Difference between revisions of "System Macros/Expansion Control"

From ConTeXt wiki
Jump to navigationJump to search
(→‎Preventing expansion: link to mkiv source)
m (typo)
 
(3 intermediate revisions by 3 users not shown)
Line 23: Line 23:
 
</texcode>
 
</texcode>
  
The two commands <code>\expandoneargafter</code> and <code>\expandtwoargsafter</code> make macros more readable by hiding a lot of <code>\expandafter</code>'s. They expand the arguments after the first command.
+
The two commands <code>\expandoneargafter</code> and <code>\expandtwoargsafter</code> make macros more readable by hiding a lot of <code>\expandafter</code>'s. They first expand the arguments that follow the command, then the command.
  
 
<texcode>
 
<texcode>
Line 32: Line 32:
 
</texcode>
 
</texcode>
  
These commands expect the arguments to be macros, the \type{\full} versions do a ''deep expansion''.
+
These commands expect the arguments to be macros, the <code>\full...</code> versions do a ''deep expansion''.
  
 
=== Expanding all arguments ===
 
=== Expanding all arguments ===
Line 60: Line 60:
 
This will prevent the macro from being expanded in places where no typesetting occurs, like when strings are written to the tuo file.
 
This will prevent the macro from being expanded in places where no typesetting occurs, like when strings are written to the tuo file.
  
Expansion problems can get quite complex. There are some other internal macros that can help harnassing it, but it is fairly unlikely that you will need them. If you believe you do, read the [[source:syst-gen.tex| syst-gen.tex]] ([[source:syst-aux.mkiv|syst-aux.mkiv]] for MkIV) source code.
+
Expansion problems can get quite complex. There are some other internal macros that can help harnassing it, but it is fairly unlikely that you will need them. If you believe you do, read the [[source:syst-gen.mkii| syst-gen.mkii]] ([[source:syst-aux.mkiv|syst-aux.mkiv]] for MkIV) source code.
  
 
< '''Prev:''' [[System Macros/Scratch Variables|Scratch Variables]] | '''Top:''' [[System Macros]] | '''Next:''' [[System Macros/Handling Arguments|Handling Arguments]] >
 
< '''Prev:''' [[System Macros/Scratch Variables|Scratch Variables]] | '''Top:''' [[System Macros]] | '''Next:''' [[System Macros/Handling Arguments|Handling Arguments]] >

Latest revision as of 11:10, 24 September 2010

< Prev: Scratch Variables | Top: System Macros | Next: Handling Arguments >

Expansion control macro shortcuts

When in unprotected mode, to be entered with \unprotect, one can use \@NX as equivalent of \noexpand, and \@EA as equivalent of \expandafter. \@EAEA expands to two expandafters, \@EAEAEA to three, and \@EAEAEAEAEA expands to \@EA\@EAEAEA\@EA. At first sight, these macros are simply shortcuts that are a bit easier to type and read, but there is a bit more to it. Here is an example where \@EA\@EAEAEA\@EA is not the same as five \expandafters in a row:

\def\complexdoblank
  {\flushnotes
   \ifmmode
     \@EA\nocomplexdoblank
   \else
     \ifopelkaar
       \ifinpagebody
         \@EA\@EAEAEA\@EA\docomplexdoblank
       \else
         \@EA\@EAEAEA\@EA\nocomplexdoblank
       \fi
     \else
       \@EAEAEA\docomplexdoblank
     \fi
   \fi}

The two commands \expandoneargafter and \expandtwoargsafter make macros more readable by hiding a lot of \expandafter's. They first expand the arguments that follow the command, then the command.

\expandoneargafter \command{\abc}
\expandtwoargsafter\command{\abc}{\def}
\fullexpandoneargafter \command{\abc}
\fullexpandtwoargsafter\command{\abc}{\def}

These commands expect the arguments to be macros, the \full... versions do a deep expansion.

Expanding all arguments

Sometimes we pass macros as arguments to commands that don't expand them before interpretation. Such commands can be enclosed by \expanded, like:

\expanded{\setupsomething[\alfa]}

Such situations occur for instance when \alfa is a commalist or when data stored in macros is fed to indexing or list generation commands. If needed, one could use \noexpand inside the argument, but some very often occuring problems with expansion (like accents) are intercepted by a somewhat smarter version with the same basic functionality:

\safeexpanded{\bookmark{\alfa}}

The \safe... form is actually so useful that there are safe versions of \edef and \xdef avialable: \safeedef and \safexdef (only usable for definitions that do not need arguments).

Preventing expansion

When expansion of a macro gives problems we can precede it by \unexpanded, like so:

\unexpanded\def\somecommand{... ... ...}

This will prevent the macro from being expanded in places where no typesetting occurs, like when strings are written to the tuo file.

Expansion problems can get quite complex. There are some other internal macros that can help harnassing it, but it is fairly unlikely that you will need them. If you believe you do, read the syst-gen.mkii (syst-aux.mkiv for MkIV) source code.

< Prev: Scratch Variables | Top: System Macros | Next: Handling Arguments >