2019-03-17 14:40:57 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2020-04-14 19:56:54 +03:00
< title > Telemetry< / title >
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-19 02:11:25 +02:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2019-03-17 14:40:57 +02:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
2020-05-03 03:01:21 +03:00
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Navigation.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Fonts.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Base.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-05-03 03:01:21 +03:00
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-14 19:56:54 +03:00
2019-03-17 14:40:57 +02:00
< / head >
2020-05-03 03:01:21 +03:00
< body class = "commentary-font" >
2020-03-19 02:11:25 +02:00
< nav role = "navigation" >
2022-04-28 19:37:28 +03:00
< h1 > < a href = "../index.html" >
2020-05-03 18:34:53 +03:00
< img src = "../docs-assets/Inform.png" height = 72" >
2020-04-14 19:56:54 +03:00
< / a > < / h1 >
2022-04-28 19:37:28 +03:00
< ul > < li > < a href = "../index.html" > home< / a > < / li >
2022-04-04 20:31:44 +03:00
< / ul > < h2 > Compiler< / h2 > < ul >
< li > < a href = "../structure.html" > structure< / a > < / li >
< li > < a href = "../inbuildn.html" > inbuild< / a > < / li >
< li > < a href = "../inform7n.html" > inform7< / a > < / li >
< li > < a href = "../intern.html" > inter< / a > < / li >
< li > < a href = "../services.html" > services< / a > < / li >
2022-04-18 17:46:46 +03:00
< li > < a href = "../secrets.html" > secrets< / a > < / li >
2022-04-04 20:31:44 +03:00
< / ul > < h2 > Other Tools< / h2 > < ul >
< li > < a href = "../inblorbn.html" > inblorb< / a > < / li >
< li > < a href = "../indocn.html" > indoc< / a > < / li >
< li > < a href = "../inform6.html" > inform6< / a > < / li >
< li > < a href = "../inpolicyn.html" > inpolicy< / a > < / li >
< li > < a href = "../inrtpsn.html" > inrtps< / a > < / li >
2022-04-18 17:46:46 +03:00
< / ul > < h2 > Resources< / h2 > < ul >
< li > < a href = "../extensions.html" > extensions< / a > < / li >
< li > < a href = "../kits.html" > kits< / a > < / li >
2022-04-04 20:31:44 +03:00
< / ul > < h2 > Repository< / h2 > < ul >
< li > < a href = "https://github.com/ganelson/inform" > < img src = "../docs-assets/github.png" height = 18 > github< / a > < / li >
< / ul > < h2 > Related Projects< / h2 > < ul >
2022-04-28 19:20:06 +03:00
< li > < a href = "../../../inweb/index.html" > inweb< / a > < / li >
< li > < a href = "../../../intest/index.html" > intest< / a > < / li >
2020-03-19 02:11:25 +02:00
2020-04-14 19:56:54 +03:00
< / ul >
2020-03-19 02:11:25 +02:00
< / nav >
< main role = "main" >
2020-05-03 03:01:21 +03:00
<!-- Weave of 'Telemetry' generated by Inweb -->
< div class = "breadcrumbs" >
2022-04-28 19:37:28 +03:00
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../services.html" > Services< / 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 > < / div >
2020-05-20 13:36:42 +03:00
< p class = "purpose" > An optional facility for transcribing the outcome of runs of software.< / p >
2019-03-17 14:40:57 +02:00
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > The telemetry file is optional, and transcribes the outcome of each run. This
2019-03-17 14:40:57 +02:00
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 >
2020-05-20 13:36:42 +03:00
< p class = "commentary" > Nothing is done unless a filename is sent to the following function:
< / p >
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "identifier-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > spool_telemetry_to< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ;< / span >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Telemetry::locate_telemetry_file< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > spool_telemetry_to< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2020-05-20 13:36:42 +03:00
< / pre >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. < / b > A little lazily, the telemetry file once opened stays open until the process
2020-05-20 13:36:42 +03:00
finishes.
< / p >
2019-03-17 14:40:57 +02:00
2020-05-20 13:36:42 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-05-03 03:01:21 +03:00
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > attempts_to_open_telemetry< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > telemetry_file_struct< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > The actual telemetry file (if created)< / span >
< span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > telemetry_file< / span > < span class = "plain-syntax" > = & < / span > < span class = "identifier-syntax" > telemetry_file_struct< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > Main telemetry stream< / span >
< span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > telmy< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > Current telemetry stream< / span >
2019-03-17 14:40:57 +02:00
2020-05-21 02:11:29 +03:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Telemetry::ensure_telemetry_file< / span > < button class = "popup" onclick = "togglePopup('usagePopup1')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup1" > Usage of < span class = "code-font" > < span class = "function-syntax" > Telemetry::ensure_telemetry_file< / span > < / span > :< br / > < a href = "1-tlm.html#SP3" > § 3< / a > < br / > Problems, Level 0 - < a href = "2-pl0.html#SP9" > § 9< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
2020-05-03 03:01:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > spool_telemetry_to< / span > < span class = "plain-syntax" > == < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ) < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > telmy< / span > < span class = "plain-syntax" > ) < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > attempts_to_open_telemetry< / span > < span class = "plain-syntax" > ++ > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > STREAM_OPEN_TO_FILE_APPEND< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > telemetry_file< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > spool_telemetry_to< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > ISO_ENC< / span > < span class = "plain-syntax" > ) == < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > )< / span >
2020-05-21 02:11:29 +03:00
< span class = "plain-syntax" > < / span > < a href = "2-pl2.html#SP14" class = "function-link" > < span class = "function-syntax" > Problems::fatal_on_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Can't open telemetry file"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > spool_telemetry_to< / span > < span class = "plain-syntax" > );< / span >
2020-05-03 03:01:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > telmy< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > telemetry_file< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > telmy< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "\n-- -- -- -- -- -- -- --\n%B (build %B): telemetry.\n"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > this_month< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > the_present< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > tm_mon< / span > < span class = "plain-syntax" > + < / span > < span class = "constant-syntax" > 1< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > this_day< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > the_present< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > tm_mday< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > this_year< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > the_present< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > tm_year< / span > < span class = "plain-syntax" > + < / span > < span class = "constant-syntax" > 1900< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > telmy< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "Running on %4d-%02d-%02d at %02d:%02d.\n\n"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > this_year< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > this_month< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > this_day< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > the_present< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > tm_hour< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > the_present< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > tm_min< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > LOG< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Opening telemetry file.\n"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
2020-05-20 13:36:42 +03:00
< / pre >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP3" class = "paragraph-anchor" > < / a > < b > § 3. < / b > And log messages can be written here:
2020-05-20 13:36:42 +03:00
< / p >
2019-03-17 14:40:57 +02:00
2020-05-20 13:36:42 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-05-03 03:01:21 +03:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Telemetry::write_to_telemetry_file< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > wchar_t< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > m< / span > < span class = "plain-syntax" > ) {< / span >
2020-05-20 13:36:42 +03:00
< span class = "plain-syntax" > < / span > < a href = "1-tlm.html#SP2" class = "function-link" > < span class = "function-syntax" > Telemetry::ensure_telemetry_file< / span > < / a > < span class = "plain-syntax" > ();< / span >
2020-05-03 03:01:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > telmy< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "The user says:\n\n%w\n\n"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > m< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< nav role = "progress" > < div class = "progresscontainer" >
2020-05-20 13:36:42 +03:00
< ul class = "progressbar" > < li class = "progressprev" > < a href = "1-pm.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "P-wtmd.html" > P< / a > < / li > < li class = "progresscurrentchapter" > 1< / li > < li class = "progresssection" > < a href = "1-pm.html" > pm< / a > < / li > < li class = "progresscurrent" > tlm< / li > < li class = "progresschapter" > < a href = "2-pl0.html" > 2< / a > < / li > < li class = "progressnext" > < a href = "2-pl0.html" > ❯ < / a > < / li > < / ul > < / div >
2020-05-03 03:01:21 +03:00
< / nav > <!-- End of weave -->
2019-03-17 14:40:57 +02:00
2020-03-19 02:11:25 +02:00
< / main >
2019-03-17 14:40:57 +02:00
< / body >
< / html >