Functions: Difference between revisions

From NEOSYS Dev Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 1: Line 1:
<html>


<!DOCTYPE html>
<!DOCTYPE html>
<html>
<html>
<head>
<head>
<!-- highlight.js for c++ syntax highlighting -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/cpp.min.js"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/monokai.min.css">
<!-- done below <script>hljs.highlightAll();</script> -->
<style>
/* custom-theme.css */
.hljs {
    display: block;
    overflow-x: auto;
    padding: 0.5em;
    background: #ffffff; /* White background */
    color: #000000; /* Black text for non-highlighted code */
}
/* Keywords (both C++ and custom) in bold green */
.hljs-keyword {
    color: #008000; /* Green */
    font-weight: bold;
}
/* Optional: Style other elements for contrast */
.hljs-string {
    color: #a31515; /* Red for strings */
}
.hljs-number {
    color: #0000ff; /* Blue for numbers */
}
.hljs-comment {
    color: #008080; /* Teal for comments */
}
</style>


<!-- bootstrap css. Is this necessary? -->
<!-- bootstrap css. Is this necessary? -->
Line 103: Line 62:
border-collapse: collapse;
border-collapse: collapse;
}
}
    img {
img {
        border: 0;
border: 0;
        vertical-align: middle
vertical-align: middle
    }
}


    hr {
hr {
        height: 1px;
height: 1px;
        background-color: #a2a9b1;
background-color: #a2a9b1;
        border: 0;
border: 0;
        margin: 0.2em 0
margin: 0.2em 0
    }
}


    h1,h2,h3,h4,h5,h6 {
h1,h2,h3,h4,h5,h6 {
        color: #000;
color: #000;
        margin: 0;
margin: 0;
        padding-top: 0.5em;
padding-top: 0.5em;
        padding-bottom: 0.17em;
padding-bottom: 0.17em;
        overflow: hidden
overflow: hidden
    }
}


    h1,h2 {
h1,h2 {
        margin-bottom: 0.6em;
margin-bottom: 0.6em;
        border-bottom: 1px solid #a2a9b1
border-bottom: 1px solid #a2a9b1
    }
}


    h3,h4,h5 {
h3,h4,h5 {
        margin-bottom: 0.3em
margin-bottom: 0.3em
    }
}


    h1 {
h1 {
        font-size: 188%;
font-size: 188%;
        font-weight: normal
font-weight: normal
    }
}


    h2 {
h2 {
        font-size: 150%;
font-size: 150%;
        font-weight: normal
font-weight: normal
    }
}


    h3 {
h3 {
        font-size: 128%
font-size: 128%
    }
}


    h4 {
h4 {
        font-size: 116%
font-size: 116%
    }
}


    h5 {
h5 {
        font-size: 108%
font-size: 108%
    }
}


    h6 {
h6 {
        font-size: 100%
font-size: 100%
    }
}


    p {
p {
        margin: 0.4em 0 0.5em 0
margin: 0.4em 0 0.5em 0
    }
}


    p img {
p img {
        margin: 0
margin: 0
    }
}


    ul {
ul {
        margin: 0.3em 0 0 1.6em;
margin: 0.3em 0 0 1.6em;
        padding: 0
padding: 0
    }
}


    ol {
ol {
        margin: 0.3em 0 0 3.2em;
margin: 0.3em 0 0 3.2em;
        padding: 0;
padding: 0;
        list-style-image: none
list-style-image: none
    }
}


    li {
li {
        margin-bottom: 0.1em
margin-bottom: 0.1em
    }
}


    dt {
dt {
        font-weight: bold;
font-weight: bold;
        margin-bottom: 0.1em
margin-bottom: 0.1em
    }
}


    dl {
dl {
        margin-top: 0.2em;
margin-top: 0.2em;
        margin-bottom: 0.5em
margin-bottom: 0.5em
    }
}


    dd {
dd {
        margin-left: 1.6em;
margin-left: 1.6em;
        margin-bottom: 0.1em
margin-bottom: 0.1em
    }
}


.gendoc_function {
.gendoc_function {
    color: #800;
color: #800;
    font-weight: 700;
font-weight: 700;
}
}


</style>
</style>
<style>
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }




</head>
<body>
<div class=toc>
<h3>Contents:</h4>
<ol>
<li><a href=#var>var</a></li>
<li><a href=#dim>dim</a></li>
<li><a href=#exoprog>exoprog</a></li>


</ol>
/* Highlight and Error */
</div>
:root {
  --highlight-bg-color: #ffffcc;
  --error-border-color: #FF0000;
  --highlight-font-weight: normal;
  --highlight-font-style: normal;
  --master-bold: bold; /*var(--master-bold)*/
  --master-italic: normal; /*var(--master-italic)*/
}
.hll { background-color: var(--highlight-bg-color); font-weight: var(--highlight-font-weight); font-style: var(--highlight-font-style); }
.err { border: 1px solid var(--error-border-color); font-weight: var(--highlight-font-weight); font-style: var(--highlight-font-style); } /* Error */


<div class=toc>
/* Comments */
<h4 id=var>Contents:</h4>
:root {
<ol>
  --comment-main-color: #3D7B7B;
<li><a href=#Var_Creation_>Var Creation </a></li>
  --comment-preproc-color: #9C6500;
<li><a href=#Arithmetical_Operators_>Arithmetical Operators </a></li>
  --comment-font-weight: var(--master-bold);
<li><a href=#Dynamic_Array_Creation,_Access_And_Update>Dynamic Array Creation, Access And Update</a></li>
  --comment-font-style: var(--master-italic);
<li><a href=#String_Creation_>String Creation </a></li>
}
<li><a href=#String_Scanning>String Scanning</a></li>
.c  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment */
<li><a href=#String_Conversion_-_Non-Mutating_-_Chainable>String Conversion - Non-Mutating - Chainable</a></li>
.ch  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Hashbang */
<li><a href=#String_Mutation_-_Standalone_Commands>String Mutation - Standalone Commands</a></li>
.cm  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Multiline */
<li><a href=#I/O_Conversion>I/O Conversion</a></li>
.cp  { color: var(--comment-preproc-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Preproc */
<li><a href=#Dynamic_Array_Functions>Dynamic Array Functions</a></li>
.cpf { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.PreprocFile */
<li><a href=#Dynamic_Array_Filters>Dynamic Array Filters</a></li>
.c1  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Single */
<li><a href=#Dynamic_Array_Mutators_Standalone_Commands>Dynamic Array Mutators Standalone Commands</a></li>
.cs  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Special */
<li><a href=#Dynamic_Array_Search>Dynamic Array Search</a></li>
 
<li><a href=#Database_Access>Database Access</a></li>
/* Keywords */
<li><a href=#Database_Management>Database Management</a></li>
:root {
<li><a href=#Database_File_I/O>Database File I/O</a></li>
  --keyword-main-color: #008000; /*green*/
<li><a href=#Database_Sort/Select>Database Sort/Select</a></li>
  --keyword-type-color: #B00040; /*reddish*/
<li><a href=#OS_Time/Date>OS Time/Date</a></li>
  --keyword-flow-color: #FF5722; /*orange*/
<li><a href=#OS_File_I/O>OS File I/O</a></li>
  --keyword-cnst-color: #FF0000; /*red*/
<li><a href=#OS_Directories>OS Directories</a></li>
  --keyword-font-weight: var(--master-bold);
<li><a href=#OS_Shell/Environment>OS Shell/Environment</a></li>
  --keyword-font-style: normal;
<li><a href=#Output>Output</a></li>
}
<li><a href=#Input>Input</a></li>
.k  { color: var(--keyword-main-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword */
<li><a href=#Math/Boolean>Math/Boolean</a></li>
.kc  { color: var(--keyword-cnst-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Constant */
<li><a href=#I/O_Conversion_Codes_>I/O Conversion Codes </a></li>


</ol>
/* used in exodus_cpp.py EXTRA_DECLARATIONS 'func', 'subr', 'function', 'subroutine' */
</div>
.kd  { color: var(--keyword-main-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /*Keyword.Declaration*/


.kn  { color: var(--keyword-main-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Namespace */
.kp  { color: var(--keyword-main-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Pseudo */


<h5 id=Var_Creation_>Var Creation </h5>
/* used in exodus_cpp.py EXTRA_FLOW_CONTROL 'stop', 'abort', 'abortall', 'call', 'gosub' */
.kr  { color: var(--keyword-flow-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Reserved */


<table class=wikitable>
/* used in exodus_cpp.py EXTRA_TYPES 'dim', 'var', '_var', 'rex', '_rex', 'let', 'in', 'out', 'io', 'qqqqqqq'
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
        'programexit', 'programinit',
<tr><td></td><td>var v1;</td><td><p>Create an unassigned var.
        'libraryinit', 'libraryexit',
</p>
        'commoninit', 'commonexit',
<p>Unassigned variables can be assigned conditionally in if/else statements or used as outbound arguments of function calls.
        'dictinit', 'dictexit'*/
</p>
.kt  { color: var(--keyword-type-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Type */
A runtime error is thrown if a var is used before being assigned so silent "use before assign" bugs cannot occur.


<pre><code class='language-cpp'>var client; // Unassigned var
/* Operators */
if (not read(client from "xo_clients", "SB001")) ...</code></pre>
:root {
  --operator-main-color: #666666;
  --operator-word-color: #AA22FF;
  --operator-font-weight: var(--master-bold);
  --operator-font-style: normal;
}
.o  { color: var(--operator-main-color); font-weight: var(--operator-font-weight); font-style: var(--operator-font-style); } /* Operator */
.ow  { color: var(--operator-word-color); font-weight: var(--operator-font-weight); font-style: var(--operator-font-style); } /* Operator.Word */


</td></tr>
/* Literals */
<tr><td></td><td>var v1 = expression;</td><td><p>Assign a var using a literal or an expression.
:root {
</p>
  --literal-color: #0000FF;                    /* Unified color (using original string main color as default) */
Use "let" instead of "var" wherever possible as a shorthand way of writing "const var".
  --literal-font-weight: var(--master-bold);    /* Unified weight (defaulting to normal) */
  --literal-font-style: var(--master-italic);  /* Unified style (defaulting to normal) */
}
.m  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.Number */
.mb  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.Number.Bin */
.mf  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.Number.Float */
.mh  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.Number.Hex */
.mi  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.Number.Integer */
.mo  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.Number.Oct */
.il  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.Number.Integer.Long */
.nb  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Name.Builtin (Really Literal.Number.Boolean?) */
.s  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String */
.sa  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Affix */
.sb  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Backtick */
.sc  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Char */
.dl  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Delimiter */
.sd  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Doc */
.s2  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Double */
.se  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Escape */
.sh  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Heredoc */
.si  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Interpol */
.sx  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Other */
.sr  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Regex */
.s1  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Single */
.ss  { color: var(--literal-color); font-weight: var(--literal-font-weight); font-style: var(--literal-font-style); } /* Literal.String.Symbol */


<pre><code class='language-cpp'>var v1 = 42;                 // Integer
/* Unidentified Names - Perhaps the most important part of a program strangely unhighlighted by pygmentize default style.*/
var v2 = 42.3;               // Double
:root {
var v3 = "abc";             // String
  --unidentified-color: #000000;
var v4 = 'x';               // char
  --unidentified-font-weight: var(--master-bold);
var v5 = true;               // bool
  --unidentified-font-style: normal;
}
.n  { color: var(--unidentified-color); font-weight: var(--unidentified-font-weight); font-style: var(--unidentified-font-style); } /* Unidentified */


var v6 = v1 + 100;           // Arithmetic
/* Names */
var v7 = v3 ^ "xyz";         // Concatenation
:root {
var v8 = oslist(".").sort(); // Built in functions
  --name-attribute-color: #687822;
  --name-builtin-color: #008000;
  --name-class-color: #B00040; /* same as .kt keyword type color to be like types*/
  --name-constant-color: #880000;
  --name-decorator-color: #AA22FF;
  --name-entity-color: #717171;
  --name-exception-color: #CB3F38;
  --name-label-color: #767600;
  --name-tag-color: #008000;
  --name-variable-color: #19177C;
  --name-font-weight: var(--master-bold);
  --name-font-style: normal;
}
.na  { color: var(--name-attribute-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Attribute */
.nc  { color: var(--name-class-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Class */
.no  { color: var(--name-constant-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Constant */
.nd  { color: var(--name-decorator-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Decorator */
.ni  { color: var(--name-entity-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Entity */
.ne  { color: var(--name-exception-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Exception */


let v9 = 12345;             // A const var
/* used in exodus_cpp.py EXTRAC_FUNCTIONS massive list*/
.nf  { color: var(--name-class-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Function */


var v10 = 12'345_var;       // A literal var integer
.nl  { color: var(--name-label-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Label */
var v11 = 123.45_var;       // A literal var double
.nn  { color: var(--name-class-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Namespace */
var v12 = "f1^v1]v2^f3"_var; // A literal var string
.nt  { color: var(--name-tag-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Tag */
.nv  { color: var(--name-variable-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Variable */
.bp  { color: var(--name-builtin-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Builtin.Pseudo */
.fm  { color: var(--name-class-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Function.Magic */
.vc  { color: var(--name-variable-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Variable.Class */
.vg  { color: var(--name-variable-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Variable.Global */
.vi  { color: var(--name-variable-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Variable.Instance */
.vm  { color: var(--name-variable-color); font-weight: var(--name-font-weight); font-style: var(--name-font-style); } /* Name.Variable.Magic */


var x = 0.1, y = "0.2", z = x + y; // z -> 0.3</code></pre>
/* Generic */
:root {
  --generic-deleted-color: #A00000;
  --generic-error-color: #E40000;
  --generic-heading-color: #000080;
  --generic-inserted-color: #008400;
  --generic-output-color: #717171;
  --generic-subheading-color: #800080;
  --generic-traceback-color: #0044DD;
  --generic-font-weight: var(--master-bold);
  --generic-font-style: italic;
}
.gd  { color: var(--generic-deleted-color); font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Deleted */
.ge  { font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Emph */
.ges { font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.EmphStrong */
.gr  { color: var(--generic-error-color); font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Error */
.gh  { color: var(--generic-heading-color); font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Heading */
.gi  { color: var(--generic-inserted-color); font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Inserted */
.go  { color: var(--generic-output-color); font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Output */
.gp  { color: var(--generic-heading-color); font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Prompt */
.gs  { font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Strong */
.gu  { color: var(--generic-subheading-color); font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Subheading */
.gt  { color: var(--generic-traceback-color); font-weight: var(--generic-font-weight); font-style: var(--generic-font-style); } /* Generic.Traceback */


</td></tr>
/* Whitespace */
<tr><td>if</td><td>v1.assigned()</td><td>
:root {
<em>Returns:</em> True if the var is assigned, otherwise false</td></tr>
  --whitespace-color: #bbbbbb;
<tr><td>if</td><td>v1.unassigned()</td><td>
  --text-font-weight: normal;
<em>Returns:</em> True if the var is unassigned, otherwise false</td></tr>
  --text-font-style: normal;
<tr><td>var=</td><td>v2.or_default(defaultvalue)</td><td>
}
<p><em>Returns:</em> A copy of the var if it is assigned or the default value if it is not.
.w  { color: var(--whitespace-color); font-weight: var(--text-font-weight); font-style: var(--text-font-style); } /* Text.Whitespace */
</p>
<p>Can be used to handle optional arguments in functions.
</p>
<p><em>defaultvalue:</em> Cannot be unassigned.


<pre><code class='language-cpp'>var v1; // Unassigned
var v2 = v1.or_default("abc"); // v2 -> "abc"
// or
var v3 = or_default(v1, "abc");</code></pre>




</p>
<p><em>Mutator:</em> defaulter()
</p>
</td></tr>
<tr><td></td><td>v1.defaulter(defaultvalue)</td><td><p>If the var is unassigned then assign the default value to it, otherwise do nothing.
</p>
<em>defaultvalue:</em> Cannot be unassigned.


<pre><code class='language-cpp'>var v1; // Unassigned
v1.defaulter("abc"); // v1 -> "abc"
// or
defaulter(v1, "abc");</code></pre>


</td></tr>
<tr><td></td><td>v1.swap(io v2)</td><td><p>Swap the contents of one var with another.
</p>
<p>Useful for stashing large strings quickly. They are moved using pointers without making copies or allocating memory.
</p>
Eiher or both variables may be unassigned.


<pre><code class='language-cpp'>var v1 = space(65'536);
var v2 = "";
v1.swap(v2); // v1 -> "" // v2.len() -> 65'536
// or
swap(v1, v2);</code></pre>


</td></tr>
<tr><td>var=</td><td>v2.move()</td><td><p>Force the contents of a var to be moved instead of copied. The moved var becomes an empty string.
</p>
<p>This allows large strings to be handled efficiently. They are moved using pointers without making copies or allocating memory.
</p>
The moved var must be assigned otherwise a VarUnassigned error is thrown.


<pre><code class='language-cpp'>var v1 = space(65'536);
var v2 = v1.move(); // v2.len() -> 65'536 // v1 -> ""
// or
var v3 = move(v2);</code></pre>


</td></tr>
<tr><td>var=</td><td>v2.clone()</td><td><p>Returns a copy of the var.
</p>
The cloned var may be unassigned, in which case the copy will be unassigned too.


<pre><code class='language-cpp'>var v1 = "abc";
</style>
var v2 = v1.clone(); // "abc"
</head>
// or
<body class="light">
var v3 = clone(v2);</code></pre>
<div class=toc>
<h3>Sections:</h3>
<ol>
<li><a href=#var>var</a></li>
<li><a href=#dim>dim</a></li>
<li><a href=#exoprog>exoprog</a></li>


</td></tr>
</ol>
<tr><td>var=</td><td>v1.dump()</td><td><p>Return a string describing internal data of a var.
</div>
</p>
<p>If the str is located on the heap then its address is given.
</p>
<p><em>typ:</em>
</p>
<p>0x01 str is available.
</p>
<p>0x02 int is available.
</p>
<p>0x04 dbl is available.
</p>
<p>0x08 nan: str is not a number.
</p>
0x16 osfile: str, int and dbl have special meaning.


<pre><code class='language-cpp'>var v1 = str("x", 32);
<div class=toc>
v1.dump().outputl(); /// e.g. var:0x7ffea7462cd0 typ:1 str:0x584d9e9f6e70 "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
<h4 id=var>Contents:</h4>
// or
<ol>
outputl(dump(v1));</code></pre>
<li><a href=#Var_Creation_>Var Creation </a></li>
 
<li><a href=#Arithmetical_Operators_>Arithmetical Operators </a></li>
</td></tr>
<li><a href=#Dynamic_Array_Creation,_Access_And_Update>Dynamic Array Creation, Access And Update</a></li>
</table>
<li><a href=#String_Creation_>String Creation </a></li>
<h5 id=Arithmetical_Operators_>Arithmetical Operators </h5>
<li><a href=#String_Scanning>String Scanning</a></li>
<li><a href=#String_Conversion_-_Non-Mutating_-_Chainable>String Conversion - Non-Mutating - Chainable</a></li>
<li><a href=#String_Mutation_-_Standalone_Commands>String Mutation - Standalone Commands</a></li>
<li><a href=#I/O_Conversion>I/O Conversion</a></li>
<li><a href=#Dynamic_Array_Functions>Dynamic Array Functions</a></li>
<li><a href=#Dynamic_Array_Filters>Dynamic Array Filters</a></li>
<li><a href=#Dynamic_Array_Mutators_Standalone_Commands>Dynamic Array Mutators Standalone Commands</a></li>
<li><a href=#Dynamic_Array_Search>Dynamic Array Search</a></li>
<li><a href=#Database_Access>Database Access</a></li>
<li><a href=#Database_Management>Database Management</a></li>
<li><a href=#Database_File_I/O>Database File I/O</a></li>
<li><a href=#Database_Sort/Select>Database Sort/Select</a></li>
<li><a href=#OS_Time/Date>OS Time/Date</a></li>
<li><a href=#OS_File_I/O>OS File I/O</a></li>
<li><a href=#OS_Directories>OS Directories</a></li>
<li><a href=#OS_Shell/Environment>OS Shell/Environment</a></li>
<li><a href=#Output>Output</a></li>
<li><a href=#Input>Input</a></li>
<li><a href=#Math/Boolean>Math/Boolean</a></li>
<li><a href=#I/O_Conversion_Codes_>I/O Conversion Codes </a></li>
 
</ol>
</div>
 
 
<h5 id=Var_Creation_>Var Creation </h5>


<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>v1.isnum()</td><td><p>Checks if a var is numeric.
<tr><td></td><td>var v1;</td><td><p>Create an unassigned var.
</p>
</p>
<p><em>Returns:</em> True if a var holds a double, an integer, or a string that is defined as numeric.
<p>Unassigned variables can be assigned conditionally in if/else statements or used as outbound arguments of function calls.
</p>
</p>
A string is defined as numeric only if it consists of one or more digits 0-9, with an optional decimal point "." placed anywhere, with an optional + or - sign prefix, or it is the empty string "", which is defined to be zero.
A runtime error is thrown if a var is used before being assigned so silent "use before assign" bugs cannot occur.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">client</span><span class="p">;</span><span class="w"> </span><span class="c1">// Unassigned var</span>
<pre><code class='language-cpp'>if ("+123.45"_var.isnum()) ... ok
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">read</span><span class="p">(</span><span class="n">client</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;SB001&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (      ""_var.isnum()) ... ok
</pre></div>
if (not   "."_var.isnum()) ... ok
<div class="highlight light"><pre><span class="c1">//            Exodus keywords:    C++ declarations:</span>
// or
<span class="c1">//            Non-Const  Const    Non-Const   Const</span>
if (isnum("123.")) ... ok</code></pre>
<span class="c1">//            -----------------    ----------------------</span>
 
<span class="c1">// Variable:  var        let      var        const var</span>
<span class="c1">// Reference:  out        in      var&amp;        const var&amp;</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>v1.num()</td><td><p>Returns a copy of the var if it is numeric or 0 otherwise.
<tr><td></td><td>var v1 = expression;</td><td><p>Assign a var using a literal or an expression.
</p>
</p>
<p><em>Returns:</em> A guaranteed numeric var
Use "let" instead of "var" wherever possible as a shorthand way of writing "const var".
</p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">42</span><span class="p">;</span><span class="w">                </span><span class="c1">// Integer</span>
Allows working numerically with data that may be non-numeric.
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">42.3</span><span class="p">;</span><span class="w">              </span><span class="c1">// Double</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">;</span><span class="w">              </span><span class="c1">// String</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="sc">&#39;x&#39;</span><span class="p">;</span><span class="w">                </span><span class="c1">// char</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v5</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w">              </span><span class="c1">// bool</span>
 
<span class="kt">var</span><span class="w"> </span><span class="n">v6</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">100</span><span class="p">;</span><span class="w">          </span><span class="c1">// Arithmetic</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v7</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xyz&quot;</span><span class="p">;</span><span class="w">        </span><span class="c1">// Concatenation</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v8</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oslist</span><span class="p">(</span><span class="s">&quot;.&quot;</span><span class="p">).</span><span class="nf">sort</span><span class="p">();</span><span class="w"> </span><span class="c1">// Built in functions</span>
 
<span class="nf">let</span><span class="w"> </span><span class="n">v9</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">12345</span><span class="p">;</span><span class="w">              </span><span class="c1">// A const var</span>


<pre><code class='language-cpp'>var v1 = "123.45"_var.num();   // 123.45
<span class="kt">var</span><span class="w"> </span><span class="n">v10</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">12&#39;345</span><span class="kt">_var</span><span class="p">;</span><span class="w">        </span><span class="c1">// A literal var integer</span>
var v2 = "abc"_var.num() + 100; // 100</code></pre>
<span class="kt">var</span><span class="w"> </span><span class="n">v11</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">123.45</span><span class="kt">_var</span><span class="p">;</span><span class="w">        </span><span class="c1">// A literal var double</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v12</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^v1]v2^f3&quot;</span><span class="kt">_var</span><span class="p">;</span><span class="w"> </span><span class="c1">// A literal var string</span>


<span class="kt">var</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">0.1</span><span class="p">,</span><span class="w"> </span><span class="n">y</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;0.2&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">z</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">y</span><span class="p">;</span><span class="w"> </span><span class="c1">// z -&gt; 0.3</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>v2 + v3</td><td><p>Addition
<tr><td>if</td><td>v1.assigned()</td><td>
<em>Returns:</em> True if the var is assigned, otherwise false</td></tr>
<tr><td>if</td><td>v1.unassigned()</td><td>
<em>Returns:</em> True if the var is unassigned, otherwise false</td></tr>
<tr><td>var=</td><td>v2.or_default(defaultvalue)</td><td>
<p><em>Returns:</em> A copy of the var if it is assigned or the default value if it is not.
</p>
</p>
<p>Attempts to perform numeric operations on non-numeric strings will throw a runtime error VarNonNumeric.
<p>Can be used to handle optional arguments in functions.
</p>
</p>
<p>Floating point numbers are implicitly converted to strings with no more than 12 significant digits of precision. This practically eliminates all floatng point rounding errors.
<p><em>defaultvalue:</em> Cannot be unassigned.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="p">;</span><span class="w"> </span><span class="c1">// Unassigned</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">or_default</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// v2 -&gt; &quot;abc&quot;</span>
<span class="c1">// or</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">or_default</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
 
</p>
</p>
<p>Internally, 0.1 + 0.2 looks like this using doubles.
<p><em>Mutator:</em> defaulter()
</p>
</p>
0.10000000000000003 + 0.20000000000000004 -> 0.30000000000000004
<pre><code class='language-cpp'>var v1 = 0.1;
var v2 = v1 + 0.2; // 0.3</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>v2 - v3</td><td>Subtraction</td></tr>
<tr><td></td><td>v1.defaulter(defaultvalue)</td><td><p>If the var is unassigned then assign the default value to it, otherwise do nothing.
<tr><td>var=</td><td>v2 * v3</td><td>Multiplication</td></tr>
</p>
<tr><td>var=</td><td>v2 / v3</td><td>Division</td></tr>
<em>defaultvalue:</em> Cannot be unassigned.
<tr><td>var=</td><td>v2 % v3</td><td>Modulus</td></tr>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="p">;</span><span class="w"> </span><span class="c1">// Unassigned</span>
<tr><td></td><td>v1 += v2</td><td>Self addition
<span class="n">v1</span><span class="p">.</span><span class="nf">defaulter</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;abc&quot;</span>
 
<span class="c1">// or</span>
<pre><code class='language-cpp'>var v1 = 0.1;
<span class="nf">defaulter</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
v1 += 0.2; // 0.3</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>v1 -= v2</td><td>Self subtraction</td></tr>
<tr><td></td><td>v1.swap(io v2)</td><td><p>Swap the contents of one var with another.
<tr><td></td><td>v1 *= v2</td><td>Self multiplication</td></tr>
<tr><td></td><td>v1 /= v2</td><td>Self division</td></tr>
<tr><td></td><td>v1 %= v2</td><td>Self modulus</td></tr>
<tr><td></td><td>v1 ++</td><td>Post increment
 
<pre><code class='language-cpp'>var v1 = 3;
var v2 = v1 ++; // v2 -> 3 // v1 -> 4</code></pre>
 
</td></tr>
<tr><td></td><td>v1 --</td><td>Post decrement
 
<pre><code class='language-cpp'>var v1 = 3;
var v2 = v1 --; // v2 -> 3 // v1 -> 2</code></pre>
 
</td></tr>
<tr><td></td><td>++ v1</td><td>Pre increment
 
<pre><code class='language-cpp'>var v1 = 3;
var v2 = ++ v1; // v2 -> 4 // v1 -> 4</code></pre>
 
</td></tr>
<tr><td></td><td>-- v1</td><td>Pre decrement
 
<pre><code class='language-cpp'>var v1 = 3;
var v2 = -- v1; // v2 -> 2 // v1 -> 2</code></pre>
 
</td></tr>
</table>
<h5 id=Dynamic_Array_Creation,_Access_And_Update>Dynamic Array Creation, Access And Update</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>""_var</td><td><p>The literal suffix "_var" allows dynamic arrays to be seamlessly embedded in code using a predefined set of visible equivalents of unprintable field mark characters as follows:
</p>
</p>
<p>` = RM, Record mark
<p>Useful for stashing large strings quickly. They are moved using pointers without making copies or allocating memory.
</p>
</p>
<p>^ = FM, Field mark
Eiher or both variables may be unassigned.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">space</span><span class="p">(</span><span class="mi">65&#39;536</span><span class="p">);</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">;</span>
<span class="n">v1</span><span class="p">.</span><span class="nf">swap</span><span class="p">(</span><span class="n">v2</span><span class="p">);</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;&quot; // v2.len() -&gt; 65&#39;536</span>
<span class="c1">// or</span>
<span class="nf">swap</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="n">v2</span><span class="p">);</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>v2.move()</td><td><p>Force the contents of a var to be moved instead of copied. The moved var becomes an empty string.
</p>
</p>
<p>] = VM, Value mark
<p>This allows large strings to be handled efficiently. They are moved using pointers without making copies or allocating memory.
</p>
</p>
<p>} = SM, Subvalue mark
The moved var must be assigned otherwise a VarUnassigned error is thrown.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">space</span><span class="p">(</span><span class="mi">65&#39;536</span><span class="p">);</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">move</span><span class="p">();</span><span class="w"> </span><span class="c1">// v2.len() -&gt; 65&#39;536 // v1 -&gt; &quot;&quot;</span>
<span class="c1">// or</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">move</span><span class="p">(</span><span class="n">v2</span><span class="p">);</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>v2.clone()</td><td><p>Returns a copy of the var.
</p>
</p>
<p>| = TM, Text mark
The cloned var may be unassigned, in which case the copy will be unassigned too.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">clone</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;abc&quot;</span>
<span class="c1">// or</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">clone</span><span class="p">(</span><span class="n">v2</span><span class="p">);</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>v1.dump()</td><td><p>Return a string describing internal data of a var.
</p>
</p>
~ = ST, Subtext mark
<p>If the str is located on the heap then its address is given.
 
</p>
<pre><code class='language-cpp'>var v1 = "f1^f2^v1]v2^f4"_var; // "f1" _FM "f2" _FM "v1" _VM "v2" _FM "f4"</code></pre>
<p><em>typ:</em>
 
</p>
</td></tr>
<p>0x01 str is available.
<tr><td></td><td>var v1 = {"a", "b", "c" ...}; // Initializer list</td><td>Create a dynamic array var from a list. C++ constrains list elements to be all the same type: var, string, double, int, etc. but they all end up as fields of a dynamic array string.
 
<pre><code class='language-cpp'>var v1 = {11, 22, 33}; // "11^22^33"_var</code></pre>
 
</td></tr>
<tr><td>var=</td><td>v2(fieldno);      v1(fieldno) = v2</td><td><p>Dynamic array - field extraction, update and append:
</p>
</p>
<p>See also inserter() and remover().
<p>0x02 int is available.
 
<pre><code class='language-cpp'>var v1 = "aa^bb"_var;
v1(4) = 44; // v1 -> "aa^bb^^44"_var
// Field number -1 causes appending a field when updating.
v1(-1) = "55"; // v1 -> "aa^bb^^44^55"_var</code></pre>
 
Field access:
</p>
</p>
<p>It is recommended to use "v1.f(fieldno)" syntax using a ".f(" prefix to access fields in expressions instead of plain "v1(fieldno)". The former syntax (using .f()) will always compile whereas the latter does not compile in all contexts. It will compile only if being called on a constant var or in a location which requires a var. This is due to C++ not making a clear distinction between usage on the left and right side of assignment operator =.
<p>0x04 dbl is available.
</p>
</p>
Furthermore using plain round brackets without the leading .f can be confused with function call syntax.
<p>0x08 nan: str is not a number.
 
<pre><code class='language-cpp'>var v1 = "aa^bb^cc"_var;
var v2 = v1.f(2); // "bb" /// .f() style access. Recommended.
var v3 =  v1(2); // "bb" ///  () style access. Not recommended.</code></pre>
 
</td></tr>
<tr><td>var=</td><td>v2(fieldno, valueno);      v1(fieldno, valueno) = v2</td><td><p>Dynamic array - value update and append
</p>
</p>
See also inserter() and remover().
0x16 osfile: str, int and dbl have special meaning.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">str</span><span class="p">(</span><span class="s">&quot;x&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">32</span><span class="p">);</span>
<pre><code class='language-cpp'>var v1 = "aa^b1]b2^cc"_var;
<span class="n">v1</span><span class="p">.</span><span class="nf">dump</span><span class="p">().</span><span class="nf">outputl</span><span class="p">();</span><span class="w"> </span><span class="c1">/// e.g. var:0x7ffea7462cd0 typ:1 str:0x584d9e9f6e70 &quot;xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&quot;</span>
v1(2, 4) = "44"; // v1 -> "aa^b1]b2]]44^cc"_var
<span class="c1">// or</span>
// value number -1 causes appending a value when updating.
<span class="nf">outputl</span><span class="p">(</span><span class="nf">dump</span><span class="p">(</span><span class="n">v1</span><span class="p">));</span>
v1(2, -1) = 55; // v1 -> "aa^b1]b2]]44]55^cc"_var</code></pre>
</pre></div>
 
Value access:
 
<pre><code class='language-cpp'>var v1 = "aa^b1]b2^cc"_var;
var v2 = v1.f(2,2); // "b2" /// .f() style access. Recommended.
var v3 =   v1(2,2); // "b2" ///   () style access. Not recommended.</code></pre>
 
</td></tr>
</td></tr>
</table>
</table>
<h5 id=String_Creation_>String Creation </h5>
<h5 id=Arithmetical_Operators_>Arithmetical Operators </h5>


<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>v2 ^ v3</td><td><p>String concatention operator ^
<tr><td>if</td><td>v1.isnum()</td><td><p>Checks if a var is numeric.
</p>
</p>
<p>At least one side must be a var.
<p><em>Returns:</em> True if a var holds a double, an integer, or a string that is defined as numeric.
</p>
A string is defined as numeric only if it consists of one or more digits 0-9, with an optional decimal point "." placed anywhere, with an optional + or - sign prefix, or it is the empty string "", which is defined to be zero.
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;+123.45&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">isnum</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="w">      </span><span class="s">&quot;&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">isnum</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w">  </span><span class="s">&quot;.&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">isnum</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
<span class="c1">// or</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">isnum</span><span class="p">(</span><span class="s">&quot;123.&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>v1.num()</td><td><p>Returns a copy of the var if it is numeric or 0 otherwise.
</p>
</p>
<p>"aa" ^ "22" will not compile but "aa" "22" will.
<p><em>Returns:</em> A guaranteed numeric var
</p>
</p>
Floating point numbers are implicitly converted to strings with no more than 12 significant digits of precision. This practically eliminates all floatng point rounding errors.
Allows working numerically with data that may be non-numeric.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;123.45&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">num</span><span class="p">();</span><span class="w">    </span><span class="c1">// 123.45</span>
<pre><code class='language-cpp'>var v2 = "aa";
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">num</span><span class="p">()</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">100</span><span class="p">;</span><span class="w"> </span><span class="c1">// 100</span>
var v1 = v2 ^ 22; // "aa22"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>v1 ^= v2</td><td>String self concatention ^= (append)
<tr><td>var=</td><td>v2 + v3</td><td><p>Addition
 
<pre><code class='language-cpp'>var v1 = "aa";
v1 ^= 22; // v1 -> "aa22"</code></pre>
</td></tr>
<tr><td>var=</td><td>varnum.round(ndecimals = 0)</td><td><p>Convert a number into a string after rounding it to a given number of decimal places.
</p>
</p>
<p>Trailing zeros are not omitted. A leading "0." is shown where appropriate.
<p>Attempts to perform numeric operations on non-numeric strings will throw a runtime error VarNonNumeric.
</p>
</p>
<p>0.5 always rounds away from zero. i.e. 1.5 -> 2 and -2.5 -> -3
<p>Floating point numbers are implicitly converted to strings with no more than 12 significant digits of precision. This practically eliminates all floatng point rounding errors.
</p>
</p>
<p><em>var:</em> The number to be converted.
<p>Internally, 0.1 + 0.2 looks like this using doubles.
</p>
</p>
<p><em>ndecimals:</em> Determines how many decimal places are shown to the right of the decimal point or, if ndecimals is negative, how many 0's to the left of it.
0.10000000000000003 + 0.20000000000000004 -> 0.30000000000000004
</p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">0.1</span><span class="p">;</span>
<em>Returns:</em> A var containing an ASCII string of digits with a leading "-" if negative, and a decimal point "." if ndecimals is > 0.
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mf">0.2</span><span class="p">;</span><span class="w"> </span><span class="c1">// 0.3</span>
 
</pre></div>
<pre><code class='language-cpp'>let v1 = var(0.295).round(2);  /"0.30"
// or
let v2 = round(1.295, 2);      //  "1.30"
 
var v3 = var(-0.295).round(2); // "-0.30"
// or
var v4 = round(-1.295, 2);    // "-1.30"
 
var v5 = round(0, 1);          // "0.0"
var v6 = round(0, 0);          // "0"
var v7 = round(0, -1);          // "0"</code></pre>
 
Negative number of decimals rounds to the left of the decimal point
 
<pre><code class='language-cpp'>let v1 = round(123456.789,  0); // "123457"
let v2 = round(123456.789, -1); // "123460"
let v3 = round(123456.789, -2); // "123500"</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::chr(num)</td><td><p>Get a char given an integer 0-255.
<tr><td>var=</td><td>v2 - v3</td><td>Subtraction</td></tr>
</p>
<tr><td>var=</td><td>v2 * v3</td><td>Multiplication</td></tr>
<p><em>Returns:</em> A string containing a single char
<tr><td>var=</td><td>v2 / v3</td><td>Division</td></tr>
</p>
<tr><td>var=</td><td>v2 % v3</td><td>Modulus</td></tr>
0-127 -> ASCII, 128-255 -> invalid UTF-8 which cannot be written to the database or used in many exodus string operations
<tr><td></td><td>v1 += v2</td><td>Self addition
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">0.1</span><span class="p">;</span>
<pre><code class='language-cpp'>let v1 = var::chr(0x61); // "a"
<span class="n">v1</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="mf">0.2</span><span class="p">;</span><span class="w"> </span><span class="c1">// 0.3</span>
// or
</pre></div>
let v2 = chr(0x61);</code></pre>
</td></tr>
 
<tr><td></td><td>v1 -= v2</td><td>Self subtraction</td></tr>
<tr><td></td><td>v1 *= v2</td><td>Self multiplication</td></tr>
<tr><td></td><td>v1 /= v2</td><td>Self division</td></tr>
<tr><td></td><td>v1 %= v2</td><td>Self modulus</td></tr>
<tr><td></td><td>v1 ++</td><td>Post increment
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">++</span><span class="p">;</span><span class="w"> </span><span class="c1">// v2 -&gt; 3 // v1 -&gt; 4</span>
</pre></div>
</td></tr>
<tr><td></td><td>v1 --</td><td>Post decrement
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">--</span><span class="p">;</span><span class="w"> </span><span class="c1">// v2 -&gt; 3 // v1 -&gt; 2</span>
</pre></div>
</td></tr>
<tr><td></td><td>++ v1</td><td>Pre increment
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">++</span><span class="w"> </span><span class="n">v1</span><span class="p">;</span><span class="w"> </span><span class="c1">// v2 -&gt; 4 // v1 -&gt; 4</span>
</pre></div>
</td></tr>
<tr><td></td><td>-- v1</td><td>Pre decrement
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">--</span><span class="w"> </span><span class="n">v1</span><span class="p">;</span><span class="w"> </span><span class="c1">// v2 -&gt; 2 // v1 -&gt; 2</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::textchr(num)</td><td><p>Get a Unicode character given a Unicode Code Point (Number)
</table>
</p>
<h5 id=Dynamic_Array_Creation,_Access_And_Update>Dynamic Array Creation, Access And Update</h5>
<em>Returns:</em> A single Unicode character in UTF8 encoding.


<pre><code class='language-cpp'>let v1 = var::textchr(171416); // "𩶘" // or "\xF0A9B698"
<table class=wikitable>
// or
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
let v2 = textchr(171416);</code></pre>
<tr><td>var=</td><td>""_var</td><td><p>The literal suffix "_var" allows dynamic arrays to be seamlessly embedded in code using a predefined set of visible equivalents of unprintable field mark characters as follows:
 
</td></tr>
<tr><td>var=</td><td>var::textchrname(unicode_code_point)</td><td><p>Get a Unicode character name
</p>
</p>
<p><em>unicode_code_point:</em> 0 - 0x10FFFF.
<p>   Visible  Unprintable
</p>
</p>
<em>Returns:</em> Text of the name or "" if not a valid Unicode Code Point
<p>*    `    RM  Record mark
 
<pre><code class='language-cpp'>let v1 = var::textchrname(91); // "LEFT SQUARE BRACKET"
// or
let v2 = textchrname(91);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>strvar.str(num)</td><td><p>Get a string of repeated substrings.
</p>
</p>
<p><em>var:</em> The substring to be repeated
<p>*    ^    FM  Field mark
</p>
<p>*    ]    VM  Value mark
</p>
<p>*    }    SM  Subvalue mark
</p>
</p>
<p><em>num:</em> How many times to repeat the substring
<p>*    |    TM  Text mark
</p>
</p>
<em>Returns:</em> A string
*    ~    ST  Subtext mark
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^f2^v1]v2^f4&quot;</span><span class="kt">_var</span><span class="p">;</span><span class="w"> </span><span class="c1">// &quot;f1&quot; _FM &quot;f2&quot; _FM &quot;v1&quot; _VM &quot;v2&quot; _FM &quot;f4&quot;</span>
<pre><code class='language-cpp'>let v1 = "ab"_var.str(3); // "ababab"
</pre></div>
// or
</td></tr>
let v2 = str("ab", 3);</code></pre>
<tr><td></td><td>var v1 = {"a", "b", "c" ...}; // Initializer list</td><td>Create a dynamic array var from a list. C++ constrains list elements to be all the same type: var, string, double, int, etc. but they all end up as fields of a dynamic array string.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="mi">11</span><span class="p">,</span><span class="w"> </span><span class="mi">22</span><span class="p">,</span><span class="w"> </span><span class="mi">33</span><span class="p">};</span><span class="w"> </span><span class="c1">// &quot;11^22^33&quot;_var</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::space(nspaces)</td><td><p>Get a string containing a given number of spaces.
<tr><td>var=</td><td>v2(fieldno);      v1(fieldno) = v2</td><td><p>Dynamic array - field extraction, update and append:
</p>
<p>See also inserter() and remover().
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa^bb&quot;</span><span class="kt">_var</span><span class="p">;</span>
<span class="n">v1</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">44</span><span class="p">;</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;aa^bb^^44&quot;_var</span>
<span class="c1">// Field number -1 causes appending a field when updating.</span>
<span class="n">v1</span><span class="p">(</span><span class="mi">-1</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;55&quot;</span><span class="p">;</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;aa^bb^^44^55&quot;_var</span>
</pre></div>
Field access:
</p>
</p>
<p><em>nspaces:</em> The number of spaces required.
<p>It is recommended to use "v1.f(fieldno)" syntax using a ".f(" prefix to access fields in expressions instead of plain "v1(fieldno)". The former syntax (using .f()) will always compile whereas the latter does not compile in all contexts. It will compile only if being called on a constant var or in a location which requires a var. This is due to C++ not making a clear distinction between usage on the left and right side of assignment operator =.
</p>
</p>
<em>Returns:</em> A string of space chars.
Furthermore using plain round brackets without the leading .f can be confused with function call syntax.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa^bb^cc&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let v1 = var::space(3); // "␣␣␣"
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bb&quot; /// .f() style access. Recommended.</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bb&quot; ///  () style access. Not recommended.</span>
let v2 = space(3);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.numberinwords(locale = "")</td><td>
<tr><td>var=</td><td>v2(fieldno, valueno);      v1(fieldno, valueno) = v2</td><td><p>Dynamic array - value update and append
<p><em>Returns:</em> A string representing a given number written in words instead of digits.
</p>
</p>
<em>locale:</em> e.g. en_GB, ar_AE, el_CY, es_US, fr_FR etc or a language name e.g. "french".
See also inserter() and remover().
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa^b1]b2^cc&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let softhyphen = "\xc2\xad";
<span class="n">v1</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;44&quot;</span><span class="p">;</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;aa^b1]b2]]44^cc&quot;_var</span>
let v1 = var(123.45).numberinwords("de_DE").replace(softhyphen, " "); // "ein␣hundert␣drei␣und␣zwanzig␣Komma␣vier␣fünf"</code></pre>
<span class="c1">// value number -1 causes appending a value when updating.</span>
 
<span class="n">v1</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">-1</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">55</span><span class="p">;</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;aa^b1]b2]]44]55^cc&quot;_var</span>
</pre></div>
Value access:
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa^b1]b2^cc&quot;</span><span class="kt">_var</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;b2&quot; /// .f() style access. Recommended.</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;b2&quot; ///  () style access. Not recommended.</span>
</pre></div>
</td></tr>
</td></tr>
</table>
</table>
<h5 id=String_Scanning>String Scanning</h5>
<h5 id=String_Creation_>String Creation </h5>


<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>strvar.at(pos1)</td><td><p>Get a single char from a string.
<tr><td>var=</td><td>v2 ^ v3</td><td><p>String concatention operator ^
</p>
<p>At least one side must be a var.
</p>
</p>
<p><em>pos1:</em> First char is 1. Last char is -1.
<p>"aa" ^ "22" will not compile but "aa" "22" will.
</p>
</p>
<em>Returns:</em> A single char if pos1 ± the length of the string, or "" if greater. Returns the first char if pos1 is 0 or (-pos1) > length.
Floating point numbers are implicitly converted to strings with no more than 12 significant digits of precision. This practically eliminates all floatng point rounding errors.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "abc";
<span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="mi">22</span><span class="p">;</span><span class="w"> </span><span class="c1">// &quot;aa22&quot;</span>
var v2 = v1.at(2);  // "b"
</pre></div>
var v3 = v1.at(-3); // "a"
var v4 = v1.at(4); // ""</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.ord()</td><td><p>Get the char number of a char
<tr><td></td><td>v1 ^= v2</td><td>String self concatention ^= (append)
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa&quot;</span><span class="p">;</span>
<span class="n">v1</span><span class="w"> </span><span class="o">^=</span><span class="w"> </span><span class="mi">22</span><span class="p">;</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;aa22&quot;</span>
</pre></div></td></tr>
<tr><td>var=</td><td>varnum.round(ndecimals = 0)</td><td><p>Convert a number into a string after rounding it to a given number of decimal places.
</p>
<p>Trailing zeros are not omitted. A leading "0." is shown where appropriate.
</p>
<p>0.5 always rounds away from zero. i.e. 1.5 -> 2 and -2.5 -> -3
</p>
</p>
<p><em>Returns:</em> A number between 0 and 255.
<p><em>var:</em> The number to be converted.
</p>
</p>
<p>If given a string, then only the first char is considered.
<p><em>ndecimals:</em> Determines how many decimal places are shown to the right of the decimal point or, if ndecimals is negative, how many 0's to the left of it.
</p>
</p>
Equivalent to ord() in php
<em>Returns:</em> A var containing an ASCII string of digits with a leading "-" if negative, and a decimal point "." if ndecimals is > 0.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">0.295</span><span class="p">).</span><span class="nf">round</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w">  </span><span class="c1">//  &quot;0.30&quot;</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">round</span><span class="p">(</span><span class="mf">1.295</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w">      </span><span class="c1">//  &quot;1.30&quot;</span>


<pre><code class='language-cpp'>let v1 = "abc"_var.ord(); // 0x61 // decimal 97, 'a'
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">-0.295</span><span class="p">).</span><span class="nf">round</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;-0.30&quot;</span>
// or
<span class="c1">// or</span>
let v2 = ord("abc");</code></pre>
<span class="kt">var</span><span class="w"> </span><span class="n">v4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">round</span><span class="p">(</span><span class="mf">-1.295</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w">    </span><span class="c1">// &quot;-1.30&quot;</span>


<span class="kt">var</span><span class="w"> </span><span class="n">v5</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">round</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">);</span><span class="w">          </span><span class="c1">// &quot;0.0&quot;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v6</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">round</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span><span class="w">          </span><span class="c1">// &quot;0&quot;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v7</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">round</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mi">-1</span><span class="p">);</span><span class="w">          </span><span class="c1">// &quot;0&quot;</span>
</pre></div>
Negative number of decimals rounds to the left of the decimal point
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">round</span><span class="p">(</span><span class="mf">123456.789</span><span class="p">,</span><span class="w">  </span><span class="mi">0</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;123457&quot;</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">round</span><span class="p">(</span><span class="mf">123456.789</span><span class="p">,</span><span class="w"> </span><span class="mi">-1</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;123460&quot;</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">round</span><span class="p">(</span><span class="mf">123456.789</span><span class="p">,</span><span class="w"> </span><span class="mi">-2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;123500&quot;</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.textord()</td><td><p>Get the Unicode Code Point of a Unicode character.
<tr><td>var=</td><td>var::chr(num)</td><td><p>Get a char given an integer 0-255.
</p>
</p>
<p><em>var:</em> A UTF-8 string. Only the first Unicode character is considered.
<p><em>Returns:</em> A string containing a single char
</p>
</p>
<p><em>Returns:</em> A number 0 to 0x10FFFF.
0-127 -> ASCII, 128-255 -> invalid UTF-8 which cannot be written to the database or used in many exodus string operations
</p>
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">chr</span><span class="p">(</span><span class="mh">0x61</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;a&quot;</span>
Equivalent to ord() in python and ruby, mb_ord() php.
<span class="c1">// or</span>
 
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">chr</span><span class="p">(</span><span class="mh">0x61</span><span class="p">);</span>
<pre><code class='language-cpp'>let v1 = "Γ"_var.textord(); // 915 // U+0393: Greek Capital Letter Gamma (Unicode character)
</pre></div>
// or
let v2 = textord("Γ");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.len()</td><td><p>Get the length of a source string in number of chars
<tr><td>var=</td><td>var::textchr(num)</td><td><p>Get a Unicode character given a Unicode Code Point (Number)
</p>
</p>
<em>Returns:</em> A number
<em>Returns:</em> A single Unicode character in UTF8 encoding.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">textchr</span><span class="p">(</span><span class="mi">171416</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;𩶘&quot; // or &quot;\xF0A9B698&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.len(); // 3
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">textchr</span><span class="p">(</span><span class="mi">171416</span><span class="p">);</span>
let v2 = len("abc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.empty()</td><td><p>Checks if the var is an empty string.
<tr><td>var=</td><td>var::textchrname(unicode_code_point)</td><td><p>Get a Unicode character name
</p>
</p>
<p><em>Returns:</em> True if it is empty amd false if not.
<p><em>unicode_code_point:</em> 0 - 0x10FFFF.
</p>
</p>
<p>This is a shorthand and more expressive way of writing 'if (var == "")' or 'if (var.len() == 0)' or 'if (not var.len())'
<em>Returns:</em> Text of the name or "" if not a valid Unicode Code Point
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">textchrname</span><span class="p">(</span><span class="mi">91</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;LEFT SQUARE BRACKET&quot;</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">textchrname</span><span class="p">(</span><span class="mi">91</span><span class="p">);</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>strvar.str(num)</td><td><p>Get a string of repeated substrings.
</p>
</p>
Note that 'if (var.empty())' is not exactly the same as 'if (not var)' because 'if (var("0.0")' is also defined as false. If a string can be converted to 0 then it is considered to be false. Contrast this with common scripting languages where 'if (var("0"))' is defined to be true.
<p><em>var:</em> The substring to be repeated
 
<pre><code class='language-cpp'>let v1 = "0";
if (not v1.empty()) ... ok // true
// or
if (not empty(v1)) ... ok // true</code></pre>
 
</td></tr>
<tr><td>var=</td><td>strvar.textwidth()</td><td><p>Count the number of output columns required for a given source string.
</p>
</p>
<p><em>Returns:</em> A number
<p><em>num:</em> How many times to repeat the substring
</p>
</p>
<p>Allows wide multi-column Unicode characters that occupy more than one space in a text file or terminal screen.
<em>Returns:</em> A string
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;ab&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">str</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;ababab&quot;</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">str</span><span class="p">(</span><span class="s">&quot;ab&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">);</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>var::space(nspaces)</td><td><p>Get a string containing a given number of spaces.
</p>
</p>
<p>Reduces combining characters to a single column. e.g. "e" followed by grave accent is multiple bytes but only occupies one output column.
<p><em>nspaces:</em> The number of spaces required.
</p>
</p>
Does not properly calculate all possible combining sequences of graphemes e.g. face followed by colour
<em>Returns:</em> A string of space chars.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">space</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;␣␣␣&quot;</span>
<pre><code class='language-cpp'>let v1 = "🤡x🤡"_var.textwidth(); // 5
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">space</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span>
let v2 = textwidth("🤡x🤡");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.textlen()</td><td><p>Count the number of Unicode code points in a source string.
<tr><td>var=</td><td>varnum.numberinwords(locale = "")</td><td>
<p><em>Returns:</em> A string representing a given number written in words instead of digits.
</p>
</p>
<em>Returns:</em> A number.
<em>locale:</em> e.g. en_GB, ar_AE, el_CY, es_US, fr_FR etc or a language name e.g. "french".
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">softhyphen</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\xc2\xad</span><span class="s">&quot;</span><span class="p">;</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">123.45</span><span class="p">).</span><span class="nf">numberinwords</span><span class="p">(</span><span class="s">&quot;de_DE&quot;</span><span class="p">).</span><span class="nf">replace</span><span class="p">(</span><span class="n">softhyphen</span><span class="p">,</span><span class="w"> </span><span class="s">&quot; &quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;ein␣hundert␣drei␣und␣zwanzig␣Komma␣vier␣fünf&quot;</span>
</pre></div>
</td></tr>
</table>
<h5 id=String_Scanning>String Scanning</h5>


<pre><code class='language-cpp'>let v1 = "Γιάννης"_var.textlen(); // 7
<table class=wikitable>
// or
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
let v2 = textlen("Γιάννης");</code></pre>
<tr><td>var=</td><td>strvar.at(pos1)</td><td><p>Get a single char from a string.
 
</td></tr>
<tr><td>var=</td><td>strvar.fcount(sepstr)</td><td><p>Count the number of fields in a source string.
</p>
</p>
<p><em>sepstr:</em> The separator character or substr that delimits individual fields.
<p><em>pos1:</em> First char is 1. Last char is -1.
</p>
</p>
<p><em>Returns:</em> The count of the number of fields
<em>Returns:</em> A single char if pos1 +/- the length of the string, or "" if greater. Returns the first char if pos1 is 0 or (-pos1) > length.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">at</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w">  </span><span class="c1">// &quot;b&quot;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">at</span><span class="p">(</span><span class="mi">-3</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;a&quot;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">at</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span><span class="w">  </span><span class="c1">// &quot;&quot;</span>
</pre></div></td></tr>
<tr><td>var=</td><td>strvar.ord()</td><td><p>Get the char number of a char
</p>
<p><em>Returns:</em> A number between 0 and 255.
</p>
<p>If given a string, then only the first char is considered.
</p>
</p>
This is similar to "var.count(sepstr) + 1" but it returns 0 for an empty source string.
Equivalent to ord() in php
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">ord</span><span class="p">();</span><span class="w"> </span><span class="c1">// 0x61 // decimal 97, &#39;a&#39;</span>
<pre><code class='language-cpp'>let v1 = "aa**cc"_var.fcount("*"); // 3
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ord</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = fcount("aa**cc", "*");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.count(sepstr)</td><td><p>Count the number of occurrences of a given substr in a source string.
<tr><td>var=</td><td>strvar.textord()</td><td><p>Get the Unicode Code Point of a Unicode character.
</p>
<p><em>var:</em> A UTF-8 string. Only the first Unicode character is considered.
</p>
</p>
<p><em>substr:</em> The substr to count.
<p><em>Returns:</em> A number 0 to 0x10FFFF.
</p>
</p>
<p><em>Returns:</em> The count of the number of sepstr found.
Equivalent to ord() in python and ruby, mb_ord() php.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Γ&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">textord</span><span class="p">();</span><span class="w"> </span><span class="c1">// 915 // U+0393: Greek Capital Letter Gamma (Unicode character)</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">textord</span><span class="p">(</span><span class="s">&quot;Γ&quot;</span><span class="p">);</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>strvar.len()</td><td><p>Get the length of a source string in number of chars
</p>
</p>
Overlapping substrings are not counted.
<em>Returns:</em> A number
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">len</span><span class="p">();</span><span class="w"> </span><span class="c1">// 3</span>
<pre><code class='language-cpp'>let v1 = "aa**cc"_var.count("*"); // 2
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">len</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = count("aa**cc", "*");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.starts(prefix)</td><td><p>Checks if a source string starts with a given prefix (substr).
<tr><td>if</td><td>strvar.empty()</td><td><p>Checks if the var is an empty string.
</p>
</p>
<p><em>prefix:</em> The substr to check for.
<p><em>Returns:</em> True if it is empty amd false if not.
</p>
</p>
<p><em>Returns:</em> True if the source string starts with the given prefix.
<p>This is a shorthand and more expressive way of writing 'if (var == "")' or 'if (var.len() == 0)' or 'if (not var.len())'
</p>
</p>
<em>Returns:</em> False if prefix is "". DIFFERS from c++, javascript, python3. See contains() for more info.
Note that 'if (var.empty())' is not exactly the same as 'if (not var)' because 'if (var("0.0")' is also defined as false. If a string can be converted to 0 then it is considered to be false. Contrast this with common scripting languages where 'if (var("0"))' is defined to be true.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;0&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>if ("abc"_var.starts("ab")) ... true
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">empty</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// true</span>
// or
<span class="c1">// or</span>
if (starts("abc", "ab")) ... true</code></pre>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">empty</span><span class="p">(</span><span class="n">v1</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// true</span>
 
</pre></div>
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.ends(suffix)</td><td><p>Checks if a source string ends with a given suffix (substr).
<tr><td>var=</td><td>strvar.textwidth()</td><td><p>Count the number of output columns required for a given source string.
</p>
</p>
<p><em>suffix:</em> The substr to check for.
<p><em>Returns:</em> A number
</p>
</p>
<p><em>Returns:</em> True if the source string ends with given suffix.
<p>Allows wide multi-column Unicode characters that occupy more than one space in a text file or terminal screen.
</p>
<p>Reduces combining characters to a single column. e.g. "e" followed by grave accent is multiple bytes but only occupies one output column.
</p>
Does not properly calculate all possible combining sequences of graphemes e.g. face followed by colour
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;🤡x🤡&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">textwidth</span><span class="p">();</span><span class="w"> </span><span class="c1">// 5</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">textwidth</span><span class="p">(</span><span class="s">&quot;🤡x🤡&quot;</span><span class="p">);</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>strvar.textlen()</td><td><p>Count the number of Unicode code points in a source string.
</p>
</p>
<em>Returns:</em> False if suffix is "". DIFFERS from c++, javascript, python3. See contains() for more info.
<em>Returns:</em> A number.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Γιάννης&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">textlen</span><span class="p">();</span><span class="w"> </span><span class="c1">// 7</span>
<pre><code class='language-cpp'>if ("abc"_var.ends("bc")) ... true
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">textlen</span><span class="p">(</span><span class="s">&quot;Γιάννης&quot;</span><span class="p">);</span>
if (ends("abc", "bc")) ... true</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.contains(substr)</td><td><p>Checks if a given substr exists in a source string.
<tr><td>var=</td><td>strvar.fcount(sepstr)</td><td><p>Count the number of fields in a source string.
</p>
</p>
<p><em>substr:</em> The substr to check for.
<p><em>sepstr:</em> The separator character or substr that delimits individual fields.
</p>
</p>
<p><em>Returns:</em> True if the source string starts with, ends with or contains the given substr.
<p><em>Returns:</em> The count of the number of fields
</p>
</p>
<p><em>Returns:</em> False if suffix is "". DIFFERS from c++, javascript, python3
This is similar to "var.count(sepstr) + 1" but it returns 0 for an empty source string.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa**cc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">fcount</span><span class="p">(</span><span class="s">&quot;*&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// 3</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">fcount</span><span class="p">(</span><span class="s">&quot;aa**cc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;*&quot;</span><span class="p">);</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>strvar.count(sepstr)</td><td><p>Count the number of occurrences of a given substr in a source string.
</p>
</p>
<p>Human logic: "" is not equal to "x" therefore x does not contain "".
<p><em>substr:</em> The substr to count.
</p>
</p>
<p>Human logic: Check each item (character) in the list for equality with what I am looking for and return success if any are equal.
<p><em>Returns:</em> The count of the number of sepstr found.
</p>
</p>
Programmer logic: Compare as many characters as are in the search string for presence in the list of characters and return success if there are no failures.
Overlapping substrings are not counted.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa**cc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">count</span><span class="p">(</span><span class="s">&quot;*&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// 2</span>
<pre><code class='language-cpp'>if ("abcd"_var.contains("bc")) ... true
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">count</span><span class="p">(</span><span class="s">&quot;aa**cc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;*&quot;</span><span class="p">);</span>
if (contains("abcd", "bc")) ... true</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.index(substr, startchar1 = 1)</td><td><p>Find a substr in a source string.
<tr><td>if</td><td>strvar.starts(prefix)</td><td><p>Checks if a source string starts with a given prefix (substr).
</p>
</p>
<p><em>substr:</em> The substr to search for.
<p><em>prefix:</em> The substr to check for.
</p>
</p>
<p><em>startchar1:</em> The char position (1 based) to start the search at. The default is 1, the first char.
<p><em>Returns:</em> True if the source string starts with the given prefix.
</p>
<em>Returns:</em> False if prefix is "". DIFFERS from c++, javascript, python3. See contains() for more info.
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">starts</span><span class="p">(</span><span class="s">&quot;ab&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="nb">true</span>
<span class="c1">// or</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">starts</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;ab&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="nb">true</span>
</pre></div>
</td></tr>
<tr><td>if</td><td>strvar.ends(suffix)</td><td><p>Checks if a source string ends with a given suffix (substr).
</p>
<p><em>suffix:</em> The substr to check for.
</p>
<p><em>Returns:</em> True if the source string ends with given suffix.
</p>
<em>Returns:</em> False if suffix is "". DIFFERS from c++, javascript, python3. See contains() for more info.
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">ends</span><span class="p">(</span><span class="s">&quot;bc&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="nb">true</span>
<span class="c1">// or</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">ends</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bc&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="nb">true</span>
</pre></div>
</td></tr>
<tr><td>if</td><td>strvar.contains(substr)</td><td><p>Checks if a given substr exists in a source string.
</p>
<p><em>substr:</em> The substr to check for.
</p>
<p><em>Returns:</em> True if the source string starts with, ends with or contains the given substr.
</p>
<p><em>Returns:</em> False if suffix is "". DIFFERS from c++, javascript, python3
</p>
<p>Human logic: "" is not equal to "x" therefore x does not contain "".
</p>
<p>Human logic: Check each item (character) in the list for equality with what I am looking for and return success if any are equal.
</p>
Programmer logic: Compare as many characters as are in the search string for presence in the list of characters and return success if there are no failures.
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">contains</span><span class="p">(</span><span class="s">&quot;bc&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="nb">true</span>
<span class="c1">// or</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">contains</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bc&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="nb">true</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>strvar.index(substr, startchar1 = 1)</td><td><p>Find a substr in a source string.
</p>
<p><em>substr:</em> The substr to search for.
</p>
<p><em>startchar1:</em> The char position (1 based) to start the search at. The default is 1, the first char.
</p>
</p>
<em>Returns:</em> The char position (1 based) that the substr is found at or 0 if not present.
<em>Returns:</em> The char position (1 based) that the substr is found at or 0 if not present.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">index</span><span class="p">(</span><span class="s">&quot;bc&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// 2</span>
<pre><code class='language-cpp'>let v1 = "abcd"_var.index("bc"); // 2
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">index</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bc&quot;</span><span class="p">);</span>
let v2 = index("abcd", "bc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.indexn(substr, occurrence)</td><td><p>Find the nth occurrence of a substr in a source string.
<tr><td>var=</td><td>strvar.indexn(substr, occurrence)</td><td><p>Find the nth occurrence of a substr in a source string.
Line 811: Line 924:
</p>
</p>
<em>Returns:</em> char position (1 based) or 0 if not present.
<em>Returns:</em> char position (1 based) or 0 if not present.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcabc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">indexn</span><span class="p">(</span><span class="s">&quot;bc&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// 5</span>
<pre><code class='language-cpp'>let v1 = "abcabc"_var.index("bc", 2); // 2
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">indexn</span><span class="p">(</span><span class="s">&quot;abcabc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bc&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
let v2 = index("abcabc", "bc", 2);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.indexr(substr, startchar1 = -1)</td><td><p>Find the position of substr working backwards from the end of the string towards the beginning.
<tr><td>var=</td><td>strvar.indexr(substr, startchar1 = -1)</td><td><p>Find the position of substr working backwards from the end of the string towards the beginning.
Line 824: Line 936:
</p>
</p>
<em>startchar1:</em> defaults to -1 meaning start searching from the last char. Positive start1char1 counts from the beginning of the source string and negative startchar1 counts backwards from the last char.
<em>startchar1:</em> defaults to -1 meaning start searching from the last char. Positive start1char1 counts from the beginning of the source string and negative startchar1 counts backwards from the last char.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcabc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">indexr</span><span class="p">(</span><span class="s">&quot;bc&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// 5</span>
<pre><code class='language-cpp'>let v1 = "abcabc"_var.indexr("bc"); // 5
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">indexr</span><span class="p">(</span><span class="s">&quot;abcabc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bc&quot;</span><span class="p">);</span>
let v2 = indexr("abcabc", "bc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.match(regex_str, regex_options = "")</td><td><p>Finds all matches of a given regular expression.
<tr><td>var=</td><td>strvar.match(regex_str, regex_options = "")</td><td><p>Finds all matches of a given regular expression.
</p>
</p>
<p><em>Returns:</em> Zero or more matching substrings separated by FMs. Any groups are in VMs.
<p><em>Returns:</em> Zero or more matching substrings separated by FMs. Any groups are in VMs.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc1abc2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">match</span><span class="p">(</span><span class="s">&quot;BC(</span><span class="se">\\</span><span class="s">d)&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;i&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bc1]1^bc2]2&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "abc1abc2"_var.match("BC(\\d)", "i"); // "bc1]1^bc2]2"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">match</span><span class="p">(</span><span class="s">&quot;abc1abc2&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;BC(</span><span class="se">\\</span><span class="s">d)&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;i&quot;</span><span class="p">);</span>
let v2 = match("abc1abc2", "BC(\\d)", "i");</code></pre>
</pre></div>
 


</p>
</p>
Line 878: Line 988:
<p><em>startchar1:</em> [in] char position to start the search from
<p><em>startchar1:</em> [in] char position to start the search from
</p>
</p>
<p><em>startchar1:</em> [out] char position to start the next search from
<p><em>startchar1:</em> [out] char position to start the next search from or 0 if no more matches.
</p>
</p>
<p><em>Returns:</em> The 1st match like match()
<p><em>Returns:</em> The 1st match like match()
</p>
</p>
regex_options as for match()
regex_options as for match()
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">startchar1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span>
<pre><code class='language-cpp'>var startchar1 = 1;
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc1abc2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">search</span><span class="p">(</span><span class="s">&quot;BC(</span><span class="se">\\</span><span class="s">d)&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">startchar1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;i&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bc1]1&quot;_var // startchar1 -&gt; 5 /// Ready for the next search</span>
let v1 = "abc1abc2"_var.search("BC(\\d)", startchar1, "i"); // "bc1]1"_var // startchar1 -> 5 /// Ready for the next search
<span class="c1">// or</span>
// or
<span class="n">startchar1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">;</span>
startchar1 = 1;
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span><span class="s">&quot;abc1abc2&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;BC(</span><span class="se">\\</span><span class="s">d)&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">startchar1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;i&quot;</span><span class="p">);</span>
let v2 = search("abc1abc2", "BC(\\d)", startchar1, "i");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.search(regex_str)</td><td>Ditto starting from first char</td></tr>
<tr><td>var=</td><td>strvar.search(regex_str)</td><td>Ditto starting from first char</td></tr>
Line 901: Line 1,010:
</p>
</p>
MurmurHash3 is used.
MurmurHash3 is used.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">hash</span><span class="p">();</span><span class="w"> </span><span class="n">assert</span><span class="p">(</span><span class="n">v1</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">6&#39;715&#39;211&#39;243&#39;465&#39;481&#39;821</span><span class="p">));</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.hash(); assert(v1 == var(6'715'211'243'465'481'821));
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">hash</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = hash("abc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 913: Line 1,021:
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>strvar.ucase()</td><td>Convert to upper case
<tr><td>var=</td><td>strvar.ucase()</td><td>Convert to upper case
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Γιάννης&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">ucase</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;ΓΙΆΝΝΗΣ&quot;</span>
<pre><code class='language-cpp'>let v1 = "Γιάννης"_var.ucase(); // "ΓΙΆΝΝΗΣ"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ucase</span><span class="p">(</span><span class="s">&quot;Γιάννης&quot;</span><span class="p">);</span>
let v2 = ucase("Γιάννης");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.lcase()</td><td>Convert to lower case
<tr><td>var=</td><td>strvar.lcase()</td><td>Convert to lower case
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;ΓΙΆΝΝΗΣ&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">lcase</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;γιάννης&quot;</span>
<pre><code class='language-cpp'>let v1 = "ΓΙΆΝΝΗΣ"_var.lcase(); // "γιάννης"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">lcase</span><span class="p">(</span><span class="s">&quot;ΓΙΆΝΝΗΣ&quot;</span><span class="p">);</span>
let v2 = lcase("ΓΙΆΝΝΗΣ");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.tcase()</td><td><p>Convert to title case.
<tr><td>var=</td><td>strvar.tcase()</td><td><p>Convert to title case.
</p>
</p>
<em>Returns:</em> Original source string with the first letter of each word is capitalised.
<em>Returns:</em> Original source string with the first letter of each word is capitalised.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;γιάννης παππάς&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">tcase</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;Γιάννης Παππάς&quot;</span>
<pre><code class='language-cpp'>let v1 = "γιάννης παππάς"_var.tcase(); // "Γιάννης Παππάς"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">tcase</span><span class="p">(</span><span class="s">&quot;γιάννης παππάς&quot;</span><span class="p">);</span>
let v2 = tcase("γιάννης παππάς");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.fcase()</td><td><p>Convert to folded case.
<tr><td>var=</td><td>strvar.fcase()</td><td><p>Convert to folded case.
Line 946: Line 1,051:
</p>
</p>
Case folding is not locale-dependent.
Case folding is not locale-dependent.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Grüßen&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">fcase</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;grüssen&quot;</span>
<pre><code class='language-cpp'>let v1 = "Grüßen"_var.fcase(); // "grüssen"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">tcase</span><span class="p">(</span><span class="s">&quot;Grüßen&quot;</span><span class="p">);</span>
let v2 = tcase("Grüßen");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.normalize()</td><td><p>Replace Unicode character sequences with their standardised NFC form.
<tr><td>var=</td><td>strvar.normalize()</td><td><p>Replace Unicode character sequences with their standardised NFC form.
Line 959: Line 1,063:
</p>
</p>
Normalization is not locale-dependent.
Normalization is not locale-dependent.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;cafe</span><span class="se">\u0301</span><span class="s">&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">normalize</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;caf\u00E9&quot; // &quot;café&quot;</span>
<pre><code class='language-cpp'>let v1 = "cafe\u0301"_var.normalize(); // "caf\u00E9" // "café"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">normalize</span><span class="p">(</span><span class="s">&quot;cafe</span><span class="se">\u0301</span><span class="s">&quot;</span><span class="p">);</span>
let v2 = normalize("cafe\u0301");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.invert()</td><td><p>Simple reversible disguising of string text.
<tr><td>var=</td><td>strvar.invert()</td><td><p>Simple reversible disguising of string text.
Line 978: Line 1,081:
</p>
</p>
Non-existant Unicode Code Points may be created but UTF8 encoding remains valid.
Non-existant Unicode Code Points may be created but UTF8 encoding remains valid.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">invert</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;\xC2&quot; &quot;\x9E&quot; &quot;\xC2&quot; &quot;\x9D&quot; &quot;\xC2&quot; &quot;\x9C&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.invert(); // "\xC2" "\x9E" "\xC2" "\x9D" "\xC2" "\x9C"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">invert</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = invert("abc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.lower()</td><td><p>Reduce all types of field mark chars by one level.
<tr><td>var=</td><td>strvar.lower()</td><td><p>Reduce all types of field mark chars by one level.
Line 993: Line 1,095:
</p>
</p>
String size remains identical.
String size remains identical.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a1^b2^c3&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">lower</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a1]b2]c3&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "a1^b2^c3"_var.lower(); // "a1]b2]c3"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">lower</span><span class="p">(</span><span class="s">&quot;a1^b2^c3&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = lower("a1^b2^c3"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.raise()</td><td><p>Increase all types of field mark chars by one level.
<tr><td>var=</td><td>strvar.raise()</td><td><p>Increase all types of field mark chars by one level.
Line 1,008: Line 1,109:
</p>
</p>
String size remains identical.
String size remains identical.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a1]b2]c3&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">raise</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a1^b2^c3&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "a1]b2]c3"_var.raise(); // "a1^b2^c3"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a1]b2]c3&quot;</span><span class="kt">_var</span><span class="p">;</span>
let v2 = "a1]b2]c3"_var;</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.crop()</td><td>Remove any redundant FM, VM etc. chars (Trailing FM; VM before FM etc.)
<tr><td>var=</td><td>strvar.crop()</td><td>Remove any redundant FM, VM etc. chars (Trailing FM; VM before FM etc.)
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a1^b2]]^c3^^&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">crop</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a1^b2^c3&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "a1^b2]]^c3^^"_var.crop(); // "a1^b2^c3"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">crop</span><span class="p">(</span><span class="s">&quot;a1^b2]]^c3^^&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = crop("a1^b2]]^c3^^"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.quote()</td><td>Wrap in double quotes.
<tr><td>var=</td><td>strvar.quote()</td><td>Wrap in double quotes.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">quote</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;\&quot;abc\&quot;&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.quote(); // "\"abc\""
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">quote</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = quote("abc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.squote()</td><td>Wrap in single quotes.
<tr><td>var=</td><td>strvar.squote()</td><td>Wrap in single quotes.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">squote</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;&#39;abc&#39;&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.squote(); // "'abc'"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">squote</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = squote("abc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.unquote()</td><td>Remove one pair of surrounding double or single quotes.
<tr><td>var=</td><td>strvar.unquote()</td><td>Remove one pair of surrounding double or single quotes.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&#39;abc&#39;&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">unquote</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;abc&quot;</span>
<pre><code class='language-cpp'>let v1 = "'abc'"_var.unquote(); // "abc"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">unquote</span><span class="p">(</span><span class="s">&quot;&#39;abc&#39;&quot;</span><span class="p">);</span>
let v2 = unquote("'abc'");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.trim(trimchars = " ")</td><td><p>Remove all leading, trailing and excessive inner bytes.
<tr><td>var=</td><td>strvar.trim(trimchars = " ")</td><td><p>Remove all leading, trailing and excessive inner bytes.
</p>
</p>
<em>trimchars:</em> The chars (bytes) to remove. The default is space.
<em>trimchars:</em> The chars (bytes) to remove. The default is space.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">trim</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a1␣b2␣c3&quot;</span>
<pre><code class='language-cpp'>let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trim(); // "a1␣b2␣c3"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">trim</span><span class="p">(</span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="p">);</span>
let v2 = trim("␣␣a1␣␣b2␣c3␣␣");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.trimfirst(trimchars = " ")</td><td>Ditto but only leading.
<tr><td>var=</td><td>strvar.trimfirst(trimchars = " ")</td><td>Ditto but only leading.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">trimfirst</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a1␣␣b2␣c3␣␣&quot;</span>
<pre><code class='language-cpp'>let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimfirst(); // "a1␣␣b2␣c3␣␣"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">trimfirst</span><span class="p">(</span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="p">);</span>
let v2 = trimfirst("␣␣a1␣␣b2␣c3␣␣");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.trimlast(trimchars = " ")</td><td>Ditto but only trailing.
<tr><td>var=</td><td>strvar.trimlast(trimchars = " ")</td><td>Ditto but only trailing.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">trimlast</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;␣␣a1␣␣b2␣c3&quot;</span>
<pre><code class='language-cpp'>let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimlast(); // "␣␣a1␣␣b2␣c3"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">trimlast</span><span class="p">(</span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="p">);</span>
let v2 = trimlast("␣␣a1␣␣b2␣c3␣␣");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.trimboth(trimchars = " ")</td><td>Ditto but only leading and trailing, not inner.
<tr><td>var=</td><td>strvar.trimboth(trimchars = " ")</td><td>Ditto but only leading and trailing, not inner.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">trimboth</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a1␣␣b2␣c3&quot;</span>
<pre><code class='language-cpp'>let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimboth(); // "a1␣␣b2␣c3"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">trimboth</span><span class="p">(</span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="p">);</span>
let v2 = trimboth("␣␣a1␣␣b2␣c3␣␣");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.first()</td><td><p>Get the first char of a string.
<tr><td>var=</td><td>strvar.first()</td><td><p>Get the first char of a string.
Line 1,077: Line 1,169:
</p>
</p>
Equivalent to var.substr(1,length) or var[1, length] in Pick OS
Equivalent to var.substr(1,length) or var[1, length] in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">first</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.first(); // "a"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">first</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = first("abc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.last()</td><td><p>Get the last char of a string.
<tr><td>var=</td><td>strvar.last()</td><td><p>Get the last char of a string.
</p>
</p>
Line 1,088: Line 1,179:
</p>
</p>
Equivalent to var.substr(-1, 1) or var[-1, 1] in Pick OS
Equivalent to var.substr(-1, 1) or var[-1, 1] in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">last</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;c&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.last(); // "c"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">last</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = last("abc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.first(std::size_t length)</td><td><p>Get the first n chars of a source string.
<tr><td>var=</td><td>strvar.first(length)</td><td><p>Get the first n chars of a source string.
</p>
</p>
<p><em>length:</em> The number of chars (bytes) to get.
<p><em>length:</em> The number of chars (bytes) to get.
Line 1,101: Line 1,191:
</p>
</p>
Equivalent to var.substr(1, length) or var[1, length] in Pick OS
Equivalent to var.substr(1, length) or var[1, length] in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">first</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;ab&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.first(2); // "ab"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">first</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
let v2 = first("abc", 2);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.last(std::size_t length)</td><td><p>Extract up to length trailing chars
<tr><td>var=</td><td>strvar.last(length)</td><td><p>Extract up to length trailing chars
</p>
</p>
Equivalent to var.substr(-length, length) or var[-length, length] in Pick OS
Equivalent to var.substr(-length, length) or var[-length, length] in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">last</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bc&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.last(2); // "bc"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">last</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
let v2 = last("abc", 2);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.cut(length)</td><td><p>Remove n chars (bytes) from the source string.
<tr><td>var=</td><td>strvar.cut(length)</td><td><p>Remove n chars (bytes) from the source string.
Line 1,123: Line 1,211:
</p>
</p>
Equivalent to var.substr(length) or var[1, length] = "" in Pick OS
Equivalent to var.substr(length) or var[1, length] = "" in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">cut</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;cd&quot;</span>
<pre><code class='language-cpp'>let v1 = "abcd"_var.cut(2); // "cd"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">cut</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
let v2 = cut("abcd", 2);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.paste(pos1, length, replacestr)</td><td><p>Insert a substr at an given position after removing a given number of chars.
<tr><td>var=</td><td>strvar.paste(pos1, length, replacestr)</td><td><p>Insert a substr at an given position after removing a given number of chars.
Line 1,141: Line 1,228:
</p>
</p>
Equivalent to var[pos1, length] = substr in Pick OS
Equivalent to var[pos1, length] = substr in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">paste</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;XYZ&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;aXYZd&quot;</span>
<pre><code class='language-cpp'>let v1 = "abcd"_var.paste(2, 2, "XYZ"); // "aXYZd"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">paste</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;XYZ&quot;</span><span class="p">);</span>
let v2 = paste("abcd", 2, 2, "XYZ");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.paste(pos1, insertstr)</td><td><p>Insert text at char position without overwriting any following chars
<tr><td>var=</td><td>strvar.paste(pos1, insertstr)</td><td><p>Insert text at char position without overwriting any following chars
</p>
</p>
Equivalent to var[pos1, 0] = substr in Pick OS
Equivalent to var[pos1, 0] = substr in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">paste</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;XYZ&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;aXYZbcd&quot;</span>
<pre><code class='language-cpp'>let v1 = "abcd"_var.paste(2, "XYZ"); // "aXYZbcd"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">paste</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;XYZ&quot;</span><span class="p">);</span>
let v2 = paste("abcd", 2, "XYZ");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.prefix(insertstr)</td><td><p>Insert text at the beginning
<tr><td>var=</td><td>strvar.prefix(insertstr)</td><td><p>Insert text at the beginning
</p>
</p>
Equivalent to var[0, 0] = substr in Pick OS
Equivalent to var[0, 0] = substr in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">prefix</span><span class="p">(</span><span class="s">&quot;XYZ&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;XYZabc&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.prefix("XYZ"); // "XYZabc"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">prefix</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;XYZ&quot;</span><span class="p">);</span>
let v2 = prefix("abc", "XYZ");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.append(appendable, ...)</td><td>Append anything at the end of a string
<tr><td>var=</td><td>strvar.append(appendable, ...)</td><td>Append anything at the end of a string
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s">&quot; is &quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="s">&quot; ok&quot;</span><span class="p">,</span><span class="w"> </span><span class="sc">&#39;.&#39;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;abc is 10 ok.&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.append(" is ", 10, " ok", '.'); // "abc is 10 ok."
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">append</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot; is &quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="s">&quot; ok&quot;</span><span class="p">,</span><span class="w"> </span><span class="sc">&#39;.&#39;</span><span class="p">);</span>
let v2 = append("abc", " is ", 10, " ok", '.');</code></pre>
</pre></div></td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.pop()</td><td><p>Remove one trailing char.
<tr><td>var=</td><td>strvar.pop()</td><td><p>Remove one trailing char.
</p>
</p>
Equivalent to var[-1, 1] = "" in Pick OS
Equivalent to var[-1, 1] = "" in Pick OS
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">pop</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;ab&quot;</span>
<pre><code class='language-cpp'>let v1 = "abc"_var.pop(); // "ab"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">pop</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
let v2 = pop("abc");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.field(delimiter, fieldnx = 1, nfieldsx = 1)</td><td><p>Copies one or more consecutive fields from a string given a delimiter
<tr><td>var=</td><td>strvar.field(delimiter, fieldnx = 1, nfieldsx = 1)</td><td><p>Copies one or more consecutive fields from a string given a delimiter
Line 1,187: Line 1,269:
</p>
</p>
<em>Returns:</em> A substring
<em>Returns:</em> A substring
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa*bb*cc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">field</span><span class="p">(</span><span class="s">&quot;*&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bb&quot;</span>
<pre><code class='language-cpp'>let v1 = "aa*bb*cc"_var.field("*", 2); // "bb"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">field</span><span class="p">(</span><span class="s">&quot;aa*bb*cc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;*&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
let v2 = field("aa*bb*cc", "*", 2);</code></pre>
</pre></div>
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa*bb*cc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">field</span><span class="p">(</span><span class="s">&quot;*&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">-1</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;cc&quot;</span>
 
<span class="c1">// or</span>
<pre><code class='language-cpp'>let v1 = "aa*bb*cc"_var.field("*", -1); // "cc"
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">field</span><span class="p">(</span><span class="s">&quot;aa*bb*cc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;*&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">-1</span><span class="p">);</span>
// or
</pre></div>
let v2 = field("aa*bb*cc", "*", -1);</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.field2(separator, fieldno, nfields = 1)</td><td></td></tr>
<tr><td>var=</td><td>strvar.fieldstore(separator, fieldno, nfields, replacement)</td><td><p>fieldstore() replaces, inserts or deletes subfields in a string.
<tr><td>var=</td><td>strvar.fieldstore(separator, fieldno, nfields, replacement)</td><td><p>fieldstore() replaces, inserts or deletes subfields in a string.
</p>
</p>
Line 1,212: Line 1,293:


The replacement can contain multiple fields itself. If replacing n fields and the replacement contains < n fields then the remaining fields become "". Conversely, if the replacement contains more fields than are required, they are discarded.
The replacement can contain multiple fields itself. If replacing n fields and the replacement contains < n fields then the remaining fields become "". Conversely, if the replacement contains more fields than are required, they are discarded.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa,bb,cc,dd,ee&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">fieldstore</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;11,22&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;aa,11,22,,ee&quot;</span>
<pre><code class='language-cpp'>let v1 = "aa,bb,cc,dd,ee"_var.fieldstore(",", 2, 3, "11,22"); // "aa,11,22,,ee"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">fieldstore</span><span class="p">(</span><span class="s">&quot;aa,bb,cc,dd,ee&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;,&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;11,22&quot;</span><span class="p">);</span>
let v2 = fieldstore("aa,bb,cc,dd,ee", ",", 2, 3, "11,22");</code></pre>
</pre></div>
 
If nfields is 0 then insert the replacement field(s) before fieldno
If nfields is 0 then insert the replacement field(s) before fieldno
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa,bb,cc,dd,ee&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">fieldstore</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;11,22&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;aa,11,22,bb,cc,dd,ee&quot;</span>
<pre><code class='language-cpp'>let v1 = "aa,bb,cc,dd,ee"_var.fieldstore(",", 2, 0, "11,22"); // "aa,11,22,bb,cc,dd,ee"</code></pre>
</pre></div>
 
If nfields is negative then delete abs(n) fields before inserting whatever fields the replacement has.
If nfields is negative then delete abs(n) fields before inserting whatever fields the replacement has.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa,bb,cc,dd,ee&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">fieldstore</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">-2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;11&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;aa,11,dd,ee&quot;</span>
<pre><code class='language-cpp'>let v1 = "aa,bb,cc,dd,ee"_var.fieldstore(",", 2, -2, "11"); // "aa,11,dd,ee"</code></pre>
</pre></div>
 
If nfields exceeds the number of fields in the input then additional empty fields are added.
If nfields exceeds the number of fields in the input then additional empty fields are added.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aa,bb,cc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">fieldstore</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;11&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;aa,bb,cc,,,11,&quot;</span>
<pre><code class='language-cpp'>let v1 = "aa,bb,cc"_var.fieldstore(",", 6, 2, "11"); // "aa,bb,cc,,,11,"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.substr(pos1, length)</td><td><p>substr version 1.
<tr><td>var=</td><td>strvar.substr(pos1, length)</td><td><p>substr version 1.
Line 1,243: Line 1,320:
</p>
</p>
Not Unicode friendly.
Not Unicode friendly.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">substr</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bc&quot;</span>
<pre><code class='language-cpp'>let v1 = "abcd"_var.substr(2, 2); // "bc"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">substr</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
let v2 = substr("abcd", 2, 2);</code></pre>
</pre></div>
 
If pos1 is negative then start counting backwards from the last char
If pos1 is negative then start counting backwards from the last char
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">substr</span><span class="p">(</span><span class="mi">-3</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bc&quot;</span>
<pre><code class='language-cpp'>let v1 = "abcd"_var.substr(-3, 2); // "bc"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">substr</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">-3</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
let v2 = substr("abcd", -3, 2);</code></pre>
</pre></div>
 
If length is negative then work backwards and return chars reversed
If length is negative then work backwards and return chars reversed
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">substr</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">-2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;cb&quot;</span>
<pre><code class='language-cpp'>let v1 = "abcd"_var.substr(3, -2); // "cb"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">substr</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">-2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;cb&quot;</span>
let v2 = substr("abcd", 3, -2); // "cb"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.b(pos1, length)</td><td>Abbreviated alias of substr version 1.</td></tr>
<tr><td>var=</td><td>strvar.b(pos1, length)</td><td>Abbreviated alias of substr version 1.</td></tr>
Line 1,273: Line 1,347:
</p>
</p>
Partially Unicode friendly but pos1 is in chars.
Partially Unicode friendly but pos1 is in chars.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcd&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">substr</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;bcd&quot;</span>
<pre><code class='language-cpp'>let v1 = "abcd"_var.substr(2); // "bcd"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">substr</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
let v2 = substr("abcd", 2);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.b(pos1)</td><td>Shorthand alias of substr version 2.</td></tr>
<tr><td>var=</td><td>strvar.b(pos1)</td><td>Shorthand alias of substr version 2.</td></tr>
Line 1,303: Line 1,376:
</p>
</p>
This function is similar to std::string::find_first_of but that function only returns pos2.
This function is similar to std::string::find_first_of but that function only returns pos2.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">pos1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">;</span>
<pre><code class='language-cpp'>var pos1 = 4;
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;12,45 78&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">substr</span><span class="p">(</span><span class="n">pos1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;, &quot;</span><span class="p">,</span><span class="w"> </span><span class="n">COL2</span><span class="p">);</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;45&quot; // COL2 -&gt; 6 // 6 is the position of the next delimiter char found.</span>
let v1 = "12,45 78"_var.substr(pos1, ", ", COL2);  // v1 -> "45" // COL2 -> 6 // 6 is the position of the next delimiter char found.
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">substr</span><span class="p">(</span><span class="s">&quot;12,45 78&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">COL2</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;, &quot;</span><span class="p">,</span><span class="w"> </span><span class="n">COL2</span><span class="p">);</span><span class="w"> </span><span class="c1">// v2 -&gt; &quot;78&quot; // COL2 -&gt; 9 // 9 is one after the end of the string meaning that none of the delimiter chars were found.</span>
let v2 = substr("12,45 78", COL2 + 1, ", ", COL2); // v2 -> "78" // COL2 -> 9 // 9 is one after the end of the string meaning that none of the delimiter chars were found.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.b(pos1, delimiterchars, out pos2)</td><td>Shorthand alias of substr version 3.</td></tr>
<tr><td>var=</td><td>strvar.b(pos1, delimiterchars, out pos2)</td><td>Shorthand alias of substr version 3.</td></tr>
Line 1,338: Line 1,410:
</p>
</p>
It is similar to version 3 of substr - substr(pos1, delimiterchars, pos2) except that in this version the delimiter chars are hard coded as the standard field mark chars (RM, FM, VM, SM, TM, ST) and it returns the first char position of the next substr, not the char position of the next field mark char.
It is similar to version 3 of substr - substr(pos1, delimiterchars, pos2) except that in this version the delimiter chars are hard coded as the standard field mark chars (RM, FM, VM, SM, TM, ST) and it returns the first char position of the next substr, not the char position of the next field mark char.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">pos1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="n">field_mark_no</span><span class="p">;</span>
<pre><code class='language-cpp'>var pos1 = 4, field_mark_no;
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;12^45^78&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">substr2</span><span class="p">(</span><span class="n">pos1</span><span class="p">,</span><span class="w"> </span><span class="n">field_mark_no</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;45&quot; // pos1 -&gt; 7 // field_mark_no -&gt; 2 // field_mark_no 2 means that a FM was found.</span>
let v1 = "12^45^78"_var.substr2(pos1, field_mark_no);  // "45" // pos1 -> 7 // field_mark_no -> 2 // field_mark_no 2 means that a FM was found.
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">substr2</span><span class="p">(</span><span class="s">&quot;12^45^78&quot;</span><span class="kt">_var</span><span class="p">,</span><span class="w"> </span><span class="n">pos1</span><span class="p">,</span><span class="w"> </span><span class="n">field_mark_no</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;78&quot; // pos1 -&gt; 9 // field_mark_no -&gt; 0 // field_mark_no 0 means that none of the standard field marks were found.</span>
let v2 = substr2("12^45^78"_var, pos1, field_mark_no); // "78" // pos1 -> 9 // field_mark_no -> 0 // field_mark_no 0 means that none of the standard field marks were found.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.b2(io pos1, out field_mark_no)</td><td>Shorthand alias of substr version 4.</td></tr>
<tr><td>var=</td><td>strvar.b2(io pos1, out field_mark_no)</td><td>Shorthand alias of substr version 4.</td></tr>
Line 1,353: Line 1,424:
</p>
</p>
Not UTF8 compatible.
Not UTF8 compatible.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abcde&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">convert</span><span class="p">(</span><span class="s">&quot;aZd&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;XY&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;Xbce&quot; // a is replaced and d is removed</span>
<pre><code class='language-cpp'>let v1 = "abcde"_var.convert("aZd", "XY"); // "Xbce" // a is replaced and d is removed
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">convert</span><span class="p">(</span><span class="s">&quot;abcde&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;aZd&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;XY&quot;</span><span class="p">);</span>
let v2 = convert("abcde", "aZd", "XY");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.textconvert(fromchars, tochars)</td><td>Ditto for Unicode code points.
<tr><td>var=</td><td>strvar.textconvert(fromchars, tochars)</td><td>Ditto for Unicode code points.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a🤡b😀c🌍d&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">textconvert</span><span class="p">(</span><span class="s">&quot;🤡😀&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;👋&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;a👋bc🌍d&quot;</span>
<pre><code class='language-cpp'>let v1 = "a🤡b😀c🌍d"_var.textconvert("🤡😀", "👋"); // "a👋bc🌍d"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">textconvert</span><span class="p">(</span><span class="s">&quot;a🤡b😀c🌍d&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;🤡😀&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;👋&quot;</span><span class="p">);</span>
let v2 = textconvert("a🤡b😀c🌍d", "🤡😀", "👋");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.replace(fromstr, tostr)</td><td><p>Replace all occurrences of one substr with another.
<tr><td>var=</td><td>strvar.replace(fromstr, tostr)</td><td><p>Replace all occurrences of one substr with another.
</p>
</p>
Case sensitive.
Case sensitive.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Abc.Abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span><span class="s">&quot;bc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;AX.AX&quot;</span>
<pre><code class='language-cpp'>let v1 = "Abc.Abc"_var.replace("bc", "X"); // "AX.AX"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">replace</span><span class="p">(</span><span class="s">&quot;Abc Abc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bc&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span>
let v2 = replace("Abc Abc", "bc", "X");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.replace(regex, replacement_str)</td><td><p>Replace substrings using a regular expression.
<tr><td>var=</td><td>strvar.replace(regex, replacement_str)</td><td><p>Replace substrings using a regular expression.
Line 1,385: Line 1,453:
<p>Pattern  Inserts
<p>Pattern  Inserts
</p>
</p>
<p>$$       Inserts a "$".
<p>* $$     Inserts a "$".
</p>
</p>
<p>$&       Inserts the matched substring. Equivalent to $0.
<p>* $&     Inserts the matched substring. Equivalent to $0.
</p>
</p>
<p>$`       Inserts the portion of the string that precedes the matched substring.
<p>* $`     Inserts the portion of the string that precedes the matched substring.
</p>
</p>
<p>$'       Inserts the portion of the string that follows the matched substring.
<p>* $'     Inserts the portion of the string that follows the matched substring.
</p>
</p>
$n       Inserts the nth (1-indexed) capturing group where n is a positive integer less than 100.
* $n     Inserts the nth (1-indexed) capturing group where n is a positive integer less than 100.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;A a B b&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span><span class="s">&quot;[A-Z]&quot;</span><span class="kt">_rex</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;&#39;$0&#39;&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;&#39;A&#39; a &#39;B&#39; b&quot;</span>
<pre><code class='language-cpp'>let v1 = "A a B b"_var.replace("[A-Z]"_rex, "'$0'"); // "'A' a 'B' b"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">replace</span><span class="p">(</span><span class="s">&quot;A a B b&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;[A-Z]&quot;</span><span class="kt">_rex</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;&#39;$0&#39;&quot;</span><span class="p">);</span>
let v2 = replace("A a B b", "[A-Z]"_rex, "'$0'");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.replace(regex, SomeFunction(match_str))</td><td><p>Replace substrings using a regular expression and a custom function.
<tr><td>var=</td><td>strvar.replace(regex, ReplacementFunction auto repl_func)</td><td><p>Replace substrings using a regular expression and a custom function.
</p>
</p>
<p>Allows very complex string conversions.
<p>Allows complex string conversions.
</p>
</p>
<p><em>SomeFunction:</em> Must return a var. Can be an inline anonymous lambda function.
<p><em>repl_func:</em> A function with arguments (in match_str) that returns a var to replace match_str. May be an inline anonymous lambda function (capturing or non-capturing).
</p>
</p>
<p>e.g. [](auto match_str) {return match_str;} // Does nothing.
<p>e.g. [](auto match_str) {return match_str;} // Does nothing.
</p>
</p>
<em>match_str:</em> Text of a single match. If regex groups are used, match_str.f(1, 1) is the whole match, match_str.f(1, 2) is the first group, etc.
<em>match_str:</em> Text of a single match. If regex groups are used, match_str.f(1, 1) is the whole match, match_str.f(1, 2) is the first group, etc.
 
<div class="highlight light"><pre><span class="c1">// Decode hex escape codes.</span>
<pre><code class='language-cpp'>// Decode hex escape codes.
<span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="sa">R</span><span class="s">&quot;</span><span class="dl">(</span><span class="s">--\0x3B--\0x2F--</span><span class="dl">)</span><span class="s">&quot;</span><span class="p">;</span><span class="w">                                 </span><span class="c1">// Hex escape codes.</span>
var v1 = R"(--\0x3B--\0x2F--)";                                // Hex escape codes.
<span class="n">v1</span><span class="p">.</span><span class="nf">replacer</span><span class="p">(</span>
v1.replacer(
<span class="w">    </span><span class="sa">R</span><span class="s">&quot;</span><span class="dl">(</span><span class="s">\\0x[0-9a-fA-F]{2,2}</span><span class="dl">)</span><span class="s">&quot;</span><span class="kt">_rex</span><span class="p">,</span><span class="w">                             </span><span class="c1">// Finds \0xFF.</span>
    R"(\\0x[0-9a-fA-F]{2,2})"_rex,                              // Finds \0xFF.
<span class="w">    </span><span class="p">[](</span><span class="k">auto</span><span class="w"> </span><span class="n">match_str</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="kr">return</span><span class="w"> </span><span class="n">match_str</span><span class="p">.</span><span class="nf">cut</span><span class="p">(</span><span class="mi">3</span><span class="p">).</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;HEX&quot;</span><span class="p">);}</span><span class="w"> </span><span class="c1">// Decodes to a char.</span>
    [](auto match_str) {return match_str.cut(3).iconv("HEX");}  // Decodes to a char.
<span class="p">);</span>
);
<span class="n">assert</span><span class="p">(</span><span class="n">v1</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;--;--/--&quot;</span><span class="p">);</span>
assert(v1 == "--;--/--");
</pre></div>
 
<div class="highlight light"><pre><span class="c1">// Reformat dates using groups.</span>
// Reformat dates using groups.
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Date: 03-15-2025&quot;</span><span class="p">;</span>
var v2 = "Date: 03-15-2025";
<span class="n">v2</span><span class="p">.</span><span class="nf">replacer</span><span class="p">(</span>
v2.replacer(
<span class="w">    </span><span class="sa">R</span><span class="s">&quot;</span><span class="dl">(</span><span class="s">(\d{2})-(\d{2})-(\d{4})</span><span class="dl">)</span><span class="s">&quot;</span><span class="kt">_rex</span><span class="p">,</span>
    R"((\d{2})-(\d{2})-(\d{4}))"_rex,
<span class="w">    </span><span class="p">[](</span><span class="k">auto</span><span class="w"> </span><span class="n">match_str</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="kr">return</span><span class="w"> </span><span class="n">match_str</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">)</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;-&quot;</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="n">match_str</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">)</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;-&quot;</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="n">match_str</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">);}</span>
    [](auto match_str) {return match_str.f(1, 4) ^ "-" ^ match_str.f(1, 2) ^ "-" ^ match_str.f(1, 3);}
<span class="p">);</span>
);
<span class="n">assert</span><span class="p">(</span><span class="n">v2</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;Date: 2025-03-15&quot;</span><span class="p">);</span>
assert(v2 == "Date: 2025-03-15");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.unique()</td><td>Remove duplicate fields in an FM or VM etc. separated list
<tr><td>var=</td><td>strvar.unique()</td><td>Remove duplicate fields in an FM or VM etc. separated list
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a1^b2^a1^c2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">unique</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a1^b2^c2&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "a1^b2^a1^c2"_var.unique(); // "a1^b2^c2"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">unique</span><span class="p">(</span><span class="s">&quot;a1^b2^a1^c2&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = unique("a1^b2^a1^c2"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.sort(delimiter = FM)</td><td><p>Reorder fields in an FM or VM etc. separated list in ascending order
<tr><td>var=</td><td>strvar.sort(delimiter = FM)</td><td><p>Reorder fields in an FM or VM etc. separated list in ascending order
</p>
</p>
Numeric data:
Numeric data:
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;20^10^2^1^1.1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">sort</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;1^1.1^2^10^20&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "20^10^2^1^1.1"_var.sort(); // "1^1.1^2^10^20"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">sort</span><span class="p">(</span><span class="s">&quot;20^10^2^1^1.1&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = sort("20^10^2^1^1.1"_var);</code></pre>
</pre></div>
 
Alphabetic data:
Alphabetic data:
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;b1^a1^c20^c10^c2^c1^b2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">sort</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;a1^b1^b2^c1^c10^c2^c20&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "b1^a1^c20^c10^c2^c1^b2"_var.sort(); // "a1^b1^b2^c1^c10^c2^c20"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">sort</span><span class="p">(</span><span class="s">&quot;b1^a1^c20^c10^c2^c1^b2&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = sort("b1^a1^c20^c10^c2^c1^b2"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.reverse(delimiter = FM)</td><td>Reorder fields in an FM or VM etc. separated list in descending order
<tr><td>var=</td><td>strvar.reverse(delimiter = FM)</td><td>Reorder fields in an FM or VM etc. separated list in descending order
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;20^10^2^1^1.1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">reverse</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;1.1^1^2^10^20&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "20^10^2^1^1.1"_var.reverse(); // "1.1^1^2^10^20"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">reverse</span><span class="p">(</span><span class="s">&quot;20^10^2^1^1.1&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = reverse("20^10^2^1^1.1"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.shuffle(delimiter = FM)</td><td>Randomise the order of fields in an FM, VM separated list
<tr><td>var=</td><td>strvar.shuffle(delimiter = FM)</td><td>Randomise the order of fields in an FM, VM separated list
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;20^10^2^1^1.1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">shuffle</span><span class="p">();</span><span class="w"> </span><span class="c1">/// e.g. &quot;2^1^20^1.1^10&quot; (random order depending on initrand())</span>
<pre><code class='language-cpp'>let v1 = "20^10^2^1^1.1"_var.shuffle(); /// e.g. "2^1^20^1.1^10" (random order depending on initrand())
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">shuffle</span><span class="p">(</span><span class="s">&quot;20^10^2^1^1.1&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = shuffle("20^10^2^1^1.1"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.parse(char sepchar = ' ')</td><td><p>Split a delimited string with embedded quotes into a dynamic array.
<tr><td>var=</td><td>strvar.parse(char sepchar = ' ')</td><td><p>Split a delimited string with embedded quotes into a dynamic array.
Line 1,468: Line 1,529:
</p>
</p>
Replaces separator chars with FM chars except inside double or single quotes and ignoring escaped quotes &bsol;" &bsol;'
Replaces separator chars with FM chars except inside double or single quotes and ignoring escaped quotes &bsol;" &bsol;'
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc,</span><span class="se">\&quot;</span><span class="s">def,</span><span class="se">\&quot;</span><span class="s">123</span><span class="se">\&quot;</span><span class="s"> fgh</span><span class="se">\&quot;</span><span class="s">,12.34&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">parse</span><span class="p">(</span><span class="sc">&#39;,&#39;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;abc^\&quot;def,\&quot;123\&quot; fgh\&quot;^12.34&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "abc,\"def,\"123\" fgh\",12.34"_var.parse(','); // "abc^\"def,\"123\" fgh\"^12.34"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">parse</span><span class="p">(</span><span class="s">&quot;abc,</span><span class="se">\&quot;</span><span class="s">def,</span><span class="se">\&quot;</span><span class="s">123</span><span class="se">\&quot;</span><span class="s"> fgh</span><span class="se">\&quot;</span><span class="s">,12.34&quot;</span><span class="p">,</span><span class="w"> </span><span class="sc">&#39;,&#39;</span><span class="p">);</span>
let v2 = parse("abc,\"def,\"123\" fgh\",12.34", ',');</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>dim=</td><td>strvar.split(delimiter = FM)</td><td><p>Split a delimited string into a dim array.
<tr><td>dim=</td><td>strvar.split(delimiter = FM)</td><td><p>Split a delimited string into a dim array.
Line 1,479: Line 1,539:
</p>
</p>
<em>Returns:</em> A dim array.
<em>Returns:</em> A dim array.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a^b^c&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">split</span><span class="p">();</span><span class="w"> </span><span class="c1">// A dimensioned array with three elements (vars)</span>
<pre><code class='language-cpp'>dim d1 = "a^b^c"_var.split(); // A dimensioned array with three elements (vars)
<span class="c1">// or</span>
// or
<span class="nf">dim</span><span class="w"> </span><span class="n">d2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">split</span><span class="p">(</span><span class="s">&quot;a^b^c&quot;</span><span class="kt">_var</span><span class="p">);</span>
dim d2 = split("a^b^c"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.fieldstore(delimiter, fieldno, nfields, replacement)</td><td></td></tr>
<tr><td>var=</td><td>strvar.fieldstore(delimiter, fieldno, nfields, replacement)</td><td></td></tr>
Line 1,494: Line 1,553:
</p>
</p>
All string mutators follow the same pattern as ucaser.<br>See the non-mutating functions for details.
All string mutators follow the same pattern as ucaser.<br>See the non-mutating functions for details.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "abc";
<span class="n">v1</span><span class="p">.</span><span class="nf">ucaser</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;ABC&quot;</span>
v1.ucaser(); // "ABC"
<span class="c1">// or</span>
// or
<span class="nf">ucaser</span><span class="p">(</span><span class="n">v1</span><span class="p">);</span>
ucaser(v1);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>strvar.lcaser()</td><td></td></tr>
<tr><td></td><td>strvar.lcaser()</td><td></td></tr>
Line 1,518: Line 1,576:
<tr><td></td><td>strvar.firster()</td><td></td></tr>
<tr><td></td><td>strvar.firster()</td><td></td></tr>
<tr><td></td><td>strvar.laster()</td><td></td></tr>
<tr><td></td><td>strvar.laster()</td><td></td></tr>
<tr><td></td><td>strvar.firster(std::size_t length)</td><td></td></tr>
<tr><td></td><td>strvar.firster(length)</td><td></td></tr>
<tr><td></td><td>strvar.laster(std::size_t length)</td><td></td></tr>
<tr><td></td><td>strvar.laster(length)</td><td></td></tr>
<tr><td></td><td>strvar.cutter(length)</td><td></td></tr>
<tr><td></td><td>strvar.cutter(length)</td><td></td></tr>
<tr><td></td><td>strvar.paster(pos1, length, insertstr)</td><td></td></tr>
<tr><td></td><td>strvar.paster(pos1, length, insertstr)</td><td></td></tr>
Line 1,532: Line 1,590:
<tr><td></td><td>strvar.textconverter(from_characters, to_characters)</td><td></td></tr>
<tr><td></td><td>strvar.textconverter(from_characters, to_characters)</td><td></td></tr>
<tr><td></td><td>strvar.replacer(regex, tostr)</td><td></td></tr>
<tr><td></td><td>strvar.replacer(regex, tostr)</td><td></td></tr>
<tr><td></td><td>strvar.replacer(regex, SomeFunction(match_str))</td><td></td></tr>
<tr><td></td><td>strvar.replacer(regex, ReplacementFunction auto repl_func)</td><td></td></tr>
<tr><td></td><td>strvar.replacer(fromstr, tostr)</td><td></td></tr>
<tr><td></td><td>strvar.replacer(fromstr, tostr)</td><td></td></tr>
<tr><td></td><td>strvar.uniquer()</td><td></td></tr>
<tr><td></td><td>strvar.uniquer()</td><td></td></tr>
Line 1,551: Line 1,609:
</p>
</p>
See [[#ICONV/OCONV PATTERNS]]
See [[#ICONV/OCONV PATTERNS]]
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">30123</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;D/E&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;21/06/2050&quot;</span>
<pre><code class='language-cpp'>let v1 = var(30123).oconv("D/E"); // "21/06/2050"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oconv</span><span class="p">(</span><span class="mi">30123</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;D/E&quot;</span><span class="p">);</span>
let v2 = oconv(30123, "D/E");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var.iconv(convstr)</td><td><p>Converts external data to internal format according to a given conversion code or pattern
<tr><td>var=</td><td>var.iconv(convstr)</td><td><p>Converts external data to internal format according to a given conversion code or pattern
Line 1,564: Line 1,621:
</p>
</p>
See [[#ICONV/OCONV PATTERNS]]
See [[#ICONV/OCONV PATTERNS]]
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;21 JUN 2050&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;D/E&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// 30123</span>
<pre><code class='language-cpp'>let v1 = "21 JUN 2050"_var.iconv("D/E"); // 30123
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;21 JUN 2050&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;D/E&quot;</span><span class="p">);</span>
let v2 = iconv("21 JUN 2050", "D/E");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var.format(fmt_str, args, ...)</td><td><p>Classic format function in printf style
<tr><td>var=</td><td>var.format(fmt_str, args, ...)</td><td><p>Classic format function in printf style
Line 1,575: Line 1,631:
</p>
</p>
or with exodus oconv codes e.g. {::MD20P|R(_)#8} as in the below example.
or with exodus oconv codes e.g. {::MD20P|R(_)#8} as in the below example.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">12.345</span><span class="p">).</span><span class="nf">format</span><span class="p">(</span><span class="s">&quot;&#39;{:_&gt;8.2f}&#39;&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;&#39;___12.35&#39;&quot;</span>
<pre><code class='language-cpp'>let v1 = var(12.345).format("'{:_>8.2f}'"); // "'___12.35'"
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">12.345</span><span class="p">).</span><span class="nf">format</span><span class="p">(</span><span class="s">&quot;&#39;{::MD20P|R(_)#8}&#39;&quot;</span><span class="p">);</span>
let v2 = var(12.345).format("'{::MD20P|R(_)#8}'");
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">format</span><span class="p">(</span><span class="s">&quot;&#39;{:_&gt;8.2f}&#39;&quot;</span><span class="p">,</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">12.345</span><span class="p">));</span><span class="w"> </span><span class="c1">// &quot;&#39;___12.35&#39;&quot;</span>
var v3 = format("'{:_>8.2f}'", var(12.345)); // "'___12.35'"
<span class="kt">var</span><span class="w"> </span><span class="n">v4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">format</span><span class="p">(</span><span class="s">&quot;&#39;{::MD20P|R(_)#8}&#39;&quot;</span><span class="p">,</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">12.345</span><span class="p">));</span>
var v4 = format("'{::MD20P|R(_)#8}'", var(12.345));</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.from_codepage(codepage)</td><td><p>Converts from codepage encoded text to UTF-8 encoded exodus text
<tr><td>var=</td><td>strvar.from_codepage(codepage)</td><td><p>Converts from codepage encoded text to UTF-8 encoded exodus text
Line 1,588: Line 1,643:
</p>
</p>
Use Linux command "iconv -l" for complete list of code pages and encodings.
Use Linux command "iconv -l" for complete list of code pages and encodings.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\xa4</span><span class="s">&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">from_codepage</span><span class="p">(</span><span class="s">&quot;CP1124&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;Є&quot;</span>
<pre><code class='language-cpp'>let v1 = "\xa4"_var.from_codepage("CP1124"); // "Є"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">from_codepage</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\xa4</span><span class="s">&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;CP1124&quot;</span><span class="p">);</span>
let v2 = from_codepage("\xa4", "CP1124");
<span class="c1">// U+0404 Cyrillic Capital Letter Ukrainian Ie Unicode character</span>
// U+0404 Cyrillic Capital Letter Ukrainian Ie Unicode character</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.to_codepage(codepage)</td><td>Converts to codepage encoded text from exodus UTF-8 encoded text
<tr><td>var=</td><td>strvar.to_codepage(codepage)</td><td>Converts to codepage encoded text from exodus UTF-8 encoded text
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Є&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">to_codepage</span><span class="p">(</span><span class="s">&quot;CP1124&quot;</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;HEX&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;A4&quot;</span>
<pre><code class='language-cpp'>let v1 = "Є"_var.to_codepage("CP1124").oconv("HEX"); // "A4"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">to_codepage</span><span class="p">(</span><span class="s">&quot;Є&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;CP1124&quot;</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;HEX&quot;</span><span class="p">);</span>
let v2 = to_codepage("Є", "CP1124").oconv("HEX");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 1,614: Line 1,667:
</p>
</p>
The abbreviated exodus field extraction function (e.g. xxx.f(20)) is provided instead since field access is extremely heavily used in source code.
The abbreviated exodus field extraction function (e.g. xxx.f(20)) is provided instead since field access is extremely heavily used in source code.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^f2v1]f2v2]f2v3^f2&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let v1 = "f1^f2v1]f2v2]f2v3^f2"_var;
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f2v2&quot;</span>
let v2 = v1.f(2, 2); // "f2v2"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.extract(fieldno, valueno = 0, subvalueno = 0)</td><td>Extract a specific field, value or subvalue from a dynamic array.
<tr><td>var=</td><td>strvar.extract(fieldno, valueno = 0, subvalueno = 0)</td><td>Extract a specific field, value or subvalue from a dynamic array.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^f2v1]f2v2]f2v3^f2&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let v1 = "f1^f2v1]f2v2]f2v3^f2"_var;
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">extract</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f2v2&quot;</span>
let v2 = v1.extract(2, 2); // "f2v2"
<span class="c1">//</span>
//
<span class="c1">// For brevity the function alias &quot;f()&quot; (standing for &quot;field&quot;) is normally used instead of &quot;extract()&quot; as follows:</span>
// For brevity the function alias "f()" (standing for "field") is normally used instead of "extract()" as follows:
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
var v3 = v1.f(2, 2);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.update(fieldno, valueno, subvalueno, replacement)</td><td><p>Same as var.updater() function but returns a new string instead of updating a variable in place.<br>Rarely used.
<tr><td>var=</td><td>strvar.update(fieldno, valueno, subvalueno, replacement)</td><td><p>Same as var.updater() function but returns a new string instead of updating a variable in place.<br>Rarely used.
Line 1,645: Line 1,696:
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>strvar.sum()</td><td>Sum up multiple values into one higher level
<tr><td>var=</td><td>strvar.sum()</td><td>Sum up multiple values into one higher level
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;1]2]3^4]5]6&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">sum</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;6^15&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "1]2]3^4]5]6"_var.sum(); // "6^15"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">sum</span><span class="p">(</span><span class="s">&quot;1]2]3^4]5]6&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = sum("1]2]3^4]5]6"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.sumall()</td><td>Sum up all levels into a single figure
<tr><td>var=</td><td>strvar.sumall()</td><td>Sum up all levels into a single figure
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;1]2]3^4]5]6&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">sumall</span><span class="p">();</span><span class="w"> </span><span class="c1">// 21</span>
<pre><code class='language-cpp'>let v1 = "1]2]3^4]5]6"_var.sumall(); // 21
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">sumall</span><span class="p">(</span><span class="s">&quot;1]2]3^4]5]6&quot;</span><span class="kt">_var</span><span class="p">);</span>
let v2 = sumall("1]2]3^4]5]6"_var);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.sum(delimiter)</td><td>Ditto allowing commas etc.
<tr><td>var=</td><td>strvar.sum(delimiter)</td><td>Ditto allowing commas etc.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;10,20,30&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">sum</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// 60</span>
<pre><code class='language-cpp'>let v1 = "10,20,30"_var.sum(","); // 60
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">sum</span><span class="p">(</span><span class="s">&quot;10,20,30&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;,&quot;</span><span class="p">);</span>
let v2 = sum("10,20,30", ",");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.mv(opcode, var2)</td><td>Binary ops (+, -, *, /) in parallel on multiple values
<tr><td>var=</td><td>strvar.mv(opcode, var2)</td><td>Binary ops (+, -, *, /) in parallel on multiple values
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;10]20]30&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">mv</span><span class="p">(</span><span class="s">&quot;+&quot;</span><span class="p">,</span><span class="s">&quot;2]3]4&quot;</span><span class="kt">_var</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;12]23]34&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "10]20]30"_var.mv("+","2]3]4"_var); // "12]23]34"_var</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 1,676: Line 1,723:
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td></td><td>strvar.updater(fieldno, replacement)</td><td>Replace a specific field in a dynamic array
<tr><td></td><td>strvar.updater(fieldno, replacement)</td><td>Replace a specific field in a dynamic array
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<span class="n">v1</span><span class="p">.</span><span class="nf">updater</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f1^X^f3&quot;_var</span>
v1.updater(2, "X"); // "f1^X^f3"_var
<span class="c1">// or</span>
// or
<span class="n">v1</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">;</span><span class="w"> </span><span class="c1">/// Easiest.</span>
v1(2) = "X"; /// Easiest.
<span class="c1">// or</span>
// or
<span class="nf">updater</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span>
updater(v1, 2, "X");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>strvar.updater(fieldno, valueno, replacement)</td><td>Replace a specific value of a specific field in a dynamic array.
<tr><td></td><td>strvar.updater(fieldno, valueno, replacement)</td><td>Replace a specific value of a specific field in a dynamic array.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<span class="n">v1</span><span class="p">.</span><span class="nf">updater</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f1^v1]X^f3&quot;_var</span>
v1.updater(2, 2, "X"); // "f1^v1]X^f3"_var
<span class="c1">// or</span>
// or
<span class="n">v1</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">;</span><span class="w"> </span><span class="c1">/// Easiest.</span>
v1(2, 2) = "X"; /// Easiest.
<span class="c1">// or</span>
// or
<span class="nf">updater</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span>
updater(v1, 2, 2, "X");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>strvar.updater(fieldno, valueno, subvalueno, replacement)</td><td>Replace a specific subvalue of a specific value of a specific field in a dynamic array.
<tr><td></td><td>strvar.updater(fieldno, valueno, subvalueno, replacement)</td><td>Replace a specific subvalue of a specific value of a specific field in a dynamic array.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<span class="n">v1</span><span class="p">.</span><span class="nf">updater</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f1^v1]v2}X}s3^f3&quot;_var</span>
v1.updater(2, 2, 2, "X"); // "f1^v1]v2}X}s3^f3"_var
<span class="c1">// or</span>
// or
<span class="n">v1</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">;</span><span class="w"> </span><span class="c1">/// Easiest.</span>
v1(2, 2, 2) = "X"; /// Easiest.
<span class="c1">// or</span>
// or
<span class="nf">updater</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span>
updater(v1, 2, 2, 2, "X");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>strvar.inserter(fieldno, insertion)</td><td>Insert a specific field in a dynamic array, moving all other fields up.
<tr><td></td><td>strvar.inserter(fieldno, insertion)</td><td>Insert a specific field in a dynamic array, moving all other fields up.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<span class="n">v1</span><span class="p">.</span><span class="nf">inserter</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f1^X^v1]v2}s2}s3^f3&quot;_var</span>
v1.inserter(2, "X"); // "f1^X^v1]v2}s2}s3^f3"_var
<span class="c1">// or</span>
// or
<span class="nf">inserter</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span>
inserter(v1, 2, "X");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>strvar.inserter(fieldno, valueno, insertion)</td><td>Ditto for a specific value in a specific field, moving all other values up.
<tr><td></td><td>strvar.inserter(fieldno, valueno, insertion)</td><td>Ditto for a specific value in a specific field, moving all other values up.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<span class="n">v1</span><span class="p">.</span><span class="nf">inserter</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f1^v1]X]v2}s2}s3^f3&quot;_var</span>
v1.inserter(2, 2, "X"); // "f1^v1]X]v2}s2}s3^f3"_var
<span class="c1">// or</span>
// or
<span class="nf">inserter</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span>
inserter(v1, 2, 2, "X");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>strvar.inserter(fieldno, valueno, subvalueno, insertion)</td><td>Ditto for a specific subvalue in a dynamic array, moving all other subvalues up.
<tr><td></td><td>strvar.inserter(fieldno, valueno, subvalueno, insertion)</td><td>Ditto for a specific subvalue in a dynamic array, moving all other subvalues up.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<span class="n">v1</span><span class="p">.</span><span class="nf">inserter</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f1^v1]v2}X}s2}s3^f3&quot;_var</span>
v1.inserter(2, 2, 2, "X"); // "f1^v1]v2}X}s2}s3^f3"_var
<span class="c1">// or</span>
// or
<span class="n">v1</span><span class="p">.</span><span class="nf">inserter</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span>
v1.inserter(2, 2, 2, "X");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>strvar.remover(fieldno, valueno = 0, subvalueno = 0)</td><td>Remove a specific field (or value, or subvalue) from a dynamic array, moving all other fields (or values, or subvalues)  down.
<tr><td></td><td>strvar.remover(fieldno, valueno = 0, subvalueno = 0)</td><td>Remove a specific field (or value, or subvalue) from a dynamic array, moving all other fields (or values, or subvalues)  down.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<span class="n">v1</span><span class="p">.</span><span class="nf">remover</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f1^v1^f3&quot;_var</span>
v1.remover(2, 2); // "f1^v1^f3"_var
<span class="c1">// or</span>
// or
<span class="nf">remover</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">);</span>
remover(v1, 2, 2);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 1,747: Line 1,787:
</p>
</p>
Searching for empty fields, values etc. (i.e. "") will work. Locating "" in "]yy" will return 1, in "xx]]zz" 2, and in "xx]yy]" 3, however, locating "" in "xx" will return 0 because there is conceptually no empty value in "xx". Locate "" in "" will return 1.
Searching for empty fields, values etc. (i.e. "") will work. Locating "" in "]yy" will return 1, in "xx]]zz" 2, and in "xx]yy]" 3, however, locating "" in "xx" will return 0 because there is conceptually no empty value in "xx". Locate "" in "" will return 1.
 
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;UK^US^UA&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">locate</span><span class="p">(</span><span class="s">&quot;US&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// 2</span>
<pre><code class='language-cpp'>if ("UK^US^UA"_var.locate("US")) ... ok // 2
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">locate</span><span class="p">(</span><span class="s">&quot;US&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;UK^US^UA&quot;</span><span class="kt">_var</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (locate("US", "UK^US^UA"_var)) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.locate(target, out valueno)</td><td><p>locate() with only the target substr provided and setting returned searches unordered values separated by any type of field mark chars.
<tr><td>if</td><td>strvar.locate(target, out valueno)</td><td><p>locate() with only the target substr provided and setting returned searches unordered values separated by any type of field mark chars.
Line 1,758: Line 1,797:
</p>
</p>
<em>Setting:</em> Field, value, subvalue etc. number if found or the max number + 1 if not. Suitable for additiom of new values
<em>Setting:</em> Field, value, subvalue etc. number if found or the max number + 1 if not. Suitable for additiom of new values
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">setting</span><span class="p">;</span>
<pre><code class='language-cpp'>var setting;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;UK]US]UA&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">locate</span><span class="p">(</span><span class="s">&quot;US&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">setting</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// setting -&gt; 2</span>
if ("UK]US]UA"_var.locate("US", setting)) ... ok // setting -> 2
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">locate</span><span class="p">(</span><span class="s">&quot;US&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;UK]US]UA&quot;</span><span class="kt">_var</span><span class="p">,</span><span class="w"> </span><span class="n">setting</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (locate("US", "UK]US]UA"_var, setting)) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.locate(target, out setting, fieldno, valueno = 0)</td><td><p>locate() the target in unordered fields if fieldno is 0, or values if a fieldno is specified, or subvalues if the valueno argument is provided.
<tr><td>if</td><td>strvar.locate(target, out setting, fieldno, valueno = 0)</td><td><p>locate() the target in unordered fields if fieldno is 0, or values if a fieldno is specified, or subvalues if the valueno argument is provided.
</p>
</p>
Line 1,770: Line 1,808:
</p>
</p>
<em>Returns:</em> False if not found and with the max field, value or subvalue number found + 1 in setting. Suitable for replacement of new fields, values or subvalues.
<em>Returns:</em> False if not found and with the max field, value or subvalue number found + 1 in setting. Suitable for replacement of new fields, values or subvalues.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">setting</span><span class="p">;</span>
<pre><code class='language-cpp'>var setting;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;f1^f2v1]f2v2]s1}s2}s3}s4^f3^f4&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">locate</span><span class="p">(</span><span class="s">&quot;s4&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">setting</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// setting -&gt; 4 // returns true</span>
if ("f1^f2v1]f2v2]s1}s2}s3}s4^f3^f4"_var.locate("s4", setting, 2, 3)) ... ok // setting -> 4 // returns true</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.locateby(ordercode, target, out valueno)</td><td><p>locateby() without fieldno or valueno arguments searches ordered values separated by VM chars.
<tr><td>if</td><td>strvar.locateby(ordercode, target, out valueno)</td><td><p>locateby() without fieldno or valueno arguments searches ordered values separated by VM chars.
Line 1,788: Line 1,825:
</p>
</p>
In case the target is not exactly found then the correct value no for inserting the target is returned in setting.
In case the target is not exactly found then the correct value no for inserting the target is returned in setting.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">valueno</span><span class="p">;</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;aaa]bbb]ccc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">locateby</span><span class="p">(</span><span class="s">&quot;AL&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bb&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">valueno</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="c1">// valueno -&gt; 2 // returns false and valueno = where it could be correctly inserted.</span>
<pre><code class='language-cpp'>var valueno; if ("aaa]bbb]ccc"_var.locateby("AL", "bb", valueno)) ... // valueno -> 2 // returns false and valueno = where it could be correctly inserted.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.locateby(ordercode, target, out setting, fieldno, valueno = 0)</td><td>locateby() ordered as above but in fields if fieldno is 0, or values in a specific fieldno, or subvalues in a specific valueno.
<tr><td>if</td><td>strvar.locateby(ordercode, target, out setting, fieldno, valueno = 0)</td><td>locateby() ordered as above but in fields if fieldno is 0, or values in a specific fieldno, or subvalues in a specific valueno.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">setting</span><span class="p">;</span>
<pre><code class='language-cpp'>var setting;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;f1^f2^aaa]bbb]ccc^f4&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">locateby</span><span class="p">(</span><span class="s">&quot;AL&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bb&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">setting</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="c1">// setting -&gt; 2 // return false and where it could be correctly inserted.</span>
if ("f1^f2^aaa]bbb]ccc^f4"_var.locateby("AL", "bb", setting, 3)) ... // setting -> 2 // return false and where it could be correctly inserted.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.locateusing(usingchar, target)</td><td>locate() a target substr in the whole unordered string using a given delimiter char returning true if found.
<tr><td>if</td><td>strvar.locateusing(usingchar, target)</td><td>locate() a target substr in the whole unordered string using a given delimiter char returning true if found.
 
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;AB,EF,CD&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">locateusing</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;EF&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
<pre><code class='language-cpp'>if ("AB,EF,CD"_var.locateusing(",", "EF")) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.locateusing(usingchar, target, out setting, fieldno = 0, valueno = 0, subvalueno = 0)</td><td><p>locate() the target in a specific field, value or subvalue using a specified delimiter and unordered data
<tr><td>if</td><td>strvar.locateusing(usingchar, target, out setting, fieldno = 0, valueno = 0, subvalueno = 0)</td><td><p>locate() the target in a specific field, value or subvalue using a specified delimiter and unordered data
Line 1,810: Line 1,844:
</p>
</p>
This is similar to the main locate command but the delimiter char can be specified e.g. a comma or TM etc.
This is similar to the main locate command but the delimiter char can be specified e.g. a comma or TM etc.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">setting</span><span class="p">;</span>
<pre><code class='language-cpp'>var setting;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;f1^f2^f3c1,f3c2,f3c3^f4&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">locateusing</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;f3c2&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">setting</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// setting -&gt; 2 // returns true</span>
if ("f1^f2^f3c1,f3c2,f3c3^f4"_var.locateusing(",", "f3c2", setting, 3)) ... ok // setting -> 2 // returns true</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.locatebyusing(ordercode, usingchar, target, out setting, fieldno = 0, valueno = 0, subvalueno = 0)</td><td><p>locatebyusing() supports all the above features in a single function.
<tr><td>if</td><td>strvar.locatebyusing(ordercode, usingchar, target, out setting, fieldno = 0, valueno = 0, subvalueno = 0)</td><td><p>locatebyusing() supports all the above features in a single function.
Line 1,823: Line 1,856:
<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>conn.connect(conninfo = "")</td><td><p>For all db operations, the operative var can either be a db connection created with dbconnect() or be any var and a default connection will be established on the fly.
<tr><td>if</td><td>conn.connect(conninfo = "")</td><td><p>For all DB operations, the operative var can either be a DB connection created with dbconnect() or be any var and a default connection will be established on the fly.
</p>
</p>
<p>The db connection string (conninfo) parameters are merged from the following places in descending priority.
<p>The DB connection string (conninfo) parameters are merged from the following places in descending priority.
</p>
</p>
<p>1. Provided in connect()'s conninfo argument. See 4. for the complete list of parameters.
<p>1. Provided in connect()'s conninfo argument. See 4. for the complete list of parameters.
Line 1,835: Line 1,868:
<p>4. The default conninfo is "host=127.0.0.1 port=5432 dbname=exodus user=exodus password=somesillysecret connect_timeout=10"
<p>4. The default conninfo is "host=127.0.0.1 port=5432 dbname=exodus user=exodus password=somesillysecret connect_timeout=10"
</p>
</p>
Setting environment variable EXO_DBTRACE=1 will cause tracing of db interface including SQL commands.
Setting environment variable EXO_DBTRACE=1 will cause tracing of DB interface including SQL commands.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">conn</span><span class="p">.</span><span class="nf">connect</span><span class="p">(</span><span class="s">&quot;dbname=exodus user=exodus password=somesillysecret&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...;</span>
if (not conn.connect("dbname=exodus user=exodus password=somesillysecret")) ...;
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">connect</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
if (not connect()) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">connect</span><span class="p">(</span><span class="s">&quot;exodus&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not connect("exodus")) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.attach(filenames)</td><td><p>"attach" causes the given filenames to be associated with a specific connection for the remainder of the session.
<tr><td>if</td><td>conn.attach(filenames)</td><td><p>"attach" causes the given filenames to be associated with a specific connection for the remainder of the session.
Line 1,858: Line 1,890:
</p>
</p>
Internally, attach merely opens each filename on the given connection causing them to be added to an internal cache.
Internally, attach merely opens each filename on the given connection causing them to be added to an internal cache.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="nf">let</span><span class="w"> </span><span class="n">filenames</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients^dict.xo_clients&quot;</span><span class="kt">_var</span><span class="p">;</span>
let filenames = "xo_clients^dict.xo_clients"_var;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">attach</span><span class="p">(</span><span class="n">filenames</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.attach(filenames)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">attach</span><span class="p">(</span><span class="n">filenames</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (attach(filenames)) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>conn.detach(filenames)</td><td><p>Removes files from the internal cache created by previous open() and attach() calls.
<tr><td></td><td>conn.detach(filenames)</td><td><p>Removes files from the internal cache created by previous open() and attach() calls.
Line 1,873: Line 1,904:
</p>
</p>
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.begintrans()</td><td>Begin a db transaction.
<tr><td>if</td><td>conn.begintrans()</td><td>Begin a DB transaction.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">conn</span><span class="p">.</span><span class="nf">begintrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
if (not conn.begintrans()) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">begintrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
if (not begintrans()) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.statustrans()</td><td>Check if a db transaction is in progress.
<tr><td>if</td><td>conn.statustrans()</td><td>Check if a DB transaction is in progress.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">statustrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.statustrans()) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">statustrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (statustrans()) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.rollbacktrans()</td><td>Rollback a db transaction.
<tr><td>if</td><td>conn.rollbacktrans()</td><td>Rollback a DB transaction.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">rollbacktrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.rollbacktrans()) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">rollbacktrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (rollbacktrans()) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.committrans()</td><td><p>Commit a db transaction.
<tr><td>if</td><td>conn.committrans()</td><td><p>Commit a DB transaction.
</p>
</p>
<em>Returns:</em> True if successfully committed or if there was no transaction in progress, otherwise false.
<em>Returns:</em> True if successfully committed or if there was no transaction in progress, otherwise false.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">committrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.committrans()) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">committrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (committrans()) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.sqlexec(sqlcmd)</td><td><p>Execute an sql command.
<tr><td>if</td><td>conn.sqlexec(sqlcmd)</td><td><p>Execute an sql command.
</p>
</p>
<em>Returns:</em> True if there was no sql error otherwise lasterror() returns a detailed error message.
<em>Returns:</em> True if there was no sql error otherwise lasterror() returns a detailed error message.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">sqlexec</span><span class="p">(</span><span class="s">&quot;select 1&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.sqlexec("select 1")) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">sqlexec</span><span class="p">(</span><span class="s">&quot;select 1&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (sqlexec("select 1")) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.sqlexec(sqlcmd, io response)</td><td><p>Execute an SQL command and capture the response.
<tr><td>if</td><td>conn.sqlexec(sqlcmd, io response)</td><td><p>Execute an SQL command and capture the response.
Line 1,924: Line 1,950:
</p>
</p>
<em>Recommended:</em> Don't use sql directly unless you must to manage or configure a database.
<em>Recommended:</em> Don't use sql directly unless you must to manage or configure a database.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="nf">let</span><span class="w"> </span><span class="n">sqlcmd</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;select &#39;xxx&#39; as col1, &#39;yyy&#39; as col2&quot;</span><span class="p">;</span>
let sqlcmd = "select 'xxx' as col1, 'yyy' as col2";
<span class="kt">var</span><span class="w"> </span><span class="n">response</span><span class="p">;</span>
var response;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">sqlexec</span><span class="p">(</span><span class="n">sqlcmd</span><span class="p">,</span><span class="w"> </span><span class="n">response</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// response -&gt; &quot;col1^col2\x1fxxx^yyy&quot;_var /// \x1f is the Record Mark (RM) char. The backtick char is used here by gendoc to deliminate source code.</span>
if (conn.sqlexec(sqlcmd, response)) ... ok // response -> "col1^col2\x1fxxx^yyy"_var /// \x1f is the Record Mark (RM) char. The backtick char is used here by gendoc to deliminate source code.
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">sqlexec</span><span class="p">(</span><span class="n">sqlcmd</span><span class="p">,</span><span class="w"> </span><span class="n">response</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (sqlexec(sqlcmd, response)) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>conn.disconnect()</td><td>Closes db connection and frees process resources both locally and in the database server.
<tr><td></td><td>conn.disconnect()</td><td>Closes DB connection and frees process resources both locally and in the database server.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="n">conn</span><span class="p">.</span><span class="nf">disconnect</span><span class="p">();</span>
conn.disconnect();
<span class="c1">// or</span>
// or
<span class="nf">disconnect</span><span class="p">();</span>
disconnect();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>conn.disconnectall()</td><td><p>Closes all connections and frees process resources both locally and in the database server(s).
<tr><td></td><td>conn.disconnectall()</td><td><p>Closes all connections and frees process resources both locally and in the database server(s).
</p>
</p>
All connections are closed automatically when a process terminates.
All connections are closed automatically when a process terminates.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="n">conn</span><span class="p">.</span><span class="nf">disconnectall</span><span class="p">();</span>
conn.disconnectall();
<span class="c1">// or</span>
// or
<span class="nf">disconnectall</span><span class="p">();</span>
disconnectall();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::lasterror()</td><td>
<tr><td>var=</td><td>var::lasterror()</td><td>
<em>Returns:</em> The last os or db error message.
<em>Returns:</em> The last OS or DB error message.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">lasterror</span><span class="p">();</span>
<pre><code class='language-cpp'>var v1 = var::lasterror();
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">lasterror</span><span class="p">();</span>
var v2 = lasterror();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>var::loglasterror(source = "")</td><td><p>Log the last os or db error message.
<tr><td></td><td>conn.setlasterror(msg)</td><td>Set the lasterror() message.</td></tr>
<tr><td></td><td>var::loglasterror(source = "")</td><td><p>Log the last OS or DB error message.
</p>
</p>
<p><em>Output:</em> to stdlog
<p><em>Output:</em> to stdlog
</p>
</p>
Prefixes the output with source if provided.
Prefixes the output with source if provided.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="o">::</span><span class="nf">loglasterror</span><span class="p">(</span><span class="s">&quot;main:&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>var::loglasterror("main:");
<span class="c1">// or</span>
// or
<span class="nf">loglasterror</span><span class="p">(</span><span class="s">&quot;main:&quot;</span><span class="p">);</span>
loglasterror("main:");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 1,980: Line 2,002:
</p>
</p>
Optionally copies an existing database from the same connection and which cannot have any current connections.
Optionally copies an existing database from the same connection and which cannot have any current connections.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">dbdelete</span><span class="p">(</span><span class="s">&quot;xo_gendoc_testdb&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{};</span><span class="w"> </span><span class="c1">// Cleanup first</span>
if (not dbdelete("xo_gendoc_testdb")) {}; // Cleanup first
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">dbcreate</span><span class="p">(</span><span class="s">&quot;xo_gendoc_testdb&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.dbcreate("xo_gendoc_testdb")) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">dbcreate</span><span class="p">(</span><span class="s">&quot;xo_gendoc_testdb&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (dbcreate("xo_gendoc_testdb")) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.dbcopy(from_dbname, to_dbname)</td><td><p>Create a named database as a copy of an existing database.
<tr><td>if</td><td>conn.dbcopy(from_dbname, to_dbname)</td><td><p>Create a named database as a copy of an existing database.
Line 1,993: Line 2,014:
</p>
</p>
The source database must exist on the same connection and cannot have any current connections.
The source database must exist on the same connection and cannot have any current connections.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">dbdelete</span><span class="p">(</span><span class="s">&quot;xo_gendoc_testdb2&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{};</span><span class="w"> </span><span class="c1">// Cleanup first</span>
if (not dbdelete("xo_gendoc_testdb2")) {}; // Cleanup first
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">dbcopy</span><span class="p">(</span><span class="s">&quot;xo_gendoc_testdb&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;xo_gendoc_testdb2&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.dbcopy("xo_gendoc_testdb", "xo_gendoc_testdb2")) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">dbcopy</span><span class="p">(</span><span class="s">&quot;xo_gendoc_testdb&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;xo_gendoc_testdb2&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (dbcopy("xo_gendoc_testdb", "xo_gendoc_testdb2")) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>conn.dblist()</td><td>
<tr><td>var=</td><td>conn.dblist()</td><td>
<em>Returns:</em> A list of available databases on a particular connection.
<em>Returns:</em> A list of available databases on a particular connection.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">conn</span><span class="p">.</span><span class="nf">dblist</span><span class="p">();</span>
let v1 = conn.dblist();
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">dblist</span><span class="p">();</span>
let v2 = dblist();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.dbdelete(dbname)</td><td><p>Delete (drop) a named database.
<tr><td>if</td><td>conn.dbdelete(dbname)</td><td><p>Delete (drop) a named database.
</p>
</p>
The target database must exist and cannot have any current connections.
The target database must exist and cannot have any current connections.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">dbdelete</span><span class="p">(</span><span class="s">&quot;xo_gendoc_testdb2&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.dbdelete("xo_gendoc_testdb2")) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">dbdelete</span><span class="p">(</span><span class="s">&quot;xo_gendoc_testdb2&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (dbdelete("xo_gendoc_testdb2")) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.createfile(filename)</td><td><p>Create a named db file.
<tr><td>if</td><td>conn.createfile(filename)</td><td><p>Create a named DB file.
</p>
</p>
filenames ending with "_temp" only last until the connection is closed.
filenames ending with "_temp" only last until the connection is closed.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">filename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_gendoc_temp&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let filename = "xo_gendoc_temp", conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">createfile</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.createfile(filename)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">createfile</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (createfile(filename)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.renamefile(filename, newfilename)</td><td>Rename a db file.
<tr><td>if</td><td>conn.renamefile(filename, newfilename)</td><td>Rename a DB file.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">filename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_gendoc_temp&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">new_filename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_gendoc_temp2&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let conn = "exodus", filename = "xo_gendoc_temp", new_filename = "xo_gendoc_temp2";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">renamefile</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span><span class="w"> </span><span class="n">new_filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.renamefile(filename, new_filename)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">renamefile</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span><span class="w"> </span><span class="n">new_filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (renamefile(filename, new_filename)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>conn.listfiles()</td><td>
<tr><td>var=</td><td>conn.listfiles()</td><td>
<em>Returns:</em> A list of all files in a database
<em>Returns:</em> A list of all files in a database
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">conn</span><span class="p">.</span><span class="nf">listfiles</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
if (not conn.listfiles()) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">listfiles</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
if (not listfiles()) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.clearfile(filename)</td><td>Delete all records in a db file
<tr><td>if</td><td>conn.clearfile(filename)</td><td>Delete all records in a DB file
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">filename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_gendoc_temp2&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let conn = "exodus", filename = "xo_gendoc_temp2";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">conn</span><span class="p">.</span><span class="nf">clearfile</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not conn.clearfile(filename)) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">clearfile</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not clearfile(filename)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.deletefile(filename)</td><td>Delete a db file
<tr><td>if</td><td>conn.deletefile(filename)</td><td>Delete a DB file
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">filename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_gendoc_temp2&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let conn = "exodus", filename = "xo_gendoc_temp2";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">deletefile</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.deletefile(filename)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">deletefile</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (deletefile(filename)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>conn_or_file.reccount(filename = "")</td><td>
<tr><td>var=</td><td>conn_or_file.reccount(filename = "")</td><td>
<p><em>Returns:</em> The approx. number of records in a db file.
<p><em>Returns:</em> The approx. number of records in a DB file.
</p>
</p>
<p>Might return -1 if not known.
<p>Might return -1 if not known.
</p>
</p>
Not very accurate inside transactions.
Not very accurate inside transactions.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">filename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let conn = "exodus", filename = "xo_clients";
<span class="kt">var</span><span class="w"> </span><span class="n">nrecs1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">conn</span><span class="p">.</span><span class="nf">reccount</span><span class="p">(</span><span class="n">filename</span><span class="p">);</span>
var nrecs1 = conn.reccount(filename);
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">nrecs2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">reccount</span><span class="p">(</span><span class="n">filename</span><span class="p">);</span>
var nrecs2 = reccount(filename);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn_or_file.flushindex(filename = "")</td><td><p>Calls db maintenance function for a file or all files.
<tr><td>if</td><td>conn_or_file.flushindex(filename = "")</td><td><p>Calls DB maintenance function for a file or all files.
</p>
</p>
<p>This doesnt actually flush any indexes but does make sure that reccount() function is reasonably accurate.
<p>This doesnt actually flush any indexes but does make sure that reccount() function is reasonably accurate.
Line 2,086: Line 2,098:
<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>file.open(dbfilename, connection = "")</td><td><p>Opens a db file to a var which can be used in subsequent db function calls to access a specific file using a specific connection.
<tr><td>if</td><td>file.open(dbfilename, connection = "")</td><td><p>Opens a DB file to a var which can be used in subsequent DB function calls to access a specific file using a specific connection.
</p>
</p>
<p><em>connection:</em> If not specified and the filename is present in an internal cache of filenames and connections created by previous calls to open() or attach() then open() returns true. If it is not present in the cache then the default connection will be checked.
<p><em>connection:</em> If not specified and the filename is present in an internal cache of filenames and connections created by previous calls to open() or attach() then open() returns true. If it is not present in the cache then the default connection will be checked.
</p>
</p>
<em>Returns:</em> True if the filename was present in the cache OR if the db connection reports that the file is present.
<em>Returns:</em> True if the filename was present in the cache OR if the DB connection reports that the file is present.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">filename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var file, filename = "xo_clients";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">file</span><span class="p">.</span><span class="nf">open</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not file.open(filename)) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">open</span><span class="p">(</span><span class="n">filename</span><span class="w"> </span><span class="ow">to</span><span class="w"> </span><span class="n">file</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not open(filename to file)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>file.close()</td><td><p>Closes db file var
<tr><td></td><td>file.close()</td><td><p>Closes DB file var
</p>
</p>
Does nothing currently since database file vars consume no resources
Does nothing currently since database file vars consume no resources
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var file = "xo_clients";
<span class="n">file</span><span class="p">.</span><span class="nf">close</span><span class="p">();</span>
file.close();
<span class="c1">// or</span>
// or
<span class="nf">close</span><span class="p">(</span><span class="n">file</span><span class="p">);</span>
close(file);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>file.createindex(fieldname, dictfile = "")</td><td><p>Creates a secondary index for a given db file and field name.
<tr><td>if</td><td>file.createindex(fieldname, dictfile = "")</td><td><p>Creates a secondary index for a given DB file and field name.
</p>
</p>
<p>The fieldname must exist in a dictionary file. The default dictionary is "dict." ^ filename.
<p>The fieldname must exist in a dictionary file. The default dictionary is "dict." ^ filename.
Line 2,123: Line 2,133:
</p>
</p>
* The dictionary field defines a calculated field that uses an exodus function. Using a psql function is OK.
* The dictionary field defines a calculated field that uses an exodus function. Using a psql function is OK.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">filename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">fieldname</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;DATE_CREATED&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var filename = "xo_clients", fieldname = "DATE_CREATED";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">deleteindex</span><span class="p">(</span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;DATE_CREATED&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{};</span><span class="w"> </span><span class="c1">// Cleanup first</span>
if (not deleteindex("xo_clients", "DATE_CREATED")) {}; // Cleanup first
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">filename</span><span class="p">.</span><span class="nf">createindex</span><span class="p">(</span><span class="n">fieldname</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (filename.createindex(fieldname)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">createindex</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span><span class="w"> </span><span class="n">fieldname</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (createindex(filename, fieldname)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>file|conn.listindex(file_or_filename = "", fieldname = "")</td><td><p>Lists secondary indexes in a database or for a db file
<tr><td>var=</td><td>file|conn.listindex(file_or_filename = "", fieldname = "")</td><td><p>Lists secondary indexes in a database or for a DB file
</p>
</p>
<em>Returns:</em> False if the db file or fieldname are given and do not exist
<em>Returns:</em> False if the DB file or fieldname are given and do not exist
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">listindex</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// includes &quot;xo_clients__date_created&quot;</span>
if (conn.listindex()) ... ok // includes "xo_clients__date_created"
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">listindex</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (listindex()) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>file.deleteindex(fieldname)</td><td><p>Deletes a secondary index for a db file and field name.
<tr><td>if</td><td>file.deleteindex(fieldname)</td><td><p>Deletes a secondary index for a DB file and field name.
</p>
</p>
<p><em>Returns:</em> False if the index cannot be deleted for any reason
<p><em>Returns:</em> False if the index cannot be deleted for any reason
Line 2,148: Line 2,156:
</p>
</p>
* Index does not already exists
* Index does not already exists
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">fieldname</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;DATE_CREATED&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var file = "xo_clients", fieldname = "DATE_CREATED";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">.</span><span class="nf">deleteindex</span><span class="p">(</span><span class="n">fieldname</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (file.deleteindex(fieldname)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">deleteindex</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">fieldname</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (deleteindex(file, fieldname)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>file.lock(key)</td><td><p>Places a metaphorical db lock on a particular record given a db file and key.
<tr><td>var=</td><td>file.lock(key)</td><td><p>Places a metaphorical DB lock on a particular record given a DB file and key.
</p>
</p>
<p>This is a advisory lock, not a physical lock, since it makes no restriction on the access or modification of data by other connections.
<p>This is a advisory lock, not a physical lock, since it makes no restriction on the access or modification of data by other connections.
</p>
</p>
<p>Neither the db file nor the record key need to actually exist since a lock is just a hash of the db file name and key combined.
<p>Neither the DB file nor the record key need to actually exist since a lock is just a hash of the DB file name and key combined.
</p>
</p>
<p>If another connection attempts to place an identical lock on the same database it will be denied.
<p>If another connection attempts to place an identical lock on the same database it will be denied.
Line 2,169: Line 2,176:
<p>Locks can be used to avoid processing a transaction simultaneously with another connection only to have one of them fail due to mutually updating the same records.
<p>Locks can be used to avoid processing a transaction simultaneously with another connection only to have one of them fail due to mutually updating the same records.
</p>
</p>
<p><em>Returns:</em>:
<p><em>Returns:</em>
</p>
</p>
<p>* 0: Failure: Another connection has already placed the same lock.
<p>* 0: Failure: Another connection has already placed the same lock.
Line 2,178: Line 2,185:
</p>
</p>
* 2: Success: The lock has already been placed and the connection is in a transaction.
* 2: Success: The lock has already been placed and the connection is in a transaction.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;1000&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var file = "xo_clients", key = "1000";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">.</span><span class="nf">lock</span><span class="p">(</span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (file.lock(key)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">lock</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (lock(file, key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>file.unlock(key)</td><td><p>Removes a db lock placed by the lock function.
<tr><td>if</td><td>file.unlock(key)</td><td><p>Removes a DB lock placed by the lock function.
</p>
</p>
<p>Only locks placed on the specified connection can be removed.
<p>Only locks placed on the specified connection can be removed.
Line 2,192: Line 2,198:
</p>
</p>
<em>Returns:</em> False if the lock is not present in a connection.
<em>Returns:</em> False if the lock is not present in a connection.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;1000&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var file = "xo_clients", key = "1000";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">.</span><span class="nf">unlock</span><span class="p">(</span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (file.unlock(key)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">unlock</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (unlock(file, key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>file.unlockall()</td><td><p>Removes all db locks placed by the lock function in the specified connection.
<tr><td>if</td><td>file.unlockall()</td><td><p>Removes all DB locks placed by the lock function in the specified connection.
</p>
</p>
Locks cannot be removed while in a transaction.
Locks cannot be removed while in a transaction.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "exodus";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">conn</span><span class="p">.</span><span class="nf">unlockall</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
if (not conn.unlockall()) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">unlockall</span><span class="p">(</span><span class="n">conn</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not unlockall(conn)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>record.write(file, key)</td><td><p>Writes a record into a db file given a unique primary key.
<tr><td></td><td>record.write(file, key)</td><td><p>Writes a record into a DB file given a unique primary key.
</p>
</p>
<p>Either inserts a new record or updates an existing record.
<p>Either inserts a new record or updates an existing record.
Line 2,215: Line 2,219:
<p><em>Returns:</em> Nothing since writes always succeed.
<p><em>Returns:</em> Nothing since writes always succeed.
</p>
</p>
<p><em>Throws:</em> VarDBException if the file does not exist. Like most db functions.
<p><em>Throws:</em> VarDBException if the file does not exist. Like most DB functions.
</p>
</p>
Any memory cached record is deleted.
Any memory cached record is deleted.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">record</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Client GD^G^20855^30000^1001.00^20855.76539&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let record = "Client GD^G^20855^30000^1001.00^20855.76539"_var;
<span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">;</span>
let file = "xo_clients", key = "GD001";
<span class="c1">//if (not &quot;xo_clients&quot;_var.deleterecord(&quot;GD001&quot;)) {}; // Cleanup first</span>
//if (not "xo_clients"_var.deleterecord("GD001")) {}; // Cleanup first
<span class="n">record</span><span class="p">.</span><span class="nf">write</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">);</span>
record.write(file, key);
<span class="c1">// or</span>
// or
<span class="nf">write</span><span class="p">(</span><span class="n">record</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">);</span>
write(record on file, key);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>record.read(file, key)</td><td><p>Reads a record from a DB file for a given key.
<tr><td>if</td><td>record.read(file, key)</td><td><p>Reads a record from a db file for a given key.
</p>
</p>
<p><em>file:</em> A db filename or a var opened to a db file.
<p><em>file:</em> A DB filename or a var opened to a DB file.
</p>
</p>
<p><em>key:</em> The key of the record to be read.
<p><em>key:</em> The key of the record to be read.
Line 2,237: Line 2,240:
<p><em>var:</em> Contains the record if it exists or is unassigned if not.
<p><em>var:</em> Contains the record if it exists or is unassigned if not.
</p>
</p>
A special case of the key being "%RECORDS%" results in a fictitious "record" being returned as an FM separated list of all the keys in the db file up to a maximum size of 4Mib, sorted in natural order.
A special case of the key being "%RECORDS%" results in a fictitious "record" being returned as an FM separated list of all the keys in the DB file up to a maximum size of 4Mib, sorted in natural order.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">record</span><span class="p">;</span>
<pre><code class='language-cpp'>var record;
<span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">;</span>
let file = "xo_clients", key = "GD001";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">record</span><span class="p">.</span><span class="nf">read</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="c1">// record -&gt; &quot;Client GD^G^20855^30000^1001.00^20855.76539&quot;_var</span>
if (not record.read(file, key)) ... // record -> "Client GD^G^20855^30000^1001.00^20855.76539"_var
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">read</span><span class="p">(</span><span class="n">record</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not read(record from file, key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>file.deleterecord(key)</td><td><p>Deletes a record from a db file given a key.
<tr><td>if</td><td>file.deleterecord(key)</td><td><p>Deletes a record from a DB file given a key.
</p>
</p>
<p><em>Returns:</em> False if the key doesnt exist
<p><em>Returns:</em> False if the key doesnt exist
Line 2,253: Line 2,255:
</p>
</p>
deleterecord(in file), a one argument free function, is available that deletes multiple records using the currently active select list.
deleterecord(in file), a one argument free function, is available that deletes multiple records using the currently active select list.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let file = "xo_clients", key = "GD001";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">.</span><span class="nf">deleterecord</span><span class="p">(</span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (file.deleterecord(key)) ... ok
<span class="c1">// or</span>
// or
<span class="c1">//if (deleterecord(file, key)) ...</span>
//if (deleterecord(file, key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>record.insertrecord(file, key)</td><td><p>Inserts a new record in a db file.
<tr><td>if</td><td>record.insertrecord(file, key)</td><td><p>Inserts a new record in a DB file.
</p>
</p>
<p><em>Returns:</em> False if the key already exists
<p><em>Returns:</em> False if the key already exists
</p>
</p>
Any memory cached record is deleted.
Any memory cached record is deleted.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">record</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Client GD^G^20855^30000^1001.00^20855.76539&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let record = "Client GD^G^20855^30000^1001.00^20855.76539"_var;
<span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">;</span>
let file = "xo_clients", key = "GD001";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">record</span><span class="p">.</span><span class="nf">insertrecord</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (record.insertrecord(file, key)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">insertrecord</span><span class="p">(</span><span class="n">record</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (insertrecord(record on file, key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>record.updaterecord(file, key)</td><td><p>Updates an existing record in a db file.
<tr><td>if</td><td>record.updaterecord(file, key)</td><td><p>Updates an existing record in a DB file.
</p>
</p>
<p><em>Returns:</em> False if no record with the given key exists.
<p><em>Returns:</em> False if no record with the given key exists.
</p>
</p>
Any memory cached record is deleted.
Any memory cached record is deleted.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">record</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Client GD^G^20855^30000^1001.00^20855.76539&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let record = "Client GD^G^20855^30000^1001.00^20855.76539"_var;
<span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">;</span>
let file = "xo_clients", key = "GD001";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">record</span><span class="p">.</span><span class="nf">updaterecord</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not record.updaterecord(file, key)) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">updaterecord</span><span class="p">(</span><span class="n">record</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not updaterecord(record on file, key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>record.updatekey(key, newkey)</td><td><p>Updates the key of an existing record in a db file.
<tr><td>if</td><td>record.updatekey(key, newkey)</td><td><p>Updates the key of an existing record in a DB file.
</p>
</p>
<p><em>Returns:</em> True if successful or false if no record with the given key exists, or a record with newkey already exists
<p><em>Returns:</em> True if successful or false if no record with the given key exists, or a record with newkey already exists
</p>
</p>
Any memory cached records of either key are deleted.
Any memory cached records of either key are deleted.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">newkey</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD002&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let file = "xo_clients", key = "GD001", newkey = "GD002";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">file</span><span class="p">.</span><span class="nf">updatekey</span><span class="p">(</span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="n">newkey</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not file.updatekey(key, newkey)) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">updatekey</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">newkey</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="c1">// Reverse the above change.</span>
if (not updatekey(file, newkey, key)) ... // Reverse the above change.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.readf(file, key, fieldno)</td><td>"Read field" Same as read() but only returns a specific field number from the record.
<tr><td>if</td><td>strvar.readf(file, key, fieldno)</td><td>"Read field" Same as read() but only returns a specific field number from the record.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="nf">field</span><span class="p">,</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">fieldno</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">;</span>
<pre><code class='language-cpp'>var field, file = "xo_clients", key = "GD001", fieldno = 2;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">field</span><span class="p">.</span><span class="nf">readf</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="n">fieldno</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="c1">// field -&gt; &quot;G&quot;</span>
if (not field.readf(file, key, fieldno)) ... // field -> "G"
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">readf</span><span class="p">(</span><span class="nf">field</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="n">fieldno</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not readf(field from file, key, fieldno)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>strvar.writef(file, key, fieldno)</td><td>"write field" Same as write() but only writes to a specific field number in the record
<tr><td></td><td>strvar.writef(file, key, fieldno)</td><td>"write field" Same as write() but only writes to a specific field number in the record
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="nf">field</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f3&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;1000&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">fieldno</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">;</span>
<pre><code class='language-cpp'>var field = "f3", file = "xo_clients", key = "1000", fieldno = 3;
<span class="nf">field</span><span class="p">.</span><span class="nf">writef</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="n">fieldno</span><span class="p">);</span>
field.writef(file, key, fieldno);
<span class="c1">// or</span>
// or
<span class="nf">writef</span><span class="p">(</span><span class="nf">field</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="n">fieldno</span><span class="p">);</span>
writef(field on file, key, fieldno);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>record.writec(file, key)</td><td><p>"Write cache" Writes a record and key into a memory cached "db file".
<tr><td></td><td>record.writec(file, key)</td><td><p>"Write cache" Writes a record and key into a memory cached "DB file".
</p>
</p>
<p>The actual database file is NOT updated.
<p>The actual database file is NOT updated.
Line 2,322: Line 2,318:
<p>It always succeeds so no result code is returned.
<p>It always succeeds so no result code is returned.
</p>
</p>
Neither the db file nor the record key need to actually exist in the actual db.
Neither the DB file nor the record key need to actually exist in the actual DB.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">record</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Client XD^X^20855^30000^1001.00^20855.76539&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let record = "Client XD^X^20855^30000^1001.00^20855.76539"_var;
<span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;XD001&quot;</span><span class="p">;</span>
let file = "xo_clients", key = "XD001";
<span class="n">record</span><span class="p">.</span><span class="nf">writec</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">);</span>
record.writec(file, key);
<span class="c1">// or</span>
// or
<span class="nf">writec</span><span class="p">(</span><span class="n">record</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">);</span>
writec(record on file, key);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>record.readc(file, key)</td><td><p>"Read cache" Same as "read() but first reads from a memory cache.
<tr><td>if</td><td>record.readc(file, key)</td><td><p>"Read cache" Same as "read() but first reads from a memory cache.
Line 2,335: Line 2,330:
<p>1. Tries to read from a memory cache. Returns true if successful.
<p>1. Tries to read from a memory cache. Returns true if successful.
</p>
</p>
<p>2a. Tries to read from the actual db file and returns false if unsuccessful.
<p>2a. Tries to read from the actual DB file and returns false if unsuccessful.
</p>
</p>
<p>2b. Writes the record and key to the memory cache and returns true.
<p>2b. Writes the record and key to the memory cache and returns true.
</p>
</p>
Cached db file data lives in exodus process memory and is lost when the process terminates or clearcache() is called.
Cached DB file data lives in exodus process memory and is lost when the process terminates or clearcache() is called.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">record</span><span class="p">;</span>
<pre><code class='language-cpp'>var record;
<span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;XD001&quot;</span><span class="p">;</span>
let file = "xo_clients", key = "XD001";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">record</span><span class="p">.</span><span class="nf">readc</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (record.readc(file, key)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readc</span><span class="p">(</span><span class="n">record</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (readc(record from file, key)) ... ok
 
// Verify not in actual database file by using read() not readc()
if (read(record from file, key)) abort("Error: " ^ key ^ " should not be in the actual database file"); // error</code></pre>


<span class="c1">// Verify not in actual database file by using read() not readc()</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">read</span><span class="p">(</span><span class="n">record</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="nf">abort</span><span class="p">(</span><span class="s">&quot;Error: &quot;</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot; should not be in the actual database file&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// error</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>if</td><td>dbfile.deletec(key)</td><td><p>Deletes a record and key from a memory cached "file".
<tr><td>if</td><td>dbfile.deletec(key)</td><td><p>Deletes a record and key from a memory cached "file".
Line 2,356: Line 2,350:
</p>
</p>
<em>Returns:</em> False if the key doesnt exist
<em>Returns:</em> False if the key doesnt exist
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;XD001&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var file = "xo_clients", key = "XD001";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">.</span><span class="nf">deletec</span><span class="p">(</span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (file.deletec(key)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">deletec</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (deletec(file, key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>conn.clearcache()</td><td><p>Clears the memory cache of all records for the given connection
<tr><td></td><td>conn.clearcache()</td><td><p>Clears the memory cache of all records for the given connection
</p>
</p>
All future cache readc() function calls will be forced to obtain records from the actual database and refresh the cache.
All future cache readc() function calls will be forced to obtain records from the actual database and refresh the cache.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;exodus&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let conn = "exodus";
<span class="n">conn</span><span class="p">.</span><span class="nf">clearcache</span><span class="p">();</span>
conn.clearcache();
<span class="c1">// or</span>
// or
<span class="nf">clearcache</span><span class="p">(</span><span class="n">conn</span><span class="p">);</span>
clearcache(conn);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.xlate(filename, fieldno, mode)</td><td><p>The xlate ("translate") function is similar to readf() but, when called as an exodus program member function, it can be used efficiently with exodus file dictionaries using column names and functions and multivalued data.
<tr><td>var=</td><td>strvar.xlate(filename, fieldno, mode)</td><td><p>The xlate ("translate") function is similar to readf() but, when called as an exodus program member function, it can be used efficiently with exodus file dictionaries using column names and functions and multivalued data.
Line 2,379: Line 2,371:
<p>strvar: Used as the primary key to lookup a field in a given file and field no or field name.
<p>strvar: Used as the primary key to lookup a field in a given file and field no or field name.
</p>
</p>
<p><em>filename:</em> The db file in which to look up data.
<p><em>filename:</em> The DB file in which to look up data.
</p>
</p>
<p>If var key is multivalued then a multivalued field is returned.
<p>If var key is multivalued then a multivalued field is returned.
Line 2,396: Line 2,388:
</p>
</p>
* "C" returns the key unconverted.
* "C" returns the key unconverted.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;SB001&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let key = "SB001";
<span class="nf">let</span><span class="w"> </span><span class="n">client_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">key</span><span class="p">.</span><span class="nf">xlate</span><span class="p">(</span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;Client AAA&quot;</span>
let client_name = key.xlate("xo_clients", 1, "X"); // "Client AAA"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">name_and_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">xlate</span><span class="p">(</span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;NAME_AND_TYPE&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;Client AAA (A)&quot;</span>
let name_and_type = xlate("xo_clients", key, "NAME_AND_TYPE", "X"); // "Client AAA (A)"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 2,431: Line 2,422:
</p>
</p>
Active select lists created using var.select()'s member function syntax cannot be consumed by the free function form of readnext() and vice versa.
Active select lists created using var.select()'s member function syntax cannot be consumed by the free function form of readnext() and vice versa.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">clients</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var clients = "xo_clients";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">clients</span><span class="p">.</span><span class="nf">select</span><span class="p">(</span><span class="s">&quot;with type &#39;B&#39; and with balance ge 100 by type by name&quot;</span><span class="p">))</span>
if (clients.select("with type 'B' and with balance ge 100 by type by name"))
<span class="w">    </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="n">clients</span><span class="p">.</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">))</span>
    while (clients.readnext(ID))
<span class="w">        </span><span class="nf">println</span><span class="p">(</span><span class="s">&quot;Client code is {}&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">ID</span><span class="p">);</span>
        println("Client code is {}", ID);
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">select</span><span class="p">(</span><span class="s">&quot;xo_clients with type &#39;B&#39; and with balance ge 100 by type by name&quot;</span><span class="p">))</span>
if (select("xo_clients with type 'B' and with balance ge 100 by type by name"))
<span class="w">    </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">))</span>
    while (readnext(ID))
<span class="w">        </span><span class="nf">println</span><span class="p">(</span><span class="s">&quot;Client code is {}&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">ID</span><span class="p">);</span>
        println("Client code is {}", ID);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>dbfile.selectkeys(keys)</td><td><p>Create an active select list from a string of keys.
<tr><td>if</td><td>dbfile.selectkeys(keys)</td><td><p>Create an active select list from a string of keys.
Line 2,449: Line 2,439:
</p>
</p>
<em>Returns:</em> True if any keys are provided or false if not.
<em>Returns:</em> True if any keys are provided or false if not.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbfile</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var dbfile = "";
<span class="nf">let</span><span class="w"> </span><span class="n">keys</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;A01^B02^C03&quot;</span><span class="kt">_var</span><span class="p">;</span>
let keys = "A01^B02^C03"_var;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbfile</span><span class="p">.</span><span class="nf">selectkeys</span><span class="p">(</span><span class="n">keys</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (dbfile.selectkeys(keys)) ... ok
<span class="n">assert</span><span class="p">(</span><span class="n">dbfile</span><span class="p">.</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">)</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">ID</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;A01&quot;</span><span class="p">);</span>
assert(dbfile.readnext(ID) and ID == "A01");
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">selectkeys</span><span class="p">(</span><span class="n">keys</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (selectkeys(keys)) ... ok
<span class="n">assert</span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">)</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">ID</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;A01&quot;</span><span class="p">);</span>
assert(readnext(ID) and ID == "A01");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>dbfile.hasnext()</td><td><p>Checks if a select list is active.
<tr><td>if</td><td>dbfile.hasnext()</td><td><p>Checks if a select list is active.
Line 2,466: Line 2,455:
</p>
</p>
If it returns true then a call to readnext() will return a database record key, otherwise not.
If it returns true then a call to readnext() will return a database record key, otherwise not.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">clients</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">;</span>
<pre><code class='language-cpp'>var clients = "xo_clients", key;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">clients</span><span class="p">.</span><span class="nf">select</span><span class="p">())</span><span class="w"> </span><span class="p">{</span>
if (clients.select()) {
<span class="w">    </span><span class="n">assert</span><span class="p">(</span><span class="n">clients</span><span class="p">.</span><span class="nf">hasnext</span><span class="p">());</span>
    assert(clients.hasnext());
<span class="p">}</span>
}
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">select</span><span class="p">(</span><span class="s">&quot;xo_clients&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
if (select("xo_clients")) {
<span class="w">    </span><span class="n">assert</span><span class="p">(</span><span class="nf">hasnext</span><span class="p">());</span>
    assert(hasnext());
<span class="p">}</span>
}</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>dbfile.readnext(out key)</td><td><p>Acquires and consumes one key from an active select list of database record keys.
<tr><td>if</td><td>dbfile.readnext(out key)</td><td><p>Acquires and consumes one key from an active select list of database record keys.
Line 2,504: Line 2,492:
</p>
</p>
<em>valueno:</em> The multivalue number if the select list was ordered on multivalued database record fields or 1 if not.
<em>valueno:</em> The multivalue number if the select list was ordered on multivalued database record fields or 1 if not.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">clients</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var clients = "xo_clients";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">clients</span><span class="p">.</span><span class="nf">select</span><span class="p">(</span><span class="s">&quot;with type &#39;B&#39; and with balance ge 100 by type by name (R)&quot;</span><span class="p">))</span>
if (clients.select("with type 'B' and with balance ge 100 by type by name (R)"))
<span class="w">    </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="n">clients</span><span class="p">.</span><span class="nf">readnext</span><span class="p">(</span><span class="n">RECORD</span><span class="p">,</span><span class="w"> </span><span class="n">ID</span><span class="p">,</span><span class="w"> </span><span class="n">MV</span><span class="p">))</span>
    while (clients.readnext(RECORD, ID, MV))
<span class="w">        </span><span class="nf">println</span><span class="p">(</span><span class="s">&quot;Code is {}, Name is {}&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">ID</span><span class="p">,</span><span class="w"> </span><span class="n">RECORD</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">1</span><span class="p">));</span>
        println("Code is {}, Name is {}", ID, RECORD.f(1));
<span class="c1">// or</span>
// or
<span class="n">DICT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;dict.xo_clients&quot;</span><span class="p">;</span>
DICT = "dict.xo_clients";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">select</span><span class="p">(</span><span class="s">&quot;xo_clients with type &#39;B&#39; and with balance ge 100 by type by name (R)&quot;</span><span class="p">))</span>
if (select("xo_clients with type 'B' and with balance ge 100 by type by name (R)"))
<span class="w">    </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">RECORD</span><span class="p">,</span><span class="w"> </span><span class="n">ID</span><span class="p">,</span><span class="w"> </span><span class="n">MV</span><span class="p">))</span>
    while (readnext(RECORD, ID, MV))
<span class="w">        </span><span class="nf">println</span><span class="p">(</span><span class="s">&quot;Code is {}, Name is {}&quot;</span><span class="p">,</span><span class="w"> </span><span class="nf">calculate</span><span class="p">(</span><span class="s">&quot;CODE&quot;</span><span class="p">),</span><span class="w"> </span><span class="nf">calculate</span><span class="p">(</span><span class="s">&quot;NAME&quot;</span><span class="p">));</span>
        println("Code is {}, Name is {}", calculate("CODE"), calculate("NAME"));</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>dbfile.clearselect()</td><td><p>Deactivates an active select list.
<tr><td></td><td>dbfile.clearselect()</td><td><p>Deactivates an active select list.
Line 2,523: Line 2,510:
</p>
</p>
Has no effect if no select list is active for dbfile.
Has no effect if no select list is active for dbfile.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">clients</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var clients = "xo_clients";
<span class="n">clients</span><span class="p">.</span><span class="nf">clearselect</span><span class="p">();</span>
clients.clearselect();
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">clients</span><span class="p">.</span><span class="nf">hasnext</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (not clients.hasnext()) ... ok
<span class="c1">// or</span>
// or
<span class="nf">clearselect</span><span class="p">();</span>
clearselect();
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">hasnext</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (not hasnext()) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>dbfile.savelist(listname)</td><td><p>Stores an active select list for later retrieval.
<tr><td>if</td><td>dbfile.savelist(listname)</td><td><p>Stores an active select list for later retrieval.
</p>
</p>
Line 2,553: Line 2,539:
</p>
</p>
Select lists saved in the lists database file may be created, deleted and listed like database records in any other database file.
Select lists saved in the lists database file may be created, deleted and listed like database records in any other database file.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">clients</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var clients = "xo_clients";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">clients</span><span class="p">.</span><span class="nf">select</span><span class="p">(</span><span class="s">&quot;with type &#39;B&#39; by name&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
if (clients.select("with type 'B' by name")) {
<span class="p">}</span>
}
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">select</span><span class="p">(</span><span class="s">&quot;xo_clients with type &#3#39;B&#39; by name&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
if (select("xo_clients with type 'B' by name")) {
<span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">savelist</span><span class="p">(</span><span class="s">&quot;mylist&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
    if (savelist("mylist")) ... ok
<span class="p">}</span>
}</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>dbfile.getlist(listname)</td><td><p>Retrieve and reactivate a saved select list.
<tr><td>if</td><td>dbfile.getlist(listname)</td><td><p>Retrieve and reactivate a saved select list.
Line 2,574: Line 2,559:
</p>
</p>
Retrieving a list does not delete it and a list can be retrieved more than once until specifically deleted.
Retrieving a list does not delete it and a list can be retrieved more than once until specifically deleted.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var file = "";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">.</span><span class="nf">getlist</span><span class="p">(</span><span class="s">&quot;mylist&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
if (file.getlist("mylist")) {
<span class="w">    </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="n">file</span><span class="p">.</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">))</span>
    while (file.readnext(ID))
<span class="w">        </span><span class="nf">println</span><span class="p">(</span><span class="s">&quot;Key is {}&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">ID</span><span class="p">);</span>
        println("Key is {}", ID);
<span class="p">}</span>
}
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">getlist</span><span class="p">(</span><span class="s">&quot;mylist&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
if (getlist("mylist")) {
<span class="w">    </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">))</span>
    while (readnext(ID))
<span class="w">        </span><span class="nf">println</span><span class="p">(</span><span class="s">&quot;Key is {}&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">ID</span><span class="p">);</span>
        println("Key is {}", ID);
<span class="p">}</span>
}</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>dbfile.deletelist(listname)</td><td><p>Delete a saved select list.
<tr><td>if</td><td>dbfile.deletelist(listname)</td><td><p>Delete a saved select list.
Line 2,594: Line 2,578:
</p>
</p>
<em>Returns:</em> True if successful or false if the list name doesnt exist.
<em>Returns:</em> True if successful or false if the list name doesnt exist.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">conn</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>var conn = "";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conn</span><span class="p">.</span><span class="nf">deletelist</span><span class="p">(</span><span class="s">&quot;mylist&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (conn.deletelist("mylist")) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">deletelist</span><span class="p">(</span><span class="s">&quot;mylist&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (deletelist("mylist")) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 2,611: Line 2,594:
</p>
</p>
<em>Returns:</em> A number. e.g. 20821 represents 2025-01-01 00:00:00 UTC for 24 hours.
<em>Returns:</em> A number. e.g. 20821 represents 2025-01-01 00:00:00 UTC for 24 hours.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">today1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">date</span><span class="p">();</span>
<pre><code class='language-cpp'>let today1 = var::date();
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">today2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">date</span><span class="p">();</span>
let today2 = date();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::time()</td><td><p>Number of whole seconds since last 00:00:00 (UTC).
<tr><td>var=</td><td>var::time()</td><td><p>Number of whole seconds since last 00:00:00 (UTC).
</p>
</p>
<em>Returns:</em> A number in the range 0 - 86399 since there are 24*60*60 seconds in a day. e.g. 43200 if time is 12:00:00
<em>Returns:</em> A number in the range 0 - 86399 since there are 24*60*60 seconds in a day. e.g. 43200 if time is 12:00:00
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">now1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">time</span><span class="p">();</span>
<pre><code class='language-cpp'>let now1 = var::time();
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">now2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">time</span><span class="p">();</span>
let now2 = time();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::ostime()</td><td><p>Number of fractional seconds since last 00:00:00 (UTC).
<tr><td>var=</td><td>var::ostime()</td><td><p>Number of fractional seconds since last 00:00:00 (UTC).
Line 2,631: Line 2,612:
</p>
</p>
e.g. 23343.704387955 approx. 06:29:03 UTC
e.g. 23343.704387955 approx. 06:29:03 UTC
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">now1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">ostime</span><span class="p">();</span>
<pre><code class='language-cpp'>let now1 = var::ostime();
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">now2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostime</span><span class="p">();</span>
let now2 = ostime();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::ostimestamp()</td><td><p>Number of fractional days since pick epoch 1967-12-31 00:00:00 UTC. Negative for dates before.
<tr><td>var=</td><td>var::ostimestamp()</td><td><p>Number of fractional days since pick epoch 1967-12-31 00:00:00 UTC. Negative for dates before.
Line 2,642: Line 2,622:
</p>
</p>
e.g. Was 20821.99998842593 around 2025-01-01 23:59:59 UTC
e.g. Was 20821.99998842593 around 2025-01-01 23:59:59 UTC
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">now1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">ostimestamp</span><span class="p">();</span>
<pre><code class='language-cpp'>let now1 = var::ostimestamp();
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">now2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostimestamp</span><span class="p">();</span>
let now2 = ostimestamp();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>vardate.ostimestamp(ostime)</td><td><p>Get a timestamp for a given date and time
<tr><td>var=</td><td>vardate.ostimestamp(ostime)</td><td><p>Get a timestamp for a given date and time
Line 2,653: Line 2,632:
</p>
</p>
<em>ostime:</em> Internal time from time(), ostime(), iconv("MT") etc.
<em>ostime:</em> Internal time from time(), ostime(), iconv("MT") etc.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">idate</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;2025-01-01&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;D&quot;</span><span class="p">),</span><span class="w"> </span><span class="n">itime</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;23:59:59&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>let idate = iconv("2025-01-01", "D"), itime = iconv("23:59:59", "MT");
<span class="nf">let</span><span class="w"> </span><span class="n">ts1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">idate</span><span class="p">.</span><span class="nf">ostimestamp</span><span class="p">(</span><span class="n">itime</span><span class="p">);</span><span class="w"> </span><span class="c1">// 20821.99998842593</span>
let ts1 = idate.ostimestamp(itime); // 20821.99998842593
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">ts2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostimestamp</span><span class="p">(</span><span class="n">idate</span><span class="p">,</span><span class="w"> </span><span class="n">itime</span><span class="p">);</span>
let ts2 = ostimestamp(idate, itime);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>var::ossleep(milliseconds)</td><td><p>Sleep/pause/wait
<tr><td></td><td>var::ossleep(milliseconds)</td><td><p>Sleep/pause/wait
Line 2,665: Line 2,643:
</p>
</p>
Releases the processor if not needed for a period of time or a delay is required.
Releases the processor if not needed for a period of time or a delay is required.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="o">::</span><span class="nf">ossleep</span><span class="p">(</span><span class="mi">100</span><span class="p">);</span><span class="w"> </span><span class="c1">// sleep for 100ms</span>
<pre><code class='language-cpp'>var::ossleep(100); // sleep for 100ms
<span class="c1">// or</span>
// or
<span class="nf">ossleep</span><span class="p">(</span><span class="mi">100</span><span class="p">);</span>
ossleep(100);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>file_dir_list.oswait(milliseconds)</td><td><p>Sleep/pause/wait up for a file system event
<tr><td>var=</td><td>file_dir_list.oswait(milliseconds)</td><td><p>Sleep/pause/wait up for a file system event
</p>
</p>
<p><em>file_dir_list:</em> An FM delimited list of os files and/or dirs to monitor.
<p><em>file_dir_list:</em> An FM delimited list of OS files and/or dirs to monitor.
</p>
</p>
<p><em>milliseconds:</em> How long to wait. Any terminal input (e.g. a key press) will also terminate the wait.
<p><em>milliseconds:</em> How long to wait. Any terminal input (e.g. a key press) will also terminate the wait.
Line 2,680: Line 2,657:
</p>
</p>
<p>Multiple events may be captured and are returned in multivalues.
<p>Multiple events may be captured and are returned in multivalues.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;.^/etc/hosts&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oswait</span><span class="p">(</span><span class="mi">100</span><span class="p">);</span><span class="w"> </span><span class="c1">/// e.g. &quot;IN_CLOSE_WRITE^/etc^hosts^f&quot;_var</span>
<pre><code class='language-cpp'>let v1 = ".^/etc/hosts"_var.oswait(100); /// e.g. "IN_CLOSE_WRITE^/etc^hosts^f"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oswait</span><span class="p">(</span><span class="s">&quot;.^/etc/hosts&quot;</span><span class="kt">_var</span><span class="p">,</span><span class="w"> </span><span class="mi">100</span><span class="p">);</span>
let v2 = oswait(".^/etc/hosts"_var, 100);</code></pre>
</pre></div>
 
Returned dynamic array fields:
Returned dynamic array fields:
</p>
</p>
Line 2,739: Line 2,715:
</p>
</p>
Opens for writing if possible, otherwise read-only.
Opens for writing if possible, otherwise read-only.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">oswrite</span><span class="p">(</span><span class="s">&quot;&quot;</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">/// Create an empty OS file</span>
if (oswrite("" on osfilename)) ... ok /// Create an empty os file
<span class="kt">var</span><span class="w"> </span><span class="nf">ostempfile</span><span class="p">;</span>
var ostempfile;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">ostempfile</span><span class="p">.</span><span class="nf">osopen</span><span class="p">(</span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (ostempfile.osopen(osfilename)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osopen</span><span class="p">(</span><span class="n">osfilename</span><span class="w"> </span><span class="ow">to</span><span class="w"> </span><span class="nf">ostempfile</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (osopen(osfilename to ostempfile)) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.osbwrite(osfilevar, io offset)</td><td><p>Writes data to an OS file at a specified position.
<tr><td>if</td><td>strvar.osbwrite(osfilevar, io offset)</td><td><p>Writes data to an OS file at a specified position.
Line 2,757: Line 2,732:
</p>
</p>
<em>Returns:</em> True if write succeeds, false if file isn’t accessible, updateable, or creatable.
<em>Returns:</em> True if write succeeds, false if file isn’t accessible, updateable, or creatable.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
<span class="nf">let</span><span class="w"> </span><span class="n">text</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aaa=123</span><span class="se">\n</span><span class="s">bbb=456</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">;</span>
let text = "aaa=123\nbbb=456\n";
<span class="kt">var</span><span class="w"> </span><span class="n">offset</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span><span class="w"> </span><span class="c1">/// -1 means append.</span>
var offset = -1; /// -1 means append.
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">text</span><span class="p">.</span><span class="nf">osbwrite</span><span class="p">(</span><span class="n">osfilename</span><span class="p">,</span><span class="w"> </span><span class="n">offset</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// offset -&gt; 16</span>
if (text.osbwrite(osfilename, offset)) ... ok // offset -> 16
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">osbwrite</span><span class="p">(</span><span class="n">text</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">osfilename</span><span class="p">,</span><span class="w"> </span><span class="n">offset</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not osbwrite(text on osfilename, offset)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.osbread(osfilevar, io offset, length)</td><td><p>Reads data from an OS file at a specified position.
<tr><td>if</td><td>strvar.osbread(osfilevar, io offset, length)</td><td><p>Reads data from an OS file at a specified position.
Line 2,777: Line 2,751:
</p>
</p>
<em>Returns:</em> True if read succeeds, false if file doesn’t exist or isn’t accessible or offset >= file size.
<em>Returns:</em> True if read succeeds, false if file doesn’t exist or isn’t accessible or offset >= file size.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
<span class="kt">var</span><span class="w"> </span><span class="n">text</span><span class="p">,</span><span class="w"> </span><span class="n">offset</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
var text, offset = 0;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">text</span><span class="p">.</span><span class="nf">osbread</span><span class="p">(</span><span class="n">osfilename</span><span class="p">,</span><span class="w"> </span><span class="n">offset</span><span class="p">,</span><span class="w"> </span><span class="mi">8</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// text -&gt; &quot;aaa=123\n&quot; // offset -&gt; 8</span>
if (text.osbread(osfilename, offset, 8)) ... ok // text -> "aaa=123\n" // offset -> 8
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osbread</span><span class="p">(</span><span class="n">text</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="n">osfilename</span><span class="p">,</span><span class="w"> </span><span class="n">offset</span><span class="p">,</span><span class="w"> </span><span class="mi">8</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// text -&gt; &quot;bbb=456\n&quot; // offset -&gt; 16</span>
if (osbread(text from osfilename, offset, 8)) ... ok // text -> "bbb=456\n" // offset -> 16</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>osfile << anything << std::endl;</td><td><p>Use convenient << syntax to output anything to an osfile.
<tr><td></td><td>osfile << anything << std::endl;</td><td><p>Use convenient << syntax to output anything to an osfile.
</p>
</p>
<em>osfile:</em> An os path and filename or an osfilevar opened by osopen(). The file will be appended, or created if it does not already exist. osfile can be "stdout" or "stderr" to simulate cout/cerr/clog.
<em>osfile:</em> An OS path and filename or an osfilevar opened by osopen(). The file will be appended, or created if it does not already exist. osfile can be "stdout" or "stderr" to simulate cout/cerr/clog.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">txtfile</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;t_temp.txt&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let txtfile = "t_temp.txt";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">osremove</span><span class="p">(</span><span class="n">txtfile</span><span class="p">))</span><span class="w"> </span><span class="p">{}</span><span class="w"> </span><span class="c1">// Remove any existing file.</span>
if (not osremove(txtfile)) {} // Remove any existing file.
<span class="n">txtfile</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">txtfile</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot; &quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">123.456789</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot; &quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">123</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">endl</span><span class="p">;</span>
txtfile << txtfile << " " << 123.456789 << " " << 123 << std::endl;
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">osread</span><span class="p">(</span><span class="n">txtfile</span><span class="p">);</span><span class="w">   </span><span class="c1">// &quot;t_temp.txt 123.457 123\n&quot;</span>
let v1 = osread(txtfile);  // "t_temp.txt 123.457 123\n"</code></pre>
</pre></div>
 
All standard c++ io manipulators may be used e.g. std::setw, setfill etc.
All standard c++ io manipulators may be used e.g. std::setw, setfill etc.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">vout</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;t_std_iomanip_overview.txt&quot;</span><span class="p">;</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">osremove</span><span class="p">(</span><span class="n">vout</span><span class="p">))</span><span class="w"> </span><span class="p">{}</span>
<span class="k">using</span><span class="w"> </span><span class="k">namespace</span><span class="w"> </span><span class="nn">std</span><span class="p">;</span>


<pre><code class='language-cpp'>let vout = "std_iomanip_overview.txt";
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">boolalpha</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="nb">true</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">true&quot;</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
if (not osremove(vout)) {}
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">noboolalpha</span><span class="w">  </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="nb">true</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">1&quot;</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
using namespace std;


vout << boolalpha   << true         << "\ttrue"   << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">showpoint</span><span class="w">   </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">42.0</span><span class="w">         </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">42.0000&quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << noboolalpha << true         << "\t1"       << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">noshowpoint</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">42.0</span><span class="w">         </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">42&quot;</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>


vout << showpoint    << 42.0          << "\t42.0000" << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">showpos</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w">            </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">+42&quot;</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << noshowpoint  << 42.0          << "\t42"      << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">noshowpos</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w">            </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">42&quot;</span><span class="w">     </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>


vout << showpos      << 42           << "\t+42"    << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">skipws</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot; &quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s"> 42&quot;</span><span class="w">     </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << noshowpos    << 42           << "\t42"     << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">noskipws</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot; &quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s"> 42&quot;</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>


vout << skipws      << " " << 42    << "\t 42"     << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">unitbuf</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;a&quot;</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">a&quot;</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << noskipws    << " " << 42    << "\t 42"     << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">nounitbuf</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;b&quot;</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">b&quot;</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>


vout << unitbuf     << "a"           << "\ta"       << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">setw</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span><span class="w">     </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w">            </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">   42&quot;</span><span class="w">  </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << nounitbuf   << "b"           << "\tb"       << endl;


vout << setw(6)     << 42           << "\t    42"  << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">left</span><span class="w">        </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">setw</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">42    &quot;</span><span class="w">  </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">right</span><span class="w">        </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">setw</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">    42&quot;</span><span class="w">  </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">internal</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">setw</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">   42&quot;</span><span class="w">  </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">setfill</span><span class="p">(</span><span class="sc">&#39;*&#39;</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">setw</span><span class="p">(</span><span class="mi">6</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">****42&quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>


vout << left        << setw(6) << 42 << "\t42    " << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">showbase</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">hex</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">255</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">0xff&quot;</span><span class="w">   </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << right        << setw(6) << 42 << "\t    42" << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">noshowbase</span><span class="w"</span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">255</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">ff&quot;</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << internal    << setw(6) << 42 << "\t    42" << endl;
vout << setfill('*') << setw(6) << 42 << "\t****42" << endl;


vout << showbase    << hex << 255   << "\t0xff"   << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">uppercase</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">255</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">FF&quot;</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << noshowbase  << 255          << "\tff"      << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">nouppercase</span><span class="w">  </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">255</span><span class="w">           </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">ff&quot;</span><span class="w">     </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>


vout << uppercase    << 255          << "\tFF"      << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">oct</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">255</span><span class="w">           </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">377&quot;</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << nouppercase  << 255          << "\tff"     << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">hex</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">255</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">ff&quot;</span><span class="w">     </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">dec</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">255</span><span class="w">           </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">255&quot;</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>


vout << oct         << 255          << "\t377"     << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">fixed</span><span class="w">        </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">42.1</span><span class="w">         </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">42.100000&quot;</span><span class="w">            </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << hex         << 255          << "\tff"     << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">scientific</span><span class="w">  </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">42.1</span><span class="w">         </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">4.210000e+01&quot;</span><span class="w">        </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << dec         << 255          << "\t255"     << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">hexfloat</span><span class="w">    </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">42.1</span><span class="w">         </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">0x1.50ccccccccccdp+5&quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">defaultfloat</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">42.1</span><span class="w">          </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">42.1&quot;</span><span class="w">                </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>


vout << fixed        << 42.1          << "\t42.100000"           << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="nf">setprecision</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">42.1567</span><span class="w"</span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">42.2&quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << scientific  << 42.1          << "\t4.210000e+01"         << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">resetiosflags</span><span class="p">(</span><span class="n">ios</span><span class="o">::</span><span class="n">fixed</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mf">42.1567</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">42.2&quot;</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << hexfloat    << 42.1          << "\t0x1.50ccccccccccdp+5" << endl;
<span class="n">vout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">setiosflags</span><span class="p">(</span><span class="n">ios</span><span class="o">::</span><span class="n">showpos</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="mi">42</span><span class="w">      </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;</span><span class="se">\t</span><span class="s">+42&quot;</span><span class="w">  </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="n">endl</span><span class="p">;</span>
vout << defaultfloat << 42.1          << "\t42.1"                 << endl;
 
vout << std::setprecision(3)      << 42.1567  << "\t42.2"  << endl;
vout << resetiosflags(ios::fixed) << 42.1567  << "\t42.2"  << endl;
vout << setiosflags(ios::showpos) << 42       << "\t+42"   << endl;
 
// Verify actual v. expected.
var act_v_exp = osread(vout);
act_v_exp.converter("\n\t", FM ^ VM); // Text to dynamic array
act_v_exp = invertarray(act_v_exp);   // Columns <-> Rows
assert(act_v_exp.f(1) eq act_v_exp.f(2));</code></pre>


<span class="c1">// Verify actual v. expected.</span>
<span class="kt">var</span><span class="w"> </span><span class="n">act_v_exp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">osread</span><span class="p">(</span><span class="n">vout</span><span class="p">);</span>
<span class="n">act_v_exp</span><span class="p">.</span><span class="nf">converter</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\n\t</span><span class="s">&quot;</span><span class="p">,</span><span class="w"> </span><span class="kc">FM</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="kc">VM</span><span class="p">);</span><span class="w"> </span><span class="c1">// Text to dynamic array</span>
<span class="n">act_v_exp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">invertarray</span><span class="p">(</span><span class="n">act_v_exp</span><span class="p">);</span><span class="w">  </span><span class="c1">// Columns &lt;-&gt; Rows</span>
<span class="n">assert</span><span class="p">(</span><span class="n">act_v_exp</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="ow">eq</span><span class="w"> </span><span class="n">act_v_exp</span><span class="p">.</span><span class="nf">f</span><span class="p">(</span><span class="mi">2</span><span class="p">));</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td></td><td>var().osclose()</td><td><p>Removes an osfilevar handle from the internal memory cache of os file handles. This frees up both exodus process memory and operating system resources.
<tr><td></td><td>var().osclose()</td><td><p>Removes an osfilevar handle from the internal memory cache of OS file handles. This frees up both exodus process memory and operating system resources.
</p>
</p>
It is advisable to osclose any file handles after use, regardless of whether they were specifically opened using osopen or not, especially in long running programs. Exodus performs caching of internal os file handles per thread and os file. If not closed, then the operating system will probably not flush deleted files from storage until the process is terminated. This can potentially create an memory issue or file system resource issue especially if osopening/osreading/oswriting many perhaps temporary files in a long running process.
It is advisable to osclose any file handles after use, regardless of whether they were specifically opened using osopen or not, especially in long running programs. Exodus performs caching of internal OS file handles per thread and OS file. If not closed, then the operating system will probably not flush deleted files from storage until the process is terminated. This can potentially create an memory issue or file system resource issue especially if osopening/osreading/oswriting many perhaps temporary files in a long running process.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">osfilevar</span><span class="p">;</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">osfilevar</span><span class="p">.</span><span class="nf">osopen</span><span class="p">(</span><span class="nf">ostempfile</span><span class="p">()))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
<pre><code class='language-cpp'>var osfilevar; if (osfilevar.osopen(ostempfile())) ... ok
<span class="n">osfilevar</span><span class="p">.</span><span class="nf">osclose</span><span class="p">();</span>
osfilevar.osclose();
<span class="c1">// or</span>
// or
<span class="nf">osclose</span><span class="p">(</span><span class="n">osfilevar</span><span class="p">);</span>
osclose(osfilevar);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.oswrite(osfilename, codepage = "")</td><td><p>Create a complete os file from a var.
<tr><td>if</td><td>strvar.oswrite(osfilename, codepage = "")</td><td><p>Create a complete OS file from a var.
</p>
</p>
<p><em>strvar:</em> The text or data to be used to create the file.
<p><em>strvar:</em> The text or data to be used to create the file.
</p>
</p>
<p><em>osfilename:</em> Absolute or relative path and filename to be written. Any existing os file is removed first.
<p><em>osfilename:</em> Absolute or relative path and filename to be written. Any existing OS file is removed first.
</p>
</p>
<p><em>codepage:</em> If specified then output is converted from UTF-8 to that codepage before being written. Otherwise no conversion is done.
<p><em>codepage:</em> If specified then output is converted from UTF-8 to that codepage before being written. Otherwise no conversion is done.
</p>
</p>
<em>Returns:</em> True if successful or false if not possible for any reason. e.g. Path is not writeable, permissions etc
<em>Returns:</em> True if successful or false if not possible for any reason. e.g. Path is not writeable, permissions etc
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">text</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aaa = 123</span><span class="se">\n</span><span class="s">bbb = 456&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let text = "aaa = 123\nbbb = 456";
<span class="nf">let</span><span class="w"> </span><span class="n">osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">;</span>
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">text</span><span class="p">.</span><span class="nf">oswrite</span><span class="p">(</span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (text.oswrite(osfilename)) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">oswrite</span><span class="p">(</span><span class="n">text</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (oswrite(text on osfilename)) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.osread(osfilename, codepage = "")</td><td><p>Read a complete os file into a var.
<tr><td>if</td><td>strvar.osread(osfilename, codepage = "")</td><td><p>Read a complete OS file into a var.
</p>
</p>
<p><em>osfilename:</em> Absolute or relative path and filename to be read.
<p><em>osfilename:</em> Absolute or relative path and filename to be read.
Line 2,884: Line 2,853:
</p>
</p>
<em>Returns:</em> True if successful or false if not possible for any reason. e.g. File doesnt exist, insufficient permissions etc.
<em>Returns:</em> True if successful or false if not possible for any reason. e.g. File doesnt exist, insufficient permissions etc.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">text</span><span class="p">;</span>
<pre><code class='language-cpp'>var text;
<span class="nf">let</span><span class="w"> </span><span class="n">osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">;</span>
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">text</span><span class="p">.</span><span class="nf">osread</span><span class="p">(</span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// text -&gt; &quot;aaa = 123\nbbb = 456&quot;</span>
if (text.osread(osfilename)) ... ok // text -> "aaa = 123\nbbb = 456"
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osread</span><span class="p">(</span><span class="n">text</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (osread(text from osfilename)) ... ok
<span class="nf">let</span><span class="w"> </span><span class="n">text2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">osread</span><span class="p">(</span><span class="n">osfilename</span><span class="p">);</span>
let text2 = osread(osfilename);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>osfile_or_dirname.osrename(new_dirpath_or_filepath)</td><td><p>Renames an os file or dir in the OS file system.
<tr><td>if</td><td>osfile_or_dirname.osrename(new_dirpath_or_filepath)</td><td><p>Renames an OS file or dir in the OS file system.
</p>
</p>
<p>The source and target must exist in the same storage device.
<p>The source and target must exist in the same storage device.
Line 2,899: Line 2,867:
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be renamed.
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be renamed.
</p>
</p>
<p><em>new_dirpath_or_filepath:</em> Will not overwrite an existing os file or dir.
<p><em>new_dirpath_or_filepath:</em> Will not overwrite an existing OS file or dir.
</p>
</p>
<p><em>Returns:</em> True if successful or false if not possible for any reason. e.g. Target already exists, path is not writeable, permissions etc.
<p><em>Returns:</em> True if successful or false if not possible for any reason. e.g. Target already exists, path is not writeable, permissions etc.
</p>
</p>
Uses std::filesystem::rename internally.
Uses std::filesystem::rename internally.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">from_osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">;</span>
<span class="nf">let</span><span class="w"> </span><span class="n">to_osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">from_osfilename</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;.bak&quot;</span><span class="p">;</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">osremove</span><span class="p">(</span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf.bak&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{};</span><span class="w"> </span><span class="c1">// Cleanup first</span>


<pre><code class='language-cpp'>let from_osfilename = ostempdir() ^ "xo_gendoc_test.conf";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">from_osfilename</span><span class="p">.</span><span class="nf">osrename</span><span class="p">(</span><span class="n">to_osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
let to_osfilename = from_osfilename ^ ".bak";
<span class="c1">// or</span>
if (not osremove(ostempdir() ^ "xo_gendoc_test.conf.bak")) {}; // Cleanup first
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osrename</span><span class="p">(</span><span class="n">from_osfilename</span><span class="p">,</span><span class="w"> </span><span class="n">to_osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
 
</pre></div>
if (from_osfilename.osrename(to_osfilename)) ... ok
// or
if (osrename(from_osfilename, to_osfilename)) ...</code></pre>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>osfile_or_dirname.osmove(to_osfilename)</td><td><p>"Moves" an os file or dir within the os file system.
<tr><td>if</td><td>osfile_or_dirname.osmove(to_osfilename)</td><td><p>"Moves" an OS file or dir within the OS file system.
</p>
</p>
<p>Attempts osrename first, then oscopy followed by osremove original.
<p>Attempts osrename first, then oscopy followed by osremove original.
Line 2,920: Line 2,887:
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be moved.
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be moved.
</p>
</p>
<p><em>to_osfilename:</em> Will not overwrite an existing os file or dir.
<p><em>to_osfilename:</em> Will not overwrite an existing OS file or dir.
</p>
</p>
<em>Returns:</em> True if successful or false if not possible for any reason. e.g. Source doesnt exist or cannot be accessed, target already exists, source or target is not writeable, permissions, storage space etc.
<em>Returns:</em> True if successful or false if not possible for any reason. e.g. Source doesnt exist or cannot be accessed, target already exists, source or target is not writeable, permissions, storage space etc.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">from_osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf.bak&quot;</span><span class="p">;</span>
<span class="nf">let</span><span class="w"> </span><span class="n">to_osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">from_osfilename</span><span class="p">.</span><span class="nf">cut</span><span class="p">(</span><span class="mi">-4</span><span class="p">);</span>


<pre><code class='language-cpp'>let from_osfilename = ostempdir() ^ "xo_gendoc_test.conf.bak";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">osremove</span><span class="p">(</span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{};</span><span class="w"> </span><span class="c1">// Cleanup first</span>
let to_osfilename = from_osfilename.cut(-4);
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">from_osfilename</span><span class="p">.</span><span class="nf">osmove</span><span class="p">(</span><span class="n">to_osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
 
<span class="c1">// or</span>
if (not osremove(ostempdir() ^ "xo_gendoc_test.conf")) {}; // Cleanup first
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osmove</span><span class="p">(</span><span class="n">from_osfilename</span><span class="p">,</span><span class="w"> </span><span class="n">to_osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (from_osfilename.osmove(to_osfilename)) ... ok
</pre></div>
// or
if (osmove(from_osfilename, to_osfilename)) ...</code></pre>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>osfile_or_dirname.oscopy(to_osfilename)</td><td><p>Copies an os file or directory recursively within the os file system.
<tr><td>if</td><td>osfile_or_dirname.oscopy(to_osfilename)</td><td><p>Copies an OS file or directory recursively within the OS file system.
</p>
</p>
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be copied.
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be copied.
</p>
</p>
<p><em>to_osfilename:</em> Will overwrite an existing os file or merge into an existing dir.
<p><em>to_osfilename:</em> Will overwrite an existing OS file or merge into an existing dir.
</p>
</p>
<p><em>Returns:</em> True if successful or false if not possible for any reason. e.g. Source doesnt exist or cannot be accessed, target is not writeable, permissions, storage space, etc.
<p><em>Returns:</em> True if successful or false if not possible for any reason. e.g. Source doesnt exist or cannot be accessed, target is not writeable, permissions, storage space, etc.
</p>
</p>
Uses std::filesystem::copy internally with recursive and overwrite options
Uses std::filesystem::copy internally with recursive and overwrite options
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">from_osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">;</span>
<span class="nf">let</span><span class="w"> </span><span class="n">to_osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">from_osfilename</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;.bak&quot;</span><span class="p">;</span>


<pre><code class='language-cpp'>let from_osfilename = ostempdir() ^ "xo_gendoc_test.conf";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">from_osfilename</span><span class="p">.</span><span class="nf">oscopy</span><span class="p">(</span><span class="n">to_osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="p">;</span>
let to_osfilename = from_osfilename ^ ".bak";
<span class="c1">// or</span>
 
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">oscopy</span><span class="p">(</span><span class="n">from_osfilename</span><span class="p">,</span><span class="w"> </span><span class="n">to_osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (from_osfilename.oscopy(to_osfilename)) ... ok;
</pre></div>
// or
if (oscopy(from_osfilename, to_osfilename)) ... ok</code></pre>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>osfilename.osremove()</td><td><p>Removes/deletes an os file from the OS file system.
<tr><td>if</td><td>osfilename.osremove()</td><td><p>Removes/deletes an OS file from the OS file system.
</p>
</p>
<p>Will not remove directories. Use osrmdir() to remove directories
<p>Will not remove directories. Use osrmdir() to remove directories
Line 2,960: Line 2,925:
</p>
</p>
If osfilename is an osfilevar then it is automatically closed.
If osfilename is an osfilevar then it is automatically closed.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">()</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="s">&quot;xo_gendoc_test.conf&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">osfilename</span><span class="p">.</span><span class="nf">osremove</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (osfilename.osremove()) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osremove</span><span class="p">(</span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (osremove(osfilename)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 2,972: Line 2,936:
<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>dirpath.oslist(globpattern = "", mode = 0)</td><td><p>Get a list of os files and/or dirs.
<tr><td>var=</td><td>dirpath.oslist(globpattern = "", mode = 0)</td><td><p>Get a list of OS files and/or dirs.
</p>
</p>
<p><em>dirpath:</em> Absolute or relative dir path.
<p><em>dirpath:</em> Absolute or relative dir path.
Line 2,978: Line 2,942:
<p><em>globpattern:</em> e.g. *.conf to be appended to the dirpath or a complete path plus glob pattern e.g. /etc/ *.conf.
<p><em>globpattern:</em> e.g. *.conf to be appended to the dirpath or a complete path plus glob pattern e.g. /etc/ *.conf.
</p>
</p>
<p><em>mode:</em> 0: default - Any regular files or dirs. 1 - Only regular os files. 2 - Only dirs.
<p><em>mode:</em> 0: default - Any regular files or dirs. 1 - Only regular OS files. 2 - Only dirs.
</p>
</p>
<em>Returns:</em> An FM delimited string containing all matching dir entries given a dir path
<em>Returns:</em> An FM delimited string containing all matching dir entries given a dir path
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">entries1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;/etc/&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oslist</span><span class="p">(</span><span class="s">&quot;*.cfg&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">/// e.g. &quot;adduser.conf^ca-certificates.con^... etc.&quot;</span>
<pre><code class='language-cpp'>var entries1 = "/etc/"_var.oslist("*.cfg"); /// e.g. "adduser.conf^ca-certificates.con^... etc."
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">entries2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oslist</span><span class="p">(</span><span class="s">&quot;/etc/&quot;</span><span class="w"> </span><span class="s">&quot;*.conf&quot;</span><span class="p">);</span>
var entries2 = oslist("/etc/" "*.conf");</code></pre>
</pre></div></td></tr>
</td></tr>
<tr><td>var=</td><td>dirpath.oslistf(globpattern = "")</td><td>Same as oslist for files only</td></tr>
<tr><td>var=</td><td>dirpath.oslistf(globpattern = "")</td><td>Same as oslist for files only</td></tr>
<tr><td>var=</td><td>dirpath.oslistd(globpattern = "")</td><td>Same as oslist for files only</td></tr>
<tr><td>var=</td><td>dirpath.oslistd(globpattern = "")</td><td>Same as oslist for files only</td></tr>
<tr><td>var=</td><td>osfile_or_dirpath.osinfo(mode = 0)</td><td><p>Get dir info about an os file or dir.
<tr><td>var=</td><td>osfile_or_dirpath.osinfo(mode = 0)</td><td><p>Get dir info about an OS file or dir.
</p>
</p>
<p><em>Returns:</em> A short string containing size ^ FM ^ modified_time ^ FM ^ modified_time or "" if not a regular file or dir.
<p><em>Returns:</em> A short string containing size ^ FM ^ modified_time ^ FM ^ modified_time or "" if not a regular file or dir.
</p>
</p>
<p><em>mode:</em> 0: default. 1: Must be a regular os file. 2: Must be an os dir.
<p><em>mode:</em> 0: default. 1: Must be a regular OS file. 2: Must be an OS dir.
</p>
</p>
See also osfile() and osdir()
See also osfile() and osdir()
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">info1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;/etc/hosts&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">osinfo</span><span class="p">();</span><span class="w"> </span><span class="c1">/// e.g. &quot;221^20597^78309&quot;_var</span>
<pre><code class='language-cpp'>var info1 = "/etc/hosts"_var.osinfo(); /// e.g. "221^20597^78309"_var
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">info2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">osinfo</span><span class="p">(</span><span class="s">&quot;/etc/hosts&quot;</span><span class="p">);</span>
var info2 = osinfo("/etc/hosts");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>osfilename.osfile()</td><td><p>Get dir info of an os file.
<tr><td>var=</td><td>osfilename.osfile()</td><td><p>Get dir info of an OS file.
</p>
</p>
<p><em>osfilename:</em> Absolute or relative path and file name.
<p><em>osfilename:</em> Absolute or relative path and file name.
Line 3,008: Line 2,970:
</p>
</p>
Alias for osinfo(1)
Alias for osinfo(1)
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">fileinfo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;/etc/hosts&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">osfile</span><span class="p">();</span><span class="w"> </span><span class="c1">/// e.g. &quot;221^20597^78309&quot;_var</span>
<pre><code class='language-cpp'>var fileinfo1 = "/etc/hosts"_var.osfile(); /// e.g. "221^20597^78309"_var
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">fileinfo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">osfile</span><span class="p">(</span><span class="s">&quot;/etc/hosts&quot;</span><span class="p">);</span>
var fileinfo2 = osfile("/etc/hosts");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>dirpath.osdir()</td><td><p>Get dir info of an os dir.
<tr><td>var=</td><td>dirpath.osdir()</td><td><p>Get dir info of an OS dir.
</p>
</p>
<p><em>dirpath:</em> Absolute or relative path and dir name.
<p><em>dirpath:</em> Absolute or relative path and dir name.
Line 3,021: Line 2,982:
</p>
</p>
Alias for osinfo(2)
Alias for osinfo(2)
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dirinfo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;/etc/&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">osdir</span><span class="p">();</span><span class="w"> </span><span class="c1">/// e.g. &quot;^20848^44464&quot;_var</span>
<pre><code class='language-cpp'>var dirinfo1 = "/etc/"_var.osdir(); /// e.g. "^20848^44464"_var
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">dirinfo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">osfile</span><span class="p">(</span><span class="s">&quot;/etc/&quot;</span><span class="p">);</span>
var dirinfo2 = osfile("/etc/");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>dirpath.osmkdir()</td><td><p>Create a new os file system directory.
<tr><td>if</td><td>dirpath.osmkdir()</td><td><p>Create a new OS file system directory.
</p>
</p>
<p>Parent dirs wil be created if necessary.
<p>Parent dirs wil be created if necessary.
Line 3,034: Line 2,994:
</p>
</p>
<em>Returns:</em> True if successful.
<em>Returns:</em> True if successful.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">osdirname</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_test/aaa&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let osdirname = "xo_test/aaa";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osrmdir</span><span class="p">(</span><span class="s">&quot;xo_test/aaa&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{};</span><span class="w"> </span><span class="c1">// Cleanup first</span>
if (osrmdir("xo_test/aaa")) {}; // Cleanup first
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">osdirname</span><span class="p">.</span><span class="nf">osmkdir</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (osdirname.osmkdir()) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osmkdir</span><span class="p">(</span><span class="n">osdirname</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (osmkdir(osdirname)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>var::oscwd(newpath)</td><td><p>Changes the current working dir.
<tr><td>if</td><td>var::oscwd(newpath)</td><td><p>Changes the current working dir.
Line 3,047: Line 3,006:
</p>
</p>
<em>Returns:</em> True if successful or false if not. e.g. Invalid dirpath, insufficient permission etc.
<em>Returns:</em> True if successful or false if not. e.g. Invalid dirpath, insufficient permission etc.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">osdirname</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_test/aaa&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let osdirname = "xo_test/aaa";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">osdirname</span><span class="p">.</span><span class="nf">oscwd</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (osdirname.oscwd()) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">oscwd</span><span class="p">(</span><span class="n">osdirname</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (oscwd(osdirname)) ... ok
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">oscwd</span><span class="p">(</span><span class="s">&quot;../..&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">/// Change back to avoid errors in following code.</span>
if (oscwd("../..")) ... ok /// Change back to avoid errors in following code.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::oscwd()</td><td><p>Gets the current dir path and name.
<tr><td>var=</td><td>var::oscwd()</td><td><p>Gets the current dir path and name.
Line 3,060: Line 3,018:
</p>
</p>
e.g. "/root/exodus/cli/src/xo_test/aaa"
e.g. "/root/exodus/cli/src/xo_test/aaa"
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">cwd1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">().</span><span class="nf">oscwd</span><span class="p">();</span>
<pre><code class='language-cpp'>var cwd1 = var().oscwd();
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">cwd2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oscwd</span><span class="p">();</span>
var cwd2 = oscwd();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>dirpath.osrmdir(evenifnotempty = false)</td><td><p>Removes (deletes) an os dir,
<tr><td>if</td><td>dirpath.osrmdir(evenifnotempty = false)</td><td><p>Removes (deletes) an OS dir,
</p>
</p>
<p><em>eventifnotempty:</em> If true any subdirs will also be removed/deleted recursively, otherwise the function will fail and return false.
<p><em>eventifnotempty:</em> If true any subdirs will also be removed/deleted recursively, otherwise the function will fail and return false.
</p>
</p>
<em>Returns:</em> Returns true if successful or false if not. e.g dir doesnt exist, insufficient permission, not empty etc.
<em>Returns:</em> Returns true if successful or false if not. e.g dir doesnt exist, insufficient permission, not empty etc.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">osdirname</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_test/aaa&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let osdirname = "xo_test/aaa";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">osdirname</span><span class="p">.</span><span class="nf">osrmdir</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (osdirname.osrmdir()) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osrmdir</span><span class="p">(</span><span class="n">osdirname</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (osrmdir(osdirname)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 3,085: Line 3,041:
<tr><td>if</td><td>command.osshell()</td><td><p>Execute a shell command.
<tr><td>if</td><td>command.osshell()</td><td><p>Execute a shell command.
</p>
</p>
<p><em>command:</em> An executable command to be interpreted by the default os shell.
<p><em>command:</em> An executable command to be interpreted by the default OS shell.
</p>
</p>
<p><em>Returns:</em> True if the process terminates with error status 0 and false otherwise.
<p><em>Returns:</em> True if the process terminates with error status 0 and false otherwise.
</p>
</p>
Append "&>/dev/null" to the command to suppress terminal output.
Append "&>/dev/null" to the command to suppress terminal output.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">cmd</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;echo $HOME&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let cmd = "echo $HOME";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="nf">osshell</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (cmd.osshell()) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osshell</span><span class="p">(</span><span class="n">cmd</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (osshell(cmd)) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>instr.osshellread(oscmd)</td><td><p>Same as osshell but captures and returns stdout
<tr><td>if</td><td>instr.osshellread(oscmd)</td><td><p>Same as osshell but captures and returns stdout
Line 3,102: Line 3,057:
</p>
</p>
Append "2>&1" to the command to capture stderr/stdlog output as well.
Append "2>&1" to the command to capture stderr/stdlog output as well.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">cmd</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;echo $HOME&quot;</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">text</span><span class="p">;</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">text</span><span class="p">.</span><span class="nf">osshellread</span><span class="p">(</span><span class="n">cmd</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>


<pre><code class='language-cpp'>let cmd = "echo $HOME";
<span class="c1">// or capturing stdout but ignoring exit status</span>
var text;
<span class="n">text</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">osshellread</span><span class="p">(</span><span class="n">cmd</span><span class="p">);</span>
if (text.osshellread(cmd)) ... ok
</pre></div>
 
// or capturing stdout but ignoring exit status
text = osshellread(cmd);</code></pre>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>outstr.osshellwrite(oscmd)</td><td><p>Same as osshell but provides stdin to the process
<tr><td>if</td><td>outstr.osshellwrite(oscmd)</td><td><p>Same as osshell but provides stdin to the process
Line 3,116: Line 3,070:
</p>
</p>
Append "&> somefile" to the command to suppress and/or capture output.
Append "&> somefile" to the command to suppress and/or capture output.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">outtext</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;abc xyz&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let outtext = "abc xyz";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">outtext</span><span class="p">.</span><span class="nf">osshellwrite</span><span class="p">(</span><span class="s">&quot;grep xyz&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (outtext.osshellwrite("grep xyz")) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">osshellwrite</span><span class="p">(</span><span class="n">outtext</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;grep xyz&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (osshellwrite(outtext, "grep xyz")) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::ostempdir()</td><td><p>Get the tmp dir path and name.
<tr><td>if</td><td>var::osprocess(oscmd, stdin_for_process, out stdout_from_process, out stderr_from_process, out exit_status, timeout_secs = 0)</td><td><p>Run an OS program synchronously.
</p>
<p>Executes an OS program passing input and capturing standard and error output, and exit status.
</p>
</p>
<em>Returns:</em> A string e.g. "/tmp/"
<p>Shell features (e.g., pipes, redirects) are not supported but can be invoked using an oscmd like "bash -c \"abc|yyy $HOME\""
 
</p>
<pre><code class='language-cpp'>let v1 = var::ostempdir();
<p><em>oscmd:</em> The executable program and its arguments. Must exist in the OS PATH.
// or
</p>
let v2 = ostempdir();</code></pre>
<p><em>stdin_for_process:</em> Optional. Input data to send to the program's standard input.
 
</p>
<p><em>stdout_from_process:</em> [out] Standard output produced by the program.
</p>
<p><em>stderr_from_process:</em> [out] Error or log output from the program.
</p>
<p><em>exit_status:</em> [out] Result of the program's execution:
</p>
<p>*  0 Program terminated normally.
</p>
<p>* -1 Timeout
</p>
<p>* nn Program reported an exit status.
</p>
<p><em>timeout_in_secs:</em> Optional. Maximum runtime in seconds (default 0 = no timeout).
</p>
<p><em>Returns:</em> Success or failure.
</p>
<p>* true    Program ran and exited with status 0 (success).
</p>
<p>* false  Program failed to start, timed out, or exited with non-zero status.
</p>
<p><em>Throws:</em> Various system errors are possible.
</p>
<p>* Pipe creation failed.
</p>
<p>* Fork failed.
</p>
* Poll failure.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v_stdout</span><span class="p">,</span><span class="w"> </span><span class="n">v_stderr</span><span class="p">,</span><span class="w"> </span><span class="n">v_exit_status</span><span class="p">;</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kt">var</span><span class="o">::</span><span class="n">osprocess</span><span class="p">(</span><span class="s">&quot;grep xyz&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;abc</span><span class="se">\n</span><span class="s">xyz 123</span><span class="se">\n</span><span class="s">def&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">v_stdout</span><span class="p">,</span><span class="w"> </span><span class="n">v_stderr</span><span class="p">,</span><span class="w"> </span><span class="n">v_exit_status</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// v_stdout -&gt; &quot;xyz 123&quot; // v_exit_status = 0</span>
<span class="c1">// or</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">osprocess</span><span class="p">(</span><span class="s">&quot;grep xyz&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;abc</span><span class="se">\n</span><span class="s">xyz 123</span><span class="se">\n</span><span class="s">def&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">v_stdout</span><span class="p">,</span><span class="w"> </span><span class="n">v_stderr</span><span class="p">,</span><span class="w"> </span><span class="n">v_exit_status</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
</pre></div>
</td></tr>
<tr><td>var=</td><td>var::ostempdir()</td><td><p>Get the tmp dir path and name.
</p>
<em>Returns:</em> A string e.g. "/tmp/"
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">ostempdir</span><span class="p">();</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempdir</span><span class="p">();</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::ostempfile()</td><td><p>Create a temporary file
<tr><td>var=</td><td>var::ostempfile()</td><td><p>Create a temporary file
</p>
</p>
<em>Returns:</em> The name of new temporary file e.g. "/tmp/~exoEcLj3C"
<em>Returns:</em> The name of new temporary file e.g. "/tmp/~exoEcLj3C"
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">temposfilename1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">ostempfile</span><span class="p">();</span>
<pre><code class='language-cpp'>var temposfilename1 = var::ostempfile();
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">temposfilename2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostempfile</span><span class="p">();</span>
var temposfilename2 = ostempfile();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>envvalue.ossetenv(envcode)</td><td><p>Set the value of an environment variable
<tr><td></td><td>envvalue.ossetenv(envcode)</td><td><p>Set the value of an environment variable
Line 3,146: Line 3,140:
</p>
</p>
<em>envvalue:</em> The new value to set the env code to.
<em>envvalue:</em> The new value to set the env code to.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">envcode</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;EXO_ABC&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">envvalue</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;XYZ&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let envcode = "EXO_ABC", envvalue = "XYZ";
<span class="n">envvalue</span><span class="p">.</span><span class="nf">ossetenv</span><span class="p">(</span><span class="n">envcode</span><span class="p">);</span>
envvalue.ossetenv(envcode);
<span class="c1">// or</span>
// or
<span class="nf">ossetenv</span><span class="p">(</span><span class="n">envcode</span><span class="p">,</span><span class="w"> </span><span class="n">envvalue</span><span class="p">);</span>
ossetenv(envcode, envvalue);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>envvalue.osgetenv(envcode)</td><td><p>Get the value of an environment variable.
<tr><td>if</td><td>envvalue.osgetenv(envcode)</td><td><p>Get the value of an environment variable.
Line 3,161: Line 3,154:
<p><em>Returns:</em> True if the envcode is set or false if not.
<p><em>Returns:</em> True if the envcode is set or false if not.
</p>
</p>
<p>osgetenv and ossetenv work with a per thread copy of the os process environment. This avoids multithreading issues but does not change the process environment. Child processes created by var::osshell() will not inherit any env variables set using ossetenv() so the oscommand will need to be prefixed to achieve the desired result.
<p>osgetenv and ossetenv work with a per thread copy of the OS process environment. This avoids multithreading issues but does not change the process environment. Child processes created by var::osshell() will not inherit any env variables set using ossetenv() so the oscommand will need to be prefixed to achieve the desired result.
</p>
</p>
For the actual system environment, see "man environ". extern char **environ; // environ is a pointer to an array of pointers to char* env pairs like xxx=yyy and the last pointer in the array is nullptr.
For the actual system environment, see "man environ". extern char **environ; // environ is a pointer to an array of pointers to char* env pairs like xxx=yyy and the last pointer in the array is nullptr.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">envvalue1</span><span class="p">;</span>
<pre><code class='language-cpp'>var envvalue1;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">envvalue1</span><span class="p">.</span><span class="nf">osgetenv</span><span class="p">(</span><span class="s">&quot;HOME&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// e.g. &quot;/home/exodus&quot;</span>
if (envvalue1.osgetenv("HOME")) ... ok // e.g. "/home/exodus"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">envvalue2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">osgetenv</span><span class="p">(</span><span class="s">&quot;EXO_ABC&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;XYZ&quot;</span>
let envvalue2 = osgetenv("EXO_ABC"); // "XYZ"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::ospid()</td><td><p>Get the current os process id
<tr><td>var=</td><td>var::ospid()</td><td><p>Get the current OS process id
</p>
</p>
<em>Returns:</em> A number e.g. 663237.
<em>Returns:</em> A number e.g. 663237.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">pid1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">ospid</span><span class="p">();</span><span class="w"> </span><span class="c1">/// e.g. 663237</span>
<pre><code class='language-cpp'>let pid1 = var::ospid(); /// e.g. 663237
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">pid2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ospid</span><span class="p">();</span>
let pid2 = ospid();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::ostid()</td><td><p>Get the current os thread process id
<tr><td>var=</td><td>var::ostid()</td><td><p>Get the current OS thread process id
</p>
</p>
<em>Returns:</em> A number e.g. 663237.
<em>Returns:</em> A number e.g. 663237.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">tid1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">ostid</span><span class="p">();</span><span class="w"> </span><span class="c1">/// e.g. 663237</span>
<pre><code class='language-cpp'>let tid1 = var::ostid(); /// e.g. 663237
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">tid2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">ostid</span><span class="p">();</span>
let tid2 = ostid();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::version()</td><td><p>Get the exodus library version info.
<tr><td>var=</td><td>var::version()</td><td><p>Get the exodus library version info.
</p>
</p>
<em>Returns:</em> The git commit details as at the time the library was built.
<em>Returns:</em> The git commit details as at the time the library was built.
 
<div class="highlight light"><pre><span class="c1">// e.g.</span>
<pre><code class='language-cpp'>// e.g.
<span class="c1">// Local:  doc 2025-03-19 18:15:31 +0000 219cdad8a</span>
// Local:  doc 2025-03-19 18:15:31 +0000 219cdad8a
<span class="c1">// Remote: doc 2025-03-17 15:03:00 +0000 958f412f0</span>
// Remote: doc 2025-03-17 15:03:00 +0000 958f412f0
<span class="c1">// https://github.com/exodusdb/exodusdb/commit/219cdad8a</span>
// https://github.com/exodusdb/exodusdb/commit/219cdad8a
<span class="c1">// https://github.com/exodusdb/exodusdb/archive/958f412f0.tar.gz</span>
// https://github.com/exodusdb/exodusdb/archive/958f412f0.tar.gz
<span class="c1">//</span>
//
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">version</span><span class="p">();</span>
let v1 = var::version();
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">version</span><span class="p">();</span>
let v2 = version();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.setxlocale(newlocalecode)</td><td><p>Sets the current thread's default locale.
<tr><td>if</td><td>strvar.setxlocale(newlocalecode)</td><td><p>Sets the current thread's default locale.
Line 3,209: Line 3,198:
</p>
</p>
True if successful
True if successful
 
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kt">var</span><span class="o">::</span><span class="nf">setxlocale</span><span class="p">(</span><span class="s">&quot;en_US.utf8&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
<pre><code class='language-cpp'>if (var::setxlocale("en_US.utf8")) ... ok
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">setxlocale</span><span class="p">(</span><span class="s">&quot;en_US.utf8&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (setxlocale("en_US.utf8")) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>var.getxlocale()</td><td><p>Gets the current thread's default locale.
<tr><td>var=</td><td>var.getxlocale()</td><td><p>Gets the current thread's default locale.
</p>
</p>
<em>Returns:</em> A locale codepage code string.
<em>Returns:</em> A locale codepage code string.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">getxlocale</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;en_US.utf8&quot;</span>
<pre><code class='language-cpp'>let v1 = var::getxlocale(); // "en_US.utf8"
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">getxlocale</span><span class="p">();</span>
let v2 = getxlocale();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
<h5 id=Output>Output</h5>
<h5 id=Output>Output</h5>
Line 3,236: Line 3,223:
</p>
</p>
The raw string bytes are output. No character or byte conversion is performed.
The raw string bytes are output. No character or byte conversion is performed.
 
<div class="highlight light"><pre><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">outputl</span><span class="p">(</span><span class="s">&quot;xyz = &quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">/// Sends &quot;xyz = abc\n&quot; to stdout and flushes.</span>
<pre><code class='language-cpp'>"abc"_var.outputl("xyz = "); /// Sends "xyz = abc\n" to stdout and flushes.
<span class="c1">// or</span>
// or
<span class="nf">outputl</span><span class="p">(</span><span class="s">&quot;xyz = &quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">/// Any number of arguments is allowed. All will be output.</span>
outputl("xyz = ", "abc"); /// Any number of arguments is allowed. All will be output.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>expr</td><td>strvar.output(prefix = "")</td><td> Same as outputl() but doesnt append an NL char and is BUFFERED, not flushed.</td></tr>
<tr><td>expr</td><td>strvar.output(prefix = "")</td><td> Same as outputl() but doesnt append an NL char and is BUFFERED, not flushed.</td></tr>
Line 3,251: Line 3,237:
</p>
</p>
Any of the six types of field mark chars present are converted to their visible versions,
Any of the six types of field mark chars present are converted to their visible versions,
 
<div class="highlight light"><pre><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">logputl</span><span class="p">(</span><span class="s">&quot;xyz = &quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">/// Sends &quot;xyz = abc\n&quot; to stdlog buffer and is not flushed.</span>
<pre><code class='language-cpp'>"abc"_var.logputl("xyz = "); /// Sends "xyz = abc\n" to stdlog buffer and is not flushed.
<span class="c1">// or</span>
// or
<span class="nf">logputl</span><span class="p">(</span><span class="s">&quot;xyz = &quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">);;</span><span class="w"> </span><span class="c1">/// Any number of arguments is allowed. All will be output.</span>
logputl("xyz = ", "abc");; /// Any number of arguments is allowed. All will be output.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>expr</td><td>strvar.logput(prefix = "")</td><td> Same as logputl() but doesnt append an NL char.</td></tr>
<tr><td>expr</td><td>strvar.logput(prefix = "")</td><td> Same as logputl() but doesnt append an NL char.</td></tr>
Line 3,265: Line 3,250:
</p>
</p>
Any of the six types of field mark chars present are converted to their visible versions,
Any of the six types of field mark chars present are converted to their visible versions,
 
<div class="highlight light"><pre><span class="s">&quot;abc&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">errputl</span><span class="p">(</span><span class="s">&quot;xyz = &quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">/// Sends &quot;xyz = abc\n&quot; to stderr</span>
<pre><code class='language-cpp'>"abc"_var.errputl("xyz = "); /// Sends "xyz = abc\n" to stderr
<span class="c1">// or</span>
// or
<span class="nf">errputl</span><span class="p">(</span><span class="s">&quot;xyz = &quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;abc&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">/// Any number of arguments is allowed. All will be output.</span>
errputl("xyz = ", "abc"); /// Any number of arguments is allowed. All will be output.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>expr</td><td>strvar.errput(prefix = "")</td><td> Same as errputl() but doesnt append an NL char and is BUFFERED not flushed.</td></tr>
<tr><td>expr</td><td>strvar.errput(prefix = "")</td><td> Same as errputl() but doesnt append an NL char and is BUFFERED not flushed.</td></tr>
Line 3,280: Line 3,264:
</td></tr>
</td></tr>
<tr><td></td><td>var().osflush()</td><td>Flush any and all buffered output to stdout and stdlog.
<tr><td></td><td>var().osflush()</td><td>Flush any and all buffered output to stdout and stdlog.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="p">().</span><span class="nf">osflush</span><span class="p">();</span>
<pre><code class='language-cpp'>var().osflush();
<span class="c1">// or</span>
// or
<span class="nf">osflush</span><span class="p">();</span>
osflush();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 3,302: Line 3,285:
</p>
</p>
Multibyte/UTF8 friendly.
Multibyte/UTF8 friendly.
 
<div class="highlight light"><pre><span class="c1">// var v1 = &quot;defaultvalue&quot;;</span>
<pre><code class='language-cpp'>// var v1 = "defaultvalue";
<span class="c1">// if (v1.input(&quot;Prompt:&quot;)) ... ok</span>
// if (v1.input("Prompt:")) ... ok
<span class="c1">// or</span>
// or
<span class="c1">// var v2 = input();</span>
// var v2 = input();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>expr</td><td>var.inputn(nchars)</td><td><p>Get raw bytes from standard input.
<tr><td>expr</td><td>var.inputn(nchars)</td><td><p>Get raw bytes from standard input.
Line 3,339: Line 3,321:
</p>
</p>
It only takes a few µsecs to return false if no key is pressed.
It only takes a few µsecs to return false if no key is pressed.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="p">;</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">keypressed</span><span class="p">();</span>
<pre><code class='language-cpp'>var v1; v1.keypressed();
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">keypressed</span><span class="p">();</span>
var v2 = keypressed();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>var().isterminal(arg = 1)</td><td><p>Checks if one of stdin, stdout, stderr is a terminal or a file/pipe.
<tr><td>if</td><td>var().isterminal(arg = 1)</td><td><p>Checks if one of stdin, stdout, stderr is a terminal or a file/pipe.
Line 3,354: Line 3,335:
</p>
</p>
The type of stdout terminal can be obtained from the TERM environment variable.
The type of stdout terminal can be obtained from the TERM environment variable.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">().</span><span class="nf">isterminal</span><span class="p">();</span><span class="w"> </span><span class="c1">/// 1 or 0</span>
<pre><code class='language-cpp'>var v1 = var().isterminal(); /// 1 or 0
<span class="c1">// or</span>
// or
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">isterminal</span><span class="p">();</span>
var v2 = isterminal();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>var().hasinput(milliseconds = 0)</td><td><p>Checks if stdin has any bytes available for input.
<tr><td>if</td><td>var().hasinput(milliseconds = 0)</td><td><p>Checks if stdin has any bytes available for input.
Line 3,385: Line 3,365:
<p>Automatically called in program/thread initialisation by exodus_main.
<p>Automatically called in program/thread initialisation by exodus_main.
</p>
</p>
<p>SIGINT - Ctrl+C -> "Interrupted. (C)ontinue (Q)uit (B)acktrace (D)ebug (A)bort ?"
<p>* SIGINT - Ctrl+C -> "Interrupted. (C)ontinue (Q)uit (B)acktrace (D)ebug (A)bort ?"
</p>
</p>
<p>SIGHUP - Sets a variable "RELOAD_req" which may be handled or ignored by the program.
<p>* SIGHUP - Sets a variable "RELOAD_req" which may be handled or ignored by the program.
</p>
</p>
<p>SIGTERM - Sets a variable "TERMINATE_req" which may be handled or ignored by the program.
<p>* SIGTERM - Sets a variable "TERMINATE_req" which may be handled or ignored by the program.
</p>
</p>
</td></tr>
</td></tr>
Line 3,403: Line 3,383:
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>varnum.abs()</td><td>Absolute value
<tr><td>var=</td><td>varnum.abs()</td><td>Absolute value
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">-12.34</span><span class="p">;</span>
<pre><code class='language-cpp'>let v1 = -12.34;
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">abs</span><span class="p">();</span><span class="w"> </span><span class="c1">// 12.34</span>
let v2 = v1.abs(); // 12.34
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">abs</span><span class="p">(</span><span class="n">v1</span><span class="p">);</span>
let v3 = abs(v1);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.pwr(exponent)</td><td>Power
<tr><td>var=</td><td>varnum.pwr(exponent)</td><td>Power
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">2</span><span class="p">).</span><span class="nf">pwr</span><span class="p">(</span><span class="mi">8</span><span class="p">);</span><span class="w"> </span><span class="c1">// 256</span>
<pre><code class='language-cpp'>let v1 = var(2).pwr(8); // 256
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">pwr</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">8</span><span class="p">);</span>
let v2 = pwr(2, 8);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>varnum.initrnd()</td><td><p>Initialise the seed for rnd()
<tr><td></td><td>varnum.initrnd()</td><td><p>Initialise the seed for rnd()
Line 3,422: Line 3,400:
</p>
</p>
Seeded from std::chrono::high_resolution_clock::now() if the argument is 0;
Seeded from std::chrono::high_resolution_clock::now() if the argument is 0;
 
<div class="highlight light"><pre><span class="kt">var</span><span class="p">(</span><span class="mi">123</span><span class="p">).</span><span class="nf">initrnd</span><span class="p">();</span><span class="w"> </span><span class="c1">/// Set seed to 123</span>
<pre><code class='language-cpp'>var(123).initrnd(); /// Set seed to 123
<span class="c1">// or</span>
// or
<span class="nf">initrnd</span><span class="p">(</span><span class="mi">123</span><span class="p">);</span>
initrnd(123);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.rnd()</td><td><p>Pseudo random number generator
<tr><td>var=</td><td>varnum.rnd()</td><td><p>Pseudo random number generator
Line 3,433: Line 3,410:
</p>
</p>
Uses std::mt19937 and std::uniform_int_distribution<int>
Uses std::mt19937 and std::uniform_int_distribution<int>
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">100</span><span class="p">).</span><span class="nf">rnd</span><span class="p">();</span><span class="w"> </span><span class="c1">/// Random 0 to 99</span>
<pre><code class='language-cpp'>let v1 = var(100).rnd(); /// Random 0 to 99
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">rnd</span><span class="p">(</span><span class="mi">100</span><span class="p">);</span>
let v2 = rnd(100);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.exp()</td><td>Power of e
<tr><td>var=</td><td>varnum.exp()</td><td>Power of e
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">1</span><span class="p">).</span><span class="nf">exp</span><span class="p">();</span><span class="w"> </span><span class="c1">// 2.718281828459045</span>
<pre><code class='language-cpp'>let v1 = var(1).exp(); // 2.718281828459045
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">exp</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
let v2 = exp(1);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.sqrt()</td><td>Square root
<tr><td>var=</td><td>varnum.sqrt()</td><td>Square root
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">100</span><span class="p">).</span><span class="nf">sqrt</span><span class="p">();</span><span class="w"> </span><span class="c1">// 10</span>
<pre><code class='language-cpp'>let v1 = var(100).sqrt(); // 10
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">sqrt</span><span class="p">(</span><span class="mi">100</span><span class="p">);</span>
let v2 = sqrt(100);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.sin()</td><td>Sine of degrees
<tr><td>var=</td><td>varnum.sin()</td><td>Sine of degrees
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">30</span><span class="p">).</span><span class="nf">sin</span><span class="p">();</span><span class="w"> </span><span class="c1">// 0.5</span>
<pre><code class='language-cpp'>let v1 = var(30).sin(); // 0.5
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">sin</span><span class="p">(</span><span class="mi">30</span><span class="p">);</span>
let v2 = sin(30);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.cos()</td><td>Cosine of degrees
<tr><td>var=</td><td>varnum.cos()</td><td>Cosine of degrees
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">60</span><span class="p">).</span><span class="nf">cos</span><span class="p">();</span><span class="w"> </span><span class="c1">// 0.5</span>
<pre><code class='language-cpp'>let v1 = var(60).cos(); // 0.5
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">cos</span><span class="p">(</span><span class="mi">60</span><span class="p">);</span>
let v2 = cos(60);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.tan()</td><td>Tangent of degrees
<tr><td>var=</td><td>varnum.tan()</td><td>Tangent of degrees
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">45</span><span class="p">).</span><span class="nf">tan</span><span class="p">();</span><span class="w"> </span><span class="c1">// 1</span>
<pre><code class='language-cpp'>let v1 = var(45).tan(); // 1
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">tan</span><span class="p">(</span><span class="mi">45</span><span class="p">);</span>
let v2 = tan(45);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.atan()</td><td>Arctangent of degrees
<tr><td>var=</td><td>varnum.atan()</td><td>Arctangent of degrees
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">1</span><span class="p">).</span><span class="nf">atan</span><span class="p">();</span><span class="w"> </span><span class="c1">// 45</span>
<pre><code class='language-cpp'>let v1 = var(1).atan(); // 45
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">atan</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
let v2 = atan(1);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.loge()</td><td><p>Natural logarithm
<tr><td>var=</td><td>varnum.loge()</td><td><p>Natural logarithm
</p>
</p>
<em>Returns:</em> Floating point ver (double)
<em>Returns:</em> Floating point ver (double)
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">2.718281828459045</span><span class="p">).</span><span class="nf">loge</span><span class="p">();</span><span class="w"> </span><span class="c1">// 1</span>
<pre><code class='language-cpp'>let v1 = var(2.718281828459045).loge(); // 1
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">loge</span><span class="p">(</span><span class="mf">2.718281828459045</span><span class="p">);</span>
let v2 = loge(2.718281828459045);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.integer()</td><td><p>Truncate decimal numbers towards zero
<tr><td>var=</td><td>varnum.integer()</td><td><p>Truncate decimal numbers towards zero
</p>
</p>
<em>Returns:</em> An integer var
<em>Returns:</em> An integer var
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">2.9</span><span class="p">).</span><span class="nf">integer</span><span class="p">();</span><span class="w"> </span><span class="c1">// 2</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">integer</span><span class="p">(</span><span class="mf">2.9</span><span class="p">);</span>


<pre><code class='language-cpp'>let v1 = var(2.9).integer(); // 2
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">-2.9</span><span class="p">).</span><span class="nf">integer</span><span class="p">();</span><span class="w"> </span><span class="c1">// -2</span>
// or
<span class="c1">// or</span>
let v2 = integer(2.9);
<span class="kt">var</span><span class="w"> </span><span class="n">v4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">integer</span><span class="p">(</span><span class="mf">-2.9</span><span class="p">);</span>
 
</pre></div>
var v3 = var(-2.9).integer(); // -2
// or
var v4 = integer(-2.9);</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.floor()</td><td><p>Truncate decimal numbers towards negative
<tr><td>var=</td><td>varnum.floor()</td><td><p>Truncate decimal numbers towards negative
</p>
</p>
<em>Returns:</em> An integer var
<em>Returns:</em> An integer var
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">2.9</span><span class="p">).</span><span class="nf">floor</span><span class="p">();</span><span class="w"> </span><span class="c1">// 2</span>
<span class="c1">// or</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">floor</span><span class="p">(</span><span class="mf">2.9</span><span class="p">);</span>


<pre><code class='language-cpp'>let v1 = var(2.9).floor(); // 2
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mf">-2.9</span><span class="p">).</span><span class="nf">floor</span><span class="p">();</span><span class="w"> </span><span class="c1">// -3</span>
// or
<span class="c1">// or</span>
let v2 = floor(2.9);
<span class="kt">var</span><span class="w"> </span><span class="n">v4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">floor</span><span class="p">(</span><span class="mf">-2.9</span><span class="p">);</span>
 
</pre></div>
var v3 = var(-2.9).floor(); // -3
// or
var v4 = floor(-2.9);</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.mod(modulus)</td><td><p>Modulus function
<tr><td>var=</td><td>varnum.mod(modulus)</td><td><p>Modulus function
Line 3,529: Line 3,496:
</p>
</p>
Floating point works.
Floating point works.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">11</span><span class="p">).</span><span class="nf">mod</span><span class="p">(</span><span class="mi">5</span><span class="p">);</span><span class="w"> </span><span class="c1">// 1</span>
<pre><code class='language-cpp'>let v1 = var(11).mod(5); // 1
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">mod</span><span class="p">(</span><span class="mi">11</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="p">);</span><span class="w"> </span><span class="c1">// 1</span>
let v2 = mod(11, 5); // 1
<span class="nf">let</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">mod</span><span class="p">(</span><span class="mi">-11</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="p">);</span><span class="w"> </span><span class="c1">// 4</span>
let v3 = mod(-11, 5); // 4
<span class="nf">let</span><span class="w"> </span><span class="n">v4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">mod</span><span class="p">(</span><span class="mi">11</span><span class="p">,</span><span class="w"> </span><span class="mi">-5</span><span class="p">);</span><span class="w"> </span><span class="c1">// -4</span>
let v4 = mod(11, -5); // -4
<span class="nf">let</span><span class="w"> </span><span class="n">v5</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">mod</span><span class="p">(</span><span class="mi">-11</span><span class="p">,</span><span class="w"> </span><span class="mi">-5</span><span class="p">);</span><span class="w"> </span><span class="c1">// -1</span>
let v5 = mod(-11, -5); // -1</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>int=</td><td>var::setprecision(newprecision)</td><td><p>Set the maximum floating point precision.
<tr><td>int=</td><td>var::setprecision(newprecision)</td><td><p>Set the maximum floating point precision.
Line 3,557: Line 3,523:
</p>
</p>
See cli/demo_precision for more info.
See cli/demo_precision for more info.
 
<div class="highlight light"><pre><span class="n">assert</span><span class="p">(</span><span class="mf">0.000001</span><span class="kt">_var</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span><span class="w"> </span><span class="c1">/// NOTE WELL: Default precision 4.</span>
<pre><code class='language-cpp'>assert(0.000001_var == 0); /// NOTE WELL: Default precision 4.
<span class="nf">let</span><span class="w"> </span><span class="n">new_precision1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">setprecision</span><span class="p">(</span><span class="mi">6</span><span class="p">);</span><span class="w"> </span><span class="c1">// 6 // Increase the precision.</span>
let new_precision1 = var::setprecision(6); // 6 // Increase the precision.
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">new_precision2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">setprecision</span><span class="p">(</span><span class="mi">6</span><span class="p">);</span>
let new_precision2 = setprecision(6);
<span class="n">assert</span><span class="p">(</span><span class="mf">0.000001</span><span class="kt">_var</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span><span class="w"> </span><span class="c1">/// NOTE: Precision 6.</span>
assert(0.000001_var != 0); /// NOTE: Precision 6.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>int=</td><td>var::getprecision()</td><td>
<tr><td>int=</td><td>var::getprecision()</td><td>
Line 3,569: Line 3,534:
</p>
</p>
See setprecision() for more info.
See setprecision() for more info.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">curr_precision1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="o">::</span><span class="nf">getprecision</span><span class="p">();</span>
<pre><code class='language-cpp'>let curr_precision1 = var::getprecision();
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">curr_precision2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">getprecision</span><span class="p">();</span>
let curr_precision2 = getprecision();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 3,584: Line 3,548:
<p><em>Returns:</em> Human readable date or calendar info, or the original value unconverted if non-numeric.
<p><em>Returns:</em> Human readable date or calendar info, or the original value unconverted if non-numeric.
</p>
</p>
<p><em>Flags:</em> See examples below.
<p><em>flags:</em> See examples below.
</p>
</p>
Any Dynamic array structure is preserved.
Any Dynamic array structure is preserved.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">19002</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="p">;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;D&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;09 JAN 2020&quot;  // Default</span>


<pre><code class='language-cpp'>let v1 = 19002;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;D/&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;01/09/2020&quot;   // mm/dd/yyyy - American numeric</span>
var v2;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;D-&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;01-09-2020&quot;    // mm-dd-yyyy - American numeric</span>
v2 =  v1.oconv( "D"   ) ; //  "09 JAN 2020// Default


v2 =  v1.oconv( "D/" ) ; // "01/09/2020"   // mm/dd/yyyy - American numeric
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;D/E&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">// &quot;09/01/2020&quot;   // dd/mm/yyyy - International numeric</span>
v2 =  v1.oconv( "D-" ) ; //  "01-09-2020"   // mm-dd-yyyy - American numeric
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;D-E&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;09-01-2020&quot;   // dd-mm-yyyy - International numeric</span>


v2 =  v1.oconv( "D/E" ) ; // "09/01/2020"   // dd/mm/yyyy - International numeric
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;D2&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">// &quot;09 JAN 20&quot;    // 2 digit year</span>
v2 =  v1.oconv( "D-E" ) ; //  "09-01-2020"    // dd-mm-yyyy - International numeric
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;D0&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;09 JAN&quot;        // No year</span>


v2 =  v1.oconv( "D2"  ) ; //  "09 JAN 20"    // 2 digit year
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DS&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;2020 JAN 09&quot;  // yyyy mmm dd - ISO year first, alpha month</span>
v2 =  v1.oconv( "D0" ) ; //  "09 JAN"        // No year
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DS-&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;2020-01-09&quot;    // yyyy-mm-dd  - ISO year first, numeric month</span>


v2 =  v1.oconv( "DS"  ) ; //  "2020 JAN 09"   // yyyy mmm dd - ISO year first, alpha month
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DZ&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot; 9 JAN 2020&quot;  // Leading 0 become spaces</span>
v2 =  v1.oconv( "DS-" ) ; // "2020-01-09"   // yyyy-mm-dd - ISO year first, numeric month
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DZZ&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;9 JAN 2020&quot;    // Leading 0 are suppressed</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;D!&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;09JAN2020&quot;    // No separators</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DS-!&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;20200109&quot;      // yyyymmdd packed</span>


v2 =  v1.oconv( "DZ"  ) ; //  " 9 JAN 2020"   // Leading 0 become spaces
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DM&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;1&quot;            // Month number</span>
v2 =  v1.oconv( "DZZ" ) ; //  "9 JAN 2020"   // Leading 0 are suppressed
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DMA&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;JANUARY&quot;      // Month name</span>
v2 =  v1.oconv( "D!"  ) ; //  "09JAN2020"     // No separators
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DY&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;2020&quot;          // Year number</span>
v2 =  v1.oconv( "DS-!") ; // "20200109"     // yyyymmdd packed
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DY2&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;20&quot;            // Year 2 digits</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DD&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">// &quot;9&quot;            // Day number in month (1-31)</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DW&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;4&quot;            // Weekday number (1-7)</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DWA&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">// &quot;THURSDAY&quot;      // Weekday name</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;</span><span class="kc">DQ</span><span class="s">&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;1&quot;             // Quarter number</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DJ&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;9&quot;            // Day number in year</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;DL&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;31&quot;            // Last day number of month (28-31)</span>


v2 = v1.oconv( "DM" ) ; // "1"            // Month number
<span class="c1">// Dynamic array</span>
v2 = v1.oconv( "DMA" ) ; /"JANUARY"       // Month name
<span class="nf">let</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;12345^12346]12347&quot;</span><span class="kt">_var</span><span class="p">;</span>
v2 = v1.oconv( "DY" ) ; /"2020"         // Year number
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v3</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;D&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;18 OCT 2001^19 OCT 2001]20 OCT 2001&quot;_var</span>
v2 = v1.oconv( "DY2" ) ; /"20"           // Year 2 digits
v2 = v1.oconv( "DD" ) ; // "9"             // Day number in month (1-31)
v2 = v1.oconv( "DW" ) ; /"4"             // Weekday number (1-7)
v2 = v1.oconv( "DWA" ) ; /"THURSDAY"     // Weekday name
v2 = v1.oconv( "DQ" ) ; /"1"             // Quarter number
v2 = v1.oconv( "DJ" ) ; /"9"             // Day number in year
v2 = v1.oconv( "DL" ) ; /"31"           // Last day number of month (28-31)
 
// Dynamic array
let v3 = "12345^12346]12347"_var;
v2 = v3.oconv("D") ; //  "18 OCT 2001^19 OCT 2001]20 OCT 2001"_var
 
// or
v2 =  oconv(v3, "D"  ) ;</code></pre>


<span class="w"> </span><span class="c1">// or</span>
<span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="nf">oconv</span><span class="p">(</span><span class="n">v3</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;D&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.iconv("D")</td><td><p>Date input: Convert human readable date to internal date format.
<tr><td>var=</td><td>strvar.iconv("D")</td><td><p>Date input: Convert human readable date to internal date format.
Line 3,635: Line 3,598:
</p>
</p>
Any Dynamic array structure is preserved.
Any Dynamic array structure is preserved.
<div class="highlight light"><pre><span class="c1">// International order &quot;DE&quot;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="p">;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">            </span><span class="nf">oconv</span><span class="p">(</span><span class="mi">19005</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;12 JAN 2020&quot;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">    </span><span class="s">&quot;12/1/2020&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19005</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">    </span><span class="s">&quot;12 1 2020&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19005</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">    </span><span class="s">&quot;12-1-2020&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19005</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="s">&quot;12 JAN 2020&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19005</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="s">&quot;jan 12 2020&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19005</span>


<pre><code class='language-cpp'>// International order "DE"
<span class="c1">// American order &quot;D&quot;</span>
var v2;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">             </span><span class="nf">oconv</span><span class="p">(</span><span class="mi">19329</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;D&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;01 DEC 2020&quot;</span>
v2 =            oconv(19005, "DE") ; //  "12 JAN 2020"
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">   </span><span class="s">&quot;12/1/2020&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;D&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19329</span>
v2 =    "12/1/2020"_var.iconv("DE") ; //  19005
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="s">&quot;DEC 1 2020&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;D&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19329</span>
v2 =   "12 1 2020"_var.iconv("DE") ; //  19005
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="s">&quot;1 dec 2020&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;D&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19329</span>
v2 =   "12-1-2020"_var.iconv("DE") ; // 19005
v2 = "12 JAN 2020"_var.iconv("DE") ; //  19005
v2 = "jan 12 2020"_var.iconv("DE") ; //  19005


// American order "D"
<span class="c1">// Reverse order</span>
v2 =             oconv(19329, "D") ; // "01 DEC 2020"
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="s">&quot;2020/12/1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19329</span>
v2 =   "12/1/2020"_var.iconv("D") ; //  19329
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">    </span><span class="s">&quot;2020-12-1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;D&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19329</span>
v2 =   "DEC 1 2020"_var.iconv("D") ; //  19329
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">   </span><span class="s">&quot;2020 1 dec&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;D&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19329</span>
v2 =  "1 dec 2020"_var.iconv("D") ; //  19329


// Reverse order
<span class="c1">//Invalid date</span>
v2 =   "2020/12/1"_var.iconv("DE") ; // 19329
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">    </span><span class="s">&quot;2/29/2021&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;D&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;&quot;</span>
v2 =   "2020-12-1"_var.iconv("D") ; //  19329
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="s">&quot;29/2/2021&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;&quot;</span>
v2 =   "2020 1 dec"_var.iconv("D") ; //  19329
 
//Invalid date
v2 =   "2/29/2021"_var.iconv("D") ; /""
v2 =   "29/2/2021"_var.iconv("DE") ; // ""
 
// or
v2 = iconv("12/1/2020"_var, "DE") ; //  19005</code></pre>


<span class="c1">// or</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;12/1/2020&quot;</span><span class="kt">_var</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;DE&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  19005</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>vartime.oconv("MT")</td><td><p>Time output: Convert internal time format to human readable time e.g. "10:30:59".
<tr><td>var=</td><td>vartime.oconv("MT")</td><td><p>Time output: Convert internal time format to human readable time e.g. "10:30:59".
Line 3,670: Line 3,632:
<p>Conversion code (e.g. "MTHS") is "MT" + flags ...
<p>Conversion code (e.g. "MTHS") is "MT" + flags ...
</p>
</p>
<p><em>Flags:</em>
<p><em>flags:</em>
</p>
</p>
<p>"H" - Show AM/PM otherwise 24 hour clock is used.
<p>* "H" - Show AM/PM otherwise 24 hour clock is used.
</p>
</p>
<p>"S" - Output seconds
<p>* "S" - Output seconds
</p>
</p>
<p>"2" = Ignored (used in iconv)
<p>* "2" = Ignored (used in iconv)
</p>
</p>
<p>":" - Any other flag is used as the separator char instead of ":"
<p>* ":" - Any other flag is used as the separator char instead of ":"
</p>
</p>
Any Dynamic array structure is preserved.
Any Dynamic array structure is preserved.
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w">  </span><span class="o">=</span><span class="w"> </span><span class="mi">62000</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="p">;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MT&quot;</span><span class="w">  </span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;17:13&quot;      // Default</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MTH&quot;</span><span class="w"> </span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;05:13PM&quot;    // &#39;H&#39; flag for AM/PM</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MTS&quot;</span><span class="w"> </span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;17:13:20&quot;  // &#39;S&#39; flag for seconds</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MTHS&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;05:13:20PM&quot; // Both flags</span>


<pre><code class='language-cpp'>let v1  = 62000;
<span class="nf">let</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
var v2;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v3</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MT&quot;</span><span class="w">  </span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;00:00&quot;</span>
v2 = v1.oconv("MT); // "17:13"     // Default
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v3</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MTH&quot;</span><span class="w"> </span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;12:00AM&quot;</span>
v2 = v1.oconv("MTH" ); // "05:13PM"   // 'H' flag for AM/PM
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v3</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MTS&quot;</span><span class="w"> </span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;00:00:00&quot;</span>
v2 = v1.oconv("MTS" ); // "17:13:20"   // 'S' flag for seconds
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v3</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MTHS&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;12:00:00AM&quot;</span>
v2 = v1.oconv("MTHS"); // "05:13:20PM" // Both flags
 
let v3  = 0;
v2 = v3.oconv("MT" ); // "00:00"
v2 = v3.oconv("MTH" ); // "12:00AM"
v2 = v3.oconv("MTS" ); // "00:00:00"
v2 = v3.oconv("MTHS"); // "12:00:00AM"
 
// Dynamic array
let v4  = "61980^62040]62100"_var;
v2 = v4.oconv("MT");   // "17:13^17:14]17:15"_var


// or
<span class="c1">// Dynamic array</span>
v2 = oconv(v1, "MT");    // "17:13"</code></pre>
<span class="nf">let</span><span class="w"> </span><span class="n">v4</span><span class="w">  </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;61980^62040]62100&quot;</span><span class="kt">_var</span><span class="p">;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v4</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MT&quot;</span><span class="p">);</span><span class="w">   </span><span class="c1">// &quot;17:13^17:14]17:15&quot;_var</span>


<span class="c1">// or</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oconv</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="p">);</span><span class="w">    </span><span class="c1">// &quot;17:13&quot;</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.iconv("MT")</td><td><p>Time input: Convert human readable time (e.g. "10:30:59") to internal time format.
<tr><td>var=</td><td>strvar.iconv("MT")</td><td><p>Time input: Convert human readable time (e.g. "10:30:59") to internal time format.
Line 3,712: Line 3,673:
</p>
</p>
Any Dynamic array structure is preserved.
Any Dynamic array structure is preserved.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="p">;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="s">&quot;17:13&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  61980</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">    </span><span class="s">&quot;05:13PM&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  61980</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">    </span><span class="s">&quot;17:13:20&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  62000</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="s">&quot;05:13:20PM&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  62000</span>


<pre><code class='language-cpp'>var v2;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="s">&quot;00:00&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  0</span>
v2 =       "17:13"_var.iconv( "MT" ) ; //  61980
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">    </span><span class="s">&quot;12:00AM&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  0    // Midnight</span>
v2 =    "05:13PM"_var.iconv( "MT" ) ; //  61980
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">     </span><span class="s">&quot;12:00PM&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  43200 // Noon</span>
v2 =    "17:13:20"_var.iconv( "MT" ) ; //  62000
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">   </span><span class="s">&quot;00:00:00&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  0</span>
v2 =  "05:13:20PM"_var.iconv( "MT" ) ; //  62000
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;12:00:00AM&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  0</span>


v2 =       "00:00"_var.iconv( "MT" ) ; // 0
<span class="c1">// Dynamic array</span>
v2 =     "12:00AM"_var.iconv( "MT" ) ; //  0    // Midnight
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;17:13^05:13PM]17:13:20&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;MT&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;61980^61980]62000&quot;_var</span>
v2 =     "12:00PM"_var.iconv( "MT" ) ; //  43200 // Noon
v2 =   "00:00:00"_var.iconv( "MT" ) ; //  0
v2 = "12:00:00AM"_var.iconv( "MT" ) ; //  0
 
// Dynamic array
v2 = "17:13^05:13PM]17:13:20"_var.iconv("MT") ; // "61980^61980]62000"_var
 
// or
v2 = iconv("17:13", "MT") ; //  61980</code></pre>


<span class="c1">// or</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;17:13&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;MT&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  61980</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.oconv("MD")</td><td><p>Number output: Convert internal numbers to external text format after rounding and optional scaling.
<tr><td>var=</td><td>varnum.oconv("MD")</td><td><p>Number output: Convert internal numbers to external text format after rounding and optional scaling.
Line 3,736: Line 3,696:
<p><em>Returns:</em> A string or, if the value is not numeric, then no conversion is performed and the original value is returned.
<p><em>Returns:</em> A string or, if the value is not numeric, then no conversion is performed and the original value is returned.
</p>
</p>
<p>Conversion code (e.g. "MD20") is "MD" or "MC", 1st digit, 2nd digit, flags ...
<p><em>conversion_code:</em> (e.g. "MD20Z") is "MD" or "MC", 1st digit, 2nd digit, flags ...
</p>
</p>
 
<p>* MD outputs like 123.45 (International)
<p>MD outputs like 123.45 (International)
</p>
</p>
<p>MC outputs like 123,45 (European)
<p>* MC outputs like 123,45 (European)
</p>
</p>
 
<p>* 1st digit = Decimal places to display. Also decimal places to move if 2nd digit not present and no P flag present.
<p>1st digit = Decimal places to display. Also decimal places to move if 2nd digit not present and no P flag present.
</p>
</p>
<p>2nd digit = Optional decimal places to move left if P flag not present.
<p>* 2nd digit = Optional decimal places to move left if P flag not present.
</p>
</p>


<p><em>Flags:</em>
<p><em>flags:</em>
</p>
</p>
<p>"P" - Preserve decimal places. Same as 2nd digit = 0;
<p>* "P" - Preserve decimal places. Same as 2nd digit = 0;
</p>
</p>
<p>"Z" - Zero flag - return "" if zero.
<p>* "Z" - Zero flag - return "" if zero.
</p>
</p>
<p>"X" - No conversion - return as is.
<p>* "X" - No conversion - return as is.
</p>
</p>
<p>"." or "," - Separate thousands depending on MD or MC.
<p>* "." or "," - Separate thousands depending on MD or MC.
</p>
</p>
<p>"-" means suffix negatives with "-" and positives with " " (space).
<p>* "-" means suffix negatives with "-" and positives with " " (space).
</p>
</p>
<p>"<" means wrap negatives in "<" and ">" chars.
<p>* "<" means wrap negatives in "<" and ">" chars.
</p>
</p>
<p>"C" means suffix negatives with "CR" and positives or zero with "DB".
<p>* "C" means suffix negatives with "CR" and positives or zero with "DB".
</p>
</p>
<p>"D" means suffix negatives with "DB" and positives or zero with "CR".
<p>* "D" means suffix negatives with "DB" and positives or zero with "CR".
</p>
</p>


  Any Dynamic array structure is preserved.
  Any Dynamic array structure is preserved.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">-1234.567</span><span class="p">;</span>
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="p">;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MD20&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;-1234.57&quot;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MD20,&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;-1,234.57&quot;    // , flag</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MC20,&quot;</span><span class="w">  </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;-1.234,57&quot;    // MC code</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MD20,-&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;1,234.57-&quot;  // - flag</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MD20,&lt;&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;&lt;1,234.57&gt;&quot;  // &lt; flag</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MD20,C&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;1,234.57CR&quot;  // C flag</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MD20,D&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;1,234.57DB&quot;  // D flag</span>


<pre><code class='language-cpp'>var v1 = -1234.567;
<span class="c1">// Dynamic array</span>
var v2;
<span class="kt">var</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;1.1^2.1]2.2&quot;</span><span class="kt">_var</span><span class="p">;</span>
v2 = v1.oconv( "MD20"   ) ; //   "-1234.57"
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v3</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;MD20&quot;</span><span class="w">   </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">// &quot;1.10^2.10]2.20&quot;_var</span>
v2 = v1.oconv( "MD20," ) ; /"-1,234.57"   // , flag
v2 = v1.oconv( "MC20," ) ; //  "-1.234,57"   // MC code
v2 = v1.oconv( "MD20,-" ) ; /"1,234.57-"  // - flag
v2 = v1.oconv( "MD20,<" ) ; /"<1,234.57>"  // < flag
v2 = v1.oconv( "MD20,C" ) ; /"1,234.57CR" // C flag
v2 = v1.oconv( "MD20,D" ) ; //   "1,234.57DB"  // D flag


// Dynamic array
<span class="c1">// or</span>
var v3 = "1.1^2.1]2.2"_var;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oconv</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;MD20&quot;</span><span class="w">   </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;-1234.57&quot;   </span>
v2 = v3.oconv( "MD20"   ) ; //  "1.10^2.10]2.20"_var
</pre></div></td></tr>
 
// or
v2 = oconv(v1, "MD20"  ) ; //  "-1234.57"   </code></pre>
</td></tr>
<tr><td>var=</td><td>var.oconv("LRC")</td><td><p>Text justification: Left, right and center. Padding and truncating. See Procrustes.
<tr><td>var=</td><td>var.oconv("LRC")</td><td><p>Text justification: Left, right and center. Padding and truncating. See Procrustes.
</p>
</p>
Line 3,796: Line 3,753:
</p>
</p>
ASCII only.
ASCII only.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="p">;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="s">&quot;abcde&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;L#3&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;abc&quot;  // Truncating</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="s">&quot;abcde&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;R#3&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;cde&quot;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="s">&quot;abcde&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;C#3&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;abc&quot;</span>


<pre><code class='language-cpp'>var v2;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="s">&quot;ab&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;L#6&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;ab␣␣␣␣&quot; // Padding</span>
v2 =     "abcde"_var.oconv( "L#3" ) ; // "abc"  // Truncating
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">     </span><span class="s">&quot;ab&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;R#6&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;␣␣␣␣ab&quot;</span>
v2 =      "abcde"_var.oconv( "R#3" ) ; //  "cde"
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">     </span><span class="s">&quot;ab&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;C#6&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;␣␣ab␣␣&quot;</span>
v2 =      "abcde"_var.oconv( "C#3" ) ; // "abc"


v2 =     "ab"_var.oconv( "L#6" ) ; // "ab␣␣␣␣"  // Padding
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="kt">var</span><span class="p">(</span><span class="mi">42</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;L(0)#5&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;42000&quot; // Padding char (x)</span>
v2 =     "ab"_var.oconv( "R#6" ) ; //  "␣␣␣␣ab"
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="kt">var</span><span class="p">(</span><span class="mi">42</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;R(0)#5&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;00042&quot;</span>
v2 =     "ab"_var.oconv( "C#6" ) ; // "␣␣ab␣␣"
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="kt">var</span><span class="p">(</span><span class="mi">42</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;C(0)#5&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;04200&quot;</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="kt">var</span><span class="p">(</span><span class="mi">42</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;C(0)#5&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;04200&quot;</span>


v2 =       var(42).oconv( "L(0)#5" ) ; // "42000" // Padding char (x)
<span class="c1">// Dynamic array</span>
v2 =      var(42).oconv( "R(0)#5" ) ; // "00042"
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">       </span><span class="s">&quot;f1^v1]v2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;L(_)#5&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;f1___^v1___]v2___&quot;_var</span>
v2 =       var(42).oconv( "C(0)#5" ) ; /"04200"
v2 =       var(42).oconv( "C(0)#5" ) ; // "04200"


// Dynamic array
<span class="c1">// Fail for non-ASCII (Should be 5)</span>
v2 =       "f1^v1]v2"_var.oconv("L(_)#5") ; //  "f1___^v1___]v2___"_var
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">     </span><span class="s">&quot;🐱&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;L#5&quot;</span><span class="p">).</span><span class="nf">textwidth</span><span class="p">()</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  3</span>
 
// Fail for non-ASCII (Should be 5)
v2 =      "🐱"_var.oconv("L#5").textwidth() ; //  3
 
// or
v2 =     oconv("abcd", "L#3" ) ; /"abc" </code></pre>


<span class="c1">// or</span>
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">      </span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;abcd&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;L#3&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;abc&quot; </span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.oconv("T")</td><td><p>Text folding and justification.
<tr><td>var=</td><td>strvar.oconv("T")</td><td><p>Text folding and justification.
Line 3,830: Line 3,786:
</p>
</p>
ASCII only.
ASCII only.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Have a nice day&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let v1 = "Have a nice day";
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;T#10&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;Have a␣␣␣␣|nice day␣␣&quot;_var</span>
let v2 = v1.oconv("T#10") ; //  "Have a␣␣␣␣|nice day␣␣"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oconv</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;T#10&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;Have a␣␣␣␣|nice day␣␣&quot;_var </span>
let v3  = oconv(v1, "T#10") ; //  "Have a␣␣␣␣|nice day␣␣"_var </code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>expr</td><td>varnum.oconv("MR")</td><td><p>Character replacement
<tr><td>expr</td><td>varnum.oconv("MR")</td><td><p>Character replacement
</p>
</p>
e.g. MRU
e.g. MRU
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;123/abC.&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let v1 = "123/abC.";
<span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="p">;</span>
var v2;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MRL&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;123/abc.&quot; // lcase</span>
v2 = v1.oconv("MRL") ; //  "123/abc." // lcase
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MRU&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;123/ABC.&quot; // ucase</span>
v2 = v1.oconv("MRU") ; //  "123/ABC." // ucase
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MRT&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;123/Abc.&quot; // tcase</span>
v2 = v1.oconv("MRT") ; //  "123/Abc." // tcase
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MRN&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;123&quot;     // Return only digits</span>
v2 = v1.oconv("MRN") ; //  "123"     // Return only digits
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MRA&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;abC&quot;     // Return only alphabetic</span>
v2 = v1.oconv("MRA") ; //  "abC"     // Return only alphabetic
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MRB&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;123abC&quot;   // Return only alphanumeric</span>
v2 = v1.oconv("MRB") ; //  "123abC"   // Return only alphanumeric
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MR/N&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;/abC.&quot;   // Remove digits</span>
v2 = v1.oconv("MR/N") ; //  "/abC."   // Remove digits
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MR/A&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;123/.&quot;   // Remove alphabetic</span>
v2 = v1.oconv("MR/A") ; //  "123/."   // Remove alphabetic
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">v1</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MR/B&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;/.&quot;     // Remove alphanumeric</span>
v2 = v1.oconv("MR/B") ; //  "/."     // Remove alphanumeric</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.oconv("HEX")</td><td><p>Convert the chars of a string to a string of pairs of hexadecimal digits.
<tr><td>var=</td><td>strvar.oconv("HEX")</td><td><p>Convert the chars of a string to a string of pairs of hexadecimal digits.
Line 3,863: Line 3,817:
</p>
</p>
This function is the exact inverse of iconv("HEX").
This function is the exact inverse of iconv("HEX").
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v2</span><span class="p">;</span>
<pre><code class='language-cpp'>var v2;
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">     </span><span class="s">&quot;ab01&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;HEX&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;61&quot; &quot;62&quot; &quot;30&quot; &quot;31&quot;</span>
v2 =      "ab01"_var.oconv( "HEX" ) ; //  "61" "62" "30" "31"
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">  </span><span class="s">&quot;</span><span class="se">\xff\x00</span><span class="s">&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;HEX&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;FF&quot; &quot;00&quot;           // Any bytes are ok.</span>
v2 = "\xff\x00"_var.oconv( "HEX" ) ; //  "FF" "00"           // Any bytes are ok.
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">         </span><span class="kt">var</span><span class="p">(</span><span class="mi">10</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;HEX&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;31&quot; &quot;30&quot;           // Uses ASCII string equivalent of 10 i.e. &quot;10&quot;.</span>
v2 =        var(10).oconv( "HEX" ) ; //  "31" "30"           // Uses ASCII string equivalent of 10 i.e. "10".
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">   </span><span class="s">&quot;</span><span class="se">\u0393</span><span class="s">&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;HEX&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;CE&quot; &quot;93&quot;           // Greek capital Gamma in UTF8 bytes.</span>
v2 =    "\u0393"_var.oconv( "HEX" ) ; //  "CE" "93"           // Greek capital Gamma in UTF8 bytes.
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">     </span><span class="s">&quot;a^]b&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="w"> </span><span class="s">&quot;HEX&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;61&quot; &quot;1E&quot; &quot;1D&quot; &quot;62&quot; // Field and value marks.</span>
v2 =      "a^]b"_var.oconv( "HEX" ) ; // "61" "1E" "1D" "62" // Field and value marks.
<span class="c1">// or</span>
// or
<span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w">       </span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;ab01&quot;</span><span class="kt">_var</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;HEX&quot;</span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="c1">//  &quot;61&quot; &quot;62&quot; &quot;30&quot; &quot;31&quot;</span>
v2 =      oconv("ab01"_var, "HEX") ; // "61" "62" "30" "31"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.iconv("HEX")</td><td><p>Convert a string of pairs of hexadecimal digits to a string of chars.
<tr><td>var=</td><td>strvar.iconv("HEX")</td><td><p>Convert a string of pairs of hexadecimal digits to a string of chars.
Line 3,889: Line 3,842:
<tr><td>var=</td><td>varnum.oconv("MX")</td><td><p>Convert number to hexadecimal string.
<tr><td>var=</td><td>varnum.oconv("MX")</td><td><p>Convert number to hexadecimal string.
</p>
</p>
<p>"MX":  Convert and trim leading zeros                      e.g. oconv(1025, "MX")  -> "401"
<p>* "MX":  Convert and trim leading zeros                      e.g. oconv(1025, "MX")  -> "401"
</p>
</p>
<p>"MXn":  Pad with up to n leading zeros but do not truncate. e.g. oconv(1025, "MX8") -> "00000401"
<p>* "MXn":  Pad with up to n leading zeros but do not truncate. e.g. oconv(1025, "MX8") -> "00000401"
</p>
</p>
<p>"MXnT": Pad and truncate to n characters.                  e.g. oconv(1025, "MX2") -> "01"
<p>* "MXnT": Pad and truncate to n characters.                  e.g. oconv(1025, "MX2") -> "01"
</p>
</p>
<p>"n":    Width. 0-9, A-G = 10 - 16.
<p>"n":    Width. 0-9, A-G = 10 - 16.
Line 3,905: Line 3,858:
<p>Negative numbers are treated as unsigned 8 byte integers (uint64).
<p>Negative numbers are treated as unsigned 8 byte integers (uint64).
</p>
</p>
<p>0  -> "00"
<p>* 0  -> "00"
</p>
</p>
<p>1  -> "01"
<p>* 1  -> "01"
</p>
</p>
<p>15 -> "0F"
<p>* 15 -> "0F"
</p>
</p>
<p>-1 -> "FFFF" "FFFF" "FFFF" "FFFF" (8 x "FF")
<p>* -1 -> "FFFF" "FFFF" "FFFF" "FFFF" (8 x "FF")
</p>
</p>
This function is a near inverse of iconv("MX").
This function is a near inverse of iconv("MX").
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;14.5]QQ]65535&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MX&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;F]QQ]FFFF&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "14.5]QQ]65535"_var.oconv("MX"); // "F]QQ]FFFF"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;14.5]QQ]65535&quot;</span><span class="kt">_var</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;MX&quot;</span><span class="p">);</span>
let v2 = oconv("14.5]QQ]65535"_var, "MX");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.iconv("MX")</td><td><p>Convert hexadecimal string to number.
<tr><td>var=</td><td>strvar.iconv("MX")</td><td><p>Convert hexadecimal string to number.
Line 3,932: Line 3,884:
<p>Leading zeros are ignored.
<p>Leading zeros are ignored.
</p>
</p>
<p>"0" -> 0
<p>* "0" -> 0
</p>
</p>
<p>"00"-> 0
<p>* "00"-> 0
</p>
</p>
<p>"1" -> 1
<p>* "1" -> 1
</p>
</p>
<p>Hex "FFFFFFFFFFFFFFFF" (8 x "FF") -> -1.
<p>* Hex "FFFFFFFFFFFFFFFF" (8 x "FF") -> -1.
</p>
</p>
<p>Hex "7FFFFFFFFFFFFFFF" is the maximum positive integer: 9223372036854775805.
<p>* Hex "7FFFFFFFFFFFFFFF" is the maximum positive integer: 9223372036854775805.
</p>
</p>
<p>Hex "8000000000000000" is the maximum negative integer: -9223372036854775808.
<p>* Hex "8000000000000000" is the maximum negative integer: -9223372036854775808.
</p>
</p>
This function is the exact inverse of oconv("MX").
This function is the exact inverse of oconv("MX").
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;F]QQ]FFFF&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;MX&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;15]]65535&quot;_var</span>
<pre><code class='language-cpp'>let v1 = "F]QQ]FFFF"_var.iconv("MX"); // "15]]65535"_var
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;F]QQ]FFFF&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;MX&quot;</span><span class="p">);</span>
let v2 = iconv("F]QQ]FFFF", "MX");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.oconv("MB")</td><td><p>Number to binary format: Convert number to strings of 1s and 0s
<tr><td>var=</td><td>varnum.oconv("MB")</td><td><p>Number to binary format: Convert number to strings of 1s and 0s
</p>
</p>
<em>varnum:</em> If not numeric then no conversion is performed and the original value is returned.
<em>varnum:</em> If not numeric then no conversion is performed and the original value is returned.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="mi">255</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;MB&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// 1111&#39;1111</span>
<pre><code class='language-cpp'>let v1 = var(255).oconv("MB"); // 1111'1111
<span class="c1">// or</span>
// or
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oconv</span><span class="p">(</span><span class="mi">255</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;MB&quot;</span><span class="p">);</span>
let v2 = oconv(255, "MB");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.oconv("TX")</td><td><p>Convert dynamic arrays to standard text format.
<tr><td>var=</td><td>strvar.oconv("TX")</td><td><p>Convert dynamic arrays to standard text format.
</p>
</p>
Line 3,971: Line 3,921:
</p>
</p>
etc.
etc.
<div class="highlight light"><pre><span class="c1">// 1. Backslash in text remains backslash</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="kc">_BS</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;TX&quot;</span><span class="p">);</span><span class="w">    </span><span class="c1">// _BS</span>


<pre><code class='language-cpp'>// 1. Backslash in text remains backslash
<span class="c1">// 2. Literal &quot;\n&quot; -&gt; literal &quot;\\n&quot; (Double escape any escaped NL chars)</span>
let v1 = var(_BS).oconv("TX");    // _BS
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="kc">_BS</span><span class="w"> </span><span class="s">&quot;n&quot;</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;TX&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// _BS _BS &quot;n&quot;</span>
 
// 2. Literal "\n" -> literal "\\n" (Double escape any escaped NL chars)
let v2 = var(_BS "n").oconv("TX"); // _BS _BS "n"
 
// 3. \n becomes literal "\n" (Single escape any NL chars)
let v3 = var(_NL).oconv("TX");     // _BS "n"


// 4. FM -> \n
<span class="c1">// 3. \n becomes literal &quot;\n&quot; (Single escape any NL chars)</span>
let v4 = "f1^f2"_var.oconv("TX"); // "f1" _NL "f2"
<span class="nf">let</span><span class="w"> </span><span class="n">v3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kt">var</span><span class="p">(</span><span class="kc">_NL</span><span class="p">).</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;TX&quot;</span><span class="p">);</span><span class="w">    </span><span class="c1">// _BS &quot;n&quot;</span>


// 5. VM -> "\" \n
<span class="c1">// 4. FM -&gt; \n</span>
let v5 = "v1]v2"_var.oconv("TX");  // "v1" _BS _NL "v2"
<span class="nf">let</span><span class="w"> </span><span class="n">v4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^f2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;TX&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;f1&quot; _NL &quot;f2&quot;</span>


// 6. SM -> "\\" \n
<span class="c1">// 5. VM -&gt; &quot;\&quot; \n</span>
let v6 = "s1}s2"_var.oconv("TX");  // "s1" _BS _BS _NL "s2"
<span class="nf">let</span><span class="w"> </span><span class="n">v5</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;v1]v2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;TX&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;v1&quot; _BS _NL &quot;v2&quot;</span>


// 7. TM -> "\\\" \n
<span class="c1">// 6. SM -&gt; &quot;\\&quot; \n</span>
let v7 = "t1|t2"_var.oconv("TX");  // "t1" _BS _BS _BS _NL "t2"
<span class="nf">let</span><span class="w"> </span><span class="n">v6</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;s1}s2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;TX&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;s1&quot; _BS _BS _NL &quot;s2&quot;</span>


// 8. ST -> "\\\\" \n
<span class="c1">// 7. TM -&gt; &quot;\\\&quot; \n</span>
let v8 = "st1~st2"_var.oconv("TX"); // "st1" _BS _BS _BS _BS _NL "st2"</code></pre>
<span class="nf">let</span><span class="w"> </span><span class="n">v7</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;t1|t2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;TX&quot;</span><span class="p">);</span><span class="w">  </span><span class="c1">// &quot;t1&quot; _BS _BS _BS _NL &quot;t2&quot;</span>


<span class="c1">// 8. ST -&gt; &quot;\\\\&quot; \n</span>
<span class="nf">let</span><span class="w"> </span><span class="n">v8</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;st1~st2&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;TX&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;st1&quot; _BS _BS _BS _BS _NL &quot;st2&quot;</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.iconv("TX")</td><td><p>Convert standard text format to dynamic array.
<tr><td>var=</td><td>strvar.iconv("TX")</td><td><p>Convert standard text format to dynamic array.
</p>
</p>
Reverse of oconv("TX") above.</td></tr>
<p>Reverse of oconv("TX") above.
</p>
</td></tr>
</table>
</table>


Line 4,022: Line 3,973:
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td></td><td>dim d1;</td><td>Create an undimensioned array of vars pending actual dimensions.
<tr><td></td><td>dim d1;</td><td>Create an undimensioned array of vars pending actual dimensions.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
<pre><code class='language-cpp'>dim d1;</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>dim d1(nrows, ncols = 1);</td><td>Create an array of vars with a fixed number of columns and rows. All vars are unassigned.
<tr><td></td><td>dim d1(nrows, ncols = 1);</td><td>Create an array of vars with a fixed number of columns and rows. All vars are unassigned.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="nf">d1</span><span class="p">(</span><span class="mi">10</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1(10);
<span class="nf">dim</span><span class="w"> </span><span class="nf">d2</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">);</span>
dim d2(10, 3);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>dim d1 = d2; // Copy</td><td>Create a copy of an array.
<tr><td></td><td>dim d1 = d2; // Copy</td><td>Create a copy of an array.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w"> </span><span class="mi">8</span><span class="p">};</span>
<pre><code class='language-cpp'> dim d1 = {2, 4, 6, 8};
<span class="nf">dim</span><span class="w"> </span><span class="n">d2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
dim d2 = d1;</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>dim d1 = dim(); // Move</td><td><p>Save an array created elsewhere.
<tr><td></td><td>dim d1 = dim(); // Move</td><td><p>Save an array created elsewhere.
</p>
</p>
Uses C++ "move" semantics.
Uses C++ "move" semantics.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^f2^f3&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">split</span><span class="p">();</span>
<pre><code class='language-cpp'>dim d1 = "f1^f2^f3"_var.split();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>dim d1 = {"a", "b", "c" ...}; // Initializer list</td><td>Create an array from a list. All elements must be the same type, var, string, double, int, etc.. but all end up as vars which are a flexible type.
<tr><td></td><td>dim d1 = {"a", "b", "c" ...}; // Initializer list</td><td>Create an array from a list. All elements must be the same type, var, string, double, int, etc.. but all end up as vars which are a flexible type.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="p">};</span>
<pre><code class='language-cpp'>dim d1 = {1, 2, 3, 4, 5};
<span class="nf">dim</span><span class="w"> </span><span class="n">d2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="s">&quot;A&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;B&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;C&quot;</span><span class="p">};</span>
dim d2 = {"A", "B", "C"};</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>dim d1 = v1;</td><td>Initialise all elements of an array to some single value or constant. A var, "", 0 etc.
<tr><td></td><td>dim d1 = v1;</td><td>Initialise all elements of an array to some single value or constant. A var, "", 0 etc.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="nf">d1</span><span class="p">(</span><span class="mi">10</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1(10);
<span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">;</span>
d1 = "";</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>dim d1 = sourceint;</td><td>Undocumented</td></tr>
<tr><td></td><td>operator=(double sourcedbl)</td><td>Undocumented</td></tr>
<tr><td></td><td>d1.redim(nrows, ncols = 1)</td><td><p>Resize an array to a different number of rows and columns.
<tr><td></td><td>d1.redim(nrows, ncols = 1)</td><td><p>Resize an array to a different number of rows and columns.
</p>
</p>
Line 4,064: Line 4,011:
</p>
</p>
Resizing cols to 0 clears all data and changes its status to "undimensioned".
Resizing cols to 0 clears all data and changes its status to "undimensioned".
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
<pre><code class='language-cpp'>dim d1;
<span class="n">d1</span><span class="p">.</span><span class="nf">redim</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">);</span>
d1.redim(10, 3);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>d1.swap(d2) </td><td><p>Swap one array with another.
<tr><td></td><td>d1.swap(d2) </td><td><p>Swap one array with another.
</p>
</p>
Either or both may be undimensioned.
Either or both may be undimensioned.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="nf">d1</span><span class="p">(</span><span class="mi">5</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1(5);
<span class="nf">dim</span><span class="w"> </span><span class="nf">d2</span><span class="p">(</span><span class="mi">10</span><span class="p">);</span>
dim d2(10);
<span class="n">d1</span><span class="p">.</span><span class="nf">swap</span><span class="p">(</span><span class="n">d2</span><span class="p">);</span>
d1.swap(d2);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 4,084: Line 4,029:
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td></td><td>var v1 = d1[rowno];</br>d1[rowno] = v1;</td><td>Access and update elements of a one dimensional array using [] brackets
<tr><td></td><td>var v1 = d1[rowno];</br>d1[rowno] = v1;</td><td>Access and update elements of a one dimensional array using [] brackets
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="p">};</span>
<pre><code class='language-cpp'>dim d1 = {1, 2, 3, 4, 5};
<span class="n">d1</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">;</span>
d1[3] = "X";
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">[</span><span class="mi">3</span><span class="p">];</span><span class="w"> </span><span class="c1">// &quot;X&quot;</span>
let v1 = d1[3]; // "X"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>var v1 = d1[rowno, colno];</br>d1[rowno, colno] = v1;</td><td>Access and update elements of an two dimensional array using [] brackets
<tr><td></td><td>var v1 = d1[rowno, colno];</br>d1[rowno, colno] = v1;</td><td>Access and update elements of an two dimensional array using [] brackets
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="nf">d1</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1(10, 5);
<span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">;</span>
d1 = "";
<span class="n">d1</span><span class="p">[</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;X&quot;</span><span class="p">;</span>
d1[3, 4] = "X";
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">[</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">];</span><span class="w"> </span><span class="c1">// &quot;X&quot;</span>
let v1 = d1[3, 4]; // "X"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>VARREF</td><td>d2(rowno);      d1(rowno) = v2</td><td></td></tr>
<tr><td>VARREF</td><td>d2(rowno, colno);      d1(rowno, colno) = v2</td><td></td></tr>
<tr><td>var=</td><td>d1.rows()</td><td><p>Get the number of rows in the dimensioned array
<tr><td>var=</td><td>d1.rows()</td><td><p>Get the number of rows in the dimensioned array
</p>
</p>
<em>Returns:</em> A count. Can be zero, indicating an empty array.
<em>Returns:</em> A count. Can be zero, indicating an empty array.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="nf">d1</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span><span class="mi">3</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1(5,3);
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">rows</span><span class="p">();</span><span class="w"> </span><span class="c1">// 5</span>
let v1 = d1.rows(); // 5</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>d1.cols()</td><td><p>Get the number of columns in the dimensioned array
<tr><td>var=</td><td>d1.cols()</td><td><p>Get the number of columns in the dimensioned array
</p>
</p>
<em>Returns:</em> A count.  0 if the array is undimensioned.
<em>Returns:</em> A count.  0 if the array is undimensioned.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="nf">d1</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span><span class="mi">3</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1(5,3);
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">cols</span><span class="p">();</span><span class="w"> </span><span class="c1">// 3</span>
let v1 = d1.cols(); // 3</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>d1.join(delimiter = FM)</td><td><p>Joins all elements into a single delimited string
<tr><td>var=</td><td>d1.join(delimiter = FM)</td><td><p>Joins all elements into a single delimited string
Line 4,119: Line 4,062:
</p>
</p>
<em>Returns:</em> A string var.
<em>Returns:</em> A string var.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="s">&quot;f1&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;f2&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;f3&quot;</span><span class="p">};</span>
<pre><code class='language-cpp'>dim d1 = {"f1", "f2", "f3"};
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">join</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;f1^f2^f3&quot;_var</span>
let v1 = d1.join(); // "f1^f2^f3"_var</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 4,138: Line 4,080:
</p>
</p>
Using undimensioned arrays allows the efficient handling of arrays with a very variable number of elements. e.g. os text files.
Using undimensioned arrays allows the efficient handling of arrays with a very variable number of elements. e.g. os text files.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
<pre><code class='language-cpp'>dim d1;
<span class="n">d1</span><span class="p">.</span><span class="nf">splitter</span><span class="p">(</span><span class="s">&quot;f1^f2^f3&quot;</span><span class="kt">_var</span><span class="p">);</span><span class="w"> </span><span class="c1">// d1.rows() -&gt; 3  //// Automatically dimensioned.</span>
d1.splitter("f1^f2^f3"_var); // d1.rows() -> 3  //// Automatically dimensioned.
<span class="c1">//</span>
//
<span class="nf">dim</span><span class="w"> </span><span class="nf">d2</span><span class="p">(</span><span class="mi">10</span><span class="p">);</span>
dim d2(10);
<span class="n">d2</span><span class="p">.</span><span class="nf">splitter</span><span class="p">(</span><span class="s">&quot;f1^f2^f3&quot;</span><span class="kt">_var</span><span class="p">);</span><span class="w"> </span><span class="c1">// d2.rows() -&gt; 10 /// Predimensioned. Excess elements become &quot;&quot;</span>
d2.splitter("f1^f2^f3"_var); // d2.rows() -> 10 /// Predimensioned. Excess elements become ""</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>d1.sorter(reverse = false)</td><td><p>Sort the elements of the array in place.
<tr><td></td><td>d1.sorter(reverse = false)</td><td><p>Sort the elements of the array in place.
</p>
</p>
<em>reverse:</em> Defaults to false. If true, then the order is reversed.
<em>reverse:</em> Defaults to false. If true, then the order is reversed.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;2,20,10,1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">split</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1 = "2,20,10,1"_var.split(",");
<span class="n">d1</span><span class="p">.</span><span class="nf">sorter</span><span class="p">();</span>
d1.sorter();
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;1,2,10,20&quot;_var</span>
let v1 = d1.join(","); // "1,2,10,20"_var</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>d1.reverser()</td><td>Reverse the elements of the array in place.
<tr><td></td><td>d1.reverser()</td><td>Reverse the elements of the array in place.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;2,20,10,1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">split</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1 = "2,20,10,1"_var.split(",");
<span class="n">d1</span><span class="p">.</span><span class="nf">reverser</span><span class="p">();</span>
d1.reverser();
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;1,10,20,2&quot;_var</span>
let v1 = d1.join(","); // "1,10,20,2"_var</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>d1.shuffler()</td><td>Randomly shuffle the order of the elements of the array in place.
<tr><td></td><td>d1.shuffler()</td><td>Randomly shuffle the order of the elements of the array in place.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;2,20,10,1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">split</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1 = "2,20,10,1"_var.split(",");
<span class="n">d1</span><span class="p">.</span><span class="nf">shuffler</span><span class="p">();</span>
d1.shuffler();
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s">&quot;,&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// random</span>
let v1 = d1.join(","); // random</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 4,185: Line 4,123:
</p>
</p>
Each element in the array becomes a separate field in the db record. Any redundant trailing FMs are suppressed.
Each element in the array becomes a separate field in the db record. Any redundant trailing FMs are suppressed.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;Client GD^G^20855^30000^1001.00^20855.76539&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">split</span><span class="p">();</span>
<pre><code class='language-cpp'>dim d1 = "Client GD^G^20855^30000^1001.00^20855.76539"_var.split();
<span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">;</span>
let file = "xo_clients", key = "GD001";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">deleterecord</span><span class="p">(</span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{};</span><span class="w"> </span><span class="c1">// Cleanup first</span>
if (not deleterecord("xo_clients", "GD001")) {}; // Cleanup first
<span class="n">d1</span><span class="p">.</span><span class="nf">write</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">);</span>
d1.write(file, key);
<span class="c1">// or</span>
// or
<span class="nf">write</span><span class="p">(</span><span class="n">d1</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">);</span>
write(d1 on file, key);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>d1.read(dbfile, key)</td><td><p>Read a db file record into an array.
<tr><td>if</td><td>d1.read(dbfile, key)</td><td><p>Read a db file record into an array.
Line 4,203: Line 4,140:
</p>
</p>
If the array is not predimensioned (rows and cols = 0) then it will be dimensioned to have exactly the same number of rows as there are fields in the record being read.
If the array is not predimensioned (rows and cols = 0) then it will be dimensioned to have exactly the same number of rows as there are fields in the record being read.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="nf">d1</span><span class="p">(</span><span class="mi">10</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1(10);
<span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;GD001&quot;</span><span class="p">;</span>
let file = "xo_clients", key = "GD001";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">read</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="c1">// d1.join() -&gt; &quot;Client GD^G^20855^30000^1001.00^20855.76539^^^^&quot;_var</span>
if (not d1.read(file, key)) ... // d1.join() -> "Client GD^G^20855^30000^1001.00^20855.76539^^^^"_var
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">read</span><span class="p">(</span><span class="n">d1</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not read(d1 from file, key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 4,225: Line 4,161:
</p>
</p>
<em>Returns:</em> True if successful or false if not.
<em>Returns:</em> True if successful or false if not.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;aaa=1</span><span class="se">\n</span><span class="s">bbb=2</span><span class="se">\n</span><span class="s">ccc=3</span><span class="se">\n</span><span class="s">&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">split</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>dim d1 = "aaa=1\nbbb=2\nccc=3\n"_var.split("\n");
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">osremove</span><span class="p">(</span><span class="s">&quot;xo_conf.txt&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{};</span><span class="w"> </span><span class="c1">// Cleanup first</span>
if (not osremove("xo_conf.txt")) {}; // Cleanup first
<span class="nf">let</span><span class="w"> </span><span class="n">osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_conf.txt&quot;</span><span class="p">;</span>
let osfilename = "xo_conf.txt";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">oswrite</span><span class="p">(</span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not d1.oswrite(osfilename)) ...
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">oswrite</span><span class="p">(</span><span class="n">d1</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not oswrite(d1 on osfilename)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>d1.osread(osfilename, codepage = "")</td><td><p>Read an entire os text file into an array.
<tr><td>if</td><td>d1.osread(osfilename, codepage = "")</td><td><p>Read an entire os text file into an array.
Line 4,245: Line 4,180:
</p>
</p>
If the first \n in the file is \r\n then the whole file will be split using \r\n as delimiter.
If the first \n in the file is \r\n then the whole file will be split using \r\n as delimiter.
 
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
<pre><code class='language-cpp'>dim d1;
<span class="nf">let</span><span class="w"> </span><span class="n">osfilename</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_conf.txt&quot;</span><span class="p">;</span>
let osfilename = "xo_conf.txt";
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">d1</span><span class="p">.</span><span class="nf">osread</span><span class="p">(</span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="c1">// d1.join(&quot;\n&quot;) -&gt; &quot;aaa=1\nbbb=2\nccc=3\n&quot;_var0</span>
if (not d1.osread(osfilename)) ... // d1.join("\n") -> "aaa=1\nbbb=2\nccc=3\n"_var0
<span class="c1">// or</span>
// or
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">osread</span><span class="p">(</span><span class="n">d1</span><span class="w"> </span><span class="ow">from</span><span class="w"> </span><span class="n">osfilename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not osread(d1 from osfilename)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 4,287: Line 4,221:
</p>
</p>
In the following examples, various environment variables like RECORD, ID and MV are used instead of declaring and using named vars. In actual code, either may be freely used.
In the following examples, various environment variables like RECORD, ID and MV are used instead of declaring and using named vars. In actual code, either may be freely used.
 
<div class="highlight light"><pre><span class="nf">select</span><span class="p">(</span><span class="s">&quot;xo_clients by name by type with type &#39;A&#39; &#39;B&#39; and with balance between 0 and 2000&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>select("xo_clients by name by type with type 'A' 'B' and with balance between 0 and 2000");
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
if (readnext(ID)) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>selectkeys(keys)</td><td>Create an active select list from some given keys.
<tr><td>if</td><td>selectkeys(keys)</td><td>Create an active select list from some given keys.
 
<div class="highlight light"><pre><span class="nf">selectkeys</span><span class="p">(</span><span class="s">&quot;SB001^JB001^JB002&quot;</span><span class="kt">_var</span><span class="p">);</span>
<pre><code class='language-cpp'>selectkeys("SB001^JB001^JB002"_var);
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// ID -&gt; &quot;SB001&quot;</span>
if (readnext(ID)) ... ok // ID -> "SB001"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>hasnext()</td><td>Check if a select list is active.
<tr><td>if</td><td>hasnext()</td><td>Check if a select list is active.
 
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">hasnext</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
<pre><code class='language-cpp'>if (hasnext()) ... ok</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>readnext(out key)</td><td><p>Get the next key from an active select list.
<tr><td>if</td><td>readnext(out key)</td><td><p>Get the next key from an active select list.
Line 4,308: Line 4,239:
</p>
</p>
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
 
<div class="highlight light"><pre><span class="nf">selectkeys</span><span class="p">(</span><span class="s">&quot;SB001^JB001^JB002&quot;</span><span class="kt">_var</span><span class="p">);</span>
<pre><code class='language-cpp'>selectkeys("SB001^JB001^JB002"_var);
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// ID -&gt; &quot;SB001&quot;</span>
if (readnext(ID)) ... ok // ID -> "SB001"</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>readnext(out key, out valueno)</td><td><p>Get the next key and value number pair from an active select list.
<tr><td>if</td><td>readnext(out key, out valueno)</td><td><p>Get the next key and value number pair from an active select list.
Line 4,320: Line 4,250:
</p>
</p>
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
 
<div class="highlight light"><pre><span class="nf">selectkeys</span><span class="p">(</span><span class="s">&quot;SB001]2^SB001]1^JB001]2&quot;</span><span class="kt">_var</span><span class="p">);</span>
<pre><code class='language-cpp'>selectkeys("SB001]2^SB001]1^JB001]2"_var);
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">ID</span><span class="p">,</span><span class="w"> </span><span class="n">MV</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="w"> </span><span class="c1">// ID -&gt; &quot;SB001&quot; // MV -&gt; 2</span>
if (readnext(ID, MV)) ... ok // ID -> "SB001" // MV -> 2</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>readnext(out record, out key, out valueno)</td><td><p>Get the next record, key and value no from an active select list.
<tr><td>if</td><td>readnext(out record, out key, out valueno)</td><td><p>Get the next record, key and value no from an active select list.
Line 4,334: Line 4,263:
</p>
</p>
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
 
<div class="highlight light"><pre><span class="nf">select</span><span class="p">(</span><span class="s">&quot;xo_clients by name (R)&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>select("xo_clients by name (R)");
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="n">RECORD</span><span class="p">,</span><span class="w"> </span><span class="n">ID</span><span class="p">,</span><span class="w"> </span><span class="n">MV</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span><span class="p">;</span>
if (readnext(RECORD, ID, MV)) ... ok;
<span class="n">assert</span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">RECORD</span><span class="p">.</span><span class="nf">empty</span><span class="p">());</span>
assert(not RECORD.empty());</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>pushselect(out cursor)</td><td><p>Saves a pointer to the currently active select list.
<tr><td></td><td>pushselect(out cursor)</td><td><p>Saves a pointer to the currently active select list.
Line 4,345: Line 4,273:
</p>
</p>
<em>cursor:</em> [out] A var that can be passed later on to the popselect() function to reactivate the saved list.
<em>cursor:</em> [out] A var that can be passed later on to the popselect() function to reactivate the saved list.
 
<div class="highlight light"><pre><span class="nf">select</span><span class="p">(</span><span class="s">&quot;xo_clients by name&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>select("xo_clients by name");
<span class="kt">var</span><span class="w"> </span><span class="n">saved_xo_clients_cursor</span><span class="p">;</span>
var saved_xo_clients_cursor;
<span class="nf">pushselect</span><span class="p">(</span><span class="n">saved_xo_clients_cursor</span><span class="p">);</span>
pushselect(saved_xo_clients_cursor);
<span class="c1">//</span>
//
<span class="c1">// ... work with another select list ...</span>
// ... work with another select list ...
<span class="c1">//</span>
//
<span class="nf">popselect</span><span class="p">(</span><span class="n">saved_xo_clients_cursor</span><span class="p">);</span><span class="w"> </span><span class="c1">// Reactivate the original select list.</span>
popselect(saved_xo_clients_cursor); // Reactivate the original select list.</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>popselect(cursor)</td><td><p>Re-establish an active select list saved by pushselect().
<tr><td></td><td>popselect(cursor)</td><td><p>Re-establish an active select list saved by pushselect().
Line 4,363: Line 4,290:
</p>
</p>
If no select list is active then nothing is done.
If no select list is active then nothing is done.
 
<div class="highlight light"><pre><span class="nf">clearselect</span><span class="p">();</span>
<pre><code class='language-cpp'>clearselect();</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>deleterecord(filename)</td><td><p>Use an active select list to delete db records.
<tr><td>if</td><td>deleterecord(filename)</td><td><p>Use an active select list to delete db records.
Line 4,372: Line 4,298:
</p>
</p>
Contrast this function with the two argument "deleterecord(file, key)" function that deletes a single record.
Contrast this function with the two argument "deleterecord(file, key)" function that deletes a single record.
 
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">select</span><span class="p">(</span><span class="s">&quot;xo_clients with type &#39;Q&#39; and with balance between 0 and 100&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
<pre><code class='language-cpp'>if (select("xo_clients with type 'Q' and with balance between 0 and 100")) {
<span class="w">  </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">deleterecord</span><span class="p">(</span><span class="s">&quot;xo_clients&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
  if (deleterecord("xo_clients")) ...
<span class="p">}</span>
}</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>deleterecord(dbfile, key)</td><td>Delete a single database file record.
<tr><td>if</td><td>deleterecord(dbfile, key)</td><td>Delete a single database file record.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;xo_clients&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;QQ001&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>let file = "xo_clients", key = "QQ001";
<span class="nf">write</span><span class="p">(</span><span class="s">&quot;&quot;</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">);</span>
write("" on file, key);
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">deleterecord</span><span class="p">(</span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not deleterecord(file, key)) ...
<span class="c1">// or</span>
// or
<span class="nf">write</span><span class="p">(</span><span class="s">&quot;&quot;</span><span class="w"> </span><span class="ow">on</span><span class="w"> </span><span class="n">file</span><span class="p">,</span><span class="w"> </span><span class="n">key</span><span class="p">);</span>
write("" on file, key);
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">file</span><span class="p">.</span><span class="nf">deleterecord</span><span class="p">(</span><span class="n">key</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not file.deleterecord(key)) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>savelist(listname)</td><td><p>Save a currently active select list under a given name.
<tr><td>if</td><td>savelist(listname)</td><td><p>Save a currently active select list under a given name.
Line 4,395: Line 4,319:
</p>
</p>
Lists are saved as a record in the "lists" file.
Lists are saved as a record in the "lists" file.
 
<div class="highlight light"><pre><span class="nf">selectkeys</span><span class="p">(</span><span class="s">&quot;SB001^SB002&quot;</span><span class="kt">_var</span><span class="p">);</span>
<pre><code class='language-cpp'>selectkeys("SB001^SB002"_var);
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">savelist</span><span class="p">(</span><span class="s">&quot;my_list&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
if (not savelist("my_list")) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>getlist(listname)</td><td><p>Reactivate a saved select list of a given name.
<tr><td>if</td><td>getlist(listname)</td><td><p>Reactivate a saved select list of a given name.
Line 4,405: Line 4,328:
</p>
</p>
<em>Returns:</em> True if an active select list was successfully reactivated, otherwise false.
<em>Returns:</em> True if an active select list was successfully reactivated, otherwise false.
 
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">getlist</span><span class="p">(</span><span class="s">&quot;my_list&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
<pre><code class='language-cpp'>if (not getlist("my_list")) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>deletelist(listname)</td><td><p>Remove a saved select list by name.
<tr><td>if</td><td>deletelist(listname)</td><td><p>Remove a saved select list by name.
</p>
</p>
A saved list is deleted from the "lists" file.
A saved list is deleted from the "lists" file.
 
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="nf">deletelist</span><span class="p">(</span><span class="s">&quot;my_list&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
<pre><code class='language-cpp'>if (not deletelist("my_list")) ...</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>formlist(filename_or_command, keys = "", fieldno = 0)</td><td></td></tr>
<tr><td>if</td><td>makelist(listname, keys)</td><td></td></tr>
</table>
</table>
<h5 id=Perform/Execute>Perform/Execute</h5>
<h5 id=Perform/Execute>Perform/Execute</h5>
Line 4,421: Line 4,344:
<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>perform(command_line)</td><td><p>Run an exodus program/library's main function using a command like syntax similar to that of executable programs.
<tr><td>var=</td><td>perform(command_line)</td><td><p>Run an exodus program/library's main function using a command like syntax similar to that of os executable programs.
</p>
</p>
<p>A "command line" is passed to the program/library in the usual COMMAND, SENTENCE and OPTIONS environment variables instead of function arguments.
<p><em>command_line:</em> Used to initialise the COMMAND, SENTENCE and OPTIONS environment variables of the performed exodus program/library. Analogous to passing function arguments. The first word of command_line is used as the name of the program/library to be loaded and run.
</p>
</p>
<p>The program/library's main function should have zero arguments. Performing a program/library function with main arguments results in them being unassigned and in some case core dump may occur.
<p>The program/library's main function should have zero arguments. Performing a program/library function with main arguments results in them being unassigned and in some case core dump may occur.
</p>
</p>
<p>The following environment variables are initialised on entry to the main function of the program/library. They are preserved untouched in the calling program.
<p><em>Returns:</em> Whatever var the program/library returns, or "" if it calls stop() or abort((). The return value can be ignored and discarded without any compiler warning.
</p>
</p>
<p>SENTENCE, COMMAND, OPTIONS: Initialised from the argument "command_line".
<p>The following environment variables are initialised on entry to the main function of the program/library and are preserved untouched in the calling program.
</p>
</p>
<p>RECUR0, RECUR1, RECUR2, RECUR3, RECUR4 to "".
<p>RECUR0, RECUR1, RECUR2, RECUR3, RECUR4 to "".
Line 4,439: Line 4,362:
<p>All other environment variables are shared between the caller and callee. There is essentially only one environment in any one process or thread.
<p>All other environment variables are shared between the caller and callee. There is essentially only one environment in any one process or thread.
</p>
</p>
<p>Any active select list is passed to the performed program/library and can be consumed by it. Conversely any active select list created by the performed program/library will be returned to the calling program. In other words, both the performing and the performed programs/libraries share a single active select list environment. This is different from execute() which gets its own private active select list, initially inactive.
<p>Any active select list in CURSOR is passed to the performed program/library and can be consumed by it. Conversely any active select list created by the performed program/library will be returned to the calling program. In other words, both the performing and the performed programs/libraries share a single active select list environment. This is different from execute() which gets its own private active select list, initially inactive.
</p>
<p><em>command_line:</em> The first word of this argument is used as the name of the program/library to be loaded and run. command_line is used to initialise the SENTENCE, COMMAND and OPTIONS environment variables.
</p>
<p><em>Returns:</em> Whatever var the program/library returns, or "" if it calls stop() or abort(()".
</p>
<p>The return value can be ignored and discarded without any compiler warning.
</p>
</p>
Exodus program/libraries may also be called directly using conventional function calling syntax. To call an exodus program/library called progname using either the syntax "call progname(args...);" or "var v1 = progname(args...);" you must "#include <progname.h>" after the "programinit()" or "libraryinit()" lines in your program/library.</td></tr>
Exodus program/libraries may also be called directly using conventional function calling syntax. To call an exodus program/library called progname using either the syntax "call progname(args...);" or "var v1 = progname(args...);" you must "#include <progname.h>" after the "programinit()" or "libraryinit()" lines in your program/library.</td></tr>
Line 4,451: Line 4,368:
</p>
</p>
Identical to perform() but any currently active select list in the calling program/library is not accessible to the executed program/library and is preserved in the calling [program as is. Any select list created by the executed library is discarded when it terminates.</td></tr>
Identical to perform() but any currently active select list in the calling program/library is not accessible to the executed program/library and is preserved in the calling [program as is. Any select list created by the executed library is discarded when it terminates.</td></tr>
<tr><td></td><td>chain(command_line)</td><td><p>Run an exodus program/library's main function after closing the current program.
<tr><td></td><td>chain(command_line)</td><td><p>Close the current program and perform another one.
</p>
</p>
Identical to perform() except that the current program closes first.</td></tr>
Identical to perform() except that the current program closes first.</td></tr>
<tr><td>var=</td><td>libinfo(libname)</td><td>Check if a lib exists to be performed/executed or called.</td></tr>
<tr><td>var=</td><td>libinfo(libname)</td><td>Check if a lib exists to be performed/executed or called. Currently it does not check if it is actually loadable.</td></tr>
</table>
</table>
<h5 id=Program_Termination_>Program Termination </h5>
<h5 id=Program_Termination_>Program Termination </h5>
Line 4,460: Line 4,377:
<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td></td><td>stop(message = "")</td><td><p>Stop the current exodus program/library normally and return to the parent exodus program/library, or return to the operating system if none.
<tr><td></td><td>stop(message = "")</td><td><p>Stop the current exodus program/library normally.
</p>
<p>Either return to the performing or executing parent exodus program/library, or exit to the OS if none.
</p>
</p>
<p>Calling stop() in an exodus OS command line executable program, or in a function called from the same, will terminate the OS process with an error status of 0 which is generally considered to indicate success.
<em>message:</em> Optional. If exiting to the OS then it will be output to stdout or, if numeric, used as the exit status.</td></tr>
<tr><td></td><td>abort(message = "")</td><td><p>Abort the current exodus program/library.
</p>
</p>
Calling stop() in a performed or executed exodus program/library, or in a function called from the same, will terminate the program/library being executed and return to the exodus program that performed or executed it.</td></tr>
<p>Similar to stop but if exiting to the OS then the default exit status is 1.
<tr><td></td><td>abort(message = "")</td><td><p>Abort the current exodus program/library abnormally and return to the parent exodus program/library, or return to the operating system if none.
</p>
</p>
Similar to stop() but, if terminating the OS process, then return an error status of 1 which is generally considered to be an indication of failure.</td></tr>
<em>message:</em> Optional. If exiting to the OS then it will be output to stderr or, if numeric, used as the exit status.</td></tr>
<tr><td></td><td>abortall(message = "")</td><td><p>Abort the current exodus program/library abnormally and return to the parent exodus program/library, or return to the operating system if none.
<tr><td></td><td>abortall(message = "")</td><td><p>Abort the current exodus program/library.
</p>
</p>
Similar to abort() but, if terminating the OS process, then return an error status of 2 which is generally considered to be an indication of failure.</td></tr>
Similar to abort but if exiting to the OS then the default exit status is 2.</td></tr>
<tr><td></td><td>logoff(message = "")</td><td></td></tr>
</table>
</table>
<h5 id=DB_File_Dictionaries>DB File Dictionaries</h5>
<h5 id=DB_File_Dictionaries>DB File Dictionaries</h5>
Line 4,477: Line 4,395:
<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>calculate(dictid)</td><td><p>given dictid reads dictrec from DICT file and extracts from RECORD/ID or calls library
<tr><td>var=</td><td>calculate(dictid)</td><td>Given a dictid reads a dictrec from the current DICT file (using readc()) and then either extracts a specific field number from the current RECORD/ID/MV environment variables or calls a dict function library to calculate the result.</td></tr>
<tr><td>var=</td><td>calculate(dictid, dictfile, id, record, mv = 0)</td><td>Given dictid, dictfile, record, id and mv, reads a dictrec from dictfile (using readc()) and then either extracts a specific field number from the given record/id/mv or calls a dict function library to calculate the result.</td></tr>
<tr><td>var=</td><td>xlate(filename, key, fieldno_or_name, mode)</td><td><p>Reads a record from the specified file and key (using readc()) and then either extracts a specific field number or calls calculate(dictid...) to obtain the result.
</p>
<p><em>filename:</em> Which file to read.
</p>
<p><em>key:</em> The key of the record to read.
</p>
<p><em>fieldno_or_name:</em>
</p>
<p>* If numeric then a specific field number will be extracted.
</p>
<p>* If "0" then the key will be returned.
</p>
<p>* If "" then the whole record will be returned.
</p>
<p>* dictid: calculate(dictid) will be called.
</p>
<p><em>mode:</em> Determines what to do if the record does not exist.
</p>
<p>* "X" Return ""
</p>
<p>* "C" Return the key.
</p>
</p>
called dict+DICT function dictid not const so we can mess with the library?</td></tr>
<em>MV:</em> Environment variable. Will be used to select a particular value or all if zero.</td></tr>
<tr><td>var=</td><td>calculate(dictid, dictfile, id, record, mv = 0)</td><td></td></tr>
<tr><td>var=</td><td>xlate(filename, key, fieldno_or_name, mode)</td><td></td></tr>
</table>
</table>
<h5 id=I/O_Conversion>I/O Conversion</h5>
<h5 id=I/O_Conversion>I/O Conversion</h5>
Line 4,503: Line 4,441:
</p>
</p>
</td></tr>
</td></tr>
<tr><td>var=</td><td>iconv(input, conversion)</td><td></td></tr>
<tr><td>var=</td><td>iconv(input, conversion)</td><td><p>iconv/oconv with access to exoprogram's environment variables.
</p>
<p>exoprog's iconv/oconv have the ability to call custom functions like "[funname,args...]"
</p>
 
<p>[NUMBER]  // built-in. See doc below.
</p>
<p>[DATE]    // built-in. See doc below.
</p>
<p>[DATEPERIOD]  e.g. [DATEPERIOD,1] [DATEPERIOD,1,12]
</p>
<p>[DATETIME]    e.g. [DATETIME,4*,DOS] [DATETIME,4*,MTS] [DATETIME,4*]
</p>
<p>[TIME2]      e.g. [TIME2,MT] [TIME2,MTS] [TIME2,MTS48]
</p></td></tr>
</table>
</table>
<h5 id=Ioconv_Date/Time_>Ioconv Date/Time </h5>
<h5 id=Ioconv_Date/Time_>Ioconv Date/Time </h5>
Line 4,523: Line 4,475:
</p>
</p>
If you are calling iconv/oconv in code and DATEFMT is adequate for your needs then pass it directly as a function argument e.g. 'var v1 = iconv|oconv(v2, DATEFORMAT);' instead of indirectly like 'var v1 = iconv|oconv(v2, "[DATE]");'.
If you are calling iconv/oconv in code and DATEFMT is adequate for your needs then pass it directly as a function argument e.g. 'var v1 = iconv|oconv(v2, DATEFORMAT);' instead of indirectly like 'var v1 = iconv|oconv(v2, "[DATE]");'.
 
<div class="highlight light"><pre><span class="n">DATEFMT</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;D/E&quot;</span><span class="p">;</span>
<pre><code class='language-cpp'>DATEFMT = "D/E";
<span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;JAN 9 2025&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;D&quot;</span><span class="p">);</span>
let v1 = iconv("JAN 9 2025", "D");
<span class="n">assert</span><span class="p">(</span><span class="nf">oconv</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;[DATE]&quot;</span><span class="w">   </span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot; 9/ 1/2025&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;D/EZ&quot; or &quot;[DATE,D]&quot; equivalent assuming D/E in DATEFMT (replace leading zeros with spaces)</span>
assert(oconv(v1, "[DATE]"  ) == " 9/ 1/2025");  // "D/EZ" or "[DATE,D]" equivalent assuming D/E in DATEFMT (replace leading zeros with spaces)
<span class="n">assert</span><span class="p">(</span><span class="nf">oconv</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;[DATE,4]&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot; 9/ 1/2025&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;D4Z&quot; equivalent assuming D/E in DATEFMT (replace leading zeros with spaces)</span>
assert(oconv(v1, "[DATE,4]" ) == " 9/ 1/2025");  // "D4Z" equivalent assuming D/E in DATEFMT (replace leading zeros with spaces)
<span class="n">assert</span><span class="p">(</span><span class="nf">oconv</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;[DATE,*4]&quot;</span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;9/1/2025&quot;</span><span class="p">);</span><span class="w">   </span><span class="c1">// &quot;D4ZZ&quot; equivalent assuming D/E in DATEFMT (trim leading zeros and spaces)</span>
assert(oconv(v1, "[DATE,*4]") == "9/1/2025");    // "D4ZZ" equivalent assuming D/E in DATEFMT (trim leading zeros and spaces)
<span class="n">assert</span><span class="p">(</span><span class="nf">oconv</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;[DATE,*]&quot;</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;9/1/2025&quot;</span><span class="p">);</span><span class="w">   </span><span class="c1">// &quot;DZZ&quot; equivalent assuming D/E in DATEFMT (trim leading zeros and spaces)</span>
assert(oconv(v1, "[DATE,*]" ) == "9/1/2025");    // "DZZ" equivalent assuming D/E in DATEFMT (trim leading zeros and spaces)</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>iconv|oconv(var, "[NUMBER]")</td><td><p>Use iconv/oconv "[NUMBER,args]" either when your numbers have currency or unit code suffixes or when you want number conversion to depend on the environment variable BASEFMT to determine thousands separator and decimal point. Otherwise use ordinary "MD" conversion codes directly for slightly greater performance.
<tr><td>var=</td><td>iconv|oconv(var, "[NUMBER]")</td><td><p>Use iconv/oconv "[NUMBER,args]" either when your numbers have currency or unit code suffixes or when you want number conversion to depend on the environment variable BASEFMT to determine thousands separator and decimal point. Otherwise use ordinary "MD" conversion codes directly for slightly greater performance.
Line 4,589: Line 4,540:


<p>Special format "[NUMBER,ndecs,move_ndecs]": move_ndecs causes decimal point to be shifted left if positive or right if negative.
<p>Special format "[NUMBER,ndecs,move_ndecs]": move_ndecs causes decimal point to be shifted left if positive or right if negative.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">oconv</span><span class="p">(</span><span class="s">&quot;1234.5USD&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;[NUMBER,2]&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;1,234.50USD&quot; // Comma added and decimal places corrected.</span>
<pre><code class='language-cpp'>var v1 = oconv("1234.5USD", "[NUMBER,2]"); // "1,234.50USD" // Comma added and decimal places corrected.</code></pre>
</pre></div>
 


</p>
</p>
Line 4,607: Line 4,557:


Optional prefix of "1/" or "/" causes the reciprocal of the number to be used. e.g. "1/100" or "/100" -> "0.01".
Optional prefix of "1/" or "/" causes the reciprocal of the number to be used. e.g. "1/100" or "/100" -> "0.01".
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">iconv</span><span class="p">(</span><span class="s">&quot;1,234.5678USD&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;[NUMBER]&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;1234.57USD&quot; // Comma removed</span>
<pre><code class='language-cpp'>var v1 = iconv("1,234.5678USD", "[NUMBER]"); // "1234.57USD" // Comma removed</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>amountunit(input0, out unitx)</td><td><p>Split amount+currency code/unit string into number and currency code/unit.
<tr><td>var=</td><td>amountunit(input0, out unitx)</td><td><p>Split amount+currency code/unit string into number and currency code/unit.
Line 4,618: Line 4,567:
</p>
</p>
<em>unitx:</em> [out] e.g. "USD"</td></tr>
<em>unitx:</em> [out] e.g. "USD"</td></tr>
<tr><td>var=</td><td>amountunit(input0)</td><td></td></tr>
<tr><td>var=</td><td>amountunit(input0)</td><td><p>Split amount+currency code/unit string into number and currency code/unit.
</p>
<p><em>var:</em> "123.45USD"
</p>
<p><em>Returns:</em> e.g. "123.45"
</p>
<em>unitx:</em> [out] e.g. "USD</td></tr>
</table>
</table>
<h5 id=Time/Date_Utilities>Time/Date Utilities</h5>
<h5 id=Time/Date_Utilities>Time/Date Utilities</h5>


<table class=wikitable>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>timedate2()</td><td>
<tr><td>var=</td><td>timedate2()</td><td>
<p><em>Returns:</em> Text of date and time in users time zone
<p><em>Returns:</em> Text of date and time in users time zone
</p>
</p>
<p>e.g. "2MAR2025 11:52AM"
<p>e.g. "2MAR2025 11:52AM"
</p>
</p>
Offset from UTC by TZ seconds.</td></tr>
Offset from UTC by TZ seconds.</td></tr>
<tr><td></td><td>getdatetime(out user_date, out user_time, out system_date, out system_time, out UTC_date, out UTC_time)</td><td>
<tr><td></td><td>getdatetime(out user_date, out user_time, out system_date, out system_time, out UTC_date, out UTC_time)</td><td>
<p><em>Returns:</em> User, server and UTC date and time
<p><em>Returns:</em> User, server and UTC date and time
</p>
</p>
<p>User date and time is determined by adding the environment variable TZ.f(1)'s TZ offset (in seconds) to UTC date/time obtained from the operating system.
<p>User date and time is determined by adding the environment variable TZ.f(1)'s TZ offset (in seconds) to UTC date/time obtained from the operating system.
</p>
</p>
<p>"system" date and time is normally the same as UTC date/time and is determined by adding the environment variable TZ.f(2)'s TZ offset (in seconds) to UTC date/time obtained from the operating system.
<p>"system" date and time is normally the same as UTC date/time and is determined by adding the environment variable TZ.f(2)'s TZ offset (in seconds) to UTC date/time obtained from the operating system.
</p>
</p>
</td></tr>
<tr><td>var=</td><td>elapsedtimetext()</td><td><p>Get text of elapsed time since environment variable TIMESTAMP was initialised with ostimestamp() at program/thread startup.
</p>
TIMESTAMP can be updated using ostimestamp() as and when desired.
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">elapsedtimetext</span><span class="p">();</span><span class="w"> </span><span class="c1">// e.g. &quot;&lt; 1ms&quot;</span>
</pre></div>
</td></tr>
</td></tr>
<tr><td>var=</td><td>elapsedtimetext()</td><td><p>Get text of elapsed time since environment variable TIMESTAMP was initialised with ostimestamp() at program/thread startup.
<tr><td>var=</td><td>elapsedtimetext(timestamp1, timestamp2)</td><td><p>Get text of elapsed time between two timestamps
</p>
</p>
TIMESTAMP can be updated using ostimestamp() as and when desired.
Caution. Use ostimestamps not ostimes. One is in days and the other is in seconds.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">elapsedtimetext</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mf">0.55</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;13 hours, 12 mins&quot;</span>
<pre><code class='language-cpp'>var v1 = elapsedtimetext(); // e.g. "< 1ms"</code></pre>
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">elapsedtimetext</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="mf">0.001</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;1 min, 26 secs&quot;</span>
 
</pre></div>
</td></tr>
<tr><td>var=</td><td>elapsedtimetext(timestamp1, timestamp2)</td><td>Get text of elapsed time between two timestamps
 
<pre><code class='language-cpp'>let v1 = elapsedtimetext(0, 0.55);  // "13 hours, 12 mins"
let v2 = elapsedtimetext(0, 0.001); // "1 min, 26 secs"</code></pre>
 
</td></tr>
</td></tr>
</table>
</table>
Line 4,659: Line 4,614:
</p>
</p>
<em>options:</em> R = Response requested. C upper case response.
<em>options:</em> R = Response requested. C upper case response.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">response</span><span class="p">;</span>
<pre><code class='language-cpp'>var response;
<span class="c1">// call note(&quot;Enter something&quot;, &quot;RC&quot;, response);</span>
// call note("Enter something", "RC", response);</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>note(msg)</td><td>Output a message to stdin and continue.
<tr><td></td><td>note(msg)</td><td>Output a message to stdin and continue.
 
<div class="highlight light"><pre><span class="k">call</span><span class="w"> </span><span class="nf">note</span><span class="p">(</span><span class="s">&quot;Hello world.&quot;</span><span class="p">);</span>
<pre><code class='language-cpp'>call note("Hello world.");</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>decide(question, options = "")</td><td><p>If stdin is a terminal, pause processing, list some given options to stdout and request the user to make a choice, otherwise set the response to "" and continue.
<tr><td>var=</td><td>decide(question, options = "")</td><td><p>If stdin is a terminal, pause processing, list some given options to stdout and request the user to make a choice, otherwise set the response to "" and continue.
Line 4,731: Line 4,684:
</p>
</p>
DISABLED - Terminal is disabled due to more errors than the maximum currently set.
DISABLED - Terminal is disabled due to more errors than the maximum currently set.
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">cursor</span><span class="p">;</span>
<pre><code class='language-cpp'>var cursor;
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">isterminal</span><span class="p">()</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="nf">getcursor</span><span class="p">(</span><span class="n">cursor</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="c1">// cursor becomes something like &quot;0^20^0.012345&quot;_var</span>
if (isterminal() and not getcursor(cursor)) ... // cursor becomes something like "0^20^0.012345"_var</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>getcursor()</td><td><p>Get the position of the terminal cursor.
<tr><td>var=</td><td>getcursor()</td><td><p>Get the position of the terminal cursor.
</p>
</p>
For more info see the main getcursor() function above.
For more info see the main getcursor() function above.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">cursor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">getcursor</span><span class="p">();</span><span class="w"> </span><span class="c1">// If isterminal() then cursor becomes something like &quot;0^20^0.012345&quot;_var</span>
<pre><code class='language-cpp'>let cursor = getcursor(); // If isterminal() then cursor becomes something like "0^20^0.012345"_var</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>setcursor(cursor_coordinates)</td><td><p>If stdin is a terminal, position the cursor at x and y as per the given coordinates.
<tr><td></td><td>setcursor(cursor_coordinates)</td><td><p>If stdin is a terminal, position the cursor at x and y as per the given coordinates.
</p>
</p>
<em>cursor_coordinates:</em> An FM delimited string containing the x and y coordinates of the terminal cursor as can be obtained by getcursor().
<em>cursor_coordinates:</em> An FM delimited string containing the x and y coordinates of the terminal cursor as can be obtained by getcursor().
 
<div class="highlight light"><pre><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">isterminal</span><span class="p">())</span><span class="w"> </span><span class="p">{</span>
<pre><code class='language-cpp'>if (isterminal()) {
<span class="w">    </span><span class="nf">let</span><span class="w"> </span><span class="n">cursor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">getcursor</span><span class="p">();</span><span class="w"> </span><span class="c1">// Save the current cursor position.</span>
    let cursor = getcursor(); // Save the current cursor position.
<span class="w">    </span><span class="n">TRACE</span><span class="p">(</span><span class="n">cursor</span><span class="p">)</span><span class="w">             </span><span class="c1">// Show the saved cursor position.</span>
    TRACE(cursor)            // Show the saved cursor position.
<span class="w">    </span><span class="nf">print</span><span class="p">(</span><span class="nf">AT</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">));</span><span class="w">           </span><span class="c1">// Position the cursor at 0,0.</span>
    print(AT(0,0));          // Position the cursor at 0,0.
<span class="w">    </span><span class="nf">setcursor</span><span class="p">(</span><span class="n">cursor</span><span class="p">);</span><span class="w">       </span><span class="c1">// Restore its position</span>
    setcursor(cursor);        // Restore its position
<span class="p">}</span>
}</code></pre>
</pre></div></td></tr>
</td></tr>
</table>
</table>
<h5 id=Array_Utilities>Array Utilities</h5>
<h5 id=Array_Utilities>Array Utilities</h5>
Line 4,764: Line 4,714:
</p>
</p>
<em>pad:</em> If true then on return, all fields will have the same number of values with superfluous trailing VMs where necessary.
<em>pad:</em> If true then on return, all fields will have the same number of values with superfluous trailing VMs where necessary.
 
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a]b]c^1]2]3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<pre><code class='language-cpp'>let v1 = "a]b]c^1]2]3"_var;
<span class="nf">let</span><span class="w"> </span><span class="n">v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">invertarray</span><span class="p">(</span><span class="n">v1</span><span class="p">);</span><span class="w"> </span><span class="c1">// &quot;a]1^b]2^c]3&quot;_var</span>
let v2 = invertarray(v1); // "a]1^b]2^c]3"_var</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
<tr><td></td><td>sortarray(io array, fns = "", order = "")</td><td><p>Sorts fields of multivalues of dynamic arrays in parallel
<tr><td></td><td>sortarray(io array, fns = "", order = "")</td><td><p>Sorts fields of multivalues of dynamic arrays in parallel
Line 4,782: Line 4,731:
</p>
</p>
DR Descending - Right Justified - Numeric
DR Descending - Right Justified - Numeric
 
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">v1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;f1^10]20]2]1^ww]xx]yy]zz^f3^f4&quot;</span><span class="kt">_var</span><span class="p">;</span><span class="w"> </span><span class="c1">// fields 2 and 3 are parallel multivalues and currently unordered.</span>
<pre><code class='language-cpp'>var v1 = "f1^10]20]2]1^ww]xx]yy]zz^f3^f4"_var;  // fields 2 and 3 are parallel multivalues and currently unordered.
<span class="nf">sortarray</span><span class="p">(</span><span class="n">v1</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;2]3&quot;</span><span class="kt">_var</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;AR&quot;</span><span class="p">);</span><span class="w"> </span><span class="c1">// v1 -&gt; &quot;f1^1]2]10]20^zz]yy]ww]xx^f3^f4&quot;_var</span>
sortarray(v1, "2]3"_var, "AR"); // v1 -> "f1^1]2]10]20^zz]yy]ww]xx^f3^f4"_var</code></pre>
</pre></div>
 
</td></tr>
</td></tr>
</table>
</table>
Line 4,793: Line 4,741:
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>lockrecord(filename, io file, keyx, recordx, waitsecs = 0, allowduplicate = false)</td><td>Does not actually return record</td></tr>
<tr><td>if</td><td>lockrecord(filename, io file, keyx, recordx, waitsecs = 0, allowduplicate = false)</td><td>Does not actually return record</td></tr>
<tr><td>if</td><td>lockrecord(filename, io file, keyx)</td><td></td></tr>
<tr><td>if</td><td>lockrecord(filename, io file, keyx)</td><td>Does not actually return recor</td></tr>
<tr><td>if</td><td>unlockrecord(filename, io file, key)</td><td></td></tr>
<tr><td>if</td><td>unlockrecord(filename, io file, key)</td><td>Does not actually return reco</td></tr>
<tr><td>if</td><td>unlockrecord()</td><td></td></tr>
<tr><td>if</td><td>unlockrecord()</td><td>Does not actually return rec</td></tr>
</table>
</table>
<script>
hljs.registerLanguage('cpp', function(hljs) {
    // Get the original C++ language definition
    const cpp = hljs.getLanguage('cpp');
    // Your custom keywords
    const customKeywords = 'var let _var BASEFMT BS CVR Callable DATEFMT DQ DimIndexOutOfBounds DimUndimensioned EOL ExoAbort ExoAbortAll ExoCommon ExoEnv ExoLogoff ExoProgram ExoStop FM NL OSSLASH OSSLASH_IS_BACKSLASH PLATFORM RELOAD_req RM SM SQ ST SV TERMINATE_req TM TZ VARREF VM VarDBException VarDebug VarDivideByZero VarError VarInvalidPointer VarNonNumeric VarNonPositive VarNotImplemented VarNumOverflow VarNumUnderflow VarOutOfMemory VarUnassigned VarUnconstructed _CPP_STANDARD _OS_NAME _OS_VERSION abs append appender assigned at atan attach backtrace begin begintrans breakoff breakon c_str call chr clearcache clearfile clearselect clone close committrans connect contains convert converter cos count createString createfile createindex createstring crop cropper cut cutter data date dbcopy dbcreate dbcursorexists dbdelete dblist debug defaulter deletec deletefile deleteindex deletelist deleterecord detach dim dim_iter disconnect disconnectall dump echo empty end ends eof errput errputl exo_backtrace exo_savestack exodus_main exp extract f fcase fcaser fcount field field2 fieldstore fieldstorer first firster floor flushindex format from from_codepage from_u32tring getexecpath gethostname getlist getprecision getprocessn getprompt getxlocale hash hasinput hasnext iconv iconv_D iconv_HEX iconv_MT iconv_TX index indexn indexr initrnd input inputn insert inserter insertrecord integer into invert inverter isnum isterminal join keypressed last laster lasterror lcase lcaser len let listfiles listindex load localeAwareCompare locate locateby locatebyusing locateusing lock loge loglasterror logput logputl lower lowerer match mod move multivalued mv normalize normalizer num numberinwords oconv oconv_D oconv_HEX oconv_LRC oconv_MD oconv_MR oconv_MS oconv_MT oconv_T oconv_TX on open operator or_default ord osbread osbwrite osclose oscopy oscwd osdir osfile osflush osgetenv osinfo oslist oslistd oslistf osmkdir osmove osopen osopenx ospid osread osremove osrename osrmdir ossetenv osshell osshellread osshellwrite ossleep ostempdir ostempfile ostid ostime ostimestamp oswait oswrite output outputl outputt parse parser paste pasteall paster pasterall pop popper prefix prefixer print printl println printt printx put pwr quote quoter raise raiser range read readc readf readnext reccount remove remover renamefile replace replacer reverse reverse_range reverser rex rnd rollbacktrans round savelist search select selectkeys selectx setlasterror setprecision setprompt setxlocale shuffle shuffler sin sort sorter space split sqlexec sqrt squote squoter starts statustrans str substr substr2 substr3 substrer sum sumall swap tan tcase tcaser textchr textchrname textconvert textconverter textlen textord textwidth time to toBool toChar toDouble toInt toInt64 toString to_codepage to_u32string to_wstring trim trimboth trimfirst trimlast trimmer trimmerboth trimmerfirst trimmerlast ucase ucaser unassigned unique uniquer unlock unlockall unquote unquoter update updatekey updater updaterecord var var_base var_iter var_mid var_proxy1 var_proxy2 var_proxy3 varint_t version with write writec writef xlate dim _dim cols dim getelementref init join operator osread oswrite read redim reverser rows shuffler sort sorter split splitter write ExoProgram _ExoProgram AT ExoProgram abort abortall amountunit at calculate chain clearselect debug decide deletelist deleterecord elapsedtimetext esctoexit execute exoprog_date exoprog_number formlist fsmsg getcursor getdatetime getlist hasnext iconv invertarray libinfo lockrecord logoff makelist note oconv otherdatasetusers otherdatausers otherusers perform popselect pushselect readnext savelist select selectkeys setcursor sortarray stop timedate2 unlockrecord xlate FlowControl _FlowControl call func function gosub subr subroutine';
    // Merge with original keywords
    const extendedKeywords = {
        keyword: (cpp.keywords.keyword || '') + ' ' + customKeywords,
        literal: cpp.keywords.literal || '',
        built_in: cpp.keywords.built_in || ''
    };


    // Return the extended language definition
    return {
        name: 'C++',
        keywords: extendedKeywords,
        contains: cpp.contains,
        illegal: cpp.illegal,
        case_insensitive: cpp.case_insensitive || false
    };
});




        hljs.highlightAll();
    </script>
</body>
</body>
</html>
</html>

Revision as of 14:13, 8 April 2025

<!DOCTYPE html>

Sections:

  1. var
  2. dim
  3. exoprog
Var Creation
Use Function Description
var v1;

Create an unassigned var.

Unassigned variables can be assigned conditionally in if/else statements or used as outbound arguments of function calls.

A runtime error is thrown if a var is used before being assigned so silent "use before assign" bugs cannot occur.
var client; // Unassigned var
if (not read(client from "xo_clients", "SB001")) ...
//             Exodus keywords:     C++ declarations:
//             Non-Const   Const    Non-Const   Const
//             -----------------    ----------------------
// Variable:   var         let      var         const var
// Reference:  out         in       var&        const var&
var v1 = expression;

Assign a var using a literal or an expression.

Use "let" instead of "var" wherever possible as a shorthand way of writing "const var".
var v1 = 42;                 // Integer
var v2 = 42.3;               // Double
var v3 = "abc";              // String
var v4 = 'x';                // char
var v5 = true;               // bool

var v6 = v1 + 100;           // Arithmetic
var v7 = v3 ^ "xyz";         // Concatenation
var v8 = oslist(".").sort(); // Built in functions

let v9 = 12345;              // A const var

var v10 = 12'345_var;        // A literal var integer
var v11 = 123.45_var;        // A literal var double
var v12 = "f1^v1]v2^f3"_var; // A literal var string

var x = 0.1, y = "0.2", z = x + y; // z -> 0.3
ifv1.assigned() Returns: True if the var is assigned, otherwise false
ifv1.unassigned() Returns: True if the var is unassigned, otherwise false
var=v2.or_default(defaultvalue)

Returns: A copy of the var if it is assigned or the default value if it is not.

Can be used to handle optional arguments in functions.

defaultvalue: Cannot be unassigned.

var v1; // Unassigned
var v2 = v1.or_default("abc"); // v2 -> "abc"
// or
var v3 = or_default(v1, "abc");

Mutator: defaulter()

v1.defaulter(defaultvalue)

If the var is unassigned then assign the default value to it, otherwise do nothing.

defaultvalue: Cannot be unassigned.
var v1; // Unassigned
v1.defaulter("abc"); // v1 -> "abc"
// or
defaulter(v1, "abc");
v1.swap(io v2)

Swap the contents of one var with another.

Useful for stashing large strings quickly. They are moved using pointers without making copies or allocating memory.

Eiher or both variables may be unassigned.
var v1 = space(65'536);
var v2 = "";
v1.swap(v2); // v1 -> "" // v2.len() -> 65'536
// or
swap(v1, v2);
var=v2.move()

Force the contents of a var to be moved instead of copied. The moved var becomes an empty string.

This allows large strings to be handled efficiently. They are moved using pointers without making copies or allocating memory.

The moved var must be assigned otherwise a VarUnassigned error is thrown.
var v1 = space(65'536);
var v2 = v1.move(); // v2.len() -> 65'536 // v1 -> ""
// or
var v3 = move(v2);
var=v2.clone()

Returns a copy of the var.

The cloned var may be unassigned, in which case the copy will be unassigned too.
var v1 = "abc";
var v2 = v1.clone(); // "abc"
// or
var v3 = clone(v2);
var=v1.dump()

Return a string describing internal data of a var.

If the str is located on the heap then its address is given.

typ:

0x01 str is available.

0x02 int is available.

0x04 dbl is available.

0x08 nan: str is not a number.

0x16 osfile: str, int and dbl have special meaning.
var v1 = str("x", 32);
v1.dump().outputl(); /// e.g. var:0x7ffea7462cd0 typ:1 str:0x584d9e9f6e70 "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
// or
outputl(dump(v1));
Arithmetical Operators
Use Function Description
ifv1.isnum()

Checks if a var is numeric.

Returns: True if a var holds a double, an integer, or a string that is defined as numeric.

A string is defined as numeric only if it consists of one or more digits 0-9, with an optional decimal point "." placed anywhere, with an optional + or - sign prefix, or it is the empty string "", which is defined to be zero.
if ("+123.45"_var.isnum()) ... ok
if (       ""_var.isnum()) ... ok
if (not   "."_var.isnum()) ... ok
// or
if (isnum("123.")) ... ok
var=v1.num()

Returns a copy of the var if it is numeric or 0 otherwise.

Returns: A guaranteed numeric var

Allows working numerically with data that may be non-numeric.
var v1 = "123.45"_var.num();    // 123.45
var v2 = "abc"_var.num() + 100; // 100
var=v2 + v3

Addition

Attempts to perform numeric operations on non-numeric strings will throw a runtime error VarNonNumeric.

Floating point numbers are implicitly converted to strings with no more than 12 significant digits of precision. This practically eliminates all floatng point rounding errors.

Internally, 0.1 + 0.2 looks like this using doubles.

0.10000000000000003 + 0.20000000000000004 -> 0.30000000000000004
var v1 = 0.1;
var v2 = v1 + 0.2; // 0.3
var=v2 - v3Subtraction
var=v2 * v3Multiplication
var=v2 / v3Division
var=v2 % v3Modulus
v1 += v2Self addition
var v1 = 0.1;
v1 += 0.2; // 0.3
v1 -= v2Self subtraction
v1 *= v2Self multiplication
v1 /= v2Self division
v1 %= v2Self modulus
v1 ++Post increment
var v1 = 3;
var v2 = v1 ++; // v2 -> 3 // v1 -> 4
v1 --Post decrement
var v1 = 3;
var v2 = v1 --; // v2 -> 3 // v1 -> 2
++ v1Pre increment
var v1 = 3;
var v2 = ++ v1; // v2 -> 4 // v1 -> 4
-- v1Pre decrement
var v1 = 3;
var v2 = -- v1; // v2 -> 2 // v1 -> 2
Dynamic Array Creation, Access And Update
Use Function Description
var=""_var

The literal suffix "_var" allows dynamic arrays to be seamlessly embedded in code using a predefined set of visible equivalents of unprintable field mark characters as follows:

Visible Unprintable

* ` RM Record mark

* ^ FM Field mark

* ] VM Value mark

* } SM Subvalue mark

* | TM Text mark

* ~ ST Subtext mark
var v1 = "f1^f2^v1]v2^f4"_var; // "f1" _FM "f2" _FM "v1" _VM "v2" _FM "f4"
var v1 = {"a", "b", "c" ...}; // Initializer listCreate a dynamic array var from a list. C++ constrains list elements to be all the same type: var, string, double, int, etc. but they all end up as fields of a dynamic array string.
var v1 = {11, 22, 33}; // "11^22^33"_var
var=v2(fieldno); v1(fieldno) = v2

Dynamic array - field extraction, update and append:

See also inserter() and remover().

var v1 = "aa^bb"_var;
v1(4) = 44; // v1 -> "aa^bb^^44"_var
// Field number -1 causes appending a field when updating.
v1(-1) = "55"; // v1 -> "aa^bb^^44^55"_var
Field access:

It is recommended to use "v1.f(fieldno)" syntax using a ".f(" prefix to access fields in expressions instead of plain "v1(fieldno)". The former syntax (using .f()) will always compile whereas the latter does not compile in all contexts. It will compile only if being called on a constant var or in a location which requires a var. This is due to C++ not making a clear distinction between usage on the left and right side of assignment operator =.

Furthermore using plain round brackets without the leading .f can be confused with function call syntax.
var v1 = "aa^bb^cc"_var;
var v2 = v1.f(2); // "bb" /// .f() style access. Recommended.
var v3 =   v1(2); // "bb" ///   () style access. Not recommended.
var=v2(fieldno, valueno); v1(fieldno, valueno) = v2

Dynamic array - value update and append

See also inserter() and remover().
var v1 = "aa^b1]b2^cc"_var;
v1(2, 4) = "44"; // v1 -> "aa^b1]b2]]44^cc"_var
// value number -1 causes appending a value when updating.
v1(2, -1) = 55; // v1 -> "aa^b1]b2]]44]55^cc"_var
Value access:
var v1 = "aa^b1]b2^cc"_var;
var v2 = v1.f(2,2); // "b2" /// .f() style access. Recommended.
var v3 =   v1(2,2); // "b2" ///   () style access. Not recommended.
String Creation
Use Function Description
var=v2 ^ v3

String concatention operator ^

At least one side must be a var.

"aa" ^ "22" will not compile but "aa" "22" will.

Floating point numbers are implicitly converted to strings with no more than 12 significant digits of precision. This practically eliminates all floatng point rounding errors.
var v2 = "aa";
var v1 = v2 ^ 22; // "aa22"
v1 ^= v2String self concatention ^= (append)
var v1 = "aa";
v1 ^= 22; // v1 -> "aa22"
var=varnum.round(ndecimals = 0)

Convert a number into a string after rounding it to a given number of decimal places.

Trailing zeros are not omitted. A leading "0." is shown where appropriate.

0.5 always rounds away from zero. i.e. 1.5 -> 2 and -2.5 -> -3

var: The number to be converted.

ndecimals: Determines how many decimal places are shown to the right of the decimal point or, if ndecimals is negative, how many 0's to the left of it.

Returns: A var containing an ASCII string of digits with a leading "-" if negative, and a decimal point "." if ndecimals is > 0.
let v1 = var(0.295).round(2);  //  "0.30"
// or
let v2 = round(1.295, 2);      //  "1.30"

var v3 = var(-0.295).round(2); // "-0.30"
// or
var v4 = round(-1.295, 2);     // "-1.30"

var v5 = round(0, 1);           // "0.0"
var v6 = round(0, 0);           // "0"
var v7 = round(0, -1);          // "0"
Negative number of decimals rounds to the left of the decimal point
let v1 = round(123456.789,  0); // "123457"
let v2 = round(123456.789, -1); // "123460"
let v3 = round(123456.789, -2); // "123500"
var=var::chr(num)

Get a char given an integer 0-255.

Returns: A string containing a single char

0-127 -> ASCII, 128-255 -> invalid UTF-8 which cannot be written to the database or used in many exodus string operations
let v1 = var::chr(0x61); // "a"
// or
let v2 = chr(0x61);
var=var::textchr(num)

Get a Unicode character given a Unicode Code Point (Number)

Returns: A single Unicode character in UTF8 encoding.
let v1 = var::textchr(171416); // "𩶘" // or "\xF0A9B698"
// or
let v2 = textchr(171416);
var=var::textchrname(unicode_code_point)

Get a Unicode character name

unicode_code_point: 0 - 0x10FFFF.

Returns: Text of the name or "" if not a valid Unicode Code Point
let v1 = var::textchrname(91); // "LEFT SQUARE BRACKET"
// or
let v2 = textchrname(91);
var=strvar.str(num)

Get a string of repeated substrings.

var: The substring to be repeated

num: How many times to repeat the substring

Returns: A string
let v1 = "ab"_var.str(3); // "ababab"
// or
let v2 = str("ab", 3);
var=var::space(nspaces)

Get a string containing a given number of spaces.

nspaces: The number of spaces required.

Returns: A string of space chars.
let v1 = var::space(3); // "␣␣␣"
// or
let v2 = space(3);
var=varnum.numberinwords(locale = "")

Returns: A string representing a given number written in words instead of digits.

locale: e.g. en_GB, ar_AE, el_CY, es_US, fr_FR etc or a language name e.g. "french".
let softhyphen = "\xc2\xad";
let v1 = var(123.45).numberinwords("de_DE").replace(softhyphen, " "); // "ein␣hundert␣drei␣und␣zwanzig␣Komma␣vier␣fünf"
String Scanning
Use Function Description
var=strvar.at(pos1)

Get a single char from a string.

pos1: First char is 1. Last char is -1.

Returns: A single char if pos1 +/- the length of the string, or "" if greater. Returns the first char if pos1 is 0 or (-pos1) > length.
var v1 = "abc";
var v2 = v1.at(2);  // "b"
var v3 = v1.at(-3); // "a"
var v4 = v1.at(4);  // ""
var=strvar.ord()

Get the char number of a char

Returns: A number between 0 and 255.

If given a string, then only the first char is considered.

Equivalent to ord() in php
let v1 = "abc"_var.ord(); // 0x61 // decimal 97, 'a'
// or
let v2 = ord("abc");
var=strvar.textord()

Get the Unicode Code Point of a Unicode character.

var: A UTF-8 string. Only the first Unicode character is considered.

Returns: A number 0 to 0x10FFFF.

Equivalent to ord() in python and ruby, mb_ord() php.
let v1 = "Γ"_var.textord(); // 915 // U+0393: Greek Capital Letter Gamma (Unicode character)
// or
let v2 = textord("Γ");
var=strvar.len()

Get the length of a source string in number of chars

Returns: A number
let v1 = "abc"_var.len(); // 3
// or
let v2 = len("abc");
ifstrvar.empty()

Checks if the var is an empty string.

Returns: True if it is empty amd false if not.

This is a shorthand and more expressive way of writing 'if (var == "")' or 'if (var.len() == 0)' or 'if (not var.len())'

Note that 'if (var.empty())' is not exactly the same as 'if (not var)' because 'if (var("0.0")' is also defined as false. If a string can be converted to 0 then it is considered to be false. Contrast this with common scripting languages where 'if (var("0"))' is defined to be true.
let v1 = "0";
if (not v1.empty()) ... ok // true
// or
if (not empty(v1)) ... ok // true
var=strvar.textwidth()

Count the number of output columns required for a given source string.

Returns: A number

Allows wide multi-column Unicode characters that occupy more than one space in a text file or terminal screen.

Reduces combining characters to a single column. e.g. "e" followed by grave accent is multiple bytes but only occupies one output column.

Does not properly calculate all possible combining sequences of graphemes e.g. face followed by colour
let v1 = "🤡x🤡"_var.textwidth(); // 5
// or
let v2 = textwidth("🤡x🤡");
var=strvar.textlen()

Count the number of Unicode code points in a source string.

Returns: A number.
let v1 = "Γιάννης"_var.textlen(); // 7
// or
let v2 = textlen("Γιάννης");
var=strvar.fcount(sepstr)

Count the number of fields in a source string.

sepstr: The separator character or substr that delimits individual fields.

Returns: The count of the number of fields

This is similar to "var.count(sepstr) + 1" but it returns 0 for an empty source string.
let v1 = "aa**cc"_var.fcount("*"); // 3
// or
let v2 = fcount("aa**cc", "*");
var=strvar.count(sepstr)

Count the number of occurrences of a given substr in a source string.

substr: The substr to count.

Returns: The count of the number of sepstr found.

Overlapping substrings are not counted.
let v1 = "aa**cc"_var.count("*"); // 2
// or
let v2 = count("aa**cc", "*");
ifstrvar.starts(prefix)

Checks if a source string starts with a given prefix (substr).

prefix: The substr to check for.

Returns: True if the source string starts with the given prefix.

Returns: False if prefix is "". DIFFERS from c++, javascript, python3. See contains() for more info.
if ("abc"_var.starts("ab")) ... true
// or
if (starts("abc", "ab")) ... true
ifstrvar.ends(suffix)

Checks if a source string ends with a given suffix (substr).

suffix: The substr to check for.

Returns: True if the source string ends with given suffix.

Returns: False if suffix is "". DIFFERS from c++, javascript, python3. See contains() for more info.
if ("abc"_var.ends("bc")) ... true
// or
if (ends("abc", "bc")) ... true
ifstrvar.contains(substr)

Checks if a given substr exists in a source string.

substr: The substr to check for.

Returns: True if the source string starts with, ends with or contains the given substr.

Returns: False if suffix is "". DIFFERS from c++, javascript, python3

Human logic: "" is not equal to "x" therefore x does not contain "".

Human logic: Check each item (character) in the list for equality with what I am looking for and return success if any are equal.

Programmer logic: Compare as many characters as are in the search string for presence in the list of characters and return success if there are no failures.
if ("abcd"_var.contains("bc")) ... true
// or
if (contains("abcd", "bc")) ... true
var=strvar.index(substr, startchar1 = 1)

Find a substr in a source string.

substr: The substr to search for.

startchar1: The char position (1 based) to start the search at. The default is 1, the first char.

Returns: The char position (1 based) that the substr is found at or 0 if not present.
let v1 = "abcd"_var.index("bc"); // 2
// or
let v2 = index("abcd", "bc");
var=strvar.indexn(substr, occurrence)

Find the nth occurrence of a substr in a source string.

substr: The string to search for.

Returns: char position (1 based) or 0 if not present.
let v1 = "abcabc"_var.indexn("bc", 2); // 5
// or
let v2 = indexn("abcabc", "bc", 2);
var=strvar.indexr(substr, startchar1 = -1)

Find the position of substr working backwards from the end of the string towards the beginning.

substr: The string to search for.

Returns: The char position of the substr if found, or 0 if not.

startchar1: defaults to -1 meaning start searching from the last char. Positive start1char1 counts from the beginning of the source string and negative startchar1 counts backwards from the last char.
let v1 = "abcabc"_var.indexr("bc"); // 5
// or
let v2 = indexr("abcabc", "bc");
var=strvar.match(regex_str, regex_options = "")

Finds all matches of a given regular expression.

Returns: Zero or more matching substrings separated by FMs. Any groups are in VMs.

let v1 = "abc1abc2"_var.match("BC(\\d)", "i"); // "bc1]1^bc2]2"_var
// or
let v2 = match("abc1abc2", "BC(\\d)", "i");

regex_options:

* l - Literal (any regex chars are treated as normal chars)

* i - Case insensitive

* p - ECMAScript/Perl (the default)

* b - Basic POSIX (same as sed)

* e - Extended POSIX

* a - awk

* g - grep

* eg - egrep or grep -E

char ranges like a-z are locale sensitive if ECMAScript

regex_options:

* m - Multiline. Default in boost (and therefore exodus)

* s - Single line. Default in std::regex

* f - First only. Only for replace() (not match() or search())

* w - Wildcard glob style (e.g. *.cfg) not regex style. Only for match() and search(). Not replace().

var=strvar.match(regex)Ditto
var=strvar.search(regex_str, io startchar1, regex_options = "")

Search for the first match of a regular expression.

startchar1: [in] char position to start the search from

startchar1: [out] char position to start the next search from or 0 if no more matches.

Returns: The 1st match like match()

regex_options as for match()
var startchar1 = 1;
let v1 = "abc1abc2"_var.search("BC(\\d)", startchar1, "i"); // "bc1]1"_var // startchar1 -> 5 /// Ready for the next search
// or
startchar1 = 1;
let v2 = search("abc1abc2", "BC(\\d)", startchar1, "i");
var=strvar.search(regex_str)Ditto starting from first char
var=strvar.search(regex, io startchar1)Ditto given a rex
var=strvar.search(regex)Ditto starting from first char.
var=strvar.hash(std::uint64_t modulus = 0)

Get a hash of a source string.

modulus: The result is limited to [0, modulus)

Returns: A 64 bit signed integer.

MurmurHash3 is used.
let v1 = "abc"_var.hash(); assert(v1 == var(6'715'211'243'465'481'821));
// or
let v2 = hash("abc");
String Conversion - Non-Mutating - Chainable
Use Function Description
var=strvar.ucase()Convert to upper case
let v1 = "Γιάννης"_var.ucase(); // "ΓΙΆΝΝΗΣ"
// or
let v2 = ucase("Γιάννης");
var=strvar.lcase()Convert to lower case
let v1 = "ΓΙΆΝΝΗΣ"_var.lcase(); // "γιάννης"
// or
let v2 = lcase("ΓΙΆΝΝΗΣ");
var=strvar.tcase()

Convert to title case.

Returns: Original source string with the first letter of each word is capitalised.
let v1 = "γιάννης παππάς"_var.tcase(); // "Γιάννης Παππάς"
// or
let v2 = tcase("γιάννης παππάς");
var=strvar.fcase()

Convert to folded case.

Returns the source string standardised in a way to enable consistent indexing and searching,

Case folding is the process of converting text to a case independent representation.

https://www.w3.org/International/wiki/Case_folding

Accents can be significant. As in French cote, coté, côte and côté.

Case folding is not locale-dependent.
let v1 = "Grüßen"_var.fcase(); // "grüssen"
// or
let v2 = tcase("Grüßen");
var=strvar.normalize()

Replace Unicode character sequences with their standardised NFC form.

Unicode normalization is the process of converting Unicode strings to a standard form, making them binary comparable and suitable for text processing and comparison. It is an important part of Unicode text processing.

For example, Unicode character "é" can be represented by either a single Unicode character, which is Unicode Code Point (\u00E9" - Latin Small Letter E with Acute), or a combination of two Unicode code points i.e. the ASCII letter "e" and a combining acute accent (Unicode Code Point "\u0301"). Unicode NFC definition converts the pair of code points to the single code point.

Normalization is not locale-dependent.
let v1 = "cafe\u0301"_var.normalize(); // "caf\u00E9" // "café"
// or
let v2 = normalize("cafe\u0301");
var=strvar.invert()

Simple reversible disguising of string text.

It works by treating the string as UTF8 encoded Unicode code points and inverting the first 8 bits of their Unicode Code Points.

Returns: A string.

invert(invert()) returns to the original text.

ASCII bytes become multibyte UTF-8 so string sizes increase.

Inverted characters remain on their original Unicode Code Page but are jumbled up.

Non-existant Unicode Code Points may be created but UTF8 encoding remains valid.
let v1 = "abc"_var.invert(); // "\xC2" "\x9E" "\xC2" "\x9D" "\xC2" "\x9C"
// or
let v2 = invert("abc");
var=strvar.lower()

Reduce all types of field mark chars by one level.

Convert all FM to VM, VM to SM etc.

Returns: The converted string.

Note that subtext ST chars are not converted because they are already the lowest level.

String size remains identical.
let v1 = "a1^b2^c3"_var.lower(); // "a1]b2]c3"_var
// or
let v2 = lower("a1^b2^c3"_var);
var=strvar.raise()

Increase all types of field mark chars by one level.

Convert all VM to FM, SM to VM etc.

Returns: The converted string.

The record mark char RM is not converted because it is already the highest level.

String size remains identical.
let v1 = "a1]b2]c3"_var.raise(); // "a1^b2^c3"_var
// or
let v2 = "a1]b2]c3"_var;
var=strvar.crop()Remove any redundant FM, VM etc. chars (Trailing FM; VM before FM etc.)
let v1 = "a1^b2]]^c3^^"_var.crop(); // "a1^b2^c3"_var
// or
let v2 = crop("a1^b2]]^c3^^"_var);
var=strvar.quote()Wrap in double quotes.
let v1 = "abc"_var.quote(); // "\"abc\""
// or
let v2 = quote("abc");
var=strvar.squote()Wrap in single quotes.
let v1 = "abc"_var.squote(); // "'abc'"
// or
let v2 = squote("abc");
var=strvar.unquote()Remove one pair of surrounding double or single quotes.
let v1 = "'abc'"_var.unquote(); // "abc"
// or
let v2 = unquote("'abc'");
var=strvar.trim(trimchars = " ")

Remove all leading, trailing and excessive inner bytes.

trimchars: The chars (bytes) to remove. The default is space.
let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trim(); // "a1␣b2␣c3"
// or
let v2 = trim("␣␣a1␣␣b2␣c3␣␣");
var=strvar.trimfirst(trimchars = " ")Ditto but only leading.
let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimfirst(); // "a1␣␣b2␣c3␣␣"
// or
let v2 = trimfirst("␣␣a1␣␣b2␣c3␣␣");
var=strvar.trimlast(trimchars = " ")Ditto but only trailing.
let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimlast(); // "␣␣a1␣␣b2␣c3"
// or
let v2 = trimlast("␣␣a1␣␣b2␣c3␣␣");
var=strvar.trimboth(trimchars = " ")Ditto but only leading and trailing, not inner.
let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimboth(); // "a1␣␣b2␣c3"
// or
let v2 = trimboth("␣␣a1␣␣b2␣c3␣␣");
var=strvar.first()

Get the first char of a string.

Returns: A char, or "" if empty.

Equivalent to var.substr(1,length) or var[1, length] in Pick OS
let v1 = "abc"_var.first(); // "a"
// or
let v2 = first("abc");
var=strvar.last()

Get the last char of a string.

Returns: A char, or "" if empty.

Equivalent to var.substr(-1, 1) or var[-1, 1] in Pick OS
let v1 = "abc"_var.last(); // "c"
// or
let v2 = last("abc");
var=strvar.first(length)

Get the first n chars of a source string.

length: The number of chars (bytes) to get.

Returns: A string of up to n chars.

Equivalent to var.substr(1, length) or var[1, length] in Pick OS
let v1 = "abc"_var.first(2); // "ab"
// or
let v2 = first("abc", 2);
var=strvar.last(length)

Extract up to length trailing chars

Equivalent to var.substr(-length, length) or var[-length, length] in Pick OS
let v1 = "abc"_var.last(2); // "bc"
// or
let v2 = last("abc", 2);
var=strvar.cut(length)

Remove n chars (bytes) from the source string.

length: Positive to remove first n chars or negative to remove the last n chars.

If the absolute value of length is >= the number of chars in the source string then all chars will be removed.

Equivalent to var.substr(length) or var[1, length] = "" in Pick OS
let v1 = "abcd"_var.cut(2); // "cd"
// or
let v2 = cut("abcd", 2);
var=strvar.paste(pos1, length, replacestr)

Insert a substr at an given position after removing a given number of chars.

pos1: 0 or 1 : Remove length chars from the beginning and insert at the beginning.

pos1: > than the length of the source string. Insert after the last char.

pos1: -1 : Remove up to length chars before inserting.Insert on or before the last char.

pos1: -2 : Insert on or before the penultimate char.

Equivalent to var[pos1, length] = substr in Pick OS
let v1 = "abcd"_var.paste(2, 2, "XYZ"); // "aXYZd"
// or
let v2 = paste("abcd", 2, 2, "XYZ");
var=strvar.paste(pos1, insertstr)

Insert text at char position without overwriting any following chars

Equivalent to var[pos1, 0] = substr in Pick OS
let v1 = "abcd"_var.paste(2, "XYZ"); // "aXYZbcd"
// or
let v2 = paste("abcd", 2, "XYZ");
var=strvar.prefix(insertstr)

Insert text at the beginning

Equivalent to var[0, 0] = substr in Pick OS
let v1 = "abc"_var.prefix("XYZ"); // "XYZabc"
// or
let v2 = prefix("abc", "XYZ");
var=strvar.append(appendable, ...)Append anything at the end of a string
let v1 = "abc"_var.append(" is ", 10, " ok", '.'); // "abc is 10 ok."
// or
let v2 = append("abc", " is ", 10, " ok", '.');
var=strvar.pop()

Remove one trailing char.

Equivalent to var[-1, 1] = "" in Pick OS
let v1 = "abc"_var.pop(); // "ab"
// or
let v2 = pop("abc");
var=strvar.field(delimiter, fieldnx = 1, nfieldsx = 1)

Copies one or more consecutive fields from a string given a delimiter

delimiter: A Unicode character.

fieldno: The first field is 1, the last field is -1.

Returns: A substring
let v1 = "aa*bb*cc"_var.field("*", 2); // "bb"
// or
let v2 = field("aa*bb*cc", "*", 2);
let v1 = "aa*bb*cc"_var.field("*", -1); // "cc"
// or
let v2 = field("aa*bb*cc", "*", -1);
var=strvar.field2(separator, fieldno, nfields = 1)
var=strvar.fieldstore(separator, fieldno, nfields, replacement)

fieldstore() replaces, inserts or deletes subfields in a string.

fieldno: The field number to replace or, if not 1, the field number to start at. Negative fieldno counts backwards from the last field.

nfields: The number of fields to replace or, if negative, the number of fields to delete first. Can be 0 to cause simple insertion of fields.

replacement: A string that is the replacement field or fields.

Returns: A modified copy of the original string.

There is no way to simply delete n fields because the replacement argument cannot be omitted, however one can achieve the same result by replacing n+1 fields with the n+1th field.

The replacement can contain multiple fields itself. If replacing n fields and the replacement contains < n fields then the remaining fields become "". Conversely, if the replacement contains more fields than are required, they are discarded.
let v1 = "aa,bb,cc,dd,ee"_var.fieldstore(",", 2, 3, "11,22"); // "aa,11,22,,ee"
// or
let v2 = fieldstore("aa,bb,cc,dd,ee", ",", 2, 3, "11,22");
If nfields is 0 then insert the replacement field(s) before fieldno
let v1 = "aa,bb,cc,dd,ee"_var.fieldstore(",", 2, 0, "11,22"); // "aa,11,22,bb,cc,dd,ee"
If nfields is negative then delete abs(n) fields before inserting whatever fields the replacement has.
let v1 = "aa,bb,cc,dd,ee"_var.fieldstore(",", 2, -2, "11"); // "aa,11,dd,ee"
If nfields exceeds the number of fields in the input then additional empty fields are added.
let v1 = "aa,bb,cc"_var.fieldstore(",", 6, 2, "11"); // "aa,bb,cc,,,11,"
var=strvar.substr(pos1, length)

substr version 1.

Copies a substr of length chars from a given a starting char position.

Returns: A substr or "".

pos1: The char position to start at. If negative then start from a position counting backwards from the last char

length: The number of chars to copy. If negative then copy backwards. This reverses the order of the chars in the returned substr.

Equivalent to var[start, length] in Pick OS

Not Unicode friendly.
let v1 = "abcd"_var.substr(2, 2); // "bc"
// or
let v2 = substr("abcd", 2, 2);
If pos1 is negative then start counting backwards from the last char
let v1 = "abcd"_var.substr(-3, 2); // "bc"
// or
let v2 = substr("abcd", -3, 2);
If length is negative then work backwards and return chars reversed
let v1 = "abcd"_var.substr(3, -2); // "cb"
// or
let v2 = substr("abcd", 3, -2); // "cb"
var=strvar.b(pos1, length)Abbreviated alias of substr version 1.
var=strvar.substr(pos1)

substr version 2.

Copies a substr from a given char position up to the end of the source string

Returns: A substr or "".

pos1: The char position to start at. If negative then start from a position counting backwards from the last char

Equivalent to var[pos1, 9999999] in Pick OS

Partially Unicode friendly but pos1 is in chars.
let v1 = "abcd"_var.substr(2); // "bcd"
// or
let v2 = substr("abcd", 2);
var=strvar.b(pos1)Shorthand alias of substr version 2.
var=strvar.substr(pos1, delimiterchars, out pos2)

substr version 3.

Copies a substr from a given char position up to (but excluding) any one of some given delimiter chars

Returns: A substr or "".

pos1: [in] The position of the first char to copy. Negative positions count backwards from the last char of the string.

pos2: [out] The position of the next delimiter char, or one char position after the end of the source string if no subsequent delimiter chars are found.

COL2: is a predefined variable that can be used for pos2 instead of declaring a variable.

An empty string may be returned if pos1 [in] points to one of the delimiter chars or points beyond the end of the source string.

Equivalent to var[pos1, ",."] in Pick OS (non-numeric length).

Works with any encoding including UTF8 for the source string but the delimiter chars are bytes.

Add 1 to pos2 to skip over the next delimiter char to copy the next substr

Works with any encoding including UTF8 for the source string but the delimiter chars are bytes.

This function is similar to std::string::find_first_of but that function only returns pos2.
var pos1 = 4;
let v1 = "12,45 78"_var.substr(pos1, ", ", COL2);  // v1 -> "45" // COL2 -> 6 // 6 is the position of the next delimiter char found.
// or
let v2 = substr("12,45 78", COL2 + 1, ", ", COL2); // v2 -> "78" // COL2 -> 9 // 9 is one after the end of the string meaning that none of the delimiter chars were found.
var=strvar.b(pos1, delimiterchars, out pos2)Shorthand alias of substr version 3.
var=strvar.substr2(io pos1, out delimiterno)

substr version 4.

Copies a substr from a given char position up to (but excluding) the next field mark char (RM, FM, VM, SM, TM, ST).

Returns: A substr or "".

pos1: [in] The position of the first char to copy. Negative positions count backwards from the last char of the string.

pos1: [out] The position of the first char of the next substr after whatever field mark char is found, or one char position after the end of the source string if no subsequent field mark char is found.

field_mark_no: [out] A number (1-6) indicating which of the standard field mark chars was found, or 0 if not.

An empty string may be returned if the pos1 [in] points to one of the field marks or beyond the end of the source string.

pos1 [out] is correctly positioned to copy the next substr.

Works with any encoding including UTF8. Was called "remove" in Pick OS.

The equivalent in Pick OS was the statement "Remove variable From string At column Setting flag"

...

This function is valuable for high performance processing of dynamic arrays.

It is notably used in "list" to print parallel columns of mixed combinations of multivalues/subvalues and text marks correctly lined up mv to mv, sv to sv, tm to tm even when particular values, subvalues and text fragments are missing from particular columns.

It is similar to version 3 of substr - substr(pos1, delimiterchars, pos2) except that in this version the delimiter chars are hard coded as the standard field mark chars (RM, FM, VM, SM, TM, ST) and it returns the first char position of the next substr, not the char position of the next field mark char.
var pos1 = 4, field_mark_no;
let v1 = "12^45^78"_var.substr2(pos1, field_mark_no);  // "45" // pos1 -> 7 // field_mark_no -> 2 // field_mark_no 2 means that a FM was found.
// or
let v2 = substr2("12^45^78"_var, pos1, field_mark_no); // "78" // pos1 -> 9 // field_mark_no -> 0 // field_mark_no 0 means that none of the standard field marks were found.
var=strvar.b2(io pos1, out field_mark_no)Shorthand alias of substr version 4.
var=strvar.convert(fromchars, tochars)

Convert or delete chars one for one to other chars

from_chars: chars to convert. If longer than to_chars then delete those characters instead of converting them.

to_chars: chars to convert to

Not UTF8 compatible.
let v1 = "abcde"_var.convert("aZd", "XY"); // "Xbce" // a is replaced and d is removed
// or
let v2 = convert("abcde", "aZd", "XY");
var=strvar.textconvert(fromchars, tochars)Ditto for Unicode code points.
let v1 = "a🤡b😀c🌍d"_var.textconvert("🤡😀", "👋"); // "a👋bc🌍d"
// or
let v2 = textconvert("a🤡b😀c🌍d", "🤡😀", "👋");
var=strvar.replace(fromstr, tostr)

Replace all occurrences of one substr with another.

Case sensitive.
let v1 = "Abc.Abc"_var.replace("bc", "X"); // "AX.AX"
// or
let v2 = replace("Abc Abc", "bc", "X");
var=strvar.replace(regex, replacement_str)

Replace substrings using a regular expression.

regex: A regular expression created by rex() or _rex.

replacement_str: A literal to replace all matched substrings.

The replacement string can include the following special replacement patterns:

Pattern Inserts

* $$ Inserts a "$".

* $& Inserts the matched substring. Equivalent to $0.

* $` Inserts the portion of the string that precedes the matched substring.

* $' Inserts the portion of the string that follows the matched substring.

* $n Inserts the nth (1-indexed) capturing group where n is a positive integer less than 100.
let v1 = "A a B b"_var.replace("[A-Z]"_rex, "'$0'"); // "'A' a 'B' b"
// or
let v2 = replace("A a B b", "[A-Z]"_rex, "'$0'");
var=strvar.replace(regex, ReplacementFunction auto repl_func)

Replace substrings using a regular expression and a custom function.

Allows complex string conversions.

repl_func: A function with arguments (in match_str) that returns a var to replace match_str. May be an inline anonymous lambda function (capturing or non-capturing).

e.g. [](auto match_str) {return match_str;} // Does nothing.

match_str: Text of a single match. If regex groups are used, match_str.f(1, 1) is the whole match, match_str.f(1, 2) is the first group, etc.
// Decode hex escape codes.
var v1 = R"(--\0x3B--\0x2F--)";                                 // Hex escape codes.
v1.replacer(
    R"(\\0x[0-9a-fA-F]{2,2})"_rex,                              // Finds \0xFF.
    [](auto match_str) {return match_str.cut(3).iconv("HEX");}  // Decodes to a char.
);
assert(v1 == "--;--/--");
// Reformat dates using groups.
var v2 = "Date: 03-15-2025";
v2.replacer(
    R"((\d{2})-(\d{2})-(\d{4}))"_rex,
    [](auto match_str) {return match_str.f(1, 4) ^ "-" ^ match_str.f(1, 2) ^ "-" ^ match_str.f(1, 3);}
);
assert(v2 == "Date: 2025-03-15");
var=strvar.unique()Remove duplicate fields in an FM or VM etc. separated list
let v1 = "a1^b2^a1^c2"_var.unique(); // "a1^b2^c2"_var
// or
let v2 = unique("a1^b2^a1^c2"_var);
var=strvar.sort(delimiter = FM)

Reorder fields in an FM or VM etc. separated list in ascending order

Numeric data:
let v1 = "20^10^2^1^1.1"_var.sort(); // "1^1.1^2^10^20"_var
// or
let v2 = sort("20^10^2^1^1.1"_var);
Alphabetic data:
let v1 = "b1^a1^c20^c10^c2^c1^b2"_var.sort(); // "a1^b1^b2^c1^c10^c2^c20"_var
// or
let v2 = sort("b1^a1^c20^c10^c2^c1^b2"_var);
var=strvar.reverse(delimiter = FM)Reorder fields in an FM or VM etc. separated list in descending order
let v1 = "20^10^2^1^1.1"_var.reverse(); // "1.1^1^2^10^20"_var
// or
let v2 = reverse("20^10^2^1^1.1"_var);
var=strvar.shuffle(delimiter = FM)Randomise the order of fields in an FM, VM separated list
let v1 = "20^10^2^1^1.1"_var.shuffle(); /// e.g. "2^1^20^1.1^10" (random order depending on initrand())
// or
let v2 = shuffle("20^10^2^1^1.1"_var);
var=strvar.parse(char sepchar = ' ')

Split a delimited string with embedded quotes into a dynamic array.

Can be used to process CSV data.

Replaces separator chars with FM chars except inside double or single quotes and ignoring escaped quotes \" \'
let v1 = "abc,\"def,\"123\" fgh\",12.34"_var.parse(','); // "abc^\"def,\"123\" fgh\"^12.34"_var
// or
let v2 = parse("abc,\"def,\"123\" fgh\",12.34", ',');
dim=strvar.split(delimiter = FM)

Split a delimited string into a dim array.

The delimiter can be multibyte Unicode.

Returns: A dim array.
dim d1 = "a^b^c"_var.split(); // A dimensioned array with three elements (vars)
// or
dim d2 = split("a^b^c"_var);
var=strvar.fieldstore(delimiter, fieldno, nfields, replacement)
String Mutation - Standalone Commands
Use Function Description
strvar.ucaser()

Upper case

All string mutators follow the same pattern as ucaser.
See the non-mutating functions for details.
var v1 = "abc";
v1.ucaser(); // "ABC"
// or
ucaser(v1);
strvar.lcaser()
strvar.tcaser()
strvar.fcaser()
strvar.normalizer()
strvar.inverter()
strvar.quoter()
strvar.squoter()
strvar.unquoter()
strvar.lowerer()
strvar.raiser()
strvar.cropper()
strvar.trimmer(trimchars = " ")
strvar.trimmerfirst(trimchars = " ")
strvar.trimmerlast(trimchars = " ")
strvar.trimmerboth(trimchars = " ")
strvar.firster()
strvar.laster()
strvar.firster(length)
strvar.laster(length)
strvar.cutter(length)
strvar.paster(pos1, length, insertstr)
strvar.paster(pos1, insertstr)
strvar.prefixer(insertstr)
strvar.appender(appendable, ...)
strvar.popper()
strvar.fieldstorer(delimiter, fieldno, nfields, replacement)
strvar.substrer(pos1, length)
strvar.substrer(pos1)
strvar.converter(from_chars, to_chars)
strvar.textconverter(from_characters, to_characters)
strvar.replacer(regex, tostr)
strvar.replacer(regex, ReplacementFunction auto repl_func)
strvar.replacer(fromstr, tostr)
strvar.uniquer()
strvar.sorter(delimiter = FM)
strvar.reverser(delimiter = FM)
strvar.shuffler(delimiter = FM)
strvar.parser(char sepchar = ' ')
I/O Conversion
Use Function Description
var=var.oconv(convstr)

Converts internal data to output external display format according to a given conversion code or pattern

If the internal data is invalid and cannot be converted then most conversions return the ORIGINAL data unconverted

Throws a runtime error VarNotImplemented if convstr is invalid

See [[#ICONV/OCONV PATTERNS]]
let v1 = var(30123).oconv("D/E"); // "21/06/2050"
// or
let v2 = oconv(30123, "D/E");
var=var.iconv(convstr)

Converts external data to internal format according to a given conversion code or pattern

If the external data is invalid and cannot be converted then most conversions return the EMPTY STRING ""

Throws a runtime error VarNotImplemented if convstr is invalid

See [[#ICONV/OCONV PATTERNS]]
let v1 = "21 JUN 2050"_var.iconv("D/E"); // 30123
// or
let v2 = iconv("21 JUN 2050", "D/E");
var=var.format(fmt_str, args, ...)

Classic format function in printf style

vars can be formatted either with C++ format codes e.g. {:_>8.2f}

or with exodus oconv codes e.g. {::MD20P|R(_)#8} as in the below example.
let v1 = var(12.345).format("'{:_>8.2f}'"); // "'___12.35'"
let v2 = var(12.345).format("'{::MD20P|R(_)#8}'");
// or
var v3 = format("'{:_>8.2f}'", var(12.345)); // "'___12.35'"
var v4 = format("'{::MD20P|R(_)#8}'", var(12.345));
var=strvar.from_codepage(codepage)

Converts from codepage encoded text to UTF-8 encoded exodus text

e.g. Codepage "CP1124" (Ukrainian).

Use Linux command "iconv -l" for complete list of code pages and encodings.
let v1 = "\xa4"_var.from_codepage("CP1124"); // "Є"
// or
let v2 = from_codepage("\xa4", "CP1124");
// U+0404 Cyrillic Capital Letter Ukrainian Ie Unicode character
var=strvar.to_codepage(codepage)Converts to codepage encoded text from exodus UTF-8 encoded text
let v1 = "Є"_var.to_codepage("CP1124").oconv("HEX"); // "A4"
// or
let v2 = to_codepage("Є", "CP1124").oconv("HEX");
Dynamic Array Functions
Use Function Description
var=strvar.f(fieldno, valueno = 0, subvalueno = 0)

f() is a highly abbreviated alias for the Pick OS field/value/subvalue extract() function.

"f()" can be thought of as "field" although the function can extract values and subvalues as well.

The convenient Pick OS angle bracket syntax for field extraction (e.g. xxx<20>) is not available in C++.

The abbreviated exodus field extraction function (e.g. xxx.f(20)) is provided instead since field access is extremely heavily used in source code.
let v1 = "f1^f2v1]f2v2]f2v3^f2"_var;
let v2 = v1.f(2, 2); // "f2v2"
var=strvar.extract(fieldno, valueno = 0, subvalueno = 0)Extract a specific field, value or subvalue from a dynamic array.
let v1 = "f1^f2v1]f2v2]f2v3^f2"_var;
let v2 = v1.extract(2, 2); // "f2v2"
//
// For brevity the function alias "f()" (standing for "field") is normally used instead of "extract()" as follows:
var v3 = v1.f(2, 2);
var=strvar.update(fieldno, valueno, subvalueno, replacement)

Same as var.updater() function but returns a new string instead of updating a variable in place.
Rarely used.

"update()" was called "replace()" in Pick OS/Basic.
var=strvar.update(fieldno, valueno, replacement)Ditto for a specific multivalue
var=strvar.update(fieldno, replacement)Ditto for a specific field
var=strvar.insert(fieldno, valueno, subvalueno, insertion)Same as var.inserter() function but returns a new string instead of updating a variable in place.
var=strvar.insert(fieldno, valueno, insertion)Ditto for a specific multivalue
var=strvar.insert(fieldno, insertion)Ditto for a specific field
var=strvar.remove(fieldno, valueno = 0, subvalueno = 0)

Same as var.remover() function but returns a new string instead of updating a variable in place.

"remove()" was called "delete()" in Pick OS/Basic.
Dynamic Array Filters
Use Function Description
var=strvar.sum()Sum up multiple values into one higher level
let v1 = "1]2]3^4]5]6"_var.sum(); // "6^15"_var
// or
let v2 = sum("1]2]3^4]5]6"_var);
var=strvar.sumall()Sum up all levels into a single figure
let v1 = "1]2]3^4]5]6"_var.sumall(); // 21
// or
let v2 = sumall("1]2]3^4]5]6"_var);
var=strvar.sum(delimiter)Ditto allowing commas etc.
let v1 = "10,20,30"_var.sum(","); // 60
// or
let v2 = sum("10,20,30", ",");
var=strvar.mv(opcode, var2)Binary ops (+, -, *, /) in parallel on multiple values
let v1 = "10]20]30"_var.mv("+","2]3]4"_var); // "12]23]34"_var
Dynamic Array Mutators Standalone Commands
Use Function Description
strvar.updater(fieldno, replacement)Replace a specific field in a dynamic array
var v1 = "f1^v1]v2}s2}s3^f3"_var;
v1.updater(2, "X"); // "f1^X^f3"_var
// or
v1(2) = "X"; /// Easiest.
// or
updater(v1, 2, "X");
strvar.updater(fieldno, valueno, replacement)Replace a specific value of a specific field in a dynamic array.
var v1 = "f1^v1]v2}s2}s3^f3"_var;
v1.updater(2, 2, "X"); // "f1^v1]X^f3"_var
// or
v1(2, 2) = "X"; /// Easiest.
// or
updater(v1, 2, 2, "X");
strvar.updater(fieldno, valueno, subvalueno, replacement)Replace a specific subvalue of a specific value of a specific field in a dynamic array.
var v1 = "f1^v1]v2}s2}s3^f3"_var;
v1.updater(2, 2, 2, "X"); // "f1^v1]v2}X}s3^f3"_var
// or
v1(2, 2, 2) = "X"; /// Easiest.
// or
updater(v1, 2, 2, 2, "X");
strvar.inserter(fieldno, insertion)Insert a specific field in a dynamic array, moving all other fields up.
var v1 = "f1^v1]v2}s2}s3^f3"_var;
v1.inserter(2, "X"); // "f1^X^v1]v2}s2}s3^f3"_var
// or
inserter(v1, 2, "X");
strvar.inserter(fieldno, valueno, insertion)Ditto for a specific value in a specific field, moving all other values up.
var v1 = "f1^v1]v2}s2}s3^f3"_var;
v1.inserter(2, 2, "X"); // "f1^v1]X]v2}s2}s3^f3"_var
// or
inserter(v1, 2, 2, "X");
strvar.inserter(fieldno, valueno, subvalueno, insertion)Ditto for a specific subvalue in a dynamic array, moving all other subvalues up.
var v1 = "f1^v1]v2}s2}s3^f3"_var;
v1.inserter(2, 2, 2, "X"); // "f1^v1]v2}X}s2}s3^f3"_var
// or
v1.inserter(2, 2, 2, "X");
strvar.remover(fieldno, valueno = 0, subvalueno = 0)Remove a specific field (or value, or subvalue) from a dynamic array, moving all other fields (or values, or subvalues) down.
var v1 = "f1^v1]v2}s2}s3^f3"_var;
v1.remover(2, 2); // "f1^v1^f3"_var
// or
remover(v1, 2, 2);
Use Function Description
var=strvar.locate(target)

locate() with only the target substr argument provided searches unordered values separated by any of the field mark chars.

Returns: The field, value, subvalue etc. number if found or 0 if not.

Searching for empty fields, values etc. (i.e. "") will work. Locating "" in "]yy" will return 1, in "xx]]zz" 2, and in "xx]yy]" 3, however, locating "" in "xx" will return 0 because there is conceptually no empty value in "xx". Locate "" in "" will return 1.
if ("UK^US^UA"_var.locate("US")) ... ok // 2
// or
if (locate("US", "UK^US^UA"_var)) ... ok
ifstrvar.locate(target, out valueno)

locate() with only the target substr provided and setting returned searches unordered values separated by any type of field mark chars.

Returns: True if found

Setting: Field, value, subvalue etc. number if found or the max number + 1 if not. Suitable for additiom of new values
var setting;
if ("UK]US]UA"_var.locate("US", setting)) ... ok // setting -> 2
// or
if (locate("US", "UK]US]UA"_var, setting)) ... ok
ifstrvar.locate(target, out setting, fieldno, valueno = 0)

locate() the target in unordered fields if fieldno is 0, or values if a fieldno is specified, or subvalues if the valueno argument is provided.

Returns: True if found and with the field, value or subvalue number in setting.

Returns: False if not found and with the max field, value or subvalue number found + 1 in setting. Suitable for replacement of new fields, values or subvalues.
var setting;
if ("f1^f2v1]f2v2]s1}s2}s3}s4^f3^f4"_var.locate("s4", setting, 2, 3)) ... ok // setting -> 4 // returns true
ifstrvar.locateby(ordercode, target, out valueno)

locateby() without fieldno or valueno arguments searches ordered values separated by VM chars.

The order code can be AL, DL, AR, DR meaning Ascending Left, Descending Right, Ascending Right, Ascending Left.

Left is used to indicate alphabetic order where 10 < 2.

Right is used to indicate numeric order where 10 > 2.

Data must be in the correct order for searching to work properly.

Returns: True if found.

In case the target is not exactly found then the correct value no for inserting the target is returned in setting.
var valueno; if ("aaa]bbb]ccc"_var.locateby("AL", "bb", valueno)) ... // valueno -> 2 // returns false and valueno = where it could be correctly inserted.
ifstrvar.locateby(ordercode, target, out setting, fieldno, valueno = 0)locateby() ordered as above but in fields if fieldno is 0, or values in a specific fieldno, or subvalues in a specific valueno.
var setting;
if ("f1^f2^aaa]bbb]ccc^f4"_var.locateby("AL", "bb", setting, 3)) ... // setting -> 2 // return false and where it could be correctly inserted.
ifstrvar.locateusing(usingchar, target)locate() a target substr in the whole unordered string using a given delimiter char returning true if found.
if ("AB,EF,CD"_var.locateusing(",", "EF")) ... ok
ifstrvar.locateusing(usingchar, target, out setting, fieldno = 0, valueno = 0, subvalueno = 0)

locate() the target in a specific field, value or subvalue using a specified delimiter and unordered data

Returns: True If found and returns in setting the number of the delimited field found.

Returns: False if not found and returns in setting the maximum number of delimited fields + 1 if not found.

This is similar to the main locate command but the delimiter char can be specified e.g. a comma or TM etc.
var setting;
if ("f1^f2^f3c1,f3c2,f3c3^f4"_var.locateusing(",", "f3c2", setting, 3)) ... ok // setting -> 2 // returns true
ifstrvar.locatebyusing(ordercode, usingchar, target, out setting, fieldno = 0, valueno = 0, subvalueno = 0)

locatebyusing() supports all the above features in a single function.

Returns: True if found.
Database Access
Use Function Description
ifconn.connect(conninfo = "")

For all DB operations, the operative var can either be a DB connection created with dbconnect() or be any var and a default connection will be established on the fly.

The DB connection string (conninfo) parameters are merged from the following places in descending priority.

1. Provided in connect()'s conninfo argument. See 4. for the complete list of parameters.

2. Any environment variables EXO_HOST EXO_PORT EXO_USER EXO_DATA EXO_PASS EXO_TIME

3. Any parameters found in a configuration file at ~/.config/exodus/exodus.cfg

4. The default conninfo is "host=127.0.0.1 port=5432 dbname=exodus user=exodus password=somesillysecret connect_timeout=10"

Setting environment variable EXO_DBTRACE=1 will cause tracing of DB interface including SQL commands.
var conn = "exodus";
if (not conn.connect("dbname=exodus user=exodus password=somesillysecret")) ...;
// or
if (not connect()) ...
// or
if (not connect("exodus")) ...
ifconn.attach(filenames)

"attach" causes the given filenames to be associated with a specific connection for the remainder of the session.

It is not necessary to attach files before opening them.

Attachments can changed by calling attach() or open() on a different connection or they can be removed by calling detach().

var: Defaults to the default connection.

filenames: FM separated list.

Returns: false if any filename does not exist and cannot be opened on the given connection. All filenames that can be opened on the conneciton are attached even if some cannot.

Internally, attach merely opens each filename on the given connection causing them to be added to an internal cache.
var conn = "exodus";
let filenames = "xo_clients^dict.xo_clients"_var;
if (conn.attach(filenames)) ... ok
// or
if (attach(filenames)) ... ok
conn.detach(filenames)

Removes files from the internal cache created by previous open() and attach() calls.

var: Defaults to the default connection.

filenames: FM separated list.

ifconn.begintrans()Begin a DB transaction.
var conn = "exodus";
if (not conn.begintrans()) ...
// or
if (not begintrans()) ...
ifconn.statustrans()Check if a DB transaction is in progress.
var conn = "exodus";
if (conn.statustrans()) ... ok
// or
if (statustrans()) ... ok
ifconn.rollbacktrans()Rollback a DB transaction.
var conn = "exodus";
if (conn.rollbacktrans()) ... ok
// or
if (rollbacktrans()) ... ok
ifconn.committrans()

Commit a DB transaction.

Returns: True if successfully committed or if there was no transaction in progress, otherwise false.
var conn = "exodus";
if (conn.committrans()) ... ok
// or
if (committrans()) ... ok
ifconn.sqlexec(sqlcmd)

Execute an sql command.

Returns: True if there was no sql error otherwise lasterror() returns a detailed error message.
var conn = "exodus";
if (conn.sqlexec("select 1")) ... ok
// or
if (sqlexec("select 1")) ... ok
ifconn.sqlexec(sqlcmd, io response)

Execute an SQL command and capture the response.

Returns: True if there was no sql error otherwise response contains a detailed error message.

response: Any rows and columns returned are separated by RM and FM respectively. The first row is the column names.

Recommended: Don't use sql directly unless you must to manage or configure a database.
var conn = "exodus";
let sqlcmd = "select 'xxx' as col1, 'yyy' as col2";
var response;
if (conn.sqlexec(sqlcmd, response)) ... ok // response -> "col1^col2\x1fxxx^yyy"_var /// \x1f is the Record Mark (RM) char. The backtick char is used here by gendoc to deliminate source code.
// or
if (sqlexec(sqlcmd, response)) ... ok
conn.disconnect()Closes DB connection and frees process resources both locally and in the database server.
var conn = "exodus";
conn.disconnect();
// or
disconnect();
conn.disconnectall()

Closes all connections and frees process resources both locally and in the database server(s).

All connections are closed automatically when a process terminates.
var conn = "exodus";
conn.disconnectall();
// or
disconnectall();
var=var::lasterror() Returns: The last OS or DB error message.
var v1 = var::lasterror();
// or
var v2 = lasterror();
conn.setlasterror(msg)Set the lasterror() message.
var::loglasterror(source = "")

Log the last OS or DB error message.

Output: to stdlog

Prefixes the output with source if provided.
var::loglasterror("main:");
// or
loglasterror("main:");
Database Management
Use Function Description
ifconn.dbcreate(new_dbname, old_dbname = "")

Create a named database on a particular connection.

The target database cannot already exist.

Optionally copies an existing database from the same connection and which cannot have any current connections.
var conn = "exodus";
if (not dbdelete("xo_gendoc_testdb")) {}; // Cleanup first
if (conn.dbcreate("xo_gendoc_testdb")) ... ok
// or
if (dbcreate("xo_gendoc_testdb")) ...
ifconn.dbcopy(from_dbname, to_dbname)

Create a named database as a copy of an existing database.

The target database cannot already exist.

The source database must exist on the same connection and cannot have any current connections.
var conn = "exodus";
if (not dbdelete("xo_gendoc_testdb2")) {}; // Cleanup first
if (conn.dbcopy("xo_gendoc_testdb", "xo_gendoc_testdb2")) ... ok
// or
if (dbcopy("xo_gendoc_testdb", "xo_gendoc_testdb2")) ...
var=conn.dblist() Returns: A list of available databases on a particular connection.
var conn = "exodus";
let v1 = conn.dblist();
// or
let v2 = dblist();
ifconn.dbdelete(dbname)

Delete (drop) a named database.

The target database must exist and cannot have any current connections.
var conn = "exodus";
if (conn.dbdelete("xo_gendoc_testdb2")) ... ok
// or
if (dbdelete("xo_gendoc_testdb2")) ...
ifconn.createfile(filename)

Create a named DB file.

filenames ending with "_temp" only last until the connection is closed.
let filename = "xo_gendoc_temp", conn = "exodus";
if (conn.createfile(filename)) ... ok
// or
if (createfile(filename)) ...
ifconn.renamefile(filename, newfilename)Rename a DB file.
let conn = "exodus", filename = "xo_gendoc_temp", new_filename = "xo_gendoc_temp2";
if (conn.renamefile(filename, new_filename)) ... ok
// or
if (renamefile(filename, new_filename)) ...
var=conn.listfiles() Returns: A list of all files in a database
var conn = "exodus";
if (not conn.listfiles()) ...
// or
if (not listfiles()) ...
ifconn.clearfile(filename)Delete all records in a DB file
let conn = "exodus", filename = "xo_gendoc_temp2";
if (not conn.clearfile(filename)) ...
// or
if (not clearfile(filename)) ...
ifconn.deletefile(filename)Delete a DB file
let conn = "exodus", filename = "xo_gendoc_temp2";
if (conn.deletefile(filename)) ... ok
// or
if (deletefile(filename)) ...
var=conn_or_file.reccount(filename = "")

Returns: The approx. number of records in a DB file.

Might return -1 if not known.

Not very accurate inside transactions.
let conn = "exodus", filename = "xo_clients";
var nrecs1 = conn.reccount(filename);
// or
var nrecs2 = reccount(filename);
ifconn_or_file.flushindex(filename = "")

Calls DB maintenance function for a file or all files.

This doesnt actually flush any indexes but does make sure that reccount() function is reasonably accurate.

Returns: True if successful otherwise false if not and with lasterror() set.
Database File I/O
Use Function Description
iffile.open(dbfilename, connection = "")

Opens a DB file to a var which can be used in subsequent DB function calls to access a specific file using a specific connection.

connection: If not specified and the filename is present in an internal cache of filenames and connections created by previous calls to open() or attach() then open() returns true. If it is not present in the cache then the default connection will be checked.

Returns: True if the filename was present in the cache OR if the DB connection reports that the file is present.
var file, filename = "xo_clients";
if (not file.open(filename)) ...
// or
if (not open(filename to file)) ...
file.close()

Closes DB file var

Does nothing currently since database file vars consume no resources
var file = "xo_clients";
file.close();
// or
close(file);
iffile.createindex(fieldname, dictfile = "")

Creates a secondary index for a given DB file and field name.

The fieldname must exist in a dictionary file. The default dictionary is "dict." ^ filename.

Returns: False if the index cannot be created for any reason.

* Index already exists

* File does not exist

* The dictionary file does not have a record with a key of the given field name.

* The dictionary file does not exist. Default is "dict." ^ filename.

* The dictionary field defines a calculated field that uses an exodus function. Using a psql function is OK.
var filename = "xo_clients", fieldname = "DATE_CREATED";
if (not deleteindex("xo_clients", "DATE_CREATED")) {}; // Cleanup first
if (filename.createindex(fieldname)) ... ok
// or
if (createindex(filename, fieldname)) ...
var=file|conn.listindex(file_or_filename = "", fieldname = "")

Lists secondary indexes in a database or for a DB file

Returns: False if the DB file or fieldname are given and do not exist
var conn = "exodus";
if (conn.listindex()) ... ok // includes "xo_clients__date_created"
// or
if (listindex()) ... ok
iffile.deleteindex(fieldname)

Deletes a secondary index for a DB file and field name.

Returns: False if the index cannot be deleted for any reason

* File does not exist

* Index does not already exists
var file = "xo_clients", fieldname = "DATE_CREATED";
if (file.deleteindex(fieldname)) ... ok
// or
if (deleteindex(file, fieldname)) ...
var=file.lock(key)

Places a metaphorical DB lock on a particular record given a DB file and key.

This is a advisory lock, not a physical lock, since it makes no restriction on the access or modification of data by other connections.

Neither the DB file nor the record key need to actually exist since a lock is just a hash of the DB file name and key combined.

If another connection attempts to place an identical lock on the same database it will be denied.

Locks can be removed by unlock() or unlockall() or will be automatically removed at the end of a transaction or when the connection is closed.

If the same process attempts to place an identical lock more than once it may be denied (if not in a transaction) or succeed but be ignored (if in a transaction).

Locks can be used to avoid processing a transaction simultaneously with another connection only to have one of them fail due to mutually updating the same records.

Returns:

* 0: Failure: Another connection has already placed the same lock.

* "" Failure: The lock has already been placed.

* 1: Success: A new lock has been placed.

* 2: Success: The lock has already been placed and the connection is in a transaction.
var file = "xo_clients", key = "1000";
if (file.lock(key)) ... ok
// or
if (lock(file, key)) ...
iffile.unlock(key)

Removes a DB lock placed by the lock function.

Only locks placed on the specified connection can be removed.

Locks cannot be removed while a connection is in a transaction.

Returns: False if the lock is not present in a connection.
var file = "xo_clients", key = "1000";
if (file.unlock(key)) ... ok
// or
if (unlock(file, key)) ...
iffile.unlockall()

Removes all DB locks placed by the lock function in the specified connection.

Locks cannot be removed while in a transaction.
var conn = "exodus";
if (not conn.unlockall()) ...
// or
if (not unlockall(conn)) ...
record.write(file, key)

Writes a record into a DB file given a unique primary key.

Either inserts a new record or updates an existing record.

Returns: Nothing since writes always succeed.

Throws: VarDBException if the file does not exist. Like most DB functions.

Any memory cached record is deleted.
let record = "Client GD^G^20855^30000^1001.00^20855.76539"_var;
let file = "xo_clients", key = "GD001";
//if (not "xo_clients"_var.deleterecord("GD001")) {}; // Cleanup first
record.write(file, key);
// or
write(record on file, key);
ifrecord.read(file, key)

Reads a record from a DB file for a given key.

file: A DB filename or a var opened to a DB file.

key: The key of the record to be read.

Returns: False if the key doesnt exist

var: Contains the record if it exists or is unassigned if not.

A special case of the key being "%RECORDS%" results in a fictitious "record" being returned as an FM separated list of all the keys in the DB file up to a maximum size of 4Mib, sorted in natural order.
var record;
let file = "xo_clients", key = "GD001";
if (not record.read(file, key)) ... // record -> "Client GD^G^20855^30000^1001.00^20855.76539"_var
// or
if (not read(record from file, key)) ...
iffile.deleterecord(key)

Deletes a record from a DB file given a key.

Returns: False if the key doesnt exist

Any memory cached record is deleted.

deleterecord(in file), a one argument free function, is available that deletes multiple records using the currently active select list.
let file = "xo_clients", key = "GD001";
if (file.deleterecord(key)) ... ok
// or
//if (deleterecord(file, key)) ...
ifrecord.insertrecord(file, key)

Inserts a new record in a DB file.

Returns: False if the key already exists

Any memory cached record is deleted.
let record = "Client GD^G^20855^30000^1001.00^20855.76539"_var;
let file = "xo_clients", key = "GD001";
if (record.insertrecord(file, key)) ... ok
// or
if (insertrecord(record on file, key)) ...
ifrecord.updaterecord(file, key)

Updates an existing record in a DB file.

Returns: False if no record with the given key exists.

Any memory cached record is deleted.
let record = "Client GD^G^20855^30000^1001.00^20855.76539"_var;
let file = "xo_clients", key = "GD001";
if (not record.updaterecord(file, key)) ...
// or
if (not updaterecord(record on file, key)) ...
ifrecord.updatekey(key, newkey)

Updates the key of an existing record in a DB file.

Returns: True if successful or false if no record with the given key exists, or a record with newkey already exists

Any memory cached records of either key are deleted.
let file = "xo_clients", key = "GD001", newkey = "GD002";
if (not file.updatekey(key, newkey)) ...
// or
if (not updatekey(file, newkey, key)) ... // Reverse the above change.
ifstrvar.readf(file, key, fieldno)"Read field" Same as read() but only returns a specific field number from the record.
var field, file = "xo_clients", key = "GD001", fieldno = 2;
if (not field.readf(file, key, fieldno)) ... // field -> "G"
// or
if (not readf(field from file, key, fieldno)) ...
strvar.writef(file, key, fieldno)"write field" Same as write() but only writes to a specific field number in the record
var field = "f3", file = "xo_clients", key = "1000", fieldno = 3;
field.writef(file, key, fieldno);
// or
writef(field on file, key, fieldno);
record.writec(file, key)

"Write cache" Writes a record and key into a memory cached "DB file".

The actual database file is NOT updated.

writec() either updates an existing cache record if the key already exists or otherwise inserts a new record into the cache.

It always succeeds so no result code is returned.

Neither the DB file nor the record key need to actually exist in the actual DB.
let record = "Client XD^X^20855^30000^1001.00^20855.76539"_var;
let file = "xo_clients", key = "XD001";
record.writec(file, key);
// or
writec(record on file, key);
ifrecord.readc(file, key)

"Read cache" Same as "read() but first reads from a memory cache.

1. Tries to read from a memory cache. Returns true if successful.

2a. Tries to read from the actual DB file and returns false if unsuccessful.

2b. Writes the record and key to the memory cache and returns true.

Cached DB file data lives in exodus process memory and is lost when the process terminates or clearcache() is called.
var record;
let file = "xo_clients", key = "XD001";
if (record.readc(file, key)) ... ok
// or
if (readc(record from file, key)) ... ok

// Verify not in actual database file by using read() not readc()
if (read(record from file, key)) abort("Error: " ^ key ^ " should not be in the actual database file"); // error
ifdbfile.deletec(key)

Deletes a record and key from a memory cached "file".

The actual database file is NOT updated.

Returns: False if the key doesnt exist
var file = "xo_clients", key = "XD001";
if (file.deletec(key)) ... ok
// or
if (deletec(file, key)) ...
conn.clearcache()

Clears the memory cache of all records for the given connection

All future cache readc() function calls will be forced to obtain records from the actual database and refresh the cache.
let conn = "exodus";
conn.clearcache();
// or
clearcache(conn);
var=strvar.xlate(filename, fieldno, mode)

The xlate ("translate") function is similar to readf() but, when called as an exodus program member function, it can be used efficiently with exodus file dictionaries using column names and functions and multivalued data.

Arguments:

strvar: Used as the primary key to lookup a field in a given file and field no or field name.

filename: The DB file in which to look up data.

If var key is multivalued then a multivalued field is returned.

fieldno: Determines which field of the record is returned.

* Integer returns that field number

* 0 means return the key unchanged.

* "" means return the whole record.

mode: Determines what is returned if the record does not exist for the given key and file.

* "X" returns ""

* "C" returns the key unconverted.
let key = "SB001";
let client_name = key.xlate("xo_clients", 1, "X"); // "Client AAA"
// or
let name_and_type = xlate("xo_clients", key, "NAME_AND_TYPE", "X"); // "Client AAA (A)"
Database Sort/Select
Use Function Description
ifdbfile.select(sort_select_command = "")

Create an active select list of keys of a database file.

The select(command) function searches and orders database records for subsequent processing given an English language-like command.

The primary job of a database, beyond mere storage and retrieval of information, is to allow rapid searching and ordering of information on demand.

In Exodus, searching and ordering of information is known as "sort/select" and is performed by the select() function.

Executing the select() function creates an "active select list" which can then be consumed by the readnext() function.

dbfile: A opened database file or file name, or an open connection or an empty var for default connections. Subsequent readnext calls must use the same.

sort_select_command: A natural language command using dictionary field names. The command can be blank if a dbfile or filename is given in dbfile or just a file name and all keys will be selected in undefined order.

Example: "select xo_clients with type 'B' and with balance ge 100 by type by name"

Option: "(R)" appended to the sort_select_command acquires the database records as well.

Returns: True if any records are selected or false if none.

Throws: VarDBException in case of any syntax error in the command.

Active select lists created using var.select()'s member function syntax cannot be consumed by the free function form of readnext() and vice versa.
var clients = "xo_clients";
if (clients.select("with type 'B' and with balance ge 100 by type by name"))
    while (clients.readnext(ID))
        println("Client code is {}", ID);
// or
if (select("xo_clients with type 'B' and with balance ge 100 by type by name"))
    while (readnext(ID))
        println("Client code is {}", ID);
ifdbfile.selectkeys(keys)

Create an active select list from a string of keys.

Similar to select() but creates the list directly from a var.

keys: An FM separated list of keys or key^VM^valueno pairs.

Returns: True if any keys are provided or false if not.
var dbfile = "";
let keys = "A01^B02^C03"_var;
if (dbfile.selectkeys(keys)) ... ok
assert(dbfile.readnext(ID) and ID == "A01");
// or
if (selectkeys(keys)) ... ok
assert(readnext(ID) and ID == "A01");
ifdbfile.hasnext()

Checks if a select list is active.

dbfile: A file or connection var used in a prior select, selectkeys or getlist function call.

Returns: True if a select list is active and false if not.

If it returns true then a call to readnext() will return a database record key, otherwise not.
var clients = "xo_clients", key;
if (clients.select()) {
    assert(clients.hasnext());
}
// or
if (select("xo_clients")) {
    assert(hasnext());
}
ifdbfile.readnext(out key)

Acquires and consumes one key from an active select list of database record keys.

dbfile: A file or connection var used in a prior select, selectkeys or getlist function call.

key: Returns the first (next) key present in an active select list or "" if no select list is active.

Returns: True if a list is active and a key is available, false if not.

Each call to readnext consumes one key from the list.

Once all the keys in an active select list have been consumed by calls to readnext, the list becomes inactive.

See select() for example code.

ifdbfile.readnext(out key, out valueno)

Similar to readnext(key) but multivalued.

If the active list was ordered by multivalued database fields then pairs of key and multivalue number will be available to the readnext function.

ifdbfile.readnext(out record, out key, out valueno)

Similar to readnext(key) but acquires the database record as well.

record: Returns the next database record from the select list assuming that the select list was created with the (R) option otherwise "" if not.

key: Returns the next database record key in the select list.

valueno: The multivalue number if the select list was ordered on multivalued database record fields or 1 if not.
var clients = "xo_clients";
if (clients.select("with type 'B' and with balance ge 100 by type by name (R)"))
    while (clients.readnext(RECORD, ID, MV))
        println("Code is {}, Name is {}", ID, RECORD.f(1));
// or
DICT = "dict.xo_clients";
if (select("xo_clients with type 'B' and with balance ge 100 by type by name (R)"))
    while (readnext(RECORD, ID, MV))
        println("Code is {}, Name is {}", calculate("CODE"), calculate("NAME"));
dbfile.clearselect()

Deactivates an active select list.

dbfile: A file or connection var used in a prior select, selectkeys or getlist function call.

Returns: Nothing

Has no effect if no select list is active for dbfile.
var clients = "xo_clients";
clients.clearselect();
if (not clients.hasnext()) ... ok
// or
clearselect();
if (not hasnext()) ... ok
ifdbfile.savelist(listname)

Stores an active select list for later retrieval.

dbfile: A file or connection var used in a prior select, selectkeys or getlist function call.

listname: A suitable name that will be required for later retrieval.

Returns: True if saved successfully or false if there was no active list to be saved.

Any existing list with the same name will be overwritten.

Only the remaining unconsumed part of the active select list is saved.

Saved lists are stand-alone and are not tied to specific database files although they usually hold keys related to specific files.

Saved lists can be created from one file and used to access another.

savelist() merely writes an FM separated string of keys as a record in the "lists" database file using the list name as the key of the record.

If a saved list is very long, additional blocks of keys for the same list may be stored with keys like listname*2, listname*3 etc.

Select lists saved in the lists database file may be created, deleted and listed like database records in any other database file.
var clients = "xo_clients";
if (clients.select("with type 'B' by name")) {
}
// or
if (select("xo_clients with type &#3#39;B' by name")) {
    if (savelist("mylist")) ... ok
}
ifdbfile.getlist(listname)

Retrieve and reactivate a saved select list.

dbfile: A file or connection var to be used by subsequent readnext function calls.

listname: The name of an existing list in the "lists" database file, either created by savelist or manually.

Returns: True if the list was successfully retrieved and activated, or false if the list name doesnt exist.

Any currently active select list is replaced.

Retrieving a list does not delete it and a list can be retrieved more than once until specifically deleted.
var file = "";
if (file.getlist("mylist")) {
    while (file.readnext(ID))
        println("Key is {}", ID);
}
// or
if (getlist("mylist")) {
    while (readnext(ID))
        println("Key is {}", ID);
}
ifdbfile.deletelist(listname)

Delete a saved select list.

dbfile: A file or connection to the desired database.

listname: The name of an existing list in the "lists" database file.

Returns: True if successful or false if the list name doesnt exist.
var conn = "";
if (conn.deletelist("mylist")) ... ok
// or
if (deletelist("mylist")) ...
OS Time/Date
Use Function Description
var=var::date()

A date in internal format.

Internal format is the number of whole days since pick epoch 1967-12-31 00:00:00 UTC. Dates prior to that are numbered negatively.

Returns: A number. e.g. 20821 represents 2025-01-01 00:00:00 UTC for 24 hours.
let today1 = var::date();
// or
let today2 = date();
var=var::time()

Number of whole seconds since last 00:00:00 (UTC).

Returns: A number in the range 0 - 86399 since there are 24*60*60 seconds in a day. e.g. 43200 if time is 12:00:00
let now1 = var::time();
// or
let now2 = time();
var=var::ostime()

Number of fractional seconds since last 00:00:00 (UTC).

Returns: A floating point with approx. nanosecond resolution depending on hardware.

e.g. 23343.704387955 approx. 06:29:03 UTC
let now1 = var::ostime();
// or
let now2 = ostime();
var=var::ostimestamp()

Number of fractional days since pick epoch 1967-12-31 00:00:00 UTC. Negative for dates before.

Returns: A floating point with approx. nanosecond resolution depending on hardware.

e.g. Was 20821.99998842593 around 2025-01-01 23:59:59 UTC
let now1 = var::ostimestamp();
// or
let now2 = ostimestamp();
var=vardate.ostimestamp(ostime)

Get a timestamp for a given date and time

vardate: Internal date from date(), iconv("D") etc.

ostime: Internal time from time(), ostime(), iconv("MT") etc.
let idate = iconv("2025-01-01", "D"), itime = iconv("23:59:59", "MT");
let ts1 = idate.ostimestamp(itime); // 20821.99998842593
// or
let ts2 = ostimestamp(idate, itime);
var::ossleep(milliseconds)

Sleep/pause/wait

milliseconds: How to long to sleep.

Releases the processor if not needed for a period of time or a delay is required.
var::ossleep(100); // sleep for 100ms
// or
ossleep(100);
var=file_dir_list.oswait(milliseconds)

Sleep/pause/wait up for a file system event

file_dir_list: An FM delimited list of OS files and/or dirs to monitor.

milliseconds: How long to wait. Any terminal input (e.g. a key press) will also terminate the wait.

Returns: An FM array of event information is returned. See below.

Multiple events may be captured and are returned in multivalues.

let v1 = ".^/etc/hosts"_var.oswait(100); /// e.g. "IN_CLOSE_WRITE^/etc^hosts^f"_var
// or
let v2 = oswait(".^/etc/hosts"_var, 100);
Returned dynamic array fields:

# Event type codes

# dirpaths

# filenames

# d=dir, f=file

Possible event type codes:

* IN_CLOSE_WRITE - A file opened for writing was closed

* IN_ACCESS - Data was read from file

* IN_MODIFY - Data was written to file

* IN_ATTRIB - File attributes changed

* IN_CLOSE - File was closed (read or write)

* IN_MOVED_FROM - File was moved away from watched directory

* IN_MOVED_TO - File was moved into watched directory

* IN_MOVE - File was moved (in or out of directory)

* IN_CREATE - A file was created in the directory

* IN_DELETE - A file was deleted from the directory

* IN_DELETE_SELF - Directory or file under observation was deleted

* IN_MOVE_SELF - Directory or file under observation was moved

OS File I/O
Use Function Description
ifosfilevar.osopen(osfilename, utf8 = true)

Opens an OS file handle for random read and write operations.

osfilevar: [out] Handle for subsequent osbread() and osbwrite() calls.

osfilename: Path and name of an existing OS file.

utf8: True (default) removes partial UTF-8 sequences from osbread() ends; false returns raw data.

Returns: True if opened successfully, false if file doesn’t exist or isn’t accessible.

Opens for writing if possible, otherwise read-only.
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
if (oswrite("" on osfilename)) ... ok /// Create an empty OS file
var ostempfile;
if (ostempfile.osopen(osfilename)) ... ok
// or
if (osopen(osfilename to ostempfile)) ... ok
ifstrvar.osbwrite(osfilevar, io offset)

Writes data to an OS file at a specified position.

strvar: Data to write.

osfilevar: Handle from osopen() or a path/filename; creates file if offset is 0 and it’s new, fails if offset isn’t 0.

offset: [in/out] Start position (0-based); updated to end of written data; -1 appends.

Returns: True if write succeeds, false if file isn’t accessible, updateable, or creatable.
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
let text = "aaa=123\nbbb=456\n";
var offset = -1; /// -1 means append.
if (text.osbwrite(osfilename, offset)) ... ok // offset -> 16
// or
if (not osbwrite(text on osfilename, offset)) ...
ifstrvar.osbread(osfilevar, io offset, length)

Reads data from an OS file at a specified position.

strvar: [out] Data read.

osfilevar: Handle from osopen() or a path/filename.

offset: [in/out] Start position (0-based); updated to end of read data.

length: Chars to read; with utf8=true (default), may return less to ensure complete UTF-8 code points.

Returns: True if read succeeds, false if file doesn’t exist or isn’t accessible or offset >= file size.
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
var text, offset = 0;
if (text.osbread(osfilename, offset, 8)) ... ok // text -> "aaa=123\n" // offset -> 8
// or
if (osbread(text from osfilename, offset, 8)) ... ok // text -> "bbb=456\n" // offset -> 16
osfile << anything << std::endl;

Use convenient << syntax to output anything to an osfile.

osfile: An OS path and filename or an osfilevar opened by osopen(). The file will be appended, or created if it does not already exist. osfile can be "stdout" or "stderr" to simulate cout/cerr/clog.
let txtfile = "t_temp.txt";
if (not osremove(txtfile)) {} // Remove any existing file.
txtfile << txtfile << " " << 123.456789 << " " << 123 << std::endl;
let v1 = osread(txtfile);   // "t_temp.txt 123.457 123\n"
All standard c++ io manipulators may be used e.g. std::setw, setfill etc.
let vout = "t_std_iomanip_overview.txt";
if (not osremove(vout)) {}
using namespace std;

vout << boolalpha    << true          << "\ttrue"    << endl;
vout << noboolalpha  << true          << "\t1"       << endl;

vout << showpoint    << 42.0          << "\t42.0000" << endl;
vout << noshowpoint  << 42.0          << "\t42"      << endl;

vout << showpos      << 42            << "\t+42"     << endl;
vout << noshowpos    << 42            << "\t42"      << endl;

vout << skipws       << " " << 42     << "\t 42"     << endl;
vout << noskipws     << " " << 42     << "\t 42"     << endl;

vout << unitbuf      << "a"           << "\ta"       << endl;
vout << nounitbuf    << "b"           << "\tb"       << endl;

vout << setw(6)      << 42            << "\t    42"  << endl;

vout << left         << setw(6) << 42 << "\t42    "  << endl;
vout << right        << setw(6) << 42 << "\t    42"  << endl;
vout << internal     << setw(6) << 42 << "\t    42"  << endl;
vout << setfill('*') << setw(6) << 42 << "\t****42"  << endl;

vout << showbase     << hex << 255    << "\t0xff"    << endl;
vout << noshowbase   << 255           << "\tff"      << endl;

vout << uppercase    << 255           << "\tFF"      << endl;
vout << nouppercase  << 255           << "\tff"      << endl;

vout << oct          << 255           << "\t377"     << endl;
vout << hex          << 255           << "\tff"      << endl;
vout << dec          << 255           << "\t255"     << endl;

vout << fixed        << 42.1          << "\t42.100000"            << endl;
vout << scientific   << 42.1          << "\t4.210000e+01"         << endl;
vout << hexfloat     << 42.1          << "\t0x1.50ccccccccccdp+5" << endl;
vout << defaultfloat << 42.1          << "\t42.1"                 << endl;

vout << std::setprecision(3)      << 42.1567  << "\t42.2"  << endl;
vout << resetiosflags(ios::fixed) << 42.1567  << "\t42.2"  << endl;
vout << setiosflags(ios::showpos) << 42       << "\t+42"   << endl;

// Verify actual v. expected.
var act_v_exp = osread(vout);
act_v_exp.converter("\n\t", FM ^ VM); // Text to dynamic array
act_v_exp = invertarray(act_v_exp);   // Columns <-> Rows
assert(act_v_exp.f(1) eq act_v_exp.f(2));
var().osclose()

Removes an osfilevar handle from the internal memory cache of OS file handles. This frees up both exodus process memory and operating system resources.

It is advisable to osclose any file handles after use, regardless of whether they were specifically opened using osopen or not, especially in long running programs. Exodus performs caching of internal OS file handles per thread and OS file. If not closed, then the operating system will probably not flush deleted files from storage until the process is terminated. This can potentially create an memory issue or file system resource issue especially if osopening/osreading/oswriting many perhaps temporary files in a long running process.
var osfilevar; if (osfilevar.osopen(ostempfile())) ... ok
osfilevar.osclose();
// or
osclose(osfilevar);
ifstrvar.oswrite(osfilename, codepage = "")

Create a complete OS file from a var.

strvar: The text or data to be used to create the file.

osfilename: Absolute or relative path and filename to be written. Any existing OS file is removed first.

codepage: If specified then output is converted from UTF-8 to that codepage before being written. Otherwise no conversion is done.

Returns: True if successful or false if not possible for any reason. e.g. Path is not writeable, permissions etc
let text = "aaa = 123\nbbb = 456";
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
if (text.oswrite(osfilename)) ... ok
// or
if (oswrite(text on osfilename)) ... ok
ifstrvar.osread(osfilename, codepage = "")

Read a complete OS file into a var.

osfilename: Absolute or relative path and filename to be read.

codepage: If specified then input is converted from that codepage to UTF-8 after being read. Otherwise no conversion is done.

strvar: [out] is currently set to "" in case of any failure but this is may be changed in a future release to either force var to be unassigned or to leave it untouched. To guarantee future behaviour either add a line 'xxxx.defaulter("")' or set var manually in case osread() returns false. Or use the one argument free function version of osread() which always returns "" in case of failure to read.

Returns: True if successful or false if not possible for any reason. e.g. File doesnt exist, insufficient permissions etc.
var text;
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
if (text.osread(osfilename)) ... ok // text -> "aaa = 123\nbbb = 456"
// or
if (osread(text from osfilename)) ... ok
let text2 = osread(osfilename);
ifosfile_or_dirname.osrename(new_dirpath_or_filepath)

Renames an OS file or dir in the OS file system.

The source and target must exist in the same storage device.

osfile_or_dirname: Absolute or relative path and file or dir name to be renamed.

new_dirpath_or_filepath: Will not overwrite an existing OS file or dir.

Returns: True if successful or false if not possible for any reason. e.g. Target already exists, path is not writeable, permissions etc.

Uses std::filesystem::rename internally.
let from_osfilename = ostempdir() ^ "xo_gendoc_test.conf";
let to_osfilename = from_osfilename ^ ".bak";
if (not osremove(ostempdir() ^ "xo_gendoc_test.conf.bak")) {}; // Cleanup first

if (from_osfilename.osrename(to_osfilename)) ... ok
// or
if (osrename(from_osfilename, to_osfilename)) ...
ifosfile_or_dirname.osmove(to_osfilename)

"Moves" an OS file or dir within the OS file system.

Attempts osrename first, then oscopy followed by osremove original.

osfile_or_dirname: Absolute or relative path and file or dir name to be moved.

to_osfilename: Will not overwrite an existing OS file or dir.

Returns: True if successful or false if not possible for any reason. e.g. Source doesnt exist or cannot be accessed, target already exists, source or target is not writeable, permissions, storage space etc.
let from_osfilename = ostempdir() ^ "xo_gendoc_test.conf.bak";
let to_osfilename = from_osfilename.cut(-4);

if (not osremove(ostempdir() ^ "xo_gendoc_test.conf")) {}; // Cleanup first
if (from_osfilename.osmove(to_osfilename)) ... ok
// or
if (osmove(from_osfilename, to_osfilename)) ...
ifosfile_or_dirname.oscopy(to_osfilename)

Copies an OS file or directory recursively within the OS file system.

osfile_or_dirname: Absolute or relative path and file or dir name to be copied.

to_osfilename: Will overwrite an existing OS file or merge into an existing dir.

Returns: True if successful or false if not possible for any reason. e.g. Source doesnt exist or cannot be accessed, target is not writeable, permissions, storage space, etc.

Uses std::filesystem::copy internally with recursive and overwrite options
let from_osfilename = ostempdir() ^ "xo_gendoc_test.conf";
let to_osfilename = from_osfilename ^ ".bak";

if (from_osfilename.oscopy(to_osfilename)) ... ok;
// or
if (oscopy(from_osfilename, to_osfilename)) ... ok
ifosfilename.osremove()

Removes/deletes an OS file from the OS file system.

Will not remove directories. Use osrmdir() to remove directories

osfilename: Absolute or relative path and file name to be removed.

Returns: True if successful or false if not possible for any reason. e.g. Target doesnt exist, path is not writeable, permissions etc.

If osfilename is an osfilevar then it is automatically closed.
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
if (osfilename.osremove()) ... ok
// or
if (osremove(osfilename)) ...
OS Directories
Use Function Description
var=dirpath.oslist(globpattern = "", mode = 0)

Get a list of OS files and/or dirs.

dirpath: Absolute or relative dir path.

globpattern: e.g. *.conf to be appended to the dirpath or a complete path plus glob pattern e.g. /etc/ *.conf.

mode: 0: default - Any regular files or dirs. 1 - Only regular OS files. 2 - Only dirs.

Returns: An FM delimited string containing all matching dir entries given a dir path
var entries1 = "/etc/"_var.oslist("*.cfg"); /// e.g. "adduser.conf^ca-certificates.con^... etc."
// or
var entries2 = oslist("/etc/" "*.conf");
var=dirpath.oslistf(globpattern = "")Same as oslist for files only
var=dirpath.oslistd(globpattern = "")Same as oslist for files only
var=osfile_or_dirpath.osinfo(mode = 0)

Get dir info about an OS file or dir.

Returns: A short string containing size ^ FM ^ modified_time ^ FM ^ modified_time or "" if not a regular file or dir.

mode: 0: default. 1: Must be a regular OS file. 2: Must be an OS dir.

See also osfile() and osdir()
var info1 = "/etc/hosts"_var.osinfo(); /// e.g. "221^20597^78309"_var
// or
var info2 = osinfo("/etc/hosts");
var=osfilename.osfile()

Get dir info of an OS file.

osfilename: Absolute or relative path and file name.

Returns: A short string containing size ^ FM ^ modified_time ^ FM ^ modified_time or "" if not a regular file.

Alias for osinfo(1)
var fileinfo1 = "/etc/hosts"_var.osfile(); /// e.g. "221^20597^78309"_var
// or
var fileinfo2 = osfile("/etc/hosts");
var=dirpath.osdir()

Get dir info of an OS dir.

dirpath: Absolute or relative path and dir name.

Returns: A short string containing FM ^ modified_time ^ FM ^ modified_time or "" if not a dir.

Alias for osinfo(2)
var dirinfo1 = "/etc/"_var.osdir(); /// e.g. "^20848^44464"_var
// or
var dirinfo2 = osfile("/etc/");
ifdirpath.osmkdir()

Create a new OS file system directory.

Parent dirs wil be created if necessary.

dirpath: Absolute or relative path and dir name.

Returns: True if successful.
let osdirname = "xo_test/aaa";
if (osrmdir("xo_test/aaa")) {}; // Cleanup first
if (osdirname.osmkdir()) ... ok
// or
if (osmkdir(osdirname)) ...
ifvar::oscwd(newpath)

Changes the current working dir.

newpath: An absolute or relative dir path and name.

Returns: True if successful or false if not. e.g. Invalid dirpath, insufficient permission etc.
let osdirname = "xo_test/aaa";
if (osdirname.oscwd()) ... ok
// or
if (oscwd(osdirname)) ... ok
if (oscwd("../..")) ... ok /// Change back to avoid errors in following code.
var=var::oscwd()

Gets the current dir path and name.

Returns: The current working dir path and name.

e.g. "/root/exodus/cli/src/xo_test/aaa"
var cwd1 = var().oscwd();
// or
var cwd2 = oscwd();
ifdirpath.osrmdir(evenifnotempty = false)

Removes (deletes) an OS dir,

eventifnotempty: If true any subdirs will also be removed/deleted recursively, otherwise the function will fail and return false.

Returns: Returns true if successful or false if not. e.g dir doesnt exist, insufficient permission, not empty etc.
let osdirname = "xo_test/aaa";
if (osdirname.osrmdir()) ... ok
// or
if (osrmdir(osdirname)) ...
OS Shell/Environment
Use Function Description
ifcommand.osshell()

Execute a shell command.

command: An executable command to be interpreted by the default OS shell.

Returns: True if the process terminates with error status 0 and false otherwise.

Append "&>/dev/null" to the command to suppress terminal output.
let cmd = "echo $HOME";
if (cmd.osshell()) ... ok
// or
if (osshell(cmd)) ... ok
ifinstr.osshellread(oscmd)

Same as osshell but captures and returns stdout

Returns: The stout of the shell command.

Append "2>&1" to the command to capture stderr/stdlog output as well.
let cmd = "echo $HOME";
var text;
if (text.osshellread(cmd)) ... ok

// or capturing stdout but ignoring exit status
text = osshellread(cmd);
ifoutstr.osshellwrite(oscmd)

Same as osshell but provides stdin to the process

Returns: True if the process terminates with error status 0 and false otherwise.

Append "&> somefile" to the command to suppress and/or capture output.
let outtext = "abc xyz";
if (outtext.osshellwrite("grep xyz")) ... ok
// or
if (osshellwrite(outtext, "grep xyz")) ... ok
ifvar::osprocess(oscmd, stdin_for_process, out stdout_from_process, out stderr_from_process, out exit_status, timeout_secs = 0)

Run an OS program synchronously.

Executes an OS program passing input and capturing standard and error output, and exit status.

Shell features (e.g., pipes, redirects) are not supported but can be invoked using an oscmd like "bash -c \"abc|yyy $HOME\""

oscmd: The executable program and its arguments. Must exist in the OS PATH.

stdin_for_process: Optional. Input data to send to the program's standard input.

stdout_from_process: [out] Standard output produced by the program.

stderr_from_process: [out] Error or log output from the program.

exit_status: [out] Result of the program's execution:

* 0 Program terminated normally.

* -1 Timeout

* nn Program reported an exit status.

timeout_in_secs: Optional. Maximum runtime in seconds (default 0 = no timeout).

Returns: Success or failure.

* true Program ran and exited with status 0 (success).

* false Program failed to start, timed out, or exited with non-zero status.

Throws: Various system errors are possible.

* Pipe creation failed.

* Fork failed.

* Poll failure.
var v_stdout, v_stderr, v_exit_status;
if (var::osprocess("grep xyz", "abc\nxyz 123\ndef", v_stdout, v_stderr, v_exit_status)) ... ok // v_stdout -> "xyz 123" // v_exit_status = 0
// or
if (osprocess("grep xyz", "abc\nxyz 123\ndef", v_stdout, v_stderr, v_exit_status)) ... ok
var=var::ostempdir()

Get the tmp dir path and name.

Returns: A string e.g. "/tmp/"
let v1 = var::ostempdir();
// or
let v2 = ostempdir();
var=var::ostempfile()

Create a temporary file

Returns: The name of new temporary file e.g. "/tmp/~exoEcLj3C"
var temposfilename1 = var::ostempfile();
// or
var temposfilename2 = ostempfile();
envvalue.ossetenv(envcode)

Set the value of an environment variable

envcode: The code of the env variable to set.

envvalue: The new value to set the env code to.
let envcode = "EXO_ABC", envvalue = "XYZ";
envvalue.ossetenv(envcode);
// or
ossetenv(envcode, envvalue);
ifenvvalue.osgetenv(envcode)

Get the value of an environment variable.

envcode: The code of the env variable to get or "" for all.

envvalue: [out] Set to the value of the env variable if set otherwise "". If envcode is "" then envvalue is set to a dynamic array of all environment variables LIKE CODE1=VALUE1^CODE2=VALUE2...

Returns: True if the envcode is set or false if not.

osgetenv and ossetenv work with a per thread copy of the OS process environment. This avoids multithreading issues but does not change the process environment. Child processes created by var::osshell() will not inherit any env variables set using ossetenv() so the oscommand will need to be prefixed to achieve the desired result.

For the actual system environment, see "man environ". extern char **environ; // environ is a pointer to an array of pointers to char* env pairs like xxx=yyy and the last pointer in the array is nullptr.
var envvalue1;
if (envvalue1.osgetenv("HOME")) ... ok // e.g. "/home/exodus"
// or
let envvalue2 = osgetenv("EXO_ABC"); // "XYZ"
var=var::ospid()

Get the current OS process id

Returns: A number e.g. 663237.
let pid1 = var::ospid(); /// e.g. 663237
// or
let pid2 = ospid();
var=var::ostid()

Get the current OS thread process id

Returns: A number e.g. 663237.
let tid1 = var::ostid(); /// e.g. 663237
// or
let tid2 = ostid();
var=var::version()

Get the exodus library version info.

Returns: The git commit details as at the time the library was built.
// e.g.
// Local:  doc 2025-03-19 18:15:31 +0000 219cdad8a
// Remote: doc 2025-03-17 15:03:00 +0000 958f412f0
// https://github.com/exodusdb/exodusdb/commit/219cdad8a
// https://github.com/exodusdb/exodusdb/archive/958f412f0.tar.gz
//
let v1 = var::version();
// or
let v2 = version();
ifstrvar.setxlocale(newlocalecode)

Sets the current thread's default locale.

strvar: The new locale codepage code.

True if successful
if (var::setxlocale("en_US.utf8")) ... ok
// or
if (setxlocale("en_US.utf8")) ... ok
var=var.getxlocale()

Gets the current thread's default locale.

Returns: A locale codepage code string.
let v1 = var::getxlocale(); // "en_US.utf8"
// or
let v2 = getxlocale();
Output
Use Function Description
exprstrvar.outputl(prefix = "")

Output to stdout with optional prefix.

Appends an NL char.

Is FLUSHED, not buffered.

The raw string bytes are output. No character or byte conversion is performed.
"abc"_var.outputl("xyz = "); /// Sends "xyz = abc\n" to stdout and flushes.
// or
outputl("xyz = ", "abc"); /// Any number of arguments is allowed. All will be output.
exprstrvar.output(prefix = "") Same as outputl() but doesnt append an NL char and is BUFFERED, not flushed.
exprstrvar.outputt(prefix = "") Same as outputl() but appends a tab char instead of an NL char and is BUFFERED, not flushed.
exprstrvar.logputl(prefix = "")

Output to stdlog with optional prefix.

Appends an NL char.

Is BUFFERED not flushed.

Any of the six types of field mark chars present are converted to their visible versions,
"abc"_var.logputl("xyz = "); /// Sends "xyz = abc\n" to stdlog buffer and is not flushed.
// or
logputl("xyz = ", "abc");; /// Any number of arguments is allowed. All will be output.
exprstrvar.logput(prefix = "") Same as logputl() but doesnt append an NL char.
exprstrvar.errputl(prefix = "")

Output to stderr with optional prefix.

Appends an NL char.

Is FLUSHED not buffered.

Any of the six types of field mark chars present are converted to their visible versions,
"abc"_var.errputl("xyz = "); /// Sends "xyz = abc\n" to stderr
// or
errputl("xyz = ", "abc"); /// Any number of arguments is allowed. All will be output.
exprstrvar.errput(prefix = "") Same as errputl() but doesnt append an NL char and is BUFFERED not flushed.
exprstrvar.put(std::ostream& ostream1)

Output to a given stream.

Is BUFFERED not flushed.

The raw string bytes are output. No character or byte conversion is performed.

var().osflush()Flush any and all buffered output to stdout and stdlog.
var().osflush();
// or
osflush();
Input
Use Function Description
ifvar.input(prompt = "")

Returns one line of input from stdin.

Returns: True if successful or false if EOF or user pressed Esc or Ctrl+X in a terminal.

var: [in] The default value for terminal input and editing. Ignored if not a terminal.

var: [out] Raw bytes up to but excluding the first new line char. In case of EOF or user pressed Esc or Ctrl+X in a terminal it will be changed to "".

Prompt: If provided, it will be displayed on the terminal.

Multibyte/UTF8 friendly.
// var v1 = "defaultvalue";
// if (v1.input("Prompt:")) ... ok
// or
// var v2 = input();
exprvar.inputn(nchars)

Get raw bytes from standard input.

Any new line chars are treated like any other bytes.

Care must be taken to handle incomplete UTF8 byte sequences at the end of one block and the beginning of the next block.

Returns: The requested number of bytes or fewer if not available.

nchars:

99 : Get up to 99 bytes or fewer if not available. Caution required with UTF8.

⋅0 : Get all bytes presently available.

⋅1 : Same as keypressed(true). Deprecated.

-1 : Same as keypressed(). Deprecated.

exprvar.keypressed(wait = false)

Return the code of the current terminal key pressed.

wait: Defaults to false. True means wait for a key to be pressed if not already pressed.

Returns: ASCII or key code defined according to terminal protocol.

Returns: "" if stdin is not a terminal.

e.g. The PgDn key if pressed might return an escape sequence like "\x1b[6~"

It only takes a few µsecs to return false if no key is pressed.
var v1; v1.keypressed();
// or
var v2 = keypressed();
ifvar().isterminal(arg = 1)

Checks if one of stdin, stdout, stderr is a terminal or a file/pipe.

arg: 0 - stdin, 1 - stdout (Default), 2 - stderr.

Returns: True if it is a terminal or false if it is a file or pipe.

Note that if the process is at the start or end of a pipeline, then only stdin or stdout will be a terminal.

The type of stdout terminal can be obtained from the TERM environment variable.
var v1 = var().isterminal(); /// 1 or 0
// or
var v2 = isterminal();
ifvar().hasinput(milliseconds = 0)

Checks if stdin has any bytes available for input.

If no bytes are immediately available, the process sleeps for up to the given number of milliseconds, returning true immediately any bytes become available or false if the period expires without any bytes becoming available.

Returns: True if any bytes are available otherwise false.

It only takes a few µsecs to return false if no bytes are available and no wait time has been requested.

ifvar().eof()

True if stdin is at end of file

ifvar().echo(on_off = true)

Sets terminal echo on or off.

"On" causes all stdin data to be reflected to stdout if stdin is a terminal.

Turning terminal echo off can be used to prevent display of confidential information.

Returns: True if successful.

var().breakon()

Install various interrupt handlers.

Automatically called in program/thread initialisation by exodus_main.

* SIGINT - Ctrl+C -> "Interrupted. (C)ontinue (Q)uit (B)acktrace (D)ebug (A)bort ?"

* SIGHUP - Sets a variable "RELOAD_req" which may be handled or ignored by the program.

* SIGTERM - Sets a variable "TERMINATE_req" which may be handled or ignored by the program.

var().breakoff()

Disable keyboard interrupt.

Ctrl+C becomes inactive in terminal.

Math/Boolean
Use Function Description
var=varnum.abs()Absolute value
let v1 = -12.34;
let v2 = v1.abs(); // 12.34
// or
let v3 = abs(v1);
var=varnum.pwr(exponent)Power
let v1 = var(2).pwr(8); // 256
// or
let v2 = pwr(2, 8);
varnum.initrnd()

Initialise the seed for rnd()

Allows the stream of pseudo random numbers generated by rnd() to be reproduced.

Seeded from std::chrono::high_resolution_clock::now() if the argument is 0;
var(123).initrnd(); /// Set seed to 123
// or
initrnd(123);
var=varnum.rnd()

Pseudo random number generator

Returns: a pseudo random integer between 0 and the provided maximum minus 1.

Uses std::mt19937 and std::uniform_int_distribution
let v1 = var(100).rnd(); /// Random 0 to 99
// or
let v2 = rnd(100);
var=varnum.exp()Power of e
let v1 = var(1).exp(); // 2.718281828459045
// or
let v2 = exp(1);
var=varnum.sqrt()Square root
let v1 = var(100).sqrt(); // 10
// or
let v2 = sqrt(100);
var=varnum.sin()Sine of degrees
let v1 = var(30).sin(); // 0.5
// or
let v2 = sin(30);
var=varnum.cos()Cosine of degrees
let v1 = var(60).cos(); // 0.5
// or
let v2 = cos(60);
var=varnum.tan()Tangent of degrees
let v1 = var(45).tan(); // 1
// or
let v2 = tan(45);
var=varnum.atan()Arctangent of degrees
let v1 = var(1).atan(); // 45
// or
let v2 = atan(1);
var=varnum.loge()

Natural logarithm

Returns: Floating point ver (double)
let v1 = var(2.718281828459045).loge(); // 1
// or
let v2 = loge(2.718281828459045);
var=varnum.integer()

Truncate decimal numbers towards zero

Returns: An integer var
let v1 = var(2.9).integer(); // 2
// or
let v2 = integer(2.9);

var v3 = var(-2.9).integer(); // -2
// or
var v4 = integer(-2.9);
var=varnum.floor()

Truncate decimal numbers towards negative

Returns: An integer var
let v1 = var(2.9).floor(); // 2
// or
let v2 = floor(2.9);

var v3 = var(-2.9).floor(); // -3
// or
var v4 = floor(-2.9);
var=varnum.mod(modulus)

Modulus function

Identical to C++ % operator only for positive numbers and modulus

Negative denominators are considered as periodic with positiive numbers

Result is between [0, modulus) if modulus is positive

Result is between (modulus, 0] if modulus is negative (symmetric)

Throws: VarDivideByZero if modulus is zero.

Floating point works.
let v1 = var(11).mod(5); // 1
// or
let v2 = mod(11, 5); // 1
let v3 = mod(-11, 5); // 4
let v4 = mod(11, -5); // -4
let v5 = mod(-11, -5); // -1
int=var::setprecision(newprecision)

Set the maximum floating point precision.

This is the number of post-decimal point digits to consider for floating point comparison and implicit conversion to strings.

The default precision is 4 which is 0.0001.

NUMBERS AND DIFFERENCES SMALLER THAN 0.0001 ARE TREATED AS ZERO UNLESS PRECISION IS INCREASED.

newprecision: New precision between -307 and 308 inclusive.

Returns: The new precision if successful or the old precision if not.

Not required if using common numbers or using the explicit rounding and formatting functions to convert numbers to strings.

Increasing the precision allows comparing and outputting smaller numbers but creates errors handling large numbers.

Setting precision inside a perform, execute or dictionary function lasts until termination of the function.

See cli/demo_precision for more info.
assert(0.000001_var == 0); /// NOTE WELL: Default precision 4.
let new_precision1 = var::setprecision(6); // 6 // Increase the precision.
// or
let new_precision2 = setprecision(6);
assert(0.000001_var != 0); /// NOTE: Precision 6.
int=var::getprecision()

Returns: The current precision setting.

See setprecision() for more info.
let curr_precision1 = var::getprecision();
// or
let curr_precision2 = getprecision();

I/O Conversion Codes

Use Function Description
var=vardate.oconv("D")

Date output: Convert internal date format to human readable date or calendar info in text format.

Returns: Human readable date or calendar info, or the original value unconverted if non-numeric.

flags: See examples below.

Any Dynamic array structure is preserved.
let v1 = 19002;
var v2;
v2 =  v1.oconv( "D"   ) ; //  "09 JAN 2020"   // Default

v2 =  v1.oconv( "D/"  ) ; //  "01/09/2020"    // mm/dd/yyyy - American numeric
v2 =  v1.oconv( "D-"  ) ; //  "01-09-2020"    // mm-dd-yyyy - American numeric

v2 =  v1.oconv( "D/E" ) ; //  "09/01/2020"    // dd/mm/yyyy - International numeric
v2 =  v1.oconv( "D-E" ) ; //  "09-01-2020"    // dd-mm-yyyy - International numeric

v2 =  v1.oconv( "D2"  ) ; //  "09 JAN 20"     // 2 digit year
v2 =  v1.oconv( "D0"  ) ; //  "09 JAN"        // No year

v2 =  v1.oconv( "DS"  ) ; //  "2020 JAN 09"   // yyyy mmm dd - ISO year first, alpha month
v2 =  v1.oconv( "DS-" ) ; //  "2020-01-09"    // yyyy-mm-dd  - ISO year first, numeric month

v2 =  v1.oconv( "DZ"  ) ; //  " 9 JAN 2020"   // Leading 0 become spaces
v2 =  v1.oconv( "DZZ" ) ; //  "9 JAN 2020"    // Leading 0 are suppressed
v2 =  v1.oconv( "D!"  ) ; //  "09JAN2020"     // No separators
v2 =  v1.oconv( "DS-!") ; //  "20200109"      // yyyymmdd packed

v2 =  v1.oconv( "DM"  ) ; //  "1"             // Month number
v2 =  v1.oconv( "DMA" ) ; //  "JANUARY"       // Month name
v2 =  v1.oconv( "DY"  ) ; //  "2020"          // Year number
v2 =  v1.oconv( "DY2" ) ; //  "20"            // Year 2 digits
v2 =  v1.oconv( "DD"  ) ; //  "9"             // Day number in month (1-31)
v2 =  v1.oconv( "DW"  ) ; //  "4"             // Weekday number (1-7)
v2 =  v1.oconv( "DWA" ) ; //  "THURSDAY"      // Weekday name
v2 =  v1.oconv( "DQ"  ) ; //  "1"             // Quarter number
v2 =  v1.oconv( "DJ"  ) ; //  "9"             // Day number in year
v2 =  v1.oconv( "DL"  ) ; //  "31"            // Last day number of month (28-31)

// Dynamic array
let v3 = "12345^12346]12347"_var;
v2 = v3.oconv("D") ; //  "18 OCT 2001^19 OCT 2001]20 OCT 2001"_var

 // or
 v2 =  oconv(v3, "D"   ) ;
var=strvar.iconv("D")

Date input: Convert human readable date to internal date format.

Returns: Internal date or "" if the input is an invalid date.

Internal date format is whole days since 1967-12-31 00:00:00 which is day 0.

Any Dynamic array structure is preserved.
// International order "DE"
var v2;
v2 =             oconv(19005, "DE") ; //  "12 JAN 2020"
v2 =    "12/1/2020"_var.iconv("DE") ; //  19005
v2 =    "12 1 2020"_var.iconv("DE") ; //  19005
v2 =    "12-1-2020"_var.iconv("DE") ; //  19005
v2 =  "12 JAN 2020"_var.iconv("DE") ; //  19005
v2 =  "jan 12 2020"_var.iconv("DE") ; //  19005

// American order "D"
v2 =             oconv(19329, "D") ; //  "01 DEC 2020"
v2 =    "12/1/2020"_var.iconv("D") ; //  19329
v2 =   "DEC 1 2020"_var.iconv("D") ; //  19329
v2 =   "1 dec 2020"_var.iconv("D") ; //  19329

// Reverse order
v2 =   "2020/12/1"_var.iconv("DE") ; //  19329
v2 =    "2020-12-1"_var.iconv("D") ; //  19329
v2 =   "2020 1 dec"_var.iconv("D") ; //  19329

//Invalid date
v2 =    "2/29/2021"_var.iconv("D") ; //  ""
v2 =   "29/2/2021"_var.iconv("DE") ; //  ""

// or
v2 = iconv("12/1/2020"_var, "DE") ; //  19005
var=vartime.oconv("MT")

Time output: Convert internal time format to human readable time e.g. "10:30:59".

Returns: Human readable time or the original value unconverted if non-numeric.

Conversion code (e.g. "MTHS") is "MT" + flags ...

flags:

* "H" - Show AM/PM otherwise 24 hour clock is used.

* "S" - Output seconds

* "2" = Ignored (used in iconv)

* ":" - Any other flag is used as the separator char instead of ":"

Any Dynamic array structure is preserved.
let v1  = 62000;
var v2;
v2 = v1.oconv("MT"  ); // "17:13"      // Default
v2 = v1.oconv("MTH" ); // "05:13PM"    // 'H' flag for AM/PM
v2 = v1.oconv("MTS" ); // "17:13:20"   // 'S' flag for seconds
v2 = v1.oconv("MTHS"); // "05:13:20PM" // Both flags

let v3  = 0;
v2 = v3.oconv("MT"  ); // "00:00"
v2 = v3.oconv("MTH" ); // "12:00AM"
v2 = v3.oconv("MTS" ); // "00:00:00"
v2 = v3.oconv("MTHS"); // "12:00:00AM"

// Dynamic array
let v4  = "61980^62040]62100"_var;
v2 = v4.oconv("MT");    // "17:13^17:14]17:15"_var

// or
v2 = oconv(v1, "MT");    // "17:13"
var=strvar.iconv("MT")

Time input: Convert human readable time (e.g. "10:30:59") to internal time format.

Returns: Internal time or "" if the input is an invalid time.

Internal time format is whole seconds since midnight.

Accepts: Two or three groups of digits surrounded and separated by any non-digits char(s).

Any Dynamic array structure is preserved.
var v2;
v2 =       "17:13"_var.iconv( "MT" ) ; //  61980
v2 =     "05:13PM"_var.iconv( "MT" ) ; //  61980
v2 =    "17:13:20"_var.iconv( "MT" ) ; //  62000
v2 =  "05:13:20PM"_var.iconv( "MT" ) ; //  62000

v2 =       "00:00"_var.iconv( "MT" ) ; //  0
v2 =     "12:00AM"_var.iconv( "MT" ) ; //  0     // Midnight
v2 =     "12:00PM"_var.iconv( "MT" ) ; //  43200 // Noon
v2 =    "00:00:00"_var.iconv( "MT" ) ; //  0
v2 =  "12:00:00AM"_var.iconv( "MT" ) ; //  0

// Dynamic array
v2 = "17:13^05:13PM]17:13:20"_var.iconv("MT") ; //  "61980^61980]62000"_var

// or
v2 = iconv("17:13", "MT") ; //  61980
var=varnum.oconv("MD")

Number output: Convert internal numbers to external text format after rounding and optional scaling.

Returns: A string or, if the value is not numeric, then no conversion is performed and the original value is returned.

conversion_code: (e.g. "MD20Z") is "MD" or "MC", 1st digit, 2nd digit, flags ...

* MD outputs like 123.45 (International)

* MC outputs like 123,45 (European)

* 1st digit = Decimal places to display. Also decimal places to move if 2nd digit not present and no P flag present.

* 2nd digit = Optional decimal places to move left if P flag not present.

flags:

* "P" - Preserve decimal places. Same as 2nd digit = 0;

* "Z" - Zero flag - return "" if zero.

* "X" - No conversion - return as is.

* "." or "," - Separate thousands depending on MD or MC.

* "-" means suffix negatives with "-" and positives with " " (space).

* "<" means wrap negatives in "<" and ">" chars.

* "C" means suffix negatives with "CR" and positives or zero with "DB".

* "D" means suffix negatives with "DB" and positives or zero with "CR".

Any Dynamic array structure is preserved.
var v1 = -1234.567;
var v2;
v2 =  v1.oconv( "MD20"   ) ; //   "-1234.57"
v2 =  v1.oconv( "MD20,"  ) ; //  "-1,234.57"    // , flag
v2 =  v1.oconv( "MC20,"  ) ; //  "-1.234,57"    // MC code
v2 =  v1.oconv( "MD20,-" ) ; //   "1,234.57-"   // - flag
v2 =  v1.oconv( "MD20,<" ) ; //  "<1,234.57>"   // < flag
v2 =  v1.oconv( "MD20,C" ) ; //   "1,234.57CR"  // C flag
v2 =  v1.oconv( "MD20,D" ) ; //   "1,234.57DB"  // D flag

// Dynamic array
var v3 = "1.1^2.1]2.2"_var;
v2 =  v3.oconv( "MD20"   ) ; //  "1.10^2.10]2.20"_var

// or
v2 =  oconv(v1, "MD20"   ) ; //   "-1234.57"   
var=var.oconv("LRC")

Text justification: Left, right and center. Padding and truncating. See Procrustes.

e.g. "L#10", "R#10", "C#10"

Useful when outputting to terminal devices where spaces are used for alignment.

Dynamic array structure is preserved.

ASCII only.
var v2;
v2 =      "abcde"_var.oconv( "L#3" ) ; //  "abc"  // Truncating
v2 =      "abcde"_var.oconv( "R#3" ) ; //  "cde"
v2 =      "abcde"_var.oconv( "C#3" ) ; //  "abc"

v2 =      "ab"_var.oconv( "L#6" ) ; //  "ab␣␣␣␣"  // Padding
v2 =      "ab"_var.oconv( "R#6" ) ; //  "␣␣␣␣ab"
v2 =      "ab"_var.oconv( "C#6" ) ; //  "␣␣ab␣␣"

v2 =       var(42).oconv( "L(0)#5" ) ; //  "42000"  // Padding char (x)
v2 =       var(42).oconv( "R(0)#5" ) ; //  "00042"
v2 =       var(42).oconv( "C(0)#5" ) ; //  "04200"
v2 =       var(42).oconv( "C(0)#5" ) ; //  "04200"

// Dynamic array
v2 =       "f1^v1]v2"_var.oconv("L(_)#5") ; //  "f1___^v1___]v2___"_var

// Fail for non-ASCII (Should be 5)
v2 =      "🐱"_var.oconv("L#5").textwidth() ; //  3

// or
v2 =      oconv("abcd", "L#3" ) ; //  "abc" 
var=strvar.oconv("T")

Text folding and justification.

e.g. T#20

Useful when outputting to terminal devices where spaces are used for alignment.

Splits text into multiple fixed length lines by inserting spaces and TM chars.

ASCII only.
let v1 = "Have a nice day";
let v2 = v1.oconv("T#10") ; //  "Have a␣␣␣␣|nice day␣␣"_var
// or
let v3  = oconv(v1, "T#10") ; //  "Have a␣␣␣␣|nice day␣␣"_var 
exprvarnum.oconv("MR")

Character replacement

e.g. MRU
let v1 = "123/abC.";
var v2;
v2 = v1.oconv("MRL") ; //  "123/abc." // lcase
v2 = v1.oconv("MRU") ; //  "123/ABC." // ucase
v2 = v1.oconv("MRT") ; //  "123/Abc." // tcase
v2 = v1.oconv("MRN") ; //  "123"      // Return only digits
v2 = v1.oconv("MRA") ; //  "abC"      // Return only alphabetic
v2 = v1.oconv("MRB") ; //  "123abC"   // Return only alphanumeric
v2 = v1.oconv("MR/N") ; //  "/abC."   // Remove digits
v2 = v1.oconv("MR/A") ; //  "123/."   // Remove alphabetic
v2 = v1.oconv("MR/B") ; //  "/."      // Remove alphanumeric
var=strvar.oconv("HEX")

Convert the chars of a string to a string of pairs of hexadecimal digits.

strvar: A string. Numbers will be converted to strings for conversion. 1.2 -> "1.2" -> hex "312E32"

Dynamic array structure is not preserved. Field marks are converted to HEX as for all other bytes.

The size of the output is always precisely double that of the input.

This function is the exact inverse of iconv("HEX").
var v2;
v2 =      "ab01"_var.oconv( "HEX" ) ; //  "61" "62" "30" "31"
v2 =  "\xff\x00"_var.oconv( "HEX" ) ; //  "FF" "00"            // Any bytes are ok.
v2 =         var(10).oconv( "HEX" ) ; //  "31" "30"            // Uses ASCII string equivalent of 10 i.e. "10".
v2 =    "\u0393"_var.oconv( "HEX" ) ; //  "CE" "93"            // Greek capital Gamma in UTF8 bytes.
v2 =      "a^]b"_var.oconv( "HEX" ) ; //  "61" "1E" "1D" "62"  // Field and value marks.
// or
v2 =       oconv("ab01"_var, "HEX") ; //  "61" "62" "30" "31"
var=strvar.iconv("HEX")

Convert a string of pairs of hexadecimal digits to a string of chars.

strvar: Must be a string of only hex digits 0-9, a-f or A-F.

Returns: A string if all input was hex digits otherwise "".

Dynamic array structure is not preserved. Any field marks prevent conversion.

This function is the exact inverse of oconv("HEX").

After prefixing a "0" to an odd sized input, the size of the output is always precisely half that of the input.

var=varnum.oconv("MX")

Convert number to hexadecimal string.

* "MX": Convert and trim leading zeros e.g. oconv(1025, "MX") -> "401"

* "MXn": Pad with up to n leading zeros but do not truncate. e.g. oconv(1025, "MX8") -> "00000401"

* "MXnT": Pad and truncate to n characters. e.g. oconv(1025, "MX2") -> "01"

"n": Width. 0-9, A-G = 10 - 16.

varnum: A number or dynamic array of numbers. Floating point numbers are rounded to integers before conversion.

Returns: A string of hexadecimal digits or a dynamic array of the same. Elements that are not numeric are left untouched and unconverted.

Dynamic array structure is preserved.

Negative numbers are treated as unsigned 8 byte integers (uint64).

* 0 -> "00"

* 1 -> "01"

* 15 -> "0F"

* -1 -> "FFFF" "FFFF" "FFFF" "FFFF" (8 x "FF")

This function is a near inverse of iconv("MX").
let v1 = "14.5]QQ]65535"_var.oconv("MX"); // "F]QQ]FFFF"_var
// or
let v2 = oconv("14.5]QQ]65535"_var, "MX");
var=strvar.iconv("MX")

Convert hexadecimal string to number.

strvar: A string or dynamic array of up to 16 hex digits: 0-9, a-f, A-F.

Returns: An integer or dynamic array of integers. Invalid elements are converted to "".

Dynamic array structure is preserved.

Hex strings are converted to unsigned 8 byte integers (uint64)

Leading zeros are ignored.

* "0" -> 0

* "00"-> 0

* "1" -> 1

* Hex "FFFFFFFFFFFFFFFF" (8 x "FF") -> -1.

* Hex "7FFFFFFFFFFFFFFF" is the maximum positive integer: 9223372036854775805.

* Hex "8000000000000000" is the maximum negative integer: -9223372036854775808.

This function is the exact inverse of oconv("MX").
let v1 = "F]QQ]FFFF"_var.iconv("MX"); // "15]]65535"_var
// or
let v2 = iconv("F]QQ]FFFF", "MX");
var=varnum.oconv("MB")

Number to binary format: Convert number to strings of 1s and 0s

varnum: If not numeric then no conversion is performed and the original value is returned.
let v1 = var(255).oconv("MB"); // 1111'1111
// or
let v2 = oconv(255, "MB");
var=strvar.oconv("TX")

Convert dynamic arrays to standard text format.

Useful for using text editors on dynamic arrays.

FMs -> \n after escaping any embedded NL

VMs -> literal "\" \n

SMs -> literal "\\" \n

etc.
// 1. Backslash in text remains backslash
let v1 = var(_BS).oconv("TX");     // _BS

// 2. Literal "\n" -> literal "\\n" (Double escape any escaped NL chars)
let v2 = var(_BS "n").oconv("TX"); // _BS _BS "n"

// 3. \n becomes literal "\n" (Single escape any NL chars)
let v3 = var(_NL).oconv("TX");     // _BS "n"

// 4. FM -> \n
let v4 = "f1^f2"_var.oconv("TX");  // "f1" _NL "f2"

// 5. VM -> "\" \n
let v5 = "v1]v2"_var.oconv("TX");  // "v1" _BS _NL "v2"

// 6. SM -> "\\" \n
let v6 = "s1}s2"_var.oconv("TX");  // "s1" _BS _BS _NL "s2"

// 7. TM -> "\\\" \n
let v7 = "t1|t2"_var.oconv("TX");  // "t1" _BS _BS _BS _NL "t2"

// 8. ST -> "\\\\" \n
let v8 = "st1~st2"_var.oconv("TX"); // "st1" _BS _BS _BS _BS _NL "st2"
var=strvar.iconv("TX")

Convert standard text format to dynamic array.

Reverse of oconv("TX") above.

Dimensioned Array Construction
Use Function Description
dim d1;Create an undimensioned array of vars pending actual dimensions.
dim d1;
dim d1(nrows, ncols = 1);Create an array of vars with a fixed number of columns and rows. All vars are unassigned.
dim d1(10);
dim d2(10, 3);
dim d1 = d2; // CopyCreate a copy of an array.
dim d1 = {2, 4, 6, 8};
dim d2 = d1;
dim d1 = dim(); // Move

Save an array created elsewhere.

Uses C++ "move" semantics.
dim d1 = "f1^f2^f3"_var.split();
dim d1 = {"a", "b", "c" ...}; // Initializer listCreate an array from a list. All elements must be the same type, var, string, double, int, etc.. but all end up as vars which are a flexible type.
dim d1 = {1, 2, 3, 4, 5};
dim d2 = {"A", "B", "C"};
dim d1 = v1;Initialise all elements of an array to some single value or constant. A var, "", 0 etc.
dim d1(10);
d1 = "";
dim d1 = sourceint;Undocumented
operator=(double sourcedbl)Undocumented
d1.redim(nrows, ncols = 1)

Resize an array to a different number of rows and columns.

Existing data will be retained as far as possible. Any additional elements are unassigned.

Resizing rows to 0 clears all data.

Resizing cols to 0 clears all data and changes its status to "undimensioned".
dim d1;
d1.redim(10, 3);
d1.swap(d2)

Swap one array with another.

Either or both may be undimensioned.
dim d1(5);
dim d2(10);
d1.swap(d2);
Array Access
Use Function Description
var v1 = d1[rowno];
d1[rowno] = v1;
Access and update elements of a one dimensional array using [] brackets
dim d1 = {1, 2, 3, 4, 5};
d1[3] = "X";
let v1 = d1[3]; // "X"
var v1 = d1[rowno, colno];
d1[rowno, colno] = v1;
Access and update elements of an two dimensional array using [] brackets
dim d1(10, 5);
d1 = "";
d1[3, 4] = "X";
let v1 = d1[3, 4]; // "X"
VARREFd2(rowno); d1(rowno) = v2
VARREFd2(rowno, colno); d1(rowno, colno) = v2
var=d1.rows()

Get the number of rows in the dimensioned array

Returns: A count. Can be zero, indicating an empty array.
dim d1(5,3);
let v1 = d1.rows(); // 5
var=d1.cols()

Get the number of columns in the dimensioned array

Returns: A count. 0 if the array is undimensioned.
dim d1(5,3);
let v1 = d1.cols(); // 3
var=d1.join(delimiter = FM)

Joins all elements into a single delimited string

delimiter: Default is FM.

Returns: A string var.
dim d1 = {"f1", "f2", "f3"};
let v1 = d1.join(); // "f1^f2^f3"_var
Array Mutation
Use Function Description
d1.splitter(str1, delimiter = FM)

Creates or updates the array from a given string.

If the dim array is undimensioned it will be dimensioned with the number of elements that the string has fields.

If the dim array is dimensioned and has more elements than there are fields in the string, the excess array elements are initialised to "". If the record has more fields than there are elements in the array, the excess fields are all left unsplit in the final element of the array.

Predimensioning arrays allows the efficient reuse of arrays in loops and ensures that all elements are assigned values, useful when reading records from db files.

Using undimensioned arrays allows the efficient handling of arrays with a very variable number of elements. e.g. os text files.
dim d1;
d1.splitter("f1^f2^f3"_var); // d1.rows() -> 3  //// Automatically dimensioned.
//
dim d2(10);
d2.splitter("f1^f2^f3"_var); // d2.rows() -> 10 /// Predimensioned. Excess elements become ""
d1.sorter(reverse = false)

Sort the elements of the array in place.

reverse: Defaults to false. If true, then the order is reversed.
dim d1 = "2,20,10,1"_var.split(",");
d1.sorter();
let v1 = d1.join(","); // "1,2,10,20"_var
d1.reverser()Reverse the elements of the array in place.
dim d1 = "2,20,10,1"_var.split(",");
d1.reverser();
let v1 = d1.join(","); // "1,10,20,2"_var
d1.shuffler()Randomly shuffle the order of the elements of the array in place.
dim d1 = "2,20,10,1"_var.split(",");
d1.shuffler();
let v1 = d1.join(","); // random
Array Conversion
Use Function Description
dim=d1.sort(reverse = false)Same as sorter() but returns a new array leaving the original untouched.
dim=d1.reverse()Same as reverser() but returns a new array leaving the original untouched.
dim=d1.shuffle()Same as shuffler() but returns a new array leaving the original untouched.
Array DB I/O
Use Function Description
d1.write(dbfile, key)

Writes a db file record created from an array.

Each element in the array becomes a separate field in the db record. Any redundant trailing FMs are suppressed.
dim d1 = "Client GD^G^20855^30000^1001.00^20855.76539"_var.split();
let file = "xo_clients", key = "GD001";
if (not deleterecord("xo_clients", "GD001")) {}; // Cleanup first
d1.write(file, key);
// or
write(d1 on file, key);
ifd1.read(dbfile, key)

Read a db file record into an array.

Each field in the database record becomes a single element in the array.

Returns: True if the record exists or false if not,

If the array is predimensioned then any excess array elements are initialised to "" and any excess record fields are left unsplit in the final array element. See dim splitter for more info.

If the array is not predimensioned (rows and cols = 0) then it will be dimensioned to have exactly the same number of rows as there are fields in the record being read.
dim d1(10);
let file = "xo_clients", key = "GD001";
if (not d1.read(file, key)) ... // d1.join() -> "Client GD^G^20855^30000^1001.00^20855.76539^^^^"_var
// or
if (not read(d1 from file, key)) ...
Array OS I/O
Use Function Description
ifd1.oswrite(osfilename, codepage = "")

Creates an entire os text file from an array

Each element of the array becomes one line in the os file delimited by \n

Any existing os file is overwritten and replaced.

codepage: Optional: Data is converted from UTF8 to the required codepage/encoding before output. If the conversion cannot be performed then return false.

Returns: True if successful or false if not.
dim d1 = "aaa=1\nbbb=2\nccc=3\n"_var.split("\n");
if (not osremove("xo_conf.txt")) {}; // Cleanup first
let osfilename = "xo_conf.txt";
if (not d1.oswrite(osfilename)) ...
// or
if (not oswrite(d1 on osfilename)) ...
ifd1.osread(osfilename, codepage = "")

Read an entire os text file into an array.

Each line in the os file, delimited by \n or \r\n, becomes a separate element in the array.

Existing data in the array is lost and the array is redimensioned to the number of lines in the input data.

codepage: Optional. Data will be converted from the specified codepage/encoding to UTF8 after being read. If the conversion cannot be performed then return false.

Returns: True if successful or false if not.

If the first \n in the file is \r\n then the whole file will be split using \r\n as delimiter.
dim d1;
let osfilename = "xo_conf.txt";
if (not d1.osread(osfilename)) ... // d1.join("\n") -> "aaa=1\nbbb=2\nccc=3\n"_var0
// or
if (not osread(d1 from osfilename)) ...
Select Lists
Use Function Description
ifselect(sortselectclause_or_filehandle = "")

Create an active select list using a natural language sort/select command.

This and all the following exoprog member functions work on an environment variable CURSOR.

Identical functions are available directly on plain var objects but vars have less functionality regarding dictionaries and environment variables which are built-in to exoprog.

Returns: True if an active select list was created, false otherwise.

In the following examples, various environment variables like RECORD, ID and MV are used instead of declaring and using named vars. In actual code, either may be freely used.
select("xo_clients by name by type with type 'A' 'B' and with balance between 0 and 2000");
if (readnext(ID)) ... ok
ifselectkeys(keys)Create an active select list from some given keys.
selectkeys("SB001^JB001^JB002"_var);
if (readnext(ID)) ... ok // ID -> "SB001"
ifhasnext()Check if a select list is active.
if (hasnext()) ... ok
ifreadnext(out key)

Get the next key from an active select list.

key: [out] A string. Typically the key of a db file record.

Returns: True if an active select list was available and the next key in the list was obtained.
selectkeys("SB001^JB001^JB002"_var);
if (readnext(ID)) ... ok // ID -> "SB001"
ifreadnext(out key, out valueno)

Get the next key and value number pair from an active select list.

key: [out] A string. Typically the key of a db file record.

valueno: [out] Is only available in select lists that have been created by sort/select commands that refer to multi-valued db dictionary fields where db records have multiple values for a specific field. In this case, a record key will appear multiple times in the select list since each multivalue is exploded for the purpose of sorting and selecting. This can be viewed as a process of "normalising" multivalues so they appear as multiple records instead of being held in a single record.

Returns: True if an active select list was available and the next key in the list was obtained.
selectkeys("SB001]2^SB001]1^JB001]2"_var);
if (readnext(ID, MV)) ... ok // ID -> "SB001" // MV -> 2
ifreadnext(out record, out key, out valueno)

Get the next record, key and value no from an active select list.

record: [out] Is only available in select lists that have been created with the final (R) option. Otherwise the record will be returned as an empty string and must be obtained using a db read() function.

key: [out] A string. Typically the key of a db file record.

valueno: [out] Is only available in select lists that have been created by sort/select commands that refer to multi-valued db dictionary fields where db records have multiple values for a specific field.

Returns: True if an active select list was available and the next key in the list was obtained.
select("xo_clients by name (R)");
if (readnext(RECORD, ID, MV)) ... ok;
assert(not RECORD.empty());
pushselect(out cursor)

Saves a pointer to the currently active select list.

This allows another select list to be activated and used temporarily before the original select list is reactivated.

cursor: [out] A var that can be passed later on to the popselect() function to reactivate the saved list.
select("xo_clients by name");
var saved_xo_clients_cursor;
pushselect(saved_xo_clients_cursor);
//
// ... work with another select list ...
//
popselect(saved_xo_clients_cursor); // Reactivate the original select list.
popselect(cursor)

Re-establish an active select list saved by pushselect().

cursor: A var created by the pushselect() function.

See pushselect() for more info.
clearselect()

Deactivate an active select list.

If no select list is active then nothing is done.
clearselect();
ifdeleterecord(filename)

Use an active select list to delete db records.

Returns: False if any records could not be deleted.

Contrast this function with the two argument "deleterecord(file, key)" function that deletes a single record.
if (select("xo_clients with type 'Q' and with balance between 0 and 100")) {
  if (deleterecord("xo_clients")) ...
}
ifdeleterecord(dbfile, key)Delete a single database file record.
let file = "xo_clients", key = "QQ001";
write("" on file, key);
if (not deleterecord(file, key)) ...
// or
write("" on file, key);
if (not file.deleterecord(key)) ...
ifsavelist(listname)

Save a currently active select list under a given name.

After saving, the list is no longer active and hasnext() will return false.

Returns: True if an active select list was saved, false if there was no active select list.

Lists are saved as a record in the "lists" file.
selectkeys("SB001^SB002"_var);
if (not savelist("my_list")) ...
ifgetlist(listname)

Reactivate a saved select list of a given name.

A saved list is obtained from the "lists" file and activated.

Returns: True if an active select list was successfully reactivated, otherwise false.
if (not getlist("my_list")) ...
ifdeletelist(listname)

Remove a saved select list by name.

A saved list is deleted from the "lists" file.
if (not deletelist("my_list")) ...
ifformlist(filename_or_command, keys = "", fieldno = 0)
ifmakelist(listname, keys)
Perform/Execute
Use Function Description
var=perform(command_line)

Run an exodus program/library's main function using a command like syntax similar to that of os executable programs.

command_line: Used to initialise the COMMAND, SENTENCE and OPTIONS environment variables of the performed exodus program/library. Analogous to passing function arguments. The first word of command_line is used as the name of the program/library to be loaded and run.

The program/library's main function should have zero arguments. Performing a program/library function with main arguments results in them being unassigned and in some case core dump may occur.

Returns: Whatever var the program/library returns, or "" if it calls stop() or abort((). The return value can be ignored and discarded without any compiler warning.

The following environment variables are initialised on entry to the main function of the program/library and are preserved untouched in the calling program.

RECUR0, RECUR1, RECUR2, RECUR3, RECUR4 to "".

ID, RECORD, MV, DICT initialised to "".

LEVEL is incremented by one.

All other environment variables are shared between the caller and callee. There is essentially only one environment in any one process or thread.

Any active select list in CURSOR is passed to the performed program/library and can be consumed by it. Conversely any active select list created by the performed program/library will be returned to the calling program. In other words, both the performing and the performed programs/libraries share a single active select list environment. This is different from execute() which gets its own private active select list, initially inactive.

Exodus program/libraries may also be called directly using conventional function calling syntax. To call an exodus program/library called progname using either the syntax "call progname(args...);" or "var v1 = progname(args...);" you must "#include " after the "programinit()" or "libraryinit()" lines in your program/library.
var=execute(command_line)

Run an exodus program/library's main function.

Identical to perform() but any currently active select list in the calling program/library is not accessible to the executed program/library and is preserved in the calling [program as is. Any select list created by the executed library is discarded when it terminates.
chain(command_line)

Close the current program and perform another one.

Identical to perform() except that the current program closes first.
var=libinfo(libname)Check if a lib exists to be performed/executed or called. Currently it does not check if it is actually loadable.
Program Termination
Use Function Description
stop(message = "")

Stop the current exodus program/library normally.

Either return to the performing or executing parent exodus program/library, or exit to the OS if none.

message: Optional. If exiting to the OS then it will be output to stdout or, if numeric, used as the exit status.
abort(message = "")

Abort the current exodus program/library.

Similar to stop but if exiting to the OS then the default exit status is 1.

message: Optional. If exiting to the OS then it will be output to stderr or, if numeric, used as the exit status.
abortall(message = "")

Abort the current exodus program/library.

Similar to abort but if exiting to the OS then the default exit status is 2.
DB File Dictionaries
Use Function Description
var=calculate(dictid)Given a dictid reads a dictrec from the current DICT file (using readc()) and then either extracts a specific field number from the current RECORD/ID/MV environment variables or calls a dict function library to calculate the result.
var=calculate(dictid, dictfile, id, record, mv = 0)Given dictid, dictfile, record, id and mv, reads a dictrec from dictfile (using readc()) and then either extracts a specific field number from the given record/id/mv or calls a dict function library to calculate the result.
var=xlate(filename, key, fieldno_or_name, mode)

Reads a record from the specified file and key (using readc()) and then either extracts a specific field number or calls calculate(dictid...) to obtain the result.

filename: Which file to read.

key: The key of the record to read.

fieldno_or_name:

* If numeric then a specific field number will be extracted.

* If "0" then the key will be returned.

* If "" then the whole record will be returned.

* dictid: calculate(dictid) will be called.

mode: Determines what to do if the record does not exist.

* "X" Return ""

* "C" Return the key.

MV: Environment variable. Will be used to select a particular value or all if zero.
I/O Conversion
Use Function Description
var=oconv(input, conversion)

iconv/oconv with access to exoprogram's environment variables.

exoprog's iconv/oconv have the ability to call custom functions like "[funname,args...]"

[NUMBER] // built-in. See doc below.

[DATE] // built-in. See doc below.

[DATEPERIOD] e.g. [DATEPERIOD,1] [DATEPERIOD,1,12]

[DATETIME] e.g. [DATETIME,4*,DOS] [DATETIME,4*,MTS] [DATETIME,4*]

[TIME2] e.g. [TIME2,MT] [TIME2,MTS] [TIME2,MTS48]

var=iconv(input, conversion)

iconv/oconv with access to exoprogram's environment variables.

exoprog's iconv/oconv have the ability to call custom functions like "[funname,args...]"

[NUMBER] // built-in. See doc below.

[DATE] // built-in. See doc below.

[DATEPERIOD] e.g. [DATEPERIOD,1] [DATEPERIOD,1,12]

[DATETIME] e.g. [DATETIME,4*,DOS] [DATETIME,4*,MTS] [DATETIME,4*]

[TIME2] e.g. [TIME2,MT] [TIME2,MTS] [TIME2,MTS48]

Ioconv Date/Time
Use Function Description
var=iconv|oconv(var, "[DATE]")

Use iconv/oconv code "[DATE,args]" when you want date conversion to depend on the environment variable DATEFMT, particularly its American/International setting. Otherwise use ordinary "D" conversion codes directly for slightly greater performance.

var: [oconv] An internal date (a number).

Returns: [oconv] A readable date in text format depending on "[DATE,args]" e.g. "31 DEC 2020" "31/12/2020" "12/31/2020"

var: [iconv] A date in text format as above.

Returns: [iconv] An internal date (a number) or "" if the input could not be understood as a valid date.

args: If args is empty then DATEFMT is used as the conversion code. If args starts with "D" then args is used as the conversion codes but any E option in DATEFMT is appended. If args does not start with "D" then args are appended to DATEFMT, a "Z" option is appended, and the result used as the conversion code. A "*" option is equivalent to a second "Z" option.

If you are calling iconv/oconv in code and DATEFMT is adequate for your needs then pass it directly as a function argument e.g. 'var v1 = iconv|oconv(v2, DATEFORMAT);' instead of indirectly like 'var v1 = iconv|oconv(v2, "[DATE]");'.
DATEFMT = "D/E";
let v1 = iconv("JAN 9 2025", "D");
assert(oconv(v1, "[DATE]"   ) == " 9/ 1/2025");  // "D/EZ" or "[DATE,D]" equivalent assuming D/E in DATEFMT (replace leading zeros with spaces)
assert(oconv(v1, "[DATE,4]" ) == " 9/ 1/2025");  // "D4Z"  equivalent assuming D/E in DATEFMT (replace leading zeros with spaces)
assert(oconv(v1, "[DATE,*4]") == "9/1/2025");    // "D4ZZ" equivalent assuming D/E in DATEFMT (trim leading zeros and spaces)
assert(oconv(v1, "[DATE,*]" ) == "9/1/2025");    // "DZZ"  equivalent assuming D/E in DATEFMT (trim leading zeros and spaces)
var=iconv|oconv(var, "[NUMBER]")

Use iconv/oconv "[NUMBER,args]" either when your numbers have currency or unit code suffixes or when you want number conversion to depend on the environment variable BASEFMT to determine thousands separator and decimal point. Otherwise use ordinary "MD" conversion codes directly for slightly greater performance.

Formatting for numbers with optional currency code/unit suffix and is sensitive to the International or European setting in BASEFMT regarding use of commas or dots for thousands separators and decimal points.

Primarily used for oconv() but can be used in reverse for iconv.

var: A number with an optional currency code or unit suffix. e.g. "12345.67USD"

Returns: A formatted number with thousands separated conventionally e.g. "12.345.67USD".

iconv/oconv("[NUMBER]") oconv leaves ndecimals untouched as in the input. iconv see below.

iconv/oconv("[NUMBER,2]") Specified number of decimal places

iconv/oconv("[NUMBER,BASE]") Decimal places as per BASEFMT

iconv/oconv("[NUMBER,*]") Leave decimal places untouched as in the input

iconv/oconv("[NUMBER,X]") Leave decimal places untouched as in the input

iconv/oconv("[NUMBER,2Z]") Z (suppress zero) combined with any other code for oconv results in empty output "" instead of "0.00" in case of zero input.

Empty input "" gives empty output "".

All leading, trailing and internal spaces are removed from the input.

A trailing currency or unit code is ignored and returned on output.

An exodus number is an optional leading + or - followed by one or more decimal digits 0-9 with a single optional decimal point placed anywhere.

If the input is non-numeric then "" is returned and STATUS set to 2. In the case of oconv with multiple fields or values each field or value is processed separately but STATUS is set to 2 if any are non-numeric.

iconv removes and oconv adds thousand separator chars. The thousands separator is "," if BASEFMT starts with "MD" or "." if it starts with "MC".

oconv:

Add thousands separator chars and optionally standardise the number of decimal places.

Multiple numbers in fields, values, subvalues etc. can be processed in one string.

Any leading + character is preserved on output.

Z suppresses zeros and returns empty string "" instead.

Special format "[NUMBER,ndecs,move_ndecs]": move_ndecs causes decimal point to be shifted left if positive or right if negative.

var v1 = oconv("1234.5USD", "[NUMBER,2]"); // "1,234.50USD" // Comma added and decimal places corrected.

iconv:

Remove all thousands separator chars and optionally standardise the number of decimal places.

If ndecs is not specified in the "[NUMBER]" pattern then ndecs is taken from the current RECORD using dictionary code NDECS if DICT is available otherwise it uses ndecs from BASEFMT.

iconv only handles a single field/value.

Optional prefix of "1/" or "/" causes the reciprocal of the number to be used. e.g. "1/100" or "/100" -> "0.01".
var v1 = iconv("1,234.5678USD", "[NUMBER]"); // "1234.57USD" // Comma removed
var=amountunit(input0, out unitx)

Split amount+currency code/unit string into number and currency code/unit.

var: "123.45USD"

Returns: e.g. "123.45"

unitx: [out] e.g. "USD"
var=amountunit(input0)

Split amount+currency code/unit string into number and currency code/unit.

var: "123.45USD"

Returns: e.g. "123.45"

unitx: [out] e.g. "USD
Time/Date Utilities
Use Function Description
var=timedate2()

Returns: Text of date and time in users time zone

e.g. "2MAR2025 11:52AM"

Offset from UTC by TZ seconds.
getdatetime(out user_date, out user_time, out system_date, out system_time, out UTC_date, out UTC_time)

Returns: User, server and UTC date and time

User date and time is determined by adding the environment variable TZ.f(1)'s TZ offset (in seconds) to UTC date/time obtained from the operating system.

"system" date and time is normally the same as UTC date/time and is determined by adding the environment variable TZ.f(2)'s TZ offset (in seconds) to UTC date/time obtained from the operating system.

var=elapsedtimetext()

Get text of elapsed time since environment variable TIMESTAMP was initialised with ostimestamp() at program/thread startup.

TIMESTAMP can be updated using ostimestamp() as and when desired.
var v1 = elapsedtimetext(); // e.g. "< 1ms"
var=elapsedtimetext(timestamp1, timestamp2)

Get text of elapsed time between two timestamps

Caution. Use ostimestamps not ostimes. One is in days and the other is in seconds.
let v1 = elapsedtimetext(0, 0.55);  // "13 hours, 12 mins"
let v2 = elapsedtimetext(0, 0.001); // "1 min, 26 secs"
Terminal I/O Utilities
Use Function Description
note(msg, options, io response)

If stdin is a terminal, output a message to stdout and optionally pause processing and request a response from the user, otherwise set the response to "" and continue.

options: R = Response requested. C upper case response.
var response;
// call note("Enter something", "RC", response);
note(msg)Output a message to stdin and continue.
call note("Hello world.");
var=decide(question, options = "")

If stdin is a terminal, pause processing, list some given options to stdout and request the user to make a choice, otherwise set the response to "" and continue.

Returns: The chosen option (value not number) or "" if the user cancelled.
var=decide(question, options, out reply, defaultreply = 1)

Same as decide() above but extended.

defaultreply: A default option if the user presses Enter.

reply: [out] The option number that the user chose or "" if they cancelled.
ifesctoexit()

If stdin is a terminal, check if a key has been pressed and, if so, pause execution and ask the user to confirm if they want to escape/cancel or resume processing.

Returns: True if a key has been pressed and the user confirms to escape/cancel. False if no key has been pressed or the user chooses to resume and not escape/cancel.
var=AT(code)

Get a string to control terminal operation.

Returns: A string to be output to the terminal in order to accomplish the desired operation.

The terminal protocol is xterminal.

code:

n Position the cursor at column number n

0 Position the cursor at column number 0

-1 Clear the screen and home the cursor

-2 Position the cursor at the top left home (x,y = 0,0)

-3 Clear from the cursor at the end of screen

-4 Clear from cursor to end of line

-40 Position the cursor at columnno 0 and clear to end of line
var=AT(x, y)

Get a terminal cursor positioning string.

Returns: A string to be output to the terminal to position the cursor at the desired screen x and y position.

The terminal protocol is xterminal.
ifgetcursor(out cursor, delayms = 3000, max_errors = 0)

Get the position of the terminal cursor.

cursor: [out] If stdin is a terminal, an FM delimited string containing the x and y coordinates of the current terminal cursor.

If stdin is not a terminatl then an empty string "" is returned.

The cursor additionally contains a third field which contains the delay in ms from the terminal.

The FM delimited string returned can be later passed to setcursor() to reposition the cursor back to its original position or it can be parsed and used accordingly.

delayms: Default 3000ms. The maximum time to wait for terminal response.

max_errors: Default is 0. If not zero, reset the number of times to error before automatically disabling getcursor(). max_errors is initialised to 3. If negative then max_errors has the the effect of disabling all future calls to getcursor().

In case the terminal fails to respond correctly within the required timeout, or is currently disabled due to too many failures, or has been specifically disabled then the returned "cursor" var contains a 4th field:

TIMEOUT - The terminal failed to respond within the timeout.

READ_ERROR - Failed to read terminal response.

INVALID_RESPONSE - Terminal response invalid.

SETUP_ERROR - Terminal setup failed.

DISABLED - Terminal is disabled due to more errors than the maximum currently set.
var cursor;
if (isterminal() and not getcursor(cursor)) ... // cursor becomes something like "0^20^0.012345"_var
var=getcursor()

Get the position of the terminal cursor.

For more info see the main getcursor() function above.
let cursor = getcursor(); // If isterminal() then cursor becomes something like "0^20^0.012345"_var
setcursor(cursor_coordinates)

If stdin is a terminal, position the cursor at x and y as per the given coordinates.

cursor_coordinates: An FM delimited string containing the x and y coordinates of the terminal cursor as can be obtained by getcursor().
if (isterminal()) {
    let cursor = getcursor(); // Save the current cursor position.
    TRACE(cursor)             // Show the saved cursor position.
    print(AT(0,0));           // Position the cursor at 0,0.
    setcursor(cursor);        // Restore its position
}
Array Utilities
Use Function Description
var=invertarray(input, pad = false)

Dynamic array fields become values and vice versa

Returns: The inverted dynamic array.

pad: If true then on return, all fields will have the same number of values with superfluous trailing VMs where necessary.
let v1 = "a]b]c^1]2]3"_var;
let v2 = invertarray(v1); // "a]1^b]2^c]3"_var
sortarray(io array, fns = "", order = "")

Sorts fields of multivalues of dynamic arrays in parallel

fns: VM separated list of field numbers to sort in parallel based on the first field number

order:

AL Ascending - Left Justified - Alphabetic

DL Descending - Left Justfiied - Alphabetic

AR Ascending - Right Justified - Numeric

DR Descending - Right Justified - Numeric
var v1 = "f1^10]20]2]1^ww]xx]yy]zz^f3^f4"_var;  // fields 2 and 3 are parallel multivalues and currently unordered.
sortarray(v1, "2]3"_var, "AR"); // v1 -> "f1^1]2]10]20^zz]yy]ww]xx^f3^f4"_var
Record Locking
Use Function Description
iflockrecord(filename, io file, keyx, recordx, waitsecs = 0, allowduplicate = false)Does not actually return record
iflockrecord(filename, io file, keyx)Does not actually return recor
ifunlockrecord(filename, io file, key)Does not actually return reco
ifunlockrecord()Does not actually return rec