commit 2133b01c03e781011b43c56ebf217538905a4bcf Author: trainstopperd Date: Wed Sep 6 22:06:42 2023 -0400 chore: add files diff --git a/COPYING.LGPLv3 b/COPYING.LGPLv3 new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/COPYING.LGPLv3 @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/doc/LIBERROR_ASSERT.autodoc b/doc/LIBERROR_ASSERT.autodoc new file mode 100755 index 0000000..6e6aedf --- /dev/null +++ b/doc/LIBERROR_ASSERT.autodoc @@ -0,0 +1,78 @@ +\section NAME +LIBEROR_ASSERT - report an error message to the stderr +\break + +\section SYNOPSIS +\bold-on +#define LIBERROR_ASSERT( +\bold-off +\italics-on +expression +\italics-off +\bold-on +, +\space +\bold-off +\italics-on +type +\italics-off +\bold-on +, +\space +\bold-off +\italics-on +message +\italocs-off +\bold-on +, +\space +\italics-on +function +\italics-off +\bold-on +); +\bold-off + +\break + +\section DESCRIPTION +The LIBERROR_ASSERT macro will raise a runtime error of the type +\space +\italics-on +type +\italics-off +\space +\break +if the expression +\space +\italics-on +expression +\italics-off +\space +evaluates to false. The error will contain a +\break +message describing what happened, as well as the function that the +\break +error occurred in. The error will be written to the stderr in the +\break +format described in +\space +\bold-on +liberror +\bold-off +(cware). + +\break + +\break + +\section SEE ALSO +\bold-on +cware +\bold-off +(cware), +\space +\bold-on +liberror +\bold-off +(cware) diff --git a/doc/LIBERROR_ASSERT.cware b/doc/LIBERROR_ASSERT.cware new file mode 100755 index 0000000..82ff871 --- /dev/null +++ b/doc/LIBERROR_ASSERT.cware @@ -0,0 +1,23 @@ +.TH "LIBERROR_ASSERT" "cware" "May 13, 2023" "" "C-Ware Manuals" + +.SH NAME +LIBEROR_ASSERT - report an error message to the stderr +.br +.SH SYNOPSIS +\fB#define LIBERROR_ASSERT(\fR\fIexpression\fR\fB, \fR\fItype\fR\fB, \fR\fImessage\fB, \fIfunction\fR\fB);\fR +.br +.SH DESCRIPTION +The LIBERROR_ASSERT macro will raise a runtime error of the type \fItype\fR +.br +if the expression \fIexpression\fR evaluates to false. The error will contain a +.br +message describing what happened, as well as the function that the +.br +error occurred in. The error will be written to the stderr in the +.br +format described in \fBliberror\fR(cware). +.br + +.br +.SH SEE ALSO +\fBcware\fR(cware), \fBliberror\fR(cware) \ No newline at end of file diff --git a/doc/LIBERROR_TEST.autodoc b/doc/LIBERROR_TEST.autodoc new file mode 100755 index 0000000..f56f50e --- /dev/null +++ b/doc/LIBERROR_TEST.autodoc @@ -0,0 +1,59 @@ +\section NAME +LIBEROR_TEST - error checks for testcases +\break + +\section SYNOPSIS +\bold-on +#define LIBERROR_TEST( +\bold-off +\italics-on +expression +\italics-off +\bold-on +, +\space +\bold-off +\italics-on +message +\italocs-off +\bold-on +); +\bold-off + +\break + +\section DESCRIPTION +The LIBERROR_TEST macro is a wrapper over +\bold-on +LIBERROR_ASSERT +\bold-off +(cware). +\break +It takes in an expression to test, and the message to display on the +\break +testcase failing. It follows the same semantics as defined in +\break +\bold-on +LIBERROR_ASSERT +\bold-off +(cware). + +\break + +\break + +\section SEE ALSO +\bold-on +cware +\bold-off +(cware), +\space +\bold-on +liberror +\bold-off +(cware), +\space +\bold-on +LIBERROR_ASSERT +\bold-off +(cware) diff --git a/doc/LIBERROR_TEST.cware b/doc/LIBERROR_TEST.cware new file mode 100755 index 0000000..31e6698 --- /dev/null +++ b/doc/LIBERROR_TEST.cware @@ -0,0 +1,21 @@ +.TH "LIBERROR_TEST" "cware" "June 11, 2023" "" "C-Ware Manuals" + +.SH NAME +LIBEROR_TEST - error checks for testcases +.br +.SH SYNOPSIS +\fB#define LIBERROR_TEST(\fR\fIexpression\fR\fB, \fR\fImessage\fB);\fR +.br +.SH DESCRIPTION +The LIBERROR_TEST macro is a wrapper over \fBLIBERROR_ASSERT\fR(cware). +.br +It takes in an expression to test, and the message to display on the +.br +testcase failing. It follows the same semantics as defined in +.br +\fBLIBERROR_ASSERT\fR(cware). +.br + +.br +.SH SEE ALSO +\fBcware\fR(cware), \fBliberror\fR(cware), \fBLIBERROR_ASSERT\fR(cware) \ No newline at end of file diff --git a/doc/liberror.autodoc b/doc/liberror.autodoc new file mode 100755 index 0000000..e6f947a --- /dev/null +++ b/doc/liberror.autodoc @@ -0,0 +1,71 @@ +\section NAME +liberror - error reporting library +\break + +\section DESCRIPTION +liberror is the resident library under C-Ware for reporting error +\break +messages in a structured, computer-readable format. As described in +\break +\bold-on +cware +\bold-off +(cware), liberror produces error messages in the format: +\break +\break +\bold-on +\set-indent 4 +{TYPE}\\t{FUNCTION}\\t{ERROR-MESSSAGE}\\t{FILE}\\t{LINE} +\set-indent 0 +\bold-off +\break +\break +Liberror is intended to be used to allow togglable safety mechanisms +\break +in C-Ware code, like checking for NULL pointers. By design, the various +\break +components of the library are designed to be composed together into +\break +larger error checking operations to validate entire structures, for +\break +example. Also provided is a basic API for adding additional runtime +\break +error checks such as whether or not a structure has been passed through +\break +an operation that releases it from memory. All of this can be enabled +\break +through the definition of the +\space +\bold-on +CWARE_SAFETY_CHECKS +\bold-off +\space +macro. The manuals for the +\break +operations can be found below: +\break +\break +MANUAL +\set-indent 20 +SYNOPSIS +\set-indent 0 +\break +----------------------------------------------------------------------- +\break +LIBERROR_ASSERT(cware) +\set-indent 4 +assert a condition with debugging information +\break +\set-indent 0 +LIBERROR_TEST(cware) +\set-indent 6 +wrapper over LIBERROR_ASSERT for testcases +\break +\set-indent 0 + + +\section SEE ALSO +\bold-on +cware +\bold-off +(cware) diff --git a/doc/liberror.cware b/doc/liberror.cware new file mode 100755 index 0000000..4ee5d1e --- /dev/null +++ b/doc/liberror.cware @@ -0,0 +1,48 @@ +.TH "liberror" "cware" "June 11, 2023" "" "C-Ware Manuals" + +.SH NAME +liberror - error reporting library +.br +.SH DESCRIPTION +liberror is the resident library under C-Ware for reporting error +.br +messages in a structured, computer-readable format. As described in +.br +\fBcware\fR(cware), liberror produces error messages in the format: +.br + +.br +\fB {TYPE}\\t{FUNCTION}\\t{ERROR-MESSSAGE}\\t{FILE}\\t{LINE}\fR +.br + +.br +Liberror is intended to be used to allow togglable safety mechanisms +.br +in C-Ware code, like checking for NULL pointers. By design, the various +.br +components of the library are designed to be composed together into +.br +larger error checking operations to validate entire structures, for +.br +example. Also provided is a basic API for adding additional runtime +.br +error checks such as whether or not a structure has been passed through +.br +an operation that releases it from memory. All of this can be enabled +.br +through the definition of the \fBCWARE_SAFETY_CHECKS\fR macro. The manuals for the +.br +operations can be found below: +.br + +.br +MANUAL SYNOPSIS +.br +----------------------------------------------------------------------- +.br +LIBERROR_ASSERT(cware) assert a condition with debugging information +.br +LIBERROR_TEST(cware) wrapper over LIBERROR_ASSERT for testcases +.br +.SH SEE ALSO +\fBcware\fR(cware) \ No newline at end of file diff --git a/src/liberror/internal.h b/src/liberror/internal.h new file mode 100755 index 0000000..542c7fe --- /dev/null +++ b/src/liberror/internal.h @@ -0,0 +1,4 @@ +#ifndef CWARE_LIBERROR_INTERNAL_H +#define CWARE_LIBERROR_INTERNAL_H + +#endif diff --git a/src/liberror/public.h b/src/liberror/public.h new file mode 100755 index 0000000..7f5bcf2 --- /dev/null +++ b/src/liberror/public.h @@ -0,0 +1,24 @@ +#ifndef CWARE_LIBERROR_PUBLIC_H +#define CWARE_LIBERROR_PUBLIC_H + +#if defined(CWARE_SAFETY_CHECKS) +#define LIBERROR_ASSERT(expression, type, message, function) \ + do { \ + if((expression) != 0) { \ + break; \ + } \ + \ + fprintf(stderr, "%s\t%s\t%s\t%s\t%i\n", type, function, message, __FILE__, __LINE__); \ + abort(); \ + } while(0) + +#define LIBERROR_TEST(expression, message) \ + LIBERROR_ASSERT(expression, "ASSERTION", message, "main") + +#else + +#define LIBERROR_ASSERT(expression, message) +#define LIBERROR_TEST(expression, type, message, function) +#endif + +#endif diff --git a/tests/compile/assert.c b/tests/compile/assert.c new file mode 100755 index 0000000..e63e2cf --- /dev/null +++ b/tests/compile/assert.c @@ -0,0 +1,10 @@ +#include +#include + +#include "liberror/public.h" + +int main() { + LIBERROR_ASSERT(1 == 0, "ASSERTION", "1 does not equal zero.", "main"); + + return 0; +} diff --git a/tests/compile/test.c b/tests/compile/test.c new file mode 100755 index 0000000..1066eac --- /dev/null +++ b/tests/compile/test.c @@ -0,0 +1,10 @@ +#include +#include + +#include "liberror/public.h" + +int main() { + LIBERROR_TEST(1 == 0, "1 does not equal zero."); + + return 0; +}