2023-06-08 21:57:05 +03:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > File Input Output Template< / title >
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< meta name = "viewport" content = "width=device-width initial-scale=1" >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
< 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" >
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< / head >
< body class = "commentary-font" >
< nav role = "navigation" >
< h1 > < a href = "../index.html" >
< img src = "../docs-assets/Inform.png" height = 72" >
< / a > < / h1 >
< ul > < li > < a href = "../index.html" > home< / a > < / li >
< / 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 >
< li > < a href = "../secrets.html" > secrets< / a > < / li >
< / 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 >
< / ul > < h2 > Resources< / h2 > < ul >
< li > < a href = "../extensions.html" > extensions< / a > < / li >
< li > < a href = "../kits.html" > kits< / a > < / li >
< / 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 >
< li > < a href = "../../../inweb/index.html" > inweb< / a > < / li >
< li > < a href = "../../../intest/index.html" > intest< / a > < / li >
< / ul >
< / nav >
< main role = "main" >
<!-- Weave of 'File Input Output Template' generated by Inweb -->
< div class = "breadcrumbs" >
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../extensions.html" > Kits< / a > < / li > < li > < a href = "index.html" > Architecture16Kit< / a > < / li > < li > < b > File Input Output Template< / b > < / li > < / ul > < / div >
< p class = "purpose" > Access to external files.< / p >
< ul class = "toc" > < li > < a href = "S-fio.html#SP1" > § 1. API< / a > < / li > < li > < a href = "S-fio.html#SP2" > § 2. Errors< / a > < / li > < / ul > < hr class = "tocbar" >
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. API. < / b > The 16-bit architecture does not allow for any external file I/O at all,
so these functions essentially refuse to do anything. Note that < span class = "extract" > < span class = "extract-syntax" > FileIO_GetC< / span > < / span >
returns end-of-file at all times, thus treating all files as if empty.
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_Exists< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ; < / span > < span class = "reserved-syntax" > rfalse< / span > < span class = "plain-syntax" > ; ];< / span >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_Ready< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ; < / span > < span class = "reserved-syntax" > rfalse< / span > < span class = "plain-syntax" > ; ];< / span >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_GetC< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ; < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > -1; ];< / span >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_PutTable< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > tab< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > FileIO_Error< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "external files cannot be used in the Z-machine"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > ];< / span >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_MarkReady< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > status< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > FileIO_PutTable< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ); ];< / span >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_GetTable< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > tab< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > FileIO_PutTable< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ); ];< / span >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_PrintContents< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > FileIO_PutTable< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ); ];< / span >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_PutContents< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > FileIO_PutTable< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ); ];< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. Errors. < / b > This could be used for I/O errors of all kinds, but in fact we only need one:
see above.
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > [ < / span > < span class = "identifier-syntax" > FileIO_Error< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > err_text< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > struc< / 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" > extf< / span > < span class = "plain-syntax" > < < / span > < span class = "constant-syntax" > 1< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > > < / span > < span class = "identifier-syntax" > NO_EXTERNAL_FILES< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > print< / span > < span class = "plain-syntax" > < / span > < span class = "string-syntax" > "^*** Error on unknown file: "< / span > < span class = "plain-syntax" > , (< / span > < span class = "reserved-syntax" > string< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > err_text< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > " ***^"< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > struc< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > TableOfExternalFiles< / span > < span class = "plain-syntax" > --> < / span > < span class = "identifier-syntax" > extf< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > print< / span > < span class = "plain-syntax" > < / span > < span class = "string-syntax" > "^*** Error on file '"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > string< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > struc< / span > < span class = "plain-syntax" > --> < / span > < span class = "identifier-syntax" > AUXF_FILENAME< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "': "< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > string< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > err_text< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > " ***^"< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > RunTimeProblem< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > RTP_FILEIOERROR< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > ];< / span >
< / pre >
< nav role = "progress" > < div class = "progresscontainer" >
2023-06-10 11:36:17 +03:00
< ul class = "progressbar" > < li class = "progressprev" > < a href = "S-io.html" > ❮ < / a > < / li > < li class = "progresssection" > < a href = "S-cpb.html" > cpb< / a > < / li > < li class = "progresssection" > < a href = "S-str.html" > str< / a > < / li > < li class = "progresssection" > < a href = "S-stt.html" > stt< / a > < / li > < li class = "progresssection" > < a href = "S-mth.html" > mth< / a > < / li > < li class = "progresssection" > < a href = "S-cs.html" > cs< / a > < / li > < li class = "progresssection" > < a href = "S-io.html" > io< / a > < / li > < li class = "progresscurrent" > fio< / li > < li class = "progresssection" > < a href = "S-vnr.html" > vnr< / a > < / li > < li class = "progressnext" > < a href = "S-vnr.html" > ❯ < / a > < / li > < / ul > < / div >
2023-06-08 21:57:05 +03:00
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >