srcanamdw/codescanner/scripts/longlines.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 # longlines.py
       
    18 #
       
    19 # Checks : Overly long lines of code.
       
    20 #
       
    21 # Reason : Lines longer than about 100 characters can indicate 
       
    22 # messy or badly-structured code that is hard to maintain.
       
    23 #
       
    24 # #################################################################
       
    25 
       
    26 script = CScript("longlines")
       
    27 # use configured line length, if available
       
    28 scriptNode = script.ScriptConfig()
       
    29 attrInt = 100
       
    30 if (scriptNode <> None):
       
    31 	attr = scriptNode.getAttribute("length")
       
    32 	attrStr = str(attr)
       
    33 	attrInt = 0
       
    34 	if (attrStr.isdigit()):
       
    35 		attrInt = int(attrStr)
       
    36 	if (attrInt < 10):
       
    37 		attrInt = 100
       
    38 		print "Warning: Invalid line length configured; using default of 100: " + attr
       
    39 	else:
       
    40 		print "Note: 'long' line length configured as: " + str(attrInt)
       
    41 script.iReString = r""".{"""+str(attrInt)+r"""}"""
       
    42 
       
    43 script.iFileExts = ["cpp", "h", "rss", "rls", "loc", "ra","mmp"]
       
    44 script.iCategory = KCategoryCodingStandards
       
    45 script.iIgnore = KIgnoreCommentsAndQuotes
       
    46 script.iSeverity = KSeverityLow
       
    47 
       
    48 scanner.AddScript(script)