srcanamdw/codescanner/scripts/ctltargettype.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 # ctltargettype.py
       
    18 #
       
    19 # Checks : Use of targettype ctl.
       
    20 #
       
    21 # Reason : The ctl target type should not be used. Instead, use DLL 
       
    22 # and explicitly refer to the Control Panel's DEF file. 
       
    23 # Note: Code that causes this issue only needs attention if it is 
       
    24 # found in code developed for Nokia Series 90 code that has extra 
       
    25 # exports for resetting the Control Panel item's data.
       
    26 #
       
    27 # #################################################################
       
    28 
       
    29 script = CScript("ctltargettype")
       
    30 script.iReString = r"""
       
    31 	^\s*
       
    32 	[Tt][Aa][Rr][Gg][Ee][Tt][Tt][Yy][Pp][Ee]
       
    33 	\s+
       
    34 	"""
       
    35 script.iFileExts = ["mmp"]
       
    36 script.iCategory = KCategoryWrongFunctionality
       
    37 script.iIgnore = KIgnoreCommentsAndQuotes
       
    38 script.iSeverity = KSeverityMedium
       
    39 
       
    40 reTargetPath = re.compile("""
       
    41 	^\s*
       
    42 	[Tt][Aa][Rr][Gg][Ee][Tt][Pp][Aa][Tt][Hh]
       
    43 	\s+
       
    44 	""", re.VERBOSE)
       
    45 
       
    46 reDefFile = re.compile("""
       
    47 	^\s*
       
    48 	[Dd][Ee][Ff][Ff][Ii][Ll][Ee]
       
    49 	""", re.VERBOSE)
       
    50 	
       
    51 def ctltargettypecompare(lines, currentline, rematch, filename):
       
    52 	m = rematch.search(lines[currentline])
       
    53 	if m:
       
    54 		if lines[currentline].upper().find("CTL") <> -1:
       
    55 			return 1
       
    56 
       
    57 		if lines[currentline].upper().find("DLL") <> -1:
       
    58 			foundDefFile = 0
       
    59 			foundSystemControls = 0
       
    60 
       
    61 			for line in lines:
       
    62 				if reTargetPath.search(line):
       
    63 					if line.upper().find("SYSTEM\\CONTROLS") <> -1:
       
    64 						foundSystemControls = 1
       
    65 
       
    66 				if reDefFile.search(line):
       
    67 					if line.upper().find("CTRL.DEF") <> -1:
       
    68 						foundDefFile = 1
       
    69 
       
    70 				if (foundSystemControls == 1) and (foundDefFile == 1):
       
    71 					break
       
    72 		
       
    73 			if (foundSystemControls == 1) and (foundDefFile <> 1):
       
    74 				return 1
       
    75 			
       
    76 	return 0
       
    77 
       
    78 script.iCompare	= ctltargettypecompare
       
    79 scanner.AddScript(script)