Class _NamespaceInfo

tools/cpplint.py:3168–3242

Stores information about a namespace.

class _NamespaceInfo(_BlockInfo):
    """Stores information about a namespace."""

    def __init__(self, name, linenum):
        _BlockInfo.__init__(self, linenum, False)
        self.name = name or ""
        self.check_namespace_indentation = True

    def CheckEnd(self, filename, clean_lines, linenum, error):
        """Check end of namespace comments."""
        line = clean_lines.raw_lines[linenum]

        # Check how many lines is enclosed in this namespace.  Don't issue
        # warning for missing namespace comments if there aren't enough
        # lines.  However, do apply checks if there is already an end of
        # namespace comment and it's incorrect.
        #
        # TODO(google): We always want to check end of namespace comments
        # if a namespace is large, but sometimes we also want to apply the
        # check if a short namespace contained nontrivial things (something
        # other than forward declarations).  There is currently no logic on
        # deciding what these nontrivial things are, so this check is
        # triggered by namespace size only, which works most of the time.
        if linenum - self.starting_linenum < 10 and not re.match(
            r"^\s*};*\s*(//|/\*).*\bnamespace\b", line
        ):
            return

        # Look for matching comment at end of namespace.
        #
        # Note that we accept C style "/* */" comments for terminating
        # namespaces, so that code that terminate namespaces inside
        # preprocessor macros can be cpplint clean.
        #
        # We also accept stuff like "// end of namespace <name>." with the
        # period at the end.
        #
        # Besides these, we don't accept anything else, otherwise we might
        # get false negatives when existing comment is a substring of the
        # expected namespace.
        if self.name:
            # Named namespace
            if not re.match(
                (r"^\s*};*\s*(//|/\*).*\bnamespace\s+" + re.escape(self.name) + r"[\*/\.\\\s]*$"),
                line,
            ):
                error(
                    filename,
                    linenum,
                    "readability/namespace",
                    5,
                    f'Namespace should be terminated with "// namespace {self.name}"',
                )
        else:
            # Anonymous namespace
            if not re.match(r"^\s*};*\s*(//|/\*).*\bnamespace[\*/\.\\\s]*$", line):
                # If "// namespace anonymous" or "// anonymous namespace (more text)",
                # mention "// anonymous namespace" as an acceptable form