This is the llvmtcl extension based on the Tcl Extension Architecture (TEA). Please see the the Tcler's wiki page for more details.

This package is a freely available open source package. You can do virtually anything you like with it, such as modifying it, redistributing it, and selling it either in whole or in part. See the file license.terms for complete information.

• Tcl 8.6
• LLVM 4.0, 5.0 or 6.0
• Optional: CMake for Windows Build

The following is a short description of the files you will find in the sample extension.

This is a C++ extension, so make sure to set the CC environment variable to a c++ compiler (e.g. clang++ or g++).

Building under most UNIX systems is easy, just run the configure script and then run make. For more information about the build process, see the tcl/unix/README file in the Tcl src distribution. The following minimal example will build and install the extension:

$ cd llvmtcl
$ ./configure --with-tcl=... --with-llvm-config=...
$ make
$ make test
$ make install

A basic build system based on the CMake project file generator is available. See CMake for details.

You can build the llvmtcl package with VisualStudio 12 like this:

You need to have built LLVM (version 4.0 or later) with CMake for x64 and should have an installed Tcl (e.g. ActiveTcl x64).

c:\devel\tclllvm> md build_x64
c:\devel\tclllvm> cd build_x64
c:\devel\tclllvm\build_x64> "c:\Program Files (x86)\CMake\bin\cmake.exe" -G"Visual Studio 12 2013 Win64" ..
c:\devel\tclllvm\build_x64> msbuild llvmtcl.sln /t:Build /p:Configuration=RelWithDebInfo /p:Platform="x64"

If you want to install the build, you can use the INSTALL target, which will install it in the location given by the CMAKE_INSTALL_PREFIX in a subdir like lib/llvmtcl3.9.

You need to have built LLVM (version 4.0 or later) with CMake for x86 and should have an installed Tcl (e.g. ActiveTcl win32).

c:\devel\tclllvm> md build_x86
c:\devel\tclllvm> cd build_x86
c:\devel\tclllvm\build_x86> "c:\Program Files (x86)\CMake\bin\cmake.exe" -G"Visual Studio 12 2013" ..
c:\devel\tclllvm\build_x86> msbuild llvmtcl.sln /t:Build /p:Configuration=RelWithDebInfo /p:Platform="Win32"

If you want to install the build, you can use the INSTALL target, which will install it in the location given by the CMAKE_INSTALL_PREFIX in a subdir like lib/llvmtcl3.9.

The installation of a TEA package is structure like so:

         $exec_prefix
          /       \
        lib       bin
         |         |
   PACKAGEx.y   (dependent .dll files on Windows)
         |
  pkgIndex.tcl (.so|.dll files)

The main .so|.dll library file gets installed in the versioned PACKAGE directory, which is OK on all platforms because it will be directly referenced with by load in the pkgIndex.tcl file. Dependent DLL files on Windows must go in the bin directory (or other directory on the user's PATH) in order for them to be found.

• To load the extension into a Tcl interpreter:

    package require llvmtcl
  

• The package makes a llvmtcl ensemble command. The subcommands are the LLVM C API functions with LLVM trimmed from the front. All supported types, enumerators and functions can be found in llvmtcl-gen.inp.

• Functions taking a pointer argument followed by an unsigned argument to specified the number of elements the pointer is pointing to are converted to ensemble commands where the pointer and the unsigned argument are replaced by a Tcl list.

examples/test.tcl - Example using the LLVM API to create a factorial function

examples/test2.tcl - Example using the LLVM API to create a function adding 4 and 6 to an argument, optimize that function and execute it.

examples/tebc.tcl - Example converting Tcl into LLVM

examples/ffidle.tcl - Example calling functions in shared libraries

For a more extensive example of use, see the tclquadcode project.