Added doc for DRC fill.

src/drc/drc/built-in-macros/_drc_layer.rb

@@ -3894,7 +3894,76 @@ CODE
       end
     end
 
-    # Experimental
+    # %DRC%
+    # @name fill
+    # @brief Fills the region with regular pattern of shapes
+    # @synopsis layer.fill([ options ])
+    #
+    # This method will attempt to fill the polygons of the layer with a regular pattern
+    # of shapes.
+    #  
+    # The fill function currently is not available in deep mode.
+    #
+    # Options are:
+    # @ul
+    # @li @b hstep(x) @/b or @b hstep(x, y) @/b: specifies the horizontal step pitch of the pattern. x must be 
+    #     a positive value. A vertical displacement component can be specified too, which results in a skewed pattern. @/li
+    # @li @b vstep(y) @/b or @b vstep(x, y) @/b: specifies the vertical step pitch of the pattern. y must be 
+    #     a positive value. A horizontal displacement component can be specified too, which results in a skewed pattern. @/li
+    # @li @b origin(x, y) @/b: specifies a fixed point to align the pattern with. This point specifies the location
+    #     of the reference point for one pattern cell. @/li
+    # @li @b auto_origin @/b: lets the algorithm choose the origin. This may result is a slightly better fill coverage
+    #     as the algorithm is able to determine a pattern origin per fill island. @/li
+    # @li @b fill_pattern(..) @/b: specifies the fill pattern. @/li
+    # @/ul
+    #
+    # "fill_pattern" generates a fill pattern object. This object is used for configuring the fill pattern
+    # content. Fill pattern need to be named. The name will be used for generating the fill cell.
+    #
+    # To provide a fill pattern, create a fill pattern object and add shapes to it. The following example creates
+    # a fill pattern named "FILL_CELL" and adds a 1x1 micron box on layer 1/0:
+    #
+    # @code
+    # p = fill_pattern("FILL_CELL")
+    # p.shape(1, 0, box(0.0, 0.0, 1.0, 1.0))
+    # @/code
+    # 
+    # See \global#box for details about the box specification. You can also add paths or polygons with \global#path or \global#polygon.
+    # 
+    # A more compact way of writing this is:
+    #
+    # @code
+    # p = fill_pattern("FILL_CELL").shape(1, 0, box(0.0, 0.0, 1.0, 1.0))
+    # @/code
+    #
+    # The fill pattern can be given a reference point which is used for placing the pattern. The reference point
+    # is the one which is aligned with the pattern origin. The following code will assign (-0.5, -0.5) as the reference
+    # point for the 1x1 micron rectangle. Hence the reference point is a little below and left of the rectangle which 
+    # in turn shifts the rectangle fill pattern to the right and up:
+    #
+    # @code
+    # p = fill_pattern("FILL_CELL")
+    # p.shape(1, 0, box(0.0, 0.0, 1.0, 1.0))
+    # p.origin(-0.5, -0.5)
+    # @/code
+    #
+    # Without a reference point given, the lower left corner of the fill pattern's bounding box will be used
+    # as the reference point.
+    #
+    # With these ingredients will can use the fill function. The first example fills the polygons
+    # of "to_fill" with an orthogonal pattern of 1x1 micron rectangles with a pitch of 2 microns:
+    #
+    # @code
+    # pattern = fill_pattern("FILL_CELL").shape(1, 0, box(0.0, 0.0, 1.0, 1.0)).origin(-0.5, -0.5)
+    # to_fill.fill(pattern, hstep(2.0), vstep(2.0))
+    # @/code
+    #
+    # This second example will create a skewed fill pattern in auto-origin mode:
+    #  
+    # @code
+    # pattern = fill_pattern("FILL_CELL").shape(1, 0, box(0.0, 0.0, 1.0, 1.0)).origin(-0.5, -0.5)
+    # to_fill.fill(pattern, hstep(2.0, 1.0), vstep(-1.0, 2.0), auto_origin)
+    # @/code
     
     def fill(*args)
 

src/lay/lay/doc/about/drc_ref_drc.xml

@@ -72,6 +72,7 @@ The following global functions are relevant for the DRC expressions:
 <li><a href="/about/drc_ref_global.xml#space">space</a> </li>
 <li><a href="/about/drc_ref_global.xml#squares">squares</a> </li>
 <li><a href="/about/drc_ref_global.xml#width">width</a> </li>
+<li><a href="/about/drc_ref_global.xml#with_holes">with_holes</a> </li>
 </ul>
 </p><p>
 The following documentation will list the methods available for DRC expression objects.
@@ -921,6 +922,22 @@ out = in.drc(primary.squares)    # equivalent
 This method acts on edge expressions and delivers a specific part of each edge.
 See <a href="/about/drc_ref_layer.xml#start_segments">layer#start_segments</a> for details about this functionality.
 </p>
+<a name="with_holes"/><h2>"with_holes" - Selects all input polygons with the specified number of holes</h2>
+<keyword name="with_holes"/>
+<p>Usage:</p>
+<ul>
+<li><tt>expression.with_holes (in condition)</tt></li>
+</ul>
+<p>
+This operation can be used as a plain function in which case it acts on primary
+shapes or can be used as method on another DRC expression.
+The following example selects all polygons with more than 2 holes:
+</p><p>
+<pre>
+out = in.drc(with_holes &gt; 2)
+out = in.drc(primary.with_holes &gt; 2)   # equivalent
+</pre>
+</p>
 <a name="|"/><h2>"|" - Boolean OR between the results of two expressions</h2>
 <keyword name="|"/>
 <p>Usage:</p>

src/lay/lay/doc/about/drc_ref_global.xml

@@ -1775,6 +1775,15 @@ In verbose mode, more output is generated in the log file
 <p>
 In verbose mode, more output is generated in the log file
 </p>
+<a name="warn"/><h2>"warn" - Prints a warning</h2>
+<keyword name="warn"/>
+<p>Usage:</p>
+<ul>
+<li><tt>warn(message)</tt></li>
+</ul>
+<p>
+Similar to <a href="#log">log</a>, but the message is printed formatted as a warning
+</p>
 <a name="width"/><h2>"width" - Performs a width check</h2>
 <keyword name="width"/>
 <p>Usage:</p>
@@ -1847,6 +1856,17 @@ shape.
 </tr>
 </table>
 </p>
+<a name="with_holes"/><h2>"with_holes" - Selects all input polygons according to their number of holes in DRC expressions</h2>
+<keyword name="with_holes"/>
+<p>Usage:</p>
+<ul>
+<li><tt>with_holes (in condition)</tt></li>
+</ul>
+<p>
+"with_holes" represents a polygon selector for
+<a href="/about/drc_ref_drc.xml">DRC</a> expressions selecting polygons of the primary by their number of holes
+(see <a href="/about/drc_ref_layer.xml#drc">Layer#drc</a> and <a href="/about/drc_ref_drc.xml#with_holes">DRC#with_holes</a> for more details).
+</p>
 <a name="write_spice"/><h2>"write_spice" - Defines SPICE output format (with options)</h2>
 <keyword name="write_spice"/>
 <p>Usage:</p>

src/lay/lay/doc/about/drc_ref_layer.xml

@@ -1023,6 +1023,79 @@ The following images show the effect of the extents method:
 </tr>
 </table>
 </p>
+<a name="fill"/><h2>"fill" - Fills the region with regular pattern of shapes</h2>
+<keyword name="fill"/>
+<p>Usage:</p>
+<ul>
+<li><tt>layer.fill([ options ])</tt></li>
+</ul>
+<p>
+This method will attempt to fill the polygons of the layer with a regular pattern
+of shapes.
+</p><p>
+The fill function currently is not available in deep mode.
+</p><p>
+Options are:
+<ul>
+<li><b>hstep(x) </b>or <b>hstep(x, y) </b>: specifies the horizontal step pitch of the pattern. x must be 
+a positive value. A vertical displacement component can be specified too, which results in a skewed pattern. </li>
+<li><b>vstep(y) </b>or <b>vstep(x, y) </b>: specifies the vertical step pitch of the pattern. y must be 
+a positive value. A horizontal displacement component can be specified too, which results in a skewed pattern. </li>
+<li><b>origin(x, y) </b>: specifies a fixed point to align the pattern with. This point specifies the location
+of the reference point for one pattern cell. </li>
+<li><b>auto_origin </b>: lets the algorithm choose the origin. This may result is a slightly better fill coverage
+as the algorithm is able to determine a pattern origin per fill island. </li>
+<li><b>fill_pattern(..) </b>: specifies the fill pattern. </li>
+</ul>
+</p><p>
+"fill_pattern" generates a fill pattern object. This object is used for configuring the fill pattern
+content. Fill pattern need to be named. The name will be used for generating the fill cell.
+</p><p>
+To provide a fill pattern, create a fill pattern object and add shapes to it. The following example creates
+a fill pattern named "FILL_CELL" and adds a 1x1 micron box on layer 1/0:
+</p><p>
+<pre>
+p = fill_pattern("FILL_CELL")
+p.shape(1, 0, box(0.0, 0.0, 1.0, 1.0))
+</pre>
+</p><p>
+See <a href="/about/drc_ref_global.xml#box">box</a> for details about the box specification. You can also add paths or polygons with <a href="/about/drc_ref_global.xml#path">path</a> or <a href="/about/drc_ref_global.xml#polygon">polygon</a>.
+</p><p>
+A more compact way of writing this is:
+</p><p>
+<pre>
+p = fill_pattern("FILL_CELL").shape(1, 0, box(0.0, 0.0, 1.0, 1.0))
+</pre>
+</p><p>
+The fill pattern can be given a reference point which is used for placing the pattern. The reference point
+is the one which is aligned with the pattern origin. The following code will assign (-0.5, -0.5) as the reference
+point for the 1x1 micron rectangle. Hence the reference point is a little below and left of the rectangle which 
+in turn shifts the rectangle fill pattern to the right and up:
+</p><p>
+<pre>
+p = fill_pattern("FILL_CELL")
+p.shape(1, 0, box(0.0, 0.0, 1.0, 1.0))
+p.origin(-0.5, -0.5)
+</pre>
+</p><p>
+Without a reference point given, the lower left corner of the fill pattern's bounding box will be used
+as the reference point.
+</p><p>
+With these ingredients will can use the fill function. The first example fills the polygons
+of "to_fill" with an orthogonal pattern of 1x1 micron rectangles with a pitch of 2 microns:
+</p><p>
+<pre>
+pattern = fill_pattern("FILL_CELL").shape(1, 0, box(0.0, 0.0, 1.0, 1.0)).origin(-0.5, -0.5)
+to_fill.fill(pattern, hstep(2.0), vstep(2.0))
+</pre>
+</p><p>
+This second example will create a skewed fill pattern in auto-origin mode:
+</p><p>
+<pre>
+pattern = fill_pattern("FILL_CELL").shape(1, 0, box(0.0, 0.0, 1.0, 1.0)).origin(-0.5, -0.5)
+to_fill.fill(pattern, hstep(2.0, 1.0), vstep(-1.0, 2.0), auto_origin)
+</pre>
+</p>
 <a name="first_edges"/><h2>"first_edges" - Returns the first edges of an edge pair collection</h2>
 <keyword name="first_edges"/>
 <p>Usage:</p>
@@ -3074,6 +3147,18 @@ bounding box.
 </p><p>
 This method is available for polygon layers only.
 </p>
+<a name="with_holes"/><h2>"with_holes" - Selects all polygons with the specified number of holes</h2>
+<keyword name="with_holes"/>
+<p>Usage:</p>
+<ul>
+<li><tt>layer.with_holes(count)</tt></li>
+<li><tt>layer.with_holes(min_count, max_count)</tt></li>
+<li><tt>layer.with_holes(min_count .. max_count)</tt></li>
+</ul>
+<p>
+This method is available for polygon layers. It will select all polygons from the input layer
+which have the specified number of holes.
+</p>
 <a name="with_length"/><h2>"with_length" - Selects edges by their length</h2>
 <keyword name="with_length"/>
 <p>Usage:</p>
@@ -3228,6 +3313,18 @@ bounding box.
 </p><p>
 This method is available for polygon layers only.
 </p>
+<a name="without_holes"/><h2>"without_holes" - Selects all polygons with the specified number of holes</h2>
+<keyword name="without_holes"/>
+<p>Usage:</p>
+<ul>
+<li><tt>layer.without_holes(count)</tt></li>
+<li><tt>layer.without_holes(min_count, max_count)</tt></li>
+<li><tt>layer.without_holes(min_count .. max_count)</tt></li>
+</ul>
+<p>
+This method is available for polygon layers. It will select all polygons from the input layer
+which do not have the specified number of holes.
+</p>
 <a name="without_length"/><h2>"without_length" - Selects edges by the their length</h2>
 <keyword name="without_length"/>
 <p>Usage:</p>