Skip to content

Commit a3cc893

Browse files
committed
base impl
0 parents  commit a3cc893

File tree

15 files changed

+1746
-0
lines changed

15 files changed

+1746
-0
lines changed

.github/workflows/ci.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Setup xmake
17+
uses: xmake-io/github-action-setup-xmake@v1
18+
with:
19+
xmake-version: latest
20+
package-cache: true
21+
22+
- name: Install dependencies
23+
run: |
24+
sudo apt-get update
25+
sudo apt-get install -y build-essential
26+
27+
- name: Install Xlings
28+
run: curl -fsSL https://d2learn.org/xlings-install.sh | bash
29+
30+
- name: Install GCC 15.1 with Xlings
31+
run: |
32+
export PATH=/home/xlings/.xlings_data/bin:$PATH
33+
xlings install gcc@15.1 -y
34+
35+
- name: Build
36+
run: |
37+
export PATH=/home/xlings/.xlings_data/bin:$PATH
38+
xmake -y
39+
40+
- name: Test
41+
run: |
42+
export PATH=/home/xlings/.xlings_data/bin:$PATH
43+
xmake run cmdline_test
44+
45+
- name: Run examples (smoke)
46+
run: |
47+
export PATH=/home/xlings/.xlings_data/bin:$PATH
48+
xmake run with_dispatch -- add python 3.12
49+
xmake run with_dispatch -- remove foo

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.xmake
2+
build

LICENSE

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
Copyright (c) 2025-present mcpp community, speakshen@163.com
2+
3+
---
4+
5+
Apache License
6+
Version 2.0, January 2004
7+
http://www.apache.org/licenses/
8+
9+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
10+
11+
1. Definitions.
12+
13+
"License" shall mean the terms and conditions for use, reproduction,
14+
and distribution as defined by Sections 1 through 9 of this document.
15+
16+
"Licensor" shall mean the copyright owner or entity authorized by
17+
the copyright owner that is granting the License.
18+
19+
"Legal Entity" shall mean the union of the acting entity and all
20+
other entities that control, are controlled by, or are under common
21+
control with that entity. For the purposes of this definition,
22+
"control" means (i) the power, direct or indirect, to cause the
23+
direction or management of such entity, whether by contract or
24+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
25+
outstanding shares, or (iii) beneficial ownership of such entity.
26+
27+
"You" (or "Your") shall mean an individual or Legal Entity
28+
exercising permissions granted by this License.
29+
30+
"Source" form shall mean the preferred form for making modifications,
31+
including but not limited to software source code, documentation
32+
source, and configuration files.
33+
34+
"Object" form shall mean any form resulting from mechanical
35+
transformation or translation of a Source form, including but
36+
not limited to compiled object code, generated documentation,
37+
and conversions to other media types.
38+
39+
"Work" shall mean the work of authorship, whether in Source or
40+
Object form, made available under the License, as indicated by a
41+
copyright notice that is included in or attached to the work
42+
(an example is provided in the Appendix below).
43+
44+
"Derivative Works" shall mean any work, whether in Source or Object
45+
form, that is based on (or derived from) the Work and for which the
46+
editorial revisions, annotations, elaborations, or other modifications
47+
represent, as a whole, an original work of authorship. For the purposes
48+
of this License, Derivative Works shall not include works that remain
49+
separable from, or merely link (or bind by name) to the interfaces of,
50+
the Work and Derivative Works thereof.
51+
52+
"Contribution" shall mean any work of authorship, including
53+
the original version of the Work and any modifications or additions
54+
to that Work or Derivative Works thereof, that is intentionally
55+
submitted to Licensor for inclusion in the Work by the copyright owner
56+
or by an individual or Legal Entity authorized to submit on behalf of
57+
the copyright owner. For the purposes of this definition, "submitted"
58+
means any form of electronic, verbal, or written communication sent
59+
to the Licensor or its representatives, including but not limited to
60+
communication on electronic mailing lists, source code control systems,
61+
and issue tracking systems that are managed by, or on behalf of, the
62+
Licensor for the purpose of discussing and improving the Work, but
63+
excluding communication that is conspicuously marked or otherwise
64+
designated in writing by the copyright owner as "Not a Contribution."
65+
66+
"Contributor" shall mean Licensor and any individual or Legal Entity
67+
on behalf of whom a Contribution has been received by Licensor and
68+
subsequently incorporated within the Work.
69+
70+
2. Grant of Copyright License. Subject to the terms and conditions of
71+
this License, each Contributor hereby grants to You a perpetual,
72+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
73+
copyright license to reproduce, prepare Derivative Works of,
74+
publicly display, publicly perform, sublicense, and distribute the
75+
Work and such Derivative Works in Source or Object form.
76+
77+
3. Grant of Patent License. Subject to the terms and conditions of
78+
this License, each Contributor hereby grants to You a perpetual,
79+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
80+
(except as stated in this section) patent license to make, have made,
81+
use, offer to sell, sell, import, and otherwise transfer the Work,
82+
where such license applies only to those patent claims licensable
83+
by such Contributor that are necessarily infringed by their
84+
Contribution(s) alone or by combination of their Contribution(s)
85+
with the Work to which such Contribution(s) was submitted. If You
86+
institute patent litigation against any entity (including a
87+
cross-claim or counterclaim in a lawsuit) alleging that the Work
88+
or a Contribution incorporated within the Work constitutes direct
89+
or contributory patent infringement, then any patent licenses
90+
granted to You under this License for that Work shall terminate
91+
as of the date such litigation is filed.
92+
93+
4. Redistribution. You may reproduce and distribute copies of the
94+
Work or Derivative Works thereof in any medium, with or without
95+
modifications, and in Source or Object form, provided that You
96+
meet the following conditions:
97+
98+
(a) You must give any other recipients of the Work or
99+
Derivative Works a copy of this License; and
100+
101+
(b) You must cause any modified files to carry prominent notices
102+
stating that You changed the files; and
103+
104+
(c) You must retain, in the Source form of any Derivative Works
105+
that You distribute, all copyright, patent, trademark, and
106+
attribution notices from the Source form of the Work,
107+
excluding those notices that do not pertain to any part of
108+
the Derivative Works; and
109+
110+
(d) If the Work includes a "NOTICE" text file as part of its
111+
distribution, then any Derivative Works that You distribute must
112+
include a readable copy of the attribution notices contained
113+
within such NOTICE file, excluding those notices that do not
114+
pertain to any part of the Derivative Works, in at least one
115+
of the following places: within a NOTICE text file distributed
116+
as part of the Derivative Works; within the Source form or
117+
documentation, if provided along with the Derivative Works; or,
118+
within a display generated by the Derivative Works, if and
119+
wherever such third-party notices normally appear. The contents
120+
of the NOTICE file are for informational purposes only and
121+
do not modify the License. You may add Your own attribution
122+
notices within Derivative Works that You distribute, alongside
123+
or as an addendum to the NOTICE text from the Work, provided
124+
that such additional attribution notices cannot be construed
125+
as modifying the License.
126+
127+
You may add Your own copyright statement to Your modifications and
128+
may provide additional or different license terms and conditions
129+
for use, reproduction, or distribution of Your modifications, or
130+
for any such Derivative Works as a whole, provided Your use,
131+
reproduction, and distribution of the Work otherwise complies with
132+
the conditions stated in this License.
133+
134+
5. Submission of Contributions. Unless You explicitly state otherwise,
135+
any Contribution intentionally submitted for inclusion in the Work
136+
by You to the Licensor shall be under the terms and conditions of
137+
this License, without any additional terms or conditions.
138+
Notwithstanding the above, nothing herein shall supersede or modify
139+
the terms of any separate license agreement you may have executed
140+
with Licensor regarding such Contributions.
141+
142+
6. Trademarks. This License does not grant permission to use the trade
143+
names, trademarks, service marks, or product names of the Licensor,
144+
except as required for reasonable and customary use in describing the
145+
origin of the Work and reproducing the content of the NOTICE file.
146+
147+
7. Disclaimer of Warranty. Unless required by applicable law or
148+
agreed to in writing, Licensor provides the Work (and each
149+
Contributor provides its Contributions) on an "AS IS" BASIS,
150+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
151+
implied, including, without limitation, any warranties or conditions
152+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
153+
PARTICULAR PURPOSE. You are solely responsible for determining the
154+
appropriateness of using or redistributing the Work and assume any
155+
risks associated with Your exercise of permissions under this License.
156+
157+
8. Limitation of Liability. In no event and under no legal theory,
158+
whether in tort (including negligence), contract, or otherwise,
159+
unless required by applicable law (such as deliberate and grossly
160+
negligent acts) or agreed to in writing, shall any Contributor be
161+
liable to You for damages, including any direct, indirect, special,
162+
incidental, or consequential damages of any character arising as a
163+
result of this License or out of the use or inability to use the
164+
Work (including but not limited to damages for loss of goodwill,
165+
work stoppage, computer failure or malfunction, or any and all
166+
other commercial damages or losses), even if such Contributor
167+
has been advised of the possibility of such damages.
168+
169+
9. Accepting Warranty or Additional Liability. While redistributing
170+
the Work or Derivative Works thereof, You may choose to offer,
171+
and charge a fee for, acceptance of support, warranty, indemnity,
172+
or other liability obligations and/or rights consistent with this
173+
License. However, in accepting such obligations, You may act only
174+
on Your own behalf and on Your sole responsibility, not on behalf
175+
of any other Contributor, and only if You agree to indemnify,
176+
defend, and hold each Contributor harmless for any liability
177+
incurred by, or claims asserted against, such Contributor by reason
178+
of your accepting any such warranty or additional liability.
179+
180+
END OF TERMS AND CONDITIONS
181+
182+
APPENDIX: How to apply the Apache License to your work.
183+
184+
To apply the Apache License to your work, attach the following
185+
boilerplate notice, with the fields enclosed by brackets "[]"
186+
replaced with your own identifying information. (Don't include
187+
the brackets!) The text should be enclosed in the appropriate
188+
comment syntax for the file format. We also recommend that a
189+
file or class name and description of purpose be included on the
190+
same "printed page" as the copyright notice for easier
191+
identification within third-party archives.
192+
193+
Copyright [yyyy] [name of copyright owner]
194+
195+
Licensed under the Apache License, Version 2.0 (the "License");
196+
you may not use this file except in compliance with the License.
197+
You may obtain a copy of the License at
198+
199+
http://www.apache.org/licenses/LICENSE-2.0
200+
201+
Unless required by applicable law or agreed to in writing, software
202+
distributed under the License is distributed on an "AS IS" BASIS,
203+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
204+
See the License for the specific language governing permissions and
205+
limitations under the License.

README.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# cmdline
2+
3+
> 一个简单易用的命令行解析库/框架 - `import mcpplibs.cmdline;`
4+
5+
使用 C++23 模块的类型安全命令行解析库。流式链式接口,零样板代码。支持位置参数、短/长选项、子命令、全局标志,以及基于 `std::expected` 的错误处理。
6+
7+
## ✨ 特性
8+
9+
- **C++23 模块**`import mcpplibs.cmdline`
10+
11+
- **流式接口** — 链式构建方法,所见即所得的 API
12+
13+
- **子命令** — 支持 `action` 回调或手动分发的嵌套命令
14+
15+
- **全局选项** — 标志透明地传播到所有子命令
16+
17+
- **类型安全结果**`std::expected<ParsedArgs, std::string>`
18+
19+
- **多种解析模式** — 支持 `argc/argv``cmdline::Argv`(即 `vector<string>`)或原始 `string_view`
20+
21+
## 快速开始
22+
23+
```cpp
24+
import std;
25+
import mcpplibs.cmdline;
26+
27+
using namespace mcpplibs;
28+
29+
int main(int argc, char* argv[]) {
30+
auto app = cmdline::App("myapp")
31+
.version("1.0.0")
32+
.description("A demo CLI")
33+
.arg("input").required().help("输入文件")
34+
.option("verbose").short_name('v').help("详细输出")
35+
.option("config").short_name('c').takes_value().value_name("FILE").help("配置文件")
36+
.action([](const cmdline::ParsedArgs& p) {
37+
if (p.is_flag_set("verbose")) std::println("详细模式已开启");
38+
if (auto c = p.value("config")) std::println("配置文件: {}", *c);
39+
std::println("输入文件: {}", p.positional(0));
40+
});
41+
42+
return app.run(argc, argv);
43+
}
44+
```
45+
46+
### 子命令 + action / run
47+
48+
```cpp
49+
auto app = cmdline::App("demo")
50+
.version("0.1.0")
51+
.description("Demo: subcommands with action dispatch")
52+
.option("yes").short_name('y').global().help("自动确认")
53+
.subcommand("add")
54+
.description("添加目标")
55+
.arg("target").required()
56+
.arg("version").required()
57+
.action([](const cmdline::ParsedArgs& a) {
58+
std::println("add: {}@{}", a.value("target").value_or(""),
59+
a.value("version").value_or(""));
60+
})
61+
.subcommand("remove")
62+
.description("移除目标")
63+
.arg("target").required()
64+
.action([](const cmdline::ParsedArgs& a) { std::println("remove: {}", a.positional(0)); });
65+
66+
app.run(argc, argv);
67+
```
68+
69+
### 多种解析模式
70+
71+
```cpp
72+
auto r1 = app.parse(argc, argv);
73+
auto r2 = app.parse_from(cmdline::Argv{"myapp", "add", "x", "1.0"});
74+
auto r3 = app.parse_from("myapp remove x --yes");
75+
```
76+
77+
## 构建
78+
79+
```shell
80+
xmake # 构建库
81+
xmake run basic # 运行基础示例
82+
xmake -y run cmdline_test # 运行测试(自动安装 gtest)
83+
```
84+
85+
## 集成到构建工具
86+
87+
### xmake
88+
89+
```lua
90+
-- 添加 mcpplibs 包仓库
91+
add_repositories("mcpplibs-index https://github.com/mcpplibs/mcpplibs-index.git")
92+
93+
-- 添加依赖
94+
add_requires("cmdline")
95+
96+
target("mytool")
97+
set_kind("binary")
98+
set_languages("c++23")
99+
add_files("main.cpp")
100+
add_packages("cmdline")
101+
set_policy("build.c++.modules", true)
102+
```
103+
104+
### cmake
105+
106+
```
107+
todo...
108+
```
109+
110+
## 📄 许可证
111+
112+
Apache-2.0

0 commit comments

Comments
 (0)