source: doc/LaTeXmacros/common.tex @ 93afb96

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 93afb96 was 93afb96, checked in by Rob Schluntz <rschlunt@…>, 5 years ago

fix typos in thesis

  • Property mode set to 100644
File size: 12.9 KB
Line 
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 : Fri Feb 10 11:32:36 2017
14%% Update Count     : 249
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{\CFA}{C$\mathbf\forall$\xspace} % set language symbolic name
39\newcommand{\CFL}{Cforall\xspace}               % set language text name
40\newcommand{\CC}{\rm C\kern-.1em\hbox{+\kern-.25em+}\xspace} % CC symbolic name
41\newcommand{\CCeleven}{\rm C\kern-.1em\hbox{+\kern-.25em+}11\xspace} % C++11 symbolic name
42\newcommand{\CCfourteen}{\rm C\kern-.1em\hbox{+\kern-.25em+}14\xspace} % C++14 symbolic name
43\newcommand{\CCseventeen}{\rm C\kern-.1em\hbox{+\kern-.25em+}17\xspace} % C++17 symbolic name
44\newcommand{\CCtwenty}{\rm C\kern-.1em\hbox{+\kern-.25em+}20} % C++20 symbolic name
45\newcommand{\Celeven}{C11\xspace}               % C11 symbolic name
46\newcommand{\Csharp}{C\raisebox{0.4ex}{\#}\xspace}      % C# symbolic name
47
48%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
49
50\makeatletter
51% parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for
52% use rather than use \parident directly.
53\newlength{\parindentlnth}
54\setlength{\parindentlnth}{\parindent}
55
56\newlength{\gcolumnposn}                                % temporary hack because lstlisting does handle tabs correctly
57\newlength{\columnposn}
58\setlength{\gcolumnposn}{2.5in}
59\setlength{\columnposn}{\gcolumnposn}
60\newcommand{\C}[2][\@empty]{\ifx#1\@empty\else\global\setlength{\columnposn}{#1}\global\columnposn=\columnposn\fi\hfill\makebox[\textwidth-\columnposn][l]{\lst@commentstyle{#2}}}
61\newcommand{\CRT}{\global\columnposn=\gcolumnposn}
62
63% allow escape sequence in lstinline
64%\usepackage{etoolbox}
65%\patchcmd{\lsthk@TextStyle}{\let\lst@DefEsc\@empty}{}{}{\errmessage{failed to patch}}
66
67\usepackage{pslatex}                                    % reduce size of san serif font
68\usepackage{relsize}                                    % must be after change to small or selects old size
69
70% reduce size of chapter/section titles
71\def\@makechapterhead#1{%
72  \vspace*{50\p@}%
73  {\parindent \z@ \raggedright \normalfont
74    \ifnum \c@secnumdepth >\m@ne
75        \large\bfseries \@chapapp\space \thechapter
76        \par\nobreak
77        \vskip 5\p@
78    \fi
79    \interlinepenalty\@M
80    \Large \bfseries #1\par\nobreak
81    \vskip 50\p@
82  }}
83\def\@makeschapterhead#1{%
84  \vspace*{50\p@}%
85  {\parindent \z@ \raggedright
86    \normalfont
87    \interlinepenalty\@M
88    \Large \bfseries  #1\par\nobreak
89    \vskip 50\p@
90  }}
91\renewcommand\section{\@startsection{section}{1}{\z@}{-3.5ex \@plus -1ex \@minus -.2ex}{1.75ex \@plus .2ex}{\normalfont\large\bfseries}}
92\renewcommand\subsection{\@startsection{subsection}{2}{\z@}{-3.25ex \@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
93\renewcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}{-2.5ex \@plus -1ex \@minus -.2ex}{1.0ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
94\renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}{-2.0ex \@plus -1ex \@minus -.2ex}{-1em}{\normalfont\normalsize\bfseries}}
95
96% index macros
97\newcommand{\italic}[1]{\emph{\hyperpage{#1}}}
98\newcommand{\definition}[1]{\textbf{\hyperpage{#1}}}
99\newcommand{\see}[1]{\emph{see} #1}
100
101% Define some commands that produce formatted index entries suitable for cross-references.
102% ``\spec'' produces entries for specifications of entities.  ``\impl'' produces entries for their
103% implementations, and ``\use'' for their uses.
104
105%  \newcommand{\bold}[1]{{\bf #1}}
106%  \def\spec{\@bsphack\begingroup
107%             \def\protect##1{\string##1\space}\@sanitize
108%             \@wrxref{|bold}}
109\def\impl{\@bsphack\begingroup
110          \def\protect##1{\string##1\space}\@sanitize
111          \@wrxref{|definition}}
112\newcommand{\indexcode}[1]{{\lstinline$#1$}}
113\def\use{\@bsphack\begingroup
114         \def\protect##1{\string##1\space}\@sanitize
115         \@wrxref{|hyperpage}}
116\def\@wrxref#1#2{\let\thepage\relax
117    \xdef\@gtempa{\write\@indexfile{\string
118    \indexentry{#2@{\lstinline$#2$}#1}{\thepage}}}\endgroup\@gtempa
119    \if@nobreak \ifvmode\nobreak\fi\fi\@esphack}
120%\newcommand{\use}[1]{\index{#1@{\lstinline$#1$}}}
121%\newcommand{\impl}[1]{\index{\protect#1@{\lstinline$\protect#1$}|definition}}
122
123% inline text and lowercase index: \Index{inline and lowercase index text}
124\newcommand{\Index}{\@ifstar\@sIndex\@Index}
125% inline text and as-in index: \Index[as-is index text]{inline text}
126\newcommand{\@Index}[2][\@empty]{\lowercase{\def\temp{#2}}#2\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
127% inline text but index with different as-is text: \Index[index text]{inline text}
128\newcommand{\@sIndex}[2][\@empty]{#2\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
129
130% inline text and code index (cannot use ©)
131\newcommand{\Indexc}[1]{\lstinline$#1$\index{#1@\lstinline$#1$}}
132% code index (cannot use ©)
133\newcommand{\indexc}[1]{\index{#1@\lstinline$#1$}}
134
135% Denote newterms in particular font and index them without particular font and in lowercase, e.g., \newterm{abc}.
136% The option parameter provides an index term different from the new term, e.g., \newterm[\texttt{abc}]{abc}
137% The star version does not lowercase the index information, e.g., \newterm*{IBM}.
138\newcommand{\newtermFontInline}{\emph}
139\newcommand{\newterm}{\@ifstar\@snewterm\@newterm}
140\newcommand{\@newterm}[2][\@empty]{\lowercase{\def\temp{#2}}{\newtermFontInline{#2}}\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
141\newcommand{\@snewterm}[2][\@empty]{{\newtermFontInline{#2}}\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
142
143% Latin abbreviation
144\newcommand{\abbrevFont}{\textit}       % set empty for no italics
145\newcommand*{\eg}{%
146        \@ifnextchar{,}{\abbrevFont{e}.\abbrevFont{g}.}%
147                {\@ifnextchar{:}{\abbrevFont{e}.\abbrevFont{g}.}%
148                        {\abbrevFont{e}.\abbrevFont{g}.,\xspace}}%
149}%
150\newcommand*{\ie}{%
151        \@ifnextchar{,}{\abbrevFont{i}.\abbrevFont{e}.}%
152                {\@ifnextchar{:}{\abbrevFont{i}.\abbrevFont{e}.}%
153                        {\abbrevFont{i}.\abbrevFont{e}.,\xspace}}%
154}%
155\newcommand*{\etc}{%
156        \@ifnextchar{.}{\abbrevFont{etc}}%
157        {\abbrevFont{etc}.\xspace}%
158}%
159\newcommand{\etal}{%
160        \@ifnextchar{.}{\abbrevFont{et~al}}%
161                {\abbrevFont{et al}.\xspace}%
162}%
163\makeatother
164
165\newenvironment{quote2}{%
166        \list{}{\lstset{resetmargins=true,aboveskip=0pt,belowskip=0pt}\topsep=4pt\parsep=0pt\leftmargin=\parindent\rightmargin\leftmargin}%
167        \item\relax
168}{%
169        \endlist
170}% quote2
171
172\newenvironment{rationale}{%
173  \begin{quote2}\noindent$\Box$\enspace
174}{%
175  \hfill\enspace$\Box$\end{quote2}
176}%
177
178% blocks and titles
179\newcommand{\define}[1]{\emph{#1\/}\index{#1}}
180\newcommand{\rewriterules}{\paragraph{Rewrite Rules}~\par\noindent}
181\newcommand{\examples}{\paragraph{Examples}~\par\noindent}
182\newcommand{\semantics}{\paragraph{Semantics}~\par\noindent}
183\newcommand{\constraints}{\paragraph{Constraints}~\par\noindent}
184\newcommand{\predefined}{\paragraph{Predefined Identifiers}~\par\noindent}
185
186% BNF macros
187\newenvironment{syntax}{
188\paragraph{Syntax}
189\begin{quote2}
190\begin{description}[noitemsep,leftmargin=\parindentlnth]
191}{
192\end{description}
193\end{quote2}
194}
195% \def\syntax{\paragraph{Syntax}\trivlist\parindent=.5in\item[\hskip.5in]}
196%\let\endsyntax=\endtrivlist
197\newcommand{\lhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}]~\ignorespaces}
198\newcommand{\oldlhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}~\dots]~}
199\newcommand{\rhs}{\hfil\newline}
200\newcommand{\nonterm}[1]{\emph{#1}\index{#1@{\emph{#1}}|italic}}
201\newcommand{\opt}{$_{opt}$\ }
202
203\usepackage{varioref}                 % extended references
204% adjust varioref package with default "section" and "page" titles, and optional title with faraway page numbers
205% \VRef{label} => Section 2.7, \VPageref{label} => page 17
206% \VRef[Figure]{label} => Figure 3.4, \VPageref{label} => page 17
207\renewcommand{\reftextfaceafter}{\unskip}
208\renewcommand{\reftextfacebefore}{\unskip}
209\renewcommand{\reftextafter}{\unskip}
210\renewcommand{\reftextbefore}{\unskip}
211\renewcommand{\reftextfaraway}[1]{\unskip, p.~\pageref{#1}}
212\renewcommand{\reftextpagerange}[2]{\unskip, pp.~\pageref{#1}--\pageref{#2}}
213\newcommand{\VRef}[2][Section]{\ifx#1\@empty\else{#1}\nobreakspace\fi\vref{#2}}
214\newcommand{\VPageref}[2][page]{\ifx#1\@empty\else{#1}\nobreakspace\fi\pageref{#2}}
215
216\let\Oldthebibliography\thebibliography
217\renewcommand\thebibliography[1]{
218  \Oldthebibliography{#1}
219  \setlength{\parskip}{0pt}                             % reduce vertical spacing between references
220  \setlength{\itemsep}{5pt plus 0.3ex}
221}%
222
223% Go programming language: https://github.com/julienc91/listings-golang/blob/master/listings-golang.sty
224\lstdefinelanguage{Golang}{
225        morekeywords=[1]{package,import,func,type,struct,return,defer,panic,recover,select,var,const,iota,},%
226        morekeywords=[2]{string,uint,uint8,uint16,uint32,uint64,int,int8,int16,int32,int64,
227                bool,float32,float64,complex64,complex128,byte,rune,uintptr, error,interface},%
228        morekeywords=[3]{map,slice,make,new,nil,len,cap,copy,close,true,false,delete,append,real,imag,complex,chan,},%
229        morekeywords=[4]{for,break,continue,range,goto,switch,case,fallthrough,if,else,default,},%
230        morekeywords=[5]{Println,Printf,Error,},%
231        sensitive=true,%
232        morecomment=[l]{//},%
233        morecomment=[s]{/*}{*/},%
234        morestring=[b]',%
235        morestring=[b]",%
236        morestring=[s]{`}{`},%
237}
238
239% CFA programming language, based on ANSI C (with some gcc additions)
240\lstdefinelanguage{Pseudo}{
241        morekeywords={string,uint,int,bool,float},%
242        sensitive=true,%
243        morecomment=[l]{//},%
244        morecomment=[s]{/*}{*/},%
245        morestring=[b]',%
246        morestring=[b]",%
247        morestring=[s]{`}{`},%
248}%
249
250% CFA programming language, based on ANSI C (with some gcc additions)
251\lstdefinelanguage{CFA}[ANSI]{C}{
252        morekeywords={_Alignas,_Alignof,__alignof,__alignof__,asm,__asm,__asm__,_At,_Atomic,__attribute,__attribute__,auto,
253                _Bool,catch,catchResume,choose,_Complex,__complex,__complex__,__const,__const__,disable,dtype,enable,__extension__,
254                fallthrough,fallthru,finally,forall,ftype,_Generic,_Imaginary,inline,__label__,lvalue,_Noreturn,one_t,otype,restrict,_Static_assert,
255                _Thread_local,throw,throwResume,trait,try,ttype,typeof,__typeof,__typeof__,zero_t},
256}%
257
258\newcommand{\CFADefaultStyle}{%
259\lstset{
260language=CFA,
261columns=fullflexible,
262basicstyle=\linespread{0.9}\sf,                                                 % reduce line spacing and use sanserif font
263stringstyle=\tt,                                                                                % use typewriter font
264tabsize=4,                                                                                              % 4 space tabbing
265xleftmargin=\parindentlnth,                                                             % indent code to paragraph indentation
266extendedchars=true,                                                                             % allow ASCII characters in the range 128-255
267escapechar=§,                                                                                   % LaTeX escape in CFA code §...§ (section symbol), emacs: C-q M-'
268mathescape=true,                                                                                % LaTeX math escape in CFA code $...$
269%keepspaces=true,                                                                               %
270showstringspaces=false,                                                                 % do not show spaces with cup
271showlines=true,                                                                                 % show blank lines at end of code
272aboveskip=4pt,                                                                                  % spacing above/below code block
273belowskip=3pt,
274% replace/adjust listing characters that look bad in sanserif
275literate={-}{\raisebox{-0.15ex}{\texttt{-}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
276        {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {_}{\makebox[1.2ex][c]{\rule{1ex}{0.1ex}}}1 {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
277        {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2,
278moredelim=**[is][\color{red}]{®}{®},                                    % red highlighting ®...® (registered trademark symbol) emacs: C-q M-.
279moredelim=**[is][\color{blue}]{ß}{ß},                                   % blue highlighting ß...ß (sharp s symbol) emacs: C-q M-_
280moredelim=**[is][\color{OliveGreen}]{¢}{¢},                     % green highlighting ¢...¢ (cent symbol) emacs: C-q M-"
281moredelim=[is][\lstset{keywords={}}]{}{},                     % keyword escape ¶...¶ (pilcrow symbol) emacs: C-q M-^
282}% lstset
283% inline code ©...© (copyright symbol) emacs: C-q M-)
284\lstMakeShortInline©                                                                    % single-character for \lstinline
285}%CFADefaultStyle
286
287% Local Variables: %
288% tab-width: 4 %
289% fill-column: 100 %
290% End: %
Note: See TracBrowser for help on using the repository browser.