Skip to content

Commit 64bba05

Browse files
Trotttargos
authored andcommitted
tools: refloat 7 Node.js patches to cpplint.py
Cherry-pick 12c8b4d Original commit message: This commit is a suggestion for adding a rule for NULL usages in the code base. This will currently report a number of errors which could be ignored using // NOLINT (readability/null_usage) PR-URL: #17373 Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Refs: 12c8b4d Cherry-pick fc81e80 Original commit message: Update cpplint.py to check for inline headers when the corresponding header is already included. PR-URL: #21521 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Refs: fc81e80 Cherry-pick cbc3dd9 Original commit message: src, tools: add check for left leaning pointers This commit adds a rule to cpplint to check that pointers in the code base lean to the left and not right, and also fixes the violations reported. PR-URL: #21010 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Refs: cbc3dd9 Cherry-pick 9029981 Original commit message: tools: fix cpplint.py header rules THIS COMMIT SHOULD GO WITH THE NEXT. IT WILL FIND NEW LINT. PR-URL: #26306 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Refs: 9029981 Cherry-pick 0a25ace Original commit message: tools: move cpplint configuration to .cpplint PR-URL: #27098 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Refs: 0a25ace Cherry-pick afa9a72 Original commit message: tools: refloat update link to google styleguide for cpplint This commit updates two old links to Google's C++ styleguide which currently result in a 404 when accessed. PR-URL: #30876 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Refs: afa9a72 Cherry-pick e23bf8f Original commit message: tools,src: refloat forbid usage of v8::Persistent `v8::Persistent` comes with the surprising catch that it requires manual cleanup. `v8::Global` doesn’t, making it easier to use, and additionally provides move semantics. New code should always use `v8::Global`. PR-URL: #31018 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> PR-URL: #35569 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> PR-URL: #35719 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> PR-URL: #35866 PR-URL: #36213 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> PR-URL: #36235 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> PR-URL: #36324 Reviewed-By: Beth Griggs <bgriggs@redhat.com>
1 parent 37e6f23 commit 64bba05

File tree

1 file changed

+109
-12
lines changed

1 file changed

+109
-12
lines changed

tools/cpplint.py

+109-12
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@
295295
'build/include',
296296
'build/include_subdir',
297297
'build/include_alpha',
298+
'build/include_inline',
298299
'build/include_order',
299300
'build/include_what_you_use',
300301
'build/namespaces_headers',
@@ -310,11 +311,13 @@
310311
'readability/constructors',
311312
'readability/fn_size',
312313
'readability/inheritance',
314+
'readability/pointer_notation',
313315
'readability/multiline_comment',
314316
'readability/multiline_string',
315317
'readability/namespace',
316318
'readability/nolint',
317319
'readability/nul',
320+
'readability/null_usage',
318321
'readability/strings',
319322
'readability/todo',
320323
'readability/utf8',
@@ -334,6 +337,7 @@
334337
'runtime/string',
335338
'runtime/threadsafe_fn',
336339
'runtime/vlog',
340+
'runtime/v8_persistent',
337341
'whitespace/blank_line',
338342
'whitespace/braces',
339343
'whitespace/comma',
@@ -842,6 +846,14 @@
842846
'Missing space after ,': r's/,\([^ ]\)/, \1/g',
843847
}
844848

849+
_NULL_TOKEN_PATTERN = re.compile(r'\bNULL\b')
850+
851+
_V8_PERSISTENT_PATTERN = re.compile(r'\bv8::Persistent\b')
852+
853+
_RIGHT_LEANING_POINTER_PATTERN = re.compile(r'[^=|(,\s><);&?:}]'
854+
r'(?<!(sizeof|return))'
855+
r'\s\*[a-zA-Z_][0-9a-zA-Z_]*')
856+
845857
_regexp_compile_cache = {}
846858

847859
# {str, set(int)}: a map from error categories to sets of linenumbers
@@ -1082,10 +1094,11 @@ class _IncludeState(object):
10821094
# needs to move backwards, CheckNextIncludeOrder will raise an error.
10831095
_INITIAL_SECTION = 0
10841096
_MY_H_SECTION = 1
1085-
_C_SECTION = 2
1086-
_CPP_SECTION = 3
1087-
_OTHER_SYS_SECTION = 4
1088-
_OTHER_H_SECTION = 5
1097+
_OTHER_H_SECTION = 2
1098+
_OTHER_SYS_SECTION = 3
1099+
_C_SECTION = 4
1100+
_CPP_SECTION = 5
1101+
10891102

10901103
_TYPE_NAMES = {
10911104
_C_SYS_HEADER: 'C system header',
@@ -2520,6 +2533,21 @@ def CheckForBadCharacters(filename, lines, error):
25202533
error(filename, linenum, 'readability/nul', 5, 'Line contains NUL byte.')
25212534

25222535

2536+
def CheckInlineHeader(filename, include_state, error):
2537+
"""Logs an error if both a header and its inline variant are included."""
2538+
2539+
all_headers = dict(item for sublist in include_state.include_list
2540+
for item in sublist)
2541+
bad_headers = set('%s.h' % name[:-6] for name in all_headers.keys()
2542+
if name.endswith('-inl.h'))
2543+
bad_headers &= set(all_headers.keys())
2544+
2545+
for name in bad_headers:
2546+
err = '%s includes both %s and %s-inl.h' % (filename, name, name)
2547+
linenum = all_headers[name]
2548+
error(filename, linenum, 'build/include_inline', 5, err)
2549+
2550+
25232551
def CheckForNewlineAtEOF(filename, lines, error):
25242552
"""Logs an error if there is no newline char at the end of the file.
25252553
@@ -3543,7 +3571,7 @@ def CheckForFunctionLengths(filename, clean_lines, linenum,
35433571
"""Reports for long function bodies.
35443572
35453573
For an overview why this is done, see:
3546-
https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions
3574+
https://google.github.io/styleguide/cppguide.html#Write_Short_Functions
35473575
35483576
Uses a simplistic algorithm assuming other style guidelines
35493577
(especially spacing) are followed.
@@ -4770,6 +4798,71 @@ def CheckAltTokens(filename, clean_lines, linenum, error):
47704798
'Use operator %s instead of %s' % (
47714799
_ALT_TOKEN_REPLACEMENT[match.group(1)], match.group(1)))
47724800

4801+
def CheckNullTokens(filename, clean_lines, linenum, error):
4802+
"""Check NULL usage.
4803+
4804+
Args:
4805+
filename: The name of the current file.
4806+
clean_lines: A CleansedLines instance containing the file.
4807+
linenum: The number of the line to check.
4808+
error: The function to call with any errors found.
4809+
"""
4810+
line = clean_lines.elided[linenum]
4811+
4812+
# Avoid preprocessor lines
4813+
if Match(r'^\s*#', line):
4814+
return
4815+
4816+
if line.find('/*') >= 0 or line.find('*/') >= 0:
4817+
return
4818+
4819+
for match in _NULL_TOKEN_PATTERN.finditer(line):
4820+
error(filename, linenum, 'readability/null_usage', 2,
4821+
'Use nullptr instead of NULL')
4822+
4823+
def CheckV8PersistentTokens(filename, clean_lines, linenum, error):
4824+
"""Check v8::Persistent usage.
4825+
4826+
Args:
4827+
filename: The name of the current file.
4828+
clean_lines: A CleansedLines instance containing the file.
4829+
linenum: The number of the line to check.
4830+
error: The function to call with any errors found.
4831+
"""
4832+
line = clean_lines.elided[linenum]
4833+
4834+
# Avoid preprocessor lines
4835+
if Match(r'^\s*#', line):
4836+
return
4837+
4838+
if line.find('/*') >= 0 or line.find('*/') >= 0:
4839+
return
4840+
4841+
for match in _V8_PERSISTENT_PATTERN.finditer(line):
4842+
error(filename, linenum, 'runtime/v8_persistent', 2,
4843+
'Use v8::Global instead of v8::Persistent')
4844+
4845+
def CheckLeftLeaningPointer(filename, clean_lines, linenum, error):
4846+
"""Check for left-leaning pointer placement.
4847+
4848+
Args:
4849+
filename: The name of the current file.
4850+
clean_lines: A CleansedLines instance containing the file.
4851+
linenum: The number of the line to check.
4852+
error: The function to call with any errors found.
4853+
"""
4854+
line = clean_lines.elided[linenum]
4855+
4856+
# Avoid preprocessor lines
4857+
if Match(r'^\s*#', line):
4858+
return
4859+
4860+
if '/*' in line or '*/' in line:
4861+
return
4862+
4863+
for match in _RIGHT_LEANING_POINTER_PATTERN.finditer(line):
4864+
error(filename, linenum, 'readability/pointer_notation', 2,
4865+
'Use left leaning pointer instead of right leaning')
47734866

47744867
def GetLineWidth(line):
47754868
"""Determines the width of the line in column positions.
@@ -4924,6 +5017,9 @@ def CheckStyle(filename, clean_lines, linenum, file_extension, nesting_state,
49245017
CheckSpacingForFunctionCall(filename, clean_lines, linenum, error)
49255018
CheckCheck(filename, clean_lines, linenum, error)
49265019
CheckAltTokens(filename, clean_lines, linenum, error)
5020+
CheckNullTokens(filename, clean_lines, linenum, error)
5021+
CheckV8PersistentTokens(filename, clean_lines, linenum, error)
5022+
CheckLeftLeaningPointer(filename, clean_lines, linenum, error)
49275023
classinfo = nesting_state.InnermostClass()
49285024
if classinfo:
49295025
CheckSectionSpacing(filename, clean_lines, classinfo, linenum, error)
@@ -5109,11 +5205,10 @@ def CheckIncludeLine(filename, clean_lines, linenum, include_state, error):
51095205
include_state.include_list[-1].append((include, linenum))
51105206

51115207
# We want to ensure that headers appear in the right order:
5112-
# 1) for foo.cc, foo.h (preferred location)
5113-
# 2) c system files
5114-
# 3) cpp system files
5115-
# 4) for foo.cc, foo.h (deprecated location)
5116-
# 5) other google headers
5208+
# 1) for foo.cc, foo.h
5209+
# 2) other project headers
5210+
# 3) c system files
5211+
# 4) cpp system files
51175212
#
51185213
# We classify each include statement as one of those 5 types
51195214
# using a number of techniques. The include_state object keeps
@@ -5376,7 +5471,7 @@ def CheckLanguage(filename, clean_lines, linenum, file_extension,
53765471
and line[-1] != '\\'):
53775472
error(filename, linenum, 'build/namespaces_headers', 4,
53785473
'Do not use unnamed namespaces in header files. See '
5379-
'https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces'
5474+
'https://google.github.io/styleguide/cppguide.html#Namespaces'
53805475
' for more information.')
53815476

53825477

@@ -6498,6 +6593,8 @@ def ProcessFileData(filename, file_extension, lines, error,
64986593

64996594
CheckForNewlineAtEOF(filename, lines, error)
65006595

6596+
CheckInlineHeader(filename, include_state, error)
6597+
65016598
def ProcessConfigOverrides(filename):
65026599
""" Loads the configuration files and processes the config overrides.
65036600
@@ -6516,7 +6613,7 @@ def ProcessConfigOverrides(filename):
65166613
if not base_name:
65176614
break # Reached the root directory.
65186615

6519-
cfg_file = os.path.join(abs_path, "CPPLINT.cfg")
6616+
cfg_file = os.path.join(abs_path, ".cpplint")
65206617
abs_filename = abs_path
65216618
if not os.path.isfile(cfg_file):
65226619
continue

0 commit comments

Comments
 (0)