source: doc/LaTeXmacros/common.tex @ 308880c

ADTaaron-thesisarm-ehast-experimentalcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newwith_gc
Last change on this file since 308880c was eaa2f3a1, checked in by Peter A. Buhr <pabuhr@…>, 7 years ago

modify C-sharp macro

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