diff options
| -rw-r--r-- | .exrc | 1 | ||||
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | COPYING | 5 | ||||
| -rw-r--r-- | LICENSE | 458 | ||||
| -rw-r--r-- | Makefile | 32 | ||||
| -rw-r--r-- | README.md | 1 | ||||
| -rw-r--r-- | compile_commands.json | 36 | ||||
| -rw-r--r-- | include/parcini.h | 136 | ||||
| -rw-r--r-- | include/tests/tests.h | 45 | ||||
| -rw-r--r-- | src/parcini.c | 239 | ||||
| -rw-r--r-- | src/tests/parcini.c | 138 | ||||
| -rw-r--r-- | test.ini | 16 |
12 files changed, 1110 insertions, 0 deletions
@@ -0,0 +1 @@ +let ch_syntax_for_h = 1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b0b5a06 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.cache +obj/ +build/ @@ -0,0 +1,5 @@ +Copyright (c) 2021 Yaroslav de la Peña Smirnov + +This is free software, which you can redistribute and/or modify under the terms +of the GNU Lesser General Public License, version 2.1 only. It is provided AS IS +and WITHOUT ANY WARRANTY whatsoever. For more information read the LICENSE file. @@ -0,0 +1,458 @@ +GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8917d8e --- /dev/null +++ b/Makefile @@ -0,0 +1,32 @@ +CC?=gcc +RM:=rm -rf + +SRC_DIR:=src +OBJ_DIR:=obj +INC_DIRS=$(addprefix -iquote,include) + +PARCINI_SOURCES:=$(wildcard $(SRC_DIR)/*.c) +PARCINI_OBJECTS:=$(PARCINI_SOURCES:%.c=$(OBJ_DIR)/%.o) +BUILD_DIR:=build + +test: CFLAGS := -std=c99 -O0 -g -Wall -DDEBUG +test: $(BUILD_DIR) tests/parcini + +tests/%: $(OBJ_DIR)/src/tests/%.o $(OBJ_DIR)/src/%.o $(PARCINI_OBJECTS) + $(CC) $(LDFLAGS) -o $(BUILD_DIR)/$@ $^ + $(BUILD_DIR)/$@ + +$(OBJ_DIR)/%.o: %.c + $(CC) -c $(CFLAGS) $(INC_DIRS) -o $@ $< + +$(BUILD_DIR): + mkdir -p $(BUILD_DIR)/tests + mkdir -p $(OBJ_DIR)/src/tests + +clean: + $(RM) $(OBJ_DIR) + $(RM) $(BUILD_DIR) + +.PHONY: clean test + +.PRECIOUS: $(OBJ_DIR)/tests/%.o $(OBJ_DIR)/%.o diff --git a/README.md b/README.md new file mode 100644 index 0000000..51a7edd --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# parsini diff --git a/compile_commands.json b/compile_commands.json new file mode 100644 index 0000000..d713573 --- /dev/null +++ b/compile_commands.json @@ -0,0 +1,36 @@ +[ + { + "directory": "/home/yaroslav/repos/personal/parcini", + "arguments": [ + "cc", + "-c", + "-std=c99", + "-O0", + "-g", + "-Wall", + "-DDEBUG", + "-iquoteinclude", + "-o", + "obj/src/tests/parcini.o", + "src/tests/parcini.c" + ], + "file": "src/tests/parcini.c" + }, + { + "directory": "/home/yaroslav/repos/personal/parcini", + "arguments": [ + "cc", + "-c", + "-std=c99", + "-O0", + "-g", + "-Wall", + "-DDEBUG", + "-iquoteinclude", + "-o", + "obj/src/parcini.o", + "src/parcini.c" + ], + "file": "src/parcini.c" + } +] diff --git a/include/parcini.h b/include/parcini.h new file mode 100644 index 0000000..3bcaf59 --- /dev/null +++ b/include/parcini.h @@ -0,0 +1,136 @@ +/* + * Copyright (c) 2021 Yaroslav de la Peña Smirnov + * + * Released under the GNU Lesser General Public License, version 2.1 only. + * For more information see `LICENSE' or visit + * https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + */ +#ifndef PARCINI_H +#define PARCINI_H +#include <stdio.h> +#include <stdbool.h> +#include <sys/types.h> + +/* You can choose to use a different character for comments (e.g. ';') at + * compile time */ +#ifndef PARCINI_COMMENT_CHAR +#define PARCINI_COMMENT_CHAR '#' +#endif + +/* + * An opaque structure that represents an instance of a "parcini" ini parser, + * used to parse a stream. + */ +typedef struct parcini parcini_t; + +/* + * All possible values to be returned by parcini_parse_next_line. + */ +enum parcini_result { + /* A line with only whitespace and/or a comment */ + PARCINI_EMPTY_LINE, + /* There are no more lines to parse */ + PARCINI_EOF, + /* A section. parcini_line.key shall be NULL and parcini_line.value.type + * shalle be PARCINI_VALUE_NONE */ + PARCINI_SECTION, + /* Key/value. parcini_line.key contains the name of the key, and + * parcini_line.value contains the type and actual value. */ + PARCINI_KEYVALUE, + /* A call to malloc/realloc failed. errno might be set */ + PARCINI_MEMORY_ERROR, + /* An error other than EOF occured when attempting to read the stream. errno + * might be set */ + PARCINI_STREAM_ERROR, + /* What seemed to start as a key is incorrectly formated, and thus couldn't + * be parsed correctly. */ + PARCINI_KEY_PARSE_ERROR, + /* Where a value should have followed a key, there is none, or it is + * incorrectly formated, and thus couldn't be parsed correctly. */ + PARCINI_VALUE_PARSE_ERROR, + /* The value is an integer number that couldn't be parsed correctly due to + * it being out of the range of a long int */ + PARCINI_VALUE_RANGE_ERROR, + /* What seemed to be a line containing a section name, wasn't formatted + * correctly and thus couldn't be parsed. */ + PARCINI_SECTION_PARSE_ERROR, +}; + +enum parcini_value_type { + /* There is no value */ + PARCINI_VALUE_NONE, + /* The value is long int */ + PARCINI_VALUE_INTEGER, + /* The value is bool */ + PARCINI_VALUE_BOOLEAN, + /* The value is pointer to char */ + PARCINI_VALUE_STRING, +}; + +/* + * A tagged union-like structure representing a parsed value. Accessing a .value + * member for which the type is not set is undefined behaviour (beware of the + * char *, it could segfault your program). + */ +struct parcini_value { + enum parcini_value_type type; + union { + long int integer; + bool boolean; + char *string; + } value; +}; + +/* + * This structure should be passed as a pointer to parcini_parse_next_line so + * that it is filled with the parsed information. The pointers here MUST NOT be + * manually freed. See function parcini_parse_next_line for more details. + */ +struct parcini_line { + size_t lineno; + char *section; + char *key; + struct parcini_value value; +}; + +/* + * Parse the next line in the stream returning the kind of result/error of + * parsing and filling the parcini_line structure with the information that was + * extracted from the line, as well as the current section (including after + * parsing a key/value line) and line number. + * + * If you need the information returned to last after the next call to this + * function, or after the destruction of the parcini_t parser instance, then you + * should copy it to a different variable/pointer before parsing the next + * line/freeing your parser instance. This data also MUST NOT be manually freed + * by the caller. + */ +enum parcini_result parcini_parse_next_line(parcini_t *, struct parcini_line *); + +/* + * Main function through which you initialize a parcini_t parser object, before + * you can parse the stream line by line. + */ +parcini_t *parcini_init(FILE *stream); + +/* + * Helper function to open a file and then initialize a parcini_t object with + * said as the source stream. + */ +parcini_t *parcini_from_file(const char *fpath); + +/* + * Helper function to initialize a parcini_t object with said string of said + * size open as a stream. + */ +parcini_t *parcini_from_string(const char *, const size_t); + +/* + * Free all memory related to the parcini_t instance. IMPORTANT: this will also + * close the stream passed to parcini_init, so if you manually opened a file and + * then passed it to parcini_init, it WILL NOT be valid after a call to + * parcini_destroy. + */ +void parcini_destroy(parcini_t *); + +#endif diff --git a/include/tests/tests.h b/include/tests/tests.h new file mode 100644 index 0000000..8c89fcc --- /dev/null +++ b/include/tests/tests.h @@ -0,0 +1,45 @@ +#ifndef TESTS_H +#define TESTS_H +#include <stdio.h> +#include <stdlib.h> + +#ifndef NOCOLOR +#define TBLD "\033[1m" +#define TRED "\033[31m" +#define TGRN "\033[32m" +#define TBLU "\033[34m" +#define TRST "\033[0m" +#else +#define TBLD "" +#define TRED "" +#define TGRN "" +#define TBLU "" +#define TRST "" +#endif + +#define RUN_TEST(test_func) \ + printf("%s:\t", #test_func); \ + fflush(stdout); \ + test_func(); \ + printf(TGRN "OK!\n" TRST) + +#define INIT_TESTS() \ + printf(TBLD "running %s tests\n" TRST, __FILE__) + +#define FAIL_TEST(reason) \ + printf(TBLD TRED "FAIL!\n" TRST); \ + printf("%s:%d: %s: ", __FILE__, __LINE__, __func__); \ + printf(reason); \ + abort() + +#define asserteq(a, b) \ + if (a != b) { \ + FAIL_TEST("assertion " TBLD TBLU #a " == " #b TRST " failed\n"); \ + } + +#define assertneq(a, b) \ + if (a == b) { \ + FAIL_TEST("assertion " TBLD TBLU #a " != " #b TRST " failed\n"); \ + } + +#endif diff --git a/src/parcini.c b/src/parcini.c new file mode 100644 index 0000000..6c19d7a --- /dev/null +++ b/src/parcini.c @@ -0,0 +1,239 @@ +/* + * Copyright (c) 2021 Yaroslav de la Peña Smirnov + * + * Released under the GNU Lesser General Public License, version 2.1 only. + * For more information see `LICENSE' or visit + * https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html + */ +#define _POSIX_C_SOURCE 200809L +#include "parcini.h" + +#include <ctype.h> +#include <errno.h> +#include <stdlib.h> +#include <string.h> +#include <stdbool.h> + +struct parcini { + FILE *stream; + char *last_section; + size_t last_section_n; + char *last_line; + size_t last_line_n; + size_t last_line_no; +}; + +/* + * Strip string "slice" of any whitespace characters to the right until the next + * non-whitespace character. + */ +static void +rstrip(const char *start, char **end) { + while (start < *end && isspace(**end)) { + **end = '\0'; + *end -= 1; + } +} + +/* + * Ignore whitespace characters on the left, moving the pointer until we find + * a non-whitespace character. + */ +static void +lskip(char **start) { + while (**start && isspace(**start)) { + *start += 1; + } +} + +/* + * Make a copy of the string "slice" located from pointer start to pointer end, + * copying it over to dst, reallocating memory if needed, and terminating it + * with a null character. + */ +static char * +slicecpy(char *start, char *end, char **dst, size_t *dstn) +{ + size_t srcn = end - start + 1; + if (*dst == NULL) { + *dst = malloc(srcn + 1); + } + if (*dstn < srcn) { + char *newptr = realloc(*dst, srcn + 1); + if (newptr == NULL) { + return NULL; + } + *dstn = srcn + 1; + *dst = newptr; + } + for (size_t i = 0; i < srcn; i++) { + (*dst)[i] = start[i]; + } + (*dst)[srcn] = '\0'; + + return *dst; +} + +enum parcini_result +parcini_parse_next_line(parcini_t *parser, struct parcini_line *parsed) +{ + ssize_t nread = getline(&parser->last_line, &parser->last_line_n, + parser->stream); + + if (nread < 0) { + if (feof(parser->stream)) { + return PARCINI_EOF; + } + return PARCINI_STREAM_ERROR; + } + + parsed->lineno = ++parser->last_line_no; + if (nread > 0) { + char *start = parser->last_line; + if (*start == PARCINI_COMMENT_CHAR) { + goto empty; + } + + if (*start == '[') { + char *end = strchr(start, ']'); + if (!end) { + return PARCINI_SECTION_PARSE_ERROR; + } + char *cmnt = strchr(start, PARCINI_COMMENT_CHAR); + if (cmnt && cmnt < end) { + return PARCINI_SECTION_PARSE_ERROR; + } + if (!slicecpy(start + 1, end - 1, &parser->last_section, + &parser->last_section_n)) { + return PARCINI_MEMORY_ERROR; + } + parsed->section = parser->last_section; + parsed->key = NULL; + parsed->value.type = PARCINI_VALUE_NONE; + return PARCINI_SECTION; + } + + parsed->section = parser->last_section; + char *delim = strchr(start, '='); + if (delim) { + char *cmnt = strchr(start, PARCINI_COMMENT_CHAR); + if (cmnt && cmnt < delim) { + return PARCINI_KEY_PARSE_ERROR; + } + char *end = delim; + *end = '\0'; + end -= 1; + rstrip(start, &end); + if (start == end) { + return PARCINI_KEY_PARSE_ERROR; + } + parsed->key = start; + + start = delim + 1; + lskip(&start); + end = parser->last_line + nread - 1; + if (*start == '"') { + delim = strrchr(start, '"'); + if (!delim) { + return PARCINI_VALUE_PARSE_ERROR; + } + if (delim != end) { + char *postq = delim + 1; + lskip(&postq); + if (*postq && *postq != PARCINI_COMMENT_CHAR) { + return PARCINI_VALUE_PARSE_ERROR; + } + } + *delim = '\0'; + parsed->value.type = PARCINI_VALUE_STRING; + parsed->value.value.string = start + 1; + return PARCINI_KEYVALUE; + } + + if (cmnt) { + if (start == cmnt) { + return PARCINI_VALUE_PARSE_ERROR; + } + *cmnt = '\0'; + end = cmnt - 1; + } + rstrip(start, &end); + + if (!strcmp(start, "yes") || !strcmp(start, "true")) { + parsed->value.type = PARCINI_VALUE_BOOLEAN; + parsed->value.value.boolean = true; + return PARCINI_KEYVALUE; + } + if (!strcmp(start, "no") || !strcmp(start, "false")) { + parsed->value.type = PARCINI_VALUE_BOOLEAN; + parsed->value.value.boolean = false; + return PARCINI_KEYVALUE; + } + + char *invalid = NULL; + errno = ETIME; + long int no = strtol(start, &invalid, 0); + if ((*invalid && *invalid != '\n' && *invalid != '\r') + || errno == EINVAL) { + return PARCINI_VALUE_PARSE_ERROR; + } + if (errno == ERANGE) { + return PARCINI_VALUE_RANGE_ERROR; + } + parsed->value.type = PARCINI_VALUE_INTEGER; + parsed->value.value.integer = no; + return PARCINI_KEYVALUE; + } + + lskip(&start); + if (*start) { + return PARCINI_KEY_PARSE_ERROR; + } + } + +empty: + return PARCINI_EMPTY_LINE; +} + +parcini_t * +parcini_init(FILE *stream) +{ + parcini_t *parser = calloc(1, sizeof *parser); + if (parser != NULL) { + parser->stream = stream; + parser->last_section = strdup(""); + parser->last_section_n = 2; + } + + return parser; +} + +parcini_t * +parcini_from_file(const char *fpath) +{ + FILE *f = NULL; + f = fopen(fpath, "r"); + if (f == NULL) { + return NULL; + } + return parcini_init(f); +} + +parcini_t * +parcini_from_string(const char *str, const size_t len) +{ + FILE *stream = fmemopen((void *)str, len, "r"); + if (stream == NULL) { + return NULL; + } + return parcini_init(stream); +} + +void +parcini_destroy(parcini_t *parser) +{ + fclose(parser->stream); + free(parser->last_line); + free(parser->last_section); + free(parser); +} diff --git a/src/tests/parcini.c b/src/tests/parcini.c new file mode 100644 index 0000000..f53ab09 --- /dev/null +++ b/src/tests/parcini.c @@ -0,0 +1,138 @@ +#include "tests/tests.h" +#include "parcini.h" + +#include <string.h> + +#define PARCINI_TEST_FILE "test.ini" + +void +test_parcini_parse_file(void) +{ + parcini_t *parser = parcini_from_file(PARCINI_TEST_FILE); + struct parcini_line line; + enum parcini_result res; + + /* line 1 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_KEYVALUE); + asserteq(line.lineno, 1); + asserteq(strcmp(line.section, ""), 0); + asserteq(strcmp(line.key, "key1"), 0); + asserteq(line.value.type, PARCINI_VALUE_STRING); + asserteq(strcmp(line.value.value.string, "string"), 0); + + /* line 2 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_KEYVALUE); + asserteq(line.lineno, 2); + asserteq(strcmp(line.section, ""), 0); + asserteq(strcmp(line.key, "key2"), 0); + asserteq(line.value.type, PARCINI_VALUE_INTEGER); + asserteq(line.value.value.integer, -1520); + + /* line 3 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_KEYVALUE); + asserteq(line.lineno, 3); + asserteq(strcmp(line.section, ""), 0); + asserteq(strcmp(line.key, "key3"), 0); + asserteq(line.value.type, PARCINI_VALUE_BOOLEAN); + asserteq(line.value.value.boolean, false); + + /* line 4 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_EMPTY_LINE); + asserteq(line.lineno, 4); + + /* line 5 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_EMPTY_LINE); + asserteq(line.lineno, 5); + + /* line 6 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_SECTION); + asserteq(line.lineno, 6); + asserteq(strcmp(line.section, "asection"), 0); + asserteq(line.key, NULL); + asserteq(line.value.type, PARCINI_VALUE_NONE); + + /* line 7 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_KEYVALUE); + asserteq(line.lineno, 7); + asserteq(strcmp(line.section, "asection"), 0); + asserteq(strcmp(line.key, "skey"), 0); + asserteq(line.value.type, PARCINI_VALUE_STRING); + asserteq(strcmp(line.value.value.string, "ur 2 slow"), 0); + + /* line 8 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_VALUE_PARSE_ERROR); + asserteq(line.lineno, 8); + + /* line 9 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_KEY_PARSE_ERROR); + asserteq(line.lineno, 9); + + /* line 10 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_VALUE_PARSE_ERROR); + asserteq(line.lineno, 10); + + /* line 11 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_VALUE_RANGE_ERROR); + asserteq(line.lineno, 11); + + /* line 12 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_KEYVALUE); + asserteq(line.lineno, 12); + asserteq(strcmp(line.section, "asection"), 0); + asserteq(strcmp(line.key, "bool2"), 0); + asserteq(line.value.type, PARCINI_VALUE_BOOLEAN); + asserteq(line.value.value.boolean, true); + + /* line 13 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_KEYVALUE); + asserteq(line.lineno, 13); + asserteq(strcmp(line.section, "asection"), 0); + asserteq(strcmp(line.key, "bool3"), 0); + asserteq(line.value.type, PARCINI_VALUE_BOOLEAN); + asserteq(line.value.value.boolean, false); + + /* line 14 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_KEYVALUE); + asserteq(line.lineno, 14); + asserteq(strcmp(line.section, "asection"), 0); + asserteq(strcmp(line.key, "bool3"), 0); + asserteq(line.value.type, PARCINI_VALUE_BOOLEAN); + asserteq(line.value.value.boolean, true); + + /* line 15 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_EMPTY_LINE); + asserteq(line.lineno, 15); + + /* line 16 */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_SECTION_PARSE_ERROR); + asserteq(line.lineno, 16); + + /* EOF */ + res = parcini_parse_next_line(parser, &line); + asserteq(res, PARCINI_EOF); + + parcini_destroy(parser); +} + +int +main(void) +{ + INIT_TESTS(); + RUN_TEST(test_parcini_parse_file); +} diff --git a/test.ini b/test.ini new file mode 100644 index 0000000..f8823b6 --- /dev/null +++ b/test.ini @@ -0,0 +1,16 @@ +key1 = "string" +key2= -1520 +key3=no + +# this is a comment +[asection] +skey="ur 2 slow" #with comment +bad=#this is not good +bad2$#this is also bad +bad3 = 2 and this +range=3000000000000000000000 #this should be enough +bool2=yes +bool3=false +bool3 = true + +[bad section |