source: doc/LaTeXmacros/common.tex @ fd603d8

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

Added properly-formatted i.e., e.g., etc. macros to common.tex

  • Property mode set to 100644
File size: 10.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 : 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\def\c11{ISO/IEC C} % C11 name (cannot have numbers in latex command 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}
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% inline text and as-in index: \Index[as-is index text]{inline text}
122% inline text but index with different as-is text: \Index[index text]{inline text}
123\newcommand{\Index}{\@ifstar\@sIndex\@Index}
124\newcommand{\@Index}[2][\@empty]{\lowercase{\def\temp{#2}}#2\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
125\newcommand{\@sIndex}[2][\@empty]{#2\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
126
127% cannot use ©
128\newcommand{\Indexc}[1]{\lstinline$#1$\index{#1@\lstinline$#1$}}
129\newcommand{\indexc}[1]{\index{#1@\lstinline$#1$}}
130
131% Denote newterms in particular font and index them without particular font and in lowercase, e.g., \newterm{abc}.
132% The option parameter provides an index term different from the new term, e.g., \newterm[\texttt{abc}]{abc}
133% The star version does not lowercase the index information, e.g., \newterm*{IBM}.
134\newcommand{\newtermFontInline}{\emph}
135\newcommand{\newterm}{\@ifstar\@snewterm\@newterm}
136\newcommand{\@newterm}[2][\@empty]{\lowercase{\def\temp{#2}}{\newtermFontInline{#2}}\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
137\newcommand{\@snewterm}[2][\@empty]{{\newtermFontInline{#2}}\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
138\makeatother
139
140\newenvironment{quote2}{%
141        \list{}{\lstset{resetmargins=true,aboveskip=0pt,belowskip=0pt}\topsep=4pt\parsep=0pt\leftmargin=\parindent\rightmargin\leftmargin}%
142        \item\relax
143}{%
144        \endlist
145}% quote2
146\newenvironment{rationale}{%
147  \begin{quote2}\noindent$\Box$\enspace
148}{%
149  \hfill\enspace$\Box$\end{quote2}
150}%
151
152% blocks and titles
153\newcommand{\define}[1]{\emph{#1\/}\index{#1}}
154\newcommand{\rewriterules}{\paragraph{Rewrite Rules}~\par\noindent}
155\newcommand{\examples}{\paragraph{Examples}~\par\noindent}
156\newcommand{\semantics}{\paragraph{Semantics}~\par\noindent}
157\newcommand{\constraints}{\paragraph{Constraints}~\par\noindent}
158\newcommand{\predefined}{\paragraph{Predefined Identifiers}~\par\noindent}
159
160% BNF macros
161\newenvironment{syntax}{
162\paragraph{Syntax}
163\begin{quote2}
164\begin{description}[noitemsep,leftmargin=\parindentlnth]
165}{
166\end{description}
167\end{quote2}
168}
169% \def\syntax{\paragraph{Syntax}\trivlist\parindent=.5in\item[\hskip.5in]}
170%\let\endsyntax=\endtrivlist
171\newcommand{\lhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}]~\ignorespaces}
172\newcommand{\oldlhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}~\dots]~}
173\newcommand{\rhs}{\hfil\newline}
174\newcommand{\nonterm}[1]{\emph{#1}\index{#1@{\emph{#1}}|italic}}
175\newcommand{\opt}{$_{opt}$\ }
176
177% adjust varioref package with default "section" and "page" titles, and optional title with faraway page numbers
178% \VRef{label} => Section 2.7, \VPageref{label} => page 17
179% \VRef[Figure]{label} => Figure 3.4, \VPageref{label} => page 17
180\renewcommand{\reftextfaceafter}{\unskip}
181\renewcommand{\reftextfacebefore}{\unskip}
182\renewcommand{\reftextafter}{\unskip}
183\renewcommand{\reftextbefore}{\unskip}
184\renewcommand{\reftextfaraway}[1]{\unskip, p.~\pageref{#1}}
185\renewcommand{\reftextpagerange}[2]{\unskip, pp.~\pageref{#1}--\pageref{#2}}
186\newcommand{\VRef}[2][Section]{\ifx#1\@empty\else{#1}\nobreakspace\fi\vref{#2}}
187\newcommand{\VPageref}[2][page]{\ifx#1\@empty\else{#1}\nobreakspace\fi\pageref{#2}}
188
189% Go programming language
190\lstdefinelanguage{Golang}{
191        morekeywords=[1]{package,import,func,type,struct,return,defer,panic, recover,select,var,const,iota,},%
192        morekeywords=[2]{string,uint,uint8,uint16,uint32,uint64,int,int8,int16, int32,int64,
193                bool,float32,float64,complex64,complex128,byte,rune,uintptr, error,interface},%
194        morekeywords=[3]{map,slice,make,new,nil,len,cap,copy,close,true,false, delete,append,real,imag,complex,chan,},%
195        morekeywords=[4]{for,break,continue,range,goto,switch,case,fallthrough,if, else,default,},%
196        morekeywords=[5]{Println,Printf,Error,},%
197        sensitive=true,%
198        morecomment=[l]{//},%
199        morecomment=[s]{/*}{*/},%
200        morestring=[b]',%
201        morestring=[b]",%
202        morestring=[s]{`}{`},%
203}
204
205% CFA programming language, based on ANSI C
206\lstdefinelanguage{CFA}[ANSI]{C}{
207        morekeywords={_Alignas,_Alignof,__alignof,__alignof__,asm,__asm,__asm__,_At,_Atomic,__attribute,__attribute__,auto,
208                _Bool,catch,catchResume,choose,_Complex,__complex,__complex__,__const,__const__,disable,dtype,enable,__extension__,
209                fallthru,finally,forall,ftype,_Generic,_Imaginary,inline,__label__,lvalue,_Noreturn,otype,restrict,_Static_assert,
210                _Thread_local,throw,throwResume,trait,try,typeof,__typeof,__typeof__,},
211}%
212
213\lstset{
214language=CFA,
215columns=fullflexible,
216basicstyle=\linespread{0.9}\sf,
217stringstyle=\tt,
218tabsize=4,
219xleftmargin=\parindentlnth,
220extendedchars=true,
221escapechar=§,
222mathescape=true,
223keepspaces=true,
224showstringspaces=false,
225showlines=true,
226aboveskip=4pt,
227belowskip=3pt,
228moredelim=**[is][\color{red}]{®}{®}, % red highlighting
229moredelim=**[is][\color{blue}]{ß}{ß}, % blue highlighting
230moredelim=**[is][\color{OliveGreen}]{¢}{¢}, % green highlighting
231moredelim=[is][\lstset{keywords={}}]{}{}, % temporarily turn off keywords
232% replace/adjust listing characters that look bad in sanserif
233literate={-}{\raisebox{-0.15ex}{\texttt{-}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
234        {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {_}{\makebox[1.2ex][c]{\rule{1ex}{0.1ex}}}1 {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
235        {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2 {...}{$\dots$}2,
236}%
237
238\lstMakeShortInline©    % single-character for \lstinline
239
240\let\Oldthebibliography\thebibliography
241\renewcommand\thebibliography[1]{
242  \Oldthebibliography{#1}
243  \setlength{\parskip}{0pt}                     % reduce vertical spacing between references
244  \setlength{\itemsep}{5pt plus 0.3ex}
245}%
246
247\newcommand*{\eg}{\textit{e.g}.\@\xspace}
248\newcommand*{\ie}{\textit{i.e}.\@\xspace}
249
250\makeatletter
251\newcommand*{\etc}{%
252    \@ifnextchar{.}%
253        {\textit{etc}}%
254        {\textit{etc}.\@\xspace}%
255}
256\makeatother
257
258% Local Variables: %
259% tab-width: 4 %
260% fill-column: 100 %
261% End: %
Note: See TracBrowser for help on using the repository browser.