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 # variablenames.py

    18 #

    19 # Checks : Local variables with member/argument names.

    20 #

    21 # Reason : Local variable names should be of the form localVariable 

    22 # and not aLocalVar or iLocalVar. Badly-named variables can be 

    23 # misleading and cause maintenance and coding errors.

    24 #

    25 # #################################################################

    26 

    27 script = CScript("variablenames")

    28 script.iReString = r"""

    29 	^\s*				# start of line plus optional whitespace

    30 	[A-Z]\w*			# class name e.g. TInt, CActive

    31 	\s*[\*&\s]\s*		# optional "*" or "&" plus at least one whitespace char

    32 	[ai][A-Z]\w*\s*		# a or i variable name plus optional whitespace

    33 	[;\(=]				# ";" or "(" or "="

    34 	"""

    35 script.iFileExts = ["cpp"]

    36 script.iCategory = KCategoryCodingStandards

    37 script.iIgnore = KIgnoreCommentsAndQuotes

    38 script.iSeverity = KSeverityLow

    39 

    40 def bracecompare(lines, currentline, rematch, filename):

    41 	m = rematch.search(lines[currentline])

    42 	if m:

    43 		checkline = currentline - 1

    44 		bracecount = 1

    45 		while (bracecount > 0) and (checkline >= 0):

    46 			bracecount -= lines[checkline].count("{")

    47 			bracecount += lines[checkline].count("}")

    48 			checkline -= 1

    49 

    50 		while (bracecount == 0) and (checkline >= 0):

    51 			if (lines[checkline].upper().find("CLASS") <> -1) or (lines[checkline].upper().find("STRUCT") <> -1):

    52 				return 0

    53 			

    54 			bracecount -= lines[checkline].count("{")

    55 			bracecount += lines[checkline].count("}")

    56 			checkline -= 1

    57 

    58 		return 1

    59 	else:

    60 		return 0

    61 

    62 script.iCompare = bracecompare

    63 scanner.AddScript(script)