source: doc/LaTeXmacros/common.tex @ 3d67f83

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

make pdfstringdefDisableCommands conditional on hyperref

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