pax_global_header 0000666 0000000 0000000 00000000064 14172606404 0014516 g ustar 00root root 0000000 0000000 52 comment=6a856ccc8dc151dddb6f1f9f11467875ea3d2206
ding-libs-0.6.2/ 0000775 0000000 0000000 00000000000 14172606404 0013373 5 ustar 00root root 0000000 0000000 ding-libs-0.6.2/.git-commit-template 0000664 0000000 0000000 00000000326 14172606404 0017257 0 ustar 00root root 0000000 0000000 COMPONENT: Subject
Explanation
Resolves:
https://pagure.io/SSSD/ding-libs/issue/XXXX
# Try to keep the subject line within 52 chars ----|
# Also please try to not exceed 72 characters of length for the body --|
ding-libs-0.6.2/.gitignore 0000664 0000000 0000000 00000001464 14172606404 0015370 0 ustar 00root root 0000000 0000000 *.[oa]
configure
config.log
config.status
config.rpath
config.h
config.h.in
cscope.out
doxy.config
Makefile
Makefile.in
Makefile.in.in
*.so
*.so.[0-9].[0-9].[0-9]
*.a
*.l[oa]
*.py[oc]
*.pydevproject
.deps
.libs
*.html
*.[0-9]
*.pc
autom4te.cache
libtool
stamp-h1
m4/*
!m4/ld-version-script.m4
aclocal.m4
depcomp
ltmain.sh
missing
.dirstamp
sssd.spec
*.gmo
*.header
*.sed
*.sin
Makevars.template
POTFILES
Rules-quot
stamp-po
ABOUT-NLS
build
*.patch
*.swp
*.X
tags
*~
.vscode/
contrib/ding-libs.spec
# Testing
*_ut*
*.out
foo.conf
test-suite.log
test.ini
bom2be
bom2le
bom3
bom4be
bom4le
dhash_example*
dhash_test*
merge.validator.*
test_real*
modtest.conf.*
real.conf.manual
test_rules.ini
# Doxyfiles
basicobjects/basicobjects.cfg.doxy
collection/collection.cfg.doxy
ini/ini_config.cfg.doxy
refarray/ref_array.cfg.doxy ding-libs-0.6.2/COPYING 0000664 0000000 0000000 00000104513 14172606404 0014432 0 ustar 00root root 0000000 0000000 GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
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.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 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 .
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:
Copyright (C)
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
.
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
.
ding-libs-0.6.2/COPYING.LESSER 0000664 0000000 0000000 00000016733 14172606404 0015434 0 ustar 00root root 0000000 0000000 GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
ding-libs-0.6.2/Makefile.am 0000664 0000000 0000000 00000033322 14172606404 0015432 0 ustar 00root root 0000000 0000000 TRACE_LEVEL=@TRACE_VAR@
RPMBUILD ?= $(PWD)/rpmbuild
#Some old versions of automake don't define builddir
builddir ?= .
# Workaround for gettext whinging
SUBDIRS =
dist_noinst_DATA = \
m4 \
COPYING \
COPYING.LESSER \
path_utils/libpath_utils.sym \
dhash/libdhash.sym \
collection/libcollection.sym \
refarray/libref_array.sym \
basicobjects/libbasicobjects.sym \
ini/libini_config.sym
##############################################################################
# Common
##############################################################################
AM_CFLAGS =
if HAVE_GCC
AM_CFLAGS += \
-Wall -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual \
-Wcast-align -Wwrite-strings -Wextra -Wno-unused-parameter \
-Wno-sign-compare -Wformat-security -Wmissing-prototypes -Wundef
endif
AM_CPPFLAGS = \
-I$(srcdir)/collection \
-I$(srcdir)/path_utils \
-I$(srcdir)/refarray \
-I$(srcdir)/dhash \
-I$(srcdir)/ini \
-I$(srcdir)/basicobjects \
-I$(srcdir) \
-I$(srcdir)/trace \
$(TRACE_LEVEL)
ACLOCAL_AMFLAGS = -I m4
DOXYGEN = @DOXYGEN@
pkgconfigdir = $(libdir)/pkgconfig
dist_pkgconfig_DATA =
dist_doc_DATA =
dist_examples_DATA =
dist_include_HEADERS =
lib_LTLIBRARIES =
check_PROGRAMS =
TESTS =
examplesdir = $(docdir)/examples
##############################################################################
# Path Utils
##############################################################################
lib_LTLIBRARIES += libpath_utils.la
dist_pkgconfig_DATA += path_utils/path_utils.pc
dist_include_HEADERS += path_utils/path_utils.h
libpath_utils_la_SOURCES = path_utils/path_utils.c
libpath_utils_la_DEPENDENCIES = path_utils/libpath_utils.sym
libpath_utils_la_LIBADD = $(LTLIBICONV) \
$(LTLIBINTL)
libpath_utils_la_LDFLAGS = \
-version-info 1:1:0
if HAVE_LD_VERSION_SCRIPT
libpath_utils_la_LDFLAGS += -Wl,--version-script=$(top_srcdir)/path_utils/libpath_utils.sym
endif
if HAVE_CHECK
check_PROGRAMS += path_utils_ut \
ini_augment_ut_check \
ini_configmod_ut_check \
ini_parse_ut_check \
ini_validators_ut_check \
$(NULL)
TESTS += path_utils_ut \
ini_augment_ut_check \
ini_configmod_ut_check \
ini_parse_ut_check \
ini_validators_ut_check \
$(NULL)
endif
path_utils_ut_SOURCES = path_utils/path_utils_ut.c
path_utils_ut_CFLAGS = \
$(AM_CFLAGS) \
$(CHECK_CFLAGS)
path_utils_ut_LDADD = \
$(CHECK_LIBS) \
libpath_utils.la
path_utils-docs:
if HAVE_DOXYGEN
cd path_utils; \
$(DOXYGEN) path_utils.cfg.doxy;
endif
dist_doc_DATA += path_utils/README.path_utils
##############################################################################
# dhash
##############################################################################
lib_LTLIBRARIES += libdhash.la
dist_pkgconfig_DATA += dhash/dhash.pc
dist_include_HEADERS += dhash/dhash.h
libdhash_la_SOURCES = dhash/dhash.c
libdhash_la_DEPENDENCIES = dhash/libdhash.sym
libdhash_la_LDFLAGS = \
-version-info 2:0:1
if HAVE_LD_VERSION_SCRIPT
libdhash_la_LDFLAGS += -Wl,--version-script=$(top_srcdir)/dhash/libdhash.sym
endif
check_PROGRAMS += dhash_test dhash_example
TESTS += dhash_test dhash_example
if HAVE_CHECK
check_PROGRAMS += dhash_ut_check
TESTS += dhash_ut_check
endif
dhash_test_SOURCES = dhash/examples/dhash_test.c
dhash_test_LDADD = libdhash.la
dhash_example_SOURCES = dhash/examples/dhash_example.c
dhash_example_LDADD = libdhash.la
dhash_ut_check_SOURCES = dhash/dhash_ut_check.c
dhash_ut_chech_CFLAGS = $(AM_CFLAGS) \
$(CHECK_CFLAGS) \
$(NULL)
dhash_ut_check_LDADD = libdhash.la \
$(CHECK_LIBS) \
$(NULL)
dist_examples_DATA += \
dhash/examples/dhash_test.c \
dhash/examples/dhash_example.c
dist_doc_DATA += dhash/README.dhash
##############################################################################
# collection
##############################################################################
lib_LTLIBRARIES += libcollection.la
dist_pkgconfig_DATA += collection/collection.pc
dist_include_HEADERS += \
collection/collection.h \
collection/collection_tools.h \
collection/collection_queue.h \
collection/collection_stack.h
libcollection_la_SOURCES = \
collection/collection.c \
collection/collection_tools.c \
collection/collection_cnv.c \
collection/collection_queue.c \
collection/collection_stack.c \
collection/collection_cmp.c \
collection/collection_iter.c \
collection/collection_priv.h \
trace/trace.h
libcollection_la_DEPENDENCIES = collection/libcollection.sym
libcollection_la_LDFLAGS = \
-version-info 5:1:1
if HAVE_LD_VERSION_SCRIPT
libcollection_la_LDFLAGS += -Wl,--version-script=$(top_srcdir)/collection/libcollection.sym
endif
check_PROGRAMS += \
collection_ut \
collection_stack_ut \
collection_queue_ut
TESTS += \
collection_ut \
collection_stack_ut \
collection_queue_ut
collection_ut_SOURCES = collection/collection_ut.c
collection_ut_LDADD = libcollection.la
collection_stack_ut_SOURCES = collection/collection_stack_ut.c
collection_stack_ut_LDADD = libcollection.la
collection_queue_ut_SOURCES = collection/collection_queue_ut.c
collection_queue_ut_LDADD = libcollection.la
collection-docs:
if HAVE_DOXYGEN
cd collection; \
$(DOXYGEN) collection.cfg.doxy
endif
##############################################################################
# refarray
##############################################################################
lib_LTLIBRARIES += libref_array.la
dist_pkgconfig_DATA += refarray/ref_array.pc
dist_include_HEADERS += refarray/ref_array.h
libref_array_la_SOURCES = \
refarray/ref_array.c \
trace/trace.h
libref_array_la_DEPENDENCIES = refarray/libref_array.sym
libref_array_la_LDFLAGS = \
-version-info 3:1:2
if HAVE_LD_VERSION_SCRIPT
libref_array_la_LDFLAGS += -Wl,--version-script=$(top_srcdir)/refarray/libref_array.sym
endif
check_PROGRAMS += ref_array_ut
TESTS += ref_array_ut
ref_array_ut_SOURCES = refarray/ref_array_ut.c
ref_array_ut_LDADD = libref_array.la
dist_doc_DATA += refarray/README.ref_array
ref_array-docs:
if HAVE_DOXYGEN
cd refarray; \
$(DOXYGEN) ref_array.cfg.doxy
endif
##############################################################################
# basicobjects
##############################################################################
lib_LTLIBRARIES += libbasicobjects.la
dist_pkgconfig_DATA += basicobjects/basicobjects.pc
dist_include_HEADERS += basicobjects/simplebuffer.h
libbasicobjects_la_SOURCES = \
basicobjects/simplebuffer.c \
trace/trace.h
libbasicobjects_la_DEPENDENCIES = basicobjects/libbasicobjects.sym
libbasicobjects_la_LDFLAGS = \
-version-info 1:0:1
if HAVE_LD_VERSION_SCRIPT
libbasicobjects_la_LDFLAGS += -Wl,--version-script=$(top_srcdir)/basicobjects/libbasicobjects.sym
endif
check_PROGRAMS += simplebuffer_ut
TESTS += simplebuffer_ut
simplebuffer_ut_SOURCES = basicobjects/simplebuffer_ut.c
simplebuffer_ut_LDADD = libbasicobjects.la
basicobjects-docs:
if HAVE_DOXYGEN
cd basicobjects; \
$(DOXYGEN) basicobjects.cfg.doxy
endif
##############################################################################
# ini_config
##############################################################################
lib_LTLIBRARIES += libini_config.la
dist_pkgconfig_DATA += ini/ini_config.pc
dist_include_HEADERS += ini/ini_config.h ini/ini_configobj.h \
ini/ini_valueobj.h ini/ini_comment.h \
ini/ini_configmod.h
libini_config_la_SOURCES = \
ini/ini_config.c \
ini/ini_config.h \
ini/ini_get_value.c \
ini/ini_get_array.c \
ini/ini_list.c \
ini/ini_print.c \
ini/ini_parse.c \
ini/ini_metadata.c \
ini/ini_metadata.h \
ini/ini_defines.h \
ini/ini_comment.c \
ini/ini_comment.h \
ini/ini_valueobj.c \
ini/ini_valueobj.h \
ini/ini_serialize.c \
ini/ini_fileobj.c \
ini/ini_configobj.c \
ini/ini_configobj.h \
ini/ini_configmod.h \
ini/ini_configmod.c \
ini/ini_config_priv.h \
ini/ini_get_valueobj.c \
ini/ini_get_array_valueobj.c \
ini/ini_list_valueobj.c \
ini/ini_augment.c \
trace/trace.h
EXTRA_libini_config_la_DEPENDENCIES = ini/libini_config.sym
libini_config_la_LIBADD = \
libcollection.la \
libpath_utils.la \
libref_array.la \
libbasicobjects.la \
$(LTLIBICONV) \
$(LTLIBINTL)
libini_config_la_LDFLAGS = \
-version-info 7:1:2
if HAVE_LD_VERSION_SCRIPT
libini_config_la_LDFLAGS += -Wl,--version-script=$(top_srcdir)/ini/libini_config.sym
endif
dist_noinst_DATA += \
ini/ini.conf \
ini/ini.d/real.conf \
ini/ini.d/test.conf \
ini/ini.d/ipa.conf \
ini/ini.d/foo.conf.in \
ini/ini.d/mysssd.conf \
ini/ini.d/smerge.conf \
ini/ini.d/sexpect.conf \
ini/ini.d/first.conf \
ini/ini.d/second.conf \
ini/ini.d/space.conf \
ini/ini.d/mergecheck.conf \
ini/ini.d/comment.conf \
ini/ini.d/real8.conf \
ini/ini.d/real16be.conf \
ini/ini.d/real16le.conf \
ini/ini.d/real32be.conf \
ini/ini.d/real32le.conf \
ini/ini.d/symbols.conf \
ini/ini.d/new_line.conf \
ini/ini.d/merge.validator \
ini/ini2.d/real8.conf \
ini/ini2.d/real16be.conf \
ini/ini2.d/real16le.conf \
ini/ini2.d/real32be.conf \
ini/ini2.d/real32le.conf
check_PROGRAMS += \
ini_config_ut \
ini_comment_ut \
ini_valueobj_ut \
ini_parse_ut \
ini_augment_ut \
ini_configmod_ut \
ini_save_ut
TESTS += \
ini_config_ut \
ini_comment_ut \
ini_valueobj_ut \
ini_parse_ut \
ini_augment_ut \
ini_configmod_ut \
ini_save_ut
ini_config_ut_SOURCES = ini/ini_config_ut.c
ini_config_ut_LDADD = \
libini_config.la \
libcollection.la
ini_comment_ut_SOURCES = ini/ini_comment_ut.c
ini_comment_ut_LDADD = libini_config.la
ini_valueobj_ut_SOURCES = ini/ini_valueobj_ut.c
ini_valueobj_ut_LDADD = libini_config.la libbasicobjects.la
ini_parse_ut_SOURCES = ini/ini_parse_ut.c
ini_parse_ut_LDADD = libini_config.la libcollection.la libbasicobjects.la
ini_augment_ut_SOURCES = ini/ini_augment_ut.c
ini_augment_ut_LDADD = libini_config.la libcollection.la \
libbasicobjects.la libpath_utils.la libref_array.la
ini_configmod_ut_SOURCES = ini/ini_configmod_ut.c
ini_configmod_ut_LDADD = libini_config.la libcollection.la \
libbasicobjects.la libpath_utils.la libref_array.la
ini_augment_ut_check_SOURCES = ini/ini_augment_ut_check.c
ini_augment_ut_check_CFLAGS = $(AM_CFLAGS) $(CHECK_CFLAGS)
ini_augment_ut_check_LDADD = libini_config.la $(CHECK_LIBS) \
libref_array.la
ini_configmod_ut_check_SOURCES = ini/ini_configmod_ut_check.c
ini_configmod_ut_check_CFLAGS = $(AM_CFLAGS) $(CHECK_CFLAGS)
ini_configmod_ut_check_LDADD = libini_config.la libcollection.la \
libbasicobjects.la libpath_utils.la \
libref_array.la \
$(CHECK_LIBS)
ini_parse_ut_check_SOURCES = ini/ini_parse_ut_check.c
ini_parse_ut_check_CFLAGS = $(AM_CFLAGS) $(CHECK_CFLAGS)
ini_parse_ut_check_LDADD = libini_config.la \
libref_array.la \
$(CHECK_LIBS)
ini_validators_ut_check_SOURCES = ini/ini_validators_ut_check.c
ini_validators_ut_check_CFLAGS = $(AM_CFLAGS) $(CHECK_CFLAGS)
ini_validators_ut_check_LDADD = libini_config.la $(CHECK_LIBS)
ini_save_ut_SOURCES = ini/ini_save_ut.c
ini_save_ut_LDADD = libini_config.la libcollection.la \
libbasicobjects.la libpath_utils.la libref_array.la
ini_config-docs:
if HAVE_DOXYGEN
cd ini; \
$(DOXYGEN) ini_config.cfg.doxy
endif
clean-local-ini_config:
rm -f ./*.out
rm -f test.ini
rm -f ./foo.conf ./bom* #From ini_parse_ut
rm -f ./merge.validator.* #From ini_augment_ut
rm -f ./real.conf.manual
rm -f ./modtest.conf.real
rm -f ./modtest.conf.exp
rm -f ./test_*
##############################################################################
# Additional rules
##############################################################################
rpmroot:
mkdir -p $(RPMBUILD)/BUILD
mkdir -p $(RPMBUILD)/RPMS
mkdir -p $(RPMBUILD)/SOURCES
mkdir -p $(RPMBUILD)/SPECS
mkdir -p $(RPMBUILD)/SRPMS
rpms: dist-gzip rpmroot
cp $(builddir)/contrib/ding-libs.spec $(RPMBUILD)/SPECS
cp $(distdir).tar.gz $(RPMBUILD)/SOURCES
cd $(RPMBUILD); \
rpmbuild --define "_topdir $(RPMBUILD)" -ba SPECS/ding-libs.spec
if GIT_CHECKOUT
prerelease-rpms:
cp $(srcdir)/version.m4 $(srcdir)/version.m4.orig
sed -e "s/m4_define(\[PRERELEASE_VERSION_NUMBER\], \[.*\])/m4_define(\[PRERELEASE_VERSION_NUMBER\], \[.`date +%Y%m%d%H`git`git log -1 --pretty=format:%h`\])/" < $(srcdir)/version.m4.orig > $(srcdir)/version.m4
$(MAKE) rpms
mv $(srcdir)/version.m4.orig $(srcdir)/version.m4
endif
# make srpms will use the old digest algorithm to be compatible
# with RHEL5
srpm: dist-gzip rpmroot
cp $(builddir)/contrib/ding-libs.spec $(RPMBUILD)/SPECS
cp $(distdir).tar.gz $(RPMBUILD)/SOURCES
cd $(RPMBUILD); \
rpmbuild --define "_topdir $(RPMBUILD)" \
--define _source_filedigest_algorithm=1 \
-bs SPECS/ding-libs.spec
if GIT_CHECKOUT
prerelease-srpm:
cp $(srcdir)/version.m4 $(srcdir)/version.m4.orig
sed -e "s/m4_define(\[PRERELEASE_VERSION_NUMBER\], \[.*\])/m4_define(\[PRERELEASE_VERSION_NUMBER\], \[.`date +%Y%m%d%H`git`git log -1 --pretty=format:%h`\])/" < $(srcdir)/version.m4.orig > $(srcdir)/version.m4
$(MAKE) srpm
mv $(srcdir)/version.m4.orig $(srcdir)/version.m4
endif
tests: all $(check_PROGRAMS)
docs: path_utils-docs collection-docs ref_array-docs ini_config-docs basicobjects-docs
clean-local: clean-local-ini_config
rm -Rf doc
ding-libs-0.6.2/README 0000664 0000000 0000000 00000000365 14172606404 0014257 0 ustar 00root root 0000000 0000000 To build the ding-libs from the tarball:
./configure
make
make docs (optional)
make check (optional)
make install
To build the ding-libs from a source checkout:
autoreconf -if
then follow the tarball instructions above.
ding-libs-0.6.2/basicobjects/ 0000775 0000000 0000000 00000000000 14172606404 0016026 5 ustar 00root root 0000000 0000000 ding-libs-0.6.2/basicobjects/basicobjects.cfg.doxy.in 0000664 0000000 0000000 00000175522 14172606404 0022545 0 ustar 00root root 0000000 0000000 # Doxyfile 1.6.3
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
# TAG = value [value, ...]
# For lists items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# http://www.gnu.org/software/libiconv for the list of possible encodings.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "libbasicobjects"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = @PACKAGE_VERSION@
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of
# source files, where putting all generated files in the same directory would
# otherwise cause performance problems for the file system.
CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is
# used as the annotated text. Otherwise, the brief description is used as-is.
# If left blank, the following values are used ("$name" is automatically
# replaced with the name of the entity): "The $name class" "The $name widget"
# "The $name file" "is" "provides" "specifies" "contains"
# "represents" "a" "an" "the"
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
# description.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
FULL_PATH_NAMES = YES
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
# path to strip.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
# the reader which header file to include in order to use a class.
# If left blank only the name of the header file containing the class
# definition is used. Otherwise one should specify the include paths that
# are normally passed to the compiler using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
# doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
# description. Set this tag to YES if you prefer the old behaviour instead.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# re-implements.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
# a new page for each member. If set to NO, the documentation of a member will
# be part of the file/class/namespace that contains it.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = YES
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# Java. For instance, namespaces will be presented as packages, qualified
# scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it parses.
# With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
# The format is ext=language, where ext is a file extension, and language is one of
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
EXTENSION_MAPPING =
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
# instead of private inheritance when no explicit protection keyword is present.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
DISTRIBUTE_GROUP_DOC = NO
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
# the \nosubgrouping command.
SUBGROUPING = YES
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
EXTRACT_STATIC = NO
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.
EXTRACT_LOCAL_CLASSES = NO
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
# If set to NO (the default) only methods in the interface are included.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = YES
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
# documentation.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
# function's detailed documentation block.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
# of that file.
SHOW_INCLUDE_FILES = YES
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
# declaration order.
SORT_MEMBER_DOCS = NO
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
# declaration order.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the
# alphabetical list.
SORT_BY_SCOPE_NAME = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
# commands in the documentation.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
# command in the documentation regardless of this setting.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command , where is the value of
# the FILE_VERSION_FILTER tag, and is the name of an input file
# provided by doxygen. Whatever the program writes to standard output
# is used as the file version. See the manual for examples.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
# doxygen. The layout file controls the global structure of the generated output files
# in an output format independent way. The create the layout file that represents
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
# of the layout file.
LAYOUT_FILE =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
WARNINGS = YES
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
WARN_IF_UNDOCUMENTED = YES
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
# documentation.
WARN_NO_PARAMDOC = NO
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text. Optionally the format may contain
# $version, which will be replaced by the version of the file (if it could
# be obtained via FILE_VERSION_FILTER)
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
# to stderr.
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = @srcdir@
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.c *.h
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
RECURSIVE = NO
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
# from the input.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
EXCLUDE_PATTERNS = *_ut.c config.h
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command , where
# is the value of the INPUT_FILTER tag, and is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.
# If FILTER_PATTERNS is specified, this tag will be
# ignored.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.
# Doxygen will compare the file name with each pattern and apply the
# filter if there is a match.
# The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
# is applied to all files.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
# functions referencing it will be listed.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
# called/used by that function will be listed.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
# link to the source code.
# Otherwise they will link to the documentation.
REFERENCES_LINK_SOURCE = YES
# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
# will need version 4.8.6 or higher.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
# which an include is specified. Set to NO to disable this.
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
# contains a lot of classes, structs, unions or interfaces.
ALPHABETICAL_INDEX = NO
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# in which this list will be split (can be a number in the range [1..20])
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
# should be ignored while generating the index headers.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
# doxygen will generate files with .html extension.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased!
HTML_STYLESHEET =
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.
HTML_TIMESTAMP = NO
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
GENERATE_DOCSET = NO
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.
DOCSET_FEEDNAME = "Doxygen generated docs"
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.
DOCSET_BUNDLE_ID = org.doxygen.Project
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# of the generated HTML documentation.
GENERATE_HTMLHELP = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
# written to the html output directory.
CHM_FILE =
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
HHC_LOCATION =
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
# it should be included in the master .chm file (NO).
GENERATE_CHI = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.
CHM_INDEX_ENCODING =
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
# normal table of contents (NO) in the .chm file.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members
# to the contents of the HTML help documentation and to the tree view.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
# HTML documentation.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace
QHP_NAMESPACE =
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
QHP_VIRTUAL_FOLDER = doc
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
# For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
# Qt Help Project / Custom Filters.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
# filter section matches.
# Qt Help Project / Filter Attributes.
QHP_SECT_FILTER_ATTRS =
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file.
QHG_LOCATION =
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
DISABLE_INDEX = NO
# This tag can be used to set the number of enum values (range [1..20])
# that doxygen will group on one line in the generated HTML documentation.
ENUM_VALUES_PER_LINE = 4
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value is set to YES, a side panel will be generated
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
GENERATE_TREEVIEW = NO
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
# is shown.
TREEVIEW_WIDTH = 250
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.
FORMULA_FONTSIZE = 10
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
SEARCHENGINE = YES
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `latex' will be used as the default path.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
# default command name.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used.
PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
# standard header. Notice: only use this tag if you know what you are doing!
LATEX_HEADER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.
LATEX_BATCHMODE = NO
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
# in the output.
LATEX_HIDE_INDICES = NO
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
LATEX_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimized for Word 97 and may not look very pretty with
# other RTF readers or editors.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `rtf' will be used as the default path.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
# Note: wordpad (write) and others do not support links.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an rtf document.
# Syntax is similar to doxygen's config file.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
# generate man pages
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `man' will be used as the default path.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
MAN_EXTENSION = .3
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
# would be unable to find the correct page. The default is NO.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
# the code including all documentation.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `xml' will be used as the default path.
XML_OUTPUT = xml
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that
# enabling this will significantly increase the size of the XML output.
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
# and incomplete at the moment.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
# moment.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
# to generate PDF and DVI output from the Perl module output.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader.
# This is useful
# if you want to understand what is going on.
# On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
# and Perl will parse it just the same.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
# Makefile don't overwrite each other's variables.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
# files.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
# PREDEFINED and EXPAND_AS_DEFINED tags.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# in the INCLUDE_PATH (see below) will be search if a #include is found.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
# the preprocessor.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
# be used.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse
# the parser if not removed.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
# The TAGFILES option can be used to specify one or more tagfiles.
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
#
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
#
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
# If a tag file is not located in the directory in which doxygen
# is run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
# will be listed.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
# be listed.
EXTERNAL_GROUPS = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
# or super classes. Setting the tag to NO turns the diagrams off. Note that
# this option is superseded by the HAVE_DOT option below. This is only a
# fallback. It is recommended to install and use dot, since it yields more
# powerful graphs.
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
# or is not a class.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
HAVE_DOT = NO
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# font does not include all possible unicode characters however, so when you need
# these (or just want a differently looking font) you can specify the font name
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.
DOT_FONTPATH =
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
UML_LOOK = NO
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
TEMPLATE_RELATIONS = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
# other documented files.
INCLUDE_GRAPH = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable call graphs
# for selected functions only using the \callgraph command.
CALL_GRAPH = NO
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable caller
# graphs for selected functions only using the \callergraph command.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.
DOT_IMAGE_FORMAT = png
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
# \dotfile command).
DOTFILE_DIRS =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
# visualized by representing a node as a red box. Note that doxygen if the
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes
# that lay further from the root node will be omitted. Note that setting this
# option to 1 or 2 may greatly reduce the computation time needed for large
# code bases. Also note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not
# seem to support this out of the box. Warning: Depending on the platform used,
# enabling this option may lead to badly anti-aliased labels on the edges of
# a graph (i.e. they become hard to read).
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10)
# support this, this feature is disabled by default.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
# the various graphs.
DOT_CLEANUP = YES
ding-libs-0.6.2/basicobjects/basicobjects.pc.in 0000664 0000000 0000000 00000000446 14172606404 0021416 0 ustar 00root root 0000000 0000000 prefix=@prefix@
exec_prefix=@exec_prefix@
libdir=@libdir@
includedir=@includedir@
Name: basicobjects
Description: Library contains basic objects like dynamic string
Version: @BASICOBJECTS_VERSION@
Libs: -L${libdir} -lbasicobjects
Cflags: -I${includedir}
URL: https://github.com/SSSD/ding-libs
ding-libs-0.6.2/basicobjects/libbasicobjects.sym 0000664 0000000 0000000 00000000535 14172606404 0021705 0 ustar 00root root 0000000 0000000 BASICOBJECTS_0.1.0 {
global:
simplebuffer_free;
simplebuffer_alloc;
simplebuffer_grow;
simplebuffer_add_raw;
simplebuffer_add_str;
simplebuffer_add_cr;
simplebuffer_write;
simplebuffer_get_buf;
simplebuffer_get_len;
local:
*;
};
BASICOBJECTS_0.1.1 {
global:
simplebuffer_get_vbuf;
} BASICOBJECTS_0.1.0;
ding-libs-0.6.2/basicobjects/simplebuffer.c 0000664 0000000 0000000 00000012637 14172606404 0020666 0 ustar 00root root 0000000 0000000 /*
Simple buffer
Basic buffer manipulation routines. Taken from ELAPI code.
Copyright (C) Dmitri Pal 2009 - 2010
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 .
*/
#include "config.h"
#include /* for errors */
#include /* for free() */
#include /* for write() */
#include /* for memcpy() */
#include "simplebuffer.h"
#include "trace.h"
/* End line string */
#define ENDLNSTR "\n"
/* Function to free buffer */
void simplebuffer_free(struct simplebuffer *data)
{
TRACE_FLOW_ENTRY();
if (data) {
free(data->buffer);
free(data);
}
TRACE_FLOW_EXIT();
}
/* Allocate buffer structure */
int simplebuffer_alloc(struct simplebuffer **data)
{
int error = EOK;
TRACE_FLOW_ENTRY();
if (!data) {
TRACE_ERROR_STRING("Invalid argument", "");
error = EINVAL;
}
else {
*data = (struct simplebuffer *)calloc(1,
sizeof(struct simplebuffer));
if (*data == NULL) {
TRACE_ERROR_STRING("Failed to allocate memory", "");
error = ENOMEM;
}
else error = EOK;
}
TRACE_FLOW_RETURN(error);
return error;
}
/* Grow buffer */
int simplebuffer_grow(struct simplebuffer *data,
uint32_t len,
uint32_t block)
{
int error = EOK;
unsigned char *newbuf = NULL;
TRACE_FLOW_ENTRY();
TRACE_INFO_NUMBER("Current length: ", data->length);
TRACE_INFO_NUMBER("Current size: ", data->size);
TRACE_INFO_NUMBER("Length to have: ", len);
TRACE_INFO_NUMBER("Increment length: ", block);
/* Grow buffer if needed */
while (data->length + len >= data->size) {
newbuf = realloc(data->buffer, data->size + block);
if (newbuf == NULL) {
TRACE_ERROR_NUMBER("Error. Failed to allocate memory.", ENOMEM);
return ENOMEM;
}
data->buffer = newbuf;
data->size += block;
TRACE_INFO_NUMBER("New size: ", data->size);
}
TRACE_INFO_NUMBER("Final size: ", data->size);
TRACE_FLOW_RETURN(error);
return error;
}
/* Function to add raw data to the end of the buffer.
* Terminating 0 is not counted in length but appended
* automatically.
*/
int simplebuffer_add_raw(struct simplebuffer *data,
void *data_in,
uint32_t len,
uint32_t block)
{
int error = EOK;
uint32_t size;
TRACE_FLOW_ENTRY();
size = len + 1;
error = simplebuffer_grow(data, size,
((block > size) ? block : size));
if (error) {
TRACE_ERROR_NUMBER("Failed to grow buffer.", error);
return error;
}
memcpy(data->buffer + data->length, data_in, len);
data->length += len;
data->buffer[data->length] = '\0';
TRACE_FLOW_EXIT();
return error;
}
/* Function to add string to the end of the buffer. */
int simplebuffer_add_str(struct simplebuffer *data,
const char *str,
uint32_t len,
uint32_t block)
{
int error = EOK;
uint32_t size;
TRACE_FLOW_ENTRY();
size = len + 1;
error = simplebuffer_grow(data, size,
((block > size) ? block : size));
if (error) {
TRACE_ERROR_NUMBER("Failed to grow buffer.", error);
return error;
}
memcpy(data->buffer + data->length, str, len);
data->length += len;
data->buffer[data->length] = '\0';
TRACE_FLOW_EXIT();
return error;
}
/* Finction to add CR to the buffer */
int simplebuffer_add_cr(struct simplebuffer *data)
{
int error = EOK;
char cr[] = ENDLNSTR;
TRACE_FLOW_ENTRY();
error = simplebuffer_add_raw(data,
(void *)cr,
sizeof(ENDLNSTR) - 1,
sizeof(ENDLNSTR));
TRACE_FLOW_RETURN(error);
return error;
}
/* Function to write data synchroniusly */
int simplebuffer_write(int fd, struct simplebuffer *data, uint32_t *left)
{
size_t res;
int error;
TRACE_FLOW_ENTRY();
/* Write given number of bytes to the socket */
res = write(fd,
data->buffer + (data->length - *left),
(size_t)(*left));
if (res == -1) {
error = errno;
TRACE_ERROR_NUMBER("Write failed.", error);
return error;
}
(*left) -= res;
TRACE_FLOW_EXIT();
return EOK;
}
/* Get buffer */
const unsigned char *simplebuffer_get_buf(struct simplebuffer *data)
{
return data->buffer;
}
/* Get void buffer */
void *simplebuffer_get_vbuf(struct simplebuffer *data)
{
return (void *)data->buffer;
}
/* Get length */
uint32_t simplebuffer_get_len(struct simplebuffer *data)
{
return data->length;
}
ding-libs-0.6.2/basicobjects/simplebuffer.h 0000664 0000000 0000000 00000004630 14172606404 0020665 0 ustar 00root root 0000000 0000000 /*
Simple buffer
Basic buffer manipulation routines. Taken from ELAPI code.
Copyright (C) Dmitri Pal 2009
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 .
*/
#ifndef ELAPI_SIMPLEBUFFER_H
#define ELAPI_SIMPLEBUFFER_H
#include
#ifndef EOK
#define EOK 0
#endif
/* Generic data structure for the buffer */
struct simplebuffer {
unsigned char *buffer;
uint32_t size;
uint32_t length;
};
/* Function to free data */
void simplebuffer_free(struct simplebuffer *data);
/* Allocate data structure */
int simplebuffer_alloc(struct simplebuffer **data);
/* Function to add memory to the buffer */
int simplebuffer_grow(struct simplebuffer *data,
uint32_t len,
uint32_t block);
/* Function to add raw data to the end of the buffer.
* Terminating 0 is not counted in length but appended
* automatically.
*/
int simplebuffer_add_raw(struct simplebuffer *data,
void *data_in,
uint32_t len,
uint32_t block);
/* Function to add string to the buffer.
* Same as above just uses string as an argument.
*/
int simplebuffer_add_str(struct simplebuffer *data,
const char *str,
uint32_t len,
uint32_t block);
/* Finction to add CR to the buffer */
int simplebuffer_add_cr(struct simplebuffer *data);
/* Function to write data synchroniusly */
int simplebuffer_write(int fd,
struct simplebuffer *data,
uint32_t *left);
/* Get buffer */
const unsigned char *simplebuffer_get_buf(struct simplebuffer *data);
/* Get buffer */
void *simplebuffer_get_vbuf(struct simplebuffer *data);
/* Get length */
uint32_t simplebuffer_get_len(struct simplebuffer *data);
#endif
ding-libs-0.6.2/basicobjects/simplebuffer_ut.c 0000664 0000000 0000000 00000007347 14172606404 0021400 0 ustar 00root root 0000000 0000000 /*
Simple buffer UNIT test
Basic buffer manipulation routines.
Copyright (C) Dmitri Pal 2010
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 .
*/
#include "config.h"
#include
#include
#include
#include
#include
#include
#define TRACE_HOME
#include "trace.h"
#include "simplebuffer.h"
int verbose = 0;
#define BOOUT(foo) \
do { \
if (verbose) foo; \
} while(0)
static int simple_test(void)
{
int error = EOK;
struct simplebuffer *data = NULL;
char str1[] = "test string 1";
char str2[] = "test string 2";
const char str3[] = "test string 3";
uint32_t left = 0;
int i;
const unsigned char *buf;
BOOUT(printf("Simple test start.\n"));
error = simplebuffer_alloc(&data);
if (error) {
printf("Failed to allocate object %d\n", error);
return error;
}
error = simplebuffer_add_raw(data,
(void *)str1,
strlen(str1),
1);
if (error) {
printf("Failed to add string to an object %d\n", error);
simplebuffer_free(data);
return error;
}
error = simplebuffer_add_cr(data);
if (error) {
printf("Failed to add CR to an object %d\n", error);
simplebuffer_free(data);
return error;
}
error = simplebuffer_add_raw(data,
(void *)str2,
strlen(str2),
1);
if (error) {
printf("Failed to add string to an object %d\n", error);
simplebuffer_free(data);
return error;
}
error = simplebuffer_add_cr(data);
if (error) {
printf("Failed to add CR to an object %d\n", error);
simplebuffer_free(data);
return error;
}
error = simplebuffer_add_str(data,
str3,
strlen(str3),
1);
if (error) {
printf("Failed to add string to an object %d\n", error);
simplebuffer_free(data);
return error;
}
left = simplebuffer_get_len(data);
buf = simplebuffer_get_buf(data);
BOOUT(for(i = 0; i < left; i++) {
printf("%02d: %02X\n", i, buf[i]);
});
if (verbose) {
while (left > 0) {
error = simplebuffer_write(1, data, &left);
if (error) {
printf("Failed to write to output %d\n", error);
simplebuffer_free(data);
return error;
}
}
}
BOOUT(printf("\n[%s]\n", simplebuffer_get_buf(data)));
BOOUT(printf("Length: %d\n", simplebuffer_get_len(data)));
simplebuffer_free(data);
BOOUT(printf("Simple test end.\n"));
return error;
}
int main(int argc, char *argv[])
{
int error = EOK;
if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1;
BOOUT(printf("Start\n"));
if ((error = simple_test())) {
printf("Test failed! Error %d.\n", error);
return -1;
}
BOOUT(printf("Success!\n"));
return 0;
}
ding-libs-0.6.2/collection/ 0000775 0000000 0000000 00000000000 14172606404 0015526 5 ustar 00root root 0000000 0000000 ding-libs-0.6.2/collection/collection.c 0000664 0000000 0000000 00000354251 14172606404 0020037 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Implementation of the collection library interface.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#include
#include
#include
#include "trace.h"
/* The collection should use the real structures */
#include "collection_priv.h"
#include "collection.h"
#define INTERRUPT(d) ((d == COL_DSP_LASTDUPNS) || (d == COL_DSP_NDUPNS)) ? 0 : 1
/* Internal constants defined to denote actions that can be performed by find handler */
#define COLLECTION_ACTION_FIND 1
#define COLLECTION_ACTION_DEL 2
#define COLLECTION_ACTION_UPDATE 3
#define COLLECTION_ACTION_GET 4
/* Special internal error code to indicate that collection search was interrupted */
#define EINTR_INTERNAL 10000
/* Magic numbers for hashing */
#if SIZEOF_LONG == 8
#define FNV1a_prime 1099511628211ul
#define FNV1a_base 14695981039346656037ul
#elif SIZEOF_LONG_LONG == 8
#define FNV1a_prime 1099511628211ull
#define FNV1a_base 14695981039346656037ull
#else
#error "Platform cannot support 64-bit constant integers"
#endif
/* Struct used for passing parameter for update operation */
struct update_property {
int type;
void *data;
int length;
int found;
};
/* This struct is used to construct path
* to an item in the collection (tree)
*/
struct path_data {
char *name;
int length;
struct path_data *previous_path;
};
/* Structure to keep data needed to
* copy collection
* while traversing it
*/
struct col_copy {
int mode;
struct path_data *current_path;
char *given_name;
int given_len;
col_copy_cb copy_cb;
void *ext_data;
};
/******************** FUNCTION DECLARATIONS ****************************/
/* Have to declare those due to function cross referencing */
static int col_find_item_and_do(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
col_item_fn item_handler,
void *custom_data,
int action);
/* Traverse callback for find & delete function */
static int col_act_traverse_handler(struct collection_item *head,
struct collection_item *previous,
struct collection_item *current,
void *passed_traverse_data,
col_item_fn user_item_handler,
void *custom_data,
int *stop);
/* Traverse handler to find parent of the item */
static int col_parent_traverse_handler(struct collection_item *head,
struct collection_item *previous,
struct collection_item *current,
void *traverse_data,
col_item_fn user_item_handler,
void *custom_data,
int *stop);
/* Traverse callback signature */
typedef int (*internal_item_fn)(struct collection_item *head,
struct collection_item *previous,
struct collection_item *current,
void *traverse_data,
col_item_fn user_item_handler,
void *custom_data,
int *stop);
/* Function to walk_items */
static int col_walk_items(struct collection_item *ci,
int mode_flags,
internal_item_fn traverse_handler,
void *traverse_data,
col_item_fn user_item_handler,
void *custom_data,
unsigned *depth);
/* Function to get sub collection */
static int col_get_subcollection(const char *property,
int property_len,
int type,
void *data,
int length,
void *found,
int *dummy);
/* Function to destroy collection */
void col_destroy_collection(struct collection_item *ci);
/******************** SUPPLEMENTARY FUNCTIONS ****************************/
/* BASIC OPERATIONS */
/* Function that checks if property can be added */
static int col_validate_property(const char *property)
{
TRACE_FLOW_STRING("col_validate_property", "Entry point.");
/* Only alpha numeric characters are allowed in names of the properties */
int invalid = 0;
const char *check;
check = property;
while (*check != '\0') {
/* It turned out that limiting collection charcters is bad */
if ((*check < ' ') || (*check == '!')) {
invalid = 1;
break;
}
check++;
}
TRACE_FLOW_NUMBER("col_validate_property. Returning ", invalid);
return invalid;
}
/* Function that cleans the item with callback */
void col_delete_item_with_cb(struct collection_item *item,
col_item_cleanup_fn cb,
void *custom_data)
{
struct collection_item *other_collection;
TRACE_FLOW_STRING("col_delete_item","Entry point.");
if (item == NULL) {
TRACE_FLOW_STRING("col_delete_item","Nothing to delete!");
return;
}
/* Handle external or embedded collection */
if(item->type == COL_TYPE_COLLECTIONREF) {
/* Our data is a pointer to a whole external collection so dereference
* it or delete */
other_collection = *((struct collection_item **)(item->data));
col_destroy_collection_with_cb(other_collection, cb, custom_data);
}
/* Call the callback */
if (cb) cb(item->property,
item->property_len,
item->type,
item->data,
item->length,
custom_data);
TRACE_INFO_STRING("Deleting property:", item->property);
TRACE_INFO_NUMBER("Type:", item->type);
if (item->property != NULL) free(item->property);
if (item->data != NULL) free(item->data);
free(item);
TRACE_FLOW_STRING("col_delete_item","Exit.");
}
/* Function that cleans the item */
void col_delete_item(struct collection_item *item)
{
TRACE_FLOW_STRING("col_delete_item","Entry point.");
col_delete_item_with_cb(item, NULL, NULL);
TRACE_FLOW_STRING("col_delete_item","Exit.");
}
/* A generic function to allocate a property item */
int col_allocate_item(struct collection_item **ci, const char *property,
const void *item_data, int length, int type)
{
struct collection_item *item = NULL;
TRACE_FLOW_STRING("col_allocate_item", "Entry point.");
TRACE_INFO_NUMBER("Will be using type:", type);
/* Check the length */
if (length >= COL_MAX_DATA) {
TRACE_ERROR_STRING("col_allocate_item", "Data to long.");
return EMSGSIZE;
}
if (col_validate_property(property)) {
TRACE_ERROR_STRING("Invalid chracters in the property name", property);
return EINVAL;
}
/* Allocate memory for the structure */
item = (struct collection_item *)malloc(sizeof(struct collection_item));
if (item == NULL) {
TRACE_ERROR_STRING("col_allocate_item", "Malloc failed.");
return ENOMEM;
}
/* After we initialize members we can use delete_item() in case of error */
item->next = NULL;
item->property = NULL;
item->data = NULL;
TRACE_INFO_NUMBER("About to set type to:", type);
item->type = type;
/* Copy property */
item->property = strdup(property);
if (item->property == NULL) {
TRACE_ERROR_STRING("col_allocate_item", "Failed to dup property.");
col_delete_item(item);
return ENOMEM;
}
item->phash = col_make_hash(property, 0, &(item->property_len));
TRACE_INFO_NUMBER("Item hash", item->phash);
TRACE_INFO_NUMBER("Item property length", item->property_len);
TRACE_INFO_NUMBER("Item property strlen", strlen(item->property));
/* Deal with data */
item->data = malloc(length);
if (item->data == NULL) {
TRACE_ERROR_STRING("col_allocate_item", "Failed to dup data.");
col_delete_item(item);
return ENOMEM;
}
memcpy(item->data, item_data, length);
item->length = length;
/* Make sure that data is NULL terminated in case of string */
if (type == COL_TYPE_STRING) ((char *)(item->data))[length-1] = '\0';
*ci = item;
TRACE_INFO_STRING("Item property", item->property);
TRACE_INFO_NUMBER("Item property type", item->type);
TRACE_INFO_NUMBER("Item data length", item->length);
TRACE_FLOW_STRING("col_allocate_item", "Success exit.");
return EOK;
}
/* Structure used to find things in collection */
struct property_search {
const char *property;
uint64_t hash;
struct collection_item *parent;
int index;
int count;
int found;
int use_type;
int type;
int interrupt;
int exact;
};
/* Find the parent of the item with given name */
static int col_find_property_sub(struct collection_item *collection,
const char *subcollection,
int interrupt,
const char *refprop,
int idx,
int exact,
int use_type,
int type,
struct collection_item **parent)
{
struct property_search ps;
int i = 0;
unsigned depth = 0;
struct collection_item *sub = NULL;
int error = EOK;
TRACE_FLOW_ENTRY();
*parent = NULL;
ps.property = refprop;
ps.hash = FNV1a_base;
ps.parent = NULL;
ps.index = idx;
ps.count = 0;
ps.found = 0;
ps.use_type = use_type;
ps.type = type;
ps.interrupt = interrupt;
ps.exact = exact;
/* Create hash of the string to search */
while(refprop[i] != 0) {
ps.hash = ps.hash ^ toupper(refprop[i]);
ps.hash *= FNV1a_prime;
i++;
}
/* Add item to collection */
if (subcollection == NULL) {
sub = collection;
}
else {
TRACE_INFO_STRING("Subcollection is not null, searching",
subcollection);
error = col_find_item_and_do(collection, subcollection,
COL_TYPE_COLLECTIONREF,
COL_TRAVERSE_DEFAULT,
col_get_subcollection, (void *)(&sub),
COLLECTION_ACTION_FIND);
if (error) {
TRACE_ERROR_NUMBER("Search for subcollection returned error:",
error);
/* Not found */
return 0;
}
if (sub == NULL) {
TRACE_ERROR_STRING("Search for subcollection returned NULL", "");
/* Not found */
return 0;
}
}
/* We do not care about error here */
(void)col_walk_items(sub, COL_TRAVERSE_ONELEVEL,
col_parent_traverse_handler,
(void *)parent, NULL, (void *)&ps,
&depth);
if (*parent) {
/* Item is found in the collection */
TRACE_FLOW_STRING("col_find_property", "Exit - item found");
return 1;
}
/* Item is not found */
TRACE_FLOW_STRING("col_find_property", "Exit - item NOT found");
return 0;
}
/* Backward compatible wrapper */
static int col_find_property(struct collection_item *collection,
const char *refprop,
int idx,
int use_type,
int type,
struct collection_item **parent)
{
int error = EOK;
TRACE_FLOW_ENTRY();
error = col_find_property_sub(collection,
NULL,
1,
refprop,
idx,
0,
use_type,
type,
parent);
TRACE_FLOW_RETURN(error);
return error;
}
/* Find a duplicate item */
int col_get_dup_item(struct collection_item *ci,
const char *subcollection,
const char *property_to_find,
int type,
int idx,
int exact,
struct collection_item **item)
{
int error = EOK;
struct collection_item *parent = NULL;
TRACE_FLOW_ENTRY();
if (!ci) {
TRACE_ERROR_STRING("Passed in collection is invalid", "");
return EINVAL;
}
if (!item) {
TRACE_ERROR_STRING("Result storage is invalid", "");
return EINVAL;
}
if (!property_to_find) {
TRACE_ERROR_STRING("Passed in property to find is NULL", "");
return EINVAL;
}
/* Find the corresponding duplicate item */
if (col_find_property_sub(ci,
subcollection,
0,
property_to_find,
idx,
exact,
(type == COL_TYPE_ANY) ? 0 : 1,
type,
&parent)) {
*item = parent->next;
/* function col_get_dup_item with big value of idx should
* return the last item with the same property name. */
if (strncmp(property_to_find,
parent->next->property,
parent->next->property_len) != 0) {
*item = parent;
}
}
else error = ENOENT;
TRACE_FLOW_EXIT();
return error;
}
/* Insert item into the current collection */
int col_insert_item_into_current(struct collection_item *collection,
struct collection_item *item,
int disposition,
const char *refprop,
int idx,
unsigned flags)
{
struct collection_header *header = NULL;
struct collection_item *parent = NULL;
struct collection_item *current = NULL;
int refindex = 0;
TRACE_FLOW_STRING("col_insert_item_into_current", "Entry point");
/* Do best effort on the item */
if ((!item) || (item->next)) {
TRACE_ERROR_STRING("Passed in item is invalid", "");
return EINVAL;
}
if (collection == NULL) {
TRACE_INFO_STRING("col_insert_item_into_current",
"Collection accepting is NULL");
if (item->type == COL_TYPE_COLLECTION) {
/* This is a special case of self creation */
TRACE_INFO_STRING("col_insert_item_into_current",
"Adding header item to new collection.");
collection = item;
}
else {
TRACE_ERROR_STRING("Passed in item is invalid", "");
return EINVAL;
}
}
else {
/* We can add items only to collections */
if (collection->type != COL_TYPE_COLLECTION) {
TRACE_ERROR_STRING("Attempt to add item to non collection.","");
TRACE_ERROR_STRING("Collection name:", collection->property);
TRACE_ERROR_NUMBER("Collection type:", collection->type);
return EINVAL;
}
}
/* After processing flags we can process disposition */
header = (struct collection_header *)collection->data;
/* Check flags first */
switch(flags) {
case COL_INSERT_NOCHECK: /* No check - good just fall through */
TRACE_INFO_STRING("Insert without check", "");
break;
case COL_INSERT_DUPOVER: /* Find item and overwrite - ignore disposition */
if (col_find_property(collection, item->property, 0, 0, 0, &parent)) {
current = parent->next;
item->next = current->next;
parent->next = item;
if (header->last == current) header->last = item;
col_delete_item(current);
/* Deleted one added another - count stays the same! */
TRACE_FLOW_STRING("col_insert_item_into_current", "Dup overwrite exit");
return EOK;
}
/* Not found so we fall thorough and add as requested */
break;
case COL_INSERT_DUPOVERT: /* Find item by name and type and overwrite - ignore disposition */
if (col_find_property(collection, item->property, 0, 1, item->type, &parent)) {
current = parent->next;
item->next = current->next;
parent->next = item;
if (header->last == current) header->last = item;
col_delete_item(current);
/* Deleted one added another - count stays the same! */
TRACE_FLOW_STRING("col_insert_item_into_current", "Dup overwrite exit");
return EOK;
}
/* Not found so we fall thorough and add as requested */
break;
case COL_INSERT_DUPERROR: if (col_find_property(collection, item->property, 0, 0, 0, &parent)) {
/* Return error */
TRACE_ERROR_NUMBER("Duplicate property", EEXIST);
return EEXIST;
}
break;
case COL_INSERT_DUPERRORT: if (col_find_property(collection, item->property, 0, 1, item->type, &parent)) {
/* Return error */
TRACE_ERROR_NUMBER("Duplicate property of the same type", EEXIST);
return EEXIST;
}
break;
case COL_INSERT_DUPMOVE: /* Find item and delete */
if (col_find_property(collection, item->property, 0, 0, 0, &parent)) {
current = parent->next;
parent->next = current->next;
if (header->last == current) header->last = parent;
col_delete_item(current);
header->count--;
}
/* Now add item according to the disposition */
break;
case COL_INSERT_DUPMOVET: /* Find item and delete */
TRACE_INFO_STRING("Property:", item->property);
TRACE_INFO_NUMBER("Type:", item->type);
if (col_find_property(collection, item->property, 0, 1, item->type, &parent)) {
TRACE_INFO_LNUMBER("Current:", parent->next);
current = parent->next;
parent->next = current->next;
if (header->last == current) header->last = parent;
col_delete_item(current);
header->count--;
}
/* Now add item according to the disposition */
break;
default: /* The new ones should be added here */
TRACE_ERROR_NUMBER("Flag is not implemented", ENOSYS);
return ENOSYS;
}
switch (disposition) {
case COL_DSP_END: /* Link new item to the last item in the list if there any */
if (header->count != 0) header->last->next = item;
/* Make sure we save a new last element */
header->last = item;
header->count++;
break;
case COL_DSP_FRONT: /* Same as above if there is header only */
if (header->count == 1) {
header->last->next = item;
header->last = item;
}
else {
item->next = collection->next;
collection->next = item;
}
header->count++;
break;
case COL_DSP_BEFORE: /* Check argument */
if (!refprop) {
TRACE_ERROR_STRING("In this case property is required", "");
return EINVAL;
}
/* We need to find property */
if (col_find_property(collection, refprop, 0, 0, 0, &parent)) {
item->next = parent->next;
parent->next = item;
header->count++;
}
else {
TRACE_ERROR_STRING("Property not found", refprop);
return ENOENT;
}
break;
case COL_DSP_AFTER: /* Check argument */
if (!refprop) {
TRACE_ERROR_STRING("In this case property is required", "");
return EINVAL;
}
/* We need to find property */
if (col_find_property(collection, refprop, 0, 0, 0, &parent)) {
parent = parent->next;
if (parent->next) {
/* It is not the last item */
item->next = parent->next;
parent->next = item;
}
else {
/* It is the last item */
header->last->next = item;
header->last = item;
}
header->count++;
}
else {
TRACE_ERROR_STRING("Property not found", refprop);
return ENOENT;
}
break;
case COL_DSP_INDEX: if(idx == 0) {
/* Same is first */
if (header->count == 1) {
header->last->next = item;
header->last = item;
}
else {
item->next = collection->next;
collection->next = item;
}
}
else if(idx >= header->count - 1) {
/* In this case add to the end */
header->last->next = item;
/* Make sure we save a new last element */
header->last = item;
}
else {
/* In the middle */
parent = collection;
/* Move to the right position counting */
while (idx > 0) {
idx--;
if (parent->next) parent = parent->next;
}
item->next = parent->next;
parent->next = item;
}
header->count++;
break;
case COL_DSP_FIRSTDUP:
case COL_DSP_LASTDUP:
case COL_DSP_NDUP:
case COL_DSP_LASTDUPNS:
case COL_DSP_NDUPNS:
if (disposition == COL_DSP_FIRSTDUP) refindex = 0;
else if ((disposition == COL_DSP_LASTDUP) ||
(disposition == COL_DSP_LASTDUPNS))
refindex = -1;
else refindex = idx;
/* We need to find property based on index */
if (col_find_property_sub(collection,
NULL,
INTERRUPT(disposition),
item->property,
refindex,
0,
0,
0,
&parent)) {
item->next = parent->next;
parent->next = item;
header->count++;
if(header->last == parent) header->last = item;
}
else {
TRACE_ERROR_STRING("Property not found", refprop);
return ENOENT;
}
break;
default:
TRACE_ERROR_STRING("Disposition is not implemented", "");
return ENOSYS;
}
TRACE_INFO_STRING("Collection:", collection->property);
TRACE_INFO_STRING("Just added item is:", item->property);
TRACE_INFO_NUMBER("Item type.", item->type);
TRACE_INFO_NUMBER("Number of items in collection now is.", header->count);
TRACE_FLOW_STRING("col_insert_item_into_current", "Exit");
return EOK;
}
/* Extract item from the current collection */
int col_extract_item_from_current(struct collection_item *collection,
int disposition,
const char *refprop,
int idx,
int type,
struct collection_item **ret_ref)
{
struct collection_header *header = NULL;
struct collection_item *parent = NULL;
struct collection_item *current = NULL;
struct collection_item *found = NULL;
int refindex = 0;
int use_type = 0;
TRACE_FLOW_STRING("col_extract_item_from_current", "Entry point");
/* Check that collection is not empty */
if ((collection == NULL) || (collection->type != COL_TYPE_COLLECTION)) {
TRACE_ERROR_STRING("Collection can't be NULL", "");
return EINVAL;
}
header = (struct collection_header *)collection->data;
/* Before moving forward we need to check if there is anything to extract */
if (header->count <= 1) {
TRACE_ERROR_STRING("Collection is empty.", "Nothing to extract.");
return ENOENT;
}
if (type != 0) use_type = 1;
switch (disposition) {
case COL_DSP_END: /* Extract last item in the list. */
parent = collection;
current = collection->next;
while (current->next != NULL) {
parent = current;
current = current->next;
}
*ret_ref = parent->next;
parent->next = NULL;
/* Special case - one data element */
if (header->count == 2) header->last = collection;
else header->last = parent;
break;
case COL_DSP_FRONT: /* Extract first item in the list */
*ret_ref = collection->next;
collection->next = (*ret_ref)->next;
/* Special case - one data element */
if (header->count == 2) header->last = collection;
break;
case COL_DSP_BEFORE: /* Check argument */
if (!refprop) {
TRACE_ERROR_STRING("In this case property is required", "");
return EINVAL;
}
/* We have to do it in two steps */
/* First find the property that is mentioned */
if (col_find_property(collection, refprop, 0, use_type, type, &found)) {
/* We found the requested property */
if (found->next == collection->next) {
/* The referenced property is the first in the list */
TRACE_ERROR_STRING("Nothing to extract. Lists starts with property", refprop);
return ENOENT;
}
/* Get to the parent of the item that is before the one that is found */
parent = collection;
current = collection->next;
while (current != found) {
parent = current;
current = current->next;
}
*ret_ref = current;
parent->next = current->next;
}
else {
TRACE_ERROR_STRING("Property not found", refprop);
return ENOENT;
}
break;
case COL_DSP_AFTER: /* Check argument */
if (!refprop) {
TRACE_ERROR_STRING("In this case property is required", "");
return EINVAL;
}
/* We need to find property */
if (col_find_property(collection, refprop, 0, use_type, type, &parent)) {
current = parent->next;
if (current->next) {
*ret_ref = current->next;
current->next = (*ret_ref)->next;
/* If we removed the last element adjust header */
if(current->next == NULL) header->last = current;
}
else {
TRACE_ERROR_STRING("Property is last in the list", refprop);
return ENOENT;
}
}
else {
TRACE_ERROR_STRING("Property not found", refprop);
return ENOENT;
}
break;
case COL_DSP_INDEX: if (idx == 0) {
*ret_ref = collection->next;
collection->next = (*ret_ref)->next;
/* Special case - one data element */
if (header->count == 2) header->last = collection;
}
/* Index 0 stands for the first data element.
* Count includes header element.
*/
else if (idx >= (header->count - 1)) {
TRACE_ERROR_STRING("Index is out of boundaries", refprop);
return ENOENT;
}
else {
/* Loop till the element with right index */
refindex = 0;
parent = collection;
current = collection->next;
while (refindex < idx) {
parent = current;
current = current->next;
refindex++;
}
*ret_ref = parent->next;
parent->next = (*ret_ref)->next;
/* If we removed the last element adjust header */
if (parent->next == NULL) header->last = parent;
}
break;
case COL_DSP_FIRSTDUP:
case COL_DSP_LASTDUP:
case COL_DSP_NDUP:
case COL_DSP_LASTDUPNS:
case COL_DSP_NDUPNS:
if (disposition == COL_DSP_FIRSTDUP) refindex = 0;
else if ((disposition == COL_DSP_LASTDUP) ||
(disposition == COL_DSP_LASTDUPNS))
refindex = -2;
else refindex = idx;
/* We need to find property based on index */
if (col_find_property_sub(collection,
NULL,
INTERRUPT(disposition),
refprop,
refindex,
1,
use_type,
type,
&parent)) {
*ret_ref = parent->next;
parent->next = (*ret_ref)->next;
/* If we removed the last element adjust header */
if(parent->next == NULL) header->last = parent;
}
else {
TRACE_ERROR_STRING("Property not found", refprop);
return ENOENT;
}
break;
default:
TRACE_ERROR_STRING("Disposition is not implemented", "");
return ENOSYS;
}
/* Clear item and reduce count */
(*ret_ref)->next = NULL;
header->count--;
TRACE_INFO_STRING("Collection:", (*ret_ref)->property);
TRACE_INFO_NUMBER("Item type.", (*ret_ref)->type);
TRACE_INFO_NUMBER("Number of items in collection now is.", header->count);
TRACE_FLOW_STRING("col_extract_item_from_current", "Exit");
return EOK;
}
/* Extract item from the collection */
int col_extract_item(struct collection_item *collection,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
int type,
struct collection_item **ret_ref)
{
struct collection_item *col = NULL;
int error = EOK;
TRACE_FLOW_STRING("col_extract_item", "Entry point");
/* Check that collection is not empty */
if ((collection == NULL) || (collection->type != COL_TYPE_COLLECTION)) {
TRACE_ERROR_STRING("Collection can't be NULL", "");
return EINVAL;
}
/* Get subcollection if needed */
if (subcollection == NULL) {
col = collection;
}
else {
TRACE_INFO_STRING("Subcollection id not null, searching", subcollection);
error = col_find_item_and_do(collection, subcollection,
COL_TYPE_COLLECTIONREF,
COL_TRAVERSE_DEFAULT,
col_get_subcollection, (void *)(&col),
COLLECTION_ACTION_FIND);
if (error) {
TRACE_ERROR_NUMBER("Search for subcollection returned error:", error);
return error;
}
if (col == NULL) {
TRACE_ERROR_STRING("Search for subcollection returned NULL pointer", "");
return ENOENT;
}
}
/* Extract from the current collection */
error = col_extract_item_from_current(col,
disposition,
refprop,
idx,
type,
ret_ref);
if (error) {
TRACE_ERROR_NUMBER("Failed to extract item from the current collection", error);
return error;
}
TRACE_FLOW_STRING("col_extract_item", "Exit");
return EOK;
}
/* Remove item (property) from collection with callback.*/
int col_remove_item_with_cb(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
int type,
col_item_cleanup_fn cb,
void *custom_data)
{
int error = EOK;
struct collection_item *ret_ref = NULL;
TRACE_FLOW_STRING("col_remove_item", "Enter");
/* Extract from the current collection */
error = col_extract_item(ci,
subcollection,
disposition,
refprop,
idx,
type,
&ret_ref);
if (error) {
TRACE_ERROR_NUMBER("Failed to extract item from the collection", error);
return error;
}
col_delete_item_with_cb(ret_ref, cb, custom_data);
TRACE_FLOW_STRING("col_remove_item", "Exit");
return EOK;
}
/* Remove item (property) from collection.*/
int col_remove_item(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
int type)
{
return col_remove_item_with_cb(ci,
subcollection,
disposition,
refprop,
idx,
type,
NULL,
NULL);
}
/* Remove item (property) from current collection.
* Just a simple wrapper.
*/
int col_remove_item_from_current(struct collection_item *ci,
int disposition,
const char *refprop,
int idx,
int type)
{
int error = EOK;
TRACE_FLOW_STRING("col_remove_item_from_current", "Exit");
/* Remove item from current collection */
error = col_remove_item(ci,
NULL,
disposition,
refprop,
idx,
type);
TRACE_FLOW_NUMBER("col_remove_item_from_current. Exit. Returning", error);
return error;
}
/* Insert the item into the collection or subcollection */
int col_insert_item(struct collection_item *collection,
const char *subcollection,
struct collection_item *item,
int disposition,
const char *refprop,
int idx,
unsigned flags)
{
int error;
struct collection_item *acceptor = NULL;
TRACE_FLOW_STRING("col_insert_item", "Entry point.");
/* Do best effort on the item */
if ((!item) || (item->next)) {
TRACE_ERROR_STRING("Passed in item is invalid", "");
return EINVAL;
}
/* Check that collection is not empty */
if ((collection == NULL) && (item->type != COL_TYPE_COLLECTION)) {
TRACE_ERROR_STRING("Collection can't be NULL", "");
return EINVAL;
}
/* Add item to collection */
if (subcollection == NULL) {
acceptor = collection;
}
else {
TRACE_INFO_STRING("Subcollection id not null, searching", subcollection);
error = col_find_item_and_do(collection, subcollection,
COL_TYPE_COLLECTIONREF,
COL_TRAVERSE_DEFAULT,
col_get_subcollection, (void *)(&acceptor),
COLLECTION_ACTION_FIND);
if (error) {
TRACE_ERROR_NUMBER("Search for subcollection returned error:", error);
return error;
}
if (acceptor == NULL) {
TRACE_ERROR_STRING("Search for subcollection returned NULL pointer", "");
return ENOENT;
}
}
/* Instert item to the current collection */
error = col_insert_item_into_current(acceptor,
item,
disposition,
refprop,
idx,
flags);
if (error) {
TRACE_ERROR_NUMBER("Failed to insert item into current collection", error);
return error;
}
TRACE_FLOW_STRING("insert_item", "Exit");
return EOK;
}
/* Insert property with reference.
* This is internal function so we do not check parameters.
* See external wrapper below.
*/
static int col_insert_property_with_ref_int(struct collection_item *collection,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int type,
const void *data,
int length,
struct collection_item **ret_ref)
{
struct collection_item *item = NULL;
int error;
TRACE_FLOW_STRING("col_insert_property_with_ref_int", "Entry point.");
/* Create a new property out of the given parameters */
error = col_allocate_item(&item, property, data, length, type);
if (error) {
TRACE_ERROR_NUMBER("Failed to allocate item", error);
return error;
}
/* Send the property to the insert_item function */
error = col_insert_item(collection,
subcollection,
item,
disposition,
refprop,
idx,
flags);
if (error) {
TRACE_ERROR_NUMBER("Failed to insert item", error);
col_delete_item(item);
return error;
}
if (ret_ref) *ret_ref = item;
TRACE_FLOW_STRING("col_insert_property_with_ref_int", "Exit");
return EOK;
}
/* Special function used to copy item from one
* collection to another using caller's callback.
*/
static int col_copy_item_with_cb(struct collection_item *collection,
const char *property,
int type,
const void *data,
int length,
col_copy_cb copy_cb,
void *ext_data)
{
struct collection_item *item = NULL;
int skip = 0;
int error = EOK;
TRACE_FLOW_STRING("col_copy_item_with_cb", "Entry point.");
/* Create a new property out of the given parameters */
error = col_allocate_item(&item, property, data, length, type);
if (error) {
TRACE_ERROR_NUMBER("Failed to allocate item", error);
return error;
}
/* Call callback if any */
if (copy_cb) {
TRACE_INFO_STRING("Calling callback for item:", item->property);
error = copy_cb(item, ext_data, &skip);
if (error) {
TRACE_ERROR_NUMBER("Callback failed", error);
col_delete_item(item);
return error;
}
}
/* Are we told to skip this item? */
if (skip) col_delete_item(item);
else {
/* Insted property into the collection */
error = col_insert_item(collection,
NULL,
item,
COL_DSP_END,
NULL,
0,
0);
if (error) {
TRACE_ERROR_NUMBER("Failed to insert item", error);
col_delete_item(item);
return error;
}
}
TRACE_FLOW_STRING("col_copy_item_with_cb", "Exit");
return EOK;
}
/* This is public function so we need to check the validity
* of the arguments.
*/
int col_insert_property_with_ref(struct collection_item *collection,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int type,
const void *data,
int length,
struct collection_item **ret_ref)
{
int error;
TRACE_FLOW_STRING("col_insert_property_with_ref", "Entry point.");
/* Check that collection is not empty */
if (collection == NULL) {
TRACE_ERROR_STRING("Collection cant be NULL", "");
return EINVAL;
}
error = col_insert_property_with_ref_int(collection,
subcollection,
disposition,
refprop,
idx,
flags,
property,
type,
data,
length,
ret_ref);
TRACE_FLOW_NUMBER("col_insert_property_with_ref_int Returning:", error);
return error;
}
/* TRAVERSE HANDLERS */
/* Special handler to just set a flag if the item is found */
static int col_is_in_item_handler(const char *property,
int property_len,
int type,
void *data,
int length,
void *found,
int *dummy)
{
TRACE_FLOW_STRING("col_is_in_item_handler", "Entry.");
TRACE_INFO_STRING("Property:", property);
TRACE_INFO_NUMBER("Property length:", property_len);
TRACE_INFO_NUMBER("Type:", type);
TRACE_INFO_NUMBER("Length:", length);
*((int *)(found)) = COL_MATCH;
TRACE_FLOW_STRING("col_is_in_item_handler", "Success Exit.");
return EOK;
}
/* Special handler to retrieve the sub collection */
static int col_get_subcollection(const char *property,
int property_len,
int type,
void *data,
int length,
void *found,
int *dummy)
{
TRACE_FLOW_STRING("col_get_subcollection", "Entry.");
TRACE_INFO_STRING("Property:", property);
TRACE_INFO_NUMBER("Property length:", property_len);
TRACE_INFO_NUMBER("Type:", type);
TRACE_INFO_NUMBER("Length:", length);
*((struct collection_item **)(found)) = *((struct collection_item **)(data));
TRACE_FLOW_STRING("col_get_subcollection","Success Exit.");
return EOK;
}
/* CLEANUP */
/* Cleans the collection tree including current item. */
/* The passed in variable should not be used after the call
* as memory is freed!!! */
static void col_delete_collection(struct collection_item *ci,
col_item_cleanup_fn cb,
void *custom_data)
{
TRACE_FLOW_STRING("col_delete_collection", "Entry.");
if (ci == NULL) {
TRACE_FLOW_STRING("col_delete_collection", "Nothing to do Exit.");
return;
}
TRACE_INFO_STRING("Real work to do", "");
TRACE_INFO_STRING("Property", ci->property);
TRACE_INFO_NUMBER("Next item", ci->next);
col_delete_collection(ci->next, cb, custom_data);
/* Delete this item */
col_delete_item_with_cb(ci, cb, custom_data);
TRACE_FLOW_STRING("col_delete_collection", "Exit.");
}
/* NAME MANAGEMENT - used by search */
/* Internal data structures used for search */
struct find_name {
const char *name_to_find;
int name_len_to_find;
uint64_t hash;
int type_to_match;
char *given_name;
int given_len;
struct path_data *current_path;
int action;
};
/* Create a new name */
static int col_create_path_data(struct path_data **name_path,
const char *name, int length,
const char *property, int property_len,
char sep)
{
int error = EOK;
struct path_data *new_name_path;
TRACE_FLOW_STRING("col_create_path_data", "Entry.");
TRACE_INFO_STRING("Constructing path from name:", name);
TRACE_INFO_STRING("Constructing path from property:", property);
/* Allocate structure */
new_name_path = (struct path_data *)malloc(sizeof(struct path_data));
if (new_name_path == NULL) {
TRACE_ERROR_NUMBER("Failed to allocate memory for new path struct.", ENOMEM);
return ENOMEM;
}
new_name_path->name = malloc(length + property_len + 2);
if (new_name_path->name == NULL) {
TRACE_ERROR_NUMBER("Failed to allocate memory for new path name.", ENOMEM);
free(new_name_path);
return ENOMEM;
}
/* Construct the new name */
new_name_path->length = 0;
if(length > 0) {
memcpy(new_name_path->name, name, length);
new_name_path->length = length;
new_name_path->name[new_name_path->length] = sep;
new_name_path->length++;
new_name_path->name[new_name_path->length] = '\0';
TRACE_INFO_STRING("Name so far:", new_name_path->name);
TRACE_INFO_NUMBER("Len so far:", new_name_path->length);
}
memcpy(&new_name_path->name[new_name_path->length], property, property_len);
new_name_path->length += property_len;
new_name_path->name[new_name_path->length] = '\0';
/* Link to the chain */
new_name_path->previous_path = *name_path;
*name_path = new_name_path;
TRACE_INFO_STRING("Constructed path", new_name_path->name);
TRACE_FLOW_NUMBER("col_create_path_data. Returning:", error);
return error;
}
/* Matching item name and type */
static int col_match_item(struct collection_item *current,
struct find_name *traverse_data)
{
const char *find_str;
const char *start;
const char *data_str;
TRACE_FLOW_STRING("col_match_item", "Entry");
if (traverse_data->type_to_match & current->type) {
/* Check if there is any value to match */
if ((traverse_data->name_to_find == NULL) ||
(*(traverse_data->name_to_find) == '\0')) {
TRACE_INFO_STRING("col_match_item",
"Returning MATCH because there is no search criteria!");
return COL_MATCH;
}
/* Check the hashes - if they do not match return */
if (traverse_data->hash != current->phash) {
TRACE_INFO_STRING("col_match_item","Returning NO match!");
return COL_NOMATCH;
}
/* We will do the actual string comparison only if the hashes matched */
/* Start comparing the two strings from the end */
find_str = traverse_data->name_to_find + traverse_data->name_len_to_find;
start = current->property;
data_str = start + current->property_len;
TRACE_INFO_STRING("Searching for:", traverse_data->name_to_find);
TRACE_INFO_STRING("Item name:", current->property);
TRACE_INFO_STRING("Current path:", traverse_data->current_path->name);
TRACE_INFO_NUMBER("Searching:", toupper(*find_str));
TRACE_INFO_NUMBER("Have:", toupper(*data_str));
/* We start pointing to 0 so the loop will be executed at least once */
while (toupper(*data_str) == toupper(*find_str)) {
TRACE_INFO_STRING("Loop iteration:","");
if (data_str == start) {
if (find_str > traverse_data->name_to_find) {
if (*(find_str-1) == '!') {
/* We matched the property but the search string is
* longer so we need to continue matching */
TRACE_INFO_STRING("col_match_item",
"Need to continue matching");
start = traverse_data->current_path->name;
data_str = &start[traverse_data->current_path->length - 1];
find_str -= 2;
continue;
}
else {
TRACE_INFO_STRING("col_match_item","Returning NO match!");
return COL_NOMATCH;
}
}
else {
TRACE_INFO_STRING("col_match_item","Returning MATCH!");
return COL_MATCH;
}
}
else if ((find_str == traverse_data->name_to_find) &&
(*(data_str-1) == '!')) return COL_MATCH;
data_str--;
find_str--;
TRACE_INFO_NUMBER("Searching:", toupper(*find_str));
TRACE_INFO_NUMBER("Have:", toupper(*data_str));
}
}
TRACE_FLOW_STRING("col_match_item","Returning NO match!");
return COL_NOMATCH;
}
/* Function to delete the data that contains search path */
static void col_delete_path_data(struct path_data *path)
{
TRACE_FLOW_STRING("col_delete_path_data","Entry.");
if (path != NULL) {
TRACE_INFO_STRING("col_delete_path_data", "Item to delete exits.");
if (path->previous_path != NULL) {
TRACE_INFO_STRING("col_delete_path_data",
"But previous item to delete exits to. Nesting.");
col_delete_path_data(path->previous_path);
}
if (path->name != NULL) {
TRACE_INFO_STRING("col_delete_path_data Deleting path:", path->name);
free(path->name);
}
TRACE_INFO_STRING("col_delete_path_data", "Deleting path element");
free(path);
}
TRACE_FLOW_STRING("col_delete_path_data", "Exit");
}
/* MAIN TRAVERSAL FUNCTION */
/* Internal function to walk collection */
/* For each item walked it will call traverse handler.
Traverse handler accepts: current item,
user provided item handler and user provided custom data. */
/* See below different traverse handlers for different cases */
static int col_walk_items(struct collection_item *ci,
int mode_flags,
internal_item_fn traverse_handler,
void *traverse_data,
col_item_fn user_item_handler,
void *custom_data,
unsigned *depth)
{
struct collection_item *current;
struct collection_item *parent = NULL;
struct collection_item *sub;
int stop = 0;
int error = EOK;
TRACE_FLOW_STRING("col_walk_items", "Entry.");
TRACE_INFO_NUMBER("Mode flags:", mode_flags);
/* Increase depth */
/* NOTE: The depth is increased at the entry to the function.
* and decreased right before the exit so it is safe to decrease it.
*/
(*depth)++;
current = ci;
while (current) {
TRACE_INFO_STRING("Processing item:", current->property);
TRACE_INFO_NUMBER("Item type:", current->type);
if (current->type == COL_TYPE_COLLECTIONREF) {
TRACE_INFO_STRING("Subcollection:", current->property);
if ((mode_flags & COL_TRAVERSE_IGNORE) == 0) {
TRACE_INFO_STRING("Subcollection is not ignored.", "");
/* We are not ignoring sub collections */
if ((mode_flags & COL_TRAVERSE_FLAT) == 0) {
TRACE_INFO_STRING("Subcollection is not flattened.", "");
/* We are not flattening sub collections.
* The flattening means that we are not going
* to return reference and headers for sub collections.
* We will also not do special end collection
* invocation for sub collections.
*/
error = traverse_handler(ci, parent, current, traverse_data,
user_item_handler, custom_data, &stop);
if (stop != 0) {
TRACE_INFO_STRING("Traverse handler returned STOP.", "");
error = EINTR_INTERNAL;
}
/* Check what error we got */
if (error == EINTR_INTERNAL) {
TRACE_FLOW_NUMBER("Internal error - means we are stopping.", error);
(*depth)--;
return error;
}
else if (error) {
TRACE_ERROR_NUMBER("Traverse handler returned error.", error);
(*depth)--;
return error;
}
}
if ((mode_flags & COL_TRAVERSE_ONELEVEL) == 0) {
TRACE_INFO_STRING("Before diving into sub collection","");
sub = *((struct collection_item **)(current->data));
TRACE_INFO_STRING("Sub collection name", sub->property);
TRACE_INFO_NUMBER("Header type", sub->type);
/* We need to go into sub collections */
error = col_walk_items(sub, mode_flags,
traverse_handler, traverse_data,
user_item_handler, custom_data,
depth);
TRACE_INFO_STRING("Returned from sub collection processing", "");
TRACE_INFO_STRING("Done processing item:", current->property);
TRACE_INFO_NUMBER("Done processing item type:", current->type);
}
}
}
else {
/* Check if it is a header and we are not on the root level.
* If we are flattening collection we need to skip headers
* for sub collections.
*/
/* Call handler if:
* a) It is not collection header
* OR
* b) It is header we are flattening but we are on top level
* OR
* c) It is header and we are not flattening.
*/
if ((current->type != COL_TYPE_COLLECTION) ||
(((mode_flags & COL_TRAVERSE_FLAT) != 0) && (*depth == 1)) ||
((mode_flags & COL_TRAVERSE_FLAT) == 0)) {
/* Call handler then move on */
error = traverse_handler(ci, parent, current,
traverse_data, user_item_handler,
custom_data, &stop);
}
}
/* If we are stopped - return EINTR_INTERNAL */
if (stop != 0) {
TRACE_INFO_STRING("Traverse handler returned STOP.", "");
error = EINTR_INTERNAL;
}
/* Check what error we got */
if (error == EINTR_INTERNAL) {
TRACE_FLOW_NUMBER("Internal error - means we are stopping.", error);
(*depth)--;
return error;
}
else if (error) {
TRACE_ERROR_NUMBER("Traverse handler returned error.", error);
(*depth)--;
return error;
}
TRACE_INFO_NUMBER("Next element", current->next);
parent = current;
current = current->next;
}
TRACE_INFO_STRING("Out of loop", "");
/* Check if we need to have a special
* call at the end of the collection.
*/
if ((mode_flags & COL_TRAVERSE_END) != 0) {
/* Do this dummy invocation only:
* a) If we are flattening and on the root level
* b) We are not flattening
*/
if ((((mode_flags & COL_TRAVERSE_FLAT) != 0) && (*depth == 1)) ||
((mode_flags & COL_TRAVERSE_FLAT) == 0)) {
TRACE_INFO_STRING("About to do the special end collection invocation of handler", "");
error = traverse_handler(ci, parent, current,
traverse_data, user_item_handler,
custom_data, &stop);
}
}
TRACE_FLOW_NUMBER("col_walk_items. Returns: ", error);
(*depth)--;
return error;
}
/* ACTION */
/* Find an item by property name and perform an action on it. */
/* No pattern matching supported in the first implementation. */
/* To refer to child properties use notatation like this: */
/* parent!child!subchild!subsubchild etc. */
static int col_find_item_and_do(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
col_item_fn item_handler,
void *custom_data,
int action)
{
int error = EOK;
struct find_name *traverse_data = NULL;
unsigned depth = 0;
int count = 0;
const char *last_part;
char *sep;
TRACE_FLOW_STRING("col_find_item_and_do", "Entry.");
/* Item handler is always required */
if ((item_handler == NULL) &&
(action == COLLECTION_ACTION_FIND)) {
TRACE_ERROR_NUMBER("No item handler - returning error!", EINVAL);
return EINVAL;
}
/* Collection is requered */
if (ci == NULL) {
TRACE_ERROR_NUMBER("No collection to search!", EINVAL);
return EINVAL;
}
/* Make sure that there is anything to search */
type &= COL_TYPE_ANY;
if ((type == 0) &&
((property_to_find == NULL) ||
((property_to_find != NULL) && (*property_to_find == '\0')))) {
TRACE_ERROR_NUMBER("No item search criteria specified - returning error!", ENOENT);
return ENOENT;
}
/* Prepare data for traversal */
traverse_data = (struct find_name *)malloc(sizeof(struct find_name));
if (traverse_data == NULL) {
TRACE_ERROR_NUMBER("Failed to allocate traverse data memory - returning error!", ENOMEM);
return ENOMEM;
}
TRACE_INFO_STRING("col_find_item_and_do", "Filling in traverse data.");
traverse_data->name_to_find = property_to_find;
if (property_to_find != NULL) {
traverse_data->name_len_to_find = strlen(property_to_find);
/* Check if the search string ends with "!" - this is illegal */
if (traverse_data->name_to_find[traverse_data->name_len_to_find - 1] == '!') {
TRACE_ERROR_NUMBER("Search string is invalid.", EINVAL);
free(traverse_data);
return EINVAL;
}
/* Find last ! if any */
sep = strrchr(traverse_data->name_to_find, '!');
if (sep != NULL) {
sep++;
last_part = sep;
}
else last_part = traverse_data->name_to_find;
TRACE_INFO_STRING("Last item", last_part);
/* Create hash of the last part */
traverse_data->hash = FNV1a_base;
/* Create hash of the string to search */
while(last_part[count] != 0) {
traverse_data->hash = traverse_data->hash ^ toupper(last_part[count]);
traverse_data->hash *= FNV1a_prime;
count++;
}
}
else {
/* We a looking for a first element of a given type */
TRACE_INFO_STRING("No search string", "");
traverse_data->name_len_to_find = 0;
}
traverse_data->type_to_match = type;
traverse_data->given_name = NULL;
traverse_data->given_len = 0;
traverse_data->current_path = NULL;
traverse_data->action = action;
mode_flags |= COL_TRAVERSE_END;
TRACE_INFO_STRING("col_find_item_and_do", "About to walk the tree.");
TRACE_INFO_NUMBER("Traverse flags", mode_flags);
error = col_walk_items(ci, mode_flags, col_act_traverse_handler,
(void *)traverse_data, item_handler, custom_data,
&depth);
if (traverse_data->current_path != NULL) {
TRACE_INFO_STRING("find_item_and_do",
"Path was not cleared - deleting");
col_delete_path_data(traverse_data->current_path);
}
free(traverse_data);
if (error && (error != EINTR_INTERNAL)) {
TRACE_ERROR_NUMBER("Walk items returned error. Returning: ", error);
return error;
}
else {
TRACE_FLOW_STRING("Walk items returned SUCCESS.", "");
return EOK;
}
}
/* Function to replace data in the item */
static int col_update_current_item(struct collection_item *current,
struct update_property *update_data)
{
TRACE_FLOW_STRING("col_update_current_item", "Entry");
/* If type is different or same but it is string or binary we need to
* replace the storage */
if ((current->type != update_data->type) ||
((current->type == update_data->type) &&
((current->type == COL_TYPE_STRING) ||
(current->type == COL_TYPE_BINARY)))) {
TRACE_INFO_STRING("Replacing item data buffer", "");
free(current->data);
current->data = malloc(update_data->length);
if (current->data == NULL) {
TRACE_ERROR_STRING("Failed to allocate memory", "");
current->length = 0;
return ENOMEM;
}
current->length = update_data->length;
}
TRACE_INFO_STRING("Overwriting item data", "");
memcpy(current->data, update_data->data, current->length);
current->type = update_data->type;
if (current->type == COL_TYPE_STRING)
((char *)(current->data))[current->length-1] = '\0';
TRACE_FLOW_STRING("update_current_item", "Exit");
return EOK;
}
/* TRAVERSE CALLBACKS */
/* Traverse handler for simple traverse function */
/* Handler must be able to deal with NULL current item */
static int col_simple_traverse_handler(struct collection_item *head,
struct collection_item *previous,
struct collection_item *current,
void *traverse_data,
col_item_fn user_item_handler,
void *custom_data,
int *stop)
{
int error = EOK;
struct collection_item end_item;
char zero = '\0';
TRACE_FLOW_STRING("col_simple_traverse_handler", "Entry.");
if (current == NULL) {
memset((void *)&end_item, 0, sizeof(struct collection_item));
end_item.type = COL_TYPE_END;
end_item.property = &zero;
current = &end_item;
}
error = user_item_handler(current->property,
current->property_len,
current->type,
current->data,
current->length,
custom_data,
stop);
TRACE_FLOW_NUMBER("col_simple_traverse_handler. Returning:", error);
return error;
}
/* Traverse handler for to find parent */
static int col_parent_traverse_handler(struct collection_item *head,
struct collection_item *previous,
struct collection_item *current,
void *traverse_data,
col_item_fn user_item_handler,
void *custom_data,
int *stop)
{
struct property_search *to_find;
int done = 0;
int match = 0;
TRACE_FLOW_STRING("col_parent_traverse_handler", "Entry.");
to_find = (struct property_search *)custom_data;
TRACE_INFO_NUMBER("Looking for HASH:", (unsigned)(to_find->hash));
TRACE_INFO_NUMBER("Current HASH:", (unsigned)(current->phash));
/* Check hashes first */
if(to_find->hash == current->phash) {
/* Check type if we are asked to use type */
if ((to_find->use_type) && (!(to_find->type & current->type))) {
TRACE_FLOW_STRING("parent_traverse_handler. Returning:","Exit. Hash is Ok, type is not");
return EOK;
}
/* Validate property. Make sure we include terminating 0 in the comparison */
if (strncasecmp(current->property, to_find->property, current->property_len + 1) == 0) {
match = 1;
to_find->found = 1;
/* Do the right thing based on index */
/* If index is 0 we are looking for the first value in the list of duplicate properties */
if (to_find->index == 0) done = 1;
/* If index is non zero we are looking for N-th instance of the dup property */
else if (to_find->index > 0) {
if (to_find->count == to_find->index) done = 1;
else {
/* Record found instance and move on */
to_find->parent = previous;
(to_find->count)++;
}
}
/* If we are looking for last instance just record it */
else to_find->parent = previous;
}
}
if (done) {
*stop = 1;
*((struct collection_item **)traverse_data) = previous;
}
else {
if (to_find->interrupt) {
/* As soon as we found first non matching one but there was a match
* return the parent of the last found item.
*/
if (((!match) || (current->next == NULL)) &&
(to_find->index != 0) && (to_find->found)) {
*stop = 1;
if (to_find->index == -2)
*((struct collection_item **)traverse_data) =
to_find->parent;
else
if (to_find->exact) {
/* This means that we need to match the exact
* index but we did not */
to_find->parent = NULL;
to_find->found = 0;
}
else
*((struct collection_item **)traverse_data) =
to_find->parent->next;
}
}
else if ((current->next == NULL) && (to_find->found)) {
*stop = 1;
if (to_find->index == -2)
*((struct collection_item **)traverse_data) =
to_find->parent;
else
if (to_find->exact) {
/* This means that we need to match the exact
* index but we did not */
to_find->parent = NULL;
to_find->found = 0;
}
else
*((struct collection_item **)traverse_data) =
to_find->parent->next;
}
}
TRACE_FLOW_STRING("col_parent_traverse_handler. Returning:","Exit");
return EOK;
}
/* Traverse callback for find & delete function */
static int col_act_traverse_handler(struct collection_item *head,
struct collection_item *previous,
struct collection_item *current,
void *passed_traverse_data,
col_item_fn user_item_handler,
void *custom_data,
int *stop)
{
int error = EOK;
struct find_name *traverse_data = NULL;
char *name;
int length;
struct path_data *temp;
struct collection_header *header;
char *property;
int property_len;
struct update_property *update_data;
TRACE_FLOW_STRING("col_act_traverse_handler", "Entry.");
traverse_data = (struct find_name *)passed_traverse_data;
/* We can be called when current points to NULL */
if (current == NULL) {
TRACE_INFO_STRING("col_act_traverse_handler",
"Special call at the end of the collection.");
temp = traverse_data->current_path;
traverse_data->current_path = temp->previous_path;
temp->previous_path = NULL;
col_delete_path_data(temp);
traverse_data->given_name = NULL;
traverse_data->given_len = 0;
TRACE_FLOW_NUMBER("Handling end of collection - removed path. Returning:", error);
return error;
}
/* Create new path at the beginning of a new sub collection */
if (current->type == COL_TYPE_COLLECTION) {
TRACE_INFO_STRING("col_act_traverse_handler",
"Processing collection handle.");
/* Create new path */
if (traverse_data->current_path != NULL) {
TRACE_INFO_STRING("Already have part of the path", "");
name = traverse_data->current_path->name;
length = traverse_data->current_path->length;
TRACE_INFO_STRING("Path:", name);
TRACE_INFO_NUMBER("Path len:", length);
}
else {
name = NULL;
length = 0;
}
if (traverse_data->given_name != NULL) {
property = traverse_data->given_name;
property_len = traverse_data->given_len;
}
else {
property = current->property;
property_len = current->property_len;
}
TRACE_INFO_STRING("col_act_traverse_handler", "About to create path data.");
error = col_create_path_data(&(traverse_data->current_path),
name, length,
property, property_len, '!');
TRACE_INFO_NUMBER("col_create_path_data returned:", error);
return error;
}
/* Handle the collection pointers */
if (current->type == COL_TYPE_COLLECTIONREF) {
traverse_data->given_name = current->property;
traverse_data->given_len = current->property_len;
TRACE_INFO_STRING("Saved given name:", traverse_data->given_name);
}
TRACE_INFO_STRING("Processing item with property:", current->property);
/* Do here what we do with items */
if (col_match_item(current, traverse_data)) {
TRACE_INFO_STRING("Matched item:", current->property);
switch (traverse_data->action) {
case COLLECTION_ACTION_FIND:
TRACE_INFO_STRING("It is a find action - calling handler.", "");
if (user_item_handler != NULL) {
/* Call user handler */
error = user_item_handler(current->property,
current->property_len,
current->type,
current->data,
current->length,
custom_data,
stop);
TRACE_INFO_NUMBER("Handler returned:", error);
TRACE_INFO_NUMBER("Handler set STOP to:", *stop);
}
break;
case COLLECTION_ACTION_GET:
TRACE_INFO_STRING("It is a get action.", "");
if (custom_data != NULL)
*((struct collection_item **)(custom_data)) = current;
break;
case COLLECTION_ACTION_DEL:
TRACE_INFO_STRING("It is a delete action.", "");
/* Make sure we tell the caller we found a match */
if (custom_data != NULL)
*(int *)custom_data = COL_MATCH;
/* Adjust header of the collection */
header = (struct collection_header *)head->data;
header->count--;
if (current->next == NULL)
header->last = previous;
/* Unlink and delete iteam */
/* Previous can't be NULL here becuase we never delete
* header elements */
previous->next = current->next;
col_delete_item(current);
TRACE_INFO_STRING("Did the delete of the item.", "");
break;
case COLLECTION_ACTION_UPDATE:
TRACE_INFO_STRING("It is an update action.", "");
if((current->type == COL_TYPE_COLLECTION) ||
(current->type == COL_TYPE_COLLECTIONREF)) {
TRACE_ERROR_STRING("Can't update collections it is an error for now", "");
return EINVAL;
}
/* Make sure we tell the caller we found a match */
if (custom_data != NULL) {
update_data = (struct update_property *)custom_data;
update_data->found = COL_MATCH;
error = col_update_current_item(current, update_data);
}
else {
TRACE_ERROR_STRING("Error - update data is required", "");
return EINVAL;
}
TRACE_INFO_STRING("Did the delete of the item.", "");
break;
default:
break;
}
/* Force interrupt if we found */
*stop = 1;
}
TRACE_FLOW_NUMBER("col_act_traverse_handler returning", error);
return error;
}
/* Traverse handler for copy function */
static int col_copy_traverse_handler(struct collection_item *head,
struct collection_item *previous,
struct collection_item *current,
void *passed_traverse_data,
col_item_fn user_item_handler,
void *custom_data,
int *stop)
{
int error = EOK;
struct collection_item *parent;
struct collection_item *other = NULL;
struct col_copy *traverse_data;
struct path_data *temp;
char *name;
int length;
char *property = NULL;
int property_len;
struct collection_header *header;
char *offset;
TRACE_FLOW_STRING("col_copy_traverse_handler", "Entry.");
parent = (struct collection_item *)custom_data;
traverse_data = (struct col_copy *)passed_traverse_data;
/* We can be called when current points to NULL */
/* This will happen only in the FLATDOT case */
if (current == NULL) {
TRACE_INFO_STRING("col_copy_traverse_handler",
"Special call at the end of the collection.");
temp = traverse_data->current_path;
traverse_data->current_path = temp->previous_path;
temp->previous_path = NULL;
col_delete_path_data(temp);
traverse_data->given_name = NULL;
traverse_data->given_len = 0;
TRACE_FLOW_NUMBER("Handling end of collection - removed path. Returning:", error);
return error;
}
/* Create new path at the beginning of a new sub collection */
if (current->type == COL_TYPE_COLLECTION) {
TRACE_INFO_STRING("col_copy_traverse_handler",
"Processing collection handle.");
if (traverse_data->mode == COL_COPY_FLATDOT) {
/* Create new path */
if (traverse_data->current_path != NULL) {
TRACE_INFO_STRING("Already have part of the path", "");
name = traverse_data->current_path->name;
length = traverse_data->current_path->length;
TRACE_INFO_STRING("Path:", name);
TRACE_INFO_NUMBER("Path len:", length);
if (traverse_data->given_name != NULL) {
property = traverse_data->given_name;
property_len = traverse_data->given_len;
}
else {
property = current->property;
property_len = current->property_len;
}
}
else {
/* Do not create prefix for top collection
* if there is no given name.
*/
name = NULL;
length = 0;
if (traverse_data->given_name != NULL) {
property = traverse_data->given_name;
property_len = traverse_data->given_len;
}
else {
property = NULL;
property_len = 0;
}
}
TRACE_INFO_STRING("col_copy_traverse_handler", "About to create path data.");
error = col_create_path_data(&(traverse_data->current_path),
name, length,
property, property_len, '.');
TRACE_FLOW_NUMBER("col_copy_traverse_handler processed header:", error);
return error;
}
else {
TRACE_FLOW_NUMBER("col_copy_traverse_handler skipping the header:", error);
return error;
}
}
/* Check if this is a special case of sub collection */
if (current->type == COL_TYPE_COLLECTIONREF) {
TRACE_INFO_STRING("Found a subcollection we need to copy. Name:",
current->property);
/* Based on the mode we need to do different things */
switch (traverse_data->mode) {
case COL_COPY_NORMAL:
error = col_copy_collection_with_cb(&other,
*((struct collection_item **)(current->data)),
current->property,
COL_COPY_NORMAL,
traverse_data->copy_cb,
traverse_data->ext_data);
if (error) {
TRACE_ERROR_NUMBER("Copy subcollection returned error:", error);
return error;
}
/* Add new item to a collection
* all references are now sub collections */
error = col_insert_property_with_ref_int(parent,
NULL,
COL_DSP_END,
NULL,
0,
0,
current->property,
COL_TYPE_COLLECTIONREF,
(void *)(&other),
sizeof(struct collection_item **),
NULL);
TRACE_FLOW_NUMBER("col_copy_traverse_handler returning in NORMAL mode:", error);
return error;
case COL_COPY_KEEPREF:
/* Just increase reference count of the referenced collection */
other = *((struct collection_item **)(current->data));
header = (struct collection_header *)(other->data);
header->reference_count++;
/* Add new item to a collection
* all references are now sub collections */
error = col_insert_property_with_ref_int(parent,
NULL,
COL_DSP_END,
NULL,
0,
0,
current->property,
COL_TYPE_COLLECTIONREF,
(void *)(&other),
sizeof(struct collection_item **),
NULL);
TRACE_FLOW_NUMBER("col_copy_traverse_handler returning in KEEPREF mode:", error);
return error;
case COL_COPY_TOP:
/* Told to ignore sub collections */
TRACE_FLOW_NUMBER("col_copy_traverse_handler returning in TOP mode:", error);
return error;
case COL_COPY_FLATDOT:
traverse_data->given_name = current->property;
traverse_data->given_len = current->property_len;
TRACE_INFO_STRING("Saved given name:", traverse_data->given_name);
TRACE_FLOW_NUMBER("col_copy_traverse_handler returning in FLATDOT mode:", error);
return error;
/* NOTE: The mode COL_COPY_FLAT is not in the list of cases becuase
* in this flat mode we traverse collection using COL_TRAVERSE_FLAT flag
* thus we should not be called on referenced collections at all
* by the col_walk_items() function.
*/
default:
TRACE_ERROR_NUMBER("col_copy_traverse_handler bad mode error:", EINVAL);
return EINVAL;
}
}
else {
if (traverse_data->mode == COL_COPY_FLATDOT) {
/* Since this code can't use asprintf have to do it hard way */
property = malloc(traverse_data->current_path->length +
current->property_len + 2);
if (property == NULL) {
TRACE_ERROR_NUMBER("Failed to allocate memory for a new name:", error);
return error;
}
/* Add first part and dot only if we have prefix */
offset = property;
if (traverse_data->current_path->length) {
memcpy(offset, traverse_data->current_path->name,
traverse_data->current_path->length);
offset[traverse_data->current_path->length] = '.';
offset += traverse_data->current_path->length + 1;
}
memcpy(offset, current->property, current->property_len);
offset[current->property_len] = '\0';
}
else property = current->property;
TRACE_INFO_STRING("Using property:", property);
error = col_copy_item_with_cb(parent,
property,
current->type,
current->data,
current->length,
traverse_data->copy_cb,
traverse_data->ext_data);
/* Free property if we allocated it */
if (traverse_data->mode == COL_COPY_FLATDOT) free(property);
if (error) {
TRACE_ERROR_NUMBER("Failed to copy property:", error);
return error;
}
}
TRACE_FLOW_NUMBER("col_copy_traverse_handler returning", error);
return error;
}
/********************* MAIN INTERFACE FUNCTIONS *****************************/
/* CREATE */
/* Function that creates an named collection of a given class*/
int col_create_collection(struct collection_item **ci, const char *name,
unsigned cclass)
{
struct collection_item *handle = NULL;
struct collection_header header;
int error = EOK;
TRACE_FLOW_STRING("col_create_collection", "Entry.");
/* Prepare header */
header.last = NULL;
header.reference_count = 1;
header.count = 0;
header.cclass = cclass;
/* Create a collection type property */
error = col_insert_property_with_ref_int(NULL,
NULL,
COL_DSP_END,
NULL,
0,
0,
name,
COL_TYPE_COLLECTION,
&header,
sizeof(header),
&handle);
if (error) return error;
*ci = handle;
TRACE_FLOW_STRING("col_create_collection", "Success Exit.");
return EOK;
}
/* DESTROY */
/* Function that destroys a collection */
void col_destroy_collection_with_cb(struct collection_item *ci,
col_item_cleanup_fn cb,
void *custom_data)
{
struct collection_header *header;
TRACE_FLOW_STRING("col_destroy_collection_with_cb", "Entry.");
/* Do not try to delete NULL */
if (ci == NULL) return;
/* You can delete only whole collection not a part of it */
if (ci->type != COL_TYPE_COLLECTION) {
TRACE_ERROR_STRING("Attempt to delete a non collection - BAD!", "");
TRACE_ERROR_NUMBER("Actual type is:", ci->type);
return;
}
TRACE_INFO_STRING("Name:", ci->property);
/* Collection can be referenced by other collection */
header = (struct collection_header *)(ci->data);
TRACE_INFO_NUMBER("Reference count:", header->reference_count);
if (header->reference_count > 1) {
TRACE_INFO_STRING("Dereferencing a referenced collection.", "");
header->reference_count--;
TRACE_INFO_NUMBER("Number after dereferencing.",
header->reference_count);
}
else {
col_delete_collection(ci, cb, custom_data);
}
TRACE_FLOW_STRING("col_destroy_collection_with_cb", "Exit.");
}
/* Function that destroys a collection */
void col_destroy_collection(struct collection_item *ci)
{
TRACE_FLOW_STRING("col_destroy_collection", "Entry.");
col_destroy_collection_with_cb(ci, NULL, NULL);
TRACE_FLOW_STRING("col_destroy_collection", "Exit.");
}
/* COPY */
/* Wrapper around a more advanced function */
int col_copy_collection(struct collection_item **collection_copy,
struct collection_item *collection_to_copy,
const char *name_to_use,
int copy_mode)
{
int error = EOK;
TRACE_FLOW_STRING("col_copy_collection", "Entry.");
error = col_copy_collection_with_cb(collection_copy,
collection_to_copy,
name_to_use,
copy_mode,
NULL,
NULL);
TRACE_FLOW_NUMBER("col_copy_collection. Exit. Returning", error);
return error;
}
/* Create a deep copy of the current collection. */
/* Referenced collections of the donor are copied as sub collections. */
int col_copy_collection_with_cb(struct collection_item **collection_copy,
struct collection_item *collection_to_copy,
const char *name_to_use,
int copy_mode,
col_copy_cb copy_cb,
void *ext_data)
{
int error = EOK;
struct collection_item *new_collection = NULL;
const char *name;
struct collection_header *header;
unsigned depth = 0;
struct col_copy traverse_data;
int flags;
TRACE_FLOW_STRING("col_copy_collection_with_cb", "Entry.");
/* Collection is required */
if (collection_to_copy == NULL) {
TRACE_ERROR_NUMBER("No collection to search!", EINVAL);
return EINVAL;
}
/* Storage is required too */
if (collection_copy == NULL) {
TRACE_ERROR_NUMBER("No memory provided to receive collection copy!", EINVAL);
return EINVAL;
}
/* NOTE: Refine this check if adding a new copy mode */
if ((copy_mode < 0) || (copy_mode > COL_COPY_TOP)) {
TRACE_ERROR_NUMBER("Invalid copy mode:", copy_mode);
return EINVAL;
}
/* Determine what name to use */
if (name_to_use != NULL)
name = name_to_use;
else
name = collection_to_copy->property;
header = (struct collection_header *)collection_to_copy->data;
/* Create a new collection */
error = col_create_collection(&new_collection, name, header->cclass);
if (error) {
TRACE_ERROR_NUMBER("col_create_collection failed returning", error);
return error;
}
traverse_data.mode = copy_mode;
traverse_data.current_path = NULL;
traverse_data.given_name = NULL;
traverse_data.given_len = 0;
traverse_data.copy_cb = copy_cb;
traverse_data.ext_data = ext_data;
if (copy_mode == COL_COPY_FLATDOT) flags = COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END;
else if (copy_mode == COL_COPY_FLAT) flags = COL_TRAVERSE_FLAT;
else flags = COL_TRAVERSE_ONELEVEL;
error = col_walk_items(collection_to_copy, flags,
col_copy_traverse_handler, (void *)(&traverse_data),
NULL, new_collection, &depth);
if (!error) *collection_copy = new_collection;
else col_destroy_collection(new_collection);
TRACE_FLOW_NUMBER("col_copy_collection_with_cb returning", error);
return error;
}
/* EXTRACTION */
/* Extract collection */
int col_get_collection_reference(struct collection_item *ci,
struct collection_item **acceptor,
const char *collection_to_find)
{
struct collection_header *header;
struct collection_item *subcollection = NULL;
int error = EOK;
TRACE_FLOW_STRING("col_get_collection_reference", "Entry.");
if ((ci == NULL) ||
(ci->type != COL_TYPE_COLLECTION) ||
(acceptor == NULL)) {
TRACE_ERROR_NUMBER("Invalid parameter - returning error",EINVAL);
return EINVAL;
}
if (collection_to_find) {
/* Find a sub collection */
TRACE_INFO_STRING("We are given subcollection name - search it:",
collection_to_find);
error = col_find_item_and_do(ci, collection_to_find,
COL_TYPE_COLLECTIONREF,
COL_TRAVERSE_DEFAULT,
col_get_subcollection,
(void *)(&subcollection),
COLLECTION_ACTION_FIND);
if (error) {
TRACE_ERROR_NUMBER("Search failed returning error", error);
return error;
}
if (subcollection == NULL) {
TRACE_ERROR_STRING("Search for subcollection returned NULL pointer", "");
return ENOENT;
}
}
else {
/* Create reference to the same collection */
TRACE_INFO_STRING("Creating reference to the top level collection.", "");
subcollection = ci;
}
header = (struct collection_header *)subcollection->data;
TRACE_INFO_NUMBER("Count:", header->count);
TRACE_INFO_NUMBER("Ref count:", header->reference_count);
header->reference_count++;
TRACE_INFO_NUMBER("Ref count after increment:", header->reference_count);
*acceptor = subcollection;
TRACE_FLOW_STRING("col_get_collection_reference", "Success Exit.");
return EOK;
}
/* Get collection - if current item is a reference get a real collection from it. */
int col_get_reference_from_item(struct collection_item *ci,
struct collection_item **acceptor)
{
struct collection_header *header;
struct collection_item *subcollection = NULL;
TRACE_FLOW_STRING("get_reference_from_item", "Entry.");
if ((ci == NULL) ||
(ci->type != COL_TYPE_COLLECTIONREF) ||
(acceptor == NULL)) {
TRACE_ERROR_NUMBER("Invalid parameter - returning error",EINVAL);
return EINVAL;
}
subcollection = *((struct collection_item **)ci->data);
header = (struct collection_header *)subcollection->data;
TRACE_INFO_NUMBER("Count:", header->count);
TRACE_INFO_NUMBER("Ref count:", header->reference_count);
header->reference_count++;
TRACE_INFO_NUMBER("Ref count after increment:", header->reference_count);
*acceptor = subcollection;
TRACE_FLOW_STRING("col_get_reference_from_item", "Success Exit.");
return EOK;
}
/* ADDITION */
/* Add collection to collection */
int col_add_collection_to_collection(struct collection_item *ci,
const char *sub_collection_name,
const char *as_property,
struct collection_item *collection_to_add,
int mode)
{
struct collection_item *acceptor = NULL;
const char *name_to_use;
struct collection_header *header;
struct collection_item *collection_copy;
int error = EOK;
struct col_copy traverse_data;
unsigned depth = 0;
TRACE_FLOW_STRING("col_add_collection_to_collection", "Entry.");
if ((ci == NULL) ||
(ci->type != COL_TYPE_COLLECTION) ||
(collection_to_add == NULL) ||
(collection_to_add->type != COL_TYPE_COLLECTION)) {
/* Need to debug here */
TRACE_ERROR_NUMBER("Missing parameter - returning error", EINVAL);
return EINVAL;
}
if (sub_collection_name != NULL) {
/* Find a sub collection */
TRACE_INFO_STRING("We are given subcollection name - search it:",
sub_collection_name);
error = col_find_item_and_do(ci, sub_collection_name,
COL_TYPE_COLLECTIONREF,
COL_TRAVERSE_DEFAULT,
col_get_subcollection,
(void *)(&acceptor),
COLLECTION_ACTION_FIND);
if (error) {
TRACE_ERROR_NUMBER("Search failed returning error", error);
return error;
}
if (acceptor == NULL) {
TRACE_ERROR_STRING("Search for subcollection returned NULL pointer", "");
return ENOENT;
}
}
else {
acceptor = ci;
}
if (as_property != NULL)
name_to_use = as_property;
else
name_to_use = collection_to_add->property;
TRACE_INFO_STRING("Going to use name:", name_to_use);
switch (mode) {
case COL_ADD_MODE_REFERENCE:
TRACE_INFO_STRING("We are adding a reference.", "");
TRACE_INFO_NUMBER("Type of the header element:",
collection_to_add->type);
TRACE_INFO_STRING("Header name we are adding.",
collection_to_add->property);
/* Create a pointer to external collection */
/* For future thread safety: Transaction start -> */
error = col_insert_property_with_ref_int(acceptor,
NULL,
COL_DSP_END,
NULL,
0,
0,
name_to_use,
COL_TYPE_COLLECTIONREF,
(void *)(&collection_to_add),
sizeof(struct collection_item **),
NULL);
TRACE_INFO_NUMBER("Type of the header element after adding property:",
collection_to_add->type);
TRACE_INFO_STRING("Header name we just added.",
collection_to_add->property);
if (error) {
TRACE_ERROR_NUMBER("Adding property failed with error:", error);
return error;
}
header = (struct collection_header *)collection_to_add->data;
TRACE_INFO_NUMBER("Count:", header->count);
TRACE_INFO_NUMBER("Ref count:", header->reference_count);
header->reference_count++;
TRACE_INFO_NUMBER("Ref count after increment:",
header->reference_count);
/* -> Transaction end */
break;
case COL_ADD_MODE_EMBED:
TRACE_INFO_STRING("We are embedding the collection.", "");
/* First check if the passed in collection is referenced more than once */
TRACE_INFO_NUMBER("Type of the header element we are adding:",
collection_to_add->type);
TRACE_INFO_STRING("Header name we are adding.",
collection_to_add->property);
TRACE_INFO_NUMBER("Type of the header element we are adding to:",
acceptor->type);
TRACE_INFO_STRING("Header name we are adding to.",
acceptor->property);
error = col_insert_property_with_ref_int(acceptor,
NULL,
COL_DSP_END,
NULL,
0,
0,
name_to_use,
COL_TYPE_COLLECTIONREF,
(void *)(&collection_to_add),
sizeof(struct collection_item **),
NULL);
TRACE_INFO_NUMBER("Adding property returned:", error);
break;
case COL_ADD_MODE_CLONE:
TRACE_INFO_STRING("We are cloning the collection.", "");
TRACE_INFO_STRING("Name we will use.", name_to_use);
/* For future thread safety: Transaction start -> */
error = col_copy_collection(&collection_copy,
collection_to_add, name_to_use,
COL_COPY_NORMAL);
if (error) return error;
TRACE_INFO_STRING("We have a collection copy.", collection_copy->property);
TRACE_INFO_NUMBER("Collection type.", collection_copy->type);
TRACE_INFO_STRING("Acceptor collection.", acceptor->property);
TRACE_INFO_NUMBER("Acceptor collection type.", acceptor->type);
error = col_insert_property_with_ref_int(acceptor,
NULL,
COL_DSP_END,
NULL,
0,
0,
name_to_use,
COL_TYPE_COLLECTIONREF,
(void *)(&collection_copy),
sizeof(struct collection_item **),
NULL);
/* -> Transaction end */
TRACE_INFO_NUMBER("Adding property returned:", error);
break;
case COL_ADD_MODE_FLAT:
TRACE_INFO_STRING("We are flattening the collection.", "");
traverse_data.mode = COL_COPY_FLAT;
traverse_data.current_path = NULL;
traverse_data.copy_cb = NULL;
traverse_data.ext_data = NULL;
if ((as_property) && (*as_property)) {
/* The normal assignement generates a warning
* becuase I am assigning const to a non const.
* I can't make the structure member to be const
* since it changes but it changes
* to point to different stings at different time
* This is just an initial sting it will use.
* The logic does not change the content of the string.
* To overcome the issue I use memcpy();
*/
memcpy(&(traverse_data.given_name),
&(as_property), sizeof(char *));
traverse_data.given_len = strlen(as_property);
}
else {
traverse_data.given_name = NULL;
traverse_data.given_len = 0;
}
error = col_walk_items(collection_to_add, COL_TRAVERSE_FLAT,
col_copy_traverse_handler, (void *)(&traverse_data),
NULL, acceptor, &depth);
TRACE_INFO_NUMBER("Copy collection flat returned:", error);
break;
case COL_ADD_MODE_FLATDOT:
TRACE_INFO_STRING("We are flattening the collection with dots.", "");
traverse_data.mode = COL_COPY_FLATDOT;
traverse_data.current_path = NULL;
traverse_data.copy_cb = NULL;
traverse_data.ext_data = NULL;
if ((as_property) && (*as_property)) {
/* The normal assignement generates a warning
* becuase I am assigning const to a non const.
* I can't make the structure member to be const
* since it changes but it changes
* to point to different stings at different time
* This is just an initial sting it will use.
* The logic does not change the content of the string.
* To overcome the issue I use memcpy();
*/
memcpy(&(traverse_data.given_name),
&(as_property), sizeof(char *));
traverse_data.given_len = strlen(as_property);
}
else {
traverse_data.given_name = NULL;
traverse_data.given_len = 0;
}
error = col_walk_items(collection_to_add, COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END,
col_copy_traverse_handler, (void *)(&traverse_data),
NULL, acceptor, &depth);
TRACE_INFO_NUMBER("Copy collection flatdot returned:", error);
break;
default:
error = EINVAL;
}
TRACE_FLOW_NUMBER("col_add_collection_to_collection returning:", error);
return error;
}
/* TRAVERSING */
/* Function to traverse the entire collection including optionally
* sub collections */
int col_traverse_collection(struct collection_item *ci,
int mode_flags,
col_item_fn item_handler,
void *custom_data)
{
int error = EOK;
unsigned depth = 0;
TRACE_FLOW_STRING("col_traverse_collection", "Entry.");
if (ci == NULL) {
TRACE_ERROR_NUMBER("No collection to traverse!", EINVAL);
return EINVAL;
}
error = col_walk_items(ci, mode_flags, col_simple_traverse_handler,
NULL, item_handler, custom_data, &depth);
if ((error != 0) && (error != EINTR_INTERNAL)) {
TRACE_ERROR_NUMBER("Error walking tree", error);
return error;
}
TRACE_FLOW_STRING("col_traverse_collection", "Success exit.");
return EOK;
}
/* CHECK */
/* Convenience function to check if specific property is in the collection */
int col_is_item_in_collection(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
int *found)
{
int error;
TRACE_FLOW_STRING("col_is_item_in_collection","Entry.");
*found = COL_NOMATCH;
error = col_find_item_and_do(ci, property_to_find,
type, mode_flags,
col_is_in_item_handler,
(void *)found,
COLLECTION_ACTION_FIND);
TRACE_FLOW_NUMBER("col_is_item_in_collection returning", error);
return error;
}
/* SEARCH */
/* Search function. Looks up an item in the collection based on the property.
Essentually it is a traverse function with spacial traversing logic.
*/
int col_get_item_and_do(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
col_item_fn item_handler,
void *custom_data)
{
int error = EOK;
TRACE_FLOW_STRING("col_get_item_and_do","Entry.");
error = col_find_item_and_do(ci, property_to_find,
type, mode_flags,
item_handler,
custom_data,
COLLECTION_ACTION_FIND);
TRACE_FLOW_NUMBER("col_get_item_and_do returning", error);
return error;
}
/* Get raw item */
int col_get_item(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
struct collection_item **item)
{
int error = EOK;
TRACE_FLOW_STRING("col_get_item", "Entry.");
error = col_find_item_and_do(ci, property_to_find,
type, mode_flags,
NULL, (void *)item,
COLLECTION_ACTION_GET);
TRACE_FLOW_NUMBER("col_get_item returning", error);
return error;
}
/* DELETE */
/* Delete property from the collection */
int col_delete_property(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags)
{
int error = EOK;
int found;
TRACE_FLOW_STRING("col_delete_property", "Entry.");
found = COL_NOMATCH;
error = col_find_item_and_do(ci, property_to_find,
type, mode_flags,
NULL, (void *)(&found),
COLLECTION_ACTION_DEL);
if ((error == EOK) && (found == COL_NOMATCH))
error = ENOENT;
TRACE_FLOW_NUMBER("col_delete_property returning", error);
return error;
}
/* UPDATE */
/* Update property in the collection */
int col_update_property(struct collection_item *ci,
const char *property_to_find,
int type,
void *new_data,
int length,
int mode_flags)
{
int error = EOK;
struct update_property update_data;
TRACE_FLOW_STRING("col_update_property", "Entry.");
update_data.type = type;
update_data.data = new_data;
update_data.length = length;
update_data.found = COL_NOMATCH;
error = col_find_item_and_do(ci, property_to_find,
type, mode_flags,
NULL, (void *)(&update_data),
COLLECTION_ACTION_UPDATE);
if ((error == EOK) && (update_data.found == COL_NOMATCH))
error = ENOENT;
TRACE_FLOW_NUMBER("col_update_property returning", error);
return error;
}
/* Function to modify the item */
int col_modify_item(struct collection_item *item,
const char *property,
int type,
const void *data,
int length)
{
TRACE_FLOW_STRING("col_modify_item", "Entry");
/* Allow renameing only */
if ((item == NULL) ||
((item->type == COL_TYPE_COLLECTION) && (length != 0)) ||
((item->type == COL_TYPE_COLLECTIONREF) && (length != 0))) {
TRACE_ERROR_NUMBER("Invalid argument or invalid argument type", EINVAL);
return EINVAL;
}
if (property != NULL) {
if (col_validate_property(property)) {
TRACE_ERROR_STRING("Invalid chracters in the property name", property);
return EINVAL;
}
free(item->property);
item->property = strdup(property);
if (item->property == NULL) {
TRACE_ERROR_STRING("Failed to allocate memory", "");
return ENOMEM;
}
/* Update property length and hash if we rename the property */
item->phash = col_make_hash(property, 0, &(item->property_len));
TRACE_INFO_NUMBER("Item hash", item->phash);
TRACE_INFO_NUMBER("Item property length", item->property_len);
TRACE_INFO_NUMBER("Item property strlen", strlen(item->property));
}
/* We need to change data ? */
if(length) {
/* If type is different or same but it is string or binary we need to
* replace the storage */
if ((item->type != type) ||
((item->type == type) &&
((item->type == COL_TYPE_STRING) || (item->type == COL_TYPE_BINARY)))) {
TRACE_INFO_STRING("Replacing item data buffer", "");
free(item->data);
item->data = malloc(length);
if (item->data == NULL) {
TRACE_ERROR_STRING("Failed to allocate memory", "");
item->length = 0;
return ENOMEM;
}
item->length = length;
}
TRACE_INFO_STRING("Overwriting item data", "");
memcpy(item->data, data, item->length);
item->type = type;
if (item->type == COL_TYPE_STRING)
((char *)(item->data))[item->length - 1] = '\0';
}
TRACE_FLOW_STRING("col_modify_item", "Exit");
return EOK;
}
/* Set collection class */
int col_set_collection_class(struct collection_item *item,
unsigned cclass)
{
struct collection_header *header;
TRACE_FLOW_STRING("col_set_collection_class", "Entry");
if (item->type != COL_TYPE_COLLECTION) {
TRACE_INFO_NUMBER("Not a collectin object. Type is", item->type);
return EINVAL;
}
header = (struct collection_header *)item->data;
header->cclass = cclass;
TRACE_FLOW_STRING("col_set_collection_class", "Exit");
return EOK;
}
/* Get collection class */
int col_get_collection_class(struct collection_item *item,
unsigned *cclass)
{
struct collection_header *header;
TRACE_FLOW_STRING("col_get_collection_class", "Entry");
if (item->type != COL_TYPE_COLLECTION) {
TRACE_ERROR_NUMBER("Not a collection object. Type is", item->type);
return EINVAL;
}
header = (struct collection_header *)item->data;
*cclass = header->cclass;
TRACE_FLOW_STRING("col_get_collection_class", "Exit");
return EOK;
}
/* Get collection count */
int col_get_collection_count(struct collection_item *item,
unsigned *count)
{
struct collection_header *header;
TRACE_FLOW_STRING("col_get_collection_count", "Entry");
if (item->type != COL_TYPE_COLLECTION) {
TRACE_ERROR_NUMBER("Not a collectin object. Type is", item->type);
return EINVAL;
}
header = (struct collection_header *)item->data;
*count = header->count;
TRACE_FLOW_STRING("col_get_collection_count", "Exit");
return EOK;
}
/* Convinience function to check if the collection is of the specific class */
/* In case of internal error assumes that collection is not of the right class */
int col_is_of_class(struct collection_item *item, unsigned cclass)
{
int error = EOK;
unsigned ret_class = 0;
TRACE_FLOW_STRING("col_is_of_class invoked", "");
error = col_get_collection_class(item, &ret_class);
if (error || (ret_class != cclass))
return 0;
else
return 1;
}
/* Get propery */
const char *col_get_item_property(struct collection_item *ci,
int *property_len)
{
if (property_len != NULL) *property_len = ci->property_len;
return ci->property;
}
/* Get type */
int col_get_item_type(struct collection_item *ci)
{
return ci->type;
}
/* Get length */
int col_get_item_length(struct collection_item *ci)
{
return ci->length;
}
/* Get data */
void *col_get_item_data(struct collection_item *ci)
{
return ci->data;
}
/* Get hash */
uint64_t col_get_item_hash(struct collection_item *ci)
{
return ci->phash;
}
/* Calculates hash of the string using internal hashing
* algorithm. Populates "length" with length
* of the string not counting 0.
* Length argument can be NULL.
*/
uint64_t col_make_hash(const char *string, int sub_len, int *length)
{
uint64_t hash = 0;
int str_len = 0;
TRACE_FLOW_STRING("col_make_hash called for string:", string);
if (string) {
hash = FNV1a_base;
while (string[str_len] != 0) {
/* Check if we need to stop */
if ((sub_len > 0) && (str_len == sub_len)) break;
hash = hash ^ toupper(string[str_len]);
hash *= FNV1a_prime;
str_len++;
}
}
if (length) *length = str_len;
TRACE_FLOW_NUMBER("col_make_hash returning hash:", hash);
return hash;
}
ding-libs-0.6.2/collection/collection.cfg.doxy.in 0000664 0000000 0000000 00000175527 14172606404 0021752 0 ustar 00root root 0000000 0000000 # Doxyfile 1.6.3
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
# TAG = value [value, ...]
# For lists items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# http://www.gnu.org/software/libiconv for the list of possible encodings.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "libcollection"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = @PACKAGE_VERSION@
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of
# source files, where putting all generated files in the same directory would
# otherwise cause performance problems for the file system.
CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is
# used as the annotated text. Otherwise, the brief description is used as-is.
# If left blank, the following values are used ("$name" is automatically
# replaced with the name of the entity): "The $name class" "The $name widget"
# "The $name file" "is" "provides" "specifies" "contains"
# "represents" "a" "an" "the"
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
# description.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
FULL_PATH_NAMES = YES
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
# path to strip.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
# the reader which header file to include in order to use a class.
# If left blank only the name of the header file containing the class
# definition is used. Otherwise one should specify the include paths that
# are normally passed to the compiler using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
# doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
# description. Set this tag to YES if you prefer the old behaviour instead.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# re-implements.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
# a new page for each member. If set to NO, the documentation of a member will
# be part of the file/class/namespace that contains it.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = YES
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# Java. For instance, namespaces will be presented as packages, qualified
# scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it parses.
# With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
# The format is ext=language, where ext is a file extension, and language is one of
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
EXTENSION_MAPPING =
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
# instead of private inheritance when no explicit protection keyword is present.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
DISTRIBUTE_GROUP_DOC = NO
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
# the \nosubgrouping command.
SUBGROUPING = YES
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
EXTRACT_STATIC = NO
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.
EXTRACT_LOCAL_CLASSES = NO
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
# If set to NO (the default) only methods in the interface are included.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = YES
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
# documentation.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
# function's detailed documentation block.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
# of that file.
SHOW_INCLUDE_FILES = YES
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
# declaration order.
SORT_MEMBER_DOCS = NO
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
# declaration order.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the
# alphabetical list.
SORT_BY_SCOPE_NAME = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
# commands in the documentation.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
# command in the documentation regardless of this setting.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command , where is the value of
# the FILE_VERSION_FILTER tag, and is the name of an input file
# provided by doxygen. Whatever the program writes to standard output
# is used as the file version. See the manual for examples.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
# doxygen. The layout file controls the global structure of the generated output files
# in an output format independent way. The create the layout file that represents
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
# of the layout file.
LAYOUT_FILE =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
WARNINGS = YES
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
WARN_IF_UNDOCUMENTED = YES
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
# documentation.
WARN_NO_PARAMDOC = NO
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text. Optionally the format may contain
# $version, which will be replaced by the version of the file (if it could
# be obtained via FILE_VERSION_FILTER)
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
# to stderr.
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = @srcdir@
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.c *.h
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
RECURSIVE = NO
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
# from the input.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
EXCLUDE_PATTERNS = *_ut.c *priv* config.h
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command , where
# is the value of the INPUT_FILTER tag, and is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.
# If FILTER_PATTERNS is specified, this tag will be
# ignored.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.
# Doxygen will compare the file name with each pattern and apply the
# filter if there is a match.
# The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
# is applied to all files.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
# functions referencing it will be listed.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
# called/used by that function will be listed.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
# link to the source code.
# Otherwise they will link to the documentation.
REFERENCES_LINK_SOURCE = YES
# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
# will need version 4.8.6 or higher.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
# which an include is specified. Set to NO to disable this.
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
# contains a lot of classes, structs, unions or interfaces.
ALPHABETICAL_INDEX = NO
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# in which this list will be split (can be a number in the range [1..20])
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
# should be ignored while generating the index headers.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
# doxygen will generate files with .html extension.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased!
HTML_STYLESHEET =
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.
HTML_TIMESTAMP = NO
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
GENERATE_DOCSET = NO
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.
DOCSET_FEEDNAME = "Doxygen generated docs"
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.
DOCSET_BUNDLE_ID = org.doxygen.Project
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# of the generated HTML documentation.
GENERATE_HTMLHELP = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
# written to the html output directory.
CHM_FILE =
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
HHC_LOCATION =
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
# it should be included in the master .chm file (NO).
GENERATE_CHI = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.
CHM_INDEX_ENCODING =
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
# normal table of contents (NO) in the .chm file.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members
# to the contents of the HTML help documentation and to the tree view.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
# HTML documentation.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace
QHP_NAMESPACE =
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
QHP_VIRTUAL_FOLDER = doc
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
# For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
# Qt Help Project / Custom Filters.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
# filter section matches.
# Qt Help Project / Filter Attributes.
QHP_SECT_FILTER_ATTRS =
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file.
QHG_LOCATION =
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
DISABLE_INDEX = NO
# This tag can be used to set the number of enum values (range [1..20])
# that doxygen will group on one line in the generated HTML documentation.
ENUM_VALUES_PER_LINE = 4
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value is set to YES, a side panel will be generated
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
GENERATE_TREEVIEW = NO
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
# is shown.
TREEVIEW_WIDTH = 250
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.
FORMULA_FONTSIZE = 10
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
SEARCHENGINE = YES
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `latex' will be used as the default path.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
# default command name.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used.
PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
# standard header. Notice: only use this tag if you know what you are doing!
LATEX_HEADER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.
LATEX_BATCHMODE = NO
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
# in the output.
LATEX_HIDE_INDICES = NO
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
LATEX_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimized for Word 97 and may not look very pretty with
# other RTF readers or editors.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `rtf' will be used as the default path.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
# Note: wordpad (write) and others do not support links.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an rtf document.
# Syntax is similar to doxygen's config file.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
# generate man pages
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `man' will be used as the default path.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
MAN_EXTENSION = .3
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
# would be unable to find the correct page. The default is NO.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
# the code including all documentation.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `xml' will be used as the default path.
XML_OUTPUT = xml
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that
# enabling this will significantly increase the size of the XML output.
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
# and incomplete at the moment.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
# moment.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
# to generate PDF and DVI output from the Perl module output.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader.
# This is useful
# if you want to understand what is going on.
# On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
# and Perl will parse it just the same.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
# Makefile don't overwrite each other's variables.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
# files.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
# PREDEFINED and EXPAND_AS_DEFINED tags.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# in the INCLUDE_PATH (see below) will be search if a #include is found.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
# the preprocessor.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
# be used.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse
# the parser if not removed.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
# The TAGFILES option can be used to specify one or more tagfiles.
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
#
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
#
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
# If a tag file is not located in the directory in which doxygen
# is run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
# will be listed.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
# be listed.
EXTERNAL_GROUPS = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
# or super classes. Setting the tag to NO turns the diagrams off. Note that
# this option is superseded by the HAVE_DOT option below. This is only a
# fallback. It is recommended to install and use dot, since it yields more
# powerful graphs.
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
# or is not a class.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
HAVE_DOT = NO
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# font does not include all possible unicode characters however, so when you need
# these (or just want a differently looking font) you can specify the font name
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.
DOT_FONTPATH =
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
UML_LOOK = NO
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
TEMPLATE_RELATIONS = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
# other documented files.
INCLUDE_GRAPH = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable call graphs
# for selected functions only using the \callgraph command.
CALL_GRAPH = NO
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable caller
# graphs for selected functions only using the \callergraph command.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.
DOT_IMAGE_FORMAT = png
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
# \dotfile command).
DOTFILE_DIRS =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
# visualized by representing a node as a red box. Note that doxygen if the
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes
# that lay further from the root node will be omitted. Note that setting this
# option to 1 or 2 may greatly reduce the computation time needed for large
# code bases. Also note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not
# seem to support this out of the box. Warning: Depending on the platform used,
# enabling this option may lead to badly anti-aliased labels on the edges of
# a graph (i.e. they become hard to read).
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10)
# support this, this feature is disabled by default.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
# the various graphs.
DOT_CLEANUP = YES
ding-libs-0.6.2/collection/collection.h 0000664 0000000 0000000 00000422177 14172606404 0020047 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Header file for collection interface.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#ifndef COLLECTION_H
#define COLLECTION_H
#include
/** @mainpage The COLLECTION interface
* The collection is a set of items of different types.
*
* To better understand how collections work imagine travel bags.
* They usually come in different sizes and one can put a bag in a bag when
* they put away to the shelf in a garage or closet. Collection is such bag
* except that you can put other bags into each other even if they are not
* empty.
* When you put items into a bag you do not see the contents of the bag.
* You just hold the bag. How many other bags inside this bag you do not know.
* But you might know that you put a "wallet" somewhere there.
* You ask the bag you hold: "find my wallet and give it to me".
* get_item function will return you the item that is your "wallet".
* You can then change something or just get information about the item you
* retrieved. But in most cases you do not need the wallet itself. You want to
* get something from the wallet or put something into it. IMO money would
* be an obvious choice. To do this you use update_xxx_property functions.
* There might be a bag somewhere deep and you might want to add something to
* it. add_xxx_property_xxx functions allow you to specify sub collection you
* want the item to be added to. If this sub collection argument is NULL top
* level collection is assumed.
* The search in the collections uses a "x!y!z" notation to refer to an item (or
* property). You can search for "wallet" and it will find any first instance of
* the "wallet" in your luggage. But you might have two wallets. One is yours and
* another is your significant other's. So you might say find "my!wallet".
* It will find wallet in your bag (collection) named "my". This collection can
* be many levels deep inside other collections. You do not need to know the
* full path to get to it. But if you have the full path you can use the fill
* path like this "luggage!newbags!my!wallet".
* It is useful to be able to put bags into bags as well as get them out of each
* other. When the collection is created the header keeps a reference count on
* how many copies of the collection are known to the world. So one can put a
* collection into collection and give up its access to it (embed) or still hold
* to the reference. By embedding the collection the caller effectively gives
* up its responsibility to destroy the collection after it is used.
* By extracting reference from an internal collection the caller gains access
* to the collection directly and thus has responsibility to destroy it after
* use.
*
* Internally collection is implemented as a link list rather than a hash
* table.
* This makes it suitable for small (dozens of items) sets of data for which
* the order is important. Thus the collection properties and sub collections
* can be used to model objects like a book case. Imagine a book case that
* consists of multiple shelves. You can perform operations like "add a new
* shelf after second shelf" or "put a book on the 4th shelf right before
* the book with the red cover."
*
* A bit of terminology:
* - collection - an object implemented as a link list that holds
* properties (attributes).
* - property - a named logical element of the collection.
* - item - physical element of the collection, think about it
* as a node in the link list.
* - value - data associated with the property.
* - type - type of the data associated with a property.
* - length - length of the data associated with the property.
* - sub collection - collection embedded into another collection.
* It is a property with the value of a special
* type. The name of the property that denotes
* a sub collection can be different from the name
* of the collection it refers to.
* - traverse - call a function that will internally iterate
* through a collection and do something with its
* elements.
* - iterate - step through a collection yourselves.
*
* Characters with codes less than space in ASCII table are illegal for
* property names.
* Character '!' also illegal in a property or collection name and
* reserved for "x!y!z" notation.
*
* There is always a header item in any collection that starts the collection.
* Most of the functions in the interface (unless explicitly stated otherwise)
* assume that the collection_item * argument points to the header element.
* Passing in elements extracted from the middle of a collection to functions
* that expect header elements is illegal. There might be not enough checking
* at the moment but this will be enforced in future versions of the library.
*
*/
#ifndef EOK
#define EOK 0
#endif
/**
* @defgroup collection COLLECTION interface
* @{
*/
/**
* @brief Default class for a free form collection.
*/
#define COL_CLASS_DEFAULT 0
/**
* @brief Value indicates that property is not found.
*
* Used in search functions.
*/
#define COL_NOMATCH 0
/**
* @brief Value indicates that property is found.
*
* Used in search functions.
*/
#define COL_MATCH 1
/**
* @defgroup coltypes Type definition constants
* @{
*/
/**
* @brief Indicates that property is of type "string".
*
* For elements of type string the length includes the trailing 0.
*/
#define COL_TYPE_STRING 0x00000001
/** @brief Indicates that property is of type "binary". */
#define COL_TYPE_BINARY 0x00000002
/** @brief Indicates that property is of type "integer". */
#define COL_TYPE_INTEGER 0x00000004
/** @brief Indicates that property is of type "unsigned". */
#define COL_TYPE_UNSIGNED 0x00000008
/** @brief Indicates that property is of type "long". */
#define COL_TYPE_LONG 0x00000010
/** @brief Indicates that property is of type "unsigned long". */
#define COL_TYPE_ULONG 0x00000020
/** @brief Indicates that property is of type "double". */
#define COL_TYPE_DOUBLE 0x00000040
/** @brief Indicates that property is of Boolean type. */
#define COL_TYPE_BOOL 0x00000080
/**
* @brief Indicates that property is of type "collection".
*
* The item of this type denotes that starting element of a
* collection.
*/
#define COL_TYPE_COLLECTION 0x00000100
/**
* @brief Indicates that property is of type "sub collection".
*
* An item of this type is a pointer to an existing external
* collection.
*/
#define COL_TYPE_COLLECTIONREF 0x00000200
/**
* @brief Special type that denotes the end of the collection.
*
* Useful when traversing collections.
*/
#define COL_TYPE_END 0x10000000
/**
* @brief Special type that denotes any property in the collection.
*
* Useful when traversing collection and searching for a property
* of unknown type but known name.
*/
#define COL_TYPE_ANY 0x0FFFFFFF
/**
* @}
*/
/**
* @defgroup addmodes Constants defining add modes
*
* The following constants define how one collection can be added to another.
*
* @{
*/
/** @brief Add a collection into a collection as a reference */
#define COL_ADD_MODE_REFERENCE 0
/**
* @brief Embed the collection into another collection.
*
* The collection will become part of another collection.
* After this operation the handle to the collection being added
* should not be used or freed.
* Embedding a collection can be done only once.
* If the collection is referenced by another collection,
* the operation will fail.
*/
#define COL_ADD_MODE_EMBED 1
/**
* @brief Perform a deep copy.
*
* Perform a deep copy of a collection with
* all its sub collections */
#define COL_ADD_MODE_CLONE 2
/**
* @brief Create a flattened copy.
*
* Create a deep copy of a collection with
* its sub collections flattening and NOT
* resolving duplicates.
*/
#define COL_ADD_MODE_FLAT 3
/**
* @brief Create a flattened copy with constructed names.
*
* Creates a deep copy of a collection with
* its sub collections flattening and NOT
* resolving duplicates. Names are constructed
* in dotted notation.
* For example the sub collection
* named "sub" containing "foo" and
* "bar" will be flattened as:
* "sub.foo", "sub.bar".
*/
#define COL_ADD_MODE_FLATDOT 4
/**
* @}
*/
/**
* @defgroup traverseconst Constants defining traverse modes
*
* The following constants define how a collection can be
* traversed or iterated.
*
* Flags defined below can generally be combined with each other.
*
* \ref COL_TRAVERSE_FLAT, \ref COL_TRAVERSE_SHOWSUB,
* \ref COL_TRAVERSE_ONLYSUB are mutually exclusive flags.
* If combined together results will be unpredictable.
* DO NOT MIX THEM IN ONE ITERATOR.
*
*
* @{
*/
/** @brief Traverse all items in the collection. */
#define COL_TRAVERSE_DEFAULT 0x00000000
/**
* @brief Traverse only the top level.
*
* Traverse only top level
* ignored if the IGNORE flag is
* specified
*/
#define COL_TRAVERSE_ONELEVEL 0x00000001
/**
* @brief Insert end collection marker.
*
* Call the handler once more when the
* end of the collection is reached.
* Specifying this flag would cause a traversing
* function to call a callback once more passing
* in a virtual property of type \ref COL_TYPE_END.
* Good for processing nested collections.
*/
#define COL_TRAVERSE_END 0x00000002
/** @brief Ignore sub collections as if none is present. */
#define COL_TRAVERSE_IGNORE 0x00000004
/**
* @brief Flatten the collection.
*
* Traversing this way would act as if
* all the properties of sub collection are properties
* of the root collection. The referencing properties or
* headers of the referenced collections are skipped.
*
* If we think of the book case example
* this is very useful when one wants to iterate through
* all the books skipping information about
* which shelf they are on.
*/
#define COL_TRAVERSE_FLAT 0x00000008
/**
* @defgroup moreiterflag Additional iterator flags
*
* \note NOTE: These flags ignored by traverse functions and
* can be used only in the iterator.
*
* @{
*/
/**
* @brief Include headers of sub collections.
*
* When one collection is embedded or referenced by another collection
* there are two names we can be interested in. The name of the property
* that defines the reference and the name of the embedded collection.
* It is recommended that they be the same, however there may be cases
* when the name of the referencing property and referenced collection
* should be different. By default only the name of the referencing
* property is returned while iterating through the collection and
* its sub collections. Specifying this flag would cause the names
* of the collection (header elements) be included into the iteration
* process.
*
* Flag is ignored if the \ref COL_TRAVERSE_ONELEVEL flag is
* specified and not ignored.
* Flag is ignored is also ignored if the FLAT flag is specified. */
#define COL_TRAVERSE_SHOWSUB 0x00010000
/**
* @brief Show sub collections.
*
* Show the header of the sub collection instead of the reference.
* Flag is ignored if the \ref COL_TRAVERSE_ONELEVEL flag is
* specified and not ignored.
* Flag is ignored is also ignored if the FLAT flag is specified. */
#define COL_TRAVERSE_ONLYSUB 0x00020000
/**
* @}
*/
/**
* @}
*/
/**
* @defgroup copyconst Constants defining copy modes
*
* The following constants define modes accepted by copy
* collection function(s).
*
* @{
*/
/**
* @brief Perform a deep copy.
*
* Referenced collections of the donor are copied as sub
* collections.
*/
#define COL_COPY_NORMAL 0
/**
* @brief Perform a deep flat copy.
*
* Collection is flattened. No name construction performed.
*/
#define COL_COPY_FLAT 1
/**
* @brief Perform a deep flat copy constructing names.
*
* Collection is flattened. Names are concatenated with dot.
*/
#define COL_COPY_FLATDOT 2
/** @brief Perform a deep copy but leave references as references. */
#define COL_COPY_KEEPREF 3
/** @brief Copy only top level collection. */
#define COL_COPY_TOP 4
/**
* @}
*/
/**
* @defgroup sortconst Constants defining sort order
*
* All flags can be combined in OR operation.
* Flags \ref COL_SORT_ASC and \ref COL_SORT_DESC are
* mutually exclusive. If both specified the
* collection will be sorted in the descending order.
*
* @{
*/
/** @brief Sort in ascending order. */
#define COL_SORT_ASC 0x00000000
/** @brief Sort in descending order. */
#define COL_SORT_DESC 0x00000001
/** @brief Sort all sub collections. */
#define COL_SORT_SUB 0x00000002
/**
* @brief Sort only embedded sub collections.
*
* Ignored if \ref COL_SORT_SUB is not specified.
*/
#define COL_SORT_MYSUB 0x00000004
/**
* @}
*/
/* Public declaration of the private data */
#ifndef COLLECTION_PRIV_H
/**
* @struct collection_item
* @brief Opaque structure that holds one property.
*
* Your implementation can assume that following members
* will always be members of the collection_item.
* but you should use get_item_xxx functions to get them
* and never access internal data directly.
*
* - char *property;
* - int property_len;
* - int type;
* - int length;
* - void *data;
*/
struct collection_item;
/**
* @struct collection_iterator
* @brief Opaque iterator structure.
*
* The iterator structure is used
* when one wants to traverse the collection
* going through its properties and optionally
* sub collections.
*
* Caller should never assume
* anything about internals of this structure.
*/
struct collection_iterator;
#endif /* COLLECTION_PRIV_H */
/**
* @brief Create a collection
*
* The function will create a collection.
* Each collection should have name and class.
*
* @param[out] ci Newly allocated collection object.
* @param[in] name The name is supposed to be a unique identifier of
* the collection. This is useful when the collections
* are stored within other collections or inside other
* aggregation objects. Caller is free to use any name.
* Name should consist of the ASCII characters with codes
* non less than space. Exclamation mark character is
* a special character and can't be used in name of
* collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] cclass Class is used to relate the collection to a specific
* group of the collections of the same structure.
* This is very useful when you try to represent
* objects using collections and you want to check if
* the objects have same structure or not.
* There is no predefined name space for the collection
* classes. Defining classes is left to the application
* developers.
* NOTE:
* If you decide to build an interface using collection
* library pick a range for the classes you are
* going to use and make sure that they do not collide
* with other interfaces built on top of the collection.
*
* @return 0 - Collection was created successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the collection name.
* @return EMSGSIZE - Collection name is too long.
*/
int col_create_collection(struct collection_item **ci,
const char *name,
unsigned cclass);
/**
* @brief Destroy a collection
*
* The function will destroy a collection.
*
* @param[in] ci Collection object.
*
*/
void col_destroy_collection(struct collection_item *ci);
/**
* @brief Cleanup Callback
*
* Signature of the callback that needs to be used when
* the collection is destroyed and a special cleanup operation
* is required for items in the collection.
*
* @param[in] property The name of the property will
* be passed in this parameter.
* @param[in] property_len Length of the property name
* will be passed in this parameter.
* @param[in] type Type of the data will be passed
* in this parameter.
* @param[in] data Pointer to the data will be passed
* in this parameter.
* @param[in] length Length of data will be passed in
* this parameter.
* @param[in] custom_data Custom data will be passed in
* this parameter.
*/
typedef void (*col_item_cleanup_fn)(const char *property,
int property_len,
int type,
void *data,
int length,
void *custom_data);
/**
* @brief Destroy a collection with callback
*
* Execute a provided callback for each item
* in the collection or subcollection immediately
* before freeing item. The callback is executed for each
* element including the collection header.
* It is the responsibility of the callback implementor
* to properly handle gifferent collection elements
* depending upon whether it is a header, reference to
* an embedded or external collection or a normal data
* element.
*
* The function will destroy a collection.
*
* @param[in] ci Collection object.
* @param[in] cb Cleanup callback.
* @param[in] custom_data Application data passed into
* the cleanup callback.
*
*/
void col_destroy_collection_with_cb(struct collection_item *ci,
col_item_cleanup_fn cb,
void *custom_data);
/**
* @brief Copy item callback.
*
* Callback is used by the
* \ref col_copy_collection_with_cb "col_copy_collection_with_cb" function.
* Function is called after the new item is created but not yet
* inserted into the target collection.
* The implementer of the callback can alter the item data
* or indicate to the caller that the item should be skipped.
*
* @param[in] item Newly allocated item that will be inserted
* into the new collection.
* @param[in] ext_data Data the application might want to
* pass to the callback.
* @param[out] skip Pointer to a variable that indicates if the
* item should be skipped or not.
* Set this variable to any nonzero value
* and the item will be skipped.
* @return 0 - Success
* @return Function can return any error code. This code
* will be propagated through the internal functions and
* returned to the application.
*
*/
typedef int (*col_copy_cb)(struct collection_item *item,
void *ext_data,
int *skip);
/**
* @brief Copy collection with data modification.
*
* Function create a deep copy of the current collection.
* Calls caller provided callback before copying each item's data.
* This is useful if the data needs to be resolved in some way.
* The best use is when the template is copied and the values
* in the template are resolved to the actual values.
* The acceptable modes are defined \ref copyconst "here".
*
* @param[out] col_copy Newly created collection object.
* @param[in] col_to_copy Collection object that will be copied.
* @param[in] name_to_use Name of the new collection.
* @param[in] copy_mode How to \ref copyconst "copy".
* @param[in] copy_cb Pointer to a callback \ref col_copy_cb.
* Can be NULL. In this case data is copied
* without modification.
* @param[in] ext_data Data the application might want to
* pass to the callback.
*
* @return 0 - Collection was copied successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return Any error code returned by the callback.
*
*/
int col_copy_collection_with_cb(struct collection_item **col_copy,
struct collection_item *col_to_copy,
const char *name_to_use,
int copy_mode,
col_copy_cb copy_cb,
void *ext_data);
/**
* @brief Copy collection without data modification.
*
* Function creates a deep copy of the current collection.
* It wraps the \ref col_copy_collection_with_cb function.
* The acceptable modes are defined \ref copyconst "here".
*
* @param[out] col_copy Newly created collection object.
* @param[in] col_to_copy Collection object that will be copied.
* @param[in] name_to_use Name of the new collection.
* @param[in] copy_mode How to \ref copyconst "copy".
*
* @return 0 - Collection was copied successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_copy_collection(struct collection_item **col_copy,
struct collection_item *col_to_copy,
const char *name_to_use,
int copy_mode);
/**
* @brief Add collection to collection.
*
* Function adds one collection into another
* depending upon a specified \ref addmodes "mode".
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add collection to. If NULL the collection
* is added to the root collection.
* @param[in] as_property Name of the property that will constitute
* the reference. If NULL the name of
* the collection being added will be used.
* If specified the restrictions to
* the name characters and length apply.
* For more details about the name related
* restrictions see
* \ref addproperty "col_add_xxx_property"
* functions.
* @param[in] ci_to_add Collection to add.
* @param[in] mode Specifies \ref addmodes "how"
* the collection should be added.
*
* @return 0 - Collection was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* The attempt to update a property which is
* a reference to a collection or a collection
* name.
* @return ENOENT - Property to update is not found.
*/
int col_add_collection_to_collection(struct collection_item *ci,
const char *subcollection,
const char *as_property,
struct collection_item *ci_to_add,
int mode);
/**
* @brief Search Callback
*
* Signature of the callback that needs to be used when
* traversing a collection or looking for a specific item.
*
* @param[in] property The name of the property will
* be passed in this parameter.
* @param[in] property_len Length of the property name
* will be passed in this parameter.
* @param[in] type Type of the data will be passed
* in this parameter.
* @param[in] data Pointer to the data will be passed
* in this parameter.
* @param[in] length Length of data will be passed in
* this parameter.
* @param[in] custom_data Custom data will be passed in
* this parameter.
* @param[out] stop Pointer to a variable where the handler
* can put nonzero to stop traversing
* of the collection.
* @return 0 - Success
* @return Function can return any error code. This code
* will be propagated through the internal functions and
* returned to the application.
*/
typedef int (*col_item_fn)(const char *property,
int property_len,
int type,
void *data,
int length,
void *custom_data,
int *stop);
/**
* @brief Traverse collection
*
* Function to traverse the entire collection
* including (optionally) sub collections.
*
* @param[in] ci Collection object to traverse.
* @param[in] mode_flags How to traverse.
* See details \ref traverseconst "here".
* @param[in] item_handler Application supplied callback.
* It will be called for each item
* in the collection including headers.
* @param[in] custom_data Custom data that application
* might want to pass to the callback.
*
* @return 0 - Collection was traversed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return Any error code returned by the callback.
*
*/
int col_traverse_collection(struct collection_item *ci,
int mode_flags,
col_item_fn item_handler,
void *custom_data);
/**
* @brief Search and do function.
*
* Looks up an item in the collection based on the property and type.
* Actually it is a traverse function with special traversing logic.
* It traverses the whole collection but calls the supplied
* callback only for the items that match the search criteria.
* It is the responsibility of the caller to define how the callback
* is going to indicate that the item it was looking for is found.
* Function will not return error if the item is not found.
* It is the responsibility of the calling application to check
* the data passed in custom_data and see if the item was found and
* that the action was performed.
*
* @param[in] ci Collection object to traverse.
* @param[in] property_to_find Name of the property to find.
* Parameter supports "x!y"
* notation.
* @param[in] type Type filter. Only properties
* of the given type will match.
* Can be 0 to indicate that all
* types should be evaluated.
* @param[in] mode_flags How to traverse the collection.
* See details \ref traverseconst "here".
* @param[in] item_handler Function to call when the item is found.
* @param[in] custom_data Custom data passed to the callback.
*
* @return 0 - Operation completed successfully.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - The search criteria is incorrect.
* @return ENOMEM - No memory.
* @return Any error code returned by the callback.
*
*/
int col_get_item_and_do(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
col_item_fn item_handler,
void *custom_data);
/**
* @brief Search function to get an item.
*
* Convenience function to get individual item.
* Caller should be aware that this is not a copy of the item
* but the pointer to actual item stored in the collection.
* The returned pointer should never be altered or freed by caller of the function.
* The caller should be sure that the collection does not go out of scope
* while the pointer to its data is in use.
* Working with the internals of the collection item structure directly
* may cause problems in future if the internal implementation changes.
* The caller needs to be aware that function does not return
* error if item is not found. The caller needs to check if
* item is not NULL to determine whether something was found.
* Internally function is a wrapper around the \ref col_get_item_and_do
* function.
*
* Use \ref getitem "item management" functions to work with the item.
*
* @param[in] ci Collection object to traverse.
* @param[in] property_to_find Name of the property to find.
* Parameter supports "x!y"
* notation.
* @param[in] type Type filter. Only properties
* of the given type will match.
* Can be 0 to indicate that all
* types should be evaluated.
* @param[in] mode_flags How to traverse the collection.
* See details \ref traverseconst "here".
* @param[in] item Pointer to found item or NULL
* if item is not found.
*
* @return 0 - No internal errors during search.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - The search criteria is incorrect.
* @return ENOMEM - No memory.
*
*/
int col_get_item(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
struct collection_item **item);
/**
* @brief Search function to get one of the duplicate items.
*
* Convenience function to get an individual item out of the list of duplicates.
* Caller should be aware that this is not a copy of the item
* but the pointer to actual item stored in the collection.
* The returned pointer should never be altered or freed by caller
* of the function.
* The caller should be sure that the collection does not go out of scope
* while the pointer to its data is in use.
* Working with the internals of the collection item structure directly
* may cause problems in future if the internal implementation changes.
* If collection to search or property to find is NULL function returns NULL.
*
* Use \ref getitem "item management" functions to work with the item.
*
* @param[in] ci Collection object to traverse.
* @param[in] subcollection Name of the sub collection to find
* item in. If NULL, the top level collection
* is used. One can use "foo!bar!baz"
* notation to identify the sub collection.
* @param[in] property_to_find Name of the property to find.
* @param[in] type Type filter. Only properties
* of the given type will match.
* Can be 0 to indicate that all
* types should be evaluated.
* @param[in] idx Index of the duplicate to find.
* 0 - any first instance
* positive - N-th instance (index is 0-based)
* negative - last instance
* @param[in] exact If 0 then if index above is greater than
* actual number of duplicates the last duplicate
* if be returned.
* If non-zero the funtion will return ENOENT
* in case the index is greater than actual
* number of duplicates.
* @param[out] item Pointer to found item or NULL
* if item is not found.
* @return 0 No errors.
* @return EINVAL Invalid argument.
* @return ENOENT Item is not found.
*/
int col_get_dup_item(struct collection_item *ci,
const char *subcollection,
const char *property_to_find,
int type,
int idx,
int exact,
struct collection_item **item);
/**
* @brief Sort collection.
*
* If the sub collections are included in sorting
* each collection is sorted separately (this is not a global sort).
* It might be dangerous to sort sub collections if
* sub collection is not owned by the current collection.
* If it is a reference to an external collection
* there might be an issue. To skip the collections that
* externally referenced use \ref COL_SORT_MYSUB flag.
* Keep in mind that if a collection is referenced
* more than once by other collection and that collection
* is sorted with sub collections the referenced
* collection will be sorted more than once.
*
* NOTE: Current implementation of the sorting
* function is very simple and alternative
* implementations might be provided later.
*
* @param[in] col Collection to sort.
* @param[in] cmp_flags For more information see
* \ref compflags "comparison flags".
* @param[in] sort_flags For more information see
* \ref sortconst "sort flags".
*
* @return 0 - No internal errors during sorting.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_sort_collection(struct collection_item *col,
unsigned cmp_flags,
unsigned sort_flags);
/**
* @brief Delete property.
*
* Delete property from the collection.
* It is recommended to use a more efficient function
* \ref col_remove_item for the same purpose if
* the property is unique or if the collection
* has a known structure.
* The col_delete_property function has some advantage only
* if it is not known where property
* resides and what is the structure of the collection.
* In this case "foo!bar!baz" notation can be used in
* the property_to_find argument to find and delete
* the property "baz" that is in a sub collection "bar"
* which is in turn a part of a collection "foo".
*
* @param[in] ci Collection to delete property from.
* @param[in] property_to_find Property to delete.
* @param[in] type Use type if names are not unique
* and you know the type of the value
* you want to delete. Otherwise set to 0.
* @param[in] mode_flags The flags define how the collection
* should be searched. For more information
* see \ref traverseconst "traverse constants".
*
* @return 0 - Property was deleted successfully.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOMEM - No memory.
* @return ENOENT - Property not found.
*
*/
int col_delete_property(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags);
/**
* @brief Is property in the collection?
*
* Convenience function to check if the property
* is indeed in the collection.
*
* @param[in] ci Collection to search.
* @param[in] property_to_find Property to find.
* @param[in] type Use type if names are not unique
* and you know the type of the value
* you want to check. Otherwise set to 0.
* @param[in] mode_flags The flags define how the collection
* should be searched. For more information
* see \ref traverseconst "traverse constants".
* @param[out] found The variable that will receive the result
* of the search.
* COL_NOMATCH - if not found
* COL_MATCH if found
*
* @return 0 - Search completed successfully.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOMEM - No memory.
*
*/
int col_is_item_in_collection(struct collection_item *ci,
const char *property_to_find,
int type,
int mode_flags,
int *found);
/**
* @brief Get a reference to a collection
*
* Get a pointer to a collection included into another collection.
* If the col_to_find is NULL function returns a reference
* to the top level collection.
* Delete extracted collection after use to decrease reference count.
*
* @param[in] ci Collection to search.
* @param[out] acceptor Variable that accepts pointer to
* an extracted collection.
* Use \ref col_destroy_collection to
* free returned object reference after
* use.
* @param[in] col_to_find Collection to find.
* "foo!bar!baz" notation can be used.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOMEM - No memory.
*/
int col_get_collection_reference(struct collection_item *ci,
struct collection_item **acceptor,
const char *col_to_find);
/**
* @brief Get a reference from the item
*
* Get a pointer to a collection from a current item
* if current item is a reference to the collection.
* If current item is not a reference to a collection an error
* will be returned.
* Delete extracted collection after use to decrease reference count.
*
* @param[in] item Item to extract the reference from.
* @param[out] acceptor Variable that accepts pointer to
* an extracted collection.
* Use \ref col_destroy_collection to
* free returned object reference after
* use.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_get_reference_from_item(struct collection_item *item,
struct collection_item **acceptor);
/**
* @brief Get collection class.
*
* The classes of the collections can be used to convey information
* about the collection's internal structure.
* Some interfaces built on top of the collection might
* impose restrictions on the collection structure.
* For example the interface can decide that it is going
* to deal with the collections that do not have sub collections
* and elements of the collections are always only strings.
* So the interface will define a class of the collection
* and create a function that would take the strings and create
* such a collection. Then other functions of that interface
* would check if the provided collection is of the specified class.
* If not the interface would reject the collection right away.
* If the collection is of the valid class the interface might
* call the validation function to make sure that this is really
* the case however it needs to validate it only once and lower level
* functions can rely on the class value of the collection
* without performing duplicate validation.
*
* @param[in] ci Collection object.
* @param[out] cclass Variable that will receive
* the value of the class.
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_get_collection_class(struct collection_item *ci,
unsigned *cclass);
/**
* @brief Set collection class.
*
* Sometimes as a result of the collection modification
* the class of the collection can change.
*
* @param[in] ci Collection object.
* @param[in] cclass New class value.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_set_collection_class(struct collection_item *ci,
unsigned cclass);
/**
* @brief Get count of the elements.
*
* It is useful to know how many items are there in the collection.
*
* @param[in] ci Collection object.
* @param[out] count Variable will receive the value
* of the number of the items in
* the collection. Collection
* header or references to external
* collections are counted as well.
* This means that every collection
* has at least one item - the header.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_get_collection_count(struct collection_item *ci,
unsigned *count);
/**
* @brief Check the class of collection.
*
* Convenience function to check if the collection is of the specific class.
* In case of internal error assumes that collection is not of the right class.
*
* @param[in] ci Collection object.
* @param[in] cclass Class value to compare to to.
*
* @return 0 - If any internal error or classes do not match.
* @return 1 - No error and classes do match.
*
*/
int col_is_of_class(struct collection_item *ci,
unsigned cclass);
/**
* @defgroup addproperty Add property functions
*
* Functions in this section add properties to a collection.
*
* All the functions in this section add a property of the specified
* type to the collection object.
* They are convenience wrappers around the col_insert_xxx_property
* functions.
* They always append property to the end of the collection.
*
* Common parameters for these functions are:
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
* @{
*/
/**
* @brief Add a string property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] string Null terminated string to add.
* @param[in] length Length of the string. Should include the length
* of the terminating 0.
* If the length is shorter than the full string
* the string will be truncated. If the length is
* longer than the actual string there might be
* garbage at end of the actual string.
* Library will always properly NULL terminate
* the string at the given position dictated
* by length but in no way will inspect the validity
* of the passed in data. This is left to the calling
* application.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_str_property(struct collection_item *ci,
const char *subcollection,
const char *property,
const char *string,
int length);
/**
* @brief Add a binary property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] binary_data Data to add.
* @param[in] length Length of the data.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_binary_property(struct collection_item *ci,
const char *subcollection,
const char *property,
void *binary_data,
int length);
/**
* @brief Add an integer property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Integer value to add. Value is signed.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_int_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int32_t number);
/**
* @brief Add an unsigned integer property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Unsigned integer value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_unsigned_property(struct collection_item *ci,
const char *subcollection,
const char *property,
uint32_t number);
/**
* @brief Add an long property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Long integer value to add. Value is signed.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_long_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int64_t number);
/**
* @brief Add an unsigned long property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Unsigned long integer value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_ulong_property(struct collection_item *ci,
const char *subcollection,
const char *property,
uint64_t number);
/**
* @brief Add a property of type double to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Floating point value.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_double_property(struct collection_item *ci,
const char *subcollection,
const char *property,
double number);
/**
* @brief Add a Boolean property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] logical Boolean value. 0 - false, nonzero - true.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_bool_property(struct collection_item *ci,
const char *subcollection,
const char *property,
unsigned char logical);
/**
* @brief Add a property of a specified type to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] type See type definitions \ref coltypes "here".
* @param[in] data Data to add.
* @param[in] length Length of the data.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_any_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int type,
void *data,
int length);
/**
* @defgroup addprop_withref Add properties with reference
*
* Family of functions that add properties to a collection
* and return reference to an item that holds
* a newly created property.
*
* All the functions in this section append a property of
* the specified type to the collection object.
*
* Parameters for the functions and return values are the same
* as for the \ref addproperty "col_add_xxx_property" functions.
* The only difference is that these functions have one additional
* argument:
*
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @{
*/
/**
* @brief Add a string property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] string Null terminated string to add.
* @param[in] length Length of the string. Should include the length
* of the terminating 0.
* If the length is shorter than the full string
* the string will be truncated. If the length is
* longer than the actual string there might be
* garbage at end of the actual string.
* Library will always properly NULL terminate
* the string at the given position dictated
* by length but in no way will inspect the validity
* of the passed in data. This is left to the calling
* application.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_str_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
char *string, int length,
struct collection_item **ret_ref);
/**
* @brief Add a binary property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] binary_data Data to add.
* @param[in] length Length of the data.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_binary_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
void *binary_data, int length,
struct collection_item **ret_ref);
/**
* @brief Add an integer property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Integer value to add. Value is signed.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_int_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, int32_t number,
struct collection_item **ret_ref);
/**
* @brief Add an unsigned integer property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Unsigned integer value to add.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_unsigned_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, uint32_t number,
struct collection_item **ret_ref);
/**
* @brief Add an long property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Long integer value to add. Value is signed.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_long_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, int64_t number,
struct collection_item **ret_ref);
/**
* @brief Add an unsigned long property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Unsigned long integer value to add.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_ulong_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, uint64_t number,
struct collection_item **ret_ref);
/**
* @brief Add a property of type double to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Floating point value.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_double_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, double number,
struct collection_item **ret_ref);
/**
* @brief Add a Boolean property to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] logical Boolean value. 0 - false, nonzero - true.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_bool_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property, unsigned char logical,
struct collection_item **ret_ref);
/**
* @brief Add a property of a specified type to a collection.
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] type See type definitions \ref coltypes "here".
* @param[in] data Data to add.
* @param[in] length Length of the data.
* @param[out] ret_ref Reference to the newly added item that
* holds the property.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection is not found.
*
*/
int col_add_any_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
int type, void *data, int length,
struct collection_item **ret_ref);
/**
* @}
*/
/**
* @}
*/
/**
* @defgroup insertproperty Insert property functions
*
* Functions in this section insert properties into a collection
* at a specified position.
*
* Common parameters for these functions are:
*
* @param[in] ci Root collection object.
* @param[in] subcollection Name of the inner collection to
* add property to. If NULL the property
* is added to the root collection.
* @param[in] disposition Defines relation point.
* For more information see
* \ref dispvalues "disposition defines".
* @param[in] refprop Property to relate to
* @param[in] idx Index (see comments below).
* @param[in] flags Flags that control naming issues.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
*
*
* Other arguments are the same as the arguments for the
* \ref addproperty "col_add_xxx_property" functions.
*
* @return 0 - Property was insterted successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
* @return ENOENT - Sub collection or property to relate to is not found.
* @return EEXIST - Property with given name already exists.
* This error is returned if collection
* should hold unique names.
* For more information see description of the
* "flags" argument.
* @return ENOSYS - Flag or disposition value is not implemented.
* @{
*/
/** @brief Insert a string property. */
int col_insert_str_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
const char *string,
int length);
/** @brief Insert a binary property. */
int col_insert_binary_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
void *binary_data,
int length);
/** @brief Insert an integer property. */
int col_insert_int_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int32_t number);
/** @brief Insert an unsigned property. */
int col_insert_unsigned_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint32_t number);
/** @brief Insert a long property. */
int col_insert_long_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int64_t number);
/** @brief Insert an unsigned long property. */
int col_insert_ulong_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint64_t number);
/** @brief Insert a property with a floating point value. */
int col_insert_double_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
double number);
/** @brief Insert a property with a Boolean value. */
int col_insert_bool_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
unsigned char logical);
/** @brief Insert a string property and get back a reference. */
int col_insert_str_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
const char *string,
int length,
struct collection_item **ret_ref);
/** @brief Insert a binary property and get back a reference. */
int col_insert_binary_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
void *binary_data,
int length,
struct collection_item **ret_ref);
/** @brief Insert an integer property and get back a reference. */
int col_insert_int_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int32_t number,
struct collection_item **ret_ref);
/** @brief Insert an unsigned property and get back a reference. */
int col_insert_unsigned_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint32_t number,
struct collection_item **ret_ref);
/** @brief Insert a long property and get back a reference. */
int col_insert_long_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int64_t number,
struct collection_item **ret_ref);
/** @brief Insert an unsigned long property and get back a reference. */
int col_insert_ulong_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint64_t number,
struct collection_item **ret_ref);
/**
* @brief Insert a property with a floating
* point value and get back a reference.
*/
int col_insert_double_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
double number,
struct collection_item **ret_ref);
/** @brief Insert a property with a Boolean value and get back a reference. */
int col_insert_bool_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
unsigned char logical,
struct collection_item **ret_ref);
/** @brief Insert property of any type and get back a reference. */
int col_insert_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int type,
const void *data,
int length,
struct collection_item **ret_ref);
/**
* @}
*/
/**
* @defgroup updateproperty Update property functions
*
* Functions in this section update properties in a collection.
*
* All update functions search the property using the
* internal traverse function.
* Use same "x!y" notation to specify a property.
* For more details about the search logic see
* \ref col_get_item_and_do function.
*
* The existing value of the property is destroyed and lost.
*
* It is not possible to rename the property using these functions.
* To do more advanced modifications see \ref col_modify_item function
* and \ref modwrap "item modification wrappers" .
*
* Common parameters for these functions are:
*
* @param[in] ci Root collection object.
* @param[in] property Name of the property.
* @param[in] mode_flags Specify how the collection
* should to be traversed.
*
* The rest of the arguments specify the new values for
* the property. For more details about these arguments see
* the description of the \ref addproperty "col_add_xxx_property"
* corresponding function.
*
*
* @return 0 - Property was updated successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* The attempt to update a property which is
* a reference to a collection or a collection
* name.
* @return ENOENT - Property to update is not found.
*
* @{
*/
/**
* Update a property with a string value.
* Length should include the terminating 0.
*/
int col_update_str_property(struct collection_item *ci,
const char *property,
int mode_flags,
char *string,
int length);
/**
* Update a property with a binary value.
*/
int col_update_binary_property(struct collection_item *ci,
const char *property,
int mode_flags,
void *binary_data,
int length);
/**
* Update a property with an integer value.
*/
int col_update_int_property(struct collection_item *ci,
const char *property,
int mode_flags,
int32_t number);
/**
* Update a property with an unsigned value.
*/
int col_update_unsigned_property(struct collection_item *ci,
const char *property,
int mode_flags,
uint32_t number);
/**
* Update a property with a long value.
*/
int col_update_long_property(struct collection_item *ci,
const char *property,
int mode_flags,
int64_t number);
/**
* Update a property with an unsigned long value.
*/
int col_update_ulong_property(struct collection_item *ci,
const char *property,
int mode_flags,
uint64_t number);
/**
* Update a property with a floating point value.
*/
int col_update_double_property(struct collection_item *ci,
const char *property,
int mode_flags,
double number);
/**
* Update a property with a Boolean value.
*/
int col_update_bool_property(struct collection_item *ci,
const char *property,
int mode_flags,
unsigned char logical);
/**
* Update a property with a value by specifying type
* and value. See definitions of the type constants
* \ref coltypes "here".
* All other col_update_xxx_property functions are wrappers
* around this one.
*/
int col_update_property(struct collection_item *ci,
const char *property,
int type,
void *new_data,
int length,
int mode_flags);
/**
* @}
*/
/**
* @defgroup getitem Item management
*
* Group of functions that allows retrieving individual elements
* of the \ref collection_item hiding the internal implementation.
*
* @{
*/
/**
* @defgroup compflags Comparison flags
*
* This section describes the flags used in item comparison.
*
* Flags:
* - \ref COL_CMPIN_PROP_EQU
* - \ref COL_CMPIN_PROP_BEG
* - \ref COL_CMPIN_PROP_MID
* - \ref COL_CMPIN_PROP_END
*
* are mutually exclusive.
*
* All other flags can be provided in any combination.
*
* @{
*/
/** @brief Properties should be exactly equal */
#define COL_CMPIN_PROP_EQU 0x000000004
/** @brief Properties should start with the same substring. */
#define COL_CMPIN_PROP_BEG 0x000000005
/** @brief One property should be a substring of another. */
#define COL_CMPIN_PROP_MID 0x000000006
/** @brief Properties should have the same substring at the end. */
#define COL_CMPIN_PROP_END 0x000000007
/**
* @brief Make sure that there is a dot.
*
* Useful with _BEG, _MID and _END flags to check that the there is
* a dot (if present) in the right place (before, after or both).
* For example the first item is named "foo.bar" and the second
* is "bar". Using _END the "bar" will be found but if _DOT flag is
* used too the function will also check if there was a "." before the found
* string in this case.
* Ignored in case of _EQU.
*/
#define COL_CMPIN_PROP_DOT 0x000000008
/** @brief Compare property lengths. */
#define COL_CMPIN_PROP_LEN 0x000000010
/** @brief Compare types. */
#define COL_CMPIN_TYPE 0x000000020
/** @brief Compare data lengths. */
#define COL_CMPIN_DATA_LEN 0x000000040
/**
* @brief Compare data.
*
* Compares data (up to the length of the second one)
* if type is the same. If type is different
* function will assume data is different
* without performing actual comparison.
*/
#define COL_CMPIN_DATA 0x000000080
/**
* @}
*/
/**
* @defgroup outflags Comparison results flags
*
* This section describes the flags set as a result of
* a comparison operation.
*
* @{
*/
/**
* @brief Second item's property is greater.
*
* If _EQU was specified and the property of the second item
* is greater the following bit will be set
*/
#define COL_CMPOUT_PROP_STR 0x00000001
/**
* @brief Second item's property is longer.
*
* If told to compare property lengths
* and the second is longer this bit will be set.
*/
#define COL_CMPOUT_PROP_LEN 0x00000002
/**
* @brief Second item's data is longer.
*
* If told to compare data lengths
* and second is longer this bit will be set
*/
#define COL_CMPOUT_DATA_LEN 0x00000004
/**
* @brief Second item's data is greater.
*
* If told to compare data
* and types are the same, then
* if the second one is greater this bit will
* be set. If data is binary flag is never set.
*/
#define COL_CMPOUT_DATA 0x00000008
/**
* @}
*/
/**
* @defgroup dispvalues Disposition constants
*
* Possible dispositions for insert, extract and delete function(s).
* Not all of these dispositions are implemented day one.
* If disposition is not implemented the function
* will return error ENOSYS.
*
* Other dispositions might be possible in future.
*
* @{
*/
/**
* @brief Relate to the end of the collection
*
* For "insert":
* - Add property to the end of the collection.
*
* For "extract" or "delete":
* - Extract or delete the last property in the collection.
*/
#define COL_DSP_END 0
/**
* @brief Relate to the beginning of the collection
*
* For "insert":
* - Add property to the beginning of the collection right after the header.
*
* For "extract" or "delete":
* - Extract or delete the first property in the collection.
* This is the one right after the header.
*/
#define COL_DSP_FRONT 1
/**
* @brief Before the given property
*
* For "insert":
* - Add property before the referenced property.
*
* For "extract" or "delete":
* - Extract or delete the property that stands
* before the referenced property in the collection.
* If given property is the first in the collection
* ENOENT is returned.
*/
#define COL_DSP_BEFORE 2
/**
* @brief After the given property
*
* For "insert":
* - Add property immediately the referenced property.
*
* For "extract" or "delete":
* - Extract or delete the property that stands
* after the referenced property in the collection.
* If given property is the last in the collection
* ENOENT is returned.
*/
#define COL_DSP_AFTER 3
/**
* @brief Use index
*
* For "insert":
* - The COL_DSP_INDEX adds the item as N-th item after header in the list.
* Index is zero based.
* If there are less than N items in the list the item is added to the end.
* The index value of 0 means that the item will be added immediately
* after the header. Index of 1 will mean that it is added after first data
* item and so on.
*
* For "extract" or "delete":
* - In case of extraction or deletion the N-th item of the collection
* will be extracted or deleted.
* Index is zero based.
* If there are less than N+1 items in the list the function will return ENOENT.
*
*/
#define COL_DSP_INDEX 4
/**
* @brief Use first among duplicates
*
* This mode applies only to the list of duplicate
* properties that are going one after another.
*
* For "insert":
* - Add property as a first dup of the given property.
* The property name is taken from the item
* and the value refprop is ignored.
*
* For "extract" or "delete":
* - Delete or extract first duplicate property.
* The property name is taken from the refprop.
* The property will be extracted or deleted if found
* regardless of whether there are any duplicates or not.
*/
#define COL_DSP_FIRSTDUP 5
/**
* @brief Use last among duplicates
*
* This mode applies only to the list of duplicate
* properties that are going one after another.
*
* For "insert":
* - Add property as the last dup of the given property.
* The property name is taken from the item
* and the value refprop is ignored.
*
* For "extract" or "delete":
* - Delete or extract the last duplicate of the property.
* The property name is taken from the refprop.
* Extracts or deletes last duplicate property in the uninterrupted
* sequence of properties with the same name.
* The property will be extracted or deleted if found
* regardless of whether there are any duplicates or not.
*/
#define COL_DSP_LASTDUP 6
/**
* @brief Use N-th among duplicates
*
* This mode applies only to the list of duplicate
* properties that are going one after another.
*
* For "insert":
* - Add property as a N-th dup of the given property.
* The property name is taken from the item
* and the value refprop is ignored.
* Index is zero based.
* The COL_DSP_NDUP is used in case of the multi value property
* to add a new property with the same name into specific place
* in the list of properties with the same name.
* The index of 0 will mean to add the property before the first
* instance of the property with the same name.
* If the property does not exist ENOENT will be returned.
* If the index is greater than the last property with the same
* name the item will be added immediately after last
* property with the same name.
*
* For "extract" or "delete":
* - Delete or extract N-th duplicate property.
* Index is zero based.
* The property name is taken from the refprop.
* If index is greater than number of duplicate
* properties in the sequence ENOENT is returned.
*
*/
#define COL_DSP_NDUP 7
/**
* @brief Use last among nonsequential duplicates
*
* This mode applies to the list of duplicates that might be scattered
* across the collection
*
* For "insert":
* - Add property as the last dup of the given property.
* The property name is taken from the item
* and the value refprop is ignored.
*
* For "extract" or "delete":
* - Delete or extract the last duplicate of the property.
* The property name is taken from the refprop.
* Extracts or deletes last duplicate property in the uninterrupted
* sequence of properties with the same name.
* The property will be extracted or deleted if found
* regardless of whether there are any duplicates or not.
*/
#define COL_DSP_LASTDUPNS 8
/**
* @brief Use N-th among nonsequential duplicates
*
* This mode applies only to the list of duplicate
* properties that are going one after another.
*
* For "insert":
* - Add property as a N-th dup of the given property.
* The property name is taken from the item
* and the value refprop is ignored.
* Index is zero based.
* The COL_DSP_NDUPNS is used in case of the multi value property
* to add a new property with the same name into specific place
* in the list of properties with the same name.
* The index of 0 will mean to add the property before the first
* instance of the property with the same name.
* If the property does not exist ENOENT will be returned.
* If the index is greater than the last property with the same
* name the item will be added immediately after last
* property with the same name.
*
* For "extract" or "delete":
* - Delete or extract N-th duplicate property.
* Index is zero based.
* The property name is taken from the refprop.
* If index is greater than number of duplicate
* properties in the sequence ENOENT is returned.
*
*/
#define COL_DSP_NDUPNS 9
/**
* @}
*/
/**
* @defgroup insflags Flags used in insert item functions
*
* Flags that can be used with insert functions.
*
* In future can more flags might be added.
*
* NOTE: Use of the duplicate checking flags is costly
* since it requires a forward look up of the whole
* collection before the item is inserted.
* Do not use it until it is absolutely necessary.
*
* @{
*/
/** @brief This is the default mode - no dup checks on insert */
#define COL_INSERT_NOCHECK 0
/**
* @brief Check for duplicate name and overwrite.
* Position arguments are ignored.
*/
#define COL_INSERT_DUPOVER 1
/**
* @brief Check for duplicate name and type and overwrite.
* Position arguments are ignored.
*/
#define COL_INSERT_DUPOVERT 2
/** @brief Return error EEXIST if the entry with the same name exists. */
#define COL_INSERT_DUPERROR 3
/**
* @brief Return error EEXIST if the entry
* with the same name and type exists.
*/
#define COL_INSERT_DUPERRORT 4
/** @brief Check for duplicates, overwrite,
* extract and then move to the position requested.
*/
#define COL_INSERT_DUPMOVE 5
/** @brief Check for duplicate name and type, overwrite,
* extract and then move to the position requested.
*/
#define COL_INSERT_DUPMOVET 6
/**
* @}
*/
/**
* @brief Get item property.
*
* Get name of the property from the item. If the item is a header
* the name of the property is the name of the collection.
* The element that denotes the collection header has
* type \ref COL_TYPE_COLLECTION.
* Optionally the property length can be retrieved too.
*
* @param[in] ci Item to get property from.
* If item is invalid the function
* will cause a segment violation.
* @param[out] property_len If not NULL the variable
* will receive the length
* of the property not counting
* terminating 0.
*
* @return Property name.
*
*/
const char *col_get_item_property(struct collection_item *ci,
int *property_len);
/**
* @brief Get item type.
*
* Get type from the item.
*
* @param[in] ci Item to get type from.
* If item is invalid the function
* will cause a segment violation.
*
* @return Item type.
*
*/
int col_get_item_type(struct collection_item *ci);
/**
* @brief Get value length from the item.
*
* Get value length from the item. For strings this includes
* NULL terminating zero.
*
* @param[in] ci Item to get value length from.
* If item is invalid the function
* will cause a segment violation.
*
* @return Value length.
*
*/
int col_get_item_length(struct collection_item *ci);
/**
* @brief Get value from the item.
*
* Get value from the item.
*
* @param[in] ci Item to get value from.
* If item is invalid the function
* will cause a segment violation.
*
* @return Property value.
*
*/
void *col_get_item_data(struct collection_item *ci);
/**
* @brief Get hash value from the item.
*
* Get hash value from the item. The hash value is
* 64-bit hash created from the property name.
* It is done to optimize the searches.
*
* This function is exposed for some corner cases
* that require low level operations, for example
* for custom search callbacks to take advantage
* of the internal hashes.
*
* @param[in] ci Item to get hash from.
* If item is invalid the function
* will cause a segment violation.
*
* @return Hash value.
*
*/
uint64_t col_get_item_hash(struct collection_item *ci);
/**
* @brief Calculate hash value for a string.
*
* Calculates hash value of the string using internal hashing
* algorithm. Populates "length" with length
* of the string not counting 0.
*
* This function is useful if you want to build a custom
* search or collection sorting function.
*
* @param[in] string String to hash. If NULL hash is 0.
* @param[in] sub_len If it is greater than zero
* it is used to count how many
* characters from string should
* be included into hash calculation.
* If 0 the actual length of the string
* is determined and used.
* @param[out] length Will receive the calculated length
* of the provided string.
* Length argument can be NULL.
*
* @return Hash value.
*/
uint64_t col_make_hash(const char *string, int sub_len, int *length);
/**
* @brief Compare two items.
*
* The second item is evaluated against the first.
* Function returns 0 if two items are the same
* and non-zero otherwise.
* The \ref compflags "in_flags" is a bit mask that
* defines how the items should be compared.
*
* If items are different they might be sorted following
* some order. For example one can order items by name
* but not by type.
* If the result of the function is non-zero
* the \ref outflags "out_flags" (if provided) will be
* set to indicate if the second item is greater
* then the first.
*
* @param[in] first First item to compare.
* @param[in] second Second item to compare.
* @param[in] in_flags See \ref compflags "comparison flags".
* @param[out] out_flags See \ref outflags "output flags".
*
*
* @return 0 if items are the same and nonzero otherwise.
*/
int col_compare_items(struct collection_item *first,
struct collection_item *second,
unsigned in_flags,
unsigned *out_flags);
/**
* @brief Modify any item element.
*
* This function is useful if you want to modify the item that
* you got as a result of \ref iterfunc "iterating" through
* collection or by calling \ref col_get_item.
* Previous type and data of the item is destroyed.
*
* If you want to rename an item provide a new name in the property
* argument otherwise keep it NULL.
*
* If you want the data to remain unchanged use 0 as a length parameter.
*
* If the item is a reference or a collection and you attempt to change
* the data, i.e. length is not 0, the call will return an error EINVAL.
* If the item is a reference or a collection it can only be renamed.
*
* The are several convenience function that are wrappers
* around this function. For more information
* see \ref modwrap "item modification wrappers".
*
* @param[in] item Item to modify.
* @param[in] property Property name. Use NULL to leave the property
* unchanged.
* @param[in] type See \ref coltypes "types" for more information.
* @param[in] data New value.
* @param[in] length New value. Use 0 to leave the value and its type
* unchanged.
*
* @return 0 - Item was successfully modified.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* The attempt to modify an item which is
* a reference to a collection or a collection
* name.
*/
int col_modify_item(struct collection_item *item,
const char *property,
int type,
const void *data,
int length);
/**
* @defgroup modwrap Item modification wrappers
*
* The functions in this section are convenience wrappers
* around \ref col_modify_item.
* They return same error codes.
*
* @{
*/
/**
* @brief Modify item property.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It is equivalent to: col_modify_item(item, property, 0, NULL, 0);
*
*/
int col_modify_item_property(struct collection_item *item,
const char *property);
/**
* @brief Modify item value to be a string.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided string.
* If property is not NULL it also renames the property.
* If the length argument is not zero the string will be truncated to
* this length. If the length is 0 the length will be calculated based
* on the length of the actual string.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_str_item(struct collection_item *item,
const char *property,
const char *string,
int length);
/**
* @brief Modify item value to be a binary blob.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided binary buffer.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_binary_item(struct collection_item *item,
const char *property,
void *binary_data,
int length);
/**
* @brief Modify item value to be a Boolean.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided logical value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_bool_item(struct collection_item *item,
const char *property,
unsigned char logical);
/**
* @brief Modify item value to be an integer.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided integer value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_int_item(struct collection_item *item,
const char *property,
int32_t number);
/**
* @brief Modify item value to be a long integer.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided long integer value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_long_item(struct collection_item *item,
const char *property,
int64_t number);
/**
* @brief Modify item value to be an unsigned long.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided unsigned long value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_ulong_item(struct collection_item *item,
const char *property,
uint64_t number);
/**
* @brief Modify item value to be an unsigned integer.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided unsigned integer value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_unsigned_item(struct collection_item *item,
const char *property,
uint32_t number);
/**
* @brief Modify item value to be a floating point.
*
* This function is a convenience wrapper around \ref col_modify_item.
* It sets a value of the item to a provided floating point value.
* If property is not NULL it also renames the property.
* Original value is always destroyed.
*
* @return - same error values as \ref col_modify_item.
*/
int col_modify_double_item(struct collection_item *item,
const char *property,
double number);
/**
* @}
*/
/**
* @brief Extract item from the collection.
*
* Function to find and remove an item from the collection.
* Function does not destroy the item instead it returns a reference
* to the item so it can be used later and inserted back into this or
* other collection.
* The function assumes that the caller knows the collection
* the property is stored in.
* The header of the collection can't be extracted with this function
* but the reference to the collection can.
*
* Function allows specifying relative position of the item in the
* collection. One can specify that he wants to extract an item
* that is first in the collection or last, or after other item
* in the collection. For more details see parameter definitions.
*
* After extracting the item from the collection the caller has to
* either insert it back into some collection using \ref col_insert_item
* or delete it using \ref col_delete_item.
*
*
* @param[in] ci Collection object.
* @param[in] subcollection Name of the sub collection to extract
* item from. If NULL, the top level collection
* is used. One can use "foo!bar!baz"
* notation to identify the sub collection.
* @param[in] disposition Constant that controls how the relative
* position of the item to extract is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should extract next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to extract.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
* @param[out] ret_ref Variable will receive the value of the
* pointer to the extracted item.
*
* @return 0 - Item was successfully extracted.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* extracting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_extract_item(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
int type,
struct collection_item **ret_ref);
/**
* @brief Extract item from the current collection.
*
* Function is similar to the \ref col_extract_item.
* It acts exactly the same as \ref col_extract_item when the
* subcollection parameter of the \ref col_extract_item is set to NULL.
*
* @param[in] ci Collection object.
* @param[in] disposition Constant that controls how the relative
* position of the item to extract is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should extract next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to extract.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
* @param[out] ret_ref Variable will receive the value of the
* pointer to the extracted item.
*
* @return 0 - Item was successfully extracted.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* extracting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_extract_item_from_current(struct collection_item *ci,
int disposition,
const char *refprop,
int idx,
int type,
struct collection_item **ret_ref);
/**
* @brief Remove item from the collection.
*
* Function internally calls \ref col_extract_item and then
* \ref col_delete_item for the extracted item.
*
* Function is similar to \ref col_delete_property function
* but allows more specific information about what item (property)
* to remove.
*
* The header will not be considered for deletion.
*
* @param[in] ci Collection object.
* @param[in] subcollection Name of the sub collection to remove
* item from. If NULL, the top level collection
* is used. One can use "foo!bar!baz"
* notation to identify the sub collection.
* @param[in] disposition Constant that controls how the relative
* position of the item to remove is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should remove next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to remove.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
*
* @return 0 - Item was successfully removed.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* deleting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_remove_item(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
int type);
/**
* @brief Remove item from the collection.
*
* Function internally calls \ref col_extract_item and then
* \ref col_delete_item for the extracted item.
*
* Function is similar to \ref col_delete_property function
* but allows more specific information about what item (property)
* to remove.
*
* The header will not be considered for deletion.
*
* @param[in] ci Collection object.
* @param[in] subcollection Name of the sub collection to remove
* item from. If NULL, the top level collection
* is used. One can use "foo!bar!baz"
* notation to identify the sub collection.
* @param[in] disposition Constant that controls how the relative
* position of the item to remove is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should remove next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to remove.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
* @param[in] cb Callback to use.
* @param[in] custom_data Caller defined data that can be passed
* to the callback.
*
* @return 0 - Item was successfully removed.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* deleting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_remove_item_with_cb(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
int type,
col_item_cleanup_fn cb,
void *custom_data);
/**
* @brief Remove item from the current collection.
*
* Function is similar to the \ref col_remove_item.
* It acts exactly the same as \ref col_remove_item when the
* subcollection parameter of the \ref col_remove_item is set to NULL.
*
* @param[in] ci Collection object.
* @param[in] disposition Constant that controls how the relative
* position of the item to remove is determined.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should remove next item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to remove.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] type Type filter. Only the item of the matching
* type will be used. It can be a bit mask of
* more than one type. Use 0 if you do not
* need to filter by type.
*
* @return 0 - Item was successfully removed.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* deleting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
*/
int col_remove_item_from_current(struct collection_item *ci,
int disposition,
const char *refprop,
int idx,
int type);
/**
* @brief Insert item to the collection.
*
* WARNING: Only use this function to insert items
* that were extracted using \ref col_extract_item or
* \ref col_extract_item_from_current.
* NEVER use it with items that were returned by:
* - \ref col_get_item
* - \ref addproperty "add property" functions
* - \ref addprop_withref "add property with reference" functions
* - \ref insertproperty "instert property" functions.
*
* The fundamental difference is that when you extracted item
* using col_extract_item() it stops to be managed by a collection.
* With such item you can:
* - a) Insert this item into another (or same) collection
* - b) Get item information using corresponding item management functions.
* - c) Destroy item using col_delete_item().
*
* You are required to do either a) or c) with such item.
*
* @param[in] ci Collection object.
* @param[in] subcollection Name of the sub collection to insert
* item into. If NULL, the top level collection
* is used. One can use "foo!bar!baz"
* notation to identify the sub collection.
* @param[in] item Item to insert.
* @param[in] disposition Constant that controls where to insert
* the item.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should insert the item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to insert.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] flags Flags that control naming issues.
* See \ref insflags "insert flags"
* for more details.
*
* @return 0 - Item was successfully extracted.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* extracting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
* @return EEXIST If duplicate name/type checking is turned on
* and duplicate name/type is detected.
*
*/
int col_insert_item(struct collection_item *ci,
const char *subcollection,
struct collection_item *item,
int disposition,
const char *refprop,
int idx,
unsigned flags);
/**
* @brief Insert item to the current collection.
*
* Function is equivalent to \ref col_insert_item with
* subcollection parameter equal NULL.
*
* @param[in] ci Collection object.
* @param[in] item Item to insert.
* @param[in] disposition Constant that controls where to insert
* the item.
* For more information see \ref dispvalues
* "disposition constants".
* @param[in] refprop Name of the property to relate to.
* This can be used to specify that function
* should insert the item after the item
* with this name. Leave NULL if the
* disposition you are using does not
* relate to an item in the collection.
* @param[in] idx Index of the property to insert.
* Useful for multi-value properties where
* several properties have same name in a row.
* @param[in] flags Flags that control naming issues.
* See \ref insflags "insert flags"
* for more details.
*
* @return 0 - Item was successfully extracted.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
* @return ENOENT - Sub collection is not found.
* The position can't be determined. For example
* extracting next item after item with name "foo"
* will cause this error if item "foo" is the last
* item in the collection. There are other cases
* when this error can be returned but the common
* theme is that something was not found.
* @return ENOSYS Unknown disposition value.
* @return EEXIST If duplicate name/type checking is turned on
* and duplicate name/type is detected.
*
*/
int col_insert_item_into_current(struct collection_item *ci,
struct collection_item *item,
int disposition,
const char *refprop,
int idx,
unsigned flags);
/**
* @brief Delete extracted item.
*
* NEVER use this function to delete an item
* that was not previously extracted from the collection.
*
* There is currently no function to create an item aside and
* then insert it into the collection so the col_delete_item
* has only one use. In future this may change.
*
* @param[in] item Item to delete.
*
*/
void col_delete_item(struct collection_item *item);
/**
* @brief Delete extracted item with callback.
*
* This function is similar to \ref col_delete_item but allows
* passing a callback function so that value stored in the collection can
* be properly distroyed.
*
* @param[in] item Item to delete.
* @param[in] cb Callback to use.
* @param[in] custom_data Caller defined data that can be passed
to the callback.
*
*/
void col_delete_item_with_cb(struct collection_item *item,
col_item_cleanup_fn cb,
void *custom_data);
/**
* @}
*/
/**
* @defgroup iterfunc Iterator interface
*
* The functions in this section allow iterating
* through a collection in a loop where the caller
* implements the loop. It is different from the search and
* traverse functions described in other sections because those
* functions implement the loop themselves and call provided
* callback in a specific situation.
*
* @{
*/
/**
* @brief Bind iterator to a collection.
*
* This function creates an iterator object and binds it to the collection.
*
* @param[out] iterator Newly created iterator object.
* @param[in] ci Collection to iterate.
* @param[in] mode_flags Flags define how to traverse the collection.
* For more information see \ref traverseconst
* "constants defining traverse modes".
*
* @return 0 - Iterator was created successfully.
* @return ENOMEM - No memory.
* @return EINVAL - The value of some of the arguments is invalid.
*
*/
int col_bind_iterator(struct collection_iterator **iterator,
struct collection_item *ci,
int mode_flags);
/**
* @brief Unbind the iterator from the collection.
*
* @param[in] iterator Iterator object to free.
*/
void col_unbind_iterator(struct collection_iterator *iterator);
/**
* @brief Iterate collection.
*
* Advance to next item in the collection. After the iterator is
* bound it does not point to any item in the collection.
* Use this function in the loop to step through all items
* in the collection. See unit test for code examples.
*
* @param[in] iterator Iterator object to use.
* @param[out] item Pointer to the collection item.
* Do not destroy or alter this pointer
* in any ways. To access the internals
* of the item use \ref getitem "item management"
* functions.
* The value of the item will be set to NULL if
* the end of the collection is reached.
*
* @return 0 - Item was successfully retrieved.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_iterate_collection(struct collection_iterator *iterator,
struct collection_item **item);
/**
* @brief Move up
*
* Stop processing this sub collection and move to the next item in the
* collection some levels up.
*
* @param[in] iterator Iterator object to use.
* @param[in] level Indicates how many levels up you want to jump.
* If 0 - call is a no op.
* If the depth is less then requested level
* the iterator will get to the 0 level and
* next call to \ref col_iterate_collection
* will return NULL item.
*
* @return 0 - Iterator was successfully repositioned.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_iterate_up(struct collection_iterator *iterator, unsigned level);
/**
* @brief Get current depth
*
* How deep are we relative to the top level?
* This function will report depth that in some cases might look
* misleading. The reason is that traverse flags affect the internal
* level we are on at each moment.
* For example the default traverse behavior is to show
* references to the sub collections.
* So when the item reference is returned the
* depth automatically adjusted to level inside the sub collection.
* So if function is called in this situation the level returned will
* denote the level inside collection.
* Now imagine that this collection is empty so the attempt to read
* element will push you automatically one level up (in absence of the
* \ref COL_TRAVERSE_END flag). If in this situation you encounter another
* collection the reference will be returned and level automatically
* adjusted to level inside the collection.
* The point is that the level is reliable only after
* a data item was returned.
* To avoid this ambiguity another function \ref col_get_item_depth
* was introduced.
*
* @param[in] iterator Iterator object to use.
* @param[in] depth The variable will receive the depth
* the iterator is on. The value is 0
* if the iterator is on the top level.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_get_iterator_depth(struct collection_iterator *iterator, int *depth);
/**
* @brief Get depth of the last returned item.
*
* @param[in] iterator Iterator object to use.
* @param[in] depth The variable will receive the depth
* the iterator is on.
* Item from the top level will have
* depth equal to 0. The value of 0
* will also be returned if no item
* was read so far.
*
* @return 0 - Success.
* @return EINVAL - The value of some of the arguments is invalid.
*/
int col_get_item_depth(struct collection_iterator *iterator, int *depth);
/**
* @brief Pin iterator
*
* Pins down the iterator to loop around current point.
*
* This feature allows some search optimization.
* The idea is to be able to put a 'pin'
* into a specific place while iterating
* the collection and make this place a new
* "wrap around" place for the collection.
* This means that next time you
* iterate this collection you will start
* iterating from the next item and
* the item you got before setting pin will be
* the last in your iteration cycle.
*
* Here is the example:
*
* Assume you have two collections that you need
* to compare and perform some action on collection
* 1 based on the presence of the item in collection 2.
* - Collection1 = A, B, C, D, E, F
* - Collection2 = A, C, F
*
* The usual approach is to try A from collection 1
* against A, B, C from collection 2. "A" will be found
* right away. But to find "F" it has to be compared
* to "A" and "C" first. The fact that the collections
* are to some extent ordered can in some cases
* help to reduce the number of comparisons.
* If we found "C" in the list we can put a "pin"
* into the collection there causing the iterator
* to warp at this "pin" point. Since "D" and "E"
* are not in the second collection we will have
* to make same amount of comparisons in traditional
* or "pinned" case to not find them.
* To find "F" in pinned case there will be just one
* comparison.
* - Traditional case = 1 + 3 + 2 + 3 + 3 + 3 = 15
* - Pinned case = 1 + 3 + 1 + 3 + 3 + 1 = 12
*
* It is a 20% comparison reduction.
*
* @param[in] iterator Iterator object to use.
*/
void col_pin_iterator(struct collection_iterator *iterator);
/**
* @brief Rewind iterator
*
* Rewinds iterator to the current pin point which is by
* default the beginning of the collection until changed by
* \ref col_pin_iterator function.
*
* @param[in] iterator Iterator object to use.
*/
void col_rewind_iterator(struct collection_iterator *iterator);
/**
* @}
*/
/**
* @}
*/
#endif
ding-libs-0.6.2/collection/collection.pc.in 0000664 0000000 0000000 00000000512 14172606404 0020610 0 ustar 00root root 0000000 0000000 prefix=@prefix@
exec_prefix=@exec_prefix@
libdir=@libdir@
includedir=@includedir@
Name: collection
Description: A data-type to collect data in a heirarchical structure for easy iteration and serialization
Version: @COLLECTION_VERSION@
Libs: -L${libdir} -lcollection
Cflags: -I${includedir}
URL: https://github.com/SSSD/ding-libs
ding-libs-0.6.2/collection/collection_cmp.c 0000664 0000000 0000000 00000033666 14172606404 0020702 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Function to compare items.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#include
#include
#include
#include "trace.h"
/* The collection should use the real structures */
#include "collection_priv.h"
#include "collection.h"
#define NONZERO 1
#define PROP_MSK 0x000000007
#define TYPED_MATCH(type) \
do { \
if (*((type *)(first->data)) != *((type *)(second->data))) { \
result = NONZERO; \
if ((out_flags) && \
(*((type *)(first->data)) < *((type *)(second->data)))) { \
*out_flags |= COL_CMPOUT_DATA; \
} \
} \
} while(0)
/* Function to compare two items */
int col_compare_items(struct collection_item *first,
struct collection_item *second,
unsigned in_flags,
unsigned *out_flags)
{
int result = 0;
unsigned mode;
int cmpres = 0;
char *substr;
TRACE_FLOW_STRING("col_compare_items", "Entry.");
/* If any of the arguments is NULL return
* that they are different.
*/
if ((first == NULL) || (second == NULL)) {
TRACE_INFO_STRING("One of the items is NULL", "");
return NONZERO;
}
/* Check if we are told to compare something */
if (!in_flags) {
TRACE_INFO_NUMBER("No flags specified", in_flags);
return NONZERO;
}
if (out_flags) *out_flags = 0;
/* Start comparison */
mode = in_flags & PROP_MSK;
if (mode > 0 ) {
/* We are told to compare the properties */
switch(mode) {
case COL_CMPIN_PROP_EQU: /* looking for exact match */
/* Compare hashes and lengths first */
if ((first->phash == second->phash) &&
(first->property_len == second->property_len)) {
/* Collections are case insensitive, sorry... */
cmpres = strncasecmp(first->property,
second->property,
second->property_len);
if (cmpres != 0) {
result = NONZERO;
if (cmpres < 0) {
/* Second is greater */
if (out_flags) *out_flags |= COL_CMPOUT_PROP_STR;
}
}
}
else {
result = NONZERO;
/* They are different so check if we need to compare? */
if (out_flags) {
cmpres = strncasecmp(first->property,
second->property,
second->property_len);
if (cmpres < 0) {
/* Second is greater */
*out_flags |= COL_CMPOUT_PROP_STR;
}
}
}
break;
case COL_CMPIN_PROP_BEG: /* looking for beginning */
/* Compare lengths first */
if (first->property_len >= second->property_len) {
cmpres = strncasecmp(first->property,
second->property,
second->property_len);
if (cmpres == 0) {
/* Check we need to validate for dot */
if (in_flags & COL_CMPIN_PROP_DOT) {
if ((first->property[second->property_len] != '\0') &&
(first->property[second->property_len] != '.')) {
result = NONZERO;
}
}
}
else result = NONZERO;
}
else result = NONZERO;
break;
case COL_CMPIN_PROP_MID: /* looking for middle */
/* Compare lengths first */
if (first->property_len >= second->property_len) {
substr = strcasestr(first->property, second->property);
if (substr != NULL) {
/* Check we need to validate for dot */
if (in_flags & COL_CMPIN_PROP_DOT) {
/* Check if we have a dot before or after */
if (((substr != first->property) &&
(first->property[(substr - first->property) - 1] != '.')) ||
((substr[second->property_len] != '\0') &&
(substr[second->property_len] != '.'))) {
result = NONZERO;
}
}
}
else result = NONZERO;
}
else result = NONZERO;
break;
case COL_CMPIN_PROP_END: /* looking for end */
/* Compare lengths first */
if (first->property_len >= second->property_len) {
substr = first->property + (first->property_len - second->property_len);
cmpres = strncasecmp(substr,
second->property,
second->property_len);
if (cmpres == 0) {
/* Check we need to validate for dot */
if (in_flags & COL_CMPIN_PROP_DOT) {
if ((substr != first->property) &&
(first->property[(substr - first->property) - 1] != '.')) {
result = NONZERO;
}
}
}
else result = NONZERO;
}
else result = NONZERO;
break;
default: result = NONZERO;
break;
}
}
/* Check if we are told to compare property lengths */
if (in_flags & COL_CMPIN_PROP_LEN) {
if (first->property_len != second->property_len) {
result = NONZERO;
/* Do we need to tell who is greater? */
if ((out_flags) && (first->property_len < second->property_len)) {
*out_flags |= COL_CMPOUT_PROP_LEN;
}
}
}
/* Check if we are told to compare types */
if (in_flags & COL_CMPIN_TYPE) {
if (first->type != second->type) result = NONZERO;
}
/* Check if we need to compare data length */
if (in_flags & COL_CMPIN_DATA_LEN) {
if (first->length != second->length) {
result = NONZERO;
/* Do we need to tell who is greater? */
if ((out_flags) && (first->length < second->length)) {
*out_flags |= COL_CMPOUT_DATA_LEN;
}
}
}
/* Check if we need to compare data */
if (in_flags & COL_CMPIN_DATA) {
if (first->type == second->type) {
switch(first->type) {
case COL_TYPE_STRING:
if (first->length == second->length) {
cmpres = strncmp((const char *)first->data,
(const char *)second->data,
first->length);
if (cmpres != 0) {
result = NONZERO;
if (cmpres < 0) {
/* Second is greater */
if (out_flags) *out_flags |= COL_CMPOUT_DATA;
}
}
}
else result = NONZERO;
break;
case COL_TYPE_BINARY:
if (first->length == second->length) {
cmpres = memcmp(first->data,
second->data,
first->length);
if (cmpres != 0) result = NONZERO;
}
else result = NONZERO;
break;
case COL_TYPE_INTEGER:
/* Use macro to match data */
TYPED_MATCH(int);
break;
case COL_TYPE_UNSIGNED:
/* Use macro to match data */
TYPED_MATCH(unsigned);
break;
case COL_TYPE_LONG:
/* Use macro to match data */
TYPED_MATCH(long);
break;
case COL_TYPE_ULONG:
/* Use macro to match data */
TYPED_MATCH(unsigned long);
break;
case COL_TYPE_DOUBLE:
/* Use macro to match data */
TYPED_MATCH(double);
break;
case COL_TYPE_BOOL:
/* Use macro to match data */
TYPED_MATCH(unsigned char);
break;
/* These are never same */
case COL_TYPE_COLLECTION:
case COL_TYPE_COLLECTIONREF:
case COL_TYPE_END:
default:
result = NONZERO;
break;
}
}
else result = NONZERO;
}
TRACE_FLOW_NUMBER("col_compare_items. Exit. Returning:", result);
return result;
}
/* Sort collection */
int col_sort_collection(struct collection_item *col,
unsigned cmp_flags,
unsigned sort_flags)
{
int error = EOK;
struct collection_item *current;
struct collection_header *header;
struct collection_item **array;
struct collection_item *temp_item;
struct collection_item *other;
size_t size;
int ind, last;
int i, j;
int res;
unsigned out_flags;
TRACE_FLOW_STRING("col_sort_collection", "Entry.");
TRACE_INFO_NUMBER("Comparison flags:", cmp_flags);
TRACE_INFO_NUMBER("Sort flags:", sort_flags);
if ((col == NULL) || (col->type != COL_TYPE_COLLECTION)) {
TRACE_ERROR_STRING("Collecton must not ne NULL", "");
return EINVAL;
}
/* This will be a fast and simple implementation for now */
header = (struct collection_header *)(col->data);
if ((sort_flags & COL_SORT_SUB) &&
(sort_flags & COL_SORT_MYSUB) &&
(header->reference_count > 1)) {
TRACE_FLOW_STRING("col_sort_collection", "Exit.");
return error;
}
size = sizeof(struct collection_item *) * (header->count - 1);
array = (struct collection_item **)malloc(size);
if (array == NULL) {
TRACE_ERROR_NUMBER("Failed to allocate memory", ENOMEM);
return ENOMEM;
}
/* Fill array */
current = col->next;
ind = 0;
while (current != NULL) {
TRACE_INFO_STRING("Item:", current->property);
array[ind] = current;
if ((sort_flags & COL_SORT_SUB) &&
(array[ind]->type == COL_TYPE_COLLECTIONREF)) {
/* If we found a subcollection and we need to sort it
* then sort it.
*/
other = *((struct collection_item **)(array[ind]->data));
error = col_sort_collection(other, cmp_flags, sort_flags);
if (error) {
TRACE_ERROR_NUMBER("Subcollection sort failed", error);
free(array);
return error;
}
}
ind++;
current = current->next;
}
last = ind - 1;
for (i = 0; i < last; i++) {
TRACE_INFO_STRING("Arg1:", array[i]->property);
TRACE_INFO_STRING("Arg2:", array[i + 1]->property);
res = col_compare_items(array[i],
array[i + 1],
cmp_flags,
&out_flags);
TRACE_INFO_STRING("Result:", ((res == 0) ? "same" : "different"));
TRACE_INFO_NUMBER("Out flags", out_flags);
/* If they are not same and second is not greater
* in any way then we need to swap them */
if ((res != 0) && (out_flags == 0)) {
/* Swap */
TRACE_INFO_STRING("Swapping:", "");
TRACE_INFO_STRING("Item:", array[i]->property);
TRACE_INFO_STRING("Item:", array[i + 1]->property);
temp_item = array[i];
array[i] = array[i + 1];
array[i + 1] = temp_item;
/* But we need to go up bubbling this item
*/
j = i;
while (j > 0) {
res = col_compare_items(array[j - 1],
array[j],
cmp_flags,
&out_flags);
/* If they are not same and second is not greater
* in any way then we need to swap them */
if ((res != 0) && (out_flags == 0)) {
/* Swap */
temp_item = array[j - 1];
array[j - 1] = array[j];
array[j] = temp_item;
}
else break;
j--;
}
}
}
/* Build the chain back */
if (sort_flags & COL_SORT_DESC) {
col->next = array[last];
for (i = last; i > 0 ; i--) {
array[i]->next = array[i - 1];
}
array[0]->next = NULL;
header->last = array[0];
}
else {
col->next = array[0];
for (i = 0; i < last ; i++) {
array[i]->next = array[i + 1];
}
array[last]->next = NULL;
header->last = array[last];
}
free(array);
TRACE_FLOW_STRING("col_sort_collection", "Exit.");
return error;
}
ding-libs-0.6.2/collection/collection_cnv.c 0000664 0000000 0000000 00000135444 14172606404 0020706 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Convenience wrapper functions are implemented here.
They take a lot of space but pretty simple so they
are separated from the core logic.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#include
#include
#include "trace.h"
/* The collection should use the teal structures */
#include "collection_priv.h"
#include "collection.h"
/* PROPERTIES */
/* Insert string property with positioning */
int col_insert_str_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
const char *string,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_string_property", "Entry.");
if (length == 0) length = strlen(string) + 1;
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_STRING,
(const void *)string,
length,
NULL);
TRACE_FLOW_NUMBER("col_insert_string_property returning", error);
return error;
}
/* Insert binary property with positioning */
int col_insert_binary_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
void *binary_data,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_binary_property", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_BINARY,
binary_data,
length,
NULL);
TRACE_FLOW_NUMBER("col_insert_binary_property returning", error);
return error;
}
/* Insert integer property with positioning */
int col_insert_int_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_int_property", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_INTEGER,
(void *)&number,
sizeof(int32_t),
NULL);
TRACE_FLOW_NUMBER("col_insert_int_property returning", error);
return error;
}
/* Insert unsigned property with positioning */
int col_insert_unsigned_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_unsigned_property", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_UNSIGNED,
(void *)&number,
sizeof(uint32_t),
NULL);
TRACE_FLOW_NUMBER("col_insert_unsigned_property returning", error);
return error;
}
/* Insert long property with positioning */
int col_insert_long_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_long_property", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_LONG,
(void *)&number,
sizeof(int64_t),
NULL);
TRACE_FLOW_NUMBER("col_insert_long_property returning", error);
return error;
}
/* Insert unsigned long property with positioning */
int col_insert_ulong_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_ulong_property", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_ULONG,
(void *)&number,
sizeof(uint64_t),
NULL);
TRACE_FLOW_NUMBER("col_insert_ulong_property returning", error);
return error;
}
/* Insert double property with positioning */
int col_insert_double_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
double number)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_double_property", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_DOUBLE,
(void *)&number,
sizeof(double),
NULL);
TRACE_FLOW_NUMBER("col_insert_double_property returning", error);
return error;
}
/* Insert bool property with positioning */
int col_insert_bool_property(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
unsigned char logical)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_bool_property", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_BOOL,
(void *)&logical,
sizeof(unsigned char),
NULL);
TRACE_FLOW_NUMBER("col_insert_bool_property returning", error);
return error;
}
/* Insert string property with positioning and reference. */
int col_insert_str_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
const char *string,
int length,
struct collection_item **ret_ref)
{
int error = EOK;
void *ptr;
TRACE_FLOW_STRING("col_insert_string_property_with_ref", "Entry.");
if (length == 0) length = strlen(string) + 1;
/* Work around a compilation warning */
memcpy(&ptr, &string, sizeof(void *));
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_STRING,
ptr,
length,
ret_ref);
TRACE_FLOW_NUMBER("col_insert_string_property_with_ref returning", error);
return error;
}
/* Insert binary property with positioning and reference. */
int col_insert_binary_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
void *binary_data,
int length,
struct collection_item **ret_ref)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_binary_property_with_ref", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_BINARY,
(void *)binary_data,
length,
ret_ref);
TRACE_FLOW_NUMBER("col_insert_binary_property_with_ref returning", error);
return error;
}
/* Insert int property with positioning and reference. */
int col_insert_int_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int32_t number,
struct collection_item **ret_ref)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_int_property_with_ref", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_INTEGER,
(void *)&number,
sizeof(int32_t),
ret_ref);
TRACE_FLOW_NUMBER("col_insert_int_property_with_ref returning", error);
return error;
}
/* Insert unsigned property with positioning and reference. */
int col_insert_unsigned_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint32_t number,
struct collection_item **ret_ref)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_unsigned_property_with_ref", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_UNSIGNED,
(void *)&number,
sizeof(uint32_t),
ret_ref);
TRACE_FLOW_NUMBER("col_insert_unsigned_property_with_ref returning", error);
return error;
}
/* Insert long property with positioning and reference. */
int col_insert_long_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
int64_t number,
struct collection_item **ret_ref)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_long_property_with_ref", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_LONG,
(void *)&number,
sizeof(int64_t),
ret_ref);
TRACE_FLOW_NUMBER("col_insert_long_property_with_ref returning", error);
return error;
}
/* Insert unsigned long property with positioning and reference. */
int col_insert_ulong_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
uint64_t number,
struct collection_item **ret_ref)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_ulong_property_with_ref", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_ULONG,
(void *)&number,
sizeof(uint64_t),
ret_ref);
TRACE_FLOW_NUMBER("col_insert_ulong_property_with_ref returning", error);
return error;
}
/* Insert double property with positioning and reference. */
int col_insert_double_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
double number,
struct collection_item **ret_ref)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_double_property_with_ref", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_DOUBLE,
(void *)&number,
sizeof(double),
ret_ref);
TRACE_FLOW_NUMBER("col_insert_double_property_with_ref returning", error);
return error;
}
/* Insert bool property with positioning and reference. */
int col_insert_bool_property_with_ref(struct collection_item *ci,
const char *subcollection,
int disposition,
const char *refprop,
int idx,
unsigned flags,
const char *property,
unsigned char logical,
struct collection_item **ret_ref)
{
int error = EOK;
TRACE_FLOW_STRING("col_insert_bool_property_with_ref", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
disposition,
refprop,
idx,
flags,
property,
COL_TYPE_BOOL,
(void *)&logical,
sizeof(unsigned char),
ret_ref);
TRACE_FLOW_NUMBER("col_insert_bool_property_with_ref returning", error);
return error;
}
/* Add a string property. */
int col_add_str_property(struct collection_item *ci,
const char *subcollection,
const char *property,
const char *string,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_str_property", "Entry.");
error = col_insert_str_property(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
string,
length);
TRACE_FLOW_NUMBER("col_add_str_property returning", error);
return error;
}
/* Add a binary property. */
int col_add_binary_property(struct collection_item *ci,
const char *subcollection,
const char *property,
void *binary_data,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_binary_property", "Entry.");
error = col_insert_binary_property(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
binary_data,
length);
TRACE_FLOW_NUMBER("col_add_binary_property returning", error);
return error;
}
/* Add an int property. */
int col_add_int_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_int_property", "Entry.");
error = col_insert_int_property(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number);
TRACE_FLOW_NUMBER("col_add_int_property returning", error);
return error;
}
/* Add an unsigned int property. */
int col_add_unsigned_property(struct collection_item *ci,
const char *subcollection,
const char *property,
uint32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_unsigned_property", "Entry.");
error = col_insert_unsigned_property(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number);
TRACE_FLOW_NUMBER("col_add_unsigned_property returning", error);
return error;
}
/* Add an long property. */
int col_add_long_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_long_property", "Entry.");
error = col_insert_long_property(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number);
TRACE_FLOW_NUMBER("col_add_long_property returning", error);
return error;
}
/* Add an unsigned long property. */
int col_add_ulong_property(struct collection_item *ci,
const char *subcollection,
const char *property,
uint64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_ulong_property", "Entry.");
error = col_insert_ulong_property(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number);
TRACE_FLOW_NUMBER("col_add_ulong_property returning", error);
return error;
}
/* Add a double property. */
int col_add_double_property(struct collection_item *ci,
const char *subcollection,
const char *property,
double number)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_double_property", "Entry.");
error = col_insert_double_property(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number);
TRACE_FLOW_NUMBER("col_add_double_property returning", error);
return error;
}
/* Add a bool property. */
int col_add_bool_property(struct collection_item *ci,
const char *subcollection,
const char *property,
unsigned char logical)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_bool_property", "Entry.");
error = col_insert_bool_property(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
logical);
TRACE_FLOW_NUMBER("col_add_bool_property returning", error);
return error;
}
/* A function to add a property */
int col_add_any_property(struct collection_item *ci,
const char *subcollection,
const char *property,
int type,
void *data,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_any_property", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
type,
data,
length,
NULL);
TRACE_FLOW_NUMBER("col_add_any_property returning", error);
return error;
}
/* Add a string property with reference */
int col_add_str_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
char *string, int length,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_str_property_with_ref", "Entry.");
error = col_insert_str_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
string,
length,
ref_ret);
TRACE_FLOW_NUMBER("col_add_str_property_with_ref returning", error);
return error;
}
/* Add a binary property with reference. */
int col_add_binary_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
void *binary_data, int length,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_binary_property_with_ref", "Entry.");
error = col_insert_binary_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
binary_data,
length,
ref_ret);
TRACE_FLOW_NUMBER("col_add_binary_property_with_ref returning", error);
return error;
}
/* Add an int property with reference. */
int col_add_int_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
int32_t number,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_int_property_with_ref", "Entry.");
error = col_insert_int_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number,
ref_ret);
TRACE_FLOW_NUMBER("col_add_int_property_with_ref returning", error);
return error;
}
/* Add an unsigned int property with reference. */
int col_add_unsigned_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
uint32_t number,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_unsigned_property_with_ref", "Entry.");
error = col_insert_unsigned_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number,
ref_ret);
TRACE_FLOW_NUMBER("col_add_unsigned_property_with_ref returning", error);
return error;
}
/* Add an long property with reference. */
int col_add_long_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
int64_t number,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_long_property_with_ref", "Entry.");
error = col_insert_long_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number,
ref_ret);
TRACE_FLOW_NUMBER("col_add_long_property_with_ref returning", error);
return error;
}
/* Add an unsigned long property with reference. */
int col_add_ulong_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
uint64_t number,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_ulong_property_with_ref", "Entry.");
error = col_insert_ulong_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number,
ref_ret);
TRACE_FLOW_NUMBER("col_add_ulong_property_with_ref returning", error);
return error;
}
/* Add a double property with reference. */
int col_add_double_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
double number,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_double_property_with_ref", "Entry.");
error = col_insert_double_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
number,
ref_ret);
TRACE_FLOW_NUMBER("col_add_double_property_with_ref returning", error);
return error;
}
/* Add a bool property with reference. */
int col_add_bool_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
unsigned char logical,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_bool_property_with_ref", "Entry.");
error = col_insert_bool_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
logical,
ref_ret);
TRACE_FLOW_NUMBER("col_add_bool_property_with_ref returning", error);
return error;
}
/* A function to add a property with reference. */
int col_add_any_property_with_ref(struct collection_item *ci,
const char *subcollection,
const char *property,
int type,
void *data,
int length,
struct collection_item **ref_ret)
{
int error = EOK;
TRACE_FLOW_STRING("col_add_any_property_with_ref", "Entry.");
error = col_insert_property_with_ref(ci,
subcollection,
COL_DSP_END,
NULL,
0,
0,
property,
type,
data,
length,
ref_ret);
TRACE_FLOW_NUMBER("col_add_any_property_with_ref returning", error);
return error;
}
/* Update a string property in the collection.
* Length should include the terminating 0 */
int col_update_str_property(struct collection_item *ci,
const char *property,
int mode_flags,
char *string,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_update_str_property", "Entry.");
if (length == 0) length = strlen(string) + 1;
error = col_update_property(ci, property, COL_TYPE_STRING,
(void *)string, length, mode_flags);
TRACE_FLOW_NUMBER("col_update_str_property Returning", error);
return error;
}
/* Update a binary property in the collection. */
int col_update_binary_property(struct collection_item *ci,
const char *property,
int mode_flags,
void *binary_data,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_update_binary_property", "Entry.");
error = col_update_property(ci, property, COL_TYPE_BINARY,
binary_data, length, mode_flags);
TRACE_FLOW_NUMBER("col_update_binary_property Returning", error);
return error;
}
/* Update an int property in the collection. */
int col_update_int_property(struct collection_item *ci,
const char *property,
int mode_flags,
int32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_update_int_property", "Entry.");
error = col_update_property(ci, property, COL_TYPE_INTEGER,
(void *)(&number), sizeof(int32_t), mode_flags);
TRACE_FLOW_NUMBER("col_update_int_property Returning", error);
return error;
}
/* Update an unsigned int property. */
int col_update_unsigned_property(struct collection_item *ci,
const char *property,
int mode_flags,
uint32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_update_unsigned_property", "Entry.");
error = col_update_property(ci, property, COL_TYPE_UNSIGNED,
(void *)(&number), sizeof(uint32_t),
mode_flags);
TRACE_FLOW_NUMBER("col_update_unsigned_property Returning", error);
return error;
}
/* Update a long property. */
int col_update_long_property(struct collection_item *ci,
const char *property,
int mode_flags,
int64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_update_long_property", "Entry.");
error = col_update_property(ci, property, COL_TYPE_LONG,
(void *)(&number), sizeof(int64_t),
mode_flags);
TRACE_FLOW_NUMBER("col_update_long_property Returning", error);
return error;
}
/* Update an unsigned long property. */
int col_update_ulong_property(struct collection_item *ci,
const char *property,
int mode_flags,
uint64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_update_ulong_property", "Entry.");
error = col_update_property(ci, property, COL_TYPE_ULONG,
(void *)(&number), sizeof(uint64_t),
mode_flags);
TRACE_FLOW_NUMBER("col_update_ulong_property Returning", error);
return error;
}
/* Update a double property. */
int col_update_double_property(struct collection_item *ci,
const char *property,
int mode_flags,
double number)
{
int error = EOK;
TRACE_FLOW_STRING("col_update_double_property", "Entry.");
error = col_update_property(ci, property, COL_TYPE_DOUBLE,
(void *)(&number), sizeof(double),
mode_flags);
TRACE_FLOW_NUMBER("col_update_double_property Returning", error);
return error;
}
/* Update a bool property. */
int col_update_bool_property(struct collection_item *ci,
const char *property,
int mode_flags,
unsigned char logical)
{
int error = EOK;
TRACE_FLOW_STRING("col_update_bool_property", "Entry.");
error = col_update_property(ci, property, COL_TYPE_BOOL,
(void *)(&logical), sizeof(unsigned char),
mode_flags);
TRACE_FLOW_NUMBER("col_update_bool_property Returning", error);
return error;
}
/* Rename item */
int col_modify_item_property(struct collection_item *item,
const char *property)
{
int error;
TRACE_FLOW_STRING("col_modify_item_property", "Entry");
error = col_modify_item(item, property, 0, NULL, 0);
TRACE_FLOW_STRING("col_modify_item_property", "Exit");
return error;
}
/* Convenience functions that wrap modify_item(). */
/* Modify item data to be str */
int col_modify_str_item(struct collection_item *item,
const char *property,
const char *string,
int length)
{
int len;
int error;
TRACE_FLOW_STRING("col_modify_str_item", "Entry");
if (length != 0) len = length;
else len = strlen(string) + 1;
error = col_modify_item(item, property,
COL_TYPE_STRING, (const void *)string, len);
TRACE_FLOW_STRING("col_modify_str_item", "Exit");
return error;
}
/* Modify item data to be binary */
int col_modify_binary_item(struct collection_item *item,
const char *property,
void *binary_data,
int length)
{
int error;
TRACE_FLOW_STRING("col_modify_binary_item", "Entry");
error = col_modify_item(item, property, COL_TYPE_BINARY, binary_data, length);
TRACE_FLOW_STRING("col_modify_binary_item", "Exit");
return error;
}
/* Modify item data to be bool */
int col_modify_bool_item(struct collection_item *item,
const char *property,
unsigned char logical)
{
int error;
TRACE_FLOW_STRING("col_modify_bool_item", "Entry");
error = col_modify_item(item, property, COL_TYPE_BOOL, (void *)(&logical), 1);
TRACE_FLOW_STRING("col_modify_bool_item", "Exit");
return error;
}
/* Modify item data to be int */
int col_modify_int_item(struct collection_item *item,
const char *property,
int32_t number)
{
int error;
TRACE_FLOW_STRING("col_modify_int_item","Entry");
error = col_modify_item(item, property, COL_TYPE_INTEGER,
(void *)(&number), sizeof(int32_t));
TRACE_FLOW_STRING("col_modify_int_item", "Exit");
return error;
}
/* Modify item data to be long */
int col_modify_long_item(struct collection_item *item,
const char *property,
int64_t number)
{
int error;
TRACE_FLOW_STRING("col_modify_long_item", "Entry");
error = col_modify_item(item, property, COL_TYPE_LONG,
(void *)(&number), sizeof(int64_t));
TRACE_FLOW_STRING("col_modify_long_item", "Exit");
return error;
}
/* Modify item data to be unigned long */
int col_modify_ulong_item(struct collection_item *item,
const char *property,
uint64_t number)
{
int error;
TRACE_FLOW_STRING("col_modify_ulong_item", "Entry");
error = col_modify_item(item, property, COL_TYPE_ULONG,
(void *)(&number), sizeof(uint64_t));
TRACE_FLOW_STRING("col_modify_ulong_item", "Exit");
return error;
}
int col_modify_unsigned_item(struct collection_item *item,
const char *property,
uint32_t number)
{
int error;
TRACE_FLOW_STRING("col_modify_unsigned_item", "Entry");
error = col_modify_item(item, property, COL_TYPE_UNSIGNED,
(void *)(&number), sizeof(uint32_t));
TRACE_FLOW_STRING("col_modify_unsigned_item", "Exit");
return error;
}
int col_modify_double_item(struct collection_item *item,
const char *property,
double number)
{
int error;
TRACE_FLOW_STRING("col_modify_double_item", "Entry");
error = col_modify_item(item, property, COL_TYPE_DOUBLE,
(void *)(&number), sizeof(double));
TRACE_FLOW_STRING("col_modify_double_item", "Exit");
return error;
}
ding-libs-0.6.2/collection/collection_iter.c 0000664 0000000 0000000 00000036607 14172606404 0021064 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Implementation of the collection library iterator functions.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#include
#include
#include
#include "trace.h"
/* The collection should use the real structures */
#include "collection_priv.h"
#include "collection.h"
/* Depth for iterator depth allocation block */
#define STACK_DEPTH_BLOCK 15
/* Grow iteration stack */
static int col_grow_stack(struct collection_iterator *iterator, unsigned desired)
{
int grow_by = 0;
struct collection_item **temp;
TRACE_FLOW_STRING("col_grow_stack", "Entry.");
if (desired > iterator->stack_size) {
grow_by = (((desired - iterator->stack_size) / STACK_DEPTH_BLOCK) + 1) * STACK_DEPTH_BLOCK;
temp = (struct collection_item **)realloc(iterator->stack, grow_by * sizeof(struct collection_item *));
if (temp == NULL) {
TRACE_ERROR_NUMBER("Failed to allocate memory", ENOMEM);
return ENOMEM;
}
iterator->stack = temp;
iterator->stack_size += grow_by;
}
TRACE_FLOW_STRING("col_grow_stack", "Exit.");
return EOK;
}
/* Bind iterator to a collection */
int col_bind_iterator(struct collection_iterator **iterator,
struct collection_item *ci,
int mode_flags)
{
int error;
struct collection_header *header;
struct collection_iterator *iter = NULL;
TRACE_FLOW_STRING("col_bind_iterator", "Entry.");
/* Do some argument checking first */
if ((iterator == NULL) || (ci == NULL)) {
TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL);
return EINVAL;
}
iter = (struct collection_iterator *)malloc(sizeof(struct collection_iterator));
if (iter == NULL) {
TRACE_ERROR_NUMBER("Error allocating memory for the iterator.", ENOMEM);
return ENOMEM;
}
/* Allocate memory for the stack */
iter->stack = NULL;
iter->stack_size = 0;
iter->stack_depth = 0;
iter->item_level = 0;
iter->flags = mode_flags;
iter->pin_level = 0;
iter->can_break = 0;
TRACE_INFO_NUMBER("Iterator flags", iter->flags);
/* Allocate memory for stack */
error = col_grow_stack(iter, 1);
if(error) {
free(iter);
TRACE_ERROR_NUMBER("Error growing stack.", error);
return error;
}
/* Create a special end item */
error = col_allocate_item(&(iter->end_item), "", NULL, 0, COL_TYPE_END);
if(error) {
free(iter);
TRACE_ERROR_NUMBER("Error allocating end item.", error);
return error;
}
/* Make sure that we tie iterator to the collection */
header = (struct collection_header *)ci->data;
header->reference_count++;
iter->top = ci;
iter->pin = ci;
*(iter->stack) = ci;
iter->stack_depth++;
*iterator = iter;
TRACE_FLOW_STRING("col_bind_iterator", "Exit");
return EOK;
}
/* Stop processing this subcollection and move to the next item in the
* collection 'level' levels up.*/
int col_iterate_up(struct collection_iterator *iterator, unsigned level)
{
TRACE_FLOW_STRING("iterate_up", "Entry");
if (iterator == NULL) {
TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL);
return EINVAL;
}
TRACE_INFO_NUMBER("Going up:", level);
TRACE_INFO_NUMBER("Current stack depth:", iterator->stack_depth);
/* If level is big just move to the top,
* that will end the iteration process.
*/
if (level >= iterator->stack_depth) iterator->stack_depth = 0;
else iterator->stack_depth -= level;
TRACE_INFO_NUMBER("Stack depth at the end:", iterator->stack_depth);
TRACE_FLOW_STRING("col_iterate_up", "Exit");
return EOK;
}
/* How deep are we relative to the top level.*/
int col_get_iterator_depth(struct collection_iterator *iterator, int *depth)
{
TRACE_FLOW_STRING("col_get_iterator_depth", "Entry");
if ((iterator == NULL) || (depth == NULL)) {
TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL);
return EINVAL;
}
*depth = iterator->stack_depth - 1;
TRACE_INFO_NUMBER("Stack depth at the end:", iterator->stack_depth);
TRACE_FLOW_STRING("col_get_iterator_depth","Exit");
return EOK;
}
/* What was the level of the last item we got? */
int col_get_item_depth(struct collection_iterator *iterator, int *depth)
{
TRACE_FLOW_STRING("col_get_item_depth", "Entry");
if ((iterator == NULL) || (depth == NULL)) {
TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL);
return EINVAL;
}
*depth = iterator->item_level;
TRACE_INFO_NUMBER("Item level at the end:", iterator->item_level);
TRACE_FLOW_STRING("col_get_item_depth","Exit");
return EOK;
}
/* Unbind the iterator from the collection */
void col_unbind_iterator(struct collection_iterator *iterator)
{
TRACE_FLOW_STRING("col_unbind_iterator", "Entry.");
if (iterator != NULL) {
col_destroy_collection(iterator->top);
col_delete_item(iterator->end_item);
free(iterator->stack);
free(iterator);
}
TRACE_FLOW_STRING("col_unbind_iterator", "Exit");
}
/* Get items from the collection one by one following the tree */
int col_iterate_collection(struct collection_iterator *iterator,
struct collection_item **item)
{
int error;
struct collection_item *current;
struct collection_item *other;
TRACE_FLOW_STRING("col_iterate_collection", "Entry.");
/* Check if we have storage for item */
if (item == NULL) {
TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL);
return EINVAL;
}
while (1) {
TRACE_INFO_NUMBER("Stack depth:", iterator->stack_depth);
if (iterator->stack_depth == 0) {
/* Re-init so if we continue looping we start over */
iterator->stack[0] = iterator->top;
iterator->stack_depth++;
iterator->item_level = 0;
}
/* Is current item available */
current = iterator->stack[iterator->stack_depth - 1];
iterator->item_level = iterator->stack_depth - 1;
/* Are we done? */
if (((iterator->stack_depth - 1) == iterator->pin_level) &&
(iterator->pin == current)) {
if (iterator->can_break) {
TRACE_FLOW_STRING("We are done.", "");
*item = NULL;
iterator->can_break = 0;
return EOK;
}
else iterator->can_break = 1;
}
/* We are not done so check if we have an item */
if (current != NULL) {
TRACE_INFO_STRING("Current item:", current->property);
TRACE_INFO_NUMBER("Current item type:", current->type);
/* Is this a collection reference */
if (current->type == COL_TYPE_COLLECTIONREF) {
/* We do follow references? */
TRACE_INFO_STRING("Current item:", "collection reference");
if ((iterator->flags & COL_TRAVERSE_IGNORE) == 0) {
/* We should not ignore - then move on */
TRACE_INFO_STRING("Collection references are not ignored", "");
error = col_grow_stack(iterator, iterator->stack_depth + 1);
if (error) {
TRACE_ERROR_NUMBER("Error growing stack.", error);
return error;
}
/* Do we need to go deeper than one level ? */
if ((iterator->flags & COL_TRAVERSE_ONELEVEL) == 0) {
TRACE_INFO_STRING("Need to go deeper", "");
/* We need to go deeper... */
/* Do we need to show headers but not reference? */
if ((iterator->flags & COL_TRAVERSE_ONLYSUB) != 0) {
TRACE_INFO_STRING("Instructed to show header not reference", "");
other = *((struct collection_item **)current->data);
iterator->stack[iterator->stack_depth] = other->next;
iterator->item_level = iterator->stack_depth;
*item = other;
}
/* Do we need to show both? */
else if ((iterator->flags & COL_TRAVERSE_SHOWSUB) != 0) {
TRACE_INFO_STRING("Instructed to show header and reference","");
iterator->stack[iterator->stack_depth] = *((struct collection_item **)(current->data));
*item = current;
/* Do not need to adjust level here */
}
/* Do not show either */
else if ((iterator->flags & COL_TRAVERSE_FLAT) != 0) {
TRACE_INFO_STRING("Instructed not to show header and reference","");
other = *((struct collection_item **)current->data);
iterator->stack[iterator->stack_depth] = other->next;
iterator->stack[iterator->stack_depth - 1] = current->next;
iterator->stack_depth++;
/* Do not need to adjust level here */
continue;
}
/* We need to show reference only */
else {
TRACE_INFO_STRING("Instructed to show reference only", "");
other = *((struct collection_item **)current->data);
TRACE_INFO_STRING("Sub collection:", other->property);
TRACE_INFO_NUMBER("Sub collection type:", other->type);
iterator->stack[iterator->stack_depth] = other->next;
if (other->next != NULL) {
TRACE_INFO_STRING("Will show this item next time:", other->next->property);
TRACE_INFO_NUMBER("Will show this item next time type:", other->next->type);
}
*item = current;
TRACE_INFO_NUMBER("Level of the reference:", iterator->item_level);
/* Do not need to adjust level here */
}
TRACE_INFO_STRING("We return item:", (*item)->property);
TRACE_INFO_NUMBER("We return item type:", (*item)->type);
TRACE_INFO_STRING("Moving to the next item on the previous item in stack", "");
iterator->stack[iterator->stack_depth - 1] = current->next;
iterator->stack_depth++;
}
else {
TRACE_INFO_STRING("Instructed to parse just one level", "");
/* On one level - just return current */
*item = current;
TRACE_INFO_STRING("Moving to the next item on one level", "");
iterator->stack[iterator->stack_depth - 1] = current->next;
}
break;
}
else {
/* We need to ignore references so move to the next item */
TRACE_INFO_STRING("Stepping over the reference", "");
iterator->stack[iterator->stack_depth - 1] = current->next;
continue;
}
}
else {
/* Got a normal item - return it and move to the next one */
if ((current->type == COL_TYPE_COLLECTION) &&
((iterator->flags & COL_TRAVERSE_FLAT) != 0) &&
(iterator->stack_depth > 1)) {
TRACE_INFO_STRING("Header of the sub collection in flat case ", "");
iterator->stack[iterator->stack_depth - 1] = current->next;
continue;
}
else {
TRACE_INFO_STRING("Simple item", "");
*item = current;
iterator->stack[iterator->stack_depth - 1] = current->next;
}
break;
}
}
else {
/* Item is NULL */
TRACE_INFO_STRING("Finished level", "moving to upper level");
iterator->stack_depth--;
/* Remember that item_level is zero based while depth is size
* so we decrease and then assign. */
TRACE_INFO_NUMBER("Stack depth at the end:", iterator->stack_depth);
if ((iterator->flags & COL_TRAVERSE_END) != 0) {
/* Show end element
* a) If we are flattening but at the top
* b) We are not flattening
*/
if ((((iterator->flags & COL_TRAVERSE_FLAT) != 0) &&
(iterator->stack_depth == 0)) ||
((iterator->flags & COL_TRAVERSE_FLAT) == 0)) {
/* Return dummy entry to indicate the end of the collection */
TRACE_INFO_STRING("Finished level", "told to return END");
*item = iterator->end_item;
break;
}
}
else {
/* Move to next level */
continue;
}
}
}
TRACE_FLOW_STRING("col_iterate_collection", "Exit");
return EOK;
}
/* Pins down the iterator to loop around this point */
void col_pin_iterator(struct collection_iterator *iterator)
{
TRACE_FLOW_STRING("col_iterator_add_pin", "Entry");
if ((!iterator) || (!iterator->stack)) {
TRACE_FLOW_STRING("Invalid itertor", "Ingoring");
return;
}
while ((iterator->stack_depth) &&
(iterator->stack[iterator->stack_depth - 1] == NULL)) {
iterator->stack_depth--;
}
if (iterator->stack_depth == 0) {
iterator->pin = iterator->top;
iterator->pin_level = 0;
}
else {
iterator->pin = iterator->stack[iterator->stack_depth - 1];
iterator->pin_level = iterator->stack_depth - 1;
}
iterator->can_break = 0;
TRACE_FLOW_STRING("col_iterator_add_pin", "Exit");
}
/* Rewinds iterator to the beginning */
void col_rewind_iterator(struct collection_iterator *iterator)
{
TRACE_FLOW_STRING("col_rewind_iterator", "Entry");
if ((!iterator) || (!iterator->stack)) {
TRACE_FLOW_STRING("Invalid itertor", "Ingoring");
return;
}
iterator->pin = iterator->top;
iterator->stack[0] = iterator->top;
iterator->stack_depth = 1;
iterator->item_level = 0;
iterator->pin_level = 0;
iterator->can_break = 0;
TRACE_FLOW_STRING("col_rewind_iterator", "Exit");
}
ding-libs-0.6.2/collection/collection_priv.h 0000664 0000000 0000000 00000005010 14172606404 0021066 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Header file for internal structures used by the collection interface.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#ifndef COLLECTION_PRIV_H
#define COLLECTION_PRIV_H
#include
/* Define real strcutures */
/* Structure that holds one property.
* This structure should never be assumed and used directly other than
* inside the collection.c that contains actual implementation or
* collection_tools.c or collection_utils.c.
*/
struct collection_item {
/* Member that contains element linking information.
* This member should never be directly accessed by an application.
*/
struct collection_item *next;
/* Your implementation can assume that these members
* will always be members of the collection_item.
* but you should use get_item_xxx functions to get them.
*/
char *property;
int property_len;
int type;
int length;
void *data;
uint64_t phash;
};
/* Internal iterator structure - exposed for reference.
* Never access internals of this structure in your application.
*/
struct collection_iterator {
struct collection_item *top;
struct collection_item **stack;
unsigned stack_size;
unsigned stack_depth;
unsigned item_level;
int flags;
struct collection_item *end_item;
struct collection_item *pin;
unsigned pin_level;
unsigned can_break;
};
/* Special type of data that stores collection header information. */
struct collection_header {
struct collection_item *last;
unsigned reference_count;
unsigned count;
unsigned cclass;
};
/* Internal function to allocate item */
int col_allocate_item(struct collection_item **ci,
const char *property,
const void *item_data,
int length,
int type);
#endif
ding-libs-0.6.2/collection/collection_queue.c 0000664 0000000 0000000 00000024067 14172606404 0021242 0 ustar 00root root 0000000 0000000 /*
QUEUE
Implementation of the queue on top of collection library interface.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#include "collection_queue.h"
#include "trace.h"
/* Function that creates a queue object */
int col_create_queue(struct collection_item **queue)
{
int error = EOK;
TRACE_FLOW_STRING("col_create_queue", "Entry point.");
error = col_create_collection(queue, COL_NAME_QUEUE, COL_CLASS_QUEUE);
TRACE_FLOW_STRING("col_create_queue", "Exit.");
return error;
}
/* Function that destroys a queue object */
void col_destroy_queue(struct collection_item *queue)
{
TRACE_FLOW_STRING("col_destroy_queue", "Entry point.");
col_destroy_collection(queue);
TRACE_FLOW_STRING("col_destroy_queue", "Exit");
}
/* Put a string property into a queue. */
int col_enqueue_str_property(struct collection_item *queue,
const char *property,
const char *string,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_str_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_str_property(queue, NULL, property, string, length);
TRACE_FLOW_STRING("col_enqueue_str_property", "Exit.");
return error;
}
/* Put a binary property into a queue. */
int col_enqueue_binary_property(struct collection_item *queue,
const char *property,
void *binary_data,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_binary_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_binary_property(queue, NULL, property, binary_data, length);
TRACE_FLOW_STRING("col_enqueue_binary_property", "Exit.");
return error;
}
/* Put an int property into a queue. */
int col_enqueue_int_property(struct collection_item *queue,
const char *property,
int32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_int_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_int_property(queue, NULL, property, number);
TRACE_FLOW_STRING("col_enqueue_int_property", "Exit.");
return error;
}
/* Put an unsigned int property into a queue. */
int col_enqueue_unsigned_property(struct collection_item *queue,
const char *property,
uint32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_unsigned_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_unsigned_property(queue, NULL, property, number);
TRACE_FLOW_STRING("col_enqueue_unsigned_property", "Exit.");
return error;
}
/* Put a long property. */
int col_enqueue_long_property(struct collection_item *queue,
const char *property,
int64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_long_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_long_property(queue, NULL, property, number);
TRACE_FLOW_STRING("col_enqueue_long_property", "Exit.");
return error;
}
/* Put an unsigned long property. */
int col_enqueue_ulong_property(struct collection_item *queue,
const char *property,
uint64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_ulong_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_ulong_property(queue, NULL, property, number);
TRACE_FLOW_STRING("col_enqueue_ulong_property", "Exit.");
return error;
}
/* Put a double property. */
int col_enqueue_double_property(struct collection_item *queue,
const char *property,
double number)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_double_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_double_property(queue, NULL, property, number);
TRACE_FLOW_STRING("enqueue_double_property", "Exit.");
return error;
}
/* Put a bool property. */
int col_enqueue_bool_property(struct collection_item *queue,
const char *property,
unsigned char logical)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_bool_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_bool_property(queue, NULL, property, logical);
TRACE_FLOW_STRING("col_enqueue_bool_property", "Exit.");
return error;
}
/* Put any property */
int col_enqueue_any_property(struct collection_item *queue,
const char *property,
int type,
void *data,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_any_property", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_any_property(queue, NULL, property, type, data, length);
TRACE_FLOW_STRING("col_enqueue_any_property", "Exit.");
return error;
}
/* Enqueue item */
int col_enqueue_item(struct collection_item *queue,
struct collection_item *item)
{
int error = EOK;
TRACE_FLOW_STRING("col_enqueue_item", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_insert_item_into_current(queue,
item,
COL_DSP_END,
NULL,
0,
COL_INSERT_NOCHECK);
TRACE_FLOW_STRING("col_enqueue_item", "Exit.");
return error;
}
/* Dequeue item */
int col_dequeue_item(struct collection_item *queue,
struct collection_item **item)
{
int error = EOK;
TRACE_FLOW_STRING("col_dequeue_item", "Entry point.");
/* Check that queue is not empty */
if (queue == NULL) {
TRACE_ERROR_STRING("queue can't be NULL", "");
return EINVAL;
}
/* Make sure it is a queue */
if (!col_is_of_class(queue, COL_CLASS_QUEUE)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_extract_item_from_current(queue,
COL_DSP_FRONT,
NULL,
0,
0,
item);
TRACE_FLOW_STRING("col_dequeue_item", "Exit.");
return error;
}
ding-libs-0.6.2/collection/collection_queue.h 0000664 0000000 0000000 00000030575 14172606404 0021250 0 ustar 00root root 0000000 0000000 /*
QUEUE
Header file for queue implemented using collection interface.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#ifndef COLLECTION_QUEUE_H
#define COLLECTION_QUEUE_H
#include "collection.h"
/**
* @defgroup queue QUEUE interface
*
* Queue interface is a wrapper on top of the \ref collection
* interface. It implements a queue using a collection object.
*
* @{
*/
/** @brief Class for the queue object */
#define COL_CLASS_QUEUE 40000
/** @brief All queues use this name as the name of the collection */
#define COL_NAME_QUEUE "queue"
/**
* @brief Create queue.
*
* Function that creates a queue object.
*
* @param[out] queue Newly created queue object.
*
* @return 0 - Queue was created successfully.
* @return ENOMEM - No memory.
*
*/
int col_create_queue(struct collection_item **queue);
/**
* @brief Destroy queue.
*
* Function that destroys a queue object.
*
* @param[in] queue Queue object to destroy.
*
*/
void col_destroy_queue(struct collection_item *queue);
/**
* @brief Add string to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] string Null terminated string to add.
* @param[in] length Length of the string. Should include the length
* of the terminating 0.
* If the length is shorter than the full string
* the string will be truncated. If the length is
* longer than the actual string there might be
* garbage at end of the actual string.
* Library will always properly NULL terminate
* the string at the given position dictated
* by length but in no way will inspect the validity
* of the passed in data. This is left to the calling
* application.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_str_property(struct collection_item *queue,
const char *property,
const char *string,
int length);
/**
* @brief Add binary value to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] binary_data Data to add.
* @param[in] length Length of the binary data.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_binary_property(struct collection_item *queue,
const char *property,
void *binary_data,
int length);
/**
* @brief Add integer value to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_int_property(struct collection_item *queue,
const char *property,
int32_t number);
/**
* @brief Add unsigned value to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_unsigned_property(struct collection_item *queue,
const char *property,
uint32_t number);
/**
* @brief Add long integer value to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_long_property(struct collection_item *queue,
const char *property,
int64_t number);
/**
* @brief Add unsigned long value to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_ulong_property(struct collection_item *queue,
const char *property,
uint64_t number);
/**
* @brief Add floating point value to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_double_property(struct collection_item *queue,
const char *property,
double number);
/**
* @brief Add Boolean value to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] logical Value to add.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_bool_property(struct collection_item *queue,
const char *property,
unsigned char logical);
/**
* @brief Add value of any type to the queue.
*
* @param[in] queue Queue object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] type Type to use.
* @param[in] data Data to add.
* @param[in] length Length of the data.
*
* @return 0 - Property was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_enqueue_any_property(struct collection_item *queue,
const char *property,
int type,
void *data,
int length);
/**
* @brief Push item into the queue.
*
* @param[in] queue Queue object.
* @param[in] item Item to push.
*
* @return 0 - Item was added successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
*/
int col_enqueue_item(struct collection_item *queue,
struct collection_item *item);
/**
* @brief Get item from the queue.
*
* @param[in] queue Queue object.
* @param[out] item Variable receives the value
* of the retrieved item.
* Will be set to NULL if there are
* no more items in the queue.
*
* @return 0 - No internal issues detected.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
*/
int col_dequeue_item(struct collection_item *queue,
struct collection_item **item);
/**
* @}
*/
#endif
ding-libs-0.6.2/collection/collection_queue_ut.c 0000664 0000000 0000000 00000013666 14172606404 0021755 0 ustar 00root root 0000000 0000000 /*
QUEUE INTERFACE
Queue unit test.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#define TRACE_HOME
#include "trace.h"
#include "collection_queue.h"
#include "collection_tools.h"
typedef int (*test_fn)(void);
int verbose = 0;
#define COLOUT(foo) \
do { \
if (verbose) foo; \
} while(0)
static int queue_test(void)
{
struct collection_item *queue = NULL;
char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
struct collection_item *item = NULL;
int i;
unsigned count;
int error = EOK;
TRACE_FLOW_STRING("queue_test","Entry.");
COLOUT(printf("\n\nQUEUE TEST!!!.\n\n\n"));
if((error = col_create_queue(&queue)) ||
(error = col_enqueue_str_property(queue, "item1","value 1" ,0)) ||
(error = col_enqueue_int_property(queue, "item2", -1)) ||
(error = col_enqueue_unsigned_property(queue, "item3", 1)) ||
(error = col_enqueue_long_property(queue, "item4", 100)) ||
(error = col_enqueue_ulong_property(queue, "item5", 1000)) ||
(error = col_enqueue_double_property(queue, "item6", 1.1)) ||
(error = col_enqueue_bool_property(queue, "item7", 1)) ||
(error = col_enqueue_binary_property(queue, "item8", binary_dump, sizeof(binary_dump)))) {
printf("Failed to enqueue property. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT));
error = col_get_collection_count(queue, &count);
if (error) {
printf("Failed to get count. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
count--;
COLOUT(printf("Rotate the queue.\n"));
for (i = 0; i < count; i++) {
if ((error = col_dequeue_item(queue, &item)) ||
(error = col_enqueue_item(queue, item))) {
printf("Failed to dequeue or enqueue items. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT));
}
col_destroy_collection(queue);
TRACE_FLOW_NUMBER("queue_test. Returning", error);
COLOUT(printf("\n\nEND OF QUEUE TEST!!!.\n\n\n"));
return error;
}
static int empty_test(void)
{
struct collection_item *queue = NULL;
struct collection_item *item = NULL;
int i;
unsigned count;
int error = EOK;
TRACE_FLOW_STRING("empty_test","Entry.");
COLOUT(printf("\n\nEMPTY QUEUE TEST!!!.\n\n\n"));
if((error = col_create_queue(&queue)) ||
(error = col_enqueue_str_property(queue, "item1","value 1" ,0)) ||
(error = col_enqueue_int_property(queue, "item2", -1)) ||
(error = col_enqueue_unsigned_property(queue, "item3", 1))) {
printf("Failed to enqueue property. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT));
error = col_get_collection_count(queue, &count);
if (error) {
printf("Failed to get count. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
count--;
COLOUT(printf("Empty the queue.\n"));
for (i = 0; i < count; i++) {
if ((error = col_dequeue_item(queue, &item))) {
printf("Failed to dequeue or enqueue items. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
col_delete_item(item);
COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT));
}
COLOUT(printf("Add elements again.\n"));
if((error = col_enqueue_str_property(queue, "item1","value 1" ,0)) ||
(error = col_enqueue_int_property(queue, "item2", -1)) ||
(error = col_enqueue_unsigned_property(queue, "item3", 1))) {
printf("Failed to enqueue property. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT));
error = col_get_collection_count(queue, &count);
if (error) {
printf("Failed to get count. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
count--;
COLOUT(printf("Empty the queue again.\n"));
for (i = 0; i < count; i++) {
if ((error = col_dequeue_item(queue, &item))) {
printf("Failed to dequeue or enqueue items. Error %d\n", error);
col_destroy_collection(queue);
return error;
}
col_delete_item(item);
COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT));
}
col_destroy_collection(queue);
TRACE_FLOW_NUMBER("empty_test. Returning", error);
COLOUT(printf("\n\nEND OF QUEUE TEST!!!.\n\n\n"));
return error;
}
/* Main function of the unit test */
int main(int argc, char *argv[])
{
int error = 0;
test_fn tests[] = { queue_test,
empty_test,
NULL };
test_fn t;
int i = 0;
if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1;
printf("Start\n");
while ((t = tests[i++])) {
error = t();
if (error) {
printf("Failed!\n");
return error;
}
}
printf("Success!\n");
return 0;
}
ding-libs-0.6.2/collection/collection_stack.c 0000664 0000000 0000000 00000023437 14172606404 0021223 0 ustar 00root root 0000000 0000000 /*
STACK
Implementation of the stack on top of collection library interface.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#include "collection_stack.h"
#include "trace.h"
/* Function that creates a stack object */
int col_create_stack(struct collection_item **stack)
{
int error = EOK;
TRACE_FLOW_STRING("col_create_stack", "Entry point.");
error = col_create_collection(stack, COL_NAME_STACK, COL_CLASS_STACK);
TRACE_FLOW_STRING("col_create_stack", "Exit.");
return error;
}
/* Function that destroys a stack object */
void col_destroy_stack(struct collection_item *stack)
{
TRACE_FLOW_STRING("col_destroy_stack", "Entry point.");
col_destroy_collection(stack);
TRACE_FLOW_STRING("col_destroy_stack", "Exit");
}
int col_push_str_property(struct collection_item *stack,
const char *property, const char *string, int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_str_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_str_property(stack, NULL, property, string, length);
TRACE_FLOW_STRING("col_push_str_property", "Exit.");
return error;
}
/* Push a binary property to stack. */
int col_push_binary_property(struct collection_item *stack,
const char *property,
void *binary_data,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_binary_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_binary_property(stack, NULL, property, binary_data, length);
TRACE_FLOW_STRING("col_push_binary_property", "Exit.");
return error;
}
/* Push an int property to stack. */
int col_push_int_property(struct collection_item *stack,
const char *property,
int32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_int_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_int_property(stack, NULL, property, number);
TRACE_FLOW_STRING("col_push_int_property", "Exit.");
return error;
}
/* Push an unsigned int property to stack. */
int col_push_unsigned_property(struct collection_item *stack,
const char *property,
uint32_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_unsigned_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_unsigned_property(stack, NULL, property, number);
TRACE_FLOW_STRING("col_push_unsigned_property", "Exit.");
return error;
}
/* Push a long property. */
int col_push_long_property(struct collection_item *stack,
const char *property,
int64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_long_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_long_property(stack, NULL, property, number);
TRACE_FLOW_STRING("col_push_long_property", "Exit.");
return error;
}
/* Push an unsigned long property. */
int col_push_ulong_property(struct collection_item *stack,
const char *property,
uint64_t number)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_ulong_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_ulong_property(stack, NULL, property, number);
TRACE_FLOW_STRING("col_push_ulong_property", "Exit.");
return error;
}
/* Push a double property. */
int col_push_double_property(struct collection_item *stack,
const char *property,
double number)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_double_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_double_property(stack, NULL, property, number);
TRACE_FLOW_STRING("col_push_double_property", "Exit.");
return error;
}
/* Push a bool property. */
int col_push_bool_property(struct collection_item *stack,
const char *property,
unsigned char logical)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_bool_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_bool_property(stack, NULL, property, logical);
TRACE_FLOW_STRING("push_double_property", "Exit.");
return error;
}
/* Push any property */
int col_push_any_property(struct collection_item *stack,
const char *property,
int type,
void *data,
int length)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_any_property", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_add_any_property(stack, NULL, property, type, data, length);
TRACE_FLOW_STRING("col_push_any_property", "Exit.");
return error;
}
/* Push item */
int col_push_item(struct collection_item *stack,
struct collection_item *item)
{
int error = EOK;
TRACE_FLOW_STRING("col_push_item", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_insert_item_into_current(stack,
item,
COL_DSP_END,
NULL,
0,
COL_INSERT_NOCHECK);
TRACE_FLOW_STRING("col_push_item", "Exit.");
return error;
}
/* Pop_item */
int col_pop_item(struct collection_item *stack,
struct collection_item **item)
{
int error = EOK;
TRACE_FLOW_STRING("col_pop_item", "Entry point.");
/* Check that stack is not empty */
if (stack == NULL) {
TRACE_ERROR_STRING("Stack can't be NULL", "");
return EINVAL;
}
/* Make sure it is a stack */
if (!col_is_of_class(stack, COL_CLASS_STACK)) {
TRACE_ERROR_STRING("Wrong class", "");
return EINVAL;
}
error = col_extract_item_from_current(stack,
COL_DSP_END,
NULL,
0,
0,
item);
TRACE_FLOW_STRING("col_pop_item", "Exit.");
return error;
}
ding-libs-0.6.2/collection/collection_stack.h 0000664 0000000 0000000 00000030447 14172606404 0021227 0 ustar 00root root 0000000 0000000 /*
STACK
Header file for stack implemented using collection interface.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#ifndef COLLECTION_STACK_H
#define COLLECTION_STACK_H
#include
/**
* @defgroup stack STACK interface
*
* Stack interface is a wrapper on top of the \ref collection
* interface. It implements a stack using a collection object.
*
* @{
*/
/** @brief Class for the stack object */
#define COL_CLASS_STACK 30000
/** @brief All stacks use this name as the name of the collection */
#define COL_NAME_STACK "stack"
/**
* @brief Create stack.
*
* Function that creates a stack object.
*
* @param[out] stack Newly created stack object.
*
* @return 0 - Stack was created successfully.
* @return ENOMEM - No memory.
*
*/
int col_create_stack(struct collection_item **stack);
/**
* @brief Destroy stack.
*
* Function that destroys a stack object.
*
* @param[in] stack Stack object to destroy.
*
*/
void col_destroy_stack(struct collection_item *stack);
/**
* @brief Push string to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] string Null terminated string to add.
* @param[in] length Length of the string. Should include the length
* of the terminating 0.
* If the length is shorter than the full string
* the string will be truncated. If the length is
* longer than the actual string there might be
* garbage at end of the actual string.
* Library will always properly NULL terminate
* the string at the given position dictated
* by length but in no way will inspect the validity
* of the passed in data. This is left to the calling
* application.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_str_property(struct collection_item *stack,
const char *property,
const char *string,
int length);
/**
* @brief Push binary value to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] binary_data Data to add.
* @param[in] length Length of the binary data.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_binary_property(struct collection_item *stack,
const char *property,
void *binary_data,
int length);
/**
* @brief Push integer value to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_int_property(struct collection_item *stack,
const char *property,
int32_t number);
/**
* @brief Push unsigned value to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_unsigned_property(struct collection_item *stack,
const char *property,
uint32_t number);
/**
* @brief Push long integer value to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_long_property(struct collection_item *stack,
const char *property,
int64_t number);
/**
* @brief Push unsigned long value to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_ulong_property(struct collection_item *stack,
const char *property,
uint64_t number);
/**
* @brief Push floating point value to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] number Value to add.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_double_property(struct collection_item *stack,
const char *property,
double number);
/**
* @brief Push Boolean value to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] logical Value to add.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_bool_property(struct collection_item *stack,
const char *property,
unsigned char logical);
/**
* @brief Push value of any type to the stack.
*
* @param[in] stack Stack object.
* @param[in] property Name of the property.
* Name should consist of the ASCII characters
* with codes non less than space.
* Exclamation mark character is
* a special character and can't be used
* in name of collection or property.
* Maximum allowed length is defined at compile time.
* The default value is 64k.
* @param[in] type Type to use.
* @param[in] data Data to add.
* @param[in] length Length of the data.
*
* @return 0 - Property was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid characters in the property name.
* Value argument is invalid in some way.
* @return EMSGSIZE - Property name is too long.
*
*/
int col_push_any_property(struct collection_item *stack,
const char *property,
int type,
void *data,
int length);
/**
* @brief Push item into the stack.
*
* @param[in] stack Stack object.
* @param[in] item Item to push.
*
* @return 0 - Item was pushed successfully.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
*/
int col_push_item(struct collection_item *stack,
struct collection_item *item);
/**
* @brief Pop item from the stack.
*
* @param[in] stack Stack object.
* @param[out] item Variable receives the value
* of the retrieved item.
* Will be set to NULL if there are
* no more items in the stack.
*
* @return 0 - No internal issues detected.
* @return ENOMEM - No memory.
* @return EINVAL - Invalid argument.
*/
int col_pop_item(struct collection_item *stack,
struct collection_item **item);
/**
* @}
*/
#endif
ding-libs-0.6.2/collection/collection_stack_ut.c 0000664 0000000 0000000 00000007321 14172606404 0021725 0 ustar 00root root 0000000 0000000 /*
STACK INTERFACE
Stack unit test.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#define TRACE_HOME
#include "trace.h"
#include "collection_stack.h"
#include "collection_tools.h"
typedef int (*test_fn)(void);
int verbose = 0;
#define COLOUT(foo) \
do { \
if (verbose) foo; \
} while(0)
static int stack_test(void)
{
struct collection_item *stack = NULL;
char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
struct collection_item *item1 = NULL;
struct collection_item *item2 = NULL;
int error = EOK;
TRACE_FLOW_STRING("stack_test", "Entry.");
COLOUT(printf("\n\nSTACK TEST!!!.\n\n\n"));
if ((error = col_create_stack(&stack)) ||
(error = col_push_str_property(stack, "item1", "value 1", 0)) ||
(error = col_push_int_property(stack, "item2", -1)) ||
(error = col_push_unsigned_property(stack, "item3", 1)) ||
(error = col_push_long_property(stack, "item4", 100)) ||
(error = col_push_ulong_property(stack, "item5", 1000)) ||
(error = col_push_double_property(stack, "item6", 1.1)) ||
(error = col_push_bool_property(stack, "item7", 1)) ||
(error = col_push_binary_property(stack, "item8", binary_dump, sizeof(binary_dump)))) {
printf("Failed to push property. Error %d\n", error);
col_destroy_collection(stack);
return error;
}
COLOUT(col_debug_collection(stack, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Swapping last two items by popping and pushing them back.\n"));
if ((error = col_pop_item(stack, &item1)) ||
(error = col_pop_item(stack, &item2))) {
printf("Failed to pop items. Error %d\n", error);
col_destroy_collection(stack);
return error;
}
COLOUT(printf("\nPopped two last items.\n"));
COLOUT(col_debug_collection(stack, COL_TRAVERSE_DEFAULT));
COLOUT(printf("\nLast item.\n"));
COLOUT(col_debug_item(item1));
COLOUT(printf("\nPrevious item.\n"));
COLOUT(col_debug_item(item2));
if ((error = col_push_item(stack, item1)) ||
(error = col_push_item(stack, item2))) {
printf("Failed to pop or push items. Error %d\n", error);
col_destroy_collection(stack);
return error;
}
COLOUT(printf("\n\nPushed two items again in reverse order.\n\n"));
COLOUT(col_debug_collection(stack, COL_TRAVERSE_DEFAULT));
col_destroy_collection(stack);
TRACE_FLOW_NUMBER("stack_test. Returning", error);
COLOUT(printf("\n\nEND OF STACK TEST!!!.\n\n"));
return error;
}
/* Main function of the unit test */
int main(int argc, char *argv[])
{
int error = 0;
test_fn tests[] = { stack_test,
NULL };
test_fn t;
int i = 0;
if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1;
printf("Start\n");
while ((t = tests[i++])) {
error = t();
if (error) {
printf("Failed!\n");
return error;
}
}
printf("Success!\n");
return 0;
}
ding-libs-0.6.2/collection/collection_tools.c 0000664 0000000 0000000 00000053024 14172606404 0021251 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Additional functions for printing and debugging collections.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#include
#include
#include "trace.h"
#include "collection_priv.h"
#include "collection.h"
#include "collection_tools.h"
/* Debug handle */
int col_debug_handle(const char *property,
int property_len,
int type,
void *data,
int length,
void *custom_data,
int *dummy)
{
int i;
int nest_level;
int ignore = 0;
TRACE_FLOW_STRING("col_debug_handle", "Entry.");
nest_level = *(int *)(custom_data);
if (nest_level == -1) {
ignore = 1;
nest_level = 1;
}
TRACE_INFO_NUMBER("We are getting this pointer:", custom_data);
TRACE_INFO_NUMBER("Nest level:", nest_level);
switch (type) {
case COL_TYPE_STRING:
printf(">%*s%s[%d] str: %s (%d)\n",
(nest_level -1) * 4, "",
property,
length,
(char *)(data),
nest_level);
break;
case COL_TYPE_BINARY:
printf(">%*s%s[%d] bin: ",
(nest_level -1) * 4, "",
property,
length);
for (i = 0; i < length; i++)
printf("%02X", ((unsigned char *)(data))[i]);
printf(" (%d)\n", nest_level);
break;
case COL_TYPE_INTEGER:
printf(">%*s%s[%d] int: %d (%d)\n",
(nest_level -1) * 4, "",
property,
length,
*((int32_t *)(data)),
nest_level);
break;
case COL_TYPE_UNSIGNED:
printf(">%*s%s[%d] uint: %u (%d)\n",
(nest_level -1) * 4, "",
property,
length,
*((uint32_t *)(data)),
nest_level);
break;
case COL_TYPE_LONG:
printf(">%*s%s[%d] long: %lld (%d)\n",
(nest_level -1) * 4, "",
property,
length,
(long long int)(*((int64_t *)(data))),
nest_level);
break;
case COL_TYPE_ULONG:
printf(">%*s%s[%d] ulong: %llu (%d)\n",
(nest_level -1) * 4, "",
property,
length,
(long long unsigned)(*((uint64_t *)(data))),
nest_level);
break;
case COL_TYPE_DOUBLE:
printf(">%*s%s[%d] double: %.4f (%d)\n",
(nest_level -1) * 4, "",
property,
length,
*((double *)(data)),
nest_level);
break;
case COL_TYPE_BOOL:
printf(">%*s%s[%d] bool: %s (%d)\n",
(nest_level -1) * 4, "",
property,
length,
(*((unsigned char *)(data)) == '\0') ? "false" : "true",
nest_level);
break;
case COL_TYPE_COLLECTION:
if (!ignore) nest_level++;
printf(">%*s%s[%d] header: count %d, ref_count %d class %d data: ",
(nest_level -1) * 4, "",
property,
length,
((struct collection_header *)(data))->count,
((struct collection_header *)(data))->reference_count,
((struct collection_header *)(data))->cclass);
/* Due to padding issues this is unsafe so ifdefed for now */
#ifdef COL_PRINT_BINARY_HEADER
for (i = 0; i < length; i++)
printf("%02X", ((unsigned char *)(data))[i]);
#endif
printf(" (%d)\n", nest_level);
break;
case COL_TYPE_COLLECTIONREF:
printf(">%*s%s[%d] external link: ",
(nest_level -1) * 4, "",
property,
length);
for (i = 0; i < length; i++)
printf("%02X", ((unsigned char *)(data))[i]);
printf(" (%d)\n", nest_level);
break;
case COL_TYPE_END:
printf(">%*sEND[N/A] (%d)\n",
(nest_level -1) * 4, "",
nest_level);
if (!ignore) nest_level--;
break;
default:
printf("Not implemented yet.\n");
break;
}
*(int *)(custom_data) = nest_level;
TRACE_INFO_NUMBER("Nest level at the end:", nest_level);
TRACE_FLOW_STRING("col_debug_handle", "Success exit.");
return EOK;
}
/* Convenience function to debug an item */
inline int col_debug_item(struct collection_item *item)
{
int dummy = 0;
int nest_level = -1;
return col_debug_handle(item->property,
item->property_len,
item->type,
item->data,
item->length,
(void *)(&nest_level),
&dummy);
}
/* Print collection for debugging purposes */
int col_debug_collection(struct collection_item *handle, int flag)
{
int error = EOK;
int nest_level = 0;
TRACE_FLOW_STRING("col_debug_collection", "Entry.");
printf("DEBUG COLLECTION %s\n", handle->property);
flag |= COL_TRAVERSE_END;
printf("Traverse flags %d\n", flag);
/* Traverse collection */
error = col_traverse_collection(handle, flag,
col_debug_handle,
(void *)(&nest_level));
if (error) printf("Error debuging collection %d\n", error);
TRACE_FLOW_STRING("col_debug_collection", "Exit.");
return error;
}
/* Return a static string based on type of the element */
static inline const char *col_get_type(int type)
{
switch (type) {
case COL_TYPE_STRING:
return COL_TYPE_NAME_STRING;
case COL_TYPE_INTEGER:
return COL_TYPE_NAME_INTEGER;
case COL_TYPE_UNSIGNED:
return COL_TYPE_NAME_UNSIGNED;
case COL_TYPE_LONG:
return COL_TYPE_NAME_LONG;
case COL_TYPE_ULONG:
return COL_TYPE_NAME_ULONG;
case COL_TYPE_BINARY:
return COL_TYPE_NAME_BINARY;
case COL_TYPE_DOUBLE:
return COL_TYPE_NAME_DOUBLE;
case COL_TYPE_BOOL:
return COL_TYPE_NAME_BOOL;
default:
return COL_TYPE_NAME_UNKNOWN;
}
}
/* Calculate the potential size of the item */
int col_get_data_len(int type, int length)
{
int len = 0;
TRACE_FLOW_STRING("col_get_data_len", "Entry point");
switch (type) {
case COL_TYPE_INTEGER:
case COL_TYPE_UNSIGNED:
len = 11;
break;
case COL_TYPE_LONG:
case COL_TYPE_ULONG:
len = 20;
break;
case COL_TYPE_STRING:
case COL_TYPE_BINARY:
len = length * 2 + 2;
break;
case COL_TYPE_DOUBLE:
len = 64;
break;
case COL_TYPE_BOOL:
len = 6;
break;
default:
len = 0;
break;
}
TRACE_FLOW_STRING("col_get_data_len","Exit point");
return len;
}
/* Copy data escaping characters */
static int col_copy_esc(char *dest, const char *source, char esc)
{
int i = 0;
int j = 0;
dest[j] = esc;
j++;
while (source[i]) {
if ((source[i] == '\\') ||
(source[i] == esc)) {
dest[j] = '\\';
j++;
}
dest[j] = source[i];
i++;
j++;
}
dest[j] = esc;
j++;
return j;
}
/* Grow buffer to accomodate more space */
int col_grow_buffer(struct col_serial_data *buf_data, int len)
{
char *tmp;
TRACE_FLOW_STRING("col_grow_buffer", "Entry point");
TRACE_INFO_NUMBER("Current length: ", buf_data->length);
TRACE_INFO_NUMBER("Increment length: ", len);
TRACE_INFO_NUMBER("Expected length: ", buf_data->length+len);
TRACE_INFO_NUMBER("Current size: ", buf_data->size);
/* Grow buffer if needed */
while (buf_data->length+len >= buf_data->size) {
tmp = realloc(buf_data->buffer, buf_data->size + BLOCK_SIZE);
if (tmp == NULL) {
TRACE_ERROR_NUMBER("Error. Failed to allocate memory.", ENOMEM);
return ENOMEM;
}
buf_data->buffer = tmp;
buf_data->size += BLOCK_SIZE;
TRACE_INFO_NUMBER("New size: ", buf_data->size);
}
TRACE_INFO_NUMBER("Final size: ", buf_data->size);
TRACE_FLOW_STRING("col_grow_buffer", "Success Exit.");
return EOK;
}
/* Specail function to add different formatting symbols to the output */
int col_put_marker(struct col_serial_data *buf_data, const void *data, int len)
{
int error = EOK;
TRACE_FLOW_STRING("col_put_marker", "Entry point");
TRACE_INFO_NUMBER("Marker length: ", len);
error = col_grow_buffer(buf_data, len);
if (error) {
TRACE_ERROR_NUMBER("col_grow_buffer failed with: ", error);
return error;
}
memcpy(buf_data->buffer + buf_data->length, data, len);
buf_data->length += len;
buf_data->buffer[buf_data->length] = '\0';
TRACE_FLOW_STRING("col_put_marker","Success exit");
return error;
}
/* Add item's data */
int col_serialize(const char *property_in,
int property_len_in,
int type,
void *data_in,
int length_in,
void *custom_data,
int *dummy)
{
int len;
struct col_serial_data *buf_data;
const char *property;
const void *data;
int property_len;
int length;
int error = EOK;
int i;
TRACE_FLOW_STRING("col_serialize","Entry point");
*dummy = 0;
/* Check is there is buffer. If not allocate */
buf_data = (struct col_serial_data *)custom_data;
if (buf_data == NULL) {
TRACE_ERROR_STRING("Error.", "Storage data is not passed in!");
return EINVAL;
}
if (buf_data->buffer == NULL) {
TRACE_INFO_STRING("First time use.", "Allocating buffer.");
buf_data->buffer = malloc(BLOCK_SIZE);
if (buf_data->buffer == NULL) {
TRACE_ERROR_NUMBER("Error. Failed to allocate memory.", ENOMEM);
return ENOMEM;
}
buf_data->buffer[0] = '\0';
buf_data->length = 0;
buf_data->size = BLOCK_SIZE;
}
TRACE_INFO_NUMBER("Buffer len: ", buf_data->length);
TRACE_INFO_NUMBER("Buffer size: ", buf_data->size);
TRACE_INFO_STRING("Buffer: ", buf_data->buffer);
/* Check the beginning of the collection */
if (type == COL_TYPE_COLLECTION) {
TRACE_INFO_STRING("Serializing collection: ", property_in);
TRACE_INFO_STRING("First header. ", "");
error = col_put_marker(buf_data, "(", 1);
if (error != EOK) return error;
property = TEXT_COLLECTION;
property_len = TEXT_COLLEN;
data = property_in;
length = property_len_in + 1;
type = COL_TYPE_STRING;
buf_data->nest_level++;
}
/* Check for subcollections */
else if (type == COL_TYPE_COLLECTIONREF) {
/* Skip */
TRACE_FLOW_STRING("col_serialize", "skip reference return");
return EOK;
}
/* Check for the end of the collection */
else if (type == COL_TYPE_END) {
if ((buf_data->length > 0) &&
(buf_data->buffer[buf_data->length-1] == ',')) {
buf_data->length--;
buf_data->buffer[buf_data->length] = '\0';
}
if (buf_data->nest_level > 0) {
buf_data->nest_level--;
error = col_put_marker(buf_data, ")", 1);
if (error != EOK) return error;
}
TRACE_FLOW_STRING("col_serialize", "end collection item processed returning");
return EOK;
}
else {
property = property_in;
property_len = property_len_in;
data = data_in;
length = length_in;
}
TRACE_INFO_STRING("Property: ", property);
TRACE_INFO_NUMBER("Property length: ", property_len);
/* Start with property and "=" */
if ((error = col_put_marker(buf_data, property, property_len)) ||
(error = col_put_marker(buf_data, "=", 1))) {
TRACE_ERROR_NUMBER("put_marker returned error: ", error);
return error;
}
/* Get projected length of the item */
len = col_get_data_len(type,length);
TRACE_INFO_NUMBER("Expected data length: ",len);
TRACE_INFO_STRING("Buffer so far: ", buf_data->buffer);
/* Make sure we have enough space */
if ((error = col_grow_buffer(buf_data, len))) {
TRACE_ERROR_NUMBER("grow_buffer returned error: ", error);
return error;
}
/* Add the value */
switch (type) {
case COL_TYPE_STRING:
/* Escape double quotes */
len = col_copy_esc(&buf_data->buffer[buf_data->length],
(const char *)(data), '"');
break;
/* Here and below it is safe to use sprintf() becuase we
* already pre-calculated the length and allocated buffer
* of the right size.
*/
case COL_TYPE_BINARY:
buf_data->buffer[buf_data->length] = '\'';
for (i = 0; i < length; i++)
sprintf(&buf_data->buffer[buf_data->length + i *2] + 1,
"%02X", (unsigned int)(((const unsigned char *)(data))[i]));
len = length * 2 + 1;
buf_data->buffer[buf_data->length + len] = '\'';
len++;
break;
case COL_TYPE_INTEGER:
len = sprintf(&buf_data->buffer[buf_data->length],
"%d", *((const int32_t *)(data)));
break;
case COL_TYPE_UNSIGNED:
len = sprintf(&buf_data->buffer[buf_data->length],
"%u", *((const uint32_t *)(data)));
break;
case COL_TYPE_LONG:
len = sprintf(&buf_data->buffer[buf_data->length],
"%lld",
(long long int)(*((const int64_t *)(data))));
break;
case COL_TYPE_ULONG:
len = sprintf(&buf_data->buffer[buf_data->length],
"%llu",
(long long unsigned)(*((const uint64_t *)(data))));
break;
case COL_TYPE_DOUBLE:
len = sprintf(&buf_data->buffer[buf_data->length],
"%.4f", *((const double *)(data)));
break;
case COL_TYPE_BOOL:
len = sprintf(&buf_data->buffer[buf_data->length],
"%s", (*((const unsigned char *)(data))) ? "true" : "false");
break;
default:
buf_data->buffer[buf_data->length] = '\0';
len = 0;
break;
}
/* Adjust length */
buf_data->length += len;
buf_data->buffer[buf_data->length] = '\0';
/* Always put a comma at the end */
error = col_put_marker(buf_data, ",", 1);
if (error != EOK) {
TRACE_ERROR_NUMBER("put_marker returned error: ", error);
return error;
}
TRACE_INFO_STRING("Data: ", buf_data->buffer);
TRACE_FLOW_STRING("col_serialize", "Exit point");
return EOK;
}
/* Print the collection using default serialization */
int col_print_collection(struct collection_item *handle)
{
struct col_serial_data buf_data;
int error = EOK;
TRACE_FLOW_STRING("col_print_collection", "Entry");
printf("COLLECTION:\n");
buf_data.buffer = NULL;
buf_data.length = 0;
buf_data.size = 0;
buf_data.nest_level = 0;
/* Traverse collection */
error = col_traverse_collection(handle,
COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END ,
col_serialize, (void *)(&buf_data));
if (error)
printf("Error traversing collection %d\n", error);
else
printf("%s\n", buf_data.buffer);
free(buf_data.buffer);
TRACE_FLOW_NUMBER("col_print_collection returning", error);
return error;
}
/* Print the collection using iterator */
int col_print_collection2(struct collection_item *handle)
{
struct collection_iterator *iterator = NULL;
int error = EOK;
struct collection_item *item = NULL;
int nest_level = 0;
int dummy = 0;
int line = 1;
TRACE_FLOW_STRING("col_print_collection2", "Entry");
/* If we have something to print print it */
if (handle == NULL) {
TRACE_ERROR_STRING("No error list", "");
return EINVAL;
}
/* Bind iterator */
error = col_bind_iterator(&iterator, handle,
COL_TRAVERSE_DEFAULT |
COL_TRAVERSE_END |
COL_TRAVERSE_SHOWSUB);
if (error) {
TRACE_ERROR_NUMBER("Error (bind):", error);
return error;
}
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
TRACE_ERROR_NUMBER("Error (iterate):", error);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) break;
if (item->type != COL_TYPE_END) printf("%05d", line);
col_debug_handle(item->property,
item->property_len,
item->type,
item->data,
item->length,
(void *)(&nest_level),
&dummy);
line++;
}
while(1);
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
TRACE_INFO_STRING("col_print_collection2", "Exit");
return EOK;
}
/* Find and print one item using default serialization */
int col_print_item(struct collection_item *handle, const char *name)
{
struct col_serial_data buf_data;
int error = EOK;
TRACE_FLOW_STRING("col_print_item", "Entry");
printf("PRINT ITEM:\n");
buf_data.buffer = NULL;
buf_data.length = 0;
buf_data.size = 0;
buf_data.nest_level = 0;
error = col_get_item_and_do(handle, name, COL_TYPE_ANY,
COL_TRAVERSE_DEFAULT,
col_serialize, &buf_data);
if(error) printf("Error searching collection %d\n", error);
else {
if (buf_data.buffer != NULL) {
if (buf_data.length > 0) buf_data.length--;
buf_data.buffer[buf_data.length] = '\0';
printf("%s\n", buf_data.buffer);
free(buf_data.buffer);
}
else {
printf("Name %s is not found in the collection %s.\n",
name, handle->property);
}
}
TRACE_FLOW_NUMBER("col_print_item returning", error);
return error;
}
/* Function to free the list of properties. */
void col_free_property_list(char **str_list)
{
int current = 0;
TRACE_FLOW_STRING("col_free_property_list","Entry");
if (str_list != NULL) {
while(str_list[current]) {
free(str_list[current]);
current++;
}
free(str_list);
}
TRACE_FLOW_STRING("col_free_property_list","Exit");
}
/* Convert collection to list of properties */
char **col_collection_to_list(struct collection_item *handle, int *size, int *error)
{
struct collection_iterator *iterator;
struct collection_item *item = NULL;
char **list;
unsigned count;
int err;
int current = 0;
TRACE_FLOW_STRING("col_collection_to_list","Entry");
/* Get number of the subsections */
err = col_get_collection_count(handle, &count);
if (err) {
TRACE_ERROR_NUMBER("Failed to get count of items from collection.", err);
if (error) *error = err;
return NULL;
}
/* Allocate memory for the sections */
list = (char **)malloc(count * sizeof(char *));
if (list == NULL) {
TRACE_ERROR_NUMBER("Failed to get allocate memory.", ENOMEM);
if (error) *error = ENOMEM;
return NULL;
}
/* Now iterate to fill in the sections */
/* Bind iterator */
err = col_bind_iterator(&iterator, handle, COL_TRAVERSE_ONELEVEL);
if (err) {
TRACE_ERROR_NUMBER("Failed to bind.", err);
if (error) *error = err;
free(list);
return NULL;
}
while(1) {
/* Loop through a collection */
err = col_iterate_collection(iterator, &item);
if (err) {
TRACE_ERROR_NUMBER("Failed to iterate collection", err);
if (error) *error = err;
col_free_property_list(list);
col_unbind_iterator(iterator);
return NULL;
}
/* Are we done ? */
if (item == NULL) break;
TRACE_INFO_STRING("Property:", col_get_item_property(item, NULL));
/* Skip head */
if(col_get_item_type(item) == COL_TYPE_COLLECTION) continue;
/* Allocate memory for the new string */
list[current] = strdup(col_get_item_property(item, NULL));
if (list[current] == NULL) {
TRACE_ERROR_NUMBER("Failed to dup string.", ENOMEM);
if (error) *error = ENOMEM;
col_free_property_list(list);
return NULL;
}
current++;
}
list[current] = NULL;
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
if (size) *size = (int)(count - 1);
if (error) *error = EOK;
TRACE_FLOW_STRING("col_collection_to_list returning", ((list == NULL) ? "NULL" : list[0]));
return list;
}
ding-libs-0.6.2/collection/collection_tools.h 0000664 0000000 0000000 00000017666 14172606404 0021272 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Header file for supplementary functions that provide
printing and debugging of collections.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#ifndef COLLECTION_TOOLS_H
#define COLLECTION_TOOLS_H
#include "collection.h"
/**
* @defgroup tools TOOLS interface
*
* Additional functions retaed to tracing,
* printing, debugging and serializaing collections.
*
* Functions in this module are more a sample implementation
* than a part of the interface. There is a chance they will
* change over time.
*
* @{
*/
#ifdef HAVE_TRACE
#define COL_DEBUG_COLLECTION(collection) col_debug_collection(collection,COL_TRAVERSE_DEFAULT);
#else
#define COL_DEBUG_COLLECTION(collection) ;
#endif
/** @brief Name used for string type. */
#define COL_TYPE_NAME_STRING "string"
/** @brief Name used for binary type. */
#define COL_TYPE_NAME_BINARY "bin"
/** @brief Name used for integer type. */
#define COL_TYPE_NAME_INTEGER "int"
/** @brief Name used for unsigned integer type. */
#define COL_TYPE_NAME_UNSIGNED "uint"
/** @brief Name used for long type. */
#define COL_TYPE_NAME_LONG "long"
/** @brief Name used for unsigned long type. */
#define COL_TYPE_NAME_ULONG "ulong"
/** @brief Name used for floating point type. */
#define COL_TYPE_NAME_DOUBLE "double"
/** @brief Name used for boolean type. */
#define COL_TYPE_NAME_BOOL "bool"
/** @brief Name used for unknown type. */
#define COL_TYPE_NAME_UNKNOWN "unknown"
/** @brief Literal used in the default serialization. */
#define TEXT_COLLECTION "SET"
/** @brief Length of the \ref TEXT_COLLECTION literal. */
#define TEXT_COLLEN 3
/**
* @brief The data will be allocated in BLOCK_SIZE
* blocks during serialization.
*/
#define BLOCK_SIZE 1024
/**
* @struct col_serial_data
* @brief Structure is used to incrementaly serialize collection.
*/
struct col_serial_data {
char *buffer;
int size;
int length;
int nest_level;
};
/**
* @brief Calculate the potential size of the item.
*
* @param[in] type Type of the value.
* @param[in] length Length of the value.
*
* @return Maximum length the value would occupy when serialized.
*/
int col_get_data_len(int type, int length);
/**
* @brief Grow serialization buffer.
*
* @param[in] buf_data Serialization object.
* @param[in] len For how much the serialization storage
* should be incrementally increased.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_grow_buffer(struct col_serial_data *buf_data, int len);
/**
* @brief Add special data to the serialization output.
*
* @param[in] buf_data Serialization object.
* @param[in] data Pointer to special data.
* @param[in] len Length of the data to insert.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_put_marker(struct col_serial_data *buf_data,
const void *data, int len);
/**
* @brief Serialization of data callback.
*
* @param[in] property_in Property to serialize.
* @param[in] property_len_in Length of the property to serialize.
* @param[in] type Type of the value.
* @param[in] data_in Value to serialize.
* @param[in] length_in Length of the value.
* @param[in] custom_data State data passed to callback.
* It is actually a serialization object.
* @param[in] dummy Not used. It is here because
* the callback needs to comply
* to the functions signature.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_serialize(const char *property_in,
int property_len_in,
int type,
void *data_in,
int length_in,
void *custom_data,
int *dummy);
/**
* @brief Debug property callback.
*
* @param[in] property Property to debug.
* @param[in] property_len Length of the property to debug.
* @param[in] type Type of the value.
* @param[in] data Value to serialize.
* @param[in] length Length of the value.
* @param[in] custom_data State data passed to the callback.
* @param[in] dummy Not used. It is here because
* the callback needs to comply
* to the functions signature.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_debug_handle(const char *property,
int property_len,
int type,
void *data,
int length,
void *custom_data,
int *dummy);
/**
* @brief Convenience function to debug an item.
*
* Prints item internals.
*
* @param[in] item Item to print.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_debug_item(struct collection_item *item);
/**
* @brief Print collection for debugging purposes.
*
* Prints collection internals.
*
* @param[in] handle Collection to debug.
* @param[in] flag See traverse flags.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_debug_collection(struct collection_item *handle,
int flag);
/**
* @brief Print collection data.
*
* Prints collection data.
* Uses traverse function to iterate through
* the collection.
*
* @param[in] handle Collection to print.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_print_collection(struct collection_item *handle);
/**
* @brief Print collection data.
*
* Prints collection data.
* Uses iterator to process the collection.
*
* @param[in] handle Collection to print.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_print_collection2(struct collection_item *handle);
/**
* @brief Find and print one property.
*
* Prints item data.
*
* @param[in] handle Collection to search.
* @param[in] name Item to find and print.
*
* @return 0 - Success.
* @return ENOMEM - No memory.
*/
int col_print_item(struct collection_item *handle, const char *name);
/**
* @brief Convert collection to the array of properties.
*
* @param[in] handle Collection to convert.
* @param[in] size Will receive the number of
* the strings in the array.
* Can be NULL if caller is not interested
* in the size of the array.
* @param[in] error Will receive error value if any.
* Can be NULL if the caller does
* not care about error codes.
* - 0 - Success.
* - ENOMEM - No memory.
*
* @return List of strings that constitute
* the properties in the collection.
* Collection name is not included.
*/
char **col_collection_to_list(struct collection_item *handle,
int *size,
int *error);
/**
* @brief Free list of properties.
*
* @param[in] str_list List to free.
*/
void col_free_property_list(char **str_list);
/**
* @}
*/
#endif
ding-libs-0.6.2/collection/collection_ut.c 0000664 0000000 0000000 00000245157 14172606404 0020553 0 ustar 00root root 0000000 0000000 /*
COLLECTION LIBRARY
Collection unit test.
Copyright (C) Dmitri Pal 2009
Collection Library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Collection Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Collection Library. If not, see .
*/
#include "config.h"
#include
#include
#include
#define TRACE_HOME
#include "trace.h"
#include "collection.h"
#include "collection_tools.h"
typedef int (*test_fn)(void);
int verbose = 0;
#define COLOUT(foo) \
do { \
if (verbose) foo; \
} while(0)
static int dup_test(void)
{
int error = EOK;
struct collection_item *dup = NULL;
struct collection_item *item = NULL;
int i;
const char *results[] = { "value5",
"value5",
"value0",
"value1",
"value2",
"value3",
"value4",
"value5" };
TRACE_FLOW_ENTRY();
COLOUT(printf("\n\nDUP TEST!!!.\n\n\n"));
COLOUT(printf("Creating DUP collection.\n"));
if ((error = col_create_collection(&dup, "dup", 0)) ||
(error = col_add_str_property(dup, NULL, "key", "value0", 0)) ||
(error = col_add_str_property(dup, NULL, "key", "value1", 0)) ||
(error = col_add_str_property(dup, NULL, "key", "value2", 0)) ||
(error = col_add_str_property(dup, NULL, "foo", "bar", 0)) ||
(error = col_add_str_property(dup, NULL, "key", "value3", 0)) ||
(error = col_add_str_property(dup, NULL, "key", "value4", 0)) ||
(error = col_add_str_property(dup, NULL, "key", "value5", 0))) {
printf("Failed to add property. Error %d\n", error);
col_destroy_collection(dup);
return error;
}
COLOUT(col_debug_collection(dup, COL_TRAVERSE_DEFAULT));
if (!col_get_dup_item(NULL, NULL, "key", COL_TYPE_ANY, 10000, 0, &item) ||
!col_get_dup_item(dup, NULL, NULL, COL_TYPE_ANY, 10000, 0, &item) ||
!col_get_dup_item(dup, NULL, "key", COL_TYPE_ANY, 10000, 1, &item) ||
!col_get_dup_item(dup, NULL, "key", COL_TYPE_STRING, 0, 1, NULL)) {
/* Expected error but did not get it */
printf("Expected error but got success.\n");
col_destroy_collection(dup);
return EINVAL;
}
for (i = 0; i < 6; i++) {
error = col_get_dup_item(dup, NULL, "key",
COL_TYPE_STRING, i, 1, &item);
if (error) {
printf("Search returned error %d.\n", error);
col_destroy_collection(dup);
return error;
}
if (!item) {
printf("Item should be found - but in reality is NULL.\n");
col_destroy_collection(dup);
return EINVAL;
}
if (strcmp((char *)col_get_item_data(item), results[i+2]) != 0) {
printf("Expected %s got %s.\n", results[i+2],
(char *)col_get_item_data(item));
col_destroy_collection(dup);
return EINVAL;
}
}
col_destroy_collection(dup);
TRACE_FLOW_EXIT();
COLOUT(printf("\n\nEND OF DUP TEST!!!.\n\n\n"));
return EOK;
}
static int ref_collection_test(void)
{
struct collection_item *peer = NULL;
struct collection_item *socket = NULL;
struct collection_item *socket2 = NULL;
char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
int error = EOK;
TRACE_FLOW_STRING("ref_collection_test", "Entry.");
COLOUT(printf("\n\nREF TEST!!!.\n\n\n"));
COLOUT(printf("Creating PEER collection.\n"));
if ((error = col_create_collection(&peer, "peer", 0)) ||
(error = col_add_str_property(peer, NULL, "hostname", "peerhost.mytest.com", 0)) ||
/* Expect trailing zero to be truncated */
(error = col_add_str_property(peer, NULL, "IPv4", "10.10.10.10", 12)) ||
(error = col_add_str_property(peer, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0))) {
printf("Failed to add property. Error %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("Creating SOCKET collection.\n"));
if ((error = col_create_collection(&socket, "socket", 0)) ||
(error = col_add_int_property(socket, NULL, "id", 1)) ||
(error = col_add_long_property(socket, NULL, "packets", 100000000L)) ||
(error = col_add_binary_property(socket, NULL, "stack", binary_dump, sizeof(binary_dump)))) {
col_destroy_collection(peer);
col_destroy_collection(socket);
printf("Failed to add property. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Adding PEER collection to SOCKET collection as a reference named PEER\n"));
/* Embed peer host into the socket2 as reference */
error = col_add_collection_to_collection(socket, NULL, "peer", peer, COL_ADD_MODE_REFERENCE);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(socket);
printf("Failed to add collection to collection. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
COLOUT(printf("About to destroy PEER\n"));
col_destroy_collection(peer);
COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT));
COLOUT(printf("About to extract PEER\n"));
error = col_get_collection_reference(socket, &peer, "peer");
if (error) {
col_destroy_collection(socket);
printf("Failed to extract collection. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
col_destroy_collection(peer);
COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT));
error = col_get_collection_reference(socket, &socket2, NULL);
if (error) {
col_destroy_collection(socket);
printf("Failed to extract collection. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT));
col_destroy_collection(socket);
COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT));
col_destroy_collection(socket2);
TRACE_FLOW_NUMBER("ref_collection_test. Returning", error);
COLOUT(printf("\n\nEND OF REF TEST!!!.\n\n\n"));
return error;
}
static int single_collection_test(void)
{
struct collection_item *handle = NULL;
int error = EOK;
TRACE_FLOW_STRING("single_collection_test", "Entry.");
if ((error = col_create_collection(&handle, "string_test", 0)) ||
(error = col_add_str_property(handle, NULL, "property_1", "some data", 0)) ||
(error = col_add_str_property(handle, NULL, "property_2", "some other data", 2)) ||
(error = col_add_str_property(handle, NULL, "property_3", "more data", 7))) {
printf("Failed to add property. Error %d\n", error);
col_destroy_collection(handle);
return error;
}
error = col_add_str_property(handle, NULL, "property 1!", "some data", 0);
if (error) {
COLOUT(printf("Expected error adding bad property to collection %d\n", error));
}
else {
printf("Expected error but got success\n");
return -1;
}
error = col_add_double_property(handle, NULL, "double", 0.253545);
if (error) {
printf("Failed to add double property. Error %d\n", error);
col_destroy_collection(handle);
return error;
}
error = col_update_double_property(handle, "double", COL_TRAVERSE_DEFAULT, 1.999999);
if (error) {
printf("Failed to update double property. Error %d\n", error);
col_destroy_collection(handle);
return error;
}
COLOUT(printf("Created collection\n"));
/* Traverse collection */
if (verbose) {
error = col_debug_collection(handle, COL_TRAVERSE_DEFAULT);
if (error) {
printf("Error debugging collection %d\n", error);
return error;
}
error = col_print_collection(handle);
if (error) {
printf("Error printing collection %d\n", error);
return error;
}
}
col_destroy_collection(handle);
TRACE_FLOW_NUMBER("single_collection_test. Error: ", error);
return error;
}
static int add_collection_test(void)
{
struct collection_item *peer = NULL;
struct collection_item *socket = NULL;
char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
int error = EOK;
TRACE_FLOW_STRING("add_collection_test", "Entry.");
COLOUT(printf("\n\nADD TEST!!!.\n\n\n"));
COLOUT(printf("Creating PEER collection.\n"));
if ((error = col_create_collection(&peer, "peer", 0)) ||
(error = col_add_str_property(peer, NULL, "hostname", "peerhost.mytest.com", 0)) ||
/* Expect trailing zero to be truncated */
(error = col_add_str_property(peer, NULL, "IPv4", "10.10.10.10", 12)) ||
(error = col_add_str_property(peer, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0))) {
printf("Failed to add property. Error %d", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("Creating SOCKET collection.\n"));
if ((error = col_create_collection(&socket, "socket", 0)) ||
(error = col_add_int_property(socket, NULL, "id", 1)) ||
(error = col_add_long_property(socket, NULL, "packets", 100000000L)) ||
(error = col_add_binary_property(socket, NULL, "stack", binary_dump, sizeof(binary_dump)))) {
col_destroy_collection(peer);
col_destroy_collection(socket);
printf("Failed to add property. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Adding PEER collection to SOCKET collection as a reference named PEER\n"));
/* Embed peer host into the socket2 as reference */
error = col_add_collection_to_collection(socket, NULL, "peer", peer, COL_ADD_MODE_REFERENCE);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(socket);
printf("Failed to create collection. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
col_destroy_collection(peer);
COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT));
col_destroy_collection(socket);
TRACE_FLOW_NUMBER("add_collection_test. Returning", error);
return error;
}
static int copy_cb(struct collection_item *item,
void *ext_data,
int *skip)
{
COLOUT(printf("INSIDE Copy Callback\n"));
COLOUT(col_debug_item(item));
COLOUT(printf("Passed in data: %s\n", (char *) ext_data));
if (strcmp(col_get_item_property(item, NULL), "id") == 0) *skip = 1;
return EOK;
}
static int mixed_collection_test(void)
{
struct collection_item *peer;
struct collection_item *socket1;
struct collection_item *socket2;
struct collection_item *socket3;
struct collection_item *event;
struct collection_item *host;
char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
int found = 0;
unsigned int class = 0;
char foo[] = "foo";
int error = EOK;
TRACE_FLOW_STRING("mixed_collection_test", "Entry.");
COLOUT(printf("\n\nMIXED TEST!!!.\n\n\n"));
COLOUT(printf("Creating PEER collection.\n"));
if ((error = col_create_collection(&peer, "peer", 0)) ||
(error = col_add_str_property(peer, NULL, "hostname", "peerhost.mytest.com", 0)) ||
/* Expect trailing zero to be truncated */
(error = col_add_str_property(peer, NULL, "IPv4", "10.10.10.10", 12)) ||
(error = col_add_str_property(peer, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0))) {
printf("Failed to add property. Error %d", error);
col_destroy_collection(peer);
return error;
}
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Creating HOST collection.\n"));
if ((error = col_create_collection(&host, "host", 0)) ||
(error = col_add_str_property(host, NULL, "hostname", "myhost.mytest.com", 0)) ||
(error = col_add_str_property(host, NULL, "IPv4", "20.20.20.20", 13)) ||
(error = col_add_str_property(host, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0)) ||
(error = col_add_double_property(host, NULL, "double", 0.253545))) {
printf("Failed to add property. Error %d", error);
col_destroy_collection(peer);
col_destroy_collection(host);
return error;
}
COLOUT(col_debug_collection(host, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Creating SOCKET1 collection.\n"));
if ((error = col_create_collection(&socket1, "socket1", 0)) ||
(error = col_add_int_property(socket1, NULL, "id", 1)) ||
(error = col_add_long_property(socket1, NULL, "packets", 100000000L)) ||
(error = col_add_binary_property(socket1, NULL, "stack", binary_dump, sizeof(binary_dump)))) {
col_destroy_collection(peer);
col_destroy_collection(host);
col_destroy_collection(socket1);
printf("Failed to add property. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket1, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Creating a copy of SOCKET1 collection named SOCKET2.\n"));
error = col_copy_collection(&socket2, socket1, "socket2", COL_COPY_NORMAL);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
col_destroy_collection(socket1);
printf("Failed to copy collection. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
error = col_copy_collection_with_cb(&socket3, socket1, "socket3",
COL_COPY_FLATDOT, copy_cb, (void *)foo);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
printf("Failed to copy collection. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket3, COL_TRAVERSE_DEFAULT));
col_destroy_collection(socket3);
COLOUT(printf("Adding PEER collection to SOCKET2 collection as a reference named PEER2\n"));
/* Embed peer host into the socket2 as reference */
error = col_add_collection_to_collection(socket2, NULL, "peer2", peer, COL_ADD_MODE_REFERENCE);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
printf("Failed to create collection. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Creating an EVENT collection.\n"));
/* Construct event */
error = col_create_collection(&event, "event", 0);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
printf("Failed to create collection. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Adding HOST to EVENT.\n"));
/* Add host to event */
error = col_add_collection_to_collection(event, NULL, NULL, host, COL_ADD_MODE_REFERENCE);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Failed to add collections. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Embed SOCKET1 into EVENT.\n"));
/* Donate socket1 to event */
/* Socket1 should not be used after this */
error = col_add_collection_to_collection(event, NULL, NULL, socket1, COL_ADD_MODE_EMBED);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Failed to add collections. Error %d\n", error);
return error;
}
COLOUT(printf("Traverse one level:\n"));
COLOUT(col_debug_collection(event, COL_TRAVERSE_ONELEVEL));
COLOUT(printf("Traverse ignore subcollections:\n"));
COLOUT(col_debug_collection(event, COL_TRAVERSE_IGNORE));
COLOUT(printf("Traverse normal:\n"));
COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT));
COLOUT(col_debug_collection(socket1, COL_TRAVERSE_DEFAULT));
COLOUT(printf("SOCKET1 MUST NOT BE USED AFTER THIS POINT!!!\n"));
socket1 = NULL;
COLOUT(printf("Add collection PEER as PEER1 to subcollection SOCKET1 of the EVENT.\n"));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
error = col_add_collection_to_collection(event, "socket1", "peer1", peer, COL_ADD_MODE_CLONE);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
/* No socket1 any more :) */
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Failed to add collections. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Add property named TIMEOUT to PEER collection.\n"));
/* Add new property to the peer collection */
error = col_add_int_property(peer, NULL, "timeout", 5);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
/* No socket1 any more :) */
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Failed to add property. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Add property named DELAY to PEER1 collection.\n"));
error = col_add_int_property(event, "peer1", "delay", 10);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
/* No socket1 any more :) */
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Failed to add property. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT));
COLOUT(col_debug_collection(host, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Check if property PEER1.DELAY is in the EVENT collection.\n"));
/* Check if the property in the collection */
found = 0;
error = col_is_item_in_collection(event, "peer1!delay", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
/* No socket1 any more :) */
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Failed to check property. Error %d\n", error);
return error;
}
if (found == 1) {
COLOUT(printf("Property is found!\n"));
}
else {
COLOUT(printf("Error property is not found!\n"));
}
COLOUT(col_print_item(event, "peer1!IPv6"));
COLOUT(col_print_item(event, "event!socket1!peer1!IPv6"));
COLOUT(col_print_item(event, "event!peer1!IPv6"));
COLOUT(col_print_item(event, "speer1!IPv6"));
COLOUT(col_print_item(event, "eer1!IPv6"));
COLOUT(col_print_item(event, "!peer1!IPv6"));
COLOUT(col_print_item(event, "t!peer1!IPv6"));
/* Traverse collection */
if (verbose) {
error = col_print_collection2(event);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
/* No socket1 any more :) */
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Error printing collection %d\n", error);
return error;
}
}
COLOUT(printf("Delete property PEER1!DELAY from the EVENT collection.\n"));
error = col_delete_property(event, "peer1!delay", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
/* No socket1 any more :) */
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Failed to delete property. Error %d\n", error);
return error;
}
COLOUT(printf("Printing EVENT.\n"));
/* Traverse collection */
if (verbose) {
error = col_print_collection2(event);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
/* No socket1 any more :) */
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Error printing collection %d\n", error);
return error;
}
}
COLOUT(printf("Debugging EVENT.\n"));
if (verbose) {
error = col_debug_collection(event, COL_TRAVERSE_DEFAULT);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(host);
/* No socket1 any more :) */
col_destroy_collection(socket2);
col_destroy_collection(event);
printf("Error printing collection %d\n", error);
return error;
}
}
COLOUT(printf("Cleanup of the collections PEER, HOST and SOCKET2.\n"));
/* Destroy a referenced collection */
col_destroy_collection(peer);
col_destroy_collection(host);
col_destroy_collection(socket2);
COLOUT(printf("Printing EVENT again.\n"));
/* Traverse collection again - peer should still be there */
if (verbose) {
error = col_print_collection(event);
if (error) {
col_destroy_collection(event);
printf("Error printing collection %d\n", error);
return error;
}
}
COLOUT(printf("Debugging EVENT again.\n"));
if (verbose) {
error = col_debug_collection(event, COL_TRAVERSE_DEFAULT);
if (error) {
col_destroy_collection(event);
printf("Error printing collection %d\n", error);
return error;
}
}
COLOUT(printf("Attempt to add property to a referenced collection.\n"));
error = col_add_int_property(event, "host", "session", 500);
if (error) {
col_destroy_collection(event);
printf("Error was NOT able to add property to a referenced collection %d.\n", error);
return error;
}
COLOUT(printf("Attempt to delete non-existent property.\n"));
/* Can't delete non exitent property */
error = col_delete_property(event, "host.host", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT);
if (error == 0) {
col_destroy_collection(event);
printf("Error was able to delete property that does not exist.\n");
return -1;
}
else COLOUT(printf("Expected error %d\n", error));
/* Set collection class */
error = col_set_collection_class(event, 2);
if (error != 0) {
col_destroy_collection(event);
printf("Error was NOT able to set class.\n");
return error;
}
error = col_get_collection_class(event, &class);
if (error != 0) {
col_destroy_collection(event);
printf("Error was NOT able to get class.\n");
return error;
}
else COLOUT(printf("Class = %d\n", class));
if (col_is_of_class(event, 2)) {
COLOUT(printf("Class mathced!\n"));
}
else {
col_destroy_collection(event);
printf("Error - bad class.\n");
return -1;
}
COLOUT(printf("Done. Cleaning...\n"));
col_destroy_collection(event);
COLOUT(printf("Exit.\n"));
TRACE_FLOW_NUMBER("add_collection_test. Returning", EOK);
return EOK;
}
static int iterator_test(void)
{
struct collection_item *peer = NULL;
struct collection_item *initial = NULL;
struct collection_item *socket1 = NULL;
struct collection_item *socket2 = NULL;
struct collection_item *socket3 = NULL;
struct collection_iterator *iterator = NULL;
int error = EOK;
struct collection_item *item = NULL;
char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
int depth = 0;
int idepth = 0;
int len = 0;
int i;
uint64_t hash1, hash2;
int rwnd = 0;
COLOUT(printf("\n\n==== ITERATOR TEST ====\n\n"));
if ((error = col_create_collection(&initial, "strater", 0)) ||
(error = col_create_collection(&peer, "peer", 0)) ||
(error = col_add_str_property(initial, NULL, "hostname", "peerhost.mytest.com", 0)) ||
/* Expect trailing zero to be truncated */
(error = col_add_str_property(initial, NULL, "IPv4", "10.10.10.10", 12)) ||
(error = col_add_str_property(initial, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0)) ||
(error = col_add_collection_to_collection(peer, NULL, NULL, initial, COL_ADD_MODE_FLAT))) {
printf("Failed to add property. Error %d", error);
col_destroy_collection(peer);
col_destroy_collection(initial);
return error;
}
col_destroy_collection(initial);
if ((error = col_create_collection(&socket1, "socket", 0)) ||
(error = col_add_int_property(socket1, NULL, "id", 1)) ||
(error = col_add_long_property(socket1, NULL, "packets", 100000000L)) ||
(error = col_add_binary_property(socket1, NULL, "stack", binary_dump, sizeof(binary_dump)))) {
col_destroy_collection(peer);
col_destroy_collection(socket1);
printf("Failed to add property. Error %d\n", error);
return error;
}
if ((error = col_create_collection(&socket2, "socket", 0)) ||
(error = col_add_int_property(socket2, NULL, "id", 2)) ||
(error = col_add_long_property(socket2, NULL, "packets", 200000000L)) ||
(error = col_add_binary_property(socket2, NULL, "queue", binary_dump, sizeof(binary_dump)))) {
col_destroy_collection(peer);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
printf("Failed to add property. Error %d\n", error);
return error;
}
if ((error = col_create_collection(&socket3, "socket", 0))) {
col_destroy_collection(peer);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
printf("Failed to add property. Error %d\n", error);
return error;
}
error = col_add_collection_to_collection(peer, NULL, "first", socket1, COL_ADD_MODE_REFERENCE);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
col_destroy_collection(socket3);
printf("Failed to add collection to collection. Error %d\n", error);
return error;
}
error = col_add_collection_to_collection(peer, NULL, "second", socket2, COL_ADD_MODE_EMBED);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(socket1);
col_destroy_collection(socket2);
col_destroy_collection(socket3);
printf("Failed to add collection to collection. Error %d\n", error);
return error;
}
error = col_add_collection_to_collection(peer, NULL, "third", socket3, COL_ADD_MODE_EMBED);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(socket1);
col_destroy_collection(socket3);
printf("Failed to add collection to collection. Error %d\n", error);
return error;
}
error = col_add_collection_to_collection(peer, NULL, "forth", socket1, COL_ADD_MODE_FLATDOT);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(socket1);
printf("Failed to add collection to collection. Error %d\n", error);
return error;
}
error = col_add_collection_to_collection(peer, NULL, NULL, socket1, COL_ADD_MODE_FLATDOT);
if (error) {
col_destroy_collection(peer);
col_destroy_collection(socket1);
printf("Failed to add collection to collection. Error %d\n", error);
return error;
}
col_destroy_collection(socket1);
/* Bind iterator */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_DEFAULT);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nCollection (traverse default):\n\n"));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT));
COLOUT(printf("\n\nCollection (traverse flat):\n\n"));
COLOUT(col_debug_collection(peer, COL_TRAVERSE_FLAT | COL_TRAVERSE_END));
COLOUT(printf("\n\nIteration (1):\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return error;
}
/* Are we done ? */
if (item == NULL) break;
depth = 0;
col_get_item_depth(iterator, &depth);
idepth = 0;
col_get_iterator_depth(iterator, &idepth);
COLOUT(printf("%*sProperty (%s), type = %d, data size = %d depth = %d idepth = %d\n",
depth * 4, "",
col_get_item_property(item, NULL),
col_get_item_type(item),
col_get_item_length(item),
depth,
idepth));
if ((strcmp(col_get_item_property(item, NULL), "id")==0) &&
(*((int *)(col_get_item_data(item))) == 1)) {
COLOUT(printf("\n\nFound property we need - go up!!!\n\n\n"));
/* This should work! */
error = col_iterate_up(iterator, 1);
if (error) {
printf("We expected success but got error %d\n", error);
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return error;
}
if ((error = col_modify_str_item(item, "id2", "test", 0)) ||
((verbose) && (error = col_debug_item(item))) ||
(error = col_modify_str_item(item, NULL, "test", 2)) ||
((verbose) && (error = col_debug_item(item))) ||
(error = col_modify_binary_item(item, NULL, binary_dump, sizeof(binary_dump))) ||
((verbose) && (error = col_debug_item(item))) ||
(error = col_modify_bool_item(item, NULL, 1)) ||
((verbose) && (error = col_debug_item(item))) ||
(error = col_modify_int_item(item, "int", 1)) ||
((verbose) && (error = col_debug_item(item))) ||
(error = col_modify_long_item(item, "long", 1000000000L)) ||
((verbose) && (error = col_debug_item(item))) ||
(error = col_modify_ulong_item(item, "ulong", 4000000000UL)) ||
((verbose) && (error = col_debug_item(item))) ||
(error = col_modify_unsigned_item(item, "unsigned", 4000000000U)) ||
((verbose) && (error = col_debug_item(item))) ||
(error = col_modify_double_item(item, "double", -1.1)) ||
((verbose) && (error = col_debug_item(item)))) {
printf("Failed to change property.\n");
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("Item name: %s\n", col_get_item_property(item, NULL)));
COLOUT(printf("Item hash: %lu\n", (unsigned long int)col_get_item_hash(item)));
error = col_modify_item_property(item, "new_name");
if (error) {
printf("We expected success but got error %d\n", error);
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return error;
}
len = 0;
COLOUT(printf("Item name: %s\n", col_get_item_property(item, &len)));
COLOUT(printf("Item hash: %lu\n", (unsigned long int)col_get_item_hash(item)));
COLOUT(printf("Item length: %d\n", len));
len = 0;
hash1 = col_make_hash("new_name", 0, &len);
COLOUT(printf("String name: %s\n", "new_name"));
COLOUT(printf("String hash: %lu\n", (unsigned long int)hash1));
COLOUT(printf("String length: %d\n", len));
len = 0;
hash2 = col_make_hash("new_name_suffix", 8, &len);
COLOUT(printf("String name: %.*s\n", len, "new_name_suffix"));
COLOUT(printf("String hash: %lu\n", (unsigned long int)hash2));
COLOUT(printf("String length: %d\n", len));
if (hash1 != hash2) {
printf("Hash calculation failed\n");
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return EINVAL;
}
hash2 = col_make_hash("new_name", 8, &len);
COLOUT(printf("String name: %.*s\n", len, "new_name"));
COLOUT(printf("String hash: %lu\n", (unsigned long int)hash2));
COLOUT(printf("String length: %d\n", len));
if (hash1 != hash2) {
printf("Hash calculation failed\n");
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return EINVAL;
}
}
}
while(1);
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_FLAT);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nIteration (2 - flat):\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) break;
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
if ((strcmp(col_get_item_property(item, NULL), "queue") == 0) &&
(rwnd == 0)) {
COLOUT(printf("Rewinding iterator...\n"));
col_rewind_iterator(iterator);
rwnd++;
}
}
while(1);
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_FLAT | COL_TRAVERSE_END);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nIteration (3 flat with end):\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) break;
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
while(1);
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nIteration (4 default with end):\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) break;
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
while(1);
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_SHOWSUB | COL_TRAVERSE_END);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nIteration (5 show headers and references with end):\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) break;
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
while(1);
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_SHOWSUB);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nIteration (6 show headers and references no END):\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) break;
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
while(1);
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_ONLYSUB);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nIteration (7 show headers only no END):\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) break;
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
while(1);
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
/* Bind iterator */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_DEFAULT);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nIterate up test:\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return error;
}
/* Are we done ? */
if (item == NULL) break;
depth = 0;
col_get_item_depth(iterator, &depth);
idepth = 0;
col_get_iterator_depth(iterator, &idepth);
COLOUT(printf("%*sProperty (%s), type = %d, data size = %d depth = %d idepth = %d\n",
depth * 4, "",
col_get_item_property(item, NULL),
col_get_item_type(item),
col_get_item_length(item),
depth,
idepth));
if (strcmp(col_get_item_property(item, NULL), "queue") == 0) {
COLOUT(printf("\n\nFound property we need - go up!!!\n"));
COLOUT(printf("Expect bail out of collection processing.\n\n"));
/* This should work! */
error = col_iterate_up(iterator, 10);
if (error) {
printf("We expected success but got error %d\n", error);
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return error;
}
}
}
while(1);
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_FLAT | COL_TRAVERSE_END);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nCircled looping:\n\n"));
for (i = 0; i < 200; i++) {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) {
COLOUT(printf("Reached end.\n\n"));
}
else {
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
}
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_FLAT | COL_TRAVERSE_END);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nCircled looping with pin:\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
if (strcmp(col_get_item_property(item, NULL), "queue") == 0) {
/* Make it a new looping point */
col_pin_iterator(iterator);
COLOUT(printf("Found pin point.\n\n"));
break;
}
/* Are we done ? */
if (item == NULL) {
printf("Unexpected end.\n\n");
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return EINVAL;
}
else {
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
}
while(1);
/* Second loop around the pin point */
for (i = 0; i < 200; i++) {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) {
COLOUT(printf("Reached end.\n\n"));
}
else {
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
}
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
/* Bind iterator again in flat mode */
error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END);
if (error) {
printf("Error (bind): %d\n", error);
col_destroy_collection(peer);
return error;
}
COLOUT(printf("\n\nCircled looping with pin (default):\n\n"));
do {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
if (strcmp(col_get_item_property(item, NULL), "queue") == 0) {
/* Make it a new looping point */
col_pin_iterator(iterator);
COLOUT(printf("Found pin point.\n\n"));
break;
}
/* Are we done ? */
if (item == NULL) {
printf("Unexpected end.\n\n");
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return EINVAL;
}
else {
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
}
while(1);
/* Second loop around the pin point */
for (i = 0; i < 200; i++) {
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
printf("Error (iterate): %d\n", error);
col_destroy_collection(peer);
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) {
COLOUT(printf("Reached end.\n\n"));
}
else {
depth = 0;
col_get_item_depth(iterator, &depth);
COLOUT(printf("%*s", depth * 4, ""));
COLOUT(col_debug_item(item));
}
}
/* Do not forget to unbind iterator - otherwise there will be a leak */
col_unbind_iterator(iterator);
col_destroy_collection(peer);
return EOK;
}
static int validate_collection(struct collection_item *col,
const char *varray[][2])
{
struct collection_iterator *iterator = NULL;
int error = EOK;
struct collection_item *item = NULL;
int count = -1;
COLOUT(printf("\n\n==== Validating collection ====\n\n"));
/* Bind iterator */
error = col_bind_iterator(&iterator, col, COL_TRAVERSE_DEFAULT);
if (error) {
COLOUT(printf("Error (bind): %d\n", error));
return error;
}
do {
count++;
/* Loop through a collection */
error = col_iterate_collection(iterator, &item);
if (error) {
COLOUT(printf("Error (iterate): %d\n", error));
col_unbind_iterator(iterator);
return error;
}
/* Are we done ? */
if (item == NULL) break;
/* Set count when we skip header */
if (col_get_item_type(item) == COL_TYPE_COLLECTION) {
count = -1;
continue;
}
if (varray[count][0] == NULL) {
/* We have reached the end of the array but not the collection.
* This means the test failed. Return error.
*/
COLOUT(printf("Got extra item in the collection: %s=%s\n",
col_get_item_property(item, NULL),
(char *)(col_get_item_data(item))));
col_unbind_iterator(iterator);
return -1;
}
if ((strcmp(col_get_item_property(item, NULL),
varray[count][0]) != 0) ||
(strcmp((char *)(col_get_item_data(item)),
varray[count][1]) != 0 )) {
COLOUT(printf("Expected %s=\"%s\" got %s=\"%s\" \n",
varray[count][0],
varray[count][1],
col_get_item_property(item, NULL),
(char *)(col_get_item_data(item))));
col_unbind_iterator(iterator);
return -1;
}
}
while(1);
col_unbind_iterator(iterator);
if (varray[count][0] != NULL) {
COLOUT(printf("Expected end got %s=\"%s\"\n", varray[count][0],
varray[count][1]));
return -1;
}
COLOUT(printf("\n\n==== Validating collection - OK ====\n\n"));
return EOK;
}
static int insert_extract_test(void)
{
struct collection_item *col;
struct collection_item *col2;
int error = EOK;
struct collection_item *item = NULL;
const char *varray1[][2] = { { "property_-1", "value_-1" },
{ "property0", "value0lastdup" },
{ "property0_5", "value0_5" },
{ "property1", "value1update" },
{ "second", "second" },
{ "property1_5", "value1_5" },
{ "property2", "value2" },
{ "property10", "value10" },
{ "property10", "value10lastdup" },
{ "property_-2", "value-2moved_to_bottom" },
{ "property0", "extra_1" },
{ "property100", "value100" },
{ NULL, NULL } };
const char *varray2[][2] = { { "property_-1_5","value_-1_5" },
{ "property1_6", "value_1_6_moved_to_front" },
{ "property0", "very_last" },
{ "property10", "value10dup" },
{ "property_-0_5", "value_-0_5" },
{ "property0", "value0firstdupupdate" },
{ "property0", "value0" },
{ "property0", "before 0_5" },
{ "property0", "value0middledup" },
{ "property0", "extra_2" },
{ "property0", "after_extra2" },
{ "property0", "before_extra2" },
{ NULL, NULL } };
COLOUT(printf("\n\n==== INSERTION TEST ====\n\n"));
if ((error = col_create_collection(&col, "insertion", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK,
"property1", "value1", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_INDEX,
NULL, 1, COL_INSERT_NOCHECK,
"second", "second", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK,
"property2", "value2", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_FRONT,
NULL, 0, COL_INSERT_NOCHECK,
"property0", "value0", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_BEFORE,
"property0", 0, COL_INSERT_NOCHECK,
"property_-1", "value_-1", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_BEFORE,
"property1", 0, COL_INSERT_NOCHECK,
"property0_5", "value0_5", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_BEFORE,
"property2", 0, COL_INSERT_NOCHECK,
"property1_5", "value1_5", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_AFTER,
"property_-1", 0, COL_INSERT_NOCHECK,
"property_-0_5", "value_-0_5", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_AFTER,
"property1_5", 0, COL_INSERT_NOCHECK,
"property1_6", "value1_6", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_INDEX,
NULL, 10, COL_INSERT_NOCHECK,
"property10", "value10", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_INDEX,
NULL, 0, COL_INSERT_NOCHECK,
"property_-2", "value_-2", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_INDEX,
NULL, 1, COL_INSERT_NOCHECK,
"property_-1_5", "value_-1_5", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_FIRSTDUP,
NULL, 0, COL_INSERT_NOCHECK,
"property0", "value0firstdup", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_LASTDUP,
NULL, 0, COL_INSERT_NOCHECK,
"property0", "value0lastdup", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_NDUP,
NULL, 1, COL_INSERT_NOCHECK,
"property0", "value0middledup", 0)) ||
(error = col_insert_str_property(col, NULL, 0,
NULL, 0, COL_INSERT_DUPOVER ,
"property0",
"value0firstdupupdate", 0)) ||
(error = col_insert_str_property(col, NULL, 0,
NULL, 0, COL_INSERT_DUPOVERT,
"property1", "value1update", 0)) ||
((error = col_insert_str_property(col, NULL, 0,
NULL, 0, COL_INSERT_DUPERROR,
"property0",
"does not matter", 0)) != EEXIST) ||
(error = col_insert_str_property(col, NULL, COL_DSP_NDUP,
NULL, 5, COL_INSERT_NOCHECK,
"property10", "value10dup", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_LASTDUP,
NULL, 0, COL_INSERT_NOCHECK,
"property10", "value10lastdup", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_END,
NULL, 0, COL_INSERT_DUPMOVET,
"property_-2",
"value-2moved_to_bottom", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_FRONT,
NULL, 0, COL_INSERT_DUPMOVE,
"property1_6",
"value_1_6_moved_to_front", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK,
"property0", "extra_1", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK,
"property0", "extra_2", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_NDUP,
"property0", 10, COL_INSERT_NOCHECK,
"property0", "before 0_5", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_NDUPNS,
"property0", 10, COL_INSERT_NOCHECK,
"property0", "after_extra2", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_NDUPNS,
"property0", 6, COL_INSERT_NOCHECK,
"property0", "before_extra2", 0)) ||
(error = col_insert_str_property(col, NULL, COL_DSP_LASTDUPNS,
"property0", 0, COL_INSERT_NOCHECK,
"property0", "very_last", 0))) {
printf("ERROR in the ITERATION TEST %d\n", error);
col_debug_collection(col, COL_TRAVERSE_DEFAULT);
col_destroy_collection(col);
return error;
}
COLOUT(printf("\n\nCollection:\n\n"));
COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT));
COLOUT(printf("\n\n==== EXTRACTION TEST ====\n\n"));
if ((error = col_create_collection(&col2, "extraction", 0)) ||
/* Extracting "property 1_6" value "value_1_6_moved_to_front" */
(error = col_extract_item(col, NULL, COL_DSP_FRONT,
NULL, 0, 0, &item)) ||
(error = col_insert_item(col2, NULL, item, COL_DSP_FRONT,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Extracting "property_-1_5" value "value_-1_5" */
(error = col_extract_item(col, NULL, COL_DSP_FRONT,
NULL, 0, 0, &item)) ||
/* Putting it in front */
(error = col_insert_item(col2, NULL, item, COL_DSP_FRONT,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Extracting "property0" value "very_last" */
(error = col_extract_item(col, NULL, COL_DSP_END,
NULL, 0, 0, &item)) ||
/* Putting it to the end */
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Inserting extra property to the end of first collection */
(error = col_insert_str_property(col, NULL, COL_DSP_INDEX,
NULL, 100, COL_INSERT_NOCHECK,
"property100", "value100", 0)) ||
/* This will extract "property10" with value "value10dup" */
(error = col_extract_item(col, NULL, COL_DSP_AFTER,
"property10", 0, COL_TYPE_STRING, &item)) ||
/* Putting it to the end */
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Extracting "property_-0_5" value "value_-0_5" */
(error = col_extract_item(col, NULL, COL_DSP_BEFORE,
"property0", 0, COL_TYPE_STRING, &item)) ||
/* Putting it to the end */
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
/* Printing initial collection to see its state */
((verbose) && (error = col_debug_collection(col,
COL_TRAVERSE_DEFAULT))) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Going for the second item in the collection which is
* at this moment "property0" with value "value0firstdupupdate"
*/
(error = col_extract_item(col, NULL, COL_DSP_INDEX,
NULL, 1, 0, &item)) ||
/* Putting it to the end */
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Extracting first sequextial duplicate of property0 whic is value
* "value0"
*/
(error = col_extract_item(col, NULL, COL_DSP_NDUP,
"property0", 1, 0, &item)) ||
/* Putting it to the end */
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Extracting last sequential dup of "property0"
* which is at this moment "before 0_5"
*/
(error = col_extract_item(col, NULL, COL_DSP_LASTDUP,
"property0", 0, 0, &item)) ||
/* Putting it to the end */
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Extracting first dup of "property0"
* which is at this moment "value0middledup"
*/
(error = col_extract_item(col, NULL, COL_DSP_FIRSTDUP,
"property0", 0, 0, &item)) ||
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Printing initial collection to see its state */
((verbose) && (error = col_debug_collection(col,
COL_TRAVERSE_DEFAULT))) ||
/* Should extract extra_2 */
(error = col_extract_item(col, NULL, COL_DSP_NDUPNS,
"property0", 3, 0, &item)) ||
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Printing initial collection to see its state */
((verbose) && (error = col_debug_collection(col,
COL_TRAVERSE_DEFAULT))) ||
/* Try extracting something that is out of index, expect ENOENT */
((error = col_extract_item(col, NULL, COL_DSP_NDUPNS,
"property0", 10, 0, &item)) != ENOENT) ||
/* Should extract after_extra_2 */
(error = col_extract_item(col, NULL, COL_DSP_NDUPNS,
"property0", 3, 0, &item)) ||
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT))) ||
/* Printing initial collection to see its state */
((verbose) && (error = col_debug_collection(col,
COL_TRAVERSE_DEFAULT))) ||
/* Should extract before_extra_2 */
(error = col_extract_item(col, NULL, COL_DSP_LASTDUPNS,
"property0", 0, 0, &item)) ||
(error = col_insert_item(col2, NULL, item, COL_DSP_END,
NULL, 0, COL_INSERT_NOCHECK)) ||
((verbose) && (error = col_debug_collection(col2,
COL_TRAVERSE_DEFAULT)))) {
COLOUT(printf("ERROR in the EXTRACTION TEST\n"));
COLOUT(printf("Collection 1\n"));
COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Collection 2\n"));
COLOUT(col_debug_collection(col2, COL_TRAVERSE_DEFAULT));
col_destroy_collection(col);
col_destroy_collection(col2);
return error;
}
COLOUT(printf("Collection 1\n"));
COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT));
COLOUT(printf("Collection 2\n"));
COLOUT(col_debug_collection(col2, COL_TRAVERSE_DEFAULT));
error = validate_collection(col, varray1);
if (error) {
COLOUT(printf("Collection 1 validation failed.\n"));
col_destroy_collection(col);
col_destroy_collection(col2);
return error;
}
error = validate_collection(col2, varray2);
if (error) {
COLOUT(printf("Collection 2 validation failed.\n"));
col_destroy_collection(col);
col_destroy_collection(col2);
return error;
}
col_destroy_collection(col2);
col_destroy_collection(col);
return EOK;
}
/* Cleanup collback */
static void cb(const char *property,
int property_len,
int type,
void *data,
int length,
void *ext_data)
{
COLOUT(printf("%s\n", *((const char **)ext_data)));
COLOUT(printf("Property: %s\n", property));
COLOUT(printf("Length: %d\n", property_len));
COLOUT(printf("Type: %d\n", type));
COLOUT(printf("Data len: %d\n", length));
}
static int delete_test(void)
{
struct collection_item *col;
int error = EOK;
const char *str = "Cleanup Callback Test";
COLOUT(printf("\n\n==== DELETION TEST 1====\n\n"));
if ((error = col_create_collection(&col, "test", 0)) ||
(error = col_add_int_property(col, NULL, "tt", 1)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_add_int_property(col, NULL, "test", 1)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_delete_property(col, "test", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_add_int_property(col, NULL, "test", 1)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_delete_property(col, "test", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_add_int_property(col, NULL, "test", 1))) {
printf("Error in delete test %d\n", error);
col_destroy_collection(col);
return error;
}
COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT));
col_destroy_collection(col);
COLOUT(printf("\n\n==== DELETION TEST 1 END ====\n\n"));
COLOUT(printf("\n\n==== DELETION TEST 2====\n\n"));
if ((error = col_create_collection(&col, "test2", 0)) ||
(error = col_add_int_property(col, NULL, "tt", 1)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_add_int_property(col, NULL, "test", 1)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_remove_item(col, NULL, COL_DSP_END, NULL, 0, COL_TYPE_ANY)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_add_int_property(col, NULL, "test", 1)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_remove_item_from_current(col, COL_DSP_AFTER, "tt", 0, COL_TYPE_ANY)) ||
((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) ||
(error = col_add_int_property(col, NULL, "test", 1))) {
printf("Error in delete test %d\n", error);
col_destroy_collection(col);
return error;
}
COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT));
COLOUT(printf("\n\n==== DELETION TEST 2 END ====\n\n"));
col_destroy_collection_with_cb(col, cb, (void *)(&str));
return error;
}
/* Search test */
static int search_test(void)
{
struct collection_item *level1 = NULL;
struct collection_item *level2 = NULL;
struct collection_item *level3 = NULL;
struct collection_item *level4 = NULL;
char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
int found = 0;
int error = 0;
COLOUT(printf("\n\n==== SEARCH TEST ====\n\n"));
if ((error = col_create_collection(&level1, "level1", 0)) ||
(error = col_create_collection(&level2, "level2", 0)) ||
(error = col_add_collection_to_collection(level1, NULL, NULL, level2, COL_ADD_MODE_REFERENCE)) ||
(error = col_create_collection(&level3, "level3", 0)) ||
(error = col_add_collection_to_collection(level1, "level2", NULL, level3, COL_ADD_MODE_REFERENCE)) ||
(error = col_create_collection(&level4, "leveL4", 0)) ||
(error = col_add_collection_to_collection(level1, "level3", NULL, level4, COL_ADD_MODE_REFERENCE)) ||
(error = col_add_int_property(level1, "leveL4", "id", 1)) ||
(error = col_add_long_property(level1, "level3", "packets", 100000000L)) ||
(error = col_add_binary_property(level1, "level2", "stack", binary_dump, sizeof(binary_dump)))) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Failed to build test. Error %d\n", error);
return error;
}
COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT));
error = col_is_item_in_collection(level1, "level1!level2!level3!level4!", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found);
if (!error) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Expected error here since the search data is illegal but got success\n");
return EINVAL;
}
found = 0;
error = col_is_item_in_collection(level1, "level1!level2!level3!level4!id", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found);
if ((error) || (!found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Failed to find item [level1!level2!level3!level4!id]. Error %d\n", error);
return error ? error : ENOENT;
}
else COLOUT(printf("Expected item is found\n"));
found = 0;
error = col_is_item_in_collection(level1, NULL, COL_TYPE_INTEGER, COL_TRAVERSE_DEFAULT, &found);
if ((error) || (!found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Failed to find first int item [level1!level2!level3!level4!id]. Error %d\n", error);
return error ? error : ENOENT;
}
else COLOUT(printf("Expected item is found\n"));
found = 0;
error = col_is_item_in_collection(level1, "", COL_TYPE_INTEGER, COL_TRAVERSE_DEFAULT, &found);
if ((error) || (!found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Failed to find first int item [level1!level2!level3!level4!id]. Error %d\n", error);
return error ? error : ENOENT;
}
else COLOUT(printf("Expected item is found\n"));
found = 0;
error = col_is_item_in_collection(level1, "level3!level4!id", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found);
if ((error) || (!found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Failed to find item [level3!level4!id]. Error %d\n", error);
return error ? error : ENOENT;
}
else COLOUT(printf("Expected item is found\n"));
found = 0;
error = col_is_item_in_collection(level1, "level3!packets", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found);
if ((error) || (!found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Failed to find item [level3.packets]. Error %d\n", error);
return error ? error : ENOENT;
}
else COLOUT(printf("Expected item is found\n"));
found = 0;
error = col_is_item_in_collection(level1, "level1!level2!stack", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found);
if ((error) || (!found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Failed to find item [level1!level2!stack]. Error %d\n", error);
return error ? error : ENOENT;
}
else COLOUT(printf("Expected item is found\n"));
found = 0;
error = col_is_item_in_collection(level1, "level1!level2!level3", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found);
if ((error) || (!found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
printf("Failed to find item [level1!level2!level3]. Error %d\n", error);
return error ? error : ENOENT;
}
else COLOUT(printf("Expected item is found\n"));
/* Negative tests */
found = 0;
error = col_is_item_in_collection(level1, NULL, 0, COL_TRAVERSE_DEFAULT, &found);
if ((error != ENOENT) || (found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
if (error) {
printf("Unexpected error with NULL & 0 test %d\n", error);
}
else {
printf("Found unexpected item with NULL & 0. Error %d\n", error);
error = EINVAL;
}
return error;
}
else COLOUT(printf("No item is found as expected.\n"));
found = 0;
error = col_is_item_in_collection(level1, "", 0, COL_TRAVERSE_DEFAULT, &found);
if ((error != ENOENT) || (found)) {
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
if (error) {
printf("Unexpected error with \"\" & 0 tests %d\n", error);
}
else {
printf("Found unexpected item with \"\" & 0. Error %d\n", error);
error = EINVAL;
}
return error;
}
else COLOUT(printf("No item is found as expected.\n"));
col_destroy_collection(level1);
col_destroy_collection(level2);
col_destroy_collection(level3);
col_destroy_collection(level4);
COLOUT(printf("\n\n==== SEARCH TEST END ====\n\n"));
return EOK;
}
/* Sort test */
static int sort_test(void)
{
struct collection_item *level1 = NULL;
struct collection_item *level2a = NULL;
struct collection_item *level2b = NULL;
struct collection_item *level3 = NULL;
int error = 0;
COLOUT(printf("\n\n==== SORT TEST ====\n\n"));
if ((error = col_create_collection(&level1, "level1", 0)) ||
(error = col_create_collection(&level2a, "level2a", 0)) ||
(error = col_add_collection_to_collection(level1, NULL, NULL, level2a, COL_ADD_MODE_REFERENCE)) ||
(error = col_create_collection(&level2b, "level2b", 0)) ||
(error = col_add_collection_to_collection(level1, NULL, NULL, level2b, COL_ADD_MODE_REFERENCE)) ||
(error = col_create_collection(&level3, "level3", 0)) ||
(error = col_add_collection_to_collection(level1, "level2a", NULL, level3, COL_ADD_MODE_REFERENCE)) ||
(error = col_add_collection_to_collection(level1, "level2b", NULL, level3, COL_ADD_MODE_REFERENCE)) ||
(error = col_add_int_property(level1, NULL, "int3", 1)) ||
(error = col_add_int_property(level1, NULL, "int2", 2)) ||
(error = col_add_int_property(level1, NULL, "int1", 3)) ||
(error = col_add_bool_property(level1, NULL, "bool3", 1)) ||
(error = col_add_bool_property(level1, NULL, "bool2", 1)) ||
(error = col_add_bool_property(level1, NULL, "bool1", 0)) ||
(error = col_add_unsigned_property(level1, NULL, "unsigned1", 2)) ||
(error = col_add_unsigned_property(level1, NULL, "unsigned3", 1)) ||
(error = col_add_unsigned_property(level1, NULL, "unsigned2", 3)) ||
(error = col_add_long_property(level1, NULL, "long3", 1)) ||
(error = col_add_long_property(level1, NULL, "long2", 2)) ||
(error = col_add_long_property(level1, NULL, "long1", 3)) ||
(error = col_add_ulong_property(level1, NULL, "ulong1", 2)) ||
(error = col_add_ulong_property(level1, NULL, "ulong3", 1)) ||
(error = col_add_ulong_property(level1, NULL, "ulong2", 3)) ||
(error = col_add_double_property(level1, NULL, "double1", 2.2)) ||
(error = col_add_double_property(level1, NULL, "double3", 1.1)) ||
(error = col_add_double_property(level1, NULL, "double2", 3.3)) ||
(error = col_add_int_property(level3, NULL, "int3L3", 1)) ||
(error = col_add_int_property(level3, NULL, "int2L3", 2)) ||
(error = col_add_int_property(level3, NULL, "int1L3", 3)) ||
(error = col_add_unsigned_property(level1, "level2a!level3", "unsigned1L3", 2)) ||
(error = col_add_unsigned_property(level1, "level2a!level3", "unsigned3L3", 1)) ||
(error = col_add_unsigned_property(level1, "level2a!level3", "unsigned2L3", 3)) ||
(error = col_add_long_property(level1, "level2b!level3", "long3L3", 1)) ||
(error = col_add_long_property(level1, "level2b!level3", "long2L3", 2)) ||
(error = col_add_long_property(level1, "level2b!level3", "long1L3", 3)) ||
(error = col_add_ulong_property(level1, "level3", "ulong1L3", 2)) ||
(error = col_add_ulong_property(level1, "level3", "ulong3L3", 1)) ||
(error = col_add_ulong_property(level1, "level3", "ulong2L3", 3)) ||
(error = col_add_bool_property(level3, NULL, "bool3", 1)) ||
(error = col_add_bool_property(level3, NULL, "bool2", 1)) ||
(error = col_add_bool_property(level3, NULL, "bool1", 0)) ||
(error = col_add_double_property(level3, NULL, "double1L3", 2.2)) ||
(error = col_add_double_property(level3, NULL, "double3L3", 1.1)) ||
(error = col_add_double_property(level3, NULL, "double2L3", 3.3))) {
col_destroy_collection(level1);
col_destroy_collection(level2a);
col_destroy_collection(level2b);
col_destroy_collection(level3);
printf("Failed to build test. Error %d\n", error);
return error;
}
COLOUT(printf("\nUNSORTED COLLECTION\n\n"));
COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT));
error = col_sort_collection(level1, COL_CMPIN_PROP_EQU, COL_SORT_SUB | COL_SORT_MYSUB);
if (error) {
col_destroy_collection(level1);
col_destroy_collection(level2a);
col_destroy_collection(level2b);
col_destroy_collection(level3);
printf("Failed sort. Error %d\n", error);
return error;
}
COLOUT(printf("\nSORTED BUT SKIPPING REFERENCES\n\n"));
COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT));
error = col_sort_collection(level1, COL_CMPIN_PROP_EQU, COL_SORT_SUB);
if (error) {
col_destroy_collection(level1);
col_destroy_collection(level2a);
col_destroy_collection(level2b);
col_destroy_collection(level3);
printf("Failed sort. Error %d\n", error);
return error;
}
COLOUT(printf("\nSORTED BUT NOT SKIPPING REFERENCES\n\n"));
COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT));
error = col_sort_collection(level1, COL_CMPIN_DATA_LEN, COL_SORT_SUB | COL_SORT_DESC);
if (error) {
col_destroy_collection(level1);
col_destroy_collection(level2a);
col_destroy_collection(level2b);
col_destroy_collection(level3);
printf("Failed sort. Error %d\n", error);
return error;
}
COLOUT(printf("\nSORTED DESC NOT SKIPPING BY LENGTH OF DATA\n\n"));
COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT));
error = col_sort_collection(level1, COL_CMPIN_PROP_LEN, COL_SORT_SUB | COL_SORT_DESC);
if (error) {
col_destroy_collection(level1);
col_destroy_collection(level2a);
col_destroy_collection(level2b);
col_destroy_collection(level3);
printf("Failed sort. Error %d\n", error);
return error;
}
COLOUT(printf("\nSORTED DESC NOT SKIPPING BY LENGTH OF PROPERTY\n\n"));
COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT));
error = col_sort_collection(level1, COL_CMPIN_DATA, COL_SORT_SUB | COL_SORT_DESC);
if (error) {
col_destroy_collection(level1);
col_destroy_collection(level2a);
col_destroy_collection(level2b);
col_destroy_collection(level3);
printf("Failed sort. Error %d\n", error);
return error;
}
COLOUT(printf("\nSORTED DESC NOT SKIPPING BY DATA\n\n"));
COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT));
col_destroy_collection(level1);
col_destroy_collection(level2a);
col_destroy_collection(level2b);
col_destroy_collection(level3);
COLOUT(printf("\n\n==== SORT TEST END ====\n\n"));
return EOK;
}
/* Main function of the unit test */
int main(int argc, char *argv[])
{
int error = 0;
test_fn tests[] = { ref_collection_test,
single_collection_test,
add_collection_test,
mixed_collection_test,
iterator_test,
insert_extract_test,
delete_test,
search_test,
sort_test,
dup_test,
NULL };
test_fn t;
int i = 0;
if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1;
printf("Start\n");
while ((t = tests[i++])) {
error = t();
if (error) {
printf("Failed!\n");
return error;
}
}
printf("Success!\n");
return 0;
}
ding-libs-0.6.2/collection/libcollection.sym 0000664 0000000 0000000 00000007761 14172606404 0021115 0 ustar 00root root 0000000 0000000 COLLECTION_0.6.2 {
global:
/* collection.h */
col_create_collection;
col_destroy_collection;
col_destroy_collection_with_cb;
col_copy_collection_with_cb;
col_copy_collection;
col_add_collection_to_collection;
col_traverse_collection;
col_get_item_and_do;
col_get_item;
col_sort_collection;
col_delete_property;
col_is_item_in_collection;
col_get_collection_reference;
col_get_reference_from_item;
col_get_collection_class;
col_set_collection_class;
col_get_collection_count;
col_is_of_class;
col_add_str_property;
col_add_binary_property;
col_add_int_property;
col_add_unsigned_property;
col_add_long_property;
col_add_ulong_property;
col_add_double_property;
col_add_bool_property;
col_add_any_property;
col_add_str_property_with_ref;
col_add_binary_property_with_ref;
col_add_int_property_with_ref;
col_add_unsigned_property_with_ref;
col_add_long_property_with_ref;
col_add_ulong_property_with_ref;
col_add_double_property_with_ref;
col_add_bool_property_with_ref;
col_add_any_property_with_ref;
col_insert_str_property;
col_insert_binary_property;
col_insert_int_property;
col_insert_unsigned_property;
col_insert_long_property;
col_insert_ulong_property;
col_insert_double_property;
col_insert_bool_property;
col_insert_str_property_with_ref;
col_insert_binary_property_with_ref;
col_insert_int_property_with_ref;
col_insert_unsigned_property_with_ref;
col_insert_long_property_with_ref;
col_insert_ulong_property_with_ref;
col_insert_double_property_with_ref;
col_insert_bool_property_with_ref;
col_insert_property_with_ref;
col_update_str_property;
col_update_binary_property;
col_update_int_property;
col_update_unsigned_property;
col_update_long_property;
col_update_ulong_property;
col_update_double_property;
col_update_bool_property;
col_update_property;
col_get_item_property;
col_get_item_type;
col_get_item_length;
col_get_item_data;
col_get_item_hash;
col_make_hash;
col_compare_items;
col_modify_item;
col_modify_item_property;
col_modify_str_item;
col_modify_binary_item;
col_modify_bool_item;
col_modify_int_item;
col_modify_long_item;
col_modify_ulong_item;
col_modify_unsigned_item;
col_modify_double_item;
col_extract_item;
col_extract_item_from_current;
col_remove_item;
col_remove_item_from_current;
col_insert_item;
col_insert_item_into_current;
col_delete_item;
col_bind_iterator;
col_unbind_iterator;
col_iterate_collection;
col_iterate_up;
col_get_iterator_depth;
col_get_item_depth;
col_pin_iterator;
col_rewind_iterator;
/* collection_queue.h */
col_create_queue;
col_destroy_queue;
col_enqueue_str_property;
col_enqueue_binary_property;
col_enqueue_int_property;
col_enqueue_unsigned_property;
col_enqueue_long_property;
col_enqueue_ulong_property;
col_enqueue_double_property;
col_enqueue_bool_property;
col_enqueue_any_property;
col_enqueue_item;
col_dequeue_item;
/* collection_stack.h */
col_create_stack;
col_destroy_stack;
col_push_str_property;
col_push_binary_property;
col_push_int_property;
col_push_unsigned_property;
col_push_long_property;
col_push_ulong_property;
col_push_double_property;
col_push_bool_property;
col_push_any_property;
col_push_item;
col_pop_item;
/* collection_tools.h */
col_get_data_len;
col_grow_buffer;
col_put_marker;
col_serialize;
col_debug_handle;
col_debug_item;
col_debug_collection;
col_print_collection;
col_print_collection2;
col_print_item;
col_collection_to_list;
col_free_property_list;
local:
*;
};
COLLECTION_0.7 {
global:
/* collection.h */
col_get_dup_item;
col_delete_item_with_cb;
col_remove_item_with_cb;
} COLLECTION_0.6.2;
ding-libs-0.6.2/configure.ac 0000664 0000000 0000000 00000006077 14172606404 0015673 0 ustar 00root root 0000000 0000000 m4_include([version.m4])
AC_INIT([ding-libs],
VERSION_NUMBER,
[sssd-devel@lists.fedorahosted.org])
AC_CONFIG_SRCDIR([README])
AC_CONFIG_AUX_DIR([build])
m4_ifdef([AC_USE_SYSTEM_EXTENSIONS],
[AC_USE_SYSTEM_EXTENSIONS],
[AC_GNU_SOURCE])
AM_INIT_AUTOMAKE([-Wall foreign subdir-objects])
AM_PROG_CC_C_O
m4_ifdef([AM_PROG_AR], [AM_PROG_AR])
AC_PROG_LIBTOOL
AC_CONFIG_MACRO_DIR([m4])
AC_PROG_INSTALL
AM_CONDITIONAL([HAVE_GCC], [test "$ac_cv_prog_gcc" = yes])
PKG_CHECK_MODULES([CHECK], [check >= 0.9.5], [have_check=1], [have_check=])
if test x$have_check = x; then
AC_MSG_WARN([Without the 'CHECK' libraries, you will be unable to run all tests in the 'make check' suite])
fi
AM_CONDITIONAL([HAVE_CHECK], [test x$have_check != x])
m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES])
AC_CONFIG_HEADERS([config.h])
AC_SUBST([PRERELEASE_VERSION],
PRERELEASE_VERSION_NUMBER)
AC_SUBST([PATH_UTILS_VERSION], PATH_UTILS_VERSION_NUMBER)
AC_SUBST([DHASH_VERSION], DHASH_VERSION_NUMBER)
AC_SUBST([COLLECTION_VERSION], COLLECTION_VERSION_NUMBER)
AC_SUBST([REF_ARRAY_VERSION], REF_ARRAY_VERSION_NUMBER)
AC_SUBST([BASICOBJECTS_VERSION], BASICOBJECTS_VERSION_NUMBER)
AC_SUBST([INI_CONFIG_VERSION], INI_CONFIG_VERSION_NUMBER)
AM_CONDITIONAL([GIT_CHECKOUT], [git log -1 >/dev/null 2>&1])
AC_PATH_PROG([DOXYGEN], [doxygen], [false])
AM_CONDITIONAL([HAVE_DOXYGEN], [test x$DOXYGEN != xfalse ])
# Enable trace build
AC_ARG_ENABLE([trace],
[AS_HELP_STRING([--enable-trace[=LEVEL]],[build with low level tracing enabled])],
[trace_level="$enableval"],
[trace_level="0"])
AS_IF([test ["$trace_level" -gt "0"] -a ["$trace_level" -lt "8"] ],[AC_SUBST([TRACE_VAR],["-DTRACE_LEVEL=$trace_level"])])
AC_CHECK_SIZEOF([long])
AC_CHECK_SIZEOF([long long])
gl_LD_VERSION_SCRIPT
AM_ICONV
AM_GNU_GETTEXT([external])
AM_GNU_GETTEXT_VERSION([0.14.4])
AC_CHECK_FUNC([strcasestr],
AC_DEFINE([HAVE_STRCASESTR],
[1],
[Define if strcasestr exists]),
AC_MSG_ERROR("Platform must support strcasestr"))
AC_CHECK_FUNC([getline],
AC_DEFINE([HAVE_GETLINE],
[1],
[Define if getline() exists]),
AC_MSG_ERROR("Platform must support getline()"))
AC_DEFINE([COL_MAX_DATA], [65535], [Max length of the data block allowed in the collection value.])
AC_DEFINE([MAX_KEY], [1024], [Max length of the key in the INI file.])
#Support old versions of autotools that don't provide docdir
AC_SUBST([docdir])
if test x$docdir = x; then
AC_SUBST([docdir], ${datadir}/doc/AC_PACKAGE_NAME)
fi
AC_CONFIG_FILES([Makefile contrib/ding-libs.spec
path_utils/path_utils.cfg.doxy path_utils/path_utils.pc
dhash/dhash.pc
collection/collection.cfg.doxy collection/collection.pc
refarray/ref_array.cfg.doxy refarray/ref_array.pc
basicobjects/basicobjects.cfg.doxy
basicobjects/basicobjects.pc
ini/ini_config.cfg.doxy ini/ini_config.pc])
AC_OUTPUT
ding-libs-0.6.2/contrib/ 0000775 0000000 0000000 00000000000 14172606404 0015033 5 ustar 00root root 0000000 0000000 ding-libs-0.6.2/contrib/ding-libs.spec.in 0000664 0000000 0000000 00000023751 14172606404 0020174 0 ustar 00root root 0000000 0000000 Name: @PACKAGE_NAME@
Version: @PACKAGE_VERSION@
Release: 0%{?dist}@PRERELEASE_VERSION@
Summary: "Ding is not GLib" assorted utility libraries
Group: Development/Libraries
License: LGPLv3+
URL: http://fedorahosted.org/sssd/
Source0: %{name}-%{version}.tar.gz
BuildRoot: %(mktemp -ud %{_tmppath}/%{name}-%{version}-%{release}-XXXXXX)
%global path_utils_version @PATH_UTILS_VERSION@
%global dhash_version @DHASH_VERSION@
%global collection_version @COLLECTION_VERSION@
%global ref_array_version @REF_ARRAY_VERSION@
%global basicobjects_version @BASICOBJECTS_VERSION@
%global ini_config_version @INI_CONFIG_VERSION@
### Patches ###
### Dependencies ###
# ding-libs is a meta-package that will pull in all of its own
# sub-packages
Requires: libpath_utils = %{path_utils_version}-%{release}
Requires: libdhash = %{dhash_version}-%{release}
Requires: libcollection = %{collection_version}-%{release}
Requires: libref_array = %{ref_array_version}-%{release}
Requires: libini_config = %{ini_config_version}-%{release}
### Build Dependencies ###
BuildRequires: autoconf
BuildRequires: automake
BuildRequires: libtool
BuildRequires: m4
BuildRequires: doxygen
BuildRequires: pkgconfig
BuildRequires: check-devel
BuildRequires: gettext-devel
%description
A meta-package that pulls in libcollection, libdhash, libini_config,
librefarray and libpath_utils.
%package devel
Summary: Development packages for ding-libs
Group: Development/Libraries
License: LGPLv3+
# ding-libs is a meta-package that will pull in all of its own
# sub-packages
Requires: libpath_utils-devel = %{path_utils_version}-%{release}
Requires: libdhash-devel = %{dhash_version}-%{release}
Requires: libcollection-devel = %{collection_version}-%{release}
Requires: libref_array-devel = %{ref_array_version}-%{release}
Requires: libbasicobjects-devel = %{basicobjects_version}-%{release}
Requires: libini_config-devel = %{ini_config_version}-%{release}
%description devel
A meta-package that pulls in development libraries for libcollection,
libdhash, libini_config, librefarray and libpath_utils.
##############################################################################
# Path Utils
##############################################################################
%package -n libpath_utils
Summary: Filesystem Path Utilities
Group: Development/Libraries
License: LGPLv3+
Version: %{path_utils_version}
%description -n libpath_utils
Utility functions to manipulate filesystem pathnames
%package -n libpath_utils-devel
Summary: Development files for libpath_utils
Group: Development/Libraries
Requires: libpath_utils = %{path_utils_version}-%{release}
License: LGPLv3+
Version: %{path_utils_version}
%description -n libpath_utils-devel
Utility functions to manipulate filesystem pathnames
%post -n libpath_utils -p /sbin/ldconfig
%postun -n libpath_utils -p /sbin/ldconfig
%files -n libpath_utils
%defattr(-,root,root,-)
%doc COPYING COPYING.LESSER
%{_libdir}/libpath_utils.so.1
%{_libdir}/libpath_utils.so.1.0.1
%files -n libpath_utils-devel
%defattr(-,root,root,-)
%{_includedir}/path_utils.h
%{_libdir}/libpath_utils.so
%{_libdir}/pkgconfig/path_utils.pc
%doc path_utils/README.path_utils
%doc path_utils/doc/html/
##############################################################################
# dhash
##############################################################################
%package -n libdhash
Group: Development/Libraries
Summary: Dynamic hash table
License: LGPLv3+
Version: %{dhash_version}
%description -n libdhash
A hash table which will dynamically resize to achieve optimal storage & access
time properties
%package -n libdhash-devel
Summary: Development files for libdhash
Group: Development/Libraries
Requires: libdhash = %{dhash_version}-%{release}
License: LGPLv3+
Version: %{dhash_version}
%description -n libdhash-devel
A hash table which will dynamically resize to achieve optimal storage & access
time properties
%post -n libdhash -p /sbin/ldconfig
%postun -n libdhash -p /sbin/ldconfig
%files -n libdhash
%defattr(-,root,root,-)
%doc COPYING COPYING.LESSER
%{_libdir}/libdhash.so.1
%{_libdir}/libdhash.so.1.1.0
%files -n libdhash-devel
%defattr(-,root,root,-)
%{_includedir}/dhash.h
%{_libdir}/libdhash.so
%{_libdir}/pkgconfig/dhash.pc
%doc dhash/README.dhash
%doc dhash/examples/*.c
##############################################################################
# collection
##############################################################################
%package -n libcollection
Summary: Collection data-type for C
Group: Development/Libraries
License: LGPLv3+
Version: %{collection_version}
%description -n libcollection
A data-type to collect data in a hierarchical structure for easy iteration
and serialization
%package -n libcollection-devel
Summary: Development files for libcollection
Group: Development/Libraries
License: LGPLv3+
Requires: libcollection = %{collection_version}-%{release}
Version: %{collection_version}
%description -n libcollection-devel
A data-type to collect data in a hierarchical structure for easy iteration
and serialization
%post -n libcollection -p /sbin/ldconfig
%postun -n libcollection -p /sbin/ldconfig
%files -n libcollection
%defattr(-,root,root,-)
%doc COPYING
%doc COPYING.LESSER
%{_libdir}/libcollection.so.4
%{_libdir}/libcollection.so.4.1.1
%files -n libcollection-devel
%defattr(-,root,root,-)
%{_includedir}/collection.h
%{_includedir}/collection_tools.h
%{_includedir}/collection_queue.h
%{_includedir}/collection_stack.h
%{_libdir}/libcollection.so
%{_libdir}/pkgconfig/collection.pc
%doc collection/doc/html/
##############################################################################
# ref_array
##############################################################################
%package -n libref_array
Summary: A refcounted array for C
Group: Development/Libraries
License: LGPLv3+
Version: %{ref_array_version}
%description -n libref_array
A dynamically-growing, reference-counted array
%package -n libref_array-devel
Summary: Development files for libref_array
Group: Development/Libraries
Requires: libref_array = %{ref_array_version}-%{release}
License: LGPLv3+
Version: %{ref_array_version}
%description -n libref_array-devel
A dynamically-growing, reference-counted array
%post -n libref_array -p /sbin/ldconfig
%postun -n libref_array -p /sbin/ldconfig
%files -n libref_array
%defattr(-,root,root,-)
%doc COPYING
%doc COPYING.LESSER
%{_libdir}/libref_array.so.1
%{_libdir}/libref_array.so.1.2.1
%files -n libref_array-devel
%defattr(-,root,root,-)
%{_includedir}/ref_array.h
%{_libdir}/libref_array.so
%{_libdir}/pkgconfig/ref_array.pc
%doc refarray/README.ref_array
%doc refarray/doc/html/
##############################################################################
# basicobjects
##############################################################################
%package -n libbasicobjects
Summary: Basic object types for C
Group: Development/Libraries
License: GPLv3+
Version: %{basicobjects_version}
%description -n libbasicobjects
Basic object types
%package -n libbasicobjects-devel
Summary: Development files for libbasicobjects
Group: Development/Libraries
License: GPLv3+
Version: %{basicobjects_version}
Requires: libbasicobjects = %{basicobjects_version}-%{release}
%description -n libbasicobjects-devel
Basic object types
%post -n libbasicobjects -p /sbin/ldconfig
%postun -n libbasicobjects -p /sbin/ldconfig
%files -n libbasicobjects
%defattr(-,root,root,-)
%doc COPYING
%doc COPYING.LESSER
%{_libdir}/libbasicobjects.so.0
%{_libdir}/libbasicobjects.so.0.1.0
%files -n libbasicobjects-devel
%defattr(-,root,root,-)
%{_includedir}/simplebuffer.h
%{_libdir}/libbasicobjects.so
%{_libdir}/pkgconfig/basicobjects.pc
##############################################################################
# ini_config
##############################################################################
%package -n libini_config
Summary: INI file parser for C
Group: Development/Libraries
License: LGPLv3+
Version: %{ini_config_version}
%description -n libini_config
Library to process config files in INI format into a libcollection data
structure
%package -n libini_config-devel
Summary: Development files for libini_config
Group: Development/Libraries
License: LGPLv3+
Requires: libini_config = %{ini_config_version}-%{release}
Requires: libcollection-devel = %{collection_version}-%{release}
Requires: libref_array-devel = %{ref_array_version}-%{release}
Requires: libbasicobjects-devel = %{basicobjects_version}-%{release}
Version: %{ini_config_version}
%description -n libini_config-devel
Library to process config files in INI format into a libcollection data
structure
%post -n libini_config -p /sbin/ldconfig
%postun -n libini_config -p /sbin/ldconfig
%files -n libini_config
%defattr(-,root,root,-)
%doc COPYING
%doc COPYING.LESSER
%{_libdir}/libini_config.so.5
%{_libdir}/libini_config.so.5.2.1
%files -n libini_config-devel
%defattr(-,root,root,-)
%{_includedir}/ini_config.h
%{_includedir}/ini_configobj.h
%{_includedir}/ini_valueobj.h
%{_includedir}/ini_comment.h
%{_includedir}/ini_configmod.h
%{_libdir}/libini_config.so
%{_libdir}/pkgconfig/ini_config.pc
%doc ini/doc/html/
##############################################################################
# Build steps
##############################################################################
%prep
%setup -q
%build
autoreconf -ivf
%configure \
--disable-static
make %{?_smp_mflags} all docs
%check
make %{?_smp_mflags} check
%install
rm -rf $RPM_BUILD_ROOT
make install DESTDIR=$RPM_BUILD_ROOT
# Remove .la files created by libtool
rm -f $RPM_BUILD_ROOT/%{_libdir}/*.la
# Remove the example files from the output directory
# We will copy them directly from the source directory
# for packaging
rm -f \
$RPM_BUILD_ROOT/usr/share/doc/ding-libs/README.* \
$RPM_BUILD_ROOT/usr/share/doc/ding-libs/examples/dhash_example.c \
$RPM_BUILD_ROOT/usr/share/doc/ding-libs/examples/dhash_test.c
# Remove document install script. RPM is handling this
rm -f */doc/html/installdox
%clean
rm -rf $RPM_BUILD_ROOT
%changelog
* Tue Sep 21 2010 Stephen Gallagher - @PACKAGE_VERSION@-0
- Automated build of ding-libs
ding-libs-0.6.2/dhash/ 0000775 0000000 0000000 00000000000 14172606404 0014462 5 ustar 00root root 0000000 0000000 ding-libs-0.6.2/dhash/README.dhash 0000664 0000000 0000000 00000000063 14172606404 0016427 0 ustar 00root root 0000000 0000000 Documentation for libdhash can be found in dhash.h
ding-libs-0.6.2/dhash/dhash.c 0000664 0000000 0000000 00000102505 14172606404 0015720 0 ustar 00root root 0000000 0000000 /*
Authors:
John Dennis
Esmond Pitt
This implementation was based on a 3/7/1989 public domain submission
to comp.sources.misc by Esmond Pitt .
Copyright (C) 2009 Red Hat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see .
*/
/*****************************************************************************/
/******************************** Documentation ******************************/
/*****************************************************************************/
/*
* See documentation in corresponding header file dhash.h.
*
* Compilation controls:
* DEBUG controls some informative traces, mainly for debugging.
* HASH_STATISTICS causes hash_accesses and hash_collisions to be maintained;
* when combined with DEBUG, these are displayed by hash_destroy().
*
*/
/*****************************************************************************/
/******************************* Include Files *******************************/
/*****************************************************************************/
#include "config.h"
#include
#include
#include
#include
#include "dhash.h"
/*****************************************************************************/
/****************************** Internal Defines *****************************/
/*****************************************************************************/
#define PRIME_1 37
#define PRIME_2 1048583
#ifndef MIN
#define MIN(a,b) (((a) < (b)) ? (a) : (b))
#endif
#ifndef MAX
#define MAX(a,b) (((a) > (b)) ? (a) : (b))
#endif
#define halloc(table, size) table->halloc(size, table->halloc_pvt)
#define hfree(table, ptr) table->hfree(ptr, table->halloc_pvt)
#define hdelete_callback(table, type, entry) do { \
if (table->delete_callback) { \
table->delete_callback(entry, type, table->delete_pvt); \
} \
} while(0)
/*****************************************************************************/
/************************** Internal Type Definitions ************************/
/*****************************************************************************/
typedef struct element_t {
hash_entry_t entry;
struct element_t *next;
} element_t, *segment_t;
struct hash_table_str {
unsigned long p; /* Next bucket to be split */
unsigned long maxp; /* upper bound on p during expansion */
unsigned long entry_count; /* current # entries */
unsigned long bucket_count; /* current # buckets */
unsigned long segment_count; /* current # segments */
unsigned long min_load_factor;
unsigned long max_load_factor;
unsigned long directory_size;
unsigned int directory_size_shift;
unsigned long segment_size;
unsigned int segment_size_shift;
hash_delete_callback *delete_callback;
void *delete_pvt;
hash_alloc_func *halloc;
hash_free_func *hfree;
void *halloc_pvt;
segment_t **directory;
#ifdef HASH_STATISTICS
hash_statistics_t statistics;
#endif
};
typedef unsigned long address_t;
typedef struct hash_keys_callback_data_t {
unsigned long index;
hash_key_t *keys;
} hash_keys_callback_data_t;
typedef struct hash_values_callback_data_t {
unsigned long index;
hash_value_t *values;
} hash_values_callback_data_t;
struct _hash_iter_context_t {
struct hash_iter_context_t iter;
hash_table_t *table;
unsigned long i, j;
segment_t *s;
element_t *p;
};
enum hash_iter_state {
HI_STATE_0,
HI_STATE_1,
HI_STATE_2,
HI_STATE_3A,
HI_STATE_3B
};
/*****************************************************************************/
/********************** External Function Declarations *********************/
/*****************************************************************************/
/*****************************************************************************/
/********************** Internal Function Declarations *********************/
/*****************************************************************************/
static address_t convert_key(hash_key_t *key);
static address_t hash(hash_table_t *table, hash_key_t *key);
static bool key_equal(hash_key_t *a, hash_key_t *b);
static int contract_table(hash_table_t *table);
static int expand_table(hash_table_t *table);
static hash_entry_t *hash_iter_next(struct hash_iter_context_t *iter);
/*****************************************************************************/
/************************* External Global Variables ***********************/
/*****************************************************************************/
/*****************************************************************************/
/************************* Internal Global Variables ***********************/
/*****************************************************************************/
#ifdef DEBUG
int debug_level = 1;
#endif
/*****************************************************************************/
/*************************** Internal Functions ****************************/
/*****************************************************************************/
static void *sys_malloc_wrapper(size_t size, void *pvt)
{
return malloc(size);
}
static void sys_free_wrapper(void *ptr, void *pvt)
{
return free(ptr);
}
static address_t convert_key(hash_key_t *key)
{
address_t h;
const unsigned char *k;
switch(key->type) {
case HASH_KEY_ULONG:
h = key->ul;
break;
case HASH_KEY_STRING:
/* Convert string to integer */
for (h = 0, k = (const unsigned char *) key->str; *k; k++)
h = h * PRIME_1 ^ (*k - ' ');
break;
case HASH_KEY_CONST_STRING:
/* Convert string to integer */
for (h = 0, k = (const unsigned char *) key->c_str; *k; k++)
h = h * PRIME_1 ^ (*k - ' ');
break;
default:
h = key->ul;
break;
}
return h;
}
static address_t hash(hash_table_t *table, hash_key_t *key)
{
address_t h, address;
h = convert_key(key);
h %= PRIME_2;
address = h & (table->maxp-1); /* h % maxp */
if (address < table->p)
address = h & ((table->maxp << 1)-1); /* h % (2*table->maxp) */
return address;
}
static bool is_valid_key_type(hash_key_enum key_type)
{
switch(key_type) {
case HASH_KEY_ULONG:
case HASH_KEY_STRING:
case HASH_KEY_CONST_STRING:
return true;
default:
return false;
}
}
static bool is_valid_value_type(hash_value_enum value_type)
{
switch(value_type) {
case HASH_VALUE_UNDEF:
case HASH_VALUE_PTR:
case HASH_VALUE_INT:
case HASH_VALUE_UINT:
case HASH_VALUE_LONG:
case HASH_VALUE_ULONG:
case HASH_VALUE_FLOAT:
case HASH_VALUE_DOUBLE:
return true;
default:
return false;
}
}
static bool key_equal(hash_key_t *a, hash_key_t *b)
{
if (a->type != b->type) return false;
switch(a->type) {
case HASH_KEY_ULONG:
return (a->ul == b->ul);
case HASH_KEY_STRING:
return (strcmp(a->str, b->str) == 0);
case HASH_KEY_CONST_STRING:
return (strcmp(a->c_str, b->c_str) == 0);
}
return false;
}
static int expand_table(hash_table_t *table)
{
address_t new_address;
unsigned long old_segment_index, new_segment_index;
unsigned long old_segment_dir, new_segment_dir;
segment_t *old_segment, *new_segment;
element_t *current, **previous, **last_of_new;
if (table->bucket_count < (table->directory_size << table->segment_size_shift)) {
#ifdef DEBUG
if (debug_level >= 2)
fprintf(stderr, "expand_table on entry: bucket_count=%lu, segment_count=%lu p=%lu maxp=%lu\n",
table->bucket_count, table->segment_count, table->p, table->maxp);
#endif
#ifdef HASH_STATISTICS
table->statistics.table_expansions++;
#endif
/*
* Locate the bucket to be split
*/
old_segment_dir = table->p >> table->segment_size_shift;
old_segment = table->directory[old_segment_dir];
old_segment_index = table->p & (table->segment_size-1); /* p % segment_size */
/*
* Expand address space; if necessary create a new segment
*/
new_address = table->maxp + table->p;
new_segment_dir = new_address >> table->segment_size_shift;
new_segment_index = new_address & (table->segment_size-1); /* new_address % segment_size */
if (new_segment_index == 0) {
table->directory[new_segment_dir] = (segment_t *)halloc(table, table->segment_size * sizeof(segment_t));
if (table->directory[new_segment_dir] == NULL) {
return HASH_ERROR_NO_MEMORY;
}
memset(table->directory[new_segment_dir], 0, table->segment_size * sizeof(segment_t));
table->segment_count++;
}
new_segment = table->directory[new_segment_dir];
/*
* Adjust state variables
*/
table->p++;
if (table->p == table->maxp) {
table->maxp <<= 1; /* table->maxp *= 2 */
table->p = 0;
}
table->bucket_count++;
/*
* Relocate records to the new bucket
*/
previous = &old_segment[old_segment_index];
current = *previous;
last_of_new = &new_segment[new_segment_index];
*last_of_new = NULL;
while (current != NULL) {
if (hash(table, ¤t->entry.key) == new_address) {
/*
* Attach it to the end of the new chain
*/
*last_of_new = current;
/*
* Remove it from old chain
*/
*previous = current->next;
last_of_new = ¤t->next;
current = current->next;
*last_of_new = NULL;
} else {
/*
* leave it on the old chain
*/
previous = ¤t->next;
current = current->next;
}
}
#ifdef DEBUG
if (debug_level >= 2)
fprintf(stderr, "expand_table on exit: bucket_count=%lu, segment_count=%lu p=%lu maxp=%lu\n",
table->bucket_count, table->segment_count, table->p, table->maxp);
#endif
}
return HASH_SUCCESS;
}
static int contract_table(hash_table_t *table)
{
address_t new_address, old_address;
unsigned long old_segment_index, new_segment_index;
unsigned long old_segment_dir, new_segment_dir;
segment_t *old_segment, *new_segment;
element_t *current;
if ((table->bucket_count > table->segment_size) && (table->segment_count > 1)) {
#ifdef DEBUG
if (debug_level >= 2)
fprintf(stderr, "contract_table on entry: bucket_count=%lu, segment_count=%lu p=%lu maxp=%lu\n",
table->bucket_count, table->segment_count, table->p, table->maxp);
#endif
#ifdef HASH_STATISTICS
table->statistics.table_contractions++;
#endif
/*
* Locate the bucket to be merged with the last bucket
*/
old_address = table->bucket_count - 1;
old_segment_dir = old_address >> table->segment_size_shift;
old_segment = table->directory[old_segment_dir];
old_segment_index = old_address & (table->segment_size-1); /* old_address % segment_size */
/*
* Adjust state variables
*/
if (table->p > 0) {
table->p--;
} else {
table->maxp >>= 1;
table->p = table->maxp - 1;
}
table->bucket_count--;
/*
* Find the last bucket to merge back
*/
if((current = old_segment[old_segment_index]) != NULL) {
new_address = hash(table, &old_segment[old_segment_index]->entry.key);
new_segment_dir = new_address >> table->segment_size_shift;
new_segment_index = new_address & (table->segment_size-1); /* new_address % segment_size */
new_segment = table->directory[new_segment_dir];
/*
* Relocate records to the new bucket by splicing the two chains
* together by inserting the old chain at the head of the new chain.
* First find the end of the old chain, then set its next pointer to
* point to the head of the new chain, set the head of the new chain to
* point to the old chain, then finally set the head of the old chain to
* NULL.
*/
while (current->next != NULL) {
current = current->next;
}
current->next = new_segment[new_segment_index];
new_segment[new_segment_index] = old_segment[old_segment_index];
old_segment[old_segment_index] = NULL;
}
/*
* If we have removed the last of the chains in this segment then free the
* segment since its no longer in use.
*/
if (old_segment_index == 0) {
table->segment_count--;
hfree(table, table->directory[old_segment_dir]);
}
#ifdef DEBUG
if (debug_level >= 2)
fprintf(stderr, "contract_table on exit: bucket_count=%lu, segment_count=%lu p=%lu maxp=%lu\n",
table->bucket_count, table->segment_count, table->p, table->maxp);
#endif
}
return HASH_SUCCESS;
}
static int lookup(hash_table_t *table, hash_key_t *key, element_t **element_arg, segment_t **chain_arg)
{
address_t h;
segment_t *current_segment;
unsigned long segment_index, segment_dir;
segment_t *chain, element;
*element_arg = NULL;
*chain_arg = NULL;
if (!table) return HASH_ERROR_BAD_TABLE;
#ifdef HASH_STATISTICS
table->statistics.hash_accesses++;
#endif
h = hash(table, key);
segment_dir = h >> table->segment_size_shift;
segment_index = h & (table->segment_size-1); /* h % segment_size */
/*
* valid segment ensured by hash()
*/
current_segment = table->directory[segment_dir];
#ifdef DEBUG
if (debug_level >= 3)
fprintf(stderr, "lookup: h=%lu, segment_dir=%lu, segment_index=%lu current_segment=%p\n",
h, segment_dir, segment_index, current_segment);
#endif
if (current_segment == NULL) return EFAULT;
chain = ¤t_segment[segment_index];
element = *chain;
/*
* Follow collision chain
*/
while (element != NULL && !key_equal(&element->entry.key, key)) {
chain = &element->next;
element = *chain;
#ifdef HASH_STATISTICS
table->statistics.hash_collisions++;
#endif
}
*element_arg = element;
*chain_arg = chain;
return HASH_SUCCESS;
}
static bool hash_keys_callback(hash_entry_t *item, void *user_data)
{
hash_keys_callback_data_t *data = (hash_keys_callback_data_t *)user_data;
data->keys[data->index++] = item->key;
return true;
}
static bool hash_values_callback(hash_entry_t *item, void *user_data)
{
hash_values_callback_data_t *data = (hash_values_callback_data_t *)user_data;
data->values[data->index++] = item->value;
return true;
}
/*****************************************************************************/
/**************************** Exported Functions ***************************/
/*****************************************************************************/
const char* hash_error_string(int error)
{
switch(error) {
case HASH_SUCCESS: return "Success";
case HASH_ERROR_BAD_KEY_TYPE: return "Bad key type";
case HASH_ERROR_BAD_VALUE_TYPE: return "Bad value type";
case HASH_ERROR_NO_MEMORY: return "No memory";
case HASH_ERROR_KEY_NOT_FOUND: return "Key not found";
case HASH_ERROR_BAD_TABLE: return "Bad table";
}
return NULL;
}
int hash_create(unsigned long count, hash_table_t **tbl,
hash_delete_callback *delete_callback,
void *delete_private_data)
{
return hash_create_ex(count, tbl, 0, 0, 0, 0,
NULL, NULL, NULL,
delete_callback,
delete_private_data);
}
int hash_create_ex(unsigned long count, hash_table_t **tbl,
unsigned int directory_bits,
unsigned int segment_bits,
unsigned long min_load_factor,
unsigned long max_load_factor,
hash_alloc_func *alloc_func,
hash_free_func *free_func,
void *alloc_private_data,
hash_delete_callback *delete_callback,
void *delete_private_data) {
unsigned long i;
unsigned int n_addr_bits, requested_bits;
unsigned int requested_directory_bits;
unsigned int requested_segment_bits;
address_t addr;
hash_table_t *table = NULL;
/* Initialize to NULL in case of an early return due to an error */
*tbl = NULL;
if (alloc_func == NULL) alloc_func = sys_malloc_wrapper;
if (free_func == NULL) free_func = sys_free_wrapper;
/* Compute directory and segment parameters */
/* compute power of 2 >= count; it's the number of requested buckets */
if (count > 1) {
for (requested_bits = 0; (1 << requested_bits) < count; requested_bits++);
} else {
requested_bits = 1;
}
/*
* If caller didn't specify directory & segment allocation then
* compute it from the requested count.
*/
if (directory_bits == 0 || segment_bits == 0) {
/* Equally divide buckets between the directory and segments */
requested_directory_bits = MAX(requested_bits >> 1, 1);
requested_segment_bits = MAX(requested_bits - requested_directory_bits, 1);
/* If the requested count wasn't specified pick a default */
if (count == 0) {
directory_bits = MAX(requested_directory_bits, HASH_DEFAULT_DIRECTORY_BITS);
segment_bits = MAX(requested_segment_bits, HASH_DEFAULT_SEGMENT_BITS);
} else {
directory_bits = requested_directory_bits;
segment_bits = requested_segment_bits;
}
}
for (addr = ~0, n_addr_bits = 0; addr; addr >>= 1, n_addr_bits++);
if (directory_bits + segment_bits > n_addr_bits) return EINVAL;
table = (hash_table_t *)alloc_func(sizeof(hash_table_t),
alloc_private_data);
if (table == NULL) {
return HASH_ERROR_NO_MEMORY;
}
memset(table, 0, sizeof(hash_table_t));
table->halloc = alloc_func;
table->hfree = free_func;
table->halloc_pvt = alloc_private_data;
table->directory_size_shift = directory_bits;
table->directory_size = directory_bits ? 1 << directory_bits : 0;
table->segment_size_shift = segment_bits;
table->segment_size = segment_bits ? 1 << segment_bits : 0;
/* Allocate directory */
table->directory = (segment_t **)halloc(table, table->directory_size * sizeof(segment_t *));
if (table->directory == NULL) {
hash_destroy(table);
return HASH_ERROR_NO_MEMORY;
}
memset(table->directory, 0, table->directory_size * sizeof(segment_t *));
/*
* If one wanted to pre-allocate all the buckets necessary to meet the needs
* of the requested count it would be done like this:
*
* table->segment_count = MIN((count + table->segment_size-1) / table->segment_size,
* table->directory_size);
*
* But with dynamic hash tables there is little point to this, the whole idea is to
* allow the table to grow/shrink dynamically, therefore we start with just one
* segment of buckets, the minimum necessary.
*/
table->segment_count = 1;
table->p = 0;
table->entry_count = 0;
table->delete_callback = delete_callback;
table->delete_pvt = delete_private_data;
/*
* Allocate initial segments of buckets
*/
for (i = 0; i < table->segment_count; i++) {
table->directory[i] = (segment_t *)halloc(table, table->segment_size * sizeof(segment_t));
if (table->directory[i] == NULL) {
hash_destroy(table);
return HASH_ERROR_NO_MEMORY;
}
memset(table->directory[i], 0, table->segment_size * sizeof(segment_t));
}
table->bucket_count = table->segment_count << table->segment_size_shift;
table->maxp = table->bucket_count;
table->min_load_factor = min_load_factor == 0 ? HASH_DEFAULT_MIN_LOAD_FACTOR : min_load_factor;
table->max_load_factor = max_load_factor == 0 ? HASH_DEFAULT_MAX_LOAD_FACTOR : max_load_factor;
#ifdef DEBUG
if (debug_level >= 1) {
fprintf(stderr, "hash_create_ex: count=%lu available buckets=%lu bucket_count=%lu maxp=%lu\n",
count, table->directory_size*table->segment_size, table->bucket_count, table->maxp);
fprintf(stderr, " directory_bits=%u segment_bits=%u requested_bits=%u\n",
directory_bits, segment_bits, requested_bits);
fprintf(stderr, " directory_size=%lu segment_size=%lu segment_count=%lu\n",
table->directory_size, table->segment_size, table->segment_count);
fprintf(stderr, " min_load_factor=%lu max_load_factor=%lu\n",
table->min_load_factor, table->max_load_factor);
}
#endif
#ifdef HASH_STATISTICS
memset(&table->statistics, 0, sizeof(table->statistics));
#endif
*tbl = table;
return HASH_SUCCESS;
}
#ifdef HASH_STATISTICS
int hash_get_statistics(hash_table_t *table, hash_statistics_t *statistics)
{
if (!table) return HASH_ERROR_BAD_TABLE;
if (!statistics) return EINVAL;
*statistics = table->statistics;
return HASH_SUCCESS;
}
#endif
int hash_destroy(hash_table_t *table)
{
unsigned long i, j;
segment_t *s;
element_t *p, *q;
if (!table) return HASH_ERROR_BAD_TABLE;
if (table->directory) {
for (i = 0; i < table->segment_count; i++) {
/* test probably unnecessary */
if ((s = table->directory[i]) != NULL) {
for (j = 0; j < table->segment_size; j++) {
p = s[j];
while (p != NULL) {
q = p->next;
hdelete_callback(table, HASH_TABLE_DESTROY, &p->entry);
if (p->entry.key.type == HASH_KEY_STRING
|| p->entry.key.type == HASH_KEY_CONST_STRING) {
/* Internally we do not use constant memory for keys
* in hash table elements. */
hfree(table, p->entry.key.str);
}
hfree(table, (char *)p);
p = q;
}
}
hfree(table, s);
}
}
hfree(table, table->directory);
}
hfree(table, table);
table = NULL;
return HASH_SUCCESS;
}
int hash_iterate(hash_table_t *table, hash_iterate_callback callback, void *user_data)
{
unsigned long i, j;
segment_t *s;
element_t *p;
if (!table) return HASH_ERROR_BAD_TABLE;
if (table != NULL) {
for (i = 0; i < table->segment_count; i++) {
/* test probably unnecessary */
if ((s = table->directory[i]) != NULL) {
for (j = 0; j < table->segment_size; j++) {
p = s[j];
while (p != NULL) {
if(!(*callback)(&p->entry, user_data)) return HASH_SUCCESS;
p = p->next;
}
}
}
}
}
return HASH_SUCCESS;
}
static hash_entry_t *hash_iter_next(struct hash_iter_context_t *iter_arg)
{
struct _hash_iter_context_t *iter = (struct _hash_iter_context_t *) iter_arg;
hash_entry_t *entry = NULL;
enum hash_iter_state state = HI_STATE_3A;
if (iter->table == NULL) return NULL;
while (state != HI_STATE_0) {
switch (state) {
case HI_STATE_1:
iter->i++;
if(iter->i >= iter->table->segment_count) return NULL;
/* test probably unnecessary */
iter->s = iter->table->directory[iter->i];
if (iter->s == NULL) {
state = HI_STATE_1;
break;
}
iter->j = 0;
state = HI_STATE_2;
/* FALLTHROUGH */
case HI_STATE_2:
if (iter->j >= iter->table->segment_size) {
state = HI_STATE_1;
break;
}
iter->p = iter->s[iter->j];
state = HI_STATE_3A;
/* FALLTHROUGH */
case HI_STATE_3A:
if (iter->p == NULL) {
state = HI_STATE_3B;
break;
}
entry = &iter->p->entry;
iter->p = iter->p->next;
state = HI_STATE_0;
break;
case HI_STATE_3B:
iter->j++;
state = HI_STATE_2;
break;
default:
/* Should never reach here */
fprintf(stderr, "ERROR hash_iter_next reached invalid state\n");
return NULL;
break;
}
}
return entry;
}
struct hash_iter_context_t *new_hash_iter_context(hash_table_t *table)
{
struct _hash_iter_context_t *iter;
if (!table) return NULL;;
iter = halloc(table, sizeof(struct _hash_iter_context_t));
if (iter == NULL) {
return NULL;
}
iter->iter.next = (hash_iter_next_t) hash_iter_next;
iter->table = table;
iter->i = 0;
iter->j = 0;
iter->s = table->directory[iter->i];
iter->p = iter->s[iter->j];
return (struct hash_iter_context_t *)iter;
}
unsigned long hash_count(hash_table_t *table)
{
return table->entry_count;
}
int hash_keys(hash_table_t *table, unsigned long *count_arg, hash_key_t **keys_arg)
{
unsigned long count;
hash_key_t *keys;
hash_keys_callback_data_t data;
if (!table) return HASH_ERROR_BAD_TABLE;
count = table->entry_count;
if (count == 0) {
*count_arg = 0;
*keys_arg = NULL;
return HASH_SUCCESS;
}
keys = halloc(table, sizeof(hash_key_t) * count);
if (keys == NULL) {
*count_arg = -1;
*keys_arg = NULL;
return HASH_ERROR_NO_MEMORY;
}
data.index = 0;
data.keys = keys;
hash_iterate(table, hash_keys_callback, &data);
*count_arg = count;
*keys_arg = keys;
return HASH_SUCCESS;
}
int hash_values(hash_table_t *table, unsigned long *count_arg, hash_value_t **values_arg)
{
unsigned long count;
hash_value_t *values;
hash_values_callback_data_t data;
if (!table) return HASH_ERROR_BAD_TABLE;
count = table->entry_count;
if (count == 0) {
*count_arg = 0;
*values_arg = NULL;
return HASH_SUCCESS;
}
values = halloc(table, sizeof(hash_value_t) * count);
if (values == NULL) {
*count_arg = -1;
*values_arg = NULL;
return HASH_ERROR_NO_MEMORY;
}
data.index = 0;
data.values = values;
hash_iterate(table, hash_values_callback, &data);
*count_arg = count;
*values_arg = values;
return HASH_SUCCESS;
}
typedef struct hash_entries_callback_data_t {
unsigned long index;
hash_entry_t *entries;
} hash_entries_callback_data_t;
static bool hash_entries_callback(hash_entry_t *item, void *user_data)
{
hash_entries_callback_data_t *data = (hash_entries_callback_data_t *)user_data;
data->entries[data->index++] = *item;
return true;
}
int hash_entries(hash_table_t *table, unsigned long *count_arg, hash_entry_t **entries_arg)
{
unsigned long count;
hash_entry_t *entries;
hash_entries_callback_data_t data;
if (!table) return HASH_ERROR_BAD_TABLE;
count = table->entry_count;
if (count == 0) {
*count_arg = 0;
*entries_arg = NULL;
return HASH_SUCCESS;
}
entries = halloc(table, sizeof(hash_entry_t) * count);
if (entries == NULL) {
*count_arg = -1;
*entries_arg = NULL;
return HASH_ERROR_NO_MEMORY;
}
data.index = 0;
data.entries = entries;
hash_iterate(table, hash_entries_callback, &data);
*count_arg = count;
*entries_arg = entries;
return HASH_SUCCESS;
}
bool hash_has_key(hash_table_t *table, hash_key_t *key)
{
hash_value_t value;
if (hash_lookup(table, key, &value) == HASH_SUCCESS)
return true;
else
return false;
}
int hash_get_default(hash_table_t *table, hash_key_t *key, hash_value_t *value, hash_value_t *default_value)
{
int error;
if (!table) return HASH_ERROR_BAD_TABLE;
error = hash_lookup(table, key, value);
if (error == HASH_ERROR_KEY_NOT_FOUND) {
error = hash_enter(table, key, default_value);
if (error != HASH_SUCCESS) {
return error;
}
*value = *default_value;
return HASH_SUCCESS;
} else {
if (error != HASH_SUCCESS) return error;
}
return HASH_SUCCESS;
}
int hash_enter(hash_table_t *table, hash_key_t *key, hash_value_t *value)
{
int error;
segment_t element, *chain;
size_t len;
if (!table) return HASH_ERROR_BAD_TABLE;
if (!is_valid_key_type(key->type))
return HASH_ERROR_BAD_KEY_TYPE;
if (!is_valid_value_type(value->type))
return HASH_ERROR_BAD_VALUE_TYPE;
lookup(table, key, &element, &chain);
if (element == NULL) { /* not found */
element = (element_t *)halloc(table, sizeof(element_t));
if (element == NULL) {
/* Allocation failed, return NULL */
return HASH_ERROR_NO_MEMORY;
}
memset(element, 0, sizeof(element_t));
/*
* Initialize new element
*/
switch(element->entry.key.type = key->type) {
case HASH_KEY_ULONG:
element->entry.key.ul = key->ul;
break;
case HASH_KEY_STRING:
case HASH_KEY_CONST_STRING:
len = strlen(key->c_str) + 1;
element->entry.key.str = halloc(table, len);
if (element->entry.key.str == NULL) {
hfree(table, element);
return HASH_ERROR_NO_MEMORY;
}
memcpy(element->entry.key.str, key->str, len);
break;
}
*chain = element; /* link into chain */
element->next = NULL;
/*
* Table over-full?
*/
if (++table->entry_count / table->bucket_count > table->max_load_factor) {
if ((error = expand_table(table)) != HASH_SUCCESS) { /* doesn't affect element */
return error;
}
}
} else {
hdelete_callback(table, HASH_ENTRY_DESTROY, &element->entry);
}
switch(element->entry.value.type = value->type) {
case HASH_VALUE_UNDEF:
element->entry.value.ul = 0;
break;
case HASH_VALUE_PTR:
element->entry.value.ptr = value->ptr;
break;
case HASH_VALUE_INT:
element->entry.value.i = value->i;
break;
case HASH_VALUE_UINT:
element->entry.value.ui = value->ui;
break;
case HASH_VALUE_LONG:
element->entry.value.l = value->l;
break;
case HASH_VALUE_ULONG:
element->entry.value.ul = value->ul;
break;
case HASH_VALUE_FLOAT:
element->entry.value.f = value->f;
break;
case HASH_VALUE_DOUBLE:
element->entry.value.d = value->d;
break;
}
return HASH_SUCCESS;
}
int hash_lookup(hash_table_t *table, hash_key_t *key, hash_value_t *value)
{
segment_t element, *chain;
if (!table) return HASH_ERROR_BAD_TABLE;
if (!is_valid_key_type(key->type))
return HASH_ERROR_BAD_KEY_TYPE;
lookup(table, key, &element, &chain);
if (element) {
*value = element->entry.value;
return HASH_SUCCESS;
} else {
return HASH_ERROR_KEY_NOT_FOUND;
}
}
int hash_delete(hash_table_t *table, hash_key_t *key)
{
int error;
segment_t element, *chain;
if (!table) return HASH_ERROR_BAD_TABLE;
if (!is_valid_key_type(key->type))
return HASH_ERROR_BAD_KEY_TYPE;
lookup(table, key, &element, &chain);
if (element) {
hdelete_callback(table, HASH_ENTRY_DESTROY, &element->entry);
*chain = element->next; /* remove from chain */
/*
* Table too sparse?
*/
if (--table->entry_count / table->bucket_count < table->min_load_factor) {
if ((error = contract_table(table)) != HASH_SUCCESS) { /* doesn't affect element */
return error;
}
}
if (element->entry.key.type == HASH_KEY_STRING
|| element->entry.key.type == HASH_KEY_CONST_STRING) {
hfree(table, element->entry.key.str);
}
hfree(table, element);
return HASH_SUCCESS;
} else {
return HASH_ERROR_KEY_NOT_FOUND;
}
}
ding-libs-0.6.2/dhash/dhash.h 0000664 0000000 0000000 00000042406 14172606404 0015730 0 ustar 00root root 0000000 0000000 /*
Authors:
John Dennis
Esmond Pitt
This implementation was based on a 3/7/1989 public domain submission
to comp.sources.misc by Esmond Pitt .
Copyright (C) 2009 Red Hat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see .
*/
#ifndef DHASH_H
#define DHASH_H
/*****************************************************************************/
/******************************** Documentation ******************************/
/*****************************************************************************/
#if 0
Dynamic hash table implementation based on article in CACM April 1988 pp.
446-457, by Per-Ake Larson.
This implementation was based on a 3/7/1989 submission to comp.sources.misc by
Esmond Pitt (ejp@ausmelb.oz.AU) that emulated the hsearch(3) interface. The interface
was reworked to be much more flexible and significant new functionality was
added by John Dennis (jdennis@sharpeye.com).
A hash table maintains a set of pairs. Lookups are performed by
locating the key in the table and returning its value.
A dynamic hash table keeps the number of hash collisions constant
independent of the number of entries in the hash table.
Both keys and values may be of different types. Two different key types are
supported, strings and unsigned longs. If the key type is a string the hash
library will automatically allocate memory to hold the hash key string and
will automatically free the memory for the key string when the hash entry
is destroyed. Items in the hash table only match when their key types match
AND the keys themselves match. For example if there were two hash entries,
one whose key type was an unsigned long equal to 1 and one whose key type was
a string equal to "1" they would not match, these are considered two
distinct entries.
The value of the key may be a undefined, pointer, an int, an unsigned int, a
long, an unsigned long, a float, or a double. The hash library does nothing
with user pointers (value.type == HASH_VALUE_PTR). Its the user responsibility
to free items pointed to by these pointers when a hash entry is deleted or the
hash table is destroyed (see hash_delete_callback and/or hash_destroy).
See dhash_example.c for an illustration of how one might use the API. It does not
represent complete API coverage nor the optimal way to do things in all cases,
it is just a general example.
Copyright 2009-1010 John Dennis
This program is distributed under the terms of the GNU Lesser General Public
License (LGPL). See the included COPYING and COPYING.lesser files for the
terms of this license.
#endif
/*****************************************************************************/
/******************************* Include Files *******************************/
/*****************************************************************************/
#include
#include
/*****************************************************************************/
/*********************************** Defines *********************************/
/*****************************************************************************/
#if 1
#define HASH_STATISTICS
#endif
#define HASH_DEFAULT_DIRECTORY_BITS 5
#define HASH_DEFAULT_SEGMENT_BITS 5
#define HASH_DEFAULT_MIN_LOAD_FACTOR 1
#define HASH_DEFAULT_MAX_LOAD_FACTOR 5
#define HASH_ERROR_BASE -2000
#define HASH_ERROR_LIMIT (HASH_ERROR_BASE+20)
#define IS_HASH_ERROR(error) (((error) >= HASH_ERROR_BASE) && ((error) < HASH_ERROR_LIMIT))
#define HASH_SUCCESS 0
#define HASH_ERROR_BAD_KEY_TYPE (HASH_ERROR_BASE + 1)
#define HASH_ERROR_BAD_VALUE_TYPE (HASH_ERROR_BASE + 2)
#define HASH_ERROR_NO_MEMORY (HASH_ERROR_BASE + 3)
#define HASH_ERROR_KEY_NOT_FOUND (HASH_ERROR_BASE + 4)
#define HASH_ERROR_BAD_TABLE (HASH_ERROR_BASE + 5)
/*****************************************************************************/
/******************************* Type Definitions ****************************/
/*****************************************************************************/
struct hash_table_str;
typedef struct hash_table_str hash_table_t;
typedef enum {
HASH_KEY_STRING,
HASH_KEY_ULONG,
HASH_KEY_CONST_STRING
} hash_key_enum;
typedef enum
{
HASH_VALUE_UNDEF,
HASH_VALUE_PTR,
HASH_VALUE_INT,
HASH_VALUE_UINT,
HASH_VALUE_LONG,
HASH_VALUE_ULONG,
HASH_VALUE_FLOAT,
HASH_VALUE_DOUBLE
} hash_value_enum;
typedef enum
{
HASH_TABLE_DESTROY,
HASH_ENTRY_DESTROY
} hash_destroy_enum;
typedef struct hash_key_t {
hash_key_enum type;
union {
char *str;
const char *c_str;
unsigned long ul;
};
} hash_key_t;
typedef struct hash_value_t {
hash_value_enum type;
union {
void *ptr;
int i;
unsigned int ui;
long l;
unsigned long ul;
float f;
double d;
};
} hash_value_t;
typedef struct hash_entry_t {
hash_key_t key;
hash_value_t value;
} hash_entry_t;
#ifdef HASH_STATISTICS
typedef struct hash_statistics_t {
unsigned long hash_accesses;
unsigned long hash_collisions;
unsigned long table_expansions;
unsigned long table_contractions;
} hash_statistics_t;
#endif
/* typedef's for callback based iteration */
typedef bool(*hash_iterate_callback)(hash_entry_t *item, void *user_data);
typedef void (hash_delete_callback)(hash_entry_t *item,
hash_destroy_enum type, void *pvt);
/* typedef's for iteration object based iteration */
struct hash_iter_context_t;
typedef hash_entry_t *(*hash_iter_next_t)(struct hash_iter_context_t *iter);
struct hash_iter_context_t {
hash_iter_next_t next;
};
/* typedef for hash_create_ex() */
typedef void *(hash_alloc_func)(size_t size, void *pvt);
typedef void (hash_free_func)(void *ptr, void *pvt);
/*****************************************************************************/
/************************* External Global Variables ***********************/
/*****************************************************************************/
/*****************************************************************************/
/**************************** Exported Functions ***************************/
/*****************************************************************************/
/*
* Given an error code returned by a hash function, map it to a error string.
* Returns NULL if the error code is unrecognized.
*/
const char* hash_error_string(int error);
/*
* Create a new hash table with room for n initial entries. hash_create returns
* an opaque pointer to the new hash table in the table parameter. Functions
* operating on the hash table pass in this hash table pointer. This means you
* may have as many concurrent hash tables as you want.
* If the table creation is successful tbl is set to the new table and
* HASH_SUCCESS is returned, otherwise tbl will be set to NULL and the
* return value will be a HASH error code.
*
* count
* Expected number of entries in the table. This is a tuning
* parameter because a dynamic hash table dynamically adjusts it's
* internal data strucuture to optimize for the actual number of
* entries. The count parameter allows for some more optimization,
* however it's not critical to get it right, the table will still
* perform well. If you have no idea of how many entries to expect
* then pass 0, a reasonable default will be selected.
* tbl
* Pointer to a hash_table_t variable which is initialized to the
* new hash table (i.e. the returned table). If the table fails to
* be created due to errors the tbl parameter will be set to NULL
* and the return value will be a HASH error code.
* delete_callback
* Pointer to a function which will be called just prior to a hash
* entry being deleted. This is useful when the hash value has
* items which may need to be disposed of. The delete_callback may
* be NULL.
* delete_private_data
* Void pointer passed to the delete_callback, this way delete
* callbacks can have a private context to reach data they need to
* use before performning their operations. delete_private_data
* may be NULL.
*
* hash_create is identical to calling:
*
* hash_create_ex(count, tbl, 0, 0, 0, 0, NULL, NULL, NULL,
* delete_callback, delete_private_data);
*/
int hash_create(unsigned long count, hash_table_t **tbl,
hash_delete_callback *delete_callback,
void *delete_private_data);
/*
* Create a new hash table and fine tune it's configurable parameters.
* Refer to CACM article for explanation of parameters. See
* hash_create for other parameters and return values.
*
* directory_bits
* Number of address bits allocated to top level directory array.
* If directory_bits or segment_bits is zero then directory_bits
* and segment_bits will be computed based on the count parameter.
* segment_bits
* number of address bits allocated to segment array.
* min_load_factor
* The table contracted when the ratio of entry count to bucket count
* is less than the min_load_factor the table is contracted.
* max_load_factor
* The table expanded when the ratio of entry count to bucket count
* is greater than the max_load_factor the table is expanded.
* alloc_func
* Function pointer for allocation.
* free_func
* Function pointer for freeing memory allocated with alloc_func.
* alloc_private_data
* Data pointer passed to the alloc and free functions so that
* custom functions can refernce other private data they may need
* during their execution without having to use global variables.
*
* Note directory_bits + segment_bits must be <= number of bits in
* unsigned long
*/
int hash_create_ex(unsigned long count, hash_table_t **tbl,
unsigned int directory_bits,
unsigned int segment_bits,
unsigned long min_load_factor,
unsigned long max_load_factor,
hash_alloc_func *alloc_func,
hash_free_func *free_func,
void *alloc_private_data,
hash_delete_callback *delete_callback,
void *delete_private_data);
#ifdef HASH_STATISTICS
/*
* Return statistics for the table.
*/
int hash_get_statistics(hash_table_t *table, hash_statistics_t *statistics);
#endif
/*
* hash_destroy deletes all entries in the hash table, freeing all memory used
* in implementing the hash table. Some hash entries may have values which are
* pointers to user data structures. User pointers are not free by hash_destroy,
* they must be free by the caller. This may be done by iterating over all the
* entries in the table using hash_iterate() and freeing the values or by
* registering a delete callback when the table is created with
* hash_create(). Note, hash keys which are strings will be automatically freed
* by hash_destroy, the caller does not need to free the key strings.
*/
int hash_destroy(hash_table_t *table);
/*
* Enter or update an item in the table referenced by key. If the key does not
* exist yet the item will be created and inserted into the table with the
* value, otherwise the value for the existing key is updated. The return value
* may be HASH_ERROR_BAD_KEY_TYPE or HASH_ERROR_BAD_VALUE_TYPE if the key or
* value type respectively is invalid. This function might also return
* HASH_ERROR_NO_MEMORY.
*/
int hash_enter(hash_table_t *table, hash_key_t *key, hash_value_t *value);
/*
* Using the key lookup the value associated with it in the table. If the key is
* not in the table HASH_ERROR_KEY_NOT_FOUND is returned. If the type of key is
* invalid HASH_ERROR_BAD_KEY_TYPE is returned. Otherwise HASH_SUCCESS is
* returned. If the result is anything other than HASH_SUCCESS the value pointer
* is not updated.
*/
int hash_lookup(hash_table_t *table, hash_key_t *key, hash_value_t *value);
/*
* Like hash_lookup() except if the key is not in the table then it is entered
* into the table and assigned the default_value. Thus it is not possible for
* hash_get_default() to return HASH_ERROR_KEY_NOT_FOUND.
*/
int hash_get_default(hash_table_t *table, hash_key_t *key, hash_value_t *value, hash_value_t *default_value);
/*
* Delete the item from the table. The key and its type are specified in the key
* parameter which are passed by reference. If the key was in the table
* HASH_SUCCESS is returned otherwise HASH_ERROR_KEY_NOT_FOUND is
* returned. Memory allocated to hold the key if it was a string is free by the
* hash library, but values which are pointers to user data must be freed by the
* caller (see delete_callback).
*/
int hash_delete(hash_table_t *table, hash_key_t *key);
/*
* Often it is useful to operate on every key and/or value in the hash
* table. The hash_iterate function will invoke the users callback on every item
* in the table as long as the callback returns a non-zero value. Returning a
* zero from the callback can be used to halt the iteration prematurely if some
* condition is met. The user_data parameter is passed to the callback
* function. It can be used for any purpose the caller wants. The callback
* parameter list is:
*
* bool callback(hash_entry_t *item, void *user_data);
*
* WARNING: Do not modify the contents of the table during an iteration it will
* produce undefined results. If you need to visit each item in the table and
* potentially delete or insert some entries the proper way to do this is to
* obtain a list of keys or items using hash_keys() or hash_items() which
* returns a copy of the keys or items. You may then loop on the list returned
* and safely update the table (don't forget to free the list when done).
*/
int hash_iterate(hash_table_t *table, hash_iterate_callback callback, void *user_data);
/*
* This is another method to iterate on every key/value in the hash table.
* However, unlike hash_iterate which requires a callback this function returns
* an iterator object which contains a next() function pointer. Each time
* next() is invoked it returns a pointer to the next hash entry in the table,
* then NULL when all entries have been visited. In some circumstances it's more
* convenient than having to define a callback. Like hash_iterate() one must
* never modify the table contents during iteration. If you intend to modify the
* table during iteration use the functions which return an indepent list of
* keys, values, or items instead and iterate on the list. The iterator object
* must be free'ed when you're done iterating by calling free() on it.
*
* Example:
*
* struct hash_iter_context_t *iter;
* hash_entry_t *entry;
*
* iter = new_hash_iter_context(table);
* while ((entry = iter->next(iter)) != NULL) {
* do_something(entry);
* }
* free(iter);
*/
struct hash_iter_context_t *new_hash_iter_context(hash_table_t *table);
/*
* Return a count of how many items are currently in the table.
*/
unsigned long hash_count(hash_table_t *table);
/*
* Get an array of all the keys in the table returned through the keys
* parameter. The number of elements in the array is returned in the count
* parameter. Each key in the array is a copy of the key in the table. Any
* pointers in the key will be shared with the table entry thus both the item in
* the array and the item in the table point to the same object. The array
* should be freed by calling free(). The function may return
* HASH_ERROR_NO_MEMORY, otherwise HASH_SUCCESS.
*/
int hash_keys(hash_table_t *table, unsigned long *count, hash_key_t **keys);
/*
* Get an array of all the values in the table returned through the values
* parameter. The number of elements in the array is returned in the count
* parameter. Each value in the array is a copy of the value in the table. Any
* pointers in the value will be shared with the table entry thus both the item in
* the array and the item in the table point to the same object. The array
* should be freed by calling free(). The function may return
* HASH_ERROR_NO_MEMORY, otherwise HASH_SUCCESS.
*/
int hash_values(hash_table_t *table, unsigned long *count, hash_value_t **values);
/*
* Get an array of all the entries in the table returned through the entries
* parameter. The number of elements in the array is returned in the count
* parameter. Each entry in the array is a copy of the entry in the table. Any
* pointers in the entry will be shared with the table entry thus both the item in
* the array and the item in the table point to the same object. The array
* should be freed by calling free(). The function may return
* HASH_ERROR_NO_MEMORY, otherwise HASH_SUCCESS.
*/
int hash_entries(hash_table_t *table, unsigned long *count, hash_entry_t **entries);
/*
* Return boolean if the key is in the table.
*/
bool hash_has_key(hash_table_t *table, hash_key_t *key);
#endif
ding-libs-0.6.2/dhash/dhash.pc.in 0000664 0000000 0000000 00000000475 14172606404 0016510 0 ustar 00root root 0000000 0000000 prefix=@prefix@
exec_prefix=@exec_prefix@
libdir=@libdir@
includedir=@includedir@
Name: dhash
Description: A hash table which will dynamically resize to achieve optimal storage & access time properties
Version: @DHASH_VERSION@
Libs: -L${libdir} -ldhash
Cflags: -I${includedir}
URL: https://github.com/SSSD/ding-libs
ding-libs-0.6.2/dhash/dhash_ut_check.c 0000664 0000000 0000000 00000013520 14172606404 0017563 0 ustar 00root root 0000000 0000000 /*
Authors:
Michal Zidek
Copyright (C) 2016 Red Hat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see .
*/
#include "config.h"
#include
#include
#include
#include
/* #define TRACE_LEVEL 7 */
#define TRACE_HOME
#include "dhash.h"
#define HTABLE_SIZE 128
int verbose = 0;
/* There must be no warnings generated during this test
* without having to cast the key value. */
START_TEST(test_key_const_string)
{
hash_table_t *htable;
int ret;
hash_value_t ret_val;
hash_value_t enter_val1;
hash_value_t enter_val2;
hash_key_t key;
enter_val1.type = HASH_VALUE_INT;
enter_val1.i = 1;
enter_val2.type = HASH_VALUE_INT;
enter_val2.i = 2;
key.type = HASH_KEY_CONST_STRING;
key.c_str = "constant";
ret = hash_create(HTABLE_SIZE, &htable, NULL, NULL);
fail_unless(ret == 0);
/* The table is empty, lookup should return error */
ret = hash_lookup(htable, &key, &ret_val);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
/* Deleting with non-existing key should return error */
ret = hash_delete(htable, &key);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
ret = hash_enter(htable, &key, &enter_val1);
fail_unless(ret == 0);
hash_lookup(htable, &key, &ret_val);
fail_unless(ret == 0);
fail_unless(ret_val.i == 1);
/* Overwrite the entry */
ret = hash_enter(htable, &key, &enter_val2);
fail_unless(ret == 0);
hash_lookup(htable, &key, &ret_val);
fail_unless(ret == 0);
fail_unless(ret_val.i == 2);
ret = hash_delete(htable, &key);
fail_unless(ret == 0);
/* Delete again with the same key */
ret = hash_delete(htable, &key);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
ret = hash_destroy(htable);
fail_unless(ret == 0);
}
END_TEST
START_TEST(test_key_string)
{
hash_table_t *htable;
int ret;
hash_value_t ret_val;
hash_value_t enter_val1;
hash_value_t enter_val2;
hash_key_t key;
char str[] = "non_constant";
enter_val1.type = HASH_VALUE_INT;
enter_val1.i = 1;
enter_val2.type = HASH_VALUE_INT;
enter_val2.i = 2;
key.type = HASH_KEY_STRING;
key.str = str;
ret = hash_create(HTABLE_SIZE, &htable, NULL, NULL);
fail_unless(ret == 0);
/* The table is empty, lookup should return error */
ret = hash_lookup(htable, &key, &ret_val);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
/* Deleting with non-existing key should return error */
ret = hash_delete(htable, &key);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
ret = hash_enter(htable, &key, &enter_val1);
fail_unless(ret == 0);
hash_lookup(htable, &key, &ret_val);
fail_unless(ret == 0);
fail_unless(ret_val.i == 1);
/* Overwrite the entry */
ret = hash_enter(htable, &key, &enter_val2);
fail_unless(ret == 0);
hash_lookup(htable, &key, &ret_val);
fail_unless(ret == 0);
fail_unless(ret_val.i == 2);
ret = hash_delete(htable, &key);
fail_unless(ret == 0);
/* Delete again with the same key */
ret = hash_delete(htable, &key);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
ret = hash_destroy(htable);
fail_unless(ret == 0);
}
END_TEST
START_TEST(test_key_ulong)
{
hash_table_t *htable;
int ret;
hash_value_t ret_val;
hash_value_t enter_val1;
hash_value_t enter_val2;
hash_key_t key;
enter_val1.type = HASH_VALUE_INT;
enter_val1.i = 1;
enter_val2.type = HASH_VALUE_INT;
enter_val2.i = 2;
key.type = HASH_KEY_ULONG;
key.ul = 68ul;
ret = hash_create(HTABLE_SIZE, &htable, NULL, NULL);
fail_unless(ret == 0);
/* The table is empty, lookup should return error */
ret = hash_lookup(htable, &key, &ret_val);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
/* Deleting with non-existing key should return error */
ret = hash_delete(htable, &key);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
ret = hash_enter(htable, &key, &enter_val1);
fail_unless(ret == 0);
hash_lookup(htable, &key, &ret_val);
fail_unless(ret == 0);
fail_unless(ret_val.i == 1);
/* Overwrite the entry */
ret = hash_enter(htable, &key, &enter_val2);
fail_unless(ret == 0);
hash_lookup(htable, &key, &ret_val);
fail_unless(ret == 0);
fail_unless(ret_val.i == 2);
ret = hash_delete(htable, &key);
fail_unless(ret == 0);
/* Delete again with the same key */
ret = hash_delete(htable, &key);
fail_unless(ret == HASH_ERROR_KEY_NOT_FOUND);
ret = hash_destroy(htable);
fail_unless(ret == 0);
}
END_TEST
static Suite *dhash_suite(void)
{
Suite *s = suite_create("");
TCase *tc_basic = tcase_create("dhash API tests");
tcase_add_test(tc_basic, test_key_const_string);
tcase_add_test(tc_basic, test_key_string);
tcase_add_test(tc_basic, test_key_ulong);
suite_add_tcase(s, tc_basic);
return s;
}
int main(void)
{
int number_failed;
Suite *s = dhash_suite();
SRunner *sr = srunner_create(s);
/* If CK_VERBOSITY is set, use that, otherwise it defaults to CK_NORMAL */
srunner_run_all(sr, CK_ENV);
number_failed = srunner_ntests_failed(sr);
srunner_free(sr);
return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE;
}
ding-libs-0.6.2/dhash/examples/ 0000775 0000000 0000000 00000000000 14172606404 0016300 5 ustar 00root root 0000000 0000000 ding-libs-0.6.2/dhash/examples/dhash_example.c 0000664 0000000 0000000 00000010727 14172606404 0021255 0 ustar 00root root 0000000 0000000 /*
Authors:
John Dennis
Copyright (C) 2009 Red Hat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see .
*/
#include
#include
#include
#include
#include "dhash.h"
struct my_data_t {
int foo;
char bar[128];
};
static void delete_callback(hash_entry_t *entry,
hash_destroy_enum type,
void *pvt)
{
if (entry->value.type == HASH_VALUE_PTR) free(entry->value.ptr);
}
static bool visit_callback(hash_entry_t *entry,
void *user_data)
{
unsigned long *count = (unsigned long *)user_data;
struct my_data_t *my_data = (struct my_data_t *) entry->value.ptr;
(*count)++;
printf("%s = [foo=%d bar=%s]\n", entry->key.str, my_data->foo, my_data->bar);
return true;
}
static struct my_data_t *new_data(int foo, const char *bar)
{
struct my_data_t *my_data = malloc(sizeof(struct my_data_t));
my_data->foo = foo;
strncpy(my_data->bar, bar, sizeof(my_data->bar));
return my_data;
}
int main(int argc, char **argv)
{
static hash_table_t *table = NULL;
hash_key_t key, *keys;
hash_value_t value;
struct hash_iter_context_t *iter;
hash_entry_t *entry;
unsigned long i, n_entries;
int error;
struct my_data_t *my_data = new_data(1024, "Hello World!");
unsigned long count;
/* Create a hash table */
error = hash_create(10, &table, delete_callback, NULL);
if (error != HASH_SUCCESS) {
fprintf(stderr, "cannot create hash table (%s)\n", hash_error_string(error));
return error;
}
/* Enter a key named "My Data" and specify it's value as a pointer to my_data */
key.type = HASH_KEY_STRING;
key.str = strdup("My Data");
value.type = HASH_VALUE_PTR;
value.ptr = my_data;
if ((error = hash_enter(table, &key, &value)) != HASH_SUCCESS) {
fprintf(stderr, "cannot add to table \"%s\" (%s)\n", key.str, hash_error_string(error));
return error;
}
free(key.str);
/* Get a list of keys and print them out, free the list when we're done */
if ((error = hash_keys(table, &count, &keys)) != HASH_SUCCESS) {
fprintf(stderr, "cannot get key list (%s)\n", hash_error_string(error));
return error;
}
for (i = 0; i < count; i++)
printf("key: %s\n", keys[i].str);
free(keys);
/* Lookup the key named "My Data" */
key.type = HASH_KEY_STRING;
key.str = strdup("My Data");
if ((error = hash_lookup(table, &key, &value)) != HASH_SUCCESS) {
fprintf(stderr, "cannot find key \"%s\" (%s)\n", key.str, hash_error_string(error));
}
free(key.str);
/* Visit each entry in the table, callback will increment count on each visit */
printf("Iterate using callback\n");
count = 0;
hash_iterate(table, visit_callback, &count);
/* Assure number of visits equal the table size */
assert(count == hash_count(table));
/* Visit each entry using iterator object */
printf("Iterate using iterator\n");
n_entries = 0;
iter = new_hash_iter_context(table);
while ((entry = iter->next(iter)) != NULL) {
struct my_data_t *data = (struct my_data_t *) entry->value.ptr;
printf("%s = [foo=%d bar=%s]\n", entry->key.str, data->foo, data->bar);
n_entries++;
}
free(iter);
/* Assure number of visits equal the table size */
assert(n_entries == hash_count(table));
/* Remove the entry, deletion callback will be invoked */
key.type = HASH_KEY_STRING;
key.str = strdup("My Data");
if ((error = hash_delete(table, &key)) != HASH_SUCCESS) {
fprintf(stderr, "cannot delete from table (%s)\n", hash_error_string(error));
}
/* Assure key is no longer in table */
assert (!hash_has_key(table, &key));
free(key.str);
/* Free the table */
hash_destroy(table);
return 0;
}
ding-libs-0.6.2/dhash/examples/dhash_test.c 0000664 0000000 0000000 00000046631 14172606404 0020604 0 ustar 00root root 0000000 0000000 /*
Authors:
John Dennis
Copyright (C) 2009 Red Hat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see .
*/
#include
#include
#include
#include
#include
#include
#include "dhash.h"
#define BUF_SIZE 1024
#define DEFAULT_MAX_TEST (500)
hash_entry_t *iter_result_1 = NULL;
hash_entry_t *iter_result_2 = NULL;
unsigned long max_test = DEFAULT_MAX_TEST;
int verbose = 0;
static const char *error_string(int error)
{
const char *str;
if (IS_HASH_ERROR(error))
return hash_error_string(error);
if (error < 0) {
return "Negative error codes are not supported.";
}
str = strerror(error);
if (str == NULL) {
return "strerror() returned NULL.";
}
return str;
}
static char *key_string(hash_key_t *key)
{
static char buf[BUF_SIZE];
switch(key->type) {
case HASH_KEY_ULONG:
snprintf(buf, sizeof(buf), "key ulong = %lu", key->ul);
break;
case HASH_KEY_STRING:
snprintf(buf, sizeof(buf), "key string = \"%s\"", key->str);
break;
case HASH_KEY_CONST_STRING:
snprintf(buf, sizeof(buf), "key string = \"%s\"", key->c_str);
break;
default:
snprintf(buf, sizeof(buf), "unknown key type = %d", key->type);
break;
}
return buf;
}
static char *value_string(hash_value_t *value)
{
static char buf[BUF_SIZE];
switch(value->type) {
case HASH_VALUE_UNDEF:
snprintf(buf, sizeof(buf), "value undefined");
break;
case HASH_VALUE_PTR:
snprintf(buf, sizeof(buf), "value str = \"%s\"", (char *)value->ptr);
break;
case HASH_VALUE_INT:
snprintf(buf, sizeof(buf), "value int = %d", value->i);
break;
case HASH_VALUE_UINT:
snprintf(buf, sizeof(buf), "value unsigned int = %u", value->ui);
break;
case HASH_VALUE_LONG:
snprintf(buf, sizeof(buf), "value long = %ld", value->l);
break;
case HASH_VALUE_ULONG:
snprintf(buf, sizeof(buf), "value unsigned long = %lu", value->ul);
break;
case HASH_VALUE_FLOAT:
snprintf(buf, sizeof(buf), "value float = %f", value->f);
break;
case HASH_VALUE_DOUBLE:
snprintf(buf, sizeof(buf), "value double = %f", value->f);
break;
default:
snprintf(buf, sizeof(buf), "unknown value type = %d", value->type);
break;
}
return buf;
}
static char *entry_string(hash_entry_t *entry)
{
static char buf[BUF_SIZE];
snprintf(buf, sizeof(buf), "[%s] = [%s]", key_string(&entry->key), value_string(&entry->value));
return buf;
}
static bool callback(hash_entry_t *item, void *user_data)
{
unsigned long *callback_count = (unsigned long *)user_data;
iter_result_1[*callback_count] = *item;
(*callback_count)++;
if (verbose) printf("%s\n", entry_string(item));
return true;
}
static void delete_callback(hash_entry_t *item, hash_destroy_enum type,
void *pvt)
{
if (item->value.type == HASH_VALUE_PTR) free(item->value.ptr);
}
typedef struct test_val_t {
long val;
char *str;
} test_val_t;
int main(int argc, char **argv)
{
test_val_t *test = NULL;
long i, j, k;
bool duplicate;
long val;
int status;
hash_value_t value;
hash_value_t old_value;
hash_value_t new_value;
hash_key_t key;
char buf[BUF_SIZE];
hash_table_t *table = NULL;
unsigned long callback_count = 0;
unsigned long table_size = 0;
unsigned int seed = time(0);
unsigned int directory_bits = 0;
unsigned int segment_bits = 0;
unsigned long min_load_factor = HASH_DEFAULT_MIN_LOAD_FACTOR;
unsigned long max_load_factor = HASH_DEFAULT_MAX_LOAD_FACTOR;
while (1) {
int arg;
int option_index = 0;
static struct option long_options[] = {
{"count", 1, 0, 'c'},
{"verbose", 1, 0, 'v'},
{"quiet", 1, 0, 'q'},
{"table-size", 1, 0, 't'},
{"directory-bits", 1, 0, 'd'},
{"segment-bits", 1, 0, 's'},
{"min-load-factor", 1, 0, 'l'},
{"max-load-factor", 1, 0, 'h'},
{"seed", 1, 0, 'r'},
{0, 0, 0, 0}
};
arg = getopt_long(argc, argv, "c:vqt:d:s:l:h:r:",
long_options, &option_index);
if (arg == -1) break;
switch (arg) {
case 'c':
max_test = strtoul(optarg, NULL, 0);
break;
case 'v':
verbose = 1;
break;
case 'q':
verbose = 0;
break;
case 't':
table_size = strtoul(optarg, NULL, 0);
break;
case 'd':
directory_bits = atoi(optarg);
break;
case 's':
segment_bits = atoi(optarg);
break;
case 'l':
min_load_factor = strtoul(optarg, NULL, 0);
break;
case 'h':
max_load_factor = strtoul(optarg, NULL, 0);
break;
case 'r':
seed = strtoul(optarg, NULL, 0);
break;
}
}
if ((test = (test_val_t *) calloc(max_test, sizeof(test_val_t))) == NULL) {
fprintf(stderr, "Failed to allocate test array\n");
exit(1);
}
if ((iter_result_1 = (hash_entry_t *) calloc(max_test, sizeof(hash_entry_t))) == NULL) {
fprintf(stderr, "Failed to allocate iter_result_1 array\n");
exit(1);
}
if ((iter_result_2 = (hash_entry_t *) calloc(max_test, sizeof(hash_entry_t))) == NULL) {
fprintf(stderr, "Failed to allocate iter_result_2 array\n");
exit(1);
}
/* Initialize the random number generator */
srandom(seed);
printf("random seed: %#x\n", seed);
/* Create the hash table as small as possible to exercise growth */
if ((status = hash_create_ex(table_size, &table,
directory_bits, segment_bits,
min_load_factor, max_load_factor,
NULL, NULL, NULL,
delete_callback, NULL)) != HASH_SUCCESS) {
fprintf(stderr, "table creation failed at line %d (%s)\n", __LINE__, error_string(status));
exit(1);
}
/* Initialize the array of test values */
for (i = 0; i < max_test; i++) {
/* Get random value, make sure it's unique */
duplicate = true;
while (duplicate) {
duplicate = false;
val = random();
for (j = 0; j < i; j++) {
if (test[j].val == val) {
duplicate = true;
break;
}
}
}
test[i].val = val;
/* If the value is odd we'll use a string as the key,
* otherwise we'll use an unsigned long as the key */
if (test[i].val & 1) {
key.type = HASH_KEY_STRING;
snprintf(buf, BUF_SIZE, "%ld", test[i].val);
test[i].str = strdup(buf);
}
}
printf("Completed building test values, beginning test ...\n");
/* Enter all the test values into the hash table */
for (i = 0; i < max_test; i++) {
if (test[i].val & 1) {
key.type = HASH_KEY_STRING;
key.str = test[i].str;
value.type = HASH_VALUE_PTR;
value.ptr = (void *) strdup(test[i].str);
}
else {
key.type = HASH_KEY_ULONG;
key.ul = test[i].val;
value.type = HASH_VALUE_LONG;
value.l = test[i].val;
}
if (hash_has_key(table, &key)) {
fprintf(stderr, "Error: %ld already in table when inserting, i = %lu, at line %d\n",
test[i].val, i, __LINE__);
exit(1);
}
if ((status = hash_enter(table, &key, &value)) != HASH_SUCCESS) {
fprintf(stderr, "Error: %ld failed insertion at line %d (%s) \n",
test[i].val, __LINE__, error_string(status));
exit(1);
}
}
/* Now visit each entry in the table using a callback iterator,
* store what we found in iter_result_1 for testing the iterator object later on */
if (verbose) printf("callback iterate:\n");
callback_count = 0;
if ((status = hash_iterate(table, callback, &callback_count)) != HASH_SUCCESS) {
fprintf(stderr, "hash_iterate failed at line %d (%s)\n", __LINE__, error_string(status));
exit(1);
}
if (verbose) printf("hash_count=%ld, callback_count=%ld\n", hash_count(table), callback_count);
if (hash_count(table) != callback_count) {
fprintf(stderr, "Error: hash_count(%ld) != callback_count(%ld) at line %d\n",
hash_count(table), callback_count, __LINE__);
exit(1);
}
/* Now vist each entry in the table using an iterator object */
{
struct hash_iter_context_t *iter;
unsigned long n_items;
hash_entry_t *entry;
if (verbose) printf("iter iterate:\n");
n_items = 0;
iter = new_hash_iter_context(table);
while ((entry = iter->next(iter)) != NULL) {
if (verbose) printf("%s\n", entry_string(entry));
iter_result_2[n_items] = *entry;
n_items++;
}
if (verbose) printf("hash_count=%ld, n_items=%ld\n", hash_count(table), n_items);
if (hash_count(table) != n_items) {
fprintf(stderr, "Error: hash_count(%ld) != n_items(%ld) at line %d\n",
hash_count(table), n_items, __LINE__);
exit(1);
}
free(iter);
}
/* Both iterators should have visited each item in the same order, verify ... */
for (i = 0; i < max_test; i++) {
if (memcmp(&iter_result_1[i], &iter_result_2[i], sizeof(iter_result_1[0])) != 0) {
fprintf(stderr, "Error: iter_result_1[%lu] != iter_result_2[%lu] at line %d\n",
i, i, __LINE__);
exit(1);
}
}
/* Get an array of keys in the table, print them out */
{
unsigned long count;
hash_key_t *keys;
if (verbose) printf("\nhash_keys:\n");
if ((status = hash_keys(table, &count, &keys)) != HASH_SUCCESS) {
fprintf(stderr, "hash_keys failed at line %d (%s)\n",
__LINE__, error_string(status));
exit(1);
}
if (hash_count(table) != count) {
fprintf(stderr, "Error: hash_count(%ld) != hash_keys() count(%ld) at line %d\n",
hash_count(table), count, __LINE__);
exit(1);
}
for (i = 0; i < count; i++) {
if (verbose) printf("%s\n", key_string(&keys[i]));
}
free(keys);
}
/* Get an array of values in the table, print them out */
{
unsigned long count;
hash_value_t *values;
if (verbose) printf("\nhash_values:\n");
hash_values(table, &count, &values);
if (hash_count(table) != count) {
fprintf(stderr, "Error: hash_count(%ld) != hash_values() count(%ld) at line %d\n",
hash_count(table), count, __LINE__);
exit(1);
}
for (i = 0; i < count; i++) {
if (verbose) printf("%s\n", value_string(&values[i]));
}
free(values);
}
/* Get an array of items in the table, print them out */
{
unsigned long count;
hash_entry_t *entries;
if (verbose) printf("\nhash_entries:\n");
hash_entries(table, &count, &entries);
if (hash_count(table) != count) {
fprintf(stderr, "Error: hash_count(%ld) != hash_entries() count(%ld) at line %d\n",
hash_count(table), count, __LINE__);
exit(1);
}
for (i = 0; i < count; i++) {
if (verbose) printf("%s\n", entry_string(&entries[i]));
}
free(entries);
}
/* See if we can find every key */
for (i = max_test - 1; i >= 0; i--) {
if (test[i].val & 1) {
key.type = HASH_KEY_STRING;
key.str = test[i].str;
}
else {
key.type = HASH_KEY_ULONG;
key.ul = test[i].val;
}
if ((status = hash_lookup(table, &key, &value)) != HASH_SUCCESS) {
fprintf(stderr, "Error: failed first lookup for value %ld at index %ld at line %d (%s)\n",
test[i].val, i, __LINE__, error_string(status));
exit(1);
}
else {
switch(value.type) {
case HASH_VALUE_PTR:
if (strcmp((char *)value.ptr, test[i].str) != 0) {
fprintf(stderr, "Error: corrupt ptr data for %lu at line %d\n", i, __LINE__);
exit(1);
}
break;
case HASH_VALUE_LONG:
if (value.l != test[i].val) {
fprintf(stderr, "Error: corrupt long data for %lu at line %d\n", i, __LINE__);
exit(1);
}
break;
default:
fprintf(stderr, "Error: unknown value type for %lu\n", i);
break;
}
}
}
/* Update an entry */
if (test[0].val & 1) {
key.type = HASH_KEY_STRING;
key.str = test[0].str;
} else {
key.type = HASH_KEY_ULONG;
key.ul = test[0].val;
}
if ((status = hash_lookup(table, &key, &value)) != HASH_SUCCESS) {
fprintf(stderr, "Error: failed lookup for value %ld, at line %d (%s)\n",
test[0].val, __LINE__, error_string(status));
exit(1);
}
old_value.type = value.type;
switch (value.type) {
case HASH_VALUE_LONG:
old_value.ul = value.ul;
break;
case HASH_VALUE_PTR:
old_value.ptr = strdup(value.ptr);
break;
default:
fprintf(stderr, "Error: unsupported value type for update.\n");
exit(1);
}
value.type = HASH_VALUE_PTR;
value.ptr = (void *) strdup("Updated");
if ((status = hash_enter(table, &key, &value)) != HASH_SUCCESS) {
fprintf(stderr, "Error: %ld failed insertion at line %d (%s) \n",
test[0].val, __LINE__, error_string(status));
exit(1);
}
if ((status = hash_lookup(table, &key, &new_value)) != HASH_SUCCESS) {
fprintf(stderr, "Error: failed lookup for value %ld, at line %d (%s)\n",
test[0].val, __LINE__, error_string(status));
exit(1);
}
if (value.type == new_value.type) {
if (strcmp(value.ptr, new_value.ptr) != 0) {
fprintf(stderr, "Error: Updated value is not correct, "
"expected (%s) got (%s), at line %d\n",
(char *) value.ptr, (char *) new_value.ptr, __LINE__);
exit(1);
}
} else {
fprintf(stderr, "Error: Updated value is not correct, "
"expected type (%d) got (%d), at line %d\n",
value.type, new_value.type, __LINE__);
exit(1);
}
if ((status = hash_enter(table, &key, &old_value)) != HASH_SUCCESS) {
fprintf(stderr, "Error: %ld failed insertion at line %d (%s) \n",
test[0].val, __LINE__, error_string(status));
exit(1);
}
/*
* Delete a key, make sure we can't find it, assure we can find all other
* keys.
*/
for (i = 0; i < max_test; i++) {
if (test[i].val & 1) {
key.type = HASH_KEY_STRING;
key.str = test[i].str;
}
else {
key.type = HASH_KEY_ULONG;
key.ul = test[i].val;
}
if ((status = hash_lookup(table, &key, &value)) != HASH_SUCCESS) {
fprintf(stderr, "Error: failed delete lookup for value %ld at index %ld at line %d (%s)\n",
test[i].val, i, __LINE__, error_string(status));
exit(1);
}
if ((status = hash_delete(table, &key)) != HASH_SUCCESS) {
fprintf(stderr, "Error: %ld not in table when deleting, i = %lu at line %d (%s)\n",
test[i].val, i, __LINE__, error_string(status));
exit(1);
}
if (hash_lookup(table, &key, &value) != HASH_ERROR_KEY_NOT_FOUND) {
fprintf(stderr, "Error: found in table after deletion, value = %ld at index %ld at line %d\n",
test[i].val, i, __LINE__);
exit(1);
}
/* See if we can find all remaining keys */
for (k = i + 1; k < max_test; k++) {
if (test[k].val & 1) {
key.type = HASH_KEY_STRING;
key.str = test[k].str;
} else {
key.type = HASH_KEY_ULONG;
key.ul = test[k].val;
}
if ((status = hash_lookup(table, &key, &value)) != HASH_SUCCESS) {
fprintf(stderr, "Error: failed second lookup for value %ld, i = %lu k = %lu at line %d (%s)\n",
test[k].val, i, k, __LINE__, error_string(status));
exit(1);
} else {
switch(value.type) {
case HASH_VALUE_PTR:
if (strcmp((char *)value.ptr, test[k].str) != 0) {
fprintf(stderr, "Error: corrupt ptr data for %lu at line %d\n", k, __LINE__);
exit(1);
}
break;
case HASH_VALUE_LONG:
if (value.l != test[k].val) {
fprintf(stderr, "Error: corrupt long data for %lu at line %d\n", k, __LINE__);
exit(1);
}
break;
default:
fprintf(stderr, "Error: unknown value type (%d) for %lu\n", value.type, k);
break;
}
}
}
}
if (verbose) printf("\n");
#ifdef HASH_STATISTICS
{
hash_statistics_t stats;
if ((status = hash_get_statistics(table, &stats)) != HASH_SUCCESS) {
fprintf(stderr, "Error: could not get statistics at line %d (%s)\n",
__LINE__, error_string(status));
exit(1);
}
printf("Statistics: Accesses = %ld, Collisions = %ld, Collision Rate = %.2f, Expansions = %ld, Contractions = %ld\n",
stats.hash_accesses, stats.hash_collisions,
((float)stats.hash_collisions / (float)stats.hash_accesses),
stats.table_expansions, stats.table_contractions);
}
#endif
if ((status = hash_destroy(table)) != HASH_SUCCESS) {
fprintf(stderr, "table destruction failed at line %d (%s)\n",
__LINE__, error_string(status));
exit(1);
}
for (i = 0; i < max_test; i++) {
if (test[i].val & 1) {
free(test[i].str);
}
}
free(test);
free(iter_result_1);
free(iter_result_2);
printf("Successfully tested %lu values\n", max_test);
return 0;
}
ding-libs-0.6.2/dhash/libdhash.sym 0000664 0000000 0000000 00000000530 14172606404 0016770 0 ustar 00root root 0000000 0000000 DHASH_0.4.3 {
global:
hash_error_string;
hash_create;
hash_create_ex;
hash_get_statistics;
hash_destroy;
hash_enter;
hash_lookup;
hash_get_default;
hash_delete;
hash_iterate;
new_hash_iter_context;
hash_count;
hash_keys;
hash_values;
hash_entries;
hash_has_key;
local:
*;
};
ding-libs-0.6.2/ini/ 0000775 0000000 0000000 00000000000 14172606404 0014152 5 ustar 00root root 0000000 0000000 ding-libs-0.6.2/ini/ini.conf 0000664 0000000 0000000 00000005773 14172606404 0015614 0 ustar 00root root 0000000 0000000 # INI file that is used by unit test
data = ds,mf.ds,mf.ds,m.ds,mds.,fmds.
dskjh = mdsmdssm ,md.sd,
C1 = "abcd"
;test data
wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww = haha
[
]
[ wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww ]
;more data
= "nmjdsbfmsdn"
s = "nmjdsbfmsdn
HEX1 = 'ABV1'
HEX2 = 'ABV'
[ ttt ]
C2 ='Ab'
int=-44i44
int2=-66U
c =
with creame and sugar
[ dddd ]
DC1 = 123U
f=-9.0.0
DC2 = -235L
DC3 = -345.8907
[ zoo
something
[ ttt ]
v=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555
v1=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555.55555555555555555555555555555555
C3 = -34756.56
C4 = .9
ding-libs-0.6.2/ini/ini.d/ 0000775 0000000 0000000 00000000000 14172606404 0015153 5 ustar 00root root 0000000 0000000 ding-libs-0.6.2/ini/ini.d/comment.conf 0000664 0000000 0000000 00000001015 14172606404 0017461 0 ustar 00root root 0000000 0000000 /* C-style comment 1 */
/*
* C-style comment 2 */
/*
//
* C-style comment 2
//
commented_out_key = some_value
*/
# The following should be viewed as comment
# so no error is expected
/*/ = /*/
# The following should be viewed as key
# so no error is expected
/./ = //
# The following should be viewed as key
# but it would be error due to spaces
/./* = /./
// This should be an error becuase parser thinks it should be a KVP line
/* Same with this one */
/* This comment should procduce an error
ding-libs-0.6.2/ini/ini.d/first.conf 0000664 0000000 0000000 00000001322 14172606404 0017147 0 ustar 00root root 0000000 0000000 [section_a]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
#END OF THE FIRST FILE
ding-libs-0.6.2/ini/ini.d/foo.conf.in 0000664 0000000 0000000 00000000240 14172606404 0017206 0 ustar 00root root 0000000 0000000 #Hoho section
[hoho]
#Hoho value
val= hoho
#End of hoho
#Start of section
[foo]
#First value
bar = first value
#Second value
bar = second value
#End of section
ding-libs-0.6.2/ini/ini.d/ipa.conf 0000664 0000000 0000000 00000005300 14172606404 0016571 0 ustar 00root root 0000000 0000000 [provider/ipa]
ipa_domain = str, None, true
ipa_server = str, None, true
ipa_hostname = str, None, false
ldap_uri = str, None, false
ldap_search_base = str, None, false
ldap_schema = str, None, false
ldap_default_bind_dn = str, None, false
ldap_default_authtok_type = str, None, false
ldap_default_authtok = str, None, false
ldap_network_timeout = int, None, false
ldap_opt_timeout = int, None, false
ldap_offline_timeout = int, None, false
ldap_tls_cacert = str, None, false
ldap_tls_reqcert = str, None, false
ldap_sasl_mech = str, None, false
ldap_sasl_authid = str, None, false
krb5_kdcip = str, None, false
krb5_realm = str, None, false
krb5_auth_timeout = int, None, false
ldap_krb5_keytab = str, None, false
ldap_krb5_init_creds = bool, None, false
ldap_entry_usn = str, None, false
ldap_rootdse_last_usn = str, None, false
ldap_referrals = bool, None, false
[provider/ipa/id]
ldap_search_timeout = int, None, false
ldap_enumeration_refresh_timeout = int, None, false
ldap_purge_cache_timeout = int, None, false
ldap_id_use_start_tls = bool, None, false
ldap_user_search_base = str, None, false
ldap_user_search_scope = str, None, false
ldap_user_search_filter = str, None, false
ldap_user_object_class = str, None, false
ldap_user_name = str, None, false
ldap_user_uid_number = str, None, false
ldap_user_gid_number = str, None, false
ldap_user_gecos = str, None, false
ldap_user_homedir = str, None, false
ldap_user_shell = str, None, false
ldap_user_uuid = str, None, false
ldap_user_principal = str, None, false
ldap_user_fullname = str, None, false
ldap_user_member_of = str, None, false
ldap_user_modify_timestamp = str, None, false
ldap_user_shadow_last_change = str, None, false
ldap_user_shadow_min = str, None, false
ldap_user_shadow_max = str, None, false
ldap_user_shadow_warning = str, None, false
ldap_user_shadow_inactive = str, None, false
ldap_user_shadow_expire = str, None, false
ldap_user_shadow_flag = str, None, false
ldap_user_krb_last_pwd_change = str, None, false
ldap_user_krb_password_expiration = str, None, false
ldap_pwd_attribute = str, None, false
ldap_group_search_base = str, None, false
ldap_group_search_scope = str, None, false
ldap_group_search_filter = str, None, false
ldap_group_object_class = str, None, false
ldap_group_name = str, None, false
ldap_group_gid_number = str, None, false
ldap_group_member = str, None, false
ldap_group_uuid = str, None, false
ldap_group_modify_timestamp = str, None, false
ldap_force_upper_case_realm = bool, None, false
[provider/ipa/auth]
krb5_ccachedir = str, None, false
krb5_ccname_template = str, None, false
krb5_keytab = str, None, false
krb5_validate = bool, None, false
[provider/ipa/access]
[provider/ipa/chpass]
krb5_changepw_principal = str, None, false
ding-libs-0.6.2/ini/ini.d/merge.validator 0000664 0000000 0000000 00000006301 14172606404 0020161 0 ustar 00root root 0000000 0000000 Errors detected while parsing: %s%s/comment.conf.
Error (9) on line 22: Invalid space character at the beginning of the line.
Error (9) on line 24: Invalid space character at the beginning of the line.
Error (9) on line 26: Invalid space character at the beginning of the line.
Error (15) on line 32: Incomplete comment at the end of the file.
Section [section_a] found in file %s%s/first.conf is not allowed.
Section [section_c] found in file %s%s/first.conf is not allowed.
Section [section_b] found in file %s%s/first.conf is not allowed.
File %s%s/first.conf contains sections that are not allowed. Skipping.
Section [section_a] found in file %s%s/mergecheck.conf is not allowed.
Section [section_c] found in file %s%s/mergecheck.conf is not allowed.
Section [section_b] found in file %s%s/mergecheck.conf is not allowed.
Section [section_d] found in file %s%s/mergecheck.conf is not allowed.
File %s%s/mergecheck.conf contains sections that are not allowed. Skipping.
Section [service] found in file %s%s/mysssd.conf is not allowed.
Section [sssd] found in file %s%s/mysssd.conf is not allowed.
Section [nss] found in file %s%s/mysssd.conf is not allowed.
Section [pam] found in file %s%s/mysssd.conf is not allowed.
Section [domain] found in file %s%s/mysssd.conf is not allowed.
File %s%s/mysssd.conf contains sections that are not allowed. Skipping.
Section [section_a] found in file %s%s/second.conf is not allowed.
Section [section_b] found in file %s%s/second.conf is not allowed.
Section [section_d] found in file %s%s/second.conf is not allowed.
File %s%s/second.conf contains sections that are not allowed. Skipping.
Section [section1] found in file %s%s/sexpect.conf is not allowed.
Section [section2] found in file %s%s/sexpect.conf is not allowed.
File %s%s/sexpect.conf contains sections that are not allowed. Skipping.
Section [section1] found in file %s%s/smerge.conf is not allowed.
Section [section2] found in file %s%s/smerge.conf is not allowed.
File %s%s/smerge.conf contains sections that are not allowed. Skipping.
Errors detected while parsing: %s%s/space.conf.
Error (9) on line 1: Invalid space character at the beginning of the line.
Error (9) on line 2: Invalid space character at the beginning of the line.
Error (9) on line 3: Invalid space character at the beginning of the line.
Error (9) on line 4: Invalid space character at the beginning of the line.
Section [info] found in file %s%s/symbols.conf is not allowed.
Section [languages] found in file %s%s/symbols.conf is not allowed.
Section [text] found in file %s%s/symbols.conf is not allowed.
File %s%s/symbols.conf contains sections that are not allowed. Skipping.
Errors detected while parsing: %s%s/test.conf.
Error (9) on line 11: Invalid space character at the beginning of the line.
Error (9) on line 12: Invalid space character at the beginning of the line.
Error (9) on line 14: Invalid space character at the beginning of the line.
Error (9) on line 15: Invalid space character at the beginning of the line.
Error (9) on line 16: Invalid space character at the beginning of the line.
Error (9) on line 26: Invalid space character at the beginning of the line.
Error (9) on line 35: Invalid space character at the beginning of the line.
%s%s/ipa.conf
%s%s/real.conf
ding-libs-0.6.2/ini/ini.d/mergecheck.conf 0000664 0000000 0000000 00000040200 14172606404 0020113 0 ustar 00root root 0000000 0000000 # Section mode: MERGE, value mode: OVERWRITE
[section_a]
key1 = second file, key1 second multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 second multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 second multi value
key2 = key2 second multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 second multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: MERGE, value mode: ERROR
# This is an expected error 17 in mode 0 + 16 + 1
# Section mode: MERGE, value mode: PRESERVE
[section_a]
key1 = first file, key1 single value
key2 = first file, key2 single value
[section_c]
key1 = first file, key1 single value
key2 = first file, key2 single value
[section_b]
key1 = key1 single value
key2 = key2 single value
key3 = key3 single value
[section_d]
key1 = second file, key1 single value
key2 = second file, key2 single value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: MERGE, value mode: ALLOW
[section_a]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key3 = key3 single value
key3 = key3 first multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: MERGE, value mode: DETECT
# This is an expected error 17 in mode 0 + 64 + 4
[section_a]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key3 = key3 single value
key3 = key3 first multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: ERROR, value mode: OVERWRITE
# This is an expected error 17 in mode 256 + 0 + 0
# Section mode: ERROR, value mode: ERROR
# This is an expected error 17 in mode 256 + 16 + 1
# Section mode: ERROR, value mode: PRESERVE
# This is an expected error 17 in mode 256 + 32 + 2
# Section mode: ERROR, value mode: ALLOW
# This is an expected error 17 in mode 256 + 48 + 3
# Section mode: ERROR, value mode: DETECT
# This is an expected error 17 in mode 256 + 64 + 4
# Section mode: OVERWRITE, value mode: OVERWRITE
[section_a]
key1 = second file, key1 second multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 second multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 second multi value
key2 = key2 second multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 second multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: OVERWRITE, value mode: ERROR
# This is an expected error 17 in mode 512 + 16 + 1
# Section mode: OVERWRITE, value mode: PRESERVE
[section_a]
key1 = second file, key1 single value
key2 = second file, key2 single value
[section_c]
key1 = first file, key1 single value
key2 = first file, key2 single value
[section_b]
key1 = key1 single value
key2 = key2 single value
key3 = key3 single value
[section_d]
key1 = second file, key1 single value
key2 = second file, key2 single value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: OVERWRITE, value mode: ALLOW
[section_a]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key3 = key3 single value
key3 = key3 first multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: OVERWRITE, value mode: DETECT
# This is an expected error 17 in mode 512 + 64 + 4
[section_a]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key3 = key3 single value
key3 = key3 first multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: PRESERVE, value mode: OVERWRITE
[section_a]
key1 = first file, key1 second multi value
key2 = first file, key2 second multi value
[section_c]
key1 = first file, key1 second multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 second multi value
key2 = key2 second multi value
[section_d]
key1 = second file, key1 second multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: PRESERVE, value mode: ERROR
[section_a]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: PRESERVE, value mode: PRESERVE
[section_a]
key1 = first file, key1 single value
key2 = first file, key2 single value
[section_c]
key1 = first file, key1 single value
key2 = first file, key2 single value
[section_b]
key1 = key1 single value
key2 = key2 single value
[section_d]
key1 = second file, key1 single value
key2 = second file, key2 single value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: PRESERVE, value mode: ALLOW
[section_a]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: PRESERVE, value mode: DETECT
[section_a]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: DETECT, value mode: OVERWRITE
# This is an expected error 17 in mode 1024 + 0 + 0
[section_a]
key1 = second file, key1 second multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 second multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 second multi value
key2 = key2 second multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 second multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: DETECT, value mode: ERROR
# This is an expected error 17 in mode 1024 + 16 + 1
# Section mode: DETECT, value mode: PRESERVE
# This is an expected error 17 in mode 1024 + 32 + 2
[section_a]
key1 = first file, key1 single value
key2 = first file, key2 single value
[section_c]
key1 = first file, key1 single value
key2 = first file, key2 single value
[section_b]
key1 = key1 single value
key2 = key2 single value
key3 = key3 single value
[section_d]
key1 = second file, key1 single value
key2 = second file, key2 single value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: DETECT, value mode: ALLOW
# This is an expected error 17 in mode 1024 + 48 + 3
[section_a]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key3 = key3 single value
key3 = key3 first multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
# Section mode: DETECT, value mode: DETECT
# This is an expected error 17 in mode 1024 + 64 + 4
[section_a]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
[section_c]
key1 = first file, key1 single value
key1 = first file, key1 first multi value
key1 = first file, key1 second multi value
key2 = first file, key2 single value
key2 = first file, key2 first multi value
key2 = first file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key3 = key3 single value
key3 = key3 first multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE FIRST FILE
#END OF THE SECOND FILE
ding-libs-0.6.2/ini/ini.d/mysssd.conf 0000664 0000000 0000000 00000003421 14172606404 0017344 0 ustar 00root root 0000000 0000000 # Format:
# option = type, subtype, mandatory[, default]
[service]
# Options available to all services
debug_level = int, None, false
debug_timestamps = bool, None, false
debug_to_files = bool, None, false
command = str, None, false
reconnection_retries = int, None, false
[sssd]
# Monitor service
services = list, str, true, nss, pam
domains = list, str, true
timeout = int, None, false
sbus_timeout = int, None, false
re_expression = str, None, false
full_name_format = str, None, false
[nss]
# Name service
enum_cache_timeout = int, None, false
entry_cache_no_wait_percentage = int, None, false
entry_negative_timeout = int, None, false
filter_users = list, str, false
filter_groups = list, str, false
filter_users_in_groups = bool, None, false
pwfield = str, None, false
[pam]
# Authentication service
offline_credentials_expiration = int, None, false
offline_failed_login_attempts = int, None, false
offline_failed_login_delay = int, None, false
[provider]
#Available provider types
id_provider = str, None, true
auth_provider = str, None, true
access_provider = str, None, false
chpass_provider = str, None, false
[domain]
# Options available to all domains
debug_level = int, None, false, 0
debug_timestamps = bool, None, false
command = str, None, false
min_id = int, None, true, 1000
max_id = int, None, false
timeout = int, None, false
enumerate = bool, None, false
cache_credentials = bool, None, true, false
store_legacy_passwords = bool, None, false
use_fully_qualified_names = bool, None, false
entry_cache_timeout = int, None, false
lookup_family_order = str, None, false
account_cache_expiration = int, None, false
filter_users = list, str, false
filter_groups = list, str, false
# Special providers
[provider/permit]
[provider/permit/access]
[provider/deny]
[provider/deny/access]
ding-libs-0.6.2/ini/ini.d/new_line.conf 0000664 0000000 0000000 00000000000 14172606404 0017610 0 ustar 00root root 0000000 0000000 ding-libs-0.6.2/ini/ini.d/real.conf 0000664 0000000 0000000 00000003161 14172606404 0016746 0 ustar 00root root 0000000 0000000 // This is a real file with some comments
[config]
version = 0.1
/**/
[monitor]
description = Monitor Configuration
sbusTimeout = 10
sbusAddress = unix:path=/var/lib/sss/pipes/private/dbus
servicePingTime = 10
bad_number = 5a
/* Service section defines
* which service are allowed.
*/
[services]
description = Local service configuration
activeServices = dp, nss, pam, info
[services/dp]
description = Data Provider Configuration
command = /usr/libexec/sssd/sssd_dp
[services/nss]
description = NSS Responder Configuration
unixSocket = /var/lib/sss/pipes/nss
command = /usr/libexec/sssd/sssd_nss
[services/pam]
command = /usr/libexec/sssd/sssd_pam
description = PAM Responder Configuration
unixSocket = /var/lib/sss/pipes/pam
[services/info]
description = InfoPipe Configuration
command = ./sbin/sssd_info
[domains]
domainsOrder = , LOCAL, , EXAMPLE.COM, , SOMEOTHER.COM , ,
badarray = , , , , ,
somearray = ,
someotherarray = , ;
justdelim=:;,;
yetanother =
[domains/LOCAL]
description = Reserved domain for local configurations
legacy = FALSE
enumerate = 3
[domains/EXAMPLE.COM]
description = Example domain served by IPA
provider = ipa
server = ipaserver1.example.com
server = ipabackupserver.example.com
legacy = FALSE
server = otheripabackupserver.example.com
enumerate = 0
binary_test = '010203'
binary_test_two = '0A0b0C'
long_array = 1 2; 4' ;8p .16/ 32?
double_array = 1.1 2.222222; .4' . ;8p .16/ -32?
server = yetanotheripabackupserver.example.com
empty_value =
space_value = " "
int32_t = -1000000000
uint32_t = 3000000000
int64_t = -1000000000123
uint64_t = 9223375036854775931
ding-libs-0.6.2/ini/ini.d/real16be.conf 0000664 0000000 0000000 00000006330 14172606404 0017425 0 ustar 00root root 0000000 0000000 þÿ / / T h i s i s a r e a l f i l e w i t h s o m e c o m m e n t s
[ c o n f i g ]
v e r s i o n = 0 . 1
/ * * /
[ m o n i t o r ]
d e s c r i p t i o n = M o n i t o r C o n f i g u r a t i o n
s b u s T i m e o u t = 1 0
s b u s A d d r e s s = u n i x : p a t h = / v a r / l i b / s s s / p i p e s / p r i v a t e / d b u s
s e r v i c e P i n g T i m e = 1 0
b a d _ n u m b e r = 5 a
/ * S e r v i c e s e c t i o n d e f i n e s
* w h i c h s e r v i c e a r e a l l o w e d .
* /
[ s e r v i c e s ]
d e s c r i p t i o n = L o c a l s e r v i c e c o n f i g u r a t i o n
a c t i v e S e r v i c e s = d p , n s s , p a m , i n f o
[ s e r v i c e s / d p ]
d e s c r i p t i o n = D a t a P r o v i d e r C o n f i g u r a t i o n
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ d p
[ s e r v i c e s / n s s ]
d e s c r i p t i o n = N S S R e s p o n d e r C o n f i g u r a t i o n
u n i x S o c k e t = / v a r / l i b / s s s / p i p e s / n s s
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ n s s
[ s e r v i c e s / p a m ]
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ p a m
d e s c r i p t i o n = P A M R e s p o n d e r C o n f i g u r a t i o n
u n i x S o c k e t = / v a r / l i b / s s s / p i p e s / p a m
[ s e r v i c e s / i n f o ]
d e s c r i p t i o n = I n f o P i p e C o n f i g u r a t i o n
c o m m a n d = . / s b i n / s s s d _ i n f o
[ d o m a i n s ]
d o m a i n s O r d e r = , L O C A L , , E X A M P L E . C O M , , S O M E O T H E R . C O M , ,
b a d a r r a y = , , , , ,
s o m e a r r a y = ,
s o m e o t h e r a r r a y = , ;
j u s t d e l i m = : ; , ;
y e t a n o t h e r =
[ d o m a i n s / L O C A L ]
d e s c r i p t i o n = R e s e r v e d d o m a i n f o r l o c a l c o n f i g u r a t i o n s
l e g a c y = F A L S E
e n u m e r a t e = 3
[ d o m a i n s / E X A M P L E . C O M ]
d e s c r i p t i o n = E x a m p l e d o m a i n s e r v e d b y I P A
p r o v i d e r = i p a
s e r v e r = i p a s e r v e r 1 . e x a m p l e . c o m
s e r v e r = i p a b a c k u p s e r v e r . e x a m p l e . c o m
l e g a c y = F A L S E
s e r v e r = o t h e r i p a b a c k u p s e r v e r . e x a m p l e . c o m
e n u m e r a t e = 0
b i n a r y _ t e s t = ' 0 1 0 2 0 3 '
b i n a r y _ t e s t _ t w o = ' 0 A 0 b 0 C '
l o n g _ a r r a y = 1 2 ; 4 ' ; 8 p . 1 6 / 3 2 ?
d o u b l e _ a r r a y = 1 . 1 2 . 2 2 2 2 2 2 ; . 4 ' . ; 8 p . 1 6 / - 3 2 ?
s e r v e r = y e t a n o t h e r i p a b a c k u p s e r v e r . e x a m p l e . c o m
e m p t y _ v a l u e =
s p a c e _ v a l u e = " "
i n t 3 2 _ t = - 1 0 0 0 0 0 0 0 0 0
u i n t 3 2 _ t = 3 0 0 0 0 0 0 0 0 0
i n t 6 4 _ t = - 1 0 0 0 0 0 0 0 0 0 1 2 3
u i n t 6 4 _ t = 3 0 0 0 0 0 0 0 0 0 1 2 3
ding-libs-0.6.2/ini/ini.d/real16le.conf 0000664 0000000 0000000 00000006330 14172606404 0017437 0 ustar 00root root 0000000 0000000 ÿþ/ / T h i s i s a r e a l f i l e w i t h s o m e c o m m e n t s
[ c o n f i g ]
v e r s i o n = 0 . 1
/ * * /
[ m o n i t o r ]
d e s c r i p t i o n = M o n i t o r C o n f i g u r a t i o n
s b u s T i m e o u t = 1 0
s b u s A d d r e s s = u n i x : p a t h = / v a r / l i b / s s s / p i p e s / p r i v a t e / d b u s
s e r v i c e P i n g T i m e = 1 0
b a d _ n u m b e r = 5 a
/ * S e r v i c e s e c t i o n d e f i n e s
* w h i c h s e r v i c e a r e a l l o w e d .
* /
[ s e r v i c e s ]
d e s c r i p t i o n = L o c a l s e r v i c e c o n f i g u r a t i o n
a c t i v e S e r v i c e s = d p , n s s , p a m , i n f o
[ s e r v i c e s / d p ]
d e s c r i p t i o n = D a t a P r o v i d e r C o n f i g u r a t i o n
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ d p
[ s e r v i c e s / n s s ]
d e s c r i p t i o n = N S S R e s p o n d e r C o n f i g u r a t i o n
u n i x S o c k e t = / v a r / l i b / s s s / p i p e s / n s s
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ n s s
[ s e r v i c e s / p a m ]
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ p a m
d e s c r i p t i o n = P A M R e s p o n d e r C o n f i g u r a t i o n
u n i x S o c k e t = / v a r / l i b / s s s / p i p e s / p a m
[ s e r v i c e s / i n f o ]
d e s c r i p t i o n = I n f o P i p e C o n f i g u r a t i o n
c o m m a n d = . / s b i n / s s s d _ i n f o
[ d o m a i n s ]
d o m a i n s O r d e r = , L O C A L , , E X A M P L E . C O M , , S O M E O T H E R . C O M , ,
b a d a r r a y = , , , , ,
s o m e a r r a y = ,
s o m e o t h e r a r r a y = , ;
j u s t d e l i m = : ; , ;
y e t a n o t h e r =
[ d o m a i n s / L O C A L ]
d e s c r i p t i o n = R e s e r v e d d o m a i n f o r l o c a l c o n f i g u r a t i o n s
l e g a c y = F A L S E
e n u m e r a t e = 3
[ d o m a i n s / E X A M P L E . C O M ]
d e s c r i p t i o n = E x a m p l e d o m a i n s e r v e d b y I P A
p r o v i d e r = i p a
s e r v e r = i p a s e r v e r 1 . e x a m p l e . c o m
s e r v e r = i p a b a c k u p s e r v e r . e x a m p l e . c o m
l e g a c y = F A L S E
s e r v e r = o t h e r i p a b a c k u p s e r v e r . e x a m p l e . c o m
e n u m e r a t e = 0
b i n a r y _ t e s t = ' 0 1 0 2 0 3 '
b i n a r y _ t e s t _ t w o = ' 0 A 0 b 0 C '
l o n g _ a r r a y = 1 2 ; 4 ' ; 8 p . 1 6 / 3 2 ?
d o u b l e _ a r r a y = 1 . 1 2 . 2 2 2 2 2 2 ; . 4 ' . ; 8 p . 1 6 / - 3 2 ?
s e r v e r = y e t a n o t h e r i p a b a c k u p s e r v e r . e x a m p l e . c o m
e m p t y _ v a l u e =
s p a c e _ v a l u e = " "
i n t 3 2 _ t = - 1 0 0 0 0 0 0 0 0 0
u i n t 3 2 _ t = 3 0 0 0 0 0 0 0 0 0
i n t 6 4 _ t = - 1 0 0 0 0 0 0 0 0 0 1 2 3
u i n t 6 4 _ t = 3 0 0 0 0 0 0 0 0 0 1 2 3
ding-libs-0.6.2/ini/ini.d/real32be.conf 0000664 0000000 0000000 00000014660 14172606404 0017430 0 ustar 00root root 0000000 0000000 þÿ / / T h i s i s a r e a l f i l e w i t h s o m e c o m m e n t s
[ c o n f i g ]
v e r s i o n = 0 . 1
/ * * /
[ m o n i t o r ]
d e s c r i p t i o n = M o n i t o r C o n f i g u r a t i o n
s b u s T i m e o u t = 1 0
s b u s A d d r e s s = u n i x : p a t h = / v a r / l i b / s s s / p i p e s / p r i v a t e / d b u s
s e r v i c e P i n g T i m e = 1 0
b a d _ n u m b e r = 5 a
/ * S e r v i c e s e c t i o n d e f i n e s
* w h i c h s e r v i c e a r e a l l o w e d .
* /
[ s e r v i c e s ]
d e s c r i p t i o n = L o c a l s e r v i c e c o n f i g u r a t i o n
a c t i v e S e r v i c e s = d p , n s s , p a m , i n f o
[ s e r v i c e s / d p ]
d e s c r i p t i o n = D a t a P r o v i d e r C o n f i g u r a t i o n
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ d p
[ s e r v i c e s / n s s ]
d e s c r i p t i o n = N S S R e s p o n d e r C o n f i g u r a t i o n
u n i x S o c k e t = / v a r / l i b / s s s / p i p e s / n s s
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ n s s
[ s e r v i c e s / p a m ]
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ p a m
d e s c r i p t i o n = P A M R e s p o n d e r C o n f i g u r a t i o n
u n i x S o c k e t = / v a r / l i b / s s s / p i p e s / p a m
[ s e r v i c e s / i n f o ]
d e s c r i p t i o n = I n f o P i p e C o n f i g u r a t i o n
c o m m a n d = . / s b i n / s s s d _ i n f o
[ d o m a i n s ]
d o m a i n s O r d e r = , L O C A L , , E X A M P L E . C O M , , S O M E O T H E R . C O M , ,
b a d a r r a y = , , , , ,
s o m e a r r a y = ,
s o m e o t h e r a r r a y = , ;
j u s t d e l i m = : ; , ;
y e t a n o t h e r =
[ d o m a i n s / L O C A L ]
d e s c r i p t i o n = R e s e r v e d d o m a i n f o r l o c a l c o n f i g u r a t i o n s
l e g a c y = F A L S E
e n u m e r a t e = 3
[ d o m a i n s / E X A M P L E . C O M ]
d e s c r i p t i o n = E x a m p l e d o m a i n s e r v e d b y I P A
p r o v i d e r = i p a
s e r v e r = i p a s e r v e r 1 . e x a m p l e . c o m
s e r v e r = i p a b a c k u p s e r v e r . e x a m p l e . c o m
l e g a c y = F A L S E
s e r v e r = o t h e r i p a b a c k u p s e r v e r . e x a m p l e . c o m
e n u m e r a t e = 0
b i n a r y _ t e s t = ' 0 1 0 2 0 3 '
b i n a r y _ t e s t _ t w o = ' 0 A 0 b 0 C '
l o n g _ a r r a y = 1 2 ; 4 ' ; 8 p . 1 6 / 3 2 ?
d o u b l e _ a r r a y = 1 . 1 2 . 2 2 2 2 2 2 ; . 4 ' . ; 8 p . 1 6 / - 3 2 ?
s e r v e r = y e t a n o t h e r i p a b a c k u p s e r v e r . e x a m p l e . c o m
e m p t y _ v a l u e =
s p a c e _ v a l u e = " "
i n t 3 2 _ t = - 1 0 0 0 0 0 0 0 0 0
u i n t 3 2 _ t = 3 0 0 0 0 0 0 0 0 0
i n t 6 4 _ t = - 1 0 0 0 0 0 0 0 0 0 1 2 3
u i n t 6 4 _ t = 3 0 0 0 0 0 0 0 0 0 1 2 3
ding-libs-0.6.2/ini/ini.d/real32le.conf 0000664 0000000 0000000 00000014660 14172606404 0017442 0 ustar 00root root 0000000 0000000 ÿþ / / T h i s i s a r e a l f i l e w i t h s o m e c o m m e n t s
[ c o n f i g ]
v e r s i o n = 0 . 1
/ * * /
[ m o n i t o r ]
d e s c r i p t i o n = M o n i t o r C o n f i g u r a t i o n
s b u s T i m e o u t = 1 0
s b u s A d d r e s s = u n i x : p a t h = / v a r / l i b / s s s / p i p e s / p r i v a t e / d b u s
s e r v i c e P i n g T i m e = 1 0
b a d _ n u m b e r = 5 a
/ * S e r v i c e s e c t i o n d e f i n e s
* w h i c h s e r v i c e a r e a l l o w e d .
* /
[ s e r v i c e s ]
d e s c r i p t i o n = L o c a l s e r v i c e c o n f i g u r a t i o n
a c t i v e S e r v i c e s = d p , n s s , p a m , i n f o
[ s e r v i c e s / d p ]
d e s c r i p t i o n = D a t a P r o v i d e r C o n f i g u r a t i o n
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ d p
[ s e r v i c e s / n s s ]
d e s c r i p t i o n = N S S R e s p o n d e r C o n f i g u r a t i o n
u n i x S o c k e t = / v a r / l i b / s s s / p i p e s / n s s
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ n s s
[ s e r v i c e s / p a m ]
c o m m a n d = / u s r / l i b e x e c / s s s d / s s s d _ p a m
d e s c r i p t i o n = P A M R e s p o n d e r C o n f i g u r a t i o n
u n i x S o c k e t = / v a r / l i b / s s s / p i p e s / p a m
[ s e r v i c e s / i n f o ]
d e s c r i p t i o n = I n f o P i p e C o n f i g u r a t i o n
c o m m a n d = . / s b i n / s s s d _ i n f o
[ d o m a i n s ]
d o m a i n s O r d e r = , L O C A L , , E X A M P L E . C O M , , S O M E O T H E R . C O M , ,
b a d a r r a y = , , , , ,
s o m e a r r a y = ,
s o m e o t h e r a r r a y = , ;
j u s t d e l i m = : ; , ;
y e t a n o t h e r =
[ d o m a i n s / L O C A L ]
d e s c r i p t i o n = R e s e r v e d d o m a i n f o r l o c a l c o n f i g u r a t i o n s
l e g a c y = F A L S E
e n u m e r a t e = 3
[ d o m a i n s / E X A M P L E . C O M ]
d e s c r i p t i o n = E x a m p l e d o m a i n s e r v e d b y I P A
p r o v i d e r = i p a
s e r v e r = i p a s e r v e r 1 . e x a m p l e . c o m
s e r v e r = i p a b a c k u p s e r v e r . e x a m p l e . c o m
l e g a c y = F A L S E
s e r v e r = o t h e r i p a b a c k u p s e r v e r . e x a m p l e . c o m
e n u m e r a t e = 0
b i n a r y _ t e s t = ' 0 1 0 2 0 3 '
b i n a r y _ t e s t _ t w o = ' 0 A 0 b 0 C '
l o n g _ a r r a y = 1 2 ; 4 ' ; 8 p . 1 6 / 3 2 ?
d o u b l e _ a r r a y = 1 . 1 2 . 2 2 2 2 2 2 ; . 4 ' . ; 8 p . 1 6 / - 3 2 ?
s e r v e r = y e t a n o t h e r i p a b a c k u p s e r v e r . e x a m p l e . c o m
e m p t y _ v a l u e =
s p a c e _ v a l u e = " "
i n t 3 2 _ t = - 1 0 0 0 0 0 0 0 0 0
u i n t 3 2 _ t = 3 0 0 0 0 0 0 0 0 0
i n t 6 4 _ t = - 1 0 0 0 0 0 0 0 0 0 1 2 3
u i n t 6 4 _ t = 3 0 0 0 0 0 0 0 0 0 1 2 3
ding-libs-0.6.2/ini/ini.d/real8.conf 0000664 0000000 0000000 00000003156 14172606404 0017042 0 ustar 00root root 0000000 0000000 // This is a real file with some comments
[config]
version = 0.1
/**/
[monitor]
description = Monitor Configuration
sbusTimeout = 10
sbusAddress = unix:path=/var/lib/sss/pipes/private/dbus
servicePingTime = 10
bad_number = 5a
/* Service section defines
* which service are allowed.
*/
[services]
description = Local service configuration
activeServices = dp, nss, pam, info
[services/dp]
description = Data Provider Configuration
command = /usr/libexec/sssd/sssd_dp
[services/nss]
description = NSS Responder Configuration
unixSocket = /var/lib/sss/pipes/nss
command = /usr/libexec/sssd/sssd_nss
[services/pam]
command = /usr/libexec/sssd/sssd_pam
description = PAM Responder Configuration
unixSocket = /var/lib/sss/pipes/pam
[services/info]
description = InfoPipe Configuration
command = ./sbin/sssd_info
[domains]
domainsOrder = , LOCAL, , EXAMPLE.COM, , SOMEOTHER.COM , ,
badarray = , , , , ,
somearray = ,
someotherarray = , ;
justdelim=:;,;
yetanother =
[domains/LOCAL]
description = Reserved domain for local configurations
legacy = FALSE
enumerate = 3
[domains/EXAMPLE.COM]
description = Example domain served by IPA
provider = ipa
server = ipaserver1.example.com
server = ipabackupserver.example.com
legacy = FALSE
server = otheripabackupserver.example.com
enumerate = 0
binary_test = '010203'
binary_test_two = '0A0b0C'
long_array = 1 2; 4' ;8p .16/ 32?
double_array = 1.1 2.222222; .4' . ;8p .16/ -32?
server = yetanotheripabackupserver.example.com
empty_value =
space_value = " "
int32_t = -1000000000
uint32_t = 3000000000
int64_t = -1000000000123
uint64_t = 3000000000123
ding-libs-0.6.2/ini/ini.d/second.conf 0000664 0000000 0000000 00000001465 14172606404 0017303 0 ustar 00root root 0000000 0000000 [section_a]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
[section_b]
key1 = key1 single value
key1 = key1 first multi value
key1 = key1 second multi value
key2 = key2 single value
key2 = key2 first multi value
key2 = key2 second multi value
key3 = key3 single value
key3 = key3 first multi value
key3 = key3 second multi value
[section_d]
key1 = second file, key1 single value
key1 = second file, key1 first multi value
key1 = second file, key1 second multi value
key2 = second file, key2 single value
key2 = second file, key2 first multi value
key2 = second file, key2 second multi value
#END OF THE SECOND FILE
ding-libs-0.6.2/ini/ini.d/sexpect.conf 0000664 0000000 0000000 00000013757 14172606404 0017512 0 ustar 00root root 0000000 0000000 # Section mode: MERGE, value mode: OVERWRITE
[section1]
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: MERGE, value mode: ERROR
# Section mode: MERGE, value mode: PRESERVE
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
#End of file
# Section mode: MERGE, value mode: ALLOW
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: MERGE, value mode: DETECT
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: ERROR, value mode: OVERWRITE
# Section mode: ERROR, value mode: ERROR
# Section mode: ERROR, value mode: PRESERVE
# Section mode: ERROR, value mode: ALLOW
# Section mode: ERROR, value mode: DETECT
# Section mode: OVERWRITE, value mode: OVERWRITE
[section1]
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: OVERWRITE, value mode: ERROR
[section1]
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: OVERWRITE, value mode: PRESERVE
[section1]
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: OVERWRITE, value mode: ALLOW
[section1]
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: OVERWRITE, value mode: DETECT
[section1]
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: PRESERVE, value mode: OVERWRITE
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
#End of file
# Section mode: PRESERVE, value mode: ERROR
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
#End of file
# Section mode: PRESERVE, value mode: PRESERVE
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
#End of file
# Section mode: PRESERVE, value mode: ALLOW
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
#End of file
# Section mode: PRESERVE, value mode: DETECT
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
#End of file
# Section mode: DETECT, value mode: OVERWRITE
[section1]
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: DETECT, value mode: ERROR
# Section mode: DETECT, value mode: PRESERVE
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
#End of file
# Section mode: DETECT, value mode: ALLOW
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
# Section mode: DETECT, value mode: DETECT
[section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
ding-libs-0.6.2/ini/ini.d/smerge.conf 0000664 0000000 0000000 00000000711 14172606404 0017303 0 ustar 00root root 0000000 0000000 [section1]
# Key 1
key1 = section1a Value 1
# Key 2
key2 = section1a Value 2
# Key 3
key3 = section1a Value 3
[section2]
# Key 1
key1 = section2a Value 1
# Key 2
key2 = section2a Value 2
# Key 3
key3 = section2a Value 3
[section1]
# Key 1
key1 = section1b Value 1
# Key 2
key2 = section1b Value 2
# Key 3
key3 = section1b Value 3
[section2]
# Key 1
key1 = section2b Value 1
# Key 2
key2 = section2b Value 2
# Key 3
key3 = section2b Value 3
#End of file
ding-libs-0.6.2/ini/ini.d/space.conf 0000664 0000000 0000000 00000000132 14172606404 0017111 0 ustar 00root root 0000000 0000000 spaces = value
tab = value
tab_and_space = value
space_and_tab = value
ding-libs-0.6.2/ini/ini.d/symbols.conf 0000664 0000000 0000000 00005622172 14172606404 0017531 0 ustar 00root root 0000000 0000000 ÿþ; = = + + = =
;
; C o p y r i g h t ( c ) M i c r o s o f t C o r p o r a t i o n . A l l r i g h t s r e s e r v e d .
;
; = = - - = =
/ / - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/ / W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G
/ /
/ / A U T O G E N E R A T E D F I L E . D O N O T E D I T . U S E $ / c o m 9 9 / s r c / p r o f i l e / p e r f m o n h e l p
/ /
/ / W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G W A R N I N G
/ / - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/ / C O R P e r f M o n S y m b o l s . i n i f i l e
[ i n f o ]
d r i v e r n a m e = . N E T F r a m e w o r k
s y m b o l f i l e = C O R P e r f M o n S y m b o l s . h
[ l a n g u a g e s ]
0 0 9 = E n g l i s h
0 0 1 = A r a b i c
8 0 4 = C h i n e s e ( P R C )
4 0 4 = C h i n e s e ( T a i w a n )
0 0 5 = C z e c h
0 0 6 = D a n i s h
0 0 7 = G e r m a n
0 0 8 = G r e e k
0 0 A = S p a n i s h
0 0 B = F i n n i s h
0 0 C = F r e n c h
0 0 D = H e b r e w
0 0 E = H u n g a r i a n
0 1 0 = I t a l i a n
0 1 1 = J a p a n e s e
0 1 2 = K o r e a n
0 1 3 = D u t c h
0 1 4 = N o r w e g i a n
0 1 5 = P o l i s h
4 1 6 = P o r t u g u e s e ( B r a z i l )
8 1 6 = P o r t u g u e s e ( P o r t u g a l )
0 1 9 = R u s s i a n
0 1 D = S w e d i s h
0 1 F = T u r k i s h
[ t e x t ]
D o t N e t C L R _ M e m o r y _ O B J E C T _ 0 0 9 _ N A M E = . N E T C L R M e m o r y
D o t N e t C L R _ M e m o r y _ O B J E C T _ 0 0 9 _ H E L P = C o u n t e r s f o r C L R G a r b a g e C o l l e c t e d h e a p .
G E N 0 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 9 _ N A M E = # G e n 0 C o l l e c t i o n s
G E N 0 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f t i m e s t h e g e n e r a t i o n 0 o b j e c t s ( y o u n g e s t ; m o s t r e c e n t l y a l l o c a t e d ) a r e g a r b a g e c o l l e c t e d ( G e n 0 G C ) s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . G e n 0 G C o c c u r s w h e n t h e a v a i l a b l e m e m o r y i n g e n e r a t i o n 0 i s n o t s u f f i c i e n t t o s a t i s f y a n a l l o c a t i o n r e q u e s t . T h i s c o u n t e r i s i n c r e m e n t e d a t t h e e n d o f a G e n 0 G C . H i g h e r g e n e r a t i o n G C s i n c l u d e a l l l o w e r g e n e r a t i o n G C s . T h i s c o u n t e r i s e x p l i c i t l y i n c r e m e n t e d w h e n a h i g h e r g e n e r a t i o n ( G e n 1 o r G e n 2 ) G C o c c u r s . _ G l o b a l _ c o u n t e r v a l u e i s n o t a c c u r a t e a n d s h o u l d b e i g n o r e d . T h i s c o u n t e r d i s p l a y s t h e l a s t o b s e r v e d v a l u e .
G E N 1 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 9 _ N A M E = # G e n 1 C o l l e c t i o n s
G E N 1 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f t i m e s t h e g e n e r a t i o n 1 o b j e c t s a r e g a r b a g e c o l l e c t e d s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h e c o u n t e r i s i n c r e m e n t e d a t t h e e n d o f a G e n 1 G C . H i g h e r g e n e r a t i o n G C s i n c l u d e a l l l o w e r g e n e r a t i o n G C s . T h i s c o u n t e r i s e x p l i c i t l y i n c r e m e n t e d w h e n a h i g h e r g e n e r a t i o n ( G e n 2 ) G C o c c u r s . _ G l o b a l _ c o u n t e r v a l u e i s n o t a c c u r a t e a n d s h o u l d b e i g n o r e d . T h i s c o u n t e r d i s p l a y s t h e l a s t o b s e r v e d v a l u e .
G E N 2 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 9 _ N A M E = # G e n 2 C o l l e c t i o n s
G E N 2 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f t i m e s t h e g e n e r a t i o n 2 o b j e c t s ( o l d e r ) a r e g a r b a g e c o l l e c t e d s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h e c o u n t e r i s i n c r e m e n t e d a t t h e e n d o f a G e n 2 G C ( a l s o c a l l e d f u l l G C ) . _ G l o b a l _ c o u n t e r v a l u e i s n o t a c c u r a t e a n d s h o u l d b e i g n o r e d . T h i s c o u n t e r d i s p l a y s t h e l a s t o b s e r v e d v a l u e .
G E N 0 _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 9 _ N A M E = P r o m o t e d M e m o r y f r o m G e n 0
G E N 0 _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e b y t e s o f m e m o r y t h a t s u r v i v e g a r b a g e c o l l e c t i o n ( G C ) a n d a r e p r o m o t e d f r o m g e n e r a t i o n 0 t o g e n e r a t i o n 1 ; o b j e c t s t h a t a r e p r o m o t e d j u s t b e c a u s e t h e y a r e w a i t i n g t o b e f i n a l i z e d a r e n o t i n c l u d e d i n t h i s c o u n t e r . T h i s c o u n t e r d i s p l a y s t h e v a l u e o b s e r v e d a t t h e e n d o f t h e l a s t G C ; i t s n o t a c u m u l a t i v e c o u n t e r .
G E N 1 _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 9 _ N A M E = P r o m o t e d M e m o r y f r o m G e n 1
G E N 1 _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e b y t e s o f m e m o r y t h a t s u r v i v e g a r b a g e c o l l e c t i o n ( G C ) a n d a r e p r o m o t e d f r o m g e n e r a t i o n 1 t o g e n e r a t i o n 2 ; o b j e c t s t h a t a r e p r o m o t e d j u s t b e c a u s e t h e y a r e w a i t i n g t o b e f i n a l i z e d a r e n o t i n c l u d e d i n t h i s c o u n t e r . T h i s c o u n t e r d i s p l a y s t h e v a l u e o b s e r v e d a t t h e e n d o f t h e l a s t G C ; i t s n o t a c u m u l a t i v e c o u n t e r . T h i s c o u n t e r i s r e s e t t o 0 i f t h e l a s t G C w a s a G e n 0 G C o n l y .
G E N 0 _ P R O M O T I O N _ R A T E _ 0 0 9 _ N A M E = G e n 0 P r o m o t e d B y t e s / S e c
G E N 0 _ P R O M O T I O N _ R A T E _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e b y t e s p e r s e c o n d t h a t a r e p r o m o t e d f r o m g e n e r a t i o n 0 ( y o u n g e s t ) t o g e n e r a t i o n 1 ; o b j e c t s t h a t a r e p r o m o t e d j u s t b e c a u s e t h e y a r e w a i t i n g t o b e f i n a l i z e d a r e n o t i n c l u d e d i n t h i s c o u n t e r . M e m o r y i s p r o m o t e d w h e n i t s u r v i v e s a g a r b a g e c o l l e c t i o n . T h i s c o u n t e r w a s d e s i g n e d a s a n i n d i c a t o r o f r e l a t i v e l y l o n g - l i v e d o b j e c t s b e i n g c r e a t e d p e r s e c . T h i s c o u n t e r d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
G E N 1 _ P R O M O T I O N _ R A T E _ 0 0 9 _ N A M E = G e n 1 P r o m o t e d B y t e s / S e c
G E N 1 _ P R O M O T I O N _ R A T E _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e b y t e s p e r s e c o n d t h a t a r e p r o m o t e d f r o m g e n e r a t i o n 1 t o g e n e r a t i o n 2 ( o l d e s t ) ; o b j e c t s t h a t a r e p r o m o t e d j u s t b e c a u s e t h e y a r e w a i t i n g t o b e f i n a l i z e d a r e n o t i n c l u d e d i n t h i s c o u n t e r . M e m o r y i s p r o m o t e d w h e n i t s u r v i v e s a g a r b a g e c o l l e c t i o n . N o t h i n g i s p r o m o t e d f r o m g e n e r a t i o n 2 s i n c e i t i s t h e o l d e s t . T h i s c o u n t e r w a s d e s i g n e d a s a n i n d i c a t o r o f v e r y l o n g - l i v e d o b j e c t s b e i n g c r e a t e d p e r s e c . T h i s c o u n t e r d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
G E N 0 _ F I N A L I Z A T I O N _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 9 _ N A M E = P r o m o t e d F i n a l i z a t i o n - M e m o r y f r o m G e n 0
G E N 0 _ F I N A L I Z A T I O N _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e b y t e s o f m e m o r y t h a t a r e p r o m o t e d f r o m g e n e r a t i o n 0 t o g e n e r a t i o n 1 j u s t b e c a u s e t h e y a r e w a i t i n g t o b e f i n a l i z e d . T h i s c o u n t e r d i s p l a y s t h e v a l u e o b s e r v e d a t t h e e n d o f t h e l a s t G C ; i t s n o t a c u m u l a t i v e c o u n t e r .
P R O C E S S _ I D _ 0 0 9 _ N A M E = P r o c e s s I D
P R O C E S S _ I D _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e p r o c e s s I D o f t h e C L R p r o c e s s i n s t a n c e b e i n g m o n i t o r e d . T h e v a l u e d i s p l a y e d w i l l b e 0 u n t i l a f t e r t h e f i r s t g a r b a g e c o l l e c t i o n .
G E N 0 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 9 _ N A M E = G e n 0 h e a p s i z e
G E N 0 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e m a x i m u m b y t e s t h a t c a n b e a l l o c a t e d i n g e n e r a t i o n 0 ( G e n 0 ) ; i t s d o e s n o t i n d i c a t e t h e c u r r e n t n u m b e r o f b y t e s a l l o c a t e d i n G e n 0 . A G e n 0 G C i s t r i g g e r e d w h e n t h e a l l o c a t i o n s s i n c e t h e l a s t G C e x c e e d t h i s s i z e . T h e G e n 0 s i z e i s t u n e d b y t h e G a r b a g e C o l l e c t o r a n d c a n c h a n g e d u r i n g t h e e x e c u t i o n o f t h e a p p l i c a t i o n . A t t h e e n d o f a G e n 0 c o l l e c t i o n t h e s i z e o f t h e G e n 0 h e a p i s i n f a c t 0 b y t e s ; t h i s c o u n t e r d i s p l a y s t h e s i z e ( i n b y t e s ) o f a l l o c a t i o n s t h a t w o u l d t r i g g e r t h e n e x t G e n 0 G C . T h i s c o u n t e r i s u p d a t e d a t t h e e n d o f a G C ; i t s n o t u p d a t e d o n e v e r y a l l o c a t i o n .
G E N 1 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 9 _ N A M E = G e n 1 h e a p s i z e
G E N 1 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f b y t e s i n g e n e r a t i o n 1 ( G e n 1 ) ; t h i s c o u n t e r d o e s n o t d i s p l a y t h e m a x i m u m s i z e o f G e n 1 . O b j e c t s a r e n o t d i r e c t l y a l l o c a t e d i n t h i s g e n e r a t i o n ; t h e y a r e p r o m o t e d f r o m p r e v i o u s G e n 0 G C s . T h i s c o u n t e r i s u p d a t e d a t t h e e n d o f a G C ; i t s n o t u p d a t e d o n e v e r y a l l o c a t i o n .
G E N 2 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 9 _ N A M E = G e n 2 h e a p s i z e
G E N 2 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f b y t e s i n g e n e r a t i o n 2 ( G e n 2 ) . O b j e c t s a r e n o t d i r e c t l y a l l o c a t e d i n t h i s g e n e r a t i o n ; t h e y a r e p r o m o t e d f r o m G e n 1 d u r i n g p r e v i o u s G e n 1 G C s . T h i s c o u n t e r i s u p d a t e d a t t h e e n d o f a G C ; i t s n o t u p d a t e d o n e v e r y a l l o c a t i o n .
L A R G E _ O B J E C T _ S I Z E _ C O U N T E R _ 0 0 9 _ N A M E = L a r g e O b j e c t H e a p s i z e
L A R G E _ O B J E C T _ S I Z E _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t s i z e o f t h e L a r g e O b j e c t H e a p i n b y t e s . O b j e c t s g r e a t e r t h a n a t h r e s h o l d a r e t r e a t e d a s l a r g e o b j e c t s b y t h e G a r b a g e C o l l e c t o r a n d a r e d i r e c t l y a l l o c a t e d i n a s p e c i a l h e a p ; t h e y a r e n o t p r o m o t e d t h r o u g h t h e g e n e r a t i o n s . I n C L R v 1 . 1 a n d a b o v e t h i s t h r e s h o l d i s e q u a l t o 8 5 0 0 0 b y t e s . T h i s c o u n t e r i s u p d a t e d a t t h e e n d o f a G C ; i t s n o t u p d a t e d o n e v e r y a l l o c a t i o n .
S U R V I V E _ F I N A L I Z E _ C O U N T E R _ 0 0 9 _ N A M E = F i n a l i z a t i o n S u r v i v o r s
S U R V I V E _ F I N A L I Z E _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f g a r b a g e c o l l e c t e d o b j e c t s t h a t s u r v i v e a c o l l e c t i o n b e c a u s e t h e y a r e w a i t i n g t o b e f i n a l i z e d . I f t h e s e o b j e c t s h o l d r e f e r e n c e s t o o t h e r o b j e c t s t h e n t h o s e o b j e c t s a l s o s u r v i v e b u t a r e n o t c o u n t e d b y t h i s c o u n t e r ; t h e " P r o m o t e d F i n a l i z a t i o n - M e m o r y f r o m G e n 0 " a n d " P r o m o t e d F i n a l i z a t i o n - M e m o r y f r o m G e n 1 " c o u n t e r s r e p r e s e n t a l l t h e m e m o r y t h a t s u r v i v e d d u e t o f i n a l i z a t i o n . T h i s c o u n t e r i s n o t a c u m u l a t i v e c o u n t e r ; i t s u p d a t e d a t t h e e n d o f e v e r y G C w i t h c o u n t o f t h e s u r v i v o r s d u r i n g t h a t p a r t i c u l a r G C o n l y . T h i s c o u n t e r w a s d e s i g n e d t o i n d i c a t e t h e e x t r a o v e r h e a d t h a t t h e a p p l i c a t i o n m i g h t i n c u r b e c a u s e o f f i n a l i z a t i o n .
N U M _ H A N D L E S _ C O U N T E R _ 0 0 9 _ N A M E = # G C H a n d l e s
N U M _ H A N D L E S _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f G C H a n d l e s i n u s e . G C H a n d l e s a r e h a n d l e s t o r e s o u r c e s e x t e r n a l t o t h e C L R a n d t h e m a n a g e d e n v i r o n m e n t . H a n d l e s o c c u p y s m a l l a m o u n t s o f m e m o r y i n t h e G C H e a p b u t p o t e n t i a l l y e x p e n s i v e u n m a n a g e d r e s o u r c e s .
A L L O C A T I O N _ R A T E _ C O U N T E R _ 0 0 9 _ N A M E = A l l o c a t e d B y t e s / s e c
A L L O C A T I O N _ R A T E _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e r a t e o f b y t e s p e r s e c o n d a l l o c a t e d o n t h e G C H e a p . T h i s c o u n t e r i s u p d a t e d a t t h e e n d o f e v e r y G C ; n o t a t e a c h a l l o c a t i o n . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
I N D U C E D _ G C _ C O U N T E R _ 0 0 9 _ N A M E = # I n d u c e d G C
I N D U C E D _ G C _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e p e a k n u m b e r o f t i m e s a g a r b a g e c o l l e c t i o n w a s p e r f o r m e d b e c a u s e o f a n e x p l i c i t c a l l t o G C . C o l l e c t . I t s a g o o d p r a c t i c e t o l e t t h e G C t u n e t h e f r e q u e n c y o f i t s c o l l e c t i o n s .
P E R _ T I M E _ I N _ G C _ C O U N T E R _ 0 0 9 _ N A M E = % T i m e i n G C
P E R _ T I M E _ I N _ G C _ C O U N T E R _ 0 0 9 _ H E L P = % T i m e i n G C i s t h e p e r c e n t a g e o f e l a p s e d t i m e t h a t w a s s p e n t i n p e r f o r m i n g a g a r b a g e c o l l e c t i o n ( G C ) s i n c e t h e l a s t G C c y c l e . T h i s c o u n t e r i s u s u a l l y a n i n d i c a t o r o f t h e w o r k d o n e b y t h e G a r b a g e C o l l e c t o r o n b e h a l f o f t h e a p p l i c a t i o n t o c o l l e c t a n d c o m p a c t m e m o r y . T h i s c o u n t e r i s u p d a t e d o n l y a t t h e e n d o f e v e r y G C a n d t h e c o u n t e r v a l u e r e f l e c t s t h e l a s t o b s e r v e d v a l u e ; i t s n o t a n a v e r a g e .
P E R _ T I M E _ I N _ G C _ C O U N T E R _ B A S E _ 0 0 9 _ N A M E = N o t D i s p l a y e d
P E R _ T I M E _ I N _ G C _ C O U N T E R _ B A S E _ 0 0 9 _ H E L P = N o t D i s p l a y e d .
T O T A L _ H E A P _ S I Z E _ C O U N T E R _ 0 0 9 _ N A M E = # B y t e s i n a l l H e a p s
T O T A L _ H E A P _ S I Z E _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r i s t h e s u m o f f o u r o t h e r c o u n t e r s ; G e n 0 H e a p S i z e ; G e n 1 H e a p S i z e ; G e n 2 H e a p S i z e a n d t h e L a r g e O b j e c t H e a p S i z e . T h i s c o u n t e r i n d i c a t e s t h e c u r r e n t m e m o r y a l l o c a t e d i n b y t e s o n t h e G C H e a p s .
T O T A L _ C O M M I T T E D _ M E M _ C O U N T E R _ 0 0 9 _ N A M E = # T o t a l c o m m i t t e d B y t e s
T O T A L _ C O M M I T T E D _ M E M _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e a m o u n t o f v i r t u a l m e m o r y ( i n b y t e s ) c u r r e n t l y c o m m i t t e d b y t h e G a r b a g e C o l l e c t o r . ( C o m m i t t e d m e m o r y i s t h e p h y s i c a l m e m o r y f o r w h i c h s p a c e h a s b e e n r e s e r v e d o n t h e d i s k p a g i n g f i l e ) .
T O T A L _ R E S E R V E D _ M E M _ C O U N T E R _ 0 0 9 _ N A M E = # T o t a l r e s e r v e d B y t e s
T O T A L _ R E S E R V E D _ M E M _ C O U N T E R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e a m o u n t o f v i r t u a l m e m o r y ( i n b y t e s ) c u r r e n t l y r e s e r v e d b y t h e G a r b a g e C o l l e c t o r . ( R e s e r v e d m e m o r y i s t h e v i r t u a l m e m o r y s p a c e r e s e r v e d f o r t h e a p p l i c a t i o n b u t n o d i s k o r m a i n m e m o r y p a g e s h a v e b e e n u s e d . )
G C _ P I N N E D _ O B J E C T S _ 0 0 9 _ N A M E = # o f P i n n e d O b j e c t s
G C _ P I N N E D _ O B J E C T S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f p i n n e d o b j e c t s e n c o u n t e r e d i n t h e l a s t G C . T h i s c o u n t e r t r a c k s t h e p i n n e d o b j e c t s o n l y i n t h e h e a p s t h a t w e r e g a r b a g e c o l l e c t e d e . g . a G e n 0 G C w o u l d c a u s e e n u m e r a t i o n o f p i n n e d o b j e c t s i n t h e g e n e r a t i o n 0 h e a p o n l y . A p i n n e d o b j e c t i s o n e t h a t t h e G a r b a g e C o l l e c t o r c a n n o t m o v e i n m e m o r y .
G C _ S I N K B L O C K S _ 0 0 9 _ N A M E = # o f S i n k B l o c k s i n u s e
G C _ S I N K B L O C K S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f s y n c b l o c k s i n u s e . S y n c b l o c k s a r e p e r - o b j e c t d a t a s t r u c t u r e s a l l o c a t e d f o r s t o r i n g s y n c h r o n i z a t i o n i n f o r m a t i o n . S y n c b l o c k s h o l d w e a k r e f e r e n c e s t o m a n a g e d o b j e c t s a n d n e e d t o b e s c a n n e d b y t h e G a r b a g e C o l l e c t o r . S y n c b l o c k s a r e n o t l i m i t e d t o s t o r i n g s y n c h r o n i z a t i o n i n f o r m a t i o n a n d c a n a l s o s t o r e C O M i n t e r o p m e t a d a t a . T h i s c o u n t e r w a s d e s i g n e d t o i n d i c a t e p e r f o r m a n c e p r o b l e m s w i t h h e a v y u s e o f s y n c h r o n i z a t i o n p r i m i t i v e s .
D o t N e t C L R _ L o a d i n g _ O B J E C T _ 0 0 9 _ N A M E = . N E T C L R L o a d i n g
D o t N e t C L R _ L o a d i n g _ O B J E C T _ 0 0 9 _ H E L P = S t a t i s t i c s f o r C L R C l a s s L o a d e r .
L O A D I N G _ C L A S S E S _ T O T A L _ 0 0 9 _ N A M E = T o t a l C l a s s e s L o a d e d
L O A D I N G _ C L A S S E S _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u m u l a t i v e n u m b e r o f c l a s s e s l o a d e d i n a l l A s s e m b l i e s s i n c e t h e s t a r t o f t h i s a p p l i c a t i o n .
L O A D I N G _ T I M E _ 0 0 9 _ N A M E = % T i m e L o a d i n g
L O A D I N G _ T I M E _ 0 0 9 _ H E L P = R e s e r v e d f o r f u t u r e u s e .
L O A D I N G _ A S M S E A R C H L E N _ 0 0 9 _ N A M E = A s s e m b l y S e a r c h L e n g t h
L O A D I N G _ A S M S E A R C H L E N _ 0 0 9 _ H E L P = R e s e r v e d f o r f u t u r e u s e .
L O A D I N G _ L O A D F A I L U R E S _ T O T A L _ 0 0 9 _ N A M E = T o t a l # o f L o a d F a i l u r e s
L O A D I N G _ L O A D F A I L U R E S _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e p e a k n u m b e r o f c l a s s e s t h a t h a v e f a i l e d t o l o a d s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h e s e l o a d f a i l u r e s c o u l d b e d u e t o m a n y r e a s o n s l i k e i n a d e q u a t e s e c u r i t y o r i l l e g a l f o r m a t . F u l l d e t a i l s c a n b e f o u n d i n t h e p r o f i l i n g s e r v i c e s h e l p .
L O A D I N G _ L O A D F A I L U R E S _ I N S T _ 0 0 9 _ N A M E = R a t e o f L o a d F a i l u r e s
L O A D I N G _ L O A D F A I L U R E S _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f c l a s s e s t h a t f a i l e d t o l o a d p e r s e c o n d . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l . T h e s e l o a d f a i l u r e s c o u l d b e d u e t o m a n y r e a s o n s l i k e i n a d e q u a t e s e c u r i t y o r i l l e g a l f o r m a t . F u l l d e t a i l s c a n b e f o u n d i n t h e p r o f i l i n g s e r v i c e s h e l p .
L O A D I N G _ H E A P S I Z E _ 0 0 9 _ N A M E = B y t e s i n L o a d e r H e a p
L O A D I N G _ H E A P S I Z E _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t s i z e ( i n b y t e s ) o f t h e m e m o r y c o m m i t t e d b y t h e c l a s s l o a d e r a c r o s s a l l A p p D o m a i n s . ( C o m m i t t e d m e m o r y i s t h e p h y s i c a l m e m o r y f o r w h i c h s p a c e h a s b e e n r e s e r v e d o n t h e d i s k p a g i n g f i l e . )
L O A D I N G _ A P P D O M A I N S _ U N L O A D E D _ T O T A L _ 0 0 9 _ N A M E = T o t a l a p p d o m a i n s u n l o a d e d
L O A D I N G _ A P P D O M A I N S _ U N L O A D E D _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f A p p D o m a i n s u n l o a d e d s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . I f a n A p p D o m a i n i s l o a d e d a n d u n l o a d e d m u l t i p l e t i m e s t h i s c o u n t e r w o u l d c o u n t e a c h o f t h o s e u n l o a d s a s s e p a r a t e .
L O A D I N G _ A P P D O M A I N S _ U N L O A D E D _ I N S T _ 0 0 9 _ N A M E = R a t e o f a p p d o m a i n s u n l o a d e d
L O A D I N G _ A P P D O M A I N S _ U N L O A D E D _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f A p p D o m a i n s u n l o a d e d p e r s e c o n d . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
L O A D I N G _ C L A S S E S _ C U R _ 0 0 9 _ N A M E = C u r r e n t C l a s s e s L o a d e d
L O A D I N G _ C L A S S E S _ C U R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f c l a s s e s l o a d e d i n a l l A s s e m b l i e s .
L O A D I N G _ C L A S S E S _ I N S T _ 0 0 9 _ N A M E = R a t e o f C l a s s e s L o a d e d
L O A D I N G _ C L A S S E S _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f c l a s s e s l o a d e d p e r s e c o n d i n a l l A s s e m b l i e s . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
L O A D I N G _ A P P D O M A I N S _ C U R _ 0 0 9 _ N A M E = C u r r e n t a p p d o m a i n s
L O A D I N G _ A P P D O M A I N S _ C U R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f A p p D o m a i n s l o a d e d i n t h i s a p p l i c a t i o n . A p p D o m a i n s ( a p p l i c a t i o n d o m a i n s ) p r o v i d e a s e c u r e a n d v e r s a t i l e u n i t o f p r o c e s s i n g t h a t t h e C L R c a n u s e t o p r o v i d e i s o l a t i o n b e t w e e n a p p l i c a t i o n s r u n n i n g i n t h e s a m e p r o c e s s .
L O A D I N G _ A P P D O M A I N S _ T O T A L _ 0 0 9 _ N A M E = T o t a l A p p d o m a i n s
L O A D I N G _ A P P D O M A I N S _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e p e a k n u m b e r o f A p p D o m a i n s l o a d e d s i n c e t h e s t a r t o f t h i s a p p l i c a t i o n . A p p D o m a i n s ( a p p l i c a t i o n d o m a i n s ) p r o v i d e a s e c u r e a n d v e r s a t i l e u n i t o f p r o c e s s i n g t h a t t h e C L R c a n u s e t o p r o v i d e i s o l a t i o n b e t w e e n a p p l i c a t i o n s r u n n i n g i n t h e s a m e p r o c e s s .
L O A D I N G _ A P P D O M A I N S _ I N S T _ 0 0 9 _ N A M E = R a t e o f a p p d o m a i n s
L O A D I N G _ A P P D O M A I N S _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f A p p D o m a i n s l o a d e d p e r s e c o n d . A p p D o m a i n s ( a p p l i c a t i o n d o m a i n s ) p r o v i d e a s e c u r e a n d v e r s a t i l e u n i t o f p r o c e s s i n g t h a t t h e C L R c a n u s e t o p r o v i d e i s o l a t i o n b e t w e e n a p p l i c a t i o n s r u n n i n g i n t h e s a m e p r o c e s s . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
L O A D I N G _ A S S E M B L I E S _ C U R _ 0 0 9 _ N A M E = C u r r e n t A s s e m b l i e s
L O A D I N G _ A S S E M B L I E S _ C U R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f A s s e m b l i e s l o a d e d a c r o s s a l l A p p D o m a i n s i n t h i s a p p l i c a t i o n . I f t h e A s s e m b l y i s l o a d e d a s d o m a i n - n e u t r a l f r o m m u l t i p l e A p p D o m a i n s t h e n t h i s c o u n t e r i s i n c r e m e n t e d o n c e o n l y . A s s e m b l i e s c a n b e l o a d e d a s d o m a i n - n e u t r a l w h e n t h e i r c o d e c a n b e s h a r e d b y a l l A p p D o m a i n s o r t h e y c a n b e l o a d e d a s d o m a i n - s p e c i f i c w h e n t h e i r c o d e i s p r i v a t e t o t h e A p p D o m a i n .
L O A D I N G _ A S S E M B L I E S _ T O T A L _ 0 0 9 _ N A M E = T o t a l A s s e m b l i e s
L O A D I N G _ A S S E M B L I E S _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f A s s e m b l i e s l o a d e d s i n c e t h e s t a r t o f t h i s a p p l i c a t i o n . I f t h e A s s e m b l y i s l o a d e d a s d o m a i n - n e u t r a l f r o m m u l t i p l e A p p D o m a i n s t h e n t h i s c o u n t e r i s i n c r e m e n t e d o n c e o n l y . A s s e m b l i e s c a n b e l o a d e d a s d o m a i n - n e u t r a l w h e n t h e i r c o d e c a n b e s h a r e d b y a l l A p p D o m a i n s o r t h e y c a n b e l o a d e d a s d o m a i n - s p e c i f i c w h e n t h e i r c o d e i s p r i v a t e t o t h e A p p D o m a i n .
L O A D I N G _ A S S E M B L I E S _ I N S T _ 0 0 9 _ N A M E = R a t e o f A s s e m b l i e s
L O A D I N G _ A S S E M B L I E S _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f A s s e m b l i e s l o a d e d a c r o s s a l l A p p D o m a i n s p e r s e c o n d . I f t h e A s s e m b l y i s l o a d e d a s d o m a i n - n e u t r a l f r o m m u l t i p l e A p p D o m a i n s t h e n t h i s c o u n t e r i s i n c r e m e n t e d o n c e o n l y . A s s e m b l i e s c a n b e l o a d e d a s d o m a i n - n e u t r a l w h e n t h e i r c o d e c a n b e s h a r e d b y a l l A p p D o m a i n s o r t h e y c a n b e l o a d e d a s d o m a i n - s p e c i f i c w h e n t h e i r c o d e i s p r i v a t e t o t h e A p p D o m a i n . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
D o t N e t C L R _ J i t _ O B J E C T _ 0 0 9 _ N A M E = . N E T C L R J i t
D o t N e t C L R _ J i t _ O B J E C T _ 0 0 9 _ H E L P = S t a t s f o r C L R J i t .
T O T A L _ M E T H O D S _ J I T T E D _ 0 0 9 _ N A M E = # o f M e t h o d s J i t t e d
T O T A L _ M E T H O D S _ J I T T E D _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f m e t h o d s c o m p i l e d J u s t - I n - T i m e ( J I T ) b y t h e C L R J I T c o m p i l e r s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h i s c o u n t e r d o e s n o t i n c l u d e t h e p r e - j i t t e d m e t h o d s .
J I T T E D _ I L _ C U R _ 0 0 9 _ N A M E = # o f I L B y t e s J i t t e d
J I T T E D _ I L _ C U R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l I L b y t e s j i t t e d s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h i s c o u n t e r i s e x a c t l y e q u i v a l e n t t o t h e " T o t a l # o f I L B y t e s J i t t e d " c o u n t e r .
J I T T E D _ I L _ T O T A L _ 0 0 9 _ N A M E = T o t a l # o f I L B y t e s J i t t e d
J I T T E D _ I L _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l I L b y t e s j i t t e d s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h i s c o u n t e r i s e x a c t l y e q u i v a l e n t t o t h e " # o f I L B y t e s J i t t e d " c o u n t e r .
J I T T E D _ I L _ I N S T _ 0 0 9 _ N A M E = I L B y t e s J i t t e d / s e c
J I T T E D _ I L _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e r a t e a t w h i c h I L b y t e s a r e j i t t e d p e r s e c o n d . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
J I T _ F A I L U R E S _ 0 0 9 _ N A M E = S t a n d a r d J i t F a i l u r e s
J I T _ F A I L U R E S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e p e a k n u m b e r o f m e t h o d s t h e J I T c o m p i l e r h a s f a i l e d t o J I T s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h i s f a i l u r e c a n o c c u r i f t h e I L c a n n o t b e v e r i f i e d o r i f t h e r e w a s a n i n t e r n a l e r r o r i n t h e J I T c o m p i l e r .
T I M E _ I N _ J I T _ 0 0 9 _ N A M E = % T i m e i n J i t
T I M E _ I N _ J I T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e p e r c e n t a g e o f e l a p s e d t i m e s p e n t i n J I T c o m p i l a t i o n s i n c e t h e l a s t J I T c o m p i l a t i o n p h a s e . T h i s c o u n t e r i s u p d a t e d a t t h e e n d o f e v e r y J I T c o m p i l a t i o n p h a s e . A J I T c o m p i l a t i o n p h a s e i s t h e p h a s e w h e n a m e t h o d a n d i t s d e p e n d e n c i e s a r e b e i n g c o m p i l e d .
T I M E _ I N _ J I T _ B A S E _ 0 0 9 _ N A M E = N o t D i s p l a y e d
T I M E _ I N _ J I T _ B A S E _ 0 0 9 _ H E L P = N o t D i s p l a y e d .
D o t N e t C L R _ I n t e r o p _ O B J E C T _ 0 0 9 _ N A M E = . N E T C L R I n t e r o p
D o t N e t C L R _ I n t e r o p _ O B J E C T _ 0 0 9 _ H E L P = S t a t s f o r C L R i n t e r o p .
C U R R E N T _ C C W _ 0 0 9 _ N A M E = # o f C C W s
C U R R E N T _ C C W _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f C o m - C a l l a b l e - W r a p p e r s ( C C W s ) . A C C W i s a p r o x y f o r t h e . N E T m a n a g e d o b j e c t b e i n g r e f e r e n c e d f r o m u n m a n a g e d C O M c l i e n t ( s ) . T h i s c o u n t e r w a s d e s i g n e d t o i n d i c a t e t h e n u m b e r o f m a n a g e d o b j e c t s b e i n g r e f e r e n c e d b y u n m a n a g e d C O M c o d e .
C U R R E N T _ S T U B S _ 0 0 9 _ N A M E = # o f S t u b s
C U R R E N T _ S T U B S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f s t u b s c r e a t e d b y t h e C L R . S t u b s a r e r e s p o n s i b l e f o r m a r s h a l l i n g a r g u m e n t s a n d r e t u r n v a l u e s f r o m m a n a g e d t o u n m a n a g e d c o d e a n d v i c e v e r s a ; d u r i n g a C O M I n t e r o p c a l l o r P I n v o k e c a l l .
N U M _ M A R S H A L L I N G _ 0 0 9 _ N A M E = # o f m a r s h a l l i n g
N U M _ M A R S H A L L I N G _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f t i m e s a r g u m e n t s a n d r e t u r n v a l u e s h a v e b e e n m a r s h a l e d f r o m m a n a g e d t o u n m a n a g e d c o d e a n d v i c e v e r s a s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h i s c o u n t e r i s n o t i n c r e m e n t e d i f t h e s t u b s a r e i n l i n e d . ( S t u b s a r e r e s p o n s i b l e f o r m a r s h a l l i n g a r g u m e n t s a n d r e t u r n v a l u e s ) . S t u b s u s u a l l y g e t i n l i n e d i f t h e m a r s h a l l i n g o v e r h e a d i s s m a l l .
T O T A L _ T L B _ I M P O R T S _ 0 0 9 _ N A M E = # o f T L B i m p o r t s / s e c
T O T A L _ T L B _ I M P O R T S _ 0 0 9 _ H E L P = R e s e r v e d f o r f u t u r e u s e .
T O T A L _ T L B _ E X P O R T S _ 0 0 9 _ N A M E = # o f T L B e x p o r t s / s e c
T O T A L _ T L B _ E X P O R T S _ 0 0 9 _ H E L P = R e s e r v e d f o r f u t u r e u s e .
D o t N e t C L R _ L o c k s A n d T h r e a d s _ O B J E C T _ 0 0 9 _ N A M E = . N E T C L R L o c k s A n d T h r e a d s
D o t N e t C L R _ L o c k s A n d T h r e a d s _ O B J E C T _ 0 0 9 _ H E L P = S t a t s f o r C L R L o c k s a n d T h r e a d s .
C O N T E N T I O N _ T O T A L _ 0 0 9 _ N A M E = T o t a l # o f C o n t e n t i o n s
C O N T E N T I O N _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f t i m e s t h r e a d s i n t h e C L R h a v e a t t e m p t e d t o a c q u i r e a m a n a g e d l o c k u n s u c c e s s f u l l y . M a n a g e d l o c k s c a n b e a c q u i r e d i n m a n y w a y s ; b y t h e " l o c k " s t a t e m e n t i n C # o r b y c a l l i n g S y s t e m . M o n i t o r . E n t e r o r b y u s i n g M e t h o d I m p l O p t i o n s . S y n c h r o n i z e d c u s t o m a t t r i b u t e .
C O N T E N T I O N _ I N S T _ 0 0 9 _ N A M E = C o n t e n t i o n R a t e / s e c
C O N T E N T I O N _ I N S T _ 0 0 9 _ H E L P = R a t e a t w h i c h t h r e a d s i n t h e r u n t i m e a t t e m p t t o a c q u i r e a m a n a g e d l o c k u n s u c c e s s f u l l y . M a n a g e d l o c k s c a n b e a c q u i r e d i n m a n y w a y s ; b y t h e " l o c k " s t a t e m e n t i n C # o r b y c a l l i n g S y s t e m . M o n i t o r . E n t e r o r b y u s i n g M e t h o d I m p l O p t i o n s . S y n c h r o n i z e d c u s t o m a t t r i b u t e .
Q U E U E _ L E N G T H _ C U R _ 0 0 9 _ N A M E = C u r r e n t Q u e u e L e n g t h
Q U E U E _ L E N G T H _ C U R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f t h r e a d s c u r r e n t l y w a i t i n g t o a c q u i r e s o m e m a n a g e d l o c k i n t h e a p p l i c a t i o n . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e l a s t o b s e r v e d v a l u e .
Q U E U E _ L E N G T H _ T O T A L _ 0 0 9 _ N A M E = Q u e u e L e n g t h P e a k
Q U E U E _ L E N G T H _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f t h r e a d s t h a t w a i t e d t o a c q u i r e s o m e m a n a g e d l o c k s i n c e t h e s t a r t o f t h e a p p l i c a t i o n .
Q U E U E _ L E N G T H _ I N S T _ 0 0 9 _ N A M E = Q u e u e L e n g t h / s e c
Q U E U E _ L E N G T H _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f t h r e a d s p e r s e c o n d w a i t i n g t o a c q u i r e s o m e l o c k i n t h e a p p l i c a t i o n . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
C U R R E N T _ L O G I C A L _ T H R E A D S _ 0 0 9 _ N A M E = # o f c u r r e n t l o g i c a l T h r e a d s
C U R R E N T _ L O G I C A L _ T H R E A D S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f c u r r e n t . N E T t h r e a d o b j e c t s i n t h e a p p l i c a t i o n . A . N E T t h r e a d o b j e c t i s c r e a t e d e i t h e r b y n e w S y s t e m . T h r e a d i n g . T h r e a d o r w h e n a n u n m a n a g e d t h r e a d e n t e r s t h e m a n a g e d e n v i r o n m e n t . T h i s c o u n t e r s m a i n t a i n s t h e c o u n t o f b o t h r u n n i n g a n d s t o p p e d t h r e a d s . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t j u s t d i s p l a y s t h e l a s t o b s e r v e d v a l u e .
C U R R E N T _ P H Y S I C A L _ T H R E A D S _ 0 0 9 _ N A M E = # o f c u r r e n t p h y s i c a l T h r e a d s
C U R R E N T _ P H Y S I C A L _ T H R E A D S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f n a t i v e O S t h r e a d s c r e a t e d a n d o w n e d b y t h e C L R t o a c t a s u n d e r l y i n g t h r e a d s f o r . N E T t h r e a d o b j e c t s . T h i s c o u n t e r s v a l u e d o e s n o t i n c l u d e t h e t h r e a d s u s e d b y t h e C L R i n i t s i n t e r n a l o p e r a t i o n s ; i t i s a s u b s e t o f t h e t h r e a d s i n t h e O S p r o c e s s .
R E C O G N I Z E D _ T H R E A D S _ C U R _ 0 0 9 _ N A M E = # o f c u r r e n t r e c o g n i z e d t h r e a d s
R E C O G N I Z E D _ T H R E A D S _ C U R _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f t h r e a d s t h a t a r e c u r r e n t l y r e c o g n i z e d b y t h e C L R ; t h e y h a v e a c o r r e s p o n d i n g . N E T t h r e a d o b j e c t a s s o c i a t e d w i t h t h e m . T h e s e t h r e a d s a r e n o t c r e a t e d b y t h e C L R ; t h e y a r e c r e a t e d o u t s i d e t h e C L R b u t h a v e s i n c e r u n i n s i d e t h e C L R a t l e a s t o n c e . O n l y u n i q u e t h r e a d s a r e t r a c k e d ; t h r e a d s w i t h s a m e t h r e a d I D r e - e n t e r i n g t h e C L R o r r e c r e a t e d a f t e r t h r e a d e x i t a r e n o t c o u n t e d t w i c e .
R E C O G N I Z E D _ T H R E A D S _ T O T A L _ 0 0 9 _ N A M E = # o f t o t a l r e c o g n i z e d t h r e a d s
R E C O G N I Z E D _ T H R E A D S _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f t h r e a d s t h a t h a v e b e e n r e c o g n i z e d b y t h e C L R s i n c e t h e s t a r t o f t h i s a p p l i c a t i o n ; t h e s e t h r e a d s h a v e a c o r r e s p o n d i n g . N E T t h r e a d o b j e c t a s s o c i a t e d w i t h t h e m . T h e s e t h r e a d s a r e n o t c r e a t e d b y t h e C L R ; t h e y a r e c r e a t e d o u t s i d e t h e C L R b u t h a v e s i n c e r u n i n s i d e t h e C L R a t l e a s t o n c e . O n l y u n i q u e t h r e a d s a r e t r a c k e d ; t h r e a d s w i t h s a m e t h r e a d I D r e - e n t e r i n g t h e C L R o r r e c r e a t e d a f t e r t h r e a d e x i t a r e n o t c o u n t e d t w i c e .
R E C O G N I Z E D _ T H R E A D S _ I N S T _ 0 0 9 _ N A M E = r a t e o f r e c o g n i z e d t h r e a d s / s e c
R E C O G N I Z E D _ T H R E A D S _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f t h r e a d s p e r s e c o n d t h a t h a v e b e e n r e c o g n i z e d b y t h e C L R ; t h e s e t h r e a d s h a v e a c o r r e s p o n d i n g . N E T t h r e a d o b j e c t a s s o c i a t e d w i t h t h e m . T h e s e t h r e a d s a r e n o t c r e a t e d b y t h e C L R ; t h e y a r e c r e a t e d o u t s i d e t h e C L R b u t h a v e s i n c e r u n i n s i d e t h e C L R a t l e a s t o n c e . O n l y u n i q u e t h r e a d s a r e t r a c k e d ; t h r e a d s w i t h s a m e t h r e a d I D r e - e n t e r i n g t h e C L R o r r e c r e a t e d a f t e r t h r e a d e x i t a r e n o t c o u n t e d t w i c e . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
D o t N e t C L R _ S e c u r i t y _ O B J E C T _ 0 0 9 _ N A M E = . N E T C L R S e c u r i t y
D o t N e t C L R _ S e c u r i t y _ O B J E C T _ 0 0 9 _ H E L P = S t a t s f o r C L R S e c u r i t y .
S E C U R I T Y _ T O T A L R T C H E C K S _ 0 0 9 _ N A M E = T o t a l R u n t i m e C h e c k s
S E C U R I T Y _ T O T A L R T C H E C K S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f r u n t i m e C o d e A c c e s s S e c u r i t y ( C A S ) c h e c k s p e r f o r m e d s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . R u n t i m e C A S c h e c k s a r e p e r f o r m e d w h e n a c a l l e r m a k e s a c a l l t o a c a l l e e d e m a n d i n g a p a r t i c u l a r p e r m i s s i o n ; t h e r u n t i m e c h e c k i s m a d e o n e v e r y c a l l b y t h e c a l l e r ; t h e c h e c k i s d o n e b y e x a m i n i n g t h e c u r r e n t t h r e a d s t a c k o f t h e c a l l e r . T h i s c o u n t e r u s e d t o g e t h e r w i t h " S t a c k W a l k D e p t h " i s i n d i c a t i v e o f p e r f o r m a n c e p e n a l t y f o r s e c u r i t y c h e c k s .
S E C U R I T Y _ T I M E A U T H O R I Z E _ 0 0 9 _ N A M E = % T i m e S i g . A u t h e n t i c a t i n g
S E C U R I T Y _ T I M E A U T H O R I Z E _ 0 0 9 _ H E L P = R e s e r v e d f o r f u t u r e u s e .
S E C U R I T Y _ L I N K C H E C K S _ 0 0 9 _ N A M E = # L i n k T i m e C h e c k s
S E C U R I T Y _ L I N K C H E C K S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f l i n k t i m e C o d e A c c e s s S e c u r i t y ( C A S ) c h e c k s s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . L i n k t i m e C A S c h e c k s a r e p e r f o r m e d w h e n a c a l l e r m a k e s a c a l l t o a c a l l e e d e m a n d i n g a p a r t i c u l a r p e r m i s s i o n a t J I T c o m p i l e t i m e ; l i n k t i m e c h e c k i s p e r f o r m e d o n c e p e r c a l l e r . T h i s c o u n t i s n o t i n d i c a t i v e o f s e r i o u s p e r f o r m a n c e i s s u e s ; i t s i n d i c a t i v e o f t h e s e c u r i t y s y s t e m a c t i v i t y .
S E C U R I T Y _ T I M E R T C H E C K S _ 0 0 9 _ N A M E = % T i m e i n R T c h e c k s
S E C U R I T Y _ T I M E R T C H E C K S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e p e r c e n t a g e o f e l a p s e d t i m e s p e n t i n p e r f o r m i n g r u n t i m e C o d e A c c e s s S e c u r i t y ( C A S ) c h e c k s s i n c e t h e l a s t s u c h c h e c k . C A S a l l o w s c o d e t o b e t r u s t e d t o v a r y i n g d e g r e e s a n d e n f o r c e s t h e s e v a r y i n g l e v e l s o f t r u s t d e p e n d i n g o n c o d e i d e n t i t y . T h i s c o u n t e r i s u p d a t e d a t t h e e n d o f a r u n t i m e s e c u r i t y c h e c k ; i t r e p r e s e n t s t h e l a s t o b s e r v e d v a l u e ; i t s n o t a n a v e r a g e .
S E C U R I T Y _ T I M E R T C H E C K S _ B A S E _ 0 0 9 _ N A M E = N o t D i s p l a y e d
S E C U R I T Y _ T I M E R T C H E C K S _ B A S E _ 0 0 9 _ H E L P = N o t D i s p l a y e d .
S E C U R I T Y _ D E P T H S E C U R I T Y _ 0 0 9 _ N A M E = S t a c k W a l k D e p t h
S E C U R I T Y _ D E P T H S E C U R I T Y _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e d e p t h o f t h e s t a c k d u r i n g t h a t l a s t r u n t i m e C o d e A c c e s s S e c u r i t y c h e c k . R u n t i m e C o d e A c c e s s S e c u r i t y c h e c k i s p e r f o r m e d b y c r a w l i n g t h e s t a c k . T h i s c o u n t e r i s n o t a n a v e r a g e ; i t j u s t d i s p l a y s t h e l a s t o b s e r v e d v a l u e .
D o t N e t C L R _ R e m o t i n g _ O B J E C T _ 0 0 9 _ N A M E = . N E T C L R R e m o t i n g
D o t N e t C L R _ R e m o t i n g _ O B J E C T _ 0 0 9 _ H E L P = S t a t s f o r C L R R e m o t i n g .
C O N T E X T _ R E M O T E C A L L S _ I N S T _ 0 0 9 _ N A M E = R e m o t e C a l l s / s e c
C O N T E X T _ R E M O T E C A L L S _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f r e m o t e p r o c e d u r e c a l l s i n v o k e d p e r s e c o n d . A r e m o t e p r o c e d u r e c a l l i s a c a l l o n a n y o b j e c t o u t s i d e t h e c a l l e r ; s A p p D o m a i n . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
C O N T E X T _ C H A N N E L S _ 0 0 9 _ N A M E = C h a n n e l s
C O N T E X T _ C H A N N E L S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f r e m o t i n g c h a n n e l s r e g i s t e r e d a c r o s s a l l A p p D o m a i n s s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . C h a n n e l s a r e u s e d t o t r a n s p o r t m e s s a g e s t o a n d f r o m r e m o t e o b j e c t s .
C O N T E X T _ P R O X I E S _ 0 0 9 _ N A M E = C o n t e x t P r o x i e s
C O N T E X T _ P R O X I E S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f r e m o t i n g p r o x y o b j e c t s c r e a t e d i n t h i s p r o c e s s s i n c e t h e s t a r t o f t h e p r o c e s s . P r o x y o b j e c t a c t s a s a r e p r e s e n t a t i v e o f t h e r e m o t e o b j e c t s a n d e n s u r e s t h a t a l l c a l l s m a d e o n t h e p r o x y a r e f o r w a r d e d t o t h e c o r r e c t r e m o t e o b j e c t i n s t a n c e .
C O N T E X T _ C L A S S E S _ 0 0 9 _ N A M E = C o n t e x t - B o u n d C l a s s e s L o a d e d
C O N T E X T _ C L A S S E S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f c o n t e x t - b o u n d c l a s s e s l o a d e d . C l a s s e s t h a t c a n b e b o u n d t o a c o n t e x t a r e c a l l e d c o n t e x t - b o u n d c l a s s e s ; c o n t e x t - b o u n d c l a s s e s a r e m a r k e d w i t h C o n t e x t A t t r i b u t e s w h i c h p r o v i d e u s a g e r u l e s f o r s y n c h r o n i z a t i o n ; t h r e a d a f f i n i t y ; t r a n s a c t i o n s e t c .
C O N T E X T _ O B J A L L O C _ 0 0 9 _ N A M E = C o n t e x t - B o u n d O b j e c t s A l l o c / s e c
C O N T E X T _ O B J A L L O C _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f c o n t e x t - b o u n d o b j e c t s a l l o c a t e d p e r s e c o n d . I n s t a n c e s o f c l a s s e s t h a t c a n b e b o u n d t o a c o n t e x t a r e c a l l e d c o n t e x t - b o u n d o b j e c t s ; c o n t e x t - b o u n d c l a s s e s a r e m a r k e d w i t h C o n t e x t A t t r i b u t e s w h i c h p r o v i d e u s a g e r u l e s f o r s y n c h r o n i z a t i o n ; t h r e a d a f f i n i t y ; t r a n s a c t i o n s e t c . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
C O N T E X T _ C O N T E X T S _ 0 0 9 _ N A M E = C o n t e x t s
C O N T E X T _ C O N T E X T S _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e c u r r e n t n u m b e r o f r e m o t i n g c o n t e x t s i n t h e a p p l i c a t i o n . A c o n t e x t i s a b o u n d a r y c o n t a i n i n g a c o l l e c t i o n o f o b j e c t s w i t h t h e s a m e u s a g e r u l e s l i k e s y n c h r o n i z a t i o n ; t h r e a d a f f i n i t y ; t r a n s a c t i o n s e t c .
C O N T E X T _ R E M O T E C A L L S _ T O T A L _ 0 0 9 _ N A M E = T o t a l R e m o t e C a l l s
C O N T E X T _ R E M O T E C A L L S _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f r e m o t e p r o c e d u r e c a l l s i n v o k e d s i n c e t h e s t a r t o f t h i s a p p l i c a t i o n . A r e m o t e p r o c e d u r e c a l l i s a c a l l o n a n y o b j e c t o u t s i d e t h e c a l l e r ; s A p p D o m a i n .
D o t N e t C L R _ E x c e p _ O B J E C T _ 0 0 9 _ N A M E = . N E T C L R E x c e p t i o n s
D o t N e t C L R _ E x c e p _ O B J E C T _ 0 0 9 _ H E L P = R u n t i m e s t a t i s t i c s o n C L R e x c e p t i o n h a n d l i n g .
E X C E P _ T H R O W N _ T O T A L _ 0 0 9 _ N A M E = # o f E x c e p s T h r o w n
E X C E P _ T H R O W N _ T O T A L _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e t o t a l n u m b e r o f e x c e p t i o n s t h r o w n s i n c e t h e s t a r t o f t h e a p p l i c a t i o n . T h e s e i n c l u d e b o t h . N E T e x c e p t i o n s a n d u n m a n a g e d e x c e p t i o n s t h a t g e t c o n v e r t e d i n t o . N E T e x c e p t i o n s e . g . n u l l p o i n t e r r e f e r e n c e e x c e p t i o n i n u n m a n a g e d c o d e w o u l d g e t r e - t h r o w n i n m a n a g e d c o d e a s a . N E T S y s t e m . N u l l R e f e r e n c e E x c e p t i o n ; t h i s c o u n t e r i n c l u d e s b o t h h a n d l e d a n d u n h a n d l e d e x c e p t i o n s . E x c e p t i o n s t h a t a r e r e - t h r o w n w o u l d g e t c o u n t e d a g a i n . E x c e p t i o n s s h o u l d o n l y o c c u r i n r a r e s i t u a t i o n s a n d n o t i n t h e n o r m a l c o n t r o l f l o w o f t h e p r o g r a m .
E X C E P _ T H R O W N _ I N S T _ 0 0 9 _ N A M E = # o f E x c e p s T h r o w n / s e c
E X C E P _ T H R O W N _ I N S T _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f e x c e p t i o n s t h r o w n p e r s e c o n d . T h e s e i n c l u d e b o t h . N E T e x c e p t i o n s a n d u n m a n a g e d e x c e p t i o n s t h a t g e t c o n v e r t e d i n t o . N E T e x c e p t i o n s e . g . n u l l p o i n t e r r e f e r e n c e e x c e p t i o n i n u n m a n a g e d c o d e w o u l d g e t r e - t h r o w n i n m a n a g e d c o d e a s a . N E T S y s t e m . N u l l R e f e r e n c e E x c e p t i o n ; t h i s c o u n t e r i n c l u d e s b o t h h a n d l e d a n d u n h a n d l e d e x c e p t i o n s . E x c e p t i o n s s h o u l d o n l y o c c u r i n r a r e s i t u a t i o n s a n d n o t i n t h e n o r m a l c o n t r o l f l o w o f t h e p r o g r a m ; t h i s c o u n t e r w a s d e s i g n e d a s a n i n d i c a t o r o f p o t e n t i a l p e r f o r m a n c e p r o b l e m s d u e t o l a r g e ( > 1 0 0 s ) r a t e o f e x c e p t i o n s t h r o w n . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
T O T A L _ E X C E P _ F I L T E R S _ R U N _ 0 0 9 _ N A M E = # o f F i l t e r s / s e c
T O T A L _ E X C E P _ F I L T E R S _ R U N _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f . N E T e x c e p t i o n f i l t e r s e x e c u t e d p e r s e c o n d . A n e x c e p t i o n f i l t e r e v a l u a t e s w h e t h e r a n e x c e p t i o n s h o u l d b e h a n d l e d o r n o t . T h i s c o u n t e r t r a c k s t h e r a t e o f e x c e p t i o n f i l t e r s e v a l u a t e d ; i r r e s p e c t i v e o f w h e t h e r t h e e x c e p t i o n w a s h a n d l e d o r n o t . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
T O T A L _ E X C E P _ F I N A L L Y S _ R U N _ 0 0 9 _ N A M E = # o f F i n a l l y s / s e c
T O T A L _ E X C E P _ F I N A L L Y S _ R U N _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f f i n a l l y b l o c k s e x e c u t e d p e r s e c o n d . A f i n a l l y b l o c k i s g u a r a n t e e d t o b e e x e c u t e d r e g a r d l e s s o f h o w t h e t r y b l o c k w a s e x i t e d . O n l y t h e f i n a l l y b l o c k s t h a t a r e e x e c u t e d f o r a n e x c e p t i o n a r e c o u n t e d ; f i n a l l y b l o c k s o n n o r m a l c o d e p a t h s a r e n o t c o u n t e d b y t h i s c o u n t e r . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
E X C E P T _ S T A C K _ D E P T H _ 0 0 9 _ N A M E = T h r o w T o C a t c h D e p t h / s e c
E X C E P T _ S T A C K _ D E P T H _ 0 0 9 _ H E L P = T h i s c o u n t e r d i s p l a y s t h e n u m b e r o f s t a c k f r a m e s t r a v e r s e d f r o m t h e f r a m e t h a t t h r e w t h e . N E T e x c e p t i o n t o t h e f r a m e t h a t h a n d l e d t h e e x c e p t i o n p e r s e c o n d . T h i s c o u n t e r r e s e t s t o 0 w h e n a n e x c e p t i o n h a n d l e r i s e n t e r e d ; s o n e s t e d e x c e p t i o n s w o u l d s h o w t h e h a n d l e r t o h a n d l e r s t a c k d e p t h . T h i s c o u n t e r i s n o t a n a v e r a g e o v e r t i m e ; i t d i s p l a y s t h e d i f f e r e n c e b e t w e e n t h e v a l u e s o b s e r v e d i n t h e l a s t t w o s a m p l e s d i v i d e d b y t h e d u r a t i o n o f t h e s a m p l e i n t e r v a l .
D o t N e t C L R _ M e m o r y _ O B J E C T _ 0 0 1 _ N A M E = . N E T C L R M e m o r y
D o t N e t C L R _ M e m o r y _ O B J E C T _ 0 0 1 _ H E L P = 9/Q'/'* DCHE) 'D(J'F'* 'DEGED) 'D*J *E ,E9G' D@ C L R .
G E N 0 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 1 _ N A M E = # G e n 0 C o l l e c t i o n s
G E N 0 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/Q'/ 9// E1'* ,E9 'D(J'F'* 'DEGED) DC'&F'* 'D,JD 0 ( G e n 0 G C ) ( #-/+ 'DC'&F'* #-/+ C'&F'* *E *.5J5G') EF0 (/! *4:JD 'D*7(JB. *-/+ 9EDJ) *,EJ9 'D(J'F'* 'DEGED) DC'&F'* 'D,JD 0 9F/E' D' *CHF 'D0'C1) 'DE*HA1) AJ 'D,JD 0 C'AJ) D*D(J) #-/ 7D('* 'D*.5J5. HJ*E 2J'/) G0' 'D9/'/ AJ FG'J) G0G 'D9EDJ). H**6EF 'D(J'F'* 'DEGED) 'D*J *E ,E9G' ( G C ) DC'&F'* 'D,JD 'D#-/+ ,EJ9 'D(J'F'* 'DEGED) 'D*J *E ,E9G' D,EJ9 C'&F'* 'D,JD 'D#B/E. HJ*E 2J'/) G0' 'D9/Q'/ (H6H- 9F/E' *-/+ 9EDJ) *,EJ9 (J'F'* EGED) D,JD #9DI ( 'D,JD 1 #H 'D,JD 2 ) . BJE) _ G l o b a l _ c o u n t e r :J1 /BJB) HJ,( %GE'DG'. J916 G0' 'D9/'/ ".1 BJE) *E* ED'-8*G'.
G E N 1 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 1 _ N A M E = # G e n 1 C o l l e c t i o n s
G E N 1 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/Q'/ 9// E1'* ,E9 'D(J'F'* 'DEGED) DC'&F'* 'D,JD 1 EF0 (/! *4:JD 'D*7(JB. HJ*E 2J'/) G0' 'D9/'/ AJ FG'J) 9EDJ) ,E9 'D(J'F'* 'DEGED) DC'&F'* 'D,JD 1 ( G e n 1 G C ) . H**6EF 'D(J'F'* 'DEGED) 'D*J *E ,E9G' ( G C ) DC'&F'* 'D,JD 'D#-/+ ,EJ9 'D(J'F'* 'DEGED) 'D*J *E ,E9G' DC'&F'* 'D,JD 'D#B/E. HJ*E 2J'/) G0' 'D9/'/ (4CD 51J- 9F/E' *-/+ 9EDJ) ,E9 (J'F'* EGED) D,JD #9DI ( 'D,JD 2 ) . BJE) _ G l o b a l _ c o u n t e r :J1 /BJB) HJ,( %GE'DG'. J916 G0' 'D9/'/ ".1 BJE) *E* ED'-8*G'.
G E N 2 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 1 _ N A M E = # G e n 2 C o l l e c t i o n s
G E N 2 _ C O L L E C T I O N S _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/Q'/ 9// 'DE1'* 'D*J J*E AJG' *,EJ9 'D(J'F'* 'DEGED) DC'&F'* 'DA&) 2 ( 'D#B/E) EF0 (/! 'D*7(JB. J*2'J/ G0' 'D9/'/ AJ FG'J) G e n 2 G C ( JO7DB 9DJG' #J6K' G C 'DC'ED) . %F BJE) 'D9/'/ _ G l o b a l _ :J1 /BJB) HJ,( *,'GDG'. J916 G0' 'D9/'/ ".1 BJE) *E* ED'-8*G'.
G E N 0 _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 1 _ N A M E = P r o m o t e d M e m o r y f r o m G e n 0
G E N 0 _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ H-/'* ('J* 'D0'C1) 'D*J *(B* (9/ *,EJ9 'D(J'F'* 'DEGED) ( G C ) H'D*J *E* *1BJ*G' EF 'D,JD 0 %DI 'D,JD 1 . 'DC'&F'* 'D*J *E* *1BJ*G' AB7 D#FG JOF*81 %FG'$G' DE J*E *6EJFG' AJ G0' 'D9/'/. J916 G0' 'D9/'/ 'DBJE) 'D*J *E* ED'-8*G' AJ FG'J) ".1 9EDJ) G C AGH DJ3 9/'/K' *1'CEJK'.
G E N 1 _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 1 _ N A M E = P r o m o t e d M e m o r y f r o m G e n 1
G E N 1 _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/Q'/ H-/'* ('J* 'D0'C1) 'D*J *(B* (9/ *,EJ9 'D(J'F'* 'DEGED) ( G C ) H'D*J *E* *1BJ*G' EF 'D,JD 1 %DI 'D,JD 2 #E' 'DC'&F'* 'D*J *E* *1BJ*G' AB7 DCHFG' JOF*81 %FG'$G' DE J*E *6EJFG' AJ G0' 'D9/'/. J916 G0' 'D9/'/ 'DBJE) 'D*J *,1J ED'-8*G' AJ FG'J) ".1 9EDJ) G C AGH DJ3 9/'/K' *1'CEJK'. J*E %9'/) *9JJF G0' 'D9/'/ %DI 0 %0' C'F* ".1 9EDJ) G C B/ *E* 9DI 'D,JD 0 AB7.
G E N 0 _ P R O M O T I O N _ R A T E _ 0 0 1 _ N A M E = G e n 0 P r o m o t e d B y t e s / S e c
G E N 0 _ P R O M O T I O N _ R A T E _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// H-/'* 'D('J* 'D*J *E* *1BJ*G' AJ 'D+'FJ) EF 'D,JD 0 ( 'D#-/+) %DI 'D,JD 1 #E' 'DC'&F'* 'D*J *E* *1BJ*G' AB7 DCHFG' JOF*81 %FG'$G' ADE J*E *6EJFG' AJ G0' 'D9/'/. J*E *1BJ) 'D0'C1) %0' *(B* (9/ %-/I 9EDJ'* *,EJ9 'D(J'F'* 'DEGED). *E *5EJE G0' 'D9/'/ CE$41 9DI 'DC'&F'* 0'* 'D9E1 'D7HJD F3(JK' 'D*J J*E %F4'$G' AJ 'D+'FJ). HJ916 G0' 'D9/'/ 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
G E N 1 _ P R O M O T I O N _ R A T E _ 0 0 1 _ N A M E = G e n 1 P r o m o t e d B y t e s / S e c
G E N 1 _ P R O M O T I O N _ R A T E _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// H-/'* 'D('J* 'D*J *E* *1BJ*G' AJ 'D+'FJ) EF 'D,JD 1 %DI 'D,JD 2 ( 'D#B/E) DE J*E *6EJF 'DC'&F'* 'D*J *E* *1BJ*G' AB7 D#FG JOF*81 %FG'$G' AJ G0' 'D9/'/. J*E *1BJ) 'D0'C1) %0' *(B* (9/ %-/I 9EDJ'* ,E9 'D(J'F'* 'DEGED). DE J*E *1BJ) #J) C'&F'* EF 'D,JD 2 D#FG GH #B/E ,JD. B/ *E *5EJE G0' 'D9/'/ CE$41 9DI 'DC'&F'* 0'* 'D9E1 'D7HJD DD:'J) 'D*J J*E %F4'$G' AJ 'D+'FJ). J916 G0' 'D9/'/ 'DA1B (JF 'DBJE 'DEH,H/) AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
G E N 0 _ F I N A L I Z A T I O N _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 1 _ N A M E = P r o m o t e d F i n a l i z a t i o n - M e m o r y f r o m G e n 0
G E N 0 _ F I N A L I Z A T I O N _ B Y T E S _ P R O M O T E D _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// H-/'* ('J* 'D0'C1) 'D*J *E* *1BJ*G' EF 'D,JD 0 %DI 'D,JD 1 AB7 D#FG JOF*81 %FG'$G'. J916 G0' 'D9/'/ 'DBJE) 'D*J *,1J ED'-8*G' AJ FG'J) ".1 9EDJ) G C AGH DJ3 9/'/K' *1'CEJK'.
P R O C E S S _ I D _ 0 0 1 _ N A M E = P r o c e s s I D
P R O C E S S _ I D _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ E91QA 'D9EDJ) 'D.'5 (E+JD 9EDJ) C L R 'D,'1J E1'B(*G. 3*CHF 'DBJE) 'DE91H6) 0 -*I #HD E,EH9) (J'F'* EGED).
G E N 0 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 1 _ N A M E = G e n 0 h e a p s i z e
G E N 0 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ #B5I 9// EF H-/'* 'D('J* JECF *.5J5G' AJ 'D,JD 0 ( G e n 0 ) HGH D' J4J1 %DI 'D9// 'D-'DJ EF H-/'* 'D('J* 'DE.55) AJ 'D,JD 0 . J*E *4:JD 9EDJ) *,EJ9 'D(J'F'* 'DEGED) DD,JD 0 9F/E' *2J/ 9EDJ'* 'D*.5J5 'D*J *E* EF0 ".1 9EDJ) *,EJ9 (J'F'* EGED) 9F -,E G0' 'D,JD. J*E 6(7 -,E 'D,JD 0 9F 71JB ,'E9 'D(J'F'* 'DEGED) CE' JECF #F J*:J1 #+F'! *FAJ0 'D*7(JB. HAJ FG'J) 9EDJ) ,E9 'D(J'F'* 'DEGED) DD,JD 0 J5(- -,E CHE) 'D,JD 0 AJ 'DH'B9 0 ('J* J916 G0' 'D9/'/ -,E 9EDJ'* 'D*.5J5 ( ('D('J*) 'D*J *9ED 9DI *4:JD 9EDJ) ,E9 'D(J'F'* 'DEGED) 'D*'DJ) DD,JD 0 ( G e n 0 G C ) . J*E *-/J+ G0' 'D9/'/ AJ FG'J) 9EDJ) ,E9 'D(J'F'* 'DEGED) HD' J*E *-/J+G 9F/ CD *.5J5.
G E N 1 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 1 _ N A M E = G e n 1 h e a p s i z e
G E N 1 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D9// 'D-'DJ EF H-/'* 'D('J* AJ 'D,JD 1 ( G e n 1 ) D' J916 G0' 'D9/'/ #B5I -,E DD,JD 1 . D' J*E *.5J5 'DC'&F'* E('41) AJ G0' 'D,JD HDCF J*E *1BJ*G' EF 9EDJ'* ,E9 'D(J'F'* 'DEGED) DD,JD 0 ( G e n 0 G C ) 'D3'(B). J*E *-/J+ G0' 'D9/'/ AJ FG'J) G C HD' J*E *-/J+G 9F/ CD 9EDJ) *.5J5.
G E N 2 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 1 _ N A M E = G e n 2 h e a p s i z e
G E N 2 _ H E A P _ S I Z E _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D9// 'D-'DJ EF H-/'* 'D('J* AJ 'D,JD 2 ( G e n 2 ) . D' J*E *.5J5 'DC'&F'* E('41) AJ G0' 'D,JD HDCF J*E *1BJ*G' EF 'D,JD 1 .D'D 9EDJ'* ,E9 'D(J'F'* 'DEGED) 'D3'(B) DD,JD 1 ( G e n 1 G C ) . J*E *-/J+ G0' 'D9/'/ AJ FG'J) 9EDJ'* ,E9 'D(J'F'* 'DEGED) HD' J*E *-/J+G 9F/ CD 9EDJ) *.5J5.
L A R G E _ O B J E C T _ S I Z E _ C O U N T E R _ 0 0 1 _ N A M E = L a r g e O b j e c t H e a p s i z e
L A R G E _ O B J E C T _ S I Z E _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D-,E 'D-'DJ DCHE) 'DC'&F'* 'DC(J1) (H-/'* 'D('J*. H**E E9'ED) 'DC'&F'* 'D*J J2J/ -,EG' 9F 'D-/ 'DEH6- 9DI #FG' C'&F'* C(J1) EF BP(D ,'E9 'D(J'F'* 'DEGED) HJ*E *.5J5G' E('41) AJ CHE) .'5) HD' **E *1BJ*G' .D'D 'D#,J'D. AJ C L R v 1 . 1 H'D%5/'1'* 'D#-/+ J3'HJ G0' 'D-/ 8 5 0 0 0 ('J*. HJ*E *-/J+ G0' 'D9/'/ AJ FG'J) 9EDJ'* ,E9 'D(J'F'* 'DEGED) HD' J*E *-/J+G 9F/ CD 9EDJ) *.5J5.
S U R V I V E _ F I N A L I Z E _ C O U N T E R _ 0 0 1 _ N A M E = F i n a l i z a t i o n S u r v i v o r s
S U R V I V E _ F I N A L I Z E _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// 'DC'&F'* 'DE*(BJ) (9/ *,EJ9 'D(J'F'* 'DEGED) DG' D#FG JOF*81 %FG'$G'. %0' C'F* G0G 'DC'&F'* *-*A8 (E1',9 %DI C'&F'* #.1I A-JF&0 3*(BI G0G 'DC'&F'* #J6K' DCF DF J*E 9/QG' (H'37) G0' 'D9/'/ HJE+D 9/'/' " 0'C1) 'D%FG'! 'D*J *E *1BJ*G' EF 'D,JD 0 " H" 0'C1) 'D%FG'! 'D*J *E *1BJ*G' EF 'D,JD 1 " 'D0'C1) 'DCDJ) 'D*J *(B* F*J,) DD%FG'!. HG0' 'D9/'/ DJ3 9/'/K' *1'CEJK' HDCF J*E *-/J+G AJ FG'J) CD 9EDJ) *,EJ9 (J'F'* EGED) (9// 'DC'&F'* 'DE*(BJ) AB7 .D'D 9EDJ) G C 'D.'5) G0G *-/J/K'. *E *5EJE G0' 'D9/'/ DD%4'1) %DI EB/'1 'D-ED 'D%6'AJ 'D0J B/ JB9 9DI 'D(1F'E, F*J,) 'D%FG'!.
N U M _ H A N D L E S _ C O U N T E R _ 0 0 1 _ N A M E = # G C H a n d l e s
N U M _ H A N D L E S _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// E9'D,'* G C 'DE3*./E) -'DJK'. *O9/ G C H a n d l e s E9'D,'* DEH'1/ .'1, C L R H'D(J&) 'DEO/'1). *4:D 'DE9'D,'* E3'-'* 5:J1) EF 'D0'C1) AJ G C H e a p HDCF G0G 'DE3'-'* *E+D EH'1/ :J1 EO/'1) EF 'DE-*ED '1*A'9 *CDA*G'.
A L L O C A T I O N _ R A T E _ C O U N T E R _ 0 0 1 _ N A M E = A l l o c a t e d B y t e s / s e c
A L L O C A T I O N _ R A T E _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ E9/D H-/'* 'D('J* 'D*J J*E *.5J5G' AJ 'D+'FJ) AJ CHE) G C . J*E *-/J+ G0' 'D9/'/ AJ FG'J) CD G C HDJ3 9F/ CD 9EDJ) *.5J5. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
I N D U C E D _ G C _ C O U N T E R _ 0 0 1 _ N A M E = # I n d u c e d G C
I N D U C E D _ G C _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ #B5I 9// EF 'DE1'* **E AJG' 9EDJ) ,E9 'D(J'F'* 'DEGED) (3(( '3*/9'! H'6- D@ G C . C o l l e c t . JA6D 'D3E'- D@ G C (6(7 *1// 9EDJ'* *,EJ9G'.
P E R _ T I M E _ I N _ G C _ C O U N T E R _ 0 0 1 _ N A M E = % T i m e i n G C
P E R _ T I M E _ I N _ G C _ C O U N T E R _ 0 0 1 _ H E L P = % HB* ,E9 'D(J'F'* 'DEGED) GH F3() 'DHB* 'DEFB6J AJ %,1'! 9EDJ) ,E9 (J'F'* EGED) ( G C ) EF0 ".1 /H1) ,E9 (J'F'* EGED). HJ9/ G0' 'D9/'/ 9'/) E$41K' 9DI 'D9ED 'D0J *E %,1'$G (H'37) " ,'E9 'D(J'F'* 'DEGED)" FJ'() 9F 'D*7(JB D,E9 'D0'C1) H6:7G'. J*E *-/J+ G0' 'D9/'/ AJ FG'J) CD 9EDJ) ,E9 (J'F'* EGED) H*9C3 BJE) 'D9/'/ ".1 BJE) *E* ED'-8*G' HGJ DJ3* BJE) 'DE*H37.
P E R _ T I M E _ I N _ G C _ C O U N T E R _ B A S E _ 0 0 1 _ N A M E = N o t D i s p l a y e d
P E R _ T I M E _ I N _ G C _ C O U N T E R _ B A S E _ 0 0 1 _ H E L P = :J1 E91H6.
T O T A L _ H E A P _ S I Z E _ C O U N T E R _ 0 0 1 _ N A M E = # B y t e s i n a l l H e a p s
T O T A L _ H E A P _ S I Z E _ C O U N T E R _ 0 0 1 _ H E L P = G0' 'D9/'/ GH E,EH9 'D9/'/'* 'D#1(9) 'D#.1I HGH -,E CHE) 'D,JD 0 H-,E CHE) 'D,JD 1 H-,E CHE) 'D,JD 2 H-,E CHE) 'DC'&F'* 'DC(J1). HJ4J1 G0' 'D9/'/ %DI 'D0'C1) 'D-'DJ) 'DE.55) ('D('J* AJ CHE'* G C .
T O T A L _ C O M M I T T E D _ M E M _ C O U N T E R _ 0 0 1 _ N A M E = # T o t a l c o m m i t t e d B y t e s
T O T A L _ C O M M I T T E D _ M E M _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ E3'-) 'D0'C1) 'D8'G1J) ( ('D('J*) 'DE-,H2) -'DJK' EF BP(D " ,'E9 'D(J'F'* 'DEGED)" . ( 'D0'C1) 'DE-,H2) GJ 0'C1) A9DJ) *E -,2 E3'-) DG' 9DI EDA 'D*1-JD 9DI 'DB15) .
T O T A L _ R E S E R V E D _ M E M _ C O U N T E R _ 0 0 1 _ N A M E = # T o t a l r e s e r v e d B y t e s
T O T A L _ R E S E R V E D _ M E M _ C O U N T E R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ E3'-) 'D0'C1) 'D8'G1J) ( ('D('J*) 'DE-,H2) -'DJK' EF BP(D " ,'E9 'D(J'F'* 'DEGED)" . ( 'D0'C1) 'DE-,H2) GJ E3'-) 'D0'C1) 'D8'G1J) 'DE-,H2) DD*7(JB /HF '3*./'E #J) 5A-'* .'5) ('DB15 #H 'D0'C1) 'D1&J3J)) .
G C _ P I N N E D _ O B J E C T S _ 0 0 1 _ N A M E = # o f P i n n e d O b j e c t s
G C _ P I N N E D _ O B J E C T S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// 'DC'&F'* 'DE+(*) 'D*J *E* E5'/A*G' AJ ".1 9EDJ) ,E9 (J'F'* EGED). J*9B( G0' 'D9/'/ 'DC'&F'* 'DE+(*) AB7 AJ 'DCHE'* 'D*J *E ,E9 (J'F'* EGED) EFG' 9DI 3(JD 'DE+'D 3HA **3(( 9EDJ) ,E9 'D(J'F'* 'DEGED) DD,JD 0 ( G e n 0 G C ) AJ *9/'/ 'DC'&F'* 'DE+(*) AJ CHE) 'D,JD 0 AB7. H'DC'&F 'DE+(* GH 'DC'&F 'D0J D' J3*7J9 " ,'E9 'D(J'F'* 'DEGED)" *-1JCG AJ 'D0'C1).
G C _ S I N K B L O C K S _ 0 0 1 _ N A M E = # o f S i n k B l o c k s i n u s e
G C _ S I N K B L O C K S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// C*D 'DE2'EF) 'DE3*./E) -'DJK'. HC*D 'DE2'EF) GJ (FJ'* (J'F'* DCD C'&F E.55) D*.2JF E9DHE'* 'DE2'EF). *-*A8 C*D 'DE2'EF) (E1',9 69JA) DDC'&F'* 'DEO/'1) HJ,( A-5G' (H'37) " ,'E9 'D(J'F'* 'DEGED)" . D' JB*51 9ED C*D 'DE2'EF) 9DI *.2JF E9DHE'* 'DE2'EF) (D HJECFG' #J6K' *.2JF (J'F'* *91JA C O M i n t e r o p . *E *5EJE G0' 'D9/'/ DD%4'1) %DI E4'CD 'D#/'! 9F/ 'D'3*./'E 'DE*2'J/ D%14'/'* 'DE2'EF) 'D#HDJ).
D o t N e t C L R _ L o a d i n g _ O B J E C T _ 0 0 1 _ N A M E = . N E T C L R L o a d i n g
D o t N e t C L R _ L o a d i n g _ O B J E C T _ 0 0 1 _ H E L P = %-5'&J'* EO-EQD A&'* C L R .
L O A D I N G _ C L A S S E S _ T O T A L _ 0 0 1 _ N A M E = T o t a l C l a s s e s L o a d e d
L O A D I N G _ C L A S S E S _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D9// 'D*1'CEJ DDA&'* 'D*J *E *-EJDG' AJ C'A) " 'D*,EJ9'*" EF0 (/! *4:JD 'D*7(JB.
L O A D I N G _ T I M E _ 0 0 1 _ N A M E = % T i m e L o a d i n g
L O A D I N G _ T I M E _ 0 0 1 _ H E L P = E-,H2 DD'3*./'E AJ 'DE3*B(D.
L O A D I N G _ A S M S E A R C H L E N _ 0 0 1 _ N A M E = A s s e m b l y S e a r c h L e n g t h
L O A D I N G _ A S M S E A R C H L E N _ 0 0 1 _ H E L P = E-,H2 DD'3*./'E AJ 'DE3*B(D.
L O A D I N G _ L O A D F A I L U R E S _ T O T A L _ 0 0 1 _ N A M E = T o t a l # o f L o a d F a i l u r e s
L O A D I N G _ L O A D F A I L U R E S _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ #B5I 9// DDA&'* 'D*J A4D *-EJDG' EF0 (/! *4:JD 'D*7(JB. B/ *1,9 E1'* A4D 'D*-EJD G0G D9/) EF 'D#3('( C#F JCHF 'D#E'F :J1 C'AM #H #F 'D*F3JB :J1 B'FHFJ. *H,/ *A'5JD C'ED) AJ *9DJE'* ./E'* %F4'! EDA 'D*91JA.
L O A D I N G _ L O A D F A I L U R E S _ I N S T _ 0 0 1 _ N A M E = R a t e o f L o a d F a i l u r e s
L O A D I N G _ L O A D F A I L U R E S _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// 'DA&'* 'D*J A4D *-EJDG' AJ 'D+'FJ). HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF). B/ *1,9 E1'* A4D 'D*-EJD G0G D9/) #3('( C#F JCHF 'D#E'F :J1 C'AM #H #F 'D*F3JB :J1 B'FHFJ. *H,/ *A'5JD C'ED) AJ *9DJE'* ./E'* %F4'! EDA 'D*91JA.
L O A D I N G _ H E A P S I Z E _ 0 0 1 _ N A M E = B y t e s i n L o a d e r H e a p
L O A D I N G _ H E A P S I Z E _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D-,E 'D-'DJ DD0'C1) ( ('D('J*) 'DE-,H2) EF BP(D EO-EQD 'DA&'* 9(1 C'A) E,'D'* A p p D o m a i n . ( 'D0'C1) 'DE-,H2) GJ 0'C1) A9DJ) *E -,2 E3'-) DG' 9DI EDA 'D*1-JD 9DI 'DB15. )
L O A D I N G _ A P P D O M A I N S _ U N L O A D E D _ T O T A L _ 0 0 1 _ N A M E = T o t a l a p p d o m a i n s u n l o a d e d
L O A D I N G _ A P P D O M A I N S _ U N L O A D E D _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// E,'D'* A p p D o m a i n 'D*J *E %D:'! *-EJDG' EF0 (/! *4:JD 'D*7(JB. %0' *E *-EJD A p p D o m a i n H%D:'! *-EJDG 9/) E1'* A3JBHE G0' 'D9/'/ (9/Q CD 9EDJ) EF 9EDJ'* %D:'! 'D*-EJD G0G (4CD EFA5D.
L O A D I N G _ A P P D O M A I N S _ U N L O A D E D _ I N S T _ 0 0 1 _ N A M E = R a t e o f a p p d o m a i n s u n l o a d e d
L O A D I N G _ A P P D O M A I N S _ U N L O A D E D _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// E,'D'* A p p D o m a i n 'D*J *E %D:'! *-EJDG' AJ 'D+'FJ). HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
L O A D I N G _ C L A S S E S _ C U R _ 0 0 1 _ N A M E = C u r r e n t C l a s s e s L o a d e d
L O A D I N G _ C L A S S E S _ C U R _ 0 0 1 _ H E L P = G0' 'D9/'/ J916 'D9// 'D-'DJ EF 'DA&'* 'DEO-EQD) AJ C'A) " 'D*,EJ9'*" .
L O A D I N G _ C L A S S E S _ I N S T _ 0 0 1 _ N A M E = R a t e o f C l a s s e s L o a d e d
L O A D I N G _ C L A S S E S _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// 'DA&'* 'D*J J*E *-EJDG' AJ 'D+'FJ) AJ C'A) " 'D*,EJ9'*" . HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* 9(1 'DHB* (D GH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
L O A D I N G _ A P P D O M A I N S _ C U R _ 0 0 1 _ N A M E = C u r r e n t a p p d o m a i n s
L O A D I N G _ A P P D O M A I N S _ C U R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D9// 'D-'DJ EF E,'D'* A p p D o m a i n 'D*J *E *-EJDG' AJ G0' 'D*7(JB. H*HA1 A p p D o m a i n s ( E,'D'* 'D*7(JB'*) H-/) E9'D,) "EF) E*9//) 'D'3*./'E (%EC'F C L R '3*./'EG' DD92D (JF 'D*7(JB'* 'D*J J*E *4:JDG' AJ FA3 'D9EDJ).
L O A D I N G _ A P P D O M A I N S _ T O T A L _ 0 0 1 _ N A M E = T o t a l A p p d o m a i n s
L O A D I N G _ A P P D O M A I N S _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ #B5I 9// EF E,'D'* 'D*7(JB'* ( A p p D o m a i n ) 'D*J *E *-EJDG' EF0 (/! *4:JD G0' 'D*7(JB. H*HA1 E,'D'* 'D*7(JB'* H-/) E9'D,) "EF) E*9//) 'D'3*./'E (%EC'F C L R '3*./'EG' DD92D (JF 'D*7(JB'* 'D*J J*E *4:JDG' AJ FA3 'D9EDJ).
L O A D I N G _ A P P D O M A I N S _ I N S T _ 0 0 1 _ N A M E = R a t e o f a p p d o m a i n s
L O A D I N G _ A P P D O M A I N S _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// E,'D'* 'D*7(JB'* ( A p p D o m a i n ) 'D*J J*E *-EJDG' AJ 'D+'FJ). H*HA1 E,'D'* 'D*7(JB'* H-/) E9'D,) "EF) E*9//) 'D'3*./'E (%EC'F C L R '3*./'EG' DD92D (JF 'D*7(JB'* 'D*J J*E *4:JDG' AJ FA3 'D9EDJ). HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* 9(1 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
L O A D I N G _ A S S E M B L I E S _ C U R _ 0 0 1 _ N A M E = C u r r e n t A s s e m b l i e s
L O A D I N G _ A S S E M B L I E S _ C U R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// " 'D*,EJ9'*" 'D-'DJ H'D*J *E *-EJDG' 9(1 C'A) E,'D'* 'D*7(JB'* ( A p p D o m a i n ) AJ G0' 'D*7(JB. %0' *E *-EJD " 'D*,EJ9" (-J+ JCHF -J'/J 'DE,'D EF E,'D'* *7(JB'* E*9//) A3HA J2/'/ G0' 'D9/'/ E1) H'-/) AB7. JECF *-EJD " 'D*,EJ9'*" (-J+ *CHF -J'/J) 'DE,'D 9F/E' JCHF EF 'DEECF E4'1C) *9DJE'*G' 'D(1E,J) (H'37) C'A) E,'D'* 'D*7(JB'* #H 9F/E' JECF *-EJDG' (-J+ *CHF .'5) (E,'D E-// 9F/E' *CHF *9DJE'*G' 'D(1E,J) .'5) (E,'D *7(JB.
L O A D I N G _ A S S E M B L I E S _ T O T A L _ 0 0 1 _ N A M E = T o t a l A s s e m b l i e s
L O A D I N G _ A S S E M B L I E S _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// " 'D*,EJ9'*" 'D%,E'DJ 'D*J *E *-EJDG' EF0 (/! *4:JD G0' 'D*7(JB. %0' *E *-EJD " 'D*,EJ9" (-J+ JCHF -J'/J 'DE,'D EF E,'D'* *7(JB'* E*9//) A3J2/'/ G0' 'D9/'/ E1) H'-/) AB7. JECF *-EJD " 'D*,EJ9'*" (-J+ *CHF -J'/J) 'DE,'D 9F/E' JCHF EF 'DEECF E4'1C) *9DJE'*G' 'D(1E,J) (H'37) C'A) E,'D'* 'D*7(JB'* #H JECF *-EJDG' (-J+ *CHF .'5) (E,'D E-// 9F/E' *CHF *9DJE'*G' 'D(1E,J) .'5) (E,'D *7(JB.
L O A D I N G _ A S S E M B L I E S _ I N S T _ 0 0 1 _ N A M E = R a t e o f A s s e m b l i e s
L O A D I N G _ A S S E M B L I E S _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// " 'D*,EJ9'*" 'D*J J*E *-EJDG' 9(1 C'A) E,'D'* 'D*7(JB'* ( A p p D o m a i n ) AJ 'D+'FJ). %0' *E *-EJD " 'D*,EJ9" (-J+ JCHF -J'/J 'DE,'D EF 'D9/J/ EF E,'D'* 'D*7(JB'* A3J2/'/ G0' 'D9/'/ E1) H'-/) AB7. JECF *-EJD " 'D*,EJ9'*" (-J+ *CHF -J'/J) 'DE,'D 9F/E' JCHF EF 'DEECF E4'1C) *9DJE'*G' 'D(1E,J) (H'37) C'A) E,'D'* 'D*7(JB'* #H JECF *-EJDG' (-J+ *CHF .'5) (E,'D E-// 9F/E' *CHF *9DJE'*G' 'D(1E,J) .'5) (E,'D 'D*7(JB. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* 9(1 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
D o t N e t C L R _ J i t _ O B J E C T _ 0 0 1 _ N A M E = . N E T C L R J i t
D o t N e t C L R _ J i t _ O B J E C T _ 0 0 1 _ H E L P = %-5'&J'* D@ C L R J i t .
T O T A L _ M E T H O D S _ J I T T E D _ 0 0 1 _ N A M E = # o f M e t h o d s J i t t e d
T O T A L _ M E T H O D S _ J I T T E D _ 0 0 1 _ H E L P = G0' 'D9/'/ J916 'D9// 'DCDJ DD#3'DJ( 'D*J *E *-HJDG' (1E,JK' 9DI 'DAH1 ( J I T ) (H'37) 'DE-HD 'D(1E,J C L R J I T EF0 (/! *4:JD 'D*7(JB. D' J*6EF G0' 'D9/'/ 'D#3'DJ( 'D*J *E *-HJDG' %DI %14'/'* D:) 'D"D) 3'(BK'.
J I T T E D _ I L _ C U R _ 0 0 1 _ N A M E = # o f I L B y t e s J i t t e d
J I T T E D _ I L _ C U R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// H-/'* ('J* I L 'D*J *E *-HJDG' %DI %14'/'* D:) 'D"D) EF0 (/! *4:JD 'D*7(JB. G0' 'D9/'/ EC'A& *E'EK' D9/'/ " %,E'DJ 9// H-/'* 'D('J* D@ I L 'D*J *E *-HJDG' %DI %14'/'* D:) 'D"D)" .
J I T T E D _ I L _ T O T A L _ 0 0 1 _ N A M E = T o t a l # o f I L B y t e s J i t t e d
J I T T E D _ I L _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// H-/'* ('J* I L 'D*J *E *-HJDG' %DI %14'/'* D:) 'D"D) EF0 (/! *4:JD 'D*7(JB. G0' 'D9/'/ EC'A& *E'EK' D9/'/ " 9// H-/'* 'D('J* D@ I L 'D*J *E *-HJDG' %DI %14'/'* D:) 'D"D)" .
J I T T E D _ I L _ I N S T _ 0 0 1 _ N A M E = I L B y t e s J i t t e d / s e c
J I T T E D _ I L _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'DE9/D 'D0J J*E (G *-HJD H-/'* 'D('J* D@ I L %DI %14'/'* D:) 'D"D) AJ 'D+'FJ). HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
J I T _ F A I L U R E S _ 0 0 1 _ N A M E = S t a n d a r d J i t F a i l u r e s
J I T _ F A I L U R E S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ #B5I 9// DD#3'DJ( 'D*J A4D 'DE-HD 'D(1E,J J I T AJ *-HJDG' %DI %14'/'* D:) 'D"D) EF0 (/! *4:JD 'D*7(JB. JECF #F J-/+ G0' 'DA4D %0' *901 'D*-BB EF I L #H %0' C'F GF'C .7# /'.DJ AJ 'DE-HD 'D(1E,J J I T .
T I M E _ I N _ J I T _ 0 0 1 _ N A M E = % T i m e i n J i t
T I M E _ I N _ J I T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ F3() 'DHB* 'DEFB6J AJ *1,E) J I T EF0 ".1 E1-D) *1,E) J I T . J*E *-/J+ G0' 'D9/'/ AJ FG'J) CD E1-D) *1,E) J I T . HE1-D) *1,E) J I T GJ E1-D) *1,E) #-/ 'D#3'DJ( HA1H9G.
T I M E _ I N _ J I T _ B A S E _ 0 0 1 _ N A M E = N o t D i s p l a y e d
T I M E _ I N _ J I T _ B A S E _ 0 0 1 _ H E L P = :J1 E91H6.
D o t N e t C L R _ I n t e r o p _ O B J E C T _ 0 0 1 _ N A M E = . N E T C L R I n t e r o p
D o t N e t C L R _ I n t e r o p _ O B J E C T _ 0 0 1 _ H E L P = %-5'&J'* D@ C L R i n t e r o p .
C U R R E N T _ C C W _ 0 0 1 _ N A M E = # o f C C W s
C U R R E N T _ C C W _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D9// 'D-'DJ EF C o m - C a l l a b l e - W r a p p e r s ( '.*5'1G' C C W s ) . J9*(1 C C W HCJD'K DDC'&F'* 'DEO/'1) D@ N E T . H'D*J J*E 9ED E1',9 %DJG' EF 9EJD ( 9ED'!) C O M :J1 'DEO/'1. *E *5EJE G0' 'D9/'/ DD%4'1) %DI 9// 'DC'&F'* 'DEO/'1) H'D*J J*E 9ED E1',9 %DJG' (H'37) 'D*9DJE'* 'D(1E,J) :J1 'DEO/'1) D@ C O M .
C U R R E N T _ S T U B S _ 0 0 1 _ N A M E = # o f S t u b s
C U R R E N T _ S T U B S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D9// 'D-'DJ EF H-/'* C9( 'D1H*JF 'D*J *E %F4'$G' (H'37) C L R . H*9/ H-/'* C9( 'D1H*JF E3$HD) 9F *F8JE 'DH3'&7 HBJE 'D%1,'9 EF 'D*9DJE'* 'D(1E,J) 'DEO/'1) %DI :J1 'DEO/'1) H'D9C3 H0DC #+F'! '3*/9'! C O M I n t e r o p #H '3*/9'! P I n v o k e .
N U M _ M A R S H A L L I N G _ 0 0 1 _ N A M E = # o f m a r s h a l l i n g
N U M _ M A R S H A L L I N G _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// E1'* *F8JE 'DH3'&7 HBJE 'D%1,'9 EF 'D*9DJE'* 'D(1E,J) 'DEO/'1) %DI :J1 'DEO/'1) H'D9C3 EF0 (/! *4:JD 'D*7(JB. HD' J*E 2J'/) G0' 'D9/'/ %0' *E *6EJF H-/'* C9( 'D1H*JF. ( H-/'* C9( 'D1H*JF GJ 'DE3$HD) 9F *F8JE 'DH3'&7 HBJE 'D%1,'9) . J*E *6EJF H-/'* C9( 'D1H*JF 9'/) %0' C'F EB/'1 'D-ED 'D*F8JEJ 5:J1K'.
T O T A L _ T L B _ I M P O R T S _ 0 0 1 _ N A M E = # o f T L B i m p o r t s / s e c
T O T A L _ T L B _ I M P O R T S _ 0 0 1 _ H E L P = E-,H2 DD'3*./'E AJ 'DE3*B(D.
T O T A L _ T L B _ E X P O R T S _ 0 0 1 _ N A M E = # o f T L B e x p o r t s / s e c
T O T A L _ T L B _ E X P O R T S _ 0 0 1 _ H E L P = E-,H2 DD'3*./'E AJ 'DE3*B(D.
D o t N e t C L R _ L o c k s A n d T h r e a d s _ O B J E C T _ 0 0 1 _ N A M E = . N E T C L R L o c k s A n d T h r e a d s
D o t N e t C L R _ L o c k s A n d T h r e a d s _ O B J E C T _ 0 0 1 _ H E L P = %-5'&J'* D*#EJF'* HE$41'* *1'(7 C L R .
C O N T E N T I O N _ T O T A L _ 0 0 1 _ N A M E = T o t a l # o f C o n t e n t i o n s
C O N T E N T I O N _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// 'DE1'* 'D*J A4D* AJG' E$41'* 'D*1'(7 AJ C L R AJ 'D-5HD 9DI *#EJF EO/'1. JECF 'D-5HD 9DI 'D*#EJF'* 'DEO/'1) (9/) 71B (H'37) 9('1) " l o c k " AJ D:) # C #H ('3*/9'! S y s t e m . M o n i t o r . E n t e r #H ('3*./'E 'D3E) 'DE.55) M e t h o d I m p l O p t i o n s . S y n c h r o n i z e d .
C O N T E N T I O N _ I N S T _ 0 0 1 _ N A M E = C o n t e n t i o n R a t e / s e c
C O N T E N T I O N _ I N S T _ 0 0 1 _ H E L P = 'DE9/D 'D0J *-'HD (G E$41'* 'D*1'(7 AJ HB* 'D*4:JD 'D-5HD 9DI *#EJF EO/'1 /HF F,'-. JECF 'D-5HD 9DI 'D*#EJF'* 'DE/O'1) (9/) 71B (H'37) 9('1) " l o c k " AJ D:) # C #H ('3*/9'! S y s t e m . M o n i t o r . E n t e r #H ('3*./'E 'D3E) 'DE.55) M e t h o d I m p l O p t i o n s . S y n c h r o n i z e d .
Q U E U E _ L E N G T H _ C U R _ 0 0 1 _ N A M E = C u r r e n t Q u e u e L e n g t h
Q U E U E _ L E N G T H _ C U R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// E$41'* 'D*1'(7 'D*J *F*81 -'DJK' 'D-5HD 9DI (96 'D*#EJF'* 'DEO/'1) AJ 'D*7(JB. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 ".1 BJE) *E* ED'-8*G'.
Q U E U E _ L E N G T H _ T O T A L _ 0 0 1 _ N A M E = Q u e u e L e n g t h P e a k
Q U E U E _ L E N G T H _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// E$41'* 'D*1'(7 'D*J 'F*81* 'D-5HD 9DI (96 'D*#EJF'* 'DEO/'1) EF0 (/! *4:JD 'D*7(JB.
Q U E U E _ L E N G T H _ I N S T _ 0 0 1 _ N A M E = Q u e u e L e n g t h / s e c
Q U E U E _ L E N G T H _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// E$41'* 'D*1'(7 AJ 'D+'FJ) 'D*J *F*81 'D-5HD 9DI (96 'D*#EJF'* AJ 'D*7(JB. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
C U R R E N T _ L O G I C A L _ T H R E A D S _ 0 0 1 _ N A M E = # o f c u r r e n t l o g i c a l T h r e a d s
C U R R E N T _ L O G I C A L _ T H R E A D S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// C'&F'* E$41 *1'(7 N E T . 'D-'DJ AJ 'D*7(JB. HJ*E %F4'! C'&F E$41 *1'(7 N E T . %E' 9F 71JB S y s t e m . T h r e a d i n g . T h r e a d ,/J/ #H 9F/E' J/.D E$41 *1'(7 :J1 EO/'1 AJ 'D(J&) 'DEO/'1). HJ-*A8 G0' 'D9/'/ (9// CD EF E$41'* 'D*1'(7 'D*J BJ/ 'D*4:JD H'DE*HBA). HBJE) G0' 'D9/'/ DJ3* BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 AB7 ".1 BJE) *E* ED'-8*G'.
C U R R E N T _ P H Y S I C A L _ T H R E A D S _ 0 0 1 _ N A M E = # o f c u r r e n t p h y s i c a l T h r e a d s
C U R R E N T _ P H Y S I C A L _ T H R E A D S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// E$41'* *1'(7 F8'E 'D*4:JD 'D#5DJ) 'D*J *E %F4'$G' H'E*D'CG' (H'37) C L R DCJ *9ED CE$41'* *1'(7 #3'3J) DC'&F'* E$41 *1'(7 N E T . D' **6EF BJE) G0' 'D9/'/ E$41'* 'D*1'(7 'DE3*./E) (H'37) C L R AJ 9EDJ'*G' 'D/'.DJ) AGJ E,EH9) A19J) EF E$41'* 'D*1'(7 'DEH,H/) AJ 9EDJ) F8'E 'D*4:JD.
R E C O G N I Z E D _ T H R E A D S _ C U R _ 0 0 1 _ N A M E = # o f c u r r e n t r e c o g n i z e d t h r e a d s
R E C O G N I Z E D _ T H R E A D S _ C U R _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// E$41'* 'D*1'(7 'D*J *E 'D*91A 9DJG' -'DJK' (H'37) C L R HJB*1F (E$41'* 'D*1'(7 G0G C'&F E$41 *1'(7 N E T . E7'(B. DE J*E %F4'! E$41'* 'D*1'(7 G0G (H'37) C L R (D *E %F4'$G' .'1, C L R DCF *E *4:JDG' EF0 0DC 'D-JF /'.D C L R E1) H'-/) 9DI 'D#BD. J*E *9B( E$41'* 'D*1'(7 'DA1J/) AB7 #E' E$41'* 'D*1'(7 'D*J DG' FA3 E91A E$41 'D*1'(7 'D*J */.D C L R E1) #.1I #H 'D*J *E* %9'/) %F4'&G' (9/ %FG'! E$41 'D*1'(7 AD' J*E 9/QG' E1*JF.
R E C O G N I Z E D _ T H R E A D S _ T O T A L _ 0 0 1 _ N A M E = # o f t o t a l r e c o g n i z e d t h r e a d s
R E C O G N I Z E D _ T H R E A D S _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// E$41'* 'D*1'(7 'D*J *E 'D*91A 9DJG' EF BP(D C L R EF0 (/! *4:JD 'D*7(JB HJB*1F (E$41'* 'D*1'(7 G0G C'&F E$41 *1'(7 N E T . E7'(B. DE J*E %F4'! E$41'* 'D*1'(7 G0G (H'37) C L R (D *E %F4'$G' .'1,G' DCF *E *4:JDG' EF0 0DC 'D-JF /'.D C L R E1) H'-/) 9DI 'D#BD. J*E *9B( E$41'* 'D*1'(7 'DA1J/) AB7 HE$41'* 'D*1'(7 'D*J *-*HJ 9DI FA3 E91A E$41 'D*1'(7 'D*J */.D C L R E1) #.1I #H E$41'* 'D*1'(7 'D*J *E* %9'/) %F4'&G' (9/ %FG'! E$41 'D*1'(7 D' J*E 9/G' E1*JF.
R E C O G N I Z E D _ T H R E A D S _ I N S T _ 0 0 1 _ N A M E = r a t e o f r e c o g n i z e d t h r e a d s / s e c
R E C O G N I Z E D _ T H R E A D S _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// E$41'* 'D*1'(7 AJ 'D+'FJ) 'D*J *E 'D*91A 9DJG' (H'37) C L R . HJB*1F (E$41'* 'D*1'(7 G0G C'&F E$41 *1'(7 N E T . E7'(B. DE J*E %F4'! E$41'* 'D*1'(7 G0G (H'37) C L R (D *E %F4'$G' .'1, C L R DCF *E *4:JDG' EF0 0DC 'D-JF /'.D C L R E1) H'-/) 9DI 'D#BD. HJ*E *9B( E$41'* 'D*1'(7 'DA1J/) AB7 HE$41'* 'D*1'(7 'D*J DG' FA3 E91A E$41 'D*1'(7 'D*J */.D C L R E1) #.1I #H E$41'* 'D*1'(7 'D*J *E* %9'/) %F4'&G' (9/ %FG'! E$41 'D*1'(7 D' J*E 9/QG' E1*JF. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
D o t N e t C L R _ S e c u r i t y _ O B J E C T _ 0 0 1 _ N A M E = . N E T C L R S e c u r i t y
D o t N e t C L R _ S e c u r i t y _ O B J E C T _ 0 0 1 _ H E L P = %-5'&J'* D#E'F C L R .
S E C U R I T Y _ T O T A L R T C H E C K S _ 0 0 1 _ N A M E = T o t a l R u n t i m e C h e c k s
S E C U R I T Y _ T O T A L R T C H E C K S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// 9EDJ'* 'D*-BB EF #E'F 'DH5HD %DI 'D*9DJE'* 'D(1E,J) ( C A S ) 'D*J *E %,1'$G' EF0 (/! *4:JD 'D*7(JB. HJ*E %,1'! 9EDJ'* 'D*-BB EF #E'F 'DH5HD %DI 'D*9DJE'* 'D(1E,J) 9F/E' JBHE 7'D( (%,1'! '3*/9'! DE*5D 9DJG D7D( %0F E9JF HJ*E %,1'! 'D*-BB 'D.'5 (HB* 'D*4:JD 9DI CD '3*/9'! (H'37) 'D7'D( HJ*E 'D*-BB 9F 71JB '.*('1 EC/3 E$41 'D*1'(7 'D-'DJ DD7'D(. HJ4J1 G0' 'D9/'/ 'D0J JO3*./E E9 " 9EB 'DEC/3 #+F'! 'DE1H1 (G" %DI EB/'1 'F.A'6 'D#/'! F*J,) 9EDJ'* 'D*-BB EF 'D#E'F.
S E C U R I T Y _ T I M E A U T H O R I Z E _ 0 0 1 _ N A M E = % T i m e S i g . A u t h e n t i c a t i n g
S E C U R I T Y _ T I M E A U T H O R I Z E _ 0 0 1 _ H E L P = E-,H2 DD'3*./'E AJ 'DE3*B(D.
S E C U R I T Y _ L I N K C H E C K S _ 0 0 1 _ N A M E = # L i n k T i m e C h e c k s
S E C U R I T Y _ L I N K C H E C K S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// 9EDJ'* 'D*-BB EF #E'F 'DH5HD %DI 'D*9DJE'* 'D(1E,J) ( C A S ) 'D.'5) (HB* 'D'1*('7 EF0 (/! *4:JD 'D*7(JB. HJ*E %,1'! 9EDJ'* 'D*-BB EF #E'F 'DH5HD %DI 'D*9DJE'* 'D(1E,J) 'D.'5) (HB* 'D'1*('7 9F/E' JBHE 7'D( (%,1'! '3*/9'! DE*5D 9DJG D7D( %0F 9F/ HB* *1,E) J I T HJ*E %,1'! 'D*-BB EF HB* 'D1(7 E1) H'-/) DCD 7'D(. HD' J4J1 G0' 'D9// %DI E4CD'* .7J1) AJ 'D#/'! HDCFG J4J1 %DI F4'7 F8'E 'D#E'F.
S E C U R I T Y _ T I M E R T C H E C K S _ 0 0 1 _ N A M E = % T i m e i n R T c h e c k s
S E C U R I T Y _ T I M E R T C H E C K S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ F3() 'DHB* 'DEFB6J AJ %,1'! 9EDJ'* 'D*-BB EF #E'F 'DH5HD %DI 'D*9DJE'* 'D(1E,J) ( C A S ) AJ HB* 'D*4:JD EF0 ".1 *-BB EE'+D. HJ3E- #E'F 'DH5HD %DI 'D*9DJE'* 'D(1E,J) ('DH+HB AJ 'D*9DJE'* 'D(1E,J) (/1,'* E*FH9) HJA16 E3*HJ'* 'D+B) 'DE*FH9) G0G (F'!K 9DI GHJ) 'D*9DJE'* 'D(1E,J). J*E *-/J+ G0' 'D9/'/ AJ FG'J) 9EDJ) 'D*-BB EF #E'F HB* 'D*4:JD HGH JE+D ".1 BJE) *E* ED'-8*G' HDJ3* BJE) 'DE*H37.
S E C U R I T Y _ T I M E R T C H E C K S _ B A S E _ 0 0 1 _ N A M E = N o t D i s p l a y e d
S E C U R I T Y _ T I M E R T C H E C K S _ B A S E _ 0 0 1 _ H E L P = :J1 E91H6.
S E C U R I T Y _ D E P T H S E C U R I T Y _ 0 0 1 _ N A M E = S t a c k W a l k D e p t h
S E C U R I T Y _ D E P T H S E C U R I T Y _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9EB 'DEC/3 D".1 9EDJ) *-BB EF #E'F 'DH5HD %DI 'D*9DJE'* 'D(1E,J) #+F'! HB* 'D*4:JD. J*E %,1'! 'D*-BB EF #E'F 'DH5HD %DI 'D*9DJE'* 'D(1E,J) 9F 71JB E3- 'DEC/3. HD' *CHF BJE) G0' 'D9/'/ BJE) 'DE*H37 HDCFG J916 AB7 ".1 BJE) *E* ED'-8*G'.
D o t N e t C L R _ R e m o t i n g _ O B J E C T _ 0 0 1 _ N A M E = . N E T C L R R e m o t i n g
D o t N e t C L R _ R e m o t i n g _ O B J E C T _ 0 0 1 _ H E L P = %-5'&J'* DD9ED 9F (O9/ AJ C L R .
C O N T E X T _ R E M O T E C A L L S _ I N S T _ 0 0 1 _ N A M E = R e m o t e C a l l s / s e c
C O N T E X T _ R E M O T E C A L L S _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// '3*/9'!'* 'D%,1'!'* 'D(9J/) 'D*J *E %,1'$G' AJ 'D+'FJ). H'3*/9'! 'D%,1'! 'D(9J/ GH '3*/9'! D#J C'&F .'1, E,'D 'D*7(JB ( A p p D o m a i n ) 'D.'5 ('D7'D(. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
C O N T E X T _ C H A N N E L S _ 0 0 1 _ N A M E = C h a n n e l s
C O N T E X T _ C H A N N E L S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// BFH'* 'D9ED 9F (O9/ 'DE3,D) 9(1 ,EJ9 E,'D'* 'D*7(JB'* ( A p p D o m a i n ) EF0 (/! *4:JD 'D*7(JB. *@O3*./E 'DBFH'* AJ FBD 'D13'&D EF H%DI 'DC'&F'* 'D(9J/).
C O N T E X T _ P R O X I E S _ 0 0 1 _ N A M E = C o n t e x t P r o x i e s
C O N T E X T _ P R O X I E S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// C'&F'* 'D9ED 9F (O9/ 'D.'5) ('DHCJD 'D*J *E %F4'$G' AJ G0G 'D9EDJ) EF0 (/! 'D9EDJ). HJ9ED C'&F 'DHCJD CEE+D DDC'&F'* 'D(9J/) HJ*#C/ EF *H,JG ,EJ9 'D'3*/9'!'* 'D*J J*E %,1'$G' 9DI 'DHCJD %DI E+JD 'DC'&F 'D(9J/ 'D5-J-.
C O N T E X T _ C L A S S E S _ 0 0 1 _ N A M E = C o n t e x t - B o u n d C l a s s e s L o a d e d
C O N T E X T _ C L A S S E S _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 'D9// 'D-'DJ DDA&'* 'DE1*(7) ('D3J'B H'D*J *E *-EJDG'. H*3EI 'DA&'* 'D*J JECF 1(7G' ('D3J'B 'DA&'* 'DE1*(7) ('D3J'B HJ*E *9DJE 'DA&'* 'DE1*(7) ('D3J'B (3E'* 'D3J'B 'D*J *HA1 BH'9/ 'D'3*./'E DDE2'EF) HDH5D E$41'* 'D*1'(7 H'DE9'ED'* %D..
C O N T E X T _ O B J A L L O C _ 0 0 1 _ N A M E = C o n t e x t - B o u n d O b j e c t s A l l o c / s e c
C O N T E X T _ O B J A L L O C _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// 'DC'&F'* 'DE1*(7) ('D3J'B 'D*J *E *.5J5G' AJ 'D+'FJ). H*3EI E+JD'* 'DA&'* 'D*J JECF 1(7G' ('D3J'B ('DC'&F'* 'DE1*(7) ('D3J'B HJ*E *9DJE 'DA&'* 'DE1*(7) ('D3J'B (3E'* 'D3J'B 'D*J *HA1 BH'9/ 'D'3*./'E DDE2'EF) HDH5D E$41'* 'D*1'(7 H'DE9'ED'* %D.. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
C O N T E X T _ C O N T E X T S _ 0 0 1 _ N A M E = C o n t e x t s
C O N T E X T _ C O N T E X T S _ 0 0 1 _ H E L P = G0' 'D9/'/ J916 'D9// 'D-'DJ D3J'B'* 'D9ED 9F (O9/ AJ 'D*7(JB. H'D3J'B GH -/ J-*HJ 9DI E,EH9) C'&F'* DG' FA3 BH'9/ 'D'3*./'E E+D 'DE2'EF) HH5D E$41'* 'D*1'(7 H'DE9'ED'* %D..
C O N T E X T _ R E M O T E C A L L S _ T O T A L _ 0 0 1 _ N A M E = T o t a l R e m o t e C a l l s
C O N T E X T _ R E M O T E C A L L S _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// '3*/9'!'* 'D%,1'!'* 'D(9J/) 'D*J *E %,1'$G' EF0 (/! *4:JD 'D*7(JB. H'3*/9'! 'D%,1'! 'D(9J/ GH '3*/9'! D#J C'&F .'1, E,'D 'D*7(JB ( A p p D o m a i n ) 'D.'5 ('D7'D(.
D o t N e t C L R _ E x c e p _ O B J E C T _ 0 0 1 _ N A M E = . N E T C L R E x c e p t i o n s
D o t N e t C L R _ E x c e p _ O B J E C T _ 0 0 1 _ H E L P = %-5'&J'* HB* 'D*4:JD AJ E9'D,) '3*+F'!'* C L R .
E X C E P _ T H R O W N _ T O T A L _ 0 0 1 _ N A M E = # o f E x c e p s T h r o w n
E X C E P _ T H R O W N _ T O T A L _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ %,E'DJ 9// 'D'3*+F'!'* 'D*J *E 71-G' EF0 (/! *4:JD 'D*7(JB. H**6EF G0G 'D'3*+F'!'* CD'K EF '3*+F'!'* N E T . H'D'3*+F'!'* :J1 'DEO/'1) 'D*J *E *-HJDG' %DI '3*+F'!'* N E T . A9DI 3(JD 'DE+'D 3**E %9'/) 71- '3*+F'! E1,9 'DE$41 'DA'1: 'DEH,H/ AJ 'D*9DJE'* 'D(1E,J) :J1 'DEO/'1) AJ 'D*9DJE'* 'D(1E,J) 'DEO/'1) 9DI GJ&) N E T S y s t e m . N u l l R e f e r e n c e E x c e p t i o n . -J+ J*6EF G0' 'D9/'/ CD'K EF 'D'3*+F'!'* 'DEO9'DN,) H:J1 'DEO9'DN,). H3J*E E1) #.1I 9/Q 'D'3*+F'!'* 'D*J *E* %9'/) 71-G'. J,( #F *-/+ 'D'3*+F'!'* AJ EH'BA F'/1) AB7 HDJ3 AJ 'D*/AB 'D9'/J DD*-CE AJ 'D(1F'E,.
E X C E P _ T H R O W N _ I N S T _ 0 0 1 _ N A M E = # o f E x c e p s T h r o w n / s e c
E X C E P _ T H R O W N _ I N S T _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// 'D'3*+F'!'* 'D*J *E 71-G' AJ 'D+'FJ). H**6EF G0G 'D'3*+F'!'* CD'K EF '3*+F'!'* N E T . H'D'3*+F'!'* :J1 'DEO/'1) 'D*J *E *-HJDG' %DI '3*+F'!'* N E T . 9DI 3(JD 'DE+'D 3J*E %9'/) 71- '3*+F'! E1,9 'DE$41 'DA'1: 'DEH,H/ AJ 'D*9DJE'* 'D(1E,J) :J1 'DEO/'1) AJ 'D*9DJE'* 'D(1E,J) 'DEO/'1) 9DI GJ&) N E T S y s t e m . N u l l R e f e r e n c e E x c e p t i o n . -J+ J*6EF G0' 'D9/'/ CD'K EF 'D'3*+F'!'* 'DEO9'DN,) H:J1 'DEO9'DN,). J,( #F *-/+ 'D'3*+F'!'* AJ EH'BA F'/1) AB7 HDJ3 AJ 'D*/AB 'D9'/J DD*-CE AJ 'D(1F'E, HB/ *E *5EJE G0' 'D9/'/ CE$41 DE4'CD 'D#/'! 'DE-*ED) F*J,) DDE9/D 'DC(J1 ( #C(1 EF 1 0 0 +'FJ)) DD'3*+F'!'* 'D*J *E 71-G'. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
T O T A L _ E X C E P _ F I L T E R S _ R U N _ 0 0 1 _ N A M E = # o f F i l t e r s / s e c
T O T A L _ E X C E P _ F I L T E R S _ R U N _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// 9H'ED *5AJ) '3*+F'!'* N E T . 'D*J *E 71-G' AJ 'D+'FJ). HJBHE 9'ED *5AJ) 'D'3*+F'! (*BJJE E' %0' C'F J,( E9'D,) 'D'3*+F'! #E D'. J*9B( G0' 'D9/'/ E9/D 9H'ED *5AJ) 'D'3*+F'!'* 'D*J *E *BJJEG' (51A 'DF81 9E' %0' C'F B/ *E E9'D,) 'D'3*+F'! #E D'. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
T O T A L _ E X C E P _ F I N A L L Y S _ R U N _ 0 0 1 _ N A M E = # o f F i n a l l y s / s e c
T O T A L _ E X C E P _ F I N A L L Y S _ R U N _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// 9EDJ'* 'D*#EJF 'DFG'&J) 'D*J *E *FAJ0G' AJ 'D+'FJ). HEF 'DE$C/ *FAJ0 'D*#EJF 'DFG'&J (51A 'DF81 9F CJAJ) %FG'! E-'HD) 'D*#EJF. HD' J*E 9/Q %D' 9EDJ'* 'D*#EJF 'DFG'&J) 'D*J J*E *FAJ0G' EF #,D #-/ 'D'3*+F'!'* AB7 AD' J*E 9/Q 9EDJ'* 'D*#EJF 'DFG'&J) 9DI E3'1'* 'D*9DJE'* 'D(1E,J) 'D9'/J) (H'37) G0' 'D9/'/. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
E X C E P T _ S T A C K _ D E P T H _ 0 0 1 _ N A M E = T h r o w T o C a t c h D e p t h / s e c
E X C E P T _ S T A C K _ D E P T H _ 0 0 1 _ H E L P = J916 G0' 'D9/'/ 9// %7'1'* 'DEC/3 'D*J *E ',*J'2G' EF 'D%7'1 'D0J B'E (71- '3*+F'! N E T . %DI 'D%7'1 'D0J 9'D, 'D'3*+F'! AJ 'D+'FJ). **E %9'/) *9JJF G0' 'D9/'/ %DI 0 9F/ %/.'D #-/ E9'D,'* 'D'3*+F'!'* H(0DC 3HA *O8G1 'D'3*+F'!'* 'DE*/'.D) EB/'1 9EB 'DEC/3 EF E9'D, %DI 'DE9'D, 'D0J JDJG. HD' *CHF BJE) G0' 'D9/'/ BJE) E*H37 'DBJ'3'* .D'D 'DHB* AGH J916 'DA1B (JF 'DBJE 'D*J *E* ED'-8*G' AJ 'D9JF*JF 'D#.J1*JF EB3HEK' 9DI E/) 'DA'5D 'D2EFJ DD9JF).
D o t N e t C L R _ M e m o r y _ O B J E C T _ 8 0 4 _ N A M E = . N E T C L R M e m o r y
D o t N e t C L R _ M e m o r y _ O B J E C T _ 8 0 4 _ H E L P = C L R ƒW>WÞV6e„vX„v¡‹pehV0
G E N 0 _ C O L L E C T I O N S _ C O U N T E R _ 8 0 4 _ N A M E = # G e n 0 C o l l e c t i o n s
G E N 0 _ C O L L E C T I O N S _ C O U N T E R _ 8 0 4 _ H E L P = dk¡‹pehV>f:yê”^(uz^/T¨RåNegù[ 0 ãNù[aŒ( g°e„vÿ gÑRM‘„v) ÛLˆƒW>WÞV6e( G e n 0 G C ) „v!kpe0G e n 0 G C (W 0 ãN-N„vïS(u…QX[
N³åNán³RM‘÷‹Bl„v —‰öeÑSu0dk¡‹pehV(W G e n 0 G C Ó~_göežX0ƒØšãN„v G C Sìb@b gƒNOãN„v G C 0dk¡‹pehV(WƒØšãN( G e n 1 b G e n 2 ) G C ÑSuöe>f_žX0_ G l o b a l _ ¡‹pehVf:y
N N!k‰Km„v