contrib/pep8analysis/www/index.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4         <title>Pep/8 Analysis</title>
   5
   6     <meta charset="utf-8">
   7     <meta http-equiv="X-UA-Compatible" content="IE=edge">
   8         <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
   9
  10         <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
  11         <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
  12         <script src="//netdna.bootstrapcdn.com/bootstrap/3.0.0/js/bootstrap.min.js"></script>
  13
  14         <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/codemirror/4.2.0/codemirror.css">
  15         <script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/4.2.0/codemirror.min.js"></script>
  16         <script src="//cdnjs.cloudflare.com/ajax/libs/codemirror/4.2.0/mode/z80/z80.js"></script>
  17
  18         <script>
  19
  20                 var _gaq = _gaq || [];
  21                 _gaq.push(['_setAccount', 'UA-574578-5']);
  22                 _gaq.push(['_trackPageview']);
  23
  24                 (function() {
  25                         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  26                         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  27                         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  28                 })();
  29
  30                 // Both Viz and Pep8 use emscripten
  31                 // We put aside the module of each program and bring it back before each use
  32                 var VizModule = null
  33
  34                 function ready() {
  35                         $("#loading").hide()
  36                         $("#analyze").prop('disabled', false)
  37                 }
  38
  39                 function complete() {
  40                         // Show and set color of output console
  41                         $("#consolePanel").removeClass("panel-success panel-warning panel-danger")
  42                         var analysis = $("#console").text();
  43                         if (analysis.indexOf("Error") >= 0) {
  44                                 $("#consolePanel").addClass("panel-danger")
  45                                 _gaq.push(['_trackEvent', 'Result', 'Error'])
  46                         }
  47                         else if (analysis.indexOf("Warning") >= 0) {
  48                                 $("#consolePanel").addClass("panel-warning")
  49                                 _gaq.push(['_trackEvent', 'Result', 'Warning'])
  50                         }
  51                         else {
  52                                 $("#consolePanel").addClass("panel-success")
  53                                 _gaq.push(['_trackEvent', 'Result', 'Success'])
  54                         }
  55                         $("#working").hide()
  56                         $("#consolePanel").show()
  57                         $("#analyze").prop('disabled', false)
  58                 }
  59
  60                 function exception(ex) {
  61                         console.debug("Tool invocation failed, with:\n" + $("#console").text() + "\n" + ex )
  62                         _gaq.push(['_trackEvent', 'Bug', 'Analysis', $("#console").text()])
  63                         $("#fatal-error").show()
  64                         $("#analyze").prop('disabled', true)
  65                 }
  66
  67                 function stdout(text) {
  68                         $("#console").append(text + "<br>")
  69                 }
  70
  71                 function exec() {
  72                         $("#working").show()
  73                         $("#consolePanel").hide()
  74
  75                         // Clean output console
  76                         $("#console").text("")
  77
  78                         // Get code
  79                         var input = editor.getValue()
  80
  81                         // Update GA stats
  82                         _gaq.push(['_trackEvent', 'Action', 'Analyze'])
  83
  84                         // Invoke the full Nit program
  85                         if(typeof(Worker) !== "undefined") {
  86                                 // Async version
  87                                 $("#analyze").prop('disabled', true)
  88                                 worker.postMessage(input)
  89                         } else {
  90                                 // Sync version
  91                                 _gaq.push(['_trackEvent', 'Bug', 'No Webworkers', $("#console").text()])
  92                                 Module = Pep8Module
  93                                 try {
  94                                         run_analysis = Module.cwrap('pep8analysis_web___NativeString_run_analysis', null, ['string'])
  95                                         run_analysis(input)
  96
  97                                         complete()
  98                                 } catch(e) {
  99                                         exception(e)
 100                                 }
 101                         }
 102                 }
 103
 104                 function load(file) {
 105                         // Load a sample program
 106                         $.get('samples/' + file, function(data){
 107                                 editor.setValue(data)
 108                         })
 109                 }
 110
 111                 function show_graph(source) {
 112                         Module = VizModule
 113                         var res = Viz(source, "svg", "dot")
 114                         VizModule = Module
 115                         $("#graph").html(res)
 116                 }
 117         </script>
 118 </head>
 119 <body>
 120
 121 <nav class="navbar navbar-default" role="navigation">
 122   <div class="container-fluid">
 123     <div class="navbar-header">
 124       <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
 125         <span class="sr-only">Toggle navigation</span>
 126                 <span class="icon-bar"></span>
 127                 <span class="icon-bar"></span>
 128                 <span class="icon-bar"></span>
 129       </button>
 130       <a class="navbar-brand">Pep/8 Analysis</a>
 131     </div>
 132
 133     <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
 134       <ul class="nav navbar-nav">
 135         <li class="active"><a>Web interface</a></li>
 136         <li><a href="https://github.com/privat/nit/tree/master/contrib/pep8analysis/">Tool source and manual</a></li>
 137       </ul>
 138       <ul class="nav navbar-nav navbar-right">
 139         <li><a href="http://nitlanguage.org/">nitlanguage.org</a></li>
 140         <li><a href="https://code.google.com/p/pep8-1/">Pep/8 project</a></li>
 141       </ul>
 142     </div>
 143   </div>
 144 </nav>
 145
 146 <div class="container-fluid">
 147         <div class="alert alert-warning" id="loading">Loading the tool... This may take some time.</div>
 148         <div class="alert alert-danger" id="fatal-error" style="display: none;">
 149                 <h2>The JavaScript tool crashed</h2>
 150                 <p>Please refresh the page to try again, or use Firefox. An error report has been sent to the developer</p>
 151         </div>
 152
 153         <div class="row">
 154           <div class="col-sm-12 col-lg-6">
 155                 <div class="panel panel-default" id="panelIntro">
 156                         <div class="panel-heading">Description and Usage
 157                                 <button type="button" class="close" onClick="$('#panelIntro').hide()" aria-hidden="true">&times;</button>
 158                         </div>
 159                         <div class="panel-body" id="code-panel">
 160                                 <p>This tools finds strange behavior in Pep/8 programs by exploring all detectable execution paths.</p>
 161                                 <p>Upon analyzing a program, this tool reports dead code blocks and data within the execution path. It also detects wrongful use of data such as accessing uninitialized memory, printing a word and reading code.</p>
 162                                 <p><strong>To use:</strong> copy-paste your code in the source code block and launch the analysis using the <em>Analyze program</em> button.</p>
 163                         </div>
 164                 </div>
 165
 166                 <div class="panel panel-default">
 167                         <div class="panel-heading">Pep/8 Source Code</div>
 168                         <div class="panel-body" id="code-panel">
 169                                 <textarea id="listing"></textarea>
 170                                 <script>
 171                                         var editor = CodeMirror.fromTextArea(listing, {
 172                                                 lineNumbers: true,
 173                                                 mode: "z80"
 174                                         });
 175                                         editor.setSize("100%", 500);
 176                                 </script>
 177
 178                                 <div class="btn-group">
 179                                   <button type="button" class="btn btn-default" id="analyze" onclick="exec();" disabled>Analyze program</button>
 180                                   <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
 181                                          <span class="glyphicon glyphicon-folder-open"></span>
 182                                         Load sample program
 183                                         <span class="caret"></span>
 184                                   </button>
 185                                   <ul class="dropdown-menu">
 186                                         <li><a onclick="load('02-fibo.pep')">fibo.pep - clean program </a></li>
 187                                         <li><a onclick="load('06-calc-non-pur.pep');">calc-non-pur.pep - self rewriting program </a></li>
 188                                         <li><a onclick="load('types.pep');"/>types.pep - strange data manipulation </a></li>
 189                                         <li><a onclick="load('directive-in-code.pep');">directive-in-code.pep - mixed directives and instructions</a></li>
 190                                   </ul>
 191                                 </div>
 192                         </div>
 193                 </div>
 194           </div>
 195
 196           <div class="clearfix visible-xs"></div>
 197           <div class="col-sm-12 col-lg-6">
 198                 <div class="alert alert-warning" id="working" style="display: none;">The tool is evaluating all possible execution paths... This may take some time.</div>
 199                 <div class="panel" id="consolePanel" style="display: none;">
 200                         <div class="panel-heading">Analysis Result</div>
 201                         <div class="panel-body">
 202                                 <samp id="console"></samp>
 203                                 <button type="button" class="btn btn-default" onclick="$('#panelGraph').show();$('#panelGraphExp').show();">
 204                                         Show control flow graph</button>
 205                                 <em class="pull-right" id="panelGraphExp" style="display: none;">The graph is at the bottom of the page...</em>
 206                         </div>
 207                 </div>
 208           </div>
 209
 210           <div class="col-sm-12 col-lg-6">
 211                 <div class="panel panel-default" id="panelRef">
 212                         <div class="panel-heading">Output Documentation
 213                                 <button type="button" class="close" onClick="$('#panelRef').hide()" aria-hidden="true">&times;</button>
 214                         </div>
 215                         <div class="panel-body" id="code-panel">
 216                                 <h4>Line and memory references</h4>
 217                                 <p>Shorthand are used in the error messages, some refer directly to the line numbers others to the address in the memory of the running program.</p>
 218                                 <table class="table table-striped">
 219                                 <tr>
 220                                         <th>Shorthand</th>
 221                                         <th>Description</th>
 222                                 </tr><tr>
 223                                         <td>web:5</td>
 224                                         <td>Source line 5</td>
 225                                 </tr><tr>
 226                                         <td>L8</td>
 227                                         <td>Source line 8</td>
 228                                 </tr><tr>
 229                                         <td>rA, rX</td>
 230                                         <td>Registers A, X</td>
 231                                 </tr><tr>
 232                                         <td>m24</td>
 233                                         <td>Memory at address 24 (bytes)</td>
 234                                 </tr><tr>
 235                                         <td>instr@m24</td>
 236                                         <td>Intruction at address 24 (bytes). Usually, this would be the (24/4+1=) 7th instruction, if there is no data blocks. And the 7th line if there is no data blocks or comments.</td>
 237                                 </tr>
 238                                 </table>
 239
 240                                 <h4>Common errors and warnings</h4>
 241
 242                                 <p>Note that the tool reports <em>possible</em> errors and strange behaviors. For an advanced or expert user, it may raise errors on correct code.</p>
 243
 244                                 <table class="table table-striped">
 245                                 <tr>
 246                                         <th>Error</th>
 247                                         <th>Meaning</th>
 248                                 </tr><tr>
 249                                         <td>... the CFG may be wrong</td>
 250                                         <td>The program structure is too complex to analyze. This happens when jumping to dynamic addresses and when using switch statements.</td>
 251                                 </tr><tr>
 252                                         <td>unreachable instructions</td>
 253                                         <td>There's dead code.</td>
 254                                 </tr><tr>
 255                                         <td>data in program flow</td>
 256                                         <td>The program may execute raw data. There's probably a <code>BR</code> missing.</td>
 257                                 </tr><tr>
 258                                         <td>overwriting code at...</td>
 259                                         <td>An instruction writes over an existing instruction (probably your code).</td>
 260                                 </tr><tr>
 261                                         <td>expected "type" in "address", got "something"</td>
 262                                         <td>An instruction uses data with an unexepected type. It may be a <code>CHARO</code> using something other than a char. Or a copy of uninitialized data over an initialized word.<br>
 263                                         </td>
 264                                 </tr>
 265                                 </table>
 266                         </div>
 267                 </div>
 268           </div>
 269         </div>
 270
 271           <div class="col-sm-12 col-lg-12">
 272                 <div class="panel panel-default" id="panelGraph" style="display: none;">
 273                         <div class="panel-heading">Control Flow Graph (CFG)
 274                                 <button type="button" class="close" onClick="$('#panelGraph').hide()" aria-hidden="true">&times;</button>
 275                         </div>
 276                         <div class="panel-body">
 277                                 <div id="graph"></div>
 278                         </div>
 279                 </div>
 280           </div>
 281
 282         <script>
 283                 if(typeof(Worker) !== "undefined") {
 284                         // Async version
 285                         var worker = new Worker("worker.js")
 286                         worker.onmessage = function(event) {
 287                                 if (event.data.type == "ready") {
 288                                         ready()
 289                                 } else if (event.data.type == "complete") {
 290                                         complete()
 291                                 } else if (event.data.type == "exception") {
 292                                         exception(event.data.data)
 293                                 } else if (event.data.type == "stdout") {
 294                                         stdout(event.data.data)
 295                                 } else if (event.data.type == "show_graph") {
 296                                         show_graph(event.data.data)
 297                                 } else {
 298                                         console.out(event.data)
 299                                 }
 300                         }
 301                 } else {
 302                         // Synced version
 303                         $(document).ready(function() {
 304                                 // Report full loading
 305                                 $("#loading").hide()
 306                                 $("#analyze").prop('disabled', false)
 307                         });
 308                         var Module = {
 309                                 'print': stdout,
 310                                 'TOTAL_MEMORY': 512000000
 311                         }
 312                         importScripts("pep8analysis.js")
 313                         var Pep8Module = Module
 314                 }
 315         </script>
 316         <script src="viz.js"></script>
 317 </div>
 318
 319 </body>
 320 </html>