+# https://github.com/Valloric/ycmd/blob/master/cpp/ycm/.ycm_extra_conf.py
+# https://jonasdevlieghere.com/a-better-youcompleteme-config/
+# https://github.com/arximboldi/dotfiles/blob/master/emacs/.ycm_extra_conf.py
+
import os
-import shlex
-import subprocess
+import os.path
+from glob import glob
+import logging
import ycm_core
+import difflib
+
+# flags used when no compilation_db is found
+BASE_FLAGS = [
+ '-std=c++1z',
+ '-x', 'c++',
+]
+
+# flags are always added
+EXTRA_FLAGS = [
+ '-Wall',
+ '-Wextra',
+ '-Weverything',
+ '-Wno-c++98-compat',
+ '-Wno-c++98-compat-pedantic',
+ # '-Wshadow',
+ # '-Werror',
+ # '-Wc++98-compat',
+ # '-Wno-long-long',
+ # '-Wno-variadic-macros',
+ # '-fexceptions',
+ # '-DNDEBUG',
+]
+
+SOURCE_EXTENSIONS = [
+ '.cpp',
+ '.cxx',
+ '.cc',
+ '.c',
+ '.m',
+ '.mm'
+]
-# 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.
-flags = [
-'-Wall',
-# '-Wextra',
-# '-Wshadow',
-# '-Werror',
-# '-Wc++98-compat',
-# '-Wno-long-long',
-# '-Wno-variadic-macros',
-# '-fexceptions',
-# '-DNDEBUG',
-'-std=c++11',
-'-stdlib=libc++',
-'-x', 'c++',
-'-I', '.',
-'-I', './include',
-'-isystem', '/usr/include/c++/4.9.0',
-'-isystem', '/usr/include/c++/4.9.0/x86_64-unknown-linux-gnu',
-'-isystem', '/usr/include/c++/4.9.0/backward',
-'-isystem', '/usr/lib/clang/3.4.1/include'
+HEADER_EXTENSIONS = [
+ '.h',
+ '.hxx',
+ '.hpp',
+ '.hh'
]
-# This function makes it easy to pull in additional flags from rospack
-def rospack():
- cmd = ['rospack', 'cflags-only-I']
- try:
- out = subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE).stdout
- except:
- return []
- line = out.readline()[:-1].split(" ")
- includes = []
- for include in line:
- if include.startswith(os.path.expanduser('~')):
- includes += ['-I', include]
+
+def similarity_ratio(s, t):
+ return difflib.SequenceMatcher(a=s.lower(), b=t.lower()).ratio()
+
+
+def generate_qt_flags():
+ flags = ['-isystem', '/usr/include/qt/']
+ for p in glob('/usr/include/qt/*/'):
+ flags += ['-isystem', p]
+ return flags
+
+
+def find_similar_file_in_database(dbpath, filename):
+ import json
+ logging.info("Trying to find some file close to: " + filename)
+ db = json.load(open(dbpath))
+ best_filename = ''
+ best_ratio = 0
+ for entry in db:
+ entry_filename = os.path.normpath(os.path.join(entry["directory"],
+ entry["file"]))
+ ratio = similarity_ratio(str(filename), str(entry_filename))
+ if ratio > best_ratio:
+ best_filename = entry_filename
+ best_ratio = ratio
+ return best_filename
+
+def ok_compilation_info(info):
+ return bool(info.compiler_flags_)
+
+def get_compilation_info_for_file(dbpath, database, filename):
+ info = database.GetCompilationInfoForFile(filename)
+ if ok_compilation_info(info):
+ logging.info("Flags for file where found in database: " + filename)
+ return info
else:
- includes += ['-isystem', include]
- return filter(lambda a: a != ' ', includes)
-
-flags += rospack()
-
-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 FlagsForFile( filename, **kwargs ):
- relative_to = DirectoryOfThisScript()
- final_flags = MakeRelativePathsInFlagsAbsolute( flags, relative_to )
-
- return {
- 'flags': final_flags,
- 'do_cache': True
- }
+ logging.info("Flags for file not found in database: " + filename)
+ basename = os.path.splitext(filename)[0]
+ for extension in SOURCE_EXTENSIONS:
+ replacement_file = basename + extension
+ logging.info("Trying to replace extension with: " + extension)
+ info = database.GetCompilationInfoForFile(replacement_file)
+ if ok_compilation_info(info):
+ logging.info("Replacing header with: " + replacement_file)
+ return info
+ replacement_file = find_similar_file_in_database(dbpath, filename)
+ logging.info("Replacing header with: " + replacement_file)
+ return database.GetCompilationInfoForFile(replacement_file)
+
+
+def find_nearest_compilation_database(root='.'):
+ dirs = glob(root + '/*/compile_commands.json', recursive=True)
+
+ if len(dirs) == 1:
+ return dirs[0]
+ elif len(dirs) > 1:
+ logging.info("Multiple compilation databases found!")
+ logging.info(dirs)
+ logging.info("Selecting first: %s" % (dir))
+ return dirs[0]
+
+ parent = os.path.dirname(os.path.abspath(root))
+ if parent == root:
+ raise RuntimeError("Could not find compile_commands.json")
+ return find_nearest_compilation_database(parent)
+
+
+def find_nearest(path, target):
+ candidates = [
+ os.path.join(path, target),
+ os.path.join(path, 'build', target),
+ os.path.join(path, 'output', target),
+ ]
+ for candidate in candidates:
+ if os.path.isfile(candidate) or os.path.isdir(candidate):
+ logging.info("Found nearest " + target + " at " + candidate)
+ return candidate
+ parent = os.path.dirname(os.path.abspath(path))
+ if parent == path:
+ raise RuntimeError("Could not find " + target)
+ return find_nearest(parent, target)
+
+
+def make_relative_paths_in_flags_absolute(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 flags_for_include(root):
+ try:
+ include_path = find_nearest(root, 'include')
+ flags = []
+ for dirroot, dirnames, filenames in os.walk(include_path):
+ for dir_path in dirnames:
+ real_path = os.path.join(dirroot, dir_path)
+ flags = flags + ["-I" + real_path]
+ return flags
+ except Exception as err:
+ logging.info("Error while looking flags for includes in root: " + root)
+ logging.error(err)
+ return None
+
+
+def flags_for_compilation_database(root, filename):
+ try:
+ compilation_db_path = find_nearest_compilation_database(root)
+ compilation_db_dir = os.path.dirname(compilation_db_path)
+ logging.info("Set compilation database directory to " + compilation_db_dir)
+ compilation_db = ycm_core.CompilationDatabase(compilation_db_dir)
+ if not compilation_db:
+ logging.info("Compilation database file found but unable to load")
+ return None
+ compilation_info = get_compilation_info_for_file(
+ compilation_db_path, compilation_db, filename)
+ if not compilation_info:
+ logging.info("No compilation info for " + filename + " in compilation database")
+ return None
+ return make_relative_paths_in_flags_absolute(
+ compilation_info.compiler_flags_,
+ compilation_info.compiler_working_dir_)
+ except Exception as err:
+ logging.info("Error while trying to get flags for " + filename + " in compilation database")
+ logging.error(err)
+ return None
+
+
+def FlagsForFile(filename, **kwargs):
+ client_data = kwargs['client_data']
+ root = client_data['getcwd()']
+
+ compilation_db_flags = flags_for_compilation_database(root, filename)
+ if compilation_db_flags:
+ final_flags = compilation_db_flags
+ else:
+ final_flags = BASE_FLAGS
+ include_flags = flags_for_include(root)
+ if include_flags:
+ final_flags = final_flags + include_flags
+
+ final_flags += generate_qt_flags()
+ final_flags += [
+ '-I', root,
+ '-I', root + '/include',
+ ]
+ return {
+ 'flags': final_flags + EXTRA_FLAGS,
+ 'do_cache': True
+ }