AMiRo-OS

#!/usr/bin/env python

#

# Copyright (c) 2009 Google Inc. All rights reserved.

#

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions are

# met:

#

#    * Redistributions of source code must retain the above copyright

# notice, this list of conditions and the following disclaimer.

#    * Redistributions in binary form must reproduce the above

# copyright notice, this list of conditions and the following disclaimer

# in the documentation and/or other materials provided with the

# distribution.

#    * Neither the name of Google Inc. nor the names of its

# contributors may be used to endorse or promote products derived from

# this software without specific prior written permission.

#

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""Does google-lint on c++ files.

The goal of this script is to identify places in the code that *may*

be in non-compliance with google style.  It does not attempt to fix

up these problems -- the point is to educate.  It does also not

attempt to find all problems, or to ensure that everything it does

find is legitimately a problem.

In particular, we can get very confused by /* and // inside strings!

We do a small hack, which is to ignore //'s with "'s after them on the

same line, but it is far from perfect (in either direction).

"""

import codecs

import copy

import getopt

import math  # for log

import os

import re

import sre_compile

import string

import sys

import unicodedata

_USAGE = """

Syntax: cpplint.py [--verbose=#] [--output=vs7] [--filter=-x,+y,...]

                   [--counting=total|toplevel|detailed] [--root=subdir]

                   [--linelength=digits]

        <file> [file] ...

  The style guidelines this tries to follow are those in

    http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml

  Every problem is given a confidence score from 1-5, with 5 meaning we are

  certain of the problem, and 1 meaning it could be a legitimate construct.

  This will miss some errors, and is not a substitute for a code review.

  To suppress false-positive errors of a certain category, add a

  'NOLINT(category)' comment to the line.  NOLINT or NOLINT(*)

  suppresses errors of all categories on that line.

  The files passed in will be linted; at least one file must be provided.

  Default linted extensions are .cc, .cpp, .cu, .cuh and .h.  Change the

  extensions with the --extensions flag.

  Flags:

    output=vs7

      By default, the output is formatted to ease emacs parsing.  Visual Studio

      compatible output (vs7) may also be used.  Other formats are unsupported.

    verbose=#

      Specify a number 0-5 to restrict errors to certain verbosity levels.

    filter=-x,+y,...

      Specify a comma-separated list of category-filters to apply: only

      error messages whose category names pass the filters will be printed.

      (Category names are printed with the message and look like

      "[whitespace/indent]".)  Filters are evaluated left to right.

      "-FOO" and "FOO" means "do not print categories that start with FOO".

      "+FOO" means "do print categories that start with FOO".

      Examples: --filter=-whitespace,+whitespace/braces

                --filter=whitespace,runtime/printf,+runtime/printf_format

                --filter=-,+build/include_what_you_use

      To see a list of all the categories used in cpplint, pass no arg:

         --filter=

    counting=total|toplevel|detailed

      The total number of errors found is always printed. If

      'toplevel' is provided, then the count of errors in each of

      the top-level categories like 'build' and 'whitespace' will

      also be printed. If 'detailed' is provided, then a count

      is provided for each category like 'build/class'.

    root=subdir

      The root directory used for deriving header guard CPP variable.

      By default, the header guard CPP variable is calculated as the relative

      path to the directory that contains .git, .hg, or .svn.  When this flag

      is specified, the relative path is calculated from the specified

      directory. If the specified directory does not exist, this flag is

      ignored.

      Examples:

        Assuming that src/.git exists, the header guard CPP variables for

        src/chrome/browser/ui/browser.h are:

        No flag => CHROME_BROWSER_UI_BROWSER_H_

        --root=chrome => BROWSER_UI_BROWSER_H_

        --root=chrome/browser => UI_BROWSER_H_

    linelength=digits

      This is the allowed line length for the project. The default value is

      80 characters.

      Examples:

        --linelength=120

    extensions=extension,extension,...

      The allowed file extensions that cpplint will check

      Examples:

        --extensions=hpp,cpp

    cpplint.py supports per-directory configurations specified in CPPLINT.cfg

    files. CPPLINT.cfg file can contain a number of key=value pairs.

    Currently the following options are supported:

      set noparent

      filter=+filter1,-filter2,...

      exclude_files=regex

      linelength=80

    "set noparent" option prevents cpplint from traversing directory tree

    upwards looking for more .cfg files in parent directories. This option

    is usually placed in the top-level project directory.

    The "filter" option is similar in function to --filter flag. It specifies

    message filters in addition to the |_DEFAULT_FILTERS| and those specified

    through --filter command-line flag.

    "exclude_files" allows to specify a regular expression to be matched against

    a file name. If the expression matches, the file is skipped and not run

    through liner.

    "linelength" allows to specify the allowed line length for the project.

    CPPLINT.cfg has an effect on files in the same directory and all

    sub-directories, unless overridden by a nested configuration file.

      Example file:

        filter=-build/include_order,+build/include_alpha

        exclude_files=.*\.cc

    The above example disables build/include_order warning and enables

    build/include_alpha as well as excludes all .cc from being

    processed by linter, in the current directory (where the .cfg

    file is located) and all sub-directories.

"""

# We categorize each error message we print.  Here are the categories.

# We want an explicit list so we can list them all in cpplint --filter=.

# If you add a new error message with a new category, add it to the list

# here!  cpplint_unittest.py should tell you if you forget to do this.

_ERROR_CATEGORIES = [

    'build/class',

    'build/c++11',

    'build/deprecated',

    'build/endif_comment',

    'build/explicit_make_pair',

    'build/forward_decl',

    'build/header_guard',

    'build/include',

    'build/include_alpha',

    'build/include_order',

    'build/include_what_you_use',

    'build/namespaces',

    'build/printf_format',

    'build/storage_class',

    'legal/copyright',

    'readability/alt_tokens',

    'readability/braces',

    'readability/casting',

    'readability/check',

    'readability/constructors',

    'readability/fn_size',

    'readability/function',

    'readability/inheritance',

    'readability/multiline_comment',

    'readability/multiline_string',

    'readability/namespace',

    'readability/nolint',

    'readability/nul',

    'readability/strings',

    'readability/todo',

    'readability/utf8',

    'runtime/arrays',

    'runtime/casting',

    'runtime/explicit',

    'runtime/int',

    'runtime/init',

    'runtime/invalid_increment',

    'runtime/member_string_references',

    'runtime/memset',

    'runtime/indentation_namespace',

    'runtime/operator',

    'runtime/printf',

    'runtime/printf_format',

    'runtime/references',

    'runtime/string',

    'runtime/threadsafe_fn',

    'runtime/vlog',

    'whitespace/blank_line',

    'whitespace/braces',

    'whitespace/comma',

    'whitespace/comments',

    'whitespace/empty_conditional_body',

    'whitespace/empty_loop_body',

    'whitespace/end_of_line',

    'whitespace/ending_newline',

    'whitespace/forcolon',

    'whitespace/indent',

    'whitespace/line_length',

    'whitespace/newline',

    'whitespace/operators',

    'whitespace/parens',

    'whitespace/semicolon',

    'whitespace/tab',

    'whitespace/todo',

    ]

# These error categories are no longer enforced by cpplint, but for backwards-

# compatibility they may still appear in NOLINT comments.

_LEGACY_ERROR_CATEGORIES = [

    'readability/streams',

    ]

# The default state of the category filter. This is overridden by the --filter=

# flag. By default all errors are on, so only add here categories that should be

# off by default (i.e., categories that must be enabled by the --filter= flags).

# All entries here should start with a '-' or '+', as in the --filter= flag.

_DEFAULT_FILTERS = ['-build/include_alpha']

# We used to check for high-bit characters, but after much discussion we

# decided those were OK, as long as they were in UTF-8 and didn't represent

# hard-coded international strings, which belong in a separate i18n file.

# C++ headers

_CPP_HEADERS = frozenset([

    # Legacy

    'algobase.h',

    'algo.h',

    'alloc.h',

    'builtinbuf.h',

    'bvector.h',

    'complex.h',

    'defalloc.h',

    'deque.h',

    'editbuf.h',

    'fstream.h',

    'function.h',

    'hash_ma