Class Invocation

utils/iwyu_tool.py:274–312

Holds arguments of an IWYU invocation.

class Invocation(object):
    """ Holds arguments of an IWYU invocation. """
    def __init__(self, command, cwd, source_file):
        self.command = command
        self.cwd = cwd
        self.source_file = source_file

    def __str__(self):
        return ' '.join(self.command)

    @classmethod
    def from_compile_command(cls, entry, extra_args):
        """ Parse a JSON compilation database entry into new Invocation. """
        if 'arguments' in entry:
            # arguments is a command-line in list form.
            command = entry['arguments']
            source_file = entry['file']
        elif 'command' in entry:
            # command is a command-line in string form, split to list.
            command = split_command(entry['command'])
            source_file = entry['file']
        else:
            raise ValueError('Invalid compilation database entry: %s' % entry)

        # Rewrite the compile command for IWYU
        compile_command, compile_args = command[0], command[1:]
        if is_msvc_driver(compile_command):
            # If the compiler is cl-compatible, let IWYU be cl-compatible.
            extra_args = ['--driver-mode=cl'] + extra_args

        command = [IWYU_EXECUTABLE] + extra_args + compile_args
        return cls(command, entry['directory'], source_file)

    def start(self, verbose):
        """ Run invocation and collect output. """
        if verbose:
            print('# %s' % self, file=sys.stderr)

        return Process.start(self)


def fixup_compilation_db(compilation_db):