Functions: Difference between revisions

From NEOSYS Dev Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
<html>
<!DOCTYPE html>
<html>
<html>
<head>
<head>
</head>
<body>


 
<!-- bootstrap css. Is this necessary? -->
<!-- highlight.js for c++ syntax highlighting -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
<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>
<!-- done below <script>hljs.highlightAll();</script> -->


<style>
<style>


/* Change highlight.js comments from default grey to green */
:root {
.hljs-comment,
    --bs-font-monospace: SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;
.hljs-quote {
color: #008000; /* This is green, you can adjust the shade as per your preference */
font-style: italic; /* Optional: You might want to keep comments italicized */
}
}
body {
margin: 10px;
    font-size: 1rem;
    font-weight: 400;
font-family: system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue","Noto Sans","Liberation Sans",Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";
line-height: 1.5;
}


</style>
pre {
margin: 0px;
white-space: pre;
overflow-x: auto;
max-width: none;
width: auto;
}


<script>
table, th, td {
//// Extend C++ language definition
border: 1px solid #a2a9b1;
//const cppLanguage = hljs.getLanguage('cpp');
}
//if (cppLanguage) {
// // Adding custom keywords
// cppLanguage.keywords = {
// ...cppLanguage.keywords,
// keyword: cppLanguage.keywords.keyword + ' round chr textchr',
// // You can also add to other categories like 'literal', 'built_in', etc.
// };
// // Register the modified language
// hljs.registerLanguage('cpp', cppLanguage);
//}


// Initialize highlight.js
th {
document.addEventListener('DOMContentLoaded', (event) => {
background-color: #eaecf0;
    hljs.highlightAll();
font-weight: bold;
});
text-align: left;
</script>
padding: 8px;
}


td {
padding: 0 0.5em 0 0.7em;
vertical-align: top;
}


.toc, .toccolours {
border: 1px solid #a2a9b1;
background-color: #f8f9fa;
padding: 5px;
font-size: 95%;
}


<!-- bootstrap css. Is this necessary? -->
.toc {
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
display: table;
padding: 7px;
}


<style>
.wikitable {
background-color: #f8f9fa;
color: #202122;
margin: 1em 0;
border: 1px solid #a2a9b1;
border-collapse: collapse;
}


body {
p {
margin: 10px;
max-width: 50ch;
}
margin: 0.4em 0 0.5em 0;
}


pre {
/* paras starting em/em get indented*/
margin: 0px;
p:has(> em:first-child) {
white-space: pre-wrap;
padding-left: 68px;
word-wrap: break-word;
border-top: 1px dashed grey;
white-space: -moz-pre-wrap;
/*border-bottom: 1px dashed grey;*/
white-space: -pre-wrap;
}
white-space: -o-pre-wrap;
overflow-wrap: break-word;
overflow-x: auto;
}


table, th, td {
/* first line of description is the title.*/
border: 1px solid #a2a9b1;
/* Exclude p with anything in it like em/em */
}
td:nth-child(3) p:first-child:not(:has(*)) {
font-weight: 500;
}


th {
/* We only use em/em for leading words (arguments) */
background-color: #eaecf0;
em {
font-weight: bold;
    display: inline-block;
text-align: left;
    min-width: 64px; /* Fill the undone indent approximately */
padding: 8px;
    margin-left: -68px; /* Undo indent for the box */
}
}


td {
/* Style em like code*/
padding: 0.2em 0.4em;
code, em {
vertical-align: top;
color:inherit; /* ignore styling from mediawiki/bootstrap etc.*/
}
font-family: var(--bs-font-monospace);
font-style: normal;
/*font-size: smaller;*/
font-weight: normal;
}


p {
img {
  margin: 0.4em 0 0.5em 0;
border: 0;
}
vertical-align: middle
}


.toc, .toccolours {
hr {
border: 1px solid #a2a9b1;
height: 1px;
background-color: #f8f9fa;
background-color: #a2a9b1;
padding: 5px;
border: 0;
font-size: 95%;
margin: 0.2em 0
}
}
.toc {
display: table;
padding: 7px;
}


.wikitable {
h1, h2, h3, h4, h5, h6 {
background-color: #f8f9fa;
color: #000;
color: #202122;
margin: 0;
margin: 1em 0;
padding-top: 0.5em;
border: 1px solid #a2a9b1;
padding-bottom: 0.17em;
border-collapse: collapse;
overflow: hidden
}
}
    img {
        border: 0;
        vertical-align: middle
    }


    hr {
h1, h2 {
        height: 1px;
margin-bottom: 0.6em;
        background-color: #a2a9b1;
border-bottom: 1px solid #a2a9b1
        border: 0;
}
        margin: 0.2em 0
    }


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


    h1,h2 {
h1 {
        margin-bottom: 0.6em;
font-size: 188%;
        border-bottom: 1px solid #a2a9b1
font-weight: normal
    }
}


    h3,h4,h5 {
h2 {
        margin-bottom: 0.3em
font-size: 150%;
    }
font-weight: normal
}


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


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


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


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


    h5 {
p {
        font-size: 108%
margin: 0.4em 0 0.5em 0
    }
}


    h6 {
p img {
        font-size: 100%
margin: 0
    }
}


    p {
ul {
        margin: 0.4em 0 0.5em 0
margin: 0.3em 0 0 1.6em;
    }
padding: 0
}


    p img {
ol {
        margin: 0
list-style-image: none
    }
}


    ul {
li {
        margin: 0.3em 0 0 1.6em;
margin-bottom: 0.1em
        padding: 0
}
    }


    ol {
dl {
        margin: 0.3em 0 0 3.2em;
display: grid;
        padding: 0;
grid-template-columns: minmax(auto, max-content) 1fr; /* Left: expands to fit content, Right: remaining space */
         list-style-image: none
/*gap: 10px;*/ /* Space between rows and columns */
    }
overflow: hidden; /* Clears floats for the dl container */
/*align-items: baseline;*/ /* Align grid items by baseline */
    align-items: stretch; /* Change from baseline to stretch to ensure equal heights */
         max-width: 50ch;
}


    li {
dt, dd {
        margin-bottom: 0.1em
margin: 0;
    }
box-sizing: border-box;
border-bottom: 1px dashed grey;
line-height: 1.5; /* Consistent line height */
vertical-align: baseline; /* Ensure text aligns on baseline */
}


    dt {
dt {
        font-weight: bold;
grid-column: 1; /* Left column */
        margin-bottom: 0.1em
padding-right: 5px;
    }
// text-align: center;
font-weight: bold;
font-family: var(--bs-font-monospace);
white-space: pre-wrap;
/* font-size: 95%;*
/* padding-top: 0.15em;*/ /* Nudge dt text baseline down to match dd */
}


    dl {
dd {
        margin-top: 0.2em;
grid-column: 2; /* Right column */
        margin-bottom: 0.5em
margin-left:1em;
    }
}


    dd {
        margin-left: 1.6em;
        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; }




<div class=toc>
/* 0. .hll/.err
<h4>Contents:</h4>
1. Comments
<ol>
2. Keywords
<li><a href=#Var_>Var </a></li>
3. Operator
<li><a href=#Var_Creation_>Var Creation </a></li>
4. Literals
<li><a href=#Arithmetical_Operators_>Arithmetical Operators </a></li>
5. Name
<li><a href=#Dynamic_Array_Creation,_Access_And_Update>Dynamic Array Creation, Access And Update</a></li>
6. Generic
<li><a href=#String_Creation_>String Creation </a></li>
7. Text.
<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>
/* Highlight and Error */
<li><a href=#I/O_Conversion>I/O Conversion</a></li>
:root {
<li><a href=#Dynamic_Array_Functions>Dynamic Array Functions</a></li>
  --highlight-bg-color: #ffffcc;
<li><a href=#Dynamic_Array_Filters>Dynamic Array Filters</a></li>
  --error-border-color: #FF0000;
<li><a href=#Dynamic_Array_Mutators_Standalone_Commands>Dynamic Array Mutators Standalone Commands</a></li>
  --highlight-font-weight: normal;
<li><a href=#Dynamic_Array_Search>Dynamic Array Search</a></li>
  --highlight-font-style: normal;
<li><a href=#Database_Access>Database Access</a></li>
  --master-bold: bold; /*var(--master-bold)*/
<li><a href=#Database_Management>Database Management</a></li>
  --master-italic: normal; /*var(--master-italic)*/
<li><a href=#Database_File_I/O>Database File I/O</a></li>
}
<li><a href=#Database_Sort/Select>Database Sort/Select</a></li>
.hll { background-color: var(--highlight-bg-color); font-weight: var(--highlight-font-weight); font-style: var(--highlight-font-style); }
<li><a href=#OS_Time/Date>OS Time/Date</a></li>
.err { border: 1px solid var(--error-border-color); font-weight: var(--highlight-font-weight); font-style: var(--highlight-font-style); } /* Error */
<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>
/* Comments */
</div>
:root {
  --comment-main-color: #3D7B7B;
  --comment-preproc-color: #9C6500;
  --comment-font-weight: var(--master-bold);
  --comment-font-style: var(--master-italic);
}
.c  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment */
.ch  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Hashbang */
.cm  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Multiline */
.cp  { color: var(--comment-preproc-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Preproc */
.cpf { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.PreprocFile */
.c1  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Single */
.cs  { color: var(--comment-main-color); font-weight: var(--comment-font-weight); font-style: var(--comment-font-style); } /* Comment.Special */


/* Keywords */
:root {
  --keyword-main-color: #008000; /*green*/
  --keyword-type-color: #B00040; /*reddish*/
  --keyword-flow-color: #FF5722; /*orange*/
  --keyword-cnst-color: #FF0000; /*red*/
  --keyword-font-weight: var(--master-bold);
  --keyword-font-style: normal;
}
.k  { color: var(--keyword-main-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword */
.kc  { color: var(--keyword-cnst-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Constant */


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


<table class=wikitable>
.kn  { color: var(--keyword-main-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Namespace */
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
.kp  { color: var(--keyword-main-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Pseudo */
</table>
 
<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>
    'libraryinit', 'libraryexit',
<tr><td></td><td>var v1;</td><td><p>Create an unassigned var.
    'commoninit', 'commonexit',
</p>
    'dictinit', 'dictexit'*/
<p>Unassigned variables can be assigned conditionally in if/else statements or used as outbound arguments of function calls.
.kt  { color: var(--keyword-type-color); font-weight: var(--keyword-font-weight); font-style: var(--keyword-font-style); } /* Keyword.Type */
</p>
A runtime error is thrown if a var is used before being assigned so silent "use before assign" bugs cannot occur.


<pre><code class='hljs-ncdecl language-javascript'>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='hljs-ncdecl language-javascript'>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='hljs-ncdecl language-javascript'>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='hljs-ncdecl language-javascript'>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='hljs-ncdecl language-javascript'>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='hljs-ncdecl language-javascript'>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='hljs-ncdecl language-javascript'>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.
<div class=toc>
</p>
<h4 id=var>Contents:</h4>
<p><em>typ:</em>
<ol>
</p>
<li><a href=#Var_Creation_>Var Creation </a></li>
<p>0x01 str is available.
<li><a href=#Arithmetical_Operators_>Arithmetical Operators </a></li>
</p>
<li><a href=#Dynamic_Array_Creation,_Access_And_Update>Dynamic Array Creation, Access And Update</a></li>
<p>0x02 int is available.
<li><a href=#String_Creation_>String Creation </a></li>
</p>
<li><a href=#String_Scanning>String Scanning</a></li>
<p>0x04 dbl is available.
<li><a href=#String_Conversion_-_Non-Mutating_-_Chainable>String Conversion - Non-Mutating - Chainable</a></li>
</p>
<li><a href=#String_Mutation_-_Standalone_Commands>String Mutation - Standalone Commands</a></li>
<p>0x08 nan: str is not a number.
<li><a href=#I/O_Conversion>I/O Conversion</a></li>
</p>
<li><a href=#Dynamic_Array_Functions>Dynamic Array Functions</a></li>
0x16 osfile: str, int and dbl have special meaning.
<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>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = str("x", 32);
<li><a href=#Dynamic_Array_Search>Dynamic Array Search</a></li>
v1.dump().outputl(); /// e.g. var:0x7ffea7462cd0 typ:1 str:0x584d9e9f6e70 "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
<li><a href=#Database_Access>Database Access</a></li>
// or
<li><a href=#Database_Management>Database Management</a></li>
outputl(dump(v1));</code></pre>
<li><a href=#Database_File_I/O>Database File I/O</a></li>
 
<li><a href=#Database_Sort/Select>Database Sort/Select</a></li>
</td></tr>
<li><a href=#OS_Time/Date>OS Time/Date</a></li>
</table>
<li><a href=#OS_File_I/O>OS File I/O</a></li>
<h5 id=Arithmetical_Operators_>Arithmetical Operators </h5>
<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><p><code></code></p></td><td><p><code>var v1;</code></p></td><td><p>Create an unassigned var.</p>
<p>Unassigned variables can be assigned conditionally in if/else statements or used as outbound arguments of function calls.</p>
<p>A runtime error is thrown if a var is used before being assigned so silent "use before assign" bugs cannot occur.</p>
<p>
<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>
<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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> True if a var holds a double, an integer, or a string that is defined as numeric.
<p>
<div class="highlight light"><pre><span class="c1">//            Exodus keywords:    C++ declarations:</span>
<span class="c1">//            Non-Const  Const    Non-Const  Const</span>
<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>
</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.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>var v1 = expression;</code></p></td><td><p>Assign a var using a literal or an expression.</p>
<p>Use "let" instead of "var" wherever possible as a shorthand way of writing "const var".</p>
<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>
<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='hljs-ncdecl language-javascript'>if ("+123.45"_var.isnum()) ... ok
<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>
if (      ""_var.isnum()) ... ok
<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>
if (not  "."_var.isnum()) ... ok
<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>
// or
if (isnum("123.")) ... ok</code></pre>


<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>
</p>
</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><p><code>if</code></p></td><td><p><code>v1.assigned()</code></p></td><td><p>Check if a var has been assigned a value.</p>
<p><em>return:</em> True if the var is assigned, otherwise false</p>
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>v1.unassigned()</code></p></td><td><p>Check if a var has not been assigned a value;</p>
<p><em>return:</em> True if the var is unassigned, otherwise false</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v2.or_default(defaultvalue)</code></p></td><td><p>Copy a var or, if it is unassigned, copy a default value.</p>
<p><em>return:</em> A copy of the var if it is assigned or the default value if it is not.</p>
<p>Can be used to handle optional arguments in functions.</p>
<p><em>defaultvalue:</em> Cannot be unassigned.</p>
<p>
<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><em>Returns:</em> A guaranteed numeric var
<p></p>
<p><em>Mutator:</em> defaulter()</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>v1.defaulter(defaultvalue)</code></p></td><td><p>If a var is unassigned, assign a default value.</p>
<p>If the var is unassigned then assign the default value to it, otherwise do nothing.</p>
<p><em>defaultvalue:</em> Cannot be unassigned.</p>
<p>
<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="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>
<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>
</pre></div>
</p>
</p>
Allows working numerically with data that may be non-numeric.
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "123.45"_var.num();    // 123.45
var v2 = "abc"_var.num() + 100; // 100</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>v2 + v3</td><td><p>Addition
<tr><td><p><code></code></p></td><td><p><code>v1.swap(io v2)</code></p></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>
<p>Eiher or both variables may be unassigned.</p>
<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="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>
</p>
</p>
<p>Attempts to perform numeric operations on non-numeric strings will throw a runtime error VarNonNumeric.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v2.move()</code></p></td><td><p>Move a var into another.</p>
<p>Shallow copy of var data and take ownership of the moved var's string if any. 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>
<p>The moved var must be assigned otherwise a VarUnassigned error is thrown.</p>
<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="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>
</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.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v2.clone()</code></p></td><td><p>Return a copy of the var.</p>
<p>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>
</p>
</p>
<p>Internally, 0.1 + 0.2 looks like this using doubles.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v1.dump()</code></p></td><td><p>Return a string describing internal data of a var.</p>
<p>If the str is located on the heap then its address is given.</p>
<p><em>typ:</em> </p>
<dl>
<dt>0x01</dt><dd>str is available.</dd>
<dt>0x02</dt><dd>int is available.</dd>
<dt>0x04</dt><dd>dbl is available.</dd>
<dt>0x08</dt><dd>nan: str is not a number.</dd>
<dt>0x16</dt><dd>osfile (nan is true, str, int and dbl have special meaning).</dd>
</dl>
<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="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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
0.10000000000000003 + 0.20000000000000004 -> 0.30000000000000004
<pre><code class='hljs-ncdecl language-javascript'>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>
</table>
<tr><td>var=</td><td>v2 * v3</td><td>Multiplication</td></tr>
<h5 id=Arithmetical_Operators_>Arithmetical Operators </h5>
<tr><td>var=</td><td>v2 / v3</td><td>Division</td></tr>
<tr><td>var=</td><td>v2 % v3</td><td>Modulus</td></tr>
<tr><td></td><td>v1 += v2</td><td>Self addition
 
<pre><code class='hljs-ncdecl language-javascript'>var v1 = 0.1;
v1 += 0.2; // 0.3</code></pre>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>v1.isnum()</code></p></td><td><p>Check if a var is numeric.</p>
<p><em>return:</em> True if a var holds a double, an integer, or a string that is defined as numeric.</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.</p>
<p>
<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>
</p>
</td></tr>
</td></tr>
<tr><td></td><td>v1 -= v2</td><td>Self subtraction</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v1.num()</code></p></td><td><p>Return a copy of the var if it is numeric or 0 otherwise.</p>
<tr><td></td><td>v1 *= v2</td><td>Self multiplication</td></tr>
<p>Allow working numerically with data that may be non-numeric.</p>
<tr><td></td><td>v1 /= v2</td><td>Self division</td></tr>
<p><em>return:</em> A guaranteed numeric var</p>
<tr><td></td><td>v1 %= v2</td><td>Self modulus</td></tr>
<p>
<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="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>
 
<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>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = 3;
</pre></div>
var v2 = v1 ++; // v2 -> 3 // v1 -> 4</code></pre>
</p>
 
</td></tr>
</td></tr>
<tr><td></td><td>v1 --</td><td>Post decrement
<tr><td><p><code>var=</code></p></td><td><p><code>v2 + v3</code></p></td><td><p>Addition</p>
 
<p>Any attempt to perform numeric operations on non-numeric strings will throw a runtime error VarNonNumeric.</p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = 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>
var v2 = v1 --; // v2 -> 3 // v1 -> 2</code></pre>
<p>Internally, 0.1 + 0.2 looks like this using doubles.</p>
 
<p>0.10000000000000003 + 0.20000000000000004 -&gt; 0.30000000000000004</p>
<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>
<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>
</p>
</td></tr>
</td></tr>
<tr><td></td><td>++ v1</td><td>Pre increment
<tr><td><p><code>var=</code></p></td><td><p><code>v2 - v3</code></p></td><td><p>Subtraction</p>
 
</td></tr>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = 3;
<tr><td><p><code>var=</code></p></td><td><p><code>v2 * v3</code></p></td><td><p>Multiplication</p>
var v2 = ++ v1; // v2 -> 4 // v1 -> 4</code></pre>
</td></tr>
 
<tr><td><p><code>var=</code></p></td><td><p><code>v2 / v3</code></p></td><td><p>Division</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v2 % v3</code></p></td><td><p>Modulus</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>v1 += v2</code></p></td><td><p>Self addition</p>
<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>
<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>
</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>v1 -= v2</code></p></td><td><p>Self subtraction</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>v1 *= v2</code></p></td><td><p>Self multiplication</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>v1 /= v2</code></p></td><td><p>Self division</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>v1 %= v2</code></p></td><td><p>Self modulus</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>v1 ++</code></p></td><td><p>Post increment</p>
<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">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>
</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>v1 --</code></p></td><td><p>Post decrement</p>
<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">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>
</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>++ v1</code></p></td><td><p>Pre increment</p>
<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">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>
</p>
</td></tr>
</td></tr>
<tr><td></td><td>-- v1</td><td>Pre decrement
<tr><td><p><code></code></p></td><td><p><code>-- v1</code></p></td><td><p>Pre decrement</p>
 
<p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = 3;
<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>
var v2 = -- v1; // v2 -> 2 // v1 -> 2</code></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="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>
</p>
</td></tr>
</td></tr>
</table>
</table>
Line 455: Line 675:
<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>""_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:
<tr><td><p><code>var=</code></p></td><td><p><code>""_var</code></p></td><td><p>Literal suffix "_var".</p>
<p>Allow dynamic arrays to be seamlessly embedded in code using a predefined set of visible equivalents of unprintable field mark characters as follows:</p>
<p>Visible equivalents:</p>
<dl>
<dt>`</dt><dd>RM  Record mark</dd>
<dt>^</dt><dd>FM  Field mark</dd>
<dt>]</dt><dd>VM  Value mark</dd>
<dt>}</dt><dd>SM  Subvalue mark</dd>
<dt>|</dt><dd>TM  Text mark</dd>
<dt>~</dt><dd>ST  Subtext mark</dd>
</dl>
<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="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></div>
</p>
</p>
<p>` = RM, Record mark
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>var v1 = {"a", "b", "c" ...}; // Initializer list</code></p></td><td><p>Code a dynamic array var as as list.</p>
<p>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.</p>
<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="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>
</p>
</p>
<p>^ = FM, Field mark
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v2(fieldno);      v1(fieldno) = v2</code></p></td><td><p>Dynamic array field extraction, update and append:</p>
<p>See also inserter() and remover().</p>
<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="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>
</p>
</p>
<p>] = VM, Value mark
<p></p>
<p>Field access:</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>
<p>Furthermore using plain round brackets without the leading .f can be confused with function call syntax.</p>
<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="s">&quot;aa^bb^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="w"> </span><span class="c1">// &quot;bb&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="w"> </span><span class="c1">// &quot;bb&quot; ///  () style access. Not recommended.</span>
</pre></div>
</p>
</p>
<p>} = SM, Subvalue mark
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v2(fieldno, valueno);      v1(fieldno, valueno) = v2</code></p></td><td><p>Dynamic array value update and append</p>
<p>See also inserter() and remover().</p>
<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="s">&quot;aa^b1]b2^cc&quot;</span><span class="kt">_var</span><span class="p">;</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">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>
<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>
</p>
</p>
<p>| = TM, Text mark
<p></p>
<p>Value access:</p>
<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="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>
</p>
</p>
~ = ST, Subtext mark
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "f1^f2^v1]v2^f4"_var; // "f1" _FM "f2" _FM "v1" _VM "v2" _FM "f4"</code></pre>
</td></tr>
</td></tr>
<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.
</table>
 
<h5 id=String_Creation_>String Creation </h5>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = {11, 22, 33}; // "11^22^33"_var</code></pre>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>v2 ^ v3</code></p></td><td><p>String concatention operator ^</p>
<p>At least one side must be a var.</p>
<p>"aa" ^ "22" will not compile but "aa" "22" will.</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.
<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>
<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>
</pre></div>
</p>
</td></tr>
</td></tr>
<tr><td>var=</td><td>v2(fieldno);       v1(fieldno) = v2</td><td><p>Dynamic array - field extraction, update and append:
<tr><td><p><code></code></p></td><td><p><code>v1 ^= v2</code></p></td><td><p>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>
</p>
</p>
<p>See also inserter() and remover().
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.round(ndecimals = 0)</code></p></td><td><p>Round a number.</p>
<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 -&gt; 2 and -2.5 -&gt; -3</p>
<p><em>var:</em> The number to be converted.</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.</p>
<p><em>return:</em> A var containing an ASCII string of digits with a leading "-" if negative, and a decimal point "." if ndecimals is &gt; 0.</p>
<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="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='hljs-ncdecl language-javascript'>var v1 = "aa^bb"_var;
<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>
v1(4) = 44; // v1 -> "aa^bb^^44"_var
<span class="c1">// or</span>
// Field number -1 causes appending a field when updating.
<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>
v1(-1) = "55"; // v1 -> "aa^bb^^44^55"_var</code></pre>


Field access:
<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>
</p>
<p>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>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::chr(num)</code></p></td><td><p>Get a char.</p>
<p><em>num:</em> An integer 0-255.</p>
<p><em>return:</em> A string containing a single char</p>
<p>0-127 -&gt; ASCII, 128-255 -&gt; invalid UTF-8 which cannot be written to the database or used in many exodus string operations</p>
<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>
<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></div>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::textchr(num)</code></p></td><td><p>Get a Unicode character.</p>
<p><em>num:</em> A Unicode Code Point (Number)</p>
<p><em>return:</em> A single Unicode character in UTF8 encoding.</p>
<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">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>
<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">textchr</span><span class="p">(</span><span class="mi">171416</span><span class="p">);</span>
</pre></div>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::textchrname(unicode_code_point)</code></p></td><td><p>Get a Unicode character name</p>
<p><em>unicode_code_point:</em> 0 - 0x10FFFF.</p>
<p><em>return:</em> Text of the name or "" if not a valid Unicode Code Point</p>
<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">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>
</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 =.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.str(num)</code></p></td><td><p>Get a string of repeated substrings.</p>
<p><em>var:</em> The substring to be repeated</p>
<p><em>num:</em> How many times to repeat the substring</p>
<p><em>return:</em> A string</p>
<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="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>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::space(nspaces)</code></p></td><td><p>Get a string as a given number of spaces.</p>
<p><em>nspaces:</em> The number of spaces required.</p>
<p><em>return:</em> A string of space chars.</p>
<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">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>
<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">space</span><span class="p">(</span><span class="mi">3</span><span class="p">);</span>
</pre></div>
</p>
</p>
Furthermore using plain round brackets without the leading .f can be confused with function call syntax.
<pre><code class='hljs-ncdecl language-javascript'>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>
</td></tr>
<tr><td>var=</td><td>v2(fieldno, valueno);       v1(fieldno, valueno) = v2</td><td><p>Dynamic array - value update and append
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.numberinwords(locale = "")</code></p></td><td><p>Get a number written out in words insteads of digits.</p>
<p><em>return:</em> A string.</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".</p>
<p>
<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>
</p>
</p>
See also inserter() and remover().
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
Value access:
<pre><code class='hljs-ncdecl language-javascript'>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=String_Scanning>String Scanning</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><p><code>var=</code></p></td><td><p><code>strvar.at(pos1)</code></p></td><td><p>Get a single char from a string.</p>
<p><em>pos1:</em> First char is 1. Last char is -1.</p>
<p><em>return:</em> A single char if pos1 +/- the length of the string, or "" if greater. Returns the first char if pos1 is 0 or (-pos1) &gt; 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>
</p>
</p>
<p>At least one side must be a var.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.ord()</code></p></td><td><p>Get the char number of a char.</p>
<p><em>return:</em> A number between 0 and 255.</p>
<p>If given a string, then only the first char is considered.</p>
<p>Equivalent to ord() in php</p>
<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="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>
<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">ord</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>"aa" ^ "22" will not compile but "aa" "22" will.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.textord()</code></p></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><em>return:</em> A number 0 to 0x10FFFF.</p>
<p>Equivalent to ord() in python and ruby, mb_ord() php.</p>
<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="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>
</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.
<pre><code class='hljs-ncdecl language-javascript'>var v2 = "aa";
var v1 = v2 ^ 22; // "aa22"</code></pre>
</td></tr>
</td></tr>
<tr><td></td><td>v1 ^= v2</td><td>String self concatention ^= (append)
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.len()</code></p></td><td><p>Get the length of a source string in number of chars.</p>
 
<p><em>return:</em> A number</p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "aa";
<p>
v1 ^= 22; // v1 -> "aa22"</code></pre>
<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>
<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">len</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</p>
</td></tr>
</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.
<tr><td><p><code>if</code></p></td><td><p><code>strvar.empty()</code></p></td><td><p>Check if the var is an empty string.</p>
<p><em>return:</em> True if it is empty amd false if not.</p>
<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>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>
<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="s">&quot;0&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="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>
<span class="c1">// or</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">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>
</p>
</p>
<p>Trailing zeros are not omitted. A leading "0." is shown where appropriate.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.textwidth()</code></p></td><td><p>Count the number of output columns required for a given source string.</p>
<p><em>return:</em> A number</p>
<p>Allow wide multi-column Unicode characters that occupy more than one space in a text file or terminal screen.</p>
<p>Reduce combining characters to a single column. e.g. "e" followed by grave accent is multiple bytes but only occupies one output column.</p>
<p>Does not properly calculate all possible combining sequences of graphemes e.g. face followed by colour</p>
<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="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>
</p>
</p>
<p>0.5 always rounds away from zero. i.e. 1.5 -> 2 and -2.5 -> -3
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.textlen()</code></p></td><td><p>Count the number of Unicode code points in a source string.</p>
<p><em>return:</em> A number.</p>
<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="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>
<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">textlen</span><span class="p">(</span><span class="s">&quot;Γιάννης&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>var:</em> The number to be converted.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.fcount(sepstr)</code></p></td><td><p>Count the number of fields in a source string.</p>
<p><em>sepstr:</em> The separator character or substr that delimits individual fields.</p>
<p><em>return:</em> The count of the number of fields</p>
<p>This is similar to "var.count(sepstr) + 1" but it returns 0 for an empty source string.</p>
<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="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>
</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.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.count(sepstr)</code></p></td><td><p>Count the number of occurrences of a given substr in a source string.</p>
<p><em>substr:</em> The substr to count.</p>
<p><em>return:</em> The count of the number of sepstr found.</p>
<p>Overlapping substrings are not counted.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<em>Returns:</em> A var containing an ASCII string of digits with a leading "-" if negative, and a decimal point "." if ndecimals is > 0.
<pre><code class='hljs-ncdecl language-javascript'>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='hljs-ncdecl language-javascript'>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><p><code>if</code></p></td><td><p><code>strvar.starts(prefix)</code></p></td><td><p>Check if a source string starts with a given prefix (substr).</p>
<p><em>prefix:</em> The substr to check for.</p>
<p><em>return:</em> True if the source string starts with the given prefix.</p>
<p>Always returns false if suffix is "". DIFFERS from c++, javascript, python3. See contains() for more info.</p>
<p>
<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>
</p>
</p>
<p><em>Returns:</em> A string containing a single char
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.ends(suffix)</code></p></td><td><p>Check if a source string ends with a given suffix (substr).</p>
<p><em>suffix:</em> The substr to check for.</p>
<p><em>return:</em> True if the source string ends with given suffix.</p>
<p>Always returns false if suffix is "". DIFFERS from c++, javascript, python3. See contains() for more info.</p>
<p>
<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>
</p>
</p>
0-127 -> ASCII, 128-255 -> invalid UTF-8 which cannot be written to the database or used in many exodus string operations
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var::chr(0x61); // "a"
// or
let v2 = chr(0x61);</code></pre>
</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)
<tr><td><p><code>if</code></p></td><td><p><code>strvar.contains(substr)</code></p></td><td><p>Check if a given substr exists in a source string.</p>
<p><em>substr:</em> The substr to check for.</p>
<p><em>return:</em> True if the source string starts with, ends with or contains the given substr.</p>
<p>Always returns false if substr is "". DIFFERS from c++, javascript, python3. See contains() for more info.</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>
<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.</p>
<p>
<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>
</p>
</p>
<em>Returns:</em> A single Unicode character in UTF8 encoding.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var::textchr(171416); // "𩶘" // or "\xF0A9B698"
// or
let v2 = textchr(171416);</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::textchrname(unicode_code_point)</td><td><p>Get a Unicode character name
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.index(substr, startchar1 = 1)</code></p></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>return:</em> The char position (1 based) that the substr is found at or 0 if not present.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>unicode_code_point:</em> 0 - 0x10FFFF.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.indexn(substr, occurrence)</code></p></td><td><p>Find the nth occurrence of a substr in a source string.</p>
<p><em>substr:</em> The string to search for.</p>
<p><em>return:</em> char position (1 based) or 0 if not present.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<em>Returns:</em> Text of the name or "" if not a valid Unicode Code Point
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var::textchrname(91); // "LEFT SQUARE BRACKET"
// or
let v2 = textchrname(91);</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>varstr.str(num)</td><td><p>Get a string of repeated substrings.
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.indexr(substr, startchar1 = -1)</code></p></td><td><p>Find the position of substr working backwards</p>
<p>Start at the end and work backwards.</p>
<p><em>substr:</em> The string to search for.</p>
<p><em>return:</em> The char position of the substr if found, or 0 if not.</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.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>var:</em> The substring to be repeated
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.match(regex_str, regex_options = "")</code></p></td><td><p>Find all matches of a given regular expression.</p>
<p><em>return:</em> Zero or more matching substrings separated by FMs. Any groups are in VMs.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>num:</em> How many times to repeat the substring
<p></p>
</p>
<p><em>regex_options:</em> </p>
<em>Returns:</em> A string
<dl>
 
<dt>l</dt><dd>Literal (any regex chars are treated as normal chars)</dd>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "ab"_var.str(3); // "ababab"
<dt>i</dt><dd>Case insensitive</dd>
// or
<dt>p</dt><dd>ECMAScript/Perl (the default)</dd>
let v2 = str("ab", 3);</code></pre>
<dt>b</dt><dd>Basic POSIX (same as sed)</dd>
 
<dt>e</dt><dd>Extended POSIX</dd>
<dt>a</dt><dd>awk</dd>
<dt>g</dt><dd>grep</dd>
<dt>eg</dt><dd>egrep or grep -E</dd>
</dl>
<p></p>
<p>char ranges like a-z are locale sensitive if ECMAScript</p>
<p></p>
<p><em>regex_options:</em> </p>
<dl>
<dt>m</dt><dd>Multiline. Default in boost (and therefore exodus)</dd>
<dt>s</dt><dd>Single line. Default in std::regex</dd>
<dt>f</dt><dd>First only. Only for replace() (not match() or search())</dd>
<dt>w</dt><dd>Wildcard glob style (e.g. *.cfg) not regex style. Only for match() and search(). Not replace().</dd>
</dl>
</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><p><code>var=</code></p></td><td><p><code>strvar.match(regex)</code></p></td><td><p>Ditto</p>
</p>
<p><em>nspaces:</em> The number of spaces required.
</p>
<em>Returns:</em> A string of space chars.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var::space(3); // "␣␣␣"
// or
let v2 = space(3);</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>varnum.numberinwords(locale = "")</td><td>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.search(regex_str, io startchar1, regex_options = "")</code></p></td><td><p>Search for the first match of a regular expression.</p>
<p><em>Returns:</em> A string representing a given number written in words instead of digits.
<p><em>startchar1:</em> [in] char position to start the search from</p>
<p><em>startchar1[out]:</em> char position to start the next search from or 0 if no more matches.</p>
<p><em>return:</em> The 1st match like match()</p>
<p>regex_options as for match()</p>
<p>
<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>
<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>
<span class="c1">// or</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>
<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>
</pre></div>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.search(regex_str)</code></p></td><td><p>Ditto starting from first char</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.search(regex, io startchar1)</code></p></td><td><p>Ditto given a rex</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.search(regex)</code></p></td><td><p>Ditto starting from first char.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.hash(std::uint64_t modulus = 0)</code></p></td><td><p>Get a hash of a source string.</p>
<p><em>modulus:</em> The result is limited to [0, modulus)</p>
<p><em>return:</em> A 64 bit signed integer.</p>
<p>MurmurHash3 is used.</p>
<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="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>
<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">hash</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</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".
<pre><code class='hljs-ncdecl language-javascript'>let softhyphen = "\xc2\xad";
let v1 = var(123.45).numberinwords("de_DE").replace(softhyphen, " "); // "ein␣hundert␣drei␣und␣zwanzig␣Komma␣vier␣fünf"</code></pre>
</td></tr>
</td></tr>
</table>
</table>
<h5 id=String_Scanning>String Scanning</h5>
<h5 id=String_Conversion_-_Non-Mutating_-_Chainable>String Conversion - Non-Mutating - Chainable</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><p><code>var=</code></p></td><td><p><code>strvar.ucase()</code></p></td><td><p>Convert to upper case</p>
<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="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>
<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">ucase</span><span class="p">(</span><span class="s">&quot;Γιάννης&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>pos1:</em> First char is 1. Last char is -1.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.lcase()</code></p></td><td><p>Convert to lower case</p>
<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="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>
<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">lcase</span><span class="p">(</span><span class="s">&quot;ΓΙΆΝΝΗΣ&quot;</span><span class="p">);</span>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "abc";
var v2 = v1.at(2);  // "b"
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><p><code>var=</code></p></td><td><p><code>strvar.tcase()</code></p></td><td><p>Convert to title case.</p>
<p><em>return:</em> Original source string with the first letter of each word is capitalised.</p>
<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="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>
<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">tcase</span><span class="p">(</span><span class="s">&quot;γιάννης παππάς&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A number between 0 and 255.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.fcase()</code></p></td><td><p>Convert to folded case.</p>
<p>Case folding is the process of converting text to a case independent representation.</p>
<p><em>return:</em> The source string standardised in a way to enable consistent indexing and searching,</p>
<p><em>https:</em> //www.w3.org/International/wiki/Case_folding</p>
<p>Accents can be significant. As in French cote, coté, côte and côté.</p>
<p>Case folding is not locale-dependent.</p>
<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="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>
<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">tcase</span><span class="p">(</span><span class="s">&quot;Grüßen&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>If given a string, then only the first char is considered.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.normalize()</code></p></td><td><p>Replace Unicode character sequences with their standardised NFC form.</p>
<p>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.</p>
<p>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.</p>
<p>Normalization is not locale-dependent.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
Equivalent to ord() in php
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.ord(); // 0x61 // decimal 97, 'a'
// or
let v2 = ord("abc");</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.invert()</code></p></td><td><p>Simple reversible disguising of string text.</p>
<p>It works by treating the string as UTF8 encoded Unicode code points and inverting the first 8 bits of their Unicode Code Points.</p>
<p><em>return:</em> A string.</p>
<p>invert(invert()) returns to the original text.</p>
<p>ASCII bytes become multibyte UTF-8 so string sizes increase.</p>
<p>Inverted characters remain on their original Unicode Code Page but are jumbled up.</p>
<p>Non-existant Unicode Code Points may be created but UTF8 encoding remains valid.</p>
<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="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>
<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">invert</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>var:</em> A UTF-8 string. Only the first Unicode character is considered.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.lower()</code></p></td><td><p>Reduce all types of field mark chars by one level.</p>
<p>Convert all FM to VM, VM to SM etc.</p>
<p><em>return:</em> The converted string.</p>
<p>Note that subtext ST chars are not converted because they are already the lowest level.</p>
<p>String size remains identical.</p>
<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="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>
<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">lower</span><span class="p">(</span><span class="s">&quot;a1^b2^c3&quot;</span><span class="kt">_var</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A number 0 to 0x10FFFF.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.raise()</code></p></td><td><p>Increase all types of field mark chars by one level.</p>
<p>Convert all VM to FM, SM to VM etc.</p>
<p><em>return:</em> The converted string.</p>
<p>The record mark char RM is not converted because it is already the highest level.</p>
<p>String size remains identical.</p>
<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="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>
<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="s">&quot;a1]b2]c3&quot;</span><span class="kt">_var</span><span class="p">;</span>
</pre></div>
</p>
</p>
Equivalent to ord() in python and ruby, mb_ord() php.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "Γ"_var.textord(); // 915 // U+0393: Greek Capital Letter Gamma (Unicode character)
// 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><p><code>var=</code></p></td><td><p><code>strvar.crop()</code></p></td><td><p>Remove any redundant FM, VM etc. chars (Trailing FM; VM before FM etc.)</p>
<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="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>
<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">crop</span><span class="p">(</span><span class="s">&quot;a1^b2]]^c3^^&quot;</span><span class="kt">_var</span><span class="p">);</span>
</pre></div>
</p>
</p>
<em>Returns:</em> A number
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.len(); // 3
// or
let v2 = len("abc");</code></pre>
</td></tr>
</td></tr>
<tr><td>if</td><td>strvar.empty()</td><td><p>Checks if the var is an empty string.
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.quote()</code></p></td><td><p>Wrap in double quotes.</p>
<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="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>
<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">quote</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> True if it is empty amd false if not.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.squote()</code></p></td><td><p>Wrap in single quotes.</p>
<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="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>
<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">squote</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</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())'
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.unquote()</code></p></td><td><p>Remove one pair of surrounding double or single quotes.</p>
<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="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>
<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">unquote</span><span class="p">(</span><span class="s">&quot;&#39;abc&#39;&quot;</span><span class="p">);</span>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "0";
if (not v1.empty()) ... ok // true
// or
if (not empty(v1)) ... ok // true</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.textwidth()</td><td><p>Count the number of output columns required for a given source string.
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.trim(trimchars = " ")</code></p></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.</p>
<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="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>
<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">trim</span><span class="p">(</span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A number
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.trimfirst(trimchars = " ")</code></p></td><td><p>Ditto but only leading.</p>
<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="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>
<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">trimfirst</span><span class="p">(</span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>Allows wide multi-column Unicode characters that occupy more than one space in a text file or terminal screen.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.trimlast(trimchars = " ")</code></p></td><td><p>Ditto but only trailing.</p>
<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="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>
<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">trimlast</span><span class="p">(</span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="p">);</span>
</pre></div>
</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.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.trimboth(trimchars = " ")</code></p></td><td><p>Ditto but only leading and trailing, not inner.</p>
<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="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>
<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">trimboth</span><span class="p">(</span><span class="s">&quot;␣␣a1␣␣b2␣c3␣␣&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
Does not properly calculate all possible combining sequences of graphemes e.g. face followed by colour
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "🤡x🤡"_var.textwidth(); // 5
// or
let v2 = textwidth("🤡x🤡");</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.first()</code></p></td><td><p>Get the first char of a string.</p>
<p><em>return:</em> A char, or "" if empty.</p>
<p>Equivalent to var.substr(1,length) or var[1, length] in Pick OS</p>
<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="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>
<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">first</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<em>Returns:</em> A number.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "Γιάννης"_var.textlen(); // 7
// or
let v2 = textlen("Γιάννης");</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.fcount(sepstr)</td><td><p>Count the number of fields in a source string.
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.last()</code></p></td><td><p>Get the last char of a string.</p>
<p><em>return:</em> A char, or "" if empty.</p>
<p>Equivalent to var.substr(-1, 1) or var[-1, 1] in Pick OS</p>
<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="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>
<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">last</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>sepstr:</em> The separator character or substr that delimits individual fields.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.first(length)</code></p></td><td><p>Get the first n chars of a source string.</p>
<p><em>length:</em> The number of chars (bytes) to get.</p>
<p><em>return:</em> A string of up to n chars.</p>
<p>Equivalent to var.substr(1, length) or var[1, length] in Pick OS</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> The count of the number of fields
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.last(length)</code></p></td><td><p>Extract up to length trailing chars</p>
<p>Equivalent to var.substr(-length, length) or var[-length, length] in Pick OS</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
This is similar to "var.count(sepstr) + 1" but it returns 0 for an empty source string.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "aa**cc"_var.fcount("*"); // 3
// or
let v2 = fcount("aa**cc", "*");</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.cut(length)</code></p></td><td><p>Remove n chars (bytes) from the source string.</p>
<p><em>length:</em> Positive to remove first n chars or negative to remove the last n chars.</p>
<p>If the absolute value of length is &gt;= the number of chars in the source string then all chars will be removed.</p>
<p>Equivalent to var.substr(length) or var[1, length] = "" in Pick OS</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>substr:</em> The substr to count.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.paste(pos1, length, replacestr)</code></p></td><td><p>Insert a substr at an given position after removing a given number of chars.</p>
<p><em>pos1:</em> </p>
<dl>
<dt>0 or 1</dt><dd>Remove length chars from the beginning and insert at the beginning.</dd>
<dt>    -1</dt><dd>Insert on or before the last char after removing up to length chars starting with the last char.</dd>
<dt>    -2</dt><dd>Ditto on or before the penultimate char.</dd>
<dt>&gt; strlen</dt><dd>If pos1 &gt; length of the source string, insert after the last char.</dd>
</dl>
<p>Equivalent to var[pos1, length] = substr in Pick OS</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> The count of the number of sepstr found.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.paste(pos1, insertstr)</code></p></td><td><p>Insert text at char position without overwriting any following chars</p>
<p>Equivalent to var[pos1, 0] = substr in Pick OS</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
Overlapping substrings are not counted.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "aa**cc"_var.count("*"); // 2
// or
let v2 = count("aa**cc", "*");</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.prefix(insertstr)</code></p></td><td><p>Insert text at the beginning</p>
<p>Equivalent to var[0, 0] = substr in Pick OS</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>prefix:</em> The substr to check for.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.append(appendable, ...)</code></p></td><td><p>Append anything at the end of a string.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> True if the source string starts with the given prefix.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.pop()</code></p></td><td><p>Remove one trailing char.</p>
<p>Equivalent to var[-1, 1] = "" in Pick OS</p>
<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="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>
<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">pop</span><span class="p">(</span><span class="s">&quot;abc&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<em>Returns:</em> False if prefix is "". DIFFERS from c++, javascript, python3. See contains() for more info.
<pre><code class='hljs-ncdecl language-javascript'>if ("abc"_var.starts("ab")) ... true
// or
if (starts("abc", "ab")) ... true</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.field(delimiter, fieldnx = 1, nfieldsx = 1)</code></p></td><td><p>Copy one or more consecutive fields from a string.</p>
<p><em>delimiter:</em> A Unicode character.</p>
<p><em>fieldno:</em> The first field is 1, the last field is -1.</p>
<p><em>return:</em> A substring</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>suffix:</em> The substr to check for.
<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="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>
<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>
</pre></div>
</p>
</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.
<pre><code class='hljs-ncdecl language-javascript'>if ("abc"_var.ends("bc")) ... true
// or
if (ends("abc", "bc")) ... true</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.field2(separator, fieldno, nfields = 1)</code></p></td><td>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.fieldstore(separator, fieldno, nfields, replacement)</code></p></td><td><p>fieldstore() replaces, inserts or deletes subfields in a string.</p>
<p><em>fieldno:</em> The field number to replace or, if not 1, the field number to start at. Negative fieldno counts backwards from the last field.</p>
<p><em>nfields:</em> 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.</p>
<p><em>replacement:</em> A string that is the replacement field or fields.</p>
<p><em>return:</em> A modified copy of the original string.</p>
<p>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.</p>
<p></p>
<p>The replacement can contain multiple fields itself. If replacing n fields and the replacement contains &lt; n fields then the remaining fields become "". Conversely, if the replacement contains more fields than are required, they are discarded.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>substr:</em> The substr to check for.
<p></p>
<p>If nfields is 0 then insert the replacement field(s) before fieldno</p>
<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="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></div>
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></div>
</p>
</p>
<p><em>Returns:</em> True if the source string starts with, ends with or contains the given substr.
<p></p>
<p>If nfields exceeds the number of fields in the input then additional empty fields are added.</p>
<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="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></div>
</p>
</p>
<p><em>Returns:</em> False if suffix is "". DIFFERS from c++, javascript, python3
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.substr(pos1, length)</code></p></td><td><p>substr version 1.</p>
<p>Copy a substr of length chars from a given a starting char position.</p>
<p><em>return:</em> A substr or "".</p>
<p><em>pos1:</em> The char position to start at. If negative then start from a position counting backwards from the last char</p>
<p><em>length:</em> The number of chars to copy. If negative then copy backwards. This reverses the order of the chars in the returned substr.</p>
<p>Equivalent to var[start, length] in Pick OS</p>
<p>Not Unicode friendly.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p>Human logic: "" is not equal to "x" therefore x does not contain "".
<p></p>
<p>If pos1 is negative then start counting backwards from the last char</p>
<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="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>
<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">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>
</pre></div>
</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></p>
<p>If length is negative then work backwards and return chars reversed</p>
<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="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>
<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">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>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>if ("abcd"_var.contains("bc")) ... true
// or
if (contains("abcd", "bc")) ... true</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.b(pos1, length)</code></p></td><td><p>Abbreviated alias of substr version 1.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.substr(pos1)</code></p></td><td><p>substr version 2.</p>
<p>Copy a substr from a given char position up to the end of the source string</p>
<p><em>return:</em> A substr or "".</p>
<p><em>pos1:</em> The char position to start at. If negative then start from a position counting backwards from the last char</p>
<p>Equivalent to var[pos1, 9999999] in Pick OS</p>
<p>Partially Unicode friendly but pos1 is in chars.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>substr:</em> The substr to search for.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.b(pos1)</code></p></td><td><p>Shorthand alias of substr version 2.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.substr(pos1, delimiterchars, out pos2)</code></p></td><td><p>substr version 3.</p>
<p>Copy a substr from a given char position up to (but excluding) any one of some given delimiter chars</p>
<p><em>return:</em> A substr or "".</p>
<p><em>pos1:</em> [in] The position of the first char to copy. Negative positions count backwards from the last char of the string.</p>
<p><em>pos2[out]:</em> 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.</p>
<p><em>COL2:</em> Is a predefined variable that can be used for pos2 instead of declaring a variable.</p>
<p>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.</p>
<p>Equivalent to var[pos1, ",."] in Pick OS (non-numeric length).</p>
<p>Works with any encoding including UTF8 for the source string but the delimiter chars are bytes.</p>
<p>Add 1 to pos2 to skip over the next delimiter char to copy the next substr</p>
<p>Works with any encoding including UTF8 for the source string but the delimiter chars are bytes.</p>
<p>This function is similar to std::string::find_first_of but that function only returns pos2.</p>
<p>
<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="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="kc">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>
<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">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="kc">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="kc">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>
</pre></div>
</p>
</p>
<p><em>startchar1:</em> The char position (1 based) to start the search at. The default is 1, the first char.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.b(pos1, delimiterchars, out pos2)</code></p></td><td><p>Shorthand alias of substr version 3.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.substr2(io pos1, out delimiterno)</code></p></td><td><p>substr version 4.</p>
<p>Copy a substr from a given char position up to (but excluding) the next field mark char (RM, FM, VM, SM, TM, ST).</p>
<p><em>return:</em> A substr or "".</p>
<p><em>pos1:</em> [in] The position of the first char to copy. Negative positions count backwards from the last char of the string.</p>
<p><em>pos1[out]:</em> 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.</p>
<p><em>field_mark_no[out]:</em> A number (1-6) indicating which of the standard field mark chars was found, or 0 if not.</p>
<p>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.</p>
<p>pos1 [out] is correctly positioned to copy the next substr.</p>
<p>Works with any encoding including UTF8. Was called "remove" in Pick OS.</p>
<p>The equivalent in Pick OS was the statement "Remove variable From string At column Setting flag"</p>
<p>This function is valuable for high performance processing of dynamic arrays.</p>
<p>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.</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.</p>
<p>
<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>
<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>
<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">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>
</pre></div>
</p>
</p>
<em>Returns:</em> The char position (1 based) that the substr is found at or 0 if not present.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcd"_var.index("bc"); // 2
// or
let v2 = index("abcd", "bc");</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.b2(io pos1, out field_mark_no)</code></p></td><td><p>Shorthand alias of substr version 4.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.convert(fromchars, tochars)</code></p></td><td><p>Convert or delete chars one for one to other chars</p>
<p><em>from_chars:</em> chars to convert. If longer than to_chars then delete those characters instead of converting them.</p>
<p><em>to_chars:</em> chars to convert to</p>
<p>Not UTF8 compatible.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>substr:</em> The string to search for.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.textconvert(fromchars, tochars)</code></p></td><td><p>Ditto for Unicode code points.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<em>Returns:</em> char position (1 based) or 0 if not present.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcabc"_var.index("bc", 2); // 2
// or
let v2 = index("abcabc", "bc", 2);</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.replace(fromstr, tostr)</code></p></td><td><p>Replace all occurrences of one substr with another.</p>
<p>Case sensitive.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>substr:</em> The string to search for.
</td></tr>
</p>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.replace(regex, replacement_str)</code></p></td><td><p>Replace substrings using a regular expression.</p>
<p><em>Returns:</em> The char position of the substr if found, or 0 if not.
<p><em>regex:</em> A regular expression created by rex() or _rex.</p>
<p><em>replacement_str:</em> A literal to replace all matched substrings.</p>
<p>The replacement string can include the following special replacement patterns:</p>
<p>Pattern</p>
<dl>
<dt>$$</dt><dd>Inserts a "$".</dd>
<dt>$&amp;</dt><dd>Inserts the matched substring. Equivalent to $0.</dd>
<dt>$`</dt><dd>Inserts the portion of the string that precedes the matched substring.</dd>
<dt>$'</dt><dd>Inserts the portion of the string that follows the matched substring.</dd>
<dt>$n</dt><dd>Inserts the nth (1-indexed) capturing group where n is a positive integer less than 100.</dd>
</dl>
<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="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>
<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">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>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcabc"_var.indexr("bc"); // 5
// or
let v2 = indexr("abcabc", "bc");</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.replace(regex, ReplacementFunction auto repl_func)</code></p></td><td><p>Replace substrings using a regular expression and a custom function.</p>
<p>Allow complex string conversions.</p>
<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>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.</p>
<p>
<div class="highlight light"><pre><span class="c1">// Decode hex escape codes.</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="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>
<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">replace</span><span class="p">(</span>
<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">// Find \0xFF.</span>
<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">// Decode to a char.</span>
<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;--;--/--&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> Zero or more matching substrings separated by FMs. Any groups are in VMs.
<p>
 
<div class="highlight light"><pre><span class="c1">// Reformat dates using groups.</span>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc1abc2"_var.match("BC(\\d)", "i"); // "bc1]1^bc2]2"_var
<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;Date: 03-15-2025&quot;</span><span class="p">;</span>
// or
<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="n">v3</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span>
let v2 = match("abc1abc2", "BC(\\d)", "i");</code></pre>
<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>
 
<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>
 
<span class="p">);</span>
<span class="n">assert</span><span class="p">(</span><span class="n">v4</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>
</pre></div>
</p>
</p>
<p><em>regex_options:</em>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.unique()</code></p></td><td><p>Remove duplicate fields, values or subvalues.</p>
<p>From a dynamic array.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><pre>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.sort(delimiter = FM)</code></p></td><td><p>Reorder fields, values or subvalues.</p>
<p>In a dynamic array.</p>
<p>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>
<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">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>
</pre></div>
</p>
</p>
<p>l - Literal (any regex chars are treated as normal chars)
<p>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>
<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">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>
</pre></div>
</p>
</p>
<p>i - Case insensitive
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.reverse(delimiter = FM)</code></p></td><td><p>Reorder fields in an FM or VM etc. separated list in descending order</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p>p - ECMAScript/Perl (the default)
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.randomize(delimiter = FM)</code></p></td><td><p>Randomise the order of fields in an FM, VM separated list</p>
<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="s">&quot;20^10^2^1^1.1&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="nf">randomize</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>
<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">randomize</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>
</pre></div>
</p>
</p>
<p>b - Basic POSIX (same as sed)
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.parse(char sepchar = ' ')</code></p></td><td><p>Split a delimited string into a dynamic array.</p>
<p>Replace separator chars with FM chars except inside double or single quotes and ignoring escaped quotes \" \'</p>
<p><em>return:</em> A dynamic array</p>
<p>Can be used to process CSV data.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p>e - Extended POSIX
</td></tr>
</p>
<tr><td><p><code>dim=</code></p></td><td><p><code>strvar.split(delimiter = FM)</code></p></td><td><p>Split a delimited string into a dim array.</p>
<p>a - awk
<p><em>Delimiter:</em> Can be multibyte Unicode.</p>
</p>
<p><em>return:</em> A dim array.</p>
<p>g - grep
<p>
</p>
<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>
<p>eg - egrep or grep -E
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.paste(pos1, length, replacestr)</code></p></td><td>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.fieldstore(delimiter, fieldno, nfields, replacement)</code></p></td><td>
</td></tr>
</table>
<h5 id=String_Mutation_-_Standalone_Commands>String Mutation - Standalone Commands</h5>


<p>char ranges like a-z are locale sensitive if ECMAScript
<table class=wikitable>
</p>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
 
<tr><td><p><code></code></p></td><td><p><code>strvar.ucaser()</code></p></td><td><p>To upper case</p>
<p>m - Multiline. Default in boost (and therefore exodus)
<p>All string mutators follow the same pattern as ucaser. See the non-mutating functions for details.</p>
</p>
<p>
<p>s - Single line. Default in std::regex
<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>
</p>
<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>
<p>f - First only. Only for replace() (not match() or search())
<span class="c1">// or</span>
</p>
<span class="nf">ucaser</span><span class="p">(</span><span class="n">v1</span><span class="p">);</span>
<p>w - Wildcard glob style (e.g. *.cfg) not regex style. Only for match() and search(). Not replace().
</pre></div>
</p>
<p></pre>
</p>
</p>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.match(regex)</td><td>Ditto</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.lcaser()</code></p></td><td>
<tr><td>var=</td><td>strvar.search(regex_str, io startchar1, regex_options = "")</td><td><p>Search for the first match of a regular expression.
</td></tr>
</p>
<tr><td><p><code></code></p></td><td><p><code>strvar.tcaser()</code></p></td><td>
<p><em>startchar1:</em> [in] char position to start the search from
</p>
<p><em>startchar1:</em> [out] char position to start the next search from
</p>
<p><em>Returns:</em> The 1st match like match()
</p>
regex_options as for match()
 
<pre><code class='hljs-ncdecl language-javascript'>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");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.search(regex_str)</td><td>Ditto starting from first char</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.fcaser()</code></p></td><td>
<tr><td>var=</td><td>strvar.search(regex, io startchar1)</td><td>Ditto given a rex</td></tr>
<tr><td>var=</td><td>strvar.search(regex)</td><td>Ditto starting from first char.</td></tr>
<tr><td>var=</td><td>strvar.hash(std::uint64_t modulus = 0)</td><td><p>Get a hash of a source string.
</p>
<p><em>modulus:</em> The result is limited to [0, modulus)
</p>
<p><em>Returns:</em> A 64 bit signed integer.
</p>
MurmurHash3 is used.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.hash(); assert(v1 == var(6'715'211'243'465'481'821));
// or
let v2 = hash("abc");</code></pre>
 
</td></tr>
</td></tr>
</table>
<tr><td><p><code></code></p></td><td><p><code>strvar.normalizer()</code></p></td><td>
<h5 id=String_Conversion_-_Non-Mutating_-_Chainable>String Conversion - Non-Mutating - Chainable</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>strvar.ucase()</td><td>Convert to upper case
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "Γιάννης"_var.ucase(); // "ΓΙΆΝΝΗΣ"
// or
let v2 = ucase("Γιάννης");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.lcase()</td><td>Convert to lower case
<tr><td><p><code></code></p></td><td><p><code>strvar.inverter()</code></p></td><td>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "ΓΙΆΝΝΗΣ"_var.lcase(); // "γιάννης"
// or
let v2 = lcase("ΓΙΆΝΝΗΣ");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.tcase()</td><td><p>Convert to title case.
<tr><td><p><code></code></p></td><td><p><code>strvar.quoter()</code></p></td><td>
</p>
<em>Returns:</em> Original source string with the first letter of each word is capitalised.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "γιάννης παππάς"_var.tcase(); // "Γιάννης Παππάς"
// or
let v2 = tcase("γιάννης παππάς");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.fcase()</td><td><p>Convert to folded case.
<tr><td><p><code></code></p></td><td><p><code>strvar.squoter()</code></p></td><td>
</p>
<p>Returns the source string standardised in a way to enable consistent indexing and searching,
</p>
<p>Case folding is the process of converting text to a case independent representation.
</p>
<p><em>https:</em>//www.w3.org/International/wiki/Case_folding
</p>
<p>Accents can be significant. As in French cote, coté, côte and côté.
</p>
Case folding is not locale-dependent.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "Grüßen"_var.fcase(); // "grüssen"
// or
let v2 = tcase("Grüßen");</code></pre>
 
</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><p><code></code></p></td><td><p><code>strvar.unquoter()</code></p></td><td>
</p>
<p>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.
</p>
<p>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.
</p>
Normalization is not locale-dependent.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "cafe\u0301"_var.normalize(); // "caf\u00E9" // "café"
// or
let v2 = normalize("cafe\u0301");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.invert()</td><td><p>Simple reversible disguising of string text.
<tr><td><p><code></code></p></td><td><p><code>strvar.lowerer()</code></p></td><td>
</p>
<p>It works by treating the string as UTF8 encoded Unicode code points and inverting the first 8 bits of their Unicode Code Points.
</p>
<p><em>Returns:</em> A string.
</p>
<p>invert(invert()) returns to the original text.
</p>
<p>ASCII bytes become multibyte UTF-8 so string sizes increase.
</p>
<p>Inverted characters remain on their original Unicode Code Page but are jumbled up.
</p>
Non-existant Unicode Code Points may be created but UTF8 encoding remains valid.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.invert(); // "\xC2" "\x9E" "\xC2" "\x9D" "\xC2" "\x9C"
// or
let v2 = invert("abc");</code></pre>
 
</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><p><code></code></p></td><td><p><code>strvar.raiser()</code></p></td><td>
</p>
<p>Convert all FM to VM, VM to SM etc.
</p>
<p><em>Returns:</em> The converted string.
</p>
<p>Note that subtext ST chars are not converted because they are already the lowest level.
</p>
String size remains identical.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "a1^b2^c3"_var.lower(); // "a1]b2]c3"_var
// or
let v2 = lower("a1^b2^c3"_var);</code></pre>
 
</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><p><code></code></p></td><td><p><code>strvar.cropper()</code></p></td><td>
</p>
</td></tr>
<p>Convert all VM to FM, SM to VM etc.
<tr><td><p><code></code></p></td><td><p><code>strvar.trimmer(trimchars = " ")</code></p></td><td>
</p>
<p><em>Returns:</em> The converted string.
</p>
<p>The record mark char RM is not converted because it is already the highest level.
</p>
String size remains identical.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "a1]b2]c3"_var.raise(); // "a1^b2^c3"_var
// or
let v2 = "a1]b2]c3"_var;</code></pre>
 
</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><p><code></code></p></td><td><p><code>strvar.trimmerfirst(trimchars = " ")</code></p></td><td>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "a1^b2]]^c3^^"_var.crop(); // "a1^b2^c3"_var
// or
let v2 = crop("a1^b2]]^c3^^"_var);</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.quote()</td><td>Wrap in double quotes.
<tr><td><p><code></code></p></td><td><p><code>strvar.trimmerlast(trimchars = " ")</code></p></td><td>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.quote(); // "\"abc\""
// or
let v2 = quote("abc");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.squote()</td><td>Wrap in single quotes.
<tr><td><p><code></code></p></td><td><p><code>strvar.trimmerboth(trimchars = " ")</code></p></td><td>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.squote(); // "'abc'"
// or
let v2 = squote("abc");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.unquote()</td><td>Remove one pair of surrounding double or single quotes.
<tr><td><p><code></code></p></td><td><p><code>strvar.firster()</code></p></td><td>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "'abc'"_var.unquote(); // "abc"
// or
let v2 = unquote("'abc'");</code></pre>
 
</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><p><code></code></p></td><td><p><code>strvar.laster()</code></p></td><td>
</p>
<em>trimchars:</em> The chars (bytes) to remove. The default is space.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trim(); // "a1␣b2␣c3"
// or
let v2 = trim("␣␣a1␣␣b2␣c3␣␣");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.trimfirst(trimchars = " ")</td><td>Ditto but only leading.
<tr><td><p><code></code></p></td><td><p><code>strvar.firster(length)</code></p></td><td>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimfirst(); // "a1␣␣b2␣c3␣␣"
// or
let v2 = trimfirst("␣␣a1␣␣b2␣c3␣␣");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.trimlast(trimchars = " ")</td><td>Ditto but only trailing.
<tr><td><p><code></code></p></td><td><p><code>strvar.laster(length)</code></p></td><td>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimlast(); // "␣␣a1␣␣b2␣c3"
// or
let v2 = trimlast("␣␣a1␣␣b2␣c3␣␣");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.trimboth(trimchars = " ")</td><td>Ditto but only leading and trailing, not inner.
<tr><td><p><code></code></p></td><td><p><code>strvar.cutter(length)</code></p></td><td>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "␣␣a1␣␣b2␣c3␣␣"_var.trimboth(); // "a1␣␣b2␣c3"
// or
let v2 = trimboth("␣␣a1␣␣b2␣c3␣␣");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.first()</td><td><p>Get the first char of a string.
<tr><td><p><code></code></p></td><td><p><code>strvar.paster(pos1, length, insertstr)</code></p></td><td>
</p>
<p><em>Returns:</em> A char, or "" if empty.
</p>
Equivalent to var.substr(1,length) or var[1, length] in Pick OS
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.first(); // "a"
// or
let v2 = first("abc");</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.last()</td><td><p>Get the last char of a string.
<tr><td><p><code></code></p></td><td><p><code>strvar.paster(pos1, insertstr)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.prefixer(insertstr)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.appender(appendable, ...)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.popper()</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.fieldstorer(delimiter, fieldno, nfields, replacement)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.substrer(pos1, length)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.substrer(pos1)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.converter(from_chars, to_chars)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.textconverter(from_characters, to_characters)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.replacer(regex, tostr)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.replacer(regex, ReplacementFunction auto repl_func)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.replacer(fromstr, tostr)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.uniquer()</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.sorter(delimiter = FM)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.reverser(delimiter = FM)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.randomizer(delimiter = FM)</code></p></td><td>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.parser(char sepchar = ' ')</code></p></td><td>
</td></tr>
</table>
<h5 id=I/O_Conversion>I/O Conversion</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var.oconv(convstr)</code></p></td><td><p>Convert internal data to output external display format.</p>
<p><em>convstr:</em> A conversion code or pattern. See ICONV/OCONV PATTERNS</p>
<p><em>return:</em> The data in external display format or, if the data is invalid and cannot converted, most conversions return the original data UNCONVERTED.</p>
<p><em>throw:</em> VarNotImplemented if convstr is invalid</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A char, or "" if empty.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var.iconv(convstr)</code></p></td><td><p>Convert external data to internal format.</p>
<p><em>convstr:</em> A conversion code or pattern. See ICONV/OCONV PATTERNS</p>
<p><em>return:</em> The data in internal format or, if the data is invalid and cannot be converted, most conversions return the EMPTY STRING ""</p>
<p><em>throw:</em> VarNotImplemented if convstr is invalid</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
Equivalent to var.substr(-1, 1) or var[-1, 1] in Pick OS
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.last(); // "c"
// or
let v2 = last("abc");</code></pre>
</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><p><code>var=</code></p></td><td><p><code>var.format(fmt_str, args, ...)</code></p></td><td><p>Classic format function in printf style</p>
<p>vars can be formatted either with C++ format codes e.g. {:_&gt;8.2f}</p>
<p>or with exodus oconv codes e.g. {::MD20P|R(_)#8} as in the below example.</p>
<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="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>
<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>
<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">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>
<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>
</pre></div>
</p>
</p>
<p><em>length:</em> The number of chars (bytes) to get.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.from_codepage(codepage)</code></p></td><td><p>Convert from codepage encoded text to UTF-8 encoded exodus text</p>
<p><em>codepage:</em> e.g. Codepage "CP1124" (Ukrainian).</p>
<p>Use Linux command "iconv -l" for a complete list of code pages and encodings.</p>
<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="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>
<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">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>
<span class="c1">// U+0404 Cyrillic Capital Letter Ukrainian Ie Unicode character</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A string of up to n chars.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.to_codepage(codepage)</code></p></td><td><p>Convert to codepage encoded text from exodus UTF-8 encoded text</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
Equivalent to var.substr(1, length) or var[1, length] in Pick OS
</td></tr>
 
</table>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.first(2); // "ab"
<h5 id=Dynamic_Array_Functions>Dynamic Array Functions</h5>
// or
let v2 = first("abc", 2);</code></pre>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.f(fieldno, valueno = 0, subvalueno = 0)</code></p></td><td><p>f() is a highly abbreviated alias for the Pick OS field/value/subvalue extract() function.</p>
<p>"f()" can be thought of as "field" although the function can extract values and subvalues as well.</p>
<p>The convenient Pick OS angle bracket syntax for field extraction (e.g. xxx&lt;20&gt;) is not available in C++.</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.</p>
<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="s">&quot;f1^f2v1]f2v2]f2v3^f2&quot;</span><span class="kt">_var</span><span class="p">;</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="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>
</pre></div>
</p>
</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><p><code>var=</code></p></td><td><p><code>strvar.extract(fieldno, valueno = 0, subvalueno = 0)</code></p></td><td><p>Extract a specific field, value or subvalue from a dynamic array.</p>
<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="s">&quot;f1^f2v1]f2v2]f2v3^f2&quot;</span><span class="kt">_var</span><span class="p">;</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="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>
<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>
<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>
</pre></div>
</p>
</p>
Equivalent to var.substr(-length, length) or var[-length, length] in Pick OS
</td></tr>
 
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.update(fieldno, valueno, subvalueno, replacement)</code></p></td><td><p>Update (replace or insert) a specific subvalue  in a dynamic array.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.last(2); // "bc"
<p>Same as var.updater() function but returns a new string instead of updating a variable in place. Rarely used.</p>
// or
<p>"update()" was called "replace()" in Pick OS/Basic.</p>
let v2 = last("abc", 2);</code></pre>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.update(fieldno, valueno, replacement)</code></p></td><td><p>Update (replace or insert) a specific value in a dynamic array.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.update(fieldno, replacement)</code></p></td><td><p>Update (replace or insert) a specific field a dynamic array.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.insert(fieldno, valueno, subvalueno, insertion)</code></p></td><td><p>Insert a subvalue in a dynamic array.</p>
<p>Same as var.inserter() function but returns a new string instead of updating a variable in place.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.insert(fieldno, valueno, insertion)</code></p></td><td><p>Insert a value in a dynamic array.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.insert(fieldno, insertion)</code></p></td><td><p>Insert a field in a dynamic array.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.remove(fieldno, valueno = 0, subvalueno = 0)</code></p></td><td><p>Remove a field, value or subvalue from a dynamic array.</p>
<p>Same as var.remover() function but returns a new string instead of updating a variable in place.</p>
<p>"remove()" was called "delete()" in Pick OS/Basic.</p>
</td></tr>
</table>
<h5 id=Dynamic_Array_Filters>Dynamic Array Filters</h5>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.sum()</code></p></td><td><p>Sum up multiple values in a dynamic array.</p>
<p>Whatever is the lowest level is summed up into a higher level.</p>
<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="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>
<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">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>
</pre></div>
</p>
</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><p><code>var=</code></p></td><td><p><code>strvar.sumall()</code></p></td><td><p>Sum up everything in a dynamic array.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p><em>length:</em> Positive to remove first n chars or negative to remove the last n chars.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.sum(delimiter)</code></p></td><td><p>Sum all fields using a given delimiter.</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
<p>If the absolute value of length is >= the number of chars in the source string then all chars will be removed.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.stddev()</code></p></td><td><p>Calculate basic statistics include stddev.</p>
<p><em>return:</em> An FM delimited string containing n, tot, min, max, tot, mean and stddev</p>
<p><em>strvar:</em> A dynamic array containing numbers using any field, value or subvalue mark delimiters.</p>
<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="s">&quot;-11.2^0^11.5^12^13.9^14&quot;</span><span class="kt">_var</span><span class="p">.</span><span class="n">stddev</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;6^40.2^-11.2^14^6.7^9.32344714506&quot;_var</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="n">stddev</span><span class="p">(</span><span class="s">&quot;-11.2^0^11.5^12^13.9^14&quot;</span><span class="kt">_var</span><span class="p">);</span>
</pre></div>
</p>
</p>
Equivalent to var.substr(length) or var[1, length] = "" in Pick OS
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcd"_var.cut(2); // "cd"
// or
let v2 = cut("abcd", 2);</code></pre>
</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><p><code>var=</code></p></td><td><p><code>strvar.mv(opcode, var2)</code></p></td><td><p>Binary ops on parallel multivalues</p>
<p></p>
<p><em>opcode:</em> </p>
<dl>
<dt>+</dt><dd>Addition</dd>
<dt>-</dt><dd>Subtraction</dd>
<dt>∗</dt><dd>Multiplication</dd>
<dt>/</dt><dd>Division</dd>
</dl>
<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="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></div>
</p>
</p>
</td></tr>
</table>
<h5 id=Dynamic_Array_Mutators_Standalone_Commands>Dynamic Array Mutators Standalone Commands</h5>


<p><em>pos1:</em> 0 or 1 : Remove length chars from the beginning and insert at the beginning.
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.updater(fieldno, replacement)</code></p></td><td><p>Replace a specific field in a dynamic array</p>
<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="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<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>
<span class="c1">// or</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="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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>pos1:</em> > than the length of the source string. Insert after the last char.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.updater(fieldno, valueno, replacement)</code></p></td><td><p>Replace a specific value in a dynamic array.</p>
<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="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<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>
<span class="c1">// or</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">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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>pos1:</em> -1 : Remove up to length chars before inserting.Insert on or before the last char.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.updater(fieldno, valueno, subvalueno, replacement)</code></p></td><td><p>Replace a specific subvalue in a dynamic array.</p>
<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="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<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>
<span class="c1">// or</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">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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>pos1:</em> -2 : Insert on or before the penultimate char.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.inserter(fieldno, insertion)</code></p></td><td><p>Insert a specific field in a dynamic array</p>
<p>All other fields are moved up.</p>
<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="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>strvar.inserter(fieldno, valueno, insertion)</code></p></td><td><p>Insert a specific value in a dynamic array.</p>
<p>All other values are moved up.</p>
<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="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
Equivalent to var[pos1, length] = substr in Pick OS
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcd"_var.paste(2, 2, "XYZ"); // "aXYZd"
// or
let v2 = paste("abcd", 2, 2, "XYZ");</code></pre>
</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><p><code></code></p></td><td><p><code>strvar.inserter(fieldno, valueno, subvalueno, insertion)</code></p></td><td><p>Insert a specific subvalue in a dynamic array.</p>
<p>All other subvalues are moved up.</p>
<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="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
Equivalent to var[pos1, 0] = substr in Pick OS
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcd"_var.paste(2, "XYZ"); // "aXYZbcd"
// or
let v2 = paste("abcd", 2, "XYZ");</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.prefix(insertstr)</td><td><p>Insert text at the beginning
<tr><td><p><code></code></p></td><td><p><code>strvar.remover(fieldno, valueno = 0, subvalueno = 0)</code></p></td><td><p>Remove a specific field, value, or subvalue from a dynamic array.</p>
<p>All other fields, values, or subvalues are moved down.</p>
<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="s">&quot;f1^v1]v2}s2}s3^f3&quot;</span><span class="kt">_var</span><span class="p">;</span>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
Equivalent to var[0, 0] = substr in Pick OS
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.prefix("XYZ"); // "XYZabc"
// or
let v2 = prefix("abc", "XYZ");</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.append(appendable, ...)</td><td>Append anything at the end of a string
</table>
<h5 id=Dynamic_Array_Search>Dynamic Array Search</h5>


<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.append(" is ", 10, " ok", '.'); // "abc is 10 ok."
<table class=wikitable>
// or
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
let v2 = append("abc", " is ", 10, " ok", '.');</code></pre>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.locate(substr)</code></p></td><td><p>locate substr in dynamic array</p>
<p>Search unordered fields, values and/or subvalues.</p>
<p>With only the substr argument provided, locate searches regardless of the field mark delimiters present.</p>
<p><em>return:</em> The field, value or subvalue number if found or 0 if not. Fields are counted regardless of delimiter.</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.</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.pop()</td><td><p>Remove one trailing char.
<tr><td><p><code>if</code></p></td><td><p><code>strvar.locate(substr, out valueno)</code></p></td><td><p>locate substr in values.</p>
<p>Search unordered VM delimited string.</p>
<p><em>valueno[out]:</em> Value number if found or the max value number + 1 if not. If not found then valueno [out] is suitable for creating a new value.</p>
<p><em>return:</em> True if found or False if not.</p>
<p>
<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="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">valueno</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">// valueno -&gt; 2</span>
<span class="c1">// or</span>
<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="n">valueno</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
</pre></div>
</p>
</p>
Equivalent to var[-1, 1] = "" in Pick OS
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abc"_var.pop(); // "ab"
// or
let v2 = pop("abc");</code></pre>
</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><p><code>if</code></p></td><td><p><code>strvar.locate(substr, out num, fieldno, valueno = 0)</code></p></td><td><p>locate substr in dynamic array.</p>
<p>Search in an unordered dynamic array.</p>
<p><em>fieldno:</em> If fieldno is non-zero then search the specified field number otherwise, if fieldno is 0, search using FM as delimiter.</p>
<p><em>valueno:</em> If provided, search the specified value number for a subvalue.</p>
<p><em>num[out]:</em> If found, the field, value or subvalue number where it was found. If not found, the max field, value or subvalue number + 1. If not found then num [out] is suitable for creating a new field, value or subvalue.</p>
<p><em>return:</em> True if found or False if not.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="nf">num</span><span class="p">;</span>
<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="nf">num</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">// num -&gt; 4 // Return true</span>
</pre></div>
</p>
</p>
<p><em>delimiter:</em> A Unicode character.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.locateby(ordercode, substr, out valueno)</code></p></td><td><p>locate substr in ordered dynamic array</p>
<p>locateby() without fieldno or valueno arguments, searches ordered values separated by VM chars.</p>
<p>Data must already be in the correct order for searching to work properly.</p>
<p><em>ordercode:</em> </p>
<dl>
<dt>AL</dt><dd>Ascending  - Left Justified (Alphabetic)</dd>
<dt>DL</dt><dd>Descending - Left Justified (Alphabetic)</dd>
<dt>AR</dt><dd>Ascending  - Right Justified (Numeric/Natural)</dd>
<dt>DR</dt><dd>Descending - Right Justified (Numeric/Natural)</dd>
</dl>
<p><em>return:</em> True if found, otherwise false.</p>
<p><em>valueno[out]:</em> Either the value no found or the correct value no for inserting the substr</p>
<p>
<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 // Return false and valueno = where it could be correctly inserted.</span>
</pre></div>
</p>
</p>
<p><em>fieldno:</em> The first field is 1, the last field is -1.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.locateby(ordercode, substr, out num, fieldno, valueno = 0)</code></p></td><td><p>locate substr in ordered dynamic array</p>
<p>locateby() with fieldno and/or valueno arguments, searches fields if fieldno is 0, or values in a specific fieldno, or subvalues in a specific valueno.</p>
<p>For more info, see locateby() without fieldno or valueno arguments.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="nf">num</span><span class="p">;</span>
<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="nf">num</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">// num -&gt; 2 // return false and where it could be correctly inserted.</span>
</pre></div>
</p>
</p>
<em>Returns:</em> A substring
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "aa*bb*cc"_var.field("*", 2); // "bb"
// or
let v2 = field("aa*bb*cc", "*", 2);</code></pre>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "aa*bb*cc"_var.field("*", -1); // "cc"
// or
let v2 = field("aa*bb*cc", "*", -1);</code></pre>
</td></tr>
</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><p><code>if</code></p></td><td><p><code>strvar.locateusing(usingchar, substr)</code></p></td><td><p>locate substr using any delimiter.</p>
<p>
<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></div>
</p>
</p>
<p><em>fieldno:</em> The field number to replace or, if not 1, the field number to start at. Negative fieldno counts backwards from the last field.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.locateusing(usingchar, substr, out num, fieldno = 0, valueno = 0, subvalueno = 0)</code></p></td><td><p>locate substr in dynamic array using any delimiter</p>
<p>Search in a specific field, value or subvalue.</p>
<p><em>num[out]:</em> If found, the number where found, otherwise the maximum number of delimited fields + 1.</p>
<p><em>return:</em> True if found and False if not.</p>
<p>This is similar to the main locate command but the delimiter char can be specified e.g. a comma or TM etc.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="nf">num</span><span class="p">;</span>
<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="nf">num</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">// num -&gt; 2 // Return true</span>
</pre></div>
</p>
</p>
<p><em>nfields:</em> 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.
</td></tr>
</p>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.locatebyusing(ordercode, usingchar, substr, out num, fieldno = 0, valueno = 0, subvalueno = 0)</code></p></td><td><p>locatebyusing() supports all the locate features in a single function.</p>
<p><em>replacement:</em> A string that is the replacement field or fields.
</td></tr>
</table>
<h5 id=Database_Access>Database Access</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.connect(conninfo = "")</code></p></td><td><p>Establish a connection to a database.</p>
<p><em>conninfo:</em> The DB connection string parameters are merged from the following places in descending priority.</p>
<ol>
<li>Provided in connect()'s conninfo argument. See the last option. for the complete list of parameters.</li>
<li>Any environment variables EXO_HOST EXO_PORT EXO_USER EXO_DATA EXO_PASS EXO_TIME</li>
<li>Any parameters found in a configuration file at ~/.config/exodus/exodus.cfg</li>
<li>The default conninfo is "host=127.0.0.1 port=5432 dbname=exodus user=exodus password=somesillysecret connect_timeout=10"</li>
</ol>
<p>Setting environment variable EXO_DBTRACE=1 will cause tracing of DB interface including SQL commands.</p>
<p><em>dbconn[out]:</em> Becomes a reference or handle for future functions that require a connection argument.</p>
<p>For all the various DB function calls, the dbconn or operative var can be either:</p>
<ul>
<li>A DB connection created with dbconnect().</li>
<li>A file var created with open().</li>
<li>Any var. A default connection will be established on the fly.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">dbconn</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>
<span class="c1">// or</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">connect</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A modified copy of the original string.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.attach(filenames)</code></p></td><td><p>Attach filename(s) to a specific DB connection.</p>
<p>Any following use of the given filename(s) without specifying a connection will be directed to the specified connection until process termination.</p>
<p>It is not necessary to attach files before opening them but the act of opening them also attaches them.</p>
<p>The files must exist in the specified connection.</p>
<p>Attachments can changed by calling attach() or open() on a different connection or they can be removed by calling detach().</p>
<p><em>dbconn:</em> The connection to which the filename(s) should be attached. Defaults to the default connection.</p>
<p><em>filenames:</em> FM separated list.</p>
<p><em>return:</em> False if any filename does not exist and cannot be opened on the given connection. All filenames that can be opened on the connection are attached even if some cannot.</p>
<p>Internally, attach merely opens each filename on the given connection causing them to be added to an internal cache.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>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.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>dbconn.detach(filenames)</code></p></td><td><p>Remove files from the internal cache created by previous open() and attach() calls.</p>
<p><em>filenames:</em> FM separated list.</p>
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.begintrans()</code></p></td><td><p>Begin a DB transaction.</p>
<p><em>return:</em> </p>
<dl>
<dt>True</dt><dd>Successfully begun.</dd>
<dt>False</dt><dd>DB refused. See lasterror() for info.</dd>
</dl>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">dbconn</span><span class="p">.</span><span class="nf">begintrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
<span class="c1">// or</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">begintrans</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
</pre></div>
</p>
</p>
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.
<pre><code class='hljs-ncdecl language-javascript'>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");</code></pre>
If nfields is 0 then insert the replacement field(s) before fieldno
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "aa,bb,cc,dd,ee"_var.fieldstore(",", 2, 0, "11,22"); // "aa,11,22,bb,cc,dd,ee"</code></pre>
If nfields is negative then delete abs(n) fields before inserting whatever fields the replacement has.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "aa,bb,cc,dd,ee"_var.fieldstore(",", 2, -2, "11"); // "aa,11,dd,ee"</code></pre>
If nfields exceeds the number of fields in the input then additional empty fields are added.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "aa,bb,cc"_var.fieldstore(",", 6, 2, "11"); // "aa,bb,cc,,,11,"</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.substr(pos1, length)</td><td><p>substr version 1.
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.statustrans()</code></p></td><td><p>Check if a DB transaction is in progress.</p>
<p><em>return:</em> True or False.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>Copies a substr of length chars from a given a starting char position.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.rollbacktrans()</code></p></td><td><p>Rollback a DB transaction.</p>
<p><em>return:</em> </p>
<dl>
<dt>True</dt><dd>Successfully rolled back or there was no transaction in progress.</dd>
<dt>False</dt><dd>DB refused. See lasterror() for info.</dd>
</dl>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A substr or "".
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.committrans()</code></p></td><td><p>Commit a DB transaction.</p>
<p><em>return:</em> </p>
<dl>
<dt>True</dt><dd>Successfully committed or there was no transaction in progress.</dd>
<dt>False</dt><dd>DB refused. See lasterror() for info.</dd>
</dl>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>pos1:</em> The char position to start at. If negative then start from a position counting backwards from the last char
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.sqlexec(sqlcmd)</code></p></td><td><p>Execute an sql command.</p>
<p><em>return:</em> </p>
<dl>
<dt>True</dt><dd>Successfully executed.</dd>
<dt>False</dt><dd>DB refused. See lasterror() for info.</dd>
</dl>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>length:</em> The number of chars to copy. If negative then copy backwards. This reverses the order of the chars in the returned substr.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.sqlexec(sqlcmd, io response)</code></p></td><td><p>Execute an SQL command and capture the response.</p>
<p><em>return:</em> </p>
<dl>
<dt>True</dt><dd>Successfully executed.</dd>
<dt>False</dt><dd>DB refused. See lasterror() for info.</dd>
</dl>
<p><em>response:</em> Any rows and columns returned are separated by RM and FM respectively. The first row is the column names.</p>
<p>It is *ecommended* that you do not use sql directly unless you must, perhaps to manage or configure a database.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="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>
<span class="kt">var</span><span class="w"> </span><span class="n">response</span><span class="p">;</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>Equivalent to var[start, length] in Pick OS
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>dbconn.disconnect()</code></p></td><td><p>Close a DB connection</p>
<p>Free process resources both locally and in the database server.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="n">dbconn</span><span class="p">.</span><span class="nf">disconnect</span><span class="p">();</span>
<span class="c1">// or</span>
<span class="nf">disconnect</span><span class="p">();</span>
</pre></div>
</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>dbconn.disconnectall()</code></p></td><td><p>Close all DB connections</p>
<p>Free process resources both locally and in the database server(s).</p>
<p>All connections are closed automatically when a process terminates.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="n">dbconn</span><span class="p">.</span><span class="nf">disconnectall</span><span class="p">();</span>
<span class="c1">// or</span>
<span class="nf">disconnectall</span><span class="p">();</span>
</pre></div>
</p>
</p>
Not Unicode friendly.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcd"_var.substr(2, 2); // "bc"
// or
let v2 = substr("abcd", 2, 2);</code></pre>
If pos1 is negative then start counting backwards from the last char
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcd"_var.substr(-3, 2); // "bc"
// or
let v2 = substr("abcd", -3, 2);</code></pre>
If length is negative then work backwards and return chars reversed
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcd"_var.substr(3, -2); // "cb"
// or
let v2 = substr("abcd", 3, -2); // "cb"</code></pre>
</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><p><code>var=</code></p></td><td><p><code>var::lasterror()</code></p></td><td><p><em>return:</em> The last OS or DB error message.</p>
<tr><td>var=</td><td>strvar.substr(pos1)</td><td><p>substr version 2.
<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="kt">var</span><span class="o">::</span><span class="nf">lasterror</span><span class="p">();</span>
<span class="c1">// or</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="nf">lasterror</span><span class="p">();</span>
</pre></div>
</p>
</p>
<p>Copies a substr from a given char position up to the end of the source string
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>dbconn.setlasterror(msg)</code></p></td><td><p>Set the lasterror() message.</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>var::loglasterror(source = "")</code></p></td><td><p>Log the last OS or DB error message.</p>
<p><em>Output:</em> To stdlog</p>
<p>Prefix the output with source if provided.</p>
<p>
<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>
<span class="c1">// or</span>
<span class="nf">loglasterror</span><span class="p">(</span><span class="s">&quot;main:&quot;</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A substr or "".
</td></tr>
</table>
<h5 id=Database_Management>Database Management</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.dbcreate(new_dbname, old_dbname = "")</code></p></td><td><p>Create a named database on a particular connection.</p>
<p>Optionally copies an existing database from the same connection</p>
<p><em>return:</em> True or False. See lasterror() for errors.</p>
<ul>
<li>Target database must not already exist.</li>
<li>Source database must exist on the same connection.</li>
<li>Source database cannot have any current connections.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>pos1:</em> The char position to start at. If negative then start from a position counting backwards from the last char
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.dbcopy(from_dbname, to_dbname)</code></p></td><td><p>Create a named database as a copy of an existing database.</p>
<p><em>return:</em> True or False. See lasterror() for errors.</p>
<ul>
<li>Target database must not already exist.</li>
<li>Source database must exist on the same connection.</li>
<li>Source database cannot have any current connections.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>Equivalent to var[pos1, 9999999] in Pick OS
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>dbconn.dblist()</code></p></td><td><p>Get a list of available databases.</p>
<p>A list for a given connection or the default connection.</p>
<p><em>return:</em> An FM delimited list.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="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">dbconn</span><span class="p">.</span><span class="nf">dblist</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">dblist</span><span class="p">();</span>
</pre></div>
</p>
</p>
Partially Unicode friendly but pos1 is in chars.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcd"_var.substr(2); // "bcd"
// or
let v2 = substr("abcd", 2);</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.b(pos1)</td><td>Shorthand alias of substr version 2.</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.dbdelete(dbname)</code></p></td><td><p>Delete (drop) a named database.</p>
<tr><td>var=</td><td>strvar.substr(pos1, delimiterchars, out pos2)</td><td><p>substr version 3.
<p><em>return:</em> True or False. See lasterror() for errors.</p>
<ul>
<li>Database does not exist</li>
<li>Database has active connections.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>Copies a substr from a given char position up to (but excluding) any one of some given delimiter chars
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.createfile(filename)</code></p></td><td><p>Create a named DB file.</p>
<p>filenames ending with "_temp" only last until the connection is closed.</p>
<p><em>return:</em> True or False. See lasterror() for errors.</p>
<ul>
<li>Filename is invalid.</li>
<li>Filename already exists.</li>
</ul>
<p>
<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">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A substr or "".
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.renamefile(filename, newfilename)</code></p></td><td><p>Rename a DB file.</p>
<p><em>return:</em> True or False. See lasterror() for errors.</p>
<ul>
<li>source filename does not exist.</li>
<li>newfilename is invalid.</li>
<li>newfilename already exists.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">dbconn</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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>pos1:</em> [in] The position of the first char to copy. Negative positions count backwards from the last char of the string.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>dbconn.listfiles()</code></p></td><td><p>Get a list of all files in a database.</p>
<p><em>return:</em> An FM separated list.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">dbconn</span><span class="p">.</span><span class="nf">listfiles</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
<span class="c1">// or</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">listfiles</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
</pre></div>
</p>
</p>
<p><em>pos2:</em> [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.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.clearfile(filename)</code></p></td><td><p>Delete all records in a DB file.</p>
<p><em>return:</em> True or False. See lasterror() for errors.</p>
<ul>
<li>filename does not exist.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">dbconn</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>
<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">dbconn</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>
<span class="c1">// or</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">clearfile</span><span class="p">(</span><span class="n">filename</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
</pre></div>
</p>
</p>
<p><em>COL2:</em> is a predefined variable that can be used for pos2 instead of declaring a variable.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbconn.deletefile(filename)</code></p></td><td><p>Delete a DB file.</p>
<p><em>return:</em> True or False. See lasterror() for errors.</p>
<ul>
<li>filename does not exist.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">dbconn</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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>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.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>conn_or_file.reccount(filename = "")</code></p></td><td><p>Get the approx number of records in a DB file.</p>
<p>Might return -1 if not known.</p>
<p>Not very accurate inside transactions.</p>
<p><em>return:</em> An approximate number.</p>
<p>
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">dbconn</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>
<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">dbconn</span><span class="p">.</span><span class="nf">reccount</span><span class="p">(</span><span class="n">filename</span><span class="p">);</span>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>Equivalent to var[pos1, ",."] in Pick OS (non-numeric length).
</td></tr>
</p>
<tr><td><p><code>if</code></p></td><td><p><code>conn_or_file.flushindex(filename = "")</code></p></td><td><p>Call the DB maintenance function.</p>
<p>Works with any encoding including UTF8 for the source string but the delimiter chars are bytes.
<p>For one file or all files.</p>
</p>
<p>Ensure that reccount() function is reasonably accurate.</p>
<p>Add 1 to pos2 to skip over the next delimiter char to copy the next substr
<p>Despite the name, this doesnt flush any index.</p>
<p><em>return:</em> True or False. See lasterror() for errors.</p>
<ul>
<li>Cannot perform maintenance while a transaction is active.</li>
</ul>
</td></tr>
</table>
<h5 id=Database_File_I/O>Database File I/O</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>file.open(dbfilename, dbconn = "")</code></p></td><td><p>Open a DB file.</p>
<p>To a var which can be used in subsequent DB function calls to access a specific file using a specific connection.</p>
<p><em>dbconn:</em> If dbconn is *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>return:</em> See lasterror().</p>
<dl>
<dt>True</dt><dd>The filename was present in the cache OR the DB connection reports that the file is present.</dd>
<dt>False</dt><dd>The DB connection reports that the file does not exist.</dd>
</dl>
<p>
<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>
<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>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
<p>Works with any encoding including UTF8 for the source string but the delimiter chars are bytes.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>file.close()</code></p></td><td><p>Close a DB file.</p>
<p>Does nothing currently since database file vars consume no resources</p>
<p>
<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="n">file</span><span class="p">.</span><span class="nf">close</span><span class="p">();</span>
<span class="c1">// or</span>
<span class="nf">close</span><span class="p">(</span><span class="n">file</span><span class="p">);</span>
</pre></div>
</p>
</p>
This function is similar to std::string::find_first_of but that function only returns pos2.
<pre><code class='hljs-ncdecl language-javascript'>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.</code></pre>
</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><p><code>if</code></p></td><td><p><code>file.createindex(fieldname, dictfile = "")</code></p></td><td><p>Create a secondary index.</p>
<tr><td>var=</td><td>strvar.substr2(io pos1, out delimiterno)</td><td><p>substr version 4.
<p>For a given DB file and field name.</p>
<p>The fieldname must exist in a dictionary file. The default dictionary is "dict." ^ filename.</p>
<p><em>return:</em> False if the index cannot be created for any reason. See lasterror().</p>
<ul>
<li>Index already exists</li>
<li>File does not exist</li>
<li>The dictionary file does not have a record with a key of the given field name.</li>
<li>The dictionary file does not exist. Default is "dict." ^ filename.</li>
<li>The dictionary field defines a calculated field that uses an exodus function. Using a psql function is OK.</li>
</ul>
<p>
<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>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>Copies a substr from a given char position up to (but excluding) the next field mark char (RM, FM, VM, SM, TM, ST).
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>file|dbconn.listindex(file_or_filename = "", fieldname = "")</code></p></td><td><p>List secondary indexes.</p>
<p>In a database or for a DB file.</p>
<p><em>return:</em> An FM separated list.</p>
<ul>
<li>DB file or fieldname does not exist.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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">// include &quot;xo_clients__date_created&quot;</span>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> A substr or "".
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>file.deleteindex(fieldname)</code></p></td><td><p>Delete a secondary index.</p>
<p>For a DB file and field name.</p>
<p><em>return:</em> False if the index cannot be deleted for any reason. See lasterror().</p>
<ul>
<li>File does not exist</li>
<li>Index does not already exists</li>
</ul>
<p>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>pos1:</em> [in] The position of the first char to copy. Negative positions count backwards from the last char of the string.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>file.lock(key)</code></p></td><td><p>Place a metaphorical DB lock.</p>
<p>On a particular record given a DB file and key.</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>
<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>If another connection attempts to place an identical lock on the same database it will be denied.</p>
<p>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.</p>
<p>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).</p>
<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><em>Returns:</em> </p>
<dl>
<dt>0</dt><dd>Failure: Another connection has already placed the same lock.</dd>
<dt>""</dt><dd>Failure: The lock has already been placed.</dd>
<dt>1</dt><dd>Success: A new lock has been placed.</dd>
<dt>2</dt><dd>Success: The lock has already been placed and the connection is in a transaction.</dd>
</dl>
<p>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>pos1:</em> [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.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>file.unlock(key)</code></p></td><td><p>Remove a DB lock.</p>
<p>A lock placed by the lock function.</p>
<p><em>return:</em> True or False. See lasterror().</p>
<ul>
<li>Lock cannot be removed while in a transaction.</li>
<li>Lock is not present in the connection.</li>
</ul>
<p>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>field_mark_no:</em> [out] A number (1-6) indicating which of the standard field mark chars was found, or 0 if not.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>file.unlockall()</code></p></td><td><p>Remove all DB locks.</p>
<p>All locks placed by the lock function in the specified connection.</p>
<p><em>return:</em> True or False. See lasterror().</p>
<ul>
<li>Locks cannot be removed while in a transaction.</li>
</ul>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="n">dbconn</span><span class="p">.</span><span class="nf">unlockall</span><span class="p">())</span><span class="w"> </span><span class="p">...</span>
<span class="c1">// or</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">unlockall</span><span class="p">(</span><span class="n">dbconn</span><span class="p">))</span><span class="w"> </span><span class="p">...</span>
</pre></div>
</p>
</p>
<p>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.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>record.write(file, key)</code></p></td><td><p>Write a record into a DB file.</p>
<p>Given a unique primary key, either inserts a new record or updates an existing record.</p>
<p><em>return:</em> Nothing since writes always succeed.</p>
<p><em>throw:</em> VarDBException if the file does not exist.</p>
<p>Any memory cached record is deleted.</p>
<p>
<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>
<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="c1">//if (not &quot;xo_clients&quot;_var.deleterecord(&quot;GD001&quot;)) {}; // Cleanup first</span>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>pos1 [out] is correctly positioned to copy the next substr.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>record.read(file, key)</code></p></td><td><p>Read a record from a DB file.</p>
<p>Given a unique primary key.</p>
<p><em>file:</em> A DB filename or a var opened to a DB file.</p>
<p><em>key:</em> The key of the record to be read.</p>
<p><em>return:</em> False if the key doesnt exist</p>
<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.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">record</span><span class="p">;</span>
<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="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>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
<p>Works with any encoding including UTF8. Was called "remove" in Pick OS.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>file.deleterecord(key)</code></p></td><td><p>Delete a record from a DB file.</p>
<p>Given a unique primary key.</p>
<p><em>return:</em> True or False.</p>
<ul>
<li>Key doesnt exist.</li>
</ul>
<p>Any memory cached record is deleted.</p>
<p>deleterecord(in file), a one argument free function, is available that deletes multiple records using the currently active select list.</p>
<p>
<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="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>
<span class="c1">// or</span>
<span class="c1">//if (deleterecord(file, key)) ...</span>
</pre></div>
</p>
</p>
<p>The equivalent in Pick OS was the statement "Remove variable From string At column Setting flag"
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>record.insertrecord(file, key)</code></p></td><td><p>Insert a new record in a DB file.</p>
<p>Given a unique primary key.</p>
<p><em>return:</em> True or False.</p>
<ul>
<li>Key already exists</li>
</ul>
<p>Any memory cached record is deleted.</p>
<p>
<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>
<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="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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>...
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>record.updaterecord(file, key)</code></p></td><td><p>Update an existing record in a DB file.</p>
<p>Given a unique primary key.</p>
<p><em>return:</em> True or False.</p>
<ul>
<li>Key does not exists</li>
</ul>
<p>Any memory cached record is deleted.</p>
<p>
<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>
<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="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>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
<p>This function is valuable for high performance processing of dynamic arrays.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>record.updatekey(key, newkey)</code></p></td><td><p>Update the key of an existing record in a DB file.</p>
<p>Given two unique primary keys.</p>
<p><em>return:</em> True or False.</p>
<ul>
<li>Key does not exists</li>
<li>New key already exists.</li>
</ul>
<p>Any memory cached records of either key are deleted.</p>
<p>
<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>
<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>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
<p>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.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.readf(file, key, fieldno)</code></p></td><td><p>Read a field from a DB file record.</p>
<p>Same as read() but only returns a specific field number from the record.</p>
<p><em>fieldno:</em> The field number to return from the DB record.</p>
<p><em>return:</em> A string var.</p>
<p>
<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>
<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>
<span class="c1">// or</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">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>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>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.</code></pre>
</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><p><code></code></p></td><td><p><code>strvar.writef(file, key, fieldno)</code></p></td><td><p>Write a field to a DB file record.</p>
<tr><td>var=</td><td>strvar.convert(fromchars, tochars)</td><td><p>Convert or delete chars one for one to other chars
<p>Same as write() but only writes to a specific field number in the record.</p>
<p>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>from_chars:</em> chars to convert. If longer than to_chars then delete those characters instead of converting them.
</td></tr>
</p>
<tr><td><p><code></code></p></td><td><p><code>record.writec(file, key)</code></p></td><td><p>Write a record and key into a memory cached "DB file".</p>
<p><em>to_chars:</em> chars to convert to
<p>The actual database file is NOT updated.</p>
<p>writec() either updates an existing cache record if the key already exists or otherwise inserts a new record into the cache.</p>
<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.</p>
<p>
<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>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
Not UTF8 compatible.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "abcde"_var.convert("aZd", "XY"); // "Xbce" // a is replaced and d is removed
// or
let v2 = convert("abcde", "aZd", "XY");</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.textconvert(fromchars, tochars)</td><td>Ditto for Unicode code points.
<tr><td><p><code>if</code></p></td><td><p><code>record.readc(file, key)</code></p></td><td><p>Read a DB record first looking in a memory cached "DB file".</p>
 
<p>Same as "read() but first reads from a memory cache held per connection.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "a🤡b😀c🌍d"_var.textconvert("🤡😀", "👋"); // "a👋bc🌍d"
<ol>
// or
<li>Tries to read from a memory cache. Returns true if successful.</li>
let v2 = textconvert("a🤡b😀c🌍d", "🤡😀", "👋");</code></pre>
</ol>
<p>2a. Tries to read from the actual DB file and returns false if unsuccessful.</p>
<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.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">record</span><span class="p">;</span>
<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>
<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>
<span class="c1">// or</span>
<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>


<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>
</p>
</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><p><code>if</code></p></td><td><p><code>dbfile.deletec(key)</code></p></td><td><p>Delete a record from a memory cached "DB file".</p>
<p>The actual database file is NOT updated.</p>
<p><em>return:</em> False if the key doesnt exist</p>
<p>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
Case sensitive.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "Abc.Abc"_var.replace("bc", "X"); // "AX.AX"
// or
let v2 = replace("Abc Abc", "bc", "X");</code></pre>
</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><p><code></code></p></td><td><p><code>dbconn.clearcache()</code></p></td><td><p>Clear the "DB file" memory cache.</p>
<p>All cached 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.</p>
<p>
<div class="highlight light"><pre><span class="nf">let</span><span class="w"> </span><span class="n">dbconn</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="n">dbconn</span><span class="p">.</span><span class="nf">clearcache</span><span class="p">();</span>
<span class="c1">// or</span>
<span class="nf">clearcache</span><span class="p">(</span><span class="n">dbconn</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>regex:</em> A regular expression created by rex() or _rex.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.xlate(filename, fieldno, mode)</code></p></td><td><p>Read a field given filename, key and field number or name.</p>
<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 named columns, functions and multivalued data.</p>
<p><em>strvar:</em> The primary key to lookup a field in a given file and field no or field name.</p>
<p><em>filename:</em> The DB file in which to look up data.</p>
<p>If var key is multivalued then a multivalued field is returned.</p>
<p><em>fieldno:</em> Which field of the record to return.</p>
<dl>
<dt>nn</dt><dd>Field number nn</dd>
<dt>0</dt><dd>The key.</dd>
<dt>""</dt><dd>The whole record.</dd>
</dl>
<p><em>mode:</em> If the record does not exist.</p>
<dl>
<dt>"X"</dt><dd>Returns ""</dd>
<dt>"C"</dt><dd>Returns the key unconverted.</dd>
</dl>
<p>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>replacement_str:</em> A literal to replace all matched substrings.
</td></tr>
</table>
<h5 id=Database_Sort/Select>Database Sort/Select</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbfile.select(sort_select_command = "")</code></p></td><td><p>Create an active select list of DB keys.</p>
<p>The select(command) function searches and orders database records for subsequent processing given an English language-like command.</p>
<p>The primary job of a database, beyond mere storage and retrieval of information, is to allow rapid searching and ordering of information on demand.</p>
<p>In Exodus, searching and ordering of information is known as "sort/select" and is performed by the select() function.</p>
<p>Executing the select() function creates an "active select list" which can then be consumed by the readnext() function.</p>
<p><em>dbfile:</em> 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.</p>
<p><em>sort_select_command:</em> 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.</p>
<p><em>Example:</em> "select xo_clients with type 'B' and with balance ge 100 by type by name"</p>
<p><em>Option:</em> "(R)" appended to the sort_select_command acquires the database records as well.</p>
<p><em>return:</em> True if any records are selected or false if none.</p>
<p><em>throw:</em> VarDBException in case of any syntax error in the command.</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.</p>
<p>
<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="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>
<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="kc">ID</span><span class="p">))</span>
<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="kc">ID</span><span class="p">);</span>
<span class="c1">// or</span>
<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>
<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="kc">ID</span><span class="p">))</span>
<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="kc">ID</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>The replacement string can include the following special replacement patterns:
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbfile.selectkeys(keys)</code></p></td><td><p>Create an active select list from a string of DB keys.</p>
<p>Similar to select() but creates the list directly from a var.</p>
<p><em>keys:</em> An FM separated list of keys or key^VM^valueno pairs.</p>
<p><em>return:</em> True if any keys are provided or false if not.</p>
<p>
<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>
<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>
<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>
<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="kc">ID</span><span class="p">)</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="kc">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>
<span class="c1">// or</span>
<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>
<span class="n">assert</span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="kc">ID</span><span class="p">)</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="kc">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>
</pre></div>
</p>
</p>
<p>Pattern  Inserts
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbfile.hasnext()</code></p></td><td><p>Check if a select list is active.</p>
<p><em>dbfile:</em> A file or connection var used in a prior select, selectkeys or getlist function call.</p>
<p><em>return:</em> True if a select list is active and false if not.</p>
<p>If it returns true then a call to readnext() will return a database record key, otherwise not.</p>
<p>
<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>
<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>
<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>
<span class="p">}</span>
<span class="c1">// or</span>
<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>
<span class="w">    </span><span class="n">assert</span><span class="p">(</span><span class="nf">hasnext</span><span class="p">());</span>
<span class="p">}</span>
</pre></div>
</p>
</p>
<p>$$      Inserts a "$".
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbfile.readnext(out key)</code></p></td><td><p>Acquire and consume one key from an active select list.</p>
<p>Each call to readnext consumes one key from the list.</p>
<p>Once all the keys in an active select list have been consumed by calls to readnext, the list becomes inactive.</p>
<p>See select() for example code.</p>
<p><em>dbfile:</em> A file or connection var used in a prior select, selectkeys or getlist function call.</p>
<p><em>key[out]:</em> Returns the first (next) key present in an active select list or "" if no select list is active.</p>
<p><em>return:</em> True if a list was active and a key was acquired, false if not.</p>
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbfile.readnext(out key, out valueno)</code></p></td><td><p>Acquire and consume one key and valueno pair from an active select list.</p>
<p>Similar to readnext(key) but multivalued.</p>
<p>If the active list was ordered by multivalued database fields then pairs of key and multivalue number will be available to the readnext function.</p>
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbfile.readnext(out record, out key, out valueno)</code></p></td><td><p>Similar to readnext(key, valueno) but acquire the database record as well.</p>
<p><em>record[out]:</em> Returns the next database record from the select list assuming that the select list was created with the (R) option otherwise "" if not.</p>
<p><em>key[out]:</em> Returns the next database record key in the select list.</p>
<p><em>valueno[out]:</em> The multivalue number if the select list was ordered on multivalued database record fields or 1 if not.</p>
<p><em>return:</em> True if a list was active and a key was acquired, false if not.</p>
<p>
<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="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>
<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="kc">RECORD</span><span class="p">,</span><span class="w"> </span><span class="kc">ID</span><span class="p">,</span><span class="w"> </span><span class="kc">MV</span><span class="p">))</span>
<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="kc">ID</span><span class="p">,</span><span class="w"> </span><span class="kc">RECORD</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="c1">// or</span>
<span class="kc">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>
<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>
<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="kc">RECORD</span><span class="p">,</span><span class="w"> </span><span class="kc">ID</span><span class="p">,</span><span class="w"> </span><span class="kc">MV</span><span class="p">))</span>
<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>
</pre></div>
</p>
</p>
<p>$&       Inserts the matched substring. Equivalent to $0.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>dbfile.clearselect()</code></p></td><td><p>Deactivate an active select list.</p>
<p><em>dbfile:</em> A file or connection var used in a prior select, selectkeys or getlist function call.</p>
<p><em>return:</em> Nothing</p>
<p>Has no effect if no select list is active for dbfile.</p>
<p>
<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="n">clients</span><span class="p">.</span><span class="nf">clearselect</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="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>
<span class="c1">// or</span>
<span class="nf">clearselect</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">hasnext</span><span class="p">())</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
</pre></div>
</p>
</p>
<p>$`      Inserts the portion of the string that precedes the matched substring.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbfile.savelist(listname)</code></p></td><td><p>Save an active select list for later retrieval.</p>
<p><em>dbfile:</em> A file or connection var used in a prior select, selectkeys or getlist function call.</p>
<p><em>listname:</em> A suitable name that will be required for later retrieval.</p>
<p><em>return:</em> True if saved successfully or false if there was no active list to be saved.</p>
<p>Any existing list with the same name will be overwritten.</p>
<p>Only the remaining unconsumed part of the active select list is saved.</p>
<p>Saved lists are stand-alone and are not tied to specific database files although they usually hold keys related to specific files.</p>
<p>Saved lists can be created from one file and used to access another.</p>
<p>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.</p>
<p>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.</p>
<p>Select lists saved in the lists database file may be created, deleted and listed like database records in any other database file.</p>
<p>
<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="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>
<span class="p">}</span>
<span class="c1">// or</span>
<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; by name&quot;</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
<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>
<span class="p">}</span>
</pre></div>
</p>
</p>
<p>$'      Inserts the portion of the string that follows the matched substring.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dbfile.getlist(listname)</code></p></td><td><p>Retrieve and reactivate a saved select list.</p>
<p><em>dbfile:</em> A file or connection var to be used by subsequent readnext function calls.</p>
<p><em>listname:</em> The name of an existing list in the "lists" database file, either created by savelist or manually.</p>
<p><em>return:</em> True if the list was successfully retrieved and activated, or false if the list name doesnt exist.</p>
<p>Any currently active select list is replaced.</p>
<p>Retrieving a list does not delete it and a list can be retrieved more than once until specifically deleted.</p>
<p>
<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>
<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>
<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="kc">ID</span><span class="p">))</span>
<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="kc">ID</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// or</span>
<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>
<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="kc">ID</span><span class="p">))</span>
<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="kc">ID</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</p>
</p>
$n      Inserts the nth (1-indexed) capturing group where n is a positive integer less than 100.
<pre><code class='hljs-ncdecl language-javascript'>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'");</code></pre>
</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><p><code>if</code></p></td><td><p><code>dbfile.deletelist(listname)</code></p></td><td><p>Delete a saved select list.</p>
<p><em>dbfile:</em> A file or connection to the desired database.</p>
<p><em>listname:</em> The name of an existing list in the "lists" database file.</p>
<p><em>return:</em> True if successful or false if the list name doesnt exist.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">dbconn</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="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">dbconn</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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>Allows very complex string conversions.
</td></tr>
</table>
<h5 id=OS_Time/Date>OS Time/Date</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::date()</code></p></td><td><p>Get the current date in internal format.</p>
<p>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.</p>
<p><em>return:</em> A number. e.g. 20821 represents 2025-01-01 00:00:00 UTC for 24 hours.</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p><em>SomeFunction:</em> Must return a var. Can be an inline anonymous lambda function.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::time()</code></p></td><td><p>Get the current time in internal format.</p>
<p>Internal time is the number of whole seconds since the last midnight 00:00:00 (UTC).</p>
<p><em>return:</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</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>e.g. [](auto match_str) {return match_str;} // Does nothing.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::ostime()</code></p></td><td><p>Get the current time in high resolution internal format.</p>
<p>High resolution internal time is the number of fractional seconds since the last midnight 00:00:00 (UTC).</p>
<p><em>return:</em> A floating point with approx. nanosecond resolution depending on hardware.</p>
<p>e.g. 23343.704387955 approx. 06:29:03 UTC</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::ostimestamp()</code></p></td><td><p>Get the current timestamp in internal format.</p>
<p>Internal timestamp is the number of fractional days since pick epoch 1967-12-31 00:00:00 UTC. Negative for dates before.</p>
<p><em>return:</em> A floating point with approx. nanosecond resolution depending on hardware.</p>
<p>e.g. Was 20821.99998842593 around 2025-01-01 23:59:59 UTC</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>// 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");</code></pre>
</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><p><code>var=</code></p></td><td><p><code>vardate.ostimestamp(ostime)</code></p></td><td><p>Get the timestamp for a given date and time</p>
 
<p><em>vardate:</em> Internal date from date(), iconv("D") etc.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "a1^b2^a1^c2"_var.unique(); // "a1^b2^c2"_var
<p><em>ostime:</em> Internal time from time(), ostime(), iconv("MT") etc.</p>
// or
<p>
let v2 = unique("a1^b2^a1^c2"_var);</code></pre>
<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>
 
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</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><p><code></code></p></td><td><p><code>var::ossleep(milliseconds)</code></p></td><td><p>Sleep/pause/wait</p>
<p><em>milliseconds:</em> How to long to sleep.</p>
<p>Release the processor if not needed for a period of time or a delay is required.</p>
<p>
<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>
<span class="c1">// or</span>
<span class="nf">ossleep</span><span class="p">(</span><span class="mi">100</span><span class="p">);</span>
</pre></div>
</p>
</p>
Numeric data:
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>
Alphabetic data:
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>
</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><p><code>var=</code></p></td><td><p><code>file_dir_list.oswait(milliseconds)</code></p></td><td><p>Sleep/pause/wait up for a file system event</p>
 
<p><em>file_dir_list:</em> An FM delimited list of OS files and/or dirs to monitor.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "20^10^2^1^1.1"_var.reverse(); // "1.1^1^2^10^20"_var
<p><em>milliseconds:</em> How long to wait. Any terminal input (e.g. a key press) will also terminate the wait.</p>
// or
<p><em>return:</em> An FM array of event information is returned. See below.</p>
let v2 = reverse("20^10^2^1^1.1"_var);</code></pre>
<p>Multiple events may be captured and are returned in multivalues.</p>
 
<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="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>
<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">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>
</pre></div>
</p>
<p></p>
<p>Returned dynamic array fields:</p>
<ol>
<li>Event type codes</li>
<li>dirpaths</li>
<li>filenames</li>
<li>d=dir, f=file</li>
</ol>
<p></p>
<p>Possible event type codes:</p>
<dl>
<dt>IN_CLOSE_WRITE</dt><dd>A file opened for writing was closed</dd>
<dt>IN_ACCESS</dt><dd>Data was read from file</dd>
<dt>IN_MODIFY</dt><dd>Data was written to file</dd>
<dt>IN_ATTRIB</dt><dd>File attributes changed</dd>
<dt>IN_CLOSE</dt><dd>File was closed (read or write)</dd>
<dt>IN_MOVED_FROM</dt><dd>File was moved away from watched directory</dd>
<dt>IN_MOVED_TO</dt><dd>File was moved into watched directory</dd>
<dt>IN_MOVE</dt><dd>File was moved (in or out of directory)</dd>
<dt>IN_CREATE</dt><dd>A file was created in the directory</dd>
<dt>IN_DELETE</dt><dd>A file was deleted from the directory</dd>
<dt>IN_DELETE_SELF</dt><dd>Directory or file under observation was deleted</dd>
<dt>IN_MOVE_SELF</dt><dd>Directory or file under observation was moved</dd>
</dl>
</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
</table>
 
<h5 id=OS_File_I/O>OS File I/O</h5>
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>osfilevar.osopen(osfilename, utf8 = true)</code></p></td><td><p>Open an OS file handle.</p>
<p>Allow random read and write operations.</p>
<p>Open for writing if possible, otherwise read-only.</p>
<p><em>osfilevar[out]:</em> Handle for subsequent osbread() and osbwrite() calls.</p>
<p><em>osfilename:</em> Path and name of an existing OS file.</p>
<p><em>utf8:</em> True (default) removes partial UTF-8 sequences from osbread() ends; false returns raw data.</p>
<p><em>return:</em> True if opened successfully, false if file doesn’t exist or isn’t accessible.</p>
<p>
<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>
<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>
<span class="kt">var</span><span class="w"> </span><span class="nf">ostempfile</span><span class="p">;</span>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</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><p><code>if</code></p></td><td><p><code>strvar.osbwrite(osfilevar, io offset)</code></p></td><td><p>Random write data to an OS file.</p>
<p>At a specified position.</p>
<p><em>strvar:</em> Data to write.</p>
<p><em>osfilevar:</em> Handle from osopen() or a path/filename; creates file if offset is 0 and it’s new, fails if offset isn’t 0.</p>
<p><em>offset:</em> [in/out] Start position (0-based); updated to end of written data; -1 appends.</p>
<p><em>return:</em> True if write succeeds, false if file isn’t accessible, updateable, or creatable.</p>
<p>
<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>
<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>
<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>
<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>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
<p>Can be used to process CSV data.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.osbread(osfilevar, io offset, length)</code></p></td><td><p>Random read data from an OS file</p>
<p>From a specified position.</p>
<p><em>strvar[out]:</em> Data read.</p>
<p><em>osfilevar:</em> Handle from osopen() or a path/filename.</p>
<p><em>offset:</em> [in/out] Start position (0-based); updated to end of read data.</p>
<p><em>length:</em> Chars to read; with utf8=true (default), may return less to ensure complete UTF-8 code points.</p>
<p><em>return:</em> True if read succeeds, false if file doesn’t exist or isn’t accessible or offset &gt;= file size.</p>
<p>
<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>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
Replaces separator chars with FM chars except inside double or single quotes and ignoring escaped quotes &bsol;" &bsol;'
<pre><code class='hljs-ncdecl language-javascript'>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", ',');</code></pre>
</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><p><code></code></p></td><td><p><code>osfile << anything << std::endl;</code></p></td><td><p>Use convenient &lt;&lt; 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.</p>
<p>
<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>
<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>
<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>
<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>
</pre></div>
</p>
</p>
<p>The delimiter can be multibyte Unicode.
<p></p>
</p>
<p>All standard c++ io manipulators may be used e.g. std::setw, setfill etc.</p>
<em>Returns:</em> A dim array.
<p>
<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='hljs-ncdecl language-javascript'>dim d1 = "a^b^c"_var.split(); // A dimensioned array with three elements (vars)
<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>
// or
<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>
dim d2 = split("a^b^c"_var);</code></pre>


</td></tr>
<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>
<tr><td>var=</td><td>strvar.fieldstore(delimiter, fieldno, nfields, replacement)</td><td></td></tr>
<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>
</table>
 
<h5 id=String_Mutation_-_Standalone_Commands>String Mutation - Standalone Commands</h5>
<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>
<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>
 
<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>
<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>
 
<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>
<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>


<table class=wikitable>
<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>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td></td><td>strvar.ucaser()</td><td><p>Upper case
</p>
All string mutators follow the same pattern as ucaser.<br>See the non-mutating functions for details.


<pre><code class='hljs-ncdecl language-javascript'>var v1 = "abc";
<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>
v1.ucaser(); // "ABC"
<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>
// or
<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>
ucaser(v1);</code></pre>
<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>


</td></tr>
<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>
<tr><td></td><td>strvar.lcaser()</td><td></td></tr>
<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>
<tr><td></td><td>strvar.tcaser()</td><td></td></tr>
<tr><td></td><td>strvar.fcaser()</td><td></td></tr>
<tr><td></td><td>strvar.normalizer()</td><td></td></tr>
<tr><td></td><td>strvar.inverter()</td><td></td></tr>
<tr><td></td><td>strvar.quoter()</td><td></td></tr>
<tr><td></td><td>strvar.squoter()</td><td></td></tr>
<tr><td></td><td>strvar.unquoter()</td><td></td></tr>
<tr><td></td><td>strvar.lowerer()</td><td></td></tr>
<tr><td></td><td>strvar.raiser()</td><td></td></tr>
<tr><td></td><td>strvar.cropper()</td><td></td></tr>
<tr><td></td><td>strvar.trimmer(trimchars = " ")</td><td></td></tr>
<tr><td></td><td>strvar.trimmerfirst(trimchars = " ")</td><td></td></tr>
<tr><td></td><td>strvar.trimmerlast(trimchars = " ")</td><td></td></tr>
<tr><td></td><td>strvar.trimmerboth(trimchars = " ")</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.firster(std::size_t length)</td><td></td></tr>
<tr><td></td><td>strvar.laster(std::size_t 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, insertstr)</td><td></td></tr>
<tr><td></td><td>strvar.prefixer(insertstr)</td><td></td></tr>
<tr><td></td><td>strvar.appender(appendable, ...)</td><td></td></tr>
<tr><td></td><td>strvar.popper()</td><td></td></tr>
<tr><td></td><td>strvar.fieldstorer(delimiter, fieldno, nfields, replacement)</td><td></td></tr>
<tr><td></td><td>strvar.substrer(pos1, length)</td><td></td></tr>
<tr><td></td><td>strvar.substrer(pos1)</td><td></td></tr>
<tr><td></td><td>strvar.converter(from_chars, to_chars)</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, SomeFunction(match_str))</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.sorter(delimiter = FM)</td><td></td></tr>
<tr><td></td><td>strvar.reverser(delimiter = FM)</td><td></td></tr>
<tr><td></td><td>strvar.shuffler(delimiter = FM)</td><td></td></tr>
<tr><td></td><td>strvar.parser(char sepchar = ' ')</td><td></td></tr>
</table>
<h5 id=I/O_Conversion>I/O Conversion</h5>


<table class=wikitable>
<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>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<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>
<tr><td>var=</td><td>var.oconv(convstr)</td><td><p>Converts internal data to output external display format according to a given conversion code or pattern
</p>
<p>If the internal data is invalid and cannot be converted then most conversions return the ORIGINAL data unconverted
</p>
<p>Throws a runtime error VarNotImplemented if convstr is invalid
</p>
See [[#ICONV/OCONV PATTERNS]]


<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(30123).oconv("D/E"); // "21/06/2050"
<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>
// or
<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>
let v2 = oconv(30123, "D/E");</code></pre>
<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>


</td></tr>
<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>
<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
<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>
</p>
<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>
<p>If the external data is invalid and cannot be converted then most conversions return the EMPTY STRING ""
<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>
</p>
<p>Throws a runtime error VarNotImplemented if convstr is invalid
</p>
See [[#ICONV/OCONV PATTERNS]]


<pre><code class='hljs-ncdecl language-javascript'>let v1 = "21 JUN 2050"_var.iconv("D/E"); // 30123
<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>
// or
<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>
let v2 = iconv("21 JUN 2050", "D/E");</code></pre>
<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>


<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="nb">FM</span><span class="w"> </span><span class="o">^</span><span class="w"> </span><span class="nb">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>
</p>
</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><p><code></code></p></td><td><p><code>var().osclose()</code></p></td><td><p>Close an osfilevar.</p>
<p>Remove 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.</p>
<p>
<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>
<span class="n">osfilevar</span><span class="p">.</span><span class="nf">osclose</span><span class="p">();</span>
<span class="c1">// or</span>
<span class="nf">osclose</span><span class="p">(</span><span class="n">osfilevar</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>vars can be formatted either with C++ format codes e.g. {:_>8.2f}
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.oswrite(osfilename, codepage = "")</code></p></td><td><p>Create a complete OS file from a var.</p>
<p><em>strvar:</em> The text or data to be used to create the file.</p>
<p><em>osfilename:</em> Absolute or relative path and filename to be written. Any existing OS file is removed first.</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>
<p><em>return:</em> True if successful or false if not possible for any reason. e.g. Path is not writeable, permissions etc</p>
<p>
<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">&qquot;aaa = 123</span><span class="se">\n</span><span class="s">bbb = 456&quot;</span><span class="p">;</span>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
or with exodus oconv codes e.g. {::MD20P|R(_)#8} as in the below example.
<pre><code class='hljs-ncdecl language-javascript'>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));</code></pre>
</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><p><code>if</code></p></td><td><p><code>strvar.osread(osfilename, codepage = "")</code></p></td><td><p>Read a complete OS file into a var.</p>
<p><em>osfilename:</em> Absolute or relative path and filename to be read.</p>
<p><em>codepage:</em> If specified then input is converted from that codepage to UTF-8 after being read. Otherwise no conversion is done.</p>
<p><em>strvar[out]:</em> 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.</p>
<p><em>return:</em> True if successful or false if not possible for any reason. e.g. File doesnt exist, insufficient permissions etc.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">text</span><span class="p">;</span>
<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>
<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>
<span class="c1">// or</span>
<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>
<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>
</pre></div>
</p>
</p>
<p>e.g. Codepage "CP1124" (Ukrainian).
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>osfile_or_dirname.osrename(new_dirpath_or_filepath)</code></p></td><td><p>Rename an OS file or dir.</p>
<p>In the OS file system.</p>
<p>The source and target must exist in the same storage device.</p>
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be renamed.</p>
<p><em>new_dirpath_or_filepath:</em> Will not overwrite an existing OS file or dir.</p>
<p><em>return:</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.</p>
<p>
<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>
 
<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>
<span class="c1">// or</span>
<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>
</p>
</p>
Use Linux command "iconv -l" for complete list of code pages and encodings.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>osfile_or_dirname.osmove(to_osfilename)</code></p></td><td><p>"Move" an OS file or dir.</p>
<p>Within the OS file system.</p>
<p>Attempt osrename first, then oscopy plus osremove original.</p>
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be moved.</p>
<p><em>to_osfilename:</em> Will not overwrite an existing OS file or dir.</p>
<p><em>return:</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.</p>
<p>
<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='hljs-ncdecl language-javascript'>let v1 = "\xa4"_var.from_codepage("CP1124"); // "Є"
<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>
// or
<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>
let v2 = from_codepage("\xa4", "CP1124");
<span class="c1">// or</span>
// U+0404 Cyrillic Capital Letter Ukrainian Ie Unicode character</code></pre>
<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>
</pre></div>
</p>
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>osfile_or_dirname.oscopy(to_osfilename)</code></p></td><td><p>Copy an OS file or directory.</p>
<p>Including subdirs.</p>
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be copied.</p>
<p><em>to_osfilename:</em> Will overwrite an existing OS file or merge into an existing dir.</p>
<p><em>return:</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</p>
<p>
<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="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>
<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>
</pre></div>
</p>
</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><p><code>if</code></p></td><td><p><code>osfilename.osremove()</code></p></td><td><p>Remove/delete an OS file.</p>
 
<p>From the OS file system.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "Є"_var.to_codepage("CP1124").oconv("HEX"); // "A4"
<p>Will not remove directories. Use osrmdir() to remove directories</p>
// or
<p><em>osfilename:</em> Absolute or relative path and file name to be removed.</p>
let v2 = to_codepage("Є", "CP1124").oconv("HEX");</code></pre>
<p><em>return:</em> True if successful or false if not possible for any reason. e.g. Target doesnt exist, path is not writeable, permissions etc.</p>
 
<p>If osfilename is an osfilevar then it is automatically closed.</p>
<p>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</td></tr>
</td></tr>
</table>
</table>
<h5 id=Dynamic_Array_Functions>Dynamic Array Functions</h5>
<h5 id=OS_Directories>OS Directories</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.f(fieldno, valueno = 0, subvalueno = 0)</td><td><p>f() is a highly abbreviated alias for the Pick OS field/value/subvalue extract() function.
<tr><td><p><code>var=</code></p></td><td><p><code>dirpath.oslist(globpattern = "", mode = 0)</code></p></td><td><p>Get a list of OS files and/or dirs.</p>
<p><em>dirpath:</em> Absolute or relative dir path.</p>
<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><em>mode:</em> </p>
<dl>
<dt>0</dt><dd>Any regular OS file or dir (Default).</dd>
<dt>1</dt><dd>Only regular OS files.</dd>
<dt>2</dt><dd>Only dirs.</dd>
</dl>
<p><em>return:</em> An FM delimited string containing all matching dir entries given a dir path</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>dirpath.oslistf(globpattern = "")</code></p></td><td><p>Get a list of OS files.</p>
<p>See oslist() for info.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>dirpath.oslistd(globpattern = "")</code></p></td><td><p>Get a list of OS dirs.</p>
<p>See oslist() for info.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>osfile_or_dirpath.osinfo(mode = 0)</code></p></td><td><p>Get dir info about an OS file or dir.</p>
<p><em>return:</em> A short string containing size ^ FM ^ modified_time ^ FM ^ modified_time or "" if not a regular file or dir.</p>
<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()</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>osfilename.osfile()</code></p></td><td><p>Get dir info of an OS file.</p>
<p><em>osfilename:</em> Absolute or relative path and file name.</p>
<p><em>return:</em> A short string containing size ^ FM ^ modified_time ^ FM ^ modified_time or "" if not a regular file.</p>
<p>Alias for osinfo(1)</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>"f()" can be thought of as "field" although the function can extract values and subvalues as well.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>dirpath.osdir()</code></p></td><td><p>Get dir info of an OS dir.</p>
<p><em>dirpath:</em> Absolute or relative path and dir name.</p>
<p><em>return:</em> A short string containing FM ^ modified_time ^ FM ^ modified_time or "" if not a dir.</p>
<p>Alias for osinfo(2)</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>The convenient Pick OS angle bracket syntax for field extraction (e.g. xxx<20>) is not available in C++.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dirpath.osmkdir()</code></p></td><td><p>Create a new OS file system directory.</p>
<p>Parent dirs wil be created if necessary.</p>
<p><em>dirpath:</em> Absolute or relative path and dir name.</p>
<p><em>return:</em> True if successful.</p>
<p>
<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>
<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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "f1^f2v1]f2v2]f2v3^f2"_var;
let v2 = v1.f(2, 2); // "f2v2"</code></pre>
</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><p><code>if</code></p></td><td><p><code>var::oscwd(newpath)</code></p></td><td><p>Change the current working dir.</p>
 
<p><em>newpath:</em> An absolute or relative dir path and name.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "f1^f2v1]f2v2]f2v3^f2"_var;
<p><em>return:</em> True if successful or false if not. e.g. Invalid dirpath, insufficient permission etc.</p>
let v2 = v1.extract(2, 2); // "f2v2"
<p>
//
<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>
// For brevity the function alias "f()" (standing for "field") is normally used instead of "extract()" as follows:
<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>
var v3 = v1.f(2, 2);</code></pre>
<span class="c1">// or</span>
 
<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>
<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>
</pre></div>
</p>
</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><p><code>var=</code></p></td><td><p><code>var::oscwd()</code></p></td><td><p>Get the current working dir path and name.</p>
<p><em>return:</em> The current working dir path and name.</p>
<p>e.g. "/root/exodus/cli/src/xo_test/aaa"</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
"update()" was called "replace()" in Pick OS/Basic.</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.update(fieldno, valueno, replacement)</td><td>Ditto for a specific multivalue</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>dirpath.osrmdir(evenifnotempty = false)</code></p></td><td><p>Remove (deletes) an OS dir,</p>
<tr><td>var=</td><td>strvar.update(fieldno, replacement)</td><td>Ditto for a specific field</td></tr>
<p><em>eventifnotempty:</em> If true any subdirs will also be removed/deleted recursively, otherwise the function will fail and return false.</p>
<tr><td>var=</td><td>strvar.insert(fieldno, valueno, subvalueno, insertion)</td><td>Same as var.inserter() function but returns a new string instead of updating a variable in place.</td></tr>
<p><em>return:</em> Returns true if successful or false if not. e.g dir doesnt exist, insufficient permission, not empty etc.</p>
<tr><td>var=</td><td>strvar.insert(fieldno, valueno, insertion)</td><td>Ditto for a specific multivalue</td></tr>
<p>
<tr><td>var=</td><td>strvar.insert(fieldno, insertion)</td><td>Ditto for a specific field</td></tr>
<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>
<tr><td>var=</td><td>strvar.remove(fieldno, valueno = 0, subvalueno = 0)</td><td><p>Same as var.remover() function but returns a new string instead of updating a variable in place.
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
"remove()" was called "delete()" in Pick OS/Basic.</td></tr>
</td></tr>
</table>
</table>
<h5 id=Dynamic_Array_Filters>Dynamic Array Filters</h5>
<h5 id=OS_Shell/Environment>OS Shell/Environment</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.sum()</td><td>Sum up multiple values into one higher level
<tr><td><p><code>if</code></p></td><td><p><code>command.osshell()</code></p></td><td><p>Execute a shell command.</p>
 
<p><em>command:</em> An executable command to be interpreted by the default OS shell.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "1]2]3^4]5]6"_var.sum(); // "6^15"_var
<p><em>return:</em> True if the process terminates with error status 0 and false otherwise.</p>
// or
<p>Append "&amp;&gt;/dev/null" to the command to suppress terminal output.</p>
let v2 = sum("1]2]3^4]5]6"_var);</code></pre>
<p>
 
<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="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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.sumall()</td><td>Sum up all levels into a single figure
<tr><td><p><code>if</code></p></td><td><p><code>instr.osshellread(oscmd)</code></p></td><td><p>Execute a shell command and capture its stdout.</p>
 
<p><em>return:</em> The stout of the shell command.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "1]2]3^4]5]6"_var.sumall(); // 21
<p>Append "2&gt;&amp;1" to the command to capture stderr/stdlog output as well.</p>
// or
<p>
let v2 = sumall("1]2]3^4]5]6"_var);</code></pre>
<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>


<span class="c1">// or capturing stdout but ignoring exit status</span>
<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>
</pre></div>
</p>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.sum(delimiter)</td><td>Ditto allowing commas etc.
<tr><td><p><code>if</code></p></td><td><p><code>outstr.osshellwrite(oscmd)</code></p></td><td><p>Execute a shell command and provide its stdin.</p>
 
<p><em>return:</em> True if the process terminates with error status 0 and false otherwise.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "10,20,30"_var.sum(","); // 60
<p>Append "&amp;&gt; somefile" to the command to suppress and/or capture output.</p>
// or
<p>
let v2 = sum("10,20,30", ",");</code></pre>
<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>
 
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</td></tr>
</td></tr>
<tr><td>var=</td><td>strvar.mv(opcode, var2)</td><td>Binary ops (+, -, *, /) in parallel on multiple values
<tr><td><p><code>if</code></p></td><td><p><code>dirpath.osprocess(oscmd, stdin_for_process, out stdout_from_process, out stderr_from_process, out exit_status, timeout_secs = 0)</code></p></td><td><p>Run an OS program synchronously.</p>
 
<p>Provide its standard input and capture its output, errors, and exit status.</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "10]20]30"_var.mv("+","2]3]4"_var); // "12]23]34"_var</code></pre>
<p>Shell features (e.g., pipes, redirects) are unsupported but can be invoked via an oscmd like "bash -c 'abc|yy $HOME'".</p>
 
<p><em>oscmd:</em> Executable and arguments; must exist in OS PATH.</p>
<p><em>stdin_for_process:</em> Optional; input data for the program’s standard input.</p>
<p><em>stdout_from_process[out]:</em> Standard output from the program.</p>
<p><em>stderr_from_process[out]:</em> Error/log output from the program.</p>
<p><em>exit_status[out]:</em> Program’s exit status: 0 (normal), -1 (timeout), else (error).</p>
<p><em>timeout_secs:</em> Optional; max runtime in seconds (default 0 = no timeout).</p>
<p><em>return:</em> True if program ran and exited with status 0 (success) or false if program failed to start, timed out, or exited with non-zero status.</p>
<p><em>throw:</em> Pipe creation failed, fork failed, poll failed.</p>
<p>
<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>
</p>
</td></tr>
</td></tr>
</table>
<tr><td><p><code>var=</code></p></td><td><p><code>var::ostempdir()</code></p></td><td><p>Get the tmp dir path.</p>
<h5 id=Dynamic_Array_Mutators_Standalone_Commands>Dynamic Array Mutators Standalone Commands</h5>
<p><em>return:</em> A string e.g. "/tmp/"</p>
 
<p>
<table class=wikitable>
<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>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<span class="c1">// or</span>
<tr><td></td><td>strvar.updater(fieldno, replacement)</td><td>Replace a specific field in a dynamic array
<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>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
</p>
v1.updater(2, "X"); // "f1^X^f3"_var
// or
v1(2) = "X"; /// Easiest.
// or
updater(v1, 2, "X");</code></pre>
 
</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><p><code>var=</code></p></td><td><p><code>var::ostempfile()</code></p></td><td><p>Create a temporary file.</p>
 
<p><em>return:</em> The name of new temporary file e.g. "/tmp/~exoEcLj3C"</p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<p>
v1.updater(2, 2, "X"); // "f1^v1]X^f3"_var
<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>
// or
<span class="c1">// or</span>
v1(2, 2) = "X"; /// Easiest.
<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>
// or
</pre></div>
updater(v1, 2, 2, "X");</code></pre>
</p>
 
</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><p><code>if</code></p></td><td><p><code>envvalue.osgetenv(envcode)</code></p></td><td><p>Get the value of an environment variable.</p>
 
<p><em>envcode:</em> The code of the env variable to get or "" for all.</p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<p><em>envvalue[out]:</em> 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...</p>
v1.updater(2, 2, 2, "X"); // "f1^v1]v2}X}s3^f3"_var
<p><em>return:</em> True if the envcode is set or false if not.</p>
// or
<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>
v1(2, 2, 2) = "X"; /// Easiest.
<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.</p>
// or
<p>
updater(v1, 2, 2, 2, "X");</code></pre>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">envvalue1</span><span class="p">;</span>
 
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</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><p><code></code></p></td><td><p><code>envvalue.ossetenv(envcode)</code></p></td><td><p>Set the value of an environment variable.</p>
 
<p><em>envcode:</em> The code of the env variable to set.</p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<p><em>envvalue:</em> The new value to set the env code to.</p>
v1.inserter(2, "X"); // "f1^X^v1]v2}s2}s3^f3"_var
<p>
// or
<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>
inserter(v1, 2, "X");</code></pre>
<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>
 
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</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><p><code>var=</code></p></td><td><p><code>var::ospid()</code></p></td><td><p>Get the current OS process id.</p>
 
<p><em>return:</em> A number e.g. 663237.</p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<p>
v1.inserter(2, 2, "X"); // "f1^v1]X]v2}s2}s3^f3"_var
<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>
// or
<span class="c1">// or</span>
inserter(v1, 2, 2, "X");</code></pre>
<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>
 
</pre></div>
</p>
</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><p><code>var=</code></p></td><td><p><code>var::ostid()</code></p></td><td><p>Get the current OS thread process id.</p>
 
<p><em>return:</em> A number e.g. 663237.</p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<p>
v1.inserter(2, 2, 2, "X"); // "f1^v1]v2}X}s2}s3^f3"_var
<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>
// or
<span class="c1">// or</span>
v1.inserter(2, 2, 2, "X");</code></pre>
<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>
 
</pre></div>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>var::version()</code></p></td><td><p>Get the exodus library version info.</p>
<p><em>return:</em> The git commit details as at the time the library was built.</p>
<p>
<div class="highlight light"><pre><span class="c1">// e.g.</span>
<span class="c1">// Local:  doc 2025-03-19 18:15:31 +0000 219cdad8a</span>
<span class="c1">// Remote: doc 2025-03-17 15:03:00 +0000 958f412f0</span>
<span class="c1">// https://github.com/exodusdb/exodusdb/commit/219cdad8a</span>
<span class="c1">// https://github.com/exodusdb/exodusdb/archive/958f412f0.tar.gz</span>
<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>
<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">version</span><span class="p">();</span>
</pre></div>
</p>
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>strvar.setxlocale(newlocalecode)</code></p></td><td><p>Set the current thread's default locale.</p>
<p><em>strvar:</em> The new locale codepage code.</p>
<p>True if successful</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</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><p><code>var=</code></p></td><td><p><code>var.getxlocale()</code></p></td><td><p>Get the current thread's default locale.</p>
 
<p><em>return:</em> A locale codepage code string.</p>
<pre><code class='hljs-ncdecl language-javascript'>var v1 = "f1^v1]v2}s2}s3^f3"_var;
<p>
v1.remover(2, 2); // "f1^v1^f3"_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="o">::</span><span class="nf">getxlocale</span><span class="p">();</span><span class="w"> </span><span class="c1">// &quot;en_US.utf8&quot;</span>
// or
<span class="c1">// or</span>
remover(v1, 2, 2);</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">getxlocale</span><span class="p">();</span>
 
</pre></div>
</p>
</td></tr>
</td></tr>
</table>
</table>
<h5 id=Dynamic_Array_Search>Dynamic Array Search</h5>
<h5 id=Output>Output</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.locate(target)</td><td><p>locate() with only the target substr argument provided searches unordered values separated by any of the field mark chars.
<tr><td><p><code>expr</code></p></td><td><p><code>strvar.outputl(prefix = "")</code></p></td><td><p>Output to stdout with optional prefix.</p>
<p>Append an NL char.</p>
<p>Is FLUSHED, not buffered.</p>
<p>The raw string bytes are output. No character or byte conversion is performed.</p>
<p>
<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>
<span class="c1">// or</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="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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> The field, value, subvalue etc. number if found or 0 if not.
</td></tr>
<tr><td><p><code>expr</code></p></td><td><p><code>strvar.output(prefix = "")</code></p></td><td> <p>Same as outputl() but doesnt append an NL char and is BUFFERED, not flushed.</p>
</td></tr>
<tr><td><p><code>expr</code></p></td><td><p><code>strvar.outputt(prefix = "")</code></p></td><td> <p>Same as outputl() but appends a tab char instead of an NL char and is BUFFERED, not flushed.</p>
</td></tr>
<tr><td><p><code>expr</code></p></td><td><p><code>strvar.logputl(prefix = "")</code></p></td><td><p>Output to stdlog with optional prefix.</p>
<p>Appends an NL char.</p>
<p>Is BUFFERED not flushed.</p>
<p>Any of the six types of field mark chars present are converted to their visible versions,</p>
<p>
<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>
<span class="c1">// or</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="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>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>if ("UK^US^UA"_var.locate("US")) ... ok // 2
// or
if (locate("US", "UK^US^UA"_var)) ... ok</code></pre>
</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><p><code>expr</code></p></td><td><p><code>strvar.logput(prefix = "")</code></p></td><td> <p>Same as logputl() but doesnt append an NL char.</p>
</td></tr>
<tr><td><p><code>expr</code></p></td><td><p><code>strvar.errputl(prefix = "")</code></p></td><td><p>Output to stderr with optional prefix.</p>
<p>Appends an NL char.</p>
<p>Is FLUSHED not buffered.</p>
<p>Any of the six types of field mark chars present are converted to their visible versions,</p>
<p>
<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>
<span class="c1">// or</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="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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> True if found
</td></tr>
<tr><td><p><code>expr</code></p></td><td><p><code>strvar.errput(prefix = "")</code></p></td><td> <p>Same as errputl() but doesnt append an NL char and is BUFFERED not flushed.</p>
</td></tr>
<tr><td><p><code>expr</code></p></td><td><p><code>strvar.put(std::ostream& ostream1)</code></p></td><td><p>Output to a given stream.</p>
<p>Is BUFFERED not flushed.</p>
<p>The raw string bytes are output. No character or byte conversion is performed.</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>var().osflush()</code></p></td><td><p>Flush any and all buffered output to stdout and stdlog.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="p">().</span><span class="nf">osflush</span><span class="p">();</span>
<span class="c1">// or</span>
<span class="nf">osflush</span><span class="p">();</span>
</pre></div>
</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
</td></tr>
 
</table>
<pre><code class='hljs-ncdecl language-javascript'>var setting;
<h5 id=Input>Input</h5>
if ("UK]US]UA"_var.locate("US", setting)) ... ok // setting -> 2
// or
if (locate("US", "UK]US]UA"_var, setting)) ... ok</code></pre>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>var.input(prompt = "")</code></p></td><td><p>Read one line of input from stdin.</p>
<p><em>return:</em> True if successful or false if EOF or user pressed Esc or Ctrl+X in a terminal.</p>
<p><em>var[in]:</em> The default value for terminal input and editing. Ignored if not a terminal.</p>
<p><em>var[out]:</em> 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 "".</p>
<p><em>Prompt:</em> If provided, it will be displayed on the terminal.</p>
<p>Multibyte/UTF8 friendly.</p>
<p>
<div class="highlight light"><pre><span class="c1">// var v1 = &quot;defaultvalue&quot;;</span>
<span class="c1">// if (v1.input(&quot;Prompt:&quot;)) ... ok</span>
<span class="c1">// or</span>
<span class="c1">// var v2 = input();</span>
</pre></div>
</p>
</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><p><code>expr</code></p></td><td><p><code>var.keypressed(wait = false)</code></p></td><td><p>Return the code of the current terminal key pressed.</p>
<p><em>wait:</em> Defaults to false. True means wait for a key to be pressed if not already pressed.</p>
<p><em>return:</em> ASCII or key code defined according to terminal protocol.</p>
<p><em>return:</em> "" if stdin is not a terminal.</p>
<p>e.g. The PgDn key if pressed might return an escape sequence like "\x1b[6~"</p>
<p>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>
<span class="c1">// or</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="nf">keypressed</span><span class="p">();</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> True if found and with the field, value or subvalue number in setting.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>var().isterminal(in_out_err = 1)</code></p></td><td><p>Check if is a terminal or a file/pipe.</p>
<p>Can check stdin, stdout, stderr.</p>
<p><em>in_out_err:</em> </p>
<dl>
<dt>0</dt><dd>stdin</dd>
<dt>1</dt><dd>stdout (Default)</dd>
<dt>2</dt><dd>stderr.</dd>
</dl>
<p><em>return:</em> True if it is a terminal or false if it is a file or pipe.</p>
<p>Note that if the process is at the start or end of a pipeline, then only stdin or stdout will be a terminal.</p>
<p>The type of stdout terminal can be obtained from the TERM environment variable.</p>
<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="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>
<span class="c1">// or</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="nf">isterminal</span><span class="p">();</span>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>var setting;
if ("f1^f2v1]f2v2]s1}s2}s3}s4^f3^f4"_var.locate("s4", setting, 2, 3)) ... ok // setting -> 4 // returns true</code></pre>
</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><p><code>if</code></p></td><td><p><code>var().hasinput(milliseconds = 0)</code></p></td><td><p>Check if stdin has any bytes available for input.</p>
</p>
<p>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.</p>
<p>The order code can be AL, DL, AR, DR meaning Ascending Left, Descending Right, Ascending Right, Ascending Left.
<p><em>return:</em> True if any bytes are available otherwise false.</p>
</p>
<p>It only takes a few µsecs to return false if no bytes are available and no wait time has been requested.</p>
<p>Left is used to indicate alphabetic order where 10 < 2.
</td></tr>
</p>
<tr><td><p><code>if</code></p></td><td><p><code>var().eof()</code></p></td><td><p>True if stdin is at end of file</p>
<p>Right is used to indicate numeric order where 10 > 2.
</p>
<p>Data must be in the correct order for searching to work properly.
</p>
<p><em>Returns:</em> True if found.
</p>
In case the target is not exactly found then the correct value no for inserting the target is returned in setting.
 
<pre><code class='hljs-ncdecl language-javascript'>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>
 
</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><p><code>if</code></p></td><td><p><code>var().echo(on_off = true)</code></p></td><td><p>Set terminal echo on or off.</p>
 
<p>"On" causes all stdin data to be reflected to stdout if stdin is a terminal.</p>
<pre><code class='hljs-ncdecl language-javascript'>var setting;
<p>Turning terminal echo off can be used to prevent display of confidential information.</p>
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>
<p><em>return:</em> True if successful.</p>
 
</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><p><code></code></p></td><td><p><code>var().breakon()</code></p></td><td><p>Install various interrupt handlers.</p>
 
<p>Automatically called in program/thread initialisation by exodus_main.</p>
<pre><code class='hljs-ncdecl language-javascript'>if ("AB,EF,CD"_var.locateusing(",", "EF")) ... ok</code></pre>
<dl>
 
<dt>SIGINT</dt><dd>Ctrl+C -&gt; "Interrupted. (C)ontinue (Q)uit (B)acktrace (D)ebug (A)bort ?"</dd>
<dt>SIGHUP</dt><dd>Sets a variable "RELOAD_req" which may be handled or ignored by the program.</dd>
<dt>SIGTERM</dt><dd>Sets a variable "TERMINATE_req" which may be handled or ignored by the program.</dd>
</dl>
</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><p><code></code></p></td><td><p><code>var().breakoff()</code></p></td><td><p>Disable keyboard interrupt.</p>
</p>
<p>Ctrl+C becomes inactive in terminal.</p>
<p><em>Returns:</em> True If found and returns in setting the number of the delimited field found.
</p>
<p><em>Returns:</em> False if not found and returns in setting the maximum number of delimited fields + 1 if not found.
</p>
This is similar to the main locate command but the delimiter char can be specified e.g. a comma or TM etc.
 
<pre><code class='hljs-ncdecl language-javascript'>var setting;
if ("f1^f2^f3c1,f3c2,f3c3^f4"_var.locateusing(",", "f3c2", setting, 3)) ... ok // setting -> 2 // returns true</code></pre>
 
</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.
</p>
<em>Returns:</em> True if found.</td></tr>
</table>
</table>
<h5 id=Database_Access>Database Access</h5>
<h5 id=Math/Boolean>Math/Boolean</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>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><p><code>var=</code></p></td><td><p><code>varnum.abs()</code></p></td><td><p>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>
<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>
<span class="c1">// or</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">abs</span><span class="p">(</span><span class="n">v1</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>The db connection string (conninfo) parameters are merged from the following places in descending priority.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.pwr(exponent)</code></p></td><td><p>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>
<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">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>
</pre></div>
</p>
</p>
<p>1. Provided in connect()'s conninfo argument. See 4. for the complete list of parameters.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>varnum.initrnd()</code></p></td><td><p>Initialise the seed for rnd().</p>
<p>Allow the stream of pseudo random numbers generated by rnd() to be reproduced.</p>
<p>Seeded from std::chrono::high_resolution_clock::now() if the argument is 0;</p>
<p>
<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>
<span class="c1">// or</span>
<span class="nf">initrnd</span><span class="p">(</span><span class="mi">123</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>2. Any environment variables EXO_HOST EXO_PORT EXO_USER EXO_DATA EXO_PASS EXO_TIME
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.rnd()</code></p></td><td><p>Pseudo random number generator.</p>
<p><em>return:</em> A pseudo random integer between 0 and the provided maximum minus 1.</p>
<p>Uses std::mt19937 and std::uniform_int_distribution&lt;int&gt;</p>
<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="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>
<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">rnd</span><span class="p">(</span><span class="mi">100</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>3. Any parameters found in a configuration file at ~/.config/exodus/exodus.cfg
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.exp()</code></p></td><td><p>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>
<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">exp</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>4. The default conninfo is "host=127.0.0.1 port=5432 dbname=exodus user=exodus password=somesillysecret connect_timeout=10"
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.sqrt()</code></p></td><td><p>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>
<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">sqrt</span><span class="p">(</span><span class="mi">100</span><span class="p">);</span>
</pre></div>
</p>
</p>
Setting environment variable EXO_DBTRACE=1 will cause tracing of db interface including SQL commands.
<pre><code class='hljs-ncdecl language-javascript'>let conninfo = "dbname=exodus user=exodus password=somesillysecret";
if (not conn.connect(conninfo)) ...;
// or
if (not connect()) ...
// or
if (not connect("exodus")) ...</code></pre>
</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><p><code>var=</code></p></td><td><p><code>varnum.sin()</code></p></td><td><p>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>
<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">sin</span><span class="p">(</span><span class="mi">30</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>It is not necessary to attach files before opening them.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.cos()</code></p></td><td><p>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>
<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">cos</span><span class="p">(</span><span class="mi">60</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p>Attachments can changed by calling attach() or open() on a different connection or they can be removed by calling detach().
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.tan()</code></p></td><td><p>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>
<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">tan</span><span class="p">(</span><span class="mi">45</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>var:</em> Defaults to the default connection.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.atan()</code></p></td><td><p>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>
<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">atan</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>filenames:</em> FM separated list.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.loge()</code></p></td><td><p>Natural logarithm.</p>
<p><em>return:</em> Floating point var (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>
<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">loge</span><span class="p">(</span><span class="mf">2.718281828459045</span><span class="p">);</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> 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.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.integer()</code></p></td><td><p>Truncate decimals.</p>
<p>Convert decimal to nearest integer towards zero.</p>
<p>Remove decimal fraction.</p>
<p><em>return:</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>
 
<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>
<span class="c1">// or</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="nf">integer</span><span class="p">(</span><span class="mf">-2.9</span><span class="p">);</span>
</pre></div>
</p>
</p>
Internally, attach merely opens each filename on the given connection causing them to be added to an internal cache.
</td></tr>
 
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.floor()</code></p></td><td><p>Floor decimals.</p>
<pre><code class='hljs-ncdecl language-javascript'>let filenames = "xo_clients^dict.xo_clients"_var, conn = "exodus";
<p>Convert decimal to nearest integer towards negative infinity.</p>
if (conn.attach(filenames)) ... ok
<p><em>return:</em> An integer var
// or
<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>
if (attach(filenames)) ... ok</code></pre>
<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>


<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>
<span class="c1">// or</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="nf">floor</span><span class="p">(</span><span class="mf">-2.9</span><span class="p">);</span>
</pre></div>
</p>
</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><p><code>var=</code></p></td><td><p><code>varnum.mod(modulus)</code></p></td><td><p>Modulus function.</p>
<p>Identical to C++ % operator only for positive numbers and modulus</p>
<p>Negative denominators are considered as periodic with positive numbers</p>
<p>Result is between [0, modulus) if modulus is positive</p>
<p>Result is between (modulus, 0] if modulus is negative (symmetric)</p>
<p><em>throw:</em> VarDivideByZero if modulus is zero.</p>
<p>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>
<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">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>
<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>
<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>
<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>
</pre></div>
</p>
</p>
<p><em>var:</em> Defaults to the default connection.
</td></tr>
<tr><td><p><code>int=</code></p></td><td><p><code>var::setprecision(newprecision)</code></p></td><td><p>Set floating point precision.</p>
<p>This is the number of post-decimal point digits to consider for floating point comparison and implicit conversion to strings.</p>
<p>The default precision is 4 which is 0.0001.</p>
<p>NUMBERS AND DIFFERENCES SMALLER THAN 0.0001 ARE TREATED AS ZERO UNLESS PRECISION IS INCREASED.</p>
<p>With the default precision, Exodus handles, without assistance, conversion to and from strings for positive and negative numbers between 0.0001 and 999'999'999'999.9999 (12 digits).</p>
<p><em>newprecision:</em> New precision between -307 and 308 inclusive.</p>
<p><em>return:</em> The new precision if successful or the old precision if not.</p>
<p>Not required if using common numbers or using the explicit rounding and formatting functions to convert numbers to strings.</p>
<p>Increasing the precision allows comparing and outputting smaller numbers but creates errors handling large numbers.</p>
<p>Setting precision inside a perform, execute or dictionary function lasts until termination of the function.</p>
<p>See cli/demo_precision for more info.</p>
<p>
<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>
<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>
<span class="c1">// or</span>
<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>
<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>
</pre></div>
</p>
</p>
<p><em>filenames:</em> FM separated list.
</td></tr>
<tr><td><p><code>int=</code></p></td><td><p><code>var::getprecision()</code></p></td><td><p>Get current floating point precision.</p>
<p><em>return:</em> The current precision setting.</p>
<p>See setprecision() for more info.</p>
<p>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.begintrans()</td><td>Begin a db transaction.
</table>
<h4 id=I/O_Conversion_Codes_>I/O Conversion Codes </h4>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>vardate.oconv("D")</code></p></td><td><p>oconv "D" Convert internal date to external format.</p>
<p>Date output: Convert internal date format to human readable date or calendar info in text format.</p>
<p><em>return:</em> Human readable date or calendar info, or the original value unconverted if non-numeric.</p>
<p><em>flags:</em> See examples below.</p>
<p>Any Dynamic array structure is preserved.</p>
<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="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>
 
<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>
<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>
 
<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>
<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>


<pre><code class='hljs-ncdecl language-javascript'>if (not conn.begintrans()) ...
<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>
// or
<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>
if (not begintrans()) ...</code></pre>


</td></tr>
<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>
<tr><td>if</td><td>conn.statustrans()</td><td>Check if a db transaction is in progress.
<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>


<pre><code class='hljs-ncdecl language-javascript'>if (conn.statustrans()) ... ok
<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>
// or
<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>
if (statustrans()) ... ok</code></pre>
<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>


</td></tr>
<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>
<tr><td>if</td><td>conn.rollbacktrans()</td><td>Rollback a db transaction.
<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>
<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>
<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="nb">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>


<pre><code class='hljs-ncdecl language-javascript'>if (conn.rollbacktrans()) ... ok
<span class="c1">// Dynamic array</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="s">&quot;12345^12346]12347&quot;</span><span class="kt">_var</span><span class="p">;</span>
if (rollbacktrans()) ... ok</code></pre>
<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>


<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">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>
</p>
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.committrans()</td><td><p>Commit a db transaction.
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.iconv("D")</code></p></td><td><p>iconv "D" Convert external date format to internal.</p>
</p>
<p>Date input: Convert human readable date to internal date format.</p>
<em>Returns:</em> True if successfully committed or if there was no transaction in progress, otherwise false.
<p><em>return:</em> Internal date or "" if the input is an invalid date.</p>
<p>Internal date format is whole days since 1967-12-31 00:00:00 which is day 0.</p>
<p>Any Dynamic array structure is preserved.</p>
<p>
<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='hljs-ncdecl language-javascript'>if (conn.committrans()) ... ok
<span class="c1">// American order &quot;D&quot;</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="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>
if (committrans()) ... ok</code></pre>
<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>
<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>
<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>


</td></tr>
<span class="c1">// Reverse order</span>
<tr><td>if</td><td>conn.sqlexec(sqlcmd)</td><td><p>Execute an sql command.
<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>
</p>
<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>
<em>Returns:</em> True if there was no sql error otherwise lasterror() returns a detailed error message.
<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>


<pre><code class='hljs-ncdecl language-javascript'>if (conn.sqlexec("select 1")) ... ok
<span class="c1">//Invalid date</span>
// or
<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>
if (sqlexec("select 1")) ... ok</code></pre>
<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>


<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>
</p>
</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><p><code>var=</code></p></td><td><p><code>vartime.oconv("MT")</code></p></td><td><p>oconv "MT" Convert internal time to external format.</p>
</p>
<p>Time output: Convert internal time format to human readable time e.g. "10:30:59".</p>
<p><em>Returns:</em> True if there was no sql error otherwise response contains a detailed error message.
<p><em>return:</em> Human readable time or the original value unconverted if non-numeric.</p>
</p>
<p>Conversion code (e.g. "MTHS") is "MT" ^ flags ...</p>
<p><em>response:</em> Any rows and columns returned are separated by RM and FM respectively. The first row is the column names.
<p><em>flags:</em> </p>
</p>
<dl>
<em>Recommended:</em> Don't use sql directly unless you must to manage or configure a database.
<dt>H</dt><dd>Show AM/PM otherwise 24 hour clock is used.</dd>
<dt>S</dt><dd>Output seconds</dd>
<dt>2</dt><dd>Ignored (used in iconv)</dd>
<dt>:</dt><dd>Any other flag is used as the separator char instead of ":"</dd>
</dl>
<p>Any Dynamic array structure is preserved.</p>
<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="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>
 
<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>
<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>
<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>
<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>
<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>


<pre><code class='hljs-ncdecl language-javascript'>let sqlcmd = "select 'xxx' as col1, 'yyy' as col2";
<span class="c1">// Dynamic array</span>
var response;
<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>
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="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>
// or
if (sqlexec(sqlcmd, response)) ... ok</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="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>
</p>
</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><p><code>var=</code></p></td><td><p><code>strvar.iconv("MT")</code></p></td><td><p>iconv "MT" Convert external time format to internal.</p>
<p>Time input: Convert human readable time (e.g. "10:30:59") to internal time format.</p>
<p><em>return:</em> Internal time or "" if the input is an invalid time.</p>
<p>Internal time format is whole seconds since midnight.</p>
<p><em>Accepts:</em> Two or three groups of digits surrounded and separated by any non-digits char(s).</p>
<p>Any Dynamic array structure is preserved.</p>
<p>
<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='hljs-ncdecl language-javascript'>conn.disconnect();
<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>
// or
<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>
disconnect();</code></pre>
<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>
<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>
<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>


<span class="c1">// Dynamic array</span>
<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>
<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>
</p>
</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><p><code>var=</code></p></td><td><p><code>varnum.oconv("MD")</code></p></td><td><p>oconv "MD" Convert internal numbers to external format.</p>
<p>Number output: Convert internal numbers to external text format after rounding and optional scaling.</p>
<p><em>return:</em> A string or, if the value is not numeric, then no conversion is performed and the original value is returned.</p>
<p><em>conversion_code:</em> (e.g. "MD20Z") is "MD" or "MC", 1st digit, 2nd digit, flags ...</p>
<dl>
<dt>"MD"</dt><dd>Outputs like 123.45 (International)</dd>
<dt>"MC"</dt><dd>Outputs like 123,45 (European)</dd>
</dl>
<p>1st digit * Decimal places to display. Also decimal places to move if 2nd digit not present and no P flag present.</p>
<p>2nd digit * Optional decimal places to move left if P flag not present.</p>
<p></p>
<p><em>flags:</em> </p>
<dl>
<dt>P</dt><dd>Preserve decimal places. Same as 2nd digit = 0;</dd>
<dt>Z</dt><dd>Zero flag - return "" if zero.</dd>
<dt>X</dt><dd>No conversion - return as is.</dd>
<dt>.</dt><dd>Separate thousands depending on MD or MC.</dd>
<dt>,</dt><dd>Ditto</dd>
<dt>-</dt><dd>Suffix negatives with "-" and positives with " " (space).</dd>
<dt>&lt;</dt><dd>Wrap negatives in "&lt;" and "&gt;" chars.</dd>
<dt>C</dt><dd>Suffix negatives with "CR" and positives or zero with "DB".</dd>
<dt>D</dt><dd>Suffix negatives with "DB" and positives or zero with "CR".</dd>
</dl>
<p> <p>Any Dynamic array structure is preserved.</p>
</p>
</p>
All connections are closed automatically when a process terminates.
<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">-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='hljs-ncdecl language-javascript'>conn.disconnectall();
<span class="c1">// Dynamic array</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="s">&quot;1.1^2.1]2.2&quot;</span><span class="kt">_var</span><span class="p">;</span>
disconnectall();</code></pre>
<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>


<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;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>
</pre></div>
</p>
</td></tr>
</td></tr>
<tr><td>var=</td><td>var::lasterror()</td><td>
<tr><td><p><code>var=</code></p></td><td><p><code>var.oconv("LRC")</code></p></td><td><p>oconv "L" "R" "C" Justify text and numbers.</p>
<em>Returns:</em> The last os or db error message.
<p>Text justification: Left, right and center. Padding and truncating. See Procrustes.</p>
<p>e.g. "L#10", "R#10", "C#10"</p>
<p>Useful when outputting to terminal devices where spaces are used for alignment.</p>
<p>Dynamic array structure is preserved.</p>
<p>ASCII only.</p>
<p>
<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='hljs-ncdecl language-javascript'>var v1 = var::lasterror();
<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>
// or
<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>
var v2 = lasterror();</code></pre>
<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>


</td></tr>
<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>
<tr><td></td><td>var::loglasterror(source = "")</td><td><p>Log the last os or db error message.
<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>
</p>
<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>
<p><em>Output:</em> to stdlog
<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>
</p>
Prefixes the output with source if provided.


<pre><code class='hljs-ncdecl language-javascript'>var::loglasterror("main:");
<span class="c1">// Dynamic array</span>
// or
<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>
loglasterror("main:");</code></pre>


</td></tr>
<span class="c1">// Fail for non-ASCII (Should be 5)</span>
</table>
<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>
<h5 id=Database_Management>Database Management</h5>


<table class=wikitable>
<span class="c1">// or</span>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<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>
<tr><td>if</td><td>conn.dbcreate(new_dbname, old_dbname = "")</td><td><p>Create a named database on a particular connection.
</pre></div>
</p>
</p>
<p>The target database cannot already exist.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.oconv("T")</code></p></td><td><p>oconv "T" Justify and fold text.</p>
<p>e.g. T#20</p>
<p>Useful when outputting to terminal devices where spaces are used for alignment.</p>
<p>Split text into multiple fixed length lines by inserting spaces and TM chars.</p>
<p>ASCII only.</p>
<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="s">&quot;Have a nice day&quot;</span><span class="p">;</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="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>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
Optionally copies an existing database from the same connection and which cannot have any current connections.
<pre><code class='hljs-ncdecl language-javascript'>var conn = "exodus";
if (not dbdelete("xo_gendoc_testdb")) {}; // Cleanup first
if (conn.dbcreate("xo_gendoc_testdb")) ... ok
// or
if (dbcreate("xo_gendoc_testdb")) ...</code></pre>
</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><p><code>expr</code></p></td><td><p><code>varnum.oconv("MR")</code></p></td><td><p>oconv "MR" Replace characters.</p>
<p>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>
<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;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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</pre></div>
</p>
</p>
<p>The target database cannot already exist.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.oconv("HEX")</code></p></td><td><p>oconv "HEX" Convert a string of chars to a string of pairs of hexadecimal digits.</p>
<p><em>strvar:</em> A string. Numbers will be converted to strings for conversion. 1.2 -&gt; "1.2" -&gt; hex "312E32"</p>
<p>Dynamic array structure is not preserved. Field marks are converted to HEX as for all other bytes.</p>
<p>The size of the output is always precisely double that of the input.</p>
<p>This function is the exact inverse of iconv("HEX").</p>
<p>
<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;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>
<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>
<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>
<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>
<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>
<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;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>
</pre></div>
</p>
</p>
The source database must exist on the same connection and cannot have any current connections.
<pre><code class='hljs-ncdecl language-javascript'>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")) ...</code></pre>
</td></tr>
</td></tr>
<tr><td>var=</td><td>conn.dblist()</td><td>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.iconv("HEX")</code></p></td><td><p>iconv "HEX" Convert a string of pairs of hexadecimal digits to a string of chars.</p>
<em>Returns:</em> A list of available databases on a particular connection.
<p><em>strvar:</em> Must be a string of only hex digits 0-9, a-f or A-F.</p>
 
<p><em>return:</em> A string if all input was hex digits otherwise "".</p>
<pre><code class='hljs-ncdecl language-javascript'>let v1 = conn.dblist();
<p>Dynamic array structure is not preserved. Any field marks prevent conversion.</p>
// or
<p>This function is the exact inverse of oconv("HEX").</p>
let v2 = dblist();</code></pre>
<p>After prefixing a "0" to an odd sized input, the size of the output is always precisely half that of the input.</p>
 
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.dbdelete(dbname)</td><td><p>Delete (drop) a named database.
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.oconv("MX")</code></p></td><td><p>oconv "MX" Convert a number to hexadecimal string.</p>
<dl>
<dt>"MX"</dt><dd>Convert and trim leading zeros                      e.g. oconv(1025, "MX") -&gt; "401"</dd>
<dt>"MXn"</dt><dd>Pad with up to n leading zeros but do not truncate. e.g. oconv(1025, "MX8") -&gt; "00000401"</dd>
<dt>"MXnT"</dt><dd>Pad and truncate to n characters.                  e.g. oconv(1025, "MX2") -&gt; "01"</dd>
</dl>
<p>"n":    Width. 0-9, A-G = 10 - 16.</p>
<p><em>varnum:</em> A number or dynamic array of numbers. Floating point numbers are rounded to integers before conversion.</p>
<p><em>return:</em> A string of hexadecimal digits or a dynamic array of the same. Elements that are not numeric are left untouched and unconverted.</p>
<p>Dynamic array structure is preserved.</p>
<p>Negative numbers are treated as unsigned 8 byte integers (uint64).</p>
<dl>
<dt> 0 -&gt;</dt><dd>"00"</dd>
<dt> 1 -&gt;</dt><dd>"01"</dd>
<dt>15 -&gt;</dt><dd>"0F"</dd>
<dt>-1 -&gt;</dt><dd>"FFFF" "FFFF" "FFFF" "FFFF" (8 x "FF")</dd>
</dl>
<p>This function is a near inverse of iconv("MX").</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
The target database must exist and cannot have any current connections.
<pre><code class='hljs-ncdecl language-javascript'>var conn = "exodus";
if (conn.dbdelete("xo_gendoc_testdb2")) ... ok
// or
if (dbdelete("xo_gendoc_testdb2")) ...</code></pre>
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.createfile(filename)</td><td><p>Create a named db file.
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.iconv("MX")</code></p></td><td><p>iconv "MX" Convert a hexadecimal string to number.</p>
<p><em>strvar:</em> A string or dynamic array of up to 16 hex digits: 0-9, a-f, A-F.</p>
<p><em>return:</em> An integer or dynamic array of integers. Invalid elements are converted to "".</p>
<p>Dynamic array structure is preserved.</p>
<p>Hex strings are converted to unsigned 8 byte integers (uint64)</p>
<p>Leading zeros are ignored.</p>
<dl>
<dt>"0"  -&gt;</dt><dd>0</dd>
<dt>"00" -&gt;</dt><dd>0</dd>
<dt>"1"  -&gt;</dt><dd>1</dd>
</dl>
<p></p>
<p>Hex "FFFF" "FFFF" "FFFF" "FFFF" (8 x "FF") -&gt; -1.</p>
<p>Hex "7FFF" "FFFF" "FFFF" "FFFF" -&gt; The maximum positive integer: 9223372036854775805.</p>
<p>Hex "8000" "0000" "0000" "0000" -&gt; The maximum negative integer: -9223372036854775808.</p>
<p>This function is the exact inverse of oconv("MX").</p>
<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="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>
<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">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>
</pre></div>
</p>
</p>
filenames ending with "_temp" only last until the connection is closed.
<pre><code class='hljs-ncdecl language-javascript'>let filename = "xo_gendoc_temp", conn = "exodus";
if (conn.createfile(filename)) ... ok
// or
if (createfile(filename)) ...</code></pre>
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.renamefile(filename, newfilename)</td><td>Rename a db file.
<tr><td><p><code>var=</code></p></td><td><p><code>varnum.oconv("MB")</code></p></td><td><p>oconv "MB" Convert a number to a binary string of "1"s and "0"s,</p>
<p><em>varnum:</em> If not numeric then no conversion is performed and the original value is returned.</p>
<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="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>
<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">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>
</pre></div>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.oconv("TX")</code></p></td><td><p>oconv "TX" Convert a dynamic array to text.</p>
<p>Convert dynamic arrays to standard text format.</p>
<p>Useful for using text editors on dynamic arrays.</p>
<dl>
<dt>FMs -&gt;</dt><dd>\n after escaping any embedded NL</dd>
<dt>VMs -&gt;</dt><dd>literal "\" \n</dd>
<dt>SMs -&gt;</dt><dd>literal "\\" \n</dd>
</dl>
<p>etc.</p>
<p>
<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="nb">_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>
 
<span class="c1">// 2. Literal &quot;\n&quot; -&gt; literal &quot;\\n&quot; (Double escape any escaped NL chars)</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="kt">var</span><span class="p">(</span><span class="nb">_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>


<pre><code class='hljs-ncdecl language-javascript'>let conn = "exodus", filename = "xo_gendoc_temp", new_filename = "xo_gendoc_temp2";
<span class="c1">// 3. \n becomes literal &quot;\n&quot; (Single escape any NL chars)</span>
if (conn.renamefile(filename, new_filename)) ... ok
<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="nb">_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>
// or
if (renamefile(filename, new_filename)) ...</code></pre>


</td></tr>
<span class="c1">// 4. FM -&gt; \n</span>
<tr><td>var=</td><td>conn.listfiles()</td><td>
<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>
<em>Returns:</em> A list of all files in a database


<pre><code class='hljs-ncdecl language-javascript'>var conn = "exodus";
<span class="c1">// 5. VM -&gt; &quot;\&quot; \n</span>
if (not conn.listfiles()) ...
<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>
// or
if (not listfiles()) ...</code></pre>


</td></tr>
<span class="c1">// 6. SM -&gt; &quot;\\&quot; \n</span>
<tr><td>if</td><td>conn.clearfile(filename)</td><td>Delete all records in a db file
<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>


<pre><code class='hljs-ncdecl language-javascript'>let conn = "exodus", filename = "xo_gendoc_temp2";
<span class="c1">// 7. TM -&gt; &quot;\\\&quot; \n</span>
if (not conn.clearfile(filename)) ...
<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>
// or
if (not clearfile(filename)) ...</code></pre>


<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>
</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>strvar.iconv("TX")</code></p></td><td><p>iconv "TX" Convert text to a dynamic array.</p>
<p>Convert standard text format to dynamic array.</p>
<p>Reverse of oconv("TX") above.</p>
</td></tr>
</td></tr>
<tr><td>if</td><td>conn.deletefile(filename)</td><td>Delete a db file
</table>
 


<pre><code class='hljs-ncdecl language-javascript'>let conn = "exodus", filename = "xo_gendoc_temp2";
<div class=toc>
if (conn.deletefile(filename)) ... ok
<h4 id=dim>Contents:</h4>
// or
<ol>
if (deletefile(filename)) ...</code></pre>
<li><a href=#Dimensioned_Array_Construction_>Dimensioned Array Construction </a></li>
<li><a href=#Array_Access>Array Access</a></li>
<li><a href=#Array_Mutation>Array Mutation</a></li>
<li><a href=#Array_Conversion>Array Conversion</a></li>
<li><a href=#Array_DB_I/O>Array DB I/O</a></li>
<li><a href=#Array_OS_I/O>Array OS I/O</a></li>


</td></tr>
</ol>
<tr><td>var=</td><td>conn_or_file.reccount(filename = "")</td><td>
</div>
<p><em>Returns:</em> The approx. number of records in a db file.
</p>
<p>Might return -1 if not known.
</p>
Not very accurate inside transactions.


<pre><code class='hljs-ncdecl language-javascript'>let conn = "exodus", filename = "xo_clients";
var nrecs1 = conn.reccount(filename);
// or
var nrecs2 = reccount(filename);</code></pre>


</td></tr>
<h5 id=Dimensioned_Array_Construction_>Dimensioned Array Construction </h5>
<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>This doesnt actually flush any indexes but does make sure that reccount() function is reasonably accurate.
</p>
<em>Returns:</em> True if successful otherwise false if not and with lasterror() set.</td></tr>
</table>
<h5 id=Database_File_I/O>Database File I/O</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>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><p><code></code></p></td><td><p><code>dim d1;</code></p></td><td><p>Create an undimensioned array of vars.</p>
<p>Pending actual dimensions by redim, read, osread or split.</p>
<p>
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
</pre></div>
</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.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>dim d1(nrows, ncols = 1);</code></p></td><td><p>Create a dimensioned array of vars.</p>
<p>Specify a fixed number of columns and rows. All vars are unassigned.</p>
<p>
<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="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>
</pre></div>
</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.
<pre><code class='hljs-ncdecl language-javascript'>var file, filename = "xo_clients";
if (not file.open(filename)) ...
// or
if (not open(filename to file)) ...</code></pre>
</td></tr>
</td></tr>
<tr><td></td><td>file.close()</td><td><p>Closes db file var
<tr><td><p><code></code></p></td><td><p><code>dim d1 = d2; // Copy</code></p></td><td><p>Copy a dimensioned array.</p>
<p>Unassigned elements are copied as is.</p>
<p>
<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>
<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>
</pre></div>
</p>
</p>
Does nothing currently since database file vars consume no resources
<pre><code class='hljs-ncdecl language-javascript'>var file = "xo_clients";
file.close();
// or
close(file);</code></pre>
</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><p><code></code></p></td><td><p><code>dim d1 = dim(); // Move</code></p></td><td><p>Save a dimensioned array created elsewhere.</p>
<p>Use C++ "move" semantics.</p>
<p>
<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></div>
</p>
</p>
<p>The fieldname must exist in a dictionary file. The default dictionary is "dict." ^ filename.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>dim d1 = {"a", "b", "c" ...}; // Initializer list</code></p></td><td><p>Create a dimensioned array from a literal list.</p>
<p>All elements must be the same type, var, string, double, int, etc. All end up as vars which are flexible.</p>
<p>
<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>
<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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> False if the index cannot be created for any reason.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>dim d1 = v1;</code></p></td><td><p>Initialise all elements of an dimensioned array.</p>
<p>To some single value. e.g. a var,  "", 0 etc.</p>
<p>
<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="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>
</pre></div>
</p>
</p>
<p>* Index already exists
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>d1.redim(nrows, ncols = 1)</code></p></td><td><p>Resize a dimensioned array.</p>
<p>To a different number of rows and columns.</p>
<p>Existing data will be retained. Any additional elements are unassigned.</p>
<p>Resizing rows to 0 clears all data.</p>
<p>Resizing cols to 0 clears all data and changes its status to "undimensioned".</p>
<p>
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
<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>
</pre></div>
</p>
</p>
<p>* File does not exist
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>d1.swap(d2) </code></p></td><td><p>Swap two arrays.</p>
<p>Either or both may be undimensioned.</p>
<p>
<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="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="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>
</pre></div>
</p>
</p>
<p>* The dictionary file does not have a record with a key of the given field name.
</td></tr>
</table>
<h5 id=Array_Access>Array Access</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code></code></p></td><td><p><code>var v1 = d1[rowno];</br>d1[rowno] = v1;</code></p></td><td><p>[row] Access and update dimensioned array elements.</p>
<p>Two dimensioned arrays can be traversed, columnwise then rowwise, using one dimension array access.</p>
<p>
<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>
<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>
<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>
</pre></div>
</p>
</p>
<p>* The dictionary file does not exist. Default is "dict." ^ filename.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>var v1 = d1[rowno, colno];</br>d1[rowno, colno] = v1;</code></p></td><td><p>[row, col] Access and update dimensioned array elements.</p>
<p>
<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>
<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>
<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>
<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>
</pre></div>
</p>
</p>
* The dictionary field defines a calculated field that uses an exodus function. Using a psql function is OK.
<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>
</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><p><code>var=</code></p></td><td><p><code>d1.rows()</code></p></td><td><p>Get the number of rows in the dimensioned array</p>
<p><em>return:</em> A count. Can be zero, indicating an empty or undimensioned array.</p>
<p>
<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>
<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>
</pre></div>
</p>
</p>
<em>Returns:</em> False if the db file or fieldname are given and do not exist
<pre><code class='hljs-ncdecl language-javascript'>var conn = "exodus";
if (conn.listindex()) ... ok // includes "xo_clients__date_created"
// or
if (listindex()) ... ok</code></pre>
</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><p><code>var=</code></p></td><td><p><code>d1.cols()</code></p></td><td><p>Get the number of columns in the dimensioned array</p>
<p><em>return:</em> A count.  0 if the array is undimensioned.</p>
<p>
<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>
<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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> False if the index cannot be deleted for any reason
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>d1.join(delimiter = FM)</code></p></td><td><p>Get a delimited string concatenating all elements of a dimensioned array.</p>
<p>Unassigned elements on the end are omitted.</p>
<p><em>delimiter:</em> Default is FM.</p>
<p><em>return:</em> A string var.</p>
<p>
<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>
<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>
</pre></div>
</p>
</p>
<p>* File does not exist
</td></tr>
</p>
</table>
* Index does not already exists
<h5 id=Array_Mutation>Array Mutation</h5>


<pre><code class='hljs-ncdecl language-javascript'>var file = "xo_clients", fieldname = "DATE_CREATED";
<table class=wikitable>
if (file.deleteindex(fieldname)) ... ok
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
// or
<tr><td><p><code></code></p></td><td><p><code>d1.splitter(str1, delimiter = FM)</code></p></td><td><p>Create or update a dimensioned array using a string with delimiters.</p>
if (deleteindex(file, fieldname)) ...</code></pre>
<p>If the dim array is undimensioned it will be dimensioned with the number of elements that the string has fields.</p>
 
<p>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.</p>
</td></tr>
<p>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.</p>
<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>Using undimensioned arrays allows the efficient handling of arrays with a very variable number of elements. e.g. OS text files.</p>
</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.
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
<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>
<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>
<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>
</pre></div>
</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.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>d1.sorter(reverse = false)</code></p></td><td><p>Sort a dimensioned array.</p>
<p>The order of the elements is adjusted so that each element is &lt;= the next.</p>
<p><em>reverse:</em> If true, then the order is reversed. The default is false.</p>
<p>
<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>
<span class="n">d1</span><span class="p">.</span><span class="nf">sorter</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="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>
</pre></div>
</p>
</p>
<p>If another connection attempts to place an identical lock on the same database it will be denied.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>d1.reverser()</code></p></td><td><p>Reverse a dimensioned array.</p>
<p>The order of the elements is reversed.</p>
<p>
<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>
<span class="n">d1</span><span class="p">.</span><span class="nf">reverser</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="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>
</pre></div>
</p>
</p>
<p>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.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>d1.randomizer()</code></p></td><td><p>Randomise a dimensioned array.</p>
<p>The order of the elements is randomised.</p>
<p>
<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>
<span class="n">d1</span><span class="p">.</span><span class="nf">randomizer</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="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>
</pre></div>
</p>
</p>
<p>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).
</td></tr>
</p>
</table>
<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.
<h5 id=Array_Conversion>Array Conversion</h5>
</p>
<p><em>Returns:</em>:
</p>
<p>* 0: Failure: Another connection has already placed the same lock.
</p>
<p>* "" Failure: The lock has already been placed.
</p>
<p>* 1: Success: A new lock has been placed.
</p>
* 2: Success: The lock has already been placed and the connection is in a transaction.


<pre><code class='hljs-ncdecl language-javascript'>var file = "xo_clients", key = "1000";
<table class=wikitable>
if (file.lock(key)) ... ok
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
// or
<tr><td><p><code>dim=</code></p></td><td><p><code>d1.sort(reverse = false)</code></p></td><td><p>Get a sorted copy of a dimensioned array.</p>
if (lock(file, key)) ...</code></pre>
</td></tr>
<tr><td><p><code>dim=</code></p></td><td><p><code>d1.reverse()</code></p></td><td><p>Get a reversed copy of a dimensioned array;</p>
</td></tr>
<tr><td><p><code>dim=</code></p></td><td><p><code>d1.randomize()</code></p></td><td><p>Get a randomised copy of a dimensioned array.</p>
</td></tr>
</table>
<h5 id=Array_DB_I/O>Array DB I/O</h5>


</td></tr>
<table class=wikitable>
<tr><td>if</td><td>file.unlock(key)</td><td><p>Removes a db lock placed by the lock function.
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code></code></p></td><td><p><code>d1.write(dbfile, key)</code></p></td><td><p>Write a DB file record created from a dimensioned array.</p>
<p>Each element in the array becomes a separate field in the DB record.</p>
<p>Redundant trailing FMs are omitted.</p>
<p>
<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>
<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="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>
<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>
<span class="c1">// or</span>
<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>
</pre></div>
</p>
</p>
<p>Only locks placed on the specified connection can be removed.
</p>
<p>Locks cannot be removed while a connection is in a transaction.
</p>
<em>Returns:</em> False if the lock is not present in a connection.
<pre><code class='hljs-ncdecl language-javascript'>var file = "xo_clients", key = "1000";
if (file.unlock(key)) ... ok
// or
if (unlock(file, key)) ...</code></pre>
</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><p><code>if</code></p></td><td><p><code>d1.read(dbfile, key)</code></p></td><td><p>Read a DB file record into a dimensioned array.</p>
<p>Each field in the database record becomes a single element in the array.</p>
<p><em>return:</em> True if the record exists or false if not,</p>
<p>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.</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.</p>
<p>
<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="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="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>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
Locks cannot be removed while in a transaction.
<pre><code class='hljs-ncdecl language-javascript'>var conn = "exodus";
if (not conn.unlockall()) ...
// or
if (not unlockall(conn)) ...</code></pre>
</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.
</table>
</p>
<h5 id=Array_OS_I/O>Array OS I/O</h5>
<p>Either inserts a new record or updates an existing record.
</p>
<p><em>Returns:</em> Nothing since writes always succeed.
</p>
<p><em>Throws:</em> VarDBException if the file does not exist. Like most db functions.
</p>
Any memory cached record is deleted.


<pre><code class='hljs-ncdecl language-javascript'>let record = "Client GD^G^20855^30000^1001.00^20855.76539"_var;
<table class=wikitable>
let file = "xo_clients", key = "GD001";
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
//if (not "xo_clients"_var.deleterecord("GD001")) {}; // Cleanup first
<tr><td><p><code>if</code></p></td><td><p><code>d1.oswrite(osfilename, codepage = "")</code></p></td><td><p>Create an entire OS text file from a dimensioned array</p>
record.write(file, key);
<p>Each element of the array becomes one line in the OS file delimited by \n</p>
// or
<p>Any existing OS file is overwritten and replaced.</p>
write(record on file, key);</code></pre>
<p><em>codepage:</em> Optional: Data is converted from UTF8 to the required codepage/encoding before output. If the conversion cannot be performed then return false.</p>
 
<p><em>return:</em> True if successful or false if not.</p>
</td></tr>
<p>
<tr><td>if</td><td>record.read(file, key)</td><td><p>Reads a record from a db file for a given key.
<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>
</p>
<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>
<p><em>file:</em> A db filename or a var opened to a db file.
<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>
</p>
<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>
<p><em>key:</em> The key of the record to be read.
<span class="c1">// or</span>
</p>
<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>
<p><em>Returns:</em> False if the key doesnt exist
</pre></div>
</p>
<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.
<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>
</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><p><code>if</code></p></td><td><p><code>d1.osread(osfilename, codepage = "")</code></p></td><td><p>Read an entire OS text file into a dimensioned array.</p>
<p>Each line in the OS file, delimited by \n or \r\n, becomes a separate element in the array.</p>
<p>Existing data in the array is lost and the array is redimensioned to the number of lines in the input data.</p>
<p><em>codepage:</em> Optional. Data will be converted from the specified codepage/encoding to UTF8 after being read. If the conversion cannot be performed then return false.</p>
<p><em>return:</em> True if successful or false if not.</p>
<p>If the first \n in the file is \r\n then the whole file will be split using \r\n as delimiter.</p>
<p>
<div class="highlight light"><pre><span class="nf">dim</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span>
<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>
<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>
<span class="c1">// or</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">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>
</pre></div>
</p>
</p>
<p><em>Returns:</em> False if the key doesnt exist
</p>
<p>Any memory cached record is deleted.
</p>
deleterecord(in file), a one argument free function, is available that deletes multiple records using the currently active select list.
<pre><code class='hljs-ncdecl language-javascript'>let file = "xo_clients", key = "GD001";
if (file.deleterecord(key)) ... ok
// or
//if (deleterecord(file, key)) ...</code></pre>
</td></tr>
</td></tr>
<tr><td>if</td><td>record.insertrecord(file, key)</td><td><p>Inserts a new record in a db file.
</table>
</p>
<p><em>Returns:</em> False if the key already exists
</p>
Any memory cached record is deleted.


<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>


</td></tr>
<div class=toc>
<tr><td>if</td><td>record.updaterecord(file, key)</td><td><p>Updates an existing record in a db file.
<h4 id=exoprog>Contents:</h4>
</p>
<ol>
<p><em>Returns:</em> False if no record with the given key exists.
<li><a href=#Select_Lists>Select Lists</a></li>
</p>
<li><a href=#Perform/Execute>Perform/Execute</a></li>
Any memory cached record is deleted.
<li><a href=#Program_Termination_>Program Termination </a></li>
<li><a href=#DB_File_Dictionaries>DB File Dictionaries</a></li>
<li><a href=#I/O_Conversion>I/O Conversion</a></li>
<li><a href=#Ioconv_Date/Time_>Ioconv Date/Time </a></li>
<li><a href=#Time/Date_Utilities>Time/Date Utilities</a></li>
<li><a href=#Terminal_I/O_Utilities>Terminal I/O Utilities</a></li>
<li><a href=#Array_Utilities>Array Utilities</a></li>
<li><a href=#Record_Locking>Record Locking</a></li>


<pre><code class='hljs-ncdecl language-javascript'>let record = "Client GD^G^20855^30000^1001.00^20855.76539"_var;
</ol>
let file = "xo_clients", key = "GD001";
</div>
if (not record.updaterecord(file, key)) ...
// or
if (not updaterecord(record on file, key)) ...</code></pre>


</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.
</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>
Any memory cached records of either key are deleted.


<pre><code class='hljs-ncdecl language-javascript'>let file = "xo_clients", key = "GD001", newkey = "GD002";
<h5 id=Select_Lists>Select Lists</h5>
if (not file.updatekey(key, newkey)) ...
// or
if (not updatekey(file, newkey, key)) ... // Reverse the above change.</code></pre>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>select(sortselectclause_or_filehandle = "")</code></p></td><td><p>Create an active select list using a natural language sort/select command.</p>
<p>This and all the following exoprog member functions work on an environment variable CURSOR.</p>
<p>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.</p>
<p><em>return:</em> True if an active select list was created, false otherwise.</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.</p>
<p>
<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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="kc">ID</span><span class="p">))</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="n">ok</span>
</pre></div>
</p>
</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><p><code>if</code></p></td><td><p><code>selectkeys(keys)</code></p></td><td><p>Create an active select list from a dynamic array of keys.</p>
 
<p>
<pre><code class='hljs-ncdecl language-javascript'>var field, file = "xo_clients", key = "GD001", fieldno = 2;
<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>
if (not field.readf(file, key, fieldno)) ... // field -> "G"
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="kc">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>
// or
</pre></div>
if (not readf(field from file, key, fieldno)) ...</code></pre>
</p>
 
</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><p><code>if</code></p></td><td><p><code>hasnext()</code></p></td><td><p>Check if a select list is active.</p>
 
<p>
<pre><code class='hljs-ncdecl language-javascript'>var field = "f3", file = "xo_clients", key = "1000", fieldno = 3;
<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>
field.writef(file, key, fieldno);
</pre></div>
// or
</p>
writef(field on file, key, fieldno);</code></pre>
 
</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><p><code>if</code></p></td><td><p><code>readnext(out key)</code></p></td><td><p>Get the next key from an active select list.</p>
<p><em>key[out]:</em> A string. Typically the key of a db file record.</p>
<p><em>return:</em> True if an active select list was available and the next key in the list was obtained.</p>
<p>
<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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="kc">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>
</pre></div>
</p>
</p>
<p>The actual database file is NOT updated.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>readnext(out key, out valueno)</code></p></td><td><p>Get the next key and value number pair from an active select list.</p>
<p><em>key[out]:</em> A string. Typically the key of a db file record.</p>
<p><em>valueno[out]:</em> 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.</p>
<p><em>return:</em> True if an active select list was available and the next key in the list was obtained.</p>
<p>
<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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="kc">ID</span><span class="p">,</span><span class="w"> </span><span class="kc">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>
</pre></div>
</p>
</p>
<p>writec() either updates an existing cache record if the key already exists or otherwise inserts a new record into the cache.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>readnext(out record, out key, out valueno)</code></p></td><td><p>Get the next record, key and value no from an active select list.</p>
<p><em>record[out]:</em> 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.</p>
<p><em>key[out]:</em> A string. Typically the key of a db file record.</p>
<p><em>valueno[out]:</em> 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.</p>
<p><em>return:</em> True if an active select list was available and the next key in the list was obtained.</p>
<p>
<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>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nf">readnext</span><span class="p">(</span><span class="kc">RECORD</span><span class="p">,</span><span class="w"> </span><span class="kc">ID</span><span class="p">,</span><span class="w"> </span><span class="kc">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>
<span class="n">assert</span><span class="p">(</span><span class="ow">not</span><span class="w"> </span><span class="kc">RECORD</span><span class="p">.</span><span class="nf">empty</span><span class="p">());</span>
</pre></div>
</p>
</p>
<p>It always succeeds so no result code is returned.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>pushselect(out cursor)</code></p></td><td><p>Get a reference to the currently active select list and suspend it.</p>
<p>Allow another select list to be activated and used temporarily before the original select list is reactivated.</p>
<p>Multiple levels of pushselect/popselect can be used.</p>
<p><em>cursor[out]:</em> A var that can be passed later on to the popselect() function to reactivate the saved list.</p>
<p>
<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>
<span class="kt">var</span><span class="w"> </span><span class="n">saved_xo_clients_cursor</span><span class="p">;</span>
<span class="nf">pushselect</span><span class="p">(</span><span class="n">saved_xo_clients_cursor</span><span class="p">);</span>
<span class="c1">//</span>
<span class="c1">// ... work with another select list ...</span>
<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>
</pre></div>
</p>
</p>
Neither the db file nor the record key need to actually exist in the actual db.
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>
</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><p><code></code></p></td><td><p><code>popselect(cursor)</code></p></td><td><p>Re-activate a select list using a reference provided by pushselect().</p>
<p><em>cursor:</em> A var created by the pushselect() function.</p>
<p>See pushselect() for more info.</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>clearselect()</code></p></td><td><p>Deactivate an active select list.</p>
<p>If no select list is active then nothing is done.</p>
<p>
<div class="highlight light"><pre><span class="nf">clearselect</span><span class="p">();</span>
</pre></div>
</p>
</p>
<p>1. Tries to read from a memory cache. Returns true if successful.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>deleterecord(filename)</code></p></td><td><p>Delete multiple DB records using an active select list.</p>
<p><em>return:</em> False if any records could not be deleted.</p>
<p>Contrast this function with the two argument "deleterecord(file, key)" function that deletes a single record.</p>
<p>
<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>
<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>
<span class="p">}</span>
</pre></div>
</p>
</p>
<p>2a. Tries to read from the actual db file and returns false if unsuccessful.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>deleterecord(dbfile, key)</code></p></td><td><p>Delete a single DB record.</p>
<p>
<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>
<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>
<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>
<span class="c1">// or</span>
<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>
<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>
</pre></div>
</p>
</p>
<p>2b. Writes the record and key to the memory cache and returns true.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>savelist(listname)</code></p></td><td><p>Save the current active select list under a given name.</p>
<p>Select lists are saved in the DB file "lists". They are accessible to any Exodus process and remain until specifically deleted.</p>
<p>After saving, the list is no longer active and hasnext() will return false.</p>
<p><em>return:</em> True if an active select list was saved, false if there was no active select list.</p>
<p>
<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>
<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>
</pre></div>
</p>
</p>
Cached db file data lives in exodus process memory and is lost when the process terminates or clearcache() is called.
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
</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><p><code>if</code></p></td><td><p><code>getlist(listname)</code></p></td><td><p>Create an active select list using a saved select list of a given name.</p>
<p>A saved list is obtained from the "lists" file and activated. The list remains in the lists file for multiple use.</p>
<p><em>return:</em> True if an active select list was successfully reactivated, otherwise false.</p>
<p>
<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></div>
</p>
</p>
<p>The actual database file is NOT updated.
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>deletelist(listname)</code></p></td><td><p>Remove a saved select list by name.</p>
<p>A saved list is deleted from the "lists" file.</p>
<p>
<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></div>
</p>
</p>
<em>Returns:</em> False if the key doesnt exist
</td></tr>
 
<tr><td><p><code>if</code></p></td><td><p><code>formlist(filename_or_command, keys = "", fieldno = 0)</code></p></td><td>
<pre><code class='hljs-ncdecl language-javascript'>var file = "xo_clients", key = "XD001";
</td></tr>
if (file.deletec(key)) ... ok
<tr><td><p><code>if</code></p></td><td><p><code>makelist(listname, keys)</code></p></td><td>
// or
</td></tr>
if (deletec(file, key)) ...</code></pre>
</table>
<h5 id=Perform/Execute>Perform/Execute</h5>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>perform(command_line)</code></p></td><td><p>Run an Exodus program/library.</p>
<p>Creates a new instance of an Exodus program library function object and calls its main() function using a command-like syntax, similar to that of running an OS executable program, and passes its arguments through the COMMAND and OPTIONS variables.</p>
<p>A performed program/library's main function should have no arguments otherwise they appear unassigned and a segfault or core dump may occur.</p>
<p>The Exodus program class member variables of a performed or executed program/library are all, as might be expected, initially unassigned unless specifically initialised inline. Note that this is not the same as calling a program library function (using function call syntax and round brackets funcx()), where the program/library/function's member variables are initially unassigned but retain their state between calls.</p>
<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><em>return:</em> Whatever the program returns from main() or passes as an argument to stop(). If the program terminates abnormally then it will return "" and lasterror() will contain some error message. The return value may be ignored so there is no need so wrap perform statements in if clauses to avoid compiler warnings.</p>
<p><em>throw:</em> All the various runtime errors based on VarError e.g. VarUnassigned.</p>
<p><em>environment:</em> The following environment variables are initialised on entry to the main function of the program/library and are preserved untouched (actually restored) in the calling program.</p>
<ul>
<li>COMMAND, OPTIONS, SENTENCE.</li>
<li>RECUR0, RECUR1, RECUR2, RECUR3, RECUR4 to "".</li>
<li>ID, RECORD, MV, DICT initialised to "".</li>
<li>LEVEL is incremented by one.</li>
<li>All other environment variables are shared between the caller and callee. There is essentially only one environment in any one process or thread.</li>
<li>CURSOR 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() where the executed program/library gets its own private active select list, initially inactive.</li>
</ul>
<p>Exodus program/library/functions 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 &lt;progname.h&gt;" after the "programinit()" or "libraryinit()" lines in your program/library. See library.h for more info.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>execute(command_line)</code></p></td><td><p>Run an exodus program/library.</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.</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>chain(command_line)</code></p></td><td><p>Close the current program and perform another one.</p>
<p>Similar to perform() except that the current program closes first and all environment variables carry forward unchanged.</p>
</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><p><code>var=</code></p></td><td><p><code>libinfo(libname)</code></p></td><td><p>Check if a lib exists.</p>
</p>
<p>Can be checked before perform/execute to avoid errors.</p>
All future cache readc() function calls will be forced to obtain records from the actual database and refresh the cache.
<p>Currently it does not check if the library is actually loadable.</p>
 
<p><em>return:</em> osfile info.</p>
<pre><code class='hljs-ncdecl language-javascript'>conn.clearcache();
// or
clearcache(conn);</code></pre>
 
</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.
</table>
</p>
<h5 id=Program_Termination_>Program Termination </h5>
<p><em>Arguments:</em>
</p>
<p>strvar: Used as the primary key to lookup a field in a given file and field no or field name.
</p>
<p><em>filename:</em> The db file in which to look up data.
</p>
<p>If var key is multivalued then a multivalued field is returned.
</p>
<p><em>fieldno:</em> Determines which field of the record is returned.
</p>
<p>* Integer returns that field number
</p>
<p>* 0 means return the key unchanged.
</p>
<p>* "" means return the whole record.
</p>
<p><em>mode:</em> Determines what is returned if the record does not exist for the given key and file.
</p>
<p>* "X" returns ""
</p>
* "C" returns the key unconverted.


<pre><code class='hljs-ncdecl language-javascript'>let key = "SB001";
<table class=wikitable>
let client_name = key.xlate("xo_clients", 1, "X"); // "Client AAA"
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
// or
<tr><td><p><code></code></p></td><td><p><code>stop(result = "")</code></p></td><td><p>Stop the current exodus program/library normally.</p>
let name_and_type = xlate("xo_clients", key, "NAME_AND_TYPE", "X"); // "Client AAA (A)"</code></pre>
<p>Either return to the performing or executing parent exodus program/library, or exit to the OS if none.</p>
<p><em>result:</em> Optional. It will be used as the return value of a parent program's perform() or execute() function, or if none, and therefore returning to the OS, it will be output to stdout if non-numeric or, if numeric, used as the exit status.</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>abort(message = "")</code></p></td><td><p>Abort the current exodus program/library.</p>
<p>Similar to stop but if exiting to the OS then the default exit status is 1.</p>
<p><em>message:</em> Optional. If exiting to the OS then it will be output to stderr or, if numeric, used as the exit status.</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>abortall(message = "")</code></p></td><td><p>Abort the current exodus program/library.</p>
<p>Similar to abort but if exiting to the OS then the default exit status is 2.</p>
</td></tr>
</table>
<h5 id=DB_File_Dictionaries>DB File Dictionaries</h5>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>calculate(dictid)</code></p></td><td><p>Get DB record field values given field name only.</p>
<p>Use a dictionary file that contains info sufficient to either extract or calculate the required value.</p>
<ol>
<li>Read fieldinfo from the current DICT file using readc() for caching.</li>
<li>Use the fieldinfo to:<ul>
  <li>Either extract a specific field number from the current RECORD/ID/MV environment variables.</li>
  <li>Or call a dictionary function library to calculate the result.</li>
</ul>
</li>
</ol>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>calculate(dictid, dictfile, id, record, mv = 0)</code></p></td><td><p>Get DB record field values given name and data.</p>
<p>Same as the one argument version of calculate() but RECORD/ID/MV are provided as arguments instead of being hard coded.</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>xlate(filename, key, fieldno_or_name, mode)</code></p></td><td><p>Read DB field using field number or name.</p>
<ol>
<li>Read a record from a given file and key using readc() for caching.</li>
<li>Extracts the given field number or calls calculate(dictid...) if non-numeric.</li>
</ol>
<p><em>filename:</em> The file to read.</p>
<p><em>key:</em> The key of the record to read.</p>
<p></p>
<p><em>fieldno_or_name:</em> The field  to return.</p>
<dl>
<dt>nn</dt><dd>Field number nn.</dd>
<dt>0</dt><dd>The record key (ID).</dd>
<dt>""</dt><dd>The whole record (RECORD)</dd>
<dt>dictid</dt><dd>The function calculate(dictid) will be called.</dd>
</dl>
<p></p>
<p><em>mode:</em> If the record does not exist.</p>
<dl>
<dt>"X"</dt><dd>Return ""</dd>
<dt>"C"</dt><dd>Return the key.</dd>
</dl>
<p></p>
<p><em>MV:</em> Environment variable. Will be used to select a particular value if not zero, or all values if zero.</p>
</td></tr>
</td></tr>
</table>
</table>
<h5 id=Database_Sort/Select>Database Sort/Select</h5>
<h5 id=I/O_Conversion>I/O Conversion</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>dbfile.select(sort_select_command = "")</td><td><p>Create an active select list of keys of a database file.
<tr><td><p><code>var=</code></p></td><td><p><code>oconv(input, conversion)</code></p></td><td><p>iconv/oconv "[...]"</p>
<p>ExoProgram's iconv/oconv functions have access to ExoProgram's environment variables like BASEFMT, DATEFMT and TZ and have the ability to call custom functions like "[funname,args...]"</p>
<p></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>
<tr><td><p><code>var=</code></p></td><td><p><code>iconv(input, conversion)</code></p></td><td>
</td></tr>
</table>
<h5 id=Ioconv_Date/Time_>Ioconv Date/Time </h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>iconv|oconv(var, "[DATE]")</code></p></td><td><p>iconv/oconv "[DATE]"</p>
<p>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.</p>
<p></p>
<p><em>var:</em> [oconv] An internal date (a number).</p>
<p><em>return:</em> [oconv] A readable date in text format depending on "[DATE,args]" e.g. "31 DEC 2020" "31/12/2020" "12/31/2020"</p>
<p><em>var:</em> [iconv] A date in text format as above.</p>
<p><em>return:</em> [iconv] An internal date (a number) or "" if the input could not be understood as a valid date.</p>
<p><em>args:</em> 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.</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]");'.</p>
<p>
<div class="highlight light"><pre><span class="kc">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>
<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>
<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>
<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>
<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>
<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>
</pre></div>
</p>
</p>
<p>The select(command) function searches and orders database records for subsequent processing given an English language-like command.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>iconv|oconv(var, "[NUMBER]")</code></p></td><td><p>iconv/oconv "[NUMBER]"</p>
<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.</p>
<p>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.</p>
<p>Primarily used for oconv() but can be used in reverse for iconv.</p>
<p><em>var:</em> A number with an optional currency code or unit suffix. e.g. "12345.67USD"</p>
<p><em>return:</em> A formatted number with thousands separated conventionally e.g. "12.345.67USD".</p>
<p>iconv/oconv("[NUMBER]")      oconv leaves ndecimals untouched as in the input. iconv see below.</p>
<p>iconv/oconv("[NUMBER,2]")    Specified number of decimal places</p>
<p>iconv/oconv("[NUMBER,BASE]") Decimal places as per BASEFMT</p>
<p>iconv/oconv("[NUMBER,*]")    Leave decimal places untouched as in the input</p>
<p>iconv/oconv("[NUMBER,X]")    Leave decimal places untouched as in the input</p>
<p>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.</p>
<p></p>
<p>Empty input "" gives empty output "".</p>
<p></p>
<p>All leading, trailing and internal spaces are removed from the input.</p>
<p></p>
<p>A trailing currency or unit code is ignored and returned on output.</p>
<p></p>
<p>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.</p>
<p></p>
<p>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.</p>
<p></p>
<p>iconv removes and oconv adds thousand separator chars. The thousands separator is  "," if BASEFMT starts with "MD" or "." if it starts with "MC".</p>
<p></p>
<p><em>oconv:</em> </p>
<p></p>
<p>Add thousands separator chars and optionally standardise the number of decimal places.</p>
<p></p>
<p>Multiple numbers in fields, values, subvalues etc. can be processed in one string.</p>
<p></p>
<p>Any leading + character is preserved on output.</p>
<p></p>
<p>Z suppresses zeros and returns empty string "" instead.</p>
<p></p>
<p>Special format "[NUMBER,ndecs,move_ndecs]": move_ndecs causes decimal point to be shifted left if positive or right if negative.</p>
<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="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></div>
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".
<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></div>
</p>
</p>
<p>The primary job of a database, beyond mere storage and retrieval of information, is to allow rapid searching and ordering of information on demand.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>amountunit(input0, out unitx)</code></p></td><td><p>Parse amount+currency code string.</p>
<p>Split amount+currency code/unit string into number and currency code/unit.</p>
<p><em>var:</em> "123.45USD"</p>
<p><em>return:</em> e.g. "123.45"</p>
<p><em>unitx[out]:</em> e.g. "USD"</p>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>amountunit(input0)</code></p></td><td>
</td></tr>
</table>
<h5 id=Time/Date_Utilities>Time/Date Utilities</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>timedate2()</code></p></td><td><p>Get text of date and time.</p>
<p>In users time zone</p>
<p>e.g. "2MAR2025 11:52AM"</p>
<p>Offset from UTC by TZ seconds.</p>
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>getdatetime(out user_date, out user_time, out system_date, out system_time, out UTC_date, out UTC_time)</code></p></td><td><p>Get current user, server and UTC dates and times.</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>
<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>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>elapsedtimetext()</code></p></td><td><p>Get text of elapsed time.</p>
<p>Since environment variable TIMESTAMP.</p>
<p>TIMESTAMP is initialised with ostimestamp() at program/thread startup.</p>
<p>TIMESTAMP can be updated using ostimestamp() as and when desired.</p>
<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="nf">elapsedtimetext</span><span class="p">();</span><span class="w"> </span><span class="c1">// e.g. &quot;&lt; 1ms&quot;</span>
</pre></div>
</p>
</p>
<p>In Exodus, searching and ordering of information is known as "sort/select" and is performed by the select() function.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>elapsedtimetext(timestamp1, timestamp2)</code></p></td><td><p>Get text of elapsed time.</p>
<p>Between two given timestamps</p>
<p><em>Warning:</em> Use ostimestamp() not ostime(). The first is in days and the second is in seconds.</p>
<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="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>
<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>
</p>
</p>
<p>Executing the select() function creates an "active select list" which can then be consumed by the readnext() function.
</td></tr>
</table>
<h5 id=Terminal_I/O_Utilities>Terminal I/O Utilities</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code></code></p></td><td><p><code>note(msg, options, io response)</code></p></td><td><p>Output a message to stdout and optionally request input.</p>
<p>If input is requested but stdin is not a terminal then set the response to "" and continue.</p>
<p><em>options:</em> R = Response requested. C upper case response.</p>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">response</span><span class="p">;</span>
<span class="c1">// call note(&quot;Enter something&quot;, &quot;RC&quot;, response);</span>
</pre></div>
</p>
</p>
<p><em>dbfile:</em> 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.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>note(msg)</code></p></td><td><p>Output a message to stdout.</p>
<p>
<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></div>
</p>
</p>
<p><em>sort_select_command:</em> 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.
</td></tr>
</p>
<tr><td><p><code>var=</code></p></td><td><p><code>decide(question, options = "")</code></p></td><td><p>Input user selection from a list of options.</p>
<p><em>Example:</em> "select xo_clients with type 'B' and with balance ge 100 by type by name"
<p>If stdin is not a terminal, set the response to "" and continue.</p>
</p>
<p><em>return:</em> The chosen option (value not number) or "" if the user cancelled.</p>
<p><em>Option:</em> "(R)" appended to the sort_select_command acquires the database records as well.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>decide(question, options, out reply, defaultreply = 1)</code></p></td><td><p>Input user selection from a list of options.</p>
<p>If stdin is not a terminal set the response to the default value, or "" if none, and continue.</p>
<p><em>defaultreply:</em> A default option if the user presses Enter.</p>
<p><em>reply[out]:</em> The option number that the user chose or "" if they cancelled.</p>
<p><em>return:</em> The chosen option (value not number) or "" if the user cancelled.</p>
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>esctoexit()</code></p></td><td><p>Check for user pause or cancel.</p>
<p>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.</p>
<p><em>return:</em> </p>
<dl>
<dt>True</dt><dd>A key has been pressed and the user chose not to resume.</dd>
<dt>False</dt><dd>stdif is not a terminal, no key has been pressed, or the user chose to resume.</dd>
</dl>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>AT(code)</code></p></td><td><p>Get a string to control terminal operation.</p>
<p><em>return:</em> A string to be output to the terminal in order to accomplish the desired operation.</p>
<p>The terminal protocol is xterminal.</p>
<p><em>code:</em> </p>
<dl>
<dt>  n</dt><dd>Position the cursor at column number n (1 based).</dd>
<dt>  0</dt><dd>Position the cursor at the first column (1).</dd>
<dt> -1</dt><dd>Clear the screen and home the cursor.</dd>
<dt> -2</dt><dd>Position the cursor at the top left home (x, y = 1, 1).</dd>
<dt> -3</dt><dd>Clear from the cursor at the end of screen.</dd>
<dt> -4</dt><dd>Clear from cursor to end of line.</dd>
<dt>-40</dt><dd>Position the cursor at columnno 0 and clear to end of line.</dd>
</dl>
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>AT(x, y)</code></p></td><td><p>Get a terminal cursor positioning string.</p>
<p><em>return:</em> A string to be output to the terminal to position the cursor at the desired screen x and y position.</p>
<p>The terminal protocol is xterminal.</p>
</td></tr>
<tr><td><p><code>if</code></p></td><td><p><code>getcursor(out cursor, delayms = 3000, max_errors = 0)</code></p></td><td><p>Get the position of the terminal cursor.</p>
<p><em>cursor[out]:</em> If stdin is a terminal, an FM delimited string containing the x and y coordinates of the current terminal cursor.</p>
<p>x and y are 1 based, not 0 based.</p>
<p>If stdin is not a terminatl then an empty string "" is returned.</p>
<p>The cursor additionally contains a third field which contains the delay in ms from the terminal.</p>
<p>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.</p>
<p><em>delayms:</em> Default 3000ms. The maximum time to wait for terminal response.</p>
<p><em>max_errors:</em> 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().</p>
<p>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:</p>
<dl>
<dt>TIMEOUT</dt><dd>The terminal failed to respond within the timeout.</dd>
<dt>READ_ERROR</dt><dd>Failed to read terminal response.</dd>
<dt>INVALID_RESPONSE</dt><dd>Terminal response invalid.</dd>
<dt>SETUP_ERROR</dt><dd>Terminal setup failed.</dd>
<dt>DISABLED</dt><dd>Terminal is disabled due to more errors than the maximum currently set.</dd>
</dl>
<p>
<div class="highlight light"><pre><span class="kt">var</span><span class="w"> </span><span class="n">cursor</span><span class="p">;</span>
<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;1^20^0.012345&quot;_var</span>
</pre></div>
</p>
</p>
<p><em>Returns:</em> True if any records are selected or false if none.
</td></tr>
<tr><td><p><code>var=</code></p></td><td><p><code>getcursor()</code></p></td><td><p>Get the position of the terminal cursor.</p>
<p>For more info see the main getcursor() function above.</p>
<p>
<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></div>
</p>
</p>
<p><em>Throws:</em> VarDBException in case of any syntax error in the command.
</td></tr>
<tr><td><p><code></code></p></td><td><p><code>setcursor(cursor_coordinates)</code></p></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().
<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>
<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>
<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>
<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>
<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>
<span class="p">}</span>
</pre></div>
</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.
</td></tr>
 
</table>
<pre><code class='hljs-ncdecl language-javascript'>var clients = "xo_clients";
<h5 id=Array_Utilities>Array Utilities</h5>
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);</code></pre>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>var=</code></p></td><td><p><code>invertarray(input, pad = false)</code></p></td><td><p>Dynamic array fields become values and vice versa</p>
<p><em>return:</em> The inverted dynamic array.</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.</p>
<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="s">&quot;a]b]c^1]2]3&quot;</span><span class="kt">_var</span><span class="p">;</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">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>
</pre></div>
</p>
</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><p><code></code></p></td><td><p><code>sortarray(io array, fns = "", order = "")</code></p></td><td><p>Sort parallel fields of multivalues of dynamic arrays</p>
</p>
<p><em>fns:</em> VM separated list of field numbers to sort in parallel based on the first field number</p>
<p>Similar to select() but creates the list directly from a var.
<p><em>order:</em> </p>
</p>
<dl>
<p><em>keys:</em> An FM separated list of keys or key^VM^valueno pairs.
<dt>AL</dt><dd>Ascending  - Left Justified (Alphabetic)</dd>
<dt>DL</dt><dd>Descending - Left Justified (Alphabetic)</dd>
<dt>AR</dt><dd>Ascending  - Right Justified (Numeric/Natural)</dd>
<dt>DR</dt><dd>Descending - Right Justified (Numeric/Natural)</dd>
</dl>
<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="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>
<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>
</pre></div>
</p>
</p>
<em>Returns:</em> True if any keys are provided or false if not.
<pre><code class='hljs-ncdecl language-javascript'>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");</code></pre>
</td></tr>
</td></tr>
<tr><td>if</td><td>dbfile.hasnext()</td><td><p>Checks if a select list is active.
</table>
</p>
<h5 id=Record_Locking>Record Locking</h5>
<p><em>dbfile:</em> A file or connection var used in a prior select, selectkeys or getlist function call.
</p>
<p><em>Returns:</em> True if a select list is active and false if not.
</p>
If it returns true then a call to readnext() will return a database record key, otherwise not.
 
<pre><code class='hljs-ncdecl language-javascript'>var clients = "xo_clients", key;
if (clients.select()) {
    assert(clients.hasnext());
}
// or
if (select("xo_clients")) {
    assert(hasnext());
}</code></pre>


<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td><p><code>if</code></p></td><td><p><code>lockrecord(filename, io file, keyx, unused, waitsecs = 0, allowduplicate = false)</code></p></td><td>
</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><p><code>if</code></p></td><td><p><code>lockrecord(filename, io file, keyx)</code></p></td><td>
</p>
<p><em>dbfile:</em> A file or connection var used in a prior select, selectkeys or getlist function call.
</p>
<p><em>key:</em> Returns the first (next) key present in an active select list or "" if no select list is active.
</p>
<p><em>Returns:</em> True if a list is active and a key is available, false if not.
</p>
<p>Each call to readnext consumes one key from the list.
</p>
<p>Once all the keys in an active select list have been consumed by calls to readnext, the list becomes inactive.
</p>
<p>See select() for example code.
</p>
</td></tr>
<tr><td>if</td><td>dbfile.readnext(out key, out valueno)</td><td><p>Similar to readnext(key) but multivalued.
</p>
<p>If the active list was ordered by multivalued database fields then pairs of key and multivalue number will be available to the readnext function.
</p>
</td></tr>
<tr><td>if</td><td>dbfile.readnext(out record, out key, out valueno)</td><td><p>Similar to readnext(key) but acquires the database record as well.
</p>
<p><em>record:</em> Returns the next database record from the select list assuming that the select list was created with the (R) option otherwise "" if not.
</p>
<p><em>key:</em> Returns the next database record key in the select list.
</p>
<em>valueno:</em> The multivalue number if the select list was ordered on multivalued database record fields or 1 if not.
 
<pre><code class='hljs-ncdecl language-javascript'>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"));</code></pre>
 
</td></tr>
<tr><td></td><td>dbfile.clearselect()</td><td><p>Deactivates an active select list.
</p>
<p><em>dbfile:</em> A file or connection var used in a prior select, selectkeys or getlist function call.
</p>
<p><em>Returns:</em> Nothing
</p>
Has no effect if no select list is active for dbfile.
 
<pre><code class='hljs-ncdecl language-javascript'>var clients = "xo_clients";
clients.clearselect();
if (not clients.hasnext()) ... ok
// or
clearselect();
if (not hasnext()) ... ok</code></pre>
 
</td></tr>
<tr><td>if</td><td>dbfile.savelist(listname)</td><td><p>Stores an active select list for later retrieval.
</p>
<p><em>dbfile:</em> A file or connection var used in a prior select, selectkeys or getlist function call.
</p>
<p><em>listname:</em> A suitable name that will be required for later retrieval.
</p>
<p><em>Returns:</em> True if saved successfully or false if there was no active list to be saved.
</p>
<p>Any existing list with the same name will be overwritten.
</p>
<p>Only the remaining unconsumed part of the active select list is saved.
</p>
<p>Saved lists are stand-alone and are not tied to specific database files although they usually hold keys related to specific files.
</p>
<p>Saved lists can be created from one file and used to access another.
</p>
<p>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.
</p>
<p>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.
</p>
Select lists saved in the lists database file may be created, deleted and listed like database records in any other database file.
 
<pre><code class='hljs-ncdecl language-javascript'>var clients = "xo_clients";
if (clients.select("with type 'B' by name")) {
}
// or
if (select("xo_clients with type 'B' by name")) {
    if (savelist("mylist")) ... ok
}</code></pre>
 
</td></tr>
<tr><td>if</td><td>dbfile.getlist(listname)</td><td><p>Retrieve and reactivate a saved select list.
</p>
<p><em>dbfile:</em> A file or connection var to be used by subsequent readnext function calls.
</p>
<p><em>listname:</em> The name of an existing list in the "lists" database file, either created by savelist or manually.
</p>
<p><em>Returns:</em> True if the list was successfully retrieved and activated, or false if the list name doesnt exist.
</p>
<p>Any currently active select list is replaced.
</p>
Retrieving a list does not delete it and a list can be retrieved more than once until specifically deleted.
 
<pre><code class='hljs-ncdecl language-javascript'>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);
}</code></pre>
 
</td></tr>
<tr><td>if</td><td>dbfile.deletelist(listname)</td><td><p>Delete a saved select list.
</p>
<p><em>dbfile:</em> A file or connection to the desired database.
</p>
<p><em>listname:</em> The name of an existing list in the "lists" database file.
</p>
<em>Returns:</em> True if successful or false if the list name doesnt exist.
 
<pre><code class='hljs-ncdecl language-javascript'>var conn = "";
if (conn.deletelist("mylist")) ... ok
// or
if (deletelist("mylist")) ...</code></pre>
 
</td></tr>
</table>
<h5 id=OS_Time/Date>OS Time/Date</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>var::date()</td><td><p>Number of whole days since pick epoch 1967-12-31 00:00:00 UTC. Negative for dates before.
</p>
e.g. was 20821 from 2025-01-01 00:00:00 UTC for 24 hours
 
<pre><code class='hljs-ncdecl language-javascript'>let today1 = var::date();
// or
let today2 = date();</code></pre>
 
</td></tr>
<tr><td>var=</td><td>var::time()</td><td><p>Number of whole seconds since last 00:00:00 (UTC).
</p>
<p>e.g. 43200 if time is 12:00
</p>
Range 0 - 86399 since there are 24*60*60 (86400) seconds in a day.
 
<pre><code class='hljs-ncdecl language-javascript'>let now1 = var::time();
// or
let now2 = time();</code></pre>
 
</td></tr>
<tr><td>var=</td><td>var::ostime()</td><td><p>Number of fractional seconds since last 00:00:00 (UTC).
</p>
<p>A floating point with approx. nanosecond resolution depending on hardware.
</p>
e.g. 23343.704387955 approx. 06:29:03 UTC
 
<pre><code class='hljs-ncdecl language-javascript'>let now1 = var::ostime();
// or
let now2 = ostime();</code></pre>
 
</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.
</p>
<p>A floating point with approx. nanosecond resolution depending on hardware.
</p>
e.g. Was 20821.99998842593 around 2025-01-01 23:59:59 UTC
 
<pre><code class='hljs-ncdecl language-javascript'>let now1 = var::ostimestamp();
// or
let now2 = ostimestamp();</code></pre>
 
</td></tr>
<tr><td>var=</td><td>vardate.ostimestamp(ostime)</td><td>Construct a timestamp from a date and time
 
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>
 
</td></tr>
<tr><td></td><td>var::ossleep(milliseconds)</td><td><p>Sleep/pause/wait for a number of milliseconds
</p>
Releases the processor if not needed for a period of time or a delay is required.
 
<pre><code class='hljs-ncdecl language-javascript'>var::ossleep(100); // sleep for 100ms
// or
ossleep(100);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>file_dir_list.oswait(milliseconds)</td><td><p>Sleep/pause/wait up to a given number of milliseconds or until any changes occur in an FM delimited list of directories and/or files.
</p>
<p>Any terminal input (e.g. a key press) will also terminate the wait.
</p>
<p>An FM array of event information is returned. See below.
</p>
<p>Multiple events are returned in multivalues.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = ".^/etc/hosts"_var.oswait(100); /// e.g. "IN_CLOSE_WRITE^/etc^hosts^f"_var
// or
let v2 = oswait(".^/etc/hosts"_var, 100);</code></pre>
 
Returned array fields
</p>
<p>1. Event type codes
</p>
<p>2. dirpaths
</p>
<p>3. filenames
</p>
<p>4. d=dir, f=file
</p>
<p><pre>
</p>
<p>Possible event type codes are as follows:
</p>
<p>* IN_CLOSE_WRITE - A file opened for writing was closed
</p>
<p>* IN_ACCESS      - Data was read from file
</p>
<p>* IN_MODIFY      - Data was written to file
</p>
<p>* IN_ATTRIB      - File attributes changed
</p>
<p>* IN_CLOSE      - File was closed (read or write)
</p>
<p>* IN_MOVED_FROM  - File was moved away from watched directory
</p>
<p>* IN_MOVED_TO    - File was moved into watched directory
</p>
<p>* IN_MOVE        - File was moved (in or out of directory)
</p>
<p>* IN_CREATE      - A file was created in the directory
</p>
<p>* IN_DELETE      - A file was deleted from the directory
</p>
<p>* IN_DELETE_SELF - Directory or file under observation was deleted
</p>
<p>* IN_MOVE_SELF  - Directory or file under observation was moved
</p>
<p></pre>
</p>
</td></tr>
</table>
<h5 id=OS_File_I/O>OS File I/O</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>osfilevar.osopen(osfilename, utf8 = true)</td><td><p>Initialises an os file handle var that can be used for random read and write
</p>
<p><em>osfilename:</em> The name of an existing os file name including path.
</p>
<p><em>utf8:</em> Defaults to true which causes trimming of partial UTF-8 Unicode byte sequences from the end of osbreads. For raw untrimmed osbreads pass tf8 = false;
</p>
<p><em>osfilevar:</em> [out] To be used in subsequent calls to osbread() and osbwrite()
</p>
<p><em>Returns:</em> True if successful or false if not possible for any reason. e.g. Target doesnt exist, permissions etc.
</p>
The file will be opened for writing if possible otherwise for reading.
 
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
 
</td></tr>
<tr><td>if</td><td>osfilevar.osbwrite(osfilevar, io offset)</td><td><p>Writes data to an existing os file starting at a given byte offset (0 based).
</p>
See osbread for more info.
 
<pre><code class='hljs-ncdecl language-javascript'>let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
let text = "aaa=123\nbbb=456\n";
var offset = osfile(osfilename).f(1); /// Size of file therefore append
if (text.osbwrite(osfilename, offset)) ... ok // offset -> 16
// or
if (not osbwrite(text on osfilename, offset)) ...</code></pre>
 
</td></tr>
<tr><td>if</td><td>osfilevar.osbread(osfilevar, io offset, length)</td><td><p>Reads length bytes from an existing os file starting at a given byte offset (0 based).
</p>
<p>The osfilevar file handle may either be initialised by osopen or be just be a normal string variable holding the path and name of the os file.
</p>
<p>After reading, the offset is updated to point to the correct offset for a subsequent sequential read.
</p>
If reading UTF8 data (the default) then the length of data actually returned may be a few bytes shorter than requested in order to be a complete number of UTF-8 code points.
 
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
 
</td></tr>
<tr><td></td><td>osfilevar.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>
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.
 
<pre><code class='hljs-ncdecl language-javascript'>osfilevar.osclose();
// or
osclose(osfilevar);</code></pre>
 
</td></tr>
<tr><td>if</td><td>strvar.oswrite(osfilename, codepage = "")</td><td><p>Create a complete os file from a var.
</p>
<p><em>strvar:</em> The text or data to be used to create the file.
</p>
<p><em>osfilename:</em> Absolute or relative path and filename to be written. Any existing os file is removed first.
</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>Returns:</em> True if successful or false if not possible for any reason. e.g. Path is not writeable, permissions etc.
 
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
 
</td></tr>
<tr><td>if</td><td>strvar.osread(osfilename, codepage = "")</td><td><p>Read a complete os file into a var.
</p>
<p><em>osfilename:</em> Absolute or relative path and filename to be read.
</p>
<p><em>codepage:</em> If specified then input is converted from that codepage to UTF-8 after being read. Otherwise no conversion is done.
</p>
<p><em>strvar:</em> [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.
</p>
<em>Returns:</em> True if successful or false if not possible for any reason. e.g. File doesnt exist, insufficient permissions etc.
 
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>
 
</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.
</p>
<p>The source and target must exist in the same storage device.
</p>
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be renamed.
</p>
<p><em>new_dirpath_or_filepath:</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. Target already exists, path is not writeable, permissions etc.
</p>
Uses std::filesystem::rename internally.
 
<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>
 
</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.
</p>
<p>Attempts osrename first, then oscopy followed by osremove original.
</p>
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be moved.
</p>
<p><em>to_osfilename:</em> Will not overwrite an existing os file or dir.
</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.
 
<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>
 
</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.
</p>
<p><em>osfile_or_dirname:</em> Absolute or relative path and file or dir name to be copied.
</p>
<p><em>to_osfilename:</em> Will overwrite an existing os file or merge into an existing 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 is not writeable, permissions, storage space, etc.
</p>
Uses std::filesystem::copy internally with recursive and overwrite options
 
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
 
</td></tr>
<tr><td>if</td><td>osfilename.osremove()</td><td><p>Removes/deletes an os file from the OS file system.
</p>
<p>Will not remove directories. Use osrmdir() to remove directories
</p>
<p><em>osfilename:</em> Absolute or relative path and file name to be removed.
</p>
<em>Returns:</em> True if successful or false if not possible for any reason. e.g. Target doesnt exist, path is not writeable, permissions etc.
 
<pre><code class='hljs-ncdecl language-javascript'>let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
if (osfilename.osremove()) ... ok
// or
if (osremove(osfilename)) ...</code></pre>
 
</td></tr>
</table>
<h5 id=OS_Directories>OS Directories</h5>
 
<table class=wikitable>
<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.
</p>
<p><em>dirpath:</em> Absolute or relative dir path.
</p>
<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><em>mode:</em> 0: default - Any regular files or dirs. 1 - Only regular os files. 2 - Only dirs.
</p>
<em>Returns:</em> An FM delimited string containing all matching dir entries given a dir path
 
<pre><code class='hljs-ncdecl language-javascript'>var entries1 = "/etc/"_var.oslist("*.cfg"); /// e.g. "adduser.conf^ca-certificates.con^... etc."
// or
var entries2 = oslist("/etc/" "*.conf");</code></pre>
</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>osfile_or_dirpath.osinfo(mode = 0)</td><td><p>Get dir info about an os file or dir.
</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>
<p><em>mode:</em> 0: default. 1: Must be a regular os file. 2: Must be an os dir.
</p>
See also osfile() and osdir()
 
<pre><code class='hljs-ncdecl language-javascript'>var info1 = "/etc/hosts"_var.osinfo(); /// e.g. "221^20597^78309"_var
// or
var info2 = osinfo("/etc/hosts");</code></pre>
 
</td></tr>
<tr><td>var=</td><td>osfilename.osfile()</td><td><p>Get dir info of an os file.
</p>
<p><em>osfilename:</em> Absolute or relative path and file name.
</p>
<p><em>Returns:</em> A short string containing size ^ FM ^ modified_time ^ FM ^ modified_time or "" if not a regular file.
</p>
Alias for osinfo(1)
 
<pre><code class='hljs-ncdecl language-javascript'>var fileinfo1 = "/etc/hosts"_var.osfile(); /// e.g. "221^20597^78309"_var
// or
var fileinfo2 = osfile("/etc/hosts");</code></pre>
 
</td></tr>
<tr><td>var=</td><td>dirpath.osdir()</td><td><p>Get dir info of an os dir.
</p>
<p><em>dirpath:</em> Absolute or relative path and dir name.
</p>
<p><em>Returns:</em> A short string containing FM ^ modified_time ^ FM ^ modified_time or "" if not a dir.
</p>
Alias for osinfo(2)
 
<pre><code class='hljs-ncdecl language-javascript'>var dirinfo1 = "/etc/"_var.osdir(); /// e.g. "^20848^44464"_var
// or
var dirinfo2 = osfile("/etc/");</code></pre>
 
</td></tr>
<tr><td>if</td><td>dirpath.osmkdir()</td><td><p>Create a new os file system directory.
</p>
<p>Parent dirs wil be created if necessary.
</p>
<p><em>dirpath:</em> Absolute or relative path and dir name.
</p>
<em>Returns:</em> True if successful.
 
<pre><code class='hljs-ncdecl language-javascript'>let osdirname = "xo_test/aaa";
if (osrmdir("xo_test/aaa")) {}; // Cleanup first
if (osdirname.osmkdir()) ... ok
// or
if (osmkdir(osdirname)) ...</code></pre>
 
</td></tr>
<tr><td>if</td><td>var::oscwd(newpath)</td><td><p>Changes the current working dir.
</p>
<p><em>newpath:</em> An absolute or relative dir path and name.
</p>
<em>Returns:</em> True if successful or false if not. e.g. Invalid dirpath, insufficient permission etc.
 
<pre><code class='hljs-ncdecl language-javascript'>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.</code></pre>
 
</td></tr>
<tr><td>var=</td><td>var::oscwd()</td><td><p>Gets the current dir path and name.
</p>
<p><em>Returns:</em> The current working dir path and name.
</p>
e.g. "/root/exodus/cli/src/xo_test/aaa"
 
<pre><code class='hljs-ncdecl language-javascript'>var cwd1 = var().oscwd();
// or
var cwd2 = oscwd();</code></pre>
 
</td></tr>
<tr><td>if</td><td>dirpath.osrmdir(evenifnotempty = false)</td><td><p>Removes (deletes) an os dir,
</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>Returns:</em> Returns true if successful or false if not. e.g dir doesnt exist, insufficient permission, not empty etc.
 
<pre><code class='hljs-ncdecl language-javascript'>let osdirname = "xo_test/aaa";
if (osdirname.osrmdir()) ... ok
// or
if (osrmdir(osdirname)) ...</code></pre>
 
</td></tr>
</table>
<h5 id=OS_Shell/Environment>OS Shell/Environment</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>command.osshell()</td><td><p>Execute a shell command.
</p>
<p><em>command:</em> An executable command to be interpreted by the default os shell.
</p>
<p><em>Returns:</em> True if the process terminates with error status 0 and false otherwise.
</p>
Append "&>/dev/null" to the command to suppress terminal output.
 
<pre><code class='hljs-ncdecl language-javascript'>let cmd = "echo $HOME";
if (cmd.osshell()) ... ok
// or
if (osshell(cmd)) ... ok</code></pre>
 
</td></tr>
<tr><td>if</td><td>instr.osshellread(oscmd)</td><td><p>Same as osshell but captures and returns stdout
</p>
<p><em>Returns:</em> The stout of the shell command.
</p>
Append "2>&1" to the command to capture stderr/stdlog output as well.
 
<pre><code class='hljs-ncdecl language-javascript'>let cmd = "echo $HOME";
var text;
if (text.osshellread(cmd)) ... ok
 
// or capturing stdout but ignoring exit status
text = osshellread(cmd);</code></pre>
 
</td></tr>
<tr><td>if</td><td>outstr.osshellwrite(oscmd)</td><td><p>Same as osshell but provides stdin to the process
</p>
<p><em>Returns:</em> True if the process terminates with error status 0 and false otherwise.
</p>
Append "&> somefile" to the command to suppress and/or capture output.
 
<pre><code class='hljs-ncdecl language-javascript'>let outtext = "abc xyz";
if (outtext.osshellwrite("grep xyz")) ... ok
// or
if (osshellwrite(outtext, "grep xyz")) ... ok</code></pre>
 
</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/"
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var::ostempdir();
// or
let v2 = ostempdir();</code></pre>
 
</td></tr>
<tr><td>var=</td><td>var::ostempfile()</td><td><p>Create a temporary file
</p>
<em>Returns:</em> The name of new temporary file e.g. "/tmp/~exoEcLj3C"
 
<pre><code class='hljs-ncdecl language-javascript'>var temposfilename1 = var::ostempfile();
// or
var temposfilename2 = ostempfile();</code></pre>
 
</td></tr>
<tr><td></td><td>envvalue.ossetenv(envcode)</td><td><p>Set the value of an environment variable
</p>
<p><em>envcode:</em> The code of the env variable to set.
</p>
<em>envvalue:</em> The new value to set the env code to.
 
<pre><code class='hljs-ncdecl language-javascript'>let envcode = "EXO_ABC", envvalue = "XYZ";
envvalue.ossetenv(envcode);
// or
ossetenv(envcode, envvalue);</code></pre>
 
</td></tr>
<tr><td>if</td><td>envvalue.osgetenv(envcode)</td><td><p>Get the value of an environment variable.
</p>
<p><em>envcode:</em> The code of the env variable to get or "" for all.
</p>
<p><em>envvalue:</em> [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...
</p>
<p><em>Returns:</em> True if the envcode is set or false if not.
</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>
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.
 
<pre><code class='hljs-ncdecl language-javascript'>var envvalue1;
if (envvalue1.osgetenv("HOME")) ... ok // e.g. "/home/exodus"
// or
let envvalue2 = osgetenv("EXO_ABC"); // "XYZ"</code></pre>
 
</td></tr>
<tr><td>var=</td><td>var::ospid()</td><td><p>Get the current os process id
</p>
<em>Returns:</em> A number e.g. 663237.
 
<pre><code class='hljs-ncdecl language-javascript'>let pid1 = var::ospid(); /// e.g. 663237
// or
let pid2 = ospid();</code></pre>
 
</td></tr>
<tr><td>var=</td><td>var::ostid()</td><td><p>Get the current os thread process id
</p>
<em>Returns:</em> A number e.g. 663237.
 
<pre><code class='hljs-ncdecl language-javascript'>let tid1 = var::ostid(); /// e.g. 663237
// or
let tid2 = ostid();</code></pre>
 
</td></tr>
<tr><td>var=</td><td>var::version()</td><td><p>Get the exodus library version info.
</p>
<em>Returns:</em> The git commit details as at the time the library was built.
 
<pre><code class='hljs-ncdecl language-javascript'>// 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();</code></pre>
 
</td></tr>
<tr><td>if</td><td>strvar.setxlocale(newlocalecode)</td><td><p>Sets the current thread's default locale.
</p>
<p><em>strvar:</em> The new locale codepage code.
</p>
True if successful
 
<pre><code class='hljs-ncdecl language-javascript'>if (var::setxlocale("en_US.utf8")) ... ok
// or
if (setxlocale("en_US.utf8")) ... ok</code></pre>
 
</td></tr>
<tr><td>var=</td><td>var.getxlocale()</td><td><p>Gets the current thread's default locale.
</p>
<em>Returns:</em> A locale codepage code string.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var::getxlocale(); // "en_US.utf8"
// or
let v2 = getxlocale();</code></pre>
 
</td></tr>
</table>
<h5 id=Output>Output</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>expr</td><td>varstr.outputl(prefix = "")</td><td><p>Output to stdout with optional prefix.
</p>
<p>Appends an NL char.
</p>
<p>Is FLUSHED, not buffered.
</p>
The raw string bytes are output. No character or byte conversion is performed.
 
<pre><code class='hljs-ncdecl language-javascript'>"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.</code></pre>
 
</td></tr>
<tr><td>expr</td><td>varstr.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>varstr.outputt(prefix = "")</td><td> Same as outputl() but appends a tab char instead of an NL char and is BUFFERED, not flushed.</td></tr>
<tr><td>expr</td><td>varstr.logputl(prefix = "")</td><td><p>Output to stdlog with optional prefix.
</p>
<p>Appends an NL char.
</p>
<p>Is BUFFERED not flushed.
</p>
Any of the six types of field mark chars present are converted to their visible versions,
 
<pre><code class='hljs-ncdecl language-javascript'>"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.</code></pre>
 
</td></tr>
<tr><td>expr</td><td>varstr.logput(prefix = "")</td><td> Same as logputl() but doesnt append an NL char.</td></tr>
<tr><td>expr</td><td>varstr.errputl(prefix = "")</td><td><p>Output to stderr with optional prefix.
</p>
<p>Appends an NL char.
</p>
<p>Is FLUSHED not buffered.
</p>
Any of the six types of field mark chars present are converted to their visible versions,
 
<pre><code class='hljs-ncdecl language-javascript'>"abc"_var.errputl("xyz = "); /// Sends "xyz = abc\n" to stderr
// or
errputl("xyz = ", "abc"); /// Any number of arguments is allowed. All will be output.</code></pre>
 
</td></tr>
<tr><td>expr</td><td>varstr.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>varstr.put(std::ostream& ostream1)</td><td><p>Output to a given stream.
</p>
<p>Is BUFFERED not flushed.
</p>
<p>The raw string bytes are output. No character or byte conversion is performed.
</p>
</td></tr>
<tr><td></td><td>var().osflush()</td><td>Flush any and all buffered output to stdout and stdlog.
 
<pre><code class='hljs-ncdecl language-javascript'>var().osflush();
// or
osflush();</code></pre>
 
</td></tr>
</table>
<h5 id=Input>Input</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>var.input(prompt = "")</td><td><p>Returns one line of input from stdin.
</p>
<p><em>Returns:</em> True if successful or false if EOF or user pressed Esc or Ctrl+X in a terminal.
</p>
<p><em>var:</em> [in] The default value for terminal input and editing. Ignored if not a terminal.
</p>
<p><em>var:</em> [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 "".
</p>
<p><em>Prompt:</em> If provided, it will be displayed on the terminal.
</p>
Multibyte/UTF8 friendly.
 
<pre><code class='hljs-ncdecl language-javascript'>// var v1 = "defaultvalue";
// if (v1.input("Prompt:")) ... ok
// or
// var v2 = input();</code></pre>
 
</td></tr>
<tr><td>expr</td><td>var.inputn(nchars)</td><td><p>Get raw bytes from standard input.
</p>
<p>Any new line chars are treated like any other bytes.
</p>
<p>Care must be taken to handle incomplete UTF8 byte sequences at the end of one block and the beginning of the next block.
</p>
<p><em>Returns:</em> The requested number of bytes or fewer if not available.
</p>
<p><em>nchars:</em>
</p>
<p>99 : Get up to 99 bytes or fewer if not available. Caution required with UTF8.
</p>
<p>⋅0 : Get all bytes presently available.
</p>
<p>⋅1 : Same as keypressed(true). Deprecated.
</p>
<p>-1 : Same as keypressed(). Deprecated.
</p>
</td></tr>
<tr><td>expr</td><td>var.keypressed(wait = false)</td><td><p>Return the code of the current terminal key pressed.
</p>
<p><em>wait:</em> Defaults to false. True means wait for a key to be pressed if not already pressed.
</p>
<p><em>Returns:</em> ASCII or key code defined according to terminal protocol.
</p>
<p><em>Returns:</em> "" if stdin is not a terminal.
</p>
<p>e.g. The PgDn key if pressed might return an escape sequence like "\x1b[6~"
</p>
It only takes a few µsecs to return false if no key is pressed.
 
<pre><code class='hljs-ncdecl language-javascript'>var v1; v1.keypressed();
// or
var v2 = keypressed();</code></pre>
 
</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.
</p>
<p><em>arg:</em> 0 - stdin, 1 - stdout (Default), 2 - stderr.
</p>
<p><em>Returns:</em> True if it is a terminal or false if it is a file or pipe.
</p>
<p>Note that if the process is at the start or end of a pipeline, then only stdin or stdout will be a terminal.
</p>
The type of stdout terminal can be obtained from the TERM environment variable.
 
<pre><code class='hljs-ncdecl language-javascript'>var v1 = var().isterminal(); /// 1 or 0
// or
var v2 = isterminal();</code></pre>
 
</td></tr>
<tr><td>if</td><td>var().hasinput(milliseconds = 0)</td><td><p>Checks if stdin has any bytes available for input.
</p>
<p>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.
</p>
<p><em>Returns:</em> True if any bytes are available otherwise false.
</p>
<p>It only takes a few µsecs to return false if no bytes are available and no wait time has been requested.
</p>
</td></tr>
<tr><td>if</td><td>var().eof()</td><td><p>True if stdin is at end of file
</p>
</td></tr>
<tr><td>if</td><td>var().echo(on_off = true)</td><td><p>Sets terminal echo on or off.
</p>
<p>"On" causes all stdin data to be reflected to stdout if stdin is a terminal.
</p>
<p>Turning terminal echo off can be used to prevent display of confidential information.
</p>
<p><em>Returns:</em> True if successful.
</p>
</td></tr>
<tr><td></td><td>var().breakon()</td><td><p>Install various interrupt handlers.
</p>
<p>Automatically called in program/thread initialisation by exodus_main.
</p>
<p>SIGINT - Ctrl+C -> "Interrupted. (C)ontinue (Q)uit (B)acktrace (D)ebug (A)bort ?"
</p>
<p>SIGHUP - Sets a variable "RELOAD_req" which may be handled or ignored by the program.
</p>
<p>SIGTERM - Sets a variable "TERMINATE_req" which may be handled or ignored by the program.
</p>
</td></tr>
<tr><td></td><td>var().breakoff()</td><td><p>Disable keyboard interrupt.
</p>
<p>Ctrl+C becomes inactive in terminal.
</p>
</td></tr>
</table>
<h5 id=Math/Boolean>Math/Boolean</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>varnum.abs()</td><td>Absolute value
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = -12.34;
let v2 = v1.abs(); // 12.34
// or
let v3 = abs(v1);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.pwr(exponent)</td><td>Power
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(2).pwr(8); // 256
// or
let v2 = pwr(2, 8);</code></pre>
 
</td></tr>
<tr><td></td><td>varnum.initrnd()</td><td><p>Initialise the seed for rnd()
</p>
<p>Allows the stream of pseudo random numbers generated by rnd() to be reproduced.
</p>
Seeded from std::chrono::high_resolution_clock::now() if the argument is 0;
 
<pre><code class='hljs-ncdecl language-javascript'>var(123).initrnd(); /// Set seed to 123
// or
initrnd(123);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.rnd()</td><td><p>Pseudo random number generator
</p>
<p><em>Returns:</em> a pseudo random integer between 0 and the provided maximum minus 1.
</p>
Uses std::mt19937 and std::uniform_int_distribution<int>
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(100).rnd(); /// Random 0 to 99
// or
let v2 = rnd(100);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.exp()</td><td>Power of e
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(1).exp(); // 2.718281828459045
// or
let v2 = exp(1);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.sqrt()</td><td>Square root
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(100).sqrt(); // 10
// or
let v2 = sqrt(100);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.sin()</td><td>Sine of degrees
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(30).sin(); // 0.5
// or
let v2 = sin(30);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.cos()</td><td>Cosine of degrees
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(60).cos(); // 0.5
// or
let v2 = cos(60);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.tan()</td><td>Tangent of degrees
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(45).tan(); // 1
// or
let v2 = tan(45);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.atan()</td><td>Arctangent of degrees
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(1).atan(); // 45
// or
let v2 = atan(1);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.loge()</td><td><p>Natural logarithm
</p>
<em>Returns:</em> Floating point ver (double)
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(2.718281828459045).loge(); // 1
// or
let v2 = loge(2.718281828459045);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.integer()</td><td><p>Truncate decimal numbers towards zero
</p>
<em>Returns:</em> An integer var
 
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.floor()</td><td><p>Truncate decimal numbers towards negative
</p>
<em>Returns:</em> An integer var
 
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varnum.mod(modulus)</td><td><p>Modulus function
</p>
<p>Identical to C++ % operator only for positive numbers and modulus
</p>
<p>Negative denominators are considered as periodic with positiive numbers
</p>
<p>Result is between [0, modulus) if modulus is positive
</p>
<p>Result is between (modulus, 0] if modulus is negative (symmetric)
</p>
<p><em>Throws:</em> VarDivideByZero if modulus is zero.
</p>
Floating point works.
 
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
 
</td></tr>
<tr><td>int=</td><td>var::setprecision(newprecision)</td><td><p>Set the maximum floating point precision.
</p>
<p>This is the number of post-decimal point digits to consider for floating point comparison and implicit conversion to strings.
</p>
<p>The default precision is 4 which is 0.0001.
</p>
<p>NUMBERS AND DIFFERENCES SMALLER THAN 0.0001 ARE TREATED AS ZERO UNLESS PRECISION IS INCREASED.
</p>
<p><em>newprecision:</em> New precision between -307 and 308 inclusive.
</p>
<p><em>Returns:</em> The new precision if successful or the old precision if not.
</p>
<p>Not required if using common numbers or using the explicit rounding and formatting functions to convert numbers to strings.
</p>
<p>Increasing the precision allows comparing and outputting smaller numbers but creates errors handling large numbers.
</p>
<p>Setting precision inside a perform, execute or dictionary function lasts until termination of the function.
</p>
See cli/demo_precision for more info.
 
<pre><code class='hljs-ncdecl language-javascript'>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.</code></pre>
 
</td></tr>
<tr><td>int=</td><td>var::getprecision()</td><td>
<p><em>Returns:</em> The current precision setting.
</p>
See setprecision() for more info.
 
<pre><code class='hljs-ncdecl language-javascript'>let curr_precision1 = var::getprecision();
// or
let curr_precision2 = getprecision();</code></pre>
 
</td></tr>
</table>
<h4 id=I/O_Conversion_Codes_>I/O Conversion Codes </h4>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>vardate.oconv("D")</td><td><p>Date output: Convert internal date format to human readable date or calendar info in text format.
</p>
<p><em>Returns:</em> Human readable date or calendar info, or the original value unconverted if non-numeric.
</p>
<p><em>Flags:</em> See examples below.
</p>
Any Dynamic array structure is preserved.
 
<pre><code class='hljs-ncdecl language-javascript'>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"  ) ;</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varstr.iconv("D")</td><td><p>Date input: Convert human readable date to internal date format.
</p>
<p><em>Returns:</em> Internal date or "" if the input is an invalid date.
</p>
<p>Internal date format is whole days since 1967-12-31 00:00:00 which is day 0.
</p>
Any Dynamic array structure is preserved.
 
<pre><code class='hljs-ncdecl language-javascript'>// 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</code></pre>
 
</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".
</p>
<p><em>Returns:</em> Human readable time or the original value unconverted if non-numeric.
</p>
<p>Conversion code (e.g. "MTHS") is "MT" + flags ...
</p>
<p><em>Flags:</em>
</p>
<p>"H" - Show AM/PM otherwise 24 hour clock is used.
</p>
<p>"S" - Output seconds
</p>
<p>"2" = Ignored (used in iconv)
</p>
<p>":" - Any other flag is used as the separator char instead of ":"
</p>
Any Dynamic array structure is preserved.
 
<pre><code class='hljs-ncdecl language-javascript'>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"</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varstr.iconv("MT")</td><td><p>Time input: Convert human readable time (e.g. "10:30:59") to internal time format.
</p>
<p><em>Returns:</em> Internal time or "" if the input is an invalid time.
</p>
<p>Internal time format is whole seconds since midnight.
</p>
<p><em>Accepts:</em> Two or three groups of digits surrounded and separated by any non-digits char(s).
</p>
Any Dynamic array structure is preserved.
 
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
 
</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.
</p>
<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>Conversion code (e.g. "MD20") is "MD" or "MC", 1st digit, 2nd digit, flags ...
</p>
 
<p>MD outputs like 123.45 (International)
</p>
<p>MC outputs like 123,45 (European)
</p>
 
<p>1st digit = Decimal places to display. Also decimal places to move if 2nd digit not present and no P flag present.
</p>
<p>2nd digit = Optional decimal places to move left if P flag not present.
</p>
 
<p><em>Flags:</em>
</p>
<p>"P" - Preserve decimal places. Same as 2nd digit = 0;
</p>
<p>"Z" - Zero flag - return "" if zero.
</p>
<p>"X" - No conversion - return as is.
</p>
<p>"." or "," - Separate thousands depending on MD or MC.
</p>
<p>"-" means suffix negatives with "-" and positives with " " (space).
</p>
<p>"<" means wrap negatives in "<" and ">" chars.
</p>
<p>"C" means suffix negatives with "CR" and positives or zero with "DB".
</p>
<p>"D" means suffix negatives with "DB" and positives or zero with "CR".
</p>
 
Any Dynamic array structure is preserved.
 
<pre><code class='hljs-ncdecl language-javascript'>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"  </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.
</p>
<p>e.g. "L#10", "R#10", "C#10"
</p>
<p>Useful when outputting to terminal devices where spaces are used for alignment.
</p>
<p>Dynamic array structure is preserved.
</p>
ASCII only.
 
<pre><code class='hljs-ncdecl language-javascript'>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" </code></pre>
 
</td></tr>
<tr><td>var=</td><td>varstr.oconv("T")</td><td><p>Text folding and justification.
</p>
<p>e.g. T#20
</p>
<p>Useful when outputting to terminal devices where spaces are used for alignment.
</p>
<p>Splits text into multiple fixed length lines by inserting spaces and TM chars.
</p>
ASCII only.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "Have a nice day";
v2 =  v1.oconv("T#10") ; //  "Have a␣␣␣␣|nice day␣␣"_var
// or
v2 =  oconv(v1, "T#10") ; //  "Have a␣␣␣␣|nice day␣␣"_var </code></pre>
 
</td></tr>
<tr><td>expr</td><td>varnum.oconv("MR")</td><td><p>Character replacement
</p>
e.g. MRU
 
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varstr.oconv("HEX")</td><td><p>Convert the chars of a string to a string of pairs of hexadecimal digits.
</p>
<p><em>varstr:</em> A string. Numbers will be converted to strings for conversion. 1.2 -> "1.2" -> hex "312E32"
</p>
<p>Dynamic array structure is not preserved. Field marks are converted to HEX as for all other bytes.
</p>
<p>The size of the output is always precisely double that of the input.
</p>
This function is the exact inverse of iconv("HEX").
 
<pre><code class='hljs-ncdecl language-javascript'>// 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"</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varstr.iconv("HEX")</td><td><p>Convert a string of pairs of hexadecimal digits to a string of chars.
</p>
<p><em>varstr:</em> Must be a string of only hex digits 0-9, a-f or A-F.
</p>
<p><em>Returns:</em> A string if all input was hex digits otherwise "".
</p>
<p>Dynamic array structure is not preserved. Any field marks prevent conversion.
</p>
<p>This function is the exact inverse of oconv("HEX").
</p>
<p>After prefixing a "0" to an odd sized input, the size of the output is always precisely half that of the input.
</p>
</td></tr>
<tr><td>var=</td><td>varnum.oconv("MX")</td><td><p>Convert number to hexadecimal string.
</p>
<p>"MX":  Convert and trim leading zeros                      e.g. oconv(1025, "MX")  -> "401"
</p>
<p>"MXn":  Pad with up to n leading zeros but do not truncate. e.g. oconv(1025, "MX8") -> "00000401"
</p>
<p>"MXnT": Pad and truncate to n characters.                  e.g. oconv(1025, "MX2") -> "01"
</p>
<p>"n":    Width. 0-9, A-G = 10 - 16.
</p>
<p><em>varnum:</em> A number or dynamic array of numbers. Floating point numbers are rounded to integers before conversion.
</p>
<p><em>Returns:</em> A string of hexadecimal digits or a dynamic array of the same. Elements that are not numeric are left untouched and unconverted.
</p>
<p>Dynamic array structure is preserved.
</p>
<p>Negative numbers are treated as unsigned 8 byte integers (uint64).
</p>
<p>0  -> "00"
</p>
<p>1  -> "01"
</p>
<p>15 -> "0F"
</p>
<p>-1 -> "FFFF" "FFFF" "FFFF" "FFFF" (8 x "FF")
</p>
This function is a near inverse of iconv("MX").
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "14.5]QQ]65535"_var.oconv("MX"); // "F]QQ]FFFF"_var
// or
let v2 = oconv("14.5]QQ]65535"_var, "MX");</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varstr.iconv("MX")</td><td><p>Convert hexadecimal string to number.
</p>
<p><em>varstr:</em> A string or dynamic array of up to 16 hex digits: 0-9, a-f, A-F.
</p>
<p><em>Returns:</em> An integer or dynamic array of integers. Invalid elements are converted to "".
</p>
<p>Dynamic array structure is preserved.
</p>
<p>Hex strings are converted to unsigned 8 byte integers (uint64)
</p>
<p>Leading zeros are ignored.
</p>
<p>"0" -> 0
</p>
<p>"00"-> 0
</p>
<p>"1" -> 1
</p>
<p>Hex "FFFFFFFFFFFFFFFF" (8 x "FF") -> -1.
</p>
<p>Hex "7FFFFFFFFFFFFFFF" is the maximum positive integer: 9223372036854775805.
</p>
<p>Hex "8000000000000000" is the maximum negative integer: -9223372036854775808.
</p>
This function is the exact inverse of oconv("MX").
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "F]QQ]FFFF"_var.iconv("MX"); // "15]]65535"_var
// or
let v2 = iconv("F]QQ]FFFF", "MX");</code></pre>
 
</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
</p>
<em>varnum:</em> If not numeric then no conversion is performed and the original value is returned.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = var(255).oconv("MB"); // 1111'1111
// or
let v2 = oconv(255, "MB");</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varstr.oconv("TX")</td><td><p>Convert dynamic arrays to standard text format.
</p>
<p>Useful for using text editors on dynamic arrays.
</p>
<p>FMs -> \n after escaping any embedded NL
</p>
<p>VMs -> literal "\" \n
</p>
<p>SMs -> literal "\\" \n
</p>
etc.
 
<pre><code class='hljs-ncdecl language-javascript'>// 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"</code></pre>
 
</td></tr>
<tr><td>var=</td><td>varstr.iconv("TX")</td><td><p>Convert standard text format to dynamic array.
</p>
Reverse of oconv("TX") above.</td></tr>
</table>
 
</body>
</html>
</html>
 
<html>
<!DOCTYPE html>
<html>
<head>
</head>
<body>
 
 
<!-- 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>
<!-- done below <script>hljs.highlightAll();</script> -->
 
<style>
 
/* Change highlight.js comments from default grey to green */
.hljs-comment,
.hljs-quote {
color: #008000; /* This is green, you can adjust the shade as per your preference */
font-style: italic; /* Optional: You might want to keep comments italicized */
}
 
</style>
 
<script>
//// Extend C++ language definition
//const cppLanguage = hljs.getLanguage('cpp');
//if (cppLanguage) {
// // Adding custom keywords
// cppLanguage.keywords = {
// ...cppLanguage.keywords,
// keyword: cppLanguage.keywords.keyword + ' round chr textchr',
// // You can also add to other categories like 'literal', 'built_in', etc.
// };
// // Register the modified language
// hljs.registerLanguage('cpp', cppLanguage);
//}
 
// Initialize highlight.js
document.addEventListener('DOMContentLoaded', (event) => {
    hljs.highlightAll();
});
</script>
 
 
 
<!-- bootstrap css. Is this necessary? -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
 
<style>
 
body {
margin: 10px;
}
 
pre {
margin: 0px;
white-space: pre-wrap;
word-wrap: break-word;
white-space: -moz-pre-wrap;
white-space: -pre-wrap;
white-space: -o-pre-wrap;
overflow-wrap: break-word;
overflow-x: auto;
}
 
table, th, td {
border: 1px solid #a2a9b1;
}
 
th {
background-color: #eaecf0;
font-weight: bold;
text-align: left;
padding: 8px;
}
 
td {
padding: 0.2em 0.4em;
vertical-align: top;
}
 
p {
  margin: 0.4em 0 0.5em 0;
}
 
.toc, .toccolours {
border: 1px solid #a2a9b1;
background-color: #f8f9fa;
padding: 5px;
font-size: 95%;
}
.toc {
display: table;
padding: 7px;
}
 
.wikitable {
background-color: #f8f9fa;
color: #202122;
margin: 1em 0;
border: 1px solid #a2a9b1;
border-collapse: collapse;
}
    img {
        border: 0;
        vertical-align: middle
    }
 
    hr {
        height: 1px;
        background-color: #a2a9b1;
        border: 0;
        margin: 0.2em 0
    }
 
    h1,h2,h3,h4,h5,h6 {
        color: #000;
        margin: 0;
        padding-top: 0.5em;
        padding-bottom: 0.17em;
        overflow: hidden
    }
 
    h1,h2 {
        margin-bottom: 0.6em;
        border-bottom: 1px solid #a2a9b1
    }
 
    h3,h4,h5 {
        margin-bottom: 0.3em
    }
 
    h1 {
        font-size: 188%;
        font-weight: normal
    }
 
    h2 {
        font-size: 150%;
        font-weight: normal
    }
 
    h3 {
        font-size: 128%
    }
 
    h4 {
        font-size: 116%
    }
 
    h5 {
        font-size: 108%
    }
 
    h6 {
        font-size: 100%
    }
 
    p {
        margin: 0.4em 0 0.5em 0
    }
 
    p img {
        margin: 0
    }
 
    ul {
        margin: 0.3em 0 0 1.6em;
        padding: 0
    }
 
    ol {
        margin: 0.3em 0 0 3.2em;
        padding: 0;
        list-style-image: none
    }
 
    li {
        margin-bottom: 0.1em
    }
 
    dt {
        font-weight: bold;
        margin-bottom: 0.1em
    }
 
    dl {
        margin-top: 0.2em;
        margin-bottom: 0.5em
    }
 
    dd {
        margin-left: 1.6em;
        margin-bottom: 0.1em
    }
 
.gendoc_function {
    color: #800;
    font-weight: 700;
}
 
</style>
 
 
<div class=toc>
<h4>Contents:</h4>
<ol>
<li><a href=#Dim_>Dim </a></li>
<li><a href=#Dimensioned_Array_Construction_>Dimensioned Array Construction </a></li>
<li><a href=#Array_Access>Array Access</a></li>
<li><a href=#Array_Mutation>Array Mutation</a></li>
<li><a href=#Array_Conversion>Array Conversion</a></li>
<li><a href=#Array_DB_I/O>Array DB I/O</a></li>
<li><a href=#Array_OS_I/O>Array OS I/O</a></li>
 
</ol>
</div>
 
 
<h4 id=Dim_>Dim </h4>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
</table>
<h5 id=Dimensioned_Array_Construction_>Dimensioned Array Construction </h5>
 
<table class=wikitable>
<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.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1;</code></pre>
 
</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.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1(10);
dim d2(10, 3);</code></pre>
 
</td></tr>
<tr><td></td><td>dim d1 = d2; // Copy</td><td>Create a copy of an array.
 
<pre><code class='hljs-ncdecl language-javascript'> dim d1 = {2, 4, 6, 8};
dim d2 = d1;</code></pre>
 
</td></tr>
<tr><td></td><td>dim d1 = dim(); // Move</td><td><p>Save an array created elsewhere.
</p>
Uses C++ "move" semantics.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1 = "f1^f2^f3"_var.split();</code></pre>
 
</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.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1 = {1, 2, 3, 4, 5};
dim d2 = {"A", "B", "C"};</code></pre>
 
</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.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1(10);
d1 = "";</code></pre>
 
</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.
</p>
<p>Existing data will be retained as far as possible. Any additional elements are unassigned.
</p>
<p>Resizing rows to 0 clears all data.
</p>
Resizing cols to 0 clears all data and changes its status to "undimensioned".
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1;
d1.redim(10, 3);</code></pre>
 
</td></tr>
<tr><td></td><td>d1.swap(d2) </td><td><p>Swap one array with another.
</p>
Either or both may be undimensioned.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1(5);
dim d2(10);
d1.swap(d2);</code></pre>
 
</td></tr>
</table>
<h5 id=Array_Access>Array Access</h5>
 
<table class=wikitable>
<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
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1 = {1, 2, 3, 4, 5};
d1[3] = "X";
let v1 = d1[3]; // "X"</code></pre>
 
</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
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1(10, 5);
d1 = "";
d1[3, 4] = "X";
let v1 = d1[3, 4]; // "X"</code></pre>
 
</td></tr>
<tr><td>var=</td><td>d1.rows()</td><td><p>Get the number of rows in the dimensioned array
</p>
<em>Returns:</em> A count. Can be zero, indicating an empty array.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1(5,3);
let v1 = d1.rows(); // 5</code></pre>
 
</td></tr>
<tr><td>var=</td><td>d1.cols()</td><td><p>Get the number of columns in the dimensioned array
</p>
<em>Returns:</em> A count.  0 if the array is undimensioned.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1(5,3);
let v1 = d1.cols(); // 3</code></pre>
 
</td></tr>
<tr><td>var=</td><td>d1.join(delimiter = FM)</td><td><p>Joins all elements into a single delimited string
</p>
<p><em>delimiter:</em> Default is FM.
</p>
<em>Returns:</em> A string var.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1 = {"f1", "f2", "f3"};
let v1 = d1.join(); // "f1^f2^f3"_var</code></pre>
 
</td></tr>
</table>
<h5 id=Array_Mutation>Array Mutation</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td></td><td>d1.splitter(str1, delimiter = FM)</td><td><p>Creates or updates the array from a given string.
</p>
<p>If the dim array is undimensioned it will be dimensioned with the number of elements that the string has fields.
</p>
<p>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.
</p>
<p>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.
</p>
Using undimensioned arrays allows the efficient handling of arrays with a very variable number of elements. e.g. os text files.
 
<pre><code class='hljs-ncdecl language-javascript'>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 ""</code></pre>
 
</td></tr>
<tr><td></td><td>d1.sorter(reverse = false)</td><td><p>Sort the elements of the array in place.
</p>
<em>reverse:</em> Defaults to false. If true, then the order is reversed.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1 = "2,20,10,1"_var.split(",");
d1.sorter();
let v1 = d1.join(","); // "1,2,10,20"_var</code></pre>
 
</td></tr>
<tr><td></td><td>d1.reverser()</td><td>Reverse the elements of the array in place.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1 = "2,20,10,1"_var.split(",");
d1.reverser();
let v1 = d1.join(","); // "1,10,20,2"_var</code></pre>
 
</td></tr>
<tr><td></td><td>d1.shuffler()</td><td>Randomly shuffle the order of the elements of the array in place.
 
<pre><code class='hljs-ncdecl language-javascript'>dim d1 = "2,20,10,1"_var.split(",");
d1.shuffler();
let v1 = d1.join(","); // random</code></pre>
 
</td></tr>
</table>
<h5 id=Array_Conversion>Array Conversion</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>dim=</td><td>d1.sort(reverse = false)</td><td>Same as sorter() but returns a new array leaving the original untouched.</td></tr>
<tr><td>dim=</td><td>d1.reverse()</td><td>Same as reverser() but returns a new array leaving the original untouched.</td></tr>
<tr><td>dim=</td><td>d1.shuffle()</td><td>Same as shuffler() but returns a new array leaving the original untouched.</td></tr>
</table>
<h5 id=Array_DB_I/O>Array DB I/O</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td></td><td>d1.write(dbfile, key)</td><td><p>Writes a db file record created from an array.
</p>
Each element in the array becomes a separate field in the db record. Any redundant trailing FMs are suppressed.
 
<pre><code class='hljs-ncdecl language-javascript'>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);</code></pre>
 
</td></tr>
<tr><td>if</td><td>d1.read(dbfile, key)</td><td><p>Read a db file record into an array.
</p>
<p>Each field in the database record becomes a single element in the array.
</p>
<p><em>Returns:</em> True if the record exists or false if not,
</p>
<p>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.
</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.
 
<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>
 
</td></tr>
</table>
<h5 id=Array_OS_I/O>Array OS I/O</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>d1.oswrite(osfilename, codepage = "")</td><td><p>Creates an entire os text file from an array
</p>
<p>Each element of the array becomes one line in the os file delimited by \n
</p>
<p>Any existing os file is overwritten and replaced.
</p>
<p><em>codepage:</em> Optional: Data is converted from UTF8 to the required codepage/encoding before output. If the conversion cannot be performed then return false.
</p>
<em>Returns:</em> True if successful or false if not.
 
<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>
 
</td></tr>
<tr><td>if</td><td>d1.osread(osfilename, codepage = "")</td><td><p>Read an entire os text file into an array.
</p>
<p>Each line in the os file, delimited by \n or \r\n, becomes a separate element in the array.
</p>
<p>Existing data in the array is lost and the array is redimensioned to the number of lines in the input data.
</p>
<p><em>codepage:</em> Optional. Data will be converted from the specified codepage/encoding to UTF8 after being read. If the conversion cannot be performed then return false.
</p>
<p><em>Returns:</em> True if successful or false if not.
</p>
If the first \n in the file is \r\n then the whole file will be split using \r\n as delimiter.
 
<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>
 
</td></tr>
</table>
 
</body>
</html>
</html>
 
<html>
<!DOCTYPE html>
<html>
<head>
</head>
<body>
 
 
<!-- 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>
<!-- done below <script>hljs.highlightAll();</script> -->
 
<style>
 
/* Change highlight.js comments from default grey to green */
.hljs-comment,
.hljs-quote {
color: #008000; /* This is green, you can adjust the shade as per your preference */
font-style: italic; /* Optional: You might want to keep comments italicized */
}
 
</style>
 
<script>
//// Extend C++ language definition
//const cppLanguage = hljs.getLanguage('cpp');
//if (cppLanguage) {
// // Adding custom keywords
// cppLanguage.keywords = {
// ...cppLanguage.keywords,
// keyword: cppLanguage.keywords.keyword + ' round chr textchr',
// // You can also add to other categories like 'literal', 'built_in', etc.
// };
// // Register the modified language
// hljs.registerLanguage('cpp', cppLanguage);
//}
 
// Initialize highlight.js
document.addEventListener('DOMContentLoaded', (event) => {
    hljs.highlightAll();
});
</script>
 
 
 
<!-- bootstrap css. Is this necessary? -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
 
<style>
 
body {
margin: 10px;
}
 
pre {
margin: 0px;
white-space: pre-wrap;
word-wrap: break-word;
white-space: -moz-pre-wrap;
white-space: -pre-wrap;
white-space: -o-pre-wrap;
overflow-wrap: break-word;
overflow-x: auto;
}
 
table, th, td {
border: 1px solid #a2a9b1;
}
 
th {
background-color: #eaecf0;
font-weight: bold;
text-align: left;
padding: 8px;
}
 
td {
padding: 0.2em 0.4em;
vertical-align: top;
}
 
p {
  margin: 0.4em 0 0.5em 0;
}
 
.toc, .toccolours {
border: 1px solid #a2a9b1;
background-color: #f8f9fa;
padding: 5px;
font-size: 95%;
}
.toc {
display: table;
padding: 7px;
}
 
.wikitable {
background-color: #f8f9fa;
color: #202122;
margin: 1em 0;
border: 1px solid #a2a9b1;
border-collapse: collapse;
}
    img {
        border: 0;
        vertical-align: middle
    }
 
    hr {
        height: 1px;
        background-color: #a2a9b1;
        border: 0;
        margin: 0.2em 0
    }
 
    h1,h2,h3,h4,h5,h6 {
        color: #000;
        margin: 0;
        padding-top: 0.5em;
        padding-bottom: 0.17em;
        overflow: hidden
    }
 
    h1,h2 {
        margin-bottom: 0.6em;
        border-bottom: 1px solid #a2a9b1
    }
 
    h3,h4,h5 {
        margin-bottom: 0.3em
    }
 
    h1 {
        font-size: 188%;
        font-weight: normal
    }
 
    h2 {
        font-size: 150%;
        font-weight: normal
    }
 
    h3 {
        font-size: 128%
    }
 
    h4 {
        font-size: 116%
    }
 
    h5 {
        font-size: 108%
    }
 
    h6 {
        font-size: 100%
    }
 
    p {
        margin: 0.4em 0 0.5em 0
    }
 
    p img {
        margin: 0
    }
 
    ul {
        margin: 0.3em 0 0 1.6em;
        padding: 0
    }
 
    ol {
        margin: 0.3em 0 0 3.2em;
        padding: 0;
        list-style-image: none
    }
 
    li {
        margin-bottom: 0.1em
    }
 
    dt {
        font-weight: bold;
        margin-bottom: 0.1em
    }
 
    dl {
        margin-top: 0.2em;
        margin-bottom: 0.5em
    }
 
    dd {
        margin-left: 1.6em;
        margin-bottom: 0.1em
    }
 
.gendoc_function {
    color: #800;
    font-weight: 700;
}
 
</style>
 
 
<div class=toc>
<h4>Contents:</h4>
<ol>
<li><a href=#Exodus_Program>Exodus Program</a></li>
<li><a href=#Select_Lists>Select Lists</a></li>
<li><a href=#Perform/Execute>Perform/Execute</a></li>
<li><a href=#Program_Termination_>Program Termination </a></li>
<li><a href=#DB_File_Dictionaries>DB File Dictionaries</a></li>
<li><a href=#I/O_Conversion>I/O Conversion</a></li>
<li><a href=#Ioconv_Date/Time_>Ioconv Date/Time </a></li>
<li><a href=#Time/Date_Utilities>Time/Date Utilities</a></li>
<li><a href=#Terminal_I/O_Utilities>Terminal I/O Utilities</a></li>
<li><a href=#Array_Utilities>Array Utilities</a></li>
<li><a href=#Record_Locking>Record Locking</a></li>
 
</ol>
</div>
 
 
<h4 id=Exodus_Program>Exodus Program</h4>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
</table>
<h5 id=Select_Lists>Select Lists</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>if</td><td>select(sortselectclause_or_filehandle = "")</td><td><p>Create an active select list using a natural language sort/select command.
</p>
<p>This and all the following exoprog member functions work on an environment variable CURSOR.
</p>
<p>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.
</p>
<p><em>Returns:</em> True if an active select list was created, false otherwise.
</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.
 
<pre><code class='hljs-ncdecl language-javascript'>select("xo_clients by name by type with type 'A' 'B' and with balance between 0 and 2000");
if (readnext(ID)) ... ok</code></pre>
 
</td></tr>
<tr><td>if</td><td>selectkeys(keys)</td><td>Create an active select list from some given keys.
 
<pre><code class='hljs-ncdecl language-javascript'>selectkeys("SB001^JB001^JB002"_var);
if (readnext(ID)) ... ok // ID -> "SB001"</code></pre>
 
</td></tr>
<tr><td>if</td><td>hasnext()</td><td>Check if a select list is active.
 
<pre><code class='hljs-ncdecl language-javascript'>if (hasnext()) ... ok</code></pre>
 
</td></tr>
<tr><td>if</td><td>readnext(out key)</td><td><p>Get the next key from an active select list.
</p>
<p><em>key:</em> [out] A string. Typically the key of a db file record.
</p>
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
 
<pre><code class='hljs-ncdecl language-javascript'>selectkeys("SB001^JB001^JB002"_var);
if (readnext(ID)) ... ok // ID -> "SB001"</code></pre>
 
</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.
</p>
<p><em>key:</em> [out] A string. Typically the key of a db file record.
</p>
<p><em>valueno:</em> [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.
</p>
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
 
<pre><code class='hljs-ncdecl language-javascript'>selectkeys("SB001]2^SB001]1^JB001]2"_var);
if (readnext(ID, MV)) ... ok // ID -> "SB001" // MV -> 2</code></pre>
 
</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.
</p>
<p><em>record:</em> [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.
</p>
<p><em>key:</em> [out] A string. Typically the key of a db file record.
</p>
<p><em>valueno:</em> [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.
</p>
<em>Returns:</em> True if an active select list was available and the next key in the list was obtained.
 
<pre><code class='hljs-ncdecl language-javascript'>select("xo_clients by name (R)");
if (readnext(RECORD, ID, MV)) ... ok;
assert(not RECORD.empty());</code></pre>
 
</td></tr>
<tr><td></td><td>pushselect(out cursor)</td><td><p>Saves a pointer to the currently active select list.
</p>
<p>This allows another select list to be activated and used temporarily before the original select list is reactivated.
</p>
<em>cursor:</em> [out] A var that can be passed later on to the popselect() function to reactivate the saved list.
 
<pre><code class='hljs-ncdecl language-javascript'>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.</code></pre>
 
</td></tr>
<tr><td></td><td>popselect(cursor)</td><td><p>Re-establish an active select list saved by pushselect().
</p>
<p><em>cursor:</em> A var created by the pushselect() function.
</p>
See pushselect() for more info.</td></tr>
<tr><td></td><td>clearselect()</td><td><p>Deactivate an active select list.
</p>
If no select list is active then nothing is done.
 
<pre><code class='hljs-ncdecl language-javascript'>clearselect();</code></pre>
 
</td></tr>
<tr><td>if</td><td>deleterecord(filename)</td><td><p>Use an active select list to delete db records.
</p>
<p><em>Returns:</em> False if any records could not be deleted.
</p>
Contrast this function with the two argument "deleterecord(file, key)" function that deletes a single record.
 
<pre><code class='hljs-ncdecl language-javascript'>if (select("xo_clients with type 'Q' and with balance between 0 and 100")) {
  if (deleterecord("xo_clients")) ...
}</code></pre>
 
</td></tr>
<tr><td>if</td><td>deleterecord(dbfile, key)</td><td>Delete a single database file record.
 
<pre><code class='hljs-ncdecl language-javascript'>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)) ...</code></pre>
 
</td></tr>
<tr><td>if</td><td>savelist(listname)</td><td><p>Save a currently active select list under a given name.
</p>
<p>After saving, the list is no longer active and hasnext() will return false.
</p>
<p><em>Returns:</em> True if an active select list was saved, false if there was no active select list.
</p>
Lists are saved as a record in the "lists" file.
 
<pre><code class='hljs-ncdecl language-javascript'>selectkeys("SB001^SB002"_var);
if (not savelist("my_list")) ...</code></pre>
 
</td></tr>
<tr><td>if</td><td>getlist(listname)</td><td><p>Reactivate a saved select list of a given name.
</p>
<p>A saved list is obtained from the "lists" file and activated.
</p>
<em>Returns:</em> True if an active select list was successfully reactivated, otherwise false.
 
<pre><code class='hljs-ncdecl language-javascript'>if (not getlist("my_list")) ...</code></pre>
 
</td></tr>
<tr><td>if</td><td>deletelist(listname)</td><td><p>Remove a saved select list by name.
</p>
A saved list is deleted from the "lists" file.
 
<pre><code class='hljs-ncdecl language-javascript'>if (not deletelist("my_list")) ...</code></pre>
 
</td></tr>
</table>
<h5 id=Perform/Execute>Perform/Execute</h5>
 
<table class=wikitable>
<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.
</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>
<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>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>
<p>SENTENCE, COMMAND, OPTIONS: Initialised from the argument "command_line".
</p>
<p>RECUR0, RECUR1, RECUR2, RECUR3, RECUR4 to "".
</p>
<p>ID, RECORD, MV, DICT initialised to "".
</p>
<p>LEVEL is incremented by one.
</p>
<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>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>
<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>
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>
<tr><td>var=</td><td>execute(command_line)</td><td><p>Run an exodus program/library's main function.
</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>
<tr><td></td><td>chain(command_line)</td><td><p>Run an exodus program/library's main function after closing the current program.
</p>
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>
</table>
<h5 id=Program_Termination_>Program Termination </h5>
 
<table class=wikitable>
<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.
</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.
</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>
<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>
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>
<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.
</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>
<tr><td></td><td>logoff(message = "")</td><td></td></tr>
</table>
<h5 id=DB_File_Dictionaries>DB File Dictionaries</h5>
 
<table class=wikitable>
<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
</p>
called dict+DICT function dictid not const so we can mess with the library?</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>
<h5 id=I/O_Conversion>I/O Conversion</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>oconv(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>
<tr><td>var=</td><td>iconv(input, conversion)</td><td></td></tr>
</table>
<h5 id=Ioconv_Date/Time_>Ioconv Date/Time </h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>iconv|oconv(var, "[DATE]")</td><td><p>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.
</p>
 
<p><em>var:</em> [oconv] An internal date (a number).
</p>
<p><em>Returns:</em> [oconv] A readable date in text format depending on "[DATE,args]" e.g. "31 DEC 2020" "31/12/2020" "12/31/2020"
</p>
<p><em>var:</em> [iconv] A date in text format as above.
</p>
<p><em>Returns:</em> [iconv] An internal date (a number) or "" if the input could not be understood as a valid date.
</p>
<p><em>args:</em> 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.
</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]");'.
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = iconv("JAN 9 2020", "D");
assert(oconv(v1, "[DATE]"  ) == " 9/ 1/2020");  // "D/EZ" or "[DATE,D]" equivalent assuming D/E in DATEFMT (replace leading zeros with spaces)
assert(oconv(v1, "[DATE,4]" ) == " 9/ 1/2020");  // "D4Z"  equivalent assuming D/E in DATEFMT (replace leading zeros with spaces)
assert(oconv(v1, "[DATE,*4]") == "9/1/2020");    // "D4ZZ" equivalent assuming D/E in DATEFMT (trim leading zeros and spaces)
assert(oconv(v1, "[DATE,*]" ) == "9/1/20");      // "DZZ"  equivalent assuming D/E in DATEFMT (trim leading zeros and spaces)</code></pre>
 
</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.
</p>
<p>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.
</p>
<p>Primarily used for oconv() but can be used in reverse for iconv.
</p>
<p><em>var:</em> A number with an optional currency code or unit suffix. e.g. "12345.67USD"
</p>
<p><em>Returns:</em> A formatted number with thousands separated conventionally e.g. "12.345.67USD".
</p>
<p>iconv/oconv("[NUMBER]")      oconv leaves ndecimals untouched as in the input. iconv see below.
</p>
<p>iconv/oconv("[NUMBER,2]")    Specified number of decimal places
</p>
<p>iconv/oconv("[NUMBER,BASE]") Decimal places as per BASEFMT
</p>
<p>iconv/oconv("[NUMBER,*]")    Leave decimal places untouched as in the input
</p>
<p>iconv/oconv("[NUMBER,X]")    Leave decimal places untouched as in the input
</p>
<p>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.
</p>
 
<p>Empty input "" gives empty output "".
</p>
 
<p>All leading, trailing and internal spaces are removed from the input.
</p>
 
<p>A trailing currency or unit code is ignored and returned on output.
</p>
 
<p>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.
</p>
 
<p>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.
</p>
 
<p>iconv removes and oconv adds thousand separator chars. The thousands separator is  "," if BASEFMT starts with "MD" or "." if it starts with "MC".
</p>
 
<p><em>oconv:</em>
</p>
 
<p>Add thousands separator chars and optionally standardise the number of decimal places.
</p>
 
<p>Multiple numbers in fields, values, subvalues etc. can be processed in one string.
</p>
 
<p>Any leading + character is preserved on output.
</p>
 
<p>Z suppresses zeros and returns empty string "" instead.
</p>
 
<p>Special format "[NUMBER,ndecs,move_ndecs]": move_ndecs causes decimal point to be shifted left if positive or right if negative.
 
<pre><code class='hljs-ncdecl language-javascript'>var v1 = oconv("1234.5USD", "[NUMBER,2]"); // "1,234.50USD" // Comma added and decimal places corrected.</code></pre>
 
 
</p>
<p><em>iconv:</em>
</p>
 
<p>Remove all thousands separator chars and optionally standardise the number of decimal places.
</p>
 
<p>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.
</p>
 
<p>iconv only handles a single field/value.
</p>
 
Optional prefix of "1/" or "/" causes the reciprocal of the number to be used. e.g. "1/100" or "/100" -> "0.01".
 
<pre><code class='hljs-ncdecl language-javascript'>var v1 = iconv("1,234.5678USD", "[NUMBER]"); // "1234.57USD" // Comma removed</code></pre>
 
</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.
</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>
<tr><td>var=</td><td>amountunit(input0)</td><td></td></tr>
</table>
<h5 id=Time/Date_Utilities>Time/Date Utilities</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>timedate2()</td><td>
<p><em>Returns:</em> Text of date and time in users time zone
</p>
<p>e.g. "2MAR2025 11:52AM"
</p>
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>
<p><em>Returns:</em> User, server and UTC date and time
</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>
<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>
</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.
 
<pre><code class='hljs-ncdecl language-javascript'>var v1 = elapsedtimetext(); // e.g. "< 1ms"</code></pre>
 
</td></tr>
<tr><td>var=</td><td>elapsedtimetext(timestamp1, timestamp2)</td><td>Get text of elapsed time between two timestamps
 
<pre><code class='hljs-ncdecl language-javascript'>let v1 = elapsedtimetext(0, 0.55);  // "13 hours, 12 mins"
let v2 = elapsedtimetext(0, 0.001); // "1 min, 26 secs"</code></pre>
 
</td></tr>
</table>
<h5 id=Terminal_I/O_Utilities>Terminal I/O Utilities</h5>
 
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td></td><td>note(msg, options, io response)</td><td><p>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.
</p>
<em>options:</em> R = Response requested. C upper case response.
 
<pre><code class='hljs-ncdecl language-javascript'>var response;
// call note("Enter something", "RC", response);</code></pre>
 
</td></tr>
<tr><td></td><td>note(msg)</td><td>Output a message to stdin and continue.
 
<pre><code class='hljs-ncdecl language-javascript'>call note("Hello world.");</code></pre>
 
</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.
</p>
<em>Returns:</em> The chosen option (value not number) or "" if the user cancelled.</td></tr>
<tr><td>var=</td><td>decide(question, options, out reply, defaultreply = 1)</td><td><p>Same as decide() above but extended.
</p>
<p><em>defaultreply:</em> A default option if the user presses Enter.
</p>
<em>reply:</em> [out] The option number that the user chose or "" if they cancelled.</td></tr>
<tr><td>if</td><td>esctoexit()</td><td><p>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.
</p>
<em>Returns:</em> 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.</td></tr>
<tr><td>var=</td><td>AT(code)</td><td><p>Get a string to control terminal operation.
</p>
<p><em>Returns:</em> A string to be output to the terminal in order to accomplish the desired operation.
</p>
<p>The terminal protocol is xterminal.
</p>
<p><em>code:</em>
</p>
<p>n  Position the cursor at column number n
</p>
<p>0  Position the cursor at column number 0
</p>
<p>-1  Clear the screen and home the cursor
</p>
<p>-2  Position the cursor at the top left home (x,y = 0,0)
</p>
<p>-3  Clear from the cursor at the end of screen
</p>
<p>-4  Clear from cursor to end of line
</p>
-40 Position the cursor at columnno 0 and clear to end of line</td></tr>
<tr><td>var=</td><td>AT(x, y)</td><td><p>Get a terminal cursor positioning string.
</p>
<p><em>Returns:</em> A string to be output to the terminal to position the cursor at the desired screen x and y position.
</p>
The terminal protocol is xterminal.</td></tr>
<tr><td>if</td><td>getcursor(out cursor, delayms = 3000, max_errors = 0)</td><td><p>Get the position of the terminal cursor.
</p>
<p><em>cursor:</em> [out] If stdin is a terminal, an FM delimited string containing the x and y coordinates of the current terminal cursor.
</p>
<p>If stdin is not a terminatl then an empty string "" is returned.
</p>
<p>The cursor additionally contains a third field which contains the delay in ms from the terminal.
</p>
<p>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.
</p>
<p><em>delayms:</em> Default 3000ms. The maximum time to wait for terminal response.
</p>
<p><em>max_errors:</em> 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().
</p>
<p>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:
</p>
<p>TIMEOUT - The terminal failed to respond within the timeout.
</p>
<p>READ_ERROR - Failed to read terminal response.
</p>
<p>INVALID_RESPONSE - Terminal response invalid.
</p>
<p>SETUP_ERROR - Terminal setup failed.
</p>
DISABLED - Terminal is disabled due to more errors than the maximum currently set.
 
<pre><code class='hljs-ncdecl language-javascript'>var cursor;
if (isterminal() and not getcursor(cursor)) ... // cursor becomes something like "0^20^0.012345"_var</code></pre>
 
</td></tr>
</td></tr>
<tr><td>var=</td><td>getcursor()</td><td><p>Get the position of the terminal cursor.
<tr><td><p><code>if</code></p></td><td><p><code>unlockrecord(filename, io file, key)</code></p></td><td>
</p>
For more info see the main getcursor() function above.
 
<pre><code class='hljs-ncdecl language-javascript'>let cursor = getcursor(); // If isterminal() then cursor becomes something like "0^20^0.012345"_var</code></pre>
 
</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><p><code>if</code></p></td><td><p><code>unlockrecord()</code></p></td><td>
</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().
 
<pre><code class='hljs-ncdecl language-javascript'>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
}</code></pre>
</td></tr>
</td></tr>
</table>
</table>
<h5 id=Array_Utilities>Array Utilities</h5>
<table class=wikitable>
<tr> <th>Use</th> <th>Function</th> <th>Description</th> </tr>
<tr><td>var=</td><td>invertarray(input, pad = false)</td><td><p>Dynamic array fields become values and vice versa
</p>
<p><em>Returns:</em> The inverted dynamic array.
</p>
<em>pad:</em> If true then on return, all fields will have the same number of values with superfluous trailing VMs where necessary.
<pre><code class='hljs-ncdecl language-javascript'>let v1 = "a]b]c^1]2]3"_var;
let v2 = invertarray(v1); // "a]1^b]2^c]3"_var</code></pre>
</td></tr>
<tr><td></td><td>sortarray(io array, fns = "", order = "")</td><td><p>Sorts fields of multivalues of dynamic arrays in parallel
</p>
<p><em>fns:</em> VM separated list of field numbers to sort in parallel based on the first field number
</p>
<p><em>order:</em>
</p>
<p>AL Ascending  - Left Justified  - Alphabetic
</p>
<p>DL Descending - Left Justfiied  - Alphabetic
</p>
<p>AR Ascending  - Right Justified - Numeric
</p>
DR Descending - Right Justified - Numeric
<pre><code class='hljs-ncdecl language-javascript'>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</code></pre>


</td></tr>
</table>
<h5 id=Record_Locking>Record Locking</h5>


<table class=wikitable>
<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)</td><td></td></tr>
<tr><td>if</td><td>unlockrecord(filename, io file, key)</td><td></td></tr>
<tr><td>if</td><td>unlockrecord()</td><td></td></tr>
</table>


</body>
</body>
</html>
</html>
</html>

Latest revision as of 16:48, 20 April 2025

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

if

v1.assigned()

Check if a var has been assigned a value.

return: True if the var is assigned, otherwise false

if

v1.unassigned()

Check if a var has not been assigned a value;

return: True if the var is unassigned, otherwise false

var=

v2.or_default(defaultvalue)

Copy a var or, if it is unassigned, copy a default value.

return: 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 a var is unassigned, assign a default value.

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()

Move a var into another.

Shallow copy of var data and take ownership of the moved var's string if any. 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()

Return 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 (nan is true, 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

if

v1.isnum()

Check if a var is numeric.

return: 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()

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

Allow working numerically with data that may be non-numeric.

return: A guaranteed numeric var

var v1 = "123.45"_var.num();    // 123.45
var v2 = "abc"_var.num() + 100; // 100

var=

v2 + v3

Addition

Any attempt 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 - v3

Subtraction

var=

v2 * v3

Multiplication

var=

v2 / v3

Division

var=

v2 % v3

Modulus

v1 += v2

Self addition

var v1 = 0.1;
v1 += 0.2; // 0.3

v1 -= v2

Self subtraction

v1 *= v2

Self multiplication

v1 /= v2

Self division

v1 %= v2

Self 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

++ v1

Pre increment

var v1 = 3;
var v2 = ++ v1; // v2 -> 4 // v1 -> 4

-- v1

Pre decrement

var v1 = 3;
var v2 = -- v1; // v2 -> 2 // v1 -> 2

Dynamic Array Creation, Access And Update
Use Function Description

var=

""_var

Literal suffix "_var".

Allow dynamic arrays to be seamlessly embedded in code using a predefined set of visible equivalents of unprintable field mark characters as follows:

Visible equivalents:

`
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 list

Code a dynamic array var as as 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 ^= v2

String self concatention ^= (append)

var v1 = "aa";
v1 ^= 22; // v1 -> "aa22"

var=

varnum.round(ndecimals = 0)

Round a number.

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.

return: 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.

num: An integer 0-255.

return: 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.

num: A Unicode Code Point (Number)

return: 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.

return: 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

return: A string

let v1 = "ab"_var.str(3); // "ababab"
// or
let v2 = str("ab", 3);

var=

var::space(nspaces)

Get a string as a given number of spaces.

nspaces: The number of spaces required.

return: A string of space chars.

let v1 = var::space(3); // "␣␣␣"
// or
let v2 = space(3);

var=

varnum.numberinwords(locale = "")

Get a number written out in words insteads of digits.

return: A string.

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.

return: 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.

return: 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.

return: 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.

return: A number

let v1 = "abc"_var.len(); // 3
// or
let v2 = len("abc");

if

strvar.empty()

Check if the var is an empty string.

return: 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.

return: A number

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

Reduce 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.

return: 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.

return: 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.

return: 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", "*");

if

strvar.starts(prefix)

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

prefix: The substr to check for.

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

Always returns false if suffix is "". DIFFERS from c++, javascript, python3. See contains() for more info.

if ("abc"_var.starts("ab")) ... true
// or
if (starts("abc", "ab")) ... true

if

strvar.ends(suffix)

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

suffix: The substr to check for.

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

Always 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

if

strvar.contains(substr)

Check if a given substr exists in a source string.

substr: The substr to check for.

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

Always returns false if substr is "". DIFFERS from c++, javascript, python3. See contains() for more info.

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.

return: 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.

return: 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

Start at the end and work backwards.

substr: The string to search for.

return: 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 = "")

Find all matches of a given regular expression.

return: 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.

return: 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)

return: 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.

return: 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.

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

return: The source string standardised in a way to enable consistent indexing and searching,

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.

return: 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.

return: 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.

return: 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.

return: 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.

return: 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.

return: 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.
-1
Insert on or before the last char after removing up to length chars starting with the last char.
-2
Ditto on or before the penultimate char.
> strlen
If pos1 > length of the source string, insert after the last 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)

Copy one or more consecutive fields from a string.

delimiter: A Unicode character.

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

return: 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.

return: 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.

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

return: 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.

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

return: 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.

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

return: 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.

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

return: 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 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.

Allow 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.
let v1 = R"(--\0x3B--\0x2F--)";                                 // Hex escape codes.
let v2 = v1.replace(
    R"(\\0x[0-9a-fA-F]{2,2})"_rex,                              // Find \0xFF.
    [](auto match_str) {return match_str.cut(3).iconv("HEX");}  // Decode to a char.
);
assert(v2 == "--;--/--");

// Reformat dates using groups.
let v3 = "Date: 03-15-2025";
let v4 = v3.replace(
    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(v4 == "Date: 2025-03-15");

var=

strvar.unique()

Remove duplicate fields, values or subvalues.

From a dynamic array.

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, values or subvalues.

In a dynamic array.

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.randomize(delimiter = FM)

Randomise the order of fields in an FM, VM separated list

let v1 = "20^10^2^1^1.1"_var.randomize(); /// e.g. "2^1^20^1.1^10" (random order depending on initrand())
// or
let v2 = randomize("20^10^2^1^1.1"_var);

var=

strvar.parse(char sepchar = ' ')

Split a delimited string into a dynamic array.

Replace separator chars with FM chars except inside double or single quotes and ignoring escaped quotes \" \'

return: A dynamic array

Can be used to process CSV data.

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.

Delimiter: Can be multibyte Unicode.

return: 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.paste(pos1, length, replacestr)

var=

strvar.fieldstore(delimiter, fieldno, nfields, replacement)

String Mutation - Standalone Commands
Use Function Description

strvar.ucaser()

To 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.randomizer(delimiter = FM)

strvar.parser(char sepchar = ' ')

I/O Conversion
Use Function Description

var=

var.oconv(convstr)

Convert internal data to output external display format.

convstr: A conversion code or pattern. See ICONV/OCONV PATTERNS

return: The data in external display format or, if the data is invalid and cannot converted, most conversions return the original data UNCONVERTED.

throw: VarNotImplemented if convstr is invalid

let v1 = var(30123).oconv("D/E"); // "21/06/2050"
// or
let v2 = oconv(30123, "D/E");

var=

var.iconv(convstr)

Convert external data to internal format.

convstr: A conversion code or pattern. See ICONV/OCONV PATTERNS

return: The data in internal format or, if the data is invalid and cannot be converted, most conversions return the EMPTY STRING ""

throw: VarNotImplemented if convstr is invalid

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)

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

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

Use Linux command "iconv -l" for a 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)

Convert 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)

Update (replace or insert) a specific subvalue in a dynamic array.

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)

Update (replace or insert) a specific value in a dynamic array.

var=

strvar.update(fieldno, replacement)

Update (replace or insert) a specific field a dynamic array.

var=

strvar.insert(fieldno, valueno, subvalueno, insertion)

Insert a subvalue in a dynamic array.

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

var=

strvar.insert(fieldno, valueno, insertion)

Insert a value in a dynamic array.

var=

strvar.insert(fieldno, insertion)

Insert a field in a dynamic array.

var=

strvar.remove(fieldno, valueno = 0, subvalueno = 0)

Remove a field, value or subvalue from a dynamic array.

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 in a dynamic array.

Whatever is the lowest level is summed up into a 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 everything in a dynamic array.

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)

Sum all fields using a given delimiter.

let v1 = "10,20,30"_var.sum(","); // 60
// or
let v2 = sum("10,20,30", ",");

var=

strvar.stddev()

Calculate basic statistics include stddev.

return: An FM delimited string containing n, tot, min, max, tot, mean and stddev

strvar: A dynamic array containing numbers using any field, value or subvalue mark delimiters.

let v1 = "-11.2^0^11.5^12^13.9^14"_var.stddev(); // "6^40.2^-11.2^14^6.7^9.32344714506"_var
// or
let v2 = stddev("-11.2^0^11.5^12^13.9^14"_var);

var=

strvar.mv(opcode, var2)

Binary ops on parallel multivalues

opcode:

+
Addition
-
Subtraction
Multiplication
/
Division

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 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 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

All other fields are moved 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)

Insert a specific value in a dynamic array.

All other values are moved 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)

Insert a specific subvalue in a dynamic array.

All other subvalues are moved 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, value, or subvalue from a dynamic array.

All other fields, values, or subvalues are moved 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(substr)

locate substr in dynamic array

Search unordered fields, values and/or subvalues.

With only the substr argument provided, locate searches regardless of the field mark delimiters present.

return: The field, value or subvalue number if found or 0 if not. Fields are counted regardless of delimiter.

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

if

strvar.locate(substr, out valueno)

locate substr in values.

Search unordered VM delimited string.

valueno[out]: Value number if found or the max value number + 1 if not. If not found then valueno [out] is suitable for creating a new value.

return: True if found or False if not.

var valueno;
if ("UK]US]UA"_var.locate("US", valueno)) ... ok // valueno -> 2
// or
if (locate("US", "UK]US]UA"_var,valueno)) ... ok

if

strvar.locate(substr, out num, fieldno, valueno = 0)

locate substr in dynamic array.

Search in an unordered dynamic array.

fieldno: If fieldno is non-zero then search the specified field number otherwise, if fieldno is 0, search using FM as delimiter.

valueno: If provided, search the specified value number for a subvalue.

num[out]: If found, the field, value or subvalue number where it was found. If not found, the max field, value or subvalue number + 1. If not found then num [out] is suitable for creating a new field, value or subvalue.

return: True if found or False if not.

var num;
if ("f1^f2v1]f2v2]s1}s2}s3}s4^f3^f4"_var.locate("s4", num, 2, 3)) ... ok // num -> 4 // Return true

if

strvar.locateby(ordercode, substr, out valueno)

locate substr in ordered dynamic array

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

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

ordercode:

AL
Ascending - Left Justified (Alphabetic)
DL
Descending - Left Justified (Alphabetic)
AR
Ascending - Right Justified (Numeric/Natural)
DR
Descending - Right Justified (Numeric/Natural)

return: True if found, otherwise false.

valueno[out]: Either the value no found or the correct value no for inserting the substr

var valueno; if ("aaa]bbb]ccc"_var.locateby("AL", "bb", valueno)) ... // valueno -> 2 // Return false and valueno = where it could be correctly inserted.

if

strvar.locateby(ordercode, substr, out num, fieldno, valueno = 0)

locate substr in ordered dynamic array

locateby() with fieldno and/or valueno arguments, searches fields if fieldno is 0, or values in a specific fieldno, or subvalues in a specific valueno.

For more info, see locateby() without fieldno or valueno arguments.

var num;
if ("f1^f2^aaa]bbb]ccc^f4"_var.locateby("AL", "bb", num, 3)) ... // num -> 2 // return false and where it could be correctly inserted.

if

strvar.locateusing(usingchar, substr)

locate substr using any delimiter.

if ("AB,EF,CD"_var.locateusing(",", "EF")) ... ok

if

strvar.locateusing(usingchar, substr, out num, fieldno = 0, valueno = 0, subvalueno = 0)

locate substr in dynamic array using any delimiter

Search in a specific field, value or subvalue.

num[out]: If found, the number where found, otherwise the maximum number of delimited fields + 1.

return: True if found and False if not.

This is similar to the main locate command but the delimiter char can be specified e.g. a comma or TM etc.

var num;
if ("f1^f2^f3c1,f3c2,f3c3^f4"_var.locateusing(",", "f3c2", num, 3)) ... ok // num -> 2 // Return true

if

strvar.locatebyusing(ordercode, usingchar, substr, out num, fieldno = 0, valueno = 0, subvalueno = 0)

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

Database Access
Use Function Description

if

dbconn.connect(conninfo = "")

Establish a connection to a database.

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

  1. Provided in connect()'s conninfo argument. See the last option. 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.

dbconn[out]: Becomes a reference or handle for future functions that require a connection argument.

For all the various DB function calls, the dbconn or operative var can be either:

  • A DB connection created with dbconnect().
  • A file var created with open().
  • Any var. A default connection will be established on the fly.

var dbconn = "exodus";
if (not dbconn.connect("dbname=exodus user=exodus password=somesillysecret")) ...;
// or
if (not connect()) ...
// or
if (not connect("exodus")) ...

if

dbconn.attach(filenames)

Attach filename(s) to a specific DB connection.

Any following use of the given filename(s) without specifying a connection will be directed to the specified connection until process termination.

It is not necessary to attach files before opening them but the act of opening them also attaches them.

The files must exist in the specified connection.

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

dbconn: The connection to which the filename(s) should be attached. Defaults to the default connection.

filenames: FM separated list.

return: False if any filename does not exist and cannot be opened on the given connection. All filenames that can be opened on the connection 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 dbconn = "exodus";
let filenames = "xo_clients^dict.xo_clients"_var;
if (dbconn.attach(filenames)) ... ok
// or
if (attach(filenames)) ... ok

dbconn.detach(filenames)

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

filenames: FM separated list.

if

dbconn.begintrans()

Begin a DB transaction.

return:

True
Successfully begun.
False
DB refused. See lasterror() for info.

var dbconn = "exodus";
if (not dbconn.begintrans()) ...
// or
if (not begintrans()) ...

if

dbconn.statustrans()

Check if a DB transaction is in progress.

return: True or False.

var dbconn = "exodus";
if (dbconn.statustrans()) ... ok
// or
if (statustrans()) ... ok

if

dbconn.rollbacktrans()

Rollback a DB transaction.

return:

True
Successfully rolled back or there was no transaction in progress.
False
DB refused. See lasterror() for info.

var dbconn = "exodus";
if (dbconn.rollbacktrans()) ... ok
// or
if (rollbacktrans()) ... ok

if

dbconn.committrans()

Commit a DB transaction.

return:

True
Successfully committed or there was no transaction in progress.
False
DB refused. See lasterror() for info.

var dbconn = "exodus";
if (dbconn.committrans()) ... ok
// or
if (committrans()) ... ok

if

dbconn.sqlexec(sqlcmd)

Execute an sql command.

return:

True
Successfully executed.
False
DB refused. See lasterror() for info.

var dbconn = "exodus";
if (dbconn.sqlexec("select 1")) ... ok
// or
if (sqlexec("select 1")) ... ok

if

dbconn.sqlexec(sqlcmd, io response)

Execute an SQL command and capture the response.

return:

True
Successfully executed.
False
DB refused. See lasterror() for info.

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

It is *ecommended* that you do not use sql directly unless you must, perhaps to manage or configure a database.

var dbconn = "exodus";
let sqlcmd = "select 'xxx' as col1, 'yyy' as col2";
var response;
if (dbconn.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

dbconn.disconnect()

Close a DB connection

Free process resources both locally and in the database server.

var dbconn = "exodus";
dbconn.disconnect();
// or
disconnect();

dbconn.disconnectall()

Close all DB connections

Free process resources both locally and in the database server(s).

All connections are closed automatically when a process terminates.

var dbconn = "exodus";
dbconn.disconnectall();
// or
disconnectall();

var=

var::lasterror()

return: The last OS or DB error message.

var v1 = var::lasterror();
// or
var v2 = lasterror();

dbconn.setlasterror(msg)

Set the lasterror() message.

var::loglasterror(source = "")

Log the last OS or DB error message.

Output: To stdlog

Prefix the output with source if provided.

var::loglasterror("main:");
// or
loglasterror("main:");

Database Management
Use Function Description

if

dbconn.dbcreate(new_dbname, old_dbname = "")

Create a named database on a particular connection.

Optionally copies an existing database from the same connection

return: True or False. See lasterror() for errors.

  • Target database must not already exist.
  • Source database must exist on the same connection.
  • Source database cannot have any current connections.

var dbconn = "exodus";
if (not dbdelete("xo_gendoc_testdb")) {}; // Cleanup first
if (dbconn.dbcreate("xo_gendoc_testdb")) ... ok
// or
if (dbcreate("xo_gendoc_testdb")) ...

if

dbconn.dbcopy(from_dbname, to_dbname)

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

return: True or False. See lasterror() for errors.

  • Target database must not already exist.
  • Source database must exist on the same connection.
  • Source database cannot have any current connections.

var dbconn = "exodus";
if (not dbdelete("xo_gendoc_testdb2")) {}; // Cleanup first
if (dbconn.dbcopy("xo_gendoc_testdb", "xo_gendoc_testdb2")) ... ok
// or
if (dbcopy("xo_gendoc_testdb", "xo_gendoc_testdb2")) ...

var=

dbconn.dblist()

Get a list of available databases.

A list for a given connection or the default connection.

return: An FM delimited list.

var dbconn = "exodus";
let v1 = dbconn.dblist();
// or
let v2 = dblist();

if

dbconn.dbdelete(dbname)

Delete (drop) a named database.

return: True or False. See lasterror() for errors.

  • Database does not exist
  • Database has active connections.

var dbconn = "exodus";
if (dbconn.dbdelete("xo_gendoc_testdb2")) ... ok
// or
if (dbdelete("xo_gendoc_testdb2")) ...

if

dbconn.createfile(filename)

Create a named DB file.

filenames ending with "_temp" only last until the connection is closed.

return: True or False. See lasterror() for errors.

  • Filename is invalid.
  • Filename already exists.

let filename = "xo_gendoc_temp", dbconn = "exodus";
if (dbconn.createfile(filename)) ... ok
// or
if (createfile(filename)) ...

if

dbconn.renamefile(filename, newfilename)

Rename a DB file.

return: True or False. See lasterror() for errors.

  • source filename does not exist.
  • newfilename is invalid.
  • newfilename already exists.

let dbconn = "exodus", filename = "xo_gendoc_temp", new_filename = "xo_gendoc_temp2";
if (dbconn.renamefile(filename, new_filename)) ... ok
// or
if (renamefile(filename, new_filename)) ...

var=

dbconn.listfiles()

Get a list of all files in a database.

return: An FM separated list.

var dbconn = "exodus";
if (not dbconn.listfiles()) ...
// or
if (not listfiles()) ...

if

dbconn.clearfile(filename)

Delete all records in a DB file.

return: True or False. See lasterror() for errors.

  • filename does not exist.

let dbconn = "exodus", filename = "xo_gendoc_temp2";
if (not dbconn.clearfile(filename)) ...
// or
if (not clearfile(filename)) ...

if

dbconn.deletefile(filename)

Delete a DB file.

return: True or False. See lasterror() for errors.

  • filename does not exist.

let dbconn = "exodus", filename = "xo_gendoc_temp2";
if (dbconn.deletefile(filename)) ... ok
// or
if (deletefile(filename)) ...

var=

conn_or_file.reccount(filename = "")

Get the approx number of records in a DB file.

Might return -1 if not known.

Not very accurate inside transactions.

return: An approximate number.

let dbconn = "exodus", filename = "xo_clients";
var nrecs1 = dbconn.reccount(filename);
// or
var nrecs2 = reccount(filename);

if

conn_or_file.flushindex(filename = "")

Call the DB maintenance function.

For one file or all files.

Ensure that reccount() function is reasonably accurate.

Despite the name, this doesnt flush any index.

return: True or False. See lasterror() for errors.

  • Cannot perform maintenance while a transaction is active.
Database File I/O
Use Function Description

if

file.open(dbfilename, dbconn = "")

Open a DB file.

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

dbconn: If dbconn is *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.

return: See lasterror().

True
The filename was present in the cache OR the DB connection reports that the file is present.
False
The DB connection reports that the file does not exist.

var file, filename = "xo_clients";
if (not file.open(filename)) ...
// or
if (not open(filename to file)) ...

file.close()

Close a DB file.

Does nothing currently since database file vars consume no resources

var file = "xo_clients";
file.close();
// or
close(file);

if

file.createindex(fieldname, dictfile = "")

Create 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.

return: False if the index cannot be created for any reason. See lasterror().

  • 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|dbconn.listindex(file_or_filename = "", fieldname = "")

List secondary indexes.

In a database or for a DB file.

return: An FM separated list.

  • DB file or fieldname does not exist.

var dbconn = "exodus";
if (dbconn.listindex()) ... ok // include "xo_clients__date_created"
// or
if (listindex()) ... ok

if

file.deleteindex(fieldname)

Delete a secondary index.

For a DB file and field name.

return: False if the index cannot be deleted for any reason. See lasterror().

  • 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)

Place 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)) ...

if

file.unlock(key)

Remove a DB lock.

A lock placed by the lock function.

return: True or False. See lasterror().

  • Lock cannot be removed while in a transaction.
  • Lock is not present in the connection.

var file = "xo_clients", key = "1000";
if (file.unlock(key)) ... ok
// or
if (unlock(file, key)) ...

if

file.unlockall()

Remove all DB locks.

All locks placed by the lock function in the specified connection.

return: True or False. See lasterror().

  • Locks cannot be removed while in a transaction.

var dbconn = "exodus";
if (not dbconn.unlockall()) ...
// or
if (not unlockall(dbconn)) ...

record.write(file, key)

Write a record into a DB file.

Given a unique primary key, either inserts a new record or updates an existing record.

return: Nothing since writes always succeed.

throw: VarDBException if the file does not exist.

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);

if

record.read(file, key)

Read a record from a DB file.

Given a unique primary key.

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

key: The key of the record to be read.

return: 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)) ...

if

file.deleterecord(key)

Delete a record from a DB file.

Given a unique primary key.

return: True or False.

  • 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)) ...

if

record.insertrecord(file, key)

Insert a new record in a DB file.

Given a unique primary key.

return: True or False.

  • 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)) ...

if

record.updaterecord(file, key)

Update an existing record in a DB file.

Given a unique primary key.

return: True or False.

  • Key does not 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)) ...

if

record.updatekey(key, newkey)

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

Given two unique primary keys.

return: True or False.

  • Key does not exists
  • New key 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.

if

strvar.readf(file, key, fieldno)

Read a field from a DB file record.

Same as read() but only returns a specific field number from the record.

fieldno: The field number to return from the DB record.

return: A string var.

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 a field to a DB file record.

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 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);

if

record.readc(file, key)

Read a DB record first looking in a memory cached "DB file".

Same as "read() but first reads from a memory cache held per connection.

  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

if

dbfile.deletec(key)

Delete a record from a memory cached "DB file".

The actual database file is NOT updated.

return: False if the key doesnt exist

var file = "xo_clients", key = "XD001";
if (file.deletec(key)) ... ok
// or
if (deletec(file, key)) ...

dbconn.clearcache()

Clear the "DB file" memory cache.

All cached 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 dbconn = "exodus";
dbconn.clearcache();
// or
clearcache(dbconn);

var=

strvar.xlate(filename, fieldno, mode)

Read a field given filename, key and field number or name.

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 named columns, functions and multivalued data.

strvar: 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: Which field of the record to return.

nn
Field number nn
0
The key.
""
The whole record.

mode: If the record does not exist.

"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

if

dbfile.select(sort_select_command = "")

Create an active select list of DB keys.

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.

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

throw: 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);

if

dbfile.selectkeys(keys)

Create an active select list from a string of DB keys.

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

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

return: 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");

if

dbfile.hasnext()

Check if a select list is active.

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

return: 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());
}

if

dbfile.readnext(out key)

Acquire and consume one key from an active select list.

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.

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

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

return: True if a list was active and a key was acquired, false if not.

if

dbfile.readnext(out key, out valueno)

Acquire and consume one key and valueno pair from an active select list.

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.

if

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

Similar to readnext(key, valueno) but acquire the database record as well.

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

key[out]: Returns the next database record key in the select list.

valueno[out]: The multivalue number if the select list was ordered on multivalued database record fields or 1 if not.

return: True if a list was active and a key was acquired, false 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()

Deactivate an active select list.

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

return: 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

if

dbfile.savelist(listname)

Save 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.

return: 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 'B' by name")) {
    if (savelist("mylist")) ... ok
}

if

dbfile.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.

return: 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);
}

if

dbfile.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.

return: True if successful or false if the list name doesnt exist.

var dbconn = "";
if (dbconn.deletelist("mylist")) ... ok
// or
if (deletelist("mylist")) ...

OS Time/Date
Use Function Description

var=

var::date()

Get the current 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.

return: 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()

Get the current time in internal format.

Internal time is the number of whole seconds since the last midnight 00:00:00 (UTC).

return: 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()

Get the current time in high resolution internal format.

High resolution internal time is the number of fractional seconds since the last midnight 00:00:00 (UTC).

return: 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()

Get the current timestamp in internal format.

Internal timestamp is the number of fractional days since pick epoch 1967-12-31 00:00:00 UTC. Negative for dates before.

return: 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 the 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.

Release 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.

return: 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:

  1. Event type codes
  2. dirpaths
  3. filenames
  4. 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

if

osfilevar.osopen(osfilename, utf8 = true)

Open an OS file handle.

Allow random read and write operations.

Open for writing if possible, otherwise read-only.

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.

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

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

if

strvar.osbwrite(osfilevar, io offset)

Random write 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.

return: 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)) ...

if

strvar.osbread(osfilevar, io offset, length)

Random read data from an OS file

From 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.

return: 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()

Close an osfilevar.

Remove 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);

if

strvar.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.

return: True if successful or false if not possible for any reason. e.g. Path is not writeable, permissions etc

let text = &qquot;aaa = 123\nbbb = 456";
let osfilename = ostempdir() ^ "xo_gendoc_test.conf";
if (text.oswrite(osfilename)) ... ok
// or
if (oswrite(text on osfilename)) ... ok

if

strvar.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.

return: 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);

if

osfile_or_dirname.osrename(new_dirpath_or_filepath)

Rename 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.

return: 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)) ...

if

osfile_or_dirname.osmove(to_osfilename)

"Move" an OS file or dir.

Within the OS file system.

Attempt osrename first, then oscopy plus 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.

return: 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)) ...

if

osfile_or_dirname.oscopy(to_osfilename)

Copy an OS file or directory.

Including subdirs.

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.

return: 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

if

osfilename.osremove()

Remove/delete 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.

return: 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
Any regular OS file or dir (Default).
1
Only regular OS files.
2
Only dirs.

return: 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 = "")

Get a list of OS files.

See oslist() for info.

var=

dirpath.oslistd(globpattern = "")

Get a list of OS dirs.

See oslist() for info.

var=

osfile_or_dirpath.osinfo(mode = 0)

Get dir info about an OS file or dir.

return: 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.

return: 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.

return: 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/");

if

dirpath.osmkdir()

Create a new OS file system directory.

Parent dirs wil be created if necessary.

dirpath: Absolute or relative path and dir name.

return: True if successful.

let osdirname = "xo_test/aaa";
if (osrmdir("xo_test/aaa")) {}; // Cleanup first
if (osdirname.osmkdir()) ... ok
// or
if (osmkdir(osdirname)) ...

if

var::oscwd(newpath)

Change the current working dir.

newpath: An absolute or relative dir path and name.

return: 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()

Get the current working dir path and name.

return: The current working dir path and name.

e.g. "/root/exodus/cli/src/xo_test/aaa"

var cwd1 = var().oscwd();
// or
var cwd2 = oscwd();

if

dirpath.osrmdir(evenifnotempty = false)

Remove (deletes) an OS dir,

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

return: 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

if

command.osshell()

Execute a shell command.

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

return: 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

if

instr.osshellread(oscmd)

Execute a shell command and capture its stdout.

return: 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);

if

outstr.osshellwrite(oscmd)

Execute a shell command and provide its stdin.

return: 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

if

dirpath.osprocess(oscmd, stdin_for_process, out stdout_from_process, out stderr_from_process, out exit_status, timeout_secs = 0)

Run an OS program synchronously.

Provide its standard input and capture its output, errors, and exit status.

Shell features (e.g., pipes, redirects) are unsupported but can be invoked via an oscmd like "bash -c 'abc|yy $HOME'".

oscmd: Executable and arguments; must exist in OS PATH.

stdin_for_process: Optional; input data for the program’s standard input.

stdout_from_process[out]: Standard output from the program.

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

exit_status[out]: Program’s exit status: 0 (normal), -1 (timeout), else (error).

timeout_secs: Optional; max runtime in seconds (default 0 = no timeout).

return: True if program ran and exited with status 0 (success) or false if program failed to start, timed out, or exited with non-zero status.

throw: Pipe creation failed, fork failed, poll failed.

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.

return: A string e.g. "/tmp/"

let v1 = var::ostempdir();
// or
let v2 = ostempdir();

var=

var::ostempfile()

Create a temporary file.

return: The name of new temporary file e.g. "/tmp/~exoEcLj3C"

var temposfilename1 = var::ostempfile();
// or
var temposfilename2 = ostempfile();

if

envvalue.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...

return: 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"

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);

var=

var::ospid()

Get the current OS process id.

return: 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.

return: 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.

return: 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();

if

strvar.setxlocale(newlocalecode)

Set 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()

Get the current thread's default locale.

return: A locale codepage code string.

let v1 = var::getxlocale(); // "en_US.utf8"
// or
let v2 = getxlocale();

Output
Use Function Description

expr

strvar.outputl(prefix = "")

Output to stdout with optional prefix.

Append 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.

expr

strvar.output(prefix = "")

Same as outputl() but doesnt append an NL char and is BUFFERED, not flushed.

expr

strvar.outputt(prefix = "")

Same as outputl() but appends a tab char instead of an NL char and is BUFFERED, not flushed.

expr

strvar.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.

expr

strvar.logput(prefix = "")

Same as logputl() but doesnt append an NL char.

expr

strvar.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.

expr

strvar.errput(prefix = "")

Same as errputl() but doesnt append an NL char and is BUFFERED not flushed.

expr

strvar.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

if

var.input(prompt = "")

Read one line of input from stdin.

return: 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();

expr

var.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.

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

return: "" 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();

if

var().isterminal(in_out_err = 1)

Check if is a terminal or a file/pipe.

Can check stdin, stdout, stderr.

in_out_err:

0
stdin
1
stdout (Default)
2
stderr.

return: 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();

if

var().hasinput(milliseconds = 0)

Check 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.

return: 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.

if

var().eof()

True if stdin is at end of file

if

var().echo(on_off = true)

Set 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.

return: 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().

Allow 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.

return: A pseudo random integer between 0 and the provided maximum minus 1.

Uses std::mt19937 and std::uniform_int_distribution<int>

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.

return: Floating point var (double)

let v1 = var(2.718281828459045).loge(); // 1
// or
let v2 = loge(2.718281828459045);

var=

varnum.integer()

Truncate decimals.

Convert decimal to nearest integer towards zero.

Remove decimal fraction.

return: 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()

Floor decimals.

Convert decimal to nearest integer towards negative infinity.

return: 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 positive numbers

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

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

throw: 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 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.

With the default precision, Exodus handles, without assistance, conversion to and from strings for positive and negative numbers between 0.0001 and 999'999'999'999.9999 (12 digits).

newprecision: New precision between -307 and 308 inclusive.

return: 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()

Get current floating point precision.

return: 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")

oconv "D" Convert internal date to external format.

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

return: 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")

iconv "D" Convert external date format to internal.

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

return: 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")

oconv "MT" Convert internal time to external format.

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

return: 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")

iconv "MT" Convert external time format to internal.

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

return: 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")

oconv "MD" Convert internal numbers to external format.

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

return: 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.
.
Separate thousands depending on MD or MC.
,
Ditto
-
Suffix negatives with "-" and positives with " " (space).
<
Wrap negatives in "<" and ">" chars.
C
Suffix negatives with "CR" and positives or zero with "DB".
D
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")

oconv "L" "R" "C" Justify text and numbers.

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")

oconv "T" Justify and fold text.

e.g. T#20

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

Split 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 

expr

varnum.oconv("MR")

oconv "MR" Replace characters.

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")

oconv "HEX" Convert a string of chars 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")

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.

return: 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")

oconv "MX" Convert a 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.

return: 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")

iconv "MX" Convert a hexadecimal string to number.

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

return: 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 "FFFF" "FFFF" "FFFF" "FFFF" (8 x "FF") -> -1.

Hex "7FFF" "FFFF" "FFFF" "FFFF" -> The maximum positive integer: 9223372036854775805.

Hex "8000" "0000" "0000" "0000" -> 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")

oconv "MB" Convert a number to a binary string of "1"s and "0"s,

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")

oconv "TX" Convert a dynamic array to text.

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")

iconv "TX" Convert text to a dynamic array.

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 by redim, read, osread or split.

dim d1;

dim d1(nrows, ncols = 1);

Create a dimensioned array of vars.

Specify a fixed number of columns and rows. All vars are unassigned.

dim d1(10);
dim d2(10, 3);

dim d1 = d2; // Copy

Copy a dimensioned array.

Unassigned elements are copied as is.

dim d1 = {2, 4, 6, 8};
dim d2 = d1;

dim d1 = dim(); // Move

Save a dimensioned array created elsewhere.

Use C++ "move" semantics.

dim d1 = "f1^f2^f3"_var.split();

dim d1 = {"a", "b", "c" ...}; // Initializer list

Create a dimensioned array from a literal list.

All elements must be the same type, var, string, double, int, etc. All end up as vars which are flexible.

dim d1 = {1, 2, 3, 4, 5};
dim d2 = {"A", "B", "C"};

dim d1 = v1;

Initialise all elements of an dimensioned array.

To some single value. e.g. a var, "", 0 etc.

dim d1(10);
d1 = "";

d1.redim(nrows, ncols = 1)

Resize a dimensioned array.

To a different number of rows and columns.

Existing data will be retained. 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 two arrays.

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;

[row] Access and update dimensioned array elements.

Two dimensioned arrays can be traversed, columnwise then rowwise, using one dimension array access.

dim d1 = {1, 2, 3, 4, 5};
d1[3] = "X";
let v1 = d1[3]; // "X"

var v1 = d1[rowno, colno];
d1[rowno, colno] = v1;

[row, col] Access and update dimensioned array elements.

dim d1(10, 5);
d1 = "";
d1[3, 4] = "X";
let v1 = d1[3, 4]; // "X"

var=

d1.rows()

Get the number of rows in the dimensioned array

return: A count. Can be zero, indicating an empty or undimensioned array.

dim d1(5,3);
let v1 = d1.rows(); // 5

var=

d1.cols()

Get the number of columns in the dimensioned array

return: A count. 0 if the array is undimensioned.

dim d1(5,3);
let v1 = d1.cols(); // 3

var=

d1.join(delimiter = FM)

Get a delimited string concatenating all elements of a dimensioned array.

Unassigned elements on the end are omitted.

delimiter: Default is FM.

return: 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)

Create or update a dimensioned array using a string with delimiters.

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 a dimensioned array.

The order of the elements is adjusted so that each element is <= the next.

reverse: If true, then the order is reversed. The default is false.

dim d1 = "2,20,10,1"_var.split(",");
d1.sorter();
let v1 = d1.join(","); // "1,2,10,20"_var

d1.reverser()

Reverse a dimensioned array.

The order of the elements is reversed.

dim d1 = "2,20,10,1"_var.split(",");
d1.reverser();
let v1 = d1.join(","); // "1,10,20,2"_var

d1.randomizer()

Randomise a dimensioned array.

The order of the elements is randomised.

dim d1 = "2,20,10,1"_var.split(",");
d1.randomizer();
let v1 = d1.join(","); // random

Array Conversion
Use Function Description

dim=

d1.sort(reverse = false)

Get a sorted copy of a dimensioned array.

dim=

d1.reverse()

Get a reversed copy of a dimensioned array;

dim=

d1.randomize()

Get a randomised copy of a dimensioned array.

Array DB I/O
Use Function Description

d1.write(dbfile, key)

Write a DB file record created from a dimensioned array.

Each element in the array becomes a separate field in the DB record.

Redundant trailing FMs are omitted.

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);

if

d1.read(dbfile, key)

Read a DB file record into a dimensioned array.

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

return: 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

if

d1.oswrite(osfilename, codepage = "")

Create an entire OS text file from a dimensioned 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.

return: 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)) ...

if

d1.osread(osfilename, codepage = "")

Read an entire OS text file into a dimensioned 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.

return: 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

if

select(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.

return: 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

if

selectkeys(keys)

Create an active select list from a dynamic array of keys.

selectkeys("SB001^JB001^JB002"_var);
if (readnext(ID)) ... ok // ID -> "SB001"

if

hasnext()

Check if a select list is active.

if (hasnext()) ... ok

if

readnext(out key)

Get the next key from an active select list.

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

return: 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"

if

readnext(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.

return: 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

if

readnext(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.

return: 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)

Get a reference to the currently active select list and suspend it.

Allow another select list to be activated and used temporarily before the original select list is reactivated.

Multiple levels of pushselect/popselect can be used.

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-activate a select list using a reference provided 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();

if

deleterecord(filename)

Delete multiple DB records using an active select list.

return: 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")) ...
}

if

deleterecord(dbfile, key)

Delete a single DB 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)) ...

if

savelist(listname)

Save the current active select list under a given name.

Select lists are saved in the DB file "lists". They are accessible to any Exodus process and remain until specifically deleted.

After saving, the list is no longer active and hasnext() will return false.

return: True if an active select list was saved, false if there was no active select list.

selectkeys("SB001^SB002"_var);
if (not savelist("my_list")) ...

if

getlist(listname)

Create an active select list using a saved select list of a given name.

A saved list is obtained from the "lists" file and activated. The list remains in the lists file for multiple use.

return: True if an active select list was successfully reactivated, otherwise false.

if (not getlist("my_list")) ...

if

deletelist(listname)

Remove a saved select list by name.

A saved list is deleted from the "lists" file.

if (not deletelist("my_list")) ...

if

formlist(filename_or_command, keys = "", fieldno = 0)

if

makelist(listname, keys)

Perform/Execute
Use Function Description

var=

perform(command_line)

Run an Exodus program/library.

Creates a new instance of an Exodus program library function object and calls its main() function using a command-like syntax, similar to that of running an OS executable program, and passes its arguments through the COMMAND and OPTIONS variables.

A performed program/library's main function should have no arguments otherwise they appear unassigned and a segfault or core dump may occur.

The Exodus program class member variables of a performed or executed program/library are all, as might be expected, initially unassigned unless specifically initialised inline. Note that this is not the same as calling a program library function (using function call syntax and round brackets funcx()), where the program/library/function's member variables are initially unassigned but retain their state between calls.

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.

return: Whatever the program returns from main() or passes as an argument to stop(). If the program terminates abnormally then it will return "" and lasterror() will contain some error message. The return value may be ignored so there is no need so wrap perform statements in if clauses to avoid compiler warnings.

throw: All the various runtime errors based on VarError e.g. VarUnassigned.

environment: The following environment variables are initialised on entry to the main function of the program/library and are preserved untouched (actually restored) in the calling program.

  • COMMAND, OPTIONS, SENTENCE.
  • 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.
  • CURSOR 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() where the executed program/library gets its own private active select list, initially inactive.

Exodus program/library/functions 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. See library.h for more info.

var=

execute(command_line)

Run an exodus program/library.

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.

Similar to perform() except that the current program closes first and all environment variables carry forward unchanged.

var=

libinfo(libname)

Check if a lib exists.

Can be checked before perform/execute to avoid errors.

Currently it does not check if the library is actually loadable.

return: osfile info.

Program Termination
Use Function Description

stop(result = "")

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.

result: Optional. It will be used as the return value of a parent program's perform() or execute() function, or if none, and therefore returning to the OS, it will be output to stdout if non-numeric 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)

Get DB record field values given field name only.

Use a dictionary file that contains info sufficient to either extract or calculate the required value.

  1. Read fieldinfo from the current DICT file using readc() for caching.
  2. Use the fieldinfo to:
    • Either extract a specific field number from the current RECORD/ID/MV environment variables.
    • Or call a dictionary function library to calculate the result.

var=

calculate(dictid, dictfile, id, record, mv = 0)

Get DB record field values given name and data.

Same as the one argument version of calculate() but RECORD/ID/MV are provided as arguments instead of being hard coded.

var=

xlate(filename, key, fieldno_or_name, mode)

Read DB field using field number or name.

  1. Read a record from a given file and key using readc() for caching.
  2. Extracts the given field number or calls calculate(dictid...) if non-numeric.

filename: The file to read.

key: The key of the record to read.

fieldno_or_name: The field to return.

nn
Field number nn.
0
The record key (ID).
""
The whole record (RECORD)
dictid
The function calculate(dictid) will be called.

mode: If the record does not exist.

"X"
Return ""
"C"
Return the key.

MV: Environment variable. Will be used to select a particular value if not zero, or all values if zero.

I/O Conversion
Use Function Description

var=

oconv(input, conversion)

iconv/oconv "[...]"

ExoProgram's iconv/oconv functions have access to ExoProgram's environment variables like BASEFMT, DATEFMT and TZ and 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)

Ioconv Date/Time
Use Function Description

var=

iconv|oconv(var, "[DATE]")

iconv/oconv "[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).

return: [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.

return: [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]")

iconv/oconv "[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"

return: 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)

Parse amount+currency code string.

Split amount+currency code/unit string into number and currency code/unit.

var: "123.45USD"

return: e.g. "123.45"

unitx[out]: e.g. "USD"

var=

amountunit(input0)

Time/Date Utilities
Use Function Description

var=

timedate2()

Get 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)

Get current user, server and UTC dates and times.

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.

TIMESTAMP is 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 given timestamps

Warning: Use ostimestamp() not ostime(). The first is in days and the second 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)

Output a message to stdout and optionally request input.

If input is requested but stdin is not a terminal then 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 stdout.

call note("Hello world.");

var=

decide(question, options = "")

Input user selection from a list of options.

If stdin is not a terminal, set the response to "" and continue.

return: The chosen option (value not number) or "" if the user cancelled.

var=

decide(question, options, out reply, defaultreply = 1)

Input user selection from a list of options.

If stdin is not a terminal set the response to the default value, or "" if none, and continue.

defaultreply: A default option if the user presses Enter.

reply[out]: The option number that the user chose or "" if they cancelled.

return: The chosen option (value not number) or "" if the user cancelled.

if

esctoexit()

Check for user pause or cancel.

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.

return:

True
A key has been pressed and the user chose not to resume.
False
stdif is not a terminal, no key has been pressed, or the user chose to resume.

var=

AT(code)

Get a string to control terminal operation.

return: 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 (1 based).
0
Position the cursor at the first column (1).
-1
Clear the screen and home the cursor.
-2
Position the cursor at the top left home (x, y = 1, 1).
-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.

return: 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.

if

getcursor(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.

x and y are 1 based, not 0 based.

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 "1^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

return: 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 = "")

Sort parallel fields of multivalues of dynamic arrays

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 Justified (Alphabetic)
AR
Ascending - Right Justified (Numeric/Natural)
DR
Descending - Right Justified (Numeric/Natural)

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

if

lockrecord(filename, io file, keyx, unused, waitsecs = 0, allowduplicate = false)

if

lockrecord(filename, io file, keyx)

if

unlockrecord(filename, io file, key)

if

unlockrecord()