diff --git a/.flake8 b/.flake8 deleted file mode 100644 index 2b20931..0000000 --- a/.flake8 +++ /dev/null @@ -1,37 +0,0 @@ -[flake8] -ignore = - # indentation is not a multiple of four, - E111,E114, - # visually indented line with same indent as next logical line, - E129, - # expected 2 blank lines, found 1 - E302,E305, - # closing bracket does not match indentation of opening bracket's line - E123, - # multiple spaces before operator - E221, - # line break before binary operator - W503, - # line break after binary operator - W504, - # multiple statements on one line - E701, - # continuation line under-indented for hanging indent - E121, - # closing bracket does not match visual indentation - E124, - # continuation line with same indent as next logical line - E125, - # continuation line over-indented for visual indent - E127, - # continuation line under-indented for visual indent - E128, - # unexpected indentation - E116, - # too many blank lines - E303, - # missing whitespace around arithmetic operator - E226, - # test for membership should be 'not in' - E713, -max-line-length=120 diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000..9a63ffd --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,3 @@ +# .git-blame-ignore-revs +# Reformatted repo with ruff +94f5e443bfa80e576ded32585f0058d09a6a7fbc diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..be006de --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +# Keep GitHub Actions up to date with GitHub's Dependabot... +# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + groups: + github-actions: + patterns: + - "*" # Group all Actions updates into a single larger pull request + schedule: + interval: weekly diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b93ce3c..adca99d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,21 +3,27 @@ on: pull_request: paths-ignore: "*.rst" push: - paths-ignore: "*.rst" + # paths-ignore: "*.rst" branches: [master, develop] concurrency: group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} cancel-in-progress: true jobs: + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - run: pipx run pre-commit run --all-files + build-test: runs-on: ${{ matrix.os }} strategy: - matrix: - # Python 3.8 is the last non-EOL version. Also adapt tox.ini - python-version: ['3.8', 'pypy3.10', '3.12'] - os: [ubuntu-latest, windows-latest] fail-fast: false - + matrix: + # Python 3.8 is EOL. Also adapt tox.ini + python-version: ['3.8', 'pypy3.11', '3.x'] + # macOS on ARM, Ubuntu on x86, Windows on X86 + os: [macos-latest, ubuntu-latest, windows-latest] steps: - name: Checkout uses: actions/checkout@v4 @@ -27,13 +33,11 @@ jobs: uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - architecture: x64 cache: 'pip' - cache-dependency-path: '**/test-requirements' + cache-dependency-path: 'pyproject.toml' - name: Install dependencies run: | python -m pip install --upgrade pip - python -m pip install -e .[dev] - python -m pip install 'tox-gh-actions<4.0.0' + python -m pip install --editable .[dev] - name: Test with tox - run: tox + run: tox -e py diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..edf2366 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,120 @@ +name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI + +on: push + +jobs: + build: + name: Build distribution 📦 + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + - name: Install pypa/build + run: >- + python3 -m + pip install + build + --user + - name: Build a binary wheel and a source tarball + run: python3 -m build + - name: Store the distribution packages + uses: actions/upload-artifact@v4 + with: + name: python-package-distributions + path: dist/ + + publish-to-pypi: + name: >- + Publish Python 🐍 distribution 📦 to PyPI + if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes + needs: + - build + runs-on: ubuntu-latest + environment: + name: pypi + url: https://pypi.org/p/cpplint + permissions: + id-token: write # IMPORTANT: mandatory for trusted publishing + + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Publish distribution 📦 to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + + github-release: + name: >- + Sign the Python 🐍 distribution 📦 with Sigstore + and upload them to GitHub Release + needs: + - publish-to-pypi + runs-on: ubuntu-latest + + permissions: + contents: write # IMPORTANT: mandatory for making GitHub Releases + id-token: write # IMPORTANT: mandatory for sigstore + + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + - name: Sign the dists with Sigstore + uses: sigstore/gh-action-sigstore-python@v3.0.0 + with: + inputs: >- + ./dist/*.tar.gz + ./dist/*.whl + - name: Create GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + run: >- + gh release create + "$GITHUB_REF_NAME" + --repo "$GITHUB_REPOSITORY" + --notes "" + - name: Upload artifact signatures to GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + # Upload to GitHub Release using the `gh` CLI. + # `dist/` contains the built packages, and the + # sigstore-produced signatures and certificates. + run: >- + gh release upload + "$GITHUB_REF_NAME" dist/** + --repo "$GITHUB_REPOSITORY" + + publish-to-testpypi: + name: Publish Python 🐍 distribution 📦 to TestPyPI + needs: + - build + runs-on: ubuntu-latest + + environment: + name: testpypi + url: https://test.pypi.org/p/cpplint + + permissions: + id-token: write # IMPORTANT: mandatory for trusted publishing + + steps: + - name: Download all the dists + uses: actions/download-artifact@v4 + with: + name: python-package-distributions + path: dist/ + # TODO(cclauss): Uncomment this job step when we have admin access to test.pypi.org + # - name: Publish distribution 📦 to TestPyPI + # uses: pypa/gh-action-pypi-publish@release/v1 + # with: + # repository-url: https://test.pypi.org/legacy/ diff --git a/.gitignore b/.gitignore index 712f99b..7098c5b 100644 --- a/.gitignore +++ b/.gitignore @@ -81,6 +81,9 @@ ipython_config.py # VSCode .vscode/ +# JetBrains PyCharm +.idea/ + # pyenv .python-version diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..c5553dc --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,70 @@ +# Learn more about this config here: https://pre-commit.com/ + +# To enable these pre-commit hooks run: +# `pipx install pre-commit` or `brew install pre-commit` +# Then in the project root directory run `pre-commit install` + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: check-added-large-files + - id: check-ast + - id: check-builtin-literals + - id: check-case-conflict + - id: check-docstring-first + - id: check-executables-have-shebangs + - id: check-json + - id: check-merge-conflict + - id: check-shebang-scripts-are-executable + - id: check-symlinks + - id: check-toml + - id: check-vcs-permalinks + - id: check-xml + - id: check-yaml + - id: debug-statements + - id: destroyed-symlinks + - id: detect-private-key + # - id: end-of-file-fixer # TODO(cclauss): Causes some tests to fail. + - id: file-contents-sorter + - id: fix-byte-order-marker + - id: forbid-new-submodules + - id: forbid-submodules + # - id: mixed-line-ending # TODO(cclauss): Causes some tests to fail. + # args: + # - --fix=lf + - id: name-tests-test + - id: pretty-format-json + - id: requirements-txt-fixer + - id: sort-simple-yaml + # - id: trailing-whitespace # TODO(cclauss): Causes some tests to fail. + + - repo: https://github.com/MarcoGorelli/auto-walrus + rev: 0.3.4 + hooks: + - id: auto-walrus + + - repo: https://github.com/codespell-project/codespell + rev: v2.4.1 + hooks: + - id: codespell + args: + - --ignore-words-list=alse,ons + additional_dependencies: + - tomli + + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.11.2 + hooks: + - id: ruff + - id: ruff-format + + - repo: https://github.com/tox-dev/pyproject-fmt + rev: v2.5.1 + hooks: + - id: pyproject-fmt + + - repo: https://github.com/abravalheri/validate-pyproject + rev: v0.24.1 + hooks: + - id: validate-pyproject diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 220215c..0000000 --- a/.pylintrc +++ /dev/null @@ -1,49 +0,0 @@ -[BASIC] -include-naming-hint=yes -method-rgx=[A-Z_][A-Za-z0-9]{2,49}$|__init__|__str__|__contains__ -function-rgx=[A-Z_][A-Za-z0-9]{2,49}$|main -const-rgx=[a-zA-Z_][A-Za-z0-9_]{2,49}$ -variable-rgx=[a-z_][a-z0-9_]{0,49}$ -argument-rgx=[a-z_][a-z0-9_]{0,49}$ -class-rgx=[A-Z_][a-zA-Z0-9]+$|basestring|unicode|long|xrange - -[MESSAGES CONTROL] -disable= - global-statement, - multiple-statements, - missing-docstring, - no-else-return, - no-self-use, - consider-merging-isinstance, - consider-using-min-builtin, - bad-continuation, - fixme, - bad-option-value, - anomalous-unicode-escape-in-string, - unused-argument, - useless-object-inheritance, - consider-using-dict-comprehension, - consider-using-in, - unnecessary-pass, - too-many-positional-arguments - -[REPORTS] -output-format=colorized -reports=no -score=no - -[FORMAT] -indent-string=' ' -indent-after-paren=4 -max-module-lines=10000 - -[DESIGN] -max-locals=25 -max-line-length=100 -max-attributes=10 -max-branches=30 -max-args=20 -max-statements=75 -max-returns=10 -min-public-methods=0 -max-bool-expr=10 diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 4dfac75..571eb2f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,14 +2,33 @@ Changelog ********* -2.0 (2024-10-06) +2.0.1 (2025-04-02) +================== + +Yet another overdue... hotfix. Sorry this took so long. + +* The false positive for indented function parameters in namespaces was eradicated by @norab0130 in https://github.com/cpplint/cpplint/pull/304 +* IWYU: treat stdio.h the same way as cstdio by @aaronliu0130 in https://github.com/cpplint/cpplint/pull/319 +* README.rst: Add instructions for pre-commit by @cclauss in https://github.com/cpplint/cpplint/pull/320 +* PEP 621: Migrate from setup.{py, cfg} to pyproject.toml by @cclauss in https://github.com/cpplint/cpplint/pull/315 +* Prepare for release 2.0.1 and update changelog by @aaronliu0130 in https://github.com/cpplint/cpplint/pull/322 +* Refactor tests and metadata by @aaronliu0130 in https://github.com/cpplint/cpplint/pull/317 +* misc git cleanup by @aaronliu0130 in https://github.com/cpplint/cpplint/pull/340 +* Mypy: static type checker for Python by @cclauss in https://github.com/cpplint/cpplint/pull/345 +* CONTRIBUTING.rst: Default branch is develop, add pre-commit by @cclauss in https://github.com/cpplint/cpplint/pull/349 +* Fix test refactoring by @aaronliu0130 in https://github.com/cpplint/cpplint/pull/350 +* suppress C++-only categories on C file extensions by @aaronliu0130 in https://github.com/cpplint/cpplint/pull/318 +* Add a GitHub Action to publish to PyPI by @cclauss in https://github.com/cpplint/cpplint/pull/347 + +2.0.0 (2024-10-06) ================ A large long-overdue modernization of the codebase! -* Python 2 is no longer supported. Python 3.12 support was added along with fixed CI for 3.7 and 3.8, courtesy of @jayvdb +* Python versions less than 3.8 are no longer supported. Python 3.12 support was added along with fixed CI for 3.7 and 3.8, courtesy of @jayvdb * As a result of all this, setup.py's lint subcommand was removed. Please run the commands directly instead. * You can now specify blocks of code that exclude linting with NOLINTBEGIN and NOLINTEND, courtesy of @n3world (https://github.com/cpplint/cpplint/pull/213) +* The config filename can now be specified through `--config` thanks to @gedankenexperimenter (https://github.com/cpplint/cpplint/pull/198). Specifying a config file not under the current directory will be available in a future release. * The `--filter` option can now be only applied to a specific file or even a specific line through utilizing colons, e.g. `-filter=-whitespace:foo.h,+whitespace/braces:foo.h:418`. Courtesy of @PhilLab (https://github.com/cpplint/cpplint/pull/171) * NOLINT and NOLINTNEXTLINE comments now support a comma-separated list of categories, courtesy of @n3world (https://github.com/cpplint/cpplint/pull/220) * NOLINT and NOLINTNEXTLINE will now ignore categories known to be from clang-tidy thanks to @xatier (https://github.com/cpplint/cpplint/pull/231) @@ -36,7 +55,7 @@ A large long-overdue modernization of the codebase! * `build/class` and `build/namespaces` no longer check for whether a namespace or class has a closing brace from @geoffviola (https://github.com/cpplint/cpplint/pull/272). This should be done in a more efficient manner by a compiler or language server instead. As part of this, the `build/class` category was removed. * Fixed false positive when an if/else statement has braces everywhere but one of the closing braces before the final block is on a separate line by @aaronliu0130 (https://github.com/cpplint/cpplint/pull/265) * For header files, the check for a header guard's name will now be cached and only run once, as opposed to previously being run on every line. This results in a ~5.6% reduction in run time thanks to @matyalatte, who figured it out, and @aaronliu0130 for implementing it (https://github.com/cpplint/cpplint/pull/291) -* Usages of the deprecated sre_compile were refectored by @jspricke (https://github.com/cpplint/cpplint/pull/214) +* Usages of the deprecated sre_compile were refactored by @jspricke (https://github.com/cpplint/cpplint/pull/214) * Usages of deprecated unittest aliases were refactored by @tirkarthi (https://github.com/cpplint/cpplint/pull/182), @aaronliu0130 and @jayvdb * Typos in this changelog, comments and functions were fixed by @jayvdb (https://github.com/cpplint/cpplint/pull/245), @aaronliu0130 and @tkruse * %-strings were modernized into f-strings by @aaronliu0130 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4ff2e0f..f482e48 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -7,7 +7,7 @@ Thanks for your interest in contributing to cpplint. Any kinds of contributions are welcome: Bug reports, Documentation, Patches. However, here are some contributions you probably shouldn't make: * Drastic reorganization - * Making the code conform to Google's Python style guidelines + * Making the code conform to Google's Python style guidelines * Features that could be regarded as a security vulnerability If you need some ideas, you may check out some of the tasks in our `issue tracker `_. @@ -22,9 +22,9 @@ For many tasks, it is okay to just develop using a single installed python versi 1. (Optional) Install `pyenv `_ to manage python versions 2. (Optional) Using pyenv, install the python versions used in testing:: - pyenv install 3.12.6 + pyenv install 3. # ... - pyenv local 3.12.6 ... + pyenv local 3. ... It may be okay to run and test python against locally installed libraries, but if you need to have a consistent build, it is recommended to manage your environment using virtualenv: `virtualenv `_, `virtualenvwrapper `_:: @@ -36,6 +36,11 @@ Alternatively, you can locally install patches like this:: pip install -e .[dev] # for usage without virtualenv, add --user +Please install pre-commit locally to run the linters before committing:: + + pipx install pre-commit + pre-commit install + Pull requests ------------- @@ -66,9 +71,9 @@ You can test your changes under your local python environment by running the tes pytest # lint the code pylint cpplint.py - flake8 + pre-commit run --all-files -Alternatively, you can run `tox` to automatically run all tests and lints. Use `-e ` followed by the python runner and version (which you must have installed) to automatically generate the testing environment and run the above tests and lints in it. For example, `tox -e py39` does the steps in Python 3.9, `tox -e py312` does the steps in Python 3.12, and `tox -e pypy3` does the steps using the latest version of the pypy interpreter. +Alternatively, you can run `tox` to automatically run all tests and lints. Use `-e ` followed by the python runner and version (which you must have installed) to automatically generate the testing environment and run the above tests and lints in it. For example, `tox -e py39` does the steps in Python 3.9, `tox -e py313` does the steps in Python 3.13, and `tox -e pypy3` does the steps using the latest version of the pypy interpreter. Releasing ========= @@ -116,14 +121,14 @@ To incorporate google's changes: git fetch google gh-pages ## Merge workflow (clean, no new commits) - git checkout master -b updates + git checkout develop -b updates git merge google/gh-pages # this will have a lot of conflicts # ... solve conflicts git merge -- continue ## Rebase workflow (dirty, creates new commits) git checkout -b updates FETCH_HEAD - git rebase master # this will have a lot of conflicts, most of which can be solved with the next command (run repeatedly) + git rebase develop # this will have a lot of conflicts, most of which can be solved with the next command (run repeatedly) # solve conflicts with files deleted in our fork (this is idempotent and safe to be called. when cpplint.py has conflicts, it will do nothing) git status | grep 'new file:' | awk '{print $3}' | xargs -r git rm --cached ; git status | grep 'deleted by us' | awk '{print $4}' | xargs -r git rm git status --untracked-files=no | grep 'nothing to commit' && git rebase --skip @@ -132,7 +137,7 @@ To incorporate google's changes: # check github action git push origin --delete updates - git rebase updates master + git rebase updates develop git branch -D updates git push @@ -156,5 +161,5 @@ To compare this for with upstream (after git fetch): .. code-block:: bash - git diff google/gh-pages:cpplint/cpplint.py master:cpplint.py - git diff google/gh-pages:cpplint/cpplint_unittest.py master:cpplint_unittest.py + git diff google/gh-pages:cpplint/cpplint.py develop:cpplint.py + git diff google/gh-pages:cpplint/cpplint_unittest.py develop:cpplint_unittest.py diff --git a/README.rst b/README.rst index 8d299b9..5d76bca 100644 --- a/README.rst +++ b/README.rst @@ -33,15 +33,11 @@ This fork aims to update cpplint to modern specifications, and be (somewhat) mor Installation ============ -To install cpplint from PyPI, run: +Use [`pipx`](https://pipx.pypa.io) to install cpplint from PyPI, run: .. code-block:: bash - $ pip install cpplint - -Externally managed environments -------------------------------- -If you get the "This environment is externally managed" error, try to search and install cpplint with your system's package manager (e.g. apt, rpm, pacman...). If it doesn't exist, you can either package cpplint for your distribution or repeat the steps above with the :code:`--break-system-packages` flag. + $ pipx install cpplint Usage ----- @@ -55,6 +51,17 @@ For full usage instructions, run: $ cpplint --help +cpplint can also be run as a pre-commit hook by adding to `.pre-commit-config.yaml`: + +.. code-block:: yaml + + - repo: https://github.com/cpplint/cpplint + rev: 2.0.0 + hooks: + - id: cpplint + args: + - --filter=-whitespace/line_length,-whitespace/parens + Changes ======= diff --git a/cpplint.py b/cpplint.py index 10a69c0..6e2cf5d 100755 --- a/cpplint.py +++ b/cpplint.py @@ -41,10 +41,12 @@ same line, but it is far from perfect (in either direction). """ +from __future__ import annotations + import codecs import collections import copy -import getopt +import getopt # pylint: disable=deprecated-module import glob import itertools import math # for log @@ -57,9 +59,9 @@ import xml.etree.ElementTree # if empty, use defaults -_valid_extensions = set([]) +_valid_extensions: set[str] = set() -__VERSION__ = '2.0.0' +__VERSION__ = "2.0.1" _USAGE = """ Syntax: cpplint.py [--verbose=#] [--output=emacs|eclipse|vs7|junit|sed|gsed] @@ -293,513 +295,515 @@ # 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/c++11', - 'build/c++17', - 'build/deprecated', - 'build/endif_comment', - 'build/explicit_make_pair', - 'build/forward_decl', - 'build/header_guard', - 'build/include', - 'build/include_subdir', - 'build/include_alpha', - 'build/include_order', - 'build/include_what_you_use', - 'build/namespaces_headers', - 'build/namespaces_literals', - '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/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/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_if_body', - 'whitespace/empty_loop_body', - 'whitespace/end_of_line', - 'whitespace/ending_newline', - 'whitespace/forcolon', - 'whitespace/indent', - 'whitespace/indent_namespace', - 'whitespace/line_length', - 'whitespace/newline', - 'whitespace/operators', - 'whitespace/parens', - 'whitespace/semicolon', - 'whitespace/tab', - 'whitespace/todo', - ] + "build/c++11", + "build/c++17", + "build/deprecated", + "build/endif_comment", + "build/explicit_make_pair", + "build/forward_decl", + "build/header_guard", + "build/include", + "build/include_subdir", + "build/include_alpha", + "build/include_order", + "build/include_what_you_use", + "build/namespaces_headers", + "build/namespaces_literals", + "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/inheritance", + "readability/multiline_comment", + "readability/multiline_string", + "readability/namespace", + "readability/nolint", + "readability/nul", + "readability/todo", + "readability/utf8", + "runtime/arrays", + "runtime/casting", + "runtime/explicit", + "runtime/int", + "runtime/init", + "runtime/invalid_increment", + "runtime/member_string_references", + "runtime/memset", + "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_if_body", + "whitespace/empty_loop_body", + "whitespace/end_of_line", + "whitespace/ending_newline", + "whitespace/forcolon", + "whitespace/indent", + "whitespace/indent_namespace", + "whitespace/line_length", + "whitespace/newline", + "whitespace/operators", + "whitespace/parens", + "whitespace/semicolon", + "whitespace/tab", + "whitespace/todo", +] # keywords to use with --outputs which generate stdout for machine processing -_MACHINE_OUTPUTS = [ - 'junit', - 'sed', - 'gsed' -] +_MACHINE_OUTPUTS = ["junit", "sed", "gsed"] # These error categories are no longer enforced by cpplint, but for backwards- # compatibility they may still appear in NOLINT comments. _LEGACY_ERROR_CATEGORIES = [ - 'build/class', - 'readability/streams', - 'readability/function', - ] + "build/class", + "readability/streams", + "readability/function", +] # These prefixes for categories should be ignored since they relate to other # tools which also use the NOLINT syntax, e.g. clang-tidy. _OTHER_NOLINT_CATEGORY_PREFIXES = [ - 'clang-analyzer-', - 'abseil-', - 'altera-', - 'android-', - 'boost-', - 'bugprone-', - 'cert-', - 'concurrency-', - 'cppcoreguidelines-', - 'darwin-', - 'fuchsia-', - 'google-', - 'hicpp-', - 'linuxkernel-', - 'llvm-', - 'llvmlibc-', - 'misc-', - 'modernize-', - 'mpi-', - 'objc-', - 'openmp-', - 'performance-', - 'portability-', - 'readability-', - 'zircon-', - ] + "clang-analyzer-", + "abseil-", + "altera-", + "android-", + "boost-", + "bugprone-", + "cert-", + "concurrency-", + "cppcoreguidelines-", + "darwin-", + "fuchsia-", + "google-", + "hicpp-", + "linuxkernel-", + "llvm-", + "llvmlibc-", + "misc-", + "modernize-", + "mpi-", + "objc-", + "openmp-", + "performance-", + "portability-", + "readability-", + "zircon-", +] # 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', - '-readability/fn_size', - ] + "-build/include_alpha", + "-readability/fn_size", +] # The default list of categories suppressed for C (not C++) files. _DEFAULT_C_SUPPRESSED_CATEGORIES = [ - 'readability/casting', - ] + "readability/casting", +] # The default list of categories suppressed for Linux Kernel files. _DEFAULT_KERNEL_SUPPRESSED_CATEGORIES = [ - 'whitespace/tab', - ] + "whitespace/tab", +] # 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', collides with System C header "complex.h" since C11 - 'defalloc.h', - 'deque.h', - 'editbuf.h', - 'fstream.h', - 'function.h', - 'hash_map', - 'hash_map.h', - 'hash_set', - 'hash_set.h', - 'hashtable.h', - 'heap.h', - 'indstream.h', - 'iomanip.h', - 'iostream.h', - 'istream.h', - 'iterator.h', - 'list.h', - 'map.h', - 'multimap.h', - 'multiset.h', - 'ostream.h', - 'pair.h', - 'parsestream.h', - 'pfstream.h', - 'procbuf.h', - 'pthread_alloc', - 'pthread_alloc.h', - 'rope', - 'rope.h', - 'ropeimpl.h', - 'set.h', - 'slist', - 'slist.h', - 'stack.h', - 'stdiostream.h', - 'stl_alloc.h', - 'stl_relops.h', - 'streambuf.h', - 'stream.h', - 'strfile.h', - 'strstream.h', - 'tempbuf.h', - 'tree.h', - 'type_traits.h', - 'vector.h', - # C++ library headers - 'algorithm', - 'array', - 'atomic', - 'bitset', - 'chrono', - 'codecvt', - 'complex', - 'condition_variable', - 'deque', - 'exception', - 'forward_list', - 'fstream', - 'functional', - 'future', - 'initializer_list', - 'iomanip', - 'ios', - 'iosfwd', - 'iostream', - 'istream', - 'iterator', - 'limits', - 'list', - 'locale', - 'map', - 'memory', - 'mutex', - 'new', - 'numeric', - 'ostream', - 'queue', - 'random', - 'ratio', - 'regex', - 'scoped_allocator', - 'set', - 'sstream', - 'stack', - 'stdexcept', - 'streambuf', - 'string', - 'strstream', - 'system_error', - 'thread', - 'tuple', - 'typeindex', - 'typeinfo', - 'type_traits', - 'unordered_map', - 'unordered_set', - 'utility', - 'valarray', - 'vector', - # C++14 headers - 'shared_mutex', - # C++17 headers - 'any', - 'charconv', - 'codecvt', - 'execution', - 'filesystem', - 'memory_resource', - 'optional', - 'string_view', - 'variant', - # C++20 headers - 'barrier', - 'bit', - 'compare', - 'concepts', - 'coroutine', - 'format', - 'latch' - 'numbers', - 'ranges', - 'semaphore', - 'source_location', - 'span', - 'stop_token', - 'syncstream', - 'version', - # C++23 headers - 'expected', - 'flat_map', - 'flat_set', - 'generator', - 'mdspan', - 'print', - 'spanstream', - 'stacktrace', - 'stdfloat', - # C++ headers for C library facilities - 'cassert', - 'ccomplex', - 'cctype', - 'cerrno', - 'cfenv', - 'cfloat', - 'cinttypes', - 'ciso646', - 'climits', - 'clocale', - 'cmath', - 'csetjmp', - 'csignal', - 'cstdalign', - 'cstdarg', - 'cstdbool', - 'cstddef', - 'cstdint', - 'cstdio', - 'cstdlib', - 'cstring', - 'ctgmath', - 'ctime', - 'cuchar', - 'cwchar', - 'cwctype', - ]) +_CPP_HEADERS = frozenset( + [ + # Legacy + "algobase.h", + "algo.h", + "alloc.h", + "builtinbuf.h", + "bvector.h", + # 'complex.h', collides with System C header "complex.h" since C11 + "defalloc.h", + "deque.h", + "editbuf.h", + "fstream.h", + "function.h", + "hash_map", + "hash_map.h", + "hash_set", + "hash_set.h", + "hashtable.h", + "heap.h", + "indstream.h", + "iomanip.h", + "iostream.h", + "istream.h", + "iterator.h", + "list.h", + "map.h", + "multimap.h", + "multiset.h", + "ostream.h", + "pair.h", + "parsestream.h", + "pfstream.h", + "procbuf.h", + "pthread_alloc", + "pthread_alloc.h", + "rope", + "rope.h", + "ropeimpl.h", + "set.h", + "slist", + "slist.h", + "stack.h", + "stdiostream.h", + "stl_alloc.h", + "stl_relops.h", + "streambuf.h", + "stream.h", + "strfile.h", + "strstream.h", + "tempbuf.h", + "tree.h", + "type_traits.h", + "vector.h", + # C++ library headers + "algorithm", + "array", + "atomic", + "bitset", + "chrono", + "codecvt", + "complex", + "condition_variable", + "deque", + "exception", + "forward_list", + "fstream", + "functional", + "future", + "initializer_list", + "iomanip", + "ios", + "iosfwd", + "iostream", + "istream", + "iterator", + "limits", + "list", + "locale", + "map", + "memory", + "mutex", + "new", + "numeric", + "ostream", + "queue", + "random", + "ratio", + "regex", + "scoped_allocator", + "set", + "sstream", + "stack", + "stdexcept", + "streambuf", + "string", + "strstream", + "system_error", + "thread", + "tuple", + "typeindex", + "typeinfo", + "type_traits", + "unordered_map", + "unordered_set", + "utility", + "valarray", + "vector", + # C++14 headers + "shared_mutex", + # C++17 headers + "any", + "charconv", + "codecvt", + "execution", + "filesystem", + "memory_resource", + "optional", + "string_view", + "variant", + # C++20 headers + "barrier", + "bit", + "compare", + "concepts", + "coroutine", + "format", + "latch", + "numbers", + "ranges", + "semaphore", + "source_location", + "span", + "stop_token", + "syncstream", + "version", + # C++23 headers + "expected", + "flat_map", + "flat_set", + "generator", + "mdspan", + "print", + "spanstream", + "stacktrace", + "stdfloat", + # C++ headers for C library facilities + "cassert", + "ccomplex", + "cctype", + "cerrno", + "cfenv", + "cfloat", + "cinttypes", + "ciso646", + "climits", + "clocale", + "cmath", + "csetjmp", + "csignal", + "cstdalign", + "cstdarg", + "cstdbool", + "cstddef", + "cstdint", + "cstdio", + "cstdlib", + "cstring", + "ctgmath", + "ctime", + "cuchar", + "cwchar", + "cwctype", + ] +) # C headers -_C_HEADERS = frozenset([ - # System C headers - 'assert.h', - 'complex.h', - 'ctype.h', - 'errno.h', - 'fenv.h', - 'float.h', - 'inttypes.h', - 'iso646.h', - 'limits.h', - 'locale.h', - 'math.h', - 'setjmp.h', - 'signal.h', - 'stdalign.h', - 'stdarg.h', - 'stdatomic.h', - 'stdbool.h', - 'stddef.h', - 'stdint.h', - 'stdio.h', - 'stdlib.h', - 'stdnoreturn.h', - 'string.h', - 'tgmath.h', - 'threads.h', - 'time.h', - 'uchar.h', - 'wchar.h', - 'wctype.h', - # C23 headers - 'stdbit.h', - 'stdckdint.h', - # additional POSIX C headers - 'aio.h', - 'arpa/inet.h', - 'cpio.h', - 'dirent.h', - 'dlfcn.h', - 'fcntl.h', - 'fmtmsg.h', - 'fnmatch.h', - 'ftw.h', - 'glob.h', - 'grp.h', - 'iconv.h', - 'langinfo.h', - 'libgen.h', - 'monetary.h', - 'mqueue.h', - 'ndbm.h', - 'net/if.h', - 'netdb.h', - 'netinet/in.h', - 'netinet/tcp.h', - 'nl_types.h', - 'poll.h', - 'pthread.h', - 'pwd.h', - 'regex.h', - 'sched.h', - 'search.h', - 'semaphore.h', - 'setjmp.h', - 'signal.h', - 'spawn.h', - 'strings.h', - 'stropts.h', - 'syslog.h', - 'tar.h', - 'termios.h', - 'trace.h', - 'ulimit.h', - 'unistd.h', - 'utime.h', - 'utmpx.h', - 'wordexp.h', - # additional GNUlib headers - 'a.out.h', - 'aliases.h', - 'alloca.h', - 'ar.h', - 'argp.h', - 'argz.h', - 'byteswap.h', - 'crypt.h', - 'endian.h', - 'envz.h', - 'err.h', - 'error.h', - 'execinfo.h', - 'fpu_control.h', - 'fstab.h', - 'fts.h', - 'getopt.h', - 'gshadow.h', - 'ieee754.h', - 'ifaddrs.h', - 'libintl.h', - 'mcheck.h', - 'mntent.h', - 'obstack.h', - 'paths.h', - 'printf.h', - 'pty.h', - 'resolv.h', - 'shadow.h', - 'sysexits.h', - 'ttyent.h', - # Additional linux glibc headers - 'dlfcn.h', - 'elf.h', - 'features.h', - 'gconv.h', - 'gnu-versions.h', - 'lastlog.h', - 'libio.h', - 'link.h', - 'malloc.h', - 'memory.h', - 'netash/ash.h', - 'netatalk/at.h', - 'netax25/ax25.h', - 'neteconet/ec.h', - 'netipx/ipx.h', - 'netiucv/iucv.h', - 'netpacket/packet.h', - 'netrom/netrom.h', - 'netrose/rose.h', - 'nfs/nfs.h', - 'nl_types.h', - 'nss.h', - 're_comp.h', - 'regexp.h', - 'sched.h', - 'sgtty.h', - 'stab.h', - 'stdc-predef.h', - 'stdio_ext.h', - 'syscall.h', - 'termio.h', - 'thread_db.h', - 'ucontext.h', - 'ustat.h', - 'utmp.h', - 'values.h', - 'wait.h', - 'xlocale.h', - # Hardware specific headers - 'arm_neon.h', - 'emmintrin.h', - 'xmmintin.h', - ]) +_C_HEADERS = frozenset( + [ + # System C headers + "assert.h", + "complex.h", + "ctype.h", + "errno.h", + "fenv.h", + "float.h", + "inttypes.h", + "iso646.h", + "limits.h", + "locale.h", + "math.h", + "setjmp.h", + "signal.h", + "stdalign.h", + "stdarg.h", + "stdatomic.h", + "stdbool.h", + "stddef.h", + "stdint.h", + "stdio.h", + "stdlib.h", + "stdnoreturn.h", + "string.h", + "tgmath.h", + "threads.h", + "time.h", + "uchar.h", + "wchar.h", + "wctype.h", + # C23 headers + "stdbit.h", + "stdckdint.h", + # additional POSIX C headers + "aio.h", + "arpa/inet.h", + "cpio.h", + "dirent.h", + "dlfcn.h", + "fcntl.h", + "fmtmsg.h", + "fnmatch.h", + "ftw.h", + "glob.h", + "grp.h", + "iconv.h", + "langinfo.h", + "libgen.h", + "monetary.h", + "mqueue.h", + "ndbm.h", + "net/if.h", + "netdb.h", + "netinet/in.h", + "netinet/tcp.h", + "nl_types.h", + "poll.h", + "pthread.h", + "pwd.h", + "regex.h", + "sched.h", + "search.h", + "semaphore.h", + "setjmp.h", + "signal.h", + "spawn.h", + "strings.h", + "stropts.h", + "syslog.h", + "tar.h", + "termios.h", + "trace.h", + "ulimit.h", + "unistd.h", + "utime.h", + "utmpx.h", + "wordexp.h", + # additional GNUlib headers + "a.out.h", + "aliases.h", + "alloca.h", + "ar.h", + "argp.h", + "argz.h", + "byteswap.h", + "crypt.h", + "endian.h", + "envz.h", + "err.h", + "error.h", + "execinfo.h", + "fpu_control.h", + "fstab.h", + "fts.h", + "getopt.h", + "gshadow.h", + "ieee754.h", + "ifaddrs.h", + "libintl.h", + "mcheck.h", + "mntent.h", + "obstack.h", + "paths.h", + "printf.h", + "pty.h", + "resolv.h", + "shadow.h", + "sysexits.h", + "ttyent.h", + # Additional linux glibc headers + "dlfcn.h", + "elf.h", + "features.h", + "gconv.h", + "gnu-versions.h", + "lastlog.h", + "libio.h", + "link.h", + "malloc.h", + "memory.h", + "netash/ash.h", + "netatalk/at.h", + "netax25/ax25.h", + "neteconet/ec.h", + "netipx/ipx.h", + "netiucv/iucv.h", + "netpacket/packet.h", + "netrom/netrom.h", + "netrose/rose.h", + "nfs/nfs.h", + "nl_types.h", + "nss.h", + "re_comp.h", + "regexp.h", + "sched.h", + "sgtty.h", + "stab.h", + "stdc-predef.h", + "stdio_ext.h", + "syscall.h", + "termio.h", + "thread_db.h", + "ucontext.h", + "ustat.h", + "utmp.h", + "values.h", + "wait.h", + "xlocale.h", + # Hardware specific headers + "arm_neon.h", + "emmintrin.h", + "xmmintin.h", + ] +) # Folders of C libraries so commonly used in C++, # that they have parity with standard C libraries. -C_STANDARD_HEADER_FOLDERS = frozenset([ - # standard C library - "sys", - # glibc for linux - "arpa", - "asm-generic", - "bits", - "gnu", - "net", - "netinet", - "protocols", - "rpc", - "rpcsvc", - "scsi", - # linux kernel header - "drm", - "linux", - "misc", - "mtd", - "rdma", - "sound", - "video", - "xen", - ]) +C_STANDARD_HEADER_FOLDERS = frozenset( + [ + # standard C library + "sys", + # glibc for linux + "arpa", + "asm-generic", + "bits", + "gnu", + "net", + "netinet", + "protocols", + "rpc", + "rpcsvc", + "scsi", + # linux kernel header + "drm", + "linux", + "misc", + "mtd", + "rdma", + "sound", + "video", + "xen", + ] +) # Type names _TYPES = re.compile( - r'^(?:' + r"^(?:" # [dcl.type.simple] - r'(char(16_t|32_t)?)|wchar_t|' - r'bool|short|int|long|signed|unsigned|float|double|' + r"(char(16_t|32_t)?)|wchar_t|" + r"bool|short|int|long|signed|unsigned|float|double|" # [support.types] - r'(ptrdiff_t|size_t|max_align_t|nullptr_t)|' + r"(ptrdiff_t|size_t|max_align_t|nullptr_t)|" # [cstdint.syn] - r'(u?int(_fast|_least)?(8|16|32|64)_t)|' - r'(u?int(max|ptr)_t)|' - r')$') + r"(u?int(_fast|_least)?(8|16|32|64)_t)|" + r"(u?int(max|ptr)_t)|" + r")$" +) # These headers are excluded from [build/include] and [build/include_order] @@ -807,40 +811,52 @@ # - Anything not following google file name conventions (containing an # uppercase character, such as Python.h or nsStringAPI.h, for example). # - Lua headers. -_THIRD_PARTY_HEADERS_PATTERN = re.compile( - r'^(?:[^/]*[A-Z][^/]*\.h|lua\.h|lauxlib\.h|lualib\.h)$') +_THIRD_PARTY_HEADERS_PATTERN = re.compile(r"^(?:[^/]*[A-Z][^/]*\.h|lua\.h|lauxlib\.h|lualib\.h)$") # Pattern for matching FileInfo.BaseName() against test file name -_test_suffixes = ['_test', '_regtest', '_unittest'] -_TEST_FILE_SUFFIX = '(' + '|'.join(_test_suffixes) + r')$' +_test_suffixes = ["_test", "_regtest", "_unittest"] +_TEST_FILE_SUFFIX = "(" + "|".join(_test_suffixes) + r")$" # Pattern that matches only complete whitespace, possibly across multiple lines. -_EMPTY_CONDITIONAL_BODY_PATTERN = re.compile(r'^\s*$', re.DOTALL) +_EMPTY_CONDITIONAL_BODY_PATTERN = re.compile(r"^\s*$", re.DOTALL) # Assertion macros. These are defined in base/logging.h and # testing/base/public/gunit.h. _CHECK_MACROS = [ - 'DCHECK', 'CHECK', - 'EXPECT_TRUE', 'ASSERT_TRUE', - 'EXPECT_FALSE', 'ASSERT_FALSE', - ] + "DCHECK", + "CHECK", + "EXPECT_TRUE", + "ASSERT_TRUE", + "EXPECT_FALSE", + "ASSERT_FALSE", +] # Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE -_CHECK_REPLACEMENT = dict([(macro_var, {}) for macro_var in _CHECK_MACROS]) - -for op, replacement in [('==', 'EQ'), ('!=', 'NE'), - ('>=', 'GE'), ('>', 'GT'), - ('<=', 'LE'), ('<', 'LT')]: - _CHECK_REPLACEMENT['DCHECK'][op] = f'DCHECK_{replacement}' - _CHECK_REPLACEMENT['CHECK'][op] = f'CHECK_{replacement}' - _CHECK_REPLACEMENT['EXPECT_TRUE'][op] = f'EXPECT_{replacement}' - _CHECK_REPLACEMENT['ASSERT_TRUE'][op] = f'ASSERT_{replacement}' - -for op, inv_replacement in [('==', 'NE'), ('!=', 'EQ'), - ('>=', 'LT'), ('>', 'LE'), - ('<=', 'GT'), ('<', 'GE')]: - _CHECK_REPLACEMENT['EXPECT_FALSE'][op] = f'EXPECT_{inv_replacement}' - _CHECK_REPLACEMENT['ASSERT_FALSE'][op] = f'ASSERT_{inv_replacement}' +_CHECK_REPLACEMENT: dict[str, dict[str, str]] = {macro_var: {} for macro_var in _CHECK_MACROS} + +for op, replacement in [ + ("==", "EQ"), + ("!=", "NE"), + (">=", "GE"), + (">", "GT"), + ("<=", "LE"), + ("<", "LT"), +]: + _CHECK_REPLACEMENT["DCHECK"][op] = f"DCHECK_{replacement}" + _CHECK_REPLACEMENT["CHECK"][op] = f"CHECK_{replacement}" + _CHECK_REPLACEMENT["EXPECT_TRUE"][op] = f"EXPECT_{replacement}" + _CHECK_REPLACEMENT["ASSERT_TRUE"][op] = f"ASSERT_{replacement}" + +for op, inv_replacement in [ + ("==", "NE"), + ("!=", "EQ"), + (">=", "LT"), + (">", "LE"), + ("<=", "GT"), + ("<", "GE"), +]: + _CHECK_REPLACEMENT["EXPECT_FALSE"][op] = f"EXPECT_{inv_replacement}" + _CHECK_REPLACEMENT["ASSERT_FALSE"][op] = f"ASSERT_{inv_replacement}" # Alternative tokens and their replacements. For full list, see section 2.5 # Alternative tokens [lex.digraph] in the C++ standard. @@ -848,18 +864,18 @@ # Digraphs (such as '%:') are not included here since it's a mess to # match those on a word boundary. _ALT_TOKEN_REPLACEMENT = { - 'and': '&&', - 'bitor': '|', - 'or': '||', - 'xor': '^', - 'compl': '~', - 'bitand': '&', - 'and_eq': '&=', - 'or_eq': '|=', - 'xor_eq': '^=', - 'not': '!', - 'not_eq': '!=' - } + "and": "&&", + "bitor": "|", + "or": "||", + "xor": "^", + "compl": "~", + "bitand": "&", + "and_eq": "&=", + "or_eq": "|=", + "xor_eq": "^=", + "not": "!", + "not_eq": "!=", +} # Compile regular expression that matches all the above keywords. The "[ =()]" # bit is meant to avoid matching these keywords outside of boolean expressions. @@ -867,7 +883,8 @@ # False positives include C-style multi-line comments and multi-line strings # but those have always been troublesome for cpplint. _ALT_TOKEN_REPLACEMENT_PATTERN = re.compile( - r'([ =()])(' + ('|'.join(_ALT_TOKEN_REPLACEMENT.keys())) + r')([ (]|$)') + r"([ =()])(" + ("|".join(_ALT_TOKEN_REPLACEMENT.keys())) + r")([ (]|$)" +) # These constants define types of headers for use with @@ -880,43 +897,43 @@ _OTHER_HEADER = 6 # These constants define the current inline assembly state -_NO_ASM = 0 # Outside of inline assembly block -_INSIDE_ASM = 1 # Inside inline assembly block -_END_ASM = 2 # Last line of inline assembly block -_BLOCK_ASM = 3 # The whole block is an inline assembly block +_NO_ASM = 0 # Outside of inline assembly block +_INSIDE_ASM = 1 # Inside inline assembly block +_END_ASM = 2 # Last line of inline assembly block +_BLOCK_ASM = 3 # The whole block is an inline assembly block # Match start of assembly blocks -_MATCH_ASM = re.compile(r'^\s*(?:asm|_asm|__asm|__asm__)' - r'(?:\s+(volatile|__volatile__))?' - r'\s*[{(]') +_MATCH_ASM = re.compile( + r"^\s*(?:asm|_asm|__asm|__asm__)" + r"(?:\s+(volatile|__volatile__))?" + r"\s*[{(]" +) # Match strings that indicate we're working on a C (not C++) file. -_SEARCH_C_FILE = re.compile(r'\b(?:LINT_C_FILE|' - r'vim?:\s*.*(\s*|:)filetype=c(\s*|:|$))') +_SEARCH_C_FILE = re.compile( + r"\b(?:LINT_C_FILE|" + r"vim?:\s*.*(\s*|:)filetype=c(\s*|:|$))" +) # Match string that indicates we're working on a Linux Kernel file. -_SEARCH_KERNEL_FILE = re.compile(r'\b(?:LINT_KERNEL_FILE)') +_SEARCH_KERNEL_FILE = re.compile(r"\b(?:LINT_KERNEL_FILE)") # Commands for sed to fix the problem _SED_FIXUPS = { - 'Remove spaces around =': r's/ = /=/', - 'Remove spaces around !=': r's/ != /!=/', - 'Remove space before ( in if (': r's/if (/if(/', - 'Remove space before ( in for (': r's/for (/for(/', - 'Remove space before ( in while (': r's/while (/while(/', - 'Remove space before ( in switch (': r's/switch (/switch(/', - 'Should have a space between // and comment': r's/\/\//\/\/ /', - 'Missing space before {': r's/\([^ ]\){/\1 {/', - 'Tab found, replace by spaces': r's/\t/ /g', - 'Line ends in whitespace. Consider deleting these extra spaces.': r's/\s*$//', - 'You don\'t need a ; after a }': r's/};/}/', - 'Missing space after ,': r's/,\([^ ]\)/, \1/g', + "Remove spaces around =": r"s/ = /=/", + "Remove spaces around !=": r"s/ != /!=/", + "Remove space before ( in if (": r"s/if (/if(/", + "Remove space before ( in for (": r"s/for (/for(/", + "Remove space before ( in while (": r"s/while (/while(/", + "Remove space before ( in switch (": r"s/switch (/switch(/", + "Should have a space between // and comment": r"s/\/\//\/\/ /", + "Missing space before {": r"s/\([^ ]\){/\1 {/", + "Tab found, replace by spaces": r"s/\t/ /g", + "Line ends in whitespace. Consider deleting these extra spaces.": r"s/\s*$//", + "You don't need a ; after a }": r"s/};/}/", + "Missing space after ,": r"s/,\([^ ]\)/, \1/g", } -# {str, set(int)}: a map from error categories to sets of linenumbers -# on which those errors are expected and should be suppressed. -_error_suppressions = {} - # The root directory used for deriving header guard CPP variable. # This is set by --root flag. _root = None @@ -945,888 +962,938 @@ # Treat all headers starting with 'h' equally: .h, .hpp, .hxx etc. # This is set by --headers flag. -_hpp_headers = set([]) +_hpp_headers: set[str] = set() + class ErrorSuppressions: - """Class to track all error suppressions for cpplint""" - - class LineRange: - """Class to represent a range of line numbers for which an error is suppressed""" - def __init__(self, begin, end): - self.begin = begin - self.end = end - - def __str__(self): - return f'[{self.begin}-{self.end}]' - - def __contains__(self, obj): - return self.begin <= obj <= self.end - - def ContainsRange(self, other): - return self.begin <= other.begin and self.end >= other.end - - def __init__(self): - self._suppressions = collections.defaultdict(list) - self._open_block_suppression = None - - def _AddSuppression(self, category, line_range): - suppressed = self._suppressions[category] - if not (suppressed and suppressed[-1].ContainsRange(line_range)): - suppressed.append(line_range) - - def GetOpenBlockStart(self): - """:return: The start of the current open block or `-1` if there is not an open block""" - return self._open_block_suppression.begin if self._open_block_suppression else -1 - - def AddGlobalSuppression(self, category): - """Add a suppression for `category` which is suppressed for the whole file""" - self._AddSuppression(category, self.LineRange(0, math.inf)) - - def AddLineSuppression(self, category, linenum): - """Add a suppression for `category` which is suppressed only on `linenum`""" - self._AddSuppression(category, self.LineRange(linenum, linenum)) - - def StartBlockSuppression(self, category, linenum): - """Start a suppression block for `category` on `linenum`. inclusive""" - if self._open_block_suppression is None: - self._open_block_suppression = self.LineRange(linenum, math.inf) - self._AddSuppression(category, self._open_block_suppression) - - def EndBlockSuppression(self, linenum): - """End the current block suppression on `linenum`. inclusive""" - if self._open_block_suppression: - self._open_block_suppression.end = linenum - self._open_block_suppression = None - - def IsSuppressed(self, category, linenum): - """:return: `True` if `category` is suppressed for `linenum`""" - suppressed = self._suppressions[category] + self._suppressions[None] - return any(linenum in lr for lr in suppressed) - - def HasOpenBlock(self): - """:return: `True` if a block suppression was started but not ended""" - return self._open_block_suppression is not None - - def Clear(self): - """Clear all current error suppressions""" - self._suppressions.clear() - self._open_block_suppression = None + """Class to track all error suppressions for cpplint""" + + class LineRange: + """Class to represent a range of line numbers for which an error is suppressed""" + + def __init__(self, begin, end): + self.begin = begin + self.end = end + + def __str__(self): + return f"[{self.begin}-{self.end}]" + + def __contains__(self, obj): + return self.begin <= obj <= self.end + + def ContainsRange(self, other): + return self.begin <= other.begin and self.end >= other.end + + def __init__(self): + self._suppressions = collections.defaultdict(list) + self._open_block_suppression = None + + def _AddSuppression(self, category, line_range): + suppressed = self._suppressions[category] + if not (suppressed and suppressed[-1].ContainsRange(line_range)): + suppressed.append(line_range) + def GetOpenBlockStart(self): + """:return: The start of the current open block or `-1` if there is not an open block""" + return self._open_block_suppression.begin if self._open_block_suppression else -1 + + def AddGlobalSuppression(self, category): + """Add a suppression for `category` which is suppressed for the whole file""" + self._AddSuppression(category, self.LineRange(0, math.inf)) + + def AddLineSuppression(self, category, linenum): + """Add a suppression for `category` which is suppressed only on `linenum`""" + self._AddSuppression(category, self.LineRange(linenum, linenum)) + + def StartBlockSuppression(self, category, linenum): + """Start a suppression block for `category` on `linenum`. inclusive""" + if self._open_block_suppression is None: + self._open_block_suppression = self.LineRange(linenum, math.inf) + self._AddSuppression(category, self._open_block_suppression) + + def EndBlockSuppression(self, linenum): + """End the current block suppression on `linenum`. inclusive""" + if self._open_block_suppression: + self._open_block_suppression.end = linenum + self._open_block_suppression = None + + def IsSuppressed(self, category, linenum): + """:return: `True` if `category` is suppressed for `linenum`""" + suppressed = self._suppressions[category] + self._suppressions[None] + return any(linenum in lr for lr in suppressed) + + def HasOpenBlock(self): + """:return: `True` if a block suppression was started but not ended""" + return self._open_block_suppression is not None + + def Clear(self): + """Clear all current error suppressions""" + self._suppressions.clear() + self._open_block_suppression = None + + +# {str, set(int)}: a map from error categories to sets of linenumbers +# on which those errors are expected and should be suppressed. _error_suppressions = ErrorSuppressions() + def ProcessHppHeadersOption(val): - global _hpp_headers - try: - _hpp_headers = {ext.strip() for ext in val.split(',')} - except ValueError: - PrintUsage('Header extensions must be comma separated list.') + global _hpp_headers + try: + _hpp_headers = {ext.strip() for ext in val.split(",")} + except ValueError: + PrintUsage("Header extensions must be comma separated list.") + def ProcessIncludeOrderOption(val): - if val is None or val == "default": - pass - elif val == "standardcfirst": - global _include_order - _include_order = val - else: - PrintUsage('Invalid includeorder value %s. Expected default|standardcfirst') + if val is None or val == "default": + pass + elif val == "standardcfirst": + global _include_order + _include_order = val + else: + PrintUsage("Invalid includeorder value %s. Expected default|standardcfirst") + def IsHeaderExtension(file_extension): - return file_extension in GetHeaderExtensions() + return file_extension in GetHeaderExtensions() + def GetHeaderExtensions(): - if _hpp_headers: - return _hpp_headers - if _valid_extensions: - return {h for h in _valid_extensions if 'h' in h} - return set(['h', 'hh', 'hpp', 'hxx', 'h++', 'cuh']) + if _hpp_headers: + return _hpp_headers + if _valid_extensions: + return {h for h in _valid_extensions if "h" in h} + return {"h", "hh", "hpp", "hxx", "h++", "cuh"} + # The allowed extensions for file names # This is set by --extensions flag def GetAllExtensions(): - return GetHeaderExtensions().union(_valid_extensions or set( - ['c', 'cc', 'cpp', 'cxx', 'c++', 'cu'])) - -def ProcessExtensionsOption(val): - global _valid_extensions - try: - extensions = [ext.strip() for ext in val.split(',')] - _valid_extensions = set(extensions) - except ValueError: - PrintUsage('Extensions should be a comma-separated list of values;' - 'for example: extensions=hpp,cpp\n' - f'This could not be parsed: "{val}"') - -def GetNonHeaderExtensions(): - return GetAllExtensions().difference(GetHeaderExtensions()) + return GetHeaderExtensions().union(_valid_extensions or {"c", "cc", "cpp", "cxx", "c++", "cu"}) -def ParseNolintSuppressions(filename, raw_line, linenum, error): - """Updates the global list of line error-suppressions. - - Parses any NOLINT comments on the current line, updating the global - error_suppressions store. Reports an error if the NOLINT comment - was malformed. - - Args: - filename: str, the name of the input file. - raw_line: str, the line of input text, with comments. - linenum: int, the number of the current line. - error: function, an error handler. - """ - matched = re.search(r'\bNOLINT(NEXTLINE|BEGIN|END)?\b(\([^)]+\))?', raw_line) - if matched: - no_lint_type = matched.group(1) - if no_lint_type == 'NEXTLINE': - def ProcessCategory(category): - _error_suppressions.AddLineSuppression(category, linenum + 1) - elif no_lint_type == 'BEGIN': - if _error_suppressions.HasOpenBlock(): - error(filename, linenum, 'readability/nolint', 5, - f'NONLINT block already defined on line {_error_suppressions.GetOpenBlockStart()}') - - def ProcessCategory(category): - _error_suppressions.StartBlockSuppression(category, linenum) - elif no_lint_type == 'END': - if not _error_suppressions.HasOpenBlock(): - error(filename, linenum, 'readability/nolint', 5, 'Not in a NOLINT block') - - def ProcessCategory(category): - if category is not None: - error(filename, linenum, 'readability/nolint', 5, - f'NOLINT categories not supported in block END: {category}') - _error_suppressions.EndBlockSuppression(linenum) - else: - def ProcessCategory(category): - _error_suppressions.AddLineSuppression(category, linenum) - categories = matched.group(2) - if categories in (None, '(*)'): # => "suppress all" - ProcessCategory(None) - elif categories.startswith('(') and categories.endswith(')'): - for category in set(map(lambda c: c.strip(), categories[1:-1].split(','))): - if category in _ERROR_CATEGORIES: - ProcessCategory(category) - elif any(c for c in _OTHER_NOLINT_CATEGORY_PREFIXES if category.startswith(c)): - # Ignore any categories from other tools. - pass - elif category not in _LEGACY_ERROR_CATEGORIES: - error(filename, linenum, 'readability/nolint', 5, - f'Unknown NOLINT error category: {category}') - -def ProcessGlobalSuppresions(lines): - """Deprecated; use ProcessGlobalSuppressions.""" - ProcessGlobalSuppressions(lines) - -def ProcessGlobalSuppressions(lines): - """Updates the list of global error suppressions. - - Parses any lint directives in the file that have global effect. - - Args: - lines: An array of strings, each representing a line of the file, with the - last element being empty if the file is terminated with a newline. - """ - for line in lines: - if _SEARCH_C_FILE.search(line): - for category in _DEFAULT_C_SUPPRESSED_CATEGORIES: - _error_suppressions.AddGlobalSuppression(category) - if _SEARCH_KERNEL_FILE.search(line): - for category in _DEFAULT_KERNEL_SUPPRESSED_CATEGORIES: - _error_suppressions.AddGlobalSuppression(category) - - -def ResetNolintSuppressions(): - """Resets the set of NOLINT suppressions to empty.""" - _error_suppressions.Clear() +def ProcessExtensionsOption(val): + global _valid_extensions + try: + extensions = [ext.strip() for ext in val.split(",")] + _valid_extensions = set(extensions) + except ValueError: + PrintUsage( + "Extensions should be a comma-separated list of values;" + "for example: extensions=hpp,cpp\n" + f'This could not be parsed: "{val}"' + ) -def IsErrorSuppressedByNolint(category, linenum): - """Returns true if the specified error category is suppressed on this line. - Consults the global error_suppressions map populated by - ParseNolintSuppressions/ProcessGlobalSuppressions/ResetNolintSuppressions. +def GetNonHeaderExtensions(): + return GetAllExtensions().difference(GetHeaderExtensions()) - Args: - category: str, the category of the error. - linenum: int, the current line number. - Returns: - bool, True iff the error should be suppressed due to a NOLINT comment, - block suppression or global suppression. - """ - return _error_suppressions.IsSuppressed(category, linenum) +def ParseNolintSuppressions(filename, raw_line, linenum, error): + """Updates the global list of line error-suppressions. -def _IsSourceExtension(s): - """File extension (excluding dot) matches a source file extension.""" - return s in GetNonHeaderExtensions() - - -class _IncludeState(object): - """Tracks line numbers for includes, and the order in which includes appear. - - include_list contains list of lists of (header, line number) pairs. - It's a lists of lists rather than just one flat list to make it - easier to update across preprocessor boundaries. - - Call CheckNextIncludeOrder() once for each header in the file, passing - in the type constants defined above. Calls in an illegal order will - raise an _IncludeError with an appropriate error message. - - """ - # self._section will move monotonically through this set. If it ever - # needs to move backwards, CheckNextIncludeOrder will raise an error. - _INITIAL_SECTION = 0 - _MY_H_SECTION = 1 - _C_SECTION = 2 - _CPP_SECTION = 3 - _OTHER_SYS_SECTION = 4 - _OTHER_H_SECTION = 5 - - _TYPE_NAMES = { - _C_SYS_HEADER: 'C system header', - _CPP_SYS_HEADER: 'C++ system header', - _OTHER_SYS_HEADER: 'other system header', - _LIKELY_MY_HEADER: 'header this file implements', - _POSSIBLE_MY_HEADER: 'header this file may implement', - _OTHER_HEADER: 'other header', - } - _SECTION_NAMES = { - _INITIAL_SECTION: "... nothing. (This can't be an error.)", - _MY_H_SECTION: 'a header this file implements', - _C_SECTION: 'C system header', - _CPP_SECTION: 'C++ system header', - _OTHER_SYS_SECTION: 'other system header', - _OTHER_H_SECTION: 'other header', - } - - def __init__(self): - self.include_list = [[]] - self._section = None - self._last_header = None - self.ResetSection('') - - def FindHeader(self, header): - """Check if a header has already been included. + Parses any NOLINT comments on the current line, updating the global + error_suppressions store. Reports an error if the NOLINT comment + was malformed. Args: - header: header to check. - Returns: - Line number of previous occurrence, or -1 if the header has not - been seen before. + filename: str, the name of the input file. + raw_line: str, the line of input text, with comments. + linenum: int, the number of the current line. + error: function, an error handler. """ - for section_list in self.include_list: - for f in section_list: - if f[0] == header: - return f[1] - return -1 + if matched := re.search(r"\bNOLINT(NEXTLINE|BEGIN|END)?\b(\([^)]+\))?", raw_line): + no_lint_type = matched.group(1) + if no_lint_type == "NEXTLINE": + + def ProcessCategory(category): + _error_suppressions.AddLineSuppression(category, linenum + 1) + elif no_lint_type == "BEGIN": + if _error_suppressions.HasOpenBlock(): + error( + filename, + linenum, + "readability/nolint", + 5, + ( + "NONLINT block already defined on line " + f"{_error_suppressions.GetOpenBlockStart()}" + ), + ) + + def ProcessCategory(category): + _error_suppressions.StartBlockSuppression(category, linenum) + elif no_lint_type == "END": + if not _error_suppressions.HasOpenBlock(): + error(filename, linenum, "readability/nolint", 5, "Not in a NOLINT block") + + def ProcessCategory(category): + if category is not None: + error( + filename, + linenum, + "readability/nolint", + 5, + f"NOLINT categories not supported in block END: {category}", + ) + _error_suppressions.EndBlockSuppression(linenum) + else: - def ResetSection(self, directive): - """Reset section checking for preprocessor directive. + def ProcessCategory(category): + _error_suppressions.AddLineSuppression(category, linenum) + + categories = matched.group(2) + if categories in (None, "(*)"): # => "suppress all" + ProcessCategory(None) + elif categories.startswith("(") and categories.endswith(")"): + for category in {c.strip() for c in categories[1:-1].split(",")}: + if category in _ERROR_CATEGORIES: + ProcessCategory(category) + elif any(c for c in _OTHER_NOLINT_CATEGORY_PREFIXES if category.startswith(c)): + # Ignore any categories from other tools. + pass + elif category not in _LEGACY_ERROR_CATEGORIES: + error( + filename, + linenum, + "readability/nolint", + 5, + f"Unknown NOLINT error category: {category}", + ) + + +def ProcessGlobalSuppressions(filename: str, lines: list[str]) -> None: + """Updates the list of global error suppressions. + + Parses any lint directives in the file that have global effect. Args: - directive: preprocessor directive (e.g. "if", "else"). + lines: An array of strings, each representing a line of the file, with the + last element being empty if the file is terminated with a newline. + filename: str, the name of the input file. """ - # The name of the current section. - self._section = self._INITIAL_SECTION - # The path of last found header. - self._last_header = '' - - # Update list of includes. Note that we never pop from the - # include list. - if directive in ('if', 'ifdef', 'ifndef'): - self.include_list.append([]) - elif directive in ('else', 'elif'): - self.include_list[-1] = [] + for line in lines: + if _SEARCH_C_FILE.search(line) or filename.lower().endswith((".c", ".cu")): + for category in _DEFAULT_C_SUPPRESSED_CATEGORIES: + _error_suppressions.AddGlobalSuppression(category) + if _SEARCH_KERNEL_FILE.search(line): + for category in _DEFAULT_KERNEL_SUPPRESSED_CATEGORIES: + _error_suppressions.AddGlobalSuppression(category) - def SetLastHeader(self, header_path): - self._last_header = header_path - def CanonicalizeAlphabeticalOrder(self, header_path): - """Returns a path canonicalized for alphabetical comparison. - - - replaces "-" with "_" so they both cmp the same. - - removes '-inl' since we don't require them to be after the main header. - - lowercase everything, just in case. +def ResetNolintSuppressions(): + """Resets the set of NOLINT suppressions to empty.""" + _error_suppressions.Clear() - Args: - header_path: Path to be canonicalized. - Returns: - Canonicalized path. - """ - return header_path.replace('-inl.h', '.h').replace('-', '_').lower() +def IsErrorSuppressedByNolint(category, linenum): + """Returns true if the specified error category is suppressed on this line. - def IsInAlphabeticalOrder(self, clean_lines, linenum, header_path): - """Check if a header is in alphabetical order with the previous header. + Consults the global error_suppressions map populated by + ParseNolintSuppressions/ProcessGlobalSuppressions/ResetNolintSuppressions. Args: - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - header_path: Canonicalized header to be checked. - + category: str, the category of the error. + linenum: int, the current line number. Returns: - Returns true if the header is in alphabetical order. + bool, True iff the error should be suppressed due to a NOLINT comment, + block suppression or global suppression. """ - # If previous section is different from current section, _last_header will - # be reset to empty string, so it's always less than current header. - # - # If previous line was a blank line, assume that the headers are - # intentionally sorted the way they are. - if (self._last_header > header_path and - re.match(r'^\s*#\s*include\b', clean_lines.elided[linenum - 1])): - return False - return True - - def CheckNextIncludeOrder(self, header_type): - """Returns a non-empty error message if the next header is out of order. + return _error_suppressions.IsSuppressed(category, linenum) - This function also updates the internal state to be ready to check - the next include. - Args: - header_type: One of the _XXX_HEADER constants defined above. +def _IsSourceExtension(s): + """File extension (excluding dot) matches a source file extension.""" + return s in GetNonHeaderExtensions() - Returns: - The empty string if the header is in the right order, or an - error message describing what's wrong. - """ - error_message = (f'Found {self._TYPE_NAMES[header_type]}' - f' after {self._SECTION_NAMES[self._section]}') - - last_section = self._section - - if header_type == _C_SYS_HEADER: - if self._section <= self._C_SECTION: - self._section = self._C_SECTION - else: - self._last_header = '' - return error_message - elif header_type == _CPP_SYS_HEADER: - if self._section <= self._CPP_SECTION: - self._section = self._CPP_SECTION - else: - self._last_header = '' - return error_message - elif header_type == _OTHER_SYS_HEADER: - if self._section <= self._OTHER_SYS_SECTION: - self._section = self._OTHER_SYS_SECTION - else: - self._last_header = '' - return error_message - elif header_type == _LIKELY_MY_HEADER: - if self._section <= self._MY_H_SECTION: - self._section = self._MY_H_SECTION - else: - self._section = self._OTHER_H_SECTION - elif header_type == _POSSIBLE_MY_HEADER: - if self._section <= self._MY_H_SECTION: - self._section = self._MY_H_SECTION - else: - # This will always be the fallback because we're not sure - # enough that the header is associated with this file. - self._section = self._OTHER_H_SECTION - else: - assert header_type == _OTHER_HEADER - self._section = self._OTHER_H_SECTION - - if last_section != self._section: - self._last_header = '' - - return '' - - -class _CppLintState(object): - """Maintains module-wide state..""" - - def __init__(self): - self.verbose_level = 1 # global setting. - self.error_count = 0 # global count of reported errors - # filters to apply when emitting error messages - self.filters = _DEFAULT_FILTERS[:] - # backup of filter list. Used to restore the state after each file. - self._filters_backup = self.filters[:] - self.counting = 'total' # In what way are we counting errors? - self.errors_by_category = {} # string to int dict storing error counts - self.quiet = False # Suppress non-error messages? - - # output format: - # "emacs" - format that emacs can parse (default) - # "eclipse" - format that eclipse can parse - # "vs7" - format that Microsoft Visual Studio 7 can parse - # "junit" - format that Jenkins, Bamboo, etc can parse - # "sed" - returns a gnu sed command to fix the problem - # "gsed" - like sed, but names the command gsed, e.g. for macOS homebrew users - self.output_format = 'emacs' - - # For JUnit output, save errors and failures until the end so that they - # can be written into the XML - self._junit_errors = [] - self._junit_failures = [] - - def SetOutputFormat(self, output_format): - """Sets the output format for errors.""" - self.output_format = output_format - - def SetQuiet(self, quiet): - """Sets the module's quiet settings, and returns the previous setting.""" - last_quiet = self.quiet - self.quiet = quiet - return last_quiet - - def SetVerboseLevel(self, level): - """Sets the module's verbosity, and returns the previous setting.""" - last_verbose_level = self.verbose_level - self.verbose_level = level - return last_verbose_level +class _IncludeState: + """Tracks line numbers for includes, and the order in which includes appear. - def SetCountingStyle(self, counting_style): - """Sets the module's counting options.""" - self.counting = counting_style + include_list contains list of lists of (header, line number) pairs. + It's a lists of lists rather than just one flat list to make it + easier to update across preprocessor boundaries. - def SetFilters(self, filters): - """Sets the error-message filters. + Call CheckNextIncludeOrder() once for each header in the file, passing + in the type constants defined above. Calls in an illegal order will + raise an _IncludeError with an appropriate error message. - These filters are applied when deciding whether to emit a given - error message. + """ - Args: - filters: A string of comma-separated filters (eg "+whitespace/indent"). - Each filter should start with + or -; else we die. + # self._section will move monotonically through this set. If it ever + # needs to move backwards, CheckNextIncludeOrder will raise an error. + _INITIAL_SECTION = 0 + _MY_H_SECTION = 1 + _C_SECTION = 2 + _CPP_SECTION = 3 + _OTHER_SYS_SECTION = 4 + _OTHER_H_SECTION = 5 + + _TYPE_NAMES = { + _C_SYS_HEADER: "C system header", + _CPP_SYS_HEADER: "C++ system header", + _OTHER_SYS_HEADER: "other system header", + _LIKELY_MY_HEADER: "header this file implements", + _POSSIBLE_MY_HEADER: "header this file may implement", + _OTHER_HEADER: "other header", + } + _SECTION_NAMES = { + _INITIAL_SECTION: "... nothing. (This can't be an error.)", + _MY_H_SECTION: "a header this file implements", + _C_SECTION: "C system header", + _CPP_SECTION: "C++ system header", + _OTHER_SYS_SECTION: "other system header", + _OTHER_H_SECTION: "other header", + } - Raises: - ValueError: The comma-separated filters did not all start with '+' or '-'. - E.g. "-,+whitespace,-whitespace/indent,whitespace/badfilter" - """ - # Default filters always have less priority than the flag ones. - self.filters = _DEFAULT_FILTERS[:] - self.AddFilters(filters) - - def AddFilters(self, filters): - """ Adds more filters to the existing list of error-message filters. """ - for filt in filters.split(','): - clean_filt = filt.strip() - if clean_filt: - self.filters.append(clean_filt) - for filt in self.filters: - if not (filt.startswith('+') or filt.startswith('-')): - raise ValueError('Every filter in --filters must start with + or -' - f' ({filt} does not)') - - def BackupFilters(self): - """ Saves the current filter list to backup storage.""" - self._filters_backup = self.filters[:] - - def RestoreFilters(self): - """ Restores filters previously backed up.""" - self.filters = self._filters_backup[:] - - def ResetErrorCounts(self): - """Sets the module's error statistic back to zero.""" - self.error_count = 0 - self.errors_by_category = {} - - def IncrementErrorCount(self, category): - """Bumps the module's error statistic.""" - self.error_count += 1 - if self.counting in ('toplevel', 'detailed'): - if self.counting != 'detailed': - category = category.split('/')[0] - if category not in self.errors_by_category: - self.errors_by_category[category] = 0 - self.errors_by_category[category] += 1 - - def PrintErrorCounts(self): - """Print a summary of errors by category, and the total.""" - for category, count in sorted(dict.items(self.errors_by_category)): - self.PrintInfo(f'Category \'{category}\' errors found: {count}\n') - if self.error_count > 0: - self.PrintInfo(f'Total errors found: {self.error_count}\n') - - def PrintInfo(self, message): - # _quiet does not represent --quiet flag. - # Hide infos from stdout to keep stdout pure for machine consumption - if not _quiet and self.output_format not in _MACHINE_OUTPUTS: - sys.stdout.write(message) - - def PrintError(self, message): - if self.output_format == 'junit': - self._junit_errors.append(message) - else: - sys.stderr.write(message) + def __init__(self): + self.include_list = [[]] + self._section = None + self._last_header = None + self.ResetSection("") + + def FindHeader(self, header): + """Check if a header has already been included. + + Args: + header: header to check. + Returns: + Line number of previous occurrence, or -1 if the header has not + been seen before. + """ + for section_list in self.include_list: + for f in section_list: + if f[0] == header: + return f[1] + return -1 + + def ResetSection(self, directive): + """Reset section checking for preprocessor directive. + + Args: + directive: preprocessor directive (e.g. "if", "else"). + """ + # The name of the current section. + self._section = self._INITIAL_SECTION + # The path of last found header. + self._last_header = "" + + # Update list of includes. Note that we never pop from the + # include list. + if directive in ("if", "ifdef", "ifndef"): + self.include_list.append([]) + elif directive in ("else", "elif"): + self.include_list[-1] = [] + + def SetLastHeader(self, header_path): + self._last_header = header_path + + def CanonicalizeAlphabeticalOrder(self, header_path): + """Returns a path canonicalized for alphabetical comparison. + + - replaces "-" with "_" so they both cmp the same. + - removes '-inl' since we don't require them to be after the main header. + - lowercase everything, just in case. + + Args: + header_path: Path to be canonicalized. + + Returns: + Canonicalized path. + """ + return header_path.replace("-inl.h", ".h").replace("-", "_").lower() + + def IsInAlphabeticalOrder(self, clean_lines, linenum, header_path): + """Check if a header is in alphabetical order with the previous header. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + header_path: Canonicalized header to be checked. + + Returns: + Returns true if the header is in alphabetical order. + """ + # If previous section is different from current section, _last_header will + # be reset to empty string, so it's always less than current header. + # + # If previous line was a blank line, assume that the headers are + # intentionally sorted the way they are. + return not ( + self._last_header > header_path + and re.match(r"^\s*#\s*include\b", clean_lines.elided[linenum - 1]) + ) + + def CheckNextIncludeOrder(self, header_type): + """Returns a non-empty error message if the next header is out of order. + + This function also updates the internal state to be ready to check + the next include. + + Args: + header_type: One of the _XXX_HEADER constants defined above. + + Returns: + The empty string if the header is in the right order, or an + error message describing what's wrong. + + """ + error_message = ( + f"Found {self._TYPE_NAMES[header_type]} after {self._SECTION_NAMES[self._section]}" + ) + + last_section = self._section + + if header_type == _C_SYS_HEADER: + if self._section <= self._C_SECTION: + self._section = self._C_SECTION + else: + self._last_header = "" + return error_message + elif header_type == _CPP_SYS_HEADER: + if self._section <= self._CPP_SECTION: + self._section = self._CPP_SECTION + else: + self._last_header = "" + return error_message + elif header_type == _OTHER_SYS_HEADER: + if self._section <= self._OTHER_SYS_SECTION: + self._section = self._OTHER_SYS_SECTION + else: + self._last_header = "" + return error_message + elif header_type == _LIKELY_MY_HEADER: + if self._section <= self._MY_H_SECTION: + self._section = self._MY_H_SECTION + else: + self._section = self._OTHER_H_SECTION + elif header_type == _POSSIBLE_MY_HEADER: + if self._section <= self._MY_H_SECTION: + self._section = self._MY_H_SECTION + else: + # This will always be the fallback because we're not sure + # enough that the header is associated with this file. + self._section = self._OTHER_H_SECTION + else: + assert header_type == _OTHER_HEADER + self._section = self._OTHER_H_SECTION + + if last_section != self._section: + self._last_header = "" + + return "" + + +class _CppLintState: + """Maintains module-wide state..""" + + def __init__(self): + self.verbose_level = 1 # global setting. + self.error_count = 0 # global count of reported errors + # filters to apply when emitting error messages + self.filters = _DEFAULT_FILTERS[:] + # backup of filter list. Used to restore the state after each file. + self._filters_backup = self.filters[:] + self.counting = "total" # In what way are we counting errors? + self.errors_by_category = {} # string to int dict storing error counts + self.quiet = False # Suppress non-error messages? + + # output format: + # "emacs" - format that emacs can parse (default) + # "eclipse" - format that eclipse can parse + # "vs7" - format that Microsoft Visual Studio 7 can parse + # "junit" - format that Jenkins, Bamboo, etc can parse + # "sed" - returns a gnu sed command to fix the problem + # "gsed" - like sed, but names the command gsed, e.g. for macOS homebrew users + self.output_format = "emacs" + + # For JUnit output, save errors and failures until the end so that they + # can be written into the XML + self._junit_errors = [] + self._junit_failures = [] + + def SetOutputFormat(self, output_format): + """Sets the output format for errors.""" + self.output_format = output_format + + def SetQuiet(self, quiet): + """Sets the module's quiet settings, and returns the previous setting.""" + last_quiet = self.quiet + self.quiet = quiet + return last_quiet + + def SetVerboseLevel(self, level): + """Sets the module's verbosity, and returns the previous setting.""" + last_verbose_level = self.verbose_level + self.verbose_level = level + return last_verbose_level + + def SetCountingStyle(self, counting_style): + """Sets the module's counting options.""" + self.counting = counting_style + + def SetFilters(self, filters): + """Sets the error-message filters. + + These filters are applied when deciding whether to emit a given + error message. + + Args: + filters: A string of comma-separated filters (eg "+whitespace/indent"). + Each filter should start with + or -; else we die. + + Raises: + ValueError: The comma-separated filters did not all start with '+' or '-'. + E.g. "-,+whitespace,-whitespace/indent,whitespace/badfilter" + """ + # Default filters always have less priority than the flag ones. + self.filters = _DEFAULT_FILTERS[:] + self.AddFilters(filters) + + def AddFilters(self, filters): + """Adds more filters to the existing list of error-message filters.""" + for filt in filters.split(","): + clean_filt = filt.strip() + if clean_filt: + self.filters.append(clean_filt) + for filt in self.filters: + if not filt.startswith(("+", "-")): + msg = f"Every filter in --filters must start with + or - ({filt} does not)" + raise ValueError(msg) + + def BackupFilters(self): + """Saves the current filter list to backup storage.""" + self._filters_backup = self.filters[:] + + def RestoreFilters(self): + """Restores filters previously backed up.""" + self.filters = self._filters_backup[:] + + def ResetErrorCounts(self): + """Sets the module's error statistic back to zero.""" + self.error_count = 0 + self.errors_by_category = {} + + def IncrementErrorCount(self, category): + """Bumps the module's error statistic.""" + self.error_count += 1 + if self.counting in ("toplevel", "detailed"): + if self.counting != "detailed": + category = category.split("/")[0] + if category not in self.errors_by_category: + self.errors_by_category[category] = 0 + self.errors_by_category[category] += 1 + + def PrintErrorCounts(self): + """Print a summary of errors by category, and the total.""" + for category, count in sorted(dict.items(self.errors_by_category)): + self.PrintInfo(f"Category '{category}' errors found: {count}\n") + if self.error_count > 0: + self.PrintInfo(f"Total errors found: {self.error_count}\n") + + def PrintInfo(self, message): + # _quiet does not represent --quiet flag. + # Hide infos from stdout to keep stdout pure for machine consumption + if not _quiet and self.output_format not in _MACHINE_OUTPUTS: + sys.stdout.write(message) + + def PrintError(self, message): + if self.output_format == "junit": + self._junit_errors.append(message) + else: + sys.stderr.write(message) - def AddJUnitFailure(self, filename, linenum, message, category, confidence): - self._junit_failures.append((filename, linenum, message, category, - confidence)) + def AddJUnitFailure(self, filename, linenum, message, category, confidence): + self._junit_failures.append((filename, linenum, message, category, confidence)) - def FormatJUnitXML(self): - num_errors = len(self._junit_errors) - num_failures = len(self._junit_failures) + def FormatJUnitXML(self): + num_errors = len(self._junit_errors) + num_failures = len(self._junit_failures) - testsuite = xml.etree.ElementTree.Element('testsuite') - testsuite.attrib['errors'] = str(num_errors) - testsuite.attrib['failures'] = str(num_failures) - testsuite.attrib['name'] = 'cpplint' + testsuite = xml.etree.ElementTree.Element("testsuite") + testsuite.attrib["errors"] = str(num_errors) + testsuite.attrib["failures"] = str(num_failures) + testsuite.attrib["name"] = "cpplint" - if num_errors == 0 and num_failures == 0: - testsuite.attrib['tests'] = str(1) - xml.etree.ElementTree.SubElement(testsuite, 'testcase', name='passed') + if num_errors == 0 and num_failures == 0: + testsuite.attrib["tests"] = str(1) + xml.etree.ElementTree.SubElement(testsuite, "testcase", name="passed") - else: - testsuite.attrib['tests'] = str(num_errors + num_failures) - if num_errors > 0: - testcase = xml.etree.ElementTree.SubElement(testsuite, 'testcase') - testcase.attrib['name'] = 'errors' - error = xml.etree.ElementTree.SubElement(testcase, 'error') - error.text = '\n'.join(self._junit_errors) - if num_failures > 0: - # Group failures by file - failed_file_order = [] - failures_by_file = {} - for failure in self._junit_failures: - failed_file = failure[0] - if failed_file not in failed_file_order: - failed_file_order.append(failed_file) - failures_by_file[failed_file] = [] - failures_by_file[failed_file].append(failure) - # Create a testcase for each file - for failed_file in failed_file_order: - failures = failures_by_file[failed_file] - testcase = xml.etree.ElementTree.SubElement(testsuite, 'testcase') - testcase.attrib['name'] = failed_file - failure = xml.etree.ElementTree.SubElement(testcase, 'failure') - template = '{0}: {1} [{2}] [{3}]' - texts = [template.format(f[1], f[2], f[3], f[4]) for f in failures] - failure.text = '\n'.join(texts) - - xml_decl = '\n' - return xml_decl + xml.etree.ElementTree.tostring(testsuite, 'utf-8').decode('utf-8') + else: + testsuite.attrib["tests"] = str(num_errors + num_failures) + if num_errors > 0: + testcase = xml.etree.ElementTree.SubElement(testsuite, "testcase") + testcase.attrib["name"] = "errors" + error = xml.etree.ElementTree.SubElement(testcase, "error") + error.text = "\n".join(self._junit_errors) + if num_failures > 0: + # Group failures by file + failed_file_order = [] + failures_by_file = {} + for failure in self._junit_failures: + failed_file = failure[0] + if failed_file not in failed_file_order: + failed_file_order.append(failed_file) + failures_by_file[failed_file] = [] + failures_by_file[failed_file].append(failure) + # Create a testcase for each file + for failed_file in failed_file_order: + failures = failures_by_file[failed_file] + testcase = xml.etree.ElementTree.SubElement(testsuite, "testcase") + testcase.attrib["name"] = failed_file + failure = xml.etree.ElementTree.SubElement(testcase, "failure") + template = "{0}: {1} [{2}] [{3}]" + texts = [template.format(f[1], f[2], f[3], f[4]) for f in failures] + failure.text = "\n".join(texts) + + xml_decl = '\n' + return xml_decl + xml.etree.ElementTree.tostring(testsuite, "utf-8").decode("utf-8") _cpplint_state = _CppLintState() def _OutputFormat(): - """Gets the module's output format.""" - return _cpplint_state.output_format + """Gets the module's output format.""" + return _cpplint_state.output_format def _SetOutputFormat(output_format): - """Sets the module's output format.""" - _cpplint_state.SetOutputFormat(output_format) + """Sets the module's output format.""" + _cpplint_state.SetOutputFormat(output_format) + def _Quiet(): - """Return's the module's quiet setting.""" - return _cpplint_state.quiet + """Return's the module's quiet setting.""" + return _cpplint_state.quiet + def _SetQuiet(quiet): - """Set the module's quiet status, and return previous setting.""" - return _cpplint_state.SetQuiet(quiet) + """Set the module's quiet status, and return previous setting.""" + return _cpplint_state.SetQuiet(quiet) def _VerboseLevel(): - """Returns the module's verbosity setting.""" - return _cpplint_state.verbose_level + """Returns the module's verbosity setting.""" + return _cpplint_state.verbose_level def _SetVerboseLevel(level): - """Sets the module's verbosity, and returns the previous setting.""" - return _cpplint_state.SetVerboseLevel(level) + """Sets the module's verbosity, and returns the previous setting.""" + return _cpplint_state.SetVerboseLevel(level) def _SetCountingStyle(level): - """Sets the module's counting options.""" - _cpplint_state.SetCountingStyle(level) + """Sets the module's counting options.""" + _cpplint_state.SetCountingStyle(level) def _Filters(): - """Returns the module's list of output filters, as a list.""" - return _cpplint_state.filters + """Returns the module's list of output filters, as a list.""" + return _cpplint_state.filters def _SetFilters(filters): - """Sets the module's error-message filters. + """Sets the module's error-message filters. + + These filters are applied when deciding whether to emit a given + error message. - These filters are applied when deciding whether to emit a given - error message. + Args: + filters: A string of comma-separated filters (eg "whitespace/indent"). + Each filter should start with + or -; else we die. + """ + _cpplint_state.SetFilters(filters) - Args: - filters: A string of comma-separated filters (eg "whitespace/indent"). - Each filter should start with + or -; else we die. - """ - _cpplint_state.SetFilters(filters) def _AddFilters(filters): - """Adds more filter overrides. + """Adds more filter overrides. + + Unlike _SetFilters, this function does not reset the current list of filters + available. - Unlike _SetFilters, this function does not reset the current list of filters - available. + Args: + filters: A string of comma-separated filters (eg "whitespace/indent"). + Each filter should start with + or -; else we die. + """ + _cpplint_state.AddFilters(filters) - Args: - filters: A string of comma-separated filters (eg "whitespace/indent"). - Each filter should start with + or -; else we die. - """ - _cpplint_state.AddFilters(filters) def _BackupFilters(): - """ Saves the current filter list to backup storage.""" - _cpplint_state.BackupFilters() + """Saves the current filter list to backup storage.""" + _cpplint_state.BackupFilters() -def _RestoreFilters(): - """ Restores filters previously backed up.""" - _cpplint_state.RestoreFilters() -class _FunctionState(object): - """Tracks current function name and the number of lines in its body.""" +def _RestoreFilters(): + """Restores filters previously backed up.""" + _cpplint_state.RestoreFilters() - _NORMAL_TRIGGER = 250 # for --v=0, 500 for --v=1, etc. - _TEST_TRIGGER = 400 # about 50% more than _NORMAL_TRIGGER. - def __init__(self): - self.in_a_function = False - self.lines_in_function = 0 - self.current_function = '' +class _FunctionState: + """Tracks current function name and the number of lines in its body.""" - def Begin(self, function_name): - """Start analyzing function body. + _NORMAL_TRIGGER = 250 # for --v=0, 500 for --v=1, etc. + _TEST_TRIGGER = 400 # about 50% more than _NORMAL_TRIGGER. - Args: - function_name: The name of the function being tracked. - """ - self.in_a_function = True - self.lines_in_function = 0 - self.current_function = function_name + def __init__(self): + self.in_a_function = False + self.lines_in_function = 0 + self.current_function = "" - def Count(self): - """Count line in current function body.""" - if self.in_a_function: - self.lines_in_function += 1 + def Begin(self, function_name): + """Start analyzing function body. - def Check(self, error, filename, linenum): - """Report if too many lines in function body. + Args: + function_name: The name of the function being tracked. + """ + self.in_a_function = True + self.lines_in_function = 0 + self.current_function = function_name - Args: - error: The function to call with any errors found. - filename: The name of the current file. - linenum: The number of the line to check. - """ - if not self.in_a_function: - return + def Count(self): + """Count line in current function body.""" + if self.in_a_function: + self.lines_in_function += 1 - if re.match(r'T(EST|est)', self.current_function): - base_trigger = self._TEST_TRIGGER - else: - base_trigger = self._NORMAL_TRIGGER - trigger = base_trigger * 2**_VerboseLevel() + def Check(self, error, filename, linenum): + """Report if too many lines in function body. - if self.lines_in_function > trigger: - error_level = int(math.log(self.lines_in_function / base_trigger, 2)) - # 50 => 0, 100 => 1, 200 => 2, 400 => 3, 800 => 4, 1600 => 5, ... - if error_level > 5: - error_level = 5 - error(filename, linenum, 'readability/fn_size', error_level, - 'Small and focused functions are preferred:' - f' {self.current_function} has {self.lines_in_function} non-comment lines' - f' (error triggered by exceeding {trigger} lines).') + Args: + error: The function to call with any errors found. + filename: The name of the current file. + linenum: The number of the line to check. + """ + if not self.in_a_function: + return - def End(self): - """Stop analyzing function body.""" - self.in_a_function = False + if re.match(r"T(EST|est)", self.current_function): + base_trigger = self._TEST_TRIGGER + else: + base_trigger = self._NORMAL_TRIGGER + trigger = base_trigger * 2 ** _VerboseLevel() + + if self.lines_in_function > trigger: + error_level = int(math.log2(self.lines_in_function / base_trigger)) + # 50 => 0, 100 => 1, 200 => 2, 400 => 3, 800 => 4, 1600 => 5, ... + error_level = min(error_level, 5) + error( + filename, + linenum, + "readability/fn_size", + error_level, + "Small and focused functions are preferred:" + f" {self.current_function} has {self.lines_in_function} non-comment lines" + f" (error triggered by exceeding {trigger} lines).", + ) + + def End(self): + """Stop analyzing function body.""" + self.in_a_function = False class _IncludeError(Exception): - """Indicates a problem with the include order in a file.""" - pass + """Indicates a problem with the include order in a file.""" + pass -class FileInfo(object): - """Provides utility functions for filenames. - - FileInfo provides easy access to the components of a file's path - relative to the project root. - """ - - def __init__(self, filename): - self._filename = filename - - def FullName(self): - """Make Windows paths like Unix.""" - return os.path.abspath(self._filename).replace('\\', '/') - - def RepositoryName(self): - r"""FullName after removing the local path to the repository. - If we have a real absolute path name here we can try to do something smart: - detecting the root of the checkout and truncating /path/to/checkout from - the name so that we get header guards that don't include things like - "C:\\Documents and Settings\\..." or "/home/username/..." in them and thus - people on different computers who have checked the source out to different - locations won't see bogus errors. - """ - fullname = self.FullName() - - if os.path.exists(fullname): - project_dir = os.path.dirname(fullname) - - # If the user specified a repository path, it exists, and the file is - # contained in it, use the specified repository path - if _repository: - repo = FileInfo(_repository).FullName() - root_dir = project_dir - while os.path.exists(root_dir): - # allow case insensitive compare on Windows - if os.path.normcase(root_dir) == os.path.normcase(repo): - return os.path.relpath(fullname, root_dir).replace('\\', '/') - one_up_dir = os.path.dirname(root_dir) - if one_up_dir == root_dir: - break - root_dir = one_up_dir - - if os.path.exists(os.path.join(project_dir, ".svn")): - # If there's a .svn file in the current directory, we recursively look - # up the directory tree for the top of the SVN checkout - root_dir = project_dir - one_up_dir = os.path.dirname(root_dir) - while os.path.exists(os.path.join(one_up_dir, ".svn")): - root_dir = os.path.dirname(root_dir) - one_up_dir = os.path.dirname(one_up_dir) - - prefix = os.path.commonprefix([root_dir, project_dir]) - return fullname[len(prefix) + 1:] - - # Not SVN <= 1.6? Try to find a git, hg, or svn top level directory by - # searching up from the current path. - root_dir = current_dir = os.path.dirname(fullname) - while current_dir != os.path.dirname(current_dir): - if (os.path.exists(os.path.join(current_dir, ".git")) or - os.path.exists(os.path.join(current_dir, ".hg")) or - os.path.exists(os.path.join(current_dir, ".svn"))): - root_dir = current_dir - break - current_dir = os.path.dirname(current_dir) - - if (os.path.exists(os.path.join(root_dir, ".git")) or - os.path.exists(os.path.join(root_dir, ".hg")) or - os.path.exists(os.path.join(root_dir, ".svn"))): - prefix = os.path.commonprefix([root_dir, project_dir]) - return fullname[len(prefix) + 1:] - - # Don't know what to do; header guard warnings may be wrong... - return fullname - - def Split(self): - """Splits the file into the directory, basename, and extension. - - For 'chrome/browser/browser.cc', Split() would - return ('chrome/browser', 'browser', '.cc') +class FileInfo: + """Provides utility functions for filenames. - Returns: - A tuple of (directory, basename, extension). + FileInfo provides easy access to the components of a file's path + relative to the project root. """ - googlename = self.RepositoryName() - project, rest = os.path.split(googlename) - return (project,) + os.path.splitext(rest) + def __init__(self, filename): + self._filename = filename + + def FullName(self): + """Make Windows paths like Unix.""" + return os.path.abspath(self._filename).replace("\\", "/") + + def RepositoryName(self): + r"""FullName after removing the local path to the repository. + + If we have a real absolute path name here we can try to do something smart: + detecting the root of the checkout and truncating /path/to/checkout from + the name so that we get header guards that don't include things like + "C:\\Documents and Settings\\..." or "/home/username/..." in them and thus + people on different computers who have checked the source out to different + locations won't see bogus errors. + """ + fullname = self.FullName() + + if os.path.exists(fullname): + project_dir = os.path.dirname(fullname) + + # If the user specified a repository path, it exists, and the file is + # contained in it, use the specified repository path + if _repository: + repo = FileInfo(_repository).FullName() + root_dir = project_dir + while os.path.exists(root_dir): + # allow case insensitive compare on Windows + if os.path.normcase(root_dir) == os.path.normcase(repo): + return os.path.relpath(fullname, root_dir).replace("\\", "/") + one_up_dir = os.path.dirname(root_dir) + if one_up_dir == root_dir: + break + root_dir = one_up_dir + + if os.path.exists(os.path.join(project_dir, ".svn")): + # If there's a .svn file in the current directory, we recursively look + # up the directory tree for the top of the SVN checkout + root_dir = project_dir + one_up_dir = os.path.dirname(root_dir) + while os.path.exists(os.path.join(one_up_dir, ".svn")): + root_dir = os.path.dirname(root_dir) + one_up_dir = os.path.dirname(one_up_dir) + + prefix = os.path.commonprefix([root_dir, project_dir]) + return fullname[len(prefix) + 1 :] + + # Not SVN <= 1.6? Try to find a git, hg, or svn top level directory by + # searching up from the current path. + root_dir = current_dir = os.path.dirname(fullname) + while current_dir != os.path.dirname(current_dir): + if ( + os.path.exists(os.path.join(current_dir, ".git")) + or os.path.exists(os.path.join(current_dir, ".hg")) + or os.path.exists(os.path.join(current_dir, ".svn")) + ): + root_dir = current_dir + break + current_dir = os.path.dirname(current_dir) + + if ( + os.path.exists(os.path.join(root_dir, ".git")) + or os.path.exists(os.path.join(root_dir, ".hg")) + or os.path.exists(os.path.join(root_dir, ".svn")) + ): + prefix = os.path.commonprefix([root_dir, project_dir]) + return fullname[len(prefix) + 1 :] + + # Don't know what to do; header guard warnings may be wrong... + return fullname + + def Split(self): + """Splits the file into the directory, basename, and extension. + + For 'chrome/browser/browser.cc', Split() would + return ('chrome/browser', 'browser', '.cc') + + Returns: + A tuple of (directory, basename, extension). + """ + + googlename = self.RepositoryName() + project, rest = os.path.split(googlename) + return (project,) + os.path.splitext(rest) + + def BaseName(self): + """File base name - text after the final slash, before the final period.""" + return self.Split()[1] + + def Extension(self): + """File extension - text following the final period, includes that period.""" + return self.Split()[2] + + def NoExtension(self): + """File has no source file extension.""" + return "/".join(self.Split()[0:2]) + + def IsSource(self): + """File has a source file extension.""" + return _IsSourceExtension(self.Extension()[1:]) - def BaseName(self): - """File base name - text after the final slash, before the final period.""" - return self.Split()[1] - def Extension(self): - """File extension - text following the final period, includes that period.""" - return self.Split()[2] - - def NoExtension(self): - """File has no source file extension.""" - return '/'.join(self.Split()[0:2]) - - def IsSource(self): - """File has a source file extension.""" - return _IsSourceExtension(self.Extension()[1:]) +def _ShouldPrintError(category, confidence, filename, linenum): + """If confidence >= verbose, category passes filter and is not suppressed.""" + # There are three ways we might decide not to print an error message: + # a "NOLINT(category)" comment appears in the source, + # the verbosity level isn't high enough, or the filters filter it out. + if IsErrorSuppressedByNolint(category, linenum): + return False -def _ShouldPrintError(category, confidence, filename, linenum): - """If confidence >= verbose, category passes filter and is not suppressed.""" + if confidence < _cpplint_state.verbose_level: + return False - # There are three ways we might decide not to print an error message: - # a "NOLINT(category)" comment appears in the source, - # the verbosity level isn't high enough, or the filters filter it out. - if IsErrorSuppressedByNolint(category, linenum): - return False + is_filtered = False + for one_filter in _Filters(): + filter_cat, filter_file, filter_line = _ParseFilterSelector(one_filter[1:]) + category_match = category.startswith(filter_cat) + file_match = filter_file in ("", filename) + line_match = filter_line in (linenum, -1) + + if one_filter.startswith("-"): + if category_match and file_match and line_match: + is_filtered = True + elif one_filter.startswith("+"): + if category_match and file_match and line_match: + is_filtered = False + else: + # should have been checked for in SetFilter. + msg = f"Invalid filter: {one_filter}" + raise ValueError(msg) + return not is_filtered - if confidence < _cpplint_state.verbose_level: - return False - is_filtered = False - for one_filter in _Filters(): - filter_cat, filter_file, filter_line = _ParseFilterSelector(one_filter[1:]) - category_match = category.startswith(filter_cat) - file_match = filter_file == "" or filter_file == filename - line_match = filter_line == linenum or filter_line == -1 - - if one_filter.startswith('-'): - if category_match and file_match and line_match: - is_filtered = True - elif one_filter.startswith('+'): - if category_match and file_match and line_match: - is_filtered = False - else: - assert False # should have been checked for in SetFilter. - if is_filtered: - return False +def Error(filename, linenum, category, confidence, message): + """Logs the fact we've found a lint error. - return True + We log where the error was found, and also our confidence in the error, + that is, how certain we are this is a legitimate style regression, and + not a misidentification or a use that's sometimes justified. + False positives can be suppressed by the use of "NOLINT(category)" + comments, NOLINTNEXTLINE or in blocks started by NOLINTBEGIN. These + are parsed into _error_suppressions. -def Error(filename, linenum, category, confidence, message): - """Logs the fact we've found a lint error. - - We log where the error was found, and also our confidence in the error, - that is, how certain we are this is a legitimate style regression, and - not a misidentification or a use that's sometimes justified. - - False positives can be suppressed by the use of "NOLINT(category)" - comments, NOLINTNEXTLINE or in blocks started by NOLINTBEGIN. These - are parsed into _error_suppressions. - - Args: - filename: The name of the file containing the error. - linenum: The number of the line containing the error. - category: A string used to describe the "category" this bug - falls under: "whitespace", say, or "runtime". Categories - may have a hierarchy separated by slashes: "whitespace/indent". - confidence: A number from 1-5 representing a confidence score for - the error, with 5 meaning that we are certain of the problem, - and 1 meaning that it could be a legitimate construct. - message: The error message. - """ - if _ShouldPrintError(category, confidence, filename, linenum): - _cpplint_state.IncrementErrorCount(category) - if _cpplint_state.output_format == 'vs7': - _cpplint_state.PrintError(f'{filename}({linenum}): error cpplint:' - f' [{category}] {message} [{confidence}]\n') - elif _cpplint_state.output_format == 'eclipse': - sys.stderr.write(f'{filename}:{linenum}: warning:' - f' {message} [{category}] [{confidence}]\n') - elif _cpplint_state.output_format == 'junit': - _cpplint_state.AddJUnitFailure(filename, linenum, message, category, confidence) - elif _cpplint_state.output_format in ['sed', 'gsed']: - if message in _SED_FIXUPS: - sys.stdout.write(f"{_cpplint_state.output_format} -i" - f" '{linenum}{_SED_FIXUPS[message]}' {filename}" - f" # {message} [{category}] [{confidence}]\n") - else: - sys.stderr.write(f'# {filename}:{linenum}: ' - f' "{message}" [{category}] [{confidence}]\n') - else: - final_message = (f'{filename}:{linenum}: ' - f' {message} [{category}] [{confidence}]\n') - sys.stderr.write(final_message) + Args: + filename: The name of the file containing the error. + linenum: The number of the line containing the error. + category: A string used to describe the "category" this bug + falls under: "whitespace", say, or "runtime". Categories + may have a hierarchy separated by slashes: "whitespace/indent". + confidence: A number from 1-5 representing a confidence score for + the error, with 5 meaning that we are certain of the problem, + and 1 meaning that it could be a legitimate construct. + message: The error message. + """ + if _ShouldPrintError(category, confidence, filename, linenum): + _cpplint_state.IncrementErrorCount(category) + if _cpplint_state.output_format == "vs7": + _cpplint_state.PrintError( + f"{filename}({linenum}): error cpplint: [{category}] {message} [{confidence}]\n" + ) + elif _cpplint_state.output_format == "eclipse": + sys.stderr.write( + f"{filename}:{linenum}: warning: {message} [{category}] [{confidence}]\n" + ) + elif _cpplint_state.output_format == "junit": + _cpplint_state.AddJUnitFailure(filename, linenum, message, category, confidence) + elif _cpplint_state.output_format in ["sed", "gsed"]: + if message in _SED_FIXUPS: + sys.stdout.write( + f"{_cpplint_state.output_format} -i" + f" '{linenum}{_SED_FIXUPS[message]}' {filename}" + f" # {message} [{category}] [{confidence}]\n" + ) + else: + sys.stderr.write( + f'# {filename}:{linenum}: "{message}" [{category}] [{confidence}]\n' + ) + else: + final_message = f"{filename}:{linenum}: {message} [{category}] [{confidence}]\n" + sys.stderr.write(final_message) # Matches standard C++ escape sequences per 2.13.2.3 of the C++ standard. -_RE_PATTERN_CLEANSE_LINE_ESCAPES = re.compile( - r'\\([abfnrtv?"\\\']|\d+|x[0-9a-fA-F]+)') +_RE_PATTERN_CLEANSE_LINE_ESCAPES = re.compile(r'\\([abfnrtv?"\\\']|\d+|x[0-9a-fA-F]+)') # Match a single C style comment on the same line. -_RE_PATTERN_C_COMMENTS = r'/\*(?:[^*]|\*(?!/))*\*/' +_RE_PATTERN_C_COMMENTS = r"/\*(?:[^*]|\*(?!/))*\*/" # Matches multi-line C style comments. # This RE is a little bit more complicated than one might expect, because we # have to take care of space removals tools so we can handle comments inside @@ -1836,868 +1903,934 @@ def Error(filename, linenum, category, confidence, message): # if this doesn't work we try on left side but only if there's a non-character # on the right. _RE_PATTERN_CLEANSE_LINE_C_COMMENTS = re.compile( - r'(\s*' + _RE_PATTERN_C_COMMENTS + r'\s*$|' + - _RE_PATTERN_C_COMMENTS + r'\s+|' + - r'\s+' + _RE_PATTERN_C_COMMENTS + r'(?=\W)|' + - _RE_PATTERN_C_COMMENTS + r')') + r"(\s*" + + _RE_PATTERN_C_COMMENTS + + r"\s*$|" + + _RE_PATTERN_C_COMMENTS + + r"\s+|" + + r"\s+" + + _RE_PATTERN_C_COMMENTS + + r"(?=\W)|" + + _RE_PATTERN_C_COMMENTS + + r")" +) def IsCppString(line): - """Does line terminate so, that the next symbol is in string constant. + """Does line terminate so, that the next symbol is in string constant. - This function does not consider single-line nor multi-line comments. + This function does not consider single-line nor multi-line comments. - Args: - line: is a partial line of code starting from the 0..n. + Args: + line: is a partial line of code starting from the 0..n. - Returns: - True, if next character appended to 'line' is inside a - string constant. - """ + Returns: + True, if next character appended to 'line' is inside a + string constant. + """ - line = line.replace(r'\\', 'XX') # after this, \\" does not match to \" - return ((line.count('"') - line.count(r'\"') - line.count("'\"'")) & 1) == 1 + line = line.replace(r"\\", "XX") # after this, \\" does not match to \" + return ((line.count('"') - line.count(r"\"") - line.count("'\"'")) & 1) == 1 def CleanseRawStrings(raw_lines): - """Removes C++11 raw strings from lines. - - Before: - static const char kData[] = R"( - multi-line string - )"; - - After: - static const char kData[] = "" - (replaced by blank line) - ""; - - Args: - raw_lines: list of raw lines. - - Returns: - list of lines with C++11 raw strings replaced by empty strings. - """ - - delimiter = None - lines_without_raw_strings = [] - for line in raw_lines: - if delimiter: - # Inside a raw string, look for the end - end = line.find(delimiter) - if end >= 0: - # Found the end of the string, match leading space for this - # line and resume copying the original lines, and also insert - # a "" on the last line. - leading_space = re.match(r'^(\s*)\S', line) - line = leading_space.group(1) + '""' + line[end + len(delimiter):] - delimiter = None - else: - # Haven't found the end yet, append a blank line. - line = '""' - - # Look for beginning of a raw string, and replace them with - # empty strings. This is done in a loop to handle multiple raw - # strings on the same line. - while delimiter is None: - # Look for beginning of a raw string. - # See 2.14.15 [lex.string] for syntax. - # - # Once we have matched a raw string, we check the prefix of the - # line to make sure that the line is not part of a single line - # comment. It's done this way because we remove raw strings - # before removing comments as opposed to removing comments - # before removing raw strings. This is because there are some - # cpplint checks that requires the comments to be preserved, but - # we don't want to check comments that are inside raw strings. - matched = re.match(r'^(.*?)\b(?:R|u8R|uR|UR|LR)"([^\s\\()]*)\((.*)$', line) - if (matched and - not re.match(r'^([^\'"]|\'(\\.|[^\'])*\'|"(\\.|[^"])*")*//', - matched.group(1))): - delimiter = ')' + matched.group(2) + '"' - - end = matched.group(3).find(delimiter) - if end >= 0: - # Raw string ended on same line - line = (matched.group(1) + '""' + - matched.group(3)[end + len(delimiter):]) - delimiter = None - else: - # Start of a multi-line raw string - line = matched.group(1) + '""' - else: - break + """Removes C++11 raw strings from lines. + + Before: + static const char kData[] = R"( + multi-line string + )"; + + After: + static const char kData[] = "" + (replaced by blank line) + ""; - lines_without_raw_strings.append(line) + Args: + raw_lines: list of raw lines. + + Returns: + list of lines with C++11 raw strings replaced by empty strings. + """ - # TODO(unknown): if delimiter is not None here, we might want to - # emit a warning for unterminated string. - return lines_without_raw_strings + delimiter = None + lines_without_raw_strings = [] + for line in raw_lines: + if delimiter: + # Inside a raw string, look for the end + end = line.find(delimiter) + if end >= 0: + # Found the end of the string, match leading space for this + # line and resume copying the original lines, and also insert + # a "" on the last line. + leading_space = re.match(r"^(\s*)\S", line) + line = leading_space.group(1) + '""' + line[end + len(delimiter) :] + delimiter = None + else: + # Haven't found the end yet, append a blank line. + line = '""' + + # Look for beginning of a raw string, and replace them with + # empty strings. This is done in a loop to handle multiple raw + # strings on the same line. + while delimiter is None: + # Look for beginning of a raw string. + # See 2.14.15 [lex.string] for syntax. + # + # Once we have matched a raw string, we check the prefix of the + # line to make sure that the line is not part of a single line + # comment. It's done this way because we remove raw strings + # before removing comments as opposed to removing comments + # before removing raw strings. This is because there are some + # cpplint checks that requires the comments to be preserved, but + # we don't want to check comments that are inside raw strings. + matched = re.match(r'^(.*?)\b(?:R|u8R|uR|UR|LR)"([^\s\\()]*)\((.*)$', line) + if matched and not re.match( + r'^([^\'"]|\'(\\.|[^\'])*\'|"(\\.|[^"])*")*//', matched.group(1) + ): + delimiter = ")" + matched.group(2) + '"' + + end = matched.group(3).find(delimiter) + if end >= 0: + # Raw string ended on same line + line = matched.group(1) + '""' + matched.group(3)[end + len(delimiter) :] + delimiter = None + else: + # Start of a multi-line raw string + line = matched.group(1) + '""' + else: + break + + lines_without_raw_strings.append(line) + + # TODO(google): if delimiter is not None here, we might want to + # emit a warning for unterminated string. + return lines_without_raw_strings def FindNextMultiLineCommentStart(lines, lineix): - """Find the beginning marker for a multiline comment.""" - while lineix < len(lines): - if lines[lineix].strip().startswith('/*'): - # Only return this marker if the comment goes beyond this line - if lines[lineix].strip().find('*/', 2) < 0: - return lineix - lineix += 1 - return len(lines) + """Find the beginning marker for a multiline comment.""" + while lineix < len(lines): + if lines[lineix].strip().startswith("/*"): + # Only return this marker if the comment goes beyond this line + if lines[lineix].strip().find("*/", 2) < 0: + return lineix + lineix += 1 + return len(lines) def FindNextMultiLineCommentEnd(lines, lineix): - """We are inside a comment, find the end marker.""" - while lineix < len(lines): - if lines[lineix].strip().endswith('*/'): - return lineix - lineix += 1 - return len(lines) + """We are inside a comment, find the end marker.""" + while lineix < len(lines): + if lines[lineix].strip().endswith("*/"): + return lineix + lineix += 1 + return len(lines) def RemoveMultiLineCommentsFromRange(lines, begin, end): - """Clears a range of lines for multi-line comments.""" - # Having // comments makes the lines non-empty, so we will not get - # unnecessary blank line warnings later in the code. - for i in range(begin, end): - lines[i] = '/**/' + """Clears a range of lines for multi-line comments.""" + # Having // comments makes the lines non-empty, so we will not get + # unnecessary blank line warnings later in the code. + for i in range(begin, end): + lines[i] = "/**/" def RemoveMultiLineComments(filename, lines, error): - """Removes multiline (c-style) comments from lines.""" - lineix = 0 - while lineix < len(lines): - lineix_begin = FindNextMultiLineCommentStart(lines, lineix) - if lineix_begin >= len(lines): - return - lineix_end = FindNextMultiLineCommentEnd(lines, lineix_begin) - if lineix_end >= len(lines): - error(filename, lineix_begin + 1, 'readability/multiline_comment', 5, - 'Could not find end of multi-line comment') - return - RemoveMultiLineCommentsFromRange(lines, lineix_begin, lineix_end + 1) - lineix = lineix_end + 1 + """Removes multiline (c-style) comments from lines.""" + lineix = 0 + while lineix < len(lines): + lineix_begin = FindNextMultiLineCommentStart(lines, lineix) + if lineix_begin >= len(lines): + return + lineix_end = FindNextMultiLineCommentEnd(lines, lineix_begin) + if lineix_end >= len(lines): + error( + filename, + lineix_begin + 1, + "readability/multiline_comment", + 5, + "Could not find end of multi-line comment", + ) + return + RemoveMultiLineCommentsFromRange(lines, lineix_begin, lineix_end + 1) + lineix = lineix_end + 1 def CleanseComments(line): - """Removes //-comments and single-line C-style /* */ comments. + """Removes //-comments and single-line C-style /* */ comments. - Args: - line: A line of C++ source. + Args: + line: A line of C++ source. - Returns: - The line with single-line comments removed. - """ - commentpos = line.find('//') - if commentpos != -1 and not IsCppString(line[:commentpos]): - line = line[:commentpos].rstrip() - # get rid of /* ... */ - return _RE_PATTERN_CLEANSE_LINE_C_COMMENTS.sub('', line) + Returns: + The line with single-line comments removed. + """ + commentpos = line.find("//") + if commentpos != -1 and not IsCppString(line[:commentpos]): + line = line[:commentpos].rstrip() + # get rid of /* ... */ + return _RE_PATTERN_CLEANSE_LINE_C_COMMENTS.sub("", line) def ReplaceAlternateTokens(line): - """Replace any alternate token by its original counterpart. - - In order to comply with the google rule stating that unary operators should - never be followed by a space, an exception is made for the 'not' and 'compl' - alternate tokens. For these, any trailing space is removed during the - conversion. - - Args: - line: The line being processed. - - Returns: - The line with alternate tokens replaced. - """ - for match in _ALT_TOKEN_REPLACEMENT_PATTERN.finditer(line): - token = _ALT_TOKEN_REPLACEMENT[match.group(2)] - tail = '' if match.group(2) in ['not', 'compl'] and match.group(3) == ' ' \ - else r'\3' - line = re.sub(match.re, rf'\1{token}{tail}', line, count=1) - return line - - -class CleansedLines(object): - """Holds 4 copies of all lines with different preprocessing applied to them. - - 1) elided member contains lines without strings and comments. - 2) lines member contains lines without comments. - 3) raw_lines member contains all the lines without processing. - 4) lines_without_raw_strings member is same as raw_lines, but with C++11 raw - strings removed. - All these members are of , and of the same length. - """ - - def __init__(self, lines): - if '-readability/alt_tokens' in _cpplint_state.filters: - for i, line in enumerate(lines): - lines[i] = ReplaceAlternateTokens(line) - self.elided = [] - self.lines = [] - self.raw_lines = lines - self.num_lines = len(lines) - self.lines_without_raw_strings = CleanseRawStrings(lines) - for line in self.lines_without_raw_strings: - self.lines.append(CleanseComments(line)) - elided = self._CollapseStrings(line) - self.elided.append(CleanseComments(elided)) - - def NumLines(self): - """Returns the number of lines represented.""" - return self.num_lines - - @staticmethod - def _CollapseStrings(elided): - """Collapses strings and chars on a line to simple "" or '' blocks. - - We nix strings first so we're not fooled by text like '"http://"' + """Replace any alternate token by its original counterpart. + + In order to comply with the google rule stating that unary operators should + never be followed by a space, an exception is made for the 'not' and 'compl' + alternate tokens. For these, any trailing space is removed during the + conversion. Args: - elided: The line being processed. + line: The line being processed. Returns: - The line with collapsed strings. + The line with alternate tokens replaced. + """ + for match in _ALT_TOKEN_REPLACEMENT_PATTERN.finditer(line): + token = _ALT_TOKEN_REPLACEMENT[match.group(2)] + tail = "" if match.group(2) in ["not", "compl"] and match.group(3) == " " else r"\3" + line = re.sub(match.re, rf"\1{token}{tail}", line, count=1) + return line + + +class CleansedLines: + """Holds 4 copies of all lines with different preprocessing applied to them. + + 1) elided member contains lines without strings and comments. + 2) lines member contains lines without comments. + 3) raw_lines member contains all the lines without processing. + 4) lines_without_raw_strings member is same as raw_lines, but with C++11 raw + strings removed. + All these members are of , and of the same length. """ - if _RE_PATTERN_INCLUDE.match(elided): - return elided - - # Remove escaped characters first to make quote/single quote collapsing - # basic. Things that look like escaped characters shouldn't occur - # outside of strings and chars. - elided = _RE_PATTERN_CLEANSE_LINE_ESCAPES.sub('', elided) - - # Replace quoted strings and digit separators. Both single quotes - # and double quotes are processed in the same loop, otherwise - # nested quotes wouldn't work. - collapsed = '' - while True: - # Find the first quote character - match = re.match(r'^([^\'"]*)([\'"])(.*)$', elided) - if not match: - collapsed += elided - break - head, quote, tail = match.groups() - - if quote == '"': - # Collapse double quoted strings - second_quote = tail.find('"') - if second_quote >= 0: - collapsed += head + '""' - elided = tail[second_quote + 1:] - else: - # Unmatched double quote, don't bother processing the rest - # of the line since this is probably a multiline string. - collapsed += elided - break - else: - # Found single quote, check nearby text to eliminate digit separators. - # - # There is no special handling for floating point here, because - # the integer/fractional/exponent parts would all be parsed - # correctly as long as there are digits on both sides of the - # separator. So we are fine as long as we don't see something - # like "0.'3" (gcc 4.9.0 will not allow this literal). - if re.search(r'\b(?:0[bBxX]?|[1-9])[0-9a-fA-F]*$', head): - match_literal = re.match(r'^((?:\'?[0-9a-zA-Z_])*)(.*)$', "'" + tail) - collapsed += head + match_literal.group(1).replace("'", '') - elided = match_literal.group(2) - else: - second_quote = tail.find('\'') - if second_quote >= 0: - collapsed += head + "''" - elided = tail[second_quote + 1:] - else: - # Unmatched single quote - collapsed += elided - break - return collapsed + def __init__(self, lines): + if "-readability/alt_tokens" in _cpplint_state.filters: + for i, line in enumerate(lines): + lines[i] = ReplaceAlternateTokens(line) + self.elided = [] + self.lines = [] + self.raw_lines = lines + self.num_lines = len(lines) + self.lines_without_raw_strings = CleanseRawStrings(lines) + for line in self.lines_without_raw_strings: + self.lines.append(CleanseComments(line)) + elided = self._CollapseStrings(line) + self.elided.append(CleanseComments(elided)) + + def NumLines(self): + """Returns the number of lines represented.""" + return self.num_lines + + @staticmethod + def _CollapseStrings(elided): + """Collapses strings and chars on a line to simple "" or '' blocks. + + We nix strings first so we're not fooled by text like '"http://"' + + Args: + elided: The line being processed. + + Returns: + The line with collapsed strings. + """ + if _RE_PATTERN_INCLUDE.match(elided): + return elided + + # Remove escaped characters first to make quote/single quote collapsing + # basic. Things that look like escaped characters shouldn't occur + # outside of strings and chars. + elided = _RE_PATTERN_CLEANSE_LINE_ESCAPES.sub("", elided) + + # Replace quoted strings and digit separators. Both single quotes + # and double quotes are processed in the same loop, otherwise + # nested quotes wouldn't work. + collapsed = "" + while True: + # Find the first quote character + match = re.match(r'^([^\'"]*)([\'"])(.*)$', elided) + if not match: + collapsed += elided + break + head, quote, tail = match.groups() + + if quote == '"': + # Collapse double quoted strings + second_quote = tail.find('"') + if second_quote >= 0: + collapsed += head + '""' + elided = tail[second_quote + 1 :] + else: + # Unmatched double quote, don't bother processing the rest + # of the line since this is probably a multiline string. + collapsed += elided + break + else: + # Found single quote, check nearby text to eliminate digit separators. + # + # There is no special handling for floating point here, because + # the integer/fractional/exponent parts would all be parsed + # correctly as long as there are digits on both sides of the + # separator. So we are fine as long as we don't see something + # like "0.'3" (gcc 4.9.0 will not allow this literal). + if re.search(r"\b(?:0[bBxX]?|[1-9])[0-9a-fA-F]*$", head): + match_literal = re.match(r"^((?:\'?[0-9a-zA-Z_])*)(.*)$", "'" + tail) + collapsed += head + match_literal.group(1).replace("'", "") + elided = match_literal.group(2) + else: + second_quote = tail.find("'") + if second_quote >= 0: + collapsed += head + "''" + elided = tail[second_quote + 1 :] + else: + # Unmatched single quote + collapsed += elided + break + + return collapsed def FindEndOfExpressionInLine(line, startpos, stack): - """Find the position just after the end of current parenthesized expression. - - Args: - line: a CleansedLines line. - startpos: start searching at this position. - stack: nesting stack at startpos. - - Returns: - On finding matching end: (index just after matching end, None) - On finding an unclosed expression: (-1, None) - Otherwise: (-1, new stack at end of this line) - """ - for i in range(startpos, len(line)): - char = line[i] - if char in '([{': - # Found start of parenthesized expression, push to expression stack - stack.append(char) - elif char == '<': - # Found potential start of template argument list - if i > 0 and line[i - 1] == '<': - # Left shift operator - if stack and stack[-1] == '<': - stack.pop() - if not stack: - return (-1, None) - elif i > 0 and re.search(r'\boperator\s*$', line[0:i]): - # operator<, don't add to stack - continue - else: - # Tentative start of template argument list - stack.append('<') - elif char in ')]}': - # Found end of parenthesized expression. - # - # If we are currently expecting a matching '>', the pending '<' - # must have been an operator. Remove them from expression stack. - while stack and stack[-1] == '<': - stack.pop() - if not stack: - return (-1, None) - if ((stack[-1] == '(' and char == ')') or - (stack[-1] == '[' and char == ']') or - (stack[-1] == '{' and char == '}')): - stack.pop() - if not stack: - return (i + 1, None) - else: - # Mismatched parentheses - return (-1, None) - elif char == '>': - # Found potential end of template argument list. - - # Ignore "->" and operator functions - if (i > 0 and - (line[i - 1] == '-' or re.search(r'\boperator\s*$', line[0:i - 1]))): - continue - - # Pop the stack if there is a matching '<'. Otherwise, ignore - # this '>' since it must be an operator. - if stack: - if stack[-1] == '<': - stack.pop() - if not stack: - return (i + 1, None) - elif char == ';': - # Found something that look like end of statements. If we are currently - # expecting a '>', the matching '<' must have been an operator, since - # template argument list should not contain statements. - while stack and stack[-1] == '<': - stack.pop() - if not stack: - return (-1, None) - - # Did not find end of expression or unbalanced parentheses on this line - return (-1, stack) + """Find the position just after the end of current parenthesized expression. + + Args: + line: a CleansedLines line. + startpos: start searching at this position. + stack: nesting stack at startpos. + + Returns: + On finding matching end: (index just after matching end, None) + On finding an unclosed expression: (-1, None) + Otherwise: (-1, new stack at end of this line) + """ + for i in range(startpos, len(line)): + char = line[i] + if char in "([{": + # Found start of parenthesized expression, push to expression stack + stack.append(char) + elif char == "<": + # Found potential start of template argument list + if i > 0 and line[i - 1] == "<": + # Left shift operator + if stack and stack[-1] == "<": + stack.pop() + if not stack: + return (-1, None) + elif i > 0 and re.search(r"\boperator\s*$", line[0:i]): + # operator<, don't add to stack + continue + else: + # Tentative start of template argument list + stack.append("<") + elif char in ")]}": + # Found end of parenthesized expression. + # + # If we are currently expecting a matching '>', the pending '<' + # must have been an operator. Remove them from expression stack. + while stack and stack[-1] == "<": + stack.pop() + if not stack: + return (-1, None) + if ( + (stack[-1] == "(" and char == ")") + or (stack[-1] == "[" and char == "]") + or (stack[-1] == "{" and char == "}") + ): + stack.pop() + if not stack: + return (i + 1, None) + else: + # Mismatched parentheses + return (-1, None) + elif char == ">": + # Found potential end of template argument list. + + # Ignore "->" and operator functions + if i > 0 and (line[i - 1] == "-" or re.search(r"\boperator\s*$", line[0 : i - 1])): + continue + + # Pop the stack if there is a matching '<'. Otherwise, ignore + # this '>' since it must be an operator. + if stack and stack[-1] == "<": + stack.pop() + if not stack: + return (i + 1, None) + elif char == ";": + # Found something that look like end of statements. If we are currently + # expecting a '>', the matching '<' must have been an operator, since + # template argument list should not contain statements. + while stack and stack[-1] == "<": + stack.pop() + if not stack: + return (-1, None) + + # Did not find end of expression or unbalanced parentheses on this line + return (-1, stack) def CloseExpression(clean_lines, linenum, pos): - """If input points to ( or { or [ or <, finds the position that closes it. - - If lines[linenum][pos] points to a '(' or '{' or '[' or '<', finds the - linenum/pos that correspond to the closing of the expression. - - TODO(unknown): cpplint spends a fair bit of time matching parentheses. - Ideally we would want to index all opening and closing parentheses once - and have CloseExpression be just a simple lookup, but due to preprocessor - tricks, this is not so easy. - - Args: - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - pos: A position on the line. - - Returns: - A tuple (line, linenum, pos) pointer *past* the closing brace, or - (line, len(lines), -1) if we never find a close. Note we ignore - strings and comments when matching; and the line we return is the - 'cleansed' line at linenum. - """ - - line = clean_lines.elided[linenum] - if (line[pos] not in '({[<') or re.match(r'<[<=]', line[pos:]): - return (line, clean_lines.NumLines(), -1) + """If input points to ( or { or [ or <, finds the position that closes it. + + If lines[linenum][pos] points to a '(' or '{' or '[' or '<', finds the + linenum/pos that correspond to the closing of the expression. + + TODO(google): cpplint spends a fair bit of time matching parentheses. + Ideally we would want to index all opening and closing parentheses once + and have CloseExpression be just a simple lookup, but due to preprocessor + tricks, this is not so easy. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + pos: A position on the line. - # Check first line - (end_pos, stack) = FindEndOfExpressionInLine(line, pos, []) - if end_pos > -1: - return (line, linenum, end_pos) + Returns: + A tuple (line, linenum, pos) pointer *past* the closing brace, or + (line, len(lines), -1) if we never find a close. Note we ignore + strings and comments when matching; and the line we return is the + 'cleansed' line at linenum. + """ - # Continue scanning forward - while stack and linenum < clean_lines.NumLines() - 1: - linenum += 1 line = clean_lines.elided[linenum] - (end_pos, stack) = FindEndOfExpressionInLine(line, 0, stack) + if (line[pos] not in "({[<") or re.match(r"<[<=]", line[pos:]): + return (line, clean_lines.NumLines(), -1) + + # Check first line + (end_pos, stack) = FindEndOfExpressionInLine(line, pos, []) if end_pos > -1: - return (line, linenum, end_pos) + return (line, linenum, end_pos) + + # Continue scanning forward + while stack and linenum < clean_lines.NumLines() - 1: + linenum += 1 + line = clean_lines.elided[linenum] + (end_pos, stack) = FindEndOfExpressionInLine(line, 0, stack) + if end_pos > -1: + return (line, linenum, end_pos) - # Did not find end of expression before end of file, give up - return (line, clean_lines.NumLines(), -1) + # Did not find end of expression before end of file, give up + return (line, clean_lines.NumLines(), -1) def FindStartOfExpressionInLine(line, endpos, stack): - """Find position at the matching start of current expression. - - This is almost the reverse of FindEndOfExpressionInLine, but note - that the input position and returned position differs by 1. - - Args: - line: a CleansedLines line. - endpos: start searching at this position. - stack: nesting stack at endpos. - - Returns: - On finding matching start: (index at matching start, None) - On finding an unclosed expression: (-1, None) - Otherwise: (-1, new stack at beginning of this line) - """ - i = endpos - while i >= 0: - char = line[i] - if char in ')]}': - # Found end of expression, push to expression stack - stack.append(char) - elif char == '>': - # Found potential end of template argument list. - # - # Ignore it if it's a "->" or ">=" or "operator>" - if (i > 0 and - (line[i - 1] == '-' or - re.match(r'\s>=\s', line[i - 1:]) or - re.search(r'\boperator\s*$', line[0:i]))): - i -= 1 - else: - stack.append('>') - elif char == '<': - # Found potential start of template argument list - if i > 0 and line[i - 1] == '<': - # Left shift operator + """Find position at the matching start of current expression. + + This is almost the reverse of FindEndOfExpressionInLine, but note + that the input position and returned position differs by 1. + + Args: + line: a CleansedLines line. + endpos: start searching at this position. + stack: nesting stack at endpos. + + Returns: + On finding matching start: (index at matching start, None) + On finding an unclosed expression: (-1, None) + Otherwise: (-1, new stack at beginning of this line) + """ + i = endpos + while i >= 0: + char = line[i] + if char in ")]}": + # Found end of expression, push to expression stack + stack.append(char) + elif char == ">": + # Found potential end of template argument list. + # + # Ignore it if it's a "->" or ">=" or "operator>" + if i > 0 and ( + line[i - 1] == "-" + or re.match(r"\s>=\s", line[i - 1 :]) + or re.search(r"\boperator\s*$", line[0:i]) + ): + i -= 1 + else: + stack.append(">") + elif char == "<": + # Found potential start of template argument list + if i > 0 and line[i - 1] == "<": + # Left shift operator + i -= 1 + else: + # If there is a matching '>', we can pop the expression stack. + # Otherwise, ignore this '<' since it must be an operator. + if stack and stack[-1] == ">": + stack.pop() + if not stack: + return (i, None) + elif char in "([{": + # Found start of expression. + # + # If there are any unmatched '>' on the stack, they must be + # operators. Remove those. + while stack and stack[-1] == ">": + stack.pop() + if not stack: + return (-1, None) + if ( + (char == "(" and stack[-1] == ")") + or (char == "[" and stack[-1] == "]") + or (char == "{" and stack[-1] == "}") + ): + stack.pop() + if not stack: + return (i, None) + else: + # Mismatched parentheses + return (-1, None) + elif char == ";": + # Found something that look like end of statements. If we are currently + # expecting a '<', the matching '>' must have been an operator, since + # template argument list should not contain statements. + while stack and stack[-1] == ">": + stack.pop() + if not stack: + return (-1, None) + i -= 1 - else: - # If there is a matching '>', we can pop the expression stack. - # Otherwise, ignore this '<' since it must be an operator. - if stack and stack[-1] == '>': - stack.pop() - if not stack: - return (i, None) - elif char in '([{': - # Found start of expression. - # - # If there are any unmatched '>' on the stack, they must be - # operators. Remove those. - while stack and stack[-1] == '>': - stack.pop() - if not stack: - return (-1, None) - if ((char == '(' and stack[-1] == ')') or - (char == '[' and stack[-1] == ']') or - (char == '{' and stack[-1] == '}')): - stack.pop() - if not stack: - return (i, None) - else: - # Mismatched parentheses - return (-1, None) - elif char == ';': - # Found something that look like end of statements. If we are currently - # expecting a '<', the matching '>' must have been an operator, since - # template argument list should not contain statements. - while stack and stack[-1] == '>': - stack.pop() - if not stack: - return (-1, None) - - i -= 1 - - return (-1, stack) + + return (-1, stack) def ReverseCloseExpression(clean_lines, linenum, pos): - """If input points to ) or } or ] or >, finds the position that opens it. - - If lines[linenum][pos] points to a ')' or '}' or ']' or '>', finds the - linenum/pos that correspond to the opening of the expression. - - Args: - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - pos: A position on the line. - - Returns: - A tuple (line, linenum, pos) pointer *at* the opening brace, or - (line, 0, -1) if we never find the matching opening brace. Note - we ignore strings and comments when matching; and the line we - return is the 'cleansed' line at linenum. - """ - line = clean_lines.elided[linenum] - if line[pos] not in ')}]>': - return (line, 0, -1) + """If input points to ) or } or ] or >, finds the position that opens it. - # Check last line - (start_pos, stack) = FindStartOfExpressionInLine(line, pos, []) - if start_pos > -1: - return (line, linenum, start_pos) + If lines[linenum][pos] points to a ')' or '}' or ']' or '>', finds the + linenum/pos that correspond to the opening of the expression. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + pos: A position on the line. - # Continue scanning backward - while stack and linenum > 0: - linenum -= 1 + Returns: + A tuple (line, linenum, pos) pointer *at* the opening brace, or + (line, 0, -1) if we never find the matching opening brace. Note + we ignore strings and comments when matching; and the line we + return is the 'cleansed' line at linenum. + """ line = clean_lines.elided[linenum] - (start_pos, stack) = FindStartOfExpressionInLine(line, len(line) - 1, stack) + if line[pos] not in ")}]>": + return (line, 0, -1) + + # Check last line + (start_pos, stack) = FindStartOfExpressionInLine(line, pos, []) if start_pos > -1: - return (line, linenum, start_pos) + return (line, linenum, start_pos) + + # Continue scanning backward + while stack and linenum > 0: + linenum -= 1 + line = clean_lines.elided[linenum] + (start_pos, stack) = FindStartOfExpressionInLine(line, len(line) - 1, stack) + if start_pos > -1: + return (line, linenum, start_pos) - # Did not find start of expression before beginning of file, give up - return (line, 0, -1) + # Did not find start of expression before beginning of file, give up + return (line, 0, -1) def CheckForCopyright(filename, lines, error): - """Logs an error if no Copyright message appears at the top of the file.""" + """Logs an error if no Copyright message appears at the top of the file.""" - # We'll say it should occur by line 10. Don't forget there's a - # placeholder line at the front. - for line in range(1, min(len(lines), 11)): - if re.search(r'Copyright', lines[line], re.I): break - else: # means no copyright line was found - error(filename, 0, 'legal/copyright', 5, - 'No copyright message found. ' - 'You should have a line: "Copyright [year] "') + # We'll say it should occur by line 10. Don't forget there's a + # placeholder line at the front. + for line in range(1, min(len(lines), 11)): + if re.search(r"Copyright", lines[line], re.IGNORECASE): + break + else: # means no copyright line was found + error( + filename, + 0, + "legal/copyright", + 5, + "No copyright message found. " + 'You should have a line: "Copyright [year] "', + ) def GetIndentLevel(line): - """Return the number of leading spaces in line. - - Args: - line: A string to check. - - Returns: - An integer count of leading spaces, possibly zero. - """ - indent = re.match(r'^( *)\S', line) - if indent: - return len(indent.group(1)) - else: + """Return the number of leading spaces in line. + + Args: + line: A string to check. + + Returns: + An integer count of leading spaces, possibly zero. + """ + if indent := re.match(r"^( *)\S", line): + return len(indent.group(1)) return 0 + def PathSplitToList(path): - """Returns the path split into a list by the separator. - - Args: - path: An absolute or relative path (e.g. '/a/b/c/' or '../a') - - Returns: - A list of path components (e.g. ['a', 'b', 'c]). - """ - lst = [] - while True: - (head, tail) = os.path.split(path) - if head == path: # absolute paths end - lst.append(head) - break - if tail == path: # relative paths end - lst.append(tail) - break - - path = head - lst.append(tail) - - lst.reverse() - return lst + """Returns the path split into a list by the separator. + + Args: + path: An absolute or relative path (e.g. '/a/b/c/' or '../a') + + Returns: + A list of path components (e.g. ['a', 'b', 'c]). + """ + lst = [] + while True: + (head, tail) = os.path.split(path) + if head == path: # absolute paths end + lst.append(head) + break + if tail == path: # relative paths end + lst.append(tail) + break + + path = head + lst.append(tail) + + lst.reverse() + return lst + def GetHeaderGuardCPPVariable(filename): - """Returns the CPP variable that should be used as a header guard. + """Returns the CPP variable that should be used as a header guard. - Args: - filename: The name of a C++ header file. + 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. + 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') + # 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() + 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") + 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 + # 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)):] + 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)) + # 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 _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) + 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 - root_abspath = os.path.abspath(_root).replace('\\', '/') + # --root=.. , will prepend the outer directory to the header guard + full_path = fileinfo.FullName() + # adapt slashes for windows + root_abspath = os.path.abspath(_root).replace("\\", "/") - maybe_path = StripListPrefix(PathSplitToList(full_path), - PathSplitToList(root_abspath)) + maybe_path = StripListPrefix(PathSplitToList(full_path), PathSplitToList(root_abspath)) - if _root_debug: - sys.stderr.write(("_root prepend (maybe_path=%s, full_path=%s, " + - "root_abspath=%s)\n") % (maybe_path, full_path, root_abspath)) + if _root_debug: + sys.stderr.write( + ("_root prepend (maybe_path=%s, full_path=%s, " + "root_abspath=%s)\n") + % (maybe_path, full_path, root_abspath) + ) - if maybe_path: - return os.path.join(*maybe_path) + if maybe_path: + return os.path.join(*maybe_path) - if _root_debug: - sys.stderr.write(f"_root ignore, returning {file_path_from_root}\n") + if _root_debug: + sys.stderr.write(f"_root ignore, returning {file_path_from_root}\n") - # --root=FAKE_DIR is ignored - return file_path_from_root + # --root=FAKE_DIR is ignored + return file_path_from_root - file_path_from_root = FixupPathFromRoot() - return re.sub(r'[^a-zA-Z0-9]', '_', file_path_from_root).upper() + '_' + file_path_from_root = FixupPathFromRoot() + return re.sub(r"[^a-zA-Z0-9]", "_", file_path_from_root).upper() + "_" def CheckForHeaderGuard(filename, clean_lines, error, cppvar): - """Checks that the file contains a header guard. - - Logs an error if no #ifndef header guard is present. For other - headers, checks that the full pathname is used. - - Args: - filename: The name of the C++ header file. - clean_lines: A CleansedLines instance containing the file. - error: The function to call with any errors found. - """ - - # Don't check for header guards if there are error suppression - # comments somewhere in this file. - # - # Because this is silencing a warning for a nonexistent line, we - # only support the very specific NOLINT(build/header_guard) syntax, - # and not the general NOLINT or NOLINT(*) syntax. - raw_lines = clean_lines.lines_without_raw_strings - for i in raw_lines: - if re.search(r'//\s*NOLINT\(build/header_guard\)', i): - return - - # Allow pragma once instead of header guards - for i in raw_lines: - if re.search(r'^\s*#pragma\s+once', i): - return - - ifndef = '' - ifndef_linenum = 0 - define = '' - endif = '' - endif_linenum = 0 - for linenum, line in enumerate(raw_lines): - linesplit = line.split() - if len(linesplit) >= 2: - # find the first occurrence of #ifndef and #define, save arg - if not ifndef and linesplit[0] == '#ifndef': - # set ifndef to the header guard presented on the #ifndef line. - ifndef = linesplit[1] - ifndef_linenum = linenum - if not define and linesplit[0] == '#define': - define = linesplit[1] - # find the last occurrence of #endif, save entire line - if line.startswith('#endif'): - endif = line - endif_linenum = linenum - - if not ifndef or not define or ifndef != define: - error(filename, 0, 'build/header_guard', 5, - f'No #ifndef header guard found, suggested CPP variable is: {cppvar}') - return - - # The guard should be PATH_FILE_H_, but we also allow PATH_FILE_H__ - # for backward compatibility. - if ifndef != cppvar: - error_level = 0 - if ifndef != cppvar + '_': - error_level = 5 - - ParseNolintSuppressions(filename, raw_lines[ifndef_linenum], ifndef_linenum, - error) - error(filename, ifndef_linenum, 'build/header_guard', error_level, - f'#ifndef header guard has wrong style, please use: {cppvar}') - - # Check for "//" comments on endif line. - ParseNolintSuppressions(filename, raw_lines[endif_linenum], endif_linenum, - error) - match = re.match(r'#endif\s*//\s*' + cppvar + r'(_)?\b', endif) - if match: - if match.group(1) == '_': - # Issue low severity warning for deprecated double trailing underscore - error(filename, endif_linenum, 'build/header_guard', 0, - f'#endif line should be "#endif // {cppvar}"') - return - - # Didn't find the corresponding "//" comment. If this file does not - # contain any "//" comments at all, it could be that the compiler - # only wants "/**/" comments, look for those instead. - no_single_line_comments = True - for i in range(1, len(raw_lines) - 1): - line = raw_lines[i] - if re.match(r'^(?:(?:\'(?:\.|[^\'])*\')|(?:"(?:\.|[^"])*")|[^\'"])*//', line): - no_single_line_comments = False - break - - if no_single_line_comments: - match = re.match(r'#endif\s*/\*\s*' + cppvar + r'(_)?\s*\*/', endif) - if match: - if match.group(1) == '_': - # Low severity warning for double trailing underscore - error(filename, endif_linenum, 'build/header_guard', 0, - f'#endif line should be "#endif /* {cppvar} */"') - return + """Checks that the file contains a header guard. - # Didn't find anything - error(filename, endif_linenum, 'build/header_guard', 5, - f'#endif line should be "#endif // {cppvar}"') + Logs an error if no #ifndef header guard is present. For other + headers, checks that the full pathname is used. + Args: + filename: The name of the C++ header file. + clean_lines: A CleansedLines instance containing the file. + error: The function to call with any errors found. + """ -def CheckHeaderFileIncluded(filename, include_state, error): - """Logs an error if a source file does not include its header.""" - - # Do not check test files - fileinfo = FileInfo(filename) - if re.search(_TEST_FILE_SUFFIX, fileinfo.BaseName()): - return - - first_include = message = None - basefilename = filename[0:len(filename) - len(fileinfo.Extension())] - for ext in GetHeaderExtensions(): - headerfile = basefilename + '.' + ext - if not os.path.exists(headerfile): - continue - headername = FileInfo(headerfile).RepositoryName() - include_uses_unix_dir_aliases = False - for section_list in include_state.include_list: - for f in section_list: - include_text = f[0] - if "./" in include_text: - include_uses_unix_dir_aliases = True - if headername in include_text or include_text in headername: - return - if not first_include: - first_include = f[1] - - message = f'{fileinfo.RepositoryName()} should include its header file {headername}' - if include_uses_unix_dir_aliases: - message += ". Relative paths like . and .. are not allowed." - - if message: - error(filename, first_include, 'build/include', 5, message) - + # Don't check for header guards if there are error suppression + # comments somewhere in this file. + # + # Because this is silencing a warning for a nonexistent line, we + # only support the very specific NOLINT(build/header_guard) syntax, + # and not the general NOLINT or NOLINT(*) syntax. + raw_lines = clean_lines.lines_without_raw_strings + for i in raw_lines: + if re.search(r"//\s*NOLINT\(build/header_guard\)", i): + return + + # Allow pragma once instead of header guards + for i in raw_lines: + if re.search(r"^\s*#pragma\s+once", i): + return + + ifndef = "" + ifndef_linenum = 0 + define = "" + endif = "" + endif_linenum = 0 + for linenum, line in enumerate(raw_lines): + linesplit = line.split() + if len(linesplit) >= 2: + # find the first occurrence of #ifndef and #define, save arg + if not ifndef and linesplit[0] == "#ifndef": + # set ifndef to the header guard presented on the #ifndef line. + ifndef = linesplit[1] + ifndef_linenum = linenum + if not define and linesplit[0] == "#define": + define = linesplit[1] + # find the last occurrence of #endif, save entire line + if line.startswith("#endif"): + endif = line + endif_linenum = linenum + + if not ifndef or not define or ifndef != define: + error( + filename, + 0, + "build/header_guard", + 5, + f"No #ifndef header guard found, suggested CPP variable is: {cppvar}", + ) + return -def CheckForBadCharacters(filename, lines, error): - """Logs an error for each line containing bad characters. + # The guard should be PATH_FILE_H_, but we also allow PATH_FILE_H__ + # for backward compatibility. + if ifndef != cppvar: + error_level = 0 + if ifndef != cppvar + "_": + error_level = 5 + + ParseNolintSuppressions(filename, raw_lines[ifndef_linenum], ifndef_linenum, error) + error( + filename, + ifndef_linenum, + "build/header_guard", + error_level, + f"#ifndef header guard has wrong style, please use: {cppvar}", + ) + + # Check for "//" comments on endif line. + ParseNolintSuppressions(filename, raw_lines[endif_linenum], endif_linenum, error) + match = re.match(r"#endif\s*//\s*" + cppvar + r"(_)?\b", endif) + if match: + if match.group(1) == "_": + # Issue low severity warning for deprecated double trailing underscore + error( + filename, + endif_linenum, + "build/header_guard", + 0, + f'#endif line should be "#endif // {cppvar}"', + ) + return - Two kinds of bad characters: + # Didn't find the corresponding "//" comment. If this file does not + # contain any "//" comments at all, it could be that the compiler + # only wants "/**/" comments, look for those instead. + no_single_line_comments = True + for i in range(1, len(raw_lines) - 1): + line = raw_lines[i] + if re.match(r'^(?:(?:\'(?:\.|[^\'])*\')|(?:"(?:\.|[^"])*")|[^\'"])*//', line): + no_single_line_comments = False + break - 1. Unicode replacement characters: These indicate that either the file - contained invalid UTF-8 (likely) or Unicode replacement characters (which - it shouldn't). Note that it's possible for this to throw off line - numbering if the invalid UTF-8 occurred adjacent to a newline. + if no_single_line_comments: + match = re.match(r"#endif\s*/\*\s*" + cppvar + r"(_)?\s*\*/", endif) + if match: + if match.group(1) == "_": + # Low severity warning for double trailing underscore + error( + filename, + endif_linenum, + "build/header_guard", + 0, + f'#endif line should be "#endif /* {cppvar} */"', + ) + return + + # Didn't find anything + error( + filename, + endif_linenum, + "build/header_guard", + 5, + f'#endif line should be "#endif // {cppvar}"', + ) - 2. NUL bytes. These are problematic for some tools. - Args: - filename: The name of the current file. - lines: An array of strings, each representing a line of the file. - error: The function to call with any errors found. - """ - for linenum, line in enumerate(lines): - if '\ufffd' in line: - error(filename, linenum, 'readability/utf8', 5, - 'Line contains invalid UTF-8 (or Unicode replacement character).') - if '\0' in line: - error(filename, linenum, 'readability/nul', 5, 'Line contains NUL byte.') +def CheckHeaderFileIncluded(filename, include_state, error): + """Logs an error if a source file does not include its header.""" + # Do not check test files + fileinfo = FileInfo(filename) + if re.search(_TEST_FILE_SUFFIX, fileinfo.BaseName()): + return -def CheckForNewlineAtEOF(filename, lines, error): - """Logs an error if there is no newline char at the end of the file. + first_include = message = None + basefilename = filename[0 : len(filename) - len(fileinfo.Extension())] + for ext in GetHeaderExtensions(): + headerfile = basefilename + "." + ext + if not os.path.exists(headerfile): + continue + headername = FileInfo(headerfile).RepositoryName() + include_uses_unix_dir_aliases = False + for section_list in include_state.include_list: + for f in section_list: + include_text = f[0] + if "./" in include_text: + include_uses_unix_dir_aliases = True + if headername in include_text or include_text in headername: + return + if not first_include: + first_include = f[1] + + message = f"{fileinfo.RepositoryName()} should include its header file {headername}" + if include_uses_unix_dir_aliases: + message += ". Relative paths like . and .. are not allowed." + + if message: + error(filename, first_include, "build/include", 5, message) - Args: - filename: The name of the current file. - lines: An array of strings, each representing a line of the file. - error: The function to call with any errors found. - """ - # The array lines() was created by adding two newlines to the - # original file (go figure), then splitting on \n. - # To verify that the file ends in \n, we just have to make sure the - # last-but-two element of lines() exists and is empty. - if len(lines) < 3 or lines[-2]: - error(filename, len(lines) - 2, 'whitespace/ending_newline', 5, - 'Could not find a newline character at the end of the file.') +def CheckForBadCharacters(filename, lines, error): + """Logs an error for each line containing bad characters. + Two kinds of bad characters: -def CheckForMultilineCommentsAndStrings(filename, clean_lines, linenum, error): - """Logs an error if we see /* ... */ or "..." that extend past one line. - - /* ... */ comments are legit inside macros, for one line. - Otherwise, we prefer // comments, so it's ok to warn about the - other. Likewise, it's ok for strings to extend across multiple - lines, as long as a line continuation character (backslash) - terminates each line. Although not currently prohibited by the C++ - style guide, it's ugly and unnecessary. We don't do well with either - in this lint program, so we warn about both. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # Remove all \\ (escaped backslashes) from the line. They are OK, and the - # second (escaped) slash may trigger later \" detection erroneously. - line = line.replace('\\\\', '') - - if line.count('/*') > line.count('*/'): - error(filename, linenum, 'readability/multiline_comment', 5, - 'Complex multi-line /*...*/-style comment found. ' - 'Lint may give bogus warnings. ' - 'Consider replacing these with //-style comments, ' - 'with #if 0...#endif, ' - 'or with more clearly structured multi-line comments.') - - if (line.count('"') - line.count('\\"')) % 2: - error(filename, linenum, 'readability/multiline_string', 5, - 'Multi-line string ("...") found. This lint script doesn\'t ' - 'do well with such strings, and may give bogus warnings. ' - 'Use C++11 raw strings or concatenation instead.') + 1. Unicode replacement characters: These indicate that either the file + contained invalid UTF-8 (likely) or Unicode replacement characters (which + it shouldn't). Note that it's possible for this to throw off line + numbering if the invalid UTF-8 occurred adjacent to a newline. + 2. NUL bytes. These are problematic for some tools. -# (non-threadsafe name, thread-safe alternative, validation pattern) -# + Args: + filename: The name of the current file. + lines: An array of strings, each representing a line of the file. + error: The function to call with any errors found. + """ + for linenum, line in enumerate(lines): + if "\ufffd" in line: + error( + filename, + linenum, + "readability/utf8", + 5, + "Line contains invalid UTF-8 (or Unicode replacement character).", + ) + if "\0" in line: + error(filename, linenum, "readability/nul", 5, "Line contains NUL byte.") + + +def CheckForNewlineAtEOF(filename, lines, error): + """Logs an error if there is no newline char at the end of the file. + + Args: + filename: The name of the current file. + lines: An array of strings, each representing a line of the file. + error: The function to call with any errors found. + """ + + # The array lines() was created by adding two newlines to the + # original file (go figure), then splitting on \n. + # To verify that the file ends in \n, we just have to make sure the + # last-but-two element of lines() exists and is empty. + if len(lines) < 3 or lines[-2]: + error( + filename, + len(lines) - 2, + "whitespace/ending_newline", + 5, + "Could not find a newline character at the end of the file.", + ) + + +def CheckForMultilineCommentsAndStrings(filename, clean_lines, linenum, error): + """Logs an error if we see /* ... */ or "..." that extend past one line. + + /* ... */ comments are legit inside macros, for one line. + Otherwise, we prefer // comments, so it's ok to warn about the + other. Likewise, it's ok for strings to extend across multiple + lines, as long as a line continuation character (backslash) + terminates each line. Although not currently prohibited by the C++ + style guide, it's ugly and unnecessary. We don't do well with either + in this lint program, so we warn about both. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Remove all \\ (escaped backslashes) from the line. They are OK, and the + # second (escaped) slash may trigger later \" detection erroneously. + line = line.replace("\\\\", "") + + if line.count("/*") > line.count("*/"): + error( + filename, + linenum, + "readability/multiline_comment", + 5, + "Complex multi-line /*...*/-style comment found. " + "Lint may give bogus warnings. " + "Consider replacing these with //-style comments, " + "with #if 0...#endif, " + "or with more clearly structured multi-line comments.", + ) + + if (line.count('"') - line.count('\\"')) % 2: + error( + filename, + linenum, + "readability/multiline_string", + 5, + 'Multi-line string ("...") found. This lint script doesn\'t ' + "do well with such strings, and may give bogus warnings. " + "Use C++11 raw strings or concatenation instead.", + ) + + +# (non-threadsafe name, thread-safe alternative, validation pattern) +# # The validation pattern is used to eliminate false positives such as: # _rand(); // false positive due to substring match. # ->rand(); // some member function rand(). @@ -2708,126 +2841,61 @@ def CheckForMultilineCommentsAndStrings(filename, clean_lines, linenum, error): # in some expression context on the same line by matching on some # operator before the function name. This eliminates constructors and # member function calls. -_UNSAFE_FUNC_PREFIX = r'(?:[-+*/=%^&|(<]\s*|>\s+)' +_UNSAFE_FUNC_PREFIX = r"(?:[-+*/=%^&|(<]\s*|>\s+)" _THREADING_LIST = ( - ('asctime(', 'asctime_r(', _UNSAFE_FUNC_PREFIX + r'asctime\([^)]+\)'), - ('ctime(', 'ctime_r(', _UNSAFE_FUNC_PREFIX + r'ctime\([^)]+\)'), - ('getgrgid(', 'getgrgid_r(', _UNSAFE_FUNC_PREFIX + r'getgrgid\([^)]+\)'), - ('getgrnam(', 'getgrnam_r(', _UNSAFE_FUNC_PREFIX + r'getgrnam\([^)]+\)'), - ('getlogin(', 'getlogin_r(', _UNSAFE_FUNC_PREFIX + r'getlogin\(\)'), - ('getpwnam(', 'getpwnam_r(', _UNSAFE_FUNC_PREFIX + r'getpwnam\([^)]+\)'), - ('getpwuid(', 'getpwuid_r(', _UNSAFE_FUNC_PREFIX + r'getpwuid\([^)]+\)'), - ('gmtime(', 'gmtime_r(', _UNSAFE_FUNC_PREFIX + r'gmtime\([^)]+\)'), - ('localtime(', 'localtime_r(', _UNSAFE_FUNC_PREFIX + r'localtime\([^)]+\)'), - ('rand(', 'rand_r(', _UNSAFE_FUNC_PREFIX + r'rand\(\)'), - ('strtok(', 'strtok_r(', - _UNSAFE_FUNC_PREFIX + r'strtok\([^)]+\)'), - ('ttyname(', 'ttyname_r(', _UNSAFE_FUNC_PREFIX + r'ttyname\([^)]+\)'), - ) + ("asctime(", "asctime_r(", _UNSAFE_FUNC_PREFIX + r"asctime\([^)]+\)"), + ("ctime(", "ctime_r(", _UNSAFE_FUNC_PREFIX + r"ctime\([^)]+\)"), + ("getgrgid(", "getgrgid_r(", _UNSAFE_FUNC_PREFIX + r"getgrgid\([^)]+\)"), + ("getgrnam(", "getgrnam_r(", _UNSAFE_FUNC_PREFIX + r"getgrnam\([^)]+\)"), + ("getlogin(", "getlogin_r(", _UNSAFE_FUNC_PREFIX + r"getlogin\(\)"), + ("getpwnam(", "getpwnam_r(", _UNSAFE_FUNC_PREFIX + r"getpwnam\([^)]+\)"), + ("getpwuid(", "getpwuid_r(", _UNSAFE_FUNC_PREFIX + r"getpwuid\([^)]+\)"), + ("gmtime(", "gmtime_r(", _UNSAFE_FUNC_PREFIX + r"gmtime\([^)]+\)"), + ("localtime(", "localtime_r(", _UNSAFE_FUNC_PREFIX + r"localtime\([^)]+\)"), + ("rand(", "rand_r(", _UNSAFE_FUNC_PREFIX + r"rand\(\)"), + ("strtok(", "strtok_r(", _UNSAFE_FUNC_PREFIX + r"strtok\([^)]+\)"), + ("ttyname(", "ttyname_r(", _UNSAFE_FUNC_PREFIX + r"ttyname\([^)]+\)"), +) def CheckPosixThreading(filename, clean_lines, linenum, error): - """Checks for calls to thread-unsafe functions. - - Much code has been originally written without consideration of - multi-threading. Also, engineers are relying on their old experience; - they have learned posix before threading extensions were added. These - tests guide the engineers to use thread-safe functions (when using - posix directly). - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - for single_thread_func, multithread_safe_func, pattern in _THREADING_LIST: - # Additional pattern matching check to confirm that this is the - # function we are looking for - if re.search(pattern, line): - error(filename, linenum, 'runtime/threadsafe_fn', 2, - 'Consider using ' + multithread_safe_func + - '...) instead of ' + single_thread_func + - '...) for improved thread safety.') - - -def CheckVlogArguments(filename, clean_lines, linenum, error): - """Checks that VLOG() is only used for defining a logging level. - - For example, VLOG(2) is correct. VLOG(INFO), VLOG(WARNING), VLOG(ERROR), and - VLOG(FATAL) are not. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - if re.search(r'\bVLOG\((INFO|ERROR|WARNING|DFATAL|FATAL)\)', line): - error(filename, linenum, 'runtime/vlog', 5, - 'VLOG() should be used with numeric verbosity level. ' - 'Use LOG() if you want symbolic severity levels.') - -# Matches invalid increment: *count++, which moves pointer instead of -# incrementing a value. -_RE_PATTERN_INVALID_INCREMENT = re.compile( - r'^\s*\*\w+(\+\+|--);') - - -def CheckInvalidIncrement(filename, clean_lines, linenum, error): - """Checks for invalid increment *count++. - - For example following function: - void increment_counter(int* count) { - *count++; - } - is invalid, because it effectively does count++, moving pointer, and should - be replaced with ++*count, (*count)++ or *count += 1. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - if _RE_PATTERN_INVALID_INCREMENT.match(line): - error(filename, linenum, 'runtime/invalid_increment', 5, - 'Changing pointer instead of value (or unused value of operator*).') - - -def IsMacroDefinition(clean_lines, linenum): - if re.search(r'^#define', clean_lines[linenum]): - return True - - if linenum > 0 and re.search(r'\\$', clean_lines[linenum - 1]): - return True - - return False - - -def IsForwardClassDeclaration(clean_lines, linenum): - return re.match(r'^\s*(\btemplate\b)*.*class\s+\w+;\s*$', clean_lines[linenum]) + """Checks for calls to thread-unsafe functions. + Much code has been originally written without consideration of + multi-threading. Also, engineers are relying on their old experience; + they have learned posix before threading extensions were added. These + tests guide the engineers to use thread-safe functions (when using + posix directly). -class _BlockInfo(object): - """Stores information about a generic block of code.""" + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + for single_thread_func, multithread_safe_func, pattern in _THREADING_LIST: + # Additional pattern matching check to confirm that this is the + # function we are looking for + if re.search(pattern, line): + error( + filename, + linenum, + "runtime/threadsafe_fn", + 2, + "Consider using " + + multithread_safe_func + + "...) instead of " + + single_thread_func + + "...) for improved thread safety.", + ) - def __init__(self, linenum, seen_open_brace): - self.starting_linenum = linenum - self.seen_open_brace = seen_open_brace - self.open_parentheses = 0 - self.inline_asm = _NO_ASM - self.check_namespace_indentation = False - def CheckBegin(self, filename, clean_lines, linenum, error): - """Run checks that applies to text up to the opening brace. +def CheckVlogArguments(filename, clean_lines, linenum, error): + """Checks that VLOG() is only used for defining a logging level. - This is mostly for checking the text after the class identifier - and the "{", usually where the base class is specified. For other - blocks, there isn't much to check, so we always pass. + For example, VLOG(2) is correct. VLOG(INFO), VLOG(WARNING), VLOG(ERROR), and + VLOG(FATAL) are not. Args: filename: The name of the current file. @@ -2835,12 +2903,32 @@ def CheckBegin(self, filename, clean_lines, linenum, error): linenum: The number of the line to check. error: The function to call with any errors found. """ - pass + line = clean_lines.elided[linenum] + if re.search(r"\bVLOG\((INFO|ERROR|WARNING|DFATAL|FATAL)\)", line): + error( + filename, + linenum, + "runtime/vlog", + 5, + "VLOG() should be used with numeric verbosity level. " + "Use LOG() if you want symbolic severity levels.", + ) + + +# Matches invalid increment: *count++, which moves pointer instead of +# incrementing a value. +_RE_PATTERN_INVALID_INCREMENT = re.compile(r"^\s*\*\w+(\+\+|--);") - def CheckEnd(self, filename, clean_lines, linenum, error): - """Run checks that applies to text after the closing brace. - This is mostly used for checking end of namespace comments. +def CheckInvalidIncrement(filename, clean_lines, linenum, error): + """Checks for invalid increment *count++. + + For example following function: + void increment_counter(int* count) { + *count++; + } + is invalid, because it effectively does count++, moving pointer, and should + be replaced with ++*count, (*count)++ or *count += 1. Args: filename: The name of the current file. @@ -2848,348 +2936,855 @@ def CheckEnd(self, filename, clean_lines, linenum, error): linenum: The number of the line to check. error: The function to call with any errors found. """ - pass + line = clean_lines.elided[linenum] + if _RE_PATTERN_INVALID_INCREMENT.match(line): + error( + filename, + linenum, + "runtime/invalid_increment", + 5, + "Changing pointer instead of value (or unused value of operator*).", + ) - def IsBlockInfo(self): - """Returns true if this block is a _BlockInfo. - This is convenient for verifying that an object is an instance of - a _BlockInfo, but not an instance of any of the derived classes. +def IsMacroDefinition(clean_lines, linenum): + if re.search(r"^#define", clean_lines[linenum]): + return True - Returns: - True for this class, False for derived classes. - """ - return self.__class__ == _BlockInfo + return bool(linenum > 0 and re.search(r"\\$", clean_lines[linenum - 1])) -class _ExternCInfo(_BlockInfo): - """Stores information about an 'extern "C"' block.""" +def IsForwardClassDeclaration(clean_lines, linenum): + return re.match(r"^\s*(\btemplate\b)*.*class\s+\w+;\s*$", clean_lines[linenum]) - def __init__(self, linenum): - _BlockInfo.__init__(self, linenum, True) +class _BlockInfo: + """Stores information about a generic block of code.""" -class _ClassInfo(_BlockInfo): - """Stores information about a class.""" - - def __init__(self, name, class_or_struct, clean_lines, linenum): - _BlockInfo.__init__(self, linenum, False) - self.name = name - self.is_derived = False - self.check_namespace_indentation = True - if class_or_struct == 'struct': - self.access = 'public' - self.is_struct = True - else: - self.access = 'private' - self.is_struct = False + def __init__(self, linenum, seen_open_brace): + self.starting_linenum = linenum + self.seen_open_brace = seen_open_brace + self.open_parentheses = 0 + self.inline_asm = _NO_ASM + self.check_namespace_indentation = False - # Remember initial indentation level for this class. Using raw_lines here - # instead of elided to account for leading comments. - self.class_indent = GetIndentLevel(clean_lines.raw_lines[linenum]) + def CheckBegin(self, filename, clean_lines, linenum, error): + """Run checks that applies to text up to the opening brace. - # Try to find the end of the class. This will be confused by things like: - # class A { - # } *x = { ... - # - # But it's still good enough for CheckSectionSpacing. - self.last_line = 0 - depth = 0 - for i in range(linenum, clean_lines.NumLines()): - line = clean_lines.elided[i] - depth += line.count('{') - line.count('}') - if not depth: - self.last_line = i - break - - def CheckBegin(self, filename, clean_lines, linenum, error): - # Look for a bare ':' - if re.search('(^|[^:]):($|[^:])', clean_lines.elided[linenum]): - self.is_derived = True - - def CheckEnd(self, filename, clean_lines, linenum, error): - # If there is a DISALLOW macro, it should appear near the end of - # the class. - seen_last_thing_in_class = False - for i in range(linenum - 1, self.starting_linenum, -1): - match = re.search( - r'\b(DISALLOW_COPY_AND_ASSIGN|DISALLOW_IMPLICIT_CONSTRUCTORS)\(' + - self.name + r'\)', - clean_lines.elided[i]) - if match: - if seen_last_thing_in_class: - error(filename, i, 'readability/constructors', 3, - match.group(1) + ' should be the last thing in the class') - break - - if not re.match(r'^\s*$', clean_lines.elided[i]): - seen_last_thing_in_class = True - - # Check that closing brace is aligned with beginning of the class. - # Only do this if the closing brace is indented by only whitespaces. - # This means we will not check single-line class definitions. - indent = re.match(r'^( *)\}', clean_lines.elided[linenum]) - if indent and len(indent.group(1)) != self.class_indent: - if self.is_struct: - parent = 'struct ' + self.name - else: - parent = 'class ' + self.name - error(filename, linenum, 'whitespace/indent', 3, - f'Closing brace should be aligned with beginning of {parent}') + This is mostly for checking the text after the class identifier + and the "{", usually where the base class is specified. For other + blocks, there isn't much to check, so we always pass. + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + pass -class _NamespaceInfo(_BlockInfo): - """Stores information about a namespace.""" + def CheckEnd(self, filename, clean_lines, linenum, error): + """Run checks that applies to text after the closing brace. - def __init__(self, name, linenum): - _BlockInfo.__init__(self, linenum, False) - self.name = name or '' - self.check_namespace_indentation = True + This is mostly used for checking end of namespace comments. - def CheckEnd(self, filename, clean_lines, linenum, error): - """Check end of namespace comments.""" - line = clean_lines.raw_lines[linenum] + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + pass - # 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(unknown): 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 ." 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 - if re.match(r'^\s*}.*\b(namespace anonymous|anonymous namespace)\b', line): - error(filename, linenum, 'readability/namespace', 5, - 'Anonymous namespace should be terminated with "// namespace"' - ' or "// anonymous namespace"') - else: - error(filename, linenum, 'readability/namespace', 5, - 'Anonymous namespace should be terminated with "// namespace"') + def IsBlockInfo(self): + """Returns true if this block is a _BlockInfo. + This is convenient for verifying that an object is an instance of + a _BlockInfo, but not an instance of any of the derived classes. -class _PreprocessorInfo(object): - """Stores checkpoints of nesting stacks when #if/#else is seen.""" + Returns: + True for this class, False for derived classes. + """ + return self.__class__ == _BlockInfo - def __init__(self, stack_before_if): - # The entire nesting stack before #if - self.stack_before_if = stack_before_if - # The entire nesting stack up to #else - self.stack_before_else = [] +class _ExternCInfo(_BlockInfo): + """Stores information about an 'extern "C"' block.""" - # Whether we have already seen #else or #elif - self.seen_else = False + def __init__(self, linenum): + _BlockInfo.__init__(self, linenum, True) -class NestingState(object): - """Holds states related to parsing braces.""" +class _ClassInfo(_BlockInfo): + """Stores information about a class.""" + + def __init__(self, name, class_or_struct, clean_lines, linenum): + _BlockInfo.__init__(self, linenum, False) + self.name = name + self.is_derived = False + self.check_namespace_indentation = True + if class_or_struct == "struct": + self.access = "public" + self.is_struct = True + else: + self.access = "private" + self.is_struct = False - def __init__(self): - # Stack for tracking all braces. An object is pushed whenever we - # see a "{", and popped when we see a "}". Only 3 types of - # objects are possible: - # - _ClassInfo: a class or struct. - # - _NamespaceInfo: a namespace. - # - _BlockInfo: some other type of block. - self.stack = [] + # Remember initial indentation level for this class. Using raw_lines here + # instead of elided to account for leading comments. + self.class_indent = GetIndentLevel(clean_lines.raw_lines[linenum]) - # Top of the previous stack before each Update(). - # - # Because the nesting_stack is updated at the end of each line, we - # had to do some convoluted checks to find out what is the current - # scope at the beginning of the line. This check is simplified by - # saving the previous top of nesting stack. - # - # We could save the full stack, but we only need the top. Copying - # the full nesting stack would slow down cpplint by ~10%. - self.previous_stack_top = [] + # Try to find the end of the class. This will be confused by things like: + # class A { + # } *x = { ... + # + # But it's still good enough for CheckSectionSpacing. + self.last_line = 0 + depth = 0 + for i in range(linenum, clean_lines.NumLines()): + line = clean_lines.elided[i] + depth += line.count("{") - line.count("}") + if not depth: + self.last_line = i + break + + def CheckBegin(self, filename, clean_lines, linenum, error): + # Look for a bare ':' + if re.search("(^|[^:]):($|[^:])", clean_lines.elided[linenum]): + self.is_derived = True + + def CheckEnd(self, filename, clean_lines, linenum, error): + # If there is a DISALLOW macro, it should appear near the end of + # the class. + seen_last_thing_in_class = False + for i in range(linenum - 1, self.starting_linenum, -1): + match = re.search( + r"\b(DISALLOW_COPY_AND_ASSIGN|DISALLOW_IMPLICIT_CONSTRUCTORS)\(" + + self.name + + r"\)", + clean_lines.elided[i], + ) + if match: + if seen_last_thing_in_class: + error( + filename, + i, + "readability/constructors", + 3, + match.group(1) + " should be the last thing in the class", + ) + break + + if not re.match(r"^\s*$", clean_lines.elided[i]): + seen_last_thing_in_class = True + + # Check that closing brace is aligned with beginning of the class. + # Only do this if the closing brace is indented by only whitespaces. + # This means we will not check single-line class definitions. + indent = re.match(r"^( *)\}", clean_lines.elided[linenum]) + if indent and len(indent.group(1)) != self.class_indent: + if self.is_struct: + parent = "struct " + self.name + else: + parent = "class " + self.name + error( + filename, + linenum, + "whitespace/indent", + 3, + f"Closing brace should be aligned with beginning of {parent}", + ) - # Stack of _PreprocessorInfo objects. - self.pp_stack = [] - def SeenOpenBrace(self): - """Check if we have seen the opening brace for the innermost block. +class _NamespaceInfo(_BlockInfo): + """Stores information about a namespace.""" - Returns: - True if we have seen the opening brace, False if the innermost - block is still expecting an opening brace. - """ - return (not self.stack) or self.stack[-1].seen_open_brace + def __init__(self, name, linenum): + _BlockInfo.__init__(self, linenum, False) + self.name = name or "" + self.check_namespace_indentation = True - def InNamespaceBody(self): - """Check if we are currently one level inside a namespace body. + def CheckEnd(self, filename, clean_lines, linenum, error): + """Check end of namespace comments.""" + line = clean_lines.raw_lines[linenum] - Returns: - True if top of the stack is a namespace block, False otherwise. - """ - return self.stack and isinstance(self.stack[-1], _NamespaceInfo) + # 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 ." 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 + if re.match(r"^\s*}.*\b(namespace anonymous|anonymous namespace)\b", line): + error( + filename, + linenum, + "readability/namespace", + 5, + 'Anonymous namespace should be terminated with "// namespace"' + ' or "// anonymous namespace"', + ) + else: + error( + filename, + linenum, + "readability/namespace", + 5, + 'Anonymous namespace should be terminated with "// namespace"', + ) + + +class _PreprocessorInfo: + """Stores checkpoints of nesting stacks when #if/#else is seen.""" + + def __init__(self, stack_before_if): + # The entire nesting stack before #if + self.stack_before_if = stack_before_if + + # The entire nesting stack up to #else + self.stack_before_else = [] + + # Whether we have already seen #else or #elif + self.seen_else = False + + +class NestingState: + """Holds states related to parsing braces.""" + + def __init__(self): + # Stack for tracking all braces. An object is pushed whenever we + # see a "{", and popped when we see a "}". Only 3 types of + # objects are possible: + # - _ClassInfo: a class or struct. + # - _NamespaceInfo: a namespace. + # - _BlockInfo: some other type of block. + self.stack = [] + + # Top of the previous stack before each Update(). + # + # Because the nesting_stack is updated at the end of each line, we + # had to do some convoluted checks to find out what is the current + # scope at the beginning of the line. This check is simplified by + # saving the previous top of nesting stack. + # + # We could save the full stack, but we only need the top. Copying + # the full nesting stack would slow down cpplint by ~10%. + self.previous_stack_top = [] + + # The number of open parentheses in the previous stack top before the last update. + # Used to prevent false indentation detection when e.g. a function parameter is indented. + # We can't use previous_stack_top, a shallow copy whose open_parentheses value is updated. + self.previous_open_parentheses = 0 + + # Stack of _PreprocessorInfo objects. + self.pp_stack = [] + + def SeenOpenBrace(self): + """Check if we have seen the opening brace for the innermost block. + + Returns: + True if we have seen the opening brace, False if the innermost + block is still expecting an opening brace. + """ + return (not self.stack) or self.stack[-1].seen_open_brace + + def InNamespaceBody(self): + """Check if we are currently one level inside a namespace body. + + Returns: + True if top of the stack is a namespace block, False otherwise. + """ + return self.stack and isinstance(self.stack[-1], _NamespaceInfo) + + def InExternC(self): + """Check if we are currently one level inside an 'extern "C"' block. + + Returns: + True if top of the stack is an extern block, False otherwise. + """ + return self.stack and isinstance(self.stack[-1], _ExternCInfo) + + def InClassDeclaration(self): + """Check if we are currently one level inside a class or struct declaration. + + Returns: + True if top of the stack is a class/struct, False otherwise. + """ + return self.stack and isinstance(self.stack[-1], _ClassInfo) + + def InAsmBlock(self): + """Check if we are currently one level inside an inline ASM block. + + Returns: + True if the top of the stack is a block containing inline ASM. + """ + return self.stack and self.stack[-1].inline_asm != _NO_ASM + + def InTemplateArgumentList(self, clean_lines, linenum, pos): + """Check if current position is inside template argument list. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + pos: position just after the suspected template argument. + Returns: + True if (linenum, pos) is inside template arguments. + """ + while linenum < clean_lines.NumLines(): + # Find the earliest character that might indicate a template argument + line = clean_lines.elided[linenum] + match = re.match(r"^[^{};=\[\]\.<>]*(.)", line[pos:]) + if not match: + linenum += 1 + pos = 0 + continue + token = match.group(1) + pos += len(match.group(0)) + + # These things do not look like template argument list: + # class Suspect { + # class Suspect x; } + if token in ("{", "}", ";"): + return False - def InExternC(self): - """Check if we are currently one level inside an 'extern "C"' block. + # These things look like template argument list: + # template + # template + # template + # template + if token in (">", "=", "[", "]", "."): + return True + + # Check if token is an unmatched '<'. + # If not, move on to the next character. + if token != "<": + pos += 1 + if pos >= len(line): + linenum += 1 + pos = 0 + continue + + # We can't be sure if we just find a single '<', and need to + # find the matching '>'. + (_, end_line, end_pos) = CloseExpression(clean_lines, linenum, pos - 1) + if end_pos < 0: + # Not sure if template argument list or syntax error in file + return False + linenum = end_line + pos = end_pos + return False - Returns: - True if top of the stack is an extern block, False otherwise. - """ - return self.stack and isinstance(self.stack[-1], _ExternCInfo) + def UpdatePreprocessor(self, line): + """Update preprocessor stack. + + We need to handle preprocessors due to classes like this: + #ifdef SWIG + struct ResultDetailsPageElementExtensionPoint { + #else + struct ResultDetailsPageElementExtensionPoint : public Extension { + #endif + + We make the following assumptions (good enough for most files): + - Preprocessor condition evaluates to true from #if up to first + #else/#elif/#endif. + + - Preprocessor condition evaluates to false from #else/#elif up + to #endif. We still perform lint checks on these lines, but + these do not affect nesting stack. + + Args: + line: current line to check. + """ + if re.match(r"^\s*#\s*(if|ifdef|ifndef)\b", line): + # Beginning of #if block, save the nesting stack here. The saved + # stack will allow us to restore the parsing state in the #else case. + self.pp_stack.append(_PreprocessorInfo(copy.deepcopy(self.stack))) + elif re.match(r"^\s*#\s*(else|elif)\b", line): + # Beginning of #else block + if self.pp_stack: + if not self.pp_stack[-1].seen_else: + # This is the first #else or #elif block. Remember the + # whole nesting stack up to this point. This is what we + # keep after the #endif. + self.pp_stack[-1].seen_else = True + self.pp_stack[-1].stack_before_else = copy.deepcopy(self.stack) + + # Restore the stack to how it was before the #if + self.stack = copy.deepcopy(self.pp_stack[-1].stack_before_if) + else: + # TODO(google): unexpected #else, issue warning? + pass + elif re.match(r"^\s*#\s*endif\b", line): + # End of #if or #else blocks. + if self.pp_stack: + # If we saw an #else, we will need to restore the nesting + # stack to its former state before the #else, otherwise we + # will just continue from where we left off. + if self.pp_stack[-1].seen_else: + # Here we can just use a shallow copy since we are the last + # reference to it. + self.stack = self.pp_stack[-1].stack_before_else + # Drop the corresponding #if + self.pp_stack.pop() + else: + # TODO(google): unexpected #endif, issue warning? + pass + + # TODO(google): Update() is too long, but we will refactor later. + def Update(self, filename, clean_lines, linenum, error): + """Update nesting state with current line. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Remember top of the previous nesting stack. + # + # The stack is always pushed/popped and not modified in place, so + # we can just do a shallow copy instead of copy.deepcopy. Using + # deepcopy would slow down cpplint by ~28%. + if self.stack: + self.previous_stack_top = self.stack[-1] + self.previous_open_parentheses = self.stack[-1].open_parentheses + else: + self.previous_stack_top = None - def InClassDeclaration(self): - """Check if we are currently one level inside a class or struct declaration. + # Update pp_stack + self.UpdatePreprocessor(line) - Returns: - True if top of the stack is a class/struct, False otherwise. - """ - return self.stack and isinstance(self.stack[-1], _ClassInfo) + # Count parentheses. This is to avoid adding struct arguments to + # the nesting stack. + if self.stack: + inner_block = self.stack[-1] + depth_change = line.count("(") - line.count(")") + inner_block.open_parentheses += depth_change + + # Also check if we are starting or ending an inline assembly block. + if inner_block.inline_asm in (_NO_ASM, _END_ASM): + if ( + depth_change != 0 + and inner_block.open_parentheses == 1 + and _MATCH_ASM.match(line) + ): + # Enter assembly block + inner_block.inline_asm = _INSIDE_ASM + else: + # Not entering assembly block. If previous line was _END_ASM, + # we will now shift to _NO_ASM state. + inner_block.inline_asm = _NO_ASM + elif inner_block.inline_asm == _INSIDE_ASM and inner_block.open_parentheses == 0: + # Exit assembly block + inner_block.inline_asm = _END_ASM + + # Consume namespace declaration at the beginning of the line. Do + # this in a loop so that we catch same line declarations like this: + # namespace proto2 { namespace bridge { class MessageSet; } } + while True: + # Match start of namespace. The "\b\s*" below catches namespace + # declarations even if it weren't followed by a whitespace, this + # is so that we don't confuse our namespace checker. The + # missing spaces will be flagged by CheckSpacing. + namespace_decl_match = re.match(r"^\s*namespace\b\s*([:\w]+)?(.*)$", line) + if not namespace_decl_match: + break + + new_namespace = _NamespaceInfo(namespace_decl_match.group(1), linenum) + self.stack.append(new_namespace) + + line = namespace_decl_match.group(2) + if line.find("{") != -1: + new_namespace.seen_open_brace = True + line = line[line.find("{") + 1 :] + + # Look for a class declaration in whatever is left of the line + # after parsing namespaces. The regexp accounts for decorated classes + # such as in: + # class LOCKABLE API Object { + # }; + class_decl_match = re.match( + r"^(\s*(?:template\s*<[\w\s<>,:=]*>\s*)?" + r"(class|struct)\s+(?:[a-zA-Z0-9_]+\s+)*(\w+(?:::\w+)*))" + r"(.*)$", + line, + ) + if class_decl_match and (not self.stack or self.stack[-1].open_parentheses == 0): + # We do not want to accept classes that are actually template arguments: + # template , + # template class Ignore3> + # void Function() {}; + # + # To avoid template argument cases, we scan forward and look for + # an unmatched '>'. If we see one, assume we are inside a + # template argument list. + end_declaration = len(class_decl_match.group(1)) + if not self.InTemplateArgumentList(clean_lines, linenum, end_declaration): + self.stack.append( + _ClassInfo( + class_decl_match.group(3), class_decl_match.group(2), clean_lines, linenum + ) + ) + line = class_decl_match.group(4) + + # If we have not yet seen the opening brace for the innermost block, + # run checks here. + if not self.SeenOpenBrace(): + self.stack[-1].CheckBegin(filename, clean_lines, linenum, error) + + # Update access control if we are inside a class/struct + if self.stack and isinstance(self.stack[-1], _ClassInfo): + classinfo = self.stack[-1] + access_match = re.match( + r"^(.*)\b(public|private|protected|signals)(\s+(?:slots\s*)?)?" + r":(?:[^:]|$)", + line, + ) + if access_match: + classinfo.access = access_match.group(2) + + # Check that access keywords are indented +1 space. Skip this + # check if the keywords are not preceded by whitespaces. + indent = access_match.group(1) + if len(indent) != classinfo.class_indent + 1 and re.match(r"^\s*$", indent): + if classinfo.is_struct: + parent = "struct " + classinfo.name + else: + parent = "class " + classinfo.name + slots = "" + if access_match.group(3): + slots = access_match.group(3) + error( + filename, + linenum, + "whitespace/indent", + 3, + f"{access_match.group(2)}{slots}:" + f" should be indented +1 space inside {parent}", + ) + + # Consume braces or semicolons from what's left of the line + while True: + # Match first brace, semicolon, or closed parenthesis. + matched = re.match(r"^[^{;)}]*([{;)}])(.*)$", line) + if not matched: + break + + token = matched.group(1) + if token == "{": + # If namespace or class hasn't seen a opening brace yet, mark + # namespace/class head as complete. Push a new block onto the + # stack otherwise. + if not self.SeenOpenBrace(): + self.stack[-1].seen_open_brace = True + elif re.match(r'^extern\s*"[^"]*"\s*\{', line): + self.stack.append(_ExternCInfo(linenum)) + else: + self.stack.append(_BlockInfo(linenum, True)) + if _MATCH_ASM.match(line): + self.stack[-1].inline_asm = _BLOCK_ASM + + elif token in {";", ")"}: + # If we haven't seen an opening brace yet, but we already saw + # a semicolon, this is probably a forward declaration. Pop + # the stack for these. + # + # Similarly, if we haven't seen an opening brace yet, but we + # already saw a closing parenthesis, then these are probably + # function arguments with extra "class" or "struct" keywords. + # Also pop these stack for these. + if not self.SeenOpenBrace(): + self.stack.pop() + else: # token == '}' + # Perform end of block checks and pop the stack. + if self.stack: + self.stack[-1].CheckEnd(filename, clean_lines, linenum, error) + self.stack.pop() + line = matched.group(2) + + def InnermostClass(self): + """Get class info on the top of the stack. + + Returns: + A _ClassInfo object if we are inside a class, or None otherwise. + """ + for i in range(len(self.stack), 0, -1): + classinfo = self.stack[i - 1] + if isinstance(classinfo, _ClassInfo): + return classinfo + return None - def InAsmBlock(self): - """Check if we are currently one level inside an inline ASM block. - Returns: - True if the top of the stack is a block containing inline ASM. - """ - return self.stack and self.stack[-1].inline_asm != _NO_ASM +def CheckForNonStandardConstructs(filename, clean_lines, linenum, nesting_state, error): + r"""Logs an error if we see certain non-ANSI constructs ignored by gcc-2. - def InTemplateArgumentList(self, clean_lines, linenum, pos): - """Check if current position is inside template argument list. + Complain about several constructs which gcc-2 accepts, but which are + not standard C++. Warning about these in lint is one way to ease the + transition to new compilers. + - put storage class first (e.g. "static const" instead of "const static"). + - "%lld" instead of %qd" in printf-type functions. + - "%1$d" is non-standard in printf-type functions. + - "\%" is an undefined character escape sequence. + - text after #endif is not allowed. + - invalid inner-style forward declaration. + - >? and ?= and ]*(.)', line[pos:]) - if not match: - linenum += 1 - pos = 0 - continue - token = match.group(1) - pos += len(match.group(0)) - - # These things do not look like template argument list: - # class Suspect { - # class Suspect x; } - if token in ('{', '}', ';'): return False - - # These things look like template argument list: - # template - # template - # template - # template - if token in ('>', '=', '[', ']', '.'): return True - - # Check if token is an unmatched '<'. - # If not, move on to the next character. - if token != '<': - pos += 1 - if pos >= len(line): - linenum += 1 - pos = 0 - continue - - # We can't be sure if we just find a single '<', and need to - # find the matching '>'. - (_, end_line, end_pos) = CloseExpression(clean_lines, linenum, pos - 1) - if end_pos < 0: - # Not sure if template argument list or syntax error in file - return False - linenum = end_line - pos = end_pos - return False - def UpdatePreprocessor(self, line): - """Update preprocessor stack. + # Remove comments from the line, but leave in strings for now. + line = clean_lines.lines[linenum] + + if re.search(r'printf\s*\(.*".*%[-+ ]?\d*q', line): + error( + filename, + linenum, + "runtime/printf_format", + 3, + "%q in format strings is deprecated. Use %ll instead.", + ) + + if re.search(r'printf\s*\(.*".*%\d+\$', line): + error( + filename, + linenum, + "runtime/printf_format", + 2, + "%N$ formats are unconventional. Try rewriting to avoid them.", + ) + + # Remove escaped backslashes before looking for undefined escapes. + line = line.replace("\\\\", "") + + if re.search(r'("|\').*\\(%|\[|\(|{)', line): + error( + filename, + linenum, + "build/printf_format", + 3, + "%, [, (, and { are undefined character escapes. Unescape them.", + ) + + # For the rest, work with both comments and strings removed. + line = clean_lines.elided[linenum] + + if re.search( + r"\b(const|volatile|void|char|short|int|long" + r"|float|double|signed|unsigned" + r"|schar|u?int8_t|u?int16_t|u?int32_t|u?int64_t)" + r"\s+(register|static|extern|typedef)\b", + line, + ): + error( + filename, + linenum, + "build/storage_class", + 5, + "Storage-class specifier (static, extern, typedef, etc) should be " + "at the beginning of the declaration.", + ) + + if re.match(r"\s*#\s*endif\s*[^/\s]+", line): + error( + filename, + linenum, + "build/endif_comment", + 5, + "Uncommented text after #endif is non-standard. Use a comment.", + ) + + if re.match(r"\s*class\s+(\w+\s*::\s*)+\w+\s*;", line): + error( + filename, + linenum, + "build/forward_decl", + 5, + "Inner-style forward declarations are invalid. Remove this line.", + ) + + if re.search(r"(\w+|[+-]?\d+(\.\d*)?)\s*(<|>)\?=?\s*(\w+|[+-]?\d+)(\.\d*)?", line): + error( + filename, + linenum, + "build/deprecated", + 3, + ">? and ))?' + # r'\s*const\s*' + type_name + '\s*&\s*\w+\s*;' + error( + filename, + linenum, + "runtime/member_string_references", + 2, + "const string& members are dangerous. It is much better to use " + "alternatives, such as pointers or simple constants.", + ) + + # Everything else in this function operates on class declarations. + # Return early if the top of the nesting stack is not a class, or if + # the class head is not completed yet. + classinfo = nesting_state.InnermostClass() + if not classinfo or not classinfo.seen_open_brace: + return - We need to handle preprocessors due to classes like this: - #ifdef SWIG - struct ResultDetailsPageElementExtensionPoint { - #else - struct ResultDetailsPageElementExtensionPoint : public Extension { - #endif + # The class may have been declared with namespace or classname qualifiers. + # The constructor and destructor will not have those qualifiers. + base_classname = classinfo.name.split("::")[-1] + + # Look for single-argument constructors that aren't marked explicit. + # Technically a valid construct, but against style. + explicit_constructor_match = re.match( + r"\s+(?:(?:inline|constexpr)\s+)*(explicit\s+)?" + rf"(?:(?:inline|constexpr)\s+)*{re.escape(base_classname)}\s*" + r"\(((?:[^()]|\([^()]*\))*)\)", + line, + ) - We make the following assumptions (good enough for most files): - - Preprocessor condition evaluates to true from #if up to first - #else/#elif/#endif. + if explicit_constructor_match: + is_marked_explicit = explicit_constructor_match.group(1) - - Preprocessor condition evaluates to false from #else/#elif up - to #endif. We still perform lint checks on these lines, but - these do not affect nesting stack. + if not explicit_constructor_match.group(2): + constructor_args = [] + else: + constructor_args = explicit_constructor_match.group(2).split(",") + + # collapse arguments so that commas in template parameter lists and function + # argument parameter lists don't split arguments in two + i = 0 + while i < len(constructor_args): + constructor_arg = constructor_args[i] + while constructor_arg.count("<") > constructor_arg.count(">") or constructor_arg.count( + "(" + ) > constructor_arg.count(")"): + constructor_arg += "," + constructor_args[i + 1] + del constructor_args[i + 1] + constructor_args[i] = constructor_arg + i += 1 + + variadic_args = [arg for arg in constructor_args if "&&..." in arg] + defaulted_args = [arg for arg in constructor_args if "=" in arg] + noarg_constructor = ( + not constructor_args # empty arg list + or + # 'void' arg specifier + (len(constructor_args) == 1 and constructor_args[0].strip() == "void") + ) + onearg_constructor = ( + ( + len(constructor_args) == 1 # exactly one arg + and not noarg_constructor + ) + or + # all but at most one arg defaulted + ( + len(constructor_args) >= 1 + and not noarg_constructor + and len(defaulted_args) >= len(constructor_args) - 1 + ) + or + # variadic arguments with zero or one argument + (len(constructor_args) <= 2 and len(variadic_args) >= 1) + ) + initializer_list_constructor = bool( + onearg_constructor + and re.search(r"\bstd\s*::\s*initializer_list\b", constructor_args[0]) + ) + copy_constructor = bool( + onearg_constructor + and re.match( + r"((const\s+(volatile\s+)?)?|(volatile\s+(const\s+)?))?" + rf"{re.escape(base_classname)}(\s*<[^>]*>)?(\s+const)?\s*(?:<\w+>\s*)?&", + constructor_args[0].strip(), + ) + ) + + if ( + not is_marked_explicit + and onearg_constructor + and not initializer_list_constructor + and not copy_constructor + ): + if defaulted_args or variadic_args: + error( + filename, + linenum, + "runtime/explicit", + 4, + "Constructors callable with one argument should be marked explicit.", + ) + else: + error( + filename, + linenum, + "runtime/explicit", + 4, + "Single-parameter constructors should be marked explicit.", + ) - Args: - line: current line to check. - """ - if re.match(r'^\s*#\s*(if|ifdef|ifndef)\b', line): - # Beginning of #if block, save the nesting stack here. The saved - # stack will allow us to restore the parsing state in the #else case. - self.pp_stack.append(_PreprocessorInfo(copy.deepcopy(self.stack))) - elif re.match(r'^\s*#\s*(else|elif)\b', line): - # Beginning of #else block - if self.pp_stack: - if not self.pp_stack[-1].seen_else: - # This is the first #else or #elif block. Remember the - # whole nesting stack up to this point. This is what we - # keep after the #endif. - self.pp_stack[-1].seen_else = True - self.pp_stack[-1].stack_before_else = copy.deepcopy(self.stack) - - # Restore the stack to how it was before the #if - self.stack = copy.deepcopy(self.pp_stack[-1].stack_before_if) - else: - # TODO(unknown): unexpected #else, issue warning? - pass - elif re.match(r'^\s*#\s*endif\b', line): - # End of #if or #else blocks. - if self.pp_stack: - # If we saw an #else, we will need to restore the nesting - # stack to its former state before the #else, otherwise we - # will just continue from where we left off. - if self.pp_stack[-1].seen_else: - # Here we can just use a shallow copy since we are the last - # reference to it. - self.stack = self.pp_stack[-1].stack_before_else - # Drop the corresponding #if - self.pp_stack.pop() - else: - # TODO(unknown): unexpected #endif, issue warning? - pass - # TODO(unknown): Update() is too long, but we will refactor later. - def Update(self, filename, clean_lines, linenum, error): - """Update nesting state with current line. +def CheckSpacingForFunctionCall(filename, clean_lines, linenum, error): + """Checks for the correctness of various spacing around function calls. Args: filename: The name of the current file. @@ -3199,3775 +3794,3977 @@ def Update(self, filename, clean_lines, linenum, error): """ line = clean_lines.elided[linenum] - # Remember top of the previous nesting stack. - # - # The stack is always pushed/popped and not modified in place, so - # we can just do a shallow copy instead of copy.deepcopy. Using - # deepcopy would slow down cpplint by ~28%. - if self.stack: - self.previous_stack_top = self.stack[-1] - else: - self.previous_stack_top = None - - # Update pp_stack - self.UpdatePreprocessor(line) - - # Count parentheses. This is to avoid adding struct arguments to - # the nesting stack. - if self.stack: - inner_block = self.stack[-1] - depth_change = line.count('(') - line.count(')') - inner_block.open_parentheses += depth_change - - # Also check if we are starting or ending an inline assembly block. - if inner_block.inline_asm in (_NO_ASM, _END_ASM): - if (depth_change != 0 and - inner_block.open_parentheses == 1 and - _MATCH_ASM.match(line)): - # Enter assembly block - inner_block.inline_asm = _INSIDE_ASM - else: - # Not entering assembly block. If previous line was _END_ASM, - # we will now shift to _NO_ASM state. - inner_block.inline_asm = _NO_ASM - elif (inner_block.inline_asm == _INSIDE_ASM and - inner_block.open_parentheses == 0): - # Exit assembly block - inner_block.inline_asm = _END_ASM - - # Consume namespace declaration at the beginning of the line. Do - # this in a loop so that we catch same line declarations like this: - # namespace proto2 { namespace bridge { class MessageSet; } } - while True: - # Match start of namespace. The "\b\s*" below catches namespace - # declarations even if it weren't followed by a whitespace, this - # is so that we don't confuse our namespace checker. The - # missing spaces will be flagged by CheckSpacing. - namespace_decl_match = re.match(r'^\s*namespace\b\s*([:\w]+)?(.*)$', line) - if not namespace_decl_match: - break - - new_namespace = _NamespaceInfo(namespace_decl_match.group(1), linenum) - self.stack.append(new_namespace) - - line = namespace_decl_match.group(2) - if line.find('{') != -1: - new_namespace.seen_open_brace = True - line = line[line.find('{') + 1:] - - # Look for a class declaration in whatever is left of the line - # after parsing namespaces. The regexp accounts for decorated classes - # such as in: - # class LOCKABLE API Object { - # }; - class_decl_match = re.match( - r'^(\s*(?:template\s*<[\w\s<>,:=]*>\s*)?' - r'(class|struct)\s+(?:[a-zA-Z0-9_]+\s+)*(\w+(?:::\w+)*))' - r'(.*)$', line) - if (class_decl_match and - (not self.stack or self.stack[-1].open_parentheses == 0)): - # We do not want to accept classes that are actually template arguments: - # template , - # template class Ignore3> - # void Function() {}; - # - # To avoid template argument cases, we scan forward and look for - # an unmatched '>'. If we see one, assume we are inside a - # template argument list. - end_declaration = len(class_decl_match.group(1)) - if not self.InTemplateArgumentList(clean_lines, linenum, end_declaration): - self.stack.append(_ClassInfo( - class_decl_match.group(3), class_decl_match.group(2), - clean_lines, linenum)) - line = class_decl_match.group(4) - - # If we have not yet seen the opening brace for the innermost block, - # run checks here. - if not self.SeenOpenBrace(): - self.stack[-1].CheckBegin(filename, clean_lines, linenum, error) - - # Update access control if we are inside a class/struct - if self.stack and isinstance(self.stack[-1], _ClassInfo): - classinfo = self.stack[-1] - access_match = re.match( - r'^(.*)\b(public|private|protected|signals)(\s+(?:slots\s*)?)?' - r':(?:[^:]|$)', - line) - if access_match: - classinfo.access = access_match.group(2) - - # Check that access keywords are indented +1 space. Skip this - # check if the keywords are not preceded by whitespaces. - indent = access_match.group(1) - if (len(indent) != classinfo.class_indent + 1 and - re.match(r'^\s*$', indent)): - if classinfo.is_struct: - parent = 'struct ' + classinfo.name - else: - parent = 'class ' + classinfo.name - slots = '' - if access_match.group(3): - slots = access_match.group(3) - error(filename, linenum, 'whitespace/indent', 3, - f'{access_match.group(2)}{slots}:' - f' should be indented +1 space inside {parent}') - - # Consume braces or semicolons from what's left of the line - while True: - # Match first brace, semicolon, or closed parenthesis. - matched = re.match(r'^[^{;)}]*([{;)}])(.*)$', line) - if not matched: - break - - token = matched.group(1) - if token == '{': - # If namespace or class hasn't seen a opening brace yet, mark - # namespace/class head as complete. Push a new block onto the - # stack otherwise. - if not self.SeenOpenBrace(): - self.stack[-1].seen_open_brace = True - elif re.match(r'^extern\s*"[^"]*"\s*\{', line): - self.stack.append(_ExternCInfo(linenum)) - else: - self.stack.append(_BlockInfo(linenum, True)) - if _MATCH_ASM.match(line): - self.stack[-1].inline_asm = _BLOCK_ASM - - elif token == ';' or token == ')': - # If we haven't seen an opening brace yet, but we already saw - # a semicolon, this is probably a forward declaration. Pop - # the stack for these. - # - # Similarly, if we haven't seen an opening brace yet, but we - # already saw a closing parenthesis, then these are probably - # function arguments with extra "class" or "struct" keywords. - # Also pop these stack for these. - if not self.SeenOpenBrace(): - self.stack.pop() - else: # token == '}' - # Perform end of block checks and pop the stack. - if self.stack: - self.stack[-1].CheckEnd(filename, clean_lines, linenum, error) - self.stack.pop() - line = matched.group(2) + # Since function calls often occur inside if/for/while/switch + # expressions - which have their own, more liberal conventions - we + # first see if we should be looking inside such an expression for a + # function call, to which we can apply more strict standards. + fncall = line # if there's no control flow construct, look at whole line + for pattern in ( + r"\bif\s*\((.*)\)\s*{", + r"\bfor\s*\((.*)\)\s*{", + r"\bwhile\s*\((.*)\)\s*[{;]", + r"\bswitch\s*\((.*)\)\s*{", + ): + match = re.search(pattern, line) + if match: + fncall = match.group(1) # look inside the parens for function calls + break + + # Except in if/for/while/switch, there should never be space + # immediately inside parens (eg "f( 3, 4 )"). We make an exception + # for nested parens ( (a+b) + c ). Likewise, there should never be + # a space before a ( when it's a function argument. I assume it's a + # function argument when the char before the whitespace is legal in + # a function name (alnum + _) and we're not starting a macro. Also ignore + # pointers and references to arrays and functions coz they're too tricky: + # we use a very simple way to recognize these: + # " (something)(maybe-something)" or + # " (something)(maybe-something," or + # " (something)[something]" + # Note that we assume the contents of [] to be short enough that + # they'll never need to wrap. + if ( # Ignore control structures. + not re.search(r"\b(if|elif|for|while|switch|return|new|delete|catch|sizeof)\b", fncall) + and + # Ignore pointers/references to functions. + not re.search(r" \([^)]+\)\([^)]*(\)|,$)", fncall) + and + # Ignore pointers/references to arrays. + not re.search(r" \([^)]+\)\[[^\]]+\]", fncall) + ): + if re.search(r"\w\s*\(\s(?!\s*\\$)", fncall): # a ( used for a fn call + error(filename, linenum, "whitespace/parens", 4, "Extra space after ( in function call") + elif re.search(r"\(\s+(?!(\s*\\)|\()", fncall): + error(filename, linenum, "whitespace/parens", 2, "Extra space after (") + if ( + re.search(r"\w\s+\(", fncall) + and not re.search(r"_{0,2}asm_{0,2}\s+_{0,2}volatile_{0,2}\s+\(", fncall) + and not re.search(r"#\s*define|typedef|using\s+\w+\s*=", fncall) + and not re.search(r"\w\s+\((\w+::)*\*\w+\)\(", fncall) + and not re.search(r"\bcase\s+\(", fncall) + ): + # TODO(google): Space after an operator function seem to be a common + # error, silence those for now by restricting them to highest verbosity. + if re.search(r"\boperator_*\b", line): + error( + filename, + linenum, + "whitespace/parens", + 0, + "Extra space before ( in function call", + ) + else: + error( + filename, + linenum, + "whitespace/parens", + 4, + "Extra space before ( in function call", + ) + # If the ) is followed only by a newline or a { + newline, assume it's + # part of a control statement (if/while/etc), and don't complain + if re.search(r"[^)]\s+\)\s*[^{\s]", fncall): + # If the closing parenthesis is preceded by only whitespaces, + # try to give a more descriptive error message. + if re.search(r"^\s+\)", fncall): + error( + filename, + linenum, + "whitespace/parens", + 2, + "Closing ) should be moved to the previous line", + ) + else: + error(filename, linenum, "whitespace/parens", 2, "Extra space before )") + + +def IsBlankLine(line): + """Returns true if the given line is blank. + + We consider a line to be blank if the line is empty or consists of + only white spaces. - def InnermostClass(self): - """Get class info on the top of the stack. + Args: + line: A line of a string. Returns: - A _ClassInfo object if we are inside a class, or None otherwise. + True, if the given line is blank. """ - for i in range(len(self.stack), 0, -1): - classinfo = self.stack[i - 1] - if isinstance(classinfo, _ClassInfo): - return classinfo - return None - -def CheckForNonStandardConstructs(filename, clean_lines, linenum, - nesting_state, error): - r"""Logs an error if we see certain non-ANSI constructs ignored by gcc-2. - - Complain about several constructs which gcc-2 accepts, but which are - not standard C++. Warning about these in lint is one way to ease the - transition to new compilers. - - put storage class first (e.g. "static const" instead of "const static"). - - "%lld" instead of %qd" in printf-type functions. - - "%1$d" is non-standard in printf-type functions. - - "\%" is an undefined character escape sequence. - - text after #endif is not allowed. - - invalid inner-style forward declaration. - - >? and ?= and )\?=?\s*(\w+|[+-]?\d+)(\.\d*)?', - line): - error(filename, linenum, 'build/deprecated', 3, - '>? and ))?' - # r'\s*const\s*' + type_name + '\s*&\s*\w+\s*;' - error(filename, linenum, 'runtime/member_string_references', 2, - 'const string& members are dangerous. It is much better to use ' - 'alternatives, such as pointers or simple constants.') - - # Everything else in this function operates on class declarations. - # Return early if the top of the nesting stack is not a class, or if - # the class head is not completed yet. - classinfo = nesting_state.InnermostClass() - if not classinfo or not classinfo.seen_open_brace: - return - - # The class may have been declared with namespace or classname qualifiers. - # The constructor and destructor will not have those qualifiers. - base_classname = classinfo.name.split('::')[-1] - - # Look for single-argument constructors that aren't marked explicit. - # Technically a valid construct, but against style. - explicit_constructor_match = re.match( - r'\s+(?:(?:inline|constexpr)\s+)*(explicit\s+)?' - rf'(?:(?:inline|constexpr)\s+)*{re.escape(base_classname)}\s*' - r'\(((?:[^()]|\([^()]*\))*)\)', line) - - if explicit_constructor_match: - is_marked_explicit = explicit_constructor_match.group(1) - - if not explicit_constructor_match.group(2): - constructor_args = [] - else: - constructor_args = explicit_constructor_match.group(2).split(',') - - # collapse arguments so that commas in template parameter lists and function - # argument parameter lists don't split arguments in two - i = 0 - while i < len(constructor_args): - constructor_arg = constructor_args[i] - while (constructor_arg.count('<') > constructor_arg.count('>') or - constructor_arg.count('(') > constructor_arg.count(')')): - constructor_arg += ',' + constructor_args[i + 1] - del constructor_args[i + 1] - constructor_args[i] = constructor_arg - i += 1 - - variadic_args = [arg for arg in constructor_args if '&&...' in arg] - defaulted_args = [arg for arg in constructor_args if '=' in arg] - noarg_constructor = (not constructor_args or # empty arg list - # 'void' arg specifier - (len(constructor_args) == 1 and - constructor_args[0].strip() == 'void')) - onearg_constructor = ((len(constructor_args) == 1 and # exactly one arg - not noarg_constructor) or - # all but at most one arg defaulted - (len(constructor_args) >= 1 and - not noarg_constructor and - len(defaulted_args) >= len(constructor_args) - 1) or - # variadic arguments with zero or one argument - (len(constructor_args) <= 2 and - len(variadic_args) >= 1)) - initializer_list_constructor = bool( - onearg_constructor and - re.search(r'\bstd\s*::\s*initializer_list\b', constructor_args[0])) - copy_constructor = bool( - onearg_constructor and - re.match(r'((const\s+(volatile\s+)?)?|(volatile\s+(const\s+)?))?' - rf'{re.escape(base_classname)}(\s*<[^>]*>)?(\s+const)?\s*(?:<\w+>\s*)?&', - constructor_args[0].strip()) - ) + return not line or line.isspace() - if (not is_marked_explicit and - onearg_constructor and - not initializer_list_constructor and - not copy_constructor): - if defaulted_args or variadic_args: - error(filename, linenum, 'runtime/explicit', 4, - 'Constructors callable with one argument ' - 'should be marked explicit.') - else: - error(filename, linenum, 'runtime/explicit', 4, - 'Single-parameter constructors should be marked explicit.') +def CheckForNamespaceIndentation(filename, nesting_state, clean_lines, line, error): + is_namespace_indent_item = len(nesting_state.stack) >= 1 and ( + isinstance(nesting_state.stack[-1], _NamespaceInfo) + or (isinstance(nesting_state.previous_stack_top, _NamespaceInfo)) + ) -def CheckSpacingForFunctionCall(filename, clean_lines, linenum, error): - """Checks for the correctness of various spacing around function calls. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # Since function calls often occur inside if/for/while/switch - # expressions - which have their own, more liberal conventions - we - # first see if we should be looking inside such an expression for a - # function call, to which we can apply more strict standards. - fncall = line # if there's no control flow construct, look at whole line - for pattern in (r'\bif\s*\((.*)\)\s*{', - r'\bfor\s*\((.*)\)\s*{', - r'\bwhile\s*\((.*)\)\s*[{;]', - r'\bswitch\s*\((.*)\)\s*{'): - match = re.search(pattern, line) - if match: - fncall = match.group(1) # look inside the parens for function calls - break - - # Except in if/for/while/switch, there should never be space - # immediately inside parens (eg "f( 3, 4 )"). We make an exception - # for nested parens ( (a+b) + c ). Likewise, there should never be - # a space before a ( when it's a function argument. I assume it's a - # function argument when the char before the whitespace is legal in - # a function name (alnum + _) and we're not starting a macro. Also ignore - # pointers and references to arrays and functions coz they're too tricky: - # we use a very simple way to recognize these: - # " (something)(maybe-something)" or - # " (something)(maybe-something," or - # " (something)[something]" - # Note that we assume the contents of [] to be short enough that - # they'll never need to wrap. - if ( # Ignore control structures. - not re.search(r'\b(if|elif|for|while|switch|return|new|delete|catch|sizeof)\b', - fncall) and - # Ignore pointers/references to functions. - not re.search(r' \([^)]+\)\([^)]*(\)|,$)', fncall) and - # Ignore pointers/references to arrays. - not re.search(r' \([^)]+\)\[[^\]]+\]', fncall)): - if re.search(r'\w\s*\(\s(?!\s*\\$)', fncall): # a ( used for a fn call - error(filename, linenum, 'whitespace/parens', 4, - 'Extra space after ( in function call') - elif re.search(r'\(\s+(?!(\s*\\)|\()', fncall): - error(filename, linenum, 'whitespace/parens', 2, - 'Extra space after (') - if (re.search(r'\w\s+\(', fncall) and - not re.search(r'_{0,2}asm_{0,2}\s+_{0,2}volatile_{0,2}\s+\(', fncall) and - not re.search(r'#\s*define|typedef|using\s+\w+\s*=', fncall) and - not re.search(r'\w\s+\((\w+::)*\*\w+\)\(', fncall) and - not re.search(r'\bcase\s+\(', fncall)): - # TODO(unknown): Space after an operator function seem to be a common - # error, silence those for now by restricting them to highest verbosity. - if re.search(r'\boperator_*\b', line): - error(filename, linenum, 'whitespace/parens', 0, - 'Extra space before ( in function call') - else: - error(filename, linenum, 'whitespace/parens', 4, - 'Extra space before ( in function call') - # If the ) is followed only by a newline or a { + newline, assume it's - # part of a control statement (if/while/etc), and don't complain - if re.search(r'[^)]\s+\)\s*[^{\s]', fncall): - # If the closing parenthesis is preceded by only whitespaces, - # try to give a more descriptive error message. - if re.search(r'^\s+\)', fncall): - error(filename, linenum, 'whitespace/parens', 2, - 'Closing ) should be moved to the previous line') - else: - error(filename, linenum, 'whitespace/parens', 2, - 'Extra space before )') + if ShouldCheckNamespaceIndentation( + nesting_state, is_namespace_indent_item, clean_lines.elided, line + ): + CheckItemIndentationInNamespace(filename, clean_lines.elided, line, error) -def IsBlankLine(line): - """Returns true if the given line is blank. - - We consider a line to be blank if the line is empty or consists of - only white spaces. - - Args: - line: A line of a string. - - Returns: - True, if the given line is blank. - """ - return not line or line.isspace() - - -def CheckForNamespaceIndentation(filename, nesting_state, clean_lines, line, - error): - is_namespace_indent_item = ( - len(nesting_state.stack) >= 1 and - (isinstance(nesting_state.stack[-1], _NamespaceInfo) or - (isinstance(nesting_state.previous_stack_top, _NamespaceInfo))) - ) - - if ShouldCheckNamespaceIndentation(nesting_state, is_namespace_indent_item, - clean_lines.elided, line): - CheckItemIndentationInNamespace(filename, clean_lines.elided, - line, error) - - -def CheckForFunctionLengths(filename, clean_lines, linenum, - function_state, error): - """Reports for long function bodies. - - For an overview why this is done, see: - https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions - - Uses a simplistic algorithm assuming other style guidelines - (especially spacing) are followed. - Only checks unindented functions, so class members are unchecked. - Trivial bodies are unchecked, so constructors with huge initializer lists - may be missed. - Blank/comment lines are not counted so as to avoid encouraging the removal - of vertical space and comments just to get through a lint check. - NOLINT *on the last line of a function* disables this check. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - function_state: Current function name and lines in body so far. - error: The function to call with any errors found. - """ - lines = clean_lines.lines - line = lines[linenum] - joined_line = '' - - starting_func = False - regexp = r'(\w(\w|::|\*|\&|\s)*)\(' # decls * & space::name( ... - match_result = re.match(regexp, line) - if match_result: - # If the name is all caps and underscores, figure it's a macro and - # ignore it, unless it's TEST or TEST_F. - function_name = match_result.group(1).split()[-1] - if function_name == 'TEST' or function_name == 'TEST_F' or ( - not re.match(r'[A-Z_]+$', function_name)): - starting_func = True - - if starting_func: - body_found = False - for start_linenum in range(linenum, clean_lines.NumLines()): - start_line = lines[start_linenum] - joined_line += ' ' + start_line.lstrip() - if re.search(r'(;|})', start_line): # Declarations and trivial functions - body_found = True - break # ... ignore - if re.search(r'{', start_line): - body_found = True - function = re.search(r'((\w|:)*)\(', line).group(1) - if re.match(r'TEST', function): # Handle TEST... macros - parameter_regexp = re.search(r'(\(.*\))', joined_line) - if parameter_regexp: # Ignore bad syntax - function += parameter_regexp.group(1) - else: - function += '()' - function_state.Begin(function) - break - if not body_found: - # No body for the function (or evidence of a non-function) was found. - error(filename, linenum, 'readability/fn_size', 5, - 'Lint failed to find start of function body.') - elif re.match(r'^\}\s*$', line): # function end - function_state.Check(error, filename, linenum) - function_state.End() - elif not re.match(r'^\s*$', line): - function_state.Count() # Count non-blank/non-comment lines. +def CheckForFunctionLengths(filename, clean_lines, linenum, function_state, error): + """Reports for long function bodies. + + For an overview why this is done, see: + https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions + Uses a simplistic algorithm assuming other style guidelines + (especially spacing) are followed. + Only checks unindented functions, so class members are unchecked. + Trivial bodies are unchecked, so constructors with huge initializer lists + may be missed. + Blank/comment lines are not counted so as to avoid encouraging the removal + of vertical space and comments just to get through a lint check. + NOLINT *on the last line of a function* disables this check. -_RE_PATTERN_TODO = re.compile(r'^//(\s*)TODO(\(.+?\))?:?(\s|$)?') + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + function_state: Current function name and lines in body so far. + error: The function to call with any errors found. + """ + lines = clean_lines.lines + line = lines[linenum] + joined_line = "" + + starting_func = False + regexp = r"(\w(\w|::|\*|\&|\s)*)\(" # decls * & space::name( ... + if match_result := re.match(regexp, line): + # If the name is all caps and underscores, figure it's a macro and + # ignore it, unless it's TEST or TEST_F. + function_name = match_result.group(1).split()[-1] + if function_name in {"TEST", "TEST_F"} or not re.match(r"[A-Z_]+$", function_name): + starting_func = True + + if starting_func: + body_found = False + for start_linenum in range(linenum, clean_lines.NumLines()): + start_line = lines[start_linenum] + joined_line += " " + start_line.lstrip() + if re.search(r"(;|})", start_line): # Declarations and trivial functions + body_found = True + break # ... ignore + if re.search(r"{", start_line): + body_found = True + function = re.search(r"((\w|:)*)\(", line).group(1) + if re.match(r"TEST", function): # Handle TEST... macros + parameter_regexp = re.search(r"(\(.*\))", joined_line) + if parameter_regexp: # Ignore bad syntax + function += parameter_regexp.group(1) + else: + function += "()" + function_state.Begin(function) + break + if not body_found: + # No body for the function (or evidence of a non-function) was found. + error( + filename, + linenum, + "readability/fn_size", + 5, + "Lint failed to find start of function body.", + ) + elif re.match(r"^\}\s*$", line): # function end + function_state.Check(error, filename, linenum) + function_state.End() + elif not re.match(r"^\s*$", line): + function_state.Count() # Count non-blank/non-comment lines. + + +_RE_PATTERN_TODO = re.compile(r"^//(\s*)TODO(\(.+?\))?:?(\s|$)?") def CheckComment(line, filename, linenum, next_line_start, error): - """Checks for common mistakes in comments. - - Args: - line: The line in question. - filename: The name of the current file. - linenum: The number of the line to check. - next_line_start: The first non-whitespace column of the next line. - error: The function to call with any errors found. - """ - commentpos = line.find('//') - if commentpos != -1: - # Check if the // may be in quotes. If so, ignore it - if re.sub(r'\\.', '', line[0:commentpos]).count('"') % 2 == 0: - # Allow one space for new scopes, two spaces otherwise: - if (not (re.match(r'^.*{ *//', line) and next_line_start == commentpos) and - ((commentpos >= 1 and - line[commentpos-1] not in string.whitespace) or - (commentpos >= 2 and - line[commentpos-2] not in string.whitespace))): - error(filename, linenum, 'whitespace/comments', 2, - 'At least two spaces is best between code and comments') - - # Checks for common mistakes in TODO comments. - comment = line[commentpos:] - match = _RE_PATTERN_TODO.match(comment) - if match: - # One whitespace is correct; zero whitespace is handled elsewhere. - leading_whitespace = match.group(1) - if len(leading_whitespace) > 1: - error(filename, linenum, 'whitespace/todo', 2, - 'Too many spaces before TODO') - - username = match.group(2) - if not username: - error(filename, linenum, 'readability/todo', 2, - 'Missing username in TODO; it should look like ' - '"// TODO(my_username): Stuff."') - - middle_whitespace = match.group(3) - # Comparisons made explicit for correctness - # -- pylint: disable=g-explicit-bool-comparison - if middle_whitespace != ' ' and middle_whitespace != '': - error(filename, linenum, 'whitespace/todo', 2, - 'TODO(my_username) should be followed by a space') - - # If the comment contains an alphanumeric character, there - # should be a space somewhere between it and the // unless - # it's a /// or //! Doxygen comment. - if (re.match(r'//[^ ]*\w', comment) and - not re.match(r'(///|//\!)(\s+|$)', comment)): - error(filename, linenum, 'whitespace/comments', 4, - 'Should have a space between // and comment') + """Checks for common mistakes in comments. + + Args: + line: The line in question. + filename: The name of the current file. + linenum: The number of the line to check. + next_line_start: The first non-whitespace column of the next line. + error: The function to call with any errors found. + """ + commentpos = line.find("//") + if commentpos != -1: + # Check if the // may be in quotes. If so, ignore it + if re.sub(r"\\.", "", line[0:commentpos]).count('"') % 2 == 0: + # Allow one space for new scopes, two spaces otherwise: + if not (re.match(r"^.*{ *//", line) and next_line_start == commentpos) and ( + (commentpos >= 1 and line[commentpos - 1] not in string.whitespace) + or (commentpos >= 2 and line[commentpos - 2] not in string.whitespace) + ): + error( + filename, + linenum, + "whitespace/comments", + 2, + "At least two spaces is best between code and comments", + ) + + # Checks for common mistakes in TODO comments. + comment = line[commentpos:] + match = _RE_PATTERN_TODO.match(comment) + if match: + # One whitespace is correct; zero whitespace is handled elsewhere. + leading_whitespace = match.group(1) + if len(leading_whitespace) > 1: + error(filename, linenum, "whitespace/todo", 2, "Too many spaces before TODO") + + username = match.group(2) + if not username: + error( + filename, + linenum, + "readability/todo", + 2, + "Missing username in TODO; it should look like " + '"// TODO(my_username): Stuff."', + ) + + middle_whitespace = match.group(3) + # Comparisons made explicit for correctness + # -- pylint: disable=g-explicit-bool-comparison + if middle_whitespace not in {" ", ""}: + error( + filename, + linenum, + "whitespace/todo", + 2, + "TODO(my_username) should be followed by a space", + ) + + # If the comment contains an alphanumeric character, there + # should be a space somewhere between it and the // unless + # it's a /// or //! Doxygen comment. + if re.match(r"//[^ ]*\w", comment) and not re.match(r"(///|//\!)(\s+|$)", comment): + error( + filename, + linenum, + "whitespace/comments", + 4, + "Should have a space between // and comment", + ) def CheckSpacing(filename, clean_lines, linenum, nesting_state, error): - """Checks for the correctness of various spacing issues in the code. - - Things we check for: spaces around operators, spaces after - if/for/while/switch, no spaces around parens in function calls, two - spaces between code and comment, don't start a block with a blank - line, don't end a function with a blank line, don't add a blank line - after public/protected/private, don't have too many blank lines in a row. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - nesting_state: A NestingState instance which maintains information about - the current stack of nested blocks being parsed. - error: The function to call with any errors found. - """ - - # Don't use "elided" lines here, otherwise we can't check commented lines. - # Don't want to use "raw" either, because we don't want to check inside C++11 - # raw strings, - raw = clean_lines.lines_without_raw_strings - line = raw[linenum] - - # Before nixing comments, check if the line is blank for no good - # reason. This includes the first line after a block is opened, and - # blank lines at the end of a function (ie, right before a line like '}' - # - # Skip all the blank line checks if we are immediately inside a - # namespace body. In other words, don't issue blank line warnings - # for this block: - # namespace { - # - # } - # - # A warning about missing end of namespace comments will be issued instead. - # - # Also skip blank line checks for 'extern "C"' blocks, which are formatted - # like namespaces. - if (IsBlankLine(line) and - not nesting_state.InNamespaceBody() and - not nesting_state.InExternC()): - elided = clean_lines.elided - prev_line = elided[linenum - 1] - prevbrace = prev_line.rfind('{') - # TODO(unknown): Don't complain if line before blank line, and line after, - # both start with alnums and are indented the same amount. - # This ignores whitespace at the start of a namespace block - # because those are not usually indented. - if prevbrace != -1 and prev_line[prevbrace:].find('}') == -1: - # OK, we have a blank line at the start of a code block. Before we - # complain, we check if it is an exception to the rule: The previous - # non-empty line has the parameters of a function header that are indented - # 4 spaces (because they did not fit in a 80 column line when placed on - # the same line as the function name). We also check for the case where - # the previous line is indented 6 spaces, which may happen when the - # initializers of a constructor do not fit into a 80 column line. - exception = False - if re.match(r' {6}\w', prev_line): # Initializer list? - # We are looking for the opening column of initializer list, which - # should be indented 4 spaces to cause 6 space indentation afterwards. - search_position = linenum-2 - while (search_position >= 0 - and re.match(r' {6}\w', elided[search_position])): - search_position -= 1 - exception = (search_position >= 0 - and elided[search_position][:5] == ' :') - else: - # Search for the function arguments or an initializer list. We use a - # simple heuristic here: If the line is indented 4 spaces; and we have a - # closing paren, without the opening paren, followed by an opening brace - # or colon (for initializer lists) we assume that it is the last line of - # a function header. If we have a colon indented 4 spaces, it is an - # initializer list. - exception = (re.match(r' {4}\w[^\(]*\)\s*(const\s*)?(\{\s*$|:)', - prev_line) - or re.match(r' {4}:', prev_line)) - - if not exception: - error(filename, linenum, 'whitespace/blank_line', 2, - 'Redundant blank line at the start of a code block ' - 'should be deleted.') - # Ignore blank lines at the end of a block in a long if-else - # chain, like this: - # if (condition1) { - # // Something followed by a blank line + """Checks for the correctness of various spacing issues in the code. + + Things we check for: spaces around operators, spaces after + if/for/while/switch, no spaces around parens in function calls, two + spaces between code and comment, don't start a block with a blank + line, don't end a function with a blank line, don't add a blank line + after public/protected/private, don't have too many blank lines in a row. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + + # Don't use "elided" lines here, otherwise we can't check commented lines. + # Don't want to use "raw" either, because we don't want to check inside C++11 + # raw strings, + raw = clean_lines.lines_without_raw_strings + line = raw[linenum] + + # Before nixing comments, check if the line is blank for no good + # reason. This includes the first line after a block is opened, and + # blank lines at the end of a function (ie, right before a line like '}' + # + # Skip all the blank line checks if we are immediately inside a + # namespace body. In other words, don't issue blank line warnings + # for this block: + # namespace { # - # } else if (condition2) { - # // Something else # } + # + # A warning about missing end of namespace comments will be issued instead. + # + # Also skip blank line checks for 'extern "C"' blocks, which are formatted + # like namespaces. + if IsBlankLine(line) and not nesting_state.InNamespaceBody() and not nesting_state.InExternC(): + elided = clean_lines.elided + prev_line = elided[linenum - 1] + prevbrace = prev_line.rfind("{") + # TODO(google): Don't complain if line before blank line, and line after, + # both start with alnums and are indented the same amount. + # This ignores whitespace at the start of a namespace block + # because those are not usually indented. + if prevbrace != -1 and prev_line[prevbrace:].find("}") == -1: + # OK, we have a blank line at the start of a code block. Before we + # complain, we check if it is an exception to the rule: The previous + # non-empty line has the parameters of a function header that are indented + # 4 spaces (because they did not fit in a 80 column line when placed on + # the same line as the function name). We also check for the case where + # the previous line is indented 6 spaces, which may happen when the + # initializers of a constructor do not fit into a 80 column line. + exception = False + if re.match(r" {6}\w", prev_line): # Initializer list? + # We are looking for the opening column of initializer list, which + # should be indented 4 spaces to cause 6 space indentation afterwards. + search_position = linenum - 2 + while search_position >= 0 and re.match(r" {6}\w", elided[search_position]): + search_position -= 1 + exception = search_position >= 0 and elided[search_position][:5] == " :" + else: + # Search for the function arguments or an initializer list. We use a + # simple heuristic here: If the line is indented 4 spaces; and we have a + # closing paren, without the opening paren, followed by an opening brace + # or colon (for initializer lists) we assume that it is the last line of + # a function header. If we have a colon indented 4 spaces, it is an + # initializer list. + exception = re.match( + r" {4}\w[^\(]*\)\s*(const\s*)?(\{\s*$|:)", prev_line + ) or re.match(r" {4}:", prev_line) + + if not exception: + error( + filename, + linenum, + "whitespace/blank_line", + 2, + "Redundant blank line at the start of a code block should be deleted.", + ) + # Ignore blank lines at the end of a block in a long if-else + # chain, like this: + # if (condition1) { + # // Something followed by a blank line + # + # } else if (condition2) { + # // Something else + # } + if linenum + 1 < clean_lines.NumLines(): + next_line = raw[linenum + 1] + if next_line and re.match(r"\s*}", next_line) and next_line.find("} else ") == -1: + error( + filename, + linenum, + "whitespace/blank_line", + 3, + "Redundant blank line at the end of a code block should be deleted.", + ) + + matched = re.match(r"\s*(public|protected|private):", prev_line) + if matched: + error( + filename, + linenum, + "whitespace/blank_line", + 3, + f'Do not leave a blank line after "{matched.group(1)}:"', + ) + + # Next, check comments + next_line_start = 0 if linenum + 1 < clean_lines.NumLines(): - next_line = raw[linenum + 1] - if (next_line - and re.match(r'\s*}', next_line) - and next_line.find('} else ') == -1): - error(filename, linenum, 'whitespace/blank_line', 3, - 'Redundant blank line at the end of a code block ' - 'should be deleted.') - - matched = re.match(r'\s*(public|protected|private):', prev_line) - if matched: - error(filename, linenum, 'whitespace/blank_line', 3, - f'Do not leave a blank line after "{matched.group(1)}:"') - - # Next, check comments - next_line_start = 0 - if linenum + 1 < clean_lines.NumLines(): - next_line = raw[linenum + 1] - next_line_start = len(next_line) - len(next_line.lstrip()) - CheckComment(line, filename, linenum, next_line_start, error) - - # get rid of comments and strings - line = clean_lines.elided[linenum] - - # You shouldn't have spaces before your brackets, except for C++11 attributes - # or maybe after 'delete []', 'return []() {};', or 'auto [abc, ...] = ...;'. - if (re.search(r'\w\s+\[(?!\[)', line) and - not re.search(r'(?:auto&?|delete|return)\s+\[', line)): - error(filename, linenum, 'whitespace/braces', 5, - 'Extra space before [') - - # In range-based for, we wanted spaces before and after the colon, but - # not around "::" tokens that might appear. - if (re.search(r'for *\(.*[^:]:[^: ]', line) or - re.search(r'for *\(.*[^: ]:[^:]', line)): - error(filename, linenum, 'whitespace/forcolon', 2, - 'Missing space around colon in range-based for loop') + next_line = raw[linenum + 1] + next_line_start = len(next_line) - len(next_line.lstrip()) + CheckComment(line, filename, linenum, next_line_start, error) + + # get rid of comments and strings + line = clean_lines.elided[linenum] + + # You shouldn't have spaces before your brackets, except for C++11 attributes + # or maybe after 'delete []', 'return []() {};', or 'auto [abc, ...] = ...;'. + if re.search(r"\w\s+\[(?!\[)", line) and not re.search(r"(?:auto&?|delete|return)\s+\[", line): + error(filename, linenum, "whitespace/braces", 5, "Extra space before [") + + # In range-based for, we wanted spaces before and after the colon, but + # not around "::" tokens that might appear. + if re.search(r"for *\(.*[^:]:[^: ]", line) or re.search(r"for *\(.*[^: ]:[^:]", line): + error( + filename, + linenum, + "whitespace/forcolon", + 2, + "Missing space around colon in range-based for loop", + ) def CheckOperatorSpacing(filename, clean_lines, linenum, error): - """Checks for horizontal spacing around operators. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # Don't try to do spacing checks for operator methods. Do this by - # replacing the troublesome characters with something else, - # preserving column position for all other characters. - # - # The replacement is done repeatedly to avoid false positives from - # operators that call operators. - while True: - match = re.match(r'^(.*\boperator\b)(\S+)(\s*\(.*)$', line) + """Checks for horizontal spacing around operators. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Don't try to do spacing checks for operator methods. Do this by + # replacing the troublesome characters with something else, + # preserving column position for all other characters. + # + # The replacement is done repeatedly to avoid false positives from + # operators that call operators. + while True: + match = re.match(r"^(.*\boperator\b)(\S+)(\s*\(.*)$", line) + if match: + line = match.group(1) + ("_" * len(match.group(2))) + match.group(3) + else: + break + + # We allow no-spaces around = within an if: "if ( (a=Foo()) == 0 )". + # Otherwise not. Note we only check for non-spaces on *both* sides; + # sometimes people put non-spaces on one side when aligning ='s among + # many lines (not that this is behavior that I approve of...) + if ( + (re.search(r"[\w.]=", line) or re.search(r"=[\w.]", line)) + and not re.search(r"\b(if|while|for) ", line) + # Operators taken from [lex.operators] in C++11 standard. + and not re.search(r"(>=|<=|==|!=|&=|\^=|\|=|\+=|\*=|\/=|\%=)", line) + and not re.search(r"operator=", line) + ): + error(filename, linenum, "whitespace/operators", 4, "Missing spaces around =") + + # It's ok not to have spaces around binary operators like + - * /, but if + # there's too little whitespace, we get concerned. It's hard to tell, + # though, so we punt on this one for now. TODO(google). + + # You should always have whitespace around binary operators. + # + # Check <= and >= first to avoid false positives with < and >, then + # check non-include lines for spacing around < and >. + # + # If the operator is followed by a comma, assume it's be used in a + # macro context and don't do any checks. This avoids false + # positives. + # + # Note that && is not included here. This is because there are too + # many false positives due to RValue references. + match = re.search(r"[^<>=!\s](==|!=|<=|>=|\|\|)[^<>=!\s,;\)]", line) if match: - line = match.group(1) + ('_' * len(match.group(2))) + match.group(3) - else: - break - - # We allow no-spaces around = within an if: "if ( (a=Foo()) == 0 )". - # Otherwise not. Note we only check for non-spaces on *both* sides; - # sometimes people put non-spaces on one side when aligning ='s among - # many lines (not that this is behavior that I approve of...) - if ((re.search(r'[\w.]=', line) or - re.search(r'=[\w.]', line)) - and not re.search(r'\b(if|while|for) ', line) - # Operators taken from [lex.operators] in C++11 standard. - and not re.search(r'(>=|<=|==|!=|&=|\^=|\|=|\+=|\*=|\/=|\%=)', line) - and not re.search(r'operator=', line)): - error(filename, linenum, 'whitespace/operators', 4, - 'Missing spaces around =') - - # It's ok not to have spaces around binary operators like + - * /, but if - # there's too little whitespace, we get concerned. It's hard to tell, - # though, so we punt on this one for now. TODO. - - # You should always have whitespace around binary operators. - # - # Check <= and >= first to avoid false positives with < and >, then - # check non-include lines for spacing around < and >. - # - # If the operator is followed by a comma, assume it's be used in a - # macro context and don't do any checks. This avoids false - # positives. - # - # Note that && is not included here. This is because there are too - # many false positives due to RValue references. - match = re.search(r'[^<>=!\s](==|!=|<=|>=|\|\|)[^<>=!\s,;\)]', line) - if match: - # TODO: support alternate operators - error(filename, linenum, 'whitespace/operators', 3, - f'Missing spaces around {match.group(1)}') - elif not re.match(r'#.*include', line): - # Look for < that is not surrounded by spaces. This is only - # triggered if both sides are missing spaces, even though - # technically should should flag if at least one side is missing a - # space. This is done to avoid some false positives with shifts. - match = re.match(r'^(.*[^\s<])<[^\s=<,]', line) + # TODO(google): support alternate operators + error( + filename, linenum, "whitespace/operators", 3, f"Missing spaces around {match.group(1)}" + ) + elif not re.match(r"#.*include", line): + # Look for < that is not surrounded by spaces. This is only + # triggered if both sides are missing spaces, even though + # technically should should flag if at least one side is missing a + # space. This is done to avoid some false positives with shifts. + match = re.match(r"^(.*[^\s<])<[^\s=<,]", line) + if match: + (_, _, end_pos) = CloseExpression(clean_lines, linenum, len(match.group(1))) + if end_pos <= -1: + error(filename, linenum, "whitespace/operators", 3, "Missing spaces around <") + + # Look for > that is not surrounded by spaces. Similar to the + # above, we only trigger if both sides are missing spaces to avoid + # false positives with shifts. + match = re.match(r"^(.*[^-\s>])>[^\s=>,]", line) + if match: + (_, _, start_pos) = ReverseCloseExpression(clean_lines, linenum, len(match.group(1))) + if start_pos <= -1: + error(filename, linenum, "whitespace/operators", 3, "Missing spaces around >") + + # We allow no-spaces around << when used like this: 10<<20, but + # not otherwise (particularly, not when used as streams) + # + # We also allow operators following an opening parenthesis, since + # those tend to be macros that deal with operators. + match = re.search(r"(operator|[^\s(<])(?:L|UL|LL|ULL|l|ul|ll|ull)?<<([^\s,=<])", line) + if ( + match + and not (match.group(1).isdigit() and match.group(2).isdigit()) + and not (match.group(1) == "operator" and match.group(2) == ";") + ): + error(filename, linenum, "whitespace/operators", 3, "Missing spaces around <<") + + # We allow no-spaces around >> for almost anything. This is because + # C++11 allows ">>" to close nested templates, which accounts for + # most cases when ">>" is not followed by a space. + # + # We still warn on ">>" followed by alpha character, because that is + # likely due to ">>" being used for right shifts, e.g.: + # value >> alpha + # + # When ">>" is used to close templates, the alphanumeric letter that + # follows would be part of an identifier, and there should still be + # a space separating the template type and the identifier. + # type> alpha + match = re.search(r">>[a-zA-Z_]", line) if match: - (_, _, end_pos) = CloseExpression( - clean_lines, linenum, len(match.group(1))) - if end_pos <= -1: - error(filename, linenum, 'whitespace/operators', 3, - 'Missing spaces around <') - - # Look for > that is not surrounded by spaces. Similar to the - # above, we only trigger if both sides are missing spaces to avoid - # false positives with shifts. - match = re.match(r'^(.*[^-\s>])>[^\s=>,]', line) + error(filename, linenum, "whitespace/operators", 3, "Missing spaces around >>") + + # There shouldn't be space around unary operators + match = re.search(r"(!\s|~\s|[\s]--[\s;]|[\s]\+\+[\s;])", line) if match: - (_, _, start_pos) = ReverseCloseExpression( - clean_lines, linenum, len(match.group(1))) - if start_pos <= -1: - error(filename, linenum, 'whitespace/operators', 3, - 'Missing spaces around >') - - # We allow no-spaces around << when used like this: 10<<20, but - # not otherwise (particularly, not when used as streams) - # - # We also allow operators following an opening parenthesis, since - # those tend to be macros that deal with operators. - match = re.search(r'(operator|[^\s(<])(?:L|UL|LL|ULL|l|ul|ll|ull)?<<([^\s,=<])', line) - if (match and not (match.group(1).isdigit() and match.group(2).isdigit()) and - not (match.group(1) == 'operator' and match.group(2) == ';')): - error(filename, linenum, 'whitespace/operators', 3, - 'Missing spaces around <<') - - # We allow no-spaces around >> for almost anything. This is because - # C++11 allows ">>" to close nested templates, which accounts for - # most cases when ">>" is not followed by a space. - # - # We still warn on ">>" followed by alpha character, because that is - # likely due to ">>" being used for right shifts, e.g.: - # value >> alpha - # - # When ">>" is used to close templates, the alphanumeric letter that - # follows would be part of an identifier, and there should still be - # a space separating the template type and the identifier. - # type> alpha - match = re.search(r'>>[a-zA-Z_]', line) - if match: - error(filename, linenum, 'whitespace/operators', 3, - 'Missing spaces around >>') - - # There shouldn't be space around unary operators - match = re.search(r'(!\s|~\s|[\s]--[\s;]|[\s]\+\+[\s;])', line) - if match: - error(filename, linenum, 'whitespace/operators', 4, - f'Extra space for operator {match.group(1)}') + error( + filename, + linenum, + "whitespace/operators", + 4, + f"Extra space for operator {match.group(1)}", + ) def CheckParenthesisSpacing(filename, clean_lines, linenum, error): - """Checks for horizontal spacing around parentheses. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # No spaces after an if, while, switch, or for - match = re.search(r' (if\(|for\(|while\(|switch\()', line) - if match: - error(filename, linenum, 'whitespace/parens', 5, - f'Missing space before ( in {match.group(1)}') - - # For if/for/while/switch, the left and right parens should be - # consistent about how many spaces are inside the parens, and - # there should either be zero or one spaces inside the parens. - # We don't want: "if ( foo)" or "if ( foo )". - # Exception: "for ( ; foo; bar)" and "for (foo; bar; )" are allowed. - match = re.search(r'\b(if|for|while|switch)\s*' - r'\(([ ]*)(.).*[^ ]+([ ]*)\)\s*{\s*$', - line) - if match: - if len(match.group(2)) != len(match.group(4)): - if not (match.group(3) == ';' and - len(match.group(2)) == 1 + len(match.group(4)) or - not match.group(2) and re.search(r'\bfor\s*\(.*; \)', line)): - error(filename, linenum, 'whitespace/parens', 5, - f'Mismatching spaces inside () in {match.group(1)}') - if len(match.group(2)) not in [0, 1]: - error(filename, linenum, 'whitespace/parens', 5, - f'Should have zero or one spaces inside ( and ) in {match.group(1)}') - - -def CheckCommaSpacing(filename, clean_lines, linenum, error): - """Checks for horizontal spacing near commas and semicolons. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - raw = clean_lines.lines_without_raw_strings - line = clean_lines.elided[linenum] - - # You should always have a space after a comma (either as fn arg or operator) - # - # This does not apply when the non-space character following the - # comma is another comma, since the only time when that happens is - # for empty macro arguments. - # - # We run this check in two passes: first pass on elided lines to - # verify that lines contain missing whitespaces, second pass on raw - # lines to confirm that those missing whitespaces are not due to - # elided comments. - match = re.search(r',[^,\s]', re.sub(r'\b__VA_OPT__\s*\(,\)', '', - re.sub(r'\boperator\s*,\s*\(', 'F(', line))) - if (match and re.search(r',[^,\s]', raw[linenum])): - error(filename, linenum, 'whitespace/comma', 3, - 'Missing space after ,') - - # You should always have a space after a semicolon - # except for few corner cases - # TODO(unknown): clarify if 'if (1) { return 1;}' is requires one more - # space after ; - if re.search(r';[^\s};\\)/]', line): - error(filename, linenum, 'whitespace/semicolon', 3, - 'Missing space after ;') + """Checks for horizontal spacing around parentheses. + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] -def _IsType(clean_lines, nesting_state, expr): - """Check if expression looks like a type name, returns true if so. - - Args: - clean_lines: A CleansedLines instance containing the file. - nesting_state: A NestingState instance which maintains information about - the current stack of nested blocks being parsed. - expr: The expression to check. - Returns: - True, if token looks like a type. - """ - # Keep only the last token in the expression - last_word = re.match(r'^.*(\b\S+)$', expr) - if last_word: - token = last_word.group(1) - else: - token = expr - - # Match native types and stdint types - if _TYPES.match(token): - return True + # No spaces after an if, while, switch, or for + match = re.search(r" (if\(|for\(|while\(|switch\()", line) + if match: + error( + filename, linenum, "whitespace/parens", 5, f"Missing space before ( in {match.group(1)}" + ) + + # For if/for/while/switch, the left and right parens should be + # consistent about how many spaces are inside the parens, and + # there should either be zero or one spaces inside the parens. + # We don't want: "if ( foo)" or "if ( foo )". + # Exception: "for ( ; foo; bar)" and "for (foo; bar; )" are allowed. + match = re.search( + r"\b(if|for|while|switch)\s*" + r"\(([ ]*)(.).*[^ ]+([ ]*)\)\s*{\s*$", + line, + ) + if match: + if len(match.group(2)) != len(match.group(4)) and not ( + match.group(3) == ";" + and len(match.group(2)) == 1 + len(match.group(4)) + or not match.group(2) + and re.search(r"\bfor\s*\(.*; \)", line) + ): + error( + filename, + linenum, + "whitespace/parens", + 5, + f"Mismatching spaces inside () in {match.group(1)}", + ) + if len(match.group(2)) not in [0, 1]: + error( + filename, + linenum, + "whitespace/parens", + 5, + f"Should have zero or one spaces inside ( and ) in {match.group(1)}", + ) - # Try a bit harder to match templated types. Walk up the nesting - # stack until we find something that resembles a typename - # declaration for what we are looking for. - typename_pattern = (r'\b(?:typename|class|struct)\s+' + re.escape(token) + - r'\b') - block_index = len(nesting_state.stack) - 1 - while block_index >= 0: - if isinstance(nesting_state.stack[block_index], _NamespaceInfo): - return False - - # Found where the opening brace is. We want to scan from this - # line up to the beginning of the function, minus a few lines. - # template - # class C - # : public ... { // start scanning here - last_line = nesting_state.stack[block_index].starting_linenum - - next_block_start = 0 - if block_index > 0: - next_block_start = nesting_state.stack[block_index - 1].starting_linenum - first_line = last_line - while first_line >= next_block_start: - if clean_lines.elided[first_line].find('template') >= 0: - break - first_line -= 1 - if first_line < next_block_start: - # Didn't find any "template" keyword before reaching the next block, - # there are probably no template things to check for this block - block_index -= 1 - continue - - # Look for typename in the specified range - for i in range(first_line, last_line + 1, 1): - if re.search(typename_pattern, clean_lines.elided[i]): - return True - block_index -= 1 - return False +def CheckCommaSpacing(filename, clean_lines, linenum, error): + """Checks for horizontal spacing near commas and semicolons. + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + raw = clean_lines.lines_without_raw_strings + line = clean_lines.elided[linenum] -def CheckBracesSpacing(filename, clean_lines, linenum, nesting_state, error): - """Checks for horizontal spacing near commas. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - nesting_state: A NestingState instance which maintains information about - the current stack of nested blocks being parsed. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # Except after an opening paren, or after another opening brace (in case of - # an initializer list, for instance), you should have spaces before your - # braces when they are delimiting blocks, classes, namespaces etc. - # And since you should never have braces at the beginning of a line, - # this is an easy test. Except that braces used for initialization don't - # follow the same rule; we often don't want spaces before those. - match = re.match(r'^(.*[^ ({>]){', line) - - if match: - # Try a bit harder to check for brace initialization. This - # happens in one of the following forms: - # Constructor() : initializer_list_{} { ... } - # Constructor{}.MemberFunction() - # Type variable{}; - # FunctionCall(type{}, ...); - # LastArgument(..., type{}); - # LOG(INFO) << type{} << " ..."; - # map_of_type[{...}] = ...; - # ternary = expr ? new type{} : nullptr; - # OuterTemplate{}> + # You should always have a space after a comma (either as fn arg or operator) # - # We check for the character following the closing brace, and - # silence the warning if it's one of those listed above, i.e. - # "{.;,)<>]:". + # This does not apply when the non-space character following the + # comma is another comma, since the only time when that happens is + # for empty macro arguments. # - # To account for nested initializer list, we allow any number of - # closing braces up to "{;,)<". We can't simply silence the - # warning on first sight of closing brace, because that would - # cause false negatives for things that are not initializer lists. - # Silence this: But not this: - # Outer{ if (...) { - # Inner{...} if (...){ // Missing space before { - # }; } - # - # There is a false negative with this approach if people inserted - # spurious semicolons, e.g. "if (cond){};", but we will catch the - # spurious semicolon with a separate check. - leading_text = match.group(1) - (endline, endlinenum, endpos) = CloseExpression( - clean_lines, linenum, len(match.group(1))) - trailing_text = '' - if endpos > -1: - trailing_text = endline[endpos:] - for offset in range(endlinenum + 1, - min(endlinenum + 3, clean_lines.NumLines() - 1)): - trailing_text += clean_lines.elided[offset] - # We also suppress warnings for `uint64_t{expression}` etc., as the style - # guide recommends brace initialization for integral types to avoid - # overflow/truncation. - if (not re.match(r'^[\s}]*[{.;,)<>\]:]', trailing_text) - and not _IsType(clean_lines, nesting_state, leading_text)): - error(filename, linenum, 'whitespace/braces', 5, - 'Missing space before {') - - # Make sure '} else {' has spaces. - if re.search(r'}else', line): - error(filename, linenum, 'whitespace/braces', 5, - 'Missing space before else') - - # You shouldn't have a space before a semicolon at the end of the line. - # There's a special case for "for" since the style guide allows space before - # the semicolon there. - if re.search(r':\s*;\s*$', line): - error(filename, linenum, 'whitespace/semicolon', 5, - 'Semicolon defining empty statement. Use {} instead.') - elif re.search(r'^\s*;\s*$', line): - error(filename, linenum, 'whitespace/semicolon', 5, - 'Line contains only semicolon. If this should be an empty statement, ' - 'use {} instead.') - elif (re.search(r'\s+;\s*$', line) and - not re.search(r'\bfor\b', line)): - error(filename, linenum, 'whitespace/semicolon', 5, - 'Extra space before last semicolon. If this should be an empty ' - 'statement, use {} instead.') + # We run this check in two passes: first pass on elided lines to + # verify that lines contain missing whitespaces, second pass on raw + # lines to confirm that those missing whitespaces are not due to + # elided comments. + match = re.search( + r",[^,\s]", re.sub(r"\b__VA_OPT__\s*\(,\)", "", re.sub(r"\boperator\s*,\s*\(", "F(", line)) + ) + if match and re.search(r",[^,\s]", raw[linenum]): + error(filename, linenum, "whitespace/comma", 3, "Missing space after ,") + # You should always have a space after a semicolon + # except for few corner cases + # TODO(google): clarify if 'if (1) { return 1;}' is requires one more + # space after ; + if re.search(r";[^\s};\\)/]", line): + error(filename, linenum, "whitespace/semicolon", 3, "Missing space after ;") -def IsDecltype(clean_lines, linenum, column): - """Check if the token ending on (linenum, column) is decltype(). - - Args: - clean_lines: A CleansedLines instance containing the file. - linenum: the number of the line to check. - column: end column of the token to check. - Returns: - True if this token is decltype() expression, False otherwise. - """ - (text, _, start_col) = ReverseCloseExpression(clean_lines, linenum, column) - if start_col < 0: - return False - if re.search(r'\bdecltype\s*$', text[0:start_col]): - return True - return False -def CheckSectionSpacing(filename, clean_lines, class_info, linenum, error): - """Checks for additional blank line issues related to sections. - - Currently the only thing checked here is blank line before protected/private. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - class_info: A _ClassInfo objects. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - # Skip checks if the class is small, where small means 25 lines or less. - # 25 lines seems like a good cutoff since that's the usual height of - # terminals, and any class that can't fit in one screen can't really - # be considered "small". - # - # Also skip checks if we are on the first line. This accounts for - # classes that look like - # class Foo { public: ... }; - # - # If we didn't find the end of the class, last_line would be zero, - # and the check will be skipped by the first condition. - if (class_info.last_line - class_info.starting_linenum <= 24 or - linenum <= class_info.starting_linenum): - return - - matched = re.match(r'\s*(public|protected|private):', clean_lines.lines[linenum]) - if matched: - # Issue warning if the line before public/protected/private was - # not a blank line, but don't do this if the previous line contains - # "class" or "struct". This can happen two ways: - # - We are at the beginning of the class. - # - We are forward-declaring an inner class that is semantically - # private, but needed to be public for implementation reasons. - # Also ignores cases where the previous line ends with a backslash as can be - # common when defining classes in C macros. - prev_line = clean_lines.lines[linenum - 1] - if (not IsBlankLine(prev_line) and - not re.search(r'\b(class|struct)\b', prev_line) and - not re.search(r'\\$', prev_line)): - # Try a bit harder to find the beginning of the class. This is to - # account for multi-line base-specifier lists, e.g.: - # class Derived - # : public Base { - end_class_head = class_info.starting_linenum - for i in range(class_info.starting_linenum, linenum): - if re.search(r'\{\s*$', clean_lines.lines[i]): - end_class_head = i - break - if end_class_head < linenum - 1: - error(filename, linenum, 'whitespace/blank_line', 3, - f'"{matched.group(1)}:" should be preceded by a blank line') +def _IsType(clean_lines, nesting_state, expr): + """Check if expression looks like a type name, returns true if so. + Args: + clean_lines: A CleansedLines instance containing the file. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + expr: The expression to check. + Returns: + True, if token looks like a type. + """ + # Keep only the last token in the expression + if last_word := re.match(r"^.*(\b\S+)$", expr): + token = last_word.group(1) + else: + token = expr -def GetPreviousNonBlankLine(clean_lines, linenum): - """Return the most recent non-blank line and its line number. + # Match native types and stdint types + if _TYPES.match(token): + return True - Args: - clean_lines: A CleansedLines instance containing the file contents. - linenum: The number of the line to check. + # Try a bit harder to match templated types. Walk up the nesting + # stack until we find something that resembles a typename + # declaration for what we are looking for. + typename_pattern = r"\b(?:typename|class|struct)\s+" + re.escape(token) + r"\b" + block_index = len(nesting_state.stack) - 1 + while block_index >= 0: + if isinstance(nesting_state.stack[block_index], _NamespaceInfo): + return False + + # Found where the opening brace is. We want to scan from this + # line up to the beginning of the function, minus a few lines. + # template + # class C + # : public ... { // start scanning here + last_line = nesting_state.stack[block_index].starting_linenum + + next_block_start = 0 + if block_index > 0: + next_block_start = nesting_state.stack[block_index - 1].starting_linenum + first_line = last_line + while first_line >= next_block_start: + if clean_lines.elided[first_line].find("template") >= 0: + break + first_line -= 1 + if first_line < next_block_start: + # Didn't find any "template" keyword before reaching the next block, + # there are probably no template things to check for this block + block_index -= 1 + continue - Returns: - A tuple with two elements. The first element is the contents of the last - non-blank line before the current line, or the empty string if this is the - first non-blank line. The second is the line number of that line, or -1 - if this is the first non-blank line. - """ + # Look for typename in the specified range + for i in range(first_line, last_line + 1, 1): + if re.search(typename_pattern, clean_lines.elided[i]): + return True + block_index -= 1 - prevlinenum = linenum - 1 - while prevlinenum >= 0: - prevline = clean_lines.elided[prevlinenum] - if not IsBlankLine(prevline): # if not a blank line... - return (prevline, prevlinenum) - prevlinenum -= 1 - return ('', -1) + return False + + +def CheckBracesSpacing(filename, clean_lines, linenum, nesting_state, error): + """Checks for horizontal spacing near commas. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Except after an opening paren, or after another opening brace (in case of + # an initializer list, for instance), you should have spaces before your + # braces when they are delimiting blocks, classes, namespaces etc. + # And since you should never have braces at the beginning of a line, + # this is an easy test. Except that braces used for initialization don't + # follow the same rule; we often don't want spaces before those. + + if match := re.match(r"^(.*[^ ({>]){", line): + # Try a bit harder to check for brace initialization. This + # happens in one of the following forms: + # Constructor() : initializer_list_{} { ... } + # Constructor{}.MemberFunction() + # Type variable{}; + # FunctionCall(type{}, ...); + # LastArgument(..., type{}); + # LOG(INFO) << type{} << " ..."; + # map_of_type[{...}] = ...; + # ternary = expr ? new type{} : nullptr; + # OuterTemplate{}> + # + # We check for the character following the closing brace, and + # silence the warning if it's one of those listed above, i.e. + # "{.;,)<>]:". + # + # To account for nested initializer list, we allow any number of + # closing braces up to "{;,)<". We can't simply silence the + # warning on first sight of closing brace, because that would + # cause false negatives for things that are not initializer lists. + # Silence this: But not this: + # Outer{ if (...) { + # Inner{...} if (...){ // Missing space before { + # }; } + # + # There is a false negative with this approach if people inserted + # spurious semicolons, e.g. "if (cond){};", but we will catch the + # spurious semicolon with a separate check. + leading_text = match.group(1) + (endline, endlinenum, endpos) = CloseExpression(clean_lines, linenum, len(match.group(1))) + trailing_text = "" + if endpos > -1: + trailing_text = endline[endpos:] + for offset in range(endlinenum + 1, min(endlinenum + 3, clean_lines.NumLines() - 1)): + trailing_text += clean_lines.elided[offset] + # We also suppress warnings for `uint64_t{expression}` etc., as the style + # guide recommends brace initialization for integral types to avoid + # overflow/truncation. + if not re.match(r"^[\s}]*[{.;,)<>\]:]", trailing_text) and not _IsType( + clean_lines, nesting_state, leading_text + ): + error(filename, linenum, "whitespace/braces", 5, "Missing space before {") + + # Make sure '} else {' has spaces. + if re.search(r"}else", line): + error(filename, linenum, "whitespace/braces", 5, "Missing space before else") + + # You shouldn't have a space before a semicolon at the end of the line. + # There's a special case for "for" since the style guide allows space before + # the semicolon there. + if re.search(r":\s*;\s*$", line): + error( + filename, + linenum, + "whitespace/semicolon", + 5, + "Semicolon defining empty statement. Use {} instead.", + ) + elif re.search(r"^\s*;\s*$", line): + error( + filename, + linenum, + "whitespace/semicolon", + 5, + "Line contains only semicolon. If this should be an empty statement, use {} instead.", + ) + elif re.search(r"\s+;\s*$", line) and not re.search(r"\bfor\b", line): + error( + filename, + linenum, + "whitespace/semicolon", + 5, + "Extra space before last semicolon. If this should be an empty " + "statement, use {} instead.", + ) + + +def IsDecltype(clean_lines, linenum, column): + """Check if the token ending on (linenum, column) is decltype(). + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: the number of the line to check. + column: end column of the token to check. + Returns: + True if this token is decltype() expression, False otherwise. + """ + (text, _, start_col) = ReverseCloseExpression(clean_lines, linenum, column) + if start_col < 0: + return False + return bool(re.search(r"\bdecltype\s*$", text[0:start_col])) + + +def CheckSectionSpacing(filename, clean_lines, class_info, linenum, error): + """Checks for additional blank line issues related to sections. + + Currently the only thing checked here is blank line before protected/private. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + class_info: A _ClassInfo objects. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + # Skip checks if the class is small, where small means 25 lines or less. + # 25 lines seems like a good cutoff since that's the usual height of + # terminals, and any class that can't fit in one screen can't really + # be considered "small". + # + # Also skip checks if we are on the first line. This accounts for + # classes that look like + # class Foo { public: ... }; + # + # If we didn't find the end of the class, last_line would be zero, + # and the check will be skipped by the first condition. + if ( + class_info.last_line - class_info.starting_linenum <= 24 + or linenum <= class_info.starting_linenum + ): + return + + matched = re.match(r"\s*(public|protected|private):", clean_lines.lines[linenum]) + if matched: + # Issue warning if the line before public/protected/private was + # not a blank line, but don't do this if the previous line contains + # "class" or "struct". This can happen two ways: + # - We are at the beginning of the class. + # - We are forward-declaring an inner class that is semantically + # private, but needed to be public for implementation reasons. + # Also ignores cases where the previous line ends with a backslash as can be + # common when defining classes in C macros. + prev_line = clean_lines.lines[linenum - 1] + if ( + not IsBlankLine(prev_line) + and not re.search(r"\b(class|struct)\b", prev_line) + and not re.search(r"\\$", prev_line) + ): + # Try a bit harder to find the beginning of the class. This is to + # account for multi-line base-specifier lists, e.g.: + # class Derived + # : public Base { + end_class_head = class_info.starting_linenum + for i in range(class_info.starting_linenum, linenum): + if re.search(r"\{\s*$", clean_lines.lines[i]): + end_class_head = i + break + if end_class_head < linenum - 1: + error( + filename, + linenum, + "whitespace/blank_line", + 3, + f'"{matched.group(1)}:" should be preceded by a blank line', + ) + + +def GetPreviousNonBlankLine(clean_lines, linenum): + """Return the most recent non-blank line and its line number. + + Args: + clean_lines: A CleansedLines instance containing the file contents. + linenum: The number of the line to check. + + Returns: + A tuple with two elements. The first element is the contents of the last + non-blank line before the current line, or the empty string if this is the + first non-blank line. The second is the line number of that line, or -1 + if this is the first non-blank line. + """ + + prevlinenum = linenum - 1 + while prevlinenum >= 0: + prevline = clean_lines.elided[prevlinenum] + if not IsBlankLine(prevline): # if not a blank line... + return (prevline, prevlinenum) + prevlinenum -= 1 + return ("", -1) def CheckBraces(filename, clean_lines, linenum, error): - """Looks for misplaced braces (e.g. at the end of line). - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - - line = clean_lines.elided[linenum] # get rid of comments and strings - - if re.match(r'\s*{\s*$', line): - # We allow an open brace to start a line in the case where someone is using - # braces in a block to explicitly create a new scope, which is commonly used - # to control the lifetime of stack-allocated variables. Braces are also - # used for brace initializers inside function calls. We don't detect this - # perfectly: we just don't complain if the last non-whitespace character on - # the previous non-blank line is ',', ';', ':', '(', '{', or '}', or if the - # previous line starts a preprocessor block. We also allow a brace on the - # following line if it is part of an array initialization and would not fit - # within the 80 character limit of the preceding line. - prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] - if (not re.search(r'[,;:}{(]\s*$', prevline) and - not re.match(r'\s*#', prevline) and - not (GetLineWidth(prevline) > _line_length - 2 and '[]' in prevline)): - error(filename, linenum, 'whitespace/braces', 4, - '{ should almost always be at the end of the previous line') - - # An else clause should be on the same line as the preceding closing brace. - if last_wrong := re.match(r'\s*else\b\s*(?:if\b|\{|$)', line): - prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] - if re.match(r'\s*}\s*$', prevline): - error(filename, linenum, 'whitespace/newline', 4, - 'An else should appear on the same line as the preceding }') - else: - last_wrong = False - - # If braces come on one side of an else, they should be on both. - # However, we have to worry about "else if" that spans multiple lines! - if re.search(r'else if\s*\(', line): # could be multi-line if - brace_on_left = bool(re.search(r'}\s*else if\s*\(', line)) - # find the ( after the if - pos = line.find('else if') - pos = line.find('(', pos) - if pos > 0: - (endline, _, endpos) = CloseExpression(clean_lines, linenum, pos) - brace_on_right = endline[endpos:].find('{') != -1 - if brace_on_left != brace_on_right: # must be brace after if - error(filename, linenum, 'readability/braces', 5, - 'If an else has a brace on one side, it should have it on both') - # Prevent detection if statement has { and we detected an improper newline after } - elif re.search(r'}\s*else[^{]*$', line) or (re.match(r'[^}]*else\s*{', line) and not last_wrong): - error(filename, linenum, 'readability/braces', 5, - 'If an else has a brace on one side, it should have it on both') - - # No control clauses with braces should have its contents on the same line - # Exclude } which will be covered by empty-block detect - # Exclude ; which may be used by while in a do-while - if keyword := re.search( - r'\b(else if|if|while|for|switch)' # These have parens - r'\s*\(.*\)\s*(?:\[\[(?:un)?likely\]\]\s*)?{\s*[^\s\\};]', line): - error(filename, linenum, 'whitespace/newline', 5, - f'Controlled statements inside brackets of {keyword.group(1)} clause' - ' should be on a separate line') - elif keyword := re.search( - r'\b(else|do|try)' # These don't have parens - r'\s*(?:\[\[(?:un)?likely\]\]\s*)?{\s*[^\s\\}]', line): - error(filename, linenum, 'whitespace/newline', 5, - f'Controlled statements inside brackets of {keyword.group(1)} clause' - ' should be on a separate line') - - # TODO: Err on if...else and do...while statements without braces; - # style guide has changed since the below comment was written - - # Check single-line if/else bodies. The style guide says 'curly braces are not - # required for single-line statements'. We additionally allow multi-line, - # single statements, but we reject anything with more than one semicolon in - # it. This means that the first semicolon after the if should be at the end of - # its line, and the line after that should have an indent level equal to or - # lower than the if. We also check for ambiguous if/else nesting without - # braces. - if_else_match = re.search(r'\b(if\s*(|constexpr)\s*\(|else\b)', line) - if if_else_match and not re.match(r'\s*#', line): - if_indent = GetIndentLevel(line) - endline, endlinenum, endpos = line, linenum, if_else_match.end() - if_match = re.search(r'\bif\s*(|constexpr)\s*\(', line) - if if_match: - # This could be a multiline if condition, so find the end first. - pos = if_match.end() - 1 - (endline, endlinenum, endpos) = CloseExpression(clean_lines, linenum, pos) - # Check for an opening brace, either directly after the if or on the next - # line. If found, this isn't a single-statement conditional. - if (not re.match(r'\s*(?:\[\[(?:un)?likely\]\]\s*)?{', endline[endpos:]) - and not (re.match(r'\s*$', endline[endpos:]) - and endlinenum < (len(clean_lines.elided) - 1) - and re.match(r'\s*{', clean_lines.elided[endlinenum + 1]))): - while (endlinenum < len(clean_lines.elided) - and ';' not in clean_lines.elided[endlinenum][endpos:]): - endlinenum += 1 - endpos = 0 - if endlinenum < len(clean_lines.elided): - endline = clean_lines.elided[endlinenum] - # We allow a mix of whitespace and closing braces (e.g. for one-liner - # methods) and a single \ after the semicolon (for macros) - endpos = endline.find(';') - if not re.match(r';[\s}]*(\\?)$', endline[endpos:]): - # Semicolon isn't the last character, there's something trailing. - # Output a warning if the semicolon is not contained inside - # a lambda expression. - if not re.match(r'^[^{};]*\[[^\[\]]*\][^{}]*\{[^{}]*\}\s*\)*[;,]\s*$', - endline): - error(filename, linenum, 'readability/braces', 4, - 'If/else bodies with multiple statements require braces') - elif endlinenum < len(clean_lines.elided) - 1: - # Make sure the next line is dedented - next_line = clean_lines.elided[endlinenum + 1] - next_indent = GetIndentLevel(next_line) - # With ambiguous nested if statements, this will error out on the - # if that *doesn't* match the else, regardless of whether it's the - # inner one or outer one. - if (if_match and re.match(r'\s*else\b', next_line) - and next_indent != if_indent): - error(filename, linenum, 'readability/braces', 4, - 'Else clause should be indented at the same level as if. ' - 'Ambiguous nested if/else chains require braces.') - elif next_indent > if_indent: - error(filename, linenum, 'readability/braces', 4, - 'If/else bodies with multiple statements require braces') + """Looks for misplaced braces (e.g. at the end of line). + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + + line = clean_lines.elided[linenum] # get rid of comments and strings + + if re.match(r"\s*{\s*$", line): + # We allow an open brace to start a line in the case where someone is using + # braces in a block to explicitly create a new scope, which is commonly used + # to control the lifetime of stack-allocated variables. Braces are also + # used for brace initializers inside function calls. We don't detect this + # perfectly: we just don't complain if the last non-whitespace character on + # the previous non-blank line is ',', ';', ':', '(', '{', or '}', or if the + # previous line starts a preprocessor block. We also allow a brace on the + # following line if it is part of an array initialization and would not fit + # within the 80 character limit of the preceding line. + prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] + if ( + not re.search(r"[,;:}{(]\s*$", prevline) + and not re.match(r"\s*#", prevline) + and not (GetLineWidth(prevline) > _line_length - 2 and "[]" in prevline) + ): + error( + filename, + linenum, + "whitespace/braces", + 4, + "{ should almost always be at the end of the previous line", + ) + + # An else clause should be on the same line as the preceding closing brace. + if last_wrong := re.match(r"\s*else\b\s*(?:if\b|\{|$)", line): + prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] + if re.match(r"\s*}\s*$", prevline): + error( + filename, + linenum, + "whitespace/newline", + 4, + "An else should appear on the same line as the preceding }", + ) + else: + last_wrong = False + + # If braces come on one side of an else, they should be on both. + # However, we have to worry about "else if" that spans multiple lines! + if re.search(r"else if\s*\(", line): # could be multi-line if + brace_on_left = bool(re.search(r"}\s*else if\s*\(", line)) + # find the ( after the if + pos = line.find("else if") + pos = line.find("(", pos) + if pos > 0: + (endline, _, endpos) = CloseExpression(clean_lines, linenum, pos) + brace_on_right = endline[endpos:].find("{") != -1 + if brace_on_left != brace_on_right: # must be brace after if + error( + filename, + linenum, + "readability/braces", + 5, + "If an else has a brace on one side, it should have it on both", + ) + # Prevent detection if statement has { and we detected an improper newline after } + elif re.search(r"}\s*else[^{]*$", line) or ( + re.match(r"[^}]*else\s*{", line) and not last_wrong + ): + error( + filename, + linenum, + "readability/braces", + 5, + "If an else has a brace on one side, it should have it on both", + ) + + # No control clauses with braces should have its contents on the same line + # Exclude } which will be covered by empty-block detect + # Exclude ; which may be used by while in a do-while + if ( + keyword := re.search( + r"\b(else if|if|while|for|switch)" # These have parens + r"\s*\(.*\)\s*(?:\[\[(?:un)?likely\]\]\s*)?{\s*[^\s\\};]", + line, + ) + ) or ( + keyword := re.search( + r"\b(else|do|try)" # These don't have parens + r"\s*(?:\[\[(?:un)?likely\]\]\s*)?{\s*[^\s\\}]", + line, + ) + ): + error( + filename, + linenum, + "whitespace/newline", + 5, + f"Controlled statements inside brackets of {keyword.group(1)} clause" + " should be on a separate line", + ) + + # TODO(aaronliu0130): Err on if...else and do...while statements without braces; + # style guide has changed since the below comment was written + + # Check single-line if/else bodies. The style guide says 'curly braces are not + # required for single-line statements'. We additionally allow multi-line, + # single statements, but we reject anything with more than one semicolon in + # it. This means that the first semicolon after the if should be at the end of + # its line, and the line after that should have an indent level equal to or + # lower than the if. We also check for ambiguous if/else nesting without + # braces. + if_else_match = re.search(r"\b(if\s*(|constexpr)\s*\(|else\b)", line) + if if_else_match and not re.match(r"\s*#", line): + if_indent = GetIndentLevel(line) + endline, endlinenum, endpos = line, linenum, if_else_match.end() + if_match = re.search(r"\bif\s*(|constexpr)\s*\(", line) + if if_match: + # This could be a multiline if condition, so find the end first. + pos = if_match.end() - 1 + (endline, endlinenum, endpos) = CloseExpression(clean_lines, linenum, pos) + # Check for an opening brace, either directly after the if or on the next + # line. If found, this isn't a single-statement conditional. + if not re.match(r"\s*(?:\[\[(?:un)?likely\]\]\s*)?{", endline[endpos:]) and not ( + re.match(r"\s*$", endline[endpos:]) + and endlinenum < (len(clean_lines.elided) - 1) + and re.match(r"\s*{", clean_lines.elided[endlinenum + 1]) + ): + while ( + endlinenum < len(clean_lines.elided) + and ";" not in clean_lines.elided[endlinenum][endpos:] + ): + endlinenum += 1 + endpos = 0 + if endlinenum < len(clean_lines.elided): + endline = clean_lines.elided[endlinenum] + # We allow a mix of whitespace and closing braces (e.g. for one-liner + # methods) and a single \ after the semicolon (for macros) + endpos = endline.find(";") + if not re.match(r";[\s}]*(\\?)$", endline[endpos:]): + # Semicolon isn't the last character, there's something trailing. + # Output a warning if the semicolon is not contained inside + # a lambda expression. + if not re.match(r"^[^{};]*\[[^\[\]]*\][^{}]*\{[^{}]*\}\s*\)*[;,]\s*$", endline): + error( + filename, + linenum, + "readability/braces", + 4, + "If/else bodies with multiple statements require braces", + ) + elif endlinenum < len(clean_lines.elided) - 1: + # Make sure the next line is dedented + next_line = clean_lines.elided[endlinenum + 1] + next_indent = GetIndentLevel(next_line) + # With ambiguous nested if statements, this will error out on the + # if that *doesn't* match the else, regardless of whether it's the + # inner one or outer one. + if if_match and re.match(r"\s*else\b", next_line) and next_indent != if_indent: + error( + filename, + linenum, + "readability/braces", + 4, + "Else clause should be indented at the same level as if. " + "Ambiguous nested if/else chains require braces.", + ) + elif next_indent > if_indent: + error( + filename, + linenum, + "readability/braces", + 4, + "If/else bodies with multiple statements require braces", + ) def CheckTrailingSemicolon(filename, clean_lines, linenum, error): - """Looks for redundant trailing semicolon. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - - line = clean_lines.elided[linenum] - - # Block bodies should not be followed by a semicolon. Due to C++11 - # brace initialization, there are more places where semicolons are - # required than not, so we explicitly list the allowed rules rather - # than listing the disallowed ones. These are the places where "};" - # should be replaced by just "}": - # 1. Some flavor of block following closing parenthesis: - # for (;;) {}; - # while (...) {}; - # switch (...) {}; - # Function(...) {}; - # if (...) {}; - # if (...) else if (...) {}; - # - # 2. else block: - # if (...) else {}; - # - # 3. const member function: - # Function(...) const {}; - # - # 4. Block following some statement: - # x = 42; - # {}; - # - # 5. Block at the beginning of a function: - # Function(...) { - # {}; - # } - # - # Note that naively checking for the preceding "{" will also match - # braces inside multi-dimensional arrays, but this is fine since - # that expression will not contain semicolons. - # - # 6. Block following another block: - # while (true) {} - # {}; - # - # 7. End of namespaces: - # namespace {}; - # - # These semicolons seems far more common than other kinds of - # redundant semicolons, possibly due to people converting classes - # to namespaces. For now we do not warn for this case. - # - # Try matching case 1 first. - match = re.match(r'^(.*\)\s*)\{', line) - if match: - # Matched closing parenthesis (case 1). Check the token before the - # matching opening parenthesis, and don't warn if it looks like a - # macro. This avoids these false positives: - # - macro that defines a base class - # - multi-line macro that defines a base class - # - macro that defines the whole class-head + """Looks for redundant trailing semicolon. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + + line = clean_lines.elided[linenum] + + # Block bodies should not be followed by a semicolon. Due to C++11 + # brace initialization, there are more places where semicolons are + # required than not, so we explicitly list the allowed rules rather + # than listing the disallowed ones. These are the places where "};" + # should be replaced by just "}": + # 1. Some flavor of block following closing parenthesis: + # for (;;) {}; + # while (...) {}; + # switch (...) {}; + # Function(...) {}; + # if (...) {}; + # if (...) else if (...) {}; + # + # 2. else block: + # if (...) else {}; + # + # 3. const member function: + # Function(...) const {}; + # + # 4. Block following some statement: + # x = 42; + # {}; + # + # 5. Block at the beginning of a function: + # Function(...) { + # {}; + # } + # + # Note that naively checking for the preceding "{" will also match + # braces inside multi-dimensional arrays, but this is fine since + # that expression will not contain semicolons. + # + # 6. Block following another block: + # while (true) {} + # {}; + # + # 7. End of namespaces: + # namespace {}; + # + # These semicolons seems far more common than other kinds of + # redundant semicolons, possibly due to people converting classes + # to namespaces. For now we do not warn for this case. + # + # Try matching case 1 first. + match = re.match(r"^(.*\)\s*)\{", line) + if match: + # Matched closing parenthesis (case 1). Check the token before the + # matching opening parenthesis, and don't warn if it looks like a + # macro. This avoids these false positives: + # - macro that defines a base class + # - multi-line macro that defines a base class + # - macro that defines the whole class-head + # + # But we still issue warnings for macros that we know are safe to + # warn, specifically: + # - TEST, TEST_F, TEST_P, MATCHER, MATCHER_P + # - TYPED_TEST + # - INTERFACE_DEF + # - EXCLUSIVE_LOCKS_REQUIRED, SHARED_LOCKS_REQUIRED, LOCKS_EXCLUDED: + # + # We implement a list of safe macros instead of a list of + # unsafe macros, even though the latter appears less frequently in + # google code and would have been easier to implement. This is because + # the downside for getting the allowed checks wrong means some extra + # semicolons, while the downside for getting disallowed checks wrong + # would result in compile errors. + # + # In addition to macros, we also don't want to warn on + # - Compound literals + # - Lambdas + # - alignas specifier with anonymous structs + # - decltype + # - concepts (requires expression) + closing_brace_pos = match.group(1).rfind(")") + opening_parenthesis = ReverseCloseExpression(clean_lines, linenum, closing_brace_pos) + if opening_parenthesis[2] > -1: + line_prefix = opening_parenthesis[0][0 : opening_parenthesis[2]] + macro = re.search(r"\b([A-Z_][A-Z0-9_]*)\s*$", line_prefix) + func = re.match(r"^(.*\])\s*$", line_prefix) + if ( + ( + macro + and macro.group(1) + not in ( + "TEST", + "TEST_F", + "MATCHER", + "MATCHER_P", + "TYPED_TEST", + "EXCLUSIVE_LOCKS_REQUIRED", + "SHARED_LOCKS_REQUIRED", + "LOCKS_EXCLUDED", + "INTERFACE_DEF", + ) + ) + or (func and not re.search(r"\boperator\s*\[\s*\]", func.group(1))) + or re.search(r"\b(?:struct|union)\s+alignas\s*$", line_prefix) + or re.search(r"\bdecltype$", line_prefix) + or re.search(r"\brequires.*$", line_prefix) + or re.search(r"\s+=\s*$", line_prefix) + ): + match = None + if ( + match + and opening_parenthesis[1] > 1 + and re.search(r"\]\s*$", clean_lines.elided[opening_parenthesis[1] - 1]) + ): + # Multi-line lambda-expression + match = None + + else: + # Try matching cases 2-3. + match = re.match(r"^(.*(?:else|\)\s*const)\s*)\{", line) + if not match: + # Try matching cases 4-6. These are always matched on separate lines. + # + # Note that we can't simply concatenate the previous line to the + # current line and do a single match, otherwise we may output + # duplicate warnings for the blank line case: + # if (cond) { + # // blank line + # } + prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] + if prevline and re.search(r"[;{}]\s*$", prevline): + match = re.match(r"^(\s*)\{", line) + + # Check matching closing brace + if match: + (endline, endlinenum, endpos) = CloseExpression(clean_lines, linenum, len(match.group(1))) + if endpos > -1 and re.match(r"^\s*;", endline[endpos:]): + # Current {} pair is eligible for semicolon check, and we have found + # the redundant semicolon, output warning here. + # + # Note: because we are scanning forward for opening braces, and + # outputting warnings for the matching closing brace, if there are + # nested blocks with trailing semicolons, we will get the error + # messages in reversed order. + + # We need to check the line forward for NOLINT + raw_lines = clean_lines.raw_lines + ParseNolintSuppressions(filename, raw_lines[endlinenum - 1], endlinenum - 1, error) + ParseNolintSuppressions(filename, raw_lines[endlinenum], endlinenum, error) + + error(filename, endlinenum, "readability/braces", 4, "You don't need a ; after a }") + + +def CheckEmptyBlockBody(filename, clean_lines, linenum, error): + """Look for empty loop/conditional body with only a single semicolon. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + + # Search for loop keywords at the beginning of the line. Because only + # whitespaces are allowed before the keywords, this will also ignore most + # do-while-loops, since those lines should start with closing brace. + # + # We also check "if" blocks here, since an empty conditional block + # is likely an error. + line = clean_lines.elided[linenum] + if matched := re.match(r"\s*(for|while|if)\s*\(", line): + # Find the end of the conditional expression. + (end_line, end_linenum, end_pos) = CloseExpression(clean_lines, linenum, line.find("(")) + + # Output warning if what follows the condition expression is a semicolon. + # No warning for all other cases, including whitespace or newline, since we + # have a separate check for semicolons preceded by whitespace. + if end_pos >= 0 and re.match(r";", end_line[end_pos:]): + if matched.group(1) == "if": + error( + filename, + end_linenum, + "whitespace/empty_conditional_body", + 5, + "Empty conditional bodies should use {}", + ) + else: + error( + filename, + end_linenum, + "whitespace/empty_loop_body", + 5, + "Empty loop bodies should use {} or continue", + ) + + # Check for if statements that have completely empty bodies (no comments) + # and no else clauses. + if end_pos >= 0 and matched.group(1) == "if": + # Find the position of the opening { for the if statement. + # Return without logging an error if it has no brackets. + opening_linenum = end_linenum + opening_line_fragment = end_line[end_pos:] + # Loop until EOF or find anything that's not whitespace or opening {. + while not re.search(r"^\s*\{", opening_line_fragment): + if re.search(r"^(?!\s*$)", opening_line_fragment): + # Conditional has no brackets. + return + opening_linenum += 1 + if opening_linenum == len(clean_lines.elided): + # Couldn't find conditional's opening { or any code before EOF. + return + opening_line_fragment = clean_lines.elided[opening_linenum] + # Set opening_line (opening_line_fragment may not be entire opening line). + opening_line = clean_lines.elided[opening_linenum] + + # Find the position of the closing }. + opening_pos = opening_line_fragment.find("{") + if opening_linenum == end_linenum: + # We need to make opening_pos relative to the start of the entire line. + opening_pos += end_pos + (closing_line, closing_linenum, closing_pos) = CloseExpression( + clean_lines, opening_linenum, opening_pos + ) + if closing_pos < 0: + return + + # Now construct the body of the conditional. This consists of the portion + # of the opening line after the {, all lines until the closing line, + # and the portion of the closing line before the }. + if clean_lines.raw_lines[opening_linenum] != CleanseComments( + clean_lines.raw_lines[opening_linenum] + ): + # Opening line ends with a comment, so conditional isn't empty. + return + if closing_linenum > opening_linenum: + # Opening line after the {. Ignore comments here since we checked above. + bodylist = list(opening_line[opening_pos + 1 :]) + # All lines until closing line, excluding closing line, with comments. + bodylist.extend(clean_lines.raw_lines[opening_linenum + 1 : closing_linenum]) + # Closing line before the }. Won't (and can't) have comments. + bodylist.append(clean_lines.elided[closing_linenum][: closing_pos - 1]) + body = "\n".join(bodylist) + else: + # If statement has brackets and fits on a single line. + body = opening_line[opening_pos + 1 : closing_pos - 1] + + # Check if the body is empty + if not _EMPTY_CONDITIONAL_BODY_PATTERN.search(body): + return + # The body is empty. Now make sure there's not an else clause. + current_linenum = closing_linenum + current_line_fragment = closing_line[closing_pos:] + # Loop until EOF or find anything that's not whitespace or else clause. + while re.search(r"^\s*$|^(?=\s*else)", current_line_fragment): + if re.search(r"^(?=\s*else)", current_line_fragment): + # Found an else clause, so don't log an error. + return + current_linenum += 1 + if current_linenum == len(clean_lines.elided): + break + current_line_fragment = clean_lines.elided[current_linenum] + + # The body is empty and there's no else clause until EOF or other code. + error( + filename, + end_linenum, + "whitespace/empty_if_body", + 4, + ("If statement had no body and no else clause"), + ) + + +def FindCheckMacro(line): + """Find a replaceable CHECK-like macro. + + Args: + line: line to search on. + Returns: + (macro name, start position), or (None, -1) if no replaceable + macro is found. + """ + for macro in _CHECK_MACROS: + i = line.find(macro) + if i >= 0: + # Find opening parenthesis. Do a regular expression match here + # to make sure that we are matching the expected CHECK macro, as + # opposed to some other macro that happens to contain the CHECK + # substring. + matched = re.match(r"^(.*\b" + macro + r"\s*)\(", line) + if not matched: + continue + return (macro, len(matched.group(1))) + return (None, -1) + + +def CheckCheck(filename, clean_lines, linenum, error): + """Checks the use of CHECK and EXPECT macros. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + + # Decide the set of replacement macros that should be suggested + lines = clean_lines.elided + (check_macro, start_pos) = FindCheckMacro(lines[linenum]) + if not check_macro: + return + + # Find end of the boolean expression by matching parentheses + (last_line, end_line, end_pos) = CloseExpression(clean_lines, linenum, start_pos) + if end_pos < 0: + return + + # If the check macro is followed by something other than a + # semicolon, assume users will log their own custom error messages + # and don't suggest any replacements. + if not re.match(r"\s*;", last_line[end_pos:]): + return + + if linenum == end_line: + expression = lines[linenum][start_pos + 1 : end_pos - 1] + else: + expression = lines[linenum][start_pos + 1 :] + for i in range(linenum + 1, end_line): + expression += lines[i] + expression += last_line[0 : end_pos - 1] + + # Parse expression so that we can take parentheses into account. + # This avoids false positives for inputs like "CHECK((a < 4) == b)", + # which is not replaceable by CHECK_LE. + lhs = "" + rhs = "" + operator = None + while expression: + matched = re.match( + r"^\s*(<<|<<=|>>|>>=|->\*|->|&&|\|\||" + r"==|!=|>=|>|<=|<|\()(.*)$", + expression, + ) + if matched: + token = matched.group(1) + if token == "(": + # Parenthesized operand + expression = matched.group(2) + (end, _) = FindEndOfExpressionInLine(expression, 0, ["("]) + if end < 0: + return # Unmatched parenthesis + lhs += "(" + expression[0:end] + expression = expression[end:] + elif token in ("&&", "||"): + # Logical and/or operators. This means the expression + # contains more than one term, for example: + # CHECK(42 < a && a < b); + # + # These are not replaceable with CHECK_LE, so bail out early. + return + elif token in ("<<", "<<=", ">>", ">>=", "->*", "->"): + # Non-relational operator + lhs += token + expression = matched.group(2) + else: + # Relational operator + operator = token + rhs = matched.group(2) + break + else: + # Unparenthesized operand. Instead of appending to lhs one character + # at a time, we do another regular expression match to consume several + # characters at once if possible. Trivial benchmark shows that this + # is more efficient when the operands are longer than a single + # character, which is generally the case. + matched = re.match(r"^([^-=!<>()&|]+)(.*)$", expression) + if not matched: + matched = re.match(r"^(\s*\S)(.*)$", expression) + if not matched: + break + lhs += matched.group(1) + expression = matched.group(2) + + # Only apply checks if we got all parts of the boolean expression + if not (lhs and operator and rhs): + return + + # Check that rhs do not contain logical operators. We already know + # that lhs is fine since the loop above parses out && and ||. + if rhs.find("&&") > -1 or rhs.find("||") > -1: + return + + # At least one of the operands must be a constant literal. This is + # to avoid suggesting replacements for unprintable things like + # CHECK(variable != iterator) + # + # The following pattern matches decimal, hex integers, strings, and + # characters (in that order). + lhs = lhs.strip() + rhs = rhs.strip() + match_constant = r'^([-+]?(\d+|0[xX][0-9a-fA-F]+)[lLuU]{0,3}|".*"|\'.*\')$' + if re.match(match_constant, lhs) or re.match(match_constant, rhs): + # Note: since we know both lhs and rhs, we can provide a more + # descriptive error message like: + # Consider using CHECK_EQ(x, 42) instead of CHECK(x == 42) + # Instead of: + # Consider using CHECK_EQ instead of CHECK(a == b) + # + # We are still keeping the less descriptive message because if lhs + # or rhs gets long, the error message might become unreadable. + error( + filename, + linenum, + "readability/check", + 2, + f"Consider using {_CHECK_REPLACEMENT[check_macro][operator]}" + f" instead of {check_macro}(a {operator} b)", + ) + + +def CheckAltTokens(filename, clean_lines, linenum, error): + """Check alternative keywords being used in boolean expressions. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Avoid preprocessor lines + if re.match(r"^\s*#", line): + return + + # Last ditch effort to avoid multi-line comments. This will not help + # if the comment started before the current line or ended after the + # current line, but it catches most of the false positives. At least, + # it provides a way to workaround this warning for people who use + # multi-line comments in preprocessor macros. + # + # TODO(google): remove this once cpplint has better support for + # multi-line comments. + if line.find("/*") >= 0 or line.find("*/") >= 0: + return + + for match in _ALT_TOKEN_REPLACEMENT_PATTERN.finditer(line): + error( + filename, + linenum, + "readability/alt_tokens", + 2, + f"Use operator {_ALT_TOKEN_REPLACEMENT[match.group(2)]} instead of {match.group(2)}", + ) + + +def GetLineWidth(line): + """Determines the width of the line in column positions. + + Args: + line: A string, which may be a Unicode string. + + Returns: + The width of the line in column positions, accounting for Unicode + combining characters and wide characters. + """ + if isinstance(line, str): + width = 0 + for uc in unicodedata.normalize("NFC", line): + if unicodedata.east_asian_width(uc) in ("W", "F"): + width += 2 + elif not unicodedata.combining(uc): + # Issue 337 + # https://mail.python.org/pipermail/python-list/2012-August/628809.html + if (sys.version_info.major, sys.version_info.minor) <= (3, 2): + # https://github.com/python/cpython/blob/2.7/Include/unicodeobject.h#L81 + is_wide_build = sysconfig.get_config_var("Py_UNICODE_SIZE") >= 4 + # https://github.com/python/cpython/blob/2.7/Objects/unicodeobject.c#L564 + is_low_surrogate = 0xDC00 <= ord(uc) <= 0xDFFF + if not is_wide_build and is_low_surrogate: + width -= 1 + + width += 1 + return width + return len(line) + + +def CheckStyle(filename, clean_lines, linenum, file_extension, nesting_state, error, cppvar=None): + """Checks rules from the 'C++ style rules' section of cppguide.html. + + Most of these rules are hard to test (naming, comment style), but we + do what we can. In particular we check for 2-space indents, line lengths, + tab usage, spaces inside code, etc. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + file_extension: The extension (without the dot) of the filename. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + cppvar: The header guard variable returned by GetHeaderGuardCPPVar. + """ + + # Don't use "elided" lines here, otherwise we can't check commented lines. + # Don't want to use "raw" either, because we don't want to check inside C++11 + # raw strings, + raw_lines = clean_lines.lines_without_raw_strings + line = raw_lines[linenum] + prev = raw_lines[linenum - 1] if linenum > 0 else "" + + if line.find("\t") != -1: + error(filename, linenum, "whitespace/tab", 1, "Tab found; better to use spaces") + + # One or three blank spaces at the beginning of the line is weird; it's + # hard to reconcile that with 2-space indents. + # NOTE: here are the conditions rob pike used for his tests. Mine aren't + # as sophisticated, but it may be worth becoming so: RLENGTH==initial_spaces + # if(RLENGTH > 20) complain = 0; + # if(match($0, " +(error|private|public|protected):")) complain = 0; + # if(match(prev, "&& *$")) complain = 0; + # if(match(prev, "\\|\\| *$")) complain = 0; + # if(match(prev, "[\",=><] *$")) complain = 0; + # if(match($0, " <<")) complain = 0; + # if(match(prev, " +for \\(")) complain = 0; + # if(prevodd && match(prevprev, " +for \\(")) complain = 0; + scope_or_label_pattern = r"\s*(?:public|private|protected|signals)(?:\s+(?:slots\s*)?)?:\s*\\?$" + classinfo = nesting_state.InnermostClass() + initial_spaces = 0 + cleansed_line = clean_lines.elided[linenum] + while initial_spaces < len(line) and line[initial_spaces] == " ": + initial_spaces += 1 + # There are certain situations we allow one space, notably for + # section labels, and also lines containing multi-line raw strings. + # We also don't check for lines that look like continuation lines + # (of lines ending in double quotes, commas, equals, or angle brackets) + # because the rules for how to indent those are non-trivial. + if ( + not re.search(r'[",=><] *$', prev) + and (initial_spaces in {1, 3}) + and not re.match(scope_or_label_pattern, cleansed_line) + and not (clean_lines.raw_lines[linenum] != line and re.match(r'^\s*""', line)) + ): + error( + filename, + linenum, + "whitespace/indent", + 3, + "Weird number of spaces at line-start. Are you using a 2-space indent?", + ) + + if line and line[-1].isspace(): + error( + filename, + linenum, + "whitespace/end_of_line", + 4, + "Line ends in whitespace. Consider deleting these extra spaces.", + ) + + # Check if the line is a header guard. + is_header_guard = IsHeaderExtension(file_extension) and line.startswith( + (f"#ifndef {cppvar}", f"#define {cppvar}", f"#endif // {cppvar}") + ) + # #include lines and header guards can be long, since there's no clean way to + # split them. + # + # URLs can be long too. It's possible to split these, but it makes them + # harder to cut&paste. + # + # The "$Id:...$" comment may also get very long without it being the + # developers fault. + # + # Doxygen documentation copying can get pretty long when using an overloaded + # function declaration + if ( + not line.startswith("#include") + and not is_header_guard + and not re.match(r"^\s*//.*http(s?)://\S*$", line) + and not re.match(r"^\s*//\s*[^\s]*$", line) + and not re.match(r"^// \$Id:.*#[0-9]+ \$$", line) + and not re.match(r"^\s*/// [@\\](copydoc|copydetails|copybrief) .*$", line) + ): + line_width = GetLineWidth(line) + if line_width > _line_length: + error( + filename, + linenum, + "whitespace/line_length", + 2, + f"Lines should be <= {_line_length} characters long", + ) + + if ( + cleansed_line.count(";") > 1 + and + # allow simple single line lambdas + not re.match(r"^[^{};]*\[[^\[\]]*\][^{}]*\{[^{}\n\r]*\}", line) + and + # for loops are allowed two ;'s (and may run over two lines). + cleansed_line.find("for") == -1 + and ( + GetPreviousNonBlankLine(clean_lines, linenum)[0].find("for") == -1 + or GetPreviousNonBlankLine(clean_lines, linenum)[0].find(";") != -1 + ) + and + # It's ok to have many commands in a switch case that fits in 1 line + not ( + (cleansed_line.find("case ") != -1 or cleansed_line.find("default:") != -1) + and cleansed_line.find("break;") != -1 + ) + ): + error(filename, linenum, "whitespace/newline", 0, "More than one command on the same line") + + # Some more style checks + CheckBraces(filename, clean_lines, linenum, error) + CheckTrailingSemicolon(filename, clean_lines, linenum, error) + CheckEmptyBlockBody(filename, clean_lines, linenum, error) + CheckSpacing(filename, clean_lines, linenum, nesting_state, error) + CheckOperatorSpacing(filename, clean_lines, linenum, error) + CheckParenthesisSpacing(filename, clean_lines, linenum, error) + CheckCommaSpacing(filename, clean_lines, linenum, error) + CheckBracesSpacing(filename, clean_lines, linenum, nesting_state, error) + CheckSpacingForFunctionCall(filename, clean_lines, linenum, error) + CheckCheck(filename, clean_lines, linenum, error) + CheckAltTokens(filename, clean_lines, linenum, error) + classinfo = nesting_state.InnermostClass() + if classinfo: + CheckSectionSpacing(filename, clean_lines, classinfo, linenum, error) + + +_RE_PATTERN_INCLUDE = re.compile(r'^\s*#\s*include\s*([<"])([^>"]*)[>"].*$') +# Matches the first component of a filename delimited by -s and _s. That is: +# _RE_FIRST_COMPONENT.match('foo').group(0) == 'foo' +# _RE_FIRST_COMPONENT.match('foo.cc').group(0) == 'foo' +# _RE_FIRST_COMPONENT.match('foo-bar_baz.cc').group(0) == 'foo' +# _RE_FIRST_COMPONENT.match('foo_bar-baz.cc').group(0) == 'foo' +_RE_FIRST_COMPONENT = re.compile(r"^[^-_.]+") + + +def _DropCommonSuffixes(filename): + """Drops common suffixes like _test.cc or -inl.h from filename. + + For example: + >>> _DropCommonSuffixes('foo/foo-inl.h') + 'foo/foo' + >>> _DropCommonSuffixes('foo/bar/foo.cc') + 'foo/bar/foo' + >>> _DropCommonSuffixes('foo/foo_internal.h') + 'foo/foo' + >>> _DropCommonSuffixes('foo/foo_unusualinternal.h') + 'foo/foo_unusualinternal' + + Args: + filename: The input filename. + + Returns: + The filename with the common suffix removed. + """ + for suffix in itertools.chain( + ( + f"{test_suffix.lstrip('_')}.{ext}" + for test_suffix, ext in itertools.product(_test_suffixes, GetNonHeaderExtensions()) + ), + ( + f"{suffix}.{ext}" + for suffix, ext in itertools.product(["inl", "imp", "internal"], GetHeaderExtensions()) + ), + ): + if ( + filename.endswith(suffix) + and len(filename) > len(suffix) + and filename[-len(suffix) - 1] in ("-", "_") + ): + return filename[: -len(suffix) - 1] + return os.path.splitext(filename)[0] + + +def _ClassifyInclude(fileinfo, include, used_angle_brackets, include_order="default"): + """Figures out what kind of header 'include' is. + + Args: + fileinfo: The current file cpplint is running over. A FileInfo instance. + include: The path to a #included file. + used_angle_brackets: True if the #include used <> rather than "". + include_order: "default" or other value allowed in program arguments + + Returns: + One of the _XXX_HEADER constants. + + For example: + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'stdio.h', True) + _C_SYS_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'string', True) + _CPP_SYS_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', True, "standardcfirst") + _OTHER_SYS_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', False) + _LIKELY_MY_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo_unknown_extension.cc'), + ... 'bar/foo_other_ext.h', False) + _POSSIBLE_MY_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/bar.h', False) + _OTHER_HEADER + """ + # This is a list of all standard c++ header files, except + # those already checked for above. + is_cpp_header = include in _CPP_HEADERS + + # Mark include as C header if in list or in a known folder for standard-ish C headers. + is_std_c_header = (include_order == "default") or ( + include in _C_HEADERS + # additional linux glibc header folders + or re.search(rf"(?:{'|'.join(C_STANDARD_HEADER_FOLDERS)})\/.*\.h", include) + ) + + # Headers with C++ extensions shouldn't be considered C system headers + include_ext = os.path.splitext(include)[1] + is_system = used_angle_brackets and include_ext not in [".hh", ".hpp", ".hxx", ".h++"] + + if is_system: + if is_cpp_header: + return _CPP_SYS_HEADER + if is_std_c_header: + return _C_SYS_HEADER + return _OTHER_SYS_HEADER + + # If the target file and the include we're checking share a + # basename when we drop common extensions, and the include + # lives in . , then it's likely to be owned by the target file. + target_dir, target_base = os.path.split(_DropCommonSuffixes(fileinfo.RepositoryName())) + include_dir, include_base = os.path.split(_DropCommonSuffixes(include)) + target_dir_pub = os.path.normpath(target_dir + "/../public") + target_dir_pub = target_dir_pub.replace("\\", "/") + if target_base == include_base and (include_dir in (target_dir, target_dir_pub)): + return _LIKELY_MY_HEADER + + # If the target and include share some initial basename + # component, it's possible the target is implementing the + # include, so it's allowed to be first, but we'll never + # complain if it's not there. + target_first_component = _RE_FIRST_COMPONENT.match(target_base) + include_first_component = _RE_FIRST_COMPONENT.match(include_base) + if ( + target_first_component + and include_first_component + and target_first_component.group(0) == include_first_component.group(0) + ): + return _POSSIBLE_MY_HEADER + + return _OTHER_HEADER + + +def CheckIncludeLine(filename, clean_lines, linenum, include_state, error): + """Check rules that are applicable to #include lines. + + Strings on #include lines are NOT removed from elided line, to make + certain tasks easier. However, to prevent false positives, checks + applicable to #include lines in CheckLanguage must be put here. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + include_state: An _IncludeState instance in which the headers are inserted. + error: The function to call with any errors found. + """ + fileinfo = FileInfo(filename) + line = clean_lines.lines[linenum] + + # "include" should use the new style "foo/bar.h" instead of just "bar.h" + # Only do this check if the included header follows google naming + # conventions. If not, assume that it's a 3rd party API that + # requires special include conventions. + # + # We also make an exception for Lua headers, which follow google + # naming convention but not the include convention. + match = re.match(r'#include\s*"([^/]+\.(.*))"', line) + if ( + match + and IsHeaderExtension(match.group(2)) + and not _THIRD_PARTY_HEADERS_PATTERN.match(match.group(1)) + ): + error( + filename, + linenum, + "build/include_subdir", + 4, + "Include the directory when naming header files", + ) + + # we shouldn't include a file more than once. actually, there are a + # handful of instances where doing so is okay, but in general it's + # not. + match = _RE_PATTERN_INCLUDE.search(line) + if match: + include = match.group(2) + used_angle_brackets = match.group(1) == "<" + duplicate_line = include_state.FindHeader(include) + if duplicate_line >= 0: + error( + filename, + linenum, + "build/include", + 4, + f'"{include}" already included at {filename}:{duplicate_line}', + ) + return + + for extension in GetNonHeaderExtensions(): + if include.endswith("." + extension) and os.path.dirname( + fileinfo.RepositoryName() + ) != os.path.dirname(include): + error( + filename, + linenum, + "build/include", + 4, + "Do not include ." + extension + " files from other packages", + ) + return + + # We DO want to include a 3rd party looking header if it matches the + # filename. Otherwise we get an erroneous error "...should include its + # header" error later. + third_src_header = False + for ext in GetHeaderExtensions(): + basefilename = filename[0 : len(filename) - len(fileinfo.Extension())] + headerfile = basefilename + "." + ext + headername = FileInfo(headerfile).RepositoryName() + if headername in include or include in headername: + third_src_header = True + break + + if third_src_header or not _THIRD_PARTY_HEADERS_PATTERN.match(include): + include_state.include_list[-1].append((include, linenum)) + + # We want to ensure that headers appear in the right order: + # 1) for foo.cc, foo.h (preferred location) + # 2) c system files + # 3) cpp system files + # 4) for foo.cc, foo.h (deprecated location) + # 5) other google headers + # + # We classify each include statement as one of those 5 types + # using a number of techniques. The include_state object keeps + # track of the highest type seen, and complains if we see a + # lower type after that. + error_message = include_state.CheckNextIncludeOrder( + _ClassifyInclude(fileinfo, include, used_angle_brackets, _include_order) + ) + if error_message: + error( + filename, + linenum, + "build/include_order", + 4, + f"{error_message}. Should be: {fileinfo.BaseName()}.h, c system," + " c++ system, other.", + ) + canonical_include = include_state.CanonicalizeAlphabeticalOrder(include) + if not include_state.IsInAlphabeticalOrder(clean_lines, linenum, canonical_include): + error( + filename, + linenum, + "build/include_alpha", + 4, + f'Include "{include}" not in alphabetical order', + ) + include_state.SetLastHeader(canonical_include) + + +def _GetTextInside(text, start_pattern): + r"""Retrieves all the text between matching open and close parentheses. + + Given a string of lines and a regular expression string, retrieve all the text + following the expression and between opening punctuation symbols like + (, [, or {, and the matching close-punctuation symbol. This properly nested + occurrences of the punctuation, so for the text like + printf(a(), b(c())); + a call to _GetTextInside(text, r'printf\(') will return 'a(), b(c())'. + start_pattern must match string having an open punctuation symbol at the end. + + Args: + text: The lines to extract text. Its comments and strings must be elided. + It can be single line and can span multiple lines. + start_pattern: The regexp string indicating where to start extracting + the text. + Returns: + The extracted text. + None if either the opening string or ending punctuation could not be found. + """ + # TODO(google): Audit cpplint.py to see what places could be profitably + # rewritten to use _GetTextInside (and use inferior regexp matching today). + + # Give opening punctuation to get the matching close-punctuation. + matching_punctuation = {"(": ")", "{": "}", "[": "]"} + closing_punctuation = set(dict.values(matching_punctuation)) + + # Find the position to start extracting text. + match = re.search(start_pattern, text, re.MULTILINE) + if not match: # start_pattern not found in text. + return None + start_position = match.end(0) + + assert start_position > 0, "start_pattern must ends with an opening punctuation." + assert text[start_position - 1] in matching_punctuation, ( + "start_pattern must ends with an opening punctuation." + ) + # Stack of closing punctuation we expect to have in text after position. + punctuation_stack = [matching_punctuation[text[start_position - 1]]] + position = start_position + while punctuation_stack and position < len(text): + if text[position] == punctuation_stack[-1]: + punctuation_stack.pop() + elif text[position] in closing_punctuation: + # A closing punctuation without matching opening punctuation. + return None + elif text[position] in matching_punctuation: + punctuation_stack.append(matching_punctuation[text[position]]) + position += 1 + if punctuation_stack: + # Opening punctuation left without matching close-punctuation. + return None + # punctuation match. + return text[start_position : position - 1] + + +# Patterns for matching call-by-reference parameters. +# +# Supports nested templates up to 2 levels deep using this messy pattern: +# < (?: < (?: < [^<>]* +# > +# | [^<>] )* +# > +# | [^<>] )* +# > +_RE_PATTERN_IDENT = r"[_a-zA-Z]\w*" # =~ [[:alpha:]][[:alnum:]]* +_RE_PATTERN_TYPE = ( + r"(?:const\s+)?(?:typename\s+|class\s+|struct\s+|union\s+|enum\s+)?" + r"(?:\w|" + r"\s*<(?:<(?:<[^<>]*>|[^<>])*>|[^<>])*>|" + r"::)+" +) +# A call-by-reference parameter ends with '& identifier'. +_RE_PATTERN_REF_PARAM = re.compile( + r"(" + _RE_PATTERN_TYPE + r"(?:\s*(?:\bconst\b|[*]))*\s*" + r"&\s*" + _RE_PATTERN_IDENT + r")\s*(?:=[^,()]+)?[,)]" +) +# A call-by-const-reference parameter either ends with 'const& identifier' +# or looks like 'const type& identifier' when 'type' is atomic. +_RE_PATTERN_CONST_REF_PARAM = ( + r"(?:.*\s*\bconst\s*&\s*" + + _RE_PATTERN_IDENT + + r"|const\s+" + + _RE_PATTERN_TYPE + + r"\s*&\s*" + + _RE_PATTERN_IDENT + + r")" +) +# Stream types. +_RE_PATTERN_REF_STREAM_PARAM = r"(?:.*stream\s*&\s*" + _RE_PATTERN_IDENT + r")" + + +def CheckLanguage( + filename, clean_lines, linenum, file_extension, include_state, nesting_state, error +): + """Checks rules from the 'C++ language rules' section of cppguide.html. + + Some of these rules are hard to test (function overloading, using + uint32_t inappropriately), but we do the best we can. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + file_extension: The extension (without the dot) of the filename. + include_state: An _IncludeState instance in which the headers are inserted. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + # If the line is empty or consists of entirely a comment, no need to + # check it. + line = clean_lines.elided[linenum] + if not line: + return + + match = _RE_PATTERN_INCLUDE.search(line) + if match: + CheckIncludeLine(filename, clean_lines, linenum, include_state, error) + return + + # Reset include state across preprocessor directives. This is meant + # to silence warnings for conditional includes. + match = re.match(r"^\s*#\s*(if|ifdef|ifndef|elif|else|endif)\b", line) + if match: + include_state.ResetSection(match.group(1)) + + # Perform other checks now that we are sure that this is not an include line + CheckCasts(filename, clean_lines, linenum, error) + CheckGlobalStatic(filename, clean_lines, linenum, error) + CheckPrintf(filename, clean_lines, linenum, error) + + if IsHeaderExtension(file_extension): + # TODO(google): check that 1-arg constructors are explicit. + # How to tell it's a constructor? + # (handled in CheckForNonStandardConstructs for now) + # TODO(google): check that classes declare or disable copy/assign + # (level 1 error) + pass + + # Check if people are using the verboten C basic types. The only exception + # we regularly allow is "unsigned short port" for port. + if re.search(r"\bshort port\b", line): + if not re.search(r"\bunsigned short port\b", line): + error( + filename, linenum, "runtime/int", 4, 'Use "unsigned short" for ports, not "short"' + ) + else: + match = re.search(r"\b(short|long(?! +double)|long long)\b", line) + if match: + error( + filename, + linenum, + "runtime/int", + 4, + f"Use int16_t/int64_t/etc, rather than the C type {match.group(1)}", + ) + + # Check if some verboten operator overloading is going on + # TODO(google): catch out-of-line unary operator&: + # class X {}; + # int operator&(const X& x) { return 42; } // unary operator& + # The trick is it's hard to tell apart from binary operator&: + # class Y { int operator&(const Y& x) { return 23; } }; // binary operator& + if re.search(r"\boperator\s*&\s*\(\s*\)", line): + error( + filename, + linenum, + "runtime/operator", + 4, + "Unary operator& is dangerous. Do not use it.", + ) + + # Check for suspicious usage of "if" like + # } if (a == b) { + if re.search(r"\}\s*if\s*\(", line): + error( + filename, + linenum, + "readability/braces", + 4, + 'Did you mean "else if"? If not, start a new line for "if".', + ) + + # Check for potential format string bugs like printf(foo). + # We constrain the pattern not to pick things like DocidForPrintf(foo). + # Not perfect but it can catch printf(foo.c_str()) and printf(foo->c_str()) + # TODO(google): Catch the following case. Need to change the calling + # convention of the whole function to process multiple line to handle it. + # printf( + # boy_this_is_a_really_long_variable_that_cannot_fit_on_the_prev_line); + if printf_args := _GetTextInside(line, r"(?i)\b(string)?printf\s*\("): + match = re.match(r"([\w.\->()]+)$", printf_args) + if match and match.group(1) != "__VA_ARGS__": + function_name = re.search(r"\b((?:string)?printf)\s*\(", line, re.IGNORECASE).group(1) + error( + filename, + linenum, + "runtime/printf", + 4, + f'Potential format string bug. Do {function_name}("%s", {match.group(1)}) instead.', + ) + + # Check for potential memset bugs like memset(buf, sizeof(buf), 0). + match = re.search(r"memset\s*\(([^,]*),\s*([^,]*),\s*0\s*\)", line) + if match and not re.match(r"^''|-?[0-9]+|0x[0-9A-Fa-f]$", match.group(2)): + error( + filename, + linenum, + "runtime/memset", + 4, + f'Did you mean "memset({match.group(1)}, 0, {match.group(2)})"?', + ) + + if re.search(r"\busing namespace\b", line): + if re.search(r"\bliterals\b", line): + error( + filename, + linenum, + "build/namespaces_literals", + 5, + "Do not use namespace using-directives. Use using-declarations instead.", + ) + else: + error( + filename, + linenum, + "build/namespaces", + 5, + "Do not use namespace using-directives. Use using-declarations instead.", + ) + + # Detect variable-length arrays. + match = re.match(r"\s*(.+::)?(\w+) [a-z]\w*\[(.+)];", line) + if ( + match + and match.group(2) != "return" + and match.group(2) != "delete" + and match.group(3).find("]") == -1 + ): + # Split the size using space and arithmetic operators as delimiters. + # If any of the resulting tokens are not compile time constants then + # report the error. + tokens = re.split(r"\s|\+|\-|\*|\/|<<|>>]", match.group(3)) + is_const = True + skip_next = False + for tok in tokens: + if skip_next: + skip_next = False + continue + + if re.search(r"sizeof\(.+\)", tok): + continue + if re.search(r"arraysize\(\w+\)", tok): + continue + + tok = tok.lstrip("(") + tok = tok.rstrip(")") + if not tok: + continue + if re.match(r"\d+", tok): + continue + if re.match(r"0[xX][0-9a-fA-F]+", tok): + continue + if re.match(r"k[A-Z0-9]\w*", tok): + continue + if re.match(r"(.+::)?k[A-Z0-9]\w*", tok): + continue + if re.match(r"(.+::)?[A-Z][A-Z0-9_]*", tok): + continue + # A catch all for tricky sizeof cases, including 'sizeof expression', + # 'sizeof(*type)', 'sizeof(const type)', 'sizeof(struct StructName)' + # requires skipping the next token because we split on ' ' and '*'. + if tok.startswith("sizeof"): + skip_next = True + continue + is_const = False + break + if not is_const: + error( + filename, + linenum, + "runtime/arrays", + 1, + "Do not use variable-length arrays. Use an appropriately named " + "('k' followed by CamelCase) compile-time constant for the size.", + ) + + # Check for use of unnamed namespaces in header files. Registration + # macros are typically OK, so we allow use of "namespace {" on lines + # that end with backslashes. + if ( + IsHeaderExtension(file_extension) + and re.search(r"\bnamespace\s*{", line) + and line[-1] != "\\" + ): + error( + filename, + linenum, + "build/namespaces_headers", + 4, + "Do not use unnamed namespaces in header files. See " + "https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces" + " for more information.", + ) + + +def CheckGlobalStatic(filename, clean_lines, linenum, error): + """Check for unsafe global or static objects. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Match two lines at a time to support multiline declarations + if linenum + 1 < clean_lines.NumLines() and not re.search(r"[;({]", line): + line += clean_lines.elided[linenum + 1].strip() + + # Check for people declaring static/global STL strings at the top level. + # This is dangerous because the C++ language does not guarantee that + # globals with constructors are initialized before the first access, and + # also because globals can be destroyed when some threads are still running. + # TODO(google): Generalize this to also find static unique_ptr instances. + # TODO(google): File bugs for clang-tidy to find these. + match = re.match( + r"((?:|static +)(?:|const +))(?::*std::)?string( +const)? +" + r"([a-zA-Z0-9_:]+)\b(.*)", + line, + ) + + # Remove false positives: + # - String pointers (as opposed to values). + # string *pointer + # const string *pointer + # string const *pointer + # string *const pointer # - # But we still issue warnings for macros that we know are safe to - # warn, specifically: - # - TEST, TEST_F, TEST_P, MATCHER, MATCHER_P - # - TYPED_TEST - # - INTERFACE_DEF - # - EXCLUSIVE_LOCKS_REQUIRED, SHARED_LOCKS_REQUIRED, LOCKS_EXCLUDED: + # - Functions and template specializations. + # string Function(... + # string Class::Method(... # - # We implement a list of safe macros instead of a list of - # unsafe macros, even though the latter appears less frequently in - # google code and would have been easier to implement. This is because - # the downside for getting the allowed checks wrong means some extra - # semicolons, while the downside for getting disallowed checks wrong - # would result in compile errors. + # - Operators. These are matched separately because operator names + # cross non-word boundaries, and trying to match both operators + # and functions at the same time would decrease accuracy of + # matching identifiers. + # string Class::operator*() + if ( + match + and not re.search(r"\bstring\b(\s+const)?\s*[\*\&]\s*(const\s+)?\w", line) + and not re.search(r"\boperator\W", line) + and not re.match(r'\s*(<.*>)?(::[a-zA-Z0-9_]+)*\s*\(([^"]|$)', match.group(4)) + ): + if re.search(r"\bconst\b", line): + error( + filename, + linenum, + "runtime/string", + 4, + "For a static/global string constant, use a C style string instead:" + f' "{match.group(1)}char{match.group(2) or ""} {match.group(3)}[]".', + ) + else: + error( + filename, + linenum, + "runtime/string", + 4, + "Static/global string variables are not permitted.", + ) + + if re.search(r"\b([A-Za-z0-9_]*_)\(\1\)", line) or re.search( + r"\b([A-Za-z0-9_]*_)\(CHECK_NOTNULL\(\1\)\)", line + ): + error( + filename, + linenum, + "runtime/init", + 4, + "You seem to be initializing a member variable with itself.", + ) + + +def CheckPrintf(filename, clean_lines, linenum, error): + """Check for printf related issues. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # When snprintf is used, the second argument shouldn't be a literal. + match = re.search(r"snprintf\s*\(([^,]*),\s*([0-9]*)\s*,", line) + if match and match.group(2) != "0": + # If 2nd arg is zero, snprintf is used to calculate size. + error( + filename, + linenum, + "runtime/printf", + 3, + "If you can, use" + f" sizeof({match.group(1)}) instead of {match.group(2)}" + " as the 2nd arg to snprintf.", + ) + + # Check if some verboten C functions are being used. + if re.search(r"\bsprintf\s*\(", line): + error(filename, linenum, "runtime/printf", 5, "Never use sprintf. Use snprintf instead.") + match = re.search(r"\b(strcpy|strcat)\s*\(", line) + if match: + error( + filename, + linenum, + "runtime/printf", + 4, + f"Almost always, snprintf is better than {match.group(1)}", + ) + + +def IsDerivedFunction(clean_lines, linenum): + """Check if current line contains an inherited function. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + Returns: + True if current line contains a function with "override" + virt-specifier. + """ + # Scan back a few lines for start of current function + for i in range(linenum, max(-1, linenum - 10), -1): + match = re.match(r"^([^()]*\w+)\(", clean_lines.elided[i]) + if match: + # Look for "override" after the matching closing parenthesis + line, _, closing_paren = CloseExpression(clean_lines, i, len(match.group(1))) + return closing_paren >= 0 and re.search(r"\boverride\b", line[closing_paren:]) + return False + + +def IsOutOfLineMethodDefinition(clean_lines, linenum): + """Check if current line contains an out-of-line method definition. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + Returns: + True if current line contains an out-of-line method definition. + """ + # Scan back a few lines for start of current function + for i in range(linenum, max(-1, linenum - 10), -1): + if re.match(r"^([^()]*\w+)\(", clean_lines.elided[i]): + return re.match(r"^[^()]*\w+::\w+\(", clean_lines.elided[i]) is not None + return False + + +def IsInitializerList(clean_lines, linenum): + """Check if current line is inside constructor initializer list. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + Returns: + True if current line appears to be inside constructor initializer + list, False otherwise. + """ + for i in range(linenum, 1, -1): + line = clean_lines.elided[i] + if i == linenum: + remove_function_body = re.match(r"^(.*)\{\s*$", line) + if remove_function_body: + line = remove_function_body.group(1) + + if re.search(r"\s:\s*\w+[({]", line): + # A lone colon tend to indicate the start of a constructor + # initializer list. It could also be a ternary operator, which + # also tend to appear in constructor initializer lists as + # opposed to parameter lists. + return True + if re.search(r"\}\s*,\s*$", line): + # A closing brace followed by a comma is probably the end of a + # brace-initialized member in constructor initializer list. + return True + if re.search(r"[{};]\s*$", line): + # Found one of the following: + # - A closing brace or semicolon, probably the end of the previous + # function. + # - An opening brace, probably the start of current class or namespace. + # + # Current line is probably not inside an initializer list since + # we saw one of those things without seeing the starting colon. + return False + + # Got to the beginning of the file without seeing the start of + # constructor initializer list. + return False + + +def CheckForNonConstReference(filename, clean_lines, linenum, nesting_state, error): + """Check for non-const references. + + Separate from CheckLanguage since it scans backwards from current + line, instead of scanning forward. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + # Do nothing if there is no '&' on current line. + line = clean_lines.elided[linenum] + if "&" not in line: + return + + # If a function is inherited, current function doesn't have much of + # a choice, so any non-const references should not be blamed on + # derived function. + if IsDerivedFunction(clean_lines, linenum): + return + + # Don't warn on out-of-line method definitions, as we would warn on the + # in-line declaration, if it isn't marked with 'override'. + if IsOutOfLineMethodDefinition(clean_lines, linenum): + return + + # Long type names may be broken across multiple lines, usually in one + # of these forms: + # LongType + # ::LongTypeContinued &identifier + # LongType:: + # LongTypeContinued &identifier + # LongType< + # ...>::LongTypeContinued &identifier + # + # If we detected a type split across two lines, join the previous + # line to current line so that we can match const references + # accordingly. + # + # Note that this only scans back one line, since scanning back + # arbitrary number of lines would be expensive. If you have a type + # that spans more than 2 lines, please use a typedef. + if linenum > 1: + previous = None + if re.match(r"\s*::(?:[\w<>]|::)+\s*&\s*\S", line): + # previous_line\n + ::current_line + previous = re.search( + r"\b((?:const\s*)?(?:[\w<>]|::)+[\w<>])\s*$", clean_lines.elided[linenum - 1] + ) + elif re.match(r"\s*[a-zA-Z_]([\w<>]|::)+\s*&\s*\S", line): + # previous_line::\n + current_line + previous = re.search( + r"\b((?:const\s*)?(?:[\w<>]|::)+::)\s*$", clean_lines.elided[linenum - 1] + ) + if previous: + line = previous.group(1) + line.lstrip() + else: + # Check for templated parameter that is split across multiple lines + endpos = line.rfind(">") + if endpos > -1: + (_, startline, startpos) = ReverseCloseExpression(clean_lines, linenum, endpos) + if startpos > -1 and startline < linenum: + # Found the matching < on an earlier line, collect all + # pieces up to current line. + line = "" + for i in range(startline, linenum + 1): + line += clean_lines.elided[i].strip() + + # Check for non-const references in function parameters. A single '&' may + # found in the following places: + # inside expression: binary & for bitwise AND + # inside expression: unary & for taking the address of something + # inside declarators: reference parameter + # We will exclude the first two cases by checking that we are not inside a + # function body, including one that was just introduced by a trailing '{'. + # TODO(google): Doesn't account for 'catch(Exception& e)' [rare]. + if nesting_state.previous_stack_top and not ( + isinstance(nesting_state.previous_stack_top, (_ClassInfo, _NamespaceInfo)) + ): + # Not at toplevel, not within a class, and not within a namespace + return + + # Avoid initializer lists. We only need to scan back from the + # current line for something that starts with ':'. + # + # We don't need to check the current line, since the '&' would + # appear inside the second set of parentheses on the current line as + # opposed to the first set. + if linenum > 0: + for i in range(linenum - 1, max(0, linenum - 10), -1): + previous_line = clean_lines.elided[i] + if not re.search(r"[),]\s*$", previous_line): + break + if re.match(r"^\s*:\s+\S", previous_line): + return + + # Avoid preprocessors + if re.search(r"\\\s*$", line): + return + + # Avoid constructor initializer lists + if IsInitializerList(clean_lines, linenum): + return + + # We allow non-const references in a few standard places, like functions + # called "swap()" or iostream operators like "<<" or ">>". Do not check + # those function parameters. + # + # We also accept & in static_assert, which looks like a function but + # it's actually a declaration expression. + allowed_functions = ( + r"(?:[sS]wap(?:<\w:+>)?|" + r"operator\s*[<>][<>]|" + r"static_assert|COMPILE_ASSERT" + r")\s*\(" + ) + if re.search(allowed_functions, line): + return + if not re.search(r"\S+\([^)]*$", line): + # Don't see an allowed function on this line. Actually we + # didn't see any function name on this line, so this is likely a + # multi-line parameter list. Try a bit harder to catch this case. + for i in range(2): + if linenum > i and re.search(allowed_functions, clean_lines.elided[linenum - i - 1]): + return + + decls = re.sub(r"{[^}]*}", " ", line) # exclude function body + for parameter in re.findall(_RE_PATTERN_REF_PARAM, decls): + if not re.match(_RE_PATTERN_CONST_REF_PARAM, parameter) and not re.match( + _RE_PATTERN_REF_STREAM_PARAM, parameter + ): + error( + filename, + linenum, + "runtime/references", + 2, + "Is this a non-const reference? " + "If so, make const or use a pointer: " + re.sub(" *<", "<", parameter), + ) + + +def CheckCasts(filename, clean_lines, linenum, error): + """Various cast related checks. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Check to see if they're using an conversion function cast. + # I just try to capture the most common basic types, though there are more. + # Parameterless conversion functions, such as bool(), are allowed as they are + # probably a member operator declaration or default constructor. + match = re.search( + r"(\bnew\s+(?:const\s+)?|\S<\s*(?:const\s+)?)?\b" + r"(int|float|double|bool|char|int16_t|uint16_t|int32_t|uint32_t|int64_t|uint64_t)" + r"(\([^)].*)", + line, + ) + expecting_function = ExpectingFunctionArgs(clean_lines, linenum) + if match and not expecting_function: + matched_type = match.group(2) + + # matched_new_or_template is used to silence two false positives: + # - New operators + # - Template arguments with function types + # + # For template arguments, we match on types immediately following + # an opening bracket without any spaces. This is a fast way to + # silence the common case where the function type is the first + # template argument. False negative with less-than comparison is + # avoided because those operators are usually followed by a space. + # + # function // bracket + no space = false positive + # value < double(42) // bracket + space = true positive + matched_new_or_template = match.group(1) + + # Avoid arrays by looking for brackets that come after the closing + # parenthesis. + if re.match(r"\([^()]+\)\s*\[", match.group(3)): + return + + # Other things to ignore: + # - Function pointers + # - Casts to pointer types + # - Placement new + # - Alias declarations + matched_funcptr = match.group(3) + if ( + matched_new_or_template is None + and not ( + matched_funcptr + and ( + re.match(r"\((?:[^() ]+::\s*\*\s*)?[^() ]+\)\s*\(", matched_funcptr) + or matched_funcptr.startswith("(*)") + ) + ) + and not re.match(r"\s*using\s+\S+\s*=\s*" + matched_type, line) + and not re.search(r"new\(\S+\)\s*" + matched_type, line) + ): + error( + filename, + linenum, + "readability/casting", + 4, + f"Using deprecated casting style. Use static_cast<{matched_type}>(...) instead", + ) + + if not expecting_function: + CheckCStyleCast( + filename, + clean_lines, + linenum, + "static_cast", + r"\((int|float|double|bool|char|u?int(16|32|64)_t|size_t)\)", + error, + ) + + # This doesn't catch all cases. Consider (const char * const)"hello". # - # In addition to macros, we also don't want to warn on - # - Compound literals - # - Lambdas - # - alignas specifier with anonymous structs - # - decltype - # - concepts (requires expression) - closing_brace_pos = match.group(1).rfind(')') - opening_parenthesis = ReverseCloseExpression( - clean_lines, linenum, closing_brace_pos) - if opening_parenthesis[2] > -1: - line_prefix = opening_parenthesis[0][0:opening_parenthesis[2]] - macro = re.search(r'\b([A-Z_][A-Z0-9_]*)\s*$', line_prefix) - func = re.match(r'^(.*\])\s*$', line_prefix) - if ((macro and - macro.group(1) not in ( - 'TEST', 'TEST_F', 'MATCHER', 'MATCHER_P', 'TYPED_TEST', - 'EXCLUSIVE_LOCKS_REQUIRED', 'SHARED_LOCKS_REQUIRED', - 'LOCKS_EXCLUDED', 'INTERFACE_DEF')) or - (func and not re.search(r'\boperator\s*\[\s*\]', func.group(1))) or - re.search(r'\b(?:struct|union)\s+alignas\s*$', line_prefix) or - re.search(r'\bdecltype$', line_prefix) or - re.search(r'\brequires.*$', line_prefix) or - re.search(r'\s+=\s*$', line_prefix)): - match = None - if (match and - opening_parenthesis[1] > 1 and - re.search(r'\]\s*$', clean_lines.elided[opening_parenthesis[1] - 1])): - # Multi-line lambda-expression - match = None - - else: - # Try matching cases 2-3. - match = re.match(r'^(.*(?:else|\)\s*const)\s*)\{', line) + # (char *) "foo" should always be a const_cast (reinterpret_cast won't + # compile). + if CheckCStyleCast( + filename, clean_lines, linenum, "const_cast", r'\((char\s?\*+\s?)\)\s*"', error + ): + pass + else: + # Check pointer casts for other than string constants + CheckCStyleCast( + filename, clean_lines, linenum, "reinterpret_cast", r"\((\w+\s?\*+\s?)\)", error + ) + + # In addition, we look for people taking the address of a cast. This + # is dangerous -- casts can assign to temporaries, so the pointer doesn't + # point where you think. + # + # Some non-identifier character is required before the '&' for the + # expression to be recognized as a cast. These are casts: + # expression = &static_cast(temporary()); + # function(&(int*)(temporary())); + # + # This is not a cast: + # reference_type&(int* function_param); + match = re.search( + r"(?:[^\w]&\(([^)*][^)]*)\)[\w(])|" + r"(?:[^\w]&(static|dynamic|down|reinterpret)_cast\b)", + line, + ) + if match: + # Try a better error message when the & is bound to something + # dereferenced by the casted pointer, as opposed to the casted + # pointer itself. + parenthesis_error = False + match = re.match(r"^(.*&(?:static|dynamic|down|reinterpret)_cast\b)<", line) + if match: + _, y1, x1 = CloseExpression(clean_lines, linenum, len(match.group(1))) + if x1 >= 0 and clean_lines.elided[y1][x1] == "(": + _, y2, x2 = CloseExpression(clean_lines, y1, x1) + if x2 >= 0: + extended_line = clean_lines.elided[y2][x2:] + if y2 < clean_lines.NumLines() - 1: + extended_line += clean_lines.elided[y2 + 1] + if re.match(r"\s*(?:->|\[)", extended_line): + parenthesis_error = True + + if parenthesis_error: + error( + filename, + linenum, + "readability/casting", + 4, + ( + "Are you taking an address of something dereferenced " + "from a cast? Wrapping the dereferenced expression in " + "parentheses will make the binding more obvious" + ), + ) + else: + error( + filename, + linenum, + "runtime/casting", + 4, + ( + "Are you taking an address of a cast? " + "This is dangerous: could be a temp var. " + "Take the address before doing the cast, rather than after" + ), + ) + + +def CheckCStyleCast(filename, clean_lines, linenum, cast_type, pattern, error): + """Checks for a C-style cast by looking for the pattern. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + cast_type: The string for the C++ cast to recommend. This is either + reinterpret_cast, static_cast, or const_cast, depending. + pattern: The regular expression used to find C-style casts. + error: The function to call with any errors found. + + Returns: + True if an error was emitted. + False otherwise. + """ + line = clean_lines.elided[linenum] + match = re.search(pattern, line) if not match: - # Try matching cases 4-6. These are always matched on separate lines. - # - # Note that we can't simply concatenate the previous line to the - # current line and do a single match, otherwise we may output - # duplicate warnings for the blank line case: - # if (cond) { - # // blank line - # } - prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] - if prevline and re.search(r'[;{}]\s*$', prevline): - match = re.match(r'^(\s*)\{', line) - - # Check matching closing brace - if match: - (endline, endlinenum, endpos) = CloseExpression( - clean_lines, linenum, len(match.group(1))) - if endpos > -1 and re.match(r'^\s*;', endline[endpos:]): - # Current {} pair is eligible for semicolon check, and we have found - # the redundant semicolon, output warning here. - # - # Note: because we are scanning forward for opening braces, and - # outputting warnings for the matching closing brace, if there are - # nested blocks with trailing semicolons, we will get the error - # messages in reversed order. - - # We need to check the line forward for NOLINT - raw_lines = clean_lines.raw_lines - ParseNolintSuppressions(filename, raw_lines[endlinenum-1], endlinenum-1, - error) - ParseNolintSuppressions(filename, raw_lines[endlinenum], endlinenum, - error) - - error(filename, endlinenum, 'readability/braces', 4, - "You don't need a ; after a }") + return False + + # Exclude lines with keywords that tend to look like casts + context = line[0 : match.start(1) - 1] + if re.match(r".*\b(?:sizeof|alignof|alignas|[_A-Z][_A-Z0-9]*)\s*$", context): + return False + + # Try expanding current context to see if we one level of + # parentheses inside a macro. + if linenum > 0: + for i in range(linenum - 1, max(0, linenum - 5), -1): + context = clean_lines.elided[i] + context + if re.match(r".*\b[_A-Z][_A-Z0-9]*\s*\((?:\([^()]*\)|[^()])*$", context): + return False + + # operator++(int) and operator--(int) + if context.endswith((" operator++", " operator--", "::operator++", "::operator--")): + return False + + # A single unnamed argument for a function tends to look like old style cast. + # If we see those, don't issue warnings for deprecated casts. + remainder = line[match.end(0) :] + if re.match(r"^\s*(?:;|const\b|throw\b|final\b|override\b|[=>{),]|->)", remainder): + return False + + # At this point, all that should be left is actual casts. + error( + filename, + linenum, + "readability/casting", + 4, + f"Using C-style cast. Use {cast_type}<{match.group(1)}>(...) instead", + ) + + return True + + +def ExpectingFunctionArgs(clean_lines, linenum): + """Checks whether where function type arguments are expected. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + + Returns: + True if the line at 'linenum' is inside something that expects arguments + of function types. + """ + line = clean_lines.elided[linenum] + return re.match(r"^\s*MOCK_(CONST_)?METHOD\d+(_T)?\(", line) or ( + linenum >= 2 + and ( + re.match( + r"^\s*MOCK_(?:CONST_)?METHOD\d+(?:_T)?\((?:\S+,)?\s*$", + clean_lines.elided[linenum - 1], + ) + or re.match( + r"^\s*MOCK_(?:CONST_)?METHOD\d+(?:_T)?\(\s*$", clean_lines.elided[linenum - 2] + ) + or re.search(r"\bstd::m?function\s*\<\s*$", clean_lines.elided[linenum - 1]) + ) + ) + + +_HEADERS_CONTAINING_TEMPLATES: tuple[tuple[str, tuple[str, ...]], ...] = ( + ("", ("deque",)), + ( + "", + ( + "unary_function", + "binary_function", + "plus", + "minus", + "multiplies", + "divides", + "modulus", + "negate", + "equal_to", + "not_equal_to", + "greater", + "less", + "greater_equal", + "less_equal", + "logical_and", + "logical_or", + "logical_not", + "unary_negate", + "not1", + "binary_negate", + "not2", + "bind1st", + "bind2nd", + "pointer_to_unary_function", + "pointer_to_binary_function", + "ptr_fun", + "mem_fun_t", + "mem_fun", + "mem_fun1_t", + "mem_fun1_ref_t", + "mem_fun_ref_t", + "const_mem_fun_t", + "const_mem_fun1_t", + "const_mem_fun_ref_t", + "const_mem_fun1_ref_t", + "mem_fun_ref", + ), + ), + ("", ("numeric_limits",)), + ("", ("list",)), + ("", ("multimap",)), + ( + "", + ("allocator", "make_shared", "make_unique", "shared_ptr", "unique_ptr", "weak_ptr"), + ), + ( + "", + ( + "queue", + "priority_queue", + ), + ), + ( + "", + ( + "set", + "multiset", + ), + ), + ("", ("stack",)), + ( + "", + ( + "char_traits", + "basic_string", + ), + ), + ("", ("tuple",)), + ("", ("unordered_map", "unordered_multimap")), + ("", ("unordered_set", "unordered_multiset")), + ("", ("pair",)), + ("", ("vector",)), + # gcc extensions. + # Note: std::hash is their hash, ::hash is our hash + ( + "", + ( + "hash_map", + "hash_multimap", + ), + ), + ( + "", + ( + "hash_set", + "hash_multiset", + ), + ), + ("", ("slist",)), +) + +_HEADERS_MAYBE_TEMPLATES: tuple[tuple[str, tuple[str, ...]], ...] = ( + ( + "", + ( + "copy", + "max", + "min", + "min_element", + "sort", + "transform", + ), + ), + ("", ("forward", "make_pair", "move", "swap")), +) + +# Non templated types or global objects +_HEADERS_TYPES_OR_OBJS: tuple[tuple[str, tuple[str, ...]], ...] = ( + # String and others are special -- it is a non-templatized type in STL. + ("", ("string",)), + ("", ("cin", "cout", "cerr", "clog", "wcin", "wcout", "wcerr", "wclog")), + ("", ("FILE", "fpos_t")), +) + +# Non templated functions +_HEADERS_FUNCTIONS: tuple[tuple[str, tuple[str, ...]], ...] = ( + ( + "", + ( + "fopen", + "freopen", + "fclose", + "fflush", + "setbuf", + "setvbuf", + "fread", + "fwrite", + "fgetc", + "getc", + "fgets", + "fputc", + "putc", + "fputs", + "getchar", + "gets", + "putchar", + "puts", + "ungetc", + "scanf", + "fscanf", + "sscanf", + "vscanf", + "vfscanf", + "vsscanf", + "printf", + "fprintf", + "sprintf", + "snprintf", + "vprintf", + "vfprintf", + "vsprintf", + "vsnprintf", + "ftell", + "fgetpos", + "fseek", + "fsetpos", + "clearerr", + "feof", + "ferror", + "perror", + "tmpfile", + "tmpnam", + ), + ), +) + +_re_pattern_headers_maybe_templates: list[tuple[re.Pattern, str, str]] = [] +for _header, _templates in _HEADERS_MAYBE_TEMPLATES: + # Match max(..., ...), max(..., ...), but not foo->max, foo.max or + # 'type::max()'. + _re_pattern_headers_maybe_templates.extend( + (re.compile(r"((\bstd::)|[^>.:])\b" + _template + r"(<.*?>)?\([^\)]"), _template, _header) + for _template in _templates + ) + +# Map is often overloaded. Only check, if it is fully qualified. +# Match 'std::map(...)', but not 'map(...)'' +_re_pattern_headers_maybe_templates.append( + (re.compile(r"(std\b::\bmap\s*\<)|(^(std\b::\b)map\b\(\s*\<)"), "map<>", "") +) +# Other scripts may reach in and modify this pattern. +_re_pattern_templates: list[tuple[re.Pattern, str, str]] = [] +for _header, _templates in _HEADERS_CONTAINING_TEMPLATES: + _re_pattern_templates.extend( + ( + re.compile(r"((^|(^|\s|((^|\W)::))std::)|[^>.:]\b)" + _template + r"\s*\<"), + _template + "<>", + _header, + ) + for _template in _templates + ) + +_re_pattern_types_or_objs: list[tuple[re.Pattern, object | type, str]] = [] +for _header, _types_or_objs in _HEADERS_TYPES_OR_OBJS: + _re_pattern_types_or_objs.extend( + (re.compile(r"\b" + _type_or_obj + r"\b"), _type_or_obj, _header) + for _type_or_obj in _types_or_objs + ) + +_re_pattern_functions: list[tuple[re.Pattern, str, str]] = [] +for _header, _functions in _HEADERS_FUNCTIONS: + # Match printf(..., ...), but not foo->printf, foo.printf or + # 'type::printf()'. + _re_pattern_functions.extend( + (re.compile(r"([^>.]|^)\b" + _function + r"\([^\)]"), _function, _header) + for _function in _functions + ) + + +def FilesBelongToSameModule(filename_cc, filename_h): + """Check if these two filenames belong to the same module. -def CheckEmptyBlockBody(filename, clean_lines, linenum, error): - """Look for empty loop/conditional body with only a single semicolon. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - - # Search for loop keywords at the beginning of the line. Because only - # whitespaces are allowed before the keywords, this will also ignore most - # do-while-loops, since those lines should start with closing brace. - # - # We also check "if" blocks here, since an empty conditional block - # is likely an error. - line = clean_lines.elided[linenum] - matched = re.match(r'\s*(for|while|if)\s*\(', line) - if matched: - # Find the end of the conditional expression. - (end_line, end_linenum, end_pos) = CloseExpression( - clean_lines, linenum, line.find('(')) - - # Output warning if what follows the condition expression is a semicolon. - # No warning for all other cases, including whitespace or newline, since we - # have a separate check for semicolons preceded by whitespace. - if end_pos >= 0 and re.match(r';', end_line[end_pos:]): - if matched.group(1) == 'if': - error(filename, end_linenum, 'whitespace/empty_conditional_body', 5, - 'Empty conditional bodies should use {}') - else: - error(filename, end_linenum, 'whitespace/empty_loop_body', 5, - 'Empty loop bodies should use {} or continue') - - # Check for if statements that have completely empty bodies (no comments) - # and no else clauses. - if end_pos >= 0 and matched.group(1) == 'if': - # Find the position of the opening { for the if statement. - # Return without logging an error if it has no brackets. - opening_linenum = end_linenum - opening_line_fragment = end_line[end_pos:] - # Loop until EOF or find anything that's not whitespace or opening {. - while not re.search(r'^\s*\{', opening_line_fragment): - if re.search(r'^(?!\s*$)', opening_line_fragment): - # Conditional has no brackets. - return - opening_linenum += 1 - if opening_linenum == len(clean_lines.elided): - # Couldn't find conditional's opening { or any code before EOF. - return - opening_line_fragment = clean_lines.elided[opening_linenum] - # Set opening_line (opening_line_fragment may not be entire opening line). - opening_line = clean_lines.elided[opening_linenum] - - # Find the position of the closing }. - opening_pos = opening_line_fragment.find('{') - if opening_linenum == end_linenum: - # We need to make opening_pos relative to the start of the entire line. - opening_pos += end_pos - (closing_line, closing_linenum, closing_pos) = CloseExpression( - clean_lines, opening_linenum, opening_pos) - if closing_pos < 0: - return + The concept of a 'module' here is a as follows: + foo.h, foo-inl.h, foo.cc, foo_test.cc and foo_unittest.cc belong to the + same 'module' if they are in the same directory. + some/path/public/xyzzy and some/path/internal/xyzzy are also considered + to belong to the same module here. - # Now construct the body of the conditional. This consists of the portion - # of the opening line after the {, all lines until the closing line, - # and the portion of the closing line before the }. - if (clean_lines.raw_lines[opening_linenum] != - CleanseComments(clean_lines.raw_lines[opening_linenum])): - # Opening line ends with a comment, so conditional isn't empty. - return - if closing_linenum > opening_linenum: - # Opening line after the {. Ignore comments here since we checked above. - bodylist = list(opening_line[opening_pos+1:]) - # All lines until closing line, excluding closing line, with comments. - bodylist.extend(clean_lines.raw_lines[opening_linenum+1:closing_linenum]) - # Closing line before the }. Won't (and can't) have comments. - bodylist.append(clean_lines.elided[closing_linenum][:closing_pos-1]) - body = '\n'.join(bodylist) - else: - # If statement has brackets and fits on a single line. - body = opening_line[opening_pos+1:closing_pos-1] - - # Check if the body is empty - if not _EMPTY_CONDITIONAL_BODY_PATTERN.search(body): - return - # The body is empty. Now make sure there's not an else clause. - current_linenum = closing_linenum - current_line_fragment = closing_line[closing_pos:] - # Loop until EOF or find anything that's not whitespace or else clause. - while re.search(r'^\s*$|^(?=\s*else)', current_line_fragment): - if re.search(r'^(?=\s*else)', current_line_fragment): - # Found an else clause, so don't log an error. - return - current_linenum += 1 - if current_linenum == len(clean_lines.elided): - break - current_line_fragment = clean_lines.elided[current_linenum] - - # The body is empty and there's no else clause until EOF or other code. - error(filename, end_linenum, 'whitespace/empty_if_body', 4, - ('If statement had no body and no else clause')) + If the filename_cc contains a longer path than the filename_h, for example, + '/absolute/path/to/base/sysinfo.cc', and this file would include + 'base/sysinfo.h', this function also produces the prefix needed to open the + header. This is used by the caller of this function to more robustly open the + header file. We don't have access to the real include paths in this context, + so we need this guesswork here. + Known bugs: tools/base/bar.cc and base/bar.h belong to the same module + according to this implementation. Because of this, this function gives + some false positives. This should be sufficiently rare in practice. -def FindCheckMacro(line): - """Find a replaceable CHECK-like macro. - - Args: - line: line to search on. - Returns: - (macro name, start position), or (None, -1) if no replaceable - macro is found. - """ - for macro in _CHECK_MACROS: - i = line.find(macro) - if i >= 0: - # Find opening parenthesis. Do a regular expression match here - # to make sure that we are matching the expected CHECK macro, as - # opposed to some other macro that happens to contain the CHECK - # substring. - matched = re.match(r'^(.*\b' + macro + r'\s*)\(', line) - if not matched: - continue - return (macro, len(matched.group(1))) - return (None, -1) + Args: + filename_cc: is the path for the source (e.g. .cc) file + filename_h: is the path for the header path + Returns: + Tuple with a bool and a string: + bool: True if filename_cc and filename_h belong to the same module. + string: the additional prefix needed to open the header file. + """ + fileinfo_cc = FileInfo(filename_cc) + if fileinfo_cc.Extension().lstrip(".") not in GetNonHeaderExtensions(): + return (False, "") -def CheckCheck(filename, clean_lines, linenum, error): - """Checks the use of CHECK and EXPECT macros. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - - # Decide the set of replacement macros that should be suggested - lines = clean_lines.elided - (check_macro, start_pos) = FindCheckMacro(lines[linenum]) - if not check_macro: - return - - # Find end of the boolean expression by matching parentheses - (last_line, end_line, end_pos) = CloseExpression( - clean_lines, linenum, start_pos) - if end_pos < 0: - return - - # If the check macro is followed by something other than a - # semicolon, assume users will log their own custom error messages - # and don't suggest any replacements. - if not re.match(r'\s*;', last_line[end_pos:]): - return - - if linenum == end_line: - expression = lines[linenum][start_pos + 1:end_pos - 1] - else: - expression = lines[linenum][start_pos + 1:] - for i in range(linenum + 1, end_line): - expression += lines[i] - expression += last_line[0:end_pos - 1] - - # Parse expression so that we can take parentheses into account. - # This avoids false positives for inputs like "CHECK((a < 4) == b)", - # which is not replaceable by CHECK_LE. - lhs = '' - rhs = '' - operator = None - while expression: - matched = re.match(r'^\s*(<<|<<=|>>|>>=|->\*|->|&&|\|\||' - r'==|!=|>=|>|<=|<|\()(.*)$', expression) - if matched: - token = matched.group(1) - if token == '(': - # Parenthesized operand - expression = matched.group(2) - (end, _) = FindEndOfExpressionInLine(expression, 0, ['(']) - if end < 0: - return # Unmatched parenthesis - lhs += '(' + expression[0:end] - expression = expression[end:] - elif token in ('&&', '||'): - # Logical and/or operators. This means the expression - # contains more than one term, for example: - # CHECK(42 < a && a < b); - # - # These are not replaceable with CHECK_LE, so bail out early. - return - elif token in ('<<', '<<=', '>>', '>>=', '->*', '->'): - # Non-relational operator - lhs += token - expression = matched.group(2) - else: - # Relational operator - operator = token - rhs = matched.group(2) - break - else: - # Unparenthesized operand. Instead of appending to lhs one character - # at a time, we do another regular expression match to consume several - # characters at once if possible. Trivial benchmark shows that this - # is more efficient when the operands are longer than a single - # character, which is generally the case. - matched = re.match(r'^([^-=!<>()&|]+)(.*)$', expression) - if not matched: - matched = re.match(r'^(\s*\S)(.*)$', expression) - if not matched: - break - lhs += matched.group(1) - expression = matched.group(2) - - # Only apply checks if we got all parts of the boolean expression - if not (lhs and operator and rhs): - return - - # Check that rhs do not contain logical operators. We already know - # that lhs is fine since the loop above parses out && and ||. - if rhs.find('&&') > -1 or rhs.find('||') > -1: - return - - # At least one of the operands must be a constant literal. This is - # to avoid suggesting replacements for unprintable things like - # CHECK(variable != iterator) - # - # The following pattern matches decimal, hex integers, strings, and - # characters (in that order). - lhs = lhs.strip() - rhs = rhs.strip() - match_constant = r'^([-+]?(\d+|0[xX][0-9a-fA-F]+)[lLuU]{0,3}|".*"|\'.*\')$' - if re.match(match_constant, lhs) or re.match(match_constant, rhs): - # Note: since we know both lhs and rhs, we can provide a more - # descriptive error message like: - # Consider using CHECK_EQ(x, 42) instead of CHECK(x == 42) - # Instead of: - # Consider using CHECK_EQ instead of CHECK(a == b) - # - # We are still keeping the less descriptive message because if lhs - # or rhs gets long, the error message might become unreadable. - error(filename, linenum, 'readability/check', 2, - f'Consider using {_CHECK_REPLACEMENT[check_macro][operator]}' - f' instead of {check_macro}(a {operator} b)') + fileinfo_h = FileInfo(filename_h) + if not IsHeaderExtension(fileinfo_h.Extension().lstrip(".")): + return (False, "") + filename_cc = filename_cc[: -(len(fileinfo_cc.Extension()))] + if matched_test_suffix := re.search(_TEST_FILE_SUFFIX, fileinfo_cc.BaseName()): + filename_cc = filename_cc[: -len(matched_test_suffix.group(1))] -def CheckAltTokens(filename, clean_lines, linenum, error): - """Check alternative keywords being used in boolean expressions. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # Avoid preprocessor lines - if re.match(r'^\s*#', line): - return - - # Last ditch effort to avoid multi-line comments. This will not help - # if the comment started before the current line or ended after the - # current line, but it catches most of the false positives. At least, - # it provides a way to workaround this warning for people who use - # multi-line comments in preprocessor macros. - # - # TODO(unknown): remove this once cpplint has better support for - # multi-line comments. - if line.find('/*') >= 0 or line.find('*/') >= 0: - return - - for match in _ALT_TOKEN_REPLACEMENT_PATTERN.finditer(line): - error(filename, linenum, 'readability/alt_tokens', 2, - f'Use operator {_ALT_TOKEN_REPLACEMENT[match.group(2)]}' - f' instead of {match.group(2)}') + filename_cc = filename_cc.replace("/public/", "/") + filename_cc = filename_cc.replace("/internal/", "/") + filename_h = filename_h[: -(len(fileinfo_h.Extension()))] + if filename_h.endswith("-inl"): + filename_h = filename_h[: -len("-inl")] + filename_h = filename_h.replace("/public/", "/") + filename_h = filename_h.replace("/internal/", "/") -def GetLineWidth(line): - """Determines the width of the line in column positions. - - Args: - line: A string, which may be a Unicode string. - - Returns: - The width of the line in column positions, accounting for Unicode - combining characters and wide characters. - """ - if isinstance(line, str): - width = 0 - for uc in unicodedata.normalize('NFC', line): - if unicodedata.east_asian_width(uc) in ('W', 'F'): - width += 2 - elif not unicodedata.combining(uc): - # Issue 337 - # https://mail.python.org/pipermail/python-list/2012-August/628809.html - if (sys.version_info.major, sys.version_info.minor) <= (3, 2): - # https://github.com/python/cpython/blob/2.7/Include/unicodeobject.h#L81 - is_wide_build = sysconfig.get_config_var("Py_UNICODE_SIZE") >= 4 - # https://github.com/python/cpython/blob/2.7/Objects/unicodeobject.c#L564 - is_low_surrogate = 0xDC00 <= ord(uc) <= 0xDFFF - if not is_wide_build and is_low_surrogate: - width -= 1 - - width += 1 - return width - else: - return len(line) + files_belong_to_same_module = filename_cc.endswith(filename_h) + common_path = "" + if files_belong_to_same_module: + common_path = filename_cc[: -len(filename_h)] + return files_belong_to_same_module, common_path -def CheckStyle(filename, clean_lines, linenum, file_extension, nesting_state, - error, cppvar=None): - """Checks rules from the 'C++ style rules' section of cppguide.html. - - Most of these rules are hard to test (naming, comment style), but we - do what we can. In particular we check for 2-space indents, line lengths, - tab usage, spaces inside code, etc. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - file_extension: The extension (without the dot) of the filename. - nesting_state: A NestingState instance which maintains information about - the current stack of nested blocks being parsed. - error: The function to call with any errors found. - cppvar: The header guard variable returned by GetHeaderGuardCPPVar. - """ - - # Don't use "elided" lines here, otherwise we can't check commented lines. - # Don't want to use "raw" either, because we don't want to check inside C++11 - # raw strings, - raw_lines = clean_lines.lines_without_raw_strings - line = raw_lines[linenum] - prev = raw_lines[linenum - 1] if linenum > 0 else '' - - if line.find('\t') != -1: - error(filename, linenum, 'whitespace/tab', 1, - 'Tab found; better to use spaces') - - # One or three blank spaces at the beginning of the line is weird; it's - # hard to reconcile that with 2-space indents. - # NOTE: here are the conditions rob pike used for his tests. Mine aren't - # as sophisticated, but it may be worth becoming so: RLENGTH==initial_spaces - # if(RLENGTH > 20) complain = 0; - # if(match($0, " +(error|private|public|protected):")) complain = 0; - # if(match(prev, "&& *$")) complain = 0; - # if(match(prev, "\\|\\| *$")) complain = 0; - # if(match(prev, "[\",=><] *$")) complain = 0; - # if(match($0, " <<")) complain = 0; - # if(match(prev, " +for \\(")) complain = 0; - # if(prevodd && match(prevprev, " +for \\(")) complain = 0; - scope_or_label_pattern = r'\s*(?:public|private|protected|signals)(?:\s+(?:slots\s*)?)?:\s*\\?$' - classinfo = nesting_state.InnermostClass() - initial_spaces = 0 - cleansed_line = clean_lines.elided[linenum] - while initial_spaces < len(line) and line[initial_spaces] == ' ': - initial_spaces += 1 - # There are certain situations we allow one space, notably for - # section labels, and also lines containing multi-line raw strings. - # We also don't check for lines that look like continuation lines - # (of lines ending in double quotes, commas, equals, or angle brackets) - # because the rules for how to indent those are non-trivial. - if (not re.search(r'[",=><] *$', prev) and - (initial_spaces == 1 or initial_spaces == 3) and - not re.match(scope_or_label_pattern, cleansed_line) and - not (clean_lines.raw_lines[linenum] != line and - re.match(r'^\s*""', line))): - error(filename, linenum, 'whitespace/indent', 3, - 'Weird number of spaces at line-start. ' - 'Are you using a 2-space indent?') - - if line and line[-1].isspace(): - error(filename, linenum, 'whitespace/end_of_line', 4, - 'Line ends in whitespace. Consider deleting these extra spaces.') - - # Check if the line is a header guard. - is_header_guard = False - if IsHeaderExtension(file_extension): - if (line.startswith(f'#ifndef {cppvar}') or - line.startswith(f'#define {cppvar}') or - line.startswith(f'#endif // {cppvar}')): - is_header_guard = True - # #include lines and header guards can be long, since there's no clean way to - # split them. - # - # URLs can be long too. It's possible to split these, but it makes them - # harder to cut&paste. - # - # The "$Id:...$" comment may also get very long without it being the - # developers fault. - # - # Doxygen documentation copying can get pretty long when using an overloaded - # function declaration - if (not line.startswith('#include') and not is_header_guard and - not re.match(r'^\s*//.*http(s?)://\S*$', line) and - not re.match(r'^\s*//\s*[^\s]*$', line) and - not re.match(r'^// \$Id:.*#[0-9]+ \$$', line) and - not re.match(r'^\s*/// [@\\](copydoc|copydetails|copybrief) .*$', line)): - line_width = GetLineWidth(line) - if line_width > _line_length: - error(filename, linenum, 'whitespace/line_length', 2, - f'Lines should be <= {_line_length} characters long') - - if (cleansed_line.count(';') > 1 and - # allow simple single line lambdas - not re.match(r'^[^{};]*\[[^\[\]]*\][^{}]*\{[^{}\n\r]*\}', - line) and - # for loops are allowed two ;'s (and may run over two lines). - cleansed_line.find('for') == -1 and - (GetPreviousNonBlankLine(clean_lines, linenum)[0].find('for') == -1 or - GetPreviousNonBlankLine(clean_lines, linenum)[0].find(';') != -1) and - # It's ok to have many commands in a switch case that fits in 1 line - not ((cleansed_line.find('case ') != -1 or - cleansed_line.find('default:') != -1) and - cleansed_line.find('break;') != -1)): - error(filename, linenum, 'whitespace/newline', 0, - 'More than one command on the same line') - - # Some more style checks - CheckBraces(filename, clean_lines, linenum, error) - CheckTrailingSemicolon(filename, clean_lines, linenum, error) - CheckEmptyBlockBody(filename, clean_lines, linenum, error) - CheckSpacing(filename, clean_lines, linenum, nesting_state, error) - CheckOperatorSpacing(filename, clean_lines, linenum, error) - CheckParenthesisSpacing(filename, clean_lines, linenum, error) - CheckCommaSpacing(filename, clean_lines, linenum, error) - CheckBracesSpacing(filename, clean_lines, linenum, nesting_state, error) - CheckSpacingForFunctionCall(filename, clean_lines, linenum, error) - CheckCheck(filename, clean_lines, linenum, error) - CheckAltTokens(filename, clean_lines, linenum, error) - classinfo = nesting_state.InnermostClass() - if classinfo: - CheckSectionSpacing(filename, clean_lines, classinfo, linenum, error) +def CheckForIncludeWhatYouUse(filename, clean_lines, include_state, error, io=codecs): + """Reports for missing stl includes. + This function will output warnings to make sure you are including the headers + necessary for the stl containers and functions that you use. We only give one + reason to include a header. For example, if you use both equal_to<> and + less<> in a .h file, only one (the latter in the file) of these will be + reported as a reason to include the . -_RE_PATTERN_INCLUDE = re.compile(r'^\s*#\s*include\s*([<"])([^>"]*)[>"].*$') -# Matches the first component of a filename delimited by -s and _s. That is: -# _RE_FIRST_COMPONENT.match('foo').group(0) == 'foo' -# _RE_FIRST_COMPONENT.match('foo.cc').group(0) == 'foo' -# _RE_FIRST_COMPONENT.match('foo-bar_baz.cc').group(0) == 'foo' -# _RE_FIRST_COMPONENT.match('foo_bar-baz.cc').group(0) == 'foo' -_RE_FIRST_COMPONENT = re.compile(r'^[^-_.]+') + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + include_state: An _IncludeState instance. + error: The function to call with any errors found. + io: The IO factory to use to read the header file. Provided for unittest + injection. + """ + required = {} # A map of header name to linenumber and the template entity. + # Example of required: { '': (1219, 'less<>') } + for linenum in range(clean_lines.NumLines()): + line = clean_lines.elided[linenum] + if not line or line[0] == "#": + continue -def _DropCommonSuffixes(filename): - """Drops common suffixes like _test.cc or -inl.h from filename. - - For example: - >>> _DropCommonSuffixes('foo/foo-inl.h') - 'foo/foo' - >>> _DropCommonSuffixes('foo/bar/foo.cc') - 'foo/bar/foo' - >>> _DropCommonSuffixes('foo/foo_internal.h') - 'foo/foo' - >>> _DropCommonSuffixes('foo/foo_unusualinternal.h') - 'foo/foo_unusualinternal' - - Args: - filename: The input filename. - - Returns: - The filename with the common suffix removed. - """ - for suffix in itertools.chain( - (f"{test_suffix.lstrip('_')}.{ext}" - for test_suffix, ext in itertools.product(_test_suffixes, GetNonHeaderExtensions())), - (f'{suffix}.{ext}' - for suffix, ext in itertools.product(['inl', 'imp', 'internal'], GetHeaderExtensions()))): - if (filename.endswith(suffix) and len(filename) > len(suffix) and - filename[-len(suffix) - 1] in ('-', '_')): - return filename[:-len(suffix) - 1] - return os.path.splitext(filename)[0] + _re_patterns = [] + _re_patterns.extend(_re_pattern_types_or_objs) + _re_patterns.extend(_re_pattern_functions) + for pattern, item, header in _re_patterns: + matched = pattern.search(line) + if matched: + # Don't warn about strings in non-STL namespaces: + # (We check only the first match per line; good enough.) + prefix = line[: matched.start()] + if prefix.endswith("std::") or not prefix.endswith("::"): + required[header] = (linenum, item) + + for pattern, template, header in _re_pattern_headers_maybe_templates: + if pattern.search(line): + required[header] = (linenum, template) + + # The following function is just a speed up, no semantics are changed. + if "<" not in line: # Reduces the cpu time usage by skipping lines. + continue + for pattern, template, header in _re_pattern_templates: + matched = pattern.search(line) + if matched: + # Don't warn about IWYU in non-STL namespaces: + # (We check only the first match per line; good enough.) + prefix = line[: matched.start()] + if prefix.endswith("std::") or not prefix.endswith("::"): + required[header] = (linenum, template) + + # Let's flatten the include_state include_list and copy it into a dictionary. + include_dict = dict([item for sublist in include_state.include_list for item in sublist]) + + # All the lines have been processed, report the errors found. + for header in sorted(required, key=required.__getitem__): + template = required[header][1] + header_stripped = header.strip('<>"') + if header_stripped not in include_dict and not ( + header_stripped[0] == "c" and (header_stripped[1:] + ".h") in include_dict + ): + error( + filename, + required[header][0], + "build/include_what_you_use", + 4, + "Add #include " + header + " for " + template, + ) + + +_RE_PATTERN_EXPLICIT_MAKEPAIR = re.compile(r"\bmake_pair\s*<") -def _ClassifyInclude(fileinfo, include, used_angle_brackets, include_order="default"): - """Figures out what kind of header 'include' is. - - Args: - fileinfo: The current file cpplint is running over. A FileInfo instance. - include: The path to a #included file. - used_angle_brackets: True if the #include used <> rather than "". - include_order: "default" or other value allowed in program arguments - - Returns: - One of the _XXX_HEADER constants. - - For example: - >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'stdio.h', True) - _C_SYS_HEADER - >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'string', True) - _CPP_SYS_HEADER - >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', True, "standardcfirst") - _OTHER_SYS_HEADER - >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', False) - _LIKELY_MY_HEADER - >>> _ClassifyInclude(FileInfo('foo/foo_unknown_extension.cc'), - ... 'bar/foo_other_ext.h', False) - _POSSIBLE_MY_HEADER - >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/bar.h', False) - _OTHER_HEADER - """ - # This is a list of all standard c++ header files, except - # those already checked for above. - is_cpp_header = include in _CPP_HEADERS - - # Mark include as C header if in list or in a known folder for standard-ish C headers. - is_std_c_header = (include_order == "default") or (include in _C_HEADERS - # additional linux glibc header folders - or re.search(rf'(?:{"|".join(C_STANDARD_HEADER_FOLDERS)})\/.*\.h', include)) - - # Headers with C++ extensions shouldn't be considered C system headers - include_ext = os.path.splitext(include)[1] - is_system = used_angle_brackets and include_ext not in ['.hh', '.hpp', '.hxx', '.h++'] - - if is_system: - if is_cpp_header: - return _CPP_SYS_HEADER - if is_std_c_header: - return _C_SYS_HEADER - else: - return _OTHER_SYS_HEADER - - # If the target file and the include we're checking share a - # basename when we drop common extensions, and the include - # lives in . , then it's likely to be owned by the target file. - target_dir, target_base = ( - os.path.split(_DropCommonSuffixes(fileinfo.RepositoryName()))) - include_dir, include_base = os.path.split(_DropCommonSuffixes(include)) - target_dir_pub = os.path.normpath(target_dir + '/../public') - target_dir_pub = target_dir_pub.replace('\\', '/') - if target_base == include_base and ( - include_dir == target_dir or - include_dir == target_dir_pub): - return _LIKELY_MY_HEADER - - # If the target and include share some initial basename - # component, it's possible the target is implementing the - # include, so it's allowed to be first, but we'll never - # complain if it's not there. - target_first_component = _RE_FIRST_COMPONENT.match(target_base) - include_first_component = _RE_FIRST_COMPONENT.match(include_base) - if (target_first_component and include_first_component and - target_first_component.group(0) == - include_first_component.group(0)): - return _POSSIBLE_MY_HEADER - - return _OTHER_HEADER +def CheckMakePairUsesDeduction(filename, clean_lines, linenum, error): + """Check that make_pair's template arguments are deduced. + G++ 4.6 in C++11 mode fails badly if make_pair's template arguments are + specified explicitly, and such use isn't intended in any case. -def CheckIncludeLine(filename, clean_lines, linenum, include_state, error): - """Check rules that are applicable to #include lines. - - Strings on #include lines are NOT removed from elided line, to make - certain tasks easier. However, to prevent false positives, checks - applicable to #include lines in CheckLanguage must be put here. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - include_state: An _IncludeState instance in which the headers are inserted. - error: The function to call with any errors found. - """ - fileinfo = FileInfo(filename) - line = clean_lines.lines[linenum] - - # "include" should use the new style "foo/bar.h" instead of just "bar.h" - # Only do this check if the included header follows google naming - # conventions. If not, assume that it's a 3rd party API that - # requires special include conventions. - # - # We also make an exception for Lua headers, which follow google - # naming convention but not the include convention. - match = re.match(r'#include\s*"([^/]+\.(.*))"', line) - if match: - if (IsHeaderExtension(match.group(2)) and - not _THIRD_PARTY_HEADERS_PATTERN.match(match.group(1))): - error(filename, linenum, 'build/include_subdir', 4, - 'Include the directory when naming header files') - - # we shouldn't include a file more than once. actually, there are a - # handful of instances where doing so is okay, but in general it's - # not. - match = _RE_PATTERN_INCLUDE.search(line) - if match: - include = match.group(2) - used_angle_brackets = match.group(1) == '<' - duplicate_line = include_state.FindHeader(include) - if duplicate_line >= 0: - error(filename, linenum, 'build/include', 4, - f'"{include}" already included at {filename}:{duplicate_line}') - return - - for extension in GetNonHeaderExtensions(): - if (include.endswith('.' + extension) and - os.path.dirname(fileinfo.RepositoryName()) != os.path.dirname(include)): - error(filename, linenum, 'build/include', 4, - 'Do not include .' + extension + ' files from other packages') - return + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + match = _RE_PATTERN_EXPLICIT_MAKEPAIR.search(line) + if match: + error( + filename, + linenum, + "build/explicit_make_pair", + 4, # 4 = high confidence + "For C++11-compatibility, omit template arguments from make_pair" + " OR use pair directly OR if appropriate, construct a pair directly", + ) - # We DO want to include a 3rd party looking header if it matches the - # filename. Otherwise we get an erroneous error "...should include its - # header" error later. - third_src_header = False - for ext in GetHeaderExtensions(): - basefilename = filename[0:len(filename) - len(fileinfo.Extension())] - headerfile = basefilename + '.' + ext - headername = FileInfo(headerfile).RepositoryName() - if headername in include or include in headername: - third_src_header = True - break - - if third_src_header or not _THIRD_PARTY_HEADERS_PATTERN.match(include): - include_state.include_list[-1].append((include, linenum)) - - # We want to ensure that headers appear in the right order: - # 1) for foo.cc, foo.h (preferred location) - # 2) c system files - # 3) cpp system files - # 4) for foo.cc, foo.h (deprecated location) - # 5) other google headers - # - # We classify each include statement as one of those 5 types - # using a number of techniques. The include_state object keeps - # track of the highest type seen, and complains if we see a - # lower type after that. - error_message = include_state.CheckNextIncludeOrder( - _ClassifyInclude(fileinfo, include, used_angle_brackets, _include_order)) - if error_message: - error(filename, linenum, 'build/include_order', 4, - f'{error_message}. Should be: {fileinfo.BaseName()}.h, c system,' - ' c++ system, other.') - canonical_include = include_state.CanonicalizeAlphabeticalOrder(include) - if not include_state.IsInAlphabeticalOrder( - clean_lines, linenum, canonical_include): - error(filename, linenum, 'build/include_alpha', 4, - f'Include "{include}" not in alphabetical order') - include_state.SetLastHeader(canonical_include) +def CheckRedundantVirtual(filename, clean_lines, linenum, error): + """Check if line contains a redundant "virtual" function-specifier. + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + # Look for "virtual" on current line. + line = clean_lines.elided[linenum] + virtual = re.match(r"^(.*)(\bvirtual\b)(.*)$", line) + if not virtual: + return -def _GetTextInside(text, start_pattern): - r"""Retrieves all the text between matching open and close parentheses. - - Given a string of lines and a regular expression string, retrieve all the text - following the expression and between opening punctuation symbols like - (, [, or {, and the matching close-punctuation symbol. This properly nested - occurrences of the punctuations, so for the text like - printf(a(), b(c())); - a call to _GetTextInside(text, r'printf\(') will return 'a(), b(c())'. - start_pattern must match string having an open punctuation symbol at the end. - - Args: - text: The lines to extract text. Its comments and strings must be elided. - It can be single line and can span multiple lines. - start_pattern: The regexp string indicating where to start extracting - the text. - Returns: - The extracted text. - None if either the opening string or ending punctuation could not be found. - """ - # TODO(unknown): Audit cpplint.py to see what places could be profitably - # rewritten to use _GetTextInside (and use inferior regexp matching today). - - # Give opening punctuations to get the matching close-punctuations. - matching_punctuation = {'(': ')', '{': '}', '[': ']'} - closing_punctuation = set(dict.values(matching_punctuation)) - - # Find the position to start extracting text. - match = re.search(start_pattern, text, re.M) - if not match: # start_pattern not found in text. - return None - start_position = match.end(0) - - assert start_position > 0, ( - 'start_pattern must ends with an opening punctuation.') - assert text[start_position - 1] in matching_punctuation, ( - 'start_pattern must ends with an opening punctuation.') - # Stack of closing punctuations we expect to have in text after position. - punctuation_stack = [matching_punctuation[text[start_position - 1]]] - position = start_position - while punctuation_stack and position < len(text): - if text[position] == punctuation_stack[-1]: - punctuation_stack.pop() - elif text[position] in closing_punctuation: - # A closing punctuation without matching opening punctuations. - return None - elif text[position] in matching_punctuation: - punctuation_stack.append(matching_punctuation[text[position]]) - position += 1 - if punctuation_stack: - # Opening punctuations left without matching close-punctuations. - return None - # punctuations match. - return text[start_position:position - 1] + # Ignore "virtual" keywords that are near access-specifiers. These + # are only used in class base-specifier and do not apply to member + # functions. + if re.search(r"\b(public|protected|private)\s+$", virtual.group(1)) or re.match( + r"^\s+(public|protected|private)\b", virtual.group(3) + ): + return + # Ignore the "virtual" keyword from virtual base classes. Usually + # there is a column on the same line in these cases (virtual base + # classes are rare in google3 because multiple inheritance is rare). + if re.match(r"^.*[^:]:[^:].*$", line): + return -# Patterns for matching call-by-reference parameters. -# -# Supports nested templates up to 2 levels deep using this messy pattern: -# < (?: < (?: < [^<>]* -# > -# | [^<>] )* -# > -# | [^<>] )* -# > -_RE_PATTERN_IDENT = r'[_a-zA-Z]\w*' # =~ [[:alpha:]][[:alnum:]]* -_RE_PATTERN_TYPE = ( - r'(?:const\s+)?(?:typename\s+|class\s+|struct\s+|union\s+|enum\s+)?' - r'(?:\w|' - r'\s*<(?:<(?:<[^<>]*>|[^<>])*>|[^<>])*>|' - r'::)+') -# A call-by-reference parameter ends with '& identifier'. -_RE_PATTERN_REF_PARAM = re.compile( - r'(' + _RE_PATTERN_TYPE + r'(?:\s*(?:\bconst\b|[*]))*\s*' - r'&\s*' + _RE_PATTERN_IDENT + r')\s*(?:=[^,()]+)?[,)]') -# A call-by-const-reference parameter either ends with 'const& identifier' -# or looks like 'const type& identifier' when 'type' is atomic. -_RE_PATTERN_CONST_REF_PARAM = ( - r'(?:.*\s*\bconst\s*&\s*' + _RE_PATTERN_IDENT + - r'|const\s+' + _RE_PATTERN_TYPE + r'\s*&\s*' + _RE_PATTERN_IDENT + r')') -# Stream types. -_RE_PATTERN_REF_STREAM_PARAM = ( - r'(?:.*stream\s*&\s*' + _RE_PATTERN_IDENT + r')') - - -def CheckLanguage(filename, clean_lines, linenum, file_extension, - include_state, nesting_state, error): - """Checks rules from the 'C++ language rules' section of cppguide.html. - - Some of these rules are hard to test (function overloading, using - uint32_t inappropriately), but we do the best we can. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - file_extension: The extension (without the dot) of the filename. - include_state: An _IncludeState instance in which the headers are inserted. - nesting_state: A NestingState instance which maintains information about - the current stack of nested blocks being parsed. - error: The function to call with any errors found. - """ - # If the line is empty or consists of entirely a comment, no need to - # check it. - line = clean_lines.elided[linenum] - if not line: - return - - match = _RE_PATTERN_INCLUDE.search(line) - if match: - CheckIncludeLine(filename, clean_lines, linenum, include_state, error) - return - - # Reset include state across preprocessor directives. This is meant - # to silence warnings for conditional includes. - match = re.match(r'^\s*#\s*(if|ifdef|ifndef|elif|else|endif)\b', line) - if match: - include_state.ResetSection(match.group(1)) - - - # Perform other checks now that we are sure that this is not an include line - CheckCasts(filename, clean_lines, linenum, error) - CheckGlobalStatic(filename, clean_lines, linenum, error) - CheckPrintf(filename, clean_lines, linenum, error) - - if IsHeaderExtension(file_extension): - # TODO(unknown): check that 1-arg constructors are explicit. - # How to tell it's a constructor? - # (handled in CheckForNonStandardConstructs for now) - # TODO(unknown): check that classes declare or disable copy/assign - # (level 1 error) - pass + # Look for the next opening parenthesis. This is the start of the + # parameter list (possibly on the next line shortly after virtual). + # TODO(google): doesn't work if there are virtual functions with + # decltype() or other things that use parentheses, but csearch suggests + # that this is rare. + end_col = -1 + end_line = -1 + start_col = len(virtual.group(2)) + for start_line in range(linenum, min(linenum + 3, clean_lines.NumLines())): + line = clean_lines.elided[start_line][start_col:] + parameter_list = re.match(r"^([^(]*)\(", line) + if parameter_list: + # Match parentheses to find the end of the parameter list + (_, end_line, end_col) = CloseExpression( + clean_lines, start_line, start_col + len(parameter_list.group(1)) + ) + break + start_col = 0 + + if end_col < 0: + return # Couldn't find end of parameter list, give up + + # Look for "override" or "final" after the parameter list + # (possibly on the next few lines). + for i in range(end_line, min(end_line + 3, clean_lines.NumLines())): + line = clean_lines.elided[i][end_col:] + match = re.search(r"\b(override|final)\b", line) + if match: + error( + filename, + linenum, + "readability/inheritance", + 4, + ( + '"virtual" is redundant since function is ' + f'already declared as "{match.group(1)}"' + ), + ) + + # Set end_col to check whole lines after we are done with the + # first line. + end_col = 0 + if re.search(r"[^\w]\s*$", line): + break - # Check if people are using the verboten C basic types. The only exception - # we regularly allow is "unsigned short port" for port. - if re.search(r'\bshort port\b', line): - if not re.search(r'\bunsigned short port\b', line): - error(filename, linenum, 'runtime/int', 4, - 'Use "unsigned short" for ports, not "short"') - else: - match = re.search(r'\b(short|long(?! +double)|long long)\b', line) - if match: - error(filename, linenum, 'runtime/int', 4, - f'Use int16_t/int64_t/etc, rather than the C type {match.group(1)}') - - # Check if some verboten operator overloading is going on - # TODO(unknown): catch out-of-line unary operator&: - # class X {}; - # int operator&(const X& x) { return 42; } // unary operator& - # The trick is it's hard to tell apart from binary operator&: - # class Y { int operator&(const Y& x) { return 23; } }; // binary operator& - if re.search(r'\boperator\s*&\s*\(\s*\)', line): - error(filename, linenum, 'runtime/operator', 4, - 'Unary operator& is dangerous. Do not use it.') - - # Check for suspicious usage of "if" like - # } if (a == b) { - if re.search(r'\}\s*if\s*\(', line): - error(filename, linenum, 'readability/braces', 4, - 'Did you mean "else if"? If not, start a new line for "if".') - - # Check for potential format string bugs like printf(foo). - # We constrain the pattern not to pick things like DocidForPrintf(foo). - # Not perfect but it can catch printf(foo.c_str()) and printf(foo->c_str()) - # TODO(unknown): Catch the following case. Need to change the calling - # convention of the whole function to process multiple line to handle it. - # printf( - # boy_this_is_a_really_long_variable_that_cannot_fit_on_the_prev_line); - printf_args = _GetTextInside(line, r'(?i)\b(string)?printf\s*\(') - if printf_args: - match = re.match(r'([\w.\->()]+)$', printf_args) - if match and match.group(1) != '__VA_ARGS__': - function_name = re.search(r'\b((?:string)?printf)\s*\(', - line, re.I).group(1) - error(filename, linenum, 'runtime/printf', 4, - 'Potential format string bug. Do' - f' {function_name}("%s", {match.group(1)}) instead.') - - # Check for potential memset bugs like memset(buf, sizeof(buf), 0). - match = re.search(r'memset\s*\(([^,]*),\s*([^,]*),\s*0\s*\)', line) - if match and not re.match(r"^''|-?[0-9]+|0x[0-9A-Fa-f]$", match.group(2)): - error(filename, linenum, 'runtime/memset', 4, - f'Did you mean "memset({match.group(1)}, 0, {match.group(2)})"?') - - if re.search(r'\busing namespace\b', line): - if re.search(r'\bliterals\b', line): - error(filename, linenum, 'build/namespaces_literals', 5, - 'Do not use namespace using-directives. ' - 'Use using-declarations instead.') - else: - error(filename, linenum, 'build/namespaces', 5, - 'Do not use namespace using-directives. ' - 'Use using-declarations instead.') - - # Detect variable-length arrays. - match = re.match(r'\s*(.+::)?(\w+) [a-z]\w*\[(.+)];', line) - if (match and match.group(2) != 'return' and match.group(2) != 'delete' and - match.group(3).find(']') == -1): - # Split the size using space and arithmetic operators as delimiters. - # If any of the resulting tokens are not compile time constants then - # report the error. - tokens = re.split(r'\s|\+|\-|\*|\/|<<|>>]', match.group(3)) - is_const = True - skip_next = False - for tok in tokens: - if skip_next: - skip_next = False - continue - - if re.search(r'sizeof\(.+\)', tok): continue - if re.search(r'arraysize\(\w+\)', tok): continue - - tok = tok.lstrip('(') - tok = tok.rstrip(')') - if not tok: continue - if re.match(r'\d+', tok): continue - if re.match(r'0[xX][0-9a-fA-F]+', tok): continue - if re.match(r'k[A-Z0-9]\w*', tok): continue - if re.match(r'(.+::)?k[A-Z0-9]\w*', tok): continue - if re.match(r'(.+::)?[A-Z][A-Z0-9_]*', tok): continue - # A catch all for tricky sizeof cases, including 'sizeof expression', - # 'sizeof(*type)', 'sizeof(const type)', 'sizeof(struct StructName)' - # requires skipping the next token because we split on ' ' and '*'. - if tok.startswith('sizeof'): - skip_next = True - continue - is_const = False - break - if not is_const: - error(filename, linenum, 'runtime/arrays', 1, - 'Do not use variable-length arrays. Use an appropriately named ' - "('k' followed by CamelCase) compile-time constant for the size.") - - # Check for use of unnamed namespaces in header files. Registration - # macros are typically OK, so we allow use of "namespace {" on lines - # that end with backslashes. - if (IsHeaderExtension(file_extension) - and re.search(r'\bnamespace\s*{', line) - and line[-1] != '\\'): - error(filename, linenum, 'build/namespaces_headers', 4, - 'Do not use unnamed namespaces in header files. See ' - 'https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces' - ' for more information.') +def CheckRedundantOverrideOrFinal(filename, clean_lines, linenum, error): + """Check if line contains a redundant "override" or "final" virt-specifier. -def CheckGlobalStatic(filename, clean_lines, linenum, error): - """Check for unsafe global or static objects. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # Match two lines at a time to support multiline declarations - if linenum + 1 < clean_lines.NumLines() and not re.search(r'[;({]', line): - line += clean_lines.elided[linenum + 1].strip() - - # Check for people declaring static/global STL strings at the top level. - # This is dangerous because the C++ language does not guarantee that - # globals with constructors are initialized before the first access, and - # also because globals can be destroyed when some threads are still running. - # TODO(unknown): Generalize this to also find static unique_ptr instances. - # TODO(unknown): File bugs for clang-tidy to find these. - match = re.match( - r'((?:|static +)(?:|const +))(?::*std::)?string( +const)? +' - r'([a-zA-Z0-9_:]+)\b(.*)', - line) - - # Remove false positives: - # - String pointers (as opposed to values). - # string *pointer - # const string *pointer - # string const *pointer - # string *const pointer - # - # - Functions and template specializations. - # string Function(... - # string Class::Method(... - # - # - Operators. These are matched separately because operator names - # cross non-word boundaries, and trying to match both operators - # and functions at the same time would decrease accuracy of - # matching identifiers. - # string Class::operator*() - if (match and - not re.search(r'\bstring\b(\s+const)?\s*[\*\&]\s*(const\s+)?\w', line) and - not re.search(r'\boperator\W', line) and - not re.match(r'\s*(<.*>)?(::[a-zA-Z0-9_]+)*\s*\(([^"]|$)', match.group(4))): - if re.search(r'\bconst\b', line): - error(filename, linenum, 'runtime/string', 4, - 'For a static/global string constant, use a C style string instead:' - f' "{match.group(1)}char{match.group(2) or ""} {match.group(3)}[]".') + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + # Look for closing parenthesis nearby. We need one to confirm where + # the declarator ends and where the virt-specifier starts to avoid + # false positives. + line = clean_lines.elided[linenum] + if (declarator_end := line.rfind(")")) >= 0: + fragment = line[declarator_end:] else: - error(filename, linenum, 'runtime/string', 4, - 'Static/global string variables are not permitted.') + if linenum > 1 and clean_lines.elided[linenum - 1].rfind(")") >= 0: + fragment = line + else: + return - if (re.search(r'\b([A-Za-z0-9_]*_)\(\1\)', line) or - re.search(r'\b([A-Za-z0-9_]*_)\(CHECK_NOTNULL\(\1\)\)', line)): - error(filename, linenum, 'runtime/init', 4, - 'You seem to be initializing a member variable with itself.') + # Check that at most one of "override" or "final" is present, not both + if re.search(r"\boverride\b", fragment) and re.search(r"\bfinal\b", fragment): + error( + filename, + linenum, + "readability/inheritance", + 4, + ('"override" is redundant since function is already declared as "final"'), + ) -def CheckPrintf(filename, clean_lines, linenum, error): - """Check for printf related issues. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # When snprintf is used, the second argument shouldn't be a literal. - match = re.search(r'snprintf\s*\(([^,]*),\s*([0-9]*)\s*,', line) - if match and match.group(2) != '0': - # If 2nd arg is zero, snprintf is used to calculate size. - error(filename, linenum, 'runtime/printf', 3, 'If you can, use' - f' sizeof({match.group(1)}) instead of {match.group(2)}' - ' as the 2nd arg to snprintf.') - - # Check if some verboten C functions are being used. - if re.search(r'\bsprintf\s*\(', line): - error(filename, linenum, 'runtime/printf', 5, - 'Never use sprintf. Use snprintf instead.') - match = re.search(r'\b(strcpy|strcat)\s*\(', line) - if match: - error(filename, linenum, 'runtime/printf', 4, - f'Almost always, snprintf is better than {match.group(1)}') +# Returns true if we are at a new block, and it is directly +# inside of a namespace. +def IsBlockInNameSpace(nesting_state, is_forward_declaration): + """Checks that the new block is directly in a namespace. + Args: + nesting_state: The _NestingState object that contains info about our state. + is_forward_declaration: If the class is a forward declared class. + Returns: + Whether or not the new block is directly in a namespace. + """ + if is_forward_declaration: + return len(nesting_state.stack) >= 1 and ( + isinstance(nesting_state.stack[-1], _NamespaceInfo) + ) + + if len(nesting_state.stack) >= 1: + if isinstance(nesting_state.stack[-1], _NamespaceInfo): + return True + if ( + len(nesting_state.stack) > 1 + and isinstance(nesting_state.previous_stack_top, _NamespaceInfo) + and isinstance(nesting_state.stack[-2], _NamespaceInfo) + ): + return True + return False -def IsDerivedFunction(clean_lines, linenum): - """Check if current line contains an inherited function. - - Args: - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - Returns: - True if current line contains a function with "override" - virt-specifier. - """ - # Scan back a few lines for start of current function - for i in range(linenum, max(-1, linenum - 10), -1): - match = re.match(r'^([^()]*\w+)\(', clean_lines.elided[i]) - if match: - # Look for "override" after the matching closing parenthesis - line, _, closing_paren = CloseExpression( - clean_lines, i, len(match.group(1))) - return (closing_paren >= 0 and - re.search(r'\boverride\b', line[closing_paren:])) - return False +def ShouldCheckNamespaceIndentation( + nesting_state: NestingState, is_namespace_indent_item, raw_lines_no_comments, linenum +): + """This method determines if we should apply our namespace indentation check. -def IsOutOfLineMethodDefinition(clean_lines, linenum): - """Check if current line contains an out-of-line method definition. + Args: + nesting_state: The current nesting state. + is_namespace_indent_item: If we just put a new class on the stack, True. + If the top of the stack is not a class, or we did not recently + add the class, False. + raw_lines_no_comments: The lines without the comments. + linenum: The current line number we are processing. - Args: - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - Returns: - True if current line contains an out-of-line method definition. - """ - # Scan back a few lines for start of current function - for i in range(linenum, max(-1, linenum - 10), -1): - if re.match(r'^([^()]*\w+)\(', clean_lines.elided[i]): - return re.match(r'^[^()]*\w+::\w+\(', clean_lines.elided[i]) is not None - return False + Returns: + True if we should apply our namespace indentation check. Currently, it + only works for classes and namespaces inside of a namespace. + """ + is_forward_declaration = IsForwardClassDeclaration(raw_lines_no_comments, linenum) -def IsInitializerList(clean_lines, linenum): - """Check if current line is inside constructor initializer list. - - Args: - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - Returns: - True if current line appears to be inside constructor initializer - list, False otherwise. - """ - for i in range(linenum, 1, -1): - line = clean_lines.elided[i] - if i == linenum: - remove_function_body = re.match(r'^(.*)\{\s*$', line) - if remove_function_body: - line = remove_function_body.group(1) - - if re.search(r'\s:\s*\w+[({]', line): - # A lone colon tend to indicate the start of a constructor - # initializer list. It could also be a ternary operator, which - # also tend to appear in constructor initializer lists as - # opposed to parameter lists. - return True - if re.search(r'\}\s*,\s*$', line): - # A closing brace followed by a comma is probably the end of a - # brace-initialized member in constructor initializer list. - return True - if re.search(r'[{};]\s*$', line): - # Found one of the following: - # - A closing brace or semicolon, probably the end of the previous - # function. - # - An opening brace, probably the start of current class or namespace. - # - # Current line is probably not inside an initializer list since - # we saw one of those things without seeing the starting colon. - return False - - # Got to the beginning of the file without seeing the start of - # constructor initializer list. - return False - - -def CheckForNonConstReference(filename, clean_lines, linenum, - nesting_state, error): - """Check for non-const references. - - Separate from CheckLanguage since it scans backwards from current - line, instead of scanning forward. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - nesting_state: A NestingState instance which maintains information about - the current stack of nested blocks being parsed. - error: The function to call with any errors found. - """ - # Do nothing if there is no '&' on current line. - line = clean_lines.elided[linenum] - if '&' not in line: - return - - # If a function is inherited, current function doesn't have much of - # a choice, so any non-const references should not be blamed on - # derived function. - if IsDerivedFunction(clean_lines, linenum): - return - - # Don't warn on out-of-line method definitions, as we would warn on the - # in-line declaration, if it isn't marked with 'override'. - if IsOutOfLineMethodDefinition(clean_lines, linenum): - return - - # Long type names may be broken across multiple lines, usually in one - # of these forms: - # LongType - # ::LongTypeContinued &identifier - # LongType:: - # LongTypeContinued &identifier - # LongType< - # ...>::LongTypeContinued &identifier - # - # If we detected a type split across two lines, join the previous - # line to current line so that we can match const references - # accordingly. - # - # Note that this only scans back one line, since scanning back - # arbitrary number of lines would be expensive. If you have a type - # that spans more than 2 lines, please use a typedef. - if linenum > 1: - previous = None - if re.match(r'\s*::(?:[\w<>]|::)+\s*&\s*\S', line): - # previous_line\n + ::current_line - previous = re.search(r'\b((?:const\s*)?(?:[\w<>]|::)+[\w<>])\s*$', - clean_lines.elided[linenum - 1]) - elif re.match(r'\s*[a-zA-Z_]([\w<>]|::)+\s*&\s*\S', line): - # previous_line::\n + current_line - previous = re.search(r'\b((?:const\s*)?(?:[\w<>]|::)+::)\s*$', - clean_lines.elided[linenum - 1]) - if previous: - line = previous.group(1) + line.lstrip() - else: - # Check for templated parameter that is split across multiple lines - endpos = line.rfind('>') - if endpos > -1: - (_, startline, startpos) = ReverseCloseExpression( - clean_lines, linenum, endpos) - if startpos > -1 and startline < linenum: - # Found the matching < on an earlier line, collect all - # pieces up to current line. - line = '' - for i in range(startline, linenum + 1): - line += clean_lines.elided[i].strip() - - # Check for non-const references in function parameters. A single '&' may - # found in the following places: - # inside expression: binary & for bitwise AND - # inside expression: unary & for taking the address of something - # inside declarators: reference parameter - # We will exclude the first two cases by checking that we are not inside a - # function body, including one that was just introduced by a trailing '{'. - # TODO(unknown): Doesn't account for 'catch(Exception& e)' [rare]. - if (nesting_state.previous_stack_top and - not (isinstance(nesting_state.previous_stack_top, _ClassInfo) or - isinstance(nesting_state.previous_stack_top, _NamespaceInfo))): - # Not at toplevel, not within a class, and not within a namespace - return - - # Avoid initializer lists. We only need to scan back from the - # current line for something that starts with ':'. - # - # We don't need to check the current line, since the '&' would - # appear inside the second set of parentheses on the current line as - # opposed to the first set. - if linenum > 0: - for i in range(linenum - 1, max(0, linenum - 10), -1): - previous_line = clean_lines.elided[i] - if not re.search(r'[),]\s*$', previous_line): - break - if re.match(r'^\s*:\s+\S', previous_line): - return + if not (is_namespace_indent_item or is_forward_declaration): + return False - # Avoid preprocessors - if re.search(r'\\\s*$', line): - return - - # Avoid constructor initializer lists - if IsInitializerList(clean_lines, linenum): - return - - # We allow non-const references in a few standard places, like functions - # called "swap()" or iostream operators like "<<" or ">>". Do not check - # those function parameters. - # - # We also accept & in static_assert, which looks like a function but - # it's actually a declaration expression. - allowed_functions = (r'(?:[sS]wap(?:<\w:+>)?|' - r'operator\s*[<>][<>]|' - r'static_assert|COMPILE_ASSERT' - r')\s*\(') - if re.search(allowed_functions, line): - return - elif not re.search(r'\S+\([^)]*$', line): - # Don't see an allowed function on this line. Actually we - # didn't see any function name on this line, so this is likely a - # multi-line parameter list. Try a bit harder to catch this case. - for i in range(2): - if (linenum > i and - re.search(allowed_functions, clean_lines.elided[linenum - i - 1])): - return + # If we are in a macro, we do not want to check the namespace indentation. + if IsMacroDefinition(raw_lines_no_comments, linenum): + return False - decls = re.sub(r'{[^}]*}', ' ', line) # exclude function body - for parameter in re.findall(_RE_PATTERN_REF_PARAM, decls): - if (not re.match(_RE_PATTERN_CONST_REF_PARAM, parameter) and - not re.match(_RE_PATTERN_REF_STREAM_PARAM, parameter)): - error(filename, linenum, 'runtime/references', 2, - 'Is this a non-const reference? ' - 'If so, make const or use a pointer: ' + - re.sub(' *<', '<', parameter)) + # Skip if we are inside an open parenthesis block (e.g. function parameters). + if nesting_state.previous_stack_top and nesting_state.previous_open_parentheses > 0: + return False + return IsBlockInNameSpace(nesting_state, is_forward_declaration) -def CheckCasts(filename, clean_lines, linenum, error): - """Various cast related checks. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - # Check to see if they're using an conversion function cast. - # I just try to capture the most common basic types, though there are more. - # Parameterless conversion functions, such as bool(), are allowed as they are - # probably a member operator declaration or default constructor. - match = re.search( - r'(\bnew\s+(?:const\s+)?|\S<\s*(?:const\s+)?)?\b' - r'(int|float|double|bool|char|int16_t|uint16_t|int32_t|uint32_t|int64_t|uint64_t)' - r'(\([^)].*)', line) - expecting_function = ExpectingFunctionArgs(clean_lines, linenum) - if match and not expecting_function: - matched_type = match.group(2) - - # matched_new_or_template is used to silence two false positives: - # - New operators - # - Template arguments with function types - # - # For template arguments, we match on types immediately following - # an opening bracket without any spaces. This is a fast way to - # silence the common case where the function type is the first - # template argument. False negative with less-than comparison is - # avoided because those operators are usually followed by a space. - # - # function // bracket + no space = false positive - # value < double(42) // bracket + space = true positive - matched_new_or_template = match.group(1) - - # Avoid arrays by looking for brackets that come after the closing - # parenthesis. - if re.match(r'\([^()]+\)\s*\[', match.group(3)): - return - - # Other things to ignore: - # - Function pointers - # - Casts to pointer types - # - Placement new - # - Alias declarations - matched_funcptr = match.group(3) - if (matched_new_or_template is None and - not (matched_funcptr and - (re.match(r'\((?:[^() ]+::\s*\*\s*)?[^() ]+\)\s*\(', - matched_funcptr) or - matched_funcptr.startswith('(*)'))) and - not re.match(r'\s*using\s+\S+\s*=\s*' + matched_type, line) and - not re.search(r'new\(\S+\)\s*' + matched_type, line)): - error(filename, linenum, 'readability/casting', 4, - 'Using deprecated casting style. ' - f'Use static_cast<{matched_type}>(...) instead') - - if not expecting_function: - CheckCStyleCast(filename, clean_lines, linenum, 'static_cast', - r'\((int|float|double|bool|char|u?int(16|32|64)_t|size_t)\)', error) - - # This doesn't catch all cases. Consider (const char * const)"hello". - # - # (char *) "foo" should always be a const_cast (reinterpret_cast won't - # compile). - if CheckCStyleCast(filename, clean_lines, linenum, 'const_cast', - r'\((char\s?\*+\s?)\)\s*"', error): - pass - else: - # Check pointer casts for other than string constants - CheckCStyleCast(filename, clean_lines, linenum, 'reinterpret_cast', - r'\((\w+\s?\*+\s?)\)', error) - - # In addition, we look for people taking the address of a cast. This - # is dangerous -- casts can assign to temporaries, so the pointer doesn't - # point where you think. - # - # Some non-identifier character is required before the '&' for the - # expression to be recognized as a cast. These are casts: - # expression = &static_cast(temporary()); - # function(&(int*)(temporary())); - # - # This is not a cast: - # reference_type&(int* function_param); - match = re.search( - r'(?:[^\w]&\(([^)*][^)]*)\)[\w(])|' - r'(?:[^\w]&(static|dynamic|down|reinterpret)_cast\b)', line) - if match: - # Try a better error message when the & is bound to something - # dereferenced by the casted pointer, as opposed to the casted - # pointer itself. - parenthesis_error = False - match = re.match(r'^(.*&(?:static|dynamic|down|reinterpret)_cast\b)<', line) - if match: - _, y1, x1 = CloseExpression(clean_lines, linenum, len(match.group(1))) - if x1 >= 0 and clean_lines.elided[y1][x1] == '(': - _, y2, x2 = CloseExpression(clean_lines, y1, x1) - if x2 >= 0: - extended_line = clean_lines.elided[y2][x2:] - if y2 < clean_lines.NumLines() - 1: - extended_line += clean_lines.elided[y2 + 1] - if re.match(r'\s*(?:->|\[)', extended_line): - parenthesis_error = True - - if parenthesis_error: - error(filename, linenum, 'readability/casting', 4, - ('Are you taking an address of something dereferenced ' - 'from a cast? Wrapping the dereferenced expression in ' - 'parentheses will make the binding more obvious')) - else: - error(filename, linenum, 'runtime/casting', 4, - ('Are you taking an address of a cast? ' - 'This is dangerous: could be a temp var. ' - 'Take the address before doing the cast, rather than after')) +# Call this method if the line is directly inside of a namespace. +# If the line above is blank (excluding comments) or the start of +# an inner namespace, it cannot be indented. +def CheckItemIndentationInNamespace(filename, raw_lines_no_comments, linenum, error): + line = raw_lines_no_comments[linenum] + if re.match(r"^\s+", line): + error( + filename, linenum, "whitespace/indent_namespace", 4, "Do not indent within a namespace." + ) + + +def ProcessLine( + filename, + file_extension, + clean_lines, + line, + include_state, + function_state, + nesting_state, + error, + extra_check_functions=None, + cppvar=None, +): + """Processes a single line in the file. -def CheckCStyleCast(filename, clean_lines, linenum, cast_type, pattern, error): - """Checks for a C-style cast by looking for the pattern. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - cast_type: The string for the C++ cast to recommend. This is either - reinterpret_cast, static_cast, or const_cast, depending. - pattern: The regular expression used to find C-style casts. - error: The function to call with any errors found. - - Returns: - True if an error was emitted. - False otherwise. - """ - line = clean_lines.elided[linenum] - match = re.search(pattern, line) - if not match: - return False + Args: + filename: Filename of the file that is being processed. + file_extension: The extension (dot not included) of the file. + clean_lines: An array of strings, each representing a line of the file, + with comments stripped. + line: Number of line being processed. + include_state: An _IncludeState instance in which the headers are inserted. + function_state: A _FunctionState instance which counts function lines, etc. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: A callable to which errors are reported, which takes 4 arguments: + filename, line number, error level, and message + extra_check_functions: An array of additional check functions that will be + run on each source line. Each function takes 4 + arguments: filename, clean_lines, line, error + cppvar: The header guard variable returned by GetHeaderGuardCPPVar. + """ + raw_lines = clean_lines.raw_lines + ParseNolintSuppressions(filename, raw_lines[line], line, error) + nesting_state.Update(filename, clean_lines, line, error) + CheckForNamespaceIndentation(filename, nesting_state, clean_lines, line, error) + if nesting_state.InAsmBlock(): + return + CheckForFunctionLengths(filename, clean_lines, line, function_state, error) + CheckForMultilineCommentsAndStrings(filename, clean_lines, line, error) + CheckStyle(filename, clean_lines, line, file_extension, nesting_state, error, cppvar) + CheckLanguage(filename, clean_lines, line, file_extension, include_state, nesting_state, error) + CheckForNonConstReference(filename, clean_lines, line, nesting_state, error) + CheckForNonStandardConstructs(filename, clean_lines, line, nesting_state, error) + CheckVlogArguments(filename, clean_lines, line, error) + CheckPosixThreading(filename, clean_lines, line, error) + CheckInvalidIncrement(filename, clean_lines, line, error) + CheckMakePairUsesDeduction(filename, clean_lines, line, error) + CheckRedundantVirtual(filename, clean_lines, line, error) + CheckRedundantOverrideOrFinal(filename, clean_lines, line, error) + if extra_check_functions: + for check_fn in extra_check_functions: + check_fn(filename, clean_lines, line, error) - # Exclude lines with keywords that tend to look like casts - context = line[0:match.start(1) - 1] - if re.match(r'.*\b(?:sizeof|alignof|alignas|[_A-Z][_A-Z0-9]*)\s*$', context): - return False - # Try expanding current context to see if we one level of - # parentheses inside a macro. - if linenum > 0: - for i in range(linenum - 1, max(0, linenum - 5), -1): - context = clean_lines.elided[i] + context - if re.match(r'.*\b[_A-Z][_A-Z0-9]*\s*\((?:\([^()]*\)|[^()])*$', context): - return False +def FlagCxxHeaders(filename, clean_lines, linenum, error): + """Flag C++ headers that the styleguide restricts. - # operator++(int) and operator--(int) - if (context.endswith(' operator++') or context.endswith(' operator--') or - context.endswith('::operator++') or context.endswith('::operator--')): - return False + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] - # A single unnamed argument for a function tends to look like old style cast. - # If we see those, don't issue warnings for deprecated casts. - remainder = line[match.end(0):] - if re.match(r'^\s*(?:;|const\b|throw\b|final\b|override\b|[=>{),]|->)', - remainder): - return False + include = re.match(r'\s*#\s*include\s+[<"]([^<"]+)[">]', line) - # At this point, all that should be left is actual casts. - error(filename, linenum, 'readability/casting', 4, - f'Using C-style cast. Use {cast_type}<{match.group(1)}>(...) instead') + # Flag unapproved C++11 headers. + if include and include.group(1) in ( + "cfenv", + "fenv.h", + "ratio", + ): + error( + filename, + linenum, + "build/c++11", + 5, + f"<{include.group(1)}> is an unapproved C++11 header.", + ) - return True + # filesystem is the only unapproved C++17 header + if include and include.group(1) == "filesystem": + error(filename, linenum, "build/c++17", 5, " is an unapproved C++17 header.") -def ExpectingFunctionArgs(clean_lines, linenum): - """Checks whether where function type arguments are expected. - - Args: - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - - Returns: - True if the line at 'linenum' is inside something that expects arguments - of function types. - """ - line = clean_lines.elided[linenum] - return (re.match(r'^\s*MOCK_(CONST_)?METHOD\d+(_T)?\(', line) or - (linenum >= 2 and - (re.match(r'^\s*MOCK_(?:CONST_)?METHOD\d+(?:_T)?\((?:\S+,)?\s*$', - clean_lines.elided[linenum - 1]) or - re.match(r'^\s*MOCK_(?:CONST_)?METHOD\d+(?:_T)?\(\s*$', - clean_lines.elided[linenum - 2]) or - re.search(r'\bstd::m?function\s*\<\s*$', - clean_lines.elided[linenum - 1])))) - - -_HEADERS_CONTAINING_TEMPLATES = ( - ('', ('deque',)), - ('', ('unary_function', 'binary_function', - 'plus', 'minus', 'multiplies', 'divides', 'modulus', - 'negate', - 'equal_to', 'not_equal_to', 'greater', 'less', - 'greater_equal', 'less_equal', - 'logical_and', 'logical_or', 'logical_not', - 'unary_negate', 'not1', 'binary_negate', 'not2', - 'bind1st', 'bind2nd', - 'pointer_to_unary_function', - 'pointer_to_binary_function', - 'ptr_fun', - 'mem_fun_t', 'mem_fun', 'mem_fun1_t', 'mem_fun1_ref_t', - 'mem_fun_ref_t', - 'const_mem_fun_t', 'const_mem_fun1_t', - 'const_mem_fun_ref_t', 'const_mem_fun1_ref_t', - 'mem_fun_ref', - )), - ('', ('numeric_limits',)), - ('', ('list',)), - ('', ('multimap',)), - ('', ('allocator', 'make_shared', 'make_unique', 'shared_ptr', - 'unique_ptr', 'weak_ptr')), - ('', ('queue', 'priority_queue',)), - ('', ('set', 'multiset',)), - ('', ('stack',)), - ('', ('char_traits', 'basic_string',)), - ('', ('tuple',)), - ('', ('unordered_map', 'unordered_multimap')), - ('', ('unordered_set', 'unordered_multiset')), - ('', ('pair',)), - ('', ('vector',)), +def ProcessFileData(filename, file_extension, lines, error, extra_check_functions=None): + """Performs lint checks and reports any errors to the given error function. - # gcc extensions. - # Note: std::hash is their hash, ::hash is our hash - ('', ('hash_map', 'hash_multimap',)), - ('', ('hash_set', 'hash_multiset',)), - ('', ('slist',)), + Args: + filename: Filename of the file that is being processed. + file_extension: The extension (dot not included) of the file. + lines: An array of strings, each representing a line of the file, with the + last element being empty if the file is terminated with a newline. + error: A callable to which errors are reported, which takes 4 arguments: + filename, line number, error level, and message + extra_check_functions: An array of additional check functions that will be + run on each source line. Each function takes 4 + arguments: filename, clean_lines, line, error + """ + lines = ( + ["// marker so line numbers and indices both start at 1"] + + lines + + ["// marker so line numbers end in a known way"] ) -_HEADERS_MAYBE_TEMPLATES = ( - ('', ('copy', 'max', 'min', 'min_element', 'sort', - 'transform', - )), - ('', ('forward', 'make_pair', 'move', 'swap')), - ) + include_state = _IncludeState() + function_state = _FunctionState() + nesting_state = NestingState() + + ResetNolintSuppressions() + + CheckForCopyright(filename, lines, error) + ProcessGlobalSuppressions(filename, lines) + RemoveMultiLineComments(filename, lines, error) + clean_lines = CleansedLines(lines) + + cppvar = None + if IsHeaderExtension(file_extension): + cppvar = GetHeaderGuardCPPVariable(filename) + CheckForHeaderGuard(filename, clean_lines, error, cppvar) + + for line in range(clean_lines.NumLines()): + ProcessLine( + filename, + file_extension, + clean_lines, + line, + include_state, + function_state, + nesting_state, + error, + extra_check_functions, + cppvar, + ) + FlagCxxHeaders(filename, clean_lines, line, error) + if _error_suppressions.HasOpenBlock(): + error( + filename, + _error_suppressions.GetOpenBlockStart(), + "readability/nolint", + 5, + "NONLINT block never ended", + ) + + CheckForIncludeWhatYouUse(filename, clean_lines, include_state, error) + + # Check that the .cc file has included its header if it exists. + if _IsSourceExtension(file_extension): + CheckHeaderFileIncluded(filename, include_state, error) + + # We check here rather than inside ProcessLine so that we see raw + # lines rather than "cleaned" lines. + CheckForBadCharacters(filename, lines, error) + + CheckForNewlineAtEOF(filename, lines, error) -# Non templated types or global objects -_HEADERS_TYPES_OR_OBJS = ( - # String and others are special -- it is a non-templatized type in STL. - ('', ('string',)), - ('', ('cin', 'cout', 'cerr', 'clog', 'wcin', 'wcout', - 'wcerr', 'wclog')), - ('', ('FILE', 'fpos_t'))) -# Non templated functions -_HEADERS_FUNCTIONS = ( - ('', ('fopen', 'freopen', - 'fclose', 'fflush', 'setbuf', 'setvbuf', 'fread', - 'fwrite', 'fgetc', 'getc', 'fgets', 'fputc', 'putc', - 'fputs', 'getchar', 'gets', 'putchar', 'puts', 'ungetc', - 'scanf', 'fscanf', 'sscanf', 'vscanf', 'vfscanf', - 'vsscanf', 'printf', 'fprintf', 'sprintf', 'snprintf', - 'vprintf', 'vfprintf', 'vsprintf', 'vsnprintf', - 'ftell', 'fgetpos', 'fseek', 'fsetpos', - 'clearerr', 'feof', 'ferror', 'perror', - 'tmpfile', 'tmpnam'),),) - -_re_pattern_headers_maybe_templates = [] -for _header, _templates in _HEADERS_MAYBE_TEMPLATES: - for _template in _templates: - # Match max(..., ...), max(..., ...), but not foo->max, foo.max or - # 'type::max()'. - _re_pattern_headers_maybe_templates.append( - (re.compile(r'((\bstd::)|[^>.:])\b' + _template + r'(<.*?>)?\([^\)]'), - _template, - _header)) +def ProcessConfigOverrides(filename): + """Loads the configuration files and processes the config overrides. -# Map is often overloaded. Only check, if it is fully qualified. -# Match 'std::map(...)', but not 'map(...)'' -_re_pattern_headers_maybe_templates.append( - (re.compile(r'(std\b::\bmap\s*\<)|(^(std\b::\b)map\b\(\s*\<)'), - 'map<>', - '')) + Args: + filename: The name of the file being processed by the linter. -# Other scripts may reach in and modify this pattern. -_re_pattern_templates = [] -for _header, _templates in _HEADERS_CONTAINING_TEMPLATES: - for _template in _templates: - _re_pattern_templates.append( - (re.compile(r'((^|(^|\s|((^|\W)::))std::)|[^>.:]\b)' + _template + r'\s*\<'), - _template + '<>', - _header)) + Returns: + False if the current |filename| should not be processed further. + """ -_re_pattern_types_or_objs = [] -for _header, _types_or_objs in _HEADERS_TYPES_OR_OBJS: - for _type_or_obj in _types_or_objs: - _re_pattern_types_or_objs.append( - (re.compile(r'\b' + _type_or_obj + r'\b'), - _type_or_obj, - _header)) + abs_filename = os.path.abspath(filename) + cfg_filters = [] + keep_looking = True + while keep_looking: + abs_path, base_name = os.path.split(abs_filename) + if not base_name: + break # Reached the root directory. + + cfg_file = os.path.join(abs_path, _config_filename) + abs_filename = abs_path + if not os.path.isfile(cfg_file): + continue -_re_pattern_functions = [] -for _header, _functions in _HEADERS_FUNCTIONS: - for _function in _functions: - # Match printf(..., ...), but not foo->printf, foo.printf or - # 'type::printf()'. - _re_pattern_functions.append( - (re.compile(r'([^>.]|^)\b' + _function + r'\([^\)]'), - _function, - _header)) + try: + with codecs.open(cfg_file, "r", "utf8", "replace") as file_handle: + for line in file_handle: + line, _, _ = line.partition("#") # Remove comments. + if not line.strip(): + continue + + name, _, val = line.partition("=") + name = name.strip() + val = val.strip() + if name == "set noparent": + keep_looking = False + elif name == "filter": + cfg_filters.append(val) + elif name == "exclude_files": + # When matching exclude_files pattern, use the base_name of + # the current file name or the directory name we are processing. + # For example, if we are checking for lint errors in /foo/bar/baz.cc + # and we found the .cfg file at /foo/CPPLINT.cfg, then the config + # file's "exclude_files" filter is meant to be checked against "bar" + # and not "baz" nor "bar/baz.cc". + if base_name: + pattern = re.compile(val) + if pattern.match(base_name): + if _cpplint_state.quiet: + # Suppress "Ignoring file" warning when using --quiet. + return False + _cpplint_state.PrintInfo( + f'Ignoring "{filename}": file excluded by "{cfg_file}". ' + 'File path component "%s" matches ' + 'pattern "%s"\n' % (base_name, val) + ) + return False + elif name == "linelength": + global _line_length + try: + _line_length = int(val) + except ValueError: + _cpplint_state.PrintError("Line length must be numeric.") + elif name == "extensions": + ProcessExtensionsOption(val) + elif name == "root": + global _root + # root directories are specified relative to CPPLINT.cfg dir. + _root = os.path.join(os.path.dirname(cfg_file), val) + elif name == "headers": + ProcessHppHeadersOption(val) + elif name == "includeorder": + ProcessIncludeOrderOption(val) + else: + _cpplint_state.PrintError( + f"Invalid configuration option ({name}) in file {cfg_file}\n" + ) + + except OSError: + _cpplint_state.PrintError( + f"Skipping config file '{cfg_file}': Can't open for reading\n" + ) + keep_looking = False -def FilesBelongToSameModule(filename_cc, filename_h): - """Check if these two filenames belong to the same module. - - The concept of a 'module' here is a as follows: - foo.h, foo-inl.h, foo.cc, foo_test.cc and foo_unittest.cc belong to the - same 'module' if they are in the same directory. - some/path/public/xyzzy and some/path/internal/xyzzy are also considered - to belong to the same module here. - - If the filename_cc contains a longer path than the filename_h, for example, - '/absolute/path/to/base/sysinfo.cc', and this file would include - 'base/sysinfo.h', this function also produces the prefix needed to open the - header. This is used by the caller of this function to more robustly open the - header file. We don't have access to the real include paths in this context, - so we need this guesswork here. - - Known bugs: tools/base/bar.cc and base/bar.h belong to the same module - according to this implementation. Because of this, this function gives - some false positives. This should be sufficiently rare in practice. - - Args: - filename_cc: is the path for the source (e.g. .cc) file - filename_h: is the path for the header path - - Returns: - Tuple with a bool and a string: - bool: True if filename_cc and filename_h belong to the same module. - string: the additional prefix needed to open the header file. - """ - fileinfo_cc = FileInfo(filename_cc) - if fileinfo_cc.Extension().lstrip('.') not in GetNonHeaderExtensions(): - return (False, '') - - fileinfo_h = FileInfo(filename_h) - if not IsHeaderExtension(fileinfo_h.Extension().lstrip('.')): - return (False, '') - - filename_cc = filename_cc[:-(len(fileinfo_cc.Extension()))] - matched_test_suffix = re.search(_TEST_FILE_SUFFIX, fileinfo_cc.BaseName()) - if matched_test_suffix: - filename_cc = filename_cc[:-len(matched_test_suffix.group(1))] - - filename_cc = filename_cc.replace('/public/', '/') - filename_cc = filename_cc.replace('/internal/', '/') - - filename_h = filename_h[:-(len(fileinfo_h.Extension()))] - if filename_h.endswith('-inl'): - filename_h = filename_h[:-len('-inl')] - filename_h = filename_h.replace('/public/', '/') - filename_h = filename_h.replace('/internal/', '/') - - files_belong_to_same_module = filename_cc.endswith(filename_h) - common_path = '' - if files_belong_to_same_module: - common_path = filename_cc[:-len(filename_h)] - return files_belong_to_same_module, common_path - - -def CheckForIncludeWhatYouUse(filename, clean_lines, include_state, error, - io=codecs): - """Reports for missing stl includes. - - This function will output warnings to make sure you are including the headers - necessary for the stl containers and functions that you use. We only give one - reason to include a header. For example, if you use both equal_to<> and - less<> in a .h file, only one (the latter in the file) of these will be - reported as a reason to include the . - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - include_state: An _IncludeState instance. - error: The function to call with any errors found. - io: The IO factory to use to read the header file. Provided for unittest - injection. - """ - required = {} # A map of header name to linenumber and the template entity. - # Example of required: { '': (1219, 'less<>') } - - for linenum in range(clean_lines.NumLines()): - line = clean_lines.elided[linenum] - if not line or line[0] == '#': - continue - - _re_patterns = [] - _re_patterns.extend(_re_pattern_types_or_objs) - _re_patterns.extend(_re_pattern_functions) - for pattern, item, header in _re_patterns: - matched = pattern.search(line) - if matched: - # Don't warn about strings in non-STL namespaces: - # (We check only the first match per line; good enough.) - prefix = line[:matched.start()] - if prefix.endswith('std::') or not prefix.endswith('::'): - required[header] = (linenum, item) - - for pattern, template, header in _re_pattern_headers_maybe_templates: - if pattern.search(line): - required[header] = (linenum, template) - - # The following function is just a speed up, no semantics are changed. - if '<' not in line: # Reduces the cpu time usage by skipping lines. - continue - - for pattern, template, header in _re_pattern_templates: - matched = pattern.search(line) - if matched: - # Don't warn about IWYU in non-STL namespaces: - # (We check only the first match per line; good enough.) - prefix = line[:matched.start()] - if prefix.endswith('std::') or not prefix.endswith('::'): - required[header] = (linenum, template) - - # Let's flatten the include_state include_list and copy it into a dictionary. - include_dict = dict([item for sublist in include_state.include_list - for item in sublist]) - - # All the lines have been processed, report the errors found. - for required_header_unstripped in sorted(required, key=required.__getitem__): - template = required[required_header_unstripped][1] - if required_header_unstripped.strip('<>"') not in include_dict: - error(filename, required[required_header_unstripped][0], - 'build/include_what_you_use', 4, - 'Add #include ' + required_header_unstripped + ' for ' + template) - - -_RE_PATTERN_EXPLICIT_MAKEPAIR = re.compile(r'\bmake_pair\s*<') + # Apply all the accumulated filters in reverse order (top-level directory + # config options having the least priority). + for cfg_filter in reversed(cfg_filters): + _AddFilters(cfg_filter) + return True -def CheckMakePairUsesDeduction(filename, clean_lines, linenum, error): - """Check that make_pair's template arguments are deduced. - - G++ 4.6 in C++11 mode fails badly if make_pair's template arguments are - specified explicitly, and such use isn't intended in any case. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - match = _RE_PATTERN_EXPLICIT_MAKEPAIR.search(line) - if match: - error(filename, linenum, 'build/explicit_make_pair', - 4, # 4 = high confidence - 'For C++11-compatibility, omit template arguments from make_pair' - ' OR use pair directly OR if appropriate, construct a pair directly') +def ProcessFile(filename, vlevel, extra_check_functions=None): + """Does google-lint on a single file. -def CheckRedundantVirtual(filename, clean_lines, linenum, error): - """Check if line contains a redundant "virtual" function-specifier. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - # Look for "virtual" on current line. - line = clean_lines.elided[linenum] - virtual = re.match(r'^(.*)(\bvirtual\b)(.*)$', line) - if not virtual: return - - # Ignore "virtual" keywords that are near access-specifiers. These - # are only used in class base-specifier and do not apply to member - # functions. - if (re.search(r'\b(public|protected|private)\s+$', virtual.group(1)) or - re.match(r'^\s+(public|protected|private)\b', virtual.group(3))): - return - - # Ignore the "virtual" keyword from virtual base classes. Usually - # there is a column on the same line in these cases (virtual base - # classes are rare in google3 because multiple inheritance is rare). - if re.match(r'^.*[^:]:[^:].*$', line): return - - # Look for the next opening parenthesis. This is the start of the - # parameter list (possibly on the next line shortly after virtual). - # TODO(unknown): doesn't work if there are virtual functions with - # decltype() or other things that use parentheses, but csearch suggests - # that this is rare. - end_col = -1 - end_line = -1 - start_col = len(virtual.group(2)) - for start_line in range(linenum, min(linenum + 3, clean_lines.NumLines())): - line = clean_lines.elided[start_line][start_col:] - parameter_list = re.match(r'^([^(]*)\(', line) - if parameter_list: - # Match parentheses to find the end of the parameter list - (_, end_line, end_col) = CloseExpression( - clean_lines, start_line, start_col + len(parameter_list.group(1))) - break - start_col = 0 - - if end_col < 0: - return # Couldn't find end of parameter list, give up - - # Look for "override" or "final" after the parameter list - # (possibly on the next few lines). - for i in range(end_line, min(end_line + 3, clean_lines.NumLines())): - line = clean_lines.elided[i][end_col:] - match = re.search(r'\b(override|final)\b', line) - if match: - error(filename, linenum, 'readability/inheritance', 4, - ('"virtual" is redundant since function is ' - f'already declared as "{match.group(1)}"')) + Args: + filename: The name of the file to parse. - # Set end_col to check whole lines after we are done with the - # first line. - end_col = 0 - if re.search(r'[^\w]\s*$', line): - break + vlevel: The level of errors to report. Every error of confidence + >= verbose_level will be reported. 0 is a good default. + extra_check_functions: An array of additional check functions that will be + run on each source line. Each function takes 4 + arguments: filename, clean_lines, line, error + """ -def CheckRedundantOverrideOrFinal(filename, clean_lines, linenum, error): - """Check if line contains a redundant "override" or "final" virt-specifier. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - # Look for closing parenthesis nearby. We need one to confirm where - # the declarator ends and where the virt-specifier starts to avoid - # false positives. - line = clean_lines.elided[linenum] - declarator_end = line.rfind(')') - if declarator_end >= 0: - fragment = line[declarator_end:] - else: - if linenum > 1 and clean_lines.elided[linenum - 1].rfind(')') >= 0: - fragment = line - else: - return + _SetVerboseLevel(vlevel) + _BackupFilters() + old_errors = _cpplint_state.error_count + + if not ProcessConfigOverrides(filename): + _RestoreFilters() + return + + lf_lines = [] + crlf_lines = [] + try: + # Support the UNIX convention of using "-" for stdin. Note that + # we are not opening the file with universal newline support + # (which codecs doesn't support anyway), so the resulting lines do + # contain trailing '\r' characters if we are reading a file that + # has CRLF endings. + # If after the split a trailing '\r' is present, it is removed + # below. + if filename == "-": + lines = sys.stdin.read().split("\n") + else: + with codecs.open(filename, "r", "utf8", "replace") as target_file: + lines = target_file.read().split("\n") + + # Remove trailing '\r'. + # The -1 accounts for the extra trailing blank line we get from split() + for linenum in range(len(lines) - 1): + if lines[linenum].endswith("\r"): + lines[linenum] = lines[linenum].rstrip("\r") + crlf_lines.append(linenum + 1) + else: + lf_lines.append(linenum + 1) + + except OSError: + # TODO(aaronliu0130): Maybe make this have an exit code of 2 after all is done + _cpplint_state.PrintError(f"Skipping input '{filename}': Can't open for reading\n") + _RestoreFilters() + return - # Check that at most one of "override" or "final" is present, not both - if re.search(r'\boverride\b', fragment) and re.search(r'\bfinal\b', fragment): - error(filename, linenum, 'readability/inheritance', 4, - ('"override" is redundant since function is ' - 'already declared as "final"')) + # Note, if no dot is found, this will give the entire filename as the ext. + file_extension = filename[filename.rfind(".") + 1 :] + # When reading from stdin, the extension is unknown, so no cpplint tests + # should rely on the extension. + if filename != "-" and file_extension not in GetAllExtensions(): + _cpplint_state.PrintError( + f"Ignoring {filename}; not a valid file name ({(', '.join(GetAllExtensions()))})\n" + ) + else: + ProcessFileData(filename, file_extension, lines, Error, extra_check_functions) + # If end-of-line sequences are a mix of LF and CR-LF, issue + # warnings on the lines with CR. + # + # Don't issue any warnings if all lines are uniformly LF or CR-LF, + # since critique can handle these just fine, and the style guide + # doesn't dictate a particular end of line sequence. + # + # We can't depend on os.linesep to determine what the desired + # end-of-line sequence should be, since that will return the + # server-side end-of-line sequence. + if lf_lines and crlf_lines: + # Warn on every line with CR. An alternative approach might be to + # check whether the file is mostly CRLF or just LF, and warn on the + # minority, we bias toward LF here since most tools prefer LF. + for linenum in crlf_lines: + Error( + filename, + linenum, + "whitespace/newline", + 1, + "Unexpected \\r (^M) found; better to use only \\n", + ) + + # Suppress printing anything if --quiet was passed unless the error + # count has increased after processing this file. + if not _cpplint_state.quiet or old_errors != _cpplint_state.error_count: + _cpplint_state.PrintInfo(f"Done processing {filename}\n") + _RestoreFilters() -# Returns true if we are at a new block, and it is directly -# inside of a namespace. -def IsBlockInNameSpace(nesting_state, is_forward_declaration): - """Checks that the new block is directly in a namespace. - - Args: - nesting_state: The _NestingState object that contains info about our state. - is_forward_declaration: If the class is a forward declared class. - Returns: - Whether or not the new block is directly in a namespace. - """ - if is_forward_declaration: - return len(nesting_state.stack) >= 1 and ( - isinstance(nesting_state.stack[-1], _NamespaceInfo)) - - if len(nesting_state.stack) >= 1: - if isinstance(nesting_state.stack[-1], _NamespaceInfo): - return True - elif (len(nesting_state.stack) > 1 and - isinstance(nesting_state.previous_stack_top, _NamespaceInfo) and - isinstance(nesting_state.stack[-2], _NamespaceInfo)): - return True - return False - - -def ShouldCheckNamespaceIndentation(nesting_state, is_namespace_indent_item, - raw_lines_no_comments, linenum): - """This method determines if we should apply our namespace indentation check. - - Args: - nesting_state: The current nesting state. - is_namespace_indent_item: If we just put a new class on the stack, True. - If the top of the stack is not a class, or we did not recently - add the class, False. - raw_lines_no_comments: The lines without the comments. - linenum: The current line number we are processing. - - Returns: - True if we should apply our namespace indentation check. Currently, it - only works for classes and namespaces inside of a namespace. - """ - - is_forward_declaration = IsForwardClassDeclaration(raw_lines_no_comments, - linenum) - - if not (is_namespace_indent_item or is_forward_declaration): - return False +def PrintUsage(message): + """Prints a brief usage string and exits, optionally with an error message. - # If we are in a macro, we do not want to check the namespace indentation. - if IsMacroDefinition(raw_lines_no_comments, linenum): - return False + Args: + message: The optional error message. + """ + sys.stderr.write( + _USAGE + % ( + sorted(GetAllExtensions()), + ",".join(sorted(GetAllExtensions())), + sorted(GetHeaderExtensions()), + ",".join(sorted(GetHeaderExtensions())), + ) + ) - return IsBlockInNameSpace(nesting_state, is_forward_declaration) + if message: + sys.exit("\nFATAL ERROR: " + message) + else: + sys.exit(0) -# Call this method if the line is directly inside of a namespace. -# If the line above is blank (excluding comments) or the start of -# an inner namespace, it cannot be indented. -def CheckItemIndentationInNamespace(filename, raw_lines_no_comments, linenum, - error): - line = raw_lines_no_comments[linenum] - if re.match(r'^\s+', line): - error(filename, linenum, 'whitespace/indent_namespace', 4, - 'Do not indent within a namespace.') - - -def ProcessLine(filename, file_extension, clean_lines, line, - include_state, function_state, nesting_state, error, - extra_check_functions=None, cppvar=None): - """Processes a single line in the file. - - Args: - filename: Filename of the file that is being processed. - file_extension: The extension (dot not included) of the file. - clean_lines: An array of strings, each representing a line of the file, - with comments stripped. - line: Number of line being processed. - include_state: An _IncludeState instance in which the headers are inserted. - function_state: A _FunctionState instance which counts function lines, etc. - nesting_state: A NestingState instance which maintains information about - the current stack of nested blocks being parsed. - error: A callable to which errors are reported, which takes 4 arguments: - filename, line number, error level, and message - extra_check_functions: An array of additional check functions that will be - run on each source line. Each function takes 4 - arguments: filename, clean_lines, line, error - cppvar: The header guard variable returned by GetHeaderGuardCPPVar. - """ - raw_lines = clean_lines.raw_lines - ParseNolintSuppressions(filename, raw_lines[line], line, error) - nesting_state.Update(filename, clean_lines, line, error) - CheckForNamespaceIndentation(filename, nesting_state, clean_lines, line, - error) - if nesting_state.InAsmBlock(): return - CheckForFunctionLengths(filename, clean_lines, line, function_state, error) - CheckForMultilineCommentsAndStrings(filename, clean_lines, line, error) - CheckStyle(filename, clean_lines, line, file_extension, nesting_state, error, cppvar) - CheckLanguage(filename, clean_lines, line, file_extension, include_state, - nesting_state, error) - CheckForNonConstReference(filename, clean_lines, line, nesting_state, error) - CheckForNonStandardConstructs(filename, clean_lines, line, - nesting_state, error) - CheckVlogArguments(filename, clean_lines, line, error) - CheckPosixThreading(filename, clean_lines, line, error) - CheckInvalidIncrement(filename, clean_lines, line, error) - CheckMakePairUsesDeduction(filename, clean_lines, line, error) - CheckRedundantVirtual(filename, clean_lines, line, error) - CheckRedundantOverrideOrFinal(filename, clean_lines, line, error) - if extra_check_functions: - for check_fn in extra_check_functions: - check_fn(filename, clean_lines, line, error) +def PrintVersion(): + sys.stdout.write("Cpplint fork (https://github.com/cpplint/cpplint)\n") + sys.stdout.write("cpplint " + __VERSION__ + "\n") + sys.stdout.write("Python " + sys.version + "\n") + sys.exit(0) -def FlagCxxHeaders(filename, clean_lines, linenum, error): - """Flag C++ headers that the styleguide restricts. - - Args: - filename: The name of the current file. - clean_lines: A CleansedLines instance containing the file. - linenum: The number of the line to check. - error: The function to call with any errors found. - """ - line = clean_lines.elided[linenum] - - include = re.match(r'\s*#\s*include\s+[<"]([^<"]+)[">]', line) - - # Flag unapproved C++11 headers. - if include and include.group(1) in ('cfenv', - 'fenv.h', - 'ratio', - ): - error(filename, linenum, 'build/c++11', 5, - f"<{include.group(1)}> is an unapproved C++11 header.") - - # filesystem is the only unapproved C++17 header - if include and include.group(1) == 'filesystem': - error(filename, linenum, 'build/c++17', 5, - " is an unapproved C++17 header.") - - -def ProcessFileData(filename, file_extension, lines, error, - extra_check_functions=None): - """Performs lint checks and reports any errors to the given error function. - - Args: - filename: Filename of the file that is being processed. - file_extension: The extension (dot not included) of the file. - lines: An array of strings, each representing a line of the file, with the - last element being empty if the file is terminated with a newline. - error: A callable to which errors are reported, which takes 4 arguments: - filename, line number, error level, and message - extra_check_functions: An array of additional check functions that will be - run on each source line. Each function takes 4 - arguments: filename, clean_lines, line, error - """ - lines = (['// marker so line numbers and indices both start at 1'] + lines + - ['// marker so line numbers end in a known way']) - - include_state = _IncludeState() - function_state = _FunctionState() - nesting_state = NestingState() - - ResetNolintSuppressions() - - CheckForCopyright(filename, lines, error) - ProcessGlobalSuppressions(lines) - RemoveMultiLineComments(filename, lines, error) - clean_lines = CleansedLines(lines) - - cppvar = None - if IsHeaderExtension(file_extension): - cppvar = GetHeaderGuardCPPVariable(filename) - CheckForHeaderGuard(filename, clean_lines, error, cppvar) - - for line in range(clean_lines.NumLines()): - ProcessLine(filename, file_extension, clean_lines, line, - include_state, function_state, nesting_state, error, - extra_check_functions, cppvar) - FlagCxxHeaders(filename, clean_lines, line, error) - if _error_suppressions.HasOpenBlock(): - error(filename, _error_suppressions.GetOpenBlockStart(), 'readability/nolint', 5, - 'NONLINT block never ended') - - CheckForIncludeWhatYouUse(filename, clean_lines, include_state, error) - - # Check that the .cc file has included its header if it exists. - if _IsSourceExtension(file_extension): - CheckHeaderFileIncluded(filename, include_state, error) - - # We check here rather than inside ProcessLine so that we see raw - # lines rather than "cleaned" lines. - CheckForBadCharacters(filename, lines, error) - - CheckForNewlineAtEOF(filename, lines, error) +def PrintCategories(): + """Prints a list of all the error-categories used by error messages. -def ProcessConfigOverrides(filename): - """ Loads the configuration files and processes the config overrides. + These are the categories used to filter messages via --filter. + """ + sys.stderr.write("".join(f" {cat}\n" for cat in _ERROR_CATEGORIES)) + sys.exit(0) - Args: - filename: The name of the file being processed by the linter. - Returns: - False if the current |filename| should not be processed further. - """ +def ParseArguments(args): + """Parses the command line arguments. - abs_filename = os.path.abspath(filename) - cfg_filters = [] - keep_looking = True - while keep_looking: - abs_path, base_name = os.path.split(abs_filename) - if not base_name: - break # Reached the root directory. + This may set the output format and verbosity level as side-effects. - cfg_file = os.path.join(abs_path, _config_filename) - abs_filename = abs_path - if not os.path.isfile(cfg_file): - continue + Args: + args: The command line arguments: + Returns: + The list of filenames to lint. + """ try: - with codecs.open(cfg_file, 'r', 'utf8', 'replace') as file_handle: - for line in file_handle: - line, _, _ = line.partition('#') # Remove comments. - if not line.strip(): - continue - - name, _, val = line.partition('=') - name = name.strip() - val = val.strip() - if name == 'set noparent': - keep_looking = False - elif name == 'filter': - cfg_filters.append(val) - elif name == 'exclude_files': - # When matching exclude_files pattern, use the base_name of - # the current file name or the directory name we are processing. - # For example, if we are checking for lint errors in /foo/bar/baz.cc - # and we found the .cfg file at /foo/CPPLINT.cfg, then the config - # file's "exclude_files" filter is meant to be checked against "bar" - # and not "baz" nor "bar/baz.cc". - if base_name: - pattern = re.compile(val) - if pattern.match(base_name): - if _cpplint_state.quiet: - # Suppress "Ignoring file" warning when using --quiet. - return False - _cpplint_state.PrintInfo(f'Ignoring "{filename}": file excluded by "{cfg_file}". ' - 'File path component "%s" matches ' - 'pattern "%s"\n' % - (base_name, val)) - return False - elif name == 'linelength': + (opts, filenames) = getopt.getopt( + args, + "", + [ + "help", + "output=", + "verbose=", + "v=", + "version", + "counting=", + "filter=", + "root=", + "repository=", + "linelength=", + "extensions=", + "exclude=", + "recursive", + "headers=", + "includeorder=", + "config=", + "quiet", + ], + ) + except getopt.GetoptError: + PrintUsage("Invalid arguments.") + + verbosity = _VerboseLevel() + output_format = _OutputFormat() + filters = "" + quiet = _Quiet() + counting_style = "" + recursive = False + + for opt, val in opts: + if opt == "--help": + PrintUsage(None) + if opt == "--version": + PrintVersion() + elif opt == "--output": + if val not in ("emacs", "vs7", "eclipse", "junit", "sed", "gsed"): + PrintUsage( + "The only allowed output formats are emacs, vs7, eclipse sed, gsed and junit." + ) + output_format = val + elif opt == "--quiet": + quiet = True + elif opt in {"--verbose", "--v"}: + verbosity = int(val) + elif opt == "--filter": + filters = val + if not filters: + PrintCategories() + elif opt == "--counting": + if val not in ("total", "toplevel", "detailed"): + PrintUsage("Valid counting options are total, toplevel, and detailed") + counting_style = val + elif opt == "--root": + global _root + _root = val + elif opt == "--repository": + global _repository + _repository = val + elif opt == "--linelength": global _line_length try: - _line_length = int(val) + _line_length = int(val) except ValueError: - _cpplint_state.PrintError('Line length must be numeric.') - elif name == 'extensions': + PrintUsage("Line length must be digits.") + elif opt == "--exclude": + global _excludes + if not _excludes: + _excludes = set() + _excludes.update(glob.glob(val)) + elif opt == "--extensions": ProcessExtensionsOption(val) - elif name == 'root': - global _root - # root directories are specified relative to CPPLINT.cfg dir. - _root = os.path.join(os.path.dirname(cfg_file), val) - elif name == 'headers': + elif opt == "--headers": ProcessHppHeadersOption(val) - elif name == 'includeorder': + elif opt == "--recursive": + recursive = True + elif opt == "--includeorder": ProcessIncludeOrderOption(val) - else: - _cpplint_state.PrintError( - f'Invalid configuration option ({name}) in file {cfg_file}\n') + elif opt == "--config": + global _config_filename + _config_filename = val + if os.path.basename(_config_filename) != _config_filename: + PrintUsage("Config file name must not include directory components.") - except IOError: - _cpplint_state.PrintError( - f"Skipping config file '{cfg_file}': Can't open for reading\n") - keep_looking = False + if not filenames: + PrintUsage("No files were specified.") - # Apply all the accumulated filters in reverse order (top-level directory - # config options having the least priority). - for cfg_filter in reversed(cfg_filters): - _AddFilters(cfg_filter) + if recursive: + filenames = _ExpandDirectories(filenames) - return True + if _excludes: + filenames = _FilterExcludedFiles(filenames) + _SetOutputFormat(output_format) + _SetQuiet(quiet) + _SetVerboseLevel(verbosity) + _SetFilters(filters) + _SetCountingStyle(counting_style) -def ProcessFile(filename, vlevel, extra_check_functions=None): - """Does google-lint on a single file. - - Args: - filename: The name of the file to parse. - - vlevel: The level of errors to report. Every error of confidence - >= verbose_level will be reported. 0 is a good default. - - extra_check_functions: An array of additional check functions that will be - run on each source line. Each function takes 4 - arguments: filename, clean_lines, line, error - """ + filenames.sort() + return filenames - _SetVerboseLevel(vlevel) - _BackupFilters() - old_errors = _cpplint_state.error_count - if not ProcessConfigOverrides(filename): - _RestoreFilters() - return - - lf_lines = [] - crlf_lines = [] - try: - # Support the UNIX convention of using "-" for stdin. Note that - # we are not opening the file with universal newline support - # (which codecs doesn't support anyway), so the resulting lines do - # contain trailing '\r' characters if we are reading a file that - # has CRLF endings. - # If after the split a trailing '\r' is present, it is removed - # below. - if filename == '-': - lines = sys.stdin.read().split('\n') - else: - with codecs.open(filename, 'r', 'utf8', 'replace') as target_file: - lines = target_file.read().split('\n') - - # Remove trailing '\r'. - # The -1 accounts for the extra trailing blank line we get from split() - for linenum in range(len(lines) - 1): - if lines[linenum].endswith('\r'): - lines[linenum] = lines[linenum].rstrip('\r') - crlf_lines.append(linenum + 1) - else: - lf_lines.append(linenum + 1) - - except IOError: - # TODO: Maybe make this have an exit code of 2 after all is done - _cpplint_state.PrintError( - f"Skipping input '{filename}': Can't open for reading\n") - _RestoreFilters() - return - - # Note, if no dot is found, this will give the entire filename as the ext. - file_extension = filename[filename.rfind('.') + 1:] - - # When reading from stdin, the extension is unknown, so no cpplint tests - # should rely on the extension. - if filename != '-' and file_extension not in GetAllExtensions(): - _cpplint_state.PrintError(f'Ignoring {filename}; not a valid file name' - f' ({(", ".join(GetAllExtensions()))})\n') - else: - ProcessFileData(filename, file_extension, lines, Error, - extra_check_functions) - - # If end-of-line sequences are a mix of LF and CR-LF, issue - # warnings on the lines with CR. - # - # Don't issue any warnings if all lines are uniformly LF or CR-LF, - # since critique can handle these just fine, and the style guide - # doesn't dictate a particular end of line sequence. - # - # We can't depend on os.linesep to determine what the desired - # end-of-line sequence should be, since that will return the - # server-side end-of-line sequence. - if lf_lines and crlf_lines: - # Warn on every line with CR. An alternative approach might be to - # check whether the file is mostly CRLF or just LF, and warn on the - # minority, we bias toward LF here since most tools prefer LF. - for linenum in crlf_lines: - Error(filename, linenum, 'whitespace/newline', 1, - 'Unexpected \\r (^M) found; better to use only \\n') - - # Suppress printing anything if --quiet was passed unless the error - # count has increased after processing this file. - if not _cpplint_state.quiet or old_errors != _cpplint_state.error_count: - _cpplint_state.PrintInfo(f'Done processing {filename}\n') - _RestoreFilters() +def _ParseFilterSelector(parameter): + """Parses the given command line parameter for file- and line-specific + exclusions. + readability/casting:file.cpp + readability/casting:file.cpp:43 + Args: + parameter: The parameter value of --filter -def PrintUsage(message): - """Prints a brief usage string and exits, optionally with an error message. - - Args: - message: The optional error message. - """ - sys.stderr.write(_USAGE % (sorted(list(GetAllExtensions())), - ','.join(sorted(list(GetAllExtensions()))), - sorted(GetHeaderExtensions()), - ','.join(sorted(GetHeaderExtensions())))) - - if message: - sys.exit('\nFATAL ERROR: ' + message) - else: - sys.exit(0) + Returns: + [category, filename, line]. + Category is always given. + Filename is either a filename or empty if all files are meant. + Line is either a line in filename or -1 if all lines are meant. + """ + colon_pos = parameter.find(":") + if colon_pos == -1: + return parameter, "", -1 + category = parameter[:colon_pos] + second_colon_pos = parameter.find(":", colon_pos + 1) + if second_colon_pos == -1: + return category, parameter[colon_pos + 1 :], -1 + return ( + category, + parameter[colon_pos + 1 : second_colon_pos], + int(parameter[second_colon_pos + 1 :]), + ) -def PrintVersion(): - sys.stdout.write('Cpplint fork (https://github.com/cpplint/cpplint)\n') - sys.stdout.write('cpplint ' + __VERSION__ + '\n') - sys.stdout.write('Python ' + sys.version + '\n') - sys.exit(0) -def PrintCategories(): - """Prints a list of all the error-categories used by error messages. +def _ExpandDirectories(filenames): + """Searches a list of filenames and replaces directories in the list with + all files descending from those directories. Files with extensions not in + the valid extensions list are excluded. - These are the categories used to filter messages via --filter. - """ - sys.stderr.write(''.join(f' {cat}\n' for cat in _ERROR_CATEGORIES)) - sys.exit(0) + Args: + filenames: A list of files or directories + Returns: + A list of all files that are members of filenames or descended from a + directory in filenames + """ + expanded = set() + for filename in filenames: + if not os.path.isdir(filename): + expanded.add(filename) + continue -def ParseArguments(args): - """Parses the command line arguments. - - This may set the output format and verbosity level as side-effects. - - Args: - args: The command line arguments: - - Returns: - The list of filenames to lint. - """ - try: - (opts, filenames) = getopt.getopt(args, '', ['help', 'output=', 'verbose=', - 'v=', - 'version', - 'counting=', - 'filter=', - 'root=', - 'repository=', - 'linelength=', - 'extensions=', - 'exclude=', - 'recursive', - 'headers=', - 'includeorder=', - 'config=', - 'quiet']) - except getopt.GetoptError: - PrintUsage('Invalid arguments.') - - verbosity = _VerboseLevel() - output_format = _OutputFormat() - filters = '' - quiet = _Quiet() - counting_style = '' - recursive = False - - for (opt, val) in opts: - if opt == '--help': - PrintUsage(None) - if opt == '--version': - PrintVersion() - elif opt == '--output': - if val not in ('emacs', 'vs7', 'eclipse', 'junit', 'sed', 'gsed'): - PrintUsage('The only allowed output formats are emacs, vs7, eclipse ' - 'sed, gsed and junit.') - output_format = val - elif opt == '--quiet': - quiet = True - elif opt == '--verbose' or opt == '--v': - verbosity = int(val) - elif opt == '--filter': - filters = val - if not filters: - PrintCategories() - elif opt == '--counting': - if val not in ('total', 'toplevel', 'detailed'): - PrintUsage('Valid counting options are total, toplevel, and detailed') - counting_style = val - elif opt == '--root': - global _root - _root = val - elif opt == '--repository': - global _repository - _repository = val - elif opt == '--linelength': - global _line_length - try: - _line_length = int(val) - except ValueError: - PrintUsage('Line length must be digits.') - elif opt == '--exclude': - global _excludes - if not _excludes: - _excludes = set() - _excludes.update(glob.glob(val)) - elif opt == '--extensions': - ProcessExtensionsOption(val) - elif opt == '--headers': - ProcessHppHeadersOption(val) - elif opt == '--recursive': - recursive = True - elif opt == '--includeorder': - ProcessIncludeOrderOption(val) - elif opt == '--config': - global _config_filename - _config_filename = val - if os.path.basename(_config_filename) != _config_filename: - PrintUsage('Config file name must not include directory components.') - - if not filenames: - PrintUsage('No files were specified.') - - if recursive: - filenames = _ExpandDirectories(filenames) - - if _excludes: - filenames = _FilterExcludedFiles(filenames) - - _SetOutputFormat(output_format) - _SetQuiet(quiet) - _SetVerboseLevel(verbosity) - _SetFilters(filters) - _SetCountingStyle(counting_style) - - filenames.sort() - return filenames + for root, _, files in os.walk(filename): + for loopfile in files: + fullname = os.path.join(root, loopfile) + if fullname.startswith("." + os.path.sep): + fullname = fullname[len("." + os.path.sep) :] + expanded.add(fullname) -def _ParseFilterSelector(parameter): - """Parses the given command line parameter for file- and line-specific - exclusions. - readability/casting:file.cpp - readability/casting:file.cpp:43 - - Args: - parameter: The parameter value of --filter - - Returns: - [category, filename, line]. - Category is always given. - Filename is either a filename or empty if all files are meant. - Line is either a line in filename or -1 if all lines are meant. - """ - colon_pos = parameter.find(":") - if colon_pos == -1: - return parameter, "", -1 - category = parameter[:colon_pos] - second_colon_pos = parameter.find(":", colon_pos + 1) - if second_colon_pos == -1: - return category, parameter[colon_pos + 1:], -1 - else: - return category, parameter[colon_pos + 1: second_colon_pos], \ - int(parameter[second_colon_pos + 1:]) + return [ + filename for filename in expanded if os.path.splitext(filename)[1][1:] in GetAllExtensions() + ] -def _ExpandDirectories(filenames): - """Searches a list of filenames and replaces directories in the list with - all files descending from those directories. Files with extensions not in - the valid extensions list are excluded. - - Args: - filenames: A list of files or directories - - Returns: - A list of all files that are members of filenames or descended from a - directory in filenames - """ - expanded = set() - for filename in filenames: - if not os.path.isdir(filename): - expanded.add(filename) - continue - - for root, _, files in os.walk(filename): - for loopfile in files: - fullname = os.path.join(root, loopfile) - if fullname.startswith('.' + os.path.sep): - fullname = fullname[len('.' + os.path.sep):] - expanded.add(fullname) - - filtered = [] - for filename in expanded: - if os.path.splitext(filename)[1][1:] in GetAllExtensions(): - filtered.append(filename) - return filtered def _FilterExcludedFiles(fnames): - """Filters out files listed in the --exclude command line switch. File paths - in the switch are evaluated relative to the current working directory - """ - exclude_paths = [os.path.abspath(f) for f in _excludes] - # because globbing does not work recursively, exclude all subpath of all excluded entries - return [f for f in fnames - if not any(e for e in exclude_paths - if _IsParentOrSame(e, os.path.abspath(f)))] + """Filters out files listed in the --exclude command line switch. File paths + in the switch are evaluated relative to the current working directory + """ + exclude_paths = [os.path.abspath(f) for f in _excludes] + # because globbing does not work recursively, exclude all subpath of all excluded entries + return [ + f + for f in fnames + if not any(e for e in exclude_paths if _IsParentOrSame(e, os.path.abspath(f))) + ] + def _IsParentOrSame(parent, child): - """Return true if child is subdirectory of parent. - Assumes both paths are absolute and don't contain symlinks. - """ - parent = os.path.normpath(parent) - child = os.path.normpath(child) - if parent == child: - return True + """Return true if child is subdirectory of parent. + Assumes both paths are absolute and don't contain symlinks. + """ + parent = os.path.normpath(parent) + child = os.path.normpath(child) + if parent == child: + return True + + prefix = os.path.commonprefix([parent, child]) + if prefix != parent: + return False + # Note: os.path.commonprefix operates on character basis, so + # take extra care of situations like '/foo/ba' and '/foo/bar/baz' + child_suffix = child[len(prefix) :] + child_suffix = child_suffix.lstrip(os.sep) + return child == os.path.join(prefix, child_suffix) - prefix = os.path.commonprefix([parent, child]) - if prefix != parent: - return False - # Note: os.path.commonprefix operates on character basis, so - # take extra care of situations like '/foo/ba' and '/foo/bar/baz' - child_suffix = child[len(prefix):] - child_suffix = child_suffix.lstrip(os.sep) - return child == os.path.join(prefix, child_suffix) def main(): - filenames = ParseArguments(sys.argv[1:]) - backup_err = sys.stderr - try: - # Change stderr to write with replacement characters so we don't die - # if we try to print something containing non-ASCII characters. - sys.stderr = codecs.StreamReader(sys.stderr, 'replace') - - _cpplint_state.ResetErrorCounts() - for filename in filenames: - ProcessFile(filename, _cpplint_state.verbose_level) - # If --quiet is passed, suppress printing error count unless there are errors. - if not _cpplint_state.quiet or _cpplint_state.error_count > 0: - _cpplint_state.PrintErrorCounts() + filenames = ParseArguments(sys.argv[1:]) + backup_err = sys.stderr + try: + # Change stderr to write with replacement characters so we don't die + # if we try to print something containing non-ASCII characters. + sys.stderr = codecs.StreamReader(sys.stderr, "replace") + + _cpplint_state.ResetErrorCounts() + for filename in filenames: + ProcessFile(filename, _cpplint_state.verbose_level) + # If --quiet is passed, suppress printing error count unless there are errors. + if not _cpplint_state.quiet or _cpplint_state.error_count > 0: + _cpplint_state.PrintErrorCounts() - if _cpplint_state.output_format == 'junit': - sys.stderr.write(_cpplint_state.FormatJUnitXML()) + if _cpplint_state.output_format == "junit": + sys.stderr.write(_cpplint_state.FormatJUnitXML()) - finally: - sys.stderr = backup_err + finally: + sys.stderr = backup_err - sys.exit(_cpplint_state.error_count > 0) + sys.exit(_cpplint_state.error_count > 0) -if __name__ == '__main__': - main() +if __name__ == "__main__": + main() diff --git a/cpplint_clitest.py b/cpplint_clitest.py index b23449a..2694712 100755 --- a/cpplint_clitest.py +++ b/cpplint_clitest.py @@ -1,5 +1,4 @@ #!/usr/bin/env python -# -*- coding: utf-8; -*- # # Copyright (c) 2009 Google Inc. All rights reserved. # @@ -31,57 +30,61 @@ """Command Line interface integration test for cpplint.py.""" +from __future__ import annotations + +import contextlib import glob import os -import sys -import subprocess -import unittest import shutil +import subprocess +import sys import tempfile -from pytest import mark -from testfixtures import compare -BASE_CMD = sys.executable + ' ' + os.path.abspath('./cpplint.py ') +import pytest +from parameterized import parameterized # type: ignore[import-untyped] +from testfixtures import compare # type: ignore[import-untyped] -def RunShellCommand(cmd: str, args: str, cwd='.'): - """ - executes a command - :param cmd: A string to execute. - :param cwd: from which folder to run. - """ +import cpplint # noqa: F401 + +BASE_CMD = sys.executable + " " + os.path.abspath("./cpplint.py ") - stdout_target = subprocess.PIPE - stderr_target = subprocess.PIPE - proc = subprocess.Popen(cmd + ' ' + args, - shell=True, - cwd=cwd, - stdout=stdout_target, - stderr=stderr_target) - out, err = proc.communicate() +def run_shell_command(cmd: str, args: str, cwd: str = ".") -> tuple[int, bytes, bytes]: + """Executes a command + + Args: + cmd: A string to execute. + args: A string with arguments to the command. + cwd: from which folder to run. + """ + cmd, args = cmd.split(), args.split() # type: ignore[assignment] + proc = subprocess.run(cmd + args, cwd=cwd, capture_output=True, check=False) + out, err = proc.stdout, proc.stderr # Make output system-agnostic, aka support Windows - if os.sep == '\\': - # TODO: Support scenario with multiple folder inputs - win_path = (os.path.dirname(args.split(' ')[-1]) + '\\').encode() - good_path = win_path.replace(b'\\', b'/') + if os.sep == "\\": + # TODO(aaronliu0130): Support scenario with multiple input names + # We currently only support the last arguments as the input name + # to prevent accidentally replacing sed tests. + # Fixing would likely need coding an internal "replace slashes" option for cpplint itself. + win_path = (os.path.dirname(args[-1]) + "\\").encode() + good_path = win_path.replace(b"\\", b"/") out, err = out.replace(win_path, good_path), err.replace(win_path, good_path) - if os.linesep == '\r\n': - out, err = out.replace(b'\r\n', b'\n'), err.replace(b'\r\n', b'\n') + if os.linesep == "\r\n": + out, err = out.replace(b"\r\n", b"\n"), err.replace(b"\r\n", b"\n") # print(err) # to get the output at time of test - return (proc.returncode, out, err) + return proc.returncode, out, err -class UsageTest(unittest.TestCase): +def test_help(): + (status, out, err) = run_shell_command(BASE_CMD, "--help") + assert status == 0 + assert out == b"" + assert err.startswith(b"\nSyntax: cpplint") - def testHelp(self): - (status, out, err) = RunShellCommand(BASE_CMD, '--help') - self.assertEqual(0, status) - self.assertEqual(b'', out) - self.assertTrue(err.startswith(b'\nSyntax: cpplint')) -class TemporaryFolderClassSetup(object): +class TemporaryFolderClassSetup: """ Regression tests: The test starts a filetreewalker scanning for files name *.def Such files are expected to have as first line the argument @@ -91,23 +94,24 @@ class TemporaryFolderClassSetup(object): systemerr output (two blank lines at end). """ + @pytest.fixture(autouse=True, name="set_up()", scope="class") @classmethod - def setUpClass(cls): + def set_up(cls): """setup tmp folder for testing with samples and custom additions by subclasses""" try: cls._root = os.path.realpath(tempfile.mkdtemp()) - shutil.copytree('samples', os.path.join(cls._root, 'samples')) + shutil.copytree("samples", os.path.join(cls._root, "samples")) cls.prepare_directory(cls._root) except Exception: - try: - cls.tearDownClass() - except Exception: - pass + with contextlib.suppress(Exception): + cls.tear_down() raise + # yield + # cls.tear_down() @classmethod - def tearDownClass(cls): - if (cls._root): + def tear_down(cls): + if cls._root: # pass shutil.rmtree(cls._root) @@ -118,120 +122,110 @@ def prepare_directory(cls, root): def get_extra_command_args(self, cwd): """Override in subclass to add arguments to command""" - return '' + return "" - def checkAllInFolder(self, foldername, expectedDefs): + def check_all_in_folder(self, folder_name, expected_defs): # uncomment to show complete diff # self.maxDiff = None count = 0 - for dirpath, _, fnames in os.walk(foldername): + for dirpath, _, fnames in os.walk(folder_name): for f in fnames: - if f.endswith('.def'): + if f.endswith(".def"): count += 1 - self._checkDef(os.path.join(dirpath, f)) - self.assertEqual(count, expectedDefs) + self.check_def(os.path.join(dirpath, f)) + assert count == expected_defs - def _checkDef(self, path): + def check_def(self, path): """runs command and compares to expected output from def file""" # self.maxDiff = None # to see full diff - with open(path, 'rb') as filehandle: - datalines = filehandle.readlines() - stdoutLines = int(datalines[2]) - filenames = datalines[0].decode('utf8').strip() + with open(path, "rb") as file_handle: + data = file_handle.readlines() + stdout_lines = int(data[2]) + filenames = data[0].decode("utf8").strip() args, _, filenames = filenames.rpartition(" ") - if '*' in filenames: + if "*" in filenames: rel_cwd = os.path.dirname(path) - filenames = ' '.join( - filename[len(rel_cwd)+1:] - for filename in glob.glob(rel_cwd + '/' + filenames) + filenames = " ".join( + filename[len(rel_cwd) + 1 :] + for filename in glob.glob(rel_cwd + "/" + filenames) ) - args += ' ' + filenames - self._runAndCheck(path, - args, - int(datalines[1]), - [line.decode('utf8').strip() for line in datalines[3:3 + stdoutLines]], - [line.decode('utf8').strip() for line in datalines[3 + stdoutLines:]]) - - def _runAndCheck( - self, - definition_file, - args, - expected_status, - expected_out, - expected_err - ): + args += " " + filenames + self._run_and_compare( + path, + args, + int(data[1]), + [line.decode("utf8").strip() for line in data[3 : 3 + stdout_lines]], + [line.decode("utf8").strip() for line in data[3 + stdout_lines :]], + ) + + def _run_and_compare(self, definition_file, args, expected_status, expected_out, expected_err): rel_cwd = os.path.dirname(definition_file) cmd = BASE_CMD + self.get_extra_command_args(rel_cwd) cwd = os.path.join(self._root, rel_cwd) # command to reproduce, do not forget first two lines have special meaning - print("\ncd " + cwd + " && " + cmd + ' ' + args + " 2> ") - (status, out, err) = RunShellCommand(cmd, args, cwd) - self.assertEqual(expected_status, status, 'bad command status %s' % status) - prefix = 'Failed check in %s comparing to %s for command: %s' % (cwd, definition_file, cmd) - compare('\n'.join(expected_err), err.decode('utf8'), prefix=prefix, show_whitespace=True) - compare('\n'.join(expected_out), out.decode('utf8'), prefix=prefix, show_whitespace=True) + print("\ncd " + cwd + " && " + cmd + " " + args + " 2> ") + (status, out, err) = run_shell_command(cmd, args, cwd) + assert expected_status == status, f"bad command status {status}" + prefix = f"Failed check in {cwd} comparing to {definition_file} for command: {cmd}" + compare("\n".join(expected_err), err.decode("utf8"), prefix=prefix, show_whitespace=True) + compare("\n".join(expected_out), out.decode("utf8"), prefix=prefix, show_whitespace=True) -class NoRepoSignatureTests(TemporaryFolderClassSetup, unittest.TestCase): +class TestNoRepoSignature(TemporaryFolderClassSetup): """runs in a temporary folder (under /tmp in linux) without any .git/.hg/.svn file""" def get_extra_command_args(self, cwd): - return (' --repository %s ' % self._root) - - def testChromiumSample(self): - self.checkAllInFolder('./samples/chromium-sample', 1) - - def testVlcSample(self): - self.checkAllInFolder('./samples/vlc-sample', 1) - - def testSillySample(self): - self.checkAllInFolder('./samples/silly-sample', 5) - - def testBoostSample(self): - self.checkAllInFolder('./samples/boost-sample', 4) - - @mark.timeout(180) - def testProtobufSample(self): - self.checkAllInFolder('./samples/protobuf-sample', 1) - - def testCodeliteSample(self): - self.checkAllInFolder('./samples/codelite-sample', 1) - - def testV8Sample(self): - self.checkAllInFolder('./samples/v8-sample', 1) - -class GitRepoSignatureTests(TemporaryFolderClassSetup, unittest.TestCase): + return f" --repository {self._root} " + + @parameterized.expand( + [ + (folder, case[:-4]) + for folder in ["chromium", "vlc", "silly", "boost", "protobuf", "codelite", "v8"] + for case in os.listdir(f"./samples/{folder}-sample") + if case.endswith(".def") + ], + name_func=lambda fun, _, x: f"test_{x.args[0]}_sample-{x.args[1]}", + ) + @pytest.mark.timeout(180) + def test_samples(self, folder, case): + self.check_def(os.path.join(f"./samples/{folder}-sample", case + ".def")) + + +class TestGitRepoSignature(TemporaryFolderClassSetup): """runs in a temporary folder with .git file""" @classmethod def prepare_directory(cls, root): - with open(os.path.join(root, '.git'), 'a'): + with open(os.path.join(root, ".git"), "a"): pass - def testCodeliteSample(self): - self.checkAllInFolder('./samples/codelite-sample', 1) + def test_codelite_sample(self): + self.check_all_in_folder("./samples/codelite-sample", 1) + -class MercurialRepoSignatureTests(TemporaryFolderClassSetup, unittest.TestCase): +class TestMercurialRepoSignature(TemporaryFolderClassSetup): """runs in a temporary folder with .hg file""" @classmethod def prepare_directory(cls, root): - with open(os.path.join(root, '.hg'), 'a'): + with open(os.path.join(root, ".hg"), "a"): pass - def testCodeliteSample(self): - self.checkAllInFolder('./samples/codelite-sample', 1) + def test_codelite_sample(self): + self.check_all_in_folder("./samples/codelite-sample", 1) -class SvnRepoSignatureTests(TemporaryFolderClassSetup, unittest.TestCase): + +class TestSvnRepoSignature(TemporaryFolderClassSetup): """runs in a temporary folder with .svn file""" @classmethod def prepare_directory(cls, root): - with open(os.path.join(root, '.svn'), 'a'): + with open(os.path.join(root, ".svn"), "a"): pass - def testCodeliteSample(self): - self.checkAllInFolder('./samples/codelite-sample', 1) + def test_codelite_sample(self): + self.check_all_in_folder("./samples/codelite-sample", 1) + -if __name__ == '__main__': - unittest.main() +if __name__ == "__main__": + pytest.main([__file__]) diff --git a/cpplint_unittest.py b/cpplint_unittest.py index c20384c..079c7d3 100755 --- a/cpplint_unittest.py +++ b/cpplint_unittest.py @@ -1,5 +1,4 @@ #!/usr/bin/env python -# -*- coding: utf-8; -*- # # Copyright (c) 2009 Google Inc. All rights reserved. # @@ -33,6 +32,8 @@ # TODO(unknown): Add a good test that tests UpdateIncludeState. +from __future__ import annotations + import codecs import os import platform @@ -42,747 +43,818 @@ import subprocess import sys import tempfile -import unittest -from parameterized import parameterized + import pytest +from parameterized import parameterized # type: ignore[import-untyped] import cpplint + def codecs_latin_encode(x): - if sys.version_info < (3,): - return x - else: return codecs.latin_1_encode(x)[0] + # This class works as an error collector and replaces cpplint.Error # function for the unit tests. We also verify each category we see # is in cpplint._ERROR_CATEGORIES, to help keep that list up to date. -class ErrorCollector(object): - # These are a global list, covering all categories seen ever. - _ERROR_CATEGORIES = cpplint._ERROR_CATEGORIES - _SEEN_ERROR_CATEGORIES = {} - - def __init__(self, assert_fn): - """assert_fn: a function to call when we notice a problem.""" - self._assert_fn = assert_fn - self._errors = [] - cpplint.ResetNolintSuppressions() - - def __call__(self, filename, linenum, - category, confidence, message): - self._assert_fn(category in self._ERROR_CATEGORIES, - 'Message "%s" has category "%s",' - ' which is not in _ERROR_CATEGORIES' % (message, category)) - self._SEEN_ERROR_CATEGORIES[category] = 1 - if cpplint._ShouldPrintError(category, confidence, filename, linenum): - self._errors.append('%s [%s] [%d]' % (message, category, confidence)) - - def Results(self): - if len(self._errors) < 2: - return ''.join(self._errors) # Most tests expect to have a string. - else: - return self._errors # Let's give a list if there is more than one. - - def ResultList(self): - return self._errors - - def VerifyAllCategoriesAreSeen(self): - """Fails if there's a category in _ERROR_CATEGORIES~_SEEN_ERROR_CATEGORIES. - - This should only be called after all tests are run, so - _SEEN_ERROR_CATEGORIES has had a chance to fully populate. Since - this isn't called from within the normal unittest framework, we - can't use the normal unittest assert macros. Instead we just exit - when we see an error. Good thing this test is always run last! - """ - for category in self._ERROR_CATEGORIES: - if category not in self._SEEN_ERROR_CATEGORIES: - sys.exit('FATAL ERROR: There are no tests for category "%s"' % category) +class ErrorCollector: + # These are a global list, covering all categories seen ever. + _ERROR_CATEGORIES = cpplint._ERROR_CATEGORIES + _SEEN_ERROR_CATEGORIES: set[str] = set() + + def __init__(self, assert_fn): + """assert_fn: a function to call when we notice a problem.""" + self._assert_fn = assert_fn + self._errors = [] + cpplint.ResetNolintSuppressions() + + def __call__(self, filename, linenum, category, confidence, message): + self._assert_fn( + category in self._ERROR_CATEGORIES, + 'Message "%s" has category "%s",' + " which is not in _ERROR_CATEGORIES" % (message, category), + ) + self._SEEN_ERROR_CATEGORIES.add(category) + if cpplint._ShouldPrintError(category, confidence, filename, linenum): + self._errors.append("%s [%s] [%d]" % (message, category, confidence)) + + def Results(self): + if len(self._errors) < 2: + return "".join(self._errors) # Most tests expect to have a string. + return self._errors # Let's give a list if there is more than one. + + def ResultList(self): + return self._errors + + def VerifyAllCategoriesAreSeen(self): + """Fails if there's a category in _ERROR_CATEGORIES~_SEEN_ERROR_CATEGORIES. + + This should only be called after all tests are run, so + _SEEN_ERROR_CATEGORIES has had a chance to fully populate. Since + this isn't called from within the normal unittest framework, we + can't use the normal unittest assert macros. Instead we just exit + when we see an error. Good thing this test is always run last! + """ + for category in self._ERROR_CATEGORIES: + if category not in self._SEEN_ERROR_CATEGORIES: + sys.exit('FATAL ERROR: There are no tests for category "%s"' % category) + + def RemoveIfPresent(self, substr): + for index, error in enumerate(self._errors): + if error.find(substr) != -1: + self._errors = self._errors[0:index] + self._errors[(index + 1) :] + break - def RemoveIfPresent(self, substr): - for (index, error) in enumerate(self._errors): - if error.find(substr) != -1: - self._errors = self._errors[0:index] + self._errors[(index + 1):] - break # This class is a lame mock of codecs. We do not verify filename, mode, or # encoding, but for the current use case it is not needed. -class MockIo(object): - - def __init__(self, mock_file): - # wrap list to allow "with open(mock)" - class EnterableList(list): - def __enter__(self): - return self - - def __exit__(self, type, value, tb): - return self - self.mock_file = EnterableList(mock_file) - - def open(self, # pylint: disable=C6409 - unused_filename, unused_mode, unused_encoding, _): - return self.mock_file - - -class CpplintTestBase(unittest.TestCase): - """Provides some useful helper functions for cpplint tests.""" - - def setUp(self): - # Allow subclasses to cheat os.path.abspath called in FileInfo class. - self.os_path_abspath_orig = os.path.abspath - - def tearDown(self): - os.path.abspath = self.os_path_abspath_orig - - # Perform lint on single line of input and return the error message. - def PerformSingleLineLint(self, code): - error_collector = ErrorCollector(self.assertTrue) - lines = code.split('\n') - cpplint.RemoveMultiLineComments('foo.h', lines, error_collector) - clean_lines = cpplint.CleansedLines(lines) - include_state = cpplint._IncludeState() - function_state = cpplint._FunctionState() - nesting_state = cpplint.NestingState() - cpplint.ProcessLine('foo.cc', 'cc', clean_lines, 0, - include_state, function_state, - nesting_state, error_collector) - # Single-line lint tests are allowed to fail the 'unlintable function' - # check. - error_collector.RemoveIfPresent( - 'Lint failed to find start of function body.') - return error_collector.Results() - - # Perform lint over multiple lines and return the error message. - def PerformMultiLineLint(self, code): - error_collector = ErrorCollector(self.assertTrue) - lines = code.split('\n') - cpplint.RemoveMultiLineComments('foo.h', lines, error_collector) - lines = cpplint.CleansedLines(lines) - nesting_state = cpplint.NestingState() - for i in range(lines.NumLines()): - nesting_state.Update('foo.h', lines, i, error_collector) - cpplint.CheckStyle('foo.h', lines, i, 'h', nesting_state, - error_collector) - cpplint.CheckForNonStandardConstructs('foo.h', lines, i, - nesting_state, error_collector) - return error_collector.Results() - - # Similar to PerformMultiLineLint, but calls CheckLanguage instead of - # CheckForNonStandardConstructs - def PerformLanguageRulesCheck(self, file_name, code): - error_collector = ErrorCollector(self.assertTrue) - include_state = cpplint._IncludeState() - nesting_state = cpplint.NestingState() - lines = code.split('\n') - cpplint.RemoveMultiLineComments(file_name, lines, error_collector) - lines = cpplint.CleansedLines(lines) - ext = file_name[file_name.rfind('.') + 1:] - for i in range(lines.NumLines()): - cpplint.CheckLanguage(file_name, lines, i, ext, include_state, - nesting_state, error_collector) - return error_collector.Results() - - def PerformFunctionLengthsCheck(self, code): - """Perform Lint function length check on block of code and return warnings. - - Builds up an array of lines corresponding to the code and strips comments - using cpplint functions. - - Establishes an error collector and invokes the function length checking - function following cpplint's pattern. - - Args: - code: C++ source code expected to generate a warning message. - - Returns: - The accumulated errors. - """ - file_name = 'foo.cc' - error_collector = ErrorCollector(self.assertTrue) - function_state = cpplint._FunctionState() - lines = code.split('\n') - cpplint.RemoveMultiLineComments(file_name, lines, error_collector) - lines = cpplint.CleansedLines(lines) - for i in range(lines.NumLines()): - cpplint.CheckForFunctionLengths(file_name, lines, i, - function_state, error_collector) - return error_collector.Results() - - def PerformIncludeWhatYouUse(self, code, filename='foo.h', io=codecs): - # First, build up the include state. - error_collector = ErrorCollector(self.assertTrue) - include_state = cpplint._IncludeState() - nesting_state = cpplint.NestingState() - lines = code.split('\n') - cpplint.RemoveMultiLineComments(filename, lines, error_collector) - lines = cpplint.CleansedLines(lines) - for i in range(lines.NumLines()): - cpplint.CheckLanguage(filename, lines, i, '.h', include_state, - nesting_state, error_collector) - # We could clear the error_collector here, but this should - # also be fine, since our IncludeWhatYouUse unittests do not - # have language problems. - - # Second, look for missing includes. - cpplint.CheckForIncludeWhatYouUse(filename, lines, include_state, - error_collector, io) - return error_collector.Results() - - # Perform lint and make sure one of the errors is what we want - def TestLintContains(self, code, expected_message): - self.assertTrue(expected_message in self.PerformSingleLineLint(code)) - def TestLintNotContains(self, code, expected_message): - self.assertFalse(expected_message in self.PerformSingleLineLint(code)) - - # Perform lint and compare the error message with "expected_message". - def TestLint(self, code, expected_message): - self.assertEqual(expected_message, self.PerformSingleLineLint(code)) - - def TestMultiLineLint(self, code, expected_message): - self.assertEqual(expected_message, self.PerformMultiLineLint(code)) - - def TestMultiLineLintRE(self, code, expected_message_re): - message = self.PerformMultiLineLint(code) - if not re.search(expected_message_re, message): - self.fail('Message was:\n' + message + 'Expected match to "' + - expected_message_re + '"') - - def TestLanguageRulesCheck(self, file_name, code, expected_message): - self.assertEqual(expected_message, - self.PerformLanguageRulesCheck(file_name, code)) - - def TestIncludeWhatYouUse(self, code, expected_message): - self.assertEqual(expected_message, - self.PerformIncludeWhatYouUse(code)) - - def TestBlankLinesCheck(self, lines, start_errors, end_errors): - for extension in ['c', 'cc', 'cpp', 'cxx', 'c++', 'cu']: - self.doTestBlankLinesCheck(lines, start_errors, end_errors, extension) - - def doTestBlankLinesCheck(self, lines, start_errors, end_errors, extension): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.' + extension, extension, lines, error_collector) - self.assertEqual( - start_errors, - error_collector.Results().count( - 'Redundant blank line at the start of a code block ' - 'should be deleted. [whitespace/blank_line] [2]')) - self.assertEqual( - end_errors, - error_collector.Results().count( - 'Redundant blank line at the end of a code block ' - 'should be deleted. [whitespace/blank_line] [3]')) - -class CpplintTest(CpplintTestBase): - - def GetNamespaceResults(self, lines): - error_collector = ErrorCollector(self.assertTrue) - cpplint.RemoveMultiLineComments('foo.h', lines, error_collector) - lines = cpplint.CleansedLines(lines) - nesting_state = cpplint.NestingState() - for i in range(lines.NumLines()): - nesting_state.Update('foo.h', lines, i, error_collector) - cpplint.CheckForNamespaceIndentation('foo.h', nesting_state, - lines, i, error_collector) - - return error_collector.Results() - - def testForwardDeclarationNamespaceIndentation(self): - lines = ['namespace Test {', - ' class ForwardDeclaration;', - '} // namespace Test'] - - results = self.GetNamespaceResults(lines) - self.assertEqual(results, 'Do not indent within a namespace. ' - ' [whitespace/indent_namespace] [4]') - - def testNamespaceIndentationForClass(self): - lines = ['namespace Test {', - 'void foo() { }', - ' class Test {', - ' };', - '} // namespace Test'] - - results = self.GetNamespaceResults(lines) - self.assertEqual(results, ['Do not indent within a namespace. ' - ' [whitespace/indent_namespace] [4]', - 'Do not indent within a namespace. ' - ' [whitespace/indent_namespace] [4]']) - - def testNamespaceIndentationNoError(self): - lines = ['namespace Test {', - 'void foo() { }', - '} // namespace Test'] - - results = self.GetNamespaceResults(lines) - self.assertEqual(results, '') - - def testNestingInNamespace(self): - lines = ['namespace Test {', - 'struct OuterClass {', - ' struct NoFalsePositivesHere;', - ' struct NoFalsePositivesHere member_variable;', - '};', - 'void foo() {', - ' const int no_positives_eh = 418;', - '}', - '} // namespace Test'] - - results = self.GetNamespaceResults(lines) - self.assertEqual(results, '') - - # Test get line width. - def testGetLineWidth(self): - self.assertEqual(0, cpplint.GetLineWidth('')) - self.assertEqual(10, cpplint.GetLineWidth(str('x') * 10)) - self.assertEqual(16, cpplint.GetLineWidth('\u90fd|\u9053|\u5e9c|\u770c|\u652f\u5e81')) - self.assertEqual(16, cpplint.GetLineWidth(u'都|道|府|県|支庁')) - self.assertEqual(5 + 13 + 9, cpplint.GetLineWidth( - u'd𝐱/dt' + u'f : t ⨯ 𝐱 → ℝ' + u't ⨯ 𝐱 → ℝ')) - - def testGetTextInside(self): - self.assertEqual('', cpplint._GetTextInside('fun()', r'fun\(')) - self.assertEqual('x, y', cpplint._GetTextInside('f(x, y)', r'f\(')) - self.assertEqual('a(), b(c())', cpplint._GetTextInside( - 'printf(a(), b(c()))', r'printf\(')) - self.assertEqual('x, y{}', cpplint._GetTextInside('f[x, y{}]', r'f\[')) - self.assertEqual(None, cpplint._GetTextInside('f[a, b(}]', r'f\[')) - self.assertEqual(None, cpplint._GetTextInside('f[x, y]', r'f\(')) - self.assertEqual('y, h(z, (a + b))', cpplint._GetTextInside( - 'f(x, g(y, h(z, (a + b))))', r'g\(')) - self.assertEqual('f(f(x))', cpplint._GetTextInside('f(f(f(x)))', r'f\(')) - # Supports multiple lines. - self.assertEqual('\n return loop(x);\n', - cpplint._GetTextInside( - 'int loop(int x) {\n return loop(x);\n}\n', r'\{')) - # '^' matches the beginning of each line. - self.assertEqual('x, y', - cpplint._GetTextInside( - '#include "inl.h" // skip #define\n' - '#define A2(x, y) a_inl_(x, y, __LINE__)\n' - '#define A(x) a_inl_(x, "", __LINE__)\n', - r'^\s*#define\s*\w+\(')) - - def testFindNextMultiLineCommentStart(self): - self.assertEqual(1, cpplint.FindNextMultiLineCommentStart([''], 0)) - - lines = ['a', 'b', '/* c'] - self.assertEqual(2, cpplint.FindNextMultiLineCommentStart(lines, 0)) - - lines = ['char a[] = "/*";'] # not recognized as comment. - self.assertEqual(1, cpplint.FindNextMultiLineCommentStart(lines, 0)) - - def testFindNextMultiLineCommentEnd(self): - self.assertEqual(1, cpplint.FindNextMultiLineCommentEnd([''], 0)) - lines = ['a', 'b', ' c */'] - self.assertEqual(2, cpplint.FindNextMultiLineCommentEnd(lines, 0)) - - def testRemoveMultiLineCommentsFromRange(self): - lines = ['a', ' /* comment ', ' * still comment', ' comment */ ', 'b'] - cpplint.RemoveMultiLineCommentsFromRange(lines, 1, 4) - self.assertEqual(['a', '/**/', '/**/', '/**/', 'b'], lines) - - def testSpacesAtEndOfLine(self): - self.TestLint( - '// Hello there ', - 'Line ends in whitespace. Consider deleting these extra spaces.' - ' [whitespace/end_of_line] [4]') - - # Test line length check. - def testLineLengthCheck(self): - self.TestLint( - '// Hello', - '') - self.TestLint( - '// x' + ' x' * 40, - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - self.TestLint( - '// x' + ' x' * 50, - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - self.TestLint( - '// //some/path/to/f' + ('i' * 100) + 'le', - '') - self.TestLint( - '// //some/path/to/f' + ('i' * 100) + 'le', - '') - self.TestLint( - '// //some/path/to/f' + ('i' * 50) + 'le and some comments', - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - self.TestLint( - '// http://g' + ('o' * 100) + 'gle.com/', - '') - self.TestLint( - '// https://g' + ('o' * 100) + 'gle.com/', - '') - self.TestLint( - '// https://g' + ('o' * 60) + 'gle.com/ and some comments', - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - self.TestLint( - '// Read https://g' + ('o' * 60) + 'gle.com/', - '') - self.TestLint( - '// $Id: g' + ('o' * 80) + 'gle.cc#1 $', - '') - self.TestLint( - '// $Id: g' + ('o' * 80) + 'gle.cc#1', - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - self.TestMultiLineLint( - 'static const char kCStr[] = "g' + ('o' * 50) + 'gle";\n', - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - self.TestMultiLineLint( - 'static const char kRawStr[] = R"(g' + ('o' * 50) + 'gle)";\n', - '') # no warning because raw string content is elided - self.TestMultiLineLint( - 'static const char kMultiLineRawStr[] = R"(\n' - 'g' + ('o' * 80) + 'gle\n' - ')";', - '') - self.TestMultiLineLint( - 'static const char kL' + ('o' * 50) + 'ngIdentifier[] = R"()";\n', - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - self.TestLint( - ' /// @copydoc ' + ('o' * (cpplint._line_length * 2)), - '') - self.TestLint( - ' /// @copydetails ' + ('o' * (cpplint._line_length * 2)), - '') - self.TestLint( - ' /// @copybrief ' + ('o' * (cpplint._line_length * 2)), - '') - - # Test error suppression annotations. - def testErrorSuppression(self): - # Two errors on same line: - self.TestLint( - 'long a = (int64_t) 65;', - ['Using C-style cast. Use static_cast(...) instead' - ' [readability/casting] [4]', - 'Use int16_t/int64_t/etc, rather than the C type long' - ' [runtime/int] [4]', - ]) - # One category of error suppressed: - self.TestLint( - 'long a = (int64_t) 65; // NOLINT(runtime/int)', - 'Using C-style cast. Use static_cast(...) instead' - ' [readability/casting] [4]') - # Two categories of errors suppressed: - self.TestLint( - 'long a = (int64_t) 65; // NOLINT(runtime/int,readability/casting)', - '') - - # All categories suppressed: (two aliases) - self.TestLint('long a = (int64_t) 65; // NOLINT', '') - self.TestLint('long a = (int64_t) 65; // NOLINT(*)', '') - # Malformed NOLINT directive: - self.TestLint( - 'long a = 65; // NOLINT(foo)', - ['Unknown NOLINT error category: foo' - ' [readability/nolint] [5]', - 'Use int16_t/int64_t/etc, rather than the C type long [runtime/int] [4]', - ]) - # Irrelevant NOLINT directive has no effect: - self.TestLint( - 'long a = 65; // NOLINT(readability/casting)', - 'Use int16_t/int64_t/etc, rather than the C type long' - ' [runtime/int] [4]') - # NOLINTNEXTLINE silences warning for the next line instead of current line - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTNEXTLINE(whitespace/line_length)', - '// ./command' + (' -verbose' * 80), - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - # NOLINTNEXTLINE multiple categories silences warning for the next line instead of current line - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTNEXTLINE(runtime/int,readability/casting)', - 'long a = (int64_t) 65;', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - # LINT_C_FILE silences cast warnings for entire file. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.h', 'h', - ['// Copyright 2014 Your Company.', - '// NOLINT(build/header_guard)', - 'int64_t a = (uint64_t) 65;', - '// LINT_C_FILE', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - # Vim modes silence cast warnings for entire file. - for modeline in ['vi:filetype=c', - 'vi:sw=8 filetype=c', - 'vi:sw=8 filetype=c ts=8', - 'vi: filetype=c', - 'vi: sw=8 filetype=c', - 'vi: sw=8 filetype=c ts=8', - 'vim:filetype=c', - 'vim:sw=8 filetype=c', - 'vim:sw=8 filetype=c ts=8', - 'vim: filetype=c', - 'vim: sw=8 filetype=c', - 'vim: sw=8 filetype=c ts=8', - 'vim: set filetype=c:', - 'vim: set sw=8 filetype=c:', - 'vim: set sw=8 filetype=c ts=8:', - 'vim: set filetype=c :', - 'vim: set sw=8 filetype=c :', - 'vim: set sw=8 filetype=c ts=8 :', - 'vim: se filetype=c:', - 'vim: se sw=8 filetype=c:', - 'vim: se sw=8 filetype=c ts=8:', - 'vim: se filetype=c :', - 'vim: se sw=8 filetype=c :', - 'vim: se sw=8 filetype=c ts=8 :']: - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.h', 'h', - ['// Copyright 2014 Your Company.', - '// NOLINT(build/header_guard)', - 'int64_t a = (uint64_t) 65;', - '/* Prevent warnings about the modeline', - modeline, - '*/', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - # LINT_KERNEL_FILE silences whitespace/tab warnings for entire file. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.h', 'h', - ['// Copyright 2014 Your Company.', - '// NOLINT(build/header_guard)', - 'struct test {', - '\tint member;', - '};', - '// LINT_KERNEL_FILE', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - # NOLINT, NOLINTNEXTLINE silences the readability/braces warning for "};". - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '#include ', - 'for (int i = 0; i != 100; ++i) {', - ' std::cout << i << std::endl;', - '}; // NOLINT', - 'for (int i = 0; i != 100; ++i) {', - ' std::cout << i << std::endl;', - '// NOLINTNEXTLINE', - '};', - '// LINT_KERNEL_FILE', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - # NOLINTBEGIN and silences all warnings after it - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTBEGIN', - 'long a = (int64_t) 65;' - 'long a = 65;', - '// ./command' + (' -verbose' * 80)], - error_collector) - self.assertEqual('', error_collector.Results()) - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTBEGIN(*)', - 'long a = (int64_t) 65;' - 'long a = 65;', - '// ./command' + (' -verbose' * 80)], - error_collector) - self.assertEqual('', error_collector.Results()) - # NOLINTEND will show warnings after that point - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTBEGIN', - 'long a = (int64_t) 65;' - 'long a = 65;', - '// NOLINTEND', - '// ./command' + (' -verbose' * 80), - ''], - error_collector) - self.assertEqual('Lines should be <= 80 characters long ' - '[whitespace/line_length] [2]', error_collector.Results()) - # NOLINTBEGIN(category) silences category warnings after it - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTBEGIN(readability/casting,runtime/int)', - 'long a = (int64_t) 65;', - 'long a = 65;', - '// ./command' + (' -verbose' * 80), - '// NOLINTEND', - ''], - error_collector) - self.assertEqual('Lines should be <= 80 characters long ' - '[whitespace/line_length] [2]', - error_collector.Results()) - # NOLINTEND(category) will generate an error that categories are not supported - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTBEGIN(readability/casting,runtime/int)', - 'long a = (int64_t) 65;', - 'long a = 65;', - '// NOLINTEND(readability/casting)', - ''], - error_collector) - self.assertEqual('NOLINT categories not supported in block END: readability/casting ' - '[readability/nolint] [5]', - error_collector.Results()) - # nested NOLINTBEGIN is not allowed - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTBEGIN(readability/casting,runtime/int)', - 'long a = (int64_t) 65;', - '// NOLINTBEGIN(runtime/int)', - 'long a = 65;', - '// NOLINTEND(*)', - ''], - error_collector) - self.assertEqual('NONLINT block already defined on line 2 ' - '[readability/nolint] [5]', error_collector.Results()) - # error if NOLINGBEGIN is not ended - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('test.cc', 'cc', - ['// Copyright 2014 Your Company.', - '// NOLINTBEGIN(readability/casting,runtime/int)', - 'long a = (int64_t) 65;', - 'long a = 65;', - ''], - error_collector) - self.assertEqual('NONLINT block never ended [readability/nolint] [5]', error_collector.Results()) - # error if unmatched NOLINTEND - self.TestLint( - '// NOLINTEND', - 'Not in a NOLINT block ' - '[readability/nolint] [5]') - self.TestLint( - '// NOLINTEND(*)', - 'Not in a NOLINT block ' - '[readability/nolint] [5]') - - # Test Variable Declarations. - def testVariableDeclarations(self): - self.TestLint( - 'long a = 65;', - 'Use int16_t/int64_t/etc, rather than the C type long' - ' [runtime/int] [4]') - self.TestLint( - 'long double b = 65.0;', - '') - self.TestLint( - 'long long aa = 6565;', - 'Use int16_t/int64_t/etc, rather than the C type long' - ' [runtime/int] [4]') - - # Test C-style cast cases. - def testCStyleCast(self): - self.TestLint( - 'int a = (int)1.0;', - 'Using C-style cast. Use static_cast(...) instead' - ' [readability/casting] [4]') - self.TestLint( - 'int a = (int)-1.0;', - 'Using C-style cast. Use static_cast(...) instead' - ' [readability/casting] [4]') - self.TestLint( - 'int *a = (int *)NULL;', - 'Using C-style cast. Use reinterpret_cast(...) instead' - ' [readability/casting] [4]') - - self.TestLint( - 'uint16_t a = (uint16_t)1.0;', - 'Using C-style cast. Use static_cast(...) instead' - ' [readability/casting] [4]') - self.TestLint( - 'int32_t a = (int32_t)1.0;', - 'Using C-style cast. Use static_cast(...) instead' - ' [readability/casting] [4]') - self.TestLint( - 'uint64_t a = (uint64_t)1.0;', - 'Using C-style cast. Use static_cast(...) instead' - ' [readability/casting] [4]') - self.TestLint( - 'size_t a = (size_t)1.0;', - 'Using C-style cast. Use static_cast(...) instead' - ' [readability/casting] [4]') - - # These shouldn't be recognized casts. - self.TestLint('u a = (u)NULL;', '') - self.TestLint('uint a = (uint)NULL;', '') - self.TestLint('typedef MockCallback CallbackType;', '') - self.TestLint('scoped_ptr< MockCallback > callback_value;', '') - self.TestLint('std::function', '') - self.TestLint('x = sizeof(int)', '') - self.TestLint('x = alignof(int)', '') - self.TestLint('alignas(int) char x[42]', '') - self.TestLint('alignas(alignof(x)) char y[42]', '') - self.TestLint('void F(int (func)(int));', '') - self.TestLint('void F(int (func)(int*));', '') - self.TestLint('void F(int (Class::member)(int));', '') - self.TestLint('void F(int (Class::member)(int*));', '') - self.TestLint('void F(int (Class::member)(int), int param);', '') - self.TestLint('void F(int (Class::member)(int*), int param);', '') - self.TestLint('X Class::operator++(int)', '') - self.TestLint('X Class::operator--(int)', '') - - # These should not be recognized (lambda functions without arg names). - self.TestLint('[](int/*unused*/) -> bool {', '') - self.TestLint('[](int /*unused*/) -> bool {', '') - self.TestLint('auto f = [](MyStruct* /*unused*/)->int {', '') - self.TestLint('[](int) -> bool {', '') - self.TestLint('auto f = [](MyStruct*)->int {', '') - - # Cast with brace initializers - self.TestLint('int64_t{4096} * 1000 * 1000', '') - self.TestLint('size_t{4096} * 1000 * 1000', '') - self.TestLint('uint_fast16_t{4096} * 1000 * 1000', '') - - # Brace initializer with templated type - self.TestMultiLineLint( +class MockIo: + def __init__(self, mock_file): + # wrap list to allow "with open(mock)" + class EnterableList(list): + def __enter__(self): + return self + + def __exit__(self, type, value, tb): # noqa: A002 + return self + + self.mock_file = EnterableList(mock_file) + + def open( + self, # pylint: disable=C6409 + unused_filename, + unused_mode, + unused_encoding, + _, + ): + return self.mock_file + + +class CpplintTestBase: + """Provides some useful helper functions for cpplint tests.""" + + def setUp(self): + # Allow subclasses to cheat os.path.abspath called in FileInfo class. + self.os_path_abspath_orig = os.path.abspath + + def tearDown(self): + os.path.abspath = self.os_path_abspath_orig + + def assertTrue(self, condition, message=""): + assert condition, message + + # Perform lint on single line of input and return the error message. + def PerformSingleLineLint(self, code): + error_collector = ErrorCollector(self.assertTrue) + lines = code.split("\n") + cpplint.RemoveMultiLineComments("foo.h", lines, error_collector) + clean_lines = cpplint.CleansedLines(lines) + include_state = cpplint._IncludeState() + function_state = cpplint._FunctionState() + nesting_state = cpplint.NestingState() + cpplint.ProcessLine( + "foo.cc", + "cc", + clean_lines, + 0, + include_state, + function_state, + nesting_state, + error_collector, + ) + # Single-line lint tests are allowed to fail the 'unlintable function' + # check. + error_collector.RemoveIfPresent("Lint failed to find start of function body.") + return error_collector.Results() + + # Perform lint over multiple lines and return the error message. + def PerformMultiLineLint(self, code): + error_collector = ErrorCollector(self.assertTrue) + lines = code.split("\n") + cpplint.RemoveMultiLineComments("foo.h", lines, error_collector) + lines = cpplint.CleansedLines(lines) + nesting_state = cpplint.NestingState() + for i in range(lines.NumLines()): + nesting_state.Update("foo.h", lines, i, error_collector) + cpplint.CheckStyle("foo.h", lines, i, "h", nesting_state, error_collector) + cpplint.CheckForNonStandardConstructs("foo.h", lines, i, nesting_state, error_collector) + return error_collector.Results() + + # Similar to PerformMultiLineLint, but calls CheckLanguage instead of + # CheckForNonStandardConstructs + def PerformLanguageRulesCheck(self, file_name, code): + error_collector = ErrorCollector(self.assertTrue) + include_state = cpplint._IncludeState() + nesting_state = cpplint.NestingState() + lines = code.split("\n") + cpplint.RemoveMultiLineComments(file_name, lines, error_collector) + lines = cpplint.CleansedLines(lines) + ext = file_name[file_name.rfind(".") + 1 :] + for i in range(lines.NumLines()): + cpplint.CheckLanguage( + file_name, lines, i, ext, include_state, nesting_state, error_collector + ) + return error_collector.Results() + + def PerformFunctionLengthsCheck(self, code): + """Perform Lint function length check on block of code and return warnings. + + Builds up an array of lines corresponding to the code and strips comments + using cpplint functions. + + Establishes an error collector and invokes the function length checking + function following cpplint's pattern. + + Args: + code: C++ source code expected to generate a warning message. + + Returns: + The accumulated errors. """ + file_name = "foo.cc" + error_collector = ErrorCollector(self.assertTrue) + function_state = cpplint._FunctionState() + lines = code.split("\n") + cpplint.RemoveMultiLineComments(file_name, lines, error_collector) + lines = cpplint.CleansedLines(lines) + for i in range(lines.NumLines()): + cpplint.CheckForFunctionLengths(file_name, lines, i, function_state, error_collector) + return error_collector.Results() + + def PerformIncludeWhatYouUse(self, code, filename="foo.h", io=codecs): + # First, build up the include state. + error_collector = ErrorCollector(self.assertTrue) + include_state = cpplint._IncludeState() + nesting_state = cpplint.NestingState() + lines = code.split("\n") + cpplint.RemoveMultiLineComments(filename, lines, error_collector) + lines = cpplint.CleansedLines(lines) + for i in range(lines.NumLines()): + cpplint.CheckLanguage( + filename, lines, i, ".h", include_state, nesting_state, error_collector + ) + # We could clear the error_collector here, but this should + # also be fine, since our IncludeWhatYouUse unittests do not + # have language problems. + + # Second, look for missing includes. + cpplint.CheckForIncludeWhatYouUse(filename, lines, include_state, error_collector, io) + return error_collector.Results() + + # Perform lint and make sure one of the errors is what we want + def TestLintContains(self, code, expected_message): + assert expected_message in self.PerformSingleLineLint(code) + + def TestLintNotContains(self, code, expected_message): + assert expected_message not in self.PerformSingleLineLint(code) + + # Perform lint and compare the error message with "expected_message". + def TestLint(self, code, expected_message): + assert expected_message == self.PerformSingleLineLint(code) + + def TestMultiLineLint(self, code, expected_message): + assert expected_message == self.PerformMultiLineLint(code) + + def TestMultiLineLintRE(self, code, expected_message_re): + message = self.PerformMultiLineLint(code) + assert re.search(expected_message_re, message) + + def TestLanguageRulesCheck(self, file_name, code, expected_message): + assert expected_message == self.PerformLanguageRulesCheck(file_name, code) + + def TestIncludeWhatYouUse(self, code, expected_message): + assert expected_message == self.PerformIncludeWhatYouUse(code) + + def TestBlankLinesCheck(self, lines, start_errors, end_errors): + for extension in ["c", "cc", "cpp", "cxx", "c++", "cu"]: + self.doTestBlankLinesCheck(lines, start_errors, end_errors, extension) + + def doTestBlankLinesCheck(self, lines, start_errors, end_errors, extension): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData("foo." + extension, extension, lines, error_collector) + assert start_errors == error_collector.Results().count( + "Redundant blank line at the start of a code block should be deleted. " + "[whitespace/blank_line] [2]" + ) + assert end_errors == error_collector.Results().count( + "Redundant blank line at the end of a code block should be deleted. " + "[whitespace/blank_line] [3]" + ) + + +class TestCpplint(CpplintTestBase): + def GetNamespaceResults(self, lines): + error_collector = ErrorCollector(self.assertTrue) + cpplint.RemoveMultiLineComments("foo.h", lines, error_collector) + lines = cpplint.CleansedLines(lines) + nesting_state = cpplint.NestingState() + for i in range(lines.NumLines()): + nesting_state.Update("foo.h", lines, i, error_collector) + cpplint.CheckForNamespaceIndentation("foo.h", nesting_state, lines, i, error_collector) + + return error_collector.Results() + + def testForwardDeclarationNamespaceIndentation(self): + lines = ["namespace Test {", " class ForwardDeclaration;", "} // namespace Test"] + + results = self.GetNamespaceResults(lines) + assert results == "Do not indent within a namespace. [whitespace/indent_namespace] [4]" + + def testNamespaceIndentationForClass(self): + lines = [ + "namespace Test {", + "void foo() { }", + " class Test {", + " };", + "} // namespace Test", + ] + + results = self.GetNamespaceResults(lines) + assert results == [ + "Do not indent within a namespace. [whitespace/indent_namespace] [4]", + "Do not indent within a namespace. [whitespace/indent_namespace] [4]", + ] + + def testNamespaceIndentationIndentedParameter(self): + lines = [ + "namespace Test {", + "void foo(SuperLongTypeName d = 418,", + " SuperLongTypeName e = 2.71) { }", + "} // namespace Test", + ] + + results = self.GetNamespaceResults(lines) + assert results == "" + + def testNestingInNamespace(self): + lines = [ + "namespace Test {", + "struct OuterClass {", + " struct NoFalsePositivesHere;", + " struct NoFalsePositivesHere member_variable;", + "};", + "void foo() {", + " const int no_positives_eh = 418;", + "}", + "} // namespace Test", + ] + + results = self.GetNamespaceResults(lines) + assert results == "" + + # Test get line width. + def testGetLineWidth(self): + assert cpplint.GetLineWidth("") == 0 + assert cpplint.GetLineWidth("x" * 10) == 10 + assert cpplint.GetLineWidth("都|道|府|県|支庁") == 16 + assert cpplint.GetLineWidth("都|道|府|県|支庁") == 16 + assert cpplint.GetLineWidth("d𝐱/dt" + "f : t ⨯ 𝐱 → ℝ" + "t ⨯ 𝐱 → ℝ") == 5 + 13 + 9 + + def testGetTextInside(self): + assert cpplint._GetTextInside("fun()", r"fun\(") == "" + assert cpplint._GetTextInside("f(x, y)", r"f\(") == "x, y" + assert cpplint._GetTextInside("printf(a(), b(c()))", r"printf\(") == "a(), b(c())" + assert cpplint._GetTextInside("f[x, y{}]", r"f\[") == "x, y{}" + assert None is cpplint._GetTextInside("f[a, b(}]", r"f\[") + assert None is cpplint._GetTextInside("f[x, y]", r"f\(") + assert cpplint._GetTextInside("f(x, g(y, h(z, (a + b))))", r"g\(") == "y, h(z, (a + b))" + assert cpplint._GetTextInside("f(f(f(x)))", r"f\(") == "f(f(x))" + # Supports multiple lines. + assert ( + cpplint._GetTextInside("int loop(int x) {\n return loop(x);\n}\n", r"\{") + == "\n return loop(x);\n" + ) + # '^' matches the beginning of each line. + assert ( + cpplint._GetTextInside( + '#include "inl.h" // skip #define\n' + "#define A2(x, y) a_inl_(x, y, __LINE__)\n" + '#define A(x) a_inl_(x, "", __LINE__)\n', + r"^\s*#define\s*\w+\(", + ) + == "x, y" + ) + + def testFindNextMultiLineCommentStart(self): + assert cpplint.FindNextMultiLineCommentStart([""], 0) == 1 + + lines = ["a", "b", "/* c"] + assert cpplint.FindNextMultiLineCommentStart(lines, 0) == 2 + + lines = ['char a[] = "/*";'] # not recognized as comment. + assert cpplint.FindNextMultiLineCommentStart(lines, 0) == 1 + + def testFindNextMultiLineCommentEnd(self): + assert cpplint.FindNextMultiLineCommentEnd([""], 0) == 1 + lines = ["a", "b", " c */"] + assert cpplint.FindNextMultiLineCommentEnd(lines, 0) == 2 + + def testRemoveMultiLineCommentsFromRange(self): + lines = ["a", " /* comment ", " * still comment", " comment */ ", "b"] + cpplint.RemoveMultiLineCommentsFromRange(lines, 1, 4) + assert lines == ["a", "/**/", "/**/", "/**/", "b"] + + def testSpacesAtEndOfLine(self): + self.TestLint( + "// Hello there ", + "Line ends in whitespace. Consider deleting these extra spaces." + " [whitespace/end_of_line] [4]", + ) + + # Test line length check. + def testLineLengthCheck(self): + self.TestLint("// Hello", "") + self.TestLint( + "// x" + " x" * 40, + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + self.TestLint( + "// x" + " x" * 50, + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + self.TestLint("// //some/path/to/f" + ("i" * 100) + "le", "") + self.TestLint("// //some/path/to/f" + ("i" * 100) + "le", "") + self.TestLint( + "// //some/path/to/f" + ("i" * 50) + "le and some comments", + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + self.TestLint("// http://g" + ("o" * 100) + "gle.com/", "") + self.TestLint("// https://g" + ("o" * 100) + "gle.com/", "") + self.TestLint( + "// https://g" + ("o" * 60) + "gle.com/ and some comments", + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + self.TestLint("// Read https://g" + ("o" * 60) + "gle.com/", "") + self.TestLint("// $Id: g" + ("o" * 80) + "gle.cc#1 $", "") + self.TestLint( + "// $Id: g" + ("o" * 80) + "gle.cc#1", + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + self.TestMultiLineLint( + 'static const char kCStr[] = "g' + ("o" * 50) + 'gle";\n', + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + self.TestMultiLineLint( + 'static const char kRawStr[] = R"(g' + ("o" * 50) + 'gle)";\n', "" + ) # no warning because raw string content is elided + self.TestMultiLineLint( + 'static const char kMultiLineRawStr[] = R"(\ng' + ("o" * 80) + 'gle\n)";', "" + ) + self.TestMultiLineLint( + "static const char kL" + ("o" * 50) + 'ngIdentifier[] = R"()";\n', + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + self.TestLint(" /// @copydoc " + ("o" * (cpplint._line_length * 2)), "") + self.TestLint(" /// @copydetails " + ("o" * (cpplint._line_length * 2)), "") + self.TestLint(" /// @copybrief " + ("o" * (cpplint._line_length * 2)), "") + + # Test error suppression annotations. + def testErrorSuppression(self): + # Two errors on same line: + self.TestLint( + "long a = (int64_t) 65;", + [ + "Using C-style cast. Use static_cast(...) instead" + " [readability/casting] [4]", + "Use int16_t/int64_t/etc, rather than the C type long [runtime/int] [4]", + ], + ) + # One category of error suppressed: + self.TestLint( + "long a = (int64_t) 65; // NOLINT(runtime/int)", + "Using C-style cast. Use static_cast(...) instead [readability/casting] [4]", + ) + # Two categories of errors suppressed: + self.TestLint("long a = (int64_t) 65; // NOLINT(runtime/int,readability/casting)", "") + + # All categories suppressed: (two aliases) + self.TestLint("long a = (int64_t) 65; // NOLINT", "") + self.TestLint("long a = (int64_t) 65; // NOLINT(*)", "") + + # Linting a C file + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.c", + "c", + ["// Copyright 2014 Your Majesty.", "int64_t a = (int64_t) 65;", ""], + error_collector, + ) + assert error_collector.Results() == "" + + # Malformed NOLINT directive: + self.TestLint( + "long a = 65; // NOLINT(foo)", + [ + "Unknown NOLINT error category: foo [readability/nolint] [5]", + "Use int16_t/int64_t/etc, rather than the C type long [runtime/int] [4]", + ], + ) + # Irrelevant NOLINT directive has no effect: + self.TestLint( + "long a = 65; // NOLINT(readability/casting)", + "Use int16_t/int64_t/etc, rather than the C type long [runtime/int] [4]", + ) + # NOLINTNEXTLINE silences warning for the next line instead of current line + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTNEXTLINE(whitespace/line_length)", + "// ./command" + (" -verbose" * 80), + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + # NOLINTNEXTLINE multiple categories silences warning for the next line instead of current + # line + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTNEXTLINE(runtime/int,readability/casting)", + "long a = (int64_t) 65;", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + # LINT_C_FILE silences cast warnings for entire file. + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.h", + "h", + [ + "// Copyright 2014 Your Company.", + "// NOLINT(build/header_guard)", + "int64_t a = (uint64_t) 65;", + "// LINT_C_FILE", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + # Vim modes silence cast warnings for entire file. + for modeline in [ + "vi:filetype=c", + "vi:sw=8 filetype=c", + "vi:sw=8 filetype=c ts=8", + "vi: filetype=c", + "vi: sw=8 filetype=c", + "vi: sw=8 filetype=c ts=8", + "vim:filetype=c", + "vim:sw=8 filetype=c", + "vim:sw=8 filetype=c ts=8", + "vim: filetype=c", + "vim: sw=8 filetype=c", + "vim: sw=8 filetype=c ts=8", + "vim: set filetype=c:", + "vim: set sw=8 filetype=c:", + "vim: set sw=8 filetype=c ts=8:", + "vim: set filetype=c :", + "vim: set sw=8 filetype=c :", + "vim: set sw=8 filetype=c ts=8 :", + "vim: se filetype=c:", + "vim: se sw=8 filetype=c:", + "vim: se sw=8 filetype=c ts=8:", + "vim: se filetype=c :", + "vim: se sw=8 filetype=c :", + "vim: se sw=8 filetype=c ts=8 :", + ]: + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.h", + "h", + [ + "// Copyright 2014 Your Company.", + "// NOLINT(build/header_guard)", + "int64_t a = (uint64_t) 65;", + "/* Prevent warnings about the modeline", + modeline, + "*/", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + # LINT_KERNEL_FILE silences whitespace/tab warnings for entire file. + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.h", + "h", + [ + "// Copyright 2014 Your Company.", + "// NOLINT(build/header_guard)", + "struct test {", + "\tint member;", + "};", + "// LINT_KERNEL_FILE", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + # NOLINT, NOLINTNEXTLINE silences the readability/braces warning for "};". + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "#include ", + "for (int i = 0; i != 100; ++i) {", + " std::cout << i << std::endl;", + "}; // NOLINT", + "for (int i = 0; i != 100; ++i) {", + " std::cout << i << std::endl;", + "// NOLINTNEXTLINE", + "};", + "// LINT_KERNEL_FILE", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + # NOLINTBEGIN and silences all warnings after it + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTBEGIN", + "long a = (int64_t) 65;long a = 65;", + "// ./command" + (" -verbose" * 80), + ], + error_collector, + ) + assert error_collector.Results() == "" + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTBEGIN(*)", + "long a = (int64_t) 65;long a = 65;", + "// ./command" + (" -verbose" * 80), + ], + error_collector, + ) + assert error_collector.Results() == "" + # NOLINTEND will show warnings after that point + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTBEGIN", + "long a = (int64_t) 65;long a = 65;", + "// NOLINTEND", + "// ./command" + (" -verbose" * 80), + "", + ], + error_collector, + ) + assert ( + error_collector.Results() + == "Lines should be <= 80 characters long [whitespace/line_length] [2]" + ) + # NOLINTBEGIN(category) silences category warnings after it + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTBEGIN(readability/casting,runtime/int)", + "long a = (int64_t) 65;", + "long a = 65;", + "// ./command" + (" -verbose" * 80), + "// NOLINTEND", + "", + ], + error_collector, + ) + assert ( + error_collector.Results() + == "Lines should be <= 80 characters long [whitespace/line_length] [2]" + ) + # NOLINTEND(category) will generate an error that categories are not supported + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTBEGIN(readability/casting,runtime/int)", + "long a = (int64_t) 65;", + "long a = 65;", + "// NOLINTEND(readability/casting)", + "", + ], + error_collector, + ) + assert ( + error_collector.Results() + == "NOLINT categories not supported in block END: readability/casting " + "[readability/nolint] [5]" + ) + # nested NOLINTBEGIN is not allowed + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTBEGIN(readability/casting,runtime/int)", + "long a = (int64_t) 65;", + "// NOLINTBEGIN(runtime/int)", + "long a = 65;", + "// NOLINTEND(*)", + "", + ], + error_collector, + ) + assert ( + error_collector.Results() + == "NONLINT block already defined on line 2 [readability/nolint] [5]" + ) + # error if NOLINGBEGIN is not ended + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "// NOLINTBEGIN(readability/casting,runtime/int)", + "long a = (int64_t) 65;", + "long a = 65;", + "", + ], + error_collector, + ) + assert error_collector.Results() == "NONLINT block never ended [readability/nolint] [5]" + # error if unmatched NOLINTEND + self.TestLint("// NOLINTEND", "Not in a NOLINT block [readability/nolint] [5]") + self.TestLint("// NOLINTEND(*)", "Not in a NOLINT block [readability/nolint] [5]") + + # Test Variable Declarations. + def testVariableDeclarations(self): + self.TestLint( + "long a = 65;", + "Use int16_t/int64_t/etc, rather than the C type long [runtime/int] [4]", + ) + self.TestLint("long double b = 65.0;", "") + self.TestLint( + "long long aa = 6565;", + "Use int16_t/int64_t/etc, rather than the C type long [runtime/int] [4]", + ) + + # Test C-style cast cases. + def testCStyleCast(self): + self.TestLint( + "int a = (int)1.0;", + "Using C-style cast. Use static_cast(...) instead [readability/casting] [4]", + ) + self.TestLint( + "int a = (int)-1.0;", + "Using C-style cast. Use static_cast(...) instead [readability/casting] [4]", + ) + self.TestLint( + "int *a = (int *)NULL;", + "Using C-style cast. Use reinterpret_cast(...) instead" + " [readability/casting] [4]", + ) + + self.TestLint( + "uint16_t a = (uint16_t)1.0;", + "Using C-style cast. Use static_cast(...) instead" + " [readability/casting] [4]", + ) + self.TestLint( + "int32_t a = (int32_t)1.0;", + "Using C-style cast. Use static_cast(...) instead [readability/casting] [4]", + ) + self.TestLint( + "uint64_t a = (uint64_t)1.0;", + "Using C-style cast. Use static_cast(...) instead" + " [readability/casting] [4]", + ) + self.TestLint( + "size_t a = (size_t)1.0;", + "Using C-style cast. Use static_cast(...) instead [readability/casting] [4]", + ) + + # These shouldn't be recognized casts. + self.TestLint("u a = (u)NULL;", "") + self.TestLint("uint a = (uint)NULL;", "") + self.TestLint("typedef MockCallback CallbackType;", "") + self.TestLint("scoped_ptr< MockCallback > callback_value;", "") + self.TestLint("std::function", "") + self.TestLint("x = sizeof(int)", "") + self.TestLint("x = alignof(int)", "") + self.TestLint("alignas(int) char x[42]", "") + self.TestLint("alignas(alignof(x)) char y[42]", "") + self.TestLint("void F(int (func)(int));", "") + self.TestLint("void F(int (func)(int*));", "") + self.TestLint("void F(int (Class::member)(int));", "") + self.TestLint("void F(int (Class::member)(int*));", "") + self.TestLint("void F(int (Class::member)(int), int param);", "") + self.TestLint("void F(int (Class::member)(int*), int param);", "") + self.TestLint("X Class::operator++(int)", "") + self.TestLint("X Class::operator--(int)", "") + + # These should not be recognized (lambda functions without arg names). + self.TestLint("[](int/*unused*/) -> bool {", "") + self.TestLint("[](int /*unused*/) -> bool {", "") + self.TestLint("auto f = [](MyStruct* /*unused*/)->int {", "") + self.TestLint("[](int) -> bool {", "") + self.TestLint("auto f = [](MyStruct*)->int {", "") + + # Cast with brace initializers + self.TestLint("int64_t{4096} * 1000 * 1000", "") + self.TestLint("size_t{4096} * 1000 * 1000", "") + self.TestLint("uint_fast16_t{4096} * 1000 * 1000", "") + + # Brace initializer with templated type + self.TestMultiLineLint( + """ template void Function(int arg1, int arg2) { variable &= ~Type1{0} - 1; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ template class Class { void Function() { variable &= ~Type{0} - 1; } };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ template class Class { void Function() { variable &= ~Type{0} - 1; } };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ namespace { template class Class { @@ -793,440 +865,450 @@ class Class { } }; }""", - '') - - # Test taking address of casts (runtime/casting) - def testRuntimeCasting(self): - error_msg = ('Are you taking an address of a cast? ' - 'This is dangerous: could be a temp var. ' - 'Take the address before doing the cast, rather than after' - ' [runtime/casting] [4]') - self.TestLint('int* x = &static_cast(foo);', error_msg) - self.TestLint('int* x = &reinterpret_cast(foo);', error_msg) - self.TestLint('int* x = &(int*)foo;', - ['Using C-style cast. Use reinterpret_cast(...) ' - 'instead [readability/casting] [4]', - error_msg]) - self.TestLint('BudgetBuckets&(BudgetWinHistory::*BucketFn)(void) const;', - '') - self.TestLint('&(*func_ptr)(arg)', '') - self.TestLint('Compute(arg, &(*func_ptr)(i, j));', '') - - # Alternative error message - alt_error_msg = ('Are you taking an address of something dereferenced ' - 'from a cast? Wrapping the dereferenced expression in ' - 'parentheses will make the binding more obvious' - ' [readability/casting] [4]') - self.TestLint('int* x = &down_cast(obj)->member_;', alt_error_msg) - self.TestLint('int* x = &down_cast(obj)[index];', alt_error_msg) - self.TestLint('int* x = &(down_cast(obj)->member_);', '') - self.TestLint('int* x = &(down_cast(obj)[index]);', '') - self.TestLint('int* x = &down_cast(obj)\n->member_;', alt_error_msg) - self.TestLint('int* x = &(down_cast(obj)\n->member_);', '') - - # It's OK to cast an address. - self.TestLint('int* x = reinterpret_cast(&foo);', '') - - # Function pointers returning references should not be confused - # with taking address of old-style casts. - self.TestLint('auto x = implicit_cast(&foo);', '') - - def testRuntimeSelfinit(self): - self.TestLint( - 'Foo::Foo(Bar r, Bel l) : r_(r_), l_(l_) { }', - 'You seem to be initializing a member variable with itself.' - ' [runtime/init] [4]') - self.TestLint( - 'Foo::Foo(Bar r, Bel l) : r_(CHECK_NOTNULL(r_)) { }', - 'You seem to be initializing a member variable with itself.' - ' [runtime/init] [4]') - self.TestLint( - 'Foo::Foo(Bar r, Bel l) : r_(r), l_(l) { }', - '') - self.TestLint( - 'Foo::Foo(Bar r) : r_(r), l_(r_), ll_(l_) { }', - '') - - # Test for unnamed arguments in a method. - def testCheckForUnnamedParams(self): - self.TestLint('virtual void Func(int*) const;', '') - self.TestLint('virtual void Func(int*);', '') - self.TestLint('void Method(char*) {', '') - self.TestLint('void Method(char*);', '') - self.TestLint('static void operator delete[](void*) throw();', '') - self.TestLint('int Method(int);', '') - - self.TestLint('virtual void Func(int* p);', '') - self.TestLint('void operator delete(void* x) throw();', '') - self.TestLint('void Method(char* x) {', '') - self.TestLint('void Method(char* /*x*/) {', '') - self.TestLint('void Method(char* x);', '') - self.TestLint('typedef void (*Method)(int32_t x);', '') - self.TestLint('static void operator delete[](void* x) throw();', '') - self.TestLint('static void operator delete[](void* /*x*/) throw();', '') - - self.TestLint('X operator++(int);', '') - self.TestLint('X operator++(int) {', '') - self.TestLint('X operator--(int);', '') - self.TestLint('X operator--(int /*unused*/) {', '') - self.TestLint('MACRO(int);', '') - self.TestLint('MACRO(func(int));', '') - self.TestLint('MACRO(arg, func(int));', '') - - self.TestLint('void (*func)(void*);', '') - self.TestLint('void Func((*func)(void*)) {}', '') - self.TestLint('template void func();', '') - self.TestLint('virtual void f(int /*unused*/) {', '') - self.TestLint('void f(int /*unused*/) override {', '') - self.TestLint('void f(int /*unused*/) final {', '') - - # Test deprecated casts such as int(d) - def testDeprecatedCast(self): - self.TestLint( - 'int a = int(2.2);', - 'Using deprecated casting style. ' - 'Use static_cast(...) instead' - ' [readability/casting] [4]') - - self.TestLint( - '(char *) "foo"', - 'Using C-style cast. ' - 'Use const_cast(...) instead' - ' [readability/casting] [4]') - - self.TestLint( - '(int*)foo', - 'Using C-style cast. ' - 'Use reinterpret_cast(...) instead' - ' [readability/casting] [4]') - - # Checks for false positives... - self.TestLint('int a = int();', '') # constructor - self.TestLint('X::X() : a(int()) {}', '') # default constructor - self.TestLint('operator bool();', '') # Conversion operator - self.TestLint('new int64_t(123);', '') # "new" operator on basic type - self.TestLint('new int64_t(123);', '') # "new" operator on basic type - self.TestLint('new const int(42);', '') # "new" on const-qualified type - self.TestLint('using a = bool(int arg);', '') # C++11 alias-declaration - self.TestLint('x = bit_cast(y);', '') # array of array - self.TestLint('void F(const char(&src)[N]);', '') # array of references - - # Placement new - self.TestLint( - 'new(field_ptr) int(field->default_value_enum()->number());', - '') - - # C++11 function wrappers - self.TestLint('std::function', '') - self.TestLint('std::function', '') - self.TestLint('std::function< int(bool) >', '') - self.TestLint('mfunction', '') - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'test.cc', 'cc', - ['// Copyright 2014 Your Company. All Rights Reserved.', - 'typedef std::function<', - ' bool(int)> F;', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - - # Return types for function pointers - self.TestLint('typedef bool(FunctionPointer)();', '') - self.TestLint('typedef bool(FunctionPointer)(int param);', '') - self.TestLint('typedef bool(MyClass::*MemberFunctionPointer)();', '') - self.TestLint('typedef bool(MyClass::* MemberFunctionPointer)();', '') - self.TestLint('typedef bool(MyClass::*MemberFunctionPointer)() const;', '') - self.TestLint('void Function(bool(FunctionPointerArg)());', '') - self.TestLint('void Function(bool(FunctionPointerArg)()) {}', '') - self.TestLint('typedef set SortedIdSet', '') - self.TestLint( - 'bool TraverseNode(T *Node, bool(VisitorBase:: *traverse) (T *t)) {}', - '') - - # The second parameter to a gMock method definition is a function signature - # that often looks like a bad cast but should not picked up by lint. - def testMockMethod(self): - self.TestLint( - 'MOCK_METHOD0(method, int());', - '') - self.TestLint( - 'MOCK_CONST_METHOD1(method, float(string));', - '') - self.TestLint( - 'MOCK_CONST_METHOD2_T(method, double(float, float));', - '') - self.TestLint( - 'MOCK_CONST_METHOD1(method, SomeType(int));', - '') - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('mock.cc', 'cc', - ['MOCK_METHOD1(method1,', - ' bool(int));', - 'MOCK_METHOD1(', - ' method2,', - ' bool(int));', - 'MOCK_CONST_METHOD2(', - ' method3, bool(int,', - ' int));', - 'MOCK_METHOD1(method4, int(bool));', - 'const int kConstant = int(42);'], # true positive - error_collector) - self.assertEqual( - 0, - error_collector.Results().count( - ('Using deprecated casting style. ' - 'Use static_cast(...) instead ' - '[readability/casting] [4]'))) - self.assertEqual( - 1, - error_collector.Results().count( - ('Using deprecated casting style. ' - 'Use static_cast(...) instead ' - '[readability/casting] [4]'))) - - # Like gMock method definitions, MockCallback instantiations look very similar - # to bad casts. - def testMockCallback(self): - self.TestLint( - 'MockCallback', - '') - self.TestLint( - 'MockCallback', - '') - - # Test false errors that happened with some include file names - def testIncludeFilenameFalseError(self): - self.TestLint( - '#include "foo/long-foo.h"', - '') - self.TestLint( - '#include "foo/sprintf.h"', - '') - - # Test typedef cases. There was a bug that cpplint misidentified - # typedef for pointer to function as C-style cast and produced - # false-positive error messages. - def testTypedefForPointerToFunction(self): - self.TestLint( - 'typedef void (*Func)(int x);', - '') - self.TestLint( - 'typedef void (*Func)(int *x);', - '') - self.TestLint( - 'typedef void Func(int x);', - '') - self.TestLint( - 'typedef void Func(int *x);', - '') - - def testIncludeWhatYouUseNoImplementationFiles(self): - code = 'std::vector foo;' - for extension in ['h', 'hpp', 'hxx', 'h++', 'cuh', - 'c', 'cc', 'cpp', 'cxx', 'c++', 'cu']: - self.assertEqual('Add #include for vector<>' - ' [build/include_what_you_use] [4]', - self.PerformIncludeWhatYouUse(code, 'foo.' + extension)) - - def testIncludeWhatYouUse(self): - self.TestIncludeWhatYouUse( - """#include + "", + ) + + # Test taking address of casts (runtime/casting) + def testRuntimeCasting(self): + error_msg = ( + "Are you taking an address of a cast? " + "This is dangerous: could be a temp var. " + "Take the address before doing the cast, rather than after" + " [runtime/casting] [4]" + ) + self.TestLint("int* x = &static_cast(foo);", error_msg) + self.TestLint("int* x = &reinterpret_cast(foo);", error_msg) + self.TestLint( + "int* x = &(int*)foo;", + [ + "Using C-style cast. Use reinterpret_cast(...) " + "instead [readability/casting] [4]", + error_msg, + ], + ) + self.TestLint("BudgetBuckets&(BudgetWinHistory::*BucketFn)(void) const;", "") + self.TestLint("&(*func_ptr)(arg)", "") + self.TestLint("Compute(arg, &(*func_ptr)(i, j));", "") + + # Alternative error message + alt_error_msg = ( + "Are you taking an address of something dereferenced " + "from a cast? Wrapping the dereferenced expression in " + "parentheses will make the binding more obvious" + " [readability/casting] [4]" + ) + self.TestLint("int* x = &down_cast(obj)->member_;", alt_error_msg) + self.TestLint("int* x = &down_cast(obj)[index];", alt_error_msg) + self.TestLint("int* x = &(down_cast(obj)->member_);", "") + self.TestLint("int* x = &(down_cast(obj)[index]);", "") + self.TestLint("int* x = &down_cast(obj)\n->member_;", alt_error_msg) + self.TestLint("int* x = &(down_cast(obj)\n->member_);", "") + + # It's OK to cast an address. + self.TestLint("int* x = reinterpret_cast(&foo);", "") + + # Function pointers returning references should not be confused + # with taking address of old-style casts. + self.TestLint("auto x = implicit_cast(&foo);", "") + + def testRuntimeSelfinit(self): + self.TestLint( + "Foo::Foo(Bar r, Bel l) : r_(r_), l_(l_) { }", + "You seem to be initializing a member variable with itself. [runtime/init] [4]", + ) + self.TestLint( + "Foo::Foo(Bar r, Bel l) : r_(CHECK_NOTNULL(r_)) { }", + "You seem to be initializing a member variable with itself. [runtime/init] [4]", + ) + self.TestLint("Foo::Foo(Bar r, Bel l) : r_(r), l_(l) { }", "") + self.TestLint("Foo::Foo(Bar r) : r_(r), l_(r_), ll_(l_) { }", "") + + # Test for unnamed arguments in a method. + def testCheckForUnnamedParams(self): + self.TestLint("virtual void Func(int*) const;", "") + self.TestLint("virtual void Func(int*);", "") + self.TestLint("void Method(char*) {", "") + self.TestLint("void Method(char*);", "") + self.TestLint("static void operator delete[](void*) throw();", "") + self.TestLint("int Method(int);", "") + + self.TestLint("virtual void Func(int* p);", "") + self.TestLint("void operator delete(void* x) throw();", "") + self.TestLint("void Method(char* x) {", "") + self.TestLint("void Method(char* /*x*/) {", "") + self.TestLint("void Method(char* x);", "") + self.TestLint("typedef void (*Method)(int32_t x);", "") + self.TestLint("static void operator delete[](void* x) throw();", "") + self.TestLint("static void operator delete[](void* /*x*/) throw();", "") + + self.TestLint("X operator++(int);", "") + self.TestLint("X operator++(int) {", "") + self.TestLint("X operator--(int);", "") + self.TestLint("X operator--(int /*unused*/) {", "") + self.TestLint("MACRO(int);", "") + self.TestLint("MACRO(func(int));", "") + self.TestLint("MACRO(arg, func(int));", "") + + self.TestLint("void (*func)(void*);", "") + self.TestLint("void Func((*func)(void*)) {}", "") + self.TestLint("template void func();", "") + self.TestLint("virtual void f(int /*unused*/) {", "") + self.TestLint("void f(int /*unused*/) override {", "") + self.TestLint("void f(int /*unused*/) final {", "") + + # Test deprecated casts such as int(d) + def testDeprecatedCast(self): + self.TestLint( + "int a = int(2.2);", + "Using deprecated casting style. " + "Use static_cast(...) instead" + " [readability/casting] [4]", + ) + + self.TestLint( + '(char *) "foo"', + "Using C-style cast. Use const_cast(...) instead [readability/casting] [4]", + ) + + self.TestLint( + "(int*)foo", + "Using C-style cast. " + "Use reinterpret_cast(...) instead" + " [readability/casting] [4]", + ) + + # Checks for false positives... + self.TestLint("int a = int();", "") # constructor + self.TestLint("X::X() : a(int()) {}", "") # default constructor + self.TestLint("operator bool();", "") # Conversion operator + self.TestLint("new int64_t(123);", "") # "new" operator on basic type + self.TestLint("new int64_t(123);", "") # "new" operator on basic type + self.TestLint("new const int(42);", "") # "new" on const-qualified type + self.TestLint("using a = bool(int arg);", "") # C++11 alias-declaration + self.TestLint("x = bit_cast(y);", "") # array of array + self.TestLint("void F(const char(&src)[N]);", "") # array of references + + # Placement new + self.TestLint("new(field_ptr) int(field->default_value_enum()->number());", "") + + # C++11 function wrappers + self.TestLint("std::function", "") + self.TestLint("std::function", "") + self.TestLint("std::function< int(bool) >", "") + self.TestLint("mfunction", "") + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "test.cc", + "cc", + [ + "// Copyright 2014 Your Company. All Rights Reserved.", + "typedef std::function<", + " bool(int)> F;", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + + # Return types for function pointers + self.TestLint("typedef bool(FunctionPointer)();", "") + self.TestLint("typedef bool(FunctionPointer)(int param);", "") + self.TestLint("typedef bool(MyClass::*MemberFunctionPointer)();", "") + self.TestLint("typedef bool(MyClass::* MemberFunctionPointer)();", "") + self.TestLint("typedef bool(MyClass::*MemberFunctionPointer)() const;", "") + self.TestLint("void Function(bool(FunctionPointerArg)());", "") + self.TestLint("void Function(bool(FunctionPointerArg)()) {}", "") + self.TestLint("typedef set SortedIdSet", "") + self.TestLint("bool TraverseNode(T *Node, bool(VisitorBase:: *traverse) (T *t)) {}", "") + + # The second parameter to a gMock method definition is a function signature + # that often looks like a bad cast but should not picked up by lint. + def testMockMethod(self): + self.TestLint("MOCK_METHOD0(method, int());", "") + self.TestLint("MOCK_CONST_METHOD1(method, float(string));", "") + self.TestLint("MOCK_CONST_METHOD2_T(method, double(float, float));", "") + self.TestLint("MOCK_CONST_METHOD1(method, SomeType(int));", "") + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "mock.cc", + "cc", + [ + "MOCK_METHOD1(method1,", + " bool(int));", + "MOCK_METHOD1(", + " method2,", + " bool(int));", + "MOCK_CONST_METHOD2(", + " method3, bool(int,", + " int));", + "MOCK_METHOD1(method4, int(bool));", + "const int kConstant = int(42);", + ], # true positive + error_collector, + ) + assert ( + error_collector.Results().count( + "Using deprecated casting style. Use static_cast(...) instead " + "[readability/casting] [4]" + ) + == 0 + ) + assert ( + error_collector.Results().count( + "Using deprecated casting style. Use static_cast(...) instead " + "[readability/casting] [4]" + ) + == 1 + ) + + # Like gMock method definitions, MockCallback instantiations look very similar + # to bad casts. + def testMockCallback(self): + self.TestLint("MockCallback", "") + self.TestLint("MockCallback", "") + + # Test false errors that happened with some include file names + def testIncludeFilenameFalseError(self): + self.TestLint('#include "foo/long-foo.h"', "") + self.TestLint('#include "foo/sprintf.h"', "") + + # Test typedef cases. There was a bug that cpplint misidentified + # typedef for pointer to function as C-style cast and produced + # false-positive error messages. + def testTypedefForPointerToFunction(self): + self.TestLint("typedef void (*Func)(int x);", "") + self.TestLint("typedef void (*Func)(int *x);", "") + self.TestLint("typedef void Func(int x);", "") + self.TestLint("typedef void Func(int *x);", "") + + def testIncludeWhatYouUseNoImplementationFiles(self): + code = "std::vector foo;" + for extension in ["h", "hpp", "hxx", "h++", "cuh", "c", "cc", "cpp", "cxx", "c++", "cu"]: + assert ( + self.PerformIncludeWhatYouUse(code, "foo." + extension) + == "Add #include for vector<> [build/include_what_you_use] [4]" + ) + + def testIncludeWhatYouUse(self): + self.TestIncludeWhatYouUse( + """#include std::vector foo; """, - '') - self.TestIncludeWhatYouUse( - """#include + "", + ) + self.TestIncludeWhatYouUse( + """#include std::pair foo; """, - 'Add #include for pair<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for pair<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include std::pair foo; """, - 'Add #include for pair<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for pair<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include std::pair foo; """, - 'Add #include for pair<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for pair<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include auto foo = std::make_pair(1, 2); """, - 'Add #include for make_pair' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for make_pair [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include std::pair foo; """, - '') - self.TestIncludeWhatYouUse( - """#include + "", + ) + self.TestIncludeWhatYouUse( + """#include DECLARE_string(foobar); """, - '') - self.TestIncludeWhatYouUse( - """#include + "", + ) + self.TestIncludeWhatYouUse( + """#include DEFINE_string(foobar, "", ""); """, - '') - self.TestIncludeWhatYouUse( - """#include + "", + ) + self.TestIncludeWhatYouUse( + """#include std::pair foo; """, - 'Add #include for pair<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include "base/foobar.h" + "Add #include for pair<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include "base/foobar.h" std::vector foo; """, - 'Add #include for vector<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for vector<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include std::set foo; """, - 'Add #include for set<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include "base/foobar.h" + "Add #include for set<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include "base/foobar.h" hash_map foobar; """, - 'Add #include for hash_map<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include "base/containers/hash_tables.h" + "Add #include for hash_map<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include "base/containers/hash_tables.h" base::hash_map foobar; """, - '') - self.TestIncludeWhatYouUse( - """#include "base/foobar.h" + "", + ) + self.TestIncludeWhatYouUse( + """#include "base/foobar.h" bool foobar = std::less(0,1); """, - 'Add #include for less<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include "base/foobar.h" + "Add #include for less<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include "base/foobar.h" bool foobar = min(0,1); """, - 'Add #include for min [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - 'cout << "hello world" << endl;', - 'Add #include for cout [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - 'printf("hello world");', - 'Add #include for printf [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - 'void a(const string &foobar);', - 'Add #include for string [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - 'void a(const std::string &foobar);', - 'Add #include for string [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - 'void a(const my::string &foobar);', - '') # Avoid false positives on strings in other namespaces. - self.TestIncludeWhatYouUse( - """#include "base/foobar.h" + "Add #include for min [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + 'cout << "hello world" << endl;', + "Add #include for cout [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + 'printf("hello world");', + "Add #include for printf [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include + printf("hello world");""", + "", + ) # Avoid false positives w/ c-style include + self.TestIncludeWhatYouUse( + "void a(const string &foobar);", + "Add #include for string [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + "void a(const std::string &foobar);", + "Add #include for string [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + "void a(const my::string &foobar);", "" + ) # Avoid false positives on strings in other namespaces. + self.TestIncludeWhatYouUse( + """#include "base/foobar.h" bool foobar = swap(0,1); """, - 'Add #include for swap [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include "base/foobar.h" + "Add #include for swap [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include "base/foobar.h" bool foobar = transform(a.begin(), a.end(), b.start(), Foo); """, - 'Add #include for transform ' - '[build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include "base/foobar.h" + "Add #include for transform [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include "base/foobar.h" boost::range::transform(input, std::back_inserter(output), square); """, - '') # Avoid false positives on transform in other namespaces. - self.TestIncludeWhatYouUse( - """#include "base/foobar.h" + "", + ) # Avoid false positives on transform in other namespaces. + self.TestIncludeWhatYouUse( + """#include "base/foobar.h" bool foobar = std::min_element(a.begin(), a.end()); """, - 'Add #include for min_element ' - '[build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """foo->swap(0,1); + "Add #include for min_element [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """foo->swap(0,1); foo.swap(0,1); """, - '') - self.TestIncludeWhatYouUse( - """#include + "", + ) + self.TestIncludeWhatYouUse( + """#include void a(const std::multimap &foobar); """, - 'Add #include for multimap<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for multimap<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include void a(const std::unordered_map &foobar); """, - 'Add #include for unordered_map<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for unordered_map<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include void a(const std::unordered_set &foobar); """, - 'Add #include for unordered_set<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for unordered_set<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include void a(const std::priority_queue &foobar); """, - '') - self.TestIncludeWhatYouUse( - """#include + "", + ) + self.TestIncludeWhatYouUse( + """#include #include #include #include "base/basictypes.h" #include "base/port.h" - vector hajoa;""", '') - self.TestIncludeWhatYouUse( - """#include + vector hajoa;""", + "", + ) + self.TestIncludeWhatYouUse( + """#include int i = numeric_limits::max() """, - 'Add #include for numeric_limits<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for numeric_limits<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include int i = numeric_limits::max() """, - '') - self.TestIncludeWhatYouUse( - """#include + "", + ) + self.TestIncludeWhatYouUse( + """#include std::unique_ptr x; """, - 'Add #include for unique_ptr<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for unique_ptr<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include auto x = std::make_unique(0); """, - 'Add #include for make_unique<>' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for make_unique<> [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include vector foo(vector x) { return std::move(x); } """, - 'Add #include for move' - ' [build/include_what_you_use] [4]') - self.TestIncludeWhatYouUse( - """#include + "Add #include for move [build/include_what_you_use] [4]", + ) + self.TestIncludeWhatYouUse( + """#include int a, b; std::swap(a, b); """, - 'Add #include for swap' - ' [build/include_what_you_use] [4]') - # False positive for std::set - self.TestIncludeWhatYouUse( - """ + "Add #include for swap [build/include_what_you_use] [4]", + ) + # False positive for std::set + self.TestIncludeWhatYouUse( + """ #include struct Foo { template @@ -1236,10 +1318,11 @@ def testIncludeWhatYouUse(self): Foo* pbar = &bar; bar.set("int", 5); pbar->set("bool", false);""", - '') - # False positive for std::map - self.TestIncludeWhatYouUse( - """ + "", + ) + # False positive for std::map + self.TestIncludeWhatYouUse( + """ template struct Foo { T t; @@ -1252,105 +1335,100 @@ def testIncludeWhatYouUse(self): }; auto res = map(); """, - '') - # False positive for boost::container::set - self.TestIncludeWhatYouUse( - """ + "", + ) + # False positive for boost::container::set + self.TestIncludeWhatYouUse( + """ boost::container::set foo; """, - '') - - def testFilesBelongToSameModule(self): - f = cpplint.FilesBelongToSameModule - self.assertEqual((True, ''), f('a.cc', 'a.h')) - self.assertEqual((True, ''), f('base/google.cc', 'base/google.h')) - self.assertEqual((True, ''), f('base/google_test.c', 'base/google.h')) - self.assertEqual((True, ''), f('base/google_test.cc', 'base/google.h')) - self.assertEqual((True, ''), f('base/google_test.cc', 'base/google.hpp')) - self.assertEqual((True, ''), f('base/google_test.cxx', 'base/google.hxx')) - self.assertEqual((True, ''), f('base/google_test.cpp', 'base/google.hpp')) - self.assertEqual((True, ''), f('base/google_test.c++', 'base/google.h++')) - self.assertEqual((True, ''), f('base/google_test.cu', 'base/google.cuh')) - self.assertEqual((True, ''), - f('base/google_unittest.cc', 'base/google.h')) - self.assertEqual((True, ''), - f('base/internal/google_unittest.cc', - 'base/public/google.h')) - self.assertEqual((True, 'xxx/yyy/'), - f('xxx/yyy/base/internal/google_unittest.cc', - 'base/public/google.h')) - self.assertEqual((True, 'xxx/yyy/'), - f('xxx/yyy/base/google_unittest.cc', - 'base/public/google.h')) - self.assertEqual((True, ''), - f('base/google_unittest.cc', 'base/google-inl.h')) - self.assertEqual((True, '/home/build/google3/'), - f('/home/build/google3/base/google.cc', 'base/google.h')) - - self.assertEqual((False, ''), - f('/home/build/google3/base/google.cc', 'basu/google.h')) - self.assertEqual((False, ''), f('a.cc', 'b.h')) - - def testCleanseLine(self): - self.assertEqual('int foo = 0;', - cpplint.CleanseComments('int foo = 0; // danger!')) - self.assertEqual('int o = 0;', - cpplint.CleanseComments('int /* foo */ o = 0;')) - self.assertEqual('foo(int a, int b);', - cpplint.CleanseComments('foo(int a /* abc */, int b);')) - self.assertEqual('f(a, b);', - cpplint.CleanseComments('f(a, /* name */ b);')) - self.assertEqual('f(a, b);', - cpplint.CleanseComments('f(a /* name */, b);')) - self.assertEqual('f(a, b);', - cpplint.CleanseComments('f(a, /* name */b);')) - self.assertEqual('f(a, b, c);', - cpplint.CleanseComments('f(a, /**/b, /**/c);')) - self.assertEqual('f(a, b, c);', - cpplint.CleanseComments('f(a, /**/b/**/, c);')) - - def testRawStrings(self): - self.TestMultiLineLint( - """ + "", + ) + + def testFilesBelongToSameModule(self): + f = cpplint.FilesBelongToSameModule + assert f("a.cc", "a.h") == (True, "") + assert f("base/google.cc", "base/google.h") == (True, "") + assert f("base/google_test.c", "base/google.h") == (True, "") + assert f("base/google_test.cc", "base/google.h") == (True, "") + assert f("base/google_test.cc", "base/google.hpp") == (True, "") + assert f("base/google_test.cxx", "base/google.hxx") == (True, "") + assert f("base/google_test.cpp", "base/google.hpp") == (True, "") + assert f("base/google_test.c++", "base/google.h++") == (True, "") + assert f("base/google_test.cu", "base/google.cuh") == (True, "") + assert f("base/google_unittest.cc", "base/google.h") == (True, "") + assert f("base/internal/google_unittest.cc", "base/public/google.h") == (True, "") + assert f("xxx/yyy/base/internal/google_unittest.cc", "base/public/google.h") == ( + True, + "xxx/yyy/", + ) + assert f("xxx/yyy/base/google_unittest.cc", "base/public/google.h") == (True, "xxx/yyy/") + assert f("base/google_unittest.cc", "base/google-inl.h") == (True, "") + assert f("/home/build/google3/base/google.cc", "base/google.h") == ( + True, + "/home/build/google3/", + ) + + assert f("/home/build/google3/base/google.cc", "basu/google.h") == (False, "") + assert f("a.cc", "b.h") == (False, "") + + def testCleanseLine(self): + assert cpplint.CleanseComments("int foo = 0; // danger!") == "int foo = 0;" + assert cpplint.CleanseComments("int /* foo */ o = 0;") == "int o = 0;" + assert cpplint.CleanseComments("foo(int a /* abc */, int b);") == "foo(int a, int b);" + assert cpplint.CleanseComments("f(a, /* name */ b);") == "f(a, b);" + assert cpplint.CleanseComments("f(a /* name */, b);") == "f(a, b);" + assert cpplint.CleanseComments("f(a, /* name */b);") == "f(a, b);" + assert cpplint.CleanseComments("f(a, /**/b, /**/c);") == "f(a, b, c);" + assert cpplint.CleanseComments("f(a, /**/b/**/, c);") == "f(a, b, c);" + + def testRawStrings(self): + self.TestMultiLineLint( + """ int main() { struct A { A(std::string s, A&& a); }; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ template > class unique_ptr { public: unique_ptr(unique_ptr&& u) noexcept; };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ void Func() { static const char kString[] = R"( #endif <- invalid preprocessor should be ignored */ <- invalid comment should be ignored too )"; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ void Func() { string s = R"TrueDelimiter( )" )FalseDelimiter" )TrueDelimiter"; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ void Func() { char char kString[] = R"( ";" )"; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ static const char kRawString[] = R"( \tstatic const int kLineWithTab = 1; static const int kLineWithTrailingWhiteSpace = 1;\x20 @@ -1367,9 +1445,10 @@ def testRawStrings(self): } )";""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ void Func() { string s = StrCat(R"TrueDelimiter( )" @@ -1379,984 +1458,1107 @@ def testRawStrings(self): )FalseDelimiter2" )TrueDelimiter2"); }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ static SomeStruct kData = { {0, R"(line1 line2 )"} };""", - '') + "", + ) - def testMultiLineComments(self): - # missing explicit is bad - self.TestMultiLineLint( - r"""int a = 0; + def testMultiLineComments(self): + # missing explicit is bad + self.TestMultiLineLint( + r"""int a = 0; /* multi-liner class Foo { Foo(int f); // should cause a lint warning in code } */ """, - '') - self.TestMultiLineLint( - r"""/* int a = 0; multi-liner + "", + ) + self.TestMultiLineLint( + r"""/* int a = 0; multi-liner static const int b = 0;""", - 'Could not find end of multi-line comment' - ' [readability/multiline_comment] [5]') - self.TestMultiLineLint(r""" /* multi-line comment""", - 'Could not find end of multi-line comment' - ' [readability/multiline_comment] [5]') - self.TestMultiLineLint(r""" // /* comment, but not multi-line""", '') - self.TestMultiLineLint(r"""/********** - */""", '') - self.TestMultiLineLint(r"""/** + "Could not find end of multi-line comment [readability/multiline_comment] [5]", + ) + self.TestMultiLineLint( + r""" /* multi-line comment""", + "Could not find end of multi-line comment [readability/multiline_comment] [5]", + ) + self.TestMultiLineLint(r""" // /* comment, but not multi-line""", "") + self.TestMultiLineLint( + r"""/********** + */""", + "", + ) + self.TestMultiLineLint( + r"""/** * Doxygen comment */""", - '') - self.TestMultiLineLint(r"""/*! + "", + ) + self.TestMultiLineLint( + r"""/*! * Doxygen comment */""", - '') - - def testMultilineStrings(self): - multiline_string_error_message = ( - 'Multi-line string ("...") found. This lint script doesn\'t ' - 'do well with such strings, and may give bogus warnings. ' - 'Use C++11 raw strings or concatenation instead.' - ' [readability/multiline_string] [5]') - - for extension in ['c', 'cc', 'cpp', 'cxx', 'c++', 'cu']: - file_path = 'mydir/foo.' + extension - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, extension, - ['const char* str = "This is a\\', - ' multiline string.";'], - error_collector) - self.assertEqual( - 2, # One per line. - error_collector.ResultList().count(multiline_string_error_message)) - - # Test non-explicit single-argument constructors - def testExplicitSingleArgumentConstructors(self): - old_verbose_level = cpplint._cpplint_state.verbose_level - cpplint._cpplint_state.verbose_level = 0 - - try: - # missing explicit is bad - self.TestMultiLineLint( - """ + "", + ) + + def testMultilineStrings(self): + multiline_string_error_message = ( + 'Multi-line string ("...") found. This lint script doesn\'t ' + "do well with such strings, and may give bogus warnings. " + "Use C++11 raw strings or concatenation instead." + " [readability/multiline_string] [5]" + ) + + for extension in ["c", "cc", "cpp", "cxx", "c++", "cu"]: + file_path = "mydir/foo." + extension + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + file_path, + extension, + ['const char* str = "This is a\\', ' multiline string.";'], + error_collector, + ) + # One per line. + assert error_collector.ResultList().count(multiline_string_error_message) == 2 + + # Test non-explicit single-argument constructors + def testExplicitSingleArgumentConstructors(self): + old_verbose_level = cpplint._cpplint_state.verbose_level + cpplint._cpplint_state.verbose_level = 0 + + try: + # missing explicit is bad + self.TestMultiLineLint( + """ class Foo { Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # missing explicit is bad, even with whitespace - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # missing explicit is bad, even with whitespace + self.TestMultiLineLint( + """ class Foo { Foo (int f); };""", - ['Extra space before ( in function call [whitespace/parens] [4]', - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]']) - # missing explicit, with distracting comment, is still bad - self.TestMultiLineLint( - """ + [ + "Extra space before ( in function call [whitespace/parens] [4]", + "Single-parameter constructors should be marked explicit." + " [runtime/explicit] [4]", + ], + ) + # missing explicit, with distracting comment, is still bad + self.TestMultiLineLint( + """ class Foo { Foo(int f); // simpler than Foo(blargh, blarg) };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # missing explicit, with qualified classname - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # missing explicit, with qualified classname + self.TestMultiLineLint( + """ class Qualifier::AnotherOne::Foo { Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # missing explicit for inline constructors is bad as well - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # missing explicit for inline constructors is bad as well + self.TestMultiLineLint( + """ class Foo { inline Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # missing explicit for constexpr constructors is bad as well - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # missing explicit for constexpr constructors is bad as well + self.TestMultiLineLint( + """ class Foo { constexpr Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # missing explicit for constexpr+inline constructors is bad as well - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # missing explicit for constexpr+inline constructors is bad as well + self.TestMultiLineLint( + """ class Foo { constexpr inline Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + self.TestMultiLineLint( + """ class Foo { inline constexpr Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # explicit with inline is accepted - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # explicit with inline is accepted + self.TestMultiLineLint( + """ class Foo { inline explicit Foo(int f); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { explicit inline Foo(int f); };""", - '') - # explicit with constexpr is accepted - self.TestMultiLineLint( - """ + "", + ) + # explicit with constexpr is accepted + self.TestMultiLineLint( + """ class Foo { constexpr explicit Foo(int f); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { explicit constexpr Foo(int f); };""", - '') - # explicit with constexpr+inline is accepted - self.TestMultiLineLint( - """ + "", + ) + # explicit with constexpr+inline is accepted + self.TestMultiLineLint( + """ class Foo { inline constexpr explicit Foo(int f); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { explicit inline constexpr Foo(int f); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { constexpr inline explicit Foo(int f); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { explicit constexpr inline Foo(int f); };""", - '') - # structs are caught as well. - self.TestMultiLineLint( - """ + "", + ) + # structs are caught as well. + self.TestMultiLineLint( + """ struct Foo { Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # Templatized classes are caught as well. - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # Templatized classes are caught as well. + self.TestMultiLineLint( + """ template class Foo { Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # inline case for templatized classes. - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # inline case for templatized classes. + self.TestMultiLineLint( + """ template class Foo { inline Foo(int f); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # constructors with a default argument should still be marked explicit - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # constructors with a default argument should still be marked explicit + self.TestMultiLineLint( + """ class Foo { Foo(int f = 0); };""", - 'Constructors callable with one argument should be marked explicit.' - ' [runtime/explicit] [4]') - # multi-argument constructors with all but one default argument should be - # marked explicit - self.TestMultiLineLint( - """ + "Constructors callable with one argument should be marked explicit." + " [runtime/explicit] [4]", + ) + # multi-argument constructors with all but one default argument should be + # marked explicit + self.TestMultiLineLint( + """ class Foo { Foo(int f, int g = 0); };""", - 'Constructors callable with one argument should be marked explicit.' - ' [runtime/explicit] [4]') - # multi-argument constructors with all default arguments should be marked - # explicit - self.TestMultiLineLint( - """ + "Constructors callable with one argument should be marked explicit." + " [runtime/explicit] [4]", + ) + # multi-argument constructors with all default arguments should be marked + # explicit + self.TestMultiLineLint( + """ class Foo { Foo(int f = 0, int g = 0); };""", - 'Constructors callable with one argument should be marked explicit.' - ' [runtime/explicit] [4]') - # explicit no-argument constructors are just fine - self.TestMultiLineLint( - """ + "Constructors callable with one argument should be marked explicit." + " [runtime/explicit] [4]", + ) + # explicit no-argument constructors are just fine + self.TestMultiLineLint( + """ class Foo { explicit Foo(); };""", - '') - # void constructors are considered no-argument - self.TestMultiLineLint( - """ + "", + ) + # void constructors are considered no-argument + self.TestMultiLineLint( + """ class Foo { explicit Foo(void); };""", - '') - # No warning for multi-parameter constructors - self.TestMultiLineLint( - """ + "", + ) + # No warning for multi-parameter constructors + self.TestMultiLineLint( + """ class Foo { explicit Foo(int f, int g); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { explicit Foo(int f, int g = 0); };""", - '') - # single-argument constructors that take a function that takes multiple - # arguments should be explicit - self.TestMultiLineLint( - """ + "", + ) + # single-argument constructors that take a function that takes multiple + # arguments should be explicit + self.TestMultiLineLint( + """ class Foo { Foo(void (*f)(int f, int g)); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # single-argument constructors that take a single template argument with - # multiple parameters should be explicit - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # single-argument constructors that take a single template argument with + # multiple parameters should be explicit + self.TestMultiLineLint( + """ template class Foo { Foo(Bar b); };""", - 'Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]') - # but copy constructors that take multiple template parameters are OK - self.TestMultiLineLint( - """ + "Single-parameter constructors should be marked explicit. [runtime/explicit] [4]", + ) + # but copy constructors that take multiple template parameters are OK + self.TestMultiLineLint( + """ template class Foo { Foo(Foo& f); };""", - '') - # proper style is okay - self.TestMultiLineLint( - """ + "", + ) + # proper style is okay + self.TestMultiLineLint( + """ class Foo { explicit Foo(int f); };""", - '') - # two argument constructor is okay - self.TestMultiLineLint( - """ + "", + ) + # two argument constructor is okay + self.TestMultiLineLint( + """ class Foo { Foo(int f, int b); };""", - '') - # two argument constructor, across two lines, is okay - self.TestMultiLineLint( - """ + "", + ) + # two argument constructor, across two lines, is okay + self.TestMultiLineLint( + """ class Foo { Foo(int f, int b); };""", - '') - # non-constructor (but similar name), is okay - self.TestMultiLineLint( - """ + "", + ) + # non-constructor (but similar name), is okay + self.TestMultiLineLint( + """ class Foo { aFoo(int f); };""", - '') - # constructor with void argument is okay - self.TestMultiLineLint( - """ + "", + ) + # constructor with void argument is okay + self.TestMultiLineLint( + """ class Foo { Foo(void); };""", - '') - # single argument method is okay - self.TestMultiLineLint( - """ + "", + ) + # single argument method is okay + self.TestMultiLineLint( + """ class Foo { Bar(int b); };""", - '') - # comments should be ignored - self.TestMultiLineLint( - """ + "", + ) + # comments should be ignored + self.TestMultiLineLint( + """ class Foo { // Foo(int f); };""", - '') - # single argument function following class definition is okay - # (okay, it's not actually valid, but we don't want a false positive) - self.TestMultiLineLint( - """ + "", + ) + # single argument function following class definition is okay + # (okay, it's not actually valid, but we don't want a false positive) + self.TestMultiLineLint( + """ class Foo { Foo(int f, int b); }; Foo(int f);""", - '') - # single argument function is okay - self.TestMultiLineLint( - """static Foo(int f);""", - '') - # single argument copy constructor is okay. - self.TestMultiLineLint( - """ + "", + ) + # single argument function is okay + self.TestMultiLineLint("""static Foo(int f);""", "") + # single argument copy constructor is okay. + self.TestMultiLineLint( + """ class Foo { Foo(const Foo&); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { Foo(volatile Foo&); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { Foo(volatile const Foo&); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { Foo(const volatile Foo&); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { Foo(Foo const&); };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo { Foo(Foo&); };""", - '') - # templatized copy constructor is okay. - self.TestMultiLineLint( - """ + "", + ) + # templatized copy constructor is okay. + self.TestMultiLineLint( + """ template class Foo { Foo(const Foo&); };""", - '') - # Special case for std::initializer_list - self.TestMultiLineLint( - """ + "", + ) + # Special case for std::initializer_list + self.TestMultiLineLint( + """ class Foo { Foo(std::initializer_list &arg) {} };""", - '') - # Special case for variadic arguments - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['class Foo {', - ' template', - ' explicit Foo(const int arg, Args&&... args) {}', - '};'], - error_collector) - self.assertEqual(0, error_collector.ResultList().count( - 'Constructors that require multiple arguments should not be marked ' - 'explicit. [runtime/explicit] [0]')) - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['class Foo {', - ' template', - ' explicit Foo(Args&&... args) {}', - '};'], - error_collector) - self.assertEqual(0, error_collector.ResultList().count( - 'Constructors that require multiple arguments should not be marked ' - 'explicit. [runtime/explicit] [0]')) - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['class Foo {', - ' template', - ' Foo(const int arg, Args&&... args) {}', - '};'], - error_collector) - self.assertEqual(1, error_collector.ResultList().count( - 'Constructors callable with one argument should be marked explicit.' - ' [runtime/explicit] [4]')) - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['class Foo {', - ' template', - ' Foo(Args&&... args) {}', - '};'], - error_collector) - self.assertEqual(1, error_collector.ResultList().count( - 'Constructors callable with one argument should be marked explicit.' - ' [runtime/explicit] [4]')) - # Anything goes inside an assembly block - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['void Func() {', - ' __asm__ (', - ' "hlt"', - ' );', - ' asm {', - ' movdqa [edx + 32], xmm2', - ' }', - '}'], - error_collector) - self.assertEqual( - 0, - error_collector.ResultList().count( - 'Extra space before ( in function call [whitespace/parens] [4]')) - self.assertEqual( - 0, - error_collector.ResultList().count( - 'Closing ) should be moved to the previous line ' - '[whitespace/parens] [2]')) - self.assertEqual( - 0, - error_collector.ResultList().count( - 'Extra space before [ [whitespace/braces] [5]')) - finally: - cpplint._cpplint_state.verbose_level = old_verbose_level - - def testSlashStarCommentOnSingleLine(self): - self.TestMultiLineLint( - """/* static */ Foo(int f);""", - '') - self.TestMultiLineLint( - """/*/ static */ Foo(int f);""", - '') - self.TestMultiLineLint( - """/*/ static Foo(int f);""", - 'Could not find end of multi-line comment' - ' [readability/multiline_comment] [5]') - self.TestMultiLineLint( - """ /*/ static Foo(int f);""", - 'Could not find end of multi-line comment' - ' [readability/multiline_comment] [5]') - self.TestMultiLineLint( - """ /**/ static Foo(int f);""", - '') - - # Test suspicious usage of "if" like this: - # if (a == b) { - # DoSomething(); - # } if (a == c) { // Should be "else if". - # DoSomething(); // This gets called twice if a == b && a == c. - # } - def testSuspiciousUsageOfIf(self): - self.TestLint( - ' if (a == b) {', - '') - self.TestLint( - ' } if (a == b) {', - 'Did you mean "else if"? If not, start a new line for "if".' - ' [readability/braces] [4]') - - # Test suspicious usage of memset. Specifically, a 0 - # as the final argument is almost certainly an error. - def testSuspiciousUsageOfMemset(self): - # Normal use is okay. - self.TestLint( - ' memset(buf, 0, sizeof(buf))', - '') - - # A 0 as the final argument is almost certainly an error. - self.TestLint( - ' memset(buf, sizeof(buf), 0)', - 'Did you mean "memset(buf, 0, sizeof(buf))"?' - ' [runtime/memset] [4]') - self.TestLint( - ' memset(buf, xsize * ysize, 0)', - 'Did you mean "memset(buf, 0, xsize * ysize)"?' - ' [runtime/memset] [4]') - - # There is legitimate test code that uses this form. - # This is okay since the second argument is a literal. - self.TestLint( - " memset(buf, 'y', 0)", - '') - self.TestLint( - ' memset(buf, 4, 0)', - '') - self.TestLint( - ' memset(buf, -1, 0)', - '') - self.TestLint( - ' memset(buf, 0xF1, 0)', - '') - self.TestLint( - ' memset(buf, 0xcd, 0)', - '') - - def testRedundantVirtual(self): - self.TestLint('virtual void F()', '') - self.TestLint('virtual void F();', '') - self.TestLint('virtual void F() {}', '') - - message_template = ('"%s" is redundant since function is already ' - 'declared as "%s" [readability/inheritance] [4]') - for virt_specifier in ['override', 'final']: - error_message = message_template % ('virtual', virt_specifier) - self.TestLint('virtual int F() %s' % virt_specifier, error_message) - self.TestLint('virtual int F() %s;' % virt_specifier, error_message) - self.TestLint('virtual int F() %s {' % virt_specifier, error_message) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company.', - 'virtual void F(int a,', - ' int b) ' + virt_specifier + ';', - 'virtual void F(int a,', - ' int b) LOCKS_EXCLUDED(lock) ' + virt_specifier + ';', - 'virtual void F(int a,', - ' int b)', - ' LOCKS_EXCLUDED(lock) ' + virt_specifier + ';', - ''], - error_collector) - self.assertEqual( - [error_message, error_message, error_message], - error_collector.Results()) - - error_message = message_template % ('override', 'final') - self.TestLint('int F() override final', error_message) - self.TestLint('int F() override final;', error_message) - self.TestLint('int F() override final {}', error_message) - self.TestLint('int F() final override', error_message) - self.TestLint('int F() final override;', error_message) - self.TestLint('int F() final override {}', error_message) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company.', - 'struct A : virtual B {', - ' ~A() override;' - '};', - 'class C', - ' : public D,', - ' public virtual E {', - ' void Func() override;', - '}', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - - self.TestLint('void Finalize(AnnotationProto *final) override;', '') - - def testCheckDeprecated(self): - self.TestLanguageRulesCheck('foo_test.cc', '#include ', '') - self.TestLanguageRulesCheck('foo_unittest.cc', '#include ', '') - - def testCheckPosixThreading(self): - self.TestLint('var = sctime_r()', '') - self.TestLint('var = strtok_r()', '') - self.TestLint('var = strtok_r(foo, ba, r)', '') - self.TestLint('var = brand()', '') - self.TestLint('_rand()', '') - self.TestLint('.rand()', '') - self.TestLint('->rand()', '') - self.TestLint('ACMRandom rand(seed)', '') - self.TestLint('ISAACRandom rand()', '') - self.TestLint('var = rand()', - 'Consider using rand_r(...) instead of rand(...)' - ' for improved thread safety.' - ' [runtime/threadsafe_fn] [2]') - self.TestLint('var = strtok(str, delim)', - 'Consider using strtok_r(...) ' - 'instead of strtok(...)' - ' for improved thread safety.' - ' [runtime/threadsafe_fn] [2]') - - def testVlogMisuse(self): - self.TestLint('VLOG(1)', '') - self.TestLint('VLOG(99)', '') - self.TestLint('LOG(ERROR)', '') - self.TestLint('LOG(INFO)', '') - self.TestLint('LOG(WARNING)', '') - self.TestLint('LOG(FATAL)', '') - self.TestLint('LOG(DFATAL)', '') - self.TestLint('VLOG(SOMETHINGWEIRD)', '') - self.TestLint('MYOWNVLOG(ERROR)', '') - errmsg = ('VLOG() should be used with numeric verbosity level. ' - 'Use LOG() if you want symbolic severity levels.' - ' [runtime/vlog] [5]') - self.TestLint('VLOG(ERROR)', errmsg) - self.TestLint('VLOG(INFO)', errmsg) - self.TestLint('VLOG(WARNING)', errmsg) - self.TestLint('VLOG(FATAL)', errmsg) - self.TestLint('VLOG(DFATAL)', errmsg) - self.TestLint(' VLOG(ERROR)', errmsg) - self.TestLint(' VLOG(INFO)', errmsg) - self.TestLint(' VLOG(WARNING)', errmsg) - self.TestLint(' VLOG(FATAL)', errmsg) - self.TestLint(' VLOG(DFATAL)', errmsg) - - # Test potential format string bugs like printf(foo). - def testFormatStrings(self): - self.TestLint('printf("foo")', '') - self.TestLint('printf("foo: %s", foo)', '') - self.TestLint('DocidForPrintf(docid)', '') # Should not trigger. - self.TestLint('printf(format, value)', '') # Should not trigger. - self.TestLint('printf(__VA_ARGS__)', '') # Should not trigger. - self.TestLint('printf(format.c_str(), value)', '') # Should not trigger. - self.TestLint('printf(format(index).c_str(), value)', '') - self.TestLint( - 'printf(foo)', - 'Potential format string bug. Do printf("%s", foo) instead.' - ' [runtime/printf] [4]') - self.TestLint( - 'printf(foo.c_str())', - 'Potential format string bug. ' - 'Do printf("%s", foo.c_str()) instead.' - ' [runtime/printf] [4]') - self.TestLint( - 'printf(foo->c_str())', - 'Potential format string bug. ' - 'Do printf("%s", foo->c_str()) instead.' - ' [runtime/printf] [4]') - self.TestLint( - 'StringPrintf(foo)', - 'Potential format string bug. Do StringPrintf("%s", foo) instead.' - '' - ' [runtime/printf] [4]') - - # Test disallowed use of operator& and other operators. - def testIllegalOperatorOverloading(self): - errmsg = ('Unary operator& is dangerous. Do not use it.' - ' [runtime/operator] [4]') - self.TestLint('void operator=(const Myclass&)', '') - self.TestLint('void operator&(int a, int b)', '') # binary operator& ok - self.TestLint('void operator&() { }', errmsg) - self.TestLint('void operator & ( ) { }', - ['Extra space after ( [whitespace/parens] [2]', errmsg]) - - # const string reference members are dangerous.. - def testConstStringReferenceMembers(self): - errmsg = ('const string& members are dangerous. It is much better to use ' - 'alternatives, such as pointers or simple constants.' - ' [runtime/member_string_references] [2]') - - members_declarations = ['const string& church', - 'const string &turing', - 'const string & godel'] - # TODO(unknown): Enable also these tests if and when we ever - # decide to check for arbitrary member references. - # "const Turing & a", - # "const Church& a", - # "const vector& a", - # "const Kurt::Godel & godel", - # "const Kazimierz::Kuratowski& kk" ] - - # The Good. - - self.TestLint('void f(const string&)', '') - self.TestLint('const string& f(const string& a, const string& b)', '') - self.TestLint('typedef const string& A;', '') - - for decl in members_declarations: - self.TestLint(decl + ' = b;', '') - self.TestLint(decl + ' =', '') - - # The Bad. - - for decl in members_declarations: - self.TestLint(decl + ';', errmsg) - - # Variable-length arrays are not permitted. - def testVariableLengthArrayDetection(self): - errmsg = ('Do not use variable-length arrays. Use an appropriately named ' - "('k' followed by CamelCase) compile-time constant for the size." - ' [runtime/arrays] [1]') - - self.TestLint('int a[any_old_variable];', errmsg) - self.TestLint('int doublesize[some_var * 2];', errmsg) - self.TestLint('int a[afunction()];', errmsg) - self.TestLint('int a[function(kMaxFooBars)];', errmsg) - self.TestLint('bool a_list[items_->size()];', errmsg) - self.TestLint('namespace::Type buffer[len+1];', errmsg) - - self.TestLint('int a[64];', '') - self.TestLint('int a[0xFF];', '') - self.TestLint('int first[256], second[256];', '') - self.TestLint('int array_name[kCompileTimeConstant];', '') - self.TestLint('char buf[somenamespace::kBufSize];', '') - self.TestLint('int array_name[ALL_CAPS];', '') - self.TestLint('AClass array1[foo::bar::ALL_CAPS];', '') - self.TestLint('int a[kMaxStrLen + 1];', '') - self.TestLint('int a[sizeof(foo)];', '') - self.TestLint('int a[sizeof(*foo)];', '') - self.TestLint('int a[sizeof foo];', '') - self.TestLint('int a[sizeof(struct Foo)];', '') - self.TestLint('int a[128 - sizeof(const bar)];', '') - self.TestLint('int a[(sizeof(foo) * 4)];', '') - self.TestLint('int a[(arraysize(fixed_size_array)/2) << 1];', '') - self.TestLint('delete a[some_var];', '') - self.TestLint('return a[some_var];', '') - - # DISALLOW_COPY_AND_ASSIGN and DISALLOW_IMPLICIT_CONSTRUCTORS should be at - # end of class if present. - def testDisallowMacrosAtEnd(self): - for macro_name in ( - 'DISALLOW_COPY_AND_ASSIGN', - 'DISALLOW_IMPLICIT_CONSTRUCTORS'): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company.', - 'class SomeClass {', - ' private:', - ' %s(SomeClass);' % macro_name, - ' int member_;', - '};', - ''], - error_collector) - self.assertEqual( - ('%s should be the last thing in the class' % macro_name) + - ' [readability/constructors] [3]', - error_collector.Results()) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company.', - 'class OuterClass {', - ' private:', - ' struct InnerClass {', - ' private:', - ' %s(InnerClass);' % macro_name, - ' int member;', - ' };', - '};', - ''], - error_collector) - self.assertEqual( - ('%s should be the last thing in the class' % macro_name) + - ' [readability/constructors] [3]', - error_collector.Results()) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company.', - 'class OuterClass1 {', - ' private:', - ' struct InnerClass1 {', - ' private:', - ' %s(InnerClass1);' % macro_name, - ' };', - ' %s(OuterClass1);' % macro_name, - '};', - 'struct OuterClass2 {', - ' private:', - ' class InnerClass2 {', - ' private:', - ' %s(InnerClass2);' % macro_name, - ' // comment', - ' };', - '', - ' %s(OuterClass2);' % macro_name, - '', - ' // comment', - '};', - 'void Func() {', - ' struct LocalClass {', - ' private:', - ' %s(LocalClass);' % macro_name, - ' } variable;', - '}', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - - # Brace usage - def testBraces(self): - # Braces shouldn't be followed by a ; unless they're defining a struct - # or initializing an array - self.TestLint('int a[3] = { 1, 2, 3 };', '') - self.TestLint( - """const int foo[] = + "", + ) + # Special case for variadic arguments + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "class Foo {", + " template", + " explicit Foo(const int arg, Args&&... args) {}", + "};", + ], + error_collector, + ) + assert ( + error_collector.ResultList().count( + "Constructors that require multiple arguments should not be marked explicit. " + "[runtime/explicit] [0]" + ) + == 0 + ) + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "class Foo {", + " template", + " explicit Foo(Args&&... args) {}", + "};", + ], + error_collector, + ) + assert ( + error_collector.ResultList().count( + "Constructors that require multiple arguments should not be marked explicit. " + "[runtime/explicit] [0]" + ) + == 0 + ) + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "class Foo {", + " template", + " Foo(const int arg, Args&&... args) {}", + "};", + ], + error_collector, + ) + assert ( + error_collector.ResultList().count( + "Constructors callable with one argument should be marked explicit. " + "[runtime/explicit] [4]" + ) + == 1 + ) + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + ["class Foo {", " template", " Foo(Args&&... args) {}", "};"], + error_collector, + ) + assert ( + error_collector.ResultList().count( + "Constructors callable with one argument should be marked explicit. " + "[runtime/explicit] [4]" + ) + == 1 + ) + # Anything goes inside an assembly block + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "void Func() {", + " __asm__ (", + ' "hlt"', + " );", + " asm {", + " movdqa [edx + 32], xmm2", + " }", + "}", + ], + error_collector, + ) + assert ( + error_collector.ResultList().count( + "Extra space before ( in function call [whitespace/parens] [4]" + ) + == 0 + ) + assert ( + error_collector.ResultList().count( + "Closing ) should be moved to the previous line [whitespace/parens] [2]" + ) + == 0 + ) + assert ( + error_collector.ResultList().count("Extra space before [ [whitespace/braces] [5]") + == 0 + ) + finally: + cpplint._cpplint_state.verbose_level = old_verbose_level + + def testSlashStarCommentOnSingleLine(self): + self.TestMultiLineLint("""/* static */ Foo(int f);""", "") + self.TestMultiLineLint("""/*/ static */ Foo(int f);""", "") + self.TestMultiLineLint( + """/*/ static Foo(int f);""", + "Could not find end of multi-line comment [readability/multiline_comment] [5]", + ) + self.TestMultiLineLint( + """ /*/ static Foo(int f);""", + "Could not find end of multi-line comment [readability/multiline_comment] [5]", + ) + self.TestMultiLineLint(""" /**/ static Foo(int f);""", "") + + # Test suspicious usage of "if" like this: + # if (a == b) { + # DoSomething(); + # } if (a == c) { // Should be "else if". + # DoSomething(); // This gets called twice if a == b && a == c. + # } + def testSuspiciousUsageOfIf(self): + self.TestLint(" if (a == b) {", "") + self.TestLint( + " } if (a == b) {", + 'Did you mean "else if"? If not, start a new line for "if". [readability/braces] [4]', + ) + + # Test suspicious usage of memset. Specifically, a 0 + # as the final argument is almost certainly an error. + def testSuspiciousUsageOfMemset(self): + # Normal use is okay. + self.TestLint(" memset(buf, 0, sizeof(buf))", "") + + # A 0 as the final argument is almost certainly an error. + self.TestLint( + " memset(buf, sizeof(buf), 0)", + 'Did you mean "memset(buf, 0, sizeof(buf))"? [runtime/memset] [4]', + ) + self.TestLint( + " memset(buf, xsize * ysize, 0)", + 'Did you mean "memset(buf, 0, xsize * ysize)"? [runtime/memset] [4]', + ) + + # There is legitimate test code that uses this form. + # This is okay since the second argument is a literal. + self.TestLint(" memset(buf, 'y', 0)", "") + self.TestLint(" memset(buf, 4, 0)", "") + self.TestLint(" memset(buf, -1, 0)", "") + self.TestLint(" memset(buf, 0xF1, 0)", "") + self.TestLint(" memset(buf, 0xcd, 0)", "") + + def testRedundantVirtual(self): + self.TestLint("virtual void F()", "") + self.TestLint("virtual void F();", "") + self.TestLint("virtual void F() {}", "") + + message_template = ( + '"%s" is redundant since function is already ' + 'declared as "%s" [readability/inheritance] [4]' + ) + for virt_specifier in ["override", "final"]: + error_message = message_template % ("virtual", virt_specifier) + self.TestLint("virtual int F() %s" % virt_specifier, error_message) + self.TestLint("virtual int F() %s;" % virt_specifier, error_message) + self.TestLint("virtual int F() %s {" % virt_specifier, error_message) + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "virtual void F(int a,", + " int b) " + virt_specifier + ";", + "virtual void F(int a,", + " int b) LOCKS_EXCLUDED(lock) " + virt_specifier + ";", + "virtual void F(int a,", + " int b)", + " LOCKS_EXCLUDED(lock) " + virt_specifier + ";", + "", + ], + error_collector, + ) + assert [error_message, error_message, error_message] == error_collector.Results() + + error_message = message_template % ("override", "final") + self.TestLint("int F() override final", error_message) + self.TestLint("int F() override final;", error_message) + self.TestLint("int F() override final {}", error_message) + self.TestLint("int F() final override", error_message) + self.TestLint("int F() final override;", error_message) + self.TestLint("int F() final override {}", error_message) + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "struct A : virtual B {", + " ~A() override;};", + "class C", + " : public D,", + " public virtual E {", + " void Func() override;", + "}", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + + self.TestLint("void Finalize(AnnotationProto *final) override;", "") + + def testCheckDeprecated(self): + self.TestLanguageRulesCheck("foo_test.cc", "#include ", "") + self.TestLanguageRulesCheck("foo_unittest.cc", "#include ", "") + + def testCheckPosixThreading(self): + self.TestLint("var = sctime_r()", "") + self.TestLint("var = strtok_r()", "") + self.TestLint("var = strtok_r(foo, ba, r)", "") + self.TestLint("var = brand()", "") + self.TestLint("_rand()", "") + self.TestLint(".rand()", "") + self.TestLint("->rand()", "") + self.TestLint("ACMRandom rand(seed)", "") + self.TestLint("ISAACRandom rand()", "") + self.TestLint( + "var = rand()", + "Consider using rand_r(...) instead of rand(...)" + " for improved thread safety." + " [runtime/threadsafe_fn] [2]", + ) + self.TestLint( + "var = strtok(str, delim)", + "Consider using strtok_r(...) " + "instead of strtok(...)" + " for improved thread safety." + " [runtime/threadsafe_fn] [2]", + ) + + def testVlogMisuse(self): + self.TestLint("VLOG(1)", "") + self.TestLint("VLOG(99)", "") + self.TestLint("LOG(ERROR)", "") + self.TestLint("LOG(INFO)", "") + self.TestLint("LOG(WARNING)", "") + self.TestLint("LOG(FATAL)", "") + self.TestLint("LOG(DFATAL)", "") + self.TestLint("VLOG(SOMETHINGWEIRD)", "") + self.TestLint("MYOWNVLOG(ERROR)", "") + errmsg = ( + "VLOG() should be used with numeric verbosity level. " + "Use LOG() if you want symbolic severity levels." + " [runtime/vlog] [5]" + ) + self.TestLint("VLOG(ERROR)", errmsg) + self.TestLint("VLOG(INFO)", errmsg) + self.TestLint("VLOG(WARNING)", errmsg) + self.TestLint("VLOG(FATAL)", errmsg) + self.TestLint("VLOG(DFATAL)", errmsg) + self.TestLint(" VLOG(ERROR)", errmsg) + self.TestLint(" VLOG(INFO)", errmsg) + self.TestLint(" VLOG(WARNING)", errmsg) + self.TestLint(" VLOG(FATAL)", errmsg) + self.TestLint(" VLOG(DFATAL)", errmsg) + + # Test potential format string bugs like printf(foo). + def testFormatStrings(self): + self.TestLint('printf("foo")', "") + self.TestLint('printf("foo: %s", foo)', "") + self.TestLint("DocidForPrintf(docid)", "") # Should not trigger. + self.TestLint("printf(format, value)", "") # Should not trigger. + self.TestLint("printf(__VA_ARGS__)", "") # Should not trigger. + self.TestLint("printf(format.c_str(), value)", "") # Should not trigger. + self.TestLint("printf(format(index).c_str(), value)", "") + self.TestLint( + "printf(foo)", + 'Potential format string bug. Do printf("%s", foo) instead. [runtime/printf] [4]', + ) + self.TestLint( + "printf(foo.c_str())", + "Potential format string bug. " + 'Do printf("%s", foo.c_str()) instead.' + " [runtime/printf] [4]", + ) + self.TestLint( + "printf(foo->c_str())", + "Potential format string bug. " + 'Do printf("%s", foo->c_str()) instead.' + " [runtime/printf] [4]", + ) + self.TestLint( + "StringPrintf(foo)", + 'Potential format string bug. Do StringPrintf("%s", foo) instead.' + "" + " [runtime/printf] [4]", + ) + + # Test disallowed use of operator& and other operators. + def testIllegalOperatorOverloading(self): + errmsg = "Unary operator& is dangerous. Do not use it. [runtime/operator] [4]" + self.TestLint("void operator=(const Myclass&)", "") + self.TestLint("void operator&(int a, int b)", "") # binary operator& ok + self.TestLint("void operator&() { }", errmsg) + self.TestLint( + "void operator & ( ) { }", ["Extra space after ( [whitespace/parens] [2]", errmsg] + ) + + # const string reference members are dangerous.. + def testConstStringReferenceMembers(self): + errmsg = ( + "const string& members are dangerous. It is much better to use " + "alternatives, such as pointers or simple constants." + " [runtime/member_string_references] [2]" + ) + + members_declarations = [ + "const string& church", + "const string &turing", + "const string & godel", + ] + # TODO(unknown): Enable also these tests if and when we ever + # decide to check for arbitrary member references. + # "const Turing & a", + # "const Church& a", + # "const vector& a", + # "const Kurt::Godel & godel", + # "const Kazimierz::Kuratowski& kk" ] + + # The Good. + + self.TestLint("void f(const string&)", "") + self.TestLint("const string& f(const string& a, const string& b)", "") + self.TestLint("typedef const string& A;", "") + + for decl in members_declarations: + self.TestLint(decl + " = b;", "") + self.TestLint(decl + " =", "") + + # The Bad. + + for decl in members_declarations: + self.TestLint(decl + ";", errmsg) + + # Variable-length arrays are not permitted. + def testVariableLengthArrayDetection(self): + errmsg = ( + "Do not use variable-length arrays. Use an appropriately named " + "('k' followed by CamelCase) compile-time constant for the size." + " [runtime/arrays] [1]" + ) + + self.TestLint("int a[any_old_variable];", errmsg) + self.TestLint("int doublesize[some_var * 2];", errmsg) + self.TestLint("int a[afunction()];", errmsg) + self.TestLint("int a[function(kMaxFooBars)];", errmsg) + self.TestLint("bool a_list[items_->size()];", errmsg) + self.TestLint("namespace::Type buffer[len+1];", errmsg) + + self.TestLint("int a[64];", "") + self.TestLint("int a[0xFF];", "") + self.TestLint("int first[256], second[256];", "") + self.TestLint("int array_name[kCompileTimeConstant];", "") + self.TestLint("char buf[somenamespace::kBufSize];", "") + self.TestLint("int array_name[ALL_CAPS];", "") + self.TestLint("AClass array1[foo::bar::ALL_CAPS];", "") + self.TestLint("int a[kMaxStrLen + 1];", "") + self.TestLint("int a[sizeof(foo)];", "") + self.TestLint("int a[sizeof(*foo)];", "") + self.TestLint("int a[sizeof foo];", "") + self.TestLint("int a[sizeof(struct Foo)];", "") + self.TestLint("int a[128 - sizeof(const bar)];", "") + self.TestLint("int a[(sizeof(foo) * 4)];", "") + self.TestLint("int a[(arraysize(fixed_size_array)/2) << 1];", "") + self.TestLint("delete a[some_var];", "") + self.TestLint("return a[some_var];", "") + + # DISALLOW_COPY_AND_ASSIGN and DISALLOW_IMPLICIT_CONSTRUCTORS should be at + # end of class if present. + def testDisallowMacrosAtEnd(self): + for macro_name in ("DISALLOW_COPY_AND_ASSIGN", "DISALLOW_IMPLICIT_CONSTRUCTORS"): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "class SomeClass {", + " private:", + " %s(SomeClass);" % macro_name, + " int member_;", + "};", + "", + ], + error_collector, + ) + assert ( + "%s should be the last thing in the class" % macro_name + + " [readability/constructors] [3]" + == error_collector.Results() + ) + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "class OuterClass {", + " private:", + " struct InnerClass {", + " private:", + " %s(InnerClass);" % macro_name, + " int member;", + " };", + "};", + "", + ], + error_collector, + ) + assert ( + "%s should be the last thing in the class" % macro_name + + " [readability/constructors] [3]" + == error_collector.Results() + ) + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "class OuterClass1 {", + " private:", + " struct InnerClass1 {", + " private:", + " %s(InnerClass1);" % macro_name, + " };", + " %s(OuterClass1);" % macro_name, + "};", + "struct OuterClass2 {", + " private:", + " class InnerClass2 {", + " private:", + " %s(InnerClass2);" % macro_name, + " // comment", + " };", + "", + " %s(OuterClass2);" % macro_name, + "", + " // comment", + "};", + "void Func() {", + " struct LocalClass {", + " private:", + " %s(LocalClass);" % macro_name, + " } variable;", + "}", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + + # Brace usage + def testBraces(self): + # Braces shouldn't be followed by a ; unless they're defining a struct + # or initializing an array + self.TestLint("int a[3] = { 1, 2, 3 };", "") + self.TestLint( + """const int foo[] = {1, 2, 3 };""", - '') - # For single line, unmatched '}' with a ';' is ignored (not enough context) - self.TestMultiLineLint( - """int a[3] = { 1, + "", + ) + # For single line, unmatched '}' with a ';' is ignored (not enough context) + self.TestMultiLineLint( + """int a[3] = { 1, 2, 3 };""", - '') - self.TestMultiLineLint( - """int a[2][3] = { { 1, 2 }, + "", + ) + self.TestMultiLineLint( + """int a[2][3] = { { 1, 2 }, { 3, 4 } };""", - '') - self.TestMultiLineLint( - """int a[2][3] = + "", + ) + self.TestMultiLineLint( + """int a[2][3] = { { 1, 2 }, { 3, 4 } };""", - '') - self.TestMultiLineLint( # should not claim else should have braces on both sides - """if (foo) { + "", + ) + self.TestMultiLineLint( # should not claim else should have braces on both sides + """if (foo) { bar; } else { baz; }""", - 'An else should appear on the same line as the preceding } [whitespace/newline] [4]') - - # CHECK/EXPECT_TRUE/EXPECT_FALSE replacements - def testCheckCheck(self): - self.TestLint('CHECK(x == 42);', - 'Consider using CHECK_EQ instead of CHECK(a == b)' - ' [readability/check] [2]') - self.TestLint('CHECK(x != 42);', - 'Consider using CHECK_NE instead of CHECK(a != b)' - ' [readability/check] [2]') - self.TestLint('CHECK(x >= 42);', - 'Consider using CHECK_GE instead of CHECK(a >= b)' - ' [readability/check] [2]') - self.TestLint('CHECK(x > 42);', - 'Consider using CHECK_GT instead of CHECK(a > b)' - ' [readability/check] [2]') - self.TestLint('CHECK(x <= 42);', - 'Consider using CHECK_LE instead of CHECK(a <= b)' - ' [readability/check] [2]') - self.TestLint('CHECK(x < 42);', - 'Consider using CHECK_LT instead of CHECK(a < b)' - ' [readability/check] [2]') - - self.TestLint('DCHECK(x == 42);', - 'Consider using DCHECK_EQ instead of DCHECK(a == b)' - ' [readability/check] [2]') - self.TestLint('DCHECK(x != 42);', - 'Consider using DCHECK_NE instead of DCHECK(a != b)' - ' [readability/check] [2]') - self.TestLint('DCHECK(x >= 42);', - 'Consider using DCHECK_GE instead of DCHECK(a >= b)' - ' [readability/check] [2]') - self.TestLint('DCHECK(x > 42);', - 'Consider using DCHECK_GT instead of DCHECK(a > b)' - ' [readability/check] [2]') - self.TestLint('DCHECK(x <= 42);', - 'Consider using DCHECK_LE instead of DCHECK(a <= b)' - ' [readability/check] [2]') - self.TestLint('DCHECK(x < 42);', - 'Consider using DCHECK_LT instead of DCHECK(a < b)' - ' [readability/check] [2]') - - self.TestLint( - 'EXPECT_TRUE("42" == x);', - 'Consider using EXPECT_EQ instead of EXPECT_TRUE(a == b)' - ' [readability/check] [2]') - self.TestLint( - 'EXPECT_TRUE("42" != x);', - 'Consider using EXPECT_NE instead of EXPECT_TRUE(a != b)' - ' [readability/check] [2]') - self.TestLint( - 'EXPECT_TRUE(+42 >= x);', - 'Consider using EXPECT_GE instead of EXPECT_TRUE(a >= b)' - ' [readability/check] [2]') - - self.TestLint( - 'EXPECT_FALSE(x == 42);', - 'Consider using EXPECT_NE instead of EXPECT_FALSE(a == b)' - ' [readability/check] [2]') - self.TestLint( - 'EXPECT_FALSE(x != 42);', - 'Consider using EXPECT_EQ instead of EXPECT_FALSE(a != b)' - ' [readability/check] [2]') - self.TestLint( - 'EXPECT_FALSE(x >= 42);', - 'Consider using EXPECT_LT instead of EXPECT_FALSE(a >= b)' - ' [readability/check] [2]') - self.TestLint( - 'ASSERT_FALSE(x > 42);', - 'Consider using ASSERT_LE instead of ASSERT_FALSE(a > b)' - ' [readability/check] [2]') - self.TestLint( - 'ASSERT_FALSE(x <= 42);', - 'Consider using ASSERT_GT instead of ASSERT_FALSE(a <= b)' - ' [readability/check] [2]') - - self.TestLint('CHECK(x<42);', - ['Missing spaces around <' - ' [whitespace/operators] [3]', - 'Consider using CHECK_LT instead of CHECK(a < b)' - ' [readability/check] [2]']) - self.TestLint('CHECK(x>42);', - ['Missing spaces around >' - ' [whitespace/operators] [3]', - 'Consider using CHECK_GT instead of CHECK(a > b)' - ' [readability/check] [2]']) - - self.TestLint('using some::namespace::operator<<;', '') - self.TestLint('using some::namespace::operator>>;', '') - - self.TestLint('CHECK(x->y == 42);', - 'Consider using CHECK_EQ instead of CHECK(a == b)' - ' [readability/check] [2]') - - self.TestLint( - ' EXPECT_TRUE(42 < x); // Random comment.', - 'Consider using EXPECT_LT instead of EXPECT_TRUE(a < b)' - ' [readability/check] [2]') - self.TestLint( - 'EXPECT_TRUE( 42 < x );', - ['Extra space after ( in function call' - ' [whitespace/parens] [4]', - 'Extra space before ) [whitespace/parens] [2]', - 'Consider using EXPECT_LT instead of EXPECT_TRUE(a < b)' - ' [readability/check] [2]']) - - self.TestLint('CHECK(4\'2 == x);', - 'Consider using CHECK_EQ instead of CHECK(a == b)' - ' [readability/check] [2]') - - def testCheckCheckFalsePositives(self): - self.TestLint('CHECK(some_iterator == obj.end());', '') - self.TestLint('EXPECT_TRUE(some_iterator == obj.end());', '') - self.TestLint('EXPECT_FALSE(some_iterator == obj.end());', '') - self.TestLint('CHECK(some_pointer != NULL);', '') - self.TestLint('EXPECT_TRUE(some_pointer != NULL);', '') - self.TestLint('EXPECT_FALSE(some_pointer != NULL);', '') - - self.TestLint('CHECK(CreateTestFile(dir, (1 << 20)));', '') - self.TestLint('CHECK(CreateTestFile(dir, (1 >> 20)));', '') - - self.TestLint('CHECK(x ^ (y < 42));', '') - self.TestLint('CHECK((x > 42) ^ (x < 54));', '') - self.TestLint('CHECK(a && b < 42);', '') - self.TestLint('CHECK(42 < a && a < b);', '') - self.TestLint('SOFT_CHECK(x > 42);', '') - - self.TestMultiLineLint( - """_STLP_DEFINE_BINARY_OP_CHECK(==, _OP_EQUAL); + "An else should appear on the same line as the preceding } [whitespace/newline] [4]", + ) + + # CHECK/EXPECT_TRUE/EXPECT_FALSE replacements + def testCheckCheck(self): + self.TestLint( + "CHECK(x == 42);", + "Consider using CHECK_EQ instead of CHECK(a == b) [readability/check] [2]", + ) + self.TestLint( + "CHECK(x != 42);", + "Consider using CHECK_NE instead of CHECK(a != b) [readability/check] [2]", + ) + self.TestLint( + "CHECK(x >= 42);", + "Consider using CHECK_GE instead of CHECK(a >= b) [readability/check] [2]", + ) + self.TestLint( + "CHECK(x > 42);", + "Consider using CHECK_GT instead of CHECK(a > b) [readability/check] [2]", + ) + self.TestLint( + "CHECK(x <= 42);", + "Consider using CHECK_LE instead of CHECK(a <= b) [readability/check] [2]", + ) + self.TestLint( + "CHECK(x < 42);", + "Consider using CHECK_LT instead of CHECK(a < b) [readability/check] [2]", + ) + + self.TestLint( + "DCHECK(x == 42);", + "Consider using DCHECK_EQ instead of DCHECK(a == b) [readability/check] [2]", + ) + self.TestLint( + "DCHECK(x != 42);", + "Consider using DCHECK_NE instead of DCHECK(a != b) [readability/check] [2]", + ) + self.TestLint( + "DCHECK(x >= 42);", + "Consider using DCHECK_GE instead of DCHECK(a >= b) [readability/check] [2]", + ) + self.TestLint( + "DCHECK(x > 42);", + "Consider using DCHECK_GT instead of DCHECK(a > b) [readability/check] [2]", + ) + self.TestLint( + "DCHECK(x <= 42);", + "Consider using DCHECK_LE instead of DCHECK(a <= b) [readability/check] [2]", + ) + self.TestLint( + "DCHECK(x < 42);", + "Consider using DCHECK_LT instead of DCHECK(a < b) [readability/check] [2]", + ) + + self.TestLint( + 'EXPECT_TRUE("42" == x);', + "Consider using EXPECT_EQ instead of EXPECT_TRUE(a == b) [readability/check] [2]", + ) + self.TestLint( + 'EXPECT_TRUE("42" != x);', + "Consider using EXPECT_NE instead of EXPECT_TRUE(a != b) [readability/check] [2]", + ) + self.TestLint( + "EXPECT_TRUE(+42 >= x);", + "Consider using EXPECT_GE instead of EXPECT_TRUE(a >= b) [readability/check] [2]", + ) + + self.TestLint( + "EXPECT_FALSE(x == 42);", + "Consider using EXPECT_NE instead of EXPECT_FALSE(a == b) [readability/check] [2]", + ) + self.TestLint( + "EXPECT_FALSE(x != 42);", + "Consider using EXPECT_EQ instead of EXPECT_FALSE(a != b) [readability/check] [2]", + ) + self.TestLint( + "EXPECT_FALSE(x >= 42);", + "Consider using EXPECT_LT instead of EXPECT_FALSE(a >= b) [readability/check] [2]", + ) + self.TestLint( + "ASSERT_FALSE(x > 42);", + "Consider using ASSERT_LE instead of ASSERT_FALSE(a > b) [readability/check] [2]", + ) + self.TestLint( + "ASSERT_FALSE(x <= 42);", + "Consider using ASSERT_GT instead of ASSERT_FALSE(a <= b) [readability/check] [2]", + ) + + self.TestLint( + "CHECK(x<42);", + [ + "Missing spaces around < [whitespace/operators] [3]", + "Consider using CHECK_LT instead of CHECK(a < b) [readability/check] [2]", + ], + ) + self.TestLint( + "CHECK(x>42);", + [ + "Missing spaces around > [whitespace/operators] [3]", + "Consider using CHECK_GT instead of CHECK(a > b) [readability/check] [2]", + ], + ) + + self.TestLint("using some::namespace::operator<<;", "") + self.TestLint("using some::namespace::operator>>;", "") + + self.TestLint( + "CHECK(x->y == 42);", + "Consider using CHECK_EQ instead of CHECK(a == b) [readability/check] [2]", + ) + + self.TestLint( + " EXPECT_TRUE(42 < x); // Random comment.", + "Consider using EXPECT_LT instead of EXPECT_TRUE(a < b) [readability/check] [2]", + ) + self.TestLint( + "EXPECT_TRUE( 42 < x );", + [ + "Extra space after ( in function call [whitespace/parens] [4]", + "Extra space before ) [whitespace/parens] [2]", + "Consider using EXPECT_LT instead of EXPECT_TRUE(a < b) [readability/check] [2]", + ], + ) + + self.TestLint( + "CHECK(4'2 == x);", + "Consider using CHECK_EQ instead of CHECK(a == b) [readability/check] [2]", + ) + + def testCheckCheckFalsePositives(self): + self.TestLint("CHECK(some_iterator == obj.end());", "") + self.TestLint("EXPECT_TRUE(some_iterator == obj.end());", "") + self.TestLint("EXPECT_FALSE(some_iterator == obj.end());", "") + self.TestLint("CHECK(some_pointer != NULL);", "") + self.TestLint("EXPECT_TRUE(some_pointer != NULL);", "") + self.TestLint("EXPECT_FALSE(some_pointer != NULL);", "") + + self.TestLint("CHECK(CreateTestFile(dir, (1 << 20)));", "") + self.TestLint("CHECK(CreateTestFile(dir, (1 >> 20)));", "") + + self.TestLint("CHECK(x ^ (y < 42));", "") + self.TestLint("CHECK((x > 42) ^ (x < 54));", "") + self.TestLint("CHECK(a && b < 42);", "") + self.TestLint("CHECK(42 < a && a < b);", "") + self.TestLint("SOFT_CHECK(x > 42);", "") + + self.TestMultiLineLint( + """_STLP_DEFINE_BINARY_OP_CHECK(==, _OP_EQUAL); _STLP_DEFINE_BINARY_OP_CHECK(!=, _OP_NOT_EQUAL); _STLP_DEFINE_BINARY_OP_CHECK(<, _OP_LESS_THAN); _STLP_DEFINE_BINARY_OP_CHECK(<=, _OP_LESS_EQUAL); @@ -2367,1521 +2569,1742 @@ def testCheckCheckFalsePositives(self): _STLP_DEFINE_BINARY_OP_CHECK(/, _OP_DIVIDE); _STLP_DEFINE_BINARY_OP_CHECK(-, _OP_SUBTRACT); _STLP_DEFINE_BINARY_OP_CHECK(%, _OP_MOD);""", - '') - - self.TestLint('CHECK(x < 42) << "Custom error message";', '') - - # Alternative token to punctuation operator replacements - def testCheckAltTokens(self): - self.TestLint('true or true', - 'Use operator || instead of or' - ' [readability/alt_tokens] [2]') - self.TestLint('true and true', - 'Use operator && instead of and' - ' [readability/alt_tokens] [2]') - self.TestLint('if (not true)', - 'Use operator ! instead of not' - ' [readability/alt_tokens] [2]') - self.TestLint('1 bitor 1', - 'Use operator | instead of bitor' - ' [readability/alt_tokens] [2]') - self.TestLint('1 xor 1', - 'Use operator ^ instead of xor' - ' [readability/alt_tokens] [2]') - self.TestLint('1 bitand 1', - 'Use operator & instead of bitand' - ' [readability/alt_tokens] [2]') - self.TestLint('x = compl 1', - 'Use operator ~ instead of compl' - ' [readability/alt_tokens] [2]') - self.TestLint('x and_eq y', - 'Use operator &= instead of and_eq' - ' [readability/alt_tokens] [2]') - self.TestLint('x or_eq y', - 'Use operator |= instead of or_eq' - ' [readability/alt_tokens] [2]') - self.TestLint('x xor_eq y', - 'Use operator ^= instead of xor_eq' - ' [readability/alt_tokens] [2]') - self.TestLint('x not_eq y', - 'Use operator != instead of not_eq' - ' [readability/alt_tokens] [2]') - self.TestLint('line_continuation or', - 'Use operator || instead of or' - ' [readability/alt_tokens] [2]') - self.TestLint('if(true and(parentheses', - 'Use operator && instead of and' - ' [readability/alt_tokens] [2]') - - self.TestLint('#include "base/false-and-false.h"', '') - self.TestLint('#error false or false', '') - self.TestLint('false nor false', '') - self.TestLint('false nand false', '') - - # Passing and returning non-const references - def testNonConstReference(self): - # Passing a non-const reference as function parameter is forbidden. - operand_error_message = ('Is this a non-const reference? ' - 'If so, make const or use a pointer: %s' - ' [runtime/references] [2]') - # Warn of use of a non-const reference in operators and functions - self.TestLint('bool operator>(Foo& s, Foo& f);', - [operand_error_message % 'Foo& s', - operand_error_message % 'Foo& f']) - self.TestLint('bool operator+(Foo& s, Foo& f);', - [operand_error_message % 'Foo& s', - operand_error_message % 'Foo& f']) - self.TestLint('int len(Foo& s);', operand_error_message % 'Foo& s') - # Allow use of non-const references in a few specific cases - self.TestLint('stream& operator>>(stream& s, Foo& f);', '') - self.TestLint('stream& operator<<(stream& s, Foo& f);', '') - self.TestLint('void swap(Bar& a, Bar& b);', '') - self.TestLint('ostream& LogFunc(ostream& s);', '') - self.TestLint('ostringstream& LogFunc(ostringstream& s);', '') - self.TestLint('istream& LogFunc(istream& s);', '') - self.TestLint('istringstream& LogFunc(istringstream& s);', '') - # Returning a non-const reference from a function is OK. - self.TestLint('int& g();', '') - # Passing a const reference to a struct (using the struct keyword) is OK. - self.TestLint('void foo(const struct tm& tm);', '') - # Passing a const reference to a typename is OK. - self.TestLint('void foo(const typename tm& tm);', '') - # Const reference to a pointer type is OK. - self.TestLint('void foo(const Bar* const& p) {', '') - self.TestLint('void foo(Bar const* const& p) {', '') - self.TestLint('void foo(Bar* const& p) {', '') - # Const reference to a templated type is OK. - self.TestLint('void foo(const std::vector& v);', '') - # Non-const reference to a pointer type is not OK. - self.TestLint('void foo(Bar*& p);', - operand_error_message % 'Bar*& p') - self.TestLint('void foo(const Bar*& p);', - operand_error_message % 'const Bar*& p') - self.TestLint('void foo(Bar const*& p);', - operand_error_message % 'Bar const*& p') - self.TestLint('void foo(struct Bar*& p);', - operand_error_message % 'struct Bar*& p') - self.TestLint('void foo(const struct Bar*& p);', - operand_error_message % 'const struct Bar*& p') - self.TestLint('void foo(struct Bar const*& p);', - operand_error_message % 'struct Bar const*& p') - # Non-const reference to a templated type is not OK. - self.TestLint('void foo(std::vector& p);', - operand_error_message % 'std::vector& p') - # Returning an address of something is not prohibited. - self.TestLint('return &something;', '') - self.TestLint('if (condition) {return &something; }', - 'Controlled statements inside brackets of if clause should be on a separate line' - ' [whitespace/newline] [5]') - self.TestLint('if (condition) return &something;', '') - self.TestLint('if (condition) address = &something;', '') - self.TestLint('if (condition) result = lhs&rhs;', '') - self.TestLint('if (condition) result = lhs & rhs;', '') - self.TestLint('a = (b+c) * sizeof &f;', '') - self.TestLint('a = MySize(b) * sizeof &f;', '') - # We don't get confused by C++11 range-based for loops. - self.TestLint('for (const string& s : c)', '') - self.TestLint('for (auto& r : c)', '') - self.TestLint('for (typename Type& a : b)', '') - # We don't get confused by some other uses of '&'. - self.TestLint('T& operator=(const T& t);', '') - self.TestLint('int g() { return (a & b); }', '') - self.TestLint('T& r = (T&)*(vp());', '') - self.TestLint('T& r = v', '') - self.TestLint('static_assert((kBits & kMask) == 0, "text");', '') - self.TestLint('COMPILE_ASSERT((kBits & kMask) == 0, text);', '') - # Spaces before template arguments. This is poor style, but - # happens 0.15% of the time. - self.TestLint('void Func(const vector &const_x, ' - 'vector &nonconst_x) {', - operand_error_message % 'vector &nonconst_x') - - # Derived member functions are spared from override check - self.TestLint('void Func(X& x);', operand_error_message % 'X& x') - self.TestLint('void Func(X& x) {}', operand_error_message % 'X& x') - self.TestLint('void Func(X& x) override;', '') - self.TestLint('void Func(X& x) override {', '') - self.TestLint('void Func(X& x) const override;', '') - self.TestLint('void Func(X& x) const override {', '') - - # Don't warn on out-of-line method definitions. - self.TestLint('void NS::Func(X& x) {', '') - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company. All Rights Reserved.', - 'void a::b() {}', - 'void f(int& q) {}', - ''], - error_collector) - self.assertEqual( - operand_error_message % 'int& q', - error_collector.Results()) - - # Other potential false positives. These need full parser - # state to reproduce as opposed to just TestLint. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company. All Rights Reserved.', - '#include ', - '#include ', - 'void swap(int &x,', - ' int &y) {', - '}', - 'void swap(', - ' sparsegroup &x,', - ' sparsegroup &y) {', - '}', - 'ostream& operator<<(', - ' ostream& out', - ' const dense_hash_set& seq) {', - '}', - 'class A {', - ' void Function(', - ' string &x) override {', - ' }', - '};', - 'void Derived::Function(', - ' string &x) {', - '}', - '#define UNSUPPORTED_MASK(_mask) \\', - ' if (flags & _mask) { \\', - ' LOG(FATAL) << "Unsupported flag: " << #_mask; \\', - ' }', - 'Constructor::Constructor()', - ' : initializer1_(a1 & b1),', - ' initializer2_(a2 & b2) {', - '}', - 'Constructor::Constructor()', - ' : initializer1_{a3 & b3},', - ' initializer2_(a4 & b4) {', - '}', - 'Constructor::Constructor()', - ' : initializer1_{a5 & b5},', - ' initializer2_(a6 & b6) {}', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - - # Multi-line references - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company. All Rights Reserved.', - 'void Func(const Outer::', - ' Inner& const_x,', - ' const Outer', - ' ::Inner& const_y,', - ' const Outer<', - ' int>::Inner& const_z,', - ' Outer::', - ' Inner& nonconst_x,', - ' Outer', - ' ::Inner& nonconst_y,', - ' Outer<', - ' int>::Inner& nonconst_z) {', - '}', - ''], - error_collector) - self.assertEqual( - [operand_error_message % 'Outer::Inner& nonconst_x', - operand_error_message % 'Outer::Inner& nonconst_y', - operand_error_message % 'Outer::Inner& nonconst_z'], - error_collector.Results()) - - # A peculiar false positive due to bad template argument parsing - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company. All Rights Reserved.', - 'inline RCULocked::ReadPtr::ReadPtr(const RCULocked* rcu) {', - ' DCHECK(!(data & kFlagMask)) << "Error";', - '}', - '', - 'RCULocked::WritePtr::WritePtr(RCULocked* rcu)', - ' : lock_(&rcu_->mutex_) {', - '}', - ''], - error_collector.Results()) - self.assertEqual('', error_collector.Results()) - - def testBraceAtBeginOfLine(self): - self.TestLint('{', - '{ should almost always be at the end of the previous line' - ' [whitespace/braces] [4]') - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['int function()', - '{', # warning here - ' MutexLock l(&mu);', - '}', - 'int variable;' - '{', # no warning - ' MutexLock l(&mu);', - '}', - 'MyType m = {', - ' {value1, value2},', - ' {', # no warning - ' loooong_value1, looooong_value2', - ' }', - '};', - '#if PREPROCESSOR', - '{', # no warning - ' MutexLock l(&mu);', - '}', - '#endif'], - error_collector) - self.assertEqual(1, error_collector.Results().count( - '{ should almost always be at the end of the previous line' - ' [whitespace/braces] [4]')) - - self.TestMultiLineLint( - """ + "", + ) + + self.TestLint('CHECK(x < 42) << "Custom error message";', "") + + # Alternative token to punctuation operator replacements + def testCheckAltTokens(self): + self.TestLint("true or true", "Use operator || instead of or [readability/alt_tokens] [2]") + self.TestLint( + "true and true", "Use operator && instead of and [readability/alt_tokens] [2]" + ) + self.TestLint( + "if (not true)", "Use operator ! instead of not [readability/alt_tokens] [2]" + ) + self.TestLint("1 bitor 1", "Use operator | instead of bitor [readability/alt_tokens] [2]") + self.TestLint("1 xor 1", "Use operator ^ instead of xor [readability/alt_tokens] [2]") + self.TestLint( + "1 bitand 1", "Use operator & instead of bitand [readability/alt_tokens] [2]" + ) + self.TestLint( + "x = compl 1", "Use operator ~ instead of compl [readability/alt_tokens] [2]" + ) + self.TestLint( + "x and_eq y", "Use operator &= instead of and_eq [readability/alt_tokens] [2]" + ) + self.TestLint("x or_eq y", "Use operator |= instead of or_eq [readability/alt_tokens] [2]") + self.TestLint( + "x xor_eq y", "Use operator ^= instead of xor_eq [readability/alt_tokens] [2]" + ) + self.TestLint( + "x not_eq y", "Use operator != instead of not_eq [readability/alt_tokens] [2]" + ) + self.TestLint( + "line_continuation or", "Use operator || instead of or [readability/alt_tokens] [2]" + ) + self.TestLint( + "if(true and(parentheses", + "Use operator && instead of and [readability/alt_tokens] [2]", + ) + + self.TestLint('#include "base/false-and-false.h"', "") + self.TestLint("#error false or false", "") + self.TestLint("false nor false", "") + self.TestLint("false nand false", "") + + # Passing and returning non-const references + def testNonConstReference(self): + # Passing a non-const reference as function parameter is forbidden. + operand_error_message = ( + "Is this a non-const reference? " + "If so, make const or use a pointer: %s" + " [runtime/references] [2]" + ) + # Warn of use of a non-const reference in operators and functions + self.TestLint( + "bool operator>(Foo& s, Foo& f);", + [operand_error_message % "Foo& s", operand_error_message % "Foo& f"], + ) + self.TestLint( + "bool operator+(Foo& s, Foo& f);", + [operand_error_message % "Foo& s", operand_error_message % "Foo& f"], + ) + self.TestLint("int len(Foo& s);", operand_error_message % "Foo& s") + # Allow use of non-const references in a few specific cases + self.TestLint("stream& operator>>(stream& s, Foo& f);", "") + self.TestLint("stream& operator<<(stream& s, Foo& f);", "") + self.TestLint("void swap(Bar& a, Bar& b);", "") + self.TestLint("ostream& LogFunc(ostream& s);", "") + self.TestLint("ostringstream& LogFunc(ostringstream& s);", "") + self.TestLint("istream& LogFunc(istream& s);", "") + self.TestLint("istringstream& LogFunc(istringstream& s);", "") + # Returning a non-const reference from a function is OK. + self.TestLint("int& g();", "") + # Passing a const reference to a struct (using the struct keyword) is OK. + self.TestLint("void foo(const struct tm& tm);", "") + # Passing a const reference to a typename is OK. + self.TestLint("void foo(const typename tm& tm);", "") + # Const reference to a pointer type is OK. + self.TestLint("void foo(const Bar* const& p) {", "") + self.TestLint("void foo(Bar const* const& p) {", "") + self.TestLint("void foo(Bar* const& p) {", "") + # Const reference to a templated type is OK. + self.TestLint("void foo(const std::vector& v);", "") + # Non-const reference to a pointer type is not OK. + self.TestLint("void foo(Bar*& p);", operand_error_message % "Bar*& p") + self.TestLint("void foo(const Bar*& p);", operand_error_message % "const Bar*& p") + self.TestLint("void foo(Bar const*& p);", operand_error_message % "Bar const*& p") + self.TestLint("void foo(struct Bar*& p);", operand_error_message % "struct Bar*& p") + self.TestLint( + "void foo(const struct Bar*& p);", operand_error_message % "const struct Bar*& p" + ) + self.TestLint( + "void foo(struct Bar const*& p);", operand_error_message % "struct Bar const*& p" + ) + # Non-const reference to a templated type is not OK. + self.TestLint( + "void foo(std::vector& p);", operand_error_message % "std::vector& p" + ) + # Returning an address of something is not prohibited. + self.TestLint("return &something;", "") + self.TestLint( + "if (condition) {return &something; }", + "Controlled statements inside brackets of if clause should be on a separate line" + " [whitespace/newline] [5]", + ) + self.TestLint("if (condition) return &something;", "") + self.TestLint("if (condition) address = &something;", "") + self.TestLint("if (condition) result = lhs&rhs;", "") + self.TestLint("if (condition) result = lhs & rhs;", "") + self.TestLint("a = (b+c) * sizeof &f;", "") + self.TestLint("a = MySize(b) * sizeof &f;", "") + # We don't get confused by C++11 range-based for loops. + self.TestLint("for (const string& s : c)", "") + self.TestLint("for (auto& r : c)", "") + self.TestLint("for (typename Type& a : b)", "") + # We don't get confused by some other uses of '&'. + self.TestLint("T& operator=(const T& t);", "") + self.TestLint("int g() { return (a & b); }", "") + self.TestLint("T& r = (T&)*(vp());", "") + self.TestLint("T& r = v", "") + self.TestLint('static_assert((kBits & kMask) == 0, "text");', "") + self.TestLint("COMPILE_ASSERT((kBits & kMask) == 0, text);", "") + # Spaces before template arguments. This is poor style, but + # happens 0.15% of the time. + self.TestLint( + "void Func(const vector &const_x, vector &nonconst_x) {", + operand_error_message % "vector &nonconst_x", + ) + + # Derived member functions are spared from override check + self.TestLint("void Func(X& x);", operand_error_message % "X& x") + self.TestLint("void Func(X& x) {}", operand_error_message % "X& x") + self.TestLint("void Func(X& x) override;", "") + self.TestLint("void Func(X& x) override {", "") + self.TestLint("void Func(X& x) const override;", "") + self.TestLint("void Func(X& x) const override {", "") + + # Don't warn on out-of-line method definitions. + self.TestLint("void NS::Func(X& x) {", "") + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company. All Rights Reserved.", + "void a::b() {}", + "void f(int& q) {}", + "", + ], + error_collector, + ) + assert operand_error_message % "int& q" == error_collector.Results() + + # Other potential false positives. These need full parser + # state to reproduce as opposed to just TestLint. + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company. All Rights Reserved.", + "#include ", + "#include ", + "void swap(int &x,", + " int &y) {", + "}", + "void swap(", + " sparsegroup &x,", + " sparsegroup &y) {", + "}", + "ostream& operator<<(", + " ostream& out", + " const dense_hash_set& seq) {", + "}", + "class A {", + " void Function(", + " string &x) override {", + " }", + "};", + "void Derived::Function(", + " string &x) {", + "}", + "#define UNSUPPORTED_MASK(_mask) \\", + " if (flags & _mask) { \\", + ' LOG(FATAL) << "Unsupported flag: " << #_mask; \\', + " }", + "Constructor::Constructor()", + " : initializer1_(a1 & b1),", + " initializer2_(a2 & b2) {", + "}", + "Constructor::Constructor()", + " : initializer1_{a3 & b3},", + " initializer2_(a4 & b4) {", + "}", + "Constructor::Constructor()", + " : initializer1_{a5 & b5},", + " initializer2_(a6 & b6) {}", + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + + # Multi-line references + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company. All Rights Reserved.", + "void Func(const Outer::", + " Inner& const_x,", + " const Outer", + " ::Inner& const_y,", + " const Outer<", + " int>::Inner& const_z,", + " Outer::", + " Inner& nonconst_x,", + " Outer", + " ::Inner& nonconst_y,", + " Outer<", + " int>::Inner& nonconst_z) {", + "}", + "", + ], + error_collector, + ) + assert [ + operand_error_message % "Outer::Inner& nonconst_x", + operand_error_message % "Outer::Inner& nonconst_y", + operand_error_message % "Outer::Inner& nonconst_z", + ] == error_collector.Results() + + # A peculiar false positive due to bad template argument parsing + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company. All Rights Reserved.", + "inline RCULocked::ReadPtr::ReadPtr(const RCULocked* rcu) {", + ' DCHECK(!(data & kFlagMask)) << "Error";', + "}", + "", + "RCULocked::WritePtr::WritePtr(RCULocked* rcu)", + " : lock_(&rcu_->mutex_) {", + "}", + "", + ], + error_collector.Results(), + ) + assert error_collector.Results() == "" + + def testBraceAtBeginOfLine(self): + self.TestLint( + "{", + "{ should almost always be at the end of the previous line [whitespace/braces] [4]", + ) + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "int function()", + "{", # warning here + " MutexLock l(&mu);", + "}", + "int variable;{", # no warning + " MutexLock l(&mu);", + "}", + "MyType m = {", + " {value1, value2},", + " {", # no warning + " loooong_value1, looooong_value2", + " }", + "};", + "#if PREPROCESSOR", + "{", # no warning + " MutexLock l(&mu);", + "}", + "#endif", + ], + error_collector, + ) + assert ( + error_collector.Results().count( + "{ should almost always be at the end of the previous line [whitespace/braces] [4]" + ) + == 1 + ) + + self.TestMultiLineLint( + """ foo( { loooooooooooooooong_value, });""", - '') - - def testMismatchingSpacesInParens(self): - self.TestLint('if (foo ) {', 'Mismatching spaces inside () in if' - ' [whitespace/parens] [5]') - self.TestLint('switch ( foo) {', 'Mismatching spaces inside () in switch' - ' [whitespace/parens] [5]') - self.TestLint('for (foo; ba; bar ) {', 'Mismatching spaces inside () in for' - ' [whitespace/parens] [5]') - self.TestLint('for (; foo; bar) {', '') - self.TestLint('for ( ; foo; bar) {', '') - self.TestLint('for ( ; foo; bar ) {', '') - self.TestLint('for (foo; bar; ) {', '') - self.TestLint('while ( foo ) {', 'Should have zero or one spaces inside' - ' ( and ) in while [whitespace/parens] [5]') - - def testSpacingForFncall(self): - self.TestLint('if (foo) {', '') - self.TestLint('for (foo; bar; baz) {', '') - self.TestLint('for (;;) {', '') - # Space should be allowed in placement new operators. - self.TestLint('Something* p = new (place) Something();', '') - # Test that there is no warning when increment statement is empty. - self.TestLint('for (foo; baz;) {', '') - self.TestLint('for (foo;bar;baz) {', 'Missing space after ;' - ' [whitespace/semicolon] [3]') - # we don't warn about this semicolon, at least for now - self.TestLintNotContains('if (condition) { return &something; }', - 'Missing space after ; [whitespace/semicolon] [3]') - # seen in some macros - self.TestLint('DoSth();\\', '') - # Test that there is no warning about semicolon here. - self.TestLint('abc;// this is abc', - 'At least two spaces is best between code' - ' and comments [whitespace/comments] [2]') - self.TestLint('while (foo) {', '') - self.TestLint('switch (foo) {', '') - self.TestLint('foo( bar)', 'Extra space after ( in function call' - ' [whitespace/parens] [4]') - self.TestLint('foo( // comment', '') - self.TestLint('foo( // comment', - 'At least two spaces is best between code' - ' and comments [whitespace/comments] [2]') - self.TestLint('foobar( \\', '') - self.TestLint('foobar( \\', '') - self.TestLint('( a + b)', 'Extra space after (' - ' [whitespace/parens] [2]') - self.TestLint('((a+b))', '') - self.TestLint('foo (foo)', 'Extra space before ( in function call' - ' [whitespace/parens] [4]') - # asm volatile () may have a space, as it isn't a function call. - self.TestLint('asm volatile ("")', '') - self.TestLint('__asm__ __volatile__ ("")', '') - self.TestLint('} catch (const Foo& ex) {', '') - self.TestLint('case (42):', '') - self.TestLint('typedef foo (*foo)(foo)', '') - self.TestLint('typedef foo (*foo12bar_)(foo)', '') - self.TestLint('typedef foo (Foo::*bar)(foo)', '') - self.TestLint('using foo = type (Foo::*bar)(foo)', '') - self.TestLint('using foo = type (Foo::*bar)(', '') - self.TestLint('using foo = type (Foo::*)(', '') - self.TestLint('foo (Foo::*bar)(', '') - self.TestLint('foo (x::y::*z)(', '') - self.TestLint('foo (Foo::bar)(', - 'Extra space before ( in function call' - ' [whitespace/parens] [4]') - self.TestLint('foo (*bar)(', '') - self.TestLint('typedef foo (Foo::*bar)(', '') - self.TestLint('(foo)(bar)', '') - self.TestLint('Foo (*foo)(bar)', '') - self.TestLint('Foo (*foo)(Bar bar,', '') - self.TestLint('char (*p)[sizeof(foo)] = &foo', '') - self.TestLint('char (&ref)[sizeof(foo)] = &foo', '') - self.TestLint('const char32 (*table[])[6];', '') - # The sizeof operator is often written as if it were a function call, with - # an opening parenthesis directly following the operator name, but it can - # also be written like any other operator, with a space following the - # operator name, and the argument optionally in parentheses. - self.TestLint('sizeof(foo)', '') - self.TestLint('sizeof foo', '') - self.TestLint('sizeof (foo)', '') - - def testReplaceAlternateTokens(self): - assert cpplint.ReplaceAlternateTokens('tor or orc') == 'tor || orc' - assert cpplint.ReplaceAlternateTokens('orc or tor') == 'orc || tor' - assert cpplint.ReplaceAlternateTokens('tor or (orc)') == 'tor || (orc)' - assert cpplint.ReplaceAlternateTokens('tor or(orc)') == 'tor ||(orc)' - assert cpplint.ReplaceAlternateTokens('sand and(android)') == \ - 'sand &&(android)' - assert cpplint.ReplaceAlternateTokens('(sand) and (android)') == \ - '(sand) && (android)' - assert cpplint.ReplaceAlternateTokens(' not note') == ' !note' - assert cpplint.ReplaceAlternateTokens(')not note') == ')!note' - assert cpplint.ReplaceAlternateTokens('(not note') == '(!note' - assert cpplint.ReplaceAlternateTokens(' not(note)') == ' !(note)' - assert cpplint.ReplaceAlternateTokens(' not (splinot)') == ' !(splinot)' - assert cpplint.ReplaceAlternateTokens('tor and orc or android') == \ - 'tor && orc || android' - assert cpplint.ReplaceAlternateTokens('tor or orc and ands not note') == \ - 'tor || orc && ands !note' - - def testSpacingAfterAlternateToken(self): - try: - cpplint._cpplint_state.AddFilters('-readability/alt_tokens') - self.TestLint('if (foo or (bar) or foobar) {', '') - self.TestLint('if (foo or (bar)) {', '') - self.TestLint('if ((foo) or (bar)) {', '') - self.TestLint('if (not foo) {', '') - self.TestLint('if (not (foo)) {', '') - self.TestLint('if (not(foo)) {', '') - self.TestLint('if ((foo)or(bar)) {', 'Missing spaces around ||' - ' [whitespace/operators] [3]') - finally: - cpplint._cpplint_state.SetFilters('') - - def testSpacingBeforeBraces(self): - self.TestLint('if (foo){', 'Missing space before {' - ' [whitespace/braces] [5]') - self.TestLint('for{', 'Missing space before {' - ' [whitespace/braces] [5]') - self.TestLint('for {', '') - self.TestLint('EXPECT_DEBUG_DEATH({', '') - self.TestLint('std::is_convertible{}', '') - self.TestLint('blah{32}', 'Missing space before {' - ' [whitespace/braces] [5]') - self.TestLint('int8_t{3}', '') - self.TestLint('int16_t{3}', '') - self.TestLint('int32_t{3}', '') - self.TestLint('uint64_t{12345}', '') - self.TestLint('constexpr int64_t kBatchGapMicros =' - ' int64_t{7} * 24 * 3600 * 1000000; // 1 wk.', '') - self.TestLint('MoveOnly(int i1, int i2) : ip1{new int{i1}}, ' - 'ip2{new int{i2}} {}', - '') - - def testSemiColonAfterBraces(self): - self.TestLintContains('if (cond) { func(); };', - 'You don\'t need a ; after a } [readability/braces] [4]') - self.TestLint('void Func() {};', - 'You don\'t need a ; after a } [readability/braces] [4]') - self.TestLint('void Func() const {};', - 'You don\'t need a ; after a } [readability/braces] [4]') - self.TestLint('class X {};', '') - for keyword in ['struct', 'union']: - for align in ['', ' alignas(16)']: - for typename in ['', ' X']: - for identifier in ['', ' x']: - self.TestLint(keyword + align + typename + ' {}' + identifier + ';', - '') - - self.TestLint('class X : public Y {};', '') - self.TestLint('class X : public MACRO() {};', '') - self.TestLint('class X : public decltype(expr) {};', '') - self.TestLint('DEFINE_FACADE(PCQueue::Watcher, PCQueue) {};', '') - self.TestLint('VCLASS(XfaTest, XfaContextTest) {};', '') - self.TestLint('class STUBBY_CLASS(H, E) {};', '') - self.TestLint('class STUBBY2_CLASS(H, E) {};', '') - self.TestLint('TEST(TestCase, TestName) {};', - 'You don\'t need a ; after a } [readability/braces] [4]') - self.TestLint('TEST_F(TestCase, TestName) {};', - 'You don\'t need a ; after a } [readability/braces] [4]') - - self.TestLint('file_tocs_[i] = (FileToc) {a, b, c};', '') - self.TestMultiLineLint('class X : public Y,\npublic Z {};', '') - self.TestMultiLineLint('template\n' - 'concept Addable = requires(T x) { x + x; };', - '') - self.TestMultiLineLint('template \n' - 'concept C = requires(T a, T b) {\n' - ' requires a == b;\n' - '};', - '') - self.TestMultiLineLint('template \n' - 'concept C = (std::integral || std::floating_point) &&\n' - ' (std::integral || std::floating_point) &&\n' - ' requires(T t, U u) {\n' - ' std::min(static_cast(t), static_cast(u));\n' - '};', - '') - - def testSpacingBeforeBrackets(self): - self.TestLint('int numbers [] = { 1, 2, 3 };', - 'Extra space before [ [whitespace/braces] [5]') - # space allowed in some cases - self.TestLint('auto [abc, def] = func();', '') - self.TestLint('#define NODISCARD [[nodiscard]]', '') - self.TestLint('void foo(int param [[maybe_unused]]);', '') - - def testLambda(self): - self.TestLint('auto x = []() {};', '') - self.TestLint('return []() {};', '') - self.TestMultiLineLint('auto x = []() {\n};\n', '') - self.TestLint('int operator[](int x) {};', - 'You don\'t need a ; after a } [readability/braces] [4]') - - self.TestMultiLineLint('auto x = [&a,\nb]() {};', '') - self.TestMultiLineLint('auto x = [&a,\nb]\n() {};', '') - self.TestMultiLineLint('auto x = [&a,\n' - ' b](\n' - ' int a,\n' - ' int b) {\n' - ' return a +\n' - ' b;\n' - '};\n', - '') - - # Avoid false positives with operator[] - self.TestLint('table_to_children[&*table].push_back(dependent);', '') - - def testBraceInitializerList(self): - self.TestLint('MyStruct p = {1, 2};', '') - self.TestLint('MyStruct p{1, 2};', '') - self.TestLint('vector p = {1, 2};', '') - self.TestLint('vector p{1, 2};', '') - self.TestLint('x = vector{1, 2};', '') - self.TestLint('x = (struct in_addr){ 0 };', '') - self.TestLint('Func(vector{1, 2})', '') - self.TestLint('Func((struct in_addr){ 0 })', '') - self.TestLint('Func(vector{1, 2}, 3)', '') - self.TestLint('Func((struct in_addr){ 0 }, 3)', '') - self.TestLint('LOG(INFO) << char{7};', '') - self.TestLint('LOG(INFO) << char{7} << "!";', '') - self.TestLint('int p[2] = {1, 2};', '') - self.TestLint('return {1, 2};', '') - self.TestLint('std::unique_ptr foo{new Foo{}};', '') - self.TestLint('auto foo = std::unique_ptr{new Foo{}};', '') - self.TestLint('static_assert(Max7String{}.IsValid(), "");', '') - self.TestLint('map_of_pairs[{1, 2}] = 3;', '') - self.TestLint('ItemView{has_offer() ? new Offer{offer()} : nullptr', '') - self.TestLint('template {}> = 0>', '') - - self.TestMultiLineLint('std::unique_ptr foo{\n' - ' new Foo{}\n' - '};\n', '') - self.TestMultiLineLint('std::unique_ptr foo{\n' - ' new Foo{\n' - ' new Bar{}\n' - ' }\n' - '};\n', '') - self.TestMultiLineLint('if (true) {\n' - ' if (false){\n' - ' func();\n' - ' }' - '}\n', - 'Missing space before { [whitespace/braces] [5]') - self.TestMultiLineLint('MyClass::MyClass()\n' - ' : initializer_{\n' - ' Func()} {\n' - '}\n', '') - self.TestLint('const pair kCL' + - ('o' * 41) + 'gStr[] = {\n', - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - self.TestMultiLineLint('const pair kCL' + - ('o' * 40) + 'ngStr[] =\n' - ' {\n' - ' {"gooooo", "oooogle"},\n' - '};\n', '') - self.TestMultiLineLint('const pair kCL' + - ('o' * 39) + 'ngStr[] =\n' - ' {\n' - ' {"gooooo", "oooogle"},\n' - '};\n', '{ should almost always be at the end of ' - 'the previous line [whitespace/braces] [4]') - - def testSpacingAroundElse(self): - self.TestLint('}else {', 'Missing space before else' - ' [whitespace/braces] [5]') - self.TestLint('} else{', 'Missing space before {' - ' [whitespace/braces] [5]') - self.TestLint('} else {', '') - self.TestLint('} else if (foo) {', '') - - def testSpacingWithInitializerLists(self): - self.TestLint('int v[1][3] = {{1, 2, 3}};', '') - self.TestLint('int v[1][1] = {{0}};', '') - - def testSpacingForBinaryOps(self): - self.TestLint('if (foo||bar) {', 'Missing spaces around ||' - ' [whitespace/operators] [3]') - self.TestLint('if (foo<=bar) {', 'Missing spaces around <=' - ' [whitespace/operators] [3]') - self.TestLint('if (foobar) {', 'Missing spaces around >' - ' [whitespace/operators] [3]') - self.TestLint('if (foobaz) {', 'Missing spaces around <' - ' [whitespace/operators] [3]') - self.TestLint('if (foobar) {', 'Missing spaces around <' - ' [whitespace/operators] [3]') - self.TestLint('template', '') - self.TestLint('std::unique_ptr>', '') - self.TestLint('typedef hash_map', '') - self.TestLint('10<<20', '') - self.TestLint('10<>b', - 'Missing spaces around >> [whitespace/operators] [3]') - self.TestLint('10>>b', - 'Missing spaces around >> [whitespace/operators] [3]') - self.TestLint('LOG(ERROR)<<*foo', - 'Missing spaces around << [whitespace/operators] [3]') - self.TestLint('LOG(ERROR)<<&foo', - 'Missing spaces around << [whitespace/operators] [3]') - self.TestLint('StringCoder>::ToString()', '') - self.TestLint('map, map>::iterator', '') - self.TestLint('func>>()', '') - self.TestLint('MACRO1(list>)', '') - self.TestLint('MACRO2(list>, 42)', '') - self.TestLint('void DoFoo(const set>& arg1);', '') - self.TestLint('void SetFoo(set>* arg1);', '') - self.TestLint('foo = new set>;', '') - self.TestLint('reinterpret_cast>*>(a);', '') - self.TestLint('MACRO(<<)', '') - self.TestLint('MACRO(<<, arg)', '') - self.TestLint('MACRO(<<=)', '') - self.TestLint('MACRO(<<=, arg)', '') - - self.TestLint('using Vector3::operator==;', '') - self.TestLint('using Vector3::operator!=;', '') - - def testSpacingBeforeLastSemicolon(self): - self.TestLint('call_function() ;', - 'Extra space before last semicolon. If this should be an ' - 'empty statement, use {} instead.' - ' [whitespace/semicolon] [5]') - self.TestLint('while (true) ;', - 'Extra space before last semicolon. If this should be an ' - 'empty statement, use {} instead.' - ' [whitespace/semicolon] [5]') - self.TestLint('default:;', - 'Semicolon defining empty statement. Use {} instead.' - ' [whitespace/semicolon] [5]') - self.TestLint(' ;', - 'Line contains only semicolon. If this should be an empty ' - 'statement, use {} instead.' - ' [whitespace/semicolon] [5]') - self.TestLint('for (int i = 0; ;', '') - - def testEmptyBlockBody(self): - self.TestLint('while (true);', - 'Empty loop bodies should use {} or continue' - ' [whitespace/empty_loop_body] [5]') - self.TestLint('if (true);', - 'Empty conditional bodies should use {}' - ' [whitespace/empty_conditional_body] [5]') - self.TestLint('while (true)', '') - self.TestLint('while (true) continue;', '') - self.TestLint('for (;;);', - 'Empty loop bodies should use {} or continue' - ' [whitespace/empty_loop_body] [5]') - self.TestLint('for (;;)', '') - self.TestLint('for (;;) continue;', '') - self.TestLint('for (;;) func();', '') - self.TestLint('if (test) {}', - 'If statement had no body and no else clause' - ' [whitespace/empty_if_body] [4]') - self.TestLint('if (test) func();', '') - self.TestLint('if (test) {} else {}', '') - self.TestMultiLineLint("""while (true && + "", + ) + + def testMismatchingSpacesInParens(self): + self.TestLint("if (foo ) {", "Mismatching spaces inside () in if [whitespace/parens] [5]") + self.TestLint( + "switch ( foo) {", "Mismatching spaces inside () in switch [whitespace/parens] [5]" + ) + self.TestLint( + "for (foo; ba; bar ) {", "Mismatching spaces inside () in for [whitespace/parens] [5]" + ) + self.TestLint("for (; foo; bar) {", "") + self.TestLint("for ( ; foo; bar) {", "") + self.TestLint("for ( ; foo; bar ) {", "") + self.TestLint("for (foo; bar; ) {", "") + self.TestLint( + "while ( foo ) {", + "Should have zero or one spaces inside ( and ) in while [whitespace/parens] [5]", + ) + + def testSpacingForFncall(self): + self.TestLint("if (foo) {", "") + self.TestLint("for (foo; bar; baz) {", "") + self.TestLint("for (;;) {", "") + # Space should be allowed in placement new operators. + self.TestLint("Something* p = new (place) Something();", "") + # Test that there is no warning when increment statement is empty. + self.TestLint("for (foo; baz;) {", "") + self.TestLint("for (foo;bar;baz) {", "Missing space after ; [whitespace/semicolon] [3]") + # we don't warn about this semicolon, at least for now + self.TestLintNotContains( + "if (condition) { return &something; }", + "Missing space after ; [whitespace/semicolon] [3]", + ) + # seen in some macros + self.TestLint("DoSth();\\", "") + # Test that there is no warning about semicolon here. + self.TestLint( + "abc;// this is abc", + "At least two spaces is best between code and comments [whitespace/comments] [2]", + ) + self.TestLint("while (foo) {", "") + self.TestLint("switch (foo) {", "") + self.TestLint("foo( bar)", "Extra space after ( in function call [whitespace/parens] [4]") + self.TestLint("foo( // comment", "") + self.TestLint( + "foo( // comment", + "At least two spaces is best between code and comments [whitespace/comments] [2]", + ) + self.TestLint("foobar( \\", "") + self.TestLint("foobar( \\", "") + self.TestLint("( a + b)", "Extra space after ( [whitespace/parens] [2]") + self.TestLint("((a+b))", "") + self.TestLint("foo (foo)", "Extra space before ( in function call [whitespace/parens] [4]") + # asm volatile () may have a space, as it isn't a function call. + self.TestLint('asm volatile ("")', "") + self.TestLint('__asm__ __volatile__ ("")', "") + self.TestLint("} catch (const Foo& ex) {", "") + self.TestLint("case (42):", "") + self.TestLint("typedef foo (*foo)(foo)", "") + self.TestLint("typedef foo (*foo12bar_)(foo)", "") + self.TestLint("typedef foo (Foo::*bar)(foo)", "") + self.TestLint("using foo = type (Foo::*bar)(foo)", "") + self.TestLint("using foo = type (Foo::*bar)(", "") + self.TestLint("using foo = type (Foo::*)(", "") + self.TestLint("foo (Foo::*bar)(", "") + self.TestLint("foo (x::y::*z)(", "") + self.TestLint( + "foo (Foo::bar)(", "Extra space before ( in function call [whitespace/parens] [4]" + ) + self.TestLint("foo (*bar)(", "") + self.TestLint("typedef foo (Foo::*bar)(", "") + self.TestLint("(foo)(bar)", "") + self.TestLint("Foo (*foo)(bar)", "") + self.TestLint("Foo (*foo)(Bar bar,", "") + self.TestLint("char (*p)[sizeof(foo)] = &foo", "") + self.TestLint("char (&ref)[sizeof(foo)] = &foo", "") + self.TestLint("const char32 (*table[])[6];", "") + # The sizeof operator is often written as if it were a function call, with + # an opening parenthesis directly following the operator name, but it can + # also be written like any other operator, with a space following the + # operator name, and the argument optionally in parentheses. + self.TestLint("sizeof(foo)", "") + self.TestLint("sizeof foo", "") + self.TestLint("sizeof (foo)", "") + + def testReplaceAlternateTokens(self): + assert cpplint.ReplaceAlternateTokens("tor or orc") == "tor || orc" + assert cpplint.ReplaceAlternateTokens("orc or tor") == "orc || tor" + assert cpplint.ReplaceAlternateTokens("tor or (orc)") == "tor || (orc)" + assert cpplint.ReplaceAlternateTokens("tor or(orc)") == "tor ||(orc)" + assert cpplint.ReplaceAlternateTokens("sand and(android)") == "sand &&(android)" + assert cpplint.ReplaceAlternateTokens("(sand) and (android)") == "(sand) && (android)" + assert cpplint.ReplaceAlternateTokens(" not note") == " !note" + assert cpplint.ReplaceAlternateTokens(")not note") == ")!note" + assert cpplint.ReplaceAlternateTokens("(not note") == "(!note" + assert cpplint.ReplaceAlternateTokens(" not(note)") == " !(note)" + assert cpplint.ReplaceAlternateTokens(" not (splinot)") == " !(splinot)" + assert cpplint.ReplaceAlternateTokens("tor and orc or android") == "tor && orc || android" + assert ( + cpplint.ReplaceAlternateTokens("tor or orc and ands not note") + == "tor || orc && ands !note" + ) + + def testSpacingAfterAlternateToken(self): + try: + cpplint._cpplint_state.AddFilters("-readability/alt_tokens") + self.TestLint("if (foo or (bar) or foobar) {", "") + self.TestLint("if (foo or (bar)) {", "") + self.TestLint("if ((foo) or (bar)) {", "") + self.TestLint("if (not foo) {", "") + self.TestLint("if (not (foo)) {", "") + self.TestLint("if (not(foo)) {", "") + self.TestLint( + "if ((foo)or(bar)) {", "Missing spaces around || [whitespace/operators] [3]" + ) + finally: + cpplint._cpplint_state.SetFilters("") + + def testSpacingBeforeBraces(self): + self.TestLint("if (foo){", "Missing space before { [whitespace/braces] [5]") + self.TestLint("for{", "Missing space before { [whitespace/braces] [5]") + self.TestLint("for {", "") + self.TestLint("EXPECT_DEBUG_DEATH({", "") + self.TestLint("std::is_convertible{}", "") + self.TestLint("blah{32}", "Missing space before { [whitespace/braces] [5]") + self.TestLint("int8_t{3}", "") + self.TestLint("int16_t{3}", "") + self.TestLint("int32_t{3}", "") + self.TestLint("uint64_t{12345}", "") + self.TestLint( + "constexpr int64_t kBatchGapMicros = int64_t{7} * 24 * 3600 * 1000000; // 1 wk.", "" + ) + self.TestLint("MoveOnly(int i1, int i2) : ip1{new int{i1}}, ip2{new int{i2}} {}", "") + + def testSemiColonAfterBraces(self): + self.TestLintContains( + "if (cond) { func(); };", "You don't need a ; after a } [readability/braces] [4]" + ) + self.TestLint("void Func() {};", "You don't need a ; after a } [readability/braces] [4]") + self.TestLint( + "void Func() const {};", "You don't need a ; after a } [readability/braces] [4]" + ) + self.TestLint("class X {};", "") + for keyword in ["struct", "union"]: + for align in ["", " alignas(16)"]: + for typename in ["", " X"]: + for identifier in ["", " x"]: + self.TestLint(keyword + align + typename + " {}" + identifier + ";", "") + + self.TestLint("class X : public Y {};", "") + self.TestLint("class X : public MACRO() {};", "") + self.TestLint("class X : public decltype(expr) {};", "") + self.TestLint("DEFINE_FACADE(PCQueue::Watcher, PCQueue) {};", "") + self.TestLint("VCLASS(XfaTest, XfaContextTest) {};", "") + self.TestLint("class STUBBY_CLASS(H, E) {};", "") + self.TestLint("class STUBBY2_CLASS(H, E) {};", "") + self.TestLint( + "TEST(TestCase, TestName) {};", "You don't need a ; after a } [readability/braces] [4]" + ) + self.TestLint( + "TEST_F(TestCase, TestName) {};", + "You don't need a ; after a } [readability/braces] [4]", + ) + + self.TestLint("file_tocs_[i] = (FileToc) {a, b, c};", "") + self.TestMultiLineLint("class X : public Y,\npublic Z {};", "") + self.TestMultiLineLint( + "template\nconcept Addable = requires(T x) { x + x; };", "" + ) + self.TestMultiLineLint( + "template \nconcept C = requires(T a, T b) {\n requires a == b;\n};", "" + ) + self.TestMultiLineLint( + "template \n" + "concept C = (std::integral || std::floating_point) &&\n" + " (std::integral || std::floating_point) &&\n" + " requires(T t, U u) {\n" + " std::min(static_cast(t), static_cast(u));\n" + "};", + "", + ) + + def testSpacingBeforeBrackets(self): + self.TestLint( + "int numbers [] = { 1, 2, 3 };", "Extra space before [ [whitespace/braces] [5]" + ) + # space allowed in some cases + self.TestLint("auto [abc, def] = func();", "") + self.TestLint("#define NODISCARD [[nodiscard]]", "") + self.TestLint("void foo(int param [[maybe_unused]]);", "") + + def testLambda(self): + self.TestLint("auto x = []() {};", "") + self.TestLint("return []() {};", "") + self.TestMultiLineLint("auto x = []() {\n};\n", "") + self.TestLint( + "int operator[](int x) {};", "You don't need a ; after a } [readability/braces] [4]" + ) + + self.TestMultiLineLint("auto x = [&a,\nb]() {};", "") + self.TestMultiLineLint("auto x = [&a,\nb]\n() {};", "") + self.TestMultiLineLint( + "auto x = [&a,\n" + " b](\n" + " int a,\n" + " int b) {\n" + " return a +\n" + " b;\n" + "};\n", + "", + ) + + # Avoid false positives with operator[] + self.TestLint("table_to_children[&*table].push_back(dependent);", "") + + def testBraceInitializerList(self): + self.TestLint("MyStruct p = {1, 2};", "") + self.TestLint("MyStruct p{1, 2};", "") + self.TestLint("vector p = {1, 2};", "") + self.TestLint("vector p{1, 2};", "") + self.TestLint("x = vector{1, 2};", "") + self.TestLint("x = (struct in_addr){ 0 };", "") + self.TestLint("Func(vector{1, 2})", "") + self.TestLint("Func((struct in_addr){ 0 })", "") + self.TestLint("Func(vector{1, 2}, 3)", "") + self.TestLint("Func((struct in_addr){ 0 }, 3)", "") + self.TestLint("LOG(INFO) << char{7};", "") + self.TestLint('LOG(INFO) << char{7} << "!";', "") + self.TestLint("int p[2] = {1, 2};", "") + self.TestLint("return {1, 2};", "") + self.TestLint("std::unique_ptr foo{new Foo{}};", "") + self.TestLint("auto foo = std::unique_ptr{new Foo{}};", "") + self.TestLint('static_assert(Max7String{}.IsValid(), "");', "") + self.TestLint("map_of_pairs[{1, 2}] = 3;", "") + self.TestLint("ItemView{has_offer() ? new Offer{offer()} : nullptr", "") + self.TestLint("template {}> = 0>", "") + + self.TestMultiLineLint("std::unique_ptr foo{\n new Foo{}\n};\n", "") + self.TestMultiLineLint( + "std::unique_ptr foo{\n new Foo{\n new Bar{}\n }\n};\n", "" + ) + self.TestMultiLineLint( + "if (true) {\n if (false){\n func();\n }}\n", + "Missing space before { [whitespace/braces] [5]", + ) + self.TestMultiLineLint( + "MyClass::MyClass()\n : initializer_{\n Func()} {\n}\n", "" + ) + self.TestLint( + "const pair kCL" + ("o" * 41) + "gStr[] = {\n", + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + self.TestMultiLineLint( + "const pair kCL" + ("o" * 40) + "ngStr[] =\n" + " {\n" + ' {"gooooo", "oooogle"},\n' + "};\n", + "", + ) + self.TestMultiLineLint( + "const pair kCL" + ("o" * 39) + "ngStr[] =\n" + " {\n" + ' {"gooooo", "oooogle"},\n' + "};\n", + "{ should almost always be at the end of the previous line [whitespace/braces] [4]", + ) + + def testSpacingAroundElse(self): + self.TestLint("}else {", "Missing space before else [whitespace/braces] [5]") + self.TestLint("} else{", "Missing space before { [whitespace/braces] [5]") + self.TestLint("} else {", "") + self.TestLint("} else if (foo) {", "") + + def testSpacingWithInitializerLists(self): + self.TestLint("int v[1][3] = {{1, 2, 3}};", "") + self.TestLint("int v[1][1] = {{0}};", "") + + def testSpacingForBinaryOps(self): + self.TestLint("if (foo||bar) {", "Missing spaces around || [whitespace/operators] [3]") + self.TestLint("if (foo<=bar) {", "Missing spaces around <= [whitespace/operators] [3]") + self.TestLint("if (foobar) {", "Missing spaces around > [whitespace/operators] [3]") + self.TestLint("if (foobaz) {", "Missing spaces around < [whitespace/operators] [3]") + self.TestLint("if (foobar) {", "Missing spaces around < [whitespace/operators] [3]") + self.TestLint("template", "") + self.TestLint("std::unique_ptr>", "") + self.TestLint("typedef hash_map", "") + self.TestLint("10<<20", "") + self.TestLint("10<>b", "Missing spaces around >> [whitespace/operators] [3]") + self.TestLint("10>>b", "Missing spaces around >> [whitespace/operators] [3]") + self.TestLint("LOG(ERROR)<<*foo", "Missing spaces around << [whitespace/operators] [3]") + self.TestLint("LOG(ERROR)<<&foo", "Missing spaces around << [whitespace/operators] [3]") + self.TestLint("StringCoder>::ToString()", "") + self.TestLint("map, map>::iterator", "") + self.TestLint("func>>()", "") + self.TestLint("MACRO1(list>)", "") + self.TestLint("MACRO2(list>, 42)", "") + self.TestLint("void DoFoo(const set>& arg1);", "") + self.TestLint("void SetFoo(set>* arg1);", "") + self.TestLint("foo = new set>;", "") + self.TestLint("reinterpret_cast>*>(a);", "") + self.TestLint("MACRO(<<)", "") + self.TestLint("MACRO(<<, arg)", "") + self.TestLint("MACRO(<<=)", "") + self.TestLint("MACRO(<<=, arg)", "") + + self.TestLint("using Vector3::operator==;", "") + self.TestLint("using Vector3::operator!=;", "") + + def testSpacingBeforeLastSemicolon(self): + self.TestLint( + "call_function() ;", + "Extra space before last semicolon. If this should be an " + "empty statement, use {} instead." + " [whitespace/semicolon] [5]", + ) + self.TestLint( + "while (true) ;", + "Extra space before last semicolon. If this should be an " + "empty statement, use {} instead." + " [whitespace/semicolon] [5]", + ) + self.TestLint( + "default:;", + "Semicolon defining empty statement. Use {} instead. [whitespace/semicolon] [5]", + ) + self.TestLint( + " ;", + "Line contains only semicolon. If this should be an empty " + "statement, use {} instead." + " [whitespace/semicolon] [5]", + ) + self.TestLint("for (int i = 0; ;", "") + + def testEmptyBlockBody(self): + self.TestLint( + "while (true);", + "Empty loop bodies should use {} or continue [whitespace/empty_loop_body] [5]", + ) + self.TestLint( + "if (true);", + "Empty conditional bodies should use {} [whitespace/empty_conditional_body] [5]", + ) + self.TestLint("while (true)", "") + self.TestLint("while (true) continue;", "") + self.TestLint( + "for (;;);", + "Empty loop bodies should use {} or continue [whitespace/empty_loop_body] [5]", + ) + self.TestLint("for (;;)", "") + self.TestLint("for (;;) continue;", "") + self.TestLint("for (;;) func();", "") + self.TestLint( + "if (test) {}", + "If statement had no body and no else clause [whitespace/empty_if_body] [4]", + ) + self.TestLint("if (test) func();", "") + self.TestLint("if (test) {} else {}", "") + self.TestMultiLineLint( + """while (true && false);""", - 'Empty loop bodies should use {} or continue' - ' [whitespace/empty_loop_body] [5]') - self.TestMultiLineLint("""do { + "Empty loop bodies should use {} or continue [whitespace/empty_loop_body] [5]", + ) + self.TestMultiLineLint( + """do { } while (false);""", - '') - self.TestMultiLineLint("""#define MACRO \\ + "", + ) + self.TestMultiLineLint( + """#define MACRO \\ do { \\ } while (false);""", - '') - self.TestMultiLineLint("""do { + "", + ) + self.TestMultiLineLint( + """do { } while (false); // next line gets a warning while (false);""", - 'Empty loop bodies should use {} or continue' - ' [whitespace/empty_loop_body] [5]') - self.TestMultiLineLint("""if (test) { + "Empty loop bodies should use {} or continue [whitespace/empty_loop_body] [5]", + ) + self.TestMultiLineLint( + """if (test) { }""", - 'If statement had no body and no else clause' - ' [whitespace/empty_if_body] [4]') - self.TestMultiLineLint("""if (test, + "If statement had no body and no else clause [whitespace/empty_if_body] [4]", + ) + self.TestMultiLineLint( + """if (test, func({})) { }""", - 'If statement had no body and no else clause' - ' [whitespace/empty_if_body] [4]') - self.TestMultiLineLint("""if (test) - func();""", '') - self.TestLint('if (test) { hello; }', - 'Controlled statements inside brackets of if clause should be on a separate line' - ' [whitespace/newline] [5]') - self.TestLint('if (test({})) { hello; }', - 'Controlled statements inside brackets of if clause should be on a separate line' - ' [whitespace/newline] [5]') - self.TestMultiLineLint("""if (test) { + "If statement had no body and no else clause [whitespace/empty_if_body] [4]", + ) + self.TestMultiLineLint( + """if (test) + func();""", + "", + ) + self.TestLint( + "if (test) { hello; }", + "Controlled statements inside brackets of if clause should be on a separate line" + " [whitespace/newline] [5]", + ) + self.TestLint( + "if (test({})) { hello; }", + "Controlled statements inside brackets of if clause should be on a separate line" + " [whitespace/newline] [5]", + ) + self.TestMultiLineLint( + """if (test) { func(); - }""", '') - self.TestMultiLineLint("""if (test) { + }""", + "", + ) + self.TestMultiLineLint( + """if (test) { // multiline // comment - }""", '') - self.TestMultiLineLint("""if (test) { // comment - }""", '') - self.TestMultiLineLint("""if (test) { + }""", + "", + ) + self.TestMultiLineLint( + """if (test) { // comment + }""", + "", + ) + self.TestMultiLineLint( + """if (test) { } else { - }""", '') - self.TestMultiLineLint("""if (func(p1, + }""", + "", + ) + self.TestMultiLineLint( + """if (func(p1, p2, p3)) { func(); - }""", '') - self.TestMultiLineLint("""if (func({}, p1)) { + }""", + "", + ) + self.TestMultiLineLint( + """if (func({}, p1)) { func(); - }""", '') - - def testSpacingForRangeBasedFor(self): - # Basic correctly formatted case: - self.TestLint('for (int i : numbers) {', '') - - # Missing space before colon: - self.TestLint('for (int i: numbers) {', - 'Missing space around colon in range-based for loop' - ' [whitespace/forcolon] [2]') - # Missing space after colon: - self.TestLint('for (int i :numbers) {', - 'Missing space around colon in range-based for loop' - ' [whitespace/forcolon] [2]') - # Missing spaces both before and after the colon. - self.TestLint('for (int i:numbers) {', - 'Missing space around colon in range-based for loop' - ' [whitespace/forcolon] [2]') - - # The scope operator '::' shouldn't cause warnings... - self.TestLint('for (std::size_t i : sizes) {}', '') - # ...but it shouldn't suppress them either. - self.TestLint('for (std::size_t i: sizes) {}', - 'Missing space around colon in range-based for loop' - ' [whitespace/forcolon] [2]') - - # Static or global STL strings. - def testStaticOrGlobalSTLStrings(self): - # A template for the error message for a const global/static string. - error_msg = ('For a static/global string constant, use a C style ' - 'string instead: "%s[]". [runtime/string] [4]') - # The error message for a non-const global/static string variable. - nonconst_error_msg = ('Static/global string variables are not permitted.' - ' [runtime/string] [4]') - - self.TestLint('string foo;', - nonconst_error_msg) - self.TestLint('string kFoo = "hello"; // English', - nonconst_error_msg) - self.TestLint('static string foo;', - nonconst_error_msg) - self.TestLint('static const string foo;', - error_msg % 'static const char foo') - self.TestLint('static const std::string foo;', - error_msg % 'static const char foo') - self.TestLint('string Foo::bar;', - nonconst_error_msg) - - self.TestLint('std::string foo;', - nonconst_error_msg) - self.TestLint('std::string kFoo = "hello"; // English', - nonconst_error_msg) - self.TestLint('static std::string foo;', - nonconst_error_msg) - self.TestLint('static const std::string foo;', - error_msg % 'static const char foo') - self.TestLint('std::string Foo::bar;', - nonconst_error_msg) - - self.TestLint('::std::string foo;', - nonconst_error_msg) - self.TestLint('::std::string kFoo = "hello"; // English', - nonconst_error_msg) - self.TestLint('static ::std::string foo;', - nonconst_error_msg) - self.TestLint('static const ::std::string foo;', - error_msg % 'static const char foo') - self.TestLint('::std::string Foo::bar;', - nonconst_error_msg) - - self.TestLint('string* pointer', '') - self.TestLint('string *pointer', '') - self.TestLint('string* pointer = Func();', '') - self.TestLint('string *pointer = Func();', '') - self.TestLint('const string* pointer', '') - self.TestLint('const string *pointer', '') - self.TestLint('const string* pointer = Func();', '') - self.TestLint('const string *pointer = Func();', '') - self.TestLint('string const* pointer', '') - self.TestLint('string const *pointer', '') - self.TestLint('string const* pointer = Func();', '') - self.TestLint('string const *pointer = Func();', '') - self.TestLint('string* const pointer', '') - self.TestLint('string *const pointer', '') - self.TestLint('string* const pointer = Func();', '') - self.TestLint('string *const pointer = Func();', '') - self.TestLint('string Foo::bar() {}', '') - self.TestLint('string Foo::operator*() {}', '') - # Rare case. - self.TestLint('string foo("foobar");', nonconst_error_msg) - # Should not catch local or member variables. - self.TestLint(' string foo', '') - # Should not catch functions. - self.TestLint('string EmptyString() { return ""; }', '') - self.TestLint('string EmptyString () { return ""; }', '') - self.TestLint('string const& FileInfo::Pathname() const;', '') - self.TestLint('string const &FileInfo::Pathname() const;', '') - self.TestLint('string VeryLongNameFunctionSometimesEndsWith(\n' - ' VeryLongNameType very_long_name_variable) {}', '') - self.TestLint('template<>\n' - 'string FunctionTemplateSpecialization(\n' - ' int x) { return ""; }', '') - self.TestLint('template<>\n' - 'string FunctionTemplateSpecialization* >(\n' - ' int x) { return ""; }', '') - - # should not catch methods of template classes. - self.TestLint('string Class::Method() const {\n' - ' return "";\n' - '}\n', '') - self.TestLint('string Class::Method(\n' - ' int arg) const {\n' - ' return "";\n' - '}\n', '') - - # Check multiline cases. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['// Copyright 2014 Your Company.', - '#include ', - 'string Class', - '::MemberFunction1();', - 'string Class::', - 'MemberFunction2();', - 'string Class::', - 'NestedClass::MemberFunction3();', - 'string TemplateClass::', - 'NestedClass::MemberFunction4();', - 'const string Class', - '::static_member_variable1;', - 'const string Class::', - 'static_member_variable2;', - 'const string Class', - '::static_member_variable3 = "initial value";', - 'const string Class::', - 'static_member_variable4 = "initial value";', - 'string Class::', - 'static_member_variable5;', - ''], - error_collector) - self.assertEqual(error_collector.Results(), - [error_msg % 'const char Class::static_member_variable1', - error_msg % 'const char Class::static_member_variable2', - error_msg % 'const char Class::static_member_variable3', - error_msg % 'const char Class::static_member_variable4', - nonconst_error_msg]) - - def testNoSpacesInFunctionCalls(self): - self.TestLint('TellStory(1, 3);', - '') - self.TestLint('TellStory(1, 3 );', - 'Extra space before )' - ' [whitespace/parens] [2]') - self.TestLint('TellStory(1 /* wolf */, 3 /* pigs */);', - '') - self.TestMultiLineLint("""TellStory(1, 3 + }""", + "", + ) + + def testSpacingForRangeBasedFor(self): + # Basic correctly formatted case: + self.TestLint("for (int i : numbers) {", "") + + # Missing space before colon: + self.TestLint( + "for (int i: numbers) {", + "Missing space around colon in range-based for loop [whitespace/forcolon] [2]", + ) + # Missing space after colon: + self.TestLint( + "for (int i :numbers) {", + "Missing space around colon in range-based for loop [whitespace/forcolon] [2]", + ) + # Missing spaces both before and after the colon. + self.TestLint( + "for (int i:numbers) {", + "Missing space around colon in range-based for loop [whitespace/forcolon] [2]", + ) + + # The scope operator '::' shouldn't cause warnings... + self.TestLint("for (std::size_t i : sizes) {}", "") + # ...but it shouldn't suppress them either. + self.TestLint( + "for (std::size_t i: sizes) {}", + "Missing space around colon in range-based for loop [whitespace/forcolon] [2]", + ) + + # Static or global STL strings. + def testStaticOrGlobalSTLStrings(self): + # A template for the error message for a const global/static string. + error_msg = ( + "For a static/global string constant, use a C style " + 'string instead: "%s[]". [runtime/string] [4]' + ) + # The error message for a non-const global/static string variable. + nonconst_error_msg = ( + "Static/global string variables are not permitted. [runtime/string] [4]" + ) + + self.TestLint("string foo;", nonconst_error_msg) + self.TestLint('string kFoo = "hello"; // English', nonconst_error_msg) + self.TestLint("static string foo;", nonconst_error_msg) + self.TestLint("static const string foo;", error_msg % "static const char foo") + self.TestLint("static const std::string foo;", error_msg % "static const char foo") + self.TestLint("string Foo::bar;", nonconst_error_msg) + + self.TestLint("std::string foo;", nonconst_error_msg) + self.TestLint('std::string kFoo = "hello"; // English', nonconst_error_msg) + self.TestLint("static std::string foo;", nonconst_error_msg) + self.TestLint("static const std::string foo;", error_msg % "static const char foo") + self.TestLint("std::string Foo::bar;", nonconst_error_msg) + + self.TestLint("::std::string foo;", nonconst_error_msg) + self.TestLint('::std::string kFoo = "hello"; // English', nonconst_error_msg) + self.TestLint("static ::std::string foo;", nonconst_error_msg) + self.TestLint("static const ::std::string foo;", error_msg % "static const char foo") + self.TestLint("::std::string Foo::bar;", nonconst_error_msg) + + self.TestLint("string* pointer", "") + self.TestLint("string *pointer", "") + self.TestLint("string* pointer = Func();", "") + self.TestLint("string *pointer = Func();", "") + self.TestLint("const string* pointer", "") + self.TestLint("const string *pointer", "") + self.TestLint("const string* pointer = Func();", "") + self.TestLint("const string *pointer = Func();", "") + self.TestLint("string const* pointer", "") + self.TestLint("string const *pointer", "") + self.TestLint("string const* pointer = Func();", "") + self.TestLint("string const *pointer = Func();", "") + self.TestLint("string* const pointer", "") + self.TestLint("string *const pointer", "") + self.TestLint("string* const pointer = Func();", "") + self.TestLint("string *const pointer = Func();", "") + self.TestLint("string Foo::bar() {}", "") + self.TestLint("string Foo::operator*() {}", "") + # Rare case. + self.TestLint('string foo("foobar");', nonconst_error_msg) + # Should not catch local or member variables. + self.TestLint(" string foo", "") + # Should not catch functions. + self.TestLint('string EmptyString() { return ""; }', "") + self.TestLint('string EmptyString () { return ""; }', "") + self.TestLint("string const& FileInfo::Pathname() const;", "") + self.TestLint("string const &FileInfo::Pathname() const;", "") + self.TestLint( + "string VeryLongNameFunctionSometimesEndsWith(\n" + " VeryLongNameType very_long_name_variable) {}", + "", + ) + self.TestLint( + "template<>\n" + "string FunctionTemplateSpecialization(\n" + ' int x) { return ""; }', + "", + ) + self.TestLint( + "template<>\n" + "string FunctionTemplateSpecialization* >(\n" + ' int x) { return ""; }', + "", + ) + + # should not catch methods of template classes. + self.TestLint('string Class::Method() const {\n return "";\n}\n', "") + self.TestLint('string Class::Method(\n int arg) const {\n return "";\n}\n', "") + + # Check multiline cases. + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "#include ", + "string Class", + "::MemberFunction1();", + "string Class::", + "MemberFunction2();", + "string Class::", + "NestedClass::MemberFunction3();", + "string TemplateClass::", + "NestedClass::MemberFunction4();", + "const string Class", + "::static_member_variable1;", + "const string Class::", + "static_member_variable2;", + "const string Class", + '::static_member_variable3 = "initial value";', + "const string Class::", + 'static_member_variable4 = "initial value";', + "string Class::", + "static_member_variable5;", + "", + ], + error_collector, + ) + assert error_collector.Results() == [ + error_msg % "const char Class::static_member_variable1", + error_msg % "const char Class::static_member_variable2", + error_msg % "const char Class::static_member_variable3", + error_msg % "const char Class::static_member_variable4", + nonconst_error_msg, + ] + + def testNoSpacesInFunctionCalls(self): + self.TestLint("TellStory(1, 3);", "") + self.TestLint("TellStory(1, 3 );", "Extra space before ) [whitespace/parens] [2]") + self.TestLint("TellStory(1 /* wolf */, 3 /* pigs */);", "") + self.TestMultiLineLint( + """TellStory(1, 3 );""", - 'Closing ) should be moved to the previous line' - ' [whitespace/parens] [2]') - self.TestMultiLineLint("""TellStory(Wolves(1), + "Closing ) should be moved to the previous line [whitespace/parens] [2]", + ) + self.TestMultiLineLint( + """TellStory(Wolves(1), Pigs(3 ));""", - 'Closing ) should be moved to the previous line' - ' [whitespace/parens] [2]') - self.TestMultiLineLint("""TellStory(1, + "Closing ) should be moved to the previous line [whitespace/parens] [2]", + ) + self.TestMultiLineLint( + """TellStory(1, 3 );""", - 'Extra space before )' - ' [whitespace/parens] [2]') - - def testToDoComments(self): - start_space = ('Too many spaces before TODO' - ' [whitespace/todo] [2]') - missing_username = ('Missing username in TODO; it should look like ' - '"// TODO(my_username): Stuff."' - ' [readability/todo] [2]') - end_space = ('TODO(my_username) should be followed by a space' - ' [whitespace/todo] [2]') - - self.TestLint('// TODOfix this', - [start_space, missing_username, end_space]) - self.TestLint('// TODO(ljenkins)fix this', - [start_space, end_space]) - self.TestLint('// TODO fix this', - [start_space, missing_username]) - self.TestLint('// TODO fix this', missing_username) - self.TestLint('// TODO: fix this', missing_username) - self.TestLint('//TODO(ljenkins): Fix this', - 'Should have a space between // and comment' - ' [whitespace/comments] [4]') - self.TestLint('// TODO(ljenkins):Fix this', end_space) - self.TestLint('// TODO(ljenkins):', '') - self.TestLint('// TODO(ljenkins): fix this', '') - self.TestLint('// TODO(ljenkins): Fix this', '') - self.TestLint('#if 1 // TEST_URLTODOCID_WHICH_HAS_THAT_WORD_IN_IT_H_', '') - self.TestLint('// See also similar TODO above', '') - self.TestLint(r'EXPECT_EQ("\\", ' - r'NormalizePath("/./../foo///bar/..//x/../..", ""));', - '') - - def testTwoSpacesBetweenCodeAndComments(self): - self.TestLint('} // namespace foo', - 'At least two spaces is best between code and comments' - ' [whitespace/comments] [2]') - self.TestLint('}// namespace foo', - 'At least two spaces is best between code and comments' - ' [whitespace/comments] [2]') - self.TestLint('printf("foo"); // Outside quotes.', - 'At least two spaces is best between code and comments' - ' [whitespace/comments] [2]') - self.TestLint('int i = 0; // Having two spaces is fine.', '') - self.TestLint('int i = 0; // Having three spaces is OK.', '') - self.TestLint('// Top level comment', '') - self.TestLint(' // Line starts with two spaces.', '') - self.TestMultiLineLint('void foo() {\n' - ' { // A scope is opening.\n' - ' int a;', '') - self.TestMultiLineLint('void foo() {\n' - ' { // A scope is opening.\n' - '#define A a', - 'At least two spaces is best between code and ' - 'comments [whitespace/comments] [2]') - self.TestMultiLineLint(' foo();\n' - ' { // An indented scope is opening.\n' - ' int a;', '') - self.TestMultiLineLint('vector my_elements = {// first\n' - ' 1,', '') - self.TestMultiLineLint('vector my_elements = {// my_elements is ..\n' - ' 1,', - 'At least two spaces is best between code and ' - 'comments [whitespace/comments] [2]') - self.TestLint('if (foo) { // not a pure scope; comment is too close!', - 'At least two spaces is best between code and comments' - ' [whitespace/comments] [2]') - self.TestLint('printf("// In quotes.")', '') - self.TestLint('printf("\\"%s // In quotes.")', '') - self.TestLint('printf("%s", "// In quotes.")', '') - - def testSpaceAfterCommentMarker(self): - self.TestLint('//', '') - self.TestLint('//x', 'Should have a space between // and comment' - ' [whitespace/comments] [4]') - self.TestLint('// x', '') - self.TestLint('///', '') - self.TestLint('/// x', '') - self.TestLint('//!', '') - self.TestLint('//----', '') - self.TestLint('//====', '') - self.TestLint('//////', '') - self.TestLint('////// x', '') - self.TestLint('///< x', '') # After-member Doxygen comment - self.TestLint('//!< x', '') # After-member Doxygen comment - self.TestLint('////x', 'Should have a space between // and comment' - ' [whitespace/comments] [4]') - self.TestLint('//}', '') - self.TestLint('//}x', 'Should have a space between // and comment' - ' [whitespace/comments] [4]') - self.TestLint('//!, ', - ' class B = piyo, ', - ' class C = fuga >', - 'class D {', - ' public:', - '};', - '', '', '', '', - '}'], - error_collector) - self.assertEqual(0, error_collector.Results().count( - 'Redundant blank line at the end of a code block should be deleted.' - ' [whitespace/blank_line] [3]')) - - def testAllowBlankLineBeforeIfElseChain(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['if (hoge) {', - '', # No warning - '} else if (piyo) {', - '', # No warning - '} else if (piyopiyo) {', - ' hoge = true;', # No warning - '} else {', - '', # Warning on this line - '}'], - error_collector) - self.assertEqual(1, error_collector.Results().count( - 'Redundant blank line at the end of a code block should be deleted.' - ' [whitespace/blank_line] [3]')) - - def testAllowBlankLineAfterExtern(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['extern "C" {', - '', - 'EXPORTAPI void APICALL Some_function() {}', - '', - '}'], - error_collector) - self.assertEqual(0, error_collector.Results().count( - 'Redundant blank line at the start of a code block should be deleted.' - ' [whitespace/blank_line] [2]')) - self.assertEqual(0, error_collector.Results().count( - 'Redundant blank line at the end of a code block should be deleted.' - ' [whitespace/blank_line] [3]')) - - def testBlankLineBeforeSectionKeyword(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['class A {', - ' public:', - ' protected:', # warning 1 - ' private:', # warning 2 - ' struct B {', - ' public:', - ' private:'] + # warning 3 - ([''] * 100) + # Make A and B longer than 100 lines - [' };', - ' struct C {', - ' protected:', - ' private:', # C is too short for warnings - ' };', - '};', - 'class D', - ' : public {', - ' public:', # no warning - '};', - 'class E {\\', - ' public:\\'] + - (['\\'] * 100) + # Makes E > 100 lines - [' int non_empty_line;\\', - ' private:\\', # no warning - ' int a;\\', - '};'], - error_collector) - self.assertEqual(2, error_collector.Results().count( - '"private:" should be preceded by a blank line' - ' [whitespace/blank_line] [3]')) - self.assertEqual(1, error_collector.Results().count( - '"protected:" should be preceded by a blank line' - ' [whitespace/blank_line] [3]')) - - def testNoBlankLineAfterSectionKeyword(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['class A {', - ' public:', - '', # warning 1 - ' private:', - '', # warning 2 - ' struct B {', - ' protected:', - '', # warning 3 - ' };', - '};'], - error_collector) - self.assertEqual(1, error_collector.Results().count( - 'Do not leave a blank line after "public:"' - ' [whitespace/blank_line] [3]')) - self.assertEqual(1, error_collector.Results().count( - 'Do not leave a blank line after "protected:"' - ' [whitespace/blank_line] [3]')) - self.assertEqual(1, error_collector.Results().count( - 'Do not leave a blank line after "private:"' - ' [whitespace/blank_line] [3]')) - - def testAllowBlankLinesInRawStrings(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['// Copyright 2014 Your Company.', - 'static const char *kData[] = {R"(', - '', - ')", R"(', - '', - ')"};', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - - def testElseOnSameLineAsClosingBraces(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['if (hoge) {', - '}', - 'else if (piyo) {', # Warning on this line - '}', - ' else {' # Warning on this line - '', - '}'], - error_collector) - self.assertEqual(2, error_collector.Results().count( - 'An else should appear on the same line as the preceding }' - ' [whitespace/newline] [4]')) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['if (hoge) {', - '', - '}', - 'else', # Warning on this line - '{', - '', - '}'], - error_collector) - self.assertEqual(1, error_collector.Results().count( - 'An else should appear on the same line as the preceding }' - ' [whitespace/newline] [4]')) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['if (hoge) {', - '', - '}', - 'else_function();'], - error_collector) - self.assertEqual(0, error_collector.Results().count( - 'An else should appear on the same line as the preceding }' - ' [whitespace/newline] [4]')) - - def testMultipleStatementsOnSameLine(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['for (int i = 0; i < 1; i++) {}', - 'switch (x) {', - ' case 0: func(); break; ', - '}', - 'sum += MathUtil::SafeIntRound(x); x += 0.1;'], - error_collector) - self.assertEqual(0, error_collector.Results().count( - 'More than one command on the same line [whitespace/newline] [0]')) - - old_verbose_level = cpplint._cpplint_state.verbose_level - cpplint._cpplint_state.verbose_level = 0 - cpplint.ProcessFileData('foo.cc', 'cc', - ['sum += MathUtil::SafeIntRound(x); x += 0.1;'], - error_collector) - cpplint._cpplint_state.verbose_level = old_verbose_level - - def testLambdasOnSameLine(self): - error_collector = ErrorCollector(self.assertTrue) - old_verbose_level = cpplint._cpplint_state.verbose_level - cpplint._cpplint_state.verbose_level = 0 - cpplint.ProcessFileData('foo.cc', 'cc', - ['const auto lambda = ' - '[](const int i) { return i; };'], - error_collector) - cpplint._cpplint_state.verbose_level = old_verbose_level - self.assertEqual(0, error_collector.Results().count( - 'More than one command on the same line [whitespace/newline] [0]')) - - error_collector = ErrorCollector(self.assertTrue) - old_verbose_level = cpplint._cpplint_state.verbose_level - cpplint._cpplint_state.verbose_level = 0 - cpplint.ProcessFileData('foo.cc', 'cc', - ['const auto result = std::any_of(vector.begin(), ' - 'vector.end(), ' - '[](const int i) { return i > 0; });'], - error_collector) - cpplint._cpplint_state.verbose_level = old_verbose_level - self.assertEqual(0, error_collector.Results().count( - 'More than one command on the same line [whitespace/newline] [0]')) - - error_collector = ErrorCollector(self.assertTrue) - old_verbose_level = cpplint._cpplint_state.verbose_level - cpplint._cpplint_state.verbose_level = 0 - cpplint.ProcessFileData('foo.cc', 'cc', - ['return mutex::Lock([this]() { ' - 'this->ReadLock(); }, [this]() { ' - 'this->ReadUnlock(); });'], - error_collector) - cpplint._cpplint_state.verbose_level = old_verbose_level - self.assertEqual(0, error_collector.Results().count( - 'More than one command on the same line [whitespace/newline] [0]')) - - error_collector = ErrorCollector(self.assertTrue) - old_verbose_level = cpplint._cpplint_state.verbose_level - cpplint._cpplint_state.verbose_level = 0 - cpplint.ProcessFileData('foo.cc', 'cc', - ['return mutex::Lock([this]() { ' - 'this->ReadLock(); }, [this]() { ' - 'this->ReadUnlock(); }, object);'], - error_collector) - cpplint._cpplint_state.verbose_level = old_verbose_level - self.assertEqual(0, error_collector.Results().count( - 'More than one command on the same line [whitespace/newline] [0]')) - - def testEndOfNamespaceComments(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('foo.cc', 'cc', - ['namespace {', - '', - '}', # No warning (too short) - 'namespace expected {', - '} // namespace mismatched', # Warning here - 'namespace {', - '} // namespace mismatched', # Warning here - 'namespace outer { namespace nested {'] + - ([''] * 10) + - ['}', # Warning here - '}', # Warning here - 'namespace {'] + - ([''] * 10) + - ['}', # Warning here - 'namespace {'] + - ([''] * 10) + - ['} // namespace some description', # Anon warning - 'namespace {'] + - ([''] * 10) + - ['} // namespace anonymous', # Variant warning - 'namespace {'] + - ([''] * 10) + - ['} // anonymous namespace (utils)', # Variant - 'namespace {'] + - ([''] * 10) + - ['} // anonymous namespace', # No warning - 'namespace missing_comment {'] + - ([''] * 10) + - ['}', # Warning here - 'namespace no_warning {'] + - ([''] * 10) + - ['} // namespace no_warning', - 'namespace no_warning {'] + - ([''] * 10) + - ['}; // end namespace no_warning', - '#define MACRO \\', - 'namespace c_style { \\'] + - (['\\'] * 10) + - ['} /* namespace c_style. */ \\', - ';'], - error_collector) - self.assertEqual(1, error_collector.Results().count( - 'Namespace should be terminated with "// namespace expected"' - ' [readability/namespace] [5]')) - self.assertEqual(1, error_collector.Results().count( - 'Namespace should be terminated with "// namespace outer"' - ' [readability/namespace] [5]')) - self.assertEqual(1, error_collector.Results().count( - 'Namespace should be terminated with "// namespace nested"' - ' [readability/namespace] [5]')) - self.assertEqual(3, error_collector.Results().count( - 'Anonymous namespace should be terminated with "// namespace"' - ' [readability/namespace] [5]')) - self.assertEqual(2, error_collector.Results().count( - 'Anonymous namespace should be terminated with "// namespace" or' - ' "// anonymous namespace"' - ' [readability/namespace] [5]')) - self.assertEqual(1, error_collector.Results().count( - 'Namespace should be terminated with "// namespace missing_comment"' - ' [readability/namespace] [5]')) - self.assertEqual(0, error_collector.Results().count( - 'Namespace should be terminated with "// namespace no_warning"' - ' [readability/namespace] [5]')) - - def testComma(self): - self.TestLint('a = f(1,2);', - 'Missing space after , [whitespace/comma] [3]') - self.TestLint('int tmp=a,a=b,b=tmp;', - ['Missing spaces around = [whitespace/operators] [4]', - 'Missing space after , [whitespace/comma] [3]']) - self.TestLint('f(a, /* name */ b);', '') - self.TestLint('f(a, /* name */b);', '') - self.TestLint('f(a, /* name */-1);', '') - self.TestLint('f(a, /* name */"1");', '') - self.TestLint('f(1, /* empty macro arg */, 2)', '') - self.TestLint('f(1,, 2)', '') - self.TestLint('operator,()', '') - self.TestLint('operator,(a,b)', - 'Missing space after , [whitespace/comma] [3]') - self.TestLint('__VA_OPT__(,)', '') - self.TestLint('__VA_OPT__ (,)', - 'Extra space before ( in function call [whitespace/parens] [4]') - - def testEqualsOperatorSpacing(self): - self.TestLint('int tmp= a;', - 'Missing spaces around = [whitespace/operators] [4]') - self.TestLint('int tmp =a;', - 'Missing spaces around = [whitespace/operators] [4]') - self.TestLint('int tmp=a;', - 'Missing spaces around = [whitespace/operators] [4]') - self.TestLint('int tmp= 7;', - 'Missing spaces around = [whitespace/operators] [4]') - self.TestLint('int tmp =7;', - 'Missing spaces around = [whitespace/operators] [4]') - self.TestLint('int tmp=7;', - 'Missing spaces around = [whitespace/operators] [4]') - self.TestLint('int* tmp=*p;', - 'Missing spaces around = [whitespace/operators] [4]') - self.TestLint('int* tmp= *p;', - 'Missing spaces around = [whitespace/operators] [4]') - self.TestMultiLineLint( - TrimExtraIndent(''' + "Extra space before ) [whitespace/parens] [2]", + ) + + def testToDoComments(self): + start_space = "Too many spaces before TODO [whitespace/todo] [2]" + missing_username = ( + "Missing username in TODO; it should look like " + '"// TODO(my_username): Stuff."' + " [readability/todo] [2]" + ) + end_space = "TODO(my_username) should be followed by a space [whitespace/todo] [2]" + + self.TestLint("// TODOfix this", [start_space, missing_username, end_space]) + self.TestLint("// TODO(ljenkins)fix this", [start_space, end_space]) + self.TestLint("// TODO fix this", [start_space, missing_username]) + self.TestLint("// TODO fix this", missing_username) + self.TestLint("// TODO: fix this", missing_username) + self.TestLint( + "//TODO(ljenkins): Fix this", + "Should have a space between // and comment [whitespace/comments] [4]", + ) + self.TestLint("// TODO(ljenkins):Fix this", end_space) + self.TestLint("// TODO(ljenkins):", "") + self.TestLint("// TODO(ljenkins): fix this", "") + self.TestLint("// TODO(ljenkins): Fix this", "") + self.TestLint("#if 1 // TEST_URLTODOCID_WHICH_HAS_THAT_WORD_IN_IT_H_", "") + self.TestLint("// See also similar TODO above", "") + self.TestLint( + r'EXPECT_EQ("\\", ' + r'NormalizePath("/./../foo///bar/..//x/../..", ""));', + "", + ) + + def testTwoSpacesBetweenCodeAndComments(self): + self.TestLint( + "} // namespace foo", + "At least two spaces is best between code and comments [whitespace/comments] [2]", + ) + self.TestLint( + "}// namespace foo", + "At least two spaces is best between code and comments [whitespace/comments] [2]", + ) + self.TestLint( + 'printf("foo"); // Outside quotes.', + "At least two spaces is best between code and comments [whitespace/comments] [2]", + ) + self.TestLint("int i = 0; // Having two spaces is fine.", "") + self.TestLint("int i = 0; // Having three spaces is OK.", "") + self.TestLint("// Top level comment", "") + self.TestLint(" // Line starts with two spaces.", "") + self.TestMultiLineLint("void foo() {\n { // A scope is opening.\n int a;", "") + self.TestMultiLineLint( + "void foo() {\n { // A scope is opening.\n#define A a", + "At least two spaces is best between code and comments [whitespace/comments] [2]", + ) + self.TestMultiLineLint(" foo();\n { // An indented scope is opening.\n int a;", "") + self.TestMultiLineLint( + "vector my_elements = {// first\n 1,", "" + ) + self.TestMultiLineLint( + "vector my_elements = {// my_elements is ..\n 1,", + "At least two spaces is best between code and comments [whitespace/comments] [2]", + ) + self.TestLint( + "if (foo) { // not a pure scope; comment is too close!", + "At least two spaces is best between code and comments [whitespace/comments] [2]", + ) + self.TestLint('printf("// In quotes.")', "") + self.TestLint('printf("\\"%s // In quotes.")', "") + self.TestLint('printf("%s", "// In quotes.")', "") + + def testSpaceAfterCommentMarker(self): + self.TestLint("//", "") + self.TestLint( + "//x", "Should have a space between // and comment [whitespace/comments] [4]" + ) + self.TestLint("// x", "") + self.TestLint("///", "") + self.TestLint("/// x", "") + self.TestLint("//!", "") + self.TestLint("//----", "") + self.TestLint("//====", "") + self.TestLint("//////", "") + self.TestLint("////// x", "") + self.TestLint("///< x", "") # After-member Doxygen comment + self.TestLint("//!< x", "") # After-member Doxygen comment + self.TestLint( + "////x", "Should have a space between // and comment [whitespace/comments] [4]" + ) + self.TestLint("//}", "") + self.TestLint( + "//}x", "Should have a space between // and comment [whitespace/comments] [4]" + ) + self.TestLint( + "//!, ", + " class B = piyo, ", + " class C = fuga >", + "class D {", + " public:", + "};", + "", + "", + "", + "", + "}", + ], + error_collector, + ) + assert ( + error_collector.Results().count( + "Redundant blank line at the end of a code block should be deleted. " + "[whitespace/blank_line] [3]" + ) + == 0 + ) + + def testAllowBlankLineBeforeIfElseChain(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "if (hoge) {", + "", # No warning + "} else if (piyo) {", + "", # No warning + "} else if (piyopiyo) {", + " hoge = true;", # No warning + "} else {", + "", # Warning on this line + "}", + ], + error_collector, + ) + assert ( + error_collector.Results().count( + "Redundant blank line at the end of a code block should be deleted. " + "[whitespace/blank_line] [3]" + ) + == 1 + ) + + def testAllowBlankLineAfterExtern(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + ['extern "C" {', "", "EXPORTAPI void APICALL Some_function() {}", "", "}"], + error_collector, + ) + assert ( + error_collector.Results().count( + "Redundant blank line at the start of a code block should be deleted. " + "[whitespace/blank_line] [2]" + ) + == 0 + ) + assert ( + error_collector.Results().count( + "Redundant blank line at the end of a code block should be deleted. " + "[whitespace/blank_line] [3]" + ) + == 0 + ) + + def testBlankLineBeforeSectionKeyword(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "class A {", + " public:", + " protected:", # warning 1 + " private:", # warning 2 + " struct B {", + " public:", + " private:", + ] # warning 3 + + ([""] * 100) # Make A and B longer than 100 lines + + [ + " };", + " struct C {", + " protected:", + " private:", # C is too short for warnings + " };", + "};", + "class D", + " : public {", + " public:", # no warning + "};", + "class E {\\", + " public:\\", + ] + + (["\\"] * 100) # Makes E > 100 lines + + [ + " int non_empty_line;\\", + " private:\\", # no warning + " int a;\\", + "};", + ], + error_collector, + ) + assert ( + error_collector.Results().count( + '"private:" should be preceded by a blank line [whitespace/blank_line] [3]' + ) + == 2 + ) + assert ( + error_collector.Results().count( + '"protected:" should be preceded by a blank line [whitespace/blank_line] [3]' + ) + == 1 + ) + + def testNoBlankLineAfterSectionKeyword(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "class A {", + " public:", + "", # warning 1 + " private:", + "", # warning 2 + " struct B {", + " protected:", + "", # warning 3 + " };", + "};", + ], + error_collector, + ) + assert ( + error_collector.Results().count( + 'Do not leave a blank line after "public:" [whitespace/blank_line] [3]' + ) + == 1 + ) + assert ( + error_collector.Results().count( + 'Do not leave a blank line after "protected:" [whitespace/blank_line] [3]' + ) + == 1 + ) + assert ( + error_collector.Results().count( + 'Do not leave a blank line after "private:" [whitespace/blank_line] [3]' + ) + == 1 + ) + + def testAllowBlankLinesInRawStrings(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + 'static const char *kData[] = {R"(', + "", + ')", R"(', + "", + ')"};', + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + + def testElseOnSameLineAsClosingBraces(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "if (hoge) {", + "}", + "else if (piyo) {", # Warning on this line + "}", + " else {" # Warning on this line + "", + "}", + ], + error_collector, + ) + assert ( + error_collector.Results().count( + "An else should appear on the same line as the preceding } " + "[whitespace/newline] [4]" + ) + == 2 + ) + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "if (hoge) {", + "", + "}", + "else", # Warning on this line + "{", + "", + "}", + ], + error_collector, + ) + assert ( + error_collector.Results().count( + "An else should appear on the same line as the preceding } " + "[whitespace/newline] [4]" + ) + == 1 + ) + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", "cc", ["if (hoge) {", "", "}", "else_function();"], error_collector + ) + assert ( + error_collector.Results().count( + "An else should appear on the same line as the preceding } " + "[whitespace/newline] [4]" + ) + == 0 + ) + + def testMultipleStatementsOnSameLine(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "for (int i = 0; i < 1; i++) {}", + "switch (x) {", + " case 0: func(); break; ", + "}", + "sum += MathUtil::SafeIntRound(x); x += 0.1;", + ], + error_collector, + ) + assert ( + error_collector.Results().count( + "More than one command on the same line [whitespace/newline] [0]" + ) + == 0 + ) + + old_verbose_level = cpplint._cpplint_state.verbose_level + cpplint._cpplint_state.verbose_level = 0 + cpplint.ProcessFileData( + "foo.cc", "cc", ["sum += MathUtil::SafeIntRound(x); x += 0.1;"], error_collector + ) + cpplint._cpplint_state.verbose_level = old_verbose_level + + def testLambdasOnSameLine(self): + error_collector = ErrorCollector(self.assertTrue) + old_verbose_level = cpplint._cpplint_state.verbose_level + cpplint._cpplint_state.verbose_level = 0 + cpplint.ProcessFileData( + "foo.cc", "cc", ["const auto lambda = [](const int i) { return i; };"], error_collector + ) + cpplint._cpplint_state.verbose_level = old_verbose_level + assert ( + error_collector.Results().count( + "More than one command on the same line [whitespace/newline] [0]" + ) + == 0 + ) + + error_collector = ErrorCollector(self.assertTrue) + old_verbose_level = cpplint._cpplint_state.verbose_level + cpplint._cpplint_state.verbose_level = 0 + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "const auto result = std::any_of(vector.begin(), " + "vector.end(), " + "[](const int i) { return i > 0; });" + ], + error_collector, + ) + cpplint._cpplint_state.verbose_level = old_verbose_level + assert ( + error_collector.Results().count( + "More than one command on the same line [whitespace/newline] [0]" + ) + == 0 + ) + + error_collector = ErrorCollector(self.assertTrue) + old_verbose_level = cpplint._cpplint_state.verbose_level + cpplint._cpplint_state.verbose_level = 0 + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "return mutex::Lock([this]() { " + "this->ReadLock(); }, [this]() { " + "this->ReadUnlock(); });" + ], + error_collector, + ) + cpplint._cpplint_state.verbose_level = old_verbose_level + assert ( + error_collector.Results().count( + "More than one command on the same line [whitespace/newline] [0]" + ) + == 0 + ) + + error_collector = ErrorCollector(self.assertTrue) + old_verbose_level = cpplint._cpplint_state.verbose_level + cpplint._cpplint_state.verbose_level = 0 + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "return mutex::Lock([this]() { " + "this->ReadLock(); }, [this]() { " + "this->ReadUnlock(); }, object);" + ], + error_collector, + ) + cpplint._cpplint_state.verbose_level = old_verbose_level + assert ( + error_collector.Results().count( + "More than one command on the same line [whitespace/newline] [0]" + ) + == 0 + ) + + def testEndOfNamespaceComments(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "namespace {", + "", + "}", # No warning (too short) + "namespace expected {", + "} // namespace mismatched", # Warning here + "namespace {", + "} // namespace mismatched", # Warning here + "namespace outer { namespace nested {", + ] + + ([""] * 10) + + [ + "}", # Warning here + "}", # Warning here + "namespace {", + ] + + ([""] * 10) + + [ + "}", # Warning here + "namespace {", + ] + + ([""] * 10) + + [ + "} // namespace some description", # Anon warning + "namespace {", + ] + + ([""] * 10) + + [ + "} // namespace anonymous", # Variant warning + "namespace {", + ] + + ([""] * 10) + + [ + "} // anonymous namespace (utils)", # Variant + "namespace {", + ] + + ([""] * 10) + + [ + "} // anonymous namespace", # No warning + "namespace missing_comment {", + ] + + ([""] * 10) + + [ + "}", # Warning here + "namespace no_warning {", + ] + + ([""] * 10) + + ["} // namespace no_warning", "namespace no_warning {"] + + ([""] * 10) + + ["}; // end namespace no_warning", "#define MACRO \\", "namespace c_style { \\"] + + (["\\"] * 10) + + ["} /* namespace c_style. */ \\", ";"], + error_collector, + ) + assert ( + error_collector.Results().count( + 'Namespace should be terminated with "// namespace expected"' + " [readability/namespace] [5]" + ) + == 1 + ) + assert ( + error_collector.Results().count( + 'Namespace should be terminated with "// namespace outer"' + " [readability/namespace] [5]" + ) + == 1 + ) + assert ( + error_collector.Results().count( + 'Namespace should be terminated with "// namespace nested"' + " [readability/namespace] [5]" + ) + == 1 + ) + assert ( + error_collector.Results().count( + 'Anonymous namespace should be terminated with "// namespace"' + " [readability/namespace] [5]" + ) + == 3 + ) + assert ( + error_collector.Results().count( + 'Anonymous namespace should be terminated with "// namespace" or ' + '"// anonymous namespace" [readability/namespace] [5]"' + ) + == 0 # 2 + ) + assert ( + error_collector.Results().count( + 'Namespace should be terminated with "// namespace missing_comment"' + " [readability/namespace] [5]" + ) + == 1 + ) + assert ( + error_collector.Results().count( + 'Namespace should be terminated with "// namespace no_warning"' + " [readability/namespace] [5]" + ) + == 0 + ) + + def testComma(self): + self.TestLint("a = f(1,2);", "Missing space after , [whitespace/comma] [3]") + self.TestLint( + "int tmp=a,a=b,b=tmp;", + [ + "Missing spaces around = [whitespace/operators] [4]", + "Missing space after , [whitespace/comma] [3]", + ], + ) + self.TestLint("f(a, /* name */ b);", "") + self.TestLint("f(a, /* name */b);", "") + self.TestLint("f(a, /* name */-1);", "") + self.TestLint('f(a, /* name */"1");', "") + self.TestLint("f(1, /* empty macro arg */, 2)", "") + self.TestLint("f(1,, 2)", "") + self.TestLint("operator,()", "") + self.TestLint("operator,(a,b)", "Missing space after , [whitespace/comma] [3]") + self.TestLint("__VA_OPT__(,)", "") + self.TestLint( + "__VA_OPT__ (,)", "Extra space before ( in function call [whitespace/parens] [4]" + ) + + def testEqualsOperatorSpacing(self): + self.TestLint("int tmp= a;", "Missing spaces around = [whitespace/operators] [4]") + self.TestLint("int tmp =a;", "Missing spaces around = [whitespace/operators] [4]") + self.TestLint("int tmp=a;", "Missing spaces around = [whitespace/operators] [4]") + self.TestLint("int tmp= 7;", "Missing spaces around = [whitespace/operators] [4]") + self.TestLint("int tmp =7;", "Missing spaces around = [whitespace/operators] [4]") + self.TestLint("int tmp=7;", "Missing spaces around = [whitespace/operators] [4]") + self.TestLint("int* tmp=*p;", "Missing spaces around = [whitespace/operators] [4]") + self.TestLint("int* tmp= *p;", "Missing spaces around = [whitespace/operators] [4]") + self.TestMultiLineLint( + TrimExtraIndent(""" lookahead_services_= - ::strings::Split(FLAGS_ls, ",", ::strings::SkipEmpty());'''), - 'Missing spaces around = [whitespace/operators] [4]') - self.TestLint('bool result = a>=42;', - 'Missing spaces around >= [whitespace/operators] [3]') - self.TestLint('bool result = a<=42;', - 'Missing spaces around <= [whitespace/operators] [3]') - self.TestLint('bool result = a==42;', - 'Missing spaces around == [whitespace/operators] [3]') - self.TestLint('auto result = a!=42;', - 'Missing spaces around != [whitespace/operators] [3]') - self.TestLint('int a = b!=c;', - 'Missing spaces around != [whitespace/operators] [3]') - self.TestLint('a&=42;', '') - self.TestLint('a|=42;', '') - self.TestLint('a^=42;', '') - self.TestLint('a+=42;', '') - self.TestLint('a*=42;', '') - self.TestLint('a/=42;', '') - self.TestLint('a%=42;', '') - self.TestLint('a>>=5;', '') - self.TestLint('a<<=5;', '') - - def testShiftOperatorSpacing(self): - self.TestLint('a<>b', - 'Missing spaces around >> [whitespace/operators] [3]') - self.TestLint('1<<20', '') - self.TestLint('1024>>10', '') - self.TestLint('Kernel<<<1, 2>>>()', '') - - def testIndent(self): - self.TestLint('static int noindent;', '') - self.TestLint(' int two_space_indent;', '') - self.TestLint(' int four_space_indent;', '') - self.TestLint(' int one_space_indent;', - 'Weird number of spaces at line-start. ' - 'Are you using a 2-space indent? [whitespace/indent] [3]') - self.TestLint(' int three_space_indent;', - 'Weird number of spaces at line-start. ' - 'Are you using a 2-space indent? [whitespace/indent] [3]') - self.TestLint(' char* one_space_indent = "public:";', - 'Weird number of spaces at line-start. ' - 'Are you using a 2-space indent? [whitespace/indent] [3]') - self.TestLint(' public:', '') - self.TestLint(' protected:', '') - self.TestLint(' private:', '') - self.TestLint(' protected: \\', '') - self.TestLint(' public: \\', '') - self.TestLint(' private: \\', '') - # examples using QT signals/slots macro - self.TestMultiLineLint( - TrimExtraIndent(""" + ::strings::Split(FLAGS_ls, ",", ::strings::SkipEmpty());"""), + "Missing spaces around = [whitespace/operators] [4]", + ) + self.TestLint( + "bool result = a>=42;", "Missing spaces around >= [whitespace/operators] [3]" + ) + self.TestLint( + "bool result = a<=42;", "Missing spaces around <= [whitespace/operators] [3]" + ) + self.TestLint( + "bool result = a==42;", "Missing spaces around == [whitespace/operators] [3]" + ) + self.TestLint( + "auto result = a!=42;", "Missing spaces around != [whitespace/operators] [3]" + ) + self.TestLint("int a = b!=c;", "Missing spaces around != [whitespace/operators] [3]") + self.TestLint("a&=42;", "") + self.TestLint("a|=42;", "") + self.TestLint("a^=42;", "") + self.TestLint("a+=42;", "") + self.TestLint("a*=42;", "") + self.TestLint("a/=42;", "") + self.TestLint("a%=42;", "") + self.TestLint("a>>=5;", "") + self.TestLint("a<<=5;", "") + + def testShiftOperatorSpacing(self): + self.TestLint("a<>b", "Missing spaces around >> [whitespace/operators] [3]") + self.TestLint("1<<20", "") + self.TestLint("1024>>10", "") + self.TestLint("Kernel<<<1, 2>>>()", "") + + def testIndent(self): + self.TestLint("static int noindent;", "") + self.TestLint(" int two_space_indent;", "") + self.TestLint(" int four_space_indent;", "") + self.TestLint( + " int one_space_indent;", + "Weird number of spaces at line-start. " + "Are you using a 2-space indent? [whitespace/indent] [3]", + ) + self.TestLint( + " int three_space_indent;", + "Weird number of spaces at line-start. " + "Are you using a 2-space indent? [whitespace/indent] [3]", + ) + self.TestLint( + ' char* one_space_indent = "public:";', + "Weird number of spaces at line-start. " + "Are you using a 2-space indent? [whitespace/indent] [3]", + ) + self.TestLint(" public:", "") + self.TestLint(" protected:", "") + self.TestLint(" private:", "") + self.TestLint(" protected: \\", "") + self.TestLint(" public: \\", "") + self.TestLint(" private: \\", "") + # examples using QT signals/slots macro + self.TestMultiLineLint( + TrimExtraIndent(""" class foo { public slots: void bar(); signals: };"""), - '') - self.TestMultiLineLint( - TrimExtraIndent(""" + "", + ) + self.TestMultiLineLint( + TrimExtraIndent(""" class foo { public slots: void bar(); };"""), - 'public slots: should be indented +1 space inside class foo' - ' [whitespace/indent] [3]') - self.TestMultiLineLint( - TrimExtraIndent(""" + "public slots: should be indented +1 space inside class foo [whitespace/indent] [3]", + ) + self.TestMultiLineLint( + TrimExtraIndent(""" class foo { signals: void bar(); };"""), - 'signals: should be indented +1 space inside class foo' - ' [whitespace/indent] [3]') - self.TestMultiLineLint( - TrimExtraIndent(''' + "signals: should be indented +1 space inside class foo [whitespace/indent] [3]", + ) + self.TestMultiLineLint( + TrimExtraIndent(""" static const char kRawString[] = R"(" - ")";'''), - '') - self.TestMultiLineLint( - TrimExtraIndent(''' + ")";"""), + "", + ) + self.TestMultiLineLint( + TrimExtraIndent(""" KV>'''), - '') - self.TestMultiLineLint( - ' static const char kSingleLineRawString[] = R"(...)";', - 'Weird number of spaces at line-start. ' - 'Are you using a 2-space indent? [whitespace/indent] [3]') - - def testSectionIndent(self): - self.TestMultiLineLint( - """ + Tuple>"""), + "", + ) + self.TestMultiLineLint( + ' static const char kSingleLineRawString[] = R"(...)";', + "Weird number of spaces at line-start. " + "Are you using a 2-space indent? [whitespace/indent] [3]", + ) + + def testSectionIndent(self): + self.TestMultiLineLint( + """ class A { public: // no warning private: // warning here };""", - 'private: should be indented +1 space inside class A' - ' [whitespace/indent] [3]') - self.TestMultiLineLint( - """ + "private: should be indented +1 space inside class A [whitespace/indent] [3]", + ) + self.TestMultiLineLint( + """ class B { public: // no warning template<> struct C { @@ -3889,251 +4312,272 @@ class B { protected: // no warning }; };""", - 'public: should be indented +1 space inside struct C' - ' [whitespace/indent] [3]') - self.TestMultiLineLint( - """ + "public: should be indented +1 space inside struct C [whitespace/indent] [3]", + ) + self.TestMultiLineLint( + """ struct D { };""", - 'Closing brace should be aligned with beginning of struct D' - ' [whitespace/indent] [3]') - self.TestMultiLineLint( - """ + "Closing brace should be aligned with beginning of struct D [whitespace/indent] [3]", + ) + self.TestMultiLineLint( + """ template class F { };""", - 'Closing brace should be aligned with beginning of class F' - ' [whitespace/indent] [3]') - self.TestMultiLineLint( - """ + "Closing brace should be aligned with beginning of class F [whitespace/indent] [3]", + ) + self.TestMultiLineLint( + """ class G { Q_OBJECT public slots: signals: };""", - ['public slots: should be indented +1 space inside class G' - ' [whitespace/indent] [3]', - 'signals: should be indented +1 space inside class G' - ' [whitespace/indent] [3]']) - self.TestMultiLineLint( - """ + [ + "public slots: should be indented +1 space inside class G [whitespace/indent] [3]", + "signals: should be indented +1 space inside class G [whitespace/indent] [3]", + ], + ) + self.TestMultiLineLint( + """ class H { /* comments */ class I { public: // no warning private: // warning here }; };""", - 'private: should be indented +1 space inside class I' - ' [whitespace/indent] [3]') - self.TestMultiLineLint( - """ + "private: should be indented +1 space inside class I [whitespace/indent] [3]", + ) + self.TestMultiLineLint( + """ class J : public ::K { public: // no warning protected: // warning here };""", - 'protected: should be indented +1 space inside class J' - ' [whitespace/indent] [3]') - self.TestMultiLineLint( - """ + "protected: should be indented +1 space inside class J [whitespace/indent] [3]", + ) + self.TestMultiLineLint( + """ class L : public M, public ::N { };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ template static void Func() { }""", - '') + "", + ) - def testConditionals(self): - self.TestMultiLineLint( - """ + def testConditionals(self): + self.TestMultiLineLint( + """ if (foo) goto fail; goto fail;""", - 'If/else bodies with multiple statements require braces' - ' [readability/braces] [4]') - self.TestMultiLineLint( - """ + "If/else bodies with multiple statements require braces [readability/braces] [4]", + ) + self.TestMultiLineLint( + """ if (foo) goto fail; goto fail;""", - 'If/else bodies with multiple statements require braces' - ' [readability/braces] [4]') - self.TestMultiLineLint( - """ + "If/else bodies with multiple statements require braces [readability/braces] [4]", + ) + self.TestMultiLineLint( + """ if (foo) foo; else goto fail; goto fail;""", - 'If/else bodies with multiple statements require braces' - ' [readability/braces] [4]') - self.TestMultiLineLint( - """ + "If/else bodies with multiple statements require braces [readability/braces] [4]", + ) + self.TestMultiLineLint( + """ if (foo) goto fail; goto fail;""", - 'If/else bodies with multiple statements require braces' - ' [readability/braces] [4]') - self.TestMultiLineLint( - """ + "If/else bodies with multiple statements require braces [readability/braces] [4]", + ) + self.TestMultiLineLint( + """ if constexpr (foo) { goto fail; goto fail; } else if constexpr (bar) { hello(); }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ if (foo) if (bar) baz; else qux;""", - 'Else clause should be indented at the same level as if. Ambiguous' - ' nested if/else chains require braces. [readability/braces] [4]') - self.TestMultiLineLint( - """ + "Else clause should be indented at the same level as if. Ambiguous" + " nested if/else chains require braces. [readability/braces] [4]", + ) + self.TestMultiLineLint( + """ if (foo) if (bar) baz; else qux;""", - 'Else clause should be indented at the same level as if. Ambiguous' - ' nested if/else chains require braces. [readability/braces] [4]') - self.TestMultiLineLint( - """ + "Else clause should be indented at the same level as if. Ambiguous" + " nested if/else chains require braces. [readability/braces] [4]", + ) + self.TestMultiLineLint( + """ if (foo) { bar; baz; } else qux;""", - 'If an else has a brace on one side, it should have it on both' - ' [readability/braces] [5]') - self.TestMultiLineLint( - """ + "If an else has a brace on one side, it should have it on both" + " [readability/braces] [5]", + ) + self.TestMultiLineLint( + """ if (foo) bar; else { baz; }""", - 'If an else has a brace on one side, it should have it on both' - ' [readability/braces] [5]') - self.TestMultiLineLint( - """ + "If an else has a brace on one side, it should have it on both" + " [readability/braces] [5]", + ) + self.TestMultiLineLint( + """ if (foo) bar; else if (baz) { qux; }""", - 'If an else has a brace on one side, it should have it on both' - ' [readability/braces] [5]') - self.TestMultiLineLint( - """ + "If an else has a brace on one side, it should have it on both" + " [readability/braces] [5]", + ) + self.TestMultiLineLint( + """ if (foo) { bar; } else if (baz) qux;""", - 'If an else has a brace on one side, it should have it on both' - ' [readability/braces] [5]') - self.TestMultiLineLint( - """ + "If an else has a brace on one side, it should have it on both" + " [readability/braces] [5]", + ) + self.TestMultiLineLint( + """ if (foo) goto fail; bar;""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ if (foo && bar) { baz; qux; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ if (foo) goto fail;""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ if (foo) bar; else baz; qux;""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ for (;;) { if (foo) bar; else baz; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ if (foo) bar; else if (baz) baz;""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ if (foo) bar; else baz;""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ if (foo) { bar; } else { baz; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ if (foo) { bar; } else if (baz) { qux; }""", - '') - # Note: this is an error for a different reason, but should not trigger the - # single-line if error. - self.TestMultiLineLint( - """ + "", + ) + # Note: this is an error for a different reason, but should not trigger the + # single-line if error. + self.TestMultiLineLint( + """ if (foo) { bar; baz; }""", - '{ should almost always be at the end of the previous line' - ' [whitespace/braces] [4]') - self.TestMultiLineLint( - """ + "{ should almost always be at the end of the previous line [whitespace/braces] [4]", + ) + self.TestMultiLineLint( + """ void foo() { if (bar) baz; }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ #if foo bar; #else baz; qux; #endif""", - '') - self.TestMultiLineLint( - """void F() { + "", + ) + self.TestMultiLineLint( + """void F() { variable = [] { if (true); }; variable = [] { if (true); }; @@ -4141,480 +4585,517 @@ def testConditionals(self): [] { if (true); }, [] { if (true); }); }""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ #if(A == 0) foo(); #elif(A == 1) bar(); #endif""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ #if (A == 0) foo(); #elif (A == 1) bar(); #endif""", - '') - - @parameterized.expand(['else if', 'if', 'while', 'for', 'switch']) - def testControlClauseWithParensNewline(self, keyword): - # The % 2 part is pseudorandom whitespace-support testing - self.TestLintContains( - f'{keyword}{["", " "][len(keyword) % 2]}(condition)' - f'{[" ", ""][len(keyword) % 2]}[[unlikely]]' - f'{[" ", ""][len(keyword) % 2]}{{' - f'{["", " "][len(keyword) % 2]}do_something(); }}', - f'Controlled statements inside brackets of {keyword} clause' - f' should be on a separate line [whitespace/newline] [5]' - ) - - @parameterized.expand(['else', 'do', 'try']) - def testControlClauseWithoutParensNewline(self, keyword): - # The % 2 part is pseudorandom whitespace-support testing - self.TestLintContains( - f'{keyword}{["", " "][len(keyword) % 2]}{{' - f'{[" ", ""][len(keyword) % 2]}do_something(); }}', - f'Controlled statements inside brackets of {keyword} clause' - f' should be on a separate line [whitespace/newline] [5]' - ) - - def testControlClauseNewlineNameFalsePositives(self): - self.TestLint(' else if_condition_do_something();', '') - self.TestLint(' } else if (blah) {', '') - self.TestLint(' variable_ends_in_else = true;', '') - - def testTab(self): - self.TestLint('\tint a;', - 'Tab found; better to use spaces [whitespace/tab] [1]') - self.TestLint('int a = 5;\t\t// set a to 5', - 'Tab found; better to use spaces [whitespace/tab] [1]') - - def testParseArguments(self): - old_output_format = cpplint._cpplint_state.output_format - old_verbose_level = cpplint._cpplint_state.verbose_level - old_headers = cpplint._hpp_headers - old_filters = cpplint._cpplint_state.filters - old_line_length = cpplint._line_length - old_valid_extensions = cpplint._valid_extensions - try: - # Don't print usage during the tests, or filter categories - sys.stdout = open(os.devnull, 'w') - sys.stderr = open(os.devnull, 'w') - - self.assertRaises(SystemExit, cpplint.ParseArguments, []) - self.assertRaises(SystemExit, cpplint.ParseArguments, ['--badopt']) - self.assertRaises(SystemExit, cpplint.ParseArguments, ['--help']) - self.assertRaises(SystemExit, cpplint.ParseArguments, ['--version']) - self.assertRaises(SystemExit, cpplint.ParseArguments, ['--v=0']) - self.assertRaises(SystemExit, cpplint.ParseArguments, ['--filter=']) - # This is illegal because all filters must start with + or - - self.assertRaises(SystemExit, cpplint.ParseArguments, ['--filter=foo']) - self.assertRaises(SystemExit, cpplint.ParseArguments, - ['--filter=+a,b,-c']) - self.assertRaises(SystemExit, cpplint.ParseArguments, ['--headers']) - - self.assertEqual(['foo.cc'], cpplint.ParseArguments(['foo.cc'])) - self.assertEqual(old_output_format, cpplint._cpplint_state.output_format) - self.assertEqual(old_verbose_level, cpplint._cpplint_state.verbose_level) - - self.assertEqual(['foo.cc'], - cpplint.ParseArguments(['--v=1', 'foo.cc'])) - self.assertEqual(1, cpplint._cpplint_state.verbose_level) - self.assertEqual(['foo.h'], - cpplint.ParseArguments(['--v=3', 'foo.h'])) - self.assertEqual(3, cpplint._cpplint_state.verbose_level) - self.assertEqual(['foo.cpp'], - cpplint.ParseArguments(['--verbose=5', 'foo.cpp'])) - self.assertEqual(5, cpplint._cpplint_state.verbose_level) - self.assertRaises(ValueError, - cpplint.ParseArguments, ['--v=f', 'foo.cc']) - - self.assertEqual(['foo.cc'], - cpplint.ParseArguments(['--output=emacs', 'foo.cc'])) - self.assertEqual('emacs', cpplint._cpplint_state.output_format) - self.assertEqual(['foo.h'], - cpplint.ParseArguments(['--output=vs7', 'foo.h'])) - self.assertEqual('vs7', cpplint._cpplint_state.output_format) - self.assertRaises(SystemExit, - cpplint.ParseArguments, ['--output=blah', 'foo.cc']) - - filt = '-,+whitespace,-whitespace/indent' - self.assertEqual(['foo.h'], - cpplint.ParseArguments(['--filter='+filt, 'foo.h'])) - self.assertEqual(['-', '+whitespace', '-whitespace/indent'], - cpplint._cpplint_state.filters) - - self.assertEqual(['foo.cc', 'foo.h'], - cpplint.ParseArguments(['foo.cc', 'foo.h'])) - - cpplint._hpp_headers = old_headers - cpplint._valid_extensions = old_valid_extensions - self.assertEqual(['foo.h'], - cpplint.ParseArguments(['--linelength=120', 'foo.h'])) - self.assertEqual(120, cpplint._line_length) - self.assertEqual(set(['h', 'hh', 'hpp', 'hxx', 'h++', 'cuh']), cpplint.GetHeaderExtensions()) # Default value - - cpplint._hpp_headers = old_headers - cpplint._valid_extensions = old_valid_extensions - self.assertEqual(['foo.h'], - cpplint.ParseArguments(['--headers=h', 'foo.h'])) - self.assertEqual(set(['h', 'c', 'cc', 'cpp', 'cxx', 'c++', 'cu']), cpplint.GetAllExtensions()) - - cpplint._hpp_headers = old_headers - cpplint._valid_extensions = old_valid_extensions - self.assertEqual(['foo.h'], - cpplint.ParseArguments(['--extensions=hpp,cpp,cpp', 'foo.h'])) - self.assertEqual(set(['hpp', 'cpp']), cpplint.GetAllExtensions()) - self.assertEqual(set(['hpp']), cpplint.GetHeaderExtensions()) - - cpplint._hpp_headers = old_headers - cpplint._valid_extensions = old_valid_extensions - self.assertEqual(['foo.h'], - cpplint.ParseArguments(['--extensions=cpp,cpp', '--headers=hpp,h', 'foo.h'])) - self.assertEqual(set(['hpp', 'h']), cpplint.GetHeaderExtensions()) - self.assertEqual(set(['hpp', 'h', 'cpp']), cpplint.GetAllExtensions()) - - finally: - sys.stdout == sys.__stdout__ - sys.stderr == sys.__stderr__ - cpplint._cpplint_state.output_format = old_output_format - cpplint._cpplint_state.verbose_level = old_verbose_level - cpplint._cpplint_state.filters = old_filters - cpplint._line_length = old_line_length - cpplint._valid_extensions = old_valid_extensions - cpplint._hpp_headers = old_headers - - def testRecursiveArgument(self): - working_dir = os.getcwd() - temp_dir = os.path.realpath(tempfile.mkdtemp()) - try: - src_dir = os.path.join(temp_dir, "src") - nested_dir = os.path.join(temp_dir, "src", "nested") - os.makedirs(nested_dir) - open(os.path.join(temp_dir, "one.cpp"), 'w').close() - open(os.path.join(src_dir, "two.cpp"), 'w').close() - open(os.path.join(nested_dir, "three.cpp"), 'w').close() - os.chdir(temp_dir) - expected = ['one.cpp', os.path.join('src', 'two.cpp'), - os.path.join('src', 'nested', 'three.cpp')] - cpplint._excludes = None - actual = cpplint.ParseArguments(['--recursive', 'one.cpp', 'src']) - self.assertEqual(set(expected), set(actual)) - finally: - os.chdir(working_dir) - shutil.rmtree(temp_dir) - - def testRecursiveExcludeInvalidFileExtension(self): - working_dir = os.getcwd() - temp_dir = os.path.realpath(tempfile.mkdtemp()) - try: - src_dir = os.path.join(temp_dir, "src") - os.makedirs(src_dir) - open(os.path.join(temp_dir, "one.cpp"), 'w').close() - open(os.path.join(src_dir, "two.cpp"), 'w').close() - open(os.path.join(src_dir, "three.cc"), 'w').close() - os.chdir(temp_dir) - expected = ['one.cpp', os.path.join('src', 'two.cpp')] - cpplint._excludes = None - actual = cpplint.ParseArguments(['--recursive', '--extensions=cpp', - 'one.cpp', 'src']) - self.assertEqual(set(expected), set(actual)) - finally: - os.chdir(working_dir) - shutil.rmtree(temp_dir) - cpplint._hpp_headers = set([]) - cpplint._valid_extensions = set([]) - - def testRecursiveExclude(self): - working_dir = os.getcwd() - temp_dir = os.path.realpath(tempfile.mkdtemp()) - try: - src_dir = os.path.join(temp_dir, 'src') - src2_dir = os.path.join(temp_dir, 'src2') - os.makedirs(src_dir) - os.makedirs(src2_dir) - open(os.path.join(src_dir, 'one.cc'), 'w').close() - open(os.path.join(src_dir, 'two.cc'), 'w').close() - open(os.path.join(src_dir, 'three.cc'), 'w').close() - open(os.path.join(src2_dir, 'one.cc'), 'w').close() - open(os.path.join(src2_dir, 'two.cc'), 'w').close() - open(os.path.join(src2_dir, 'three.cc'), 'w').close() - os.chdir(temp_dir) - - expected = [ - os.path.join('src', 'one.cc'), - os.path.join('src', 'two.cc'), - os.path.join('src', 'three.cc') - ] - cpplint._excludes = None - actual = cpplint.ParseArguments(['src']) - self.assertEqual(set(['src']), set(actual)) - - cpplint._excludes = None - actual = cpplint.ParseArguments(['--recursive', 'src']) - self.assertEqual(set(expected), set(actual)) - - expected = [os.path.join('src', 'one.cc')] - cpplint._excludes = None - actual = cpplint.ParseArguments(['--recursive', - '--exclude=src{0}t*'.format(os.sep), 'src']) - self.assertEqual(set(expected), set(actual)) - - expected = [os.path.join('src', 'one.cc')] - cpplint._excludes = None - actual = cpplint.ParseArguments(['--recursive', - '--exclude=src/two.cc', '--exclude=src/three.cc', 'src']) - self.assertEqual(set(expected), set(actual)) - - expected = set([ - os.path.join('src2', 'one.cc'), - os.path.join('src2', 'two.cc'), - os.path.join('src2', 'three.cc') - ]) - cpplint._excludes = None - actual = cpplint.ParseArguments(['--recursive', - '--exclude=src', '.']) - self.assertEqual(expected, set(actual)) - finally: - os.chdir(working_dir) - shutil.rmtree(temp_dir) - - def testJUnitXML(self): - try: - cpplint._cpplint_state._junit_errors = [] - cpplint._cpplint_state._junit_failures = [] - expected = ('\n' - '' - '' - '') - self.assertEqual(expected, cpplint._cpplint_state.FormatJUnitXML()) - - cpplint._cpplint_state._junit_errors = ['ErrMsg1'] - cpplint._cpplint_state._junit_failures = [] - expected = ('\n' - '' - 'ErrMsg1' - '') - self.assertEqual(expected, cpplint._cpplint_state.FormatJUnitXML()) - - cpplint._cpplint_state._junit_errors = ['ErrMsg1', 'ErrMsg2'] - cpplint._cpplint_state._junit_failures = [] - expected = ('\n' - '' - 'ErrMsg1\nErrMsg2' - '') - self.assertEqual(expected, cpplint._cpplint_state.FormatJUnitXML()) - - cpplint._cpplint_state._junit_errors = ['ErrMsg'] - cpplint._cpplint_state._junit_failures = [ - ('File', 5, 'FailMsg', 'category/subcategory', 3)] - expected = ('\n' - '' - 'ErrMsg' - '5: FailMsg [category/subcategory] ' - '[3]') - self.assertEqual(expected, cpplint._cpplint_state.FormatJUnitXML()) - - cpplint._cpplint_state._junit_errors = [] - cpplint._cpplint_state._junit_failures = [ - ('File1', 5, 'FailMsg1', 'category/subcategory', 3), - ('File2', 99, 'FailMsg2', 'category/subcategory', 3), - ('File1', 19, 'FailMsg3', 'category/subcategory', 3)] - expected = ('\n' - '' - '5: FailMsg1 [category/subcategory]' - ' [3]\n19: FailMsg3 [category/subcategory] [3]' - '99: FailMsg2 ' - '[category/subcategory] [3]') - self.assertEqual(expected, cpplint._cpplint_state.FormatJUnitXML()) - - cpplint._cpplint_state._junit_errors = ['&'] - cpplint._cpplint_state._junit_failures = [ - ('File1', 5, '&', 'category/subcategory', 3)] - expected = ('\n' - '' - '&</error>' - '5: ' - '&</failure> [category/subcategory] [3]' - '') - self.assertEqual(expected, cpplint._cpplint_state.FormatJUnitXML()) - - finally: - cpplint._cpplint_state._junit_errors = [] - cpplint._cpplint_state._junit_failures = [] - - def testQuiet(self): - self.assertEqual(cpplint._cpplint_state.quiet, False) - cpplint.ParseArguments(['--quiet', 'one.cpp']) - self.assertEqual(cpplint._cpplint_state.quiet, True) - - def testLineLength(self): - old_line_length = cpplint._line_length - try: - cpplint._line_length = 80 - self.TestLint( - '// H %s' % ('H' * 75), - '') - self.TestLint( - '// H %s' % ('H' * 76), - 'Lines should be <= 80 characters long' - ' [whitespace/line_length] [2]') - cpplint._line_length = 120 - self.TestLint( - '// H %s' % ('H' * 115), - '') - self.TestLint( - '// H %s' % ('H' * 116), - 'Lines should be <= 120 characters long' - ' [whitespace/line_length] [2]') - finally: - cpplint._line_length = old_line_length - - def testFilter(self): - old_filters = cpplint._cpplint_state.filters - try: - cpplint._cpplint_state.SetFilters('-,+whitespace,-whitespace/indent') - self.TestLint( - '// Hello there ', - 'Line ends in whitespace. Consider deleting these extra spaces.' - ' [whitespace/end_of_line] [4]') - self.TestLint('int a = (int)1.0;', '') - self.TestLint(' weird opening space', '') - finally: - cpplint._cpplint_state.filters = old_filters - - def testDefaultFilter(self): - default_filters = cpplint._DEFAULT_FILTERS - old_filters = cpplint._cpplint_state.filters - cpplint._DEFAULT_FILTERS = ['-whitespace'] - try: - # Reset filters - cpplint._cpplint_state.SetFilters('') - self.TestLint('// Hello there ', '') - cpplint._cpplint_state.SetFilters('+whitespace/end_of_line') - self.TestLint( - '// Hello there ', - 'Line ends in whitespace. Consider deleting these extra spaces.' - ' [whitespace/end_of_line] [4]') - self.TestLint(' weird opening space', '') - finally: - cpplint._cpplint_state.filters = old_filters - cpplint._DEFAULT_FILTERS = default_filters - - def testFileSpecificFilter(self): - old_filters = cpplint._cpplint_state.filters - try: - test_code = """ + "", + ) + + @parameterized.expand(["else if", "if", "while", "for", "switch"]) + def testControlClauseWithParensNewline(self, keyword): + # The % 2 part is pseudorandom whitespace-support testing + self.TestLintContains( + f"{keyword}{['', ' '][len(keyword) % 2]}(condition)" + f"{[' ', ''][len(keyword) % 2]}[[unlikely]]" + f"{[' ', ''][len(keyword) % 2]}{{" + f"{['', ' '][len(keyword) % 2]}do_something(); }}", + f"Controlled statements inside brackets of {keyword} clause" + f" should be on a separate line [whitespace/newline] [5]", + ) + + @parameterized.expand(["else", "do", "try"]) + def testControlClauseWithoutParensNewline(self, keyword): + # The % 2 part is pseudorandom whitespace-support testing + self.TestLintContains( + f"{keyword}{['', ' '][len(keyword) % 2]}{{" + f"{[' ', ''][len(keyword) % 2]}do_something(); }}", + f"Controlled statements inside brackets of {keyword} clause" + f" should be on a separate line [whitespace/newline] [5]", + ) + + def testControlClauseNewlineNameFalsePositives(self): + self.TestLint(" else if_condition_do_something();", "") + self.TestLint(" } else if (blah) {", "") + self.TestLint(" variable_ends_in_else = true;", "") + + def testTab(self): + self.TestLint("\tint a;", "Tab found; better to use spaces [whitespace/tab] [1]") + self.TestLint( + "int a = 5;\t\t// set a to 5", "Tab found; better to use spaces [whitespace/tab] [1]" + ) + + def testParseArguments(self): + old_output_format = cpplint._cpplint_state.output_format + old_verbose_level = cpplint._cpplint_state.verbose_level + old_headers = cpplint._hpp_headers + old_filters = cpplint._cpplint_state.filters + old_line_length = cpplint._line_length + old_valid_extensions = cpplint._valid_extensions + try: + # Don't print usage during the tests, or filter categories + sys.stdout = open(os.devnull, "w") + sys.stderr = open(os.devnull, "w") + + with pytest.raises(SystemExit): + cpplint.ParseArguments([]) + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--badopt"]) + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--help"]) + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--version"]) + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--v=0"]) + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--filter="]) + # This is illegal because all filters must start with + or - + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--filter=foo"]) + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--filter=+a,b,-c"]) + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--linelength=0"]) + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--headers"]) + + assert cpplint.ParseArguments(["foo.cc"]) == ["foo.cc"] + assert old_output_format == cpplint._cpplint_state.output_format + assert old_verbose_level == cpplint._cpplint_state.verbose_level + + assert cpplint.ParseArguments(["--v=1", "foo.cc"]) == ["foo.cc"] + assert cpplint._cpplint_state.verbose_level == 1 + assert cpplint.ParseArguments(["--v=3", "foo.h"]) == ["foo.h"] + assert cpplint._cpplint_state.verbose_level == 3 + assert cpplint.ParseArguments(["--verbose=5", "foo.cpp"]) == ["foo.cpp"] + assert cpplint._cpplint_state.verbose_level == 5 + with pytest.raises( + ValueError, match=re.escape("invalid literal for int() with base 10: 'f'") + ): + cpplint.ParseArguments(["--v=f", "foo.cc"]) + + assert cpplint.ParseArguments(["--output=emacs", "foo.cc"]) == ["foo.cc"] + assert cpplint._cpplint_state.output_format == "emacs" + assert cpplint.ParseArguments(["--output=vs7", "foo.h"]) == ["foo.h"] + assert cpplint._cpplint_state.output_format == "vs7" + with pytest.raises(SystemExit): + cpplint.ParseArguments(["--output=blah", "foo.cc"]) + + filt = "-,+whitespace,-whitespace/indent" + assert cpplint.ParseArguments(["--filter=" + filt, "foo.h"]) == ["foo.h"] + assert cpplint._cpplint_state.filters == ["-", "+whitespace", "-whitespace/indent"] + + assert cpplint.ParseArguments(["foo.cc", "foo.h"]) == ["foo.cc", "foo.h"] + + cpplint._hpp_headers = old_headers + cpplint._valid_extensions = old_valid_extensions + assert cpplint.ParseArguments(["--linelength=120", "foo.h"]) == ["foo.h"] + assert cpplint._line_length == 120 + assert { + "h", + "hh", + "hpp", + "hxx", + "h++", + "cuh", + } == cpplint.GetHeaderExtensions() # Default value + + cpplint._hpp_headers = old_headers + cpplint._valid_extensions = old_valid_extensions + assert cpplint.ParseArguments(["--headers=h", "foo.h"]) == ["foo.h"] + assert {"h", "c", "cc", "cpp", "cxx", "c++", "cu"} == cpplint.GetAllExtensions() + + cpplint._hpp_headers = old_headers + cpplint._valid_extensions = old_valid_extensions + assert cpplint.ParseArguments(["--extensions=hpp,cpp,cpp", "foo.h"]) == ["foo.h"] + assert {"hpp", "cpp"} == cpplint.GetAllExtensions() + assert {"hpp"} == cpplint.GetHeaderExtensions() + + cpplint._hpp_headers = old_headers + cpplint._valid_extensions = old_valid_extensions + assert cpplint.ParseArguments(["--extensions=cpp,cpp", "--headers=hpp,h", "foo.h"]) == [ + "foo.h" + ] + assert {"hpp", "h"} == cpplint.GetHeaderExtensions() + assert {"hpp", "h", "cpp"} == cpplint.GetAllExtensions() + + finally: + sys.stdout = sys.__stdout__ + sys.stderr = sys.__stderr__ + cpplint._cpplint_state.output_format = old_output_format + cpplint._cpplint_state.verbose_level = old_verbose_level + cpplint._cpplint_state.filters = old_filters + cpplint._line_length = old_line_length + cpplint._valid_extensions = old_valid_extensions + cpplint._hpp_headers = old_headers + + def testRecursiveArgument(self): + working_dir = os.getcwd() + temp_dir = os.path.realpath(tempfile.mkdtemp()) + try: + src_dir = os.path.join(temp_dir, "src") + nested_dir = os.path.join(temp_dir, "src", "nested") + os.makedirs(nested_dir) + open(os.path.join(temp_dir, "one.cpp"), "w").close() + open(os.path.join(src_dir, "two.cpp"), "w").close() + open(os.path.join(nested_dir, "three.cpp"), "w").close() + os.chdir(temp_dir) + expected = [ + "one.cpp", + os.path.join("src", "two.cpp"), + os.path.join("src", "nested", "three.cpp"), + ] + cpplint._excludes = None + actual = cpplint.ParseArguments(["--recursive", "one.cpp", "src"]) + assert set(expected) == set(actual) + finally: + os.chdir(working_dir) + shutil.rmtree(temp_dir) + + def testRecursiveExcludeInvalidFileExtension(self): + working_dir = os.getcwd() + temp_dir = os.path.realpath(tempfile.mkdtemp()) + try: + src_dir = os.path.join(temp_dir, "src") + os.makedirs(src_dir) + open(os.path.join(temp_dir, "one.cpp"), "w").close() + open(os.path.join(src_dir, "two.cpp"), "w").close() + open(os.path.join(src_dir, "three.cc"), "w").close() + os.chdir(temp_dir) + expected = ["one.cpp", os.path.join("src", "two.cpp")] + cpplint._excludes = None + actual = cpplint.ParseArguments(["--recursive", "--extensions=cpp", "one.cpp", "src"]) + assert set(expected) == set(actual) + finally: + os.chdir(working_dir) + shutil.rmtree(temp_dir) + cpplint._hpp_headers = set() + cpplint._valid_extensions = set() + + def testRecursiveExclude(self): + working_dir = os.getcwd() + temp_dir = os.path.realpath(tempfile.mkdtemp()) + try: + src_dir = os.path.join(temp_dir, "src") + src2_dir = os.path.join(temp_dir, "src2") + os.makedirs(src_dir) + os.makedirs(src2_dir) + open(os.path.join(src_dir, "one.cc"), "w").close() + open(os.path.join(src_dir, "two.cc"), "w").close() + open(os.path.join(src_dir, "three.cc"), "w").close() + open(os.path.join(src2_dir, "one.cc"), "w").close() + open(os.path.join(src2_dir, "two.cc"), "w").close() + open(os.path.join(src2_dir, "three.cc"), "w").close() + os.chdir(temp_dir) + + expected = [ + os.path.join("src", "one.cc"), + os.path.join("src", "two.cc"), + os.path.join("src", "three.cc"), + ] + cpplint._excludes = None + actual = cpplint.ParseArguments(["src"]) + assert {"src"} == set(actual) + + cpplint._excludes = None + actual = cpplint.ParseArguments(["--recursive", "src"]) + assert set(expected) == set(actual) + + expected = [os.path.join("src", "one.cc")] + cpplint._excludes = None + actual = cpplint.ParseArguments(["--recursive", f"--exclude=src{os.sep}t*", "src"]) + assert set(expected) == set(actual) + + expected = [os.path.join("src", "one.cc")] + cpplint._excludes = None + actual = cpplint.ParseArguments( + ["--recursive", "--exclude=src/two.cc", "--exclude=src/three.cc", "src"] + ) + assert set(expected) == set(actual) + + expected = { + os.path.join("src2", "one.cc"), + os.path.join("src2", "two.cc"), + os.path.join("src2", "three.cc"), + } + cpplint._excludes = None + actual = cpplint.ParseArguments(["--recursive", "--exclude=src", "."]) + assert expected == set(actual) + finally: + os.chdir(working_dir) + shutil.rmtree(temp_dir) + + def testJUnitXML(self): + try: + cpplint._cpplint_state._junit_errors = [] + cpplint._cpplint_state._junit_failures = [] + expected = ( + '\n' + '' + '' + "" + ) + assert expected == cpplint._cpplint_state.FormatJUnitXML() + + cpplint._cpplint_state._junit_errors = ["ErrMsg1"] + cpplint._cpplint_state._junit_failures = [] + expected = ( + '\n' + '' + 'ErrMsg1' + "" + ) + assert expected == cpplint._cpplint_state.FormatJUnitXML() + + cpplint._cpplint_state._junit_errors = ["ErrMsg1", "ErrMsg2"] + cpplint._cpplint_state._junit_failures = [] + expected = ( + '\n' + '' + 'ErrMsg1\nErrMsg2' + "" + ) + assert expected == cpplint._cpplint_state.FormatJUnitXML() + + cpplint._cpplint_state._junit_errors = ["ErrMsg"] + cpplint._cpplint_state._junit_failures = [ + ("File", 5, "FailMsg", "category/subcategory", 3) + ] + expected = ( + '\n' + '' + 'ErrMsg' + '5: FailMsg [category/subcategory] ' + "[3]" + ) + assert expected == cpplint._cpplint_state.FormatJUnitXML() + + cpplint._cpplint_state._junit_errors = [] + cpplint._cpplint_state._junit_failures = [ + ("File1", 5, "FailMsg1", "category/subcategory", 3), + ("File2", 99, "FailMsg2", "category/subcategory", 3), + ("File1", 19, "FailMsg3", "category/subcategory", 3), + ] + expected = ( + '\n' + '' + '5: FailMsg1 [category/subcategory]' + " [3]\n19: FailMsg3 [category/subcategory] [3]" + '99: FailMsg2 ' + "[category/subcategory] [3]" + ) + assert expected == cpplint._cpplint_state.FormatJUnitXML() + + cpplint._cpplint_state._junit_errors = ["&"] + cpplint._cpplint_state._junit_failures = [ + ("File1", 5, "&", "category/subcategory", 3) + ] + expected = ( + '\n' + '' + '&</error>' + '5: ' + "&</failure> [category/subcategory] [3]" + "" + ) + assert expected == cpplint._cpplint_state.FormatJUnitXML() + + finally: + cpplint._cpplint_state._junit_errors = [] + cpplint._cpplint_state._junit_failures = [] + + def testQuiet(self): + assert cpplint._cpplint_state.quiet is False + cpplint.ParseArguments(["--quiet", "one.cpp"]) + assert cpplint._cpplint_state.quiet is True + + def testLineLength(self): + old_line_length = cpplint._line_length + try: + cpplint._line_length = 80 + self.TestLint("// H %s" % ("H" * 75), "") + self.TestLint( + "// H %s" % ("H" * 76), + "Lines should be <= 80 characters long [whitespace/line_length] [2]", + ) + cpplint._line_length = 120 + self.TestLint("// H %s" % ("H" * 115), "") + self.TestLint( + "// H %s" % ("H" * 116), + "Lines should be <= 120 characters long [whitespace/line_length] [2]", + ) + finally: + cpplint._line_length = old_line_length + + def testFilter(self): + old_filters = cpplint._cpplint_state.filters + try: + cpplint._cpplint_state.SetFilters("-,+whitespace,-whitespace/indent") + self.TestLint( + "// Hello there ", + "Line ends in whitespace. Consider deleting these extra spaces." + " [whitespace/end_of_line] [4]", + ) + self.TestLint("int a = (int)1.0;", "") + self.TestLint(" weird opening space", "") + finally: + cpplint._cpplint_state.filters = old_filters + + def testDefaultFilter(self): + default_filters = cpplint._DEFAULT_FILTERS + old_filters = cpplint._cpplint_state.filters + cpplint._DEFAULT_FILTERS = ["-whitespace"] + try: + # Reset filters + cpplint._cpplint_state.SetFilters("") + self.TestLint("// Hello there ", "") + cpplint._cpplint_state.SetFilters("+whitespace/end_of_line") + self.TestLint( + "// Hello there ", + "Line ends in whitespace. Consider deleting these extra spaces." + " [whitespace/end_of_line] [4]", + ) + self.TestLint(" weird opening space", "") + finally: + cpplint._cpplint_state.filters = old_filters + cpplint._DEFAULT_FILTERS = default_filters + + def testFileSpecificFilter(self): + old_filters = cpplint._cpplint_state.filters + try: + test_code = """ class Foo { Foo(int f) { } };""" - cpplint._cpplint_state.SetFilters('') - self.TestMultiLineLint( - test_code, - ['Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]', - '{ should almost always be at the end of the previous line' - ' [whitespace/braces] [4]'] - ) - - cpplint._cpplint_state.SetFilters('-runtime/explicit:foo.h') - self.TestMultiLineLint( - test_code, - '{ should almost always be at the end of the previous line' - ' [whitespace/braces] [4]' - ) - - cpplint._cpplint_state.SetFilters('-runtime/explicit:foo.h:2') - self.TestMultiLineLint( - test_code, - '{ should almost always be at the end of the previous line' - ' [whitespace/braces] [4]' - ) - - cpplint._cpplint_state.SetFilters('-runtime/explicit:foo.h:14,-whitespace/braces:otherfile.h:3') - self.TestMultiLineLint( - test_code, - ['Single-parameter constructors should be marked explicit.' - ' [runtime/explicit] [4]', - '{ should almost always be at the end of the previous line' - ' [whitespace/braces] [4]'] - ) - - cpplint._cpplint_state.SetFilters('-runtime/explicit:foo.h:2,-whitespace/braces:foo.h:3') - self.TestMultiLineLint( - test_code, - '' - ) - finally: - cpplint._cpplint_state.filters = old_filters - - def testDuplicateHeader(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('path/self.cc', 'cc', - ['// Copyright 2014 Your Company. All Rights Reserved.', - '#include "path/self.h"', - '#include "path/duplicate.h"', - '#include "path/duplicate.h"', - '#ifdef MACRO', - '#include "path/unique.h"', - '#else', - '#include "path/unique.h"', - '#endif', - ''], - error_collector) - self.assertEqual( - ['"path/duplicate.h" already included at path/self.cc:3 ' - '[build/include] [4]'], - error_collector.ResultList()) - - def testUnnamedNamespacesInHeaders(self): - for extension in ['h', 'hpp', 'hxx', 'h++', 'cuh']: - self.doTestUnnamedNamespacesInHeaders(extension) - - def doTestUnnamedNamespacesInHeaders(self, extension): - self.TestLanguageRulesCheck( - 'foo.' + extension, 'namespace {', - 'Do not use unnamed namespaces in header files. See' - ' https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces' - ' for more information. [build/namespaces_headers] [4]') - # namespace registration macros are OK. - self.TestLanguageRulesCheck('foo.' + extension, 'namespace { \\', '') - # named namespaces are OK. - self.TestLanguageRulesCheck('foo.' + extension, 'namespace foo {', '') - self.TestLanguageRulesCheck('foo.' + extension, 'namespace foonamespace {', '') - - def testUnnamedNamespacesInNonHeaders(self): - for extension in ['c', 'cc', 'cpp', 'cxx', 'c++', 'cu']: - self.TestLanguageRulesCheck('foo.' + extension, 'namespace {', '') - self.TestLanguageRulesCheck('foo.' + extension, 'namespace foo {', '') - - def testBuildClass(self): - # Test that the linter can parse to the end of class definitions, - # and that it will report when it can't. - # Don't warn on forward declarations of various types. - self.TestMultiLineLint( - 'class Foo;', - '') - self.TestMultiLineLint( - """struct Foo* + cpplint._cpplint_state.SetFilters("") + self.TestMultiLineLint( + test_code, + [ + "Single-parameter constructors should be marked explicit." + " [runtime/explicit] [4]", + "{ should almost always be at the end of the previous line" + " [whitespace/braces] [4]", + ], + ) + + cpplint._cpplint_state.SetFilters("-runtime/explicit:foo.h") + self.TestMultiLineLint( + test_code, + "{ should almost always be at the end of the previous line" + " [whitespace/braces] [4]", + ) + + cpplint._cpplint_state.SetFilters("-runtime/explicit:foo.h:2") + self.TestMultiLineLint( + test_code, + "{ should almost always be at the end of the previous line" + " [whitespace/braces] [4]", + ) + + cpplint._cpplint_state.SetFilters( + "-runtime/explicit:foo.h:14,-whitespace/braces:otherfile.h:3" + ) + self.TestMultiLineLint( + test_code, + [ + "Single-parameter constructors should be marked explicit." + " [runtime/explicit] [4]", + "{ should almost always be at the end of the previous line" + " [whitespace/braces] [4]", + ], + ) + + cpplint._cpplint_state.SetFilters( + "-runtime/explicit:foo.h:2,-whitespace/braces:foo.h:3" + ) + self.TestMultiLineLint(test_code, "") + finally: + cpplint._cpplint_state.filters = old_filters + + def testDuplicateHeader(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "path/self.cc", + "cc", + [ + "// Copyright 2014 Your Company. All Rights Reserved.", + '#include "path/self.h"', + '#include "path/duplicate.h"', + '#include "path/duplicate.h"', + "#ifdef MACRO", + '#include "path/unique.h"', + "#else", + '#include "path/unique.h"', + "#endif", + "", + ], + error_collector, + ) + assert error_collector.ResultList() == [ + '"path/duplicate.h" already included at path/self.cc:3 [build/include] [4]' + ] + + def testUnnamedNamespacesInHeaders(self): + for extension in ["h", "hpp", "hxx", "h++", "cuh"]: + self.doTestUnnamedNamespacesInHeaders(extension) + + def doTestUnnamedNamespacesInHeaders(self, extension): + self.TestLanguageRulesCheck( + "foo." + extension, + "namespace {", + "Do not use unnamed namespaces in header files. See" + " https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces" + " for more information. [build/namespaces_headers] [4]", + ) + # namespace registration macros are OK. + self.TestLanguageRulesCheck("foo." + extension, "namespace { \\", "") + # named namespaces are OK. + self.TestLanguageRulesCheck("foo." + extension, "namespace foo {", "") + self.TestLanguageRulesCheck("foo." + extension, "namespace foonamespace {", "") + + def testUnnamedNamespacesInNonHeaders(self): + for extension in ["c", "cc", "cpp", "cxx", "c++", "cu"]: + self.TestLanguageRulesCheck("foo." + extension, "namespace {", "") + self.TestLanguageRulesCheck("foo." + extension, "namespace foo {", "") + + def testBuildClass(self): + # Test that the linter can parse to the end of class definitions, + # and that it will report when it can't. + # Don't warn on forward declarations of various types. + self.TestMultiLineLint("class Foo;", "") + self.TestMultiLineLint( + """struct Foo* foo = NewFoo();""", - '') - # Test preprocessor. - self.TestMultiLineLint( - """#ifdef DERIVE_FROM_GOO + "", + ) + # Test preprocessor. + self.TestMultiLineLint( + """#ifdef DERIVE_FROM_GOO struct Foo : public Goo { #else struct Foo : public Hoo { #endif };""", - '') - self.TestMultiLineLint( - """ + "", + ) + self.TestMultiLineLint( + """ class Foo #ifdef DERIVE_FROM_GOO : public Goo { @@ -4622,2101 +5103,2094 @@ class Foo : public Hoo { #endif };""", - '') - - def testBuildEndComment(self): - # The crosstool compiler we currently use will fail to compile the - # code in this test, so we might consider removing the lint check. - self.TestMultiLineLint( - """#if 0 + "", + ) + + def testBuildEndComment(self): + # The crosstool compiler we currently use will fail to compile the + # code in this test, so we might consider removing the lint check. + self.TestMultiLineLint( + """#if 0 #endif Not a comment""", - 'Uncommented text after #endif is non-standard. Use a comment.' - ' [build/endif_comment] [5]') - - def testBuildForwardDecl(self): - # The crosstool compiler we currently use will fail to compile the - # code in this test, so we might consider removing the lint check. - self.TestLint('class Foo::Goo;', - 'Inner-style forward declarations are invalid.' - ' Remove this line.' - ' [build/forward_decl] [5]') - - def GetBuildHeaderGuardPreprocessorSymbol(self, file_path): - # Figure out the expected header guard by processing an empty file. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', [], error_collector) - for error in error_collector.ResultList(): - matched = re.search( - 'No #ifndef header guard found, suggested CPP variable is: ' - '([A-Z0-9_]+)', - error) - if matched is not None: - return matched.group(1) - - def testBuildHeaderGuard(self): - file_path = 'mydir/foo.h' - expected_guard = self.GetBuildHeaderGuardPreprocessorSymbol(file_path) - self.assertTrue(re.search('MYDIR_FOO_H_$', expected_guard)) - - # No guard at all: expect one error. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', [], error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - 'No #ifndef header guard found, suggested CPP variable is: %s' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # No header guard, but the error is suppressed. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['// Copyright 2014 Your Company.', - '// NOLINT(build/header_guard)', ''], - error_collector) - self.assertEqual([], error_collector.ResultList()) - - # Wrong guard - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef FOO_H', '#define FOO_H'], error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#ifndef header guard has wrong style, please use: %s' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # No define - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef %s' % expected_guard], error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - 'No #ifndef header guard found, suggested CPP variable is: %s' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # Mismatched define - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef %s' % expected_guard, - '#define FOO_H'], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - 'No #ifndef header guard found, suggested CPP variable is: %s' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # No endif - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef %s' % expected_guard, - '#define %s' % expected_guard, - ''], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#endif line should be "#endif // %s"' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # Commentless endif - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef %s' % expected_guard, - '#define %s' % expected_guard, - '#endif'], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#endif line should be "#endif // %s"' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # Commentless endif for old-style guard - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef %s_' % expected_guard, - '#define %s_' % expected_guard, - '#endif'], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#endif line should be "#endif // %s"' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # No header guard errors - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef %s' % expected_guard, - '#define %s' % expected_guard, - '#endif // %s' % expected_guard], - error_collector) - for line in error_collector.ResultList(): - if line.find('build/header_guard') != -1: - self.fail('Unexpected error: %s' % line) - - # No header guard errors for old-style guard - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef %s_' % expected_guard, - '#define %s_' % expected_guard, - '#endif // %s_' % expected_guard], - error_collector) - for line in error_collector.ResultList(): - if line.find('build/header_guard') != -1: - self.fail('Unexpected error: %s' % line) - - old_verbose_level = cpplint._cpplint_state.verbose_level - try: - cpplint._cpplint_state.verbose_level = 0 - # Warn on old-style guard if verbosity is 0. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef %s_' % expected_guard, - '#define %s_' % expected_guard, - '#endif // %s_' % expected_guard], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#ifndef header guard has wrong style, please use: %s' - ' [build/header_guard] [0]' % expected_guard), - error_collector.ResultList()) - finally: - cpplint._cpplint_state.verbose_level = old_verbose_level - - # Completely incorrect header guard - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef FOO', - '#define FOO', - '#endif // FOO'], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#ifndef header guard has wrong style, please use: %s' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#endif line should be "#endif // %s"' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # incorrect header guard with nolint - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'h', - ['#ifndef FOO // NOLINT', - '#define FOO', - '#endif // FOO NOLINT'], - error_collector) - self.assertEqual( - 0, - error_collector.ResultList().count( - '#ifndef header guard has wrong style, please use: %s' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - self.assertEqual( - 0, - error_collector.ResultList().count( - '#endif line should be "#endif // %s"' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # Special case for flymake - for test_file in ['mydir/foo_flymake.h', 'mydir/.flymake/foo.h']: - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(test_file, 'h', - ['// Copyright 2014 Your Company.', ''], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - 'No #ifndef header guard found, suggested CPP variable is: %s' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - # Cuda guard - file_path = 'mydir/foo.cuh' - expected_guard = self.GetBuildHeaderGuardPreprocessorSymbol(file_path) - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'cuh', - ['#ifndef FOO', - '#define FOO', - '#endif // FOO'], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#ifndef header guard has wrong style, please use: %s' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - self.assertEqual( - 1, - error_collector.ResultList().count( - '#endif line should be "#endif // %s"' - ' [build/header_guard] [5]' % expected_guard), - error_collector.ResultList()) - - def testPragmaOnce(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData('mydir/foo.h', 'h', - ['// Copyright 2014 Your Company.', '#pragma once', ''], - error_collector) - self.assertEqual([], error_collector.ResultList()) - - def testBuildHeaderGuardWithRoot(self): - temp_directory = os.path.realpath(tempfile.mkdtemp()) - try: - test_directory = os.path.join(temp_directory, "test") - os.makedirs(test_directory) - os.makedirs(os.path.join(test_directory, ".svn")) - header_directory = os.path.join(test_directory, "cpplint") - os.makedirs(header_directory) - self.doTestBuildHeaderGuardWithRoot(header_directory) - finally: - shutil.rmtree(temp_directory) - - def doTestBuildHeaderGuardWithRoot(self, header_directory): - - # note: Tested file paths must be real, otherwise - # the repository name lookup will fail. - file_path = os.path.join(header_directory, - 'cpplint_test_header.h') - open(file_path, 'a').close() - file_info = cpplint.FileInfo(file_path) - if file_info.FullName() == file_info.RepositoryName(): - # When FileInfo cannot deduce the root directory of the repository, - # FileInfo.RepositoryName returns the same value as FileInfo.FullName. - # This can happen when this source file was obtained without .svn or - # .git directory. (e.g. using 'svn export' or 'git archive'). - # Skip this test in such a case because --root flag makes sense only - # when the root directory of the repository is properly deduced. - return - - self.assertEqual('CPPLINT_CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - # - # test --root flags: - # this changes the cpp header guard prefix - # - - # left-strip the header guard by using a root dir inside of the repo dir. - # relative directory - cpplint._root = 'cpplint' - self.assertEqual('CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - nested_header_directory = os.path.join(header_directory, "nested") - nested_file_path = os.path.join(nested_header_directory, 'cpplint_test_header.h') - os.makedirs(nested_header_directory) - open(nested_file_path, 'a').close() - - cpplint._root = os.path.join('cpplint', 'nested') - actual = cpplint.GetHeaderGuardCPPVariable(nested_file_path) - self.assertEqual('CPPLINT_TEST_HEADER_H_', - actual) - - # absolute directory - # (note that CPPLINT.cfg root=setting is always made absolute) - cpplint._root = header_directory - self.assertEqual('CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - cpplint._root = nested_header_directory - self.assertEqual('CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(nested_file_path)) - - # --root flag is ignored if an non-existent directory is specified. - cpplint._root = 'NON_EXISTENT_DIR' - self.assertEqual('CPPLINT_CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - # prepend to the header guard by using a root dir that is more outer - # than the repo dir - - # (using absolute paths) - # (note that CPPLINT.cfg root=setting is always made absolute) - this_files_path = os.path.dirname(os.path.abspath(file_path)) - (styleguide_path, this_files_dir) = os.path.split(this_files_path) - (styleguide_parent_path, styleguide_dir_name) = os.path.split(styleguide_path) - # parent dir of styleguide - cpplint._root = styleguide_parent_path - self.assertIsNotNone(styleguide_parent_path) - # do not hardcode the 'styleguide' repository name, it could be anything. - expected_prefix = re.sub(r'[^a-zA-Z0-9]', '_', styleguide_dir_name).upper() + '_' - # do not have 'styleguide' repo in '/' - self.assertEqual('%sCPPLINT_CPPLINT_TEST_HEADER_H_' % (expected_prefix), - cpplint.GetHeaderGuardCPPVariable(file_path)) - - # To run the 'relative path' tests, we must be in the directory of this test file. - cur_dir = os.getcwd() - os.chdir(this_files_path) - - # (using relative paths) - styleguide_rel_path = os.path.relpath(styleguide_path, this_files_path) - # '..' - cpplint._root = styleguide_rel_path - self.assertEqual('CPPLINT_CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - styleguide_rel_path = os.path.relpath(styleguide_parent_path, - this_files_path) # '../..' - cpplint._root = styleguide_rel_path - self.assertEqual('%sCPPLINT_CPPLINT_TEST_HEADER_H_' % (expected_prefix), - cpplint.GetHeaderGuardCPPVariable(file_path)) - - cpplint._root = None - - # Restore previous CWD. - os.chdir(cur_dir) - - def testIncludeItsHeader(self): - temp_directory = os.path.realpath(tempfile.mkdtemp()) - cur_dir = os.getcwd() - try: - test_directory = os.path.join(temp_directory, "test") - os.makedirs(test_directory) - file_path = os.path.join(test_directory, 'foo.h') - open(file_path, 'a').close() - file_path = os.path.join(test_directory, 'Bar.h') - open(file_path, 'a').close() - - os.chdir(temp_directory) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'test/foo.cc', 'cc', - [''], - error_collector) - - if platform.system() == 'Windows': - test_directory = test_directory.replace('\\', '/') - expected = "{dir}/{fn}.cc should include its header file {dir}/{fn}.h [build/include] [5]".format( - fn="foo", - dir=test_directory) - self.assertEqual( - 1, - error_collector.Results().count(expected)) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'test/foo.cc', 'cc', - [r'#include "test/foo.h"', - '' - ], - error_collector) - self.assertEqual( - 0, - error_collector.Results().count(expected)) - - # Unix directory aliases are not allowed, and should trigger the - # "include itse header file" error - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'test/foo.cc', 'cc', - [r'#include "./test/foo.h"', - '' - ], - error_collector) - expected = "{dir}/{fn}.cc should include its header file {dir}/{fn}.h{unix_text} [build/include] [5]".format( - fn="foo", - dir=test_directory, - unix_text=". Relative paths like . and .. are not allowed.") - self.assertEqual( - 1, - error_collector.Results().count(expected)) - - # This should continue to work - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'test/Bar.cc', 'cc', - [r'#include "test/Bar.h"', - '' - ], - error_collector) - expected = "{dir}/{fn}.cc should include its header file {dir}/{fn}.h [build/include] [5]".format( - fn="Bar", - dir=test_directory) - self.assertEqual( - 0, - error_collector.Results().count(expected)) - - # Since Bar.cc & Bar.h look 3rd party-ish, it should be ok without the include dir - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'test/Bar.cc', 'cc', - [r'#include "Bar.h"', - '' - ], - error_collector) - self.assertEqual( - 0, - error_collector.Results().count(expected)) - - # Test edge case in which multiple files have the same base name - open(os.path.join(test_directory, 'foo.hpp'), 'a').close() - cpplint.ProcessFileData( - 'test/foo.cc', 'cc', - [r'#include "foo.hpp"', - '' - ], - error_collector) - self.assertEqual( - 0, - error_collector.Results().count(expected)) - - finally: - # Restore previous CWD. - os.chdir(cur_dir) - shutil.rmtree(temp_directory) - - def testPathSplitToList(self): - self.assertEqual([''], - cpplint.PathSplitToList(os.path.join(''))) - - self.assertEqual(['.'], - cpplint.PathSplitToList(os.path.join('.'))) - - self.assertEqual(['..'], - cpplint.PathSplitToList(os.path.join('..'))) - - self.assertEqual(['..', 'a', 'b'], - cpplint.PathSplitToList(os.path.join('..', 'a', 'b'))) - - self.assertEqual(['a', 'b', 'c', 'd'], - cpplint.PathSplitToList(os.path.join('a', 'b', 'c', 'd'))) - - def testBuildHeaderGuardWithRepository(self): - temp_directory = os.path.realpath(tempfile.mkdtemp()) - temp_directory2 = os.path.realpath(tempfile.mkdtemp()) - - # On Windows, os.path.relpath fails when the input is on - # a different drive than the current drive. - # In GitHub Actions CI, TEMP is set to C: drive, while the - # repository clone is on D: drive. - current_directory = os.getcwd() - try: - os.chdir(temp_directory) - - os.makedirs(os.path.join(temp_directory, ".svn")) - trunk_dir = os.path.join(temp_directory, "trunk") - os.makedirs(trunk_dir) - header_directory = os.path.join(trunk_dir, "cpplint") - os.makedirs(header_directory) - file_path = os.path.join(header_directory, 'cpplint_test_header.h') - open(file_path, 'a').close() - - # search for .svn if _repository is not specified - self.assertEqual('TRUNK_CPPLINT_CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - # use the provided repository root for header guards - cpplint._repository = os.path.relpath(trunk_dir) - self.assertEqual('CPPLINT_CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - cpplint._repository = os.path.abspath(trunk_dir) - self.assertEqual('CPPLINT_CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - # ignore _repository if it doesn't exist - cpplint._repository = os.path.join(temp_directory, 'NON_EXISTENT') - self.assertEqual('TRUNK_CPPLINT_CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - # ignore _repository if it exists but file isn't in it - cpplint._repository = os.path.relpath(temp_directory2) - self.assertEqual('TRUNK_CPPLINT_CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - # _root should be relative to _repository - cpplint._repository = os.path.relpath(trunk_dir) - cpplint._root = 'cpplint' - self.assertEqual('CPPLINT_TEST_HEADER_H_', - cpplint.GetHeaderGuardCPPVariable(file_path)) - - finally: - os.chdir(current_directory) - shutil.rmtree(temp_directory) - shutil.rmtree(temp_directory2) - cpplint._repository = None - cpplint._root = None - - def testBuildInclude(self): - # Test that include statements have slashes in them. - self.TestLint('#include "foo.h"', - 'Include the directory when naming header files' - ' [build/include_subdir] [4]') - self.TestLint('#include "bar.hh"', - 'Include the directory when naming header files' - ' [build/include_subdir] [4]') - self.TestLint('#include "baz.aa"', '') - self.TestLint('#include "dir/foo.h"', '') - self.TestLint('#include "Python.h"', '') - self.TestLint('#include "lua.h"', '') - - def testHppInclude(self): - code = '\n'.join([ - '#include ', - '#include ' - ]) - self.TestLanguageRulesCheck('foo.h', code, '') - - def testBuildPrintfFormat(self): - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - [r'printf("\%%d", value);', - r'snprintf(buffer, sizeof(buffer), "\[%d", value);', - r'fprintf(file, "\(%d", value);', - r'vsnprintf(buffer, sizeof(buffer), "\\\{%d", ap);'], - error_collector) - self.assertEqual( - 4, - error_collector.Results().count( - '%, [, (, and { are undefined character escapes. Unescape them.' - ' [build/printf_format] [3]')) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - 'foo.cc', 'cc', - ['// Copyright 2014 Your Company.', - '#include ', - r'printf("\\%%%d", value);', - r'printf(R"(\[)");', - r'printf(R"(\[%s)", R"(\])");', - ''], - error_collector) - self.assertEqual('', error_collector.Results()) - - def testRuntimePrintfFormat(self): - self.TestLint( - r'fprintf(file, "%q", value);', - '%q in format strings is deprecated. Use %ll instead.' - ' [runtime/printf_format] [3]') - - self.TestLint( - r'aprintf(file, "The number is %12q", value);', - '%q in format strings is deprecated. Use %ll instead.' - ' [runtime/printf_format] [3]') - - self.TestLint( - r'printf(file, "The number is" "%-12q", value);', - '%q in format strings is deprecated. Use %ll instead.' - ' [runtime/printf_format] [3]') - - self.TestLint( - r'printf(file, "The number is" "%+12q", value);', - '%q in format strings is deprecated. Use %ll instead.' - ' [runtime/printf_format] [3]') - - self.TestLint( - r'printf(file, "The number is" "% 12q", value);', - '%q in format strings is deprecated. Use %ll instead.' - ' [runtime/printf_format] [3]') - - self.TestLint( - r'snprintf(file, "Never mix %d and %1$d parameters!", value);', - '%N$ formats are unconventional. Try rewriting to avoid them.' - ' [runtime/printf_format] [2]') - - def TestLintLogCodeOnError(self, code, expected_message): - # Special TestLint which logs the input code on error. - result = self.PerformSingleLineLint(code) - if result != expected_message: - self.fail('For code: "%s"\nGot: "%s"\nExpected: "%s"' - % (code, result, expected_message)) - - def testBuildStorageClass(self): - qualifiers = [None, 'const', 'volatile'] - signs = [None, 'signed', 'unsigned'] - types = ['void', 'char', 'int', 'float', 'double', - 'schar', 'int8_t', 'uint8_t', 'int16_t', 'uint16_t', - 'int32_t', 'uint32_t', 'int64_t', 'uint64_t'] - storage_classes = ['extern', 'register', 'static', 'typedef'] - - build_storage_class_error_message = ( - 'Storage-class specifier (static, extern, typedef, etc) should be ' - 'at the beginning of the declaration. [build/storage_class] [5]') - - # Some explicit cases. Legal in C++, deprecated in C99. - self.TestLint('const int static foo = 5;', - build_storage_class_error_message) - - self.TestLint('char static foo;', - build_storage_class_error_message) - - self.TestLint('double const static foo = 2.0;', - build_storage_class_error_message) - - self.TestLint('uint64_t typedef unsigned_long_long;', - build_storage_class_error_message) - - self.TestLint('int register foo = 0;', - build_storage_class_error_message) - - # Since there are a very large number of possibilities, randomly - # construct declarations. - # Make sure that the declaration is logged if there's an error. - # Seed generator with an integer for absolute reproducibility. - random.seed(25) - for unused_i in range(10): - # Build up random list of non-storage-class declaration specs. - other_decl_specs = [random.choice(qualifiers), random.choice(signs), - random.choice(types)] - # remove None - other_decl_specs = [x for x in other_decl_specs if x is not None] - - # shuffle - random.shuffle(other_decl_specs) - - # insert storage class after the first - storage_class = random.choice(storage_classes) - insertion_point = random.randint(1, len(other_decl_specs)) - decl_specs = (other_decl_specs[0:insertion_point] - + [storage_class] - + other_decl_specs[insertion_point:]) - - self.TestLintLogCodeOnError( - ' '.join(decl_specs) + ';', - build_storage_class_error_message) - - # but no error if storage class is first - self.TestLintLogCodeOnError( - storage_class + ' ' + ' '.join(other_decl_specs), - '') - - def testLegalCopyright(self): - legal_copyright_message = ( - 'No copyright message found. ' - 'You should have a line: "Copyright [year] "' - ' [legal/copyright] [5]') - - copyright_line = '// Copyright 2014 Google Inc. All Rights Reserved.' - - file_path = 'mydir/googleclient/foo.cc' - - # There should be a copyright message in the first 10 lines - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'cc', [], error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count(legal_copyright_message)) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - file_path, 'cc', - ['' for unused_i in range(10)] + [copyright_line], - error_collector) - self.assertEqual( - 1, - error_collector.ResultList().count(legal_copyright_message)) - - # Test that warning isn't issued if Copyright line appears early enough. - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(file_path, 'cc', [copyright_line], error_collector) - for message in error_collector.ResultList(): - if message.find('legal/copyright') != -1: - self.fail('Unexpected error: %s' % message) - - error_collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData( - file_path, 'cc', - ['' for unused_i in range(9)] + [copyright_line], - error_collector) - for message in error_collector.ResultList(): - if message.find('legal/copyright') != -1: - self.fail('Unexpected error: %s' % message) - - def testInvalidIncrement(self): - self.TestLint('*count++;', - 'Changing pointer instead of value (or unused value of ' - 'operator*). [runtime/invalid_increment] [5]') - - def testSnprintfSize(self): - self.TestLint('vsnprintf(NULL, 0, format)', '') - self.TestLint('snprintf(fisk, 1, format)', - 'If you can, use sizeof(fisk) instead of 1 as the 2nd arg ' - 'to snprintf. [runtime/printf] [3]') -class CxxTest(CpplintTestBase): - - def Helper(self, package, extension, lines, count): - filename = package + '/foo.' + extension - lines = lines[:] - - # Header files need to have an ifdef guard wrapped around their code. - if extension.startswith('h'): - guard = filename.upper().replace('/', '_').replace('.', '_') + '_' - lines.insert(0, '#ifndef ' + guard) - lines.insert(1, '#define ' + guard) - lines.append('#endif // ' + guard) - - # All files need a final blank line. - lines.append('') - - # Process the file and check resulting error count. - collector = ErrorCollector(self.assertTrue) - cpplint.ProcessFileData(filename, extension, lines, collector) - error_list = collector.ResultList() - self.assertEqual(count, len(error_list), error_list) - - def TestCxxFeature(self, code, expected_error): - lines = code.split('\n') - collector = ErrorCollector(self.assertTrue) - cpplint.RemoveMultiLineComments('foo.h', lines, collector) - clean_lines = cpplint.CleansedLines(lines) - cpplint.FlagCxxHeaders('foo.cc', clean_lines, 0, collector) - self.assertEqual(expected_error, collector.Results()) - - def testBlockedHeaders(self): - self.TestCxxFeature('#include ', - ' is an unapproved C++11 header.' - ' [build/c++11] [5]') - self.TestCxxFeature('#include ', - ' is an unapproved C++11 header.' - ' [build/c++11] [5]') - self.TestCxxFeature('#include ', - ' is an unapproved C++17 header.' - ' [build/c++17] [5]') - - def testExplicitMakePair(self): - self.TestLint('make_pair', '') - self.TestLint('make_pair(42, 42)', '') - self.TestLint('make_pair<', - 'For C++11-compatibility, omit template arguments from' - ' make_pair OR use pair directly OR if appropriate,' - ' construct a pair directly' - ' [build/explicit_make_pair] [4]') - self.TestLint('make_pair <', - 'For C++11-compatibility, omit template arguments from' - ' make_pair OR use pair directly OR if appropriate,' - ' construct a pair directly' - ' [build/explicit_make_pair] [4]') - self.TestLint('my_make_pair', '') - - -class CleansedLinesTest(unittest.TestCase): - - def testInit(self): - lines = ['Line 1', - 'Line 2', - 'Line 3 // Comment test', - 'Line 4 /* Comment test */', - 'Line 5 "foo"'] - - clean_lines = cpplint.CleansedLines(lines) - self.assertEqual(lines, clean_lines.raw_lines) - self.assertEqual(5, clean_lines.NumLines()) - - self.assertEqual(['Line 1', - 'Line 2', - 'Line 3', - 'Line 4', - 'Line 5 "foo"'], - clean_lines.lines) - - self.assertEqual(['Line 1', - 'Line 2', - 'Line 3', - 'Line 4', - 'Line 5 ""'], - clean_lines.elided) - - def testInitEmpty(self): - clean_lines = cpplint.CleansedLines([]) - self.assertEqual([], clean_lines.raw_lines) - self.assertEqual(0, clean_lines.NumLines()) - - def testCollapseStrings(self): - collapse = cpplint.CleansedLines._CollapseStrings - self.assertEqual('""', collapse('""')) # "" (empty) - self.assertEqual('"""', collapse('"""')) # """ (bad) - self.assertEqual('""', collapse('"xyz"')) # "xyz" (string) - self.assertEqual('""', collapse('"\\\""')) # "\"" (string) - self.assertEqual('""', collapse('"\'"')) # "'" (string) - self.assertEqual('"\"', collapse('"\"')) # "\" (bad) - self.assertEqual('""', collapse('"\\\\"')) # "\\" (string) - self.assertEqual('"', collapse('"\\\\\\"')) # "\\\" (bad) - self.assertEqual('""', collapse('"\\\\\\\\"')) # "\\\\" (string) - - self.assertEqual('\'\'', collapse('\'\'')) # '' (empty) - self.assertEqual('\'\'', collapse('\'a\'')) # 'a' (char) - self.assertEqual('\'\'', collapse('\'\\\'\'')) # '\'' (char) - self.assertEqual('\'', collapse('\'\\\'')) # '\' (bad) - self.assertEqual('', collapse('\\012')) # '\012' (char) - self.assertEqual('', collapse('\\xfF0')) # '\xfF0' (char) - self.assertEqual('', collapse('\\n')) # '\n' (char) - self.assertEqual(r'\#', collapse('\\#')) # '\#' (bad) - - self.assertEqual('"" + ""', collapse('"\'" + "\'"')) - self.assertEqual("'', ''", collapse("'\"', '\"'")) - self.assertEqual('""[0b10]', collapse('"a\'b"[0b1\'0]')) - - self.assertEqual('42', collapse("4'2")) - self.assertEqual('0b0101', collapse("0b0'1'0'1")) - self.assertEqual('1048576', collapse("1'048'576")) - self.assertEqual('0X100000', collapse("0X10'0000")) - self.assertEqual('0004000000', collapse("0'004'000'000")) - self.assertEqual('1.602176565e-19', collapse("1.602'176'565e-19")) - self.assertEqual('\'\' + 0xffff', collapse("'i' + 0xf'f'f'f")) - self.assertEqual('sizeof\'\' == 1', collapse("sizeof'x' == 1")) - self.assertEqual('0x.03p100', collapse('0x.0\'3p1\'0\'0')) - self.assertEqual('123.45', collapse('1\'23.4\'5')) - - self.assertEqual('StringReplace(body, "", "");', - collapse('StringReplace(body, "\\\\", "\\\\\\\\");')) - self.assertEqual('\'\' ""', - collapse('\'"\' "foo"')) - - -class OrderOfIncludesTest(CpplintTestBase): - - def setUp(self): - CpplintTestBase.setUp(self) - self.include_state = cpplint._IncludeState() - os.path.abspath = lambda value: value - - def testCheckNextIncludeOrder_OtherThenCpp(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._OTHER_HEADER)) - self.assertEqual('Found C++ system header after other header', - self.include_state.CheckNextIncludeOrder( - cpplint._CPP_SYS_HEADER)) - - def testCheckNextIncludeOrder_CppThenC(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._CPP_SYS_HEADER)) - self.assertEqual('Found C system header after C++ system header', - self.include_state.CheckNextIncludeOrder( - cpplint._C_SYS_HEADER)) - - def testCheckNextIncludeOrder_OtherSysThenC(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._OTHER_SYS_HEADER)) - self.assertEqual('Found C system header after other system header', - self.include_state.CheckNextIncludeOrder( - cpplint._C_SYS_HEADER)) - - def testCheckNextIncludeOrder_OtherSysThenCpp(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._OTHER_SYS_HEADER)) - self.assertEqual('Found C++ system header after other system header', - self.include_state.CheckNextIncludeOrder( - cpplint._CPP_SYS_HEADER)) - - def testCheckNextIncludeOrder_LikelyThenCpp(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._LIKELY_MY_HEADER)) - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._CPP_SYS_HEADER)) - - def testCheckNextIncludeOrder_PossibleThenCpp(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._POSSIBLE_MY_HEADER)) - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._CPP_SYS_HEADER)) - - def testCheckNextIncludeOrder_CppThenLikely(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._CPP_SYS_HEADER)) - # This will eventually fail. - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._LIKELY_MY_HEADER)) - - def testCheckNextIncludeOrder_CppThenPossible(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._CPP_SYS_HEADER)) - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._POSSIBLE_MY_HEADER)) - - def testCheckNextIncludeOrder_CppThenOtherSys(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._CPP_SYS_HEADER)) - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._OTHER_SYS_HEADER)) - - def testCheckNextIncludeOrder_OtherSysThenPossible(self): - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._OTHER_SYS_HEADER)) - self.assertEqual('', self.include_state.CheckNextIncludeOrder( - cpplint._POSSIBLE_MY_HEADER)) - - - def testClassifyInclude(self): - file_info = cpplint.FileInfo - classify_include = cpplint._ClassifyInclude - self.assertEqual(cpplint._C_SYS_HEADER, - classify_include(file_info('foo/foo.cc'), - 'stdio.h', - True)) - self.assertEqual(cpplint._C_SYS_HEADER, - classify_include(file_info('foo/foo.cc'), - 'sys/time.h', - True)) - self.assertEqual(cpplint._C_SYS_HEADER, - classify_include(file_info('foo/foo.cc'), - 'netipx/ipx.h', - True)) - self.assertEqual(cpplint._C_SYS_HEADER, - classify_include(file_info('foo/foo.cc'), - 'arpa/ftp.h', - True)) - self.assertEqual(cpplint._CPP_SYS_HEADER, - classify_include(file_info('foo/foo.cc'), - 'string', - True)) - self.assertEqual(cpplint._CPP_SYS_HEADER, - classify_include(file_info('foo/foo.cc'), - 'typeinfo', - True)) - self.assertEqual(cpplint._C_SYS_HEADER, - classify_include(file_info('foo/foo.cc'), - 'foo/foo.h', - True)) - self.assertEqual(cpplint._OTHER_SYS_HEADER, - classify_include(file_info('foo/foo.cc'), - 'foo/foo.h', - True, - "standardcfirst")) - self.assertEqual(cpplint._OTHER_HEADER, - classify_include(file_info('foo/foo.cc'), - 'string', - False)) - self.assertEqual(cpplint._OTHER_HEADER, - classify_include(file_info('foo/foo.cc'), - 'boost/any.hpp', - True)) - self.assertEqual(cpplint._OTHER_HEADER, - classify_include(file_info('foo/foo.hxx'), - 'boost/any.hpp', - True)) - self.assertEqual(cpplint._OTHER_HEADER, - classify_include(file_info('foo/foo.h++'), - 'boost/any.hpp', - True)) - self.assertEqual(cpplint._LIKELY_MY_HEADER, - classify_include(file_info('foo/foo.cc'), - 'foo/foo-inl.h', - False)) - self.assertEqual(cpplint._LIKELY_MY_HEADER, - classify_include(file_info('foo/internal/foo.cc'), - 'foo/public/foo.h', - False)) - self.assertEqual(cpplint._POSSIBLE_MY_HEADER, - classify_include(file_info('foo/internal/foo.cc'), - 'foo/other/public/foo.h', - False)) - self.assertEqual(cpplint._OTHER_HEADER, - classify_include(file_info('foo/internal/foo.cc'), - 'foo/other/public/foop.h', - False)) - - def testTryDropCommonSuffixes(self): - cpplint._hpp_headers = set([]) - cpplint._valid_extensions = set([]) - self.assertEqual('foo/foo', cpplint._DropCommonSuffixes('foo/foo-inl.h')) - self.assertEqual('foo/foo', cpplint._DropCommonSuffixes('foo/foo-inl.hxx')) - self.assertEqual('foo/foo', cpplint._DropCommonSuffixes('foo/foo-inl.h++')) - self.assertEqual('foo/foo', cpplint._DropCommonSuffixes('foo/foo-inl.hpp')) - self.assertEqual('foo/bar/foo', - cpplint._DropCommonSuffixes('foo/bar/foo_inl.h')) - self.assertEqual('foo/foo', cpplint._DropCommonSuffixes('foo/foo.cc')) - self.assertEqual('foo/foo', cpplint._DropCommonSuffixes('foo/foo.cxx')) - self.assertEqual('foo/foo', cpplint._DropCommonSuffixes('foo/foo.c')) - self.assertEqual('foo/foo_unusualinternal', - cpplint._DropCommonSuffixes('foo/foo_unusualinternal.h')) - self.assertEqual('foo/foo_unusualinternal', - cpplint._DropCommonSuffixes('foo/foo_unusualinternal.hpp')) - self.assertEqual('', - cpplint._DropCommonSuffixes('_test.cc')) - self.assertEqual('', - cpplint._DropCommonSuffixes('_test.c')) - self.assertEqual('', - cpplint._DropCommonSuffixes('_test.c++')) - self.assertEqual('test', - cpplint._DropCommonSuffixes('test.c')) - self.assertEqual('test', - cpplint._DropCommonSuffixes('test.cc')) - self.assertEqual('test', - cpplint._DropCommonSuffixes('test.c++')) - - def testRegression(self): - def Format(includes): - include_list = [] - for item in includes: - if item.startswith('"') or item.startswith('<'): - include_list.append('#include %s\n' % item) - else: - include_list.append(item + '\n') - return ''.join(include_list) - - # Test singleton cases first. - self.TestLanguageRulesCheck('foo/foo.cc', Format(['"foo/foo.h"']), '') - self.TestLanguageRulesCheck('foo/foo.cc', Format(['']), '') - self.TestLanguageRulesCheck('foo/foo.cc', Format(['']), '') - self.TestLanguageRulesCheck('foo/foo.cc', Format(['"foo/foo-inl.h"']), '') - self.TestLanguageRulesCheck('foo/foo.cc', Format(['"bar/bar-inl.h"']), '') - self.TestLanguageRulesCheck('foo/foo.cc', Format(['"bar/bar.h"']), '') - - # Test everything in a good and new order. - self.TestLanguageRulesCheck('foo/foo.cc', - Format(['"foo/foo.h"', - '"foo/foo-inl.h"', - '', - '', - '', - '"bar/bar-inl.h"', - '"bar/bar.h"']), - '') - - # Test bad orders. - self.TestLanguageRulesCheck( - 'foo/foo.cc', - Format(['', '']), - 'Found C system header after C++ system header.' - ' Should be: foo.h, c system, c++ system, other.' - ' [build/include_order] [4]') - self.TestLanguageRulesCheck( - 'foo/foo.cc', - Format(['"foo/bar-inl.h"', - '"foo/foo-inl.h"']), - '') - self.TestLanguageRulesCheck( - 'foo/foo.cc', - Format(['"foo/e.h"', - '"foo/b.h"', # warning here (e>b) - '"foo/c.h"', - '"foo/d.h"', - '"foo/a.h"']), # warning here (d>a) - ['Include "foo/b.h" not in alphabetical order' - ' [build/include_alpha] [4]', - 'Include "foo/a.h" not in alphabetical order' - ' [build/include_alpha] [4]']) - # -inl.h headers are no longer special. - self.TestLanguageRulesCheck('foo/foo.cc', - Format(['"foo/foo-inl.h"', '']), - '') - self.TestLanguageRulesCheck('foo/foo.cc', - Format(['"foo/bar.h"', '"foo/bar-inl.h"']), - '') - # Test componentized header. OK to have my header in ../public dir. - self.TestLanguageRulesCheck('foo/internal/foo.cc', - Format(['"foo/public/foo.h"', '']), - '') - # OK to have my header in other dir (not stylistically, but - # cpplint isn't as good as a human). - self.TestLanguageRulesCheck('foo/internal/foo.cc', - Format(['"foo/other/public/foo.h"', - '']), - '') - self.TestLanguageRulesCheck('foo/foo.cc', - Format(['"foo/foo.h"', - '', - '"base/google.h"', - '"base/flags.h"']), - 'Include "base/flags.h" not in alphabetical ' - 'order [build/include_alpha] [4]') - # According to the style, -inl.h should come before .h, but we don't - # complain about that. - self.TestLanguageRulesCheck('foo/foo.cc', - Format(['"foo/foo-inl.h"', - '"foo/foo.h"', - '"base/google.h"', - '"base/google-inl.h"']), - '') - # Allow project includes to be separated by blank lines - self.TestLanguageRulesCheck('a/a.cc', - Format(['"a/a.h"', - '', - '"base/google.h"', - '', - '"b/c.h"', - '', - 'MACRO', - '"a/b.h"']), - '') - self.TestLanguageRulesCheck('a/a.cc', - Format(['"a/a.h"', - '', - '"base/google.h"', - '"a/b.h"']), - 'Include "a/b.h" not in alphabetical ' - 'order [build/include_alpha] [4]') - - # Test conditional includes - self.TestLanguageRulesCheck( - 'a/a.cc', - ''.join(['#include \n', - '#include "base/port.h"\n', - '#include \n']), - ('Found C++ system header after other header. ' - 'Should be: a.h, c system, c++ system, other. ' - '[build/include_order] [4]')) - self.TestLanguageRulesCheck( - 'a/a.cc', - ''.join(['#include \n', - '#include "base/port.h"\n', - '#ifdef LANG_CXX11\n', - '#include \n', - '#endif // LANG_CXX11\n']), - '') - self.TestLanguageRulesCheck( - 'a/a.cc', - ''.join(['#include \n', - '#ifdef LANG_CXX11\n', - '#include "base/port.h"\n', - '#include \n', - '#endif // LANG_CXX11\n']), - ('Found C++ system header after other header. ' - 'Should be: a.h, c system, c++ system, other. ' - '[build/include_order] [4]')) - - # Third party headers are exempt from order checks - self.TestLanguageRulesCheck('foo/foo.cc', - Format(['', '"Python.h"', '']), - '') - - -class CheckForFunctionLengthsTest(CpplintTestBase): - - def setUp(self): - # Reducing these thresholds for the tests speeds up tests significantly. - CpplintTestBase.setUp(self) - self.old_normal_trigger = cpplint._FunctionState._NORMAL_TRIGGER - self.old_test_trigger = cpplint._FunctionState._TEST_TRIGGER - - cpplint._FunctionState._NORMAL_TRIGGER = 10 - cpplint._FunctionState._TEST_TRIGGER = 25 - - def tearDown(self): - cpplint._FunctionState._NORMAL_TRIGGER = self.old_normal_trigger - cpplint._FunctionState._TEST_TRIGGER = self.old_test_trigger - - def TestFunctionLengthsCheck(self, code, expected_message): - """Check warnings for long function bodies are as expected. + "Uncommented text after #endif is non-standard. Use a comment." + " [build/endif_comment] [5]", + ) + + def testBuildForwardDecl(self): + # The crosstool compiler we currently use will fail to compile the + # code in this test, so we might consider removing the lint check. + self.TestLint( + "class Foo::Goo;", + "Inner-style forward declarations are invalid." + " Remove this line." + " [build/forward_decl] [5]", + ) + + def testBuildDeprecated(self): + self.TestLint( + "a ? and ?= b", + ">? and ", "#include "]) + self.TestLanguageRulesCheck("foo.h", code, "") + + def testBuildPrintfFormat(self): + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + r'printf("\%%d", value);', + r'snprintf(buffer, sizeof(buffer), "\[%d", value);', + r'fprintf(file, "\(%d", value);', + r'vsnprintf(buffer, sizeof(buffer), "\\\{%d", ap);', + ], + error_collector, + ) + assert ( + error_collector.Results().count( + "%, [, (, and { are undefined character escapes. Unescape them. " + "[build/printf_format] [3]" + ) + == 4 + ) + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + "foo.cc", + "cc", + [ + "// Copyright 2014 Your Company.", + "#include ", + r'printf("\\%%%d", value);', + r'printf(R"(\[)");', + r'printf(R"(\[%s)", R"(\])");', + "", + ], + error_collector, + ) + assert error_collector.Results() == "" + + def testRuntimePrintfFormat(self): + self.TestLint( + r'fprintf(file, "%q", value);', + "%q in format strings is deprecated. Use %ll instead. [runtime/printf_format] [3]", + ) + + self.TestLint( + r'aprintf(file, "The number is %12q", value);', + "%q in format strings is deprecated. Use %ll instead. [runtime/printf_format] [3]", + ) + + self.TestLint( + r'printf(file, "The number is" "%-12q", value);', + "%q in format strings is deprecated. Use %ll instead. [runtime/printf_format] [3]", + ) + + self.TestLint( + r'printf(file, "The number is" "%+12q", value);', + "%q in format strings is deprecated. Use %ll instead. [runtime/printf_format] [3]", + ) + + self.TestLint( + r'printf(file, "The number is" "% 12q", value);', + "%q in format strings is deprecated. Use %ll instead. [runtime/printf_format] [3]", + ) + + self.TestLint( + r'snprintf(file, "Never mix %d and %1$d parameters!", value);', + "%N$ formats are unconventional. Try rewriting to avoid them." + " [runtime/printf_format] [2]", + ) + + def TestLintLogCodeOnError(self, code, expected_message): + # Special TestLint which logs the input code on error. + assert (result := self.PerformSingleLineLint(code)) == expected_message, ( + f'For code: "{code}"\nGot: "{result}"\nExpected: "{expected_message}"' + ) + + def testBuildStorageClass(self): + qualifiers = [None, "const", "volatile"] + signs = [None, "signed", "unsigned"] + types = [ + "void", + "char", + "int", + "float", + "double", + "schar", + "int8_t", + "uint8_t", + "int16_t", + "uint16_t", + "int32_t", + "uint32_t", + "int64_t", + "uint64_t", + ] + storage_classes = ["extern", "register", "static", "typedef"] + + build_storage_class_error_message = ( + "Storage-class specifier (static, extern, typedef, etc) should be " + "at the beginning of the declaration. [build/storage_class] [5]" + ) + + # Some explicit cases. Legal in C++, deprecated in C99. + self.TestLint("const int static foo = 5;", build_storage_class_error_message) + + self.TestLint("char static foo;", build_storage_class_error_message) + + self.TestLint("double const static foo = 2.0;", build_storage_class_error_message) + + self.TestLint("uint64_t typedef unsigned_long_long;", build_storage_class_error_message) + + self.TestLint("int register foo = 0;", build_storage_class_error_message) + + # Since there are a very large number of possibilities, randomly + # construct declarations. + # Make sure that the declaration is logged if there's an error. + # Seed generator with an integer for absolute reproducibility. + random.seed(25) + for _i in range(10): + # Build up random list of non-storage-class declaration specs. + other_decl_specs = [ + random.choice(qualifiers), + random.choice(signs), + random.choice(types), + ] + # remove None + other_decl_specs = [x for x in other_decl_specs if x is not None] + + # shuffle + random.shuffle(other_decl_specs) + + # insert storage class after the first + storage_class = random.choice(storage_classes) + insertion_point = random.randint(1, len(other_decl_specs)) + decl_specs = ( + other_decl_specs[0:insertion_point] + + [storage_class] + + other_decl_specs[insertion_point:] + ) + + self.TestLintLogCodeOnError( + " ".join(decl_specs) + ";", build_storage_class_error_message + ) + + # but no error if storage class is first + self.TestLintLogCodeOnError(storage_class + " " + " ".join(other_decl_specs), "") + + def testLegalCopyright(self): + legal_copyright_message = ( + "No copyright message found. " + 'You should have a line: "Copyright [year] "' + " [legal/copyright] [5]" + ) + + copyright_line = "// Copyright 2014 Google Inc. All Rights Reserved." + + file_path = "mydir/googleclient/foo.cc" + + # There should be a copyright message in the first 10 lines + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData(file_path, "cc", [], error_collector) + assert error_collector.ResultList().count(legal_copyright_message) == 1 + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + file_path, "cc", ["" for unused_i in range(10)] + [copyright_line], error_collector + ) + assert error_collector.ResultList().count(legal_copyright_message) == 1 + + # Test that warning isn't issued if Copyright line appears early enough. + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData(file_path, "cc", [copyright_line], error_collector) + for line in error_collector.ResultList(): + assert "legal/copyright" not in line + + error_collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData( + file_path, "cc", ["" for unused_i in range(9)] + [copyright_line], error_collector + ) + for line in error_collector.ResultList(): + assert "legal/copyright" not in line + + def testInvalidIncrement(self): + self.TestLint( + "*count++;", + "Changing pointer instead of value (or unused value of " + "operator*). [runtime/invalid_increment] [5]", + ) + + def testSnprintfSize(self): + self.TestLint("vsnprintf(NULL, 0, format)", "") + self.TestLint( + "snprintf(fisk, 1, format)", + "If you can, use sizeof(fisk) instead of 1 as the 2nd arg " + "to snprintf. [runtime/printf] [3]", + ) + + +class TestCxx(CpplintTestBase): + def Helper(self, package, extension, lines, count): + filename = package + "/foo." + extension + lines = lines[:] + + # Header files need to have an ifdef guard wrapped around their code. + if extension.startswith("h"): + guard = filename.upper().replace("/", "_").replace(".", "_") + "_" + lines.insert(0, "#ifndef " + guard) + lines.insert(1, "#define " + guard) + lines.append("#endif // " + guard) + + # All files need a final blank line. + lines.append("") + + # Process the file and check resulting error count. + collector = ErrorCollector(self.assertTrue) + cpplint.ProcessFileData(filename, extension, lines, collector) + error_list = collector.ResultList() + assert count == len(error_list), error_list + + def TestCxxFeature(self, code, expected_error): + lines = code.split("\n") + collector = ErrorCollector(self.assertTrue) + cpplint.RemoveMultiLineComments("foo.h", lines, collector) + clean_lines = cpplint.CleansedLines(lines) + cpplint.FlagCxxHeaders("foo.cc", clean_lines, 0, collector) + assert expected_error == collector.Results() + + def testBlockedHeaders(self): + self.TestCxxFeature( + "#include ", " is an unapproved C++11 header. [build/c++11] [5]" + ) + self.TestCxxFeature( + "#include ", " is an unapproved C++11 header. [build/c++11] [5]" + ) + self.TestCxxFeature( + "#include ", + " is an unapproved C++17 header. [build/c++17] [5]", + ) + + def testExplicitMakePair(self): + self.TestLint("make_pair", "") + self.TestLint("make_pair(42, 42)", "") + self.TestLint( + "make_pair<", + "For C++11-compatibility, omit template arguments from" + " make_pair OR use pair directly OR if appropriate," + " construct a pair directly" + " [build/explicit_make_pair] [4]", + ) + self.TestLint( + "make_pair <", + "For C++11-compatibility, omit template arguments from" + " make_pair OR use pair directly OR if appropriate," + " construct a pair directly" + " [build/explicit_make_pair] [4]", + ) + self.TestLint("my_make_pair", "") + + +class TestCleansedLines: + def testInit(self): + lines = [ + "Line 1", + "Line 2", + "Line 3 // Comment test", + "Line 4 /* Comment test */", + 'Line 5 "foo"', + ] + + clean_lines = cpplint.CleansedLines(lines) + assert lines == clean_lines.raw_lines + assert clean_lines.NumLines() == 5 + + assert clean_lines.lines == ["Line 1", "Line 2", "Line 3", "Line 4", 'Line 5 "foo"'] + + assert clean_lines.elided == ["Line 1", "Line 2", "Line 3", "Line 4", 'Line 5 ""'] + + def testInitEmpty(self): + clean_lines = cpplint.CleansedLines([]) + assert clean_lines.raw_lines == [] + assert clean_lines.NumLines() == 0 + + def testCollapseStrings(self): + collapse = cpplint.CleansedLines._CollapseStrings + assert collapse('""') == '""' # "" (empty) + assert collapse('"""') == '"""' # """ (bad) + assert collapse('"xyz"') == '""' # "xyz" (string) + assert collapse('"\\""') == '""' # "\"" (string) + assert collapse('"\'"') == '""' # "'" (string) + assert collapse('""') == '""' # "\" (bad) + assert collapse('"\\\\"') == '""' # "\\" (string) + assert collapse('"\\\\\\"') == '"' # "\\\" (bad) + assert collapse('"\\\\\\\\"') == '""' # "\\\\" (string) + + assert collapse("''") == "''" # '' (empty) + assert collapse("'a'") == "''" # 'a' (char) + assert collapse("'\\''") == "''" # '\'' (char) + assert collapse("'\\'") == "'" # '\' (bad) + assert collapse("\\012") == "" # '\012' (char) + assert collapse("\\xfF0") == "" # '\xfF0' (char) + assert collapse("\\n") == "" # '\n' (char) + assert collapse("\\#") == r"\#" # '\#' (bad) + + assert collapse('"\'" + "\'"') == '"" + ""' + assert collapse("'\"', '\"'") == "'', ''" + assert collapse("\"a'b\"[0b1'0]") == '""[0b10]' + + assert collapse("4'2") == "42" + assert collapse("0b0'1'0'1") == "0b0101" + assert collapse("1'048'576") == "1048576" + assert collapse("0X10'0000") == "0X100000" + assert collapse("0'004'000'000") == "0004000000" + assert collapse("1.602'176'565e-19") == "1.602176565e-19" + assert collapse("'i' + 0xf'f'f'f") == "'' + 0xffff" + assert collapse("sizeof'x' == 1") == "sizeof'' == 1" + assert collapse("0x.0'3p1'0'0") == "0x.03p100" + assert collapse("1'23.4'5") == "123.45" + + assert ( + collapse('StringReplace(body, "\\\\", "\\\\\\\\");') == 'StringReplace(body, "", "");' + ) + assert collapse('\'"\' "foo"') == "'' \"\"" + + +class TestOrderOfIncludes(CpplintTestBase): + @pytest.fixture(autouse=True) + def setUp(self): + CpplintTestBase.setUp(self) + self.include_state = cpplint._IncludeState() + os.path.abspath = lambda value: value + + def testCheckNextIncludeOrder_OtherThenCpp(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._OTHER_HEADER) == "" + assert ( + self.include_state.CheckNextIncludeOrder(cpplint._CPP_SYS_HEADER) + == "Found C++ system header after other header" + ) + + def testCheckNextIncludeOrder_CppThenC(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._CPP_SYS_HEADER) == "" + assert ( + self.include_state.CheckNextIncludeOrder(cpplint._C_SYS_HEADER) + == "Found C system header after C++ system header" + ) + + def testCheckNextIncludeOrder_OtherSysThenC(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._OTHER_SYS_HEADER) == "" + assert ( + self.include_state.CheckNextIncludeOrder(cpplint._C_SYS_HEADER) + == "Found C system header after other system header" + ) + + def testCheckNextIncludeOrder_OtherSysThenCpp(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._OTHER_SYS_HEADER) == "" + assert ( + self.include_state.CheckNextIncludeOrder(cpplint._CPP_SYS_HEADER) + == "Found C++ system header after other system header" + ) + + def testCheckNextIncludeOrder_LikelyThenCpp(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._LIKELY_MY_HEADER) == "" + assert self.include_state.CheckNextIncludeOrder(cpplint._CPP_SYS_HEADER) == "" + + def testCheckNextIncludeOrder_PossibleThenCpp(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._POSSIBLE_MY_HEADER) == "" + assert self.include_state.CheckNextIncludeOrder(cpplint._CPP_SYS_HEADER) == "" + + def testCheckNextIncludeOrder_CppThenLikely(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._CPP_SYS_HEADER) == "" + # This will eventually fail. + assert self.include_state.CheckNextIncludeOrder(cpplint._LIKELY_MY_HEADER) == "" + + def testCheckNextIncludeOrder_CppThenPossible(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._CPP_SYS_HEADER) == "" + assert self.include_state.CheckNextIncludeOrder(cpplint._POSSIBLE_MY_HEADER) == "" + + def testCheckNextIncludeOrder_CppThenOtherSys(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._CPP_SYS_HEADER) == "" + assert self.include_state.CheckNextIncludeOrder(cpplint._OTHER_SYS_HEADER) == "" + + def testCheckNextIncludeOrder_OtherSysThenPossible(self): + assert self.include_state.CheckNextIncludeOrder(cpplint._OTHER_SYS_HEADER) == "" + assert self.include_state.CheckNextIncludeOrder(cpplint._POSSIBLE_MY_HEADER) == "" + + def testClassifyInclude(self): + file_info = cpplint.FileInfo + classify_include = cpplint._ClassifyInclude + assert classify_include(file_info("foo/foo.cc"), "stdio.h", True) == cpplint._C_SYS_HEADER + assert ( + classify_include(file_info("foo/foo.cc"), "sys/time.h", True) == cpplint._C_SYS_HEADER + ) + assert ( + classify_include(file_info("foo/foo.cc"), "netipx/ipx.h", True) == cpplint._C_SYS_HEADER + ) + assert ( + classify_include(file_info("foo/foo.cc"), "arpa/ftp.h", True) == cpplint._C_SYS_HEADER + ) + assert classify_include(file_info("foo/foo.cc"), "string", True) == cpplint._CPP_SYS_HEADER + assert ( + classify_include(file_info("foo/foo.cc"), "typeinfo", True) == cpplint._CPP_SYS_HEADER + ) + assert classify_include(file_info("foo/foo.cc"), "foo/foo.h", True) == cpplint._C_SYS_HEADER + assert ( + classify_include(file_info("foo/foo.cc"), "foo/foo.h", True, "standardcfirst") + == cpplint._OTHER_SYS_HEADER + ) + assert classify_include(file_info("foo/foo.cc"), "string", False) == cpplint._OTHER_HEADER + assert ( + classify_include(file_info("foo/foo.cc"), "boost/any.hpp", True) + == cpplint._OTHER_HEADER + ) + assert ( + classify_include(file_info("foo/foo.hxx"), "boost/any.hpp", True) + == cpplint._OTHER_HEADER + ) + assert ( + classify_include(file_info("foo/foo.h++"), "boost/any.hpp", True) + == cpplint._OTHER_HEADER + ) + assert ( + classify_include(file_info("foo/foo.cc"), "foo/foo-inl.h", False) + == cpplint._LIKELY_MY_HEADER + ) + assert ( + classify_include(file_info("foo/internal/foo.cc"), "foo/public/foo.h", False) + == cpplint._LIKELY_MY_HEADER + ) + assert ( + classify_include(file_info("foo/internal/foo.cc"), "foo/other/public/foo.h", False) + == cpplint._POSSIBLE_MY_HEADER + ) + assert ( + classify_include(file_info("foo/internal/foo.cc"), "foo/other/public/foop.h", False) + == cpplint._OTHER_HEADER + ) + + def testTryDropCommonSuffixes(self): + cpplint._hpp_headers = set() + cpplint._valid_extensions = set() + assert cpplint._DropCommonSuffixes("foo/foo-inl.h") == "foo/foo" + assert cpplint._DropCommonSuffixes("foo/foo-inl.hxx") == "foo/foo" + assert cpplint._DropCommonSuffixes("foo/foo-inl.h++") == "foo/foo" + assert cpplint._DropCommonSuffixes("foo/foo-inl.hpp") == "foo/foo" + assert cpplint._DropCommonSuffixes("foo/bar/foo_inl.h") == "foo/bar/foo" + assert cpplint._DropCommonSuffixes("foo/foo.cc") == "foo/foo" + assert cpplint._DropCommonSuffixes("foo/foo.cxx") == "foo/foo" + assert cpplint._DropCommonSuffixes("foo/foo.c") == "foo/foo" + assert cpplint._DropCommonSuffixes("foo/foo_unusualinternal.h") == "foo/foo_unusualinternal" + assert ( + cpplint._DropCommonSuffixes("foo/foo_unusualinternal.hpp") == "foo/foo_unusualinternal" + ) + assert cpplint._DropCommonSuffixes("_test.cc") == "" + assert cpplint._DropCommonSuffixes("_test.c") == "" + assert cpplint._DropCommonSuffixes("_test.c++") == "" + assert cpplint._DropCommonSuffixes("test.c") == "test" + assert cpplint._DropCommonSuffixes("test.cc") == "test" + assert cpplint._DropCommonSuffixes("test.c++") == "test" + + def testRegression(self): + def Format(includes): + include_list = [] + for item in includes: + if item.startswith(('"', "<")): + include_list.append("#include %s\n" % item) + else: + include_list.append(item + "\n") + return "".join(include_list) + + # Test singleton cases first. + self.TestLanguageRulesCheck("foo/foo.cc", Format(['"foo/foo.h"']), "") + self.TestLanguageRulesCheck("foo/foo.cc", Format([""]), "") + self.TestLanguageRulesCheck("foo/foo.cc", Format([""]), "") + self.TestLanguageRulesCheck("foo/foo.cc", Format(['"foo/foo-inl.h"']), "") + self.TestLanguageRulesCheck("foo/foo.cc", Format(['"bar/bar-inl.h"']), "") + self.TestLanguageRulesCheck("foo/foo.cc", Format(['"bar/bar.h"']), "") + + # Test everything in a good and new order. + self.TestLanguageRulesCheck( + "foo/foo.cc", + Format( + [ + '"foo/foo.h"', + '"foo/foo-inl.h"', + "", + "", + "", + '"bar/bar-inl.h"', + '"bar/bar.h"', + ] + ), + "", + ) + + # Test bad orders. + self.TestLanguageRulesCheck( + "foo/foo.cc", + Format(["", ""]), + "Found C system header after C++ system header." + " Should be: foo.h, c system, c++ system, other." + " [build/include_order] [4]", + ) + self.TestLanguageRulesCheck( + "foo/foo.cc", Format(['"foo/bar-inl.h"', '"foo/foo-inl.h"']), "" + ) + self.TestLanguageRulesCheck( + "foo/foo.cc", + Format( + [ + '"foo/e.h"', + '"foo/b.h"', # warning here (e>b) + '"foo/c.h"', + '"foo/d.h"', + '"foo/a.h"', + ] + ), # warning here (d>a) + [ + 'Include "foo/b.h" not in alphabetical order [build/include_alpha] [4]', + 'Include "foo/a.h" not in alphabetical order [build/include_alpha] [4]', + ], + ) + # -inl.h headers are no longer special. + self.TestLanguageRulesCheck("foo/foo.cc", Format(['"foo/foo-inl.h"', ""]), "") + self.TestLanguageRulesCheck("foo/foo.cc", Format(['"foo/bar.h"', '"foo/bar-inl.h"']), "") + # Test componentized header. OK to have my header in ../public dir. + self.TestLanguageRulesCheck( + "foo/internal/foo.cc", Format(['"foo/public/foo.h"', ""]), "" + ) + # OK to have my header in other dir (not stylistically, but + # cpplint isn't as good as a human). + self.TestLanguageRulesCheck( + "foo/internal/foo.cc", Format(['"foo/other/public/foo.h"', ""]), "" + ) + self.TestLanguageRulesCheck( + "foo/foo.cc", + Format(['"foo/foo.h"', "", '"base/google.h"', '"base/flags.h"']), + 'Include "base/flags.h" not in alphabetical order [build/include_alpha] [4]', + ) + # According to the style, -inl.h should come before .h, but we don't + # complain about that. + self.TestLanguageRulesCheck( + "foo/foo.cc", + Format(['"foo/foo-inl.h"', '"foo/foo.h"', '"base/google.h"', '"base/google-inl.h"']), + "", + ) + # Allow project includes to be separated by blank lines + self.TestLanguageRulesCheck( + "a/a.cc", + Format( + ['"a/a.h"', "", '"base/google.h"', "", '"b/c.h"', "", "MACRO", '"a/b.h"'] + ), + "", + ) + self.TestLanguageRulesCheck( + "a/a.cc", + Format(['"a/a.h"', "", '"base/google.h"', '"a/b.h"']), + 'Include "a/b.h" not in alphabetical order [build/include_alpha] [4]', + ) + + # Test conditional includes + self.TestLanguageRulesCheck( + "a/a.cc", + "".join( + [ + "#include \n", + '#include "base/port.h"\n', + "#include \n", + ] + ), + ( + "Found C++ system header after other header. " + "Should be: a.h, c system, c++ system, other. " + "[build/include_order] [4]" + ), + ) + self.TestLanguageRulesCheck( + "a/a.cc", + "".join( + [ + "#include \n", + '#include "base/port.h"\n', + "#ifdef LANG_CXX11\n", + "#include \n", + "#endif // LANG_CXX11\n", + ] + ), + "", + ) + self.TestLanguageRulesCheck( + "a/a.cc", + "".join( + [ + "#include \n", + "#ifdef LANG_CXX11\n", + '#include "base/port.h"\n', + "#include \n", + "#endif // LANG_CXX11\n", + ] + ), + ( + "Found C++ system header after other header. " + "Should be: a.h, c system, c++ system, other. " + "[build/include_order] [4]" + ), + ) + + # Third party headers are exempt from order checks + self.TestLanguageRulesCheck( + "foo/foo.cc", Format(["", '"Python.h"', ""]), "" + ) + + +class TestCheckForFunctionLengths(CpplintTestBase): + @pytest.fixture(autouse=True) + def setUp(self): + # Reducing these thresholds for the tests speeds up tests significantly. + CpplintTestBase.setUp(self) + self.old_normal_trigger = cpplint._FunctionState._NORMAL_TRIGGER + self.old_test_trigger = cpplint._FunctionState._TEST_TRIGGER + + cpplint._FunctionState._NORMAL_TRIGGER = 10 + cpplint._FunctionState._TEST_TRIGGER = 25 + + def tearDown(self): + cpplint._FunctionState._NORMAL_TRIGGER = self.old_normal_trigger + cpplint._FunctionState._TEST_TRIGGER = self.old_test_trigger + + def TestFunctionLengthsCheck(self, code, expected_message): + """Check warnings for long function bodies are as expected. + + Args: + code: C++ source code expected to generate a warning message. + expected_message: Message expected to be generated by the C++ code. + """ + assert expected_message == self.PerformFunctionLengthsCheck(code) - Args: - code: C++ source code expected to generate a warning message. - expected_message: Message expected to be generated by the C++ code. - """ - self.assertEqual(expected_message, - self.PerformFunctionLengthsCheck(code)) + def TriggerLines(self, error_level): + """Return number of lines needed to trigger a function length warning. - def TriggerLines(self, error_level): - """Return number of lines needed to trigger a function length warning. + Args: + error_level: --v setting for cpplint. - Args: - error_level: --v setting for cpplint. + Returns: + Number of lines needed to trigger a function length warning. + """ + return cpplint._FunctionState._NORMAL_TRIGGER * 2**error_level - Returns: - Number of lines needed to trigger a function length warning. - """ - return cpplint._FunctionState._NORMAL_TRIGGER * 2**error_level + def TestLines(self, error_level): + """Return number of lines needed to trigger a test function length warning. - def TestLines(self, error_level): - """Return number of lines needed to trigger a test function length warning. + Args: + error_level: --v setting for cpplint. - Args: - error_level: --v setting for cpplint. + Returns: + Number of lines needed to trigger a test function length warning. + """ + return cpplint._FunctionState._TEST_TRIGGER * 2**error_level - Returns: - Number of lines needed to trigger a test function length warning. - """ - return cpplint._FunctionState._TEST_TRIGGER * 2**error_level + def TestFunctionLengthCheckDefinition(self, lines, error_level): + """Generate long function definition and check warnings are as expected. - def TestFunctionLengthCheckDefinition(self, lines, error_level): - """Generate long function definition and check warnings are as expected. + Args: + lines: Number of lines to generate. + error_level: --v setting for cpplint. + """ + trigger_level = self.TriggerLines(cpplint._VerboseLevel()) + self.TestFunctionLengthsCheck( + "void test(int x)" + self.FunctionBody(lines), + ( + "Small and focused functions are preferred: " + "test() has %d non-comment lines " + "(error triggered by exceeding %d lines)." + " [readability/fn_size] [%d]" % (lines, trigger_level, error_level) + ), + ) + + def TestFunctionLengthCheckDefinitionOK(self, lines): + """Generate shorter function definition and check no warning is produced. + + Args: + lines: Number of lines to generate. + """ + self.TestFunctionLengthsCheck("void test(int x)" + self.FunctionBody(lines), "") - Args: - lines: Number of lines to generate. - error_level: --v setting for cpplint. - """ - trigger_level = self.TriggerLines(cpplint._VerboseLevel()) - self.TestFunctionLengthsCheck( - 'void test(int x)' + self.FunctionBody(lines), - ('Small and focused functions are preferred: ' - 'test() has %d non-comment lines ' - '(error triggered by exceeding %d lines).' - ' [readability/fn_size] [%d]' - % (lines, trigger_level, error_level))) - - def TestFunctionLengthCheckDefinitionOK(self, lines): - """Generate shorter function definition and check no warning is produced. + def TestFunctionLengthCheckAtErrorLevel(self, error_level): + """Generate and check function at the trigger level for --v setting. - Args: - lines: Number of lines to generate. - """ - self.TestFunctionLengthsCheck( - 'void test(int x)' + self.FunctionBody(lines), - '') + Args: + error_level: --v setting for cpplint. + """ + self.TestFunctionLengthCheckDefinition(self.TriggerLines(error_level), error_level) - def TestFunctionLengthCheckAtErrorLevel(self, error_level): - """Generate and check function at the trigger level for --v setting. + def TestFunctionLengthCheckBelowErrorLevel(self, error_level): + """Generate and check function just below the trigger level for --v setting. - Args: - error_level: --v setting for cpplint. - """ - self.TestFunctionLengthCheckDefinition(self.TriggerLines(error_level), - error_level) + Args: + error_level: --v setting for cpplint. + """ + self.TestFunctionLengthCheckDefinition(self.TriggerLines(error_level) - 1, error_level - 1) - def TestFunctionLengthCheckBelowErrorLevel(self, error_level): - """Generate and check function just below the trigger level for --v setting. + def TestFunctionLengthCheckAboveErrorLevel(self, error_level): + """Generate and check function just above the trigger level for --v setting. - Args: - error_level: --v setting for cpplint. - """ - self.TestFunctionLengthCheckDefinition(self.TriggerLines(error_level)-1, - error_level-1) + Args: + error_level: --v setting for cpplint. + """ + self.TestFunctionLengthCheckDefinition(self.TriggerLines(error_level) + 1, error_level) + + def FunctionBody(self, number_of_lines): + return " {\n" + " this_is_just_a_test();\n" * number_of_lines + "}" + + def FunctionBodyWithBlankLines(self, number_of_lines): + return " {\n" + " this_is_just_a_test();\n\n" * number_of_lines + "}" + + def FunctionBodyWithNoLints(self, number_of_lines): + return " {\n" + " this_is_just_a_test(); // NOLINT\n" * number_of_lines + "}" + + # Test line length checks. + def testFunctionLengthCheckDeclaration(self): + self.TestFunctionLengthsCheck( + "void test();", # Not a function definition + "", + ) + + def testFunctionLengthCheckDeclarationWithBlockFollowing(self): + self.TestFunctionLengthsCheck( + ("void test();\n" + self.FunctionBody(66)), # Not a function definition + "", + ) + + def testFunctionLengthCheckClassDefinition(self): + self.TestFunctionLengthsCheck( # Not a function definition + "class Test" + self.FunctionBody(66) + ";", "" + ) + + def testFunctionLengthCheckTrivial(self): + self.TestFunctionLengthsCheck( + "void test() {}", # Not counted + "", + ) + + def testFunctionLengthCheckEmpty(self): + self.TestFunctionLengthsCheck("void test() {\n}", "") + + def testFunctionLengthCheckDefinitionBelowSeverity0(self): + old_verbosity = cpplint._SetVerboseLevel(0) + self.TestFunctionLengthCheckDefinitionOK(self.TriggerLines(0) - 1) + cpplint._SetVerboseLevel(old_verbosity) + + def testFunctionLengthCheckDefinitionAtSeverity0(self): + old_verbosity = cpplint._SetVerboseLevel(0) + self.TestFunctionLengthCheckDefinitionOK(self.TriggerLines(0)) + cpplint._SetVerboseLevel(old_verbosity) + + def testFunctionLengthCheckDefinitionAboveSeverity0(self): + old_verbosity = cpplint._SetVerboseLevel(0) + self.TestFunctionLengthCheckAboveErrorLevel(0) + cpplint._SetVerboseLevel(old_verbosity) + + def testFunctionLengthCheckDefinitionBelowSeverity1v0(self): + old_verbosity = cpplint._SetVerboseLevel(0) + self.TestFunctionLengthCheckBelowErrorLevel(1) + cpplint._SetVerboseLevel(old_verbosity) + + def testFunctionLengthCheckDefinitionAtSeverity1v0(self): + old_verbosity = cpplint._SetVerboseLevel(0) + self.TestFunctionLengthCheckAtErrorLevel(1) + cpplint._SetVerboseLevel(old_verbosity) + + def testFunctionLengthCheckDefinitionBelowSeverity1(self): + self.TestFunctionLengthCheckDefinitionOK(self.TriggerLines(1) - 1) + + def testFunctionLengthCheckDefinitionAtSeverity1(self): + self.TestFunctionLengthCheckDefinitionOK(self.TriggerLines(1)) + + def testFunctionLengthCheckDefinitionAboveSeverity1(self): + self.TestFunctionLengthCheckAboveErrorLevel(1) + + def testFunctionLengthCheckDefinitionSeverity1PlusBlanks(self): + error_level = 1 + error_lines = self.TriggerLines(error_level) + 1 + trigger_level = self.TriggerLines(cpplint._VerboseLevel()) + self.TestFunctionLengthsCheck( + "void test_blanks(int x)" + self.FunctionBody(error_lines), + ( + "Small and focused functions are preferred: " + "test_blanks() has %d non-comment lines " + "(error triggered by exceeding %d lines)." + " [readability/fn_size] [%d]" + ) + % (error_lines, trigger_level, error_level), + ) + + def testFunctionLengthCheckComplexDefinitionSeverity1(self): + error_level = 1 + error_lines = self.TriggerLines(error_level) + 1 + trigger_level = self.TriggerLines(cpplint._VerboseLevel()) + self.TestFunctionLengthsCheck( + ( + "my_namespace::my_other_namespace::MyVeryLongTypeName*\n" + "my_namespace::my_other_namespace::MyFunction(int arg1, char* arg2)" + + self.FunctionBody(error_lines) + ), + ( + "Small and focused functions are preferred: " + "my_namespace::my_other_namespace::MyFunction()" + " has %d non-comment lines " + "(error triggered by exceeding %d lines)." + " [readability/fn_size] [%d]" + ) + % (error_lines, trigger_level, error_level), + ) + + def testFunctionLengthCheckDefinitionSeverity1ForTest(self): + error_level = 1 + error_lines = self.TestLines(error_level) + 1 + trigger_level = self.TestLines(cpplint._VerboseLevel()) + self.TestFunctionLengthsCheck( + "TEST_F(Test, Mutator)" + self.FunctionBody(error_lines), + ( + "Small and focused functions are preferred: " + "TEST_F(Test, Mutator) has %d non-comment lines " + "(error triggered by exceeding %d lines)." + " [readability/fn_size] [%d]" + ) + % (error_lines, trigger_level, error_level), + ) + + def testFunctionLengthCheckDefinitionSeverity1ForSplitLineTest(self): + error_level = 1 + error_lines = self.TestLines(error_level) + 1 + trigger_level = self.TestLines(cpplint._VerboseLevel()) + self.TestFunctionLengthsCheck( + ( + "TEST_F(GoogleUpdateRecoveryRegistryProtectedTest,\n" + " FixGoogleUpdate_AllValues_MachineApp)" # note: 4 spaces + + self.FunctionBody(error_lines) + ), + ( + "Small and focused functions are preferred: " + "TEST_F(GoogleUpdateRecoveryRegistryProtectedTest, " # 1 space + "FixGoogleUpdate_AllValues_MachineApp) has %d non-comment lines " + "(error triggered by exceeding %d lines)." + " [readability/fn_size] [%d]" + ) + % (error_lines + 1, trigger_level, error_level), + ) + + def testFunctionLengthCheckDefinitionSeverity1ForBadTestDoesntBreak(self): + error_level = 1 + error_lines = self.TestLines(error_level) + 1 + trigger_level = self.TestLines(cpplint._VerboseLevel()) + self.TestFunctionLengthsCheck( + ("TEST_F(" + self.FunctionBody(error_lines)), + ( + "Small and focused functions are preferred: " + "TEST_F has %d non-comment lines " + "(error triggered by exceeding %d lines)." + " [readability/fn_size] [%d]" + ) + % (error_lines, trigger_level, error_level), + ) + + def testFunctionLengthCheckDefinitionSeverity1WithEmbeddedNoLints(self): + error_level = 1 + error_lines = self.TriggerLines(error_level) + 1 + trigger_level = self.TriggerLines(cpplint._VerboseLevel()) + self.TestFunctionLengthsCheck( + "void test(int x)" + self.FunctionBodyWithNoLints(error_lines), + ( + "Small and focused functions are preferred: " + "test() has %d non-comment lines " + "(error triggered by exceeding %d lines)." + " [readability/fn_size] [%d]" + ) + % (error_lines, trigger_level, error_level), + ) + + def testFunctionLengthCheckDefinitionSeverity1WithNoLint(self): + self.TestFunctionLengthsCheck( + ( + "void test(int x)" + + self.FunctionBody(self.TriggerLines(1)) + + " // NOLINT -- long function" + ), + "", + ) + + def testFunctionLengthCheckDefinitionBelowSeverity2(self): + self.TestFunctionLengthCheckBelowErrorLevel(2) + + def testFunctionLengthCheckDefinitionSeverity2(self): + self.TestFunctionLengthCheckAtErrorLevel(2) + + def testFunctionLengthCheckDefinitionAboveSeverity2(self): + self.TestFunctionLengthCheckAboveErrorLevel(2) + + def testFunctionLengthCheckDefinitionBelowSeverity3(self): + self.TestFunctionLengthCheckBelowErrorLevel(3) + + def testFunctionLengthCheckDefinitionSeverity3(self): + self.TestFunctionLengthCheckAtErrorLevel(3) + + def testFunctionLengthCheckDefinitionAboveSeverity3(self): + self.TestFunctionLengthCheckAboveErrorLevel(3) + + def testFunctionLengthCheckDefinitionBelowSeverity4(self): + self.TestFunctionLengthCheckBelowErrorLevel(4) + + def testFunctionLengthCheckDefinitionSeverity4(self): + self.TestFunctionLengthCheckAtErrorLevel(4) + + def testFunctionLengthCheckDefinitionAboveSeverity4(self): + self.TestFunctionLengthCheckAboveErrorLevel(4) + + def testFunctionLengthCheckDefinitionBelowSeverity5(self): + self.TestFunctionLengthCheckBelowErrorLevel(5) + + def testFunctionLengthCheckDefinitionAtSeverity5(self): + self.TestFunctionLengthCheckAtErrorLevel(5) + + def testFunctionLengthCheckDefinitionAboveSeverity5(self): + self.TestFunctionLengthCheckAboveErrorLevel(5) + + def testFunctionLengthCheckDefinitionHugeLines(self): + # 5 is the limit + self.TestFunctionLengthCheckDefinition(self.TriggerLines(10), 5) + + def testFunctionLengthNotDeterminable(self): + # Macro invocation without terminating semicolon. + self.TestFunctionLengthsCheck("MACRO(arg)", "") + + # Macro with underscores + self.TestFunctionLengthsCheck("MACRO_WITH_UNDERSCORES(arg1, arg2, arg3)", "") + + self.TestFunctionLengthsCheck( + "NonMacro(arg)", + "Lint failed to find start of function body. [readability/fn_size] [5]", + ) + + def testFunctionLengthCheckWithNamespace(self): + old_verbosity = cpplint._SetVerboseLevel(1) + self.TestFunctionLengthsCheck( + ( + "namespace {\n" + "void CodeCoverageCL35256059() {\n" + (" X++;\n" * 3000) + "}\n" + "} // namespace\n" + ), + ( + "Small and focused functions are preferred: " + "CodeCoverageCL35256059() has 3000 non-comment lines " + "(error triggered by exceeding 20 lines)." + " [readability/fn_size] [5]" + ), + ) + cpplint._SetVerboseLevel(old_verbosity) - def TestFunctionLengthCheckAboveErrorLevel(self, error_level): - """Generate and check function just above the trigger level for --v setting. + +def TrimExtraIndent(text_block): + """Trim a uniform amount of whitespace off of each line in a string. + + Compute the minimum indent on all non blank lines and trim that from each, so + that the block of text has no extra indentation. Args: - error_level: --v setting for cpplint. + text_block: a multiline string + + Returns: + text_block with the common whitespace indent of each line removed. """ - self.TestFunctionLengthCheckDefinition(self.TriggerLines(error_level)+1, - error_level) - - def FunctionBody(self, number_of_lines): - return ' {\n' + ' this_is_just_a_test();\n'*number_of_lines + '}' - - def FunctionBodyWithBlankLines(self, number_of_lines): - return ' {\n' + ' this_is_just_a_test();\n\n'*number_of_lines + '}' - - def FunctionBodyWithNoLints(self, number_of_lines): - return (' {\n' + - ' this_is_just_a_test(); // NOLINT\n'*number_of_lines + '}') - - # Test line length checks. - def testFunctionLengthCheckDeclaration(self): - self.TestFunctionLengthsCheck( - 'void test();', # Not a function definition - '') - - def testFunctionLengthCheckDeclarationWithBlockFollowing(self): - self.TestFunctionLengthsCheck( - ('void test();\n' - + self.FunctionBody(66)), # Not a function definition - '') - - def testFunctionLengthCheckClassDefinition(self): - self.TestFunctionLengthsCheck( # Not a function definition - 'class Test' + self.FunctionBody(66) + ';', - '') - - def testFunctionLengthCheckTrivial(self): - self.TestFunctionLengthsCheck( - 'void test() {}', # Not counted - '') - - def testFunctionLengthCheckEmpty(self): - self.TestFunctionLengthsCheck( - 'void test() {\n}', - '') - - def testFunctionLengthCheckDefinitionBelowSeverity0(self): - old_verbosity = cpplint._SetVerboseLevel(0) - self.TestFunctionLengthCheckDefinitionOK(self.TriggerLines(0)-1) - cpplint._SetVerboseLevel(old_verbosity) - - def testFunctionLengthCheckDefinitionAtSeverity0(self): - old_verbosity = cpplint._SetVerboseLevel(0) - self.TestFunctionLengthCheckDefinitionOK(self.TriggerLines(0)) - cpplint._SetVerboseLevel(old_verbosity) - - def testFunctionLengthCheckDefinitionAboveSeverity0(self): - old_verbosity = cpplint._SetVerboseLevel(0) - self.TestFunctionLengthCheckAboveErrorLevel(0) - cpplint._SetVerboseLevel(old_verbosity) - - def testFunctionLengthCheckDefinitionBelowSeverity1v0(self): - old_verbosity = cpplint._SetVerboseLevel(0) - self.TestFunctionLengthCheckBelowErrorLevel(1) - cpplint._SetVerboseLevel(old_verbosity) - - def testFunctionLengthCheckDefinitionAtSeverity1v0(self): - old_verbosity = cpplint._SetVerboseLevel(0) - self.TestFunctionLengthCheckAtErrorLevel(1) - cpplint._SetVerboseLevel(old_verbosity) - - def testFunctionLengthCheckDefinitionBelowSeverity1(self): - self.TestFunctionLengthCheckDefinitionOK(self.TriggerLines(1)-1) - - def testFunctionLengthCheckDefinitionAtSeverity1(self): - self.TestFunctionLengthCheckDefinitionOK(self.TriggerLines(1)) - - def testFunctionLengthCheckDefinitionAboveSeverity1(self): - self.TestFunctionLengthCheckAboveErrorLevel(1) - - def testFunctionLengthCheckDefinitionSeverity1PlusBlanks(self): - error_level = 1 - error_lines = self.TriggerLines(error_level) + 1 - trigger_level = self.TriggerLines(cpplint._VerboseLevel()) - self.TestFunctionLengthsCheck( - 'void test_blanks(int x)' + self.FunctionBody(error_lines), - ('Small and focused functions are preferred: ' - 'test_blanks() has %d non-comment lines ' - '(error triggered by exceeding %d lines).' - ' [readability/fn_size] [%d]') - % (error_lines, trigger_level, error_level)) - - def testFunctionLengthCheckComplexDefinitionSeverity1(self): - error_level = 1 - error_lines = self.TriggerLines(error_level) + 1 - trigger_level = self.TriggerLines(cpplint._VerboseLevel()) - self.TestFunctionLengthsCheck( - ('my_namespace::my_other_namespace::MyVeryLongTypeName*\n' - 'my_namespace::my_other_namespace::MyFunction(int arg1, char* arg2)' - + self.FunctionBody(error_lines)), - ('Small and focused functions are preferred: ' - 'my_namespace::my_other_namespace::MyFunction()' - ' has %d non-comment lines ' - '(error triggered by exceeding %d lines).' - ' [readability/fn_size] [%d]') - % (error_lines, trigger_level, error_level)) - - def testFunctionLengthCheckDefinitionSeverity1ForTest(self): - error_level = 1 - error_lines = self.TestLines(error_level) + 1 - trigger_level = self.TestLines(cpplint._VerboseLevel()) - self.TestFunctionLengthsCheck( - 'TEST_F(Test, Mutator)' + self.FunctionBody(error_lines), - ('Small and focused functions are preferred: ' - 'TEST_F(Test, Mutator) has %d non-comment lines ' - '(error triggered by exceeding %d lines).' - ' [readability/fn_size] [%d]') - % (error_lines, trigger_level, error_level)) - - def testFunctionLengthCheckDefinitionSeverity1ForSplitLineTest(self): - error_level = 1 - error_lines = self.TestLines(error_level) + 1 - trigger_level = self.TestLines(cpplint._VerboseLevel()) - self.TestFunctionLengthsCheck( - ('TEST_F(GoogleUpdateRecoveryRegistryProtectedTest,\n' - ' FixGoogleUpdate_AllValues_MachineApp)' # note: 4 spaces - + self.FunctionBody(error_lines)), - ('Small and focused functions are preferred: ' - 'TEST_F(GoogleUpdateRecoveryRegistryProtectedTest, ' # 1 space - 'FixGoogleUpdate_AllValues_MachineApp) has %d non-comment lines ' - '(error triggered by exceeding %d lines).' - ' [readability/fn_size] [%d]') - % (error_lines+1, trigger_level, error_level)) - - def testFunctionLengthCheckDefinitionSeverity1ForBadTestDoesntBreak(self): - error_level = 1 - error_lines = self.TestLines(error_level) + 1 - trigger_level = self.TestLines(cpplint._VerboseLevel()) - self.TestFunctionLengthsCheck( - ('TEST_F(' - + self.FunctionBody(error_lines)), - ('Small and focused functions are preferred: ' - 'TEST_F has %d non-comment lines ' - '(error triggered by exceeding %d lines).' - ' [readability/fn_size] [%d]') - % (error_lines, trigger_level, error_level)) - - def testFunctionLengthCheckDefinitionSeverity1WithEmbeddedNoLints(self): - error_level = 1 - error_lines = self.TriggerLines(error_level)+1 - trigger_level = self.TriggerLines(cpplint._VerboseLevel()) - self.TestFunctionLengthsCheck( - 'void test(int x)' + self.FunctionBodyWithNoLints(error_lines), - ('Small and focused functions are preferred: ' - 'test() has %d non-comment lines ' - '(error triggered by exceeding %d lines).' - ' [readability/fn_size] [%d]') - % (error_lines, trigger_level, error_level)) - - def testFunctionLengthCheckDefinitionSeverity1WithNoLint(self): - self.TestFunctionLengthsCheck( - ('void test(int x)' + self.FunctionBody(self.TriggerLines(1)) - + ' // NOLINT -- long function'), - '') - - def testFunctionLengthCheckDefinitionBelowSeverity2(self): - self.TestFunctionLengthCheckBelowErrorLevel(2) - - def testFunctionLengthCheckDefinitionSeverity2(self): - self.TestFunctionLengthCheckAtErrorLevel(2) - - def testFunctionLengthCheckDefinitionAboveSeverity2(self): - self.TestFunctionLengthCheckAboveErrorLevel(2) - - def testFunctionLengthCheckDefinitionBelowSeverity3(self): - self.TestFunctionLengthCheckBelowErrorLevel(3) - - def testFunctionLengthCheckDefinitionSeverity3(self): - self.TestFunctionLengthCheckAtErrorLevel(3) - - def testFunctionLengthCheckDefinitionAboveSeverity3(self): - self.TestFunctionLengthCheckAboveErrorLevel(3) - - def testFunctionLengthCheckDefinitionBelowSeverity4(self): - self.TestFunctionLengthCheckBelowErrorLevel(4) - - def testFunctionLengthCheckDefinitionSeverity4(self): - self.TestFunctionLengthCheckAtErrorLevel(4) - - def testFunctionLengthCheckDefinitionAboveSeverity4(self): - self.TestFunctionLengthCheckAboveErrorLevel(4) - - def testFunctionLengthCheckDefinitionBelowSeverity5(self): - self.TestFunctionLengthCheckBelowErrorLevel(5) - - def testFunctionLengthCheckDefinitionAtSeverity5(self): - self.TestFunctionLengthCheckAtErrorLevel(5) - - def testFunctionLengthCheckDefinitionAboveSeverity5(self): - self.TestFunctionLengthCheckAboveErrorLevel(5) - - def testFunctionLengthCheckDefinitionHugeLines(self): - # 5 is the limit - self.TestFunctionLengthCheckDefinition(self.TriggerLines(10), 5) - - def testFunctionLengthNotDeterminable(self): - # Macro invocation without terminating semicolon. - self.TestFunctionLengthsCheck( - 'MACRO(arg)', - '') - - # Macro with underscores - self.TestFunctionLengthsCheck( - 'MACRO_WITH_UNDERSCORES(arg1, arg2, arg3)', - '') - - self.TestFunctionLengthsCheck( - 'NonMacro(arg)', - 'Lint failed to find start of function body.' - ' [readability/fn_size] [5]') - - def testFunctionLengthCheckWithNamespace(self): - old_verbosity = cpplint._SetVerboseLevel(1) - self.TestFunctionLengthsCheck( - ('namespace {\n' - 'void CodeCoverageCL35256059() {\n' + - (' X++;\n' * 3000) + - '}\n' - '} // namespace\n'), - ('Small and focused functions are preferred: ' - 'CodeCoverageCL35256059() has 3000 non-comment lines ' - '(error triggered by exceeding 20 lines).' - ' [readability/fn_size] [5]')) - cpplint._SetVerboseLevel(old_verbosity) + def CountLeadingWhitespace(s): + count = 0 + for c in s: + if not c.isspace(): + break + count += 1 + return count + + # find the minimum indent (except for blank lines) + min_indent = min([CountLeadingWhitespace(line) for line in text_block.split("\n") if line]) + return "\n".join([line[min_indent:] for line in text_block.split("\n")]) + + +class TestCloseExpression: + @pytest.fixture(autouse=True) + def setUp(self): + self.lines = cpplint.CleansedLines( + # 1 2 3 4 5 + # 0123456789012345678901234567890123456789012345678901234567890 + [ + "// Line 0", + "inline RCULocked::ReadPtr::ReadPtr(const RCULocked* rcu) {", + ' DCHECK(!(data & kFlagMask)) << "Error";', + "}", + "// Line 4", + "RCULocked::WritePtr::WritePtr(RCULocked* rcu)", + " : lock_(&rcu_->mutex_) {", + "}", + "// Line 8", + "template ", + "typename std::enable_if<", + " std::is_array::value && (std::extent::value > 0)>::type", + "MakeUnique(A&&... a) = delete;", + "// Line 13", + "auto x = []() {};", + "// Line 15", + "template ", + "friend bool operator==(const reffed_ptr& a,", + " const reffed_ptr& b) {", + " return a.get() == b.get();", + "}", + "// Line 21", + ] + ) + + def testCloseExpression(self): + # List of positions to test: + # (start line, start position, end line, end position + 1) + positions = [ + (1, 16, 1, 19), + (1, 37, 1, 59), + (1, 60, 3, 1), + (2, 8, 2, 29), + (2, 30, 22, -1), # Left shift operator + (9, 9, 9, 36), + (10, 23, 11, 59), + (11, 54, 22, -1), # Greater than operator + (14, 9, 14, 11), + (14, 11, 14, 13), + (14, 14, 14, 16), + (17, 22, 18, 46), + (18, 47, 20, 1), + ] + for p in positions: + (_, line, column) = cpplint.CloseExpression(self.lines, p[0], p[1]) + assert (p[2], p[3]) == (line, column) + + def testReverseCloseExpression(self): + # List of positions to test: + # (end line, end position, start line, start position) + positions = [ + (1, 18, 1, 16), + (1, 58, 1, 37), + (2, 27, 2, 10), + (2, 28, 2, 8), + (6, 18, 0, -1), # -> operator + (9, 35, 9, 9), + (11, 54, 0, -1), # Greater than operator + (11, 57, 11, 31), + (14, 10, 14, 9), + (14, 12, 14, 11), + (14, 15, 14, 14), + (18, 45, 17, 22), + (20, 0, 18, 47), + ] + for p in positions: + (_, line, column) = cpplint.ReverseCloseExpression(self.lines, p[0], p[1]) + assert (p[2], p[3]) == (line, column) + + +class TestNestingState: + @pytest.fixture(autouse=True) + def setUp(self): + self.nesting_state = cpplint.NestingState() + self.error_collector = ErrorCollector(self.assertTrue) + + def assertTrue(self, condition, message=""): + assert condition, message + + def UpdateWithLines(self, lines): + clean_lines = cpplint.CleansedLines(lines) + for line in range(clean_lines.NumLines()): + self.nesting_state.Update("test.cc", clean_lines, line, self.error_collector) + + def testEmpty(self): + self.UpdateWithLines([]) + assert self.nesting_state.stack == [] + + def testNamespace(self): + self.UpdateWithLines(["namespace {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._NamespaceInfo) + assert self.nesting_state.stack[0].seen_open_brace + assert self.nesting_state.stack[0].name == "" + + self.UpdateWithLines(["namespace outer { namespace inner"]) + assert len(self.nesting_state.stack) == 3 + assert self.nesting_state.stack[0].seen_open_brace + assert self.nesting_state.stack[1].seen_open_brace + assert not self.nesting_state.stack[2].seen_open_brace + assert self.nesting_state.stack[0].name == "" + assert self.nesting_state.stack[1].name == "outer" + assert self.nesting_state.stack[2].name == "inner" + + self.UpdateWithLines(["{"]) + assert self.nesting_state.stack[2].seen_open_brace + + self.UpdateWithLines(["}", "}}"]) + assert len(self.nesting_state.stack) == 0 + + def testDecoratedClass(self): + self.UpdateWithLines(["class Decorated_123 API A {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "A" + assert not self.nesting_state.stack[0].is_derived + assert self.nesting_state.stack[0].class_indent == 0 + self.UpdateWithLines(["}"]) + assert len(self.nesting_state.stack) == 0 + + def testInnerClass(self): + self.UpdateWithLines(["class A::B::C {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "A::B::C" + assert not self.nesting_state.stack[0].is_derived + assert self.nesting_state.stack[0].class_indent == 0 + self.UpdateWithLines(["}"]) + assert len(self.nesting_state.stack) == 0 + + def testClass(self): + self.UpdateWithLines(["class A {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "A" + assert not self.nesting_state.stack[0].is_derived + assert self.nesting_state.stack[0].class_indent == 0 + + self.UpdateWithLines(["};", "struct B : public A {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "B" + assert self.nesting_state.stack[0].is_derived + + self.UpdateWithLines(["};", "class C", ": public A {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "C" + assert self.nesting_state.stack[0].is_derived + + self.UpdateWithLines(["};", "template"]) + assert len(self.nesting_state.stack) == 0 + + self.UpdateWithLines(["class D {", " class E {"]) + assert len(self.nesting_state.stack) == 2 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "D" + assert not self.nesting_state.stack[0].is_derived + assert isinstance(self.nesting_state.stack[1], cpplint._ClassInfo) + assert self.nesting_state.stack[1].name == "E" + assert not self.nesting_state.stack[1].is_derived + assert self.nesting_state.stack[1].class_indent == 2 + assert self.nesting_state.InnermostClass().name == "E" + + self.UpdateWithLines(["}", "}"]) + assert len(self.nesting_state.stack) == 0 + + def testClassAccess(self): + self.UpdateWithLines(["class A {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].access == "private" + + self.UpdateWithLines([" public:"]) + assert self.nesting_state.stack[0].access == "public" + self.UpdateWithLines([" protracted:"]) + assert self.nesting_state.stack[0].access == "public" + self.UpdateWithLines([" protected:"]) + assert self.nesting_state.stack[0].access == "protected" + self.UpdateWithLines([" private:"]) + assert self.nesting_state.stack[0].access == "private" + + self.UpdateWithLines([" struct B {"]) + assert len(self.nesting_state.stack) == 2 + assert isinstance(self.nesting_state.stack[1], cpplint._ClassInfo) + assert self.nesting_state.stack[1].access == "public" + assert self.nesting_state.stack[0].access == "private" + + self.UpdateWithLines([" protected :"]) + assert self.nesting_state.stack[1].access == "protected" + assert self.nesting_state.stack[0].access == "private" + + self.UpdateWithLines([" }", "}"]) + assert len(self.nesting_state.stack) == 0 + + def testStruct(self): + self.UpdateWithLines(["struct A {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "A" + assert not self.nesting_state.stack[0].is_derived + + self.UpdateWithLines(["}", "void Func(struct B arg) {"]) + assert len(self.nesting_state.stack) == 1 + assert not isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + + self.UpdateWithLines(["}"]) + assert len(self.nesting_state.stack) == 0 + + def testPreprocessor(self): + assert len(self.nesting_state.pp_stack) == 0 + self.UpdateWithLines(["#if MACRO1"]) + assert len(self.nesting_state.pp_stack) == 1 + self.UpdateWithLines(["#endif"]) + assert len(self.nesting_state.pp_stack) == 0 + + self.UpdateWithLines(["#ifdef MACRO2"]) + assert len(self.nesting_state.pp_stack) == 1 + self.UpdateWithLines(["#else"]) + assert len(self.nesting_state.pp_stack) == 1 + self.UpdateWithLines(["#ifdef MACRO3"]) + assert len(self.nesting_state.pp_stack) == 2 + self.UpdateWithLines(["#elif MACRO4"]) + assert len(self.nesting_state.pp_stack) == 2 + self.UpdateWithLines(["#endif"]) + assert len(self.nesting_state.pp_stack) == 1 + self.UpdateWithLines(["#endif"]) + assert len(self.nesting_state.pp_stack) == 0 + + self.UpdateWithLines( + [ + "#ifdef MACRO5", + "class A {", + "#elif MACRO6", + "class B {", + "#else", + "class C {", + "#endif", + ] + ) + assert len(self.nesting_state.pp_stack) == 0 + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "A" + self.UpdateWithLines(["};"]) + assert len(self.nesting_state.stack) == 0 + + self.UpdateWithLines(["class D", "#ifdef MACRO7"]) + assert len(self.nesting_state.pp_stack) == 1 + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "D" + assert not self.nesting_state.stack[0].is_derived + + self.UpdateWithLines(["#elif MACRO8", ": public E"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[0].name == "D" + assert self.nesting_state.stack[0].is_derived + assert not self.nesting_state.stack[0].seen_open_brace + + self.UpdateWithLines(["#else", "{"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[0].name == "D" + assert not self.nesting_state.stack[0].is_derived + assert self.nesting_state.stack[0].seen_open_brace + + self.UpdateWithLines(["#endif"]) + assert len(self.nesting_state.pp_stack) == 0 + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[0].name == "D" + assert not self.nesting_state.stack[0].is_derived + assert not self.nesting_state.stack[0].seen_open_brace + + self.UpdateWithLines([";"]) + assert len(self.nesting_state.stack) == 0 + + def testTemplate(self): + self.UpdateWithLines(["template >"]) + assert len(self.nesting_state.stack) == 0 + self.UpdateWithLines(["class A {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "A" + + self.UpdateWithLines( + ["};", "template class B>", "class C"] + ) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "C" + self.UpdateWithLines([";"]) + assert len(self.nesting_state.stack) == 0 + + self.UpdateWithLines(["class D : public Tmpl"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "D" + + self.UpdateWithLines(["{", "};"]) + assert len(self.nesting_state.stack) == 0 + + self.UpdateWithLines( + [ + "template ", + "static void Func() {", + ] + ) + assert len(self.nesting_state.stack) == 1 + assert not isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + self.UpdateWithLines(["}", "template class K {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "K" + + def testTemplateDefaultArg(self): + self.UpdateWithLines(["template > class unique_ptr {"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[0], isinstance( + self.nesting_state.stack[0], cpplint._ClassInfo + ) + + def testTemplateInnerClass(self): + self.UpdateWithLines(["class A {", " public:"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + + self.UpdateWithLines([" template ", " class C >", " : public A {"]) + assert len(self.nesting_state.stack) == 2 + assert isinstance(self.nesting_state.stack[1], cpplint._ClassInfo) + + def testArguments(self): + self.UpdateWithLines(["class A {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "A" + assert self.nesting_state.stack[-1].open_parentheses == 0 + + self.UpdateWithLines([" void Func(", " struct X arg1,"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 1 + self.UpdateWithLines([" struct X *arg2);"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 0 + + self.UpdateWithLines(["};"]) + assert len(self.nesting_state.stack) == 0 + + self.UpdateWithLines(["struct B {"]) + assert len(self.nesting_state.stack) == 1 + assert isinstance(self.nesting_state.stack[0], cpplint._ClassInfo) + assert self.nesting_state.stack[0].name == "B" + + self.UpdateWithLines(["#ifdef MACRO", " void Func(", " struct X arg1"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 1 + self.UpdateWithLines(["#else"]) + + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 0 + self.UpdateWithLines([" void Func(", " struct X arg1"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 1 + + self.UpdateWithLines(["#endif"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 1 + self.UpdateWithLines([" struct X *arg2);"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 0 + + self.UpdateWithLines(["};"]) + assert len(self.nesting_state.stack) == 0 + + def testInlineAssembly(self): + self.UpdateWithLines( + [ + "void CopyRow_SSE2(const uint8_t* src, uint8_t* dst,", + " int count) {", + ] + ) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 0 + assert self.nesting_state.stack[-1].inline_asm == cpplint._NO_ASM + + self.UpdateWithLines([" asm volatile ("]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 1 + assert self.nesting_state.stack[-1].inline_asm == cpplint._INSIDE_ASM + + self.UpdateWithLines( + [ + ' "sub %0,%1 \\n"', + ' "1: \\n"', + ' "movdqa (%0),%%xmm0 \\n"', + ' "movdqa 0x10(%0),%%xmm1 \\n"', + ' "movdqa %%xmm0,(%0,%1) \\n"', + ' "movdqa %%xmm1,0x10(%0,%1) \\n"', + ' "lea 0x20(%0),%0 \\n"', + ' "sub $0x20,%2 \\n"', + ' "jg 1b \\n"', + ' : "+r"(src), // %0', + ' "+r"(dst), // %1', + ' "+r"(count) // %2', + " :", + ' : "memory", "cc"', + ] + ) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 1 + assert self.nesting_state.stack[-1].inline_asm == cpplint._INSIDE_ASM + + self.UpdateWithLines(["#if defined(__SSE2__)", ' , "xmm0", "xmm1"']) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 1 + assert self.nesting_state.stack[-1].inline_asm == cpplint._INSIDE_ASM + + self.UpdateWithLines(["#endif"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 1 + assert self.nesting_state.stack[-1].inline_asm == cpplint._INSIDE_ASM + + self.UpdateWithLines([" );"]) + assert len(self.nesting_state.stack) == 1 + assert self.nesting_state.stack[-1].open_parentheses == 0 + assert self.nesting_state.stack[-1].inline_asm == cpplint._END_ASM + + self.UpdateWithLines(["__asm {"]) + assert len(self.nesting_state.stack) == 2 + assert self.nesting_state.stack[-1].open_parentheses == 0 + assert self.nesting_state.stack[-1].inline_asm == cpplint._BLOCK_ASM + + self.UpdateWithLines(["}"]) + assert len(self.nesting_state.stack) == 1 + + self.UpdateWithLines(["}"]) + assert len(self.nesting_state.stack) == 0 + + +class TestQuiet: + @pytest.fixture(autouse=True) + def setUp(self): + self.temp_dir = os.path.realpath(tempfile.mkdtemp()) + self.this_dir_path = os.path.abspath(self.temp_dir) + self.python_executable = sys.executable or "python" + self.cpplint_test_h = os.path.join(self.this_dir_path, "cpplint_test_header.h") + open(self.cpplint_test_h, "w").close() + + def tearDown(self): + shutil.rmtree(self.temp_dir) + + def _runCppLint(self, *args): + cpplint_abspath = os.path.join(os.path.dirname(os.path.abspath(__file__)), "cpplint.py") + + cmd_line = [self.python_executable, cpplint_abspath] + list(args) + [self.cpplint_test_h] + + return_code = 0 + try: + output = subprocess.check_output(cmd_line, stderr=subprocess.STDOUT) + except subprocess.CalledProcessError as err: + return_code = err.returncode + output = err.output + if isinstance(output, bytes): + output = output.decode("utf-8") + return (return_code, output) + + def testNonQuietWithErrors(self): + # This will fail: the test header is missing a copyright and header guard. + (return_code, output) = self._runCppLint() + assert return_code == 1 + # Always-on behavior: Print error messages as they come up. + assert "[legal/copyright]" in output + assert "[build/header_guard]" in output + # If --quiet was unspecified: Print 'Done processing' and 'Total errors..' + assert "Done processing" in output + assert "Total errors found:" in output + + def testQuietWithErrors(self): + # When there are errors, behavior is identical to not passing --quiet. + (return_code, output) = self._runCppLint("--quiet") + assert return_code == 1 + assert "[legal/copyright]" in output + assert "[build/header_guard]" in output + # Even though --quiet was used, print these since there were errors. + assert "Done processing" in output + assert "Total errors found:" in output + + def testNonQuietWithoutErrors(self): + # This will succeed. We filtered out all the known errors for that file. + (return_code, output) = self._runCppLint( + "--filter=" + "-legal/copyright," + "-build/header_guard" + ) + assert return_code == 0, output + # No cpplint errors are printed since there were no errors. + assert "[legal/copyright]" not in output + assert "[build/header_guard]" not in output + # Print 'Done processing' since + # --quiet was not specified. + assert "Done processing" in output + + def testQuietWithoutErrors(self): + # This will succeed. We filtered out all the known errors for that file. + (return_code, output) = self._runCppLint( + "--quiet", "--filter=" + "-legal/copyright," + "-build/header_guard" + ) + assert return_code == 0, output + # No cpplint errors are printed since there were no errors. + assert "[legal/copyright]" not in output + assert "[build/header_guard]" not in output + # --quiet was specified and there were no errors: + # skip the printing of 'Done processing' and 'Total errors..' + assert "Done processing" not in output + assert "Total errors found:" not in output + # Output with no errors must be completely blank! + assert output == "" -def TrimExtraIndent(text_block): - """Trim a uniform amount of whitespace off of each line in a string. - - Compute the minimum indent on all non blank lines and trim that from each, so - that the block of text has no extra indentation. - - Args: - text_block: a multiline string - - Returns: - text_block with the common whitespace indent of each line removed. - """ - - def CountLeadingWhitespace(s): - count = 0 - for c in s: - if not c.isspace(): - break - count += 1 - return count - # find the minimum indent (except for blank lines) - min_indent = min([CountLeadingWhitespace(line) - for line in text_block.split('\n') if line]) - return '\n'.join([line[min_indent:] for line in text_block.split('\n')]) - - -class CloseExpressionTest(unittest.TestCase): - - def setUp(self): - self.lines = cpplint.CleansedLines( - # 1 2 3 4 5 - # 0123456789012345678901234567890123456789012345678901234567890 - ['// Line 0', - 'inline RCULocked::ReadPtr::ReadPtr(const RCULocked* rcu) {', - ' DCHECK(!(data & kFlagMask)) << "Error";', - '}', - '// Line 4', - 'RCULocked::WritePtr::WritePtr(RCULocked* rcu)', - ' : lock_(&rcu_->mutex_) {', - '}', - '// Line 8', - 'template ', - 'typename std::enable_if<', - ' std::is_array::value && (std::extent::value > 0)>::type', - 'MakeUnique(A&&... a) = delete;', - '// Line 13', - 'auto x = []() {};', - '// Line 15', - 'template ', - 'friend bool operator==(const reffed_ptr& a,', - ' const reffed_ptr& b) {', - ' return a.get() == b.get();', - '}', - '// Line 21']) - - def testCloseExpression(self): - # List of positions to test: - # (start line, start position, end line, end position + 1) - positions = [(1, 16, 1, 19), - (1, 37, 1, 59), - (1, 60, 3, 1), - (2, 8, 2, 29), - (2, 30, 22, -1), # Left shift operator - (9, 9, 9, 36), - (10, 23, 11, 59), - (11, 54, 22, -1), # Greater than operator - (14, 9, 14, 11), - (14, 11, 14, 13), - (14, 14, 14, 16), - (17, 22, 18, 46), - (18, 47, 20, 1)] - for p in positions: - (_, line, column) = cpplint.CloseExpression(self.lines, p[0], p[1]) - self.assertEqual((p[2], p[3]), (line, column)) - - def testReverseCloseExpression(self): - # List of positions to test: - # (end line, end position, start line, start position) - positions = [(1, 18, 1, 16), - (1, 58, 1, 37), - (2, 27, 2, 10), - (2, 28, 2, 8), - (6, 18, 0, -1), # -> operator - (9, 35, 9, 9), - (11, 54, 0, -1), # Greater than operator - (11, 57, 11, 31), - (14, 10, 14, 9), - (14, 12, 14, 11), - (14, 15, 14, 14), - (18, 45, 17, 22), - (20, 0, 18, 47)] - for p in positions: - (_, line, column) = cpplint.ReverseCloseExpression(self.lines, p[0], p[1]) - self.assertEqual((p[2], p[3]), (line, column)) - - -class NestingStateTest(unittest.TestCase): - - def setUp(self): - self.nesting_state = cpplint.NestingState() - self.error_collector = ErrorCollector(self.assertTrue) - - def UpdateWithLines(self, lines): - clean_lines = cpplint.CleansedLines(lines) - for line in range(clean_lines.NumLines()): - self.nesting_state.Update('test.cc', - clean_lines, line, self.error_collector) - - def testEmpty(self): - self.UpdateWithLines([]) - self.assertEqual(self.nesting_state.stack, []) - - def testNamespace(self): - self.UpdateWithLines(['namespace {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], - cpplint._NamespaceInfo)) - self.assertTrue(self.nesting_state.stack[0].seen_open_brace) - self.assertEqual(self.nesting_state.stack[0].name, '') - - self.UpdateWithLines(['namespace outer { namespace inner']) - self.assertEqual(len(self.nesting_state.stack), 3) - self.assertTrue(self.nesting_state.stack[0].seen_open_brace) - self.assertTrue(self.nesting_state.stack[1].seen_open_brace) - self.assertFalse(self.nesting_state.stack[2].seen_open_brace) - self.assertEqual(self.nesting_state.stack[0].name, '') - self.assertEqual(self.nesting_state.stack[1].name, 'outer') - self.assertEqual(self.nesting_state.stack[2].name, 'inner') - - self.UpdateWithLines(['{']) - self.assertTrue(self.nesting_state.stack[2].seen_open_brace) - - self.UpdateWithLines(['}', '}}']) - self.assertEqual(len(self.nesting_state.stack), 0) - - def testDecoratedClass(self): - self.UpdateWithLines(['class Decorated_123 API A {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'A') - self.assertFalse(self.nesting_state.stack[0].is_derived) - self.assertEqual(self.nesting_state.stack[0].class_indent, 0) - self.UpdateWithLines(['}']) - self.assertEqual(len(self.nesting_state.stack), 0) - - def testInnerClass(self): - self.UpdateWithLines(['class A::B::C {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'A::B::C') - self.assertFalse(self.nesting_state.stack[0].is_derived) - self.assertEqual(self.nesting_state.stack[0].class_indent, 0) - self.UpdateWithLines(['}']) - self.assertEqual(len(self.nesting_state.stack), 0) - - def testClass(self): - self.UpdateWithLines(['class A {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'A') - self.assertFalse(self.nesting_state.stack[0].is_derived) - self.assertEqual(self.nesting_state.stack[0].class_indent, 0) - - self.UpdateWithLines(['};', - 'struct B : public A {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'B') - self.assertTrue(self.nesting_state.stack[0].is_derived) - - self.UpdateWithLines(['};', - 'class C', - ': public A {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'C') - self.assertTrue(self.nesting_state.stack[0].is_derived) - - self.UpdateWithLines(['};', - 'template']) - self.assertEqual(len(self.nesting_state.stack), 0) - - self.UpdateWithLines(['class D {', ' class E {']) - self.assertEqual(len(self.nesting_state.stack), 2) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'D') - self.assertFalse(self.nesting_state.stack[0].is_derived) - self.assertTrue(isinstance(self.nesting_state.stack[1], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[1].name, 'E') - self.assertFalse(self.nesting_state.stack[1].is_derived) - self.assertEqual(self.nesting_state.stack[1].class_indent, 2) - self.assertEqual(self.nesting_state.InnermostClass().name, 'E') - - self.UpdateWithLines(['}', '}']) - self.assertEqual(len(self.nesting_state.stack), 0) - - def testClassAccess(self): - self.UpdateWithLines(['class A {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].access, 'private') - - self.UpdateWithLines([' public:']) - self.assertEqual(self.nesting_state.stack[0].access, 'public') - self.UpdateWithLines([' protracted:']) - self.assertEqual(self.nesting_state.stack[0].access, 'public') - self.UpdateWithLines([' protected:']) - self.assertEqual(self.nesting_state.stack[0].access, 'protected') - self.UpdateWithLines([' private:']) - self.assertEqual(self.nesting_state.stack[0].access, 'private') - - self.UpdateWithLines([' struct B {']) - self.assertEqual(len(self.nesting_state.stack), 2) - self.assertTrue(isinstance(self.nesting_state.stack[1], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[1].access, 'public') - self.assertEqual(self.nesting_state.stack[0].access, 'private') - - self.UpdateWithLines([' protected :']) - self.assertEqual(self.nesting_state.stack[1].access, 'protected') - self.assertEqual(self.nesting_state.stack[0].access, 'private') - - self.UpdateWithLines([' }', '}']) - self.assertEqual(len(self.nesting_state.stack), 0) - - def testStruct(self): - self.UpdateWithLines(['struct A {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'A') - self.assertFalse(self.nesting_state.stack[0].is_derived) - - self.UpdateWithLines(['}', - 'void Func(struct B arg) {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertFalse(isinstance(self.nesting_state.stack[0], - cpplint._ClassInfo)) - - self.UpdateWithLines(['}']) - self.assertEqual(len(self.nesting_state.stack), 0) - - def testPreprocessor(self): - self.assertEqual(len(self.nesting_state.pp_stack), 0) - self.UpdateWithLines(['#if MACRO1']) - self.assertEqual(len(self.nesting_state.pp_stack), 1) - self.UpdateWithLines(['#endif']) - self.assertEqual(len(self.nesting_state.pp_stack), 0) - - self.UpdateWithLines(['#ifdef MACRO2']) - self.assertEqual(len(self.nesting_state.pp_stack), 1) - self.UpdateWithLines(['#else']) - self.assertEqual(len(self.nesting_state.pp_stack), 1) - self.UpdateWithLines(['#ifdef MACRO3']) - self.assertEqual(len(self.nesting_state.pp_stack), 2) - self.UpdateWithLines(['#elif MACRO4']) - self.assertEqual(len(self.nesting_state.pp_stack), 2) - self.UpdateWithLines(['#endif']) - self.assertEqual(len(self.nesting_state.pp_stack), 1) - self.UpdateWithLines(['#endif']) - self.assertEqual(len(self.nesting_state.pp_stack), 0) - - self.UpdateWithLines(['#ifdef MACRO5', - 'class A {', - '#elif MACRO6', - 'class B {', - '#else', - 'class C {', - '#endif']) - self.assertEqual(len(self.nesting_state.pp_stack), 0) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'A') - self.UpdateWithLines(['};']) - self.assertEqual(len(self.nesting_state.stack), 0) - - self.UpdateWithLines(['class D', - '#ifdef MACRO7']) - self.assertEqual(len(self.nesting_state.pp_stack), 1) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'D') - self.assertFalse(self.nesting_state.stack[0].is_derived) - - self.UpdateWithLines(['#elif MACRO8', - ': public E']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[0].name, 'D') - self.assertTrue(self.nesting_state.stack[0].is_derived) - self.assertFalse(self.nesting_state.stack[0].seen_open_brace) - - self.UpdateWithLines(['#else', - '{']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[0].name, 'D') - self.assertFalse(self.nesting_state.stack[0].is_derived) - self.assertTrue(self.nesting_state.stack[0].seen_open_brace) - - self.UpdateWithLines(['#endif']) - self.assertEqual(len(self.nesting_state.pp_stack), 0) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[0].name, 'D') - self.assertFalse(self.nesting_state.stack[0].is_derived) - self.assertFalse(self.nesting_state.stack[0].seen_open_brace) - - self.UpdateWithLines([';']) - self.assertEqual(len(self.nesting_state.stack), 0) - - def testTemplate(self): - self.UpdateWithLines(['template >']) - self.assertEqual(len(self.nesting_state.stack), 0) - self.UpdateWithLines(['class A {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'A') - - self.UpdateWithLines(['};', - 'template class B>', - 'class C']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'C') - self.UpdateWithLines([';']) - self.assertEqual(len(self.nesting_state.stack), 0) - - self.UpdateWithLines(['class D : public Tmpl']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'D') - - self.UpdateWithLines(['{', '};']) - self.assertEqual(len(self.nesting_state.stack), 0) - - self.UpdateWithLines(['template ', - 'static void Func() {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertFalse(isinstance(self.nesting_state.stack[0], - cpplint._ClassInfo)) - self.UpdateWithLines(['}', - 'template class K {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'K') - - def testTemplateDefaultArg(self): - self.UpdateWithLines([ - 'template > class unique_ptr {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(self.nesting_state.stack[0], isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - - def testTemplateInnerClass(self): - self.UpdateWithLines(['class A {', - ' public:']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - - self.UpdateWithLines([' template ', - ' class C >', - ' : public A {']) - self.assertEqual(len(self.nesting_state.stack), 2) - self.assertTrue(isinstance(self.nesting_state.stack[1], cpplint._ClassInfo)) - - def testArguments(self): - self.UpdateWithLines(['class A {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'A') - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 0) - - self.UpdateWithLines([' void Func(', - ' struct X arg1,']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 1) - self.UpdateWithLines([' struct X *arg2);']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 0) - - self.UpdateWithLines(['};']) - self.assertEqual(len(self.nesting_state.stack), 0) - - self.UpdateWithLines(['struct B {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertTrue(isinstance(self.nesting_state.stack[0], cpplint._ClassInfo)) - self.assertEqual(self.nesting_state.stack[0].name, 'B') - - self.UpdateWithLines(['#ifdef MACRO', - ' void Func(', - ' struct X arg1']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 1) - self.UpdateWithLines(['#else']) - - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 0) - self.UpdateWithLines([' void Func(', - ' struct X arg1']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 1) - - self.UpdateWithLines(['#endif']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 1) - self.UpdateWithLines([' struct X *arg2);']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 0) - - self.UpdateWithLines(['};']) - self.assertEqual(len(self.nesting_state.stack), 0) - - def testInlineAssembly(self): - self.UpdateWithLines(['void CopyRow_SSE2(const uint8_t* src, uint8_t* dst,', - ' int count) {']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 0) - self.assertEqual(self.nesting_state.stack[-1].inline_asm, cpplint._NO_ASM) - - self.UpdateWithLines([' asm volatile (']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 1) - self.assertEqual(self.nesting_state.stack[-1].inline_asm, - cpplint._INSIDE_ASM) - - self.UpdateWithLines([' "sub %0,%1 \\n"', - ' "1: \\n"', - ' "movdqa (%0),%%xmm0 \\n"', - ' "movdqa 0x10(%0),%%xmm1 \\n"', - ' "movdqa %%xmm0,(%0,%1) \\n"', - ' "movdqa %%xmm1,0x10(%0,%1) \\n"', - ' "lea 0x20(%0),%0 \\n"', - ' "sub $0x20,%2 \\n"', - ' "jg 1b \\n"', - ' : "+r"(src), // %0', - ' "+r"(dst), // %1', - ' "+r"(count) // %2', - ' :', - ' : "memory", "cc"']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 1) - self.assertEqual(self.nesting_state.stack[-1].inline_asm, - cpplint._INSIDE_ASM) - - self.UpdateWithLines(['#if defined(__SSE2__)', - ' , "xmm0", "xmm1"']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 1) - self.assertEqual(self.nesting_state.stack[-1].inline_asm, - cpplint._INSIDE_ASM) - - self.UpdateWithLines(['#endif']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 1) - self.assertEqual(self.nesting_state.stack[-1].inline_asm, - cpplint._INSIDE_ASM) - - self.UpdateWithLines([' );']) - self.assertEqual(len(self.nesting_state.stack), 1) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 0) - self.assertEqual(self.nesting_state.stack[-1].inline_asm, cpplint._END_ASM) - - self.UpdateWithLines(['__asm {']) - self.assertEqual(len(self.nesting_state.stack), 2) - self.assertEqual(self.nesting_state.stack[-1].open_parentheses, 0) - self.assertEqual(self.nesting_state.stack[-1].inline_asm, - cpplint._BLOCK_ASM) - - self.UpdateWithLines(['}']) - self.assertEqual(len(self.nesting_state.stack), 1) - - self.UpdateWithLines(['}']) - self.assertEqual(len(self.nesting_state.stack), 0) - - -class QuietTest(unittest.TestCase): - - def setUp(self): - self.temp_dir = os.path.realpath(tempfile.mkdtemp()) - self.this_dir_path = os.path.abspath(self.temp_dir) - self.python_executable = sys.executable or 'python' - self.cpplint_test_h = os.path.join(self.this_dir_path, - 'cpplint_test_header.h') - open(self.cpplint_test_h, 'w').close() - - def tearDown(self): - shutil.rmtree(self.temp_dir) - - def _runCppLint(self, *args): - cpplint_abspath = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'cpplint.py') - - cmd_line = [self.python_executable, cpplint_abspath] + \ - list(args) + \ - [self.cpplint_test_h] - - return_code = 0 - try: - output = subprocess.check_output(cmd_line, - stderr=subprocess.STDOUT) - except subprocess.CalledProcessError as err: - return_code = err.returncode - output = err.output - if isinstance(output, bytes): - output = output.decode('utf-8') - return (return_code, output) - - def testNonQuietWithErrors(self): - # This will fail: the test header is missing a copyright and header guard. - (return_code, output) = self._runCppLint() - self.assertEqual(1, return_code) - # Always-on behavior: Print error messages as they come up. - self.assertIn("[legal/copyright]", output) - self.assertIn("[build/header_guard]", output) - # If --quiet was unspecified: Print 'Done processing' and 'Total errors..' - self.assertIn("Done processing", output) - self.assertIn("Total errors found:", output) - - def testQuietWithErrors(self): - # When there are errors, behavior is identical to not passing --quiet. - (return_code, output) = self._runCppLint('--quiet') - self.assertEqual(1, return_code) - self.assertIn("[legal/copyright]", output) - self.assertIn("[build/header_guard]", output) - # Even though --quiet was used, print these since there were errors. - self.assertIn("Done processing", output) - self.assertIn("Total errors found:", output) - - def testNonQuietWithoutErrors(self): - # This will succeed. We filtered out all the known errors for that file. - (return_code, output) = self._runCppLint('--filter=' + - '-legal/copyright,' + - '-build/header_guard') - self.assertEqual(0, return_code, output) - # No cpplint errors are printed since there were no errors. - self.assertNotIn("[legal/copyright]", output) - self.assertNotIn("[build/header_guard]", output) - # Print 'Done processing' since - # --quiet was not specified. - self.assertIn("Done processing", output) - - def testQuietWithoutErrors(self): - # This will succeed. We filtered out all the known errors for that file. - (return_code, output) = self._runCppLint('--quiet', - '--filter=' + - '-legal/copyright,' + - '-build/header_guard') - self.assertEqual(0, return_code, output) - # No cpplint errors are printed since there were no errors. - self.assertNotIn("[legal/copyright]", output) - self.assertNotIn("[build/header_guard]", output) - # --quiet was specified and there were no errors: - # skip the printing of 'Done processing' and 'Total errors..' - self.assertNotIn("Done processing", output) - self.assertNotIn("Total errors found:", output) - # Output with no errors must be completely blank! - self.assertEqual("", output) # class FileFilterTest(unittest.TestCase): # def testFilterExcludedFiles(self): # self.assertEqual([], _FilterExcludedFiles([])) -# pylint: disable=C6409 -def setUp(): - """Runs before all tests are executed. - """ - # Enable all filters, so we don't miss anything that is off by default. - cpplint._DEFAULT_FILTERS = [] - cpplint._cpplint_state.SetFilters('') - # pylint: disable=C6409 -def tearDown(): - """A global check to make sure all error-categories have been tested. - - The main tearDown() routine is the only code we can guarantee will be - run after all other tests have been executed. - """ - try: - if _run_verifyallcategoriesseen: - ErrorCollector(None).VerifyAllCategoriesAreSeen() - except NameError: - # If nobody set the global _run_verifyallcategoriesseen, then - # we assume we should silently not run the test - pass - - -@pytest.fixture(autouse=True) -def run_around_tests(): - setUp() - yield - tearDown() - - -if __name__ == '__main__': - # We don't want to run the VerifyAllCategoriesAreSeen() test unless - # we're running the full test suite: if we only run one test, - # obviously we're not going to see all the error categories. So we - # only run VerifyAllCategoriesAreSeen() when no commandline flags - # are passed in. - global _run_verifyallcategoriesseen - _run_verifyallcategoriesseen = (len(sys.argv) == 1) - - setUp() - unittest.main() - tearDown() +def setUp(): + """Runs before all tests are executed.""" + # Enable all filters, so we don't miss anything that is off by default. + cpplint._DEFAULT_FILTERS = [] + cpplint._cpplint_state.SetFilters("") + + +@pytest.fixture(autouse=True, scope="session") +def run_around_tests(pytestconfig: pytest.Config): + setUp() + yield + # We don't want to run the VerifyAllCategoriesAreSeen() test unless + # we're running the full test suite: if we only run one test, + # obviously we're not going to see all the error categories. So we + # only run VerifyAllCategoriesAreSeen() when we don't filter for + # specific tests. + if pytestconfig.getoption("-k", default=None) in {None, ""} and not any( + "::" in arg for arg in pytestconfig.args + ): + ErrorCollector(None).VerifyAllCategoriesAreSeen() + + +if __name__ == "__main__": + pytest.main([__file__]) diff --git a/dev-requirements b/dev-requirements deleted file mode 100644 index 62a36ea..0000000 --- a/dev-requirements +++ /dev/null @@ -1,5 +0,0 @@ -# requirements to run development steps - -flake8>=4.0.1 -pylint>=2.11.0 -setuptools diff --git a/pyproject.toml b/pyproject.toml index 29ae077..f028050 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,212 @@ [build-system] -build-backend = "setuptools.build_meta:__legacy__" -requires = [ - "setuptools", - "wheel", +build-backend = "setuptools.build_meta" +requires = [ "setuptools>=61.2" ] + +[project] +name = "cpplint" +description = "Check C++ files configurably against Google's style guide" +readme = "README.rst" +keywords = [ "c++", "cpp", "google style", "lint" ] +license = { text = "BSD-3-Clause" } +maintainers = [ + { name = "Aaron Liu", email = "aaronliu0130@gmail.com" }, + { name = "Christian Clauss", email = "cclauss@me.com" }, + { name = "John Vandenberg", email = "jayvdb@gmail.com" }, ] +authors = [ + { name = "Google Inc." }, + { name = "Thibault Kruse" }, + { name = "Andrew Davis", email = "theandrewdavis@gmail.com" }, + { name = "cpplint developers" }, +] +requires-python = ">=3.8" +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Environment :: Console", + "Intended Audience :: End Users/Desktop", + "License :: Freely Distributable", + "License :: OSI Approved :: BSD License", + "Natural Language :: English", + "Programming Language :: C++", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Topic :: Software Development :: Quality Assurance", +] +dynamic = [ "version" ] +dependencies = [ ] + +optional-dependencies.dev = [ + "mypy", + "parameterized", + "pylint>=2.11", + "pytest", + "pytest-cov", + "pytest-timeout", + "testfixtures", + "tox<5", +] +urls.Homepage = "https://github.com/cpplint/cpplint" +scripts.cpplint = "cpplint:main" + +[tool.setuptools] +py-modules = [ "cpplint" ] +include-package-data = false +dynamic.version = { attr = "cpplint.__VERSION__" } + +[tool.ruff] +target-version = "py38" + +line-length = 100 +lint.select = [ + "A", # flake8-builtins + "AIR", # Airflow + "ASYNC", # flake8-async + "B", # flake8-bugbear + "BLE", # flake8-blind-except + "C4", # flake8-comprehensions + "C90", # McCabe cyclomatic complexity + "DJ", # flake8-django + "DTZ", # flake8-datetimez + "E", # pycodestyle + "EM", # flake8-errmsg + "EXE", # flake8-executable + "F", # Pyflakes + "FA", # flake8-future-annotations + "FAST", # FastAPI + "FBT", # flake8-boolean-trap + "FIX", # flake8-fixme + "FLY", # flynt + "FURB", # refurb + "G", # flake8-logging-format + "I", # isort + "ICN", # flake8-import-conventions + "INP", # flake8-no-pep420 + "INT", # flake8-gettext + "ISC", # flake8-implicit-str-concat + "LOG", # flake8-logging + "N", # pep8-naming + "NPY", # NumPy-specific rules + "PD", # pandas-vet + "PERF", # Perflint + "PGH", # pygrep-hooks + "PIE", # flake8-pie + "PL", # Pylint + "PT", # flake8-pytest-style + "PYI", # flake8-pyi + "Q", # flake8-quotes + "RET", # flake8-return + "RSE", # flake8-raise + "SIM", # flake8-simplify + "SLOT", # flake8-slots + "T10", # flake8-debugger + "TC", # flake8-type-checking + "TD", # flake8-todos + "TID", # flake8-tidy-imports + "TRY", # tryceratops + "UP", # pyupgrade + "W", # pycodestyle + "YTT", # flake8-2020 + # "ANN", # flake8-annotations + # "ARG", # flake8-unused-arguments + # "COM", # flake8-commas + # "CPY", # flake8-copyright + # "D", # pydocstyle + # "DOC", # pydoclint + # "ERA", # eradicate + # "PTH", # flake8-use-pathlib + # "RUF", # Ruff-specific rules + # "S", # flake8-bandit + # "SLF", # flake8-self + # "T20", # flake8-print +] +lint.ignore = [ + "FBT003", # flake8-boolean-trap + "FIX002", # flake8-fixme + "ISC003", # flake8-implicit-str-concat + "PIE790", # Unnecessary `pass` statement + "TD003", # flake8-todos +] +lint.per-file-ignores."cpplint.py" = [ + "ICN001", + "N802", + "PERF401", + "PLR5501", + "PLW0603", + "PLW2901", + "SIM102", + "SIM108", +] +lint.per-file-ignores."cpplint_unittest.py" = [ "FLY002", "N802", "PLW0604", "SIM115", "UP031" ] +lint.mccabe.max-complexity = 29 +lint.pylint.allow-magic-value-types = [ "bytes", "int", "str" ] +lint.pylint.max-args = 10 # Default is 5 +lint.pylint.max-bool-expr = 8 # Default is 5 +lint.pylint.max-branches = 30 # Default is 12 +lint.pylint.max-locals = 16 # Default is 15 +lint.pylint.max-public-methods = 130 # Default is 20 +lint.pylint.max-returns = 9 # Default is 9 +lint.pylint.max-statements = 79 # Default is 50 + +[tool.pylint.basic] +argument-rgx = "[a-z_][a-z0-9_]{0,49}$" +class-rgx = "[A-Z_][a-zA-Z0-9]+$" +const-rgx = "[a-zA-Z_][A-Za-z0-9_]{2,49}$" +function-rgx = "[A-Z_][A-Za-z0-9]{2,49}$|main" +include-naming-hint = true +method-rgx = "[A-Z_][A-Za-z0-9]{2,49}$|__init__|__str__|__contains__" +variable-rgx = "[a-z_][a-z0-9_]{0,49}$" + +[tool.pylint.messages-control] +disable = [ + "anomalous-unicode-escape-in-string", + "bad-continuation", + "bad-option-value", + "consider-merging-isinstance", + "consider-using-dict-comprehension", + "consider-using-in", + "consider-using-min-builtin", + "fixme", + "global-statement", + "missing-docstring", + "multiple-statements", + "no-else-return", + "no-self-use", + "too-many-positional-arguments", + "unnecessary-pass", + "unused-argument", + "useless-object-inheritance", +] + +[tool.pylint.reports] +output-format = "colorized" +reports = false +score = false + +[tool.pylint.format] +indent-after-paren = 4 +indent-string = ' ' +max-module-lines = 10000 + +[tool.pylint.design] +max-args = 20 +max-attributes = 10 +max-bool-expr = 10 +max-branches = 30 +max-line-length = 100 +max-locals = 25 +max-returns = 10 +max-statements = 79 +min-public-methods = 0 + +[tool.pytest.ini_options] +# fail if coverage is under 90% +addopts = "--color=yes --cov-fail-under=90 --cov=cpplint" +python_files = [ "*test.py" ] +required_plugins = [ "pytest-cov", "pytest-timeout" ] +testpaths = [ "." ] +timeout = 60 diff --git a/samples/boost-sample/exclude.def b/samples/boost-sample/exclude.def index e9fef89..731ffad 100644 --- a/samples/boost-sample/exclude.def +++ b/samples/boost-sample/exclude.def @@ -3,15 +3,13 @@ 4 Done processing src/inspect/unnamed_namespace_check.hpp Done processing src/tr1/c_policy.hpp -Total errors found: 126 +Total errors found: 121 src/inspect/unnamed_namespace_check.hpp:0: No #ifndef header guard found, suggested CPP variable is: SAMPLES_BOOST_SAMPLE_SRC_INSPECT_UNNAMED_NAMESPACE_CHECK_HPP_ [build/header_guard] [5] src/inspect/unnamed_namespace_check.hpp:11: Include the directory when naming header files [build/include_subdir] [4] src/inspect/unnamed_namespace_check.hpp:14: Do not use unnamed namespaces in header files. See https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces for more information. [build/namespaces_headers] [4] src/inspect/unnamed_namespace_check.hpp:17: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/inspect/unnamed_namespace_check.hpp:18: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:18: At least two spaces is best between code and comments [whitespace/comments] [2] -src/inspect/unnamed_namespace_check.hpp:19: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:19: Closing ) should be moved to the previous line [whitespace/parens] [2] src/inspect/unnamed_namespace_check.hpp:21: Anonymous namespace should be terminated with "// namespace" [readability/namespace] [5] src/inspect/unnamed_namespace_check.hpp:21: At least two spaces is best between code and comments [whitespace/comments] [2] @@ -44,9 +42,6 @@ src/inspect/unnamed_namespace_check.hpp:38: Do not indent within a namespace. src/inspect/unnamed_namespace_check.hpp:38: Weird number of spaces at line-start. Are you using a 2-space indent? [whitespace/indent] [3] src/inspect/unnamed_namespace_check.hpp:40: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:40: Weird number of spaces at line-start. Are you using a 2-space indent? [whitespace/indent] [3] -src/inspect/unnamed_namespace_check.hpp:41: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/inspect/unnamed_namespace_check.hpp:42: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/inspect/unnamed_namespace_check.hpp:43: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:44: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:44: { should almost always be at the end of the previous line [whitespace/braces] [4] src/inspect/unnamed_namespace_check.hpp:48: Lines should be <= 80 characters long [whitespace/line_length] [2] diff --git a/samples/boost-sample/headers_inspect.def b/samples/boost-sample/headers_inspect.def index 6c61efc..3c1d647 100644 --- a/samples/boost-sample/headers_inspect.def +++ b/samples/boost-sample/headers_inspect.def @@ -2,15 +2,13 @@ src/inspect/* 1 3 Done processing src/inspect/unnamed_namespace_check.hpp -Total errors found: 55 +Total errors found: 50 src/inspect/unnamed_namespace_check.hpp:0: No #ifndef header guard found, suggested CPP variable is: SAMPLES_BOOST_SAMPLE_SRC_INSPECT_UNNAMED_NAMESPACE_CHECK_HPP_ [build/header_guard] [5] src/inspect/unnamed_namespace_check.hpp:11: Include the directory when naming header files [build/include_subdir] [4] src/inspect/unnamed_namespace_check.hpp:14: Do not use unnamed namespaces in header files. See https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces for more information. [build/namespaces_headers] [4] src/inspect/unnamed_namespace_check.hpp:17: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/inspect/unnamed_namespace_check.hpp:18: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:18: At least two spaces is best between code and comments [whitespace/comments] [2] -src/inspect/unnamed_namespace_check.hpp:19: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:19: Closing ) should be moved to the previous line [whitespace/parens] [2] src/inspect/unnamed_namespace_check.hpp:21: Anonymous namespace should be terminated with "// namespace" [readability/namespace] [5] src/inspect/unnamed_namespace_check.hpp:21: At least two spaces is best between code and comments [whitespace/comments] [2] @@ -43,9 +41,6 @@ src/inspect/unnamed_namespace_check.hpp:38: Do not indent within a namespace. src/inspect/unnamed_namespace_check.hpp:38: Weird number of spaces at line-start. Are you using a 2-space indent? [whitespace/indent] [3] src/inspect/unnamed_namespace_check.hpp:40: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:40: Weird number of spaces at line-start. Are you using a 2-space indent? [whitespace/indent] [3] -src/inspect/unnamed_namespace_check.hpp:41: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/inspect/unnamed_namespace_check.hpp:42: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/inspect/unnamed_namespace_check.hpp:43: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:44: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/inspect/unnamed_namespace_check.hpp:44: { should almost always be at the end of the previous line [whitespace/braces] [4] src/inspect/unnamed_namespace_check.hpp:48: Lines should be <= 80 characters long [whitespace/line_length] [2] diff --git a/samples/boost-sample/include/boost/math/octonion.hpp b/samples/boost-sample/include/boost/math/octonion.hpp index fba9aff..a6c1a67 100644 --- a/samples/boost-sample/include/boost/math/octonion.hpp +++ b/samples/boost-sample/include/boost/math/octonion.hpp @@ -925,7 +925,7 @@ namespace boost // There is quite a lot of repetition in the code below. This is intentional. // The last conditional block is the normal form, and the others merely -// consist of workarounds for various compiler deficiencies. Hopefuly, when +// consist of workarounds for various compiler deficiencies. Hopefully, when // more compilers are conformant and we can retire support for those that are // not, we will be able to remove the clutter. This is makes the situation // (painfully) explicit. @@ -3970,7 +3970,7 @@ namespace boost #undef BOOST_OCTONION_VALARRAY_LOADER - // Note: This is the Cayley norm, not the Euclidian norm... + // Note: This is the Cayley norm, not the Euclidean norm... template inline T norm(octonion const & o) diff --git a/samples/boost-sample/simple.def b/samples/boost-sample/simple.def index 823013c..229b367 100644 --- a/samples/boost-sample/simple.def +++ b/samples/boost-sample/simple.def @@ -2,7 +2,7 @@ include/boost/math/* 1 3 Done processing include/boost/math/octonion.hpp -Total errors found: 2924 +Total errors found: 2900 include/boost/math/octonion.hpp:11: #ifndef header guard has wrong style, please use: SAMPLES_BOOST_SAMPLE_INCLUDE_BOOST_MATH_OCTONION_HPP_ [build/header_guard] [5] include/boost/math/octonion.hpp:4250: #endif line should be "#endif // SAMPLES_BOOST_SAMPLE_INCLUDE_BOOST_MATH_OCTONION_HPP_" [build/header_guard] [5] @@ -1167,7 +1167,6 @@ include/boost/math/octonion.hpp:1711: Do not indent within a namespace. [white include/boost/math/octonion.hpp:1711: Lines should be <= 80 characters long [whitespace/line_length] [2] include/boost/math/octonion.hpp:1711: Missing space after , [whitespace/comma] [3] include/boost/math/octonion.hpp:1711: Extra space after ( [whitespace/parens] [2] -include/boost/math/octonion.hpp:1712: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:1713: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:1713: { should almost always be at the end of the previous line [whitespace/braces] [4] include/boost/math/octonion.hpp:1716: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -2616,7 +2615,6 @@ include/boost/math/octonion.hpp:3856: Do not indent within a namespace. [white include/boost/math/octonion.hpp:3856: Lines should be <= 80 characters long [whitespace/line_length] [2] include/boost/math/octonion.hpp:3856: Missing space after , [whitespace/comma] [3] include/boost/math/octonion.hpp:3856: Extra space after ( [whitespace/parens] [2] -include/boost/math/octonion.hpp:3857: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:3857: Lines should be <= 80 characters long [whitespace/line_length] [2] include/boost/math/octonion.hpp:3858: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:3858: { should almost always be at the end of the previous line [whitespace/braces] [4] @@ -2728,13 +2726,6 @@ include/boost/math/octonion.hpp:3999: Do not indent within a namespace. [white include/boost/math/octonion.hpp:3999: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] include/boost/math/octonion.hpp:4000: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4001: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4002: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4003: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4004: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4005: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4006: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4007: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4008: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4009: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4009: { should almost always be at the end of the previous line [whitespace/braces] [4] include/boost/math/octonion.hpp:4012: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] @@ -2772,13 +2763,6 @@ include/boost/math/octonion.hpp:4054: Do not indent within a namespace. [white include/boost/math/octonion.hpp:4054: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] include/boost/math/octonion.hpp:4055: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4056: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4057: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4058: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4059: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4060: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4061: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4062: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4063: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4064: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4064: { should almost always be at the end of the previous line [whitespace/braces] [4] include/boost/math/octonion.hpp:4067: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] @@ -2791,13 +2775,6 @@ include/boost/math/octonion.hpp:4080: Do not indent within a namespace. [white include/boost/math/octonion.hpp:4080: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] include/boost/math/octonion.hpp:4081: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4082: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4083: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4084: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4085: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4086: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4087: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4088: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4089: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4090: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4090: { should almost always be at the end of the previous line [whitespace/braces] [4] include/boost/math/octonion.hpp:4093: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] @@ -2886,7 +2863,6 @@ include/boost/math/octonion.hpp:4192: Do not indent within a namespace. [white include/boost/math/octonion.hpp:4192: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] include/boost/math/octonion.hpp:4193: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4194: Do not indent within a namespace. [whitespace/indent_namespace] [4] -include/boost/math/octonion.hpp:4195: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4196: Do not indent within a namespace. [whitespace/indent_namespace] [4] include/boost/math/octonion.hpp:4196: { should almost always be at the end of the previous line [whitespace/braces] [4] include/boost/math/octonion.hpp:4198: { should almost always be at the end of the previous line [whitespace/braces] [4] diff --git a/samples/chromium-sample/simple.def b/samples/chromium-sample/simple.def index 1e68efd..a5c6c5c 100644 --- a/samples/chromium-sample/simple.def +++ b/samples/chromium-sample/simple.def @@ -5,12 +5,9 @@ Done processing src/chrome_content_renderer_client.cc Done processing src/chrome_content_renderer_client.h Done processing src/io_thread.cc Done processing src/io_thread.h -Total errors found: 25 +Total errors found: 18 src/chrome_content_renderer_client.cc:303: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/chrome_content_renderer_client.cc:308: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/chrome_content_renderer_client.cc:309: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/chrome_content_renderer_client.cc:310: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/chrome_content_renderer_client.cc:308: Add #include for vector<> [build/include_what_you_use] [4] src/chrome_content_renderer_client.cc:1540: Add #include for set<> [build/include_what_you_use] [4] src/chrome_content_renderer_client.cc:1841: Add #include for string [build/include_what_you_use] [4] @@ -19,10 +16,6 @@ src/chrome_content_renderer_client.h:5: #ifndef header guard has wrong style, p src/chrome_content_renderer_client.h:225: #endif line should be "#endif // SAMPLES_CHROMIUM_SAMPLE_SRC_CHROME_CONTENT_RENDERER_CLIENT_H_" [build/header_guard] [5] src/chrome_content_renderer_client.h:115: Use int16_t/int64_t/etc, rather than the C type long [runtime/int] [4] src/chrome_content_renderer_client.h:117: Use int16_t/int64_t/etc, rather than the C type long [runtime/int] [4] -src/io_thread.cc:242: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/io_thread.cc:286: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/io_thread.cc:298: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/io_thread.cc:299: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/io_thread.cc:1148: Closing ) should be moved to the previous line [whitespace/parens] [2] src/io_thread.cc:1547: Missing space around colon in range-based for loop [whitespace/forcolon] [2] src/io_thread.cc:651: Add #include for map<> [build/include_what_you_use] [4] diff --git a/samples/chromium-sample/src/chrome_content_renderer_client.cc b/samples/chromium-sample/src/chrome_content_renderer_client.cc index 04a7dbd..fe0d0ec 100644 --- a/samples/chromium-sample/src/chrome_content_renderer_client.cc +++ b/samples/chromium-sample/src/chrome_content_renderer_client.cc @@ -1194,12 +1194,12 @@ WebPlugin* ChromeContentRendererClient::CreatePlugin( #endif // BUILDFLAG(ENABLE_PLUGINS) // For NaCl content handling plugins, the NaCl manifest is stored in an -// additonal 'nacl' param associated with the MIME type. +// additional 'nacl' param associated with the MIME type. // static GURL ChromeContentRendererClient::GetNaClContentHandlerURL( const std::string& actual_mime_type, const content::WebPluginInfo& plugin) { - // Look for the manifest URL among the MIME type's additonal parameters. + // Look for the manifest URL among the MIME type's additional parameters. for (const auto& mime_type : plugin.mime_types) { if (mime_type.mime_type == actual_mime_type) { for (const auto& p : mime_type.additional_params) { diff --git a/samples/codelite-sample/src/pptable.cpp b/samples/codelite-sample/src/pptable.cpp index c11c811..62be675 100644 --- a/samples/codelite-sample/src/pptable.cpp +++ b/samples/codelite-sample/src/pptable.cpp @@ -155,7 +155,7 @@ void PPToken::processArgs(const wxString &argsList) { args = wxStringTokenize(argsList, wxT(","), wxTOKEN_STRTOK); - // replace all occurances of 'arg' with %1, %2 etc + // replace all occurrences of 'arg' with %1, %2 etc for(size_t i=0; isecond.fullname() << wxT("=") << replacement << wxT("\n"); diff --git a/samples/protobuf-sample/simple.def b/samples/protobuf-sample/simple.def index a01d2b0..963eaba 100644 --- a/samples/protobuf-sample/simple.def +++ b/samples/protobuf-sample/simple.def @@ -4,7 +4,7 @@ src/* Done processing src/descriptor.pb.cc Done processing src/descriptor.pb.h Done processing src/descriptor_unittest.cc -Total errors found: 3212 +Total errors found: 3111 src/descriptor.pb.cc:0: No copyright message found. You should have a line: "Copyright [year] " [legal/copyright] [5] src/descriptor.pb.cc:9: Found C system header after C++ system header. Should be: descriptor.pb.h, c system, c++ system, other. [build/include_order] [4] @@ -266,12 +266,9 @@ src/descriptor.pb.cc:900: Do not indent within a namespace. [whitespace/indent src/descriptor.pb.cc:917: If statement had no body and no else clause [whitespace/empty_if_body] [4] src/descriptor.pb.cc:932: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:938: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:956: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:961: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:964: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:970: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:1004: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor.pb.cc:1020: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:1030: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:1063: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] src/descriptor.pb.cc:1064: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -297,7 +294,6 @@ src/descriptor.pb.cc:1249: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:1252: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:1260: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:1263: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:1280: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:1285: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:1288: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:1347: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -314,8 +310,6 @@ src/descriptor.pb.cc:1455: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:1456: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:1459: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:1460: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:1510: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor.pb.cc:1608: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:1708: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:1733: Redundant blank line at the end of a code block should be deleted. [whitespace/blank_line] [3] src/descriptor.pb.cc:1756: Redundant blank line at the end of a code block should be deleted. [whitespace/blank_line] [3] @@ -479,16 +473,13 @@ src/descriptor.pb.cc:2482: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:2484: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2502: Are you taking an address of something dereferenced from a cast? Wrapping the dereferenced expression in parentheses will make the binding more obvious [readability/casting] [4] src/descriptor.pb.cc:2506: Missing space after , [whitespace/comma] [3] -src/descriptor.pb.cc:2522: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:2527: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2530: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2535: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2550: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:2583: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:2587: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2592: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2602: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:2603: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:2607: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2612: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2616: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -515,16 +506,13 @@ src/descriptor.pb.cc:2781: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:2783: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2801: Are you taking an address of something dereferenced from a cast? Wrapping the dereferenced expression in parentheses will make the binding more obvious [readability/casting] [4] src/descriptor.pb.cc:2805: Missing space after , [whitespace/comma] [3] -src/descriptor.pb.cc:2821: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:2826: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2829: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2834: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2849: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:2882: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:2886: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2891: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2901: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:2902: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:2906: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2911: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:2915: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -547,7 +535,6 @@ src/descriptor.pb.cc:3071: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:3088: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:3106: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:3109: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:3127: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:3132: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:3135: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:3158: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -560,9 +547,7 @@ src/descriptor.pb.cc:3237: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:3252: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:3263: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:3268: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:3321: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:3351: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:3399: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:3433: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:3479: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:3504: Redundant blank line at the end of a code block should be deleted. [whitespace/blank_line] [3] @@ -693,7 +678,6 @@ src/descriptor.pb.cc:4322: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:4325: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4328: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4334: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:4347: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:4352: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4355: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4394: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -703,11 +687,9 @@ src/descriptor.pb.cc:4430: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:4433: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4482: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4496: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:4546: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:4570: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4613: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4633: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:4634: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:4660: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4706: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:4721: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -862,12 +844,9 @@ src/descriptor.pb.cc:5381: If statement had no body and no else clause [whites src/descriptor.pb.cc:5396: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5402: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5413: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:5422: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:5427: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5430: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:5470: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:5489: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:5490: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:5504: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5536: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] src/descriptor.pb.cc:5537: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -903,13 +882,10 @@ src/descriptor.pb.cc:5699: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:5716: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5722: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5734: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:5748: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:5753: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5756: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5779: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5794: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:5826: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor.pb.cc:5858: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:5886: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:5911: Redundant blank line at the end of a code block should be deleted. [whitespace/blank_line] [3] src/descriptor.pb.cc:5935: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] @@ -955,15 +931,12 @@ src/descriptor.pb.cc:6200: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:6206: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6218: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6222: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:6232: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:6237: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6240: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6262: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6276: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:6308: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:6322: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6338: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:6339: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:6354: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6365: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6397: Redundant blank line at the end of a code block should be deleted. [whitespace/blank_line] [3] @@ -1014,14 +987,11 @@ src/descriptor.pb.cc:6672: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:6678: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6690: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6693: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:6704: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:6709: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6712: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6735: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6750: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:6782: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:6813: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:6814: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:6842: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:6867: Redundant blank line at the end of a code block should be deleted. [whitespace/blank_line] [3] src/descriptor.pb.cc:6888: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1077,17 +1047,14 @@ src/descriptor.pb.cc:7199: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:7202: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7205: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7208: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:7222: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:7227: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7230: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7285: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7299: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7314: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:7347: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:7387: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7392: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7402: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:7403: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:7447: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7452: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:7456: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1200,7 +1167,6 @@ src/descriptor.pb.cc:8014: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:8018: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8024: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8027: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:8042: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:8047: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8050: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8074: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1218,7 +1184,6 @@ src/descriptor.pb.cc:8231: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:8248: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8275: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8281: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:8320: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:8335: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8342: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8350: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1229,7 +1194,6 @@ src/descriptor.pb.cc:8380: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:8385: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8390: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8395: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:8436: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:8452: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8460: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:8468: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1419,7 +1383,6 @@ src/descriptor.pb.cc:9363: If statement had no body and no else clause [whites src/descriptor.pb.cc:9378: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9403: Are you taking an address of something dereferenced from a cast? Wrapping the dereferenced expression in parentheses will make the binding more obvious [readability/casting] [4] src/descriptor.pb.cc:9407: Missing space after , [whitespace/comma] [3] -src/descriptor.pb.cc:9424: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:9429: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9432: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9437: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1428,12 +1391,10 @@ src/descriptor.pb.cc:9467: Lines should be <= 80 characters long [whitespace/l src/descriptor.pb.cc:9482: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9492: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9498: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:9537: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:9541: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9546: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9551: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9556: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:9577: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:9581: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9586: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:9591: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1476,7 +1437,6 @@ src/descriptor.pb.cc:9972: If statement had no body and no else clause [whites src/descriptor.pb.cc:9987: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10012: Are you taking an address of something dereferenced from a cast? Wrapping the dereferenced expression in parentheses will make the binding more obvious [readability/casting] [4] src/descriptor.pb.cc:10016: Missing space after , [whitespace/comma] [3] -src/descriptor.pb.cc:10036: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:10041: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10044: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10045: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1491,13 +1451,11 @@ src/descriptor.pb.cc:10118: Lines should be <= 80 characters long [whitespace/ src/descriptor.pb.cc:10134: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10144: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10150: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:10189: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:10199: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10204: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10209: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10212: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10220: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:10241: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:10251: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10256: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10261: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1547,17 +1505,14 @@ src/descriptor.pb.cc:10664: If statement had no body and no else clause [white src/descriptor.pb.cc:10679: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10704: Are you taking an address of something dereferenced from a cast? Wrapping the dereferenced expression in parentheses will make the binding more obvious [readability/casting] [4] src/descriptor.pb.cc:10708: Missing space after , [whitespace/comma] [3] -src/descriptor.pb.cc:10725: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:10730: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10733: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10738: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10753: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10763: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10769: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:10808: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:10812: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10817: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:10838: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:10842: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10847: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:10862: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1584,15 +1539,12 @@ src/descriptor.pb.cc:11083: Do not indent within a namespace. [whitespace/inde src/descriptor.pb.cc:11101: If statement had no body and no else clause [whitespace/empty_if_body] [4] src/descriptor.pb.cc:11116: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11122: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11142: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11147: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11150: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11155: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11165: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11171: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11210: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11214: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11235: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11239: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11254: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11294: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] @@ -1613,15 +1565,12 @@ src/descriptor.pb.cc:11439: Do not indent within a namespace. [whitespace/inde src/descriptor.pb.cc:11440: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11458: If statement had no body and no else clause [whitespace/empty_if_body] [4] src/descriptor.pb.cc:11473: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11499: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11504: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11507: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11512: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11522: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11528: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11567: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11571: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11592: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11596: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11611: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11651: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] @@ -1642,15 +1591,12 @@ src/descriptor.pb.cc:11796: Do not indent within a namespace. [whitespace/inde src/descriptor.pb.cc:11797: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11815: If statement had no body and no else clause [whitespace/empty_if_body] [4] src/descriptor.pb.cc:11830: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11856: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11861: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11864: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11869: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11879: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11885: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11924: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11928: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:11949: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:11953: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:11968: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12008: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] @@ -1678,14 +1624,11 @@ src/descriptor.pb.cc:12190: Lines should be <= 80 characters long [whitespace/ src/descriptor.pb.cc:12194: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12196: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12208: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:12219: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:12224: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12227: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12249: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:12282: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:12296: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12306: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:12307: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:12322: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12326: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12355: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1714,18 +1657,15 @@ src/descriptor.pb.cc:12544: Missing space after , [whitespace/comma] [3] src/descriptor.pb.cc:12551: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12554: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12557: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:12572: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:12577: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12580: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12586: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12619: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12634: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12649: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:12712: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:12732: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12737: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12742: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:12769: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:12791: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12796: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:12801: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1868,7 +1808,6 @@ src/descriptor.pb.cc:13396: Lines should be <= 80 characters long [whitespace/ src/descriptor.pb.cc:13402: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13414: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13417: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:13430: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:13435: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13438: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13442: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -1883,12 +1822,10 @@ src/descriptor.pb.cc:13498: Lines should be <= 80 characters long [whitespace/ src/descriptor.pb.cc:13515: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13516: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13518: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:13550: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:13554: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13564: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13595: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13609: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:13610: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:13665: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13673: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13698: Redundant blank line at the end of a code block should be deleted. [whitespace/blank_line] [3] @@ -1905,12 +1842,9 @@ src/descriptor.pb.cc:13847: Do not indent within a namespace. [whitespace/inde src/descriptor.pb.cc:13848: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:13865: If statement had no body and no else clause [whitespace/empty_if_body] [4] src/descriptor.pb.cc:13880: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:13904: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:13909: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13912: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:13918: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:13952: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor.pb.cc:13968: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:13978: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14011: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] src/descriptor.pb.cc:14012: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -2037,7 +1971,6 @@ src/descriptor.pb.cc:14395: Lines should be <= 80 characters long [whitespace/ src/descriptor.pb.cc:14413: Are you taking an address of something dereferenced from a cast? Wrapping the dereferenced expression in parentheses will make the binding more obvious [readability/casting] [4] src/descriptor.pb.cc:14417: Missing space after , [whitespace/comma] [3] src/descriptor.pb.cc:14424: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:14439: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:14444: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14447: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14451: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -2046,12 +1979,10 @@ src/descriptor.pb.cc:14455: Lines should be <= 80 characters long [whitespace/ src/descriptor.pb.cc:14456: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14487: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14502: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:14535: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:14539: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14559: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14564: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14574: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:14575: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:14604: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14609: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14613: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -2071,12 +2002,9 @@ src/descriptor.pb.cc:14770: Do not indent within a namespace. [whitespace/inde src/descriptor.pb.cc:14787: If statement had no body and no else clause [whitespace/empty_if_body] [4] src/descriptor.pb.cc:14802: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14808: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:14826: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:14831: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14834: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14840: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.cc:14874: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor.pb.cc:14890: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.cc:14900: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.cc:14933: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4] src/descriptor.pb.cc:14934: Lines should be <= 80 characters long [whitespace/line_length] [2] @@ -2143,31 +2071,26 @@ src/descriptor.pb.h:88: Lines should be <= 80 characters long [whitespace/line src/descriptor.pb.h:89: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:91: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:92: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.h:97: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.h:98: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:107: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:108: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:109: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:111: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:112: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.h:117: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.h:118: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:127: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:128: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:129: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:131: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:132: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.h:137: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.h:147: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:148: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:151: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.h:157: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.h:167: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:168: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:169: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:171: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:172: Lines should be <= 80 characters long [whitespace/line_length] [2] -src/descriptor.pb.h:177: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor.pb.h:183: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:225: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor.pb.h:227: private: should be indented +1 space inside class FileDescriptorSet [whitespace/indent] [3] @@ -2984,25 +2907,6 @@ src/descriptor_unittest.cc:57: "google/protobuf/stubs/logging.h" already includ src/descriptor_unittest.cc:58: Found C system header after C++ system header. Should be: descriptor_unittest.h, c system, c++ system, other. [build/include_order] [4] src/descriptor_unittest.cc:59: Found C system header after C++ system header. Should be: descriptor_unittest.h, c system, c++ system, other. [build/include_order] [4] src/descriptor_unittest.cc:60: Found C system header after C++ system header. Should be: descriptor_unittest.h, c system, c++ system, other. [build/include_order] [4] -src/descriptor_unittest.cc:88: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:95: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:102: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:103: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:104: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:114: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:115: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:116: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:117: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:128: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:129: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:130: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:131: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:142: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:150: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:158: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:166: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:167: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:168: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor_unittest.cc:734: Extra space before ) [whitespace/parens] [2] src/descriptor_unittest.cc:735: Extra space before ) [whitespace/parens] [2] src/descriptor_unittest.cc:822: Extra space after ( in function call [whitespace/parens] [4] @@ -3165,13 +3069,9 @@ src/descriptor_unittest.cc:2325: Extra space before ( in function call [whites src/descriptor_unittest.cc:2327: Extra space after ( in function call [whitespace/parens] [4] src/descriptor_unittest.cc:2327: Extra space before ( in function call [whitespace/parens] [4] src/descriptor_unittest.cc:2383: Weird number of spaces at line-start. Are you using a 2-space indent? [whitespace/indent] [3] -src/descriptor_unittest.cc:2627: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:2698: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:2699: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor_unittest.cc:2781: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor_unittest.cc:3038: Lines should be <= 80 characters long [whitespace/line_length] [2] src/descriptor_unittest.cc:3120: Missing space after , [whitespace/comma] [3] -src/descriptor_unittest.cc:4183: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor_unittest.cc:4475: Closing ) should be moved to the previous line [whitespace/parens] [2] src/descriptor_unittest.cc:4489: Closing ) should be moved to the previous line [whitespace/parens] [2] src/descriptor_unittest.cc:4502: Closing ) should be moved to the previous line [whitespace/parens] [2] @@ -3184,7 +3084,6 @@ src/descriptor_unittest.cc:5273: Do not indent within a namespace. [whitespace src/descriptor_unittest.cc:5274: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor_unittest.cc:5276: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor_unittest.cc:5277: Do not indent within a namespace. [whitespace/indent_namespace] [4] -src/descriptor_unittest.cc:5856: Do not indent within a namespace. [whitespace/indent_namespace] [4] src/descriptor_unittest.cc:5929: Single-parameter constructors should be marked explicit. [runtime/explicit] [4] src/descriptor_unittest.cc:5968: Single-parameter constructors should be marked explicit. [runtime/explicit] [4] src/descriptor_unittest.cc:6401: Do not indent within a namespace. [whitespace/indent_namespace] [4] diff --git a/samples/protobuf-sample/src/descriptor_unittest.cc b/samples/protobuf-sample/src/descriptor_unittest.cc index f937b9e..8a32002 100644 --- a/samples/protobuf-sample/src/descriptor_unittest.cc +++ b/samples/protobuf-sample/src/descriptor_unittest.cc @@ -419,7 +419,7 @@ TEST_F(FileDescriptorTest, FindExtensionByNumber) { } TEST_F(FileDescriptorTest, BuildAgain) { - // Test that if te call BuildFile again on the same input we get the same + // Test that if the call BuildFile again on the same input we get the same // FileDescriptor back. FileDescriptorProto file; foo_file_->CopyTo(&file); @@ -431,7 +431,7 @@ TEST_F(FileDescriptorTest, BuildAgain) { } TEST_F(FileDescriptorTest, BuildAgainWithSyntax) { - // Test that if te call BuildFile again on the same input we get the same + // Test that if the call BuildFile again on the same input we get the same // FileDescriptor back even if syntax param is specified. FileDescriptorProto proto_syntax2; proto_syntax2.set_name("foo_syntax2"); @@ -2251,7 +2251,7 @@ TEST_F(MiscTest, DefaultValues) { AddField(message_proto, "empty_string", 11, label, FD::TYPE_STRING) ->set_default_value(""); - // Add a second set of fields with implicit defalut values. + // Add a second set of fields with implicit default values. AddField(message_proto, "implicit_int32" , 21, label, FD::TYPE_INT32 ); AddField(message_proto, "implicit_int64" , 22, label, FD::TYPE_INT64 ); AddField(message_proto, "implicit_uint32", 23, label, FD::TYPE_UINT32); @@ -4647,7 +4647,7 @@ TEST_F(ValidationErrorTest, RepeatedMessageOption) { } TEST_F(ValidationErrorTest, ResolveUndefinedOption) { - // The following should produce an eror that baz.bar is resolved but not + // The following should produce an error that baz.bar is resolved but not // defined. // foo.proto: // package baz diff --git a/samples/v8-sample/src/interface-descriptors.h b/samples/v8-sample/src/interface-descriptors.h index b552ec9..269cda3 100644 --- a/samples/v8-sample/src/interface-descriptors.h +++ b/samples/v8-sample/src/interface-descriptors.h @@ -180,7 +180,7 @@ class V8_EXPORT_PRIVATE CallInterfaceDescriptorData { RegList allocatable_registers_ = 0; // |registers_params_| defines registers that are used for parameter passing. - // |machine_types_| defines machine types for resulting values and incomping + // |machine_types_| defines machine types for resulting values and incoming // parameters. // Both arrays are allocated dynamically by the InterfaceDescriptor and // freed on destruction. This is because static arrays cause creation of @@ -945,7 +945,7 @@ class BinaryOpDescriptor : public CallInterfaceDescriptor { DECLARE_DESCRIPTOR(BinaryOpDescriptor, CallInterfaceDescriptor) }; -// This desciptor is shared among String.p.charAt/charCodeAt/codePointAt +// This descriptor is shared among String.p.charAt/charCodeAt/codePointAt // as they all have the same interface. class StringAtDescriptor final : public CallInterfaceDescriptor { public: diff --git a/samples/vlc-sample/simple.def b/samples/vlc-sample/simple.def index 19c9563..05de643 100644 --- a/samples/vlc-sample/simple.def +++ b/samples/vlc-sample/simple.def @@ -4,7 +4,7 @@ src/* Done processing src/libvlc.c Done processing src/libvlc.h Done processing src/missing.c -Total errors found: 602 +Total errors found: 599 src/libvlc.c:41: Found C system header after other header. Should be: libvlc.h, c system, c++ system, other. [build/include_order] [4] src/libvlc.c:47: Found C system header after other header. Should be: libvlc.h, c system, c++ system, other. [build/include_order] [4] @@ -19,7 +19,6 @@ src/libvlc.c:86: Extra space before ( in function call [whitespace/parens] [4] src/libvlc.c:86: Extra space before ) [whitespace/parens] [2] src/libvlc.c:92: Extra space after ( in function call [whitespace/parens] [4] src/libvlc.c:93: { should almost always be at the end of the previous line [whitespace/braces] [4] -src/libvlc.c:98: Using C-style cast. Use reinterpret_cast(...) instead [readability/casting] [4] src/libvlc.c:99: Extra space before ) [whitespace/parens] [2] src/libvlc.c:100: Missing space before ( in if( [whitespace/parens] [5] src/libvlc.c:103: Extra space before ( in function call [whitespace/parens] [4] @@ -74,7 +73,6 @@ src/libvlc.c:219: Extra space before ) [whitespace/parens] [2] src/libvlc.c:220: Missing space before ( in if( [whitespace/parens] [5] src/libvlc.c:221: { should almost always be at the end of the previous line [whitespace/braces] [4] src/libvlc.c:222: Extra space after ( in function call [whitespace/parens] [4] -src/libvlc.c:222: Using C-style cast. Use static_cast(...) instead [readability/casting] [4] src/libvlc.c:223: Extra space after ( in function call [whitespace/parens] [4] src/libvlc.c:223: Extra space before ) [whitespace/parens] [2] src/libvlc.c:224: Extra space after ( in function call [whitespace/parens] [4] @@ -367,7 +365,6 @@ src/libvlc.c:627: Missing space before ( in if( [whitespace/parens] [5] src/libvlc.c:629: Extra space after ( in function call [whitespace/parens] [4] src/libvlc.c:629: Extra space before ) [whitespace/parens] [2] src/libvlc.c:640: { should almost always be at the end of the previous line [whitespace/braces] [4] -src/libvlc.c:223: Add #include for fclose [build/include_what_you_use] [4] src/libvlc.h:0: No #ifndef header guard found, suggested CPP variable is: SAMPLES_VLC_SAMPLE_SRC_LIBVLC_H_ [build/header_guard] [5] src/libvlc.h:34: Extra space before ( in function call [whitespace/parens] [4] src/libvlc.h:35: Extra space before ( in function call [whitespace/parens] [4] diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index eebbf0a..0000000 --- a/setup.cfg +++ /dev/null @@ -1,10 +0,0 @@ -[aliases] -test = pytest - -[tool:pytest] -python_files = *test.py -testpaths = . -required_plugins = pytest-cov pytest-timeout -timeout = 60 -# fail if coverage is under 90% -addopts = --color=yes --cov-fail-under=90 --cov=cpplint diff --git a/setup.py b/setup.py deleted file mode 100755 index 2325a71..0000000 --- a/setup.py +++ /dev/null @@ -1,48 +0,0 @@ -#! /usr/bin/env python -from setuptools import setup -import cpplint - -# some pip versions bark on comments -def read_without_comments(filename): - with open(filename) as f: - return [line for line in f.read().splitlines() if not len(line) == 0 and not line.startswith('#')] - -test_required = read_without_comments('test-requirements') - -setup(name='cpplint', - version=cpplint.__VERSION__, - py_modules=['cpplint'], - # generate platform specific start script - entry_points={ - 'console_scripts': [ - 'cpplint = cpplint:main' - ] - }, - install_requires=[], - url='https://github.com/cpplint/cpplint', - download_url='https://github.com/cpplint/cpplint', - keywords=['lint', 'python', 'c++'], - maintainer='cpplint Developers', - classifiers=['Development Status :: 5 - Production/Stable', - 'Environment :: Console', - 'Intended Audience :: End Users/Desktop', - 'License :: Freely Distributable', - 'License :: OSI Approved :: BSD License', - 'Natural Language :: English', - 'Programming Language :: Python :: 3 :: Only', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - 'Programming Language :: Python :: 3.11', - 'Programming Language :: Python :: 3.12', - 'Programming Language :: C++', - 'Topic :: Software Development :: Quality Assurance'], - description='Automated checker to ensure C++ files follow Google\'s style guide', - long_description=open('README.rst').read(), - license='BSD-3-Clause', - tests_require=test_required, - # extras_require allow pip install .[dev] - extras_require={ - 'test': test_required, - 'dev': read_without_comments('dev-requirements') + test_required - }) diff --git a/test-requirements b/test-requirements deleted file mode 100644 index 9c9abb5..0000000 --- a/test-requirements +++ /dev/null @@ -1,8 +0,0 @@ -# requirements for testing steps -tox<5.0.0 - -pytest -pytest-cov -pytest-timeout -testfixtures -parameterized diff --git a/tox.ini b/tox.ini index d7e3e82..62d43e6 100644 --- a/tox.ini +++ b/tox.ini @@ -1,20 +1,13 @@ [tox] -envlist = py38, py39, py3.10, py311, py312, pypy3 +envlist = py38, py39, py3.10, py311, py312, py313, pypy3 skip_missing_interpreters = true -[gh-actions] -python = - 3.8: py38 - 3.9: py39 - 3.10: py310 - 3.11: py311 - 3.12: py312 - pypy3.10: pypy3 [testenv] +allowlist_externals = sh extras = dev commands = {envpython} -m pytest {posargs:} {envpython} -m pylint cpplint.py - {envpython} -m flake8 cpplint.py + sh -c 'mypy *.py'