From 73dd849484cee9c46c24582fc6537bc68c18fdce Mon Sep 17 00:00:00 2001 From: Xavi Del Campo Date: Thu, 19 Mar 2020 18:39:06 +0100 Subject: [PATCH] First commit --- .gitignore | 3 + LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 32 ++++++++ dynstr.c | 68 ++++++++++++++++ include/dynstr.h | 85 ++++++++++++++++++++ 5 files changed, 389 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 dynstr.c create mode 100644 include/dynstr.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6b3d155 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*.o +*.obj + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4b95a1f --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 Xavier Del Campo Romero + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e32369b --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +dynstr +====== + +Minimal library that provides dynamic strings using plain C99. Convenience +macros are also provided if GNU C is used. + +# Usage + +``` +#include +#include "dynstr.h" + +int main(const int argc, const char *argv[]) +{ + struct dynstr s; + + dynstr_init(&s); + dynstr_append(&s, "Hello"); + dynstr_append(&s, " from %s:%d\n", __func__, __LINE__); + printf("%s", s.str); + dynstr_free(&s); + + return 0; +} +``` +Output: + +``` +Hello from main:10 +``` +# License +See LICENSE file. diff --git a/dynstr.c b/dynstr.c new file mode 100644 index 0000000..35d47b1 --- /dev/null +++ b/dynstr.c @@ -0,0 +1,68 @@ +/* + Copyright 2020 Xavier Del Campo Romero + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +#include "dynstr.h" +#include +#include +#include +#include +#include + +void dynstr_init(struct dynstr *const d) +{ + memset(d, 0, sizeof *d); +} + +int dynstr_append(struct dynstr *const d, const char *const format, ...) +{ + va_list ap; + + va_start(ap, format); + const size_t src_len = vsnprintf(NULL, 0, format, ap); + size_t new_len; + va_end(ap); + + if (!d->str) + { + new_len = src_len + 1; + d->str = calloc(src_len + 1, sizeof *d->str); + } + else + { + new_len = d->len + src_len + 1; + d->str = realloc(d->str, (d->len + src_len) * sizeof *d->str); + } + + if (d->str) + { + va_start(ap, format); + vsprintf(d->str + d->len, format, ap); + va_end(ap); + d->len += src_len; + } + else + { + return 1; + } + + return 0; +} + +void dynstr_free(struct dynstr *const d) +{ + free(d->str); + memset(d, 0, sizeof *d); +} diff --git a/include/dynstr.h b/include/dynstr.h new file mode 100644 index 0000000..1902eae --- /dev/null +++ b/include/dynstr.h @@ -0,0 +1,85 @@ +/* + Copyright 2020 Xavier Del Campo Romero + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +#ifndef DYNSTR_H +#define DYNSTR_H + +#include + +#ifdef __GNUC__ + +/* Since dynstr_append() might fail (as it is based on dynamic memory + * allocation), these macros can be used to avoid boilerplate code. + * However, C99 variadic macros might expand with a trailing comma + * when no parameters are given after "format", a GNU extension is + * needed to avoid this problem. */ +#include + +/** + * Convenience macro that calls dynstr_append and returns NULL if failed. + */ +#define dynstr_append_or_ret_null(d, format, ...) if (dynstr_append(d, format, ## __VA_ARGS__)) return NULL; + +/** + * Convenience macro that calls dynstr_append and returns false if failed. + */ +#define dynstr_append_or_ret_false(d, format, ...) if (dynstr_append(d, format, ## __VA_ARGS__)) return false; + +/** + * Convenience macro that calls dynstr_append and returns one if failed. + */ +#define dynstr_append_or_ret_nonzero(d, format, ...) if (dynstr_append(d, format, ## __VA_ARGS__)) return 1; + +#endif /* __GNUC__ */ + +/** + * Dynamic string type used for this library. + * @note If needed, members can be safely read but should not be modified + * outside this library. + */ +struct dynstr +{ + char *str; /**< Null-terminated string. */ + size_t len; /**< String length, null character not included. */ +}; + +/** + * Reportedly, it initializes an empty string with zero length. + * @attention Always call this function when creating a dynstr instance. + * @param d Dynamic string to be initialized. + */ +void dynstr_init(struct dynstr *d); + +/** + * This function takes a string literal in printf format and a variable + * number of arguments, calculates its size and concatenates it into the + * dynamic string. + * @param d Dynamic string where new string will be appended. + * @param format String literal in printf format. + * @return Returns 0 if successful, 1 if alloc operation failed. + */ +int dynstr_append(struct dynstr *d, const char *format, ...); + +/** + * This function frees memory used by the dynamic string. + * @param d Dynamic string to be freed. + * @attention Attempting to call this function on an uninitialized or empty + * instance is undefined behaviour. + * @attention Parameters inside the struct are reset once memory is freed. + */ +void dynstr_free(struct dynstr *d); + +#endif /* DYNSTR_H */