srcanamdw/codescanner/scripts/tcclasses.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
# tcclasses.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 : T classes inheriting from C classes.
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 : T classes that are derived from C classes may have a 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    22
# complex constructor and so need to be handled differently. 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    23
# It is better to make the T class into a C class, which will make 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    24
# the code easier to maintain.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    25
#
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    26
# #################################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    27
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    28
script = CScript("tcclasses")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    29
script.iReString = r"""
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    30
	class
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    31
	\s+					# at least one whitespace char
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    32
	(\w+::)?
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    33
	(\w+)				# T class
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    34
	\s*					# optional whitespace
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    35
	:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    36
	(.*)				# save inheritance text as group 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    37
	"""
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    38
script.iFileExts = ["h", "cpp"]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    39
script.iCategory = KCategoryWrongFunctionality
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    40
script.iIgnore = KIgnoreCommentsAndQuotes
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    41
script.iSeverity = KSeverityMedium
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    42
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    43
def tcclasscompare(lines, currentline, rematch, filename):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    44
	m = rematch.search(lines[currentline])
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    45
	if m:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    46
		className = m.group(2)
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    47
		if className[0] <> "T" or (len(className) == 1) or not className[1].isupper():
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    48
			return 0
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    49
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    50
		inheritanceString = m.group(3)
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    51
		i = currentline + 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    52
		while (inheritanceString.find("{") == -1) and i < len(lines):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    53
			if (inheritanceString.find(";") <> -1):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    54
				return 0
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    55
			inheritanceString += lines[i]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    56
			i += 1	
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    57
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    58
		inheritancelist = inheritanceString.split(",")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    59
		reclass = re.compile("[\s:]*(public|protected|private)?\s*([\w:]+)")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    60
		classlist = []
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    61
		for inheritance in inheritancelist:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    62
			match = reclass.search(inheritance)
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    63
			if match:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    64
				inheritclass = match.group(2)
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    65
				colonpos = inheritclass.rfind(":")
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    66
				if (colonpos <> -1):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    67
					inheritclass = inheritclass[colonpos + 1:]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    68
				classlist.append(inheritclass)
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    69
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    70
		for classname in classlist:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    71
			if (len(classname) > 2) and classname[0] == "C" and classname[1].isupper():
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    72
				return 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    73
	return 0
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    74
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    75
script.iCompare = tcclasscompare
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    76
scanner.AddScript(script)