diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..38a7c2f --- /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 2025 Piraterna + + 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/include/args.h b/include/args.h index 1bb5735..b854656 100644 --- a/include/args.h +++ b/include/args.h @@ -11,6 +11,14 @@ #ifndef PIRATPKG_ARGS_H #define PIRATPKG_ARGS_H +/* Return codes for parse_args() */ +#define ARG_SUCCESS 0 /* Parsing succeeded */ +#define ARG_ERR_UNKNOWN -1 /* Unknown argument encountered */ +#define ARG_ERR_MISSING_VALUE \ + -2 /* Argument requires a value but none was provided */ +#define ARG_ERR_REQUIRED_MISSING -3 /* Required argument was not provided */ +#define ARG_ERR_ALLOC_FAILED -4 /* Memory allocation (e.g., strdup) failed */ + struct arg { const char* name; /* Long name (e.g., "--config") */ diff --git a/src/args.c b/src/args.c index e1be5c0..060ce4b 100644 --- a/src/args.c +++ b/src/args.c @@ -67,7 +67,7 @@ int parse_args(int argc, char* argv[], struct arg* arg_table, int num_args) arg_table[j].value = strdup_safe(argv[i + 1]); if (arg_table[j].value == NULL) { - return -1; + return ARG_ERR_ALLOC_FAILED; } shift_args(&argc, argv, i); shift_args(&argc, argv, i); @@ -78,7 +78,7 @@ int parse_args(int argc, char* argv[], struct arg* arg_table, int num_args) /* Error: missing value for argument */ printf("Error: Argument '%s' requires a value\n", argv[i]); - return -1; + return ARG_ERR_MISSING_VALUE; } } break; @@ -111,7 +111,7 @@ int parse_args(int argc, char* argv[], struct arg* arg_table, int num_args) arg_table[j].value = strdup_safe(argv[i + 1]); if (arg_table[j].value == NULL) { - return -1; + return ARG_ERR_ALLOC_FAILED; } shift_args(&argc, argv, i); shift_args(&argc, argv, i); @@ -122,7 +122,7 @@ int parse_args(int argc, char* argv[], struct arg* arg_table, int num_args) /* Error: missing value for argument */ printf("Error: Argument '%s' requires a value\n", argv[i]); - return -1; + return ARG_ERR_MISSING_VALUE; } } break; @@ -139,7 +139,7 @@ int parse_args(int argc, char* argv[], struct arg* arg_table, int num_args) arg_table[j].value = strdup_safe(argv[i]); if (arg_table[j].value == NULL) { - return -1; + return ARG_ERR_ALLOC_FAILED; } shift_args(&argc, argv, i); break; @@ -153,10 +153,12 @@ int parse_args(int argc, char* argv[], struct arg* arg_table, int num_args) { if (arg_table[i].required && arg_table[i].value == NULL) { - printf("Error: Missing required argument: %s\n", arg_table[i].name); - return -1; + /* Report error */ + printf("piratpkg: Missing required argument: %s\n", + arg_table[i].name); + return ARG_ERR_REQUIRED_MISSING; } } - return argc; + return ARG_SUCCESS; } diff --git a/src/piratpkg.c b/src/piratpkg.c index 1b27220..acfd60e 100644 --- a/src/piratpkg.c +++ b/src/piratpkg.c @@ -26,18 +26,38 @@ struct arena global_arena; void print_help() { - printf("Usage: piratpkg [options]\n"); + printf("Usage: piratpkg [OPTION]...\n"); + printf("A minimal package manager for Piraterna's Linux distribution.\n\n"); printf("Options:\n"); - printf(" -h, --help Show this help message\n"); - printf(" -c, --config Specify the config file (default: %s)\n", - DEFAULT_CONFIG_FILE); + printf(" -h, --help display this help and exit\n"); + printf(" -v, --version output version information and exit\n"); + printf( + " -c, --config use specified configuration file (default: " + "%s)\n", + DEFAULT_CONFIG_FILE); + printf("\n"); + printf("Report bugs to: \n"); + printf("Piraterna home page: \n"); +} + +void print_version() +{ + printf("piratpkg 0.1.0\n"); + printf("Copyright (C) 2025 Piraterna\n"); + printf( + "License Apache-2.0: Apache License version 2.0 " + "\n"); + printf( + "This is free software: you are free to change and redistribute " + "it.\n"); + printf("There is NO WARRANTY, to the extent permitted by law.\n"); } int main(int argc, char** argv) { int status = 0; - /* 16KB Arena to */ + /* 16KB Arena to start with */ status = arena_init(&global_arena, DEFAULT_ARENA_SIZE); if (status != 0) { @@ -46,14 +66,20 @@ int main(int argc, char** argv) /* Handle arguments */ struct arg arg_table[] = { - {"--help", "-h", 0, NULL, 0}, + {"--help", "-h", 0, NULL, 0}, /* Special argument*/ + {"--version", "-v", 0, NULL, 0}, /* Special argument*/ {"--config", "-c", 0, DEFAULT_CONFIG_FILE, 1}, }; int arg_count = sizeof(arg_table) / sizeof(arg_table[0]); argc = parse_args(argc, argv, arg_table, arg_count); - if (argc < 0) + if (argc < ARG_SUCCESS) { + if (argc == ARG_ERR_REQUIRED_MISSING || argc == ARG_ERR_MISSING_VALUE) + { + print_help(); + } + arena_destroy(&global_arena); return 1; } @@ -66,9 +92,16 @@ int main(int argc, char** argv) return 0; } + if (arg_table[1].value != NULL) + { + print_version(); + arena_destroy(&global_arena); + return 0; + } + /* Open and parse config file */ FILE* file = - fopen(arg_table[1].value, "r"); /* Open config file as read-only */ + fopen(arg_table[2].value, "r"); /* Open config file as read-only */ if (file == NULL) { perror("piratpkg: Failed to open config file"); @@ -96,7 +129,8 @@ int main(int argc, char** argv) memcpy(line_copy, line, len + 1); - /* Parse the line as a key-value pair, if it fails it's not a kv pair */ + /* Parse the line as a key-value pair, if it fails it's not a kv + * pair */ static struct key_value_pair kv_pair; if (parse_single_key_value(line, &kv_pair) != 0) {