Changeset 7a15b7e for doc/LaTeXmacros/common.sty

Timestamp:

Feb 7, 2022, 11:04:54 PM (16 months ago)

Author:

Peter A. Buhr <pabuhr@…>

Branches:

ADT, enum, forall-pointer-decay, master, pthread-emulation, qualifiedEnum

Children:

12b5e94a, c4f8170

Parents:

1cf8a9f

Message:

cleanup, add snake and lang macro

File:

• doc/LaTeXmacros/common.sty (modified) (7 diffs)

doc/LaTeXmacros/common.sty

@@ -11 +11 @@
 %% Created On       : Sat Apr  9 10:06:17 2016
 %% Last Modified By : Peter A. Buhr
-%% Last Modified On : Mon May 31 09:08:37 2021
-%% Update Count     : 565
+%% Last Modified On : Mon Feb  7 23:00:46 2022
+%% Update Count     : 569
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -43 +43 @@
 \newcommand{\CCIcon}{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}} % C++ icon
 \newcommand{\CC}[1][]{\protect\CCIcon{#1}\xspace}               % C++ symbolic name
+\newcommand{\Cpp}[1][]{\CC{#1}}                                                 % C++ synonym
 % numbers disallowed in latex variables names => use number names
 \newcommand{\CCeleven}{\protect\CCIcon{11}\xspace}              % C++11 symbolic name
@@ -51 +52 @@
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\usepackage{pslatex}                                                                    % reduce size of san serif font
+\usepackage{relsize}                                                                    % must be after change to small or selects old size
+\usepackage{rotating}
+\usepackage{calc}                                                                               % latex arithmetic
 
 % remove special-character warning in PDF side-bar names
@@ -71 +77 @@
 \newlength{\parindentlnth}
 \setlength{\parindentlnth}{\parindent}
-
-\usepackage{pslatex}                                                                    % reduce size of san serif font
-\usepackage{relsize}                                                                    % must be after change to small or selects old size
-\usepackage{rotating}
-\usepackage{calc}                                                                               % latex arithmetic
 
 % reduce size of chapter/section titles
@@ -151 +152 @@
 \newcommand{\@snewterm}[2][\@empty]{{\newtermFontInline{#2}}\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi}
 
+% \snake{<identifier>}
+% Improves writing of snake case (or any convention that uses _) by allowing
+% line breaks after _. Disables commands inside the block and formats the
+% identifier to look like code.
+\newcommand*\snake[1]{\snakefont{\expandafter\snake@next\detokenize{#1}\@nil}}
+
+% \snakefont{<text>}
+% Command used by \snake, you may renew the command to change its formating.
+\newcommand*\snakefont[1]{\LstBasicStyle{#1}}
+
+% Thanks Manuel of TeX Stack exchange. (I got the base pattern from one of
+% their answers.) Note: \@nil should never be defined.
+\newcommand*\snake@next[1]{\ifx\@nil#1\else
+  \expandafter\ifx\string_#1\string_\allowbreak\else#1\fi
+  \expandafter\snake@next\fi
+}
+
+% \lang{<language>}{<code>}
+% Use the listings package to format the snipit of <code> in <language>.
+\newcommand{\lang}[2]{\lstinline[language=#1]{#2}}
+
 % Latin abbreviation
 \newcommand{\abbrevFont}{\textit}                       % set empty for no italics
@@ -263 +285 @@
 extendedchars=true,                                             % allow ASCII characters in the range 128-255
 escapechar=\$,                                                  % LaTeX escape in CFA code §...§ (section symbol), emacs: C-q M-'
-mathescape=false,                                               % LaTeX math escape in CFA code $...$
+mathescape=false,                                               % disable LaTeX math escape in CFA code $...$
 keepspaces=true,                                                %
 showstringspaces=false,                                 % do not show spaces with cup
@@ -308 +330 @@
 }{}
 % inline code @...@ (at symbol)
-\makeatother
 \lstMakeShortInline@                                    % single-character for \lstinline
-\makeatletter
 \fi%