source: doc/LaTeXmacros/common.tex @ 182fe1e

ADTaaron-thesisarm-ehast-experimentalcleanup-dtorsctordeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxmemorynew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newwith_gc
Last change on this file since 182fe1e was 182fe1e, checked in by Peter A. Buhr <pabuhr@…>, 8 years ago

update switch documentation and LaTeX macros

  • Property mode set to 100644
File size: 12.1 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<<<<<<< HEAD
13%% Last Modified By : Peter A. Buhr
14%% Last Modified On : Mon Aug  1 08:57:17 2016
15%% Update Count     : 223
16=======
17%% Last Modified By :
18%% Last Modified On : Sun Jul 31 07:22:50 2016
19%% Update Count     : 207
20>>>>>>> 080615890f586cb9954c252b55cab47f52c25758
21%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
22
23%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
24
25\setlength{\textheight}{9in}
26%\oddsidemargin 0.0in
27\renewcommand{\topfraction}{0.8}                % float must be greater than X of the page before it is forced onto its own page
28\renewcommand{\bottomfraction}{0.8}             % float must be greater than X of the page before it is forced onto its own page
29\renewcommand{\floatpagefraction}{0.8}  % float must be greater than X of the page before it is forced onto its own page
30\renewcommand{\textfraction}{0.0}               % the entire page maybe devoted to floats with no text on the page at all
31
32\lefthyphenmin=4                                                % hyphen only after 4 characters
33\righthyphenmin=4
34
35\usepackage[ignoredisplayed]{enumitem}  % do not affect trivlist
36\setlist{labelsep=1ex}% global
37\setlist[itemize]{topsep=0.5ex,parsep=0.25ex,itemsep=0.25ex,listparindent=\parindent,leftmargin=\parindent}% global
38\setlist[itemize,1]{label=\textbullet}% local
39%\renewcommand{\labelitemi}{{\raisebox{0.25ex}{\footnotesize$\bullet$}}}
40\setlist[enumerate]{listparindent=\parindent}% global
41\setlist[enumerate,2]{leftmargin=\parindent,labelsep=*,align=parleft,label=\alph*.}% local
42\setlist[description]{itemsep=0pt,listparindent=\parindent,leftmargin=\parindent,labelsep=1.5ex}
43
44% Names used in the document.
45
46\newcommand{\CFA}{C$\mathbf\forall$\xspace} % set language symbolic name
47\newcommand{\CFL}{Cforall\xspace}               % set language text name
48\newcommand{\CC}{\rm C\kern-.1em\hbox{+\kern-.25em+}\xspace} % CC symbolic name
49\newcommand{\CCeleven}{\rm C\kern-.1em\hbox{+\kern-.25em+}11\xspace} % C++11 symbolic name
50\def\c11{ISO/IEC C}                                             % C11 name (cannot have numbers in latex command name)
51
52%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
53
54\makeatletter
55% parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for
56% use rather than use \parident directly.
57\newlength{\parindentlnth}
58\setlength{\parindentlnth}{\parindent}
59
60\newlength{\gcolumnposn}                                % temporary hack because lstlisting does 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@commentstyle{#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
74% reduce size of chapter/section titles
75\def\@makechapterhead#1{%
76  \vspace*{50\p@}%
77  {\parindent \z@ \raggedright \normalfont
78    \ifnum \c@secnumdepth >\m@ne
79        \large\bfseries \@chapapp\space \thechapter
80        \par\nobreak
81        \vskip 5\p@
82    \fi
83    \interlinepenalty\@M
84    \Large \bfseries #1\par\nobreak
85    \vskip 50\p@
86  }}
87\def\@makeschapterhead#1{%
88  \vspace*{50\p@}%
89  {\parindent \z@ \raggedright
90    \normalfont
91    \interlinepenalty\@M
92    \Large \bfseries  #1\par\nobreak
93    \vskip 50\p@
94  }}
95\renewcommand\section{\@startsection{section}{1}{\z@}{-3.5ex \@plus -1ex \@minus -.2ex}{1.75ex \@plus .2ex}{\normalfont\large\bfseries}}
96\renewcommand\subsection{\@startsection{subsection}{2}{\z@}{-3.25ex \@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
97\renewcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}{-2.5ex \@plus -1ex \@minus -.2ex}{1.0ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
98\renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}{-2.0ex \@plus -1ex \@minus -.2ex}{-1em}{\normalfont\normalsize\bfseries}}
99
100% index macros
101\newcommand{\italic}[1]{\emph{\hyperpage{#1}}}
102\newcommand{\definition}[1]{\textbf{\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}[1]{\lstinline$#1$\index{#1@\lstinline$#1$}}
136% code index (cannot use ©)
137\newcommand{\indexc}[1]{\index{#1@\lstinline$#1$}}
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\newcommand*{\eg}{%
150        \@ifnextchar{,}{\abbrevFont{e}.\abbrevFont{g}.}%
151                {\@ifnextchar{:}{\abbrevFont{e}.\abbrevFont{g}.}%
152                        {\abbrevFont{e}.\abbrevFont{g}.,\xspace}}%
153}%
154\newcommand*{\ie}{%
155        \@ifnextchar{,}{\abbrevFont{i}.\abbrevFont{e}.}%
156                {\@ifnextchar{:}{\abbrevFont{i}.\abbrevFont{e}.}%
157                        {\abbrevFont{i}.\abbrevFont{e}.,\xspace}}%
158}%
159\newcommand*{\etc}{%
160        \@ifnextchar{.}{\abbrevFont{etc}}%
161        {\abbrevFont{etc}.\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% adjust varioref package with default "section" and "page" titles, and optional title with faraway page numbers
204% \VRef{label} => Section 2.7, \VPageref{label} => page 17
205% \VRef[Figure]{label} => Figure 3.4, \VPageref{label} => page 17
206\renewcommand{\reftextfaceafter}{\unskip}
207\renewcommand{\reftextfacebefore}{\unskip}
208\renewcommand{\reftextafter}{\unskip}
209\renewcommand{\reftextbefore}{\unskip}
210\renewcommand{\reftextfaraway}[1]{\unskip, p.~\pageref{#1}}
211\renewcommand{\reftextpagerange}[2]{\unskip, pp.~\pageref{#1}--\pageref{#2}}
212\newcommand{\VRef}[2][Section]{\ifx#1\@empty\else{#1}\nobreakspace\fi\vref{#2}}
213\newcommand{\VPageref}[2][page]{\ifx#1\@empty\else{#1}\nobreakspace\fi\pageref{#2}}
214
215% Go programming language: https://github.com/julienc91/listings-golang/blob/master/listings-golang.sty
216\lstdefinelanguage{Golang}{
217        morekeywords=[1]{package,import,func,type,struct,return,defer,panic, recover,select,var,const,iota,},%
218        morekeywords=[2]{string,uint,uint8,uint16,uint32,uint64,int,int8,int16, int32,int64,
219                bool,float32,float64,complex64,complex128,byte,rune,uintptr, error,interface},%
220        morekeywords=[3]{map,slice,make,new,nil,len,cap,copy,close,true,false, delete,append,real,imag,complex,chan,},%
221        morekeywords=[4]{for,break,continue,range,goto,switch,case,fallthrough,if, else,default,},%
222        morekeywords=[5]{Println,Printf,Error,},%
223        sensitive=true,%
224        morecomment=[l]{//},%
225        morecomment=[s]{/*}{*/},%
226        morestring=[b]',%
227        morestring=[b]",%
228        morestring=[s]{`}{`},%
229}
230
231% CFA programming language, based on ANSI C (with some gcc additions)
232\lstdefinelanguage{CFA}[ANSI]{C}{
233        morekeywords={_Alignas,_Alignof,__alignof,__alignof__,asm,__asm,__asm__,_At,_Atomic,__attribute,__attribute__,auto,
234                _Bool,catch,catchResume,choose,_Complex,__complex,__complex__,__const,__const__,disable,dtype,enable,__extension__,
235                fallthrough,fallthru,finally,forall,ftype,_Generic,_Imaginary,inline,__label__,lvalue,_Noreturn,otype,restrict,_Static_assert,
236                _Thread_local,throw,throwResume,trait,try,typeof,__typeof,__typeof__,},
237}%
238
239\lstset{
240language=CFA,
241columns=fullflexible,
242basicstyle=\linespread{0.9}\sf,                 % reduce line spacing and use sanserif font
243stringstyle=\tt,                                                % use typewriter font
244tabsize=4,                                                              % 4 space tabbing
245xleftmargin=\parindentlnth,                             % indent code to paragraph indentation
246extendedchars=true,                                             % allow ASCII characters in the range 128-255
247escapechar=§,                                                   % escape to latex in CFA code
248mathescape=true,                                                % allow $...$ LaTeX math escapes in code
249%keepspaces=true,                                               %
250showstringspaces=false,                                 % do not show spaces with cup
251showlines=true,                                                 % show blank lines at end of code
252aboveskip=4pt,                                                  % spacing above/below code block
253belowskip=3pt,
254moredelim=**[is][\color{red}]{®}{®},    % red highlighting
255moredelim=**[is][\color{blue}]{ß}{ß},   % blue highlighting
256moredelim=**[is][\color{OliveGreen}]{¢}{¢}, % green highlighting
257moredelim=[is][\lstset{keywords={}}]{}{}, % temporarily turn off keywords
258% replace/adjust listing characters that look bad in sanserif
259literate={-}{\raisebox{-0.15ex}{\texttt{-}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
260        {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {_}{\makebox[1.2ex][c]{\rule{1ex}{0.1ex}}}1 {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
261        {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2 {...}{$\dots$}2,
262}%
263
264\lstMakeShortInline©    % single-character for \lstinline
265
266\let\Oldthebibliography\thebibliography
267\renewcommand\thebibliography[1]{
268  \Oldthebibliography{#1}
269  \setlength{\parskip}{0pt}                             % reduce vertical spacing between references
270  \setlength{\itemsep}{5pt plus 0.3ex}
271}%
272
273% Local Variables: %
274% tab-width: 4 %
275% fill-column: 100 %
276% End: %
Note: See TracBrowser for help on using the repository browser.