Comment définir des arguments optionnels comme ceux de \section ?

On présentera quelques méthodes traditionnelles, avant de se tourner vers la commande \NewDocumentCommand désormais incluse dans le noyau de \LaTeX, qui fournit une syntaxe ad hoc.

Avec \newcommand

Les arguments optionnels des macros définies avec \newcommand ne fonctionnent pas vraiment comme l'argument optionnel de \section. En effet, la valeur par défaut de l'argument optionnel de \section est celle de l'argument obligatoire donnée par l'utilisateur ; au contraire, \newcommand exige que vous déterminiez la valeur de l'argument par défaut au moment où vous définissez la commande.

L'astuce requise consiste à utiliser une macro dans l'argument optionnel :

\documentclass{article}
 
\newcommand\thing[2][\DefaultOpt]{%
  \def\DefaultOpt{#2}%
  optional arg: #1,  mandatory arg: #2%
}
 
\begin{document}
\thing{manda}% #1=#2
 
\thing[opti]{manda}% #1="opti"
\end{document}

\documentclass{article}

\newcommand\thing[2][\DefaultOpt]{%
  \def\DefaultOpt{#2}%
  optional arg: #1,  mandatory arg: #2%
}

\begin{document}
\thispagestyle{empty}
\thing{manda}% #1=#2

\thing[opti]{manda}% #1="opti"
\end{document}

Le code source de \LaTeX utilise une méthode plus subtile : il utilise une macro \@dblarg. Voici comment l'exemple précédent aurait été écrit dans LaTeX :

\makeatletter
\newcommand\thing{\@dblarg\@thing}
\newcommand\@thing[2][\@error]{%
  optional arg: #1,  mandatory arg: #2%
}
\makeatother

Dans ce code, \@thing n'est jamais appelé qu'avec un argument optionnel et un argument obligatoire ; si la valeur par défaut de la \newcommand est appelée, un bug apparaît dans le code utilisateur…

typ o

Avec \NewDocumentCommand

La macro \NewDocumentCommand, autrefois fournie par l'extension xparse et intégrée dans le cœur de \LaTeX depuis 2020, fournit une syntaxe qui permet de définir les commandes de manière flexible. On peut ainsi redéfinir la commande \thing ci-dessus :

\NewDocumentCommand\thing{o m}{%
  argument optionnel entre crochets : #1,  argument obligatoire : #2%
}

o indique un argument optionnel et m un argument obligatoire (mandatory). Chaque argument peut être rendu long en préfixant le caractère d'un +.

On peut indiquer une valeur par défaut de la manière suivante :

\NewDocumentCommand\thing{O{valeur par défaut} m}{%
  argument optionnel entre crochets : #1,  argument obligatoire : #2%
}

Il est même possible d'indiquer plus d'un argument entre crochets, auquel cas l'utilisateur ne pourra pas définir le second sans avoir défini le premier (noter que [] produit un argument vide, pas l'argument par défaut) :

\NewDocumentCommand\thing{
  O{valeur par défaut}
  O{un autre défaut} 
  m
}{%
  premier argument optionnel entre crochets : \textbf{#1}\\
  second argument optionnel entre crochets : \textbf{#2}\\
  argument obligatoire : \textbf{#3}
}
 
\thing[le premier argument]{%
  j'ai défini le premier argument entre crochets mais 
  pas le second}
 
\thing[le premier argument][le second argument]{%
  j'ai défini les deux arguments optionnels}
 
\thing[][le second argument]{le premier argument 
  est vide}
 
\thing[valeur par défaut][le second argument]{%
  pour obtenir la valeur par défaut du premier 
  argument et définir le second argument, j'ai
  dû indiquer explicitement la valeur par défaut}

\documentclass{article}
\thispagestyle{empty}
\setlength{\parskip}{10pt}
\setlength{\parindent}{0pt}
\def\thing[#1][#2]#3{%
  premier argument optionnel entre crochets : \textbf{#1}\\
  second argument optionnel entre crochets : \textbf{#2}\\
  argument obligatoire : \textbf{#3} }

\begin{document}

\thing[le premier argument][un autre défaut]{j'ai défini le premier argument entre crochets mais pas le second}

\thing[le premier argument][le second argument]{j'ai défini les deux arguments optionnels}

\thing[][le second argument]{le premier argument est vide}

\thing[valeur par défaut][le second argument]{pour obtenir la valeur par défaut du premier argument et définir le second argument, j'ai dû indiquer explicitement la valeur par défaut}

\end{document}

Sources :

2_programmation/macros/arguments_optionnels_comme_pour_section.txt · Dernière modification: 2021/10/21 13:50 par bdumont
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0