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 > Directories< / title >
2020-04-23 22:23:44 +00:00
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
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-04-20 22:26:08 +00:00
2020-05-02 22:50:23 +00:00
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-30 22:36:38 +00:00
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-25 10:33:39 +00:00
< 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" >
2020-04-20 22:26:08 +00:00
< link href = "../docs-assets/Base.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-21 16:55:17 +00:00
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-23 22:23:44 +00:00
2019-02-04 22:26:45 +00:00
< / head >
2020-04-25 10:33:39 +00:00
< body class = "commentary-font" >
2020-03-19 00:03:04 +00:00
< nav role = "navigation" >
2020-04-13 16:06:45 +00:00
< h1 > < a href = "../index.html" >
2020-04-20 22:26:08 +00:00
< img src = "../docs-assets/Octagram.png" width = 72 height = 72" >
2020-04-13 16:06:45 +00:00
< / 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-15 22:45:08 +00:00
< li > < a href = "../eastertide/index.html" > eastertide< / a > < / li >
2020-04-14 17:36:42 +00:00
< / ul > < h2 > Repository< / h2 > < ul >
2020-04-20 22:34:44 +00:00
< li > < a href = "https://github.com/ganelson/inweb" > < img src = "../docs-assets/github.png" height = 18 > github< / a > < / li >
2020-04-14 17:36:42 +00:00
< / ul > < h2 > Related Projects< / h2 > < ul >
< li > < a href = "../../../inform/docs/index.html" > inform< / a > < / li >
< li > < a href = "../../../intest/docs/index.html" > intest< / 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-23 22:23:44 +00:00
<!-- Weave of 'Directories' generated by Inweb -->
2020-04-30 22:36:38 +00:00
< div class = "breadcrumbs" >
< 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 > Directories< / b > < / li > < / ul > < / div >
< p class = "purpose" > Scanning directories on the host filing system.< / p >
2019-02-04 22:26:45 +00:00
2020-08-16 17:39:53 +00:00
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > All of this abstracts the code already found in the platform definitions.
2019-02-04 22:26:45 +00:00
< / p >
2020-04-25 10:33:39 +00:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-04-21 16:55:17 +00:00
< span class = "reserved-syntax" > typedef< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > scan_directory< / span > < span class = "plain-syntax" > {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > directory_handle< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > char< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > directory_name_written_out< / span > < span class = "plain-syntax" > [4*< / span > < span class = "constant-syntax" > MAX_FILENAME_LENGTH< / span > < span class = "plain-syntax" > ];< / span >
2020-05-09 12:05:00 +00:00
< span class = "plain-syntax" > < / span > < span class = "constant-syntax" > CLASS_DEFINITION< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > scan_directory< / span > < span class = "plain-syntax" > ;< / span >
2020-04-24 10:26:18 +00:00
< / pre >
< ul class = "endnotetexts" > < li > The structure scan_directory is private to this section.< / li > < / ul >
2020-08-16 17:39:53 +00:00
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. < / b > The directory name going out has to be transcoded from flat Unicode to
2019-02-04 22:26:45 +00:00
whatever the locale encoding is; the filenames coming back have to be
transcoded the other way.
< / p >
2020-04-25 10:33:39 +00:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-04-25 12:26:09 +00:00
< span class = "reserved-syntax" > scan_directory< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > Directories::open< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > pathname< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > scan_directory< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > CREATE< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > scan_directory< / span > < span class = "plain-syntax" > );< / span >
2020-06-27 22:03:14 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > pn< / span > < span class = "plain-syntax" > )< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > pn< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%p"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "4-sm.html#SP6" class = "function-link" > < span class = "function-syntax" > Str::copy_to_locale_string< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > directory_name_written_out< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > pn< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > 4< / span > < span class = "plain-syntax" > *< / span > < span class = "constant-syntax" > MAX_FILENAME_LENGTH< / span > < span class = "plain-syntax" > );< / span >
2020-06-27 22:03:14 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > DISCARD_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > pn< / span > < span class = "plain-syntax" > )< / span >
2020-07-06 22:01:05 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > directory_handle< / span > < span class = "plain-syntax" > = < / span > < a href = "1-wp.html#SP9" class = "function-link" > < span class = "function-syntax" > Platform::opendir< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > directory_name_written_out< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > directory_handle< / 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 = "identifier-syntax" > NULL< / 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" > D< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2019-02-04 22:26:45 +00:00
2020-04-25 12:26:09 +00:00
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Directories::next< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > scan_directory< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > leafname< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > char< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > leafname_Cs< / span > < span class = "plain-syntax" > [< / span > < span class = "constant-syntax" > MAX_FILENAME_LENGTH< / 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" > rv< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > TRUE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > while< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > rv< / span > < span class = "plain-syntax" > ) {< / span >
2020-07-06 22:01:05 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > rv< / span > < span class = "plain-syntax" > = < / span > < a href = "1-wp.html#SP9" class = "function-link" > < span class = "function-syntax" > Platform::readdir< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > directory_handle< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > directory_name_written_out< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > leafname_Cs< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > leafname_Cs< / span > < span class = "plain-syntax" > [0] != < / span > < span class = "character-syntax" > '.'< / span > < span class = "plain-syntax" > ) < / span > < span class = "reserved-syntax" > break< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "4-sm.html#SP15" class = "function-link" > < span class = "function-syntax" > Str::clear< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > leafname< / 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" > rv< / span > < span class = "plain-syntax" > ) < / span > < a href = "2-str.html#SP32" class = "function-link" > < span class = "function-syntax" > Streams::write_locale_string< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > leafname< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > leafname_Cs< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > rv< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2019-02-04 22:26:45 +00:00
2020-04-25 12:26:09 +00:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Directories::close< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > scan_directory< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > ) {< / span >
2020-07-06 22:01:05 +00:00
< span class = "plain-syntax" > < / span > < a href = "1-wp.html#SP9" class = "function-link" > < span class = "function-syntax" > Platform::closedir< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > directory_handle< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
2020-04-24 10:26:18 +00:00
< / pre >
2020-04-30 22:36:38 +00:00
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprev" > < a href = "3-shl.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "P-abgtf.html" > P< / a > < / li > < li class = "progresschapter" > < a href = "1-fm.html" > 1< / a > < / li > < li class = "progresschapter" > < a href = "2-dl.html" > 2< / a > < / li > < li class = "progresscurrentchapter" > 3< / li > < li class = "progresssection" > < a href = "3-em.html" > em< / a > < / li > < li class = "progresssection" > < a href = "3-cla.html" > cla< / a > < / li > < li class = "progresssection" > < a href = "3-pth.html" > pth< / a > < / li > < li class = "progresssection" > < a href = "3-fln.html" > fln< / a > < / li > < li class = "progresssection" > < a href = "3-cf.html" > cf< / a > < / li > < li class = "progresssection" > < a href = "3-shl.html" > shl< / a > < / li > < li class = "progresscurrent" > drc< / li > < li class = "progresssection" > < a href = "3-tm.html" > tm< / a > < / li > < li class = "progresschapter" > < a href = "4-chr.html" > 4< / a > < / li > < li class = "progresschapter" > < a href = "5-htm.html" > 5< / a > < / li > < li class = "progresschapter" > < a href = "6-bf.html" > 6< / a > < / li > < li class = "progresschapter" > < a href = "7-vn.html" > 7< / a > < / li > < li class = "progresschapter" > < a href = "8-ws.html" > 8< / a > < / li > < li class = "progressnext" > < a href = "3-tm.html" > ❯ < / a > < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
2020-04-23 22:23:44 +00:00
2020-03-19 00:03:04 +00:00
< / main >
2019-02-04 22:26:45 +00:00
< / body >
< / html >