diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2023-08-09 08:54:37 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2023-08-09 08:54:37 +0200 |
| commit | 2109dedc473944dbb38756cd48d0c44f996304c4 (patch) | |
| tree | 70544a43e6e403c7874cb250195346503edbe716 /libbuild2/functions-integer.cxx | |
| parent | d7b3619dad84f4f24aa3ab6629246a3324bdc2cd (diff) | |
Complete and cleanup function documentation in preparation for auto-extraction
Also:
- Move the $target.*() function family from functions-name.cxx to separate
functions-target.cxx.
- Get rid of the separate $process_path_ex.*() family, merging it with
$process_path.*().
Diffstat (limited to 'libbuild2/functions-integer.cxx')
| -rw-r--r-- | libbuild2/functions-integer.cxx | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/libbuild2/functions-integer.cxx b/libbuild2/functions-integer.cxx index a634ae9..934f753 100644 --- a/libbuild2/functions-integer.cxx +++ b/libbuild2/functions-integer.cxx @@ -69,6 +69,16 @@ namespace build2 // $string(<int64>) // $string(<uint64>[, <base>[, <width>]]) // + // Convert an integer to a string. For unsigned integers we can specify + // the desired base and width. For example: + // + // x = [uint64] 0x0000ffff + // + // c.poptions += "-DOFFSET=$x" # -DOFFSET=65535 + // c.poptions += "-DOFFSET=$string($x, 16)" # -DOFFSET=0xffff + // c.poptions += "-DOFFSET=$string($x, 16, 8)" # -DOFFSET=0x0000ffff + // + // Note that we don't handle NULL values for these type since they have no // empty representation. // @@ -82,9 +92,10 @@ namespace build2 // $integer_sequence(<begin>, <end>[, <step>]) // // Return the list of uint64 integers starting from <begin> (including) to - // <end> (excluding) with the specified <step> or 1 if unspecified. If + // <end> (excluding) with the specified <step> or `1` if unspecified. If // <begin> is greater than <end>, empty list is returned. // + // Note that currently negative numbers are not supported but this could // be handled if required (e.g., by returning int64s in this case). // @@ -123,7 +134,7 @@ namespace build2 // // The following flags are supported: // - // dedup - in addition to sorting also remove duplicates + // dedup - in addition to sorting also remove duplicates // f["sort"] += [](int64s v, optional<names> fs) { @@ -164,7 +175,7 @@ namespace build2 // $find_index(<ints>, <int>) // // Return the index of the first element in the integer sequence that is - // equal to the specified integer or $size(<ints>) if none is found. + // equal to the specified integer or `$size(ints)` if none is found. // f["find_index"] += [](int64s vs, value v) { |