.ycm_extra_conf.py
Go to the documentation of this file.
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 
31 import os
32 import ycm_core
33 
34 # These are the compilation flags that will be used in case there's no
35 # compilation database set (by default, one is not set).
36 # CHANGE THIS LIST OF FLAGS. YES, THIS IS THE DROID YOU HAVE BEEN LOOKING FOR.
37 flags = [
38 '-Wall',
39 '-Wextra',
40 '-Werror',
41 '-fexceptions',
42 # THIS IS IMPORTANT! Without a "-std=<something>" flag, clang won't know which
43 # language to use when compiling headers. So it will guess. Badly. So C++
44 # headers will be compiled as C headers. You don't want that so ALWAYS specify
45 # a "-std=<something>".
46 # For a C project, you would set this to something like 'c99' instead of
47 # 'c++11'.
48 '-std=c++03',
49 # ...and the same thing goes for the magic -x option which specifies the
50 # language that the files to be compiled are written in. This is mostly
51 # relevant for c++ headers.
52 # For a C project, you would set this to 'c' instead of 'c++'.
53 '-x',
54 'c++',
55 '-isystem', "/opt/ros/%s/include" % os.environ.get('ROS_DISTRO', 'indigo'),
56 '-isystem', '/usr/include/Poco',
57 '-isystem', '/usr/include',
58 '-I', '.',
59 '-I', './include',
60 '-I', '../devel/include',
61 # ROS flags
62 '-DROSCONSOLE_BACKEND_LOG4CXX',
63 #'-DROS_PACKAGE_NAME="mavros"',
64 ]
65 
66 # Set this to the absolute path to the folder (NOT the file!) containing the
67 # compile_commands.json file to use that instead of 'flags'. See here for
68 # more details: http://clang.llvm.org/docs/JSONCompilationDatabase.html
69 #
70 # You can get CMake to generate this file for you by adding:
71 # set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )
72 # to your CMakeLists.txt file.
73 #
74 # Most projects will NOT need to set this to anything; you can just change the
75 # 'flags' list of compilation flags. Notice that YCM itself uses that approach.
76 compilation_database_folder = ''
77 
78 if os.path.exists( compilation_database_folder ):
79  database = ycm_core.CompilationDatabase( compilation_database_folder )
80 else:
81  database = None
82 
83 SOURCE_EXTENSIONS = [ '.cpp', '.cxx', '.cc', '.c', '.m', '.mm' ]
84 
86  return os.path.dirname( os.path.abspath( __file__ ) )
87 
88 
89 def MakeRelativePathsInFlagsAbsolute( flags, working_directory ):
90  if not working_directory:
91  return list( flags )
92  new_flags = []
93  make_next_absolute = False
94  path_flags = [ '-isystem', '-I', '-iquote', '--sysroot=' ]
95  for flag in flags:
96  new_flag = flag
97 
98  if make_next_absolute:
99  make_next_absolute = False
100  if not flag.startswith( '/' ):
101  new_flag = os.path.join( working_directory, flag )
102 
103  for path_flag in path_flags:
104  if flag == path_flag:
105  make_next_absolute = True
106  break
107 
108  if flag.startswith( path_flag ):
109  path = flag[ len( path_flag ): ]
110  new_flag = path_flag + os.path.join( working_directory, path )
111  break
112 
113  if new_flag:
114  new_flags.append( new_flag )
115  return new_flags
116 
117 
118 def IsHeaderFile( filename ):
119  extension = os.path.splitext( filename )[ 1 ]
120  return extension in [ '.h', '.hxx', '.hpp', '.hh' ]
121 
122 
124  # The compilation_commands.json file generated by CMake does not have entries
125  # for header files. So we do our best by asking the db for flags for a
126  # corresponding source file, if any. If one exists, the flags for that file
127  # should be good enough.
128  if IsHeaderFile( filename ):
129  basename = os.path.splitext( filename )[ 0 ]
130  for extension in SOURCE_EXTENSIONS:
131  replacement_file = basename + extension
132  if os.path.exists( replacement_file ):
133  compilation_info = database.GetCompilationInfoForFile(
134  replacement_file )
135  if compilation_info.compiler_flags_:
136  return compilation_info
137  return None
138  return database.GetCompilationInfoForFile( filename )
139 
140 
141 def FlagsForFile( filename, **kwargs ):
142  if database:
143  # Bear in mind that compilation_info.compiler_flags_ does NOT return a
144  # python list, but a "list-like" StringVec object
145  compilation_info = GetCompilationInfoForFile( filename )
146  if not compilation_info:
147  return None
148 
149  final_flags = MakeRelativePathsInFlagsAbsolute(
150  compilation_info.compiler_flags_,
151  compilation_info.compiler_working_dir_ )
152  else:
153  relative_to = DirectoryOfThisScript()
154  final_flags = MakeRelativePathsInFlagsAbsolute( flags, relative_to )
155 
156  return {
157  'flags': final_flags,
158  'do_cache': True
159  }
def IsHeaderFile(filename)
def DirectoryOfThisScript()
def FlagsForFile(filename, kwargs)
def GetCompilationInfoForFile(filename)
def MakeRelativePathsInFlagsAbsolute(flags, working_directory)


ntpd_driver
Author(s): Vladimir Ermakov
autogenerated on Thu Feb 25 2021 03:06:49