source: doc/LaTeXmacros/common.tex @ b2f5082

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since b2f5082 was b2f5082, checked in by Rob Schluntz <rschlunt@…>, 5 years ago

add C++14 symbolic name

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