mirror of
https://github.com/ganelson/inform.git
synced 2024-07-08 18:14:21 +03:00
70 lines
8.3 KiB
HTML
70 lines
8.3 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>1/pm</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta http-equiv="Content-Language" content="en-gb">
|
|
<link href="inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
</head>
|
|
<body>
|
|
|
|
<!--Weave of '1/tlm' generated by 7-->
|
|
<ul class="crumbs"><li><a href="../webs.html">★</a></li><li><a href="index.html">problems</a></li><li><a href="index.html#1">Chapter 1: Starting Up</a></li><li><b>Telemetry</b></li></ul><p class="purpose">To log Inform's activity.</p>
|
|
|
|
<ul class="toc"><li><a href="#SP1">§1. Telemetry</a></li></ul><hr class="tocbar">
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. Telemetry. </b>The telemetry file is optional, and transcribes the outcome of each run. This
|
|
is mainly for testing Inform, but may also be useful for teachers who want
|
|
to monitor how a whole class is using the system.
|
|
</p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">spool_telemetry_to</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Telemetry::locate_telemetry_file</span><span class="plain">(</span><span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">F</span><span class="plain">) {</span>
|
|
<span class="identifier">spool_telemetry_to</span><span class="plain"> = </span><span class="identifier">F</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">attempts_to_open_telemetry</span><span class="plain"> = 0;</span>
|
|
<span class="identifier">text_stream</span><span class="plain"> </span><span class="identifier">telemetry_file_struct</span><span class="plain">; </span> <span class="comment">The actual telemetry file (if created)</span>
|
|
<span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">telemetry_file</span><span class="plain"> = &</span><span class="identifier">telemetry_file_struct</span><span class="plain">; </span> <span class="comment">Main telemetry stream</span>
|
|
<span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">telmy</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">; </span> <span class="comment">Current telemetry stream</span>
|
|
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Telemetry::ensure_telemetry_file</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">spool_telemetry_to</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">telmy</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">attempts_to_open_telemetry</span><span class="plain">++ > 0) </span><span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">STREAM_OPEN_TO_FILE_APPEND</span><span class="plain">(</span><span class="identifier">telemetry_file</span><span class="plain">, </span><span class="identifier">spool_telemetry_to</span><span class="plain">, </span><span class="identifier">ISO_ENC</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">)</span>
|
|
<span class="functiontext">Problems::Fatal::filename_related</span><span class="plain">(</span><span class="string">"Can't open telemetry file"</span><span class="plain">, </span><span class="identifier">spool_telemetry_to</span><span class="plain">);</span>
|
|
<span class="identifier">telmy</span><span class="plain"> = </span><span class="identifier">telemetry_file</span><span class="plain">;</span>
|
|
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">telmy</span><span class="plain">, </span><span class="string">"\</span><span class="plain">n</span><span class="string">-- -- -- -- -- -- -- --\</span><span class="plain">n</span><span class="string">%B (build %B): telemetry.\</span><span class="plain">n</span><span class="string">"</span><span class="plain">,</span>
|
|
<span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">);</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">this_month</span><span class="plain"> = </span><span class="identifier">the_present</span><span class="plain">-></span><span class="identifier">tm_mon</span><span class="plain"> + 1;</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">this_day</span><span class="plain"> = </span><span class="identifier">the_present</span><span class="plain">-></span><span class="identifier">tm_mday</span><span class="plain">;</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">this_year</span><span class="plain"> = </span><span class="identifier">the_present</span><span class="plain">-></span><span class="identifier">tm_year</span><span class="plain"> + 1900;</span>
|
|
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">telmy</span><span class="plain">, </span><span class="string">"Running on %4d-%02d-%02d at %02d:%02d.\</span><span class="plain">n</span><span class="string">\</span><span class="plain">n</span><span class="string">"</span><span class="plain">,</span>
|
|
<span class="identifier">this_year</span><span class="plain">, </span><span class="identifier">this_month</span><span class="plain">, </span><span class="identifier">this_day</span><span class="plain">, </span><span class="identifier">the_present</span><span class="plain">-></span><span class="identifier">tm_hour</span><span class="plain">, </span><span class="identifier">the_present</span><span class="plain">-></span><span class="identifier">tm_min</span><span class="plain">);</span>
|
|
<span class="identifier">LOG</span><span class="plain">(</span><span class="string">"Opening telemetry file.\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Telemetry::write_to_telemetry_file</span><span class="plain">(</span><span class="identifier">wchar_t</span><span class="plain"> *</span><span class="identifier">m</span><span class="plain">) {</span>
|
|
<span class="functiontext">Telemetry::ensure_telemetry_file</span><span class="plain">();</span>
|
|
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">telmy</span><span class="plain">, </span><span class="string">"The user says:\</span><span class="plain">n</span><span class="string">\</span><span class="plain">n</span><span class="string">%w\</span><span class="plain">n</span><span class="string">\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">m</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Telemetry::locate_telemetry_file appears nowhere else.</p>
|
|
|
|
<p class="endnote">The function Telemetry::ensure_telemetry_file is used in 2/pl3 (<a href="2-pl3.html#SP9">§9</a>).</p>
|
|
|
|
<p class="endnote">The function Telemetry::write_to_telemetry_file appears nowhere else.</p>
|
|
|
|
<hr class="tocbar">
|
|
<ul class="toc"><li><a href="1-pm.html">Back to 'Problems Module'</a></li><li><i>(This section ends Chapter 1: Starting Up.)</i></li></ul><hr class="tocbar">
|
|
<!--End of weave-->
|
|
</body>
|
|
</html>
|
|
|