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

« back to all changes in this revision

Viewing changes to embedded/www/files/changes.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_changes - 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/changes.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_changes.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_changes(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_changes - CriTcl Changes</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="#section1">Description</a></li>
 
114
<li class="section"><a href="#section2">Changes for version 2.1</a></li>
 
115
<li class="section"><a href="#section3">Changes for version 3</a></li>
 
116
<li class="section"><a href="#section4">Changes for version 3.0.1</a></li>
 
117
<li class="section"><a href="#section5">Changes for version 3.0.2</a></li>
 
118
<li class="section"><a href="#section6">Changes for version 3.0.3</a></li>
 
119
<li class="section"><a href="#section7">Changes for version 3.0.4</a></li>
 
120
<li class="section"><a href="#section8">Changes for version 3.0.5</a></li>
 
121
<li class="section"><a href="#section9">Changes for version 3.0.6</a></li>
 
122
<li class="section"><a href="#section10">Changes for version 3.0.7</a></li>
 
123
<li class="section"><a href="#section11">Changes for version 3.1</a></li>
 
124
<li class="section"><a href="#section12">Changes for version 3.1.1</a></li>
 
125
<li class="section"><a href="#section13">Changes for version 3.1.2</a></li>
 
126
<li class="section"><a href="#section14">Changes for version 3.1.3</a></li>
 
127
<li class="section"><a href="#section15">Changes for version 3.1.4</a></li>
 
128
<li class="section"><a href="#section16">Changes for version 3.1.5</a></li>
 
129
<li class="section"><a href="#section17">Changes for version 3.1.6</a></li>
 
130
<li class="section"><a href="#section18">Changes for version 3.1.7</a></li>
 
131
<li class="section"><a href="#section19">Changes for version 3.1.8</a></li>
 
132
<li class="section"><a href="#section20">Changes for version 3.1.9</a></li>
 
133
<li class="section"><a href="#section21">Authors</a></li>
 
134
<li class="section"><a href="#section22">Bugs, Ideas, Feedback</a></li>
 
135
<li class="section"><a href="#keywords">Keywords</a></li>
 
136
<li class="section"><a href="#category">Category</a></li>
 
137
<li class="section"><a href="#copyright">Copyright</a></li>
 
138
</ul>
 
139
</div>
 
140
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
 
141
<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
 
142
system to build C extension packages for Tcl on the fly, from C code
 
143
embedded within Tcl scripts, for all who wish to make their code go
 
144
faster.</p>
 
145
<p>This document provides an overview of the changes <b class="package"><a href="critcl_pkg.html">critcl</a></b>
 
146
underwent from version to version.</p>
 
147
</div>
 
148
<div id="section2" class="section"><h2><a name="section2">Changes for version 2.1</a></h2>
 
149
<ol class="enumerated">
 
150
<li><p>Fixed bug where <b class="cmd">critcl::tsources</b> interpreted relative
 
151
paths as relative to the current working directory instead of
 
152
relative to the &quot;<b class="file">.critcl</b>&quot; file using the command, as all other
 
153
commands of this type do.</p></li>
 
154
<li><p>Fixed internals, preventing information collected for multiple
 
155
&quot;<b class="file">.critcl</b>&quot; files to leak between them. Notably, <b class="cmd">critcl::tk</b>
 
156
is not a global configuration option anymore.</p></li>
 
157
<li><p>Fixed the command <b class="cmd">critcl::license</b> to be a null-operation
 
158
in mode &quot;compile &amp; run&quot;, instead of throwing an error.</p></li>
 
159
<li><p>Fixed the critcl application's interference with the &quot;compile &amp;
 
160
run&quot; result cache in <b class="option">-pkg</b> mode by having it use a wholly
 
161
separate (and by default transient) directory for that mode.</p></li>
 
162
<li><p>Fixed bug where changes to a &quot;<b class="file">.critcl</b>&quot; file did not result
 
163
in a rebuild for mode &quot;compile &amp; run&quot;. All relevant API commands now
 
164
ensure UUID changes.</p></li>
 
165
<li><p>Fixed bug in the backend handling of <b class="cmd">critcl::debug</b> where
 
166
the companion c-sources of a &quot;<b class="file">.critcl</b>&quot; file were not compiled
 
167
with debug options, although the &quot;<b class="file">.critcl</b>&quot; file was.</p></li>
 
168
<li><p>Fixed bug in <b class="cmd">critcl::debug</b> which prevented recognition of
 
169
mode &quot;all&quot; when it was not the first argument to the command.</p></li>
 
170
<li><p>Fixed bug in &quot;<b class="file">preload.c</b>&quot; preventing its compilation on
 
171
non-windows platforms.</p></li>
 
172
<li><p>Fixed long-standing bug in the handling of namespace qualifiers
 
173
in the command name argument of <b class="cmd">critcl::cproc</b> and
 
174
<b class="cmd">critcl::ccommand</b>. It is now possible to specify a fully
 
175
qualified command name without issues.</p></li>
 
176
<li><p>Extended/reworked <b class="cmd">critcl::tsources</b> to be the canonical
 
177
way of declaring &quot;<b class="file">.tcl</b>&quot; companion files even for mode &quot;compile &amp;
 
178
run&quot;.</p></li>
 
179
<li><p>Extended/reworked <b class="cmd">critcl::tsources</b> to allow the use of a
 
180
&quot;<b class="file">.critcl</b>&quot; file as its own Tcl companion file.</p></li>
 
181
<li><p>Extended <b class="cmd">critcl::framework</b> to internally check for OS X
 
182
build target, and to ignore the declaration if its not.</p></li>
 
183
<li><p>Extended <b class="cmd">critcl::failed</b> to be callable more than once in
 
184
a &quot;<b class="file">.critcl</b>&quot; file. The first call forces the build, if it was not
 
185
done already, to get the result. Further calls return the cached
 
186
result of the first call.</p></li>
 
187
<li><p>Extended the handling of environment variable CC in the code
 
188
determining the compiler to use to deal with (i.e. remove) paths to
 
189
the compiler, compiler file extensions, and compiler options specified
 
190
after the compiler itself, leaving only the bare name of the compiler.</p></li>
 
191
<li><p>Extended the code handling the search for preloaded libraries
 
192
to print the paths it searched, making debugging of a search failure
 
193
easier.</p></li>
 
194
<li><p>A new command <b class="cmd">critcl::tcl</b> can be used to declare the
 
195
version of Tcl minimally needed to build and run the &quot;<b class="file">.critcl</b>&quot;
 
196
file and package. Defaults to 8.4 if not declared. Extended critcl to
 
197
have the stubs and headers for all of Tcl 8.4, 8.5, and 8.6.</p></li>
 
198
<li><p>A new command <b class="cmd">critcl::load</b> forces the build and load of a
 
199
&quot;<b class="file">.critcl</b>&quot; file. This is the official way for overriding critcl's
 
200
default lazy-build-&amp;-load-on-demand scheme for mode &quot;compile &amp; run&quot;.</p>
 
201
<p><em>Note</em> that after using <b class="cmd">critcl::load</b> /
 
202
<b class="cmd">critcl::failed</b> in a &quot;<b class="file">.critcl</b>&quot; file it is not possible to
 
203
use critcl commands in that file anymore. Doing so will throw an
 
204
error.</p></li>
 
205
<li><p>Extended the generation of '#line' pragmas to use
 
206
<b class="cmd">info frame</b> (if available) to provide the C compiler with exact
 
207
line numbers into the &quot;<b class="file">.critcl</b>&quot; file for the reporting of
 
208
warnings and errors.</p></li>
 
209
<li><p>Extended <b class="cmd">critcl::check</b> with logging to help with
 
210
debugging build-time checks of the environment, plus an additional
 
211
optional argument to provide labeling.</p></li>
 
212
<li><p>Added a new command <b class="cmd">critcl::checklink</b> which not only
 
213
tries to check the environment via compiling the code, but also
 
214
its linkability.</p></li>
 
215
<li><p>Added a new command <b class="cmd">critcl::msg</b> for messaging, like
 
216
command <b class="cmd">critcl::error</b> is for error reporting. Likewise this is a
 
217
hook a user of the package is allowed to override. The default
 
218
implementation, used by mode <i class="term"><a href="../index.html#key0">compile &amp; run</a></i> does nothing. The
 
219
implementation for mode <i class="term"><a href="../index.html#key9">generate package</a></i> prints the message
 
220
to stdout.</p>
 
221
<p>Envisioned use is for the reporting of results determined by
 
222
<b class="cmd">critcl::check</b> and <b class="cmd">critcl::checklink</b> during building, to
 
223
help with debugging when something goes wrong with a check.</p></li>
 
224
<li><p>Exposed the argument processing internals of <b class="cmd">critcl::proc</b>
 
225
for use by advanced users. The new commands are</p>
 
226
<ol class="enumerated">
 
227
<li><p><b class="cmd">critcl::argnames</b></p></li>
 
228
<li><p><b class="cmd">critcl::argcnames</b></p></li>
 
229
<li><p><b class="cmd">critcl::argcsignature</b></p></li>
 
230
<li><p><b class="cmd">critcl::argvardecls</b></p></li>
 
231
<li><p><b class="cmd">critcl::argconversion</b></p></li>
 
232
</ol>
 
233
<p>Please see section <em>Advanced Embedded C Code</em> of the
 
234
<b class="package"><a href="critcl_pkg.html">critcl</a></b> package documentation for details.</p></li>
 
235
<li><p>Extended the critcl package to intercept <b class="cmd">package
 
236
provide</b> and record the file -&gt; package name mapping. Plus other
 
237
internal changes now allow the use of namespaced package names while
 
238
still using proper path names and init function.</p></li>
 
239
<li><p>Dropped the unused commands <b class="cmd">critcl::optimize</b> and
 
240
<b class="cmd">critcl::include</b>.</p></li>
 
241
<li><p>Dropped <b class="option">-lib</b> mode from the critcl application.</p></li>
 
242
<li><p>Dropped remnants of support for Tcl 8.3 and before.</p></li>
 
243
</ol>
 
244
</div>
 
245
<div id="section3" class="section"><h2><a name="section3">Changes for version 3</a></h2>
 
246
<ol class="enumerated">
 
247
<li><p>The command <b class="cmd">critcl::platform</b> was deprecated in version
 
248
2.1, superceded by <b class="cmd">critcl::targetplatform</b>, yet kept for
 
249
compatibility. Now it has been removed.</p></li>
 
250
<li><p>The command <b class="cmd">critcl::compiled</b> was kept with in version 2.1
 
251
with semantics in contradiction to its, for compatibility. This
 
252
contradiction has been removed, changing the visible semantics of the
 
253
command to be in line with its name.</p></li>
 
254
<li><p>The change to version 3 became necessary because of the two
 
255
incompatible visible changes above.</p></li>
 
256
<li><p>Extended the application package with code handling a new
 
257
option <b class="option">-tea</b>. Specifying this option invokes a special mode
 
258
where critcl generates a TEA package, i.e. wraps the input into a
 
259
directory hierarchy and support files which provide it TEA-lookalike
 
260
buildsystem.</p>
 
261
<p>This new option, and <b class="option">-pkg</b>, exclude each other. If
 
262
both are specified the last used option takes precedence.</p>
 
263
<p>The generated package directory hierarchy is mostly
 
264
self-contained, but not fully. It requires not only a working
 
265
installation of Tcl, but also working installations of the packages
 
266
<b class="package">md5</b> and <b class="package">cmdline</b>. Both of these are provided by the
 
267
<b class="package">Tcllib</b> bundle. Not required, but recommended to have
 
268
installed are any of the packages which can accelerate md5's
 
269
operation, i.e. <b class="package">cryptkit</b>, <b class="package">tcllibc</b>, or
 
270
<b class="package">Trf</b>.</p></li>
 
271
<li><p>Extended the critcl package with a new command
 
272
<b class="cmd">critcl::scan</b> taking the path to a &quot;<b class="file">.critcl</b>&quot; file,
 
273
statically scanning it, and returning license, version, a list of its
 
274
companion files, list of imported APIs, and list of
 
275
developer-specified custom configuration options. This data is the
 
276
foundation for the TEA wrapping described above.</p>
 
277
<p>Note that this is a <em>static</em> scan. While the other build
 
278
modes can (must) execute the &quot;<b class="file">.critcl</b>&quot; file and make
 
279
platform-specific decisions regarding the assembled C code, companion
 
280
files, etc. the TEA wrap mode is not in a position to make
 
281
platform-specific decisions. It has to wrap everything which might
 
282
conceivably be needed when actually building. Hence the static scan.
 
283
This has however its own set of problems, namely the inability to
 
284
figure out any dynamic construction of companion file paths, at least
 
285
on its own. Thus:</p></li>
 
286
<li><p>Extended the API used by critcl-based packages with the command
 
287
<b class="cmd">critcl::owns</b>. While this command is ignored by the regular build
 
288
modes the static scanner described above takes its arguments as the
 
289
names of companion files which have to be wrapped into the TEA package
 
290
and could not be figured by the scanner otherwise, like because of
 
291
dynamic paths to <b class="cmd">critcl::tsources</b>, <b class="cmd">critcl::csources</b>,
 
292
getting sourced directly, or simply being adjunct datafiles.</p></li>
 
293
<li><p>Extended the API used by critcl-based packages with the command
 
294
<b class="cmd">critcl::api</b> for the management of stubs tables, be it their use,
 
295
and/or declaration and export.</p>
 
296
<p>Please see section <em>Stubs Table Management</em> of the
 
297
<b class="package"><a href="critcl_pkg.html">critcl</a></b> package documentation for details.</p></li>
 
298
<li><p>Extended the API used by critcl-based packages with the command
 
299
<b class="cmd">critcl::userconfig</b> for the management of developer-specified
 
300
custom configuration options, be it their use and/or declaration.</p>
 
301
<p>Please see section <em>Custom Build Configuration</em> of the
 
302
<b class="package"><a href="critcl_pkg.html">critcl</a></b> package documentation for details.</p></li>
 
303
<li><p>Extended the API used by critcl-based packages with the
 
304
commands <b class="cmd">critcl::description</b>, <b class="cmd">critcl::summary</b>,
 
305
<b class="cmd">critcl::subject</b>, <b class="cmd">critcl::meta</b>, and
 
306
<b class="cmd">critcl::buildrequirement</b> for the declaration of TEApot meta data
 
307
for/about the package.</p>
 
308
<p>Please see section <em>Package Meta Data</em> of the
 
309
<b class="package"><a href="critcl_pkg.html">critcl</a></b> package documentation for details.</p></li>
 
310
</ol>
 
311
</div>
 
312
<div id="section4" class="section"><h2><a name="section4">Changes for version 3.0.1</a></h2>
 
313
<ol class="enumerated">
 
314
<li><p>Bugfixes all around. In detail:</p></li>
 
315
<li><p>Fixed recording of Tcl version requirements. Keep package name
 
316
and version together, unbreaking generated meta data and generated
 
317
package load command.</p></li>
 
318
<li><p>Fixed the build scripts: When installing, or wrapping for TEA,
 
319
generate any missing directories</p></li>
 
320
<li><p>Modified the build scripts to properly exit the application
 
321
when the window of their GUI is closed through the (X) button.</p></li>
 
322
<li><p>Removed an 8.5-ism (open wb) which had slipped into the main
 
323
build script.</p></li>
 
324
<li><p>Modified the example build scripts to separate the output for
 
325
the different examples (and packages) by adding empty lines.</p></li>
 
326
<li><p>stack::c example bugfix: Include API declarations for use in
 
327
the companion files.</p></li>
 
328
<li><p>Extended the documentation: Noted the need for a working
 
329
installation of a C compiler.</p></li>
 
330
<li><p>Extended the Windows target definitions and code to handle the
 
331
manifest files used by modern MS development environments. Note that
 
332
this code handles both possibilities, environment using manifests, and
 
333
(old(er)) environments without.</p></li>
 
334
<li><p>Extended the Windows 64bit target definitions and code to
 
335
auto-detect the need for the helper library &quot;bufferoverflowU.lib&quot; and
 
336
reconfigure the compile and link commands appropriately. We assume
 
337
that the library must be linked when present. This should be no harm
 
338
if the library is present, yet not needed. Just superfluous. We search
 
339
for the library in the paths specified by the environment variable
 
340
LIB.</p></li>
 
341
</ol>
 
342
</div>
 
343
<div id="section5" class="section"><h2><a name="section5">Changes for version 3.0.2</a></h2>
 
344
<ol class="enumerated">
 
345
<li><p>Fixed issue in compile-and-run mode where commands put into the
 
346
auto_index are not found by Tcl's [unknown] command.</p></li>
 
347
<li><p>Fixed an array key mismatch breaking usage of client data and
 
348
delete function for procedure. Reported by Jos DeCoster, with patch.</p></li>
 
349
<li><p>Implemented a command line option <b class="option">-L</b>, an equivalent of
 
350
option <b class="option">-I</b>, just for library search paths.</p></li>
 
351
<li><p>Fixed github issues 5 and 8. Working around a missing variable
 
352
::errorInfo. It should always be present, however there seem to be
 
353
revisions of Tcl around which violate this assumption.</p></li>
 
354
</ol>
 
355
</div>
 
356
<div id="section6" class="section"><h2><a name="section6">Changes for version 3.0.3</a></h2>
 
357
<ol class="enumerated">
 
358
<li><p>Fixed github issues 5 and 8, for the example build.tcl
 
359
scripts. Working around a missing variable ::errorInfo. It should
 
360
always be present, however there seem to be revisions of Tcl around
 
361
which violate this assumption.</p></li>
 
362
</ol>
 
363
</div>
 
364
<div id="section7" class="section"><h2><a name="section7">Changes for version 3.0.4</a></h2>
 
365
<ol class="enumerated">
 
366
<li><p>Fixed generation of the package's initname when the incoming
 
367
        code is read from stdin and has no proper path.</p></li>
 
368
<li><p>Fixed github issue 11. Now using /LIBPATH instead of -L
 
369
        on Windows (libinclude configuration setting).</p></li>
 
370
<li><p>Extended critcl to handle -l:path format of -l options.
 
371
        GNU ld 2.22+ handles this by searching for the path as
 
372
        is. Good when specifying static libraries, as plain -l looks
 
373
        for shared libraries in preference over static. critcl handles
 
374
        it now, as older GNU ld's do not understand it, nor the
 
375
        various vendor-specific linkers.</p></li>
 
376
<li><p>Fixed github issue #12. Critcl now determines the version of
 
377
        MSVC in use and uses it to switch between various link debug
 
378
        options. Simplified the handling of bufferoverflowU.lib also,
 
379
        making use of the same mechanism and collapsing the two
 
380
        configurations sections we had back into one.</p></li>
 
381
<li><p>Reworked the insertion of #line pragmas into the generated C
 
382
        code to avoid limitations on the line number argument imposed
 
383
        by various compilers, and be more accurate.</p></li>
 
384
<li><p>Modified argument processing. Option -libdir now also
 
385
        implies -L for its argument.</p></li>
 
386
<li><p>Extended handling of option -show (<b class="cmd">critcl::showconfig</b>)
 
387
        to list the path of the configuration file the data is coming
 
388
        from. Good for debugging configuration processing.</p></li>
 
389
<li><p>Extended the build script with targets to regenerate the
 
390
        embedded documentation, and diagrams, and to generate a
 
391
        release.</p></li>
 
392
</ol>
 
393
</div>
 
394
<div id="section8" class="section"><h2><a name="section8">Changes for version 3.0.5</a></h2>
 
395
<ol class="enumerated">
 
396
<li><p>Fixed bug in the new code for #line pragmas triggered when
 
397
        specifying C code without leading whitespace.</p></li>
 
398
<li><p>Extended the documentation to have manpages for the license,
 
399
        source retrieval, installer, and developer's guides.</p></li>
 
400
</ol>
 
401
</div>
 
402
<div id="section9" class="section"><h2><a name="section9">Changes for version 3.0.6</a></h2>
 
403
<ol class="enumerated">
 
404
<li><p>Fixed github issue 10. The critcl application now delivers a
 
405
        proper exit code (1) on build failure, instead of always
 
406
        indicating success (status 0).</p></li>
 
407
<li><p>Fixed github issue 13. Handling of bufferoverflowU.lib for
 
408
        release builds was inconsistent with handling for debug
 
409
        builds. It is now identically handled (conditional) by
 
410
        both cases.</p></li>
 
411
<li><p>Documentation cleanup, mainly in the installation guide, and
 
412
        the README.md shown by github</p></li>
 
413
</ol>
 
414
</div>
 
415
<div id="section10" class="section"><h2><a name="section10">Changes for version 3.0.7</a></h2>
 
416
<ol class="enumerated">
 
417
<li><p>Fixed the code generated by <b class="cmd">critcl::c++command</b>.
 
418
        The emitted code handed a non-static string table to
 
419
        <b class="function">Tcl_GetIndexFromObj</b>, in violation of the contract, which
 
420
        requires the table to have a fixed address. This was a memory
 
421
        smash waiting to happen. Thanks to Brian Griffin for alrerting
 
422
        us to the general problem.</p></li>
 
423
</ol>
 
424
</div>
 
425
<div id="section11" class="section"><h2><a name="section11">Changes for version 3.1</a></h2>
 
426
<ol class="enumerated">
 
427
<li><p>Added a new higher-level package <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b>.</p>
 
428
<p>This package simplifies the creation of code associating data
 
429
with an interpreter via Tcl's <b class="function">Tcl_(Get|Set)AssocData()</b> APIs. The
 
430
user can concentrate on his data while all the necessary boilerplate
 
431
C code to support this is generated by the package.</p>
 
432
<p>This package uses several of the new features which were added
 
433
to the core <b class="package"><a href="critcl_pkg.html">critcl</a></b> package, see below.</p></li>
 
434
<li><p>Added the higher-level package <b class="package"><a href="critcl_class.html">critcl::class</a></b>.</p>
 
435
<p>This package simplifies the creation of C level objects with
 
436
class and instance commands. The user can write a class definition
 
437
with class- and instance-variables and -methods similar to a TclOO
 
438
class, with all the necessary boilerplate C code to support this
 
439
generated by the package.</p>
 
440
<p>This package uses several of the new features which were added
 
441
to the core <b class="package"><a href="critcl_pkg.html">critcl</a></b> package, see below.</p></li>
 
442
<li><p>Extended the API for handling TEApot metadata. Added the
 
443
command <b class="cmd">critcl::meta?</b> to query the stored information. Main use
 
444
currently envisioned is retrieval of the current package's name by
 
445
utility commands, for use in constructed names. This particular
 
446
information is always available due to the static scan of the package
 
447
file on execution of the first critcl command.</p>
 
448
<p>The new packages <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b> and
 
449
<b class="package"><a href="critcl_class.html">critcl::class</a></b> (see above) are users of this command.</p></li>
 
450
<li><p>Extended the API with a command, <b class="cmd">critcl::name2c</b>, exposing
 
451
the process of converting a Tcl name into base name, namespace, and C
 
452
namespace. This enables higher-level code generators to generate the same
 
453
type of C identifiers as <b class="package"><a href="critcl_pkg.html">critcl</a></b> itself.</p>
 
454
<p>The new package <b class="package"><a href="critcl_class.html">critcl::class</a></b> (see above) is a user
 
455
of this command.</p></li>
 
456
<li><p>Extended the API with a command, <b class="cmd">critcl::source</b>,
 
457
executing critcl commands found in a separate file in the context of
 
458
the current file. This enables easier management of larger bodies of
 
459
code as it allows the user to split such up into easier to digest
 
460
smaller chunks without causing the generation of multiple packages.</p></li>
 
461
<li><p>Related to the previous item, extended the API with commands to
 
462
divert collection of generated C code into memory. This makes it
 
463
easier to use the commands for embedded C code in higher-level code
 
464
generators.</p>
 
465
<p>See the section <b class="sectref">Advanced: Diversions</b> for details of
 
466
the provided commands.</p>
 
467
<p>The new package <b class="package"><a href="critcl_class.html">critcl::class</a></b> (see above) is a user
 
468
of these facilities.</p></li>
 
469
<li><p>Extended the API with commands helping developers with the
 
470
generation of proper C <i class="term">#line</i> directives. This allows
 
471
higher-level code generators to generate and insert their own
 
472
directives, ensuring that compile errors in their code are properly
 
473
attributed.</p>
 
474
<p>See the section <b class="sectref">Advanced: Location management</b> for
 
475
details of the provided commands.</p>
 
476
<p>The new packages <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b> and
 
477
<b class="package"><a href="critcl_class.html">critcl::class</a></b> (see above) are users of these facilities.</p></li>
 
478
<li><p>Extended the API with commands giving users the ability to
 
479
define custom argument and result types for <b class="cmd">::critcl::cproc</b>.</p>
 
480
<p>See the section <b class="sectref">Advanced: Extending cproc</b> for
 
481
details of the provided commands.</p></li>
 
482
</ol>
 
483
</div>
 
484
<div id="section12" class="section"><h2><a name="section12">Changes for version 3.1.1</a></h2>
 
485
<ol class="enumerated">
 
486
<li><p>Bugfixes all around. In detail:</p></li>
 
487
<li><p>Fixed the generation of wrong#args errors for
 
488
<b class="cmd">critcl::cproc</b> and derived code (<b class="package"><a href="critcl_class.html">critcl::class</a></b>
 
489
cproc-based methods). Use NULL if there are no arguments, and
 
490
take the offset into account.</p></li>
 
491
<li><p>Fixed the handling of package names by
 
492
<b class="package"><a href="critcl_class.html">critcl::class</a></b>. Forgot that they may contain namespace
 
493
separators. Bumped to version 1.0.1.</p></li>
 
494
<li><p>Extended a <b class="package"><a href="critcl_class.html">critcl::class</a></b> generated error message in
 
495
instance creation for clarity. Bumped to version 1.0.2.</p></li>
 
496
</ol>
 
497
</div>
 
498
<div id="section13" class="section"><h2><a name="section13">Changes for version 3.1.2</a></h2>
 
499
<ol class="enumerated">
 
500
<li><p>Enhancement. In detail:</p></li>
 
501
<li><p>Extended <b class="cmd">critcl::cproc</b> to be able to handle optional
 
502
       arguments, in a limited way. This is automatically available to
 
503
       <b class="package"><a href="critcl_class.html">critcl::class</a></b> cproc-based methods as well.</p></li>
 
504
<li><p>Bugfix in <b class="cmd">lassign</b> emulation for Tcl 8.4.  Properly set
 
505
       unused variables to the empty string.  Bumped version of
 
506
       emulation package <b class="package">lassign84</b> to 1.0.1.</p></li>
 
507
</ol>
 
508
</div>
 
509
<div id="section14" class="section"><h2><a name="section14">Changes for version 3.1.3</a></h2>
 
510
<ol class="enumerated">
 
511
<li><p>Enhancement. In detail:</p></li>
 
512
<li><p>Added new argument type &quot;pstring&quot;, for &quot;Pascal String&quot;, a
 
513
       counted string, i.e. a combination of string pointer and string
 
514
       length.</p></li>
 
515
<li><p>Added new methods <b class="cmd">critcl::argtypesupport</b> and
 
516
       <b class="cmd">::critcl::argsupport</b> to define and use additional
 
517
       supporting code for an argument type, here used by &quot;pstring&quot;
 
518
       above to define the necessary structure.</p></li>
 
519
<li><p>Semi-bugfixes in the packages <b class="package"><a href="critcl_class.html">critcl::class</a></b> and
 
520
       <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b>. Pragmas for the AS meta data scanner
 
521
       to ensure that the template files are made part of the package.
 
522
       Versions bumped to 1.0.4 and 1.0.1 respectively.</p></li>
 
523
</ol>
 
524
</div>
 
525
<div id="section15" class="section"><h2><a name="section15">Changes for version 3.1.4</a></h2>
 
526
<ol class="enumerated">
 
527
<li><p>Bugfix in package <b class="package"><a href="critcl_class.html">critcl::class</a></b>. Generate a dummy
 
528
       field in the class structure if the class has no class
 
529
       variables. Without this change the structure would be empty,
 
530
       and a number of compilers are not able to handle such a type.</p></li>
 
531
<li><p>Fixed a typo which broke the win64 configuration.</p></li>
 
532
<li><p>Fixed issue #16, a typo in the documentation of command
 
533
       <b class="cmd"><a href="critcl_class.html">critcl::class</a></b>.</p></li>
 
534
</ol>
 
535
</div>
 
536
<div id="section16" class="section"><h2><a name="section16">Changes for version 3.1.5</a></h2>
 
537
<ol class="enumerated">
 
538
<li><p>Fixed issue #19. Made the regular expression extracting the
 
539
       MSVC version number more general to make it work on german
 
540
       language systems. This may have to be revisited in the future,
 
541
       for other Windows locales.</p></li>
 
542
<li><p>Fixed issue #20. Made option -tea work on windows, at least in
 
543
       a unix emulation environment like msys/mingw.</p></li>
 
544
</ol>
 
545
</div>
 
546
<div id="section17" class="section"><h2><a name="section17">Changes for version 3.1.6</a></h2>
 
547
<ol class="enumerated">
 
548
<li><p>Fixed issue #21. While the multi-definition of the stub-table
 
549
       pointer variables was ok with for all the C linkers seen so far
 
550
       C++ linkers did not like this at all. Reworked the code to
 
551
       ensure that this set of variables is generated only once, in
 
552
       the wrapper around all the pieces to assemble.</p></li>
 
553
<li><p>Fixed issue #22, the handling of the command identifier
 
554
       arguments of <b class="cmd">critcl::ccommand</b>, <b class="cmd">critcl::cproc</b>, and
 
555
       <b class="cmd">critcl::cdata</b>. We now properly allow any Tcl identifier
 
556
       and generate proper internal C identifiers from them.</p>
 
557
<p>As part of this the signature of command <b class="cmd">critcl::name2c</b>
 
558
       changed. The command now delivers a list of four values instead
 
559
       of three. The new value was added at the end.</p>
 
560
<p>Further adapted the implementation of package
 
561
       <b class="package"><a href="critcl_class.html">critcl::class</a></b>, a user of <b class="cmd">critcl::name2c</b>.
 
562
       This package is now at version 1.0.6 and requires critcl 3.1.6</p>
 
563
<p>Lastly fixed the mis-handling of option <b class="option">-cname</b> in
 
564
       <b class="cmd">critcl::ccommand</b>, and <b class="cmd">critcl::cproc</b>.</p></li>
 
565
<li><p>Fixed issue #23.</p></li>
 
566
</ol>
 
567
</div>
 
568
<div id="section18" class="section"><h2><a name="section18">Changes for version 3.1.7</a></h2>
 
569
<ol class="enumerated">
 
570
<li><p>Fixed issue #24. Extract and unconditionally display compiler
 
571
        warnings found in the build log. Prevents users from missing
 
572
        warnings which, while not causing the build to fail, may
 
573
        still indicate problems.</p></li>
 
574
<li><p>New feature. Output hook. All non-messaging user output is now
 
575
        routed through the command <b class="cmd">critcl::print</b>, and users are
 
576
        allowed to override it when using the critcl application-as-package.</p></li>
 
577
<li><p>New feature, by Ashok P. Nadkarni. Platform configurations can
 
578
        inherit values from configurations defined before them.</p></li>
 
579
</ol>
 
580
</div>
 
581
<div id="section19" class="section"><h2><a name="section19">Changes for version 3.1.8</a></h2>
 
582
<ol class="enumerated">
 
583
<li><p>Fixed issue with package indices generated for Tcl 8.4.
 
584
        Join the list of commands with semi-colon, not newline.</p></li>
 
585
<li><p>Fixed issue #26 which brought up use-cases I had forgotten to
 
586
        consider while fixing bug #21 (see critcl 3.1.6).</p></li>
 
587
</ol>
 
588
</div>
 
589
<div id="section20" class="section"><h2><a name="section20">Changes for version 3.1.9</a></h2>
 
590
<ol class="enumerated">
 
591
<li><p>Fixed issue #27. Added missing platform definitions for
 
592
        various alternate linux and OS X targets.</p></li>
 
593
<li><p>Fixed issue #28. Added missing -mXX flags for linking at the
 
594
        linux-{32,64}-* targets.</p></li>
 
595
<li><p>Fixed issue #29. Replaced the use of raw &quot;cheaders&quot;
 
596
        information in the processing of &quot;cdefines&quot; with the proper
 
597
        include directives derived from it.</p></li>
 
598
<li><p>Fixed the issue behind rejected pull request #30 by Andrew
 
599
        Shadura. Dynamically extract the stubs variable declarations
 
600
        from the Tcl header files and generate matching variable
 
601
        definitions for use in the package code. The generated code
 
602
        will now be always consistent with the headers, even when
 
603
        critcl's own copy of them is replaced by system headers.</p></li>
 
604
<li><p>Fixed issue #31. Accepted patch by Andrew Shadura, with
 
605
        changes (comments), for easier integration of critcl with
 
606
        OS package systems, replacing critcl's copies of Tcl headers
 
607
        with their own.</p></li>
 
608
<li><p>Fixed issue #32. Merged pull request by Andrew Shadura.
 
609
        Various typos in documentation and comments.</p></li>
 
610
<li><p>Fixed issue #33. Handle files starting with a dot better.</p></li>
 
611
</ol>
 
612
</div>
 
613
<div id="section21" class="section"><h2><a name="section21">Authors</a></h2>
 
614
<p>Jean Claude Wippler, Steve Landers, Andreas Kupries</p>
 
615
</div>
 
616
<div id="section22" class="section"><h2><a name="section22">Bugs, Ideas, Feedback</a></h2>
 
617
<p>This document, and the package it describes, will undoubtedly contain
 
618
bugs and other problems.
 
619
Please report them at <a href="https://github.com/andreas-kupries/critcl/issues">https://github.com/andreas-kupries/critcl/issues</a>.
 
620
Ideas for enhancements you may have for either package, application,
 
621
and/or the documentation are also very welcome and should be reported
 
622
at <a href="https://github.com/andreas-kupries/critcl/issues">https://github.com/andreas-kupries/critcl/issues</a> as well.</p>
 
623
</div>
 
624
<div id="keywords" class="section"><h2><a name="keywords">Keywords</a></h2>
 
625
<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>
 
626
</div>
 
627
<div id="category" class="section"><h2><a name="category">Category</a></h2>
 
628
<p>Glueing/Embedded C code</p>
 
629
</div>
 
630
<div id="copyright" class="section"><h2><a name="copyright">Copyright</a></h2>
 
631
<p>Copyright &copy; Jean-Claude Wippler<br>
 
632
Copyright &copy; Steve Landers<br>
 
633
Copyright &copy; 2011-2013 Andreas Kupries</p>
 
634
</div>
 
635
</div></body></html>