% Ceci est xtring_doc_fr.tex, le manuel en français de xstring % This is xtring_doc_fr.tex, the french manual of xstring % % 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{textcomp} \usepackage{moreverb} \usepackage{lmodern} \usepackage{eurosym} \usepackage{xspace} \usepackage{xstring} \usepackage[frenchb]{babel} \makeatletter %\@addtoreset{footnote}{page}% reset du n° de footnote à chaque page \newcommand*\exemple{\@ifstar{\def\frontiere{|}\@xs@MakeVerb}{\def\frontiere{}\@xs@MakeVerb}} \long\def\@xs@afterreadverb#1{% \normalexpandarg \tokenize\cs@resultat{#1}% \fullexpandarg \leavevmode\hbox to0.7\linewidth{\hfil\tt#1}\quad\frontiere\cs@resultat\frontiere\hfil\par} \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\etoile{$\langle$\texttt{[*]}$\rangle$} \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}} \newcommand\US{unité syntaxique\xspace} \newcommand\USs{unités syntaxiques\xspace} \newcommand\Xstring{\textsf{xstring}\xspace} \begin{document} \setlength{\parindent}{0pt} \begin{titlepage} \null\par\vfill \begin{center} \begin{minipage}{0.75\linewidth} \begin{center} \Huge\bfseries \Xstring\par\vspace{5pt} \small v\xstringversion\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} \xstringfrenchdate \end{center} \vfill\hrulefill \begin{center} \begin{minipage}{0.85\linewidth} \noindent \hfill\textbf{\textit{Résumé}}\hfill{}\medskip\par Cette extension, qui requiert Plain $\varepsilon$-\TeX, regroupe un ensemble de macros manipulant des chaînes pouvant contenir des caractères, séquences de contrôle, groupes entre accolades, de façon à utiliser les macros aussi pour de la programmation \TeX{} : \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. \item une chaîne représente t-elle un entier relatif ? Un nombre décimal ? \item deux chaînes sont-elles égales ? \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; \item position du 1\ier{} caractère différent entre 2 chaînes. \end{itemize} \end{itemize} \setlength{\parindent}{0pt} \medskip D'autres commandes permettent de gérer les caractères spéciaux normalement interdits dans les chaînes (\verb|#| et \verb|%|), ainsi que d'éventuelles différences entre catcodes de caractères, ce qui devrait permettre de couvrir tous les besoins en matière de programmation. \end{minipage} \end{center} \hrulefill\vfill{} \end{titlepage} \pagebreak \tableofcontents \pagebreak \section{Présentation} \subsection{Description} Cette extension\footnote{L'extension ne nécessite pas \LaTeX et peut être compilée sous Plain $\varepsilon$-\TeX{}.} regroupe des macros et des tests opérant sur des chaînes de caractères représentant du code \TeX, 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, test si une chaîne est un nombre entier ou décimal, extractions de sous-chaînes ou de caractères, calculs de position d'une sous-chaîne, calculs du nombre d'occurrences, etc.\medskip \Xstring lit les arguments qui lui sont transmis \emph{\US par \US\footnote{Sauf cas particulier, une \US est un caractère lu dans le code à ces exceptions près : une séquence de contrôle est une \US, un groupe entre accolades est aussi une \US. Voir également page~\pageref{developpementarguments}.}}, ce qui revient à les lire caractère par caractère lorsque ceux-ci contiennent des caractères \guill{normaux}, c'est-à-dire dont les catcodes sont 10, 11 et 12. On peut également utiliser \Xstring à des fins de programmation en utilisant des arguments contenant des séquences de contrôle et des caractères dont les catcodes sont moins inoffensifs. Voir le chapitre sur le mode de lecture et de développement des arguments (page~\pageref{developpementarguments}), la commande \verb|\verbtocs| (page~\pageref{verbtocs}), la commande \verb|\scancs| (page~\pageref{scancs}).\medskip Certes d'autres packages manipulant les chaînes de caractères 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.\medskip Comme les macros manipulent des chaînes pouvant éventuellement contenir des caractères, il peut arriver aux utilisateurs avancés de rencontrer des problèmes de \guill{catcodes\footnote{Codes de catégories, en français.}} conduisant à des comportement inattendus. Ces effets indésirables peuvent être contrôlés. Consulter en particulier le chapitre sur les catcodes des arguments page~\pageref{macrosetoilees}. \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 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 cela a été ma principale motivation puisque j'ai découvert \LaTeX{} récemment\footnote{En novembre 2007, je suis donc un \og noob\fg{} pour longtemps encore !}, 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. \section{Les macros} \subsection{Présentation des macros} Pour bien comprendre les actions de chaque macro, envisageons tout d'abord le fonctionnement et la présentation des macros dans leur mode de fonctionnement le plus simple. Pas de problème de catcode ici, ni de caractères spéciaux et encore moins de séquence de contrôle dans les arguments !\medskip Dans ce chapitre, la totalité des macros est présentée selon ce plan :\smallskip \parindent3em \begin{itemize} \item la syntaxe complète\footnote{L'étoile optionnelle après le nom de la macro, et l'argument optionnel entre crochet venant en dernier seront expliqués plus tard. Voir page~\pageref{macrosetoilees} pour les macros étoilées et page~\pageref{argumentoptionnel} pour l'argument optionnel en dernière position.} 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} \parindent0pt\smallskip \subsection{Les tests} \subsubsection{\ttfamily\textbackslash IfSubStr} \verb|\IfSubStr|\etoile\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{\ttfamily\textbackslash IfSubStrBefore} \verb|\IfSubStrBefore|\etoile\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{\ttfamily\textbackslash IfSubStrBehind} \verb|\IfSubStrBehind|\etoile\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{\ttfamily\textbackslash IfBeginWith} \verb|\IfBeginWith|\etoile\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{\ttfamily\textbackslash IfEndWith} \verb|\IfEndWith|\etoile\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}| \subsubsection{\ttfamily\textbackslash IfInteger} \verb|\IfInteger|\etoile\ARGU{nombre}\ARGU{vrai}\ARGU{faux} \smallskip Teste si \argu{nombre} est un nombre entier relatif, et exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\smallskip Si le test est faux pour cause de caractères non autorisés, la séquence de contrôle \verb|\@xs@afterinteger| contient la partie illégale de \argu{nombre}.\medskip \exemple|\IfInteger{13}{vrai}{faux}| \exemple|\IfInteger{-219}{vrai}{faux}| \exemple|\IfInteger{+9}{vrai}{faux}| \exemple|\IfInteger{3.14}{vrai}{faux}| \exemple|\IfInteger{0}{vrai}{faux}| \exemple|\IfInteger{49a}{vrai}{faux}| \exemple|\IfInteger{+}{vrai}{faux}| \exemple|\IfInteger{-}{vrai}{faux}| \exemple|\IfInteger{0000}{vrai}{faux}| \subsubsection{\ttfamily\textbackslash IfDecimal} \label{ifdecimal} \verb|\IfDecimal|\etoile\ARGU{nombre}\ARGU{vrai}\ARGU{faux} \smallskip Teste si \argu{nombre} est un nombre décimal, et exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\smallskip Les compteurs \verb|\integerpart| et \verb|\decimalpart| contiennent les parties entières et décimales de \argu{nombre}. Si le test est faux pour cause de caractères non autorisés, la séquence de contrôle \verb|\@xs@afterdecimal| contient la partie illégale de \argu{nombre}, alors que si le test est faux parce que la partie décimale après le séparateur décimal est vide, elle contient \guill{X}.\medskip \begin{Conditions} \item Le séparateur décimal peut être un point ou une virgule; \item Si ce qui se trouve à droite du séparateur décimal s'il est présent est vide, le test est faux; \item Si ce qui se trouve à gauche du séparateur décimal s'il est présent est vide, la partie entière est considérée comme étant 0. \end{Conditions} \exemple|\IfDecimal{3.14}{vrai}{faux}| \exemple|\IfDecimal{3,14}{vrai}{faux}| \exemple|\IfDecimal{-0.5}{vrai}{faux}| \exemple|\IfDecimal{.7}{vrai}{faux}| \exemple|\IfDecimal{,9}{vrai}{faux}| \exemple|\IfDecimal{1..2}{vrai}{faux}| \exemple|\IfDecimal{+6}{vrai}{faux}| \exemple|\IfDecimal{-15}{vrai}{faux}| \exemple|\IfDecimal{1.}{vrai}{faux}| \exemple|\IfDecimal{2,}{vrai}{faux}| \exemple|\IfDecimal{.}{vrai}{faux}| \exemple|\IfDecimal{,}{vrai}{faux}| \exemple|\IfDecimal{+}{vrai}{faux}| \exemple|\IfDecimal{-}{vrai}{faux}| \subsubsection{\ttfamily\textbackslash IfStrEq} \verb|\IfStrEq|\etoile\ARGU{chaineA}\ARGU{chaineB}\ARGU{vrai}\ARGU{faux} \smallskip Teste si les chaînes \argu{chaineA} et \argu{chaineB} sont égales, c'est-à-dire si elles contiennent successivement les mêmes caractères dans le même ordre. Exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\smallskip \exemple|\IfStrEq{a1b2c3}{a1b2c3}{vrai}{faux}| \exemple|\IfStrEq{abcdef}{abcd}{vrai}{faux}| \exemple|\IfStrEq{abc}{abcdef}{vrai}{faux}| \exemple|\IfStrEq{3,14}{3,14}{vrai}{faux}| \exemple|\IfStrEq{12.34}{12.340}{vrai}{faux}| \exemple|\IfStrEq{abc}{}{vrai}{faux}| \exemple|\IfStrEq{}{abc}{vrai}{faux}| \exemple|\IfStrEq{}{}{vrai}{faux}| \subsubsection{\ttfamily\textbackslash IfEq} \verb|\IfEq|\etoile\ARGU{chaineA}\ARGU{chaineB}\ARGU{vrai}\ARGU{faux} \smallskip Teste si les chaînes \argu{chaineA} et \argu{chaineB} sont égales, \emph{sauf} si \argu{chaineA} et \argu{chaineB} contiennent des nombres, auquel cas la macro teste si les nombres sont égaux. Exécute \argu{vrai} dans l'affirmative, et \argu{faux} dans le cas contraire.\smallskip \begin{Conditions} \item La définition de \emph{nombre} est celle évoquée dans la macro \verb|IfDecimal| (voir page~\pageref{ifdecimal}), et donc : \item Les signes \guill{+} sont facultatifs; \item Le séparateur décimal peut être indifféremment la virgule ou le point; \item Il est possible d'évaluer des expressions algébriques en utilisant la primitive \verb|\numexpr| de $\varepsilon$-\TeX{}, en gardant à l'esprit qu'elle ne donne que des résultats entiers et qu'elle arrondit les résultats non entiers à l'entier le plus proche. \end{Conditions} \exemple|\IfEq{a1b2c3}{a1b2c3}{vrai}{faux}| \exemple|\IfEq{abcdef}{ab}{vrai}{faux}| \exemple|\IfEq{ab}{abcdef}{vrai}{faux}| \exemple|\IfEq{12.34}{12,34}{vrai}{faux}| \exemple|\IfEq{+12.34}{12.340}{vrai}{faux}| \exemple|\IfEq{10}{+10}{vrai}{faux}| \exemple|\IfEq{-10}{10}{vrai}{faux}| \exemple|\IfEq{+0,5}{,5}{vrai}{faux}| \exemple|\IfEq{1.001}{1.01}{vrai}{faux}| \exemple|\IfEq{3*4+2}{14}{vrai}{faux}| \exemple|\IfEq{\number\numexpr3*4+2}{14}{vrai}{faux}| \exemple|\IfEq{0}{-0.0}{vrai}{faux}| \exemple|\IfEq{}{}{vrai}{faux}| \subsubsection{\ttfamily\textbackslash IfStrEqCase} \begin{minipage}{\textwidth} \verb|\IfStrEqCase|\etoile\ARGU{chaine}\verb|{%|\par \qquad\qquad\ARGU{chaine1}\ARGU{code1}\verb|%|\par \qquad\qquad\ARGU{chaine2}\ARGU{code2}\verb|%|\par \qquad\qquad\verb|etc...|\par \qquad\qquad\ARGU{chaineN}\ARGU{codeN}\verb|}|\arguC{code alternatif} \end{minipage} \smallskip Teste successivement si \argu{chaine} est égale à \argu{chaine1}, \argu{chaine2}, etc. La comparaison se fait au sens de \verb|\IfStrEq| (voir paragraphes précédents). Si un test est positif, le code correspondant est exécuté et la macro se termine. Si tous les tests sont négatifs, le code optionnel \argu{code alternatif} est exécuté s'il est présent.\smallskip \exemple|\IfStrEqCase{b}{{a}{AA}{b}{BB}{c}{CC}}| \exemple*|\IfStrEqCase{abc}{{a}{AA}{b}{BB}{c}{CC}}| \exemple|\IfStrEqCase{c}{{a}{AA}{b}{BB}{c}{CC}}[autre]| \exemple|\IfStrEqCase{d}{{a}{AA}{b}{BB}{c}{CC}}[autre]| \exemple|\IfStrEqCase{+3}{{1}{un}{2}{deux}{3}{trois}}[autre]| \exemple|\IfStrEqCase{0.5}{{0}{zero}{.5}{moitié}{1}{un}}[autre]| \subsubsection{\ttfamily\textbackslash IfEqCase} \begin{minipage}{\textwidth} \verb|\IfEqCase|\etoile\ARGU{chaine}\verb|{%|\par \qquad\qquad\ARGU{chaine1}\ARGU{code1}\verb|%|\par \qquad\qquad\ARGU{chaine2}\ARGU{code2}\verb|%|\par \qquad\qquad\verb|etc...|\par \qquad\qquad\ARGU{chaineN}\ARGU{codeN}\verb|}|\arguC{code alternatif} \end{minipage} \smallskip Teste successivement si \argu{chaine} est égale à \argu{chaine1}, \argu{chaine2}, etc. La comparaison se fait au sens de \verb|\IfEq| (voir paragraphes précédents). Si un test est positif, le code correspondant est exécuté et la macro se termine. Si tous les tests sont négatifs, le code optionnel \argu{code alternatif} est exécuté s'il est présent.\smallskip \exemple|\IfEqCase{b}{{a}{AA}{b}{BB}{c}{CC}}| \exemple*|\IfEqCase{abc}{{a}{AA}{b}{BB}{c}{CC}}| \exemple|\IfEqCase{c}{{a}{AA}{b}{BB}{c}{CC}}[autre]| \exemple|\IfEqCase{d}{{a}{AA}{b}{BB}{c}{CC}}[autre]| \exemple|\IfEqCase{+3}{{1}{un}{2}{deux}{3}{trois}}[autre]| \exemple|\IfEqCase{0.5}{{0}{zero}{.5}{moitié}{1}{un}}[autre]| \subsection{Les macros renvoyant une chaîne} \subsubsection{\ttfamily\textbackslash StrBefore} \verb|\StrBefore|\etoile\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{\ttfamily\textbackslash StrBehind} \verb|\StrBehind|\etoile\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{\ttfamily\textbackslash StrBetween} \verb|\StrBetween|\etoile\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{\ttfamily\textbackslash StrSubstitute} \verb|\StrSubstitute|\etoile\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{\ttfamily\textbackslash StrDel} \verb|\StrDel|\etoile\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{\ttfamily\textbackslash StrSplit} \verb|\StrSplit|\etoile\ARGU{chaine}\ARGU{nombre}\ARGU{chaineA}\ARGU{chaineB} \smallskip La \argu{chaine}, est coupée en deux chaînes après le caractère se situant à la position \argu{nombre}. La partie gauche est assigné à la séquence de contrôle \argu{chaineA} et la partie droite à \argu{chaineB}.\par Cette macro renvoie \emph{deux chaînes} et donc \textbf{n'affiche rien}. Par conséquent, elle ne dispose pas de l'argument optionnel\footnote{Voir les explications sur l'argument venant en dernière position page~\pageref{argumentoptionnel}.} en dernière position.\medskip \begin{Conditions} \item Si \argu{nombre}${}\leqslant0$, \argu{chaineA} sera vide et \argu{chaineB} contiendra la totalité de \argu{chaine}; \item Si \argu{nombre}${}\geqslant$\argu{longueurChaine}, \argu{chaineA} contiendra la totalité de \argu{chaine} et \argu{chaineB} sera vide; \item Si \argu{chaine} est vide \argu{chaineA} et \argu{chaineB} seront vides, quelque soit l'entier \argu{nombre}. \end{Conditions} \setverbdelim{=} \exemple=\StrSplit{abcdef}{4}{\csA}{\csB}résultats : |\csA| et |\csB|= \exemple=\StrSplit{a b c }{2}{\csA}{\csB}résultats : |\csA| et |\csB|= \exemple=\StrSplit{abcdef}{1}{\csA}{\csB}résultats : |\csA| et |\csB|= \exemple=\StrSplit{abcdef}{5}{\csA}{\csB}résultats : |\csA| et |\csB|= \exemple=\StrSplit{abcdef}{9}{\csA}{\csB}résultats : |\csA| et |\csB|= \exemple=\StrSplit{abcdef}{-3}{\csA}{\csB}résultats : |\csA| et |\csB|= \setverbdelim{|} \subsubsection{\ttfamily\textbackslash StrGobbleLeft} \verb|\StrGobbleLeft|\etoile\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{\ttfamily\textbackslash StrLeft} \verb|\StrLeft|\etoile\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{\ttfamily\textbackslash StrGobbleRight} \verb|\StrGobbleRight|\etoile\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{\ttfamily\textbackslash StrRight} \verb|\StrRight|\etoile\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{\ttfamily\textbackslash StrChar} \verb|\StrChar|\etoile\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{\ttfamily\textbackslash StrMid} \verb|\StrMid|\etoile\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{\ttfamily\textbackslash StrLen} \verb|\StrLen|\etoile\ARGU{chaine}\arguC{nom} \smallskip Renvoie la longueur de \argu{chaine}. \exemple|\StrLen{xstring}| \exemple|\StrLen{A}| \exemple|\StrLen{a bc def }| \subsubsection{\ttfamily\textbackslash StrCount} \verb|\StrCount|\etoile\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{\ttfamily\textbackslash StrPosition} \verb|\StrPosition|\etoile\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}| \subsubsection{\ttfamily\textbackslash StrCompare} \verb|\StrCompare|\etoile\ARGU{chaineA}\ARGU{chaineB}\arguC{nom} \smallskip Cette macro peut fonctionner avec 2 tolérances : la tolérance \guill{normale} sélectionnée par défaut, et la tolérance \guill{stricte}.\medskip \begin{itemize} \item La tolérance normale, activée par la commande \verb|\comparenormal|.\par La macro compare successivement les caractères de gauche à droite des chaînes \argu{chaineA} et \argu{chaineB} jusqu'à ce qu'une différence apparaisse ou que la fin de la plus courte chaîne soit atteinte. Si aucune différence n'est trouvée, la macro renvoie 0. Sinon, la position de la 1\iere{} différence est renvoyée. \item La tolérance stricte, activée par la commande \verb|\comparestrict|.\par La macro compare les 2 chaînes. Si elles sont égales, elle renvoie 0 sinon la position de la 1\iere{} différence est renvoyée. \end{itemize} \smallskip L'ordre des 2 chaînes n'a aucune influence sur le comportement de la macro.\medskip On peut également mémoriser le mode de comparaison en cours avec \verb|\savecomparemode|, le modifier par la suite et revenir à la situation lors de la sauvegarde avec \verb|\restoreecomparemode|.\medskip Exemples en tolérance normale :\par\comparenormal \exemple|\StrCompare{abcd}{abcd}| \exemple|\StrCompare{abcd}{abc}| \exemple|\StrCompare{abc}{abcd}| \exemple|\StrCompare{éùçà}{éùçà}| \exemple|\StrCompare{a b c}{abc}| \exemple|\StrCompare{aaa}{baaa}| \exemple|\StrCompare{abc}{xyz}| \exemple|\StrCompare{123456}{123457}| \exemple|\StrCompare{abc}{}| \medskip Exemples en tolérance stricte :\par\comparestrict \exemple|\StrCompare{abcd}{abcd}| \exemple|\StrCompare{abcd}{abc}| \exemple|\StrCompare{abc}{abcd}| \exemple|\StrCompare{éùçà}{éùçà}| \exemple|\StrCompare{a b c}{abc}| \exemple|\StrCompare{aaa}{baaa}| \exemple|\StrCompare{abc}{xyz}| \exemple|\StrCompare{123456}{123457}| \exemple|\StrCompare{abc}{}| \comparenormal \section{Modes de fonctionnement} \subsection{Développement des arguments} \label{devarg} \subsubsection{Les macros {\ttfamily \textbackslash fullexpandarg}, {\ttfamily \textbackslash expandarg} et {\ttfamily \textbackslash noexpandarg}} La macro \verb|\fullexpandarg| est appelée par défaut, ce qui fait que tous les arguments transmis aux macros sont développés le plus possible (pour cela, un \verb|\edef| est utilisé). Ce mode de développement maximal permet dans la plupart des cas d'éviter d'utiliser des chaînes d'\verb|\expandafter|. Le code en est souvent allégé. On peut interdire le développement des arguments des macros (et ainsi revenir au comportement normal de \TeX) en invoquant \verb|\noexpandarg| ou \verb|\normalexpandarg| qui sont synonymes.\medskip Il existe enfin un autre mode de développement des arguments que l'on appelle avec \verb|\expandarg|. Dans ce cas, le \textbf{premier lexème} de chaque argument est développé \emph{une fois} avant que la macro ne soit appelée. Dans le cas où un argument contient plus d'un lexème, les lexèmes qui suivent le premier ne sont pas développés du tout (on peut contourner cette limitation et faire appel, au préalable, à la macro \verb|\scancs*|, voir page~\pageref{scancs}).\medskip Les commandes \verb|\fullexpandarg|, \verb|\noexpandarg|, \verb|\normalexpandarg| et \verb|\expandarg| peuvent être appelées à tout moment dans le code et fonctionnent comme des bascules. On peut rendre leur portée locale dans un groupe.\medskip On peut également mémoriser le mode de développement en cours avec \verb|\saveexpandmode|, le modifier par la suite et revenir à la situation lors de la sauvegarde avec \verb|\restoreexpandmode|. \subsubsection{Caractères autorisés dans les arguments} Tout d'abord, quelque soit le mode de développement choisi, \textbf{les lexèmes de catcode 6 et 14 (habituellement {\ttfamily\#} et {\ttfamily\%}) sont interdits dans tous les arguments}\footnote{Le lexème {\ttfamily\#} sera peut-être autorisé dans une future version !}.\bigskip Lorsque le mode \verb|\fullexpandarg| est activé, les arguments sont évalués à l'aide de la primitive \verb|\edef| avant d'être transmis aux macros. Par conséquent, sont autorisés dans les arguments : \smallskip\parindent3em \begin{itemize} \item les lettres, majuscules, minuscules, accentuées\footnote{Pour pouvoir utiliser des lettres accentuées de façon fiable, il est nécessaire de charger le packages \texttt{\string\fontenc} avec l'option \texttt{[T1]}, ainsi que \texttt{\string\inputenc} avec l'option correspondant au codage du fichier tex.} ou non, les chiffres, les espaces\footnote{Selon la règle \TeX{}iènne, plusieurs espaces consécutifs n'en font qu'un.} ainsi que tout autre lexème de catcode 10, 11 ou 12 (signes de ponctuation, signes opératoires mathématiques, parenthèses, crochets, etc); \item les lexèmes de catcode 1 à 4, qui sont habituellement : \og\verb|{|\fg\quad\og\verb|}|\fg\footnote{Attention : les accolades \textbf{doivent} être équilibrées dans les arguments !}\quad\og\verb|$|\fg\quad\og\verb|&|\fg \item les lexèmes de catcode 7 et 8, qui sont habituellement : \og\verb|^|\fg\quad\og\verb|_|\fg \item toute séquence de contrôle si elle est purement développable\footnote{C'est-à-dire qu'elle peut être mise à l'intérieur d'un {\ttfamily\string\edef}.} et dont le développement maximal donne des caractères autorisés; \item un lexème de catcode 13 (caractère actif) s'il est purement développable. \end{itemize} \parindent0pt\smallskip En revanche, certains caractères\footnote{Ces caractères s'obtiennent avec la touche \textsf{AtlGr}${}+{}$lettre sous les distributions GNU/Linux.} comme \officialeuro, \textcurrency, ¶, etc. généreront des erreurs. \bigskip Lorsque les arguments ne sont plus développés au maximum avec \verb|\expandarg| ou \verb|\noexpandarg|, les caractères autorisés sont ceux cités ci-dessus auxquels il faut rajouter toute séquence de contrôle, même non définie, ainsi que les caractères précédemment cités (\officialeuro, \textcurrency, ¶, etc.). \subsection{Développement des macros, argument optionnel} \label{argumentoptionnel} 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|. L'imbrication des macros de ce package n'est pas permise non plus, même en faisant appel à \verb|\expandafter|.\medskip C'est pour cela que les macros renvoyant un résultat, c'est-à-dire toutes sauf les tests et \verb|\StrSplit|, sont dotées d'un argument optionnel venant en dernière position. Cet argument prend la forme de \arguC{nom}, où \argu{nom} est 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 \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. Cela permet donc contourner les limitations évoquées dans les exemples ci dessus.\medskip Ainsi cette construction non permise censée assigner à \verb|\Resultat| les 4 caractères de gauche de \verb|xstring| :\par \hspace{0.2\linewidth}\verb|\edef\Resultat{\StrLeft{xstring}{4}}|\par \qquad est équivalente à :\par \hspace{0.2\linewidth}\verb|\StrLeft{xstring}{4}[\Resultat]|\medskip Et cette imbrication non permise censée enlever le premier et le dernier caractère de \verb|xstring| :\par \hspace{0.2\linewidth}\verb|\StrGobbleLeft{\StrGobbleRight{xstring}{1}}{1}|\par \qquad se programme ainsi :\par \hspace{0.2\linewidth}\verb|\StrGobbleRight{xstring}{1}[\machaine]|\par \hspace{0.2\linewidth}\verb|\StrGobbleleft{\machaine}{1}|\par \subsection{Lecture des arguments} \label{developpementarguments} \subsubsection{Lecture à l'\US prés} Les macros de \Xstring traitent les arguments \US par \US. Dans le code \TeX{}, une \US est soit :\smallskip\parindent3em \begin{itemize} \item une séquence de contrôle; \item un groupe, c'est à dire une suite de caractères située entre deux accolades équilibrées; \item un caractère ne faisant pas partie des 2 espèces ci dessus. \end{itemize} \medskip\parindent0pt Voyons ce qu'est la notion d'\US sur un exemple. Prenons cet argument : \og\verb|ab\textbf{xyz}cd|\fg Il contient 6 \USs qui sont : \og\verb|a|\fg, \og\verb|b|\fg, \og\verb|\textbf|\fg, \og\verb|{xyz}|\fg, \og\verb|c|\fg{} et \og\verb|d|\fg.\medskip Que va t-il arriver si l'on se place sous \verb|\noexpandarg| et que l'on demande à \Xstring de trouver la longueur de cet argument et d'en trouver le 4\ieme{} \guill{caractère} ?\medskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \noexpandarg \StrLen{ab\textbf{xyz}cd}\par \StrChar{ab\textbf{xyz}cd}{4}[\mychar] \meaning\mychar \end{boxedverbatim} \hspace*{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \noexpandarg \StrLen{ab\textbf{xyz}cd}\par \StrChar{ab\textbf{xyz}cd}{4}[\mychar] \meaning\mychar \end{minipage} \fullexpandarg \medskip Il est nécessaire d'utiliser \verb|\meaning| pour bien visualiser le véritable contenu de \verb|\mychar| et non pas de simplement d'appeler cette séquence de contrôle, ce qui fait perdre des informations. On voit qu'on n'obtient pas vraiment un \guill{caractère}, mais cela était prévisible : il s'agit d'une \US. \subsubsection{Exploration des groupes} Par défaut, la commande \verb|\noexploregroups| est appelée et donc dans l'argument principal, \Xstring considère les groupes entre accolades comme \USs fermées dans lesquelles \Xstring ne regarde pas. Pour certains besoins spécifiques, il peut être nécessaire de modifier le mode de lecture des arguments et d'explorer l'intérieur des groupes entre accolades. Pour cela on peut invoquer \verb|\exploregroups|.\medskip Que va donner ce nouveau mode d'exploration sur l'exemple précédent ? \Xstring ne va plus compter le groupe comme une seule \US mais va compter les \USs se trouvant à l'intérieur, et ainsi de suite s'il y avait plusieurs niveaux d'imbrication de groupes:\smallskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \noexpandarg \exploregroups \StrLen{ab\textbf{xyz}cd}\par \StrChar{ab\textbf{xyz}cd}{4}[\mychar] \meaning\mychar \end{boxedverbatim} \hspace*{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \noexpandarg \exploregroups \StrLen{ab\textbf{xyz}cd}\par \StrChar{ab\textbf{xyz}cd}{4}[\mychar] \meaning\mychar \end{minipage} \fullexpandarg\noexploregroups \medskip L'exploration des groupes peut se réveler utile pour le comptage, le calcul de position ou les tests, mais comporte une limitation lorsque l'on appelle des macros renvoyant des chaînes : lorsqu'un argument est coupé à l'intérieur d'un groupe, alors \textbf{le résultat ne tient pas compte de ce qui se trouve à l'extérieur de ce groupe}. Il faut donc utiliser ce mode en connaissance de cause lorsque l'on utilise les macros renvoyant des chaînes. Voyons ce que cela signifie sur un exemple : mettons que l'on veuille renvoyer ce qui se trouve à droite de la 2\ieme{} occurrence de \verb|\a| dans l'argument \verb|\a1{\b1\a2}\a3|. Comme l'on explore les groupes, cette occurrence se trouve à l'intérieur du groupe \verb|{\b1\a2}|. Le résultat renvoyé sera donc : \verb|\b1|. Vérifions-le :\smallskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \noexpandarg \exploregroups \StrBefore[2]{\a1{\b1\a2}\a3}{\a}[\mycs] \meaning\mycs \end{boxedverbatim} \hspace*{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \noexpandarg \exploregroups \StrBefore[2]{\a1{\b1\a2}\a3}{\a}[\mycs] \meaning\mycs \end{minipage} \fullexpandarg\noexploregroups \medskip L'exploration des groupes\footnote{On peut consulter le fichier de test de \Xstring qui comporte de nombreux exemples et met en évidence les différences selon le mode d'exploration des groupes.} peut ainsi changer le comportement de la plupart des macros de \Xstring, à l'exception de \verb|\IfInteger|, \verb|\IfDecimal|, \verb|\IfStrEq|, \verb|\StrEq| et \verb|\StrCompare| qui sont insensibles au mode d'exploration en cours. De plus, pour des raison d'équilibrage d'accolades, 2 macros n'opèrent qu'en mode \verb|\noexploregroups|, quelque soit le mode d'exploration en cours : \verb|\StrBetween| et \verb|\StrMid|.\medskip On peut mémoriser le mode de d'exploration en cours avec \verb|\saveexploremode|, le modifier par la suite et revenir à la situation lors de la sauvegarde avec \verb|\restoreexploremode|. \subsection{Catcodes des arguments, macros étoilées} \label{macrosetoilees} Les macros présentées ici tiennent compte des catcodes des caractères constituant les arguments. Il faut donc garder à l'esprit, particulièrement lors des tests, que les caractères \emph{et leurs catcodes} sont examinés.\medskip Par exemple, ces 2 arguments :\par\smallskip \hfil\verb|{\string a\string b}|\qquad et\qquad\verb|{ab}|\hfil{}\par\smallskip ne se développent pas en 2 arguments égaux au yeux de \Xstring. Dans le premier cas, à cause de l'emploi de la primitive \verb|\string|, les caractères \og\verb|ab|\fg{} ont un catcode de 12 alors que dans l'autre cas, ils ont leurs catcodes naturels de 11. Il convient donc d'être conscient de ces subtilités lorsque l'on emploie des primitives dont les résultats sont des chaînes de caractères ayant des catcodes de 12 et 10 comme \verb|\string|, \verb|\detokenize|, \verb|\meaning|, \verb|\jobname|, \verb|\fontname|, \verb|\romannumeral|, etc.\medskip Pour demander aux macros de ne pas tenir compte des catcodes, on peut utiliser les macros étoilées. Celles-ci convertissent tous leurs arguments en chaînes de caractères dont les catcodes sont 12 (et 10 pour l'espace) avant que la macro non étoilée travaille sur ces arguments ainsi modifiés.\medskip \textbf{Attention} : utiliser une macro étoilée a des conséquenses ! Les arguments sont \guill{détokénisés}, il n'y a donc plus de séquence de contrôle, plus de goupes, ni aucun caractère de catcode spécial puisque tout est converti en caractères \guill{inoffensifs} ayant le même catcode.\medskip Voici un exemple :\par\smallskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \IfStrEq{\string a\string b}{ab}{vrai}{faux}\par \IfStrEq*{\string a\string b}{ab}{vrai}{faux} \end{boxedverbatim} \hspace{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \IfStrEq{\string a\string b}{ab}{vrai}{faux}\par \IfStrEq*{\string a\string b}{ab}{vrai}{faux} \end{minipage}\smallskip Dans l'exemple ci-dessus, après développement (on suppose que \verb|\fullexpandarg| est actif), le premier argument contient \verb|{ab}| où, à cause de \verb|\string|, les 2 caractères ont un catcode de 12. Le deuxième argument est \verb|{ab}| où les caractères ont leurs catcodes naturels de 11. Les chaînes n'étant pas égales à cause des catcodes, le test est donc \emph{négatif} dans la version non étoilée.\bigskip Pour les macros renvoyant une chaîne, si on emploie les versions étoilées, le résultat sera une chaîne de caractères dont les catcodes sont 12, et 10 pour l'espace. Ainsi après un \og\verb|\StrBefore*{a \b c d}{c}[\montexte]|\fg{}, la séquence de contrôle \verb|\montexte| se développera en \og{}\verb|a|${}_{12}$\verb*| |${}_{10}$\verb|\|${}_{12}$\verb|b|${}_{12}$\verb*| |${}_{10}$\fg{}. \section{Autres macros pour une aide à la programmation} Bien que \Xstring ait la possibilité de lire et traiter des arguments contenant du code \TeX{} ou \LaTeX{} ce qui devrait couvrir la plupart des besoins en programmation, il peut arriver pour des besoins très spécifiques que cela ne suffise pas. Ce chapitre présente d'autres macros qui permettent de contourner certaines limitations. \subsection{Assigner un contenu verb, la macro \ttfamily\textbackslash verbtocs} \label{verbtocs} La macro \verb|\verbtocs| permet le lire le contenu d'un \guill{verb} qui peut contenir tous 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}. \argu{nom} contiendra donc des caractères de catcodes 12 ou 10 pour l'espace.\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 lire un contenu verb 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{\string\verbtocs} ! Pour cette raison, avertissement sera émis si l'argument de \texttt{\string\setverbdelim} contient plusieurs caractères.}.\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 des délimiteurs, 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| J'affiche le résultat :\par\resultat \end{boxedverbatim} \hspace*{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \verbtocs{\resultat} |a & b{ c% d$ e \f| J'affiche le résultat :\par\resultat \end{minipage} \subsection{Tokenisation d'un texte vers une séquence de contrôle, la macro \ttfamily\textbackslash tokenize} Le processus inverse de ce qui a été vu au dessus consiste à interpréter une suite de caractères en lexèmes. Pour cela, on dispose de la macro :\medskip \hfill\verb|\tokenize|\ARGU{nom}\ARGU{séquences de contrôle}\hfill{} \smallskip \argu{séquences de contrôle} est développée le plus possible si l'on a invoqué \verb|\fullexpandarg|; elle n'est pas développée si l'on a invoqué \verb|\normalexpandarg| ou \verb|\expandarg|. Après développement éventuel, la suite de caractères est transformeé en tokens puis assigné à l 'aide d'un \verb|\def| à la séquence de contrôle \argu{nom}.\medskip Voici un exemple où l'on détokenise un argument, on affiche le texte obtenu, puis on transforme ce texte en ce que l'argument était au début; enfin, on affiche le résultat de la tokenisation :\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, la macro \ttfamily\textbackslash scancs} \label{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|\etoile\arguC{nombre}\ARGU{nom}\ARGU{séquence(s) 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 verbatimisée en caractères de catcode 12 ou 10 pour l'espace, puis assignée à la séquence de contrôle \argu{nom}.\bigskip Si cela s'avère nécessaire, on peut aussi contrôler la profondeur de développement avec l'argument optionnel. Si le $n$-développement donne une séquence de contrôle, alors cette séquence de contrôle est verbatimisée en caractères de catcode 12. L'exemple montre toutes les profondeurs de développement de la séquence de contrôle \verb|\c| de la profondeur 0 jusqu'à la profondeur 3 :\par\medskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \def\a{1 z 3} \def\b{\a} \def\c{\b} \scancs[0]{\resultat}{\c} développement 0 : \resultat\par \scancs[1]{\resultat}{\c} développement 1 : \resultat\par \scancs[2]{\resultat}{\c} développement 2 : \resultat\par \scancs[3]{\resultat}{\c} développement 3 : \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[0]{\resultat}{\c} développement 0 : \resultat\par \scancs[1]{\resultat}{\c} développement 1 : \resultat\par \scancs[2]{\resultat}{\c} développement 2 : \resultat\par \scancs[3]{\resultat}{\c} développement 3 : \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 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. Il faut garder à l'esprit que si le $n$-développement contient un groupe entre accolades, ce groupe sera développé au développement $n+1$, et perdra ses accolades ! Il en est de même pour les espaces\footnote{Tout appel à la macro {\ttfamily\string\scancs} est accompagné d'un message d'attention mettant en grade sur ces inconvénients.}. Voici un exemple :\par\medskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \def\a{1 {2}} \def\b{\a \a} \scancs*[0]{\resultat}{{A}\b} développement 0 : \resultat\par \scancs*[1]{\resultat}{{A}\b} développement 1 : \resultat\par \scancs*[2]{\resultat}{{A}\b} développement 2 : \resultat\par \scancs*[3]{\resultat}{{A}\b} développement 3 : \resultat \end{boxedverbatim} \hspace{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \def\a{1 {2}} \def\b{\a \a} \scancs*[0]{\resultat}{{A}\b} développement 0 : \resultat\par \scancs*[1]{\resultat}{{A}\b} développement 1 : \resultat\par \scancs*[2]{\resultat}{{A}\b} développement 2 : \resultat\par \scancs*[3]{\resultat}{{A}\b} développement 3 : \resultat \end{minipage} \subsection{À l'intérieur 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, ce qui disqualifie la macro \verb|\verbtocs|. Il faut donc observer la règle suivante :\par\medskip \hfill \textbf{Ne pas utiliser la macro {\ttfamily\string\verbtocs} à l'intérieur de la définition d'une macro}.\hfill{}\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 détokénisés. 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{\string\detokenize}. Il suffit de définir la macro ainsi :\par\texttt{\string\newcommand\string\bracearg[1]\{\string\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 de catcodes 12. 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{La macro \ttfamily\textbackslash StrRemoveBraces} Pour des utilisations spéciales, on peut désirer retirer les accolades délimitant les groupes dans un argument. On peut utiliser la macro \verb|\StrRemoveBraces| dont voici la syntaxe :\smallskip \verb|\StrRemoveBraces|\ARGU{chaine}\arguC{nom} \smallskip Cette macro est sensible au mode d'exploration, et retirera \emph{toutes} les accolades avec \verb|\exploregroups| alors qu'elle ne retirera que les accolades des groupes de plus haut niveau avec \verb|\noexploregroups|.\medskip \exemple|\noexploregroups| \exemple|\StrRemoveBraces{a{b{c}d}e{f}g}[\mycs]| \exemple|\meaning\mycs| \exemple|\exploregroups| \exemple|\StrRemoveBraces{a{b{c}d}e{f}g}[\mycs]| \exemple|\meaning\mycs| \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 \verb|\textbf{A}\textbf{B}\textit{C}| qui donne : \textbf{A}\textbf{B}\textit{C}\medskip Pour cela, on va développer les arguments des macros une fois avant qu'elles les traitent, en invoquant la commande \verb|\expandarg|. Ensuite, on définit \verb|\pattern| qui est le motif à remplacer, et \verb|\replace| qui est le motif de substitution. On travaille token par token puisque \verb|\expandarg| a été appelé, il suffit d'invoquer \verb|\StrSubstitute| pour faire les 2 substitutions.\medskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \expandarg \def\myCS{\textit{A}\textit{B}\textit{C}} \def\pattern{\textit} \def\replace{\textbf} \StrSubstitute[2]{\myCS}{\pattern}{\replace} \end{boxedverbatim} \hspace*{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \expandarg \def\myCS{\textit{A}\textit{B}\textit{C}} \def\pattern{\textit} \def\replace{\textbf} \StrSubstitute[2]{\myCS}{\pattern}{\replace} \end{minipage}\fullexpandarg \medskip Pour éviter de définir les séquences de contrôle \verb|\pattern| et \verb|\replace|, on aurait pu utiliser un leurre comme par exemple une séquence de contrôle qui se développe en \guill{rien} comme \verb|\empty|, et coder de cette façon :\par\smallskip \hfil\verb|\StrSubstitute[2]{\myCS}{\empty\textit}{\empty\textbf}|\hfil{}\medskip Ainsi, \verb|\empty| est développée en \guill{rien} et il reste dans les 2 derniers arguments les séquences de contrôles significatives \verb|\textit| et \verb|textbf|.\smallskip La séquence de contrôle \verb|\empty| est donc un \guill{hack} pour \verb|\expandarg| : elle permet de bloquer le développement du 1\ier{} lexème ! On aurait d'ailleurs pu utiliser \verb|\noexpand| au lieu de \verb|\empty| pour obtenir le même résultat. \subsubsection{Exemple 2} Cherchons à écrire une macro \verb|\tofrac| qui transforme une écriture du type \guill{a/b} par \guill{$\frac{a}{b}$}.\medskip Tout d'abord, annulons le développement des arguments avec \verb|\noexpandarg| : nous n'avons pas besoin de développement ici. Il suffit d'isoler ce qui se trouve avant et après la 1\iere{} occurrence de \guill{/} (on suppose qu'il n'y a qu'une seule occurrence), le mettre dans les séquences de contrôle \verb|\avant| et \verb|\apres| et simplement appeler la macro \verb|\frac| :\medskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \noexpandarg \newcommand\tofrac[1]{% \StrBefore{#1}{/}[\num]% \StrBehind{#1}{/}[\den]% $\frac{\num}{\den}$% } \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} \noexpandarg \newcommand\tofrac[1]{% \StrBefore{#1}{/}[\num]% \StrBehind{#1}{/}[\den]% $\frac{\num}{\den}$} \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}\fullexpandarg \subsubsection{Exemple 3} Soit une phrase composée de texte. Dans cette phrase, essayons construire une macro qui mette en gras le 1\ier{} mot qui suit un mot donné. On entend par mot une suite de caractère ne commençant ni ne finissant par un espace. Si le mot n'existe pas dans la phrase, rien n'est fait.\medskip On va écrire une macro \verb|\grasapres| qui effectue ce travail. On appelle \verb|\StrBehind| qui assigne à \verb|\mot| ce qui se trouve après la 1\iere{} occurrence du mot (précédé et suivi de son espace). Ensuite, le mot à mettre en gras est ce qui se trouve avant le 1\ier{} espace dans la séquence de contrôle \verb|\mot|. Remarquons que ceci reste vrai même si le mot à mettre en gras est le dernier de l'argument car un espace a été rajouté à la fin de l'argument par \verb|{#1 }| lors de l'appel à \verb|\StrBehind|. Remarquons aussi que \verb|\expandarg| a été appelé et donc, le premier lexème de l'argument \verb|\textbf{\mot}| est développé 1 fois, \emph{lui aussi} ! Cela est possible (heureusement sinon, il aurait fallu faire autrement et utiliser le hack de l'exemple précédent) puisque le 1-développement de cette macro de \LaTeX{} est \og\verb|\protect\textbf|\fg{}\footnote{En toute rigueur, il aurait fallu écrire :\par\hspace{2em}{\ttfamily\string\StrSubstitute[1]\{\string#1\}\{\string\mot\}\{\string\expandafter\string\textbf\string\expandafter\{\string\mot\}\}}\\De cette façons, dans {\ttfamily\{\string\expandafter\string\textbf\string\expandafter\{\string\mot\}\}}, la séquence de contrôle {\ttfamily\string\mot} est développée \textbf{avant} que l'appel à la macro ne se fasse. Cela est dû à l'{\ttfamily\string\expandafter} placé en début d'argument qui est développé à cause de {\ttfamily\string\expandarg} et grace à l'autre {\ttfamily\string\expandafter}, provoque le développement de {\ttfamily\string\mot}}.\medskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \newcommand\grasapres[2]{% \noexpandarg \StrBehind[1]{#1 }{ #2 }[\mot]% \expandarg \StrBefore{\mot}{ }[\mot]% \StrSubstitute[1]{#1}{\mot}{\textbf{\mot}}% } \grasapres{Le package xstring est nouveau}{package} \grasapres{Le package xstring est nouveau}{ckage} \grasapres{Le package xstring est nouveau}{est} \end{boxedverbatim} \hspace*{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \newcommand\grasapres[2]{% \noexpandarg \StrBehind[1]{#1 }{ #2 }[\mot]% \expandarg \StrBefore{\mot}{ }[\mot]% \StrSubstitute[1]{#1}{\mot}{\textbf{\mot}}% } \grasapres{Le package xstring est nouveau}{package} \grasapres{Le package xstring est nouveau}{ckage} \grasapres{Le package xstring est nouveau}{est} \end{minipage}\fullexpandarg \subsubsection{Exemple 4} Soit un argument commençant par au moins 3 séquences de contrôles avec leurs éventuels arguments. Comment intervertir les 2 premières séquences de contrôle de telle sorte qu'elles gardent leurs arguments ? On va pour cela écrire une macro \verb|swaptwofirst|. Cette fois ci, on ne peut pas chercher le seul caractère \og\verb|\|\fg{} (de catcode 0) dans un argument. Nous serons obligé de détokeniser l'argument, c'est ce que fait \verb|\scancs[0]\chaine{#1}| qui met le résultat dans \verb|\chaine|. Ensuite, on cherchera dans cette séquence de contrôle les occurrences de \verb|\antislash| qui contient le caractère \og\verb|\|\fg{} de catcode 12, assigné avec un \verb|\verbtocs| écrit \emph{en dehors\footnote{En effet, la macro {\tt\string\verbtocs} et son argument verb est interdite à l'intérieur de la définition d'une macro.}} du corps de la macro. La macro se termine par une retokenisation, une fois que les chaînes \verb|\avant| et \verb|\apres| aient été échangées.\medskip \begin{minipage}[r]{0.6\linewidth} \hfill \begin{boxedverbatim} \verbtocs{\antislash}|\| \newcommand\swaptwofirst[1]{% \fullexpandarg \scancs[0]\chaine{#1}% \StrBefore[3]{\chaine}{\antislash}[\firsttwo]% \StrBehind{\chaine}{\firsttwo}[\others] \StrBefore[2]{\firsttwo}{\antislash}[\avant] \StrBehind{\firsttwo}{\avant}[\apres]% \tokenize\myCS{\apres\avant\others}% \myCS} \swaptwofirst{\underline{A}\textbf{B}\textit{C}} \swaptwofirst{\Large\underline{A}\textbf{B}123} \end{boxedverbatim} \hspace*{0.3cm} \end{minipage}% \begin{minipage}[r]{0.3\linewidth} \verbtocs{\antislash}|\| \newcommand\swaptwofirst[1]{% \fullexpandarg \scancs[0]\chaine{#1}% \StrBefore[3]{\chaine}{\antislash}[\firsttwo]% \StrBehind{\chaine}{\firsttwo}[\others] \StrBefore[2]{\firsttwo}{\antislash}[\avant] \StrBehind{\firsttwo}{\avant}[\apres]% \tokenize\myCS{\apres\avant\others}% \myCS} \swaptwofirst{\underline{A}\textbf{B}\textit{C}} \swaptwofirst{\Large\underline{A}\textbf{B}123} \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} \fullexpandarg \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 \expandafter\expandafter\expandafter \findthegroup\expandafter% et on recommence \fi \else% accolades non équilibrées ? % cherche accolade fermante suivante \expandafter\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} \fullexpandarg \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 \expandafter\expandafter\expandafter \findthegroup\expandafter% et on recommence \fi \else% accolades non équilibrées ? % cherche accolade fermante suivante \expandafter\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é.\vspace{10pt} \begin{center} $\star$\par $\star$\quad$\star$ \end{center} \vspace{10pt} 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}