1
|
1 |
# #################################################################
|
|
2 |
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
# All rights reserved.
|
|
4 |
#
|
|
5 |
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
|
6 |
#
|
|
7 |
# * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
8 |
# * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
|
9 |
# * Neither the name of Nokia Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
10 |
#
|
|
11 |
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
|
12 |
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
|
|
13 |
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
14 |
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
15 |
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.#
|
|
16 |
#
|
|
17 |
# commentcode.py
|
|
18 |
#
|
|
19 |
# Checks : Commented-out code.
|
|
20 |
#
|
|
21 |
# Reason : Instances of code that are commented out make the code
|
|
22 |
# hard to maintain and to interpret clearly. The commented out code
|
|
23 |
# should be removed. Any requirement to rediscover old code
|
|
24 |
# should be made through source control and not by trawling through
|
|
25 |
# commented-out code.
|
|
26 |
#
|
|
27 |
# #################################################################
|
|
28 |
|
|
29 |
script = CScript("commentcode")
|
|
30 |
script.iReString = r"""
|
|
31 |
/(/|\*) # "//" or "/*"
|
|
32 |
(.*); # skip to semicolon
|
|
33 |
\s* # optional whitespace
|
|
34 |
(//.*)? # optional comment
|
|
35 |
$ # end of line
|
|
36 |
"""
|
|
37 |
script.iFileExts = ["h","cpp"]
|
|
38 |
script.iCategory = KCategoryCodeReviewGuides
|
|
39 |
script.iIgnore = KIgnoreQuotes
|
|
40 |
script.iSeverity = KSeverityLow
|
|
41 |
|
|
42 |
reDeclaration = re.compile("""
|
|
43 |
\s*
|
|
44 |
[A-Z][\w<>*&]+
|
|
45 |
\s+
|
|
46 |
\w+
|
|
47 |
\s*
|
|
48 |
""", re.VERBOSE)
|
|
49 |
|
|
50 |
def commentcodecompare(lines, currentline, rematch, filename):
|
|
51 |
m = rematch.search(lines[currentline])
|
|
52 |
if m:
|
|
53 |
if ((m.group(2)[-1:] == ")") or (m.group(2).find("=") <> -1)) or (reDeclaration.match(m.group(2))):
|
|
54 |
line = lines[currentline]
|
|
55 |
i = 0
|
|
56 |
inCommentBlock = 0
|
|
57 |
|
|
58 |
while i < len(line):
|
|
59 |
if not inCommentBlock:
|
|
60 |
if (line[i] == "/"):
|
|
61 |
if (line[i + 1] == "/"):
|
|
62 |
return 1
|
|
63 |
elif (line[i + 1] == "*"):
|
|
64 |
inCommentBlock = 1
|
|
65 |
i += 2
|
|
66 |
continue
|
|
67 |
else:
|
|
68 |
endIndex = line[i:].find("*/")
|
|
69 |
if (endIndex <> -1):
|
|
70 |
inCommentBlock = 0
|
|
71 |
if line[i:i + endIndex + 2].find(";") <> -1:
|
|
72 |
return 1
|
|
73 |
i += endIndex + 2
|
|
74 |
continue
|
|
75 |
else:
|
|
76 |
return 1
|
|
77 |
|
|
78 |
i += 1
|
|
79 |
|
|
80 |
return 0
|
|
81 |
|
|
82 |
script.iCompare = commentcodecompare
|
|
83 |
scanner.AddScript(script)
|
|
84 |
|