2019-02-04 22:26:45 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2020-04-08 22:41:00 +00:00
< title > Error Messages< / title >
2020-03-19 00:03:04 +00:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2019-02-04 22:26:45 +00:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
2020-03-19 00:03:04 +00:00
< link href = "../inweb.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-10 20:29:28 +00:00
2019-02-04 22:26:45 +00:00
< / head >
< body >
2020-03-19 00:03:04 +00:00
< nav role = "navigation" >
2020-04-13 16:06:45 +00:00
< h1 > < a href = "../index.html" >
< img src = "../..//docs/docs-src/Figures/Octagram184x184.png" width = 72 height = 72" >
< / a > < / h1 >
< ul > < li > < a href = "../inweb/index.html" > inweb< / a > < / li >
< / ul > < h2 > Foundation Module< / h2 > < ul >
< li > < a href = "index.html" > < span class = "selectedlink" > foundation< / span > < / a > < / li >
2020-03-19 00:03:04 +00:00
< li > < a href = "../foundation-test/index.html" > foundation-test< / a > < / li >
2020-04-13 16:06:45 +00:00
< / ul > < h2 > Example Webs< / h2 > < ul >
2020-04-12 16:24:23 +00:00
< li > < a href = "../goldbach/index.html" > goldbach< / a > < / li >
< li > < a href = "../twinprimes/twinprimes.html" > twinprimes< / a > < / li >
2020-04-13 16:06:45 +00:00
< / ul > < h2 > External< / h2 > < ul >
< li > < a href = "https://github.com/ganelson/inweb" > github< / a > < / li >
2020-03-19 00:03:04 +00:00
2020-04-13 16:06:45 +00:00
< / ul >
2020-03-19 00:03:04 +00:00
< / nav >
< main role = "main" >
2020-04-08 22:41:00 +00:00
<!-- Weave of 'Error Messages' generated by 7 -->
2020-04-13 16:06:45 +00:00
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "index.html" > foundation< / a > < / li > < li > < a href = "index.html#3" > Chapter 3: The Operating System< / a > < / li > < li > < b > Error Messages< / b > < / li > < / ul > < p class = "purpose" > A basic system for command-line tool error messages.< / p >
2019-02-04 22:26:45 +00:00
< ul class = "toc" > < li > < a href = "#SP1" > § 1. Errors handler< / a > < / li > < li > < a href = "#SP2" > § 2. Error messages< / a > < / li > < li > < a href = "#SP4" > § 4. Deliberately crashing< / a > < / li > < li > < a href = "#SP5" > § 5. Survivable errors< / a > < / li > < / ul > < hr class = "tocbar" >
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. Errors handler. < / b > The user can provide a routine to deal with error messages before they're
issued. If this returns < code class = "display" > < span class = "extract" > FALSE< / span > < / code > , nothing is printed to < code class = "display" > < span class = "extract" > stderr< / span > < / code > .
< / p >
< pre class = "display" >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > int< / span > < span class = "plain" > (*< / span > < span class = "identifier" > errors_handler< / span > < span class = "plain" > )(< / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *, < / span > < span class = "reserved" > int< / 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 = "identifier" > internal_errors_handler< / span > < span class = "plain" > )(< / span > < span class = "reserved" > void< / span > < span class = "plain" > *, < / span > < span class = "reserved" > char< / span > < span class = "plain" > *, < / span > < span class = "reserved" > char< / span > < span class = "plain" > *, < / span > < span class = "reserved" > int< / span > < span class = "plain" > ) = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
2019-02-04 22:26:45 +00:00
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::set_handler< button class = "popup" onclick = "togglePopup('usagePopup150')" > ...< span class = "popuptext" id = "usagePopup150" > Usage of < b > Errors::set_handler< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > int< / span > < span class = "plain" > (*< / span > < span class = "identifier" > f< / span > < span class = "plain" > )(< / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *, < / span > < span class = "reserved" > int< / span > < span class = "plain" > )) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > errors_handler< / span > < span class = "plain" > = < / span > < span class = "identifier" > f< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::set_internal_handler< button class = "popup" onclick = "togglePopup('usagePopup151')" > ...< span class = "popuptext" id = "usagePopup151" > Usage of < b > Errors::set_internal_handler< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > (*< / span > < span class = "identifier" > f< / span > < span class = "plain" > )(< / span > < span class = "reserved" > void< / span > < span class = "plain" > *, < / span > < span class = "reserved" > char< / span > < span class = "plain" > *, < / span > < span class = "reserved" > char< / span > < span class = "plain" > *, < / span > < span class = "reserved" > int< / span > < span class = "plain" > )) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > internal_errors_handler< / span > < span class = "plain" > = < / span > < span class = "identifier" > f< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > problem_count< / span > < span class = "plain" > = < / span > < span class = "constant" > 0< / span > < span class = "plain" > ;< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::have_occurred< button class = "popup" onclick = "togglePopup('usagePopup152')" > ...< span class = "popuptext" id = "usagePopup152" > Usage of < b > Errors::have_occurred< / b > :< br > Streams - < a href = "2-str.html#SP37" > § 37< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) {< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > problem_count< / span > < span class = "plain" > > < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ;< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::issue< button class = "popup" onclick = "togglePopup('usagePopup153')" > ...< span class = "popuptext" id = "usagePopup153" > Usage of < b > Errors::issue< / b > :< br > < a href = "#SP2" > § 2< / a > , < a href = "#SP6" > § 6< / a > , < a href = "#SP7" > § 7< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > fatality< / span > < span class = "plain" > ) {< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > rv< / span > < span class = "plain" > = < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > errors_handler< / span > < span class = "plain" > ) < / span > < span class = "identifier" > rv< / span > < span class = "plain" > = (*< / span > < span class = "identifier" > errors_handler< / span > < span class = "plain" > )(< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > fatality< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > rv< / span > < span class = "plain" > ) < / span > < span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "constant" > STDERR< / span > < span class = "plain" > , < / span > < span class = "string" > "%S"< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > fatality< / span > < span class = "plain" > ) < / span > < span class = "functiontext" > < a href = "#SP4" > Errors::die< / a > < / span > < span class = "plain" > (); < / span > < span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "identifier" > problem_count< / span > < span class = "plain" > ++;< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP2" > < / a > < b > § 2. Error messages. < / b > Ah, they kill you; or they don't. The fatal kind cause an exit code of 2, to
distinguish this from a proper completion in which non-fatal errors occur.
These two routines (alone) can be caused by failures of the memory allocation
or streams systems, and therefore must be written with a little care to use
the temporary stream, not some other string which might need fresh allocation.
< / p >
< pre class = "display" >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::fatal< button class = "popup" onclick = "togglePopup('usagePopup154')" > ...< span class = "popuptext" id = "usagePopup154" > Usage of < b > Errors::fatal< / b > :< br > Memory - < a href = "2-mmr.html#SP11_1" > § 11.1< / a > , < a href = "2-mmr.html#SP15" > § 15< / a > , < a href = "2-mmr.html#SP16_1" > § 16.1< / a > < br > Streams - < a href = "2-str.html#SP34_1" > § 34.1< / a > , < a href = "2-str.html#SP35_3" > § 35.3< / a > < br > C Strings - < a href = "4-cst.html#SP3" > § 3< / a > < br > Binary Files - < a href = "6-bf.html#SP9" > § 9< / a > < br > Build Files - < a href = "8-bf.html#SP7" > § 7< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
2020-04-06 11:26:10 +00:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: fatal error: %s\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::fatal_with_C_string< button class = "popup" onclick = "togglePopup('usagePopup155')" > ...< span class = "popuptext" id = "usagePopup155" > Usage of < b > Errors::fatal_with_C_string< / b > :< br > < a href = "#SP3" > § 3< / a > , Memory - < a href = "2-mmr.html#SP26_1" > § 26.1< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > parameter< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: fatal error: "< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > parameter< / span > < span class = "plain" > );< / span >
2020-04-06 11:26:10 +00:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "\n"< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::fatal_with_text< button class = "popup" onclick = "togglePopup('usagePopup156')" > ...< span class = "popuptext" id = "usagePopup156" > Usage of < b > Errors::fatal_with_text< / b > :< br > Command Line Arguments - < a href = "3-cla.html#SP8" > § 8< / a > , < a href = "3-cla.html#SP11" > § 11< / a > , < a href = "3-cla.html#SP13" > § 13< / a > < br > Bibliographic Data for Webs - < a href = "8-bdfw.html#SP5" > § 5< / a > < br > Build Files - < a href = "8-bf.html#SP6" > § 6< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > parameter< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: fatal error: "< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > parameter< / span > < span class = "plain" > );< / span >
2020-04-06 11:26:10 +00:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "\n"< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::fatal_with_file< button class = "popup" onclick = "togglePopup('usagePopup157')" > ...< span class = "popuptext" id = "usagePopup157" > Usage of < b > Errors::fatal_with_file< / b > :< br > Text Files - < a href = "4-tf.html#SP5_1" > § 5.1< / a > , < a href = "4-tf.html#SP5_2" > § 5.2< / a > , < a href = "4-tf.html#SP5_3_2" > § 5.3.2< / a > < br > Epub Ebooks - < a href = "5-ee.html#SP6_1" > § 6.1< / a > , < a href = "5-ee.html#SP6_2" > § 6.2< / a > , < a href = "5-ee.html#SP6_3" > § 6.3< / a > , < a href = "5-ee.html#SP7_2" > § 7.2< / a > , < a href = "5-ee.html#SP7_3" > § 7.3< / a > < br > Binary Files - < a href = "6-bf.html#SP7" > § 7< / a > , < a href = "6-bf.html#SP8" > § 8< / a > , < a href = "6-bf.html#SP9" > § 9< / a > < br > Build Files - < a href = "8-bf.html#SP4" > § 4< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > F< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
2020-04-06 11:26:10 +00:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: fatal error: %s: %f\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > F< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::fatal_with_path< button class = "popup" onclick = "togglePopup('usagePopup158')" > ...< span class = "popuptext" id = "usagePopup158" > Usage of < b > Errors::fatal_with_path< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
2020-04-06 11:26:10 +00:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: fatal error: %s: %p\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > P< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP3" > < / a > < b > § 3. < / b > Assertion failures lead to the following:
< / p >
< pre class = "definitions" >
2020-04-11 22:43:27 +00:00
< span class = "definitionkeyword" > define< / span > < span class = "identifier" > internal_error< / span > < span class = "plain" > (< / span > < span class = "identifier" > message< / span > < span class = "plain" > ) < / span > < span class = "functiontext" > < a href = "#SP3" > Errors::internal_error_handler< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > __FILE__< / span > < span class = "plain" > , < / span > < span class = "identifier" > __LINE__< / span > < span class = "plain" > )< / span >
2019-02-04 22:26:45 +00:00
< / pre >
< pre class = "display" >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::internal_error_handler< button class = "popup" onclick = "togglePopup('usagePopup159')" > ...< span class = "popuptext" id = "usagePopup159" > Usage of < b > Errors::internal_error_handler< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > *< / span > < span class = "identifier" > p< / span > < span class = "plain" > , < / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > f< / span > < span class = "plain" > , < / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > lc< / span > < span class = "plain" > ) {< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > internal_errors_handler< / span > < span class = "plain" > )< / span >
2020-03-19 00:03:04 +00:00
< span class = "plain" > (*< / span > < span class = "identifier" > internal_errors_handler< / span > < span class = "plain" > )(< / span > < span class = "identifier" > p< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > f< / span > < span class = "plain" > , < / span > < span class = "identifier" > lc< / span > < span class = "plain" > );< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > else< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP2" > Errors::fatal_with_C_string< / a > < / span > < span class = "plain" > (< / span > < span class = "string" > "internal error (%s)"< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP4" > < / a > < b > § 4. Deliberately crashing. < / b > It's sometimes convenient to get a backtrace from the debugger when an error
occurs unexpectedly, and one way to do that is to force a division by zero.
(This is only enabled by < code class = "display" > < span class = "extract" > -crash< / span > < / code > at the command line and is for debugging only.)
< / p >
< pre class = "display" >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > debugger_mode< / span > < span class = "plain" > = < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > ;< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::enter_debugger_mode< button class = "popup" onclick = "togglePopup('usagePopup160')" > ...< span class = "popuptext" id = "usagePopup160" > Usage of < b > Errors::enter_debugger_mode< / b > :< br > Command Line Arguments - < a href = "3-cla.html#SP13_1" > § 13.1< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) {< / span >
2020-04-06 11:26:10 +00:00
< span class = "identifier" > debugger_mode< / span > < span class = "plain" > = < / span > < span class = "constant" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > printf< / span > < span class = "plain" > (< / span > < span class = "string" > "(Debugger mode enabled: will crash on fatal errors)\n"< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::die< button class = "popup" onclick = "togglePopup('usagePopup161')" > ...< span class = "popuptext" id = "usagePopup161" > Usage of < b > Errors::die< / b > :< br > < a href = "#SP1" > § 1< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) { < / span > < span class = "comment" > as void as it gets< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > DL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > STREAM_FLUSH< / span > < span class = "plain" > (< / span > < span class = "identifier" > DL< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > debugger_mode< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "constant" > STDERR< / span > < span class = "plain" > , < / span > < span class = "string" > "(crashing intentionally to allow backtrace)\n"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > to_deliberately_crash< / span > < span class = "plain" > = < / span > < span class = "constant" > 0< / span > < span class = "plain" > ;< / span >
2020-04-04 19:46:43 +00:00
< span class = "identifier" > printf< / span > < span class = "plain" > (< / span > < span class = "string" > "%d"< / span > < span class = "plain" > , < / span > < span class = "constant" > 1< / span > < span class = "plain" > /< / span > < span class = "identifier" > to_deliberately_crash< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
2020-04-08 12:03:15 +00:00
< span class = "comment" > on a fatal exit, memory isn't freed, because that causes threading problems< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > exit< / span > < span class = "plain" > (2);< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP5" > < / a > < b > § 5. Survivable errors. < / b > The trick with error messages is to indicate where they occur, and we can
specify this at three levels of abstraction:
< / p >
< pre class = "display" >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::nowhere< button class = "popup" onclick = "togglePopup('usagePopup162')" > ...< span class = "popuptext" id = "usagePopup162" > Usage of < b > Errors::nowhere< / b > :< br > Epub Ebooks - < a href = "5-ee.html#SP7_2_2_3" > § 7.2.2.3< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > ) {< / span >
< span class = "functiontext" > < a href = "#SP5" > Errors::in_text_file< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::in_text_file< button class = "popup" onclick = "togglePopup('usagePopup163')" > ...< span class = "popuptext" id = "usagePopup163" > Usage of < b > Errors::in_text_file< / b > :< br > Command Line Arguments - < a href = "3-cla.html#SP11" > § 11< / a > < br > Build Files - < a href = "8-bf.html#SP3" > § 3< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_file_position< / span > < span class = "plain" > *< / span > < span class = "identifier" > here< / span > < span class = "plain" > ) {< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > here< / span > < span class = "plain" > )< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP6" > Errors::at_position< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > here< / span > < span class = "plain" > -> < / span > < span class = "element" > text_file_filename< / span > < span class = "plain" > , < / span > < span class = "identifier" > here< / span > < span class = "plain" > -> < / span > < span class = "element" > line_count< / span > < span class = "plain" > );< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > else< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP6" > Errors::at_position< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , < / span > < span class = "constant" > 0< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::in_text_file_S< button class = "popup" onclick = "togglePopup('usagePopup164')" > ...< span class = "popuptext" id = "usagePopup164" > Usage of < b > Errors::in_text_file_S< / b > :< br > Web Structure - < a href = "8-ws.html#SP7_3_2" > § 7.3.2< / a > , < a href = "8-ws.html#SP7_3_2_1" > § 7.3.2.1< / a > , < a href = "8-ws.html#SP7_3_3_2" > § 7.3.3.2< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_file_position< / span > < span class = "plain" > *< / span > < span class = "identifier" > here< / span > < span class = "plain" > ) {< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > here< / span > < span class = "plain" > )< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP6" > Errors::at_position_S< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > here< / span > < span class = "plain" > -> < / span > < span class = "element" > text_file_filename< / span > < span class = "plain" > , < / span > < span class = "identifier" > here< / span > < span class = "plain" > -> < / span > < span class = "element" > line_count< / span > < span class = "plain" > );< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > else< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP6" > Errors::at_position_S< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , < / span > < span class = "constant" > 0< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP6" > < / a > < b > § 6. < / b > Which funnel through:
< / p >
< pre class = "display" >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::at_position< button class = "popup" onclick = "togglePopup('usagePopup165')" > ...< span class = "popuptext" id = "usagePopup165" > Usage of < b > Errors::at_position< / b > :< br > < a href = "#SP5" > § 5< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > file< / span > < span class = "plain" > , < / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > line< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: "< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > );< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > file< / span > < span class = "plain" > ) < / span > < span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%f, line %d: "< / span > < span class = "plain" > , < / span > < span class = "identifier" > file< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::at_position_S< button class = "popup" onclick = "togglePopup('usagePopup166')" > ...< span class = "popuptext" id = "usagePopup166" > Usage of < b > Errors::at_position_S< / b > :< br > < a href = "#SP5" > § 5< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > file< / span > < span class = "plain" > , < / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > line< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: "< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > );< / span >
2020-04-06 11:26:10 +00:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > file< / span > < span class = "plain" > ) < / span > < span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%f, line %d: "< / span > < span class = "plain" > , < / span > < span class = "identifier" > file< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%S\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP7" > < / a > < b > § 7. < / b > Lastly:
< / p >
< pre class = "display" >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::with_file< button class = "popup" onclick = "togglePopup('usagePopup167')" > ...< span class = "popuptext" id = "usagePopup167" > Usage of < b > Errors::with_file< / b > :< br > Text Files - < a href = "4-tf.html#SP5_1" > § 5.1< / a > , < a href = "4-tf.html#SP5_2" > § 5.2< / a > , < a href = "4-tf.html#SP5_3_2" > § 5.3.2< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > F< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
2020-04-06 11:26:10 +00:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: %f: %s\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > , < / span > < span class = "identifier" > F< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
2020-04-11 22:43:27 +00:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Errors::with_text< button class = "popup" onclick = "togglePopup('usagePopup168')" > ...< span class = "popuptext" id = "usagePopup168" > Usage of < b > Errors::with_text< / b > :< br > Build Files - < a href = "8-bf.html#SP9" > § 9< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > char< / span > < span class = "plain" > *< / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "reserved" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > T< / span > < span class = "plain" > ) {< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "%s: "< / span > < span class = "plain" > , < / span > < span class = "identifier" > INTOOL_NAME< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "identifier" > message< / span > < span class = "plain" > , < / span > < span class = "identifier" > T< / span > < span class = "plain" > );< / span >
2020-04-06 11:26:10 +00:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "string" > "\n"< / span > < span class = "plain" > );< / span >
2020-04-11 22:43:27 +00:00
< span class = "functiontext" > < a href = "#SP1" > Errors::issue< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > , < / span > < span class = "constant" > FALSE< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > ERM< / span > < span class = "plain" > )< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
2019-03-12 23:32:12 +00:00
< hr class = "tocbar" >
< ul class = "toc" > < li > < i > (This section begins Chapter 3: The Operating System.)< / i > < / li > < li > < a href = "3-cla.html" > Continue with 'Command Line Arguments'< / a > < / li > < / ul > < hr class = "tocbar" >
2019-03-18 11:16:10 +00:00
<!-- End of weave -->
2020-04-11 20:39:43 +00: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 00:03:04 +00:00
< / main >
2019-02-04 22:26:45 +00:00
< / body >
< / html >
