source: doc/LaTeXmacros/common.tex @ 7bb37fc

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 7bb37fc was e80ebe5, checked in by Peter A. Buhr <pabuhr@…>, 6 years ago

document new -no-include-std flag and implicit standard headers

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