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

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

change Latin-1 highlight character for color read in lstlisting, add subparagraph adjustment

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