Clang format windows download

Clang-format is a tool for formatting C++, built on LLVM. This is a package that allows you to run it easily from within Sublime Text.

In this package, we provide an alternative wrapper around clang-format for use within Sublime Text 3. Whilst LLVM does provide a very simple plugin to work with Sublime Text here, it doesn’t really exploit any of the Sublime Text package functionality. We add new features such as customising the style from a settings file, selecting styles using the Command Palette, and easier installation.

• Install clang-format in one of the following ways:
  • Install using your package manager, e.g. sudo apt-get install clang-format or sudo apt-get install clang-format-5.0 .
  • Download the entire LLVM toolchain and extract the clang-format binary. Just extract the .tar.xz file and copy bin/clang-format into your PATH (e.g. /usr/local/bin ).
• Install this package through Package Control in the usual way.
• Set the path to the clang-format binaries. You can do this from within Sublime Text by choosing Clang Format — Set Path from the command palette. Hint: the path should look something like this [path/to/clang]/clang/bin/clang-format . If clang-format is in your system path, you shouldn’t need to do anything.

• Default shortcut is super+option+a on OSX and option+cmd+a otherwise. This will apply clang-format to the selection.
• From the command palette, you can select the formatting type by using Clang Format: Select Style . You will find the small number of defaults, and also a new ‘Custom’ entry. Selecting this entry allows you to customise the style through a settings file. You can access it from the main menu, under Package Settings . In this file you can add custom rules, such as Allmen style braces, and different indents. For examples see http://clang.llvm.org/docs/ClangFormatStyleOptions.html.
• Settings for the ‘Custom’ format and others are available through the Sublime Text preferences.
• It is possible to run the formatter on every save to a file, change settings to «format_on_save»: true .
• To change settings on a per-package basis, add them under ClangFormat key, example project.sublime-settings:

If You Liked This

. And want to contribute, PR’s gladly accepted!

Maybe you’ll like my other plugin, iOpener. It lets you open files by path, with completion, history, and other goodies.

Otherwise, why not pop on over and star this repo on GitHub?

Thanks to the LLVM project for doing the hard work, including writing clang format, and also the original Sublime Text plugin on which this package is based.

Also thanks to y0ssar1an, Bendtherules and other contributors for their improvements!

Why not go and watch the video that got me interested in clang-format in the first place?

About

A C++ code formatter based on Clang Format, for beautiful code with minimal effort in Sublime Text 3

Clang format windows download

LLVM is distributed under an open source License.

See the releases page for stable releases, and the apt page for nightly packages for Debian and Ubuntu.

We provide a periodically updated installer for Windows:

If there is a previous version installed, the installer provides an option to uninstall it.

Currently, the package includes clang, clang-format, lld, and the AddressSanitizer runtime from compiler-rt. Eventually it should grow to encompass other Clang tools, and possibly other LLVM projects such as libc++.

To use the LLVM toolchain from Visual Studio after running the installer above, install the LLVM Compiler Toolchain Visual Studio extension (supports Visual Studio 2017 and later), select a project in Solution Explorer, open its Property Page (Alt+F7 by default), and in the «General» section of «Configuration Properties» change «Platform Toolset» to «llvm». Alternatively, invoke MSBuild with /p:PlatformToolset=llvm to try out the toolchain without modifying the project files.

A 32-bit version (.sig) of the installer is also available.

The .sig files are PGP signatures using key 345AD05D.

We also provide a standalone Visual Studio plugin for clang-format. It requires Visual Studio 2012 Professional or later. Notably, the Express editions do not support plugins.

Visual Studio plugin installer (.sig), based on based on Git commit 6923b0a7. This is also available at the Visual Studio Marketplace. A separate build of the clang-format binary is available as clang-format-6923b0a7.exe (.sig).

How to Format C/C++ Code in VSCode on Windows and Linux

Since the day that Microsoft released Visual Studio Code, I had installed it on Windows instead of notepad++. Because VS Code does not have a built-in code formatter or beautifier by default, I was eager to see a more powerful VS Code with extensions. Now there it is. We can find many useful extensions on Visual Studio Marketplace. Recently I was writing C/C++ code on Ubuntu and found the extension Clang-Format for beautifying C/C++ code. Let’s take a glimpse of how to make clang-format works with Visual Studio Code on Windows and Linux.

Getting Started with Clang-Format

To install an extension, we can press Ctrl+Shift+P and type in “install extension”. When all extensions listed, search for “format”, and you will see the Clang-Format: After installing the extension, you need to restart VSCode.

To format code, you can call Command Palette again with Ctrl+Shift+P, and then input “format”: The shortcut Ctrl+Shift+I is for Linux. If you want to use it on Windows, you need to use Alter+Shift+F.

If you do not have Clang-Format installed on your system, you will see the prompt:

How to Install Clang-Format on Windows

Install the package and add the path of %LLVM% \bin to your system environment.

The shortcut Alter+Shift+F now works in Visual Studio Code for Windows.

How to Install Clang-Format on Ubuntu 14.04

There are two ways to install clang-format on Ubuntu 14.04: the stand-alone clang-format-3.4 or Clang for x86 _64 Ubuntu 14.04. The package size of stand-alone is much smaller than the full LLVM.

If you choose to install clang-format-3.4, the VS Code extension can’t work instantly. It will still prompt you that no clang-format found. Why? The installed clang-format tool is named clang-format-3.4:

To make it work, you just need to create a symlink:

Alternatively, if you download and extract the LLVM package, you will find clang-format under clang+llvm/bin:

Similarly, create a symbolic link for clang-format:

Now, you can format code with Ctrl+Shift+I in Visual Studio Code for Linux.

Интеграция ClangFormat и Notepad++

Исходные требования

Установка и настройка

1. Если Notepad++ еще не установлен, скачиваем и устанавливаем его

2. В Notepad++ устанавливаем плагин NppExec

NppExec позволяет вызывать сторонние приложения из Notepad++ и взаимодействовать с компонентами библиотеки Scintilla, на основе которой написан Notepad++.

Plugins –> Plugin Admin. –> NppExec –> Install
Notepad++ перезапустится, после чего появится каталог /plugins/NppExec/ и пункт меню Plugins –> NppExec

3. Скачиваем исполняемый файл ClangFormat

Для этого на странице https://llvm.org/builds/ находим и скачиваем установочный файл для Windows, например LLVM-X.X.X-rYYYYYY-win64.exe . Весь пакет можно не устанавливать, достаточно архиватором извлечь файл clang-format.exe . Можно использовать 7-zip: удаляем у файла расширение .exe , открываем файл при помощи 7-zip и извлекаем из подкаталога bin/ файл clang-format.exe . Помещаем файл clang-format.exe в каталог /plugins/NppExec/clang-format/ .

4. Добавляем конфигурационные файлы для ClangFormat

Конфигурационные файлы должны иметь название .clang-format или _clang-format . В них содержится набор правил (стилей) форматирования, формат которых описан в руководстве ClangFormat Style Options.

Для примера используем файлы из проектов Linux Kernel и Qt.

Скачанные с GitHub файлы .clang-format помещаем в соответствующие каталоги:
/plugins/NppExec/clang-format/LINUX_KERNEL/
/plugins/NppExec/clang-format/QT/

5. Создаем скрипт для NppExec

Открываем окно редактирования и запуска скриптов NppExec Plugins –> NppExec –> Execute. или нажимаем F6 . Копируем и вставляем в окно приведенный ниже текст скрипта и сохраняем скрипт под названием clang-format кнопкой Save. .

После запуска скрипт на основе выбранного стиля форматирования, заданного в переменной style , выбирает нужный файл .clang-format , проверяет дату его изменения и при необходимости копирует его во временный каталог. Туда же во временный файл копируется выделенный фрагмент исходного кода, после чего запускается clang-format.exe . Отформатированный фрагмент копируется обратно в окно Notepad++. Затем временный файл удаляется.

В ClangFormat нет возможности указать путь к конфигурационному файлу .clang-format . ClangFormat будет искать его в каталоге форматируемого файла и, если не найдет, перейдет к поиску в родительских каталогах. После окончания работы скрипта файл .clang-format останется во временном каталоге для того, чтобы не выполнять его копирование при каждом запуске форматирования.

На всех этапах работы скрипта выполняется проверка на ошибки, и при их возникновении открывается консольное окно NppExec, в которое выводится сообщение.

6. В Notepad++ добавляем новый пункт меню для запуска скрипта

Открываем Plugins –> NppExec –> Advanced Options. , в выпадающем списке Associated script выбираем название скрипта clang-format и нажимаем на кнопку Add/Modify .

Перезапускаем Notepad++, после чего появится пункт меню Plugins –> NppExec –> clang-format .

7. В Notepad++ настраиваем клавиатурную комбинацию для запуска скрипта

Будем использовать комбинацию Ctrl + I по аналогии с QtCreator. Открываем Settings –> Shortcut Mapper .

По умолчанию комбинация Ctrl + I занята, поэтому нужно ее освободить кнопкой Clear во вкладке Main Menu (строка 38 Split Lines в текущей версии Notepad++). После этого во вкладке Plugin commands присваиваем комбинацию Ctrl + I скрипту clang-format .

Готово, можем пользоваться!

Инструкция по использованию

Открываем файл с исходным кодом в Notepad++, выделяем нужный фрагмент или весь текст и нажимаем Ctrl + I . Если ничего не выделять, то будет отформатирована текущая строка.

Getting Started: Building and Running Clang

This page gives you the shortest path to checking out Clang and demos a few options. This should get you up and running with the minimum of muss and fuss. If you like what you see, please consider getting involved with the Clang community. If you run into problems, please file bugs in LLVM Bugzilla.

Release Clang Versions

Clang is released as part of regular LLVM releases. You can download the release versions from https://llvm.org/releases/.

Clang is also provided in all major BSD or GNU/Linux distributions as part of their respective packaging systems. From Xcode 4.2, Clang is the default compiler for Mac OS X.

Building Clang and Working with the Code

On Unix-like Systems

If you would like to check out and build Clang, the current procedure is as follows:

1. Get the required tools.
   • See Getting Started with the LLVM System — Requirements.
   • Note also that Python is needed for running the test suite. Get it at: https://www.python.org/downloads/
   • Standard build process uses CMake. Get it at: https://cmake.org/download/
2. Check out the LLVM project:
   • Change directory to where you want the llvm directory placed.
   • git clone https://github.com/llvm/llvm-project.git
3. Build LLVM and Clang:
   • cd llvm-project
   • mkdir build (in-tree build is not supported)
   • cd build
   • cmake -DLLVM_ENABLE_PROJECTS=clang -G "Unix Makefiles" ../llvm
   • make
   • This builds both LLVM and Clang for debug mode.
   • Note: For subsequent Clang development, you can just run make clang.
   • CMake allows you to generate project files for several IDEs: Xcode, Eclipse CDT4, CodeBlocks, Qt-Creator (use the CodeBlocks generator), KDevelop3. For more details see Building LLVM with CMake page.
4. If you intend to use Clang’s C++ support, you may need to tell it how to find your C++ standard library headers. In general, Clang will detect the best version of libstdc++ headers available and use them — it will look both for system installations of libstdc++ as well as installations adjacent to Clang itself. If your configuration fits neither of these scenarios, you can use the -DGCC_INSTALL_PREFIX cmake option to tell Clang where the gcc containing the desired libstdc++ is installed.
5. Try it out (assuming you add llvm/build/bin to your path):
   • clang --help
   • clang file.c -fsyntax-only (check for correctness)
   • clang file.c -S -emit-llvm -o - (print out unoptimized llvm code)
   • clang file.c -S -emit-llvm -o - -O3
   • clang file.c -S -O3 -o - (output native machine code)
6. Run the testsuite:
   • make check-clang

Using Visual Studio

The following details setting up for and building Clang on Windows using Visual Studio:

1. Get the required tools:
   • Git. Source code control program. Get it from: https://git-scm.com/download
   • CMake. This is used for generating Visual Studio solution and project files. Get it from: https://cmake.org/download/
   • Visual Studio 2017 or later
   • Python. It is used to run the clang test suite. Get it from: https://www.python.org/download/
   • GnuWin32 tools The Clang and LLVM test suite use various GNU core utilities, such as grep, sed, and find. The gnuwin32 packages are the oldest and most well-tested way to get these tools. However, the MSys utilities provided by git for Windows have been known to work. Cygwin has worked in the past, but is not well tested. If you don’t already have the core utilies from some other source, get gnuwin32 from http://getgnuwin32.sourceforge.net/.
2. Check out LLVM and Clang:
   • git clone https://github.com/llvm/llvm-project.git

Note: Some Clang tests are sensitive to the line endings. Ensure that checking out the files does not convert LF line endings to CR+LF. If you’re using git on Windows, make sure your core.autocrlf setting is false.

Run CMake to generate the Visual Studio solution and project files:

• cd ..\.. (back to where you started)
• mkdir build (for building without polluting the source dir)
• cd build
• If you are using Visual Studio 2017: cmake -DLLVM_ENABLE_PROJECTS=clang -G "Visual Studio 15 2017" -A x64 -Thost=x64 ..\llvm
  -Thost=x64 is required, since the 32-bit linker will run out of memory.
• To generate x86 binaries instead of x64, pass -A Win32.
• See the LLVM CMake guide for more information on other configuration options for CMake.
• The above, if successful, will have created an LLVM.sln file in the build directory.

Build Clang:

• Open LLVM.sln in Visual Studio.
• Build the «clang» project for just the compiler driver and front end, or the «ALL_BUILD» project to build everything, including tools.

Try it out (assuming you added llvm/debug/bin to your path). (See the running examples from above.)

See Hacking on clang — Testing using Visual Studio on Windows for information on running regression tests on Windows.

Using Ninja alongside Visual Studio

We recommend that developers who want the fastest incremental builds use the Ninja build system. You can use the generated Visual Studio project files to edit Clang source code and generate a second build directory next to it for running the tests with these steps:

1. Check out clang and LLVM as described above
2. Open a developer command prompt with the appropriate environment.
   • If you open the start menu and search for «Command Prompt», you should see shortcuts created by Visual Studio to do this. To use native x64 tools, choose the one titled «x64 Native Tools Command Prompt for VS 2017».
   • Alternatively, launch a regular cmd prompt and run the appropriate vcvarsall.bat incantation. To get the 2017 x64 tools, this would be:
     "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat" x64
3. mkdir build_ninja (or build, or use your own organization)
4. cd build_ninja
5. set CC=cl (necessary to force CMake to choose MSVC over mingw GCC if you have it installed)
6. set CXX=cl
7. cmake -GNinja ..\llvm
8. ninja clang This will build just clang.
9. ninja check-clang This will run the clang tests.

Clang Compiler Driver (Drop-in Substitute for GCC)

The clang tool is the compiler driver and front-end, which is designed to be a drop-in replacement for the gcc command. Here are some examples of how to use the high-level driver:

The ‘clang’ driver is designed to work as closely to GCC as possible to maximize portability. The only major difference between the two is that Clang defaults to gnu99 mode while GCC defaults to gnu89 mode. If you see weird link-time errors relating to inline functions, try passing -std=gnu89 to clang.

Examples of using Clang

Preprocessing:

Type checking:

GCC options:

Pretty printing from the AST:

Note, the -cc1 argument indicates the compiler front-end, and not the driver, should be run. The compiler front-end has several additional Clang specific features which are not exposed through the GCC compatible driver interface.