# Can one define an expandable command that removes control sequences from its argument?

I am trying to create an expandable command that accepts a single argument that may contain control sequences, and expands to that same argument with all control sequences and braces removed. That is:

\StripControlSequences{John Q. Author, \textit{Book Title}}


should expand to merely:

John Q. Author, Book Title


Alternatively, if I could designate the control sequences that get stripped out, such as \textit, \textbf, etc. that would be reasonable, as well.

If I didn't care about expandability, this would be easy. I have a macro using xstring that strips out arbitrary control characters. If I just wanted to get rid of the formatting from \textit during execution, I could do something like this:

\def\StripControlSequences#1{{%
\let\textit=\relax%
#1%
}}


Unfortunately, this is not expandable; from my understanding, any macro that itself uses assignments (including \let and \def) can never be expanded. In this case, I need to use the output of \StripControlSequences in something like the following:

\def\Def#1#2{\expandafter\def\csname\StripControlSequences{#1}\endcsname{#2}}


such that the command sequence could later be called, without the control sequences, like the following:

\Def{John Q. Author, \textit{Book Title}}{full citation string}

\begin{document}
\csname John Q. Author, Book Title\endcsname
\end{document}


which would produce a document with only:

full citation string


(of course, users of my macro package wouldn't call \csname ... \endcsname directly, but you get the point). In case anyone is wondering about the context, I have a macro package for producing automated legal citations, and given that my target audience is non-technical, I need to try to make the interface as simple as possible. (I'm happy to explain more about the broader context, if necessary).

I've hunted for a while for any good answers to this without luck; but I apologize if this has been asked before! I basically understand the problems with fragile/robust commands, but it seems to me that no combination of \protect, etc. will be applicable here, because \protect merely delays expansion until later execution, so as to allow its argument to be moved. On the other hand, here I basically want execution at all times.

So perhaps another way to ask this question is: is it possible to force execution, like an \edef that fully executes its argument, instead of merely expanding it?

-

I am pleased to be able to teach Martin Scharrer something he didn't know :)

# A fully expandable sanitizer

The following is an implementation of a \Sanitize command that:

• Completely removes all control sequences and balanced braces in its argument.

• Does not choke on nested braces.

• Keeps spaces where they were requested either by " " or "\ " (for after macros).

• Is fully expandable (i.e. can be put in \edef or \csname).

Edit: This is a revised version. My initial code had a few minor bugs that were a major pain to fix, and this is substantially rewritten. I think it's clearer, too.

## How it works

There are three states: sanitizing spaces, sanitizing groups, and sanitizing tokens. We scan for "words" one at a time, then within each "word" look for groups that might be hiding spaces (TeX's macro scanner will only absorb delimited arguments with balanced braces). Finally, once we are satisfied that we are looking at genuinely contiguous tokens, we scan one at a time and throw out the ones that are control sequences, leaving only explicitly specified spaces (" " or "\ ").

From the inside out, the operation looks like this:

• \SanitizeTokens is a big nested conditional that tests its argument against the various special cases. During the sweep for spaces, all space characters were converted to \SanitizedSpace tokens, and they are now converted to \RealSpaces. Both \SanitizedSpace and \SanitizeStop are macros that expand to themselves, and since they are private, this means that testing against them via \ifx is a reliable way to detect the exact control sequences (in the first version, these were \countdef tokens, which have the same property but are not quite as private).

• \SanitizeGroups uses the tricky \def\SanitizeGroups#1#{ construction discussed in this question: Macros with # as the last parameter. It is the most legitimate such use I can imagine: its point is to detect groups, which you can't do using plain macro expansion in any other way. It guarantees that #1 has no groups in it, and since this comes after space elimination, it also has no spaces in it, so we can run \SanitizeTokens straight away. We then "enter" the group and go back to eliminating spaces.

• \SanitizeSpaces uses pattern matching to grab the first chunk of text up until a space, excluding of course those spaces that are in groups. There is a technical trick here: every use of this macro has {} right after it, before the text. The point of that is so that the argument scanner doesn't remove braces around a group constituting an entire "word" between spaces. If that happens, then we will erroneously treat it as though it's been cleared of spaces when, in fact, it has not. (Any unsanitized spaces would be eaten by \SanitizeTokens because argument scanning ignores spaces.)

• There are of course some cute utility macros. My favorite is \IfNoGapToStop, which is called like this: \IfNoGapToStop.X. \SanitizeStop, with X being the quantity potentially containing a gap. If it has none, then the first gap is the visible space after the period; if it has a gap, then the two periods are in different components, and both arguments of \IfNoGapToStop are nonempty.

Aside from the structural changes from the previous version, this one correctly preserves spaces at the boundaries of groups. (That version didn't explicitly scan for groups, but eliminated them as a side effect of absorbing tokens. That works, but it also makes it impossible to be sure when you are looking at a group, which may have spaces, rather than a single token.)

Oh, and of course: the algorithm is no longer stupid. The last version rescanned the entire initial portion of the text repeatedly while looking for words (the point of that was so as not to "lose" those tokens before sanitizing them). Now I crawl through the words one at a time, so there's no problem with abandoning each one when looking for the next. That turns a quadratic algorithm into a linear one.

This is not my preferred way of writing TeX anymore (for that, you should read this answer: How to write readable commands) but pgfkeys is really not the tool for this kind of textual parsing.

\documentclass{article}

\makeatletter
\newcommand\Sanitize[1]{%
\SanitizeSpaces{}#1 \SanitizeStop
}

% This loops through and replaces all spaces (outside brace groups) with \SanitizedSpace's.
% Then it goes for the control sequences.
% All calls to this should put a {} right before the content, to inhibit the gobbling of braces
% if there is a group right at the beginning.
\def\SanitizeSpaces#1 #2\SanitizeStop{%
\IfEmpty{#2}% Last word
{\IfEmpty{#1}% No content at all
{}% Nothing to do
{\SanitizeGroups#1{\SanitizeStop}}%
}%
% No need for a trailing space anymore: there's already one from the initial call
{\SanitizeGroups#1\SanitizedSpace{\SanitizeStop}\SanitizeSpaces{}#2\SanitizeStop}%
}

% Sanitize tokens up to the next group, then go back to doing spaces.
\def\SanitizeGroups#1#{%
\SanitizeTokens#1\SanitizeStop
\EnterGroup
}

% Sanitize the next group from the top.
\newcommand\EnterGroup[1]{%
\ifx\SanitizeStop#1%
\expandafter\@gobble
\else
\expandafter\@firstofone
\fi
{\SanitizeSpaces{}#1 \SanitizeStop\SanitizeGroups}%
}

\newcommand\SanitizeTokens[1]{%
\ifx\SanitizeStop#1%
\else
\ifx\SanitizedSpace#1%
\RealSpace
\else
\ifx\ #1%
\RealSpace
\else
\if\relax\noexpand#1%
\else
#1%
\fi
\fi
\fi
\expandafter\SanitizeTokens
\fi
}

% We use TeX's proclivity to eat braces even for delimited arguments to eat the braces if #1
% happens to be just {}, which we put in.
% Even if we didn't put it in, {} is going to get thrown out when \SanitizeSpaces gets to it.
\newcommand\IfEmpty[1]{%
\IfOneTokenToStop.#1\SanitizeStop
{% #1 has at most space tokens
% and thus is nonempty if and only if there is a gap:
\IfNoGapToStop.#1. \SanitizeStop
}
{% #1 has non-space tokens
\@secondoftwo
}%
}

% Checks for a gap in #1, meaning #2 is nonempty
% This should only be used with \IfEmpty
\def\IfNoGapToStop#1 #2\SanitizeStop{%
% It's enough to check for one token, since #2 is never just spaces
\IfOneTokenToStop.#2\SanitizeStop
}

\def\IfOneTokenToStop#1#2{% From \IfEmpty, #1 is always a .
\ifx\SanitizeStop#2%
% If #2 is multi-token, the rest of it will fall in the one-token case and be passed over.
% If not, well, that's what we asked for.
\expandafter\@firstoftwo
\else
\expandafter\GobbleToStopAndSecond
\fi
}

\def\GobbleToStopAndSecond#1\SanitizeStop{%
\@secondoftwo
}
\makeatother

\def\SanitizeStop{\SanitizeStop}
\def\SanitizedSpace{\SanitizedSpace}
\def\RealSpace{ }

\begin{document}
\setlength\parindent{0pt}\tt

% Torture test
\edef\a{%
\Sanitize{ Word1 \macro{Word2 Word3}{\macro\ Word4}{ Word5} {Word6 }{}Word7{ }{{Word8}} }
}\meaning\a

\a
\medskip

% Examples
\edef\a{%
\Sanitize{\emph{This} sentence has \TeX\ macros and {grouping}. }
}\meaning\a

\a
\medskip

\edef\a{%
\Sanitize{{A}{ gratuitously {nested} sentence {}{{with many} layers}}.}
}\meaning\a

\a
\medskip

\end{document}

-
Very, very nice. I'd choose \count1 and \count2, because \c@page is \count0. –  egreg Nov 8 '11 at 7:50
@egreg: It pleases me to live on the edge :) Also, it just occurred to me that I could make these macros \def to themselves, which would serve the same purpose a little more efficiently. –  Ryan Reich Nov 8 '11 at 8:30
@egreg: Also, thank you. –  Ryan Reich Nov 8 '11 at 8:31
Wow, very thorough. Thanks! –  cdecoro Nov 11 '11 at 13:17
@Bruno: True. However, some things man was not meant to know; changing the brace characters is one of them. –  Ryan Reich Nov 17 '11 at 1:06
show 1 more comment

If your text contains only "safe" text (no accented characters) and a limited number of control sequences, known a priori, then

\makeatletter
\def\StripControlSequences#1{%
\begingroup
\let\textit\@firstofone
\let\textbf\@firstofone
\edef\x{\endgroup#1}\x}
\makeatother


Add other needed sequences if needed. If the possible control sequences are all of the "one argument" kind, this should do. Otherwise you'd need a check token by token.

However, if your context is not to print the argument, but rather define something based on it via \csname, then Martin's suggestion of \detokenize is good.

Some more context should be available, in order to suggest the best strategy. Probably some key may be more appropriate, as probably users are not supposed to type

\whatever{John Q. Author, \textit{Book Title}}


in order to get

 <full citation string>


in their printout: using this would fail if the argument to \whatever is not exactly as it appears.

-
Thanks. I do, in fact, want the user to omit the \textit{...}. Ordinarily, I would use a key as you suggest (that's what I've been doing until now). But while this would be perfectly sensible for us, lawyers seem to have trouble grasping the concept. –  cdecoro Nov 11 '11 at 13:23

The easier method is to use \detokenize:

\documentclass{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\makeatletter
\newcommand\removecs[1]{\expandafter\if@cs\detokenize{#1}\@nil{\expandafter\removecs@i\detokenize{#1}\@nil}{\detokenize{#1}}}
\begingroup
\catcode\|0 |catcode|\12
|catcode|<1 |catcode|>2
|catcode|{12 |catcode|}12
|gdef|if@firstisbrace#1<|if@firstisbrace@i#1{|@nil>
|gdef|if@firstisbrace@i#1{#2|@nil<|csname @|ifx|@empty#1|@empty first|else second|fi oftwo|endcsname>
|gdef|if@cs#1|@nil<|if@cs@i#1\|@nil>
|gdef|if@cs@i#1\#2|@nil<|csname @|ifx|@empty#2|@empty second|else first|fi oftwo|endcsname>
|gdef|remove@braces{#1}#2|@nil<|if@cs#1#2|@nil<|removecs@i#1#2|@nil><#1#2>>
|gdef|removecs@i#1\#2 #3|@nil<%
#1%
|if@firstisbrace<#3>
<|remove@braces#3|@nil>
<|if@cs#3|@nil<|removecs@i#3|@nil><#3>>%
>
|endgroup

\makeatother
\begin{document}
\removecs{abcd \textit{f\textbf{oo}bar} ijkl\foo{1}2\bar3{4}!}

\edef\foobar{\removecs{abcd \textit{f\textbf{oo}bar} ijkl\foo{1}2\bar3{4}!}}
\meaning\foobar
\end{document}

-
I'll give that a try, thanks. –  cdecoro Nov 11 '11 at 13:24

You could define one, but not in an expandable way (to my knowledge). You would need to read token for token (which requires unexpandable assignments) and then test if it is a control sequence and strip it. This would work even in your case if you can put the strip macro before the \csname and make it define the result into an expandable macro. However, the whole thing isn't that trivial.

An alternative would be to use e-TeX's \detokenize{..} to turn the control sequence into normal text which can be used inside \csname:

\csname\detokenize{#1}\endcsname


Here #1 can include macros which however are taken as part of the file name. If this isn't an issue I would go with this.

There is also a non e-TeX way:

\def\@tempa{#1}%
\@onelevel@sanitize\@tempa
\csname\@tempa\endcsname

-
Thanks for your response. However, I need the name to not include the inner macros. My goal is to have the user include the formatting once, and then on all subsequent invocations refer to the source without the formatting. –  cdecoro Nov 11 '11 at 13:19