TABLE OF CONTENTS

Ada/Generic_Command [ Packages ]

[ Top ] [ Ada ] [ Packages ]

FUNCTION

 Generic package to add new commands to Tcl

SOURCE

   generic
      type ClientData is private;
   package Generic_Command is

Ada/Generic_ExitHandler [ Packages ]

[ Top ] [ Ada ] [ Packages ]

FUNCTION

 Generic packaged to add exit handlers to Tcl

SOURCE

   generic
      type ClientData is private;
   package Generic_ExitHandler is

Ada/Generic_PkgRequire [ Packages ]

[ Top ] [ Ada ] [ Packages ]

FUNCTION

 Generic package to manipulate Tcl packages

SOURCE

   generic
      type ClientData is private;
   package Generic_PkgRequire is

Tcl/Ada [ Packages ]

[ Top ] [ Tcl ] [ Packages ]

FUNCTION

 This package provides the "thin" binding to Tcl.

SOURCE

package Tcl.Ada is

Generic_Command/Generic_Command.Tcl_CmdDeleteProc [ Types ]

[ Top ] [ Generic_Command ] [ Types ]

FUNCTION

 Generic procedure which will be executed before command is deleted

SOURCE

      type Tcl_CmdDeleteProc is access procedure(data: in ClientData);
      pragma Convention(C, Tcl_CmdDeleteProc);

PARAMETERS

 data - ClientData passed to the command

Generic_Command/Generic_Command.Tcl_CmdProc [ Types ]

[ Top ] [ Generic_Command ] [ Types ]

FUNCTION

 Generic function for Tcl command

SOURCE

      type Tcl_CmdProc is access function
        (data: in ClientData; interp: in Tcl_Interp; argc: in C.int;
         argv: in CArgv.Chars_Ptr_Ptr) return C.int;
      pragma Convention(C, Tcl_CmdProc);

PARAMETERS

 data   - ClientData passed to command
 interp - Tcl interpreter with which command will be used
 argc   - Number of arguments passed to the command
 argv   - String with argumentts passed to the command. First argument
          is the command name

RESULT

 Tcl result code

Generic_ExitHandler/Generic_ExitHandler.Tcl_ExitProc [ Types ]

[ Top ] [ Generic_ExitHandler ] [ Types ]

FUNCTION

 Generic procedure for exit handlers

SOURCE

      type Tcl_ExitProc is access procedure(data: in ClientData);
      pragma Convention(C, Tcl_ExitProc);

PARAMETERS

 data - ClientData passed to the command

Ada/Ada.Tcl_Eval [ Subprograms ]

[ Top ] [ Ada ] [ Subprograms ]

FUNCTION

 Execute (evaluate) Tcl statement in the selected Tcl interpreter

SOURCE

   function Tcl_Eval
     (interp: Tcl_Interp; strng: in String) return C.int;

   procedure Tcl_Eval(interp: Tcl_Interp; strng: in String);

PARAMETERS

 interp - Tcl interpreter on which the selected statement will be
          evaluated
 strng  - Tcl statement to evaluate

RESULT

 Tcl code (TCL_OK, TCL_ERROR, etc) returned after evaluate the
 selected statement

Ada/Ada.Tcl_EvalFile [ Subprograms ]

[ Top ] [ Ada ] [ Subprograms ]

FUNCTION

 Execute (evaluate) Tcl script from the selected file

SOURCE

   function Tcl_EvalFile
     (interp: Tcl_Interp; fileName: in String) return C.int;

   procedure Tcl_EvalFile(interp: Tcl_Interp; fileName: in String);

PARAMETERS

 interp   - Tcl interpreter on which the selected script will be
            executed
 fileName - Name of file which contains Tcl script to evaluate

RESULT

 Tcl code (TCL_OK, TCL_ERROR, etc) returned after evaluate the
 selected script

Ada/Ada.Tcl_GetVar [ Subprograms ]

[ Top ] [ Ada ] [ Subprograms ]

FUNCTION

 Get value of selected variable

SOURCE

   function Tcl_GetVar
     (interp: Tcl_Interp; varName: in String;
      flags: in C.int := TCL_GLOBAL_ONLY) return String;

PARAMETERS

 interp  - Tcl interpreter in which variable will be queried
 varName - Tcl variable to get
 flags   - Tcl flags to variable

RESULT

 String with value of selected variable

Ada/Ada.Tcl_SetVar [ Subprograms ]

[ Top ] [ Ada ] [ Subprograms ]

FUNCTION

 Set value for the selected variable

SOURCE

   function Tcl_SetVar
     (interp: Tcl_Interp; varName: in String; newValue: in String;
      flags: in C.int := TCL_GLOBAL_ONLY) return String;

   procedure Tcl_SetVar
     (interp: Tcl_Interp; varName: in String; newValue: in String;
      flags: in C.int := TCL_GLOBAL_ONLY);

PARAMETERS

 interp   - Tcl interpreter in which the variable will be set
 varName  - Name of variable to set
 newValue - Value of variable to set
 flags    - Tcl flags for variable

RESULT

 If variable cannot be set, return empty string.

Ada/Ada.Tcl_UnsetVar [ Subprograms ]

[ Top ] [ Ada ] [ Subprograms ]

FUNCTION

 Unset the selected variable

SOURCE

   function Tcl_UnsetVar
     (interp: Tcl_Interp; varName: in String;
      flags: in C.int := TCL_GLOBAL_ONLY) return C.int;

   procedure Tcl_UnsetVar
     (interp: Tcl_Interp; varName: in String;
      flags: in C.int := TCL_GLOBAL_ONLY);

PARAMETERS

 interp   - Tcl interpreter in which the variable will be removed
 varName  - Name of variable to removed
 flags    - Tcl flags for variable

RESULT

 If variable cannot be removed, return TCL_ERROR.

Generic_Command/Generic_Command.Tcl_CreateCommand [ Subprograms ]

[ Top ] [ Generic_Command ] [ Subprograms ]

FUNCTION

 Create new Tcl command

SOURCE

      function Tcl_CreateCommand
        (interp: Tcl_Interp; cmdName: in C.Strings.chars_ptr;
         proc: not null Tcl_CmdProc; data: in ClientData;
         deleteProc: in Tcl_CmdDeleteProc) return Tcl_Command;
      pragma Import(C, Tcl_CreateCommand, "Tcl_CreateCommand");

      function Tcl_CreateCommand
        (interp: Tcl_Interp; cmdName: in String;
         proc: not null Tcl_CmdProc; data: in ClientData;
         deleteProc: in Tcl_CmdDeleteProc) return Tcl_Command;

PARAMETERS

 interp     - Tcl interpreter to which command will be added
 cmdName    - Name of the command used to execute it in Tcl scripts
 proc       - Tcl_CmdProc which will be executed when command will be
              called
 data       - ClientData which will be passed to the command
 deleteProc - Tcl_CmdDeleteProc which will be executed before command
              will be removed from interpreter. Can be null

RESULT

 Newly created Tcl_Command or null if command wasn't created.

Generic_ExitHandler/Generic_ExitHandler.Tcl_CreateExitHandler [ Subprograms ]

[ Top ] [ Generic_ExitHandler ] [ Subprograms ]

FUNCTION

 Set the selected procedure as a standard procedure called on Tcl exit
 command

SOURCE

      procedure Tcl_CreateExitHandler
        (proc: not null Tcl_ExitProc; data: in ClientData);
      pragma Import(C, Tcl_CreateExitHandler, "Tcl_CreateExitHandler");

PARAMETERS

 proc - Tcl_ExitProc which will be used as exit procedure
 data - ClientData passed to the procedure

Generic_ExitHandler/Generic_ExitHandler.Tcl_CreateThreadExitHandler [ Subprograms ]

[ Top ] [ Generic_ExitHandler ] [ Subprograms ]

FUNCTION

 Set the selected procedure as a standart procedure called on exit
 from a Tcl thread

SOURCE

      procedure Tcl_CreateThreadExitHandler
        (proc: not null Tcl_ExitProc; data: in ClientData);
      pragma Import(C, Tcl_CreateThreadExitHandler,
         "Tcl_CreateThreadExitHandler");

PARAMETERS

 proc - Tcl_ExitProc which will be used on exit from thread
 data - ClientData passed to the procedure

Generic_ExitHandler/Generic_ExitHandler.Tcl_DeleteExitHandler [ Subprograms ]

[ Top ] [ Generic_ExitHandler ] [ Subprograms ]

FUNCTION

 Delete previously set procedure as exit handler

SOURCE

      procedure Tcl_DeleteExitHandler
        (proc: not null Tcl_ExitProc; data: in ClientData);
      pragma Import(C, Tcl_DeleteExitHandler, "Tcl_DeleteExitHandler");

PARAMETERS

 proc - Tcl_ExitProc which was set as exit hander
 data - ClientData passed to the procedure

Generic_ExitHandler/Generic_ExitHandler.Tcl_DeleteThreadExitHandler [ Subprograms ]

[ Top ] [ Generic_ExitHandler ] [ Subprograms ]

FUNCTION

 Delete previously set procedure used on exit from Tcl thread

SOURCE

      procedure Tcl_DeleteThreadExitHandler
        (proc: not null Tcl_ExitProc; data: in ClientData);
      pragma Import(C, Tcl_DeleteThreadExitHandler,
         "Tcl_DeleteThreadExitHandler");

PARAMETERS

 proc - Tcl_ExitProc which was set as exit hander
 data - ClientData passed to the procedure

Generic_PkgRequire/Generic_PkgRequire.Tcl_PkgPresentEx [ Subprograms ]

[ Top ] [ Generic_PkgRequire ] [ Subprograms ]

FUNCTION

 Load selected Tcl package if it is not loaded yet.

SOURCE

      function Tcl_PkgPresentEx
        (interp: Tcl_Interp;
         name: in C.Strings.chars_ptr;
         version: in C.Strings.chars_ptr;
         exact: in C.int;
         clientdataptr: access ClientData)    can be null

         return C.Strings.chars_ptr;
      pragma Import(C, Tcl_PkgPresentEx, "Tcl_PkgPresentEx");

      function Tcl_PkgPresentEx
        (interp: Tcl_Interp;
         name: in String;
         version: in String;
         exact: in C.int;
         clientdataptr: access ClientData)    can be null

         return String;

PARAMETERS

 interp        - Tcl interpeter to which package will be loaded
 name          - Name of Tcl package to load
 version       - Version of Tcl package which will be loaded
 exact         - If 0 version can be higher than desired. If greater
                 than 0, version of package must be exactly that same
                 as parameter version
 clientdataptr - Additional data for Tcl command, can be null

RESULT

 String with version of package loaded, if package was not loaded,
 return empty string

Generic_PkgRequire/Generic_PkgRequire.Tcl_PkgProvideEx [ Subprograms ]

[ Top ] [ Generic_PkgRequire ] [ Subprograms ]

FUNCTION

 Check if selected Tcl package is loaded into Tcl interpreter
 interp  - Tcl interpreter to check
 name    - Name of Tcl package to check
 version - Version of package to check
 data    - Additonal data for Tcl command

SOURCE

      function Tcl_PkgProvideEx
        (interp: Tcl_Interp; name: in C.Strings.chars_ptr;
         version: in C.Strings.chars_ptr; data: in ClientData) return C.int;
      pragma Import(C, Tcl_PkgProvideEx, "Tcl_PkgProvideEx");

      function Tcl_PkgProvideEx
        (interp: Tcl_Interp; name: in String; version: in String;
         data: in ClientData) return C.int;

      procedure Tcl_PkgProvideEx
        (interp: Tcl_Interp; name: in String; version: in String;
         data: in ClientData);

RESULT

 Returns TCL_OK if package is loaded, otherwise TCL_ERROR

Generic_PkgRequire/Generic_PkgRequire.Tcl_PkgRequireEx [ Subprograms ]

[ Top ] [ Generic_PkgRequire ] [ Subprograms ]

FUNCTION

 Load selected Tcl package into selected Tcl interpreter

SOURCE

      function Tcl_PkgRequireEx
        (interp: Tcl_Interp;
         name: in C.Strings.chars_ptr;
         version: in C.Strings.chars_ptr;
         exact: in C.int;
         clientdataptr: access ClientData)    can be null

         return C.Strings.chars_ptr;
      pragma Import(C, Tcl_PkgRequireEx, "Tcl_PkgRequireEx");

      function Tcl_PkgRequireEx
        (interp: Tcl_Interp;
         name: in String;
         version: in String;
         exact: in C.int;
         clientdataptr: access ClientData)    can be null

         return String;

PARAMETERS

 interp        - Tcl interpeter to which package will be loaded
 name          - Name of Tcl package to load
 version       - Version of Tcl package which will be loaded
 exact         - If 0 version can be higher than desired. If greater
                 than 0, version of package must be exactly that same
                 as parameter version
 clientdataptr - Additional data for Tcl command, can be null

RESULT

 String with version of package loaded, if package was not loaded,
 return empty string