srcanamdw/codescanner/scripts/arraypassing.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 # arraypassing.py
       
    18 #
       
    19 # Checks : Passing arrays by value rather than reference.
       
    20 #
       
    21 # Reason : Passing arrays by value causes the array to be copied 
       
    22 # needlessly, which takes up time and memory. For efficiency, 
       
    23 # references should be used.
       
    24 #
       
    25 # #################################################################
       
    26 
       
    27 script = CScript("arraypassing")
       
    28 script.iReString = r"""
       
    29     (\(|,)?         # open bracket or preceeding comma
       
    30     \s*             # whitespace
       
    31 	(R|C)\w*Array	# skip to a parameter type containing "R...Array..." or "C...Array..."
       
    32     \s*				# whitespace
       
    33 	(<.*>)?			# optional class in angle brackets
       
    34 	\s+				# whitespace
       
    35 	(\w+)			# parameter name
       
    36     (=|\w|\s)*      # optional parameter initialization or whitespace
       
    37     (\)|,)			# close bracket or trailing comma
       
    38 	"""
       
    39 script.iFileExts = ["cpp"]
       
    40 script.iCategory = KCategoryPerformance
       
    41 script.iIgnore = KIgnoreCommentsAndQuotes
       
    42 script.iSeverity = KSeverityMedium
       
    43 script.iCompare = DefaultFuncParamCompare
       
    44 
       
    45 scanner.AddScript(script)