C++ C D Objective-C Python C# Other
Pull request Compare This branch is 26 commits behind uncrustify:master.
Failed to load latest commit information.
autotools autotools: moving required files to auxiliary directory and removing … Jul 22, 2016
cmake Add toolchain files for MinGW cross-compilers Aug 10, 2016
documentation Run scripts/update-defaults.sh Aug 1, 2016
etc Run scripts/update-defaults.sh Aug 1, 2016
man Don't use backslash in Unix file path in the man page May 19, 2016
osx Add missing osx directory. Oct 25, 2009
scripts Refactored make_token_names.py to generate just like make_token_enum.… Jul 21, 2016
src Merge branch 'master' into Bug_222 Aug 30, 2016
tests Merge branch 'master' into Bug_222 Aug 30, 2016
uncrustify.xcodeproj add cmt_insert_before_inlines to annotate functions declared inline i… Jun 29, 2016
win32 add missing files to Visual Studio project files May 18, 2016
.editorconfig Added .editorconfig files that matches current Uncrustify style Jul 22, 2016
.gitattributes Add gitattributes file May 25, 2016
.gitignore Refactored .gitignore to be more organized Jul 22, 2016
.travis.yml invoke ctest to run the tests Aug 11, 2016
AUTHORS Import r1644 from subversion Oct 17, 2009
BUGS Change to GitHub Jul 29, 2016
CMakeLists.txt Merge pull request #625 from jibsen/mingw-cross-compile Aug 23, 2016
COPYING Import r1644 from subversion Oct 17, 2009
ChangeLog Test for issue #596 Aug 6, 2016
Comments.txt prepare the configuration file for the sources Apr 25, 2016
HELP Change to GitHub Jul 29, 2016
INSTALL Simplify expressions such as: May 2, 2016
Makefile.am Adding README.md to the distribution Mar 27, 2016
NEWS Import r1644 from subversion Oct 17, 2009
README.md use badges from shield for a custom label Aug 12, 2016
TESTING Tweaks to the TESTING how-to Aug 26, 2011
appveyor.yml invoke ctest to run the tests Aug 11, 2016
autogen.sh Import r1644 from subversion Oct 17, 2009
commit.log Update ChangeLog and commit.log Feb 3, 2016
configure.ac Change to GitHub Jul 29, 2016
extras.vpj Add a few files to the workspace Jan 1, 2013
forUncrustifySources.cfg uncrustify all the sources with forUncrustifySources.cfg Apr 27, 2016
forUncrustifySources.txt uncrustify all the sources with forUncrustifySources.cfg Apr 27, 2016
make_token_names.bat Added Windows helper root script to run make_token_names.py Jul 4, 2016
make_token_names.sh Remove the date from token_names.h/make_token_names.sh Dec 28, 2012
make_version.py Support for hg if the github repository is pulled using hg git extension Jul 21, 2016
make_win32.sh Rework make_win32.sh to build outside of the source tree. Feb 3, 2016
package.json Added package.json for npm Feb 18, 2015
release-steps.txt The issue #411 is partialy fixed. May 12, 2016
run_tests.bat ./run_tests.sh and .bat root scripts were unable to locate a relative… Aug 11, 2016
run_tests.sh ./run_tests.sh and .bat root scripts were unable to locate a relative… Aug 11, 2016
uncrustify.vpj Add ability to get config from UNCRUSTIFY_CONFIG env var to win32 Dec 29, 2011
uncrustify.vpw Update SlickEdit project files Oct 9, 2011
working.txt save off work in the freebsd branch Dec 5, 2009


README for Uncrustify

Travis CI AppVeyor

Post any bugs to the issue tracker found on the project's GitHub page: https://github.com/uncrustify/uncrustify/issues

Please include the following with your issue:

  • a description of what is not working right
  • input code sufficient to demonstrate the issue
  • expected output code
  • configuration options used to generate the output

If the issue cannot be easily reproduced, then it isn't likely to be fixed.

Building using CMake

CMake is a tool that generates build systems (Makefiles, Visual Studio project files, and others).

To generate a build system for Uncrustify using CMake, create a build folder and run CMake from it:

$ mkdir build
$ cd build
$ cmake ..

Then use the build tools of your build system (in many cases this will simply be make, but on Windows it could be MSBuild or Visual Studio). Or use CMake to invoke it:

$ cmake --build .

If testing is enabled, CMake generates a test target, which you can build using your build system tools (usually make test). This can also be invoked using CTest:

$ ctest -V -C Debug

There is also an install target, which can be used to install the Uncrustify executable (typically make install).

A note on CMake configurations

Some build systems are single-configuration, which means you specify the build type when running CMake (by setting the CMAKE_BUILD_TYPE variable), and the generated files then build that configuration.

An example of a single-configuration build system is Makefiles. You can build the Release configuration of Uncrustify (from the build folder) with:

$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make

Other build systems are multi-configuration, which means you specify the build type when building.

An example of a multi-configuration build system is Visual Studio project files. When you open the project in Visual Studio, you can select which configuration to build. You can also do this while building from the command line with cmake --build . --config Release.

Building using Autotools

Quick start:

$ ./autogen.sh
$ ./configure
$ make

The executable is src/uncrustify. Copy that to your ~/bin/ folder or wherever you want.

Building the program using Xcode on Mac OS X

You can of course just open the Xcode project and build uncrustify using the default 'Debug' configuration but if you want to install it the 'Install' configuration will not work from within Xcode.

For that you will have to use the Xcode command line tool 'xcodebuild'.

To do that, cd into the uncrustify project folder where uncrustify.xcodeproj resides and enter the following command:

$ sudo xcodebuild -configuration 'Install'

You will be prompted for the root level password. By doing this you will install uncrustify into /usr/local/bin. The install location can be changed by editing the Build Settings for the uncrustify target. The setting you need to change is called, surprisingly enough, 'Installation Directory'.

Configuring the program

Examine the example config files in etc (such as ben.cfg) and/or read configuration.txt. Copy the existing config file that closely matches your style and put in ~/.uncrustify/. Find complete configuration file options in this file. Modify to your liking.

Running the program (and refining your style)

As of the current release, I don't particularly trust this program to not make mistakes and screw up my whitespace formatting.

Here's how to run it:

$ uncrustify -c ~/.uncrustify/mystyle.cfg -f somefile.c > somefile.c.unc

The -c option selects the configuration file. The -f option specifies the input file. The output is sent to stdout. Error messages are sent to stderr.

Use a quality side-by-side diff tool to determine if the program did what you wanted. Repeat until your style is refined.

Running the program (once you've found your style)

Write a script to automate the above. Check out etc/dofiles.sh for an example. That script is used as follows:

  1. navigate one level above your project
  2. make a list of file to process $ find myproj -name "*.[ch]" > files.txt
  3. $ sh etc/dofiles.sh files.txt
  4. Use your favorite diff/merge program to merge in the changes $ xxdiff out/myproj myproj