Update of "Documentation"
Overview

Artifact ID: 08b4f3af1aaaa9a1071bf1fc4e57c99213df7d60
Page Name:Documentation
Date: 2014-06-22 22:27:56
Original User: rkeene
Mimetype:text/x-markdown
Parent: 6ce701f58b9fb5058f881fff69edc393782d11f1
Content

High-Level API Manual Page

package require tcc4tcl

tcc4tcl::new

Creates a new TCC interpreter instance.

Synposis:

    tcc4tcl::new ?<outputFile> ?<packageNameAndVersionAsAList>??

Returns an opaque handle which is also a Tcl command to operate on.

$handle cproc

Creates a Tcl procedure that calls C code.

Synoposis:

    $handle cproc <procName> <argList> <returnType> <code>
  1. <procName> is the name of the Tcl procedure to create
  2. <argList> is a list of arguments and their types for the C function;
    1. The list is in the format of: type1 name1 type2 name2 ... typeN nameN
    2. The supported types are:
      1. Tcl_Interp*: Must be first argument, will be the interpreter and the user will not need to pass this parameter
      2. int
      3. long
      4. float
      5. double
      6. char*
      7. Tcl_Obj*: Passes the Tcl object in unchanged
      8. void*
  3. <returnType> is the return type for the C function
    1. The supported types are:
      1. void: No return value
      2. ok: Return TCL_OK or TCL_ERROR
      3. int
      4. long
      5. float
      6. double
      7. char*: TCL_STATIC string (immutable from C -- use this for constants)
      8. string, dstring: return a (char*) that is a TCL_DYNAMIC string (allocated from Tcl_Alloc, will be managed by Tcl)
      9. vstring: return a (char*) that is a TCL_VOLATILE string (mutable from C, will be copied be Tcl -- use this for local variables)
      10. default: Tcl_Obj*, a Tcl Object
  4. <code> is the C code that comprises the function

$handle ccode

Compile arbitrary C code.

Synopsis:

    $handle ccode <code>

$handle tk

Request that Tk be used for this handle.

Synposis:

    $handle tk

$handle linktclcommand

Create a Tcl command that calls an existing C command as a Tcl command.

Synopsis:

    $handle linktclcommand <CSymbol> <TclCommandName>

$handle code

Return text of what code will be compiled when the go subcommand is called.

Synposis:

    $handle code

$handle go

Execute all requested operations and output to memory, an executable, or DLL.

Once this command completes the handle is released.

Synopsis:

    $handle go

See also [Low-Level API]