Skip to content

Instantly share code, notes, and snippets.

@galou

galou/.ycm_extra_conf.py

Last active April 4, 2022 10:18
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save galou/92a2d05dd772778f86f2 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save galou/92a2d05dd772778f86f2 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. galou revised this gist Jul 22, 2015. 1 changed file with 0 additions and 4 deletions.
    4 changes: 0 additions & 4 deletions .ycm_extra_conf.py
    View file
    Original file line number Diff line number Diff line change
    @@ -227,8 +227,6 @@ def GetCompilationInfoForFile(filename, database):


    def FlagsForFile(filename):
    import tempfile # debug
    f = tempfile.NamedTemporaryFile(prefix=filename, delete=False) #debug
    database = GetDatabase(GetCompilationDatabaseFolder(filename))
    if database:
    # Bear in mind that compilation_info.compiler_flags_ does NOT return a
    @@ -249,8 +247,6 @@ def FlagsForFile(filename):
    relative_to = DirectoryOfThisScript()
    final_flags = MakeRelativePathsInFlagsAbsolute(flags, relative_to)

    f.write('flags: {}\n'.format(final_flags)) #debug
    f.close() #debug
    return {
    'flags': final_flags,
    'do_cache': True
  2. galou revised this gist Jul 22, 2015. 1 changed file with 9 additions and 5 deletions.
    14 changes: 9 additions & 5 deletions .ycm_extra_conf.py
    View file
    Original file line number Diff line number Diff line change
    @@ -56,7 +56,7 @@ def GetRosIncludeFlags():
    # catkin config --cmake-args '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON'
    # in your shell.

    flags = [
    default_flags = [
    '-Wall',
    '-Wextra',
    '-Werror',
    @@ -65,9 +65,6 @@ def GetRosIncludeFlags():
    '-Wno-variadic-macros',
    '-fexceptions',
    '-DNDEBUG',
    # You 100% do NOT need -DUSE_CLANG_COMPLETER in your flags; only the YCM
    # source code needs it.
    '-DUSE_CLANG_COMPLETER',
    # 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
    @@ -87,7 +84,9 @@ def GetRosIncludeFlags():
    # include third party libraries
    # '-isystem',
    # '/some/path/include',
    ] + GetRosIncludeFlags()
    ]

    flags = default_flags + GetRosIncludeFlags()


    def GetCompilationDatabaseFolder(filename):
    @@ -228,6 +227,8 @@ def GetCompilationInfoForFile(filename, database):


    def FlagsForFile(filename):
    import tempfile # debug
    f = tempfile.NamedTemporaryFile(prefix=filename, delete=False) #debug
    database = GetDatabase(GetCompilationDatabaseFolder(filename))
    if database:
    # Bear in mind that compilation_info.compiler_flags_ does NOT return a
    @@ -243,10 +244,13 @@ def FlagsForFile(filename):
    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)

    f.write('flags: {}\n'.format(final_flags)) #debug
    f.close() #debug
    return {
    'flags': final_flags,
    'do_cache': True
  3. galou revised this gist Jul 21, 2015. 1 changed file with 210 additions and 26 deletions.
    236 changes: 210 additions & 26 deletions .ycm_extra_conf.py
    View file
    Original file line number Diff line number Diff line change
    @@ -1,17 +1,28 @@
    # -*- coding: utf-8 -*-

    ##########################################################################
    # ycm_extra_conf.py for ROS #
    # Author: Gaël Ecorchard (2014) #
    # YouCompleteMe configuration for ROS #
    # Author: Gaël Ecorchard (2015) #
    # #
    # Place this file in your ROS catkin workspace to use it. #
    # 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
    def getRosIncludePaths():
    import os
    The directories are looked for in $ROS_WORKSPACE.
    """
    try:
    from rospkg import RosPack
    except ImportError:
    @@ -22,48 +33,221 @@ def getRosIncludePaths():
    for p in rospack.list():
    if os.path.exists(rospack.get_path(p) + '/include'):
    includes.append(rospack.get_path(p) + '/include')
    if os.path.exists('/opt/ros/indigo/include'):
    includes.append('/opt/ros/indigo/include')
    if os.path.exists('/opt/ros/hydro/include'):
    includes.append('/opt/ros/hydro/include')
    for distribution in os.listdir('/opt/ros'):
    includes.append('/opt/ros/' + distribution + '/include')
    return includes


    def getRosIncludeFlags():
    includes = getRosIncludePaths()
    def GetRosIncludeFlags():
    includes = GetRosIncludePaths()
    flags = []
    for include in includes:
    flags.append('-isystem')
    flags.append(include)
    return flags

    # some default flags
    # for more information install clang-3.2-doc package and
    # check UsersManual.html
    # 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.

    flags = [
    '-Wall',
    '-Wextra',
    '-Werror',

    # std is required
    # clang won't know which language to use compiling headers
    '-std=c++98',

    # '-x' and 'c++' also required
    # use 'c' for C projects
    '-Wc++98-compat',
    '-Wno-long-long',
    '-Wno-variadic-macros',
    '-fexceptions',
    '-DNDEBUG',
    # You 100% do NOT need -DUSE_CLANG_COMPLETER in your flags; only the YCM
    # source code needs it.
    '-DUSE_CLANG_COMPLETER',
    # 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',
    ] + getRosIncludeFlags()
    ] + 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)


    # youcompleteme is calling this function to get flags
    # You can also set database for flags. Check: JSONCompilationDatabase.html in
    # clang-3.2-doc package
    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_)
    else:
    relative_to = DirectoryOfThisScript()
    final_flags = MakeRelativePathsInFlagsAbsolute(flags, relative_to)

    return {
    'flags': flags,
    'flags': final_flags,
    'do_cache': True
    }
  4. galou revised this gist Oct 3, 2014. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions .ycm_extra_conf.py
    View file
    Original file line number Diff line number Diff line change
    @@ -1,3 +1,5 @@
    # -*- coding: utf-8 -*-

    ##########################################################################
    # ycm_extra_conf.py for ROS #
    # Author: Gaël Ecorchard (2014) #
  5. galou revised this gist Oct 3, 2014. 1 changed file with 9 additions and 18 deletions.
    27 changes: 9 additions & 18 deletions .ycm_extra_conf.py
    View file
    Original file line number Diff line number Diff line change
    @@ -1,22 +1,10 @@
    ##########################################################################
    # Simple ycm_extra_conf.py example #
    # Copyright (C) <2013> Onur Aslan <onur@onur.im> #
    # ycm_extra_conf.py for ROS #
    # Author: Gaël Ecorchard (2014) #
    # #
    # This file is loaded by default. Place your own .ycm_extra_conf.py to #
    # project root to override this. #
    # Place this file in your ROS catkin workspace to use it. #
    # #
    # This program is free software: you can redistribute it and/or modify #
    # it under the terms of the GNU General Public License as published by #
    # the Free Software Foundation, either version 3 of the License, or #
    # (at your option) any later version. #
    # #
    # This program is distributed in the hope that it will be useful, #
    # but WITHOUT ANY WARRANTY; without even the implied warranty of #
    # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
    # GNU General Public License for more details. #
    # #
    # You should have received a copy of the GNU General Public License #
    # along with this program. If not, see <http://www.gnu.org/licenses/>. #
    # License: CC0 #
    ##########################################################################


    @@ -28,11 +16,14 @@ def getRosIncludePaths():
    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')
    includes.append(os.path.expandvars('$ROS_WORKSPACE') + '/devel/include')
    includes.append('/opt/ros/indigo/include')
    if os.path.exists('/opt/ros/indigo/include'):
    includes.append('/opt/ros/indigo/include')
    if os.path.exists('/opt/ros/hydro/include'):
    includes.append('/opt/ros/hydro/include')
    return includes


  6. galou created this gist Oct 3, 2014.
    76 changes: 76 additions & 0 deletions .ycm_extra_conf.py
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,76 @@
    ##########################################################################
    # Simple ycm_extra_conf.py example #
    # Copyright (C) <2013> Onur Aslan <onur@onur.im> #
    # #
    # This file is loaded by default. Place your own .ycm_extra_conf.py to #
    # project root to override this. #
    # #
    # This program is free software: you can redistribute it and/or modify #
    # it under the terms of the GNU General Public License as published by #
    # the Free Software Foundation, either version 3 of the License, or #
    # (at your option) any later version. #
    # #
    # This program is distributed in the hope that it will be useful, #
    # but WITHOUT ANY WARRANTY; without even the implied warranty of #
    # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
    # GNU General Public License for more details. #
    # #
    # You should have received a copy of the GNU General Public License #
    # along with this program. If not, see <http://www.gnu.org/licenses/>. #
    ##########################################################################


    def getRosIncludePaths():
    import os
    try:
    from rospkg import RosPack
    except ImportError:
    return []
    rospack = RosPack()
    includes = []
    for p in rospack.list():
    if os.path.exists(rospack.get_path(p) + '/include'):
    includes.append(rospack.get_path(p) + '/include')
    includes.append(os.path.expandvars('$ROS_WORKSPACE') + '/devel/include')
    includes.append('/opt/ros/indigo/include')
    return includes


    def getRosIncludeFlags():
    includes = getRosIncludePaths()
    flags = []
    for include in includes:
    flags.append('-isystem')
    flags.append(include)
    return flags

    # some default flags
    # for more information install clang-3.2-doc package and
    # check UsersManual.html
    flags = [
    '-Wall',
    '-Werror',

    # std is required
    # clang won't know which language to use compiling headers
    '-std=c++98',

    # '-x' and 'c++' also required
    # use 'c' for C projects
    '-x',
    'c++',

    # include third party libraries
    # '-isystem',
    # '/some/path/include',
    ] + getRosIncludeFlags()


    # youcompleteme is calling this function to get flags
    # You can also set database for flags. Check: JSONCompilationDatabase.html in
    # clang-3.2-doc package
    def FlagsForFile(filename):
    return {
    'flags': flags,
    'do_cache': True
    }