summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/exp-testopt/exp-testopt.dtx
blob: 6cefe7715ae4d6a044468b4920f2106948ccfb1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
% \iffalse meta-comment
%
%%  (C) 2008 Paul Ebermann
%%
%%   Package exp-testopt - expandible testopt-Variante.
%%
%%   Die Datei exp-testopt.dtx sowie die dazugehörige
%%   exp-testopt.ins sowie die damit generierte
%%   exp-testopt.sty stehen unter der
%%   "LaTeX Project Public License" (LPPL, zu finden
%%   unter http://www.latex-project.org/lppl/, sowie
%%   auch in den meisten TeX-Distributionen in
%%   texmf/docs/latex/base/lppl*.txt), Version 1.3b oder
%%   später (nach Wahl des Verwenders).
%%
%%   Der 'maintenance-status' ist (zur Zeit) 'author-maintained'.
%%   
%%   Das heißt u.a., die Dateien dürfen frei vertrieben werden,
%%   bei Änderungen (durch andere Personen als Paul Ebermann)
%%   ist aber der Name der Datei zu ändern.
%
% \fi
%
% \iffalse
% ---------------------------------------------
%<package>\NeedsTeXFormat{LaTeX2e}[2005/12/01]%
% ----------------------------________________-----------------
%<package>\ProvidesPackage{exp-testopt}[2009/03/06 v0.3  (PE)]
% ----------------------------________________-----------------
% \fi
%
% \iffalse
%<*driver>
\PassOptionsToClass{draft}{scrartcl}
\documentclass{scrartcl}
%
% Esperantajn tekstojn oni prefere entajpu per unikodaj literoj.
\usepackage[utf8x]{inputenc}
\usepackage[esperanto]{babel}

\addto{\extrasesperanto}{%
  \renewcommand*{\generalname}{\^Generale}%
  \GlossaryPrologue{%
    \section{\^San\^goj}%
  }%
  \GlossaryMin=3\baselineskip
  \IndexPrologue{%
    \section{Indekso}
    Kurzivaj nombroj indikas la lokojn, kie la indeks-ero estas priskribita,
    substrekitaj nombroj indikas la lokon de la difino, la aliaj estas uzoj.
  }
  \IndexMin=5\baselineskip
}


\usepackage[svgnames]{xcolor}

\usepackage{exp-testopt}

\usepackage[bookmarks=false]{hyperref}
\usepackage[countalllines, withmarginpar]{gmdoc}
\usepackage[inline, visible]{gmdoc-enhance}
\let\pack\textrm%
\renewcommand*{\EOFMark}{}



\newenvironment{kodo-citajho}[1][english]{%
  \par
  \addtolength{\CodeIndent}{1cm}
  \addtolength{\TextIndent}{1cm}
  \addtolength{\rightskip}{1cm}
  \renewcommand*{\printlinenumber}{%
    \leavevmode
      \llap{\rlap{%
          \hspace*{1cm}%
          \LineNumFont$\phantom{999}$\llap{%
          $(\thecodelinenum)$}}%
      \hskip\leftskip%
      %
    }%
  }
%!  \addmargin{5em}
  \csname otherlanguage*\endcsname{#1}%
  \slshape%
  \expandafter\addtomacro\csname ttverbatim@hook\endcsname{\slshape}%
  \MakeShortVerb\|\DeleteShortVerb\'%
}{
  \MakeShortVerb\'\DeleteShortVerb\|%
  \csname endotherlanguage*\endcsname%
  \endaddmargin
}

\addtomacro\LineNumFont{\normalcolor}


\RecordChanges
\begin{document}
   % ^ ne taŭgas kiel specialsigno, ĉar ni
   % bezonas ĝin por ^^B, ^^M ktp.
   \catcode`\^=7%
   \MakeShortVerb\'
   \DocInput{exp-testopt.dtx}
\end{document}
%</driver>
% \fi
%
% \chschange{v0.1}{2009/03/03}{37}
% \chschange{v0.2}{2009/03/03}{90}
% \chschange{v0.3}{2009/03/06}{139}
% \changes{v0.1}{2009/03/03}{Unua versio}
% \changes{v0.2}{2009/03/03}{Preta por publikigo, mi kredas.}
% \changes{v0.3}{2009/03/06}{Post pluraj cimkorektoj nun vere\
%   preta \dots}
%
% \GetFileInfo{exp-testopt.sty}
%
%
% \title{La \pack{exp-testopt}-Pakaĵo -- ekspandebla varianto de \
%   \cs{@testopt}.  \thanks{ Tiu dokumento rilatas al \
%     \pack{exp-testopt}~\fileversion, de~\filedate.}}
% \author{Paul Ebermann\thanks{\texttt{Paul-Ebermann@gmx.de}}}
%
% \maketitle
%
%
% \begin{abstract}
%   Ekspandebla varianto de '\@testopt' el la \LaTeX-kerno, kaj iom
%   pli ĝenerala (ankaŭ ekspandebla) '\@expandable@ifopt', por rekoni
%   ekziston de opciaj argumentoj (sen tuj doni defaŭlton).
%   Ankaŭ '\newcommand'-varianto, kiu uzas tion.
% \end{abstract}
% 
%
% \tableofcontents
%
% \section{Uzanta dokumentaĵo}
%
%  Tiu ĉi pakaĵo enhavas unu makroon rekte uzebla de uzantoj, kvankam
%  ankaŭ ĝin verŝajne pli ofte uzos pakaĵo-kreantoj.
%  Krome ĝi enhavas du utilajn makroojn por pakaĵ-kreantoj
% (ne por uzantoj).
%
%  \subsection{Makrooj}
%
%  \TextUsage{\expnewcommand}'*'\arg{nomo}\arg[paramnum]\
%   \arg[defaŭlto]\arg{kodo} 
%   --
%   funkcias simile kiel '\newcommand': Kreas komandon kun \meta{num} parametroj
%   (ĝis 9), kaj se \meta{defaŭlto} estas donita, la unua parametro estos
%   opcia kun \meta{defaŭlto} kiel defaŭlta valoro.
%   Diferenco al '\newcommand' nur ekzistas, se \meta{defaŭlto} estas
%   donita -- tiam je voko de la makroo ni uzas ekspandeblan komparon
%   por ekscii, ĉu unua parametro estas donita. (Tio havas la avantaĝon
%   esti ekspandebla, sed la limigojn menciitajn sube.)
%  
%
%   \TextUsage{\@expandable@testopt}\marg{ordono}\marg{defaŭlto}
%   -- 
%  vokas \meta{ordono}n kun '[]'-parametro -- se neniu plia estas donata de
%  la uzanto, ni uzas \meta{defaŭlto} anstataŭe.
%  Pli detale: kontrolas, ĉu la sekva signo
%  estas '['. Se jes, iĝas \meta{ordono}, alikaze iĝas
%  \meta{ordono}\arg[defaŭlto].
%  (Tio funkcias simile kiel '\@testopt' el la \LaTeX-kerno.)
%
%  \TextUsage{\@expandable@ifopt}\marg{jes}\marg{ne} --
%  kontrolas, ĉu la sekva signo estas '['. Se jes, vokas \meta{jes}, alikaze
%  \meta{ne}.
%
% \subsection{Limigoj}
%
%  Fakte tiuj makrooj ne kontrolas la sekvan simbolon (kio igus ĝin
%   ne-ekspandebla pro uzo de '\futurelet', kiel '\@testopt'),
%  sed la sekvan makroo-argumenton ('#3', fakte). Krome estas malfacile
%  kompari ion, se oni ne povas difini/ŝanĝi ion.
%
% Tio havas la sekvajn konsekvencojn:
% \begin{itemize}
% \item 
%   Ne eblas distingi '[' de '{[}' per nia algoritmo -- ambaŭ estas traktataj
%   kiel \meta{Jes}.
% \item 
%   La sekva argumento estu de la amika speco: Ĝi estu (se ĝi ne estas
%   simple '[') ĉeno el maksimume unu \emph{danĝera} simbolo (kontrolsekvenco
%   aŭ el danĝera kategorio) kaj poste simpla teksto (el kategorioj 10, 11,
%   12).
%
%   Se ĝi konsistas el nur unu simbolo, tio ne estas problemo. Se ĝi
%   konsistas el simpla teksto, tio ankaŭ ne estas problemo.
%
%   En aliaj kazoj povas aperi strangaj erarmesaĝoj.
% \item Apero de pluraj spaco-simboloj antaŭ la '[' povas konfuzigi la
%   programon, tiam ankaŭ aperos strangaj erarmesaĝoj.
% \end{itemize}
%
%  Do, antaŭ la uzo de tiuj makrooj bone pripensu, ĉu la limigoj vin
%  ĝenas.
%
%  (Krome eblas trompi nian algoritmon per kreado de pliaj makrooj en la
%   nomspaco de '\exp-testopt@@'\meta{io}'@'. Ne faru tion, krom se vi certas
%   pri la konsekvencoj.)
%
%
% \section{Ekzemplo}
%
% Jen ekzemplo de la uzo por krei komandon '\beispiel' kun opcia
% argumento.
%
% \changes{v0.3}{2009/03/05}{Testo ankaŭ por \cs{expnewcommand}}
%
%<*test>
\makeatletter
\errorcontextlines = 20

\def\beispiel{%
  \@expandable@testopt\beispielImpl{Default}%
}
\def\beispielImpl[#1]{%
  \fbox{#1}%
}
\makeatother

\expnewcommand*{\ekzemplo}[1][Defa\u ulto]{%
  \textbf{(#1)}%
}

\expnewcommand*{\ekzemploDu}[2][defa\u ulto]{%
  \ensuremath{\frac{\mbox{#1}}{\mbox{#2}}}%
}

  \beispiel{egal} \beispiel[bla]
  \beispiel$ e=m c^2$ \beispiel[$ e=m c^2$]

  \ekzemplo\ekzemplo[Bla]
  \expandafter\ekzemplo\space[bla]
  \expandafter\expandafter\expandafter\ekzemplo\expandafter\space\space[dua bla]
  \ekzemplo
  [nova linio]
  \ekzemplo

  [du novaj linioj]
  \ekzemplo[blub]

  \ekzemploDu{testo}
  \ekzemploDu[bla]{testo}

%</test>
%
% Kontraŭe al kreado de tia komando per '\newcommand', la komando estas
% tute ekspandebla (nu, krom la enhavo de '\beispielImpl'), anstataŭ
% robustigita per malfruigita ekspandado. Tiel ekzemple eblas uzi valorojn
% de variabloj kun ilia aktuala valoro, ankaŭ se la komando mem estos poste
% skribota en dosieron. (Hmm, iom komplika, ĉu?)
%
% La supra kodo donas jenan rezulton:
%
% \begin{center}\StraightEOL
%   \fbox{\
%     \begin{minipage}{0.8\linewidth} \
%      \normalInput{\jobname.test} \
%     \end{minipage}\
%   }
% \end{center}
%
% \StopEventually{\PrintChanges\PrintIndex}
%
% \section{Implementado}
%
%
%<*package>


%
% \subsection{Ĉefaj makrooj}
%
% Niaj du ĉefaj makrooj nun aspektas tiom similaj, ke ni povas implementi
% 'testopt' per 'ifopt'.
%
\newcommand*{\@expandable@testopt}[2]{%
  \@expandable@ifopt{#1}{#1[#2]}%
}

% '\@expandable@ifopt' nun faras la laboron.
%
\newcommand{\@expandable@ifopt}[3]{%
  \expandafter\ifx% '\ifx' komparas la difinojn de du makrooj, nome \dots
     \csname exp-testopt@@\string#3@\endcsname% \dots makronomo kreita el la
% tria argumento (= la signo poste).
     \exp@testopt@opt@% \dots kaj tiu antaŭdifinita makroo.
    \afterfi{#1#3}% En la jes-kazo, vokas la unuan argumenton
% (kun la tria), \dots
  \else% \dots en la ne-kazo la duan.
%
% Sed tiam ni ankoraŭ devos eltrovi, ĉu la tria konsistis el unu aŭ pluraj
% tokenoj, por meti '{...}' ĉirkaŭ ĝin en la dua kazo. (Se ĝi nur estas
% unu tokeno, meti '{...}' povas esti malhelpa, se ĝi fakte ne estas argumento
% al '#2', sed ekzemple io kiel '$', aŭ sekva makroo.)
    \@expandable@ifOneToken#3\@expandable@ifOneToken% Tiu
% ĉi makroo provas eltrovi tion.
    {\afterfi{#2#3}}%
    {\afterfi{#2{#3}}}%
  \fi%
}%


%  La ideo por tia ekspandebla kontrolo de la sekva »signo« estas, ke ni
%  kreas el la »signo« makroonomon, kaj komparas la signifon de ĝi kun
%  signifo de konata makroo.
%
%  \subsection{Komparendaj makrooj}
%
%  Por tio ni kreas iujn nomojn, kiuj estas supozeble ne uzata de iu alia,
%  kun signifoj, kiuj ankaŭ supozeble ne erare aperas.
%
\def\exp@testopt@opt@{<<<[>>>}% tio estas la nomo, kies valoron ni
% komparas kun aliaj kandidatoj. 
\@namedef{exp-testopt@@\string[@}{<<<[>>>}% Tio -- '\exp-testopt@@[@' -- estas
% la makroo, kiu estos trovota en la \emph{jes}-kazo.


% Ni ankoraŭ devas eltrovi, ĉu la argumento estas
% nur unu tokeno aŭ pluraj, por povi meti '{...}'
% en la dua kazo. Ni uzas similan trukon por tio.
\long\def\@expandable@ifOneToken#1#2\@expandable@ifOneToken#3#4{%
  \expandafter\ifx%
     \csname exp-testopt@@\string#2@\endcsname%
     \exp@testopt@empty@%
     \afterfi{#3}%
  \else
     \afterfi{#4}%
  \fi
}

\def\exp@testopt@empty@{<<<>>>}% tio
% estas la nomo, kies valoron ni komparas kun aliaj kandidatoj. 
\@namedef{exp-testopt@@@}{<<<>>>}% Tio --
%  '\exp-testopt@@@' -- estas la makroo, kiu estos trovota en la kazo,
%  ke '#2' estas malplena.



% \subsection{Komando-difinoj}
%
% \changes{v0.2}{2009/03/03}{Aldono de \cs{expnewcommand}.}
%
% Ni volas krei varianton de '\newcommand', kiu uzas
% nian ekspandeblan metodon por opciaj argumentoj, anstataŭ
% la robustan.
%
% Jen la originalo el latex.ltx (ltdefns.dtx, por esti
%  preciza, CTAN-versio de 2006-05-21).
% \begin{kodo-citajho} 
%<*latex2e>
%    Handle the second optional argument.
\long\def\@xargdef#1[#2][#3]#4{%
  \@ifdefinable#1{%
%    Define the actual command to be:\\
%    |\def\foo{\@protected@testopt\foo\\foo{default}}|\\
%    where |\\foo| is a csname generated from applying |\csname| and
%    |\string| to |\foo|, ie the actual name contains a backslash and
%    therefore can't clash easily with exisiting command names.
%    ``Default'' is the contents of the second optional argument of
%    |(re)newcommand|.  {\color{red}
     \expandafter\def\expandafter#1\expandafter{%
          \expandafter
          \@protected@testopt
          \expandafter
          #1%
          \csname\string#1\endcsname
          {#3}}%
% }   Now we define the internal macro ie |\\foo| which is supposed to
%    pick up all arguments (optional and mandatory).
       \expandafter\@yargdef
          \csname\string#1\endcsname
           \tw@
           {#2}%
           {#4}}}
%</latex2e>
%  \end{kodo-citajho}
%
% Kaj ni nun devas ŝanĝi la markitan parton
% por anstataŭe uzi nian metodon. Tio signifas, ke \meta{nomo} nun
% estas difinita kiel
% {\color{Green}'\@expandable@testopt\'\meta{nomo}\marg{defaŭlto}},
% anstataŭ
% {\color{red}^^A
% '\@protected@testopt'\meta{nomo}'\'\meta{nomo}\marg{defaŭlto}}.
%
% (Kompreneble ni ne redifinas '\@xargdef', sed difinas nian
%  propran varianton, por uzi anstataŭe -- ni ja ne volas ŝanĝi
%  la bazan funkcion de '\newcommand'.)
\long\def\@exp@xargdef#1[#2][#3]#4{%
  \@ifdefinable#1{% { \color{Green}
    \expandafter\def\expandafter#1\expandafter{% 
      \expandafter%
      \@expandable@testopt%
      \csname\string#1\endcsname%
      {#3}}% }
    \expandafter\@yargdef%
      \csname\string#1\endcsname%
      \tw@%
      {#2}%
      {#4}%
  }%
}


% Kaj nun kelkaj paralelaj difinoj al '\newcommand', '\new@command' kaj
%  '\@newcommand'.
%
% \changes{v0.3}{2009/03/03}{Cim-korekto: \cs{exp@new@command} renomita al \cs{expnew@command}}
%
% '\expnewcommand' estas la ĉefa komando.
\def\expnewcommand{%
  \@star@or@long\expnew@command%
}
\def\expnew@command#1{%
  \@testopt{\exp@newcommand#1}0%
}
\def\exp@newcommand#1[#2]{%
  \@ifnextchar [{\@exp@xargdef#1[#2]}% Ĉi
% tie ni vokas nian varianton anstataŭ '\@xargdef'.
%                                                             ^^A ]
               {\@argdef#1[#2]}% Tiu estas la originalo.
}

%
% \subsection{Helpaj makrooj}
%
% '\afterfi'\arg{kodo} -- saltas ĝis post la sekva '\fi', kaj
% ekzekutas \meta{kodo}n tie.
% 
% Kopiita el \pk{gmutils}.
%
\@ifundefined{afterfi}{%
  \def\afterfi#1#2\fi{%
    \fi#1%
    }%
}{}%

%
%
%
% Jam fino :-)
\endinput
%</package>
% (Jes, vere fino.)
%
% \Finale
%\endinput


%%% Folgendes ist nur für meinen Editor.
%%%
%%% Local Variables:
%%% mode: docTeX
%%% TeX-master: t
%%% End: