source: doc/LaTeXmacros/common.tex @ 144fa5c

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

support abbrevs \CFA, \CC, lstinline ... in PDF titles

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