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

<! -- Generated from file '/home/aku/Projects/Packages/Critcl/dev-master/embedded/www/files/critcl_introduction.html' by tcllib/doctools with format 'html'

-->

<! -- CVS: $Id$ critcl_introduction.n

100

-->

101

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_introduction(n) 3.1.8 doc "C Runtime In Tcl (CriTcl)"</h1>

107

108

critcl_introduction - Introduction To CriTcl

109

</div>

110

<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>

111

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">Related Documents</a></li>

115

<li class="section"><a href="#section3">Modes Of Operation/Use</a></li>

116

<li class="section"><a href="#section4">System Architecture</a></li>

117

<li class="section"><a href="#section5">Examples</a></li>

118

<li class="section"><a href="#section6">Changes for version 2.1</a></li>

119

<li class="section"><a href="#section7">Changes for version 3</a></li>

120

<li class="section"><a href="#section8">Changes for version 3.0.1</a></li>

121

<li class="section"><a href="#section9">Changes for version 3.0.2</a></li>

122

<li class="section"><a href="#section10">Changes for version 3.0.3</a></li>

123

<li class="section"><a href="#section11">Changes for version 3.0.4</a></li>

124

<li class="section"><a href="#section12">Changes for version 3.0.5</a></li>

125

<li class="section"><a href="#section13">Changes for version 3.0.6</a></li>

126

<li class="section"><a href="#section14">Changes for version 3.0.7</a></li>

127

<li class="section"><a href="#section15">Changes for version 3.1</a></li>

128

<li class="section"><a href="#section16">Changes for version 3.1.1</a></li>

129

<li class="section"><a href="#section17">Changes for version 3.1.2</a></li>

130

<li class="section"><a href="#section18">Changes for version 3.1.3</a></li>

131

<li class="section"><a href="#section19">Changes for version 3.1.4</a></li>

132

<li class="section"><a href="#section20">Changes for version 3.1.5</a></li>

133

<li class="section"><a href="#section21">Changes for version 3.1.6</a></li>

134

<li class="section"><a href="#section22">Changes for version 3.1.7</a></li>

135

<li class="section"><a href="#section23">Changes for version 3.1.8</a></li>

136

<li class="section"><a href="#section24">Changes for version 3.1.9</a></li>

137

<li class="section"><a href="#section25">Authors</a></li>

138

<li class="section"><a href="#section26">Bugs, Ideas, Feedback</a></li>

139

<li class="section"><a href="#keywords">Keywords</a></li>

140

<li class="section"><a href="#category">Category</a></li>

141

<li class="section"><a href="#copyright">Copyright</a></li>

142

</ul>

143

</div>

144

<div id="section1" class="section"><h2><a name="section1">Description</a></h2>

145

Welcome to the C Runtime In Tcl, <a href="critcl_pkg.html">CriTcl</a> for short, a

146

system to build C extension packages for Tcl on the fly, from C code

147

embedded within Tcl scripts, for all who wish to make their code go

148

faster.

149

CriTcl started life as an experiment by Jean-Claude Wippler and was a

150

self-contained Tcl package to build C code into a Tcl/Tk extension on

151

the fly. It was somewhat inspired by Brian Ingerson's Inline

152

for Perl, but is considerably more lightweight.

153

It is for the last 5% to 10% when pure Tcl, which does go a long way,

154

is not sufficient anymore. I.e. for

155

156

<li>when the last bits of performance are needed,</li>

157

<li>access to 3rd party libraries,</li>

158

<li>hiding critical pieces of your library or application, and</li>

159

<li>simply needing features provided only by C.</li>

160

</ol>

161

The following sections first reference a few related documents

162

which may or may not be of interest to you, depending on if you are

163

just a plain user of the system, trying to get and build/install it,

164

or are going deep into the internals for either edification or

165

modification.

166

This is followed by an introduction to the modes of operation

167

supported by the system, and its general architecture as seen by a

168

user.

169

</div>

170

<div id="section2" class="section"><h2><a name="section2">Related Documents</a></h2>

171

172

<li><a href="license.html">Critcl - License</a>.</li>

173

<li><a href="critcl_usingit.html">Using Critcl</a></li>

174

<li><a href="critcl_sources.html">Critcl - How To Get The Sources</a>.</li>

175

<li><a href="critcl_installer.html">Critcl - The Installer's Guide</a>.</li>

176

<li><a href="critcl_apppkg.html">Critcl - Application Package Reference</a></li>

177

<li><a href="critcl_pkg.html">Critcl - Package Reference</a></li>

178

<li><a href="critcl_devguide.html">Critcl - The Developer's Guide</a>.</li>

179

</ol>

180

</div>

181

<div id="section3" class="section"><h2><a name="section3">Modes Of Operation/Use</a></h2>

182

CriTcl can be used in three different modes of operation, called

183

184

<li><a href="../index.html#key0">Compile & Run</a>, and</li>

185

<li><a href="../index.html#key9">Generate Package</a></li>

186

<li>Generate TEA Package</li>

187

</ol>

188

Of these three <a href="../index.html#key0">Compile & Run</a> came first and is the default

189

when using the package directly. In that case the package collects the

190

C fragments, builds them as needed, and caches the results for quick

191

reuse when the same code is used in the future again.

192

The second mode, <a href="../index.html#key9">Generate Package</a>, was introduced to enable

193

the creation of (prebuilt) deliverable packages which do not depend on

194

the existence of a build system, i.e. C compiler, on the target

195

machine.

196

This was originally done through the experimental Critbind tool,

197

and is now handled by the <a href="critcl_app.html">CriTcl Application</a>, also named

198

<a href="critcl_pkg.html">critcl</a>.

199

Newly introduced with Critcl version 3 is

200

Generate TEA Package. This mode constructs a directory

201

hierarchy from the package which can later be built like a regular TEA

202

package, i.e. using

203

204

.../configure --prefix ...

205

make all isntall

206

</pre>

207

</div>

208

<div id="section4" class="section"><h2><a name="section4">System Architecture</a></h2>

209

The system consists of two main layers, as seen in the figure below,

210

plus a support layer containing general packages the system uses during

211

operation.

212

213

214

<li>At the top we have an application built on top of the core packages,

215

providing command line access to the second and third usage modes,

216

i.e. <a href="../index.html#key9">Generate Package</a> and Generate TEA Package.

217

218

<dt><a href="critcl_pkg.html">critcl</a></dt>

219

220

<dt><a href="critcl_apppkg.html">critcl::app</a></dt>

221

222

</dl>

223

</li>

224

<li>Below that is the core package providing the essential functionality

225

of the system, plus various utility packages which make common tasks

226

more convenient.

227

228

<dt><a href="critcl_pkg.html">critcl</a></dt>

229

230

<dt><a href="critcl_util.html">critcl::util</a></dt>

231

232

</dl>

233

</li>

234

<li>Lastly a layer of supporting packages, mostly external to critcl.

235

236

237

<dd>For this pure-Tcl package to be fast users should get one of several

238

possible accelerator packages:

239

240

<li>tcllibc</li>

241

242

243

</ol></dd>

244

<dt>cmdline</dt>

245

246

<dt>platform</dt>

247

248

<dt>stubs::container</dt>

249

250

<dt>stubs::reader</dt>

251

252

<dt>stubs::writer</dt>

253

254

<dt>stubs::gen</dt>

255

256

<dt>stubs::gen::init</dt>

257

258

<dt>stubs::gen::header</dt>

259

260

<dt>stubs::gen::decl</dt>

261

262

<dt>stubs::gen::macro</dt>

263

264

<dt>stubs::gen::slot</dt>

265

266

<dt>stubs::gen::lib</dt>

267

268

</dl>

269

</li>

270

</ol>

271

</div>

272

<div id="section5" class="section"><h2><a name="section5">Examples</a></h2>

273

The sources of Critcl, should you have gotten them, contain

274

several larger examples show-casing various aspects of the

275

system. These demonstration packages can all be found in the

276

sub-directory "examples/" of the sources.

277

Lots of smaller examples can be found in the document

278

Using CriTcl, an introduction to Critcl by way of a of

279

examples. These focus more on specific critcl commands than the

280

overall picture shown by the large examples mentioned in the previous

281

paragraph.

282

</div>

283

<div id="section6" class="section"><h2><a name="section6">Changes for version 2.1</a></h2>

284

285

<li>Fixed bug where critcl::tsources interpreted relative

286

paths as relative to the current working directory instead of

287

relative to the ".critcl" file using the command, as all other

288

commands of this type do.</li>

289

<li>Fixed internals, preventing information collected for multiple

290

".critcl" files to leak between them. Notably, critcl::tk

291

is not a global configuration option anymore.</li>

292

<li>Fixed the command critcl::license to be a null-operation

293

in mode "compile & run", instead of throwing an error.</li>

294

<li>Fixed the critcl application's interference with the "compile &

295

run" result cache in -pkg mode by having it use a wholly

296

separate (and by default transient) directory for that mode.</li>

297

<li>Fixed bug where changes to a ".critcl" file did not result

298

in a rebuild for mode "compile & run". All relevant API commands now

299

ensure UUID changes.</li>

300

<li>Fixed bug in the backend handling of critcl::debug where

301

the companion c-sources of a ".critcl" file were not compiled

302

with debug options, although the ".critcl" file was.</li>

303

<li>Fixed bug in critcl::debug which prevented recognition of

304

mode "all" when it was not the first argument to the command.</li>

305

<li>Fixed bug in "preload.c" preventing its compilation on

306

non-windows platforms.</li>

307

<li>Fixed long-standing bug in the handling of namespace qualifiers

308

in the command name argument of critcl::cproc and

309

critcl::ccommand. It is now possible to specify a fully

310

qualified command name without issues.</li>

311

<li>Extended/reworked critcl::tsources to be the canonical

312

way of declaring ".tcl" companion files even for mode "compile &

313

run".</li>

314

<li>Extended/reworked critcl::tsources to allow the use of a

315

".critcl" file as its own Tcl companion file.</li>

316

<li>Extended critcl::framework to internally check for OS X

317

build target, and to ignore the declaration if its not.</li>

318

<li>Extended critcl::failed to be callable more than once in

319

a ".critcl" file. The first call forces the build, if it was not

320

done already, to get the result. Further calls return the cached

321

result of the first call.</li>

322

<li>Extended the handling of environment variable CC in the code

323

determining the compiler to use to deal with (i.e. remove) paths to

324

the compiler, compiler file extensions, and compiler options specified

325

after the compiler itself, leaving only the bare name of the compiler.</li>

326

<li>Extended the code handling the search for preloaded libraries

327

to print the paths it searched, making debugging of a search failure

328

easier.</li>

329

<li>A new command critcl::tcl can be used to declare the

330

version of Tcl minimally needed to build and run the ".critcl"

331

file and package. Defaults to 8.4 if not declared. Extended critcl to

332

have the stubs and headers for all of Tcl 8.4, 8.5, and 8.6.</li>

333

<li>A new command critcl::load forces the build and load of a

334

".critcl" file. This is the official way for overriding critcl's

335

default lazy-build-&-load-on-demand scheme for mode "compile & run".

336

Note that after using critcl::load /

337

critcl::failed in a ".critcl" file it is not possible to

338

use critcl commands in that file anymore. Doing so will throw an

339

error.</li>

340

<li>Extended the generation of '#line' pragmas to use

341

info frame (if available) to provide the C compiler with exact

342

line numbers into the ".critcl" file for the reporting of

343

warnings and errors.</li>

344

<li>Extended critcl::check with logging to help with

345

debugging build-time checks of the environment, plus an additional

346

optional argument to provide labeling.</li>

347

<li>Added a new command critcl::checklink which not only

348

tries to check the environment via compiling the code, but also

349

its linkability.</li>

350

<li>Added a new command critcl::msg for messaging, like

351

command critcl::error is for error reporting. Likewise this is a

352

hook a user of the package is allowed to override. The default

353

implementation, used by mode <a href="../index.html#key0">compile & run</a> does nothing. The

354

implementation for mode <a href="../index.html#key9">generate package</a> prints the message

355

to stdout.

356

Envisioned use is for the reporting of results determined by

357

critcl::check and critcl::checklink during building, to

358

help with debugging when something goes wrong with a check.</li>

359

<li>Exposed the argument processing internals of critcl::proc

360

for use by advanced users. The new commands are

361

362

<li>critcl::argnames</li>

363

<li>critcl::argcnames</li>

364

<li>critcl::argcsignature</li>

365

<li>critcl::argvardecls</li>

366

<li>critcl::argconversion</li>

367

</ol>

368

Please see section Advanced Embedded C Code of the

369

<a href="critcl_pkg.html">critcl</a> package documentation for details.</li>

370

<li>Extended the critcl package to intercept package

371

provide and record the file -> package name mapping. Plus other

372

internal changes now allow the use of namespaced package names while

373

still using proper path names and init function.</li>

374

<li>Dropped the unused commands critcl::optimize and

375

critcl::include.</li>

376

<li>Dropped -lib mode from the critcl application.</li>

377

<li>Dropped remnants of support for Tcl 8.3 and before.</li>

378

</ol>

379

</div>

380

<div id="section7" class="section"><h2><a name="section7">Changes for version 3</a></h2>

381

382

<li>The command critcl::platform was deprecated in version

383

2.1, superceded by critcl::targetplatform, yet kept for

384

compatibility. Now it has been removed.</li>

385

<li>The command critcl::compiled was kept with in version 2.1

386

with semantics in contradiction to its, for compatibility. This

387

contradiction has been removed, changing the visible semantics of the

388

command to be in line with its name.</li>

389

<li>The change to version 3 became necessary because of the two

390

incompatible visible changes above.</li>

391

<li>Extended the application package with code handling a new

392

option -tea. Specifying this option invokes a special mode

393

where critcl generates a TEA package, i.e. wraps the input into a

394

directory hierarchy and support files which provide it TEA-lookalike

395

buildsystem.

396

This new option, and -pkg, exclude each other. If

397

both are specified the last used option takes precedence.

398

The generated package directory hierarchy is mostly

399

self-contained, but not fully. It requires not only a working

400

installation of Tcl, but also working installations of the packages

401

md5 and cmdline. Both of these are provided by the

402

Tcllib bundle. Not required, but recommended to have

403

installed are any of the packages which can accelerate md5's

404

operation, i.e. cryptkit, tcllibc, or

405

Trf.</li>

406

<li>Extended the critcl package with a new command

407

critcl::scan taking the path to a ".critcl" file,

408

statically scanning it, and returning license, version, a list of its

409

companion files, list of imported APIs, and list of

410

developer-specified custom configuration options. This data is the

411

foundation for the TEA wrapping described above.

412

Note that this is a static scan. While the other build

413

modes can (must) execute the ".critcl" file and make

414

platform-specific decisions regarding the assembled C code, companion

415

files, etc. the TEA wrap mode is not in a position to make

416

platform-specific decisions. It has to wrap everything which might

417

conceivably be needed when actually building. Hence the static scan.

418

This has however its own set of problems, namely the inability to

419

figure out any dynamic construction of companion file paths, at least

420

on its own. Thus:</li>

421

<li>Extended the API used by critcl-based packages with the command

422

critcl::owns. While this command is ignored by the regular build

423

modes the static scanner described above takes its arguments as the

424

names of companion files which have to be wrapped into the TEA package

425

and could not be figured by the scanner otherwise, like because of

426

dynamic paths to critcl::tsources, critcl::csources,

427

getting sourced directly, or simply being adjunct datafiles.</li>

428

<li>Extended the API used by critcl-based packages with the command

429

critcl::api for the management of stubs tables, be it their use,

430

and/or declaration and export.

431

Please see section Stubs Table Management of the

432

<a href="critcl_pkg.html">critcl</a> package documentation for details.</li>

433

<li>Extended the API used by critcl-based packages with the command

434

critcl::userconfig for the management of developer-specified

435

custom configuration options, be it their use and/or declaration.

436

Please see section Custom Build Configuration of the

437

<a href="critcl_pkg.html">critcl</a> package documentation for details.</li>

438

<li>Extended the API used by critcl-based packages with the

439

commands critcl::description, critcl::summary,

440

critcl::subject, critcl::meta, and

441

critcl::buildrequirement for the declaration of TEApot meta data

442

for/about the package.

443

Please see section Package Meta Data of the

444

<a href="critcl_pkg.html">critcl</a> package documentation for details.</li>

445

</ol>

446

</div>

447

<div id="section8" class="section"><h2><a name="section8">Changes for version 3.0.1</a></h2>

448

449

<li>Bugfixes all around. In detail:</li>

450

<li>Fixed recording of Tcl version requirements. Keep package name

451

and version together, unbreaking generated meta data and generated

452

package load command.</li>

453

<li>Fixed the build scripts: When installing, or wrapping for TEA,

454

generate any missing directories</li>

455

<li>Modified the build scripts to properly exit the application

456

when the window of their GUI is closed through the (X) button.</li>

457

<li>Removed an 8.5-ism (open wb) which had slipped into the main

458

build script.</li>

459

<li>Modified the example build scripts to separate the output for

460

the different examples (and packages) by adding empty lines.</li>

461

<li>stack::c example bugfix: Include API declarations for use in

462

the companion files.</li>

463

<li>Extended the documentation: Noted the need for a working

464

installation of a C compiler.</li>

465

<li>Extended the Windows target definitions and code to handle the

466

manifest files used by modern MS development environments. Note that

467

this code handles both possibilities, environment using manifests, and

468

(old(er)) environments without.</li>

469

<li>Extended the Windows 64bit target definitions and code to

470

auto-detect the need for the helper library "bufferoverflowU.lib" and

471

reconfigure the compile and link commands appropriately. We assume

472

that the library must be linked when present. This should be no harm

473

if the library is present, yet not needed. Just superfluous. We search

474

for the library in the paths specified by the environment variable

475

LIB.</li>

476

</ol>

477

</div>

478

<div id="section9" class="section"><h2><a name="section9">Changes for version 3.0.2</a></h2>

479

480

<li>Fixed issue in compile-and-run mode where commands put into the

481

auto_index are not found by Tcl's [unknown] command.</li>

482

<li>Fixed an array key mismatch breaking usage of client data and

483

delete function for procedure. Reported by Jos DeCoster, with patch.</li>

484

<li>Implemented a command line option -L, an equivalent of

485

option -I, just for library search paths.</li>

486

<li>Fixed github issues 5 and 8. Working around a missing variable

487

::errorInfo. It should always be present, however there seem to be

488

revisions of Tcl around which violate this assumption.</li>

489

</ol>

490

</div>

491

<div id="section10" class="section"><h2><a name="section10">Changes for version 3.0.3</a></h2>

492

493

<li>Fixed github issues 5 and 8, for the example build.tcl

494

scripts. Working around a missing variable ::errorInfo. It should

495

always be present, however there seem to be revisions of Tcl around

496

which violate this assumption.</li>

497

</ol>

498

</div>

499

<div id="section11" class="section"><h2><a name="section11">Changes for version 3.0.4</a></h2>

500

501

<li>Fixed generation of the package's initname when the incoming

502

code is read from stdin and has no proper path.</li>

503

<li>Fixed github issue 11. Now using /LIBPATH instead of -L

504

on Windows (libinclude configuration setting).</li>

505

<li>Extended critcl to handle -l:path format of -l options.

506

GNU ld 2.22+ handles this by searching for the path as

507

is. Good when specifying static libraries, as plain -l looks

508

for shared libraries in preference over static. critcl handles

509

it now, as older GNU ld's do not understand it, nor the

510

various vendor-specific linkers.</li>

511

<li>Fixed github issue #12. Critcl now determines the version of

512

MSVC in use and uses it to switch between various link debug

513

options. Simplified the handling of bufferoverflowU.lib also,

514

making use of the same mechanism and collapsing the two

515

configurations sections we had back into one.</li>

516

<li>Reworked the insertion of #line pragmas into the generated C

517

code to avoid limitations on the line number argument imposed

518

by various compilers, and be more accurate.</li>

519

<li>Modified argument processing. Option -libdir now also

520

implies -L for its argument.</li>

521

<li>Extended handling of option -show (critcl::showconfig)

522

to list the path of the configuration file the data is coming

523

from. Good for debugging configuration processing.</li>

524

<li>Extended the build script with targets to regenerate the

525

embedded documentation, and diagrams, and to generate a

526

release.</li>

527

</ol>

528

</div>

529

<div id="section12" class="section"><h2><a name="section12">Changes for version 3.0.5</a></h2>

530

531

<li>Fixed bug in the new code for #line pragmas triggered when

532

specifying C code without leading whitespace.</li>

533

<li>Extended the documentation to have manpages for the license,

534

source retrieval, installer, and developer's guides.</li>

535

</ol>

536

</div>

537

<div id="section13" class="section"><h2><a name="section13">Changes for version 3.0.6</a></h2>

538

539

<li>Fixed github issue 10. The critcl application now delivers a

540

proper exit code (1) on build failure, instead of always

541

indicating success (status 0).</li>

542

<li>Fixed github issue 13. Handling of bufferoverflowU.lib for

543

release builds was inconsistent with handling for debug

544

builds. It is now identically handled (conditional) by

545

both cases.</li>

546

<li>Documentation cleanup, mainly in the installation guide, and

547

the README.md shown by github</li>

548

</ol>

549

</div>

550

<div id="section14" class="section"><h2><a name="section14">Changes for version 3.0.7</a></h2>

551

552

<li>Fixed the code generated by critcl::c++command.

553

The emitted code handed a non-static string table to

554

Tcl_GetIndexFromObj, in violation of the contract, which

555

requires the table to have a fixed address. This was a memory

556

smash waiting to happen. Thanks to Brian Griffin for alrerting

557

us to the general problem.</li>

558

</ol>

559

</div>

560

<div id="section15" class="section"><h2><a name="section15">Changes for version 3.1</a></h2>

561

562

<li>Added a new higher-level package <a href="critcl_iassoc.html">critcl::iassoc</a>.

563

This package simplifies the creation of code associating data

564

with an interpreter via Tcl's Tcl_(Get|Set)AssocData() APIs. The

565

user can concentrate on his data while all the necessary boilerplate

566

C code to support this is generated by the package.

567

This package uses several of the new features which were added

568

to the core <a href="critcl_pkg.html">critcl</a> package, see below.</li>

569

<li>Added the higher-level package <a href="critcl_class.html">critcl::class</a>.

570

This package simplifies the creation of C level objects with

571

class and instance commands. The user can write a class definition

572

with class- and instance-variables and -methods similar to a TclOO

573

class, with all the necessary boilerplate C code to support this

574

generated by the package.

575

This package uses several of the new features which were added

576

to the core <a href="critcl_pkg.html">critcl</a> package, see below.</li>

577

<li>Extended the API for handling TEApot metadata. Added the

578

command critcl::meta? to query the stored information. Main use

579

currently envisioned is retrieval of the current package's name by

580

utility commands, for use in constructed names. This particular

581

information is always available due to the static scan of the package

582

file on execution of the first critcl command.

583

The new packages <a href="critcl_iassoc.html">critcl::iassoc</a> and

584

<a href="critcl_class.html">critcl::class</a> (see above) are users of this command.</li>

585

<li>Extended the API with a command, critcl::name2c, exposing

586

the process of converting a Tcl name into base name, namespace, and C

587

namespace. This enables higher-level code generators to generate the same

588

type of C identifiers as <a href="critcl_pkg.html">critcl</a> itself.

589

The new package <a href="critcl_class.html">critcl::class</a> (see above) is a user

590

of this command.</li>

591

<li>Extended the API with a command, critcl::source,

592

executing critcl commands found in a separate file in the context of

593

the current file. This enables easier management of larger bodies of

594

code as it allows the user to split such up into easier to digest

595

smaller chunks without causing the generation of multiple packages.</li>

596

<li>Related to the previous item, extended the API with commands to

597

divert collection of generated C code into memory. This makes it

598

easier to use the commands for embedded C code in higher-level code

599

generators.

600

See the section Advanced: Diversions for details of

601

the provided commands.

602

The new package <a href="critcl_class.html">critcl::class</a> (see above) is a user

603

of these facilities.</li>

604

<li>Extended the API with commands helping developers with the

605

generation of proper C #line directives. This allows

606

higher-level code generators to generate and insert their own

607

directives, ensuring that compile errors in their code are properly

608

attributed.

609

See the section Advanced: Location management for

610

details of the provided commands.

611

The new packages <a href="critcl_iassoc.html">critcl::iassoc</a> and

612

<a href="critcl_class.html">critcl::class</a> (see above) are users of these facilities.</li>

613

<li>Extended the API with commands giving users the ability to

614

define custom argument and result types for ::critcl::cproc.

615

See the section Advanced: Extending cproc for

616

details of the provided commands.</li>

617

</ol>

618

</div>

619

<div id="section16" class="section"><h2><a name="section16">Changes for version 3.1.1</a></h2>

620

621

<li>Bugfixes all around. In detail:</li>

622

<li>Fixed the generation of wrong#args errors for

623

critcl::cproc and derived code (<a href="critcl_class.html">critcl::class</a>

624

cproc-based methods). Use NULL if there are no arguments, and

625

take the offset into account.</li>

626

<li>Fixed the handling of package names by

627

<a href="critcl_class.html">critcl::class</a>. Forgot that they may contain namespace

628

separators. Bumped to version 1.0.1.</li>

629

<li>Extended a <a href="critcl_class.html">critcl::class</a> generated error message in

630

instance creation for clarity. Bumped to version 1.0.2.</li>

631

</ol>

632

</div>

633

<div id="section17" class="section"><h2><a name="section17">Changes for version 3.1.2</a></h2>

634

635

<li>Enhancement. In detail:</li>

636

<li>Extended critcl::cproc to be able to handle optional

637

arguments, in a limited way. This is automatically available to

638

<a href="critcl_class.html">critcl::class</a> cproc-based methods as well.</li>

639

<li>Bugfix in lassign emulation for Tcl 8.4. Properly set

640

unused variables to the empty string. Bumped version of

641

emulation package lassign84 to 1.0.1.</li>

642

</ol>

643

</div>

644

<div id="section18" class="section"><h2><a name="section18">Changes for version 3.1.3</a></h2>

645

646

<li>Enhancement. In detail:</li>

647

<li>Added new argument type "pstring", for "Pascal String", a

648

counted string, i.e. a combination of string pointer and string

649

length.</li>

650

<li>Added new methods critcl::argtypesupport and

651

::critcl::argsupport to define and use additional

652

supporting code for an argument type, here used by "pstring"

653

above to define the necessary structure.</li>

654

<li>Semi-bugfixes in the packages <a href="critcl_class.html">critcl::class</a> and

655

<a href="critcl_iassoc.html">critcl::iassoc</a>. Pragmas for the AS meta data scanner

656

to ensure that the template files are made part of the package.

657

Versions bumped to 1.0.4 and 1.0.1 respectively.</li>

658

</ol>

659

</div>

660

<div id="section19" class="section"><h2><a name="section19">Changes for version 3.1.4</a></h2>

661

662

<li>Bugfix in package <a href="critcl_class.html">critcl::class</a>. Generate a dummy

663

field in the class structure if the class has no class

664

variables. Without this change the structure would be empty,

665

and a number of compilers are not able to handle such a type.</li>

666

<li>Fixed a typo which broke the win64 configuration.</li>

667

<li>Fixed issue #16, a typo in the documentation of command

668

<a href="critcl_class.html">critcl::class</a>.</li>

669

</ol>

670

</div>

671

<div id="section20" class="section"><h2><a name="section20">Changes for version 3.1.5</a></h2>

672

673

<li>Fixed issue #19. Made the regular expression extracting the

674

MSVC version number more general to make it work on german

675

language systems. This may have to be revisited in the future,

676

for other Windows locales.</li>

677

<li>Fixed issue #20. Made option -tea work on windows, at least in

678

a unix emulation environment like msys/mingw.</li>

679

</ol>

680

</div>

681

<div id="section21" class="section"><h2><a name="section21">Changes for version 3.1.6</a></h2>

682

683

<li>Fixed issue #21. While the multi-definition of the stub-table

684

pointer variables was ok with for all the C linkers seen so far

685

C++ linkers did not like this at all. Reworked the code to

686

ensure that this set of variables is generated only once, in

687

the wrapper around all the pieces to assemble.</li>

688

<li>Fixed issue #22, the handling of the command identifier

689

arguments of critcl::ccommand, critcl::cproc, and

690

critcl::cdata. We now properly allow any Tcl identifier

691

and generate proper internal C identifiers from them.

692

As part of this the signature of command critcl::name2c

693

changed. The command now delivers a list of four values instead

694

of three. The new value was added at the end.

695

Further adapted the implementation of package

696

<a href="critcl_class.html">critcl::class</a>, a user of critcl::name2c.

697

This package is now at version 1.0.6 and requires critcl 3.1.6

698

Lastly fixed the mis-handling of option -cname in

699

critcl::ccommand, and critcl::cproc.</li>

700

<li>Fixed issue #23.</li>

701

</ol>

702

</div>

703

<div id="section22" class="section"><h2><a name="section22">Changes for version 3.1.7</a></h2>

704

705

<li>Fixed issue #24. Extract and unconditionally display compiler

706

warnings found in the build log. Prevents users from missing

707

warnings which, while not causing the build to fail, may

708

still indicate problems.</li>

709

<li>New feature. Output hook. All non-messaging user output is now

710

routed through the command critcl::print, and users are

711

allowed to override it when using the critcl application-as-package.</li>

712

<li>New feature, by Ashok P. Nadkarni. Platform configurations can

713

inherit values from configurations defined before them.</li>

714

</ol>

715

</div>

716

<div id="section23" class="section"><h2><a name="section23">Changes for version 3.1.8</a></h2>

717

718

<li>Fixed issue with package indices generated for Tcl 8.4.

719

Join the list of commands with semi-colon, not newline.</li>

720

<li>Fixed issue #26 which brought up use-cases I had forgotten to

721

consider while fixing bug #21 (see critcl 3.1.6).</li>

722

</ol>

723

</div>

724

<div id="section24" class="section"><h2><a name="section24">Changes for version 3.1.9</a></h2>

725

726

<li>Fixed issue #27. Added missing platform definitions for

727

various alternate linux and OS X targets.</li>

728

<li>Fixed issue #28. Added missing -mXX flags for linking at the

729

linux-{32,64}-* targets.</li>

730

<li>Fixed issue #29. Replaced the use of raw "cheaders"

731

information in the processing of "cdefines" with the proper

732

include directives derived from it.</li>

733

<li>Fixed the issue behind rejected pull request #30 by Andrew

734

Shadura. Dynamically extract the stubs variable declarations

735

from the Tcl header files and generate matching variable

736

definitions for use in the package code. The generated code

737

will now be always consistent with the headers, even when

738

critcl's own copy of them is replaced by system headers.</li>

739

<li>Fixed issue #31. Accepted patch by Andrew Shadura, with

740

changes (comments), for easier integration of critcl with

741

OS package systems, replacing critcl's copies of Tcl headers

742

with their own.</li>

743

<li>Fixed issue #32. Merged pull request by Andrew Shadura.

744

Various typos in documentation and comments.</li>

745

<li>Fixed issue #33. Handle files starting with a dot better.</li>

746

</ol>

747

</div>

748

<div id="section25" class="section"><h2><a name="section25">Authors</a></h2>

749

Jean Claude Wippler, Steve Landers, Andreas Kupries

750

</div>

751

<div id="section26" class="section"><h2><a name="section26">Bugs, Ideas, Feedback</a></h2>

752

This document, and the package it describes, will undoubtedly contain

753

bugs and other problems.

754

Please report them at <a href="https://github.com/andreas-kupries/critcl/issues">https://github.com/andreas-kupries/critcl/issues</a>.

755

Ideas for enhancements you may have for either package, application,

756

and/or the documentation are also very welcome and should be reported

757

at <a href="https://github.com/andreas-kupries/critcl/issues">https://github.com/andreas-kupries/critcl/issues</a> as well.

758

</div>

759

<div id="keywords" class="section"><h2><a name="keywords">Keywords</a></h2>

760

<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 & 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>

761

</div>

762

<div id="category" class="section"><h2><a name="category">Category</a></h2>

763

Glueing/Embedded C code

764

</div>

765

<div id="copyright" class="section"><h2><a name="copyright">Copyright</a></h2>

766

767

768

769

</div>

770

</div></body></html>

Older »