source: doc/LaTeXmacros/common.tex @ d073e3c

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since d073e3c was 6d7c3df, checked in by Peter A. Buhr <pabuhr@…>, 6 years ago

Merge branch 'master' of plg2:software/cfa/cfa-cc

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