2020-02-27 13:18:25 +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 > Template Manager< / title >
2020-03-19 02:11:25 +02:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2020-02-27 13:18:25 +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
2020-02-27 13:18:25 +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 = "index.html" > < span class = "selectedlink" > supervisor< / span > < / 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 = "../problems-module/index.html" > problems< / 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 'Template Manager' generated by 7 -->
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../compiler.html" > Inbuild Modules< / a > < / li > < li > < a href = "index.html" > supervisor< / a > < / li > < li > < a href = "index.html#4" > Chapter 4: Genre Management< / a > < / li > < li > < b > Template Manager< / b > < / li > < / ul > < p class = "purpose" > Claiming and creating copies of the template genre: used for website and interpreter templates when releasing an Inform project.< / p >
2020-02-27 13:18:25 +02:00
2020-04-16 01:49:59 +03:00
< ul class = "toc" > < li > < a href = "4-tm.html#SP1" > § 1. Genre definition< / a > < / li > < li > < a href = "4-tm.html#SP4" > § 4. Claiming< / a > < / li > < li > < a href = "4-tm.html#SP5" > § 5. Searching< / a > < / li > < li > < a href = "4-tm.html#SP6" > § 6. Copying< / a > < / li > < / ul > < hr class = "tocbar" >
2020-02-27 13:18:25 +02:00
2020-03-30 15:25:23 +03:00
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. Genre definition. < / b > The < code class = "display" > < span class = "extract" > template_genre< / span > < / code > can be summarised as follows. Website templates
are directories. They are recognised by containing either a metadata file
called < code class = "display" > < span class = "extract" > (manifest).txt< / span > < / code > or < code class = "display" > < span class = "extract" > index.html< / span > < / code > , or both. They are stored in
nests, in < code class = "display" > < span class = "extract" > N/Templates/Title-vVersion< / span > < / code > . Their build graphs are single
vertices with no build or use edges.
< / p >
2020-02-27 13:18:25 +02:00
< pre class = "display" >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > TemplateManager::start< button class = "popup" onclick = "togglePopup('usagePopup229')" > ...< span class = "popuptext" id = "usagePopup229" > Usage of < b > TemplateManager::start< / b > :< br > Inbuild Control - < a href = "1-ic.html#SP3" > § 3< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > template_genre< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "2-gnr.html#SP1" > Genres::new< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > I< / span > < span class = "string" > "template"< / span > < span class = "plain" > , < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > );< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > METHOD_ADD< / span > < span class = "plain" > (< / span > < span class = "identifier" > template_genre< / span > < span class = "plain" > , < / span > < span class = "constant" > GENRE_WRITE_WORK_MTID< / span > < span class = "plain" > , < / span > < span class = "functiontext" > < a href = "4-tm.html#SP1" > TemplateManager::write_work< / a > < / span > < span class = "plain" > );< / span >
< span class = "identifier" > METHOD_ADD< / span > < span class = "plain" > (< / span > < span class = "identifier" > template_genre< / span > < span class = "plain" > , < / span > < span class = "constant" > GENRE_CLAIM_AS_COPY_MTID< / span > < span class = "plain" > , < / span > < span class = "functiontext" > < a href = "4-tm.html#SP4" > TemplateManager::claim_as_copy< / a > < / span > < span class = "plain" > );< / span >
< span class = "identifier" > METHOD_ADD< / span > < span class = "plain" > (< / span > < span class = "identifier" > template_genre< / span > < span class = "plain" > , < / span > < span class = "constant" > GENRE_SEARCH_NEST_FOR_MTID< / span > < span class = "plain" > , < / span > < span class = "functiontext" > < a href = "4-tm.html#SP5" > TemplateManager::search_nest_for< / a > < / span > < span class = "plain" > );< / span >
< span class = "identifier" > METHOD_ADD< / span > < span class = "plain" > (< / span > < span class = "identifier" > template_genre< / span > < span class = "plain" > , < / span > < span class = "constant" > GENRE_COPY_TO_NEST_MTID< / span > < span class = "plain" > , < / span > < span class = "functiontext" > < a href = "4-tm.html#SP6" > TemplateManager::copy_to_nest< / a > < / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +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" > TemplateManager::write_work< button class = "popup" onclick = "togglePopup('usagePopup230')" > ...< span class = "popuptext" id = "usagePopup230" > Usage of < b > TemplateManager::write_work< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_genre< / span > < span class = "plain" > *< / span > < span class = "identifier" > gen< / span > < span class = "plain" > , < / span > < span class = "identifier" > OUTPUT_STREAM< / span > < span class = "plain" > , < / span > < span class = "reserved" > inbuild_work< / span > < span class = "plain" > *< / span > < span class = "identifier" > work< / span > < span class = "plain" > ) {< / span >
2020-04-07 03:06:09 +03:00
< span class = "identifier" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "%S"< / span > < span class = "plain" > , < / span > < span class = "identifier" > work< / span > < span class = "plain" > -> < / span > < span class = "element" > title< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP2" > < / a > < b > § 2. < / b > Templates live in the < code class = "display" > < span class = "extract" > Templates< / span > < / code > subdirectory of a nest:
< / p >
< pre class = "display" >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "functiontext" > TemplateManager::path_within_nest< button class = "popup" onclick = "togglePopup('usagePopup231')" > ...< span class = "popuptext" id = "usagePopup231" > Usage of < b > TemplateManager::path_within_nest< / b > :< br > < a href = "4-tm.html#SP5" > § 5< / a > , < a href = "4-tm.html#SP6" > § 6< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_nest< / span > < span class = "plain" > *< / span > < span class = "identifier" > N< / span > < span class = "plain" > ) {< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > N< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > internal_error< / span > < span class = "plain" > (< / span > < span class = "string" > "no nest"< / span > < span class = "plain" > );< / span >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > Pathnames::down< / span > < span class = "plain" > (< / span > < span class = "identifier" > N< / span > < span class = "plain" > -> < / span > < span class = "element" > location< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "Templates"< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP3" > < / a > < b > § 3. < / b > Template copies are annotated with a structure called an < code class = "display" > < span class = "extract" > inform_template< / span > < / code > ,
which stores data about extensions used by the Inform compiler.
< / p >
< pre class = "display" >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > inform_template< / span > < span class = "plain" > *< / span > < span class = "functiontext" > TemplateManager::from_copy< button class = "popup" onclick = "togglePopup('usagePopup232')" > ...< span class = "popuptext" id = "usagePopup232" > Usage of < b > TemplateManager::from_copy< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "identifier" > C< / 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" > C< / span > < span class = "plain" > ) & & (< / span > < span class = "identifier" > C< / span > < span class = "plain" > -> < / span > < span class = "element" > edition< / span > < span class = "plain" > -> < / span > < span class = "element" > work< / span > < span class = "plain" > -> < / span > < span class = "element" > genre< / span > < span class = "plain" > == < / span > < span class = "identifier" > template_genre< / span > < span class = "plain" > )) {< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > RETRIEVE_POINTER_inform_template< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > -> < / span > < span class = "element" > content< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "functiontext" > TemplateManager::new_copy< button class = "popup" onclick = "togglePopup('usagePopup233')" > ...< span class = "popuptext" id = "usagePopup233" > Usage of < b > TemplateManager::new_copy< / b > :< br > < a href = "4-tm.html#SP4" > § 4< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > name< / span > < span class = "plain" > , < / span > < span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > ) {< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > inform_template< / span > < span class = "plain" > *< / span > < span class = "identifier" > K< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "5-ts.html#SP1" > Templates::new_it< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > name< / span > < span class = "plain" > , < / span > < span class = "identifier" > P< / span > < span class = "plain" > );< / span >
< span class = "reserved" > inbuild_work< / span > < span class = "plain" > *< / span > < span class = "identifier" > work< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "2-wrk.html#SP2" > Works::new< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > template_genre< / span > < span class = "plain" > , < / span > < span class = "identifier" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > name< / span > < span class = "plain" > ), < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > );< / span >
< span class = "reserved" > inbuild_edition< / span > < span class = "plain" > *< / span > < span class = "identifier" > edition< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "2-edt.html#SP1" > Editions::new< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > work< / span > < span class = "plain" > , < / span > < span class = "identifier" > K< / span > < span class = "plain" > -> < / span > < span class = "element" > version< / span > < span class = "plain" > );< / span >
< span class = "identifier" > K< / span > < span class = "plain" > -> < / span > < span class = "element" > as_copy< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "2-cps.html#SP3" > Copies::new_in_path< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > edition< / span > < span class = "plain" > , < / span > < span class = "identifier" > P< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > < a href = "2-cps.html#SP4" > Copies::set_content< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > K< / span > < span class = "plain" > -> < / span > < span class = "element" > as_copy< / span > < span class = "plain" > , < / span > < span class = "identifier" > STORE_POINTER_inform_template< / span > < span class = "plain" > (< / span > < span class = "identifier" > K< / span > < span class = "plain" > ));< / span >
2020-04-07 03:06:09 +03:00
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > K< / span > < span class = "plain" > -> < / span > < span class = "identifier" > as_copy< / span > < span class = "plain" > ;< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP4" > < / a > < b > § 4. Claiming. < / b > Here < code class = "display" > < span class = "extract" > arg< / span > < / code > is a textual form of a filename or pathname, such as may have been
supplied at the command line; < code class = "display" > < span class = "extract" > ext< / span > < / code > is a substring of it, and is its extension
(e.g., < code class = "display" > < span class = "extract" > jpg< / span > < / code > if < code class = "display" > < span class = "extract" > arg< / span > < / code > is < code class = "display" > < span class = "extract" > Geraniums.jpg< / span > < / code > ), or is empty if there isn't one;
< code class = "display" > < span class = "extract" > directory_status< / span > < / code > is true if we know for some reason that this is a directory
not a file, false if we know the reverse, and otherwise not applicable.
< / p >
< p class = "inwebparagraph" > Templates are slightly hard to recognise in isolation, but they contain
either a manifest file, or else an < code class = "display" > < span class = "extract" > index.html< / span > < / code > , so that will have to do.
< / p >
< pre class = "display" >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > TemplateManager::claim_as_copy< button class = "popup" onclick = "togglePopup('usagePopup234')" > ...< span class = "popuptext" id = "usagePopup234" > Usage of < b > TemplateManager::claim_as_copy< / b > :< br > < a href = "4-tm.html#SP1" > § 1< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_genre< / span > < span class = "plain" > *< / span > < span class = "identifier" > gen< / span > < span class = "plain" > , < / span > < span class = "reserved" > inbuild_copy< / span > < span class = "plain" > **< / span > < span class = "identifier" > C< / span > < span class = "plain" > ,< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > arg< / span > < span class = "plain" > , < / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > ext< / span > < span class = "plain" > , < / span > < span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > directory_status< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > directory_status< / span > < span class = "plain" > == < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > = < / span > < span class = "identifier" > Pathnames::from_text< / span > < span class = "plain" > (< / span > < span class = "identifier" > arg< / span > < span class = "plain" > );< / span >
2020-04-16 01:49:59 +03:00
< span class = "plain" > *< / span > < span class = "identifier" > C< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "4-tm.html#SP4" > TemplateManager::claim_folder_as_copy< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "functiontext" > TemplateManager::claim_folder_as_copy< button class = "popup" onclick = "togglePopup('usagePopup235')" > ...< span class = "popuptext" id = "usagePopup235" > Usage of < b > TemplateManager::claim_folder_as_copy< / b > :< br > < a href = "4-tm.html#SP5" > § 5< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > canary1< / span > < span class = "plain" > = < / span > < span class = "identifier" > Filenames::in< / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "(manifest).txt"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > canary2< / span > < span class = "plain" > = < / span > < span class = "identifier" > Filenames::in< / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "index.html"< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > TextFiles::exists< / span > < span class = "plain" > (< / span > < span class = "identifier" > canary1< / span > < span class = "plain" > )) || (< / span > < span class = "identifier" > TextFiles::exists< / span > < span class = "plain" > (< / span > < span class = "identifier" > canary2< / span > < span class = "plain" > ))) {< / span >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "identifier" > C< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "4-tm.html#SP3" > TemplateManager::new_copy< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > Pathnames::directory_name< / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > ), < / span > < span class = "identifier" > P< / span > < span class = "plain" > );< / span >
2020-04-14 19:56:54 +03:00
< span class = "functiontext" > < a href = "2-wrk.html#SP11" > Works::add_to_database< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > -> < / span > < span class = "element" > edition< / span > < span class = "plain" > -> < / span > < span class = "element" > work< / span > < span class = "plain" > , < / span > < span class = "constant" > CLAIMED_WDBC< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > C< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP5" > < / a > < b > § 5. Searching. < / b > Here we look through a nest to find all kits matching the supplied
requirements.
< / p >
< pre class = "display" >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > TemplateManager::search_nest_for< button class = "popup" onclick = "togglePopup('usagePopup236')" > ...< span class = "popuptext" id = "usagePopup236" > Usage of < b > TemplateManager::search_nest_for< / b > :< br > < a href = "4-tm.html#SP1" > § 1< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_genre< / span > < span class = "plain" > *< / span > < span class = "identifier" > gen< / span > < span class = "plain" > , < / span > < span class = "reserved" > inbuild_nest< / span > < span class = "plain" > *< / span > < span class = "identifier" > N< / span > < span class = "plain" > ,< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > inbuild_requirement< / span > < span class = "plain" > *< / span > < span class = "identifier" > req< / span > < span class = "plain" > , < / span > < span class = "identifier" > linked_list< / span > < span class = "plain" > *< / span > < span class = "identifier" > search_results< / 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" > req< / span > < span class = "plain" > -> < / span > < span class = "identifier" > work< / span > < span class = "plain" > -> < / span > < span class = "element" > genre< / span > < span class = "plain" > ) & & (< / span > < span class = "identifier" > req< / span > < span class = "plain" > -> < / span > < span class = "element" > work< / span > < span class = "plain" > -> < / span > < span class = "element" > genre< / span > < span class = "plain" > != < / span > < span class = "identifier" > template_genre< / span > < span class = "plain" > )) < / span > < span class = "reserved" > return< / span > < span class = "plain" > ;< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "4-tm.html#SP2" > TemplateManager::path_within_nest< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > N< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > scan_directory< / span > < span class = "plain" > *< / span > < span class = "identifier" > D< / span > < span class = "plain" > = < / span > < span class = "identifier" > Directories::open< / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > D< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > LEAFNAME< / span > < span class = "plain" > );< / span >
< span class = "reserved" > while< / span > < span class = "plain" > (< / span > < span class = "identifier" > Directories::next< / span > < span class = "plain" > (< / span > < span class = "identifier" > D< / span > < span class = "plain" > , < / span > < span class = "identifier" > LEAFNAME< / span > < span class = "plain" > )) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::get_last_char< / span > < span class = "plain" > (< / span > < span class = "identifier" > LEAFNAME< / span > < span class = "plain" > ) == < / span > < span class = "identifier" > FOLDER_SEPARATOR< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > Str::delete_last_character< / span > < span class = "plain" > (< / span > < span class = "identifier" > LEAFNAME< / span > < span class = "plain" > );< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > Q< / span > < span class = "plain" > = < / span > < span class = "identifier" > Pathnames::down< / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > , < / span > < span class = "identifier" > LEAFNAME< / span > < span class = "plain" > );< / span >
< span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "identifier" > C< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "4-tm.html#SP4" > TemplateManager::claim_folder_as_copy< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > Q< / span > < span class = "plain" > );< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > C< / span > < span class = "plain" > ) & & (< / span > < span class = "functiontext" > < a href = "2-rqr.html#SP7" > Requirements::meets< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > -> < / span > < span class = "element" > edition< / span > < span class = "plain" > , < / span > < span class = "identifier" > req< / span > < span class = "plain" > ))) {< / span >
< span class = "functiontext" > < a href = "2-nst.html#SP6" > Nests::add_search_result< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > search_results< / span > < span class = "plain" > , < / span > < span class = "identifier" > N< / span > < span class = "plain" > , < / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "identifier" > req< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > LEAFNAME< / span > < span class = "plain" > );< / span >
< span class = "identifier" > Directories::close< / span > < span class = "plain" > (< / span > < span class = "identifier" > D< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP6" > < / a > < b > § 6. Copying. < / b > Now the task is to copy a template into place in a nest. Since a template is
a folder, we need to < code class = "display" > < span class = "extract" > rsync< / span > < / code > it.
< / p >
< pre class = "display" >
2020-04-14 19:56:54 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "functiontext" > TemplateManager::pathname_in_nest< button class = "popup" onclick = "togglePopup('usagePopup237')" > ...< span class = "popuptext" id = "usagePopup237" > Usage of < b > TemplateManager::pathname_in_nest< / b > :< br > none< / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_nest< / span > < span class = "plain" > *< / span > < span class = "identifier" > N< / span > < span class = "plain" > , < / span > < span class = "reserved" > inbuild_edition< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
2020-03-11 02:21:09 +02:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > leaf< / span > < span class = "plain" > );< / span >
2020-04-14 19:56:54 +03:00
< span class = "functiontext" > < a href = "2-edt.html#SP2" > Editions::write_canonical_leaf< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > leaf< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > );< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > = < / span > < span class = "identifier" > Pathnames::down< / span > < span class = "plain" > (< / span > < span class = "functiontext" > < a href = "4-tm.html#SP2" > TemplateManager::path_within_nest< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > N< / span > < span class = "plain" > ), < / span > < span class = "identifier" > leaf< / span > < span class = "plain" > );< / span >
2020-03-11 02:21:09 +02:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > leaf< / span > < span class = "plain" > );< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > P< / span > < span class = "plain" > ;< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
2020-04-16 01:49:59 +03:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > TemplateManager::copy_to_nest< button class = "popup" onclick = "togglePopup('usagePopup238')" > ...< span class = "popuptext" id = "usagePopup238" > Usage of < b > TemplateManager::copy_to_nest< / b > :< br > < a href = "4-tm.html#SP1" > § 1< / a > < / span > < / button > < / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_genre< / span > < span class = "plain" > *< / span > < span class = "identifier" > gen< / span > < span class = "plain" > , < / span > < span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "reserved" > inbuild_nest< / span > < span class = "plain" > *< / span > < span class = "identifier" > N< / span > < span class = "plain" > ,< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > syncing< / span > < span class = "plain" > , < / span > < span class = "reserved" > build_methodology< / span > < span class = "plain" > *< / span > < span class = "identifier" > meth< / span > < span class = "plain" > ) {< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > pathname< / span > < span class = "plain" > *< / span > < span class = "identifier" > P< / span > < span class = "plain" > = < / span > < span class = "functiontext" > < a href = "4-tm.html#SP6" > TemplateManager::pathname_in_nest< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > N< / span > < span class = "plain" > , < / span > < span class = "identifier" > C< / span > < span class = "plain" > -> < / span > < span class = "element" > edition< / span > < span class = "plain" > );< / span >
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > canary1< / span > < span class = "plain" > = < / span > < span class = "identifier" > Filenames::in< / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "(manifest).txt"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > canary2< / span > < span class = "plain" > = < / span > < span class = "identifier" > Filenames::in< / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "index.html"< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > TextFiles::exists< / span > < span class = "plain" > (< / span > < span class = "identifier" > canary1< / span > < span class = "plain" > )) || (< / span > < span class = "identifier" > TextFiles::exists< / span > < span class = "plain" > (< / span > < span class = "identifier" > canary2< / span > < span class = "plain" > ))) {< / span >
2020-04-14 19:56:54 +03:00
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > syncing< / span > < span class = "plain" > == < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ) { < / span > < span class = "functiontext" > < a href = "2-cps.html#SP13" > Copies::overwrite_error< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "identifier" > N< / span > < span class = "plain" > ); < / span > < span class = "reserved" > return< / span > < span class = "plain" > ; }< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > } < / span > < span class = "reserved" > else< / 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" > meth< / span > < span class = "plain" > -> < / span > < span class = "identifier" > methodology< / span > < span class = "plain" > == < / span > < span class = "constant" > DRY_RUN_METHODOLOGY< / span > < span class = "plain" > ) {< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > , < / span > < span class = "string" > "mkdir -p "< / span > < span class = "plain" > );< / span >
< span class = "identifier" > Shell::quote_path< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > , < / span > < span class = "identifier" > P< / 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" > STDOUT< / span > < span class = "plain" > , < / span > < span class = "string" > "%S\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > command< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > );< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > {< / span >
2020-04-07 03:06:09 +03:00
< span class = "identifier" > Pathnames::create_in_file_system< / span > < span class = "plain" > (< / span > < span class = "identifier" > N< / span > < span class = "plain" > -> < / span > < span class = "element" > location< / span > < span class = "plain" > );< / span >
2020-04-16 01:49:59 +03:00
< span class = "identifier" > Pathnames::create_in_file_system< / span > < span class = "plain" > (< / span > < span class = "functiontext" > < a href = "4-tm.html#SP2" > TemplateManager::path_within_nest< / a > < / span > < span class = "plain" > (< / span > < span class = "identifier" > N< / span > < span class = "plain" > ));< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > Pathnames::create_in_file_system< / span > < span class = "plain" > (< / span > < span class = "identifier" > P< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / 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" > meth< / span > < span class = "plain" > -> < / span > < span class = "identifier" > methodology< / span > < span class = "plain" > == < / span > < span class = "constant" > DRY_RUN_METHODOLOGY< / span > < span class = "plain" > ) {< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > , < / span > < span class = "string" > "rsync -a --delete "< / span > < span class = "plain" > );< / span >
2020-04-07 03:06:09 +03:00
< span class = "identifier" > Shell::quote_path< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > , < / span > < span class = "identifier" > C< / span > < span class = "plain" > -> < / span > < span class = "element" > location_if_path< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > Shell::quote_path< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > , < / span > < span class = "identifier" > P< / 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" > STDOUT< / span > < span class = "plain" > , < / span > < span class = "string" > "%S\n"< / span > < span class = "plain" > , < / span > < span class = "identifier" > command< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > command< / span > < span class = "plain" > );< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > {< / span >
2020-04-07 03:06:09 +03:00
< span class = "identifier" > Pathnames::rsync< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > -> < / span > < span class = "element" > location_if_path< / span > < span class = "plain" > , < / span > < span class = "identifier" > P< / span > < span class = "plain" > );< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< hr class = "tocbar" >
2020-03-31 02:17:21 +03:00
< ul class = "toc" > < li > < a href = "4-pfm.html" > Back to 'Project File Manager'< / a > < / li > < li > < i > (This section ends Chapter 4: Genre Management.)< / i > < / li > < / ul > < hr class = "tocbar" >
2020-02-27 13:18:25 +02: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 >
2020-02-27 13:18:25 +02:00
< / body >
< / html >
