srcanamdw/codescanner/renderers_poc/renderer.py
author noe\swadi
Thu, 18 Feb 2010 12:29:02 +0530
changeset 1 22878952f6e2
permissions -rw-r--r--
Committing the CodeScanner Core tool This component has been moved from the StaticAnaApps package. BUG : 5889 (http://developer.symbian.org/webbugs/show_bug.cgi?id=5889).
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     1
# #################################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     2
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     3
# All rights reserved.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     4
# 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     5
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     6
# 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     7
# * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     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.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
     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.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    10
# 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    11
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    12
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    13
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    14
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    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.#
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    16
#
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    17
# #################################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    18
#!/usr/bin/python
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    19
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    20
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    21
# experimentation
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    22
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    23
# #############################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    24
class CRendererBase:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    25
    def RegisterSelf( self, aName, aDescription, aRendererManager ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    26
        self.iName = aName
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    27
        self.iDescription = aDescription
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    28
        aRendererManager.AddRenderer( self )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    29
        
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    30
    def DoBeginTest( self, aTestName ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    31
        return
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    32
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    33
    def DoEndTest( self, aTestName ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    34
        return
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    35
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    36
    def DoReportError( self, aFile, aLine, aResult ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    37
        return
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    38
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    39
    iName = "CRendererBase!"
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    40
    iDescription = ""
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    41
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    42
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    43
class CRendererManager:
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    44
    def __init__( self ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    45
        # declare associative list of renderers
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    46
        self.iRendererList = {}
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    47
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    48
    def AddRenderer( self, aRenderer ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    49
        self.iRendererList[ aRenderer.iName ] = aRenderer
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    50
        print( "Added " + aRenderer.iName )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    51
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    52
    def ListRenderers( self ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    53
        print( "Renderers:" )        
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    54
        for name, renderer in self.iRendererList.items():
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    55
            print( "\t" + name + "\t" + renderer.iDescription  )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    56
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    57
        print( "" )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    58
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    59
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    60
    def BeginTest( self, aTestName ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    61
        for name, renderer in self.iRendererList.items():
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    62
            renderer.DoBeginTest( aTestName )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    63
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    64
    def EndTest( self, aTestName ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    65
        for name, renderer in self.iRendererList.items():
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    66
            renderer.DoEndTest( aTestName )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    67
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    68
    def ReportError( self, aFile, aLine, aResult ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    69
        for name, renderer in self.iRendererList.items():
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    70
            renderer.DoReportError( aFile, aLine, aResult )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    71
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    72
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    73
# #############################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    74
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    75
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    76
# renderers are to be dropped in arbitarily, much like test scripts, images and embedded files
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    77
# rest of linescanners uses them via the RendererManager instance.
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    78
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    79
# #############################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    80
class CHtmlRenderer( CRendererBase ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    81
    def __init__( self, aRendererManager ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    82
        self.RegisterSelf( "html", "Classic CodeScanner browsable HTML tree", aRendererManager )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    83
        
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    84
    def DoBeginTest( self, aTestName ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    85
        self.iFileHandle = open( aTestName + ".html", "w" )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    86
        self.iFileHandle.write( "<html>\n<body>\n<h1>" + aTestName + "</h1>\n" )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    87
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    88
    def DoEndTest( self, aTestName ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    89
        self.iFileHandle.write( "</body>\n</html>\n" )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    90
        self.iFileHandle.close()
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    91
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    92
    def DoReportError( self, aFile, aLine, aResult ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    93
        self.iFileHandle.write( "<i>" + aResult + "</i> at " + str( aLine ) + "<br/>\n" )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    94
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    95
# #############################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    96
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    97
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    98
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
    99
# #############################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   100
class CMsdevRenderer( CRendererBase ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   101
    def __init__( self, aRendererManager ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   102
        self.RegisterSelf( "msdev", "Classic MIScan plugin for MSDEV", aRendererManager )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   103
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   104
    def DoBeginTest( self, aTestName ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   105
        self.iErrorCount = 0
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   106
        return
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   107
    
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   108
    def DoEndTest( self, aTestName ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   109
        print( "\n\n" + str( self.iErrorCount ) + " total errors" )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   110
        return
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   111
    
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   112
    def DoReportError( self, aFile, aLine, aResult ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   113
        self.iErrorCount += 1
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   114
        # :\Series60Ex\menu\src\aknexmenusubcontainer.cpp(126) : warning: to do comment
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   115
        print( aFile + "(" + str( aLine ) + ") : " + aResult )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   116
    
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   117
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   118
# #############################################################
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   119
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   120
# objects register themselves with rendererManager
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   121
rendererManager = CRendererManager()
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   122
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   123
CHtmlRenderer( rendererManager )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   124
CMsdevRenderer( rendererManager )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   125
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   126
rendererManager.ListRenderers()
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   127
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   128
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   129
errorCasesFiles = [ "moose.cpp",
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   130
                    "lama.cpp",
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   131
                    "underflow.cpp",
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   132
                    "wankers.cpp" ]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   133
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   134
errorCasesLines = [ 56,
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   135
                    23,
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   136
                    67,
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   137
                    42 ]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   138
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   139
errorCasesMessages = [ "moose farmer in field",
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   140
                       "lama shags sheep",
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   141
                       "out of budget",
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   142
                       "DELL are bad people" ]
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   143
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   144
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   145
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   146
rendererManager.BeginTest( "arbitarytest case" )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   147
for file, line, error in zip( errorCasesFiles, errorCasesLines, errorCasesMessages ):
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   148
    rendererManager.ReportError( file, line, error )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   149
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   150
rendererManager.EndTest( "test harness" )
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   151
    
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   152
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   153
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   154
22878952f6e2 Committing the CodeScanner Core tool
noe\swadi
parents:
diff changeset
   155