Merge branch 'main' of https://github.com/goplus/llcppg into doc/import-from-conan

Author: MeteorsLiu

README.md

@@ -179,61 +179,50 @@ cJSON_bool Bool
 
 ### Customizing Bindings
 #### Function Customization
-When you run llcppg directly with the above configuration, it will generate function names according to the configuration. After execution, you'll find a `llcppg.symb.json` file in the current directory. 
+After execution, you can directly see the mapped functions in the result.
 
+```go
+//go:linkname CreateObject C.cJSON_CreateObject
+func CreateObject() *CJSON
+// llgo:link (*CJSON).AddItemToObject C.cJSON_AddItemToObject
+func (recv_ *CJSON) AddItemToObject(string *c.Char, item *CJSON) Bool {
+	return 0
+}
+/* Render a cJSON entity to text for transfer/storage without any formatting. */
+// llgo:link (*CJSON).PrintUnformatted C.cJSON_PrintUnformatted
+func (recv_ *CJSON) PrintUnformatted() *c.Char {
+	return nil
+}
+```
+You can specify function mapping behavior in `llcppg.cfg` by config the `symMap` field:
 ```json
-[
-  {
-    "mangle": "cJSON_CreateObject",
-    "c++": "cJSON_CreateObject()",
-    "go": "CreateObject"
-  },
-  {
-    "mangle": "cJSON_AddItemToObject",
-    "c++": "cJSON_AddItemToObject(cJSON *, const char *, cJSON *)",
-    "go": "(*CJSON).AddItemToObject"
-  },
-  {
-    "mangle": "cJSON_PrintUnformatted",
-    "c++": "cJSON_PrintUnformatted(const cJSON *)",
-    "go": "(*CJSON).PrintUnformatted"
-  },
-]
-```
-
-- `mangle` field contains the symbol name of function
-- `c++` field shows the function prototype from the header file
-- `go` field displays the function name that will be generated in LLGo binding. 
+{
+    "symMap":{
+        "mangle":"<goFuncName> | <.goMethodName> | -"
+    }
+}
+```
+`mangle` is the symbol name of the function. For the value of `mangle`, you can customize it as:
+  1. `goFuncName` - generates a regular function named `goFuncName`
+  2. `.goMethodName` - generates a method named `goMethodName` (if it doesn't meet the rules for generating a method, it will be generated as a regular function)
+  3. `-` - completely ignore this function
 
-  You can customize this field to:
-  1. Change function names (e.g. "CreateObject" to "Object" for simplicity)
-  2. Remove the method receiver prefix to generate a function instead of a method
-  3. Set it to "-" to completely ignore this function
-
-For example, to convert `(*CJSON).PrintUnformatted` from a method to a function, simply remove the `(*CJSON).` prefix in the configuration file:
+For example, to convert `(*CJSON).PrintUnformatted` from a method to a function, you can use follow config:
 
 ```json
-[
-  {
-    "mangle": "cJSON_PrintUnformatted",
-    "c++": "cJSON_PrintUnformatted(const cJSON *)",
-    "go": "PrintUnformatted"
-  },
-]
+{
+  "symMap":{
+    "cJSON_PrintUnformatted":"PrintUnformatted"
+  }
+}
 ```
 This will generate a function instead of a method in the Go code:
 ```go
 //go:linkname PrintUnformatted C.cJSON_PrintUnformatted
-func PrintUnformatted(item *CJSON) *int8
+func PrintUnformatted(item *CJSON) *c.Char
 ```
 
-You can customize the generated bindings by modifying the `llcppg.symb.json` file.
-
-After modifying the file, run llcppg again to apply your customized bindings.
-
-The symbol table is generated by llcppsymg, which is internally called by llcppg to generate the symbol table as input for Go code generation. 
-
-You can also run llcppsymg separately to customize the symbol table before running llcppg. To do this, use the command:
+You can also run llcppsymg separately. To do this, use the command:
 
 ```sh
 llcppg -symbgen

_llcppgtest/cjson/conf/linux/llcppg.cfg

@@ -11,5 +11,15 @@
 	},
 	"trimPrefixes": ["cJSON_", "cJSONUtils_"],
 	"cplusplus": false,
-	"mix":true
+	"mix":true,
+	"symMap": {
+		"cJSON_PrintUnformatted":".CStr",
+		"cJSON_CreateObject":"Object",
+		"cJSON_CreateArray":"Array",
+		"cJSON_CreateString":"String",
+		"cJSON_free":"FreeCStr",
+		"cJSON_AddItemToArray":".AddItem",
+		"cJSON_AddItemToObject":".SetItem",
+		"cJSON_free":"FreeCStr"
+	}
 }

_llcppgtest/cjson/conf/linux/llcppg.symb.json

@@ -10,5 +10,15 @@
 		"cJSON": "JSON"
 	},
 	"trimPrefixes": ["cJSON_", "cJSONUtils_"],
-	"cplusplus": false
+	"cplusplus": false,
+	"symMap": {
+		"cJSON_PrintUnformatted":".CStr",
+		"cJSON_CreateObject":"Object",
+		"cJSON_CreateArray":"Array",
+		"cJSON_CreateString":"String",
+		"cJSON_free":"FreeCStr",
+		"cJSON_AddItemToArray":".AddItem",
+		"cJSON_AddItemToObject":".SetItem",
+		"cJSON_free":"FreeCStr"
+	}
 }

_llcppgtest/cjson/llcppg.cfg

@@ -7,5 +7,8 @@
 		"raymath.h",
 		"rlgl.h"
 	],
-	"cplusplus": false
+	"cplusplus": false,
+	"symMap": {
+		"ClearBackground": "ClearBackground"
+	}
 }

_llcppgtest/cjson/llcppg.symb.json

@@ -8,5 +8,8 @@
 	],
 	"trimPrefixes": ["sqlite3_","SQLITE_"],
 	"cplusplus": false,
-	"mix":true
+	"mix":true,
+	"symMap":{
+		"sqlite3_finalize":".Close"
+	}
 }

_llcppgtest/raylib/llcppg.cfg

@@ -7,5 +7,8 @@
 		"sqlite3.h"
 	],
 	"trimPrefixes": ["sqlite3_","SQLITE_"],
-	"cplusplus": false
+	"cplusplus": false,
+	"symMap":{
+		"sqlite3_finalize":".Close"
+	}
 }