Sarcasm
commented
3 years ago Copy-pasting my answer from here:
I think compdb is correct, it could just be an issue with incorrect shell command parsing from the tool you use.
The escaping performed by compdb is on purpose, because JSON compilation database command is a shell command in a JSON string.
compdb outputs entries with the command key, not arguments, so it's normal that there is a difference in escaping between compdb and bear.
If the tool correctly parses command using something like Python shlex.split() it should be ok.
Confusingly, I think the official JSON Compilation Database documentation example is wrong:
Example:
[ { "directory": "/home/user/llvm/build", "command": "/usr/bin/clang++ -Irelative -DSOMEDEF=\"With spaces, quotes and \\-es.\" -c -o file.o file.cc", "file": "file.cc" }, ... ]
But from what I remember, tools producing command where mostly correct, and libclang JSON parsing was too.
/usr/bin/clang++ -Irelative -DSOMEDEF="With spaces, quotes and \-es." -c -o file.o file.ccExample of parsing issue with and without proper escaping:
$ tail -n +1 /tmp/print_args.py /tmp/command.json
==> /tmp/print_args.py <==
#!/usr/bin/env python
import json
import shlex
import sys
with open(sys.argv[1]) as fp:
data = json.load(fp)
for i, entry in enumerate(data):
if i != 0:
print("")
arguments = shlex.split(entry["command"], posix=True)
for argument in arguments:
print(argument)
==> /tmp/command.json <==
[
{ "directory": "/home/user/llvm/build",
"command": "clang++ -DGIT_VERSION=\"9c90bc5c\"",
"file": "foo.cc"
},
{ "directory": "/home/user/llvm/build",
"command": "clang++ -DGIT_VERSION=\\\"9c90bc5c\\\"",
"file": "bar.cc"
}
]
$ python /tmp/print_args.py /tmp/command.json
clang++
-DGIT_VERSION=9c90bc5c
clang++
-DGIT_VERSION="9c90bc5c"Ideally, compdb should output arguments instead of command, which is less confusing to use.
zancas
I am mainly using compdb together with Bear, so this may be specific to the processing of
"arguments"formatted input. But if a compilation flag such as-DVAR="STRING"is sent in, where it appears with this JSON compliant syntax:The result is
So far the editors & tools i'd configured, VSCode's c++ plugin, and
ccls, were fine with this (even though I noticed the problem when setting up my scripting), but now my scripting when invoking clang fails withbecause it is attempting to generate invalid C++ code that includes the extra (incorrectly python-escaped) backslash...