luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Got rid of most of the @args

This commit is contained in:
Matthias Koefferlein 2020-03-14 21:50:47 +01:00
parent 415a1a97f9
commit 53c81cc572
40 changed files with 888 additions and 1825 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
src/db/db/gsiDeclDbBox.cc
View File

@ -111,19 +111,17 @@ struct box_defs
"box is also an empty box. The width, height, p1 and p2 attributes of an empty box are undefined. "
"Use \\empty? to get a value indicating whether the box is empty.\n"
) +
constructor ("new", &new_lbrt,
constructor ("new", &new_lbrt, gsi::arg ("left"), gsi::arg ("bottom"), gsi::arg ("right"), gsi::arg ("top"),
"@brief Creates a box with four coordinates\n"
"\n"
"@args left, bottom, right, top\n"
"\n"
"Four coordinates are given to create a new box. If the coordinates "
"are not provided in the correct order (i.e. right < left), these are "
"swapped."
) +
constructor ("new", &new_pp,
constructor ("new", &new_pp, gsi::arg ("lower_left"), gsi::arg ("upper_right"),
"@brief Creates a box from two points\n"
"\n"
"@args lower_left, upper_right\n"
"\n"
"Two points are given to create a new box. If the coordinates "
"are not provided in the correct order (i.e. right < left), these are "
@ -156,44 +154,36 @@ struct box_defs
method ("height", &C::height,
"@brief Gets the height of the box\n"
) +
method ("left=", &C::set_left,
method ("left=", &C::set_left, gsi::arg ("c"),
"@brief Sets the left coordinate of the box\n"
"@args c\n"
) +
method ("right=", &C::set_right,
method ("right=", &C::set_right, gsi::arg ("c"),
"@brief Sets the right coordinate of the box\n"
"@args c\n"
) +
method ("bottom=", &C::set_bottom,
method ("bottom=", &C::set_bottom, gsi::arg ("c"),
"@brief Sets the bottom coordinate of the box\n"
"@args c\n"
) +
method ("top=", &C::set_top,
method ("top=", &C::set_top, gsi::arg ("c"),
"@brief Sets the top coordinate of the box\n"
"@args c\n"
) +
method ("p1=", &C::set_p1,
method ("p1=", &C::set_p1, gsi::arg ("p"),
"@brief Sets the lower left point of the box\n"
"@args p\n"
) +
method ("p2=", &C::set_p2,
method ("p2=", &C::set_p2, gsi::arg ("p"),
"@brief Sets the upper right point of the box\n"
"@args p\n"
) +
method_ext ("contains?", &box_defs<C>::contains,
method_ext ("contains?", &box_defs<C>::contains, gsi::arg ("x"), gsi::arg ("y"),
"@brief Returns true if the box contains the given point\n"
"\n"
"@args x, y"
"\n"
"Tests whether a point (x, y) is inside the box.\n"
"It also returns true if the point is exactly on the box contour.\n"
"\n"
"@return true if the point is inside the box.\n"
) +
method ("contains?", &C::contains,
method ("contains?", &C::contains, gsi::arg ("point"),
"@brief Returns true if the box contains the given point\n"
"\n"
"@args point"
"\n"
"Tests whether a point is inside the box.\n"
"It also returns true if the point is exactly on the box contour.\n"
@ -209,25 +199,22 @@ struct box_defs
"Such a box is neutral when combining it with other boxes and renders empty boxes "
"if used in box intersections and false in geometrical relationship tests. "
) +
method ("inside?", &C::inside,
method ("inside?", &C::inside, gsi::arg ("box"),
"@brief Tests if this box is inside the argument box\n"
"\n"
"@args box\n"
"\n"
"Returns true, if this box is inside the given box, i.e. the box intersection renders this box"
) +
method ("touches?", &C::touches,
method ("touches?", &C::touches, gsi::arg ("box"),
"@brief Tests if this box touches the argument box\n"
"\n"
"@args box\n"
"\n"
"Two boxes touch if they overlap or their boundaries share at least one common point. "
"Touching is equivalent to a non-empty intersection ('!(b1 & b2).empty?')."
) +
method ("overlaps?", &C::overlaps,
method ("overlaps?", &C::overlaps, gsi::arg ("box"),
"@brief Tests if this box overlaps the argument box\n"
"\n"
"@args box\n"
"\n"
"Returns true, if the intersection box of this box with the argument box exists and has a non-vanishing area"
) +
@ -246,10 +233,9 @@ struct box_defs
"\n"
"This method has been introduced in version 0.23."
) +
method_ext ("+", &box_defs<C>::join_with_point,
method_ext ("+", &box_defs<C>::join_with_point, gsi::arg ("point"),
"@brief Joins box with a point\n"
"\n"
"@args point\n"
"\n"
"The + operator joins a point with the box. The resulting box will enclose both the original "
"box and the point.\n"
@ -258,10 +244,9 @@ struct box_defs
"\n"
"@return The box joined with the point\n"
) +
method ("+", &C::joined,
method ("+", &C::joined, gsi::arg ("box"),
"@brief Joins two boxes\n"
"\n"
"@args box\n"
"\n"
"The + operator joins the first box with the one given as \n"
"the second argument. Joining constructs a box that encloses\n"
@ -273,10 +258,9 @@ struct box_defs
"\n"
"@return The joined box\n"
) +
method ("&", &C::intersection,
method ("&", &C::intersection, gsi::arg ("box"),
"@brief Returns the intersection of this box with another box\n"
"\n"
"@args box\n"
"\n"
"The intersection of two boxes is the largest\n"
"box common to both boxes. The intersection may be \n"
@ -289,10 +273,9 @@ struct box_defs
"\n"
"@return The intersection box\n"
) +
method ("*", &C::convolved,
method ("*", &C::convolved, gsi::arg ("box"),
"@brief Returns the convolution product from this box with another box\n"
"\n"
"@args box\n"
"\n"
"The * operator convolves the firstbox with the one given as \n"
"the second argument. The box resulting from \"convolution\" is the\n"
@ -304,10 +287,9 @@ struct box_defs
"\n"
"@return The convolved box\n"
) +
method ("*", &C::scaled,
method ("*", &C::scaled, gsi::arg ("scale_factor"),
"@brief Returns the scaled box\n"
"\n"
"@args scale_factor\n"
"\n"
"The * operator scales the box with the given factor and returns the result.\n"
"\n"
@ -317,30 +299,27 @@ struct box_defs
"\n"
"@return The scaled box\n"
) +
method_ext ("move", &box_defs<C>::move,
method_ext ("move", &box_defs<C>::move, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Moves the box by a certain distance\n"
"\n"
"@args dx, dy\n"
"\n"
"This is a convenience method which takes two values instead of a Point object.\n"
"This method has been introduced in version 0.23.\n"
"\n"
"@return A reference to this box.\n"
) +
method_ext ("moved", &box_defs<C>::moved,
method_ext ("moved", &box_defs<C>::moved, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Moves the box by a certain distance\n"
"\n"
"@args dx, dy\n"
"\n"
"This is a convenience method which takes two values instead of a Point object.\n"
"This method has been introduced in version 0.23.\n"
"\n"
"@return The enlarged box.\n"
) +
method ("move", &C::move,
method ("move", &C::move, gsi::arg ("distance"),
"@brief Moves the box by a certain distance\n"
"\n"
"@args distance\n"
"\n"
"Moves the box by a given offset and returns the moved\n"
"box. Does not check for coordinate overflows.\n"
@ -349,10 +328,9 @@ struct box_defs
"\n"
"@return A reference to this box.\n"
) +
method ("moved", &C::moved,
method ("moved", &C::moved, gsi::arg ("distance"),
"@brief Returns the box moved by a certain distance\n"
"\n"
"@args distance\n"
"\n"
"Moves the box by a given offset and returns the moved\n"
"box. Does not modify this box. Does not check for coordinate\n"
@ -362,30 +340,27 @@ struct box_defs
"\n"
"@return The moved box.\n"
) +
method_ext ("enlarge", &box_defs<C>::enlarge,
method_ext ("enlarge", &box_defs<C>::enlarge, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Enlarges the box by a certain amount.\n"
"\n"
"@args dx, dy\n"
"\n"
"This is a convenience method which takes two values instead of a Point object.\n"
"This method has been introduced in version 0.23.\n"
"\n"
"@return A reference to this box.\n"
) +
method_ext ("enlarged", &box_defs<C>::enlarged,
method_ext ("enlarged", &box_defs<C>::enlarged, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Enlarges the box by a certain amount.\n"
"\n"
"@args dx, dy\n"
"\n"
"This is a convenience method which takes two values instead of a Point object.\n"
"This method has been introduced in version 0.23.\n"
"\n"
"@return The enlarged box.\n"
) +
method ("enlarge", &C::enlarge,
method ("enlarge", &C::enlarge, gsi::arg ("enlargement"),
"@brief Enlarges the box by a certain amount.\n"
"\n"
"@args enlargement\n"
"\n"
"Enlarges the box by x and y value specified in the vector\n"
"passed. Positive values with grow the box, negative ones\n"
@ -400,10 +375,9 @@ struct box_defs
"\n"
"@return A reference to this box.\n"
) +
method ("enlarged", &C::enlarged,
method ("enlarged", &C::enlarged, gsi::arg ("enlargement"),
"@brief Returns the enlarged box.\n"
"\n"
"@args enlargement\n"
"\n"
"Enlarges the box by x and y value specified in the vector\n"
"passed. Positive values with grow the box, negative ones\n"
@ -418,35 +392,30 @@ struct box_defs
"\n"
"@return The enlarged box.\n"
) +
method ("transformed", &C::template transformed<simple_trans_type>,
method ("transformed", &C::template transformed<simple_trans_type>, gsi::arg ("t"),
"@brief Returns the box transformed with the given simple transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The transformation to apply\n"
"@return The transformed box\n"
) +
method ("transformed", &C::template transformed<complex_trans_type>,
method ("transformed", &C::template transformed<complex_trans_type>, gsi::arg ("t"),
"@brief Returns the box transformed with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed box (a DBox now)\n"
) +
method ("<", &C::less,
method ("<", &C::less, gsi::arg ("box"),
"@brief Returns true if this box is 'less' than another box\n"
"@args box\n"
"Returns true, if this box is 'less' with respect to first and second point (in this order)"
) +
method ("==", &C::equal,
method ("==", &C::equal, gsi::arg ("box"),
"@brief Returns true if this box is equal to the other box\n"
"@args box\n"
"Returns true, if this box and the given box are equal "
) +
method ("!=", &C::not_equal,
method ("!=", &C::not_equal, gsi::arg ("box"),
"@brief Returns true if this box is not equal to the other box\n"
"@args box\n"
"Returns true, if this box and the given box are not equal "
) +
method_ext ("hash", &hash_value,
@ -455,9 +424,8 @@ struct box_defs
"\n"
"This method has been introduced in version 0.25.\n"
) +
constructor ("from_s", &from_string,
constructor ("from_s", &from_string, gsi::arg ("s"),
"@brief Creates a box object from a string\n"
"@args s\n"
"Creates the object from a string representation (as returned by \\to_s)\n"
"\n"
"This method has been added in version 0.23.\n"
@ -494,10 +462,9 @@ Class<db::Box> decl_Box ("db", "Box",
"\n"
"This method has been introduced in version 0.25."
) +
method ("transformed", &db::Box::transformed<db::ICplxTrans>,
method ("transformed", &db::Box::transformed<db::ICplxTrans>, gsi::arg ("t"),
"@brief Transforms the box with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed box (in this case an integer coordinate box)\n"
@ -550,10 +517,9 @@ Class<db::DBox> decl_DBox ("db", "DBox",
"\n"
"This method has been introduced in version 0.25."
) +
method ("transformed", &db::DBox::transformed<db::VCplxTrans>,
method ("transformed", &db::DBox::transformed<db::VCplxTrans>, gsi::arg ("t"),
"@brief Transforms the box with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed box (in this case an integer coordinate box)\n"
@ -582,4 +548,3 @@ Class<db::DBox> decl_DBox ("db", "DBox",
);
}

292
src/db/db/gsiDeclDbCell.cc
View File

@ -447,21 +447,18 @@ struct cell_inst_array_defs
gsi::constructor ("new", &new_v,
"@brief Creates en empty cell instance with size 0"
) +
gsi::constructor ("new", &new_cell_inst,
gsi::constructor ("new", &new_cell_inst, gsi::arg ("cell_index"), gsi::arg ("trans"),
"@brief Creates a single cell instance\n"
"@args cell_index, trans\n"
"@param cell_index The cell to instantiate\n"
"@param trans The transformation by which to instantiate the cell\n"
) +
gsi::constructor ("new", &new_cell_inst_cplx,
gsi::constructor ("new", &new_cell_inst_cplx, gsi::arg ("cell_index"), gsi::arg ("trans"),
"@brief Creates a single cell instance with a complex transformation\n"
"@args cell_index, trans\n"
"@param cell_index The cell to instantiate\n"
"@param trans The complex transformation by which to instantiate the cell\n"
) +
gsi::constructor ("new", &new_cell_inst_array,
gsi::constructor ("new", &new_cell_inst_array, gsi::arg ("cell_index"), gsi::arg ("trans"), gsi::arg ("a"), gsi::arg ("b"), gsi::arg ("na"), gsi::arg ("nb"),
"@brief Creates a single cell instance\n"
"@args cell_index, trans, a, b, na, nb\n"
"@param cell_index The cell to instantiate\n"
"@param trans The transformation by which to instantiate the cell\n"
"@param a The displacement vector of the array in the 'a' axis\n"
@ -473,9 +470,8 @@ struct cell_inst_array_defs
"Starting with version 0.25 the displacements are of vector type."
)
) +
gsi::constructor ("new", &new_cell_inst_array_cplx,
gsi::constructor ("new", &new_cell_inst_array_cplx, gsi::arg ("cell_index"), gsi::arg ("trans"), gsi::arg ("a"), gsi::arg ("b"), gsi::arg ("na"), gsi::arg ("nb"),
"@brief Creates a single cell instance with a complex transformation\n"
"@args cell_index, trans, a, b, na, nb\n"
"@param cell_index The cell to instantiate\n"
"@param trans The complex transformation by which to instantiate the cell\n"
"@param a The displacement vector of the array in the 'a' axis\n"
@ -517,17 +513,15 @@ struct cell_inst_array_defs
gsi::method_ext ("cell_index", &cell_index,
"@brief Gets the cell index of the cell instantiated \n"
) +
method_ext ("cell_index=", &set_cell_index,
method_ext ("cell_index=", &set_cell_index, gsi::arg ("index"),
"@brief Sets the index of the cell this instance refers to\n"
"@args index\n"
) +
gsi::method ("cplx_trans", (complex_trans_type (C::*) () const) &C::complex_trans,
"@brief Gets the complex transformation of the first instance in the array\n"
"This method is always applicable, compared to \\trans, since simple transformations can be expressed as complex transformations as well."
) +
gsi::method_ext ("cplx_trans=", &set_cplx_trans,
gsi::method_ext ("cplx_trans=", &set_cplx_trans, gsi::arg ("trans"),
"@brief Sets the complex transformation of the instance or the first instance in the array\n"
"@args trans\n"
+ std::string (new_doc ? "" :
"\n"
"This method was introduced in version 0.22.\n"
@ -537,9 +531,8 @@ struct cell_inst_array_defs
"@brief Gets the transformation of the first instance in the array\n"
"The transformation returned is only valid if the array does not represent a complex transformation array"
) +
gsi::method_ext ("trans=", &set_trans,
gsi::method_ext ("trans=", &set_trans, gsi::arg ("t"),
"@brief Sets the transformation of the instance or the first instance in the array\n"
"@args t\n"
+ std::string (new_doc ? "" :
"\n"
"This method was introduced in version 0.22.\n"
@ -551,52 +544,45 @@ struct cell_inst_array_defs
"The inverted array reference describes in which transformations the parent cell is\n"
"seen from the current cell."
) +
gsi::method_ext ("transformed", &transformed_simple,
gsi::method_ext ("transformed", &transformed_simple, gsi::arg ("trans"),
"@brief Gets the transformed cell instance\n"
"@args trans\n"
+ std::string (new_doc ? "" :
"\n"
"This method has been introduced in version 0.20.\n"
)
) +
gsi::method_ext ("transformed", &transformed_icplx,
gsi::method_ext ("transformed", &transformed_icplx, gsi::arg ("trans"),
"@brief Gets the transformed cell instance (complex transformation)\n"
"@args trans\n"
+ std::string (new_doc ? "" :
"\n"
"This method has been introduced in version 0.20.\n"
)
) +
gsi::method_ext ("transform", &transform_simple,
gsi::method_ext ("transform", &transform_simple, gsi::arg ("trans"),
"@brief Transforms the cell instance with the given transformation\n"
"@args trans\n"
+ std::string (new_doc ? "" :
"\n"
"This method has been introduced in version 0.20.\n"
)
) +
gsi::method_ext ("transform", &transform_icplx,
gsi::method_ext ("transform", &transform_icplx, gsi::arg ("trans"),
"@brief Transforms the cell instance with the given complex transformation\n"
"@args trans\n"
+ std::string (new_doc ? "" :
"\n"
"This method has been introduced in version 0.20.\n"
)
) +
gsi::method_ext ("<", &less,
gsi::method_ext ("<", &less, gsi::arg ("other"),
"@brief Compares two arrays for 'less'\n"
"@args other\n"
"The comparison provides an arbitrary sorting criterion and not specific sorting order. It "
"is guaranteed that if an array a is less than b, b is not less than a. In addition, it a "
"is not less than b and b is not less than a, then a is equal to b."
) +
gsi::method_ext ("==", &equal,
gsi::method_ext ("==", &equal, gsi::arg ("other"),
"@brief Compares two arrays for equality\n"
"@args other"
) +
gsi::method_ext ("!=", &not_equal,
gsi::method_ext ("!=", &not_equal, gsi::arg ("other"),
"@brief Compares two arrays for inequality\n"
"@args other"
) +
method_ext ("hash", &hash_value,
"@brief Computes a hash value\n"
@ -620,9 +606,8 @@ struct cell_inst_array_defs
"Starting with version 0.25 the displacement is of vector type.\n"
)
) +
gsi::method_ext ("a=", &set_array_a,
gsi::method_ext ("a=", &set_array_a, gsi::arg ("vector"),
"@brief Sets the displacement vector for the 'a' axis\n"
"@args vector\n"
"\n"
"If the instance was not regular before this property is set, it will be initialized to a regular instance.\n"
+ std::string (new_doc ? "" :
@ -637,9 +622,8 @@ struct cell_inst_array_defs
"Starting with version 0.25 the displacement is of vector type.\n"
)
) +
gsi::method_ext ("b=", &set_array_b,
gsi::method_ext ("b=", &set_array_b, gsi::arg ("vector"),
"@brief Sets the displacement vector for the 'b' axis\n"
"@args vector\n"
"\n"
"If the instance was not regular before this property is set, it will be initialized to a regular instance.\n"
+ std::string (new_doc ? "" :
@ -650,9 +634,8 @@ struct cell_inst_array_defs
gsi::method_ext ("na", &array_na,
"@brief Gets the number of instances in the 'a' axis\n"
) +
gsi::method_ext ("na=", &set_array_na,
gsi::method_ext ("na=", &set_array_na, gsi::arg ("n"),
"@brief Sets the number of instances in the 'a' axis\n"
"@args n\n"
"\n"
"If the instance was not regular before this property is set to a value larger than zero, it will be initialized to a regular instance.\n"
"To make an instance a single instance, set na or nb to 0.\n"
@ -664,9 +647,8 @@ struct cell_inst_array_defs
gsi::method_ext ("nb", &array_nb,
"@brief Gets the number of instances in the 'b' axis\n"
) +
gsi::method_ext ("nb=", &set_array_nb,
gsi::method_ext ("nb=", &set_array_nb, gsi::arg ("n"),
"@brief Sets the number of instances in the 'b' axis\n"
"@args n\n"
"\n"
"If the instance was not regular before this property is set to a value larger than zero, it will be initialized to a regular instance.\n"
"To make an instance a single instance, set na or nb to 0.\n"
@ -1743,9 +1725,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method ("name=", &db::Cell::set_name,
gsi::method ("name=", &db::Cell::set_name, gsi::arg ("name"),
"@brief Renames the cell\n"
"@args name\n"
"Renaming a cell may cause name clashes, i.e. the name may be identical to the name\n"
"of another cell. This does not have any immediate effect, but the cell needs to be "
"renamed, for example when writing the layout to a GDS file.\n"
@ -1757,9 +1738,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23."
) +
method ("prop_id=", (void (db::Cell::*) (db::properties_id_type)) &db::Cell::prop_id,
method ("prop_id=", (void (db::Cell::*) (db::properties_id_type)) &db::Cell::prop_id, gsi::arg ("id"),
"@brief Sets the properties ID associated with the cell\n"
"@args id\n"
"This method is provided, if a properties ID has been derived already. Usually it's more convenient "
"to use \\delete_property, \\set_property or \\property.\n"
"\n"
@ -1770,9 +1750,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method_ext ("delete_property", &delete_cell_property,
gsi::method_ext ("delete_property", &delete_cell_property, gsi::arg ("key"),
"@brief Deletes the user property with the given key\n"
"@args key\n"
"This method is a convenience method that deletes the property with the given key. "
"It does nothing if no property with that key exists. Using that method is more "
"convenient than creating a new property set with a new ID and assigning that properties ID.\n"
@ -1780,9 +1759,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method_ext ("set_property", &set_cell_property,
gsi::method_ext ("set_property", &set_cell_property, gsi::arg ("key"), gsi::arg ("value"),
"@brief Sets the user property with the given key to the given value\n"
"@args key, value\n"
"This method is a convenience method that sets the property with the given key to the given value. "
"If no property with that key exists, it will create one. Using that method is more "
"convenient than creating a new property set with a new ID and assigning that properties ID.\n"
@ -1790,26 +1768,23 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method_ext ("property", &get_cell_property,
gsi::method_ext ("property", &get_cell_property, gsi::arg ("key"),
"@brief Gets the user property with the given key\n"
"@args key\n"
"This method is a convenience method that gets the property with the given key. "
"If no property with that key exists, it will return nil. Using that method is more "
"convenient than using the layout object and the properties ID to retrieve the property value. "
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method_ext ("write", &write_simple,
gsi::method_ext ("write", &write_simple, gsi::arg ("file_name"),
"@brief Writes the cell to a layout file\n"
"@args file_name\n"
"The format of the file will be determined from the file name. Only the cell and "
"it's subtree below will be saved.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("write", &write_options,
gsi::method_ext ("write", &write_options, gsi::arg ("file_name"), gsi::arg ("options"),
"@brief Writes the cell to a layout file\n"
"@args file_name, options\n"
"The format of the file will be determined from the file name. Only the cell and "
"it's subtree below will be saved.\n"
"In contrast to the other 'write' method, this version allows one to specify save options, i.e. "
@ -1817,9 +1792,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("shapes", (db::Cell::shapes_type &(db::Cell::*) (unsigned int)) &db::Cell::shapes,
gsi::method ("shapes", (db::Cell::shapes_type &(db::Cell::*) (unsigned int)) &db::Cell::shapes, gsi::arg ("layer_index"),
"@brief Returns the shapes list of the given layer\n"
"@args layer_index\n"
"\n"
"This method gives access to the shapes list on a certain layer.\n"
"If the layer does not exist yet, it is created.\n"
@ -1828,9 +1802,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"@return A reference to the shapes list\n"
) +
gsi::method_ext ("shapes", &shapes_of_cell_const,
gsi::method_ext ("shapes", &shapes_of_cell_const, gsi::arg ("layer_index"),
"@brief Returns the shapes list of the given layer (const version)\n"
"@args layer_index\n"
"\n"
"This method gives access to the shapes list on a certain layer. This is the const version - only const (reading) methods "
"can be called on the returned object.\n"
@ -1847,21 +1820,18 @@ Class<db::Cell> decl_Cell ("db", "Cell",
gsi::method ("clear_insts", &db::Cell::clear_insts,
"@brief Clears the instance list\n"
) +
gsi::method ("erase", (void (db::Cell::*) (const db::Instance &)) &db::Cell::erase,
gsi::method ("erase", (void (db::Cell::*) (const db::Instance &)) &db::Cell::erase, gsi::arg ("inst"),
"@brief Erases the instance given by the Instance object\n"
"@args inst\n"
"\n"
"This method has been introduced in version 0.16. It can only be used in editable mode."
) +
gsi::method ("swap", &db::Cell::swap,
gsi::method ("swap", &db::Cell::swap, gsi::arg ("layer_index1"), gsi::arg ("layer_index2"),
"@brief Swaps the layers given\n"
"@args layer_index1, layer_index2\n"
"\n"
"This method swaps two layers inside this cell.\n"
) +
gsi::method ("move", &db::Cell::move,
gsi::method ("move", &db::Cell::move, gsi::arg ("src"), gsi::arg ("dest"),
"@brief Moves the shapes from the source to the target layer\n"
"@args src, dest\n"
"\n"
"The destination layer is not overwritten. Instead, the shapes are added to the shapes of the destination layer.\n"
"This method will move shapes within the cell. To move shapes from another cell this cell, "
@ -1872,9 +1842,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"@param src The layer index of the source layer\n"
"@param dest The layer index of the destination layer\n"
) +
gsi::method_ext ("move", &move_from_other_cell,
gsi::method_ext ("move", &move_from_other_cell, gsi::arg ("src_cell"), gsi::arg ("src_layer"), gsi::arg ("dest"),
"@brief Moves shapes from another cell to the target layern this cell\n"
"@args src_cell, src_layer, dest\n"
"\n"
"This method will move all shapes on layer 'src_layer' of cell 'src_cell' to the layer 'dest' of this cell.\n"
"The destination layer is not overwritten. Instead, the shapes are added to the shapes of the destination layer.\n"
@ -1888,9 +1857,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"@param src_layer The layer index of the layer from which to take the shapes\n"
"@param dest The layer index of the destination layer\n"
) +
gsi::method ("copy", &db::Cell::copy,
gsi::method ("copy", &db::Cell::copy, gsi::arg ("src"), gsi::arg ("dest"),
"@brief Copies the shapes from the source to the target layer\n"
"@args src, dest\n"
"\n"
"The destination layer is not overwritten. Instead, the shapes are added to the shapes of the destination layer.\n"
"If source are target layer are identical, this method does nothing.\n"
@ -1902,9 +1870,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"@param src The layer index of the source layer\n"
"@param dest The layer index of the destination layer\n"
) +
gsi::method_ext ("copy", &copy_from_other_cell,
gsi::method_ext ("copy", &copy_from_other_cell, gsi::arg ("src_cell"), gsi::arg ("src_layer"), gsi::arg ("dest"),
"@brief Copies shapes from another cell to the target layern this cell\n"
"@args src_cell, src_layer, dest\n"
"\n"
"This method will copy all shapes on layer 'src_layer' of cell 'src_cell' to the layer 'dest' of this cell.\n"
"The destination layer is not overwritten. Instead, the shapes are added to the shapes of the destination layer.\n"
@ -1918,9 +1885,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"@param src_layer The layer index of the layer from which to take the shapes\n"
"@param dest The layer index of the destination layer\n"
) +
gsi::method ("clear", &db::Cell::clear,
gsi::method ("clear", &db::Cell::clear, gsi::arg ("layer_index"),
"@brief Clears the shapes on the given layer\n"
"@args layer_index\n"
) +
gsi::method_ext ("clear", &clear_all,
"@brief Clears the cell (deletes shapes and instances)\n"
@ -1951,9 +1917,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("prune_subcells", &prune_subcells,
gsi::method_ext ("prune_subcells", &prune_subcells, gsi::arg ("levels"),
"@brief Deletes all sub cells of the cell which are not used otherwise down to the specified level of hierarchy\n"
"@args levels\n"
"\n"
"This deletes all sub cells of the cell which are not used otherwise.\n"
"All instances of the deleted cells are deleted as well.\n"
@ -1976,9 +1941,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("prune_cell", &prune_cell,
gsi::method_ext ("prune_cell", &prune_cell, gsi::arg ("levels"),
"@brief Deletes the cell plus subcells not used otherwise\n"
"@args levels\n"
"\n"
"This deletes the cell and also all sub cells of the cell which are not used otherwise.\n"
"The number of hierarchy levels to consider can be specified as well. One level of hierarchy means that "
@ -1992,9 +1956,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("flatten", &flatten1,
gsi::method_ext ("flatten", &flatten1, gsi::arg ("prune"),
"@brief Flattens the given cell\n"
"@args prune\n"
"\n"
"This method propagates all shapes from the hierarchy below into the given cell.\n"
"It also removes the instances of the cells from which the shapes came from, but does not remove the cells themselves if prune is set to false.\n"
@ -2007,9 +1970,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("flatten", &flatten,
gsi::method_ext ("flatten", &flatten, gsi::arg ("levels"), gsi::arg ("prune"),
"@brief Flattens the given cell\n"
"@args levels, prune\n"
"\n"
"This method propagates all shapes from the specified number of hierarchy levels below into the given cell.\n"
"It also removes the instances of the cells from which the shapes came from, but does not remove the cells themselves if prune is set to false.\n"
@ -2020,9 +1982,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("fill_region", &fill_region1,
gsi::method_ext ("fill_region", &fill_region1, gsi::arg ("region"), gsi::arg ("fill_cell_index"), gsi::arg ("fc_box"), gsi::arg ("origin"),
"@brief Fills the given region with cells of the given type\n"
"@args region, fill_cell_index, fc_box, origin\n"
"@param region The region to fill\n"
"@param fill_cell_index The fill cell to place\n"
"@param fc_box The fill cell's footprint\n"
@ -2040,9 +2001,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("fill_region", &fill_region2,
gsi::method_ext ("fill_region", &fill_region2, gsi::arg ("region"), gsi::arg ("fill_cell_index"), gsi::arg ("fc_box"), gsi::arg ("origin"), gsi::arg ("remaining_parts"), gsi::arg ("fill_margin"), gsi::arg ("remaining_polygons"),
"@brief Fills the given region with cells of the given type (extended version)\n"
"@args region, fill_cell_index, fc_box, origin, remaining_parts, fill_margin, remaining_polygons\n"
"@param region The region to fill\n"
"@param fill_cell_index The fill cell to place\n"
"@param fc_box The fill cell's footprint\n"
@ -2084,9 +2044,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("begin_shapes_rec", &begin_shapes_rec,
gsi::method_ext ("begin_shapes_rec", &begin_shapes_rec, gsi::arg ("layer"),
"@brief Delivers a recursive shape iterator for the shapes below the cell on the given layer\n"
"@args layer\n"
"@param layer The layer from which to get the shapes\n"
"@return A suitable iterator\n"
"\n"
@ -2138,9 +2097,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This variant has been added in version 0.25.\n"
) +
gsi::method_ext ("copy_shapes", &copy_shapes1,
gsi::method_ext ("copy_shapes", &copy_shapes1, gsi::arg ("source_cell"),
"@brief Copies the shapes from the given cell into this cell\n"
"@args source_cell\n"
"@param source_cell The cell from where to copy shapes\n"
"All shapes are copied from the source cell to this cell. Instances are not copied.\n"
"\n"
@ -2156,9 +2114,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("copy_shapes", &copy_shapes2,
gsi::method_ext ("copy_shapes", &copy_shapes2, gsi::arg ("source_cell"), gsi::arg ("layer_mapping"),
"@brief Copies the shapes from the given cell into this cell\n"
"@args source_cell, layer_mapping\n"
"@param source_cell The cell from where to copy shapes\n"
"@param layer_mapping A \\LayerMapping object that specifies which layers are copied and where\n"
"All shapes on layers specified in the layer mapping object are copied from the source cell to this cell. Instances are not copied.\n"
@ -2168,9 +2125,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("copy_instances", &copy_instances,
gsi::method_ext ("copy_instances", &copy_instances, gsi::arg ("source_cell"),
"@brief Copies the instances of child cells in the source cell to this cell\n"
"@args source_cell\n"
"@param source_cell The cell where the instances are copied from\n"
"The source cell must reside in the same layout than this cell. The instances of "
"child cells inside the source cell are copied to this cell. No new cells are created, "
@ -2183,9 +2139,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("copy_tree", &copy_tree,
gsi::method_ext ("copy_tree", &copy_tree, gsi::arg ("source_cell"),
"@brief Copies the cell tree of the given cell into this cell\n"
"@args source_cell\n"
"@param source_cell The cell from where to copy the cell tree\n"
"@return A list of indexes of newly created cells\n"
"The complete cell tree of the source cell is copied to the target cell plus all "
@ -2199,9 +2154,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("copy_tree_shapes", &copy_tree_shapes2,
gsi::method_ext ("copy_tree_shapes", &copy_tree_shapes2, gsi::arg ("source_cell"), gsi::arg ("cell_mapping"),
"@brief Copies the shapes from the given cell and the cell tree below into this cell or subcells of this cell\n"
"@args source_cell, cell_mapping\n"
"@param source_cell The starting cell from where to copy shapes\n"
"@param cell_mapping The cell mapping object that determines how cells are identified between source and target layout\n"
"\n"
@ -2223,9 +2177,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("copy_tree_shapes", &copy_tree_shapes3,
gsi::method_ext ("copy_tree_shapes", &copy_tree_shapes3, gsi::arg ("source_cell"), gsi::arg ("cell_mapping"), gsi::arg ("layer_mapping"),
"@brief Copies the shapes from the given cell and the cell tree below into this cell or subcells of this cell with layer mapping\n"
"@args source_cell, cell_mapping, layer_mapping\n"
"@param source_cell The cell from where to copy shapes and instances\n"
"@param cell_mapping The cell mapping object that determines how cells are identified between source and target layout\n"
"\n"
@ -2248,9 +2201,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("move_shapes", &move_shapes1,
gsi::method_ext ("move_shapes", &move_shapes1, gsi::arg ("source_cell"),
"@brief Moves the shapes from the given cell into this cell\n"
"@args source_cell\n"
"@param source_cell The cell from where to move shapes\n"
"All shapes are moved from the source cell to this cell. Instances are not moved.\n"
"\n"
@ -2266,9 +2218,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("move_shapes", &move_shapes2,
gsi::method_ext ("move_shapes", &move_shapes2, gsi::arg ("source_cell"), gsi::arg ("layer_mapping"),
"@brief Moves the shapes from the given cell into this cell\n"
"@args source_cell, layer_mapping\n"
"@param source_cell The cell from where to move shapes\n"
"@param layer_mapping A \\LayerMapping object that specifies which layers are moved and where\n"
"All shapes on layers specified in the layer mapping object are moved from the source cell to this cell. Instances are not moved.\n"
@ -2278,9 +2229,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("move_instances", &move_instances,
gsi::method_ext ("move_instances", &move_instances, gsi::arg ("source_cell"),
"@brief Moves the instances of child cells in the source cell to this cell\n"
"@args source_cell\n"
"@param source_cell The cell where the instances are moved from\n"
"The source cell must reside in the same layout than this cell. The instances of "
"child cells inside the source cell are moved to this cell. No new cells are created, "
@ -2293,9 +2243,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("move_tree", &move_tree,
gsi::method_ext ("move_tree", &move_tree, gsi::arg ("source_cell"),
"@brief Moves the cell tree of the given cell into this cell\n"
"@args source_cell\n"
"@param source_cell The cell from where to move the cell tree\n"
"@return A list of indexes of newly created cells\n"
"The complete cell tree of the source cell is moved to the target cell plus all "
@ -2309,9 +2258,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("move_tree_shapes", &move_tree_shapes2,
gsi::method_ext ("move_tree_shapes", &move_tree_shapes2, gsi::arg ("source_cell"), gsi::arg ("cell_mapping"),
"@brief Moves the shapes from the given cell and the cell tree below into this cell or subcells of this cell\n"
"@args source_cell, cell_mapping\n"
"@param source_cell The starting cell from where to move shapes\n"
"@param cell_mapping The cell mapping object that determines how cells are identified between source and target layout\n"
"\n"
@ -2333,9 +2281,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("move_tree_shapes", &move_tree_shapes3,
gsi::method_ext ("move_tree_shapes", &move_tree_shapes3, gsi::arg ("source_cell"), gsi::arg ("cell_mapping"), gsi::arg ("layer_mapping"),
"@brief Moves the shapes from the given cell and the cell tree below into this cell or subcells of this cell with layer mapping\n"
"@args source_cell, cell_mapping, layer_mapping\n"
"@param source_cell The cell from where to move shapes and instances\n"
"@param cell_mapping The cell mapping object that determines how cells are identified between source and target layout\n"
"\n"
@ -2358,34 +2305,30 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method ("replace_prop_id", &db::Cell::replace_prop_id,
gsi::method ("replace_prop_id", &db::Cell::replace_prop_id, gsi::arg ("instance"), gsi::arg ("property_id"),
"@brief Replaces (or install) the properties of a cell\n"
"@args instance,property_id\n"
"@return An Instance object representing the new instance\n"
"This method has been introduced in version 0.16. It can only be used in editable mode.\n"
"Changes the properties Id of the given instance or install a properties Id on that instance if it does not have one yet.\n"
"The property Id must be obtained from the \\Layout object's property_id method which "
"associates a property set with a property Id.\n"
) +
gsi::method ("transform", (db::Instance (db::Cell::*)(const db::Instance &, const db::Trans &)) &db::Cell::transform,
gsi::method ("transform", (db::Instance (db::Cell::*)(const db::Instance &, const db::Trans &)) &db::Cell::transform, gsi::arg ("instance"), gsi::arg ("trans"),
"@brief Transforms the instance with the given transformation\n"
"@args instance, trans\n"
"@return A reference (an \\Instance object) to the new instance\n"
"This method has been introduced in version 0.16.\n"
"The original instance may be deleted and re-inserted by this method. Therefore, a new reference is returned.\n"
"It is permitted in editable mode only."
) +
gsi::method ("transform", (db::Instance (db::Cell::*)(const db::Instance &, const db::ICplxTrans &)) &db::Cell::transform,
gsi::method ("transform", (db::Instance (db::Cell::*)(const db::Instance &, const db::ICplxTrans &)) &db::Cell::transform, gsi::arg ("instance"), gsi::arg ("trans"),
"@brief Transforms the instance with the given complex integer transformation\n"
"@args instance, trans\n"
"@return A reference (an \\Instance object) to the new instance\n"
"This method has been introduced in version 0.23.\n"
"The original instance may be deleted and re-inserted by this method. Therefore, a new reference is returned.\n"
"It is permitted in editable mode only."
) +
gsi::method ("transform_into", (db::Instance (db::Cell::*)(const db::Instance &, const db::Trans &)) &db::Cell::transform_into,
gsi::method ("transform_into", (db::Instance (db::Cell::*)(const db::Instance &, const db::Trans &)) &db::Cell::transform_into, gsi::arg ("instance"), gsi::arg ("trans"),
"@brief Transforms the instance into a new coordinate system with the given transformation\n"
"@args instance, trans\n"
"@return A reference (an \\Instance object) to the new instance\n"
"\n"
"In contrast to the \\transform method, this method allows propagation of the transformation into child cells. "
@ -2399,9 +2342,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"The original instance may be deleted and re-inserted by this method. Therefore, a new reference is returned.\n"
"It is permitted in editable mode only."
) +
gsi::method ("transform_into", (db::Instance (db::Cell::*)(const db::Instance &, const db::ICplxTrans &)) &db::Cell::transform_into,
gsi::method ("transform_into", (db::Instance (db::Cell::*)(const db::Instance &, const db::ICplxTrans &)) &db::Cell::transform_into, gsi::arg ("instance"), gsi::arg ("trans"),
"@brief Transforms the instance into a new coordinate system with the given complex integer transformation\n"
"@args instance, trans\n"
"@return A reference (an \\Instance object) to the new instance\n"
"\n"
"See the comments for the simple-transformation version for a description of this method.\n"
@ -2409,9 +2351,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"The original instance may be deleted and re-inserted by this method. Therefore, a new reference is returned.\n"
"It is permitted in editable mode only."
) +
gsi::method ("transform_into", (void (db::Cell::*)(const db::Trans &)) &db::Cell::transform_into,
gsi::method ("transform_into", (void (db::Cell::*)(const db::Trans &)) &db::Cell::transform_into, gsi::arg ("trans"),
"@brief Transforms the cell into a new coordinate system with the given transformation\n"
"@args trans\n"
"\n"
"This method transforms all instances and all shapes. The instances are transformed in a way that allows propagation "
"of the transformation into child cells. "
@ -2423,9 +2364,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"It has been introduced in version 0.23.\n"
) +
gsi::method ("transform_into", (void (db::Cell::*)(const db::ICplxTrans &)) &db::Cell::transform_into,
gsi::method ("transform_into", (void (db::Cell::*)(const db::ICplxTrans &)) &db::Cell::transform_into, gsi::arg ("trans"),
"@brief Transforms the cell into a new coordinate system with the given complex integer transformation\n"
"@args trans\n"
"\n"
"See the comments for the simple-transformation version for a description of this method.\n"
"This method has been introduced in version 0.23.\n"
@ -2476,17 +2416,15 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method ("replace", (db::Instance (db::Cell::*)(const db::Instance &, const db::Cell::cell_inst_array_type &)) &db::Cell::replace,
gsi::method ("replace", (db::Instance (db::Cell::*)(const db::Instance &, const db::Cell::cell_inst_array_type &)) &db::Cell::replace, gsi::arg ("instance"), gsi::arg ("cell_inst_array"),
"@brief Replaces a cell instance (array) with a different one\n"
"@args instance,cell_inst_array\n"
"@return An \\Instance object representing the new instance\n"
"This method has been introduced in version 0.16. It can only be used in editable mode.\n"
"The instance given by the instance object (first argument) is replaced by the given instance (second argument). "
"The new object will not have any properties."
) +
gsi::method_ext ("replace", &replace_inst_with_props,
gsi::method_ext ("replace", &replace_inst_with_props, gsi::arg ("instance"), gsi::arg ("cell_inst_array"), gsi::arg ("property_id"),
"@brief Replaces a cell instance (array) with a different one with properties\n"
"@args instance,cell_inst_array,property_id\n"
"@return An \\Instance object representing the new instance\n"
"This method has been introduced in version 0.16. It can only be used in editable mode.\n"
"The instance given by the instance object (first argument) is replaced by the given instance (second argument) with the given properties Id.\n"
@ -2591,9 +2529,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"The bounding box is computed over all layers. To compute the bounding box over single layers, "
"use \\bbox_per_layer.\n"
) +
gsi::method ("bbox_per_layer", (const db::Cell::box_type &(db::Cell::*) (unsigned int) const) &db::Cell::bbox,
gsi::method ("bbox_per_layer", (const db::Cell::box_type &(db::Cell::*) (unsigned int) const) &db::Cell::bbox, gsi::arg ("layer_index"),
"@brief Gets the per-layer bounding box of the cell\n"
"@args layer_index\n"
"\n"
"@return The bounding box of the cell considering only the given layer\n"
"\n"
@ -2707,26 +2644,23 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"A cell is a leaf cell if there are no child instantiations.\n"
) +
gsi::method ("is_valid?", &db::Cell::is_valid,
gsi::method ("is_valid?", &db::Cell::is_valid, gsi::arg ("instance"),
"@brief Tests if the given \\Instance object is still pointing to a valid object\n"
"@args instance\n"
"This method has been introduced in version 0.16.\n"
"If the instance represented by the given reference has been deleted, this method returns false. "
"If however, another instance has been inserted already that occupies the original instances position, "
"this method will return true again.\n"
) +
gsi::iterator_ext ("each_shape", &begin_shapes,
gsi::iterator_ext ("each_shape", &begin_shapes, gsi::arg ("layer_index"), gsi::arg ("flags"),
"@brief Iterates over all shapes of a given layer\n"
"@args layer_index, flags\n"
"\n"
"@param flags An \"or\"-ed combination of the S.. constants of the \\Shapes class\n"
"@param layer_index The layer on which to run the query\n"
"\n"
"This iterator is equivalent to 'shapes(layer).each'."
) +
gsi::iterator_ext ("each_shape", &begin_shapes_all,
gsi::iterator_ext ("each_shape", &begin_shapes_all, gsi::arg ("layer_index"),
"@brief Iterates over all shapes of a given layer\n"
"@args layer_index\n"
"\n"
"@param layer_index The layer on which to run the query\n"
"\n"
@ -2734,17 +2668,15 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"This convenience method has been introduced in version 0.16.\n"
) +
// Hint: don't use db::Shapes::begin_touching. It does not update the box trees automatically
gsi::iterator_ext ("each_touching_shape", &begin_touching_shapes,
gsi::iterator_ext ("each_touching_shape", &begin_touching_shapes, gsi::arg ("layer_index"), gsi::arg ("box"), gsi::arg ("flags"),
"@brief Iterates over all shapes of a given layer that touch the given box\n"
"@args layer_index, box, flags\n"
"\n"
"@param flags An \"or\"-ed combination of the S.. constants of the \\Shapes class\n"
"@param box The box by which to query the shapes\n"
"@param layer_index The layer on which to run the query\n"
) +
gsi::iterator_ext ("each_touching_shape", &begin_touching_shapes_all,
gsi::iterator_ext ("each_touching_shape", &begin_touching_shapes_all, gsi::arg ("layer_index"), gsi::arg ("box"),
"@brief Iterates over all shapes of a given layer that touch the given box\n"
"@args layer_index, box\n"
"\n"
"@param box The box by which to query the shapes\n"
"@param layer_index The layer on which to run the query\n"
@ -2753,17 +2685,15 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"This convenience method has been introduced in version 0.16.\n"
) +
// Hint: don't use db::Shapes::begin_overlapping. It does not update the box trees automatically
gsi::iterator_ext ("each_overlapping_shape", &begin_overlapping_shapes,
gsi::iterator_ext ("each_overlapping_shape", &begin_overlapping_shapes, gsi::arg ("layer_index"), gsi::arg ("box"), gsi::arg ("flags"),
"@brief Iterates over all shapes of a given layer that overlap the given box\n"
"@args layer_index, box, flags\n"
"\n"
"@param flags An \"or\"-ed combination of the S.. constants of the \\Shapes class\n"
"@param box The box by which to query the shapes\n"
"@param layer_index The layer on which to run the query\n"
) +
gsi::iterator_ext ("each_overlapping_shape", &begin_overlapping_shapes_all,
gsi::iterator_ext ("each_overlapping_shape", &begin_overlapping_shapes_all, gsi::arg ("layer_index"), gsi::arg ("box"),
"@brief Iterates over all shapes of a given layer that overlap the given box\n"
"@args layer_index, box\n"
"\n"
"@param box The box by which to query the shapes\n"
"@param layer_index The layer on which to run the query\n"
@ -2938,17 +2868,15 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method_ext ("pcell_declaration", &pcell_declaration_of_inst,
gsi::method_ext ("pcell_declaration", &pcell_declaration_of_inst, gsi::arg ("instance"),
"@brief Returns the PCell declaration of a pcell instance\n"
"@args instance\n"
"If the instance is not a PCell instance, this method returns nil.\n"
"The \\PCellDeclaration object allows one to retrieve PCell parameter definitions for example.\n"
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method_ext ("is_pcell_variant?", &is_pcell_variant_of_inst,
gsi::method_ext ("is_pcell_variant?", &is_pcell_variant_of_inst, gsi::arg ("instance"),
"@brief Returns true, if this instance is a PCell variant\n"
"@args instance\n"
"This method returns true, if this instance represents a PCell with a distinct\n"
"set of parameters. This method also returns true, if it is a PCell imported from a library.\n"
"\n"
@ -2964,27 +2892,24 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method ("pcell_parameters", &db::Cell::get_pcell_parameters,
gsi::method ("pcell_parameters", &db::Cell::get_pcell_parameters, gsi::arg ("instance"),
"@brief Returns the PCell parameters for a pcell instance\n"
"@args instance\n"
"If the given instance is a PCell instance, this method returns a list of\n"
"values for the PCell parameters. If the instance is not a PCell instance, this\n"
"method returns an empty list.\n"
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method ("pcell_parameters_by_name", &db::Cell::get_named_pcell_parameters,
gsi::method ("pcell_parameters_by_name", &db::Cell::get_named_pcell_parameters, gsi::arg ("instance"),
"@brief Returns the PCell parameters for a pcell instance as a name to value dictionary\n"
"@args instance\n"
"If the given instance is a PCell instance, this method returns a dictionary of\n"
"values for the PCell parameters with the parameter names as the keys. If the instance is not a PCell instance, this\n"
"method returns an empty dictionary.\n"
"\n"
"This method has been introduced in version 0.24.\n"
) +
gsi::method_ext ("change_pcell_parameter", &change_pcell_parameter,
gsi::method_ext ("change_pcell_parameter", &change_pcell_parameter, gsi::arg ("instance"), gsi::arg ("name"), gsi::arg ("value"),
"@brief Changes a single parameter for an individual PCell instance given by name\n"
"@args instance, name, value\n"
"@return The new instance (the old may be invalid)\n"
"This will set the PCell parameter named 'name' to the given value for the "
"instance addressed by 'instance'. If no parameter with that name exists, the "
@ -2992,9 +2917,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("change_pcell_parameters", &change_pcell_parameters,
gsi::method_ext ("change_pcell_parameters", &change_pcell_parameters, gsi::arg ("instance"), gsi::arg ("dict"),
"@brief Changes the given parameter for an individual PCell instance\n"
"@args instance, dict\n"
"@return The new instance (the old may be invalid)\n"
"This version receives a dictionary of names and values. It will change the "
"parameters given by the names to the values given by the values of the dictionary. "
@ -3003,9 +2927,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.24.\n"
) +
gsi::method ("change_pcell_parameters", &db::Cell::change_pcell_parameters,
gsi::method ("change_pcell_parameters", &db::Cell::change_pcell_parameters, gsi::arg ("instance"), gsi::arg ("parameters"),
"@brief Changes the parameters for an individual PCell instance\n"
"@args instance, parameters\n"
"@return The new instance (the old may be invalid)\n"
"If necessary, this method creates a new variant and replaces the given instance\n"
"by an instance of this variant.\n"
@ -3066,9 +2989,8 @@ Class<db::Cell> decl_Cell ("db", "Cell",
"\n"
"This method has been introduced in version 0.20.\n"
) +
gsi::method ("ghost_cell=", &db::Cell::set_ghost_cell,
gsi::method ("ghost_cell=", &db::Cell::set_ghost_cell, gsi::arg ("flag"),
"@brief Sets the \"ghost cell\" flag\n"
"@args flag\n"
"\n"
"See \\is_ghost_cell? for a description of this property.\n"
"\n"
@ -3729,9 +3651,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
method ("prop_id", &db::Instance::prop_id,
"@brief Gets the properties ID associated with the instance\n"
) +
method_ext ("prop_id=", &set_prop_id,
method_ext ("prop_id=", &set_prop_id, gsi::arg ("id"),
"@brief Sets the properties ID associated with the instance\n"
"@args id\n"
"This method is provided, if a properties ID has been derived already. Usually it's more convenient "
"to use \\delete_property, \\set_property or \\property.\n"
"\n"
@ -3740,9 +3661,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
gsi::method ("has_prop_id?", &db::Instance::has_prop_id,
"@brief Returns true, if the instance has properties\n"
) +
gsi::method_ext ("delete_property", &delete_property,
gsi::method_ext ("delete_property", &delete_property, gsi::arg ("key"),
"@brief Deletes the user property with the given key\n"
"@args key\n"
"This method is a convenience method that deletes the property with the given key. "
"It does nothing if no property with that key exists. Using that method is more "
"convenient than creating a new property set with a new ID and assigning that properties ID.\n"
@ -3752,9 +3672,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.22."
) +
gsi::method_ext ("set_property", &set_property,
gsi::method_ext ("set_property", &set_property, gsi::arg ("key"), gsi::arg ("value"),
"@brief Sets the user property with the given key to the given value\n"
"@args key, value\n"
"This method is a convenience method that sets the property with the given key to the given value. "
"If no property with that key exists, it will create one. Using that method is more "
"convenient than creating a new property set with a new ID and assigning that properties ID.\n"
@ -3764,9 +3683,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.22."
) +
gsi::method_ext ("property", &get_property,
gsi::method_ext ("property", &get_property, gsi::arg ("key"),
"@brief Gets the user property with the given key\n"
"@args key\n"
"This method is a convenience method that gets the property with the given key. "
"If no property with that key exists, it will return nil. Using that method is more "
"convenient than using the layout object and the properties ID to retrieve the property value. "
@ -3880,9 +3798,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This variant has been introduced in version 0.25."
) +
method_ext ("cell=", &set_inst_cell,
method_ext ("cell=", &set_inst_cell, gsi::arg ("cell"),
"@brief Sets the \\Cell object this instance refers to\n"
"@args cell\n"
"\n"
"Setting the cell object to nil is equivalent to deleting the instance.\n"
"\n"
@ -3891,9 +3808,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
method ("cell_index", &db::Instance::cell_index,
"@brief Get the index of the cell this instance refers to\n"
) +
method_ext ("cell_index=", &set_inst_cell_index,
method_ext ("cell_index=", &set_inst_cell_index, gsi::arg ("cell_index"),
"@brief Sets the index of the cell this instance refers to\n"
"@args cell_index\n"
"\n"
"This method has been introduced in version 0.23."
) +
@ -3927,17 +3843,15 @@ Class<db::Instance> decl_Instance ("db", "Instance",
gsi::method_ext ("nb", &array_nb_i,
"@brief Returns the number of instances in the 'b' axis\n"
) +
gsi::method_ext ("a=", &set_array_a_i,
gsi::method_ext ("a=", &set_array_a_i, gsi::arg ("a"),
"@brief Sets the displacement vector for the 'a' axis\n"
"@args a\n"
"\n"
"If the instance was not an array instance before it is made one.\n"
"\n"
"This method has been introduced in version 0.23. Starting with version 0.25 the displacement is of vector type."
) +
gsi::method_ext ("b=", &set_array_b_i,
gsi::method_ext ("b=", &set_array_b_i, gsi::arg ("b"),
"@brief Sets the displacement vector for the 'b' axis\n"
"@args b\n"
"\n"
"If the instance was not an array instance before it is made one.\n"
"\n"
@ -3959,17 +3873,15 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.25."
) +
gsi::method_ext ("na=", &set_array_na_i,
gsi::method_ext ("na=", &set_array_na_i, gsi::arg ("na"),
"@brief Sets the number of instances in the 'a' axis\n"
"@args na\n"
"\n"
"If the instance was not an array instance before it is made one.\n"
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method_ext ("nb=", &set_array_nb_i,
gsi::method_ext ("nb=", &set_array_nb_i, gsi::arg ("nb"),
"@brief Sets the number of instances in the 'b' axis\n"
"@args nb\n"
"\n"
"If the instance was not an array instance before it is made one.\n"
"\n"
@ -3994,9 +3906,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("flatten", &inst_flatten,
gsi::method_ext ("flatten", &inst_flatten, gsi::arg ("levels"),
"@brief Flattens the instance\n"
"@args levels\n"
"\n"
"This method will convert the instance to a number of shapes which are equivalent "
"to the content of the cell. The instance itself will be removed.\n"
@ -4098,9 +4009,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("change_pcell_parameters", &inst_change_pcell_parameters_list,
gsi::method_ext ("change_pcell_parameters", &inst_change_pcell_parameters_list, gsi::arg ("params"),
"@brief Changes the parameters of a PCell instance to the list of parameters\n"
"@args params\n"
"\n"
"This method changes the parameters of a PCell instance to the given list of "
"parameters. The list must correspond to the parameters listed in the pcell declaration.\n"
@ -4109,9 +4019,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("change_pcell_parameters", &inst_change_pcell_parameters_dict,
gsi::method_ext ("change_pcell_parameters", &inst_change_pcell_parameters_dict, gsi::arg ("dict"),
"@brief Changes the parameters of a PCell instance to the dictionary of parameters\n"
"@args dict\n"
"\n"
"This method changes the parameters of a PCell instance to the given "
"values. The values are specifies as a dictionary of names (keys) vs. values.\n"
@ -4120,9 +4029,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("change_pcell_parameter", &inst_change_pcell_parameter,
gsi::method_ext ("change_pcell_parameter", &inst_change_pcell_parameter, gsi::arg ("name"), gsi::arg ("value"),
"@brief Changes a single parameter of a PCell instance to the given value\n"
"@args name,value\n"
"\n"
"This method changes a parameter of a PCell instance to the given value. The "
"name identifies the PCell parameter and must correspond to one parameter listed in the PCell "
@ -4205,9 +4113,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
gsi::method ("cell_inst", &db::Instance::cell_inst,
"@brief Gets the basic \\CellInstArray object associated with this instance reference."
) +
gsi::method_ext ("cell_inst=", &set_cell_inst,
gsi::method_ext ("cell_inst=", &set_cell_inst, gsi::arg ("inst"),
"@brief Changes the \\CellInstArray object to the given one.\n"
"@args inst\n"
"This method replaces the instance by the given CellInstArray object.\n"
"\n"
"This method has been introduced in version 0.22"
@ -4223,19 +4130,16 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.25"
) +
gsi::method ("<", &db::Instance::operator<,
gsi::method ("<", &db::Instance::operator<, gsi::arg ("b"),
"@brief Provides an order criterion for two Instance objects\n"
"@args b\n"
"Warning: this operator is just provided to establish any order, not a particular one."
) +
gsi::method ("!=", &db::Instance::operator!=,
gsi::method ("!=", &db::Instance::operator!=, gsi::arg ("b"),
"@brief Tests for inequality of two Instance objects\n"
"@args b\n"
"Warning: this operator returns true if both objects refer to the same instance, not just identical ones."
) +
gsi::method ("==", &db::Instance::operator==,
gsi::method ("==", &db::Instance::operator==, gsi::arg ("b"),
"@brief Tests for equality of two Instance objects\n"
"@args b\n"
"See the hint on the < operator."
) +
gsi::method_ext ("to_s", &to_string1,
@ -4243,9 +4147,8 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced with version 0.16."
) +
gsi::method_ext ("to_s", &to_string2,
gsi::method_ext ("to_s", &to_string2, gsi::arg ("with_cellname"),
"@brief Creates a string showing the contents of the reference\n"
"@args with_cellname\n"
"\n"
"Passing true to with_cellname makes the string contain the cellname instead of the cell index\n"
"\n"
@ -4393,4 +4296,3 @@ Class<db::DCellInstArray> decl_DCellInstArray ("db", "DCellInstArray",
}

28
src/db/db/gsiDeclDbCellMapping.cc
View File

@ -48,10 +48,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"\n"
"This constant has been introduced in version 0.25."
) +
gsi::method ("for_single_cell", &db::CellMapping::create_single_mapping,
gsi::method ("for_single_cell", &db::CellMapping::create_single_mapping, gsi::arg ("layout_a"), gsi::arg ("cell_index_a"), gsi::arg ("layout_b"), gsi::arg ("cell_index_b"),
"@brief Initializes the cell mapping for top-level identity\n"
"\n"
"@args layout_a, cell_index_a, layout_b, cell_index_b\n"
"@param layout_a The target layout.\n"
"@param cell_index_a The index of the target cell.\n"
"@param layout_b The source layout.\n"
@ -66,10 +65,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method ("for_single_cell_full", &db::CellMapping::create_single_mapping_full,
gsi::method ("for_single_cell_full", &db::CellMapping::create_single_mapping_full, gsi::arg ("layout_a"), gsi::arg ("cell_index_a"), gsi::arg ("layout_b"), gsi::arg ("cell_index_b"),
"@brief Initializes the cell mapping for top-level identity\n"
"\n"
"@args layout_a, cell_index_a, layout_b, cell_index_b\n"
"@param layout_a The target layout.\n"
"@param cell_index_a The index of the target cell.\n"
"@param layout_b The source layout.\n"
@ -82,10 +80,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method ("from_geometry_full", &db::CellMapping::create_from_geometry_full,
gsi::method ("from_geometry_full", &db::CellMapping::create_from_geometry_full, gsi::arg ("layout_a"), gsi::arg ("cell_index_a"), gsi::arg ("layout_b"), gsi::arg ("cell_index_b"),
"@brief Initializes the cell mapping using the geometrical identity in full mapping mode\n"
"\n"
"@args layout_a, cell_index_a, layout_b, cell_index_b\n"
"@param layout_a The target layout.\n"
"@param cell_index_a The index of the target starting cell.\n"
"@param layout_b The source layout.\n"
@ -103,10 +100,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method ("from_geometry", &db::CellMapping::create_from_geometry,
gsi::method ("from_geometry", &db::CellMapping::create_from_geometry, gsi::arg ("layout_a"), gsi::arg ("cell_index_a"), gsi::arg ("layout_b"), gsi::arg ("cell_index_b"),
"@brief Initializes the cell mapping using the geometrical identity\n"
"\n"
"@args layout_a, cell_index_a, layout_b, cell_index_b\n"
"@param layout_a The target layout.\n"
"@param cell_index_a The index of the target starting cell.\n"
"@param layout_b The source layout.\n"
@ -119,10 +115,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method ("from_names", &db::CellMapping::create_from_names,
gsi::method ("from_names", &db::CellMapping::create_from_names, gsi::arg ("layout_a"), gsi::arg ("cell_index_a"), gsi::arg ("layout_b"), gsi::arg ("cell_index_b"),
"@brief Initializes the cell mapping using the name identity\n"
"\n"
"@args layout_a, cell_index_a, layout_b, cell_index_b\n"
"@param layout_a The target layout.\n"
"@param cell_index_a The index of the target starting cell.\n"
"@param layout_b The source layout.\n"
@ -134,10 +129,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method ("from_names_full", &db::CellMapping::create_from_names_full,
gsi::method ("from_names_full", &db::CellMapping::create_from_names_full, gsi::arg ("layout_a"), gsi::arg ("cell_index_a"), gsi::arg ("layout_b"), gsi::arg ("cell_index_b"),
"@brief Initializes the cell mapping using the name identity in full mapping mode\n"
"\n"
"@args layout_a, cell_index_a, layout_b, cell_index_b\n"
"@param layout_a The target layout.\n"
"@param cell_index_a The index of the target starting cell.\n"
"@param layout_b The source layout.\n"
@ -167,10 +161,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"\n"
"This method has been introduced in version 0.25."
) +
gsi::method ("map", &db::CellMapping::map,
gsi::method ("map", &db::CellMapping::map, gsi::arg ("cell_index_b"), gsi::arg ("cell_index_a"),
"@brief Explicitly specifies a mapping.\n"
"\n"
"@args cell_index_b, cell_index_a\n"
"\n"
"@param cell_index_b The index of the cell in layout B (the \"source\")\n"
"@param cell_index_a The index of the cell in layout A (the \"target\") - this index can be \\DropCell\n"
@ -180,10 +173,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method ("has_mapping?", &db::CellMapping::has_mapping,
gsi::method ("has_mapping?", &db::CellMapping::has_mapping, gsi::arg ("cell_index_b"),
"@brief Returns as value indicating whether a cell of layout_b has a mapping to a layout_a cell.\n"
"\n"
"@args cell_index_b\n"
"\n"
"@param cell_index_b The index of the cell in layout_b whose mapping is requested.\n"
"@return true, if the cell has a mapping\n"
@ -191,10 +183,9 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
"Note that if the cell is supposed to be dropped (see \\DropCell), the respective "
"source cell will also be regarded \"mapped\", so has_mapping? will return true in this case.\n"
) +
gsi::method ("cell_mapping", &db::CellMapping::cell_mapping,
gsi::method ("cell_mapping", &db::CellMapping::cell_mapping, gsi::arg ("cell_index_b"),
"@brief Determines cell mapping of a layout_b cell to the corresponding layout_a cell.\n"
"\n"
"@args cell_index_b\n"
"\n"
"@param cell_index_b The index of the cell in layout_b whose mapping is requested.\n"
"@return The cell index in layout_a.\n"
@ -246,4 +237,3 @@ Class<db::CellMapping> decl_CellMapping ("db", "CellMapping",
);
}

2
src/db/db/gsiDeclDbCommonStreamOptions.cc
View File

@ -153,7 +153,6 @@ gsi::ClassExt<db::LoadLayoutOptions> common_reader_options (
) +
gsi::method_ext ("properties_enabled=", &set_properties_enabled, gsi::arg ("enabled"),
"@brief Specifies whether properties should be read\n"
"@args enabled\n"
"@param enabled True, if properties should be read."
"\n"
"Starting with version 0.25 this option only applies to GDS2 and OASIS format. Other formats provide their own configuration."
@ -166,4 +165,3 @@ gsi::ClassExt<db::LoadLayoutOptions> common_reader_options (

37
src/db/db/gsiDeclDbEdgePair.cc
View File

@ -80,16 +80,14 @@ struct edge_pair_defs
method ("first", (const edge_type &(C::*) () const) &C::first,
"@brief Gets the first edge\n"
) +
method ("first=", &C::set_first,
method ("first=", &C::set_first, gsi::arg ("edge"),
"@brief Sets the first edge\n"
"@args edge\n"
) +
method ("second", (const edge_type &(C::*) () const) &C::second,
"@brief Gets the second edge\n"
) +
method ("second=", &C::set_second,
method ("second=", &C::set_second, gsi::arg ("edge"),
"@brief Sets the second edge\n"
"@args edge\n"
) +
method ("normalized", &C::normalized,
"@brief Normalizes the edge pair\n"
@ -100,9 +98,8 @@ struct edge_pair_defs
"because that way the polygons won't be self-overlapping and the enlargement parameter "
"is applied properly."
) +
method ("polygon", &C::to_polygon,
method ("polygon", &C::to_polygon, gsi::arg ("e The enlargement (set to zero for exact representation)"),
"@brief Convert an edge pair to a polygon\n"
"@args e The enlargement (set to zero for exact representation)\n"
"The polygon is formed by connecting the end and start points of the edges. It is recommended to "
"use \\normalized before converting the edge pair to a polygon.\n"
"\n"
@ -113,9 +110,8 @@ struct edge_pair_defs
"\n"
"Another version for converting edge pairs to simple polygons is \\simple_polygon which renders a \\SimplePolygon object."
) +
method ("simple_polygon", &C::to_simple_polygon,
method ("simple_polygon", &C::to_simple_polygon, gsi::arg ("e The enlargement (set to zero for exact representation)"),
"@brief Convert an edge pair to a simple polygon\n"
"@args e The enlargement (set to zero for exact representation)\n"
"The polygon is formed by connecting the end and start points of the edges. It is recommended to "
"use \\normalized before converting the edge pair to a polygon.\n"
"\n"
@ -126,9 +122,8 @@ struct edge_pair_defs
"\n"
"Another version for converting edge pairs to polygons is \\polygon which renders a \\Polygon object."
) +
constructor ("from_s", &from_string,
constructor ("from_s", &from_string, gsi::arg ("s"),
"@brief Creates an object from a string\n"
"@args s\n"
"Creates the object from a string representation (as returned by \\to_s)\n"
"\n"
"This method has been added in version 0.23.\n"
@ -139,23 +134,20 @@ struct edge_pair_defs
method ("bbox", &C::bbox,
"@brief Gets the bounding box of the edge pair\n"
) +
method ("<", &C::less,
method ("<", &C::less, gsi::arg ("box"),
"@brief Less operator\n"
"@args box\n"
"Returns true, if this edge pair is 'less' with respect to first and second edge\n"
"\n"
"This method has been introduced in version 0.25.\n"
) +
method ("==", &C::equal,
method ("==", &C::equal, gsi::arg ("box"),
"@brief Equality\n"
"@args box\n"
"Returns true, if this edge pair and the given one are equal\n"
"\n"
"This method has been introduced in version 0.25.\n"
) +
method ("!=", &C::not_equal,
method ("!=", &C::not_equal, gsi::arg ("box"),
"@brief Inequality\n"
"@args box\n"
"Returns true, if this edge pair and the given one are not equal\n"
"\n"
"This method has been introduced in version 0.25.\n"
@ -166,9 +158,8 @@ struct edge_pair_defs
"\n"
"This method has been introduced in version 0.25.\n"
) +
method ("transformed", &C::template transformed<simple_trans_type>,
method ("transformed", &C::template transformed<simple_trans_type>, gsi::arg ("t"),
"@brief Returns the transformed pair\n"
"@args t\n"
"\n"
"Transforms the edge pair with the given transformation.\n"
"Does not modify the edge pair but returns the transformed edge.\n"
@ -177,9 +168,8 @@ struct edge_pair_defs
"\n"
"@return The transformed edge pair\n"
) +
method ("transformed", &C::template transformed<complex_trans_type>,
method ("transformed", &C::template transformed<complex_trans_type>, gsi::arg ("t"),
"@brief Returns the transformed edge pair\n"
"@args t\n"
"\n"
"Transforms the edge pair with the given complex transformation.\n"
"Does not modify the edge pair but returns the transformed edge.\n"
@ -215,9 +205,8 @@ Class<db::EdgePair> decl_EdgePair ("db", "EdgePair",
"\n"
"This method has been introduced in version 0.25."
) +
method ("transformed", &db::EdgePair::transformed<db::ICplxTrans>,
method ("transformed", &db::EdgePair::transformed<db::ICplxTrans>, gsi::arg ("t"),
"@brief Returns the transformed edge pair\n"
"@args t\n"
"\n"
"Transforms the edge pair with the given complex transformation.\n"
"Does not modify the edge pair but returns the transformed edge.\n"
@ -265,10 +254,9 @@ Class<db::DEdgePair> decl_DEdgePair ("db", "DEdgePair",
"\n"
"This method has been introduced in version 0.25."
) +
method ("transformed", &db::DEdgePair::transformed<db::VCplxTrans>,
method ("transformed", &db::DEdgePair::transformed<db::VCplxTrans>, gsi::arg ("t"),
"@brief Transforms the edge pair with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed edge pair (in this case an integer coordinate edge pair)\n"
@ -290,4 +278,3 @@ Class<db::DEdgePair> decl_DEdgePair ("db", "DEdgePair",
);
}

76
src/db/db/gsiDeclDbEdgePairs.cc
View File

@ -185,33 +185,29 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"This constructor creates an empty edge pair collection.\n"
) +
constructor ("new", &new_a,
constructor ("new", &new_a, gsi::arg ("array"),
"@brief Constructor from an edge pair array\n"
"@args array\n"
"\n"
"This constructor creates an edge pair collection from an array of \\EdgePair objects.\n"
"\n"
"This constructor has been introduced in version 0.26."
) +
constructor ("new", &new_ep,
constructor ("new", &new_ep, gsi::arg ("edge_pair"),
"@brief Constructor from a single edge pair object\n"
"@args edge_pair\n"
"\n"
"This constructor creates an edge pair collection with a single edge pair.\n"
"\n"
"This constructor has been introduced in version 0.26."
) +
constructor ("new", &new_shapes,
constructor ("new", &new_shapes, gsi::arg ("shapes"),
"@brief Shapes constructor\n"
"@args shapes\n"
"\n"
"This constructor creates an edge pair collection from a \\Shapes collection.\n"
"\n"
"This constructor has been introduced in version 0.26."
) +
constructor ("new", &new_si,
constructor ("new", &new_si, gsi::arg ("shape_iterator"),
"@brief Constructor from a hierarchical shape set\n"
"@args shape_iterator\n"
"\n"
"This constructor creates an edge pair collection from the shapes delivered by the given recursive shape iterator.\n"
"Only edge pairs are taken from the shape set and other shapes are ignored.\n"
@ -228,9 +224,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"This constructor has been introduced in version 0.26."
) +
constructor ("new", &new_si2,
constructor ("new", &new_si2, gsi::arg ("shape_iterator"), gsi::arg ("trans"),
"@brief Constructor from a hierarchical shape set with a transformation\n"
"@args shape_iterator, trans\n"
"\n"
"This constructor creates an edge pair collection from the shapes delivered by the given recursive shape iterator.\n"
"Only edge pairs are taken from the shape set and other shapes are ignored.\n"
@ -304,13 +299,11 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"This method has been introduced in version 0.26."
) +
method ("insert", (void (db::EdgePairs::*) (const db::Edge &, const db::Edge &)) &db::EdgePairs::insert,
method ("insert", (void (db::EdgePairs::*) (const db::Edge &, const db::Edge &)) &db::EdgePairs::insert, gsi::arg ("first"), gsi::arg ("second"),
"@brief Inserts an edge pair into the collection\n"
"@args first, second\n"
) +
method ("insert", (void (db::EdgePairs::*) (const db::EdgePair &)) &db::EdgePairs::insert,
method ("insert", (void (db::EdgePairs::*) (const db::EdgePair &)) &db::EdgePairs::insert, gsi::arg ("edge_pair"),
"@brief Inserts an edge pair into the collection\n"
"@args edge_pair\n"
) +
method_ext ("is_deep?", &is_deep,
"@brief Returns true if the edge pair collection is a deep (hierarchical) one\n"
@ -322,29 +315,26 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"This method has been added in version 0.26."
) +
method ("+", &db::EdgePairs::operator+,
method ("+", &db::EdgePairs::operator+, gsi::arg ("other"),
"@brief Returns the combined edge pair collection of self and the other one\n"
"\n"
"@args other\n"
"@return The resulting edge pair collection\n"
"\n"
"This operator adds the edge pairs of the other collection to self and returns a new combined set.\n"
"\n"
"This method has been introduced in version 0.24.\n"
) +
method ("+=", &db::EdgePairs::operator+=,
method ("+=", &db::EdgePairs::operator+=, gsi::arg ("other"),
"@brief Adds the edge pairs of the other edge pair collection to self\n"
"\n"
"@args other\n"
"@return The edge pair collection after modification (self)\n"
"\n"
"This operator adds the edge pairs of the other collection to self.\n"
"\n"
"This method has been introduced in version 0.24.\n"
) +
method_ext ("move", &move_p,
method_ext ("move", &move_p, gsi::arg ("p"),
"@brief Moves the edge pair collection\n"
"@args p\n"
"\n"
"Moves the edge pairs by the given offset and returns the \n"
"moved edge pair collection. The edge pair collection is overwritten.\n"
@ -355,9 +345,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"Starting with version 0.25 the displacement is of vector type."
) +
method_ext ("move", &move_xy,
method_ext ("move", &move_xy, gsi::arg ("x"), gsi::arg ("y"),
"@brief Moves the edge pair collection\n"
"@args x,y\n"
"\n"
"Moves the edge pairs by the given offset and returns the \n"
"moved edge pairs. The edge pair collection is overwritten.\n"
@ -367,9 +356,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"@return The moved edge pairs (self).\n"
) +
method_ext ("moved", &moved_p,
method_ext ("moved", &moved_p, gsi::arg ("p"),
"@brief Returns the moved edge pair collection (does not modify self)\n"
"@args p\n"
"\n"
"Moves the edge pairs by the given offset and returns the \n"
"moved edge pairs. The edge pair collection is not modified.\n"
@ -380,9 +368,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"Starting with version 0.25 the displacement is of vector type."
) +
method_ext ("moved", &moved_xy,
method_ext ("moved", &moved_xy, gsi::arg ("x"), gsi::arg ("y"),
"@brief Returns the moved edge pair collection (does not modify self)\n"
"@args x,y\n"
"\n"
"Moves the edge pairs by the given offset and returns the \n"
"moved edge pairs. The edge pair collection is not modified.\n"
@ -392,9 +379,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"@return The moved edge pairs.\n"
) +
method ("transformed", (db::EdgePairs (db::EdgePairs::*)(const db::Trans &) const) &db::EdgePairs::transformed,
method ("transformed", (db::EdgePairs (db::EdgePairs::*)(const db::Trans &) const) &db::EdgePairs::transformed, gsi::arg ("t"),
"@brief Transform the edge pair collection\n"
"@args t\n"
"\n"
"Transforms the edge pairs with the given transformation.\n"
"Does not modify the edge pair collection but returns the transformed edge pairs.\n"
@ -403,9 +389,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"@return The transformed edge pairs.\n"
) +
method ("transformed|#transformed_icplx", (db::EdgePairs (db::EdgePairs::*)(const db::ICplxTrans &) const) &db::EdgePairs::transformed,
method ("transformed|#transformed_icplx", (db::EdgePairs (db::EdgePairs::*)(const db::ICplxTrans &) const) &db::EdgePairs::transformed, gsi::arg ("t"),
"@brief Transform the edge pair collection with a complex transformation\n"
"@args t\n"
"\n"
"Transforms the edge pairs with the given complex transformation.\n"
"Does not modify the edge pair collection but returns the transformed edge pairs.\n"
@ -414,9 +399,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"@return The transformed edge pairs.\n"
) +
method ("transform", (db::EdgePairs &(db::EdgePairs::*)(const db::Trans &)) &db::EdgePairs::transform,
method ("transform", (db::EdgePairs &(db::EdgePairs::*)(const db::Trans &)) &db::EdgePairs::transform, gsi::arg ("t"),
"@brief Transform the edge pair collection (modifies self)\n"
"@args t\n"
"\n"
"Transforms the edge pair collection with the given transformation.\n"
"This version modifies the edge pair collection and returns a reference to self.\n"
@ -425,9 +409,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"@return The transformed edge pair collection.\n"
) +
method ("transform|#transform_icplx", (db::EdgePairs &(db::EdgePairs::*)(const db::ICplxTrans &)) &db::EdgePairs::transform,
method ("transform|#transform_icplx", (db::EdgePairs &(db::EdgePairs::*)(const db::ICplxTrans &)) &db::EdgePairs::transform, gsi::arg ("t"),
"@brief Transform the edge pair collection with a complex transformation (modifies self)\n"
"@args t\n"
"\n"
"Transforms the edge pair collection with the given transformation.\n"
"This version modifies the edge pair collection and returns a reference to self.\n"
@ -436,9 +419,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"@return The transformed edge pair collection.\n"
) +
method_ext ("insert", &insert_e,
method_ext ("insert", &insert_e, gsi::arg ("edge_pairs"),
"@brief Inserts all edge pairs from the other edge pair collection into this edge pair collection\n"
"@args edge_pairs\n"
"This method has been introduced in version 0.25."
) +
method_ext ("edges", &edges,
@ -459,17 +441,15 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"The boxes will not be merged, so it is possible to determine overlaps "
"of these boxes for example.\n"
) +
method_ext ("extents", &extents1,
method_ext ("extents", &extents1, gsi::arg ("d"),
"@brief Returns a region with the enlarged bounding boxes of the edge pairs\n"
"@args d\n"
"This method will return a region consisting of the bounding boxes of the edge pairs enlarged by the given distance d.\n"
"The enlargement is specified per edge, i.e the width and height will be increased by 2*d.\n"
"The boxes will not be merged, so it is possible to determine overlaps "
"of these boxes for example.\n"
) +
method_ext ("extents", &extents2,
method_ext ("extents", &extents2, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Returns a region with the enlarged bounding boxes of the edge pairs\n"
"@args dx, dy\n"
"This method will return a region consisting of the bounding boxes of the edge pairs enlarged by the given distance dx in x direction and dy in y direction.\n"
"The enlargement is specified per edge, i.e the width will be increased by 2*dx.\n"
"The boxes will not be merged, so it is possible to determine overlaps "
@ -480,9 +460,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"This method creates polygons from the edge pairs. Each polygon will be a triangle or quadrangle "
"which connects the start and end points of the edges forming the edge pair."
) +
method_ext ("polygons", &polygons2,
method_ext ("polygons", &polygons2, gsi::arg ("e"),
"@brief Converts the edge pairs to polygons\n"
"@args e\n"
"This method creates polygons from the edge pairs. Each polygon will be a triangle or quadrangle "
"which connects the start and end points of the edges forming the edge pair. "
"This version allows one to specify an enlargement which is applied to the edges. The length of the edges is "
@ -493,9 +472,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
method ("clear", &db::EdgePairs::clear,
"@brief Clears the edge pair collection\n"
) +
method ("swap", &db::EdgePairs::swap,
method ("swap", &db::EdgePairs::swap, gsi::arg ("other"),
"@brief Swap the contents of this collection with the contents of another collection\n"
"@args other\n"
"This method is useful to avoid excessive memory allocation in some cases. "
"For managed memory languages such as Ruby, those cases will be rare. "
) +
@ -512,9 +490,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
gsi::iterator ("each", &db::EdgePairs::begin,
"@brief Returns each edge pair of the edge pair collection\n"
) +
method ("[]", &db::EdgePairs::nth,
method ("[]", &db::EdgePairs::nth, gsi::arg ("n"),
"@brief Returns the nth edge pair\n"
"@args n\n"
"\n"
"This method returns nil if the index is out of range. It is available for flat edge pairs only - i.e. "
"those for which \\has_valid_edge_pairs? is true. Use \\flatten to explicitly flatten an edge pair collection.\n"
@ -534,9 +511,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"\n"
"This method has been introduced in version 0.26."
) +
method ("enable_progress", &db::EdgePairs::enable_progress,
method ("enable_progress", &db::EdgePairs::enable_progress, gsi::arg ("label"),
"@brief Enable progress reporting\n"
"@args label\n"
"After calling this method, the edge pair collection will report the progress through a progress bar while "
"expensive operations are running.\n"
"The label is a text which is put in front of the progress bar.\n"
@ -551,9 +527,8 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
"The length of the output is limited to 20 edge pairs to avoid giant strings on large regions. "
"For full output use \"to_s\" with a maximum count parameter.\n"
) +
method_ext ("to_s", &to_string1,
method_ext ("to_s", &to_string1, gsi::arg ("max_count"),
"@brief Converts the edge pair collection to a string\n"
"@args max_count\n"
"This version allows specification of the maximum number of edge pairs contained in the string."
),
"@brief EdgePairs (a collection of edge pairs)\n"
@ -567,4 +542,3 @@ Class<db::EdgePairs> decl_EdgePairs ("db", "EdgePairs",
);
}

58
src/db/db/gsiDeclDbEdgeProcessor.cc
View File

@ -183,9 +183,8 @@ static int mode_anotb () { return int (db::BooleanOp::ANotB); }
static int mode_bnota () { return int (db::BooleanOp::BNotA); }
Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
method_ext ("simple_merge_p2e|#simple_merge", &gsi::simple_merge1,
method_ext ("simple_merge_p2e|#simple_merge", &gsi::simple_merge1, gsi::arg ("in"),
"@brief Merge the given polygons in a simple \"non-zero wrapcount\" fashion\n"
"@args in\n"
"\n"
"The wrapcount is computed over all polygons, i.e. overlapping polygons may \"cancel\" if they\n"
"have different orientation (since a polygon is oriented by construction that is not easy to achieve).\n"
@ -204,9 +203,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param in The input polygons\n"
"@return The output edges\n"
) +
method_ext ("simple_merge_p2e|#simple_merge", &gsi::simple_merge1m,
method_ext ("simple_merge_p2e|#simple_merge", &gsi::simple_merge1m, gsi::arg ("in"), gsi::arg ("mode"),
"@brief Merge the given polygons and specify the merge mode\n"
"@args in, mode\n"
"\n"
"The wrapcount is computed over all polygons, i.e. overlapping polygons may \"cancel\" if they\n"
"have different orientation (since a polygon is oriented by construction that is not easy to achieve).\n"
@ -229,9 +227,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param in The input polygons\n"
"@return The output edges\n"
) +
method_ext ("simple_merge_p2p|#simple_merge_to_polygon", &gsi::simple_merge_to_polygon1,
method_ext ("simple_merge_p2p|#simple_merge_to_polygon", &gsi::simple_merge_to_polygon1, gsi::arg ("in"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Merge the given polygons in a simple \"non-zero wrapcount\" fashion into polygons\n"
"@args in, resolve_holes, min_coherence\n"
"\n"
"The wrapcount is computed over all polygons, i.e. overlapping polygons may \"cancel\" if they\n"
"have different orientation (since a polygon is oriented by construction that is not easy to achieve).\n"
@ -251,9 +248,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method_ext ("simple_merge_p2p|#simple_merge_to_polygon", &gsi::simple_merge_to_polygon1m,
method_ext ("simple_merge_p2p|#simple_merge_to_polygon", &gsi::simple_merge_to_polygon1m, gsi::arg ("in"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"), gsi::arg ("mode"),
"@brief Merge the given polygons and specify the merge mode\n"
"@args in, resolve_holes, min_coherence, mode\n"
"\n"
"The wrapcount is computed over all polygons, i.e. overlapping polygons may \"cancel\" if they\n"
"have different orientation (since a polygon is oriented by construction that is not easy to achieve).\n"
@ -277,9 +273,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method_ext ("simple_merge_e2e|#simple_merge", &gsi::simple_merge2,
method_ext ("simple_merge_e2e|#simple_merge", &gsi::simple_merge2, gsi::arg ("in"),
"@brief Merge the given edges in a simple \"non-zero wrapcount\" fashion\n"
"@args in\n"
"\n"
"The edges provided must form valid closed contours. Contours oriented differently \"cancel\" each other. \n"
"Overlapping contours are merged when the orientation is the same.\n"
@ -296,9 +291,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param in The input edges\n"
"@return The output edges\n"
) +
method_ext ("simple_merge_e2e|#simple_merge", &gsi::simple_merge2m,
method_ext ("simple_merge_e2e|#simple_merge", &gsi::simple_merge2m, gsi::arg ("in"), gsi::arg ("mode"),
"@brief Merge the given polygons and specify the merge mode\n"
"@args in, mode\n"
"\n"
"The edges provided must form valid closed contours. Contours oriented differently \"cancel\" each other. \n"
"Overlapping contours are merged when the orientation is the same.\n"
@ -319,9 +313,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param in The input edges\n"
"@return The output edges\n"
) +
method_ext ("simple_merge_e2p|#simple_merge_to_polygon", &gsi::simple_merge_to_polygon2,
method_ext ("simple_merge_e2p|#simple_merge_to_polygon", &gsi::simple_merge_to_polygon2, gsi::arg ("in"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Merge the given edges in a simple \"non-zero wrapcount\" fashion into polygons\n"
"@args in, resolve_holes, min_coherence\n"
"\n"
"The edges provided must form valid closed contours. Contours oriented differently \"cancel\" each other. \n"
"Overlapping contours are merged when the orientation is the same.\n"
@ -339,9 +332,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method_ext ("simple_merge_e2p|#simple_merge_to_polygon", &gsi::simple_merge_to_polygon2m,
method_ext ("simple_merge_e2p|#simple_merge_to_polygon", &gsi::simple_merge_to_polygon2m, gsi::arg ("in"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"), gsi::arg ("mode"),
"@brief Merge the given polygons and specify the merge mode\n"
"@args in, resolve_holes, min_coherence, mode\n"
"\n"
"The edges provided must form valid closed contours. Contours oriented differently \"cancel\" each other. \n"
"Overlapping contours are merged when the orientation is the same.\n"
@ -363,9 +355,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method_ext ("merge_p2e|#merge", &gsi::merge,
method_ext ("merge_p2e|#merge", &gsi::merge, gsi::arg ("in"), gsi::arg ("min_wc"),
"@brief Merge the given polygons \n"
"@args in, min_wc\n"
"\n"
"In contrast to \"simple_merge\", this merge implementation considers each polygon individually before merging them.\n"
"Thus self-overlaps are effectively removed before the output is computed and holes are correctly merged with the\n"
@ -383,9 +374,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_wc The minimum wrap count for output (0: all polygons, 1: at least two overlapping)\n"
"@return The output edges\n"
) +
method_ext ("merge_p2p|#merge_to_polygon", &gsi::merge_to_polygon,
method_ext ("merge_p2p|#merge_to_polygon", &gsi::merge_to_polygon, gsi::arg ("in"), gsi::arg ("min_wc"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Merge the given polygons \n"
"@args in, min_wc, resolve_holes, min_coherence\n"
"\n"
"In contrast to \"simple_merge\", this merge implementation considers each polygon individually before merging them.\n"
"Thus self-overlaps are effectively removed before the output is computed and holes are correctly merged with the\n"
@ -404,9 +394,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method_ext ("size_p2e|#size", &gsi::size1,
method_ext ("size_p2e|#size", &gsi::size1, gsi::arg ("in"), gsi::arg ("dx"), gsi::arg ("dy"), gsi::arg ("mode"),
"@brief Size the given polygons \n"
"@args in, dx, dy, mode\n"
"\n"
"This method sizes a set of polygons. Before the sizing is applied, the polygons are merged. After that, sizing is applied \n"
"on the individual result polygons of the merge step. The result may contain overlapping contours, but no self-overlaps. \n"
@ -432,9 +421,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param mode The sizing mode (standard is 2)\n"
"@return The output edges\n"
) +
method_ext ("size_p2p|#size_to_polygon", &gsi::size_to_polygon1,
method_ext ("size_p2p|#size_to_polygon", &gsi::size_to_polygon1, gsi::arg ("in"), gsi::arg ("dx"), gsi::arg ("dy"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Size the given polygons into polygons\n"
"@args in, dx, dy, mode, resolve_holes, min_coherence\n"
"\n"
"This method sizes a set of polygons. Before the sizing is applied, the polygons are merged. After that, sizing is applied \n"
"on the individual result polygons of the merge step. The result may contain overlapping polygons, but no self-overlapping ones. \n"
@ -462,9 +450,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method_ext ("size_p2e|#size", &gsi::size2,
method_ext ("size_p2e|#size", &gsi::size2, gsi::arg ("in"), gsi::arg ("d"), gsi::arg ("mode"),
"@brief Size the given polygons (isotropic)\n"
"@args in, d, mode\n"
"\n"
"This method is equivalent to calling the anisotropic version with identical dx and dy.\n"
"\n"
@ -476,9 +463,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param mode The sizing mode\n"
"@return The output edges\n"
) +
method_ext ("size_p2p|#size_to_polygon", &gsi::size_to_polygon2,
method_ext ("size_p2p|#size_to_polygon", &gsi::size_to_polygon2, gsi::arg ("in"), gsi::arg ("d"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Size the given polygons into polygons (isotropic)\n"
"@args in, d, mode, resolve_holes, min_coherence\n"
"\n"
"This method is equivalent to calling the anisotropic version with identical dx and dy.\n"
"\n"
@ -492,9 +478,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method_ext ("boolean_p2e|#boolean", &gsi::boolean1,
method_ext ("boolean_p2e|#boolean", &gsi::boolean1, gsi::arg ("a"), gsi::arg ("b"), gsi::arg ("mode"),
"@brief Boolean operation for a set of given polygons, creating edges\n"
"@args a, b, mode\n"
"\n"
"This method computes the result for the given boolean operation on two sets of polygons.\n"
"The result is presented as a set of edges forming closed contours. Hulls are oriented clockwise while\n"
@ -511,9 +496,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param mode The boolean mode\n"
"@return The output edges\n"
) +
method_ext ("boolean_p2p|#boolean_to_polygon", &gsi::boolean_to_polygon1,
method_ext ("boolean_p2p|#boolean_to_polygon", &gsi::boolean_to_polygon1, gsi::arg ("a"), gsi::arg ("b"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Boolean operation for a set of given polygons, creating polygons\n"
"@args a, b, mode, resolve_holes, min_coherence\n"
"\n"
"This method computes the result for the given boolean operation on two sets of polygons.\n"
"This method produces polygons on output and allows fine-tuning of the parameters for that purpose.\n"
@ -531,9 +515,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method_ext ("boolean_e2e|#boolean", &gsi::boolean2,
method_ext ("boolean_e2e|#boolean", &gsi::boolean2, gsi::arg ("a"), gsi::arg ("b"), gsi::arg ("mode"),
"@brief Boolean operation for a set of given edges, creating edges\n"
"@args a, b, mode\n"
"\n"
"This method computes the result for the given boolean operation on two sets of edges.\n"
"The input edges must form closed contours where holes and hulls must be oriented differently. \n"
@ -550,9 +533,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param mode The boolean mode (one of the Mode.. values)\n"
"@return The output edges\n"
) +
method_ext ("boolean_e2p|#boolean_to_polygon", &gsi::boolean_to_polygon2,
method_ext ("boolean_e2p|#boolean_to_polygon", &gsi::boolean_to_polygon2, gsi::arg ("a"), gsi::arg ("b"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Boolean operation for a set of given edges, creating polygons\n"
"@args a, b, mode, resolve_holes, min_coherence\n"
"\n"
"This method computes the result for the given boolean operation on two sets of edges.\n"
"The input edges must form closed contours where holes and hulls must be oriented differently. \n"
@ -570,9 +552,8 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
"@param min_coherence true, if touching corners should be resolved into less connected contours\n"
"@return The output polygons\n"
) +
method ("enable_progress", &db::EdgeProcessor::enable_progress,
method ("enable_progress", &db::EdgeProcessor::enable_progress, gsi::arg ("label"),
"@brief Enable progress reporting\n"
"@args label\n"
"After calling this method, the edge processor will report the progress through a progress bar.\n"
"The label is a text which is put in front of the progress bar.\n"
"Using a progress bar will imply a performance penalty of a few percent typically.\n"
@ -610,4 +591,3 @@ Class<db::EdgeProcessor> decl_EdgeProcessor ("db", "EdgeProcessor",
);
} // namespace gsi

16
src/db/db/gsiDeclDbInstElement.cc
View File

@ -92,14 +92,12 @@ Class<db::InstElement> decl_InstElement ("db", "InstElement",
gsi::constructor ("new", &new_v,
"@brief Default constructor"
) +
gsi::constructor ("new|#new_i", &new_i,
gsi::constructor ("new|#new_i", &new_i, gsi::arg ("inst"),
"@brief Create an instance element from a single instance alone\n"
"@args inst\n"
"Starting with version 0.15, this method takes an \\Instance object (an instance reference) as the argument.\n"
) +
gsi::constructor ("new|#new_iab", &new_iab,
gsi::constructor ("new|#new_iab", &new_iab, gsi::arg ("inst"), gsi::arg ("a_index"), gsi::arg ("b_index"),
"@brief Create an instance element from an array instance pointing into a certain array member\n"
"@args inst, a_index, b_index\n"
"Starting with version 0.15, this method takes an \\Instance object (an instance reference) as the first argument.\n"
) +
gsi::method_ext ("inst", &inst,
@ -117,19 +115,16 @@ Class<db::InstElement> decl_InstElement ("db", "InstElement",
"\n"
"This method is equivalent to \"self.inst.prop_id\" and provided for convenience.\n"
) +
gsi::method ("<", &db::InstElement::operator<,
gsi::method ("<", &db::InstElement::operator<, gsi::arg ("b"),
"@brief Provides an order criterion for two InstElement objects\n"
"@args b\n"
"Note: this operator is just provided to establish any order, not a particular one."
) +
gsi::method ("!=", &db::InstElement::operator!=,
gsi::method ("!=", &db::InstElement::operator!=, gsi::arg ("b"),
"@brief Inequality of two InstElement objects\n"
"@args b\n"
"See the comments on the == operator.\n"
) +
gsi::method ("==", &db::InstElement::operator==,
gsi::method ("==", &db::InstElement::operator==, gsi::arg ("b"),
"@brief Equality of two InstElement objects\n"
"@args b\n"
"Note: this operator returns true if both instance elements refer to the same instance, not just identical ones."
) +
gsi::method_ext ("ia", &array_index_a,
@ -182,4 +177,3 @@ Class<db::InstElement> decl_InstElement ("db", "InstElement",
);
} // namespace gsi

16
src/db/db/gsiDeclDbLayerMapping.cc
View File

@ -31,10 +31,9 @@ namespace gsi
{
Class<db::LayerMapping> decl_LayerMapping ("db", "LayerMapping",
gsi::method ("create", &db::LayerMapping::create,
gsi::method ("create", &db::LayerMapping::create, gsi::arg ("layout_a"), gsi::arg ("layout_b"),
"@brief Initialize the layer mapping from two layouts\n"
"\n"
"@args layout_a, layout_b\n"
"@param layout_a The target layout\n"
"@param layout_b The source layout\n"
"\n"
@ -43,10 +42,9 @@ Class<db::LayerMapping> decl_LayerMapping ("db", "LayerMapping",
"will not be mapped.\n"
"\\create_full is a version of this method which creates new layers in layout_a if no corresponding layer is found.\n"
) +
gsi::method ("create_full", &db::LayerMapping::create_full,
gsi::method ("create_full", &db::LayerMapping::create_full, gsi::arg ("layout_a"), gsi::arg ("layout_b"),
"@brief Initialize the layer mapping from two layouts\n"
"\n"
"@args layout_a, layout_b\n"
"@param layout_a The target layout\n"
"@param layout_b The source layout\n"
"@return A list of layers created\n"
@ -59,10 +57,9 @@ Class<db::LayerMapping> decl_LayerMapping ("db", "LayerMapping",
gsi::method ("clear", &db::LayerMapping::clear,
"@brief Clears the mapping.\n"
) +
gsi::method ("map", &db::LayerMapping::map,
gsi::method ("map", &db::LayerMapping::map, gsi::arg ("layer_index_b"), gsi::arg ("layer_index_a"),
"@brief Explicitly specify a mapping.\n"
"\n"
"@args layer_index_b, layer_index_a\n"
"\n"
"@param layer_index_b The index of the layer in layout B (the \"source\")\n"
"@param layer_index_a The index of the layer in layout A (the \"target\")\n"
@ -77,18 +74,16 @@ Class<db::LayerMapping> decl_LayerMapping ("db", "LayerMapping",
"\n"
"This method has been introduced in version 0.25."
) +
gsi::method ("has_mapping?", &db::LayerMapping::has_mapping,
gsi::method ("has_mapping?", &db::LayerMapping::has_mapping, gsi::arg ("layer_index_b"),
"@brief Determine if a layer in layout_b has a mapping to a layout_a layer.\n"
"\n"
"@args layer_index_b\n"
"\n"
"@param layer_index_b The index of the layer in layout_b whose mapping is requested.\n"
"@return true, if the layer has a mapping\n"
) +
gsi::method ("layer_mapping", &db::LayerMapping::layer_mapping,
gsi::method ("layer_mapping", &db::LayerMapping::layer_mapping, gsi::arg ("layer_index_b"),
"@brief Determine layer mapping of a layout_b layer to the corresponding layout_a layer.\n"
"\n"
"@args layer_index_b\n"
"\n"
"@param layer_index_b The index of the layer in layout_b whose mapping is requested.\n"
"@return The corresponding layer in layout_a.\n"
@ -125,4 +120,3 @@ Class<db::LayerMapping> decl_LayerMapping ("db", "LayerMapping",
}

295
src/db/db/gsiDeclDbLayout.cc
View File

@ -128,26 +128,23 @@ Class<db::LayerProperties> decl_LayerInfo ("db", "LayerInfo",
"\n"
"This method was added in version 0.18.\n"
) +
gsi::constructor ("new", &ctor_layer_info_ld,
gsi::constructor ("new", &ctor_layer_info_ld, gsi::arg ("layer"), gsi::arg ("datatype"),
"@brief The constructor for a layer/datatype pair.\n"
"@args layer,datatype\n"
"Creates a \\LayerInfo object representing a layer and datatype.\n"
"@param layer The layer number\n"
"@param datatype The datatype number\n"
"\n"
"This method was added in version 0.18.\n"
) +
gsi::constructor ("new", &ctor_layer_info_name,
gsi::constructor ("new", &ctor_layer_info_name, gsi::arg ("name"),
"@brief The constructor for a named layer.\n"
"@args name\n"
"Creates a \\LayerInfo object representing a named layer.\n"
"@param name The name\n"
"\n"
"This method was added in version 0.18.\n"
) +
gsi::constructor ("new", &ctor_layer_info_ldn,
gsi::constructor ("new", &ctor_layer_info_ldn, gsi::arg ("layer"), gsi::arg ("datatype"), gsi::arg ("name"),
"@brief The constructor for a named layer with layer and datatype.\n"
"@args layer,datatype,name\n"
"Creates a \\LayerInfo object representing a named layer with layer and datatype.\n"
"@param layer The layer number\n"
"@param datatype The datatype number\n"
@ -155,9 +152,8 @@ Class<db::LayerProperties> decl_LayerInfo ("db", "LayerInfo",
"\n"
"This method was added in version 0.18.\n"
) +
gsi::method ("from_string", &li_from_string,
gsi::method ("from_string", &li_from_string, gsi::arg ("s"),
"@brief Create a layer info object from a string\n"
"@args s\n"
"@param The string\n"
"@return The LayerInfo object\n"
"\n"
@ -172,24 +168,21 @@ Class<db::LayerProperties> decl_LayerInfo ("db", "LayerInfo",
"\n"
"This method was added in version 0.18.\n"
) +
gsi::method ("==", &db::LayerProperties::operator==,
gsi::method ("==", &db::LayerProperties::operator==, gsi::arg ("b"),
"@brief Compares two layer info objects\n"
"@return True, if both are equal\n"
"@args b\n"
"\n"
"This method was added in version 0.18.\n"
) +
gsi::method ("!=", &db::LayerProperties::operator!=,
gsi::method ("!=", &db::LayerProperties::operator!=, gsi::arg ("b"),
"@brief Compares two layer info objects\n"
"@return True, if both are not equal\n"
"@args b\n"
"\n"
"This method was added in version 0.18.\n"
) +
gsi::method ("is_equivalent?", &db::LayerProperties::log_equal,
gsi::method ("is_equivalent?", &db::LayerProperties::log_equal, gsi::arg ("b"),
"@brief Equivalence of two layer info objects\n"
"@return True, if both are equivalent\n"
"@args b\n"
"\n"
"First, layer and datatype are compared. The name is of second order and used only if no layer or datatype is given.\n"
"This is basically a weak comparison that reflects the search preferences.\n"
@ -214,24 +207,21 @@ Class<db::LayerProperties> decl_LayerInfo ("db", "LayerInfo",
"\n"
"This method was added in version 0.18.\n"
) +
gsi::method_ext ("name=", &lp_set_name,
gsi::method_ext ("name=", &lp_set_name, gsi::arg ("name"),
"@brief Set the layer name\n"
"The name is set on OASIS input for example, if the layer has a name.\n"
"@args name"
) +
gsi::method_ext ("name", &lp_get_name,
"@brief Gets the layer name\n"
) +
gsi::method_ext ("layer=", &lp_set_layer,
gsi::method_ext ("layer=", &lp_set_layer, gsi::arg ("layer"),
"@brief Sets the layer number\n"
"@args layer\n"
) +
gsi::method_ext ("layer", &lp_get_layer,
"@brief Gets the layer number\n"
) +
gsi::method_ext ("datatype=", &lp_set_datatype,
gsi::method_ext ("datatype=", &lp_set_datatype, gsi::arg ("datatype"),
"@brief Set the datatype\n"
"@args datatype"
) +
gsi::method_ext ("datatype", &lp_get_datatype,
"@brief Gets the datatype\n"
@ -875,9 +865,8 @@ static void dtransform_cplx (db::Layout *layout, const db::DCplxTrans &trans)
}
Class<db::Layout> decl_Layout ("db", "Layout",
gsi::constructor ("new", &layout_ctor_with_manager,
gsi::constructor ("new", &layout_ctor_with_manager, gsi::arg ("manager"),
"@brief Creates a layout object attached to a manager\n"
"@args manager\n"
"\n"
"This constructor specifies a manager object which is used to "
"store undo information for example.\n"
@ -893,9 +882,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"always editable. Before that version, they inherited the editable flag from "
"the application."
) +
gsi::constructor ("new", &editable_layout_ctor_with_manager,
gsi::constructor ("new", &editable_layout_ctor_with_manager, gsi::arg ("editable"), gsi::arg ("manager"),
"@brief Creates a layout object attached to a manager\n"
"@args editable,manager\n"
"\n"
"This constructor specifies a manager object which is used to "
"store undo information for example. It also allows one to specify whether "
@ -904,9 +892,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method was introduced in version 0.22.\n"
) +
gsi::constructor ("new", &editable_layout_default_ctor,
gsi::constructor ("new", &editable_layout_default_ctor, gsi::arg ("editable"),
"@brief Creates a layout object\n"
"@args editable\n"
"\n"
"This constructor specifies whether "
"the layout is editable. In editable mode, some optimisations are disabled "
@ -958,9 +945,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.24."
) +
method ("prop_id=", (void (db::Layout::*) (db::properties_id_type)) &db::Layout::prop_id,
method ("prop_id=", (void (db::Layout::*) (db::properties_id_type)) &db::Layout::prop_id, gsi::arg ("id"),
"@brief Sets the properties ID associated with the layout\n"
"@args id\n"
"This method is provided, if a properties ID has been derived already. Usually it's more convenient "
"to use \\delete_property, \\set_property or \\property.\n"
"\n"
@ -971,9 +957,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("delete_property", &delete_layout_property,
gsi::method_ext ("delete_property", &delete_layout_property, gsi::arg ("key"),
"@brief Deletes the user property with the given key\n"
"@args key\n"
"This method is a convenience method that deletes the property with the given key. "
"It does nothing if no property with that key exists. Using that method is more "
"convenient than creating a new property set with a new ID and assigning that properties ID.\n"
@ -981,9 +966,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("set_property", &set_layout_property,
gsi::method_ext ("set_property", &set_layout_property, gsi::arg ("key"), gsi::arg ("value"),
"@brief Set the user property with the given key to the given value\n"
"@args key, value\n"
"This method is a convenience method that sets the property with the given key to the given value. "
"If no property with that key exists, it will create one. Using that method is more "
"convenient than creating a new property set with a new ID and assigning that properties ID.\n"
@ -991,18 +975,16 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("property", &get_layout_property,
gsi::method_ext ("property", &get_layout_property, gsi::arg ("key"),
"@brief Gets the user property with the given key\n"
"@args key\n"
"This method is a convenience method that gets the property with the given key. "
"If no property with that key exists, it will return nil. Using that method is more "
"convenient than using the properties ID to retrieve the property value. "
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("properties_id", &properties_id,
gsi::method_ext ("properties_id", &properties_id, gsi::arg ("properties"),
"@brief Gets the properties ID for a given properties set\n"
"@args properties\n"
"\n"
"Before a set of properties can be attached to a shape, it must be converted into an ID that "
"is unique for that set. The properties set must be given as a list of pairs of variants, "
@ -1012,9 +994,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"@param properties The array of pairs of variants (both elements can be integer, double or string)\n"
"@return The unique properties ID for that set"
) +
gsi::method_ext ("properties", &properties,
gsi::method_ext ("properties", &properties, gsi::arg ("properties_id"),
"@brief Gets the properties set for a given properties ID\n"
"@args properties_id\n"
"\n"
"Basically performs the backward conversion of the 'properties_id' method. "
"Given a properties ID, returns the properties set as an array of pairs of "
@ -1041,27 +1022,23 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method ("has_cell?", &db::Layout::has_cell,
gsi::method ("has_cell?", &db::Layout::has_cell, gsi::arg ("name"),
"@brief Returns true if a cell with a given name exists\n"
"@args name\n"
"Returns true, if the layout has a cell with the given name"
) +
gsi::method_ext ("#cell_by_name", &cell_by_name,
gsi::method_ext ("#cell_by_name", &cell_by_name, gsi::arg ("name"),
"@brief Gets the cell index for a given name\n"
"@args name\n"
"Returns the cell index for the cell with the given name. If no cell with this "
"name exists, an exception is thrown."
"\n"
"From version 0.23 on, a version of the \\cell method is provided which returns a \\Cell object for the cell with the given name "
"or \"nil\" if the name is not valid. This method replaces \\cell_by_name and \\has_cell?\n"
) +
gsi::method ("cell_name", &db::Layout::cell_name,
gsi::method ("cell_name", &db::Layout::cell_name, gsi::arg ("index"),
"@brief Gets the name for a cell with the given index\n"
"@args index\n"
) +
gsi::method_ext ("create_cell", &create_cell,
gsi::method_ext ("create_cell", &create_cell, gsi::arg ("name"),
"@brief Creates a cell with the given name\n"
"@args name\n"
"@param name The name of the cell to create\n"
"@return The \\Cell object of the newly created cell.\n"
"\n"
@ -1070,9 +1047,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduce in version 0.23 and replaces \\add_cell.\n"
) +
gsi::method_ext ("create_cell", &create_cell2,
gsi::method_ext ("create_cell", &create_cell2, gsi::arg ("name"), gsi::arg ("params"),
"@brief Creates a cell as a PCell variant with the given name\n"
"@args name, params\n"
"@param name The name of the PCell and the name of the cell to create\n"
"@param params The PCell parameters (key/value dictionary)\n"
"@return The \\Cell object of the newly created cell.\n"
@ -1085,9 +1061,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduce in version 0.24.\n"
) +
gsi::method_ext ("create_cell", &create_cell3,
gsi::method_ext ("create_cell", &create_cell3, gsi::arg ("name"), gsi::arg ("lib_name"),
"@brief Creates a cell with the given name\n"
"@args name, lib_name\n"
"@param name The name of the library cell and the name of the cell to create\n"
"@param lib_name The name of the library where to take the cell from\n"
"@return The \\Cell object of the newly created cell.\n"
@ -1097,9 +1072,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduce in version 0.24.\n"
) +
gsi::method_ext ("create_cell", &create_cell4,
gsi::method_ext ("create_cell", &create_cell4, gsi::arg ("name"), gsi::arg ("lib_name"), gsi::arg ("params"),
"@brief Creates a cell with the given name\n"
"@args name, lib_name, params\n"
"@param name The name of the PCell and the name of the cell to create\n"
"@param lib_name The name of the library where to take the PCell from\n"
"@param params The PCell parameters (key/value dictionary)\n"
@ -1113,21 +1087,18 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduce in version 0.24.\n"
) +
gsi::method ("#add_cell", &db::Layout::add_cell,
gsi::method ("#add_cell", &db::Layout::add_cell, gsi::arg ("name"),
"@brief Adds a cell with the given name\n"
"@args name\n"
"@return The index of the newly created cell.\n"
"\n"
"From version 0.23 on this method is deprecated because another method exists which is more convenient because "
"is returns a \\Cell object (\\create_cell).\n"
) +
gsi::method ("rename_cell", &db::Layout::rename_cell,
gsi::method ("rename_cell", &db::Layout::rename_cell, gsi::arg ("index"), gsi::arg ("name"),
"@brief name\n"
"@args index, name\n"
) +
gsi::method ("delete_cell", &db::Layout::delete_cell,
gsi::method ("delete_cell", &db::Layout::delete_cell, gsi::arg ("cell_index"),
"@brief Deletes a cell \n"
"@args cell_index\n"
"\n"
"This deletes a cell but not the sub cells of the cell.\n"
"These subcells will likely become new top cells unless they are used\n"
@ -1140,9 +1111,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.20.\n"
) +
gsi::method_ext ("delete_cells", &delete_cells,
gsi::method_ext ("delete_cells", &delete_cells, gsi::arg ("cell_index_list"),
"@brief Deletes multiple cells\n"
"@args cell_index_list\n"
"\n"
"This deletes the cells but not the sub cells of these cells.\n"
"These subcells will likely become new top cells unless they are used\n"
@ -1153,9 +1123,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.20.\n"
) +
gsi::method_ext ("prune_subcells", &prune_subcells,
gsi::method_ext ("prune_subcells", &prune_subcells, gsi::arg ("cell_index"), gsi::arg ("levels"),
"@brief Deletes all sub cells of the cell which are not used otherwise down to the specified level of hierarchy\n"
"@args cell_index, levels\n"
"\n"
"This deletes all sub cells of the cell which are not used otherwise.\n"
"All instances of the deleted cells are deleted as well.\n"
@ -1166,9 +1135,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.20.\n"
) +
gsi::method_ext ("prune_cell", &prune_cell,
gsi::method_ext ("prune_cell", &prune_cell, gsi::arg ("cell_index"), gsi::arg ("levels"),
"@brief Deletes a cell plus subcells not used otherwise\n"
"@args cell_index, levels\n"
"\n"
"This deletes a cell and also all sub cells of the cell which are not used otherwise.\n"
"The number of hierarchy levels to consider can be specified as well. One level of hierarchy means that "
@ -1180,9 +1148,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.20.\n"
) +
gsi::method ("delete_cell_rec", &db::Layout::delete_cell_rec,
gsi::method ("delete_cell_rec", &db::Layout::delete_cell_rec, gsi::arg ("cell_index"),
"@brief Deletes a cell plus all subcells\n"
"@args cell_index\n"
"\n"
"This deletes a cell and also all sub cells of the cell.\n"
"In contrast to \\prune_cell, all cells are deleted together with their instances even if they are used otherwise.\n"
@ -1215,9 +1182,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.26.\n"
) +
gsi::method_ext ("flatten", &flatten,
gsi::method_ext ("flatten", &flatten, gsi::arg ("cell_index"), gsi::arg ("levels"), gsi::arg ("prune"),
"@brief Flattens the given cell\n"
"@args cell_index, levels, prune\n"
"\n"
"This method propagates all shapes and instances from the specified number of hierarchy levels below into the given cell.\n"
"It also removes the instances of the cells from which the shapes came from, but does not remove the cells themselves if prune is set to false.\n"
@ -1229,9 +1195,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.20.\n"
) +
gsi::method_ext ("flatten_into", &flatten_into,
gsi::method_ext ("flatten_into", &flatten_into, gsi::arg ("source_cell_index"), gsi::arg ("target_cell_index"), gsi::arg ("trans"), gsi::arg ("levels"),
"@brief Flattens the given cell into another cell\n"
"@args source_cell_index, target_cell_index, trans, levels\n"
"\n"
"This method works like 'flatten', but allows specification of a target cell which can be different from the source cell plus "
"a transformation which is applied for all shapes and instances in the target cell.\n"
@ -1290,9 +1255,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method ("dbu=", (void (db::Layout::*) (double)) &db::Layout::dbu,
gsi::method ("dbu=", (void (db::Layout::*) (double)) &db::Layout::dbu, gsi::arg ("dbu"),
"@brief Sets the database unit\n"
"@args dbu\n"
"\n"
"See \\dbu for a description of the database unit.\n"
) +
@ -1316,9 +1280,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method ("layer", &db::Layout::get_layer,
gsi::method ("layer", &db::Layout::get_layer, gsi::arg ("info"),
"@brief Finds or creates a layer with the given properties\n"
"@args info\n"
"\n"
"If a layer with the given properties already exists, this method will return the index of that layer."
"If no such layer exists, a new one with these properties will be created and its index will be returned. "
@ -1326,77 +1289,68 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("layer", &get_layer1,
gsi::method_ext ("layer", &get_layer1, gsi::arg ("name"),
"@brief Finds or creates a layer with the given name\n"
"@args name\n"
"\n"
"If a layer with the given name already exists, this method will return the index of that layer."
"If no such layer exists, a new one with theis name will be created and its index will be returned.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("layer", &get_layer2,
gsi::method_ext ("layer", &get_layer2, gsi::arg ("layer"), gsi::arg ("datatype"),
"@brief Finds or creates a layer with the given layer and datatype number\n"
"@args layer, datatype\n"
"\n"
"If a layer with the given layer/datatype already exists, this method will return the index of that layer."
"If no such layer exists, a new one with these properties will be created and its index will be returned.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("layer", &get_layer3,
gsi::method_ext ("layer", &get_layer3, gsi::arg ("layer"), gsi::arg ("datatype"), gsi::arg ("name"),
"@brief Finds or creates a layer with the given layer and datatype number and name\n"
"@args layer, datatype, name\n"
"\n"
"If a layer with the given layer/datatype/name already exists, this method will return the index of that layer."
"If no such layer exists, a new one with these properties will be created and its index will be returned.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("find_layer", &find_layer,
gsi::method_ext ("find_layer", &find_layer, gsi::arg ("info"),
"@brief Finds a layer with the given properties\n"
"@args info\n"
"\n"
"If a layer with the given properties already exists, this method will return the index of that layer."
"If no such layer exists, it will return nil.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("find_layer", &find_layer1,
gsi::method_ext ("find_layer", &find_layer1, gsi::arg ("name"),
"@brief Finds a layer with the given name\n"
"@args name\n"
"\n"
"If a layer with the given name already exists, this method will return the index of that layer."
"If no such layer exists, it will return nil.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("find_layer", &find_layer2,
gsi::method_ext ("find_layer", &find_layer2, gsi::arg ("layer"), gsi::arg ("datatype"),
"@brief Finds a layer with the given layer and datatype number\n"
"@args layer, datatype\n"
"\n"
"If a layer with the given layer/datatype already exists, this method will return the index of that layer."
"If no such layer exists, it will return nil.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("find_layer", &find_layer3,
gsi::method_ext ("find_layer", &find_layer3, gsi::arg ("layer"), gsi::arg ("datatype"), gsi::arg ("name"),
"@brief Finds a layer with the given layer and datatype number and name\n"
"@args layer, datatype, name\n"
"\n"
"If a layer with the given layer/datatype/name already exists, this method will return the index of that layer."
"If no such layer exists, it will return nil.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("insert_layer", (unsigned int (db::Layout::*) (const db::LayerProperties &)) &db::Layout::insert_layer,
gsi::method ("insert_layer", (unsigned int (db::Layout::*) (const db::LayerProperties &)) &db::Layout::insert_layer, gsi::arg ("props"),
"@brief Inserts a new layer with the given properties\n"
"@args props\n"
"@return The index of the newly created layer\n"
) +
gsi::method ("insert_layer_at", (void (db::Layout::*) (unsigned int, const db::LayerProperties &)) &db::Layout::insert_layer,
gsi::method ("insert_layer_at", (void (db::Layout::*) (unsigned int, const db::LayerProperties &)) &db::Layout::insert_layer, gsi::arg ("index"), gsi::arg ("props"),
"@brief Inserts a new layer with the given properties at the given index\n"
"@args index, props\n"
"This method will associate the given layer info with the given layer index. If a layer with that index already "
"exists, this method will change the properties of the layer with that index. Otherwise a new layer is created."
) +
@ -1406,37 +1360,32 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.22.\n"
) +
gsi::method ("insert_special_layer", (unsigned int (db::Layout::*) (const db::LayerProperties &)) &db::Layout::insert_special_layer,
gsi::method ("insert_special_layer", (unsigned int (db::Layout::*) (const db::LayerProperties &)) &db::Layout::insert_special_layer, gsi::arg ("props"),
"@brief Inserts a new special layer with the given properties\n"
"@args props\n"
"\n"
"Special layers can be used to represent objects that should not participate in normal viewing or other "
"related operations. Special layers are not reported as valid layers.\n"
"\n"
"@return The index of the newly created layer\n"
) +
gsi::method ("insert_special_layer_at", (void (db::Layout::*) (unsigned int, const db::LayerProperties &)) &db::Layout::insert_special_layer,
gsi::method ("insert_special_layer_at", (void (db::Layout::*) (unsigned int, const db::LayerProperties &)) &db::Layout::insert_special_layer, gsi::arg ("index"), gsi::arg ("props"),
"@brief Inserts a new special layer with the given properties at the given index\n"
"@args index, props\n"
"\n"
"See \\insert_special_layer for a description of special layers."
) +
gsi::method ("set_info", &db::Layout::set_properties,
gsi::method ("set_info", &db::Layout::set_properties, gsi::arg ("index"), gsi::arg ("props"),
"@brief Sets the info structure for a specified layer\n"
"@args index, props\n"
) +
gsi::method ("get_info", &db::Layout::get_properties,
gsi::method ("get_info", &db::Layout::get_properties, gsi::arg ("index"),
"@brief Gets the info structure for a specified layer\n"
"@args index\n"
) +
gsi::method ("cells", &db::Layout::cells,
"@brief Returns the number of cells\n"
"\n"
"@return The number of cells (the maximum cell index)\n"
) +
gsi::method_ext ("cell", &cell_from_name,
gsi::method_ext ("cell", &cell_from_name, gsi::arg ("name"),
"@brief Gets a cell object from the cell name\n"
"@args name\n"
"\n"
"@param name The cell name\n"
"@return A reference to the cell (a \\Cell object)\n"
@ -1444,9 +1393,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"If name is not a valid cell name, this method will return \"nil\".\n"
"This method has been introduced in version 0.23 and replaces \\cell_by_name.\n"
) +
gsi::method_ext ("cell", &cell_from_index,
gsi::method_ext ("cell", &cell_from_index, gsi::arg ("i"),
"@brief Gets a cell object from the cell index\n"
"@args i\n"
"\n"
"@param i The cell index\n"
"@return A reference to the cell (a \\Cell object)\n"
@ -1480,9 +1428,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"A layout may have an arbitrary number of top cells. The usual case however is that there is one "
"top cell."
) +
gsi::method ("swap_layers", &db::Layout::swap_layers,
gsi::method ("swap_layers", &db::Layout::swap_layers, gsi::arg ("a"), gsi::arg ("b"),
"@brief Swap two layers\n"
"@args a, b\n"
"\n"
"Swaps the shapes of both layers.\n"
"\n"
@ -1491,9 +1438,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"@param a The first of the layers to swap.\n"
"@param b The second of the layers to swap.\n"
) +
gsi::method ("move_layer", &db::Layout::move_layer,
gsi::method ("move_layer", &db::Layout::move_layer, gsi::arg ("src"), gsi::arg ("dest"),
"@brief Moves a layer\n"
"@args src, dest\n"
"\n"
"This method was introduced in version 0.19.\n"
"\n"
@ -1503,9 +1449,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"@param src The layer index of the source layer.\n"
"@param dest The layer index of the destination layer.\n"
) +
gsi::method ("copy_layer", &db::Layout::copy_layer,
gsi::method ("copy_layer", &db::Layout::copy_layer, gsi::arg ("src"), gsi::arg ("dest"),
"@brief Copies a layer\n"
"@args src, dest\n"
"\n"
"This method was introduced in version 0.19.\n"
"\n"
@ -1515,9 +1460,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"@param src The layer index of the source layer.\n"
"@param dest The layer index of the destination layer.\n"
) +
gsi::method ("clear_layer", &db::Layout::clear_layer,
gsi::method ("clear_layer", &db::Layout::clear_layer, gsi::arg ("layer_index"),
"@brief Clears a layer\n"
"@args layer_index\n"
"\n"
"Clears the layer: removes all shapes.\n"
"\n"
@ -1525,9 +1469,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"@param layer_index The index of the layer to delete.\n"
) +
gsi::method ("delete_layer", &db::Layout::delete_layer,
gsi::method ("delete_layer", &db::Layout::delete_layer, gsi::arg ("layer_index"),
"@brief Deletes a layer\n"
"@args layer_index\n"
"\n"
"This method frees the memory allocated for the shapes of this layer and remembers the\n"
"layer's index for reuse when the next layer is allocated.\n"
@ -1572,15 +1515,13 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.26.1.\n"
) +
gsi::method ("transform", (void (db::Layout::*) (const db::Trans &t)) &db::Layout::transform,
gsi::method ("transform", (void (db::Layout::*) (const db::Trans &t)) &db::Layout::transform, gsi::arg ("trans"),
"@brief Transforms the layout with the given transformation\n"
"@args trans\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("transform", (void (db::Layout::*) (const db::ICplxTrans &t)) &db::Layout::transform,
gsi::method ("transform", (void (db::Layout::*) (const db::ICplxTrans &t)) &db::Layout::transform, gsi::arg ("trans"),
"@brief Transforms the layout with the given complex integer transformation\n"
"@args trans\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
@ -1598,36 +1539,31 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("is_valid_cell_index?", &db::Layout::is_valid_cell_index,
gsi::method ("is_valid_cell_index?", &db::Layout::is_valid_cell_index, gsi::arg ("cell_index"),
"@brief Returns true, if a cell index is a valid index\n"
"@args cell_index\n"
"\n"
"@return true, if this is the case\n"
"This method has been added in version 0.20.\n"
) +
gsi::method ("is_valid_layer?", &db::Layout::is_valid_layer,
gsi::method ("is_valid_layer?", &db::Layout::is_valid_layer, gsi::arg ("layer_index"),
"@brief Returns true, if a layer index is a valid normal layout layer index\n"
"@args layer_index\n"
"\n"
"@return true, if this is the case\n"
) +
gsi::method ("is_free_layer?", &db::Layout::is_free_layer,
gsi::method ("is_free_layer?", &db::Layout::is_free_layer, gsi::arg ("layer_index"),
"@brief Returns true, if a layer index is a free (unused) layer index\n"
"@args layer_index\n"
"\n"
"@return true, if this is the case\n"
"\n"
"This method has been introduced in version 0.26."
) +
gsi::method ("is_special_layer?", &db::Layout::is_special_layer,
gsi::method ("is_special_layer?", &db::Layout::is_special_layer, gsi::arg ("layer_index"),
"@brief Returns true, if a layer index is a special layer index\n"
"@args layer_index\n"
"\n"
"@return true, if this is the case\n"
) +
gsi::method_ext ("begin_shapes", &begin_shapes2,
gsi::method_ext ("begin_shapes", &begin_shapes2, gsi::arg ("cell"), gsi::arg ("layer"),
"@brief Delivers a recursive shape iterator for the shapes below the given cell on the given layer\n"
"@args cell,layer\n"
"@param cell The cell object of the initial (top) cell\n"
"@param layer The layer from which to get the shapes\n"
"@return A suitable iterator\n"
@ -1637,9 +1573,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.24.\n"
) +
gsi::method_ext ("begin_shapes", &begin_shapes,
gsi::method_ext ("begin_shapes", &begin_shapes, gsi::arg ("cell_index"), gsi::arg ("layer"),
"@brief Delivers a recursive shape iterator for the shapes below the given cell on the given layer\n"
"@args cell_index,layer\n"
"@param cell_index The index of the initial (top) cell\n"
"@param layer The layer from which to get the shapes\n"
"@return A suitable iterator\n"
@ -1648,9 +1583,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.18.\n"
) +
gsi::method_ext ("begin_shapes_touching", &begin_shapes_touching,
gsi::method_ext ("begin_shapes_touching", &begin_shapes_touching, gsi::arg ("cell_index"), gsi::arg ("layer"), gsi::arg ("region"),
"@brief Delivers a recursive shape iterator for the shapes below the given cell on the given layer using a region search\n"
"@args cell_index,layer,region\n"
"@param cell_index The index of the starting cell\n"
"@param layer The layer from which to get the shapes\n"
"@param region The search region\n"
@ -1661,9 +1595,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.18.\n"
) +
gsi::method_ext ("begin_shapes_touching", &begin_shapes_touching2,
gsi::method_ext ("begin_shapes_touching", &begin_shapes_touching2, gsi::arg ("cell"), gsi::arg ("layer"), gsi::arg ("region"),
"@brief Delivers a recursive shape iterator for the shapes below the given cell on the given layer using a region search\n"
"@args cell,layer,region\n"
"@param cell The cell object for the starting cell\n"
"@param layer The layer from which to get the shapes\n"
"@param region The search region\n"
@ -1675,9 +1608,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.24.\n"
) +
gsi::method_ext ("begin_shapes_overlapping", &begin_shapes_overlapping,
gsi::method_ext ("begin_shapes_overlapping", &begin_shapes_overlapping, gsi::arg ("cell_index"), gsi::arg ("layer"), gsi::arg ("region"),
"@brief Delivers a recursive shape iterator for the shapes below the given cell on the given layer using a region search\n"
"@args cell_index,layer,region\n"
"@param cell_index The index of the starting cell\n"
"@param layer The layer from which to get the shapes\n"
"@param region The search region\n"
@ -1688,9 +1620,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.18.\n"
) +
gsi::method_ext ("begin_shapes_overlapping", &begin_shapes_overlapping2,
gsi::method_ext ("begin_shapes_overlapping", &begin_shapes_overlapping2, gsi::arg ("cell_index"), gsi::arg ("layer"), gsi::arg ("region"),
"@brief Delivers a recursive shape iterator for the shapes below the given cell on the given layer using a region search\n"
"@args cell_index,layer,region\n"
"@param cell The cell object for the starting cell\n"
"@param layer The layer from which to get the shapes\n"
"@param region The search region\n"
@ -1752,9 +1683,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This variant has been added in version 0.25.\n"
) +
gsi::method_ext ("#write", &write_options2,
gsi::method_ext ("#write", &write_options2, gsi::arg ("filename"), gsi::arg ("gzip"), gsi::arg ("options"),
"@brief Writes the layout to a stream file\n"
"@args filename, gzip, options\n"
"@param filename The file to which to write the layout\n"
"@param gzip Ignored\n"
"@param options The option set to use for writing. See \\SaveLayoutOptions for details\n"
@ -1763,9 +1693,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"variant with two parameters automatically determines the compression mode from the file name. "
"The gzip parameter is ignored staring with version 0.23.\n"
) +
gsi::method_ext ("write", &write_options1,
gsi::method_ext ("write", &write_options1, gsi::arg ("filename"), gsi::arg ("options"),
"@brief Writes the layout to a stream file\n"
"@args filename, options\n"
"@param filename The file to which to write the layout\n"
"@param options The option set to use for writing. See \\SaveLayoutOptions for details\n"
"\n"
@ -1774,14 +1703,12 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This variant has been introduced in version 0.23.\n"
) +
gsi::method_ext ("write", &write_simple,
gsi::method_ext ("write", &write_simple, gsi::arg ("filename"),
"@brief Writes the layout to a stream file\n"
"@args filename\n"
"@param filename The file to which to write the layout\n"
) +
gsi::method_ext ("clip", &clip,
gsi::method_ext ("clip", &clip, gsi::arg ("cell"), gsi::arg ("box"),
"@brief Clips the given cell by the given rectangle and produce a new cell with the clip\n"
"@args cell, box\n"
"@param cell The cell index of the cell to clip\n"
"@param box The clip box in database units\n"
"@return The index of the new cell\n"
@ -1793,9 +1720,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.21.\n"
) +
gsi::method_ext ("clip_into", &clip_into,
gsi::method_ext ("clip_into", &clip_into, gsi::arg ("cell"), gsi::arg ("target"), gsi::arg ("box"),
"@brief Clips the given cell by the given rectangle and produce a new cell with the clip\n"
"@args cell, target, box\n"
"@param cell The cell index of the cell to clip\n"
"@param box The clip box in database units\n"
"@param target The target layout\n"
@ -1813,9 +1739,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.21.\n"
) +
gsi::method_ext ("multi_clip", &multi_clip,
gsi::method_ext ("multi_clip", &multi_clip, gsi::arg ("cell"), gsi::arg ("boxes"),
"@brief Clips the given cell by the given rectangles and produce new cells with the clips, one for each rectangle.\n"
"@args cell, boxes\n"
"@param cell The cell index of the cell to clip\n"
"@param boxes The clip boxes in database units\n"
"@return The indexes of the new cells\n"
@ -1828,9 +1753,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.21.\n"
) +
gsi::method_ext ("multi_clip_into", &multi_clip_into,
gsi::method_ext ("multi_clip_into", &multi_clip_into, gsi::arg ("cell"), gsi::arg ("target"), gsi::arg ("boxes"),
"@brief Clips the given cell by the given rectangles and produce new cells with the clips, one for each rectangle.\n"
"@args cell, target, boxes\n"
"@param cell The cell index of the cell to clip\n"
"@param boxes The clip boxes in database units\n"
"@param target The target layout\n"
@ -1849,9 +1773,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.21.\n"
) +
gsi::method ("convert_cell_to_static", &db::Layout::convert_cell_to_static,
gsi::method ("convert_cell_to_static", &db::Layout::convert_cell_to_static, gsi::arg ("cell_index"),
"@brief Converts a PCell or library cell to a usual (static) cell\n"
"@args cell_index\n"
"@return The index of the new cell\n"
"This method will create a new cell which contains the static representation of the "
"PCell or library proxy given by \"cell_index\". If that cell is not a PCell or library "
@ -1859,9 +1782,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method ("add_lib_cell", &db::Layout::get_lib_proxy,
gsi::method ("add_lib_cell", &db::Layout::get_lib_proxy, gsi::arg ("library"), gsi::arg ("lib_cell_index"),
"@brief Imports a cell from the library\n"
"@args library, lib_cell_index\n"
"@param library The reference to the library from which to import the cell\n"
"@param lib_cell_index The index of the imported cell in the library\n"
"@return The cell index of the new proxy cell in this layout\n"
@ -1872,9 +1794,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method ("add_pcell_variant", &db::Layout::get_pcell_variant_dict,
gsi::method ("add_pcell_variant", &db::Layout::get_pcell_variant_dict, gsi::arg ("pcell_id"), gsi::arg ("parameters"),
"@brief Creates a PCell variant for the given PCell ID with the parameters given as a name/value dictionary\n"
"@args pcell_id, parameters\n"
"@return The cell index of the pcell variant proxy cell\n"
"This method will create a PCell variant proxy for a local PCell definition.\n"
"It will create the PCell variant for the given parameters. Note that this method \n"
@ -1892,9 +1813,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method ("add_pcell_variant", &db::Layout::get_pcell_variant,
gsi::method ("add_pcell_variant", &db::Layout::get_pcell_variant, gsi::arg ("pcell_id"), gsi::arg ("parameters"),
"@brief Creates a PCell variant for the given PCell ID with the given parameters\n"
"@args pcell_id, parameters\n"
"@return The cell index of the pcell variant proxy cell\n"
"This method will create a PCell variant proxy for a local PCell definition.\n"
"It will create the PCell variant for the given parameters. Note that this method \n"
@ -1909,9 +1829,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method_ext ("add_pcell_variant", &add_lib_pcell_variant_dict,
gsi::method_ext ("add_pcell_variant", &add_lib_pcell_variant_dict, gsi::arg ("library"), gsi::arg ("pcell_id"), gsi::arg ("parameters"),
"@brief Creates a PCell variant for a PCell located in an external library with the parameters given as a name/value dictionary\n"
"@args library, pcell_id, parameters\n"
"@return The cell index of the new proxy cell in this layout\n"
"This method will import a PCell from a library and create a variant for the \n"
"given parameter set.\n"
@ -1929,9 +1848,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method_ext ("add_pcell_variant", &add_lib_pcell_variant,
gsi::method_ext ("add_pcell_variant", &add_lib_pcell_variant, gsi::arg ("library"), gsi::arg ("pcell_id"), gsi::arg ("parameters"),
"@brief Creates a PCell variant for a PCell located in an external library\n"
"@args library, pcell_id, parameters\n"
"@return The cell index of the new proxy cell in this layout\n"
"This method will import a PCell from a library and create a variant for the \n"
"given parameter set.\n"
@ -1958,16 +1876,14 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.24.\n"
) +
gsi::method_ext ("pcell_id", &pcell_id,
gsi::method_ext ("pcell_id", &pcell_id, gsi::arg ("name"),
"@brief Gets the ID of the PCell with the given name\n"
"@args name\n"
"This method is equivalent to 'pcell_declaration(name).id'.\n"
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method_ext ("pcell_declaration", &pcell_declaration,
gsi::method_ext ("pcell_declaration", &pcell_declaration, gsi::arg ("name"),
"@brief Gets a reference to the PCell declaration for the PCell with the given name\n"
"@args name\n"
"Returns a reference to the local PCell declaration with the given name. If the name\n"
"is not a valid PCell name, this method returns nil.\n"
"\n"
@ -1977,9 +1893,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method ("pcell_declaration", &db::Layout::pcell_declaration,
gsi::method ("pcell_declaration", &db::Layout::pcell_declaration, gsi::arg ("pcell_id"),
"@brief Gets a reference to the PCell declaration for the PCell with the given PCell ID.\n"
"@args pcell_id\n"
"Returns a reference to the local PCell declaration with the given PCell id. If the parameter\n"
"is not a valid PCell ID, this method returns nil. The PCell ID is the number returned \n"
"by \\register_pcell for example.\n"
@ -1990,9 +1905,8 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method ("register_pcell", &db::Layout::register_pcell,
gsi::method ("register_pcell", &db::Layout::register_pcell, gsi::arg ("name"), gsi::arg ("declaration"),
"@brief Registers a PCell declaration under the given name\n"
"@args name, declaration\n"
"Registers a local PCell in the current layout. If a declaration with that name\n"
"already exists, it is replaced with the new declaration.\n"
"\n"
@ -2059,9 +1973,8 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"\"same as original\" and all layers are selected as well as all cells.\n"
"The default format is GDS2."
) +
gsi::method_ext ("set_format_from_filename", &set_format_from_filename,
gsi::method_ext ("set_format_from_filename", &set_format_from_filename, gsi::arg ("filename"),
"@brief Select a format from the given file name\n"
"@args filename\n"
"\n"
"This method will set the format according to the file's extension.\n"
"\n"
@ -2070,9 +1983,8 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"only consumer for the return value, Layout#write, now ignores that "
"parameter and automatically determines the compression mode from the file name.\n"
) +
gsi::method ("format=", &db::SaveLayoutOptions::set_format,
gsi::method ("format=", &db::SaveLayoutOptions::set_format, gsi::arg ("format"),
"@brief Select a format\n"
"@args format\n"
"The format string can be either \"GDS2\", \"OASIS\", \"CIF\" or \"DXF\". Other formats may be available if\n"
"a suitable plugin is installed."
) +
@ -2081,10 +1993,9 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"\n"
"See \\format= for a description of that method.\n"
) +
gsi::method ("add_layer", &db::SaveLayoutOptions::add_layer,
gsi::method ("add_layer", &db::SaveLayoutOptions::add_layer, gsi::arg ("layer_index"), gsi::arg ("properties"),
"@brief Add a layer to be saved \n"
"\n"
"@args layer_index, properties\n"
"\n"
"Adds the layer with the given index to the layer list that will be written.\n"
"If all layers have been selected previously, all layers will \n"
@ -2107,20 +2018,18 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"This method will clear all layers selected with \\add_layer so far and clear the 'select all layers' flag.\n"
"Using this method is the only way to save a layout without any layers."
) +
gsi::method ("select_cell", &db::SaveLayoutOptions::select_cell,
gsi::method ("select_cell", &db::SaveLayoutOptions::select_cell, gsi::arg ("cell_index"),
"@brief Selects a cell to be saved (plus hierarchy below)\n"
"\n"
"@args cell_index\n"
"\n"
"This method is basically a convenience method that combines \\clear_cells and \\add_cell.\n"
"This method clears the 'select all cells' flag.\n"
"\n"
"This method has been added in version 0.22.\n"
) +
gsi::method ("select_this_cell", &db::SaveLayoutOptions::select_this_cell,
gsi::method ("select_this_cell", &db::SaveLayoutOptions::select_this_cell, gsi::arg ("cell_index"),
"@brief Selects a cell to be saved\n"
"\n"
"@args cell_index\n"
"\n"
"This method is basically a convenience method that combines \\clear_cells and \\add_this_cell.\n"
"This method clears the 'select all cells' flag.\n"
@ -2135,10 +2044,9 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"\n"
"This method has been added in version 0.22.\n"
) +
gsi::method ("add_this_cell", &db::SaveLayoutOptions::add_this_cell,
gsi::method ("add_this_cell", &db::SaveLayoutOptions::add_this_cell, gsi::arg ("cell_index"),
"@brief Adds a cell to be saved\n"
"\n"
"@args cell_index\n"
"\n"
"The index of the cell must be a valid index in the context of the layout that will be saved.\n"
"This method clears the 'select all cells' flag.\n"
@ -2146,10 +2054,9 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method ("add_cell", &db::SaveLayoutOptions::add_cell,
gsi::method ("add_cell", &db::SaveLayoutOptions::add_cell, gsi::arg ("cell_index"),
"@brief Add a cell (plus hierarchy) to be saved\n"
"\n"
"@args cell_index\n"
"\n"
"The index of the cell must be a valid index in the context of the layout that will be saved.\n"
"This method clears the 'select all cells' flag.\n"
@ -2163,9 +2070,8 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"This method will clear all cells specified with \\add_cells so far and set the 'select all cells' flag.\n"
"This is the default.\n"
) +
gsi::method ("write_context_info=", &db::SaveLayoutOptions::set_write_context_info,
gsi::method ("write_context_info=", &db::SaveLayoutOptions::set_write_context_info, gsi::arg ("flag"),
"@brief Enables or disables context information\n"
"@args flag\n"
"\n"
"If this flag is set to false, no context information for PCell or library cell instances is written. "
"Those cells will be converted to plain cells and KLayout will not be able to restore the identity of "
@ -2184,9 +2090,8 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"\n"
"This method was introduced in version 0.23.\n"
) +
gsi::method ("keep_instances=", &db::SaveLayoutOptions::set_keep_instances,
gsi::method ("keep_instances=", &db::SaveLayoutOptions::set_keep_instances, gsi::arg ("flag"),
"@brief Enables or disables instances for dropped cells\n"
"@args flag\n"
"\n"
"If this flag is set to true, instances for cells will be written, even if the cell is dropped. "
"That may happen, if cells are selected with \\select_this_cell or \\add_this_cell or \\no_empty_cells is used. "
@ -2205,9 +2110,8 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"\n"
"This method was introduced in version 0.23.\n"
) +
gsi::method ("dbu=", &db::SaveLayoutOptions::set_dbu,
gsi::method ("dbu=", &db::SaveLayoutOptions::set_dbu, gsi::arg ("dbu"),
"@brief Set the database unit to be used in the stream file\n"
"@args dbu\n"
"\n"
"By default, the database unit of the layout is used. This method allows one to explicitly use a different\n"
"database unit. A scale factor is introduced automatically which scales all layout objects accordingly so their physical dimensions remain the same. "
@ -2219,9 +2123,8 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
"\n"
"See \\dbu= for a description of that attribute.\n"
) +
gsi::method ("no_empty_cells=", &db::SaveLayoutOptions::set_dont_write_empty_cells,
gsi::method ("no_empty_cells=", &db::SaveLayoutOptions::set_dont_write_empty_cells, gsi::arg ("flag"),
"@brief Don't write empty cells if this flag is set\n"
"@args flag\n"
"\n"
"By default, all cells are written (no_empty_cells is false).\n"
"This applies to empty cells which do not contain shapes for the specified layers "
@ -2230,9 +2133,8 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
gsi::method ("no_empty_cells?", &db::SaveLayoutOptions::dont_write_empty_cells,
"@brief Returns a flag indicating whether empty cells are not written.\n"
) +
gsi::method ("scale_factor=", &db::SaveLayoutOptions::set_scale_factor,
gsi::method ("scale_factor=", &db::SaveLayoutOptions::set_scale_factor, gsi::arg ("scale_factor"),
"@brief Set the scaling factor for the saving \n"
"@args scale_factor\n"
"\n"
"Using a scaling factor will scale all objects accordingly. "
"This scale factor adds to a potential scaling implied by using an explicit database unit.\n"
@ -2262,4 +2164,3 @@ Class<db::SaveLayoutOptions> decl_SaveLayoutOptions ("db", "SaveLayoutOptions",
);
}

67
src/db/db/gsiDeclDbLibrary.cc
View File

@ -72,18 +72,16 @@ Class<db::Library> decl_Library ("db", "Library",
gsi::constructor ("new", &new_lib,
"@brief Creates a new, empty library"
) +
gsi::method ("library_by_name", &library_by_name,
gsi::method ("library_by_name", &library_by_name, gsi::arg ("name"),
"@brief Gets a library by name\n"
"@args name\n"
"Returns the library object for the given name. If the name is not a valid\n"
"library name, nil is returned.\n"
) +
gsi::method ("library_names", &library_names,
"@brief Returns a list of the names of all libraries registered in the system.\n"
) +
gsi::method_ext ("register", &register_lib,
gsi::method_ext ("register", &register_lib, gsi::arg ("name"),
"@brief Registers the library with the given name\n"
"@args name\n"
"\n"
"This method can be called in the constructor to register the library after \n"
"the layout object has been filled with content. If a library with that name\n"
@ -110,9 +108,8 @@ Class<db::Library> decl_Library ("db", "Library",
gsi::method ("description", &db::Library::get_description,
"@brief Returns the libraries' description text\n"
) +
gsi::method ("description=", &db::Library::set_description,
gsi::method ("description=", &db::Library::set_description, gsi::arg ("description"),
"@brief Sets the libraries' description text\n"
"@args description\n"
) +
gsi::method ("technology", &db::Library::get_technology,
"@brief Returns name of the technology the library is associated with\n"
@ -121,9 +118,8 @@ Class<db::Library> decl_Library ("db", "Library",
"\n"
"This attribute has been introduced in version 0.25."
) +
gsi::method ("technology=", &db::Library::set_technology,
gsi::method ("technology=", &db::Library::set_technology, gsi::arg ("technology"),
"@brief sets the name of the technology the library is associated with\n"
"@args technology\n"
"\n"
"See \\technology for details. "
"This attribute has been introduced in version 0.25."
@ -335,9 +331,8 @@ Class<PCellDeclarationImpl> decl_PCellDeclaration (decl_PCellDeclaration_Native,
gsi::method ("parameters_from_shape", &PCellDeclarationImpl::parameters_from_shape_fb, "@hide") +
gsi::method ("transformation_from_shape", &PCellDeclarationImpl::transformation_from_shape_fb, "@hide") +
gsi::method ("display_text", &PCellDeclarationImpl::get_display_name_fb, "@hide") +
gsi::callback ("get_layers", &PCellDeclarationImpl::get_layer_declarations_impl, &PCellDeclarationImpl::cb_get_layer_declarations,
gsi::callback ("get_layers", &PCellDeclarationImpl::get_layer_declarations_impl, &PCellDeclarationImpl::cb_get_layer_declarations, gsi::arg ("parameters"),
"@brief Returns a list of layer declarations\n"
"@args parameters\n"
"Reimplement this method to return a list of layers this PCell wants to create.\n"
"The layer declarations are returned as a list of LayerInfo objects which are\n"
"used as match expressions to look up the layer in the actual layout.\n"
@ -352,9 +347,8 @@ Class<PCellDeclarationImpl> decl_PCellDeclaration (decl_PCellDeclaration_Native,
"and defines the parameter name, type, description text and possible choices for\n"
"the parameter value.\n"
) +
gsi::callback ("coerce_parameters", &PCellDeclarationImpl::coerce_parameters_impl, &PCellDeclarationImpl::cb_coerce_parameters,
gsi::callback ("coerce_parameters", &PCellDeclarationImpl::coerce_parameters_impl, &PCellDeclarationImpl::cb_coerce_parameters, gsi::arg ("layout"), gsi::arg ("input"),
"@brief Modifies the parameters to match the requirements\n"
"@args layout, input\n"
"@param layout The layout object in which the PCell will be produced\n"
"@param input The parameters before the modification\n"
"@return The modified parameters or an empty array, indicating that no modification was done\n"
@ -367,9 +361,8 @@ Class<PCellDeclarationImpl> decl_PCellDeclaration (decl_PCellDeclaration_Native,
"\n"
"It can raise an exception to indicate that something is not correct.\n"
) +
gsi::callback ("produce", &PCellDeclarationImpl::produce, &PCellDeclarationImpl::cb_produce,
gsi::callback ("produce", &PCellDeclarationImpl::produce, &PCellDeclarationImpl::cb_produce, gsi::arg ("layout"), gsi::arg ("layer_ids"), gsi::arg ("parameters"), gsi::arg ("cell"),
"@brief The production callback\n"
"@args layout, layer_ids, parameters, cell\n"
"@param layout The layout object where the cell resides\n"
"@param layer_ids A list of layer ID's which correspond to the layers declared with get_layers\n"
"@param parameters A list of parameter values which correspond to the parameters declared with get_parameters\n"
@ -378,9 +371,8 @@ Class<PCellDeclarationImpl> decl_PCellDeclaration (decl_PCellDeclaration_Native,
"The code is supposed to create the layout in the target cell using the provided \n"
"parameters and the layers passed in the layer_ids list.\n"
) +
gsi::callback ("can_create_from_shape", &PCellDeclarationImpl::can_create_from_shape, &PCellDeclarationImpl::cb_can_create_from_shape,
gsi::callback ("can_create_from_shape", &PCellDeclarationImpl::can_create_from_shape, &PCellDeclarationImpl::cb_can_create_from_shape, gsi::arg ("layout"), gsi::arg ("shape"), gsi::arg ("layer"),
"@brief Returns true, if the PCell can be created from the given shape\n"
"@args layout,shape,layer\n"
"@param layout The layout the shape lives in\n"
"@param shape The shape from which a PCell shall be created\n"
"@param layer The layer index (in layout) of the shape\n"
@ -389,9 +381,8 @@ Class<PCellDeclarationImpl> decl_PCellDeclaration (decl_PCellDeclaration_Native,
"\\parameters_from_shape and \\transformation_from_shape to derive the parameters and instance "
"transformation for the new PCell instance that will replace the shape.\n"
) +
gsi::callback ("parameters_from_shape", &PCellDeclarationImpl::parameters_from_shape, &PCellDeclarationImpl::cb_parameters_from_shape,
gsi::callback ("parameters_from_shape", &PCellDeclarationImpl::parameters_from_shape, &PCellDeclarationImpl::cb_parameters_from_shape, gsi::arg ("layout"), gsi::arg ("shape"), gsi::arg ("layer"),
"@brief Gets the parameters for the PCell which can replace the given shape\n"
"@args layout,shape,layer\n"
"@param layout The layout the shape lives in\n"
"@param shape The shape from which a PCell shall be created\n"
"@param layer The layer index (in layout) of the shape\n"
@ -399,9 +390,8 @@ Class<PCellDeclarationImpl> decl_PCellDeclaration (decl_PCellDeclaration_Native,
"it will use this method to derive the parameters for the PCell instance that will replace the shape. "
"See also \\transformation_from_shape and \\can_create_from_shape."
) +
gsi::callback ("transformation_from_shape", &PCellDeclarationImpl::transformation_from_shape, &PCellDeclarationImpl::cb_transformation_from_shape,
gsi::callback ("transformation_from_shape", &PCellDeclarationImpl::transformation_from_shape, &PCellDeclarationImpl::cb_transformation_from_shape, gsi::arg ("layout"), gsi::arg ("shape"), gsi::arg ("layer"),
"@brief Gets the instance transformation for the PCell which can replace the given shape\n"
"@args layout,shape,layer\n"
"@param layout The layout the shape lives in\n"
"@param shape The shape from which a PCell shall be created\n"
"@param layer The layer index (in layout) of the shape\n"
@ -409,9 +399,8 @@ Class<PCellDeclarationImpl> decl_PCellDeclaration (decl_PCellDeclaration_Native,
"it will use this method to derive the transformation for the PCell instance that will replace the shape. "
"See also \\parameters_from_shape and \\can_create_from_shape."
) +
gsi::callback ("display_text", &PCellDeclarationImpl::get_display_name, &PCellDeclarationImpl::cb_get_display_name,
gsi::callback ("display_text", &PCellDeclarationImpl::get_display_name, &PCellDeclarationImpl::cb_get_display_name, gsi::arg ("parameters"),
"@brief Returns the display text for this PCell given a certain parameter set\n"
"@args parameters\n"
"Reimplement this method to create a distinct display text for a PCell variant with \n"
"the given parameter set. If this method is not implemented, a default text is created. \n"
),
@ -539,24 +528,21 @@ db::PCellParameterDeclaration *ctor_pcell_parameter_3 (const std::string &name,
}
Class<db::PCellParameterDeclaration> decl_PCellParameterDeclaration ("db", "PCellParameterDeclaration",
gsi::constructor ("new", &ctor_pcell_parameter,
gsi::constructor ("new", &ctor_pcell_parameter, gsi::arg ("name"), gsi::arg ("type"), gsi::arg ("description"),
"@brief Create a new parameter declaration with the given name and type\n"
"@args name, type, description\n"
"@param name The parameter name\n"
"@param type One of the Type... constants describing the type of the parameter\n"
"@param description The description text\n"
) +
gsi::constructor ("new", &ctor_pcell_parameter_2,
gsi::constructor ("new", &ctor_pcell_parameter_2, gsi::arg ("name"), gsi::arg ("type"), gsi::arg ("description"), gsi::arg ("default"),
"@brief Create a new parameter declaration with the given name, type and default value\n"
"@args name, type, description, default\n"
"@param name The parameter name\n"
"@param type One of the Type... constants describing the type of the parameter\n"
"@param description The description text\n"
"@param default The default (initial) value\n"
) +
gsi::constructor ("new", &ctor_pcell_parameter_3,
gsi::constructor ("new", &ctor_pcell_parameter_3, gsi::arg ("name"), gsi::arg ("type"), gsi::arg ("description"), gsi::arg ("default"), gsi::arg ("unit"),
"@brief Create a new parameter declaration with the given name, type, default value and unit string\n"
"@args name, type, description, default\n"
"@param name The parameter name\n"
"@param type One of the Type... constants describing the type of the parameter\n"
"@param description The description text\n"
@ -566,57 +552,50 @@ Class<db::PCellParameterDeclaration> decl_PCellParameterDeclaration ("db", "PCel
gsi::method ("name", &db::PCellParameterDeclaration::get_name,
"@brief Gets the name\n"
) +
gsi::method ("name=", &db::PCellParameterDeclaration::set_name,
gsi::method ("name=", &db::PCellParameterDeclaration::set_name, gsi::arg ("value"),
"@brief Sets the name\n"
"@args value\n"
) +
gsi::method ("unit", &db::PCellParameterDeclaration::get_unit,
"@brief Gets the unit string\n"
) +
gsi::method ("unit=", &db::PCellParameterDeclaration::set_unit,
gsi::method ("unit=", &db::PCellParameterDeclaration::set_unit, gsi::arg ("unit"),
"@brief Sets the unit string\n"
"The unit string is shown right to the edit fields for numeric parameters.\n"
"@args unit\n"
) +
gsi::method_ext ("type", &get_type,
"@brief Gets the type\n"
"The type is one of the T... constants."
) +
gsi::method_ext ("type=", &set_type,
gsi::method_ext ("type=", &set_type, gsi::arg ("type"),
"@brief Sets the type\n"
"@args type\n"
) +
gsi::method ("description", &db::PCellParameterDeclaration::get_description,
"@brief Gets the description text\n"
) +
gsi::method ("description=", &db::PCellParameterDeclaration::set_description,
gsi::method ("description=", &db::PCellParameterDeclaration::set_description, gsi::arg ("description"),
"@brief Sets the description\n"
"@args description\n"
) +
gsi::method ("hidden?", &db::PCellParameterDeclaration::is_hidden,
"@brief Returns true, if the parameter is a hidden parameter that should not be shown in the user interface\n"
"By making a parameter hidden, it is possible to create internal parameters which cannot be\n"
"edited.\n"
) +
gsi::method ("hidden=", &db::PCellParameterDeclaration::set_hidden,
gsi::method ("hidden=", &db::PCellParameterDeclaration::set_hidden, gsi::arg ("flag"),
"@brief Makes the parameter hidden if this attribute is set to true\n"
"@args flag\n"
) +
gsi::method ("readonly?", &db::PCellParameterDeclaration::is_readonly,
"@brief Returns true, if the parameter is a read-only parameter\n"
"By making a parameter read-only, it is shown but cannot be\n"
"edited.\n"
) +
gsi::method ("readonly=", &db::PCellParameterDeclaration::set_readonly,
gsi::method ("readonly=", &db::PCellParameterDeclaration::set_readonly, gsi::arg ("flag"),
"@brief Makes the parameter read-only if this attribute is set to true\n"
"@args flag\n"
) +
gsi::method_ext ("clear_choices", &clear_choices,
"@brief Clears the list of choices\n"
) +
gsi::method_ext ("add_choice", &add_choice,
gsi::method_ext ("add_choice", &add_choice, gsi::arg ("description"), gsi::arg ("value"),
"@brief Add a new value to the list of choices\n"
"@args description, value\n"
"This method will add the given value with the given description to the list of\n"
"choices. If choices are defined, KLayout will show a drop-down box instead of an\n"
"entry field in the parameter user interface.\n"
@ -630,9 +609,8 @@ Class<db::PCellParameterDeclaration> decl_PCellParameterDeclaration ("db", "PCel
gsi::method ("default", &db::PCellParameterDeclaration::get_default,
"@brief Gets the default value\n"
) +
gsi::method ("default=", &db::PCellParameterDeclaration::set_default,
gsi::method ("default=", &db::PCellParameterDeclaration::set_default, gsi::arg ("value"),
"@brief Sets the default value\n"
"@args value\n"
"If a default value is defined, it will be used to initialize the parameter value\n"
"when a PCell is created.\n"
) +
@ -657,4 +635,3 @@ Class<db::PCellParameterDeclaration> decl_PCellParameterDeclaration ("db", "PCel
}

8
src/db/db/gsiDeclDbManager.cc
View File

@ -58,10 +58,9 @@ static db::Manager::transaction_id_t transaction2(db::Manager *manager, const st
}
Class<db::Manager> decl_Manager ("db", "Manager",
gsi::method_ext ("transaction", &transaction1,
gsi::method_ext ("transaction", &transaction1, gsi::arg ("description"),
"@brief Begin a transaction\n"
"\n"
"@args description\n"
"\n"
"This call will open a new transaction. A transaction consists\n"
"of a set of operations issued with the 'queue' method.\n"
@ -71,10 +70,9 @@ Class<db::Manager> decl_Manager ("db", "Manager",
"\n"
"@return The ID of the transaction (can be used to join other transactions with this one)\n"
) +
gsi::method_ext ("transaction", &transaction2,
gsi::method_ext ("transaction", &transaction2, gsi::arg ("description"), gsi::arg ("join_with"),
"@brief Begin a joined transaction\n"
"\n"
"@args description, join_with\n"
"\n"
"This call will open a new transaction and join if with the previous transaction.\n"
"The ID of the previous transaction must be equal to the ID given with 'join_with'.\n"
@ -134,4 +132,4 @@ Class<db::Manager> decl_Manager ("db", "Manager",
"This class has been introduced in version 0.19.\n"
);
}
}

82
src/db/db/gsiDeclDbMatrix.cc
View File

@ -105,25 +105,21 @@ gsi::Class<db::Matrix2d> decl_Matrix2d ("db", "Matrix2d",
gsi::constructor ("new", &new_matrix2d,
"@brief Create a new Matrix2d representing a unit transformation"
) +
gsi::constructor ("new", &new_matrix2d_m,
gsi::constructor ("new", &new_matrix2d_m, gsi::arg ("m"),
"@brief Create a new Matrix2d representing an isotropic magnification\n"
"@args m\n"
"@param m The magnification\n"
) +
gsi::constructor ("new", &new_matrix2d_m2,
gsi::constructor ("new", &new_matrix2d_m2, gsi::arg ("mx"), gsi::arg ("my"),
"@brief Create a new Matrix2d representing an anisotropic magnification\n"
"@args mx, my\n"
"@param mx The magnification in x direction\n"
"@param my The magnification in y direction\n"
) +
gsi::constructor ("new", &new_matrix2d_t,
gsi::constructor ("new", &new_matrix2d_t, gsi::arg ("t"),
"@brief Create a new Matrix2d from the given complex transformation"
"@args t\n"
"@param t The transformation from which to create the matrix (not taking into account the displacement)\n"
) +
gsi::constructor ("newc", &new_matrix2d_mrm,
gsi::constructor ("newc", &new_matrix2d_mrm, gsi::arg ("mag"), gsi::arg ("rotation"), gsi::arg ("mirror"),
"@brief Create a new Matrix2d representing an isotropic magnification, rotation and mirroring\n"
"@args mag, rotation, mirror\n"
"@param mag The magnification in x direction\n"
"@param rotation The rotation angle (in degree)\n"
"@param mirror The mirror flag (at x axis)\n"
@ -132,9 +128,8 @@ gsi::Class<db::Matrix2d> decl_Matrix2d ("db", "Matrix2d",
"This constructor is called 'newc' to distinguish it from the constructors taking matrix coefficients ('c' is for composite).\n"
"The order of execution of the operations is mirror, magnification, rotation (as for complex transformations).\n"
) +
gsi::constructor ("newc", &new_matrix2d_smrm,
gsi::constructor ("newc", &new_matrix2d_smrm, gsi::arg ("shear"), gsi::arg ("mx"), gsi::arg ("my"), gsi::arg ("rotation"), gsi::arg ("mirror"),
"@brief Create a new Matrix2d representing a shear, anisotropic magnification, rotation and mirroring\n"
"@args shear, mx, my, rotation, mirror\n"
"@param shear The shear angle\n"
"@param mx The magnification in x direction\n"
"@param my The magnification in y direction\n"
@ -144,9 +139,8 @@ gsi::Class<db::Matrix2d> decl_Matrix2d ("db", "Matrix2d",
"The order of execution of the operations is mirror, magnification, shear and rotation.\n"
"This constructor is called 'newc' to distinguish it from the constructor taking the four matrix coefficients ('c' is for composite).\n"
) +
gsi::constructor ("new", &new_matrix2d_m4,
gsi::constructor ("new", &new_matrix2d_m4, gsi::arg ("m11"), gsi::arg ("m12"), gsi::arg ("m21"), gsi::arg ("m22"),
"@brief Create a new Matrix2d from the four coefficients\n"
"@args m11, m12, m21, m22\n"
) +
gsi::method ("m11", &db::Matrix2d::m11,
"@brief Gets the m11 coefficient.\n"
@ -164,9 +158,8 @@ gsi::Class<db::Matrix2d> decl_Matrix2d ("db", "Matrix2d",
"@brief Gets the m22 coefficient.\n"
"@return The value of the m22 coefficient\n"
) +
gsi::method_ext ("m", &coeff_m,
gsi::method_ext ("m", &coeff_m, gsi::arg ("i"), gsi::arg ("j"),
"@brief Gets the m coefficient with the given index.\n"
"@args i,j\n"
"@return The coefficient [i,j]\n"
) +
gsi::method ("to_s", &db::Matrix2d::to_string,
@ -177,21 +170,18 @@ gsi::Class<db::Matrix2d> decl_Matrix2d ("db", "Matrix2d",
"@brief The inverse of this matrix.\n"
"@return The inverse of this matrix\n"
) +
gsi::method_ext ("trans", &trans_p,
gsi::method_ext ("trans", &trans_p, gsi::arg ("p"),
"@brief Transforms a point with this matrix.\n"
"@args p\n"
"@param p The point to transform.\n"
"@return The product if self and the point p\n"
) +
gsi::method_ext ("*", &prod_m,
gsi::method_ext ("*", &prod_m, gsi::arg ("m"),
"@brief Product of two matrices.\n"
"@args m\n"
"@param m The other matrix.\n"
"@return The matrix product self*m\n"
) +
gsi::method_ext ("+", &sum_m,
gsi::method_ext ("+", &sum_m, gsi::arg ("m"),
"@brief Sum of two matrices.\n"
"@args m\n"
"@param m The other matrix.\n"
"@return The (element-wise) sum of self+m\n"
) +
@ -373,19 +363,16 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
gsi::constructor ("new", &new_matrix3d,
"@brief Create a new Matrix3d representing a unit transformation"
) +
gsi::constructor ("new", &new_matrix3d_m,
gsi::constructor ("new", &new_matrix3d_m, gsi::arg ("m"),
"@brief Create a new Matrix3d representing a magnification\n"
"@args m\n"
"@param m The magnification\n"
) +
gsi::constructor ("new", &new_matrix3d_t,
gsi::constructor ("new", &new_matrix3d_t, gsi::arg ("t"),
"@brief Create a new Matrix3d from the given complex transformation"
"@args t\n"
"@param t The transformation from which to create the matrix\n"
) +
gsi::constructor ("newc", &new_matrix3d_mrm,
gsi::constructor ("newc", &new_matrix3d_mrm, gsi::arg ("mag"), gsi::arg ("rotation"), gsi::arg ("mirrx"),
"@brief Create a new Matrix3d representing a isotropic magnification, rotation and mirroring\n"
"@args mag, rotation, mirrx\n"
"@param mag The magnification\n"
"@param rotation The rotation angle (in degree)\n"
"@param mirrx The mirror flag (at x axis)\n"
@ -393,9 +380,8 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
"The order of execution of the operations is mirror, magnification and rotation.\n"
"This constructor is called 'newc' to distinguish it from the constructors taking coefficients ('c' is for composite).\n"
) +
gsi::constructor ("newc", &new_matrix3d_smrm,
gsi::constructor ("newc", &new_matrix3d_smrm, gsi::arg ("shear"), gsi::arg ("mx"), gsi::arg ("my"), gsi::arg ("rotation"), gsi::arg ("mirrx"),
"@brief Create a new Matrix3d representing a shear, anisotropic magnification, rotation and mirroring\n"
"@args shear, mx, my, rotation, mirrx\n"
"@param shear The shear angle\n"
"@param mx The magnification in x direction\n"
"@param mx The magnification in y direction\n"
@ -405,9 +391,8 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
"The order of execution of the operations is mirror, magnification, rotation and shear.\n"
"This constructor is called 'newc' to distinguish it from the constructor taking the four matrix coefficients ('c' is for composite).\n"
) +
gsi::constructor ("newc", &new_matrix3d_dsmrm,
gsi::constructor ("newc", &new_matrix3d_dsmrm, gsi::arg ("u"), gsi::arg ("shear"), gsi::arg ("mx"), gsi::arg ("my"), gsi::arg ("rotation"), gsi::arg ("mirrx"),
"@brief Create a new Matrix3d representing a displacement, shear, anisotropic magnification, rotation and mirroring\n"
"@args u, shear, mx, my, rotation, mirrx\n"
"@param u The displacement\n"
"@param shear The shear angle\n"
"@param mx The magnification in x direction\n"
@ -420,9 +405,8 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
"\n"
"Starting with version 0.25 the displacement is of vector type."
) +
gsi::constructor ("newc", &new_matrix3d_pdsmrm,
gsi::constructor ("newc", &new_matrix3d_pdsmrm, gsi::arg ("tx"), gsi::arg ("ty"), gsi::arg ("z"), gsi::arg ("u"), gsi::arg ("shear"), gsi::arg ("mx"), gsi::arg ("my"), gsi::arg ("rotation"), gsi::arg ("mirrx"),
"@brief Create a new Matrix3d representing a perspective distortion, displacement, shear, anisotropic magnification, rotation and mirroring\n"
"@args tx, ty, z, u, shear, mx, my, rotation, mirrx\n"
"@param tx The perspective tilt angle x (around the y axis)\n"
"@param ty The perspective tilt angle y (around the x axis)\n"
"@param z The observer distance at which the tilt angles are given\n"
@ -442,21 +426,17 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
"\n"
"Starting with version 0.25 the displacement is of vector type."
) +
gsi::constructor ("new", &new_matrix3d_m4,
gsi::constructor ("new", &new_matrix3d_m4, gsi::arg ("m11"), gsi::arg ("m12"), gsi::arg ("m21"), gsi::arg ("m22"),
"@brief Create a new Matrix3d from the four coefficients of a Matrix2d\n"
"@args m11, m12, m21, m22\n"
) +
gsi::constructor ("new", &new_matrix3d_m6,
gsi::constructor ("new", &new_matrix3d_m6, gsi::arg ("m11"), gsi::arg ("m12"), gsi::arg ("m21"), gsi::arg ("m22"), gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Create a new Matrix3d from the four coefficients of a Matrix2d plus a displacement\n"
"@args m11, m12, m21, m22, dx, dy\n"
) +
gsi::constructor ("new", &new_matrix3d_m9,
gsi::constructor ("new", &new_matrix3d_m9, gsi::arg ("m11"), gsi::arg ("m12"), gsi::arg ("m13"), gsi::arg ("m21"), gsi::arg ("m22"), gsi::arg ("m23"), gsi::arg ("m31"), gsi::arg ("m32"), gsi::arg ("m33"),
"@brief Create a new Matrix3d from the nine matrix coefficients\n"
"@args m11, m12, m13, m21, m22, m23, m31, m32, m33\n"
) +
gsi::method_ext ("m", &coeff_m3,
gsi::method_ext ("m", &coeff_m3, gsi::arg ("i"), gsi::arg ("j"),
"@brief Gets the m coefficient with the given index.\n"
"@args i,j\n"
"@return The coefficient [i,j]\n"
) +
gsi::method ("to_s", &db::Matrix3d::to_string,
@ -467,27 +447,23 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
"@brief The inverse of this matrix.\n"
"@return The inverse of this matrix\n"
) +
gsi::method_ext ("trans", &trans_p3,
gsi::method_ext ("trans", &trans_p3, gsi::arg ("p"),
"@brief Transforms a point with this matrix.\n"
"@args p\n"
"@param p The point to transform.\n"
"@return The product if self and the point p\n"
) +
gsi::method_ext ("*", &prod_m3,
gsi::method_ext ("*", &prod_m3, gsi::arg ("m"),
"@brief Product of two matrices.\n"
"@args m\n"
"@param m The other matrix.\n"
"@return The matrix product self*m\n"
) +
gsi::method_ext ("*", &trans_p3,
gsi::method_ext ("*", &trans_p3, gsi::arg ("p"),
"@brief Transform a point.\n"
"@args p\n"
"@param p The point to transform.\n"
"@return The transformed point\n"
) +
gsi::method_ext ("+", &sum_m3,
gsi::method_ext ("+", &sum_m3, gsi::arg ("m"),
"@brief Sum of two matrices.\n"
"@args m\n"
"@param m The other matrix.\n"
"@return The (element-wise) sum of self+m\n"
) +
@ -522,18 +498,16 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
"Starting with version 0.25 this method returns a vector type instead of a point.\n"
"@return The displacement vector.\n"
) +
gsi::method ("tx", &db::Matrix3d::perspective_tilt_x,
gsi::method ("tx", &db::Matrix3d::perspective_tilt_x, gsi::arg ("z"),
"@brief Returns the perspective tilt angle tx.\n"
"@args z\n"
"@param z The observer distance at which the tilt angle is computed.\n"
"@return The tilt angle tx.\n"
"The tx and ty parameters represent the perspective distortion. They denote a tilt of the xy plane around the y axis (tx) or the x axis (ty) in degree. "
"The same effect is achieved for different tilt angles at different observer distances. Hence, the observer distance must be specified at which the tilt angle is computed. "
"If the magnitude of the tilt angle is not important, z can be set to 1.\n"
) +
gsi::method ("ty", &db::Matrix3d::perspective_tilt_y,
gsi::method ("ty", &db::Matrix3d::perspective_tilt_y, gsi::arg ("z"),
"@brief Returns the perspective tilt angle ty.\n"
"@args z\n"
"@param z The observer distance at which the tilt angle is computed.\n"
"@return The tilt angle ty.\n"
"The tx and ty parameters represent the perspective distortion. They denote a tilt of the xy plane around the y axis (tx) or the x axis (ty) in degree. "
@ -545,7 +519,7 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
"@return True if this matrix has a mirror component.\n"
"See the description of this class for details about the basic transformations."
) +
gsi::method_ext ("adjust", &adjust,
gsi::method_ext ("adjust", &adjust, gsi::arg ("landmarks_before"), gsi::arg ("landmarks_after"), gsi::arg ("flags"), gsi::arg ("fixed_point"),
"@brief Adjust a 3d matrix to match the given set of landmarks\n"
"\n"
"This function tries to adjust the matrix\n"
@ -553,7 +527,6 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
"or that the \"after\" landmarks will match as close as possible to the \"before\" landmarks \n"
"(if the problem is overdetermined).\n"
"\n"
"@args landmarks_before, landmarks_after, flags, fixed_point\n"
"@param landmarks_before The points before the transformation.\n"
"@param landmarks_after The points after the transformation.\n"
"@param mode Selects the adjustment mode. Must be one of the Adjust... constants.\n"
@ -594,4 +567,3 @@ gsi::Class<db::Matrix3d> decl_Matrix3d ("db", "Matrix3d",
);
}

64
src/db/db/gsiDeclDbPath.cc
View File

@ -119,28 +119,25 @@ struct path_defs
constructor ("new", &new_v,
"@brief Default constructor: creates an empty (invalid) path with width 0"
) +
constructor ("new|#new_pw", &new_pw,
constructor ("new|#new_pw", &new_pw, gsi::arg ("pts"), gsi::arg ("width"),
"@brief Constructor given the points of the path's spine and the width\n"
"\n"
"@args pts, width\n"
"\n"
"@param pts The points forming the spine of the path\n"
"@param width The width of the path\n"
) +
constructor ("new|#new_pwx", &new_pwx,
constructor ("new|#new_pwx", &new_pwx, gsi::arg ("pts"), gsi::arg ("width"), gsi::arg ("bgn_ext"), gsi::arg ("end_ext"),
"@brief Constructor given the points of the path's spine, the width and the extensions\n"
"\n"
"@args pts, width, bgn_ext, end_ext\n"
"\n"
"@param pts The points forming the spine of the path\n"
"@param width The width of the path\n"
"@param bgn_ext The begin extension of the path\n"
"@param end_ext The end extension of the path\n"
) +
constructor ("new|#new_pwxr", &new_pwxr,
constructor ("new|#new_pwxr", &new_pwxr, gsi::arg ("pts"), gsi::arg ("width"), gsi::arg ("bgn_ext"), gsi::arg ("end_ext"), gsi::arg ("round"),
"@brief Constructor given the points of the path's spine, the width, the extensions and the round end flag\n"
"\n"
"@args pts, width, bgn_ext, end_ext, round\n"
"\n"
"@param pts The points forming the spine of the path\n"
"@param width The width of the path\n"
@ -148,20 +145,17 @@ struct path_defs
"@param end_ext The end extension of the path\n"
"@param round If this flag is true, the path will get rounded ends\n"
) +
method ("<", &C::less,
method ("<", &C::less, gsi::arg ("p"),
"@brief Less operator\n"
"@args p\n"
"@param p The object to compare against\n"
"This operator is provided to establish some, not necessarily a certain sorting order"
) +
method ("==", &C::equal,
method ("==", &C::equal, gsi::arg ("p"),
"@brief Equality test\n"
"@args p\n"
"@param p The object to compare against"
) +
method ("!=", &C::not_equal,
method ("!=", &C::not_equal, gsi::arg ("p"),
"@brief Inequality test\n"
"@args p\n"
"@param p The object to compare against\n"
) +
method_ext ("hash", &hash_value,
@ -170,9 +164,8 @@ struct path_defs
"\n"
"This method has been introduced in version 0.25.\n"
) +
method_ext ("points=", &set_points,
method_ext ("points=", &set_points, gsi::arg ("p"),
"@brief Set the points of the path\n"
"@args p\n"
"@param p An array of points to assign to the path's spine"
) +
iterator ("each_point", &C::begin, &C::end,
@ -181,30 +174,26 @@ struct path_defs
method ("num_points|#points", &C::points,
"@brief Get the number of points"
) +
method ("width=", (void (C::*)(coord_type)) &C::width,
method ("width=", (void (C::*)(coord_type)) &C::width, gsi::arg ("w"),
"@brief Set the width\n"
"@args w\n"
) +
method ("width", (coord_type (C::*)() const) &C::width,
"@brief Get the width\n"
) +
method ("bgn_ext=", (void (C::*)(coord_type)) &C::bgn_ext,
method ("bgn_ext=", (void (C::*)(coord_type)) &C::bgn_ext, gsi::arg ("ext"),
"@brief Set the begin extension\n"
"@args ext\n"
) +
method ("bgn_ext", (coord_type (C::*)() const) &C::bgn_ext,
"@brief Get the begin extension\n"
) +
method ("end_ext=", (void (C::*)(coord_type)) &C::end_ext,
method ("end_ext=", (void (C::*)(coord_type)) &C::end_ext, gsi::arg ("ext"),
"@brief Set the end extension\n"
"@args ext\n"
) +
method ("end_ext", (coord_type (C::*)() const) &C::end_ext,
"@brief Get the end extension\n"
) +
method ("round=", (void (C::*)(bool)) &C::round,
method ("round=", (void (C::*)(bool)) &C::round, gsi::arg ("round_ends_flag"),
"@brief Set the 'round ends' flag\n"
"@args round_ends_flag\n"
"A path with round ends show half circles at the ends, instead of square or rectangular ends. "
"Paths with this flag set should use a begin and end extension of half the width (see \\bgn_ext and \\end_ext). "
"The interpretation of such paths in other tools may differ otherwise."
@ -212,17 +201,15 @@ struct path_defs
method ("is_round?", (bool (C::*)() const) &C::round,
"@brief Returns true, if the path has round ends\n"
) +
method_ext ("*", &scale,
method_ext ("*", &scale, gsi::arg ("f"),
"@brief Scaling by some factor\n"
"\n"
"@args f\n"
"\n"
"Returns the scaled object. All coordinates are multiplied with the given factor and if "
"necessary rounded."
) +
method ("move", &C::move,
method ("move", &C::move, gsi::arg ("p"),
"@brief Moves the path.\n"
"@args p\n"
"\n"
"Moves the path by the given offset and returns the \n"
"moved path. The path is overwritten.\n"
@ -231,9 +218,8 @@ struct path_defs
"\n"
"@return The moved path.\n"
) +
method_ext ("move", &move_xy,
method_ext ("move", &move_xy, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Moves the path.\n"
"@args dx, dy\n"
"\n"
"Moves the path by the given offset and returns the \n"
"moved path. The path is overwritten.\n"
@ -245,9 +231,8 @@ struct path_defs
"\n"
"This version has been added in version 0.23.\n"
) +
method ("moved", &C::moved,
method ("moved", &C::moved, gsi::arg ("p"),
"@brief Returns the moved path (does not change self)\n"
"@args p\n"
"\n"
"Moves the path by the given offset and returns the \n"
"moved path. The path is not modified.\n"
@ -256,9 +241,8 @@ struct path_defs
"\n"
"@return The moved path.\n"
) +
method_ext ("moved", &moved_xy,
method_ext ("moved", &moved_xy, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Returns the moved path (does not change self)\n"
"@args dx, dy\n"
"\n"
"Moves the path by the given offset and returns the \n"
"moved path. The path is not modified.\n"
@ -270,9 +254,8 @@ struct path_defs
"\n"
"This version has been added in version 0.23.\n"
) +
method ("transformed", &C::template transformed<simple_trans_type>,
method ("transformed", &C::template transformed<simple_trans_type>, gsi::arg ("t"),
"@brief Transform the path.\n"
"@args t\n"
"\n"
"Transforms the path with the given transformation.\n"
"Does not modify the path but returns the transformed path.\n"
@ -281,9 +264,8 @@ struct path_defs
"\n"
"@return The transformed path.\n"
) +
method ("transformed|#transformed_cplx", &C::template transformed<complex_trans_type>,
method ("transformed|#transformed_cplx", &C::template transformed<complex_trans_type>, gsi::arg ("t"),
"@brief Transform the path.\n"
"@args t\n"
"\n"
"Transforms the path with the given complex transformation.\n"
"Does not modify the path but returns the transformed path.\n"
@ -292,9 +274,8 @@ struct path_defs
"\n"
"@return The transformed path.\n"
) +
constructor ("from_s", &from_string,
constructor ("from_s", &from_string, gsi::arg ("s"),
"@brief Creates an object from a string\n"
"@args s\n"
"Creates the object from a string representation (as returned by \\to_s)\n"
"\n"
"This method has been added in version 0.23.\n"
@ -367,9 +348,8 @@ Class<db::Path> decl_Path ("db", "Path",
"\n"
"This method has been introduced in version 0.25."
) +
method ("transformed", &db::Path::transformed<db::ICplxTrans>,
method ("transformed", &db::Path::transformed<db::ICplxTrans>, gsi::arg ("t"),
"@brief Transform the path.\n"
"@args t\n"
"\n"
"Transforms the path with the given complex transformation.\n"
"Does not modify the path but returns the transformed path.\n"
@ -447,10 +427,9 @@ Class<db::DPath> decl_DPath ("db", "DPath",
"\n"
"This method has been introduced in version 0.25."
) +
method ("transformed", &db::DPath::transformed<db::VCplxTrans>,
method ("transformed", &db::DPath::transformed<db::VCplxTrans>, gsi::arg ("t"),
"@brief Transforms the polygon with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed path (in this case an integer coordinate path)\n"
@ -474,4 +453,3 @@ Class<db::DPath> decl_DPath ("db", "DPath",
);
}

50
src/db/db/gsiDeclDbPoint.cc
View File

@ -103,16 +103,14 @@ struct point_defs
constructor ("new", &new_v,
"@brief Default constructor: creates a point at 0,0"
) +
constructor ("new", &new_vec,
constructor ("new", &new_vec, gsi::arg ("v"),
"@brief Default constructor: creates a point at from an vector\n"
"@args v\n"
"This constructor is equivalent to computing point(0,0)+v.\n"
"This method has been introduced in version 0.25."
) +
constructor ("new", &new_xy,
constructor ("new", &new_xy, gsi::arg ("x"), gsi::arg ("y"),
"@brief Constructor for a point from two coordinate values\n"
"\n"
"@args x, y\n"
) +
method_ext ("to_v", &to_vector,
"@brief Turns the point into a vector\n"
@ -122,47 +120,41 @@ struct point_defs
method_ext ("-@", &negate,
"@brief Compute the negative of a point\n"
"\n"
"@args p\n"
"\n"
"Returns a new point with -x, -y.\n"
"\n"
"This method has been added in version 0.23."
) +
method ("+", (C (C::*) (const db::vector<coord_type> &) const) &C::add,
method ("+", (C (C::*) (const db::vector<coord_type> &) const) &C::add, gsi::arg ("v"),
"@brief Adds a vector to a point\n"
"\n"
"@args v\n"
"\n"
"Adds vector v to self by adding the coordinates.\n"
"\n"
"Starting with version 0.25, this method expects a vector argument."
) +
method ("-", (db::vector<coord_type> (C::*) (const C &) const) &C::subtract,
method ("-", (db::vector<coord_type> (C::*) (const C &) const) &C::subtract, gsi::arg ("p"),
"@brief Subtract one point from another\n"
"\n"
"@args p\n"
"\n"
"Subtract point p from self by subtracting the coordinates. This renders a vector.\n"
"\n"
"Starting with version 0.25, this method renders a vector."
) +
method ("<", &C::less,
method ("<", &C::less, gsi::arg ("p"),
"@brief \"less\" comparison operator\n"
"\n"
"@args p\n"
"\n"
"This operator is provided to establish a sorting\n"
"order\n"
) +
method ("==", &C::equal,
method ("==", &C::equal, gsi::arg ("p"),
"@brief Equality test operator\n"
"\n"
"@args p\n"
) +
method ("!=", &C::not_equal,
method ("!=", &C::not_equal, gsi::arg ("p"),
"@brief Inequality test operator\n"
"\n"
"@args p\n"
) +
method_ext ("hash", &hash_value,
"@brief Computes a hash value\n"
@ -176,57 +168,49 @@ struct point_defs
method ("y", &C::y,
"@brief Accessor to the y coordinate\n"
) +
method ("x=", &C::set_x,
method ("x=", &C::set_x, gsi::arg ("coord"),
"@brief Write accessor to the x coordinate\n"
"@args coord\n"
) +
method ("y=", &C::set_y,
method ("y=", &C::set_y, gsi::arg ("coord"),
"@brief Write accessor to the y coordinate\n"
"@args coord\n"
) +
method_ext ("*", &scale,
method_ext ("*", &scale, gsi::arg ("f"),
"@brief Scaling by some factor\n"
"\n"
"@args f\n"
"\n"
"Returns the scaled object. All coordinates are multiplied with the given factor and if "
"necessary rounded."
) +
method_ext ("*=", &iscale,
method_ext ("*=", &iscale, gsi::arg ("f"),
"@brief Scaling by some factor\n"
"\n"
"@args f\n"
"\n"
"Scales object in place. All coordinates are multiplied with the given factor and if "
"necessary rounded."
) +
method_ext ("/", &divide,
method_ext ("/", &divide, gsi::arg ("d"),
"@brief Division by some divisor\n"
"\n"
"@args d\n"
"\n"
"Returns the scaled object. All coordinates are divided with the given divisor and if "
"necessary rounded."
) +
method_ext ("/=", &idiv,
method_ext ("/=", &idiv, gsi::arg ("d"),
"@brief Division by some divisor\n"
"\n"
"@args d\n"
"\n"
"Divides the object in place. All coordinates are divided with the given divisor and if "
"necessary rounded."
) +
method ("distance", (double (C::*) (const C &) const) &C::double_distance,
method ("distance", (double (C::*) (const C &) const) &C::double_distance, gsi::arg ("d"),
"@brief The Euclidian distance to another point\n"
"\n"
"@args d\n"
"\n"
"@param d The other point to compute the distance to.\n"
) +
method ("sq_distance", (double (C::*) (const C &) const) &C::sq_double_distance,
method ("sq_distance", (double (C::*) (const C &) const) &C::sq_double_distance, gsi::arg ("d"),
"@brief The square Euclidian distance to another point\n"
"\n"
"@args d\n"
"\n"
"@param d The other point to compute the distance to.\n"
) +
@ -244,9 +228,8 @@ struct point_defs
"\n"
"This method has been introduced in version 0.23."
) +
constructor ("from_s", &from_string,
constructor ("from_s", &from_string, gsi::arg ("s"),
"@brief Creates an object from a string\n"
"@args s\n"
"Creates the object from a string representation (as returned by \\to_s)\n"
"\n"
"This method has been added in version 0.23.\n"
@ -329,4 +312,3 @@ Class<db::Point> decl_Point ("db", "Point",
);
}

7
src/db/db/gsiDeclDbPolygon.cc
View File

@ -1938,9 +1938,8 @@ Class<db::DPolygon> decl_DPolygon ("db", "DPolygon",
"\n"
"This method has been introduced in version 0.25."
) +
method_ext ("transform", &transform_cplx_dp,
method_ext ("transform", &transform_cplx_dp, gsi::arg ("t"),
"@brief Transforms the polygon with a complex transformation (in-place)\n"
"@args t\n"
"\n"
"Transforms the polygon with the given complex transformation.\n"
"Modifies self and returns self. An out-of-place version which does not modify self is \\transformed.\n"
@ -1949,10 +1948,9 @@ Class<db::DPolygon> decl_DPolygon ("db", "DPolygon",
"\n"
"This method has been introduced in version 0.24.\n"
) +
method_ext ("transformed", &transformed_vcplx_dp,
method_ext ("transformed", &transformed_vcplx_dp, gsi::arg ("t"),
"@brief Transforms the polygon with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed polygon (in this case an integer coordinate polygon)\n"
@ -2006,4 +2004,3 @@ Class<db::DPolygon> decl_DPolygon ("db", "DPolygon",
);
}

34
src/db/db/gsiDeclDbReader.cc
View File

@ -83,29 +83,25 @@ namespace gsi
}
Class<db::LayerMap> decl_LayerMap ("db", "LayerMap",
gsi::method_ext ("is_mapped?", &lm_is_mapped,
gsi::method_ext ("is_mapped?", &lm_is_mapped, gsi::arg ("layer"),
"@brief Check, if a given physical layer is mapped\n"
"@args layer\n"
"@param layer The physical layer specified with an \\LayerInfo object.\n"
"@return True, if the layer is mapped."
) +
gsi::method_ext ("logical", &lm_logical,
gsi::method_ext ("logical", &lm_logical, gsi::arg ("layer"),
"@brief Returns the logical layer (the layer index in the layout object) for a given physical layer.n"
"@args layer\n"
"@param layer The physical layer specified with an \\LayerInfo object.\n"
"@return The logical layer index or -1 if the layer is not mapped."
) +
gsi::method ("mapping_str", &db::LayerMap::mapping_str,
gsi::method ("mapping_str", &db::LayerMap::mapping_str, gsi::arg ("log_layer"),
"@brief Returns the mapping string for a given logical layer\n"
"@args log_layer\n"
"@param log_layer The logical layer for which the mapping is requested.\n"
"@return A string describing the mapping."
"\n"
"The mapping string is compatible with the string that the \"map\" method accepts.\n"
) +
gsi::method_ext ("mapping", &lm_mapping,
gsi::method_ext ("mapping", &lm_mapping, gsi::arg ("log_layer"),
"@brief Returns the mapped physical (or target if one is specified) layer for a given logical layer\n"
"@args log_layer\n"
"@param log_layer The logical layer for which the mapping is requested.\n"
"@return A \\LayerInfo object which is the physical layer mapped to the logical layer."
"\n"
@ -113,18 +109,16 @@ namespace gsi
"to one logical layer. This method will return a single one of\n"
"them. It will return the one with the lowest layer and datatype.\n"
) +
gsi::method_ext ("map", &lm_map,
gsi::method_ext ("map", &lm_map, gsi::arg ("phys_layer"), gsi::arg ("log_layer"),
"@brief Maps a physical layer to a logical one\n"
"@args phys_layer,log_layer\n"
"@param phys_layer The physical layer (a \\LayerInfo object).\n"
"@param log_layer The logical layer to which the physical layer is mapped.\n"
"\n"
"In general, there may be more than one physical layer mapped\n"
"to one logical layer. This method will add the given physical layer to the mapping for the logical layer.\n"
) +
gsi::method_ext ("map", &lm_map_with_target,
gsi::method_ext ("map", &lm_map_with_target, gsi::arg ("phys_layer"), gsi::arg ("log_layer"), gsi::arg ("target_layer"),
"@brief Maps a physical layer to a logical one with a target layer\n"
"@args phys_layer,log_layer,target_layer\n"
"@param phys_layer The physical layer (a \\LayerInfo object).\n"
"@param log_layer The logical layer to which the physical layer is mapped.\n"
"@param target_layer The properties of the layer that will be created unless it already exists.\n"
@ -134,9 +128,8 @@ namespace gsi
"\n"
"This method has been added in version 0.20.\n"
) +
gsi::method_ext ("map", &lm_map_interval,
gsi::method_ext ("map", &lm_map_interval, gsi::arg ("pl_start"), gsi::arg ("pl_stop"), gsi::arg ("log_layer"),
"@brief Maps a physical layer interval to a logical one\n"
"@args pl_start,pl_stop,log_layer\n"
"@param pl_start The first physical layer (a \\LayerInfo object).\n"
"@param pl_stop The last physical layer (a \\LayerInfo object).\n"
"@param log_layer The logical layer to which the physical layers are mapped.\n"
@ -145,9 +138,8 @@ namespace gsi
"given logical layer. l1 and d1 are given by the pl_start argument, while l2 and d2 are given by "
"the pl_stop argument."
) +
gsi::method_ext ("map", &lm_map_interval_with_target,
gsi::method_ext ("map", &lm_map_interval_with_target, gsi::arg ("pl_start"), gsi::arg ("pl_stop"), gsi::arg ("log_layer"), gsi::arg ("layer_properties"),
"@brief Maps a physical layer interval to a logical one with a target layer\n"
"@args pl_start,pl_stop,log_layer\n"
"@param pl_start The first physical layer (a \\LayerInfo object).\n"
"@param pl_stop The last physical layer (a \\LayerInfo object).\n"
"@param log_layer The logical layer to which the physical layers are mapped.\n"
@ -159,9 +151,8 @@ namespace gsi
"\n"
"This method has been added in version 0.20.\n"
) +
gsi::method_ext ("map", &lm_map_string,
gsi::method_ext ("map", &lm_map_string, gsi::arg ("map_expr"), gsi::arg ("log_layer"),
"@brief Maps a physical layer given by a string to a logical one\n"
"@args map_expr,log_layer\n"
"@param map_expr The string describing the physical layer to map.\n"
"@param log_layer The logical layer to which the physical layers are mapped.\n"
"\n"
@ -262,9 +253,8 @@ namespace gsi
// extend the layout class by two reader methods
static
gsi::ClassExt<db::Layout> layout_reader_decl (
gsi::method_ext ("read", &load_without_options,
gsi::method_ext ("read", &load_without_options, gsi::arg ("filename"),
"@brief Load the layout from the given file\n"
"@args filename\n"
"The format of the file is determined automatically and automatic unzipping is provided. "
"No particular options can be specified.\n"
"@param filename The name of the file to load.\n"
@ -272,9 +262,8 @@ namespace gsi
"\n"
"This method has been added in version 0.18."
) +
gsi::method_ext ("read", &load_with_options,
gsi::method_ext ("read", &load_with_options, gsi::arg ("filename"), gsi::arg ("options"),
"@brief Load the layout from the given file with options\n"
"@args filename,options\n"
"The format of the file is determined automatically and automatic unzipping is provided. "
"In this version, some reader options can be specified. "
"@param filename The name of the file to load.\n"
@ -287,4 +276,3 @@ namespace gsi
);
}

59
src/db/db/gsiDeclDbRecursiveShapeIterator.cc
View File

@ -120,9 +120,8 @@ static db::Region complex_region (const db::RecursiveShapeIterator *iter)
}
Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveShapeIterator",
gsi::constructor ("new", &new_si1,
gsi::constructor ("new", &new_si1, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layer"),
"@brief Creates a recursive, single-layer shape iterator.\n"
"@args layout, cell, layer\n"
"@param layout The layout which shall be iterated\n"
"@param cell The initial cell which shall be iterated (including it's children)\n"
"@param layer The layer (index) from which the shapes are taken\n"
@ -132,10 +131,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This constructor has been introduced in version 0.23.\n"
) +
gsi::constructor ("new", &new_si2,
gsi::constructor ("new", &new_si2, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layers"),
"@brief Creates a recursive, multi-layer shape iterator.\n"
"@args layout, cell, layer\n"
"@args layout, cell, layers\n"
"@param layout The layout which shall be iterated\n"
"@param cell The initial cell which shall be iterated (including it's children)\n"
"@param layers The layer indexes from which the shapes are taken\n"
@ -146,9 +143,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This constructor has been introduced in version 0.23.\n"
) +
gsi::constructor ("new", &new_si3,
gsi::constructor ("new", &new_si3, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layer"), gsi::arg ("box"), gsi::arg ("overlapping"),
"@brief Creates a recursive, single-layer shape iterator with a region.\n"
"@args layout, cell, layer, box, overlapping\n"
"@param layout The layout which shall be iterated\n"
"@param cell The initial cell which shall be iterated (including it's children)\n"
"@param layer The layer (index) from which the shapes are taken\n"
@ -164,9 +160,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This constructor has been introduced in version 0.23.\n"
) +
gsi::constructor ("new", &new_si3a,
gsi::constructor ("new", &new_si3a, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layer"), gsi::arg ("region"), gsi::arg ("overlapping"),
"@brief Creates a recursive, single-layer shape iterator with a region.\n"
"@args layout, cell, layer, region, overlapping\n"
"@param layout The layout which shall be iterated\n"
"@param cell The initial cell which shall be iterated (including it's children)\n"
"@param layer The layer (index) from which the shapes are taken\n"
@ -183,9 +178,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This constructor has been introduced in version 0.25.\n"
) +
gsi::constructor ("new", &new_si4,
gsi::constructor ("new", &new_si4, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layers"), gsi::arg ("box"), gsi::arg ("overlapping"),
"@brief Creates a recursive, multi-layer shape iterator with a region.\n"
"@args layout, cell, layers, box, overlapping\n"
"@param layout The layout which shall be iterated\n"
"@param cell The initial cell which shall be iterated (including it's children)\n"
"@param layers The layer indexes from which the shapes are taken\n"
@ -202,9 +196,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This constructor has been introduced in version 0.23.\n"
) +
gsi::constructor ("new", &new_si4a,
gsi::constructor ("new", &new_si4a, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layers"), gsi::arg ("region"), gsi::arg ("overlapping"),
"@brief Creates a recursive, multi-layer shape iterator with a region.\n"
"@args layout, cell, layers, region, overlapping\n"
"@param layout The layout which shall be iterated\n"
"@param cell The initial cell which shall be iterated (including it's children)\n"
"@param layers The layer indexes from which the shapes are taken\n"
@ -222,9 +215,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This constructor has been introduced in version 0.23.\n"
) +
gsi::method ("max_depth=", (void (db::RecursiveShapeIterator::*) (int)) &db::RecursiveShapeIterator::max_depth,
gsi::method ("max_depth=", (void (db::RecursiveShapeIterator::*) (int)) &db::RecursiveShapeIterator::max_depth, gsi::arg ("depth"),
"@brief Specify the maximum hierarchy depth to look into\n"
"@args depth\n"
"\n"
"A depth of 0 instructs the iterator to deliver only shapes from the initial cell.\n"
"The depth must be specified before the shapes are being retrieved.\n"
@ -278,36 +270,32 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method ("region=", (void (db::RecursiveShapeIterator::*)(const db::RecursiveShapeIterator::box_type &)) &db::RecursiveShapeIterator::set_region,
gsi::method ("region=", (void (db::RecursiveShapeIterator::*)(const db::RecursiveShapeIterator::box_type &)) &db::RecursiveShapeIterator::set_region, gsi::arg ("box_region"),
"@brief Sets the rectangular region that is iterator is iterating over\n"
"@args box_region\n"
"See \\region for a description of this attribute.\n"
"Setting a simple region will reset the complex region to a rectangle and reset the iterator to "
"the beginning of the sequence."
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("region=", (void (db::RecursiveShapeIterator::*)(const db::RecursiveShapeIterator::region_type &)) &db::RecursiveShapeIterator::set_region,
gsi::method ("region=", (void (db::RecursiveShapeIterator::*)(const db::RecursiveShapeIterator::region_type &)) &db::RecursiveShapeIterator::set_region, gsi::arg ("complex_region"),
"@brief Sets the complex region that is iterator is using\n"
"@args complex_region\n"
"See \\complex_region for a description of this attribute. Setting the complex region will "
"reset the basic region (see \\region) to the bounding box of the complex region and "
"reset the iterator to the beginning of the sequence.\n"
"\n"
"This method overload has been introduced in version 0.25.\n"
) +
gsi::method ("confine_region", (void (db::RecursiveShapeIterator::*)(const db::RecursiveShapeIterator::box_type &)) &db::RecursiveShapeIterator::confine_region,
gsi::method ("confine_region", (void (db::RecursiveShapeIterator::*)(const db::RecursiveShapeIterator::box_type &)) &db::RecursiveShapeIterator::confine_region, gsi::arg ("box_region"),
"@brief Confines the region that is iterator is iterating over\n"
"@args box_region\n"
"This method is similar to setting the region (see \\region=), but will confine any region (complex or simple) already set. "
"Essentially it does a logical AND operation between the existing and given region. "
"Hence this method can only reduce a region, not extend it.\n"
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method ("confine_region", (void (db::RecursiveShapeIterator::*)(const db::RecursiveShapeIterator::region_type &)) &db::RecursiveShapeIterator::confine_region,
gsi::method ("confine_region", (void (db::RecursiveShapeIterator::*)(const db::RecursiveShapeIterator::region_type &)) &db::RecursiveShapeIterator::confine_region, gsi::arg ("complex_region"),
"@brief Confines the region that is iterator is iterating over\n"
"@args complex_region\n"
"This method is similar to setting the region (see \\region=), but will confine any region (complex or simple) already set. "
"Essentially it does a logical AND operation between the existing and given region. "
"Hence this method can only reduce a region, not extend it.\n"
@ -319,9 +307,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("overlapping=", &db::RecursiveShapeIterator::set_overlapping,
gsi::method ("overlapping=", &db::RecursiveShapeIterator::set_overlapping, gsi::arg ("region"),
"@brief Sets a flag indicating whether overlapping shapes are selected when a region is used\n"
"@args region\n"
"\n"
"If this flag is false, shapes touching the search region are returned.\n"
"\n"
@ -349,9 +336,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("unselect_cells", &unselect_cells1,
gsi::method_ext ("unselect_cells", &unselect_cells1, gsi::arg ("cells"),
"@brief Unselects the given cells.\n"
"@args cells\n"
"\n"
"This method will sets the \"unselected\" mark on the given cells. "
"That means that these cells or their child cells will not be visited, unless "
@ -363,9 +349,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("unselect_cells", &unselect_cells2,
gsi::method_ext ("unselect_cells", &unselect_cells2, gsi::arg ("cells"),
"@brief Unselects the given cells.\n"
"@args cells\n"
"\n"
"This method will sets the \"unselected\" mark on the given cells. "
"That means that these cells or their child cells will not be visited, unless "
@ -379,9 +364,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("select_cells", &select_cells1,
gsi::method_ext ("select_cells", &select_cells1, gsi::arg ("cells"),
"@brief Unselects the given cells.\n"
"@args cells\n"
"\n"
"This method will sets the \"selected\" mark on the given cells. "
"That means that these cells or their child cells are visited, unless "
@ -393,9 +377,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("select_cells", &select_cells2,
gsi::method_ext ("select_cells", &select_cells2, gsi::arg ("cells"),
"@brief Unselects the given cells.\n"
"@args cells\n"
"\n"
"This method will sets the \"selected\" mark on the given cells. "
"That means that these cells or their child cells are visited, unless "
@ -409,9 +392,8 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("shape_flags=", (void (db::RecursiveShapeIterator::*)(unsigned int)) &db::RecursiveShapeIterator::shape_flags,
gsi::method ("shape_flags=", (void (db::RecursiveShapeIterator::*)(unsigned int)) &db::RecursiveShapeIterator::shape_flags, gsi::arg ("flags"),
"@brief Specifies the shape selection flags\n"
"@args flags\n"
"\n"
"The flags are the same then being defined in \\Shapes (the default is RBA::Shapes::SAll).\n"
"The flags must be specified before the shapes are being retrieved.\n"
@ -470,15 +452,13 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.25."
) +
gsi::method ("==", &db::RecursiveShapeIterator::operator==,
gsi::method ("==", &db::RecursiveShapeIterator::operator==, gsi::arg ("other"),
"@brief Comparison of iterators - equality\n"
"@args other\n"
"\n"
"Two iterators are equal if they point to the same shape.\n"
) +
gsi::method ("!=", &db::RecursiveShapeIterator::operator!=,
gsi::method ("!=", &db::RecursiveShapeIterator::operator!=, gsi::arg ("other"),
"@brief Comparison of iterators - inequality\n"
"@args other\n"
"\n"
"Two iterators are not equal if they do not point to the same shape.\n"
),
@ -568,4 +548,3 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
);
}

69
src/db/db/gsiDeclDbShape.cc
View File

@ -1156,9 +1156,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.22."
) +
gsi::method_ext ("cell=", &set_cell_ptr,
gsi::method_ext ("cell=", &set_cell_ptr, gsi::arg ("cell"),
"@brief Moves the shape to a different cell\n"
"@args cell\n"
"\n"
"Both the current and the target cell must reside in the same layout.\n"
"\n"
@ -1171,9 +1170,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.22."
) +
gsi::method_ext ("box=", &set_shape<db::Box>,
gsi::method_ext ("box=", &set_shape<db::Box>, gsi::arg ("box"),
"@brief Replaces the shape by the given box\n"
"@args box\n"
"This method replaces the shape by the given box. This method can only be called "
"for editable layouts. It does not change the user properties of the shape.\n"
"Calling this method will invalidate any iterators. It should not be called inside a "
@ -1188,9 +1186,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.25."
) +
gsi::method_ext ("path=", &set_shape<db::Path>,
gsi::method_ext ("path=", &set_shape<db::Path>, gsi::arg ("box"),
"@brief Replaces the shape by the given path object\n"
"@args box\n"
"This method replaces the shape by the given path object. This method can only be called "
"for editable layouts. It does not change the user properties of the shape.\n"
"Calling this method will invalidate any iterators. It should not be called inside a "
@ -1205,9 +1202,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.25."
) +
gsi::method_ext ("polygon=", &set_shape<db::Polygon>,
gsi::method_ext ("polygon=", &set_shape<db::Polygon>, gsi::arg ("box"),
"@brief Replaces the shape by the given polygon object\n"
"@args box\n"
"This method replaces the shape by the given polygon object. This method can only be called "
"for editable layouts. It does not change the user properties of the shape.\n"
"Calling this method will invalidate any iterators. It should not be called inside a "
@ -1222,9 +1218,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.25."
) +
gsi::method_ext ("text=", &set_shape<db::Text>,
gsi::method_ext ("text=", &set_shape<db::Text>, gsi::arg ("box"),
"@brief Replaces the shape by the given text object\n"
"@args box\n"
"This method replaces the shape by the given text object. This method can only be called "
"for editable layouts. It does not change the user properties of the shape.\n"
"Calling this method will invalidate any iterators. It should not be called inside a "
@ -1241,7 +1236,6 @@ Class<db::Shape> decl_Shape ("db", "Shape",
) +
gsi::method_ext ("edge=", &set_shape<db::Edge>, gsi::arg("edge"),
"@brief Replaces the shape by the given edge\n"
"@args box\n"
"This method replaces the shape by the given edge. This method can only be called "
"for editable layouts. It does not change the user properties of the shape.\n"
"Calling this method will invalidate any iterators. It should not be called inside a "
@ -1258,7 +1252,6 @@ Class<db::Shape> decl_Shape ("db", "Shape",
) +
gsi::method_ext ("edge_pair=", &set_shape<db::EdgePair>, gsi::arg("edge_pair"),
"@brief Replaces the shape by the given edge pair\n"
"@args box\n"
"This method replaces the shape by the given edge pair. This method can only be called "
"for editable layouts. It does not change the user properties of the shape.\n"
"Calling this method will invalidate any iterators. It should not be called inside a "
@ -1273,9 +1266,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.26."
) +
gsi::method_ext ("delete_property", &delete_property,
gsi::method_ext ("delete_property", &delete_property, gsi::arg ("key"),
"@brief Deletes the user property with the given key\n"
"@args key\n"
"This method is a convenience method that deletes the property with the given key. "
"It does nothing if no property with that key exists. Using that method is more "
"convenient than creating a new property set with a new ID and assigning that properties ID.\n"
@ -1285,9 +1277,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.22."
) +
gsi::method_ext ("set_property", &set_property,
gsi::method_ext ("set_property", &set_property, gsi::arg ("key"), gsi::arg ("value"),
"@brief Sets the user property with the given key to the given value\n"
"@args key, value\n"
"This method is a convenience method that sets the property with the given key to the given value. "
"If no property with that key exists, it will create one. Using that method is more "
"convenient than creating a new property set with a new ID and assigning that properties ID.\n"
@ -1297,9 +1288,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.22."
) +
gsi::method_ext ("property", &get_property,
gsi::method_ext ("property", &get_property, gsi::arg ("key"),
"@brief Gets the user property with the given key\n"
"@args key\n"
"This method is a convenience method that gets the property with the given key. "
"If no property with that key does not exist, it will return nil. Using that method is more "
"convenient than using the layout object and the properties ID to retrieve the property value. "
@ -1336,9 +1326,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.25."
) +
gsi::iterator ("each_point_hole", &db::Shape::begin_hole, &db::Shape::end_hole,
gsi::iterator ("each_point_hole", &db::Shape::begin_hole, &db::Shape::end_hole, gsi::arg ("hole_index"),
"@brief Iterates over the points of a hole contour\n"
"@args hole_index\n"
"\n"
"This method applies to polygons and delivers all points of the respective hole contour.\n"
"It will throw an exception for other objects.\n"
@ -1411,9 +1400,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method_ext ("box_width=", &set_box_width,
gsi::method_ext ("box_width=", &set_box_width, gsi::arg ("w"),
"@brief Sets the width of the box\n"
"@args w\n"
"\n"
"Applies to boxes only. Changes the width of the box and throws an exception if the shape is not a box.\n"
"\n"
@ -1421,7 +1409,6 @@ Class<db::Shape> decl_Shape ("db", "Shape",
) +
gsi::method_ext ("box_dwidth=", &set_box_dwidth, gsi::arg ("w"),
"@brief Sets the width of the box in micrometer units\n"
"@args w\n"
"\n"
"Applies to boxes only. Changes the width of the box to the value given in micrometer units and throws an exception if the shape is not a box.\n"
"Translation to database units happens internally.\n"
@ -1442,9 +1429,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method_ext ("box_height=", &set_box_height,
gsi::method_ext ("box_height=", &set_box_height, gsi::arg ("h"),
"@brief Sets the height of the box\n"
"@args h\n"
"\n"
"Applies to boxes only. Changes the height of the box and throws an exception if the shape is not a box.\n"
"\n"
@ -1655,9 +1641,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"Applies to paths only. Will throw an exception if the object is not a path.\n"
) +
gsi::method_ext ("round_path=", &set_round_path,
gsi::method_ext ("round_path=", &set_round_path, gsi::arg ("r"),
"@brief The path will be a round-ended path if this property is set to true\n"
"@args r\n"
"\n"
"Applies to paths only. Will throw an exception if the object is not a path.\n"
"Please note that the extensions will apply as well. To get a path with circular ends, set the begin and "
@ -1794,9 +1779,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
) +
gsi::method_ext ("text_string=", &set_text_string,
gsi::method_ext ("text_string=", &set_text_string, gsi::arg ("string"),
"@brief Sets the text string\n"
"@args string\n"
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
"\n"
@ -1807,9 +1791,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
) +
gsi::method_ext ("text_rot=", &set_text_rot,
gsi::method_ext ("text_rot=", &set_text_rot, gsi::arg ("o"),
"@brief Sets the text's orientation code (see \\Trans)\n"
"@args o\n"
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
) +
@ -1873,7 +1856,6 @@ Class<db::Shape> decl_Shape ("db", "Shape",
) +
gsi::method_ext ("text_size=", &set_text_size, gsi::arg ("size"),
"@brief Sets the text size\n"
"@args size\n"
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
"\n"
@ -1881,7 +1863,6 @@ Class<db::Shape> decl_Shape ("db", "Shape",
) +
gsi::method_ext ("text_dsize=", &set_text_dsize, gsi::arg ("size"),
"@brief Sets the text size in micrometer units\n"
"@args size\n"
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
"\n"
@ -1892,9 +1873,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
) +
gsi::method_ext ("text_font=", &set_text_font,
gsi::method_ext ("text_font=", &set_text_font, gsi::arg ("font"),
"@brief Sets the text's font\n"
"@args font\n"
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
"\n"
@ -1908,9 +1888,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method_ext ("text_halign=", &set_text_halign,
gsi::method_ext ("text_halign=", &set_text_halign, gsi::arg ("a"),
"@brief Sets the text's horizontal alignment\n"
"@args a\n"
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
"See \\text_halign for a description of that property.\n"
@ -1925,9 +1904,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been introduced in version 0.22.\n"
) +
gsi::method_ext ("text_valign=", &set_text_valign,
gsi::method_ext ("text_valign=", &set_text_valign, gsi::arg ("a"),
"@brief Sets the text's vertical alignment\n"
"@args a\n"
"\n"
"Applies to texts only. Will throw an exception if the object is not a text.\n"
"See \\text_valign for a description of that property.\n"
@ -2036,9 +2014,8 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("layer_info=", &set_shape_layer,
gsi::method_ext ("layer_info=", &set_shape_layer, gsi::arg ("layer_info"),
"@brief Moves the shape to a layer given by a \\LayerInfo object\n"
"@args layer_info\n"
"If no layer with the given properties exists, an exception is thrown.\n"
"\n"
"This method has been added in version 0.23.\n"
@ -2049,19 +2026,16 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method_ext ("layer=", &set_shape_layer_index,
gsi::method_ext ("layer=", &set_shape_layer_index, gsi::arg ("layer_index"),
"@brief Moves the shape to a layer given by the layer index object\n"
"@args layer_index\n"
"\n"
"This method has been added in version 0.23.\n"
) +
gsi::method ("!=", &db::Shape::operator!=,
gsi::method ("!=", &db::Shape::operator!=, gsi::arg ("other"),
"@brief Inequality operator\n"
"@args other\n"
) +
gsi::method ("==", &db::Shape::operator==,
gsi::method ("==", &db::Shape::operator==, gsi::arg ("other"),
"@brief Equality operator\n"
"@args other\n"
"\n"
"Equality of shapes is not specified by the identity of the objects but by the\n"
"identity of the pointers - both shapes must refer to the same object.\n"
@ -2112,4 +2086,3 @@ Class<db::Shape> decl_Shape ("db", "Shape",
);
}

61
src/db/db/gsiDeclDbShapeProcessor.cc
View File

@ -176,9 +176,8 @@ size_to_polygon2n (db::ShapeProcessor *processor, const std::vector<db::Shape> &
Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
method ("merge", (void (db::ShapeProcessor::*) (const db::Layout &, const db::Cell &, unsigned int, db::Shapes &, bool, unsigned int, bool, bool)) &db::ShapeProcessor::merge,
method ("merge", (void (db::ShapeProcessor::*) (const db::Layout &, const db::Cell &, unsigned int, db::Shapes &, bool, unsigned int, bool, bool)) &db::ShapeProcessor::merge, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layer"), gsi::arg ("out"), gsi::arg ("hierarchical"), gsi::arg ("min_wc"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Merge the given shapes from a layout into a shapes container\n"
"@args layout, cell, layer, out, hierarchical, min_wc, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the merge method. This implementation takes shapes\n"
"from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container. "
@ -192,9 +191,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method ("boolean", (void (db::ShapeProcessor::*) (const db::Layout &, const db::Cell &, unsigned int, const db::Layout &, const db::Cell &, unsigned int, db::Shapes &, int, bool, bool, bool)) &db::ShapeProcessor::boolean,
method ("boolean", (void (db::ShapeProcessor::*) (const db::Layout &, const db::Cell &, unsigned int, const db::Layout &, const db::Cell &, unsigned int, db::Shapes &, int, bool, bool, bool)) &db::ShapeProcessor::boolean, gsi::arg ("layout_a"), gsi::arg ("cell_a"), gsi::arg ("layer_a"), gsi::arg ("layout_b"), gsi::arg ("cell_b"), gsi::arg ("layer_b"), gsi::arg ("out"), gsi::arg ("mode"), gsi::arg ("hierarchical"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Boolean operation on shapes from layouts\n"
"@args layout_a, cell_a, layer_a, layout_b, cell_b, layer_b, out, mode, hierarchical, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the boolean operations. This implementation takes shapes\n"
"from layout cells (optionally all in hierarchy) and produces new shapes in a shapes container. "
@ -211,9 +209,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method ("size", (void (db::ShapeProcessor::*) (const db::Layout &, const db::Cell &, unsigned int, db::Shapes &, db::Coord, db::Coord, unsigned int, bool, bool, bool)) &db::ShapeProcessor::size,
method ("size", (void (db::ShapeProcessor::*) (const db::Layout &, const db::Cell &, unsigned int, db::Shapes &, db::Coord, db::Coord, unsigned int, bool, bool, bool)) &db::ShapeProcessor::size, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layer"), gsi::arg ("out"), gsi::arg ("dx"), gsi::arg ("dy"), gsi::arg ("mode"), gsi::arg ("hierarchical"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Sizing operation on shapes from layouts\n"
"@args layout, cell, layer, out, dx, dy, mode, hierarchical, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing operation. This implementation takes shapes\n"
"from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container. "
@ -229,9 +226,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method ("size", (void (db::ShapeProcessor::*) (const db::Layout &, const db::Cell &, unsigned int, db::Shapes &, db::Coord, unsigned int, bool, bool, bool)) &db::ShapeProcessor::size,
method ("size", (void (db::ShapeProcessor::*) (const db::Layout &, const db::Cell &, unsigned int, db::Shapes &, db::Coord, unsigned int, bool, bool, bool)) &db::ShapeProcessor::size, gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layer"), gsi::arg ("out"), gsi::arg ("d"), gsi::arg ("mode"), gsi::arg ("hierarchical"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Sizing operation on shapes from layouts\n"
"@args layout, cell, layer, out, d, mode, hierarchical, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing operation. This implementation takes shapes\n"
"from a layout cell (optionally all in hierarchy) and produces new shapes in a shapes container. "
@ -247,9 +243,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method_ext ("merge", &gsi::merge1,
method_ext ("merge", &gsi::merge1, gsi::arg ("in"), gsi::arg ("trans"), gsi::arg ("min_wc"),
"@brief Merge the given shapes\n"
"@args in, trans, min_wc\n"
"\n"
"See the \\EdgeProcessor for a description of the merge method. This implementation takes shapes\n"
"rather than polygons for input and produces an edge set.\n"
@ -258,9 +253,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param trans A corresponding set of transformations to apply on the shapes\n"
"@param min_wc The minimum wrap count for output (0: all polygons, 1: at least two overlapping)\n"
) +
method_ext ("merge_to_polygon", &gsi::merge_to_polygon1,
method_ext ("merge_to_polygon", &gsi::merge_to_polygon1, gsi::arg ("in"), gsi::arg ("trans"), gsi::arg ("min_wc"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Merge the given shapes\n"
"@args in, trans, min_wc, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the merge method. This implementation takes shapes\n"
"rather than polygons for input and produces a polygon set.\n"
@ -271,9 +265,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method_ext ("merge", &gsi::merge2,
method_ext ("merge", &gsi::merge2, gsi::arg ("in"), gsi::arg ("min_wc"),
"@brief Merge the given shapes\n"
"@args in, min_wc\n"
"\n"
"See the \\EdgeProcessor for a description of the merge method. This implementation takes shapes\n"
"rather than polygons for input and produces an edge set.\n"
@ -283,9 +276,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param in The set of shapes to merge\n"
"@param min_wc The minimum wrap count for output (0: all polygons, 1: at least two overlapping)\n"
) +
method_ext ("merge_to_polygon", &gsi::merge_to_polygon2,
method_ext ("merge_to_polygon", &gsi::merge_to_polygon2, gsi::arg ("in"), gsi::arg ("min_wc"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Merge the given shapes\n"
"@args in, min_wc, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the merge method. This implementation takes shapes\n"
"rather than polygons for input and produces a polygon set.\n"
@ -297,9 +289,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method_ext ("boolean", &gsi::boolean1,
method_ext ("boolean", &gsi::boolean1, gsi::arg ("in_a"), gsi::arg ("trans_a"), gsi::arg ("in_b"), gsi::arg ("trans_b"), gsi::arg ("mode"),
"@brief Boolean operation on two given shape sets into an edge set\n"
"@args in_a, trans_a, in_b, trans_b, mode\n"
"\n"
"See the \\EdgeProcessor for a description of the boolean operations. This implementation takes shapes\n"
"rather than polygons for input and produces an edge set.\n"
@ -310,9 +301,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param trans_b A set of transformations to apply before the shapes are used\n"
"@param mode The boolean operation (see \\EdgeProcessor)\n"
) +
method_ext ("boolean_to_polygon", &gsi::boolean_to_polygon1,
method_ext ("boolean_to_polygon", &gsi::boolean_to_polygon1, gsi::arg ("in_a"), gsi::arg ("trans_a"), gsi::arg ("in_b"), gsi::arg ("trans_b"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Boolean operation on two given shape sets into a polygon set\n"
"@args in_a, trans_a, in_b, trans_b, mode, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the boolean operations. This implementation takes shapes\n"
"rather than polygons for input and produces a polygon set.\n"
@ -325,9 +315,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method_ext ("boolean", &gsi::boolean2,
method_ext ("boolean", &gsi::boolean2, gsi::arg ("in_a"), gsi::arg ("in_b"), gsi::arg ("mode"),
"@brief Boolean operation on two given shape sets into an edge set\n"
"@args in_a, in_b, mode\n"
"\n"
"See the \\EdgeProcessor for a description of the boolean operations. This implementation takes shapes\n"
"rather than polygons for input and produces an edge set.\n"
@ -338,9 +327,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param in_b The set of shapes to use for input A\n"
"@param mode The boolean operation (see \\EdgeProcessor)\n"
) +
method_ext ("boolean_to_polygon", &gsi::boolean_to_polygon2,
method_ext ("boolean_to_polygon", &gsi::boolean_to_polygon2, gsi::arg ("in_a"), gsi::arg ("in_b"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Boolean operation on two given shape sets into a polygon set\n"
"@args in_a, in_b, mode, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the boolean operations. This implementation takes shapes\n"
"rather than polygons for input and produces a polygon set.\n"
@ -353,9 +341,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method_ext ("size", &gsi::size1,
method_ext ("size", &gsi::size1, gsi::arg ("in"), gsi::arg ("trans"), gsi::arg ("d"), gsi::arg ("mode"),
"@brief Size the given shapes\n"
"@args in, trans, d, mode\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing method. This implementation takes shapes\n"
"rather than polygons for input and produces an edge set. This is isotropic version that does not allow\n"
@ -366,9 +353,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param d The sizing value\n"
"@param mode The sizing mode (see \\EdgeProcessor)\n"
) +
method_ext ("size", &gsi::size2,
method_ext ("size", &gsi::size2, gsi::arg ("in"), gsi::arg ("trans"), gsi::arg ("dx"), gsi::arg ("dy"), gsi::arg ("mode"),
"@brief Size the given shapes\n"
"@args in, trans, dx, dy, mode\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing method. This implementation takes shapes\n"
"rather than polygons for input and produces an edge set.\n"
@ -379,9 +365,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param dy The sizing value in y-direction\n"
"@param mode The sizing mode (see \\EdgeProcessor)\n"
) +
method_ext ("size_to_polygon", &gsi::size_to_polygon1,
method_ext ("size_to_polygon", &gsi::size_to_polygon1, gsi::arg ("in"), gsi::arg ("trans"), gsi::arg ("d"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Size the given shapes\n"
"@args in, trans, d, mode, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing method. This implementation takes shapes\n"
"rather than polygons for input and produces a polygon set. This is isotropic version that does not allow\n"
@ -394,9 +379,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method_ext ("size_to_polygon", &gsi::size_to_polygon2,
method_ext ("size_to_polygon", &gsi::size_to_polygon2, gsi::arg ("in"), gsi::arg ("trans"), gsi::arg ("dx"), gsi::arg ("dy"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Size the given shapes\n"
"@args in, trans, dx, dy, mode, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing method. This implementation takes shapes\n"
"rather than polygons for input and produces a polygon set.\n"
@ -409,9 +393,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method_ext ("size", &gsi::size1n,
method_ext ("size", &gsi::size1n, gsi::arg ("in"), gsi::arg ("d"), gsi::arg ("mode"),
"@brief Size the given shapes\n"
"@args in, d, mode\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing method. This implementation takes shapes\n"
"rather than polygons for input and produces an edge set. This is isotropic version that does not allow\n"
@ -423,9 +406,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param d The sizing value\n"
"@param mode The sizing mode (see \\EdgeProcessor)\n"
) +
method_ext ("size", &gsi::size2n,
method_ext ("size", &gsi::size2n, gsi::arg ("in"), gsi::arg ("dx"), gsi::arg ("dy"), gsi::arg ("mode"),
"@brief Size the given shapes\n"
"@args in, dx, dy, mode\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing method. This implementation takes shapes\n"
"rather than polygons for input and produces an edge set.\n"
@ -437,9 +419,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param dy The sizing value in y-direction\n"
"@param mode The sizing mode (see \\EdgeProcessor)\n"
) +
method_ext ("size_to_polygon", &gsi::size_to_polygon1n,
method_ext ("size_to_polygon", &gsi::size_to_polygon1n, gsi::arg ("in"), gsi::arg ("d"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Size the given shapes\n"
"@args in, d, mode, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing method. This implementation takes shapes\n"
"rather than polygons for input and produces a polygon set. This is isotropic version that does not allow\n"
@ -453,9 +434,8 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
"@param resolve_holes true, if holes should be resolved into the hull\n"
"@param min_coherence true, if minimum polygons should be created for touching corners\n"
) +
method_ext ("size_to_polygon", &gsi::size_to_polygon2n,
method_ext ("size_to_polygon", &gsi::size_to_polygon2n, gsi::arg ("in"), gsi::arg ("dx"), gsi::arg ("dy"), gsi::arg ("mode"), gsi::arg ("resolve_holes"), gsi::arg ("min_coherence"),
"@brief Size the given shapes\n"
"@args in, dx, dy, mode, resolve_holes, min_coherence\n"
"\n"
"See the \\EdgeProcessor for a description of the sizing method. This implementation takes shapes\n"
"rather than polygons for input and produces a polygon set.\n"
@ -477,4 +457,3 @@ Class<db::ShapeProcessor> decl_ShapeProcessor ("db", "ShapeProcessor",
);
}

79
src/db/db/gsiDeclDbShapes.cc
View File

@ -431,9 +431,8 @@ static unsigned int s_texts () { return db::ShapeIterator::Texts;
static unsigned int s_user_objects () { return db::ShapeIterator::UserObjects; }
Class<db::Shapes> decl_Shapes ("db", "Shapes",
gsi::method ("insert", (db::Shape (db::Shapes::*)(const db::Shape &)) &db::Shapes::insert,
gsi::method ("insert", (db::Shape (db::Shapes::*)(const db::Shape &)) &db::Shapes::insert, gsi::arg ("shape"),
"@brief Inserts a shape from a shape reference into the shapes list\n"
"@args shape\n"
"@return A reference (a \\Shape object) to the newly created shape\n"
"This method has been introduced in version 0.16.\n"
) +
@ -707,9 +706,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"It has been introduced in version 0.25.\n"
) +
gsi::method ("transform", (db::Shape (db::Shapes::*)(const db::Shape &, const db::Trans &)) &db::Shapes::transform,
gsi::method ("transform", (db::Shape (db::Shapes::*)(const db::Shape &, const db::Trans &)) &db::Shapes::transform, gsi::arg ("shape"), gsi::arg ("trans"),
"@brief Transforms the shape given by the reference with the given transformation\n"
"@args shape, trans\n"
"@return A reference (a \\Shape object) to the new shape\n"
"The original shape may be deleted and re-inserted by this method. Therefore, a new reference is returned.\n"
"It is permitted in editable mode only.\n"
@ -741,10 +739,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method_ext ("replace", &replace<db::Box>,
gsi::method_ext ("replace", &replace<db::Box>, gsi::arg ("shape"), gsi::arg ("box"),
"@brief Replaces the given shape with a box\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args shape,box\n"
"\n"
"This method has been introduced with version 0.16. It replaces the given shape with the "
"object specified. It does not change the property Id. To change the property Id, "
@ -762,10 +759,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("replace", &replace<db::Path>,
gsi::method_ext ("replace", &replace<db::Path>, gsi::arg ("shape"), gsi::arg ("path"),
"@brief Replaces the given shape with a path\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args shape,path\n"
"\n"
"This method has been introduced with version 0.16. It replaces the given shape with the "
"object specified. It does not change the property Id. To change the property Id, "
@ -823,10 +819,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.26.\n"
) +
gsi::method_ext ("replace", &replace<db::Text>,
gsi::method_ext ("replace", &replace<db::Text>, gsi::arg ("shape"), gsi::arg ("text"),
"@brief Replaces the given shape with a text object\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args shape,text\n"
"\n"
"This method has been introduced with version 0.16. It replaces the given shape with the "
"object specified. It does not change the property Id. To change the property Id, "
@ -844,10 +839,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("replace", &replace<db::SimplePolygon>,
gsi::method_ext ("replace", &replace<db::SimplePolygon>, gsi::arg ("shape"), gsi::arg ("simple_polygon"),
"@brief Replaces the given shape with a simple polygon\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args shape,simple_polygon\n"
"\n"
"This method has been introduced with version 0.16. It replaces the given shape with the "
"object specified. It does not change the property Id. To change the property Id, "
@ -865,10 +859,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("replace", &replace<db::Polygon>,
gsi::method_ext ("replace", &replace<db::Polygon>, gsi::arg ("shape"), gsi::arg ("polygon"),
"@brief Replaces the given shape with a polygon\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args shape,polygon\n"
"\n"
"This method has been introduced with version 0.16. It replaces the given shape with the "
"object specified. It does not change the property Id. To change the property Id, "
@ -886,10 +879,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("insert|#insert_box", &insert<db::Box>,
gsi::method_ext ("insert|#insert_box", &insert<db::Box>, gsi::arg ("box"),
"@brief Inserts a box into the shapes list\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args box\n"
"\n"
"Starting with version 0.16, this method returns a reference to the newly created shape\n"
) +
@ -901,10 +893,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("insert|#insert_path", &insert<db::Path>,
gsi::method_ext ("insert|#insert_path", &insert<db::Path>, gsi::arg ("path"),
"@brief Inserts a path into the shapes list\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args path\n"
"\n"
"Starting with version 0.16, this method returns a reference to the newly created shape\n"
) +
@ -942,10 +933,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.26."
) +
gsi::method_ext ("insert|#insert_text", &insert<db::Text>,
gsi::method_ext ("insert|#insert_text", &insert<db::Text>, gsi::arg ("text"),
"@brief Inserts a text into the shapes list\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args text\n"
"\n"
"Starting with version 0.16, this method returns a reference to the newly created shape\n"
) +
@ -957,10 +947,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("insert|#insert_simple_polygon", &insert<db::SimplePolygon>,
gsi::method_ext ("insert|#insert_simple_polygon", &insert<db::SimplePolygon>, gsi::arg ("simple_polygon"),
"@brief Inserts a simple polygon into the shapes list\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args simple_polygon\n"
"\n"
"Starting with version 0.16, this method returns a reference to the newly created shape\n"
) +
@ -972,10 +961,9 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("insert|#insert_polygon", &insert<db::Polygon>,
gsi::method_ext ("insert|#insert_polygon", &insert<db::Polygon>, gsi::arg ("polygon"),
"@brief Inserts a polygon into the shapes list\n"
"@return A reference to the new shape (a \\Shape object)\n"
"@args polygon\n"
"\n"
"Starting with version 0.16, this method returns a reference to the newly created shape\n"
) +
@ -987,9 +975,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("insert|#insert_box_with_properties", &insert_with_properties<db::Box>,
gsi::method_ext ("insert|#insert_box_with_properties", &insert_with_properties<db::Box>, gsi::arg ("box"), gsi::arg ("property_id"),
"@brief Inserts a box with properties into the shapes list\n"
"@args box, property_id\n"
"@return A reference to the new shape (a \\Shape object)\n"
"The property Id must be obtained from the \\Layout object's property_id method which "
"associates a property set with a property Id."
@ -1004,9 +991,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("insert|#insert_path_with_properties", &insert_with_properties<db::Path>,
gsi::method_ext ("insert|#insert_path_with_properties", &insert_with_properties<db::Path>, gsi::arg ("path"), gsi::arg ("property_id"),
"@brief Inserts a path with properties into the shapes list\n"
"@args path, property_id\n"
"@return A reference to the new shape (a \\Shape object)\n"
"The property Id must be obtained from the \\Layout object's property_id method which "
"associates a property set with a property Id."
@ -1053,9 +1039,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.26."
) +
gsi::method_ext ("insert|#insert_text_with_properties", &insert_with_properties<db::Text>,
gsi::method_ext ("insert|#insert_text_with_properties", &insert_with_properties<db::Text>, gsi::arg ("text"), gsi::arg ("property_id"),
"@brief Inserts a text with properties into the shapes list\n"
"@args text, property_id\n"
"@return A reference to the new shape (a \\Shape object)\n"
"The property Id must be obtained from the \\Layout object's property_id method which "
"associates a property set with a property Id."
@ -1070,9 +1055,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("insert|#insert_simple_polygon_with_properties", &insert_with_properties<db::SimplePolygon>,
gsi::method_ext ("insert|#insert_simple_polygon_with_properties", &insert_with_properties<db::SimplePolygon>, gsi::arg ("simple_polygon"), gsi::arg ("property_id"),
"@brief Inserts a simple polygon with properties into the shapes list\n"
"@args simple_polygon, property_id\n"
"@return A reference to the new shape (a \\Shape object)\n"
"The property Id must be obtained from the \\Layout object's property_id method which "
"associates a property set with a property Id."
@ -1087,9 +1071,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::method_ext ("insert|#insert_polygon_with_properties", &insert_with_properties<db::Polygon>,
gsi::method_ext ("insert|#insert_polygon_with_properties", &insert_with_properties<db::Polygon>, gsi::arg ("polygon"), gsi::arg ("property_id"),
"@brief Inserts a polygon with properties into the shapes list\n"
"@args polygon, property_id\n"
"@return A reference to the new shape (a \\Shape object)\n"
"The property Id must be obtained from the \\Layout object's property_id method which "
"associates a property set with a property Id."
@ -1104,9 +1087,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This variant has been introduced in version 0.25."
) +
gsi::iterator_ext ("each", &begin,
gsi::iterator_ext ("each", &begin, gsi::arg ("flags"),
"@brief Gets all shapes\n"
"@args flags\n"
"\n"
"@param flags An \"or\"-ed combination of the S... constants\n"
) +
@ -1115,9 +1097,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This call is equivalent to each(SAll). This convenience method has been introduced in version 0.16\n"
) +
gsi::iterator_ext ("each_touching", &begin_touching,
gsi::iterator_ext ("each_touching", &begin_touching, gsi::arg ("flags"), gsi::arg ("region"),
"@brief Gets all shapes that touch the search box (region)\n"
"@args flags,region\n"
"This method was introduced in version 0.16\n"
"\n"
"@param flags An \"or\"-ed combination of the S... constants\n"
@ -1130,9 +1111,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This method was introduced in version 0.25\n"
) +
gsi::iterator_ext ("each_touching", &begin_touching_all,
gsi::iterator_ext ("each_touching", &begin_touching_all, gsi::arg ("region"),
"@brief Gets all shapes that touch the search box (region)\n"
"@args region\n"
"@param region The rectangular search region\n"
"\n"
"This call is equivalent to each_touching(SAll,region). This convenience method has been introduced in version 0.16\n"
@ -1144,9 +1124,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This method was introduced in version 0.25\n"
) +
gsi::iterator_ext ("each_overlapping", &begin_overlapping,
gsi::iterator_ext ("each_overlapping", &begin_overlapping, gsi::arg ("flags"), gsi::arg ("region"),
"@brief Gets all shapes that overlap the search box (region)\n"
"@args flags,region\n"
"This method was introduced in version 0.16\n"
"\n"
"@param flags An \"or\"-ed combination of the S... constants\n"
@ -1159,9 +1138,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This method was introduced in version 0.25\n"
) +
gsi::iterator_ext ("each_overlapping", &begin_overlapping_all,
gsi::iterator_ext ("each_overlapping", &begin_overlapping_all, gsi::arg ("region"),
"@brief Gets all shapes that overlap the search box (region)\n"
"@args region\n"
"@param region The rectangular search region\n"
"\n"
"This call is equivalent to each_overlapping(SAll,region). This convenience method has been introduced in version 0.16\n"
@ -1173,24 +1151,21 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"\n"
"This method was introduced in version 0.25\n"
) +
gsi::method ("erase", &db::Shapes::erase_shape,
gsi::method ("erase", &db::Shapes::erase_shape, gsi::arg ("shape"),
"@brief Erases the shape pointed to by the given \\Shape object\n"
"@args shape\n"
"This method has been introduced in version 0.16. It can only be used in editable mode.\n"
"Erasing a shape will invalidate the shape reference. Access to this reference may then render invalid results.\n"
"\n"
"@param shape The shape which to destroy"
) +
gsi::method ("find", (db::Shape (db::Shapes::*)(const db::Shape &) const) &db::Shapes::find,
gsi::method ("find", (db::Shape (db::Shapes::*)(const db::Shape &) const) &db::Shapes::find, gsi::arg ("shape"),
"@brief Finds a shape inside this collected\n"
"@args shape\n"
"This method has been introduced in version 0.21.\n"
"This method tries to find the given shape in this collection. The original shape may be located in another collection. "
"If the shape is found, this method returns a reference to the shape in this collection, otherwise a null reference is returned."
) +
gsi::method ("is_valid?", &db::Shapes::is_valid,
gsi::method ("is_valid?", &db::Shapes::is_valid, gsi::arg ("shape"),
"@brief Tests if the given \\Shape object is still pointing to a valid object\n"
"@args shape\n"
"This method has been introduced in version 0.16.\n"
"If the shape represented by the given reference has been deleted, this method returns false. "
"If however, another shape has been inserted already that occupies the original shape's position, "
@ -1209,9 +1184,8 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
"This method was introduced in version 0.16\n"
"@return The number of shapes in this container\n"
) +
gsi::method ("replace_prop_id", (db::Shape (db::Shapes::*) (const db::Shape &, db::properties_id_type)) &db::Shapes::replace_prop_id,
gsi::method ("replace_prop_id", (db::Shape (db::Shapes::*) (const db::Shape &, db::properties_id_type)) &db::Shapes::replace_prop_id, gsi::arg ("shape"), gsi::arg ("property_id"),
"@brief Replaces (or install) the properties of a shape\n"
"@args shape,property_id\n"
"@return A \\Shape object representing the new shape\n"
"This method has been introduced in version 0.16. It can only be used in editable mode.\n"
"Changes the properties Id of the given shape or install a properties Id on that shape if it does not have one yet.\n"
@ -1263,4 +1237,3 @@ Class<db::Shapes> decl_Shapes ("db", "Shapes",
);
}

70
src/db/db/gsiDeclDbText.cc
View File

@ -156,43 +156,38 @@ struct text_defs
"\n"
"Creates a text with unit transformation and empty text."
) +
constructor ("new", &new_st,
constructor ("new", &new_st, gsi::arg ("string"), gsi::arg ("trans"),
"@brief Constructor with string and transformation\n"
"\n"
"@args string, trans\n"
"\n"
"A string and a transformation is provided to this constructor. The transformation "
"specifies the location and orientation of the text object."
) +
constructor ("new", &new_sxy,
constructor ("new", &new_sxy, gsi::arg ("string"), gsi::arg ("x"), gsi::arg ("y"),
"@brief Constructor with string and location\n"
"\n"
"@args string, x, y\n"
"\n"
"A string and a location is provided to this constructor. The location "
"is specifies as a pair of x and y coordinates.\n"
"\n"
"This method has been introduced in version 0.23."
) +
constructor ("new", &new_sthf,
constructor ("new", &new_sthf, gsi::arg ("string"), gsi::arg ("trans"), gsi::arg ("height"), gsi::arg ("font"),
"@brief Constructor with string, transformation, text height and font\n"
"\n"
"@args string, trans, height, font\n"
"\n"
"A string and a transformation is provided to this constructor. The transformation "
"specifies the location and orientation of the text object. In addition, the text height "
"and font can be specified."
) +
method ("string=", (void (C::*) (const std::string &)) &C::string,
method ("string=", (void (C::*) (const std::string &)) &C::string, gsi::arg ("text"),
"@brief Assign a text string to this object\n"
"@args text\n"
) +
method ("string", (const char *(C::*) () const) &C::string,
"@brief Get the text string\n"
) +
method_ext ("x=", set_x,
method_ext ("x=", set_x, gsi::arg ("x"),
"@brief Sets the x location of the text\n"
"@args x\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
@ -201,9 +196,8 @@ struct text_defs
"\n"
"This method has been introduced in version 0.23.\n"
) +
method_ext ("y=", set_y,
method_ext ("y=", set_y, gsi::arg ("y"),
"@brief Sets the y location of the text\n"
"@args y\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
@ -212,30 +206,26 @@ struct text_defs
"\n"
"This method has been introduced in version 0.23.\n"
) +
method ("trans=", (void (C::*) (const simple_trans_type &)) &C::trans,
method ("trans=", (void (C::*) (const simple_trans_type &)) &C::trans, gsi::arg ("t"),
"@brief Assign a transformation (text position and orientation) to this object\n"
"@args t\n"
) +
method ("trans", (const simple_trans_type & (C::*) () const) &C::trans,
"@brief Get the transformation\n"
) +
method ("size=", (void (C::*) (coord_type)) &C::size,
method ("size=", (void (C::*) (coord_type)) &C::size, gsi::arg ("s"),
"@brief Set the text height of this object\n"
"@args s\n"
) +
method ("size", (coord_type (C::*) () const) &C::size,
"@brief Get the text height\n"
) +
method_ext ("font=", &set_font,
method_ext ("font=", &set_font, gsi::arg ("f"),
"@brief Set the font number\n"
"@args f\n"
) +
method_ext ("font", &get_font,
"@brief Get the font number\n"
) +
method_ext ("halign=", &set_halign,
method_ext ("halign=", &set_halign, gsi::arg ("a"),
"@brief Set the horizontal alignment\n"
"@args a\n"
"\n"
"This property specifies how the text is aligned relative to the anchor point. "
"Allowed values for this property are 0 (left), 1 (center) and 2 (right)."
@ -247,9 +237,8 @@ struct text_defs
"\n"
"See \\halign= for a description of this property.\n"
) +
method_ext ("valign=", &set_valign,
method_ext ("valign=", &set_valign, gsi::arg ("a"),
"@brief Set the vertical alignment\n"
"@args a\n"
"\n"
"This property specifies how the text is aligned relative to the anchor point. "
"Allowed values for this property are 0 (top), 1 (center) and 2 (bottom)."
@ -261,10 +250,9 @@ struct text_defs
"\n"
"See \\valign= for a description of this property.\n"
) +
method_ext ("move", &move,
method_ext ("move", &move, gsi::arg ("distance"),
"@brief Moves the text by a certain distance (modifies self)\n"
"\n"
"@args distance\n"
"\n"
"Moves the text by a given offset and returns the moved\n"
"text. Does not check for coordinate overflows.\n"
@ -273,10 +261,9 @@ struct text_defs
"\n"
"@return A reference to this text object\n"
) +
method_ext ("move", &move_xy,
method_ext ("move", &move_xy, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Moves the text by a certain distance (modifies self)\n"
"\n"
"@args dx, dy\n"
"\n"
"Moves the text by a given distance in x and y direction and returns the moved\n"
"text. Does not check for coordinate overflows.\n"
@ -288,10 +275,9 @@ struct text_defs
"\n"
"This method was introduced in version 0.23."
) +
method_ext ("moved", &moved,
method_ext ("moved", &moved, gsi::arg ("distance"),
"@brief Returns the text moved by a certain distance (does not modify self)\n"
"\n"
"@args distance\n"
"\n"
"Moves the text by a given offset and returns the moved\n"
"text. Does not modify *this. Does not check for coordinate\n"
@ -301,10 +287,9 @@ struct text_defs
"\n"
"@return The moved text.\n"
) +
method_ext ("moved", &moved_xy,
method_ext ("moved", &moved_xy, gsi::arg ("dx"), gsi::arg ("dy"),
"@brief Returns the text moved by a certain distance (does not modify self)\n"
"\n"
"@args dx, dy\n"
"\n"
"Moves the text by a given offset and returns the moved\n"
"text. Does not modify *this. Does not check for coordinate\n"
@ -317,39 +302,34 @@ struct text_defs
"\n"
"This method was introduced in version 0.23."
) +
method ("transformed", &C::template transformed<simple_trans_type>,
method ("transformed", &C::template transformed<simple_trans_type>, gsi::arg ("t"),
"@brief Transform the text with the given simple transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The transformation to apply\n"
"@return The transformed text\n"
) +
method ("transformed", &C::template transformed<complex_trans_type>,
method ("transformed", &C::template transformed<complex_trans_type>, gsi::arg ("t"),
"@brief Transform the text with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed text (a DText now)\n"
) +
method ("<", &C::less,
method ("<", &C::less, gsi::arg ("t"),
"@brief Less operator\n"
"@args t\n"
"@param t The object to compare against\n"
"This operator is provided to establish some, not necessarily a certain sorting order"
) +
method ("==", &C::equal,
method ("==", &C::equal, gsi::arg ("text"),
"@brief Equality\n"
"\n"
"@args text\n"
"\n"
"Return true, if this text object and the given text are equal "
) +
method ("!=", &C::not_equal,
method ("!=", &C::not_equal, gsi::arg ("text"),
"@brief Inequality\n"
"\n"
"@args text\n"
"\n"
"Return true, if this text object and the given text are not equal "
) +
@ -359,9 +339,8 @@ struct text_defs
"\n"
"This method has been introduced in version 0.25.\n"
) +
constructor ("from_s", &from_string,
constructor ("from_s", &from_string, gsi::arg ("s"),
"@brief Creates an object from a string\n"
"@args s\n"
"Creates the object from a string representation (as returned by \\to_s)\n"
"\n"
"This method has been added in version 0.23.\n"
@ -396,10 +375,9 @@ Class<db::Text> decl_Text ("db", "Text",
"\n"
"This method has been introduced in version 0.25."
) +
method ("transformed", &db::Text::transformed<db::ICplxTrans>,
method ("transformed", &db::Text::transformed<db::ICplxTrans>, gsi::arg ("t"),
"@brief Transform the text with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed text (in this case an integer coordinate object now)\n"
@ -446,10 +424,9 @@ Class<db::DText> decl_DText ("db", "DText",
"\n"
"This method has been introduced in version 0.25."
) +
method ("transformed", &db::DText::transformed<db::VCplxTrans>,
method ("transformed", &db::DText::transformed<db::VCplxTrans>, gsi::arg ("t"),
"@brief Transforms the text with the given complex transformation\n"
"\n"
"@args t\n"
"\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed text (in this case an integer coordinate text)\n"
@ -472,4 +449,3 @@ Class<db::DText> decl_DText ("db", "DText",
);
}

91
src/db/db/gsiDeclDbTilingProcessor.cc
View File

@ -172,9 +172,8 @@ gsi::Class<db::TileOutputReceiver> &dbdecl_TileOutputReceiverBase ()
}
gsi::Class<TileOutputReceiver_Impl> decl_TileOutputReceiver (decl_TileOutputReceiverBase, "db", "TileOutputReceiver",
gsi::callback ("begin", &TileOutputReceiver_Impl::begin, &TileOutputReceiver_Impl::begin_cb,
gsi::callback ("begin", &TileOutputReceiver_Impl::begin, &TileOutputReceiver_Impl::begin_cb, gsi::arg ("nx"), gsi::arg ("ny"), gsi::arg ("p0"), gsi::arg ("dx"), gsi::arg ("dy"), gsi::arg ("frame"),
"@brief Initiates the delivery\n"
"@args nx, ny, p0, dx, dy, frame\n"
"This method is called before the first tile delivers it's data.\n"
"\n"
"@param nx The number of tiles in x direction\n"
@ -191,9 +190,8 @@ gsi::Class<TileOutputReceiver_Impl> decl_TileOutputReceiver (decl_TileOutputRece
"\n"
"The frame parameter has been added in version 0.25."
) +
gsi::callback ("put", &TileOutputReceiver_Impl::put_red, &TileOutputReceiver_Impl::put_cb,
gsi::callback ("put", &TileOutputReceiver_Impl::put_red, &TileOutputReceiver_Impl::put_cb, gsi::arg ("ix"), gsi::arg ("iy"), gsi::arg ("tile"), gsi::arg ("obj"), gsi::arg ("dbu"), gsi::arg ("clip"),
"@brief Delivers data for one tile\n"
"@args ix, iy, tile, obj, dbu, clip\n"
"\n"
"When the script's \"_output\" function is called, the data will be delivered through this\n"
"method. \"obj\" is the data passed as the second argument to _output.\n"
@ -335,44 +333,39 @@ static void tp_input11 (db::TilingProcessor *proc, const std::string &name, cons
}
Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
method_ext ("input", &tp_input2,
method_ext ("input", &tp_input2, gsi::arg ("name"), gsi::arg ("iter"),
"@brief Specifies input for the tiling processor\n"
"@args name, iter\n"
"This method will establish an input channel for the processor. This version receives input from a "
"recursive shape iterator, hence from a hierarchy of shapes from a layout.\n"
"\n"
"The name specifies the variable under which the input can be used in the scripts."
) +
method_ext ("input", &tp_input3,
method_ext ("input", &tp_input3, gsi::arg ("name"), gsi::arg ("iter"), gsi::arg ("trans"),
"@brief Specifies input for the tiling processor\n"
"@args name, iter, trans\n"
"This method will establish an input channel for the processor. This version receives input from a "
"recursive shape iterator, hence from a hierarchy of shapes from a layout.\n"
"In addition, a transformation can be specified which will be applied to the shapes before they are used.\n"
"\n"
"The name specifies the variable under which the input can be used in the scripts."
) +
method_ext ("input", &tp_input4,
method_ext ("input", &tp_input4, gsi::arg ("name"), gsi::arg ("layout"), gsi::arg ("cell_index"), gsi::arg ("lp"),
"@brief Specifies input for the tiling processor\n"
"@args name, layout, cell_index, lp\n"
"This method will establish an input channel for the processor. This version receives input from a "
"layout and the hierarchy below the cell with the given cell index.\n"
"\"lp\" is a \\LayerInfo object specifying the input layer.\n"
"\n"
"The name specifies the variable under which the input can be used in the scripts."
) +
method_ext ("input", &tp_input5,
method_ext ("input", &tp_input5, gsi::arg ("name"), gsi::arg ("layout"), gsi::arg ("cell_index"), gsi::arg ("layer"),
"@brief Specifies input for the tiling processor\n"
"@args name, layout, cell_index, layer\n"
"This method will establish an input channel for the processor. This version receives input from a "
"layout and the hierarchy below the cell with the given cell index.\n"
"\"layer\" is the layer index of the input layer.\n"
"\n"
"The name specifies the variable under which the input can be used in the scripts."
) +
method_ext ("input", &tp_input6,
method_ext ("input", &tp_input6, gsi::arg ("name"), gsi::arg ("layout"), gsi::arg ("cell_index"), gsi::arg ("lp"), gsi::arg ("trans"),
"@brief Specifies input for the tiling processor\n"
"@args name, layout, cell_index, lp, trans\n"
"This method will establish an input channel for the processor. This version receives input from a "
"layout and the hierarchy below the cell with the given cell index.\n"
"\"lp\" is a \\LayerInfo object specifying the input layer.\n"
@ -380,9 +373,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"\n"
"The name specifies the variable under which the input can be used in the scripts."
) +
method_ext ("input", &tp_input7,
method_ext ("input", &tp_input7, gsi::arg ("name"), gsi::arg ("layout"), gsi::arg ("cell_index"), gsi::arg ("layer"), gsi::arg ("trans"),
"@brief Specifies input for the tiling processor\n"
"@args name, layout, cell_index, layer, trans\n"
"This method will establish an input channel for the processor. This version receives input from a "
"layout and the hierarchy below the cell with the given cell index.\n"
"\"layer\" is the layer index of the input layer.\n"
@ -390,18 +382,16 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"\n"
"The name specifies the variable under which the input can be used in the scripts."
) +
method_ext ("input", &tp_input8,
method_ext ("input", &tp_input8, gsi::arg ("name"), gsi::arg ("region"),
"@brief Specifies input for the tiling processor\n"
"@args name, region\n"
"This method will establish an input channel for the processor. This version receives input from a \\Region object. "
"Regions don't always come with a database unit, hence a database unit should be specified with the \\dbu= method if only "
"regions and edges are used as input.\n"
"\n"
"The name specifies the variable under which the input can be used in the scripts."
) +
method_ext ("input", &tp_input9,
method_ext ("input", &tp_input9, gsi::arg ("name"), gsi::arg ("region"), gsi::arg ("trans"),
"@brief Specifies input for the tiling processor\n"
"@args name, region, trans\n"
"This method will establish an input channel for the processor. This version receives input from a \\Region object. "
"Regions don't always come with a database unit, hence a database unit should be specified with the \\dbu= method if only "
"regions and edges are used as input.\n"
@ -410,18 +400,16 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"\n"
"This variant allows one to specify an additional transformation too. It has been introduced in version 0.23.2.\n"
) +
method_ext ("input", &tp_input10,
method_ext ("input", &tp_input10, gsi::arg ("name"), gsi::arg ("edges"),
"@brief Specifies input for the tiling processor\n"
"@args name, edges\n"
"This method will establish an input channel for the processor. This version receives input from an \\Edges object. "
"Edge collections don't always come with a database unit, hence a database unit should be specified with the \\dbu= method if only "
"regions and edges are used as input.\n"
"\n"
"The name specifies the variable under which the input can be used in the scripts."
) +
method_ext ("input", &tp_input11,
method_ext ("input", &tp_input11, gsi::arg ("name"), gsi::arg ("edges"), gsi::arg ("trans"),
"@brief Specifies input for the tiling processor\n"
"@args name, edges, trans\n"
"This method will establish an input channel for the processor. This version receives input from an \\Edges object. "
"Edge collections don't always come with a database unit, hence a database unit should be specified with the \\dbu= method if only "
"regions and edges are used as input.\n"
@ -431,15 +419,13 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"This variant allows one to specify an additional transformation too. It has been introduced in version 0.23.2.\n"
"\n"
) +
method ("var", &db::TilingProcessor::var,
method ("var", &db::TilingProcessor::var, gsi::arg ("name"), gsi::arg ("value"),
"@brief Defines a variable for the tiling processor script\n"
"@args name, value\n"
"\n"
"The name specifies the variable under which the value can be used in the scripts."
) +
method_ext ("output", &tp_output,
method_ext ("output", &tp_output, gsi::arg ("name"), gsi::arg ("rec"),
"@brief Specifies output for the tiling processor\n"
"@args name, rec\n"
"This method will establish an output channel for the processor. For that it registers an output receiver "
"which will receive data from the scripts. The scripts call the _output function to deliver data.\n"
"\"name\" will be name of the variable which must be passed to the first argument of the _output function "
@ -474,9 +460,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"tp.execute(\"Job description\")\n"
"@/code\n"
) +
method_ext ("output", &tp_output_layout1,
method_ext ("output", &tp_output_layout1, gsi::arg ("name"), gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("lp"),
"@brief Specifies output to a layout layer\n"
"@args name, layout, cell, lp\n"
"This method will establish an output channel to a layer in a layout. The output sent to that channel "
"will be put into the specified layer and cell. In this version, the layer is specified through a \\LayerInfo "
"object, i.e. layer and datatype number. If no such layer exists, it will be created.\n"
@ -489,9 +474,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"@param cell The index of the cell to which the data is sent\n"
"@param lp The layer specification where the output will be sent to\n"
) +
method_ext ("output", &tp_output_layout2,
method_ext ("output", &tp_output_layout2, gsi::arg ("name"), gsi::arg ("layout"), gsi::arg ("cell"), gsi::arg ("layer_index"),
"@brief Specifies output to a layout layer\n"
"@args name, layout, cell, layer_index\n"
"This method will establish an output channel to a layer in a layout. The output sent to that channel "
"will be put into the specified layer and cell. In this version, the layer is specified through a layer index, "
"hence it must be created before.\n"
@ -504,9 +488,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"@param cell The index of the cell to which the data is sent\n"
"@param layer_index The layer index where the output will be sent to\n"
) +
method_ext ("output", &tp_output_region,
method_ext ("output", &tp_output_region, gsi::arg ("name"), gsi::arg ("region"),
"@brief Specifies output to a \\Region object\n"
"@args name, region\n"
"This method will establish an output channel to a \\Region object. The output sent to that channel "
"will be put into the specified region.\n"
"\n"
@ -517,9 +500,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"@param name The name of the channel\n"
"@param region The \\Region object to which the data is sent\n"
) +
method_ext ("output", &tp_output_edges,
method_ext ("output", &tp_output_edges, gsi::arg ("name"), gsi::arg ("edges"),
"@brief Specifies output to an \\Edges object\n"
"@args name, edges\n"
"This method will establish an output channel to an \\Edges object. The output sent to that channel "
"will be put into the specified edge collection.\n"
"'Solid' objects such as polygons will be converted to edges by resolving their hulls into edges. "
@ -531,9 +513,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"@param name The name of the channel\n"
"@param edges The \\Edges object to which the data is sent\n"
) +
method_ext ("output", &tp_output_edge_pairs,
method_ext ("output", &tp_output_edge_pairs, gsi::arg ("name"), gsi::arg ("edge_pairs"),
"@brief Specifies output to an \\EdgePairs object\n"
"@args name, edge_pairs\n"
"This method will establish an output channel to an \\EdgePairs object. The output sent to that channel "
"will be put into the specified edge pair collection.\n"
"Only \\EdgePair objects are accepted. Other objects are discarded.\n"
@ -544,9 +525,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"@param name The name of the channel\n"
"@param edge_pairs The \\EdgePairs object to which the data is sent\n"
) +
method_ext ("output", &tp_output_double,
method_ext ("output", &tp_output_double, gsi::arg ("name"), gsi::arg ("sum"),
"@brief Specifies output to single value\n"
"@args name, sum\n"
"This method will establish an output channel which sums up float data delivered by calling the _output function.\n"
"In order to specify the target for the data, a \\Value object must be provided for the \"sum\" parameter.\n"
"\n"
@ -558,9 +538,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"\n"
"This method has been introduced in version 0.23.2."
) +
method ("scale_to_dbu=", &db::TilingProcessor::set_scale_to_dbu,
method ("scale_to_dbu=", &db::TilingProcessor::set_scale_to_dbu, gsi::arg ("en"),
"@brief Enables or disabled automatic scaling to database unit\n"
"@args en\n"
"\n"
"If automatic scaling to database unit is enabled, the input is automatically scaled to the "
"database unit set inside the tile processor. This is the default.\n"
@ -570,16 +549,14 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
method ("dbu", &db::TilingProcessor::dbu,
"@brief Gets the database unit under which the computations will be done\n"
) +
method ("dbu=", &db::TilingProcessor::set_dbu,
method ("dbu=", &db::TilingProcessor::set_dbu, gsi::arg ("u"),
"@brief Sets the database unit under which the computations will be done\n"
"@args u\n"
"\n"
"All data used within the scripts will be brought to that database unit. If none is given "
"it will be the database unit of the first layout given or 1nm if no layout is specified.\n"
) +
method ("frame=", &db::TilingProcessor::set_frame,
method ("frame=", &db::TilingProcessor::set_frame, gsi::arg ("frame"),
"@brief Sets the layout frame\n"
"@args frame\n"
"\n"
"The layout frame is the box (in micron units) taken into account for computing\n"
"the tiles if the tile counts are not given. If the layout frame is not set or\n"
@ -588,26 +565,23 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"\n"
"This method has been introduced in version 0.25."
) +
method ("tile_size", &db::TilingProcessor::tile_size,
method ("tile_size", &db::TilingProcessor::tile_size, gsi::arg ("w"), gsi::arg ("h"),
"@brief Sets the tile size\n"
"@args w, h\n"
"\n"
"Specifies the size of the tiles to be used. If no tile size is specified, tiling won't be used "
"and all computations will be done on the whole layout.\n"
"\n"
"The tile size is given in micron.\n"
) +
method ("tiles", &db::TilingProcessor::tiles,
method ("tiles", &db::TilingProcessor::tiles, gsi::arg ("nw"), gsi::arg ("nh"),
"@brief Sets the tile count\n"
"@args nw, nh\n"
"\n"
"Specifies the number of tiles to be used. If no tile number is specified, the number of tiles "
"required is computed from the layout's dimensions and the tile size. If a number is given, but "
"no tile size, the tile size will be computed from the layout's dimensions.\n"
) +
method ("tile_origin", &db::TilingProcessor::tile_origin,
method ("tile_origin", &db::TilingProcessor::tile_origin, gsi::arg ("xo"), gsi::arg ("yo"),
"@brief Sets the tile origin\n"
"@args xo, yo\n"
"\n"
"Specifies the origin (lower left corner) of the tile field. If no origin is specified, the "
"tiles are centered to the layout's bounding box. Giving the origin together with the "
@ -615,9 +589,8 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"\n"
"The tile origin is given in micron.\n"
) +
method ("tile_border", &db::TilingProcessor::tile_border,
method ("tile_border", &db::TilingProcessor::tile_border, gsi::arg ("bx"), gsi::arg ("by"),
"@brief Sets the tile border\n"
"@args bx, by\n"
"\n"
"Specifies the tile border. The border is a margin that is considered when fetching shapes. "
"By specifying a border you can fetch shapes into the tile's data which are outside the "
@ -625,24 +598,21 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
"\n"
"The tile border is given in micron.\n"
) +
method ("threads=", &db::TilingProcessor::set_threads,
method ("threads=", &db::TilingProcessor::set_threads, gsi::arg ("n"),
"@brief Specifies the number of threads to use\n"
"@args n\n"
) +
method ("threads", &db::TilingProcessor::threads,
"@brief Gets the number of threads to use\n"
) +
method ("queue", &db::TilingProcessor::queue,
method ("queue", &db::TilingProcessor::queue, gsi::arg ("script"),
"@brief Queues a script for parallel execution\n"
"@args script\n"
"\n"
"With this method, scripts are registered that are executed in parallel on each tile.\n"
"The scripts have \"Expressions\" syntax and can make use of several predefined variables and functions.\n"
"See the \\TilingProcessor class description for details.\n"
) +
method ("execute", &db::TilingProcessor::execute,
method ("execute", &db::TilingProcessor::execute, gsi::arg ("desc"),
"@brief Runs the job\n"
"@args desc\n"
"\n"
"This method will initiate execution of the queued scripts, once for every tile. The desc is a text "
"shown in the progress bar for example.\n"
@ -729,4 +699,3 @@ Class<db::TilingProcessor> decl_TilingProcessor ("db", "TilingProcessor",
);
}

20
src/db/db/gsiDeclDbTrans.cc
View File

@ -923,7 +923,6 @@ struct cplx_trans_defs
) +
method ("mag=", (void (C::*) (double)) &C::mag, arg ("m"),
"@brief Sets the magnification\n"
"@args m\n"
"@param m The new magnification"
) +
method ("R0", &trans_r0,
@ -1028,9 +1027,8 @@ Class<db::DCplxTrans> decl_DCplxTrans ("db", "DCplxTrans",
"\n"
"This method has been introduced in version 0.25."
) +
method ("*", (db::CplxTrans (db::DCplxTrans::*) (const db::CplxTrans &) const) &db::DCplxTrans::concat,
method ("*", (db::CplxTrans (db::DCplxTrans::*) (const db::CplxTrans &) const) &db::DCplxTrans::concat, gsi::arg ("t"),
"@brief Multiplication (concatenation) of transformations\n"
"@args t\n"
"\n"
"The * operator returns self*t (\"t is applied before this transformation\").\n"
"\n"
@ -1108,18 +1106,16 @@ Class<db::CplxTrans> decl_CplxTrans ("db", "CplxTrans",
"\n"
"This method has been introduced in version 0.25."
) +
method ("*", (db::DCplxTrans (db::CplxTrans::*) (const db::VCplxTrans &) const) &db::CplxTrans::concat,
method ("*", (db::DCplxTrans (db::CplxTrans::*) (const db::VCplxTrans &) const) &db::CplxTrans::concat, gsi::arg ("t"),
"@brief Multiplication (concatenation) of transformations\n"
"@args t\n"
"\n"
"The * operator returns self*t (\"t is applied before this transformation\").\n"
"\n"
"@param t The transformation to apply before\n"
"@return The modified transformation\n"
) +
method ("*", (db::CplxTrans (db::CplxTrans::*) (const db::ICplxTrans &) const) &db::CplxTrans::concat,
method ("*", (db::CplxTrans (db::CplxTrans::*) (const db::ICplxTrans &) const) &db::CplxTrans::concat, gsi::arg ("t"),
"@brief Multiplication (concatenation) of transformations\n"
"@args t\n"
"\n"
"The * operator returns self*t (\"t is applied before this transformation\").\n"
"\n"
@ -1200,9 +1196,8 @@ Class<db::ICplxTrans> decl_ICplxTrans ("db", "ICplxTrans",
"\n"
"This method has been introduced in version 0.25."
) +
method ("*", (db::VCplxTrans (db::ICplxTrans::*) (const db::VCplxTrans &) const) &db::ICplxTrans::concat,
method ("*", (db::VCplxTrans (db::ICplxTrans::*) (const db::VCplxTrans &) const) &db::ICplxTrans::concat, gsi::arg ("t"),
"@brief Multiplication (concatenation) of transformations\n"
"@args t\n"
"\n"
"The * operator returns self*t (\"t is applied before this transformation\").\n"
"\n"
@ -1273,18 +1268,16 @@ Class<db::VCplxTrans> decl_VCplxTrans ("db", "VCplxTrans",
"\n"
"This method has been introduced in version 0.25."
) +
method ("*", (db::VCplxTrans (db::VCplxTrans::*) (const db::DCplxTrans &) const) &db::VCplxTrans::concat,
method ("*", (db::VCplxTrans (db::VCplxTrans::*) (const db::DCplxTrans &) const) &db::VCplxTrans::concat, gsi::arg ("t"),
"@brief Multiplication (concatenation) of transformations\n"
"@args t\n"
"\n"
"The * operator returns self*t (\"t is applied before this transformation\").\n"
"\n"
"@param t The transformation to apply before\n"
"@return The modified transformation\n"
) +
method ("*", (db::ICplxTrans (db::VCplxTrans::*) (const db::CplxTrans &) const) &db::VCplxTrans::concat,
method ("*", (db::ICplxTrans (db::VCplxTrans::*) (const db::CplxTrans &) const) &db::VCplxTrans::concat, gsi::arg ("t"),
"@brief Multiplication (concatenation) of transformations\n"
"@args t\n"
"\n"
"The * operator returns self*t (\"t is applied before this transformation\").\n"
"\n"
@ -1329,4 +1322,3 @@ Class<db::VCplxTrans> decl_VCplxTrans ("db", "VCplxTrans",
);
}

59
src/db/db/gsiDeclDbVector.cc
View File

@ -128,16 +128,14 @@ struct vector_defs
constructor ("new", &new_v,
"@brief Default constructor: creates a null vector with coordinates (0,0)"
) +
constructor ("new", &new_point,
constructor ("new", &new_point, gsi::arg ("p"),
"@brief Default constructor: creates a vector from a point\n"
"@args p\n"
"This constructor is equivalent to computing p-point(0,0).\n"
"This method has been introduced in version 0.25."
) +
constructor ("new", &new_xy,
constructor ("new", &new_xy, gsi::arg ("x"), gsi::arg ("y"),
"@brief Constructor for a vector from two coordinate values\n"
"\n"
"@args x, y\n"
) +
method_ext ("to_p", &to_point,
"@brief Turns the vector into a point\n"
@ -148,48 +146,41 @@ struct vector_defs
method_ext ("-@", &negate,
"@brief Compute the negative of a vector\n"
"\n"
"@args p\n"
"\n"
"Returns a new vector with -x,-y.\n"
) +
method ("+", (C (C::*) (const C &) const) &C::add,
method ("+", (C (C::*) (const C &) const) &C::add, gsi::arg ("v"),
"@brief Adds two vectors\n"
"\n"
"@args v\n"
"\n"
"Adds vector v to self by adding the coordinates.\n"
) +
method_ext ("+", &add_with_point,
method_ext ("+", &add_with_point, gsi::arg ("p"),
"@brief Adds a vector and a point\n"
"\n"
"@args p\n"
"\n"
"Returns the point p shifted by the vector.\n"
) +
method ("-", (C (C::*) (const C &) const) &C::subtract,
method ("-", (C (C::*) (const C &) const) &C::subtract, gsi::arg ("v"),
"@brief Subtract two vectors\n"
"\n"
"@args v\n"
"\n"
"Subtract vector v from self by subtracting the coordinates.\n"
) +
method ("<", &C::less,
method ("<", &C::less, gsi::arg ("v"),
"@brief \"less\" comparison operator\n"
"\n"
"@args v\n"
"\n"
"This operator is provided to establish a sorting\n"
"order\n"
) +
method ("==", &C::equal,
method ("==", &C::equal, gsi::arg ("v"),
"@brief Equality test operator\n"
"\n"
"@args v\n"
) +
method ("!=", &C::not_equal,
method ("!=", &C::not_equal, gsi::arg ("v"),
"@brief Inequality test operator\n"
"\n"
"@args v\n"
) +
method_ext ("hash", &hash_value,
"@brief Computes a hash value\n"
@ -203,71 +194,61 @@ struct vector_defs
method ("y", &C::y,
"@brief Accessor to the y coordinate\n"
) +
method ("x=", &C::set_x,
method ("x=", &C::set_x, gsi::arg ("coord"),
"@brief Write accessor to the x coordinate\n"
"@args coord\n"
) +
method ("y=", &C::set_y,
method ("y=", &C::set_y, gsi::arg ("coord"),
"@brief Write accessor to the y coordinate\n"
"@args coord\n"
) +
method_ext ("*", &scale,
method_ext ("*", &scale, gsi::arg ("f"),
"@brief Scaling by some factor\n"
"\n"
"@args f\n"
"\n"
"Returns the scaled object. All coordinates are multiplied with the given factor and if "
"necessary rounded."
) +
method_ext ("*=", &iscale,
method_ext ("*=", &iscale, gsi::arg ("f"),
"@brief Scaling by some factor\n"
"\n"
"@args f\n"
"\n"
"Scales object in place. All coordinates are multiplied with the given factor and if "
"necessary rounded."
) +
method_ext ("/", &divide,
method_ext ("/", &divide, gsi::arg ("d"),
"@brief Division by some divisor\n"
"\n"
"@args d\n"
"\n"
"Returns the scaled object. All coordinates are divided with the given divisor and if "
"necessary rounded."
) +
method_ext ("/=", &idiv,
method_ext ("/=", &idiv, gsi::arg ("d"),
"@brief Division by some divisor\n"
"\n"
"@args d\n"
"\n"
"Divides the object in place. All coordinates are divided with the given divisor and if "
"necessary rounded."
) +
method_ext ("vprod", &vprod,
method_ext ("vprod", &vprod, gsi::arg ("v"),
"@brief Computes the vector product between self and the given vector\n"
"\n"
"@args v\n"
"\n"
"The vector product of a and b is defined as: vp = ax*by-ay*bx.\n"
) +
method_ext ("vprod_sign", &vprod_sign,
method_ext ("vprod_sign", &vprod_sign, gsi::arg ("v"),
"@brief Computes the vector product between self and the given vector and returns a value indicating the sign of the product\n"
"\n"
"@args v\n"
"\n"
"@return 1 if the vector product is positive, 0 if it is zero and -1 if it is negative.\n"
) +
method_ext ("sprod", &sprod,
method_ext ("sprod", &sprod, gsi::arg ("v"),
"@brief Computes the scalar product between self and the given vector\n"
"\n"
"@args v\n"
"\n"
"The scalar product of a and b is defined as: vp = ax*bx+ay*by.\n"
) +
method_ext ("sprod_sign", &sprod_sign,
method_ext ("sprod_sign", &sprod_sign, gsi::arg ("v"),
"@brief Computes the scalar product between self and the given vector and returns a value indicating the sign of the product\n"
"\n"
"@args v\n"
"\n"
"@return 1 if the scalar product is positive, 0 if it is zero and -1 if it is negative.\n"
) +
@ -279,9 +260,8 @@ struct vector_defs
"@brief The square length of the vector\n"
"'sq_abs' is an alias provided for compatibility with the former point type."
) +
constructor ("from_s", &from_string,
constructor ("from_s", &from_string, gsi::arg ("s"),
"@brief Creates an object from a string\n"
"@args s\n"
"Creates the object from a string representation (as returned by \\to_s)\n"
) +
method ("to_s", (std::string (C::*) () const) &C::to_string,
@ -362,4 +342,3 @@ Class<db::Vector> decl_Vector ("db", "Vector",
);
}

3
src/gsi/gsi/gsiClassBase.cc
View File

@ -376,12 +376,13 @@ static SpecialMethod *
sm_assign (const char *name, const gsi::ClassBase *cls)
{
SpecialMethod *sm = new SpecialMethod (name,
tl::to_string (tr ("@brief Assigns another object to self\n@args other")),
tl::to_string (tr ("@brief Assigns another object to self")),
false, // non-const
false, // non-static
MethodBase::Assign);
gsi::ArgType a;
a.init<void> (new gsi::ArgSpecBase ("other"));
a.set_is_cref (true);
a.set_type (gsi::T_object);
a.set_cls (cls);

7
src/gsi/gsi/gsiDeclBasic.cc
View File

@ -45,17 +45,15 @@ Class<Value> decl_Value ("tl", "Value",
gsi::constructor ("new", &new_vv0,
"@brief Constructs a nil object.\n"
) +
gsi::constructor ("new", &new_vv,
gsi::constructor ("new", &new_vv, gsi::arg ("value"),
"@brief Constructs a non-nil object with the given value.\n"
"@args value\n"
"This constructor has been introduced in version 0.22.\n"
) +
gsi::method ("to_s", &Value::to_string,
"@brief Convert this object to a string\n"
) +
gsi::method ("value=", &Value::set_value,
gsi::method ("value=", &Value::set_value, gsi::arg ("value"),
"@brief Set the actual value.\n"
"@args value\n"
) +
gsi::method ("value", (const tl::Variant &(Value::*)() const) &Value::value,
"@brief Gets the actual value.\n"
@ -69,4 +67,3 @@ Class<Value> decl_Value ("tl", "Value",
);
}

112
src/img/img/gsiDeclImg.cc
View File

@ -137,9 +137,8 @@ gsi::Class<img::DataMapping> decl_ImageDataMapping ("lay", "ImageDataMapping",
gsi::method_ext ("clear_colormap", &gsi::clear_colormap,
"@brief The the color map of this data mapping object."
) +
gsi::method_ext ("add_colormap_entry", &gsi::add_colormap,
gsi::method_ext ("add_colormap_entry", &gsi::add_colormap, gsi::arg ("value"), gsi::arg ("color"),
"@brief Add a colormap entry for this data mapping object.\n"
"@args value, color\n"
"@param value The value at which the given color should be applied.\n"
"@param color The color to apply (a 32 bit RGB value).\n"
"\n"
@ -152,21 +151,18 @@ gsi::Class<img::DataMapping> decl_ImageDataMapping ("lay", "ImageDataMapping",
"@brief Returns the current number of color map entries.\n"
"@return The number of entries.\n"
) +
gsi::method_ext ("colormap_color", &gsi::colormap_color,
gsi::method_ext ("colormap_color", &gsi::colormap_color, gsi::arg ("n"),
"@brief Returns the color for a given color map entry.\n"
"@args n\n"
"@param n The index of the entry (0..\\num_colormap_entries-1)\n"
"@return The color (see \\add_colormap_entry for a description).\n"
) +
gsi::method_ext ("colormap_value", &gsi::colormap_value,
gsi::method_ext ("colormap_value", &gsi::colormap_value, gsi::arg ("n"),
"@brief Returns the vlue for a given color map entry.\n"
"@args n\n"
"@param n The index of the entry (0..\\num_colormap_entries-1)\n"
"@return The value (see \\add_colormap_entry for a description).\n"
) +
gsi::method_ext ("brightness=", &gsi::set_brightness,
gsi::method_ext ("brightness=", &gsi::set_brightness, gsi::arg ("brightness"),
"@brief Set the brightness\n"
"@args brightness\n"
"See \\brightness for a description of this property.\n"
) +
gsi::method_ext ("brightness", &gsi::brightness,
@ -175,9 +171,8 @@ gsi::Class<img::DataMapping> decl_ImageDataMapping ("lay", "ImageDataMapping",
"The brightness is a double value between roughly -1.0 and 1.0. \n"
"Neutral (original) brightness is 0.0.\n"
) +
gsi::method_ext ("contrast=", &gsi::set_contrast,
gsi::method_ext ("contrast=", &gsi::set_contrast, gsi::arg ("contrast"),
"@brief Set the contrast\n"
"@args contrast\n"
"See \\contrast for a description of this property.\n"
) +
gsi::method_ext ("contrast", &gsi::contrast,
@ -186,9 +181,8 @@ gsi::Class<img::DataMapping> decl_ImageDataMapping ("lay", "ImageDataMapping",
"The contrast is a double value between roughly -1.0 and 1.0. \n"
"Neutral (original) contrast is 0.0.\n"
) +
gsi::method_ext ("gamma=", &gsi::set_gamma,
gsi::method_ext ("gamma=", &gsi::set_gamma, gsi::arg ("gamma"),
"@brief Set the gamma\n"
"@args gamma\n"
"See \\gamma for a description of this property.\n"
) +
gsi::method_ext ("gamma", &gsi::gamma,
@ -198,9 +192,8 @@ gsi::Class<img::DataMapping> decl_ImageDataMapping ("lay", "ImageDataMapping",
"A value for linear intensity reproduction on the screen is roughly 0.5. The exact value depends on the \n"
"monitor calibration. Values below 1.0 give a \"softer\" appearance while values above 1.0 give a \"harder\" appearance.\n"
) +
gsi::method_ext ("red_gain=", &gsi::set_red_gain,
gsi::method_ext ("red_gain=", &gsi::set_red_gain, gsi::arg ("red_gain"),
"@brief Set the red_gain\n"
"@args red_gain\n"
"See \\red_gain for a description of this property.\n"
) +
gsi::method_ext ("red_gain", &gsi::red_gain,
@ -211,9 +204,8 @@ gsi::Class<img::DataMapping> decl_ImageDataMapping ("lay", "ImageDataMapping",
"\n"
"1.0 is a neutral value. The gain should be >=0.0.\n"
) +
gsi::method_ext ("green_gain=", &gsi::set_green_gain,
gsi::method_ext ("green_gain=", &gsi::set_green_gain, gsi::arg ("green_gain"),
"@brief Set the green_gain\n"
"@args green_gain\n"
"See \\green_gain for a description of this property.\n"
) +
gsi::method_ext ("green_gain", &gsi::green_gain,
@ -224,9 +216,8 @@ gsi::Class<img::DataMapping> decl_ImageDataMapping ("lay", "ImageDataMapping",
"\n"
"1.0 is a neutral value. The gain should be >=0.0.\n"
) +
gsi::method_ext ("blue_gain=", &gsi::set_blue_gain,
gsi::method_ext ("blue_gain=", &gsi::set_blue_gain, gsi::arg ("blue_gain"),
"@brief Set the blue_gain\n"
"@args blue_gain\n"
"See \\blue_gain for a description of this property.\n"
) +
gsi::method_ext ("blue_gain", &gsi::blue_gain,
@ -489,9 +480,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"This will create an empty image without data and no particular pixel width or related.\n"
"Use the \\read_file or \\set_data methods to set image properties and pixel values.\n"
) +
gsi::constructor ("new", &gsi::new_image_f,
gsi::constructor ("new", &gsi::new_image_f, gsi::arg ("filename"),
"@brief Constructor from a image file \n"
"@args filename\n"
"\n"
"This constructor creates an image object from a file (which can have any format supported by Qt) and \n"
"a unit transformation. The image will originally be put to position 0,0 (lower left corner) and each pixel\n"
@ -499,9 +489,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"\n"
"@param filename The path to the image file to load.\n"
) +
gsi::constructor ("new", &gsi::new_image_ft,
gsi::constructor ("new", &gsi::new_image_ft, gsi::arg ("filename"), gsi::arg ("trans"),
"@brief Constructor from a image file \n"
"@args filename, trans\n"
"\n"
"This constructor creates an image object from a file (which can have any format supported by Qt) and \n"
"a transformation. The image will originally be put to position 0,0 (lower left corner) and each pixel\n"
@ -510,9 +499,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"@param filename The path to the image file to load.\n"
"@param trans The transformation to apply to the image when displaying it.\n"
) +
gsi::constructor ("new", &gsi::new_image_whd,
gsi::constructor ("new", &gsi::new_image_whd, gsi::arg ("w"), gsi::arg ("h"), gsi::arg ("data"),
"@brief Constructor for a monochrome image with the given pixel values\n"
"@args w, h, data\n"
"\n"
"This constructor creates an image from the given pixel values. The values have to be organized\n"
"line by line. Each line must consist of \"w\" values where the first value is the leftmost pixel.\n"
@ -525,9 +513,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"@param h The height of the image\n"
"@param d The data (see method description)\n"
) +
gsi::constructor ("new", &gsi::new_image_whtd,
gsi::constructor ("new", &gsi::new_image_whtd, gsi::arg ("w"), gsi::arg ("h"), gsi::arg ("trans"), gsi::arg ("data"),
"@brief Constructor for a monochrome image with the given pixel values\n"
"@args w, h, trans, data\n"
"\n"
"This constructor creates an image from the given pixel values. The values have to be organized\n"
"line by line. Each line must consist of \"w\" values where the first value is the leftmost pixel.\n"
@ -542,9 +529,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"@param d The data (see method description)\n"
) +
/* HINT: these declarations cannot be used currently since any array is case to the boolean color parameter
gsi::constructor ("new", &img::new_image_whc,
gsi::constructor ("new", &img::new_image_whc, gsi::arg ("w"), gsi::arg ("h"), gsi::arg ("color"),
"@brief Constructor for monochrome or color images with zero pixel values\n"
"@args w, h, color\n"
"\n"
"This constructor creates an image object from a data set describing one monochrome channel\n"
"or three color channels.\n"
@ -558,9 +544,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"@param h The height of the image\n"
"@param color True to create a color image.\n"
) +
gsi::constructor ("new", &img::new_image_whtc,
gsi::constructor ("new", &img::new_image_whtc, gsi::arg ("w"), gsi::arg ("h"), gsi::arg ("trans"), gsi::arg ("color"),
"@brief Constructor for monochrome or color images with zero pixel values\n"
"@args w, h, trans, color\n"
"\n"
"This constructor creates an image object from a data set describing one monochrome channel\n"
"or three color channels.\n"
@ -576,9 +561,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"@param color True to create a color image.\n"
) +
*/
gsi::constructor ("new", &gsi::new_image_whrgb,
gsi::constructor ("new", &gsi::new_image_whrgb, gsi::arg ("w"), gsi::arg ("h"), gsi::arg ("red"), gsi::arg ("green"), gsi::arg ("blue"),
"@brief Constructor for a color image with the given pixel values\n"
"@args w, h, red, green, blue\n"
"\n"
"This constructor creates an image from the given pixel values. The values have to be organized\n"
"line by line and separated by color channel. Each line must consist of \"w\" values where the first value is the leftmost pixel.\n"
@ -593,9 +577,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"@param green The green channel data set which will become owned by the image\n"
"@param blue The blue channel data set which will become owned by the image\n"
) +
gsi::constructor ("new", &gsi::new_image_whtrgb,
gsi::constructor ("new", &gsi::new_image_whtrgb, gsi::arg ("w"), gsi::arg ("h"), gsi::arg ("trans"), gsi::arg ("red"), gsi::arg ("green"), gsi::arg ("blue"),
"@brief Constructor for a color image with the given pixel values\n"
"@args w, h, trans, red, green, blue\n"
"\n"
"This constructor creates an image from the given pixel values. The values have to be organized\n"
"line by line and separated by color channel. Each line must consist of \"w\" values where the first value is the leftmost pixel.\n"
@ -615,22 +598,19 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"@brief Gets the bounding box of the image\n"
"@return The bounding box\n"
) +
gsi::method ("transformed", &ImageRef::transformed<db::DTrans>,
gsi::method ("transformed", &ImageRef::transformed<db::DTrans>, gsi::arg ("t"),
"@brief Transforms the image with the given simple transformation\n"
"@args t\n"
"@param t The transformation to apply\n"
"@return The transformed object\n"
) +
gsi::method ("transformed|#transformed_matrix", &ImageRef::transformed<db::Matrix3d>,
gsi::method ("transformed|#transformed_matrix", &ImageRef::transformed<db::Matrix3d>, gsi::arg ("t"),
"@brief Transforms the image with the given matrix transformation\n"
"@args t\n"
"@param t The transformation to apply (a matrix)\n"
"@return The transformed object\n"
"This method has been introduced in version 0.22."
) +
gsi::method ("transformed|#transformed_cplx", &ImageRef::transformed<db::DCplxTrans>,
gsi::method ("transformed|#transformed_cplx", &ImageRef::transformed<db::DCplxTrans>, gsi::arg ("t"),
"@brief Transforms the image with the given complex transformation\n"
"@args t\n"
"@param t The magnifying transformation to apply\n"
"@return The transformed object\n"
) +
@ -654,9 +634,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"@brief Returns true, if the image is a color image\n"
"@return True, if the image is a color image\n"
) +
gsi::method ("set_mask", &ImageRef::set_mask,
gsi::method ("set_mask", &ImageRef::set_mask, gsi::arg ("x"), gsi::arg ("y"), gsi::arg ("m"),
"@brief Sets the mask for a pixel\n"
"@args x, y, m\n"
"\n"
"@param x The x coordinate of the pixel (0..width()-1)\n"
"@param y The y coordinate of the pixel (mathematical order: 0 is the lowest, 0..height()-1)\n"
@ -666,9 +645,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("mask", (bool (ImageRef::*) (size_t x, size_t y) const) &ImageRef::mask,
gsi::method ("mask", (bool (ImageRef::*) (size_t x, size_t y) const) &ImageRef::mask, gsi::arg ("x"), gsi::arg ("y"),
"@brief Gets the mask for one pixel\n"
"@args x, y\n"
"\n"
"@param x The x coordinate of the pixel (0..width()-1)\n"
"@param y The y coordinate of the pixel (mathematical order: 0 is the lowest, 0..height()-1)\n"
@ -678,9 +656,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("set_pixel", (void (ImageRef::*)(size_t x, size_t y, double v)) &ImageRef::set_pixel,
gsi::method ("set_pixel", (void (ImageRef::*)(size_t x, size_t y, double v)) &ImageRef::set_pixel, gsi::arg ("x"), gsi::arg ("y"), gsi::arg ("v"),
"@brief Sets one pixel (monochrome)\n"
"@args x, y, v\n"
"\n"
"@param x The x coordinate of the pixel (0..width()-1)\n"
"@param y The y coordinate of the pixel (mathematical order: 0 is the lowest, 0..height()-1)\n"
@ -689,9 +666,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"If the component index, x or y value exceeds the image bounds of the image is a color image,\n"
"this method does nothing.\n"
) +
gsi::method ("set_pixel", (void (ImageRef::*)(size_t x, size_t y, double r, double g, double b)) &ImageRef::set_pixel,
gsi::method ("set_pixel", (void (ImageRef::*)(size_t x, size_t y, double r, double g, double b)) &ImageRef::set_pixel, gsi::arg ("x"), gsi::arg ("y"), gsi::arg ("r"), gsi::arg ("g"), gsi::arg ("b"),
"@brief Sets one pixel (color)\n"
"@args x, y, r, g, b\n"
"\n"
"@param x The x coordinate of the pixel (0..width()-1)\n"
"@param y The y coordinate of the pixel (mathematical order: 0 is the lowest, 0..height()-1)\n"
@ -702,9 +678,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"If the component index, x or y value exceeds the image bounds of the image is not a color image,\n"
"this method does nothing.\n"
) +
gsi::method ("get_pixel", (double (ImageRef::*)(size_t x, size_t y) const) &ImageRef::pixel,
gsi::method ("get_pixel", (double (ImageRef::*)(size_t x, size_t y) const) &ImageRef::pixel, gsi::arg ("x"), gsi::arg ("y"),
"@brief Gets one pixel (monochrome only)\n"
"@args x, y\n"
"\n"
"@param x The x coordinate of the pixel (0..width()-1)\n"
"@param y The y coordinate of the pixel (mathematical order: 0 is the lowest, 0..height()-1)\n"
@ -713,9 +688,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"returns 0.0. This method is valid for monochrome images only. For color images it will return 0.0 always.\n"
"Use \\is_color? to decide whether the image is a color image or monochrome one.\n"
) +
gsi::method ("get_pixel", (double (ImageRef::*)(size_t x, size_t y, unsigned int component) const) &ImageRef::pixel,
gsi::method ("get_pixel", (double (ImageRef::*)(size_t x, size_t y, unsigned int component) const) &ImageRef::pixel, gsi::arg ("x"), gsi::arg ("y"), gsi::arg ("component"),
"@brief Gets one pixel (monochrome and color)\n"
"@args x, y, component\n"
"\n"
"@param x The x coordinate of the pixel (0..width()-1)\n"
"@param y The y coordinate of the pixel (mathematical order: 0 is the lowest, 0..height()-1)\n"
@ -724,18 +698,16 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"If the component index, x or y value exceeds the image bounds, this method \n"
"returns 0.0. For monochrome images, the component index is ignored.\n"
) +
gsi::method ("set_data", (void (ImageRef::*)(size_t w, size_t h, const std::vector<double> &d)) &ImageRef::set_data,
gsi::method ("set_data", (void (ImageRef::*)(size_t w, size_t h, const std::vector<double> &d)) &ImageRef::set_data, gsi::arg ("w"), gsi::arg ("h"), gsi::arg ("d"),
"@brief Writes the image data field (monochrome)\n"
"@args w, h, d\n"
"@param w The width of the new data\n"
"@param h The height of the new data\n"
"@param d The (monochrome) data to load into the image\n"
"\n"
"See the constructor description for the data organisation in that field.\n"
) +
gsi::method ("set_data", (void (ImageRef::*)(size_t w, size_t h, const std::vector<double> &r, const std::vector<double> &g, const std::vector<double> &b)) &img::Object::set_data,
gsi::method ("set_data", (void (ImageRef::*)(size_t w, size_t h, const std::vector<double> &r, const std::vector<double> &g, const std::vector<double> &b)) &img::Object::set_data, gsi::arg ("w"), gsi::arg ("h"), gsi::arg ("r"), gsi::arg ("g"), gsi::arg ("b"),
"@brief Writes the image data field (color)\n"
"@args w, h, r, g, b\n"
"@param w The width of the new data\n"
"@param h The height of the new data\n"
"@param r The red channel data to load into the image\n"
@ -765,9 +737,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"\n"
"This method has been introduced in version 0.27.\n"
) +
gsi::method_ext ("pixel_width=", &img_set_pixel_width,
gsi::method_ext ("pixel_width=", &img_set_pixel_width, gsi::arg ("w"),
"@brief Sets the pixel width\n"
"@args w\n"
"\n"
"The pixel width determines the width of on pixel in the original space which is transformed to\n"
"micron space with the transformation.\n"
@ -783,9 +754,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"Starting with version 0.22, this property is incorporated into the transformation matrix.\n"
"This property is provided for convenience only."
) +
gsi::method_ext ("pixel_height=", &img_set_pixel_height,
gsi::method_ext ("pixel_height=", &img_set_pixel_height, gsi::arg ("h"),
"@brief Sets the pixel height\n"
"@args h\n"
"\n"
"The pixel height determines the height of on pixel in the original space which is transformed to\n"
"micron space with the transformation.\n"
@ -815,9 +785,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"\n"
"This method was introduced in version 0.25."
) +
gsi::method ("matrix=", &ImageRef::set_matrix,
gsi::method ("matrix=", &ImageRef::set_matrix, gsi::arg ("t"),
"@brief Sets the transformation matrix\n"
"@args t\n"
"\n"
"This transformation matrix converts pixel coordinates (0,0 being the center and each pixel having the dimension of pixel_width and pixel_height)\n"
"to micron coordinates. The coordinate of the pixel is the lower left corner of the pixel.\n"
@ -850,9 +819,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"Please note that for backward compatibility, the rotation center is pixel 0,0 (lowest left one), while it "
"is the image center for the matrix transformation."
) +
gsi::method_ext ("trans=", &img_set_trans,
gsi::method_ext ("trans=", &img_set_trans, gsi::arg ("t"),
"@brief Sets the transformation\n"
"@args t\n"
"\n"
"This transformation converts pixel coordinates (0,0 being the lower left corner and each pixel having the dimension of pixel_width and pixel_height)\n"
"to micron coordinates. The coordinate of the pixel is the lower left corner of the pixel.\n"
@ -862,9 +830,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"Please note that for backward compatibility, the rotation center is pixel 0,0 (lowest left one), while it "
"is the image center for the matrix transformation."
) +
gsi::method ("min_value=", &ImageRef::set_min_value,
gsi::method ("min_value=", &ImageRef::set_min_value, gsi::arg ("v"),
"@brief Sets the minimum value\n"
"@args v\n"
"\n"
"See \\min_value for the description of the minimum value property.\n"
) +
@ -875,9 +842,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"It does not necessarily correspond to the minimum value of the data set but it must be\n"
"larger than that.\n"
) +
gsi::method ("max_value=", &ImageRef::set_max_value,
gsi::method ("max_value=", &ImageRef::set_max_value, gsi::arg ("v"),
"@brief Gets the upper limit of the values in the data set\n"
"@args v\n"
"\n"
"This value determines the upper end of the data mapping (i.e. white value etc.).\n"
"It does not necessarily correspond to the maximum value of the data set but it must be\n"
@ -888,9 +854,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"\n"
"See the \\max_value method for the description of the maximum value property.\n"
) +
gsi::method ("visible=", &ImageRef::set_visible,
gsi::method ("visible=", &ImageRef::set_visible, gsi::arg ("v"),
"@brief Sets the visibility\n"
"@args v\n"
"\n"
"See the \\is_visible? method for a description of this property.\n"
"\n"
@ -911,9 +876,8 @@ gsi::Class<ImageRef> decl_Image (decl_BasicImage, "lay", "Image",
"On initialization, a unique Id is given to the object. The Id cannot be changed. "
"This behaviour has been modified in version 0.20."
) +
gsi::method ("data_mapping=", &ImageRef::set_data_mapping,
gsi::method ("data_mapping=", &ImageRef::set_data_mapping, gsi::arg ("data_mapping"),
"@brief Sets the data mapping object\n"
"@args data_mapping\n"
"\n"
"The data mapping describes the transformation of a pixel value (any double value) into pixel data "
"which can be sent to the graphics cards for display. See \\ImageDataMapping for a more detailed description.\n"
@ -1335,9 +1299,8 @@ static void tp_output_image (db::TilingProcessor *proc, const std::string &name,
// extend the db::TilingProcessor with the ability to feed images
static
gsi::ClassExt<db::TilingProcessor> tiling_processor_ext (
method_ext ("output", &tp_output_image,
method_ext ("output", &tp_output_image, gsi::arg ("name"), gsi::arg ("image"),
"@brief Specifies output to an image\n"
"@args name, image\n"
"This method will establish an output channel which delivers float data to image data. "
"The image is a monochrome image where each pixel corresponds to a single tile. This "
"method for example is useful to collect densitity information into an image. The "
@ -1350,4 +1313,3 @@ gsi::ClassExt<db::TilingProcessor> tiling_processor_ext (
);
}

16
src/lay/lay/gsiDeclLayApplication.cc
View File

@ -93,10 +93,9 @@ static gsi::Methods application_methods ()
// TODO: basically this method belongs to PluginRoot (aka MainWindow).
// There is separate declaration for PluginRoot which we have to synchronize
// with this method.
method<C, std::string, const std::string &> ("get_config", &C::get_config,
method<C, std::string, const std::string &> ("get_config", &C::get_config, gsi::arg ("name"),
"@brief Gets the value for a configuration parameter\n"
"\n"
"@args name\n"
"@param name The name of the configuration parameter whose value shall be obtained (a string)\n"
"\n"
"@return The value of the parameter\n"
@ -123,10 +122,9 @@ static gsi::Methods application_methods ()
// TODO: basically this method belongs to PluginRoot (aka MainWindow).
// There is separate declaration for PluginRoot which we have to synchronize
// with this method.
method<C, const std::string &, const std::string &> ("set_config", &C::set_config,
method<C, const std::string &, const std::string &> ("set_config", &C::set_config, gsi::arg ("name"), gsi::arg ("value"),
"@brief Sets a configuration parameter with the given name to the given value\n"
"\n"
"@args name, value\n"
"@param name The name of the configuration parameter to set\n"
"@param value The value to which to set the configuration parameter\n"
"\n"
@ -153,9 +151,8 @@ static gsi::Methods application_methods ()
// TODO: basically this method belongs to PluginRoot (aka MainWindow).
// There is separate declaration for PluginRoot which we have to synchronize
// with this method.
method<C, bool, const std::string &> ("write_config", &C::write_config,
method<C, bool, const std::string &> ("write_config", &C::write_config, gsi::arg ("file_name"),
"@brief Writes configuration to a file\n"
"@args file_name\n"
"@return A value indicating whether the operation was successful\n"
"\n"
"If the configuration file cannot be written, \n"
@ -164,9 +161,8 @@ static gsi::Methods application_methods ()
// TODO: basically this method belongs to PluginRoot (aka MainWindow).
// There is separate declaration for PluginRoot which we have to synchronize
// with this method.
method<C, bool, const std::string &> ("read_config", &C::read_config,
method<C, bool, const std::string &> ("read_config", &C::read_config, gsi::arg ("file_name"),
"@brief Reads the configuration from a file\n"
"@args file_name\n"
"@return A value indicating whether the operation was successful\n"
"\n"
"This method siletly does nothing, if the config file does not\n"
@ -208,8 +204,7 @@ static gsi::Methods application_methods ()
"\n"
"This method has been added in version 0.22."
) +
method<C, int> ("exit", &C::exit,
"@args result\n"
method<C, int> ("exit", &C::exit, gsi::arg ("result"),
"@brief Ends the application with the given exit status\n"
"\n"
"This method should be called instead of simply shutting down the process. It performs some "
@ -286,4 +281,3 @@ LAY_PUBLIC make_application_decl (bool non_gui_mode)
}
}

13
src/lay/lay/gsiDeclLayHelpDialog.cc
View File

@ -60,15 +60,13 @@ lay::HelpDialog *new_help_dialog_with_parent (QWidget *parent, bool modal)
}
Class<lay::HelpDialog> decl_HelpDialog (QT_EXTERNAL_BASE (QDialog) "lay", "HelpDialog",
method ("new", new_help_dialog,
method ("new", new_help_dialog, gsi::arg ("modal"),
"@brief Creates a new help dialog\n"
"@args modal\n"
"If the modal flag is true, the dialog will be shown as a modal window.\n"
) +
#if defined(HAVE_QTBINDINGS)
method ("new", new_help_dialog_with_parent,
method ("new", new_help_dialog_with_parent, gsi::arg ("parent"), gsi::arg ("modal"),
"@brief Creates a new help dialog\n"
"@args parent, modal\n"
"If the modal flag is true, the dialog will be shown as a modal window.\n"
) +
#else
@ -79,14 +77,12 @@ Class<lay::HelpDialog> decl_HelpDialog (QT_EXTERNAL_BASE (QDialog) "lay", "HelpD
"@brief Executes the dialog (shows it modally)\n"
) +
#endif
method ("search", &lay::HelpDialog::search,
method ("search", &lay::HelpDialog::search, gsi::arg ("topic"),
"@brief Issues a search on the specified topic\n"
"@args topic\n"
"This method will call the search page with the given topic.\n"
) +
method ("load", &lay::HelpDialog::load,
method ("load", &lay::HelpDialog::load, gsi::arg ("url"),
"@brief Loads the specified URL\n"
"@args url\n"
"This method will call the page with the given URL.\n"
),
@ -119,4 +115,3 @@ Class<lay::HelpSource> decl_HelpSource (laybasicdecl_BrowserSource (), "lay", "H
);
}

52
src/lay/lay/gsiDeclLayMainWindow.cc
View File

@ -66,10 +66,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"This method has been added in version 0.24."
) +
gsi::method ("message", &lay::MainWindow::message,
gsi::method ("message", &lay::MainWindow::message, gsi::arg ("message"), gsi::arg ("time"),
"@brief Displays a message in the status bar\n"
"\n"
"@args message,time\n"
"@param message The message to display\n"
"@param time The time how long to display the message in ms\n"
"\n"
@ -77,10 +76,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"This method has been added in version 0.18."
) +
gsi::method ("resize", (void (lay::MainWindow::*)(int, int)) &lay::MainWindow::resize,
gsi::method ("resize", (void (lay::MainWindow::*)(int, int)) &lay::MainWindow::resize, gsi::arg ("width"), gsi::arg ("height"),
"@brief Resizes the window\n"
"\n"
"@args width, height\n"
"@param width The new width of the window\n"
"@param height The new width of the window\n"
"\n"
@ -114,10 +112,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"This method has been added in version 0.22.\n"
) +
gsi::method ("create_layout", (lay::CellViewRef (lay::MainWindow::*) (int)) &lay::MainWindow::create_layout,
gsi::method ("create_layout", (lay::CellViewRef (lay::MainWindow::*) (int)) &lay::MainWindow::create_layout, gsi::arg ("mode"),
"@brief Creates a new, empty layout\n"
"\n"
"@args mode\n"
"@param mode An integer value of 0, 1 or 2 that determines how the layout is created\n"
"@return The cellview of the layout that was created\n"
"\n"
@ -129,10 +126,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.\n"
) +
gsi::method ("create_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, int)) &lay::MainWindow::create_layout,
gsi::method ("create_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, int)) &lay::MainWindow::create_layout, gsi::arg ("tech"), gsi::arg ("mode"),
"@brief Creates a new, empty layout with the given technology\n"
"\n"
"@args tech, mode\n"
"@param mode An integer value of 0, 1 or 2 that determines how the layout is created\n"
"@param tech The name of the technology to use for that layout.\n"
"@return The cellview of the layout that was created\n"
@ -146,10 +142,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"This version was introduced in version 0.22.\n"
"Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.\n"
) +
gsi::method ("load_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, int)) &lay::MainWindow::load_layout,
gsi::method ("load_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, int)) &lay::MainWindow::load_layout, gsi::arg ("filename"), gsi::arg ("mode"),
"@brief Loads a new layout\n"
"\n"
"@args filename, mode\n"
"@param filename The name of the file to load\n"
"@param mode An integer value of 0, 1 or 2 that determines how the file is loaded\n"
"@return The cellview into which the layout was loaded\n"
@ -163,10 +158,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.\n"
) +
gsi::method ("load_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, const std::string &, int)) &lay::MainWindow::load_layout,
gsi::method ("load_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, const std::string &, int)) &lay::MainWindow::load_layout, gsi::arg ("filename"), gsi::arg ("tech"), gsi::arg ("mode"),
"@brief Loads a new layout and associate it with the given technology\n"
"\n"
"@args filename, tech, mode\n"
"@param filename The name of the file to load\n"
"@param tech The name of the technology to use for that layout.\n"
"@param mode An integer value of 0, 1 or 2 that determines how the file is loaded\n"
@ -181,10 +175,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"This version was introduced in version 0.22.\n"
"Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.\n"
) +
gsi::method ("load_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, const db::LoadLayoutOptions &, int)) &lay::MainWindow::load_layout,
gsi::method ("load_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, const db::LoadLayoutOptions &, int)) &lay::MainWindow::load_layout, gsi::arg ("filename"), gsi::arg ("options"), gsi::arg ("mode"),
"@brief Loads a new layout with the given options\n"
"\n"
"@args filename, options, mode\n"
"@param filename The name of the file to load\n"
"@param options The reader options to use.\n"
"@param mode An integer value of 0, 1 or 2 that determines how the file is loaded\n"
@ -197,10 +190,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"This version was introduced in version 0.22.\n"
"Starting with version 0.25, this method returns a cellview object that can be modified to configure the cellview.\n"
) +
gsi::method ("load_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, const db::LoadLayoutOptions &, const std::string &, int)) &lay::MainWindow::load_layout,
gsi::method ("load_layout", (lay::CellViewRef (lay::MainWindow::*) (const std::string &, const db::LoadLayoutOptions &, const std::string &, int)) &lay::MainWindow::load_layout, gsi::arg ("filename"), gsi::arg ("options"), gsi::arg ("tech"), gsi::arg ("mode"),
"@brief Loads a new layout with the given options and associate it with the given technology\n"
"\n"
"@args filename, options, tech, mode\n"
"@param filename The name of the file to load\n"
"@param options The reader options to use.\n"
"@param tech The name of the technology to use for that layout.\n"
@ -219,10 +211,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
gsi::method ("clone_current_view", &lay::MainWindow::clone_current_view,
"@brief Clones the current view and make it current\n"
) +
gsi::method ("save_session", &lay::MainWindow::save_session,
gsi::method ("save_session", &lay::MainWindow::save_session, gsi::arg ("fn"),
"@brief Saves the session to the given file\n"
"\n"
"@args fn\n"
"@param fn The path to the session file\n"
"\n"
"The session is saved to the given session file. Any existing layout edits are not automatically saved together with "
@ -231,10 +222,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"This method was added in version 0.18."
) +
gsi::method ("restore_session", &lay::MainWindow::restore_session,
gsi::method ("restore_session", &lay::MainWindow::restore_session, gsi::arg ("fn"),
"@brief Restores a session from the given file\n"
"\n"
"@args fn\n"
"@param fn The path to the session file\n"
"\n"
"The session stored in the given session file is restored. All existing views are closed and all "
@ -242,19 +232,17 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"This method was added in version 0.18."
) +
gsi::method_ext ("#enable_edits", &enable_edits,
gsi::method_ext ("#enable_edits", &enable_edits, gsi::arg ("enable"),
"@brief Enables or disables editing\n"
"\n"
"@args enable\n"
"@param enable Enable edits if set to true\n"
"\n"
"Starting from version 0.25, this method enables/disables edits on the current view only. \n"
"Use LayoutView#enable_edits instead.\n"
) +
gsi::method ("synchronous=|#synchroneous", &lay::MainWindow::set_synchronous,
gsi::method ("synchronous=|#synchroneous", &lay::MainWindow::set_synchronous, gsi::arg ("sync_mode"),
"@brief Puts the main window into synchronous mode\n"
"\n"
"@args sync_mode\n"
"@param sync_mode 'true' if the application should behave synchronously\n"
"\n"
"In synchronous mode, an application is allowed to block on redraw. While redrawing, "
@ -292,10 +280,9 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"This method does not immediately exit the application but sends an exit request "
"to the application which will cause a clean shutdown of the GUI. "
) +
gsi::method ("current_view_index=|#select_view", &lay::MainWindow::select_view,
gsi::method ("current_view_index=|#select_view", &lay::MainWindow::select_view, gsi::arg ("index"),
"@brief Selects the view with the given index\n"
"\n"
"@args index\n"
"@param index The index of the view to select (0 is the first)\n"
"\n"
"This method will make the view with the given index the current (front) view.\n"
@ -319,9 +306,8 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"@return The number of views available so far.\n"
) +
gsi::method ("view", (lay::LayoutView *(lay::MainWindow::*)(int)) &lay::MainWindow::view,
gsi::method ("view", (lay::LayoutView *(lay::MainWindow::*)(int)) &lay::MainWindow::view, gsi::arg ("n"),
"@brief Returns a reference to a view object by index\n"
"@args n\n"
"\n"
"@return The view object's reference for the view with the given index.\n"
) +
@ -332,14 +318,13 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"This method was added in version 0.22."
) +
gsi::method ("initial_technology=", &lay::MainWindow::set_initial_technology,
gsi::method ("initial_technology=", &lay::MainWindow::set_initial_technology, gsi::arg ("tech"),
"@brief Sets the technology used for creating or loading layouts (unless explicitly specified)\n"
"\n"
"Setting the technology will have an effect on the next load_layout or create_layout operation which does not explicitly specify the technology but "
"might not be reflected correctly in the reader options dialog and changes will be reset when the "
"application is restarted."
"\n"
"@args tech\n"
"@param tech The new initial technology\n"
"\n"
"This method was added in version 0.22."
@ -352,9 +337,8 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods "
"(add_current_view_observer/remove_current_view_observer) have been removed in 0.25.\n"
) +
gsi::event ("on_view_created", &lay::MainWindow::view_created_event,
gsi::event ("on_view_created", &lay::MainWindow::view_created_event, gsi::arg ("index"),
"@brief An event indicating that a new view was created\n"
"@args index\n"
"@param index The index of the view that was created\n"
"\n"
"This event is triggered after a new view was created. For example, if a layout is loaded into a new panel.\n"
@ -362,9 +346,8 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"Before version 0.25 this event was based on the observer pattern obsolete now. The corresponding methods "
"(add_new_view_observer/remove_new_view_observer) have been removed in 0.25.\n"
) +
gsi::event ("on_view_closed", &lay::MainWindow::view_closed_event,
gsi::event ("on_view_closed", &lay::MainWindow::view_closed_event, gsi::arg ("index"),
"@brief An event indicating that a view was closed\n"
"@args index\n"
"@param index The index of the view that was closed\n"
"\n"
"This event is triggered after a view was closed. For example, because the tab was closed.\n"
@ -785,4 +768,3 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
);
}

142
src/laybasic/laybasic/gsiDeclLayDialogs.cc
View File

@ -277,25 +277,21 @@ BrowserDialog_Stub *new_browser_dialog_static_and_parent (QWidget *parent, const
#endif
Class<BrowserDialog_Stub> decl_BrowserDialog (QT_EXTERNAL_BASE (QDialog) "lay", "BrowserDialog",
gsi::constructor ("new", &new_browser_dialog_with_source,
gsi::constructor ("new", &new_browser_dialog_with_source, gsi::arg ("source"),
"@brief Creates a HTML browser window with a \\BrowserSource as the source of HTML code\n"
"@args source\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::constructor ("new", &new_browser_dialog_static,
gsi::constructor ("new", &new_browser_dialog_static, gsi::arg ("html"),
"@brief Creates a HTML browser window with a static HTML content\n"
"@args html\n"
"This method has been introduced in version 0.23.\n"
) +
#if defined(HAVE_QTBINDINGS)
gsi::constructor ("new", &new_browser_dialog_with_source_and_parent,
gsi::constructor ("new", &new_browser_dialog_with_source_and_parent, gsi::arg ("parent"), gsi::arg ("source"),
"@brief Creates a HTML browser window with a \\BrowserSource as the source of HTML code\n"
"@args parent,source\n"
"This method variant with a parent argument has been introduced in version 0.24.2.\n"
) +
gsi::constructor ("new", &new_browser_dialog_static_and_parent,
gsi::constructor ("new", &new_browser_dialog_static_and_parent, gsi::arg ("parent"), gsi::arg ("html"),
"@brief Creates a HTML browser window with a static HTML content\n"
"@args parent,html\n"
"This method variant with a parent argument has been introduced in version 0.24.2.\n"
) +
#else
@ -309,24 +305,21 @@ Class<BrowserDialog_Stub> decl_BrowserDialog (QT_EXTERNAL_BASE (QDialog) "lay",
gsi::method ("execute|#exec", &BrowserDialog_Stub::exec,
"@brief Executes the HTML browser dialog as a modal window\n"
) +
gsi::method ("load", &BrowserDialog_Stub::load,
gsi::method ("load", &BrowserDialog_Stub::load, gsi::arg ("url"),
"@brief Loads the given URL into the browser dialog\n"
"@args url\n"
"Typically the URL has the \"int:\" scheme so the HTML code is taken from the "
"\\BrowserSource object.\n"
) +
gsi::method ("label=", &BrowserDialog_Stub::set_label,
gsi::method ("label=", &BrowserDialog_Stub::set_label, gsi::arg ("label"),
"@brief Sets the label text\n"
"@args label\n"
"\n"
"The label is shown left of the navigation buttons.\n"
"By default, no label is specified.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("set_search_url", &BrowserDialog_Stub::set_search_url,
gsi::method ("set_search_url", &BrowserDialog_Stub::set_search_url, gsi::arg ("url"), gsi::arg ("query_item"),
"@brief Enables the search field and specifies the search URL generated for a search\n"
"@args url, query_item\n"
"\n"
"If a search URL is set, the search box right to the navigation bar will be enabled. "
"When a text is entered into the search box, the browser will navigate to an URL composed "
@ -334,34 +327,29 @@ Class<BrowserDialog_Stub> decl_BrowserDialog (QT_EXTERNAL_BASE (QDialog) "lay",
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method ("search", &BrowserDialog_Stub::search,
gsi::method ("search", &BrowserDialog_Stub::search, gsi::arg ("search_item"),
"@brief Issues a search request using the given search item and the search URL specified with \\set_search_url\n"
"@args search_item\n"
"\n"
"See \\set_search_url for a description of the search mechanism.\n"
) +
gsi::method_ext ("source=|#set_source", &set_source,
gsi::method_ext ("source=|#set_source", &set_source, gsi::arg ("source"),
"@brief Connects to a source object\n"
"@args source\n"
"\n"
"Setting the source should be the first thing done after the BrowserDialog object is created. It will not "
"have any effect after the browser has loaded the first page. In particular, \\home= should be called after the source "
"was set."
) +
gsi::method_ext ("resize|#set_size", &set_size,
gsi::method_ext ("resize|#set_size", &set_size, gsi::arg ("width"), gsi::arg ("height"),
"@brief Sets the size of the dialog window\n"
"@args width, height\n"
) +
gsi::method_ext ("caption=|#set_caption", &set_caption,
gsi::method_ext ("caption=|#set_caption", &set_caption, gsi::arg ("caption"),
"@brief Sets the caption of the window\n"
"@args caption\n"
) +
gsi::method ("reload", &BrowserDialog_Stub::reload,
"@brief Reloads the current page"
) +
gsi::method ("home=|#set_home", &BrowserDialog_Stub::set_home,
gsi::method ("home=|#set_home", &BrowserDialog_Stub::set_home, gsi::arg ("home_url"),
"@brief Sets the browser's initial and current URL which is selected if the \"home\" location is chosen\n"
"@args home_url\n"
"The home URL is the one shown initially and the one which is selected when the \"home\" button is pressed. "
"The default location is \"int:/index.html\".\n"
) +
@ -430,9 +418,8 @@ Class<BrowserSource_Stub> decl_BrowserSourceStub ("lay", "BrowserSource",
"\n"
"The default HTML string is sent when no specific implementation is provided.\n"
) +
gsi::callback ("get", &BrowserSource_Stub::get, &BrowserSource_Stub::get_cb,
gsi::callback ("get", &BrowserSource_Stub::get, &BrowserSource_Stub::get_cb, gsi::arg ("url"),
"@brief Get the HTML code for a given \"int\" URL.\n"
"@args url\n"
"\n"
"If this method returns an empty string, the browser will not be set to \n"
"a new location. This allows implementing any functionality behind such links.\n"
@ -463,48 +450,41 @@ lay::BrowserPanel *new_browser_panel (QWidget *parent)
}
Class<lay::BrowserPanel> decl_BrowserPanel (QT_EXTERNAL_BASE (QWidget) "lay", "BrowserPanel",
gsi::constructor ("new", &new_browser_panel_with_source,
gsi::constructor ("new", &new_browser_panel_with_source, gsi::arg ("parent"), gsi::arg ("source"),
"@brief Creates a HTML browser widget with a \\BrowserSource as the source of HTML code\n"
"@args parent, source\n"
) +
gsi::constructor ("new", &new_browser_panel,
gsi::constructor ("new", &new_browser_panel, gsi::arg ("parent"),
"@brief Creates a HTML browser widget\n"
"@args parent\n"
) +
gsi::method ("load", &lay::BrowserPanel::load,
gsi::method ("load", &lay::BrowserPanel::load, gsi::arg ("url"),
"@brief Loads the given URL into the browser widget\n"
"@args url\n"
"Typically the URL has the \"int:\" scheme so the HTML code is taken from the "
"\\BrowserSource object.\n"
) +
gsi::method ("url", &lay::BrowserPanel::url,
"@brief Gets the URL currently shown\n"
) +
gsi::method ("set_search_url", &lay::BrowserPanel::set_search_url,
gsi::method ("set_search_url", &lay::BrowserPanel::set_search_url, gsi::arg ("url"), gsi::arg ("query_item"),
"@brief Enables the search field and specifies the search URL generated for a search\n"
"@args url, query_item\n"
"\n"
"If a search URL is set, the search box right to the navigation bar will be enabled. "
"When a text is entered into the search box, the browser will navigate to an URL composed "
"of the search URL, the search item and the search text, i.e. \"myurl?item=search_text\".\n"
) +
gsi::method ("search", &lay::BrowserPanel::search,
gsi::method ("search", &lay::BrowserPanel::search, gsi::arg ("search_item"),
"@brief Issues a search request using the given search item and the search URL specified with \\set_search_url\n"
"@args search_item\n"
"\n"
"See \\search_url= for a description of the search mechanism.\n"
) +
gsi::method ("source=", &lay::BrowserPanel::set_source,
gsi::method ("source=", &lay::BrowserPanel::set_source, gsi::arg ("source"),
"@brief Connects to a source object\n"
"@args source\n"
"\n"
"Setting the source should be the first thing done after the BrowserDialog object is created. It will not "
"have any effect after the browser has loaded the first page. In particular, \\home= should be called after the source "
"was set."
) +
gsi::method ("label=", &lay::BrowserPanel::set_label,
gsi::method ("label=", &lay::BrowserPanel::set_label, gsi::arg ("label"),
"@brief Sets the label text\n"
"@args label\n"
"\n"
"The label is shown left of the navigation buttons.\n"
"By default, no label is specified.\n"
@ -512,9 +492,8 @@ Class<lay::BrowserPanel> decl_BrowserPanel (QT_EXTERNAL_BASE (QWidget) "lay", "B
gsi::method ("reload", &lay::BrowserPanel::reload,
"@brief Reloads the current page"
) +
gsi::method ("home=", &lay::BrowserPanel::set_home,
gsi::method ("home=", &lay::BrowserPanel::set_home, gsi::arg ("home_url"),
"@brief Sets the browser widget's initial and current URL which is selected if the \"home\" location is chosen\n"
"@args home_url\n"
"The home URL is the one shown initially and the one which is selected when the \"home\" button is pressed. "
"The default location is \"int:/index.html\".\n"
),
@ -711,18 +690,16 @@ static tl::Variant ask_item (const std::string &title, const std::string &label,
struct InputDialog { };
Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
gsi::method ("#get_string", &get_string,
gsi::method ("#get_string", &get_string, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting a string\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return A \\StringValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_item", &get_item,
gsi::method ("#get_item", &get_item, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("items"), gsi::arg ("value"),
"@brief Open an input dialog requesting an item from a list\n"
"@args title, label, items, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param items The list of items to show in the selection element\n"
@ -730,18 +707,16 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return A \\StringValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_string_password", &get_string_password,
gsi::method ("#get_string_password", &get_string_password, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting a string without showing the actual characters entered\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return A \\StringValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_double", &get_double,
gsi::method ("#get_double", &get_double, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("digits"),
"@brief Open an input dialog requesting a floating-point value\n"
"@args title, label, value, digits\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@ -749,9 +724,8 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return A \\DoubleValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_double_ex", &get_double_ex,
gsi::method ("#get_double_ex", &get_double_ex, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("min"), gsi::arg ("max"), gsi::arg ("digits"),
"@brief Open an input dialog requesting a floating-point value with enhanced capabilities\n"
"@args title, label, value, min, max, digits\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@ -761,18 +735,16 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return A \\DoubleValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_int", &get_int,
gsi::method ("#get_int", &get_int, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting an integer value\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return A \\IntValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("#get_int_ex", &get_int_ex,
gsi::method ("#get_int_ex", &get_int_ex, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("min"), gsi::arg ("max"), gsi::arg ("step"),
"@brief Open an input dialog requesting an integer value with enhanced capabilities\n"
"@args title, label, value, min, max, step\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@ -782,18 +754,16 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return A \\IntValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
) +
gsi::method ("ask_string", &ask_string,
gsi::method ("ask_string", &ask_string, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting a string\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return The string entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_item", &ask_item,
gsi::method ("ask_item", &ask_item, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("items"), gsi::arg ("value"),
"@brief Open an input dialog requesting an item from a list\n"
"@args title, label, items, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param items The list of items to show in the selection element\n"
@ -801,18 +771,16 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return The string of the item selected if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_string_password", &ask_string_password,
gsi::method ("ask_string_password", &ask_string_password, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting a string without showing the actual characters entered\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
"@return The string entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_double", &ask_double,
gsi::method ("ask_double", &ask_double, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("digits"),
"@brief Open an input dialog requesting a floating-point value\n"
"@args title, label, value, digits\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@ -820,9 +788,8 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return The value entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_double_ex", &ask_double_ex,
gsi::method ("ask_double_ex", &ask_double_ex, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("min"), gsi::arg ("max"), gsi::arg ("digits"),
"@brief Open an input dialog requesting a floating-point value with enhanced capabilities\n"
"@args title, label, value, min, max, digits\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@ -832,9 +799,8 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return The value entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_int", &ask_int,
gsi::method ("ask_int", &ask_int, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"),
"@brief Open an input dialog requesting an integer value\n"
"@args title, label, value\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@ -842,9 +808,8 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
"@return The value entered if \"Ok\" was pressed or nil if \"Cancel\" was pressed\n"
"This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent."
) +
gsi::method ("ask_int_ex", &ask_int_ex,
gsi::method ("ask_int_ex", &ask_int_ex, gsi::arg ("title"), gsi::arg ("label"), gsi::arg ("value"), gsi::arg ("min"), gsi::arg ("max"), gsi::arg ("step"),
"@brief Open an input dialog requesting an integer value with enhanced capabilities\n"
"@args title, label, value, min, max, step\n"
"@param title The title to display for the dialog\n"
"@param label The label text to display for the dialog\n"
"@param value The initial value for the input field\n"
@ -968,9 +933,8 @@ static tl::Variant ask_save_file_name (const std::string &title, const std::stri
}
Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
gsi::method ("#get_existing_dir", &get_existing_dir,
gsi::method ("#get_existing_dir", &get_existing_dir, gsi::arg ("title"), gsi::arg ("dir"),
"@brief Open a dialog to select a directory\n"
"@args title, dir\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@ -978,9 +942,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"Starting with version 0.23 this method is deprecated. Use \\ask_existing_dir instead.\n"
) +
gsi::method ("#get_open_file_names", &get_open_file_names,
gsi::method ("#get_open_file_names", &get_open_file_names, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one or multiple files for opening\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@ -989,9 +952,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"Starting with version 0.23 this method is deprecated. Use \\ask_open_file_names instead.\n"
) +
gsi::method ("#get_open_file_name", &get_open_file_name,
gsi::method ("#get_open_file_name", &get_open_file_name, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one file for opening\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@ -1000,9 +962,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"Starting with version 0.23 this method is deprecated. Use \\ask_open_file_name instead.\n"
) +
gsi::method ("#get_save_file_name", &get_save_file_name,
gsi::method ("#get_save_file_name", &get_save_file_name, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one file for writing\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@ -1011,9 +972,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"Starting with version 0.23 this method is deprecated. Use \\ask_save_file_name instead.\n"
) +
gsi::method ("ask_existing_dir", &ask_existing_dir,
gsi::method ("ask_existing_dir", &ask_existing_dir, gsi::arg ("title"), gsi::arg ("dir"),
"@brief Open a dialog to select a directory\n"
"@args title, dir\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@ -1021,9 +981,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent.\n"
) +
gsi::method ("ask_open_file_names", &ask_open_file_names,
gsi::method ("ask_open_file_names", &ask_open_file_names, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one or multiple files for opening\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@ -1032,9 +991,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent.\n"
) +
gsi::method ("ask_open_file_name", &ask_open_file_name,
gsi::method ("ask_open_file_name", &ask_open_file_name, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one file for opening\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@ -1043,9 +1001,8 @@ Class<FileDialog> decl_FileDialog ("lay", "FileDialog",
"\n"
"This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent.\n"
) +
gsi::method ("ask_save_file_name", &ask_save_file_name,
gsi::method ("ask_save_file_name", &ask_save_file_name, gsi::arg ("title"), gsi::arg ("dir"), gsi::arg ("filter"),
"@brief Select one file for writing\n"
"@args title, dir, filter\n"
"\n"
"@param title The title of the dialog\n"
"@param dir The directory selected initially\n"
@ -1182,33 +1139,29 @@ Class<MessageBox> decl_MessageBox (QT_EXTERNAL_BASE (QMainWindow) "lay", "Messag
gsi::method ("Abort|#b_abort", &b_abort, "@brief A constant describing the 'Abort' button") +
gsi::method ("Retry|#b_retry", &b_retry, "@brief A constant describing the 'Retry' button") +
gsi::method ("Ignore|#b_ignore", &b_ignore, "@brief A constant describing the 'Ignore' button") +
gsi::method ("warning", &warning,
gsi::method ("warning", &warning, gsi::arg ("title"), gsi::arg ("text"), gsi::arg ("buttons"),
"@brief Open a warning message box\n"
"@args title, text, buttons\n"
"@param title The title of the window\n"
"@param text The text to show\n"
"@param buttons A combination (+) of button constants (\\Ok and so on) describing the buttons to show for the message box\n"
"@return The button constant describing the button that was pressed\n"
) +
gsi::method ("question", &question,
gsi::method ("question", &question, gsi::arg ("title"), gsi::arg ("text"), gsi::arg ("buttons"),
"@brief Open a question message box\n"
"@args title, text, buttons\n"
"@param title The title of the window\n"
"@param text The text to show\n"
"@param buttons A combination (+) of button constants (\\Ok and so on) describing the buttons to show for the message box\n"
"@return The button constant describing the button that was pressed\n"
) +
gsi::method ("info", &info,
gsi::method ("info", &info, gsi::arg ("title"), gsi::arg ("text"), gsi::arg ("buttons"),
"@brief Open a information message box\n"
"@args title, text, buttons\n"
"@param title The title of the window\n"
"@param text The text to show\n"
"@param buttons A combination (+) of button constants (\\Ok and so on) describing the buttons to show for the message box\n"
"@return The button constant describing the button that was pressed\n"
) +
gsi::method ("critical", &critical,
gsi::method ("critical", &critical, gsi::arg ("title"), gsi::arg ("text"), gsi::arg ("buttons"),
"@brief Open a critical (error) message box\n"
"@args title, text, buttons\n"
"@param title The title of the window\n"
"@param text The text to show\n"
"@param buttons A combination (+) of button constants (\\Ok and so on) describing the buttons to show for the message box\n"
@ -1233,4 +1186,3 @@ Class<MessageBox> decl_MessageBox (QT_EXTERNAL_BASE (QMainWindow) "lay", "Messag
);
}

208
src/laybasic/laybasic/gsiDeclLayLayers.cc
View File

@ -421,15 +421,13 @@ static std::string source_string_1 (const lay::LayerProperties *n)
}
Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
method ("==", &lay::LayerProperties::operator==,
method ("==", &lay::LayerProperties::operator==, gsi::arg ("other"),
"@brief Equality \n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
method ("!=", &lay::LayerProperties::operator!=,
method ("!=", &lay::LayerProperties::operator!=, gsi::arg ("other"),
"@brief Inequality \n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
@ -443,9 +441,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22.\n"
) +
method ("eff_frame_color", &lay::LayerProperties::eff_frame_color,
method ("eff_frame_color", &lay::LayerProperties::eff_frame_color, gsi::arg ("real"),
"@brief Gets the effective frame color \n"
"@args real\n"
"\n"
"The effective frame color is computed from the frame color brightness and the\n"
"frame color.\n"
@ -459,9 +456,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("eff_fill_color", &lay::LayerProperties::eff_fill_color,
method ("eff_fill_color", &lay::LayerProperties::eff_fill_color, gsi::arg ("real"),
"@brief Gets the effective fill color\n"
"@args real\n"
"\n"
"The effective fill color is computed from the frame color brightness and the\n"
"frame color.\n"
@ -475,9 +471,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("frame_color", &lay::LayerProperties::frame_color,
method ("frame_color", &lay::LayerProperties::frame_color, gsi::arg ("real"),
"@brief Gets the frame color\n"
"@args real\n"
"\n"
"This method may return an invalid color if the color is not set.\n"
"\n"
@ -490,9 +485,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("frame_color=", &lay::LayerProperties::set_frame_color,
method ("frame_color=", &lay::LayerProperties::set_frame_color, gsi::arg ("color"),
"@brief Sets the frame color to the given value\n"
"@args color\n"
"\n"
"The color is a 32bit value encoding the blue value in the lower 8 bits, "
"the green value in the next 8 bits and the red value in the 8 bits above that."
@ -500,9 +494,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
method ("clear_frame_color", &lay::LayerProperties::clear_frame_color,
"@brief Resets the frame color \n"
) +
method ("has_frame_color?", &lay::LayerProperties::has_frame_color,
method ("has_frame_color?", &lay::LayerProperties::has_frame_color, gsi::arg ("real"),
"@brief True, if the frame color is set\n"
"@args real\n"
) +
method_ext ("has_frame_color?", &get_has_frame_color_1,
"@brief True, if the frame color is set\n"
@ -511,9 +504,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("fill_color", &lay::LayerProperties::fill_color,
method ("fill_color", &lay::LayerProperties::fill_color, gsi::arg ("real"),
"@brief Gets the fill color\n"
"@args real\n"
"\n"
"This method may return an invalid color if the color is not set.\n"
"\n"
@ -526,9 +518,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("fill_color=", &lay::LayerProperties::set_fill_color,
method ("fill_color=", &lay::LayerProperties::set_fill_color, gsi::arg ("color"),
"@brief Sets the fill color to the given value\n"
"@args color\n"
"\n"
"The color is a 32bit value encoding the blue value in the lower 8 bits, "
"the green value in the next 8 bits and the red value in the 8 bits above that."
@ -536,9 +527,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
method ("clear_fill_color", &lay::LayerProperties::clear_fill_color,
"@brief Resets the fill color\n"
) +
method ("has_fill_color?", &lay::LayerProperties::has_fill_color,
method ("has_fill_color?", &lay::LayerProperties::has_fill_color, gsi::arg ("real"),
"@brief True, if the fill color is set\n"
"@args real\n"
) +
method_ext ("has_fill_color?", &get_has_fill_color_1,
"@brief True, if the fill color is set\n"
@ -547,16 +537,14 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("frame_brightness=", &lay::LayerProperties::set_frame_brightness,
method ("frame_brightness=", &lay::LayerProperties::set_frame_brightness, gsi::arg ("brightness"),
"@brief Sets the frame brightness\n"
"@args brightness\n"
"\n"
"For neutral brightness set this value to 0. For darker colors set it to a negative "
"value (down to -255), for brighter colors to a positive value (up to 255)\n"
) +
method ("frame_brightness", &lay::LayerProperties::frame_brightness,
method ("frame_brightness", &lay::LayerProperties::frame_brightness, gsi::arg ("real"),
"@brief Gets the frame brightness value\n"
"@args real\n"
"\n"
"If the brightness is not set, this method may return an invalid value\n"
"\n"
@ -569,16 +557,14 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("fill_brightness=", &lay::LayerProperties::set_fill_brightness,
method ("fill_brightness=", &lay::LayerProperties::set_fill_brightness, gsi::arg ("brightness"),
"@brief Sets the fill brightness\n"
"@args brightness\n"
"\n"
"For neutral brightness set this value to 0. For darker colors set it to a negative "
"value (down to -255), for brighter colors to a positive value (up to 255)\n"
) +
method ("fill_brightness", &lay::LayerProperties::fill_brightness,
method ("fill_brightness", &lay::LayerProperties::fill_brightness, gsi::arg ("real"),
"@brief Gets the fill brightness value\n"
"@args real\n"
"\n"
"If the brightness is not set, this method may return an invalid value\n"
"\n"
@ -591,18 +577,16 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("dither_pattern=", &lay::LayerProperties::set_dither_pattern,
method ("dither_pattern=", &lay::LayerProperties::set_dither_pattern, gsi::arg ("index"),
"@brief Sets the dither pattern index\n"
"@args index"
"\n"
"The dither pattern index must be one of the valid indices.\n"
"The first indices are reserved for built-in pattern, the following ones are custom pattern.\n"
"Index 0 is always solid filled and 1 is always the hollow filled pattern.\n"
"For custom pattern see \\LayoutView#add_stipple.\n"
) +
method ("eff_dither_pattern", &lay::LayerProperties::eff_dither_pattern,
method ("eff_dither_pattern", &lay::LayerProperties::eff_dither_pattern, gsi::arg ("real"),
"@brief Gets the effective dither pattern index\n"
"@args real\n"
"\n"
"The effective dither pattern index is always a valid index, even if no dither pattern "
"is set."
@ -616,9 +600,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("dither_pattern", &lay::LayerProperties::dither_pattern,
method ("dither_pattern", &lay::LayerProperties::dither_pattern, gsi::arg ("real"),
"@brief Gets the dither pattern index\n"
"@args real\n"
"\n"
"This method may deliver an invalid dither pattern index if it is not set.\n"
"\n"
@ -634,9 +617,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
method ("clear_dither_pattern", &lay::LayerProperties::clear_dither_pattern,
"@brief Clears the dither pattern\n"
) +
method ("has_dither_pattern?", &lay::LayerProperties::has_dither_pattern,
method ("has_dither_pattern?", &lay::LayerProperties::has_dither_pattern, gsi::arg ("real"),
"@brief True, if the dither pattern is set\n"
"@args real\n"
) +
method_ext ("has_dither_pattern?", &get_has_dither_pattern_1,
"@brief True, if the dither pattern is set\n"
@ -705,13 +687,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.25."
) +
method ("valid=", &lay::LayerProperties::set_valid,
method ("valid=", &lay::LayerProperties::set_valid, gsi::arg ("valid"),
"@brief Sets the validity state\n"
"@args valid"
) +
method ("valid?", &lay::LayerProperties::valid,
method ("valid?", &lay::LayerProperties::valid, gsi::arg ("real"),
"@brief Gets the validity state\n"
"@args real\n"
) +
method_ext ("valid?", &get_valid_1,
"@brief Gets the validity state\n"
@ -720,13 +700,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.23."
) +
method ("visible=", &lay::LayerProperties::set_visible,
method ("visible=", &lay::LayerProperties::set_visible, gsi::arg ("visible"),
"@brief Sets the visibility state\n"
"@args visible"
) +
method ("visible?", &lay::LayerProperties::visible,
method ("visible?", &lay::LayerProperties::visible, gsi::arg ("real"),
"@brief Gets the visibility state\n"
"@args real\n"
) +
method_ext ("visible?", &get_visible_1,
"@brief Gets the visibility state\n"
@ -735,13 +713,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("transparent=", &lay::LayerProperties::set_transparent,
method ("transparent=", &lay::LayerProperties::set_transparent, gsi::arg ("transparent"),
"@brief Sets the transparency state\n"
"@args transparent"
) +
method ("transparent?", &lay::LayerProperties::transparent,
method ("transparent?", &lay::LayerProperties::transparent, gsi::arg ("real"),
"@brief Gets the transparency state\n"
"@args real\n"
) +
method_ext ("transparent?", &get_transparent_1,
"@brief Gets the transparency state\n"
@ -750,13 +726,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("width=", &lay::LayerProperties::set_width,
method ("width=", &lay::LayerProperties::set_width, gsi::arg ("width"),
"@brief Sets the line width to the given width\n"
"@args width"
) +
method ("width", &lay::LayerProperties::width,
method ("width", &lay::LayerProperties::width, gsi::arg ("real"),
"@brief Gets the line width\n"
"@args real\n"
) +
method_ext ("width", &get_width_1,
"@brief Gets the line width\n"
@ -765,13 +739,11 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("marked=", &lay::LayerProperties::set_marked,
method ("marked=", &lay::LayerProperties::set_marked, gsi::arg ("marked"),
"@brief Sets the marked state\n"
"@args marked"
) +
method ("marked?", &lay::LayerProperties::marked,
method ("marked?", &lay::LayerProperties::marked, gsi::arg ("real"),
"@brief Gets the marked state\n"
"@args real\n"
) +
method_ext ("marked?", &get_marked_1,
"@brief Gets the marked state\n"
@ -780,15 +752,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("xfill=", &lay::LayerProperties::set_xfill,
method ("xfill=", &lay::LayerProperties::set_xfill, gsi::arg ("xfill"),
"@brief Sets a value indicating whether shapes are drawn with a cross\n"
"@args xfill\n"
"\n"
"This attribute has been introduced in version 0.25.\n"
) +
method ("xfill?", &lay::LayerProperties::xfill,
method ("xfill?", &lay::LayerProperties::xfill, gsi::arg ("real"),
"@brief Gets a value indicating whether shapes are drawn with a cross\n"
"@args real\n"
"\n"
"This attribute has been introduced in version 0.25.\n"
) +
@ -799,15 +769,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This attribute has been introduced in version 0.25.\n"
) +
method ("animation=", &lay::LayerProperties::set_animation,
method ("animation=", &lay::LayerProperties::set_animation, gsi::arg ("animation"),
"@brief Sets the animation state\n"
"@args animation\n"
"\n"
"See the description of the \\animation method for details about the animation state"
) +
method ("animation", &lay::LayerProperties::animation,
method ("animation", &lay::LayerProperties::animation, gsi::arg ("real"),
"@brief Gets the animation state\n"
"@args real\n"
"\n"
"The animation state is an integer either being 0 (static), 1 (scrolling), 2 (blinking) "
"or 3 (inversely blinking)"
@ -819,16 +787,14 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("name=", &lay::LayerProperties::set_name,
method ("name=", &lay::LayerProperties::set_name, gsi::arg ("name"),
"@brief Sets the name to the given string\n"
"@args name\n"
) +
method ("name", &lay::LayerProperties::name,
"@brief Gets the name\n"
) +
method_ext ("trans", &get_trans,
method_ext ("trans", &get_trans, gsi::arg ("real"),
"@brief Gets the transformations that the layer is transformed with\n"
"@args real\n"
"\n"
"The transformations returned by this accessor is the one used for displaying this layer. "
"The layout is transformed with each of these transformations before it is drawn.\n\n"
@ -841,15 +807,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("trans=", &set_trans,
method_ext ("trans=", &set_trans, gsi::arg ("trans_vector"),
"@brief Sets the transformations that the layer is transformed with\n"
"@args trans_vector\n"
"\n"
"See \\trans for a description of the transformations."
) +
method_ext ("source_cellview", &get_cellview,
method_ext ("source_cellview", &get_cellview, gsi::arg ("real"),
"@brief Gets the cellview index that this layer refers to\n"
"@args real\n"
"\n"
"If \"real\" is true, the effective value is returned."
) +
@ -860,15 +824,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_cellview=", &set_cellview,
method_ext ("source_cellview=", &set_cellview, gsi::arg ("cellview_index"),
"@brief Sets the cellview index that this layer refers to\n"
"@args cellview_index\n"
"\n"
"See \\cellview for a description of the transformations."
) +
method_ext ("source_layer_index", &get_layer_index,
method_ext ("source_layer_index", &get_layer_index, gsi::arg ("real"),
"@brief Gets the layer index that the shapes are taken from\n"
"@args real\n"
"\n"
"If the layer index is positive, the shapes drawn are taken from this layer rather than "
"searched for by layer and datatype. This property is stronger than the layer/datatype or "
@ -885,15 +847,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_layer_index=", &set_layer_index,
method_ext ("source_layer_index=", &set_layer_index, gsi::arg ("index"),
"@brief Sets the layer index specification that the shapes are taken from\n"
"@args index\n"
"\n"
"See \\source_layer_index for a description of this property."
) +
method_ext ("source_layer", &get_layer,
method_ext ("source_layer", &get_layer, gsi::arg ("real"),
"@brief Gets the stream layer that the shapes are taken from\n"
"@args real\n"
"\n"
"If the layer is positive, the actual layer is looked up by this stream layer. If a name or "
"layer index is specified, the stream layer is not used.\n\n"
@ -906,15 +866,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_layer=", &set_layer,
method_ext ("source_layer=", &set_layer, gsi::arg ("layer"),
"@brief Sets the stream layer that the shapes are taken from\n"
"@args layer\n"
"\n"
"See \\source_layer for a description of this property"
) +
method_ext ("source_datatype", &get_datatype,
method_ext ("source_datatype", &get_datatype, gsi::arg ("real"),
"@brief Gets the stream datatype that the shapes are taken from\n"
"@args real\n"
"\n"
"If the datatype is positive, the actual layer is looked up by this stream datatype. If a name or "
"layer index is specified, the stream datatype is not used.\n\n"
@ -927,18 +885,16 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_datatype=", &set_datatype,
method_ext ("source_datatype=", &set_datatype, gsi::arg ("datatype"),
"@brief Sets the stream datatype that the shapes are taken from\n"
"@args datatype\n"
"\n"
"See \\datatype for a description of this property"
) +
method_ext ("clear_source_name", &clear_name,
"@brief Removes any stream layer name specification from this layer\n"
) +
method_ext ("source_name", &get_name,
method_ext ("source_name", &get_name, gsi::arg ("real"),
"@brief Gets the stream name that the shapes are taken from\n"
"@args real\n"
"\n"
"If the name is non-empty, the actual layer is looked up by this stream layer name. If a "
"layer index (see \\layer_index) is specified, the stream datatype is not used.\n"
@ -952,9 +908,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("has_source_name?", &has_name,
method_ext ("has_source_name?", &has_name, gsi::arg ("real"),
"@brief Gets a value indicating whether a stream layer name is specified for this layer\n"
"@args real\n"
"\n"
"If \"real\" is true, the effective value is returned."
) +
@ -965,15 +920,13 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("source_name=", &set_name,
method_ext ("source_name=", &set_name, gsi::arg ("name"),
"@brief Sets the stream layer name that the shapes are taken from\n"
"@args name\n"
"\n"
"See \\name for a description of this property"
) +
method_ext ("upper_hier_level", &get_upper_hier_level,
method_ext ("upper_hier_level", &get_upper_hier_level, gsi::arg ("real"),
"@brief Gets the upper hierarchy level shown\n"
"@args real\n"
"\n"
"This is the hierarchy level at which the drawing starts. "
"This property is only meaningful, if \\has_upper_hier_level is true. "
@ -988,9 +941,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("upper_hier_level_relative?|#upper_hier_level_relative", &get_upper_hier_level_relative,
method_ext ("upper_hier_level_relative?|#upper_hier_level_relative", &get_upper_hier_level_relative, gsi::arg ("real"),
"@brief Gets a value indicating whether if the upper hierarchy level is relative.\n"
"@args real\n"
"\n"
"See \\upper_hier_level for a description of this property.\n"
"\n"
@ -1003,9 +955,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("upper_hier_level_mode", &get_upper_hier_level_mode,
method_ext ("upper_hier_level_mode", &get_upper_hier_level_mode, gsi::arg ("real"),
"@brief Gets the mode for the upper hierarchy level.\n"
"@args real\n"
"@param real If true, the computed value is returned, otherwise the local node value\n"
"\n"
"The mode value can be 0 (value is given by \\upper_hier_level), 1 for \"minimum value\" and 2 for \"maximum value\".\n"
@ -1019,34 +970,30 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("upper_hier_level=", &set_upper_hier_level1,
method_ext ("upper_hier_level=", &set_upper_hier_level1, gsi::arg ("level"),
"@brief Sets a upper hierarchy level\n"
"@args level\n"
"\n"
"If this method is called, the upper hierarchy level is enabled. "
"See \\upper_hier_level for a description of this property.\n"
) +
method_ext ("set_upper_hier_level", &set_upper_hier_level2,
method_ext ("set_upper_hier_level", &set_upper_hier_level2, gsi::arg ("level"), gsi::arg ("relative"),
"@brief Sets the upper hierarchy level and if it is relative to the context cell\n"
"@args level,relative\n"
"\n"
"If this method is called, the upper hierarchy level is enabled. "
"See \\upper_hier_level for a description of this property.\n"
"\n"
"This method has been introduced in version 0.19.\n"
) +
method_ext ("set_upper_hier_level", &set_upper_hier_level3,
method_ext ("set_upper_hier_level", &set_upper_hier_level3, gsi::arg ("level"), gsi::arg ("relative"), gsi::arg ("mode"),
"@brief Sets the upper hierarchy level, if it is relative to the context cell and the mode\n"
"@args level,relative,mode\n"
"\n"
"If this method is called, the upper hierarchy level is enabled. "
"See \\upper_hier_level for a description of this property.\n"
"\n"
"This method has been introduced in version 0.20.\n"
) +
method_ext ("has_upper_hier_level?", &get_has_upper_hier_level,
method_ext ("has_upper_hier_level?", &get_has_upper_hier_level, gsi::arg ("real"),
"@brief Gets a value indicating whether an upper hierarchy level is explicitly specified\n"
"@args real\n"
"\n"
"If \"real\" is true, the effective value is returned."
) +
@ -1062,9 +1009,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"See \\has_upper_hier_level for a description of this property"
) +
method_ext ("lower_hier_level", &get_lower_hier_level,
method_ext ("lower_hier_level", &get_lower_hier_level, gsi::arg ("real"),
"@brief Gets the lower hierarchy level shown\n"
"@args real\n"
"\n"
"This is the hierarchy level at which the drawing starts. "
"This property is only meaningful, if \\has_lower_hier_level is true. "
@ -1079,9 +1025,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("lower_hier_level_relative?|#lower_hier_level_relative", &get_lower_hier_level_relative,
method_ext ("lower_hier_level_relative?|#lower_hier_level_relative", &get_lower_hier_level_relative, gsi::arg ("real"),
"@brief Gets a value indicating whether the lower hierarchy level is relative.\n"
"@args real\n"
"\n"
"See \\lower_hier_level for a description of this property.\n"
"\n"
@ -1109,34 +1054,30 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("lower_hier_level=", &set_lower_hier_level1,
method_ext ("lower_hier_level=", &set_lower_hier_level1, gsi::arg ("level"),
"@brief Sets the lower hierarchy level\n"
"@args level\n"
"\n"
"If this method is called, the lower hierarchy level is enabled. "
"See \\lower_hier_level for a description of this property.\n"
) +
method_ext ("set_lower_hier_level", &set_lower_hier_level2,
method_ext ("set_lower_hier_level", &set_lower_hier_level2, gsi::arg ("level"), gsi::arg ("relative"),
"@brief Sets the lower hierarchy level and if it is relative to the context cell\n"
"@args level,relative\n"
"\n"
"If this method is called, the lower hierarchy level is enabled. "
"See \\lower_hier_level for a description of this property.\n"
"\n"
"This method has been introduced in version 0.19.\n"
) +
method_ext ("set_lower_hier_level", &set_lower_hier_level3,
method_ext ("set_lower_hier_level", &set_lower_hier_level3, gsi::arg ("level"), gsi::arg ("relative"), gsi::arg ("mode"),
"@brief Sets the lower hierarchy level, whether it is relative to the context cell and the mode\n"
"@args level,relative,mode\n"
"\n"
"If this method is called, the lower hierarchy level is enabled. "
"See \\lower_hier_level for a description of this property.\n"
"\n"
"This method has been introduced in version 0.20.\n"
) +
method_ext ("has_lower_hier_level?", &get_has_lower_hier_level,
method_ext ("has_lower_hier_level?", &get_has_lower_hier_level, gsi::arg ("real"),
"@brief Gets a value indicating whether a lower hierarchy level is explicitly specified\n"
"@args real\n"
"\n"
"If \"real\" is true, the effective value is returned."
) +
@ -1152,9 +1093,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"See \\has_lower_hier_level for a description of this property"
) +
method ("source", &lay::LayerProperties::source_string,
method ("source", &lay::LayerProperties::source_string, gsi::arg ("real"),
"@brief Gets the source specification \n"
"@args real\n"
"\n"
"This method delivers the source specification as a string\n"
"\n"
@ -1167,9 +1107,8 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method ("source=", (void (lay::LayerProperties::*) (const std::string &s)) &lay::LayerProperties::set_source,
method ("source=", (void (lay::LayerProperties::*) (const std::string &s)) &lay::LayerProperties::set_source, gsi::arg ("s"),
"@brief Loads the source specification from a string\n"
"@args s\n"
"\n"
"Sets the source specification to the given string. The source specification may contain "
"the cellview index, the source layer (given by layer/datatype or layer name), transformation, "
@ -1240,15 +1179,13 @@ static void clear_children (lay::LayerPropertiesNode *node)
Class<lay::LayerPropertiesNode> decl_LayerPropertiesNode (
decl_LayerProperties,
"lay", "LayerPropertiesNode",
method ("==", &lay::LayerPropertiesNode::operator==,
method ("==", &lay::LayerPropertiesNode::operator==, gsi::arg ("other"),
"@brief Equality \n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
method ("!=", &lay::LayerPropertiesNode::operator!=,
method ("!=", &lay::LayerPropertiesNode::operator!=, gsi::arg ("other"),
"@brief Inequality \n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
@ -1271,9 +1208,8 @@ Class<lay::LayerPropertiesNode> decl_LayerPropertiesNode (
"\n"
"The parameterless version of this method was introduced in version 0.25."
) +
method_ext ("add_child", &add_child,
method_ext ("add_child", &add_child, gsi::arg ("child"),
"@brief Add a child entry\n"
"@args child\n"
"@return A reference to the node created\n"
"This method allows building a layer properties tree by adding children to node objects. "
"It returns a reference to the node object created.\n"
@ -1395,24 +1331,21 @@ static lay::LayerPropertiesNodeRef current (const lay::LayerPropertiesConstItera
Class<lay::LayerPropertiesConstIterator> decl_LayerPropertiesIterator (
"lay", "LayerPropertiesIterator",
method ("!=", &lay::LayerPropertiesConstIterator::operator!=,
method ("!=", &lay::LayerPropertiesConstIterator::operator!=, gsi::arg ("other"),
"@brief Inequality\n"
"@args other\n"
"\n"
"@param other The other object to compare against"
) +
method ("==", &lay::LayerPropertiesConstIterator::operator==,
method ("==", &lay::LayerPropertiesConstIterator::operator==, gsi::arg ("other"),
"@brief Equality\n"
"@args other\n"
"\n"
"@param other The other object to compare against"
"\n"
"Returns true, if self and other point to the same layer properties node. Caution: this does "
"not imply that both layer properties nodes sit in the same tab. Just their position in the tree is compared."
) +
method ("<", &lay::LayerPropertiesConstIterator::operator<,
method ("<", &lay::LayerPropertiesConstIterator::operator<, gsi::arg ("other"),
"@brief Comparison\n"
"@args other\n"
"\n"
"@param other The other object to compare against\n"
"\n"
@ -1448,17 +1381,15 @@ Class<lay::LayerPropertiesConstIterator> decl_LayerPropertiesIterator (
"If the current element does not have a parent, the iterator will\n"
"become a null iterator.\n"
) +
method ("next_sibling", &lay::LayerPropertiesConstIterator::next_sibling,
method ("next_sibling", &lay::LayerPropertiesConstIterator::next_sibling, gsi::arg ("n"),
"@brief Move to the next sibling by a given distance\n"
"\n"
"@args n\n"
"\n"
"The iterator is moved to the nth next sibling of the current element. Use negative distances to move backward.\n"
) +
method ("to_sibling", &lay::LayerPropertiesConstIterator::to_sibling,
method ("to_sibling", &lay::LayerPropertiesConstIterator::to_sibling, gsi::arg ("n"),
"@brief Move to the sibling with the given index\n"
"\n"
"@args n\n"
"\n"
"The iterator is moved to the nth sibling by selecting the nth child in the current node's parent.\n"
) +
@ -1533,4 +1464,3 @@ Class<lay::LayerPropertiesConstIterator> decl_LayerPropertiesIterator (
}

43
src/laybasic/laybasic/gsiDeclLayMarker.cc
View File

@ -83,52 +83,45 @@ bool has_color (const lay::DMarker *marker)
}
Class<lay::DMarker> decl_Marker ("lay", "Marker",
gsi::constructor ("new", &create_marker,
gsi::constructor ("new", &create_marker, gsi::arg ("view"),
"@brief Creates a marker\n"
"@args view\n"
"\n"
"A marker is always associated with a view, in which it is shown. The "
"view this marker is associated with must be passed to the constructor."
) +
gsi::method ("set|set_box", (void (lay::DMarker::*) (const db::DBox &)) &lay::DMarker::set,
gsi::method ("set|set_box", (void (lay::DMarker::*) (const db::DBox &)) &lay::DMarker::set, gsi::arg ("box"),
"@brief Sets the box the marker is to display\n"
"@args box\n"
"\n"
"Makes the marker show a box. The box must be given in micron units.\n"
"If the box is empty, no marker is drawn.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("set|set_text", (void (lay::DMarker::*) (const db::DText &)) &lay::DMarker::set,
gsi::method ("set|set_text", (void (lay::DMarker::*) (const db::DText &)) &lay::DMarker::set, gsi::arg ("text"),
"@brief Sets the text the marker is to display\n"
"@args text\n"
"\n"
"Makes the marker show a text. The text must be given in micron units.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("set|set_edge", (void (lay::DMarker::*) (const db::DEdge &)) &lay::DMarker::set,
gsi::method ("set|set_edge", (void (lay::DMarker::*) (const db::DEdge &)) &lay::DMarker::set, gsi::arg ("edge"),
"@brief Sets the edge the marker is to display\n"
"@args edge\n"
"\n"
"Makes the marker show a edge. The edge must be given in micron units.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("set|set_path", (void (lay::DMarker::*) (const db::DPath &)) &lay::DMarker::set,
gsi::method ("set|set_path", (void (lay::DMarker::*) (const db::DPath &)) &lay::DMarker::set, gsi::arg ("path"),
"@brief Sets the path the marker is to display\n"
"@args path\n"
"\n"
"Makes the marker show a path. The path must be given in micron units.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("set|set_polygon", (void (lay::DMarker::*) (const db::DPolygon &)) &lay::DMarker::set,
gsi::method ("set|set_polygon", (void (lay::DMarker::*) (const db::DPolygon &)) &lay::DMarker::set, gsi::arg ("polygon"),
"@brief Sets the polygon the marker is to display\n"
"@args polygon\n"
"\n"
"Makes the marker show a polygon. The polygon must be given in micron units.\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method_ext ("color=", set_color,
gsi::method_ext ("color=", set_color, gsi::arg ("color"),
"@brief Sets the color of the marker\n"
"@args color\n"
"The color is a 32bit unsigned integer encoding the RGB values in the lower 3 bytes (blue in the lowest significant byte). "
"The color can be reset with \\reset_color, in which case, the default foreground color is used."
) +
@ -143,9 +136,8 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
gsi::method_ext ("has_color?", has_color,
"@brief Returns a value indicating whether the marker has a specific color\n"
) +
gsi::method_ext ("frame_color=", set_frame_color,
gsi::method_ext ("frame_color=", set_frame_color, gsi::arg ("color"),
"@brief Sets the frame color of the marker\n"
"@args color\n"
"The color is a 32bit unsigned integer encoding the RGB values in the lower 3 bytes (blue in the lowest significant byte). "
"The color can be reset with \\reset_frame_color, in which case the fill color is used.\n"
"The set method has been added in version 0.20.\n"
@ -164,9 +156,8 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
"@brief Returns a value indicating whether the marker has a specific frame color\n"
"The set method has been added in version 0.20.\n"
) +
gsi::method ("dismissable=", &lay::DMarker::set_dismissable,
gsi::method ("dismissable=", &lay::DMarker::set_dismissable, gsi::arg ("flag"),
"@brief Sets a value indicating whether the marker can be hidden\n"
"@args flag\n"
"Dismissable markers can be hidden setting \"View/Show Markers\" to \"off\". "
"The default setting is \"false\" meaning the marker can't be hidden.\n"
"\n"
@ -176,27 +167,24 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
"@brief Gets a value indicating whether the marker can be hidden\n"
"See \\dismissable= for a description of this predicate."
) +
gsi::method ("line_width=", &lay::DMarker::set_line_width,
gsi::method ("line_width=", &lay::DMarker::set_line_width, gsi::arg ("width"),
"@brief Sets the line width of the marker\n"
"@args width\n"
"This is the width of the line drawn for the outline of the marker."
) +
gsi::method ("line_width", &lay::DMarker::get_line_width,
"@brief Gets the line width of the marker\n"
"See \\line_width= for a description of the line width."
) +
gsi::method ("vertex_size=", &lay::DMarker::set_vertex_size,
gsi::method ("vertex_size=", &lay::DMarker::set_vertex_size, gsi::arg ("size"),
"@brief Sets the vertex size of the marker\n"
"@args size\n"
"This is the size of the rectangles drawn for the vertices object."
) +
gsi::method ("vertex_size", &lay::DMarker::get_vertex_size,
"@brief Gets the vertex size of the marker\n"
"See \\vertex_size= for a description."
) +
gsi::method ("halo=", &lay::DMarker::set_halo,
gsi::method ("halo=", &lay::DMarker::set_halo, gsi::arg ("halo"),
"@brief Sets the halo flag\n"
"@args halo\n"
"The halo flag is either -1 (for taking the default), 0 to disable the halo or 1 to enable it. "
"If the halo is enabled, a pixel border with the background color is drawn around the marker, the "
"vertices and texts."
@ -205,9 +193,8 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
"@brief Gets the halo flag\n"
"See \\halo= for a description of the halo flag."
) +
gsi::method ("dither_pattern=", &lay::DMarker::set_dither_pattern,
gsi::method ("dither_pattern=", &lay::DMarker::set_dither_pattern, gsi::arg ("index"),
"@brief Sets the stipple pattern index\n"
"@args index\n"
"A value of -1 or less than zero indicates that the marker is not filled. Otherwise, the "
"value indicates which pattern to use for filling the marker."
) +
@ -215,9 +202,8 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
"@brief Gets the stipple pattern index\n"
"See \\dither_pattern= for a description of the stipple pattern index."
) +
gsi::method ("line_style=", &lay::DMarker::set_line_style,
gsi::method ("line_style=", &lay::DMarker::set_line_style, gsi::arg ("index"),
"@brief Sets the line style\n"
"@args index\n"
"The line style is given by an index. 0 is solid, 1 is dashed and so forth.\n"
"\n"
"This method has been introduced in version 0.25."
@ -236,4 +222,3 @@ Class<lay::DMarker> decl_Marker ("lay", "Marker",
);
}

67
src/laybasic/laybasic/gsiDeclLayMenu.cc
View File

@ -87,46 +87,40 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
"\n"
"This method has been introduced in version 0.26."
) +
method ("action", &lay::AbstractMenu::action,
method ("action", &lay::AbstractMenu::action, gsi::arg ("path"),
"@brief Get the reference to a Action object associated with the given path\n"
"@args path\n"
"\n"
"@param path The path to the item. This must be a valid path.\n"
"@return A reference to a Action object associated with this path\n"
) +
method ("items", &lay::AbstractMenu::items,
method ("items", &lay::AbstractMenu::items, gsi::arg ("path"),
"@brief Get the subitems for a given submenu\n"
"@args path\n"
"\n"
"@param path The path to the submenu\n"
"@return A vector or path strings for the child items or an empty vector if the path is not valid or the item does not have children\n"
) +
method ("is_menu?", &lay::AbstractMenu::is_menu,
method ("is_menu?", &lay::AbstractMenu::is_menu, gsi::arg ("path"),
"@brief Query if an item is a menu\n"
"@args path\n"
"\n"
"@param path The path to the item\n"
"@return false if the path is not valid or is not a menu\n"
) +
method ("is_separator?", &lay::AbstractMenu::is_separator,
method ("is_separator?", &lay::AbstractMenu::is_separator, gsi::arg ("path"),
"@brief Query if an item is a separator\n"
"@args path\n"
"\n"
"@param path The path to the item\n"
"@return false if the path is not valid or is not a separator\n"
"\n"
"This method has been introduced in version 0.19.\n"
) +
method ("is_valid?", &lay::AbstractMenu::is_valid,
method ("is_valid?", &lay::AbstractMenu::is_valid, gsi::arg ("path"),
"@brief Query if a path is a valid one\n"
"@args path\n"
"\n"
"@param path The path to check\n"
"@return false if the path is not a valid path to an item\n"
) +
method ("insert_item", (void (lay::AbstractMenu::*) (const std::string &, const std::string &, const lay::Action &)) &lay::AbstractMenu::insert_item,
method ("insert_item", (void (lay::AbstractMenu::*) (const std::string &, const std::string &, const lay::Action &)) &lay::AbstractMenu::insert_item, gsi::arg ("path"), gsi::arg ("name"), gsi::arg ("action"),
"@brief Insert a new item before the one given by the path\n"
"@args path, name, action\n"
"\n"
"The Action object passed as the third parameter references the handler which both implements the "
"action to perform and the menu item's appearance such as title, icon and keyboard shortcut.\n"
@ -135,16 +129,14 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
"@param name The name of the item to insert \n"
"@param action The Action object to insert\n"
) +
method ("insert_separator", &lay::AbstractMenu::insert_separator,
method ("insert_separator", &lay::AbstractMenu::insert_separator, gsi::arg ("path"), gsi::arg ("name"),
"@brief Insert a new separator before the item given by the path\n"
"@args path, name\n"
"\n"
"@param path The path to the item before which to insert the separator\n"
"@param name The name of the separator to insert \n"
) +
method ("insert_menu", (void (lay::AbstractMenu::*) (const std::string &, const std::string &, const std::string &)) &lay::AbstractMenu::insert_menu,
method ("insert_menu", (void (lay::AbstractMenu::*) (const std::string &, const std::string &, const std::string &)) &lay::AbstractMenu::insert_menu, gsi::arg ("path"), gsi::arg ("name"), gsi::arg ("title"),
"@brief Insert a new submenu before the item given by the path\n"
"@args path, name, title\n"
"\n"
"The title string optionally encodes the key shortcut and icon resource\n"
"in the form <text>[\"(\"<shortcut>\")\"][\"<\"<icon-resource>\">\"].\n"
@ -153,15 +145,13 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
"@param name The name of the submenu to insert \n"
"@param title The title of the submenu to insert\n"
) +
method ("delete_item", &lay::AbstractMenu::delete_item,
method ("delete_item", &lay::AbstractMenu::delete_item, gsi::arg ("path"),
"@brief Delete the item given by the path\n"
"@args path\n"
"\n"
"@param path The path to the item to delete\n"
) +
method ("group", &lay::AbstractMenu::group,
method ("group", &lay::AbstractMenu::group, gsi::arg ("group"),
"@brief Get the group members\n"
"@args group\n"
"\n"
"@param group The group name\n"
"@param A vector of all members (by path) of the group\n"
@ -201,9 +191,8 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
);
Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
method ("title=", &lay::Action::set_title,
method ("title=", &lay::Action::set_title, gsi::arg ("title"),
"@brief Sets the title\n"
"@args title\n"
"\n"
"@param title The title string to set (just the title)\n"
) +
@ -212,9 +201,8 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
"\n"
"@return The current title string\n"
) +
method ("shortcut=", (void (lay::Action::*)(const std::string &)) &lay::Action::set_shortcut,
method ("shortcut=", (void (lay::Action::*)(const std::string &)) &lay::Action::set_shortcut, gsi::arg ("shortcut"),
"@brief Sets the keyboard shortcut\n"
"@args shortcut\n"
"If the shortcut string is empty, the default shortcut will be used. If the string "
"is equal to \\Action#NoKeyBound, no keyboard shortcut will be assigned.\n"
"\n"
@ -230,9 +218,8 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
"@brief Gets the keyboard shortcut\n"
"@return The keyboard shortcut as a string\n"
) +
method ("default_shortcut=", (void (lay::Action::*)(const std::string &)) &lay::Action::set_default_shortcut,
method ("default_shortcut=", (void (lay::Action::*)(const std::string &)) &lay::Action::set_default_shortcut, gsi::arg ("shortcut"),
"@brief Sets the default keyboard shortcut\n"
"@args shortcut\n"
"\n"
"The default shortcut is used, if \\shortcut is empty.\n"
"\n"
@ -281,55 +268,47 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
"\n"
"This attribute has been introduced in version 0.25.\n"
) +
method ("separator=", &lay::Action::set_separator,
method ("separator=", &lay::Action::set_separator, gsi::arg ("separator"),
"@brief Makes an item a separator or not\n"
"@args separator\n"
"\n"
"@param separator true to make the item a separator\n"
"This method has been introduced in version 0.25.\n"
) +
method ("checkable=", &lay::Action::set_checkable,
method ("checkable=", &lay::Action::set_checkable, gsi::arg ("checkable"),
"@brief Make the item(s) checkable or not\n"
"@args checkable\n"
"\n"
"@param checkable true to make the item checkable\n"
) +
method ("enabled=", &lay::Action::set_enabled,
method ("enabled=", &lay::Action::set_enabled, gsi::arg ("enabled"),
"@brief Enable or disable the action\n"
"@args enabled \n"
"\n"
"@param enabled true to enable the item\n"
) +
method ("visible=", &lay::Action::set_visible,
method ("visible=", &lay::Action::set_visible, gsi::arg ("visible"),
"@brief Show or hide\n"
"@args visible \n"
"\n"
"@param visible true to make the item visible\n"
) +
method ("hidden=", &lay::Action::set_hidden,
method ("hidden=", &lay::Action::set_hidden, gsi::arg ("hidden"),
"@brief Sets a value that makes the item hidden always\n"
"@args hidden\n"
"See \\is_hidden? for details.\n"
"\n"
"This attribute has been introduced in version 0.25\n"
) +
method ("checked=", &lay::Action::set_checked,
method ("checked=", &lay::Action::set_checked, gsi::arg ("checked"),
"@brief Check or uncheck\n"
"@args checked \n"
"\n"
"@param checked true to make the item checked\n"
) +
method ("icon=", &lay::Action::set_icon,
method ("icon=", &lay::Action::set_icon, gsi::arg ("file"),
"@brief Set the icon to the given picture\n"
"@args file\n"
"\n"
"@param file The image file to load for the icon\n"
"\n"
"Passing an empty string will reset the icon\n"
) +
method ("icon_text=", &lay::Action::set_icon_text,
method ("icon_text=", &lay::Action::set_icon_text, gsi::arg ("icon_text"),
"@brief Set the icon's text \n"
"@args icon_text\n"
"\n"
"If an icon text is set, this will be used for the text below the icon.\n"
"If no icon text is set, the normal text will be used for the icon.\n"
@ -338,9 +317,8 @@ Class<lay::Action> decl_ActionBase ("lay", "ActionBase",
method ("icon_text", &lay::Action::get_icon_text,
"@brief Get the icon's text\n"
) +
method ("tool_tip=", &lay::Action::set_tool_tip,
method ("tool_tip=", &lay::Action::set_tool_tip, gsi::arg ("text"),
"@brief Set the tool tip text \n"
"@args text\n"
"\n"
"The tool tip text is displayed in the tool tip window of the menu entry.\n"
"This is in particular useful for entries in the tool bar."
@ -421,4 +399,3 @@ Class<ActionStub> decl_Action (decl_ActionBase, "lay", "Action",
);
}

94
src/laybasic/laybasic/gsiDeclLayPlugin.cc
View File

@ -439,9 +439,8 @@ private:
};
Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
method ("register", &PluginFactoryBase::register_gsi,
method ("register", &PluginFactoryBase::register_gsi, gsi::arg ("position"), gsi::arg ("name"), gsi::arg ("title"),
"@brief Registers the plugin factory\n"
"@args position, name, title\n"
"@param position An integer that determines the order in which the plugins are created. The internal plugins use the values from 1000 to 50000.\n"
"@param name The plugin name. This is an arbitrary string which should be unique. Hence it is recommended to use a unique prefix, i.e. \"myplugin::ThePluginClass\".\n"
"@param title The title string which is supposed to appear in the tool bar and menu related to this plugin.\n"
@ -449,9 +448,8 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"Registration of the plugin factory makes the object known to the system. Registration requires that the menu items have been set "
"already. Hence it is recommended to put the registration at the end of the initialization method of the factory class.\n"
) +
method ("register", &PluginFactoryBase::register_gsi2,
method ("register", &PluginFactoryBase::register_gsi2, gsi::arg ("position"), gsi::arg ("name"), gsi::arg ("title"), gsi::arg ("icon"),
"@brief Registers the plugin factory\n"
"@args position, name, title, icon\n"
"@param position An integer that determines the order in which the plugins are created. The internal plugins use the values from 1000 to 50000.\n"
"@param name The plugin name. This is an arbitrary string which should be unique. Hence it is recommended to use a unique prefix, i.e. \"myplugin::ThePluginClass\".\n"
"@param title The title string which is supposed to appear in the tool bar and menu related to this plugin.\n"
@ -462,9 +460,8 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"Registration of the plugin factory makes the object known to the system. Registration requires that the menu items have been set "
"already. Hence it is recommended to put the registration at the end of the initialization method of the factory class.\n"
) +
callback ("configure", &gsi::PluginFactoryBase::configure, &gsi::PluginFactoryBase::f_configure,
callback ("configure", &gsi::PluginFactoryBase::configure, &gsi::PluginFactoryBase::f_configure, gsi::arg ("name"), gsi::arg ("value"),
"@brief Gets called for configuration events for the plugin singleton\n"
"@args name, value\n"
"This method can be reimplemented to receive configuration events "
"for the plugin singleton. Before a configuration can be received it must be "
"registered by calling \\add_option in the plugin factories' constructor.\n"
@ -479,14 +476,12 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
) +
callback ("config_finalize", &gsi::PluginFactoryBase::config_finalize, &gsi::PluginFactoryBase::f_config_finalize,
"@brief Gets called after a set of configuration events has been sent\n"
"@args\n"
"This method can be reimplemented and is called after a set of configuration events "
"has been sent to the plugin factory singleton with \\configure. It can be used to "
"set up user interfaces properly for example.\n"
) +
callback ("menu_activated", &gsi::PluginFactoryBase::menu_activated, &gsi::PluginFactoryBase::f_menu_activated,
callback ("menu_activated", &gsi::PluginFactoryBase::menu_activated, &gsi::PluginFactoryBase::f_menu_activated, gsi::arg ("symbol"),
"@brief Gets called when a menu item is selected\n"
"@args symbol\n"
"\n"
"Usually, menu-triggered functionality is implemented in the per-view instance of the plugin. "
"However, using this method it is possible to implement functionality globally for all plugin "
@ -496,37 +491,32 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"If this method was handling the menu event, it should return true. This indicates that the event "
"will not be propagated to other plugins hence avoiding duplicate calls.\n"
) +
callback ("initialized", &gsi::PluginFactoryBase::initialize, &gsi::PluginFactoryBase::f_initialize,
callback ("initialized", &gsi::PluginFactoryBase::initialize, &gsi::PluginFactoryBase::f_initialize, gsi::arg ("root"),
"@brief Gets called when the plugin singleton is initialized, i.e. when the application has been started.\n"
"@args root\n"
"@param root The reference to the \\MainWindow object\n"
) +
callback ("uninitialized", &gsi::PluginFactoryBase::uninitialize, &gsi::PluginFactoryBase::f_uninitialize,
callback ("uninitialized", &gsi::PluginFactoryBase::uninitialize, &gsi::PluginFactoryBase::f_uninitialize, gsi::arg ("root"),
"@brief Gets called when the application shuts down and the plugin is unregistered\n"
"This event can be used to free resources allocated with this factory singleton.\n"
"@args root\n"
"@param root The reference to the \\MainWindow object\n"
) +
factory_callback ("create_plugin", &gsi::PluginFactoryBase::create_plugin_gsi, &gsi::PluginFactoryBase::f_create_plugin,
factory_callback ("create_plugin", &gsi::PluginFactoryBase::create_plugin_gsi, &gsi::PluginFactoryBase::f_create_plugin, gsi::arg ("manager"), gsi::arg ("root"), gsi::arg ("view"),
"@brief Creates the plugin\n"
"This is the basic functionality that the factory must provide. This method must create a plugin of the "
"specific type.\n"
"@args manager, root, view\n"
"@param manager The database manager object responsible for handling database transactions\n"
"@param root The reference to the \\MainWindow object\n"
"@param view The \\LayoutView that is plugin is created for\n"
"@return The new \\Plugin implementation object\n"
) +
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry1,
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry1, gsi::arg ("menu_name"), gsi::arg ("insert_pos"),
"@brief Specifies a separator\n"
"@args menu_name, insert_pos\n"
"Call this method in the factory constructor to build the menu items that this plugin shall create.\n"
"This specific call inserts a separator at the given position (insert_pos). The position uses abstract menu item paths "
"and \"menu_name\" names the component that will be created. See \\AbstractMenu for a description of the path.\n"
) +
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry2,
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry2, gsi::arg ("symbol"), gsi::arg ("menu_name"), gsi::arg ("insert_pos"), gsi::arg ("title"),
"@brief Specifies a menu item\n"
"@args symbol, menu_name, insert_pos, title\n"
"Call this method in the factory constructor to build the menu items that this plugin shall create.\n"
"This specific call inserts a menu item at the specified position (insert_pos). The position uses abstract menu item paths "
"and \"menu_name\" names the component that will be created. See \\AbstractMenu for a description of the path.\n"
@ -537,15 +527,13 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"@param insert_pos The position where to create the entry\n"
"@param title The title string for the item. The title can contain a keyboard shortcut in round braces after the title text, i.e. \"My Menu Item(F12)\"\n"
) +
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry3,
method ("add_menu_entry", &gsi::PluginFactoryBase::add_menu_entry3, gsi::arg ("symbol"), gsi::arg ("menu_name"), gsi::arg ("insert_pos"), gsi::arg ("title"), gsi::arg ("sub_menu"),
"@brief Specifies a menu item or sub-menu\n"
"@args symbol, menu_name, insert_pos, title, sub_menu\n"
"Similar to the previous form of \"add_menu_entry\", but this version allows also to create sub-menus by setting the "
"last parameter to \"true\""
) +
method ("add_option", &gsi::PluginFactoryBase::add_option,
method ("add_option", &gsi::PluginFactoryBase::add_option, gsi::arg ("name"), gsi::arg ("default_value"),
"@brief Specifies configuration variables.\n"
"@args name, default_value\n"
"Call this method in the factory constructor to add configuration key/value pairs to the configuration repository. "
"Without specifying configuration variables, the status of a plugin cannot be persisted. "
"\n\n"
@ -555,9 +543,8 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
"doing so has the advantage that it is guaranteed that a variable with this keys exists and has the given default value initially."
"\n\n"
) +
method ("has_tool_entry=", &gsi::PluginFactoryBase::has_tool_entry,
method ("has_tool_entry=", &gsi::PluginFactoryBase::has_tool_entry, gsi::arg ("f"),
"@brief Enables or disables the tool bar entry\n"
"@args f\n"
"Initially this property is set to true. This means that the plugin will have a visible entry in the toolbar. "
"This property can be set to false to disable this feature. In that case, the title and icon given on registration will be ignored. "
),
@ -638,28 +625,24 @@ Class<gsi::PluginFactoryBase> decl_PluginFactory ("lay", "PluginFactory",
);
Class<gsi::PluginBase> decl_Plugin ("lay", "Plugin",
callback ("menu_activated", &gsi::PluginBase::menu_activated, &gsi::PluginBase::f_menu_activated,
callback ("menu_activated", &gsi::PluginBase::menu_activated, &gsi::PluginBase::f_menu_activated, gsi::arg ("symbol"),
"@brief Gets called when a custom menu item is selected\n"
"@args symbol\n"
"When a menu item is clicked which was registered with the plugin factory, the plugin's 'menu_activated' method is "
"called for the current view. The symbol registered for the menu item is passed in the 'symbol' argument."
) +
callback ("configure", &gsi::PluginBase::configure, &gsi::PluginBase::f_configure,
callback ("configure", &gsi::PluginBase::configure, &gsi::PluginBase::f_configure, gsi::arg ("name"), gsi::arg ("value"),
"@brief Sends configuration requests to the plugin\n"
"@args name, value\n"
"@param name The name of the configuration variable as registered in the plugin factory\n"
"@param value The value of the configuration variable\n"
"When a configuration variable is changed, the new value is reported to the plugin by calling the 'configure' method."
) +
callback ("config_finalize", &gsi::PluginBase::config_finalize, &gsi::PluginBase::f_config_finalize,
"@brief Sends the post-configuration request to the plugin\n"
"@args\n"
"After all configuration parameters have been sent, 'config_finalize' is called to given the plugin a chance to "
"update it's internal state according to the new configuration.\n"
) +
callback ("key_event", &gsi::PluginBase::key_event, &gsi::PluginBase::f_key_event,
callback ("key_event", &gsi::PluginBase::key_event, &gsi::PluginBase::f_key_event, gsi::arg ("key"), gsi::arg ("buttons"),
"@brief Handles the key pressed event\n"
"@args key, buttons\n"
"This method will called by the view on the active plugin when a button is pressed on the mouse.\n"
"\n"
"If the plugin handles the event, it should return true to indicate that the event should not be processed further."
@ -668,9 +651,8 @@ Class<gsi::PluginBase> decl_Plugin ("lay", "Plugin",
"@param buttons A combination of the constants in the \\ButtonState class which codes both the mouse buttons and the key modifiers (.e. ShiftButton etc).\n"
"@return True to terminate dispatcher\n"
) +
callback ("mouse_button_pressed_event", &gsi::PluginBase::mouse_press_event, &gsi::PluginBase::f_mouse_press_event,
callback ("mouse_button_pressed_event", &gsi::PluginBase::mouse_press_event, &gsi::PluginBase::f_mouse_press_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse button pressed event\n"
"@args p, buttons, prio\n"
"This method will called by the view when a button is pressed on the mouse.\n"
"\n"
"First, the plugins that grabbed the mouse with \\grab_mouse will receive this event with 'prio' set to true "
@ -691,76 +673,61 @@ Class<gsi::PluginBase> decl_Plugin ("lay", "Plugin",
"@param buttons A combination of the constants in the \\ButtonState class which codes both the mouse buttons and the key modifiers (.e. LeftButton, ShiftButton etc).\n"
"@return True to terminate dispatcher\n"
) +
callback ("mouse_click_event", &gsi::PluginBase::mouse_click_event, &gsi::PluginBase::f_mouse_click_event,
callback ("mouse_click_event", &gsi::PluginBase::mouse_click_event, &gsi::PluginBase::f_mouse_click_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse button click event (after the button has been released)\n"
"@args p, buttons, prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse button has been released without moving it.\n"
) +
callback ("mouse_double_click_event", &gsi::PluginBase::mouse_double_click_event, &gsi::PluginBase::f_mouse_double_click_event,
callback ("mouse_double_click_event", &gsi::PluginBase::mouse_double_click_event, &gsi::PluginBase::f_mouse_double_click_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse button double-click event\n"
"@args p, buttons, prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse button has been double-clicked.\n"
) +
callback ("leave_event", &gsi::PluginBase::leave_event, &gsi::PluginBase::f_leave_event,
callback ("leave_event", &gsi::PluginBase::leave_event, &gsi::PluginBase::f_leave_event, gsi::arg ("prio"),
"@brief Handles the leave event (mouse leaves canvas area of view)\n"
"@args prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse leaves the canvas area.\n"
"This method does not have a position nor button flags.\n"
) +
callback ("enter_event", &gsi::PluginBase::enter_event, &gsi::PluginBase::f_enter_event,
callback ("enter_event", &gsi::PluginBase::enter_event, &gsi::PluginBase::f_enter_event, gsi::arg ("prio"),
"@brief Handles the enter event (mouse enters canvas area of view)\n"
"@args prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse enters the canvas area.\n"
"This method does not have a position nor button flags.\n"
) +
callback ("mouse_moved_event", &gsi::PluginBase::mouse_move_event, &gsi::PluginBase::f_mouse_move_event,
callback ("mouse_moved_event", &gsi::PluginBase::mouse_move_event, &gsi::PluginBase::f_mouse_move_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse move event\n"
"@args p, buttons, prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse is moved in the canvas area.\n"
) +
callback ("mouse_button_released_event", &gsi::PluginBase::mouse_release_event, &gsi::PluginBase::f_mouse_release_event,
callback ("mouse_button_released_event", &gsi::PluginBase::mouse_release_event, &gsi::PluginBase::f_mouse_release_event, gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"@brief Handles the mouse button release event\n"
"@args p, buttons, prio\n"
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse button is released.\n"
) +
callback ("wheel_event", &gsi::PluginBase::wheel_event, &gsi::PluginBase::f_wheel_event,
"@args delta, horizontal, p, buttons, prio\n"
callback ("wheel_event", &gsi::PluginBase::wheel_event, &gsi::PluginBase::f_wheel_event, gsi::arg ("delta"), gsi::arg ("horizontal"), gsi::arg ("p"), gsi::arg ("buttons"), gsi::arg ("prio"),
"The behaviour of this callback is the same than for \\mouse_press_event, except that it is called when the mouse wheel is rotated.\n"
"Additional parameters for this event are 'delta' (the rotation angle in units of 1/8th degree) and 'horizontal' which is true when the horizontal wheel was rotated and "
"false if the vertical wheel was rotated.\n"
) +
callback ("activated", &gsi::PluginBase::activated, &gsi::PluginBase::f_activated,
"@brief Gets called when the plugin is activated (selected in the tool bar)\n"
"@args\n"
) +
callback ("deactivated", &gsi::PluginBase::deactivated, &gsi::PluginBase::f_deactivated,
"@brief Gets called when the plugin is deactivated and another plugin is activated\n"
"@args\n"
) +
callback ("drag_cancel", &gsi::PluginBase::drag_cancel, &gsi::PluginBase::f_drag_cancel,
"@brief Gets called on various occasions when a drag operation should be canceled\n"
"@args\n"
"If the plugin implements some press-and-drag or a click-and-drag operation, this callback should "
"cancel this operation and return in some state waiting for a new mouse event."
) +
callback ("update", &gsi::PluginBase::update, &gsi::PluginBase::f_update,
"@brief Gets called when the view has changed\n"
"@args\n"
"This method is called in particular if the view has changed the visible rectangle, i.e. after zooming in or out or panning. "
"This callback can be used to update any internal states that depend on the view's state."
) +
method ("grab_mouse", &gsi::PluginBase::grab_mouse,
"@brief Redirects mouse events to this plugin, even if the plugin is not active.\n"
"@args\n"
) +
method ("ungrab_mouse", &gsi::PluginBase::ungrab_mouse,
"@brief Removes a mouse grab registered with \\grab_mouse.\n"
"@args\n"
) +
method ("set_cursor", &gsi::PluginBase::set_cursor,
method ("set_cursor", &gsi::PluginBase::set_cursor, gsi::arg ("cursor_type"),
"@brief Sets the cursor in the view area to the given type\n"
"@args cursor_type\n"
"Setting the cursor has an effect only inside event handlers, i.e. mouse_press_event. The cursor is not set permanently. Is is reset "
"in the mouse move handler unless a button is pressed or the cursor is explicitly set again in the mouse_move_event.\n"
"\n"
@ -891,35 +858,31 @@ Class<lay::PluginRoot> decl_PluginRoot ("lay", "PluginRoot",
"\n"
"@return The instance\n"
) +
method ("write_config", &lay::PluginRoot::write_config,
method ("write_config", &lay::PluginRoot::write_config, gsi::arg ("file_name"),
"@brief Writes configuration to a file\n"
"@args file_name\n"
"@return A value indicating whether the operation was successful\n"
"\n"
"If the configuration file cannot be written, false \n"
"is returned but no exception is thrown.\n"
) +
method ("read_config", &lay::PluginRoot::read_config,
method ("read_config", &lay::PluginRoot::read_config, gsi::arg ("file_name"),
"@brief Reads the configuration from a file\n"
"@args file_name\n"
"@return A value indicating whether the operation was successful\n"
"\n"
"This method siletly does nothing, if the config file does not\n"
"exist. If it does and an error occurred, the error message is printed\n"
"on stderr. In both cases, false is returned.\n"
) +
method_ext ("get_config", &get_config,
method_ext ("get_config", &get_config, gsi::arg ("name"),
"@brief Gets the value of a local configuration parameter\n"
"\n"
"@args name\n"
"@param name The name of the configuration parameter whose value shall be obtained (a string)\n"
"\n"
"@return The value of the parameter or nil if there is no such parameter\n"
) +
method ("set_config", (void (lay::PluginRoot::*) (const std::string &, const std::string &)) &lay::PluginRoot::config_set,
method ("set_config", (void (lay::PluginRoot::*) (const std::string &, const std::string &)) &lay::PluginRoot::config_set, gsi::arg ("name"), gsi::arg ("value"),
"@brief Set a local configuration parameter with the given name to the given value\n"
"\n"
"@args name, value\n"
"@param name The name of the configuration parameter to set\n"
"@param value The value to which to set the configuration parameter\n"
"\n"
@ -961,4 +924,3 @@ Class<lay::PluginRoot> decl_PluginRoot ("lay", "PluginRoot",
);
}

32
src/plugins/streamers/dxf/db_plugin/gsiDeclDbDXF.cc
View File

@ -223,18 +223,16 @@ gsi::ClassExt<db::LoadLayoutOptions> dxf_reader_options (
"This method has been added in version 0.25 and replaces the respective global option in \\LoadLayoutOptions "
"in a format-specific fashion."
) +
gsi::method_ext ("dxf_dbu=", &set_dxf_dbu,
gsi::method_ext ("dxf_dbu=", &set_dxf_dbu, gsi::arg ("dbu"),
"@brief Specifies the database unit which the reader uses and produces\n"
"@args dbu\n"
"\nThis property has been added in version 0.21.\n"
) +
gsi::method_ext ("dxf_dbu", &get_dxf_dbu,
"@brief Specifies the database unit which the reader uses and produces\n"
"\nThis property has been added in version 0.21.\n"
) +
gsi::method_ext ("dxf_text_scaling=", &set_dxf_text_scaling,
gsi::method_ext ("dxf_text_scaling=", &set_dxf_text_scaling, gsi::arg ("unit"),
"@brief Specifies the text scaling in percent of the default scaling\n"
"@args unit\n"
"\n"
"The default value 100, meaning that the letter pitch is roughly 92 percent of the specified text height. "
"Decrease this value to get smaller fonts and increase it to get larger fonts.\n"
@ -244,18 +242,16 @@ gsi::ClassExt<db::LoadLayoutOptions> dxf_reader_options (
"@brief Gets the text scaling factor (see \\dxf_text_scaling=)\n"
"\nThis property has been added in version 0.21.20.\n"
) +
gsi::method_ext ("dxf_unit=", &set_dxf_unit,
gsi::method_ext ("dxf_unit=", &set_dxf_unit, gsi::arg ("unit"),
"@brief Specifies the unit in which the DXF file is drawn.\n"
"@args unit\n"
"\nThis property has been added in version 0.21.3.\n"
) +
gsi::method_ext ("dxf_unit", &get_dxf_unit,
"@brief Specifies the unit in which the DXF file is drawn\n"
"\nThis property has been added in version 0.21.3.\n"
) +
gsi::method_ext ("dxf_circle_points=", &set_dxf_circle_points,
gsi::method_ext ("dxf_circle_points=", &set_dxf_circle_points, gsi::arg ("points"),
"@brief Specifies the number of points used per full circle for arc interpolation\n"
"@args points\n"
"See also \\dxf_circle_accuracy for how to specify the number of points based on "
"an approximation accuracy.\n"
"\n"
@ -268,9 +264,8 @@ gsi::ClassExt<db::LoadLayoutOptions> dxf_reader_options (
"@brief Gets the number of points used per full circle for arc interpolation\n"
"\nThis property has been added in version 0.21.6.\n"
) +
gsi::method_ext ("dxf_circle_accuracy=", &set_dxf_circle_accuracy,
gsi::method_ext ("dxf_circle_accuracy=", &set_dxf_circle_accuracy, gsi::arg ("accuracy"),
"@brief Specifies the accuracy of the circle approximation\n"
"@args accuracy\n"
"\n"
"In addition to the number of points per circle, the circle accuracy can be specified. "
"If set to a value larger than the database unit, the number of points per circle will "
@ -288,9 +283,8 @@ gsi::ClassExt<db::LoadLayoutOptions> dxf_reader_options (
"@brief Gets the accuracy of the circle approximation\n"
"\nThis property has been added in version 0.24.9.\n"
) +
gsi::method_ext ("dxf_contour_accuracy=", &set_dxf_contour_accuracy,
gsi::method_ext ("dxf_contour_accuracy=", &set_dxf_contour_accuracy, gsi::arg ("accuracy"),
"@brief Specifies the accuracy for contour closing\n"
"@args accuracy\n"
"\n"
"When polylines need to be connected or closed, this\n"
"value is used to indicate the accuracy. This is the value (in DXF units)\n"
@ -307,9 +301,8 @@ gsi::ClassExt<db::LoadLayoutOptions> dxf_reader_options (
"\n"
"\nThis property has been added in version 0.25.3.\n"
) +
gsi::method_ext ("dxf_render_texts_as_polygons=", &set_dxf_render_texts_as_polygons,
gsi::method_ext ("dxf_render_texts_as_polygons=", &set_dxf_render_texts_as_polygons, gsi::arg ("value"),
"@brief If this option is set to true, text objects are rendered as polygons\n"
"@args value\n"
"\nThis property has been added in version 0.21.15.\n"
) +
gsi::method_ext ("dxf_render_texts_as_polygons?|#dxf_render_texts_as_polygons", &get_dxf_render_texts_as_polygons,
@ -334,18 +327,16 @@ gsi::ClassExt<db::LoadLayoutOptions> dxf_reader_options (
"\n"
"This method has been added in version 0.25.3."
) +
gsi::method_ext ("dxf_keep_other_cells=", &set_dxf_keep_other_cells,
gsi::method_ext ("dxf_keep_other_cells=", &set_dxf_keep_other_cells, gsi::arg ("value"),
"@brief If this option is set to true, all cells are kept, not only the top cell and it's children\n"
"@args value\n"
"\nThis property has been added in version 0.21.15.\n"
) +
gsi::method_ext ("dxf_keep_other_cells?|#dxf_keep_other_cells", &get_dxf_keep_other_cells,
"@brief If this option is true, all cells are kept, not only the top cell and it's children\n"
"\nThis property has been added in version 0.21.15.\n"
) +
gsi::method_ext ("dxf_polyline_mode=", &set_dxf_polyline_mode,
gsi::method_ext ("dxf_polyline_mode=", &set_dxf_polyline_mode, gsi::arg ("mode"),
"@brief Specifies how to treat POLYLINE/LWPOLYLINE entities.\n"
"@args mode\n"
"The mode is 0 (automatic), 1 (keep lines), 2 (create polygons from closed polylines with width = 0), "
"3 (merge all lines with width = 0 into polygons), 4 (as 3 plus auto-close open contours).\n"
"\nThis property has been added in version 0.21.3.\n"
@ -378,9 +369,8 @@ static int get_dxf_polygon_mode (const db::SaveLayoutOptions *options)
// extend lay::SaveLayoutOptions with the DXF options
static
gsi::ClassExt<db::SaveLayoutOptions> dxf_writer_options (
gsi::method_ext ("dxf_polygon_mode=", &set_dxf_polygon_mode,
gsi::method_ext ("dxf_polygon_mode=", &set_dxf_polygon_mode, gsi::arg ("mode"),
"@brief Specifies how to write polygons.\n"
"@args mode\n"
"The mode is 0 (write POLYLINE entities), 1 (write LWPOLYLINE entities), 2 (decompose into SOLID entities), "
"3 (write HATCH entities), or 4 (write LINE entities).\n"
"\nThis property has been added in version 0.21.3. '4', in version 0.25.6.\n"
@ -393,4 +383,4 @@ gsi::ClassExt<db::SaveLayoutOptions> dxf_writer_options (
""
);
}
}

28
src/plugins/streamers/gds2/db_plugin/gsiDeclDbGDS2.cc
View File

@ -128,9 +128,8 @@ static double get_gds2_user_units (const db::SaveLayoutOptions *options)
// extend lay::SaveLayoutOptions with the GDS2 options
static
gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
gsi::method_ext ("gds2_max_vertex_count=", &set_gds2_max_vertex_count,
gsi::method_ext ("gds2_max_vertex_count=", &set_gds2_max_vertex_count, gsi::arg ("count"),
"@brief Set the maximum number of vertices for polygons to write\n"
"@args count\n"
"This property describes the maximum number of point for polygons in GDS2 files.\n"
"Polygons with more points will be split.\n"
"The minimum value for this property is 4. The maximum allowed value is about 4000 or 8000, depending on the\n"
@ -143,9 +142,8 @@ gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
"See \\gds2_max_vertex_count= method for a description of the maximum vertex count."
"\nThis property has been added in version 0.18.\n"
) +
gsi::method_ext ("gds2_multi_xy_records=", &set_gds2_multi_xy_records,
gsi::method_ext ("gds2_multi_xy_records=", &set_gds2_multi_xy_records, gsi::arg ("flag"),
"@brief Use multiple XY records in BOUNDARY elements for unlimited large polygons\n"
"@args flag\n"
"\n"
"Setting this property to true allows producing polygons with an unlimited number of points \n"
"at the cost of incompatible formats. Setting it to true disables the \\gds2_max_vertex_count setting.\n"
@ -156,9 +154,8 @@ gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
"See \\gds2_multi_xy_records= method for a description of this property."
"\nThis property has been added in version 0.18.\n"
) +
gsi::method_ext ("gds2_write_timestamps=", &set_gds2_write_timestamps,
gsi::method_ext ("gds2_write_timestamps=", &set_gds2_write_timestamps, gsi::arg ("flag"),
"@brief Write the current time into the GDS2 timestamps if set to true\n"
"@args flag\n"
"\n"
"If this property is set to false, the time fields will all be zero. This somewhat simplifies compare and diff "
"applications.\n"
@ -169,9 +166,8 @@ gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
"@brief Gets a value indicating whether the current time is written into the GDS2 timestamp fields\n"
"\nThis property has been added in version 0.21.16.\n"
) +
gsi::method_ext ("gds2_no_zero_length_paths=", &set_gds2_no_zero_length_paths,
gsi::method_ext ("gds2_no_zero_length_paths=", &set_gds2_no_zero_length_paths, gsi::arg ("flag"),
"@brief Eliminates zero-length paths if true\n"
"@args flag\n"
"\n"
"If this property is set to true, paths with zero length will be converted to BOUNDARY objects.\n"
"\n"
@ -181,9 +177,8 @@ gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
"@brief Gets a value indicating whether zero-length paths are eliminated\n"
"\nThis property has been added in version 0.23.\n"
) +
gsi::method_ext ("gds2_write_cell_properties=", &set_gds2_write_cell_properties,
gsi::method_ext ("gds2_write_cell_properties=", &set_gds2_write_cell_properties, gsi::arg ("flag"),
"@brief Enables writing of cell properties if set to true\n"
"@args flag\n"
"\n"
"If this property is set to true, cell properties will be written as PROPATTR/PROPVALUE records immediately "
"following the BGNSTR records. This is a non-standard extension and is therefore disabled by default.\n"
@ -194,9 +189,8 @@ gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
"@brief Gets a value indicating whether cell properties are written\n"
"\nThis property has been added in version 0.23.\n"
) +
gsi::method_ext ("gds2_write_file_properties=", &set_gds2_write_file_properties,
gsi::method_ext ("gds2_write_file_properties=", &set_gds2_write_file_properties, gsi::arg ("flag"),
"@brief Enables writing of file properties if set to true\n"
"@args flag\n"
"\n"
"If this property is set to true, layout properties will be written as PROPATTR/PROPVALUE records immediately "
"following the BGNLIB records. This is a non-standard extension and is therefore disabled by default.\n"
@ -207,9 +201,8 @@ gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
"@brief Gets a value indicating whether layout properties are written\n"
"\nThis property has been added in version 0.24.\n"
) +
gsi::method_ext ("gds2_max_cellname_length=", &set_gds2_max_cellname_length,
gsi::method_ext ("gds2_max_cellname_length=", &set_gds2_max_cellname_length, gsi::arg ("length"),
"@brief Maximum length of cell names\n"
"@args length\n"
"\n"
"This property describes the maximum number of characters for cell names. \n"
"Longer cell names will be shortened.\n"
@ -220,9 +213,8 @@ gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
"See \\gds2_max_cellname_length= method for a description of the maximum cell name length."
"\nThis property has been added in version 0.18.\n"
) +
gsi::method_ext ("gds2_libname=", &set_gds2_libname,
gsi::method_ext ("gds2_libname=", &set_gds2_libname, gsi::arg ("libname"),
"@brief Set the library name\n"
"@args libname\n"
"\n"
"The library name is the string written into the LIBNAME records of the GDS file.\n"
"The library name should not be an empty string and is subject to certain limitations in the character choice.\n"
@ -233,9 +225,8 @@ gsi::ClassExt<db::SaveLayoutOptions> gds2_writer_options (
"See \\gds2_libname= method for a description of the library name."
"\nThis property has been added in version 0.18.\n"
) +
gsi::method_ext ("gds2_user_units=", &set_gds2_user_units,
gsi::method_ext ("gds2_user_units=", &set_gds2_user_units, gsi::arg ("uu"),
"@brief Set the users units to write into the GDS file\n"
"@args uu\n"
"\n"
"The user units of a GDS file are rarely used and usually are set to 1 (micron).\n"
"The intention of the user units is to specify the display units. KLayout ignores the user unit and uses microns as the display unit.\n"
@ -326,4 +317,3 @@ gsi::ClassExt<db::LoadLayoutOptions> gds2_reader_options (
);
}

26
src/plugins/streamers/oasis/db_plugin/gsiDeclDbOASIS.cc
View File

@ -181,25 +181,22 @@ static std::string get_oasis_subst_char (const db::SaveLayoutOptions *options)
// extend lay::SaveLayoutOptions with the OASIS options
static
gsi::ClassExt<db::SaveLayoutOptions> oasis_writer_options (
gsi::method_ext ("oasis_write_cblocks=", &set_oasis_write_cblocks,
gsi::method_ext ("oasis_write_cblocks=", &set_oasis_write_cblocks, gsi::arg ("flag"),
"@brief Sets a value indicating whether to write compressed CBLOCKS per cell\n"
"@args flag\n"
"Setting this property clears all format specific options for other formats such as GDS.\n"
) +
gsi::method_ext ("oasis_write_cblocks?", &get_oasis_write_cblocks,
"@brief Gets a value indicating whether to write compressed CBLOCKS per cell\n"
) +
gsi::method_ext ("oasis_strict_mode=", &set_oasis_strict_mode,
gsi::method_ext ("oasis_strict_mode=", &set_oasis_strict_mode, gsi::arg ("flag"),
"@brief Sets a value indicating whether to write strict-mode OASIS files\n"
"@args flag\n"
"Setting this property clears all format specific options for other formats such as GDS.\n"
) +
gsi::method_ext ("oasis_strict_mode?", &get_oasis_strict_mode,
"@brief Gets a value indicating whether to write strict-mode OASIS files\n"
) +
gsi::method_ext ("oasis_substitution_char=", &set_oasis_subst_char,
gsi::method_ext ("oasis_substitution_char=", &set_oasis_subst_char, gsi::arg ("char"),
"@brief Sets the substitution character for a-strings and n-strings\n"
"@args char\n"
"The substitution character is used in place of invalid characters. The value of this "
"attribute is a string which is either empty or a single character. If the string is "
"empty, no substitution is made at the risk of producing invalid OASIS files.\n"
@ -211,9 +208,8 @@ gsi::ClassExt<db::SaveLayoutOptions> oasis_writer_options (
"\n"
"See \\oasis_substitution_char for details. This attribute has been introduced in version 0.23.\n"
) +
gsi::method_ext ("oasis_recompress=", &set_oasis_recompress,
gsi::method_ext ("oasis_recompress=", &set_oasis_recompress, gsi::arg ("flag"),
"@brief Sets OASIS recompression mode\n"
"@args flag\n"
"If this flag is true, shape arrays already existing will be resolved and compression is applied "
"to the individual shapes again. If this flag is false (the default), shape arrays already existing "
"will be written as such.\n"
@ -226,9 +222,8 @@ gsi::ClassExt<db::SaveLayoutOptions> oasis_writer_options (
"\n"
"This method has been introduced in version 0.23."
) +
gsi::method_ext ("oasis_permissive=", &set_oasis_permissive,
gsi::method_ext ("oasis_permissive=", &set_oasis_permissive, gsi::arg ("flag"),
"@brief Sets OASIS permissive mode\n"
"@args flag\n"
"If this flag is true, certain shapes which cannot be written to OASIS are reported as warnings, "
"not as errors. For example, paths with odd width (are rounded) or polygons with less than three points (are skipped).\n"
"\n"
@ -240,9 +235,8 @@ gsi::ClassExt<db::SaveLayoutOptions> oasis_writer_options (
"\n"
"This method has been introduced in version 0.25.1."
) +
gsi::method_ext ("oasis_write_cell_bounding_boxes=", &set_oasis_write_cell_bounding_boxes,
gsi::method_ext ("oasis_write_cell_bounding_boxes=", &set_oasis_write_cell_bounding_boxes, gsi::arg ("flag"),
"@brief Sets a value indicating whether cell bounding boxes are written\n"
"@args flag\n"
"If this value is set to true, cell bounding boxes are written (S_BOUNDING_BOX). "
"The S_BOUNDING_BOX properties will be attached to the CELLNAME records.\n"
"\n"
@ -258,9 +252,8 @@ gsi::ClassExt<db::SaveLayoutOptions> oasis_writer_options (
"\n"
"This method has been introduced in version 0.24.3."
) +
gsi::method_ext ("oasis_write_std_properties=", &set_oasis_write_std_properties,
gsi::method_ext ("oasis_write_std_properties=", &set_oasis_write_std_properties, gsi::arg ("flag"),
"@brief Sets a value indicating whether standard properties will be written\n"
"@args flag\n"
"If this value is false, no standard properties are written. If true, S_TOP_CELL and some other global "
"standard properties are written. In addition, \\oasis_write_cell_bounding_boxes= can be used to "
"write cell bounding boxes using S_BOUNDING_BOX.\n"
@ -285,9 +278,8 @@ gsi::ClassExt<db::SaveLayoutOptions> oasis_writer_options (
// this method is mainly provided as access point for the generic interface
"@hide"
) +
gsi::method_ext ("oasis_compression_level=", &set_oasis_compression,
gsi::method_ext ("oasis_compression_level=", &set_oasis_compression, gsi::arg ("level"),
"@brief Set the OASIS compression level\n"
"@args level\n"
"The OASIS compression level is an integer number between 0 and 10. 0 basically is no compression, "
"1 produces shape arrays in a simple fashion. 2 and higher compression levels will use a more elaborate "
"algorithm to find shape arrays which uses 2nd and further neighbor distances. The higher the level, the "
@ -300,4 +292,4 @@ gsi::ClassExt<db::SaveLayoutOptions> oasis_writer_options (
""
);
}
}

127
src/rdb/rdb/gsiDeclRdb.cc
View File

@ -97,9 +97,8 @@ static rdb::Reference *new_ref_tp (const db::DCplxTrans &trans, rdb::id_type par
}
Class<rdb::Reference> decl_RdbReference ("rdb", "RdbReference",
gsi::constructor ("new", &new_ref_tp,
gsi::constructor ("new", &new_ref_tp, gsi::arg ("trans"), gsi::arg ("parent_cell_id"),
"@brief Creates a reference with a given transformation and parent cell ID\n"
"@args trans, parent_cell_id\n"
) +
gsi::method ("database", (const rdb::Database *(rdb::Reference::*)() const) &rdb::Reference::database,
"@brief Gets the database object that category is associated with\n"
@ -112,17 +111,15 @@ Class<rdb::Reference> decl_RdbReference ("rdb", "RdbReference",
"usual transformation of a cell reference.\n"
"@return The transformation\n"
) +
gsi::method ("trans=", &rdb::Reference::set_trans,
gsi::method ("trans=", &rdb::Reference::set_trans, gsi::arg ("trans"),
"@brief Sets the transformation for this reference\n"
"@args trans\n"
) +
gsi::method ("parent_cell_id", &rdb::Reference::parent_cell_id,
"@brief Gets parent cell ID for this reference\n"
"@return The parent cell ID\n"
) +
gsi::method ("parent_cell_id=", &rdb::Reference::set_parent_cell_id,
gsi::method ("parent_cell_id=", &rdb::Reference::set_parent_cell_id, gsi::arg ("id"),
"@brief Sets the parent cell ID for this reference\n"
"@args id\n"
),
"@brief A cell reference inside the report database\n"
"This class describes a cell reference. Such reference object can be attached to cells to describe instantiations of them "
@ -209,9 +206,8 @@ Class<rdb::Cell> decl_RdbCell ("rdb", "RdbCell",
gsi::method ("num_items_visited", &rdb::Cell::num_items_visited,
"@brief Gets the number of visited items for this cell\n"
) +
gsi::method_ext ("add_reference", &add_reference,
gsi::method_ext ("add_reference", &add_reference, gsi::arg ("ref"),
"@brief Adds a reference to the references of this cell\n"
"@args ref\n"
"@param ref The reference to add.\n"
) +
gsi::method_ext ("clear_references", &clear_references,
@ -343,27 +339,24 @@ Class<rdb::Category> decl_RdbCategory ("rdb", "RdbCategory",
"\n"
"This method has been introduced in version 0.26.\n"
) +
gsi::method_ext ("scan_layer", &scan_layer1,
gsi::method_ext ("scan_layer", &scan_layer1, gsi::arg ("layout"), gsi::arg ("layer"),
"@brief Scans a layer from a layout into this category\n"
"@args layout, layer\n"
"Creates RDB items for each polygon or edge shape read from the each cell in the layout on the given layer and puts them into this category.\n"
"New cells will be generated for every cell encountered in the layout.\n"
"Other settings like database unit, description, top cell etc. are not made in the RDB.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("scan_layer", &scan_layer2,
gsi::method_ext ("scan_layer", &scan_layer2, gsi::arg ("layout"), gsi::arg ("layer"), gsi::arg ("cell"),
"@brief Scans a layer from a layout into this category, starting with a given cell\n"
"@args layout, layer, cell\n"
"Creates RDB items for each polygon or edge shape read from the cell and it's children in the layout on the given layer and puts them into this category.\n"
"New cells will be generated when required.\n"
"Other settings like database unit, description, top cell etc. are not made in the RDB.\n"
"\n"
"This method has been introduced in version 0.23.\n"
) +
gsi::method_ext ("scan_layer", &scan_layer3,
gsi::method_ext ("scan_layer", &scan_layer3, gsi::arg ("layout"), gsi::arg ("layer"), gsi::arg ("cell"), gsi::arg ("levels"),
"@brief Scans a layer from a layout into this category, starting with a given cell and a depth specification\n"
"@args layout, layer, cell, levels\n"
"Creates RDB items for each polygon or edge shape read from the cell and it's children in the layout on the given layer and puts them into this category.\n"
"New cells will be generated when required.\n"
"\"levels\" is the number of hierarchy levels to take the child cells from. 0 means to use only \"cell\" and don't descend, -1 means \"all levels\".\n"
@ -388,9 +381,8 @@ Class<rdb::Category> decl_RdbCategory ("rdb", "RdbCategory",
"@brief Gets the category description\n"
"@return The description string\n"
) +
gsi::method ("description=", &rdb::Category::set_description,
gsi::method ("description=", &rdb::Category::set_description, gsi::arg ("description"),
"@brief Sets the category description\n"
"@args description\n"
"@param description The description string\n"
) +
gsi::iterator_ext ("each_sub_category", &begin_sub_categories, &end_sub_categories,
@ -606,48 +598,39 @@ void value_set_tag_id (rdb::ValueWrapper *v, rdb::id_type id)
}
Class<rdb::ValueWrapper> decl_RdbItemValue ("rdb", "RdbItemValue",
gsi::method ("from_s", &value_from_string,
gsi::method ("from_s", &value_from_string, gsi::arg ("s"),
"@brief Creates a value object from a string\n"
"@args s\n"
"The string format is the same than obtained by the to_s method.\n"
) +
gsi::constructor ("new", &new_value_f,
gsi::constructor ("new", &new_value_f, gsi::arg ("f"),
"@brief Creates a value representing a numeric value\n"
"@args f\n"
"\n"
"This variant has been introduced in version 0.24\n"
) +
gsi::constructor ("new", &new_value_s,
gsi::constructor ("new", &new_value_s, gsi::arg ("s"),
"@brief Creates a value representing a string\n"
"@args s\n"
) +
gsi::constructor ("new", &new_value_p,
gsi::constructor ("new", &new_value_p, gsi::arg ("p"),
"@brief Creates a value representing a DPolygon object\n"
"@args p\n"
) +
gsi::constructor ("new", &new_value_path,
gsi::constructor ("new", &new_value_path, gsi::arg ("p"),
"@brief Creates a value representing a DPath object\n"
"@args p\n"
"\n"
"This method has been introduced in version 0.22."
) +
gsi::constructor ("new", &new_value_text,
gsi::constructor ("new", &new_value_text, gsi::arg ("t"),
"@brief Creates a value representing a DText object\n"
"@args t\n"
"\n"
"This method has been introduced in version 0.22."
) +
gsi::constructor ("new", &new_value_e,
gsi::constructor ("new", &new_value_e, gsi::arg ("e"),
"@brief Creates a value representing a DEdge object\n"
"@args e\n"
) +
gsi::constructor ("new", &new_value_ep,
gsi::constructor ("new", &new_value_ep, gsi::arg ("ee"),
"@brief Creates a value representing a DEdgePair object\n"
"@args ee\n"
) +
gsi::constructor ("new", &new_value_b,
gsi::constructor ("new", &new_value_b, gsi::arg ("b"),
"@brief Creates a value representing a DBox object\n"
"@args b\n"
) +
gsi::method_ext ("to_s", &value_to_string,
"@brief Converts a value to a string\n"
@ -722,9 +705,8 @@ Class<rdb::ValueWrapper> decl_RdbItemValue ("rdb", "RdbItemValue",
"@brief Gets the box if the value represents one.\n"
"@return The \\DBox object or nil"
) +
gsi::method_ext ("tag_id=", &value_set_tag_id,
gsi::method_ext ("tag_id=", &value_set_tag_id, gsi::arg ("id"),
"@brief Sets the tag ID to make the value a tagged value or 0 to reset it\n"
"@args id\n"
"@param id The tag ID\n"
"To get a tag ID, use \\RdbDatabase#user_tag_id (preferred) or \\RdbDatabase#tag_id (for internal use).\n"
"Tagged values have been added in version 0.24. Tags can be given to identify a value, for example "
@ -805,29 +787,25 @@ Class<rdb::Item> decl_RdbItem ("rdb", "RdbItem",
"@brief Gets a value indicating whether the item was already visited\n"
"@return True, if the item has been visited already\n"
) +
gsi::method ("add_tag", &rdb::Item::add_tag,
gsi::method ("add_tag", &rdb::Item::add_tag, gsi::arg ("tag_id"),
"@brief Adds a tag with the given id to the item\n"
"@args tag_id\n"
"Each tag can be added once to the item. The tags of an item thus form a set. "
"If a tag with that ID already exists, this method does nothing."
) +
gsi::method ("remove_tag", &rdb::Item::remove_tag,
gsi::method ("remove_tag", &rdb::Item::remove_tag, gsi::arg ("tag_id"),
"@brief Remove the tag with the given id from the item\n"
"@args tag_id\n"
"If a tag with that ID does not exists on this item, this method does nothing."
) +
gsi::method ("has_tag?", &rdb::Item::has_tag,
gsi::method ("has_tag?", &rdb::Item::has_tag, gsi::arg ("tag_id"),
"@brief Returns a value indicating whether the item has a tag with the given ID\n"
"@args tag_id\n"
"@return True, if the item has a tag with the given ID\n"
) +
gsi::method ("tags_str", &rdb::Item::tag_str,
"@brief Returns a string listing all tags of this item\n"
"@return A comma-separated list of tags\n"
) +
gsi::method ("tags_str=", &rdb::Item::set_tag_str,
gsi::method ("tags_str=", &rdb::Item::set_tag_str, gsi::arg ("tags"),
"@brief Sets the tags from a string\n"
"@args tags\n"
"@param tags A comma-separated list of tags\n"
) +
#if defined(HAVE_QT)
@ -835,9 +813,8 @@ Class<rdb::Item> decl_RdbItem ("rdb", "RdbItem",
"@brief Gets the image associated with this item as a string\n"
"@return A base64-encoded image file (usually in PNG format)\n"
) +
gsi::method ("image_str=", &rdb::Item::set_image_str,
gsi::method ("image_str=", &rdb::Item::set_image_str, gsi::arg ("image"),
"@brief Sets the image from a string\n"
"@args image\n"
"@param image A base64-encoded image file (preferably in PNG format)\n"
) +
#endif
@ -849,49 +826,41 @@ Class<rdb::Item> decl_RdbItem ("rdb", "RdbItem",
"for this specific item instead of simply counting the items. "
"@return The multiplicity\n"
) +
gsi::method ("multiplicity=", &rdb::Item::set_multiplicity,
gsi::method ("multiplicity=", &rdb::Item::set_multiplicity, gsi::arg ("multiplicity"),
"@brief Sets the item's multiplicity\n"
"@args multiplicity\n"
) +
*/
gsi::method_ext ("add_value", &add_value,
gsi::method_ext ("add_value", &add_value, gsi::arg ("value"),
"@brief Adds a value object to the values of this item\n"
"@args value\n"
"@param value The value to add.\n"
) +
gsi::method_ext ("add_value", &add_value_t<db::DPolygon>,
gsi::method_ext ("add_value", &add_value_t<db::DPolygon>, gsi::arg ("value"),
"@brief Adds a polygon object to the values of this item\n"
"@args value\n"
"@param value The polygon to add.\n"
"This method has been introduced in version 0.25 as a convenience method."
) +
gsi::method_ext ("add_value", &add_value_t<db::DBox>,
gsi::method_ext ("add_value", &add_value_t<db::DBox>, gsi::arg ("value"),
"@brief Adds a box object to the values of this item\n"
"@args value\n"
"@param value The box to add.\n"
"This method has been introduced in version 0.25 as a convenience method."
) +
gsi::method_ext ("add_value", &add_value_t<db::DEdge>,
gsi::method_ext ("add_value", &add_value_t<db::DEdge>, gsi::arg ("value"),
"@brief Adds an edge object to the values of this item\n"
"@args value\n"
"@param value The edge to add.\n"
"This method has been introduced in version 0.25 as a convenience method."
) +
gsi::method_ext ("add_value", &add_value_t<db::DEdgePair>,
gsi::method_ext ("add_value", &add_value_t<db::DEdgePair>, gsi::arg ("value"),
"@brief Adds an edge pair object to the values of this item\n"
"@args value\n"
"@param value The edge pair to add.\n"
"This method has been introduced in version 0.25 as a convenience method."
) +
gsi::method_ext ("add_value", &add_value_t<std::string>,
gsi::method_ext ("add_value", &add_value_t<std::string>, gsi::arg ("value"),
"@brief Adds a string object to the values of this item\n"
"@args value\n"
"@param value The string to add.\n"
"This method has been introduced in version 0.25 as a convenience method."
) +
gsi::method_ext ("add_value", &add_value_t<double>,
gsi::method_ext ("add_value", &add_value_t<double>, gsi::arg ("value"),
"@brief Adds a numeric value to the values of this item\n"
"@args value\n"
"@param value The value to add.\n"
"This method has been introduced in version 0.25 as a convenience method."
) +
@ -1198,32 +1167,28 @@ Class<rdb::Database> decl_ReportDatabase ("rdb", "ReportDatabase",
"@brief Returns the number of items already visited inside the database\n"
"@return The total number of items already visited\n"
) +
gsi::method ("num_items", (size_t (rdb::Database::*) (rdb::id_type, rdb::id_type) const) &rdb::Database::num_items,
gsi::method ("num_items", (size_t (rdb::Database::*) (rdb::id_type, rdb::id_type) const) &rdb::Database::num_items, gsi::arg ("cell_id"), gsi::arg ("category_id"),
"@brief Returns the number of items inside the database for a given cell/category combination\n"
"@args cell_id, category_id\n"
"@param cell_id The ID of the cell for which to retrieve the number\n"
"@param category_id The ID of the category for which to retrieve the number\n"
"@return The total number of items for the given cell and the given category\n"
) +
gsi::method ("num_items_visited", (size_t (rdb::Database::*) (rdb::id_type, rdb::id_type) const) &rdb::Database::num_items_visited,
gsi::method ("num_items_visited", (size_t (rdb::Database::*) (rdb::id_type, rdb::id_type) const) &rdb::Database::num_items_visited, gsi::arg ("cell_id"), gsi::arg ("category_id"),
"@brief Returns the number of items visited already for a given cell/category combination\n"
"@args cell_id, category_id\n"
"@param cell_id The ID of the cell for which to retrieve the number\n"
"@param category_id The ID of the category for which to retrieve the number\n"
"@return The total number of items visited for the given cell and the given category\n"
) +
gsi::method_ext ("create_item", &create_item,
gsi::method_ext ("create_item", &create_item, gsi::arg ("cell_id"), gsi::arg ("category_id"),
"@brief Creates a new item for the given cell/category combination\n"
"@args cell_id, category_id\n"
"@param cell_id The ID of the cell to which the item is associated\n"
"@param category_id The ID of the category to which the item is associated\n"
"\n"
"A more convenient method that takes cell and category objects instead of ID's is the "
"other version of \\create_item.\n"
) +
gsi::method_ext ("create_item", &create_item_from_objects,
gsi::method_ext ("create_item", &create_item_from_objects, gsi::arg ("cell"), gsi::arg ("category"),
"@brief Creates a new item for the given cell/category combination\n"
"@args cell, category\n"
"@param cell The cell to which the item is associated\n"
"@param category The category to which the item is associated\n"
"\n"
@ -1376,38 +1341,32 @@ Class<rdb::Database> decl_ReportDatabase ("rdb", "ReportDatabase",
gsi::iterator_ext ("each_item", &database_items_begin, &database_items_end,
"@brief Iterates over all iterms inside the database\n"
) +
gsi::iterator_ext ("each_item_per_cell", &database_items_begin_cell, &database_items_end_cell,
gsi::iterator_ext ("each_item_per_cell", &database_items_begin_cell, &database_items_end_cell, gsi::arg ("cell_id"),
"@brief Iterates over all iterms inside the database which are associated with the given cell\n"
"@args cell_id\n"
"@param cell_id The ID of the cell for which all associated items should be retrieved\n"
) +
gsi::iterator_ext ("each_item_per_category", &database_items_begin_cat, &database_items_end_cat,
gsi::iterator_ext ("each_item_per_category", &database_items_begin_cat, &database_items_end_cat, gsi::arg ("category_id"),
"@brief Iterates over all iterms inside the database which are associated with the given category\n"
"@args category_id\n"
"@param category_id The ID of the category for which all associated items should be retrieved\n"
) +
gsi::iterator_ext ("each_item_per_cell_and_category", &database_items_begin_cc, &database_items_end_cc,
gsi::iterator_ext ("each_item_per_cell_and_category", &database_items_begin_cc, &database_items_end_cc, gsi::arg ("cell_id"), gsi::arg ("category_id"),
"@brief Iterates over all iterms inside the database which are associated with the given cell and category\n"
"@args cell_id,category_id\n"
"@param cell_id The ID of the cell for which all associated items should be retrieved\n"
"@param category_id The ID of the category for which all associated items should be retrieved\n"
) +
gsi::method ("set_item_visited", &rdb::Database::set_item_visited,
gsi::method ("set_item_visited", &rdb::Database::set_item_visited, gsi::arg ("item"), gsi::arg ("visited"),
"@brief Modifies the visited state of an item\n"
"@args item,visited\n"
"@param item The item to modify\n"
"@param visited True to set the item to visited state, false otherwise\n"
) +
gsi::method ("load", &rdb::Database::load,
gsi::method ("load", &rdb::Database::load, gsi::arg ("filename"),
"@brief Loads the database from the given file\n"
"@args filename\n"
"@param filename The file from which to load the database\n"
"The reader recognizes the format automatically and will choose the appropriate decoder. 'gzip' compressed files are uncompressed "
"automatically.\n"
) +
gsi::method ("save", &rdb::Database::save,
gsi::method ("save", &rdb::Database::save, gsi::arg ("filename"),
"@brief Saves the database to the given file\n"
"@args filename\n"
"@param filename The file to which to save the database\n"
"The database is always saved in KLayout's XML-based format.\n"
),
@ -1432,9 +1391,8 @@ static void tp_output_rdb (db::TilingProcessor *proc, const std::string &name, r
// extend the db::TilingProcessor with the ability to feed images
static
gsi::ClassExt<db::TilingProcessor> tiling_processor_ext (
method_ext ("output", &tp_output_rdb,
method_ext ("output", &tp_output_rdb, gsi::arg ("name"), gsi::arg ("rdb"), gsi::arg ("cell_id"), gsi::arg ("category_id"),
"@brief Specifies output to a report database\n"
"@args name, rdb, cell_id, category_id\n"
"This method will establish an output channel for the processor. The output sent to that channel "
"will be put into the report database given by the \"rdb\" parameter. \"cell_id\" specifies the "
"cell and \"category_id\" the category to use.\n"
@ -1446,4 +1404,3 @@ gsi::ClassExt<db::TilingProcessor> tiling_processor_ext (
);
}