From 34143eaaa4666db4fe0388ca74b9b0831778ef6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joger=E4=B9=94?= Date: Sun, 16 Oct 2022 10:51:16 +0800 Subject: [PATCH] update copyright and comments --- README.md | 2 +- interface/jargs_parser_api.hpp | 328 ++++++++++++++++++++++++++++++++- license | 2 +- 3 files changed, 320 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 16c41a6..0719b87 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ Congratulations! Now you can use `JArgsParser`! ## Want an advance support? -Sorry, document is now ready now. If you want to get more information, please go to see `example/show_all.cpp` or `ut/main.cpp`. +Sorry, document is not ready now. If you want to get more information, please go to see `example/show_all.cpp` or `ut/main.cpp`. Or, may be you can join us. diff --git a/interface/jargs_parser_api.hpp b/interface/jargs_parser_api.hpp index 740531b..4173c7c 100644 --- a/interface/jargs_parser_api.hpp +++ b/interface/jargs_parser_api.hpp @@ -1,5 +1,219 @@ +/** + * @file jargs_parser_api.hpp + * @brief A header-only c++ argument parser lib + * @version 0.0.2 + * @date 2022-10-16 + * + * @url https://github.com/ZhengqiaoWang/JArgsParser + * + */ #ifndef JARGS_PARSER_API_H #define JARGS_PARSER_API_H + +/**************************************************** + 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 [2022] [ZhengqiaoWang] + + 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 #include #include @@ -12,6 +226,10 @@ namespace Joger { namespace ArgsParser { + /** + * @brief Arguments types + * + */ enum ArgsType : unsigned int { POSITION = 0, @@ -20,6 +238,10 @@ namespace Joger ACTION = 3 }; + /** + * @brief Argument value type + * + */ enum class ArgsValType { INT, @@ -30,9 +252,21 @@ namespace Joger LIST_STRING, NOTYPE }; + + /** + * @brief Argument description + * + */ class ArgsDesc { public: + /** + * @brief position argument description + * + * @param key key to get argument + * @param arg_val_type arg value type + * @param description arg info, display when call for help + */ ArgsDesc(const std::string &key, const ArgsValType &arg_val_type, const std::string description) : key(key), @@ -43,6 +277,15 @@ namespace Joger { arg_width = key.size(); } + + /** + * @brief flag argument description + * + * @param key key to get argument + * @param short_name short arg like -a -b -c + * @param full_name full arg like --aaa --bbb --ccc + * @param description arg info, display when call for help + */ ArgsDesc(const std::string &key, const std::string &short_name, const std::string &full_name, @@ -56,6 +299,17 @@ namespace Joger { arg_width = short_name.size() + full_name.size() + 1; } + + /** + * @brief value argument description + * + * @param key key to get argument + * @param short_name short arg like -a -b -c + * @param full_name full arg like --aaa --bbb --ccc + * @param arg_val_type arg value type + * @param description arg info, display when call for help + * @param required set argument is required or not, true required, false not required. + */ ArgsDesc(const std::string &key, const std::string &short_name, const std::string &full_name, @@ -71,6 +325,16 @@ namespace Joger { arg_width = short_name.size() + full_name.size() + 1; } + + /** + * @brief action argument description + * + * @param key key to get argument + * @param short_name short arg like -a -b -c + * @param full_name full arg like --aaa --bbb --ccc + * @param action an void(void) function call when user use this argument + * @param description arg info, display when call for help + */ ArgsDesc(const std::string &key, const std::string &short_name, const std::string &full_name, @@ -92,22 +356,39 @@ namespace Joger } public: - std::string key; - ArgsType arg_type; - ArgsValType arg_val_type; - std::string short_name, full_name, description; - bool required{false}; - std::function action; - int arg_width{0}; + std::string key; ///< primary key for get arg value + ArgsType arg_type; ///< arg type + ArgsValType arg_val_type; ///< arg value type + std::string short_name; ///< short arg + std::string full_name; ///< full(long) arg + std::string description; ///< arg info + bool required{false}; ///< required flag + std::function action; ///< what function after action arg called + int arg_width{0}; ///< store the width of both short_name and full_name to display help }; static bool isInterger(const std::string &in_val); static bool isFloat(const std::string &in_val); static std::vector splitString(const std::string &in_val, const char &spliter); + /** + * @brief JArgsParser + * + * get document or help from GitHub: https://github.com/ZhengqiaoWang/JArgsParser + * + */ class JArgsParser { public: + /** + * @brief Construct a new JArgsParser object + * + * @param argc arg num + * @param argv arg char* array + * @param description application's description + * @param copyright application's copyright + * @param version application's version string + */ JArgsParser(int argc, char const *argv[], const std::string &description, @@ -125,7 +406,13 @@ namespace Joger } public: - void setArgument(const ArgsDesc &args_desc) + /** + * @brief Set an argument + * + * @param args_desc argument description + * @return JArgsParser& JArgsParser + */ + JArgsParser &setArgument(const ArgsDesc &args_desc) { auto &key = args_desc.key; switch (args_desc.arg_type) @@ -160,7 +447,15 @@ namespace Joger } m_arg_map[args_desc.arg_type][key] = args_desc; m_arg_max_length = args_desc.arg_width > m_arg_max_length ? args_desc.arg_width : m_arg_max_length; + return *this; } + + /** + * @brief start to parse arguments and check + * + * @return true success + * @return false failed + */ bool parseArgs() { if (m_argc <= 1) @@ -202,9 +497,9 @@ namespace Joger if (!m_argv_vec.empty()) { printf("ERROR: unknown arguments: "); - for(auto&item:m_argv_vec) + for (auto &item : m_argv_vec) { - printf("%s ",item.c_str()); + printf("%s ", item.c_str()); } printf("\n"); showHelp(); @@ -214,6 +509,15 @@ namespace Joger return true; } + /** + * @brief Get argument by key + * + * @tparam ValueType local argument type + * @param key key setted in setArgument + * @param out_val argument value + * @return true success + * @return false failed(not found) + */ template bool getArgument(const std::string &key, ValueType &out_val) { @@ -225,6 +529,10 @@ namespace Joger } public: + /** + * @brief show help + * + */ void showHelp() noexcept { printf("usage: %s ", m_app_file_name.c_str()); diff --git a/license b/license index 261eeb9..d011e00 100644 --- a/license +++ b/license @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright [2022] [ZhengqiaoWang] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.