srcanamdw/codescanner/scripts/resourcenotoncleanupstack.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 # resourcenotoncleanupstack.py
       
    18 #
       
    19 # Checks : Neglected to put resource objects on cleanup stack.
       
    20 #
       
    21 # Reason : If a stack-based resource object is not put on the 
       
    22 # cleanup stack with CleanupResetAndDestroyPushL() or 
       
    23 # CleanupClosePushL(), and a leaving function or ELeave is called, 
       
    24 # a memory leak occurs. CodeScanner occasionally gives false 
       
    25 # positives for this issue. Individual cases should be investigated.
       
    26 #
       
    27 # #################################################################
       
    28 
       
    29 script = CScript("resourcenotoncleanupstack")
       
    30 script.iReString = r"""
       
    31 	^\s*					# start of line plus optional whitespace
       
    32 	R\w+					# resource type
       
    33 	\s*						# optional whitespace
       
    34 	(<.*>)?					# optional class in angle brackets
       
    35 	\s+						# whitespace
       
    36 	(\w+)					# object name
       
    37 	\s*						# optional whitespace
       
    38 	;
       
    39 	"""
       
    40 script.iFileExts = ["cpp"]
       
    41 script.iCategory = KCategoryCodeReviewGuides
       
    42 script.iIgnore = KIgnoreCommentsAndQuotes
       
    43 script.iSeverity = KSeverityLow
       
    44 
       
    45 cleanupFunction = re.compile("""
       
    46 	\s*						# optional whitespace
       
    47 	(CleanupClosePushL|CleanupResetAndDestroyPushL)
       
    48 	\s*						# optional whitespace
       
    49 	\(
       
    50 	\s*						# optional whitespace
       
    51 	(\w+)					# object name
       
    52 	\s*						# optional whitespace
       
    53 	\)
       
    54 	\s*						# optional whitespace
       
    55 	;
       
    56 	""", re.VERBOSE)
       
    57 
       
    58 def resourcecompare(lines, currentline, rematch, filename):
       
    59     m = rematch.search(lines[currentline])
       
    60     if m:
       
    61     	objectName = m.group(2)
       
    62     	bracketdepth = GetBracketDepth(lines, currentline)
       
    63     	i = currentline
       
    64 
       
    65     	# search for CleanupClosePushL() or CleanupResetAndDestroyPushL() 
       
    66     	# with the resource object at parameter
       
    67     	while (i < len(lines)):
       
    68     		nextLine = lines[i]
       
    69     		
       
    70     		match = cleanupFunction.search(nextLine)
       
    71     		if (match):
       
    72     			if objectName == match.group(2):
       
    73     				return 0
       
    74 
       
    75     		if (nextLine.find('{') >= 0):
       
    76     			bracketdepth = bracketdepth + 1
       
    77     		if (nextLine.find('}') >= 0):
       
    78     			bracketdepth = bracketdepth - 1
       
    79     			if (bracketdepth == 0):
       
    80     				return 1
       
    81 
       
    82     		i += 1
       
    83 
       
    84 	return 0
       
    85 
       
    86 script.iCompare = resourcecompare
       
    87 scanner.AddScript(script)