source: doc/LaTeXmacros/common.tex @ 7564e10

arm-ehjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-expr
Last change on this file since 7564e10 was 7564e10, checked in by Peter A. Buhr <pabuhr@…>, 3 years ago

change default comment indentation for listing macros

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