# #################################################################

# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# 

# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

# 

# * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

# * 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.

# * 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.

# 

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 

# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 

# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 

# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 

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

#

# nonconsttdesc.py

#

# Checks : Non-const TDesC& parameter passing.

#

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

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

# descriptors, for example, passing descriptors by value.

#

# #################################################################

script = CScript("nonconsttdesc")

script.iReString = """

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

    \s*            # whitespace

    (\w+)?

    \s*            # whitespace

    (TDesC)

    \s*            # whitespace

    &

    \s*            # whitespace

    (\w+)          # parameter name

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

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

    """

script.iFileExts = ["cpp"]

script.iCategory = KCategoryCodingStandards

script.iIgnore = KIgnoreCommentsAndQuotes

script.iSeverity = KSeverityLow

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

    # make sure const TDesC& parameters are skipped

    line = lines[currentline]

    m = rematch.search(line)

    if m:

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

        while m and isConst:

            line = line[m.end():]

            m = rematch.search(line)

            if m:

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

        if isConst:

            return 0

        else:

            return DefaultFuncParamCompare(lines, currentline, rematch, filename)

    return 0

script.iCompare = consttdesccompare

scanner.AddScript(script)