Function GetHeaderGuardCPPVariable

tools/cpplint.py:2539–2617

Returns the CPP variable that should be used as a header guard. Args: filename: The name of a C++ header file. Returns: The CPP variable that should be used as a header guard in the named file.

(filename)

def GetHeaderGuardCPPVariable(filename):
    """Returns the CPP variable that should be used as a header guard.

    Args:
      filename: The name of a C++ header file.

    Returns:
      The CPP variable that should be used as a header guard in the
      named file.

    """

    # Restores original filename in case that cpplint is invoked from Emacs's
    # flymake.
    filename = re.sub(r"_flymake\.h$", ".h", filename)
    filename = re.sub(r"/\.flymake/([^/]*)$", r"/\1", filename)
    # Replace 'c++' with 'cpp'.
    filename = filename.replace("C++", "cpp").replace("c++", "cpp")

    fileinfo = FileInfo(filename)
    file_path_from_root = fileinfo.RepositoryName()

    def FixupPathFromRoot():
        if _root_debug:
            sys.stderr.write(
                f"\n_root fixup, _root = '{_root}',"
                f" repository name = '{fileinfo.RepositoryName()}'\n"
            )

        # Process the file path with the --root flag if it was set.
        if not _root:
            if _root_debug:
                sys.stderr.write("_root unspecified\n")
            return file_path_from_root

        def StripListPrefix(lst, prefix):
            # f(['x', 'y'], ['w, z']) -> None  (not a valid prefix)
            if lst[: len(prefix)] != prefix:
                return None
            # f(['a, 'b', 'c', 'd'], ['a', 'b']) -> ['c', 'd']
            return lst[(len(prefix)) :]

        # root behavior:
        #   --root=subdir , lstrips subdir from the header guard
        maybe_path = StripListPrefix(PathSplitToList(file_path_from_root), PathSplitToList(_root))

        if _root_debug:
            sys.stderr.write(
                ("_root lstrip (maybe_path=%s, file_path_from_root=%s," + " _root=%s)\n")
                % (maybe_path, file_path_from_root, _root)
            )

        if maybe_path:
            return os.path.join(*maybe_path)

        #   --root=.. , will prepend the outer directory to the header guard
        full_path = fileinfo.FullName()
        # adapt slashes for windows