2013-11-22 16:00:20 +08:00
|
|
|
This directory contains a VSPackage project to generate a Visual Studio extension
|
2013-09-05 00:11:46 +08:00
|
|
|
for clang-format.
|
|
|
|
|
|
|
|
|
|
Build prerequisites are:
|
2016-12-02 02:05:41 +08:00
|
|
|
- Visual Studio 2015
|
|
|
|
|
- Extensions SDK (you'll be prompted to install it if you open ClangFormat.sln)
|
2013-12-03 01:31:52 +08:00
|
|
|
|
2016-12-02 02:05:41 +08:00
|
|
|
The extension is built using CMake to generate the usual LLVM.sln by setting
|
|
|
|
|
the following CMake vars:
|
|
|
|
|
|
|
|
|
|
- BUILD_CLANG_FORMAT_VS_PLUGIN=ON
|
|
|
|
|
|
2019-11-26 17:16:06 +08:00
|
|
|
- NUGET_EXE_DIR=path/to/nuget_dir (unless nuget.exe is already available in PATH)
|
2016-12-02 02:05:41 +08:00
|
|
|
|
|
|
|
|
example:
|
|
|
|
|
cd /d C:\code\llvm
|
|
|
|
|
mkdir build & cd build
|
2019-11-26 17:16:06 +08:00
|
|
|
cmake -DBUILD_CLANG_FORMAT_VS_PLUGIN=ON -DNUGET_EXE_DIR=C:\nuget ..
|
2016-12-02 02:05:41 +08:00
|
|
|
|
|
|
|
|
Once LLVM.sln is generated, build the clang_format_vsix target, which will build
|
|
|
|
|
ClangFormat.sln, the C# extension application.
|
2013-12-04 02:02:51 +08:00
|
|
|
|
2014-08-02 01:38:53 +08:00
|
|
|
The CMake build will copy clang-format.exe and LICENSE.TXT into the ClangFormat/
|
|
|
|
|
directory so they can be bundled with the plug-in, as well as creating
|
|
|
|
|
ClangFormat/source.extension.vsixmanifest. Once the plug-in has been built with
|
|
|
|
|
CMake once, it can be built manually from the ClangFormat.sln solution in Visual
|
|
|
|
|
Studio.
|
2016-12-16 09:51:43 +08:00
|
|
|
|
|
|
|
|
===========
|
|
|
|
|
Debugging
|
|
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
Once you've built the clang_format_vsix project from LLVM.sln at least once,
|
|
|
|
|
open ClangFormat.sln in Visual Studio, then:
|
|
|
|
|
|
|
|
|
|
- Make sure the "Debug" target is selected
|
|
|
|
|
- Open the ClangFormat project properties
|
|
|
|
|
- Select the Debug tab
|
|
|
|
|
- Set "Start external program:" to where your devenv.exe is installed. Typically
|
|
|
|
|
it's "C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\devenv.exe"
|
|
|
|
|
- Set "Command line arguments" to: /rootsuffix Exp
|
|
|
|
|
- You can now set breakpoints if you like
|
|
|
|
|
- Press F5 to build and run with debugger
|
|
|
|
|
|
|
|
|
|
If all goes well, a new instance of Visual Studio will be launched in a special
|
|
|
|
|
mode where it uses the experimental hive instead of the normal configuration hive.
|
|
|
|
|
By default, when you build a VSIX project in Visual Studio, it auto-registers the
|
|
|
|
|
extension in the experimental hive, allowing you to test it. In the new Visual Studio
|
|
|
|
|
instance, open or create a C++ solution, and you should now see the Clang Format
|
|
|
|
|
entries in the Tool menu. You can test it out, and any breakpoints you set will be
|
|
|
|
|
hit where you can debug as usual.
|
