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

    18 #

    19 # Checks : Use of forbidden words in header files.

    20 #

    21 # Reason : Some words should not be used in header files; 

    22 # especially those header files destined for external release. 

    23 # Some words may be forbidden for legal reasons or for platform 

    24 # consistency. Where they exist, alternative allowed words should 

    25 # be used. For example, \"NMP\" and \"Nokia Mobile Phones\" should 

    26 # be replaced by \"Nokia\".

    27 #

    28 # #################################################################

    29 

    30 script = CScript("forbiddenwords")

    31 script.iReString = ""

    32 script.iFileExts = ["h"]

    33 script.iCategory = KCategoryCodingStandards

    34 script.iIgnore = KIgnoreNothing

    35 script.iSeverity = KSeverityLow

    36 

    37 reForbiddenWordsStr = "(Typhoon|Hurricane|Calypso|Rubik|Epoc\\|Nokia Mobile Phones|NMP|Mobile Innovation|(^|\s)S90|(^|\s)S80)"

    38 

    39 scriptNode = script.ScriptConfig()

    40 if (scriptNode <> None):

    41 	for wordNode in scriptNode.getElementsByTagName("wordsRE"):

    42 		reForbiddenWordsStr = wordNode.firstChild.nodeValue

    43 		print "Note: 'forbidden words' pattern configured as: " + reForbiddenWordsStr

    44 		break

    45 reForbiddenWords = re.compile(reForbiddenWordsStr, re.IGNORECASE)

    46 

    47 def forbiddenwordcompare(lines, currentline, rematch, filename):

    48 	return reForbiddenWords.search(lines[currentline])

    49 

    50 script.iCompare = forbiddenwordcompare

    51 scanner.AddScript(script)