ycm_extra_conf.py 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. # This file is NOT licensed under the GPLv3, which is the license for the rest
  2. # of YouCompleteMe.
  3. #
  4. # Here's the license text for this file:
  5. #
  6. # This is free and unencumbered software released into the public domain.
  7. #
  8. # Anyone is free to copy, modify, publish, use, compile, sell, or
  9. # distribute this software, either in source code form or as a compiled
  10. # binary, for any purpose, commercial or non-commercial, and by any
  11. # means.
  12. #
  13. # In jurisdictions that recognize copyright laws, the author or authors
  14. # of this software dedicate any and all copyright interest in the
  15. # software to the public domain. We make this dedication for the benefit
  16. # of the public at large and to the detriment of our heirs and
  17. # successors. We intend this dedication to be an overt act of
  18. # relinquishment in perpetuity of all present and future rights to this
  19. # software under copyright law.
  20. #
  21. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22. # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23. # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  24. # IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  25. # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  26. # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  27. # OTHER DEALINGS IN THE SOFTWARE.
  28. #
  29. # For more information, please refer to <http://unlicense.org/>
  30. import os
  31. import ycm_core
  32. # These are the compilation flags that will be used in case there's no
  33. # compilation database set (by default, one is not set).
  34. # CHANGE THIS LIST OF FLAGS. YES, THIS IS THE DROID YOU HAVE BEEN LOOKING FOR.
  35. flags = [
  36. '-Wall',
  37. '-Wextra',
  38. 'ggdb',
  39. '-std=c99',
  40. '-pedantic'
  41. ]
  42. # Set this to the absolute path to the folder (NOT the file!) containing the
  43. # compile_commands.json file to use that instead of 'flags'. See here for
  44. # more details: http://clang.llvm.org/docs/JSONCompilationDatabase.html
  45. #
  46. # You can get CMake to generate this file for you by adding:
  47. # set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )
  48. # to your CMakeLists.txt file.
  49. #
  50. # Most projects will NOT need to set this to anything; you can just change the
  51. # 'flags' list of compilation flags. Notice that YCM itself uses that approach.
  52. compilation_database_folder = ''
  53. if os.path.exists( compilation_database_folder ):
  54. database = ycm_core.CompilationDatabase( compilation_database_folder )
  55. else:
  56. database = None
  57. SOURCE_EXTENSIONS = [ '.cpp', '.cxx', '.cc', '.c', '.m', '.mm' ]
  58. def DirectoryOfThisScript():
  59. return os.path.dirname( os.path.abspath( __file__ ) )
  60. def MakeRelativePathsInFlagsAbsolute( flags, working_directory ):
  61. if not working_directory:
  62. return list( flags )
  63. new_flags = []
  64. make_next_absolute = False
  65. path_flags = [ '-isystem', '-I', '-iquote', '--sysroot=' ]
  66. for flag in flags:
  67. new_flag = flag
  68. if make_next_absolute:
  69. make_next_absolute = False
  70. if not flag.startswith( '/' ):
  71. new_flag = os.path.join( working_directory, flag )
  72. for path_flag in path_flags:
  73. if flag == path_flag:
  74. make_next_absolute = True
  75. break
  76. if flag.startswith( path_flag ):
  77. path = flag[ len( path_flag ): ]
  78. new_flag = path_flag + os.path.join( working_directory, path )
  79. break
  80. if new_flag:
  81. new_flags.append( new_flag )
  82. return new_flags
  83. def IsHeaderFile( filename ):
  84. extension = os.path.splitext( filename )[ 1 ]
  85. return extension in [ '.h', '.hxx', '.hpp', '.hh' ]
  86. def GetCompilationInfoForFile( filename ):
  87. # The compilation_commands.json file generated by CMake does not have entries
  88. # for header files. So we do our best by asking the db for flags for a
  89. # corresponding source file, if any. If one exists, the flags for that file
  90. # should be good enough.
  91. if IsHeaderFile( filename ):
  92. basename = os.path.splitext( filename )[ 0 ]
  93. for extension in SOURCE_EXTENSIONS:
  94. replacement_file = basename + extension
  95. if os.path.exists( replacement_file ):
  96. compilation_info = database.GetCompilationInfoForFile(
  97. replacement_file )
  98. if compilation_info.compiler_flags_:
  99. return compilation_info
  100. return None
  101. return database.GetCompilationInfoForFile( filename )
  102. def FlagsForFile( filename, **kwargs ):
  103. if database:
  104. # Bear in mind that compilation_info.compiler_flags_ does NOT return a
  105. # python list, but a "list-like" StringVec object
  106. compilation_info = GetCompilationInfoForFile( filename )
  107. if not compilation_info:
  108. return None
  109. final_flags = MakeRelativePathsInFlagsAbsolute(
  110. compilation_info.compiler_flags_,
  111. compilation_info.compiler_working_dir_ )
  112. # NOTE: This is just for YouCompleteMe; it's highly likely that your project
  113. # does NOT need to remove the stdlib flag. DO NOT USE THIS IN YOUR
  114. # ycm_extra_conf IF YOU'RE NOT 100% SURE YOU NEED IT.
  115. try:
  116. final_flags.remove( '-stdlib=libc++' )
  117. except ValueError:
  118. pass
  119. else:
  120. relative_to = DirectoryOfThisScript()
  121. final_flags = MakeRelativePathsInFlagsAbsolute( flags, relative_to )
  122. return {
  123. 'flags': final_flags,
  124. 'do_cache': True
  125. }