Python3000

.gitignore

@@ -0,0 +1,5 @@
+.svn
+__pycache__
+*.pyc
+cpplint.egg-info
+build

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+python:
+  - "3.4"
+  - "3.3"
+  - "3.2"
+  - "2.7"
+  - "2.6"
+# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
+# install: "sudo apt-get install"
+# command to run tests, e.g. python setup.py test
+script: python cpplint_unittest.py

README.md

@@ -0,0 +1,85 @@
+# cpplint - static code checker for C++
+
+[![Build Status](https://travis-ci.org/tkruse/cpplint.svg)](https://travis-ci.org/tkruse/cpplint)
+
+This project provides cpplint as a pypi package
+(https://pypi.python.org/pypi/cpplint). It follows the code maintained as SVN
+repository by google employees at
+http://google-styleguide.googlecode.com/svn/trunk/cpplint.
+
+
+It is possible that this repo lags behind the SVN repo, if you notice this,
+feel free to open an issue asking for an update.
+The ```svn``` branch should be a 1-to-1 copy of the history in SVN.
+The ```pypi`` branch contains all local patches on top of svn.
+This branch will be rebased frequently.
+
+To install from pypi:
+
+```
+$ pip install cpplint
+```
+
+The run by calling
+```
+$ cpplint [OPTIONS] files
+```
+
+For more info, see [Original README](README)
+
+## Customizations
+
+The modifications in this branch are minor fixes and cosmetic changes:
+
+- more default extensions
+- python 3k compatibility
+- minor fixes around default file extensions
+- continuous integration on travis
+
+## Maintaining
+
+The strategy here is to have 3 branches: master, svn and pypi.
+In the svn branch, only commits from the original svn repo are added.
+The Pypi contains patches to upstream, that are intended to be rebased often.
+The master branch will be update to the latest pypi state (Either by tedious
+manual merging or by hard resets).
+
+Prerequisites: Install git-svn.
+To fetch the latest changes from SVN upstream after cloning:
+
+```
+# once after cloning
+git svn init http://google-styleguide.googlecode.com/svn/trunk/cpplint/
+# this creates a remote git-svn and get all new commits
+git svn fetch
+# update svn branch
+git checkout master
+git branch -D svn
+git checkout git-svn -b svn
+# this build will fail in travis, ignore that
+git push origin -f svn
+# rebase local patches
+git checkout pypi
+git rebase svn
+# run tests, fix if fail
+python cpplint_unittest.py
+# when all good, push pypi to let travis have a go with all python versions
+git push origin -f pypi
+# check travis is happy (github badge on pypi branch)
+git checkout master
+# evil hard push, maintainer must be careful, or do a tedious merge instead
+git reset --hard pypi
+git push origin -f master
+```
+
+Then:
+- Wait and see if travis likes the changes
+- if necessary fix errors, like python3 compatibility (see earlier commit on common fixes)
+- Version Bump in setup.py, update changelog
+- Create new release in pypi:
+ - ensure ~/.pypirc is valid
+ - run:
+```
+python setup.py sdist register -r pypi
+python setup.py sdist bdist upload -r pypi
+ ```

changelog.rst

@@ -0,0 +1,32 @@
+Changelog
+---------
+
+0.0.5
+-----
+
+Maintenance release, undoes earlier project folder structure changes
+to remain as true to upstream as possible.
+
+0.0.4
+-----
+
+- Merged with upstream revision r141 (2014-12-04)
+This includes many new checks, see commit messages for details.
+This also reverts some renaming of files, to stay close to the original project.
+
+
+0.0.3
+-----
+
+- py3k compatibility
+
+0.0.2
+-----
+
+- fixed and extended allowed extensions
+
+0.0.1
+-----
+
+- import from googlecode, added setup.py
+- imported revision r83 (2012-05-11)

cpplint.py

@@ -57,6 +57,9 @@
 _valid_extensions = set(['c', 'cc', 'cpp', 'cxx', 'c++', 'h', 'hpp', 'hxx',
     'h++'])
 
+Py3k = (sys.version_info[0] == 3)
+"""A boolean to check if we are running Python3000"""
+
 _USAGE = """
 Syntax: cpplint.py [--verbose=#] [--output=vs7] [--filter=-x,+y,...]
                    [--counting=total|toplevel|detailed] [--root=subdir]
@@ -502,6 +505,19 @@
 # This is set by --linelength flag.
 _line_length = 80
 
+try:
+    xrange(0,1)
+except NameError:
+    xrange = range
+try:
+    unicode
+except NameError:
+    basestring = unicode = str
+try:
+    long
+except NameError:
+    long = int
+
 def ParseNolintSuppressions(filename, raw_line, linenum, error):
   """Updates the global list of error-suppressions.
 
@@ -841,7 +857,11 @@ def IncrementErrorCount(self, category):
 
   def PrintErrorCounts(self):
     """Print a summary of errors by category, and the total."""
-    for category, count in self.errors_by_category.iteritems():
+    try:
+        items = self.errors_by_category.iteritems()
+    except AttributeError:
+        items = self.errors_by_category.items()
+    for category, count in items:
       sys.stderr.write('Category \'%s\' errors found: %d\n' %
                        (category, count))
     sys.stderr.write('Total errors found: %d\n' % self.error_count)
@@ -1816,7 +1836,7 @@ def CheckForBadCharacters(filename, lines, error):
     error: The function to call with any errors found.
   """
   for linenum, line in enumerate(lines):
-    if u'\ufffd' in line:
+    if unicode(b'\xef\xbf\xbd', 'utf-8') in line:
       error(filename, linenum, 'readability/utf8', 5,
             'Line contains invalid UTF-8 (or Unicode replacement character).')
     if '\0' in line:
@@ -4678,7 +4698,7 @@ def CheckIncludeLine(filename, clean_lines, linenum, include_state, error):
 
 
 def _GetTextInside(text, start_pattern):
-  r"""Retrieves all the text between matching open and close parentheses.
+  """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
@@ -4702,7 +4722,10 @@ def _GetTextInside(text, start_pattern):
 
   # Give opening punctuations to get the matching close-punctuations.
   matching_punctuation = {'(': ')', '{': '}', '[': ']'}
-  closing_punctuation = set(matching_punctuation.itervalues())
+  try:
+    closing_punctuation = set(matching_punctuation.values())
+  except AttributeError:
+    closing_punctuation = set(matching_punctuation.itervalues())
 
   # Find the position to start extracting text.
   match = re.search(start_pattern, text, re.M)
@@ -5672,7 +5695,7 @@ def CheckForIncludeWhatYouUse(filename, clean_lines, include_state, error,
 
   # include_dict is modified during iteration, so we iterate over a copy of
   # the keys.
-  header_keys = include_dict.keys()
+  header_keys = list(include_dict.keys())
   for header in header_keys:
     (same_module, common_path) = FilesBelongToSameModule(abs_filename, header)
     fullpath = common_path + header
@@ -6307,10 +6330,11 @@ def main():
 
   # 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.StreamReaderWriter(sys.stderr,
-                                         codecs.getreader('utf8'),
-                                         codecs.getwriter('utf8'),
-                                         'replace')
+  if not Py3k:
+      sys.stderr = codecs.StreamReaderWriter(sys.stderr,
+                                             codecs.getreader('utf8'),
+                                             codecs.getwriter('utf8'),
+                                             'replace')
 
   _cpplint_state.ResetErrorCounts()
   for filename in filenames:
@@ -6322,3 +6346,4 @@ def main():
 
 if __name__ == '__main__':
   main()
+

cpplint_unittest.py

@@ -39,9 +39,30 @@
 import re
 import sys
 import unittest
+import tempfile
+import shutil
 
 import cpplint
+import sys
 
+try:
+    xrange(0,1)
+except NameError:
+    xrange = range
+try:
+    unicode
+except NameError:
+    basestring = unicode = str
+try:
+    long
+except NameError:
+    long = int
+Py3k = (sys.version_info[0] == 3)
+if Py3k:
+  chrstr = bytes
+else:
+  def chrstr(l):
+    return ''.join([chr(x) for x in l])
 
 # This class works as an error collector and replaces cpplint.Error
 # function for the unit tests.  We also verify each category we see
@@ -305,8 +326,11 @@ def testFalsePositivesNoError(self):
   # Test get line width.
   def testGetLineWidth(self):
     self.assertEquals(0, cpplint.GetLineWidth(''))
-    self.assertEquals(10, cpplint.GetLineWidth(u'x' * 10))
-    self.assertEquals(16, cpplint.GetLineWidth(u'都|道|府|県|支庁'))
+    self.assertEquals(10, cpplint.GetLineWidth(unicode('x') * 10))
+    try:
+      self.assertEquals(16, cpplint.GetLineWidth('都|道|府|県|支庁'.decode('utf-8')))
+    except AttributeError:
+      self.assertEquals(16, cpplint.GetLineWidth('都|道|府|県|支庁'))
 
   def testGetTextInside(self):
     self.assertEquals('', cpplint._GetTextInside('fun()', r'fun\('))
@@ -2928,7 +2952,7 @@ def DoTest(self, raw_bytes, has_invalid_utf8):
       error_collector = ErrorCollector(self.assert_)
       cpplint.ProcessFileData(
           'foo.cc', 'cc',
-          unicode(raw_bytes, 'utf8', 'replace').split('\n'),
+          raw_bytes.decode('utf-8', 'replace').split('\n'),
           error_collector)
       # The warning appears only once.
       self.assertEquals(
@@ -2938,12 +2962,19 @@ def DoTest(self, raw_bytes, has_invalid_utf8):
               ' (or Unicode replacement character).'
               '  [readability/utf8] [5]'))
 
-    DoTest(self, 'Hello world\n', False)
-    DoTest(self, '\xe9\x8e\xbd\n', False)
-    DoTest(self, '\xe9x\x8e\xbd\n', True)
+    # For Python 2/3 compatibility we must use the chrstr shim to create the
+    # the byte strings because Python3 automatically trys to encode it to
+    # UTF-8. Normal strings must be encoded to ascii to make the DoTest
+    # function correctly work on Python3
+    DoTest(self, 'Hello world\n'.encode('ascii'), False)
+    #                  '\xe9 \x8e \xbd  \n'
+    DoTest(self, chrstr([233, 142, 189, 10]), False)
+    #                  '\xe9   x  \x8e \xbd  \n'
+    DoTest(self, chrstr([233, 120, 142, 189, 10]), True)
     # This is the encoding of the replacement character itself (which
     # you can see by evaluating codecs.getencoder('utf8')(u'\ufffd')).
-    DoTest(self, '\xef\xbf\xbd\n', True)
+    #                  '\xef \xbf \xbd  \n'
+    DoTest(self, chrstr([239, 191, 189, 10]), True)
 
   def testBadCharacters(self):
     # Test for NUL bytes only
@@ -2961,7 +2992,7 @@ def testBadCharacters(self):
     cpplint.ProcessFileData(
         'nul_utf8.cc', 'cc',
         ['// Copyright 2014 Your Company.',
-         unicode('\xe9x\0', 'utf8', 'replace'), ''],
+         chrstr([233, 120, 0]).decode('utf-8', 'replace'), ''],
         error_collector)
     self.assertEquals(
         error_collector.Results(),
@@ -4073,27 +4104,34 @@ def testBuildHeaderGuard(self):
           error_collector.ResultList())
 
   def testBuildHeaderGuardWithRoot(self):
-    file_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),
-                             'cpplint_test_header.h')
-    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.assertEquals('CPPLINT_CPPLINT_TEST_HEADER_H_',
-                      cpplint.GetHeaderGuardCPPVariable(file_path))
-    cpplint._root = 'cpplint'
-    self.assertEquals('CPPLINT_TEST_HEADER_H_',
-                      cpplint.GetHeaderGuardCPPVariable(file_path))
-    # --root flag is ignored if an non-existent directory is specified.
-    cpplint._root = 'NON_EXISTENT_DIR'
-    self.assertEquals('CPPLINT_CPPLINT_TEST_HEADER_H_',
-                      cpplint.GetHeaderGuardCPPVariable(file_path))
+    temp_directory = tempfile.mkdtemp()
+    try:
+        os.makedirs(os.path.join(temp_directory, ".svn"))
+        header_directory = os.path.join(temp_directory, "cpplint")
+        os.makedirs(header_directory)
+        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.assertEquals('CPPLINT_CPPLINT_TEST_HEADER_H_',
+                          cpplint.GetHeaderGuardCPPVariable(file_path))
+        cpplint._root = 'cpplint'
+        self.assertEquals('CPPLINT_TEST_HEADER_H_',
+                          cpplint.GetHeaderGuardCPPVariable(file_path))
+        # --root flag is ignored if an non-existent directory is specified.
+        cpplint._root = 'NON_EXISTENT_DIR'
+        self.assertEquals('CPPLINT_CPPLINT_TEST_HEADER_H_',
+                          cpplint.GetHeaderGuardCPPVariable(file_path))
+    finally:
+        shutil.rmtree(temp_directory)
 
   def testBuildInclude(self):
     # Test that include statements have slashes in them.

setup.py

@@ -0,0 +1,31 @@
+from setuptools import setup
+
+
+setup(name='cpplint',
+      version='0.0.5',
+      py_modules=['cpplint'],
+      # generate platform specific start script
+      entry_points={
+        'console_scripts': [
+            'cpplint = cpplint:main'
+        ]
+      },
+      install_requires=[],
+      url="http://en.wikipedia.org/wiki/Cpplint",
+      download_url="https://github.com/tkruse/cpplint",
+      keywords=["lint", "python", "c++"],
+      maintainer = 'Thibault Kruse',
+      maintainer_email = 'see_github@nospam.com',
+      classifiers=["Programming Language :: Python",
+                   "Programming Language :: Python :: 2",
+                   "Programming Language :: Python :: 3",
+                   "Programming Language :: C++",
+                   "License :: Freely Distributable"],
+      description="This is automated checker to make sure a C++ file follows Google's C++ style guide",
+      long_description="""This is automated checker to make sure a C++ file follows Google's C++ style
+guide (http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml). As it
+heavily relies on regular expressions, cpplint.py won't catch all violations of
+the style guide and will very occasionally report a false positive. There is a
+list of things we currently don't handle very well at the top of cpplint.py,
+and we welcome patches to improve it.
+Original SVN download URL: http://google-styleguide.googlecode.com/svn/trunk/cpplint/""")