source: doc/LaTeXmacros/common.tex @ ff3fc93

aaron-thesisarm-ehcleanup-dtorsctordeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxmemorynew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since ff3fc93 was ef3b335, checked in by Aaron Moss <a3moss@…>, 6 years ago

Minor edits to comp II draft

  • Property mode set to 100644
File size: 11.0 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 Jul 12 20:37:57 2016
14%% Update Count     : 206
15%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
16
17%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
18
19\setlength{\textheight}{9in}
20%\oddsidemargin 0.0in
21\renewcommand{\topfraction}{0.8}        % float must be greater than X of the page before it is forced onto its own page
22\renewcommand{\bottomfraction}{0.8}     % float must be greater than X of the page before it is forced onto its own page
23\renewcommand{\floatpagefraction}{0.8}  % float must be greater than X of the page before it is forced onto its own page
24\renewcommand{\textfraction}{0.0}       % the entire page maybe devoted to floats with no text on the page at all
25
26\lefthyphenmin=4
27\righthyphenmin=4
28
29\usepackage[ignoredisplayed]{enumitem}  % do not affect trivlist
30\setlist{labelsep=1ex}% global
31\setlist[itemize]{topsep=0.5ex,parsep=0.25ex,itemsep=0.25ex,listparindent=\parindent,leftmargin=\parindent}% global
32\setlist[itemize,1]{label=\textbullet}% local
33%\renewcommand{\labelitemi}{{\raisebox{0.25ex}{\footnotesize$\bullet$}}}
34\setlist[enumerate]{listparindent=\parindent}% global
35\setlist[enumerate,2]{leftmargin=\parindent,labelsep=*,align=parleft,label=\alph*.}% local
36\setlist[description]{itemsep=0pt,listparindent=\parindent,leftmargin=\parindent,labelsep=1.5ex}
37
38% Names used in the document.
39
40\newcommand{\CFA}{C$\mathbf\forall$\xspace}              % set language symbolic name
41\newcommand{\CFL}{Cforall\xspace}                        % set language text name
42\newcommand{\CC}{\rm C\kern-.1em\hbox{+\kern-.25em+}\xspace} % CC symbolic name
43\newcommand{\CCeleven}{\rm C\kern-.1em\hbox{+\kern-.25em+}11\xspace} % C++11 symbolic name
44\def\c11{ISO/IEC C} % C11 name (cannot have numbers in latex command name)
45
46%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
47
48\makeatletter
49% parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for
50% use rather than use \parident directly.
51\newlength{\parindentlnth}
52\setlength{\parindentlnth}{\parindent}
53
54\newlength{\gcolumnposn}
55\newlength{\columnposn}
56\setlength{\gcolumnposn}{2.5in}
57\setlength{\columnposn}{\gcolumnposn}
58\newcommand{\C}[2][\@empty]{\ifx#1\@empty\else\global\setlength{\columnposn}{#1}\global\columnposn=\columnposn\fi\hfill\makebox[\textwidth-\columnposn][l]{\lst@commentstyle{#2}}}
59\newcommand{\CRT}{\global\columnposn=\gcolumnposn}
60
61% allow escape sequence in lstinline
62%\usepackage{etoolbox}
63%\patchcmd{\lsthk@TextStyle}{\let\lst@DefEsc\@empty}{}{}{\errmessage{failed to patch}}
64
65\usepackage{pslatex}                                                                    % reduce size of san serif font
66\usepackage{relsize}                                    % must be after change to small or selects old size
67
68% reduce size of chapter/section titles
69\def\@makechapterhead#1{%
70  \vspace*{50\p@}%
71  {\parindent \z@ \raggedright \normalfont
72    \ifnum \c@secnumdepth >\m@ne
73        \large\bfseries \@chapapp\space \thechapter
74        \par\nobreak
75        \vskip 5\p@
76    \fi
77    \interlinepenalty\@M
78    \Large \bfseries #1\par\nobreak
79    \vskip 50\p@
80  }}
81\def\@makeschapterhead#1{%
82  \vspace*{50\p@}%
83  {\parindent \z@ \raggedright
84    \normalfont
85    \interlinepenalty\@M
86    \Large \bfseries  #1\par\nobreak
87    \vskip 50\p@
88  }}
89\renewcommand\section{\@startsection{section}{1}{\z@}{-3.5ex \@plus -1ex \@minus -.2ex}{1.75ex \@plus .2ex}{\normalfont\large\bfseries}}
90\renewcommand\subsection{\@startsection{subsection}{2}{\z@}{-3.25ex \@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
91\renewcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}{-2.5ex \@plus -1ex \@minus -.2ex}{1.0ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
92\renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}{-2.0ex \@plus -1ex \@minus -.2ex}{-1em}{\normalfont\normalsize\bfseries}}
93
94% index macros
95\newcommand{\italic}[1]{\emph{\hyperpage{#1}}}
96\newcommand{\definition}[1]{\textbf{\hyperpage{#1}}}
97\newcommand{\see}[1]{\emph{see} #1}
98
99% Define some commands that produce formatted index entries suitable for cross-references.
100% ``\spec'' produces entries for specifications of entities.  ``\impl'' produces entries for their
101% implementations, and ``\use'' for their uses.
102
103%  \newcommand{\bold}[1]{{\bf #1}}
104%  \def\spec{\@bsphack\begingroup
105%             \def\protect##1{\string##1\space}\@sanitize
106%             \@wrxref{|bold}}
107\def\impl{\@bsphack\begingroup
108          \def\protect##1{\string##1\space}\@sanitize
109          \@wrxref{|definition}}
110\newcommand{\indexcode}[1]{{\lstinline$#1$}}
111\def\use{\@bsphack\begingroup
112         \def\protect##1{\string##1\space}\@sanitize
113         \@wrxref{|hyperpage}}
114\def\@wrxref#1#2{\let\thepage\relax
115    \xdef\@gtempa{\write\@indexfile{\string
116    \indexentry{#2@{\lstinline$#2$}#1}{\thepage}}}\endgroup\@gtempa
117    \if@nobreak \ifvmode\nobreak\fi\fi\@esphack}
118%\newcommand{\use}[1]{\index{#1@{\lstinline$#1$}}}
119%\newcommand{\impl}[1]{\index{\protect#1@{\lstinline$\protect#1$}|definition}}
120
121% inline text and lowercase index: \Index{inline and lowercase index text}
122% inline text and as-in index: \Index[as-is index text]{inline text}
123% inline text but index with different as-is text: \Index[index text]{inline text}
124\newcommand{\Index}{\@ifstar\@sIndex\@Index}
125\newcommand{\@Index}[2][\@empty]{\lowercase{\def\temp{#2}}#2\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
126\newcommand{\@sIndex}[2][\@empty]{#2\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
127
128% cannot use ©
129\newcommand{\Indexc}[1]{\lstinline$#1$\index{#1@\lstinline$#1$}}
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\makeatother
140
141\newenvironment{quote2}{%
142        \list{}{\lstset{resetmargins=true,aboveskip=0pt,belowskip=0pt}\topsep=4pt\parsep=0pt\leftmargin=\parindent\rightmargin\leftmargin}%
143        \item\relax
144}{%
145        \endlist
146}% quote2
147\newenvironment{rationale}{%
148  \begin{quote2}\noindent$\Box$\enspace
149}{%
150  \hfill\enspace$\Box$\end{quote2}
151}%
152
153% blocks and titles
154\newcommand{\define}[1]{\emph{#1\/}\index{#1}}
155\newcommand{\rewriterules}{\paragraph{Rewrite Rules}~\par\noindent}
156\newcommand{\examples}{\paragraph{Examples}~\par\noindent}
157\newcommand{\semantics}{\paragraph{Semantics}~\par\noindent}
158\newcommand{\constraints}{\paragraph{Constraints}~\par\noindent}
159\newcommand{\predefined}{\paragraph{Predefined Identifiers}~\par\noindent}
160
161% BNF macros
162\newenvironment{syntax}{
163\paragraph{Syntax}
164\begin{quote2}
165\begin{description}[noitemsep,leftmargin=\parindentlnth]
166}{
167\end{description}
168\end{quote2}
169}
170% \def\syntax{\paragraph{Syntax}\trivlist\parindent=.5in\item[\hskip.5in]}
171%\let\endsyntax=\endtrivlist
172\newcommand{\lhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}]~\ignorespaces}
173\newcommand{\oldlhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}~\dots]~}
174\newcommand{\rhs}{\hfil\newline}
175\newcommand{\nonterm}[1]{\emph{#1}\index{#1@{\emph{#1}}|italic}}
176\newcommand{\opt}{$_{opt}$\ }
177
178% adjust varioref package with default "section" and "page" titles, and optional title with faraway page numbers
179% \VRef{label} => Section 2.7, \VPageref{label} => page 17
180% \VRef[Figure]{label} => Figure 3.4, \VPageref{label} => page 17
181\renewcommand{\reftextfaceafter}{\unskip}
182\renewcommand{\reftextfacebefore}{\unskip}
183\renewcommand{\reftextafter}{\unskip}
184\renewcommand{\reftextbefore}{\unskip}
185\renewcommand{\reftextfaraway}[1]{\unskip, p.~\pageref{#1}}
186\renewcommand{\reftextpagerange}[2]{\unskip, pp.~\pageref{#1}--\pageref{#2}}
187\newcommand{\VRef}[2][Section]{\ifx#1\@empty\else{#1}\nobreakspace\fi\vref{#2}}
188\newcommand{\VPageref}[2][page]{\ifx#1\@empty\else{#1}\nobreakspace\fi\pageref{#2}}
189
190% Go programming language
191\lstdefinelanguage{Golang}{
192        morekeywords=[1]{package,import,func,type,struct,return,defer,panic, recover,select,var,const,iota,},%
193        morekeywords=[2]{string,uint,uint8,uint16,uint32,uint64,int,int8,int16, int32,int64,
194                bool,float32,float64,complex64,complex128,byte,rune,uintptr, error,interface},%
195        morekeywords=[3]{map,slice,make,new,nil,len,cap,copy,close,true,false, delete,append,real,imag,complex,chan,},%
196        morekeywords=[4]{for,break,continue,range,goto,switch,case,fallthrough,if, else,default,},%
197        morekeywords=[5]{Println,Printf,Error,},%
198        sensitive=true,%
199        morecomment=[l]{//},%
200        morecomment=[s]{/*}{*/},%
201        morestring=[b]',%
202        morestring=[b]",%
203        morestring=[s]{`}{`},%
204}
205
206% CFA programming language, based on ANSI C
207\lstdefinelanguage{CFA}[ANSI]{C}{
208        morekeywords={_Alignas,_Alignof,__alignof,__alignof__,asm,__asm,__asm__,_At,_Atomic,__attribute,__attribute__,auto,
209                _Bool,catch,catchResume,choose,_Complex,__complex,__complex__,__const,__const__,disable,dtype,enable,__extension__,
210                fallthru,finally,forall,ftype,_Generic,_Imaginary,inline,__label__,lvalue,_Noreturn,otype,restrict,_Static_assert,
211                _Thread_local,throw,throwResume,trait,try,typeof,__typeof,__typeof__,},
212}%
213
214\lstset{
215language=CFA,
216columns=fullflexible,
217basicstyle=\linespread{0.9}\sf,
218stringstyle=\tt,
219tabsize=4,
220xleftmargin=\parindentlnth,
221extendedchars=true,
222escapechar=§,
223mathescape=true,
224keepspaces=true,
225showstringspaces=false,
226showlines=true,
227aboveskip=4pt,
228belowskip=3pt,
229moredelim=**[is][\color{red}]{®}{®}, % red highlighting
230moredelim=**[is][\color{blue}]{ß}{ß}, % blue highlighting
231moredelim=**[is][\color{OliveGreen}]{¢}{¢}, % green highlighting
232moredelim=[is][\lstset{keywords={}}]{}{}, % temporarily turn off keywords
233% replace/adjust listing characters that look bad in sanserif
234literate={-}{\raisebox{-0.15ex}{\texttt{-}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
235        {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {_}{\makebox[1.2ex][c]{\rule{1ex}{0.1ex}}}1 {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
236        {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2 {...}{$\dots$}2,
237}%
238
239\lstMakeShortInline©    % single-character for \lstinline
240
241\let\Oldthebibliography\thebibliography
242\renewcommand\thebibliography[1]{
243  \Oldthebibliography{#1}
244  \setlength{\parskip}{0pt}                     % reduce vertical spacing between references
245  \setlength{\itemsep}{5pt plus 0.3ex}
246}%
247
248\newcommand*{\eg}{\textit{e.g}.\@\xspace}
249\newcommand*{\ie}{\textit{i.e}.\@\xspace}
250
251\makeatletter
252\newcommand*{\etc}{%
253    \@ifnextchar{.}%
254        {\textit{etc}}%
255        {\textit{etc}.\@\xspace}%
256}
257\makeatother
258
259% Local Variables: %
260% tab-width: 4 %
261% fill-column: 100 %
262% End: %
Note: See TracBrowser for help on using the repository browser.