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 # linescanner.py - the main body of CodeScanner

    18 #

    19 # #################################################################

    20 

    21 import base64

    22 import datetime

    23 import encodings

    24 import getopt

    25 import os

    26 import os.path

    27 import psyco

    28 import re

    29 import sys

    30 import xml.dom.minidom

    31 import zlib

    32 

    33 # Ignore flags

    34 KIgnoreNothing = 0

    35 KIgnoreComments = 1

    36 KIgnoreCommentsAndQuotes = 2

    37 KIgnoreQuotes = 3

    38 

    39 # Severities for the scripts

    40 KSeverityHigh = 0

    41 KSeverityMedium = 1

    42 KSeverityLow = 2

    43 

    44 # The names used in the XML configuration file for severity element names.

    45 KSeverityConfigMap = {

    46 			KSeverityHigh		: "high",

    47 			KSeverityMedium		: "medium",

    48 			KSeverityLow		: "low"}

    49 

    50 # The names used in the HTML summary file for severity element names.

    51 KSeverityHTMLMap = {

    52 			KSeverityHigh		: "High",

    53 			KSeverityMedium		: "Medium",

    54 			KSeverityLow		: "Low"}

    55 

    56 # Categories for the scripts

    57 KCategoryLegal = "Legal Code" 

    58 KCategoryDefinitePanic = "Always Panic"

    59 KCategoryCanPanic = "Can Panic"

    60 KCategoryWrongFunctionality = "Wrong Functionality"

    61 KCategoryLocalisation = "Localisation"

    62 KCategoryPerformance = "Performance"

    63 KCategoryCodingStandards = "Coding Standard"

    64 KCategoryDocumentation = "Documentation"

    65 KCategoryCodeReviewGuides = "Code Review Guide"

    66 KCategoryOther = "Other"

    67 

    68 KCategoryHtmlDisplayOrder = [KCategoryLegal,

    69 	KCategoryDefinitePanic,

    70 	KCategoryCanPanic,

    71 	KCategoryWrongFunctionality,

    72 	KCategoryLocalisation,

    73 	KCategoryPerformance,

    74 	KCategoryCodingStandards,

    75 	KCategoryDocumentation,

    76 	KCategoryCodeReviewGuides,

    77 	KCategoryOther]

    78 

    79 # The names used in the XML configuration file for category element names.

    80 KCategoryConfigMap = {

    81 			KCategoryLegal				:	"legal", 

    82 			KCategoryDefinitePanic		:	"panic", 

    83 			KCategoryCanPanic			:	"canpanic", 

    84 			KCategoryWrongFunctionality	:	"functionality",

    85 			KCategoryLocalisation		:	"localisation",

    86 			KCategoryPerformance		:	"performance",

    87 			KCategoryCodingStandards	:	"codingstandards",

    88 			KCategoryDocumentation		:	"documentation",

    89 			KCategoryCodeReviewGuides	:	"codereview",

    90 			KCategoryOther				:	"other"}

    91 

    92 #Custom rule keyword types

    93 KKeywordBaseClass = "baseclass"

    94 KKeywordCall = "call"

    95 KKeywordClassName = "class"

    96 KKeywordComment = "comment"

    97 KKeywordGeneric = "generic"

    98 KKeywordLocal = "local"

    99 KKeywordMacro = "macro"

   100 KKeywordMember = "member"

   101 KKeywordMethod = "method"

   102 KKeywordParameter = "parameter"

   103 KKeywordUnknown = "unknown"

   104 

   105 #The names used in the XML configuration file for custom rule keyword types.

   106 KCustomRuleKeywordMap = {

   107 			KKeywordBaseClass           :   "baseclass",

   108 			KKeywordCall                :   "call",

   109 			KKeywordClassName           :   "class",

   110 			KKeywordComment             :   "comment",

   111 			KKeywordGeneric             :   "generic",

   112 			KKeywordLocal               :   "local",

   113 			KKeywordMacro               :   "macro",

   114 			KKeywordMember              :   "member",

   115 			KKeywordMethod              :   "method",

   116 			KKeywordParameter           :   "parameter",

   117 			KKeywordUnknown             :   "unknown"}

   118 

   119 KVersion = "Nokia CodeScanner version 2.1.4"

   120 KCopyrightLine1 = "Copyright (c) 2007-2009. Nokia Corporation. All rights reserved."

   121 KCopyrightLine1Html = "Copyright © 2007-2009. Nokia Corporation. All rights reserved."

   122 KCopyrightLine2 = "For product and support information, visit www.forum.nokia.com."

   123 KWww = "www.forum.nokia.com"

   124 

   125 stringPool = {}

   126 #

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

   128 # All rights reserved.

   129 # 

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

   131 # 

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

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

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

   135 # 

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

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

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

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

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

   141 #

   142 

   143 # English.loc

   144 # localised string for Script accessArrayElementWithoutCheck

   145 

   146 stringPool[ "accessArrayElementWithoutCheck!title" ]       = "Array element accessed by At() function without checking index is within array range"

   147 stringPool[ "accessArrayElementWithoutCheck!description" ] = "Whenever an element in an array is accessed, the index should be checked to ensure that it is less than array.Count(). CodeScanner checks for explicit calls to a Count() function; so if the array index is checked in a different way, it gives false positives. Accessing an invalid index can cause a panic."

   148 stringPool[ "accessArrayElementWithoutCheck!ideTitle" ]    = "array element accessed by At() function without checking index is within array range"

   149 

   150 # localised string for Script accessArrayElementWithoutCheck2

   151 stringPool[ "accessArrayElementWithoutCheck2!title" ]       = "Array element accessed by [] without checking range"

   152 stringPool[ "accessArrayElementWithoutCheck2!description" ] = "Whenever an element in an array is accessed, the index should first be checked to ensure that it is within range. CodeScanner checks for explicit calls to a Count() or Length() function; so if the array index is checked in a different way, it gives false positives. Accessing an invalid index can cause a panic."

   153 stringPool[ "accessArrayElementWithoutCheck2!ideTitle" ]    = "array element accessed by [] without checking range"

   154 

   155 # localised string for Script activestart

   156 stringPool[ "activestart!title" ]       = "Using CActiveScheduler::Start"

   157 stringPool[ "activestart!description" ] = "Using CActiveScheduler::Start() can mean that something asynchronous is being made synchronous. Instead, use active objects correctly in an asynchronous way."

   158 stringPool[ "activestart!ideTitle" ]    = "using CActiveScheduler::Start"

   159 

   160 # localised string for Script activestop

   161 stringPool[ "activestop!title" ]       = "Using CActiveScheduler::Stop"

   162 stringPool[ "activestop!description" ] = "Using CActiveScheduler::Stop() can mean that something asynchronous is being made synchronous. Instead, use active objects correctly in an asynchronous way."

   163 stringPool[ "activestop!ideTitle" ]    = "using CActiveScheduler::Stop"

   164 

   165 # localised string for Script arraypassing

   166 stringPool[ "arraypassing!title" ]       = "Passing arrays by value rather than reference"

   167 stringPool[ "arraypassing!description" ] = "Passing arrays by value causes the array to be copied needlessly, which takes up time and memory. For efficiency, references should be used."

   168 stringPool[ "arraypassing!ideTitle" ]    = "passing arrays by value rather than reference"

   169 

   170 # localised string for Script arrayptrcleanup

   171 stringPool[ "arrayptrcleanup!title" ]       = "Using local CArrayPtr classes without cleanup items"

   172 stringPool[ "arrayptrcleanup!description" ] = "It is not enough to push a local CArrayPtr class onto the cleanup stack. A TCleanupItem and callback function must be used to avoid leaking the elements."

   173 stringPool[ "arrayptrcleanup!ideTitle" ]    = "using local CArrayPtr classes without cleanup items"

   174 

   175 # localised string for Script assertdebuginvariant

   176 stringPool[ "assertdebuginvariant!title" ]       = "__ASSERT_DEBUG with User::Invariant"

   177 stringPool[ "assertdebuginvariant!description" ] = "Replace __ASSERT_DEBUG(<condition>, User::Invariant()) with ASSERT(<condition>), because it is easier to read."

   178 stringPool[ "assertdebuginvariant!ideTitle" ]    = "__ASSERT_DEBUG with User::Invariant"

   179 

   180 # localised string for Script baddefines

   181 stringPool[ "baddefines!title" ]       = "Lowercase definition names"

   182 stringPool[ "baddefines!description" ] = "Badly-named definitions makes the code harder to maintain and can lead to defects."

   183 stringPool[ "baddefines!ideTitle" ]    = "lowercase definition names"

   184 

   185 # localised string for Script baseconstruct

   186 stringPool[ "baseconstruct!title" ]       = "Leaving function called before BaseConstructL()"

   187 stringPool[ "baseconstruct!description" ] = "If a leave occurs before BaseConstructL() is called, the system can panic because it is trying to clean up an application that has not been fully initialised."

   188 stringPool[ "baseconstruct!ideTitle" ]    = "leaving method called before BaseConstructL"

   189 

   190 # localised string for Script callActiveObjectWithoutCheckingOrStopping

   191 stringPool[ "callActiveObjectWithoutCheckingOrStopping!title" ]       = "Active object called without checking whether it is active or canceling it first"

   192 stringPool[ "callActiveObjectWithoutCheckingOrStopping!description" ] = "If an active object is started twice, a panic occurs. CodeScanner picks out places where there is a call to a Start(), Queue(), or After() function on a member variable, without a previous call to IsActive(), Cancel(), or Stop(). In general, if starting a timer, there should at least be a call to IsActive() to ensure that the timer is not already running."

   193 stringPool[ "callActiveObjectWithoutCheckingOrStopping!ideTitle" ]    = "active object called without checking whether it is active or canceling it first"

   194 

   195 # localised string for Script changenotification

   196 stringPool[ "changenotification!title" ]       = "Using RSAVarChangeNotify to see System Agent changes"

   197 stringPool[ "changenotification!description" ] = "When watching for System Agent changes, use RSystemAgent rather than RSAVarChangeNotify, which can fail."

   198 stringPool[ "changenotification!ideTitle" ]    = "using RSAVarChangeNotify to see System Agent changes"

   199 

   200 # localised string for Script cleanup

   201 stringPool[ "cleanup!title" ]       = "CleanupStack::Pop(AndDestroy) parameters"

   202 stringPool[ "cleanup!description" ] = "These functions should be called with explicit variable parameters to avoid misalignment."

   203 stringPool[ "cleanup!ideTitle" ]    = "missing CleanupStack::Pop parameter"

   204 

   205 # localised string for Script commentcode

   206 stringPool[ "commentcode!title" ]       = "Commented-out code"

   207 stringPool[ "commentcode!description" ] = "Instances of code that are commented out make the code hard to maintain and to interpret clearly. The commented out code should be removed. Any requirement to rediscover old code should be made through source control and not by trawling through commented-out code."

   208 stringPool[ "commentcode!ideTitle" ]    = "commented-out code"

   209 

   210 # localised string for Script connect

   211 stringPool[ "connect!title" ]       = "Ignoring Connect() return value"

   212 stringPool[ "connect!description" ] = "Ignoring the error returned from Connect() functions means that if the Connect() function fails due to OOM or other problems, the next access to the resource will panic."

   213 stringPool[ "connect!ideTitle" ]    = "ignoring Connect() return value"

   214 

   215 # localised string for Script ConnectAndDontCloseMemberVariable

   216 stringPool[ "ConnectAndDontCloseMemberVariable!title" ]       = "Calling Connect() or Open() on a member variable without calling Close() in the destructor"

   217 stringPool[ "ConnectAndDontCloseMemberVariable!description" ] = "If Connect() or Open() is called on any member variable, then Close() must be called in the destructor."

   218 stringPool[ "ConnectAndDontCloseMemberVariable!ideTitle" ]    = "calling Connect() or Open() on a member variable without calling Close() in the destructor"

   219 

   220 # localised string for Script constnames

   221 stringPool[ "constnames!title" ]       = "Badly-named constants"

   222 stringPool[ "constnames!description" ] = "Badly-named constant will make the source code harder to maintain and make defects more likely."

   223 stringPool[ "constnames!ideTitle" ]    = "badly-named constant"

   224 

   225 # localised string for Script consttdescptr

   226 stringPool[ "consttdescptr!title" ]       = "Const descriptor pointer as argument"

   227 stringPool[ "consttdescptr!description" ] = "Use \"const TDesC&\" instead of \"const TDesC*\"."

   228 stringPool[ "consttdescptr!ideTitle" ]    = "const descriptor pointer as argument"

   229 

   230 # localised string for Script controlornull

   231 stringPool[ "controlornull!title" ]       = "Accessing return value of ControlOrNull()"

   232 stringPool[ "controlornull!description" ] = "The return value might be NULL, so it should be checked before access."

   233 stringPool[ "controlornull!ideTitle" ]    = "accessing return value of ControlOrNull()"

   234 

   235 # localised string for Script crepository

   236 stringPool[ "crepository!title" ]       = "Ignoring CRepository::get() return value"

   237 stringPool[ "crepository!description" ] = "Independent application cannot assume that the Central Repository is set up fully. This means the return value of CRepository::get() cannot be ignored."

   238 stringPool[ "crepository!ideTitle" ]    = "ignoring CRepository::get() return value"

   239 

   240 # localised string for Script ctltargettype

   241 stringPool[ "ctltargettype!title" ]       = "Use of targettype ctl"

   242 stringPool[ "ctltargettype!description" ] = "The ctl target type should not be used. Instead, use DLL and explicitly refer to the Control Panel's DEF file. Note: Code that causes this issue only needs attention if it is found in code developed for Nokia Series 90 code that has extra exports for resetting the Control Panel item's data."

   243 stringPool[ "ctltargettype!ideTitle" ]    = "use of targettype ctl"

   244 

   245 # localised string for Script customizableicons

   246 stringPool[ "customizableicons!title" ]       = "Use of customizable icons"

   247 stringPool[ "customizableicons!description" ] = "Due to device customization requirements, independent application must not remove any customization done by the variant team. This means independent application cannot include customizable icons."

   248 stringPool[ "customizableicons!ideTitle" ]    = "use of customizable icons"

   249 

   250 # localised string for Script debugrom

   251 stringPool[ "debugrom!title" ]       = "Debug components in ROM"

   252 stringPool[ "debugrom!description" ] = "Debug versions of components in the ROM could mean that ROM space is being taken up with debugging information or that logging is being put out. Release versions should be in the ROM unless there is a good reason why they are not."

   253 stringPool[ "debugrom!ideTitle" ]    = "debug components in ROM"

   254 

   255 # localised string for Script declarename

   256 stringPool[ "declarename!title" ]       = "Use of __DECLARE_NAME"

   257 stringPool[ "declarename!description" ] = "The __DECLARE_NAME macro is historical and serves no purpose anymore and should be removed."

   258 stringPool[ "declarename!ideTitle" ]    = "use of __DECLARE_NAME"

   259 

   260 # localised string for Script deleteMemberVariable

   261 stringPool[ "deleteMemberVariable!title" ]       = "Member variable deleted incorrectly"

   262 stringPool[ "deleteMemberVariable!description" ] = "When a member variable is deleted, it should be assigned either to NULL or to another value. This prevents accidental access of the deleted object. If a NewL() or other leaving function is called to reassign the member variable, it should first be assigned to NULL in case that function leaves."

   263 stringPool[ "deleteMemberVariable!ideTitle" ]    = "member variable deleted incorrectly"

   264 

   265 # localised string for Script destructor

   266 stringPool[ "destructor!title" ]       = "Pointer access in destructors"

   267 stringPool[ "destructor!description" ] = "Accessing pointers to objects in destructors without checking whether they are not NULL could result in a panic because they may not have been constructed. The pointers should be checked to determine whether they are owned objects. If they are not owned, they should really be references rather than pointers."

   268 stringPool[ "destructor!ideTitle" ]    = "destructor is accessing/dereferencing data member"

   269 

   270 # localised string for Script doubleSemiColon

   271 stringPool[ "doubleSemiColon!title" ]       = "Use of double semicolon"

   272 stringPool[ "doubleSemiColon!description" ] = "Double semicolons at the end of a line are not necessary and cause a CodeWarrior compiler error."

   273 stringPool[ "doubleSemiColon!ideTitle" ]    = "use of double semicolon"

   274 

   275 # localised string for Script driveletters

   276 stringPool[ "driveletters!title" ]       = "Hard-coded drive letters"

   277 stringPool[ "driveletters!description" ] = "Drive letters should not be hard-coded."

   278 stringPool[ "driveletters!ideTitle" ]    = "hard-coded drive letters"

   279 

   280 # localised string for Script eikbuttons

   281 stringPool[ "eikbuttons!title" ]       = "Checks that the R_EIK_BUTTONS_* resources are not being used"

   282 stringPool[ "eikbuttons!description" ] = "R_EIK_BUTTONS_* resources will not be internationalised, and should not be used. Instead, create your own button resource. No button resource (or indeed, rls string) should be used in more than one location. Note: This issue is only relevant for development on Nokia platforms."

   283 stringPool[ "eikbuttons!ideTitle" ]    = "use of R_EIK_BUTTONS_ resources"

   284 

   285 # localised string for Script eikonenvstatic

   286 stringPool[ "eikonenvstatic!title" ]       = "Using CEikonEnv::Static"

   287 stringPool[ "eikonenvstatic!description" ] = "CEikonEnv::Static() calls should be kept to a minimum, because this involves TLS. All applications, controls, and dialogs already have a pointer to the singleton instance of CEikonEnv as a member variable and so do not need to find it again. If a class does not have access to a CEikonEnv and needs to use it repeatedly, then it should store one."

   288 stringPool[ "eikonenvstatic!ideTitle" ]    = "using CEikonEnv::Static"

   289 

   290 # localised string for Script enummembers

   291 stringPool[ "enummembers!title" ]       = "Enums with badly-named members"

   292 stringPool[ "enummembers!description" ] = "Enums with badly-named members make the code harder to maintain and may cause defects."

   293 stringPool[ "enummembers!ideTitle" ]    = "enum with badly-named member"

   294 

   295 # localised string for Script enumnames

   296 stringPool[ "enumnames!title" ]       = "Badly-named enums"

   297 stringPool[ "enumnames!description" ] = "Badly-named enums make the code harder to maintain and may cause defects."

   298 stringPool[ "enumnames!ideTitle" ]    = "badly-named enum"

   299 

   300 # localised string for Script exportinline

   301 stringPool[ "exportinline!title" ]       = "Exporting inline functions"

   302 stringPool[ "exportinline!description" ] = "Inline functions should not be exported because this can cause those that link to the DLL to fail to build. Exporting functions limits the changes that can be made in the future due to considerations of binary-compatibility."

   303 stringPool[ "exportinline!ideTitle" ]    = "exporting inline functions"

   304 

   305 # localised string for Script exportpurevirtual

   306 stringPool[ "exportpurevirtual!title" ]       = "Exporting pure virtual functions"

   307 stringPool[ "exportpurevirtual!description" ] = "Symbian recommends against the exportation of pure virtual functions."

   308 stringPool[ "exportpurevirtual!ideTitle" ]    = "exporting pure virtual functions"

   309 

   310 # localised string for Script externaldriveletters

   311 # stringPool[ "externaldriveletters!title" ]       = "Hard-coded external drive letters"

   312 # stringPool[ "externaldriveletters!description" ] = "External drive letters should not be hard-coded as the external drive may change between platforms and releases. This may cause confusion over ownership leading to classes being deleted erroneously and leaks occurring."

   313 # stringPool[ "externaldriveletters!ideTitle" ]    = "hard-coded external drive letter"

   314 

   315 # localised string for Script flags

   316 stringPool[ "flags!title" ]       = "Use of R&D flags or feature flags"

   317 stringPool[ "flags!description" ] = "Independent application must not use R&D flags nor feature flags via preprocessor statements in the source code. This means bld*.hrh and productvariant.hrh should not be used."

   318 stringPool[ "flags!ideTitle" ]    = "use of R&D flags or feature flags"

   319 

   320 # localised string for Script foff

   321 stringPool[ "foff!title" ]       = "Use of _FOFF"

   322 stringPool[ "foff!description" ] = "_FOFF allows access to data in classes that were not intended for public access. This may cause problems, especially when the location of the data changes."

   323 stringPool[ "foff!ideTitle" ]    = "use of _FOFF"

   324 

   325 # localised string for Script forbiddenwords

   326 stringPool[ "forbiddenwords!title" ]       = "Use of forbidden words in header files"

   327 stringPool[ "forbiddenwords!description" ] = "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\"."

   328 stringPool[ "forbiddenwords!ideTitle" ]    = "use of forbidden words in header files"

   329 

   330 # localised string for Script forgottoputptroncleanupstack

   331 stringPool[ "forgottoputptroncleanupstack!title" ]       = "Neglected to put variable on cleanup stack"

   332 stringPool[ "forgottoputptroncleanupstack!description" ] = "If a variable is not put on the cleanup stack and a leaving function or ELeave is called, a memory leak occurs. CodeScanner occasionally gives false positives for this issue. Individual cases should be investigated."

   333 stringPool[ "forgottoputptroncleanupstack!ideTitle" ]    = "neglected to put variable on cleanup stack"

   334 

   335 # localised string for Script friend

   336 stringPool[ "friend!title" ]       = "Use of friends"

   337 stringPool[ "friend!description" ] = "The friend directive is often misused and can indicate problems in the OO design."

   338 stringPool[ "friend!ideTitle" ]    = "use of friends"

   339 

   340 # localised string for Script goto

   341 stringPool[ "goto!title" ]       = "Use of goto"

   342 stringPool[ "goto!description" ] = "Goto should not be used if it can be avoided because it makes the program flow more difficult to follow."

   343 stringPool[ "goto!ideTitle" ]    = "use of goto"

   344 

   345 # localised string for Script ifassignments

   346 stringPool[ "ifassignments!title" ]       = "Assignment in an If statement"

   347 stringPool[ "ifassignments!description" ] = "Assignments inside an If statement often indicate that the assignment was not intended. Even if the assignment was intended, it is clearer to separate out the assignment from the conditional. The script that detects such occurrences has a few false positives when the action statements are on the same line as the conditional check. However, this is also against the coding standards and the action should be on a separate line."

   348 stringPool[ "ifassignments!ideTitle" ]    = "assignment in an If statement"

   349 

   350 # localised string for Script ifpreprocessor

   351 stringPool[ "ifpreprocessor!title" ]       = "Use of #if in .h files"

   352 stringPool[ "ifpreprocessor!description" ] = "#if in header files should only be used before the main include guards and not around #include statements or around functional blocks in class definitions. The reason for the latter is to aid readability and to make BC breaks more difficult."

   353 stringPool[ "ifpreprocessor!ideTitle" ]    = "use of #if in .h files (not as main include guards)"

   354 

   355 # localised string for Script inheritanceorder

   356 stringPool[ "inheritanceorder!title" ]       = "Incorrect inheritance order of M and C classes"

   357 stringPool[ "inheritanceorder!description" ] = "If a C class inherits first from an M class and then a C class, a panic can occur when trying to pop a CBase pointer pointing to such a class from the cleanup stack when in fact a pointer pointing to the first predecessor, the mixin class, was popped instead."

   358 stringPool[ "inheritanceorder!ideTitle" ]    = "incorrect inheritance order of M and C classes"

   359 

   360 # localised string for Script intleaves

   361 stringPool[ "intleaves!title" ]       = "Methods that leave AND return a TInt error"

   362 stringPool[ "intleaves!description" ] = "Returning an error code as well as being able to leave is problematical for the caller. It is preferable to adhere to one method of returning the error. Note: CodeScanner is likely to return false positives for this situation, because some returned TInt values will not be error codes."

   363 stringPool[ "intleaves!ideTitle" ]    = "methods that leave AND return a TInt error"

   364 

   365 # localised string for Script jmp

   366 stringPool[ "jmp!title" ]       = "Use of setjmp and/or longjmp"

   367 stringPool[ "jmp!description" ] = "Using setjmp and/or longjmp makes code less maintainable."

   368 stringPool[ "jmp!ideTitle" ]    = "use of setjmp and/or longjmp"

   369 

   370 # localised string for Script leave

   371 stringPool[ "leave!title" ]       = "Leaving functions called in non-leaving functions"

   372 stringPool[ "leave!description" ] = "Non-leaving functions should not call leaving functions. Note: Operator functions are considered to be able to leave when scanning the code inside them."

   373 stringPool[ "leave!ideTitle" ]    = "leaving function called in non-leaving function"

   374 

   375 # localised string for Script LeaveNoError

   376 stringPool[ "LeaveNoError!title" ]       = "Leaving with KErrNone"

   377 stringPool[ "LeaveNoError!description" ] = "Leaving with KErrNone usually indicates that there is a makeshift way around a design issue rather than a true and proper fix to the architecture."

   378 stringPool[ "LeaveNoError!ideTitle" ]    = "leaving with KErrNone"

   379 

   380 # localised string for Script leavingoperators

   381 stringPool[ "leavingoperators!title" ]       = "Leaving functions called in operator functions"

   382 stringPool[ "leavingoperators!description" ] = "It is not obvious that operator functions can leave. Calling leaving functions in operator functions should be considered carefully."

   383 stringPool[ "leavingoperators!ideTitle" ]    = "leaving functions called in operator functions"

   384 

   385 # localised string for Script LFunctionCantLeave

   386 stringPool[ "LFunctionCantLeave!title" ]       = "L-functions that cannot leave"

   387 stringPool[ "LFunctionCantLeave!description" ] = "A function should not be named with an 'L' if it cannot leave. The only exception is in virtual functions where the function name is defined in the base class so the L cannot be removed. For example, RunL()."

   388 stringPool[ "LFunctionCantLeave!ideTitle" ]    = "L-functions that cannot leave"

   389 

   390 # localised string for Script longlines

   391 stringPool[ "longlines!title" ]       = "Overly long lines of code"

   392 stringPool[ "longlines!description" ] = "Lines longer than about 100 characters can indicate messy or badly-structured code that is hard to maintain."

   393 stringPool[ "longlines!ideTitle" ]    = "overly long line of code"

   394 

   395 # localised string for Script magicnumbers

   396 stringPool[ "magicnumbers!title" ]       = "Use of magic numbers"

   397 stringPool[ "magicnumbers!description" ] = "Magic numbers - that is, numbers that are hard-coded into the source code and instead of being presented as constants - make code difficult to maintain and give no indication of why a calculation is the way it is. Magic numbers should be replaced with named constants."

   398 stringPool[ "magicnumbers!ideTitle" ]    = "use of magic numbers"

   399 

   400 # localised string for Script mclassdestructor

   401 stringPool[ "mclassdestructor!title" ]       = "M class has destructor"

   402 stringPool[ "mclassdestructor!description" ] = "M classes should not contain a destructor."

   403 stringPool[ "mclassdestructor!ideTitle" ]    = "M class has destructor"

   404 

   405 # localised string for Script memberlc

   406 stringPool[ "memberlc!title" ]       = "Assigning LC methods to member variables"

   407 stringPool[ "memberlc!description" ] = "Objects on the cleanup stack should not be assigned to member variables"

   408 stringPool[ "memberlc!ideTitle" ]    = "LC method assigned to data member"

   409 

   410 # localised string for Script membervariablecallld

   411 stringPool[ "membervariablecallld!title" ]       = "Calling LD function on member variable"

   412 stringPool[ "membervariablecallld!description" ] = "LD functions should not be called on a member variable because ownership can be unclear and may lead to double deletes."

   413 stringPool[ "membervariablecallld!ideTitle" ]    = "calling LD function on member variable"

   414 

   415 # localised string for Script missingcancel

   416 stringPool[ "missingcancel!title" ]       = "Cancel() not called in active object's destructor"

   417 stringPool[ "missingcancel!description" ] = "Cancel() should always be called in active object's destructor to cancel an outstanding request if there is one. If there is no request pending then Cancel() just does nothing, but if we do not call Cancel() when having an outstanding request a panic will be raised. CodeScanner occasionally gives false positives for this issue. Individual cases should be investigated."

   418 stringPool[ "missingcancel!ideTitle" ]    = "Cancel() not called in active object's destructor"

   419 

   420 # localised string for Script missingcclass

   421 stringPool[ "missingcclass!title" ]       = "C class not inheriting from another C class"

   422 stringPool[ "missingcclass!description" ] = "All C classes should inherit from another C class to ensure that all data members are zeroed."

   423 stringPool[ "missingcclass!ideTitle" ]    = "C class not inheriting from another C class"

   424 

   425 # localised string for Script mmpsourcepath

   426 stringPool[ "mmpsourcepath!title" ]       = "Use of absolute path names in MMP files"

   427 stringPool[ "mmpsourcepath!description" ] = "Use of absolute paths in MMP files makes it impossible to relocate the source. Relative paths should be used instead."

   428 stringPool[ "mmpsourcepath!ideTitle" ]    = "use of absolute path names in MMP files"

   429 

   430 # localised string for Script multilangrsc

   431 stringPool[ "multilangrsc!title" ]       = "Not using BaflUtils::NearestLanguageFile() when loading a resource file"

   432 stringPool[ "multilangrsc!description" ] = "If AddResourceFileL() is used without first using BaflUtils::NearestLanguageFile(), then not all language versions of resources will be picked up."

   433 stringPool[ "multilangrsc!ideTitle" ]    = "not using BaflUtils::NearestLanguageFile() when loading a resource file"

   434 

   435 # localised string for Script multipledeclarations

   436 stringPool[ "multipledeclarations!title" ]       = "Multiple declarations on one line"

   437 stringPool[ "multipledeclarations!description" ] = "Multiple declarations on one line can be confusing. Separate them out so that each declaration is on its own separate line."

   438 stringPool[ "multipledeclarations!ideTitle" ]    = "multiple declarations on one line"

   439 

   440 # localised string for Script multipleinheritance

   441 stringPool[ "multipleinheritance!title" ]       = "Non M-class multiple inheritance"

   442 stringPool[ "multipleinheritance!description" ] = "It is bad Symbian OS practice to derive from two classes that have implemented functions. Complex behaviour that was not intended can result."

   443 stringPool[ "multipleinheritance!ideTitle" ]    = "multiple inheritance from non M-classes"

   444 

   445 # localised string for Script mydocs

   446 stringPool[ "mydocs!title" ]       = "Hard-coded mydocs directory strings"

   447 stringPool[ "mydocs!description" ] = "The mydocs directory is subject to change so should not be referenced directly. Note: @	This issue will only occur in code developed for the Nokia Series 90 platform."

   448 stringPool[ "mydocs!ideTitle" ]    = "hard-coded mydocs directory strings"

   449 

   450 # localised string for Script namespace

   451 stringPool[ "namespace!title" ]       = "Use of namespace"

   452 stringPool[ "namespace!description" ] = "Namespaces are often used to work around a poor naming convention."

   453 stringPool[ "namespace!ideTitle" ]    = "use of namespace"

   454 

   455 # localised string for Script newlreferences

   456 stringPool[ "newlreferences!title" ]       = "NewL() returning a reference"

   457 stringPool[ "newlreferences!description" ] = "NewL() and NewLC() functions should return a pointer to an object created on the heap."

   458 stringPool[ "newlreferences!ideTitle" ]    = "NewL() returning a reference"

   459 

   460 # localised string for Script noleavetrap

   461 stringPool[ "noleavetrap!title" ]       = "TRAP used with no leaving functions"

   462 stringPool[ "noleavetrap!description" ] = "A TRAP is unnecessary if there are no leaving functions."

   463 stringPool[ "noleavetrap!ideTitle" ]    = "TRAP contains no leaving functions"

   464 

   465 # localised string for Script nonconsthbufc

   466 stringPool[ "nonconsthbufc!title" ]       = "Non-const HBufC* parameter passing"

   467 stringPool[ "nonconsthbufc!description" ] = "HBufC* parameters should almost always be passed as a const pointer."

   468 stringPool[ "nonconsthbufc!ideTitle" ]    = "non-const HBufC* parameter passing"

   469 

   470 # localised string for Script nonconsttdesc

   471 stringPool[ "nonconsttdesc!title" ]       = "Non-const TDesC& parameter passing"

   472 stringPool[ "nonconsttdesc!description" ] = "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."

   473 stringPool[ "nonconsttdesc!ideTitle" ]    = "non-const TDesC& parameter passing"

   474 

   475 # localised string for Script nonleavenew

   476 stringPool[ "nonleavenew!title" ]       = "Use of new without (ELeave)"

   477 stringPool[ "nonleavenew!description" ] = "Using new without (ELeave) is only used in special circumstances. The leaving variant should typically be used in preference. A common exception is for application creation, where NULL is returned for failed creation."

   478 stringPool[ "nonleavenew!ideTitle" ]    = "new used without (ELeave)"

   479 

   480 # localised string for Script nonunicodeskins

   481 stringPool[ "nonunicodeskins!title" ]       = "Non-Unicode skins"

   482 stringPool[ "nonunicodeskins!description" ] = "Skin definition files (SKN, SKE) must be Unicode. Note: Code that causes this issue only needs attention if it is found in code developed for Nokia Series 90 code."

   483 stringPool[ "nonunicodeskins!ideTitle" ]    = "non-Unicode skins"

   484 

   485 # localised string for Script null

   486 stringPool[ "null!title" ]       = "NULL equality check"

   487 stringPool[ "null!description" ] = "There is no need to compare pointer variables to NULL. Use If(ptr)."

   488 stringPool[ "null!ideTitle" ]    = "NULL equality check"

   489 

   490 # localised string for Script open

   491 stringPool[ "open!title" ]       = "Ignoring Open() return value"

   492 stringPool[ "open!description" ] = "Ignoring the return value from Open() functions (due to OOM, etc.) means that when the resource is accessed next, a panic will result."

   493 stringPool[ "open!ideTitle" ]    = "ignoring Open() return value"

   494 

   495 # localised string for Script pointertoarrays

   496 stringPool[ "pointertoarrays!title" ]       = "Pointer to arrays as members of a C class"

   497 stringPool[ "pointertoarrays!description" ] = "In C classes, there is no need to use pointers to arrays as data members. Instead, use the arrays themselves. Using pointers leads to obscure notation like \"(*array)[n]\" for the more usual \"array[n]\". It also makes it necessary to explicitly delete the arrays in the destructor. Using the arrays themselves also simplifies notation, reduces indirection, and reduces heap fragmentation."

   498 stringPool[ "pointertoarrays!ideTitle" ]    = "pointer to arrays as members of a C class"

   499 

   500 # localised string for Script pragmadisable

   501 stringPool[ "pragmadisable!title" ]       = "Use of #pragma warning"

   502 stringPool[ "pragmadisable!description" ] = "Disabling warnings can lead to problems, because the warnings are probably there for a reason."

   503 stringPool[ "pragmadisable!ideTitle" ]    = "use of #pragma warning"

   504 

   505 # localised string for Script pragmamessage

   506 stringPool[ "pragmamessage!title" ]       = "Use of #pragma message"

   507 stringPool[ "pragmamessage!description" ] = "#pragma messages during the build stage can interfere with the build log parsing."

   508 stringPool[ "pragmamessage!ideTitle" ]    = "use of #pragma message"

   509 

   510 # localised string for Script pragmaother

   511 stringPool[ "pragmaother!title" ]       = "Use of #pragma other than warning and message"

   512 stringPool[ "pragmaother!description" ] = "#pragma directives should only be used in very edge cases (for example, functions consisting of inline assembler without explicit return statements) because, typically, their usage masks valid build warnings and error messages."

   513 stringPool[ "pragmaother!ideTitle" ]    = "use of #pragma other than warning and message"

   514 

   515 # localised string for Script privateinheritance

   516 stringPool[ "privateinheritance!title" ]       = "Use of private inheritance"

   517 stringPool[ "privateinheritance!description" ] = "Classes should not be inherited privately. If public or protected inheritance is not appropriate, consider using an amalgamation; that is, have an object of that type as a member variable."

   518 stringPool[ "privateinheritance!ideTitle" ]    = "use of private inheritance"

   519 

   520 # localised string for Script pushaddrvar

   521 stringPool[ "pushaddrvar!title" ]       = "Pushing address of a variable onto the cleanup stack"

   522 stringPool[ "pushaddrvar!description" ] = "If the variable is owned by the code pushing it, it should be stored as a pointer. If it is not, it should not be pushed onto the cleanup stack."

   523 stringPool[ "pushaddrvar!ideTitle" ]    = "pushing address of a variable onto the cleanup stack"

   524 

   525 # localised string for Script pushmember

   526 stringPool[ "pushmember!title" ]       = "Pushing data members onto the cleanup stack"

   527 stringPool[ "pushmember!description" ] = "Pushing member variables is likely to lead to double deletes or leakage in certain circumstances and so should be avoided. Even if no panic can result, it is bad practice and makes maintenance more difficult."

   528 stringPool[ "pushmember!ideTitle" ]    = "data member pushed to cleanup stack"

   529 

   530 # localised string for Script readresource

   531 stringPool[ "readresource!title" ]       = "Using ReadResource() instead of ReadResourceL()"

   532 stringPool[ "readresource!description" ] = "ReadResourceL() should always be used in preference to ReadResource() because in an error scenario ReadResource() effectively fails silently. If no check is performed on the resulting descriptor afterwards, unexpected states can ensue. These states are often characterized by buffer overflows."

   533 stringPool[ "readresource!ideTitle" ]    = "Using ReadResource() instead of ReadResourceL()"

   534 

   535 # localised string for Script resourcenotoncleanupstack

   536 stringPool[ "resourcenotoncleanupstack!title" ]       = "Neglected to put resource objects on cleanup stack"

   537 stringPool[ "resourcenotoncleanupstack!description" ] = "If a stack-based resource object is not put on the cleanup stack with CleanupResetAndDestroyPushL() or CleanupClosePushL(), and a leaving function or ELeave is called, a memory leak occurs. CodeScanner occasionally gives false positives for this issue. Individual cases should be investigated."

   538 stringPool[ "resourcenotoncleanupstack!ideTitle" ]    = "neglected to put resource objects on cleanup stack"

   539 

   540 # localised string for Script resourcesonheap

   541 stringPool[ "resourcesonheap!title" ]       = "Resource objects on the heap"

   542 stringPool[ "resourcesonheap!description" ] = "There is very rarely any real need to put R classes on the heap (unless they are not real R classes!).  Doing so can lead to inefficiency and cleanup stack problems."

   543 stringPool[ "resourcesonheap!ideTitle" ]    = "resource objects on the heap"

   544 

   545 # localised string for Script returndescriptoroutofscope

   546 stringPool[ "returndescriptoroutofscope!title" ]       = "Return descriptor out of scope"

   547 stringPool[ "returndescriptoroutofscope!description" ] = "Returning a TBuf descriptor that is declared locally takes it out of scope. This can cause a crash on WINSCW, although not on WINS."

   548 stringPool[ "returndescriptoroutofscope!ideTitle" ]    = "return descriptor out of scope"

   549 

   550 # localised string for Script rfs

   551 stringPool[ "rfs!title" ]       = "Use of non-pointer/reference RFs"

   552 stringPool[ "rfs!description" ] = "Connecting to an RFs is a time-consuming operation. (It can take approximately 0.1 seconds on some devices.) To minimise wasted time and resources, use the already-connected one in EikonEnv or elsewhere, if possible."

   553 stringPool[ "rfs!ideTitle" ]    = "use of non-pointer/reference RFs"

   554 

   555 # localised string for Script rssnames

   556 stringPool[ "rssnames!title" ]       = "Duplicate RSS names"

   557 stringPool[ "rssnames!description" ] = "Resource files with clashing NAME fields can cause the wrong resource file to be accessed. This can lead to incorrect functionality or panics."

   558 stringPool[ "rssnames!ideTitle" ]    = "duplicate RSS names"

   559 

   560 # localised string for Script stringliterals

   561 stringPool[ "stringliterals!title" ]       = "Use of _L string literals"

   562 stringPool[ "stringliterals!description" ] = "_L() string literals should be replaced by the _LIT() macro."

   563 stringPool[ "stringliterals!ideTitle" ]    = "use of _L string literals"

   564 

   565 # localised string for Script stringsinresourcefiles

   566 stringPool[ "stringsinresourcefiles!title" ]       = "Strings in RSS or RA files"

   567 stringPool[ "stringsinresourcefiles!description" ] = "Strings should not be defined in RSS or RA files. Instead, they should be put in RLS or other localisable files."

   568 stringPool[ "stringsinresourcefiles!ideTitle" ]    = "strings in RSS or RA files"

   569 

   570 # localised string for Script struct

   571 stringPool[ "struct!title" ]       = "Use of struct"

   572 stringPool[ "struct!description" ] = "C-style structs should not generally be used. The correct idiom is to use a class with public members. A permissible use of a C-style struct is if it is used to group non-semantically related entities together for convenience, and if a class-related hierarchy would be too heavy-weight."

   573 stringPool[ "struct!ideTitle" ]    = "use of struct"

   574 

   575 # localised string for Script tcclasses

   576 stringPool[ "tcclasses!title" ]       = "T classes inheriting from C classes"

   577 stringPool[ "tcclasses!description" ] = "T classes that are derived from C classes may have a complex constructor and so need to be handled differently. It is better to make the T class into a C class, which will make the code easier to maintain."

   578 stringPool[ "tcclasses!ideTitle" ]    = "T class inherits from C class"

   579 

   580 # localised string for Script tclassdestructor

   581 stringPool[ "tclassdestructor!title" ]       = "T class has destructor"

   582 stringPool[ "tclassdestructor!description" ] = "T classes should not have a destructor"

   583 stringPool[ "tclassdestructor!ideTitle" ]    = "T class has destructor"

   584 

   585 # localised string for Script todocomments

   586 stringPool[ "todocomments!title" ]       = "\"To do\" comments"

   587 stringPool[ "todocomments!description" ] = "\"To do\" comments in code suggest that it is not finished."

   588 stringPool[ "todocomments!ideTitle" ]    = "\"To do\" comment"

   589 

   590 # localised string for Script trapcleanup

   591 stringPool[ "trapcleanup!title" ]       = "Use of LC function in TRAPs"

   592 stringPool[ "trapcleanup!description" ] = "You cannot trap something that leaves something on the cleanup stack because it will panic."

   593 stringPool[ "trapcleanup!ideTitle" ]    = "LC function used in TRAP"

   594 

   595 # localised string for Script trapeleave

   596 stringPool[ "trapeleave!title" ]       = "Trapping new(ELeave)"

   597 stringPool[ "trapeleave!description" ] = "The trapping of a \"new(ELeave) CXxx\" call is redundant and wasteful as the code to support TRAP is surprisingly large. If the instantiation process really needs not to leave, use \"new CXxx\" and check for NULL."

   598 stringPool[ "trapeleave!ideTitle" ]    = "trapping new(ELeave)"

   599 

   600 # localised string for Script traprunl

   601 stringPool[ "traprunl!title" ]       = "Trapping of (Do)RunL() rather than using RunError()"

   602 stringPool[ "traprunl!description" ] = "The RunError() function should be used rather than the CActive derivative using its own TRAPD solution within a RunL()."

   603 stringPool[ "traprunl!ideTitle" ]    = "trapping of (Do)RunL() rather than using RunError()"

   604 

   605 # localised string for Script trspassing

   606 stringPool[ "trspassing!title" ]       = "Passing TRequestStatus parameters by value"

   607 stringPool[ "trspassing!description" ] = "TRequestStatus parameters should be passed by reference. If TRequestStatus is just being used as an error code, then convert it to a TInt."

   608 stringPool[ "trspassing!ideTitle" ]    = "passing TRequestStatus parameters by value"

   609 

   610 # localised string for Script uids

   611 stringPool[ "uids!title" ]       = "Duplicate UIDs"

   612 stringPool[ "uids!description" ] = "UIDs must be unique."

   613 stringPool[ "uids!ideTitle" ]    = "duplicate UIDs"

   614 

   615 # localised string for Script uncompressedaif

   616 stringPool[ "uncompressedaif!title" ]       = "Uncompressed AIFs in ROM"

   617 stringPool[ "uncompressedaif!description" ] = "AIF files should be referenced as \"AIF=\" rather than \"data=\" or \"file=\" otherwise they can bloat the ROM size and slow down application loading."

   618 stringPool[ "uncompressedaif!ideTitle" ]    = "uncompressed AIFs in ROM"

   619 

   620 # localised string for Script uncompressedbmp

   621 stringPool[ "uncompressedbmp!title" ]       = "Uncompressed bitmaps in ROM"

   622 stringPool[ "uncompressedbmp!description" ] = "Using uncompressed bitmaps can significantly bloat the size of ROM images. All occurrences of \"bitmap=\" in iby/hby files should be replaced with \"auto-bitmap=\". Also, including bitmaps using \"data=\" or \"file=\" causes bloat and load-speed reductions."

   623 stringPool[ "uncompressedbmp!ideTitle" ]    = "uncompressed bitmaps in ROM"

   624 

   625 # localised string for Script unicodesource

   626 stringPool[ "unicodesource!title" ]       = "Unicode source files"

   627 stringPool[ "unicodesource!description" ] = "Having Unicode source files (CPP, H, RLS, LOC, RSS, and RA) will break most build systems."

   628 stringPool[ "unicodesource!ideTitle" ]    = "Unicode source files"

   629 

   630 # localised string for Script userafter

   631 stringPool[ "userafter!title" ]       = "Use of User::After"

   632 stringPool[ "userafter!description" ] = "Generally, User::After() functions are used to skirt around timing problems. Typically, they should be removed and the defects fixed properly: that is, by waiting for the correct event to continue execution."

   633 stringPool[ "userafter!ideTitle" ]    = "use of User::After"

   634 

   635 # localised string for Script userfree

   636 stringPool[ "userfree!title" ]       = "Using User::Free directly"

   637 stringPool[ "userfree!description" ] = "User::Free() should never be called, because all objects free their memory on deletion; their destructors are not called and further resources cannot be freed or closed. This function should be removed and replaced by explicit deletes."

   638 stringPool[ "userfree!ideTitle" ]    = "using User::Free directly"

   639 

   640 # localised string for Script userWaitForRequest

   641 stringPool[ "userWaitForRequest!title" ]       = "Use of User::WaitForRequest"

   642 stringPool[ "userWaitForRequest!description" ] = "User::WaitForRequest() should not generally be used in UI code because the UI will not respond to redraw events while its thread is stopped."

   643 stringPool[ "userWaitForRequest!ideTitle" ]    = "use of User::WaitForRequest"

   644 

   645 # localised string for Script variablenames

   646 stringPool[ "variablenames!title" ]       = "Local variables with member/argument names"

   647 stringPool[ "variablenames!description" ] = "Local variable names should be of the form localVariable and not aLocalVar or iLocalVar. Badly-named variables can be misleading and cause maintenance and coding errors."

   648 stringPool[ "variablenames!ideTitle" ]    = "local variables with member/argument names"

   649 

   650 # localised string for Script voidparameter

   651 stringPool[ "voidparameter!title" ]       = "Void parameter explicitly declared"

   652 stringPool[ "voidparameter!description" ] = "Declaring a void parameter is unnecessary. A function declared as DoSomething(void) may as well be declared as DoSomething(). Void casts are also unnecessary."

   653 stringPool[ "voidparameter!ideTitle" ]    = "void parameter explicitly declared"

   654 

   655 # localised string for Script worryingcomments

   656 stringPool[ "worryingcomments!title" ]       = "Worrying comments"

   657 stringPool[ "worryingcomments!description" ] = "Typically, exclamation and question marks in comments indicate that something odd is in the code or that it is unfinished or not understood fully."

   658 stringPool[ "worryingcomments!ideTitle" ]    = "worrying comments"

   659 

   660 #!LOCALISEHERE

   661 

   662 def Usage(code, msg=""):

   663 	print msg

   664 	print

   665 	print KVersion

   666 	print

   667 	print "Usage: CodeScanner [options] <source dir> [<output dir>]"	

   668 	print "   or: CodeScanner [options] <source file> [<output dir>]"

   669 	print 

   670 	print "options:"

   671 	print "    -h - display command help"

   672 	print "    -v - display verbose messages"

   673 	print "    -c <config file> - use specified configuration file"

   674 	print "    -i <source dir/file> - specify additional directory/file to scan"

   675 	print "    -l <log file> - create debug log with specified filename"

   676 	print "    -o html|xml|std - specify output format : HTML, XML or StdOut; default is HTML"

   677 	print "    -x url to lxr site"

   678 	print "    -r lxr version"

   679 	print "    -t on/off - create a time-stamped directory for results, default is on"

   680 	print

   681 	print "<source dir> is the directory containing the source code to scan"

   682 	print "<source file> is the single file containing the source code to scan"

   683 	print "<output dir> is the directory in which to produce the output"

   684 	print

   685 	print "Notes:"

   686 	print "<source dir> and <output dir> cannot be identical"

   687 	print "<output dir> cannot be the root of a drive"

   688 	print

   689 	print KCopyrightLine1

   690 	print KCopyrightLine2

   691 	if scanner.iLog <> None:

   692 		scanner.iLog.Write("usage(): exiting with code " + str(code))

   693 		scanner.iLog.Close()

   694 	sys.exit(code)

   695 

   696 def DefaultCompare(aLines, aCurrentline, aRematch, aFilename):

   697 	if aRematch.search(aLines[aCurrentline]):

   698 		return 1

   699 	else:

   700 		return 0

   701 

   702 def DefaultFuncParamCompare(lines, currentline, rematch, filename):

   703 	# distinguish local declaration from function parameter

   704     line = lines[currentline]

   705     m = rematch.search(line)

   706     if m:

   707         isFuncParam = (line.find(")") <> -1)

   708         isLocal = (line.find(";") <> -1)

   709 

   710         while (not isFuncParam) and (not isLocal) and (currentline + 1 < len(lines)):

   711             currentline += 1

   712             line = lines[currentline]

   713             isFuncParam = (line.find(")") <> -1)

   714             isLocal = (line.find(";") <> -1)

   715 

   716         if isFuncParam:

   717             return 1

   718         elif isLocal:

   719             return 0

   720 

   721     return 0

   722 

   723 def ScanDirOrFile(argument):

   724 	if os.path.isdir(argument):

   725 		scanner.iComponentManager.SetRoot(argument)

   726 		scanner.TraverseDirectory(argument)

   727 	elif os.path.isfile(argument):

   728 		parentDir = os.path.dirname(argument)

   729 		scanner.iComponentManager.SetRoot(parentDir)

   730 		scanner.iComponentManager.BeginDirectory(parentDir)

   731 		numberOfLinesScanned = 0

   732 		numberOfLinesScanned += scanner.ScanFile(argument)

   733 		scanner.iComponentManager.EndDirectory(parentDir, numberOfLinesScanned)

   734 	else:

   735 		print "Unable to open specified source file: " + argument

   736 		sys.exit(2)

   737 

   738 

   739 class CScript:

   740 

   741 	# #######################################################

   742 	# CScript - a test script

   743 

   744 	def __init__(self, aScriptName):

   745 		self.iScriptName = aScriptName

   746 		self.iCompare = DefaultCompare

   747 		self.iReString = ""

   748 		self.iReMatch = re.compile("")

   749 		self.iTitle = stringPool[aScriptName + "!title"]

   750 		self.iIdeTitle = stringPool[aScriptName + "!ideTitle"]

   751 		self.iFileExts = []

   752 		self.iIgnore = KIgnoreNothing

   753 		self.iDescription = stringPool[aScriptName + "!description"]

   754 		self.iSeverity = KSeverityMedium

   755 		self.iBaseClass = ""

   756 

   757 	def ScriptConfig(self):

   758 		if (scanner.iDomConfig <> None):

   759 			for scriptsNode in scanner.iDomConfig.getElementsByTagName("scripts"):

   760 				for scriptNode in scriptsNode.getElementsByTagName(self.iScriptName):

   761 					return scriptNode

   762 		return None

   763 	

   764 	def DefaultInheritanceCompare(self, lines, currentline, rematch, filename):

   765 		m = rematch.search(lines[currentline])

   766 		if m:

   767 			inheritanceString = m.group(3)

   768 			# check for inheritance list spanning multiple lines

   769 			i = currentline + 1

   770 			while (inheritanceString.find("{") == -1) and i < len(lines):

   771 				if (inheritanceString.find(";") <> -1):

   772 					return 0

   773 				inheritanceString += lines[i]

   774 				i += 1

   775 

   776 			# construct inheritance class list

   777 			inheritancelist = inheritanceString.split(",")

   778 			reclass = re.compile("[\s:]*(public|protected|private)?\s*([\w:]+)")

   779 			classlist = []

   780 			for inheritance in inheritancelist:

   781 				match = reclass.search(inheritance)

   782 				if match:

   783 					inheritclass = match.group(2)

   784 					colonpos = inheritclass.rfind(":")

   785 					if (colonpos <> -1):

   786 						inheritclass = inheritclass[colonpos + 1:]

   787 					classlist.append(inheritclass)

   788 

   789 			# search for inheritance class

   790 			for classname in classlist:

   791 				if classname == self.iBaseClass:

   792 					return 1

   793 

   794 		return 0

   795 

   796 

   797 class CCustomScript(CScript):

   798 

   799 	# #######################################################

   800 	# CScript - a test script based on a custom rule

   801 

   802 	def __init__(self, aScriptName):

   803 		self.iScriptName = aScriptName

   804 		self.iCompare = DefaultCompare

   805 		self.iReString = ""

   806 		self.iTitle = ""

   807 		self.iIdeTitle = ""

   808 		self.iFileExts = []

   809 		self.iIgnore = KIgnoreNothing

   810 		self.iDescription = ""

   811 

   812 

   813 class CCategorisedScripts:

   814 

   815 	# #######################################################

   816 	# CCategorisedScripts - a collection of scripts sorted

   817 	# by script category (panic, can panic, etc.)

   818 

   819 	def AddScript(self, aScript):

   820 		# do we have a category for this already?

   821 		category = aScript.iCategory

   822 		if (not self.iScripts.has_key(category)):

   823 			# no, create a linear array here

   824 			self.iScripts[category] = []

   825 

   826 		# append to the correct category

   827 		self.iScripts[category].append(aScript)

   828 

   829 		# compile the reg-ex otherwise will get continuous hits

   830 		aScript.iReMatch = re.compile(aScript.iReString, re.VERBOSE)

   831 

   832 	def AllScripts(self):

   833 		result = []

   834 		for scripts in self.iScripts.values():

   835 			result += scripts

   836 

   837 		return result

   838 

   839 	def PrintListOfTestScripts(self):

   840 		for category in self.iScripts.keys():

   841 			print(category + "\n----------------------------------")

   842 			for script in self.iScripts[category]:

   843 				print("\t" + script.iScriptName)

   844 

   845 		print("")

   846 

   847 	# iScripts is a 2D array, 1st level is a hash of categories

   848 	#                         2nd level is linear array

   849 	iScripts = {}        

   850 

   851 class CLogger:

   852 

   853 	# #######################################################

   854 	# CLogger

   855 	# a simple log file interface

   856 

   857 	def __init__(self, aFilename):

   858 		if aFilename != None and len(aFilename) > 0:

   859 			self.iFile = file(aFilename, "w")

   860 			self.iFile.write(KVersion + " started at " + datetime.datetime.now().ctime() + "\n")

   861 		else:

   862 			self.iFile = None

   863 

   864 	def Write(self, aText):

   865 		if self.iFile <> None:

   866 			self.iFile.write(str(datetime.datetime.now().time())+":"+aText+"\n")

   867 			self.iFile.flush()

   868 

   869 	def Close(self):

   870 		if self.iFile <> None:

   871 			self.iFile.write(KVersion + " ended at " + datetime.datetime.now().ctime() + "\n")

   872 			self.iFile.close()

   873 

   874 

   875 class CRendererBase:

   876 

   877 	# #######################################################

   878 	# CRendererBase - base class for renderers

   879 

   880 	def RegisterSelf(self, aName, aDescription, aRendererManager):

   881 		self.iName = aName

   882 		self.iDescription = aDescription

   883 		aRendererManager.AddRenderer(self)

   884 	def BeginComponent(self, aComponent):

   885 		return

   886 	def BeginFile(self, aFilename):

   887 		return

   888 	def ReportError(self, aLineContext, aScript):

   889 		return

   890 	def EndFile(self):

   891 		return

   892 	def EndComponent(self, aComponent):

   893 		return

   894 

   895 

   896 class CStdOutRenderer(CRendererBase):

   897 

   898 	# #######################################################

   899 	# CStdOutRenderer - renderer for Standard Console Output

   900 	# Output goes to standard output; when run in Carbide, 

   901 	# this shows up in the output window. Correctly formatted 

   902 	# lines can then be selected, automatically selecting 

   903 	# the corresponding line of the associated source file. 

   904 	# The format is:

   905 	#   <filename>(<line>) : <comment>

   906 

   907 	def __init__(self, aRendererManager):

   908 		self.RegisterSelf("stdout", "StdOut renderer", aRendererManager)

   909 		print KVersion

   910 

   911 	def BeginComponent(self, aComponent):

   912 		return

   913 

   914 	def BeginFile(self, aFilename):

   915 		self.iErrorCount = 0

   916 		scanner.ReportAction("Scanning file " + aFilename)

   917 

   918 	def ReportError(self, aLineContext, aScript):

   919 		self.iErrorCount += 1

   920 		if (aScript.iSeverity == KSeverityLow):

   921 			msgType = "info"

   922 		elif (aScript.iSeverity == KSeverityMedium):

   923 			msgType = "warning"

   924 		elif (aScript.iSeverity == KSeverityHigh):

   925 			msgType = "error"

   926 		print(aLineContext.iFileName + "(" + str(aLineContext.iLineNumber) + ") : " + msgType + ": " + aScript.iScriptName + ": " + KSeverityConfigMap[aScript.iSeverity] + ": " + KCategoryConfigMap[aScript.iCategory] + ": " + aScript.iIdeTitle)

   927 		if len(scanner.iRendererManager.iAnnotation)>0:

   928 			print scanner.iRendererManager.iAnnotation

   929 			scanner.iRendererManager.iAnnotation = ""

   930 

   931 	def EndFile(self):

   932 		scanner.ReportAction("Total problems found in file: " + str(self.iErrorCount))

   933 

   934 	def EndComponent(self, aComponent):

   935 		scanner.iEndTime = datetime.datetime.now().ctime()

   936 		return

   937 

   938 

   939 class CXmlComponentSummaryFile:

   940 	# #########################################################

   941 	# CXmlComponentSummaryFile

   942 	# Encapsulates the script (problem) summary for XML output.

   943 	# For each script, there is a listing for occurrences

   944 	# of that script's problem and location of each occurrence.

   945 

   946 	def CreateSummary(self, aXmlRenderer):

   947 		try:

   948 			outputPath = os.path.normpath(os.path.join(aXmlRenderer.iOutputDirectory, "problemIndex.xml"))

   949 			outputFile = file(outputPath, "w")

   950 		except IOError:

   951 			scanner.ReportError("IOError : Unable to create output file " + outputPath)

   952 		else:

   953 			errors = aXmlRenderer.iErrors

   954 			level = 0

   955 			indent = "   "

   956 			outputFile.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")

   957 			outputFile.write(level * indent + "<problemIndex>\n")

   958 			level += 1

   959 			for category in KCategoryHtmlDisplayOrder:

   960 				found = False

   961 				if scanner.iCategoriedScripts.iScripts.has_key(category):

   962 					for script in scanner.iCategoriedScripts.iScripts[category]:

   963 						if errors.has_key(script.iScriptName):

   964 							found = True

   965 							break

   966 					if found:

   967 						outputFile.write(level * indent + "<category")

   968 						outputFile.write(" name=\"" + KCategoryConfigMap[category] + "\">\n")

   969 						level += 1

   970 						for script in scanner.iCategoriedScripts.iScripts[category]:

   971 							if errors.has_key(script.iScriptName):

   972 								outputFile.write(level * indent + "<problem")

   973 								outputFile.write(" name=\"" + script.iScriptName + "\"")

   974 								outputFile.write(" severity=\"" + KSeverityConfigMap[script.iSeverity] + "\">\n")

   975 								level += 1

   976 								for fileName, lines in errors[script.iScriptName].items():

   977 									outputFile.write(level * indent + "<file")

   978 									outputFile.write(" path=\"" + fileName + "\">\n")

   979 									level += 1

   980 									for lineNo in lines:

   981 										outputFile.write(level * indent + str(lineNo) + "\n")

   982 									level -= 1

   983 									outputFile.write(level * indent + "</file>\n")

   984 								level -= 1

   985 								outputFile.write(level * indent + "</problem>\n")

   986 						level -= 1

   987 						outputFile.write(level * indent + "</category>\n")

   988 			level -= 1

   989 			outputFile.write(level * indent + "</problemIndex>\n")

   990 			outputFile.close()

   991 

   992 

   993 class CXmlRenderer(CRendererBase):

   994 

   995 	# ########################################

   996 	# CXmlRenderer - a renderer for XML output

   997 

   998 	def __init__(self, aRendererManager, aOutputDirectory):

   999 		self.RegisterSelf("xml", "XML renderer", aRendererManager)

  1000 		self.iOutputDirectory = aOutputDirectory

  1001 		if os.path.isdir(self.iOutputDirectory) != True :

  1002 			os.makedirs(self.iOutputDirectory)

  1003 		self.iErrors = {} 

  1004 		print

  1005 		print KVersion

  1006 		print KCopyrightLine1

  1007 		print KCopyrightLine2

  1008 

  1009 	def BeginComponent(self, aComponent):

  1010 		return

  1011 

  1012 	def BeginFile(self, aFilename):

  1013 		self.iFilename = aFilename

  1014 		scanner.ReportAction("Scanning file " + aFilename)

  1015 

  1016 	def ReportError(self, aLineContext, aScript):

  1017 		scriptName = aScript.iScriptName

  1018 		fileName = aLineContext.iFileName

  1019 		lineNumber = aLineContext.iLineNumber

  1020 		if (not self.iErrors.has_key(scriptName)):

  1021 			self.iErrors[scriptName] = {}

  1022 		if (not self.iErrors[scriptName].has_key(fileName)):

  1023 			self.iErrors[scriptName][fileName] = []

  1024 		self.iErrors[scriptName][fileName].append(lineNumber)

  1025 

  1026 	def EndFile(self):

  1027 		#tbd

  1028 		return

  1029 

  1030 	def EndComponent(self, aComponent):

  1031 		relativeComponentName = scanner.iComponentManager.RelativeComponentName(aComponent.iFullPath)

  1032 		if len(relativeComponentName) < 1:	# root component - final component

  1033 			scanner.iEndTime = datetime.datetime.now().ctime()

  1034 			componentSummaryFile = CXmlComponentSummaryFile()

  1035 			componentSummaryFile.CreateSummary(self)

  1036 

  1037 

  1038 class CHtmlOutputFileBase:

  1039 

  1040 	# #######################################################

  1041 	# CHtmlOutputFileBase - base class for HTML output files

  1042 

  1043 	def WriteHeader(self, aOutputFile):

  1044 		aOutputFile.write("<html><body>")

  1045 

  1046 	def Write(self, aOutputFile, aText):

  1047 		aOutputFile.write(aText)

  1048 

  1049 	def WriteLink(self, aOutputFile, aHref, aText):

  1050 		aHref = self.CleanupLink(aHref)

  1051 		aOutputFile.write("<a href=\"" + aHref + "\">" + aText + "</a>")

  1052 

  1053 	def WriteElement(self, aOutputFile, aElementName, aElementValue):

  1054 		aOutputFile.write("<"+aElementName+">"+aElementValue+"</"+aElementName+">")

  1055 

  1056 	def WriteBreak(self, aOutputFile):

  1057 		aOutputFile.write("<br>")

  1058 

  1059 	def WriteFooter(self, aOutputFile):

  1060 		aOutputFile.write("<br><hr><center><h5>"+KCopyrightLine1Html+"</h5>")

  1061 		aOutputFile.write("<h5>")

  1062 		CHtmlOutputFileBase.WriteLink(self, aOutputFile, "http://"+KWww, KWww)

  1063 		aOutputFile.write("</h5></center></body></html>")

  1064 

  1065 	def CleanupLink(self, aHref):

  1066 		# Mozilla Firefox does not handle link with the '#' character correctly, 

  1067 		# so we need to replace it with the equivalent URL encoding "%23"

  1068 		aHref = aHref.replace("#", "%23")

  1069 		# Mozilla Firefox sometimes does not handle link with '\' correctly,

  1070 		# so we need to replace it with '/'

  1071 		aHref = aHref.replace('\\', '/')

  1072 		return aHref

  1073 

  1074 

  1075 class CHtmlOutputFile(CHtmlOutputFileBase):

  1076 

  1077 	# #######################################################

  1078 	# CHtmlOutputFile - simplified access to HTML output file

  1079 

  1080 	def __init__(self, aOutputPath):

  1081 		if not os.path.isdir(os.path.dirname(aOutputPath)):

  1082 			os.makedirs(os.path.dirname(aOutputPath))

  1083 		self.iOutputFile = file(aOutputPath, "w")

  1084 		self.WriteHeader(self.iOutputFile)

  1085 

  1086 	def Write(self, aText):

  1087 		CHtmlOutputFileBase.Write(self, self.iOutputFile, aText)

  1088 

  1089 	def WriteLink(self, aHref, aText):

  1090 		CHtmlOutputFileBase.WriteLink(self, self.iOutputFile, aHref, aText)

  1091 

  1092 	def WriteElement(self, aElementName, aElementValue):

  1093 		CHtmlOutputFileBase.WriteElement(self, self.iOutputFile, aElementName, aElementValue)

  1094 

  1095 	def WriteBreak(self):

  1096 		CHtmlOutputFileBase.WriteBreak(self, self.iOutputFile)

  1097 		

  1098 	def Close(self):

  1099 		self.WriteFooter(self.iOutputFile)

  1100 		self.iOutputFile.close()

  1101 

  1102 

  1103 class CHtmlComponentSummaryFiles:

  1104 

  1105 	# #######################################################

  1106 	# CHtmlComponentSummaryFiles

  1107 	# Encapsulates the component summary files for HTML output.

  1108 	# For each component, there is a component report file listing the number 

  1109 	# of occurrences of each problem type. There is also a single index or 

  1110 	# summary file with links to each of the component report files.

  1111 

  1112 	def CreateSummaries(self, aHtmlRenderer, aOutputDirectory):

  1113 		totalErrorCount = 0

  1114 		outputPath = os.path.normpath(os.path.join(aOutputDirectory, "componentIndex.html"))

  1115 		componentSummaryFile = CHtmlOutputFile(outputPath)

  1116 		componentSummaryFile.Write("<font face=verdana>")

  1117 		componentSummaryFile.WriteElement("h2", "Component Summary")

  1118 		componentSummaryFile.Write("Source: "+scanner.iSource)

  1119 		componentSummaryFile.WriteBreak()

  1120 		componentSummaryFile.Write("Scan started at:   " + scanner.iStartTime)

  1121 		componentSummaryFile.WriteBreak()

  1122 		componentSummaryFile.Write("Scan completed at: " + scanner.iEndTime)

  1123 		componentSummaryFile.WriteBreak()

  1124 		componentSummaryFile.WriteBreak()

  1125 		componentSummaryFile.WriteLink("problemIndex.html", "View problems by type")

  1126 		componentSummaryFile.WriteBreak()

  1127 		componentSummaryFile.Write("<hr>")

  1128 		componentSummaryFile.WriteBreak()

  1129 		componentSummaryFile.Write("<table border=\"1\" width=\"100%\">")

  1130 		componentSummaryFile.Write("<tr bgcolor=\"#0099ff\">")

  1131 		componentSummaryFile.WriteElement("th width=\"75%\"", "Component")

  1132 		componentSummaryFile.WriteElement("th", "Items Found")

  1133 		componentSummaryFile.WriteElement("th", "Lines of Code")

  1134 		componentSummaryFile.WriteElement("th", "Possible Defects/KLOC")

  1135 		componentSummaryFile.Write("</tr>")