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 # nonconsttdesc.py

    18 #

    19 # Checks : Non-const TDesC& parameter passing.

    20 #

    21 # Reason : TDesC& parameters should be passed as a const. If it is 

    22 # not, it may indicate that the coder does not understand 

    23 # descriptors, for example, passing descriptors by value.

    24 #

    25 # #################################################################

    26 

    27 script = CScript("nonconsttdesc")

    28 script.iReString = """

    29     (\(|,)?        # open bracket or preceeding comma

    30     \s*            # whitespace

    31     (\w+)?

    32     \s*            # whitespace

    33     (TDesC)

    34     \s*            # whitespace

    35     &

    36     \s*            # whitespace

    37     (\w+)          # parameter name

    38     (=|\w|\s)*     # optional parameter initialization or whitespace

    39     (\)|,)         # close bracket or trailing comma

    40     """

    41 script.iFileExts = ["cpp"]

    42 script.iCategory = KCategoryCodingStandards

    43 script.iIgnore = KIgnoreCommentsAndQuotes

    44 script.iSeverity = KSeverityLow

    45 

    46 def consttdesccompare(lines, currentline, rematch, filename):

    47     # make sure const TDesC& parameters are skipped

    48     line = lines[currentline]

    49     m = rematch.search(line)

    50     if m:

    51         isConst = (m.group(0).find("const") <> -1)

    52         while m and isConst:

    53             line = line[m.end():]

    54             m = rematch.search(line)

    55             if m:

    56                 isConst = (m.group(0).find("const") <> -1)

    57         if isConst:

    58             return 0

    59         else:

    60             return DefaultFuncParamCompare(lines, currentline, rematch, filename)

    61     return 0

    62 

    63 script.iCompare = consttdesccompare

    64 scanner.AddScript(script)