|
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 # pointertoarrays.py |
|
18 # |
|
19 # Checks : Pointer to arrays as members of a C class. |
|
20 # |
|
21 # Reason : In C classes, there is no need to use pointers to arrays |
|
22 # as data members. Instead, use the arrays themselves. Using |
|
23 # pointers leads to obscure notation like \"(*array)[n]\" for the |
|
24 # more usual \"array[n]\". It also makes it necessary to explicitly |
|
25 # delete the arrays in the destructor. Using the arrays themselves |
|
26 # also simplifies notation, reduces indirection, and reduces heap |
|
27 # fragmentation. |
|
28 # |
|
29 # ################################################################# |
|
30 |
|
31 script = CScript("pointertoarrays") |
|
32 script.iReString = r""" |
|
33 ^\s* # start of line plus optional whitespace |
|
34 [CR]\w*Array\w* # class name e.g. RPointerArray |
|
35 (|<\w*>) # optional "<Xxxx>" part |
|
36 \s*\* # "*" (with optional whitespace) |
|
37 \s*i[A-Z] # optional whitespace followed by the starting i of the member variable and then a capital letter |
|
38 """ |
|
39 script.iFileExts = ["h", "cpp"] |
|
40 script.iCategory = KCategoryPerformance |
|
41 script.iIgnore = KIgnoreCommentsAndQuotes |
|
42 script.iSeverity = KSeverityMedium |
|
43 |
|
44 def pointerToArraysCompare(lines, currentline, rematch, filename): |
|
45 m = rematch.search(lines[currentline]) |
|
46 if m: |
|
47 if (len(scanner.iCurrentClassName) > 1) and (scanner.iCurrentClassName[0]=="C"): |
|
48 return 1 # only a problem with C classes |
|
49 else: |
|
50 return 0 |
|
51 else: |
|
52 return 0 |
|
53 |
|
54 script.iCompare = pointerToArraysCompare |
|
55 script.iDisplayMethodName = 0 |
|
56 script.iDisplayClassName = 1 |
|
57 |
|
58 scanner.AddScript(script) |