summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/plain/xintsession/xintsession.tex
blob: aa0e8540d21f55ad032910e26939af4aeb9c8267 (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
% Release 0.2 (2021-05-05) of xintsession.tex
% author: Jean-Francois Burnol
% License: LPPL 1.3c (author-maintained)
% Usage: execute etex or pdftex
%        then enter "xintsession" at the ** prompt
\input xintexpr.sty\relax%
% AJOUTER CHECK DE VERSION ICI
\input xintbinhex.sty\relax%
\input polexpr.sty\relax% attention will crash if < 0.8
\let\PolToExprOneTerm\PolToExprOneTermStyleB%
%\let\PolToExprTimes\empty%
% we do assume standard catcodes on loading and use
% \XINTrestorecatcodes as a convenience facility.
% It stores \endlinechar but not \newlinechar
% and was renamed at 1.4e
\edef\xsrestorecatcodes{\XINTrestorecatcodes%
                        \newlinechar\the\newlinechar\relax}%
\endlinechar 13 %
\newlinechar 10
\catcode`_ 11
\catcode`& 11
\catcode`@ 11
\catcode`^ 11 
\catcode`" 7
\catcode0 12
\newwrite\xs_out
\edef\xs_name{\jobname-\expandafter\xint_gobble_ii\the\year
                      \expandafter\xint_gobble_i\the\numexpr100+\month\relax
                      \expandafter\xint_gobble_i\the\numexpr100+\day\relax
                      _%
                      \expandafter\xint_gobble_i\the\numexpr(\time+30)/60+99h%
                      \expandafter\xint_gobble_i\the\numexpr100+\time-60*((\time+30)/60-1).tex}%
\immediate\openout\xs_out=\xs_name\relax
\begingroup\catcode37 12
\long\gdef\xs_message#1{\message{#1}\immediate\write\xs_out{%#1}}\endgroup
{\catcode13\active\def
{""J}\catcode32\active\edef {\string }%
\catcode`?=0\catcode`\\=12\relax%
?xdef?xs_logo{%
                _____       _____
         ____  ____(_)________  /_________  _________________
         __  |/_/_  /__  __ \  __/  _ \_  |/_/__  __ \_  ___/
         __>  < _  / _  / / / /_ /  __/_>  < __  /_/ /  /
         /_/|_| /_/  /_/ /_/\__/ \___//_/|_| _  .___//_/
                                              /_/
  _____       _____                         __________
  ___(_)________  /__________________ ________  /___(_)__   ______
  __  /__  __ \  __/  _ \_  ___/  __ `/  ___/  __/_  /__ | / /  _ \
  _  / _  / / / /_ /  __/  /   / /_/ // /__ / /_ _  / __ |/ //  __/
  /_/  /_/ /_/\__/ \___//_/    \__,_/ \___/ \__/ /_/  _____/ \___/
}%
?immediate?write128{%

  xintsession 0.2
  Copyright (c) Jean-Francois Burnol, 2021.

  \jobname is ?jobname
  Transcript will go to log and to ?xs_name

  ===> HIT THE <RET> KEY NOW! <===%
}}%
\def\xs_no{0}%
\XINT_expr_defvar_one{@___}{{0}}%
\XINT_expr_defvar_one{@__}{{0}}%
\XINT_expr_defvar_one{@_}{{0}}%
\def\xs_fetch{\let\xs_in\empty\xs_fetch_a}%
\begingroup
\catcode13\active%
\long\gdef\xs_fetch_a#1
{%
  \odef\xs_firstitem{\romannumeral0\xintfirstitem{#1.}}%
  \ifcat\relax\expandafter\noexpand\xs_firstitem%
    \expandafter\xs_cs%
  \else%
   \if &\expandafter\noexpand\xs_firstitem%
    \expandafter\expandafter\expandafter\xs_magic%
   \fi%
  \fi%
  \if;\expandafter\noexpand\romannumeral0\xintlastitem{#1}%
    \xs_fetch_b#1^%
  \else%
    \message{(Use ; to end multi-line input)}%
    \odef\xs_in{\xs_in#1}\expandafter\xs_fetch_a%
  \fi%
}%
\endgroup
\long\def\xs_cs\if;\expandafter\noexpand\romannumeral0\xintlastitem#1#2\fi
{%
   \xs_message{(executing \detokenize{#1} in background)}%
   #1\xs_fetch_a
}%
\def\xs_firstfour#1#2#3#4#5\xint_bye{\edef\xs_magic_in{#1#2#3#4}\def\xs_magic_inb{#5}}%
\long\def\xs_magic\if;\expandafter\noexpand\romannumeral0\xintlastitem#1#2\fi
{%
  \xs_firstfour#1\empty\empty\empty\empty\xint_bye
  \ifcsname xs_magic@\xs_magic_in\endcsname
      \csname xs_magic@\xs_magic_in\expandafter\endcsname
  \else
   \xs_message{(\detokenize\expandafter{\xint_gobble_i#1} is not a magic keyword:
            ignored)}%
  \fi\xs_fetch_a
}%
\long\def\xs_fetch_b#1;^%
{%
   \odef\xs_in{\xs_in#1}\expandafter\xs_fetch_c
}%
\def\xs_fetch_c
{%
   \if\relax\romannumeral`""@\detokenize\expandafter{\xs_in}\relax\expandafter\xs_pause\fi
   \expandafter\xs_parse_a\xs_in:=^%
}%
\def\xs_pause\expandafter\xs_parse_a\xs_in:=^{\xs_pause_a\xs_fetch_a}%
\def\xs_pause_a\xs_fetch_a
{%
   \xs_message{Need a break? OK, use \string\xintresume\space if you change your mind.}%
   \xs_resetcats
}%
\def\xs_bye\xs_fetch_a
{%
   \xs_message{Did I say something wrong?}%
   \xs_message{Session transcript written on \xs_name}%
%   \xs_resetcats
   \immediate\closeout\xs_out
% expeditive exit because I need to think about generating new output
% filename with a check that it is not same (a minute may be too coarse?).
% Add random postfix? or simply do not bother rather...
   \csname bye\endcsname
}%
\def\xs_parse_a#1:=#2%
{%
   \xint_gob_til_^#2\xs_calc ^%
   \def\xs_left{#1}\xs_parse_b#2%
}%
\def\xs_calc ^#1^%
{%
   \edef\xs_no{\the\numexpr1+\xs_no}%
   \xs_xintdefvar @_\xs_no=\xs_in;%
   \immediate\write\xs_out
   {\expandafter\string\xs_xintdefvar\space @_\xs_no:=%
                \detokenize\expandafter{\xs_in};}%
   \XINT_expr_defvar_one{@___}{\csname XINT_expr_varvalue_@__\endcsname}%
   \XINT_expr_defvar_one{@__}{\csname XINT_expr_varvalue_@_\endcsname}%
   \XINT_expr_defvar_one{@_}{\csname XINT_expr_varvalue_@_\xs_no\endcsname}%
   \xs_message{(@_\xs_no)\space\space\space\space\xs_xinteval{@_\xs_no}}%
   \xs_fetch
}%
\def\xs_parse_b #1:=^%
{%
   \def\xs_right{#1}\expandafter\xs_parse_c\xs_left(;%
}%
\def\xs_parse_c #1(#2%
{%
   \edef\xs_funcname{\expandafter\xint_zapspaces\detokenize{#1} \xint_gobble_i}%
   \xint_gob_til_sc#2\xs_defvar;\xs_deffunc
}%
\def\xs_deffunc #1;%
{%
% attention: \xs_xintdeffunc needs to see parentheses immediately
   \expandafter\xs_xintdeffunc\xs_left=\xs_right;%
   \immediate\write\xs_out
   {\expandafter\string\xs_xintdeffunc\space\detokenize\expandafter{\xs_left}:=%
                \detokenize\expandafter{\xs_right};}%
   \expandafter\ifx\xs_xintdeffunc\poldef
        \xs_message{\xs_funcname\space = \PolToExpr{\xs_funcname}}%
        \xs_message{Issue \string\PolGenFloatVariant{\xs_funcname} if fp evaluations
                 with \xs_funcname\space are intended}%
   \else\xs_message{Function \xs_funcname\space defined}%
   \fi\xs_fetch
}%
\def\xs_defvar;\xs_deffunc
{%
   \edef\xs_no{\the\numexpr1+\xs_no}%
   \xs_xintdefvar @_\xs_no=\xs_right;%
   \immediate\write\xs_out
   {\expandafter\string\xs_xintdefvar\space\detokenize\expandafter{\xs_left}:=%
                \detokenize\expandafter{\xs_right};}%
   \XINT_expr_defvar_one{@___}{\csname XINT_expr_varvalue_@__\endcsname}%
   \XINT_expr_defvar_one{@__}{\csname XINT_expr_varvalue_@_\endcsname}%
   \XINT_expr_defvar_one{@_}{\csname XINT_expr_varvalue_@_\xs_no\endcsname}%
   % this is to allow multiple assignments
   \expandafter\xs_xintdefvar\xs_left=@_\xs_no;%
   \xs_message{(@_\xs_no)\space\space\space\space\xs_xinteval{@_\xs_no}}%
   \xs_fetch
}%
\let\xs_magic@&pau\xs_pause_a
\let\xs_magic@&bye\xs_bye
\def\xs_magic@&fp
{%
   \xs_message{fp mode (\xinttheDigits\space digits)}%
   \def\xs_mode{fp (Digits=\xinttheDigits)}%
   \def\xs_xintdefvar{\xintdeffloatvar}%
   \def\xs_xintdeffunc{\xintdeffloatfunc}%
   \def\xs_xinteval{\xintfloateval}%
}%
\expandafter\def\csname xs_magic@&fp=\endcsname
{%
   \xintDigits*:=\xs_magic_inb\relax
   \xs_message{fp mode (log and trig reloaded at Digits=\xinttheDigits)}%
   \def\xs_mode{fp=\xinttheDigits}%
   \def\xs_xintdefvar{\xintdeffloatvar}%
   \def\xs_xintdeffunc{\xintdeffloatfunc}%
   \def\xs_xinteval{\xintfloateval}%
}%
\def\xs_magic@&exa
{%
   \xs_message{exact mode (floating point evaluations use \xinttheDigits\space digits)}%
   \def\xs_mode{exact}%
   \def\xs_xintdefvar{\xintdefvar}%
   \def\xs_xintdeffunc{\xintdeffunc}%
   \def\xs_xinteval{\xinteval}%
}%
\def\xs_magic@&int
{%
   \xs_message{int mode (integer only: / rounds, // is floored division, /: is modulo)}%
   \def\xs_mode{int}%
   \def\xs_xintdefvar{\xintdefiivar}%
   \def\xs_xintdeffunc{\xintdefiifunc}%
   \def\xs_xinteval{\xintiieval}%
}%
\def\xs_magic@&pol
{%
   \xs_message{pol mode (i.e. function definitions use \string\poldef)}%
   \def\xs_mode{pol}%
   \def\xs_xintdefvar{\xintdefvar}%
   \def\xs_xintdeffunc{\poldef}%
   \def\xs_xinteval{\xinteval}%
}%
\def\xs_magic@&mod{\xs_message{current mode: \xs_mode}}%
\def\xs_setcats
{%
    \newlinechar10\endlinechar13%
    \catcode13\active\catcode`@ 11\relax
}%
\def\xs_storecats{\edef\xs_resetcats
{%
    \newlinechar\the\newlinechar
    \endlinechar\the\endlinechar
    \catcode13=\the\catcode13
    \catcode`@\the\catcode`@\relax
}}%
\begingroup
\catcode13\active\catcode32\active%
\gdef\xintstart{\edef {\string }\xs_setcats\def
{""J}\message{\xs_logo
  Welcome to xintexpr interactive mode!

  - input is `;'-terminated and can extend over multiple lines,
  - definitions must be done using the `:=' syntax, not `='.

  Any line starting with a control sequence is executed in the
  background, the interrupted numerical input resumes at prompt.
  Magic words: `&pause' (or `;'), `&help', `&bye'.
  Mode toggles: `&exact', `&fp', `&int', `&pol'.  Say for example
  `&fp=24' at the prompt to work with Digits=24 (Digits range: 1 to 62)
  Starting in}\xs_magic@&exa\let
=\xs_fetch}\gdef\xintresume{\edef {\string }\xs_storecats\xs_setcats%
\message{Welcome back to xintexpr interactive mode!}\let
=\xs_fetch}\catcode`?0\catcode`\\12?gdef?xs_help?xs_fetch_a{?def
{""J}?edef {?string }?message{%
  - Terminate inputs using the `;' character.

  - Input can extend over multiple lines (<RET> terminated).

  - An empty input (`;' terminated) or the magic word `&pause' puts
    the session on hold and switches to normal TeX interaction. Use
    \xintresume to resume the session.

  - The numerical engine can work in various modes:
    * exact mode means using \xintexpr context,
    * fp mode uses \xintfloatexpr,
    * int mode uses integer-only \xintiiexpr,
    * pol mode makes function definitions using \poldef.
    To activate a mode enter `&<mode name>' at the prompt

  - Lines starting with any control sequence are handed over to
    TeX, and numerical input resumes on next line.

  - Say `&fp=<number>' for example `&fp=32' at the prompt to change
    the Digits setting. This can be done in the midst of the
    input of a  multi-line computation!

(1/5) HIT <RET> KEY
}?let
=?xs_help_b}?gdef?xs_help_b{?def
{""J}?message{%
  - Say `&exact' resp. `&fp' to go back and forth between exact
    and floating point mode

  - Issue `&mode' if you forgot in what mode you are currently in.

  - Definitions (variables or functions) are done using `:='.

    IMPORTANT: currently, using a `=' by oversight will cause
    breakage because xintsession thinks it is then a numerical
    evaluation, not a definition, but there is no `=' operator in
    xintexpr syntax.

    Perhaps in future it will be allowed to make definitions using
    `=' and xintsession will check if it is not misinterpreting a
    `=' from `<=', `>=', `!=', `==' or `seq()' syntax but this
    currently was considered to add too much overhead for the
    benefit.
    
  - Parentheses present before the `:=' trigger a function
    definition, else a variable definition is done.

  - Functions defined in one mode are not available for usage in
    other modes without further steps; check xintexpr doc.

(2/5) HIT <RET> KEY
}?let
=?xs_help_c}?gdef?xs_help_c{?def
{""J}?message{%
  - Polynomial definitions (pol mode) are function definitions (see
    polexpr documentation). To use a polynomial also as a numerical
    function when back in fp mode, issue
    \PolGenFloatVariant{<polname>} at the prompt.

  - Variables defined in any mode can be used in any mode except:
    * polynomials can be used as variables only in the pol and the
      exact modes,
    * integer-only mode requires... integer-only variables, also
      internally. Use in int mode num() or \xintiexpr...\relax as
      wrapper around exact or fp variables, even integer-valued ones.

  - Whenever a variable is defined, or a computation is performed,
    the result is assigned a label @_<integer>. These automatic
    variables can then be used in subsequent computations.

  - In the case of a multi-variable assignment (see xintexpr doc)
    the automatic variable @_<integer> holds the whole thing, which
    may be a nutple or an ople, in addition to individual variables.

  - The special variables @_, @__, and @___ hold the last, next
    to last and next to next to last evaluation results.

(3/5) HIT <RET> KEY
}?let
=?xs_help_d}?gdef?xs_help_d{?def
{""J}?message{%
  Known issues:

  - The [P] optional argument of \xintfloateval can not be used
    because it is not recognized by \xintdeffloatvar, one can use
    the float() function with its second argument.

  - An \xintexpr...\relax wrapper inside fp mode or an
    \xintiexpr...\relax one inside int mode can not start a line,
    as it would trigger control sequence execution.
    Start with 0+ or use parentheses.

  - The definitive default output format of the exact and fp modes
    are not yet decided at upstream xintexpr:
    - trailing zeros are not trimmed,
    - exact and fp modes print out floating point numbers in
      diverging ways,
    - exact mode does not reduce to lowest terms, use reduce().

  - By default, the ** and ^ operators operate _only_ with integer
    exponents in exact mode and with half-integers in fp mode.
    Fractional powers are available via the pow(x,a) function.

(4/5) HIT <RET> KEY
}?let
=?xs_help_e}?gdef?xs_help_e{?def
{""J}?message{%
  Known issues (cont.):

  - Refer to xintexpr \poormanloghack documentation on how to let
    fractional powers be available with ** or ^, and check polexpr
    documentation for related information.

  - A session transcript file is created which can be executed by
    eTeX to redo all calculations; however @_, @__, and @___ will
    not be defined in this context so need to be manually replaced
    by the suitable @_<integer>.

  Future:

  - a plot() function will be added at some point to export
    coordinates into a .tex file for usage either with PSTricks or
    TikZ/pgf.

  Miscellany:

  Misformed xintexpr input can drop you into TeX error mode. In that
  case, try escaping using `S'.  It does work sometimes.

(5/5) You are back to the xintexpr interactive session! (mode: ?xs_mode)
      Use `&bye' to terminate the session and the TeX run.
}?let
=?xs_fetch?xs_fetch_a}?endgroup
\let\xs_magic@&hel\xs_help
\xsrestorecatcodes
\csname xs_storecats\endcsname
\catcode13\active\def
{\xintstart
}\endinput%