args module (#437)

This completes rewriting the command line argument parsing to replace it with the Lyra library. The main() changes now allow for parsing project jamfiles before printing help text. And hence allow for all jam side args to be displayed with -h.

Author: grafikrobot

.ci/azp-linux-test.yml

@@ -1,46 +1,46 @@
 parameters:
-- name: b2_opts
-  type: string
-  default: ''
+  - name: b2_opts
+    type: string
+    default: ""
 
 steps:
-- bash: |
-    set -e
-    uname -a
-    ./.ci/linux-cxx-install.sh
-    python3 --version
-  displayName: Install
-- bash: |
-    set -e
-    cd src/engine
-    set PATH=${PATH};${CXX_PATH}
-    ./build.sh ${TOOLSET}
-    ./b2 -v
-    cd ../..
-    echo "using ${TOOLSET%%-[0-9]*} : : ${CXX} ;" > ${HOME}/user-config.jam
-  displayName: Build
-- bash: |
-    set -e
-    echo "Available system locales:"
-    locale -a
-    echo "Switch to C.UTF-8 locale."
-    export LC_ALL=C.UTF-8
-    cd test
-    ./test_all.py ${TOOLSET}
-    cd ..
-  displayName: Test
-- bash: |
-    set -e
-    ./src/engine/b2 b2 warnings-as-errors=on variant=debug,release ${TOOLSET:+toolset=$TOOLSET} ${{ parameters.b2_opts }}
-  displayName: "No Warnings"
-- bash: |
-    set -e
-    ./bootstrap.sh ${TOOLSET}
-    ./b2 --prefix=$HOME/temp/.b2 install ${TOOLSET:+toolset=$TOOLSET} ${{ parameters.b2_opts }}
-    rm ./b2
-    export PATH=$HOME/temp/.b2/bin:$PATH
-    cd $HOME
-    touch build.jam
-    b2 -v
-    b2 -n --debug-configuration ${TOOLSET:+toolset=$TOOLSET} ${{ parameters.b2_opts }}
-  displayName: Bootstrap
+  - bash: |
+      set -e
+      uname -a
+      ./.ci/linux-cxx-install.sh
+      python3 --version
+    displayName: Install
+  - bash: |
+      set -e
+      cd src/engine
+      set PATH=${PATH};${CXX_PATH}
+      ./build.sh ${TOOLSET}
+      ./b2 -v
+      cd ../..
+      echo "using ${TOOLSET%%-[0-9]*} : : ${CXX} ;" > ${HOME}/user-config.jam
+    displayName: Build
+  - bash: |
+      set -e
+      echo "Available system locales:"
+      locale -a
+      echo "Switch to C.UTF-8 locale."
+      export LC_ALL=C.UTF-8
+      cd test
+      ./test_all.py ${TOOLSET}
+      cd ..
+    displayName: Test
+  - bash: |
+      set -e
+      ./src/engine/b2 b2 warnings-as-errors=on variant=debug,release ${TOOLSET:+toolset=$TOOLSET} ${{ parameters.b2_opts }}
+    displayName: "No Warnings"
+  - bash: |
+      set -e
+      ./bootstrap.sh ${TOOLSET}
+      ./b2 --prefix=$HOME/temp/.b2 install ${TOOLSET:+toolset=$TOOLSET} ${{ parameters.b2_opts }}
+      rm ./b2
+      export PATH=$HOME/temp/.b2/bin:$PATH
+      cd $HOME
+      touch build.jam
+      b2 -v
+      b2 -n --debug-configuration ${TOOLSET:+toolset=$TOOLSET} ${{ parameters.b2_opts }}
+    displayName: Bootstrap

.clang-format

@@ -7,11 +7,14 @@ UseTab: Always
 Language: Cpp
 AccessModifierOffset: 0
 AlignAfterOpenBracket: DontAlign
-AlignConsecutiveAssignments: false
-AlignConsecutiveDeclarations: false
+AlignArrayOfStructures: None
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: None
+AlignConsecutiveDeclarations: None
+AlignConsecutiveMacros: None
 AlignEscapedNewlines: DontAlign
 AlignOperands: DontAlign
-AlignTrailingComments: false
+AlignTrailingComments: { Kind: Never }
 AllowAllArgumentsOnNextLine: true
 AllowAllConstructorInitializersOnNextLine: true
 AllowAllParametersOfDeclarationOnNextLine: true
@@ -29,22 +32,22 @@ BinPackParameters: false
 BitFieldColonSpacing: Both
 BreakBeforeBraces: Custom
 BraceWrapping:
-  AfterCaseLabel: true
-  AfterClass: true
-  AfterControlStatement: Always
-  AfterEnum: true
-  AfterExternBlock: true
-  AfterFunction: true
-  AfterNamespace: false
-  AfterStruct: true
-  AfterUnion: true
-  BeforeCatch: true
-  BeforeElse: true
-  BeforeWhile: true
-  IndentBraces: false
-  SplitEmptyFunction: false
-  SplitEmptyNamespace: true
-  SplitEmptyRecord: false
+ AfterCaseLabel: true
+ AfterClass: true
+ AfterControlStatement: Always
+ AfterEnum: true
+ AfterExternBlock: true
+ AfterFunction: true
+ AfterNamespace: false
+ AfterStruct: true
+ AfterUnion: true
+ BeforeCatch: true
+ BeforeElse: true
+ BeforeWhile: true
+ IndentBraces: false
+ SplitEmptyFunction: false
+ SplitEmptyNamespace: true
+ SplitEmptyRecord: false
 BreakBeforeBinaryOperators: All
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializers: BeforeComma
@@ -70,6 +73,7 @@ NamespaceIndentation: None
 PenaltyBreakBeforeFirstCallParameter: 0
 PenaltyBreakFirstLessLess: 0
 PenaltyReturnTypeOnItsOwnLine: 999999
+PenaltyIndentedWhitespace: 999999
 PointerAlignment: Middle
 PPIndentWidth: 0
 ReflowComments: true

.editorconfig

@@ -15,6 +15,10 @@ trim_trailing_whitespace = true
 indent_size = 2
 indent_style = space
 
+[*.clang-format]
+indent_size = 1
+indent_style = space
+
 [*.jam]
 indent_style = space
 

.vscode/launch.json

@@ -8,7 +8,7 @@
 			"name": "(gdb) Pipe Launch",
 			"type": "cppdbg",
 			"request": "launch",
-			"program": "/root/b2/.build/gcc-12/debug/cxxstd-11-iso/threading-multi/b2",
+			"program": "/root/b2/.build/gcc-14/debug/cxxstd-11-iso/threading-multi/b2",
 			"args": [],
 			"stopAtEntry": true,
 			"cwd": "/root/b2/test/grep",
@@ -68,11 +68,16 @@
 			"request": "launch",
 			"program": "${workspaceFolder}\\.build\\msvc-14.3\\debug\\cxxstd-11-iso\\threading-multi\\b2.exe",
 			"args": [
-				"-v"
+				"-ftest.jam"
 			],
 			"stopAtEntry": false,
-			"cwd": "${workspaceFolder}\\src\\engine",
-			"environment": []
+			"cwd": "${workspaceFolder}\\test",
+			"environment": [
+				{
+					"name": "BOOST_BUILD_PATH",
+					"value": "${workspaceFolder}"
+				}
+			]
 		},
 		{
 			"name": "(msvc) Launch, Unit Tests",
@@ -92,10 +97,12 @@
 			"name": "(gcc) Launch",
 			"type": "cppdbg",
 			"request": "launch",
-			"program": "${workspaceFolder}/.build/gcc-13/debug/cxxstd-11-iso/threading-multi/b2",
-			"args": ["-d1", "--command-database=json", "b2"],
+			"program": "${workspaceFolder}/.build/gcc-14/debug/cxxstd-11-iso/threading-multi/b2",
+			"args": [
+				"-h"
+			],
 			"stopAtEntry": false,
-			"cwd": "${workspaceFolder}",
+			"cwd": "${workspaceFolder}/example/hello",
 			"environment": [],
 			"externalConsole": false,
 			"MIMode": "gdb",
@@ -111,10 +118,10 @@
 			"name": "(gcc) Launch: ASAN",
 			"type": "cppdbg",
 			"request": "launch",
-			"program": "${workspaceFolder}/.build/gcc-13/debug/address-sanitizer-on/cxxstd-11-iso/b2",
+			"program": "${workspaceFolder}/.build/gcc-14/debug/address-sanitizer-on/cxxstd-11-iso/threading-multi/b2",
 			"args": [
-				"-na",
-				"toolset=gcc"
+				"-n",
+				"-a"
 			],
 			"stopAtEntry": false,
 			"cwd": "${workspaceFolder}",
@@ -133,7 +140,7 @@
 			"name": "(gcc) Launch, Unit Tests",
 			"type": "cppdbg",
 			"request": "launch",
-			"program": "${workspaceFolder}/.build/gcc-13/debug/cxxstd-11-iso/threading-multi/b2",
+			"program": "${workspaceFolder}/.build/gcc-14/debug/cxxstd-11-iso/threading-multi/b2",
 			"args": [
 				"--debug",
 				"--build-system=test/test",
@@ -158,7 +165,7 @@
 			"name": "(gcc) Launch, Unit Tests: ASAN",
 			"type": "cppdbg",
 			"request": "launch",
-			"program": "${workspaceFolder}/.build/gcc-13/debug/address-sanitizer-on/cxxstd-11-iso/b2",
+			"program": "${workspaceFolder}/.build/gcc-14/debug/address-sanitizer-on/cxxstd-11-iso/b2",
 			"args": [
 				"--debug",
 				"--build-system=test/test",
@@ -187,7 +194,7 @@
 			"name": "(rr) Launch",
 			"type": "cppdbg",
 			"request": "launch",
-			"program": "${workspaceFolder}/.build/gcc-13/debug/cxxstd-11-iso/b2",
+			"program": "${workspaceFolder}/.build/gcc-14/debug/cxxstd-11-iso/b2",
 			"args": [
 				"--grep"
 			],

doc/src/history.adoc

@@ -9,6 +9,9 @@
 * *New*: Add generic `cc` toolset for simply, direct, configuration of unknown
   C compiler toolsets (for example `tcc`).
   -- _René Ferdinand Rivera Morell_
+* *New*: Add `args` module for common handling of both native and Jam side
+  command line arguments.
+  -- _René Ferdinand Rivera Morell_
 * Fix command database output file path when an output dir is not given.
   -- _René Ferdinand Rivera Morell_
 * Fix asciidoctor ignoring relevant features when building which caused invalid
@@ -28,6 +31,10 @@
   -- _Andrey Semashev_
 * Fix Building on Haiku OS which doesn't have `wait4`.
   -- _Fas Xmut_
+* Rewrite the command like argument parsing to use the Lyra library. The result
+  is that arguments from Jam and native are integrated and available with the
+  built-in `-h` help.
+  -- _René Ferdinand Rivera Morell_
 
 == Version 5.2.1
 

doc/src/reference.adoc

@@ -780,6 +780,7 @@ include::../../src/engine/mod_set.h[tag=reference]
 include::../../src/engine/mod_string.h[tag=reference]
 include::../../src/engine/mod_version.h[tag=reference]
 include::../../src/engine/mod_db.h[tag=reference]
+include::../../src/engine/mod_args.h[tag=reference]
 
 include::path.adoc[]