Debian Codegraph @

texmf-dist/source/latex/exp-testopt/exp-testopt.dtx

raw
1 % \iffalse meta-comment
2 %
3 %% (C) 2008 Paul Ebermann
4 %%
5 %% Package exp-testopt - expandible testopt-Variante.
6 %%
7 %% Die Datei exp-testopt.dtx sowie die dazugehörige
8 %% exp-testopt.ins sowie die damit generierte
9 %% exp-testopt.sty stehen unter der
10 %% "LaTeX Project Public License" (LPPL, zu finden
11 %% unter http://www.latex-project.org/lppl/, sowie
12 %% auch in den meisten TeX-Distributionen in
13 %% texmf/docs/latex/base/lppl*.txt), Version 1.3b oder
14 %% später (nach Wahl des Verwenders).
15 %%
16 %% Der 'maintenance-status' ist (zur Zeit) 'author-maintained'.
17 %%
18 %% Das heißt u.a., die Dateien dürfen frei vertrieben werden,
19 %% bei Änderungen (durch andere Personen als Paul Ebermann)
20 %% ist aber der Name der Datei zu ändern.
21 %
22 % \fi
23 %
24 % \iffalse
25 % ---------------------------------------------
26 %<package>\NeedsTeXFormat{LaTeX2e}[2005/12/01]%
27 % ----------------------------________________-----------------
28 %<package>\ProvidesPackage{exp-testopt}[2009/03/06 v0.3 (PE)]
29 % ----------------------------________________-----------------
30 % \fi
31 %
32 % \iffalse
33 %<*driver>
34 \PassOptionsToClass{draft}{scrartcl}
35 \documentclass{scrartcl}
36 %
37 % Esperantajn tekstojn oni prefere entajpu per unikodaj literoj.
38 \usepackage[utf8x]{inputenc}
39 \usepackage[esperanto]{babel}
40
41 \addto{\extrasesperanto}{%
42 \renewcommand*{\generalname}{\^Generale}%
43 \GlossaryPrologue{%
44 \section{\^San\^goj}%
45 }%
46 \GlossaryMin=3\baselineskip
47 \IndexPrologue{%
48 \section{Indekso}
49 Kurzivaj nombroj indikas la lokojn, kie la indeks-ero estas priskribita,
50 substrekitaj nombroj indikas la lokon de la difino, la aliaj estas uzoj.
51 }
52 \IndexMin=5\baselineskip
53 }
54
55
56 \usepackage[svgnames]{xcolor}
57
58 \usepackage{exp-testopt}
59
60 \usepackage[bookmarks=false]{hyperref}
61 \usepackage[countalllines, withmarginpar]{gmdoc}
62 \usepackage[inline, visible]{gmdoc-enhance}
63 \let\pack\textrm%
64 \renewcommand*{\EOFMark}{}
65
66
67
68 \newenvironment{kodo-citajho}[1][english]{%
69 \par
70 \addtolength{\CodeIndent}{1cm}
71 \addtolength{\TextIndent}{1cm}
72 \addtolength{\rightskip}{1cm}
73 \renewcommand*{\printlinenumber}{%
74 \leavevmode
75 \llap{\rlap{%
76 \hspace*{1cm}%
77 \LineNumFont$\phantom{999}$\llap{%
78 $(\thecodelinenum)$}}%
79 \hskip\leftskip%
80 %
81 }%
82 }
83 %! \addmargin{5em}
84 \csname otherlanguage*\endcsname{#1}%
85 \slshape%
86 \expandafter\addtomacro\csname ttverbatim@hook\endcsname{\slshape}%
87 \MakeShortVerb\|\DeleteShortVerb\'%
88 }{
89 \MakeShortVerb\'\DeleteShortVerb\|%
90 \csname endotherlanguage*\endcsname%
91 \endaddmargin
92 }
93
94 \addtomacro\LineNumFont{\normalcolor}
95
96
97 \RecordChanges
98 \begin{document}
99 % ^ ne taŭgas kiel specialsigno, ĉar ni
100 % bezonas ĝin por ^^B, ^^M ktp.
101 \catcode`\^=7%
102 \MakeShortVerb\'
103 \DocInput{exp-testopt.dtx}
104 \end{document}
105 %</driver>
106 % \fi
107 %
108 % \chschange{v0.1}{2009/03/03}{37}
109 % \chschange{v0.2}{2009/03/03}{90}
110 % \chschange{v0.3}{2009/03/06}{139}
111 % \changes{v0.1}{2009/03/03}{Unua versio}
112 % \changes{v0.2}{2009/03/03}{Preta por publikigo, mi kredas.}
113 % \changes{v0.3}{2009/03/06}{Post pluraj cimkorektoj nun vere\
114 % preta \dots}
115 %
116 % \GetFileInfo{exp-testopt.sty}
117 %
118 %
119 % \title{La \pack{exp-testopt}-Pakaĵo -- ekspandebla varianto de \
120 % \cs{@testopt}. \thanks{ Tiu dokumento rilatas al \
121 % \pack{exp-testopt}~\fileversion, de~\filedate.}}
122 % \author{Paul Ebermann\thanks{\texttt{[email protected]}}}
123 %
124 % \maketitle
125 %
126 %
127 % \begin{abstract}
128 % Ekspandebla varianto de '\@testopt' el la \LaTeX-kerno, kaj iom
129 % pli ĝenerala (ankaŭ ekspandebla) '\@expandable@ifopt', por rekoni
130 % ekziston de opciaj argumentoj (sen tuj doni defaŭlton).
131 % Ankaŭ '\newcommand'-varianto, kiu uzas tion.
132 % \end{abstract}
133 %
134 %
135 % \tableofcontents
136 %
137 % \section{Uzanta dokumentaĵo}
138 %
139 % Tiu ĉi pakaĵo enhavas unu makroon rekte uzebla de uzantoj, kvankam
140 % ankaŭ ĝin verŝajne pli ofte uzos pakaĵo-kreantoj.
141 % Krome ĝi enhavas du utilajn makroojn por pakaĵ-kreantoj
142 % (ne por uzantoj).
143 %
144 % \subsection{Makrooj}
145 %
146 % \TextUsage{\expnewcommand}'*'\arg{nomo}\arg[paramnum]\
147 % \arg[defaŭlto]\arg{kodo}
148 % --
149 % funkcias simile kiel '\newcommand': Kreas komandon kun \meta{num} parametroj
150 % (ĝis 9), kaj se \meta{defaŭlto} estas donita, la unua parametro estos
151 % opcia kun \meta{defaŭlto} kiel defaŭlta valoro.
152 % Diferenco al '\newcommand' nur ekzistas, se \meta{defaŭlto} estas
153 % donita -- tiam je voko de la makroo ni uzas ekspandeblan komparon
154 % por ekscii, ĉu unua parametro estas donita. (Tio havas la avantaĝon
155 % esti ekspandebla, sed la limigojn menciitajn sube.)
156 %
157 %
158 % \TextUsage{\@expandable@testopt}\marg{ordono}\marg{defaŭlto}
159 % --
160 % vokas \meta{ordono}n kun '[]'-parametro -- se neniu plia estas donata de
161 % la uzanto, ni uzas \meta{defaŭlto} anstataŭe.
162 % Pli detale: kontrolas, ĉu la sekva signo
163 % estas '['. Se jes, iĝas \meta{ordono}, alikaze iĝas
164 % \meta{ordono}\arg[defaŭlto].
165 % (Tio funkcias simile kiel '\@testopt' el la \LaTeX-kerno.)
166 %
167 % \TextUsage{\@expandable@ifopt}\marg{jes}\marg{ne} --
168 % kontrolas, ĉu la sekva signo estas '['. Se jes, vokas \meta{jes}, alikaze
169 % \meta{ne}.
170 %
171 % \subsection{Limigoj}
172 %
173 % Fakte tiuj makrooj ne kontrolas la sekvan simbolon (kio igus ĝin
174 % ne-ekspandebla pro uzo de '\futurelet', kiel '\@testopt'),
175 % sed la sekvan makroo-argumenton ('#3', fakte). Krome estas malfacile
176 % kompari ion, se oni ne povas difini/ŝanĝi ion.
177 %
178 % Tio havas la sekvajn konsekvencojn:
179 % \begin{itemize}
180 % \item
181 % Ne eblas distingi '[' de '{[}' per nia algoritmo -- ambaŭ estas traktataj
182 % kiel \meta{Jes}.
183 % \item
184 % La sekva argumento estu de la amika speco: Ĝi estu (se ĝi ne estas
185 % simple '[') ĉeno el maksimume unu \emph{danĝera} simbolo (kontrolsekvenco
186 % aŭ el danĝera kategorio) kaj poste simpla teksto (el kategorioj 10, 11,
187 % 12).
188 %
189 % Se ĝi konsistas el nur unu simbolo, tio ne estas problemo. Se ĝi
190 % konsistas el simpla teksto, tio ankaŭ ne estas problemo.
191 %
192 % En aliaj kazoj povas aperi strangaj erarmesaĝoj.
193 % \item Apero de pluraj spaco-simboloj antaŭ la '[' povas konfuzigi la
194 % programon, tiam ankaŭ aperos strangaj erarmesaĝoj.
195 % \end{itemize}
196 %
197 % Do, antaŭ la uzo de tiuj makrooj bone pripensu, ĉu la limigoj vin
198 % ĝenas.
199 %
200 % (Krome eblas trompi nian algoritmon per kreado de pliaj makrooj en la
201 % nomspaco de '\exp-testopt@@'\meta{io}'@'. Ne faru tion, krom se vi certas
202 % pri la konsekvencoj.)
203 %
204 %
205 % \section{Ekzemplo}
206 %
207 % Jen ekzemplo de la uzo por krei komandon '\beispiel' kun opcia
208 % argumento.
209 %
210 % \changes{v0.3}{2009/03/05}{Testo ankaŭ por \cs{expnewcommand}}
211 %
212 %<*test>
213 \makeatletter
214 \errorcontextlines = 20
215
216 \def\beispiel{%
217 \@expandable@testopt\beispielImpl{Default}%
218 }
219 \def\beispielImpl[#1]{%
220 \fbox{#1}%
221 }
222 \makeatother
223
224 \expnewcommand*{\ekzemplo}[1][Defa\u ulto]{%
225 \textbf{(#1)}%
226 }
227
228 \expnewcommand*{\ekzemploDu}[2][defa\u ulto]{%
229 \ensuremath{\frac{\mbox{#1}}{\mbox{#2}}}%
230 }
231
232 \beispiel{egal} \beispiel[bla]
233 \beispiel$ e=m c^2$ \beispiel[$ e=m c^2$]
234
235 \ekzemplo\ekzemplo[Bla]
236 \expandafter\ekzemplo\space[bla]
237 \expandafter\expandafter\expandafter\ekzemplo\expandafter\space\space[dua bla]
238 \ekzemplo
239 [nova linio]
240 \ekzemplo
241
242 [du novaj linioj]
243 \ekzemplo[blub]
244
245 \ekzemploDu{testo}
246 \ekzemploDu[bla]{testo}
247
248 %</test>
249 %
250 % Kontraŭe al kreado de tia komando per '\newcommand', la komando estas
251 % tute ekspandebla (nu, krom la enhavo de '\beispielImpl'), anstataŭ
252 % robustigita per malfruigita ekspandado. Tiel ekzemple eblas uzi valorojn
253 % de variabloj kun ilia aktuala valoro, ankaŭ se la komando mem estos poste
254 % skribota en dosieron. (Hmm, iom komplika, ĉu?)
255 %
256 % La supra kodo donas jenan rezulton:
257 %
258 % \begin{center}\StraightEOL
259 % \fbox{\
260 % \begin{minipage}{0.8\linewidth} \
261 % \normalInput{\jobname.test} \
262 % \end{minipage}\
263 % }
264 % \end{center}
265 %
266 % \StopEventually{\PrintChanges\PrintIndex}
267 %
268 % \section{Implementado}
269 %
270 %
271 %<*package>
272
273
274 %
275 % \subsection{Ĉefaj makrooj}
276 %
277 % Niaj du ĉefaj makrooj nun aspektas tiom similaj, ke ni povas implementi
278 % 'testopt' per 'ifopt'.
279 %
280 \newcommand*{\@expandable@testopt}[2]{%
281 \@expandable@ifopt{#1}{#1[#2]}%
282 }
283
284 % '\@expandable@ifopt' nun faras la laboron.
285 %
286 \newcommand{\@expandable@ifopt}[3]{%
287 \expandafter\ifx% '\ifx' komparas la difinojn de du makrooj, nome \dots
288 \csname exp-testopt@@\string#3@\endcsname% \dots makronomo kreita el la
289 % tria argumento (= la signo poste).
290 \exp@testopt@opt@% \dots kaj tiu antaŭdifinita makroo.
291 \afterfi{#1#3}% En la jes-kazo, vokas la unuan argumenton
292 % (kun la tria), \dots
293 \else% \dots en la ne-kazo la duan.
294 %
295 % Sed tiam ni ankoraŭ devos eltrovi, ĉu la tria konsistis el unu aŭ pluraj
296 % tokenoj, por meti '{...}' ĉirkaŭ ĝin en la dua kazo. (Se ĝi nur estas
297 % unu tokeno, meti '{...}' povas esti malhelpa, se ĝi fakte ne estas argumento
298 % al '#2', sed ekzemple io kiel '$', aŭ sekva makroo.)
299 \@expandable@ifOneToken#3\@expandable@ifOneToken% Tiu
300 % ĉi makroo provas eltrovi tion.
301 {\afterfi{#2#3}}%
302 {\afterfi{#2{#3}}}%
303 \fi%
304 }%
305
306
307 % La ideo por tia ekspandebla kontrolo de la sekva »signo« estas, ke ni
308 % kreas el la »signo« makroonomon, kaj komparas la signifon de ĝi kun
309 % signifo de konata makroo.
310 %
311 % \subsection{Komparendaj makrooj}
312 %
313 % Por tio ni kreas iujn nomojn, kiuj estas supozeble ne uzata de iu alia,
314 % kun signifoj, kiuj ankaŭ supozeble ne erare aperas.
315 %
316 \def\exp@testopt@opt@{<<<[>>>}% tio estas la nomo, kies valoron ni
317 % komparas kun aliaj kandidatoj.
318 \@namedef{exp-testopt@@\string[@}{<<<[>>>}% Tio -- '\exp-testopt@@[@' -- estas
319 % la makroo, kiu estos trovota en la \emph{jes}-kazo.
320
321
322 % Ni ankoraŭ devas eltrovi, ĉu la argumento estas
323 % nur unu tokeno aŭ pluraj, por povi meti '{...}'
324 % en la dua kazo. Ni uzas similan trukon por tio.
325 \long\def\@expandable@ifOneToken#1#2\@expandable@ifOneToken#3#4{%
326 \expandafter\ifx%
327 \csname exp-testopt@@\string#2@\endcsname%
328 \exp@testopt@empty@%
329 \afterfi{#3}%
330 \else
331 \afterfi{#4}%
332 \fi
333 }
334
335 \def\exp@testopt@empty@{<<<>>>}% tio
336 % estas la nomo, kies valoron ni komparas kun aliaj kandidatoj.
337 \@namedef{exp-testopt@@@}{<<<>>>}% Tio --
338 % '\exp-testopt@@@' -- estas la makroo, kiu estos trovota en la kazo,
339 % ke '#2' estas malplena.
340
341
342
343 % \subsection{Komando-difinoj}
344 %
345 % \changes{v0.2}{2009/03/03}{Aldono de \cs{expnewcommand}.}
346 %
347 % Ni volas krei varianton de '\newcommand', kiu uzas
348 % nian ekspandeblan metodon por opciaj argumentoj, anstataŭ
349 % la robustan.
350 %
351 % Jen la originalo el latex.ltx (ltdefns.dtx, por esti
352 % preciza, CTAN-versio de 2006-05-21).
353 % \begin{kodo-citajho}
354 %<*latex2e>
355 % Handle the second optional argument.
356 \long\def\@xargdef#1[#2][#3]#4{%
357 \@ifdefinable#1{%
358 % Define the actual command to be:\\
359 % |\def\foo{\@protected@testopt\foo\\foo{default}}|\\
360 % where |\\foo| is a csname generated from applying |\csname| and
361 % |\string| to |\foo|, ie the actual name contains a backslash and
362 % therefore can't clash easily with exisiting command names.
363 % ``Default'' is the contents of the second optional argument of
364 % |(re)newcommand|. {\color{red}
365 \expandafter\def\expandafter#1\expandafter{%
366 \expandafter
367 \@protected@testopt
368 \expandafter
369 #1%
370 \csname\string#1\endcsname
371 {#3}}%
372 % } Now we define the internal macro ie |\\foo| which is supposed to
373 % pick up all arguments (optional and mandatory).
374 \expandafter\@yargdef
375 \csname\string#1\endcsname
376 \tw@
377 {#2}%
378 {#4}}}
379 %</latex2e>
380 % \end{kodo-citajho}
381 %
382 % Kaj ni nun devas ŝanĝi la markitan parton
383 % por anstataŭe uzi nian metodon. Tio signifas, ke \meta{nomo} nun
384 % estas difinita kiel
385 % {\color{Green}'\@expandable@testopt\'\meta{nomo}\marg{defaŭlto}},
386 % anstataŭ
387 % {\color{red}^^A
388 % '\@protected@testopt'\meta{nomo}'\'\meta{nomo}\marg{defaŭlto}}.
389 %
390 % (Kompreneble ni ne redifinas '\@xargdef', sed difinas nian
391 % propran varianton, por uzi anstataŭe -- ni ja ne volas ŝanĝi
392 % la bazan funkcion de '\newcommand'.)
393 \long\def\@exp@xargdef#1[#2][#3]#4{%
394 \@ifdefinable#1{% { \color{Green}
395 \expandafter\def\expandafter#1\expandafter{%
396 \expandafter%
397 \@expandable@testopt%
398 \csname\string#1\endcsname%
399 {#3}}% }
400 \expandafter\@yargdef%
401 \csname\string#1\endcsname%
402 \tw@%
403 {#2}%
404 {#4}%
405 }%
406 }
407
408
409 % Kaj nun kelkaj paralelaj difinoj al '\newcommand', '\new@command' kaj
410 % '\@newcommand'.
411 %
412 % \changes{v0.3}{2009/03/03}{Cim-korekto: \cs{exp@new@command} renomita al \cs{expnew@command}}
413 %
414 % '\expnewcommand' estas la ĉefa komando.
415 \def\expnewcommand{%
416 \@star@or@long\expnew@command%
417 }
418 \def\expnew@command#1{%
419 \@testopt{\exp@newcommand#1}0%
420 }
421 \def\exp@newcommand#1[#2]{%
422 \@ifnextchar [{\@exp@xargdef#1[#2]}% Ĉi
423 % tie ni vokas nian varianton anstataŭ '\@xargdef'.
424 % ^^A ]
425 {\@argdef#1[#2]}% Tiu estas la originalo.
426 }
427
428 %
429 % \subsection{Helpaj makrooj}
430 %
431 % '\afterfi'\arg{kodo} -- saltas ĝis post la sekva '\fi', kaj
432 % ekzekutas \meta{kodo}n tie.
433 %
434 % Kopiita el \pk{gmutils}.
435 %
436 \@ifundefined{afterfi}{%
437 \def\afterfi#1#2\fi{%
438 \fi#1%
439 }%
440 }{}%
441
442 %
443 %
444 %
445 % Jam fino :-)
446 \endinput
447 %</package>
448 % (Jes, vere fino.)
449 %
450 % \Finale
451 %\endinput
452
453
454 %%% Folgendes ist nur für meinen Editor.
455 %%%
456 %%% Local Variables:
457 %%% mode: docTeX
458 %%% TeX-master: t
459 %%% End: