srcanamdw/codescanner/scripts/enummembers.py
author noe\swadi
Thu, 18 Feb 2010 12:29:02 +0530
changeset 1 22878952f6e2
permissions -rw-r--r--
Committing the CodeScanner Core tool This component has been moved from the StaticAnaApps package. BUG : 5889 (http://developer.symbian.org/webbugs/show_bug.cgi?id=5889).
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     1
# #################################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     2
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     3
# All rights reserved.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     4
# 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     5
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     6
# 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     7
# * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     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.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     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.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    10
# 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    11
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    12
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    13
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    14
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    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.#
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    16
#
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    17
# enummembers.py
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    18
#
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    19
# Checks : Badly-named enum members.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    20
#
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    21
# Reason : Badly-named enum members make the code harder to 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    22
# maintain and may cause defects.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    23
#
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    24
# #################################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    25
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    26
script = CScript("enummembers")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    27
script.iReString = r"""
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    28
			^
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    29
			\s*
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    30
			enum
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    31
			((\s+\w+)|(\s+\w+\s*::\s*\w+))?
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    32
			\s*
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    33
			({|$)
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    34
			"""
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    35
script.iFileExts = ["h", "cpp"]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    36
script.iCategory = KCategoryCodingStandards
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    37
script.iIgnore = KIgnoreCommentsAndQuotes
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    38
script.iSeverity = KSeverityLow
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    39
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    40
reMember = re.compile("^\s*(\w+)")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    41
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    42
def enummemberscompare(lines, currentline, rematch, filename):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    43
	m = rematch.search(lines[currentline])
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    44
	if m:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    45
		startline = currentline
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    46
		openbraceindex = lines[startline].find("{")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    47
		while (openbraceindex == -1) and (startline < len(lines)) and (lines[startline].find(";") == -1):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    48
			startline += 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    49
			openbraceindex = lines[startline].find("{")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    50
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    51
		if openbraceindex == -1:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    52
			return 0
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    53
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    54
		endline = currentline
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    55
		closebraceindex = lines[endline].find("}")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    56
		while (closebraceindex == -1) and (endline < len(lines)):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    57
			endline += 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    58
			closebraceindex = lines[endline].find("}")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    59
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    60
		enumcontents = ""
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    61
		if (startline == endline):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    62
			enumcontents = lines[startline][openbraceindex + 1:closebraceindex - 1]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    63
		else:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    64
			enumcontents = lines[startline][openbraceindex + 1:]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    65
			line = startline + 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    66
			while (line < len(lines)) and (line < endline):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    67
				enumcontents = enumcontents + lines[line]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    68
				line += 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    69
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    70
			enumcontents = enumcontents + lines[endline][:closebraceindex - 1]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    71
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    72
		# check contents
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    73
		members = enumcontents.split("\n\r,")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    74
		for member in members:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    75
			m2 = reMember.search(member)
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    76
			if m2 and (m2.group(1)[:1] <> "E"):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    77
				return 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    78
									
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    79
	return 0
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    80
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    81
script.iCompare = enummemberscompare
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    82
scanner.AddScript(script)