Changeset f53acdf8 for doc/user/user.tex

Timestamp:

Jul 19, 2019, 2:16:01 PM (6 years ago)

Author:

Thierry Delisle <tdelisle@…>

Branches:

ADT, arm-eh, ast-experimental, enum, forall-pointer-decay, jacob/cs343-translation, master, new-ast, new-ast-unique-expr, pthread-emulation, qualifiedEnum

Children:

4eb43fa

Parents:

1f1c102 (diff), 8ac3b0e (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' into new-ast

File:

• doc/user/user.tex (modified) (15 diffs)

doc/user/user.tex

@@ -11 +11 @@
 %% Created On       : Wed Apr  6 14:53:29 2016
 %% Last Modified By : Peter A. Buhr
-%% Last Modified On : Sat Jun 15 16:29:45 2019
-%% Update Count     : 3847
+%% Last Modified On : Sat Jul 13 18:36:18 2019
+%% Update Count     : 3876
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -2697 +2697 @@
 \subsection{Expressions}
 
+% Change order of expression evaluation.
+% http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0145r2.pdf
+
 Multiple-return-value functions provide \CFA with a new syntax for expressing a combination of expressions in the return statement and a combination of types in a function signature.
 These notions are generalized to provide \CFA with \newterm{tuple expression}s and \newterm{tuple type}s.
@@ -3346 +3349 @@
 
 
-\section{I/O Stream Library}
-\label{s:IOStreamLibrary}
+\section{Stream I/O Library}
+\label{s:StreamIOLibrary}
 \index{input/output stream library}
 \index{stream library}
 
-The goal of \CFA input/output (I/O) is to simplify the common cases\index{I/O!common case}, while fully supporting polymorphism and user defined types in a consistent way.
-\CFA I/O combines ideas from C ©printf©, \CC, and Python.
-I/O can be unformatted or formatted.
-Unformatted means \CFA selects the output or input format for values that match with the type of a variable.
-Formatted means additional information is specified to augment how an output or input of value is interpreted.
-\CFA formatting is a cross between C ©printf© and \CC ©cout© manipulators.
+The goal of \CFA stream input/output (I/O) is to simplify the common cases\index{I/O!common case}, while fully supporting polymorphism and user defined types in a consistent way.
+Stream I/O can be implicitly or explicitly formatted.
+Implicit formatting means \CFA selects the output or input format for values that match with the type of a variable.
+Explicit formatting means additional information is specified to augment how an output or input of value is interpreted.
+\CFA formatting is a cross between C ©printf© and \CC ©cout© manipulators, and Python implicit spacing and newline.
+Specifically:
 \begin{itemize}
 \item
-©printf© format codes are dense, making them difficult to read and remember.
+©printf©/Python format codes are dense, making them difficult to read and remember.
 \CFA/\CC format manipulators are named, making them easier to read and remember.
 \item
-©printf© separates format codes from associated variables, making it difficult to match codes with variables.
+©printf©/Python separates format codes from associated variables, making it difficult to match codes with variables.
 \CFA/\CC co-locate codes with associated variables, where \CFA has the tighter binding.
 \item
-Format manipulators in \CC have global rather than local effect, except ©setw©.
+Format manipulators in \CFA have local effect, whereas \CC have global effect, except ©setw©.
 Hence, it is common programming practice to toggle manipulators on and then back to the default to prevent downstream side-effects.
 Without this programming style, errors occur when moving prints, as manipulator effects incorrectly flow into the new location.
 (To guarantee no side-effects, manipulator values must be saved and restored across function calls.)
+\item
+\CFA has more sophisticated implicit spacing between values than Python, plus implicit newline at the end of a print.
 \end{itemize}
 The \CFA header file for the I/O library is \Indexc{fstream.hfa}.
 
-For unformatted output, the common case is printing a sequence of variables separated by whitespace.
+For implicit formatted output, the common case is printing a series of variables separated by whitespace.
 \begin{cquote}
-\begin{tabular}{@{}l@{\hspace{3em}}l@{}}
-\multicolumn{1}{c@{\hspace{3em}}}{\textbf{\CFA}}        & \multicolumn{1}{c}{\textbf{\CC}}      \\
+\begin{tabular}{@{}l@{\hspace{2em}}l@{\hspace{2em}}l@{}}
+\multicolumn{1}{c@{\hspace{2em}}}{\textbf{\CFA}}        & \multicolumn{1}{c@{\hspace{2em}}}{\textbf{\CC}}       & \multicolumn{1}{c}{\textbf{Python}}   \\
 \begin{cfa}
 int x = 1, y = 2, z = 3;
@@ -3385 +3390 @@
 cout << x ®<< " "® << y ®<< " "® << z << endl;
 \end{cfa}
+&
+\begin{cfa}
+x = 1;  y = 2;  z = 3
+print( x, y, z )
+\end{cfa}
 \\
+\begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
+1® ®2® ®3
+\end{cfa}
+&
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
 1® ®2® ®3
@@ -3429 +3443 @@
 There is a weak similarity between the \CFA logical-or operator and the \Index{Shell pipe-operator} for moving data, where data flows in the correct direction for input but the opposite direction for output.
 
-For unformatter input, the common case is reading a sequence of values separated by whitespace, where the type of an input constant must match with the type of the input variable.
+For implicit formatted input, the common case is reading a sequence of values separated by whitespace, where the type of an input constant must match with the type of the input variable.
 \begin{cquote}
 \begin{lrbox}{\LstBox}
@@ -3436 +3450 @@
 \end{cfa}
 \end{lrbox}
-\begin{tabular}{@{}l@{\hspace{3em}}l@{}}
+\begin{tabular}{@{}l@{\hspace{3em}}l@{\hspace{3em}}l@{}}
 \multicolumn{1}{@{}l@{}}{\usebox\LstBox} \\
-\multicolumn{1}{c@{\hspace{3em}}}{\textbf{\CFA}}        & \multicolumn{1}{c}{\textbf{\CC}}      \\
+\multicolumn{1}{c@{\hspace{2em}}}{\textbf{\CFA}}        & \multicolumn{1}{c@{\hspace{2em}}}{\textbf{\CC}}       & \multicolumn{1}{c}{\textbf{Python}}   \\
 \begin{cfa}[aboveskip=0pt,belowskip=0pt]
 sin | x | y | z;
@@ -3446 +3460 @@
 cin >> x >> y >> z;
 \end{cfa}
+&
+\begin{cfa}[aboveskip=0pt,belowskip=0pt]
+x = int(input());  y = float(input());  z = input();
+\end{cfa}
 \\
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
 ®1® ®2.5® ®A®
+
+
 \end{cfa}
 &
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
 ®1® ®2.5® ®A®
+
+
+\end{cfa}
+&
+\begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
+®1®
+®2.5®
+®A®
 \end{cfa}
 \end{tabular}
@@ -3481 +3509 @@
 
 \item
-A separator does not appear before or after a null (empty) C string.
+A separator does not appear before or after a null (empty) C string, which is a local mechanism to disable insertion of the separator character.
 \begin{cfa}
 sout | 1 | "" | 2 | "" | 3;
 123
 \end{cfa}
-which is a local mechanism to disable insertion of the separator character.
 
 \item
 {\lstset{language=CFA,deletedelim=**[is][]{¢}{¢}}
-A seperator does not appear before a C string starting with the (extended) \Index*{ASCII}\index{ASCII!extended} characters: \lstinline[basicstyle=\tt]@,.;!?)]}%¢»@
+A separator does not appear before a C string starting with the (extended) \Index*{ASCII}\index{ASCII!extended} characters: \lstinline[basicstyle=\tt]@,.;!?)]}%¢»@, where \lstinline[basicstyle=\tt]@»@ is a closing citation mark.
 \begin{cfa}[belowskip=0pt]
 sout | 1 | ", x" | 2 | ". x" | 3 | "; x" | 4 | "! x" | 5 | "? x" | 6 | "% x"
@@ -3498 +3525 @@
 1®,® x 2®.® x 3®;® x 4®!® x 5®?® x 6®%® x 7§\color{red}\textcent§ x 8®»® x 9®)® x 10®]® x 11®}® x
 \end{cfa}}%
-where \lstinline[basicstyle=\tt]@»@ is a closing citation mark.
-
-\item
-A separator does not appear after a C string ending with the (extended) \Index*{ASCII}\index{ASCII!extended} characters: \lstinline[mathescape=off,basicstyle=\tt]@([{=$£¥¡¿«@
+
+\item
+A separator does not appear after a C string ending with the (extended) \Index*{ASCII}\index{ASCII!extended} characters: \lstinline[mathescape=off,basicstyle=\tt]@([{=$£¥¡¿«@, where \lstinline[basicstyle=\tt]@¡¿@ are inverted opening exclamation and question marks, and \lstinline[basicstyle=\tt]@«@ is an opening citation mark.
 %$
 \begin{cfa}[mathescape=off]
@@ -3512 +3538 @@
 \end{cfa}
 %$
-where \lstinline[basicstyle=\tt]@¡¿@ are inverted opening exclamation and question marks, and \lstinline[basicstyle=\tt]@«@ is an opening citation mark.
 
 \item
@@ -3626 +3651 @@
 The tuple separator also responses to being turned on and off.
 \begin{cfa}[belowskip=0pt]
-sout | t1 | sepOff | t2; §\C{// locally turn on/off implicit separator}§
+sout | t1 | sepOff | t2; §\C{// turn off implicit separator for the next item}§
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -3650 +3675 @@
 \subsection{Newline Manipulators}
 
-The following \Index{manipulator} controls \Index{newline separation} for input and output.
+The following \Index{manipulators} control \Index{newline separation} for input and output.
 
 For input:
@@ -3705 +3730 @@
 0b0 0b11011 0b11011 0b11011 0b11011
 sout | bin( -27HH ) | bin( -27H ) | bin( -27 ) | bin( -27L );
-0b11100101 0b1111111111100101 0b11111111111111111111111111100101 0b(58 1s)100101
+0b11100101 0b1111111111100101 0b11111111111111111111111111100101 0b®(58 1s)®100101
 \end{cfa}
 
@@ -3748 +3773 @@
 
 \item
-\Indexc{nobase}( integer )\index{manipulator!nobase@©nobase©} do not precede ©bin©, ©oct©, ©hex© with ©0b©/©0B©, ©0©, or ©0x©/©0X©. Printing the base is the default.
+\Indexc{nobase}( integer )\index{manipulator!nobase@©nobase©} do not precede ©bin©, ©oct©, ©hex© with ©0b©/©0B©, ©0©, or ©0x©/©0X©.
+Printing the base is the default.
 \begin{cfa}[belowskip=0pt]
 sout | nobase( bin( 27 ) ) | nobase( oct( 27 ) ) | nobase( hex( 27 ) );
@@ -3782 +3808 @@
 ®  ®4.000000 ® ®4.000000 4.000000
 ®  ®ab ® ®ab ab
-    ab    ab ab
 \end{cfa}
 If the value is larger, it is printed without truncation, ignoring the ©minimum©.