diff options
author | Jörg Frings-Fürst <debian@jff-webhosting.net> | 2023-01-29 15:45:54 +0100 |
---|---|---|
committer | Jörg Frings-Fürst <debian@jff-webhosting.net> | 2023-01-29 15:45:54 +0100 |
commit | ea61b72fd4e7485b1487a4c94d908a9051ce2c9d (patch) | |
tree | 453ec4076d8a2374b2261dd42de59604095dc044 /docs/html | |
parent | 37e148ea3642ac18f703bfe68083e185d29eea95 (diff) | |
parent | 517ad9d4b6eae320b708d03a9340a22893b0cab7 (diff) |
Update upstream source from tag 'upstream/4.0.3'
Update to upstream version '4.0.3'
with Debian dir 538ed2ce92d0b7f84f42a595fb73b1fa053aa759
Diffstat (limited to 'docs/html')
-rwxr-xr-x | docs/html/Xbase64ClassDiagram.jpg | bin | 0 -> 93778 bytes | |||
-rwxr-xr-x | docs/html/gpl-3.0.txt | 674 | ||||
-rwxr-xr-x | docs/html/index.htm | 33 | ||||
-rwxr-xr-x | docs/html/index.html | 43 | ||||
-rwxr-xr-x | docs/html/xbab.html (renamed from docs/html/xbbib.htm) | 8 | ||||
-rwxr-xr-x | docs/html/xbac.html | 102 | ||||
-rwxr-xr-x | docs/html/xbad.html | 27 | ||||
-rwxr-xr-x | docs/html/xbae.html | 94 | ||||
-rwxr-xr-x | docs/html/xbaf.html (renamed from docs/html/xbc15.htm) | 29 | ||||
-rwxr-xr-x | docs/html/xbc1.html (renamed from docs/html/xbc1.htm) | 22 | ||||
-rwxr-xr-x | docs/html/xbc10.html (renamed from docs/html/xbc10.htm) | 0 | ||||
-rwxr-xr-x | docs/html/xbc11.html (renamed from docs/html/xbc11.htm) | 0 | ||||
-rwxr-xr-x | docs/html/xbc12.html (renamed from docs/html/xbc12.htm) | 28 | ||||
-rwxr-xr-x | docs/html/xbc13.html (renamed from docs/html/xbc13.htm) | 0 | ||||
-rwxr-xr-x | docs/html/xbc14.htm | 12 | ||||
-rwxr-xr-x | docs/html/xbc14.html | 113 | ||||
-rwxr-xr-x | docs/html/xbc15.html | 51 | ||||
-rwxr-xr-x | docs/html/xbc2.html (renamed from docs/html/xbc2.htm) | 0 | ||||
-rwxr-xr-x | docs/html/xbc3.html (renamed from docs/html/xbc3.htm) | 0 | ||||
-rwxr-xr-x | docs/html/xbc4.html (renamed from docs/html/xbc4.htm) | 5 | ||||
-rwxr-xr-x | docs/html/xbc5.html (renamed from docs/html/xbc5.htm) | 17 | ||||
-rwxr-xr-x | docs/html/xbc6.html (renamed from docs/html/xbc6.htm) | 18 | ||||
-rwxr-xr-x | docs/html/xbc7.html (renamed from docs/html/xbc7.htm) | 0 | ||||
-rwxr-xr-x | docs/html/xbc8.html (renamed from docs/html/xbc8.htm) | 2 | ||||
-rwxr-xr-x | docs/html/xbc9.html (renamed from docs/html/xbc9.htm) | 1 |
25 files changed, 1202 insertions, 77 deletions
diff --git a/docs/html/Xbase64ClassDiagram.jpg b/docs/html/Xbase64ClassDiagram.jpg Binary files differnew file mode 100755 index 0000000..81bb539 --- /dev/null +++ b/docs/html/Xbase64ClassDiagram.jpg diff --git a/docs/html/gpl-3.0.txt b/docs/html/gpl-3.0.txt new file mode 100755 index 0000000..94a9ed0 --- /dev/null +++ b/docs/html/gpl-3.0.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/docs/html/index.htm b/docs/html/index.htm deleted file mode 100755 index 3c992f5..0000000 --- a/docs/html/index.htm +++ /dev/null @@ -1,33 +0,0 @@ -<!DOCTYPE HTML PUBLIC> -<HTML><TITLE>Xbase DBMS Documentation Table of Contents</TITLE> -<BODY BGCOLOR=#FFFFFF> -<H1><p align="center">Xbase DBMS<br> -Last Updated 11/21/22<br>Version 4.x.x</p></H1> -<h2>Documentation Table Of Contents</h2> -<h3>Section 1 - Xbase Concepts</h3> -<h4> -<A HREF="xbc1.htm">Chapter 1 - Getting Started</A><br> -<A HREF="xbc2.htm">Chapter 2 - Database Overview</A><br> -<A HREF="xbc3.htm">Chapter 3 - Fields and Strings</A><br> -<A HREF="xbc4.htm">Chapter 4 - Date Processing</A><br> -<A HREF="xbc5.htm">Chapter 5 - Expression Handling</A><br> -<A HREF="xbc6.htm">Chapter 6 - Index Overview</A><br> -<A HREF="xbc7.htm">Chapter 7 - NDX (DBase) Indices</A><br> -<A HREF="xbc8.htm">Chapter 8 - MDX (DBase) Indices</A><br> -<A HREF="xbc9.htm">Chapter 9 - NTX (Clipper) Indices</A><br> -<A HREF="xbc10.htm">Chapter 10 - CDX (FoxPro) Indices</A><br> -<A HREF="xbc11.htm">Chapter 11 - IDX (FoxPro) Indices</A><br> -<A HREF="xbc12.htm">Chapter 12 - Record and File Locking</A><br> -<A HREF="xbc13.htm">Chapter 13 - Logfile Support</A><br> -<A HREF="xbc14.htm">Chapter 14 - SQL Support</A><br> -<A HREF="xbc15.htm">Chapter 15 - Utility programs</A><br> - -</h4> -<h3>Section 3 - Appendices</h3> -<h4> -<A HREF="copying.lib">Appendix C - GPL Library License</A><br> -<A HREF="xbbib.htm">Appendix D - Bibliography</A><br> -</h4> -<p><img src="xbase.jpg"><br><hr> -</BODY> -</HTML> diff --git a/docs/html/index.html b/docs/html/index.html new file mode 100755 index 0000000..098c7ea --- /dev/null +++ b/docs/html/index.html @@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC> +<HTML><TITLE>Xbase DBMS Documentation Table of Contents</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H1><p align="center">Xbase DBMS<br> +Last Updated 12/21/22<br>Version 4.0.3</p></H1> +<h2>Documentation Table Of Contents</h2> +<h3>Section 1 - Xbase Concepts</h3> +<h4> +<A HREF="xbc1.html">Chapter 1 - Getting Started</A><br> +<A HREF="xbc2.html">Chapter 2 - Database Overview</A><br> +<A HREF="xbc3.html">Chapter 3 - Fields and Strings</A><br> +<A HREF="xbc4.html">Chapter 4 - Date Processing</A><br> +<A HREF="xbc5.html">Chapter 5 - Expression Handling</A><br> +<A HREF="xbc6.html">Chapter 6 - Index Overview</A><br> +<A HREF="xbc7.html">Chapter 7 - NDX (DBase) Indices</A><br> +<A HREF="xbc8.html">Chapter 8 - MDX (DBase) Indices</A><br> +<A HREF="xbc9.html">Chapter 9 - NTX (Clipper) Indices</A><br> +<A HREF="xbc10.html">Chapter 10 - CDX (FoxPro) Indices</A><br> +<A HREF="xbc11.html">Chapter 11 - IDX (FoxPro) Indices</A><br> +<A HREF="xbc12.html">Chapter 12 - Record and File Locking</A><br> +<A HREF="xbc13.html">Chapter 13 - Logfile Support</A><br> +<A HREF="xbc14.html">Chapter 14 - SQL Support</A><br> + + +</h4> +<h3>Section 2 - Classes and Objects</h3> +<h4> +<A HREF="xbc15.html">Chapter 15 - General Class Information</A><br> + +</h4> +<h3>Section 3 - Appendices</h3> +<h4> +<A HREF="gpl-3.0.txt">Appendix A - GPL Library License</A><br> +<A HREF="xbab.html">Appendix B - Bibliography</A><br> +<A HREF="xbac.html">Appendix C - Library Build Options</A><br> +<A HREF="xbad.html">Appendix D - File Types</A><br> +<A HREF="xbae.html">Appendix E - Error Codes</A><br> +<A HREF="xbaf.html">Appendix F - Utility and Example Programs</A><br> + +</h4> +<p><img src="xbase.jpg"><br><hr> +</BODY> +</HTML> diff --git a/docs/html/xbbib.htm b/docs/html/xbab.html index 70e4e82..809c2ea 100755 --- a/docs/html/xbbib.htm +++ b/docs/html/xbab.html @@ -3,7 +3,7 @@ <TITLE>Xbase DBMS Bibliography</TITLE> <BODY BGCOLOR=#FFFFFF> <H1><p align="center">Xbase DBMS Bibliography</p></H1> -<p align="center">Page Updated 2/1/99</p><hr> +<p align="center">Page Updated 12/9/22</p><hr> Bachman, Erik<br> Xbase File Format Description / Erik Bachman, Roskilde, Denmark: Clickety @@ -59,5 +59,11 @@ The Draft Standard C++ Library by P.J. Plauger, Prentice Hall, New Jersey, H.M Dietel/P.J. Deitel: C++ How To Program, Prentice Hall, Englewod Cliffs, New Jersey 07632<br><br> +Molinaro, Anthony:<br> +SQL Cookbook, O'Reilly Media, Inc, 2005, +Sebastopol CA: ISBN 978-0-596-00976-2<br><br> + +<hr> +<p><img src="xbase.jpg"><br><hr> </BODY> </HTML> diff --git a/docs/html/xbac.html b/docs/html/xbac.html new file mode 100755 index 0000000..0b0fb0b --- /dev/null +++ b/docs/html/xbac.html @@ -0,0 +1,102 @@ +<!DOCTYPE HTML PUBLIC> +<HTML> +<TITLE>Xbase DBMS Appendix C</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H2><p align="center">Library Build Compile Options</p></H2> +<p align="center">Chapter Updated 12/09/22</p><hr> + + + +<center> +<H2>Library Build Compile Options</H2> +<table > +<TABLE BORDER> +<TR VALIGN="BASELINE"> +<TR><TH>Options</TH><TH>Description</TH><TH>Prerequisites - Notes</TH></TR> +<TR><TD>XB_DEBUG_SUPPORT</TD><TD>Include library debugging functionality</TD></TR> +<TR><TD>XB_UTILS_SUPPORT</TD><TD>Build utility programs?</TD></TR> +<TR><TD>XB_EXAMPLES_SUPPORT</TD><TD>Build example programs?</TD></TR> +<TR><TD>XB_MEMO_SUPPORT</TD><TD>Include Memo file support?</TD><TD>Prereq: XB_LINKLIST_SUPPORT</TD></TR> +<TR><TD>XB_LOGGING_SUPPORT</TD><TD>Include logging support?</TD></TR> +<TR><TD>XB_DBF3_SUPPORT</TD><TD>Include DBF Version III support?</TD><TD>At lease one of XB_DBF3_SUPPORT or<br> XB_DBF4_SUPPORT required</TD></TR> +<TR><TD>XB_DBF4_SUPPORT</TD><TD>Include DBF Version IV support?</TD><TD>At least one of XB_DBF3_SUPPORT or<br> XB_DBF4_SUPPORT required</TD></TR> +<TR><TD>XB_LINKLIST_SUPPORT</TD><TD>Include Linklist functionality?</TD></TR> +<TR><TD>XB_LOCKING_SUPPORT</TD><TD>Include File and Record locking support?</TD><TD>Prereq: XB_LINKLIST_SUPPORT</TD></TR> +<TR><TD>XB_FUNCTION_SUPPORT</TD><TD>Include Expression Function support?</TD></TR> +<TR><TD>XB_EXPRESSION_SUPPORT</TD><TD>Include Expression support?</TD><TD>Prereq: XB_FUNCTION_SUPPORT<br>and XB_LINKLIST_SUPPORT</TD></TR> +<TR><TD>XB_NDX_SUPPORT</TD><TD>Include NDX Index support?</TD><TD>Prereq: XB_EXPRESSION_SUPPORT</TD></TR> +<TR><TD>XB_MDX_SUPPORT</TD><TD>Include MDX Index support?</TD><TD>Prereq: XB_EXPRESSION_SUPPORT</TD></TR> +<TR><TD>XB_SQL_SUPPORT</TD><TD>Include SQL support?</TD><TD>Prereq: XB_MEMO_SUPPORT<br>and XB_DBF4_SUPPORT</TR> +<TR><TD>XB_INF_SUPPORT</TD><TD>Include INF support (Provides auto open functions for NDX indices)</TD></TR> +<TR><TD>XB_FILTER_SUPPORT</TD><TD>Include Filter support</TD><TD>Prereq: XB_EXPRESSION_SUPPORT</TD></TR> +</TABLE></center> + + + +<br><br><hr><br><br> +<center><h2>CMake</h2></center> +The Xbase library is built using the CMake build manager. Cmake provides the architecture for +building cross platform projects with a unified build system. If you are not familiar with CMake, +you can familiarize yourself with it at https://cmake.org +<br><br> +To modify the XBase64 compile options take the following steps:<br><br><br> + +1) Identify which platform you want to build and identify the correct build folder +<table border=1> +<tr><td>/xbase64-4.x.x/build/borland5.5</td><td>Older free Borland 5.5 32 bit Windows compiler</td></tr> +<tr><td>/xbase64-4.x.x/build/linux32</td><td>Linux 32 bit build folder</td></tr> +<tr><td>/xbase64-4.x.x/build/linux64</td><td>Linux 64 bit build folder</td></tr> +<tr><td>/xbase64-4.x.x/build/win32vs</td><td>Windows 32 bit Visual Studio folder</td></tr> +<tr><td>/xbase64-4.x.x/build/win64vs</td><td>Windows 64 bit Visual Studio folder</td></tr> +<tr><td>/xbase64-4.x.x/build/mac64</td><td>MAC 64 but folder</td></tr> +</table> + +<br><br><br> +2) Navigate to the appropriate folder identified in step 1. Once you are in the correct folder, +verify there is a <em>CmakeLists.txt</em> file. That file is the main librbary build configuration file. +<br><br> + +3) Select one if the following methods to update the config options +<table border=1> +<tr><td>For Windows users, use program cmake-gui.exe</td></tr> +<tr><td>For Unix/Linux/Mac users, use program cmake-gui</td></tr> +<tr><td>For Unix command line, use program "ccmake ."</td></tr> +<tr><td>Or manually edit the <em>CmakeLists.txt</em> file with your favorite text editor</td></tr> +</table> +<br><br><br> +<hr><br><br><br> +<center><h2>Debug Support <em>(Option: XB_DEBUG_SUPPORT)</em></h2></center> +The following methods are included from the library when the XB_DEBUG_OPTION is turned on. They +are mainly used for library debugging purposes and can be safely left turned off.<br><br> +<center><table border=1> +<TR><TH>Method/Function</TH><TH>Description</TH></TR> +<tr><td>xbDate::Dump()</td><td>Dump the xbDate object internals to stdout</td></tr> +<tr><td>xbDate::DumpDateTable()</td><td>Dump internal date tables to stdout</td></tr> +<tr><td>xbDbf::DumpTableLockStatus()</td><td>Dump internal locking status / structures</td></tr> +<tr><td>xbExp::DumpToken()</td><td>Dump expression values</td></tr> +<tr><td>xbExp::DumpTree()</td><td>Dump expression token tree</td></tr> +<tr><td>xbExpNode::DumpToken()</td><td>Dump expression node values</td></tr> +<tr><td>xbFile::DumpBlockToDisk</td><td>Dump specified block of data to a disk file</td></tr> +<tr><td>xbIx::DumpNode</td><td>Dump index node header</td></tr> +<tr><td>xbIxMdx::DumpBlock</td><td>Dump MDX index block</td></tr> +<tr><td>xbIxMdx::DumpFreeBlocks</td><td>Dump MDX free block chain</td></tr> +<tr><td>xbIxMdx::DumpHeader</td><td>Dump MDX file header info</td></tr> +<tr><td>xbIxMdx::DumpIxForTag</td><td>Dump MDX index keys and values for a given tag</td></tr> +<tr><td>xbIxMdx::DumpIxNodeChain</td><td>Dump MDX current memory node linked list for a given tag</td></tr> +<tr><td>xbIxMdx::DumpTagBlocks</td><td>Dump MDX blocks for a given tag</td></tr> +<tr><td>xbIxNdx::DumpHeader</td><td>Dump MDX file header info</td></tr> +<tr><td>xbIxNdx::DumpIxNodeChain</td><td>Dump MDX current memory node linked list for a given tag</td></tr> +<tr><td>xbIxNdx::DumpNode</td><td>Dump index node header</td></tr> +<tr><td>xbIxNdx::DumpTagBlocks</td><td>Dump NDX blocks for a given tag</td></tr> +<tr><td>xbMemoDbt3::DumpMemoFreeChain()</td><td>Place holder</td></tr> +<tr><td>xbMemoDbt4::DumpMemoFreeChain()</td><td>Dump list of free blocks available for reuse</td></tr> +<tr><td>xbMemoDbt4::DumpMemoInternals()</td><td>Dump V4 memo file internals</td></tr> +<tr><td>xbString::Dump()</td><td>Dump string internals</td></tr> +<tr><td>xbString::DumpHex()</td><td>Dump string internals in hex</td></tr> +</table></center> + + +<br><hr><br><br> +<p><img src="xbase.jpg"><br><hr> +</BODY> +</HTML> diff --git a/docs/html/xbad.html b/docs/html/xbad.html new file mode 100755 index 0000000..7356b7b --- /dev/null +++ b/docs/html/xbad.html @@ -0,0 +1,27 @@ +<!DOCTYPE HTML PUBLIC> +<HTML> +<TITLE>Xbase DBMS Appendix D</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H2><p align="center">File Types</p></H2> +<p align="center">Chapter Updated 12/09/22</p><hr> + +<h3>Supported File Types.</h3> + +All supported file types have one the following file extensions: +The extensions are allway upper case.<br><br> + + +<table > +<TABLE BORDER> +<TR VALIGN="BASELINE"> +<TR><TH>File Type</TH><TH>Description</TH></TR> +<TR><TD>*.DBF</TD><TD>Main database file or Table</TD></TR> +<TR><TD>*.DBT</TD><TD>Memo file data</TD></TR> +<TR><TD>*.INF</TD><TD>INF - Behave like MS ODBC File. Used to auto open NDX index file</TD></TR> +<TR><TD>*.MDX</TD><TD>Production V4 index file, contains up to 47 tags. Automatically opened.</TD></TR> +<TR><TD>*.NDX</TD><TD>Non production V3 index files. Contains one tag per file. Automatically opened if included in ocrreespondin INF file.</TD></TR> +</TABLE> +<br><hr><br> +<p><img src="xbase.jpg"><br><hr> +</BODY> +</HTML> diff --git a/docs/html/xbae.html b/docs/html/xbae.html new file mode 100755 index 0000000..5f1dce6 --- /dev/null +++ b/docs/html/xbae.html @@ -0,0 +1,94 @@ +<!DOCTYPE HTML PUBLIC> +<HTML> +<TITLE>Xbase DBMS Appendix E</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H2><p align="center">Eror Codes</p></H2> +<p align="center">Chapter Updated 12/09/22</p><hr> + +<h3>Error Codes and Error Processing</h3> + +Alomost all Xbase64 methods and functions return and xbInt16 return code, which is zero or positive on success and negative +if an error condition occurs. +<br><br> +As of the 4.x.x release, the library has been extensively updated to use exception processing and most error +conditions will result in a mesage written to the logfile if logfile processing is enabled. The error routines +typically write two values to the logfile, an error code value and an iErrorStop value which identifies where +exactly in the library code the error occurred. +<br><br> +Error codes are defined in the xbretcod.h file.<br><br><br> + + +<TR><TH>File Type</TH><TH>Description</TH></TR> +<TR><TD>*.DBF</TD><TD>Main database file or Table</TD></TR> +<TR><TD>*.DBT</TD><TD>Memo file data</TD></TR> +<TR><TD>*.INF</TD><TD>INF - Behave like MS ODBC File. Used to auto open NDX index file</TD></TR> +<TR><TD>*.MDX</TD><TD>Production V4 index file, contains up to 47 tags. Automatically opened.</TD></TR> +<TR><TD>*.NDX</TD><TD>Non production V3 index files. Contains one tag per file. Automatically opened if included in ocrreespondin INF file.</TD></TR> + + +<br><br><br> +<table > +<TABLE BORDER> +<TR VALIGN="BASELINE"> +<TR><TH>Description</TH><TH>Error Code</TH><TH>Category</TH></TR> +<TR><TD> XB_NO_ERROR </TD><TD> 0 </TD><TD> general </TD></TR> +<TR><TD> XB_NO_MEMORY </TD><TD> -100 </TD><TD> general </TD></TR> +<TR><TD> XB_INVALID_OPTION </TD><TD> -101 </TD><TD> general </TD></TR> +<TR><TD> XB_DUP_TABLE_OR_ALIAS </TD><TD> -110 </TD><TD> table manager </TD></TR> +<TR><TD> XB_INVALID_NODELINK </TD><TD> -120 </TD><TD> linklist </TD></TR> +<TR><TD> XB_KEY_NOT_UNIQUE </TD><TD> -121 </TD><TD> linklist </TD></TR> +<TR><TD> XB_FILE_EXISTS </TD><TD> -200 </TD><TD> file </TD></TR> +<TR><TD> XB_ALREADY_OPEN </TD><TD> -201 </TD><TD> file </TD></TR> +<TR><TD> XB_DBF_FILE_NOT_OPEN </TD><TD> -202 </TD><TD> file </TD></TR> +<TR><TD> XB_FILE_NOT_FOUND </TD><TD> -203 </TD><TD> file </TD></TR> +<TR><TD> XB_FILE_TYPE_NOT_SUPPORTED</TD><TD> -204 </TD><TD> file </TD></TR> +<TR><TD> XB_RENAME_ERROR </TD><TD> -205 </TD><TD> file </TD></TR> +<TR><TD> XB_INVALID_OBJECT </TD><TD> -206 </TD><TD> file </TD></TR> +<TR><TD> XB_NOT_OPEN </TD><TD> -207 </TD><TD> file </TD></TR> +<TR><TD> XB_NOT_FOUND </TD><TD> -208 </TD><TD> file </TD></TR> +<TR><TD> XB_OPEN_ERROR </TD><TD> -209 </TD><TD> file </TD></TR> +<TR><TD> XB_CLOSE_ERROR </TD><TD> -210 </TD><TD> file </TD></TR> +<TR><TD> XB_SEEK_ERROR </TD><TD> -211 </TD><TD> file </TD></TR> +<TR><TD> XB_READ_ERROR </TD><TD> -212 </TD><TD> file </TD></TR> +<TR><TD> XB_WRITE_ERROR </TD><TD> -213 </TD><TD> file </TD></TR> +<TR><TD> XB_EOF </TD><TD> -214 </TD><TD> file </TD></TR> +<TR><TD> XB_BOF </TD><TD> -215 </TD><TD> file </TD></TR> +<TR><TD> XB_INVALID_BLOCK_SIZE </TD><TD> -216 </TD><TD> file </TD></TR> +<TR><TD> XB_INVALID_BLOCK_NO </TD><TD> -217 </TD><TD> file </TD></TR> +<TR><TD> XB_INVALID_RECORD </TD><TD> -218 </TD><TD> file </TD></TR> +<TR><TD> XB_DELETE_FAILED </TD><TD> -219 </TD><TD> file </TD></TR> +<TR><TD> XB_INVALID_TABLE_NAME </TD><TD> -220 </TD><TD> file </TD></TR> +<TR><TD> XB_EMPTY </TD><TD> -221 </TD><TD> file </TD></TR> +<TR><TD> XB_LIMIT_REACHED </TD><TD> -222 </TD><TD> file </TD></TR> +<TR><TD> XB_INVALID_FIELD_TYPE </TD><TD> -300 </TD><TD> field </TD></TR> +<TR><TD> XB_INVALID_FIELD_NO </TD><TD> -301 </TD><TD> field </TD></TR> +<TR><TD> XB_INVALID_DATA </TD><TD> -302 </TD><TD> field </TD></TR> +<TR><TD> XB_INVALID_FIELD_NAME </TD><TD> -303 </TD><TD> field </TD></TR> +<TR><TD> XB_INVALID_MEMO_FIELD </TD><TD> -304 </TD><TD> field </TD></TR> +<TR><TD> XB_INVALID_FIELD </TD><TD> -305 </TD><TD> field </TD></TR> +<TR><TD> XB_INVALID_FIELD_LEN </TD><TD> -306 </TD><TD> field </TD></TR> +<TR><TD> XB_INVALID_DATE </TD><TD> -307 </TD><TD> date field </TD></TR> +<TR><TD> XB_INVALID_LOCK_OPTION </TD><TD> -400 </TD><TD> lock </TD></TR> +<TR><TD> XB_LOCK_FAILED </TD><TD> -401 </TD><TD> lock </TD></TR> +<TR><TD> XB_TABLE_NOT_LOCKED </TD><TD> -402 </TD><TD> lock - need table locked for operation </TD></TR> +<TR><TD> XB_PARSE_ERROR </TD><TD> -500 </TD><TD> expression </TD></TR> +<TR><TD> XB_INVALID_FUNCTION </TD><TD> -501 </TD><TD> expression </TD></TR> +<TR><TD> XB_INVALID_PARM </TD><TD> -502 </TD><TD> expression </TD></TR> +<TR><TD> XB_INCONSISTENT_PARM_LENS </TD><TD> -503 </TD><TD> expression </TD></TR> +<TR><TD> XB_INCOMPATIBLE_OPERANDS </TD><TD> -504 </TD><TD> expression </TD></TR> +<TR><TD> XB_UNBALANCED_PARENS </TD><TD> -505 </TD><TD> expression </TD></TR> +<TR><TD> XB_UNBALANCED_QUOTES </TD><TD> -506 </TD><TD> expression </TD></TR> +<TR><TD> XB_INVALID_EXPRESSION </TD><TD> -507 </TD><TD> expression </TD></TR> +<TR><TD> XB_INVALID_KEYNO </TD><TD> -600 </TD><TD> index </TD></TR> +<TR><TD> XB_INVALID_INDEX </TD><TD> -601 </TD><TD> index file error </TD></TR> +<TR><TD> XB_INVALID_TAG </TD><TD> -602 </TD><TD> invalid index tag name, must be <= 10 bytes </TD></TR> +<TR><TD> XB_INVALID_PAGE </TD><TD> -603 </TD><TD> invalid index page </TD></TR> +<TR><TD> XB_SYNTAX_ERROR </TD><TD> -700 </TD><TD> sql syntax error </TD></TR> +</TABLE> + + + +<br><hr><br> +<p><img src="xbase.jpg"><br><hr> +</BODY> +</HTML> diff --git a/docs/html/xbc15.htm b/docs/html/xbaf.html index 89bab09..110db7b 100755 --- a/docs/html/xbc15.htm +++ b/docs/html/xbaf.html @@ -3,11 +3,25 @@ <TITLE>Xbase DBMS Chapter 15</TITLE> <BODY BGCOLOR=#FFFFFF> <H1><p align=center>Sample Programs</p></H1> -<p align=center>Page Updated 11/30/22</p><hr><br><br> -Sample Xbase DBMS programs include in the library.<br><br> +<p align=center>Page Updated 12/20/22</p><hr><br><br> + <CENTER> <TABLE BORDER> -<CAPTION ALIGN=TOP><H3>XBase Sample Programs</H3></CAPTION> +<CAPTION ALIGN=TOP><H3>XBase Example Programs</H3></CAPTION> +<TR ALIGN=BASELINE> +<TR><TH ALIGN=LEFT>Program<TD>Program Description +<TR><TH ALIGN=LEFT>xb_ex_string<TD>Example program to demonstrate xbString class usage +<TR><TH ALIGN=LEFT>xb_ex_v3_create_dbf<TD>Example program to create V3 DBF file +<TR><TH ALIGN=LEFT>xb_ex_v3_upd_dbf<TD>Example program to update V3 DBF file +<TR><TH ALIGN=LEFT>xb_ex_v4_create_dbf<TD>Example Program to create V4 DBF file +<TR><TH ALIGN=LEFT>xb_ex_v4_upd_dbf<TD>Example program to update V4 DBF file +</TABLE></CENTER> +<br><br> + + +<CENTER> +<TABLE BORDER> +<CAPTION ALIGN=TOP><H3>XBase Utility Programs</H3></CAPTION> <TR ALIGN=BASELINE> <TR><TH ALIGN=LEFT>Program<TD>Program Description <TR><TH ALIGN=LEFT>xb_cfg_check<TD>This program prints the compile settings and options in use @@ -16,18 +30,15 @@ Sample Xbase DBMS programs include in the library.<br><br> <TR><TH ALIGN=LEFT>xb_deletall<TD>This program marks all records in a DBF file for deletion <TR><TH ALIGN=LEFT>xb_dumpdbt<TD>Debug memo files <TR><TH ALIGN=LEFT>xb_dumphdr<TD>This program opens an Xbase file and prints its header -<TR><TH ALIGN=LEFT>xb_dumprecs<TD>This program dumps records for an X-Base file -<TR><TH ALIGN=LEFT>xb_ex_string<TD>Example string program -<TR><TH ALIGN=LEFT>xb_ex_v3_create_dbf<TD>Example program to create V3 DBF file -<TR><TH ALIGN=LEFT>xb_ex_v3_upd_dbf<TD>Example program to update V3 DBF file -<TR><TH ALIGN=LEFT>xb_ex_v4_create_dbf<TD>Example Program to create V4 DBF file -<TR><TH ALIGN=LEFT>xb_ex_v4_upd_dbf<TD>Example program to update V4 DBF file +<TR><TH ALIGN=LEFT>xb_dumprecs<TD>This program dumps records for an XBase file <TR><TH ALIGN=LEFT>xb_execsql<TD>This program executes SQL statements <TR><TH ALIGN=LEFT>xb_pack<TD>This program packs (removes deleted records) from a DBF database file <TR><TH ALIGN=LEFT>xb_undelall<TD>This program undeletes all deleted records in a dbf file <TR><TH ALIGN=LEFT>xb_zap<TD>This program removes all records from a DBF file </TABLE></CENTER> <br><br> + + <hr> <p><img src="xbase.jpg"><br><hr> </BODY> diff --git a/docs/html/xbc1.htm b/docs/html/xbc1.html index bb04aec..c07e5f6 100755 --- a/docs/html/xbc1.htm +++ b/docs/html/xbc1.html @@ -4,7 +4,7 @@ <BODY BGCOLOR=#FFFFFF> <h1><p align="center">Getting Started</p></h1> -<p align="center">Chapter Updated 11/21/22</p> +<p align="center">Chapter Updated 12/09/22</p> <hr><h2>Overview</h2> @@ -25,7 +25,7 @@ with DBase III (TM) and DBase IV (TM) version data files and indices *.DBF (data), *.NDX (single tag index), *.MDX (multi tag index) and *.DBT (memo).<br><br> -Version 4.x.x is a major rewrite of the library to strenghen error +Version 4.x.x is a major rewrite of the library to strengthen error processing and bring consistency across modules. It includes updates to the locking process and also includes a module to support MDX multi tag indices.<br><br> @@ -35,6 +35,20 @@ and that code will be re-incorporated into the latest version in the future. +<br><br> +<B>Why use the Xbase library? </B> +The DBF file format is a ubiquitous industry standard with +widespread usage and application. Using this standard file format removes any +<em>vender specific</em> locks that bind you to a particular platform. +Additionally, with Xbase64 only the options needed can be compiled into or out of the library +to provide a custom configuration specific to project requirements. +For a small footprint, locking, memo fields and indices could be excluded from +the library build which would reduce the library size. +This tool is usefull for small to medium sized apps that don't need all the +overhead, sophistication and cost of a complex client server configuration. +The Xbase library is designed to be flexible in which options can be compiled +into or out fo the library and also which environments it can be run on. + <br><br><br> @@ -71,6 +85,7 @@ Xbase64 defines the following field types:<br><br><br> <CAPTION ALIGN=TOP><h3>Field Types</h3></CAPTION> <TR ALIGN=BASELINE> <TR><TH ALIGN=LEFT>Type<TD>Description +<TR><TH ALIGN=LEFT>xbBool<TD>Contains xbTrue (0) or xbFalse (1) <TR><TH ALIGN=LEFT>xbInt16<TD>16 bit int <TR><TH ALIGN=LEFT>xbUInt16<TD>16 bit unsigned int <TR><TH ALIGN=LEFT>xbInt32<TD>32 bit int @@ -178,8 +193,7 @@ Maximum index key length - 100 bytes<br> Maximum .DBT file memo block size - 32256<br> Maximum expression result length - 100 bytes<br> Maximum NDX index key length - 100 bytes<br><br> -<hr><br><br> - +<hr><br> <p><img src=xbase.jpg><br><hr> </BODY> </HTML> diff --git a/docs/html/xbc10.htm b/docs/html/xbc10.html index 04f5158..04f5158 100755 --- a/docs/html/xbc10.htm +++ b/docs/html/xbc10.html diff --git a/docs/html/xbc11.htm b/docs/html/xbc11.html index 4230f3f..4230f3f 100755 --- a/docs/html/xbc11.htm +++ b/docs/html/xbc11.html diff --git a/docs/html/xbc12.htm b/docs/html/xbc12.html index f9fe114..a40c7e0 100755 --- a/docs/html/xbc12.htm +++ b/docs/html/xbc12.html @@ -1,9 +1,9 @@ <!DOCTYPE HTML PUBLIC> <HTML> -<TITLE>Xbase DBMS Chapter 8</TITLE> +<TITLE>Xbase DBMS Chapter 12</TITLE> <BODY BGCOLOR=#FFFFFF> <H1><p align="center">Record and File Locking</p></H1> -<p align="center">Chapter Updated 11/29/22</p><hr> +<p align="center">Chapter Updated 12/13/22</p><hr> <h3>Locking Overview</h3> @@ -15,9 +15,12 @@ can cause the files to become inaccurate and unusable.<br><br> Automatic record locking is on by default in the Xbase64 library. To disable it, use method xbXBase::DisableDefaultAutoLock() and to enable it, use method xbXBase::EnableDefaultAutoLock(). - -Locking can also be enabled / disabled at the table level with with xbDbf::SetAutoLock(). - +<br><br> +Locking can also be enabled / disabled at the table level with with xbDbf::SetAutoLock().<br><br> +If autolocking is disabled and the code base is being used in a multi user environment, it is +up to the application program to verify the needed locks are set as there is no checking or +setting any locks if autolocking is turned off. It is only safe to turn off the autolocking functionality +if the library is being used in a single user environment. <br><br> The current Xbase64 record locking logic is modeled after DBase (tm) V7 locking. @@ -55,17 +58,28 @@ be simultaneously opened with a program on the Unix box. That could cause some In Unix, a program can not lock a file so another process can not access it.<br> In Windows, a program can lock a file so another process can not access it.<br> DBase(tm) supports routines to open files exclusively, preventing other users from opening a file.<br> +Locking on the Mac/Apple platform only works on NFS shares. It does not work with SMB shares. <br><h3>Samba settings</h3> If you will be using Samba on Linux/Unix and sharing files between Linux and Windows machines, you will need to disable oplocks. In the smb.conf file, set:<br> -<h4>oplocks = no</h4> +<br> +[sharename]<br> +oplocks = False<br> +level2 oplocks = False + + +<br><h3>iLockFlavor</h3> + +The library was constructed in a manner so that it could be updated to support alternate lock "flavors". +The 4.x.x library is built to mirror the DBase locking, but the structure is in place to expand to other locking +types if needed. -<br> +<br><br><br> <hr><br> <p><img src="xbase.jpg"><br><hr> </BODY> diff --git a/docs/html/xbc13.htm b/docs/html/xbc13.html index 9f51a85..9f51a85 100755 --- a/docs/html/xbc13.htm +++ b/docs/html/xbc13.html diff --git a/docs/html/xbc14.htm b/docs/html/xbc14.htm deleted file mode 100755 index fdcf949..0000000 --- a/docs/html/xbc14.htm +++ /dev/null @@ -1,12 +0,0 @@ -<!DOCTYPE HTML PUBLIC> -<HTML> -<TITLE>Xbase DBMS Chapter 14</TITLE> -<BODY BGCOLOR=#FFFFFF> -<H2><p align="center">CDX Indices</p></H2> -<p align="center">Chapter Updated 11/30/22</p><hr> - -<h3>Pending SQL module development.</h3> - -<hr> -</BODY> -</HTML> diff --git a/docs/html/xbc14.html b/docs/html/xbc14.html new file mode 100755 index 0000000..2c086df --- /dev/null +++ b/docs/html/xbc14.html @@ -0,0 +1,113 @@ +<!DOCTYPE HTML PUBLIC> +<HTML> +<TITLE>Xbase DBMS Chapter 14</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H2><p align="center">CDX Indices</p></H2> +<p align="center">Chapter Updated 12/08/22</p><hr> + +<h3>SQL Command Status</h3> + +Development of SQL support is still underway and very preliminary. As of the 4.0.3 version, the following SQL commands +are available.<br><br> +The SQL commands are modeled after industry standard SQL specifications and do what you would expect an SQL command to do. +<br> +Use of <em>[brackets]</em> in this chapter identifies optional components of a given command. +<br><br> +<hr> +<h3>ALTER TABLE</h3> +Expected format:<br> +ALTER TABLE tablename.DBF RENAME TO newtablename.DBF +<br><br> +<hr> +<h3>CREATE INDEX</h3> +Expected format to create an Dbase 3, NDX index:<br> +CREATE INDEX ixname.NDX ON tablename.dbf ( EXPRESSION ) [ASSOCIATE] + +<br><br> +Expected format to create an Dbase 4, tag on an MDX index:<br> +CREATE [UNIQUE] INDEX tagname ON tablename.DBF ( EXPRESSION ) [DESC] [FILTER .NOT. DELETED()] + +<br><br> +The ASSOCIATE parameter is specific to Xbase64 library, it is used to associate non production (NDX) index file to a dbf +file so it will be automatically opened with the dbf file whenever the dbf file is opened by the xbase64 routines. +<br><br> +The [ASSOCIATE] parameter is not used with MDX production indices +<br><br> +Xbase first looks for ".NDX" in the file name to determine if an NDX index should be created. +If .NDX is not in the filename, it looks in the uda for "IXTYPE" for either NDX or MDX to +detmermine the index type to create. if IXTYPE is not found, it creates an MDX tag. +<br><br> +The optional DESC parameter defines an entire index key as descending. This is +different than other SQL implementations where specific fields can be descending. +<br><br> +The optional FILTER parameter is specific to the XBASE64 library, is it used to assign a filter to a tag in an +MDX style index. Everything to the right of the keyword FILTER is considered part of the filter. +<br><br> +The original DBASE indices used to '+' to create an index on more than one field +<br>ie: FIELD1+FIELD2+FIELD3 +<br><brSQL uses commas: ie: FIELD1, FIELD2, FIELD3 +<br> +The Xbase library supports either '+' or ',' when creating mutli field indices. +<br><br> +<hr> + + + +<h3>CREATE TABLE</h3> +Expected format:<br> +CREATE TABLE tablename.dbf (Field1 CHAR(10), INTFLD1 INTEGER, ... ) +<br><br> +<table border=1> +<tr><th>SQL TYPE</th><th>XBASE Field Type</th></tr> +<tr><td>SMALLINT</td><td>NUMERIC(6,0)</td></tr> +<tr><td>INTEGER</td><td>NUMERIC(11,0)</td></tr> +<tr><td>DECIMAL(x,y)</td><td>NUMERIC(x+1,y)</td></tr> +<tr><td>NUMERIC(x,y)</td><td>NUMERIC(x,y)</td></tr> +<tr><td>FLOAT(x,y)</td><td>FLOAT(x,y)</td></tr> +<tr><td>CHAR(n)</td><td>CHARACTER(n)</td></tr> +<tr><td>DATE</td><td>DATE</td></tr> +<tr><td>VARCHAR</td><td>MEMO</td></tr> +<tr><td>LOGICAL</td><td>LOGICAL</td></tr> +</table> +<br> +<hr> + + +<h3>DELETE</h3> +Expected format:<br> +DELETE FROM tablename.DBF [WHERE expression] +<br><br> +<hr> + + +<h3>DROP INDEX</h3> +Expected format:<br> +DROP INDEX [IF EXISTS] ixname.NDX ON tablename.DBF<br> +DROP INDEX [IF EXISTS] tagname ON tablename.DBF<br> +<br> + + +<hr> +<h3>DROP TABLE</h3> +Expected format:<br> +DROP TABLE [IF EXISTS] tablename.DBF +<br> +<hr> +<h3>INSERT</h3> +Expexted format:<br> +INSERT INTO tablename (field1, field2, field3,...) VALUES ( 'charval', numval, 'what is the correct odbc date format to use? CCYYMMDD'); +<br><br> +<hr> +<h3>SET</h3> +Used to set a variable name<br> +Expected format:<br> +SET ATTRIBUTE = DATAVALUE<br> +SET ATTRIBUTE = ^ (to delete an entry) <br> +<br> +<hr><br><br> +<p><img src=xbase.jpg><br><hr> + +</BODY> +</HTML> + + diff --git a/docs/html/xbc15.html b/docs/html/xbc15.html new file mode 100755 index 0000000..136724d --- /dev/null +++ b/docs/html/xbc15.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC> +<HTML> +<TITLE>Xbase DBMS Chapter 15</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H2><p align="center">Class Inventory</p></H2> +<p align="center">Chapter Updated 12/24/22</p><hr> +<br> +<center><h3>Class Descriptions</h3></center> + +<center> +<table border=1> +<tr><th>Class</th><th>Description</th></tr> +<tr><td>xbBcd</td><td>Supports binary coded deciemal data</td></tr> +<tr><td>xbDate</td><td>Support date operations on a given date formatted as YYYYMMDD</td></tr> +<tr><td>xbDbf</td><td>Base class for DBF file handling. If you are adding support for a new file type, <br>derive new file type class from this.</td></tr> +<tr><td>xbDbf3</td><td>Derived from xbDbf, supports DBase V3 files</td></tr> +<tr><td>xbDbf4</td><td>Derived from xbDbf, supports DBase V4 files</td></tr> +<tr><td>xbExp</td><td>Class for supporting expression logic</td></tr> +<tr><td>xbExpNode</td><td>Class definition of a single node, utilized by xbExp</td></tr> +<tr><td>xbFile</td><td>Main file class. If you are porting this library to another platform, start here</td></tr> +<tr><td>xbFilter</td><td>Supports filters</td></tr> +<tr><td>xbIx</td><td>Base class for index file support. If you are adding support for a new index type, <br>derive new index type class from this.</td></tr> +<tr><td>xbIxNdx</td><td>Derived from xbIx, supports NDX style indices.</td></tr> +<tr><td>xbIxMdx</td><td>Derived from xbIx, supports MDX style indices</td></tr> +<tr><td>xbLinkList</td><td>Class supporting linked list functionality</td></tr> +<tr><td>xbLinkListOrd</td><td>Class supporting ordered linked list functionality</td></tr> +<tr><td>xbLinkListNode</td><td>Class defining one node, used by xbLinkList and xbLinkListOrd</td></tr> +<tr><td>xbLog</td><td>Class supporting general log file activity</td></tr> +<tr><td>xbMemo</td><td>Base class for supporting memo (.DBT) files. If you are adding support for a new memo type, <br>derive new memo type class from this.</td></tr> +<tr><td>xbMemoDbt3</td><td>Derived from xbMemo, supports V3 Memo files</td></tr> +<tr><td>xbMemoDbt4</td><td>Derived from xbMemo, supports V3 Memo files</td></tr> +<tr><td>xbSql</td><td>Supports SQL access</td></tr> +<tr><td>xbSsv</td><td>Base class, shared system values</td></tr> +<tr><td>xbString</td><td>String handling class</td></tr> +<tr><td>xbTag</td><td>Class to support index tags</td></tr> +<tr><td>xbTblMgr</td><td>Class used internally in the library for managing multiple open files/tables</td></tr> +<tr><td>xbUda</td><td>Class for supporting fields for the xbSql functions. Stands for User data area</td></tr> +<tr><td>xbXBase</td><td>Class to tie everything together. Every application program starts with one of these</td></tr> +</table> +</center> + +<hr> +<br><br> +Fix me... +<p><img src="Xbase64ClassDiagram.jpg"><br> + +<br><br> +<hr> +<p><img src="xbase.jpg"><br><hr> +</BODY> +</HTML> diff --git a/docs/html/xbc2.htm b/docs/html/xbc2.html index 72a6009..72a6009 100755 --- a/docs/html/xbc2.htm +++ b/docs/html/xbc2.html diff --git a/docs/html/xbc3.htm b/docs/html/xbc3.html index f2f4a1d..f2f4a1d 100755 --- a/docs/html/xbc3.htm +++ b/docs/html/xbc3.html diff --git a/docs/html/xbc4.htm b/docs/html/xbc4.html index f494629..a0275ed 100755 --- a/docs/html/xbc4.htm +++ b/docs/html/xbc4.html @@ -3,7 +3,7 @@ <TITLE>Xbase DBMS Chapter 4</TITLE> <BODY BGCOLOR=#FFFFFF> <H1><p align="center">Date Processing</p></H1> -<p align="center">Chapter Updated 2/12/99</p><hr> +<p align="center">Chapter Updated 12/09/22</p><hr> The objective of this chapter is to provide information regarding the basic concepts of date arithmetic and supply generic @@ -56,7 +56,8 @@ To calculate a future or past date, convert the base date to a Julian date, add (or subtract) the number of days necessary to (from) it and convert the julian date back to a Gregorian date.<br><br> -The Julian date routines use a base date of 01/01/0001.<br><br> +The Julian date routines use a base date of 01/01/0001. DBase julian Dates have an offset of 1721425L, reason unknown. +<br><br> <h2>Gregorian Dates</h2> diff --git a/docs/html/xbc5.htm b/docs/html/xbc5.html index f798125..9708b17 100755 --- a/docs/html/xbc5.htm +++ b/docs/html/xbc5.html @@ -3,7 +3,7 @@ <title>Xbase DBMS Chapter 5</title> <body bgcolor=#FFFFFF> <h1><p align="center">Expression Handling<br></h1> -<p align="center">Chapter Updated 11/27/22</p><hr> +<p align="center">Chapter Updated 12/26/22</p><hr> <h3>Overview</h3> @@ -39,7 +39,6 @@ If an expression will be processed repeatedly, it is best to pre-parse the tree using <em>ParseExpression</em>, then for each new call to the expression, execute method <em>ProcessExpression</em> which processes the tree. - <h3>Expression Return Types</h3> Expressions will return a type of CHAR, NUMERIC, DATE or LOGICAL.<br><br> @@ -72,7 +71,7 @@ slightly more efficient to call the C++ functions directly, rather than execute the expression parsing routines.<br><br> To add a new function, find a function that is similar to what you need, copy -the code and modify xbxbase.h, xbfuncs.cpp, xbexp.cpp and xb_test_expression.cpp. +the code and modify xbxbase.h, xbfuncs.cpp, xbexp.cpp and xb_test_expression.cpp.<br><br> <table border=1> @@ -116,7 +115,7 @@ the code and modify xbxbase.h, xbfuncs.cpp, xbexp.cpp and xb_test_expression.cpp <tr><td>SQRT</td><td>N</td><td>Calculate square root</td></tr> <tr><td>STOD</td><td>D</td><td>Convert 8 byte CCYYMMDD date to date</td></tr> <tr><td>STR</td><td>C</td><td>Convert number to character string</td></tr> -<tr><td>STRZERO</td><td>C</td><td>Convert number to character string with leading zeroes</td></tr> +<tr><td>STRZERO</td><td>C</td><td>Convert number to character string with leading zeroes. Clipper Function.</td></tr> <tr><td>SUBSTR</td><td>C</td><td>Extract portion oif one string from another string</td></tr> <tr><td>TRIM</td><td>C</td><td>Trim left and right sides of a string</td></tr> <tr><td>UPPER</td><td>C</td><td>Conver lower case to upper case</td></tr> @@ -145,8 +144,6 @@ of database->fieldname. <tr><td>DATE</td><td>{10/07/60} or {02/09/1989}</td></tr> </table> - - <br><br> <h3>Expression Operators</h3> <table border=1> @@ -187,10 +184,11 @@ of database->fieldname. </table> <br><br> -<h3>Examples</h3> +<h3>Example Expressions</h3> <li>CUSTOMERS->LNAME + ", " + CUSTOMERS->FNAME <li>LNAME + ", " + FNAME <li>STARTDT + 90 +<li>DATE() - 7 <li>YEAR( TODAY() ) <li>IIF( "A" = "N", "true result", "false result" ) <li>IIF( "A" = "N" .OR. 2 > 1 , "true result", "false result" ) @@ -199,6 +197,11 @@ of database->fieldname. <br><br> +<h3>Example program</h3> +For an example on how to use the expression logic, see program +<em>src/examples/xb_ex_expression.cpp</em>. +<br><br> + <hr> <p><img src="xbase.jpg"><br><hr> </BODY> diff --git a/docs/html/xbc6.htm b/docs/html/xbc6.html index a7e1746..094545f 100755 --- a/docs/html/xbc6.htm +++ b/docs/html/xbc6.html @@ -3,7 +3,7 @@ <TITLE>Xbase DBMS Chapter 6</TITLE> <BODY BGCOLOR=#FFFFFF> <H1><p align="center">Index Overview</p></H1> -<p align="center">Chapter Updated 11/27/222</p><hr> +<p align="center">Chapter Updated 12/09/22</p><hr> The objective of this chapter is to provide information regarding the basic concepts of index processing for the Xbase library.<br><br> @@ -27,6 +27,13 @@ Each index file contains one or more tags depending on the file type. Each tag and has characteristics: Sort order (ASC or DESC), unique or not unique and some formats support filtering. Each open table (dbf file) has an "active tag" for database operations. +<h2>Index processing design</h2> + +The library is construcuted to handle index files with multiple tags per file. Single tag files like the NDX indices +are treated as a multi tag file, but there is only one tag. This allows for maximum flexibility for future +additional index types. + + <h2>Index updates</h2> @@ -129,7 +136,16 @@ The library automatically updates all tags in all open index files. <td>xbDbf::SetCurTag</td><td>Set current tag.</td> </tr> </table> +<br><br> +<h2>Internal Data Storage</h2> +<table border=1> +<tr><th>Type<th>Stored in DBF as</th><th>Stored in NDX as</th><th>Stored in MDX as</th></tr> +<tr><td>C</td><td>Character data</td><td>Character data</td><td>Character data</td></tr> +<tr><td>F</td><td>Text numbers</td><td>xbDouble</td><td>xbBcd</td></tr> +<tr><td>N</td><td>Text numbers</td><td>xbDouble</td><td>xbBcd</td></tr> +<tr><td>D</td><td>Text YYYYMMDD</td><td>xbDouble Julian</td><td>xbDouble Julian</td></tr> +</table> <br><br> <hr> <p><img src="xbase.jpg"><br><hr> diff --git a/docs/html/xbc7.htm b/docs/html/xbc7.html index 20a60de..20a60de 100755 --- a/docs/html/xbc7.htm +++ b/docs/html/xbc7.html diff --git a/docs/html/xbc8.htm b/docs/html/xbc8.html index cb47657..fcc461c 100755 --- a/docs/html/xbc8.htm +++ b/docs/html/xbc8.html @@ -3,7 +3,7 @@ <TITLE>Xbase DBMS Chapter 8</TITLE> <BODY BGCOLOR=#FFFFFF> <H2><p align="center">MDX Indices</p></H2> -<p align="center">Chapter Updated 11/28/22</p><hr> +<p align="center">Chapter Updated 12/02/22</p><hr> The objective of this chapter is to provide information regarding the basic concepts of how .MDX index files work in the Xbase environment.<br><br> diff --git a/docs/html/xbc9.htm b/docs/html/xbc9.html index 297a702..afcd2fa 100755 --- a/docs/html/xbc9.htm +++ b/docs/html/xbc9.html @@ -175,5 +175,6 @@ than the search key given. <hr> <A HREF="mailto:bob@#synxis.com"> Author: Bob Cotton - bob@synxis.com</A><br> +<p><img src="xbase.jpg"><br><hr> </BODY> </HTML> |