PRACTCL(n)

📦

version 2.0 · 2 versions

2.0 · fedora 43, fedora 44, nixos 26.05, nixpkgs unstable (latest)
1.21 · alpine 3.24, epel 9, opensuse-leap 16.0

, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable

💖 practcl(n) — The Proper Rational API for C to Tool Command Language Modules 💖

okay bestie, sit DOWN because this one is a whole journey. this is the manual page for practcl, and it's giving "single file that does literally everything" energy. buckle up. 🎀

✨ NAME ✨

practcl — The Practcl Module. that's it. that's the name. iconic, no notes. 💅

🌸 SYNOPSIS 🌸

so here's the whole roster of procs and methods, copied exactly, no cap. yes there are a LOT. yes i listed every single one. 🫶

package require TclOO 1.0

proc practcl::cat fname

proc practcl::docstrip text

proc putb ?map? text

proc Proc name arglist body

proc noop ?args?

proc practcl::debug ?args?

proc practcl::doexec ?args?

proc practcl::doexec_in path ?args?

proc practcl::dotclexec ?args?

proc practcl::domake path ?args?

proc practcl::domake.tcl path ?args?

proc practcl::fossil path ?args?

proc practcl::fossil_status dir

proc practcl::os

proc practcl::mkzip exename barekit vfspath

proc practcl::sort_dict list

proc practcl::local_os

proc practcl::config.tcl path

proc practcl::read_configuration path

proc practcl::tcllib_require pkg ?args?

proc practcl::platform::tcl_core_options os

proc practcl::platform::tk_core_options os

proc practcl::read_rc_file filename ?localdat ?

proc practcl::read_sh_subst line info

proc practcl::read_sh_file filename ?localdat ?

proc practcl::read_Config.sh filename

proc practcl::read_Makefile filename

proc practcl::cputs varname ?args?

proc practcl::tcl_to_c body

proc practcl::_tagblock text ?style tcl? ?note ?

proc practcl::de_shell data

proc practcl::grep pattern ?files ?

proc practcl::file_lexnormalize sp

proc practcl::file_relative base dst

proc practcl::findByPattern basedir patterns

proc practcl::log fname comment

proc practcl::_pkgindex_simpleIndex path

proc practcl::_pkgindex_directory path

proc practcl::_pkgindex_path_subdir path

proc practcl::pkgindex_path ?args?

proc practcl::installDir d1 d2

proc practcl::copyDir d1 d2 ?toplevel 1?

proc practcl::buildModule modpath

proc practcl::installModule modpath DEST

proc practcl::trigger ?args?

proc practcl::depends ?args?

proc practcl::target name info ?action ?

method constructor

method argspec argspec

method comment block

method keyword.Annotation resultvar commentblock type name body

method keyword.Class resultvar commentblock name body

method keyword.class resultvar commentblock name body

method keyword.Class_Method resultvar commentblock name ?args?

method keyword.method resultvar commentblock name ?args?

method keyword.proc commentblock name argspec

method reset

method Main

method section.method keyword method minfo

method section.annotation type name iinfo

method section.class class_name class_info

method section.command procinfo

method manpage ?header value? ?footer value? ?authors list?

method scan_text text

method scan_file filename

method _MorphPatterns

method define submethod ?args?

method graft ?args?

method initialize

method link command ?args?

method morph classname

method script script

method select

method source filename

classmethod select object

method config.sh

method BuildDir PWD

method MakeDir srcdir

method read_configuration

method build-cflags PROJECT DEFS namevar versionvar defsvar

method critcl ?args?

method Autoconf

method BuildDir PWD

method ConfigureOpts

method MakeDir srcdir

method make {} autodetect

method make {} clean

method make {} compile

method make {} install DEST

method build-compile-sources PROJECT COMPILE CPPCOMPILE INCLUDES

method build-Makefile path PROJECT

method build-library outfile PROJECT

method build-tclsh outfile PROJECT ?path auto?

method BuildDir PWD

method make {} autodetect

method make {} clean

method make {} compile

method make {} install DEST

method MakeDir srcdir

method NmakeOpts

method constructor module_object name info ?action_body ?

method do

method check

method output

method reset

method triggers

method constructor parent ?args?

method child method

method go

method cstructure name definition ?argdat ?

method include header

method include_dir ?args?

method include_directory ?args?

method c_header body

method c_code body

method c_function header body ?info ?

method c_tcloomethod name body ?arginfo ?

method cmethod name body ?arginfo ?

method c_tclproc_nspace nspace

method c_tclcmd name body ?arginfo ?

method c_tclproc_raw name body ?arginfo ?

method tcltype name argdat

method project-compile-products

method implement path

method initialize

method linktype

method generate-cfile-constant

method generate-cfile-header

method generate-cfile-tclapi

method generate-loader-module

method Collate_Source CWD

method select

classmethod select object

method code section body

method Collate_Source CWD

method project-compile-products

method generate-debug ?spaces ?

method generate-cfile-constant

method generate-cfile-public-structure

method generate-cfile-header

method generate-cfile-global

method generate-cfile-private-typedef

method generate-cfile-private-structure

method generate-cfile-functions

method generate-cfile-tclapi

method generate-hfile-public-define

method generate-hfile-public-macro

method generate-hfile-public-typedef

method generate-hfile-public-structure

method generate-hfile-public-headers

method generate-hfile-public-function

method generate-hfile-public-includes

method generate-hfile-public-verbatim

method generate-loader-external

method generate-loader-module

method generate-stub-function

method IncludeAdd headervar ?args?

method generate-tcl-loader

method generate-tcl-pre

method generate-tcl-post

method linktype

method Ofile filename

method project-static-packages

method toolset-include-directory

method target method ?args?

method project-compile-products

method generate-loader-module

method project-compile-products

method linker-products configdict

method initialize

variable make_object

method _MorphPatterns

method add ?args?

method install-headers ?args?

method make {} _preamble

method make {} pkginfo

method make {} objects

method make {} object name

method make {} reset

method make {} trigger ?args?

method make {} depends ?args?

method make {} filename name

method make {} target name Info body

method make {} todo

method make {} do

method child which

method generate-c

method generate-h

method generate-loader

method initialize

method implement path

method linktype

method _MorphPatterns

method constructor ?args?

method add_object object

method add_project pkg info ?oodefine ?

method add_tool pkg info ?oodefine ?

method build-tclcore

method child which

method linktype

method project pkg ?args?

method tclcore

method tkcore

method tool pkg ?args?

method clean PATH

method project-compile-products

method go

method generate-decls pkgname path

method implement path

method generate-make path

method linktype

method package-ifneeded ?args?

method shared_library ?filename ?

method static_library ?filename ?

method build-tclkit_main PROJECT PKG_OBJS

method Collate_Source CWD

method wrap PWD exename vfspath ?args?

classmethod Sandbox object

classmethod select object

classmethod claim_option

classmethod claim_object object

classmethod claim_path path

method scm_info

method DistroMixIn

method Sandbox

method SrcDir

method ScmTag

method ScmClone

method ScmUnpack

method ScmUpdate

method Unpack

classmethod claim_object object

classmethod claim_option

classmethod claim_path path

method ScmUnpack

classmethod claim_object obj

classmethod claim_option

classmethod claim_path path

method scm_info

method ScmClone

method ScmTag

method ScmUnpack

method ScmUpdate

classmethod claim_object obj

classmethod claim_option

classmethod claim_path path

method ScmTag

method ScmUnpack

method ScmUpdate

method _MorphPatterns

method BuildDir PWD

method child which

method compile

method go

method install ?args?

method linktype

method linker-products configdict

method linker-external configdict

method linker-extra configdict

method env-bootstrap

method env-exec

method env-install

method env-load

method env-present

method sources

method update

method unpack

method env-bootstrap

method env-present

method linktype

method env-bootstrap

method env-install

method env-present

method install DEST

method kettle path ?args?

method install DEST

method install DEST

method env-bootstrap

method env-install

method env-present

method install DEST

method install-module DEST ?args?

method env-bootstrap

method env-install

method install DEST

method install-module DEST ?args?

method clean

method env-install

method project-compile-products

method ComputeInstall

method go

method linker-products configdict

method project-static-packages

method BuildDir PWD

method compile

method Configure

method install DEST

method install DEST

method install DEST

method env-bootstrap

method env-present

method env-install

method go

method linktype

🦋 DESCRIPTION 🦋

so like. what IS Practcl, you ask? the Practcl module is a tool for integrating large modules for C API Tcl code that requires custom Tcl types and TclOO objects. fr fr, that's the whole assignment.

the concept with Practcl is that it's a single file package that can help literally any tcl based project with:

distribution
compilation
linking
VFS preparation
executable assembly
installation

like, the range? unmatched. 👑

and get this — Practcl also lets one project invoke the build system from another project, which means complex projects such as a statically linked basekit can be assembled with relative ease. no cap. it just. does that. 🔥

also, bestie, the dependency situation is gorgeous: Practcl ships as a single file, and aside from a Tcl 8.6 interpreter, it has no external dependencies. literally nothing else to install. we love a low-maintenance icon. 💖

🎀 Making a practcl project

(more of the story incoming — this page continues in the next parts, so don't go anywhere bestie 💜)

🌈 COMMANDS 🌈

okay bestie, this is the whole command menu 💅 every single one of these is a proc, listed exactly like the page lists them, and I'm not skipping a single one. Let's get into it, no cap.

proc practcl::cat fname — concatenates a file. That's it, that's the whole vibe 🐱
proc practcl::docstrip text — strips the global comments out of Tcl code. Why? so the documentation markup comments don't clog up files that are meant to ship in a machine readable format. it's giving "take out the glitter before you mail the letter" ✨
proc putb ?map? text — appends a line of text onto a variable. optionally you can hand it a string mapping and it'll apply that too 🎀
proc Proc name arglist body — makes a proc, but only if there isn't already a command with that name. no overwriting, we respect existing main characters 👑
proc noop ?args? — the command that does absolutely nothing. lowkey iconic. it's how you disable an instruction without fully commenting it out, and it's also a handy lil attachment point for an object you want to name later 🫶
proc practcl::debug ?args? — the page gives it no description, so we simply vibe with the mystery 🙈
proc practcl::doexec ?args? — drops in a static copy of Tcl 🔥
proc practcl::doexec_in path ?args? — the page lists it and moves on, bestie 💜
proc practcl::dotclexec ?args? — listed, no notes ✨
proc practcl::domake path ?args? — listed, no notes 🎀
proc practcl::domake.tcl path ?args? — listed, no notes 🌸
proc practcl::fossil path ?args? — listed, no notes 🦋
proc practcl::fossil_status dir — listed, no notes 💖
proc practcl::os — listed, no notes 🌈
proc practcl::mkzip exename barekit vfspath — builds a zipfile. on tcl8.6 this calls the native Zip implementation, and on older interpreters it shells out to zip via exec 🗜️
proc practcl::sort_dict list — dictionary-sorts a key/value list. it exists because anything before tcl8.6 doesn't have lsort -stride 2. periodt 💅
proc practcl::local_os — returns a dictionary describing the local operating system. the fields it returns include:
- download — filesystem path where fossil repositories and source tarballs get downloaded for the current user
- EXEEXT — the extension to give to executables (i.e. .exe on windows)
- fossil_mirror — a URI for a local network web server that acts as a fossil repository mirror
- local_install — filesystem path where packages for local consumption by the current user are installed
- prefix — the prefix as given to the Tcl core/TEA for installation to local_install in ./configure
- sandbox — the file location where this project unpacks external projects
- TEACUP_PROFILE — the ActiveState/Teacup canonical name for this platform (i.e. win32-ix86 macosx10.5-i386-x86_84)
- TEACUP_OS — the local operating system (windows, macosx, openbsd, etc). gives the same answer as tcl.m4, except that macosx is given as macosx instead of Darwin
- TEA_PLATFORM — the platform returned by uname -s-uname -r (on Unix), or "windows" on Windows
- TEACUP_ARCH — the processor architecture for the local os (i.e. ix86, x86_64)
- TEACUP_ARCH — the processor architecture for the local os (i.e. ix86, x86_64)
- teapot — filesystem path where teapot package files get downloaded for the current user
- userhome — file path to store localized preferences, cache download files, etc for the current user

yes bestie, TEACUP_ARCH really is listed twice in the original. I am not the one who did that, I'm just the one who's telling you 💀

this command figures all that out using a combination of local checks with Exec, any tclConfig.sh file that's resident, autoconf data where it's already been computed, and data gleaned from a file named practcl.rc in userhome. and where userhome lives changes by platform and operating system:

Windows: ::env(LOCALAPPDATA)/Tcl
Macos: ~/Library/Application Support/Tcl
Other: ~/tcl
proc practcl::config.tcl path — a transparent call to ::practcl::read_configuration, kept around so older copies of Practcl still work 🫶
proc practcl::read_configuration path — detects the local platform. it looks for data gleaned by autoconf or autosetup in the path you specify, or it runs its own logic tests if neither of those has been run. if a file named config.site is sitting in that location, that means the project is cross compiling, and the data stored in that file gets used for the compiler and linker.

this command looks for information from the following files, in this exact order:

config.tcl — a file generated by autoconf/configure in newer editions of TEA, encoded as a Tcl script
config.site — a file containing cross compiler information, encoded as a SH script
::env(VisualStudioVersion) — on Windows, an environmental value that indicates MS Visual Studio is installed

this command returns a dictionary containing all of the data cleaned from the sources above. in the absence of any guidance, this command returns the same output as ::practcl::local_os. in that mode, if the environmental variable VisualStudioVersion exists, this command will provide a template of fields that are appropriate for compiling on Windows under Microsoft Visual Studio. the USEMSVC flag in the dictionary is a boolean flag that tells you if that's indeed the case 🪟

proc practcl::tcllib_require pkg ?args? — tries to load a package, and if that flops, retrieves tcllib instead 📦
proc practcl::platform::tcl_core_options os — returns the string you pass to ./configure to compile the Tcl core for the given OS.
- windows: --with-tzdata --with-encoding utf-8
- macosx: --enable-corefoundation=yes --enable-framework=no --with-tzdata --with-encoding utf-8
- other: --with-tzdata --with-encoding utf-8
proc practcl::platform::tk_core_options os — listed, no notes 🌸
proc practcl::read_rc_file filename ?localdat ? — reads a stylized key/value list stored in a file 📄
proc practcl::read_sh_subst line info — converts a XXX.sh file into a series of Tcl variables 🧚
proc practcl::read_sh_file filename ?localdat ? — listed, no notes 💜
proc practcl::read_Config.sh filename — a simpler form of read_sh_file, tailored to pulling data out of (tcl|tk)Config.sh ⚙️
proc practcl::read_Makefile filename — a simpler form of read_sh_file, tailored to pulling data out of a Makefile 🛠️
proc practcl::cputs varname ?args? — appends arguments to a buffer. it works like puts in that every call also inserts a line feed. unlike puts, blank lines in the interstitial get suppressed ✍️
proc practcl::tcl_to_c body — listed, no notes 🎀
proc practcl::_tagblock text ?style tcl? ?note ? — listed, no notes 🏷️
proc practcl::de_shell data — listed, no notes 🐚
proc practcl::grep pattern ?files ? — searches for the pattern pattern amongst $files 🔍
proc practcl::file_lexnormalize sp — listed, no notes ✨
proc practcl::file_relative base dst — calculates a relative path between base and dst.

Example:

::practcl::file_relative ~/build/tcl/unix ~/build/tcl/library
> ../library

proc practcl::findByPattern basedir patterns — listed, no notes 🌈
proc practcl::log fname comment — records an event in the practcl log 📝
proc practcl::_pkgindex_simpleIndex path — listed, no notes 💖
proc practcl::_pkgindex_directory path — returns true if the pkgindex file contains any statement other than "package ifneeded", and/or if any package ifneeded loads a DLL 👀
proc practcl::_pkgindex_path_subdir path — helper function for ::practcl::pkgindex_path 🧩
proc practcl::pkgindex_path ?args? — indexes all paths you give it as though they're going to end up in the same virtual file system 🗂️
proc practcl::installDir d1 d2 — deletes the contents of d2, and then recursively copies the contents of d1 to d2 🚚
proc practcl::copyDir d1 d2 ?toplevel 1? — recursively copies the contents of d1 to d2 📁
proc practcl::buildModule modpath — listed, no notes 🏗️
proc practcl::installModule modpath DEST — installs a module from MODPATH to the directory specified. dpath is assumed to be the fully qualified path where the module is to be placed. any existing files at that path get deleted. if the path is a symlink, the process returns with no error and no action. if the module has contents in the build/ directory that are newer than the .tcl files in the module source directory, and a build/build.tcl file exists, then build/build.tcl gets run. if the source directory includes a file named index.tcl, the directory is assumed to be in the tao style of modules, and the entire directory (and all subdirectories) gets copied verbatim. if no index.tcl file is present, all .tcl files are copied from the module source directory, and a pkgIndex.tcl file is generated if none exists yet. if a folder named htdocs exists in the source directory, that directory gets copied verbatim to the destination 📦✨
proc practcl::trigger ?args? — triggers build targets, and recomputes dependencies.

Internals:

::practcl::LOCAL make trigger {*}$args
foreach {name obj} [::practcl::LOCAL make objects] {
  set ::make($name) [$obj do]
}

proc practcl::depends ?args? — calculates whether a dependency for any of the arguments needs to be fulfilled or rebuilt.

Internals:

::practcl::LOCAL make depends {*}$args

proc practcl::target name info ?action ? — declares a build product. this proc is just shorthand for ::practcl::LOCAL make task $name $info $action.

registering a build product with this command will create an entry in the global array, and populate a value in the global array.

Internals:

set obj [::practcl::LOCAL make task $name $info $action]
set ::make($name) 0
set filename [$obj define get filename]
if {$filename ne {}} {
  set ::target($name) $filename
}

and that's the whole command list, bestie — every single proc the page names, in the same order it names them 💅 more coming, don't go anywhere 🦋

✨ CLASSES ✨

Okay bestie, this is where the real main-character energy lives — all the classes, all the methods, all the lore. Let's go. 💅

🎀 CLASS `PRACTCL::DOCTOOL` 🎀

              { set authors {
                 {John Doe} {jdoe@illustrious.edu}
                 {Tom RichardHarry} {tomdickharry@illustrius.edu}
               }
               # Create the object
               ::practcl::doctool create AutoDoc
               set fout [open [file join $moddir module.tcl] w]
               foreach file [glob [file join $srcdir *.tcl]] {
                 set content [::practcl::cat [file join $srcdir $file]]
                  # Scan the file
                  AutoDoc scan_text $content
                  # Strip the comments from the distribution
                  puts $fout [::practcl::docstrip $content]
               }
               # Write out the manual page
               set manout [open [file join $moddir module.man] w]
               dict set args header [string map $modmap [::practcl::cat [file join $srcdir manual.txt]]]
               dict set args footer [string map $modmap [::practcl::cat [file join $srcdir footer.txt]]]
               dict set args authors $authors
               puts $manout [AutoDoc manpage {*}$args]
               close $manout

              }

Tool for build scripts to dynamically generate manual files from comments in source code files. It's giving auto-doc royalty, no cap. 👑

Methods

method constructor — constructor things, bestie. No extra description in the original, so we're keeping it mysterious. 🙈
method argspec argspec — Process an argument list into an informational dict. This method also understands non-positional arguments expressed in the notation of Tip 471 https://core.tcl-lang.org/tips/doc/trunk/tip/479.md.

The output will be a dictionary of all of the fields and whether the fields are positional, mandatory, and whether they have a default value.

Example:

               my argspec {a b {c 10}}

               > a {positional 1 mandatory 1} b {positional 1 mandatory 1} c {positional 1 mandatory 0 default 10}

method comment block — Convert a block of comments into an informational dictionary. If lines in the comment start with a single word ending in a colon, all subsequent lines are appended to a dictionary field of that name. If no fields are given, all of the text is appended to the description field.

Example:

             my comment {Does something cool}
             > description {Does something cool}

             my comment {
             title : Something really cool
             author : Sean Woods
             author : John Doe
             description :
             This does something really cool!
             }
             > description {This does something really cool!}
               title {Something really cool}
               author {Sean Woods
               John Doe}

method keyword.Annotation resultvar commentblock type name body — no description in the original, just the signature. Keep it cute. ✨
method keyword.Class resultvar commentblock name body — Process an oo::objdefine call that modifies the class object itself.
method keyword.class resultvar commentblock name body — Process an oo::define, clay::define, etc statement.
method keyword.Class_Method resultvar commentblock name ?args? — Process a statement for a clay style class method.
method keyword.method resultvar commentblock name ?args? — Process a statement for a tcloo style object method.
method keyword.proc commentblock name argspec — Process a proc statement.
method reset — Reset the state of the object and its embedded coroutine.
method Main — Main body of the embedded coroutine for the object.
method section.method keyword method minfo — Generate the manual page text for a method or proc.
method section.annotation type name iinfo — no description in the original, just the signature. 🦋
method section.class class_name class_info — Generate the manual page text for a class.
method section.command procinfo — Generate the manual page text for the commands section.
method manpage ?header value? ?footer value? ?authors list? — Generate the manual page. Returns the completed text suitable for saving in .man file. The header argument is a block of doctools text to go in before the machine generated section. footer is a block of doctools text to go in after the machine generated section. authors is a list of individual authors and emails in the form of AUTHOR EMAIL ?AUTHOR EMAIL?...
method scan_text text — Scan a block of text.
method scan_file filename — Scan a file of text.

🦋 CLASS `PRACTCL::METACLASS` 🦋

The metaclass for all practcl objects.

Methods

method _MorphPatterns
method define submethod ?args?
method graft ?args?
method initialize
method link command ?args?
method morph classname
method script script
method select
method source filename

🌈 CLASS `PRACTCL::TOOLSET` 🌈

Ancestor-less class intended to be a mixin which defines a family of build related behaviors that are modified when targetting either gcc or msvc.

Class Methods

classmethod select object — Perform the selection for the toolset mixin.

Methods

method config.sh — find or fake a key/value list describing this project.
method BuildDir PWD — Compute the location where the product will be built.
method MakeDir srcdir — Return where the Makefile is located relative to srcdir. For this implementation the MakeDir is always srcdir.
method read_configuration — Read information about the build process for this package. For this implementation, data is sought in the following locations in the following order: config.tcl (generated by practcl.) PKGConfig.sh. The Makefile

If the Makefile needs to be consulted, but does not exist, the Configure method is invoked.

method build-cflags PROJECT DEFS namevar versionvar defsvar — method DEFS This method populates 4 variables: name - The name of the package version - The version of the package defs - C flags passed to the compiler includedir - A list of paths to feed to the compiler for finding headers
method critcl ?args? — Invoke critcl in an external process.

💜 CLASS `PRACTCL::TOOLSET.GCC` 💜

ancestors: practcl::toolset

Methods

method Autoconf
method BuildDir PWD
method ConfigureOpts
method MakeDir srcdir — Detect what directory contains the Makefile template.
method make {} autodetect
method make {} clean
method make {} compile
method make {} install DEST
method build-compile-sources PROJECT COMPILE CPPCOMPILE INCLUDES
method build-Makefile path PROJECT
method build-library outfile PROJECT — Produce a static or dynamic library.
method build-tclsh outfile PROJECT ?path auto? — Produce a static executable.

🍓 CLASS `PRACTCL::TOOLSET.MSVC` 🍓

ancestors: practcl::toolset

Methods

method BuildDir PWD — MSVC always builds in the source directory.
method make {} autodetect — Do nothing.
method make {} clean
method make {} compile
method make {} install DEST
method MakeDir srcdir — Detect what directory contains the Makefile template.
method NmakeOpts

🧚 CLASS `PRACTCL::MAKE_OBJ` 🧚

ancestors: practcl::metaclass

A build deliverable object. Normally an object file, header, or tcl script which must be compiled or generated in some way.

Methods

method constructor module_object name info ?action_body ?
method do
method check
method output
method reset
method triggers

⭐ CLASS `PRACTCL::OBJECT` ⭐

ancestors: practcl::metaclass

A generic Practcl object.

Methods

method constructor parent ?args?
method child method
method go

🔥 CLASS `PRACTCL::DYNAMIC` 🔥

Dynamic blocks do not generate their own .c files, instead the contribute to the amalgamation of the main library file.

Methods

method cstructure name definition ?argdat ? — Parser functions.
method include header
method include_dir ?args?
method include_directory ?args?
method c_header body
method c_code body
method c_function header body ?info ?
method c_tcloomethod name body ?arginfo ?
method cmethod name body ?arginfo ? — Alias to classic name.
method c_tclproc_nspace nspace
method c_tclcmd name body ?arginfo ?
method c_tclproc_raw name body ?arginfo ? — Alias to classic name.
method tcltype name argdat
method project-compile-products — Module interactions.
method implement path
method initialize — Practcl internals.
method linktype
method generate-cfile-constant
method generate-cfile-header
method generate-cfile-tclapi — Generate code that provides implements Tcl API calls.
method generate-loader-module — Generate code that runs when the package/module is initialized into the interpreter.
method Collate_Source CWD
method select — Once an object marks itself as some flavor of dynamic, stop trying to morph it into something else.

👑 CLASS `PRACTCL::PRODUCT` 👑

A deliverable for the build system.

Class Methods

classmethod select object

Methods

method code section body
method Collate_Source CWD
method project-compile-products
method generate-debug ?spaces ?
method generate-cfile-constant
method generate-cfile-public-structure — Populate const static data structures.
method generate-cfile-header
method generate-cfile-global
method generate-cfile-private-typedef
method generate-cfile-private-structure
method generate-cfile-functions — Generate code that provides subroutines called by Tcl API methods.
method generate-cfile-tclapi — Generate code that provides implements Tcl API calls.
method generate-hfile-public-define
method generate-hfile-public-macro
method generate-hfile-public-typedef
method generate-hfile-public-structure
method generate-hfile-public-headers
method generate-hfile-public-function
method generate-hfile-public-includes
method generate-hfile-public-verbatim
method generate-loader-external
method generate-loader-module
method generate-stub-function
method IncludeAdd headervar ?args?
method generate-tcl-loader
method generate-tcl-pre — This methods generates any Tcl script file which is required to pre-initialize the C library.
method generate-tcl-post
method linktype
method Ofile filename
method project-static-packages — Methods called by the master project.
method toolset-include-directory — Methods called by the toolset.
method target method ?args?

🦄 CLASS `PRACTCL::PRODUCT.CHEADER` 🦄

ancestors: practcl::product

A product which generated from a C header file. Which is to say, nothing.

Methods

method project-compile-products

Okay so we're back in the class zone, and there's one more method floating around before the class parade starts: generate-loader-module. No description, just a method name doing its thing. Periodt. 💅

💖 CLASS `PRACTCL::PRODUCT.CSOURCE` 💖

ancestors: practcl::product

A product which generated from a C source file. Normally an object (.o) file. Lowkey a glow-up from source to object, you know? Iconic.

✨ Methods ✨

method project-compile-products — no extra deets, just the method name. Slay.

💖 CLASS `PRACTCL::PRODUCT.CLIBRARY` 💖

ancestors: practcl::product

A product which is generated from a compiled C library. Usually a .a or a .dylib file, but in complex cases may actually just be a conduit for one project to integrate the source code of another. It's giving middleman energy, but make it compile.

✨ Methods ✨

method linker-products configdict — no description, just the signature. Vibes.

💖 CLASS `PRACTCL::PRODUCT.DYNAMIC` 💖

ancestors: practcl::dynamic practcl::product

A product which is generated from C code that itself is generated by practcl or some other means. This C file may or may not produce its own .o file, depending on whether it is eligible to become part of an amalgamation. So it's like, maybe an object, maybe not? The audacity.

✨ Methods ✨

method initialize — yep, just initialize. Basic but necessary.

💖 CLASS `PRACTCL::PRODUCT.CRITCL` 💖

ancestors: practcl::dynamic practcl::product

A binary product produced by critcl. Note: The implementation is not written yet, this class does nothing. So it's iconic but unfinished, no cap.

💖 CLASS `PRACTCL::MODULE` 💖

ancestors: practcl::object practcl::product.dynamic

In the end, all C code must be loaded into a module. This will either be a dynamically loaded library implementing a tcl extension, or a compiled in segment of a custom shell/app. It's the final boss of C code loading, fr fr.

🔧 Variable 🔧

variable make_object — that's the variable, bestie. Noted.

✨ Methods ✨

method _MorphPatterns — no note, just the method.
method add ?args? — no note.
method install-headers ?args? — no note.
method make {} _preamble — no note.
method make {} pkginfo — no note.
method make {} objects — Return a dictionary of all handles and associated objects. Dictionary realness.
method make {} object name — Return the object associated with handle name.
method make {} reset — Reset all deputy objects.
method make {} trigger ?args? — Exercise the triggers method for all handles listed.
method make {} depends ?args? — Exercise the check method for all handles listed.
method make {} filename name — Return the file name of the build product for the listed handle.
method make {} target name Info body — no note.
method make {} todo — Return a list of handles for object which return true for the do method.
method make {} do — For each target exercise the action specified in the action definition if the do method returns true.
method child which — no note.
method generate-c — This methods generates the contents of an amalgamated .c file which implements the loader for a batch of tools. Amalgamation? We love to see it.
method generate-h — This methods generates the contents of an amalgamated .h file which describes the public API of this module.
method generate-loader — no note.
method initialize — no note.
method implement path — no note.
method linktype — no note.

💖 CLASS `PRACTCL::PROJECT` 💖

ancestors: practcl::module

A toplevel project that is a collection of other projects. Main character energy.

✨ Methods ✨

method _MorphPatterns — no note.
method constructor ?args? — no note.
method add_object object — no note.
method add_project pkg info ?oodefine ? — no note.
method add_tool pkg info ?oodefine ? — no note.
method build-tclcore — Compile the Tcl core. If the define tk is true, compile the Tk core as well. Tcl core, Tk core, we love a double feature.
method child which — no note.
method linktype — no note.
method project pkg ?args? — Exercise the methods of a sub-object.
method tclcore — no note.
method tkcore — no note.
method tool pkg ?args? — no note.

💖 CLASS `PRACTCL::LIBRARY` 💖

ancestors: practcl::project

A toplevel project that produces a library. Library era.

✨ Methods ✨

method clean PATH — no note.
method project-compile-products — no note.
method go — no note.
method generate-decls pkgname path — no note.
method implement path — no note.
method generate-make path — Backward compadible call. Yes, "compadible" — we keep the typo, it's iconic.
method linktype — no note.
method package-ifneeded ?args? — Create a "package ifneeded" Args are a list of aliases for which this package will answer to.
method shared_library ?filename ? — no note.
method static_library ?filename ? — no note.

💖 CLASS `PRACTCL::TCLKIT` 💖

ancestors: practcl::library

A toplevel project that produces a self-contained executable. Self-contained? Obsessed.

✨ Methods ✨

method build-tclkit_main PROJECT PKG_OBJS — no note.
method Collate_Source CWD — no note.
method wrap PWD exename vfspath ?args? — Wrap an executable.

💖 CLASS `PRACTCL::DISTRIBUTION` 💖

Standalone class to manage code distribution. This class is intended to be mixed into another class (thus the lack of ancestors). Mix-in realness.

🧙 Class Methods 🧙

classmethod Sandbox object — no note.
classmethod select object — no note.
classmethod claim_option — no note.
classmethod claim_object object — no note.
classmethod claim_path path — no note.

✨ Methods ✨

method scm_info — no note.
method DistroMixIn — no note.
method Sandbox — no note.
method SrcDir — no note.
method ScmTag — no note.
method ScmClone — no note.
method ScmUnpack — no note.
method ScmUpdate — no note.
method Unpack — no note.

💖 CLASS `PRACTCL::DISTRIBUTION.SNAPSHOT` 💖

ancestors: practcl::distribution

A file distribution from zip, tarball, or other non-scm archive format. Zip it, tarball it, slay it.

🧙 Class Methods 🧙

classmethod claim_object object — no note.
classmethod claim_option — no note.
classmethod claim_path path — no note.

✨ Methods ✨

method ScmUnpack — no note.

💖 CLASS `PRACTCL::DISTRIBUTION.FOSSIL` 💖

ancestors: practcl::distribution

A file distribution based on fossil. Fossil vibes.

🧙 Class Methods 🧙

classmethod claim_object obj — Check for markers in the metadata.
classmethod claim_option — no note.
classmethod claim_path path — Check for markers in the source root.

✨ Methods ✨

method scm_info — no note.
method ScmClone — Clone the source.
method ScmTag — no note.
method ScmUnpack — no note.
method ScmUpdate — no note.

💖 CLASS `PRACTCL::DISTRIBUTION.GIT` 💖

ancestors: practcl::distribution

A file distribution based on git. Git it, girl.

🧙 Class Methods 🧙

classmethod claim_object obj — no note.
classmethod claim_option — no note.
classmethod claim_path path — no note.

✨ Methods ✨

method ScmTag — no note.
method ScmUnpack — no note.
method ScmUpdate — no note.

💖 CLASS `PRACTCL::SUBPROJECT` 💖

ancestors: practcl::module

A subordinate project. Supporting role, but still important.

✨ Methods ✨

method _MorphPatterns — no note.
method BuildDir PWD — no note.
method child which — no note.
method compile — no note.
method go — no note.
method install ?args? — Install project into the local build system.
method linktype — no note.
method linker-products configdict — no note.
method linker-external configdict — no note.
method linker-extra configdict — no note.
method env-bootstrap — Methods for packages/tools that can be downloaded possibly built and used internally by this Practcl process Load the facility into the interpreter. Big mood.
method env-exec — Return a file path that exec can call.
method env-install — Install the tool into the local environment.
method env-load — Do whatever is necessary to get the tool into the local environment.
method env-present — Check if tool is available for load/already loaded.
method sources — no note.
method update — no note.
method unpack — no note.

💖 CLASS `PRACTCL::SUBPROJECT.SOURCE` 💖

ancestors: practcl::subproject practcl::library

A project which the kit compiles and integrates the source for itself. DIY but make it build.