source: doc/LaTeXmacros/common.tex @ 1a6e855

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 1a6e855 was 1a6e855, checked in by Peter A. Buhr <pabuhr@…>, 4 years ago

make CFA icon all san-serif, increase tab size, add "with" keyword, add C++ language

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