Why waste your valuable development time formatting code manually when we are trying to build amazing robots?
The repo contains an auto formatting script for the ROS C++ Style Guidelines.
Note: this style is in beta format as its only been tested by Dave Coleman
-
Install clang_format:
sudo apt-get install -y clang-format-3.6
-
Then put in the root of your catkin workspace the file
.clang_format
, located in this repo. You can save this file from this link. For example, place it on your computer here:~/catkin_ws/.clang_format
-
Now any file inside your catkin workspace will be formatted with the ROS style guidelines described in this config file
You can run clang_format in several ways:
Format single file:
clang-format-3.6 --i -style=file MY_ROS_NODE.cpp
Format entire directory recursively including subfolders:
find . -name '*.h' -or -name '*.hpp' -or -name '*.cpp' | xargs clang-format-3.6 --i -style=file $1
In your ~/.emacs
config file, add the following:
Format your source code if its in some directory such as the catkin_ws
(feel free to change keywords catkin_ws):
(defun run-ros-clang-format ()
"Runs clang-format on cpp,hpp files in catkin_ws/ and reverts buffer."
(interactive)
(and
(string-match "/catkin_ws/.*\\.\\(h\\|cpp\\)$" buffer-file-name)
(shell-command (concat "clang-format-3.6 -style=file -i " buffer-file-name))
(message (concat "Saved and ran clang-format on " buffer-file-name))
(revert-buffer t t t)
))
Set a keyboard shortcut to run, such as F12
(global-set-key [f12] 'maybe-run-ros-clang-format)
Install the clang-format package via package manager or apm install clang-format
.
In the package settings set clang-format-3.6
as your executable and point 'Style' to your .clang_format
file.