Header files flags

.ycm_extra_conf.py

import json
import os
import ycm_core

# 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 = [
]


# Set this to 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
#
# You can get CMake to generate this file for you by adding:
#   set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )
# to your CMakeLists.txt file.
#
# Most projects will NOT need to set this to anything; you can just change the
# 'flags' list of compilation flags. Notice that YCM itself uses that approach.
compilation_database_folder = 'C:\\Users\\micbou\\tests\\ycm-issue-2094'
compilation_database = None
compilation_database_paths = None

SOURCE_EXTENSIONS = [ '.cpp', '.cxx', '.cc', '.c', '.m', '.mm' ]


def GetCompilationDatabase():
  global compilation_database

  if compilation_database:
    return compilation_database

  if os.path.exists( compilation_database_folder ):
    compilation_database = ycm_core.CompilationDatabase( compilation_database_folder )
    return compilation_database
  return None


def GetCompilationDatabasePaths():
  global compilation_database_paths

  if compilation_database_paths:
    return compilation_database_paths

  compile_commands = os.path.join( compilation_database_folder,
                                   'compile_commands.json' )
  with open( compile_commands, encoding = 'utf8' ) as cc:
    compile_objects = json.loads( cc.read() )

  paths = []
  for command_object in compile_objects:
    command_file = command_object[ 'file' ]
    if not os.path.isabs( command_file ):
      command_file = os.path.join( command_object[ 'directory' ],
                                   command_file )
    paths.append( command_file )

  compilation_database_paths = paths
  return paths


def GetPathWithLongestPrefix( filename, paths ):
  longest_path = None
  longest_prefix_number = 0
  for path in paths:
    prefix_number = len( os.path.commonprefix( [ filename, path ] ) )
    if prefix_number > longest_prefix_number:
      longest_path = path
      longest_prefix_number = prefix_number
  return longest_path


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 GetCompilationInfoForFile( filename ):
  # 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.
  database = GetCompilationDatabase()

  if IsHeaderFile( filename ):
    basename = os.path.splitext( filename )[ 0 ]
    for extension in SOURCE_EXTENSIONS:
      replacement_file = basename + extension
      if os.path.exists( replacement_file ):
        compilation_info = database.GetCompilationInfoForFile( replacement_file )
        if compilation_info.compiler_flags_:
          return compilation_info

    replacement_file = GetPathWithLongestPrefix(
      filename, GetCompilationDatabasePaths() )
    if replacement_file:
      compilation_info = database.GetCompilationInfoForFile( replacement_file )
      if compilation_info.compiler_flags_:
        return compilation_info
    return None
  return database.GetCompilationInfoForFile( filename )


def RemoveFlagsPrecedingClang( flags ):
  for index, flag in enumerate( flags ):
    if flag.startswith( 'clang' ):
      return ( flags[ index - 1: ] if index > 1 else
               flags )
  return flags[ :-1 ]


def FlagsForFile( filename, **kwargs ):
  if GetCompilationDatabase():
    # Bear in mind that compilation_info.compiler_flags_ does NOT return a
    # python list, but a "list-like" StringVec object
    compilation_info = GetCompilationInfoForFile( filename )
    if not compilation_info:
      return None

    flags = MakeRelativePathsInFlagsAbsolute(
      compilation_info.compiler_flags_,
      compilation_info.compiler_working_dir_ )

    final_flags = RemoveFlagsPrecedingClang( flags )
  else:
    relative_to = DirectoryOfThisScript()
    final_flags = MakeRelativePathsInFlagsAbsolute( flags, relative_to )

  return {
    'flags': final_flags,
    'do_cache': True
  }