source: doc/LaTeXmacros/common.tex

Last change on this file was 8f7109c, checked in by Peter A. Buhr <pabuhr@…>, 4 weeks ago

change minimum left/right hyphenation from 4 to 3 characters

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