|
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 # missingcclass.py |
|
18 # |
|
19 # Checks : C class not inheriting from another C class. |
|
20 # |
|
21 # Reason : All C classes should inherit from another C class to |
|
22 # ensure that all data members are zeroed. |
|
23 # |
|
24 # ################################################################# |
|
25 |
|
26 script = CScript("missingcclass") |
|
27 script.iReString = r""" |
|
28 ^\s* |
|
29 class |
|
30 \s+ |
|
31 (\w+::)? |
|
32 (\w+) |
|
33 \s* |
|
34 (.*)""" |
|
35 script.iFileExts = ["h", "cpp"] |
|
36 script.iCategory = KCategoryCanPanic |
|
37 script.iIgnore = KIgnoreCommentsAndQuotes |
|
38 script.iSeverity = KSeverityHigh |
|
39 |
|
40 reCClassIgnoreStr = "" |
|
41 scriptNode = script.ScriptConfig() |
|
42 if (scriptNode <> None): |
|
43 for wordNode in scriptNode.getElementsByTagName("cclassIgnoreRE"): |
|
44 reCClassIgnoreStr = wordNode.firstChild.nodeValue |
|
45 print "Note: ignoring the following classes when checking for C class not inheriting from another C class: " + reCClassIgnoreStr |
|
46 break |
|
47 if len(reCClassIgnoreStr) > 0: |
|
48 reCClassIgnores = re.compile(reCClassIgnoreStr, re.IGNORECASE) |
|
49 else : |
|
50 reCClassIgnores = None |
|
51 |
|
52 def missingcclasscompare(lines, currentline, rematch, filename): |
|
53 m = rematch.search(lines[currentline]) |
|
54 if m: |
|
55 className = m.group(2) |
|
56 if className[0] <> "C" or (len(className) == 1) or not className[1].isupper(): |
|
57 return 0 |
|
58 |
|
59 #ignore classes on the ignored list |
|
60 if reCClassIgnores: |
|
61 if reCClassIgnores.search(className): |
|
62 return 0 |
|
63 |
|
64 inheritanceString = m.group(3) |
|
65 i = currentline + 1 |
|
66 while (inheritanceString.find("{") == -1) and i < len(lines): |
|
67 if (inheritanceString.find(";") <> -1): |
|
68 return 0 |
|
69 inheritanceString += lines[i] |
|
70 i += 1 |
|
71 |
|
72 inheritancelist = inheritanceString.split(",") |
|
73 |
|
74 reclass = re.compile("[\s:]*(public|protected|private)?\s*([\w:]+)") |
|
75 classlist = [] |
|
76 for inheritance in inheritancelist: |
|
77 match = reclass.search(inheritance) |
|
78 if match: |
|
79 inheritclass = match.group(2) |
|
80 colonpos = inheritclass.rfind(":") |
|
81 if (colonpos <> -1): |
|
82 inheritclass = inheritclass[colonpos + 1:] |
|
83 classlist.append(inheritclass) |
|
84 |
|
85 ccount = 0 |
|
86 for classname in classlist: |
|
87 if (len(classname) > 2) and classname[0] == "C" and classname[1].isupper(): |
|
88 ccount += 1 |
|
89 |
|
90 if ccount == 0: |
|
91 return 1 |
|
92 else: |
|
93 return 0 |
|
94 else: |
|
95 return 0 |
|
96 |
|
97 script.iCompare = missingcclasscompare |
|
98 scanner.AddScript(script) |