Generate `compile_commands.json`

[louwers]

Would be really neat if a compile_commands.json could be generated.

This way IDEs based on clangd can offer completion. https://clangd.llvm.org/design/compile-commands

I tried using Bear but it did not detect any compiler invocations. What happens when you run pebble build?

[louwers]

Blocked by #7 since https://github.com/coredevices/PebbleOS/blob/main/sdk/waf/waflib/extras/clang_compilation_database.py seems to be missing.

[louwers]

Workaround:

https://gitlab.com/ita1024/waf/-/blob/0c5a95927e0c3a5e3b9546581feb483c1393c8bd/waflib/extras/clang_compilation_database.py

Download this file, put it here:

Pebble SDK/SDKs/current/sdk-core/pebble/.waf3-1.7.11-951087d39789950ed009f0c86ce75e7b/waflib/extras

Add this line to def configure(ctx): in wscript

    ctx.load('clang_compilation_database')

Run pebble build

Then do ln -s build/compile_commands.json .

Now you have auto-completion in VS Code and other IDEs/editors.

[nytpu]

That workaround works great, although pipes was removed on Python 3.13 so it seems better to use this revision: https://gitlab.com/ita1024/waf/-/blob/5e4b86b81df3b9819738d757eb8d2c8646ef0ede/waflib/extras/clang_compilation_database.py And then delete the pipes import at the top (that is completely unused in this revision, but they never got around to removing it before rewriting the script such that it doesn't work with the Waf version).

Also, using this will automatically symlink to the root, and still allow building on SDK installations without the workaround (or old SDK versions once the SDK gets updated):

    try:
        ctx.load('clang_compilation_database')
        os.symlink(out + '/compile_commands.json', top + '/compile_commands.json')
    except:
        pass

[louwers]

@nytpu Apparantly, clangd will look for build/compile_commands.json as well, so I am not sure if the symlink is even needed.

clangd will look in the parent directories of the files you edit looking for it, and also in subdirectories named build/. For example, if editing $SRC/gui/window.cpp, we search in $SRC/gui/, $SRC/gui/build/, $SRC/, $SRC/build/, …

https://clangd.llvm.org/installation#project-setup