X-Git-Url: https://zdv2.bktei.com/gitweb/BK-2023-05.git/blobdiff_plain/29607ac01b10c735406ff0584dd903416623b20a..b79e0a8bf378602e9df72410dc711532c40115b1:/src/notes.tm

diff --git a/src/notes.tm b/src/notes.tm
index 67728a6..03d208a 100644
--- a/src/notes.tm
+++ b/src/notes.tm
@@ -3,11 +3,53 @@
 <style|<tuple|book|style-bk>>
 
 <\body>
+  <\hide-preamble>
+    \;
+
+    <assign|description-aligned|<\macro|body>
+      <compound|<if|<and|<value|<merge|prefix-|description-aligned>>|<unequal|<value|last-item-nr>|0>>|list*|list>|<macro|name|<aligned-item|<item-strong|<arg|name><item-spc>>>>|<macro|name|<with|mode|math|<with|font-series|bold|math-font-series|bold|<rigid|\<ast\>>>>>|<arg|body>>
+    </macro>>
+  </hide-preamble>
+
   <chapter|Definitions>
 
   <section|Terminology>
 
   <\description-compact>
+    <item*|assignment>An expression in which a variable is set to a value.
+    For example, in the expression <hgroup|<cpp|x = 1>>, the variable <cpp|x>
+    is set to the value <cpp|1> because <cpp|x> is to the left of the equals
+    sign \ \P<cpp|=>\Q. The value of the entire expression is equal to the
+    value of the left hand side (i.e. <cpp|x> in this example) after the
+    assignment is performed. For example, the following C code will print
+    \P<cpp|true>\Q:
+
+    <\cpp-code>
+      #include \<less\>stdio.h\<gtr\>
+
+      int main() {
+
+      \ \ int c;
+
+      \ \ if( (c = 7) == 7 )
+
+      \ \ \ \ printf("true");
+
+      \ \ else
+
+      \ \ \ \ printf("false");
+
+      };
+    </cpp-code>
+
+    As another example, the following lines are equivalent:
+
+    <\cpp-code>
+      a = b = c = 0;
+
+      a = ( b = ( c = 0 ) );
+    </cpp-code>
+
     <item*|declaration<label|term declaration>>A construct that establishes
     an association between a particular variable, function, or type and its
     attributes. (See <hlink|cppreference.com|https://en.cppreference.com/w/c/language/declarations>
@@ -18,6 +60,9 @@
     same associations as a declaration but also causes storage to be
     allocated for the variable. (See <hlink|microsoft.com|https://docs.microsoft.com/en-us/cpp/c-language/c-declarations-and-definitions>).
 
+    <item*|delinter><label|term_delinter> A source code analysis program
+    designed to detect common syntactic errors.
+
     <item*|enumeration<label|term enumeration>><hlink|Enumeration|https://en.wikipedia.org/wiki/Enumeration>
     (or <code*|enum>) is a user defined data type in <name|C>. It is mainly
     used to assign names to integral constants. For example, the declaration
@@ -30,7 +75,7 @@
     used to represent hard-to-type or invisible characters. Some commonly
     used escape sequences in <name|C> include:
 
-    <\description-paragraphs>
+    <\description-aligned>
       <item*|<cpp|\\n>>Represents the <em|newline> character.
 
       <item*|<cpp|\\t>>Represents the <em|tab> character.
@@ -39,11 +84,11 @@
 
       <item*|<cpp|\\\\>>Represents the <em|backslash> (i.e.
       \P<verbatim|<em|\\>>\Q) character.
-    </description-paragraphs>
+    </description-aligned>
 
     All other escape sequences used in <name|C> are:
 
-    <\description-paragraphs>
+    <\description-aligned>
       <item*|<cpp|\\a>>Represents the <em|alert> (bell) character.
 
       <item*|<cpp|\\f>>Represents the <em|formfeed> character.
@@ -69,7 +114,7 @@
       <item*|<cpp|\\x><em|hh>>Represents a <em|hexadecimal> number (e.g.
       <cpp|\\x0A> is the <em|newline> character<rsup|<reference|ref
       includehelp-oct-hex>>).
-    </description-paragraphs>
+    </description-aligned>
 
     <label|term garbage_collection><item*|garbage collection>The process of
     freeing memory allocated by a program but which is no longer referenced.
@@ -137,7 +182,15 @@
   <subsection|Character Input and Output>
 
   <\description>
-    <item*|<cpp|getchar()><label|func getchar>>Read one character at a time.
+    <item*|<cpp|getchar()><label|func getchar>>Read one character at a time
+    from the input buffer. Returns as <cpp|int> a <em|character
+    constant>.<\footnote>
+      <name|ASCII> characters have constants in the range <math|0-127>. UTF-8
+      characters return multiple constants (e.g. \<#B0\> returns <cpp|194
+      176>). See <hlinkv|https://www.smashingmagazine.com/2012/06/all-about-unicode-utf8-character-sets/>.
+      A strategy for reading the multiple bytes of a UTF-8 character is here:
+      <hlinkv|https://stackoverflow.com/a/34240796/>.
+    </footnote>
 
     <item*|<cpp|for()>>A generalization of <cpp|while()>. Takes three
     arguments:
@@ -157,11 +210,41 @@
     character (e.g. <cpp|arg1>) at a time.
 
     <item*|<cpp|printf()>>Used for printing formatted text to console.
+
+    Character codes include:
+
+    <\description-aligned>
+      <item*|<cpp|%d>>Used with <cpp|int> (i.e. 16-bit integers; max value of
+      <math|2<rsup|16>=32\<space\>767>).
+
+      <item*|<cpp|%ld>>Used with <cpp|long> (i.e. at least 32-bit
+      integers).<\footnote>
+        K&R 2nd Ed., Sec. 1.5 \PThe conversion specification <cpp|%ld> tells
+        <cpp|printf> that the corresponding argument is a <cpp|long>
+        integer.\Q
+      </footnote>
+
+      <item*|<cpp|%f>>Used with <cpp|float> and <cpp|double> (double
+      precision <cpp|float>).
+    </description-aligned>
   </description>
 
   \;
 
-  \;
+  <chapter|Utilities>
+
+  <section|Text Editor>
+
+  <\itemize>
+    <item><name|Emacs> - GNU text editor. See
+    <hlinkv|https://www.gnu.org/software/emacs/>.
+
+    <item><name|Vim> - text editor See <hlinkv|https://www.vim.org/>.
+  </itemize>
+
+  <section|Linter>
+
+  (TODO: Insert C language linter here)
 
   \;
 </body>
@@ -178,20 +261,24 @@
     <associate|auto-2|<tuple|1.1|?>>
     <associate|auto-3|<tuple|1.2|?>>
     <associate|auto-4|<tuple|1.2.1|?>>
+    <associate|auto-5|<tuple|2|?>>
+    <associate|auto-6|<tuple|2.1|?>>
+    <associate|auto-7|<tuple|2.2|?>>
     <associate|footnote-1.1.1|<tuple|1.1.1|?>>
-    <associate|footnote-1.1.2|<tuple|1.1.2|?>>
+    <associate|footnote-1.2.1|<tuple|1.2.1|?>>
+    <associate|footnote-1.2.2|<tuple|1.2.2|?>>
     <associate|footnr-1.1.1|<tuple|1.1.1|?>>
-    <associate|footnr-1.1.2|<tuple|1.1.2|?>>
+    <associate|footnr-1.2.1|<tuple|1.2.1|?>>
+    <associate|footnr-1.2.2|<tuple|1.2.2|?>>
     <associate|func getchar|<tuple|1.2.1|?>>
     <associate|func putchar|<tuple|3|?>>
     <associate|ref includehelp-oct-hex|<tuple|1.1.1|?>>
-    <associate|term declaration|<tuple|1.1|?>>
+    <associate|term declaration|<tuple|assignment|?>>
     <associate|term definition|<tuple|declaration<label|term declaration>|?>>
-    <associate|term enumeration|<tuple|definition<label|term definition>|?>>
+    <associate|term enumeration|<tuple|delinter|?>>
     <associate|term escape_sequence|<tuple|enumeration<label|term
     enumeration>|?>>
-    <associate|term foo|<tuple|structure assignment|?>>
-    <associate|term garbage_collection|<tuple|1.1.1|?>>
+    <associate|term garbage_collection|<tuple|<with|mode|<quote|prog>|prog-language|<quote|cpp>|font-family|<quote|rm>|\\x><with|font-shape|<quote|italic>|hh>|?>>
     <associate|term heap|<tuple|garbage collection|?>>
     <associate|term machine-independent|<tuple|<label|term heap>heap|?>>
     <associate|term operand|<tuple|<label|term
@@ -201,7 +288,7 @@
     <associate|term struct|<tuple|<label|term stack>stack|?>>
     <associate|term structure_assignment|<tuple|<label|term struct>struct|?>>
     <associate|term text_stream|<tuple|structure assignment|?>>
-    <associate|term-sep XX|<tuple|structure assignment|?>>
+    <associate|term_delinter|<tuple|delinter|?>>
   </collection>
 </references>