1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -*- Mode: Latex -*- %%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
---|
2 | %%
|
---|
3 | %% Cforall Version 1.0.0 Copyright (C) 2016 University of Waterloo
|
---|
4 | %%
|
---|
5 | %% The contents of this file are covered under the licence agreement in the
|
---|
6 | %% file "LICENCE" distributed with Cforall.
|
---|
7 | %%
|
---|
8 | %% common.tex --
|
---|
9 | %%
|
---|
10 | %% Author : Peter A. Buhr
|
---|
11 | %% Created On : Sat Apr 9 10:06:17 2016
|
---|
12 | %% Last Modified By : Peter A. Buhr
|
---|
13 | %% Last Modified On : Sun Feb 14 15:52:46 2021
|
---|
14 | %% Update Count : 524
|
---|
15 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
---|
16 |
|
---|
17 | \setlength{\textheight}{9in}
|
---|
18 | %\oddsidemargin 0.0in
|
---|
19 | \renewcommand{\topfraction}{0.8} % float must be greater than X of the page before it is forced onto its own page
|
---|
20 | \renewcommand{\bottomfraction}{0.8} % float must be greater than X of the page before it is forced onto its own page
|
---|
21 | \renewcommand{\floatpagefraction}{0.8} % float must be greater than X of the page before it is forced onto its own page
|
---|
22 | \renewcommand{\textfraction}{0.0} % the entire page maybe devoted to floats with no text on the page at all
|
---|
23 |
|
---|
24 | \lefthyphenmin=4 % hyphen only after 4 characters
|
---|
25 | \righthyphenmin=4
|
---|
26 |
|
---|
27 | \usepackage[ignoredisplayed]{enumitem} % do not affect trivlist
|
---|
28 | \setlist{labelsep=1ex}% global
|
---|
29 | \setlist[itemize]{topsep=0.5ex,parsep=0.25ex,itemsep=0.25ex,listparindent=\parindent,leftmargin=\parindent}% global
|
---|
30 | \setlist[itemize,1]{label=\textbullet}% local
|
---|
31 | %\renewcommand{\labelitemi}{{\raisebox{0.25ex}{\footnotesize$\bullet$}}}
|
---|
32 | \setlist[enumerate]{listparindent=\parindent}% global
|
---|
33 | \setlist[enumerate,2]{leftmargin=\parindent,labelsep=*,align=parleft,label=\alph*.}% local
|
---|
34 | \setlist[description]{topsep=0.5ex,itemsep=0pt,listparindent=\parindent,leftmargin=\parindent,labelsep=1.5ex}
|
---|
35 |
|
---|
36 | % Names used in the document.
|
---|
37 |
|
---|
38 | \usepackage{xspace}
|
---|
39 | \newcommand{\CFAIcon}{\textsf{C}\raisebox{\depth}{\rotatebox{180}{\textsf{A}}}} % Cforall icon
|
---|
40 | \newcommand{\CFA}{\protect\CFAIcon\xspace} % CFA symbolic name
|
---|
41 | \newcommand{\CFL}{\textrm{Cforall}\xspace} % Cforall non-icon name
|
---|
42 | \newcommand{\Celeven}{\textrm{C11}\xspace} % C11 symbolic name
|
---|
43 | \newcommand{\CCIcon}{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}} % C++ icon
|
---|
44 | \newcommand{\CC}{\protect\CCIcon\xspace} % C++ symbolic name
|
---|
45 | % numbers disallowed in latex variables names => use number names
|
---|
46 | \newcommand{\CCeleven}{\protect\CCIcon{11}\xspace} % C++11 symbolic name
|
---|
47 | \newcommand{\CCfourteen}{\protect\CCIcon{14}\xspace} % C++14 symbolic name
|
---|
48 | \newcommand{\CCseventeen}{\protect\CCIcon{17}\xspace} % C++17 symbolic name
|
---|
49 | \newcommand{\CCtwenty}{\protect\CCIcon{20}\xspace} % C++20 symbolic name
|
---|
50 | \newcommand{\Csharp}{C\raisebox{-0.7ex}{\Large$^\sharp$}\xspace} % C# symbolic name
|
---|
51 |
|
---|
52 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
---|
53 |
|
---|
54 | % remove special-character warning in PDF side-bar names
|
---|
55 | \makeatletter
|
---|
56 | \@ifpackageloaded{hyperref}{
|
---|
57 | \pdfstringdefDisableCommands{
|
---|
58 | \def\CFA{\CFL}
|
---|
59 | \def\Celeven{C11\xspace}
|
---|
60 | \def\CC{C++\xspace}
|
---|
61 | \def\CCeleven{C++11\xspace}
|
---|
62 | \def\CCfourteen{C++14\xspace}
|
---|
63 | \def\CCseventeen{C++17\xspace}
|
---|
64 | \def\CCtwenty{C++20\xspace}
|
---|
65 | \def\Csharp{C\#\xspace}
|
---|
66 | \def\lstinline{\xspace}% must use {} as delimiters, e.g., \lstinline{...}
|
---|
67 | }{}
|
---|
68 | }
|
---|
69 |
|
---|
70 | % parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for
|
---|
71 | % use rather than use \parident directly.
|
---|
72 | \newlength{\parindentlnth}
|
---|
73 | \setlength{\parindentlnth}{\parindent}
|
---|
74 |
|
---|
75 | \usepackage{pslatex} % reduce size of san serif font
|
---|
76 | \usepackage{relsize} % must be after change to small or selects old size
|
---|
77 | \usepackage{rotating}
|
---|
78 |
|
---|
79 | % reduce size of chapter/section titles
|
---|
80 | \def\@makechapterhead#1{%
|
---|
81 | \vspace*{50\p@}%
|
---|
82 | {\parindent \z@ \raggedright \normalfont
|
---|
83 | \ifnum \c@secnumdepth >\m@ne
|
---|
84 | \large\bfseries \@chapapp\space \thechapter
|
---|
85 | \par\nobreak
|
---|
86 | \vskip 5\p@
|
---|
87 | \fi
|
---|
88 | \interlinepenalty\@M
|
---|
89 | \Large \bfseries #1\par\nobreak
|
---|
90 | \vskip 50\p@
|
---|
91 | }}
|
---|
92 | \def\@makeschapterhead#1{%
|
---|
93 | \vspace*{50\p@}%
|
---|
94 | {\parindent \z@ \raggedright
|
---|
95 | \normalfont
|
---|
96 | \interlinepenalty\@M
|
---|
97 | \Large \bfseries #1\par\nobreak
|
---|
98 | \vskip 50\p@
|
---|
99 | }}
|
---|
100 | \renewcommand\section{\@startsection{section}{1}{\z@}{-3.0ex \@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\large\bfseries}}
|
---|
101 | \renewcommand\subsection{\@startsection{subsection}{2}{\z@}{-2.75ex \@plus -1ex \@minus -.2ex}{1.25ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
|
---|
102 | \renewcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}{-2.5ex \@plus -1ex \@minus -.2ex}{1.0ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
|
---|
103 | \renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}{-2.0ex \@plus -1ex \@minus -.2ex}{-1em}{\normalfont\normalsize\bfseries}}
|
---|
104 |
|
---|
105 | % index macros
|
---|
106 | \newcommand{\italic}[1]{\emph{\hyperpage{#1}}}
|
---|
107 | \newcommand{\Definition}[1]{\textbf{\hyperpage{#1}}}
|
---|
108 | \newcommand{\see}[1]{(see #1)}
|
---|
109 |
|
---|
110 | % Define some commands that produce formatted index entries suitable for cross-references.
|
---|
111 | % ``\spec'' produces entries for specifications of entities. ``\impl'' produces entries for their
|
---|
112 | % implementations, and ``\use'' for their uses.
|
---|
113 |
|
---|
114 | % \newcommand{\bold}[1]{{\bf #1}}
|
---|
115 | % \def\spec{\@bsphack\begingroup
|
---|
116 | % \def\protect##1{\string##1\space}\@sanitize
|
---|
117 | % \@wrxref{|bold}}
|
---|
118 | \def\impl{\@bsphack\begingroup
|
---|
119 | \def\protect##1{\string##1\space}\@sanitize
|
---|
120 | \@wrxref{|Definition}}
|
---|
121 | \newcommand{\indexcode}[1]{{\lstinline$#1$}}
|
---|
122 | \def\use{\@bsphack\begingroup
|
---|
123 | \def\protect##1{\string##1\space}\@sanitize
|
---|
124 | \@wrxref{|hyperpage}}
|
---|
125 | \def\@wrxref#1#2{\let\thepage\relax
|
---|
126 | \xdef\@gtempa{\write\@indexfile{\string
|
---|
127 | \indexentry{#2@{\lstinline$#2$}#1}{\thepage}}}\endgroup\@gtempa
|
---|
128 | \if@nobreak \ifvmode\nobreak\fi\fi\@esphack}
|
---|
129 | %\newcommand{\use}[1]{\index{#1@{\lstinline$#1$}}}
|
---|
130 | %\newcommand{\impl}[1]{\index{\protect#1@{\lstinline$\protect#1$}|Definition}}
|
---|
131 |
|
---|
132 | % inline text and lowercase index: \Index{inline and lowercase index text}
|
---|
133 | \newcommand{\Index}{\@ifstar\@sIndex\@Index}
|
---|
134 | % inline text and as-in index: \Index[as-is index text]{inline text}
|
---|
135 | \newcommand{\@Index}[2][\@empty]{\lowercase{\def\temp{#2}}#2\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
|
---|
136 | % inline text but index with different as-is text: \Index[index text]{inline text}
|
---|
137 | \newcommand{\@sIndex}[2][\@empty]{#2\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
|
---|
138 |
|
---|
139 | % inline text and code index (cannot use ©)
|
---|
140 | \newcommand{\Indexc}[2][\@empty]{\lstinline[#1]$#2$\index{#2@\lstinline[#1]$#2$}}
|
---|
141 | % code index (cannot use ©)
|
---|
142 | \newcommand{\indexc}[2][\@empty]{\index{#2@\lstinline[#1]$#2$}}
|
---|
143 |
|
---|
144 | % Denote newterms in particular font and index them without particular font and in lowercase, e.g., \newterm{abc}.
|
---|
145 | % The option parameter provides an index term different from the new term, e.g., \newterm[\texttt{abc}]{abc}
|
---|
146 | % The star version does not lowercase the index information, e.g., \newterm*{IBM}.
|
---|
147 | \newcommand{\newtermFontInline}{\emph}
|
---|
148 | \newcommand{\newterm}{\protect\@ifstar\@snewterm\@newterm}
|
---|
149 | \newcommand{\@newterm}[2][\@empty]{\lowercase{\def\temp{#2}}{\newtermFontInline{#2}}\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
|
---|
150 | \newcommand{\@snewterm}[2][\@empty]{{\newtermFontInline{#2}}\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
|
---|
151 |
|
---|
152 | % Latin abbreviation
|
---|
153 | \newcommand{\abbrevFont}{\textit} % set empty for no italics
|
---|
154 | \@ifundefined{eg}{
|
---|
155 | \newcommand{\EG}{\abbrevFont{e}.\abbrevFont{g}.}
|
---|
156 | \newcommand*{\eg}{%
|
---|
157 | \@ifnextchar{,}{\EG}%
|
---|
158 | {\@ifnextchar{:}{\EG}%
|
---|
159 | {\EG,\xspace}}%
|
---|
160 | }}{}%
|
---|
161 | \@ifundefined{ie}{
|
---|
162 | \newcommand{\IE}{\abbrevFont{i}.\abbrevFont{e}.}
|
---|
163 | \newcommand*{\ie}{%
|
---|
164 | \@ifnextchar{,}{\IE}%
|
---|
165 | {\@ifnextchar{:}{\IE}%
|
---|
166 | {\IE,\xspace}}%
|
---|
167 | }}{}%
|
---|
168 | \@ifundefined{etc}{
|
---|
169 | \newcommand{\ETC}{\abbrevFont{etc}}
|
---|
170 | \newcommand*{\etc}{%
|
---|
171 | \@ifnextchar{.}{\ETC}%
|
---|
172 | {\ETC.\xspace}%
|
---|
173 | }}{}%
|
---|
174 | \@ifundefined{etal}{
|
---|
175 | \newcommand{\ETAL}{\abbrevFont{et}~\abbrevFont{al}}
|
---|
176 | \newcommand*{\etal}{%
|
---|
177 | \@ifnextchar{.}{\protect\ETAL}%
|
---|
178 | {\protect\ETAL.\xspace}%
|
---|
179 | }}{}%
|
---|
180 | \@ifundefined{viz}{
|
---|
181 | \newcommand{\VIZ}{\abbrevFont{viz}}
|
---|
182 | \newcommand*{\viz}{%
|
---|
183 | \@ifnextchar{.}{\VIZ}%
|
---|
184 | {\VIZ.\xspace}%
|
---|
185 | }}{}%
|
---|
186 | \makeatother
|
---|
187 |
|
---|
188 | \newenvironment{cquote}{%
|
---|
189 | \list{}{\lstset{resetmargins=true,aboveskip=0pt,belowskip=0pt}\topsep=4pt\parsep=0pt\leftmargin=\parindentlnth\rightmargin\leftmargin}%
|
---|
190 | \item\relax
|
---|
191 | }{%
|
---|
192 | \endlist
|
---|
193 | }% cquote
|
---|
194 |
|
---|
195 | \newenvironment{rationale}{%
|
---|
196 | \begin{cquote}\noindent$\Box$\enspace
|
---|
197 | }{%
|
---|
198 | \hfill\enspace$\Box$\end{cquote}
|
---|
199 | }%
|
---|
200 |
|
---|
201 | % blocks and titles
|
---|
202 | \newcommand{\define}[1]{\emph{#1\/}\index{#1}}
|
---|
203 | \newcommand{\rewriterules}{\paragraph{Rewrite Rules}~\par\noindent}
|
---|
204 | \newcommand{\examples}{\paragraph{Examples}~\par\noindent}
|
---|
205 | \newcommand{\semantics}{\paragraph{Semantics}~\par\noindent}
|
---|
206 | \newcommand{\constraints}{\paragraph{Constraints}~\par\noindent}
|
---|
207 | \newcommand{\predefined}{\paragraph{Predefined Identifiers}~\par\noindent}
|
---|
208 |
|
---|
209 | % BNF macros
|
---|
210 | \newenvironment{syntax}{
|
---|
211 | \paragraph{Syntax}
|
---|
212 | \begin{cquote}
|
---|
213 | \begin{description}[noitemsep,leftmargin=\parindentlnth]
|
---|
214 | }{
|
---|
215 | \end{description}
|
---|
216 | \end{cquote}
|
---|
217 | }
|
---|
218 | % \def\syntax{\paragraph{Syntax}\trivlist\parindent=.5in\item[\hskip.5in]}
|
---|
219 | %\let\endsyntax=\endtrivlist
|
---|
220 | \newcommand{\lhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}]~\ignorespaces}
|
---|
221 | \newcommand{\oldlhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}~\dots]~}
|
---|
222 | \newcommand{\rhs}{\hfil\newline}
|
---|
223 | \newcommand{\nonterm}[1]{\emph{#1}\index{#1@{\emph{#1}}|italic}}
|
---|
224 | \newcommand{\opt}{$_{opt}$\ }
|
---|
225 |
|
---|
226 | \usepackage{varioref} % extended references
|
---|
227 | % adjust varioref package with default "section" and "page" titles, and optional title with faraway page numbers
|
---|
228 | % \VRef{label} => Section 2.7, \VPageref{label} => page 17
|
---|
229 | % \VRef[Figure]{label} => Figure 3.4, \VPageref{label} => page 17
|
---|
230 | \renewcommand{\reftextfaceafter}{\unskip}
|
---|
231 | \renewcommand{\reftextfacebefore}{\unskip}
|
---|
232 | \renewcommand{\reftextafter}{\unskip}
|
---|
233 | \renewcommand{\reftextbefore}{\unskip}
|
---|
234 | \renewcommand{\reftextfaraway}[1]{\unskip, p.~\pageref{#1}}
|
---|
235 | \renewcommand{\reftextpagerange}[2]{\unskip, pp.~\pageref{#1}--\pageref{#2}}
|
---|
236 | \newcommand{\VRef}[2][Section]{\ifx#1\@empty\else{#1}\nobreakspace\fi\vref{#2}}
|
---|
237 | \newcommand{\VPageref}[2][page]{\ifx#1\@empty\else{#1}\nobreakspace\fi\pageref{#2}}
|
---|
238 |
|
---|
239 | \let\Oldthebibliography\thebibliography
|
---|
240 | \renewcommand\thebibliography[1]{
|
---|
241 | \Oldthebibliography{#1}
|
---|
242 | \setlength{\parskip}{0pt} % reduce vertical spacing between references
|
---|
243 | \setlength{\itemsep}{5pt plus 0.3ex}
|
---|
244 | }%
|
---|
245 |
|
---|
246 | \usepackage{listings} % format program code
|
---|
247 | \usepackage{lstlang}
|
---|
248 | \usepackage{calc} % latex arithmetic
|
---|
249 |
|
---|
250 | \makeatletter
|
---|
251 | \newcommand{\LstBasicStyle}[1]{{\lst@basicstyle{#1}}}
|
---|
252 | \newcommand{\LstKeywordStyle}[1]{{\lst@basicstyle{\lst@keywordstyle{#1}}}}
|
---|
253 | \newcommand{\LstCommentStyle}[1]{{\lst@basicstyle{\lst@commentstyle{#1}}}}
|
---|
254 | \newcommand{\LstStringStyle}[1]{{\lst@basicstyle{\lst@stringstyle{#1}}}}
|
---|
255 |
|
---|
256 | \newlength{\gcolumnposn} % temporary hack because lstlisting does not handle tabs correctly
|
---|
257 | \newlength{\columnposn}
|
---|
258 | \setlength{\gcolumnposn}{2.75in}
|
---|
259 | \setlength{\columnposn}{\gcolumnposn}
|
---|
260 | \newcommand{\C}[2][\@empty]{\ifx#1\@empty\else\global\setlength{\columnposn}{#1}\global\columnposn=\columnposn\fi\hfill\makebox[\textwidth-\columnposn][l]{\lst@basicstyle{\LstCommentStyle{#2}}}}
|
---|
261 | \newcommand{\CRT}{\global\columnposn=\gcolumnposn}
|
---|
262 |
|
---|
263 | % allow escape sequence in lstinline
|
---|
264 | %\usepackage{etoolbox}
|
---|
265 | %\patchcmd{\lsthk@TextStyle}{\let\lst@DefEsc\@empty}{}{}{\errmessage{failed to patch}}
|
---|
266 |
|
---|
267 | % allow adding to lst literate
|
---|
268 | \def\addToLiterate#1{\protect\edef\lst@literate{\unexpanded\expandafter{\lst@literate}\unexpanded{#1}}}
|
---|
269 | \lst@Key{add to literate}{}{\addToLiterate{#1}}
|
---|
270 | \makeatother
|
---|
271 |
|
---|
272 | \newcommand{\CFAStyle}{%
|
---|
273 | \lstset{
|
---|
274 | columns=fullflexible,
|
---|
275 | basicstyle=\linespread{0.9}\sf, % reduce line spacing and use sanserif font
|
---|
276 | stringstyle=\tt, % use typewriter font
|
---|
277 | tabsize=5, % N space tabbing
|
---|
278 | xleftmargin=\parindentlnth, % indent code to paragraph indentation
|
---|
279 | extendedchars=true, % allow ASCII characters in the range 128-255
|
---|
280 | escapechar=\$, % LaTeX escape in CFA code §...§ (section symbol), emacs: C-q M-'
|
---|
281 | mathescape=false, % LaTeX math escape in CFA code $...$
|
---|
282 | keepspaces=true, %
|
---|
283 | showstringspaces=false, % do not show spaces with cup
|
---|
284 | showlines=true, % show blank lines at end of code
|
---|
285 | aboveskip=4pt, % spacing above/below code block
|
---|
286 | belowskip=0pt,
|
---|
287 | numberstyle=\footnotesize\sf, % numbering style
|
---|
288 | % replace/adjust listing characters that look bad in sanserif
|
---|
289 | literate={-}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.75ex}{0.1ex}}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
|
---|
290 | {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
|
---|
291 | {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2 {->}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.8ex}{0.075ex}}}\kern-0.2ex\textgreater}2,
|
---|
292 | }% lstset
|
---|
293 | }% CFAStyle
|
---|
294 |
|
---|
295 | \ifdefined\CFALatin% extra Latin-1 escape characters
|
---|
296 | \lstnewenvironment{cfa}[1][]{% necessary
|
---|
297 | \lstset{
|
---|
298 | language=CFA,
|
---|
299 | moredelim=**[is][\color{red}]{@}{@}, % red highlighting @...@
|
---|
300 | %moredelim=**[is][\color{red}]{®}{®}, % red highlighting ®...® (registered trademark symbol) emacs: C-q M-.
|
---|
301 | %moredelim=**[is][\color{blue}]{ß}{ß}, % blue highlighting ß...ß (sharp s symbol) emacs: C-q M-_
|
---|
302 | %moredelim=**[is][\color{OliveGreen}]{¢}{¢}, % green highlighting ¢...¢ (cent symbol) emacs: C-q M-"
|
---|
303 | %moredelim=[is][\lstset{keywords={}}]{¶}{¶}, % keyword escape ¶...¶ (pilcrow symbol) emacs: C-q M-^
|
---|
304 | }% lstset
|
---|
305 | \lstset{#1}% necessary
|
---|
306 | }{}
|
---|
307 | % inline code ©...© (copyright symbol) emacs: C-q M-)
|
---|
308 | \lstMakeShortInline© % single-character for \lstinline
|
---|
309 | \else% regular ASCI characters
|
---|
310 | \lstnewenvironment{cfa}[1][]{% necessary
|
---|
311 | \lstset{
|
---|
312 | language=CFA,
|
---|
313 | escapechar=\$, % LaTeX escape in CFA code
|
---|
314 | mathescape=false, % LaTeX math escape in CFA code $...$
|
---|
315 | moredelim=**[is][\color{red}]{@}{@}, % red highlighting @...@
|
---|
316 | }% lstset
|
---|
317 | \lstset{#1}% necessary
|
---|
318 | }{}
|
---|
319 | % inline code @...@ (at symbol)
|
---|
320 | \lstMakeShortInline@ % single-character for \lstinline
|
---|
321 | \fi%
|
---|
322 |
|
---|
323 | % Local Variables: %
|
---|
324 | % tab-width: 4 %
|
---|
325 | % fill-column: 100 %
|
---|
326 | % End: %
|
---|