source: doc/LaTeXmacros/common.tex

Last change on this file was 1b2adec, checked in by Peter A. Buhr <pabuhr@…>, 7 months ago

add latex macros \VRefrange and \VPagerefrange

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