Changeset 2155 in kBuild for trunk

Timestamp:

Dec 29, 2008 1:01:43 AM (16 years ago)

Author:

bird

Message:

kmk quick ref: added new string functions.

Location:

trunk/kBuild/doc

Files:

• QuickReference-kmk.html (modified) (1 diff)
• QuickReference-kmk.txt (modified) (1 diff)

trunk/kBuild/doc/QuickReference-kmk.html

@@ -698 +698 @@
 <pre class="literal-block">
 $(printf fmt, arg...)
+</pre>
+<p>Return the length of a string or a (unexpanded) variable:</p>
+<pre class="literal-block">
+$(length string)
+$(length-var var)
+</pre>
+<p>Find the position of <tt class="docutils literal"><span class="pre">needle</span></tt> in <tt class="docutils literal"><span class="pre">haystack</span></tt>, returns 0 if not found.
+Negative <tt class="docutils literal"><span class="pre">start</span></tt> indices are relative to the end of <tt class="docutils literal"><span class="pre">haystack</span></tt>, while
+positive ones are one based:</p>
+<pre class="literal-block">
+$(pos needle, haystack[, start])
+$(lastpos needle, haystack[, start])
+</pre>
+<p>Returns the specified substring. The <tt class="docutils literal"><span class="pre">start</span></tt> works like with <tt class="docutils literal"><span class="pre">$(pos</span> <span class="pre">)</span></tt>.
+If the substring is partially outside the <tt class="docutils literal"><span class="pre">string</span></tt> the result will be
+padded with <tt class="docutils literal"><span class="pre">pad</span></tt> if present:</p>
+<pre class="literal-block">
+$(substr string, start[, length[, pad]])
+</pre>
+<p>Insert <tt class="docutils literal"><span class="pre">in</span></tt> into <tt class="docutils literal"><span class="pre">str</span></tt> at the specified position. <tt class="docutils literal"><span class="pre">n</span></tt> works like with
+<tt class="docutils literal"><span class="pre">$(pos</span> <span class="pre">)</span></tt>, except that <tt class="docutils literal"><span class="pre">0</span></tt> is the end of the string:</p>
+<pre class="literal-block">
+$(insert in, str[, n[, length[, pad]]])
+</pre>
+<p>Translate <tt class="docutils literal"><span class="pre">string</span></tt> exchanging characters in <tt class="docutils literal"><span class="pre">from-set</span></tt> with <tt class="docutils literal"><span class="pre">to-set</span></tt>,
+optionally completing <tt class="docutils literal"><span class="pre">to-set</span></tt> with <tt class="docutils literal"><span class="pre">pad-char</span></tt> if specified. If no
+<tt class="docutils literal"><span class="pre">pad-char</span></tt> characters absent in <tt class="docutils literal"><span class="pre">to-set</span></tt> will be deleted:</p>
+<pre class="literal-block">
+$(translate string, from-set[, to-set[, pad-char]])
 </pre>
 </blockquote>

trunk/kBuild/doc/QuickReference-kmk.txt

@@ -340 +340 @@
         $(printf fmt, arg...)
 
+    Return the length of a string or a (unexpanded) variable::
+
+        $(length string)
+        $(length-var var)
+
+    Find the position of ``needle`` in ``haystack``, returns 0 if not found.
+    Negative ``start`` indices are relative to the end of ``haystack``, while
+    positive ones are one based::
+
+        $(pos needle, haystack[, start])
+        $(lastpos needle, haystack[, start])
+
+    Returns the specified substring. The ``start`` works like with ``$(pos )``.
+    If the substring is partially outside the ``string`` the result will be
+    padded with ``pad`` if present::
+
+        $(substr string, start[, length[, pad]])
+
+    Insert ``in`` into ``str`` at the specified position. ``n`` works like with
+    ``$(pos )``, except that ``0`` is the end of the string::
+
+        $(insert in, str[, n[, length[, pad]]])
+
+    Translate ``string`` exchanging characters in ``from-set`` with ``to-set``,
+    optionally completing ``to-set`` with ``pad-char`` if specified. If no
+    ``pad-char`` characters absent in ``to-set`` will be deleted::
+
+        $(translate string, from-set[, to-set[, pad-char]])
+
 
 Functions for file names: