summaryrefslogtreecommitdiff
path: root/doc/upgrading.html
blob: 7ebde056898448829d09c9189988e0bbe50d4a38 (plain) (blame)
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META name='Description' content='Ficl - embedded scripting with object oriented programming'>
<META name='Keywords' content='scripting prototyping tcl OOP Forth interpreter C'>
<LINK rel='SHORTCUT ICON' href='ficl.ico'>
<TITLE>upgrading ficl</TITLE>
<style>

blockquote { margin-left: 1em }

</style>

</HEAD>
<BODY>

<table border=0 cellspacing=0 width=100%%><tr>


<td width=112 bgcolor=#004968 colspan=3>
<img src=graphics/ficl.4.96.jpg height=96 width=96>
</td>

<td bgcolor=#004968>
<font face=arial,helvetica color=white size=7><b><i>
upgrading ficl
</i></b></font>
</td></tr>


<tr>
<td bgcolor=#004968 width=10></td>
<td bgcolor=#004968 valign=top>
<br><p>
<a href=index.html><font face=arial,helvetica color=white><b>Index</b></font></a><p>
<p><br>
<a href=dpans.html><font face=arial,helvetica color=white><b>ANS</b></font></a><br>
<a href=api.html><font face=arial,helvetica color=white><b>API</b></font></a><br>
<a href=debugger.html><font face=arial,helvetica color=white><b>Debugger</b></font></a><br>
<a href=http://sourceforge.net/project/showfiles.php?group_id=24441><font face=arial,helvetica color=white><b>Download</b></font></a><br>
<a href=license.html><font face=arial,helvetica color=white><b>Licensing</b></font></a><br>
<a href=links.html><font face=arial,helvetica color=white><b>Links</b></font></a><br>
<a href=locals.html><font face=arial,helvetica color=white><b>Locals</b></font></a><br>
<a href=oop.html><font face=arial,helvetica color=white><b>OOP&nbsp;In&nbsp;Ficl</b></font></a><br>
<a href=parsesteps.html><font face=arial,helvetica color=white><b>Parse&nbsp;Steps</b></font></a><br>
<a href=releases.html><font face=arial,helvetica color=white><b>Release&nbsp;History</b></font></a><br>
<a href=upgrading.html><font face=arial,helvetica color=white><b>Upgrading&nbsp;To&nbsp;4.0</b></font></a><br>
</td><td bgcolor=#004968 width=5></td><td valign=top><blockquote><p>



Ficl 4.0 is smaller, faster, and more capable than any previous
version.  For more information on why Ficl 4.0 is so gosh-darned
swell, see the <a href=index.html#WhatsNewInFicl4.0>What's New In Ficl 4.0?</a>
section of the overview.
<p>


Since the Ficl API has changed so dramatically, you can't just drop
the new Ficl source.  You have two basic choices:
<a href=#compatibility>use the <code>FICL_WANT_COMPATIBILITY</code> support</a>, and
<a href=#newapi>switching to the new API</a>.
<p>

Note that using <i>either</i> of these choices <i>requires</i>
that you recompile your application.  You cannot build Ficl 4 into
a shared library or DLL and use it with an application expecting
Ficl 3.0.  Stated another way: Ficl 4 is <i>source</i> compatible
but not <i>binary</i> compatible with Ficl 3.


<a name=oldnames>

<p>
</blockquote><table border=0 bgcolor=#a0a0a0 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=5><b><i>
<a name='UsingcodeFICL_WANT_COMPATIBILITY/code'>
Using <code>FICL_WANT_COMPATIBILITY</code>
</a></i></b></font></td></tr></table><p><blockquote>


</a>


If you want to get Ficl 4.0 up and running in your project as quickly
as possible, <code>FICL_WANT_COMPATIBILITY</code> is what you'll want to use.
There are two easy steps, one of which you might be able to skip:
<p>

<ol>

<li>
Set the C preprocessor constant <code>FICL_WANT_COMPATIBILITY</code> to 1.
The best way is by adding the following line to <code>ficllocal.h</code>:
<pre>
	#define FICL_WANT_COMPATIBILITY (1)
</pre>


<li>

<i>If</i> you use a custom <code>ficlTextOut()</code> function, you'll
have to rename it, and explicitly specify it to Ficl.  Renaming it is
necessary, because the Ficl compatibility layer also provides one for
code that called <code>ficlTextOut()</code> directly (instead of calling
<code>vmTextOut()</code> as it should have).
We recommend renaming your function to <code>ficlTextOutLocal()</code>, as
we have have provided a prototype for this function for you in <code>ficlcompatibility.h</code>.
This will save you the trouble of defining your own prototype, ensuring you get
correct name decoration / linkage, etc.

<p>

There are two methods you can use to specify your <code>ficlTextOut()</code>
function:
<ol>

<li>
Specify it in the <code>FICL_INIT_INFO</code> structure passed in to
<code>ficlInitSystem()</code>.  This is the preferred method, as it ensures
you will see the results of Ficl's initialization code, and it will be
automatically passed in to every newly created VM.

<li>
Set it explicitly in every VM by calling <code>vmSetTextOut()</code> and
passing it in.

</ol>
<p>

<b>Note:</b>  Any other method, such as setting it by hand in the
<code>FICL_SYSTEM</code> or <code>FICL_VM</code> structures,
will <b>not</b> work.  There is a special compatibility layer for old-style
<code>OUTFUNC</code> functions, but it is only invoked properly when you
use one of the two methods mentioned above.


</ol>

<p>

This <i>should</i> be sufficient for you to recompile-and-go
with Ficl 4.  If it's not, please let us know, preferably including a
suggested solution to the problem.


<a name=newapi>

<p>
</blockquote><table border=0 bgcolor=#a0a0a0 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=5><b><i>
<a name='UsingTheNewAPI'>
Using The New API
</a></i></b></font></td></tr></table><p><blockquote>


</a>

Since most (all?) of the external symbols have changed names since the 3.0 series,
here is a quick guide to get you started on renaming everything.  This is by no
means an exhaustive list; this is meant to guide you towards figuring out what
the new name <i>should</i> be.  (After all, part of the point of this massive
renaming was to make all the external symbols consistent.)
<p>





<p>
</blockquote><table border=0 bgcolor=#b8b8b8 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=4><b><i>
<a name='Types'>
Types
</a></i></b></font></td></tr></table><p><blockquote>



Every external type has been renamed.  They all begin with the
word <code>ficl</code>, and they use mixed case (instead of all upper-case,
which is now reserved for macros).  Also, the confusingly-named
string objects have been renamed:
<code>FICL_STRING</code> is now <code>ficlCountedString</code>, as it
represents a "counted string" in the language, and
the more commonly-used <code>STRINGINFO</code> is now simply
<code>ficlString</code>.

<table width=100%><tr>

<td bgcolor=#d0d0f0><b>old name</b></td>

<td bgcolor=#e0e0ff><b>new name</td>

</tr>

<tr>

<td bgcolor=#e0e0e0><code>FICL_SYSTEM</code></td>

<td bgcolor=#f0f0f0><code>ficlSystem</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FICL_VM</code></td>

<td bgcolor=#f0f0f0><code>ficlVm</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FICL_SYSTEM_INFO</code></td>

<td bgcolor=#f0f0f0><code>ficlSystemInformation</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FICL_WORD</code></td>

<td bgcolor=#f0f0f0><code>ficlWord</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>IPTYPE</code></td>

<td bgcolor=#f0f0f0><code>ficlIp</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FICL_CODE</code></td>

<td bgcolor=#f0f0f0><code>ficlPrimitive</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>OUTFUNC</code></td>

<td bgcolor=#f0f0f0><code>ficlOutputFunction</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FICL_DICTIONARY</code></td>

<td bgcolor=#f0f0f0><code>ficlDictionary</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FICL_STACK</code></td>

<td bgcolor=#f0f0f0><code>ficlStack</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>STRINGINFO</code></td>

<td bgcolor=#f0f0f0><code>ficlString</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FICL_STRING</code></td>

<td bgcolor=#f0f0f0><code>ficlCountedString</code></td>

</tr>


</table><p>




<p>
</blockquote><table border=0 bgcolor=#b8b8b8 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=4><b><i>
<a name='StructureMembers'>
Structure Members
</a></i></b></font></td></tr></table><p><blockquote>



In addition, many structure names have changed.  To help ease the heartache,
we've also added some accessor macros.  So, in case they change in the future,
your code might still compile (hooray!).
<table width=100%><tr>

<td bgcolor=#d0d0f0><b>old name</b></td>

<td bgcolor=#e0e0ff><b>new name</td>

<td bgcolor=#d0d0f0><b>accessor</td>

</tr>

<tr>

<td bgcolor=#e0e0e0><code>pExtend</code></td>

<td bgcolor=#f0f0f0><code>context</code></td>

<td bgcolor=#e0e0e0><code>ficlVmGetContext(), ficlSystemGetContext()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>pStack</code></td>

<td bgcolor=#f0f0f0><code>dataStack</code></td>

<td bgcolor=#e0e0e0><code>ficlVmGetDataStack()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>fStack</code></td>

<td bgcolor=#f0f0f0><code>floatStack</code></td>

<td bgcolor=#e0e0e0><code>ficlVmGetFloatStack()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>rStack</code></td>

<td bgcolor=#f0f0f0><code>returnStack</code></td>

<td bgcolor=#e0e0e0><code>ficlVmGetReturnStack()</code></td>

</tr>


</table><p>




<p>
</blockquote><table border=0 bgcolor=#b8b8b8 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=4><b><i>
<a name='CallbackFunctions'>
Callback Functions
</a></i></b></font></td></tr></table><p><blockquote>



Text output callbacks have changed in two major ways:

<ul>

<li>
They no longer take a VM pointer; they now take a <code>ficlCallback</code> structure.
This allows output to be printed before a VM is defined, or in circumstances where a
VM may not be defined (such as an assertion failure in a <code>ficlSystem...()</code> function).

<li>
They no longer take a flag indicating whether or not to add a "newline".
Instead, the function must output a newline whenever it encounters
a <code>\n</code> character in the text.

</ul>

If you don't want to rewrite your output function yet, you can
"thunk" the new-style call to the old-style.  Just pass in <code>ficlOldnamesCallbackTextOut</code>
as the name of the output function for the system and VM, and then set 
the <code>thunkedTextout</code> member of the <code>ficlSystem</code>
or <code>ficlVm</code> to your old-style text output function.



<p>
</blockquote><table border=0 bgcolor=#b8b8b8 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=4><b><i>
<a name='RenamedMacros'>
Renamed Macros
</a></i></b></font></td></tr></table><p><blockquote>



<table width=100%><tr>

<td bgcolor=#d0d0f0><b>old name</b></td>

<td bgcolor=#e0e0ff><b>new name</td>

</tr>

<tr>

<td bgcolor=#e0e0e0><code>PUSHPTR(p)</code></td>

<td bgcolor=#f0f0f0><code>ficlStackPushPointer(vm->dataStack, p)</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>POPUNS()</code></td>

<td bgcolor=#f0f0f0><code>ficlStackPopUnsigned(vm->dataStack)</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>GETTOP()</code></td>

<td bgcolor=#f0f0f0><code>ficlStackGetTop(vm->dataStack)</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FW_IMMEDIATE</code></td>

<td bgcolor=#f0f0f0><code>FICL_WORD_IMMEDIATE</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>FW_COMPILE</code></td>

<td bgcolor=#f0f0f0><code>FICL_WORD_COMPILE_ONLY</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>VM_INNEREXIT</code></td>

<td bgcolor=#f0f0f0><code>FICL_VM_STATUS_INNER_EXIT</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>VM_OUTOFTEXT</code></td>

<td bgcolor=#f0f0f0><code>FICL_VM_STATUS_OUT_OF_TEXT</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>VM_RESTART</code></td>

<td bgcolor=#f0f0f0><code>FICL_VM_RESTART</code></td>

</tr>


</table><p>




<p>
</blockquote><table border=0 bgcolor=#b8b8b8 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=4><b><i>
<a name='codeficllocalh/code'>
<code>ficllocal.h</code>
</a></i></b></font></td></tr></table><p><blockquote>



One more note about macros.  Ficl now ships with a standard place for
you to tweak the Ficl compile-time preprocessor switches  such as
<code>FICL_WANT_COMPATIBILITY</code> and <code>FICL_WANT_FLOAT</code>.
It's a file called <code>ficllocal.h</code>, and we guarantee that it
will always ship empty (or with only comments).  We suggest that you
put all your local changes there, rather than editing <code>ficl.h</code>
or editing the makefile.  That should make it much easier to integrate
future Ficl releases into your product&mdash;all you need do is preserve
your tweaked copy of <code>ficllocal.h</code> and replace the rest.



<p>
</blockquote><table border=0 bgcolor=#b8b8b8 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=4><b><i>
<a name='RenamedFunctions'>
Renamed Functions
</a></i></b></font></td></tr></table><p><blockquote>



Every function that deals primarily with a particular structure
is now named after that structure.  For instance, any function
that takes a <code>ficlSystem</code> as its first argument is
named <code>ficlSystem<i>Something</i>()</code>.  Any function
that takes a <code>ficlVm</code> as its first argument is
named <code>ficlVm<i>Something</i>()</code>.  And so on.
<p>

Also, functions that create a new object are always
called <code>Create</code> (not <code>Alloc</code>, <code>Allot</code>, <code>Init</code>, or <code>New</code>).
Functions that create a new object are always
called <code>Destroy</code> (not <code>Free</code>, <code>Term</code>, or <code>Delete</code>).
<p>


<table width=100%><tr>

<td bgcolor=#d0d0f0><b>old name</b></td>

<td bgcolor=#e0e0ff><b>new name</td>

</tr>

<tr>

<td bgcolor=#e0e0e0><code>ficlInitSystem()</code></td>

<td bgcolor=#f0f0f0><code>ficlSystemCreate()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>ficlTermSystem()</code></td>

<td bgcolor=#f0f0f0><code>ficlSystemDestroy()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>ficlNewVM()</code></td>

<td bgcolor=#f0f0f0><code>ficlSystemCreateVm()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>ficlFreeVM()</code></td>

<td bgcolor=#f0f0f0><code>ficlVmDestroy()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>dictCreate()</code></td>

<td bgcolor=#f0f0f0><code>ficlDictionaryCreate()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>dictDelete()</code></td>

<td bgcolor=#f0f0f0><code>ficlDictionaryDestroy()</code></td>

</tr>


</table><p>


<p>

All functions exported by Ficl now start with the word <code>ficl</code>.
This is a <i>feature</i>, as it means the Ficl project will no longer
pollute your namespace.

<table width=100%><tr>

<td bgcolor=#d0d0f0><b>old name</b></td>

<td bgcolor=#e0e0ff><b>new name</td>

</tr>

<tr>

<td bgcolor=#e0e0e0><code>PUSHPTR(p)</code></td>

<td bgcolor=#f0f0f0><code>ficlStackPushPointer(vm->dataStack, p)</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>POPUNS()</code></td>

<td bgcolor=#f0f0f0><code>ficlStackPopUnsigned(vm->dataStack)</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>GETTOP()</code></td>

<td bgcolor=#f0f0f0><code>ficlStackGetTop(vm->dataStack)</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>ltoa()</code></td>

<td bgcolor=#f0f0f0><code>ficlLtoa()</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>strincmp()</code></td>

<td bgcolor=#f0f0f0><code>ficlStrincomp()</code></td>

</tr>


</table><p>






<p>
</blockquote><table border=0 bgcolor=#b8b8b8 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=4><b><i>
<a name='RemovedFunctions'>
Removed Functions
</a></i></b></font></td></tr></table><p><blockquote>



A few entry points have simply been removed.
For instance, functions specifically managing a system's <code>ENVIRONMENT</code>
settings have been removed, in favor of managing the system's
<code>environment</code> dictionary directly:
<table width=100%><tr>

<td bgcolor=#d0d0f0><b>old name</b></td>

<td bgcolor=#e0e0ff><b>new name</td>

</tr>

<tr>

<td bgcolor=#e0e0e0><code>ficlSystemSetEnvironment(system)</code></td>

<td bgcolor=#f0f0f0><code>ficlDictionarySetConstant(ficlSystemGetEnvironment(system), ...)</code></td>

</tr>


<tr>

<td bgcolor=#e0e0e0><code>ficlSystemSet2Environment(system)</code></td>

<td bgcolor=#f0f0f0><code>ficlDictionarySet2Constant(ficlSystemGetEnvironment(system), ...)</code></td>

</tr>


</table><p>




In a similar vein, <code>ficlSystemBuild()</code> has been removed in favor
of using <code>ficlDictionarySetPrimitive()</code> directly:

<table width=100%><tr>

<td bgcolor=#d0d0f0><b>old name</b></td>

<td bgcolor=#e0e0ff><b>new name</td>

</tr>

<tr>

<td bgcolor=#e0e0e0><code>ficlSystemBuild(system, ...)</code></td>

<td bgcolor=#f0f0f0><code>ficlDictionarySetPrimitive(ficlSystemGetDictionary(system), ...)</code></td>

</tr>


</table><p>



Finally, there is no <i>exact</i> replacement for <code>ficlExec()</code>.  99% of the code
that called <code>ficlExec()</code> never bothered to manage <code>SOURCE-ID</code> properly.
If you were calling <code>ficlExec()</code>, and you weren't changing <code>SOURCE-ID</code>
(or <code>vm->sourceId</code>) to match, you should replace those calls with <code>ficlVmEvaluate()</code>,
which will manage <code>SOURCE-ID</code> for you.
<p>

There <i>is</i> a function that takes the place of <code>ficlExec()</code> which doesn't change
<code>SOURCE-ID</code>: <code>ficlVmExecuteString()</code>.  However, instead of taking a
straight C string (a <code>char *</code>), it takes a <code>ficlString *</code> as its
code argument.  (This is to discourage its use.)



<p>
</blockquote><table border=0 bgcolor=#a0a0a0 width=100%><tr>

<td width=1em></td>
<td>
<font face=arial,helvetica color=#004968 size=5><b><i>
<a name='InternalChanges'>
Internal Changes
</a></i></b></font></td></tr></table><p><blockquote>



<b>Note:</b> none of these changes should affect you.  If they do, there's probably
a problem somewhere.  Either Ficl's API doesn't abstract away something enough, or
you are approaching a problem the wrong way.  Food for thought.
<p>

There's only one internal change worth noting here.
The top value on a Ficl stack used to be at (to use the modern structure names)
<code>stack->top[-1]</code>.  It is now at <code>stack->top[0]</code>.
In other words, the "stack top" pointer used to point <i>past</i> the top
element; it now points <i>at</i> the top element.  (Pointing <i>at</i> the
top element is not only less confusing, it is also faster.)

</body>
</html>