cpp_indexer Namespace Reference

Classes
class	_ClassInfo
class	_Indexer
class	Location
class	SymbolsIndex

Functions
	_change_working_directory_to (path)
	_create_compilation_database ()
	_get_current_commit_hash ()
SymbolsIndex	_index_source ()
SymbolsIndex	load_index (str filename)

Variables
	_libclang_path = None
	_clang_include_dir = None
	_path_to_llvm
str	_DART_CONFIGURATION
tuple	_DART_BUILD_DIR
	_SymbolsIndexSchema = class_schema(SymbolsIndex)()

Detailed Description

Clang based C++ code indexer which produces xref.json.

Function Documentation

_change_working_directory_to()

cpp_indexer._change_working_directory_to (   path )

protected

Definition at line 48 of file cpp_indexer.py.

def _change_working_directory_to(path):
    oldpwd = os.getcwd()
    os.chdir(path)
    try:
        yield
    finally:
        os.chdir(oldpwd)
 
 

_create_compilation_database()

cpp_indexer._create_compilation_database ( )

protected

Create compilation database for the default configuration.

Extacts compilation database (compile_commands.json) for the default
build configuration and filters it down to commands taht builds just
the core VM pieces in the host configuration.

Definition at line 57 of file cpp_indexer.py.

def _create_compilation_database():
    """Create compilation database for the default configuration.
 
    Extacts compilation database (compile_commands.json) for the default
    build configuration and filters it down to commands taht builds just
    the core VM pieces in the host configuration.
    """
    logging.info('Extracting compilation commands from build files for %s',
                 _DART_CONFIGURATION)
    with _change_working_directory_to(_DART_BUILD_DIR):
        commands = json.loads(
            subprocess.check_output(['ninja', '-C', '.', '-t', 'compdb',
                                     'cxx']))
    pattern = re.compile(
        r'libdart(_vm|_compiler)?_precompiler_host_targeting_host\.')
    with open('compile_commands.json', 'w', encoding='utf-8') as outfile:
        json.dump([
            cmd for cmd in commands
            if pattern.search(cmd['command']) is not None
        ], outfile)
 
 

_get_current_commit_hash()

cpp_indexer._get_current_commit_hash ( )

protected

Definition at line 79 of file cpp_indexer.py.

def _get_current_commit_hash():
    return subprocess.check_output(['git', 'merge-base', 'main', 'HEAD'],
                                   text=True).strip()
 
 
@dataclass

_index_source()

SymbolsIndex cpp_indexer._index_source ( )

protected

Definition at line 233 of file cpp_indexer.py.

def _index_source() -> SymbolsIndex:
    indexer = _Indexer()
 
    _create_compilation_database()
    with _change_working_directory_to(_DART_BUILD_DIR):
        index = Index.create()
        compdb = CompilationDatabase.fromDirectory('.')
 
        commands = list(compdb.getAllCompileCommands())
        with ShadyBar('Indexing',
                      max=len(commands),
                      suffix='%(percent)d%% eta %(eta_td)s') as progress_bar:
            for command in commands:
                args = [
                    arg for arg in command.arguments
                    if arg.startswith('-I') or arg.startswith('-W') or
                    arg.startswith('-D') or arg.startswith('-i') or
                    arg.startswith('sdk/') or arg.startswith('-std')
                ] + [
                    '-Wno-macro-redefined', '-Wno-unused-const-variable',
                    '-Wno-unused-function', '-Wno-unused-variable'
                ]
 
                if _clang_include_dir is not None:
                    args.append(f'-I{_clang_include_dir}')
 
                unit = index.parse(command.filename, args=args)
                for diag in unit.diagnostics:
                    print(diag.format())
 
                indexer.index(unit)
                progress_bar.next()
 
    return indexer.symbols_index
 
 

load_index()

SymbolsIndex cpp_indexer.load_index

(

str

filename

)

Load symbols index from the given file.

If index is out of date or missing it will be generated.

Definition at line 272 of file cpp_indexer.py.

def load_index(filename: str) -> SymbolsIndex:
    """Load symbols index from the given file.
 
    If index is out of date or missing it will be generated.
    """
    index: SymbolsIndex
 
    if os.path.exists(filename):
        with open(filename, 'r', encoding='utf-8') as json_file:
            index = _SymbolsIndexSchema.loads(json_file.read())
        if _get_current_commit_hash() == index.commit:
            logging.info('Loaded symbols index from %s', filename)
            return index
        logging.warning(
            '%s is generated for commit %s while current commit is %s',
            filename, index.commit, _get_current_commit_hash())
 
    index = _index_source()
    with open(filename, 'w', encoding='utf-8') as json_file:
        json_file.write(_SymbolsIndexSchema.dumps(index))
    logging.info(
        'Successfully indexed C++ source and written symbols index into %s',
        filename)
    return index

Variable Documentation

_clang_include_dir

cpp_indexer._clang_include_dir = None

protected

Definition at line 25 of file cpp_indexer.py.

_DART_BUILD_DIR

tuple cpp_indexer._DART_BUILD_DIR

protected

Initial value:

=  ('xcodebuild' if platform.system() == 'Darwin' else
                   'out') + '/' + _DART_CONFIGURATION

Definition at line 43 of file cpp_indexer.py.

_DART_CONFIGURATION

str cpp_indexer._DART_CONFIGURATION

protected

Initial value:

=  'Release' + (
    'ARM64' if platform.uname().machine == 'arm64' else 'X64')

Definition at line 41 of file cpp_indexer.py.

_libclang_path

str cpp_indexer._libclang_path = None

protected

Definition at line 24 of file cpp_indexer.py.

_path_to_llvm

cpp_indexer._path_to_llvm

protected

Initial value:

=  subprocess.check_output(['brew', '--prefix', 'llvm'],
                                            encoding='utf-8').strip()

Definition at line 27 of file cpp_indexer.py.

_SymbolsIndexSchema

cpp_indexer._SymbolsIndexSchema = class_schema(SymbolsIndex)()

protected

Definition at line 269 of file cpp_indexer.py.