|
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 # enummembers.py |
|
18 # |
|
19 # Checks : Badly-named enum members. |
|
20 # |
|
21 # Reason : Badly-named enum members make the code harder to |
|
22 # maintain and may cause defects. |
|
23 # |
|
24 # ################################################################# |
|
25 |
|
26 script = CScript("enummembers") |
|
27 script.iReString = r""" |
|
28 ^ |
|
29 \s* |
|
30 enum |
|
31 ((\s+\w+)|(\s+\w+\s*::\s*\w+))? |
|
32 \s* |
|
33 ({|$) |
|
34 """ |
|
35 script.iFileExts = ["h", "cpp"] |
|
36 script.iCategory = KCategoryCodingStandards |
|
37 script.iIgnore = KIgnoreCommentsAndQuotes |
|
38 script.iSeverity = KSeverityLow |
|
39 |
|
40 reMember = re.compile("^\s*(\w+)") |
|
41 |
|
42 def enummemberscompare(lines, currentline, rematch, filename): |
|
43 m = rematch.search(lines[currentline]) |
|
44 if m: |
|
45 startline = currentline |
|
46 openbraceindex = lines[startline].find("{") |
|
47 while (openbraceindex == -1) and (startline < len(lines)) and (lines[startline].find(";") == -1): |
|
48 startline += 1 |
|
49 openbraceindex = lines[startline].find("{") |
|
50 |
|
51 if openbraceindex == -1: |
|
52 return 0 |
|
53 |
|
54 endline = currentline |
|
55 closebraceindex = lines[endline].find("}") |
|
56 while (closebraceindex == -1) and (endline < len(lines)): |
|
57 endline += 1 |
|
58 closebraceindex = lines[endline].find("}") |
|
59 |
|
60 enumcontents = "" |
|
61 if (startline == endline): |
|
62 enumcontents = lines[startline][openbraceindex + 1:closebraceindex - 1] |
|
63 else: |
|
64 enumcontents = lines[startline][openbraceindex + 1:] |
|
65 line = startline + 1 |
|
66 while (line < len(lines)) and (line < endline): |
|
67 enumcontents = enumcontents + lines[line] |
|
68 line += 1 |
|
69 |
|
70 enumcontents = enumcontents + lines[endline][:closebraceindex - 1] |
|
71 |
|
72 # check contents |
|
73 members = enumcontents.split("\n\r,") |
|
74 for member in members: |
|
75 m2 = reMember.search(member) |
|
76 if m2 and (m2.group(1)[:1] <> "E"): |
|
77 return 1 |
|
78 |
|
79 return 0 |
|
80 |
|
81 script.iCompare = enummemberscompare |
|
82 scanner.AddScript(script) |