Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
YouCompleteMe configuration file for ROS, copy to $ROS_WORKSPACE
# -*- coding: utf-8 -*-
##########################################################################
# YouCompleteMe configuration for ROS #
# Author: Gaël Ecorchard (2015) #
# #
# The file requires the definition of the $ROS_WORKSPACE variable in #
# your shell. #
# Name this file .ycm_extra_conf.py and place it in $ROS_WORKSPACE to #
# use it. #
# #
# Tested with Ubuntu 14.04 and Indigo. #
# #
# License: CC0 #
##########################################################################
import os
import ycm_core
def GetRosIncludePaths():
"""Return a list of potential include directories
The directories are looked for in $ROS_WORKSPACE.
"""
try:
from rospkg import RosPack
except ImportError:
return []
rospack = RosPack()
includes = []
includes.append(os.path.expandvars('$ROS_WORKSPACE') + '/devel/include')
for p in rospack.list():
if os.path.exists(rospack.get_path(p) + '/include'):
includes.append(rospack.get_path(p) + '/include')
for distribution in os.listdir('/opt/ros'):
includes.append('/opt/ros/' + distribution + '/include')
return includes
def GetRosIncludeFlags():
includes = GetRosIncludePaths()
flags = []
for include in includes:
flags.append('-isystem')
flags.append(include)
return flags
# These are the compilation flags that will be used in case there's no
# compilation database set (by default, one is not set).
# CHANGE THIS LIST OF FLAGS. YES, THIS IS THE DROID YOU HAVE BEEN LOOKING FOR.
# You can get CMake to generate the compilation_commands.json file for you by
# adding:
# set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
# to your CMakeLists.txt file or by once entering
# catkin config --cmake-args '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON'
# in your shell.
default_flags = [
'-Wall',
'-Wextra',
'-Werror',
'-Wc++98-compat',
'-Wno-long-long',
'-Wno-variadic-macros',
'-fexceptions',
'-DNDEBUG',
# THIS IS IMPORTANT! Without a "-std=<something>" flag, clang won't know
# which language to use when compiling headers. So it will guess. Badly. So
# C++ headers will be compiled as C headers. You don't want that so ALWAYS
# specify a "-std=<something>".
# For a C project, you would set this to something like 'c99' instead of
# 'c++11'.
'-std=c++03',
# ...and the same thing goes for the magic -x option which specifies the
# language that the files to be compiled are written in. This is mostly
# relevant for c++ headers.
# For a C project, you would set this to 'c' instead of 'c++'.
'-x',
'c++',
'-I',
'.',
# include third party libraries
# '-isystem',
# '/some/path/include',
]
flags = default_flags + GetRosIncludeFlags()
def GetCompilationDatabaseFolder(filename):
"""Return the directory potentially containing compilation_commands.json
Return the absolute path to the folder (NOT the file!) containing the
compile_commands.json file to use that instead of 'flags'. See here for
more details: http://clang.llvm.org/docs/JSONCompilationDatabase.html.
The compilation_commands.json for the given file is returned by getting
the package the file belongs to.
"""
try:
import rospkg
except ImportError:
return ''
pkg_name = rospkg.get_package_name(filename)
if not pkg_name:
return ''
dir = (os.path.expandvars('$ROS_WORKSPACE') +
os.path.sep +
'build' +
os.path.sep +
pkg_name)
return dir
def GetDatabase(compilation_database_folder):
if os.path.exists(compilation_database_folder):
return ycm_core.CompilationDatabase(compilation_database_folder)
return None
SOURCE_EXTENSIONS = ['.cpp', '.cxx', '.cc', '.c', '.m', '.mm']
def DirectoryOfThisScript():
return os.path.dirname(os.path.abspath(__file__))
def MakeRelativePathsInFlagsAbsolute(flags, working_directory):
if not working_directory:
return list(flags)
new_flags = []
make_next_absolute = False
path_flags = ['-isystem', '-I', '-iquote', '--sysroot=']
for flag in flags:
new_flag = flag
if make_next_absolute:
make_next_absolute = False
if not flag.startswith('/'):
new_flag = os.path.join(working_directory, flag)
for path_flag in path_flags:
if flag == path_flag:
make_next_absolute = True
break
if flag.startswith(path_flag):
path = flag[len(path_flag):]
new_flag = path_flag + os.path.join(working_directory, path)
break
if new_flag:
new_flags.append(new_flag)
return new_flags
def IsHeaderFile(filename):
extension = os.path.splitext(filename)[1]
return extension in ['.h', '.hxx', '.hpp', '.hh']
def GetCompilationInfoForHeaderSameDir(headerfile, database):
"""Return compile flags for src file with same base in the same directory
"""
filename_no_ext = os.path.splitext(headerfile)[0]
for extension in SOURCE_EXTENSIONS:
replacement_file = filename_no_ext + extension
if os.path.exists(replacement_file):
compilation_info = database.GetCompilationInfoForFile(
replacement_file)
if compilation_info.compiler_flags_:
return compilation_info
return None
def GetCompilationInfoForHeaderRos(headerfile, database):
"""Return the compile flags for the corresponding src file in ROS
Return the compile flags for the source file corresponding to the header
file in the ROS where the header file is.
"""
try:
import rospkg
except ImportError:
return None
pkg_name = rospkg.get_package_name(headerfile)
if not pkg_name:
return None
try:
pkg_path = rospkg.RosPack().get_path(pkg_name)
except rospkg.ResourceNotFound:
return None
filename_no_ext = os.path.splitext(headerfile)[0]
hdr_basename_no_ext = os.path.basename(filename_no_ext)
for path, dirs, files in os.walk(pkg_path):
for src_filename in files:
src_basename_no_ext = os.path.splitext(src_filename)[0]
if hdr_basename_no_ext != src_basename_no_ext:
continue
for extension in SOURCE_EXTENSIONS:
if src_filename.endswith(extension):
compilation_info = database.GetCompilationInfoForFile(
path + os.path.sep + src_filename)
if compilation_info.compiler_flags_:
return compilation_info
return None
def GetCompilationInfoForFile(filename, database):
# The compilation_commands.json file generated by CMake does not have
# entries for header files. So we do our best by asking the db for flags
# for a corresponding source file, if any. If one exists, the flags for
# that file should be good enough.
# Corresponding source file are looked for in the same package.
if IsHeaderFile(filename):
# Look in the same directory.
compilation_info = GetCompilationInfoForHeaderSameDir(
filename, database)
if compilation_info:
return compilation_info
# Look in the package.
compilation_info = GetCompilationInfoForHeaderRos(filename, database)
if compilation_info:
return compilation_info
return database.GetCompilationInfoForFile(filename)
def FlagsForFile(filename):
database = GetDatabase(GetCompilationDatabaseFolder(filename))
if database:
# Bear in mind that compilation_info.compiler_flags_ does NOT return a
# python list, but a "list-like" StringVec object
compilation_info = GetCompilationInfoForFile(filename, database)
if not compilation_info:
# Return the default flags defined above.
return {
'flags': flags,
'do_cache': True,
}
final_flags = MakeRelativePathsInFlagsAbsolute(
compilation_info.compiler_flags_,
compilation_info.compiler_working_dir_)
final_flags += default_flags
else:
relative_to = DirectoryOfThisScript()
final_flags = MakeRelativePathsInFlagsAbsolute(flags, relative_to)
return {
'flags': final_flags,
'do_cache': True
}
@airballking
Copy link

airballking commented Jan 7, 2016

Thanks a lot for sharing this! I find it very useful. :)

@zephirefaith
Copy link

zephirefaith commented Mar 13, 2017

Thanks for sharing this! Saved my life with c++ codes...however I was wondering how can I get similar autocompletions for Rospy files. I still do not completely understand how to configure YCM for python files. Any pointers would be great.

Copy link

ghost commented Aug 27, 2017

After I copy it to my .ycm _extra_conf.py,i find that when i write my code,the vim can't recognize the header file ,generate by catkin_make, in the catkin_ws/devel/include,but i see you have add the path.so i really don't know how to deal with it

Copy link

ghost commented Aug 27, 2017

sorry,It's my problem.I have deal with it.thanks

@schoelst
Copy link

schoelst commented Oct 12, 2017

@ghost: any luck? - I have a similar problem:
I tried the config on the ROS tutorials, by copying it to ~/catkin_ws/.ycm_extra_conf.py, I also made sure it is executed when I open a file in vim.
When I use export ROS_WORKSPACE=~/catkin_ws/src #import ros/ros.h seems to be found (it is not highlighted), however #include "beginner_tutorials/AddTwoInts.h" is not (this is stored in ~/catkin_ws/devel/include/beginner_tutorials/).
But if I use export ROS_WORKSPACE=~/catkin_ws both #imports are highlighted, so are all uses of the ros namespace.

@JachinShen
Copy link

JachinShen commented May 28, 2018

@schoelst: I find this problem, too! There are two functions containing $ROS_WORKSPACE, GetRosIncludePaths and GetCompilationDatabaseFolder. The first one works properly with export ROS_WORKSPACE=~/catkin_ws, but the second one doesn't.
You can check the description of GetCompilationDatabaseFolder,

Return the absolute path to the folder (NOT the file!) containing the
compile_commands.json file to use that instead of 'flags'.

So this function find the folder containing compile_commands.json and use the json file to check instead of the flags.
Thus, if we set ROS_WORKSPACE to the right path, export ROS_WORKSPACE=~/catkin_ws, it will find the build folder ~/catkin_ws/build/your_pkg but there is no compile_commands.json. So the setting of 'nothing' cover the flags and ycm have no idea how to compile it.
If we set it to the wrong path, export ROS_WORKSPACE=~/catkin_ws/src, there is no folder '~/catkin_ws/src/build/your_pkg`, so ycm just ignore it and use the flags, which contains the headers of ros.
Therefore, there are two ways to solve it.

  • Just return ' ' in GetCompilationDatabaseFolder. It works but ycm only know the header of ros, so some mistakes may happen.
  • Recommended Add set( CMAKE_EXPORT_COMPILE_COMMANDS ON ) in your CMakeLists.txt to generate the compile_commands.json. Then ycm will know exactly how to compile your project.

@egoist-sx
Copy link

egoist-sx commented Oct 21, 2018

If set(CMAKE_EXPORT_COMPILE_COMMANDS ON) is added to package's CMakeLists.txt, compile_commands.json is still generated at ~/catkin_ws/build/ not at ~/catkin_ws/build/package/.

Do I miss anything?

@woidpointer
Copy link

woidpointer commented Oct 21, 2018

@egoist-sx: I think this is the default behaviour of cmake at least the newer versions. This is my version which works for me: https://gist.github.com/woidpointer/d596b293b050b12bb1e68eaf00428fd6
Additionally, to get it completely running I have to install rospkg via pip3 (sudo pip3 install -U rospkg)
to import the referenced libs in python3.

@galou
Copy link
Author

galou commented Oct 23, 2018

I use catkin-tools and run catkin config -DCMAKE_EXPORT_COMPILE_COMMANDS=ON on the command line. You need to run this command just once. There is no need to add this to the CMakeLists.txt files.

@vpeopleonatank
Copy link

vpeopleonatank commented Nov 12, 2018

@egoist-sx: I think this is the default behaviour of cmake at least the newer versions. This is my version which works for me: https://gist.github.com/woidpointer/d596b293b050b12bb1e68eaf00428fd6
Additionally, to get it completely running I have to install rospkg via pip3 (sudo pip3 install -U rospkg)
to import the referenced libs in python3.

Your .ycm_extra_conf.py worked for me. Thank you so much 👍

@hare0319
Copy link

hare0319 commented Apr 25, 2019

Hi All,
I copied the conf file to my ~/catkin_ws/ and added extra line, set( CMAKE_EXPORT_COMPILE_COMMANDS ON ), to my CMakeLists.txt. When I load vim under ~/catkin_ws/src, it works perfectly. YCM can locate both ros packages and my personal packages correctly. However, if I use vim under ~/catkin_ws/src/beginner_tutorials/src, YCM can find neither ros packages nor my personal packages. It will report file not found error for lines #include "ros/ros.h" and #include "beginner_tutorials/AddTwoInts.h".
May I ask how can I solve this?
Thanks a lot in advance

@hare0319
Copy link

hare0319 commented Apr 27, 2019

Well, it seems my issue is the same as the one discussed above. Updating .ycm_extra_conf.py solves the problem.

@kgreenek
Copy link

kgreenek commented Dec 15, 2019

This was super helpful, thank you so much!

I spent a some time tweaking this today, and was able to make a few improvements. Most notably, with this version, you don't need to specify the ROS_WORKSPACE environment variable; it figures that out automatically based on your current directory. I also made it available as a vim plugin, so you can install it using Plug (or whichever plugin manager you prefer).

Code and instructions are here: https://github.com/kgreenek/vim-ros-ycm

@jrjfonseca
Copy link

jrjfonseca commented Apr 29, 2020

i put .ycm_extra_conf.py under catkin_ws, i defined in my bashrc export ROS_WORKSPACE= ~/catkin_ws I have to nodes inside a package my_first_node.py and my_first_node.cpp, so in the node.py all the functions import etc is recognized without .ycm_extra_conf.py however the cpp does not even recognize the #include <ros/ros.h> can somebody help me.

@XiaoshanLin9701
Copy link

XiaoshanLin9701 commented Feb 15, 2021

@egoist-sx: I think this is the default behaviour of cmake at least the newer versions. This is my version which works for me: https://gist.github.com/woidpointer/d596b293b050b12bb1e68eaf00428fd6
Additionally, to get it completely running I have to install rospkg via pip3 (sudo pip3 install -U rospkg)
to import the referenced libs in python3.

This solution works for me. Thank you!

@galou
Copy link
Author

galou commented Feb 15, 2021

I realized not so long time ago that YCM supports using compile_commands.json directly. So you can try to configure with catkin config -DCMAKE_EXPORT_COMPILE_COMMANDS=ON and then symlink the compile_commands.json into the source directory of your package.

@Briancbn
Copy link

Briancbn commented Feb 19, 2022

I have added a tutorial for the whole setup for YCM and updated this file to work with ROS2 too using the compile_commands.json https://github.com/Briancbn/ros_vim_autocomplete

I can include the symlink method too if needed. The extra config still has the advantage of working with .cpp and .hpp files before the first compilation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment