Browse Source

initial version derived from taskrambler

1.0.2
Georg Hopp 12 years ago
commit
bc62624956
  1. 41
      .gitignore
  2. 1
      AUTHORS
  3. 674
      COPYING
  4. 0
      ChangeLog
  5. 20
      Makefile.am
  6. 0
      NEWS
  7. 1
      README
  8. 81
      README.html
  9. 155
      README.md
  10. 0
      TODO
  11. 7
      bootstrap
  12. 64
      configure.ac
  13. 1584
      docs/Doxyfile.in
  14. 13
      docs/Makefile.am
  15. 11
      include/Makefile.am
  16. 285
      include/tr/class.h
  17. 73
      include/tr/commons.h
  18. 137
      include/tr/interface.h
  19. 121
      include/tr/interface/class.h
  20. 56
      include/tr/interface/indexable.h
  21. 47
      include/tr/interface/observer.h
  22. 50
      include/tr/interface/serializable.h
  23. 46
      include/tr/interface/subject.h
  24. 39
      include/tr/memory.h
  25. 16
      include/trbase.h
  26. 80
      m4/gcov.m4
  27. 14
      m4/memopt.m4
  28. 19
      src/Makefile.am
  29. 125
      src/i_class.c
  30. 45
      src/i_indexable.c
  31. 42
      src/i_observer.c
  32. 66
      src/i_serializable.c
  33. 61
      src/i_subject.c
  34. 72
      src/interface.c
  35. 885
      src/memory.c
  36. 65
      tests/Makefile.am
  37. 121
      tests/classTest.c
  38. 72
      tests/mock/mock_class.c
  39. 49
      tests/mock/mock_class.h
  40. 121
      tests/runtest.c
  41. 136
      tests/runtest.h
  42. 45
      tests/suppress/external.supp

41
.gitignore

@ -0,0 +1,41 @@
.*.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

1
AUTHORS

@ -0,0 +1 @@
Georg Hopp <georg@steffers.org>

674
COPYING

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

0
ChangeLog

20
Makefile.am

@ -0,0 +1,20 @@
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/'

0
NEWS

1
README

@ -0,0 +1 @@
README.md

81
README.html

@ -0,0 +1,81 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title></title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<h1 id="libtrbase">LIBTRBASE</h1>
<p>As the very basic building block of <a href="http://taskrambler.weird-web-workers.org/">taskrambler</a> this library provides a system to create basic classes and interfaces in ANSI C, some common macro definitions (always useful) and an optimized memory management system.</p>
<h3 id="the-class-system">The class system</h3>
<p>The class system is not what you know from &quot;real&quot; object oriented languages. It only provides these few OOP features:</p>
<ul>
<li>code and data encapsulation</li>
<li>late binding through interfaces</li>
<li>inheritance</li>
</ul>
<p>I created it with the idea that at least for me the most useful part of object orientation is the ability to create interfaces and bind them to a specific data structure. This binding in turn enables injection which for me is by far the most important type of object combination.</p>
<p>The second important thing, mostly to reduce code duplication, is inheritance.</p>
<p>The class system combines C structures with one or more interfaces. Each of these interfaces consists of one ore more pointers to functions which must be set during the class creation. These functions are then called via selector functions which have to be defined for the specific interface.</p>
<p>The interface of the class system consists of Preprocessor definitions which provide an easy way to create the neccessary data structures and definitions. There are also definitions for calling the correct interface implementation for a given class instance. If no implementation can be found in the class of the current object it will be looked for in the parent class if there is one and so forth.</p>
<p>The ideas for this are partly derived from the Book <em>&quot;Object Oriented Programming in ANSI C&quot;</em> from Axel-Tobias Schreiner.</p>
<p>In the examples I will show how libtrbase supports you in creating these structures.</p>
<h3 id="the-optimized-memory-management">The optimized memory management</h3>
<p>Allocating and freeing memory on the heap is an expensive action. And because of fragmentation effects it might become even more expensive if the process runs really long.</p>
<p>To overcome this issue I implemented a memory management which never really free's a given memory region, instead it stores the address in a ballanced btree indexed by the size of the memory segment. Multiple adresses for memory of the same size are simply listed. The next allocation first looks in this btree if there is a fitting segment (same size or larger as the requested segment) and returns it if available.</p>
<p>For the ballanced btree I use red-black trees. Thanks to the authors of the <a href="http://en.wikipedia.org/wiki/Red–black_tree">Wikipedia article</a>. This implementation is more or less taken from there, with only some small changes here and there.</p>
<p>The idea is based on an idea found on <a href="http://www.flounder.com/memory_allocation.htm">this page</a> of the The Joseph M. Newcomer Co. The concrete idea was first described by Charles B. Weinstock in his Ph.D. dissertation on storage allocation.</p>
<h2 id="installation">INSTALLATION</h2>
<p>This can be installed via the usual configure, make, make install cycle. For gentoo users am ebuild is added under docs.</p>
<h3 id="api-doc">API DOC</h3>
<p>To generate the api doc a patched version of doxygen is neccessary. A patch is included under docs.</p>
<p><em>make docs</em> creates the api doc.</p>
<h3 id="test-coverage-report">TEST COVERAGE REPORT</h3>
<p>gcov and lcov are needed to build these.</p>
<p>The source has to be configured with <em>configure --enable-gcov</em>. <em>make coverage-html</em> creates the converage reports then.</p>
<h2 id="usage">USAGE</h2>
<h3 id="api">API</h3>
<h4 id="function-like-macros---class-creation">function-like macros - class creation</h4>
<ul>
<li><strong>TR_CLASS(name):</strong> Declare a new class.</li>
<li><strong>TR_CREATE_CLASS(name, parent, ...):</strong> Create a new class.</li>
<li><strong>TR_EXTENDS(parent):</strong> Extend another class</li>
</ul>
<h4 id="function-like-macros---class-information">function-like macros - class information</h4>
<ul>
<li><strong>TR_GET_CLASS(object):</strong> Get the class of the given object.</li>
<li><strong>TR_HAS_PARENT(class):</strong> Check if the class extends another class.</li>
<li><strong>TR_IS_OBJECT(obj):</strong> Check that the given pointer is really an instance of a class.</li>
<li><strong>TR_INSTANCE_OF(class, obj):</strong> Check that the given obj is an instance of class.</li>
</ul>
<h4 id="function-like-macros---interface-selector-helper">function-like macros - interface selector helper</h4>
<ul>
<li><strong>TR_CALL(object, iface, method, ...):</strong> Call the interface implementation of the class or one of the parent classes of object.</li>
<li><strong>TR_RETCALL(object, iface, method, ret, ...):</strong> Same as TR_CALL but with return value.</li>
<li><strong>TR_PARENTCALL(object, iface, method, ...):</strong> Directly call the implementation within the parent class.</li>
</ul>
<h4 id="function-like-macros---interface-creation">function-like macros - interface creation</h4>
<ul>
<li><strong>TR_INTERFACE(name):</strong></li>
<li><strong>TR_CREATE_INTERFACE(name, nfunc):</strong></li>
<li><strong>TR_IF(name):</strong></li>
<li><strong>TR_INIT_IFACE(name, ...):</strong></li>
</ul>
<h3 id="example">EXAMPLE</h3>
<h4 id="optimized-memory-management">optimized memory management</h4>
<h4 id="create-a-new-class">create a new class</h4>
<h4 id="create-a-new-interface">create a new interface</h4>
<h4 id="implement-an-interface-in-a-class">implement an interface in a class</h4>
<h4 id="class-extension">class extension</h4>
<h2 id="testing">TESTING</h2>
<p>This comes with the start of a unit test suite. You can use <em>make test</em> to build and run the existent tests.</p>
<h3 id="requirements">REQUIREMENTS</h3>
<p>Currently, you need valgrind to build the tests, because some memory checking is done by the way.</p>
<h2 id="contribution">CONTRIBUTION</h2>
<p>I would really like to see some people possibly interested in this stuff. I think it contains some really interesting ideas.</p>
<p>If you like to contribute anyway, make a fork, do your changes and generate a pull request. Or simply contact me on georg@steffers.org.</p>
</body>
</html>

155
README.md

@ -0,0 +1,155 @@
LIBTRBASE
=========
As the very basic building block of
[taskrambler](http://taskrambler.weird-web-workers.org/) this library
provides a system to create basic classes and interfaces in
ANSI C, some common macro definitions (always useful) and an optimized
memory management system.
### The class system ###
The class system is not what you know from "real" object oriented languages.
It only provides these few OOP features:
* code and data encapsulation
* late binding through interfaces
* inheritance
I created it with the idea that at least for me the most useful part
of object orientation is the ability to create interfaces and bind them
to a specific data structure. This binding in turn enables injection which
for me is by far the most important type of object combination.
The second important thing, mostly to reduce code duplication, is inheritance.
The class system combines C structures with one or more interfaces. Each
of these interfaces consists of one ore more pointers to functions which
must be set during the class creation. These functions are then called
via selector functions which have to be defined for the specific interface.
The interface of the class system consists of Preprocessor definitions
which provide an easy way to create the neccessary data structures and
definitions. There are also definitions for calling the correct interface
implementation for a given class instance. If no implementation can be found in
the class of the current object it will be looked for in the parent class
if there is one and so forth.
The ideas for this are partly derived from the Book
*"Object Oriented Programming in ANSI C"* from Axel-Tobias Schreiner.
In the examples I will show how libtrbase supports you in creating these
structures.
### The optimized memory management ###
Allocating and freeing memory on the heap is an expensive action. And because
of fragmentation effects it might become even more expensive if the process
runs really long.
To overcome this issue I implemented a memory management which never really
free's a given memory region, instead it stores the address in a ballanced btree
indexed by the size of the memory segment. Multiple adresses for memory of the
same size are simply listed. The next allocation first looks in this btree if
there is a fitting segment (same size or larger as the requested segment) and
returns it if available.
For the ballanced btree I use red-black trees. Thanks to the authors of the
[Wikipedia article](http://en.wikipedia.org/wiki/Red–black_tree). This
implementation is more or less taken from there, with only some small changes
here and there.
The idea is based on an idea found on
[this page](http://www.flounder.com/memory_allocation.htm) of the
The Joseph M. Newcomer Co.
The concrete idea was first described by Charles B. Weinstock in his Ph.D.
dissertation on storage allocation.
INSTALLATION
------------
This can be installed via the usual configure, make, make install
cycle. For gentoo users am ebuild is added under docs.
### API DOC ###
To generate the api doc a patched version of doxygen is
neccessary. A patch is included under docs.
*make docs* creates the api doc.
### TEST COVERAGE REPORT
gcov and lcov are needed to build these.
The source has to be configured with *configure --enable-gcov*.
*make coverage-html* creates the converage reports then.
USAGE
-----
### API ###
#### function-like macros - class creation ####
* **TR\_CLASS(name):** Declare a new class.
* **TR\_CREATE\_CLASS(name, parent, ...):** Create a new class.
* **TR\_EXTENDS(parent):** Extend another class
#### function-like macros - class information ####
* **TR\_GET\_CLASS(object):** Get the class of the given object.
* **TR\_HAS\_PARENT(class):** Check if the class extends another class.
* **TR\_IS\_OBJECT(obj):** Check that the given pointer is really an
instance of a class.
* **TR\_INSTANCE\_OF(class, obj):** Check that the given obj is an instance of
class.
#### function-like macros - interface selector helper ####
* **TR\_CALL(object, iface, method, ...):** Call the interface implementation
of the class or one of the parent classes of object.
* **TR\_RETCALL(object, iface, method, ret, ...):** Same as TR\_CALL but
with return value.
* **TR\_PARENTCALL(object, iface, method, ...):** Directly call the
implementation within the parent class.
#### function-like macros - interface creation ####
* **TR\_INTERFACE(name):**
* **TR\_CREATE_INTERFACE(name, nfunc):**
* **TR\_IF(name):**
* **TR\_INIT\_IFACE(name, ...):**
### EXAMPLE ###
#### optimized memory management ####
#### create a new class ####
#### create a new interface ####
#### implement an interface in a class ####
#### class extension ####
TESTING
-------
This comes with the start of a unit test suite.
You can use *make test* to build and run the existent tests.
### REQUIREMENTS
Currently, you need valgrind to build the tests, because some memory checking
is done by the way.
CONTRIBUTION
------------
I would really like to see some people possibly interested in this stuff.
I think it contains some really interesting ideas.
If you like to contribute anyway, make a fork, do your changes and generate
a pull request. Or simply contact me on georg@steffers.org.

0
TODO

7
bootstrap

@ -0,0 +1,7 @@
#!/bin/sh
aclocal
libtoolize --copy
autoheader
automake --gnu --add-missing --copy
autoconf

64
configure.ac

@ -0,0 +1,64 @@
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
AC_PREREQ([2.68])
AC_INIT([libtrbase],
[1.0.1],
[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([1.0.1])
AC_CONFIG_SRCDIR([src/interface.c])
AC_CONFIG_HEADERS([config.h])
AC_CONFIG_MACRO_DIR([m4])
m4_include([m4/gcov.m4])
AC_TDD_GCOV
m4_include([m4/memopt.m4])
AC_MEM_OPT
# 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
include/Makefile])
AC_OUTPUT

1584
docs/Doxyfile.in
File diff suppressed because it is too large
View File

13
docs/Makefile.am

@ -0,0 +1,13 @@
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

11
include/Makefile.am

@ -0,0 +1,11 @@
nobase_include_HEADERS = trbase.h \
tr/class.h \
tr/commons.h \
tr/interface.h \
tr/memory.h \
tr/interface/class.h \
tr/interface/indexable.h \
tr/interface/observer.h \
tr/interface/serializable.h \
tr/interface/subject.h

285
include/tr/class.h

@ -0,0 +1,285 @@
/**
* \file
* My own class implementation for C. It combines a data structure with
* a set of interfaces. Each interface is another structure containing
* one or more function pointers to concrete implementations of this
* interface for the defined class.
*
* To each interface a set of caller functions exist, that take an instance
* of an object and then in turn call the implementation for the class of
* this object. If there is none within the class it looks into its
* parent class and so forth.
*
* This is somewhat similar to late binding in real OOP languages, but
* by far not so elaborated. This is not a real object oriented language
* and will surely never ever provide all features these have.
*
* That said it has proven very usefull for me to orgnize code and prevent
* code duplication.
*
* \author Georg Hopp
*
* \copyright
* Copyright © 2012-2013 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_CLASS_CLASS_H__
#define __TR_CLASS_CLASS_H__
#include <stdarg.h>
#include <sys/types.h>
#include <string.h>
#include <assert.h>
#include "tr/interface.h"
/** \cond PRIVATE */
#ifndef _ISOC99_SOURCE
#define _ISOC99_SOURCE
#endif
/** \endcond */
/**
* A magic number that identifies instances of a TR_CLASS class.
*/
#define TR_CLASS_MAGIC 0xFEFE
/**
* Class declaration macro. This one declares all structures
* that are needed to create a new class.
*/
#define TR_CLASS(name) \
struct c_##name; \
typedef struct c_##name * name; \
extern struct TR_class * const _##name; \
struct c_##name
/**
* Make the new class a child of an existing class.
* This is used within the class declaration and can
* only be used once. If you do it twice the behaviour
* is undefined, but most likely the resulting code won't
* even compile.
*/
#define TR_EXTENDS(parent) \
const char _[sizeof(struct c_##parent)]
/**
* Some macros might translate a give NULL to _NULL,
* this should in turn be a real NULL again.
*/
#define _NULL NULL
/**
* This will create a new class which previously has
* to be defined by TR_CLASS.
* This makro will create static variables and functions
* used to manage and controll the new class (and its
* instances.)
* Especially it creates and initializes tha class
* structure for this class. This structure contains all
* the meta informations of the new class. These are
* it's members as well as its interface implementations.
* Each class must at least provide an implementation
* for the ctor interface else no instances can be
* created.
*/
#define TR_CREATE_CLASS(name,_parent,...) \
static struct TR_class c_##name; \
static TR_class_ptr _classInit##name##_(void) { \
c_##name.parent = _##_parent; \
c_##name.init = NULL; \
return &c_##name; \
}; \
static struct TR_class c_##name = { \
TR_CLASS_MAGIC, \
NULL, \
sizeof(struct c_##name), \
_classInit##name##_, \
TR_INIT_IFACE_IMPL(__VA_ARGS__) \
}; \
struct TR_class * const _##name = &c_##name; \
struct c_##name##_object { \
void * TR_class; \
struct c_##name data; \
}
/**
* NEW. Create a static instance of a class.
* This is new and currently it is only possible to create
* instances for class that does not need a constructor.
*
* \todo
* This macro requires to close the initializer
* with an extra curly brancket. This is not nice...find a
* way to prevent this.
* \todo
* This does not call any constructor with any value...this
* has to be fixed.
*/
#define TR_INSTANCE(class, name) \
struct c_##class##_object _##name; \
class name = &(_##name.data); \
struct c_##class##_object _##name = { \
&c_##class,
/**
* I initialize _ (the class's base or parent class)
* with the identifier of that class.
* This identifier is not static and thus can't be used
* for a static initialization. As a workaround, until I
* find a better solution I create an initialization function
* with each class, that will be called once as soon as
* an interface implementation will be called. In any case
* this is a call to the constructor of this class.
* Well, not in any...if I remember correct the static
* instance does not call anything at all...
*
* \cond PRIVATE
*/
#define TR_INIT_CLASS(class) \
((class)->init? (class)->init() : (class))
/** \endcond */
/**
* Returns the pointer to the class structure of the given object.
* The class structure is the structure that contains all the
* metainformations about our class.
*
* \see TR_CREATE_CLASS
*/
#define TR_GET_CLASS(object) \
(TR_INIT_CLASS(*(TR_class_ptr *)((void*)(object) - sizeof(void*))))
/**
* Returns this class's implementations of the interface
* identified by iface.
*/
#define TR_IFACE_GET(class,iface) \
(TR_interfaceGet(&((class)->impl),(iface)))
/**
* Check if the given class is a child of any base class.
* That is it has an TR_EXTENDS expression whithin its declaration.
*
* \see TR_EXTENDS
*/
#define TR_HAS_PARENT(class) \
(NULL != ((class)->parent) && TR_INIT_CLASS((class)->parent))
/**
* Check if obj really points to a class instance.
*
* /see TR_CLASS_MAGIC
*/
#define TR_IS_OBJECT(obj) \
((TR_GET_CLASS((obj)))->magic == TR_CLASS_MAGIC)
/**
* Check of obj points to an instance of class.
*/
#define TR_INSTANCE_OF(class,obj) \
((TR_GET_CLASS((obj))) == _##class)
/**
* Call the class's implementation for the given method of the
* given interface _iface.
* For this the makro searches through all interfaces defined within
* a class for the correct one...from a performance aspect this might
* not be ideal but on the other hand...we don't expect more than a
* hand full of interfaces per class.
*
* \cond PRIVATE
*/
#define _TR_CALL(_class,_iface,method,...) \
do { \
TR_class_ptr class = _class; \
iface = (struct i_##_iface *)TR_IFACE_GET(class, &i_##_iface); \
while ((NULL == iface || \
NULL == iface->method) && TR_HAS_PARENT(class)) { \
class = class->parent; \
iface = (struct i_##_iface *)TR_IFACE_GET(class, &i_##_iface); \
} \
assert(NULL != iface->method); \
} while(0)
/** \endcond */
/**
* Call the class's implementation for the given method of the
* given interface _iface. This one does not handle a return
* value of the called implementation and as such is only suitable
* if there is no return value or you are not interested in it.
*
* \todo actually i use gcc feature ## for variadoc... think about
* a way to make this standard.
*/
#define TR_CALL(object,_iface,method,...) \
do { \
struct i_##_iface * iface; \
_TR_CALL(TR_GET_CLASS(object), _iface, method, ##__VA_ARGS__); \
iface->method(object, ##__VA_ARGS__); \
} while(0)
/**
* Call the class's implementation for the given method of the
* given interface _iface. The return value of the function is assigned
* to ret.
*
* \see TR_CALL
*/
#define TR_RETCALL(object,_iface,method,ret,...) \
do { \
struct i_##_iface * iface; \
_TR_CALL(TR_GET_CLASS(object), _iface, method, ##__VA_ARGS__); \
ret = iface->method(object, ##__VA_ARGS__); \
} while(0)
/**
* Like call but this calls the implementation of the direct parent
* class of this object.
*
* \see TR_CALL
*/
#define TR_PARENTCALL(object,_iface,method,...) \
do { \
struct i_##_iface * iface; \
TR_class_ptr pc_class = TR_GET_CLASS((object)); \
assert(TR_HAS_PARENT(pc_class)); \
_TR_CALL(pc_class->parent, _iface, method, ##__VA_ARGS__); \
iface->method(object, ##__VA_ARGS__); \
} while(0)
/**
* Definition of the metadata structures and symbols used to
* manage classe.
*
* \cond PRIVATE
*/
struct TR_class;
typedef struct TR_class * TR_class_ptr;
typedef TR_class_ptr (* TR_fptr_classInit)(void);
struct TR_class {
const int magic;
TR_class_ptr parent;
size_t object_size;
TR_fptr_classInit init;
struct TR_iface_impl impl;
};
/** \endcond */
#endif // __TR_CLASS_CLASS_H__
// vim: set ts=4 sw=4:

73
include/tr/commons.h

@ -0,0 +1,73 @@
/**
* \file
* Common reusable definitions.
*
* \todo All public symbols need to be prefixed to make name clashes
* more unlikely.
*
* \author Georg Hopp
*
* \copyright
* Copyright © 2012-2013 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_COMMONS_H__
#define __TR_COMMONS_H__
#define Bool char
#ifdef TRUE
# undef TRUE
#endif
#ifdef FALSE
# undef FALSE
#endif
#define TRUE 1
#define FALSE 0
#ifndef MAX
# define MAX(a,b) ((a)>(b)? (a) : (b))
#endif
#ifndef MIN
# define MIN(a,b) ((a)<(b)? (a) : (b))
#endif
/**
* XOR variant of swapping a variable
*/
#define SWAP_XOR(a, b) ((a)^=(b),(b)^=(a),(a)^=(b))
/**
* swap two variable through an intermediate.
*/
#define SWAP(type, a, b) do { \
type tmp = (a); \
(a) = (b); \
(b) = tmp; \
} while(0);
/**
* Const STRing Argument
* This makro evaluates to two function argument.
*
* \param char* val A NULL terminated static string.
*/
#define CSTRA(val) val, sizeof(val)-1 //!< Const STRing Argument
#endif // __TR_COMMONS_H__
// vim: set ts=4 sw=4:

137
include/tr/interface.h

@ -0,0 +1,137 @@
/**
* \file
* Interface definition code. Each interface is a set of selector functions
* as well as a data structure where the concrete implementation will be stored.
* This structure is the intergrated in the class that implements the
* interface.
*
* \author Georg Hopp
*
* \copyright
* Copyright © 2012-2013 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_H__
#define __TR_INTERFACE_H__
#include <sys/types.h>
/**
* The maximum number of interfaces per class.
*
* \cond PRIVATE
*/
#define TR_MAX_IFACE 32 // ATTENTION: every iface_impl will use
// MAX_IFACE * sizeof(void*)
/** \endcond */
/**
* Get interface implementation in the current compile context
* by it's interface name.
* TR_CREATE_CLASS accepts a list of interface implementations for
* initialization of the class. This makes it easier to add these.
*
* \see TR_CREATE_CLASS
*/
#define TR_IF(name) ((const struct i_##name const*)&i_##name##_impl)
/**
* Create an implementation of the interface "name" with the functions
* given in the variable argument list. This in turn can then be used
* within class initializations.
*
* \see TR_IF
*/
#define TR_INIT_IFACE(name,...) \
static const struct i_##name i_##name##_impl = {&i_##name,__VA_ARGS__}
#define TR_IFID const struct TR_interface * const _
#define TR_INTERFACE(name) \
extern const struct TR_interface i_##name; \
struct i_##name
/**
* Initialize the TR_interface structure for a new interface
*/
#define TR_CREATE_INTERFACE(name, nfunc) \
const struct TR_interface i_##name = { nfunc }
/**
* calculate the number of argument given to a macro during compile
* time. Helper for TR_INIT_IFACE_IMPL.
*
* \see TR_INIT_IFACE_IMPL
*
* \cond PRIVATE
*/
#define TR_IFACE_NUMARGS(...) \
(sizeof((const void*[]){__VA_ARGS__})/sizeof(void*))
/**
* Create a static struct TR_ifac_imp for the initializarion of a new
* created class. This is only internally used in TR_CREATE_CLASS.
*
* \see TR_CREATE_CLASS
*/
#define TR_INIT_IFACE_IMPL(...) \
{TR_IFACE_NUMARGS(__VA_ARGS__), 0, {__VA_ARGS__}}
/**
* The interface implementations for a class.
* This will be initialized statically during class creation.
*
* \see TR_INIT_IFACE_IMPL
*/
struct TR_iface_impl {
/** the number of interface implementations */
const size_t nimpl;
/**
* This indicates if impls was sorted. The first time it
* will be accessed via TR_interfaceGet, This array will
* be sorted with quicksort to make subsequent interface
* searches faster. After it was sorted this flag will be set
* to true,
*
* \see TR_interfaceGet
*/
char simpl;
/** Array to hold the used interface implementations. */
const void * impl[TR_MAX_IFACE];
};
typedef struct TR_iface_impl * TR_iface_impl_ptr;
/**
* Interface identifier structure. Each interface has to initialize one
* of these. All implementations of the interface then contain this
* pointer so that they can easily be identified.
*/
struct TR_interface {
const size_t nmethods;
};
typedef const struct TR_interface * TR_iface_ptr;
/**
* Get the interface implementation for the interface identified by
* TR_iface_ptr.
*/
TR_iface_ptr TR_interfaceGet(TR_iface_impl_ptr, const TR_iface_ptr);
/** endcond */
#endif // __TR_INTERFACE_H__
// vim: set ts=4 sw=4:

121
include/tr/interface/class.h

@ -0,0 +1,121 @@
/**
* \file
* Interface for class handling. Defines new, delete and clone selectors
* which in turn use the ctor, dtor and clone implementation from the
* class implementation.
*
* \author Georg Hopp
*
* \copyright
* Copyright © 2012-2013 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_CLASS_INTERFACE_CLASS_H__
#define __TR_CLASS_INTERFACE_CLASS_H__
#include <stdarg.h>
#include "tr/class.h"
#include "tr/interface.h"
typedef int (* fptr_ctor)(void *, va_list *);
typedef void (* fptr_dtor)(void *);
typedef void (* fptr_clone)(void *, void * const);
/**
* The interface structure for the class interface.
* Each class that implements this interface (and that
* should be all classes) need to provide at least
* a funtion pointer for the fptr_ctor. Else no
* instances can be created.
*/
TR_INTERFACE(TR_Class) {
TR_IFID;
fptr_ctor ctor;
fptr_dtor dtor;
fptr_clone clone;
};
/**
* Interface caller function for i_class::ctor.
* This one will never be called direcly but only through
* TR_new.
*
* \see TR_classNewv
* \see TR_new
*
* \cond PRIVATE
*/
void * TR_classNew(TR_class_ptr, ...);
/**
* This is another caller function for i_class:ctor but
* this uses a va_list for the argument to the constructor
* instead of an ellipse.
* Again this will only be called through TR_newv.
*
* \see TR_newv
*/
void * TR_classNewv(TR_class_ptr, va_list *);
/**
* Interface caller function for i_class::dtor.
* Never called directly.
*
* \see TR_delete
*/
void TR_classDelete(void **);
/**
* Interface caller function for i_class::clone
* Never called directly.
*
* \see TR_delete
*/
void * TR_classClone(void *);
/** \endcond */
/**
* Create an instance of a class by calling its constructor
* implementation after initialization and memory allocation
* of the class itself.
*/
#define TR_new(class,...) TR_classNew(_##class, ##__VA_ARGS__)
/**
* Create an instance of a class by calling its constructor
* implementation but this time with a va_list instead of a
* variable amount of arguments.
*/
#define TR_newv(class,args) TR_classNewParams(_##class, args)
/**
* Destroy an instance by first calling its destructor and then
* free all other memory.
*/
#define TR_delete(object) TR_classDelete((void **)&(object))
/**
* Create a clone of an instance by calling its clone implementation.
* A simple memcopy is often not enough because the cloned instance
* might have to allocate ist own resources or reuse resources in
* a given way.
*/
#define TR_clone(object) TR_classClone((void *)(object))
#endif // __TR_CLASS_INTERFACE_CLASS_H__
// vim: set ts=4 sw=4:

56
include/tr/interface/indexable.h

@ -0,0 +1,56 @@
/**
* \file
* This interface provides only one function at all.
* indexUuid will generate a uuid to the current object.
*
* This one is not generic enough for an interface...I
* don't want to rely on Uuid here....The Uuid stuff is more
* an implementation of this interface.
*
* An implementation of indexable::index should always return
* an instance of class Index / or an class that implements
* the index interface. Uuid would then be a candidate for such
* a class.
*
* \todo
* Maybe merge hashable and indexable. Thus we might get an
* easy way to exchange the hashing mechanism used for my
* associative arrays.
*
* \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_INDEXABLE_H__
#define __TR_INTERFACE_INDEXABLE_H__
#include "tr/interface.h"
typedef void * (* fptr_TR_getIndex)(void *);
TR_INTERFACE(TR_Indexable) {
TR_IFID;
fptr_TR_getIndex index;
};
void * TR_getIndex(void *);
#endif // __TR_INTERFACE_INDEXABLE_H__
// vim: set ts=4 sw=4:

47
include/tr/interface/observer.h

@ -0,0 +1,47 @@
/**
* \file
* Definition of the observer pattern implementation.
*
* \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_OBSERVER_H__
#define __TR_INTERFACE_OBSERVER_H__
#include "tr/interface.h"
typedef void (* fptr_TR_observerUpdate)(void *, void*);
/**
* Interface structur for the observer pattern
*/
TR_INTERFACE(TR_Observer) {
TR_IFID;
fptr_TR_observerUpdate update;
};
/**
* This will be called on each registered observer if the subject
* needs to notify them.
*/
void TR_observerUpdate(void *, void *);
#endif // __TR_INTERFACE_OBSERVER_H__
// vim: set ts=4 sw=4:

50
include/tr/interface/serializable.h

@ -0,0 +1,50 @@
/**
* \file
* Classes that implement this interface can be converted to an
* array of bytes and created from an array of bytes if it has
* the correct format. The format of th byte array is class
* specific.
*
* \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 __SERIALIZABLE_H__
#define __SERIALIZABLE_H__
#include "tr/interface.h"
typedef size_t (* fptr_serializeSize)(void *);
typedef void (* fptr_serialize)(void *, unsigned char *);
typedef void (* fptr_unserialize)(void *, const unsigned char *, size_t);
TR_INTERFACE(TR_Serializable) {
TR_IFID;
fptr_serializeSize serializeSize;
fptr_serialize serialize;
fptr_unserialize unserialize;
};
size_t TR_serializeSize(void *);
void TR_serialize(void *, unsigned char *);
void TR_unserialize(void *, const unsigned char *, size_t);
#endif // __SERIALIZABLE_H__
// vim: set ts=4 sw=4:

46
include/tr/interface/subject.h

@ -0,0 +1,46 @@
/**
* \file
* Definition of the subject pattern implementation.
*
* \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 __SUBJECT_H__
#define __SUBJECT_H__
#include "tr/interface.h"
typedef void (* fptr_subjectAttach)(void *, void *);
typedef void (* fptr_subjectDetach)(void *, void *);
typedef void (* fptr_subjectNotify)(void *);
TR_INTERFACE(TR_Subject) {
TR_IFID;
fptr_subjectAttach attach;
fptr_subjectDetach detach;
fptr_subjectNotify notify;
};
void TR_subjectAttach(void *, void *);
void TR_subjectDetach(void *, void *);
void TR_subjectNotify(void *);
#endif // __SUBJECT_H__
// vim: set ts=4 sw=4:

39
include/tr/memory.h

@ -0,0 +1,39 @@
/**
* \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_MEMORY_H__
#define __TR_MEMORY_H__
#define TR_MEM_FREE(seg) (TR_free((void **)&(seg)))
#include <sys/types.h>
void * TR_malloc(size_t);
void * TR_calloc(size_t, size_t);
void * TR_reference(void *);
void TR_free(void **);
size_t TR_getSize(void *);
void TR_cleanup();
#endif // __TR_MEMORY_H__
// vim: set ts=4 sw=4:

16
include/trbase.h

@ -0,0 +1,16 @@
#ifndef __TR_BASE_H__
#define __TR_BASE_H__
#include "tr/commons.h"
#include "tr/memory.h"
#include "tr/class.h"
#include "tr/interface.h"
#include "tr/interface/class.h"
#include "tr/interface/subject.h"
#include "tr/interface/observer.h"
#include "tr/interface/serializable.h"
#include "tr/interface/indexable.h"
#endif // __TR_BASE_H__
// vim: set ts=4 sw=4:

80
m4/gcov.m4

@ -0,0 +1,80 @@
# Checks for existence of coverage tools:
# * gcov
# * lcov
# * genhtml
# * gcovr
#
# Sets ac_cv_check_gcov to yes if tooling is present
# and reports the executables to the variables LCOV, GCOVR and GENHTML.
AC_DEFUN([AC_TDD_GCOV],
[
AC_ARG_ENABLE(gcov,
AS_HELP_STRING([--enable-gcov],
[enable coverage testing with gcov]),
[use_gcov=$enableval], [use_gcov=no])
AM_CONDITIONAL(HAVE_GCOV, test "x$use_gcov" = "xyes")
if test "x$use_gcov" = "xyes"; then
# we need gcc:
if test "$GCC" != "yes"; then
AC_MSG_ERROR([GCC is required for --enable-gcov])
fi
# Check if ccache is being used
AC_CHECK_PROG(SHTOOL, shtool, shtool)
case `$SHTOOL path $CC` in
*ccache*[)] gcc_ccache=yes;;
*[)] gcc_ccache=no;;
esac
if test "$gcc_ccache" = "yes" && (test -z "$CCACHE_DISABLE" || test "$CCACHE_DISABLE" != "1"); then
AC_MSG_ERROR([ccache must be disabled when --enable-gcov option is used. You can disable ccache by setting environment variable CCACHE_DISABLE=1.])
fi
lcov_version_list="1.6 1.7 1.8 1.9 1.10"
AC_CHECK_PROG(LCOV, lcov, lcov)
AC_CHECK_PROG(GENHTML, genhtml, genhtml)
if test "$LCOV"; then
AC_CACHE_CHECK([for lcov version], glib_cv_lcov_version, [
glib_cv_lcov_version=invalid
lcov_version=`$LCOV -v 2>/dev/null | $SED -e 's/^.* //'`
for lcov_check_version in $lcov_version_list; do
if test "$lcov_version" = "$lcov_check_version"; then
glib_cv_lcov_version="$lcov_check_version (ok)"
fi
done
])
else
lcov_msg="To enable code coverage reporting you must have one of the following lcov versions installed: $lcov_version_list"
AC_MSG_ERROR([$lcov_msg])
fi
case $glib_cv_lcov_version in
""|invalid[)]
lcov_msg="You must have one of the following versions of lcov: $lcov_version_list (found: $lcov_version)."
AC_MSG_ERROR([$lcov_msg])
LCOV="exit 0;"
;;
esac
if test -z "$GENHTML"; then
AC_MSG_ERROR([Could not find genhtml from the lcov package])
fi
# Remove all optimization flags from CFLAGS
changequote({,})
CFLAGS=`echo "$CFLAGS" | $SED -e 's/-O[0-9]*//g'`
changequote([,])
# Add the special gcc flags
COVERAGE_CFLAGS="-O0 -fprofile-arcs -ftest-coverage"
COVERAGE_CXXFLAGS="-O0 -fprofile-arcs -ftest-coverage"
COVERAGE_LDFLAGS="-lgcov"
AC_SUBST(COVERAGE_CFLAGS)
AC_SUBST(COVERAGE_CXXFLAGS)
AC_SUBST(COVERAGE_LDFLAGS)
fi
]) # AC_TDD_GCOV

14
m4/memopt.m4

@ -0,0 +1,14 @@
AC_DEFUN([AC_MEM_OPT],
[
AC_ARG_ENABLE(mem_opt,
AC_HELP_STRING([--disable-mem-opt],
[disable best bit tree based memory optimizations]))
AS_IF([test "x$enable_mem_opt" != "xno"], [
AC_MSG_NOTICE("Using best fit tree based memory optimizations")
MEM_OPT_FLAGS="-DMEM_OPT"
AC_SUBST(MEM_OPT_FLAGS)
])
])
# vim: set ft=m4 ts=2 sw=2:

19
src/Makefile.am

@ -0,0 +1,19 @@
ACLOCAL_AMFLAGS = -I m4
AUTOMAKE_OPTIONS = subdir-objects
AM_CFLAGS += -I../include/
TR_CLASS = memory.c \
interface.c \
i_class.c \
i_subject.c \
i_observer.c \
i_indexable \
i_serializable
lib_LTLIBRARIES = libtrbase.la
libtrbase_la_SOURCES = $(TR_CLASS)
libtrbase_la_CFLAGS = $(AM_CFLAGS)
libtrbase_la_LIBADD =
libtrbase_la_LDFLAGS = -version-info 1:0:1

125
src/i_class.c

@ -0,0 +1,125 @@
/**
* \file
* The selector implementations for the class 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/>.
*/
#include <stdarg.h>
#include <stdlib.h>
#include <assert.h>
#include "tr/class.h"
#include "tr/interface/class.h"
#include "tr/memory.h"
/**
* Create and initialize the structures for a new interface called
* class.
* Interfaces and Classes may have the same name because internally
* everything that has to do with interfaces is prefixed with an i_
*/
TR_CREATE_INTERFACE(TR_Class, 3);
/*
* SELECTOR DEFINITION
* ===================
*/
/**
* Selector for the ctor implementation. This one accepts a va_list.
*
* \cond PRIVATE
*/
void *
TR_classNewv(TR_class_ptr class, va_list * params)
{
void * object = TR_calloc(1, class->object_size + sizeof(void*));
int ret;
* (TR_class_ptr *)object = class;
object += sizeof(void*);
TR_RETCALL(object, TR_Class, ctor, ret, params);
if (-1 == ret) {
TR_classDelete(&object);
}
return object;
}
/**
* Selector for the ctor implementation. This one accepts a variable
* amount of arguments.
*/
void *
TR_classNew(TR_class_ptr class, ...)
{
va_list params;
void * object;
va_start(params, class);
object = TR_classNewv(class, &params);
va_end(params);
return object;
}
/**
* Selector for the dtor implementation. This one accepts a variable
* amount of arguments.
*/
void
TR_classDelete(void ** object)
{
if (NULL != *object) {
void * mem;
TR_CALL(*object, TR_Class, dtor);
mem = *object - sizeof(void*);
TR_MEM_FREE(mem);
*object = NULL;
}
}
/**
* Selector for the clone implementation. This one accepts a variable
* amount of arguments.
*/
void *
TR_classClone(void * _object)
{
TR_class_ptr class = TR_GET_CLASS(_object);
void * object = TR_calloc(1, class->object_size + sizeof(void*));
* (TR_class_ptr *)object = class;
object += sizeof(void*);
#undef clone
TR_CALL(object, TR_Class, clone, _object);
return object;
}
/** endcond */
// vim: set ts=4 sw=4:

45
src/i_indexable.c

@ -0,0 +1,45 @@
/**
* \file
* Get the index from an indexable object.
*
* \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/class.h"
#include "tr/interface/indexable.h"
/**
* create the inadexable interface.
*/
TR_CREATE_INTERFACE(TR_Indexable, 1);
/**
* Get it's index from an indexable object.
*/
void *
TR_getIndex(void * indexable)
{
void * ret;
TR_RETCALL(indexable, TR_Indexable, uuid, ret, namespace);
return ret;
}
// vim: set ts=4 sw=4:

42
src/i_observer.c

@ -0,0 +1,42 @@
/**
* \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/class.h"
#include "tr/interface/observer.h"
/**
* Create the oberver interface.
*/
TR_CREATE_INTERFACE(TR_Observer, 1);
/**
* The implementation of update will be called by a
* subject whenever it ments to inform the observer about
* something
*/
void
TR_observerUpdate(void * observer, void * subject)
{
TR_CALL(observer, TR_Observer, update, subject);
}
// vim: set ts=4 sw=4:

66
src/i_serializable.c

@ -0,0 +1,66 @@
/**
* \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/class.h"
#include "tr/interface/serializable.h"
/**
* Create the serializable interface.
*/
TR_CREATE_INTERFACE(TR_Serializable, 2);
/**
* Serialize the given instance to a byte array
*/
void
TR_serialize(
void * serializable,
unsigned char ** serialized,
size_t * nserialized)
{
TR_CALL(
serializable,
TR_Serializable,
serialize,
serialized,
nserialized);
}
/**
* Unerialize the given instance to a byte array
*/
void
TR_unserialize(
void * serializable,
const unsigned char * serialized,
size_t nserialized)
{
TR_CALL(
serializable,
TR_Serializable,
unserialize,
serialized,
nserialized);
}
// vim: set ts=4 sw=4:

61
src/i_subject.c

@ -0,0 +1,61 @@
/**
* \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/class.h"
#include "tr/interface/subject.h"
/**
* Create the TR_Subject interface
*/
TR_CREATE_INTERFACE(TR_Subject, 3);
/**
* Attach an observer to a subject. After a successfull
* call to this the subject will inform the observer about events.
*/
void
TR_subjectAttach(void * subject, void * observer)
{
TR_CALL(subject, TR_Subject, attach, observer);
}
/**
* Detach an Observer from a Subject. After this no events
* will be propagated from the subject to the observer anymore.
*/
void
TR_subjectDetach(void * subject, void * observer)
{
TR_CALL(subject, TR_Subject, detach, observer);
}
/**
* Trigger the a notification of all attached observers.
*/
void
TR_subjectNotify(void * subject)
{
TR_CALL(subject, TR_Subject, notify);
}
// vim: set ts=4 sw=4:

72
src/interface.c

@ -0,0 +1,72 @@
/**
* \file
* Get an interface implementation from a implementation structure.
*
* \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 <stdlib.h>
#include "tr/interface.h"
#include "tr/commons.h"
/**
* Compare interfaces.
* Used with bsearch on the interfaces.
*/
static
inline
int
comp(const void * _a, const void * _b)
{
const struct interface * a = **(const struct interface ***)_a;
const struct interface * b = **(const struct interface ***)_b;
return ((a)<(b))? -1 : ((a)>(b))? 1 : 0;
}
/**
* Get a specific interface implementation from the interface
* implementation from a class.
*/
TR_iface_ptr
TR_interfaceGet(TR_iface_impl_ptr iface_impl, const TR_iface_ptr _iface)
{
const TR_iface_ptr * iface = &_iface;
TR_iface_ptr * found;
if (! iface_impl->simpl) {
qsort(
(void**)(iface_impl->impl),
iface_impl->nimpl,
sizeof(TR_iface_ptr), comp);
iface_impl->simpl=TRUE;
}
found = bsearch(
&iface,
iface_impl->impl,
iface_impl->nimpl,
sizeof(TR_iface_ptr),
comp);
return found? *found : (TR_iface_ptr)NULL;
}
// vim: set ts=4 sw=4:

885
src/memory.c

@ -0,0 +1,885 @@
/**
* \file This holds all stufff related our memory managent.
* I try the best as far as I can to reduce memory fragmentation
* and unneccessary calls to alloc and free.
*
* To achive this I try an approach described here as "Quick Fit".
* http://www.flounder.com/memory_allocation.htm
*
* The basic idea is to keep allocated memory segments and don't free
* them again. Instead I will put them in a tree indexed by their size.
* To get new memory I first have a look in the tree if there is
* a fitting memory segment. Fitting mean, larger or exactly the size
* I need. If there is one, use it. If not create a new one using
* usual malloc approach.
* I won't split the reagions at all because most likely they will be
* free soon again. This way I might waste some memory, so I have to
* keep an eye on this.
*
* Right now I don't build an upper limit for allocation. The limit
* still is the system memory itself.
*
* This is not implemented as a class because it will be used in the
* process of object creation.
*
* The data structure is a balanced tree with size as key.
* Under the size key is a list of elements of the same size.
*
* \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 <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <search.h>
#include <unistd.h>
#include "tr/memory.h"
enum rbColor {rbBlack=1, rbRed=2};
struct memSegment
{
size_t ref_count;
size_t size;
void * ptr;
enum rbColor color;
struct memSegment * next;
struct memSegment * last;
struct memSegment * parent;
struct memSegment * left;
struct memSegment * right;
};
static
struct memSegment *
newElement(size_t size)
{
struct memSegment * element = malloc(size);
element->ref_count = 1;
element->size = size;
element->ptr = (void*)element + sizeof(struct memSegment);
element->next = NULL;
element->last = NULL;
element->color = rbRed;
element->parent = NULL;
element->left = NULL;
element->right = NULL;
return element;
}
/**
* find element in tree
*/
static
struct memSegment *
findElement(struct memSegment * tree, size_t size)
{
struct memSegment * fitting = NULL;
while (NULL != tree) {
if (tree->size == size) {
fitting = tree;
break;
}
if (size > tree->size) {
tree = tree->right;
} else {
fitting = tree;
tree = tree->left;
}
}
return fitting;
}
/*
* function to get specific elements needed for
* rb handling, grandparent, uncle and sibbling
*/
static
struct memSegment *
grandparent(struct memSegment * node)
{
if (NULL != node && NULL != node->parent) {
return node->parent->parent;
}
return NULL;
}
static
struct memSegment *
uncle(struct memSegment * node)
{
struct memSegment * gp = grandparent(node);
if (NULL == gp) {
return NULL;
}
if (node->parent == gp->left) {
return gp->right;
}
return gp->left;
}
static
struct memSegment *
sibling(struct memSegment * node)
{
if (NULL == node) {
return NULL;
}
if (NULL == node->parent->left || node == node->parent->left) {
return node->parent->right;
} else {
return node->parent->left;
}
}
/*
* tree modifications...needed for rb handling.
*/
static
void
rotateLeft(struct memSegment ** tree, struct memSegment * node)
{
struct memSegment * rightChild = node->right;
struct memSegment * rcLeftSub = node->right->left;
rightChild->left = node;
rightChild->parent = node->parent;
node->right = rcLeftSub;
if (NULL != rcLeftSub) {
rcLeftSub->parent = node;
}
if (node->parent) {
if (node->parent->left == node) {
node->parent->left = rightChild;
} else {
node->parent->right = rightChild;
}
} else {
*tree = rightChild;
}
node->parent = rightChild;
}
static
void
rotateRight(struct memSegment ** tree, struct memSegment * node)
{
struct memSegment * leftChild = node->left;
struct memSegment * lcRightSub = node->left->right;
leftChild->right = node;
leftChild->parent = node->parent;
node->left = lcRightSub;
if (NULL != lcRightSub) {
lcRightSub->parent = node;
}
if (node->parent) {
if (node->parent->left == node) {
node->parent->left = leftChild;
} else {
node->parent->right = leftChild;
}
} else {
*tree = leftChild;
}
node->parent = leftChild;
}
static
void
replaceNode(
struct memSegment ** tree,
struct memSegment * node1,
struct memSegment * node2)
{
if (NULL != node1->parent) {
if (node1 == node1->parent->left) {
node1->parent->left = node2;
} else {
node1->parent->right = node2;
}
} else {
*tree = node2;
}
if (NULL != node2) {
node2->parent = node1->parent;
}
}
/**
* insert element in tree
*/
static
struct memSegment *
insertElement(struct memSegment ** tree, struct memSegment * element)
{
struct memSegment * node = *tree;
struct memSegment * new_node = NULL;
struct memSegment * u;
struct memSegment * g;
element->next = NULL;
element->last = NULL;
element->color = rbRed;
element->parent = NULL;
element->left = NULL;
element->right = NULL;
// if tree is empty it's simple... :)
if (NULL == node) {
*tree = node = new_node = element;
} else {
// normal binary tree add....
while (NULL != node) {
if (element->size < node->size) {
if (NULL == node->left) {
node->left = element;
node->left->parent = node;
new_node = node = node->left;
break;
} else {
node = node->left;
}
} else if (element->size > node->size) {
if (NULL == node->right) {
node->right = element;
node->right->parent = node;
new_node = node = node->right;
break;
} else {
node = node->right;
}
} else {
if (NULL == node->next) {
node->next = element;
node->last = element;
} else {
node->last->next = element;
node->last = element;
}
return node;
}
}
}
if (NULL != new_node) {
/*
* handle reballancing rb style
*/
while (1) {
// case 1
if (node->parent == NULL) {
node->color = rbBlack;
// we're done.... :)
break;
}
// case 2
if (node->parent->color == rbBlack) {
// Tree is still valid ... wow, again we're done... :)
break;
}
// case 3
u = uncle(node);
g = grandparent(node);
if (u != NULL && u->color == rbRed) {
node->parent->color = rbBlack;
u->color = rbBlack;
g->color = rbRed;
node = g;
continue;
}
// case 4
if (node == node->parent->right && node->parent == g->left) {
rotateLeft(tree, node->parent);
node = node->left;
} else if (node == node->parent->left && node->parent == g->right) {
rotateRight(tree, node->parent);
node = node->right;
}
// case 5
g = grandparent(node);
node->parent->color = rbBlack;
g->color = rbRed;
if (node == node->parent->left) {
rotateRight(tree, g);
} else {
rotateLeft(tree, g);
}
// we're done..
break;
}
}
return new_node;
}
/**
* delete element from tree
* here multiple functions are involved....
* =======================================================================
*/
/**
* find minimum of the right subtree aka leftmost leaf of right subtree
* aka left in-order successor.
* We return the parent of the element in the out argument parent.
* This can be NULL wenn calling.
*
* 2: *successor = {size = 80, ptr = 0x603ae0, color = rbRed, parent = 0x603160,
* left = 0x0, right = 0x0}
* 1: *node = {size = 70, ptr = 0x603a60, color = rbBlack, parent = 0x603070,
* left = 0x6030e0, right = 0x6031e0}
*
*/
static
struct memSegment *
findInOrderSuccessor(struct memSegment * tree)
{
struct memSegment * node = tree->right;
while (NULL != node->left) {
node = node->left;
}
return node;
}
static
struct memSegment *
deleteElement(struct memSegment ** tree, struct memSegment * element)
{
struct memSegment * node = *tree;
struct memSegment * del_node;
struct memSegment * child;
struct memSegment * s;
// find the relevant node and it's parent
while (NULL != node) {
if (element->size < node->size) {
node = node->left;
} else if (element->size > node->size) {
node = node->right;
} else {
if (NULL != node->next) {
if (NULL != node->parent) {
if (node == node->parent->left) {
node->parent->left = node->next;
} else {
node->parent->right = node->next;
}
} else {
*tree = node->next;
}
if (NULL != node->left) {
node->left->parent = node->next;
}
if (NULL != node->right) {
node->right->parent = node->next;
}
node->next->last = node->last;
node->next->color = node->color;
node->next->parent = node->parent;
node->next->left = node->left;
node->next->right = node->right;
return node;
}
break;
}
}
// element not found
if (NULL == node) {
return node;
}
del_node = node;
// now our cases follows...the first one is the same as with
// simple binary search trees. Two non null children.
// case 1: two children
if (NULL != node->left && NULL != node->right) {
struct memSegment * successor = findInOrderSuccessor(node);
enum rbColor tmpcolor = successor->color;
struct memSegment * tmpparent = successor->parent;
struct memSegment * tmpleft = successor->left;
struct memSegment * tmpright = successor->right;
replaceNode(tree, node, successor);
successor->color = node->color;
successor->left = node->left;
successor->left->parent = successor;
// the right one might be successor...
if (node->right == successor) {
successor->right = node;
node->parent = successor;
} else {
successor->right = node->right;
node->right->parent = successor;
node->parent = tmpparent;
tmpparent->left = node;
}
node->color = tmpcolor;
node->left = tmpleft;
node->right = tmpright;
}
// Precondition: n has at most one non-null child.
child = (NULL == node->right) ? node->left : node->right;
replaceNode(tree, node, child);
// delete one child case
// TODO this is overly complex as simply derived from the function...
// maybe this can be simplified. Maybe not...check.
if (node->color == rbBlack) {
if (NULL != child && child->color == rbRed) {
child->color = rbBlack;
// done despite modifying tree itself if neccessary..
return del_node;
} else {
if (NULL != child) {
node = child;
} else {
node->color = rbBlack;
node->left = NULL;
node->right = NULL;
}
}
} else {
return del_node;
}
// delete and rb rebalance...
while(1) {
// case 1
if (NULL == node->parent) {
// done again
break;
}
// case 2
s = sibling(node);
if (NULL != s && s->color == rbRed) {
node->parent->color = rbRed;
s->color = rbBlack;
/*
* detect which child we are...assumption
* if we are not parent->right and parent->right is not
* null we must be left, even if its set to NULL previously
*/
if (NULL != node->parent->right && node != node->parent->right) {
rotateLeft(tree, node->parent);
} else {
rotateRight(tree, node->parent);
}
}
s = sibling(node);
// case 3 / 4
if (NULL == s || ((s->color == rbBlack) &&
(NULL == s->left || s->left->color == rbBlack) &&
(NULL == s->right || s->right->color == rbBlack))) {
if (NULL != s) {
s->color = rbRed;
}
if (node->parent->color == rbBlack) {
// case 3
node = node->parent;
continue;
} else {
// case 4
node->parent->color = rbBlack;
// and done again...
break;
}
}
// case 5
if (NULL != s && s->color == rbBlack) {
// this if statement is trivial,
// due to case 2 (even though case 2 changed the sibling to a
// sibling's child,
// the sibling's child can't be red, since no red parent can
// have a red child).
//
// the following statements just force the red to be on the
// left of the left of the parent,
// or right of the right, so case 6 will rotate correctly.
if ((node == node->parent->left) &&
(NULL == s->right || s->right->color == rbBlack) &&
(NULL != s->left && s->left->color == rbRed)) {
// this last test is trivial too due to cases 2-4.
s->color = rbRed;
s->left->color = rbBlack;
rotateRight(tree, s);
} else if ((node == node->parent->right) &&
(NULL == s->left || s->left->color == rbBlack) &&
(NULL != s->right && s->right->color == rbRed)) {
// this last test is trivial too due to cases 2-4.
s->color = rbRed;
s->right->color = rbBlack;
rotateLeft(tree, s);
}
}
s = sibling(node);
// case 6
if (NULL != s) {
s->color = node->parent->color;
}
if (NULL != node && NULL != node->parent) {
node->parent->color = rbBlack;
/*
* detect which child we are...assumption
* if we are not parent->right and parent->right is not
* null we must be left, even if its set to NULL previously
*/
if (NULL != node->parent->right && node != node->parent->right) {
if (NULL != s->right) {
s->right->color = rbBlack;
}
rotateLeft(tree, node->parent);
} else {
if (NULL != s->left) {
s->left->color = rbBlack;
}
rotateRight(tree, node->parent);
}
}
// done...
break;
}
return del_node;
}
//static
//void
//traverse(struct memSegment * tree, void (*cb)(struct memSegment *, int))
//{
// struct memSegment * previous = tree;
// struct memSegment * node = tree;
// 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 (node) {
// /*
// * If we come from the right so nothing and go to our
// * next parent.
// */
// if (previous == node->right) {
// previous = node;
// node = node->parent;
// depth--;
// continue;
// }
//
// if ((NULL == node->left || previous == node->left)) {
// /*
// * If there are no more elements to the left or we
// * came from the left, process data.
// */
// cb(node, depth);
// previous = node;
//
// if (NULL != node->right) {
// node = node->right;
// depth++;
// } else {
// node = node->parent;
// depth--;
// }
// } else {
// /*
// * if there are more elements to the left go there.
// */
// previous = node;
// node = node->left;
// depth++;
// }
// }
//}
static
void
post(struct memSegment * tree, void (*cb)(struct memSegment *, int))
{
struct memSegment * previous = tree;
struct memSegment * node = tree;
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 (node) {
/*
* If we come from the right so nothing and go to our
* next parent.
*/
if (((NULL == node->left || previous == node->left)
&& NULL == node->right)
|| previous == node->right) {
struct memSegment * parent = node->parent;
cb(node, depth);
previous = node;
node = parent;
depth--;
continue;
}
if ((NULL == node->left || previous == node->left)) {
/*
* If there are no more elements to the left or we
* came from the left, process data.
*/
previous = node;
if (NULL != node->right) {
node = node->right;
depth++;
} else {
node = node->parent;
depth--;
}
} else {
/*
* if there are more elements to the left go there.
*/
previous = node;
node = node->left;
depth++;
}
}
}
//void
//printElement(struct memSegment * node, int depth)
//{
// int i;
//
// printf("%s %010zu:%p(%02d)",
// (node->color==rbRed)?"R":"B",
// node->size,
// node->ptr,
// depth);
// for (i=0; i<depth; i++) printf("-");
// puts("");
//
// node = node->next;
// while (NULL != node) {
// printf(" %s %010zu:%p(%02d)",
// (node->color==rbRed)?"R":"B",
// node->size,
// node->ptr,
// depth);
// for (i=0; i<depth; i++) printf("-");
// puts("");
// node = node->next;
// }
//}
//void
//cleanup(struct memSegment * node, int depth)
//{
// while (NULL != node) {
// struct memSegment * next = node->next;
// free(node);
// node = next;
// }
//}
static
struct memSegment * segments = NULL;
static
void
segmentFree(struct memSegment * segment, int depth)
{
while (NULL != segment) {
struct memSegment * next = segment->next;
free(segment);
segment = next;
}
}
void *
TR_reference(void * mem)
{
struct memSegment * seg = (mem - sizeof(struct memSegment));
seg->ref_count++;
return mem;
}
/*
* This will always allocate a multiple of PAGESIZE
*/
void *
TR_malloc(size_t size)
{
struct memSegment * seg = NULL;
//long psize = sysconf(_SC_PAGESIZE);
long psize = 64;
size += sizeof(struct memSegment);
/* allocate only blocks of a multiple of pagesize, similar to cbuf */
size = (0>=size)?1:(0!=size%psize)?(size/psize)+1:size/psize;
size *= psize;
#ifdef MEM_OPT
seg = findElement(segments, size);
#endif
if (NULL == seg) {
seg = newElement(size);
} else {
// remove the found one from the tree as we use it now.
seg = deleteElement(&segments, seg);
}
return seg->ptr;
}
/**
* this is a really memory wasting solution....just to be able to
* use calloc, which might be faster then malloc/memset solution.
*
* Maybe this is a bad idea, as we need to memset the buffer anyway
* if it comes from our tree, which hopefully should be the majority
* of cases.
*/
void *
TR_calloc(size_t nmemb, size_t size)
{
size_t _size = nmemb * size;
void * mem = TR_malloc(_size);
memset(mem, 0, _size);
return mem;
}
void
TR_free(void ** mem)
{
if (NULL != *mem) {
struct memSegment * seg = (*mem - sizeof(struct memSegment));
if (1 < seg->ref_count) {
seg->ref_count--;
} else {
#ifdef MEM_OPT
insertElement(&segments, seg);
#else
free(seg);
#endif
}
*mem = NULL;
}
}
size_t
TR_getSize(void * mem)
{
struct memSegment * segment;
if (NULL == mem) {
return 0;
}
segment = (struct memSegment *)(mem - sizeof(struct memSegment));
return segment->size;
}
void
TR_cleanup()
{
#ifdef MEM_OPT
post(segments, segmentFree);
#endif
}
// vim: set ts=4 sw=4:

65
tests/Makefile.am

@ -0,0 +1,65 @@
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

121
tests/classTest.c

@ -0,0 +1,121 @@
/**
* \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:

72
tests/mock/mock_class.c

@ -0,0 +1,72 @@
/**
* \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:

49
tests/mock/mock_class.h

@ -0,0 +1,49 @@
/**
* \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:

121
tests/runtest.c

@ -0,0 +1,121 @@
/**
* \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:

136
tests/runtest.h

@ -0,0 +1,136 @@
/**
* \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:

45
tests/suppress/external.supp

@ -0,0 +1,45 @@
#
# 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
}
Loading…
Cancel
Save