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

« back to all changes in this revision

Viewing changes to embedded/man/files/changes.n

  • 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
'\" Generated from file '/home/aku/Projects/Packages/Critcl/dev-master/embedded/man/files/changes\&.n' by tcllib/doctools with format 'nroff'
 
3
'\" Copyright (c) Jean-Claude Wippler
 
4
'\" Copyright (c) Steve Landers
 
5
'\" Copyright (c) 2011-2013 Andreas Kupries
 
6
'\"
 
7
'\" The definitions below are for supplemental macros used in Tcl/Tk
 
8
'\" manual entries.
 
9
'\"
 
10
'\" .AP type name in/out ?indent?
 
11
'\"     Start paragraph describing an argument to a library procedure.
 
12
'\"     type is type of argument (int, etc.), in/out is either "in", "out",
 
13
'\"     or "in/out" to describe whether procedure reads or modifies arg,
 
14
'\"     and indent is equivalent to second arg of .IP (shouldn't ever be
 
15
'\"     needed;  use .AS below instead)
 
16
'\"
 
17
'\" .AS ?type? ?name?
 
18
'\"     Give maximum sizes of arguments for setting tab stops.  Type and
 
19
'\"     name are examples of largest possible arguments that will be passed
 
20
'\"     to .AP later.  If args are omitted, default tab stops are used.
 
21
'\"
 
22
'\" .BS
 
23
'\"     Start box enclosure.  From here until next .BE, everything will be
 
24
'\"     enclosed in one large box.
 
25
'\"
 
26
'\" .BE
 
27
'\"     End of box enclosure.
 
28
'\"
 
29
'\" .CS
 
30
'\"     Begin code excerpt.
 
31
'\"
 
32
'\" .CE
 
33
'\"     End code excerpt.
 
34
'\"
 
35
'\" .VS ?version? ?br?
 
36
'\"     Begin vertical sidebar, for use in marking newly-changed parts
 
37
'\"     of man pages.  The first argument is ignored and used for recording
 
38
'\"     the version when the .VS was added, so that the sidebars can be
 
39
'\"     found and removed when they reach a certain age.  If another argument
 
40
'\"     is present, then a line break is forced before starting the sidebar.
 
41
'\"
 
42
'\" .VE
 
43
'\"     End of vertical sidebar.
 
44
'\"
 
45
'\" .DS
 
46
'\"     Begin an indented unfilled display.
 
47
'\"
 
48
'\" .DE
 
49
'\"     End of indented unfilled display.
 
50
'\"
 
51
'\" .SO
 
52
'\"     Start of list of standard options for a Tk widget.  The
 
53
'\"     options follow on successive lines, in four columns separated
 
54
'\"     by tabs.
 
55
'\"
 
56
'\" .SE
 
57
'\"     End of list of standard options for a Tk widget.
 
58
'\"
 
59
'\" .OP cmdName dbName dbClass
 
60
'\"     Start of description of a specific option.  cmdName gives the
 
61
'\"     option's name as specified in the class command, dbName gives
 
62
'\"     the option's name in the option database, and dbClass gives
 
63
'\"     the option's class in the option database.
 
64
'\"
 
65
'\" .UL arg1 arg2
 
66
'\"     Print arg1 underlined, then print arg2 normally.
 
67
'\"
 
68
'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $
 
69
'\"
 
70
'\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
 
71
.if t .wh -1.3i ^B
 
72
.nr ^l \n(.l
 
73
.ad b
 
74
'\"     # Start an argument description
 
75
.de AP
 
76
.ie !"\\$4"" .TP \\$4
 
77
.el \{\
 
78
.   ie !"\\$2"" .TP \\n()Cu
 
79
.   el          .TP 15
 
80
.\}
 
81
.ta \\n()Au \\n()Bu
 
82
.ie !"\\$3"" \{\
 
83
\&\\$1  \\fI\\$2\\fP    (\\$3)
 
84
.\".b
 
85
.\}
 
86
.el \{\
 
87
.br
 
88
.ie !"\\$2"" \{\
 
89
\&\\$1  \\fI\\$2\\fP
 
90
.\}
 
91
.el \{\
 
92
\&\\fI\\$1\\fP
 
93
.\}
 
94
.\}
 
95
..
 
96
'\"     # define tabbing values for .AP
 
97
.de AS
 
98
.nr )A 10n
 
99
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
 
100
.nr )B \\n()Au+15n
 
101
.\"
 
102
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 
103
.nr )C \\n()Bu+\\w'(in/out)'u+2n
 
104
..
 
105
.AS Tcl_Interp Tcl_CreateInterp in/out
 
106
'\"     # BS - start boxed text
 
107
'\"     # ^y = starting y location
 
108
'\"     # ^b = 1
 
109
.de BS
 
110
.br
 
111
.mk ^y
 
112
.nr ^b 1u
 
113
.if n .nf
 
114
.if n .ti 0
 
115
.if n \l'\\n(.lu\(ul'
 
116
.if n .fi
 
117
..
 
118
'\"     # BE - end boxed text (draw box now)
 
119
.de BE
 
120
.nf
 
121
.ti 0
 
122
.mk ^t
 
123
.ie n \l'\\n(^lu\(ul'
 
124
.el \{\
 
125
.\"     Draw four-sided box normally, but don't draw top of
 
126
.\"     box if the box started on an earlier page.
 
127
.ie !\\n(^b-1 \{\
 
128
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 
129
.\}
 
130
.el \}\
 
131
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 
132
.\}
 
133
.\}
 
134
.fi
 
135
.br
 
136
.nr ^b 0
 
137
..
 
138
'\"     # VS - start vertical sidebar
 
139
'\"     # ^Y = starting y location
 
140
'\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 
141
.de VS
 
142
.if !"\\$2"" .br
 
143
.mk ^Y
 
144
.ie n 'mc \s12\(br\s0
 
145
.el .nr ^v 1u
 
146
..
 
147
'\"     # VE - end of vertical sidebar
 
148
.de VE
 
149
.ie n 'mc
 
150
.el \{\
 
151
.ev 2
 
152
.nf
 
153
.ti 0
 
154
.mk ^t
 
155
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 
156
.sp -1
 
157
.fi
 
158
.ev
 
159
.\}
 
160
.nr ^v 0
 
161
..
 
162
'\"     # Special macro to handle page bottom:  finish off current
 
163
'\"     # box/sidebar if in box/sidebar mode, then invoked standard
 
164
'\"     # page bottom macro.
 
165
.de ^B
 
166
.ev 2
 
167
'ti 0
 
168
'nf
 
169
.mk ^t
 
170
.if \\n(^b \{\
 
171
.\"     Draw three-sided box if this is the box's first page,
 
172
.\"     draw two sides but no top otherwise.
 
173
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 
174
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 
175
.\}
 
176
.if \\n(^v \{\
 
177
.nr ^x \\n(^tu+1v-\\n(^Yu
 
178
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 
179
.\}
 
180
.bp
 
181
'fi
 
182
.ev
 
183
.if \\n(^b \{\
 
184
.mk ^y
 
185
.nr ^b 2
 
186
.\}
 
187
.if \\n(^v \{\
 
188
.mk ^Y
 
189
.\}
 
190
..
 
191
'\"     # DS - begin display
 
192
.de DS
 
193
.RS
 
194
.nf
 
195
.sp
 
196
..
 
197
'\"     # DE - end display
 
198
.de DE
 
199
.fi
 
200
.RE
 
201
.sp
 
202
..
 
203
'\"     # SO - start of list of standard options
 
204
.de SO
 
205
.SH "STANDARD OPTIONS"
 
206
.LP
 
207
.nf
 
208
.ta 4c 8c 12c
 
209
.ft B
 
210
..
 
211
'\"     # SE - end of list of standard options
 
212
.de SE
 
213
.fi
 
214
.ft R
 
215
.LP
 
216
See the \\fBoptions\\fR manual entry for details on the standard options.
 
217
..
 
218
'\"     # OP - start of full description for a single option
 
219
.de OP
 
220
.LP
 
221
.nf
 
222
.ta 4c
 
223
Command-Line Name:      \\fB\\$1\\fR
 
224
Database Name:  \\fB\\$2\\fR
 
225
Database Class: \\fB\\$3\\fR
 
226
.fi
 
227
.IP
 
228
..
 
229
'\"     # CS - begin code excerpt
 
230
.de CS
 
231
.RS
 
232
.nf
 
233
.ta .25i .5i .75i 1i
 
234
..
 
235
'\"     # CE - end code excerpt
 
236
.de CE
 
237
.fi
 
238
.RE
 
239
..
 
240
.de UL
 
241
\\$1\l'|0\(ul'\\$2
 
242
..
 
243
.TH "critcl_changes" n 3\&.1\&.8 doc "C Runtime In Tcl (CriTcl)"
 
244
.BS
 
245
.SH NAME
 
246
critcl_changes \- CriTcl Changes
 
247
.SH DESCRIPTION
 
248
.PP
 
249
Welcome to the \fIC Runtime In Tcl\fR, \fICriTcl\fR for short, a
 
250
system to build C extension packages for Tcl on the fly, from C code
 
251
embedded within Tcl scripts, for all who wish to make their code go
 
252
faster\&.
 
253
.PP
 
254
This document provides an overview of the changes \fBcritcl\fR
 
255
underwent from version to version\&.
 
256
.SH "CHANGES FOR VERSION 2\&.1"
 
257
.IP [1]
 
258
Fixed bug where \fBcritcl::tsources\fR interpreted relative
 
259
paths as relative to the current working directory instead of
 
260
relative to the "\fI\&.critcl\fR" file using the command, as all other
 
261
commands of this type do\&.
 
262
.IP [2]
 
263
Fixed internals, preventing information collected for multiple
 
264
"\fI\&.critcl\fR" files to leak between them\&. Notably, \fBcritcl::tk\fR
 
265
is not a global configuration option anymore\&.
 
266
.IP [3]
 
267
Fixed the command \fBcritcl::license\fR to be a null-operation
 
268
in mode "compile & run", instead of throwing an error\&.
 
269
.IP [4]
 
270
Fixed the critcl application's interference with the "compile &
 
271
run" result cache in \fB-pkg\fR mode by having it use a wholly
 
272
separate (and by default transient) directory for that mode\&.
 
273
.IP [5]
 
274
Fixed bug where changes to a "\fI\&.critcl\fR" file did not result
 
275
in a rebuild for mode "compile & run"\&. All relevant API commands now
 
276
ensure UUID changes\&.
 
277
.IP [6]
 
278
Fixed bug in the backend handling of \fBcritcl::debug\fR where
 
279
the companion c-sources of a "\fI\&.critcl\fR" file were not compiled
 
280
with debug options, although the "\fI\&.critcl\fR" file was\&.
 
281
.IP [7]
 
282
Fixed bug in \fBcritcl::debug\fR which prevented recognition of
 
283
mode "all" when it was not the first argument to the command\&.
 
284
.IP [8]
 
285
Fixed bug in "\fIpreload\&.c\fR" preventing its compilation on
 
286
non-windows platforms\&.
 
287
.IP [9]
 
288
Fixed long-standing bug in the handling of namespace qualifiers
 
289
in the command name argument of \fBcritcl::cproc\fR and
 
290
\fBcritcl::ccommand\fR\&. It is now possible to specify a fully
 
291
qualified command name without issues\&.
 
292
.IP [10]
 
293
Extended/reworked \fBcritcl::tsources\fR to be the canonical
 
294
way of declaring "\fI\&.tcl\fR" companion files even for mode "compile &
 
295
run"\&.
 
296
.IP [11]
 
297
Extended/reworked \fBcritcl::tsources\fR to allow the use of a
 
298
"\fI\&.critcl\fR" file as its own Tcl companion file\&.
 
299
.IP [12]
 
300
Extended \fBcritcl::framework\fR to internally check for OS X
 
301
build target, and to ignore the declaration if its not\&.
 
302
.IP [13]
 
303
Extended \fBcritcl::failed\fR to be callable more than once in
 
304
a "\fI\&.critcl\fR" file\&. The first call forces the build, if it was not
 
305
done already, to get the result\&. Further calls return the cached
 
306
result of the first call\&.
 
307
.IP [14]
 
308
Extended the handling of environment variable CC in the code
 
309
determining the compiler to use to deal with (i\&.e\&. remove) paths to
 
310
the compiler, compiler file extensions, and compiler options specified
 
311
after the compiler itself, leaving only the bare name of the compiler\&.
 
312
.IP [15]
 
313
Extended the code handling the search for preloaded libraries
 
314
to print the paths it searched, making debugging of a search failure
 
315
easier\&.
 
316
.IP [16]
 
317
A new command \fBcritcl::tcl\fR can be used to declare the
 
318
version of Tcl minimally needed to build and run the "\fI\&.critcl\fR"
 
319
file and package\&. Defaults to 8\&.4 if not declared\&. Extended critcl to
 
320
have the stubs and headers for all of Tcl 8\&.4, 8\&.5, and 8\&.6\&.
 
321
.IP [17]
 
322
A new command \fBcritcl::load\fR forces the build and load of a
 
323
"\fI\&.critcl\fR" file\&. This is the official way for overriding critcl's
 
324
default lazy-build-&-load-on-demand scheme for mode "compile & run"\&.
 
325
.sp
 
326
\fINote\fR that after using \fBcritcl::load\fR /
 
327
\fBcritcl::failed\fR in a "\fI\&.critcl\fR" file it is not possible to
 
328
use critcl commands in that file anymore\&. Doing so will throw an
 
329
error\&.
 
330
.IP [18]
 
331
Extended the generation of '#line' pragmas to use
 
332
\fBinfo frame\fR (if available) to provide the C compiler with exact
 
333
line numbers into the "\fI\&.critcl\fR" file for the reporting of
 
334
warnings and errors\&.
 
335
.IP [19]
 
336
Extended \fBcritcl::check\fR with logging to help with
 
337
debugging build-time checks of the environment, plus an additional
 
338
optional argument to provide labeling\&.
 
339
.IP [20]
 
340
Added a new command \fBcritcl::checklink\fR which not only
 
341
tries to check the environment via compiling the code, but also
 
342
its linkability\&.
 
343
.IP [21]
 
344
Added a new command \fBcritcl::msg\fR for messaging, like
 
345
command \fBcritcl::error\fR is for error reporting\&. Likewise this is a
 
346
hook a user of the package is allowed to override\&. The default
 
347
implementation, used by mode \fIcompile & run\fR does nothing\&. The
 
348
implementation for mode \fIgenerate package\fR prints the message
 
349
to stdout\&.
 
350
.sp
 
351
Envisioned use is for the reporting of results determined by
 
352
\fBcritcl::check\fR and \fBcritcl::checklink\fR during building, to
 
353
help with debugging when something goes wrong with a check\&.
 
354
.IP [22]
 
355
Exposed the argument processing internals of \fBcritcl::proc\fR
 
356
for use by advanced users\&. The new commands are
 
357
.RS
 
358
.IP [1]
 
359
\fBcritcl::argnames\fR
 
360
.IP [2]
 
361
\fBcritcl::argcnames\fR
 
362
.IP [3]
 
363
\fBcritcl::argcsignature\fR
 
364
.IP [4]
 
365
\fBcritcl::argvardecls\fR
 
366
.IP [5]
 
367
\fBcritcl::argconversion\fR
 
368
.RE
 
369
.IP
 
370
Please see section \fIAdvanced Embedded C Code\fR of the
 
371
\fBcritcl\fR package documentation for details\&.
 
372
.IP [23]
 
373
Extended the critcl package to intercept \fBpackage
 
374
provide\fR and record the file -> package name mapping\&. Plus other
 
375
internal changes now allow the use of namespaced package names while
 
376
still using proper path names and init function\&.
 
377
.IP [24]
 
378
Dropped the unused commands \fBcritcl::optimize\fR and
 
379
\fBcritcl::include\fR\&.
 
380
.IP [25]
 
381
Dropped \fB-lib\fR mode from the critcl application\&.
 
382
.IP [26]
 
383
Dropped remnants of support for Tcl 8\&.3 and before\&.
 
384
.PP
 
385
.SH "CHANGES FOR VERSION 3"
 
386
.IP [1]
 
387
The command \fBcritcl::platform\fR was deprecated in version
 
388
2\&.1, superceded by \fBcritcl::targetplatform\fR, yet kept for
 
389
compatibility\&. Now it has been removed\&.
 
390
.IP [2]
 
391
The command \fBcritcl::compiled\fR was kept with in version 2\&.1
 
392
with semantics in contradiction to its, for compatibility\&. This
 
393
contradiction has been removed, changing the visible semantics of the
 
394
command to be in line with its name\&.
 
395
.IP [3]
 
396
The change to version 3 became necessary because of the two
 
397
incompatible visible changes above\&.
 
398
.IP [4]
 
399
Extended the application package with code handling a new
 
400
option \fB-tea\fR\&. Specifying this option invokes a special mode
 
401
where critcl generates a TEA package, i\&.e\&. wraps the input into a
 
402
directory hierarchy and support files which provide it TEA-lookalike
 
403
buildsystem\&.
 
404
.sp
 
405
This new option, and \fB-pkg\fR, exclude each other\&. If
 
406
both are specified the last used option takes precedence\&.
 
407
.sp
 
408
The generated package directory hierarchy is mostly
 
409
self-contained, but not fully\&. It requires not only a working
 
410
installation of Tcl, but also working installations of the packages
 
411
\fBmd5\fR and \fBcmdline\fR\&. Both of these are provided by the
 
412
\fBTcllib\fR bundle\&. Not required, but recommended to have
 
413
installed are any of the packages which can accelerate md5's
 
414
operation, i\&.e\&. \fBcryptkit\fR, \fBtcllibc\fR, or
 
415
\fBTrf\fR\&.
 
416
.IP [5]
 
417
Extended the critcl package with a new command
 
418
\fBcritcl::scan\fR taking the path to a "\fI\&.critcl\fR" file,
 
419
statically scanning it, and returning license, version, a list of its
 
420
companion files, list of imported APIs, and list of
 
421
developer-specified custom configuration options\&. This data is the
 
422
foundation for the TEA wrapping described above\&.
 
423
.sp
 
424
Note that this is a \fIstatic\fR scan\&. While the other build
 
425
modes can (must) execute the "\fI\&.critcl\fR" file and make
 
426
platform-specific decisions regarding the assembled C code, companion
 
427
files, etc\&. the TEA wrap mode is not in a position to make
 
428
platform-specific decisions\&. It has to wrap everything which might
 
429
conceivably be needed when actually building\&. Hence the static scan\&.
 
430
This has however its own set of problems, namely the inability to
 
431
figure out any dynamic construction of companion file paths, at least
 
432
on its own\&. Thus:
 
433
.IP [6]
 
434
Extended the API used by critcl-based packages with the command
 
435
\fBcritcl::owns\fR\&. While this command is ignored by the regular build
 
436
modes the static scanner described above takes its arguments as the
 
437
names of companion files which have to be wrapped into the TEA package
 
438
and could not be figured by the scanner otherwise, like because of
 
439
dynamic paths to \fBcritcl::tsources\fR, \fBcritcl::csources\fR,
 
440
getting sourced directly, or simply being adjunct datafiles\&.
 
441
.IP [7]
 
442
Extended the API used by critcl-based packages with the command
 
443
\fBcritcl::api\fR for the management of stubs tables, be it their use,
 
444
and/or declaration and export\&.
 
445
.sp
 
446
Please see section \fIStubs Table Management\fR of the
 
447
\fBcritcl\fR package documentation for details\&.
 
448
.IP [8]
 
449
Extended the API used by critcl-based packages with the command
 
450
\fBcritcl::userconfig\fR for the management of developer-specified
 
451
custom configuration options, be it their use and/or declaration\&.
 
452
.sp
 
453
Please see section \fICustom Build Configuration\fR of the
 
454
\fBcritcl\fR package documentation for details\&.
 
455
.IP [9]
 
456
Extended the API used by critcl-based packages with the
 
457
commands \fBcritcl::description\fR, \fBcritcl::summary\fR,
 
458
\fBcritcl::subject\fR, \fBcritcl::meta\fR, and
 
459
\fBcritcl::buildrequirement\fR for the declaration of TEApot meta data
 
460
for/about the package\&.
 
461
.sp
 
462
Please see section \fIPackage Meta Data\fR of the
 
463
\fBcritcl\fR package documentation for details\&.
 
464
.PP
 
465
.SH "CHANGES FOR VERSION 3\&.0\&.1"
 
466
.IP [1]
 
467
Bugfixes all around\&. In detail:
 
468
.IP [2]
 
469
Fixed recording of Tcl version requirements\&. Keep package name
 
470
and version together, unbreaking generated meta data and generated
 
471
package load command\&.
 
472
.IP [3]
 
473
Fixed the build scripts: When installing, or wrapping for TEA,
 
474
generate any missing directories
 
475
.IP [4]
 
476
Modified the build scripts to properly exit the application
 
477
when the window of their GUI is closed through the (X) button\&.
 
478
.IP [5]
 
479
Removed an 8\&.5-ism (open wb) which had slipped into the main
 
480
build script\&.
 
481
.IP [6]
 
482
Modified the example build scripts to separate the output for
 
483
the different examples (and packages) by adding empty lines\&.
 
484
.IP [7]
 
485
stack::c example bugfix: Include API declarations for use in
 
486
the companion files\&.
 
487
.IP [8]
 
488
Extended the documentation: Noted the need for a working
 
489
installation of a C compiler\&.
 
490
.IP [9]
 
491
Extended the Windows target definitions and code to handle the
 
492
manifest files used by modern MS development environments\&. Note that
 
493
this code handles both possibilities, environment using manifests, and
 
494
(old(er)) environments without\&.
 
495
.IP [10]
 
496
Extended the Windows 64bit target definitions and code to
 
497
auto-detect the need for the helper library "bufferoverflowU\&.lib" and
 
498
reconfigure the compile and link commands appropriately\&. We assume
 
499
that the library must be linked when present\&. This should be no harm
 
500
if the library is present, yet not needed\&. Just superfluous\&. We search
 
501
for the library in the paths specified by the environment variable
 
502
LIB\&.
 
503
.PP
 
504
.SH "CHANGES FOR VERSION 3\&.0\&.2"
 
505
.IP [1]
 
506
Fixed issue in compile-and-run mode where commands put into the
 
507
auto_index are not found by Tcl's [unknown] command\&.
 
508
.IP [2]
 
509
Fixed an array key mismatch breaking usage of client data and
 
510
delete function for procedure\&. Reported by Jos DeCoster, with patch\&.
 
511
.IP [3]
 
512
Implemented a command line option \fB-L\fR, an equivalent of
 
513
option \fB-I\fR, just for library search paths\&.
 
514
.IP [4]
 
515
Fixed github issues 5 and 8\&. Working around a missing variable
 
516
::errorInfo\&. It should always be present, however there seem to be
 
517
revisions of Tcl around which violate this assumption\&.
 
518
.PP
 
519
.SH "CHANGES FOR VERSION 3\&.0\&.3"
 
520
.IP [1]
 
521
Fixed github issues 5 and 8, for the example build\&.tcl
 
522
scripts\&. Working around a missing variable ::errorInfo\&. It should
 
523
always be present, however there seem to be revisions of Tcl around
 
524
which violate this assumption\&.
 
525
.PP
 
526
.SH "CHANGES FOR VERSION 3\&.0\&.4"
 
527
.IP [1]
 
528
Fixed generation of the package's initname when the incoming
 
529
code is read from stdin and has no proper path\&.
 
530
.IP [2]
 
531
Fixed github issue 11\&. Now using /LIBPATH instead of -L
 
532
on Windows (libinclude configuration setting)\&.
 
533
.IP [3]
 
534
Extended critcl to handle -l:path format of -l options\&.
 
535
GNU ld 2\&.22+ handles this by searching for the path as
 
536
is\&. Good when specifying static libraries, as plain -l looks
 
537
for shared libraries in preference over static\&. critcl handles
 
538
it now, as older GNU ld's do not understand it, nor the
 
539
various vendor-specific linkers\&.
 
540
.IP [4]
 
541
Fixed github issue #12\&. Critcl now determines the version of
 
542
MSVC in use and uses it to switch between various link debug
 
543
options\&. Simplified the handling of bufferoverflowU\&.lib also,
 
544
making use of the same mechanism and collapsing the two
 
545
configurations sections we had back into one\&.
 
546
.IP [5]
 
547
Reworked the insertion of #line pragmas into the generated C
 
548
code to avoid limitations on the line number argument imposed
 
549
by various compilers, and be more accurate\&.
 
550
.IP [6]
 
551
Modified argument processing\&. Option -libdir now also
 
552
implies -L for its argument\&.
 
553
.IP [7]
 
554
Extended handling of option -show (\fBcritcl::showconfig\fR)
 
555
to list the path of the configuration file the data is coming
 
556
from\&. Good for debugging configuration processing\&.
 
557
.IP [8]
 
558
Extended the build script with targets to regenerate the
 
559
embedded documentation, and diagrams, and to generate a
 
560
release\&.
 
561
.PP
 
562
.SH "CHANGES FOR VERSION 3\&.0\&.5"
 
563
.IP [1]
 
564
Fixed bug in the new code for #line pragmas triggered when
 
565
specifying C code without leading whitespace\&.
 
566
.IP [2]
 
567
Extended the documentation to have manpages for the license,
 
568
source retrieval, installer, and developer's guides\&.
 
569
.PP
 
570
.SH "CHANGES FOR VERSION 3\&.0\&.6"
 
571
.IP [1]
 
572
Fixed github issue 10\&. The critcl application now delivers a
 
573
proper exit code (1) on build failure, instead of always
 
574
indicating success (status 0)\&.
 
575
.IP [2]
 
576
Fixed github issue 13\&. Handling of bufferoverflowU\&.lib for
 
577
release builds was inconsistent with handling for debug
 
578
builds\&. It is now identically handled (conditional) by
 
579
both cases\&.
 
580
.IP [3]
 
581
Documentation cleanup, mainly in the installation guide, and
 
582
the README\&.md shown by github
 
583
.PP
 
584
.SH "CHANGES FOR VERSION 3\&.0\&.7"
 
585
.IP [1]
 
586
Fixed the code generated by \fBcritcl::c++command\fR\&.
 
587
The emitted code handed a non-static string table to
 
588
\fBTcl_GetIndexFromObj\fR, in violation of the contract, which
 
589
requires the table to have a fixed address\&. This was a memory
 
590
smash waiting to happen\&. Thanks to Brian Griffin for alrerting
 
591
us to the general problem\&.
 
592
.PP
 
593
.SH "CHANGES FOR VERSION 3\&.1"
 
594
.IP [1]
 
595
Added a new higher-level package \fBcritcl::iassoc\fR\&.
 
596
.sp
 
597
This package simplifies the creation of code associating data
 
598
with an interpreter via Tcl's \fBTcl_(Get|Set)AssocData()\fR APIs\&. The
 
599
user can concentrate on his data while all the necessary boilerplate
 
600
C code to support this is generated by the package\&.
 
601
.sp
 
602
This package uses several of the new features which were added
 
603
to the core \fBcritcl\fR package, see below\&.
 
604
.IP [2]
 
605
Added the higher-level package \fBcritcl::class\fR\&.
 
606
.sp
 
607
This package simplifies the creation of C level objects with
 
608
class and instance commands\&. The user can write a class definition
 
609
with class- and instance-variables and -methods similar to a TclOO
 
610
class, with all the necessary boilerplate C code to support this
 
611
generated by the package\&.
 
612
.sp
 
613
This package uses several of the new features which were added
 
614
to the core \fBcritcl\fR package, see below\&.
 
615
.IP [3]
 
616
Extended the API for handling TEApot metadata\&. Added the
 
617
command \fBcritcl::meta?\fR to query the stored information\&. Main use
 
618
currently envisioned is retrieval of the current package's name by
 
619
utility commands, for use in constructed names\&. This particular
 
620
information is always available due to the static scan of the package
 
621
file on execution of the first critcl command\&.
 
622
.sp
 
623
The new packages \fBcritcl::iassoc\fR and
 
624
\fBcritcl::class\fR (see above) are users of this command\&.
 
625
.IP [4]
 
626
Extended the API with a command, \fBcritcl::name2c\fR, exposing
 
627
the process of converting a Tcl name into base name, namespace, and C
 
628
namespace\&. This enables higher-level code generators to generate the same
 
629
type of C identifiers as \fBcritcl\fR itself\&.
 
630
.sp
 
631
The new package \fBcritcl::class\fR (see above) is a user
 
632
of this command\&.
 
633
.IP [5]
 
634
Extended the API with a command, \fBcritcl::source\fR,
 
635
executing critcl commands found in a separate file in the context of
 
636
the current file\&. This enables easier management of larger bodies of
 
637
code as it allows the user to split such up into easier to digest
 
638
smaller chunks without causing the generation of multiple packages\&.
 
639
.IP [6]
 
640
Related to the previous item, extended the API with commands to
 
641
divert collection of generated C code into memory\&. This makes it
 
642
easier to use the commands for embedded C code in higher-level code
 
643
generators\&.
 
644
.sp
 
645
See the section \fBAdvanced: Diversions\fR for details of
 
646
the provided commands\&.
 
647
.sp
 
648
The new package \fBcritcl::class\fR (see above) is a user
 
649
of these facilities\&.
 
650
.IP [7]
 
651
Extended the API with commands helping developers with the
 
652
generation of proper C \fI#line\fR directives\&. This allows
 
653
higher-level code generators to generate and insert their own
 
654
directives, ensuring that compile errors in their code are properly
 
655
attributed\&.
 
656
.sp
 
657
See the section \fBAdvanced: Location management\fR for
 
658
details of the provided commands\&.
 
659
.sp
 
660
The new packages \fBcritcl::iassoc\fR and
 
661
\fBcritcl::class\fR (see above) are users of these facilities\&.
 
662
.IP [8]
 
663
Extended the API with commands giving users the ability to
 
664
define custom argument and result types for \fB::critcl::cproc\fR\&.
 
665
.sp
 
666
See the section \fBAdvanced: Extending cproc\fR for
 
667
details of the provided commands\&.
 
668
.PP
 
669
.SH "CHANGES FOR VERSION 3\&.1\&.1"
 
670
.IP [1]
 
671
Bugfixes all around\&. In detail:
 
672
.IP [2]
 
673
Fixed the generation of wrong#args errors for
 
674
\fBcritcl::cproc\fR and derived code (\fBcritcl::class\fR
 
675
cproc-based methods)\&. Use NULL if there are no arguments, and
 
676
take the offset into account\&.
 
677
.IP [3]
 
678
Fixed the handling of package names by
 
679
\fBcritcl::class\fR\&. Forgot that they may contain namespace
 
680
separators\&. Bumped to version 1\&.0\&.1\&.
 
681
.IP [4]
 
682
Extended a \fBcritcl::class\fR generated error message in
 
683
instance creation for clarity\&. Bumped to version 1\&.0\&.2\&.
 
684
.PP
 
685
.SH "CHANGES FOR VERSION 3\&.1\&.2"
 
686
.IP [1]
 
687
Enhancement\&. In detail:
 
688
.IP [2]
 
689
Extended \fBcritcl::cproc\fR to be able to handle optional
 
690
arguments, in a limited way\&. This is automatically available to
 
691
\fBcritcl::class\fR cproc-based methods as well\&.
 
692
.IP [3]
 
693
Bugfix in \fBlassign\fR emulation for Tcl 8\&.4\&.  Properly set
 
694
unused variables to the empty string\&.  Bumped version of
 
695
emulation package \fBlassign84\fR to 1\&.0\&.1\&.
 
696
.PP
 
697
.SH "CHANGES FOR VERSION 3\&.1\&.3"
 
698
.IP [1]
 
699
Enhancement\&. In detail:
 
700
.IP [2]
 
701
Added new argument type "pstring", for "Pascal String", a
 
702
counted string, i\&.e\&. a combination of string pointer and string
 
703
length\&.
 
704
.IP [3]
 
705
Added new methods \fBcritcl::argtypesupport\fR and
 
706
\fB::critcl::argsupport\fR to define and use additional
 
707
supporting code for an argument type, here used by "pstring"
 
708
above to define the necessary structure\&.
 
709
.IP [4]
 
710
Semi-bugfixes in the packages \fBcritcl::class\fR and
 
711
\fBcritcl::iassoc\fR\&. Pragmas for the AS meta data scanner
 
712
to ensure that the template files are made part of the package\&.
 
713
Versions bumped to 1\&.0\&.4 and 1\&.0\&.1 respectively\&.
 
714
.PP
 
715
.SH "CHANGES FOR VERSION 3\&.1\&.4"
 
716
.IP [1]
 
717
Bugfix in package \fBcritcl::class\fR\&. Generate a dummy
 
718
field in the class structure if the class has no class
 
719
variables\&. Without this change the structure would be empty,
 
720
and a number of compilers are not able to handle such a type\&.
 
721
.IP [2]
 
722
Fixed a typo which broke the win64 configuration\&.
 
723
.IP [3]
 
724
Fixed issue #16, a typo in the documentation of command
 
725
\fBcritcl::class\fR\&.
 
726
.PP
 
727
.SH "CHANGES FOR VERSION 3\&.1\&.5"
 
728
.IP [1]
 
729
Fixed issue #19\&. Made the regular expression extracting the
 
730
MSVC version number more general to make it work on german
 
731
language systems\&. This may have to be revisited in the future,
 
732
for other Windows locales\&.
 
733
.IP [2]
 
734
Fixed issue #20\&. Made option -tea work on windows, at least in
 
735
a unix emulation environment like msys/mingw\&.
 
736
.PP
 
737
.SH "CHANGES FOR VERSION 3\&.1\&.6"
 
738
.IP [1]
 
739
Fixed issue #21\&. While the multi-definition of the stub-table
 
740
pointer variables was ok with for all the C linkers seen so far
 
741
C++ linkers did not like this at all\&. Reworked the code to
 
742
ensure that this set of variables is generated only once, in
 
743
the wrapper around all the pieces to assemble\&.
 
744
.IP [2]
 
745
Fixed issue #22, the handling of the command identifier
 
746
arguments of \fBcritcl::ccommand\fR, \fBcritcl::cproc\fR, and
 
747
\fBcritcl::cdata\fR\&. We now properly allow any Tcl identifier
 
748
and generate proper internal C identifiers from them\&.
 
749
.sp
 
750
As part of this the signature of command \fBcritcl::name2c\fR
 
751
changed\&. The command now delivers a list of four values instead
 
752
of three\&. The new value was added at the end\&.
 
753
.sp
 
754
Further adapted the implementation of package
 
755
\fBcritcl::class\fR, a user of \fBcritcl::name2c\fR\&.
 
756
This package is now at version 1\&.0\&.6 and requires critcl 3\&.1\&.6
 
757
.sp
 
758
Lastly fixed the mis-handling of option \fB-cname\fR in
 
759
\fBcritcl::ccommand\fR, and \fBcritcl::cproc\fR\&.
 
760
.IP [3]
 
761
Fixed issue #23\&.
 
762
.PP
 
763
.SH "CHANGES FOR VERSION 3\&.1\&.7"
 
764
.IP [1]
 
765
Fixed issue #24\&. Extract and unconditionally display compiler
 
766
warnings found in the build log\&. Prevents users from missing
 
767
warnings which, while not causing the build to fail, may
 
768
still indicate problems\&.
 
769
.IP [2]
 
770
New feature\&. Output hook\&. All non-messaging user output is now
 
771
routed through the command \fBcritcl::print\fR, and users are
 
772
allowed to override it when using the critcl application-as-package\&.
 
773
.IP [3]
 
774
New feature, by Ashok P\&. Nadkarni\&. Platform configurations can
 
775
inherit values from configurations defined before them\&.
 
776
.PP
 
777
.SH "CHANGES FOR VERSION 3\&.1\&.8"
 
778
.IP [1]
 
779
Fixed issue with package indices generated for Tcl 8\&.4\&.
 
780
Join the list of commands with semi-colon, not newline\&.
 
781
.IP [2]
 
782
Fixed issue #26 which brought up use-cases I had forgotten to
 
783
consider while fixing bug #21 (see critcl 3\&.1\&.6)\&.
 
784
.PP
 
785
.SH "CHANGES FOR VERSION 3\&.1\&.9"
 
786
.IP [1]
 
787
Fixed issue #27\&. Added missing platform definitions for
 
788
various alternate linux and OS X targets\&.
 
789
.IP [2]
 
790
Fixed issue #28\&. Added missing -mXX flags for linking at the
 
791
linux-{32,64}-* targets\&.
 
792
.IP [3]
 
793
Fixed issue #29\&. Replaced the use of raw "cheaders"
 
794
information in the processing of "cdefines" with the proper
 
795
include directives derived from it\&.
 
796
.IP [4]
 
797
Fixed the issue behind rejected pull request #30 by Andrew
 
798
Shadura\&. Dynamically extract the stubs variable declarations
 
799
from the Tcl header files and generate matching variable
 
800
definitions for use in the package code\&. The generated code
 
801
will now be always consistent with the headers, even when
 
802
critcl's own copy of them is replaced by system headers\&.
 
803
.IP [5]
 
804
Fixed issue #31\&. Accepted patch by Andrew Shadura, with
 
805
changes (comments), for easier integration of critcl with
 
806
OS package systems, replacing critcl's copies of Tcl headers
 
807
with their own\&.
 
808
.IP [6]
 
809
Fixed issue #32\&. Merged pull request by Andrew Shadura\&.
 
810
Various typos in documentation and comments\&.
 
811
.IP [7]
 
812
Fixed issue #33\&. Handle files starting with a dot better\&.
 
813
.PP
 
814
.SH AUTHORS
 
815
Jean Claude Wippler, Steve Landers, Andreas Kupries
 
816
.SH "BUGS, IDEAS, FEEDBACK"
 
817
This document, and the package it describes, will undoubtedly contain
 
818
bugs and other problems\&.
 
819
Please report them at \fIhttps://github\&.com/andreas-kupries/critcl/issues\fR\&.
 
820
Ideas for enhancements you may have for either package, application,
 
821
and/or the documentation are also very welcome and should be reported
 
822
at \fIhttps://github\&.com/andreas-kupries/critcl/issues\fR as well\&.
 
823
.SH KEYWORDS
 
824
C code, Embedded C Code, code generator, compile & run, compiler, dynamic code generation, dynamic compilation, generate package, linker, on demand compilation, on-the-fly compilation
 
825
.SH CATEGORY
 
826
Glueing/Embedded C code
 
827
.SH COPYRIGHT
 
828
.nf
 
829
Copyright (c) Jean-Claude Wippler
 
830
Copyright (c) Steve Landers
 
831
Copyright (c) 2011-2013 Andreas Kupries
 
832
 
 
833
.fi
 
 
b'\\ No newline at end of file'