summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/xstring/xstring_doc_fr.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/generic/xstring/xstring_doc_fr.tex')
-rw-r--r--Master/texmf-dist/doc/generic/xstring/xstring_doc_fr.tex623
1 files changed, 428 insertions, 195 deletions
diff --git a/Master/texmf-dist/doc/generic/xstring/xstring_doc_fr.tex b/Master/texmf-dist/doc/generic/xstring/xstring_doc_fr.tex
index 0cbf4bd637d..295644470ec 100644
--- a/Master/texmf-dist/doc/generic/xstring/xstring_doc_fr.tex
+++ b/Master/texmf-dist/doc/generic/xstring/xstring_doc_fr.tex
@@ -1,7 +1,7 @@
% 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
+% Christian Tellechea 2009
%
% email : unbonpetit@gmail.com
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -18,21 +18,32 @@
\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[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 lexèmes},pdfkeywords={xstring,latex,string,chaine},pdfcreator={LaTeX}]{hyperref}
+\usepackage[a4paper,dvips,margin=1.9cm]{geometry}
+\usepackage{amsmath,amssymb,amsfonts,textcomp}
+\usepackage{color}
\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{%
+% redéfinition de l'écriture des textes des footnote
+\long\def\@makefntextFB#1{%
+ \ifx\thefootnote\ftnISsymbol
+ \@makefntextORI{#1}%
+ \else
+ \rule\z@\footnotesep
+ \setbox\@tempboxa\hbox{\@thefnmark}%
+ \ifdim\wd\@tempboxa>\z@
+ \kern2em\llap{\@thefnmark.\kern0.5em}%
+ \fi
+ \begingroup\advance\hsize-2em\vtop{#1}\endgroup%
+ \fi}
+
+\newcommand*\exemple{\@ifstar{\let\frontiere\textbar\@xs@MakeVerb}{\let\frontiere\@empty\@xs@MakeVerb}}
+\def\@xs@afterreadverb#1{%
\normalexpandarg
\tokenize\cs@resultat{#1}%
\fullexpandarg
@@ -40,12 +51,10 @@
\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\ARGU[1]{\texttt{\color{black}\{}\argu{#1}\texttt{\color{black}\}}}
+\newcommand\arguC[1]{\texttt{\color{black}[}\argu{#1}\texttt{\color{black}]}}
+\newcommand\arguCC[2]{\texttt{\color{black}[}\argu{#1}\texttt{\color{black},}\argu{#2}\texttt{\color{black}]}}
\newcommand\etoile{$\langle$\texttt{[*]}$\rangle$}
-\newcommand\voirdeftexte{~(voir \ref{deftexte})}
\newenvironment{Conditions}[1][1cm]%
{\begin{list}%
{$\vartriangleright$}%
@@ -83,7 +92,7 @@
\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{} :
+ Cette extension, qui requiert Plain $\varepsilon$-\TeX, regroupe un ensemble de macros manipulant des chaînes de lexèmes (tokens en anglais). Les macros peuvent être utilisées de façon basique dans le traitement des chaînes de caractères mais peuvent également être utiles en programmation \TeX{} pour la manipulation des lexèmes, c'est-à-dire du code \TeX{}. Parmis les fonctionnalités, les principales sont :
\setlength{\parindent}{1.5em}
\begin{itemize}
\item[$\triangleright$] des tests :
@@ -93,11 +102,12 @@
\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 :
+ \item[$\triangleright$] des recherches 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.
+ \item recherche de ce qui se trouve avant (ou après) la $n$\ieme{} occurrence d'une sous-chaîne;
+ \item recherche de ce qui se trouve entre les occurrences de 2 sous-chaînes;
+ \item sous-chaîne comprise entre 2 positions;
+ \item recherche d'un groupe entre accolades par son identifiant.
\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 :
@@ -105,32 +115,32 @@
\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.
+ \item position de la 1\iere{} différence entre 2 chaînes;
+ \item renvoi de l'identifiant du groupe dans lequel une recherche ou une coupure s'est faite.
\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.
+ D'autres commandes permettent de gérer les lexèmes spéciaux normalement interdits dans les chaînes (\verb|#| et \verb|%|), ainsi que d'éventuelles différences entre catcodes de lexèmes, 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
+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 lexèmes, un peu comme en disposent des langages dit \guill{évolués}. On y trouve les opérations habituelles sur les chaînes, 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, 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
+Les arguments contenant des chaînes de lexèmes sont lus par \Xstring \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 lexèmes \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 lexèmes 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}.
+Comme les macros manipulent des chaînes de lexèmes, 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.
+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. 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
@@ -138,7 +148,7 @@ Ensuite, et cela a été ma principale motivation puisque j'ai découvert \LaTeX
\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
+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 lexèmes spéciaux et encore moins de séquence de contrôle dans les arguments : les arguments contiendront des caractères alphanumériques.\medskip
Dans ce chapitre, la totalité des macros est présentée selon ce plan :\smallskip
@@ -147,10 +157,11 @@ Dans ce chapitre, la totalité des macros est présentée selon ce plan :\smalls
\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{||}.
+ \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{\textbar}, étant entendu qu'une chaîne vide est représentée par \guill{\textbar\textbar}.
\end{itemize}
\parindent0pt\smallskip
+\textbf{Important} : dans les macros qui suivent, sauf cas spécifié, un \argu{nombre} est un nombre entier, un compteur, ou le résultat d'une opération arithmétique effectuée à l'aide de la primitive \verb|\numexpr|.
\subsection{Les tests}
\subsubsection{\ttfamily\textbackslash IfSubStr}
\verb|\IfSubStr|\etoile\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\ARGU{vrai}\ARGU{faux}
@@ -256,7 +267,7 @@ Teste si \argu{chaine} se termine par \argu{chaineA}, et exécute \argu{vrai} da
\subsubsection{\ttfamily\textbackslash IfInteger}
-\verb|\IfInteger|\etoile\ARGU{nombre}\ARGU{vrai}\ARGU{faux}
+\verb|\IfInteger|\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
@@ -275,7 +286,7 @@ Si le test est faux pour cause de caractères non autorisés, la séquence de co
\subsubsection{\ttfamily\textbackslash IfDecimal}
\label{ifdecimal}
-\verb|\IfDecimal|\etoile\ARGU{nombre}\ARGU{vrai}\ARGU{faux}
+\verb|\IfDecimal|\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
@@ -310,7 +321,7 @@ Si le test est faux pour cause de caractères non autorisés, la séquence de co
\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
+Teste si les chaînes \argu{chaineA} et \argu{chaineB} sont égales, c'est-à-dire si elles contiennent successivement les mêmes \US 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}|
@@ -331,8 +342,7 @@ Teste si les chaînes \argu{chaineA} et \argu{chaineB} sont égales, \emph{sauf}
\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.
+ \item Le séparateur décimal peut être indifféremment la virgule ou le point.
\end{Conditions}
\exemple|\IfEq{a1b2c3}{a1b2c3}{vrai}{faux}|
@@ -390,7 +400,6 @@ Teste successivement si \argu{chaine} est égale à \argu{chaine1}, \argu{chaine
\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
@@ -465,7 +474,7 @@ Dans \argu{chaine}, renvoie ce qui se trouve entre\footnote{Au sens strict, c'es
\exemple*|\StrBetween[3,2]{abracadabra}{a}{bra}|
\subsubsection{\ttfamily\textbackslash StrSubstitute}
-\verb|\StrSubstitute|\etoile\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}\arguC{nom}
+\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
@@ -492,7 +501,7 @@ Dans \argu{chaine}, la macro remplace les \argu{nombre} premières occurrences d
\exemple|\StrSubstitute[4]{a1a2a3}{a}{B}|
\subsubsection{\ttfamily\textbackslash StrDel}
-\verb|\StrDel|\etoile\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
+\verb|\StrDel|\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
\smallskip
L'argument optionnel \argu{nombre} vaut 0 par défaut.\par\smallskip
@@ -513,38 +522,16 @@ Supprime les \argu{nombre} premières occurrences de \argu{chaineA} dans \argu{c
\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}
+\verb|\StrGobbleLeft|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip
-Dans \argu{chaine}, enlève les \argu{nombre} premiers caractères de gauche.\medskip
+Dans \argu{chaine}, enlève les \argu{nombre} premieres \USs 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.
+ \item Si \argu{nombre}${}\leqslant0$, aucune \US n'est supprimée;
+ \item Si \argu{nombre}${}\geqslant{}$\argu{longueurChaine}, toutes les \USs sont supprimées.
\end{Conditions}
\exemple*|\StrGobbleLeft{xstring}{2}|
@@ -554,15 +541,15 @@ Dans \argu{chaine}, enlève les \argu{nombre} premiers caractères de gauche.\me
\exemple*|\StrGobbleLeft{a bc def }{4}|
\subsubsection{\ttfamily\textbackslash StrLeft}
-\verb|\StrLeft|\etoile\ARGU{chaine}\ARGU{nombre}\arguC{nom}
+\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.
+ \item Si \argu{nombre}${}\leqslant0$, aucune \US n'est retournée;
+ \item Si \argu{nombre}${}\geqslant{}$\argu{longueurChaine}, toutes les \USs sont retournées.
\end{Conditions}
\exemple*|\StrLeft{xstring}{2}|
@@ -572,10 +559,10 @@ Dans \argu{chaine}, renvoie la sous-chaîne de gauche de longueur \argu{nombre}.
\exemple*|\StrLeft{a bc def }{5}|
\subsubsection{\ttfamily\textbackslash StrGobbleRight}
-\verb|\StrGobbleRight|\etoile\ARGU{chaine}\ARGU{nombre}\arguC{nom}
+\verb|\StrGobbleRight|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip
-Agit comme \verb|\StrGobbleLeft|, mais enlève les caractères à droite de \argu{chaine}.
+Agit comme \verb|\StrGobbleLeft|, mais enlève les \USs à droite de \argu{chaine}.
\exemple*|\StrGobbleRight{xstring}{2}|
\exemple*|\StrGobbleRight{xstring}{9}|
@@ -584,10 +571,10 @@ Agit comme \verb|\StrGobbleLeft|, mais enlève les caractères à droite de \arg
\exemple*|\StrGobbleRight{a bc def }{4}|
\subsubsection{\ttfamily\textbackslash StrRight}
-\verb|\StrRight|\etoile\ARGU{chaine}\ARGU{nombre}\arguC{nom}
+\verb|\StrRight|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip
-Agit comme \verb|\StrLeft|, mais renvoie les caractères à la droite de \argu{chaine}.
+Agit comme \verb|\StrLeft|, mais renvoie les \USs à la droite de \argu{chaine}.
\exemple*|\StrRight{xstring}{2}|
\exemple*|\StrRight{xstring}{9}|
@@ -596,14 +583,14 @@ Agit comme \verb|\StrLeft|, mais renvoie les caractères à la droite de \argu{c
\exemple*|\StrRight{a bc def }{5}|
\subsubsection{\ttfamily\textbackslash StrChar}
-\verb|\StrChar|\etoile\ARGU{chaine}\ARGU{nombre}\arguC{nom}
+\verb|\StrChar|\ARGU{chaine}\ARGU{nombre}\arguC{nom}
\smallskip
-Renvoie le caractère à la position \argu{nombre} dans la chaîne \argu{chaine}.\medskip
+Renvoie l'\US à 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é.
+ \item Si \argu{chaine} est vide, aucune \US n'est renvoyée;
+ \item Si \argu{nombre}${}\leqslant0$ ou si \argu{nombre}${}>{}$\argu{longueurChaine}, aucune \US n'est renvoyée.
\end{Conditions}
\exemple|\StrChar{xstring}{4}|
@@ -612,18 +599,18 @@ Renvoie le caractère à la position \argu{nombre} dans la chaîne \argu{chaine}
\exemple|\StrChar{a bc def }{6}|
\subsubsection{\ttfamily\textbackslash StrMid}
-\verb|\StrMid|\etoile\ARGU{chaine}\ARGU{nombreA}\ARGU{nombreB}\arguC{nom}
+\verb|\StrMid|\ARGU{chaine}\ARGU{nombre1}\ARGU{nombre2}\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
+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{nombre1} et \argu{nombre2}.\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}.
+ \item Si \argu{nombre1}${}>{}$\argu{nombre2}, alors rien n'est renvoyé;
+ \item Si \argu{nombre1}${}<1$ et \argu{nombre2}${}<1$ alors rien n'est renvoyé;
+ \item Si \argu{nombre1}${}>{}$\argu{longueurChaine} et \argu{nombre2}${}>{}$\argu{longueurChaine}, alors rien n'est renvoyé;
+ \item Si \argu{nombre1}${}<1$, alors la macro se comporte comme si \argu{nombre1}${}=1$;
+ \item Si \argu{nombre2}${}>{}$\argu{longueurChaine}, alors la macro se comporte comme si \argu{nombre2}${}={}$\argu{longueurChaine}.
\end{Conditions}
\exemple|\StrMid{xstring}{2}{5}|
@@ -636,7 +623,7 @@ Dans \argu{chaine}, renvoie la sous chaîne se trouvant entre\footnote{Au sens l
\subsection{Les macros renvoyant des nombres}
\subsubsection{\ttfamily\textbackslash StrLen}
-\verb|\StrLen|\etoile\ARGU{chaine}\arguC{nom}
+\verb|\StrLen|\ARGU{chaine}\arguC{nom}
\smallskip
Renvoie la longueur de \argu{chaine}.
@@ -646,7 +633,7 @@ Renvoie la longueur de \argu{chaine}.
\exemple|\StrLen{a bc def }|
\subsubsection{\ttfamily\textbackslash StrCount}
-\verb|\StrCount|\etoile\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
+\verb|\StrCount|\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
\smallskip
Compte combien de fois \argu{chaineA} est contenue dans \argu{chaine}.\par\medskip
@@ -661,7 +648,7 @@ Compte combien de fois \argu{chaineA} est contenue dans \argu{chaine}.\par\medsk
\exemple|\StrCount{aaaaaa}{aa}|
\subsubsection{\ttfamily\textbackslash StrPosition}
-\verb|\StrPosition|\etoile\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
+\verb|\StrPosition|\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\arguC{nom}
\smallskip
L'argument optionnel \argu{nombre} vaut 1 par défaut.\par\smallskip
@@ -690,7 +677,7 @@ Cette macro peut fonctionner avec 2 tolérances : la tolérance \guill{normale}
\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.
+ La macro compare successivement les \US 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}
@@ -728,18 +715,61 @@ Exemples en tolérance stricte :\par\comparestrict
\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é.
+La macro \verb|\fullexpandarg| est appelée par défaut, ce qui fait que certains 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
+On peut interdire le développement de ces arguments (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
+Il existe enfin un autre mode de développement de ces arguments que l'on appelle avec \verb|\expandarg|. Dans ce cas, le \textbf{premier lexème} de ces arguments est développé \emph{une fois} avant que la macro ne soit appelée. Si l'argument contient plus d'un lexème, les lexèmes qui suivent le premier ne sont pas développés (on peut contourner cette volontaire limitation et utiliser 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|.
+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|.\medskip
+
+Dans la liste ci-dessous, on peut voir en \textcolor{red}{rouge} quels arguments sont soumis à l'éventuel développement pour chaque macro vue dans le chapitre précedent :\smallskip
+
+\newcommand\colorise{\color{red}}
+\parindent3em
+\begin{itemize}
+ \item\verb|\IfSubStr|\etoile{\colorise\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfSubStrBefore|\etoile{\colorise\arguCC{nombre1}{nombre2}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfSubStrBehind|\etoile{\colorise\arguCC{nombre1}{nombre2}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfBeginWith|\etoile{\colorise\ARGU{chaine}\ARGU{chaineA}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfEndWith|\etoile{\colorise\ARGU{chaine}\ARGU{chaineA}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfInteger|{\colorise\ARGU{nombre}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfDecimal|{\colorise\ARGU{nombre}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfStrEq|\etoile{\colorise\ARGU{chaineA}\ARGU{chaineB}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfEq|\etoile{\colorise\ARGU{chaineA}\ARGU{chaineB}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfStrEqCase|\etoile{\colorise\ARGU{chaine}\texttt{\color{black}\{}\colorise\ARGU{chaine1}}\ARGU{code1}\par
+ \setbox0=\hbox{{\ttfamily\string\IfStrEqCase}\etoile\ARGU{chaine}{\ttfamily\{}}
+ \hskip\wd0{\colorise\ARGU{chaine2}}\ARGU{code2}\par
+ \hskip\wd0\ \ldots\par
+ \hskip\wd0{\colorise\ARGU{chaine $n$}}\ARGU{code $n$}\verb|}|\arguC{code alternatif}
+ \item\verb|\IfEqCase|\etoile{\colorise\ARGU{chaine}\texttt{\color{black}\{}\colorise\ARGU{chaine1}}\ARGU{code1}\par
+ \setbox0=\hbox{{\ttfamily\string\IfEqCase}\etoile\ARGU{chaine}{\ttfamily\{}}
+ \hskip\wd0{\colorise\ARGU{chaine2}}\ARGU{code2}\par
+ \hskip\wd0\ \ldots\par
+ \hskip\wd0{\colorise\ARGU{chaine $n$}}\ARGU{code $n$}\verb|}|\arguC{code alternatif}
+ \item\verb|\StrBefore|\etoile{\colorise\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}}\arguC{nom}
+ \item\verb|\StrBehind|\etoile{\colorise\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}}\arguC{nom}
+ \item\verb|\StrBetween|\etoile{\colorise\arguCC{nombre1}{nombre2}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}}\arguC{nom}
+ \item\verb|\StrSubstitute|{\colorise\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}}\arguC{nom}
+ \item\verb|\StrDel|{\colorise\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}}\arguC{nom}
+ \item\verb|\StrSplit|{\colorise\ARGU{chaine}\ARGU{nombre}}\ARGU{chaineA}\ARGU{chaineB}\qquad{\small(voir page~\pageref{StrSplit} pour la macro \verb|StrSplit|)}
+ \item\verb|\StrGobbleLeft|{\colorise\ARGU{chaine}\ARGU{nombre}}\arguC{nom}
+ \item\verb|\StrLeft|{\colorise\ARGU{chaine}\ARGU{nombre}}\arguC{nom}
+ \item\verb|\StrGobbleRight|{\colorise\ARGU{chaine}\ARGU{nombre}}\arguC{nom}
+ \item\verb|\StrRight|{\colorise\ARGU{chaine}\ARGU{nombre}}\arguC{nom}
+ \item\verb|\StrChar|{\colorise\ARGU{chaine}\ARGU{nombre}}\arguC{nom}
+ \item\verb|\StrMid|{\colorise\ARGU{chaine}\ARGU{nombre1}\ARGU{nombre2}}\arguC{nom}
+ \item\verb|\StrLen|{\colorise\ARGU{chaine}}\arguC{nom}
+ \item\verb|\StrCount|{\colorise\ARGU{chaine}\ARGU{chaineA}}\arguC{nom}
+ \item\verb|\StrPosition|{\colorise\arguC{nombre}\ARGU{chaine}\ARGU{chaineA}}\arguC{nom}
+ \item\verb|\StrCompare|{\colorise\ARGU{chaineA}\ARGU{chaineB}}\arguC{nom}
+\end{itemize}
+\parindent0pt
\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
+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
@@ -753,16 +783,16 @@ Lorsque le mode \verb|\fullexpandarg| est activé, les arguments sont évalués
\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.
+En revanche, sous UTF8, 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
+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.\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
+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 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
@@ -775,14 +805,14 @@ Et cette imbrication non permise censée enlever le premier et le dernier caract
\hspace{0.2\linewidth}\verb|\StrGobbleRight{xstring}{1}[\machaine]|\par
\hspace{0.2\linewidth}\verb|\StrGobbleleft{\machaine}{1}|\par
-\subsection{Lecture des arguments}
+\subsection{Traitement 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
+\subsubsection{Traitement à l'\US prés}
+Les macros de \Xstring traitent les arguments \US par \US. Dans le code \TeX{}, une \US\footnote{Pour les utilisateurs familiers avec la programmation \LaTeX, une \US est ce qui est supprimé par la macro \texttt{\string\@gobble} dont le code, d'une grande simplicité, est :\quad{\ttfamily\string\def\string\@gobble\string#1\string{\string}}} 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 groupe, c'est à dire une suite de lexèmes 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
@@ -812,10 +842,10 @@ Que va t-il arriver si l'on se place sous \verb|\noexpandarg| et que l'on demand
\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.
+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 ---~les accolades ici. 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.
+Par défaut, la commande \verb|\noexploregroups| est appelée et donc dans l'argument à examiner qui contient la chaîne de lexèmes, \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
@@ -862,26 +892,23 @@ Voyons ce que cela signifie sur un exemple : mettons que l'on veuille renvoyer c
\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.
+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|\IfEq| 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}
+\subsection{Catcodes et 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
+Les macros de \Xstring tiennent compte des catcodes des lexèmes constituant les arguments. Il faut donc garder à l'esprit, particulièrement lors des tests, que les lexèmes \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
+ne se développent pas en 2 arguments égaux aux 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. Ces primitives sont par exemple : \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
+Pour demander aux macros de ne pas tenir compte des catcodes, on peut utiliser les macros étoilées. Après l'éventuel développement des arguments en accord avec le mode de développement, celles-ci convertissent (à l'aide d'un \verb|\detokenize|) leur 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. Il faut noter que les arguments optionnels ne sont pas concernés par ces modifications et gardent leur catcode.\smallskip
Voici un exemple :\par\smallskip
\begin{minipage}[r]{0.6\linewidth}
@@ -897,12 +924,214 @@ Voici un exemple :\par\smallskip
\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
+Les chaînes n'étant pas égales à cause des catcodes, le test est bien \emph{négatif} dans la version non étoilée.\bigskip
+
+\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
+
+Ainsi, 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{}.\medskip
+
+Les macros détokenisant leur arguments par l'utilisation de l'étoile sont présentées dans la liste ci-dessous. Pour chacune d'entre elles, on peut voir en \textcolor{red}{rouge} quels arguments seront détokenisé lorsque l'étoile sera employée :\smallskip
+
+\parindent3em
+\begin{itemize}
+ \item\verb|\IfSubStr|\etoile\arguC{nombre}{\colorise\ARGU{chaine}\ARGU{chaineA}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfSubStrBefore|\etoile\arguCC{nombre1}{nombre2}{\colorise\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfSubStrBehind|\etoile\arguCC{nombre1}{nombre2}{\colorise\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfBeginWith|\etoile{\colorise\ARGU{chaine}\ARGU{chaineA}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfEndWith|\etoile{\colorise\ARGU{chaine}\ARGU{chaineA}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfStrEq|\etoile{\colorise\ARGU{chaineA}\ARGU{chaineB}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfEq|\etoile{\colorise\ARGU{chaineA}\ARGU{chaineB}}\ARGU{vrai}\ARGU{faux}
+ \item\verb|\IfStrEqCase|\etoile{\colorise\ARGU{chaine}\texttt{\color{black}\{}\colorise\ARGU{chaine1}}\ARGU{code1}\par
+ \setbox0=\hbox{{\ttfamily\string\IfStrEqCase}\etoile\ARGU{chaine}{\ttfamily\{}}
+ \hskip\wd0{\colorise\ARGU{chaine2}}\ARGU{code2}\par
+ \hskip\wd0\ \ldots\par
+ \hskip\wd0{\colorise\ARGU{chaine $n$}}\ARGU{code $n$}\verb|}|\arguC{code alternatif}
+ \item\verb|\IfEqCase|\etoile{\colorise\ARGU{chaine}\texttt{\color{black}\{}\colorise\ARGU{chaine1}}\ARGU{code1}\par
+ \setbox0=\hbox{{\ttfamily\string\IfEqCase}\etoile\ARGU{chaine}{\ttfamily\{}}
+ \hskip\wd0{\colorise\ARGU{chaine2}}\ARGU{code2}\par
+ \hskip\wd0\ \ldots\par
+ \hskip\wd0{\colorise\ARGU{chaine $n$}}\ARGU{code $n$}\verb|}|\arguC{code alternatif}
+ \item\verb|\StrBefore|\etoile\arguC{nombre}{\colorise\ARGU{chaine}\ARGU{chaineA}}\arguC{nom}
+ \item\verb|\StrBehind|\etoile\arguC{nombre}{\colorise\ARGU{chaine}\ARGU{chaineA}}\arguC{nom}
+ \item\verb|\StrBetween|\etoile\arguCC{nombre1}{nombre2}{\colorise\ARGU{chaine}\ARGU{chaineA}\ARGU{chaineB}}\arguC{nom}
+ \item\verb|\StrCompare|\etoile{\colorise\ARGU{chaineA}\ARGU{chaineB}}\arguC{nom}
+\end{itemize}
+\parindent0pt
+
+\section{Macros avancées 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 les macros décritesz précédemment ne suffisent pas. Ce chapitre présente d'autres macros qui permettent d'aller plus loin ou de contourner certaines limitations.
+\subsection{Recherche d'un groupe, les macros {\ttfamily\textbackslash StrFindGroup} et {\ttfamily\textbackslash groupID}}
+Lorsque le mode \verb=\exploregroups= est actif, la macro \verb=\StrFindGroup= permet de trouver un groupe entre accolades explicites en spécifiant son identifiant :\smallskip
-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{}.
+\verb|\StrFindGroup|\ARGU{argument}\ARGU{identifiant}\arguC{nom}\medskip
-\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.
+Lorsque le groupe caractérisé par l'identifiant n'existe pas, une chaîne vide sera assignée à la séquence de contrôle \argu{nom}. Si le groupe existe, ce groupe \emph{avec ses accolades} sera assigné à \argu{nom}.\smallskip
+
+Cet identifiant est une suite d'entiers séparés par des virgules caractérisant le groupe cherché dans l'argument. Le premier entier est le $n$\ieme{} groupe (d'imbrication 1) dans lequel est le groupe cherché. Puis, en se plaçant dans ce groupe, le 2\ieme{} entier est le $n$\ieme{} groupe dans lequel est le groupe cherché. Et ainsi de suite jusqu'à ce que l'imbrication du groupe soit atteinte.\bigskip
+
+Prenons par exemple l'argument suivant où l'on a 3 niveaux d'imbrication de groupes. Pour plus de clarté, les accolades délimitant les groupes sont colorées en rouge pour l'imbrication de niveau 1, en bleu pour le niveau 2 et en vert pour le niveau 3. Les groupes dans chaque imbrication sont ensuite numérotés selon la règle décrite ci-dessus :
+\begingroup
+ \def\AccO#1{\text{\color{#1}\ttfamily\{}}
+ \def\AccF#1{\text{\color{#1}\ttfamily\}}}
+ \def\texte#1{\text{\texttt{\color{black}#1}}}
+ \def\decalbrace{\vphantom{\underbrace{A}_A}}
+ \[\texte{a}{\color{red}\underbrace{\AccO{red}{\color{blue}\underbrace{\decalbrace\AccO{blue}\texte{bc}\AccF{blue}}_{\color{blue}1}}\texte{d}{\color{blue}\underbrace{\decalbrace\AccO{blue}\texte{efg}\AccF{blue}}_{\color{blue}2}}\AccF{red}}_{\color{red}1}}\texte{h}{\color{red}\underbrace{\AccO{red}{\color{blue}\underbrace{\decalbrace\AccO{blue}\texte{ij}\AccF{blue}}_{\color{blue}1}}{\color{blue}\underbrace{\decalbrace\AccO{blue}\texte{k}\AccF{blue}}_{\color{blue}2}}{\color{blue}\underbrace{\AccO{blue}\texte{l}{\color{green}\underbrace{\AccO{green}\texte{m}\AccF{green}}_{\color{green}1}}{\color{green}\underbrace{\AccO{green}\texte{no}\AccF{green}}_{\color{green}2}}\AccF{blue}}_{\color{blue}3}}\texte{p}\AccF{red}}_{\color{red}2}}\]
+\endgroup
+\smallskip
+Dans cet exemple :\parindent3em
+\begin{itemize}
+ \item le groupe \verb={{bc}d{efg}}= a donc pour identifiant \texttt{\color{red}1};
+ \item le groupe \verb={ij}= a pour identifiant \texttt{{\color{red}2},\color{blue}1};
+ \item le groupe \verb={no}= a pour identifiant \texttt{{\color{red}2},{\color{blue}3},\color{green}2};
+ \item l'argument dans sa totalité \og\verb=a{{bc}d{efg}}h{{ij}{k}{l{m}{no}}p}=\fg{} a pour identifiant \verb=0=, seul cas où l'entier 0 est contenu dans l'identifiant d'un groupe.
+\end{itemize}
+\parindent0pt
+\medskip
+
+Voici l'exemple complet :\smallskip
+
+\begin{minipage}[r]{0.6\linewidth}
+\hfill
+\begin{boxedverbatim}
+ \exploregroups
+ \expandarg
+ \def\chaine{a{{bc}d{efg}}h{{ij}{k}{l{m}{no}}p}}
+ \StrFindGroup{\chaine}{1}[\mongroupe]
+ \meaning\mongroupe\par
+ \StrFindGroup{\chaine}{2,1}[\mongroupe]
+ \meaning\mongroupe\par
+ \StrFindGroup{\chaine}{2,3,2}[\mongroupe]
+ \meaning\mongroupe\par
+ \StrFindGroup{\chaine}{2,5}[\mongroupe]
+ \meaning\mongroupe\par
+\end{boxedverbatim}
+\hspace*{0.3cm}
+\end{minipage}%
+\begin{minipage}[r]{0.3\linewidth}
+ \exploregroups
+ \expandarg
+ \def\chaine{a{{bc}d{efg}}h{{ij}{k}{l{m}{no}}p}}
+ \StrFindGroup{\chaine}{1}[\mongroupe]
+ \meaning\mongroupe\par
+ \StrFindGroup{\chaine}{2,1}[\mongroupe]
+ \meaning\mongroupe\par
+ \StrFindGroup{\chaine}{2,3,2}[\mongroupe]
+ \meaning\mongroupe\par
+ \StrFindGroup{\chaine}{2,5}[\mongroupe]
+ \meaning\mongroupe\par
+\end{minipage}
+\bigskip
+
+Le processus inverse existe, et plusieurs macros de \Xstring donnent aussi comme information l'identifiant du groupe dans lequel elles ont fait une coupure ou trouvé une recherche. Ces macros sont : \verb|\IfSubStr|, \verb|\StrBefore|, \verb|\StrBehind|, \verb|\StrSplit|, \verb|\StrLeft|, \verb|\StrGobbleLeft|, \verb|\StrRight|, \verb|\StrGobbleRight|, \verb|\StrChar|, \verb|\StrPosition|.\medskip
+
+Après l'appel à ces macros, la commande \verb|\groupID| se développe en l'identifiant du groupe dans lequel la coupure s'est faite ou la recherche d'un argument a abouti. Lorsque la coupure ne peut avoir lieu ou que la recherche n'a pas abouti, \verb|\groupID| est vide. Évidemment, l'utilisation de \verb|\groupID| n'a de sens que lorsque le mode \verb|\exploregroups| est actif, et quand les macros ne sont pas étoilées.\smallskip
+
+Voici quelques exemples avec la macro \verb|\StrChar| :\smallskip
+
+\begin{minipage}[r]{0.6\linewidth}
+\hfill
+\begin{boxedverbatim}
+ \exploregroups
+ char no 1 = \StrChar{a{b{cd}{e{f}g}h}ijkl}{1}\qquad
+ \string\groupID = \groupID\par
+ char no 4 = \StrChar{a{b{cd}{e{f}g}h}ijkl}{4}\qquad
+ \string\groupID = \groupID\par
+ char no 6 = \StrChar{a{b{cd}{e{f}g}h}ijkl}{6}\qquad
+ \string\groupID = \groupID\par
+ char no 20 = \StrChar{a{b{cd}{e{f}g}h}ijkl}{20}\qquad
+ \string\groupID = \groupID
+\end{boxedverbatim}
+\hspace*{0.3cm}
+\end{minipage}%
+\begin{minipage}[r]{0.3\linewidth}
+ \exploregroups
+ char no 1 = \StrChar{a{b{cd}{e{f}g}h}ijkl}{1}\qquad
+ \string\groupID = \groupID\par
+ char no 4 = \StrChar{a{b{cd}{e{f}g}h}ijkl}{4}\qquad
+ \string\groupID = \groupID\par
+ char no 6 = \StrChar{a{b{cd}{e{f}g}h}ijkl}{6}\qquad
+ \string\groupID = \groupID\par
+ char no 20 = \StrChar{a{b{cd}{e{f}g}h}ijkl}{20}\qquad
+ \string\groupID = \groupID
+\end{minipage}
+
+\subsection{Coupure d'une chaîne, la macro {\ttfamily\textbackslash StrSplit}}
+\label{StrSplit}
+Voici la syntaxe de cette macro :\smallskip
+
+\verb|\StrSplit|\ARGU{chaine}\ARGU{nombre}\ARGU{chaineA}\ARGU{chaineB}
+\smallskip
+
+La \argu{chaine}, est coupée en deux chaînes juste après l'\US 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 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{|}\medskip
+
+Lorsque l'exploration des groupes est activée, et que l'on demande une coupure en fin de groupe, alors une chaîne contiendra la totalité du groupe tansque l'autre sera vide comme on le voit sur cet exemple :\smallskip
+
+\begin{minipage}[r]{0.6\linewidth}
+\hfill
+\begin{boxedverbatim}
+ \exploregroups
+ \StrSplit{ab{cd{ef}gh}ij}{6}\strA\strB
+ \meaning\strA\par
+ \meaning\strB
+\end{boxedverbatim}
+\hspace*{0.3cm}
+\end{minipage}%
+\begin{minipage}[r]{0.3\linewidth}
+ \exploregroups
+ \StrSplit{ab{cd{ef}gh}ij}{6}\strA\strB
+ \meaning\strA\par
+ \meaning\strB
+\end{minipage}
+\medskip
+
+Une version étoilée de cette macro existe : dans ce cas, la coupure se fait juste avant la prochaine \US qui suit l'\US désirée. La version étoilée ne donne des résultats différents de la version normale que lorsque la $n$\ieme{} \US est à la fin d'un groupe auquel cas, la coupure intervient non pas après cette \US mais \emph{avant} la prochaine \US, que \verb|StrSplit| atteint en fermant autant de groupes que nécessaire.\smallskip
+
+\begin{minipage}[r]{0.6\linewidth}
+\hfill
+\begin{boxedverbatim}
+ \exploregroups
+ Macro non étoilée :\par
+ \StrSplit{ab{cd{ef}gh}ij}{6}\strA\strB
+ \meaning\strA\par
+ \meaning\strB\par
+ \string\groupID = \groupID\par
+ Macro étoilée :\par
+ \StrSplit*{ab{cd{ef}gh}ij}{6}\strA\strB
+ \meaning\strA\par
+ \meaning\strB\par
+ \string\groupID\ = \groupID
+\end{boxedverbatim}
+\hspace*{0.3cm}
+\end{minipage}%
+\begin{minipage}[r]{0.3\linewidth}
+ \exploregroups
+ Macro non étoilée :\par
+ \StrSplit{ab{cd{ef}gh}ij}{6}\strA\strB
+ \meaning\strA\par
+ \meaning\strB\par
+ \string\groupID = \groupID\par
+ Macro étoilée :\par
+ \StrSplit*{ab{cd{ef}gh}ij}{6}\strA\strB
+ \meaning\strA\par
+ \meaning\strB\par
+ \string\groupID\ = \groupID
+\end{minipage}
\subsection{Assigner un contenu verb, la macro \ttfamily\textbackslash verbtocs}
\label{verbtocs}
@@ -913,10 +1142,10 @@ La macro \verb|\verbtocs| permet le lire le contenu d'un \guill{verb} qui peut c
\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
+Par défaut, le lexème délimitant le contenu verb est \guill{|}, étant entendu que ce lexème 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 lexème délimitant le contenu verb par la macro :\par\medskip
+\hfill\verb|\setverbdelim|\ARGU{lexème}\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
+Tout \argu{lexème} peut être utilisé\footnote{Plusieurs lexèmes 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 lexèmes.}.\medskip
Concernant ces arguments verb, il faut tenir compte des deux points suivants :
\begin{itemize}
@@ -945,7 +1174,7 @@ Le processus inverse de ce qui a été vu au dessus consiste à interpréter une
\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
+\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 lexèmes 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}
@@ -1077,7 +1306,7 @@ Dans l'exemple artificiel\footnote{On peut agir beaucoup plus simplement en util
\newcommand\bracearg[1]{%
\def\text{#1}%
\scancs*{\result}{\Ob\text\Cb}%
- result%
+ \result%
}
\bracearg{xstring}\par
\bracearg{\a}
@@ -1103,14 +1332,15 @@ On peut utiliser la macro \verb|\StrRemoveBraces| dont voici la syntaxe :\smalls
\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
+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 bas niveau avec \verb|\noexploregroups|.\medskip
+\vbox{%
\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|
+\exemple|\meaning\mycs|}
\subsection{Exemples d'utilisation en programmation}
\label{exemples}
@@ -1155,6 +1385,64 @@ Ainsi, \verb|\empty| est développée en \guill{rien} et il reste dans les 2 der
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}
+On cherche ici à écrire une commande qui efface \verb|n| unités syntaxiques dans une chaîne à partir d'une position donnée, et affecte le résultat dans une séquence de contrôle dont on peut choisir le nom.
+
+On va appeler cette macro \verb|StringDel| et lui donner la syntaxe :
+
+\hfil\verb|\StringDel{chaine}{position}{n}{\nom_resultat}|\hfil{}
+\medskip
+
+On peut procéder ainsi : prendre la chaîne se trouvant juste avant la position, la sauvegarder. Ensuite enlever \verb|n + position| \USs à la chaîne, et concaténer ce résultat à ce qui a été sauvegardé auparavant. Cela donne le code suivant :\medskip
+
+\begin{minipage}[r]{0.7\linewidth}
+ \hfill
+ \begin{boxedverbatim}
+ \newcommand\StringDel[4]{%
+ \begingroup
+ \expandarg% portée locale au groupe
+ \StrLeft{\empty#1}{\number\numexpr#2-1}[#4]%
+ \StrGobbleLeft{\empty#1}{\number\numexpr#2+#3-1}[\StrA]%
+ \expandafter\expandafter\expandafter\endgroup
+ \expandafter\expandafter\expandafter\def
+ \expandafter\expandafter\expandafter#4%
+ \expandafter\expandafter\expandafter{\expandafter#4\StrA}%
+ }
+
+ \noexploregroups
+ \StringDel{abcdefgh}{2}{3}{\cmd}
+ \meaning\cmd
+
+ \StringDel{a\textbf{1}b\textbf{2c}3d}{3}{4}{\cmd}
+ \meaning\cmd
+ \end{boxedverbatim}
+ \hspace*{0.3cm}
+\end{minipage}%
+\begin{minipage}[r]{0.3\linewidth}
+ \newcommand\StringDel[4]{%
+ \begingroup
+ \expandarg% portée locale au groupe
+ \StrLeft{\empty#1}{\number\numexpr#2-1}[#4]%
+ \StrGobbleLeft{\empty#1}{\number\numexpr#2+#3-1}[\StrA]%
+ \expandafter\expandafter\expandafter\endgroup
+ \expandafter\expandafter\expandafter\def
+ \expandafter\expandafter\expandafter#4%
+ \expandafter\expandafter\expandafter{\expandafter#4\StrA}%
+ }
+
+ \noexploregroups
+ \StringDel{abcdefgh}{2}{3}{\cmd}
+ \meaning\cmd
+
+ \StringDel{a\textbf{1}b\textbf{2c}3d}{3}{4}{\cmd}
+ \meaning\cmd
+\end{minipage}\fullexpandarg
+\bigskip
+
+Pour la concaténation, on aurait pu procéder différemment en utilisant la macro \verb|\g@addto@macro| de \LaTeX{}. Cela évite aussi de laborieux \guill{ponts} d'\verb|\expandafter|. Il suffit alors de remplacer l'assignation par\footnote{À condition d'avoir provisoirement changé le code de catégorie de \og{\ttfamily\string@}\fg{} en écrivant la macro entre les commandes {\ttfamily\string\makeatletter} et {\ttfamily\string\makeatother}} :\smallskip
+
+\hfil\verb|\expandafter\g@addto@macro\expandafter#4\expandafter{\StrA}\endgroup|\hfil{}
+
+\subsubsection{Exemple 3}
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
@@ -1187,10 +1475,10 @@ Tout d'abord, annulons le développement des arguments avec \verb|\noexpandarg|
\tofrac{x+\sqrt{x}/\sqrt{x^2+x+1}}
\end{minipage}\fullexpandarg
-\subsubsection{Exemple 3}
+\subsubsection{Exemple 4}
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
+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\}\}}\newline De cette façon, 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
@@ -1227,7 +1515,7 @@ On va écrire une macro \verb|\grasapres| qui effectue ce travail. On appelle \v
\grasapres{Le package xstring est nouveau}{est}
\end{minipage}\fullexpandarg
-\subsubsection{Exemple 4}
+\subsubsection{Exemple 5}
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
@@ -1269,96 +1557,41 @@ Cette fois ci, on ne peut pas chercher le seul caractère \og\verb|\|\fg{} (de 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
+\subsubsection{Exemple 6}
+Dans une chaîne, on cherche ici à isoler le n\ieme{} mot se trouvant entre 2 délimiteurs précis. Pour cela on écrira une macro \verb|\findword| admettant comme argument optionnel le délimiteur de mot (l'espace par défaut), 1 argument contenant la chaîne, 1 argument contenant le nombre correspondant au n\ieme{} mot cheché.\medskip
+
+La macro \verb|\findword| utilise \verb|\StrBetween| et \verb|\numexpr| de façon astucieuse :\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}
+ \newcommand\findword[3][ ]{%
+ \StrBetween[#3,\numexpr#3+1]{#1#2#1}{#1}{#1}}
+ \noexpandarg
+ |\findword{a bc d\textit{e f} gh}{3}|
+
+ |\findword[\@nil]{1 \@nil 2 3 \@nil4\@nil}{2}|
\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
+ \newcommand\findword[3][ ]{%
+ \StrBetween[#3,\numexpr#3+1]{#1#2#1}{#1}{#1}}
+ \noexpandarg
+ |\findword{a bc d\textit{e f} gh}{3}|
-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}
+ |\findword[\@nil]{1 \@nil 2 3 \@nil4\@nil}{2}|
+\end{minipage}
+\bigskip\bigskip
\begin{center}
$\star$\par
$\star$\quad$\star$
\end{center}
-\vspace{10pt}
+\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
+Merci de me signaler par \href{mailto:unbonpetit@gmail.com}{email} tout bug ou toute proposition d'amélioration\ldots\medskip
Christian Tellechea
\end{document} \ No newline at end of file