Changeset 8d66610 for doc/theses/andrew_beach_MMath/cfalab.sty

Timestamp:

May 21, 2021, 4:48:10 PM (5 years ago)

Author:

Thierry Delisle <tdelisle@…>

Branches:

ADT, arm-eh, ast-experimental, enum, forall-pointer-decay, jacob/cs343-translation, master, new-ast-unique-expr, pthread-emulation, qualifiedEnum, stuck-waitfor-destruct

Children:

f1bce515

Parents:

5407cdc (diff), 7404cdc (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' of plg.uwaterloo.ca:software/cfa/cfa-cc

File:

• doc/theses/andrew_beach_MMath/cfalab.sty (modified) (4 diffs)

doc/theses/andrew_beach_MMath/cfalab.sty

@@ -1 +1 @@
 % Package for CFA Research Lab.
+% (Now more a personal collection and testing grounds for common.sty.)
 %
-% Made by combining and updating various macro files people had made.
+% This is a collection of commands everyone working on CFA related documents
+% should find useful. So mostly programming language related tools.
 %
 % Internal commands are prefixed with "\cfalab@".
@@ -10 +12 @@
 
 % Other packages required.
+%
+% Access to new basic LaTeX tools and other low level commands.
 \RequirePackage{etoolbox}
+% Code formatting tools and environments.
 \RequirePackage{listings}
+% Automatically adds spaces.
 \RequirePackage{xspace}
 
-% Symbols: All symbols are zero argument robust commands with special rules
-% about the space following the c.s. token. Normally the space might be
-% re-added according to the rules of the xspace package. They may be followed
-% by a star (which the command will consume) to disable this behaviour.
+% Tip for commands that end with \xspace: if the default is not correct then
+% follow the command with {} to disable \xspace, use '{} ' to force add a
+% space and '{}<whatever-follows>' to force remove one.
+%
+% \CFA
+% Cforall with the forall symbol.
+\newrobustcmd\CFA{\textsf{C\raisebox{\depth}{\rotatebox{180}{A}}}\xspace}
+% \Cpp[<std>]
+% C++ symbol name. You may optionally provide <std> to specify a standard.
+\newrobustcmd\Cpp[1][\xspace]{C++#1}
 
-% \newsymbolcmd{<command>}{<replacement text>}
-%     Defines <command> to be a symbol that has the given <replacement text>.
-\newrobustcmd*\newsymbolcmd[2]{\newrobustcmd{#1}{\cfalab@symbol{#2}}}
-\def\cfalab@symbol#1{\@ifnextchar*{#1\cfalab@eatstar}{#1\xspace}}
-\def\cfalab@eatstar*{}
-
-% Cforall with the forall symbol.
-\newsymbolcmd\CFA{\textsf{C}\raisebox{\depth}{\rotatebox{180}{\textsf{A}}}}
-% C++ with kerning. (No standard number support.)
-\newsymbolcmd\CPP{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}}
-
-% This is executed very early in the \begin{document} code.
+% This is executed very early in the \begin{document} code, before the
+% document's contents but after packages are loaded.
 \AtEndPreamble{
   \@ifpackageloaded{hyperref}{
@@ -36 +38 @@
     \pdfstringdefDisableCommands{
       \def\CFA{CFA}
-      \def\CPP{C++}
+      \def\Cpp{C++}
+      \def\lstinline{}
+      \def\code#1#2{#2}
     }
   }{}
 }
+
+% \colour{<colour>}{<text>}
+% Just \color but using the LaTeX style instead of TeX style command.
+\newcommand*\colour[2]{{\color{#1}#2}}
+
+% \code{<language>}{<code>}
+% Use the listings package to format the snipit of <code> in <language>.
+\newrobustcmd*\code[2]{\lstinline[language=#1]{#2}}
+
+% \begin{cfa}[<options>]
+% \end{cfa}
+% Use the listings package to format a block of CFA code.
+% Extra listings options can be passed in as an optional argument.
+\lstnewenvironment{cfa}[1][]{\lstset{language=CFA}\lstset{#1}}{}
+
+% \settextunderscore{(new|old)}
+% Redefines the underscore either as a new repersentation or the old one.
+% Not that some other packages (ex. hyperref) can override this. Set it up
+% after loading them.
+\let\cfalab@textunderscore@old=\textunderscore
+\newcommand\cfalab@textunderscore@new{%
+    \leavevmode\makebox[1.2ex][c]{\rule{1ex}{0.075ex}}}
+\newcommand\settextunderscore[1]{%
+    \renewcommand\textunderscore{\csuse{cfalab@textunderscore@#1}}}
 
 % The CFA listings language. Based off of ANCI C and including GCC extensions.
@@ -61 +89 @@
 \lstset{defaultdialect={[UW]CFA}}
 
-% The cfalab style defines some common settings useful in different languages.
-\lstdefinestyle{cfalab}{%
-    columns=fullflexible,
-    basicstyle=\linespread{0.9}\tt,
-    stringstyle=\tt,
+% Create an internal paragraph indent amount. This is used internally to
+% mimic the standard indent even when it has been overriden in the document.
+\newlength\cfalab@parindent
+\deflength\cfalab@parindent{\parindent}
+
+% The cfacommon style has many useful defaults for CFA and other types of
+% code. Use the listings option "style=cfacommon" to load them.
+\lstdefinestyle{cfacommon}{
+  columns=fullflexible,
+  basicstyle=\linespread{0.9}\sf,
+  stringstyle=\tt,
+  tabsize=5,
+  % Indent code to paragraph indentation.
+  xleftmargin=\cfalab@parindent,
+  % Allow ASCII characters in the range 128-255.
+  extendedchars=true,
+  % This allows you to use "math mode" to insert LaTeX into the code.
+  % Use \( and \) if you need to insert math mode inside that code.
+  escapechar=\$,
+  % Disable LaTeX math escape in CFA code $...$
+  mathescape=false,
+  keepspaces=true,
+  % Do not show spaces with cup.
+  showstringspaces=false,
+  % Show blank lines at end of code.
+  showlines=true,
+  % Spacing above/below code block.
+  aboveskip=4pt,belowskip=0pt,
+  numberstyle=\footnotesize\sf,
+  % Replace/adjust listing characters that look bad in sanserif.
+  literate={-}{\makebox[1ex][c]{\raisebox{0.7ex}{\rule{0.75ex}{0.1ex}}}}1
+    {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1
+    {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1
+    {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2
+    {->}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.8ex}{0.075ex}}}\kern-0.2ex\textgreater}2,
 }
 
-% \code*[<escape character>]{<code>}
-%     Use the listings package to format a snipit of <code>.
-%     The <escape character> must be a character that does not appear in
-%     <code> and defaults to a backtick.
-\newcommand*\codeC[2][\`]{\lstinline[language=C]#1#2#1}
-\newcommand*\codeCFA[2][\`]{\lstinline[language=CFA]#1#2#1}
+% common.tex Compatablity ===================================================
+% Below this line is for compatability with the old common.tex file.
 
-% \settextunderscore{(new|old)}
-%     Redefines the underscore either as a new repersentation or the old one.
-%     Not that some other packages (ex. hyperref) can override this. Set it
-%     up after loading them.
-\let\cfalab@textunderscore@old=\textunderscore
-\newcommand\cfalab@textunderscore@new{%
-    \leavevmode\makebox[1.2ex][c]{\rule{1ex}{0.075ex}}}
-\newcommand\settextunderscore[1]{%
-    \renewcommand\textunderscore{\csuse{cfalab@textunderscore@#1}}}
+% Backwards compatable way to activate the cfacommon style.
+\newcommand{\CFAStyle}{\lstset{style=cfacommon}}
+
+% A couple of abbreviations are provided. Just ones someone liked.
+%
+% Abbreviation formatting commands (renew to customize):
+\newcommand{\abbrevFont}{\textit}
+%
+% Abbreviations that, if not followed by a comma or colon, add a comma.
+\newrobustcmd*\cfalab@abbrev@comma{%
+  \@ifnextchar{,}{}{\@ifnextchar{:}{}{,\xspace}}}
+\providerobustcmd*\eg{\abbrevFont{e}.\abbrevFont{g}.\cfalab@abbrev@comma}
+\providerobustcmd*\ie{\abbrevFont{i}.\abbrevFont{e}.\cfalab@abbrev@comma}
+%
+% Abbreviations that, if not followed by a period, add a period.
+\newrobustcmd*\cfalab@abbrev@period{\@ifnextchar{.}{}{.\xspace}}
+\providerobustcmd*\etc{\abbrevFont{etc}\cfalab@abbrev@period}
+\providerobustcmd*\etal{\abbrevFont{et}~\abbrevFont{al}\cfalab@abbrev@period}
+\providerobustcmd*\viz{\abbrevFont{viz}\cfalab@abbrev@period}
 
 \endinput