initial checkin

+.*.swp
+*.o
+*.a
+*.lo
+*.la
+*.gcda
+*.gcno
+.dirstamp
+.deps/
+.libs/
+Makefile
+configure
+Makefile.in
+m4/
+/config.*
+*.crt
+*.csr
+*.pem
+*.m4
+taskrambler.conf
+/INSTALL
+tests/coverage*
+/docs/api/
+/docs/Doxyfile
+/run
+/autom4te.cache/
+/compile
+/depcomp
+/install-sh
+/libtool
+/ltmain.sh
+/missing
+stamp-h1
+src/taskrambler
+/tests/*Test
+/tests/*.log
+/tests/*.trs
+gmon.out
+test-driver
+/assets/html/_documentation.html
+tags

+Georg Hopp <georg@steffers.org>

+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

+ACLOCAL_AMFLAGS = -I m4
+
+EXTRA_DIST = include
+
+SUBDIRS = src tests docs include
+
+.PHONY: docs coverage-html
+
+if HAVE_DOXYGEN
+docs:
+	-$(MAKE) -C docs $(AM_MAKEFLAGS) -k $@
+endif
+
+if HAVE_GCOV
+coverage-html:
+	-$(MAKE) -C tests $(AM_MAKEFLAGS) -k $@
+endif
+
+tags:
+	ctags -R -V --langdef=cclass --langmap=cclass:.h --regex-cclass='/^[ \t]*\(TR_CLASS\|TR_INTERFACE\)\(([a-zA-Z0-9_]+)/\2/d,definition/'

+README.md

+#!/bin/sh
+
+aclocal
+libtoolize --copy
+autoheader
+automake --gnu --add-missing --copy
+autoconf

+#                                               -*- Autoconf -*-
+# Process this file with autoconf to produce a configure script.
+
+AC_PREREQ([2.68])
+AC_INIT([libtrhash],
+        [0.0.0],
+        [Georg Hopp <georg@steffers.org>])
+LT_INIT
+AM_INIT_AUTOMAKE
+#AM_INIT_AUTOMAKE([subdir-objects])
+AM_SILENT_RULES([yes])
+AC_COPYRIGHT([Copyright © 2013 Georg Hopp])
+AC_REVISION([0.0.0])
+AC_CONFIG_SRCDIR([src/tree/tree.c])
+AC_CONFIG_HEADERS([trdata.h])
+AC_CONFIG_MACRO_DIR([m4])
+
+m4_include([m4/gcov.m4])
+AC_TDD_GCOV
+
+# Checks for programs.
+AC_PROG_CXX
+AC_PROG_CC
+AC_PROG_CC_C99
+AC_PROG_LIBTOOL
+AM_PROG_CC_C_O
+
+# Doxygen
+AC_CHECK_PROGS([DOXYGEN], [doxygen])
+if test -z "$DOXYGEN";
+   then AC_MSG_WARN([Doxygen not found - continuing without Doxygen support])
+fi
+
+AM_CONDITIONAL([HAVE_DOXYGEN],
+               [test -n "$DOXYGEN"])
+AM_COND_IF([HAVE_DOXYGEN],
+	   [AC_CONFIG_FILES([docs/Doxyfile])])
+
+# Checks for header files.
+AC_CHECK_HEADERS([stdarg.h string.h stdlib.h stdio.h unistd.h syslog.h sys/types.h])
+
+# Checks for typedefs, structures, and compiler characteristics.
+AC_HEADER_STDBOOL
+AC_C_INLINE
+AC_TYPE_PID_T
+AC_TYPE_SIZE_T
+
+# Checks for library functions.
+AC_CHECK_FUNCS([memset])
+
+AM_CFLAGS="${AM_CFLAGS} ${DRAGONEGG_FLAGS}"
+AM_CFLAGS="${AM_CFLAGS} ${MEM_OPT_FLAGS}"
+AM_CFLAGS="${AM_CFLAGS} ${CFLAGS}"
+AC_SUBST(AM_CFLAGS)
+
+AC_CONFIG_FILES([Makefile
+		 docs/Makefile
+		 tests/Makefile
+		 src/Makefile
+		 src/cbuf/Makefile
+		 src/hash/Makefile
+		 src/queue/Makefile
+		 src/tree/Makefile
+		 include/Makefile])
+AC_OUTPUT

+# Doxyfile 1.8.4
+
+# 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 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
+#---------------------------------------------------------------------------
+
+DOXYFILE_ENCODING     = UTF-8
+PROJECT_NAME          = @PACKAGE_NAME@
+PROJECT_NUMBER        = @PACKAGE_VERSION@
+PROJECT_BRIEF         = "Web server and task management solution."
+OUTPUT_DIRECTORY      = @top_srcdir@/docs/api/@PACKAGE_VERSION@
+CREATE_SUBDIRS        = NO
+OUTPUT_LANGUAGE       = English
+BRIEF_MEMBER_DESC     = YES
+REPEAT_BRIEF          = YES
+FULL_PATH_NAMES       = NO
+SHORT_NAMES           = NO
+JAVADOC_AUTOBRIEF     = NO
+QT_AUTOBRIEF          = NO
+INHERIT_DOCS          = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE              = 4
+
+# This tag can be used to specify a number of aliases that acts
+# 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.
+ALIASES               =
+
+# 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.
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# 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++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
+# C++. 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
+# that for custom extensions you also need to set FILE_PATTERNS otherwise the
+# files are not read by doxygen.
+EXTENSION_MAPPING     =
+
+# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
+# comments according to the Markdown format, which allows for more readable
+# documentation. See http://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.
+MARKDOWN_SUPPORT      = YES
+
+# 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 by putting a % sign in front of the word
+# or globally by setting AUTOLINK_SUPPORT to NO.
+AUTOLINK_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.
+DISTRIBUTE_GROUP_DOC  = NO
+
+# Set the SUBGROUPING tag to YES (the default) 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.
+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).
+INLINE_GROUPED_CLASSES = YES
+
+# 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 (the default), structs, classes, and unions are shown on a separate
+# page (for HTML and Man pages) or section (for LaTeX and RTF).
+INLINE_SIMPLE_STRUCTS  = YES
+
+# When TYPEDEF_HIDES_STRUCT 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.
+TYPEDEF_HIDES_STRUCT   = YES
+
+#---------------------------------------------------------------------------
+# 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
+EXTRACT_ALL     = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+EXTRACT_PRIVATE = YES
+
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+EXTRACT_PACKAGE = YES
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+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.
+EXTRACT_LOCAL_CLASSES  = YES
+
+# This flag is only useful for Objective-C code. When 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 (the default) only methods in the interface are included.
+EXTRACT_LOCAL_METHODS  = YES
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) 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.
+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 (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+HIDE_UNDOC_CLASSES     = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+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 (the default) these blocks will be appended to the
+# function's detailed documentation block.
+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 (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+INTERNAL_DOCS          = YES
+
+# 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
+# and Mac users are advised to set this option to NO.
+CASE_SENSE_NAMES       = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+HIDE_SCOPE_NAMES       = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+SHOW_INCLUDE_FILES     = YES
+
+# 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.
+FORCE_LOCAL_INCLUDES   = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+INLINE_INFO            = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) 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.
+SORT_MEMBER_DOCS       = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+SORT_BRIEF_DOCS        = NO
+
+# 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 default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to 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 default)
+# the group names will appear in their defined order.
+SORT_GROUP_NAMES       = NO
+
+# 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 default), 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.
+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.
+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.
+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.
+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.
+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.
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if section-label ... \endif
+# and \cond section-label ... \endcond blocks.
+ENABLED_SECTIONS       =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or macro consists of 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 initializer of individual variables and macros in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+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.
+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 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 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. See the manual for examples.
+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.
+LAYOUT_FILE            =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files
+# containing the references data. This must be a list of .bib files. The
+# .bib extension is automatically appended if omitted. Using this command
+# requires the bibtex tool to be installed. See also
+# http://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. Do not use
+# file names with spaces, bibtex cannot handle them.
+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
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+QUIET                  = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+WARNINGS               = YES
+
+# If WARN_IF_UNDOCUMENTED 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.
+WARN_IF_UNDOCUMENTED   = NO
+
+# If WARN_IF_DOC_ERROR 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.
+WARN_IF_DOC_ERROR      = YES
+
+# The 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 (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+WARN_NO_PARAMDOC       = 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)
+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 stderr.
+WARN_LOGFILE           =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be 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.
+INPUT = @top_srcdir@/include/ @top_srcdir@/src/ @top_srcdir@/assets/js
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+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 pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
+# *.f90 *.f *.for *.vhd *.vhdl
+FILE_PATTERNS          =
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+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.
+EXCLUDE_SYMLINKS       = YES
+
+# 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
+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.
+# Possible values are YES and NO. If left blank NO is used.
+EXAMPLE_RECURSIVE      = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are 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 <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> 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.
+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
+# info on how filters are used. If FILTER_PATTERNS is empty or if
+# non of the patterns match the file name, INPUT_FILTER is applied.
+FILTER_PATTERNS        =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+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 option only has effect when
+# FILTER_SOURCE_FILES is enabled.
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MD_FILE_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 reuse the introduction page also for the doxygen output.
+USE_MDFILE_AS_MAINPAGE =
+
+#---------------------------------------------------------------------------
+# 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 also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER         = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES         = YES
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C, C++ and Fortran comments will always remain visible.
+
+STRIP_CODE_COMMENTS    = NO
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# 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.
+
+REFERENCES_RELATION    = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# 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.
+
+REFERENCES_LINK_SOURCE = 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 http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS              = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) 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.
+
+VERBATIM_HEADERS       = YES
+
+#---------------------------------------------------------------------------
+# 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.
+
+ALPHABETICAL_INDEX     = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+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 one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX          =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+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. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT            = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION    = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header. Note that when using a custom header you are responsible
+#  for the proper inclusion of any scripts and style sheets that doxygen
+# needs, which is dependent on the configuration options used.
+# It is advised to generate a default header using "doxygen -w html
+# header.html footer.html stylesheet.css YourConfigFile" and then modify
+# that header. Note that the header is subject to change so you typically
+# have to redo this when upgrading to a newer version of doxygen or when
+# changing the value of configuration settings such as GENERATE_TREEVIEW!
+
+HTML_HEADER            =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+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. Note that it is recommended to use
+# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
+# tag will in the future become obsolete.
+
+HTML_STYLESHEET        =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
+# user-defined cascading style sheet that is 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 therefor more
+# robust against future updates. Doxygen will copy the style sheet file to
+# the output directory.
+
+HTML_EXTRA_STYLESHEET  =
+
+# 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.
+
+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 http://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.
+# The allowed range is 0 to 359.
+
+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.
+
+HTML_COLORSTYLE_SAT    = 100
+
+# 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.
+
+HTML_COLORSTYLE_GAMMA  = 80
+
+# 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 NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP         = 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.
+
+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.
+
+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, 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 http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+
+GENERATE_DOCSET        = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# 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.
+
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, 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.
+
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+
+# When GENERATE_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.
+
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME  = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP      = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+CHM_FILE               =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+HHC_LOCATION           =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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).
+
+GENERATE_CHI           = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING     =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+BINARY_TOC             = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+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.
+
+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.
+
+QCH_FILE               =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+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
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER     = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
+# add. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME   =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS  =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS  =
+
+# If the GENERATE_QHP tag is set to YES, 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.
+
+QHG_LOCATION           =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+#  will be generated, which together with the HTML files, 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.
+
+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.
+
+ECLIPSE_DOC_ID         = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
+# at top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it. Since the tabs have the same information as the
+# navigation tree you can set this option to NO if you already set
+# GENERATE_TREEVIEW 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.
+# Since the tree basically has the same information as the tab index you
+# could consider to set DISABLE_INDEX to NO when enabling this option.
+
+GENERATE_TREEVIEW      = YES
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
+# (range [0,1..20]) 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.
+
+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.
+
+TREEVIEW_WIDTH         = 250
+
+# When 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.
+
+EXT_LINKS_IN_WINDOW    = NO
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# 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.
+
+FORMULA_FONTSIZE       = 10
+
+# Use the FORMULA_TRANPARENT 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 before the changes have effect.
+
+FORMULA_TRANSPARENT    = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
+# (see http://www.mathjax.org) which uses client side Javascript for the
+# rendering instead of using prerendered 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.
+
+USE_MATHJAX            = NO
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
+# SVG. The default value is HTML-CSS, which is slower, but has the best
+# compatibility.
+
+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 http://www.mathjax.org before deployment.
+
+MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
+# names that should be enabled during MathJax rendering.
+
+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.
+
+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.
+
+SEARCHENGINE           = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript.
+# There are two flavours of web server based search depending on the
+# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
+# searching and an index file used by the script. When EXTERNAL_SEARCH is
+# enabled the indexing and searching needs to be provided by external tools.
+# See the manual for details.
+
+SERVER_BASED_SEARCH    = NO
+
+# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain
+# the search results. Doxygen ships with an example indexer (doxyindexer) and
+# search engine (doxysearch.cgi) which are based on the open source search
+# engine library Xapian. See the manual for configuration details.
+
+EXTERNAL_SEARCH        = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will returned the search results when EXTERNAL_SEARCH is enabled.
+# Doxygen ships with an example search engine (doxysearch) which is based on
+# the open source search engine library Xapian. See the manual for configuration
+# details.
+
+SEARCHENGINE_URL       =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+
+SEARCHDATA_FILE        = searchdata.xml
+
+# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+
+EXTERNAL_SEARCH_ID     =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
+# of to a relative location where the documentation can be found.
+# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
+
+EXTRA_SEARCH_MAPPINGS  =
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX         = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT           = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME         = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME     = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX          = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, letter, legal and
+# executive. If left blank a4 will be used.
+
+PAPER_TYPE             = a4
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES         =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER           =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
+# the generated latex document. The footer should contain everything after
+# the last chapter. If it is left blank doxygen will generate a
+# standard footer. Notice: only use this tag if you know what you are doing!
+
+LATEX_FOOTER           =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images
+# or other source files which should be copied to the LaTeX output directory.
+# Note that the files will be copied as-is; there are no commands or markers
+# available.
+
+LATEX_EXTRA_FILES      =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS         = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX           = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE        = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES     = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
+# source code with syntax highlighting in the LaTeX output.
+# Note that which sources are shown also depends on other settings
+# such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE      = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
+# http://en.wikipedia.org/wiki/BibTeX for more info.
+
+LATEX_BIB_STYLE        = plain
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF           = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT             = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF            = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS         = NO
+
+# Load style sheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE    =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE    =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN           = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT             = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION          = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS              = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML           = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT             = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA             =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD                =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING     = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files
+# that can be used to generate PDF.
+
+GENERATE_DOCBOOK       = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it. If left blank docbook will be used as the default path.
+
+DOCBOOK_OUTPUT         = docbook
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF   = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD       = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX          = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader.
+# This is useful
+# if you want to understand what is going on.
+# On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY         = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING   = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION        = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF     = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# pointed to by INCLUDE_PATH will be searched when a #include is found.
+
+SEARCH_INCLUDES        = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH           =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS  =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED             =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition that
+# overrules the definition found in the source code.
+
+EXPAND_AS_DEFINED      =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all references to function-like macros
+# that are alone on a line, have an all uppercase name, and do not end with a
+# semicolon, because these will confuse the parser if not removed.
+SKIP_FUNCTION_MACROS   = NO
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles. For each
+# tag file the location of the external documentation should be added. The
+# format of a tag file without this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths
+# or URLs. Note that each tag file must have a unique name (where the name does
+# NOT include the path). If a tag file is not located in the directory in which
+# doxygen is run, you must also specify the path to the tagfile here.
+
+TAGFILES               =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE       =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS           = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS        = YES
+
+# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed
+# in the related pages index. If set to NO, only the current project's
+# pages will be listed.
+
+EXTERNAL_PAGES         = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH              = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option also works with HAVE_DOT disabled, but it is recommended to
+# install and use dot, since it yields more powerful graphs.
+
+CLASS_DIAGRAMS         = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH            =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+HIDE_UNDOC_RELATIONS   = NO
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT               = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS        = 0
+
+# By default doxygen will use the Helvetica font for all dot files that
+# doxygen generates. When you want a differently looking font you can specify
+# the font name using DOT_FONTNAME. You need to make sure dot is able to find
+# the font, which can be done by putting it in a standard location or by setting
+# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
+# directory containing the font.
+
+DOT_FONTNAME           = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE           = 10
+
+# By default doxygen will tell dot to use the Helvetica font.
+# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
+# set the path where dot can find it.
+
+DOT_FONTPATH           =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH            = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH    = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS           = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+UML_LOOK               = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside
+# the class node. If there are many fields or methods and many nodes the
+# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
+# threshold limits the number of items for each type to make the size more
+# manageable. Set this to 0 for no limit. Note that the threshold may be
+# exceeded by 50% before the limit is enforced.
+UML_LIMIT_NUM_FIELDS   = 10
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+TEMPLATE_RELATIONS     = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+INCLUDE_GRAPH          = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+INCLUDED_BY_GRAPH      = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+CALL_GRAPH             = YES
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH           = YES
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will generate a graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY    = YES
+
+# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH        = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are svg, png, jpg, or gif.
+# If left blank png will be used. If you choose svg you need to set
+# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
+# visible in IE 9+ (other browsers do not have this requirement).
+
+DOT_IMAGE_FORMAT       = svg
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+# Note that this requires a modern browser other than Internet Explorer.
+# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
+# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
+# visible. Older versions of IE do not have SVG support.
+
+INTERACTIVE_SVG        = YES
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH               =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS           =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the
+# \mscfile command).
+
+MSCFILE_DIRS           =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES    = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH    = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT        = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS      = YES
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND        = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP            = YES

+EXTRA_DIST = Doxyfile.in
+
+if HAVE_DOXYGEN
+
+.PHONY: docs
+
+docs:
+	@mkdir -p $(top_srcdir)/docs/api/$(PACKAGE_VERSION)
+	$(DOXYGEN) Doxyfile
+
+clean-local:
+	@rm -rf $(top_srcdir)/docs/api/
+endif 

+nobase_include_HEADERS = trdata.h \
+			 tr/cbuf.h \
+			 tr/hash.h \
+			 tr/hash_value.h \
+			 tr/queue.h \
+			 tr/tree.h \
+			 tr/interface/hashable.h

+/**
+ * \file
+ * My implementation of a ringbuffer.
+ * It maps a shared memory object twice directly following
+ * thus make it possible to read and write from any
+ * position within the buffer without the nasty wrap
+ * calculations.
+ * This is achived because the same memory region is mapped
+ * at the two addresses.
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __TR_CBUF_H__
+#define __TR_CBUF_H__
+
+#include <ctype.h>
+#include <string.h>
+#include <sys/types.h>
+
+#include "trbase.h"
+#include "trio.h"
+
+#define TR_ECBUFOVFL		100
+
+
+TR_CLASS(TR_Cbuf) {
+	char * shm_name;  // shared memory identifier
+
+	char * data;
+	Bool   lock;
+
+	size_t bsize;
+	size_t bused;
+
+	size_t write;
+	size_t read;
+};
+
+ssize_t TR_cbufRead(TR_Cbuf,  TR_Stream);
+ssize_t TR_cbufWrite(TR_Cbuf, TR_Stream);
+
+char *  TR_cbufGetLine(TR_Cbuf, char **);
+char *  TR_cbufGetData(TR_Cbuf, size_t);
+char *  TR_cbufSetData(TR_Cbuf, const void *, size_t);
+void    TR_cbufEmpty(TR_Cbuf);
+
+char *  TR_cbufGetRead(TR_Cbuf this);
+char *  TR_cbufGetWrite(TR_Cbuf this);
+char *  TR_cbufMemchr(TR_Cbuf this, int c);
+size_t  TR_cbufAddrIndex(TR_Cbuf this, const void * c);
+void    TR_cbufIncRead(TR_Cbuf this, size_t n);
+void    TR_cbufIncWrite(TR_Cbuf this, size_t n);
+size_t  TR_cbufGetFree(TR_Cbuf this);
+char    TR_cbufIsEmpty(TR_Cbuf this);
+void    TR_cbufSkipNonAlpha(TR_Cbuf this);
+Bool    TR_cbufIsLocked(TR_Cbuf this);
+void    TR_cbufLock(TR_Cbuf this);
+void    TR_cbufRelease(TR_Cbuf this);
+
+#endif // __TR_CBUF_H__
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __TR_HASH_H__
+#define __TR_HASH_H__
+
+#include <sys/types.h>
+
+#include "trbase.h"
+#include "tr/tree.h"
+
+#define TR_HASH_IS_EMPTY(h)	((h)->root)
+
+TR_CLASS(TR_Hash) {
+	TR_Tree root;
+};
+
+void * TR_hashAdd(TR_Hash, void *);
+void * TR_hashDelete(TR_Hash, const char *, size_t);
+void * TR_hashGet(TR_Hash, const char *, size_t);
+void * TR_hashGetFirst(TR_Hash);
+void * TR_hashDeleteByVal(TR_Hash, unsigned long);
+void * TR_hashGetByVal(TR_Hash, unsigned long);
+void   TR_hashEach(TR_Hash, void (*)(const void*));
+void   TR_hashCleanup(TR_Hash);
+
+#endif // __TR_HASH_H__
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __TR_HASH_VALUE_H__
+#define __TR_HASH_VALUE_H__
+
+#include <sys/types.h>
+
+#include "trbase.h"
+
+TR_CLASS(TR_HashValue) {
+	unsigned long hash;
+
+	char *        key;
+	void *        value;
+
+	size_t        nkey;
+	size_t        nvalue;
+};
+
+#endif // __TR_HASH_VALUE_H__
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ * The logger interface.
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __TR_INTERFACE_HASHABLE_H__
+#define __TR_INTERFACE_HASHABLE_H__
+
+#include "trbase.h"
+
+typedef unsigned long (* fptr_TR_hashableGetHash)(void *);
+typedef void          (* fptr_TR_hashableHandleDouble)(void *, void *);
+
+TR_INTERFACE(TR_Hashable) {
+	TR_IFID;
+	fptr_TR_hashableGetHash      getHash;
+	fptr_TR_hashableHandleDouble handleDouble;
+};
+
+extern unsigned long TR_hashableGetHash(void *);
+extern void          TR_hashableHandleDouble(void *, void *);
+
+#endif // __TR_INTERFACE_HASHABLE_H__
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ * Holds requests ready for processing.
+ * 
+ * \todo change this to a real queue.
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __TR_QUEUE_H__
+#define __TR_QUEUE_H__
+
+#include <sys/types.h>
+
+#include "trbase.h"
+
+
+TR_CLASS(TR_Queue) {
+	void *    msg;
+	TR_Queue  next;
+
+	/**
+	 * first and last are only available in the initial queue
+	 * element (the root). This elelment does not contain any message
+	 * and exists only for organizational purpose.
+	 *
+	 * \todo next and first always have to be the same...so get rid
+	 * of first.
+	 */
+	TR_Queue  first;
+	TR_Queue  last;
+	size_t nmsg;
+};
+
+void   TR_queuePut(TR_Queue, void *);
+void * TR_queueGet(TR_Queue);
+
+#define TR_queueEmpty(this)		(0 >= (this)->nmsg)
+
+#endif // __TR_QUEUE_H__
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __TR_TREE_H__
+#define __TR_TREE_H__
+
+#include "trbase.h"
+
+#define TR_TREE_RIGHT(node)	(NULL!=(node)?(node)->right:NULL)
+#define TR_TREE_LEFT(node)		(NULL!=(node)?(node)->left:NULL)
+#define TR_TREE_PARENT(node)	(NULL!=(node)?(node)->parent:NULL)
+
+#define TR_TREE_CHILD(node) \
+	(NULL==TR_TREE_RIGHT((node))?TR_TREE_LEFT((node)):TR_TREE_RIGHT((node)))
+
+#define TR_TREE_RIGHT_LEFT(node) \
+	(NULL!=TR_TREE_RIGHT((node))?TR_TREE_LEFT(TR_TREE_RIGHT((node))):NULL)
+
+#define TR_TREE_LEFT_RIGHT(node) \
+	(NULL!=TR_TREE_LEFT((node))?TR_TREE_RIGHT(TR_TREE_LEFT((node))):NULL)
+
+#define TR_TREE_SIBLING(node)               \
+	(NULL!=TR_TREE_PARENT((node))?          \
+	 ((node)==TR_TREE_PARENT((node))->left? \
+	  TR_TREE_PARENT((node))->right:        \
+	  TR_TREE_PARENT((node))->left):        \
+	 NULL)
+
+#define TR_TREE_GRANDPARENT(node) \
+	(NULL!=TR_TREE_PARENT((node))?TR_TREE_PARENT((node))->parent:NULL)
+
+#define TR_TREE_UNCLE(node)                                   \
+	(NULL!=TR_TREE_GRANDPARENT((node))?                       \
+	 (TR_TREE_PARENT((node))==TR_TREE_GRANDPARENT((node))->left? \
+	  TR_TREE_GRANDPARENT((node))->right:                     \
+	  TR_TREE_GRANDPARENT((node))->left):                     \
+	 NULL)
+
+#define TR_TREE_ROTATE_LEFT(root, node)                        \
+	do {                                                    \
+		if (NULL != TR_TREE_RIGHT_LEFT((node))) {              \
+			TR_TREE_RIGHT_LEFT((node))->parent = (node);       \
+		}                                                   \
+		TR_TREE_RIGHT((node))->left = (node);                  \
+		if (NULL != TR_TREE_PARENT((node))) {                  \
+			if (TR_TREE_PARENT((node))->left==(node)) {        \
+				TR_TREE_PARENT((node))->left = (node)->right;  \
+			} else {                                        \
+				TR_TREE_PARENT((node))->right = (node)->right; \
+			}                                               \
+		} else {                                            \
+			*(root) = (node)->right;                        \
+		}                                                   \
+		(node)->right  = TR_TREE_RIGHT_LEFT((node));           \
+		(node)->parent = (node)->right;                     \
+		TR_TREE_RIGHT((node))->parent = (node)->parent;        \
+	} while(0)
+
+#define TR_TREE_ROTATE_RIGHT(root, node)                       \
+	do {                                                    \
+		if (NULL != TR_TREE_LEFT_RIGHT((node))) {              \
+			TR_TREE_LEFT_RIGHT((node))->parent = (node);       \
+		}                                                   \
+		TR_TREE_LEFT((node))->right = (node);                  \
+		if (NULL != TR_TREE_PARENT((node))) {                  \
+			if (TR_TREE_PARENT((node))->left==(node)) {        \
+				TR_TREE_PARENT((node))->left = (node)->left;   \
+			} else {                                        \
+				TR_TREE_PARENT((node))->right = (node)->left;  \
+			}                                               \
+		} else {                                            \
+			*(root) = (node)->left;                         \
+		}                                                   \
+		TR_TREE_LEFT((node))->parent = (node)->parent;         \
+		(node)->left   = TR_TREE_LEFT_RIGHT((node));           \
+		(node)->parent = (node)->right;                     \
+	} while(0)
+
+#define TR_TREE_REPLACE_NODE(root, node1, node2)            \
+	do {                                                 \
+		if (NULL != TR_TREE_PARENT((node1))) {              \
+			if ((node1) == TR_TREE_PARENT((node1))->left) { \
+				TR_TREE_PARENT((node1))->left = (node2);    \
+			} else {                                     \
+				TR_TREE_PARENT((node1))->right = (node2);   \
+			}                                            \
+		} else {                                         \
+			*(root) = (node2);                           \
+		}                                                \
+		if (NULL != (node2)) {                           \
+			(node2)->parent = (node1)->parent;           \
+		}                                                \
+	} while(0)
+
+
+typedef enum {rbBlack=1, rbRed=2} TR_rbColor;
+
+TR_CLASS(TR_Tree) {
+	void * data;
+
+	TR_rbColor color;
+
+	TR_Tree parent;
+	TR_Tree left;
+	TR_Tree right;
+};
+
+typedef int  (*TR_TreeComp)(const void *, const void *);
+typedef void (*TR_TreeAction)(const void *, const int);
+
+void * TR_treeFind(TR_Tree, const void *, TR_TreeComp);
+void * TR_treeInsert(TR_Tree *, const void *, TR_TreeComp);
+void * TR_treeDelete(TR_Tree *, const void *, TR_TreeComp);
+void   TR_treeWalk(TR_Tree, TR_TreeAction);
+void   TR_treeDestroy(TR_Tree *, TR_TreeAction);
+
+#endif // __TR_TREE_H__
+
+// vim: set ts=4 sw=4:

+#ifndef __TR_DATA_H__
+#define __TR_DATA_H__
+
+#include "tr/cbuf.h"
+#include "tr/hash.h"
+#include "tr/hash_value.h"
+#include "tr/queue.h"
+#include "tr/tree.h"
+#include "tr/interface/hashable.h"
+
+#endif // __TR_DATA_H__
+
+// vim: set ts=4 sw=4:

+.*.swp
+*.o
+*.a
+*.lo
+*.la
+*.gcda
+*.gcno
+.dirstamp
+.deps/
+.libs/
+Makefile
+configure
+Makefile.in
+m4/
+/config.*
+*.crt
+*.csr
+*.pem
+*.m4
+taskrambler.conf
+/INSTALL
+tests/coverage*
+/docs/api/
+/docs/Doxyfile
+/run
+/autom4te.cache/
+/compile
+/depcomp
+/install-sh
+/libtool
+/ltmain.sh
+/missing
+stamp-h1
+src/taskrambler
+/tests/*Test
+/tests/*.log
+/tests/*.trs
+gmon.out
+test-driver
+/assets/html/_documentation.html
+tags

+ACLOCAL_AMFLAGS = -I m4
+AUTOMAKE_OPTIONS = subdir-objects
+
+AM_CFLAGS += -I../include/
+
+TRDATALIBS = cbuf/libcbuf.la \
+	     hash/libhash.la \
+	     queue/libqueue.la \
+	     tree/libtree.la
+
+lib_LTLIBRARIES = libtrdata.la
+
+libtrdata_la_SOURCES =
+libtrdata_la_CFLAGS  = $(AM_CFLAGS)
+libtrdata_la_LIBADD  = $(TRDATALIBS)
+
+SUBDIRS = cbuf hash queue tree

+ACLOCAL_AMFLAGS = -I m4
+AUTOMAKE_OPTIONS = subdir-objects
+
+AM_CFLAGS += -I../../include/
+
+CB = cbuf.c read.c \
+     get_line.c set_data.c get_data.c \
+     addr_index.c get_free.c get_read.c get_write.c \
+     inc_read.c inc_write.c is_empty.c memchr.c \
+     skip_non_alpha.c is_locked.c lock.c release.c \
+     empty.c
+
+noinst_LTLIBRARIES = libcbuf.la
+
+libcbuf_la_SOURCES = $(CB)
+libcbuf_la_CFLAGS  = $(AM_CFLAGS)

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+
+#include "tr/cbuf.h"
+
+size_t
+TR_cbufAddrIndex(TR_Cbuf this, const void * c)
+{
+	return c - (const void *)TR_cbufGetRead(this);
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#define _POSIX_SOURCE
+#define _POSIX_C_SOURCE 200112L
+#define _GNU_SOURCE
+
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <sys/mman.h>
+#include <stdarg.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <fcntl.h>
+
+#include "trbase.h"
+#include "tr/cbuf.h"
+
+
+static void cbufDtor(void*);
+
+static
+int
+cbufCtor(void * _this, va_list * params)
+{
+	TR_Cbuf   this     = _this;
+	char      state    = -1;
+	char *    shm_name = va_arg(*params, char*);
+	long      psize    = sysconf(_SC_PAGESIZE);
+	size_t    size;
+	int       shm;
+	char    * data;
+
+	this->shm_name = TR_malloc(strlen(shm_name) + 7 + 2);
+	sprintf(this->shm_name, "/%06d_%s", getpid(), shm_name);
+
+	/**
+	 * align size at page boundary.
+	 * increase as neccessary
+	 */
+	size = va_arg(*params, size_t);
+	size = (0 >= size)? 1 : (0 != size%psize)? (size/psize)+1 : size/psize;
+	this->bsize = psize * size;
+
+	while (-1 == state) {
+		shm = shm_open(this->shm_name, O_RDWR|O_CREAT|O_EXCL, S_IRWXU);
+		if (-1 == shm) {
+			break;
+		}
+
+		if (-1 == ftruncate(shm, this->bsize)) {
+			break;
+		}
+
+		this->data = mmap (0, this->bsize << 1,
+				PROT_NONE, MAP_ANONYMOUS|MAP_PRIVATE, -1, 0);
+		if (this->data == MAP_FAILED) {
+			this->data = NULL;
+			break;
+		}   
+
+		data = mmap (this->data, this->bsize,
+				PROT_READ|PROT_WRITE, MAP_FIXED|MAP_SHARED, shm, 0);
+		if (data != this->data) {
+			break;
+		}   
+
+		data = mmap (this->data + this->bsize, this->bsize,
+				PROT_READ|PROT_WRITE, MAP_FIXED|MAP_SHARED, shm, 0);
+		if (data != this->data + this->bsize) {
+			break;
+		}   
+
+		state = 0;
+	}
+
+	if (-1 != shm) {
+		shm_unlink(this->shm_name);
+		close(shm);
+	}
+
+	return state;
+}
+
+static
+void
+cbufDtor(void * _this)
+{
+	TR_Cbuf this = _this;
+
+	TR_MEM_FREE(this->shm_name);
+
+	if (NULL != this->data && MAP_FAILED != this->data) {
+		munmap(this->data, this->bsize << 1);
+	}
+
+	this->data = NULL;
+}
+
+TR_INIT_IFACE(TR_Class, cbufCtor, cbufDtor, NULL);
+TR_CREATE_CLASS(TR_Cbuf, NULL, TR_IF(TR_Class));
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/cbuf.h"
+
+void
+TR_cbufEmpty(TR_Cbuf this)
+{
+	this->bused = 0;
+	this->read  = this->write;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+#include <string.h>
+
+#include "tr/cbuf.h"
+
+char *
+TR_cbufGetData(TR_Cbuf this, size_t n)
+{
+	char * ret = TR_cbufGetRead(this);
+
+	if (n > this->bused) {
+		return (char *)-1;
+	}
+
+	TR_cbufIncRead(this, n);
+	return ret;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+
+#include "tr/cbuf.h"
+
+size_t
+TR_cbufGetFree(TR_Cbuf this)
+{
+	return this->bsize - this->bused;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+
+#include <string.h>
+
+#include "tr/cbuf.h"
+
+char *
+TR_cbufGetLine(TR_Cbuf this, char ** line_end)
+{
+	char * nl  = TR_cbufMemchr(this, '\n');
+	char * ret = NULL;
+
+	if (NULL != nl) {
+		size_t len = TR_cbufAddrIndex(this, nl) + 1;
+
+		*line_end = nl - 1;
+		*nl       = 0;
+		*(nl-1)   = ('\r' == *(nl-1))? 0 : *(nl-1);
+
+		ret = TR_cbufGetRead(this);
+		TR_cbufIncRead(this, len);
+	}
+
+	return ret;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/cbuf.h"
+
+char *
+TR_cbufGetRead(TR_Cbuf this)
+{
+	return this->data + this->read;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/cbuf.h"
+
+char *
+TR_cbufGetWrite(TR_Cbuf this)
+{
+	return this->data + this->write;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+
+#include "tr/cbuf.h"
+
+void
+TR_cbufIncRead(TR_Cbuf this, size_t n)
+{
+	this->read  += n;
+	this->read   = (this->read >= this->bsize)?
+		this->read - this->bsize : this->read;
+	this->bused -= n;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+
+#include "tr/cbuf.h"
+
+void
+TR_cbufIncWrite(TR_Cbuf this, size_t n)
+{
+	this->write += n;
+	this->write  = (this->write >= this->bsize)?
+		this->write - this->bsize : this->write;
+	this->bused += n;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/cbuf.h"
+
+char
+TR_cbufIsEmpty(TR_Cbuf this)
+{
+	return (0 == this->bused);
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/cbuf.h"
+
+Bool
+TR_cbufIsLocked(TR_Cbuf this)
+{
+	return this->lock;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/cbuf.h"
+
+void
+TR_cbufLock(TR_Cbuf this)
+{
+	this->lock = TRUE;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <string.h>
+
+#include "tr/cbuf.h"
+
+char *
+TR_cbufMemchr(TR_Cbuf this, int c)
+{
+	return memchr(TR_cbufGetRead(this), c, this->bused);
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+#include <unistd.h>
+#include <errno.h>
+
+#include "trio.h"
+#include "tr/cbuf.h"
+
+
+ssize_t
+TR_cbufRead(TR_Cbuf this, TR_Stream st)
+{
+	size_t  rsize = TR_cbufGetFree(this);
+	ssize_t rrsize;
+
+	if (0 == rsize) {
+		errno = TR_ECBUFOVFL;
+		return -1;
+	}
+
+	rrsize = TR_streamRead(st, TR_cbufGetWrite(this), rsize);
+
+	if (0 < rrsize) {
+		TR_cbufIncWrite(this, rrsize);
+	}
+
+	return rrsize;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/cbuf.h"
+
+void
+TR_cbufRelease(TR_Cbuf this)
+{
+	this->lock = FALSE;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+#include <string.h>
+#include <errno.h>
+
+#include "tr/cbuf.h"
+
+char *
+TR_cbufSetData(TR_Cbuf this, const void * src, size_t n)
+{
+	char * addr;
+
+	if (n > TR_cbufGetFree(this)) {
+		errno = TR_ECBUFOVFL;
+		return (char *)-1;
+	}
+
+	addr = memcpy(TR_cbufGetWrite(this), src, n);
+	TR_cbufIncWrite(this, n);
+
+	return addr;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <ctype.h>
+
+#include "tr/cbuf.h"
+
+void
+TR_cbufSkipNonAlpha(TR_Cbuf this)
+{
+	while(0 < this->bused && !isalpha(*TR_cbufGetRead(this)))
+		TR_cbufIncRead(this, 1);
+}
+
+// vim: set ts=4 sw=4:

+ACLOCAL_AMFLAGS = -I m4
+AUTOMAKE_OPTIONS = subdir-objects
+
+AM_CFLAGS += -I../../include/
+
+HASH = hash.c add.c get.c get_first.c delete.c each.c value.c \
+       cleanup.c interface/hashable.c
+
+noinst_LTLIBRARIES = libhash.la
+
+libhash_la_SOURCES = $(HASH)
+libhash_la_CFLAGS  = $(AM_CFLAGS)

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <search.h>
+
+#include "tr/hash.h"
+#include "tr/interface/hashable.h"
+#include "tr/tree.h"
+
+static
+inline
+int
+hashAddComp(const void * a, const void * b)
+{
+	unsigned long hash_a = TR_hashableGetHash((void*)a);
+	unsigned long hash_b = TR_hashableGetHash((void*)b);
+
+	if (hash_a < hash_b) {
+		return -1;
+	}
+	
+	if (hash_a > hash_b) {
+		return 1;
+	}
+
+	return 0;
+}
+
+void *
+TR_hashAdd(TR_Hash this, void * operand)
+{
+	void * found = TR_treeInsert(&this->root, operand, hashAddComp);
+
+	if (NULL == found) {
+		return NULL;
+	}
+
+	if (operand != found) {
+		TR_hashableHandleDouble(found, operand);
+		TR_delete(operand);
+	}
+
+	return found;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "trbase.h"
+#include "tr/hash.h"
+#include "tr/tree.h"
+
+static
+inline
+void
+tDelete(const void * node, const int depth)
+{
+	TR_delete(node);
+}
+
+void
+TR_hashCleanup(TR_Hash this)
+{
+	TR_treeDestroy(&(this->root), tDelete);
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+
+#include "trhash.h"
+#include "tr/interface/hashable.h"
+#include "tr/hash.h"
+#include "tr/tree.h"
+
+static
+inline
+int
+hashDeleteComp(const void * a, const void * b)
+{
+	unsigned long hash_a = TR_hashableGetHash((void*)a);
+
+	if (hash_a < *(const unsigned long*)b) {
+		return -1;
+	}
+	
+	if (hash_a > *(const unsigned long*)b) {
+		return 1;
+	}
+
+	return 0;
+}
+
+void *
+TR_hashDelete(TR_Hash this, const char * search, size_t nsearch)
+{
+	unsigned long   hash  = TR_sdbm((const unsigned char *)search, nsearch);
+	void          * found = NULL;
+
+	found = TR_treeDelete(&(this->root), &hash, hashDeleteComp);
+
+	return found;
+}
+
+void *
+TR_hashDeleteByVal(TR_Hash this, unsigned long hash)
+{
+	void * found = TR_treeDelete(&(this->root), &hash, hashDeleteComp);
+
+	return found;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <search.h>
+
+#include "tr/hash.h"
+#include "tr/tree.h"
+
+static void (*cb)(const void*);
+
+static
+inline
+void
+walk(const void * node, const int depth)
+{
+	cb(node);
+}
+
+void
+TR_hashEach(TR_Hash this, void (*callback)(const void*))
+{
+	cb = callback;
+
+	TR_treeWalk(this->root, walk);
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <stdio.h>
+
+#include <search.h>
+#include <sys/types.h>
+
+#include "trhash.h"
+#include "tr/hash.h"
+#include "tr/interface/hashable.h"
+#include "tr/tree.h"
+
+static
+inline
+int
+hashGetComp(const void * a, const void * b)
+{
+	unsigned long hash_a = TR_hashableGetHash((void*)a);
+
+	if (hash_a < *(const unsigned long*)b) {
+		return -1;
+	}
+	
+	if (hash_a > *(const unsigned long*)b) {
+		return 1;
+	}
+
+	return 0;
+}
+
+void *
+TR_hashGet(TR_Hash this, const char * search, size_t nsearch)
+{
+	unsigned long   hash  = TR_sdbm((const unsigned char *)search, nsearch);
+	void          * found = TR_treeFind(this->root, &hash, hashGetComp);
+
+	return found;
+}
+
+void *
+TR_hashGetByVal(TR_Hash this, unsigned long hash)
+{
+	void * found = TR_treeFind(this->root, &hash, hashGetComp);
+
+	return found;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <sys/types.h>
+
+#include "tr/hash.h"
+
+void *
+TR_hashGetFirst(TR_Hash this)
+{
+	return this->root;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#define _GNU_SOURCE
+
+#include <stdarg.h>
+
+#include "trbase.h"
+#include "tr/hash.h"
+
+static
+int
+hashCtor(void * _this, va_list * params)
+{
+	return 0;
+}
+
+static
+inline
+void
+tDelete(const void * node, const int depth)
+{
+	TR_delete(node);
+}
+
+static
+void
+hashDtor(void * _this)
+{
+	TR_Hash this = _this;
+
+	TR_hashCleanup(this);
+}
+
+TR_INIT_IFACE(TR_Class, hashCtor, hashDtor, NULL);
+TR_CREATE_CLASS(TR_Hash, NULL, TR_IF(TR_Class));
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdarg.h>
+
+#include "trbase.h"
+#include "tr/interface/hashable.h"
+
+TR_CREATE_INTERFACE(TR_Hashable, 2);
+
+unsigned long
+TR_hashableGetHash(void * hashable)
+{
+	unsigned long ret;
+
+	TR_RETCALL(hashable, TR_Hashable, getHash, ret);
+
+	return ret;
+}
+
+void
+TR_hashableHandleDouble(void * hashable, void * new_hashable)
+{
+	TR_CALL(hashable, TR_Hashable, handleDouble, new_hashable);
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <stdarg.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/types.h>
+
+#include "trbase.h"
+#include "trhash.h"
+#include "tr/hash_value.h"
+#include "tr/interface/hashable.h"
+
+static
+int
+hashValueCtor(void * _this, va_list * params)
+{
+	TR_HashValue this = _this;
+	char * key        = va_arg(* params, char*);
+	void * value;
+	
+	this->nkey   = va_arg(* params, size_t);
+	value        = va_arg(* params, void*);
+	this->nvalue = va_arg(* params, size_t);
+
+	this->key = TR_malloc(this->nkey + 1);
+	this->key[this->nkey] = 0;
+	memcpy(this->key, key, this->nkey);
+
+	this->hash = TR_sdbm((unsigned char *)this->key, this->nkey);
+
+	if (NULL != value) {
+		this->value = TR_malloc(this->nvalue + 1);
+		((char*)this->value)[this->nvalue] = 0;
+		memcpy(this->value, value, this->nvalue);
+	}
+
+	return 0;
+}
+
+static
+void
+hashValueDtor(void * _this)
+{
+	TR_HashValue this = _this;
+
+	TR_MEM_FREE(this->key);
+	TR_MEM_FREE(this->value);
+}
+
+static
+unsigned long
+hashValueGetHash(void * _this)
+{
+	TR_HashValue this = _this;
+
+	return this->hash;
+}
+
+static
+void
+hashValueHandleDouble(void * _this, void * _double)
+{
+	TR_HashValue this = _this;
+	TR_HashValue doub = _double;
+	void * tmp_value;
+	size_t tmp_nvalue;
+
+	/**
+	 * here we swap the internal data of both objects,
+	 * effectively overwriting the old entry. We need not
+	 * to free anything here as _double will be deleted
+	 * afterwards anyway (\see hash/add.c).
+	 */
+	tmp_value   = this->value;
+	this->value = doub->value;
+	doub->value = tmp_value;
+
+	tmp_nvalue   = this->nvalue;
+	this->nvalue = doub->nvalue;
+	doub->nvalue = tmp_nvalue;
+}
+
+TR_INIT_IFACE(TR_Class, hashValueCtor, hashValueDtor, NULL);
+TR_INIT_IFACE(TR_Hashable, hashValueGetHash, hashValueHandleDouble);
+TR_CREATE_CLASS(TR_HashValue, NULL, TR_IF(TR_Class), TR_IF(TR_Hashable));
+
+// vim: set ts=4 sw=4:

+ACLOCAL_AMFLAGS = -I m4
+AUTOMAKE_OPTIONS = subdir-objects
+
+AM_CFLAGS += -I../../include/
+
+noinst_LTLIBRARIES = libqueue.la
+
+libqueue_la_SOURCES = queue.c get.c put.c
+libqueue_la_CFLAGS  = $(AM_CFLAGS)

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "trbase.h"
+#include "tr/queue.h"
+
+void *
+TR_queueGet(TR_Queue this)
+{
+	TR_Queue   first;
+	void     * msg;
+
+	if (NULL == this->first) {
+		return NULL;
+	}
+
+	msg   = this->first->msg;
+	first = this->first->next;
+
+	if (this->first == this->last) {
+		this->last = NULL;
+	}
+	TR_delete(this->first);
+
+	this->next  = first;
+	this->first = first;
+	this->nmsg--;
+
+	return msg;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "trbase.h"
+#include "tr/queue.h"
+
+void
+TR_queuePut(TR_Queue this, void * msg)
+{
+	TR_Queue node = (this->last)? this->last : this;
+
+	node->next = TR_new(TR_Queue);
+	this->last = node->next;
+
+	if (node == this) {
+		this->first = node->next;
+	}
+
+	node->next->msg = msg;
+	this->nmsg++;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <stdarg.h>
+
+#include "trbase.h"
+#include "tr/queue.h"
+
+static
+int
+queueCtor(void * _this, va_list * params)
+{
+	return 0;
+}
+
+static
+void
+queueDtor(void * _this)
+{
+	TR_Queue this = _this;
+	TR_Queue node = this->first;
+	
+	while (NULL != node) {
+		TR_Queue next = node->next;
+		TR_delete(node->msg);
+		TR_delete(node);
+		node = next;
+	}
+}
+
+TR_INIT_IFACE(TR_Class, queueCtor, queueDtor, NULL);
+TR_CREATE_CLASS(TR_Queue, NULL, TR_IF(TR_Class));
+
+// vim: set ts=4 sw=4:

+ACLOCAL_AMFLAGS = -I m4
+AUTOMAKE_OPTIONS = subdir-objects
+
+TREE = tree.c find.c insert.c inOrderSuccessor.c delete.c walk.c \
+       rotateLeft.c rotateRight.c destroy.c
+
+AM_CFLAGS += -I../../include/
+
+noinst_LTLIBRARIES = libtree.la
+
+libtree_la_SOURCES = $(TREE)
+libtree_la_CFLAGS  = $(AM_CFLAGS)

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "trbase.h"
+#include "tr/tree.h"
+
+TR_Tree TR_inOrderSuccessor(TR_Tree);
+void TR_treeRotateLeft(TR_Tree *, TR_Tree);
+void TR_treeRotateRight(TR_Tree *, TR_Tree);
+
+void *
+TR_treeDelete(TR_Tree * this, const void * search, TR_TreeComp comp)
+{
+	TR_Tree   node = *this;
+	TR_Tree   del_node;
+
+	void    * data;
+
+	/*
+	 * first search for it and if its found return the data
+	 * and we are done...
+	 */
+	while (NULL != node) {
+		int comparison = comp(node->data, search);
+
+		if (0 < comparison) {
+			node = TR_TREE_LEFT(node);
+			continue;
+		}
+
+		if (0 > comparison) {
+			node = TR_TREE_RIGHT(node);
+			continue;
+		}
+
+		if (0 == comparison) {
+			break;
+		}
+	}   
+
+	/*
+	 * nothing was found...return NULL to indicate this.
+	 */
+	if (NULL == node) {
+		return NULL;
+	}
+
+	/*
+	 * we found an element, store its data pointer as we are
+	 * up to delete it.
+	 */
+	data = node->data;
+
+	/*
+	 * now remove the element.
+	 */
+	
+	/*
+	 * if we have two children replace data with the one from 
+	 * out inOrderSuccessor and remove the inOrderSuccessor.
+	 */
+	if (NULL != TR_TREE_LEFT(node) && NULL != TR_TREE_RIGHT(node)) {
+		TR_Tree successor = TR_inOrderSuccessor(node);
+
+		node->data = successor->data;
+		node       = successor;
+	}
+
+	{
+		TR_Tree child = TR_TREE_CHILD(node);
+
+		/*
+		 * if we still have one child replace ourself with it.
+		 */
+		TR_TREE_REPLACE_NODE(this, node, child);
+
+		/*
+		 * and finally delete the node...and prepare ourselfs
+		 * for rebalancing.
+		 */
+		if (rbBlack == node->color) {
+			if (NULL != child && rbRed == child->color) {
+				child->color = rbBlack;
+				TR_delete(node);
+				return data;
+			} else {
+				del_node = node;
+				if (NULL != child) {
+					node = child;
+				} else {
+					node->color = rbBlack;
+					node->left  = NULL;
+					node->right = NULL;
+				}
+			}
+		} else {
+			TR_delete(node);
+			return data;
+		}
+	}
+
+	/*
+	 * now comes rebalancing...note that if we came to this point
+	 * the node is still not deleted.
+	 * This is because I am not sure if it is needed during the
+	 * rebalancing process...(this does not make much sense, but
+	 * to be honest I don't know now.)
+	 */
+	while(1) {
+		// case 1
+		if (NULL == TR_TREE_PARENT(node)) {
+			break;
+		}
+
+		// case 2
+		if (NULL != TR_TREE_SIBLING(node)
+				&& rbRed == TR_TREE_SIBLING(node)->color) {
+
+			TR_TREE_PARENT(node)->color  = rbRed;
+			TR_TREE_SIBLING(node)->color = rbBlack;
+
+			if (NULL != TR_TREE_PARENT(node)->right &&
+					node != TR_TREE_PARENT(node)->right) {
+
+				//TREE_ROTATE_LEFT(this, TREE_PARENT(node));
+				TR_treeRotateLeft(this, TR_TREE_PARENT(node));
+
+			} else {
+
+				//TREE_ROTATE_RIGHT(this, TREE_PARENT(node));
+				TR_treeRotateRight(this, TR_TREE_PARENT(node));
+
+			}
+		}
+
+		// case 3 / 4
+		if (NULL == TR_TREE_SIBLING(node)
+				|| (rbBlack == TR_TREE_SIBLING(node)->color
+					&& (NULL == TR_TREE_SIBLING(node)->left
+						|| rbBlack == TR_TREE_SIBLING(node)->left->color)
+					&& (NULL == TR_TREE_SIBLING(node)->right
+						|| rbBlack == TR_TREE_SIBLING(node)->right->color))) {
+
+			if (NULL != TR_TREE_SIBLING(node)) {
+				TR_TREE_SIBLING(node)->color = rbRed;
+			}
+
+
+			/*
+			 * this is the point where during the balancing our tree
+			 * node can be finally deleted.
+			 */
+			if (rbBlack == TR_TREE_PARENT(node)->color) {
+				// case 3
+				TR_Tree parent = node->parent;
+				node = parent;
+				continue;
+			} else {
+				// case 4
+				TR_TREE_PARENT(node)->color = rbBlack;
+				break;
+			}
+		}
+
+		// case 5
+		if (NULL != TR_TREE_SIBLING(node)
+				&& rbBlack == TR_TREE_SIBLING(node)->color) {
+
+			if (node == TR_TREE_PARENT(node)->left
+					&& (NULL == TR_TREE_SIBLING(node)->right
+						|| rbBlack == TR_TREE_SIBLING(node)->right->color)
+					&& (NULL != TR_TREE_SIBLING(node)->left
+						&& rbRed == TR_TREE_SIBLING(node)->left->color)) {
+
+				TR_TREE_SIBLING(node)->color       = rbRed;
+				TR_TREE_SIBLING(node)->left->color = rbBlack;
+
+				//TREE_ROTATE_RIGHT(this, TREE_SIBLING(node));
+				TR_treeRotateRight(this, TR_TREE_SIBLING(node));
+
+			} else if (node == TR_TREE_PARENT(node)->right
+					&& (NULL == TR_TREE_SIBLING(node)->left
+						|| rbBlack == TR_TREE_SIBLING(node)->left->color)
+					&& (NULL != TR_TREE_SIBLING(node)->right
+						&& rbRed == TR_TREE_SIBLING(node)->right->color)) {
+
+				TR_TREE_SIBLING(node)->color        = rbRed;
+				TR_TREE_SIBLING(node)->right->color = rbBlack;
+
+				//TREE_ROTATE_LEFT(this, TREE_SIBLING(node));
+				TR_treeRotateLeft(this, TR_TREE_SIBLING(node));
+			}
+		}
+		
+		// case 6
+		if (NULL != TR_TREE_SIBLING(node)) {
+			TR_TREE_SIBLING(node)->color = TR_TREE_PARENT(node)->color;
+		}
+
+		if (NULL != node && NULL != TR_TREE_PARENT(node)) {
+			TR_TREE_PARENT(node)->color = rbBlack;
+
+			if (NULL != TR_TREE_PARENT(node)->right
+					&& node != TR_TREE_PARENT(node)->right) {
+
+				if (NULL != TR_TREE_SIBLING(node)->right) {
+					TR_TREE_SIBLING(node)->right->color = rbBlack;
+				}
+				//TREE_ROTATE_LEFT(this, TREE_PARENT(node));
+				TR_treeRotateLeft(this, TR_TREE_PARENT(node));
+			} else {
+				if (NULL != TR_TREE_SIBLING(node)->left) {
+					TR_TREE_SIBLING(node)->left->color = rbBlack;
+				}
+				//TREE_ROTATE_RIGHT(this, TREE_PARENT(node));
+				TR_treeRotateRight(this, TR_TREE_PARENT(node));
+			}
+		}
+
+		break;
+	}
+
+	TR_delete(del_node);
+	/*
+	 * not sure if deleting here is correct.
+	 */
+	return data;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "trbase.h"
+#include "tr/tree.h"
+
+void
+TR_treeDestroy(TR_Tree * this, TR_TreeAction action)
+{
+    TR_Tree previous = * this;
+    TR_Tree node     = * this;
+    int  depth    = 1;
+    
+    /*
+     * I think this has something like O(n+log(n)) on a ballanced
+     * tree because I have to traverse back the rightmost leaf to
+     * the root to get a break condition.
+     */
+    while (NULL != node) {
+        /*
+         * If we come from the right so nothing and go to our
+         * next parent.
+         */
+        if (((NULL == TR_TREE_LEFT(node)
+				|| previous == TR_TREE_LEFT(node)) && NULL == TR_TREE_RIGHT(node))
+				|| previous == TR_TREE_RIGHT(node)) {
+            
+            TR_Tree parent = TR_TREE_PARENT(node);
+            
+            action(node->data, depth);
+            
+            previous = node;
+			TR_delete(node);
+            node = parent;
+            depth--;
+
+            continue;
+        }
+        
+        if ((NULL == TR_TREE_LEFT(node) || previous == TR_TREE_LEFT(node))) {
+            /*
+             * If there are no more elements to the left or we
+             * came from the left, process data.
+             */
+            previous = node;
+            
+            if (NULL != TR_TREE_RIGHT(node)) {
+                node = TR_TREE_RIGHT(node);
+                depth++;
+            } else { 
+                node = TR_TREE_PARENT(node);
+                depth--;
+            }
+        } else {
+            /*
+             * if there are more elements to the left go there.
+             */
+            previous = node;
+            node     = TR_TREE_LEFT(node);
+            depth++;
+        }
+    }
+	
+	*this = NULL;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/tree.h"
+
+void *
+TR_treeFind(TR_Tree this, const void * search, TR_TreeComp comp)
+{
+	while (NULL != this) {
+		int comparison = comp(this->data, search);
+
+		if (0 < comparison) {
+			this = TR_TREE_LEFT(this);
+			continue;
+		}
+
+		if (0 > comparison) {
+			this = TR_TREE_RIGHT(this);
+			continue;
+		}
+
+		if (0 == comparison) {
+			break;
+		}
+	}   
+
+	return NULL != this ? this->data : NULL;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/tree.h"
+
+TR_Tree
+TR_inOrderSuccessor(TR_Tree this)
+{
+	this = TR_TREE_RIGHT(this);
+
+	while (NULL != TR_TREE_LEFT(this)) {
+		this = TR_TREE_LEFT(this);
+	}
+
+	return this;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "trbase.h"
+#include "tr/tree.h"
+
+void TR_treeRotateLeft(TR_Tree *, TR_Tree);
+void TR_treeRotateRight(TR_Tree *, TR_Tree);
+
+void *
+TR_treeInsert(TR_Tree * this, const void * search, TR_TreeComp comp)
+{
+	TR_Tree node     = *this;
+	TR_Tree new_node = NULL;
+
+	/*
+	 * insert the node or return the one in tree if comparison
+	 * succeeds.
+	 */
+	if (NULL == node) {
+		/*
+		 * if the root is NULL we simple add the element and set
+		 * node to it.
+		 */
+		*this = node = new_node = TR_new(TR_Tree, search);
+	} else {
+		/*
+		 * first search for it and if its found return the data
+		 * and we are done...
+		 */
+		int  comparison;
+
+		while (NULL != node) {
+			comparison = comp(node->data, search);
+
+			if (0 < comparison) {
+				if (NULL != TR_TREE_LEFT(node)) {
+					node = TR_TREE_LEFT(node);
+					continue;
+				} else {
+					break;
+				}
+			}
+
+			if (0 > comparison) {
+				if (NULL != TR_TREE_RIGHT(node)) {
+					node = TR_TREE_RIGHT(node);
+					continue;
+				} else {
+					break;
+				}
+			}
+
+			if (0 == comparison) {
+				return node->data;
+			}
+		}   
+
+		/*
+		 * as we have not found it now add a new element.
+		 */
+		if (0 < comparison) {
+			node->left = TR_new(TR_Tree, search);
+			TR_TREE_LEFT(node)->parent = node;
+			node = new_node = TR_TREE_LEFT(node);
+		} else {
+			node->right = TR_new(TR_Tree, search);
+			TR_TREE_RIGHT(node)->parent = node;
+			node = new_node = TR_TREE_RIGHT(node);
+		}
+	}
+
+	/*
+	 * we expect node not to be NULL and pointing to our
+	 * new node at this point...now rabalance the tree
+	 */
+	while (1) {
+		// case 1
+		if (NULL == TR_TREE_PARENT(node)) {
+			node->color = rbBlack;
+			break;
+		}
+
+		// case 2
+		if (rbBlack == TR_TREE_PARENT(node)->color) {
+			break;
+		}
+
+		// case 3
+		if (NULL != TR_TREE_UNCLE(node) && rbRed == TR_TREE_UNCLE(node)->color) {
+			TR_TREE_PARENT(node)->color      = rbBlack;
+			TR_TREE_UNCLE(node)->color       = rbBlack;
+			TR_TREE_GRANDPARENT(node)->color = rbRed;
+
+			node = TR_TREE_GRANDPARENT(node);
+			continue;
+		}
+
+		// case 4
+		if (node == TR_TREE_PARENT(node)->right
+				&& TR_TREE_PARENT(node) == TR_TREE_GRANDPARENT(node)->left) {
+
+			//TREE_ROTATE_LEFT(this, TREE_PARENT(node));
+			TR_treeRotateLeft(this, TR_TREE_PARENT(node));
+			node = TR_TREE_LEFT(node);
+
+		} else if (node == TR_TREE_PARENT(node)->left
+				&& TR_TREE_PARENT(node) == TR_TREE_GRANDPARENT(node)->right) {
+
+			//TREE_ROTATE_RIGHT(this, TREE_PARENT(node));
+			TR_treeRotateRight(this, TR_TREE_PARENT(node));
+			node = TR_TREE_RIGHT(node);
+
+		}
+
+		// case 5
+		TR_TREE_PARENT(node)->color      = rbBlack;
+		TR_TREE_GRANDPARENT(node)->color = rbRed;
+
+		if (node == TR_TREE_PARENT(node)->left) {
+			//TREE_ROTATE_RIGHT(this, TREE_GRANDPARENT(node));
+			TR_treeRotateRight(this, TR_TREE_GRANDPARENT(node));
+		} else {
+			//TREE_ROTATE_LEFT(this, TREE_GRANDPARENT(node));
+			TR_treeRotateLeft(this, TR_TREE_GRANDPARENT(node));
+		}
+
+		break;
+	}
+
+	return new_node->data;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/tree.h"
+
+void
+TR_treeRotateLeft(TR_Tree * this, TR_Tree node)
+{
+	TR_Tree rightChild = TR_TREE_RIGHT(node);
+	TR_Tree rcLeftSub  = TR_TREE_RIGHT_LEFT(node);
+
+	rightChild->left   = node;
+	rightChild->parent = TR_TREE_PARENT(node);
+	node->right        = rcLeftSub;
+	if (NULL != rcLeftSub) {
+		rcLeftSub->parent  = node;
+	}   
+
+	if (NULL != TR_TREE_PARENT(node)) {
+		if (TR_TREE_PARENT(node)->left == node) {
+			TR_TREE_PARENT(node)->left = rightChild;
+		} else {
+			TR_TREE_PARENT(node)->right = rightChild;
+		}   
+	} else {
+		*this = rightChild;
+	}   
+
+	node->parent = rightChild;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/tree.h"
+
+void
+TR_treeRotateRight(TR_Tree * this, TR_Tree node)
+{
+	TR_Tree leftChild  = TR_TREE_LEFT(node);
+	TR_Tree lcRightSub = TR_TREE_LEFT_RIGHT(node);
+
+	leftChild->right   = node;
+	leftChild->parent  = TR_TREE_PARENT(node);
+	node->left         = lcRightSub;
+	if (NULL != lcRightSub) {
+		lcRightSub->parent = node;
+	}   
+
+	if (NULL != TR_TREE_PARENT(node)) {
+		if (TR_TREE_PARENT(node)->left == node) {
+			TR_TREE_PARENT(node)->left = leftChild;
+		} else {
+			TR_TREE_PARENT(node)->right = leftChild;
+		}   
+	} else {
+		*this = leftChild;
+	}   
+
+	node->parent = leftChild;
+}
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#define _GNU_SOURCE
+
+#include <stdarg.h>
+
+#include "trbase.h"
+#include "tr/tree.h"
+
+static
+int
+treeCtor(void * _this, va_list * params)
+{
+	TR_Tree this = _this;
+
+	this->data   = va_arg(*params, void *);
+	this->color  = rbRed;
+	this->parent = NULL;
+	this->left   = NULL;
+	this->right  = NULL;
+
+	return 0;
+}
+
+static
+void
+treeDtor(void * _this)
+{
+}
+
+TR_INIT_IFACE(TR_Class, treeCtor, treeDtor, NULL);
+TR_CREATE_CLASS(TR_Tree, NULL, TR_IF(TR_Class));
+
+// vim: set ts=4 sw=4:

+/**
+ * \file
+ *
+ * \author	Georg Hopp
+ *
+ * \copyright
+ * Copyright © 2012  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tr/tree.h"
+
+void
+TR_treeWalk(TR_Tree this, TR_TreeAction action)
+{
+	TR_Tree previous = this;
+	TR_Tree node     = this;
+	int  depth       = 1;
+
+	while (NULL != node) {
+		if (previous == TR_TREE_RIGHT(node)) {
+			previous = node;
+			node     = node->parent;
+			depth--;
+			continue;
+		}
+
+		if (NULL == TR_TREE_LEFT(node) || previous == TR_TREE_LEFT(node)) {
+			action(node->data, depth);
+			previous = node;
+
+			if (NULL != TR_TREE_RIGHT(node)) {
+				node = TR_TREE_RIGHT(node);
+				depth++;
+			} else {
+				node = TR_TREE_PARENT(node);
+				depth--;
+			}
+		} else {
+			previous = node;
+			node     = TR_TREE_LEFT(node);
+			depth++;
+		}
+	}
+}
+
+// vim: set ts=4 sw=4:

+ACLOCAL_AMFLAGS = -I m4
+AUTOMAKE_OPTIONS = subdir-objects
+
+TESTS_ENVIRONMENT = valgrind \
+		    --error-exitcode=123 \
+		    --leak-check=full \
+		    --suppressions=./suppress/external.supp \
+		    --quiet
+TESTS = classTest
+check_PROGRAMS = classTest
+
+COMMON = runtest.c
+CLASS  = $(COMMON) \
+	 ../src/interface.c \
+	 ../src/i_class.c \
+	 ../src/memory.c \
+	 mock/mock_class.c
+
+AM_CFLAGS += -O0 -Wall -Werror -ggdb -I ../include -I .. -I . $(MEM_OPT_FLAGS)
+AM_LDFLAGS = 
+
+if HAVE_GCOV
+AM_CFLAGS += $(COVERAGE_CFLAGS)
+AM_LDFLAGS += $(COVERAGE_LDFLAGS)
+endif
+
+classTest_SOURCES = $(CLASS) classTest.c
+classTest_CFLAGS  = $(AM_CFLAGS) -pg
+classTest_LDFLAGS = $(AM_LDFLAGS) -pg
+
+EXTRA_DIST = runtest.h mock suppress
+
+if HAVE_GCOV
+
+.PHONY: clean-gcda clean-gcno coverage-html clean-coverage
+
+cov_dir = $(top_srcdir)/tests/coverage/$(PACKAGE_VERSION)
+
+coverage-html: clean clean-coverage check
+	@echo Collecting coverage data
+	$(LCOV) -d $(top_srcdir) -c -i -o coverage.base
+	$(LCOV) -d $(top_srcdir) -c -o coverage.run --gcov-tool /usr/bin/gcov
+	$(LCOV) -d $(top_srcdir) \
+		-a ./coverage.base -a ./coverage.run \
+		-o coverage.info
+	LANG=C $(GENHTML) --prefix $(top_srcdir) \
+	     --output-directory $(cov_dir) \
+	     --title "$(PACKAGE_NAME) $(PACKAGE_VERSION)" \
+	     --legend --branch-coverage --show-details coverage.run
+
+clean-coverage: clean-gcda clean-gcno
+	$(LCOV) -d $(top_srcdir) -z
+	-rm -rf coverage.info coverage.base coverage.run $(cov_dir)
+  
+clean-gcda:
+	@echo Removing old coverage results
+	-find $(top_srcdir) -name '*.gcda' -print | xargs -r rm
+  
+clean-gcno:
+	@echo Removing old coverage results
+	-find $(top_srcdir) -name '*.gcno' -print | xargs -r rm
+  
+clean-local: clean-coverage
+
+endif # HAVE_GCOV

+/**
+ * \file
+ * cclassTest.c: tests for my oop C stuff
+ * Copyright (C) 2011  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <stdio.h>
+#include <sys/types.h>
+
+#include "runtest.h"
+#include "mock/mock_class.h"
+
+#include "tr/class.h"
+
+const char testname[] = "cclassTest";
+
+MockClass mock = NULL;
+
+static
+int
+__setUp()
+{
+    mock = NULL;
+    _reset();
+
+    return TEST_OK;
+}
+int (* const setUp)() = __setUp;
+
+static
+int
+__tearDown()
+{
+    if (NULL != mock) {
+        ASSERT_OBJECT(mock);
+        TR_delete(mock);
+    }
+
+    return TEST_OK;
+}
+int (* const tearDown)() = __tearDown;
+
+static
+int
+testNew(void)
+{
+    mock = TR_new(MockClass, 123);
+
+    ASSERT_OBJECT_NOT_NULL(mock);
+    ASSERT_EQUAL(1, _called);
+    ASSERT_EQUAL(123, mock->value);
+
+    return TEST_OK;
+}
+
+static
+int
+testNewFail(void)
+{
+    mock = TR_new(MockClass, 321);
+
+    ASSERT_NULL(mock);
+
+    return TEST_OK;
+}
+
+static
+int
+testDelete(void)
+{
+    mock = TR_new(MockClass, 123);
+
+    ASSERT_NOT_NULL(mock);
+
+    _reset();
+    TR_delete(mock);
+
+    ASSERT_NULL(mock);
+    ASSERT_EQUAL(1, _called);
+
+    return TEST_OK;
+}
+
+static
+int
+testClone(void)
+{
+    MockClass clone;
+
+    mock  = TR_new(MockClass, 123);
+    clone = TR_clone(mock);
+
+    ASSERT_INSTANCE_OF(MockClass, clone);
+    ASSERT_EQUAL(mock->value, clone->value);
+
+    TR_delete(clone);
+
+    return TEST_OK;
+}
+
+const testfunc tests[] = {
+    testNew,
+    testNewFail,
+    testDelete,
+    testClone
+};
+const size_t count = FUNCS_COUNT(tests);
+
+// vim: set et ts=4 sw=4:

+/**
+ * \file
+ * mock/class.c: a mock to test my oop stuff
+ * Copyright (C) 2011  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <assert.h>
+#include <stdarg.h>
+
+#include "tr/class.h"
+#include "mock_class.h"
+
+char _called;
+
+void
+_reset()
+{
+    _called = 0;
+}
+
+static
+inline
+int
+mockCtor(void * _this, va_list * params)
+{
+    MockClass this = _this;
+
+    _called = 1;
+    this->value = va_arg(* params, int);
+
+    if (321 == this->value)
+        return -1;
+
+    return 0;
+}
+
+static
+inline
+void
+mockDtor(void * _this)
+{
+    _called = 1;
+}
+
+static
+inline
+void
+mockClone(void * _this, void * _base)
+{
+    MockClass this = _this;
+    MockClass base = _base;
+
+    this->value = base->value;
+}
+
+TR_INIT_IFACE(TR_Class, mockCtor, mockDtor, mockClone);
+TR_CREATE_CLASS(MockClass, NULL, TR_IF(TR_Class));
+
+// vim: set et ts=4 sw=4:

+/**
+ * \file
+ * mock/class.h: definitions for my mock to test my oop stuff
+ *
+ * \author Georg Hopp <georg@steffers.org>
+ *
+ * \copyright
+ * Copyright (C) 2011  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef __MOCK_MOCK_CLASS_H__
+#define __MOCK_MOCK_CLASS_H__
+
+#include "trbase.h"
+
+extern char _called;
+
+#ifndef _RESET
+#define _RESET
+void _reset();
+#endif // _RESET
+
+
+TR_CLASS(MockClass) {
+    int value;
+};
+
+/**
+ * ~~~ method declarations ~~~~~~~~
+ */
+
+int  mockClassGetValue(MockClass this);
+void mockClassSetValue(MockClass this, int value);
+
+#endif//__MOCK_MOCK_CLASS_H__
+
+// vim: set et ts=4 sw=4:

+/**
+ * \file
+ * runtest.c: the main runner for my tests
+ * Copyright (C) 2011  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/types.h>
+
+#include "runtest.h"
+#include "tr/class.h"
+
+
+#define TEST_OK_CHAR		'.'
+#define TEST_FAILED_CHAR	'F'
+#define TEST_ERROR_CHAR		'E'
+
+
+const char results[3] = {
+    TEST_OK_CHAR,
+    TEST_FAILED_CHAR,
+    TEST_ERROR_CHAR
+};
+
+int
+isObjectNull(void * object)
+{
+    TR_class_ptr class = TR_GET_CLASS(object);
+
+    if (! TR_IS_OBJECT(object)) {
+        return 0;
+    }
+
+    return isMemNull(object, class->object_size);
+}
+
+int
+isMemNull(void * _mem, size_t size)
+{
+    size_t index;
+
+    if (NULL == _mem) {
+        return 0;
+    }
+
+    for(index=0; index<size && 0 == ((char *)_mem)[index]; index++);
+
+    return (size == index);
+}
+
+int
+main(int argc, char * argv[])
+{
+    size_t errors     = 0;
+    size_t failures   = 0;
+    // size_t assertions = 0;   // @TODO find a way to count assertions
+
+    size_t index;
+
+    printf("running tests for %s\n", testname);
+
+    for (index=0; index<count; index++) {
+        int result = TEST_ERROR, _setUp = 0;  // initialize setup to false
+
+        if (NULL != setUp) {
+            if (TEST_OK == (result = setUp())) {
+                _setUp = 1;  // we successfully set up the test
+            }
+        }
+
+        if (_setUp) {
+            result = tests[index]();
+        }
+
+        if (_setUp && NULL != tearDown) {
+            int _tearDown = tearDown();
+
+            if ((! TEST_OK == _tearDown) && TEST_OK == result) {
+                result = _tearDown;
+            }
+        }
+
+        switch (result) {
+            case TEST_FAILED: failures++; break;
+            case TEST_ERROR:  errors++; break;
+        }
+
+        putchar(results[result]);
+
+        if (79 == index%80) {
+            putchar('\n');
+        }
+
+        fflush(stdout);
+    }
+    puts("\n");
+
+    printf("running %lu tests: %lu - OK, %lu - FAILED, %lu - ERRORS\n",
+            count,
+            count - errors - failures,
+            failures,
+            errors);
+
+    return failures + errors;
+}
+
+// vim: set et ts=4 sw=4:

+/**
+ * \file
+ * runtest.h: assertions and other definitions for all my tests
+ *
+ * \author Georg Hopp <georg@steffers.org>
+ *
+ * \copyright
+ * Copyright (C) 2011  Georg Hopp
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef __RUNTEST_h__
+#define __RUNTEST_h__
+
+#include <sys/types.h>
+#include <string.h>
+
+#include "trbase.h"
+
+enum RESULT_TYPES {
+    TEST_OK=0,
+    TEST_FAILED,
+    TEST_ERROR
+};
+
+#define ASSERT_NULL(value) \
+    if (NULL != (value)) { \
+        printf("%s[%d]: Assertion failed that %s is NULL\n", \
+                __FILE__, __LINE__, #value); \
+        return TEST_FAILED; }
+
+#define ASSERT_NOT_NULL(value) \
+    if (NULL == (value)) { \
+        printf("%s[%d]: Assertion failed that %s is NOT NULL\n", \
+                __FILE__, __LINE__, #value); \
+        return TEST_FAILED; }
+
+#define ASSERT_EQUAL(val1,val2) \
+    if ((val1) != (val2)) { \
+        printf("%s[%d]: Assertion failed that %s EQUALS %s\n", \
+                __FILE__, __LINE__, #val1, #val2); \
+        return TEST_FAILED; }
+
+#define ASSERT_NOT_EQUAL(val1,val2) \
+    if ((val1) == (val2)) { \
+        printf("%s[%d]: Assertion failed that %s NOT EQUALS %s\n", \
+                __FILE__, __LINE__, #val1, #val2); \
+        return TEST_FAILED; }
+
+#define ASSERT_MEM_EQUAL(val1,val2,size) \
+    if(0 != memcmp((val1), (val2), (size))) { \
+        printf("%s[%d]: Assertion failed that memory at %s EQUALS %s for %lu bytes\n", \
+                __FILE__, __LINE__, #val1, #val2, size); \
+        return TEST_FAILED; }
+
+#define ASSERT_MEM_NOT_EQUAL(val1,val2,size) \
+    if(0 == memcmp((val1), (val2), (size))) { \
+        printf("%s[%d]: Assertion failed that memory at %s NOT EQUALS %s for %lu bytes\n", \
+                __FILE__, __LINE__, #val1, #val2, size); \
+        return TEST_FAILED; }
+
+#define ASSERT_MEM_NULL(val, size) \
+    if (! isMemNull((val), (size))) { \
+        printf("%s[%d]: Assertion failed that memory at %s is NULL for %lu bytes\n", \
+                __FILE__, __LINE__, #val, size); \
+        return TEST_FAILED; }
+
+#define ASSERT_MEM_NOT_NULL(val, size) \
+    if (isMemNull((val), (size))) { \
+        printf("%s[%d]: Assertion failed that memory at %s is NOT NULL for %lu bytes\n", \
+                __FILE__, __LINE__, #val, size); \
+        return TEST_FAILED; }
+
+#define ASSERT_STRING_EQUAL(val1, val2) \
+    if(0 != strcmp((val1), (val2))) { \
+        printf("%s[%d]: Assertion failed that string %s EQUALS %s\n", \
+                __FILE__, __LINE__, val1, val2); \
+        return TEST_FAILED; }
+
+#define ASSERT_STRING_NOT_EQUAL(val1, val2) \
+    if(0 == strcmp((val1), (val2))) { \
+        printf("%s[%d]: Assertion failed that string %s NOT EQUALS %s\n", \
+                __FILE__, __LINE__, val1, val2); \
+        return TEST_FAILED; }
+
+#define ASSERT_OBJECT(val) \
+    if (! TR_IS_OBJECT((val))) { \
+        printf("%s[%d]: Assertion failed that %s IS an object\n", \
+                __FILE__, __LINE__, #val); \
+        return TEST_FAILED; }
+
+#define ASSERT_OBJECT_NULL(val) \
+    if (! isObjectNull((val))) { \
+        printf("%s[%d]: Assertion failed that %s IS an UNINITIALIZED object\n", \
+                __FILE__, __LINE__, #val); \
+        return TEST_FAILED; }
+
+#define ASSERT_OBJECT_NOT_NULL(val) \
+    if (isObjectNull((val))) { \
+        printf("%s[%d]: Assertion failed that %s IS an INITIALIZED object\n", \
+                __FILE__, __LINE__, #val); \
+        return TEST_FAILED; }
+
+#define ASSERT_INSTANCE_OF(class, val) \
+    if (! TR_INSTANCE_OF(class, val)) { \
+        printf("%s[%d]: Assertion failed that %s is instance of %s\n", \
+                __FILE__, __LINE__, #val, #class); \
+        return TEST_FAILED; }
+
+
+typedef int (* const testfunc)(void);
+#define FUNCS_COUNT(array)  (sizeof((array)) / sizeof(testfunc))
+
+extern const char testname[];
+extern testfunc tests[];
+extern const size_t count;
+
+extern int (* const setUp)();
+extern int (* const tearDown)();
+
+int isMemNull(void * _mem, size_t size);
+int isObjectNull(void * _object);
+
+#endif//__RUNTEST_h__
+// vim: set et ts=4 sw=4:

+#
+# This is a valgrind suppression file that should be used when using valgrind.
+#
+# See Misc/README.valgrind for more information.
+{
+	GDBM open on non existent file
+	Memcheck:Param
+	write(buf)
+	fun:__write_nocancel
+	fun:_gdbm_full_write
+	fun:gdbm_open
+	fun:storageCtor
+	fun:classNew
+	fun:main
+}
+
+{
+	GDBM close - to be honest I don't know what it complains about.
+	Memcheck:Param
+	msync(start)
+	fun:__msync_nocancel
+	fun:gdbm_close
+	fun:storageDtor
+	fun:classDelete
+	fun:main
+}
+
+{
+	Uninitialized bytes in openldap
+	Memcheck:Param
+	sendmsg(mmsg[0].msg_hdr)
+	fun:sendmmsg
+	fun:__libc_res_nsend
+	fun:__libc_res_nquery
+	fun:__libc_res_nquerydomain
+	fun:__libc_res_nsearch
+	fun:_nss_dns_gethostbyname4_r
+	fun:gaih_inet
+	fun:getaddrinfo
+	fun:ldap_connect_to_host
+	fun:ldap_int_open_connection
+	fun:ldap_new_connection
+	fun:ldap_open_defconn
+}
+

+/* trdata.h.  Generated from trdata.h.in by configure.  */
+/* trdata.h.in.  Generated from configure.ac by autoheader.  */
+
+/* Define to 1 if you have the <dlfcn.h> header file. */
+#define HAVE_DLFCN_H 1
+
+/* Define to 1 if you have the <inttypes.h> header file. */
+#define HAVE_INTTYPES_H 1
+
+/* Define to 1 if you have the <memory.h> header file. */
+#define HAVE_MEMORY_H 1
+
+/* Define to 1 if you have the `memset' function. */
+#define HAVE_MEMSET 1
+
+/* Define to 1 if you have the <stdarg.h> header file. */
+#define HAVE_STDARG_H 1
+
+/* Define to 1 if stdbool.h conforms to C99. */
+#define HAVE_STDBOOL_H 1
+
+/* Define to 1 if you have the <stdint.h> header file. */
+#define HAVE_STDINT_H 1
+
+/* Define to 1 if you have the <stdio.h> header file. */
+#define HAVE_STDIO_H 1
+
+/* Define to 1 if you have the <stdlib.h> header file. */
+#define HAVE_STDLIB_H 1
+
+/* Define to 1 if you have the <strings.h> header file. */
+#define HAVE_STRINGS_H 1
+
+/* Define to 1 if you have the <string.h> header file. */
+#define HAVE_STRING_H 1
+
+/* Define to 1 if you have the <syslog.h> header file. */
+#define HAVE_SYSLOG_H 1
+
+/* Define to 1 if you have the <sys/stat.h> header file. */
+#define HAVE_SYS_STAT_H 1
+
+/* Define to 1 if you have the <sys/types.h> header file. */
+#define HAVE_SYS_TYPES_H 1
+
+/* Define to 1 if you have the <unistd.h> header file. */
+#define HAVE_UNISTD_H 1
+
+/* Define to 1 if the system has the type `_Bool'. */
+#define HAVE__BOOL 1
+
+/* Define to the sub-directory in which libtool stores uninstalled libraries.
+   */
+#define LT_OBJDIR ".libs/"
+
+/* Name of package */
+#define PACKAGE "libtrhash"
+
+/* Define to the address where bug reports for this package should be sent. */
+#define PACKAGE_BUGREPORT "Georg Hopp <georg@steffers.org>"
+
+/* Define to the full name of this package. */
+#define PACKAGE_NAME "libtrhash"
+
+/* Define to the full name and version of this package. */
+#define PACKAGE_STRING "libtrhash 0.0.0"
+
+/* Define to the one symbol short name of this package. */
+#define PACKAGE_TARNAME "libtrhash"
+
+/* Define to the home page for this package. */
+#define PACKAGE_URL ""
+
+/* Define to the version of this package. */
+#define PACKAGE_VERSION "0.0.0"
+
+/* Define to 1 if you have the ANSI C header files. */
+#define STDC_HEADERS 1
+
+/* Version number of package */
+#define VERSION "0.0.0"
+
+/* Define to `__inline__' or `__inline' if that's what the C compiler
+   calls it, or to nothing if 'inline' is not supported under any name.  */
+#ifndef __cplusplus
+/* #undef inline */
+#endif
+
+/* Define to `int' if <sys/types.h> does not define. */
+/* #undef pid_t */
+
+/* Define to `unsigned int' if <sys/types.h> does not define. */
+/* #undef size_t */

+/* trdata.h.in.  Generated from configure.ac by autoheader.  */
+
+/* Define to 1 if you have the <dlfcn.h> header file. */
+#undef HAVE_DLFCN_H
+
+/* Define to 1 if you have the <inttypes.h> header file. */
+#undef HAVE_INTTYPES_H
+
+/* Define to 1 if you have the <memory.h> header file. */
+#undef HAVE_MEMORY_H
+
+/* Define to 1 if you have the `memset' function. */
+#undef HAVE_MEMSET
+
+/* Define to 1 if you have the <stdarg.h> header file. */
+#undef HAVE_STDARG_H
+
+/* Define to 1 if stdbool.h conforms to C99. */
+#undef HAVE_STDBOOL_H
+
+/* Define to 1 if you have the <stdint.h> header file. */
+#undef HAVE_STDINT_H
+
+/* Define to 1 if you have the <stdio.h> header file. */
+#undef HAVE_STDIO_H
+
+/* Define to 1 if you have the <stdlib.h> header file. */
+#undef HAVE_STDLIB_H
+
+/* Define to 1 if you have the <strings.h> header file. */
+#undef HAVE_STRINGS_H
+
+/* Define to 1 if you have the <string.h> header file. */
+#undef HAVE_STRING_H
+
+/* Define to 1 if you have the <syslog.h> header file. */
+#undef HAVE_SYSLOG_H
+
+/* Define to 1 if you have the <sys/stat.h> header file. */
+#undef HAVE_SYS_STAT_H
+
+/* Define to 1 if you have the <sys/types.h> header file. */
+#undef HAVE_SYS_TYPES_H
+
+/* Define to 1 if you have the <unistd.h> header file. */
+#undef HAVE_UNISTD_H
+
+/* Define to 1 if the system has the type `_Bool'. */
+#undef HAVE__BOOL
+
+/* Define to the sub-directory in which libtool stores uninstalled libraries.
+   */
+#undef LT_OBJDIR
+
+/* Name of package */
+#undef PACKAGE
+
+/* Define to the address where bug reports for this package should be sent. */
+#undef PACKAGE_BUGREPORT
+
+/* Define to the full name of this package. */
+#undef PACKAGE_NAME
+
+/* Define to the full name and version of this package. */
+#undef PACKAGE_STRING
+
+/* Define to the one symbol short name of this package. */
+#undef PACKAGE_TARNAME
+
+/* Define to the home page for this package. */
+#undef PACKAGE_URL
+
+/* Define to the version of this package. */
+#undef PACKAGE_VERSION
+
+/* Define to 1 if you have the ANSI C header files. */
+#undef STDC_HEADERS
+
+/* Version number of package */
+#undef VERSION
+
+/* Define to `__inline__' or `__inline' if that's what the C compiler
+   calls it, or to nothing if 'inline' is not supported under any name.  */
+#ifndef __cplusplus
+#undef inline
+#endif
+
+/* Define to `int' if <sys/types.h> does not define. */
+#undef pid_t
+
+/* Define to `unsigned int' if <sys/types.h> does not define. */
+#undef size_t