source: doc/LaTeXmacros/common.tex @ 2b878b4

arm-ehjacob/cs343-translationnew-ast-unique-expr
Last change on this file since 2b878b4 was 2b878b4, checked in by Peter A. Buhr <pabuhr@…>, 9 months ago

change format of \see macro, reduce spacing before description macro

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