-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path2015-02-03-cloxp-capture.html
86 lines (84 loc) · 7.74 KB
/
2015-02-03-cloxp-capture.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<link href="/css/normalize.css" rel="stylesheet">
<link href="/css/skeleton.css" rel="stylesheet">
<link href="/css/default.css" rel="stylesheet">
<title>Capture to see</title>
<meta property="og:title" content="Capturing and inspecting values with cloxp">
<meta property="og:description" content="How to capture values for debugging and inspection using cloxp.">
<meta property="og:url" content="/2015-02-03-cloxp-capture.html">
<meta property="og:image" content="/images/cloxp-logo.jpg">
<link rel="shortcut icon" href="/favicon.ico">
<!-- link(href="/css/greeting.css" rel="stylesheet")-->
</head>
<body>
<div class="back-button"><a href="/">back</a></div>
<div class="content">
<div style="margin-bottom: 50px" class="container">
<div class="row">
<div class="offset-by-two eight columns"><h1 id="capture-to-see">Capture to see</h1>
<p>One reason why programming can be considered "hard" is the fact that programs by definition are build on abstractions. As much power as abstractions can bring: they can make it harder to actually <em>see</em> what happens in programs.</p>
<p>Take the object-oriented concept of classes as an example. A class serves as a description of objects<sup>*</sup>. First when a class gets instantiated it produces an actual thing whose state can be inspected and whose behavior observed. One big contribution of the Self language was to show how much more direct and straightforward programming becomes when prototypical inheritance (no abstract classes anymore) is paired with tools that allow to <a href="http://www.selflanguage.org/_static/published/self4.0UserInterface.pdf">directly interact with objects</a>.</p>
<p>No matter which programming methodology you subscribe to, the programming language and the tools you use should make it easy for you to understand and <em>see</em> what happens in the programs you write. Playing interpreter is not our strong side, computers are much better at that!</p>
<p><small><sup>*</sup> Even if your programming language has first-class classes (as it should).</small></p>
<h3 id="capturing-clojure-state-with-cloxp">Capturing Clojure state with cloxp</h3>
<p>One feature of cloxp is to instrument expressions and capture the values they produce over time. In its essence this is actually not more than libraries like <a href="https://github.com/clojure/tools.trace">tools.trace</a> or <a href="https://github.com/dgrnbrg/spyscope">spyscope</a> provide. However, building this feature into a rich environment such as the one cloxp provides allows </p>
<p>a) to easily instrument multiple locations and arrange the gathered data in a way that allows to compare it and to stay on top of things</p>
<p>b) to access the gathered data directly, for example to inspect it further</p>
<p>Here is how it works. Inside a function you select a sub expression for capturing. From that point on a small annotation that appears on all views of that function will show the last value that was captured:</p>
<div style="text-align: center; margin-left: -100px; margin-bottom: 120px;" class="video-wrapper">
<video style="display: inline-block;" width="820" height="460" controls="" autobuffer="autobuffer">
<source src="videos/cloxp-capture-1.mp4" type="video/mp4; codecs="avc1.42E01E, mp4a.40.2""/>
<source src="videos/cloxp-capture-1.oggtheora.ogv" type="video/ogg; codecs="theora, vorbis""/>
</video>
</div>
<p>By clicking on that annotation (or invoking a shortcut of you are a keyboard junkie) you can open up another workspaces that shows the captured values. Note that the captured data is still there, you can directly evaluate and inspect it:</p>
<div style="text-align: center; margin-left: -100px; margin-bottom: 120px;" class="video-wrapper">
<video style="display: inline-block;" width="820" height="460" controls="" autobuffer="autobuffer">
<source src="videos/cloxp-capture-2.mp4" type="video/mp4; codecs="avc1.42E01E, mp4a.40.2""/>
<source src="videos/cloxp-capture-2.oggtheora.ogv" type="video/ogg; codecs="theora, vorbis""/>
</video>
</div>
<p>This also works for asynchronous code:<small><br> (Note, by default only the last 30 captures are stored, this number can be increased if necessary.)</small></p>
<div style="text-align: center; margin-left: -100px; margin-bottom: 120px;" class="video-wrapper">
<video style="display: inline-block;" width="820" height="460" controls="" autobuffer="autobuffer">
<source src="videos/cloxp-capture-3.mp4" type="video/mp4; codecs="avc1.42E01E, mp4a.40.2""/>
<source src="videos/cloxp-capture-3.oggtheora.ogv" type="video/ogg; codecs="theora, vorbis""/>
</video>
</div>
<p>The feature is "real" and not just meant for the playground; it is no problem to instrument system-level code and code across namespaces. Ever wanted to see what's really going on in your Clojure image? Just ask it!<small><br> (Note, the function instrumented below is clojure.main/repl which itself is used continuously by cloxp, even (de)instrumenting depends on it. Yet, no interruption occurs.)</small></p>
<div style="text-align: center; margin-left: -100px; margin-bottom: 120px;" class="video-wrapper">
<video style="display: inline-block;" width="820" height="500" controls="" autobuffer="autobuffer">
<source src="videos/cloxp-capture-4.mp4" type="video/mp4; codecs="avc1.42E01E, mp4a.40.2""/>
<source src="videos/cloxp-capture-4.oggtheora.ogv" type="video/ogg; codecs="theora, vorbis""/>
</video>
</div>
<p>In order to stay on top of things you can get a summary of all captures:</p>
<div style="text-align: center; margin-left: -100px; margin-bottom: 120px;" class="video-wrapper">
<video style="display: inline-block;" width="820" height="460" controls="" autobuffer="autobuffer">
<source src="videos/cloxp-capture-5.mp4" type="video/mp4; codecs="avc1.42E01E, mp4a.40.2""/>
<source src="videos/cloxp-capture-5.oggtheora.ogv" type="video/ogg; codecs="theora, vorbis""/>
</video>
</div><p>Capturing values is one of the simplest ways to help you <em>see</em> what is actually happing in your code. By being able to directly access captured state you can directly find out what data your code deals with, making debugging much faster and direct and allowing you to peek through layers of abstractions.
Paired with some support around visualization, managment and inspection it is a tool that will make the term "printf debugging" hopefully extinct.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="inner"><a href="mailto:[email protected]?Subject=cloxp" target="_top">© 2015 Robert Krahn</a><span class="spacer">|</span><a href="/atom.xml">feed</a></div>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-56965545-3', 'auto', {'siteSpeedSampleRate': 50});
ga('require', 'linkid', 'linkid.js');
ga('require', 'displayfeatures');
ga('send', 'pageview');
</script>
</body>
</html>