4 <title>Pep/
8 Analysis
</title>
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">
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>
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>
19 (function(i
,s
,o
,g
,r
,a
,m
){i
['GoogleAnalyticsObject']=r
;i
[r]=i
[r]||
function(){
20 (i
[r].q
=i
[r].q||
[]).push(arguments
)},i
[r].l
=1*new Date();a
=s
.createElement(o
),
21 m
=s
.getElementsByTagName(o
)[0];a
.async
=1;a
.src
=g
;m
.parentNode
.insertBefore(a
,m
)
22 })(window
,document
,'script','//www.google-analytics.com/analytics.js','ga');
24 ga('create', 'UA-574578-5', 'xymus.net');
25 ga('send', 'pageview');
27 // Both Viz and Pep8 use emscripten
28 // We put aside the module of each program and bring it back before each use
30 $
(document
).ready(function() {
31 // Report full loading
33 $
("#analyze").prop('disabled', false)
38 // Clean output console
39 $
("#console").text("")
42 var input
= editor
.getValue()
45 ga('trackEvent', 'Action', 'Analyze')
47 // Invoke the full Nit program
49 ret
= Module
['callMain']([input])
51 // Shot and set color of output console
52 $
("#consolePanel").removeClass("panel-success panel-warning panel-danger")
53 $
("#consolePanel").show()
54 var analysis
= $
("#consolePanel").text();
55 if (analysis
.indexOf("Error") >= 0) {
56 $
("#consolePanel").addClass("panel-danger")
57 ga('trackEvent', 'Result', 'Error')
59 else if (analysis
.indexOf("Warning") >= 0) {
60 $
("#consolePanel").addClass("panel-warning")
61 ga('trackEvent', 'Result', 'Warning')
64 $
("#consolePanel").addClass("panel-success")
65 ga('trackEvent', 'Result', 'Success')
70 // Load a sample program
71 $
.get('samples/' + file
, function(data
){
76 function show_graph(source
) {
78 var res
= Viz(source
, "svg", "dot")
86 <nav class=
"navbar navbar-default" role=
"navigation">
87 <div class=
"container-fluid">
88 <div class=
"navbar-header">
89 <button type=
"button" class=
"navbar-toggle" data-toggle=
"collapse" data-target=
"#bs-example-navbar-collapse-1">
90 <span class=
"sr-only">Toggle navigation
</span>
91 <span class=
"icon-bar"></span>
92 <span class=
"icon-bar"></span>
93 <span class=
"icon-bar"></span>
95 <a class=
"navbar-brand">Pep/
8 Analysis
</a>
98 <div class=
"collapse navbar-collapse" id=
"bs-example-navbar-collapse-1">
99 <ul class=
"nav navbar-nav">
100 <li class=
"active"><a>Web interface
</a></li>
101 <li><a href=
"https://github.com/privat/nit/tree/master/contrib/pep8analysis/">Tool source and manual
</a></li>
103 <ul class=
"nav navbar-nav navbar-right">
104 <li><a href=
"http://nitlanguage.org/">nitlanguage.org
</a></li>
105 <li><a href=
"https://code.google.com/p/pep8-1/">Pep/
8 project
</a></li>
111 <div class=
"container-fluid">
112 <div class=
"alert alert-warning" id=
"loading">Loading the tool... This may take some time.
</div>
115 <div class=
"col-sm-12 col-lg-6">
116 <div class=
"panel panel-default" id=
"panelIntro">
117 <div class=
"panel-heading">Description and Usage
118 <button type=
"button" class=
"close" onClick=
"$('#panelIntro').hide()" aria-hidden=
"true">×</button>
120 <div class=
"panel-body" id=
"code-panel">
121 <p>This tools finds strange behavior in Pep/
8 programs by exploring all detectable execution paths.
</p>
122 <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>
123 <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>
127 <div class=
"panel panel-default">
128 <div class=
"panel-heading">Pep/
8 Source Code
</div>
129 <div class=
"panel-body" id=
"code-panel">
130 <textarea id=
"listing"></textarea>
132 var editor
= CodeMirror
.fromTextArea(listing
, {
136 editor
.setSize("100%", 500);
139 <div class=
"btn-group">
140 <button type=
"button" class=
"btn btn-default" id=
"analyze" onclick=
"exec();" disabled
>Analyze program
</button>
141 <button type=
"button" class=
"btn btn-default dropdown-toggle" data-toggle=
"dropdown">
142 <span class=
"glyphicon glyphicon-folder-open"></span>
144 <span class=
"caret"></span>
146 <ul class=
"dropdown-menu">
147 <li><a onclick=
"load('02-fibo.pep')">fibo.pep - clean program
</a></li>
148 <li><a onclick=
"load('06-calc-non-pur.pep');">calc-non-pur.pep - self rewriting program
</a></li>
149 <li><a onclick=
"load('types.pep');"/>types.pep - strange data manipulation
</a></li>
150 <li><a onclick=
"load('directive-in-code.pep');">directive-in-code.pep - mixed directives and instructions
</a></li>
157 <div class=
"clearfix visible-xs"></div>
158 <div class=
"col-sm-12 col-lg-6">
159 <div class=
"panel" id=
"consolePanel" style=
"display: none;">
160 <div class=
"panel-heading">Analysis Result
</div>
161 <div class=
"panel-body">
162 <samp id=
"console"></samp>
163 <button type=
"button" class=
"btn btn-default" onclick=
"$('#panelGraph').show();$('#panelGraphExp').show();">
164 Show control flow graph
</button>
165 <em class=
"pull-right" id=
"panelGraphExp" style=
"display: none;">The graph is at the bottom of the page...
</em>
170 <div class=
"col-sm-12 col-lg-6">
171 <div class=
"panel panel-default" id=
"panelRef">
172 <div class=
"panel-heading">Output Documentation
173 <button type=
"button" class=
"close" onClick=
"$('#panelRef').hide()" aria-hidden=
"true">×</button>
175 <div class=
"panel-body" id=
"code-panel">
176 <h4>Line and memory references
</h4>
177 <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>
178 <table class=
"table table-striped">
184 <td>Source line
5</td>
187 <td>Source line
8</td>
190 <td>Registers A, X
</td>
193 <td>Memory at address
24 (bytes)
</td>
196 <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>
200 <h4>Common errors and warnings
</h4>
202 <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>
204 <table class=
"table table-striped">
209 <td>... the CFG may be wrong
</td>
210 <td>The program structure is too complex to analyze. This happens when jumping to dynamic addresses and when using switch statements.
</td>
212 <td>unreachable instructions
</td>
213 <td>There's dead code.
</td>
215 <td>data in program flow
</td>
216 <td>The program may execute raw data. There's probably a
<code>BR
</code> missing.
</td>
218 <td>overwriting code at...
</td>
219 <td>An instruction writes over an existing instruction (probably your code).
</td>
221 <td>expected
"type" in
"address", got
"something"</td>
222 <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>
231 <div class=
"col-sm-12 col-lg-12">
232 <div class=
"panel panel-default" id=
"panelGraph" style=
"display: none;">
233 <div class=
"panel-heading">Control Flow Graph (CFG)
234 <button type=
"button" class=
"close" onClick=
"$('#panelGraph').hide()" aria-hidden=
"true">×</button>
236 <div class=
"panel-body">
237 <div id=
"graph"></div>
244 'print': function(text
) {
245 $
("#console").append(text
+ "<br>")
247 'noInitialRun': true,
248 'TOTAL_MEMORY': 512000000
251 <script src=
"pep8analysis.js"></script>
252 <script>Pep8Module
= Module
</script>
253 <script src=
"viz.js"></script>