<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="__bstring_8h">
<title>/Users/bernard/b20/bsoft/include/Bstring.h File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/include/Bstring.h</primary></indexterm>
<para>

<para>Header file for the string class. </para>
 
</para>
<programlisting>#include &lt;iostream&gt;
#include &lt;cstdio&gt;
#include &lt;vector&gt;
</programlisting><simplesect>
    <title>Classes    </title>
        <itemizedlist>
            <listitem><para>class <link linkend="_class_bstring">Bstring</link></para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Macros    </title>
        <itemizedlist>
            <listitem><para>#define <link linkend="__bstring_8h_1a0647b5e43b456afc9045487d5156a134">MAX_FORMAT_SIZE</link>   64</para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>istream &amp; <link linkend="__bstring_8h_1a5b1ba6d7d836de3a4374fd0899064682">operator&gt;&gt;</link> (istream &amp;input, <link linkend="_class_bstring">Bstring</link> &amp;s)</para>
</listitem>
            <listitem><para>ostream &amp; <link linkend="__bstring_8h_1af1fc059c1bcfe3d73f7da0279b507460">operator&lt;&lt;</link> (ostream &amp;output, <link linkend="_class_bstring">Bstring</link> &amp;s)</para>
</listitem>
            <listitem><para><link linkend="_class_bstring">Bstring</link> * <link linkend="__bstring_8h_1a7f784a89c16640b39c197fabc7062930">string_add</link> (<link linkend="_class_bstring">Bstring</link> **list, const char *string)</para>

<para>Adds a string to a linked list. </para>
</listitem>
            <listitem><para><link linkend="_class_bstring">Bstring</link> * <link linkend="__bstring_8h_1a804a6fb318de2e47f5bbf3e84c915490">string_add</link> (<link linkend="_class_bstring">Bstring</link> **list, <link linkend="_class_bstring">Bstring</link> &amp;string)</para>
</listitem>
            <listitem><para><link linkend="_class_bstring">Bstring</link> <link linkend="__bstring_8h_1a2d08d18bfadb2e1057784bf9bc7ac7aa">string_catenate</link> (<link linkend="_class_bstring">Bstring</link> *list)</para>

<para>Catenates a string linked list into one string. </para>
</listitem>
            <listitem><para>int <link linkend="__bstring_8h_1a28d272b0a3d80dfeacf2ee7bf9c6d4c2">string_kill</link> (<link linkend="_class_bstring">Bstring</link> *list)</para>

<para>Kills a string linked list. </para>
</listitem>
            <listitem><para><link linkend="_class_bstring">Bstring</link> <link linkend="__bstring_8h_1ae06719a39570ac5e7ceec60123d35e19">parameter_file_path</link> (<link linkend="_class_bstring">Bstring</link> filename)</para>

<para>Finds the parameter file path. </para>
</listitem>
            <listitem><para>int <link linkend="__bstring_8h_1ae0d83007cde6bf79ab6c3ee65fa3aadf">string_sort</link> (<link linkend="_class_bstring">Bstring</link> *slist, int descending, int value)</para>

<para>Sorts a list of strings in ascending (descending) lexical or value order. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Header file for the string class. </para>

<para><formalpara><title>Author: </title>

<para>Bernard Heymann </para>
</formalpara>
<formalpara><title>Date: </title>

<para>Created: 20051020 </para>

<para>Modified: 20190208 </para>
</formalpara>
</para>
</section>
<section>
<title>Macro Definition Documentation</title>
<anchor xml:id="__bstring_8h_1a0647b5e43b456afc9045487d5156a134"/>    <section>
    <title>MAX_FORMAT_SIZE</title>
<indexterm><primary>MAX_FORMAT_SIZE</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>MAX_FORMAT_SIZE</secondary></indexterm>
<para><computeroutput>#define MAX_FORMAT_SIZE   64</computeroutput></para><para>
Definition at line 18 of file Bstring.h.</para>
</section>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="__bstring_8h_1af1fc059c1bcfe3d73f7da0279b507460"/>    <section>
    <title>operator&lt;&lt;()</title>
<indexterm><primary>operator&lt;&lt;</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>operator&lt;&lt;</secondary></indexterm>
<para><computeroutput>ostream&amp; operator&lt;&lt; (ostream &amp; output, <link linkend="_class_bstring">Bstring</link> &amp; s)</computeroutput></para><para>
Definition at line 694 of file Bstring.cpp.</para>
    </section><anchor xml:id="__bstring_8h_1a5b1ba6d7d836de3a4374fd0899064682"/>    <section>
    <title>operator&gt;&gt;()</title>
<indexterm><primary>operator&gt;&gt;</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>operator&gt;&gt;</secondary></indexterm>
<para><computeroutput>istream&amp; operator&gt;&gt; (istream &amp; input, <link linkend="_class_bstring">Bstring</link> &amp; s)</computeroutput></para><para>
Definition at line 687 of file Bstring.cpp.</para>
    </section><anchor xml:id="__bstring_8h_1ae06719a39570ac5e7ceec60123d35e19"/>    <section>
    <title>parameter_file_path()</title>
<indexterm><primary>parameter_file_path</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>parameter_file_path</secondary></indexterm>
<para><computeroutput><link linkend="_class_bstring">Bstring</link> parameter_file_path (<link linkend="_class_bstring">Bstring</link> filename)</computeroutput></para><para>

<para>Finds the parameter file path. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>&amp;filename</entry>
                                <entry>
<para>the parameter filename. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para><link linkend="_class_bstring">Bstring</link> the full path and file name. <literallayout><computeroutput>The parameter file path should primarily be defined in the environmental
variable &quot;BPARAM&quot;.
Otherwise a default is used which may or may not be valid.
The string returned has a length containing the path plus one byte.
</computeroutput></literallayout> </para>
</formalpara>
</para>
<para>
Definition at line 787 of file Bstring.cpp.</para>
    </section><anchor xml:id="__bstring_8h_1a7f784a89c16640b39c197fabc7062930"/>    <section>
    <title>string_add()<computeroutput>[1/2]</computeroutput></title>
<indexterm><primary>string_add</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>string_add</secondary></indexterm>
<para><computeroutput><link linkend="_class_bstring">Bstring</link>* string_add (<link linkend="_class_bstring">Bstring</link> ** list, const char * string)</computeroutput></para><para>

<para>Adds a string to a linked list. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>**list</entry>
                                <entry>
<para>the string linked list. </para>
</entry>
                            </row>
                            <row>
                                <entry>&amp;string</entry>
                                <entry>
<para>string - unchanged. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>Bstring* new string structure. </para>
</formalpara>
</para>
<para>
Definition at line 705 of file Bstring.cpp.</para>
    </section><anchor xml:id="__bstring_8h_1a804a6fb318de2e47f5bbf3e84c915490"/>    <section>
    <title>string_add()<computeroutput>[2/2]</computeroutput></title>
<indexterm><primary>string_add</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>string_add</secondary></indexterm>
<para><computeroutput><link linkend="_class_bstring">Bstring</link>* string_add (<link linkend="_class_bstring">Bstring</link> ** list, <link linkend="_class_bstring">Bstring</link> &amp; string)</computeroutput></para><para>
Definition at line 711 of file Bstring.cpp.</para>
    </section><anchor xml:id="__bstring_8h_1a2d08d18bfadb2e1057784bf9bc7ac7aa"/>    <section>
    <title>string_catenate()</title>
<indexterm><primary>string_catenate</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>string_catenate</secondary></indexterm>
<para><computeroutput><link linkend="_class_bstring">Bstring</link> string_catenate (<link linkend="_class_bstring">Bstring</link> * list)</computeroutput></para><para>

<para>Catenates a string linked list into one string. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>*list</entry>
                                <entry>
<para>the string linked list. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para><link linkend="_class_bstring">Bstring</link> new string. </para>
</formalpara>
</para>
<para>
Definition at line 739 of file Bstring.cpp.</para>
    </section><anchor xml:id="__bstring_8h_1a28d272b0a3d80dfeacf2ee7bf9c6d4c2"/>    <section>
    <title>string_kill()</title>
<indexterm><primary>string_kill</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>string_kill</secondary></indexterm>
<para><computeroutput>int string_kill (<link linkend="_class_bstring">Bstring</link> * list)</computeroutput></para><para>

<para>Kills a string linked list. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>*list</entry>
                                <entry>
<para>the string linked list. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int 0. </para>
</formalpara>
</para>
<para>
Definition at line 760 of file Bstring.cpp.</para>
    </section><anchor xml:id="__bstring_8h_1ae0d83007cde6bf79ab6c3ee65fa3aadf"/>    <section>
    <title>string_sort()</title>
<indexterm><primary>string_sort</primary><secondary>Bstring.h</secondary></indexterm>
<indexterm><primary>Bstring.h</primary><secondary>string_sort</secondary></indexterm>
<para><computeroutput>int string_sort (<link linkend="_class_bstring">Bstring</link> * slist, int descending, int value)</computeroutput></para><para>

<para>Sorts a list of strings in ascending (descending) lexical or value order. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>*slist</entry>
                                <entry>
<para>string list. </para>
</entry>
                            </row>
                            <row>
                                <entry>descending</entry>
                                <entry>
<para>flag to do a descending sort. </para>
</entry>
                            </row>
                            <row>
                                <entry>value</entry>
                                <entry>
<para>sort in value order. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int 0. <literallayout><computeroutput>The string list is first convert to an array, quicksorted, and
written back into the string list.
</computeroutput></literallayout> </para>
</formalpara>
</para>
<para>
Definition at line 875 of file Bstring.cpp.</para>
</section>
</section>
</section>
