diff --git a/.clang-format b/.clang-format
index a6079ec..312c052 100644
--- a/.clang-format
+++ b/.clang-format
@@ -1,5 +1,5 @@
-BasedOnStyle: Google
-ColumnLimit: 160
-UseTab: Always
-IndentWidth: 4
-TabWidth: 4
+BasedOnStyle: Google
+ColumnLimit: 160
+UseTab: Always
+IndentWidth: 4
+TabWidth: 4
diff --git a/.gitignore b/.gitignore
index 5d55158..9675354 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,57 +1,57 @@
-.cache/
-
-# Prerequisites
-*.d
-
-# Object files
-*.o
-*.ko
-*.obj
-*.elf
-
-# Linker output
-*.ilk
-*.map
-*.exp
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Libraries
-*.lib
-*.a
-*.la
-*.lo
-
-# Shared objects (inc. Windows DLLs)
-*.dll
-*.so
-*.so.*
-*.dylib
-
-# Executables
-*.exe
-*.out
-*.app
-*.i*86
-*.x86_64
-*.hex
-
-# Debug files
-*.dSYM/
-*.su
-*.idb
-*.pdb
-
-# Kernel Module Compile Results
-*.mod*
-*.cmd
-.tmp_versions/
-modules.order
-Module.symvers
-Mkfile.old
-dkms.conf
-
-# debug information files
-*.dwo
+.cache/
+
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+# debug information files
+*.dwo
diff --git a/LICENSE b/LICENSE
index f288702..3877ae0 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,674 +1,674 @@
- 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
-.
+ 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
+.
diff --git a/README.md b/README.md
index a79a22d..804dea9 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,13 @@
-# myclib
-
-**myclib** is a personal C library. This project is a work in progress and intended for educational use.
-It is not production-ready. Use at your own risk.
-
-## Features
-
-- Hashmaps - Thread-safe (MT Safe)
-- Dynamic strings - Thread-safe (MT Safe)
-- Circular Queue - Thread-safe (MT Safe)
-
-## Examples
-You can find examples inside `test/` folder.
+# myclib
+
+**myclib** is a personal C library. This project is a work in progress and intended for educational use.
+It is not production-ready. Use at your own risk.
+
+## Features
+
+- Hashmaps - Thread-safe (MT Safe)
+- Dynamic strings - Thread-safe (MT Safe)
+- Circular Queue - Thread-safe (MT Safe)
+
+## Examples
+You can find examples inside `test/` folder.
diff --git a/hashmap/myhashmap.c b/hashmap/myhashmap.c
index 5b5ba80..3f220c5 100644
--- a/hashmap/myhashmap.c
+++ b/hashmap/myhashmap.c
@@ -1,331 +1,331 @@
-#include "myhashmap.h"
-
-#include
-#include
-#include
-
-static size_t mcl_get_mutex(mcl_hashmap_s *hashmap, size_t hash) { return hash % hashmap->num_locks; }
-
-static size_t mcl_get_bucket_index(mcl_hashmap_s *hashmap, void *key) {
- unsigned int hash = hashmap->hash_fn(key);
- return hash % MYCLIB_HASHMAP_SIZE;
-}
-
-static void mcl_free_bucket_content(mcl_hashmap_s *hashmap, mcl_bucket_s *bucket) {
- if (bucket == NULL) {
- return;
- }
-
- /* Free key if free function is provided */
- if (hashmap->free_key_fn != NULL && bucket->key != NULL) {
- hashmap->free_key_fn(bucket->key);
- }
-
- /* Free value if free function is provided */
- if (hashmap->free_value_fn != NULL && bucket->value != NULL) {
- hashmap->free_value_fn(bucket->value);
- }
-}
-
-static mcl_bucket_s *mcl_find_bucket(mcl_hashmap_s *hashmap, void *key, mcl_bucket_s **prev) {
- size_t index = mcl_get_bucket_index(hashmap, key);
- mcl_bucket_s *bucket = &hashmap->map[index];
-
- *prev = NULL;
-
- /* Return NULL if first bucket is empty */
- if (bucket->key == NULL) {
- return NULL;
- }
-
- /* Search through the collision chain */
- while (bucket != NULL) {
- if (hashmap->equal_fn(bucket->key, key)) {
- return bucket;
- }
- *prev = bucket;
- bucket = bucket->next;
- }
-
- return NULL;
-}
-
-mcl_hashmap_s *mcl_hm_new(hash_f *hash_fn, equal_f *equal_fn, free_key_f *free_key_fn, free_value_f *free_value_fn, size_t key_size, size_t value_size) {
- mcl_hashmap_s *hashmap = malloc(sizeof(mcl_hashmap_s));
- if (hashmap == NULL) {
- return NULL;
- }
-
- hashmap->hash_fn = hash_fn;
- hashmap->equal_fn = equal_fn;
- hashmap->free_key_fn = free_key_fn;
- hashmap->free_value_fn = free_value_fn;
- hashmap->key_size = key_size;
- hashmap->value_size = value_size;
-
- hashmap->num_locks = 64;
- hashmap->locks = malloc(sizeof(mtx_t) * hashmap->num_locks);
- if (hashmap->locks == NULL) {
- free(hashmap);
-
- return NULL;
- }
-
- int ret;
- for (size_t i = 0; i < hashmap->num_locks; ++i) {
- ret = mtx_init(&(hashmap->locks[i]), mtx_plain);
- if (ret != thrd_success) {
- /* Mutex failed */
- for (size_t j = 0; j < i; ++j) {
- mtx_destroy(&(hashmap->locks[j]));
- }
-
- free(hashmap->locks);
- free(hashmap);
- }
- }
-
- memset(hashmap->map, 0, sizeof(hashmap->map));
-
- return hashmap;
-}
-
-void mcl_hm_free(mcl_hashmap_s *hashmap) {
- if (hashmap == NULL) {
- return;
- }
-
- /* Iterate through all buckets in the hash map */
- for (size_t i = 0; i < MYCLIB_HASHMAP_SIZE; ++i) {
- mcl_bucket_s *bucket = &hashmap->map[i];
-
- /* Free the first bucket if it contains data */
- if (bucket->key != NULL) {
- mcl_free_bucket_content(hashmap, bucket);
- }
-
- /* Free all chained buckets */
- bucket = bucket->next;
- while (bucket != NULL) {
- mcl_bucket_s *next = bucket->next;
- mcl_free_bucket_content(hashmap, bucket);
- free(bucket);
- bucket = next;
- }
- }
-
- /* Free the mutex */
- for (size_t i = 0; i < hashmap->num_locks; ++i) {
- mtx_destroy(&(hashmap->locks[i]));
- }
- free(hashmap->locks);
-
- /* Free the hash map structure itself */
- free(hashmap);
-}
-
-void mcl_hm_free_bucket(mcl_bucket_s *bucket) {
- if (bucket == NULL) {
- return;
- }
-
- free(bucket->key);
- free(bucket->value);
- free(bucket);
-}
-
-bool mcl_hm_set(mcl_hashmap_s *hashmap, void *key, void *value) {
- if (hashmap == NULL || key == NULL || value == NULL) {
- return false;
- }
-
- size_t mutex_id = mcl_get_mutex(hashmap, hashmap->hash_fn(key));
- mtx_t *mutex = &(hashmap->locks[mutex_id]);
- mtx_lock(mutex);
-
- mcl_bucket_s *prev;
- mcl_bucket_s *existing = mcl_find_bucket(hashmap, key, &prev);
-
- if (existing != NULL) {
- /* Key exists, update value */
- if (hashmap->free_value_fn != NULL && existing->value != NULL) {
- hashmap->free_value_fn(existing->value);
- }
-
- existing->value = malloc(hashmap->value_size);
- if (existing->value == NULL) {
- mtx_unlock(mutex);
-
- return false;
- }
-
- memcpy(existing->value, value, hashmap->value_size);
- mtx_unlock(mutex);
-
- return true;
- }
-
- /* Key doesn't exist, need to insert new bucket */
- size_t index = mcl_get_bucket_index(hashmap, key);
- mcl_bucket_s *bucket = &hashmap->map[index];
-
- if (bucket->key == NULL) {
- /* First bucket is empty, use it */
- bucket->key = malloc(hashmap->key_size);
- if (bucket->key == NULL) {
- mtx_unlock(mutex);
-
- return false;
- }
-
- bucket->value = malloc(hashmap->value_size);
- if (bucket->value == NULL) {
- free(bucket->key);
- bucket->key = NULL;
- mtx_unlock(mutex);
-
- return false;
- }
-
- memcpy(bucket->key, key, hashmap->key_size);
- memcpy(bucket->value, value, hashmap->value_size);
- bucket->next = NULL;
- mtx_unlock(mutex);
-
- return true;
- }
-
- /* Create new bucket and insert at head of collision chain */
- mcl_bucket_s *new_bucket = malloc(sizeof(mcl_bucket_s));
- if (new_bucket == NULL) {
- mtx_unlock(mutex);
-
- return false;
- }
-
- new_bucket->key = malloc(hashmap->key_size);
- if (new_bucket->key == NULL) {
- free(new_bucket);
- mtx_unlock(mutex);
-
- return false;
- }
-
- new_bucket->value = malloc(hashmap->value_size);
- if (new_bucket->value == NULL) {
- free(new_bucket->key);
- free(new_bucket);
- mtx_unlock(mutex);
-
- return false;
- }
-
- memcpy(new_bucket->key, key, hashmap->key_size);
- memcpy(new_bucket->value, value, hashmap->value_size);
- new_bucket->next = bucket->next;
- bucket->next = new_bucket;
-
- mtx_unlock(mutex);
-
- return true;
-}
-
-static mcl_bucket_s *mcl_get_bucket_copy(mcl_bucket_s *from, size_t key_size, size_t value_size) {
- mcl_bucket_s *copy = malloc(sizeof(mcl_bucket_s));
- if (copy == NULL) {
- return NULL;
- }
- memcpy(copy, from, sizeof(mcl_bucket_s));
-
- copy->key = malloc(key_size);
- if (copy->key == NULL) {
- free(copy);
-
- return NULL;
- }
- memcpy(copy->key, from->key, key_size);
-
- copy->value = malloc(value_size);
- if (copy->value == NULL) {
- free(copy->key);
- free(copy);
-
- return NULL;
- }
- memcpy(copy->value, from->value, value_size);
-
- return copy;
-}
-
-mcl_bucket_s *mcl_hm_get(mcl_hashmap_s *hashmap, void *key) {
- if (hashmap == NULL || key == NULL) {
- return NULL;
- }
-
- size_t mutex_id = mcl_get_mutex(hashmap, hashmap->hash_fn(key));
- mtx_t *mutex = &(hashmap->locks[mutex_id]);
- mtx_lock(mutex);
-
- mcl_bucket_s *prev;
- mcl_bucket_s *found = mcl_find_bucket(hashmap, key, &prev);
-
- if (found) {
- mcl_bucket_s *copy = mcl_get_bucket_copy(found, hashmap->key_size, hashmap->value_size);
-
- mtx_unlock(mutex);
-
- return copy;
- }
-
- mtx_unlock(mutex);
-
- return NULL;
-}
-
-bool mcl_hm_remove(mcl_hashmap_s *hashmap, void *key) {
- if (hashmap == NULL || key == NULL) {
- return false;
- }
-
- size_t mutex_id = mcl_get_mutex(hashmap, hashmap->hash_fn(key));
- mtx_t *mutex = &(hashmap->locks[mutex_id]);
- mtx_lock(mutex);
-
- mcl_bucket_s *prev;
- mcl_bucket_s *to_remove = mcl_find_bucket(hashmap, key, &prev);
-
- if (to_remove == NULL) {
- mtx_unlock(mutex);
-
- return false;
- }
-
- /* Free the content of the bucket */
- mcl_free_bucket_content(hashmap, to_remove);
-
- /* Handle removal based on position in chain */
- if (prev == NULL) {
- /* Removing first bucket in chain */
- if (to_remove->next != NULL) {
- /* Move next bucket's content to first bucket and free the next bucket */
- mcl_bucket_s *next_bucket = to_remove->next;
- to_remove->key = next_bucket->key;
- to_remove->value = next_bucket->value;
- to_remove->next = next_bucket->next;
- free(next_bucket);
- } else {
- /* No next bucket, mark first bucket as empty */
- to_remove->key = NULL;
- to_remove->value = NULL;
- to_remove->next = NULL;
- }
- } else {
- /* Removing bucket from middle/end of chain */
- prev->next = to_remove->next;
- free(to_remove);
- }
-
- mtx_unlock(mutex);
-
- return true;
-}
+#include "myhashmap.h"
+
+#include
+#include
+#include
+
+static size_t mcl_get_mutex(mcl_hashmap_s *hashmap, size_t hash) { return hash % hashmap->num_locks; }
+
+static size_t mcl_get_bucket_index(mcl_hashmap_s *hashmap, void *key) {
+ unsigned int hash = hashmap->hash_fn(key);
+ return hash % MYCLIB_HASHMAP_SIZE;
+}
+
+static void mcl_free_bucket_content(mcl_hashmap_s *hashmap, mcl_bucket_s *bucket) {
+ if (bucket == NULL) {
+ return;
+ }
+
+ /* Free key if free function is provided */
+ if (hashmap->free_key_fn != NULL && bucket->key != NULL) {
+ hashmap->free_key_fn(bucket->key);
+ }
+
+ /* Free value if free function is provided */
+ if (hashmap->free_value_fn != NULL && bucket->value != NULL) {
+ hashmap->free_value_fn(bucket->value);
+ }
+}
+
+static mcl_bucket_s *mcl_find_bucket(mcl_hashmap_s *hashmap, void *key, mcl_bucket_s **prev) {
+ size_t index = mcl_get_bucket_index(hashmap, key);
+ mcl_bucket_s *bucket = &hashmap->map[index];
+
+ *prev = NULL;
+
+ /* Return NULL if first bucket is empty */
+ if (bucket->key == NULL) {
+ return NULL;
+ }
+
+ /* Search through the collision chain */
+ while (bucket != NULL) {
+ if (hashmap->equal_fn(bucket->key, key)) {
+ return bucket;
+ }
+ *prev = bucket;
+ bucket = bucket->next;
+ }
+
+ return NULL;
+}
+
+mcl_hashmap_s *mcl_hm_new(hash_f *hash_fn, equal_f *equal_fn, free_key_f *free_key_fn, free_value_f *free_value_fn, size_t key_size, size_t value_size) {
+ mcl_hashmap_s *hashmap = malloc(sizeof(mcl_hashmap_s));
+ if (hashmap == NULL) {
+ return NULL;
+ }
+
+ hashmap->hash_fn = hash_fn;
+ hashmap->equal_fn = equal_fn;
+ hashmap->free_key_fn = free_key_fn;
+ hashmap->free_value_fn = free_value_fn;
+ hashmap->key_size = key_size;
+ hashmap->value_size = value_size;
+
+ hashmap->num_locks = 64;
+ hashmap->locks = malloc(sizeof(mtx_t) * hashmap->num_locks);
+ if (hashmap->locks == NULL) {
+ free(hashmap);
+
+ return NULL;
+ }
+
+ int ret;
+ for (size_t i = 0; i < hashmap->num_locks; ++i) {
+ ret = mtx_init(&(hashmap->locks[i]), mtx_plain);
+ if (ret != thrd_success) {
+ /* Mutex failed */
+ for (size_t j = 0; j < i; ++j) {
+ mtx_destroy(&(hashmap->locks[j]));
+ }
+
+ free(hashmap->locks);
+ free(hashmap);
+ }
+ }
+
+ memset(hashmap->map, 0, sizeof(hashmap->map));
+
+ return hashmap;
+}
+
+void mcl_hm_free(mcl_hashmap_s *hashmap) {
+ if (hashmap == NULL) {
+ return;
+ }
+
+ /* Iterate through all buckets in the hash map */
+ for (size_t i = 0; i < MYCLIB_HASHMAP_SIZE; ++i) {
+ mcl_bucket_s *bucket = &hashmap->map[i];
+
+ /* Free the first bucket if it contains data */
+ if (bucket->key != NULL) {
+ mcl_free_bucket_content(hashmap, bucket);
+ }
+
+ /* Free all chained buckets */
+ bucket = bucket->next;
+ while (bucket != NULL) {
+ mcl_bucket_s *next = bucket->next;
+ mcl_free_bucket_content(hashmap, bucket);
+ free(bucket);
+ bucket = next;
+ }
+ }
+
+ /* Free the mutex */
+ for (size_t i = 0; i < hashmap->num_locks; ++i) {
+ mtx_destroy(&(hashmap->locks[i]));
+ }
+ free(hashmap->locks);
+
+ /* Free the hash map structure itself */
+ free(hashmap);
+}
+
+void mcl_hm_free_bucket(mcl_bucket_s *bucket) {
+ if (bucket == NULL) {
+ return;
+ }
+
+ free(bucket->key);
+ free(bucket->value);
+ free(bucket);
+}
+
+bool mcl_hm_set(mcl_hashmap_s *hashmap, void *key, void *value) {
+ if (hashmap == NULL || key == NULL || value == NULL) {
+ return false;
+ }
+
+ size_t mutex_id = mcl_get_mutex(hashmap, hashmap->hash_fn(key));
+ mtx_t *mutex = &(hashmap->locks[mutex_id]);
+ mtx_lock(mutex);
+
+ mcl_bucket_s *prev;
+ mcl_bucket_s *existing = mcl_find_bucket(hashmap, key, &prev);
+
+ if (existing != NULL) {
+ /* Key exists, update value */
+ if (hashmap->free_value_fn != NULL && existing->value != NULL) {
+ hashmap->free_value_fn(existing->value);
+ }
+
+ existing->value = malloc(hashmap->value_size);
+ if (existing->value == NULL) {
+ mtx_unlock(mutex);
+
+ return false;
+ }
+
+ memcpy(existing->value, value, hashmap->value_size);
+ mtx_unlock(mutex);
+
+ return true;
+ }
+
+ /* Key doesn't exist, need to insert new bucket */
+ size_t index = mcl_get_bucket_index(hashmap, key);
+ mcl_bucket_s *bucket = &hashmap->map[index];
+
+ if (bucket->key == NULL) {
+ /* First bucket is empty, use it */
+ bucket->key = malloc(hashmap->key_size);
+ if (bucket->key == NULL) {
+ mtx_unlock(mutex);
+
+ return false;
+ }
+
+ bucket->value = malloc(hashmap->value_size);
+ if (bucket->value == NULL) {
+ free(bucket->key);
+ bucket->key = NULL;
+ mtx_unlock(mutex);
+
+ return false;
+ }
+
+ memcpy(bucket->key, key, hashmap->key_size);
+ memcpy(bucket->value, value, hashmap->value_size);
+ bucket->next = NULL;
+ mtx_unlock(mutex);
+
+ return true;
+ }
+
+ /* Create new bucket and insert at head of collision chain */
+ mcl_bucket_s *new_bucket = malloc(sizeof(mcl_bucket_s));
+ if (new_bucket == NULL) {
+ mtx_unlock(mutex);
+
+ return false;
+ }
+
+ new_bucket->key = malloc(hashmap->key_size);
+ if (new_bucket->key == NULL) {
+ free(new_bucket);
+ mtx_unlock(mutex);
+
+ return false;
+ }
+
+ new_bucket->value = malloc(hashmap->value_size);
+ if (new_bucket->value == NULL) {
+ free(new_bucket->key);
+ free(new_bucket);
+ mtx_unlock(mutex);
+
+ return false;
+ }
+
+ memcpy(new_bucket->key, key, hashmap->key_size);
+ memcpy(new_bucket->value, value, hashmap->value_size);
+ new_bucket->next = bucket->next;
+ bucket->next = new_bucket;
+
+ mtx_unlock(mutex);
+
+ return true;
+}
+
+static mcl_bucket_s *mcl_get_bucket_copy(mcl_bucket_s *from, size_t key_size, size_t value_size) {
+ mcl_bucket_s *copy = malloc(sizeof(mcl_bucket_s));
+ if (copy == NULL) {
+ return NULL;
+ }
+ memcpy(copy, from, sizeof(mcl_bucket_s));
+
+ copy->key = malloc(key_size);
+ if (copy->key == NULL) {
+ free(copy);
+
+ return NULL;
+ }
+ memcpy(copy->key, from->key, key_size);
+
+ copy->value = malloc(value_size);
+ if (copy->value == NULL) {
+ free(copy->key);
+ free(copy);
+
+ return NULL;
+ }
+ memcpy(copy->value, from->value, value_size);
+
+ return copy;
+}
+
+mcl_bucket_s *mcl_hm_get(mcl_hashmap_s *hashmap, void *key) {
+ if (hashmap == NULL || key == NULL) {
+ return NULL;
+ }
+
+ size_t mutex_id = mcl_get_mutex(hashmap, hashmap->hash_fn(key));
+ mtx_t *mutex = &(hashmap->locks[mutex_id]);
+ mtx_lock(mutex);
+
+ mcl_bucket_s *prev;
+ mcl_bucket_s *found = mcl_find_bucket(hashmap, key, &prev);
+
+ if (found) {
+ mcl_bucket_s *copy = mcl_get_bucket_copy(found, hashmap->key_size, hashmap->value_size);
+
+ mtx_unlock(mutex);
+
+ return copy;
+ }
+
+ mtx_unlock(mutex);
+
+ return NULL;
+}
+
+bool mcl_hm_remove(mcl_hashmap_s *hashmap, void *key) {
+ if (hashmap == NULL || key == NULL) {
+ return false;
+ }
+
+ size_t mutex_id = mcl_get_mutex(hashmap, hashmap->hash_fn(key));
+ mtx_t *mutex = &(hashmap->locks[mutex_id]);
+ mtx_lock(mutex);
+
+ mcl_bucket_s *prev;
+ mcl_bucket_s *to_remove = mcl_find_bucket(hashmap, key, &prev);
+
+ if (to_remove == NULL) {
+ mtx_unlock(mutex);
+
+ return false;
+ }
+
+ /* Free the content of the bucket */
+ mcl_free_bucket_content(hashmap, to_remove);
+
+ /* Handle removal based on position in chain */
+ if (prev == NULL) {
+ /* Removing first bucket in chain */
+ if (to_remove->next != NULL) {
+ /* Move next bucket's content to first bucket and free the next bucket */
+ mcl_bucket_s *next_bucket = to_remove->next;
+ to_remove->key = next_bucket->key;
+ to_remove->value = next_bucket->value;
+ to_remove->next = next_bucket->next;
+ free(next_bucket);
+ } else {
+ /* No next bucket, mark first bucket as empty */
+ to_remove->key = NULL;
+ to_remove->value = NULL;
+ to_remove->next = NULL;
+ }
+ } else {
+ /* Removing bucket from middle/end of chain */
+ prev->next = to_remove->next;
+ free(to_remove);
+ }
+
+ mtx_unlock(mutex);
+
+ return true;
+}
diff --git a/hashmap/myhashmap.h b/hashmap/myhashmap.h
index 891fa4d..c969d77 100644
--- a/hashmap/myhashmap.h
+++ b/hashmap/myhashmap.h
@@ -1,143 +1,143 @@
-#ifndef MYCLIB_HASHMAP_H
-#define MYCLIB_HASHMAP_H
-
-#include
-#include
-#include
-
-#define MYCLIB_HASHMAP_SIZE 1024 /**< Number of buckets in the hash map */
-
-/**
- * @brief A single bucket in the hash map
- *
- * Each bucket can hold one key-value pair and points to the next bucket
- * in case of hash collisions (separate chaining).
- */
-typedef struct mcl_bucket {
- void *key; /**< Pointer to the key */
- void *value; /**< Pointer to the value */
- struct mcl_bucket *next; /**< Pointer to the next bucket in case of collision */
-} mcl_bucket_s;
-
-/**
- * @brief Function pointer type for a hash function
- *
- * @param[in] key Pointer to the key to hash
- * @return The computed hash as an unsigned integer
- */
-typedef unsigned int hash_f(const void *key);
-
-/**
- * @brief Function pointer type for a key comparison function
- *
- * @param[in] key_a Pointer to the first key
- * @param[in] key_b Pointer to the second key
- * @return true if the keys are considered equal, false otherwise
- */
-typedef bool equal_f(const void *key_a, const void *key_b);
-
-/**
- * @brief Function pointer type for freeing a key
- *
- * @param[in] key Pointer to the key to free
- */
-typedef void free_key_f(void *key);
-
-/**
- * @brief Function pointer type for freeing a value
- *
- * @param[in] value Pointer to the value to free
- */
-typedef void free_value_f(void *value);
-
-/**
- * @brief Main structure representing the hash map
- *
- * Contains function pointers for hash computation, key comparison,
- * and memory management, along with the bucket array.
- */
-typedef struct mcl_hashmap {
- hash_f *hash_fn; /**< Hash function */
- equal_f *equal_fn; /**< Equality comparison function */
- free_key_f *free_key_fn; /**< Key deallocation function (optional) */
- free_value_f *free_value_fn; /**< Value deallocation function (optional) */
- size_t key_size; /**< Size in bytes of the key */
- size_t value_size; /**< Size in bytes of the value */
- mcl_bucket_s map[MYCLIB_HASHMAP_SIZE]; /**< Array of bucket chains */
- mtx_t *locks; /**< Mutex array */
- size_t num_locks; /**< Number of mutex */
-} mcl_hashmap_s;
-
-/**
- * @brief Initialize a new hash map with user-defined behavior functions
- *
- * Creates a new hash map and initializes it with the provided function pointers.
- * The free functions can be NULL if no automatic memory management is needed.
- * Keys and values will be copied into the hashmap using memcpy with the specified sizes.
- *
- * @param[in] hash_fn Function used to hash keys (required)
- * @param[in] equal_fn Function used to compare keys (required)
- * @param[in] free_key_fn Function used to free keys (optional, can be NULL)
- * @param[in] free_value_fn Function used to free values (optional, can be NULL)
- * @param[in] key_size Size in bytes of each key to be stored
- * @param[in] value_size Size in bytes of each value to be stored
- * @return A pointer to the newly initialized hash map, or NULL on failure
- */
-mcl_hashmap_s *mcl_hm_new(hash_f *hash_fn, equal_f *equal_fn, free_key_f *free_key_fn, free_value_f *free_value_fn, size_t key_size, size_t value_size);
-
-/**
- * @brief Free all resources used by the hash map
- *
- * Iterates through all buckets, frees keys and values using the provided
- * free functions (if not NULL), and deallocates the hash map structure.
- *
- * @param[in] hashmap Pointer to the hash map to free
- */
-void mcl_hm_free(mcl_hashmap_s *hashmap);
-
-/**
- * @brief Free a bucket returned by mcl_hm_get()
- *
- * @param[in] bucket Pointer to the bucket to free
- */
-void mcl_hm_free_bucket(mcl_bucket_s *bucket);
-
-/**
- * @brief Insert or update a key-value pair in the hash map
- *
- * If the key already exists, the old value is freed (if free_value_fn is provided)
- * and replaced with the new value. If the key doesn't exist, a new entry is created.
- * Both key and value are copied into the hashmap using memcpy.
- *
- * @param[in] hashmap Pointer to the hash map
- * @param[in] key Pointer to the key to insert (will be copied, must not be NULL)
- * @param[in] value Pointer to the value to insert (will be copied, must not be NULL)
- * @return true if the operation succeeded, false on failure (NULL hashmap/key/value or memory allocation failure)
- */
-bool mcl_hm_set(mcl_hashmap_s *hashmap, void *key, void *value);
-
-/**
- * @brief Retrieve a bucket by key
- *
- * Searches for the given key in the hash map and returns the bucket containing it.
- * The caller can then access both the key and value from the returned bucket.
- *
- * @param[in] hashmap Pointer to the hash map
- * @param[in] key Pointer to the key to search for
- * @return Pointer to the copy of the bucket, to avoid race conditions, or NULL if not found or on invalid input
- */
-mcl_bucket_s *mcl_hm_get(mcl_hashmap_s *hashmap, void *key);
-
-/**
- * @brief Remove a key-value pair from the hash map
- *
- * Searches for the given key and removes it from the hash map. Both the key
- * and value are freed using the provided free functions (if not NULL).
- *
- * @param[in] hashmap Pointer to the hash map
- * @param[in] key Pointer to the key to remove
- * @return true if the key was found and removed, false if not found or on invalid input
- */
-bool mcl_hm_remove(mcl_hashmap_s *hashmap, void *key);
-
-#endif /* MYCLIB_HASHMAP_H */
+#ifndef MYCLIB_HASHMAP_H
+#define MYCLIB_HASHMAP_H
+
+#include
+#include
+#include
+
+#define MYCLIB_HASHMAP_SIZE 1024 /**< Number of buckets in the hash map */
+
+/**
+ * @brief A single bucket in the hash map
+ *
+ * Each bucket can hold one key-value pair and points to the next bucket
+ * in case of hash collisions (separate chaining).
+ */
+typedef struct mcl_bucket {
+ void *key; /**< Pointer to the key */
+ void *value; /**< Pointer to the value */
+ struct mcl_bucket *next; /**< Pointer to the next bucket in case of collision */
+} mcl_bucket_s;
+
+/**
+ * @brief Function pointer type for a hash function
+ *
+ * @param[in] key Pointer to the key to hash
+ * @return The computed hash as an unsigned integer
+ */
+typedef unsigned int hash_f(const void *key);
+
+/**
+ * @brief Function pointer type for a key comparison function
+ *
+ * @param[in] key_a Pointer to the first key
+ * @param[in] key_b Pointer to the second key
+ * @return true if the keys are considered equal, false otherwise
+ */
+typedef bool equal_f(const void *key_a, const void *key_b);
+
+/**
+ * @brief Function pointer type for freeing a key
+ *
+ * @param[in] key Pointer to the key to free
+ */
+typedef void free_key_f(void *key);
+
+/**
+ * @brief Function pointer type for freeing a value
+ *
+ * @param[in] value Pointer to the value to free
+ */
+typedef void free_value_f(void *value);
+
+/**
+ * @brief Main structure representing the hash map
+ *
+ * Contains function pointers for hash computation, key comparison,
+ * and memory management, along with the bucket array.
+ */
+typedef struct mcl_hashmap {
+ hash_f *hash_fn; /**< Hash function */
+ equal_f *equal_fn; /**< Equality comparison function */
+ free_key_f *free_key_fn; /**< Key deallocation function (optional) */
+ free_value_f *free_value_fn; /**< Value deallocation function (optional) */
+ size_t key_size; /**< Size in bytes of the key */
+ size_t value_size; /**< Size in bytes of the value */
+ mcl_bucket_s map[MYCLIB_HASHMAP_SIZE]; /**< Array of bucket chains */
+ mtx_t *locks; /**< Mutex array */
+ size_t num_locks; /**< Number of mutex */
+} mcl_hashmap_s;
+
+/**
+ * @brief Initialize a new hash map with user-defined behavior functions
+ *
+ * Creates a new hash map and initializes it with the provided function pointers.
+ * The free functions can be NULL if no automatic memory management is needed.
+ * Keys and values will be copied into the hashmap using memcpy with the specified sizes.
+ *
+ * @param[in] hash_fn Function used to hash keys (required)
+ * @param[in] equal_fn Function used to compare keys (required)
+ * @param[in] free_key_fn Function used to free keys (optional, can be NULL)
+ * @param[in] free_value_fn Function used to free values (optional, can be NULL)
+ * @param[in] key_size Size in bytes of each key to be stored
+ * @param[in] value_size Size in bytes of each value to be stored
+ * @return A pointer to the newly initialized hash map, or NULL on failure
+ */
+mcl_hashmap_s *mcl_hm_new(hash_f *hash_fn, equal_f *equal_fn, free_key_f *free_key_fn, free_value_f *free_value_fn, size_t key_size, size_t value_size);
+
+/**
+ * @brief Free all resources used by the hash map
+ *
+ * Iterates through all buckets, frees keys and values using the provided
+ * free functions (if not NULL), and deallocates the hash map structure.
+ *
+ * @param[in] hashmap Pointer to the hash map to free
+ */
+void mcl_hm_free(mcl_hashmap_s *hashmap);
+
+/**
+ * @brief Free a bucket returned by mcl_hm_get()
+ *
+ * @param[in] bucket Pointer to the bucket to free
+ */
+void mcl_hm_free_bucket(mcl_bucket_s *bucket);
+
+/**
+ * @brief Insert or update a key-value pair in the hash map
+ *
+ * If the key already exists, the old value is freed (if free_value_fn is provided)
+ * and replaced with the new value. If the key doesn't exist, a new entry is created.
+ * Both key and value are copied into the hashmap using memcpy.
+ *
+ * @param[in] hashmap Pointer to the hash map
+ * @param[in] key Pointer to the key to insert (will be copied, must not be NULL)
+ * @param[in] value Pointer to the value to insert (will be copied, must not be NULL)
+ * @return true if the operation succeeded, false on failure (NULL hashmap/key/value or memory allocation failure)
+ */
+bool mcl_hm_set(mcl_hashmap_s *hashmap, void *key, void *value);
+
+/**
+ * @brief Retrieve a bucket by key
+ *
+ * Searches for the given key in the hash map and returns the bucket containing it.
+ * The caller can then access both the key and value from the returned bucket.
+ *
+ * @param[in] hashmap Pointer to the hash map
+ * @param[in] key Pointer to the key to search for
+ * @return Pointer to the copy of the bucket, to avoid race conditions, or NULL if not found or on invalid input
+ */
+mcl_bucket_s *mcl_hm_get(mcl_hashmap_s *hashmap, void *key);
+
+/**
+ * @brief Remove a key-value pair from the hash map
+ *
+ * Searches for the given key and removes it from the hash map. Both the key
+ * and value are freed using the provided free functions (if not NULL).
+ *
+ * @param[in] hashmap Pointer to the hash map
+ * @param[in] key Pointer to the key to remove
+ * @return true if the key was found and removed, false if not found or on invalid input
+ */
+bool mcl_hm_remove(mcl_hashmap_s *hashmap, void *key);
+
+#endif /* MYCLIB_HASHMAP_H */
diff --git a/meson.build b/meson.build
index 8466426..2d90872 100644
--- a/meson.build
+++ b/meson.build
@@ -1,26 +1,26 @@
-project(
- 'testlib',
- 'c',
- version: '0.1',
- default_options: ['c_std=c17'],
-)
-
-src = files(
- 'hashmap/myhashmap.c',
- 'queue/myqueue.c',
- 'string/mystring.c',
-)
-
-testlib = files(
- 'test/test.c',
- 'test/hashmap/hm1.c',
- 'test/queue/q1.c',
- 'test/string/str1.c',
- 'test/string/str2.c',
-)
-
-sources = src + testlib
-
-inc_dir = include_directories('string', 'queue', 'hashmap')
-
-executable('testlib', sources, include_directories: inc_dir)
+project(
+ 'testlib',
+ 'c',
+ version: '0.1',
+ default_options: ['c_std=c17'],
+)
+
+src = files(
+ 'hashmap/myhashmap.c',
+ 'queue/myqueue.c',
+ 'string/mystring.c',
+)
+
+testlib = files(
+ 'test/test.c',
+ 'test/hashmap/hm1.c',
+ 'test/queue/q1.c',
+ 'test/string/str1.c',
+ 'test/string/str2.c',
+)
+
+sources = src + testlib
+
+inc_dir = include_directories('string', 'queue', 'hashmap')
+
+executable('testlib', sources, include_directories: inc_dir)
diff --git a/native_cl.ini b/native_cl.ini
index d9e3a03..86ccda5 100644
--- a/native_cl.ini
+++ b/native_cl.ini
@@ -1,4 +1,4 @@
-[binaries]
-c = 'cl'
-cpp = 'cl'
-ar = 'lib'
+[binaries]
+c = 'cl'
+cpp = 'cl'
+ar = 'lib'
diff --git a/queue/myqueue.c b/queue/myqueue.c
index 6ed331f..837ecf1 100644
--- a/queue/myqueue.c
+++ b/queue/myqueue.c
@@ -1,141 +1,141 @@
-#include "myqueue.h"
-
-#include
-#include
-
-mcl_queue_s *mcl_queue_new(size_t queue_size, size_t elem_size) {
- mcl_queue_s *queue = malloc(sizeof(mcl_queue_s));
- if (queue == NULL) {
- return NULL;
- }
-
- queue->buffer = malloc(queue_size * elem_size);
- if (queue->buffer == NULL) {
- free(queue);
-
- return NULL;
- }
-
- int ret = mtx_init(&queue->lock, mtx_plain);
- if (ret != thrd_success) {
- free(queue->buffer);
- free(queue);
-
- return NULL;
- }
-
- queue->front = 0;
- queue->rear = 0;
- queue->size = 0;
- queue->capacity = queue_size;
- queue->elem_size = elem_size;
-
- return queue;
-}
-
-int mcl_queue_push(mcl_queue_s *queue, const void *elem) {
- int ret = mtx_lock(&queue->lock);
- if (ret != thrd_success) {
- return -1;
- }
-
- if (queue->size == queue->capacity) {
- /* Queue full */
- mtx_unlock(&queue->lock);
-
- return -1;
- }
-
- /* Copy the elem in the buffer */
- void *dest = (char *)queue->buffer + (queue->rear * queue->elem_size);
- memcpy(dest, elem, queue->elem_size);
-
- queue->size++;
- queue->rear = (queue->rear + 1) % queue->capacity;
-
- mtx_unlock(&queue->lock);
-
- return 0;
-}
-
-int mcl_queue_pop(mcl_queue_s *queue, void *out_elem) {
- int ret = mtx_lock(&queue->lock);
- if (ret != thrd_success) {
- return -1;
- }
-
- if (queue->size == 0) {
- /* Queue empty */
- mtx_unlock(&queue->lock);
-
- return -1;
- }
-
- void *src = (char *)queue->buffer + (queue->front * queue->elem_size);
- memcpy(out_elem, src, queue->elem_size);
-
- queue->front = (queue->front + 1) % queue->capacity;
- queue->size--;
-
- mtx_unlock(&queue->lock);
-
- return 0;
-}
-
-int mcl_queue_get_front(mcl_queue_s *queue, void *out) {
- int ret = mtx_lock(&queue->lock);
- if (ret != thrd_success) {
- return -1;
- }
-
- if (queue->size == 0) {
- mtx_unlock(&queue->lock);
-
- return -1;
- }
-
- void *front = (char *)queue->buffer + (queue->front * queue->elem_size);
- memcpy(out, front, queue->elem_size);
-
- mtx_unlock(&queue->lock);
-
- return 0;
-}
-
-int mcl_queue_get_rear(mcl_queue_s *queue, void *out) {
- int ret = mtx_lock(&queue->lock);
- if (ret != thrd_success) {
- return -1;
- }
-
- if (queue->size == 0) {
- mtx_unlock(&queue->lock);
-
- return -1;
- }
-
- size_t rear_index;
- if (queue->rear == 0) {
- rear_index = queue->capacity - 1;
- } else {
- rear_index = queue->rear - 1;
- }
-
- void *rear = (char *)queue->buffer + (rear_index * queue->elem_size);
- memcpy(out, rear, queue->elem_size);
-
- mtx_unlock(&queue->lock);
-
- return 0;
-}
-
-void mcl_queue_free(mcl_queue_s *queue) {
- if (queue == NULL) {
- return;
- }
-
- mtx_destroy(&queue->lock);
-
- free(queue->buffer);
- free(queue);
-}
+#include "myqueue.h"
+
+#include
+#include
+
+mcl_queue_s *mcl_queue_new(size_t queue_size, size_t elem_size) {
+ mcl_queue_s *queue = malloc(sizeof(mcl_queue_s));
+ if (queue == NULL) {
+ return NULL;
+ }
+
+ queue->buffer = malloc(queue_size * elem_size);
+ if (queue->buffer == NULL) {
+ free(queue);
+
+ return NULL;
+ }
+
+ int ret = mtx_init(&queue->lock, mtx_plain);
+ if (ret != thrd_success) {
+ free(queue->buffer);
+ free(queue);
+
+ return NULL;
+ }
+
+ queue->front = 0;
+ queue->rear = 0;
+ queue->size = 0;
+ queue->capacity = queue_size;
+ queue->elem_size = elem_size;
+
+ return queue;
+}
+
+int mcl_queue_push(mcl_queue_s *queue, const void *elem) {
+ int ret = mtx_lock(&queue->lock);
+ if (ret != thrd_success) {
+ return -1;
+ }
+
+ if (queue->size == queue->capacity) {
+ /* Queue full */
+ mtx_unlock(&queue->lock);
+
+ return -1;
+ }
+
+ /* Copy the elem in the buffer */
+ void *dest = (char *)queue->buffer + (queue->rear * queue->elem_size);
+ memcpy(dest, elem, queue->elem_size);
+
+ queue->size++;
+ queue->rear = (queue->rear + 1) % queue->capacity;
+
+ mtx_unlock(&queue->lock);
+
+ return 0;
+}
+
+int mcl_queue_pop(mcl_queue_s *queue, void *out_elem) {
+ int ret = mtx_lock(&queue->lock);
+ if (ret != thrd_success) {
+ return -1;
+ }
+
+ if (queue->size == 0) {
+ /* Queue empty */
+ mtx_unlock(&queue->lock);
+
+ return -1;
+ }
+
+ void *src = (char *)queue->buffer + (queue->front * queue->elem_size);
+ memcpy(out_elem, src, queue->elem_size);
+
+ queue->front = (queue->front + 1) % queue->capacity;
+ queue->size--;
+
+ mtx_unlock(&queue->lock);
+
+ return 0;
+}
+
+int mcl_queue_get_front(mcl_queue_s *queue, void *out) {
+ int ret = mtx_lock(&queue->lock);
+ if (ret != thrd_success) {
+ return -1;
+ }
+
+ if (queue->size == 0) {
+ mtx_unlock(&queue->lock);
+
+ return -1;
+ }
+
+ void *front = (char *)queue->buffer + (queue->front * queue->elem_size);
+ memcpy(out, front, queue->elem_size);
+
+ mtx_unlock(&queue->lock);
+
+ return 0;
+}
+
+int mcl_queue_get_rear(mcl_queue_s *queue, void *out) {
+ int ret = mtx_lock(&queue->lock);
+ if (ret != thrd_success) {
+ return -1;
+ }
+
+ if (queue->size == 0) {
+ mtx_unlock(&queue->lock);
+
+ return -1;
+ }
+
+ size_t rear_index;
+ if (queue->rear == 0) {
+ rear_index = queue->capacity - 1;
+ } else {
+ rear_index = queue->rear - 1;
+ }
+
+ void *rear = (char *)queue->buffer + (rear_index * queue->elem_size);
+ memcpy(out, rear, queue->elem_size);
+
+ mtx_unlock(&queue->lock);
+
+ return 0;
+}
+
+void mcl_queue_free(mcl_queue_s *queue) {
+ if (queue == NULL) {
+ return;
+ }
+
+ mtx_destroy(&queue->lock);
+
+ free(queue->buffer);
+ free(queue);
+}
diff --git a/queue/myqueue.h b/queue/myqueue.h
index d59ec64..c3f6a64 100644
--- a/queue/myqueue.h
+++ b/queue/myqueue.h
@@ -1,72 +1,72 @@
-#ifndef MYCLIB_QUEUE_H
-#define MYCLIB_QUEUE_H
-
-#include
-#include
-
-/**
- * @brief A simple circular queue (ring buffer).
- */
-typedef struct mcl_queue {
- size_t front; /**< Index of the next element to read. */
- size_t rear; /**< Index where the next element will be written. */
- size_t size; /**< Current number of elements in the queue. */
- size_t capacity; /**< Maximum number of elements the queue can hold. */
- size_t elem_size; /**< Size in bytes of each element. */
- void *buffer; /**< Memory buffer that holds the elements. */
- mtx_t lock; /**< Mutex to protect concurrent access. */
-} mcl_queue_s;
-
-/**
- * @brief Create and initialize a new queue.
- *
- * @param queue_size Number of elements the queue can hold.
- * @param elem_size Size in bytes of each element.
- * @return Pointer to the new queue, or NULL on failure.
- */
-mcl_queue_s *mcl_queue_new(size_t queue_size, size_t elem_size);
-
-/**
- * @brief Add an element to the queue.
- *
- * @param queue Pointer to the queue.
- * @param elem Pointer to the data to add.
- * @return 0 on success, -1 if the queue is full or on error.
- */
-int mcl_queue_push(mcl_queue_s *queue, const void *elem);
-
-/**
- * @brief Remove an element from the queue.
- *
- * @param queue Pointer to the queue.
- * @param out_elem Pointer to memory where the removed element will be copied.
- * @return 0 on success, -1 if the queue is empty or on error.
- */
-int mcl_queue_pop(mcl_queue_s *queue, void *out_elem);
-
-/**
- * @brief Copy the front element without removing it.
- *
- * @param queue Pointer to the queue.
- * @param out Pointer to memory where the element will be copied.
- * @return 0 on success, -1 if the queue is empty or on error.
- */
-int mcl_queue_get_front(mcl_queue_s *queue, void *out);
-
-/**
- * @brief Copy the last element without removing it.
- *
- * @param queue Pointer to the queue.
- * @param out Pointer to memory where the element will be copied.
- * @return 0 on success, -1 if the queue is empty or on error.
- */
-int mcl_queue_get_rear(mcl_queue_s *queue, void *out);
-
-/**
- * @brief Free all resources used by the queue.
- *
- * @param queue Pointer to the queue to free.
- */
-void mcl_queue_free(mcl_queue_s *queue);
-
-#endif // MYCLIB_QUEUE_H
+#ifndef MYCLIB_QUEUE_H
+#define MYCLIB_QUEUE_H
+
+#include
+#include
+
+/**
+ * @brief A simple circular queue (ring buffer).
+ */
+typedef struct mcl_queue {
+ size_t front; /**< Index of the next element to read. */
+ size_t rear; /**< Index where the next element will be written. */
+ size_t size; /**< Current number of elements in the queue. */
+ size_t capacity; /**< Maximum number of elements the queue can hold. */
+ size_t elem_size; /**< Size in bytes of each element. */
+ void *buffer; /**< Memory buffer that holds the elements. */
+ mtx_t lock; /**< Mutex to protect concurrent access. */
+} mcl_queue_s;
+
+/**
+ * @brief Create and initialize a new queue.
+ *
+ * @param queue_size Number of elements the queue can hold.
+ * @param elem_size Size in bytes of each element.
+ * @return Pointer to the new queue, or NULL on failure.
+ */
+mcl_queue_s *mcl_queue_new(size_t queue_size, size_t elem_size);
+
+/**
+ * @brief Add an element to the queue.
+ *
+ * @param queue Pointer to the queue.
+ * @param elem Pointer to the data to add.
+ * @return 0 on success, -1 if the queue is full or on error.
+ */
+int mcl_queue_push(mcl_queue_s *queue, const void *elem);
+
+/**
+ * @brief Remove an element from the queue.
+ *
+ * @param queue Pointer to the queue.
+ * @param out_elem Pointer to memory where the removed element will be copied.
+ * @return 0 on success, -1 if the queue is empty or on error.
+ */
+int mcl_queue_pop(mcl_queue_s *queue, void *out_elem);
+
+/**
+ * @brief Copy the front element without removing it.
+ *
+ * @param queue Pointer to the queue.
+ * @param out Pointer to memory where the element will be copied.
+ * @return 0 on success, -1 if the queue is empty or on error.
+ */
+int mcl_queue_get_front(mcl_queue_s *queue, void *out);
+
+/**
+ * @brief Copy the last element without removing it.
+ *
+ * @param queue Pointer to the queue.
+ * @param out Pointer to memory where the element will be copied.
+ * @return 0 on success, -1 if the queue is empty or on error.
+ */
+int mcl_queue_get_rear(mcl_queue_s *queue, void *out);
+
+/**
+ * @brief Free all resources used by the queue.
+ *
+ * @param queue Pointer to the queue to free.
+ */
+void mcl_queue_free(mcl_queue_s *queue);
+
+#endif // MYCLIB_QUEUE_H
diff --git a/string/mystring.c b/string/mystring.c
index bcb8aa5..da2096f 100644
--- a/string/mystring.c
+++ b/string/mystring.c
@@ -1,321 +1,339 @@
-#include "mystring.h"
-
-#include
-#include
-#include
-#include
-#include
-
-/* Initialize Thread-Specific Storage */
-
-static tss_t buffer_key;
-static once_flag buffer_once = ONCE_FLAG_INIT;
-
-typedef struct {
- char *buf; /**< Allocated buffer */
- size_t cap; /**< Buffer's capacity */
-} tl_buffer_s;
-
-static void buffer_destructor(void *buf) {
- tl_buffer_s *tb = (tl_buffer_s *)buf;
- if (tb == NULL) {
- return;
- }
- free(tb->buf);
- free(tb);
-}
-
-static void buffer_key_init(void) { tss_create(&buffer_key, buffer_destructor); }
-
-/* Returns the next power of two of a number */
-static size_t next_power_two(size_t len) {
- if (len == 0) return 1;
-
- size_t p = 1;
- while (p < len) {
- if (p > SIZE_MAX / 2) {
- p = len;
- break;
- }
- p <<= 1;
- }
-
- return p;
-}
-
-mcl_string_s *mcl_string_new(const char *text, size_t initial_capacity) {
- if (text == NULL) {
- return NULL;
- }
-
- mcl_string_s *str = malloc(sizeof(mcl_string_s));
- if (str == NULL) {
- return NULL;
- }
-
- str->size = strlen(text);
-
- if (initial_capacity != 0 && initial_capacity < (str->size + 1)) {
- /* Can't allocate with this capacity */
- free(str);
-
- return NULL;
- }
-
- size_t capacity = initial_capacity;
- if (capacity == 0) {
- /* Calculate the needed capacity */
- capacity = next_power_two(str->size + 1);
- }
-
- str->capacity = capacity;
-
- /* Allocate data (text) buffer */
- str->data = malloc(str->capacity);
- if (str->data == NULL) {
- free(str);
-
- return NULL;
- }
-
- /* Copy the text and ensure null termination */
- memcpy(str->data, text, str->size);
- str->data[str->size] = '\0';
-
- /* Init mutex */
- if (mtx_init(&str->lock, mtx_plain) != thrd_success) {
- free(str->data);
- free(str);
-
- return NULL;
- }
-
- return str;
-}
-
-int mcl_string_append(mcl_string_s *string, const char *text) {
- if (string == NULL || text == NULL) {
- return -1;
- }
-
- if (mtx_lock(&string->lock) != thrd_success) {
- return -1;
- }
-
- /* Handle empty case */
- size_t text_len = strlen(text);
- if (text_len == 0) {
- mtx_unlock(&string->lock);
-
- return 0;
- }
-
- size_t new_size = string->size + text_len;
-
- /* Check if we need to resize */
- if (new_size + 1 > string->capacity) {
- size_t new_capacity = next_power_two(new_size + 1);
- /* Reallocate the buffer */
- void *new_data = realloc(string->data, new_capacity);
- if (!new_data) {
- mtx_unlock(&string->lock);
-
- return -1;
- }
-
- string->data = new_data;
- string->capacity = new_capacity;
- }
-
- /* Append text */
- memcpy(string->data + string->size, text, text_len);
- string->size = new_size;
- string->data[string->size] = '\0';
-
- mtx_unlock(&string->lock);
-
- return 0;
-}
-
-int mcl_string_extend(mcl_string_s *destination, mcl_string_s *source) {
- /* TODO */
-
- return 0;
-}
-
-void mcl_string_free(mcl_string_s *string) {
- if (string == NULL) {
- return;
- }
-
- if (string->data) {
- free(string->data);
- }
-
- mtx_destroy(&string->lock);
-
- free(string);
-}
-
-size_t mcl_string_length(mcl_string_s *string) {
- if (string == NULL) {
- return 0;
- }
-
- if (mtx_lock(&string->lock) != thrd_success) {
- return 0;
- }
-
- size_t len = string->size;
-
- mtx_unlock(&string->lock);
-
- return len;
-}
-
-size_t mcl_string_capacity(mcl_string_s *string) {
- if (string == NULL) {
- return 0;
- }
-
- if (mtx_lock(&string->lock) != thrd_success) {
- return 0;
- }
-
- size_t cap = string->capacity;
-
- mtx_unlock(&string->lock);
-
- return cap;
-}
-
-char *mcl_string_cstr(mcl_string_s *string) {
- if (string == NULL || string->data == NULL) {
- return NULL;
- }
-
- call_once(&buffer_once, buffer_key_init);
-
- if (mtx_lock(&string->lock) != thrd_success) {
- return NULL;
- }
-
- size_t need = string->size + 1;
-
- /* Retrieve thread local buffer */
- tl_buffer_s *tb = (tl_buffer_s *)tss_get(buffer_key);
- if (tb == NULL) {
- /* Not found, make a new one */
- tb = malloc(sizeof(*tb));
- if (tb == NULL) {
- mtx_unlock(&string->lock);
-
- return NULL;
- }
-
- tb->cap = next_power_two(need);
- tb->buf = malloc(tb->cap);
- if (tb->buf == NULL) {
- free(tb);
- mtx_unlock(&string->lock);
-
- return NULL;
- }
-
- if (tss_set(buffer_key, tb) != thrd_success) {
- free(tb->buf);
- free(tb);
- mtx_unlock(&string->lock);
-
- return NULL;
- }
- } else if (tb->cap < need) {
- /* Found, but we need a bigger buffer */
- size_t newcap = next_power_two(need);
- char *tmp = realloc(tb->buf, newcap);
- if (tmp == NULL) {
- mtx_unlock(&string->lock);
-
- return NULL;
- }
-
- tb->buf = tmp;
- tb->cap = newcap;
- }
-
- memcpy(tb->buf, string->data, need);
-
- mtx_unlock(&string->lock);
-
- return tb->buf;
-}
-
-int mcl_string_compare(mcl_string_s *s1, mcl_string_s *s2) {
- if (s1 == NULL || s2 == NULL) {
- return -123;
- }
-
- if (mtx_lock(&s1->lock) != thrd_success) {
- return -123;
- }
-
- if (mtx_lock(&s2->lock) != thrd_success) {
- mtx_unlock(&s1->lock);
-
- return -123;
- }
-
- int ret = strcmp(s1->data, s2->data);
-
- mtx_unlock(&s1->lock);
- mtx_unlock(&s2->lock);
-
- return ret;
-}
-
-void mcl_string_clear(mcl_string_s *string) {
- if (string == NULL) {
- return;
- }
-
- if (mtx_lock(&string->lock) != thrd_success) {
- return;
- }
-
- memset(string->data, 0, string->size);
- string->size = 0;
-
- mtx_unlock(&string->lock);
-}
-
-void mcl_string_toupper(mcl_string_s *string) {
- if (string == NULL) {
- return;
- }
-
- if (mtx_lock(&string->lock) != thrd_success) {
- return;
- }
-
- for (size_t i = 0; i < string->size; ++i) {
- string->data[i] = (char)toupper((unsigned char)string->data[i]);
- }
-
- mtx_unlock(&string->lock);
-}
-
-void mcl_string_tolower(mcl_string_s *string) {
- if (string == NULL) {
- return;
- }
-
- if (mtx_lock(&string->lock) != thrd_success) {
- return;
- }
-
- for (size_t i = 0; i < string->size; ++i) {
- string->data[i] = (char)tolower((unsigned char)string->data[i]);
- }
-
- mtx_unlock(&string->lock);
-}
+#include "mystring.h"
+
+#include
+#include
+#include
+#include
+#include
+
+/* Initialize Thread-Specific Storage */
+
+static tss_t buffer_key;
+static once_flag buffer_once = ONCE_FLAG_INIT;
+
+typedef struct {
+ char *buf; /**< Allocated buffer */
+ size_t cap; /**< Buffer's capacity */
+} tl_buffer_s;
+
+static void buffer_destructor(void *buf) {
+ tl_buffer_s *tb = (tl_buffer_s *)buf;
+ if (tb == NULL) {
+ return;
+ }
+ free(tb->buf);
+ free(tb);
+}
+
+static void buffer_key_init(void) { tss_create(&buffer_key, buffer_destructor); }
+
+/* Returns the next power of two of a number */
+static size_t next_power_two(size_t len) {
+ if (len == 0) return 1;
+
+ size_t p = 1;
+ while (p < len) {
+ if (p > SIZE_MAX / 2) {
+ p = len;
+ break;
+ }
+ p <<= 1;
+ }
+
+ return p;
+}
+
+mcl_string_s *mcl_string_new(const char *text, size_t initial_capacity) {
+ if (text == NULL) {
+ return NULL;
+ }
+
+ mcl_string_s *str = malloc(sizeof(mcl_string_s));
+ if (str == NULL) {
+ return NULL;
+ }
+
+ str->size = strlen(text);
+
+ if (initial_capacity != 0 && initial_capacity < (str->size + 1)) {
+ /* Can't allocate with this capacity */
+ free(str);
+
+ return NULL;
+ }
+
+ size_t capacity = initial_capacity;
+ if (capacity == 0) {
+ /* Calculate the needed capacity */
+ capacity = next_power_two(str->size + 1);
+ }
+
+ str->capacity = capacity;
+
+ /* Allocate data (text) buffer */
+ str->data = malloc(str->capacity);
+ if (str->data == NULL) {
+ free(str);
+
+ return NULL;
+ }
+
+ /* Copy the text and ensure null termination */
+ memcpy(str->data, text, str->size);
+ str->data[str->size] = '\0';
+
+ /* Init mutex */
+ if (mtx_init(&str->lock, mtx_plain) != thrd_success) {
+ free(str->data);
+ free(str);
+
+ return NULL;
+ }
+
+ return str;
+}
+
+int mcl_string_append(mcl_string_s *string, const char *text) {
+ if (string == NULL || text == NULL) {
+ return -1;
+ }
+
+ if (mtx_lock(&string->lock) != thrd_success) {
+ return -1;
+ }
+
+ /* Handle empty case */
+ size_t text_len = strlen(text);
+ if (text_len == 0) {
+ mtx_unlock(&string->lock);
+
+ return 0;
+ }
+
+ size_t new_size = string->size + text_len;
+
+ /* Check if we need to resize */
+ if (new_size + 1 > string->capacity) {
+ size_t new_capacity = next_power_two(new_size + 1);
+ /* Reallocate the buffer */
+ void *new_data = realloc(string->data, new_capacity);
+ if (!new_data) {
+ mtx_unlock(&string->lock);
+
+ return -1;
+ }
+
+ string->data = new_data;
+ string->capacity = new_capacity;
+ }
+
+ /* Append text */
+ memcpy(string->data + string->size, text, text_len);
+ string->size = new_size;
+ string->data[string->size] = '\0';
+
+ mtx_unlock(&string->lock);
+
+ return 0;
+}
+
+int mcl_string_extend(mcl_string_s *destination, mcl_string_s *source) {
+ if (destination == NULL || source == NULL) {
+ return -1;
+ }
+
+ size_t need = destination->size + source->size;
+ if (need > destination->capacity) {
+ /* Reallocate destination data buffer */
+ destination->capacity = next_power_two(need);
+ char *tmp = realloc(destination->data, destination->capacity);
+ if (tmp == NULL) {
+ return -1;
+ }
+ destination->data = tmp;
+ }
+
+ /* Copy memory from source data buffer */
+ memcpy(destination->data + destination->size, source->data, source->size);
+ destination->size = need;
+ destination->data[destination->size] = '\0';
+
+ return 0;
+}
+
+void mcl_string_free(mcl_string_s *string) {
+ if (string == NULL) {
+ return;
+ }
+
+ if (string->data) {
+ free(string->data);
+ }
+
+ mtx_destroy(&string->lock);
+
+ free(string);
+}
+
+size_t mcl_string_length(mcl_string_s *string) {
+ if (string == NULL) {
+ return 0;
+ }
+
+ if (mtx_lock(&string->lock) != thrd_success) {
+ return 0;
+ }
+
+ size_t len = string->size;
+
+ mtx_unlock(&string->lock);
+
+ return len;
+}
+
+size_t mcl_string_capacity(mcl_string_s *string) {
+ if (string == NULL) {
+ return 0;
+ }
+
+ if (mtx_lock(&string->lock) != thrd_success) {
+ return 0;
+ }
+
+ size_t cap = string->capacity;
+
+ mtx_unlock(&string->lock);
+
+ return cap;
+}
+
+char *mcl_string_cstr(mcl_string_s *string) {
+ if (string == NULL || string->data == NULL) {
+ return NULL;
+ }
+
+ call_once(&buffer_once, buffer_key_init);
+
+ if (mtx_lock(&string->lock) != thrd_success) {
+ return NULL;
+ }
+
+ size_t need = string->size + 1;
+
+ /* Retrieve thread local buffer */
+ tl_buffer_s *tb = (tl_buffer_s *)tss_get(buffer_key);
+ if (tb == NULL) {
+ /* Not found, make a new one */
+ tb = malloc(sizeof(*tb));
+ if (tb == NULL) {
+ mtx_unlock(&string->lock);
+
+ return NULL;
+ }
+
+ tb->cap = next_power_two(need);
+ tb->buf = malloc(tb->cap);
+ if (tb->buf == NULL) {
+ free(tb);
+ mtx_unlock(&string->lock);
+
+ return NULL;
+ }
+
+ if (tss_set(buffer_key, tb) != thrd_success) {
+ free(tb->buf);
+ free(tb);
+ mtx_unlock(&string->lock);
+
+ return NULL;
+ }
+ } else if (tb->cap < need) {
+ /* Found, but we need a bigger buffer */
+ size_t newcap = next_power_two(need);
+ char *tmp = realloc(tb->buf, newcap);
+ if (tmp == NULL) {
+ mtx_unlock(&string->lock);
+
+ return NULL;
+ }
+
+ tb->buf = tmp;
+ tb->cap = newcap;
+ }
+
+ memcpy(tb->buf, string->data, need);
+
+ mtx_unlock(&string->lock);
+
+ return tb->buf;
+}
+
+int mcl_string_compare(mcl_string_s *s1, mcl_string_s *s2) {
+ if (s1 == NULL || s2 == NULL) {
+ return -123;
+ }
+
+ if (mtx_lock(&s1->lock) != thrd_success) {
+ return -123;
+ }
+
+ if (mtx_lock(&s2->lock) != thrd_success) {
+ mtx_unlock(&s1->lock);
+
+ return -123;
+ }
+
+ int ret = strcmp(s1->data, s2->data);
+
+ mtx_unlock(&s1->lock);
+ mtx_unlock(&s2->lock);
+
+ return ret;
+}
+
+void mcl_string_clear(mcl_string_s *string) {
+ if (string == NULL) {
+ return;
+ }
+
+ if (mtx_lock(&string->lock) != thrd_success) {
+ return;
+ }
+
+ memset(string->data, 0, string->size);
+ string->size = 0;
+
+ mtx_unlock(&string->lock);
+}
+
+void mcl_string_toupper(mcl_string_s *string) {
+ if (string == NULL) {
+ return;
+ }
+
+ if (mtx_lock(&string->lock) != thrd_success) {
+ return;
+ }
+
+ for (size_t i = 0; i < string->size; ++i) {
+ string->data[i] = (char)toupper((unsigned char)string->data[i]);
+ }
+
+ mtx_unlock(&string->lock);
+}
+
+void mcl_string_tolower(mcl_string_s *string) {
+ if (string == NULL) {
+ return;
+ }
+
+ if (mtx_lock(&string->lock) != thrd_success) {
+ return;
+ }
+
+ for (size_t i = 0; i < string->size; ++i) {
+ string->data[i] = (char)tolower((unsigned char)string->data[i]);
+ }
+
+ mtx_unlock(&string->lock);
+}
diff --git a/string/mystring.h b/string/mystring.h
index aa2e192..3dbbce5 100644
--- a/string/mystring.h
+++ b/string/mystring.h
@@ -1,108 +1,119 @@
-#ifndef MYCLIB_STRING_H
-#define MYCLIB_STRING_H
-
-#include
-#include
-
-/**
- * @brief Thread-safe dynamic string structure.
- */
-typedef struct mcl_string {
- char *data; /**< Pointer to null-terminated string data */
- size_t size; /**< Current length (excluding null terminator) */
- size_t capacity; /**< Allocated capacity including null terminator */
- mtx_t lock; /**< Mutex for thread safety */
-} mcl_string_s;
-
-/**
- * @brief Create a new string initialized with the given text.
- *
- * @param text Initial text.
- * @param initial_capacity Initial buffer capacity (including null terminator). Pass 0 to auto-calculate.
- * @return Pointer to the new string, or NULL on failure.
- */
-mcl_string_s *mcl_string_new(const char *text, size_t initial_capacity);
-
-/**
- * @brief Free the string and its resources.
- *
- * @param string String to free (safe to call with NULL).
- */
-void mcl_string_free(mcl_string_s *string);
-
-/**
- * @brief Append text to the string.
- *
- * @param string String to modify.
- * @param text Text to append.
- * @return 0 on success, -1 on failure.
- */
-int mcl_string_append(mcl_string_s *string, const char *text);
-
-/**
- * @brief Extend by adding another string.
- *
- * @param destination Destination string.
- * @param source Source string.
- * @return 0 on success, -1 on failure.
- */
-int mcl_string_extend(mcl_string_s *destination, mcl_string_s *source);
-
-/**
- * @brief Clear the string content without freeing the memory.
- *
- * @param string String to clear.
- */
-void mcl_string_clear(mcl_string_s *string);
-
-/**
- * @brief Get the current length of the string.
- *
- * @param string String to query.
- * @return Length excluding null terminator, or 0 if NULL.
- */
-size_t mcl_string_length(mcl_string_s *string);
-
-/**
- * @brief Get the total allocated capacity of the string buffer.
- *
- * @param string String to query.
- * @return Capacity in bytes (including null terminator), or 0 if NULL.
- */
-size_t mcl_string_capacity(mcl_string_s *string);
-
-/**
- * @brief Get a pointer to a null-terminated C-string.
- *
- * @param string String to read.
- * @return Pointer to a thread-local buffer, or NULL on failure.
- *
- * @note Valid until the next call in the same thread. Do NOT free the returned pointer.
- * Do NOT call more than once this function in a print function.
- */
-char *mcl_string_cstr(mcl_string_s *string);
-
-/**
- * @brief Compare two strings.
- *
- * @param s1 First string.
- * @param s2 Second string.
- * @return -123 on failure or same as strcmp().
- */
-int mcl_string_compare(mcl_string_s *s1, mcl_string_s *s2);
-
-/**
- * @brief Convert the string to uppercase.
- *
- * @param string String to modify.
- */
-void mcl_string_toupper(mcl_string_s *string);
-
-/**
- * @brief Convert the string to lowercase.
- *
- * @param string String to modify.
- */
-void mcl_string_tolower(mcl_string_s *string);
-
-#endif /* MYCLIB_STRING_H */
+#ifndef MYCLIB_STRING_H
+#define MYCLIB_STRING_H
+
+#include
+#include
+
+/**
+ * @brief Thread-safe dynamic string structure.
+ */
+typedef struct mcl_string {
+ char *data; /**< Pointer to null-terminated string data */
+ size_t size; /**< Current length (excluding null terminator) */
+ size_t capacity; /**< Allocated capacity including null terminator */
+ mtx_t lock; /**< Mutex for thread safety */
+} mcl_string_s;
+
+/**
+ * @brief Create a new string initialized with the given text.
+ *
+ * @param text Initial text.
+ * @param initial_capacity Initial buffer capacity (including null terminator). Pass 0 to auto-calculate.
+ * @return Pointer to the new string, or NULL on failure.
+ */
+mcl_string_s *mcl_string_new(const char *text, size_t initial_capacity);
+
+/**
+ * @brief Free the string and its resources.
+ *
+ * @param string String to free (safe to call with NULL).
+ */
+void mcl_string_free(mcl_string_s *string);
+
+/**
+ * @brief Append text to the string.
+ *
+ * @param string String to modify.
+ * @param text Text to append.
+ * @return 0 on success, -1 on failure.
+ */
+int mcl_string_append(mcl_string_s *string, const char *text);
+
+/**
+ * @brief Extend by adding another string.
+ *
+ * @param destination Destination string.
+ * @param source Source string.
+ * @return 0 on success, -1 on failure.
+ */
+int mcl_string_extend(mcl_string_s *destination, mcl_string_s *source);
+
+/**
+ * @brief Clear the string content without freeing the memory.
+ *
+ * @param string String to clear.
+ */
+void mcl_string_clear(mcl_string_s *string);
+
+/**
+ * @brief Get the current length of the string.
+ *
+ * @param string String to query.
+ * @return Length excluding null terminator, or 0 if NULL.
+ */
+size_t mcl_string_length(mcl_string_s *string);
+
+/**
+ * @brief Get the total allocated capacity of the string buffer.
+ *
+ * @param string String to query.
+ * @return Capacity in bytes (including null terminator), or 0 if NULL.
+ */
+size_t mcl_string_capacity(mcl_string_s *string);
+
+/**
+ * @brief Get a pointer to a null-terminated C-string.
+ *
+ * @param string String to read.
+ * @return Pointer to a thread-local buffer, or NULL on failure.
+ *
+ * @note Valid until the next call in the same thread. Do NOT free the returned pointer.
+ * Do NOT call more than once this function in a print function.
+ */
+char *mcl_string_cstr(mcl_string_s *string);
+
+/**
+ * @brief Compare two strings.
+ *
+ * @param s1 First string.
+ * @param s2 Second string.
+ * @return -123 on failure or same as strcmp().
+ */
+int mcl_string_compare(mcl_string_s *s1, mcl_string_s *s2);
+
+/**
+ * @brief Convert the string to uppercase.
+ *
+ * @param string String to modify.
+ */
+void mcl_string_toupper(mcl_string_s *string);
+
+/**
+ * @brief Convert the string to lowercase.
+ *
+ * @param string String to modify.
+ */
+void mcl_string_tolower(mcl_string_s *string);
+
+/**
+ * @brief Find a substring inside a string.
+ *
+ * @param string String where to search.
+ * @param substring Substring to search.
+ * @return Index of the first occurrence, -1 on failure.
+ *
+ * @note TODO
+ */
+int mcl_string_find(mcl_string_s *string, const char *substring);
+
+#endif /* MYCLIB_STRING_H */
diff --git a/test/hashmap/hm1.c b/test/hashmap/hm1.c
index e44fdbc..d9d4730 100644
--- a/test/hashmap/hm1.c
+++ b/test/hashmap/hm1.c
@@ -1,90 +1,90 @@
-#include
-#include
-#include
-#include
-
-#include "../../hashmap/myhashmap.h"
-
-#define MAX_STR_LEN 64
-
-/* My custom data type stored as value */
-struct my_custom_type {
- int age;
- char favourite_brand[MAX_STR_LEN];
-};
-
-/* Let's hash our name */
-static unsigned int my_hash_func(const void *key) {
- char *name = (char *)key;
- size_t len = strlen(name);
-
- unsigned int hash = 0;
- for (size_t i = 0; i < len; ++i) {
- hash += (int)name[i];
- }
-
- return hash % 2069;
-}
-
-/* Let's write our compare function */
-bool my_equal_fun(const void *key_a, const void *key_b) {
- char *name_a = (char *)key_a;
- char *name_b = (char *)key_b;
-
- if (strcmp(name_a, name_b) == 0) {
- return true;
- }
-
- return false;
-}
-
-/* And our last two functions, the free key and value called inside mcl_hm_remove() */
-void my_free_key(void *key) { free(key); }
-
-void my_free_value(void *value) {
- struct my_custom_type *mct = (struct my_custom_type *)value;
-
- free(mct);
-}
-
-void test_hm1(void) {
- /* Allocate a new hashmap */
- /* Pass your custom hash, equal and free functions */
- /* This hashmap will contain names as keys and a custom type as value */
- size_t key_size = sizeof(char) * MAX_STR_LEN;
- size_t value_size = sizeof(int) + sizeof(char) * MAX_STR_LEN;
- mcl_hashmap_s *map = mcl_hm_new(my_hash_func, my_equal_fun, my_free_key, my_free_value, key_size, value_size);
- assert(map != NULL);
-
- /* Make a new value */
- struct my_custom_type p1 = {
- .age = 21,
- };
- strncpy(p1.favourite_brand, "Ferrari", sizeof(p1.favourite_brand));
-
- /* Insert a new pair */
- assert(mcl_hm_set(map, "John", &p1));
-
- /* Retrieve the data */
- /* Remember to free the value from the get function */
- mcl_bucket_s *john = mcl_hm_get(map, "John");
- assert(john != NULL);
-
- char *name = (char *)john->key;
- struct my_custom_type *john_v = (struct my_custom_type *)john->value;
- int age = john_v->age;
- char *fav_brand = john_v->favourite_brand;
-
- assert(strcmp(name, "John") == 0);
- assert(age == 21);
- assert(strcmp(fav_brand, "Ferrari") == 0);
-
- /* Free the bucket */
- mcl_hm_free_bucket(john);
-
- /* Remove a key from hash map */
- assert(mcl_hm_remove(map, "John"));
-
- /* Deallocate */
- mcl_hm_free(map);
-}
+#include
+#include
+#include
+#include
+
+#include "../../hashmap/myhashmap.h"
+
+#define MAX_STR_LEN 64
+
+/* My custom data type stored as value */
+struct my_custom_type {
+ int age;
+ char favourite_brand[MAX_STR_LEN];
+};
+
+/* Let's hash our name */
+static unsigned int my_hash_func(const void *key) {
+ char *name = (char *)key;
+ size_t len = strlen(name);
+
+ unsigned int hash = 0;
+ for (size_t i = 0; i < len; ++i) {
+ hash += (int)name[i];
+ }
+
+ return hash % 2069;
+}
+
+/* Let's write our compare function */
+bool my_equal_fun(const void *key_a, const void *key_b) {
+ char *name_a = (char *)key_a;
+ char *name_b = (char *)key_b;
+
+ if (strcmp(name_a, name_b) == 0) {
+ return true;
+ }
+
+ return false;
+}
+
+/* And our last two functions, the free key and value called inside mcl_hm_remove() */
+void my_free_key(void *key) { free(key); }
+
+void my_free_value(void *value) {
+ struct my_custom_type *mct = (struct my_custom_type *)value;
+
+ free(mct);
+}
+
+void test_hm1(void) {
+ /* Allocate a new hashmap */
+ /* Pass your custom hash, equal and free functions */
+ /* This hashmap will contain names as keys and a custom type as value */
+ size_t key_size = sizeof(char) * MAX_STR_LEN;
+ size_t value_size = sizeof(int) + sizeof(char) * MAX_STR_LEN;
+ mcl_hashmap_s *map = mcl_hm_new(my_hash_func, my_equal_fun, my_free_key, my_free_value, key_size, value_size);
+ assert(map != NULL);
+
+ /* Make a new value */
+ struct my_custom_type p1 = {
+ .age = 21,
+ };
+ strncpy(p1.favourite_brand, "Ferrari", sizeof(p1.favourite_brand));
+
+ /* Insert a new pair */
+ assert(mcl_hm_set(map, "John", &p1));
+
+ /* Retrieve the data */
+ /* Remember to free the value from the get function */
+ mcl_bucket_s *john = mcl_hm_get(map, "John");
+ assert(john != NULL);
+
+ char *name = (char *)john->key;
+ struct my_custom_type *john_v = (struct my_custom_type *)john->value;
+ int age = john_v->age;
+ char *fav_brand = john_v->favourite_brand;
+
+ assert(strcmp(name, "John") == 0);
+ assert(age == 21);
+ assert(strcmp(fav_brand, "Ferrari") == 0);
+
+ /* Free the bucket */
+ mcl_hm_free_bucket(john);
+
+ /* Remove a key from hash map */
+ assert(mcl_hm_remove(map, "John"));
+
+ /* Deallocate */
+ mcl_hm_free(map);
+}
diff --git a/test/queue/q1.c b/test/queue/q1.c
index 69411e0..3d8287e 100644
--- a/test/queue/q1.c
+++ b/test/queue/q1.c
@@ -1,48 +1,48 @@
-#include
-
-#include "../../queue/myqueue.h"
-
-void test_q1(void) {
- /* Allocate a new queue */
- mcl_queue_s *queue = mcl_queue_new(3, sizeof(int));
- assert(queue != NULL);
-
- int val, out;
-
- /* Push value to the ring buffer */
- val = 1;
- assert(mcl_queue_push(queue, &val) == 0);
-
- val = 2;
- assert(mcl_queue_push(queue, &val) == 0);
-
- /* Retrieve values */
- int front, rear;
- assert(mcl_queue_get_front(queue, &front) == 0);
- assert(mcl_queue_get_rear(queue, &rear) == 0);
- assert(front == 1);
- assert(rear == 2);
-
- /* Remove an element from the buffer */
- assert(mcl_queue_pop(queue, &out) == 0);
- assert(out == 1);
-
- assert(mcl_queue_get_front(queue, &front) == 0);
- assert(front == 2);
-
- val = 3;
- assert(mcl_queue_push(queue, &val) == 0);
-
- assert(mcl_queue_get_rear(queue, &rear) == 0);
- assert(rear == 3);
-
- val = 4;
- assert(mcl_queue_push(queue, &val) == 0);
-
- /* Clear queue */
- while (mcl_queue_pop(queue, &out) == 0) {}
- assert(queue->size == 0);
-
- /* Deallocate memory */
- mcl_queue_free(queue);
-}
+#include
+
+#include "../../queue/myqueue.h"
+
+void test_q1(void) {
+ /* Allocate a new queue */
+ mcl_queue_s *queue = mcl_queue_new(3, sizeof(int));
+ assert(queue != NULL);
+
+ int val, out;
+
+ /* Push value to the ring buffer */
+ val = 1;
+ assert(mcl_queue_push(queue, &val) == 0);
+
+ val = 2;
+ assert(mcl_queue_push(queue, &val) == 0);
+
+ /* Retrieve values */
+ int front, rear;
+ assert(mcl_queue_get_front(queue, &front) == 0);
+ assert(mcl_queue_get_rear(queue, &rear) == 0);
+ assert(front == 1);
+ assert(rear == 2);
+
+ /* Remove an element from the buffer */
+ assert(mcl_queue_pop(queue, &out) == 0);
+ assert(out == 1);
+
+ assert(mcl_queue_get_front(queue, &front) == 0);
+ assert(front == 2);
+
+ val = 3;
+ assert(mcl_queue_push(queue, &val) == 0);
+
+ assert(mcl_queue_get_rear(queue, &rear) == 0);
+ assert(rear == 3);
+
+ val = 4;
+ assert(mcl_queue_push(queue, &val) == 0);
+
+ /* Clear queue */
+ while (mcl_queue_pop(queue, &out) == 0) {}
+ assert(queue->size == 0);
+
+ /* Deallocate memory */
+ mcl_queue_free(queue);
+}
diff --git a/test/string/str1.c b/test/string/str1.c
index 36924e8..d07b0c1 100644
--- a/test/string/str1.c
+++ b/test/string/str1.c
@@ -1,37 +1,37 @@
-#include
-#include
-#include
-#include
-
-#include "../../string/mystring.h"
-
-void test_str1(void) {
- size_t length;
- size_t capacity;
- char *c_str;
-
- /* Allocate a new dynamic string with an initial capacity */
- mcl_string_s *str = mcl_string_new("Hello, world!", 512);
- assert(str != NULL);
-
- /* Retrieve a C str from string with mcl_string_cstr() */
- c_str = mcl_string_cstr(str);
- length = mcl_string_length(str);
- capacity = mcl_string_capacity(str);
- assert(strcmp(c_str, "Hello, world!") == 0);
- assert(length == 13);
- assert(capacity == 512);
-
- /* Append text to a mcl_string */
- assert(mcl_string_append(str, " How are you?") == 0);
-
- c_str = mcl_string_cstr(str);
- length = mcl_string_length(str);
- capacity = mcl_string_capacity(str);
- assert(strcmp(c_str, "Hello, world! How are you?") == 0);
- assert(length == 26);
- assert(capacity == 512);
-
- /* Always deallocate memory */
- mcl_string_free(str);
-}
+#include
+#include
+#include
+#include
+
+#include "../../string/mystring.h"
+
+void test_str1(void) {
+ size_t length;
+ size_t capacity;
+ char *c_str;
+
+ /* Allocate a new dynamic string with an initial capacity */
+ mcl_string_s *str = mcl_string_new("Hello, world!", 512);
+ assert(str != NULL);
+
+ /* Retrieve a C str from string with mcl_string_cstr() */
+ c_str = mcl_string_cstr(str);
+ length = mcl_string_length(str);
+ capacity = mcl_string_capacity(str);
+ assert(strcmp(c_str, "Hello, world!") == 0);
+ assert(length == 13);
+ assert(capacity == 512);
+
+ /* Append text to a mcl_string */
+ assert(mcl_string_append(str, " How are you?") == 0);
+
+ c_str = mcl_string_cstr(str);
+ length = mcl_string_length(str);
+ capacity = mcl_string_capacity(str);
+ assert(strcmp(c_str, "Hello, world! How are you?") == 0);
+ assert(length == 26);
+ assert(capacity == 512);
+
+ /* Always deallocate memory */
+ mcl_string_free(str);
+}
diff --git a/test/string/str2.c b/test/string/str2.c
index 3d0a62b..564cfae 100644
--- a/test/string/str2.c
+++ b/test/string/str2.c
@@ -1,27 +1,34 @@
-#include
-#include
-
-#include "../../string/mystring.h"
-
-void test_str2(void) {
- mcl_string_s *s1 = mcl_string_new("Hello, world!", 0);
- assert(s1 != NULL);
- mcl_string_s *s2 = mcl_string_new("Hello, world!", 0);
- assert(s2 != NULL);
- /* Don't call mcl_string_cstr() more than once in the same printf function */
-
- int ret = mcl_string_compare(s1, s2);
- assert(ret == 0);
-
- mcl_string_clear(s1);
- ret = mcl_string_compare(s1, s2);
- assert(ret != 0);
-
- mcl_string_tolower(s1);
- mcl_string_toupper(s2);
- assert(strcmp(mcl_string_cstr(s1), "") == 0);
- assert(strcmp(mcl_string_cstr(s2), "HELLO, WORLD!") == 0);
-
- mcl_string_free(s1);
- mcl_string_free(s2);
-}
+#include
+#include
+
+#include "../../string/mystring.h"
+
+void test_str2(void) {
+ mcl_string_s *s1 = mcl_string_new("Hello, world!", 0);
+ assert(s1 != NULL);
+ mcl_string_s *s2 = mcl_string_new("Hello, world!", 0);
+ assert(s2 != NULL);
+ /* Don't call mcl_string_cstr() more than once in the same printf function */
+
+ int ret = mcl_string_compare(s1, s2);
+ assert(ret == 0);
+
+ mcl_string_clear(s1);
+ ret = mcl_string_compare(s1, s2);
+ assert(ret != 0);
+
+ mcl_string_tolower(s1);
+ mcl_string_toupper(s2);
+ assert(strcmp(mcl_string_cstr(s1), "") == 0);
+ assert(strcmp(mcl_string_cstr(s2), "HELLO, WORLD!") == 0);
+
+ /* Extend a string */
+ mcl_string_s *extend_me = mcl_string_new("This string is suuuuuuuuuuuuuuuuuuuuuper extended!", 0);
+ mcl_string_extend(s1, extend_me);
+ assert(mcl_string_length(s1) == 50);
+ assert(mcl_string_capacity(s1) == 64);
+
+ mcl_string_free(s1);
+ mcl_string_free(s2);
+ mcl_string_free(extend_me);
+}
diff --git a/test/test.c b/test/test.c
index 12cc589..5c1bf8d 100644
--- a/test/test.c
+++ b/test/test.c
@@ -1,26 +1,31 @@
-/**
- * Ignore this file
- */
-
-#include
-#include
-
-int main(void) {
- puts("==== [Running Hashmap tests] ====");
- test_hm1();
- puts("OK!");
- puts("");
-
- puts("==== [Running Queue tests] ====");
- test_q1();
- puts("OK!");
- puts("");
-
- puts("==== [Running String tests] ====");
- test_str1();
- test_str2();
- puts("OK!");
- puts("");
-
- return 0;
-}
+/**
+ * Ignore this file
+ */
+
+#include
+#include
+
+void test_hm1();
+void test_q1();
+void test_str1();
+void test_str2();
+
+int main(void) {
+ puts("==== [Running Hashmap tests] ====");
+ test_hm1();
+ puts("OK!");
+ puts("");
+
+ puts("==== [Running Queue tests] ====");
+ test_q1();
+ puts("OK!");
+ puts("");
+
+ puts("==== [Running String tests] ====");
+ test_str1();
+ test_str2();
+ puts("OK!");
+ puts("");
+
+ return 0;
+}