source: doc/LaTeXmacros/common.tex @ 4b393ba

ADTarm-ehast-experimentalenumforall-pointer-decayjacob/cs343-translationnew-ast-unique-exprpthread-emulationqualifiedEnum
Last change on this file since 4b393ba was 4b393ba, checked in by Peter A. Buhr <pabuhr@…>, 3 years ago

formatting, generalize printing \CC macros

  • Property mode set to 100644
File size: 13.4 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 : Wed Feb  3 10:57:33 2021
14%% Update Count     : 508
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]{topsep=0.5ex,itemsep=0pt,listparindent=\parindent,leftmargin=\parindent,labelsep=1.5ex}
35
36% Names used in the document.
37
38\usepackage{xspace}
39\newcommand{\CFAIcon}{\textsf{C}\raisebox{\depth}{\rotatebox{180}{\textsf{A}}}} % Cforall icon
40\newcommand{\CFA}{\protect\CFAIcon\xspace}                      % CFA symbolic name
41\newcommand{\CFL}{\textrm{Cforall}\xspace}                      % Cforall non-icon name
42\newcommand{\Celeven}{\textrm{C11}\xspace}                      % C11 symbolic name
43\newcommand{\CCIcon}{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}} % C++ icon
44\newcommand{\CC}{\protect\CCIcon\xspace}                        % C++ symbolic name
45% numbers disallowed in latex variables names => use number names
46\newcommand{\CCeleven}{\protect\CCIcon{11}\xspace}      % C++11 symbolic name
47\newcommand{\CCfourteen}{\protect\CCIcon{14}\xspace} % C++14 symbolic name
48\newcommand{\CCseventeen}{\protect\CCIcon{17}\xspace} % C++17 symbolic name
49\newcommand{\CCtwenty}{\protect\CCIcon{20}\xspace}      % C++20 symbolic name
50\newcommand{\Csharp}{C\raisebox{-0.7ex}{\Large$^\sharp$}\xspace} % C# symbolic name
51
52%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
53
54% remove special-character warning in PDF side-bar names
55\makeatletter
56\@ifpackageloaded{hyperref}{
57  \pdfstringdefDisableCommands{
58  \def\CFA{\CFL}
59  \def\CC{C++\xspace}
60  \def\CCeleven{C++11\xspace}
61  \def\CCfourteen{C++14\xspace}
62  \def\CCseventeen{C++17\xspace}
63  \def\CCtwenty{C++20\xspace}
64  \def\Csharp{C\#\xspace}
65  \def\lstinline{\xspace} % must use {} as delimiters, e.g., \lstinline{...}
66  }{}
67}
68
69% parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for
70% use rather than use \parident directly.
71\newlength{\parindentlnth}
72\setlength{\parindentlnth}{\parindent}
73
74\usepackage{pslatex}                                    % reduce size of san serif font
75\usepackage{relsize}                                    % must be after change to small or selects old size
76\usepackage{rotating}
77
78% reduce size of chapter/section titles
79\def\@makechapterhead#1{%
80  \vspace*{50\p@}%
81  {\parindent \z@ \raggedright \normalfont
82    \ifnum \c@secnumdepth >\m@ne
83        \large\bfseries \@chapapp\space \thechapter
84        \par\nobreak
85        \vskip 5\p@
86    \fi
87    \interlinepenalty\@M
88    \Large \bfseries #1\par\nobreak
89    \vskip 50\p@
90  }}
91\def\@makeschapterhead#1{%
92  \vspace*{50\p@}%
93  {\parindent \z@ \raggedright
94    \normalfont
95    \interlinepenalty\@M
96    \Large \bfseries  #1\par\nobreak
97    \vskip 50\p@
98  }}
99\renewcommand\section{\@startsection{section}{1}{\z@}{-3.5ex \@plus -1ex \@minus -.2ex}{1.75ex \@plus .2ex}{\normalfont\large\bfseries}}
100\renewcommand\subsection{\@startsection{subsection}{2}{\z@}{-3.25ex \@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
101\renewcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}{-2.5ex \@plus -1ex \@minus -.2ex}{1.0ex \@plus .2ex}{\normalfont\normalsize\bfseries}}
102\renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}{-2.0ex \@plus -1ex \@minus -.2ex}{-1em}{\normalfont\normalsize\bfseries}}
103
104% index macros
105\newcommand{\italic}[1]{\emph{\hyperpage{#1}}}
106\newcommand{\Definition}[1]{\textbf{\hyperpage{#1}}}
107\newcommand{\see}[1]{(see #1)}
108
109% Define some commands that produce formatted index entries suitable for cross-references.
110% ``\spec'' produces entries for specifications of entities.  ``\impl'' produces entries for their
111% implementations, and ``\use'' for their uses.
112
113%  \newcommand{\bold}[1]{{\bf #1}}
114%  \def\spec{\@bsphack\begingroup
115%             \def\protect##1{\string##1\space}\@sanitize
116%             \@wrxref{|bold}}
117\def\impl{\@bsphack\begingroup
118          \def\protect##1{\string##1\space}\@sanitize
119          \@wrxref{|Definition}}
120\newcommand{\indexcode}[1]{{\lstinline$#1$}}
121\def\use{\@bsphack\begingroup
122         \def\protect##1{\string##1\space}\@sanitize
123         \@wrxref{|hyperpage}}
124\def\@wrxref#1#2{\let\thepage\relax
125    \xdef\@gtempa{\write\@indexfile{\string
126    \indexentry{#2@{\lstinline$#2$}#1}{\thepage}}}\endgroup\@gtempa
127    \if@nobreak \ifvmode\nobreak\fi\fi\@esphack}
128%\newcommand{\use}[1]{\index{#1@{\lstinline$#1$}}}
129%\newcommand{\impl}[1]{\index{\protect#1@{\lstinline$\protect#1$}|Definition}}
130
131% inline text and lowercase index: \Index{inline and lowercase index text}
132\newcommand{\Index}{\@ifstar\@sIndex\@Index}
133% inline text and as-in index: \Index[as-is index text]{inline text}
134\newcommand{\@Index}[2][\@empty]{\lowercase{\def\temp{#2}}#2\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
135% inline text but index with different as-is text: \Index[index text]{inline text}
136\newcommand{\@sIndex}[2][\@empty]{#2\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
137
138% inline text and code index (cannot use ©)
139\newcommand{\Indexc}[2][\@empty]{\lstinline[#1]$#2$\index{#2@\lstinline[#1]$#2$}}
140% code index (cannot use ©)
141\newcommand{\indexc}[2][\@empty]{\index{#2@\lstinline[#1]$#2$}}
142
143% Denote newterms in particular font and index them without particular font and in lowercase, e.g., \newterm{abc}.
144% The option parameter provides an index term different from the new term, e.g., \newterm[\texttt{abc}]{abc}
145% The star version does not lowercase the index information, e.g., \newterm*{IBM}.
146\newcommand{\newtermFontInline}{\emph}
147\newcommand{\newterm}{\@ifstar\@snewterm\@newterm}
148\newcommand{\@newterm}[2][\@empty]{\lowercase{\def\temp{#2}}{\newtermFontInline{#2}}\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi}
149\newcommand{\@snewterm}[2][\@empty]{{\newtermFontInline{#2}}\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
150
151% Latin abbreviation
152\newcommand{\abbrevFont}{\textit}                       % set empty for no italics
153\@ifundefined{eg}{
154\newcommand{\EG}{\abbrevFont{e}.\abbrevFont{g}.}
155\newcommand*{\eg}{%
156        \@ifnextchar{,}{\EG}%
157                {\@ifnextchar{:}{\EG}%
158                        {\EG,\xspace}}%
159}}{}%
160\@ifundefined{ie}{
161\newcommand{\IE}{\abbrevFont{i}.\abbrevFont{e}.}
162\newcommand*{\ie}{%
163        \@ifnextchar{,}{\IE}%
164                {\@ifnextchar{:}{\IE}%
165                        {\IE,\xspace}}%
166}}{}%
167\@ifundefined{etc}{
168\newcommand{\ETC}{\abbrevFont{etc}}
169\newcommand*{\etc}{%
170        \@ifnextchar{.}{\ETC}%
171        {\ETC.\xspace}%
172}}{}%
173\@ifundefined{etal}{
174\newcommand{\ETAL}{\abbrevFont{et}~\abbrevFont{al}}
175\newcommand*{\etal}{%
176        \@ifnextchar{.}{\protect\ETAL}%
177                {\protect\ETAL.\xspace}%
178}}{}%
179\@ifundefined{viz}{
180\newcommand{\VIZ}{\abbrevFont{viz}}
181\newcommand*{\viz}{%
182        \@ifnextchar{.}{\VIZ}%
183                {\VIZ.\xspace}%
184}}{}%
185\makeatother
186
187\newenvironment{cquote}{%
188        \list{}{\lstset{resetmargins=true,aboveskip=0pt,belowskip=0pt}\topsep=4pt\parsep=0pt\leftmargin=\parindentlnth\rightmargin\leftmargin}%
189        \item\relax
190}{%
191        \endlist
192}% cquote
193
194\newenvironment{rationale}{%
195  \begin{cquote}\noindent$\Box$\enspace
196}{%
197  \hfill\enspace$\Box$\end{cquote}
198}%
199
200% blocks and titles
201\newcommand{\define}[1]{\emph{#1\/}\index{#1}}
202\newcommand{\rewriterules}{\paragraph{Rewrite Rules}~\par\noindent}
203\newcommand{\examples}{\paragraph{Examples}~\par\noindent}
204\newcommand{\semantics}{\paragraph{Semantics}~\par\noindent}
205\newcommand{\constraints}{\paragraph{Constraints}~\par\noindent}
206\newcommand{\predefined}{\paragraph{Predefined Identifiers}~\par\noindent}
207
208% BNF macros
209\newenvironment{syntax}{
210\paragraph{Syntax}
211\begin{cquote}
212\begin{description}[noitemsep,leftmargin=\parindentlnth]
213}{
214\end{description}
215\end{cquote}
216}
217% \def\syntax{\paragraph{Syntax}\trivlist\parindent=.5in\item[\hskip.5in]}
218%\let\endsyntax=\endtrivlist
219\newcommand{\lhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}]~\ignorespaces}
220\newcommand{\oldlhs}[1]{\item[\emph{#1:}\index{#1@{\emph{#1}}|italic}~\dots]~}
221\newcommand{\rhs}{\hfil\newline}
222\newcommand{\nonterm}[1]{\emph{#1}\index{#1@{\emph{#1}}|italic}}
223\newcommand{\opt}{$_{opt}$\ }
224
225\usepackage{varioref}                                   % extended references
226% adjust varioref package with default "section" and "page" titles, and optional title with faraway page numbers
227% \VRef{label} => Section 2.7, \VPageref{label} => page 17
228% \VRef[Figure]{label} => Figure 3.4, \VPageref{label} => page 17
229\renewcommand{\reftextfaceafter}{\unskip}
230\renewcommand{\reftextfacebefore}{\unskip}
231\renewcommand{\reftextafter}{\unskip}
232\renewcommand{\reftextbefore}{\unskip}
233\renewcommand{\reftextfaraway}[1]{\unskip, p.~\pageref{#1}}
234\renewcommand{\reftextpagerange}[2]{\unskip, pp.~\pageref{#1}--\pageref{#2}}
235\newcommand{\VRef}[2][Section]{\ifx#1\@empty\else{#1}\nobreakspace\fi\vref{#2}}
236\newcommand{\VPageref}[2][page]{\ifx#1\@empty\else{#1}\nobreakspace\fi\pageref{#2}}
237
238\let\Oldthebibliography\thebibliography
239\renewcommand\thebibliography[1]{
240  \Oldthebibliography{#1}
241  \setlength{\parskip}{0pt}                             % reduce vertical spacing between references
242  \setlength{\itemsep}{5pt plus 0.3ex}
243}%
244
245\usepackage{listings}                                                                   % format program code
246\usepackage{lstlang}
247\usepackage{calc}                                                                               % latex arithmetic
248
249\makeatletter
250\newcommand{\LstBasicStyle}[1]{{\lst@basicstyle{#1}}}
251\newcommand{\LstKeywordStyle}[1]{{\lst@basicstyle{\lst@keywordstyle{#1}}}}
252\newcommand{\LstCommentStyle}[1]{{\lst@basicstyle{\lst@commentstyle{#1}}}}
253
254\newlength{\gcolumnposn}                                % temporary hack because lstlisting does not handle tabs correctly
255\newlength{\columnposn}
256\setlength{\gcolumnposn}{2.75in}
257\setlength{\columnposn}{\gcolumnposn}
258\newcommand{\C}[2][\@empty]{\ifx#1\@empty\else\global\setlength{\columnposn}{#1}\global\columnposn=\columnposn\fi\hfill\makebox[\textwidth-\columnposn][l]{\lst@basicstyle{\LstCommentStyle{#2}}}}
259\newcommand{\CRT}{\global\columnposn=\gcolumnposn}
260
261% allow escape sequence in lstinline
262%\usepackage{etoolbox}
263%\patchcmd{\lsthk@TextStyle}{\let\lst@DefEsc\@empty}{}{}{\errmessage{failed to patch}}
264
265% allow adding to lst literate
266\def\addToLiterate#1{\protect\edef\lst@literate{\unexpanded\expandafter{\lst@literate}\unexpanded{#1}}}
267\lst@Key{add to literate}{}{\addToLiterate{#1}}
268\makeatother
269
270\newcommand{\CFAStyle}{%
271\lstset{
272columns=fullflexible,
273basicstyle=\linespread{0.9}\sf,                 % reduce line spacing and use sanserif font
274stringstyle=\tt,                                                % use typewriter font
275tabsize=5,                                                              % N space tabbing
276xleftmargin=\parindentlnth,                             % indent code to paragraph indentation
277extendedchars=true,                                             % allow ASCII characters in the range 128-255
278escapechar=§,                                                   % LaTeX escape in CFA code §...§ (section symbol), emacs: C-q M-'
279mathescape=true,                                                % LaTeX math escape in CFA code $...$
280keepspaces=true,                                                %
281showstringspaces=false,                                 % do not show spaces with cup
282showlines=true,                                                 % show blank lines at end of code
283aboveskip=4pt,                                                  % spacing above/below code block
284belowskip=0pt,
285numberstyle=\footnotesize\sf,                   % numbering style
286% replace/adjust listing characters that look bad in sanserif
287literate={-}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.75ex}{0.1ex}}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
288        {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
289        {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2 {->}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.8ex}{0.075ex}}}\kern-0.2ex\textgreater}2,
290}% lstset
291}% CFAStyle
292
293\ifdefined\CFALatin% extra Latin-1 escape characters
294\lstnewenvironment{cfa}[1][]{
295\lstset{
296language=CFA,
297moredelim=**[is][\color{red}]{®}{®},    % red highlighting ®...® (registered trademark symbol) emacs: C-q M-.
298moredelim=**[is][\color{blue}]{ß}{ß},   % blue highlighting ß...ß (sharp s symbol) emacs: C-q M-_
299moredelim=**[is][\color{OliveGreen}]{¢}{¢}, % green highlighting ¢...¢ (cent symbol) emacs: C-q M-"
300moredelim=[is][\lstset{keywords={}}]{}{}, % keyword escape ¶...¶ (pilcrow symbol) emacs: C-q M-^
301% replace/adjust listing characters that look bad in sanserif
302add to literate={`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
303}% lstset
304\lstset{#1}
305}{}
306% inline code ©...© (copyright symbol) emacs: C-q M-)
307\lstMakeShortInline©                                    % single-character for \lstinline
308\else% regular ASCI characters
309\lstnewenvironment{cfa}[1][]{
310\lstset{
311language=CFA,
312escapechar=\$,                                                  % LaTeX escape in CFA code
313mathescape=false,                                               % LaTeX math escape in CFA code $...$
314moredelim=**[is][\color{red}]{@}{@},    % red highlighting @...@
315}% lstset
316\lstset{#1}
317}{}
318% inline code @...@ (at symbol)
319\lstMakeShortInline@                                    % single-character for \lstinline
320\fi%
321
322% Local Variables: %
323% tab-width: 4 %
324% fill-column: 100 %
325% End: %
Note: See TracBrowser for help on using the repository browser.