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

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

#

# forbiddenwords.py

#

# Checks : Use of forbidden words in header files.

#

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

# especially those header files destined for external release. 

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

# consistency. Where they exist, alternative allowed words should 

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

# be replaced by \"Nokia\".

#

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

script = CScript("forbiddenwords")

script.iReString = ""

script.iFileExts = ["h"]

script.iCategory = KCategoryCodingStandards

script.iIgnore = KIgnoreNothing

script.iSeverity = KSeverityLow

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

scriptNode = script.ScriptConfig()

if (scriptNode <> None):

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

		reForbiddenWordsStr = wordNode.firstChild.nodeValue

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

		break

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

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

	return reForbiddenWords.search(lines[currentline])

script.iCompare = forbiddenwordcompare

scanner.AddScript(script)