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 : Thu Mar 15 09:52:27 2018 |
---|
14 | %% Update Count : 378 |
---|
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]{itemsep=0pt,listparindent=\parindent,leftmargin=\parindent,labelsep=1.5ex} |
---|
35 | |
---|
36 | % Names used in the document. |
---|
37 | |
---|
38 | \newcommand{\CFAIcon}{\textsf{C}\raisebox{\depth}{\rotatebox{180}{\textsf{A}}}\xspace} % Cforall symbolic name |
---|
39 | \newcommand{\CFA}{\protect\CFAIcon} % safe for section/caption |
---|
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 |
---|
47 | \newcommand{\Csharp}{C\raisebox{-0.7ex}{\Large$^\sharp$}\xspace} % C# symbolic name |
---|
48 | |
---|
49 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
---|
50 | |
---|
51 | \makeatletter |
---|
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} |
---|
56 | |
---|
57 | \newcommand{\LstKeywordStyle}[1]{{\lst@basicstyle{\lst@keywordstyle{#1}}}} |
---|
58 | \newcommand{\LstCommentStyle}[1]{{\lst@basicstyle{\lst@commentstyle{#1}}}} |
---|
59 | |
---|
60 | \newlength{\gcolumnposn} % temporary hack because lstlisting does not handle tabs correctly |
---|
61 | \newlength{\columnposn} |
---|
62 | \setlength{\gcolumnposn}{2.5in} |
---|
63 | \setlength{\columnposn}{\gcolumnposn} |
---|
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}}}} |
---|
65 | \newcommand{\CRT}{\global\columnposn=\gcolumnposn} |
---|
66 | |
---|
67 | % allow escape sequence in lstinline |
---|
68 | %\usepackage{etoolbox} |
---|
69 | %\patchcmd{\lsthk@TextStyle}{\let\lst@DefEsc\@empty}{}{}{\errmessage{failed to patch}} |
---|
70 | |
---|
71 | \usepackage{pslatex} % reduce size of san serif font |
---|
72 | \usepackage{relsize} % must be after change to small or selects old size |
---|
73 | \usepackage{rotating} |
---|
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 | }} |
---|
96 | \renewcommand\section{\@startsection{section}{1}{\z@}{-3.5ex \@plus -1ex \@minus -.2ex}{1.75ex \@plus .2ex}{\normalfont\large\bfseries}} |
---|
97 | \renewcommand\subsection{\@startsection{subsection}{2}{\z@}{-3.25ex \@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\normalsize\bfseries}} |
---|
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{\see}[1]{\emph{see}~#1} |
---|
104 | |
---|
105 | % Define some commands that produce formatted index entries suitable for cross-references. |
---|
106 | % ``\spec'' produces entries for specifications of entities. ``\impl'' produces entries for their |
---|
107 | % implementations, and ``\use'' for their uses. |
---|
108 | |
---|
109 | % \newcommand{\bold}[1]{{\bf #1}} |
---|
110 | % \def\spec{\@bsphack\begingroup |
---|
111 | % \def\protect##1{\string##1\space}\@sanitize |
---|
112 | % \@wrxref{|bold}} |
---|
113 | \def\impl{\@bsphack\begingroup |
---|
114 | \def\protect##1{\string##1\space}\@sanitize |
---|
115 | \@wrxref{|definition}} |
---|
116 | \newcommand{\indexcode}[1]{{\lstinline$#1$}} |
---|
117 | \def\use{\@bsphack\begingroup |
---|
118 | \def\protect##1{\string##1\space}\@sanitize |
---|
119 | \@wrxref{|hyperpage}} |
---|
120 | \def\@wrxref#1#2{\let\thepage\relax |
---|
121 | \xdef\@gtempa{\write\@indexfile{\string |
---|
122 | \indexentry{#2@{\lstinline$#2$}#1}{\thepage}}}\endgroup\@gtempa |
---|
123 | \if@nobreak \ifvmode\nobreak\fi\fi\@esphack} |
---|
124 | %\newcommand{\use}[1]{\index{#1@{\lstinline$#1$}}} |
---|
125 | %\newcommand{\impl}[1]{\index{\protect#1@{\lstinline$\protect#1$}|definition}} |
---|
126 | |
---|
127 | % inline text and lowercase index: \Index{inline and lowercase index text} |
---|
128 | \newcommand{\Index}{\@ifstar\@sIndex\@Index} |
---|
129 | % inline text and as-in index: \Index[as-is index text]{inline text} |
---|
130 | \newcommand{\@Index}[2][\@empty]{\lowercase{\def\temp{#2}}#2\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi} |
---|
131 | % inline text but index with different as-is text: \Index[index text]{inline text} |
---|
132 | \newcommand{\@sIndex}[2][\@empty]{#2\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi} |
---|
133 | |
---|
134 | % inline text and code index (cannot use ©) |
---|
135 | \newcommand{\Indexc}[2][\@empty]{\lstinline[#1]$#2$\index{#2@\lstinline[#1]$#2$}} |
---|
136 | % code index (cannot use ©) |
---|
137 | \newcommand{\indexc}[2][\@empty]{\index{#2@\lstinline[#1]$#2$}} |
---|
138 | |
---|
139 | % Denote newterms in particular font and index them without particular font and in lowercase, e.g., \newterm{abc}. |
---|
140 | % The option parameter provides an index term different from the new term, e.g., \newterm[\texttt{abc}]{abc} |
---|
141 | % The star version does not lowercase the index information, e.g., \newterm*{IBM}. |
---|
142 | \newcommand{\newtermFontInline}{\emph} |
---|
143 | \newcommand{\newterm}{\@ifstar\@snewterm\@newterm} |
---|
144 | \newcommand{\@newterm}[2][\@empty]{\lowercase{\def\temp{#2}}{\newtermFontInline{#2}}\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi} |
---|
145 | \newcommand{\@snewterm}[2][\@empty]{{\newtermFontInline{#2}}\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi} |
---|
146 | |
---|
147 | % Latin abbreviation |
---|
148 | \newcommand{\abbrevFont}{\textit} % set empty for no italics |
---|
149 | \@ifundefined{eg}{ |
---|
150 | \newcommand{\EG}{\abbrevFont{e}.\abbrevFont{g}.} |
---|
151 | \newcommand*{\eg}{% |
---|
152 | \@ifnextchar{,}{\EG}% |
---|
153 | {\@ifnextchar{:}{\EG}% |
---|
154 | {\EG,\xspace}}% |
---|
155 | }}{}% |
---|
156 | \@ifundefined{ie}{ |
---|
157 | \newcommand{\IE}{\abbrevFont{i}.\abbrevFont{e}.} |
---|
158 | \newcommand*{\ie}{% |
---|
159 | \@ifnextchar{,}{\IE}% |
---|
160 | {\@ifnextchar{:}{\IE}% |
---|
161 | {\IE,\xspace}}% |
---|
162 | }}{}% |
---|
163 | \@ifundefined{etc}{ |
---|
164 | \newcommand{\ETC}{\abbrevFont{etc}} |
---|
165 | \newcommand*{\etc}{% |
---|
166 | \@ifnextchar{.}{\ETC}% |
---|
167 | {\ETC.\xspace}% |
---|
168 | }}{}% |
---|
169 | \@ifundefined{etal}{ |
---|
170 | \newcommand{\ETAL}{\abbrevFont{et}~\abbrevFont{al}} |
---|
171 | \newcommand*{\etal}{% |
---|
172 | \@ifnextchar{.}{\protect\ETAL}% |
---|
173 | {\protect\ETAL.\xspace}% |
---|
174 | }}{}% |
---|
175 | \@ifundefined{viz}{ |
---|
176 | \newcommand{\VIZ}{\abbrevFont{viz}} |
---|
177 | \newcommand*{\viz}{% |
---|
178 | \@ifnextchar{.}{\VIZ}% |
---|
179 | {\VIZ.\xspace}% |
---|
180 | }}{}% |
---|
181 | \makeatother |
---|
182 | |
---|
183 | \newenvironment{cquote}{% |
---|
184 | \list{}{\lstset{resetmargins=true,aboveskip=0pt,belowskip=0pt}\topsep=4pt\parsep=0pt\leftmargin=\parindentlnth\rightmargin\leftmargin}% |
---|
185 | \item\relax |
---|
186 | }{% |
---|
187 | \endlist |
---|
188 | }% cquote |
---|
189 | |
---|
190 | \newenvironment{rationale}{% |
---|
191 | \begin{cquote}\noindent$\Box$\enspace |
---|
192 | }{% |
---|
193 | \hfill\enspace$\Box$\end{cquote} |
---|
194 | }% |
---|
195 | |
---|
196 | % blocks and titles |
---|
197 | \newcommand{\define}[1]{\emph{#1\/}\index{#1}} |
---|
198 | \newcommand{\rewriterules}{\paragraph{Rewrite Rules}~\par\noindent} |
---|
199 | \newcommand{\examples}{\paragraph{Examples}~\par\noindent} |
---|
200 | \newcommand{\semantics}{\paragraph{Semantics}~\par\noindent} |
---|
201 | \newcommand{\constraints}{\paragraph{Constraints}~\par\noindent} |
---|
202 | \newcommand{\predefined}{\paragraph{Predefined Identifiers}~\par\noindent} |
---|
203 | |
---|
204 | % BNF macros |
---|
205 | \newenvironment{syntax}{ |
---|
206 | \paragraph{Syntax} |
---|
207 | \begin{cquote} |
---|
208 | \begin{description}[noitemsep,leftmargin=\parindentlnth] |
---|
209 | }{ |
---|
210 | \end{description} |
---|
211 | \end{cquote} |
---|
212 | } |
---|
213 | % \def\syntax{\paragraph{Syntax}\trivlist\parindent=.5in\item[\hskip.5in]} |
---|
214 | %\let\endsyntax=\endtrivlist |
---|
215 | \newcommand{\lhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}]~\ignorespaces} |
---|
216 | \newcommand{\oldlhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}~\dots]~} |
---|
217 | \newcommand{\rhs}{\hfil\newline} |
---|
218 | \newcommand{\nonterm}[1]{\emph{#1}\index{#1@{\emph{#1}}|italic}} |
---|
219 | \newcommand{\opt}{$_{opt}$\ } |
---|
220 | |
---|
221 | \usepackage{varioref} % extended references |
---|
222 | % adjust varioref package with default "section" and "page" titles, and optional title with faraway page numbers |
---|
223 | % \VRef{label} => Section 2.7, \VPageref{label} => page 17 |
---|
224 | % \VRef[Figure]{label} => Figure 3.4, \VPageref{label} => page 17 |
---|
225 | \renewcommand{\reftextfaceafter}{\unskip} |
---|
226 | \renewcommand{\reftextfacebefore}{\unskip} |
---|
227 | \renewcommand{\reftextafter}{\unskip} |
---|
228 | \renewcommand{\reftextbefore}{\unskip} |
---|
229 | \renewcommand{\reftextfaraway}[1]{\unskip, p.~\pageref{#1}} |
---|
230 | \renewcommand{\reftextpagerange}[2]{\unskip, pp.~\pageref{#1}--\pageref{#2}} |
---|
231 | \newcommand{\VRef}[2][Section]{\ifx#1\@empty\else{#1}\nobreakspace\fi\vref{#2}} |
---|
232 | \newcommand{\VPageref}[2][page]{\ifx#1\@empty\else{#1}\nobreakspace\fi\pageref{#2}} |
---|
233 | |
---|
234 | \let\Oldthebibliography\thebibliography |
---|
235 | \renewcommand\thebibliography[1]{ |
---|
236 | \Oldthebibliography{#1} |
---|
237 | \setlength{\parskip}{0pt} % reduce vertical spacing between references |
---|
238 | \setlength{\itemsep}{5pt plus 0.3ex} |
---|
239 | }% |
---|
240 | |
---|
241 | \usepackage{lstlang} |
---|
242 | |
---|
243 | \newcommand{\CFADefaults}{% |
---|
244 | \lstset{ |
---|
245 | language=CFA, |
---|
246 | columns=fullflexible, |
---|
247 | basicstyle=\linespread{0.9}\sf, % reduce line spacing and use sanserif font |
---|
248 | stringstyle=\tt, % use typewriter font |
---|
249 | tabsize=5, % N space tabbing |
---|
250 | xleftmargin=\parindentlnth, % indent code to paragraph indentation |
---|
251 | extendedchars=true, % allow ASCII characters in the range 128-255 |
---|
252 | escapechar=§, % LaTeX escape in CFA code §...§ (section symbol), emacs: C-q M-' |
---|
253 | mathescape=true, % LaTeX math escape in CFA code $...$ |
---|
254 | keepspaces=true, % |
---|
255 | showstringspaces=false, % do not show spaces with cup |
---|
256 | showlines=true, % show blank lines at end of code |
---|
257 | aboveskip=4pt, % spacing above/below code block |
---|
258 | belowskip=3pt, |
---|
259 | % replace/adjust listing characters that look bad in sanserif |
---|
260 | literate={-}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.8ex}{0.1ex}}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1 |
---|
261 | {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1 |
---|
262 | {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2 {->}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.8ex}{0.075ex}}}\kern-0.2ex\textgreater}2, |
---|
263 | moredelim=**[is][\color{red}]{®}{®}, % red highlighting ®...® (registered trademark symbol) emacs: C-q M-. |
---|
264 | moredelim=**[is][\color{blue}]{ß}{ß}, % blue highlighting ß...ß (sharp s symbol) emacs: C-q M-_ |
---|
265 | moredelim=**[is][\color{OliveGreen}]{¢}{¢}, % green highlighting ¢...¢ (cent symbol) emacs: C-q M-" |
---|
266 | moredelim=[is][\lstset{keywords={}}]{¶}{¶}, % keyword escape ¶...¶ (pilcrow symbol) emacs: C-q M-^ |
---|
267 | }% lstset |
---|
268 | }% CFADefaults |
---|
269 | \newcommand{\CFAStyle}{% |
---|
270 | \CFADefaults |
---|
271 | % inline code ©...© (copyright symbol) emacs: C-q M-) |
---|
272 | \lstMakeShortInline© % single-character for \lstinline |
---|
273 | }% CFAStyle |
---|
274 | |
---|
275 | \lstnewenvironment{cfa}[1][] |
---|
276 | {\CFADefaults\lstset{#1}} |
---|
277 | {} |
---|
278 | |
---|
279 | % Local Variables: % |
---|
280 | % tab-width: 4 % |
---|
281 | % fill-column: 100 % |
---|
282 | % End: % |
---|