C++ Demangler Rewrite

.gitignore

@@ -1,2 +1,7 @@
 build*/
 .cache/
+debug_demangler
+debug_demangler.c
+debug_demangler.dSYM/
+compile_commands.json
+steps-grammars

README.md

@@ -32,3 +32,68 @@ demangle -s pascal 'OUTPUT_$$_init'
 meson --prefix=/usr -Dinstall_lib=true build
 ninja -C build install
 ```
+
+## Demangler
+
+## Graphviz Tracing
+
+The C++ demangler now supports visual tracing via Graphviz for debugging complex parsing scenarios. Instead of text-based trace logs, the system generates `.dot` files that can be rendered as visual graphs showing the parsing tree.
+
+### Features
+
+- **Visual parsing tree**: Each rule invocation becomes a node in the graph
+- **Success/failure tracking**: Nodes are color-coded:
+  - 🟢 **Green**: Successful rule matches
+  - 🔴 **Red**: Failed rule matches  
+  - 🟠 **Orange**: Backtracked attempts (dashed border)
+  - 🔵 **Blue**: Currently running rules
+- **Position tracking**: Shows parsing position and input snippets
+- **Result display**: Successful nodes show their output
+- **Parent-child relationships**: Edges show rule call hierarchy
+- **Backtracking visualization**: Clearly shows which paths were abandoned
+
+### Usage
+
+Enable tracing by setting the `DEMANGLE_TRACE` environment variable:
+
+```bash
+export DEMANGLE_TRACE=1
+./your_demangler _ZN4llvm8DenseMapIPKN5clang4DeclEPNS_6WeakVHEE
+```
+
+Or compile with `-DENABLE_GRAPHVIZ_TRACE` to always enable tracing.
+
+This will generate a file like `demangle_trace__ZN4llvm8DenseMapIPKN5clang4DeclEPNS_6WeakVHE.dot`.
+
+### Generating Images
+
+Convert the `.dot` file to a visual format:
+
+```bash
+# PNG image
+dot -Tpng demangle_trace.dot -o parsing_tree.png
+
+# SVG (scalable)
+dot -Tsvg demangle_trace.dot -o parsing_tree.svg
+
+# PDF
+dot -Tpdf demangle_trace.dot -o parsing_tree.pdf
+```
+
+### Graph Structure
+
+The generated graph shows:
+- **Root node**: The initial `mangled_name` rule
+- **Child nodes**: All rules called during parsing
+- **Edge colors**: Match the node status (green for success, red for failure, etc.)
+- **Node labels**: Include rule name, position, input snippet, and result
+- **Legend**: Explains the color coding
+
+This visual representation makes it much easier to understand complex backtracking scenarios and identify where parsing issues occur.
+
+## Building
+
+```
+meson -Dbuildtype=debugoptimized -Db_sanitize=address,undefined build
+ninja -C build test
+```

meson.build

@@ -5,8 +5,15 @@ cc = meson.get_compiler('c')
 common_c_args = []
 libdemangle_c_args = []
 libdemangle_src = [
-  'src' / 'cxx' / 'borland.c',
+  'src' / 'borland.c',
   'src' / 'cxx.c',
+
+  'src' / 'cplusplus' / 'demangle.c',
+  'src' / 'cplusplus' / 'common.c',
+  'src' / 'cplusplus' / 'param.c',
+  'src' / 'cplusplus' / 'v2.c',
+  'src' / 'cplusplus' / 'v3.c',
+
   'src' / 'demangler.c',
   'src' / 'demangler_util.c',
   'src' / 'java.c',
@@ -27,16 +34,38 @@ tests = [
   'objc',
   'pascal',
   'rust',
-]
 
-if get_option('use_gpl')
-  libdemangle_src += 'src' / 'cxx' / 'cp-demangle.c'
-  libdemangle_src += 'src' / 'gnu_v2' / 'cplus-dem.c'
-  common_c_args += '-DWITH_GPL=1'
-  tests += 'cxx'
-  tests += 'cxx_base'
-  tests += 'cxx_gnu_v2'
-endif
+  'cxx.00',
+  'cxx.01',
+  'cxx.02',
+  'cxx.03',
+  'cxx.04',
+  'cxx.05',
+  'cxx.06',
+  'cxx.07',
+  'cxx.08',
+  'cxx.09',
+  'cxx.10',
+  'cxx.11',
+  'cxx.12',
+  'cxx.13',
+  'cxx.14',
+  'cxx.15',
+  'cxx.16',
+  'cxx.17',
+  'cxx.18',
+  'cxx.19',
+  'cxx.20',
+  'cxx.21',
+  'cxx.22',
+  'cxx.23',
+  'cxx.24',
+  'cxx.25',
+  'cxx.26',
+
+  'cxx_base',
+  'cxx_gnu_v2',
+]
 
 if get_option('use_swift_demangler')
   libdemangle_src += 'src' / 'swift.c'
@@ -56,25 +85,30 @@ elif cc.has_argument('--std=c99')
   add_project_arguments('--std=c99', language: 'c')
 endif
 
-libdemangle = library('demangle', libdemangle_src,
-    c_args : common_c_args + libdemangle_c_args,
-    dependencies: [],
-    implicit_include_directories: false,
-    install: get_option('install_lib'),
-    include_directories: include_directories(['include', 'src']))
+libdemangle = library(
+  'demangle',
+  libdemangle_src,
+  c_args: common_c_args + libdemangle_c_args,
+  dependencies: [],
+  implicit_include_directories: false,
+  install: get_option('install_lib'),
+  include_directories: include_directories(['include', 'src']),
+)
 
 libdemangle_dep = declare_dependency(
-    link_with: libdemangle,
-    dependencies: [],
-    include_directories: include_directories('include'),
+  link_with: libdemangle,
+  dependencies: [],
+  include_directories: include_directories('include'),
 )
 
 if get_option('enable_cli')
   bin_demangle = [
     'bin' / 'demangle.c',
   ]
-  executable('demangle', bin_demangle,
-    c_args : common_c_args,
+  executable(
+    'demangle',
+    bin_demangle,
+    c_args: common_c_args,
     dependencies: [libdemangle_dep],
     include_directories: include_directories(['include', 'src']),
     implicit_include_directories: false,
@@ -91,13 +125,15 @@ if get_option('enable_tests') and not meson.is_subproject()
     test_dependencies += cc.find_library('ubsan')
   endif
   foreach test : tests
-    exe = executable('test_@0@'.format(test), 'test/test_@[email protected]'.format(test),
+    exe = executable(
+      'test_@0@'.format(test),
+      'test/test_@[email protected]'.format(test),
       include_directories: include_directories(['include', 'test']),
       dependencies: test_dependencies,
-      c_args : common_c_args,
+      c_args: common_c_args,
       install: false,
       install_rpath: '',
-      implicit_include_directories: false
+      implicit_include_directories: false,
     )
     test(test, exe)
   endforeach

meson_options.txt

@@ -1,5 +1,4 @@
-option('use_gpl', type: 'boolean', value: true, description: 'Set to false when you want to disable gpl code')
 option('use_swift_demangler', type: 'boolean', value: true, description: 'If false, disables the swift demangler')
 option('install_lib', type: 'boolean', value: false, description: 'install libdemangle in the specified prefix path.')
 option('enable_cli', type: 'boolean', value: false, description: 'install a cli to demangle symbols.')
-option('enable_tests', type: 'boolean', value: true, description: 'Build unit tests in test/')
+option('enable_tests', type: 'boolean', value: true, description: 'Build unit tests in test/')

src/cplusplus/.clang-format

@@ -0,0 +1,149 @@
+---
+BasedOnStyle: Google
+AlignConsecutiveBitFields:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: true
+  PadOperators: true
+AlignAfterOpenBracket: BlockIndent
+AlignArrayOfStructures: Right
+AlignConsecutiveAssignments:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: false
+  PadOperators: true
+  AlignCompound: true
+AlignConsecutiveDeclarations:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: true
+  PadOperators: true
+AlignOperands: AlignAfterOperator
+AlignEscapedNewlines: Right
+AlignConsecutiveMacros:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: true
+  PadOperators: true
+AlignConsecutiveShortCaseStatements:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCaseColons: true
+AlignTrailingComments:
+  Kind: Always
+  OverEmptyLines: 2
+AllowAllArgumentsOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: Empty
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortEnumsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AttributeMacros:
+  - FORCE_INLINE
+  - PACKED
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterObjCDeclaration: false
+  AfterStruct: false
+  AfterUnion: false
+  AfterExternBlock: false
+  BeforeElse: false
+  BeforeWhile: false
+  IndentBraces: true
+BracedInitializerIndentWidth: 4
+BreakArrays: false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInlineASMColon: Always
+BreakBeforeTernaryOperators: false
+BreakStringLiterals: true
+ColumnLimit: 100
+ContinuationIndentWidth: 4
+IncludeBlocks: Regroup
+IndentCaseBlocks: false
+IndentCaseLabels: true
+IndentExternBlock: Indent
+IndentGotoLabels: false
+IndentPPDirectives: AfterHash
+IndentWidth: 4
+IndentWrappedFunctionNames: true
+InsertBraces: false
+KeepEmptyLinesAtEOF: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+LineEnding: CRLF
+Macros:
+  - ALLOCATE(type, n) (type*)calloc(sizeof(type), n)
+  - FREE(x) free((void*)x)
+  - REALLOCATE(oldptr, type, n) (type*)realloc(oldptr, sizeof(type)*n)
+MaxEmptyLinesToKeep: 4
+PPIndentWidth: 4
+PointerAlignment: Right
+QualifierAlignment: Leave
+ReferenceAlignment: Right
+ReflowComments: true
+RemoveParentheses: Leave
+SortIncludes: CaseSensitive
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: true
+SpaceBeforeCpp11BracedList: true
+SpaceBeforeParens: NonEmptyParentheses
+SpaceBeforeParensOptions:
+  AfterControlStatements: true
+  AfterForeachMacros: true
+  AfterFunctionDeclarationName: true
+  AfterFunctionDefinitionName: true
+  AfterIfMacros: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpacesBeforeTrailingComments: 1
+UseTab: Never
+TabWidth: 4
+Standard: Latest
+SpacesInContainerLiterals: true
+SpacesInLineCommentPrefix:
+  Maximum: -1
+  Minimum: 1
+SpacesInParens: Never
+SpacesInSquareBrackets: false
+StatementAttributeLikeMacros:
+  - PACKED
+  - FORCE_INLINE
+TypeNames:
+  - Char
+  - ZString
+  - U1
+  - U2
+  - U4
+  - U8
+  - I1
+  - I2
+  - I4
+  - I8
+  - Size
+  - Size32
+  - Size64
+  - Off4
+  - Off8
+  - Addr4
+  - Addr8
+  - UintPtr
+CommentPragmas: .*
+Cpp11BracedListStyle: true

src/cplusplus/common.c

@@ -0,0 +1,38 @@
+#include "cplusplus/common.h"
+
+CpDem* cpdem_init (CpDem* dem, const char* mangled, CpDemOptions opts) {
+    if (!dem || !mangled) {
+        return NULL;
+    }
+
+    memset (dem, 0, sizeof (CpDem));
+    dem->original =
+        ((StrIter) {.beg = mangled, .end = mangled + strlen (mangled) + 1, .cur = mangled});
+    dem->opts = opts;
+    dem_string_init (&dem->base_name);
+    dem_string_init (&dem->suffix);
+    dem_string_init (&dem->prefix);
+    param_vec_init (&dem->func_params);
+    return dem;
+}
+
+void cpdem_fini (CpDem* dem) {
+    if (!dem) {
+        return;
+    }
+
+    /* free all demstring and deinit qualifiers vector */
+    vec_foreach_ptr (&dem->qualifiers, q, { dem_string_deinit (q); });
+    vec_deinit (&dem->qualifiers);
+
+    // deinit all func params first
+    param_vec_deinit (&dem->func_params);
+
+    dem_string_deinit (&dem->base_name);
+    dem_string_deinit (&dem->prefix);
+    dem_string_deinit (&dem->suffix);
+    dem_string_deinit (&dem->custom_operator);
+
+    memset (dem, 0, sizeof (CpDem));
+    return;
+}