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-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-03-19 02:11:25 +02:00
< link href = "../inweb.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 >
< body >
2020-03-19 02:11:25 +02:00
< nav role = "navigation" >
2020-04-14 19:56:54 +03:00
< h1 > < a href = "../index.html" >
< img src = "../docs-src/Figures/Inform.png" height = 72" >
< / a > < / h1 >
< ul > < li > < a href = "../compiler.html" > compiler tools< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../other.html" > other tools< / a > < / li >
< li > < a href = "../extensions.html" > extensions and kits< / a > < / li >
< li > < a href = "../units.html" > unit test tools< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Compiler Webs< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../inbuild/index.html" > inbuild< / a > < / li >
< li > < a href = "../inform7/index.html" > inform7< / a > < / li >
< li > < a href = "../inter/index.html" > inter< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inbuild Modules< / h2 > < ul >
< li > < a href = "../supervisor-module/index.html" > supervisor< / a > < / li >
< / ul > < h2 > Inform7 Modules< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../core-module/index.html" > core< / a > < / li >
< li > < a href = "../inflections-module/index.html" > inflections< / a > < / li >
< li > < a href = "../linguistics-module/index.html" > linguistics< / a > < / li >
< li > < a href = "../kinds-module/index.html" > kinds< / a > < / li >
< li > < a href = "../if-module/index.html" > if< / a > < / li >
< li > < a href = "../multimedia-module/index.html" > multimedia< / a > < / li >
2020-04-14 19:56:54 +03:00
< li > < a href = "index.html" > < span class = "selectedlink" > problems< / span > < / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../index-module/index.html" > index< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inter Modules< / h2 > < ul >
< li > < a href = "../bytecode-module/index.html" > bytecode< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../building-module/index.html" > building< / a > < / li >
< li > < a href = "../codegen-module/index.html" > codegen< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Shared Modules< / h2 > < ul >
< li > < a href = "../arch-module/index.html" > arch< / a > < / li >
< li > < a href = "../syntax-module/index.html" > syntax< / a > < / li >
< li > < a href = "../words-module/index.html" > words< / a > < / li >
< li > < a href = "../html-module/index.html" > html< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../../../inweb/docs/foundation-module/index.html" > foundation< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul >
2020-03-19 02:11:25 +02:00
< / nav >
< main role = "main" >
2020-04-14 19:56:54 +03:00
<!-- Weave of 'Telemetry' generated by 7 -->
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../compiler.html" > Inform7 Modules< / 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 >
2019-03-17 14:40:57 +02:00
2020-04-16 01:49:59 +03:00
< ul class = "toc" > < li > < a href = "1-tlm.html#SP1" > § 1. Telemetry< / a > < / li > < / ul > < hr class = "tocbar" >
2019-03-17 14:40:57 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Telemetry::locate_telemetry_file< button class = "popup" onclick = "togglePopup('usagePopup2')" > ...< span class = "popuptext" id = "usagePopup2" > Usage of < b > Telemetry::locate_telemetry_file< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > F< / span > < span class = "plain" > ) {< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > spool_telemetry_to< / span > < span class = "plain" > = < / span > < span class = "identifier" > F< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > attempts_to_open_telemetry< / span > < span class = "plain" > = < / span > < span class = "constant" > 0< / span > < span class = "plain" > ;< / span >
2020-04-14 19:56:54 +03:00
< 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 >
2019-03-17 14:40:57 +02:00
2020-04-14 19:56:54 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Telemetry::ensure_telemetry_file< button class = "popup" onclick = "togglePopup('usagePopup3')" > ...< span class = "popuptext" id = "usagePopup3" > Usage of < b > Telemetry::ensure_telemetry_file< / b > :< br > Problems, Level 3 - < a href = "2-pl3.html#SP10" > § 10< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) {< / span >
2019-03-17 14:40:57 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > attempts_to_open_telemetry< / span > < span class = "plain" > ++ > < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > ;< / span >
2019-03-17 14:40:57 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< span class = "functiontext" > < a href = "2-pl0.html#SP1" > Problems::Fatal::filename_related< / a > < / 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 >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > telmy< / span > < span class = "plain" > = < / span > < span class = "identifier" > telemetry_file< / span > < span class = "plain" > ;< / span >
2020-04-07 03:06:09 +03:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > telmy< / span > < span class = "plain" > , < / span > < span class = "string" > "\n-- -- -- -- -- -- -- --\n%B (build %B): telemetry.\n"< / span > < span class = "plain" > ,< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > FALSE< / span > < span class = "plain" > , < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > );< / span >
2020-04-07 03:06:09 +03:00
< 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" > + < / span > < span class = "constant" > 1< / span > < span class = "plain" > ;< / span >
2019-03-17 14:40:57 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< 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" > + < / span > < span class = "constant" > 1900< / 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" > "Running on %4d-%02d-%02d at %02d:%02d.\n\n"< / span > < span class = "plain" > ,< / span >
2019-03-17 14:40:57 +02:00
< 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 >
2020-04-07 03:06:09 +03:00
< span class = "identifier" > LOG< / span > < span class = "plain" > (< / span > < span class = "string" > "Opening telemetry file.\n"< / span > < span class = "plain" > );< / span >
2019-03-17 14:40:57 +02:00
< span class = "plain" > }< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Telemetry::write_to_telemetry_file< button class = "popup" onclick = "togglePopup('usagePopup4')" > ...< span class = "popuptext" id = "usagePopup4" > Usage of < b > Telemetry::write_to_telemetry_file< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "identifier" > wchar_t< / span > < span class = "plain" > *< / span > < span class = "identifier" > m< / span > < span class = "plain" > ) {< / span >
2020-04-16 01:49:59 +03:00
< span class = "functiontext" > < a href = "1-tlm.html#SP1" > Telemetry::ensure_telemetry_file< / a > < / span > < span class = "plain" > ();< / span >
2020-04-07 03:06:09 +03:00
< 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:\n\n%w\n\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > m< / span > < span class = "plain" > );< / span >
2019-03-17 14:40:57 +02:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / 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" >
2019-04-22 17:42:10 +03:00
<!-- End of weave -->
2020-04-14 19:56:54 +03:00
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
< link href = "Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-19 02:11:25 +02:00
< / main >
2019-03-17 14:40:57 +02:00
< / body >
< / html >