.ycm_extra_conf.py File Reference

Configuration for vim's YouCompleteMe plugin. More...

Go to the source code of this file.

Functions
OlderGroup
Functions that seem necessary for older YCM.
def	MakeRelativePathsInFlagsAbsolute (flags, working_directory)
def	FlagsForFile (filename, kwargs)
	This seems to be the entry point for older YCM; this function is called by ycmd to produce flags for a file. More...
NewerGroup
Functions that seem necessary for newer YCM.
def	IsHeaderFile (filename)
def	FindCorrespondingSourceFile (filename)
def	Settings (kwargs)
	This seems to be the entry point for newer YCM. More...

Variables
	DIR_OF_THIS_SCRIPT = os.path.abspath( os.path.dirname( __file__ ) )
list	flags
	Compilation flags that will be used in case there's no compilation database set (by default, one is not set). More...
list	SOURCE_EXTENSIONS = [ '.cpp', '.cxx', '.cc', '.c', '.m', '.mm' ]
	Variable that seems necessary for new YCM. More...

Detailed Description

Configuration for vim's YouCompleteMe plugin.

Copyright

2019 Thomas E. Vaughan; all rights reserved.

License: BSD three-clause; see LICENSE.

Definition in file .ycm_extra_conf.py.

Function Documentation

def FindCorrespondingSourceFile

(

filename

)

Definition at line 73 of file .ycm_extra_conf.py.

def FindCorrespondingSourceFile( filename ):
  if IsHeaderFile( filename ):
    basename = os.path.splitext( filename )[ 0 ]
    for extension in SOURCE_EXTENSIONS:
      replacement_file = basename + extension
      if os.path.exists( replacement_file ):
        return replacement_file
  return filename

Here is the call graph for this function:

Here is the caller graph for this function:

def FlagsForFile	(		filename,
			kwargs
	)

This seems to be the entry point for older YCM; this function is called by ycmd to produce flags for a file.

Definition at line 58 of file .ycm_extra_conf.py.

def FlagsForFile( filename, **kwargs ):
  final_flags = MakeRelativePathsInFlagsAbsolute(flags, DIR_OF_THIS_SCRIPT)
  return {
    'flags': final_flags,
  }

Here is the call graph for this function:

def IsHeaderFile

(

filename

)

Definition at line 69 of file .ycm_extra_conf.py.

def IsHeaderFile( filename ):
  extension = os.path.splitext( filename )[ 1 ]
  return extension in [ '.h', '.hxx', '.hpp', '.hh' ]

Here is the caller graph for this function:

def MakeRelativePathsInFlagsAbsolute	(		flags,
			working_directory
	)

Definition at line 32 of file .ycm_extra_conf.py.

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

Here is the caller graph for this function:

def Settings

(

kwargs

)

This seems to be the entry point for newer YCM.

Definition at line 83 of file .ycm_extra_conf.py.

def Settings( **kwargs ):
  if kwargs[ 'language' ] == 'cfamily':
    filename = FindCorrespondingSourceFile( kwargs[ 'filename' ] )
    return {
      'flags': flags,
      'include_paths_relative_to_dir': DIR_OF_THIS_SCRIPT,
      'override_filename': filename
    }
  return {}

Here is the call graph for this function:

Variable Documentation

DIR_OF_THIS_SCRIPT = os.path.abspath( os.path.dirname( __file__ ) )

Definition at line 8 of file .ycm_extra_conf.py.

list flags

Initial value:

= [
'-Wall',
'-Wextra',
'-Werror',
'-std=c++14',
'-x', 'c++',
'-isystem', '/usr/include/clang/7/include',
'-I', '.',
]

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.

Definition at line 14 of file .ycm_extra_conf.py.

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

Variable that seems necessary for new YCM.

SOURCE_EXTENSIONS is used by FindCorrespondingSourceFile.

Definition at line 26 of file .ycm_extra_conf.py.