~ubuntu-branches/ubuntu/utopic/critcl/utopic

« back to all changes in this revision

Viewing changes to embedded/www/files/critcl_apppkg.html

  • Committer: Package Import Robot
  • Author(s): Andrew Shadura
  • Date: 2013-05-11 00:08:06 UTC
  • Revision ID: package-import@ubuntu.com-20130511000806-7hq1zc3fnn0gat79
Tags: upstream-3.1.9
ImportĀ upstreamĀ versionĀ 3.1.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
<html><head>
 
3
<title>critcl::app - C Runtime In Tcl (CriTcl)</title>
 
4
<style type="text/css"><!--
 
5
    HTML {
 
6
        background:     #FFFFFF;
 
7
        color:          black;
 
8
    }
 
9
    BODY {
 
10
        background:     #FFFFFF;
 
11
        color:          black;
 
12
    }
 
13
    DIV.doctools {
 
14
        margin-left:    10%;
 
15
        margin-right:   10%;
 
16
    }
 
17
    DIV.doctools H1,DIV.doctools H2 {
 
18
        margin-left:    -5%;
 
19
    }
 
20
    H1, H2, H3, H4 {
 
21
        margin-top:     1em;
 
22
        font-family:    sans-serif;
 
23
        font-size:      large;
 
24
        color:          #005A9C;
 
25
        background:     transparent;
 
26
        text-align:             left;
 
27
    }
 
28
    H1.title {
 
29
        text-align: center;
 
30
    }
 
31
    UL,OL {
 
32
        margin-right: 0em;
 
33
        margin-top: 3pt;
 
34
        margin-bottom: 3pt;
 
35
    }
 
36
    UL LI {
 
37
        list-style: disc;
 
38
    }
 
39
    OL LI {
 
40
        list-style: decimal;
 
41
    }
 
42
    DT {
 
43
        padding-top:    1ex;
 
44
    }
 
45
    UL.toc,UL.toc UL, UL.toc UL UL {
 
46
        font:           normal 12pt/14pt sans-serif;
 
47
        list-style:     none;
 
48
    }
 
49
    LI.section, LI.subsection {
 
50
        list-style:     none;
 
51
        margin-left:    0em;
 
52
        text-indent:    0em;
 
53
        padding:        0em;
 
54
    }
 
55
    PRE {
 
56
        display:        block;
 
57
        font-family:    monospace;
 
58
        white-space:    pre;
 
59
        margin:         0%;
 
60
        padding-top:    0.5ex;
 
61
        padding-bottom: 0.5ex;
 
62
        padding-left:   1ex;
 
63
        padding-right:  1ex;
 
64
        width:          100%;
 
65
    }
 
66
    PRE.example {
 
67
        color:          black;
 
68
        background:     #f5dcb3;
 
69
        border:         1px solid black;
 
70
    }
 
71
    UL.requirements LI, UL.syntax LI {
 
72
        list-style:     none;
 
73
        margin-left:    0em;
 
74
        text-indent:    0em;
 
75
        padding:        0em;
 
76
    }
 
77
    DIV.synopsis {
 
78
        color:          black;
 
79
        background:     #80ffff;
 
80
        border:         1px solid black;
 
81
        font-family:    serif;
 
82
        margin-top:     1em;
 
83
        margin-bottom:  1em;
 
84
    }
 
85
    UL.syntax {
 
86
        margin-top:     1em;
 
87
        border-top:     1px solid black;
 
88
    }
 
89
    UL.requirements {
 
90
        margin-bottom:  1em;
 
91
        border-bottom:  1px solid black;
 
92
    }
 
93
--></style>
 
94
</head>
 
95
<! -- Generated from file '/home/aku/Projects/Packages/Critcl/dev-master/embedded/www/files/critcl_apppkg.html' by tcllib/doctools with format 'html'
 
96
   -->
 
97
<! -- Copyright &copy; Jean-Claude Wippler   -- Copyright &copy; Steve Landers   -- Copyright &copy; 2011-2013 Andreas Kupries
 
98
   -->
 
99
<! -- CVS: $Id$ critcl::app.n
 
100
   -->
 
101
<body><div class="doctools">
 
102
<hr> [
 
103
  <a href="../toc.html">Table Of Contents</a>
 
104
| <a href="../index.html">Keyword Index</a>
 
105
] <hr>
 
106
<h1 class="title">critcl::app(n) 3.1.8 doc &quot;C Runtime In Tcl (CriTcl)&quot;</h1>
 
107
<div id="name" class="section"><h2><a name="name">Name</a></h2>
 
108
<p>critcl::app - Critcl - Application Package Reference</p>
 
109
</div>
 
110
<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
 
111
<ul class="toc">
 
112
<li class="section"><a href="#toc">Table Of Contents</a></li>
 
113
<li class="section"><a href="#synopsis">Synopsis</a></li>
 
114
<li class="section"><a href="#section1">Description</a></li>
 
115
<li class="section"><a href="#section2">API</a></li>
 
116
<li class="section"><a href="#section3">Options</a></li>
 
117
<li class="section"><a href="#section4">Modes Of Operation/Use</a></li>
 
118
<li class="section"><a href="#section5">Package Structure</a></li>
 
119
<li class="section"><a href="#section6">Changes for version 2.1</a></li>
 
120
<li class="section"><a href="#section7">Changes for version 3</a></li>
 
121
<li class="section"><a href="#section8">Changes for version 3.0.1</a></li>
 
122
<li class="section"><a href="#section9">Changes for version 3.0.2</a></li>
 
123
<li class="section"><a href="#section10">Changes for version 3.0.3</a></li>
 
124
<li class="section"><a href="#section11">Changes for version 3.0.4</a></li>
 
125
<li class="section"><a href="#section12">Changes for version 3.0.5</a></li>
 
126
<li class="section"><a href="#section13">Changes for version 3.0.6</a></li>
 
127
<li class="section"><a href="#section14">Changes for version 3.0.7</a></li>
 
128
<li class="section"><a href="#section15">Changes for version 3.1</a></li>
 
129
<li class="section"><a href="#section16">Changes for version 3.1.1</a></li>
 
130
<li class="section"><a href="#section17">Changes for version 3.1.2</a></li>
 
131
<li class="section"><a href="#section18">Changes for version 3.1.3</a></li>
 
132
<li class="section"><a href="#section19">Changes for version 3.1.4</a></li>
 
133
<li class="section"><a href="#section20">Changes for version 3.1.5</a></li>
 
134
<li class="section"><a href="#section21">Changes for version 3.1.6</a></li>
 
135
<li class="section"><a href="#section22">Changes for version 3.1.7</a></li>
 
136
<li class="section"><a href="#section23">Changes for version 3.1.8</a></li>
 
137
<li class="section"><a href="#section24">Changes for version 3.1.9</a></li>
 
138
<li class="section"><a href="#section25">Authors</a></li>
 
139
<li class="section"><a href="#section26">Bugs, Ideas, Feedback</a></li>
 
140
<li class="section"><a href="#keywords">Keywords</a></li>
 
141
<li class="section"><a href="#category">Category</a></li>
 
142
<li class="section"><a href="#copyright">Copyright</a></li>
 
143
</ul>
 
144
</div>
 
145
<div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2>
 
146
<div class="synopsis">
 
147
<ul class="requirements">
 
148
<li>package require <b class="pkgname">Tcl 8.4</b></li>
 
149
<li>package require <b class="pkgname">critcl::app <span class="opt">?3.1.8?</span></b></li>
 
150
<li>package require <b class="pkgname">critcl <span class="opt">?2?</span></b></li>
 
151
<li>package require <b class="pkgname">platform <span class="opt">?1.0.2?</span></b></li>
 
152
<li>package require <b class="pkgname">cmdline</b></li>
 
153
</ul>
 
154
<ul class="syntax">
 
155
<li><a href="#1"><b class="cmd">::critcl::app::main</b> <i class="arg">commandline</i></a></li>
 
156
</ul>
 
157
</div>
 
158
</div>
 
159
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
 
160
<p>Welcome to the <i class="term">C Runtime In Tcl</i>, <i class="term"><a href="critcl_pkg.html">CriTcl</a></i> for short, a
 
161
system to build C extension packages for Tcl on the fly, from C code
 
162
embedded within Tcl scripts, for all who wish to make their code go
 
163
faster.</p>
 
164
<p>This document is the reference manpage for the <b class="package">critcl::app</b>
 
165
package. Its intended audience are developers working on critcl's
 
166
internals.  Writers of packages with embedded C code can ignore this
 
167
document.
 
168
If you are in need of an overview of the whole system instead, please
 
169
go and read the <i class="term"><a href="critcl_introduction.html">Introduction To CriTcl</a></i>.</p>
 
170
<p>This package resides in the Application Layer of CriTcl.</p>
 
171
<p><img alt="arch_application" src="../image/arch_application.png"></p>
 
172
<p>,
 
173
implementing the functionality of the <i class="term"><a href="critcl_app.html">CriTcl Application</a></i>,
 
174
and through this, the mode <span class="sectref"><a href="#section4">generate package</a></span>.
 
175
The actual application is (only) a shim wrapping around this
 
176
package. It itself is build on top of the core package
 
177
<b class="package"><a href="critcl_pkg.html">critcl</a></b>.</p>
 
178
</div>
 
179
<div id="section2" class="section"><h2><a name="section2">API</a></h2>
 
180
<p>The package exports a single command</p>
 
181
<dl class="definitions">
 
182
<dt><a name="1"><b class="cmd">::critcl::app::main</b> <i class="arg">commandline</i></a></dt>
 
183
<dd><p>The <i class="arg">commandline</i> is a list of options and input files, in this order,
 
184
with both parts possibly empty.
 
185
The exact set of options supported, their meaning, and interaction is
 
186
detailed in section <span class="sectref"><a href="#section3">Options</a></span> below.
 
187
For a larger set of examples please see section &quot;Building Critcl Packages&quot;
 
188
in the document about <i class="term">Using CriTcl</i>.</p></dd>
 
189
</dl>
 
190
</div>
 
191
<div id="section3" class="section"><h2><a name="section3">Options</a></h2>
 
192
<p>The following options are understood</p>
 
193
<dl class="options">
 
194
<dt><b class="option">-v</b></dt>
 
195
<dd></dd>
 
196
<dt><b class="option">--version</b></dt>
 
197
<dd><p>These options cause critcl to print its version to <b class="const">stdout</b> and
 
198
then exit.</p></dd>
 
199
<dt><b class="option">-I</b> path</dt>
 
200
<dd><p>This option specifies an additional global include path to use during
 
201
compilation of &quot;<b class="file">.critcl</b>&quot; files. All values are used if this is
 
202
specified multiple times.</p>
 
203
<p>This option is irrelevant when generating a TEA package (see
 
204
option <b class="option">-tea</b> below).</p></dd>
 
205
<dt><b class="option">-L</b> path</dt>
 
206
<dd><p>This option specifies an additional global library searh path to use
 
207
during linking of &quot;<b class="file">.critcl</b>&quot; files. All values are used if this is
 
208
specified multiple times.</p>
 
209
<p>This option is irrelevant when generating a TEA package (see
 
210
option <b class="option">-tea</b> below).</p></dd>
 
211
<dt><b class="option">-cache</b> path</dt>
 
212
<dd><p>This option specifies the path to the directory to use as the result
 
213
cache. If not specified it defaults to &quot;<b class="file">~/.critcl/&lt;platform&gt;</b>&quot;,
 
214
or, when generating a package (see option <b class="option">-pkg</b> below), to
 
215
&quot;<b class="file">~/.critcl/&lt;pid&gt;.&lt;epoch&gt;</b>&quot;,
 
216
When specified multiple times the last value is used.</p>
 
217
<p>This option is irrelevant when generating a TEA package (see
 
218
option <b class="option">-tea</b> below).</p></dd>
 
219
<dt><b class="option">-clean</b></dt>
 
220
<dd><p>When specified the result cache is emptied, i.e. all files and
 
221
directories found inside are deleted) before compilation begins.</p>
 
222
<p>This option is irrelevant when generating a package (see option
 
223
<b class="option">-pkg</b> below) because this mode starts out with a unique and
 
224
empty result cache.</p>
 
225
<p>This option is irrelevant when generating a TEA package (see
 
226
option <b class="option">-tea</b> below).</p></dd>
 
227
<dt><b class="option">-config</b> path</dt>
 
228
<dd><p>This option specifies the path to a custom configuration file,
 
229
allowing the user to use their own target specifications. If not
 
230
specified a hardwired default configuration embedded in the system
 
231
core is used instead.
 
232
When specified multiple times the last value is used.</p>
 
233
<p>This option is irrelevant when generating a TEA package (see
 
234
option <b class="option">-tea</b> below).</p></dd>
 
235
<dt><b class="option">-debug</b> mode</dt>
 
236
<dd><p>This option activates compilation with debugging. It accepts the modes
 
237
below.
 
238
When specified multiple times the combination of all modes is used.</p>
 
239
<p>This option is irrelevant when generating a TEA package (see
 
240
option <b class="option">-tea</b> below).</p>
 
241
<dl class="definitions">
 
242
<dt><b class="const">memory</b></dt>
 
243
<dd><p>This mode activates memory debugging of allocations made through the
 
244
Tcl core.</p></dd>
 
245
<dt><b class="const">symbols</b></dt>
 
246
<dd><p>This mode activates building of all &quot;<b class="file">.c</b>&quot; files with debugging
 
247
symbols.</p></dd>
 
248
<dt><b class="const">all</b></dt>
 
249
<dd><p>This mode activates both <b class="const">memory</b> and <b class="const">symbols</b>.</p></dd>
 
250
</dl></dd>
 
251
<dt><b class="option">-disable</b> name</dt>
 
252
<dd><p>This option sets the value of the custom build configuration option
 
253
<i class="arg">name</i> to <b class="const">false</b>. It is equivalent to &quot;-with-<i class="arg">name</i> 0&quot;.</p>
 
254
<p>The information is validated only if one of the &quot;<b class="file">.critcl</b>&quot;
 
255
input files actually defines and uses a custom build configuration
 
256
option with that <i class="arg">name</i>.</p>
 
257
<p>This option is irrelevant when generating a TEA package (see
 
258
option <b class="option">-tea</b> below).</p></dd>
 
259
<dt><b class="option">-enable</b> name</dt>
 
260
<dd><p>This option sets the value of the custom build configuration option
 
261
<i class="arg">name</i> to <b class="const">true</b>. It is equivalent to &quot;-with-<i class="arg">name</i> 1&quot;.</p>
 
262
<p>The information is validated only if one of the &quot;<b class="file">.critcl</b>&quot;
 
263
input files actually defines and uses a custom build configuration
 
264
option with that <i class="arg">name</i>.</p>
 
265
<p>This option is irrelevant when generating a TEA package (see
 
266
option <b class="option">-tea</b> below).</p></dd>
 
267
<dt><b class="option">-force</b></dt>
 
268
<dd><p>When specified compilation is always done, even if a shared library
 
269
for the file exists already. This effect can be had through cleaning
 
270
the cache (see above) as well, except that it is lazy in the
 
271
destruction of files and will not destroy files unrelated to the ones
 
272
we are building.</p>
 
273
<p>This option is irrelevant when generating a package (see option
 
274
<b class="option">-pkg</b> below) because this mode starts out with a unique and
 
275
empty result cache.</p>
 
276
<p>This option is irrelevant when generating a TEA package (see
 
277
option <b class="option">-tea</b> below).</p></dd>
 
278
<dt><b class="option">-help</b></dt>
 
279
<dd><p>This option will cause the system to print a short help about command
 
280
line syntax and options and then exit the application.</p></dd>
 
281
<dt><b class="option">-keep</b></dt>
 
282
<dd><p>This option will cause the system to keep the &quot;<b class="file">.c</b>&quot; files
 
283
generated by a run in the result cache.
 
284
When generating a package (see option <b class="option">-pkg</b> below) this also
 
285
prevents the deletion of the unique result cache used by the run.
 
286
This option is intended for the debugging of <b class="cmd"><a href="critcl_pkg.html">critcl</a></b> itself,
 
287
where it may be necessary to inspect the generated C code.</p>
 
288
<p>This option is irrelevant when generating a TEA package (see
 
289
option <b class="option">-tea</b> below).</p></dd>
 
290
<dt><b class="option">-libdir</b> path</dt>
 
291
<dd><p>This option specifies the path under which the packages generated via
 
292
option <b class="option">-pkg</b> are saved. It also specifies a path to search
 
293
libraries in, like for <b class="option">-L</b>.
 
294
When specified multiple times the last value is used.
 
295
When not specified at all the default, &quot;<b class="file">lib</b>&quot;, is used. Note how
 
296
this is a relative path, placing the result into the current working
 
297
directory.</p></dd>
 
298
<dt><b class="option">-includedir</b> path</dt>
 
299
<dd><p>This option specifies the path under which any generated package
 
300
headers are saved. It also specifies a path to search include files
 
301
in, like for <b class="option">-I</b>.
 
302
When specified multiple times the last value is used as destination,
 
303
however all previous values are kept on the include search path.
 
304
When not specified at all the default, &quot;<b class="file">include</b>&quot;, is used. Note
 
305
how this is a relative path, placing the result into the current
 
306
working directory.</p>
 
307
<p>This option is irrelevant when generating a TEA package (see
 
308
option <b class="option">-tea</b> below).</p></dd>
 
309
<dt><b class="option">-pkg</b></dt>
 
310
<dd><p>The default mode of the application is to build the &quot;<b class="file">.critcl</b>&quot;
 
311
files listed on the command line and save the results in the result
 
312
cache. Essentially pre-filling the cache with important packages,
 
313
cutting down on the time needed to use these packages.</p>
 
314
<p>This option activates one of the other modes, package generation.
 
315
In this mode the input files are processed first as usual, however
 
316
after that they are bundled into a single library and additional files
 
317
are generated to make this library usable as a regular Tcl package.</p>
 
318
<p>The option <b class="option">-tea</b>, see below, invokes the last mode, TEA
 
319
generation. If both options, i.e. <b class="option">-pkg</b> and <b class="option">-tea</b> are
 
320
specified the last one specified wins.</p>
 
321
<p>In this mode the options <b class="option">-clean</b> and <b class="option">-force</b> are
 
322
irrelevant and ignored. In contrast, the option <b class="option">-libdir</b> is
 
323
relevant in both this and <b class="option">-tea</b> mode.</p>
 
324
<p>When this option is specified the basename of the first file argument
 
325
after the options is used as the name of the package to generate. If
 
326
the extension of that file indicates a shared library (&quot;<b class="file">.so</b>&quot;,
 
327
&quot;<b class="file">.sl</b>&quot;, &quot;<b class="file">.dylib</b>&quot;, and &quot;<b class="file">.dll</b>&quot;) it is also removed from
 
328
the set of input files. A &quot;<b class="file">.tcl</b>&quot; file is kept as part of the
 
329
input. A single file without extension is assumed to actually have a
 
330
&quot;<b class="file">.tcl</b>&quot; extension. A file without extension, but other input files
 
331
following is treated like the name of a shared library proper, and
 
332
removed from the set of input files.</p>
 
333
<p>Examples:</p>
 
334
<pre class="example">
 
335
        ... -pkg ... foo
 
336
        =&gt; Package name is: foo
 
337
        =&gt; Input file is:   foo.tcl
 
338
</pre>
 
339
<pre class="example">
 
340
        ... -pkg ... foo bar.tcl
 
341
        =&gt; Package name is: foo
 
342
        =&gt; Input file is:   bar.tcl
 
343
</pre>
 
344
<pre class="example">
 
345
        ... -pkg ... foo.tcl
 
346
        =&gt; Package name is: foo
 
347
        =&gt; Input file is:   foo.tcl
 
348
</pre>
 
349
<pre class="example">
 
350
        ... -pkg ... foo.so bar.tcl
 
351
        =&gt; Package name is: foo
 
352
        =&gt; Input file is:   bar.tcl
 
353
</pre>
 
354
</dd>
 
355
<dt><b class="option">-show</b></dt>
 
356
<dd><p>This option, when specified, will cause the system to print the
 
357
configuration of the chosen target to <b class="const">stdout</b> and then exit.
 
358
The choice of target can be influenced through the option
 
359
<b class="option">-target</b> (see below).</p></dd>
 
360
<dt><b class="option">-showall</b></dt>
 
361
<dd><p>This option, when specified, will cause the system to print the whole
 
362
chosen configuration file to <b class="const">stdout</b> and then exit.
 
363
The choice of configuration file can be influenced through the option
 
364
<b class="option">-config</b> (see above).</p></dd>
 
365
<dt><b class="option">-target</b> name</dt>
 
366
<dd><p>This option overrides the default choice of build target with
 
367
the user's choice.
 
368
When specified multiple times the last value is used.
 
369
The named target must exist in the chosen configuration file.
 
370
Use option <b class="option">-targets</b> (see below) to get a list of the
 
371
acceptable targets.
 
372
The choice of configuration file can be influenced through the option
 
373
<b class="option">-config</b> (see above).</p>
 
374
<p>This option is irrelevant when generating a TEA package (see
 
375
option <b class="option">-tea</b> below).</p></dd>
 
376
<dt><b class="option">-targets</b></dt>
 
377
<dd><p>This option, when specified, will cause the system to print the list
 
378
of all known targets from the chosen configuration file to
 
379
<b class="const">stdout</b> and then exit.
 
380
The choice of configuration file can be influenced through the option
 
381
<b class="option">-config</b> (see above).</p></dd>
 
382
<dt><b class="option">-tea</b></dt>
 
383
<dd><p>Similar to option <b class="option">-pkg</b>, except that the invoked mode does not
 
384
generate binaries, but a directory hierarchy containing the
 
385
&quot;<b class="file">.critcl</b>&quot; file, its companion files, and a TEA-lookalike build
 
386
system with most of the needed support code (incliding copies of the
 
387
critcl packages).</p>
 
388
<p>If both options, i.e. <b class="option">-pkg</b> and <b class="option">-tea</b> are specified
 
389
the last one specified wins.</p>
 
390
<p>In this mode the options <b class="option">-I</b>, <b class="option">-L</b>, <b class="option">-clean</b>,
 
391
<b class="option">-force</b>, <b class="option">-cache</b>, <b class="option">-includedir</b>, <b class="option">-enable</b>,
 
392
<b class="option">-disable</b>, and <b class="option">-with-<b class="variable">FOO</b></b> are irrelevant and
 
393
ignored. In contrast, the option <b class="option">-libdir</b> is relevant in both
 
394
this and <b class="option">-pkg</b> mode.</p>
 
395
<p>When this option is specified the basename of the first file argument
 
396
after the options is used as the name of the package to generate. If
 
397
the extension of that file indicates a shared library (&quot;<b class="file">.so</b>&quot;,
 
398
&quot;<b class="file">.sl</b>&quot;, &quot;<b class="file">.dylib</b>&quot;, and &quot;<b class="file">.dll</b>&quot;) it is also removed from
 
399
the set of input files. A &quot;<b class="file">.tcl</b>&quot; file is kept as part of the
 
400
input. A single file without extension is assumed to actually have a
 
401
&quot;<b class="file">.tcl</b>&quot; extension. A file without extension, but other input files
 
402
following is treated like the name of a shared library proper, and
 
403
removed from the set of input files.</p>
 
404
<p>Examples:</p>
 
405
<pre class="example">
 
406
        ... -tea ... foo
 
407
        =&gt; Package name is: foo
 
408
        =&gt; Input file is:   foo.tcl
 
409
</pre>
 
410
<pre class="example">
 
411
        ... -tea ... foo bar.tcl
 
412
        =&gt; Package name is: foo
 
413
        =&gt; Input file is:   bar.tcl
 
414
</pre>
 
415
<pre class="example">
 
416
        ... -tea ... foo.tcl
 
417
        =&gt; Package name is: foo
 
418
        =&gt; Input file is:   foo.tcl
 
419
</pre>
 
420
<pre class="example">
 
421
        ... -tea ... foo.so bar.tcl
 
422
        =&gt; Package name is: foo
 
423
        =&gt; Input file is:   bar.tcl
 
424
</pre>
 
425
</dd>
 
426
<dt><b class="option">-with-<b class="variable">name</b></b> value</dt>
 
427
<dd><p>This option sets the value of the custom build configuration option
 
428
<i class="arg">name</i> to <i class="arg">value</i>.</p>
 
429
<p>The information is validated only if one of the &quot;<b class="file">.critcl</b>&quot;
 
430
input files actually defines and uses a custom build configuration
 
431
option with that <i class="arg">name</i>.</p>
 
432
<p>This option is irrelevant when generating a TEA package (see
 
433
option <b class="option">-tea</b> above).</p></dd>
 
434
</dl>
 
435
</div>
 
436
<div id="section4" class="section"><h2><a name="section4">Modes Of Operation/Use</a></h2>
 
437
<p>CriTcl can be used in three different modes of operation, called</p>
 
438
<ol class="enumerated">
 
439
<li><p><i class="term"><a href="../index.html#key0">Compile &amp; Run</a></i>, and</p></li>
 
440
<li><p><i class="term"><a href="../index.html#key9">Generate Package</a></i></p></li>
 
441
<li><p><i class="term">Generate TEA Package</i></p></li>
 
442
</ol>
 
443
<p>Of these three <i class="term"><a href="../index.html#key0">Compile &amp; Run</a></i> came first and is the default
 
444
when using the package directly. In that case the package collects the
 
445
C fragments, builds them as needed, and caches the results for quick
 
446
reuse when the same code is used in the future again.</p>
 
447
<p>The second mode, <i class="term"><a href="../index.html#key9">Generate Package</a></i>, was introduced to enable
 
448
the creation of (prebuilt) deliverable packages which do not depend on
 
449
the existence of a build system, i.e. C compiler, on the target
 
450
machine.
 
451
This was originally done through the experimental <b class="cmd">Critbind</b> tool,
 
452
and is now handled by the <i class="term"><a href="critcl_app.html">CriTcl Application</a></i>, also named
 
453
<b class="cmd"><a href="critcl_pkg.html">critcl</a></b>.</p>
 
454
<p>Newly introduced with Critcl version 3 is
 
455
<i class="term">Generate TEA Package</i>. This mode constructs a directory
 
456
hierarchy from the package which can later be built like a regular TEA
 
457
package, i.e. using</p>
 
458
<pre class="example">
 
459
        .../configure --prefix ...
 
460
        make all isntall
 
461
</pre>
 
462
</div>
 
463
<div id="section5" class="section"><h2><a name="section5">Package Structure</a></h2>
 
464
<p>Packages generated by critcl have the following basic structure:</p>
 
465
<pre class="example">
 
466
&lt;TOP&gt;
 
467
+- pkgIndex.tcl
 
468
+- critcl-rt.tcl
 
469
+- license.terms (optional)
 
470
|
 
471
+- tcl (optional)
 
472
|  +- &lt;tsources files&gt;
 
473
|
 
474
+- &lt;platform&gt;
 
475
   +- &lt;shared library&gt;
 
476
</pre>
 
477
<p><em>Notes</em></p>
 
478
<ol class="enumerated">
 
479
<li><p>The file &quot;<b class="file">pkgIndex.tcl</b>&quot; is the standard package index file
 
480
expected by Tcl's package management. It is sourced during a search
 
481
for packages, and declares the package to Tcl with its files, and how
 
482
to handle them.</p></li>
 
483
<li><p>The file &quot;<b class="file">critcl-rt.tcl</b>&quot; is a helper file containing the
 
484
common code used by &quot;<b class="file">pkgIndex.tcl</b>&quot; to perform its tasks.</p></li>
 
485
<li><p>The file &quot;<b class="file">license.terms</b>&quot; is optional and appears only if
 
486
the &quot;<b class="file">.critcl</b>&quot; file the package is generated from used the command
 
487
<b class="cmd">critcl::license</b> to declare package author and license.</p></li>
 
488
<li><p>All files declared with the command <b class="cmd">critcl::tsources</b> are
 
489
put into the sub-directory &quot;<b class="file">tcl</b>&quot;.</p></li>
 
490
<li><p>The shared library generated by critcl is put into a
 
491
platform-specific sub-directory.</p></li>
 
492
</ol>
 
493
<p>The whole structure, and especially the last point, enable us
 
494
to later merge the results (for the same package, and version) for
 
495
multiple target platforms into a single directory structure without
 
496
conflict, by simply copying the top directories over each other. The
 
497
only files which can conflict are in the &lt;TOP&gt; and &quot;<b class="file">tcl</b>&quot;
 
498
directories, and for these we know that they are identical across
 
499
targets. The result of such a merge would look like:</p>
 
500
<pre class="example">
 
501
&lt;TOP&gt;
 
502
+- pkgIndex.tcl
 
503
+- critcl-rt.tcl
 
504
+- license.terms (optional)
 
505
|
 
506
+- tcl (optional)
 
507
|  +- &lt;tsources files&gt;
 
508
|
 
509
+- &lt;platform1&gt;
 
510
|  +- &lt;shared library1&gt;
 
511
+- &lt;platform2&gt;
 
512
|  +- &lt;shared library2&gt;
 
513
...
 
514
+- &lt;platformN&gt;
 
515
   +- &lt;shared libraryN&gt;
 
516
</pre>
 
517
</div>
 
518
<div id="section6" class="section"><h2><a name="section6">Changes for version 2.1</a></h2>
 
519
<ol class="enumerated">
 
520
<li><p>Fixed bug where <b class="cmd">critcl::tsources</b> interpreted relative
 
521
paths as relative to the current working directory instead of
 
522
relative to the &quot;<b class="file">.critcl</b>&quot; file using the command, as all other
 
523
commands of this type do.</p></li>
 
524
<li><p>Fixed internals, preventing information collected for multiple
 
525
&quot;<b class="file">.critcl</b>&quot; files to leak between them. Notably, <b class="cmd">critcl::tk</b>
 
526
is not a global configuration option anymore.</p></li>
 
527
<li><p>Fixed the command <b class="cmd">critcl::license</b> to be a null-operation
 
528
in mode &quot;compile &amp; run&quot;, instead of throwing an error.</p></li>
 
529
<li><p>Fixed the critcl application's interference with the &quot;compile &amp;
 
530
run&quot; result cache in <b class="option">-pkg</b> mode by having it use a wholly
 
531
separate (and by default transient) directory for that mode.</p></li>
 
532
<li><p>Fixed bug where changes to a &quot;<b class="file">.critcl</b>&quot; file did not result
 
533
in a rebuild for mode &quot;compile &amp; run&quot;. All relevant API commands now
 
534
ensure UUID changes.</p></li>
 
535
<li><p>Fixed bug in the backend handling of <b class="cmd">critcl::debug</b> where
 
536
the companion c-sources of a &quot;<b class="file">.critcl</b>&quot; file were not compiled
 
537
with debug options, although the &quot;<b class="file">.critcl</b>&quot; file was.</p></li>
 
538
<li><p>Fixed bug in <b class="cmd">critcl::debug</b> which prevented recognition of
 
539
mode &quot;all&quot; when it was not the first argument to the command.</p></li>
 
540
<li><p>Fixed bug in &quot;<b class="file">preload.c</b>&quot; preventing its compilation on
 
541
non-windows platforms.</p></li>
 
542
<li><p>Fixed long-standing bug in the handling of namespace qualifiers
 
543
in the command name argument of <b class="cmd">critcl::cproc</b> and
 
544
<b class="cmd">critcl::ccommand</b>. It is now possible to specify a fully
 
545
qualified command name without issues.</p></li>
 
546
<li><p>Extended/reworked <b class="cmd">critcl::tsources</b> to be the canonical
 
547
way of declaring &quot;<b class="file">.tcl</b>&quot; companion files even for mode &quot;compile &amp;
 
548
run&quot;.</p></li>
 
549
<li><p>Extended/reworked <b class="cmd">critcl::tsources</b> to allow the use of a
 
550
&quot;<b class="file">.critcl</b>&quot; file as its own Tcl companion file.</p></li>
 
551
<li><p>Extended <b class="cmd">critcl::framework</b> to internally check for OS X
 
552
build target, and to ignore the declaration if its not.</p></li>
 
553
<li><p>Extended <b class="cmd">critcl::failed</b> to be callable more than once in
 
554
a &quot;<b class="file">.critcl</b>&quot; file. The first call forces the build, if it was not
 
555
done already, to get the result. Further calls return the cached
 
556
result of the first call.</p></li>
 
557
<li><p>Extended the handling of environment variable CC in the code
 
558
determining the compiler to use to deal with (i.e. remove) paths to
 
559
the compiler, compiler file extensions, and compiler options specified
 
560
after the compiler itself, leaving only the bare name of the compiler.</p></li>
 
561
<li><p>Extended the code handling the search for preloaded libraries
 
562
to print the paths it searched, making debugging of a search failure
 
563
easier.</p></li>
 
564
<li><p>A new command <b class="cmd">critcl::tcl</b> can be used to declare the
 
565
version of Tcl minimally needed to build and run the &quot;<b class="file">.critcl</b>&quot;
 
566
file and package. Defaults to 8.4 if not declared. Extended critcl to
 
567
have the stubs and headers for all of Tcl 8.4, 8.5, and 8.6.</p></li>
 
568
<li><p>A new command <b class="cmd">critcl::load</b> forces the build and load of a
 
569
&quot;<b class="file">.critcl</b>&quot; file. This is the official way for overriding critcl's
 
570
default lazy-build-&amp;-load-on-demand scheme for mode &quot;compile &amp; run&quot;.</p>
 
571
<p><em>Note</em> that after using <b class="cmd">critcl::load</b> /
 
572
<b class="cmd">critcl::failed</b> in a &quot;<b class="file">.critcl</b>&quot; file it is not possible to
 
573
use critcl commands in that file anymore. Doing so will throw an
 
574
error.</p></li>
 
575
<li><p>Extended the generation of '#line' pragmas to use
 
576
<b class="cmd">info frame</b> (if available) to provide the C compiler with exact
 
577
line numbers into the &quot;<b class="file">.critcl</b>&quot; file for the reporting of
 
578
warnings and errors.</p></li>
 
579
<li><p>Extended <b class="cmd">critcl::check</b> with logging to help with
 
580
debugging build-time checks of the environment, plus an additional
 
581
optional argument to provide labeling.</p></li>
 
582
<li><p>Added a new command <b class="cmd">critcl::checklink</b> which not only
 
583
tries to check the environment via compiling the code, but also
 
584
its linkability.</p></li>
 
585
<li><p>Added a new command <b class="cmd">critcl::msg</b> for messaging, like
 
586
command <b class="cmd">critcl::error</b> is for error reporting. Likewise this is a
 
587
hook a user of the package is allowed to override. The default
 
588
implementation, used by mode <i class="term"><a href="../index.html#key0">compile &amp; run</a></i> does nothing. The
 
589
implementation for mode <i class="term"><a href="../index.html#key9">generate package</a></i> prints the message
 
590
to stdout.</p>
 
591
<p>Envisioned use is for the reporting of results determined by
 
592
<b class="cmd">critcl::check</b> and <b class="cmd">critcl::checklink</b> during building, to
 
593
help with debugging when something goes wrong with a check.</p></li>
 
594
<li><p>Exposed the argument processing internals of <b class="cmd">critcl::proc</b>
 
595
for use by advanced users. The new commands are</p>
 
596
<ol class="enumerated">
 
597
<li><p><b class="cmd">critcl::argnames</b></p></li>
 
598
<li><p><b class="cmd">critcl::argcnames</b></p></li>
 
599
<li><p><b class="cmd">critcl::argcsignature</b></p></li>
 
600
<li><p><b class="cmd">critcl::argvardecls</b></p></li>
 
601
<li><p><b class="cmd">critcl::argconversion</b></p></li>
 
602
</ol>
 
603
<p>Please see section <em>Advanced Embedded C Code</em> of the
 
604
<b class="package"><a href="critcl_pkg.html">critcl</a></b> package documentation for details.</p></li>
 
605
<li><p>Extended the critcl package to intercept <b class="cmd">package
 
606
provide</b> and record the file -&gt; package name mapping. Plus other
 
607
internal changes now allow the use of namespaced package names while
 
608
still using proper path names and init function.</p></li>
 
609
<li><p>Dropped the unused commands <b class="cmd">critcl::optimize</b> and
 
610
<b class="cmd">critcl::include</b>.</p></li>
 
611
<li><p>Dropped <b class="option">-lib</b> mode from the critcl application.</p></li>
 
612
<li><p>Dropped remnants of support for Tcl 8.3 and before.</p></li>
 
613
</ol>
 
614
</div>
 
615
<div id="section7" class="section"><h2><a name="section7">Changes for version 3</a></h2>
 
616
<ol class="enumerated">
 
617
<li><p>The command <b class="cmd">critcl::platform</b> was deprecated in version
 
618
2.1, superceded by <b class="cmd">critcl::targetplatform</b>, yet kept for
 
619
compatibility. Now it has been removed.</p></li>
 
620
<li><p>The command <b class="cmd">critcl::compiled</b> was kept with in version 2.1
 
621
with semantics in contradiction to its, for compatibility. This
 
622
contradiction has been removed, changing the visible semantics of the
 
623
command to be in line with its name.</p></li>
 
624
<li><p>The change to version 3 became necessary because of the two
 
625
incompatible visible changes above.</p></li>
 
626
<li><p>Extended the application package with code handling a new
 
627
option <b class="option">-tea</b>. Specifying this option invokes a special mode
 
628
where critcl generates a TEA package, i.e. wraps the input into a
 
629
directory hierarchy and support files which provide it TEA-lookalike
 
630
buildsystem.</p>
 
631
<p>This new option, and <b class="option">-pkg</b>, exclude each other. If
 
632
both are specified the last used option takes precedence.</p>
 
633
<p>The generated package directory hierarchy is mostly
 
634
self-contained, but not fully. It requires not only a working
 
635
installation of Tcl, but also working installations of the packages
 
636
<b class="package">md5</b> and <b class="package">cmdline</b>. Both of these are provided by the
 
637
<b class="package">Tcllib</b> bundle. Not required, but recommended to have
 
638
installed are any of the packages which can accelerate md5's
 
639
operation, i.e. <b class="package">cryptkit</b>, <b class="package">tcllibc</b>, or
 
640
<b class="package">Trf</b>.</p></li>
 
641
<li><p>Extended the critcl package with a new command
 
642
<b class="cmd">critcl::scan</b> taking the path to a &quot;<b class="file">.critcl</b>&quot; file,
 
643
statically scanning it, and returning license, version, a list of its
 
644
companion files, list of imported APIs, and list of
 
645
developer-specified custom configuration options. This data is the
 
646
foundation for the TEA wrapping described above.</p>
 
647
<p>Note that this is a <em>static</em> scan. While the other build
 
648
modes can (must) execute the &quot;<b class="file">.critcl</b>&quot; file and make
 
649
platform-specific decisions regarding the assembled C code, companion
 
650
files, etc. the TEA wrap mode is not in a position to make
 
651
platform-specific decisions. It has to wrap everything which might
 
652
conceivably be needed when actually building. Hence the static scan.
 
653
This has however its own set of problems, namely the inability to
 
654
figure out any dynamic construction of companion file paths, at least
 
655
on its own. Thus:</p></li>
 
656
<li><p>Extended the API used by critcl-based packages with the command
 
657
<b class="cmd">critcl::owns</b>. While this command is ignored by the regular build
 
658
modes the static scanner described above takes its arguments as the
 
659
names of companion files which have to be wrapped into the TEA package
 
660
and could not be figured by the scanner otherwise, like because of
 
661
dynamic paths to <b class="cmd">critcl::tsources</b>, <b class="cmd">critcl::csources</b>,
 
662
getting sourced directly, or simply being adjunct datafiles.</p></li>
 
663
<li><p>Extended the API used by critcl-based packages with the command
 
664
<b class="cmd">critcl::api</b> for the management of stubs tables, be it their use,
 
665
and/or declaration and export.</p>
 
666
<p>Please see section <em>Stubs Table Management</em> of the
 
667
<b class="package"><a href="critcl_pkg.html">critcl</a></b> package documentation for details.</p></li>
 
668
<li><p>Extended the API used by critcl-based packages with the command
 
669
<b class="cmd">critcl::userconfig</b> for the management of developer-specified
 
670
custom configuration options, be it their use and/or declaration.</p>
 
671
<p>Please see section <em>Custom Build Configuration</em> of the
 
672
<b class="package"><a href="critcl_pkg.html">critcl</a></b> package documentation for details.</p></li>
 
673
<li><p>Extended the API used by critcl-based packages with the
 
674
commands <b class="cmd">critcl::description</b>, <b class="cmd">critcl::summary</b>,
 
675
<b class="cmd">critcl::subject</b>, <b class="cmd">critcl::meta</b>, and
 
676
<b class="cmd">critcl::buildrequirement</b> for the declaration of TEApot meta data
 
677
for/about the package.</p>
 
678
<p>Please see section <em>Package Meta Data</em> of the
 
679
<b class="package"><a href="critcl_pkg.html">critcl</a></b> package documentation for details.</p></li>
 
680
</ol>
 
681
</div>
 
682
<div id="section8" class="section"><h2><a name="section8">Changes for version 3.0.1</a></h2>
 
683
<ol class="enumerated">
 
684
<li><p>Bugfixes all around. In detail:</p></li>
 
685
<li><p>Fixed recording of Tcl version requirements. Keep package name
 
686
and version together, unbreaking generated meta data and generated
 
687
package load command.</p></li>
 
688
<li><p>Fixed the build scripts: When installing, or wrapping for TEA,
 
689
generate any missing directories</p></li>
 
690
<li><p>Modified the build scripts to properly exit the application
 
691
when the window of their GUI is closed through the (X) button.</p></li>
 
692
<li><p>Removed an 8.5-ism (open wb) which had slipped into the main
 
693
build script.</p></li>
 
694
<li><p>Modified the example build scripts to separate the output for
 
695
the different examples (and packages) by adding empty lines.</p></li>
 
696
<li><p>stack::c example bugfix: Include API declarations for use in
 
697
the companion files.</p></li>
 
698
<li><p>Extended the documentation: Noted the need for a working
 
699
installation of a C compiler.</p></li>
 
700
<li><p>Extended the Windows target definitions and code to handle the
 
701
manifest files used by modern MS development environments. Note that
 
702
this code handles both possibilities, environment using manifests, and
 
703
(old(er)) environments without.</p></li>
 
704
<li><p>Extended the Windows 64bit target definitions and code to
 
705
auto-detect the need for the helper library &quot;bufferoverflowU.lib&quot; and
 
706
reconfigure the compile and link commands appropriately. We assume
 
707
that the library must be linked when present. This should be no harm
 
708
if the library is present, yet not needed. Just superfluous. We search
 
709
for the library in the paths specified by the environment variable
 
710
LIB.</p></li>
 
711
</ol>
 
712
</div>
 
713
<div id="section9" class="section"><h2><a name="section9">Changes for version 3.0.2</a></h2>
 
714
<ol class="enumerated">
 
715
<li><p>Fixed issue in compile-and-run mode where commands put into the
 
716
auto_index are not found by Tcl's [unknown] command.</p></li>
 
717
<li><p>Fixed an array key mismatch breaking usage of client data and
 
718
delete function for procedure. Reported by Jos DeCoster, with patch.</p></li>
 
719
<li><p>Implemented a command line option <b class="option">-L</b>, an equivalent of
 
720
option <b class="option">-I</b>, just for library search paths.</p></li>
 
721
<li><p>Fixed github issues 5 and 8. Working around a missing variable
 
722
::errorInfo. It should always be present, however there seem to be
 
723
revisions of Tcl around which violate this assumption.</p></li>
 
724
</ol>
 
725
</div>
 
726
<div id="section10" class="section"><h2><a name="section10">Changes for version 3.0.3</a></h2>
 
727
<ol class="enumerated">
 
728
<li><p>Fixed github issues 5 and 8, for the example build.tcl
 
729
scripts. Working around a missing variable ::errorInfo. It should
 
730
always be present, however there seem to be revisions of Tcl around
 
731
which violate this assumption.</p></li>
 
732
</ol>
 
733
</div>
 
734
<div id="section11" class="section"><h2><a name="section11">Changes for version 3.0.4</a></h2>
 
735
<ol class="enumerated">
 
736
<li><p>Fixed generation of the package's initname when the incoming
 
737
        code is read from stdin and has no proper path.</p></li>
 
738
<li><p>Fixed github issue 11. Now using /LIBPATH instead of -L
 
739
        on Windows (libinclude configuration setting).</p></li>
 
740
<li><p>Extended critcl to handle -l:path format of -l options.
 
741
        GNU ld 2.22+ handles this by searching for the path as
 
742
        is. Good when specifying static libraries, as plain -l looks
 
743
        for shared libraries in preference over static. critcl handles
 
744
        it now, as older GNU ld's do not understand it, nor the
 
745
        various vendor-specific linkers.</p></li>
 
746
<li><p>Fixed github issue #12. Critcl now determines the version of
 
747
        MSVC in use and uses it to switch between various link debug
 
748
        options. Simplified the handling of bufferoverflowU.lib also,
 
749
        making use of the same mechanism and collapsing the two
 
750
        configurations sections we had back into one.</p></li>
 
751
<li><p>Reworked the insertion of #line pragmas into the generated C
 
752
        code to avoid limitations on the line number argument imposed
 
753
        by various compilers, and be more accurate.</p></li>
 
754
<li><p>Modified argument processing. Option -libdir now also
 
755
        implies -L for its argument.</p></li>
 
756
<li><p>Extended handling of option -show (<b class="cmd">critcl::showconfig</b>)
 
757
        to list the path of the configuration file the data is coming
 
758
        from. Good for debugging configuration processing.</p></li>
 
759
<li><p>Extended the build script with targets to regenerate the
 
760
        embedded documentation, and diagrams, and to generate a
 
761
        release.</p></li>
 
762
</ol>
 
763
</div>
 
764
<div id="section12" class="section"><h2><a name="section12">Changes for version 3.0.5</a></h2>
 
765
<ol class="enumerated">
 
766
<li><p>Fixed bug in the new code for #line pragmas triggered when
 
767
        specifying C code without leading whitespace.</p></li>
 
768
<li><p>Extended the documentation to have manpages for the license,
 
769
        source retrieval, installer, and developer's guides.</p></li>
 
770
</ol>
 
771
</div>
 
772
<div id="section13" class="section"><h2><a name="section13">Changes for version 3.0.6</a></h2>
 
773
<ol class="enumerated">
 
774
<li><p>Fixed github issue 10. The critcl application now delivers a
 
775
        proper exit code (1) on build failure, instead of always
 
776
        indicating success (status 0).</p></li>
 
777
<li><p>Fixed github issue 13. Handling of bufferoverflowU.lib for
 
778
        release builds was inconsistent with handling for debug
 
779
        builds. It is now identically handled (conditional) by
 
780
        both cases.</p></li>
 
781
<li><p>Documentation cleanup, mainly in the installation guide, and
 
782
        the README.md shown by github</p></li>
 
783
</ol>
 
784
</div>
 
785
<div id="section14" class="section"><h2><a name="section14">Changes for version 3.0.7</a></h2>
 
786
<ol class="enumerated">
 
787
<li><p>Fixed the code generated by <b class="cmd">critcl::c++command</b>.
 
788
        The emitted code handed a non-static string table to
 
789
        <b class="function">Tcl_GetIndexFromObj</b>, in violation of the contract, which
 
790
        requires the table to have a fixed address. This was a memory
 
791
        smash waiting to happen. Thanks to Brian Griffin for alrerting
 
792
        us to the general problem.</p></li>
 
793
</ol>
 
794
</div>
 
795
<div id="section15" class="section"><h2><a name="section15">Changes for version 3.1</a></h2>
 
796
<ol class="enumerated">
 
797
<li><p>Added a new higher-level package <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b>.</p>
 
798
<p>This package simplifies the creation of code associating data
 
799
with an interpreter via Tcl's <b class="function">Tcl_(Get|Set)AssocData()</b> APIs. The
 
800
user can concentrate on his data while all the necessary boilerplate
 
801
C code to support this is generated by the package.</p>
 
802
<p>This package uses several of the new features which were added
 
803
to the core <b class="package"><a href="critcl_pkg.html">critcl</a></b> package, see below.</p></li>
 
804
<li><p>Added the higher-level package <b class="package"><a href="critcl_class.html">critcl::class</a></b>.</p>
 
805
<p>This package simplifies the creation of C level objects with
 
806
class and instance commands. The user can write a class definition
 
807
with class- and instance-variables and -methods similar to a TclOO
 
808
class, with all the necessary boilerplate C code to support this
 
809
generated by the package.</p>
 
810
<p>This package uses several of the new features which were added
 
811
to the core <b class="package"><a href="critcl_pkg.html">critcl</a></b> package, see below.</p></li>
 
812
<li><p>Extended the API for handling TEApot metadata. Added the
 
813
command <b class="cmd">critcl::meta?</b> to query the stored information. Main use
 
814
currently envisioned is retrieval of the current package's name by
 
815
utility commands, for use in constructed names. This particular
 
816
information is always available due to the static scan of the package
 
817
file on execution of the first critcl command.</p>
 
818
<p>The new packages <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b> and
 
819
<b class="package"><a href="critcl_class.html">critcl::class</a></b> (see above) are users of this command.</p></li>
 
820
<li><p>Extended the API with a command, <b class="cmd">critcl::name2c</b>, exposing
 
821
the process of converting a Tcl name into base name, namespace, and C
 
822
namespace. This enables higher-level code generators to generate the same
 
823
type of C identifiers as <b class="package"><a href="critcl_pkg.html">critcl</a></b> itself.</p>
 
824
<p>The new package <b class="package"><a href="critcl_class.html">critcl::class</a></b> (see above) is a user
 
825
of this command.</p></li>
 
826
<li><p>Extended the API with a command, <b class="cmd">critcl::source</b>,
 
827
executing critcl commands found in a separate file in the context of
 
828
the current file. This enables easier management of larger bodies of
 
829
code as it allows the user to split such up into easier to digest
 
830
smaller chunks without causing the generation of multiple packages.</p></li>
 
831
<li><p>Related to the previous item, extended the API with commands to
 
832
divert collection of generated C code into memory. This makes it
 
833
easier to use the commands for embedded C code in higher-level code
 
834
generators.</p>
 
835
<p>See the section <b class="sectref">Advanced: Diversions</b> for details of
 
836
the provided commands.</p>
 
837
<p>The new package <b class="package"><a href="critcl_class.html">critcl::class</a></b> (see above) is a user
 
838
of these facilities.</p></li>
 
839
<li><p>Extended the API with commands helping developers with the
 
840
generation of proper C <i class="term">#line</i> directives. This allows
 
841
higher-level code generators to generate and insert their own
 
842
directives, ensuring that compile errors in their code are properly
 
843
attributed.</p>
 
844
<p>See the section <b class="sectref">Advanced: Location management</b> for
 
845
details of the provided commands.</p>
 
846
<p>The new packages <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b> and
 
847
<b class="package"><a href="critcl_class.html">critcl::class</a></b> (see above) are users of these facilities.</p></li>
 
848
<li><p>Extended the API with commands giving users the ability to
 
849
define custom argument and result types for <b class="cmd">::critcl::cproc</b>.</p>
 
850
<p>See the section <b class="sectref">Advanced: Extending cproc</b> for
 
851
details of the provided commands.</p></li>
 
852
</ol>
 
853
</div>
 
854
<div id="section16" class="section"><h2><a name="section16">Changes for version 3.1.1</a></h2>
 
855
<ol class="enumerated">
 
856
<li><p>Bugfixes all around. In detail:</p></li>
 
857
<li><p>Fixed the generation of wrong#args errors for
 
858
<b class="cmd">critcl::cproc</b> and derived code (<b class="package"><a href="critcl_class.html">critcl::class</a></b>
 
859
cproc-based methods). Use NULL if there are no arguments, and
 
860
take the offset into account.</p></li>
 
861
<li><p>Fixed the handling of package names by
 
862
<b class="package"><a href="critcl_class.html">critcl::class</a></b>. Forgot that they may contain namespace
 
863
separators. Bumped to version 1.0.1.</p></li>
 
864
<li><p>Extended a <b class="package"><a href="critcl_class.html">critcl::class</a></b> generated error message in
 
865
instance creation for clarity. Bumped to version 1.0.2.</p></li>
 
866
</ol>
 
867
</div>
 
868
<div id="section17" class="section"><h2><a name="section17">Changes for version 3.1.2</a></h2>
 
869
<ol class="enumerated">
 
870
<li><p>Enhancement. In detail:</p></li>
 
871
<li><p>Extended <b class="cmd">critcl::cproc</b> to be able to handle optional
 
872
       arguments, in a limited way. This is automatically available to
 
873
       <b class="package"><a href="critcl_class.html">critcl::class</a></b> cproc-based methods as well.</p></li>
 
874
<li><p>Bugfix in <b class="cmd">lassign</b> emulation for Tcl 8.4.  Properly set
 
875
       unused variables to the empty string.  Bumped version of
 
876
       emulation package <b class="package">lassign84</b> to 1.0.1.</p></li>
 
877
</ol>
 
878
</div>
 
879
<div id="section18" class="section"><h2><a name="section18">Changes for version 3.1.3</a></h2>
 
880
<ol class="enumerated">
 
881
<li><p>Enhancement. In detail:</p></li>
 
882
<li><p>Added new argument type &quot;pstring&quot;, for &quot;Pascal String&quot;, a
 
883
       counted string, i.e. a combination of string pointer and string
 
884
       length.</p></li>
 
885
<li><p>Added new methods <b class="cmd">critcl::argtypesupport</b> and
 
886
       <b class="cmd">::critcl::argsupport</b> to define and use additional
 
887
       supporting code for an argument type, here used by &quot;pstring&quot;
 
888
       above to define the necessary structure.</p></li>
 
889
<li><p>Semi-bugfixes in the packages <b class="package"><a href="critcl_class.html">critcl::class</a></b> and
 
890
       <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b>. Pragmas for the AS meta data scanner
 
891
       to ensure that the template files are made part of the package.
 
892
       Versions bumped to 1.0.4 and 1.0.1 respectively.</p></li>
 
893
</ol>
 
894
</div>
 
895
<div id="section19" class="section"><h2><a name="section19">Changes for version 3.1.4</a></h2>
 
896
<ol class="enumerated">
 
897
<li><p>Bugfix in package <b class="package"><a href="critcl_class.html">critcl::class</a></b>. Generate a dummy
 
898
       field in the class structure if the class has no class
 
899
       variables. Without this change the structure would be empty,
 
900
       and a number of compilers are not able to handle such a type.</p></li>
 
901
<li><p>Fixed a typo which broke the win64 configuration.</p></li>
 
902
<li><p>Fixed issue #16, a typo in the documentation of command
 
903
       <b class="cmd"><a href="critcl_class.html">critcl::class</a></b>.</p></li>
 
904
</ol>
 
905
</div>
 
906
<div id="section20" class="section"><h2><a name="section20">Changes for version 3.1.5</a></h2>
 
907
<ol class="enumerated">
 
908
<li><p>Fixed issue #19. Made the regular expression extracting the
 
909
       MSVC version number more general to make it work on german
 
910
       language systems. This may have to be revisited in the future,
 
911
       for other Windows locales.</p></li>
 
912
<li><p>Fixed issue #20. Made option -tea work on windows, at least in
 
913
       a unix emulation environment like msys/mingw.</p></li>
 
914
</ol>
 
915
</div>
 
916
<div id="section21" class="section"><h2><a name="section21">Changes for version 3.1.6</a></h2>
 
917
<ol class="enumerated">
 
918
<li><p>Fixed issue #21. While the multi-definition of the stub-table
 
919
       pointer variables was ok with for all the C linkers seen so far
 
920
       C++ linkers did not like this at all. Reworked the code to
 
921
       ensure that this set of variables is generated only once, in
 
922
       the wrapper around all the pieces to assemble.</p></li>
 
923
<li><p>Fixed issue #22, the handling of the command identifier
 
924
       arguments of <b class="cmd">critcl::ccommand</b>, <b class="cmd">critcl::cproc</b>, and
 
925
       <b class="cmd">critcl::cdata</b>. We now properly allow any Tcl identifier
 
926
       and generate proper internal C identifiers from them.</p>
 
927
<p>As part of this the signature of command <b class="cmd">critcl::name2c</b>
 
928
       changed. The command now delivers a list of four values instead
 
929
       of three. The new value was added at the end.</p>
 
930
<p>Further adapted the implementation of package
 
931
       <b class="package"><a href="critcl_class.html">critcl::class</a></b>, a user of <b class="cmd">critcl::name2c</b>.
 
932
       This package is now at version 1.0.6 and requires critcl 3.1.6</p>
 
933
<p>Lastly fixed the mis-handling of option <b class="option">-cname</b> in
 
934
       <b class="cmd">critcl::ccommand</b>, and <b class="cmd">critcl::cproc</b>.</p></li>
 
935
<li><p>Fixed issue #23.</p></li>
 
936
</ol>
 
937
</div>
 
938
<div id="section22" class="section"><h2><a name="section22">Changes for version 3.1.7</a></h2>
 
939
<ol class="enumerated">
 
940
<li><p>Fixed issue #24. Extract and unconditionally display compiler
 
941
        warnings found in the build log. Prevents users from missing
 
942
        warnings which, while not causing the build to fail, may
 
943
        still indicate problems.</p></li>
 
944
<li><p>New feature. Output hook. All non-messaging user output is now
 
945
        routed through the command <b class="cmd">critcl::print</b>, and users are
 
946
        allowed to override it when using the critcl application-as-package.</p></li>
 
947
<li><p>New feature, by Ashok P. Nadkarni. Platform configurations can
 
948
        inherit values from configurations defined before them.</p></li>
 
949
</ol>
 
950
</div>
 
951
<div id="section23" class="section"><h2><a name="section23">Changes for version 3.1.8</a></h2>
 
952
<ol class="enumerated">
 
953
<li><p>Fixed issue with package indices generated for Tcl 8.4.
 
954
        Join the list of commands with semi-colon, not newline.</p></li>
 
955
<li><p>Fixed issue #26 which brought up use-cases I had forgotten to
 
956
        consider while fixing bug #21 (see critcl 3.1.6).</p></li>
 
957
</ol>
 
958
</div>
 
959
<div id="section24" class="section"><h2><a name="section24">Changes for version 3.1.9</a></h2>
 
960
<ol class="enumerated">
 
961
<li><p>Fixed issue #27. Added missing platform definitions for
 
962
        various alternate linux and OS X targets.</p></li>
 
963
<li><p>Fixed issue #28. Added missing -mXX flags for linking at the
 
964
        linux-{32,64}-* targets.</p></li>
 
965
<li><p>Fixed issue #29. Replaced the use of raw &quot;cheaders&quot;
 
966
        information in the processing of &quot;cdefines&quot; with the proper
 
967
        include directives derived from it.</p></li>
 
968
<li><p>Fixed the issue behind rejected pull request #30 by Andrew
 
969
        Shadura. Dynamically extract the stubs variable declarations
 
970
        from the Tcl header files and generate matching variable
 
971
        definitions for use in the package code. The generated code
 
972
        will now be always consistent with the headers, even when
 
973
        critcl's own copy of them is replaced by system headers.</p></li>
 
974
<li><p>Fixed issue #31. Accepted patch by Andrew Shadura, with
 
975
        changes (comments), for easier integration of critcl with
 
976
        OS package systems, replacing critcl's copies of Tcl headers
 
977
        with their own.</p></li>
 
978
<li><p>Fixed issue #32. Merged pull request by Andrew Shadura.
 
979
        Various typos in documentation and comments.</p></li>
 
980
<li><p>Fixed issue #33. Handle files starting with a dot better.</p></li>
 
981
</ol>
 
982
</div>
 
983
<div id="section25" class="section"><h2><a name="section25">Authors</a></h2>
 
984
<p>Jean Claude Wippler, Steve Landers, Andreas Kupries</p>
 
985
</div>
 
986
<div id="section26" class="section"><h2><a name="section26">Bugs, Ideas, Feedback</a></h2>
 
987
<p>This document, and the package it describes, will undoubtedly contain
 
988
bugs and other problems.
 
989
Please report them at <a href="https://github.com/andreas-kupries/critcl/issues">https://github.com/andreas-kupries/critcl/issues</a>.
 
990
Ideas for enhancements you may have for either package, application,
 
991
and/or the documentation are also very welcome and should be reported
 
992
at <a href="https://github.com/andreas-kupries/critcl/issues">https://github.com/andreas-kupries/critcl/issues</a> as well.</p>
 
993
</div>
 
994
<div id="keywords" class="section"><h2><a name="keywords">Keywords</a></h2>
 
995
<p><a href="../index.html#key8">C code</a>, <a href="../index.html#key3">Embedded C Code</a>, <a href="../index.html#key6">code generator</a>, <a href="../index.html#key0">compile &amp; run</a>, <a href="../index.html#key10">compiler</a>, <a href="../index.html#key1">dynamic code generation</a>, <a href="../index.html#key2">dynamic compilation</a>, <a href="../index.html#key9">generate package</a>, <a href="../index.html#key4">linker</a>, <a href="../index.html#key5">on demand compilation</a>, <a href="../index.html#key7">on-the-fly compilation</a></p>
 
996
</div>
 
997
<div id="category" class="section"><h2><a name="category">Category</a></h2>
 
998
<p>Glueing/Embedded C code</p>
 
999
</div>
 
1000
<div id="copyright" class="section"><h2><a name="copyright">Copyright</a></h2>
 
1001
<p>Copyright &copy; Jean-Claude Wippler<br>
 
1002
Copyright &copy; Steve Landers<br>
 
1003
Copyright &copy; 2011-2013 Andreas Kupries</p>
 
1004
</div>
 
1005
</div></body></html>