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 >
< title > 6/mkf< / 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" >
2019-02-04 22:26:45 +00:00
< / head >
< body >
2020-03-19 00:03:04 +00:00
< nav role = "navigation" >
< h1 > < a href = "../webs.html" > Sources< / a > < / h1 >
< ul >
< li > < a href = "../inweb/index.html" > inweb< / a > < / li >
< / ul >
< h2 > Foundation< / h2 >
< ul >
< li > < a href = "../foundation-module/index.html" > foundation-module< / a > < / li >
< li > < a href = "../foundation-test/index.html" > foundation-test< / a > < / li >
< / ul >
< / nav >
< main role = "main" >
2019-02-09 12:33:40 +00:00
<!-- Weave of '6/gs' generated by 7 -->
2020-03-23 15:04:43 +00:00
< ul class = "crumbs" > < li > < a href = "../webs.html" > Source< / a > < / li > < li > < a href = "index.html" > inweb< / a > < / li > < li > < a href = "index.html#6" > Chapter 6: Extras< / a > < / li > < li > < b > Git Support< / b > < / li > < / ul > < p class = "purpose" > Constructing a suitable gitignore file for a simple inweb project.< / p >
2019-02-04 22:26:45 +00:00
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. < / b > This section offers just one function, which constructs a < code class = "display" > < span class = "extract" > .gitignore< / span > < / code >
file by following a "prototype".
< / p >
< pre class = "display" >
2020-04-05 17:37:43 +00:00
< span class = "identifier" > typedef< / span > < span class = "plain" > < / span > < span class = "identifier" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > gitignore_state< / span > < span class = "plain" > {< / span >
< span class = "identifier" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > web< / span > < span class = "plain" > *< / span > < span class = "identifier" > for_web< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > < / span > < span class = "identifier" > to_gitignore< / span > < span class = "plain" > ;< / span >
2020-04-05 00:03:36 +00:00
< span class = "identifier" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > last_line_was_blank< / span > < span class = "plain" > ; < / span > < span class = "comment" > used to suppress runs of multiple blank lines< / span >
2020-04-05 17:37:43 +00:00
< span class = "plain" > } < / span > < span class = "identifier" > gitignore_state< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > void< / span > < span class = "plain" > < / span > < span class = "identifier" > Git::write_gitignore< / span > < span class = "plain" > (< / span > < span class = "identifier" > web< / span > < span class = "plain" > *< / span > < span class = "identifier" > W< / span > < span class = "plain" > , < / span > < span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > prototype< / span > < span class = "plain" > , < / span > < span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > F< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > gitignore_state< / span > < span class = "plain" > < / span > < span class = "identifier" > MS< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > MS< / span > < span class = "plain" > .< / span > < span class = "identifier" > for_web< / span > < span class = "plain" > = < / span > < span class = "identifier" > W< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > MS< / span > < span class = "plain" > .< / span > < span class = "identifier" > last_line_was_blank< / span > < span class = "plain" > = < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > OUT< / span > < span class = "plain" > = & (< / span > < span class = "identifier" > MS< / span > < span class = "plain" > .< / span > < span class = "identifier" > to_gitignore< / span > < span class = "plain" > );< / span >
< span class = "identifier" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > STREAM_OPEN_TO_FILE< / span > < span class = "plain" > (< / span > < span class = "identifier" > OUT< / span > < span class = "plain" > , < / span > < span class = "identifier" > F< / span > < span class = "plain" > , < / span > < span class = "identifier" > ISO_ENC< / span > < span class = "plain" > ) == < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > )< / span >
< span class = "identifier" > Errors::fatal_with_file< / span > < span class = "plain" > (< / span > < span class = "string" > "unable to write tangled file"< / 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" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "# This gitignore was automatically written by inweb -gitignore\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "# and is not intended for human editing\< / span > < span class = "plain" > n< / span > < span class = "string" > \< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > );< / span >
2020-04-05 17:37:43 +00:00
< span class = "identifier" > TextFiles::read< / span > < span class = "plain" > (< / span > < span class = "identifier" > prototype< / span > < span class = "plain" > , < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > , < / span > < span class = "string" > "can't open prototype file"< / span > < span class = "plain" > ,< / span >
< span class = "identifier" > TRUE< / span > < span class = "plain" > , < / span > < span class = "identifier" > Git::copy_gitignore_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , & < / span > < span class = "identifier" > MS< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > STREAM_CLOSE< / span > < span class = "plain" > (< / span > < span class = "identifier" > OUT< / span > < span class = "plain" > );< / span >
2020-04-05 17:37:43 +00:00
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > STDOUT< / span > < span class = "plain" > , < / span > < span class = "string" > "Wrote gitignore file '%f' from script '%f'\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > , < / span > < span class = "identifier" > F< / span > < span class = "plain" > , < / span > < span class = "identifier" > prototype< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Git::write_gitignore is used in 1/pc (< a href = "1-pc.html#SP7_1" > § 7.1< / a > ), 3/ta (< a href = "3-ta.html#SP13" > § 13< / a > ).< / p >
< p class = "endnote" > The structure gitignore_state is accessed in 6/mkf and here.< / p >
< p class = "inwebparagraph" > < a id = "SP2" > < / a > < b > § 2. < / b > < / p >
< pre class = "display" >
2020-04-05 17:37:43 +00:00
< span class = "identifier" > void< / span > < span class = "plain" > < / span > < span class = "identifier" > Git::copy_gitignore_line< / span > < span class = "plain" > (< / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "identifier" > text_file_position< / span > < span class = "plain" > *< / span > < span class = "identifier" > tfp< / span > < span class = "plain" > , < / span > < span class = "identifier" > void< / span > < span class = "plain" > *< / span > < span class = "identifier" > X< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > gitignore_state< / span > < span class = "plain" > *< / span > < span class = "identifier" > MS< / span > < span class = "plain" > = (< / span > < span class = "identifier" > gitignore_state< / span > < span class = "plain" > *) < / span > < span class = "identifier" > X< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > OUT< / span > < span class = "plain" > = & (< / span > < span class = "identifier" > MS< / span > < span class = "plain" > -> < / span > < span class = "identifier" > to_gitignore< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
2020-04-05 17:37:43 +00:00
< span class = "identifier" > match_results< / span > < span class = "plain" > < / span > < span class = "identifier" > mr< / span > < span class = "plain" > = < / span > < span class = "identifier" > Regexp::create_mr< / span > < span class = "plain" > ();< / span >
< span class = "identifier" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > " *#%c*"< / span > < span class = "plain" > )) { < / span > < span class = "identifier" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > ); < / span > < span class = "identifier" > return< / span > < span class = "plain" > ; }< / span >
< span class = "identifier" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > " *{basics} *"< / span > < span class = "plain" > )) < / span > < < span class = "cwebmacro" > Expand basics< / span > < span class = "cwebmacronumber" > 2.1< / span > > < span class = "plain" > ;< / span >
< span class = "identifier" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > );< / span >
2019-02-04 22:26:45 +00:00
< < span class = "cwebmacro" > And otherwise copy the line straight through< / span > < span class = "cwebmacronumber" > 2.2< / span > > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Git::copy_gitignore_line is used in < a href = "#SP1" > § 1< / a > , < a href = "#SP2_1" > § 2.1< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP2_1" > < / a > < b > § 2.1. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Expand basics< / span > < span class = "cwebmacronumber" > 2.1< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
2020-04-05 17:37:43 +00:00
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > prototype< / span > < span class = "plain" > =< / span >
< span class = "identifier" > Filenames::in_folder< / span > < span class = "plain" > (< / span > < span class = "identifier" > path_to_inweb_materials< / span > < span class = "plain" > , < / span > < span class = "identifier" > I< / span > < span class = "string" > "gitignorescript.txt"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > TextFiles::read< / span > < span class = "plain" > (< / span > < span class = "identifier" > prototype< / span > < span class = "plain" > , < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > , < / span > < span class = "string" > "can't open make settings file"< / span > < span class = "plain" > ,< / span >
< span class = "identifier" > TRUE< / span > < span class = "plain" > , < / span > < span class = "identifier" > Git::copy_gitignore_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , < / span > < span class = "identifier" > MS< / span > < span class = "plain" > );< / span >
< span class = "identifier" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > );< / span >
2020-04-05 00:03:36 +00:00
< span class = "identifier" > return< / span > < span class = "plain" > ;< / span >
2019-02-04 22:26:45 +00:00
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP2" > § 2< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP2_2" > < / a > < b > § 2.2. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > And otherwise copy the line straight through< / span > < span class = "cwebmacronumber" > 2.2< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
2020-04-05 17:37:43 +00:00
< span class = "identifier" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > line< / span > < span class = "plain" > ) == < / span > < span class = "constant" > 0< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > MS< / span > < span class = "plain" > -> < / span > < span class = "identifier" > last_line_was_blank< / span > < span class = "plain" > == < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ) < / span > < span class = "identifier" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > );< / span >
< span class = "identifier" > MS< / span > < span class = "plain" > -> < / span > < span class = "identifier" > last_line_was_blank< / span > < span class = "plain" > = < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ;< / span >
2020-04-05 00:03:36 +00:00
< span class = "plain" > } < / span > < span class = "identifier" > else< / span > < span class = "plain" > {< / span >
2020-04-05 17:37:43 +00:00
< span class = "identifier" > MS< / span > < span class = "plain" > -> < / span > < span class = "identifier" > last_line_was_blank< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
2019-02-04 22:26:45 +00:00
< span class = "identifier" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "%S\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > , < / span > < span class = "identifier" > line< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP2" > § 2< / a > .< / p >
2019-03-12 23:32:12 +00:00
< hr class = "tocbar" >
2020-04-01 19:43:48 +00:00
< ul class = "toc" > < li > < a href = "6-mkf.html" > Back to 'Makefiles'< / a > < / li > < li > < a href = "6-rw.html" > Continue with 'Readme Writeme'< / a > < / li > < / ul > < hr class = "tocbar" >
2019-03-18 11:16:10 +00:00
<!-- End of weave -->
2020-03-19 00:03:04 +00:00
< / main >
2019-02-04 22:26:45 +00:00
< / body >
< / html >
