pax_global_header00006660000000000000000000000064147332460100014512gustar00rootroot0000000000000052 comment=b81b1c92715727c58adda2647ec1f2d61a2566c7 mdbtools-1.0.1/000077500000000000000000000000001473324601000133345ustar00rootroot00000000000000mdbtools-1.0.1/.github/000077500000000000000000000000001473324601000146745ustar00rootroot00000000000000mdbtools-1.0.1/.github/workflows/000077500000000000000000000000001473324601000167315ustar00rootroot00000000000000mdbtools-1.0.1/.github/workflows/build.yml000066400000000000000000000110331473324601000205510ustar00rootroot00000000000000name: build on: [ push, pull_request ] env: TEST_DATA_URL: https://github.com/mdbtools/mdbtestdata/archive/refs/heads/master.tar.gz jobs: linux: runs-on: ubuntu-latest strategy: fail-fast: false matrix: compiler: [ clang, gcc, gcc-9, gcc-10 ] iconv: [ enable-iconv, disable-iconv] glib: [ enable-glib, disable-glib ] steps: - name: Install packages run: sudo apt install gettext - uses: actions/checkout@v2 - name: Fetch test data run: | rm -rf test mkdir test curl -sSLf "$TEST_DATA_URL" | tar xz --strip-components=1 -C test - name: Autoconf run: autoreconf -i -f - name: Configure run: ./configure --disable-silent-rules --${{ matrix.glib }} --${{ matrix.iconv }} --with-unixodbc=/usr env: CC: ${{ matrix.compiler }} - name: Make run: make - name: CLI tests run: ./test_script.sh --github - name: SQL tests run: bash -e -x ./test_sql.sh - name: ODBC tests run: ./src/odbc/unittest env: MDBPATH: test/data - name: pkg-config libmdb test run: pkg-config libmdb --exists env: PKG_CONFIG_PATH: . - name: pkg-config libmdbsql test run: pkg-config libmdbsql --exists env: PKG_CONFIG_PATH: . macos: runs-on: macos-latest strategy: fail-fast: false matrix: compiler: [ clang, gcc ] iconv: [ enable-iconv, disable-iconv] glib: [ enable-glib, disable-glib ] steps: - name: Install packages run: brew install bison gawk automake libtool unixodbc - uses: actions/checkout@v2 - name: Fetch test data run: | rm -rf test mkdir test curl -sSLf "$TEST_DATA_URL" | tar xz --strip-components=1 -C test - name: Autoconf run: autoreconf -i -f - name: Configure run: ./configure --disable-silent-rules --${{ matrix.glib }} --${{ matrix.iconv }} --with-unixodbc=/opt/homebrew/opt/unixodbc env: CC: ${{ matrix.compiler }} YACC: /opt/homebrew/opt/bison/bin/bison - name: Make run: make - name: CLI tests run: ./test_script.sh --github - name: SQL tests run: bash -e -x ./test_sql.sh - name: ODBC tests run: ./src/odbc/unittest env: MDBPATH: test/data - name: pkg-config libmdb test run: pkg-config libmdb --exists env: PKG_CONFIG_PATH: . - name: pkg-config libmdbsql test run: pkg-config libmdbsql --exists env: PKG_CONFIG_PATH: . macos-iodbc: runs-on: macos-latest strategy: fail-fast: false matrix: compiler: [ clang, gcc ] glib: [ enable-glib, disable-glib ] steps: - name: Install packages run: brew install bison gawk automake libtool libiodbc - name: Add path run: echo /opt/homebrew/opt/libiodbc/bin >> $GITHUB_PATH - uses: actions/checkout@v2 - name: Fetch test data run: | rm -rf test mkdir test curl -sSLf "$TEST_DATA_URL" | tar xz --strip-components=1 -C test - name: Autoconf run: autoreconf -i -f - name: Configure run: ./configure --disable-silent-rules --${{ matrix.glib }} --with-iodbc=/opt/homebrew/opt/libiodbc env: CC: ${{ matrix.compiler }} YACC: /opt/homebrew/opt/bison/bin/bison - name: Make run: make - name: ODBC tests run: ./src/odbc/unittest env: MDBPATH: test/data windows: runs-on: windows-latest strategy: fail-fast: false matrix: iconv: [ enable-iconv, disable-iconv] glib: [ enable-glib, disable-glib ] defaults: run: shell: msys2 {0} steps: - uses: msys2/setup-msys2@v2 with: update: true install: >- autotools base-devel gcc git glib2-devel - uses: actions/checkout@v2 - name: Fetch test data run: | rm -rf test mkdir test curl -sSLf "$TEST_DATA_URL" | tar xz --strip-components=1 -C test - name: Autoconf run: autoreconf -i -f - name: Configure run: ./configure --${{ matrix.glib }} --${{ matrix.iconv }} - name: Make run: make - name: Test run: ./test_script.sh --github - name: SQL Test run: bash -e -x ./test_sql.sh mdbtools-1.0.1/.github/workflows/fuzz.yml000066400000000000000000000011351473324601000204520ustar00rootroot00000000000000name: CIFuzz on: [pull_request] jobs: Fuzzing: runs-on: ubuntu-latest steps: - name: Build Fuzzers uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master with: oss-fuzz-project-name: 'mdbtools' dry-run: false - name: Run Fuzzers uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master with: oss-fuzz-project-name: 'mdbtools' fuzz-seconds: 600 dry-run: false - name: Upload Crash uses: actions/upload-artifact@v1 if: failure() with: name: artifacts path: ./out/artifacts mdbtools-1.0.1/.gitignore000066400000000000000000000016131473324601000153250ustar00rootroot00000000000000*.o *.lo *.la *.out .deps/ .idea/ .libs/ aclocal.m4 autom4te.cache/ build-aux/* !build-aux/config.rpath m4/ !m4/ax_tls.m4 !m4/ccalias.m4 !m4/iconv.m4 !m4/readline.m4 config.log config.status configure /configure~ Makefile.in Makefile doc/*.1 INSTALL include/mdbver.h include/mdbtools.h libmdb.pc libmdbsql.pc libtool mdbtools-*.tar.gz mdbtools-*.zip src/extras/mdb-hexdump src/odbc/unittest src/sql/lexer.c src/sql/parser.c src/sql/parser.h src/util/mdb-array src/util/mdb-count src/util/mdb-export src/util/mdb-json src/util/mdb-header src/util/mdb-import src/util/mdb-parsecsv src/util/mdb-prop src/util/mdb-queries src/util/mdb-schema src/util/mdb-sql src/util/mdb-tables src/util/mdb-ver src/util/prcat src/util/prdata src/util/prdump src/util/prindex src/util/prkkd src/util/prole src/util/prtable src/util/updrow /test/ /.vscode/ ## apidocs docs related public/ .sass-cache/ *.css.map temp-man-pages/ mdbtools-1.0.1/.gitlab-ci.yml000066400000000000000000000002751473324601000157740ustar00rootroot00000000000000image: ubuntu pages: script: - apt-get update -qq - apt-get install -y -qq doxygen graphviz python3 - ./api_docx/build_docs.sh artifacts: paths: - public only: - dev mdbtools-1.0.1/AUTHORS000066400000000000000000000064721473324601000144150ustar00rootroot000000000000002000-2005,2007,2010,2011,2016 Brian Bruns 2000 Brent Johnson 2000 Carl Seutter 2000 Georg Bauer 2000 Karl Nyberg 2000 Michael Wood 2000 Tim Nelson 2000 Trevor Harrison 2001 Oliver Stieber 2001 Yves Maingoy 2002 Ben McKeegan 2002 Don Badrak 2002 Mike Finger 2002 trewitt 2004-2006 Jeff Smith 2004,2005 David Mansfield 2004,2012 Filip Van Raemdonck 2004 Alexandre Horst 2004 Luciano Miguel Wolf 2004 Michael Meeks 2004 teodor 2004 Wind Li 2005 Alex Hunsaker 2005 Artur Frysiak 2005 calvinrsmith 2005 Edward Catmur 2005 Horst Knorr 2005 Leonard Leblanc 2005 Martin Ellis 2005 Mike Prudence 2005 Pedro Gutierrez 2005 Yasir Assam 2008 Brett Hutley 2009,2010 Tim Retout < 2009,2011 Mark Williams 2009 Pablo Llopis 2009 Rene Engelhard 2009 Steve Langasek 2009 Vincent Fourmond 2010,2011 Bernhard Reiter 2011-2017,2020-2021 Jean-Michel Nirgal Vourgère 2011,2013,2018 James Ahlborn 2011 Dmitry Nikitin 2011 Jakob Egger 2011 xsloader 2012-2015 Jimmy Taker 2012 Adam Vandenberg 2012 branche 2012 Hans de Goede 2012 Will Daniels 2013,2014 tyzhaoqi 2013,2015 William Rogers 2013 Boris Barbulovski 2013 Chris Kerr 2014 David Hicks 2014 lovelytwo 2014 Maurus Cuelenaere 2014 Mihai Draghicioiu 2014 Paul Fitzpatrick 2014 Shane Mc Cormack 2014 Ugo Di Girolamo 2015,2016 Sam Shaw 2015,2017 leecher1337 2015 Dan Villiom Podlaski Christiansen 2015 Dmitrij D. Czarkoff 2015 Sam Stuck 2015 Stefano Costa 2015 Vladimir Rutsky 2016 Ewen McNeill 2016 Joshua Short 2017 chunhao 2017 Joshua Pinter 2017 Kane O'Donnell 2017 Edward Abraham 2017 Richard Mansfield 2018-2021 Evan Miller 2018,2019 Cyber Emissary 2018 Bruce Johnson 2018 Mark Ord 2018 Matt Newman 2019 Peter Kaukov 2019 VJ 2020,2021 James Woodcock 2020 Nyall Dawson 2020 Rainer Hurling 2021 Pedro Morgan 2021 kalpha2 2021 Dan Church 2021 Sam James mdbtools-1.0.1/COPYING000066400000000000000000000432541473324601000143770ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. 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. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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. 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 convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 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 2 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision 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, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This 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. mdbtools-1.0.1/COPYING.LIB000066400000000000000000000614471473324601000150100ustar00rootroot00000000000000 GNU LIBRARY GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the library GPL. It is numbered 2 because it goes with version 2 of the ordinary GPL.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Library General Public License, applies to some specially designated Free Software Foundation software, and to any other libraries whose authors decide to use it. You can use it for your libraries, 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library, or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link a program with the library, you must provide complete object files to the recipients so that they can relink them with the library, after making changes to the library and recompiling it. And you must show them these terms so they know their rights. Our method of protecting your rights has two steps: (1) copyright the library, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the library. Also, for each distributor's protection, we want to make certain that everyone understands that there is no warranty for this free library. If the library is modified by someone else and passed on, we want its recipients to know that what they have is not the original version, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that companies distributing free software will individually obtain patent licenses, thus in effect transforming the program into proprietary software. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License, which was designed for utility programs. This license, the GNU Library General Public License, applies to certain designated libraries. This license is quite different from the ordinary one; be sure to read it in full, and don't assume that anything in it is the same as in the ordinary license. The reason we have a separate public license for some libraries is that they blur the distinction we usually make between modifying or adding to a program and simply using it. Linking a program with a library, without changing the library, is in some sense simply using the library, and is analogous to running a utility program or application program. However, in a textual and legal sense, the linked executable is a combined work, a derivative of the original library, and the ordinary General Public License treats it as such. Because of this blurred distinction, using the ordinary General Public License for libraries did not effectively promote software sharing, because most developers did not use the libraries. We concluded that weaker conditions might promote sharing better. However, unrestricted linking of non-free programs would deprive the users of those programs of all benefit from the free status of the libraries themselves. This Library General Public License is intended to permit developers of non-free programs to use free libraries, while preserving your freedom as a user of such programs to change the free libraries that are incorporated in them. (We have not seen how to achieve this as regards changes in header files, but we have achieved it as regards changes in the actual functions of the Library.) The hope is that this will lead to faster development of free libraries. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, while the latter only works together with the library. Note that it is possible for a library to be covered by the ordinary General Public License rather than by this special one. GNU LIBRARY GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Library General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also compile or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. c) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. d) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Library 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 Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "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 LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY 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 LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library 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 Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! mdbtools-1.0.1/HACKING000066400000000000000000000002621473324601000143230ustar00rootroot00000000000000The mdbtools HACKING file has moved to HACKING.md in this folder. Please update your bookmarks to the new location: https://github.com/mdbtools/mdbtools/blob/master/HACKING.md mdbtools-1.0.1/HACKING.md000066400000000000000000001355041473324601000147320ustar00rootroot00000000000000This file documents the Microsoft MDB file format for Jet3 and Jet4 databases. [TOC] General Notes ------------- Access (Jet) does not in general initialize pages to zero before writing them, so the file will contains a lot of unititialized data. This makes the task of figuring out the format a bit more difficult than it otherwise would be. This document will, generally speaking, provide all offsets and constants in hex format. Most multibyte pointer and integers are stored in little endian (LSB-MSB) order. There is an exception in the case of indexes, see the section on index pages for details. Terminology ----------- This section contains a mix of information about data structures used in the MDB file format along with general database terminology needed to explain these structures. ``` Page - A fixed size region within the file on a 2 or 4K boundry. All data in the file exists inside pages. System Table - Tables in Access generally starting with "MSys". The 'Flags' field in the table's Catalog Entry will contain a flag in one of two positions (0x80000000 or 0x00000002). See also the TDEF (table definition) pages for "System Table" field. Catalog Entry - A row from the MSysObjects table describing another database object. The MSysObjects table definition page is always at page 2 of the database, and a phony tdef structure is bootstrapped to initially read the database. Page Split - A process in which a row is added to a page with no space left. A second page is allocated and rows on the original page are split between the two pages and then indexes are updated. Pages can use a variety of algorithms for splitting the rows, the most popular being a 50/50 split in which rows are divided evenly between pages. Overflow Page - Instead of doing a full page split with associated index writes, a pointer to an "overflow" page can be stored at the original row's location. Compacting a database would normally rewrite overflow pages back into regular pages. Leaf Page - The lowest page on an index tree. In Access, leaf pages are of a different type than other index pages. UCS-2 - a two byte unicode encoding used in Jet4 files. Covered Query - a query that can be satisfied by reading only index pages. For instance if the query "SELECT count(*) from Table1 where Column3 = 4" were run and Column3 was indexed, the query could be satisfied by reading only indexes. Because of the way Access hashes text columns in indexes, covered queries on text columns are not possible. ``` Pages ----- At its topmost level, a MDB file is organized into a series of fixed-size pages. These are 2K in size for Jet3 (Access 97) and 4K for Jet4 (Access 2000/2002). All data in MDB files exists within pages, of which there are a number of types. The first byte of each page identifies the page type as follows. ``` 0x00 Database definition page. (Always page 0) 0x01 Data page 0x02 Table definition 0x03 Intermediate Index pages 0x04 Leaf Index pages 0x05 Page Usage Bitmaps (extended page usage) 0x08 ?? ``` Database Definition Page ------------------------ Each MDB database has a single definition page located at beginning of the file. Not a lot is known about this page, and it is one of the least documented page types. However, it contains things like Jet version, encryption keys, and name of the creating program. Note, this page is "encrypted" with a simple rc4 key starting at offset 0x18 and extending for 126 (Jet3) or 128 (Jet4) bytes. Offset 0x14 contains the Jet version of this database: - 0x00 for 3 - 0x01 for 4 - 0x02 for 5 - 0x03 for Access 2010 - 0x04 for Access 2013 - 0x05 for Access 2016 - 0x06 for Access 2019 This is used by the `mdb-ver` utility to determine the Jet version. The 20 bytes (Jet3) or 40 bytes (Jet4) starting at 0x42 are the database password. In Jet4, there is an additional mask applied to this password derived from the database creation date (also stored on this page as 8 bytes starting at offset 0x72). The 4 bytes at 0x3e on the Database Definition Page are the database key. The 2 bytes at 0x3C are the default database code page (useless in Jet4?). The 2 bytes at 0x3A (Jet3) or 4 bytes at 0x6E (Jet4) are the default text collating sort order. Data Pages ---------- Data rows are all stored in data pages. The header of a Jet3 data page looks like this: ``` +--------------------------------------------------------------------------+ | Jet3 Data Page Definition | +------+---------+---------------------------------------------------------+ | data | length | name | description | +------+---------+---------------------------------------------------------+ | 0x01 | 1 byte | page_type | 0x01 indicates a data page. | | 0x01 | 1 byte | unknown | | | ???? | 2 bytes | free_space | Free space in this page | | ???? | 4 bytes | tdef_pg | Page pointer to table definition | | ???? | 2 bytes | num_rows | number of records on this page | +--------------------------------------------------------------------------+ | Iterate for the number of records | +--------------------------------------------------------------------------+ | ???? | 2 bytes | offset_row | The record's location on this page | +--------------------------------------------------------------------------+ ``` Notes: - In Jet4, an additional four-byte field was added after tdef_pg. Its purpose is currently unknown. - Offsets that have 0x40 in the high order byte point to a location within the page where a Data Pointer (4 bytes) to another data page (also known as an overflow page) is stored. Called 'lookupflag' in source code. - Offsets that have 0x80 in the high order byte are deleted rows. Called 'delflag' in source code. Rows are stored from the end of the page to the top of the page. So, the first row stored runs from the row's offset to page_size - 1. The next row runs from its offset to the previous row's offset - 1, and so on. Decoding a row requires knowing the number and types of columns from its TDEF page. Decoding is handled by the routine mdb_crack_row(). ``` +--------------------------------------------------------------------------+ | Jet3 Row Definition | +------+---------+---------------------------------------------------------+ | data | length | name | description | +------+---------+---------------------------------------------------------+ | ???? | 1 byte | num_cols | Number of columns stored on this row. | | ???? | n bytes | fixed_cols | Fixed length columns | | ???? | n bytes | var_cols | Variable length columns | | ???? | 1 byte | eod | length of data from begining of record | | ???? | n bytes | var_table[]| offset from start of row for each var_col | | ???? | n bytes | jump_table | Jump table (see description below) | | ???? | 1 byte | var_len | number of variable length columns | | ???? | n bytes | null_mask | Null indicator. See notes. | +--------------------------------------------------------------------------+ ``` ``` +--------------------------------------------------------------------------+ | Jet4 Row Definition | +------+---------+---------------------------------------------------------+ | data | length | name | description | +------+---------+---------------------------------------------------------+ | ???? | 2 bytes | num_cols | Number of columns stored on this row. | | ???? | n bytes | fixed_cols | Fixed length columns | | ???? | n bytes | var_cols | Variable length columns | | ???? | 2 bytes | eod | length of data from begining of record | | ???? | n bytes | var_table[]| offset from start of row for each var_col | | ???? | 2 bytes | var_len | number of variable length columns | | ???? | n bytes | null_mask | Null indicator. See notes. | +--------------------------------------------------------------------------+ ``` Notes: - A row will always have the number of fixed columns as specified in the table definition, but may have fewer variable columns, as rows are not updated when columns are added. - All fixed-length columns are stored first to last, followed by non-null variable-length columns stored first to last. - If the number of variable columns, as given in the TDEF, is 0, then the only items in the row are num_cols, fixed_cols, and null_mask. - The var_len field indicates the number of entries in the var_table[]. - The var_table[] and jump_table[] are stored in reverse order. - The eod field points at the first byte after the var_cols field. It is used to determine where the last var_col ends. - The size of the null mask is computed by (num_cols + 7)/8. - Fixed columns can be null (unlike some other databases). - The null mask stores one bit for each column, starting with the least-significant bit of the first byte. - In the null mask, 0 represents null, and 1 represents not null. - Values for boolean fixed columns are in the null mask: 0 - false, 1 - true. In Jet3, offsets are stored as 1-byte fields yielding a maximum of 256 bytes. To get around this, offsets are computed using a jump table. The jump table stores the number of the first column in each jump segment. If the size of the row is less than 256 then the jump table will not be present. Also, eod is treated as an additional entry of the var_table[]. For example, if the row contains 45 columns and the 15th column is the first with an offset of 256 or greater, then the first entry in the jump table will be 0xe (14). If the 24th column is the first one at offset >= 512, the second entry of the jump table would be 0x17 (23). If eod is the first entry >= 768, the last entry in this case will be 0x2d (45). The number of jump table entries is calculated based on the size of the row, rather than the location of eod. As a result, there may be a dummy entry that contains 0xff. In this case, and using the example above, the values in the jump table would be 0x2d 0x17 0x0e 0xff. In Jet4 all offsets are stored as 2 byte fields, including the var_table entries. Thus, the jump table was (thankfully) ditched in Jet4. Each memo column (or other long binary data) in a row ``` +-------------------------------------------------------------------------+ | Memo Field Definition (12 bytes) | +------+---------+-------------+------------------------------------------+ | data | length | name | description | +------+---------+-------------+------------------------------------------+ | ???? | 3 bytes | memo_len | Total length of the memo | | ???? | 1 bytes | bitmask | See values | | ???? | 4 bytes | lval_dp | Data pointer to LVAL page (if needed) | | 0x00 | 4 bytes | unknown | | +------+---------+-------------+------------------------------------------+ ``` Values for the bitmask: - 0x80 = the memo is in a string at the end of this header (memo_len bytes) - 0x40 = the memo is in a unique LVAL page in a record type 1 - 0x00 = the memo is in n LVAL pages in a record type 2 If the memo is in a LVAL page, we use row_id of lval_dp to find the row. ```c offset_start of memo = (int16*) LVAL_page[offset_num_rows + (row_id * 2) + 2] if (row_id = 0) offset_stop of memo = 2048(jet3) or 4096(jet4) else offset_stop of memo = (int16*) LVAL_page[offset_num_row + (row_id * 2)] & offset_mask // offset_mask = 0x1fff ``` The length (partial if type 2) for the memo is: memo_page_len = offset_stop - offset_start Update: The bitmask can't be an entire byte long. OLE fields can hold up to 1gig. That requires at least 30 bits, leaving only 2 bits for flags. Maybe sometimes 0xC0000000 is ignored? See http://office.microsoft.com/en-us/access-help/access-2007-specifications-HA010030739.aspx Number of characters in a Memo field: 65,535 when entering data through the user interface; 2 gigabytes of character storage when entering data programmatically. That would mean 31 bits for length. Note: if a memo field is marked for compression, only at value which is at most 1024 characters when uncompressed can be compressed. fields longer than that _must_ be stored uncompressed. LVAL (Long Value) Pages ----------------------- The header of a LVAL page is just like that of a regular data page, except that in place of the tdef_pg is the word 'LVAL'. Each memo record type 1 looks like this: ``` +------+---------+-------------+------------------------------------------+ | data | length | name | description | +------+---------+-------------+------------------------------------------+ | ???? | n bytes | memo_value | A string which is the memo | +-------------------------------------------------------------------------+ ``` Each memo record type 2 looks like this: ``` +------+---------+-------------+------------------------------------------+ | data | length | name | description | +------+---------+-------------+------------------------------------------+ | ???? | 4 bytes | lval_dp | Next page LVAL type 2 if memo is too long| | ???? | n bytes | memo_value | A string which is the memo (partial) | +-------------------------------------------------------------------------+ ``` In a LVAL type 2 data page, you have - 10 or 14 bytes for the header of the data page, - 2 bytes for an offset, - 4 bytes for the next lval_pg So there is a block of 2048 - (10+2+4) = 2032(jet3) or 4096 - (14+2+4) = 4076(jet4) bytes max in a page. TDEF (Table Definition) Pages ----------------------------- Every table in the database has a TDEF page. It contains a definition of the columns, types, sizes, indexes, and similar information. ``` +-------------------------------------------------------------------------+ | Jet3/Jet4 TDEF Header +------+---------+-------------+------------------------------------------+ | data | length | name | description | +------+---------+-------------+------------------------------------------+ | 0x02 | 1 bytes | page_type | 0x02 indicate a tabledef page | | 0x01 | 1 bytes | unknown | | | ???? | 2 bytes | tdef_id | (jet3) The word 'VC' | | | | | (jet4) Free space in this page minus 8 | | 0x00 | 4 bytes | next_pg | Next tdef page pointer (0 if none) | +------+---------+-------------+------------------------------------------+ ``` TDEFs can span multiple pages for large tables, this is accomplished using the next_pg field. ``` +-------------------------------------------------------------------------+ | Jet3 Table Definition Block (35 bytes) | +------+---------+-------------+------------------------------------------+ | data | length | name | description | +------+---------+-------------+------------------------------------------+ | ???? | 4 bytes | tdef_len | Length of the data for this page | | ???? | 4 bytes | num_rows | Number of records in this table | | 0x00 | 4 bytes | autonumber | value for the next value of the | | | | | autonumber column, if any. 0 otherwise | | 0x4e | 1 byte | table_type | 0x4e: user table, 0x53: system table | | ???? | 2 bytes | max_cols | Max columns a row will have (deletions) | | ???? | 2 bytes | num_var_cols| Number of variable columns in table | | ???? | 2 bytes | num_cols | Number of columns in table (repeat) | | ???? | 4 bytes | num_idx | Number of logical indexes in table | | ???? | 4 bytes | num_real_idx| Number of index entries | | ???? | 4 bytes | used_pages | Points to a record containing the | | | | | usage bitmask for this table. | | ???? | 4 bytes | free_pages | Points to a similar record as above, | | | | | listing pages which contain free space. | +-------------------------------------------------------------------------+ | Iterate for the number of num_real_idx (8 bytes per idxs) | +-------------------------------------------------------------------------+ | 0x00 | 4 bytes | ??? | | | ???? | 4 bytes | num_idx_rows| (not sure) | +-------------------------------------------------------------------------+ | Iterate for the number of num_cols (18 bytes per column) | +-------------------------------------------------------------------------+ | ???? | 1 byte | col_type | Column Type (see table below) | | ???? | 2 bytes | col_num | Column Number (includes deleted columns) | | ???? | 2 bytes | offset_V | Offset for variable length columns | | ???? | 2 bytes | col_num | Column Number | | ???? | 2 bytes | sort_order | textual column sort order(0x409=General) | | ???? | 2 bytes | misc | prec/scale (1 byte each), or code page | | | | | for textual columns (0x4E4=cp1252) | | ???? | 2 bytes | ??? | | | ???? | 1 byte | bitmask | See Column flags bellow | | ???? | 2 bytes | offset_F | Offset for fixed length columns | | ???? | 2 bytes | col_len | Length of the column (0 if memo) | +-------------------------------------------------------------------------+ | Iterate for the number of num_cols (n bytes per column) | +-------------------------------------------------------------------------+ | ???? | 1 byte | col_name_len| len of the name of the column | | ???? | n bytes | col_name | Name of the column | +-------------------------------------------------------------------------+ | Iterate for the number of num_real_idx (30+9 = 39 bytes) | +-------------------------------------------------------------------------+ | Iterate 10 times for 10 possible columns (10*3 = 30 bytes) | +-------------------------------------------------------------------------+ | ???? | 2 bytes | col_num | number of a column (0xFFFF= none) | | ???? | 1 byte | col_order | 0x01 = ascendency order | +-------------------------------------------------------------------------+ | ???? | 4 bytes | used_pages | Points to usage bitmap for index | | ???? | 4 bytes | first_dp | Data pointer of the index page | | ???? | 1 byte | flags | See flags table for indexes | +-------------------------------------------------------------------------+ | Iterate for the number of num_idx (20 bytes) | +-------------------------------------------------------------------------+ | ???? | 4 bytes | index_num | Number of the index | | | | |(warn: not always in the sequential order)| | ???? | 4 bytes | index_num2 | Index into index cols list | | 0x00 | 1 byte | rel_tbl_type| type of the other table in this fk | | | | | (same values as index_type) | | 0xFF | 4 bytes | rel_idx_num | index number of other index in fk | | | | | (or -1 if this index is not a fk) | | 0x00 | 4 bytes | rel_tbl_page| page number of other table in fk | | 0x01 | 1 byte | cascade_ups | flag indicating if updates are cascaded | | 0x01 | 1 byte | cascade_dels| flag indicating if deletes are cascaded | | ???? | 1 byte | index_type | 0x01 if index is primary, 0x02 if foreign| +-------------------------------------------------------------------------+ | Iterate for the number of num_idx | +-------------------------------------------------------------------------+ | ???? | 1 byte | idx_name_len| len of the name of the index | | ???? | n bytes | idx_name | Name of the index | +-------------------------------------------------------------------------+ | Iterate while col_num != 0xffff | +-------------------------------------------------------------------------+ | ???? | 2 bytes | col_num | Column number with variable length | | ???? | 4 bytes | used_pages | Points to a record containing the | | | | | usage bitmask for this column. | | ???? | 4 bytes | free_pages | Points to a similar record as above, | | | | | listing pages which contain free space. | +-------------------------------------------------------------------------+ +-------------------------------------------------------------------------+ | Jet4 Table Definition Block (55 bytes) | +------+---------+-------------+------------------------------------------+ | data | length | name | description | +------+---------+-------------+------------------------------------------+ | ???? | 4 bytes | tdef_len | Length of the data for this page | | ???? | 4 bytes | unknown | unknown | | ???? | 4 bytes | num_rows | Number of records in this table | | 0x00 | 4 bytes | autonumber | value for the next value of the | | | | | autonumber column, if any. 0 otherwise | | 0x01 | 1 byte | autonum_flag| 0x01 makes autonumbers work in access | | ???? | 3 bytes | unknown | unknown | | 0x00 | 4 bytes | ct_autonum | autonumber value for complex type column(s) | | | | | (shared across all columns in the table) | | ???? | 8 bytes | unknown | unknown | | 0x4e | 1 byte | table_type | 0x4e: user table, 0x53: system table | | ???? | 2 bytes | max_cols | Max columns a row will have (deletions) | | ???? | 2 bytes | num_var_cols| Number of variable columns in table | | ???? | 2 bytes | num_cols | Number of columns in table (repeat) | | ???? | 4 bytes | num_idx | Number of logical indexes in table | | ???? | 4 bytes | num_real_idx| Number of index entries | | ???? | 4 bytes | used_pages | Points to a record containing the | | | | | usage bitmask for this table. | | ???? | 4 bytes | free_pages | Points to a similar record as above, | | | | | listing pages which contain free space. | +-------------------------------------------------------------------------+ | Iterate for the number of num_real_idx (12 bytes per idxs) | +-------------------------------------------------------------------------+ | 0x00 | 4 bytes | ??? | | | ???? | 4 bytes | num_idx_rows| (not sure) | | 0x00 | 4 bytes | ??? | | +-------------------------------------------------------------------------+ | Iterate for the number of num_cols (25 bytes per column) | +-------------------------------------------------------------------------+ | ???? | 1 byte | col_type | Column Type (see table below) | | ???? | 4 bytes | unknown | matches first unknown definition block | | ???? | 2 bytes | col_num | Column Number (includes deleted columns) | | ???? | 2 bytes | offset_V | Offset for variable length columns | | ???? | 2 bytes | col_num | Column Number | | ???? | 2 bytes | misc | prec/scale (1 byte each), or sort order | | | | | for textual columns(0x409=General) | | | | | or "complexid" for complex columns (4bytes)| | ???? | 2 bytes | misc_ext | text sort order version num is 2nd byte | | ???? | 1 byte | bitmask | See column flags below | | ???? | 1 byte | misc_flags | 0x01 for compressed unicode | | 0000 | 4 bytes | ??? | | | ???? | 2 bytes | offset_F | Offset for fixed length columns | | ???? | 2 bytes | col_len | Length of the column (0 if memo/ole) | +-------------------------------------------------------------------------+ | Iterate for the number of num_cols (n*2 bytes per column) | +-------------------------------------------------------------------------+ | ???? | 2 bytes | col_name_len| len of the name of the column | | ???? | n bytes | col_name | Name of the column (UCS-2 format) | +-------------------------------------------------------------------------+ | Iterate for the number of num_real_idx (30+22 = 52 bytes) | +-------------------------------------------------------------------------+ | ???? | 4 bytes | ??? | | +-------------------------------------------------------------------------+ | Iterate 10 times for 10 possible columns (10*3 = 30 bytes) | +-------------------------------------------------------------------------+ | ???? | 2 bytes | col_num | number of a column (0xFFFF= none) | | ???? | 1 byte | col_order | 0x01 = ascendency order | +-------------------------------------------------------------------------+ | ???? | 4 bytes | used_pages | Points to usage bitmap for index | | ???? | 4 bytes | first_dp | Data pointer of the index page | | ???? | 1 byte | flags | See flags table for indexes | | ???? | 9 bytes | unknown | | +-------------------------------------------------------------------------+ | Iterate for the number of num_idx (28 bytes) | +-------------------------------------------------------------------------+ | ???? | 4 bytes | unknown | matches first unknown definition block | | ???? | 4 bytes | index_num | Number of the index | | | | |(warn: not always in the sequential order)| | ???? | 4 bytes | index_num2 | Index into index cols list | | 0x00 | 1 byte | rel_tbl_type| type of the other table in this fk | | | | | (same values as index_type) | | 0xFF | 4 bytes | rel_idx_num | index number of other index in fk | | | | | (or -1 if this index is not a fk) | | 0x00 | 4 bytes | rel_tbl_page| page number of other table in fk | | 0x01 | 1 byte | cascade_ups | flag indicating if updates are cascaded | | 0x01 | 1 byte | cascade_dels| flag indicating if deletes are cascaded | | ???? | 1 byte | index_type | 0x01 if index is primary, 0x02 if foreign| +-------------------------------------------------------------------------+ | Iterate for the number of num_idx | +-------------------------------------------------------------------------+ | ???? | 2 bytes | idx_name_len| len of the name of the index | | ???? | n bytes | idx_name | Name of the index (UCS-2) | +-------------------------------------------------------------------------+ | Iterate while col_num != 0xffff | +-------------------------------------------------------------------------+ | ???? | 2 bytes | col_num | Column number with variable length | | ???? | 4 bytes | used_pages | Points to a record containing the | | | | | usage bitmask for this column. | | ???? | 4 bytes | free_pages | Points to a similar record as above, | | | | | listing pages which contain free space. | +-------------------------------------------------------------------------+ ``` Columns flags (not complete): - 0x01: fixed length column - 0x02: can be null (possibly related to joins?) - 0x04: is auto long - 0x10: replication related field (or hidden?). These columns start with "s_" or "Gen_" (the "Gen_" fields are for memo fields) - 0x40: is auto guid - 0x80: hyperlink. Syntax is "Link Title#http://example.com/somepage.html#" or "#PAGE.HTM#" In Access 2007 and Access 2010, "Complex Columns" (multivalued fields, version history, attachments) always have the flag byte set to exactly 0x07. Index flags (not complete): - 0x01 Unique - 0x02 IgnoreNuls - 0x08 Required Column Type may be one of the following (not complete): ``` BOOL = 0x01 /* Boolean ( 1 bit ) */ BYTE = 0x02 /* Byte ( 8 bits) */ INT = 0x03 /* Integer (16 bits) */ LONGINT = 0x04 /* Long Integer (32 bits) */ MONEY = 0x05 /* Currency (64 bits) */ FLOAT = 0x06 /* Single (32 bits) */ DOUBLE = 0x07 /* Double (64 bits) */ DATETIME = 0x08 /* Date/Time (64 bits) */ BINARY = 0x09 /* Binary (255 bytes) */ TEXT = 0x0A /* Text (255 bytes) */ OLE = 0x0B /* OLE = Long binary */ MEMO = 0x0C /* Memo = Long text*/ UNKNOWN_0D = 0x0D UNKNOWN_0E = 0x0E REPID = 0x0F /* GUID */ NUMERIC = 0x10 /* Scaled decimal (17 bytes) */ ``` Notes on reading index metadata: There are 2 types of index metadata, "physical" index info (denoted by num_real_idx) and "logical" index info (denoted by num_idx). Normally, there is a 1 to 1 relationship between these 2 types of information. However there can be more logical index infos than physical index infos (currently only seen for foreign key indexes). In this situation, one or more of the logical indexes actually share the same underlying physical index (the index_num2 indicates which physical index backs which logical index). As noted in the previous paragraph, physical index sharing is generally only seen when a foreign key index has been created. When access creates a relationship between 2 tables with "enforce referential integrity" enabled, each of the tables gets an extra logical index with type 2 (foreign key). These logical indexes contain extra information, primarily pointers to the related table (rel_tbl_page) and logical index (rel_idx_num). Also, the rel_tbl_type value indicates which table in the relationship is the "primary" table (the one one from which cascaded updates/deletes flow). If the indexed columns for the foreign key are already indexed by another logical index in the table (e.g. an index which the user has explicitly created), then the logical foreign key index will simply share the underlying physical index data. Notes on deleted and added columns: (sort of Jet4 specific) If a fixed length column is deleted the offset_F field will contain the offsets of the original row definition. Thus if the number of columns on the row does not match the number in the tdef, the offset_F field could be used to return the proper data. Columns are never really deleted in the row data. The deleted column will forever exist and be set to null for new rows. A row may have less than max_cols columns but will never have more, as max_cols is never decremented. If you have a table with 6 columns, delete one, and add one, then max_cols will be 7. For variable length columns, offset_V will hold the position in the offset table of that column. Missing columns are set to null for new rows. Page Usage Maps --------------- There are three uses for the page usage bitmaps. There is a global page usage stored on page 1 which tracks allocated pages throughout the database. Tables store two page usage bitmaps. One is a straight map of which pages are owned by the table. The second is a map of the pages owned by the table which have free space on them (used for inserting data). The table bitmaps appear to be of a fixed size for both Jet 3 and 4 (128 and 64 bytes respectively). The first byte of the map is a type field. ``` +--------------------------------------------------------------------------+ | Type 0 Page Usage Map | +------+---------+---------------------------------------------------------+ | data | length | name | description | +------+---------+---------------------------------------------------------+ | 0x00 | 1 byte | map_type | 0x00 indicates map stored within. | | ???? | 4 byte | page_start | first page for which this map applies | +------+---------+---------------------------------------------------------+ | Iterate for the length of map | +--------------------------------------------------------------------------+ | ???? | 1 byte | bitmap | each bit encodes the allocation status of a| | | | | page. 1 indicates allocated to this table. | | | | | Pages are stored starting with the low | | | | | order bit of the first byte. | +--------------------------------------------------------------------------+ ``` If you're paying attention then you'll realize that the relatively small size of the map (128*8*2048 or 64*8*4096 = 2 Meg) means that this scheme won't work with larger database files although the initial start page helps a bit. To overcome this there is a second page usage map scheme with the map_type of 0x01. ``` +--------------------------------------------------------------------------+ | Type 1 Page Usage Map | +------+---------+---------------------------------------------------------+ | data | length | name | description | +------+---------+---------------------------------------------------------+ | 0x01 | 1 byte | map_type | 0x01 indicates this is a indirection list. | +------+---------+---------------------------------------------------------+ | Iterate for the length of map | +--------------------------------------------------------------------------+ | ???? | 4 bytes | map_page | pointer to page type 0x05 containing map | +--------------------------------------------------------------------------+ ``` Note that the initial start page is gone and is reused for the first page indirection. The 0x05 type page header looks like: ``` +--------------------------------------------------------------------------+ | Usage Map Page (type 0x05) | +------+---------+---------------------------------------------------------+ | data | length | name | description | +------+---------+---------------------------------------------------------+ | 0x05 | 1 byte | page_type | allocation map page | | 0x01 | 1 byte | unknown | always 1 as with other page types | | 0x00 | 2 bytes | unknown | | +------+---------+---------------------------------------------------------+ ``` The rest of the page is the allocation bitmap following the same scheme (lsb to msb order, 1 bit per page) as a type 0 map. This yields a maximum of 2044*8=16352 (jet3) or 4092*8 = 32736 (jet4) pages mapped per type 0x05 page. Given 128/4+1 = 33 or 64/4+1 = 17 page pointers per indirection row (remember the start page field is reused, thus the +1), this yields 33*16352*2048 = 1053 Meg (jet3) or 17*32736*4096 = 2173 Meg (jet4) or enough to cover the maximum size of each of the database formats comfortably, so there is no reason to believe any other page map schemes exist. Indices ------- Indices are not completely understood but here is what we know. ``` +-------------------------------------------------------------------------+ | Index Page (type 0x03) | +------+---------+-------------+------------------------------------------+ | data | length | name | description | +------+---------+-------------+------------------------------------------+ | 0x03 | 1 bytes | page_type | 0x03 indicate an index page | | 0x01 | 1 bytes | unknown | | | ???? | 2 bytes | free_space | The free space at the end this page | | ???? | 4 bytes | parent_page | The page number of the TDEF for this idx | | ???? | 4 bytes | prev_page | Previous page at this index level | | ???? | 4 bytes | next_page | Next page at this index level | | ???? | 4 bytes | tail_page | Pointer to tail leaf page | | ???? | 2 bytes | pref_len | Length of the shared entry prefix | +-------------------------------------------------------------------------+ ``` Index pages come in two flavors. 0x04 pages are leaf pages which contain one entry for each row in the table. Each entry is composed of a flag, the indexed column values and a page/row pointer to the data. 0x03 index pages make up the rest of the index tree and contain a flag, the indexed columns, the page/row that contains this entry, and the leaf page or intermediate (another 0x03 page) page pointer for which this is the first entry on. Both index types have a bitmask starting at 0x16(jet3) or 0x1b(jet4) which identifies the starting location of each index entry on this page. The first entry begins at offset 0xf8(jet3) or 0x1e0(jet4), and is not explicitly indicated in the bitmask. Note that the count in each byte begins with the low order bit. For example take the data: ``` 00 20 00 04 80 00 ... ``` Convert the bytes to binary starting with the low order bit in each byte. v's mark where each entry begins: ``` v v v v 0000 0000 0000 0100 0000 0000 0010 0000 0000 0001 0000 0000 -- 00 --- -- 20 --- -- 00 --- -- 04 --- -- 80 --- -- 00 --- ``` As noted earlier, the first entry is implicit. The second entry begins at an offset of 13 (0xd) bytes from the first. The third entry 26 (0x1a) bytes from the first. The final entry starts at an offset of 39 (0x27) bytes from the first. In this example the rest of the mask (up to offset 0xf8/0x1e0) would be zero-filled and thus this last entry isn't an actual entry, but the stopping point of the data. For Jet3, (0xf8 - 0x16) * 8 = 0x710 and 0x800 - 0xf8 = 0x708. For Jet4, (0x1e0 - 0x1b) * 8 = 0xe28 and 0x1000 - 0x1e0 = 0xe20. So the mask just covers the page, including space to indicate if the last entry goes to the end of the page. One wonders why MS didn't use a row offset table like they did on data pages. It seems like it would have been easier and more flexible. So now we come to the index entries for type 0x03 pages which look like this: ``` +-------------------------------------------------------------------------+ | Index Record | +------+---------+-------------+------------------------------------------+ | data | length | name | description | +------+---------+-------------+------------------------------------------+ | 0x7f | 1 byte | flags | 0x80 LSB, 0x7f MSB, 0x00 null? | | ???? | variable| indexed cols| indexed column data | | ???? | 3 bytes | data page | page containing row referred to by this | | | | | index entry | | ???? | 1 byte | data row | row number on that page of this entry | | ???? | 4 bytes | child page | next level index page containing this | | | | | entry as last entry. Could be a leaf | | | | | node. | +-------------------------------------------------------------------------+ ``` The flag field is generally either 0x00, 0x7f, 0x80, or 0xFF. 0x80 is the one's complement of 0x7f and all text data in the index would then need to be negated. The reason for this negation is descending order. The 0x00 flag indicates that the key column is null (or 0xFF for descending order), and no data will follow, only the page pointer. In multicolumn indexes the flag field plus data is repeated for the number of columns participating in the key. Index entries are always sorted based on the lexicographical order of the entry bytes of the entire index entry (thus descending order is achieved by negating the bytes). The flag field ensures that null values are always sorted at the beginning (for ascending) or end (for descending) of the index. Note, there is a compression scheme utilizing a shared entry prefix. If an index page has a shared entry prefix (idicated by a pref_len > 0), then the first pref_len bytes from the first entry need to be pre-pended to every subsequent entry on the page to get the full entry bytes. For example, normally an index entry with an integer primary key would be 9 bytes (1 for the flags field, 4 for the integer, 4 for page/row). If the pref_len on the index page were 4, every entry after the first would then contain only 5 bytes, where the first byte is the last octet of the encoded primary key field (integer) and the last four are the page/row pointer. Thus if the first key value on the page is 1 and it points to page 261 (00 01 05) row 3, it becomes: ``` 7f 00 00 00 01 00 01 05 03 ``` and the next index entry can be: ``` 02 00 01 05 04 ``` That is, the shared prefix is [7f 00 00 00], so the actual next entry is: ``` [7f 00 00 00] 02 00 01 05 04 ``` so the key value is 2 (the last octet changes to 02) page 261 row 4. Access stores an 'alphabetic sort order' version of the text key columns in the index. Here is the encoding as we know it: ``` 0-9: 0x56-0x5f A-Z: 0x60-0x79 a-z: 0x60-0x79 ``` Once converted into this (non-ascii) character set, the text value can be sorted in 'alphabetic' order using the lexicographical order of the entry bytes. A text column will end with a NULL (0x00 or 0xff if negated). Note, this encoding is the "General" sort order in Access 2000-2007 (1033, version 0). As of Access 2010, this is now called the "General legacy" sort order, and the 2010 "General" sort order is a new encoding (1033, vesion 1). The leaf page entries store the key column and the 3 byte page and 1 byte row number. The value of the index root page in the index definition may be an index page (type 0x03), an index leaf page (type 0x04) if there is only one index page, or (in the case of tables small enough to fit on one page) a data page (type 0x01). So to search the index, you need to convert your value into the alphabetic character set, compare against each index entry, and on successful comparison follow the page and row number to the data. Because text data is managled during this conversion there is no 'covered querys' possible on text columns. To conserve on frequent index updates, Jet also does something special when creating new leaf pages at the end of a primary key index (or other index where new values are generally added to the end of the index). The tail leaf page pointer of the last leaf node points to the new leaf page but the index tree is not otherwise updated. Since index entries in type 0x03 index pages point to the last entry in the page, adding a new entry to the end of a large index would cause updates all the way up the index tree. Instead, the tail page can be updated in isolation until it is full, and then moved into the index proper. In src/libmdb/index.c, the last leaf read is stored, once the index search has been exhausted by the normal search routine, it enters a "clean up mode" and reads the next leaf page pointer until it's null. Properties ---------- Design View table definitions are stored in LvProp column of MSysObjects as OLE fields. They contain default values, description, format, required ... They start with a 32 bits header: 'KKD\0' in Jet3 and 'MR2\0' in Jet 4. Next come chunks. Each chunk starts with: - 32 bits length value (this includes the length) - 16 bits chunk type (0x0080 contains the names, 0x0000 and 0x0001 contain the values. 0x0000 seems to contain information about the "main" object, e.g. the table, and 0x0001 seems to contain information about other objects, e.g. the table columns) ``` Name chunk blocks (0x0080) simply contain occurences of: 16 bit name length name For instance: 0x0d 0x00 and 'AccessVersion' (AccessVersion is 13 bytes, 0x0d 0x00 intel order) ``` Value chunk blocks (0x0000 and 0x0001) contain a header: - 32 bits length value (this includes the length) - 16 bits name length - name (0x0000 chunk blocks are not usually named, 0x0001 chunk blocks have the column name to which the properties belong) Next comes one of more chunks of data: - 16 bit length value (this includes the length) - 8 bit ddl flag - 8 bit type - 16 bit name (index in the name array of above chunk 0x0080) - 16 bit value length field (non-inclusive) value (07.53 for the AccessVersion example above) See ``props.c``` for an example. Text Data Type -------------- In Jet3, the encoding of text depends on the machine on which it was created. So for databases created on U.S. English systems, it can be expected that text is encoded in CP1252. This is the default used by mdbtools. If you know that another encoding has been used, you can override the default by setting the environment variable MDB_JET3_CHARSET. To find out what encodings will work on your system, run 'iconv -l'. In Jet4, the encoding can be either little-endian UCS-2, or a special compressed form of it. This compressed format begins with 0xff 0xfe. The string then starts in compressed mode, where characters with 0x00 for the most-significant byte do not encode it. In the compressed format, a 0x00 byte signals a change from compressed mode to uncompressed mode, or from uncompressed mode back to compressed mode. The string may end in either mode. Note that a string containing any character 0x##00 (UCS-2) will not be compressed. Also, the string will only be compressed if it really does make the string shorter as compared to uncompressed UCS-2. Programs that use mdbtools libraries will receive strings encoded in UTF-8 by default. This default can by overridden by setting the environment variable MDBICONV to the desired encoding. mdbtools-1.0.1/Makefile.am000066400000000000000000000003711473324601000153710ustar00rootroot00000000000000ACLOCAL_AMFLAGS = -I m4 SUBDIRS = src include doc DEFDIR = $(prefix) EXTRA_DIST = HACKING HACKING.md libmdb.pc.in libmdbsql.pc.in README.md pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = libmdb.pc if SQL pkgconfig_DATA += libmdbsql.pc endif mdbtools-1.0.1/NEWS000066400000000000000000000244541473324601000140440ustar00rootroot00000000000000Version 1.0.0 ============= MDB Tools 1.0 includes a number of new features compared to the 0.9 series. The most significant change is that mdbtools.h is now generated at build time, and its internal HAVE_ macros have been removed. This means that it is now safe for clients to compile against mdbtools.h without needing to provide the same HAVE_ICONV and HAVE_GLIB flags that were present when the library was first compiled. For most users, MDB Tools 1.0 will be ABI and API compatible with the 0.9 series but see the notes in the "Install" section below. The SQL engine has two new operators: ILIKE (case-insensitive pattern matching) and <> (not equals). Changes since 0.9.4: Build: * Generate platform-specific `mdbtools.h` at configure-time #316 * Ensure compiler supports thread-local storage * Fix `AC_PROG_LEX` warning with autoconf 2.70 * Rely on autoconf to define appropriate values of `_XOPEN_SOURCE` and friends * New `--disable-iconv` configure option (falls back to `wcstombs` where possible) * Fix a build error when `./configure` detected iconv, but thought it was not working * Generating the configure script now requires autoconf 2.64 or later Install: * Install `libmdbodbc.so` and `libmdbodbcW.so` into ${libdir}/odbc #315 * Do not install `mdb-sql` if SQL support was not built #276 * Do not install `libmdbsql.pc` if SQL support was not built `pkg-config`: * Simplify `--cflags` for libmdb * Provide correct `--cflags` for libmdbsql libmdb: * Copy date formats when cloning handles #326 * Fix incorrect reading of double values #339 #342 * Fix accidental reads of non-index data #335 #343 * New `mdb_set_repid_fmt()` for setting the format of Rep IDs (UUIDs) #344 SQL: * New case-insensitive, Unicode-aware `ILIKE` operator #244 * New `<>` (not equal) operator #329 * Improved support for comparing floating-point values to integers * Improved support for floating point literals with no fractional digits (e.g. "3.") * Add support for querying Rep IDs ODBC: * Format boolean values correctly as `SQL_C_CHAR` #327 * Add support for the `SQL_C_WCHAR` (UTF-16) return type #347 #348 * The Unicode driver (`libmdbodbcW.so`) no longer uses iconv #332 #333 * Add support for older iODBC installations lacking `odbcinst.h` `mdb-export`: * Convert table names to lower case when exporting to PostgreSQL #322 * Use `CREATE IF NOT EXISTS` when exporting to PostgreSQL #321 * Fix issue where byte columns with values > 127 were exported as negative numbers (regression introduced in v0.9.3-beta1) #350 `mdb-hexdump`: * Deprecate tool Version 0.9.4 ============= libmdb: * Write encrypted pages #305 * Improved support for big-endian platforms * Remove obsolete `AC_HEADER_STDC` macro from configure.ac SQL: * Fix compilation on RHEL 7.9 #301 * Add brackets around table names in `mdb-query` output #307 * Support for brackets around table names in SQL parser * Fix regression in 0.9.3 where `COUNT(*)` resulted in a parse error #318 #319 ODBC: * Fix `-Werror=array-bounds` compile error #313 Version 0.9.3 ============= libmdb: * Support files created with Access 2019 #260 #277 * Fix a warning when reading in binary property values #262 * Fix signed-unsigned comparison warning #269 * Migrate to `g_memdup2` #287 #288 * Fix build when `_XOPEN_SOURCE` was already defined on the platform #298 * Fix build failure with emscripten #299 libmdbsql: * Support negative floating point literals #274 #279 * Improved support for file paths in `CONNECT TO` statements #275 #280 #282 * Comparison operators behaved incorrectly when the constant was on the left #283 #285 * Allow double quoted (") database names #291 * Allow spaces in database names #292 #293 ODBC: * unixODBC now uses the `--libdir` passed at configure-time #261 * Fix a segfault in PyODBC when `SQLGetTypeInfo` is called on an unsupported data type #278 Docs: * Add JET version for access 2013/2016/2019 to docs #286 Version 0.9.2 ============= MDB Tools 0.9.2 is a security and bug-fix release. Due to a number of memory errors uncovered by OSS-Fuzz, all users who use MDB Tools to read data from untrusted sources are encouraged to upgrade to 0.9.2 as soon as possible. The release also includes some minor improvements and behavior changes, described below. libmdb: * Fix infinite loop with malformed input (oss-fuzz/28789) * Fix buffer overrun and some out of bounds memory accesses (oss-fuzz/28832 + oss-fuzz/28807) * Fix potential memory leak (oss-fuzz/28791) * Improved bounds and return value checking (oss-fuzz/29328 + oss-fuzz/29329) * Add support for numeric scale/precision on JET3 databases and floating-point column types * `mdb_col_to_string` now prints a warning and returns `""` for any unsupported data type * Improved warning with invalid row data #253 Command-line tools: * All CLI tools which accept string arguments are now locale-aware (#237) * All CLI tools now accept a `--version` argument (#232) * `mdb-export`: Fix issue where exported SQL field sizes were sometimes twice the necessary size (#112) * `mdb-export`: Improved handling of BLOBs (#250) * `mdb-export`: Implement a serial type and relations for MySQL (#257) * `mdb-queries` now has long option names `--list`, `--newline`, and `--delimiter` * `mdb-schema`: Exit with an error code if the requested table is not found ODBC: * `SQLBindCol` now respects its TargetType (fCType) argument and converts bound data to the requested type (#23 #242) * `SQLFetchCol` now returns `SQL_SUCCESS_WITH_INFO` if a bound column was truncated, and `SQL_ERROR` if a bound value is out of range of the target type. * Fix handling of numeric types in ODBC driver (#255) Build and documentation: * Updated man pages with new SQL features and correct `MDBOPTS` information (#203) * Add generated API documentation (#239) * Move `HACKING` to `HACKING.md` (with a relocation notice) and `TODO` to `TODO.md` * Fuzz-test all pull requests (#230) * Add `-DHAVE_GLIB` to library's `pkg-config --cflags` if needed (#254) Version 0.9.1 ============= * MDB Tools has migrated from Travis CI to GitHub Actions for automated builds * Fix a build error with msys2 (Windows) when GLib was disabled * Remove dependency on math.h #228 * mdb-export now uses scientific notation only for very small numbers #84 * mdb-schema no longer emits illegal ALTER TABLE statements for SQLite relationships #82 * mdb-schema now omits the namespace for PostgreSQL indexes and constraints #93 * Automatically detect character encoding of JET3 databases #224 * JET3: Transcode Latin-1 text to UTF-8 when iconv is not present * JET4: Transcode Unicode text to UTF-8 when iconv is not present (using `wcstombs`) #223 * Fix a buffer overrun with binary string fields OSS-Fuzz/28779 #216 * Fix a stack overflow with malformed input OSS-Fuzz/28780 #217 * Improved validation of date input OSS-Fuzz/28790 #219 * Fix a potential buffer overrun when compiled without iconv OSS-Fuzz/28773 #220 * Fix an extra newline that appeared at the `mdb-sql` prompt when Readline was not present * Fix potential stack corruption with malformed input * mdb-export has a new --escape-invisible flag for C-style escaping of tabs and newlines #222 * Print a warning if MDBOPTS=use_index is set at run-time but libmswstr was absent at compile-time #215 #226 * Improved support for databases that were improperly closed #120 * Remove warnings about mdb_find_row and row_size that did not necessarily indicate a problem Version 0.9.0 ============= MDB Tools is under new management! Update your bookmarks and tell your favorite search engine that this is our new home on the WWW: https://github.com/mdbtools/mdbtools MDB Tools 0.9.0 builds off the fork of cyberemissary on GitHub, collects many years of unapplied patches, and includes a number of internal improvements. Besides a host of security fixes, GLib is now completely optional, files can be opened completely in-memory, and many global variables have been eliminated to facilitate thread safety. The core library, libmdb, is believed to be thread-safe in the sense that several handles can be opened simultaneously and passed between threads. However, individual handles are NOT thread-safe, so don't try to do work on a single handle from multiple threads without implementing your own locking mechanism. The auxiliary libraries, libmdbsql and ODBC, still have some non-reentrant function calls. Thread safety is not promised, though the situation is significantly improved from the 0.7 days. The ABI has some slight changes (mostly having to do with struct layouts) so you'll need to bump your SO numbers and such. The main changes to the API are the introduction of a new function for in-memory parsing: MdbHandle *mdb_open_buffer(void *buffer, size_t len, MdbFileFlags flags); And the modification of the "mdb_set_date_fmt" function to include a handle parameter, so that date formats can be set in a non-global fashion: void mdb_set_date_fmt(MdbHandle *mdb, const char *); The above function is the most common reason that old projects will fail to compile on 0.9, and the fix is straightforward. The previously-deprecated functions mdb_init() and mdb_exit() have been removed. These functions did nothing; any calls to them should be excised with prejudice. This release introduces two new CLI tools (mdb-count and mdb-queries) and deprecates mdb-array, mdb-header, and mdb-parsecsv. Several man pages have been added or otherwise brought up to date. The GNOME-based GUI tool that formerly shipped with MDB Tools has been moved to a separate project, here: https://github.com/mdbtools/gmdb2 It seems to compile but should probably be classified as abandonware. The project uses a deprecated GUI toolkit, and as such gmdb2 is no longer included in Linux distros that used to carry it. Version 0.7.1 ============= autogen.sh is no more. Use "autoreconf -if" to bootstrap the configuration. autoconf/automake has been updated to more recent standards. - config.guess config.sub depcomp install-sh ltmain.sh missing ylwrap files are now in build-aux/ directory You'll now need autoconf >= 2.58 An experimental (buggy) version of ODBC driver that supports UCS-2 interface is now available: libmdbodbcW.so Note that libmdbodbc supports UTF-8 really well, so that this is usually not needed. Version 0.3 =========== The organization of the project files has changed a bit from that last release. The autoconf stuff has been moved to the root directory. The include directory has also been moved from src/include to include mdbtools-1.0.1/README.md000066400000000000000000000137551473324601000146260ustar00rootroot00000000000000[![Build Status](https://github.com/mdbtools/mdbtools/workflows/build/badge.svg)](https://github.com/mdbtools/mdbtools/actions) [![Build status](https://ci.appveyor.com/api/projects/status/22wwy5d0rrmk6e3c/branch/dev?svg=true)](https://ci.appveyor.com/project/evanmiller/mdbtools/branch/dev) [![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/mdbtools.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:mdbtools) Welcome to the exciting world of MDB Tools! MDB Tools is a set of programs to help you extract data from Microsoft Access files in various settings. See the [NEWS](./NEWS) file for information about the latest release. ## Components The major pieces of MDB Tools are: ### libmdb The core library that allows access to MDB files programatically. See [mdbtools.h](./include/mdbtools.h.in) for the complete API. ### libmdbsql Builds on libmdb to provide a SQL engine (aka Jet). See [mdbsql.h](./include/mdbsql.h) for the complete API. ### utils Provides command line utilities, including: | Command | Description | | ------- | ----------- | | `mdb-ver` | Prints the version (JET 3 or 4) of an mdb file. | | `mdb-schema` | Prints DDL for the specified table. | | `mdb-export` | Export table to CSV or SQL formats. | | `mdb-json` | Export table to JSON format. | | `mdb-tables` | A simple dump of table names to be used with shell scripts. | | `mdb-count` | A simple count of number of rows in a table, to be used in shell scripts and ETL pipelines. | | `mdb-sql` | A simple SQL engine (also used by ODBC and gmdb). | | `mdb-queries` | List and print queries stored in the database. | | `mdb-hexdump`\* | (in [src/extras](./src/extras)) Simple hex dump utility to look at mdb files. | | `mdb-array`\* | Export data in an MDB database table to a C array. | | `mdb-header`\* | Generates a C header to be used in exporting mdb data to a C prog. | | `mdb-parsecsv`\* | Generates a C program given a CSV file made with mdb-export. | \* Deprecated See the man page of each program for usage instructions. The [src/util](./src/util) directory also contains a number of debugging tools, intended for developers. They are: | Command | Description | | ------- | ----------- | | `prcat` | Prints the catalog table from an mdb file. | | `prkkd` | Dump of information about design view data given the offset to it. | | `prtable` | Dump of a table definition. | | `prdata` | Dump of the data given a table name. | | `prole` | Dump of ole columns given a table name and sargs. | These tools are not installed on the host system. ### odbc An ODBC driver for use with unixODBC or iODBC driver manager. Allows one to use MDB files with PHP for example. ### gmdb2 The Gnome MDB File Viewer and debugger. Recently ported to GTK+3 and moved to [mdbtools/gmdb2](https://github.com/mdbtools/gmdb2). ## License Files in libmdb, libmdbsql, and libmdbodbc are licensed under LGPL and the utilities and gui program are under the GPL, see [COPYING.LIB](./COPYING.LIB) and [COPYING](./COPYING) files respectively. ## Requirements First, you must have reasonably current installations of: * [libtool](https://www.gnu.org/software/libtool/) * [automake](https://www.gnu.org/software/automake/) * [autoconf](https://www.gnu.org/software/autoconf/) (version >= 2.64) If you want to build the SQL engine, you'll need [bison](https://www.gnu.org/software/bison/) (version >= 3.0) or [byacc](https://invisible-island.net/byacc/byacc.html), and [flex](https://github.com/westes/flex). If you want to build the ODBC driver, you'll need `unixodbc-dev` (version 2.2.10 or above) or [iodbc](http://www.iodbc.org/dataspace/doc/iodbc/wiki/iodbcWiki/WelcomeVisitors). If you want to build man pages, you'll need [GNU awk](https://www.gnu.org/software/gawk/). ## Installation Latest version is available at https://github.com/mdbtools/mdbtools ### Debian ``` apt install mdbtools ``` ### Homebrew ```bash brew install mdbtools ``` ### MacPorts ```bash port install mdbtools ``` ### From source If you have cloned the Git repository, you will first need to generate the `configure` file (skip this step if you have downloaded a formal release): ```bash $ autoreconf -i -f ``` Then: ```bash $ ./configure ``` OR for a complete install (requires bison, flex, and unixODBC): ```bash $ ./configure --with-unixodbc=/usr/local ``` By default, MDB Tools is linked against the copy of [GLib](https://developer.gnome.org/glib/) returned by pkg-config. You can point to a different GLib installation using the `GLIB_CFLAGS` and `GLIB_LIBS` enivornment variables. Or, you can disable GLib entirely with the `--disable-glib` flag, in which case MDB Tools will use an internal implementation of GLib's functions. configure can be passed any of the following flags to turn on other capabilities. Note that the options `--with-unixodbc` and `--with-iodbc` are mutually exclusive. ``` --with-unixodbc specifies the location of the unixODBC driver manager and causes the unixODBC driver to be built. --with-iodbc specifies the location of the iODBC driver manager and causes the iODBC driver to be built. ``` By default, the ODBC driver will be installed as /usr/local/lib/odbc/libmdbodbc.so, with a Unicode-capable driver at /usr/local/lib/odbc/libmdbodbcW.so. The command `configure --help` will give you the list of mdbtools specific options. ```bash $ make ``` Once MDB Tools has been compiled, libmdb.[so|a] will be in the src/libmdb directory and the utility programs will be in the src/util directory. You can then install (to /usr/local by default) by running the following as root: ```bash $ make install ``` Some systems will also need the ld cache to be updated after installation; You can do that running: ```bash $ ldconfig ``` ## Hacking If you are interested in helping, read the [HACKING](./HACKING) file for a description of where the code stands and what has been gleened of the file format. ## Contact Please send bug reports to the new github repository. https://github.com/mdbtools/mdbtools/issues mdbtools-1.0.1/TODO.md000066400000000000000000000002271473324601000144240ustar00rootroot00000000000000TODO ---- See the list of [open issues tagged "enhancement"](https://github.com/mdbtools/mdbtools/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement). mdbtools-1.0.1/api_docx/000077500000000000000000000000001473324601000151225ustar00rootroot00000000000000mdbtools-1.0.1/api_docx/COPYING.md000077700000000000000000000000001473324601000200152../COPYINGustar00rootroot00000000000000mdbtools-1.0.1/api_docx/DoxygenLayout.xml000066400000000000000000000170761473324601000204720ustar00rootroot00000000000000 mdbtools-1.0.1/api_docx/NEWS.md000077700000000000000000000000001473324601000171252../NEWSustar00rootroot00000000000000mdbtools-1.0.1/api_docx/build_docs.sh000077500000000000000000000006331473324601000175720ustar00rootroot00000000000000#!/bin/bash set -e DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" echo "DIR = $DIR" ROOT="$(dirname "$DIR")" echo "ROOT = $ROOT" echo "### cleanup $ROOT/temp-man-pages" rm -f -r $ROOT/temp-man-pages mkdir $ROOT/temp-man-pages echo "### create man pages" which python3 python3 $ROOT/api_docx/pre_build.py echo "### doxygen version" doxygen -v doxygen $ROOT/api_docx/doxygen.conf mdbtools-1.0.1/api_docx/custom.css000066400000000000000000000664731473324601000171660ustar00rootroot00000000000000/* The standard CSS for doxygen 1.8.13 */ body, table, div, p, dl { font: 400 14px/22px Roboto,sans-serif; } body { background-color: #333333; } p.reference, p.definition { font-size: 9pt; } /* @group Heading Levels */ h1.groupheader { font-size: 120%; } .title { font: 400 14px/28px Roboto,sans-serif; font-size: 150%; font-weight: bold; margin: 10px 2px; } h2.groupheader { color: #eeeeee; font-size: 150%; font-weight: normal; margin-top: 30px; padding: 4px 0 4px 10px; width: 100%; background: linear-gradient(to right, #777777 0%, #333333 100%); border-radius: 5px; } h3.groupheader { font-size: 100%; } h1, h2, h3, h4, h5, h6 { -webkit-transition: text-shadow 0.5s linear; -moz-transition: text-shadow 0.5s linear; -ms-transition: text-shadow 0.5s linear; -o-transition: text-shadow 0.5s linear; transition: text-shadow 0.5s linear; margin-right: 15px; } h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { text-shadow: 0 0 15px cyan; } dt { font-weight: normal; font-size: 10pt; padding: 3px 5px; background-color: white; border-top: 1px dotted #dddddd; } div.multicol { -moz-column-gap: 1em; -webkit-column-gap: 1em; -moz-column-count: 3; -webkit-column-count: 3; } p.startli, p.startdd { margin-top: 2px; } p.starttd { margin-top: 0px; } p.endli { margin-bottom: 0px; } p.enddd { margin-bottom: 4px; } p.endtd { margin-bottom: 2px; } /* @end */ caption { font-weight: bold; } span.legend { font-size: 70%; text-align: center; } h3.version { font-size: 90%; text-align: center; } div.qindex, div.navtab { background-color: #EBEFF6; border: 1px solid #A3B4D7; text-align: center; } div.qindex, div.navpath { width: 100%; line-height: 140%; } div.navtab { margin-right: 15px; } /* @group Link Styling */ a { color: #3D578C; font-weight: normal; text-decoration: none; } .contents a:visited { color: #4665A2; } a:hover { text-decoration: underline; } a.qindex { font-weight: bold; } a.qindexHL { font-weight: bold; background-color: #9CAFD4; color: #ffffff; border: 1px double #869DCA; } .contents a.qindexHL:visited { color: #ffffff; } a.el { font-weight: bold; } a.code, a.code:visited, a.line, a.line:visited { color: #4665A2; } a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { color: #4665A2; } /* @end */ dl.el { margin-left: -1cm; } pre.fragment { border: 1px solid #C4CFE5; background-color: #FBFCFD; padding: 4px 6px; margin: 4px 8px 4px 2px; overflow: auto; word-wrap: break-word; font-size: 9pt; line-height: 125%; font-family: monospace, fixed; font-size: 105%; } div.fragment { padding: 0px; margin: 4px 8px 4px 2px; background-color: #FBFCFD; border: 1px solid #C4CFE5; } div.line { font-family: monospace, fixed; font-size: 13px; min-height: 13px; line-height: 1.0; text-wrap: unrestricted; white-space: -moz-pre-wrap; /* Moz */ white-space: -pre-wrap; /* Opera 4-6 */ white-space: -o-pre-wrap; /* Opera 7 */ white-space: pre-wrap; /* CSS3 */ word-wrap: break-word; /* IE 5.5+ */ text-indent: -53px; padding-left: 53px; padding-bottom: 0px; margin: 0px; -webkit-transition-property: background-color, box-shadow; -webkit-transition-duration: 0.5s; -moz-transition-property: background-color, box-shadow; -moz-transition-duration: 0.5s; -ms-transition-property: background-color, box-shadow; -ms-transition-duration: 0.5s; -o-transition-property: background-color, box-shadow; -o-transition-duration: 0.5s; transition-property: background-color, box-shadow; transition-duration: 0.5s; } div.line:after { content: "\000A"; white-space: pre; } div.line.glow { background-color: cyan; box-shadow: 0 0 10px cyan; } span.lineno { padding-right: 4px; text-align: right; border-right: 2px solid #0F0; background-color: #E8E8E8; white-space: pre; } span.lineno a { background-color: #D8D8D8; } span.lineno a:hover { background-color: #C8C8C8; } .lineno { -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } div.ah, span.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px; padding: 0.2em; border: solid thin #333; border-radius: 0.5em; -webkit-border-radius: .5em; -moz-border-radius: .5em; box-shadow: 2px 2px 3px #999; -webkit-box-shadow: 2px 2px 3px #999; -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000), color-stop(0.3, #444)); background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); } div.classindex ul { list-style: none; padding-left: 0; } div.classindex span.ai { display: inline-block; } div.groupHeader { margin-left: 16px; margin-top: 12px; font-weight: bold; } div.groupText { margin-left: 16px; font-style: italic; } body { background-color: white; color: black; margin: 0; } div.contents { margin-top: 10px; margin-left: 12px; margin-right: 8px; } td.indexkey { background-color: #EBEFF6; font-weight: bold; border: 1px solid #C4CFE5; margin: 2px 0px 2px 0; padding: 2px 10px; white-space: nowrap; vertical-align: top; } td.indexvalue { background-color: #EBEFF6; border: 1px solid #C4CFE5; padding: 2px 10px; margin: 2px 0px; } tr.memlist { background-color: #EEF1F7; } p.formulaDsp { text-align: center; } img.formulaInl { vertical-align: middle; } div.center { text-align: center; margin-top: 0px; margin-bottom: 0px; padding: 0px; } div.center img { border: 0px; } address.footer { text-align: right; padding-right: 12px; } img.footer { border: 0px; vertical-align: middle; } /* @group Code Colorization */ span.keyword { color: #008000; } span.keywordtype { color: #604020; } span.keywordflow { color: #e08000; } span.comment { color: #800000; } span.preprocessor { color: #806020; } span.stringliteral { color: #002080; } span.charliteral { color: #008080; } span.vhdldigit { color: #ff00ff; } span.vhdlchar { color: #000000; } span.vhdlkeyword { color: #700070; } span.vhdllogic { color: #ff0000; } blockquote { background-color: #F7F8FB; border-left: 2px solid #9CAFD4; margin: 0 24px 0 4px; padding: 0 12px 0 16px; } /* @end */ /* .search { color: #003399; font-weight: bold; } form.search { margin-bottom: 0px; margin-top: 0px; } input.search { font-size: 75%; color: #000080; font-weight: normal; background-color: #e8eef2; } */ td.tiny { font-size: 75%; } .dirtab { padding: 4px; border-collapse: collapse; border: 1px solid #A3B4D7; } th.dirtab { background: #EBEFF6; font-weight: bold; } hr { height: 0px; border: none; border-top: 1px solid #4A6AAA; } hr.footer { height: 1px; } /* @group Member Descriptions */ table.memberdecls { border-spacing: 0px; padding: 0px; margin-bottom: 10px; } .memberdecls td, .fieldtable tr { -webkit-transition-property: background-color, box-shadow; -webkit-transition-duration: 0.5s; -moz-transition-property: background-color, box-shadow; -moz-transition-duration: 0.5s; -ms-transition-property: background-color, box-shadow; -ms-transition-duration: 0.5s; -o-transition-property: background-color, box-shadow; -o-transition-duration: 0.5s; transition-property: background-color, box-shadow; transition-duration: 0.5s; } .memberdecls td.glow, .fieldtable tr.glow { background-color: cyan; box-shadow: 0 0 15px cyan; } .mdescLeft, .mdescRight, .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight, .memTemplParams { background-color: #F9FAFC; border: none; margin: 4px; padding: 1px 0 0 8px; } .mdescLeft, .mdescRight { padding: 0px 8px 4px 8px; color: #555; } .memSeparator { border-bottom: 1px solid #DEE4F0; line-height: 1px; margin: 0px; padding: 0px; } .memItemLeft, .memTemplItemLeft { white-space: nowrap; } .memItemRight { width: 100%; } .memTemplParams { color: #4665A2; white-space: nowrap; font-size: 80%; } /* @end */ /* @group Member Details */ /* Styles for detailed member documentation */ .memtitle { padding: 8px; border-top: 1px solid #dddddd; border-left: 1px solid #dddddd; border-right: 1px solid #dddddd; border-top-right-radius: 4px; border-top-left-radius: 4px; margin-bottom: -1px; background-color: #eeeeee; line-height: 1.25; font-weight: 400; float: left; font-size: 11pt; min-width: 30%; } .permalink { font-size: 65%; display: inline-block; vertical-align: middle; } .memtemplate { font-size: 80%; color: #4665A2; font-weight: normal; margin-left: 9px; } .memnav { background-color: #EBEFF6; border: 1px solid #A3B4D7; text-align: center; margin: 2px; margin-right: 15px; padding: 2px; } .mempage { width: 100%; } .memitem { padding: 0; margin-bottom: 10px; margin-right: 5px; -webkit-transition: box-shadow 0.5s linear; -moz-transition: box-shadow 0.5s linear; -ms-transition: box-shadow 0.5s linear; -o-transition: box-shadow 0.5s linear; transition: box-shadow 0.5s linear; display: table !important; width: 100%; } .memitem.glow { box-shadow: 0 0 15px cyan; } .memname { font-weight: 400; font-size: 10pt; margin-left: 6px; } .memname td { vertical-align: bottom; font-size: 10pt; } .memproto, dl.reflist dt { border-top: 1px solid #dddddd; border-left: 1px solid #dddddd; border-right: 1px solid #dddddd; padding: 6px 0px 6px 0px; color: #253555; font-weight: bold; background-color: #eeeeee; /* opera specific markup */ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); border-top-right-radius: 4px; /* firefox specific markup */ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; -moz-border-radius-topright: 4px; /* webkit specific markup */ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); -webkit-border-top-right-radius: 4px; } .overload { font-family: "courier new",courier,monospace; font-size: 65%; } .memdoc, dl.reflist dd { border-bottom: 1px solid #dddddd; border-left: 1px solid #dddddd; border-right: 1px solid #dddddd; padding: 6px 10px 2px 10px; background-color: #FBFCFD; border-top-width: 0; background-color: #eeeeee; /* opera specific markup */ border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); } dl.reflist dt { padding: 5px; } dl.reflist dd { margin: 0px 0px 10px 0px; padding: 5px; } .paramkey { text-align: right; } .paramtype { white-space: nowrap; } .paramname { color: #05790D; white-space: nowrap; } .paramname em { font-style: normal; } .paramname code { line-height: 14px; } .params, .retval, .exception, .tparams { margin-left: 0px; padding-left: 0px; } .params .paramname, .retval .paramname { font-weight: bold; vertical-align: top; } .params .paramtype { font-style: italic; vertical-align: top; } .params .paramdir { font-family: "courier new",courier,monospace; vertical-align: top; } .params tbody td { border-bottom: 1px dashed #bbbbbb; } table.mlabels { border-spacing: 0px; } td.mlabels-left { width: 100%; padding: 0px; } td.mlabels-right { vertical-align: bottom; padding: 0px; white-space: nowrap; } span.mlabels { margin-left: 8px; } span.mlabel { background-color: #FEFFA3; border: 1px solid #444444; text-shadow: none; color: black; margin-right: 4px; padding: 2px 3px; border-radius: 3px; font-size: 10pt; white-space: nowrap; vertical-align: middle; } /* @end */ /* these are for tree view inside a (index) page */ div.directory { margin: 10px 0px; border-top: 1px solid #9CAFD4; border-bottom: 1px solid #9CAFD4; width: 100%; } .directory table { border-collapse: collapse; } .directory td { margin: 0px; padding: 5px; vertical-align: top; } .directory td.entry { white-space: nowrap; padding-right: 6px; padding-top: 3px; } .directory td.entry a { outline: none; } .directory td.entry a img { border: none; } .directory td.desc { width: 100%; padding-left: 6px; padding-right: 6px; padding-top: 3px; border-left: 1px solid rgba(0, 0, 0, 0.05); } .directory tr.even { padding-left: 6px; background-color: #F7F8FB; } .directory img { vertical-align: -30%; } .directory .levels { white-space: nowrap; width: 100%; text-align: right; font-size: 9pt; } .directory .levels span { cursor: pointer; padding-left: 2px; padding-right: 2px; color: #3D578C; } .arrow { color: #9CAFD4; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; cursor: pointer; font-size: 80%; display: inline-block; width: 16px; height: 22px; } .icon { font-family: Arial, Helvetica; font-weight: bold; font-size: 12px; height: 14px; width: 16px; display: inline-block; background-color: #728DC1; color: white; text-align: center; border-radius: 4px; margin-left: 2px; margin-right: 2px; } .icona { width: 24px; height: 22px; display: inline-block; } .iconfopen { width: 24px; height: 18px; margin-bottom: 4px; background-image: url("folderopen.png"); background-position: 0px -4px; background-repeat: repeat-y; vertical-align: top; display: inline-block; } .iconfclosed { width: 24px; height: 18px; margin-bottom: 4px; background-image: url("folderclosed.png"); background-position: 0px -4px; background-repeat: repeat-y; vertical-align: top; display: inline-block; } .icondoc { width: 24px; height: 18px; margin-bottom: 4px; background-image: url("doc.png"); background-position: 0px -4px; background-repeat: repeat-y; vertical-align: top; display: inline-block; } table.directory { font: 400 14px Roboto,sans-serif; background-color: #efefef; border: 1px dotted #dddddd; } /* @end */ div.dynheader { margin-top: 8px; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } address { font-style: normal; color: #2A3D61; } table.doxtable caption { caption-side: top; } table.doxtable { border-collapse: collapse; margin-top: 4px; margin-bottom: 4px; } table.doxtable td, table.doxtable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } table.doxtable th { background-color: #374F7F; color: #FFFFFF; font-size: 110%; padding-bottom: 4px; padding-top: 5px; } table.fieldtable { /*width: 100%;*/ margin-bottom: 10px; border: 1px solid #A8B8D9; border-spacing: 0px; -moz-border-radius: 4px; -webkit-border-radius: 4px; border-radius: 4px; -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); } .fieldtable td, .fieldtable th { padding: 3px 7px 2px; } .fieldtable td.fieldtype, .fieldtable td.fieldname { white-space: nowrap; border-right: 1px solid #A8B8D9; border-bottom: 1px solid #A8B8D9; vertical-align: top; } .fieldtable td.fieldname { padding-top: 3px; } .fieldtable td.fielddoc { border-bottom: 1px solid #A8B8D9; /*width: 100%;*/ } .fieldtable td.fielddoc p:first-child { margin-top: 0px; } .fieldtable td.fielddoc p:last-child { margin-bottom: 2px; } .fieldtable tr:last-child td { border-bottom: none; } .fieldtable th { background-image: url("nav_f.png"); background-repeat: repeat-x; background-color: #E2E8F2; font-size: 90%; color: #253555; padding-bottom: 4px; padding-top: 5px; text-align: left; font-weight: 400; -moz-border-radius-topleft: 4px; -moz-border-radius-topright: 4px; -webkit-border-top-left-radius: 4px; -webkit-border-top-right-radius: 4px; border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom: 1px solid #A8B8D9; } .tabsearch { top: 0px; left: 10px; height: 36px; background-image: url("tab_b.png"); z-index: 101; overflow: hidden; font-size: 13px; } .navpath ul { font-size: 11px; background-image: url("tab_b.png"); background-repeat: repeat-x; background-position: 0 -5px; height: 30px; line-height: 30px; color: #8AA0CC; border: solid 1px #C2CDE4; overflow: hidden; margin: 0px; padding: 0px; } .navpath li { list-style-type: none; float: left; padding-left: 10px; padding-right: 15px; background-repeat: no-repeat; background-position: right; color: #364D7C; } .navpath li.navelem a { height: 32px; display: block; text-decoration: none; outline: none; color: #dddddd; text-decoration: none; } .navpath li.navelem a:hover { color: white; } .navpath li.footer { list-style-type: none; float: right; padding-left: 10px; padding-right: 15px; background-image: none; background-repeat: no-repeat; background-position: right; color: #364D7C; font-size: 8pt; } div.summary { float: right; font-size: 10pt; padding-right: 5px; width: 50%; text-align: right; } div.summary a { white-space: nowrap; } table.classindex { margin: 10px; white-space: nowrap; margin-left: 3%; margin-right: 3%; width: 94%; border: 0; border-spacing: 0; padding: 0; } div.ingroups { font-size: 8pt; width: 50%; text-align: left; } div.ingroups a { white-space: nowrap; } div.header { background-color: #dddddd; margin: 0px; border-bottom: 1px solid #aaaaaa; } div.headertitle { padding: 5px 5px 5px 10px; } dl { padding: 0 0 0 10px; } /* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ dl.section { margin-left: 0px; padding-left: 0px; } dl.note { margin-left: -7px; padding-left: 3px; border-left: 4px solid; border-color: #D0C000; } dl.warning, dl.attention { margin-left: -7px; padding-left: 3px; border-left: 4px solid; border-color: #FF0000; } dl.pre, dl.post, dl.invariant { margin-left: -7px; padding-left: 3px; border-left: 4px solid; border-color: #00D000; } dl.deprecated { margin-left: -7px; padding-left: 3px; border-left: 4px solid; border-color: #505050; } dl.todo { margin-left: -7px; padding-left: 3px; border-left: 4px solid; border-color: #00C0E0; } dl.test { margin-left: -7px; padding-left: 3px; border-left: 4px solid; border-color: #3030E0; } dl.bug { margin-left: -7px; padding-left: 3px; border-left: 4px solid; border-color: #C08050; } dl.section dd { margin-bottom: 6px; } #projectlogo { text-align: center; vertical-align: bottom; border-collapse: separate; } #projectlogo img { border: 0px none; } #projectalign { vertical-align: middle; } #projectname { font: 18pt monospace; margin: 0 0 0 40px; padding: 10px 0px; color: #dddddd; } #projectbrief { font: 120% Tahoma, Arial,sans-serif; margin: 0px; padding: 0px; } #projectnumber { font: 10pt Tahoma, Arial,sans-serif; margin: 0px; padding: 0px; } #titlearea { padding: 0px; margin: 0px; width: 100%; border-bottom: 1px dashed #777777; /* fallback/image non-cover color */ background-color: #186FA5; /* Standard */ background: linear-gradient(to right, #186FA5 0%, #186FA5 1%, #444444 3%, #666666 5%, #444444 50%, #333333 100%); } .image { text-align: center; } .dotgraph { text-align: center; } .mscgraph { text-align: center; } .plantumlgraph { text-align: center; } .diagraph { text-align: center; } .caption { font-weight: bold; } div.zoom { border: 1px solid #90A5CE; } dl.citelist { margin-bottom: 50px; } dl.citelist dt { color: #334975; float: left; font-weight: bold; margin-right: 10px; padding: 5px; } dl.citelist dd { margin: 2px 0; padding: 5px 0; } div.toc { padding: 14px 25px; background-color: #F4F6FA; border: 1px solid #D8DFEE; border-radius: 7px 7px 7px 7px; float: right; height: auto; margin: 0 8px 10px 10px; width: 200px; } div.toc li { background: url("bdwn.png") no-repeat scroll 0 5px transparent; font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; margin-top: 5px; padding-left: 10px; padding-top: 2px; } div.toc h3 { font: bold 12px/1.2 Arial,FreeSans,sans-serif; color: #4665A2; border-bottom: 0 none; margin: 0; } div.toc ul { list-style: none outside none; border: medium none; padding: 0px; } div.toc li.level1 { margin-left: 0px; } div.toc li.level2 { margin-left: 15px; } div.toc li.level3 { margin-left: 30px; } div.toc li.level4 { margin-left: 45px; } .inherit_header { font-weight: bold; color: gray; cursor: pointer; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } .inherit_header td { padding: 6px 0px 2px 5px; } .inherit { display: none; } tr.heading h2 { margin-top: 12px; margin-bottom: 4px; } /* tooltip related style info */ .ttc { position: absolute; display: none; } #powerTip { cursor: default; white-space: nowrap; background-color: white; border: 1px solid gray; border-radius: 4px 4px 4px 4px; box-shadow: 1px 1px 7px gray; display: none; font-size: smaller; max-width: 80%; opacity: 0.9; padding: 1ex 1em 1em; position: absolute; z-index: 2147483647; } #powerTip div.ttdoc { color: grey; font-style: italic; } #powerTip div.ttname a { font-weight: bold; } #powerTip div.ttname { font-weight: bold; } #powerTip div.ttdeci { color: #006318; } #powerTip div { margin: 0px; padding: 0px; font: 12px/16px Roboto,sans-serif; } #powerTip:before, #powerTip:after { content: ""; position: absolute; margin: 0px; } #powerTip.n:after, #powerTip.n:before, #powerTip.s:after, #powerTip.s:before, #powerTip.w:after, #powerTip.w:before, #powerTip.e:after, #powerTip.e:before, #powerTip.ne:after, #powerTip.ne:before, #powerTip.se:after, #powerTip.se:before, #powerTip.nw:after, #powerTip.nw:before, #powerTip.sw:after, #powerTip.sw:before { border: solid transparent; content: " "; height: 0; width: 0; position: absolute; } #powerTip.n:after, #powerTip.s:after, #powerTip.w:after, #powerTip.e:after, #powerTip.nw:after, #powerTip.ne:after, #powerTip.sw:after, #powerTip.se:after { border-color: rgba(255, 255, 255, 0); } #powerTip.n:before, #powerTip.s:before, #powerTip.w:before, #powerTip.e:before, #powerTip.nw:before, #powerTip.ne:before, #powerTip.sw:before, #powerTip.se:before { border-color: rgba(128, 128, 128, 0); } #powerTip.n:after, #powerTip.n:before, #powerTip.ne:after, #powerTip.ne:before, #powerTip.nw:after, #powerTip.nw:before { top: 100%; } #powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { border-top-color: #ffffff; border-width: 10px; margin: 0px -10px; } #powerTip.n:before { border-top-color: #808080; border-width: 11px; margin: 0px -11px; } #powerTip.n:after, #powerTip.n:before { left: 50%; } #powerTip.nw:after, #powerTip.nw:before { right: 14px; } #powerTip.ne:after, #powerTip.ne:before { left: 14px; } #powerTip.s:after, #powerTip.s:before, #powerTip.se:after, #powerTip.se:before, #powerTip.sw:after, #powerTip.sw:before { bottom: 100%; } #powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { border-bottom-color: #ffffff; border-width: 10px; margin: 0px -10px; } #powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { border-bottom-color: #808080; border-width: 11px; margin: 0px -11px; } #powerTip.s:after, #powerTip.s:before { left: 50%; } #powerTip.sw:after, #powerTip.sw:before { right: 14px; } #powerTip.se:after, #powerTip.se:before { left: 14px; } #powerTip.e:after, #powerTip.e:before { left: 100%; } #powerTip.e:after { border-left-color: #ffffff; border-width: 10px; top: 50%; margin-top: -10px; } #powerTip.e:before { border-left-color: #808080; border-width: 11px; top: 50%; margin-top: -11px; } #powerTip.w:after, #powerTip.w:before { right: 100%; } #powerTip.w:after { border-right-color: #ffffff; border-width: 10px; top: 50%; margin-top: -10px; } #powerTip.w:before { border-right-color: #808080; border-width: 11px; top: 50%; margin-top: -11px; } @media print { #top { display: none; } #side-nav { display: none; } #nav-path { display: none; } body { overflow: visible; } h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } .summary { display: none; } .memitem { page-break-inside: avoid; } #doc-content { margin-left: 0 !important; height: auto !important; width: auto !important; overflow: inherit; display: inline; } } /* @group Markdown */ /* table.markdownTable { border-collapse:collapse; margin-top: 4px; margin-bottom: 4px; } table.markdownTable td, table.markdownTable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } table.markdownTableHead tr { } table.markdownTableBodyLeft td, table.markdownTable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } th.markdownTableHeadLeft th.markdownTableHeadRight th.markdownTableHeadCenter th.markdownTableHeadNone { background-color: #374F7F; color: #FFFFFF; font-size: 110%; padding-bottom: 4px; padding-top: 5px; } th.markdownTableHeadLeft { text-align: left } th.markdownTableHeadRight { text-align: right } th.markdownTableHeadCenter { text-align: center } */ table.markdownTable { border-collapse: collapse; margin-top: 4px; margin-bottom: 4px; } table.markdownTable td, table.markdownTable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { background-color: #374F7F; color: #FFFFFF; font-size: 110%; padding-bottom: 4px; padding-top: 5px; } th.markdownTableHeadLeft, td.markdownTableBodyLeft { text-align: left; } th.markdownTableHeadRight, td.markdownTableBodyRight { text-align: right; } th.markdownTableHeadCenter, td.markdownTableBodyCenter { text-align: center; } /* @end */ #logo_txt { float: right; padding: 10px 15px 0 0; font-family: Anton; color: white; font-size: 26pt; } #logo_txt a { color: white; text-decoration: none; } #logo_txt a:hover { color: #B7473A; text-decoration: none; } #logo_plc { color: #B7473A; } a:hover #logo_plc { color: white; } #openplc_ver { color: #999999; font-family: monospace; font-size: 14pt; padding: 10px; margin: 10px; } #main-nav .sm { background-image: none; background-color: #333333; } #main-nav .sm-dox { background-image: none; } #main-nav .sm-dox a { background-image: none; text-shadow: none; color: #dddddd; } #main-nav .sm-dox a:hover { background-image: none; background-color: #666666; } #main-nav .sm-dox ul li a { color: black; } #main-nav .sm-dox ul li a:hover { color: white; } #nav-tree a { color: black; } #nav-tree .selected { background-image: none; background-color: #666666; text-shadow: none; } #nav-path ul { background-image: none; background-color: #333333; } #nav-path .footer { color: #dddddd; } .ui-resizable-e { background-image: none; background-color: #dddddd; } dl.see dt { border-left: 4px solid #E1D033; } dl.params dt { border-left: 4px solid #169735; } dl.return dt { border-left: 4px solid #97166D; } .contents h2 { background-color: #eeeeee; padding: 3px 3px; border-top: 1px dashed #dddddd; border-right: 10px dashed #dddddd; } .edit_button { float: right; text-decoration: none; } table td { font-family: monospace; } table td b { color: darkgreen; } table th { background-color: #444444; } /*# sourceMappingURL=custom.css.map */ mdbtools-1.0.1/api_docx/custom.scss000066400000000000000000000731251473324601000173410ustar00rootroot00000000000000/* The standard CSS for doxygen 1.8.13 */ @mixin topbar-gradient($color) { /* fallback/image non-cover color */ background-color: $color; /* Standard */ background: linear-gradient(to right, $color 0%, $color 1%, #444444 3%, #666666 5%, #444444 50%, #333333 100%); } $tab_border: #dddddd; //$tab_bg_color: #dddddd; $tab_bg_color: #eeeeee; body, table, div, p, dl { font: 400 14px/22px Roboto,sans-serif; } body { background-color: #333333; } p.reference, p.definition { font-size: 9pt; } /* @group Heading Levels */ h1.groupheader { font-size: 120%; } .title { font: 400 14px/28px Roboto,sans-serif; font-size: 150%; font-weight: bold; margin: 10px 2px; } h2.groupheader { //border-bottom: 1px solid #879ECB; color: #eeeeee; font-size: 150%; font-weight: normal; margin-top: 30px; padding: 4px 0 4px 10px; width: 100%; //#background-color: #aaaaaa; background: linear-gradient(to right,#777777 0%, #333333 100%); border-radius: 5px; } h3.groupheader { font-size: 100%; } h1, h2, h3, h4, h5, h6 { -webkit-transition: text-shadow 0.5s linear; -moz-transition: text-shadow 0.5s linear; -ms-transition: text-shadow 0.5s linear; -o-transition: text-shadow 0.5s linear; transition: text-shadow 0.5s linear; margin-right: 15px; } h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { text-shadow: 0 0 15px cyan; } dt { font-weight: normal; font-size: 10pt; padding: 3px 5px; background-color: white; border-top: 1px dotted #dddddd; } div.multicol { -moz-column-gap: 1em; -webkit-column-gap: 1em; -moz-column-count: 3; -webkit-column-count: 3; } p.startli, p.startdd { margin-top: 2px; } p.starttd { margin-top: 0px; } p.endli { margin-bottom: 0px; } p.enddd { margin-bottom: 4px; } p.endtd { margin-bottom: 2px; } /* @end */ caption { font-weight: bold; } span.legend { font-size: 70%; text-align: center; } h3.version { font-size: 90%; text-align: center; } div.qindex, div.navtab{ background-color: #EBEFF6; border: 1px solid #A3B4D7; text-align: center; } div.qindex, div.navpath { width: 100%; line-height: 140%; } div.navtab { margin-right: 15px; } /* @group Link Styling */ a { color: #3D578C; font-weight: normal; text-decoration: none; } .contents a:visited { color: #4665A2; } a:hover { text-decoration: underline; } a.qindex { font-weight: bold; } a.qindexHL { font-weight: bold; background-color: #9CAFD4; color: #ffffff; border: 1px double #869DCA; } .contents a.qindexHL:visited { color: #ffffff; } a.el { font-weight: bold; } a.elRef { } a.code, a.code:visited, a.line, a.line:visited { color: #4665A2; } a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { color: #4665A2; } /* @end */ dl.el { margin-left: -1cm; } pre.fragment { border: 1px solid #C4CFE5; background-color: #FBFCFD; padding: 4px 6px; margin: 4px 8px 4px 2px; overflow: auto; word-wrap: break-word; font-size: 9pt; line-height: 125%; font-family: monospace, fixed; font-size: 105%; } div.fragment { padding: 0px; margin: 4px 8px 4px 2px; background-color: #FBFCFD; border: 1px solid #C4CFE5; } div.line { font-family: monospace, fixed; font-size: 13px; min-height: 13px; line-height: 1.0; text-wrap: unrestricted; white-space: -moz-pre-wrap; /* Moz */ white-space: -pre-wrap; /* Opera 4-6 */ white-space: -o-pre-wrap; /* Opera 7 */ white-space: pre-wrap; /* CSS3 */ word-wrap: break-word; /* IE 5.5+ */ text-indent: -53px; padding-left: 53px; padding-bottom: 0px; margin: 0px; -webkit-transition-property: background-color, box-shadow; -webkit-transition-duration: 0.5s; -moz-transition-property: background-color, box-shadow; -moz-transition-duration: 0.5s; -ms-transition-property: background-color, box-shadow; -ms-transition-duration: 0.5s; -o-transition-property: background-color, box-shadow; -o-transition-duration: 0.5s; transition-property: background-color, box-shadow; transition-duration: 0.5s; } div.line:after { content:"\000A"; white-space: pre; } div.line.glow { background-color: cyan; box-shadow: 0 0 10px cyan; } span.lineno { padding-right: 4px; text-align: right; border-right: 2px solid #0F0; background-color: #E8E8E8; white-space: pre; } span.lineno a { background-color: #D8D8D8; } span.lineno a:hover { background-color: #C8C8C8; } .lineno { -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } div.ah, span.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px; padding: 0.2em; border: solid thin #333; border-radius: 0.5em; -webkit-border-radius: .5em; -moz-border-radius: .5em; box-shadow: 2px 2px 3px #999; -webkit-box-shadow: 2px 2px 3px #999; -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); } div.classindex ul { list-style: none; padding-left: 0; } div.classindex span.ai { display: inline-block; } div.groupHeader { margin-left: 16px; margin-top: 12px; font-weight: bold; } div.groupText { margin-left: 16px; font-style: italic; } body { background-color: white; color: black; margin: 0; } div.contents { margin-top: 10px; margin-left: 12px; margin-right: 8px; } td.indexkey { background-color: #EBEFF6; font-weight: bold; border: 1px solid #C4CFE5; margin: 2px 0px 2px 0; padding: 2px 10px; white-space: nowrap; vertical-align: top; } td.indexvalue { background-color: #EBEFF6; border: 1px solid #C4CFE5; padding: 2px 10px; margin: 2px 0px; } tr.memlist { background-color: #EEF1F7; } p.formulaDsp { text-align: center; } img.formulaDsp { } img.formulaInl { vertical-align: middle; } div.center { text-align: center; margin-top: 0px; margin-bottom: 0px; padding: 0px; } div.center img { border: 0px; } address.footer { text-align: right; padding-right: 12px; } img.footer { border: 0px; vertical-align: middle; } /* @group Code Colorization */ span.keyword { color: #008000 } span.keywordtype { color: #604020 } span.keywordflow { color: #e08000 } span.comment { color: #800000 } span.preprocessor { color: #806020 } span.stringliteral { color: #002080 } span.charliteral { color: #008080 } span.vhdldigit { color: #ff00ff } span.vhdlchar { color: #000000 } span.vhdlkeyword { color: #700070 } span.vhdllogic { color: #ff0000 } blockquote { background-color: #F7F8FB; border-left: 2px solid #9CAFD4; margin: 0 24px 0 4px; padding: 0 12px 0 16px; } /* @end */ /* .search { color: #003399; font-weight: bold; } form.search { margin-bottom: 0px; margin-top: 0px; } input.search { font-size: 75%; color: #000080; font-weight: normal; background-color: #e8eef2; } */ td.tiny { font-size: 75%; } .dirtab { padding: 4px; border-collapse: collapse; border: 1px solid #A3B4D7; } th.dirtab { background: #EBEFF6; font-weight: bold; } hr { height: 0px; border: none; border-top: 1px solid #4A6AAA; } hr.footer { height: 1px; } /* @group Member Descriptions */ table.memberdecls { border-spacing: 0px; padding: 0px; margin-bottom: 10px; } .memberdecls td, .fieldtable tr { -webkit-transition-property: background-color, box-shadow; -webkit-transition-duration: 0.5s; -moz-transition-property: background-color, box-shadow; -moz-transition-duration: 0.5s; -ms-transition-property: background-color, box-shadow; -ms-transition-duration: 0.5s; -o-transition-property: background-color, box-shadow; -o-transition-duration: 0.5s; transition-property: background-color, box-shadow; transition-duration: 0.5s; } .memberdecls td.glow, .fieldtable tr.glow { background-color: cyan; box-shadow: 0 0 15px cyan; } .mdescLeft, .mdescRight, .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight, .memTemplParams { background-color: #F9FAFC; border: none; margin: 4px; padding: 1px 0 0 8px; } .mdescLeft, .mdescRight { padding: 0px 8px 4px 8px; color: #555; } .memSeparator { border-bottom: 1px solid #DEE4F0; line-height: 1px; margin: 0px; padding: 0px; } .memItemLeft, .memTemplItemLeft { white-space: nowrap; } .memItemRight { width: 100%; } .memTemplParams { color: #4665A2; white-space: nowrap; font-size: 80%; } /* @end */ /* @group Member Details */ /* Styles for detailed member documentation */ .memtitle { padding: 8px; border-top: 1px solid $tab_border; border-left: 1px solid $tab_border; border-right: 1px solid $tab_border; border-top-right-radius: 4px; border-top-left-radius: 4px; margin-bottom: -1px; //background-image: url('nav_f.png'); //background-repeat: repeat-x; background-color: $tab_bg_color; line-height: 1.25; font-weight: 400; float:left; font-size: 11pt; min-width: 30%; } .permalink { font-size: 65%; display: inline-block; vertical-align: middle; } .memtemplate { font-size: 80%; color: #4665A2; font-weight: normal; margin-left: 9px; } .memnav { background-color: #EBEFF6; border: 1px solid #A3B4D7; text-align: center; margin: 2px; margin-right: 15px; padding: 2px; } .mempage { width: 100%; } .memitem { padding: 0; margin-bottom: 10px; margin-right: 5px; -webkit-transition: box-shadow 0.5s linear; -moz-transition: box-shadow 0.5s linear; -ms-transition: box-shadow 0.5s linear; -o-transition: box-shadow 0.5s linear; transition: box-shadow 0.5s linear; display: table !important; width: 100%; } .memitem.glow { box-shadow: 0 0 15px cyan; } .memname { font-weight: 400; font-size: 10pt; margin-left: 6px; } .memname td { vertical-align: bottom; font-size: 10pt; } .memproto, dl.reflist dt { border-top: 1px solid $tab_border; border-left: 1px solid $tab_border; border-right: 1px solid $tab_border; padding: 6px 0px 6px 0px; color: #253555; font-weight: bold; //text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); background-color: $tab_bg_color; /* opera specific markup */ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); border-top-right-radius: 4px; /* firefox specific markup */ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; -moz-border-radius-topright: 4px; /* webkit specific markup */ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); -webkit-border-top-right-radius: 4px; } .overload { font-family: "courier new",courier,monospace; font-size: 65%; } .memdoc, dl.reflist dd { border-bottom: 1px solid $tab_border; border-left: 1px solid $tab_border; border-right: 1px solid $tab_border; padding: 6px 10px 2px 10px; background-color: #FBFCFD; border-top-width: 0; //background-image:url('nav_g.png'); //background-repeat:repeat-x; background-color: $tab_bg_color; /* opera specific markup */ border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); } dl.reflist dt { padding: 5px; } dl.reflist dd { margin: 0px 0px 10px 0px; padding: 5px; } .paramkey { text-align: right; } .paramtype { white-space: nowrap; } .paramname { color: #05790D; white-space: nowrap; } .paramname em { font-style: normal; } .paramname code { line-height: 14px; } .params, .retval, .exception, .tparams { margin-left: 0px; padding-left: 0px; } .params .paramname, .retval .paramname { font-weight: bold; vertical-align: top; } .params .paramtype { font-style: italic; vertical-align: top; } .params .paramdir { font-family: "courier new",courier,monospace; vertical-align: top; } .params tbody td { border-bottom: 1px dashed #bbbbbb; } table.mlabels { border-spacing: 0px; } td.mlabels-left { width: 100%; padding: 0px; } td.mlabels-right { vertical-align: bottom; padding: 0px; white-space: nowrap; } span.mlabels { margin-left: 8px; } span.mlabel { background-color: #FEFFA3; border:1px solid #444444; text-shadow: none; color: black; margin-right: 4px; padding: 2px 3px; border-radius: 3px; font-size: 10pt; white-space: nowrap; vertical-align: middle; } /* @end */ /* these are for tree view inside a (index) page */ div.directory { margin: 10px 0px; border-top: 1px solid #9CAFD4; border-bottom: 1px solid #9CAFD4; width: 100%; } .directory table { border-collapse:collapse; } .directory td { margin: 0px; padding: 5px; vertical-align: top; } .directory td.entry { white-space: nowrap; padding-right: 6px; padding-top: 3px; } .directory td.entry a { outline:none; } .directory td.entry a img { border: none; } .directory td.desc { width: 100%; padding-left: 6px; padding-right: 6px; padding-top: 3px; border-left: 1px solid rgba(0,0,0,0.05); } .directory tr.even { padding-left: 6px; background-color: #F7F8FB; } .directory img { vertical-align: -30%; } .directory .levels { white-space: nowrap; width: 100%; text-align: right; font-size: 9pt; } .directory .levels span { cursor: pointer; padding-left: 2px; padding-right: 2px; color: #3D578C; } .arrow { color: #9CAFD4; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; cursor: pointer; font-size: 80%; display: inline-block; width: 16px; height: 22px; } .icon { font-family: Arial, Helvetica; font-weight: bold; font-size: 12px; height: 14px; width: 16px; display: inline-block; background-color: #728DC1; color: white; text-align: center; border-radius: 4px; margin-left: 2px; margin-right: 2px; } .icona { width: 24px; height: 22px; display: inline-block; } .iconfopen { width: 24px; height: 18px; margin-bottom: 4px; background-image:url('folderopen.png'); background-position: 0px -4px; background-repeat: repeat-y; vertical-align:top; display: inline-block; } .iconfclosed { width: 24px; height: 18px; margin-bottom: 4px; background-image:url('folderclosed.png'); background-position: 0px -4px; background-repeat: repeat-y; vertical-align:top; display: inline-block; } .icondoc { width: 24px; height: 18px; margin-bottom: 4px; background-image:url('doc.png'); background-position: 0px -4px; background-repeat: repeat-y; vertical-align:top; display: inline-block; } table.directory { font: 400 14px Roboto,sans-serif; background-color: #efefef; border: 1px dotted #dddddd; } /* @end */ div.dynheader { margin-top: 8px; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } address { font-style: normal; color: #2A3D61; } table.doxtable caption { caption-side: top; } table.doxtable { border-collapse:collapse; margin-top: 4px; margin-bottom: 4px; } table.doxtable td, table.doxtable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } table.doxtable th { background-color: #374F7F; color: #FFFFFF; font-size: 110%; padding-bottom: 4px; padding-top: 5px; } table.fieldtable { /*width: 100%;*/ margin-bottom: 10px; border: 1px solid #A8B8D9; border-spacing: 0px; -moz-border-radius: 4px; -webkit-border-radius: 4px; border-radius: 4px; -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); } .fieldtable td, .fieldtable th { padding: 3px 7px 2px; } .fieldtable td.fieldtype, .fieldtable td.fieldname { white-space: nowrap; border-right: 1px solid #A8B8D9; border-bottom: 1px solid #A8B8D9; vertical-align: top; } .fieldtable td.fieldname { padding-top: 3px; } .fieldtable td.fielddoc { border-bottom: 1px solid #A8B8D9; /*width: 100%;*/ } .fieldtable td.fielddoc p:first-child { margin-top: 0px; } .fieldtable td.fielddoc p:last-child { margin-bottom: 2px; } .fieldtable tr:last-child td { border-bottom: none; } .fieldtable th { background-image:url('nav_f.png'); background-repeat:repeat-x; background-color: #E2E8F2; font-size: 90%; color: #253555; padding-bottom: 4px; padding-top: 5px; text-align:left; font-weight: 400; -moz-border-radius-topleft: 4px; -moz-border-radius-topright: 4px; -webkit-border-top-left-radius: 4px; -webkit-border-top-right-radius: 4px; border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom: 1px solid #A8B8D9; } .tabsearch { top: 0px; left: 10px; height: 36px; background-image: url('tab_b.png'); z-index: 101; overflow: hidden; font-size: 13px; } .navpath ul { font-size: 11px; background-image:url('tab_b.png'); background-repeat:repeat-x; background-position: 0 -5px; height:30px; line-height:30px; color:#8AA0CC; border:solid 1px #C2CDE4; overflow:hidden; margin:0px; padding:0px; } .navpath li { list-style-type:none; float:left; padding-left:10px; padding-right:15px; //background-image:url('bc_s.png'); background-repeat:no-repeat; background-position:right; color:#364D7C; } .navpath li.navelem a { height:32px; display:block; text-decoration: none; outline: none; color: #dddddd; //font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; //text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); text-decoration: none; } .navpath li.navelem a:hover { color: white; } .navpath li.footer { list-style-type:none; float:right; padding-left:10px; padding-right:15px; background-image:none; background-repeat:no-repeat; background-position:right; color:#364D7C; font-size: 8pt; } div.summary { float: right; font-size: 10pt; padding-right: 5px; width: 50%; text-align: right; } div.summary a { white-space: nowrap; } table.classindex { margin: 10px; white-space: nowrap; margin-left: 3%; margin-right: 3%; width: 94%; border: 0; border-spacing: 0; padding: 0; } div.ingroups { font-size: 8pt; width: 50%; text-align: left; } div.ingroups a { white-space: nowrap; } div.header { //background-image:url('nav_h.png'); //background-repeat:repeat-x; background-color: #dddddd; margin: 0px; border-bottom: 1px solid #aaaaaa; } div.headertitle { padding: 5px 5px 5px 10px; } dl { padding: 0 0 0 10px; } /* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ dl.section { margin-left: 0px; padding-left: 0px; } dl.note { margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #D0C000; } dl.warning, dl.attention { margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #FF0000; } dl.pre, dl.post, dl.invariant { margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #00D000; } dl.deprecated { margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #505050; } dl.todo { margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #00C0E0; } dl.test { margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #3030E0; } dl.bug { margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #C08050; } dl.section dd { margin-bottom: 6px; } #projectlogo { text-align: center; vertical-align: bottom; border-collapse: separate; } #projectlogo img { border: 0px none; } #projectalign { vertical-align: middle; } #projectname { font: 18pt monospace; margin: 0 0 0 40px; padding: 10px 0px; color: #dddddd; } #projectbrief { font: 120% Tahoma, Arial,sans-serif; margin: 0px; padding: 0px; } #projectnumber { font: 10pt Tahoma, Arial,sans-serif; margin: 0px; padding: 0px; } // top banner #titlearea { padding: 0px; margin: 0px; width: 100%; border-bottom: 1px dashed #777777; //background-color: blue; @include topbar-gradient(#186FA5); } .image { text-align: center; } .dotgraph { text-align: center; } .mscgraph { text-align: center; } .plantumlgraph { text-align: center; } .diagraph { text-align: center; } .caption { font-weight: bold; } div.zoom { border: 1px solid #90A5CE; } dl.citelist { margin-bottom:50px; } dl.citelist dt { color:#334975; float:left; font-weight:bold; margin-right:10px; padding:5px; } dl.citelist dd { margin:2px 0; padding:5px 0; } div.toc { padding: 14px 25px; background-color: #F4F6FA; border: 1px solid #D8DFEE; border-radius: 7px 7px 7px 7px; float: right; height: auto; margin: 0 8px 10px 10px; width: 200px; } div.toc li { background: url("bdwn.png") no-repeat scroll 0 5px transparent; font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; margin-top: 5px; padding-left: 10px; padding-top: 2px; } div.toc h3 { font: bold 12px/1.2 Arial,FreeSans,sans-serif; color: #4665A2; border-bottom: 0 none; margin: 0; } div.toc ul { list-style: none outside none; border: medium none; padding: 0px; } div.toc li.level1 { margin-left: 0px; } div.toc li.level2 { margin-left: 15px; } div.toc li.level3 { margin-left: 30px; } div.toc li.level4 { margin-left: 45px; } .inherit_header { font-weight: bold; color: gray; cursor: pointer; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } .inherit_header td { padding: 6px 0px 2px 5px; } .inherit { display: none; } tr.heading h2 { margin-top: 12px; margin-bottom: 4px; } /* tooltip related style info */ .ttc { position: absolute; display: none; } #powerTip { cursor: default; white-space: nowrap; background-color: white; border: 1px solid gray; border-radius: 4px 4px 4px 4px; box-shadow: 1px 1px 7px gray; display: none; font-size: smaller; max-width: 80%; opacity: 0.9; padding: 1ex 1em 1em; position: absolute; z-index: 2147483647; } #powerTip div.ttdoc { color: grey; font-style: italic; } #powerTip div.ttname a { font-weight: bold; } #powerTip div.ttname { font-weight: bold; } #powerTip div.ttdeci { color: #006318; } #powerTip div { margin: 0px; padding: 0px; font: 12px/16px Roboto,sans-serif; } #powerTip:before, #powerTip:after { content: ""; position: absolute; margin: 0px; } #powerTip.n:after, #powerTip.n:before, #powerTip.s:after, #powerTip.s:before, #powerTip.w:after, #powerTip.w:before, #powerTip.e:after, #powerTip.e:before, #powerTip.ne:after, #powerTip.ne:before, #powerTip.se:after, #powerTip.se:before, #powerTip.nw:after, #powerTip.nw:before, #powerTip.sw:after, #powerTip.sw:before { border: solid transparent; content: " "; height: 0; width: 0; position: absolute; } #powerTip.n:after, #powerTip.s:after, #powerTip.w:after, #powerTip.e:after, #powerTip.nw:after, #powerTip.ne:after, #powerTip.sw:after, #powerTip.se:after { border-color: rgba(255, 255, 255, 0); } #powerTip.n:before, #powerTip.s:before, #powerTip.w:before, #powerTip.e:before, #powerTip.nw:before, #powerTip.ne:before, #powerTip.sw:before, #powerTip.se:before { border-color: rgba(128, 128, 128, 0); } #powerTip.n:after, #powerTip.n:before, #powerTip.ne:after, #powerTip.ne:before, #powerTip.nw:after, #powerTip.nw:before { top: 100%; } #powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { border-top-color: #ffffff; border-width: 10px; margin: 0px -10px; } #powerTip.n:before { border-top-color: #808080; border-width: 11px; margin: 0px -11px; } #powerTip.n:after, #powerTip.n:before { left: 50%; } #powerTip.nw:after, #powerTip.nw:before { right: 14px; } #powerTip.ne:after, #powerTip.ne:before { left: 14px; } #powerTip.s:after, #powerTip.s:before, #powerTip.se:after, #powerTip.se:before, #powerTip.sw:after, #powerTip.sw:before { bottom: 100%; } #powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { border-bottom-color: #ffffff; border-width: 10px; margin: 0px -10px; } #powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { border-bottom-color: #808080; border-width: 11px; margin: 0px -11px; } #powerTip.s:after, #powerTip.s:before { left: 50%; } #powerTip.sw:after, #powerTip.sw:before { right: 14px; } #powerTip.se:after, #powerTip.se:before { left: 14px; } #powerTip.e:after, #powerTip.e:before { left: 100%; } #powerTip.e:after { border-left-color: #ffffff; border-width: 10px; top: 50%; margin-top: -10px; } #powerTip.e:before { border-left-color: #808080; border-width: 11px; top: 50%; margin-top: -11px; } #powerTip.w:after, #powerTip.w:before { right: 100%; } #powerTip.w:after { border-right-color: #ffffff; border-width: 10px; top: 50%; margin-top: -10px; } #powerTip.w:before { border-right-color: #808080; border-width: 11px; top: 50%; margin-top: -11px; } @media print { #top { display: none; } #side-nav { display: none; } #nav-path { display: none; } body { overflow:visible; } h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } .summary { display: none; } .memitem { page-break-inside: avoid; } #doc-content { margin-left:0 !important; height:auto !important; width:auto !important; overflow:inherit; display:inline; } } /* @group Markdown */ /* table.markdownTable { border-collapse:collapse; margin-top: 4px; margin-bottom: 4px; } table.markdownTable td, table.markdownTable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } table.markdownTableHead tr { } table.markdownTableBodyLeft td, table.markdownTable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } th.markdownTableHeadLeft th.markdownTableHeadRight th.markdownTableHeadCenter th.markdownTableHeadNone { background-color: #374F7F; color: #FFFFFF; font-size: 110%; padding-bottom: 4px; padding-top: 5px; } th.markdownTableHeadLeft { text-align: left } th.markdownTableHeadRight { text-align: right } th.markdownTableHeadCenter { text-align: center } */ table.markdownTable { border-collapse:collapse; margin-top: 4px; margin-bottom: 4px; } table.markdownTable td, table.markdownTable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } table.markdownTable tr { } th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { background-color: #374F7F; color: #FFFFFF; font-size: 110%; padding-bottom: 4px; padding-top: 5px; } th.markdownTableHeadLeft, td.markdownTableBodyLeft { text-align: left } th.markdownTableHeadRight, td.markdownTableBodyRight { text-align: right } th.markdownTableHeadCenter, td.markdownTableBodyCenter { text-align: center } /* @end */ // main top nav #logo_txt { float: right; padding: 10px 15px 0 0; font-family: Anton; color: white; font-size: 26pt; } #logo_txt a { color: white; text-decoration: none; } #logo_txt a:hover { color: #B7473A; text-decoration: none; } #logo_plc{ color: #B7473A; } a:hover #logo_plc{ color: white; } #openplc_ver{ color: #999999; font-family: monospace; font-size: 14pt; padding: 10px; margin: 10px; } #main-nav { //background-color: black; .sm { background-image: none; background-color: #333333; } .sm-dox { background-image: none; a { background-image: none; text-shadow: none; color: #dddddd; } a:hover { background-image: none; background-color: #666666; } ul li a { color: black; } ul li a:hover { color: white; } } } #nav-tree { a { color: black; } .selected { background-image: none; background-color: #666666; text-shadow: none; } } // footer #nav-path { ul { background-image: none; background-color: #333333; } .footer { color: #dddddd; } } .ui-resizable-e { background-image: none; background-color: #dddddd; } // little color borders dl.see { dt { border-left: 4px solid #E1D033; } } dl.params { dt { border-left: 4px solid #169735; } } dl.return { dt { border-left: 4px solid #97166D; } } .contents h2 { background-color: #eeeeee; padding: 3px 3px; border-top: 1px dashed #dddddd; border-right: 10px dashed #dddddd; } .edit_button { float: right; text-decoration: none; } table td { font-family: monospace; //background-color: red; b { color: darkgreen; } } table th { background-color: #444444; } mdbtools-1.0.1/api_docx/doxygen.conf000066400000000000000000003342731473324601000174620ustar00rootroot00000000000000# Doxyfile 1.8.17 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the configuration # file that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = "Developer Docs" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = "latest" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = "api_docx/mdb-tools-logo.png" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = YES # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all generated output in the proper direction. # Possible values are: None, LTR, RTL and Context. # The default value is: None. OUTPUT_TEXT_DIRECTION = None # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = YES # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be # interpreted by doxygen. # The default value is: NO. JAVADOC_BANNER = YES # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = YES # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines (in the resulting output). You can put ^^ in the value part of an # alias to insert a newline as if a physical newline was in the original file. # When you need a literal { or } or , in the value part of an alias you have to # escape them by means of a backslash (\), this can lead to conflicts with the # commands \{ and \} for these it is advised to use the version @{ and @} or use # a double escape (\\{ and \\}) ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice # sources only. Doxygen will then generate output that is more tailored for that # language. For instance, namespaces will be presented as modules, types will be # separated into more groups, etc. # The default value is: NO. OPTIMIZE_OUTPUT_SLICE = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is # Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = "txt=md" # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = YES # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual # methods of a class will be included in the documentation. # The default value is: NO. EXTRACT_PRIV_VIRTUAL = YES # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = YES # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = YES # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = YES # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # (including Cygwin) ands Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = YES # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = YES # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = api_docx/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. If # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = src/ include/ \ temp-man-pages/ \ README.md TODO.md HACKING.md api_docx/ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, # *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ *.idl \ *.ddl \ *.odl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ *.cs \ *.d \ *.php \ *.php4 \ *.php5 \ *.phtml \ *.inc \ *.m \ *.markdown \ *.md \ *.mm \ *.dox \ *.doc \ *.txt \ *.f90 \ *.f95 \ *.f03 \ *.f08 \ *.f \ *.for \ *.tcl \ *.vhd \ *.vhdl \ *.ucf \ *.qsf \ *.ice # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = NO # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = # If clang assisted parsing is enabled you can provide the clang parser with the # path to the compilation database (see: # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files # were built. This is equivalent to specifying the "-p" option to a clang tool, # such as clang-check. These options will then be passed to the parser. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. CLANG_DATABASE_PATH = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = public # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = api_docx/custom.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 0 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 255 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = YES # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: https://developer.apple.com/xcode/), introduced with OSX # 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /