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