% This is xtring_doc_fr.tex, the manual of xstring (in french)
% Christian Tellechea 2008
%
% email : unbonpetit@gmail.com
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
%
%     http://www.latex-project.org/lppl.txt
%
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
%
\documentclass[a4paper,10pt]{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[dvips,colorlinks=true,hyperfootnotes=false,citecolor=black,filecolor=black,linkcolor=blue,urlcolor=blue,bookmarks=false,pdfauthor={Christian TELLECHEA},pdftitle={xstring},pdfsubject={package pour la manipulation de chaines de caractères},pdfkeywords={xstring,latex,string,chaine de caractères},pdfcreator={LaTeX}]{hyperref}
\usepackage[a4paper,dvips,margin=2cm]{geometry}
\usepackage{amssymb}
\usepackage{moreverb}
\usepackage{lmodern}
\usepackage{eurosym}
\usepackage{xstring}
\usepackage[frenchb]{babel}
\makeatletter

\newcommand*\Exemple{\@ifstar{\def\frontiere{|}\@Ex}{\def\frontiere{}\@Ex}}
% la macro de Ulrich Diez
\newcommand*\@Ex{%
	\relax%
	\ifmmode\hbox\else\leavevmode\null\fi%
	\bgroup%
		\verb@eol@error%
		\let\do\@makeother\dospecials%
		\verbatim@font\@noligs%
		\@@Ex}
\newcommand*\@@Ex[1]{%
	\@vobeyspaces\frenchspacing\
	\catcode`#1\active%
	\lccode`\~`#1%
	\gdef\verb@balance@group{\@ehc}%
	\aftergroup\verb@balance@group%
		\lowercase{%
			\let ~\verb@egroup%
			\def\@tempa##1~{\hbox to \Partage\linewidth{\hfil##1~}\quad\scantokens{\frontiere##1\frontiere}\par}}%
	\@tempa}%
\makeatother
\newcommand\guill[1]{\og{}#1\fg{}}
\newcommand\argu[1]{$\langle$\textit{#1}$\rangle$}
\newcommand\ARGU[1]{\texttt{\{}\argu{#1}\texttt{\}}}
\newcommand\arguC[1]{\texttt{[}\argu{#1}\texttt{]}}
\newcommand\arguCC[2]{\texttt{[}\argu{#1}{,}\argu{#2}\texttt{]}}
\newcommand\texte[1]{\texttt{texte}${}_{#1}$}
\newcommand\voirdeftexte{~(voir \ref{deftexte})}
\newenvironment{Conditions}[1][1cm]%
{\begin{list}%
	{$\vartriangleright$}%
	{\setlength{\leftmargin}{#1}
	 \setlength{\itemsep}{0pt}
	 \setlength{\parsep}{0pt}
	 \setlength{\topsep}{2ptplus3ptminus2pt}
	}}%
{\end{list}}

\begin{document}
\gdef\Partage{0.7}
\begin{titlepage}
	\null\par\vfill
	\begin{center}
		\begin{minipage}{0.75\linewidth}
			\begin{center}
				\Huge\bfseries xstring\par\vspace{5pt}
				\small v1.0\par\vspace{25pt}
				\normalsize Manuel de l'utilisateur
			\end{center}
		\end{minipage}
	\end{center}
	\vspace{1cm}
	\begin{center}
		Christian {\sc Tellechea}\par\small
		\href{mailto:unbonpetit@gmail.com}{\nolinkurl{unbonpetit@gmail.com}}\par\vspace{5pt}
		5 juillet 2008
	\end{center}
	\vfill\hrulefill
	\begin{center}
		\begin{minipage}{0.85\linewidth}
			\noindent
			\hfill\textbf{\textit{Résumé}}\hfill{}\medskip\par
			Cette extension regroupe un ensemble de macros manipulant des chaînes de caractères :
			\setlength{\parindent}{1.5em}
			\begin{itemize}
				\item[$\triangleright$] des tests :
					\begin{itemize}
						\item une chaîne en contient elle une autre au moins $n$ fois ?
						\item une chaîne commence t-elle ou finit-elle par une autre ? etc.
					\end{itemize}
				\item[$\triangleright$] des extractions de chaînes :
					\begin{itemize}
						\item renvoi de ce qui se trouve avant (ou après) la $n$\ieme{} occurrence d'une sous-chaîne;
						\item renvoi de ce qui se trouve entre les occurrences de 2 sous-chaînes;
						\item sous-chaîne comprise entre 2 positions, etc.
					\end{itemize}
				\item[$\triangleright$] le remplacement de toutes ou des $n$ premières occurrences d'une sous-chaîne par une autre sous-chaîne;
				\item[$\triangleright$] des calculs de nombres :
					\begin{itemize}
						\item longueur d'une chaîne;
						\item position de la la $n$\ieme{} occurrence d'une sous-chaîne;
						\item comptage du nombre d'occurrences d'une sous-chaîne dans une autre.
					\end{itemize}
			\end{itemize}
			\medskip
			D'autres commandes permettent  de traiter les caractères spéciaux (\verb|&|, \verb|~|, \verb|\|, \verb|{|, \verb|}|, \verb|_|, \verb|#|, \verb|$|, \verb|^| et \verb|%|) de façon à les utiliser dans les arguments des macros de ce package, ce qui permet d'utiliser ces macros à fins de programmation.
		\end{minipage}
	\end{center}
	\hrulefill\vfill{}
\end{titlepage}
\pagebreak
\tableofcontents
\pagebreak

\section{Présentation}
\subsection{Description}
Cette extension regroupe des macros et des tests opérant sur des chaînes de caractères, un peu comme en disposent des langages dit \guill{évolués}. On y trouve les opérations habituelles sur les chaînes de caractères, comme par exemple : test si une chaîne en contient une autre, commence ou finit par une autre, extractions de sous-chaînes ou de caractères, calculs de position d'une sous-chaîne, calculs du nombre d'occurrences, etc.\medskip

Certes d'autres packages existent (par exemple \href{http://www.ctan.org/tex-archive/macros/latex/contrib/substr/}{\nolinkurl{substr}} et \href{http://www.ctan.org/tex-archive/macros/latex/contrib/stringstrings/}{\nolinkurl{stringstrings}}), mais outre des différences notables quant aux fonctionnalités, ils ne prennent pas en charge les occurrences des sous-chaînes et me semblent soit trop limités, soit trop difficiles à utiliser pour la programmation.

\subsection{Motivation}
J'ai été conduit à écrire ce type de macros car je n'ai jamais vraiment trouvé de d'outils sous \LaTeX{} adaptés à mes besoins concernant le traitement de chaînes de caractères. Alors, au fil des derniers mois, et avec l'aide de contributeurs\footnote{Je remercie chaleureusement Manuel alias \guill{\nolinkurl{mpg}} pour son aide précieuse, sa compétence et sa disponibilité.} de \nolinkurl{fr.comp.text.tex}, j'ai écrit quelques macros qui me servaient ponctuellement ou régulièrement. Leur nombre s'étant accru, et celles-ci devenant un peu trop dispersées dans les répertoires de mon ordinateur, je les ai regroupées dans ce package.

Ainsi, le fait de donner corps à un ensemble cohérent de macros force à davantage de rigueur et induit naturellement de nécessaires améliorations, ce qui a pris la majeure partie du temps que j'ai consacré à ce package. Pour harmoniser le tout, mais à contre-c\oe{}ur, j'ai fini par choisir des noms de macros à consonances anglo-saxonnes.\medskip

Ensuite, et ça a été ma principale motivation puisque j'ai découvert \LaTeX{} il y a moins d'un an, l'écriture de xstring qui est mon premier package m'a surtout permis de beaucoup progresser en programmation pure, et aborder des méthodes propres à la programmation sous \TeX.

\subsection{Fonctionnement}
\label{deftexte}
Dans la suite, on écrira \guill{\texte{10,11,12}} une suite de caractères dont les catcodes sont 10, 11 ou 12.
\subsubsection{Développement des arguments}
\label{devarg}
Tous les arguments des macros\footnote{À l'exeption des 2 derniers arguments des macros tests qui contiennent des séquences de contrôle à exécuter selon le résultat du test, ainsi qu'à l'exception de l'argument optionnel venant en dernière position.} manipulant des chaînes de caractères sont susceptibles de donner, à une certaine profondeur de développement du \texte{10,11,12}. Ainsi, \emph{par défaut}, pour éviter des chaines d'\verb|\expandafter| et faciliter l'usage des macros de ce package, tous les arguments sont développés au maximum avant d'être pris en compte par la macro appelée : pour cela, la commande \verb|\fullexpandarg| est appelée par défaut.\bigskip

Par exemple, si \verb|\macro| est une macro de ce package nécessitant un argument texte et un argument nombre obligatoires, les constructions suivantes sont équivalentes :\medskip

\begin{minipage}[t]{0.35\linewidth}
	Construction avec \verb|\fullexpandarg|\par\hrulefill\par
	\verb|\def\aa{du texte}|\par
	\verb|\def\nn{2}|\par
	\verb|\macro{\aa}{\nn}|
\end{minipage}
\hfill
\begin{minipage}[t]{0.6\linewidth}
	Construction habituelle sous \LaTeX{} ou  avec \verb|\normalexpandarg|\par\hrulefill\par
	\verb|\def\aa{du texte}|\par
	\verb|\def\nn{2}|\par
	\verb|\expandafter\expandafter\expandafter\macro|\par
	\verb| \expandafter\expandafter\expandafter|\par
	\verb|  {\expandafter\aa\expandafter}\expandafter{\nn}|
\end{minipage}\hfill{}\medskip

La construction de gauche permet de s'affranchir de l'ordre de développement des arguments et épargne à l'utilisateur des chaînes d'\verb|\expandafter|. En revanche, les arguments doivent être purement développables, et donner à leur développement maximum du \texte{10,11,12} contenant ce qui est attendu (nombre ou chaîne de caractères).\medskip

On peut cependant revenir à tout moment à l'ordre habituel de développement avec la commande\\\verb|\normalexpandarg|, et utiliser quand on le souhaite \verb|\fullexpandarg| qui est appelée par défaut pour basculer à nouveau vers le développement maximum des arguments.

\subsubsection{Arguments textuels}
Les macros de packages manipulant des chaînes de caractères, elles nécessitent un ou plusieurs arguments contenant du \texte{10,11,12}\voirdeftexte{}, en respectant la classique syntaxe entre accolades \verb|{|\texte{10,11,12}\verb|}| ou entre crochet pour les arguments optionnels \verb|[|\texte{10,11,12}\verb|]|.\medskip

Il convient de respecter les règles suivantes pour le développement des arguments textuels :
\begin{itemize}
	\item ils peuvent contenir des lettres (majuscules ou minuscules, accentuées\footnote{Pour pouvoir utiliser des lettres accentuées de façon fiable, il est nécessaire de charger le packages \texttt{\textbackslash fontenc} avec l'option \texttt{[T1]}, ainsi que \texttt{\textbackslash inputenc} avec l'option correspondant au codage du fichier tex} ou non), des chiffres et des espaces, ainsi que tout caractère de catcode 10, 11 ou 12 (signes de ponctuation, signes opératoires mathématiques, parenthèses, crochets, etc). Le signe \officialeuro, par contre, génèrera des erreurs.
	\item les espaces sont gérés et comptabilisés comme des caractères à part entière, à la condition qu'il ne se suivent pas, auquel cas, la règle \LaTeX{}ienne prévaut et plusieurs espaces consécutifs n'en font qu'un seul;
	\item aucun caractère spécial n'est accepté, c'est-à-dire que les 10 caractères suivants sont strictement interdits : \verb|&|, \verb|~|, \verb|\|, \verb|{|, \verb|}|, \verb|_|, \verb|#|, \verb|$|, \verb|^| et \verb|%|.
\end{itemize}\medskip

Pour contourner certaines de ces règles et aller plus loin dans les possibilités des macros pour les utiliser à des fins de programmation, il existe des macros spéciales qui permettent d'inclure dans des arguments textuels n'importe quel caractère spécial, c'est-à-dire un caractère dont le catcode est différent de 10, 11 ou 12, ainsi que des séquences de contrôle en contenant. Voir la description détaillée de ce mode de fonctionnement au chapitre \ref{programmation}, page~\pageref{programmation}.

\subsubsection{Développement des macros, argument optionnel}
Les macros de ce package ne sont pas purement développables et ne peuvent donc pas être mises dans l'argument d'un \verb|\edef|. Par conséquent, certaines constructions ne sont pas acceptées et conduisent à des erreurs lors de la compilation. Si par exemple, \verb|\commande{argument}| est une macro de ce package avec son argument, supposée renvoyer une chaîne de caractères, alors les constructions suivantes ne sont pas permises :\smallskip

\hspace{0.2\linewidth}\verb|\edef\Resultat{\commande{argument}}|\par
\qquad pas plus que\par
\hspace{0.2\linewidth}\verb|\commandeA{\commandeB{\commandeC{argument}}}|\smallskip

C'est pour cela que les macros renvoyant un résultat, c'est-à-dire toutes sauf les tests, sont dotées d'un argument optionnel venant en dernière position. Cet argument prend la forme de \arguC{nom}, où \argu{nom} est le nom d'une séquence de contrôle qui recevra (l'assignation se fait avec un \verb|\edef|) le résultat de la macro, ce qui fait que \verb|\|\argu{nom} est purement développable et peut donc se trouver dans l'argument d'un \verb|\edef|. Dans le cas de la présence d'un argument optionnel en dernière position, aucun affichage n'aura lieu. Cet argument optionnel, évidemment, n'est pas développé contrairement aux autres arguments. Il permet ainsi contourner les limitations évoquées dans les exemples ci dessus.\medskip

Ainsi cette construction non permise :\par
\hspace{0.2\linewidth}\verb|\edef\Resultat{\commande{arguments}}|\par
\qquad est équivalente à\par
\hspace{0.2\linewidth}\verb|\commande{argument}[\Resultat]|\medskip

Et cet autre construction non permise :\par
\hspace{0.2\linewidth}\verb|\commandeA{\commandeB{\commandeC{arguments}}}|\par
\qquad se comporte de même que\par
\hspace{0.2\linewidth}\verb|\commandeC{arguments}[\MaChaine]|\par
\hspace{0.2\linewidth}\verb|\commandeB{\MaChaine}[\MaChaine]|\par
\hspace{0.2\linewidth}\verb|\commandeA{\MaChaine}|\par

\section{Les macros}
\label{listemacros}
\subsection{Présentation des macros}
Dans ce chapitre, la totalité des macros est présentée selon ce plan :\smallskip

\begin{itemize}
	\item la syntaxe ainsi que la valeur d'éventuels arguments optionnels;
	\item une brève description du fonctionnement;
	\item le fonctionnement sous certaines conditions particulières. Pour chaque conditions envisagée, le fonctionnement décrit est prioritaire sur celui (ceux) se trouvant au dessous de lui;
	\item enfin, quelques exemples sont donnés. J'ai essayé de les trouver les plus facilement compréhensibles et les plus représentatifs des situations rencontrées dans une utilisation normale\footnote{Pour une collection plus importante d'exemples, on peut aussi consulter le fichier de test.}. Si un doute est possible quant à la présence d'espaces dans le résultat, celui-ci sera délimité par des \guill{|}, étant entendu qu'une chaîne vide est représentée par \guill{||}.
\end{itemize}\smallskip

\subsection{Les tests}
\subsubsection{IfSubStr}
\verb|\IfSubStr|\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\ARGU{vrai}\ARGU{faux}
\smallskip

L'argument optionnel \argu{nombre} vaut 1 par défaut.\par
\smallskip

Teste si \argu{chaine} contient au moins \argu{nombre} fois \argu{chaineA} et exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\medskip

\begin{Conditions}
	\item Si \argu{nombre}${}\leqslant0$,  exécute \argu{faux};
	\item Si \argu{chaine} ou \argu{chaineA} est vide, exécute \argu{faux}.
\end{Conditions}

\Exemple|\IfSubStr{xstring}{tri}{vrai}{faux}|
\Exemple|\IfSubStr{xstring}{a}{vrai}{faux}|
\Exemple|\IfSubStr{a bc def }{c d}{vrai}{faux}|
\Exemple|\IfSubStr{a bc def }{cd}{vrai}{faux}|
\Exemple|\IfSubStr[2]{1a2a3a}{a}{vrai}{faux}|
\Exemple|\IfSubStr[3]{1a2a3a}{a}{vrai}{faux}|
\Exemple|\IfSubStr[4]{1a2a3a}{a}{vrai}{faux}|

\subsubsection{IfSubStrBefore}
\verb|\IfSubStrBefore|\arguCC{nombre1}{nombre2}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}\ARGU{vrai}\ARGU{faux}
\smallskip

Les arguments optionnels \argu{nombre1} et \argu{nombre2} valent 1 par défaut.\par\smallskip

Dans \argu{chaine}, la macro teste si l'occurrence \no\argu{nombre1} de \argu{chaineA} se trouve à gauche de l'occurrence \no\argu{nombre2} de \argu{chaineB}. Exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\medskip

\begin{Conditions}
	\item Si l'une des occurrences n'est pas trouvée, exécute \argu{faux};
	\item Si l'un des arguments \argu{chaine}, \argu{chaineA} ou \argu{chaineB} est vide, exécute \argu{faux};
	\item Si l'un au moins des deux arguments optionnels est négatif ou nul, exécute \argu{faux}.
\end{Conditions}

\Exemple|\IfSubStrBefore{xstring}{st}{in}{vrai}{faux}|
\Exemple|\IfSubStrBefore{xstring}{ri}{s}{vrai}{faux}|
\Exemple|\IfSubStrBefore{LaTeX}{LaT}{TeX}{vrai}{faux}|
\Exemple|\IfSubStrBefore{a bc def }{ b}{ef}{vrai}{faux}|
\Exemple|\IfSubStrBefore{a bc def }{ab}{ef}{vrai}{faux}|
\Exemple|\IfSubStrBefore[2,1]{b1b2b3}{b}{2}{vrai}{faux}|
\Exemple|\IfSubStrBefore[3,1]{b1b2b3}{b}{2}{vrai}{faux}|
\Exemple|\IfSubStrBefore[2,2]{baobab}{a}{b}{vrai}{faux}|
\Exemple|\IfSubStrBefore[2,3]{baobab}{a}{b}{vrai}{faux}|

\subsubsection{IfSubStrBehind}
\verb|\IfSubStrBehind|\arguCC{nombre1}{nombre2}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}\ARGU{vrai}\ARGU{faux}
\smallskip

Les arguments optionnels \argu{nombre1} et \argu{nombre2} valent 1 par défaut.\par\smallskip

Dans \argu{chaine}, la macro teste si l'occurrence \no\argu{nombre1} de \argu{chaineA} se trouve après l'occurrence \\\no\argu{nombre2} de \argu{chaineB}. Exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\medskip

\begin{Conditions}
	\item Si l'une des occurrences n'est pas trouvée, exécute \argu{faux};
	\item Si l'un des arguments \argu{chaine}, \argu{chaineA} ou \argu{chaineB} est vide, exécute \argu{faux};
	\item Si l'un au moins des deux arguments optionnels est négatif ou nul, exécute \argu{faux}.
\end{Conditions}

\Exemple|\IfSubStrBehind{xstring}{ri}{xs}{vrai}{faux}|
\Exemple|\IfSubStrBehind{xstring}{s}{i}{vrai}{faux}|
\Exemple|\IfSubStrBehind{LaTeX}{TeX}{LaT}{vrai}{faux}|
\Exemple|\IfSubStrBehind{a bc def }{ d}{a}{vrai}{faux}|
\Exemple|\IfSubStrBehind{a bc def }{cd}{a b}{vrai}{faux}|
\Exemple|\IfSubStrBehind[2,1]{b1b2b3}{b}{2}{vrai}{faux}|
\Exemple|\IfSubStrBehind[3,1]{b1b2b3}{b}{2}{vrai}{faux}|
\Exemple|\IfSubStrBehind[2,2]{baobab}{b}{a}{vrai}{faux}|
\Exemple|\IfSubStrBehind[2,3]{baobab}{b}{a}{vrai}{faux}|

\subsubsection{IfBeginWith}

\verb|\IfBeginWith|\ARGU{chaine}\ARGU{chaineA}\ARGU{vrai}\ARGU{faux}
\smallskip

Teste si \argu{chaine} commence par \argu{chaineA}, et exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\medskip

\begin{Conditions}
\item Si \argu{chaine} ou \argu{chaineA} est vide, exécute \argu{faux}.
\end{Conditions}

\Exemple|\IfBeginWith{xstring}{xst}{vrai}{faux}|
\Exemple|\IfBeginWith{LaTeX}{a}{vrai}{faux}|
\Exemple|\IfBeginWith{a bc def }{a b}{vrai}{faux}|
\Exemple|\IfBeginWith{a bc def }{ab}{vrai}{faux}|

\subsubsection{IfEndWith}

\verb|\IfEndWith|\ARGU{chaine}\ARGU{chaineA}\ARGU{vrai}\ARGU{faux}
\smallskip

Teste si \argu{chaine} se termine par \argu{chaineA}, et exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\medskip

\begin{Conditions}
	\item Si \argu{chaine} ou \argu{chaineA} est vide, exécute \argu{faux}.
\end{Conditions}

\Exemple|\IfEndWith{xstring}{ring}{vrai}{faux}|
\Exemple|\IfEndWith{LaTeX}{a}{vrai}{faux}|
\Exemple|\IfEndWith{a bc def }{ef }{vrai}{faux}|
\Exemple|\IfEndWith{a bc def }{ef}{vrai}{faux}|

\subsection{Les macros renvoyant une chaîne}
\subsubsection{StrBefore}
\verb|\StrBefore|\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
\smallskip

L'argument optionnel \argu{nombre} vaut 1 par défaut.\par\smallskip

Dans \argu{chaine}, renvoie ce qui se trouve avant l'occurrence \no\argu{nombre} de \argu{chaineA}.\medskip

\begin{Conditions}
	\item Si \argu{chaine} ou \argu{chaineA} est vide, une chaîne vide est renvoyée;
	\item Si \argu{nombre}${}<1$ alors, la macro se comporte comme si \argu{nombre}${}=1$;
	\item Si l'occurrence n'est pas trouvée, une chaîne vide est renvoyée.
\end{Conditions}

\Exemple*|\StrBefore{xstring}{tri}|
\Exemple*|\StrBefore{LaTeX}{e}|
\Exemple*|\StrBefore{LaTeX}{p}|
\Exemple*|\StrBefore{LaTeX}{L}|
\Exemple*|\StrBefore{a bc def }{def}|
\Exemple*|\StrBefore{a bc def }{cd}|
\Exemple*|\StrBefore[1]{1b2b3}{b}|
\Exemple*|\StrBefore[2]{1b2b3}{b}|

\subsubsection{StrBehind}
\verb|\StrBehind|\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
\smallskip

L'argument optionnel \argu{nombre} vaut 1 par défaut.\par\smallskip

Dans \argu{chaine}, renvoie ce qui se trouve après l'occurrence \no\argu{nombre} de \argu{chaineA}.\medskip

\begin{Conditions}
	\item Si \argu{chaine} ou \argu{chaineA} est vide, une chaîne vide est renvoyée;
	\item Si \argu{nombre}${}<1$ alors, la macro se comporte comme si \argu{nombre}${}=1$;
	\item Si l'occurrence n'est pas trouvée, une chaîne vide est renvoyée.
\end{Conditions}

\Exemple*|\StrBehind{xstring}{tri}|
\Exemple*|\StrBehind{LaTeX}{e}|
\Exemple*|\StrBehind{LaTeX}{p}|
\Exemple*|\StrBehind{LaTeX}{X}|
\Exemple*|\StrBehind{a bc def }{bc}|
\Exemple*|\StrBehind{a bc def }{cd}|
\Exemple*|\StrBehind[1]{1b2b3}{b}|
\Exemple*|\StrBehind[2]{1b2b3}{b}|
\Exemple*|\StrBehind[3]{1b2b3}{b}|

\subsubsection{StrBetween}
\verb|\StrBetween|\arguCC{nombre1}{nombre2}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}\arguC{nom}
\smallskip

Les arguments optionnels \argu{nombre1} et \argu{nombre2} valent 1 par défaut.\par\smallskip

Dans \argu{chaine}, renvoie ce qui se trouve entre\footnote{Au sens strict, c'est-à-dire \emph{sans} les chaînes frontière} les occurrences \no\argu{nombre1} de \argu{chaineA} et \no \argu{nombre2} de \argu{chaineB}.
\medskip

\begin{Conditions}
	\item Si les occurrences ne sont pas dans l'ordre (\argu{chaineA} \emph{puis} \argu{chaineB}) dans \argu{chaine}, une chaîne vide est renvoyée;
	\item Si l'une des 2 occurrences n'existe pas dans \argu{chaine}, une chaîne vide est renvoyée;
	\item Si l'un des arguments optionnels \argu{nombre1} ou \argu{nombre2} est négatif ou nul, une chaîne vide est renvoyée.
\end{Conditions}

\Exemple*|\StrBetween{xstring}{xs}{ng}|
\Exemple*|\StrBetween{xstring}{i}{n}|
\Exemple*|\StrBetween{xstring}{a}{tring}|
\Exemple*|\StrBetween{a bc def }{a}{d}|
\Exemple*|\StrBetween{a bc def }{a }{f}|
\Exemple*|\StrBetween{a1b1a2b2a3b3}{a}{b}|
\Exemple*|\StrBetween[2,3]{a1b1a2b2a3b3}{a}{b}|
\Exemple*|\StrBetween[1,3]{a1b1a2b2a3b3}{a}{b}|
\Exemple*|\StrBetween[3,1]{a1b1a2b2a3b3}{a}{b}|
\Exemple*|\StrBetween[3,2]{abracadabra}{a}{bra}|

\subsubsection{StrSubstitute}
\verb|\StrSubstitute|\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}\arguC{nom}
\smallskip

L'argument optionnel \argu{nombre} vaut 0 par défaut.\par\smallskip

Dans \argu{chaine}, la macro remplace les \argu{nombre} premières occurrences de \argu{chaineA} par \argu{chaineB}, sauf si \argu{nombre}${}=0$ auquel cas, \emph{toutes} les occurrences sont remplacées.

\begin{Conditions}
	\item Si \argu{chaine} est vide, une chaîne vide est renvoyée;
	\item Si \argu{chaineA} est vide ou n'existe pas dans \argu{chaine}, la macro est sans effet;
	\item Si \argu{nombre} est supérieur au nombre d'occurrences de \argu{chaineA}, alors toutes les occurrences sont remplacées;
	\item Si \argu{nombre}${}<0$ alors la macro se comporte comme si \argu{nombre}${}=0$;
	\item Si \argu{chaineB} est vide, alors les occurrences de \argu{chaineA}, si elles existent, sont supprimées.
\end{Conditions}

\Exemple|\StrSubstitute{xstring}{i}{a}|
\Exemple|\StrSubstitute{abracadabra}{a}{o}|
\Exemple|\StrSubstitute{abracadabra}{br}{TeX}|
\Exemple|\StrSubstitute{LaTeX}{m}{n}|
\Exemple|\StrSubstitute{a bc def }{ }{M}|
\Exemple|\StrSubstitute{a bc def }{ab}{AB}|
\Exemple|\StrSubstitute[1]{a1a2a3}{a}{B}|
\Exemple|\StrSubstitute[2]{a1a2a3}{a}{B}|
\Exemple|\StrSubstitute[3]{a1a2a3}{a}{B}|
\Exemple|\StrSubstitute[4]{a1a2a3}{a}{B}|

\subsubsection{StrDel}
\verb|\StrDel|\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
\smallskip

L'argument optionnel \argu{nombre} vaut 0 par défaut.\par\smallskip

Supprime les \argu{nombre} premières occurrences de \argu{chaineA} dans \argu{chaine}, sauf si \argu{nombre}${}=0$ auquel cas, \emph{toutes} les occurrences sont supprimées.\medskip

\begin{Conditions}
	\item Si \argu{chaine} est vide, une chaîne vide est renvoyée;
	\item Si \argu{chaineA} est vide ou n'existe pas dans \argu{chaine}, la macro est sans effet;
	\item Si \argu{nombre} est supérieur au nombre d'occurrences de \argu{chaineA}, alors toutes les occurrences sont supprimées;
	\item Si \argu{nombre}${}<0$ alors la macro se comporte comme si \argu{nombre}${}=0$;
\end{Conditions}

\Exemple|\StrDel{abracadabra}{a}|
\Exemple|\StrDel[1]{abracadabra}{a}|
\Exemple|\StrDel[4]{abracadabra}{a}|
\Exemple|\StrDel[9]{abracadabra}{a}|
\Exemple|\StrDel{a bc def }{ }|
\Exemple*|\StrDel{a bc def }{def}|


\subsubsection{StrGobbleLeft}
\verb|\StrGobbleLeft|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip

Dans \argu{chaine}, enlève les \argu{nombre} premiers caractères de gauche.\medskip

\begin{Conditions}
	\item Si \argu{chaine} est vide, renvoie une chaîne vide;
	\item Si \argu{nombre}${}\leqslant0$, aucun caractère n'est supprimé.
	\item Si \argu{nombre}${}\geqslant{}$\argu{longueurChaine}, tous les caractères sont supprimés.
\end{Conditions}

\Exemple*|\StrGobbleLeft{xstring}{2}|
\Exemple*|\StrGobbleLeft{xstring}{9}|
\Exemple*|\StrGobbleLeft{LaTeX}{4}|
\Exemple*|\StrGobbleLeft{LaTeX}{-2}|
\Exemple*|\StrGobbleLeft{a bc def }{4}|

\subsubsection{StrLeft}
\verb|\StrLeft|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip

Dans \argu{chaine}, renvoie la sous-chaîne de gauche de longueur \argu{nombre}.\medskip

\begin{Conditions}
	\item Si \argu{chaine} est vide, renvoie une chaîne vide;
	\item Si \argu{nombre}${}\leqslant0$, aucun caractère n'est retourné.
	\item Si \argu{nombre}${}\geqslant{}$\argu{longueurChaine}, tous les caractères sont retournés.
\end{Conditions}

\Exemple*|\StrLeft{xstring}{2}|
\Exemple*|\StrLeft{xstring}{9}|
\Exemple*|\StrLeft{LaTeX}{4}|
\Exemple*|\StrLeft{LaTeX}{-2}|
\Exemple*|\StrLeft{a bc def }{5}|

\subsubsection{StrGobbleRight}
\verb|\StrGobbleRight|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip

Agit comme \verb|\StrGobbleLeft|, mais enlève les caractères à droite de \argu{chaine}.

\Exemple*|\StrGobbleRight{xstring}{2}|
\Exemple*|\StrGobbleRight{xstring}{9}|
\Exemple*|\StrGobbleRight{LaTeX}{4}|
\Exemple*|\StrGobbleRight{LaTeX}{-2}|
\Exemple*|\StrGobbleRight{a bc def }{4}|

\subsubsection{StrRight}
\verb|\StrRight|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip

Agit comme \verb|\StrLeft|, mais renvoie les caractères à la droite de \argu{chaine}.

\Exemple*|\StrRight{xstring}{2}|
\Exemple*|\StrRight{xstring}{9}|
\Exemple*|\StrRight{LaTeX}{4}|
\Exemple*|\StrRight{LaTeX}{-2}|
\Exemple*|\StrRight{a bc def }{5}|

\subsubsection{StrChar}
\verb|\StrChar|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip

Renvoie le caractère à la position \argu{nombre} dans la chaîne \argu{chaine}.\medskip

\begin{Conditions}
	\item Si \argu{chaine} est vide, aucun caractère n'est renvoyé;
	\item Si \argu{nombre}${}\leqslant0$ ou si \argu{nombre}${}>{}$\argu{longueurChaine}, aucun caractère n'est renvoyé.
\end{Conditions}

\Exemple|\StrChar{xstring}{4}|
\Exemple*|\StrChar{xstring}{9}|
\Exemple*|\StrChar{xstring}{-5}|
\Exemple|\StrChar{a bc def }{6}|

\subsubsection{StrMid}
\verb|\StrMid|\ARGU{chaine}\ARGU{nombreA}\ARGU{nombreB}\arguC{nom}
\smallskip

Dans \argu{chaine}, renvoie la sous chaîne se trouvant entre\footnote{Au sens large, c'est-à-dire que les chaînes \guill{frontière} sont renvoyés.} les positions \argu{nombreA} et \argu{nombreB}.\medskip

\begin{Conditions}
	\item Si \argu{chaine} est vide, une chaîne vide est renvoyée;
	\item Si \argu{nombreA}${}>{}$\argu{nombreB}, alors rien n'est renvoyé;
	\item Si \argu{nombreA}${}<1$ et \argu{nombreB}${}<1$ alors rien n'est renvoyé;
	\item Si \argu{nombreA}${}>{}$\argu{longueurChaine} et \argu{nombreB}${}>{}$\argu{longueurChaine}, alors rien n'est renvoyé;
	\item Si \argu{nombreA}${}<1$, alors la macro se comporte comme si \argu{nombreA}${}=1$;
	\item Si \argu{nombreB}${}>{}$\argu{longueurChaine}, alors la macro se comporte comme si \argu{nombreB}${}={}$\argu{longueurChaine}.
\end{Conditions}

\Exemple|\StrMid{xstring}{2}{5}|
\Exemple|\StrMid{xstring}{-4}{2}|
\Exemple*|\StrMid{xstring}{5}{1}|
\Exemple|\StrMid{xstring}{6}{15}|
\Exemple|\StrMid{xstring}{3}{3}|
\Exemple*|\StrMid{a bc def }{2}{7}|


\subsection{Les macros renvoyant des nombres}
\subsubsection{StrLen}
\verb|\StrLen|\ARGU{chaine}\arguC{nom}
\smallskip

Renvoie la longueur de \argu{chaine}.

\Exemple|\StrLen{xstring}|
\Exemple|\StrLen{A}|
\Exemple|\StrLen{a bc def }|

\subsubsection{StrCount}
\verb|\StrCount|\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
\smallskip

Compte combien de fois \argu{chaineA} est contenue dans \argu{chaine}.\par\medskip

\begin{Conditions}
	\item Si l'un au moins des arguments \argu{chaine} ou \argu{chaineA} est vide, la macro renvoie 0.
\end{Conditions}

\Exemple|\StrCount{abracadabra}{a}|
\Exemple|\StrCount{abracadabra}{bra}|
\Exemple|\StrCount{abracadabra}{tic}|
\Exemple|\StrCount{aaaaaa}{aa}|

\subsubsection{StrPosition}
\verb|\StrPosition|\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
\smallskip

L'argument optionnel \argu{nombre} vaut 1 par défaut.\par\smallskip

Dans \argu{chaine}, renvoie la position de l'occurrence \no\argu{nombre} de \argu{chaineA}.\medskip

\begin{Conditions}
	\item Si \argu{nombre} est supérieur au nombre d'occurrences de \argu{chaineA}, alors la macro renvoie 0.
	\item Si \argu{chaine} ne contient pas \argu{chaineA}, alors la macro renvoie 0.
\end{Conditions}
\medskip

\Exemple|\StrPosition{xstring}{ring}|
\Exemple|\StrPosition[4]{abracadabra}{a}|
\Exemple|\StrPosition[2]{abracadabra}{bra}|
\Exemple|\StrPosition[9]{abracadabra}{a}|
\Exemple|\StrPosition{abracadabra}{z}|
\Exemple|\StrPosition{a bc def }{d}|
\Exemple|\StrPosition[3]{aaaaaa}{aa}|

\section{Utilisation des macros à des fins de programmation}
\label{programmation}
\subsection{Verbatimiser vers une séquence de contrôle}
La macro \verb|\verbtocs| permet le lire le contenu d'un argument \guill{verb} qui peut contenir les caractères spéciaux : \verb|&|, \verb|~|, \verb|\|, \verb|{|, \verb|}|, \verb|_|, \verb|#|, \verb|$|, \verb|^| et \verb|%|. Les caractères \guill{normaux} gardent leur catcodes naturels, sauf les caractères spéciaux qui prennent un catcode de 12. Ensuite, ces caractères sont assignés à une séquence de contrôle. La syntaxe complète est :\medskip

\hfill\verb|\verbtocs|\ARGU{nom}|\argu{caractères}|\hfill{}
\smallskip

\argu{nom} est le nom d'une séquence de contrôle qui recevra à l'aide d'un \verb|\edef| les \argu{caractères} dont les caractères spéciaux auront reçu un catcode de 12. \argu{nom} contiendra donc du \texte{10,11,12}\voirdeftexte.\medskip

Par défaut, le caractère délimitant le contenu verb est \guill{|}, étant entendu que ce caractère ne peut être à la fois le délimiteur et être contenu dans ce qu'il délimite. Au cas où on voudrait \guill{verbatimiser} des caractères contenant \guill{|}, on peut changer à tout moment le caractère délimitant le contenu verb par la macro :\par\medskip
\hfill\verb|\setverbdelim|\ARGU{caractère}\hfill{}\smallskip

Tout \argu{caractère} ayant un catcode de 11 ou 12 peut être utilisé\footnote{Plusieurs caractères peuvent être utilisés au risque d'alourdir la syntaxe de \texttt{\textbackslash verbtocs} ! Pour cette raison, avertissement sera émis si l'argument de \texttt{\textbackslash setverbdelim} contient plusieurs caractères.}. Par exemple, après \verb|\setverbdelim{=}|, un argument textuel verb aura cette syntaxe \verb|=|\argu{caractères}\verb|=|.\medskip

Concernant ces arguments verb, il faut tenir compte des deux points suivants :
\begin{itemize}
	\item tous les caractères se trouvant avant |\argu{caractères}| seront ignorés;
	\item à l'intérieur de l'argument textuel verb, tous les espaces sont comptabilisés même s'ils sont consécutifs.
\end{itemize}
\medskip

Exemple :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\verbtocs{\resultat}  |a   & b{ c% d$ e \f|
		\resultat
	\end{boxedverbatim}
	\hspace*{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\verbtocs{\resultat}  |a   & b{ c% d$ e \f|
	\resultat
\end{minipage}

\subsection{Tokenisation d'un texte vers une séquence de contrôle}
Le processus inverse de ce qui a été vu au dessus consiste à transformer un \texte{10,11,12} en séquences de contrôle. Pour cela, on dispose de la macro :\medskip

\hfill\verb|\tokenize|\ARGU{nom}\ARGU{séquence de contrôle}\hfill{}
\smallskip

\argu{séquence de contrôle} est développée le plus possible si l'on a invoqué \verb|\fullexpandarg| (voir page~\pageref{devarg}); elle subit un 1-développement si l'on invoque \verb|\normalexpandarg|. Dans les deux cas, le développement doit donner du \texte{10,11,12}. Ensuite, ce \texte{10,11,12} est transformé en tokens puis assigné à l 'aide d'un \verb|\def| à la séquence de contrôle \argu{nom}.\medskip

Exemple :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\verbtocs{\text}|\textbf{a} $\frac{1}{2}$|
		texte : \text
		\tokenize{\resultat}{\text}
		\par
		résultat : \resultat
	\end{boxedverbatim}
	\hspace*{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\raggedright
	\verbtocs{\text}
	  |\textbf{a} $\frac{1}{2}$|
	texte : \text
	\tokenize{\resultat}{\text}
	\par
	résultat : \resultat
\end{minipage}
\medskip

Il est bien évident à la dernière ligne, que l'appel à la séquence de contrôle \verb|\resultat| est ici possible puisque les séquences de contrôle qu'elle contient sont définies.\medskip

\subsection{Développement d'une séquence de contrôle avant une conversion en verb}
\subsubsection{La macro scancs}
On peut souhaiter développer une séquence de contrôle avant de convertir ce développement en texte. Pour cela existe la macro :\medskip

\hfill\verb|\scancs|\arguC{nombre}\ARGU{nom}\ARGU{séquence de contrôle}\hfill{}
\smallskip

Le \argu{nombre} vaut 1 par défaut et représente la profondeur à laquelle va être développée la \argu{séquence de contrôle} avant d'être transformée en caractères de catcode 12 (ou 10 pour l'espace) puis assignée à la séquence de contrôle \argu{nom} qui contiendra donc du \texte{10,12}\voirdeftexte.

\subsubsection{Attention aux catcodes !}
Prenons un cas simple où la \argu{séquence de contrôle} se développe en texte, comme dans l'exemple suivant :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\def\test{a b1 d}
		\scancs{\resultat}{\test}
		\resultat
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\def\test{a b1 d}
	\scancs{\resultat}{\test}
	\resultat
\end{minipage}
\medskip

Mais attention au catcodes !

Dans l'exemple précédent, \verb|\scancs{\resultat}{\test}| n'est pas équivalent à \verb|\edef\resultat{\test}|.\medskip

En effet, dans le 1\ier{} cas avec \verb|\scancs{\resultat}{\test}|, \verb|\resultat| contient du \texte{10,12} (des caractères de catcode 12 et des espaces de catcode 10) et se développe en :\par
\hfill\verb|a|${}_{12}$\ \verb*| |${}_{10}$\ \verb|b|${}_{12}$\ \verb|1|${}_{12}$\ \verb*| |${}_{10}$\ \verb|d|${}_{12}$\hfill{}
\medskip

Dans le le second cas avec \verb|\edef\resultat{\test}|, \verb|\resultat| contient des caractères de catcode 11 (les lettres), un caractère de catcode 12 (le chiffre 1) et des espaces de catcode 10, et se développe en :\par
\hfill\verb|a|${}_{11}$\ \verb*| |${}_{10}$\ \verb|b|${}_{11}$\ \verb|1|${}_{12}$\ \verb*| |${}_{10}$\ \verb|d|${}_{11}$\hfill{}

\subsubsection{Profondeur de développement}
Si cela s'avère nécessaire, on peut aussi contrôler la profondeur de développement avec l'argument optionnel. Ainsi, dans l'exemple suivant, au 1\ier{} appel de \verb|\scancs|, la séquence de contrôle \verb|\c| subit un 3-developpement qui donne \og{}\verb|1|${}_{12}$\ \verb*| |${}_{10}$\ \verb|z|${}_{11}$\ \verb*| |${}_{10}$\ \verb|3|${}_{12}$\fg{} qui est transformé en \og{}\verb|1|${}_{12}$\ \verb*| |${}_{10}$\ \verb|z|${}_{12}$\ \verb*| |${}_{10}$\ \verb|3|${}_{12}$\fg{}.\smallskip

Par contre, si le $n$-développement donne une séquence de contrôle, alors cette séquence de contrôle est transformée en caractères de catcode 12. Ainsi, au 2\ieme{} appel de \verb|\scancs|, la ligne \verb|\scancs[2]{\resultat}{\c}| procède au 2-développement de la séquence de contrôle \verb|\c| qui donne la séquence de contrôle \fbox{\texttt{\textbackslash a}} qui est transformée en \og{}\verb|\|${}_{12}$~\verb|a|${}_{12}$\fg{}.

L'exemple montre toutes les profondeurs de développement jusqu'à la profondeur 0 :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\def\a{1 z 3}
		\def\b{\a}
		\def\c{\b}
		\scancs[3]{\resultat}{\c}
		\resultat\par
		\scancs[2]{\resultat}{\c}
		\resultat\par
		\scancs[1]{\resultat}{\c}
		\resultat\par
		\scancs[0]{\resultat}{\c}
		\resultat
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\def\a{1 z 3}
	\def\b{\a}
	\def\c{\b}
	\scancs[3]{\resultat}{\c}
	\resultat\par
	\scancs[2]{\resultat}{\c}
	\resultat\par
	\scancs[1]{\resultat}{\c}
	\resultat\par
	\scancs[0]{\resultat}{\c}
	\resultat
\end{minipage}
\medskip

Il est bien évident qu'il faut s'assurer que le développement à la profondeur souhaitée soit possible, sous peine d'erreur à la compilation.\medskip

\subsubsection{Développement de plusieurs séquences de contrôle}
En toute rigueur, le 3\ieme{} argument \argu{séquence de contrôle} (ou l'un de ses développements) doit contenir une seule et unique séquence de contrôle qui elle seule sera développée. Si ce 3\ieme{} argument ou l'un ses développements contient plusieurs séquences de contrôle, la compilation s'arrête avec un message d'erreur invitant à utiliser la version étoilée. La macro étoilée, d'utilisation plus délicate et qu'il convient donc d'utiliser avec attention, permet en effet de développer \emph{toutes} les séquences de contrôle contenues dans le 3\ieme{} argument à la profondeur spécifiée dans le 1\ier{} argument. Voyons cela sur un exemple :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\def\a{LaTeX}
		\def\b{est puissant}
		\scancs*[1]{\resultat}{\a \b}
		\resultat\par
		\scancs*[2]{\resultat}{\a\space\b}
		\resultat
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\def\a{LaTeX}
	\def\b{est puissant}
	\scancs*[1]{\resultat}{\a \b}
	\resultat\par
	\scancs*[2]{\resultat}{\a\space\b}
	\resultat
\end{minipage}
\medskip

Tout d'abord, un message d'attention a été généré à la compilation. Voyons sa signification\ldots\medskip

En premier lieu, on constate qu'il manque une espace entre les mots \guill{LaTeX} et \guill{est}, bien qu'une espace ait été insérée entre les 2 séquences de contrôles \verb|\a| et \verb|\b|. Cela est dû à ce que, lors de la lecture de l'argument, \TeX{} ignore les espaces situées après les séquences de contrôle. Et donc, \verb|{\a \b}| est assimilé à \verb|{\a\b}|, quelque soit le nombre d'espaces insérées entre \verb|\a| et \verb|\b|. Pour avoir notre espace entre \guill{LaTeX} et \guill{est}, on aurait pu utiliser la séquence de contrôle \verb|\space| qui se développe en une espace, et écrire comme 3\ieme{} argument : \verb|{\a\space\b}|. On aurait aussi pu insérer une espace à la fin de la définition de \verb|\a| et écrire \verb|\def\a{LaTeX }|.\medskip

Ensuite, il convient cependant de faire attention lorsqu'on utilise des profondeurs de développement supérieures à 1 : si une séquence de contrôle se $n$-développe en du \texte{10,11,12}, au développement suivant, les espaces seront avalées à la lecture. On le voit dans après la ligne \verb|\scancs*[2]{\result}{\a\space\b}| où \verb|\resultat| contient \guill{LaTeXestpuissant} où tous les espaces ont été mangés lors du 2-développement!\medskip

De plus, et c'est aussi le sens du message d'avertissement généré par la version étoilée, il faut savoir que si le $n$-développement contient des accolades, celles-ci, tout comme les espaces, seront supprimées au développement suivant.\medskip

Enfin, lors de l'utilisation de \verb|\scancs|, une espace est insérée après chaque séquence de contrôle. En effet, la primitive \verb|\detokenize| de $\varepsilon$-\TeX{} qui a été utilisée ici, insère une espace apès chaque séquence de contrôle. Il n'y a pas moyen de l'éviter.\medskip

\subsubsection{Exemples}
Dans l'exemple suivant, les séquences de contrôle subissent un 2-développement. \verb|\d| donne donc \verb|\b|, et \verb|\b| donne \verb|\textbf{a}\textit{b}|, et on constate bien qu'une espace est insérée après chaque séquence de contrôle. \par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\def\a{\textbf{a}\textit{b}}
		\def\b{\a}
		\def\c{\b}
		\def\d{\c}
		\scancs*[2]{\resultat}{\d\b}
		\resultat
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\def\a{\textbf{a}\textit{b}}
	\def\b{\a}
	\def\c{\b}
	\def\d{\c}
	\scancs*[2]{\resultat}{\d\b}
	\resultat
\end{minipage}
\medskip

Voici un exemple illustrant la perte des accolades au développement suivant :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\def\a{1{2}}
		\def\b{\a}
		\scancs*[1]{\resultat}{\b{A}}
		\resultat\par
		\scancs*[2]{\resultat}{\b{A}}
		\resultat\par
		\scancs*[3]{\resultat}{\b{A}}
		\resultat\par
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
		\def\a{1{2}}
		\def\b{\a}
		\scancs*[1]{\resultat}{\b{A}}
		\resultat\par
		\scancs*[2]{\resultat}{\b{A}}
		\resultat\par
		\scancs*[3]{\resultat}{\b{A}}
		\resultat\par
\end{minipage}
\medskip

Enfin, voici un dernier exemple où l'on met à profit l'espace inséré après chaque séquence de contrôle par \verb|\scancs| pour trouver la $n$\ieme{} séquence de contrôle dans le développement d'une séquence de contrôle.

Dans l'exemple ci-dessous, on cherchera la 4\ieme{} séquence de contrôle dans \verb|\myCS| qui contient :\par\medskip
\hfill\verb|\a xy{3 2}\b7\c123 {m}\d{8}\e|\hfill{}
\medskip

On cherche bien évidemment à obtenir \verb|\d| !\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\verbtocs{\antislash}|\|
		\newcommand\findcs[2]{%
		 \scancs[1]{\theCS}{#2}%
		 \tokenize{\theCS}{\theCS}%
		 \scancs[1]{\theCS}{\theCS}%
		 \StrBehind[#1]{\theCS}{\antislash}[\theCS]%
		 \StrBefore{\theCS}{ }[\theCS]%
		 \edef\theCS{\antislash\theCS}}
		\verbtocs{\myCS}|\a xy{3 2}\b7\c123 {m}\d{8}\e|
		% ici, \myCS contient du texte
		\findcs{4}{\myCS}
		\theCS\par
		\def\myCS{\a xy{3 2}\b7\c123 {m}\d{8}\e}
		% ici, \myCS contient des séquences de contrôle
		\findcs{4}{\myCS}
		\theCS
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\verbtocs{\antislash}|\|
	\newcommand\findcs[2]{%
		\scancs[1]{\theCS}{#2}%
		\tokenize{\theCS}{\theCS}%
		\scancs[1]{\theCS}{\theCS}%
		\StrBehind[#1]{\theCS}{\antislash}[\theCS]%
		\StrBefore{\theCS}{ }[\theCS]%
		\edef\theCS{\antislash\theCS}}
	\verbtocs{\myCS}|\a xy{3 2}\b7\c123 {m}\d{8}\e|
	% ici, \myCS contient du texte
	\findcs{4}{\myCS}
	\theCS\par
	\def\myCS{\a xy{3 2}\b7\c123 {m}\d{8}\e}
	% ici, \myCS contient des séquences de contrôle
	\findcs{4}{\myCS}
	\theCS
\end{minipage}
\medskip

Au début de la macro \verb|\findcs|, les appels successifs à \verb|\tokenize| puis une deuxième fois à \verb|\scancs| sont nécessaires pour que la macro fonctionne dans le cas où l'argument est une séquence de contrôle se développant en du \texte{10,11,12} : de cette façon en \guill{tokenisant} puis \guill{detokenisant}, des espaces seront bien insérés après chaque séquence de contrôle.

\subsection{À l'interieur d'une définition de macro}
Certaines difficultés surviennent lorsque l'on se trouve à l'intérieur de la définition d'une macro, c'est-à-dire entre les accolades suivant un \verb|\def\macro| ou un \verb|\newcommand\macro|.\medskip

Pour les mêmes raison qu'il est interdit d'employer la commande \verb|\verb| à l'intérieur de la définition d'une macro, les arguments textuels verb du type |\argu{caractères}| sont également interdits. Il faut donc observer la règle suivante :\par\medskip
\hfill \textbf{Ne pas utiliser d'argument textuel verb \og{}|\argu{texte}|\fg{} à l'intérieur de la définition d'une macro}.\hfill{}\medskip

Par conséquent, la macro \verb|\verbtocs| est interdite à l'intérieur de la définition d'une macro.\bigskip

Mais alors, comment faire pour manipuler des arguments textuels verb et \guill{verbatimiser} dans les définitions de macro ?\bigskip

Il y a la primitive \verb|\detokenize| de $\varepsilon$-\TeX, mais elle comporte des restrictions, entre autres :
\begin{itemize}
	\item les accolades doivent être équilibrées;
	\item les espaces consécutifs sont ignorés;
	\item les signes \verb|%| sont interdits;
	\item une espace est ajoutée après chaque séquence de contrôle;
	\item les caractères \verb|#| sont doublés.
\end{itemize}
\medskip

Il est préférable d'utiliser la macro \verb|\scancs|, et définir avec \verb|\verbtocs| à l'extérieur des définitions de macros, des séquences de contrôle contenant des caractères spéciaux. On pourra aussi utiliser la macro \verb|\tokenize| pour transformer le résultat final (qui est une chaîne de caractères) en une séquence de contrôle. On peut voir des exemples utilisant ces macros page~\pageref{exemples}, à la fin de ce manuel.\medskip

Dans l'exemple artificiel\footnote{On peut agir beaucoup plus simplement en utilisant la commande \texttt{\textbackslash detokenize}. Il suffit de définir la macro ainsi :\par\texttt{\textbackslash newcommand\textbackslash bracearg[1]\{\textbackslash detokenize\{\{\#1\}\}\}}} qui suit, on écrit une macro qui met son argument entre accolades. Pour cela, on définit en dehors de la définition de la macro 2 séquences de contrôles \verb|\Ob| et \verb|\Cb| contenant une accolade ouvrante et une accolade fermante. Ces séquences de contrôle sont ensuite développées et utilisées à l'intérieur de la macro pour obtenir le résultat voulu :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\verbtocs{\Ob}|{|
		\verbtocs{\Cb}|}|
		\newcommand\bracearg[1]{%
		    \def\text{#1}%
		    \scancs*{\result}{\Ob\text\Cb}%
		    \result}
		\bracearg{xstring}\par
		\bracearg{\a}
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\verbtocs{\Ob}|{|
	\verbtocs{\Cb}|}|
	\newcommand\bracearg[1]{%
		\def\text{#1}%
		\scancs*{\result}{\Ob\text\Cb}%
		\result}
	\bracearg{xstring}\par
	\bracearg{\a}
\end{minipage}

\subsection{Macros étoilées}
Comme \verb|\scancs| donne du \texte{10,12}\voirdeftexte, cela pose des problèmes pour les macros listées au chapitre~\ref{listemacros}, car elles tiennent compte du catcode des caractères de leurs arguments textuels.\medskip

Voici un exemple :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\verbtocs{\mytext}|a b c|
		\IfSubStr{\mytext}{b}{vrai}{faux}
		\par
		\edef\onecs{x y z}
		\scancs[1]\mycs\onecs
		\IfSubStr{\mycs}{y}{vrai}{faux}
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\verbtocs{\mytext}|a b c|
	\IfSubStr{\mytext}{b}{vrai}{faux}
	\par
	\edef\onecs{x y z}
	\scancs[1]\mycs\onecs
	\IfSubStr{\mycs}{y}{vrai}{faux}
\end{minipage}
\medskip

Le premier test renvoie vrai puisque la macro \verb|\verbtocs| ne modifie pas les catcodes des caractères non spéciaux : ainsi, \verb|\mytext| se développe en \og{}\verb|a|${}_{11}$\ \verb*| |${}_{10}$\ \verb|b|${}_{11}$\ \verb*| |${}_{10}$\ \verb|c|${}_{11}$\fg{} qui contient bien le deuxième argument qui est \og{}\verb|b|${}_{11}$\fg{}.\medskip

Pour le second test, puisque \verb|\scancs| donne du \texte{10,12}, il renvoit faux puisque \verb|\mycs| se développe en\newline\og{}\verb|x|${}_{12}$\ \verb*| |${}_{10}$\ \verb|y|${}_{12}$\ \verb*| |${}_{10}$\ \verb|z|${}_{12}$\fg{} qui ne contient pas le deuxième argument qui est \og{}\verb|y|${}_{11}$\fg{}.\bigskip

Pour éviter ce désagrément dû à cette différence de catcodes, et les rendre \guill{compatibles} avec \verb|\scancs|, les macros présentées au chapitre \ref{listemacros} ont toutes une version étoilée qui converti le contenu des arguments textuels en caractères dont les catcodes sont 12 uniquement, ou 10 pour les espaces :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\edef\onecs{x y z}
		\scancs[1]\mycs\onecs
		\IfSubStr*{\mycs}{y}{vrai}{faux}
	\end{boxedverbatim}
	\hspace{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\edef\onecs{x y z}
	\scancs[1]\mycs\onecs
	\IfSubStr*{\mycs}{y}{vrai}{faux}
\end{minipage}

\subsection{Exemples d'utilisation en programmation}
\label{exemples}
Voici quelques exemples très simples d'utilisation des macros comme on pourrait en rencontrer en programmation.

\subsubsection{Exemple 1}
On cherche à remplacer les deux premiers \verb|\textit| par \verb|\textbf| dans la séquence de contrôle \verb|\myCS| qui contient :\par\smallskip
\hfill\verb|\textit{A}\textit{B}\textit{C}|\hfill{}
\medskip

On cherche évidemment à obtenir : \textbf{A}\textbf{B}\textit{C}\medskip

\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\def\myCS{\textit{A}\textit{B}\textit{C}}
		\scancs[1]{\text}{\myCS}
		\StrSubstitute*[2]{\text}{textit}{textbf}[\text]
		\tokenize{\myCS}{\text}
		\myCS
	\end{boxedverbatim}
 \hspace*{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\def\myCS{\textit{A}\textit{B}\textit{C}}
	\scancs[1]{\text}{\myCS}
	\StrSubstitute*[2]{\text}{textit}{textbf}[\text]
	\tokenize{\myCS}{\text}
	\myCS
\end{minipage}

\subsubsection{Exemple 2}
Cherchons à écrire une macro \verb|\tofrac| qui transforme une écriture du type \guill{a/b} par \guill{$\frac{a}{b}$} :\par\medskip
\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\verbtocs{\csfrac}|\frac|%
		\verbtocs{\Ob}|{|%
		\verbtocs{\Cb}|}|%
		\newcommand\tofrac[1]{%
		  \scancs[0]{\myfrac}{#1}%
		  \StrBefore{\myfrac}{/}[\num]%
		  \StrBehind{\myfrac}{/}[\den]%
		  \tokenize\myfrac{\csfrac\Ob\num\Cb\Ob\den\Cb}%
		  $\myfrac$}
		\tofrac{15/9}
		\tofrac{u_{n+1}/u_n}
		\tofrac{a^m/a^n}
		\tofrac{x+\sqrt{x}/\sqrt{x^2+x+1}}
	\end{boxedverbatim}
 \hspace*{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\verbtocs{\csfrac}|\frac|%
	\verbtocs{\Ob}|{|%
	\verbtocs{\Cb}|}|%
	\newcommand\tofrac[1]{%
		\scancs[0]{\myfrac}{#1}%
		\StrBefore{\myfrac}{/}[\num]%
		\StrBehind{\myfrac}{/}[\den]%
		\tokenize\myfrac{\csfrac\Ob\num\Cb\Ob\den\Cb}%
		$\myfrac$}
	\tofrac{15/9}
	\tofrac{u_{n+1}/u_n}
	\tofrac{a^m/a^n}
	\tofrac{x+\sqrt{x}/\sqrt{x^2+x+1}}
\end{minipage}

\subsubsection{Exemple 3}
Soit une phrase composée de texte. Dans une séquence de contrôle \verb|\phrase|, essayons de mettre en gras le 1\ier{} mot qui suit le mot \guill{package}. Nous prendrons par exemple comme phrase :\par\medskip
\hfill\verb|Le package xstring est nouveau.|\hfill{}\bigskip
\setverbdelim{|}

\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\def\phrase{Le package xstring est nouveau.}
		\def\mot{package}
		\StrBehind[1]{\phrase}{\mot}[\nom]
		\IfBeginWith{\nom}{ }%
		  {\StrGobbleLeft{\nom}{1}[\nom]}%
		  {}%
		\StrBefore{\nom}{ }[\nom]
		\verbtocs{\avant}|\textbf{|
		\verbtocs{\apres}|}|
		\StrSubstitute[1]%
		  {\phrase}{\nom}{\avant\nom\apres}[\phrase]
		\tokenize{\phrase}{\phrase}
		\phrase
	\end{boxedverbatim}
	\hspace*{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
		\def\phrase{Le package xstring est nouveau.}
		\def\mot{package}
		\StrBehind[1]{\phrase}{\mot}[\nom]
		\IfBeginWith{\nom}{ }%
			{\StrGobbleLeft{\nom}{1}[\nom]}%
			{}%
		\StrBefore{\nom}{ }[\nom]
		\verbtocs{\avant}|\textbf{|
		\verbtocs{\apres}|}|
		\StrSubstitute[1]%
		  {\phrase}{\nom}{\avant\nom\apres}[\phrase]
		\tokenize{\phrase}{\phrase}
		\phrase
\end{minipage}

\subsubsection{Exemple 4}
Soit une séquence de contrôle \verb|\myCS| définie par un \verb|\def| contenant des séquences de contrôles avec leurs éventuels arguments. Comment intervertir les 2 premières séquences de contrôle ? On prendra comme exemple une séquence de contrôle contenant :\par\medskip
\hfill\verb|\textbf{A}\textit{B}\texttt{C}|\hfill{}\bigskip

On cherche à obtenir une séquence de contrôle finale contenant \verb|\textit{B}\textbf{A}\texttt{C}| et donnant : \textit{B}\textbf{A}\texttt{C}\medskip

\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\def\myCS{\textbf{A}\textit{B}\texttt{C}}
		\scancs[1]{\chaine}{\myCS}
		\verbtocs{\antislash}|\|
		\StrBefore[3]{\chaine}{\antislash}[\firsttwo]
		\StrBehind{\chaine}{\firsttwo}[\others]
		\StrBefore[2]{\firsttwo}{\antislash}[\avant]
		\StrBehind{\firsttwo}{\avant}[\apres]%
		\tokenize{\myCS}{\apres\avant\others}%
		résultat : \myCS
	\end{boxedverbatim}
	\hspace*{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\def\myCS{\textbf{A}\textit{B}\texttt{C}}
	\scancs[1]{\chaine}{\myCS}
	\verbtocs{\antislash}|\|
	\StrBefore[3]{\chaine}{\antislash}[\firsttwo]
	\StrBehind{\chaine}{\firsttwo}[\others]
	\StrBefore[2]{\firsttwo}{\antislash}[\avant]
	\StrBehind{\firsttwo}{\avant}[\apres]%
	\tokenize{\myCS}{\apres\avant\others}%
	résultat : \myCS
\end{minipage}

\subsubsection{Exemple 5}
Soit une séquence de contrôle \verb|\myCS| définie par un \verb|\def| contenant des séquences de contrôles et des groupes entre accolades. Essayons de trouver le $n$\ieme{} groupe, c'est à dire ce qui se trouve entre la $n$\ieme{} paire d'accolades équilibrées. On prendra comme exemple une séquence de contrôle contenant :\par\medskip
\hfill\verb|\a{1\b{2}}\c{3}\d{4\e{5}\f{6{7}}}|\hfill{}\medskip

\begin{minipage}[r]{0.6\linewidth}
	\hfill
	\begin{boxedverbatim}
		\newcount\occurr
		\newcount\nbgroup
		\newcommand\findgroup[2]{%
		  \scancs[1]{\chaine}{#2}%
		  \occurr=0
		  \nbgroup=0
		  \def\findthegroup{%
		    \StrBehind{\chaine}{\Obr}[\remain]%
		    \advance\occurr by 1% accolade fermante suivante
		    \StrBefore[\the\occurr]{\remain}{\Cbr}[\group]%
		    \StrCount{\group}{\Obr}[\nbA]%
		    \StrCount{\group}{\Cbr}[\nbB]%
		    \ifnum\nbA=\nbB% accolades équilibrées ?
		      \advance\nbgroup by 1
		      \ifnum\nbgroup<#1% si c'est pas le bon groupe
		        \StrBehind{\chaine}{\group}[\chaine]%
		        \occurr=0% on initialise \chaine et \occur
		        \findthegroup% et on recommence
		      \fi
		    \else% accolades non équilibrées ?
		      % cherche accolade fermante suivante
		      \findthegroup
		    \fi}
		  \findthegroup
		  \group}

		\verbtocs{\Obr}|{|
		\verbtocs{\Cbr}|}|
		\def\myCS{\a{1\b{2}}\c{3}\d{4\e{5}\f{6{7}}}}
		groupe 1: \findgroup{1}{\myCS}\par
		groupe 2: \findgroup{2}{\myCS}\par
		groupe 3: \findgroup{3}{\myCS}
	\end{boxedverbatim}
	\hspace*{0.3cm}
\end{minipage}%
\begin{minipage}[r]{0.3\linewidth}
	\newcount\occurr
	\newcount\nbgroup
	\newcommand\findgroup[2]{%
		\scancs[1]{\chaine}{#2}%
		\occurr=0
		\nbgroup=0
		\def\findthegroup{%
		\StrBehind{\chaine}{\Obr}[\remain]%
		\advance\occurr by 1% accolade fermante suivante
		\StrBefore[\the\occurr]{\remain}{\Cbr}[\group]%
		\StrCount{\group}{\Obr}[\nbA]%
		\StrCount{\group}{\Cbr}[\nbB]%
		\ifnum\nbA=\nbB% accolades équilibrées ?
			\advance\nbgroup by 1
			\ifnum\nbgroup<#1% si c'est pas le bon groupe
			\StrBehind{\chaine}{\group}[\chaine]%
			\occurr=0% on initialise \chaine et \occur
			\findthegroup% et on recommence
			\fi
		\else% accolades non équilibrées ?
			% cherche accolade fermante suivante
			\findthegroup
		\fi}
		\findthegroup
		\group}

	\verbtocs{\Obr}|{|
	\verbtocs{\Cbr}|}|
	\def\myCS{\a{1\b{2}}\c{3}\d{4\e{5}\f{6{7}}}}
	groupe 1: \findgroup{1}{\myCS}\par
	groupe 2: \findgroup{2}{\myCS}\par
	groupe 3: \findgroup{3}{\myCS}
\end{minipage}
\medskip

On peut observer qu'il faut deux compteurs, deux tests et une double récursivité pour trouver le bon groupe : un de chaque pour compter quelle accolade fermante va délimiter le groupe en cours, et l'autre pour compter quel groupe est examiné.\bigskip\bigskip

\begin{center}
$\star$

$\star$\quad$\star$
\end{center}
\bigskip\bigskip

C'est tout, j'espère que ce package vous sera utile !\par
Merci de me signaler par email tout bug ou toute proposition d'amélioration\ldots\medskip

Christian Tellechea
\end{document}