srcanamdw/codescanner/scripts/constnames.py
changeset 1 22878952f6e2
equal deleted inserted replaced
0:509e4801c378 1:22878952f6e2
       
     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 # constnames.py
       
    18 #
       
    19 # Checks : Badly-named constants.
       
    20 #
       
    21 # Reason : Badly-named constant will make the source code harder to 
       
    22 # maintain and make defects more likely.
       
    23 #
       
    24 # #################################################################
       
    25 
       
    26 script = CScript("constnames")
       
    27 script.iReString = r"""
       
    28 	^
       
    29 	\s*
       
    30 	const
       
    31 	\s+
       
    32 	\w+		# type
       
    33 	\s*
       
    34 	[\*&]?	# reference or pointer
       
    35 	\s*
       
    36 	[^K\s]	# name initial letter
       
    37 	\w+		# name
       
    38 	\s*
       
    39 	=
       
    40 	[^()]*
       
    41 	;
       
    42 	"""
       
    43 script.iFileExts = ["h", "cpp"]
       
    44 script.iCategory = KCategoryCodingStandards
       
    45 script.iIgnore = KIgnoreCommentsAndQuotes
       
    46 script.iSeverity = KSeverityLow
       
    47 
       
    48 def constnamescompare(lines, currentline, rematch, filename):
       
    49 	if (scanner.iCurrentMethodName == ""):
       
    50 		if rematch.search(lines[currentline]):
       
    51 			return 1
       
    52 
       
    53 	return 0
       
    54 
       
    55 script.iCompare = constnamescompare
       
    56 scanner.AddScript(script)