srcanamdw/codescanner/scripts/open.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 # open.py
       
    18 #
       
    19 # Checks : Ignoring Open() return value.
       
    20 #
       
    21 # Reason : Ignoring the return value from Open() functions 
       
    22 # (due to OOM, etc.) means that when the resource is accessed next, 
       
    23 # a panic will result.
       
    24 #
       
    25 # #################################################################
       
    26 
       
    27 script = CScript("open")
       
    28 script.iReString = "^\s*(\w+)(\.|->)Open\s*\("
       
    29 script.iFileExts = ["cpp"]
       
    30 script.iCategory = KCategoryCanPanic
       
    31 script.iIgnore = KIgnoreCommentsAndQuotes
       
    32 script.iSeverity = KSeverityHigh
       
    33 
       
    34 reOpenIgnoreStr = ""
       
    35 scriptNode = script.ScriptConfig()
       
    36 if (scriptNode <> None):
       
    37 	for wordNode in scriptNode.getElementsByTagName("openIgnoreRE"):
       
    38 		reOpenIgnoreStr = wordNode.firstChild.nodeValue
       
    39 		print "Note: ignoring the following objects and classes when checking for open() return value: " + reOpenIgnoreStr
       
    40 		break
       
    41 if len(reOpenIgnoreStr) > 0:
       
    42 	reOpenIgnores = re.compile(reOpenIgnoreStr, re.IGNORECASE)
       
    43 else :
       
    44 	reOpenIgnores = None
       
    45 
       
    46 reOpenAssignStr = "=\s+$"
       
    47 reOpenAssign = re.compile(reOpenAssignStr, re.IGNORECASE)
       
    48 
       
    49 def streamcompare(lines, currentline, rematch, filename):
       
    50 	m = rematch.search(lines[currentline])
       
    51 	if m:
       
    52 		# ignore objects with the word "tream" in object name or object type
       
    53 		objectName = m.group(1)
       
    54 		if (objectName.find("tream") <> -1):
       
    55 			return 0
       
    56 		objectType = GetLocalVariableType(lines, currentline, objectName)
       
    57 		if (objectType.find("tream") <> -1):
       
    58 			return 0
       
    59 
       
    60 		#ignore objects with either object name or object type on the ignored list
       
    61 		if reOpenIgnores:
       
    62 			if reOpenIgnores.search(objectName):
       
    63 				return 0
       
    64 			if reOpenIgnores.search(objectType):
       
    65 				return 0
       
    66 
       
    67 		# look for handler of Open() return value on a different line
       
    68 		i = currentline - 1
       
    69 		if (i > 0) and (i >= scanner.iCurrentMethodStart):
       
    70 			line = lines[i]
       
    71 			bracketCount = line.count("(") - line.count(")")
       
    72 			if (bracketCount > 0):
       
    73 				return 0
       
    74 			r = reOpenAssign.search(line)
       
    75 			if r:
       
    76 				return 0
       
    77 		return 1
       
    78 	else:
       
    79 		return 0
       
    80 
       
    81 script.iCompare = streamcompare
       
    82 scanner.AddScript(script)