<div dir="ltr"><div class="gmail_quote"><div dir="ltr">On Tue, Nov 27, 2018 at 8:09 PM Anton Södergren via clangd-dev <<a href="mailto:clangd-dev@lists.llvm.org">clangd-dev@lists.llvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div>Hello! I'm not sure if this is the best place to ask, but it's better to get a discussion going rather than just being confused.</div></div></div></div></blockquote><div>Right place! Welcome :-)</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div>I tried using Clangd in Visual Studio Code, but noticed that it doesn't integrate well with the CMake Tools extension, which makes it hard to use together with a CMake workflow. I would like a way for Clangd to automatically get the correct info when CMake runs in the editor.</div><div>Specifically, I want seamless and automatic integration between these two extensions without the user having to do any additional config:</div><div><ul><li>vscode-clangd (<a href="https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd" target="_blank">https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd</a>)<br></li><li>CMake Tools (<a href="https://marketplace.visualstudio.com/items?itemName=vector-of-bool.cmake-tools" target="_blank">https://marketplace.visualstudio.com/items?itemName=vector-of-bool.cmake-tools</a>)</li></ul></div></div></div></div></blockquote><div>I'm not familiar with CMake Tools, I guess it helps with editing CMakeLists, CMake configs, and running configure/generate?</div><div>(Sorry, I would dig into it, about to head out on vacation)</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div><div>I see three possible approaches for this:</div><div><ol><li>Work with the author of CMake Tools to make the extension generate the appropriate info for vscode-clangd</li><li>Make vscode-clangd retrieve the info from CMake Tools somehow</li><li>Create a new extension that acts as a bridge between the two</li></ol><div>Or alternatively, some combination of the different approaches.</div><div>I know that the CMake Tools extension integrates well with Microsoft's C/C++ extension, so maybe it would be a good idea to do this in a similar way that they did it. If my understanding is correct, a separate bridge extension was previously used for this, but I think they now use a combination of something similar to approach 1 and 2 for the extensions to communicate with each other.</div><div>I would be interested to hear what you all think would be the best way to go about this, and maybe I can get in touch with vector-of-bools (the author of the CMake Tools extension) about it too.<br></div><div><br></div><div>Another question I had regarding this: how does Clangd find the correct include paths and other info in the first place? Does it use some kind of compilation commands file for this? Is it possible to tell Clangd where to look for such a file? I couldn't really find any documentation about this when I looked around.</div></div></div></div></div></div></blockquote><div>So if my understanding of CMake Tools is correct, these questions are very much related :-)</div><div><br></div><div>Clangd works like other clang-based tools. Starting at the source file in question, it walks up directories until it finds <a href="https://clang.llvm.org/docs/JSONCompilationDatabase.html">compile_commands.json</a>. This lists the flags required to compile each file in its scope.</div><div><br></div><div>So I think there are three relevant parts here:</div><div><ul><li>this file has to be created somehow. CMake can do this, it's controlled by <a href="https://cmake.org/cmake/help/v3.5/variable/CMAKE_EXPORT_COMPILE_COMMANDS.html">CMAKE_EXPORT_COMPILE_COMMANDS</a>, which I believe is on by default now. It writes the files into the root of the build tree.</li><li>the file has to be discovered somehow (if the CMake build tree != the source tree). The current best-practice is to manually create a symlink src/compile_commands.json -> build/compile_commands.json. I think symlinking src/.build to build/ is a slightly more principled approach, but something still has to create a symlink. (Maybe we could get CMake or CMake Tools to do it?). Or maybe there's some other clever way to find the build tree.</li><li>clangd has to reload the data when appropriate. Today, it caches forever :-( Ilya is working on fixing it!</li></ul><div>Gotta run, hope this helps!</div></div><div>Patches and ideas welcome :-)</div></div></div>