1practcl(Tnh)e The Proper Rational API for C to Tool Command Language Modpurlaectcl(n)
2______________________________________________________________________________
6
8 practcl - The Practcl Module
9
11 package require TclOO 1.0
12 proc practcl::cat fname
14 proc practcl::docstrip text
16 proc putb ?map? text
18 proc Proc name arglist body
20 proc noop ?args?
22 proc practcl::debug ?args?
24 proc practcl::doexec ?args?
26 proc practcl::doexec_in path ?args?
28 proc practcl::dotclexec ?args?
30 proc practcl::domake path ?args?
32 proc practcl::domake.tcl path ?args?
34 proc practcl::fossil path ?args?
36 proc practcl::fossil_status dir
38 proc practcl::os
40 proc practcl::mkzip exename barekit vfspath
42 proc practcl::sort_dict list
44 proc practcl::local_os
46 proc practcl::config.tcl path
48 proc practcl::read_configuration path
50 proc practcl::tcllib_require pkg ?args?
52 proc practcl::platform::tcl_core_options os
54 proc practcl::platform::tk_core_options os
56 proc practcl::read_rc_file filename ?localdat ?
58 proc practcl::read_sh_subst line info
60 proc practcl::read_sh_file filename ?localdat ?
62 proc practcl::read_Config.sh filename
64 proc practcl::read_Makefile filename
66 proc practcl::cputs varname ?args?
68 proc practcl::tcl_to_c body
70 proc practcl::_tagblock text ?style tcl? ?note ?
72 proc practcl::de_shell data
74 proc practcl::grep pattern ?files ?
76 proc practcl::file_lexnormalize sp
78 proc practcl::file_relative base dst
80 proc practcl::findByPattern basedir patterns
82 proc practcl::log fname comment
84 proc practcl::_pkgindex_simpleIndex path
86 proc practcl::_pkgindex_directory path
88 proc practcl::_pkgindex_path_subdir path
90 proc practcl::pkgindex_path ?args?
92 proc practcl::installDir d1 d2
94 proc practcl::copyDir d1 d2 ?toplevel 1?
96 proc practcl::buildModule modpath
98 proc practcl::installModule modpath DEST
100 proc practcl::trigger ?args?
102 proc practcl::depends ?args?
104 proc practcl::target name info ?action ?
106 method constructor
108 method argspec argspec
110 method comment block
112 method keyword.Annotation resultvar commentblock type name body
114 method keyword.Class resultvar commentblock name body
116 method keyword.class resultvar commentblock name body
118 method keyword.Class_Method resultvar commentblock name ?args?
120 method keyword.method resultvar commentblock name ?args?
122 method keyword.proc commentblock name argspec
124 method reset
126 method Main
128 method section.method keyword method minfo
130 method section.annotation type name iinfo
132 method section.class class_name class_info
134 method section.command procinfo
136 method manpage ?header value? ?footer value? ?authors list?
138 method scan_text text
140 method scan_file filename
142 method _MorphPatterns
144 method define submethod ?args?
146 method graft ?args?
148 method initialize
150 method link command ?args?
152 method morph classname
154 method script script
156 method select
158 method source filename
160 classmethod select object
162 method config.sh
164 method BuildDir PWD
166 method MakeDir srcdir
168 method read_configuration
170 method build-cflags PROJECT DEFS namevar versionvar defsvar
172 method critcl ?args?
174 method Autoconf
176 method BuildDir PWD
178 method ConfigureOpts
180 method MakeDir srcdir
182 method make {} autodetect
184 method make {} clean
186 method make {} compile
188 method make {} install DEST
190 method build-compile-sources PROJECT COMPILE CPPCOMPILE INCLUDES
192 method build-Makefile path PROJECT
194 method build-library outfile PROJECT
196 method build-tclsh outfile PROJECT ?path auto?
198 method BuildDir PWD
200 method make {} autodetect
202 method make {} clean
204 method make {} compile
206 method make {} install DEST
208 method MakeDir srcdir
210 method NmakeOpts
212 method constructor module_object name info ?action_body ?
214 method do
216 method check
218 method output
220 method reset
222 method triggers
224 method constructor parent ?args?
226 method child method
228 method go
230 method cstructure name definition ?argdat ?
232 method include header
234 method include_dir ?args?
236 method include_directory ?args?
238 method c_header body
240 method c_code body
242 method c_function header body ?info ?
244 method c_tcloomethod name body ?arginfo ?
246 method cmethod name body ?arginfo ?
248 method c_tclproc_nspace nspace
250 method c_tclcmd name body ?arginfo ?
252 method c_tclproc_raw name body ?arginfo ?
254 method tcltype name argdat
256 method project-compile-products
258 method implement path
260 method initialize
262 method linktype
264 method generate-cfile-constant
266 method generate-cfile-header
268 method generate-cfile-tclapi
270 method generate-loader-module
272 method Collate_Source CWD
274 method select
276 classmethod select object
278 method code section body
280 method Collate_Source CWD
282 method project-compile-products
284 method generate-debug ?spaces ?
286 method generate-cfile-constant
288 method generate-cfile-public-structure
290 method generate-cfile-header
292 method generate-cfile-global
294 method generate-cfile-private-typedef
296 method generate-cfile-private-structure
298 method generate-cfile-functions
300 method generate-cfile-tclapi
302 method generate-hfile-public-define
304 method generate-hfile-public-macro
306 method generate-hfile-public-typedef
308 method generate-hfile-public-structure
310 method generate-hfile-public-headers
312 method generate-hfile-public-function
314 method generate-hfile-public-includes
316 method generate-hfile-public-verbatim
318 method generate-loader-external
320 method generate-loader-module
322 method generate-stub-function
324 method IncludeAdd headervar ?args?
326 method generate-tcl-loader
328 method generate-tcl-pre
330 method generate-tcl-post
332 method linktype
334 method Ofile filename
336 method project-static-packages
338 method toolset-include-directory
340 method target method ?args?
342 method project-compile-products
344 method generate-loader-module
346 method project-compile-products
348 method linker-products configdict
350 method initialize
352 variable make_object
354 method _MorphPatterns
356 method add ?args?
358 method install-headers ?args?
360 method make {} _preamble
362 method make {} pkginfo
364 method make {} objects
366 method make {} object name
368 method make {} reset
370 method make {} trigger ?args?
372 method make {} depends ?args?
374 method make {} filename name
376 method make {} target name Info body
378 method make {} todo
380 method make {} do
382 method child which
384 method generate-c
386 method generate-h
388 method generate-loader
390 method initialize
392 method implement path
394 method linktype
396 method _MorphPatterns
398 method constructor ?args?
400 method add_object object
402 method add_project pkg info ?oodefine ?
404 method add_tool pkg info ?oodefine ?
406 method build-tclcore
408 method child which
410 method linktype
412 method project pkg ?args?
414 method tclcore
416 method tkcore
418 method tool pkg ?args?
420 method clean PATH
422 method project-compile-products
424 method go
426 method generate-decls pkgname path
428 method implement path
430 method generate-make path
432 method linktype
434 method package-ifneeded ?args?
436 method shared_library ?filename ?
438 method static_library ?filename ?
440 method build-tclkit_main PROJECT PKG_OBJS
442 method Collate_Source CWD
444 method wrap PWD exename vfspath ?args?
446 classmethod Sandbox object
448 classmethod select object
450 classmethod claim_option
452 classmethod claim_object object
454 classmethod claim_path path
456 method scm_info
458 method DistroMixIn
460 method Sandbox
462 method SrcDir
464 method ScmTag
466 method ScmClone
468 method ScmUnpack
470 method ScmUpdate
472 method Unpack
474 classmethod claim_object object
476 classmethod claim_option
478 classmethod claim_path path
480 method ScmUnpack
482 classmethod claim_object obj
484 classmethod claim_option
486 classmethod claim_path path
488 method scm_info
490 method ScmClone
492 method ScmTag
494 method ScmUnpack
496 method ScmUpdate
498 classmethod claim_object obj
500 classmethod claim_option
502 classmethod claim_path path
504 method ScmTag
506 method ScmUnpack
508 method ScmUpdate
510 method _MorphPatterns
512 method BuildDir PWD
514 method child which
516 method compile
518 method go
520 method install ?args?
522 method linktype
524 method linker-products configdict
526 method linker-external configdict
528 method linker-extra configdict
530 method env-bootstrap
532 method env-exec
534 method env-install
536 method env-load
538 method env-present
540 method sources
542 method update
544 method unpack
546 method env-bootstrap
548 method env-present
550 method linktype
552 method env-bootstrap
554 method env-install
556 method env-present
558 method install DEST
560 method kettle path ?args?
562 method install DEST
564 method install DEST
566 method env-bootstrap
568 method env-install
570 method env-present
572 method install DEST
574 method install-module DEST ?args?
576 method env-bootstrap
578 method env-install
580 method install DEST
582 method install-module DEST ?args?
584 method clean
586 method env-install
588 method project-compile-products
590 method ComputeInstall
592 method go
594 method linker-products configdict
596 method project-static-packages
598 method BuildDir PWD
600 method compile
602 method Configure
604 method install DEST
606 method install DEST
608 method install DEST
610 method env-bootstrap
612 method env-present
614 method env-install
616 method go
618 method linktype
620______________________________________________________________________________
622
624 The Practcl module is a tool for integrating large modules for C API
625 Tcl code that requires custom Tcl types and TclOO objects.
626 The concept with Practcl is that is a single file package that can as‐
628 sist any tcl based project with distribution, compilation, linking, VFS
629 preparation, executable assembly, and installation. Practcl also allows
630 one project to invoke the build system from another project, allowing
631 complex projects such as a statically linked basekit to be assembled
632 with relative ease.
633 Practcl ships as a single file, and aside from a Tcl 8.6 interpreter,
635 has no external dependencies.
636 Making a practcl project
638
640 proc practcl::cat fname
641 Concatenate a file
642 proc practcl::docstrip text
644 Strip the global comments from tcl code. Used to prevent the
645 documentation markup comments from clogging up files intended
646 for distribution in machine readable format.
647 proc putb ?map? text
649 Append a line of text to a variable. Optionally apply a string
650 mapping.
651 proc Proc name arglist body
653 Generate a proc if no command already exists by that name
654 proc noop ?args?
656 A command to do nothing. A handy way of negating an instruction
657 without having to comment it completely out. It's also a handy
658 attachment point for an object to be named later
659 proc practcl::debug ?args?
661 proc practcl::doexec ?args?
663 Drop in a static copy of Tcl
664 proc practcl::doexec_in path ?args?
666 proc practcl::dotclexec ?args?
668 proc practcl::domake path ?args?
670 proc practcl::domake.tcl path ?args?
672 proc practcl::fossil path ?args?
674 proc practcl::fossil_status dir
676 proc practcl::os
678 proc practcl::mkzip exename barekit vfspath
680 Build a zipfile. On tcl8.6 this invokes the native Zip implemen‐
681 tation on older interpreters this invokes zip via exec
682 proc practcl::sort_dict list
684 Dictionary sort a key/value list. Needed because pre tcl8.6 does
685 not have lsort -stride 2
686 proc practcl::local_os
688 Returns a dictionary describing the local operating system.
689 Fields return include:
690 • download - Filesystem path where fossil repositories and
692 source tarballs are downloaded for the current user
693 • EXEEXT - The extension to give to executables. (i.e. .exe
695 on windows)
696 • fossil_mirror - A URI for a local network web server who
698 acts as a fossil repository mirror
699 • local_install - Filesystem path where packages for local
701 consumption by the current user are installed
702 • prefix - The prefix as given to the Tcl core/TEA for in‐
704 stallation to local_install in ./configure
705 • sandbox - The file location where this project unpacks
707 external projects
708 • TEACUP_PROFILE - The ActiveState/Teacup canonical name
710 for this platform (i.e. win32-ix86 ma‐
711 cosx10.5-i386-x86_84)
712 • TEACUP_OS - The local operating system (windows, macosx,
714 openbsd, etc). Gives the same answer as tcl.m4, except
715 that macosx is given as macosx instead of Darwin.
716 • TEA_PLATFORM - The platform returned by uname -s-uname -r
718 (on Unix), or "windows" on Windows
719 • TEACUP_ARCH - The processor architecture for the local os
721 (i.e. ix86, x86_64)
722 • TEACUP_ARCH - The processor architecture for the local os
724 (i.e. ix86, x86_64)
725 • teapot - Filesystem path where teapot package files are
727 downloaded for the current user
728 • userhome - File path to store localized preferences,
730 cache download files, etc for the current user
731 This command uses a combination of local checks with Exec, any
733 tclConfig.sh file that is resident, autoconf data where already
734 computed, and data gleaned from a file named practcl.rc in user‐
735 home. The location for userhome varies by platform and operating
736 system:
737 • Windows: ::env(LOCALAPPDATA)/Tcl
739 • Macos: ~/Library/Application Support/Tcl
741 • Other: ~/tcl
743 proc practcl::config.tcl path
745 A transparent call to ::practcl::read_configuration to preserve
746 backward compadibility with older copies of Practcl
747 proc practcl::read_configuration path
749 Detect local platform. This command looks for data gleaned by
750 autoconf or autosetup in the path specified, or perform its own
751 logic tests if neither has been run. A file named config.site
752 present in the location indicates that this project is cross
753 compiling, and the data stored in that file is used for the com‐
754 piler and linker.
755 This command looks for information from the following files, in
757 the following order:
758 • config.tcl - A file generated by autoconf/configure in
760 newer editions of TEA, encoded as a Tcl script.
761 • config.site - A file containing cross compiler informa‐
763 tion, encoded as a SH script
764 • ::env(VisualStudioVersion) - On Windows, and environmen‐
766 tal value that indicates MS Visual Studio is installed
767 This command returns a dictionary containing all of the data cleaned
769 from the sources above. In the absence of any guidance this command
770 returns the same output as ::practcl::local_os. In this mode, if the
771 environmental variable VisualStudioVersion exists, this command will
772 provide a template of fields that are appropriate for compiling on Win‐
773 dows under Microsoft Visual Studio. The USEMSVC flag in the dictionary
774 is a boolean flag to indicate if this is indeed the case.
775 proc practcl::tcllib_require pkg ?args?
777 Try to load a package, and failing that retrieve tcllib
778 proc practcl::platform::tcl_core_options os
780 Return the string to pass to ./configure to compile the Tcl core
781 for the given OS.
782 • windows: --with-tzdata --with-encoding utf-8
784 • macosx: --enable-corefoundation=yes --enable-frame‐
786 work=no --with-tzdata --with-encoding utf-8
787 • other: --with-tzdata --with-encoding utf-8
789 proc practcl::platform::tk_core_options os
791 proc practcl::read_rc_file filename ?localdat ?
793 Read a stylized key/value list stored in a file
794 proc practcl::read_sh_subst line info
796 Converts a XXX.sh file into a series of Tcl variables
797 proc practcl::read_sh_file filename ?localdat ?
799 proc practcl::read_Config.sh filename
801 A simpler form of read_sh_file tailored to pulling data from
802 (tcl|tk)Config.sh
803 proc practcl::read_Makefile filename
805 A simpler form of read_sh_file tailored to pulling data from a
806 Makefile
807 proc practcl::cputs varname ?args?
809 Append arguments to a buffer The command works like puts in that
810 each call will also insert a line feed. Unlike puts, blank links
811 in the interstitial are suppressed
812 proc practcl::tcl_to_c body
814 proc practcl::_tagblock text ?style tcl? ?note ?
816 proc practcl::de_shell data
818 proc practcl::grep pattern ?files ?
820 Search for the pattern pattern amongst $files
821 proc practcl::file_lexnormalize sp
823 proc practcl::file_relative base dst
825 Calculate a relative path between base and dst
826 Example:
828 ::practcl::file_relative ~/build/tcl/unix ~/build/tcl/library
830 > ../library
831 proc practcl::findByPattern basedir patterns
836 proc practcl::log fname comment
838 Record an event in the practcl log
839 proc practcl::_pkgindex_simpleIndex path
841 proc practcl::_pkgindex_directory path
843 Return true if the pkgindex file contains any statement other
844 than "package ifneeded" and/or if any package ifneeded loads a
845 DLL
846 proc practcl::_pkgindex_path_subdir path
848 Helper function for ::practcl::pkgindex_path
849 proc practcl::pkgindex_path ?args?
851 Index all paths given as though they will end up in the same
852 virtual file system
853 proc practcl::installDir d1 d2
855 Delete the contents of d2, and then recusively Ccopy the con‐
856 tents of d1 to d2.
857 proc practcl::copyDir d1 d2 ?toplevel 1?
859 Recursively copy the contents of d1 to d2
860 proc practcl::buildModule modpath
862 proc practcl::installModule modpath DEST
864 Install a module from MODPATH to the directory specified. dpath
865 is assumed to be the fully qualified path where module is to be
866 placed. Any existing files will be deleted at that path. If
867 the path is symlink the process will return with no error and no
868 action. If the module has contents in the build/ directory that
869 are newer than the .tcl files in the module source directory,
870 and a build/build.tcl file exists, the build/build.tcl file is
871 run. If the source directory includes a file named index.tcl,
872 the directory is assumed to be in the tao style of modules, and
873 the entire directory (and all subdirectories) are copied verba‐
874 tim. If no index.tcl file is present, all .tcl files are copied
875 from the module source directory, and a pkgIndex.tcl file is
876 generated if non yet exists. I a folder named htdocs exists in
877 the source directory, that directory is copied verbatim to the
878 destination.
879 proc practcl::trigger ?args?
881 Trigger build targets, and recompute dependencies
882 Internals:
884 ::practcl::LOCAL make trigger {*}$args
887 foreach {name obj} [::practcl::LOCAL make objects] {
888 set ::make($name) [$obj do]
889 }
890 proc practcl::depends ?args?
893 Calculate if a dependency for any of the arguments needs to be
894 fulfilled or rebuilt.
895 Internals:
897 ::practcl::LOCAL make depends {*}$args
900 proc practcl::target name info ?action ?
903 Declare a build product. This proc is just a shorthand for
904 ::practcl::LOCAL make task $name $info $action
905 Registering a build product with this command will create an en‐
907 try in the global array, and populate a value in the global
908 array.
909 Internals:
911 set obj [::practcl::LOCAL make task $name $info $action]
914 set ::make($name) 0
915 set filename [$obj define get filename]
916 if {$filename ne {}} {
917 set ::target($name) $filename
918 }
919
922 CLASS PRACTCL::DOCTOOL
923 { set authors {
924 {John Doe} {jdoe@illustrious.edu}
925 {Tom RichardHarry} {tomdickharry@illustrius.edu}
926 }
927 # Create the object
928 ::practcl::doctool create AutoDoc
929 set fout [open [file join $moddir module.tcl] w]
930 foreach file [glob [file join $srcdir *.tcl]] {
931 set content [::practcl::cat [file join $srcdir $file]]
932 # Scan the file
933 AutoDoc scan_text $content
934 # Strip the comments from the distribution
935 puts $fout [::practcl::docstrip $content]
936 }
937 # Write out the manual page
938 set manout [open [file join $moddir module.man] w]
939 dict set args header [string map $modmap [::practcl::cat [file join $srcdir manual.txt]]]
940 dict set args footer [string map $modmap [::practcl::cat [file join $srcdir footer.txt]]]
941 dict set args authors $authors
942 puts $manout [AutoDoc manpage {*}$args]
943 close $manout
944 }
947 Tool for build scripts to dynamically generate manual files from com‐
949 ments in source code files
950 Methods
952 method constructor
954 method argspec argspec
956 Process an argument list into an informational dict. This
957 method also understands non-positional arguments expressed in
958 the notation of Tip 471 https://core.tcl-
959 lang.org/tips/doc/trunk/tip/479.md.
960 The output will be a dictionary of all of the fields and whether
962 the fields are positional, mandatory, and whether they have a
963 default value.
964 Example:
967 my argspec {a b {c 10}}
969 > a {positional 1 mandatory 1} b {positional 1 mandatory 1} c {positional 1 mandatory 0 default 10}
971 method comment block
976 Convert a block of comments into an informational dictionary.
977 If lines in the comment start with a single word ending in a
978 colon, all subsequent lines are appended to a dictionary field
979 of that name. If no fields are given, all of the text is ap‐
980 pended to the description field.
981 Example:
983 my comment {Does something cool}
985 > description {Does something cool}
986 my comment {
988 title : Something really cool
989 author : Sean Woods
990 author : John Doe
991 description :
992 This does something really cool!
993 }
994 > description {This does something really cool!}
995 title {Something really cool}
996 author {Sean Woods
997 John Doe}
998 method keyword.Annotation resultvar commentblock type name body
1003 method keyword.Class resultvar commentblock name body
1005 Process an oo::objdefine call that modifies the class object it‐
1006 self
1007 method keyword.class resultvar commentblock name body
1009 Process an oo::define, clay::define, etc statement.
1010 method keyword.Class_Method resultvar commentblock name ?args?
1012 Process a statement for a clay style class method
1013 method keyword.method resultvar commentblock name ?args?
1015 Process a statement for a tcloo style object method
1016 method keyword.proc commentblock name argspec
1018 Process a proc statement
1019 method reset
1021 Reset the state of the object and its embedded coroutine
1022 method Main
1024 Main body of the embedded coroutine for the object
1025 method section.method keyword method minfo
1027 Generate the manual page text for a method or proc
1028 method section.annotation type name iinfo
1030 method section.class class_name class_info
1032 Generate the manual page text for a class
1033 method section.command procinfo
1035 Generate the manual page text for the commands section
1036 method manpage ?header value? ?footer value? ?authors list?
1038 Generate the manual page. Returns the completed text suitable
1039 for saving in .man file. The header argument is a block of doc‐
1040 tools text to go in before the machine generated section. footer
1041 is a block of doctools text to go in after the machine generated
1042 section. authors is a list of individual authors and emails in
1043 the form of AUTHOR EMAIL ?AUTHOR EMAIL?...
1044 method scan_text text
1046 Scan a block of text
1047 method scan_file filename
1049 Scan a file of text
1050 CLASS PRACTCL::METACLASS
1052 The metaclass for all practcl objects
1053 Methods
1055 method _MorphPatterns
1057 method define submethod ?args?
1059 method graft ?args?
1061 method initialize
1063 method link command ?args?
1065 method morph classname
1067 method script script
1069 method select
1071 method source filename
1073 CLASS PRACTCL::TOOLSET
1075 Ancestor-less class intended to be a mixin which defines a family of
1076 build related behaviors that are modified when targetting either gcc or
1077 msvc
1078 Class Methods
1080 classmethod select object
1082 Perform the selection for the toolset mixin
1083 Methods
1085 method config.sh
1087 find or fake a key/value list describing this project
1088 method BuildDir PWD
1090 Compute the location where the product will be built
1091 method MakeDir srcdir
1093 Return where the Makefile is located relative to srcdir. For
1094 this implementation the MakeDir is always srcdir.
1095 method read_configuration
1097 Read information about the build process for this package. For
1098 this implementation, data is sought in the following locations
1099 in the following order: config.tcl (generated by practcl.) PKG‐
1100 Config.sh. The Makefile
1101 If the Makefile needs to be consulted, but does not exist, the
1103 Configure method is invoked
1104 method build-cflags PROJECT DEFS namevar versionvar defsvar
1106 method DEFS This method populates 4 variables: name - The name
1107 of the package version - The version of the package defs - C
1108 flags passed to the compiler includedir - A list of paths to
1109 feed to the compiler for finding headers
1110 method critcl ?args?
1112 Invoke critcl in an external process
1113 CLASS PRACTCL::TOOLSET.GCC
1115 ancestors: practcl::toolset
1116 Methods
1118 method Autoconf
1120 method BuildDir PWD
1122 method ConfigureOpts
1124 method MakeDir srcdir
1126 Detect what directory contains the Makefile template
1127 method make {} autodetect
1129 method make {} clean
1131 method make {} compile
1133 method make {} install DEST
1135 method build-compile-sources PROJECT COMPILE CPPCOMPILE INCLUDES
1137 method build-Makefile path PROJECT
1139 method build-library outfile PROJECT
1141 Produce a static or dynamic library
1142 method build-tclsh outfile PROJECT ?path auto?
1144 Produce a static executable
1145 CLASS PRACTCL::TOOLSET.MSVC
1147 ancestors: practcl::toolset
1148 Methods
1150 method BuildDir PWD
1152 MSVC always builds in the source directory
1153 method make {} autodetect
1155 Do nothing
1156 method make {} clean
1158 method make {} compile
1160 method make {} install DEST
1162 method MakeDir srcdir
1164 Detect what directory contains the Makefile template
1165 method NmakeOpts
1167 CLASS PRACTCL::MAKE_OBJ
1169 ancestors: practcl::metaclass
1170 A build deliverable object. Normally an object file, header, or tcl
1172 script which must be compiled or generated in some way
1173 Methods
1175 method constructor module_object name info ?action_body ?
1177 method do
1179 method check
1181 method output
1183 method reset
1185 method triggers
1187 CLASS PRACTCL::OBJECT
1189 ancestors: practcl::metaclass
1190 A generic Practcl object
1192 Methods
1194 method constructor parent ?args?
1196 method child method
1198 method go
1200 CLASS PRACTCL::DYNAMIC
1202 Dynamic blocks do not generate their own .c files, instead the contrib‐
1203 ute to the amalgamation of the main library file
1204 Methods
1206 method cstructure name definition ?argdat ?
1208 Parser functions
1209 method include header
1211 method include_dir ?args?
1213 method include_directory ?args?
1215 method c_header body
1217 method c_code body
1219 method c_function header body ?info ?
1221 method c_tcloomethod name body ?arginfo ?
1223 method cmethod name body ?arginfo ?
1225 Alias to classic name
1226 method c_tclproc_nspace nspace
1228 method c_tclcmd name body ?arginfo ?
1230 method c_tclproc_raw name body ?arginfo ?
1232 Alias to classic name
1233 method tcltype name argdat
1235 method project-compile-products
1237 Module interactions
1238 method implement path
1240 method initialize
1242 Practcl internals
1243 method linktype
1245 method generate-cfile-constant
1247 method generate-cfile-header
1249 method generate-cfile-tclapi
1251 Generate code that provides implements Tcl API calls
1252 method generate-loader-module
1254 Generate code that runs when the package/module is initialized
1255 into the interpreter
1256 method Collate_Source CWD
1258 method select
1260 Once an object marks itself as some flavor of dynamic, stop try‐
1261 ing to morph it into something else
1262 CLASS PRACTCL::PRODUCT
1264 A deliverable for the build system
1265 Class Methods
1267 classmethod select object
1269 Methods
1271 method code section body
1273 method Collate_Source CWD
1275 method project-compile-products
1277 method generate-debug ?spaces ?
1279 method generate-cfile-constant
1281 method generate-cfile-public-structure
1283 Populate const static data structures
1284 method generate-cfile-header
1286 method generate-cfile-global
1288 method generate-cfile-private-typedef
1290 method generate-cfile-private-structure
1292 method generate-cfile-functions
1294 Generate code that provides subroutines called by Tcl API meth‐
1295 ods
1296 method generate-cfile-tclapi
1298 Generate code that provides implements Tcl API calls
1299 method generate-hfile-public-define
1301 method generate-hfile-public-macro
1303 method generate-hfile-public-typedef
1305 method generate-hfile-public-structure
1307 method generate-hfile-public-headers
1309 method generate-hfile-public-function
1311 method generate-hfile-public-includes
1313 method generate-hfile-public-verbatim
1315 method generate-loader-external
1317 method generate-loader-module
1319 method generate-stub-function
1321 method IncludeAdd headervar ?args?
1323 method generate-tcl-loader
1325 method generate-tcl-pre
1327 This methods generates any Tcl script file which is required to
1328 pre-initialize the C library
1329 method generate-tcl-post
1331 method linktype
1333 method Ofile filename
1335 method project-static-packages
1337 Methods called by the master project
1338 method toolset-include-directory
1340 Methods called by the toolset
1341 method target method ?args?
1343 CLASS PRACTCL::PRODUCT.CHEADER
1345 ancestors: practcl::product
1346 A product which generated from a C header file. Which is to say, noth‐
1348 ing.
1349 Methods
1351 method project-compile-products
1353 method generate-loader-module
1355 CLASS PRACTCL::PRODUCT.CSOURCE
1357 ancestors: practcl::product
1358 A product which generated from a C source file. Normally an object (.o)
1360 file.
1361 Methods
1363 method project-compile-products
1365 CLASS PRACTCL::PRODUCT.CLIBRARY
1367 ancestors: practcl::product
1368 A product which is generated from a compiled C library. Usually a .a
1370 or a .dylib file, but in complex cases may actually just be a conduit
1371 for one project to integrate the source code of another
1372 Methods
1374 method linker-products configdict
1376 CLASS PRACTCL::PRODUCT.DYNAMIC
1378 ancestors: practcl::dynamic practcl::product
1379 A product which is generated from C code that itself is generated by
1381 practcl or some other means. This C file may or may not produce its own
1382 .o file, depending on whether it is eligible to become part of an amal‐
1383 gamation
1384 Methods
1386 method initialize
1388 CLASS PRACTCL::PRODUCT.CRITCL
1390 ancestors: practcl::dynamic practcl::product
1391 A binary product produced by critcl. Note: The implementation is not
1393 written yet, this class does nothing.
1394 CLASS PRACTCL::MODULE
1396 ancestors: practcl::object practcl::product.dynamic
1397 In the end, all C code must be loaded into a module This will either be
1399 a dynamically loaded library implementing a tcl extension, or a com‐
1400 piled in segment of a custom shell/app
1401 Variable
1403 variable make_object
1405 Methods
1407 method _MorphPatterns
1409 method add ?args?
1411 method install-headers ?args?
1413 method make {} _preamble
1415 method make {} pkginfo
1417 method make {} objects
1419 Return a dictionary of all handles and associated objects
1420 method make {} object name
1422 Return the object associated with handle name
1423 method make {} reset
1425 Reset all deputy objects
1426 method make {} trigger ?args?
1428 Exercise the triggers method for all handles listed
1429 method make {} depends ?args?
1431 Exercise the check method for all handles listed
1432 method make {} filename name
1434 Return the file name of the build product for the listed handle
1435 method make {} target name Info body
1437 method make {} todo
1439 Return a list of handles for object which return true for the do
1440 method
1441 method make {} do
1443 For each target exercise the action specified in the action def‐
1444 inition if the do method returns true
1445 method child which
1447 method generate-c
1449 This methods generates the contents of an amalgamated .c file
1450 which implements the loader for a batch of tools
1451 method generate-h
1453 This methods generates the contents of an amalgamated .h file
1454 which describes the public API of this module
1455 method generate-loader
1457 method initialize
1459 method implement path
1461 method linktype
1463 CLASS PRACTCL::PROJECT
1465 ancestors: practcl::module
1466 A toplevel project that is a collection of other projects
1468 Methods
1470 method _MorphPatterns
1472 method constructor ?args?
1474 method add_object object
1476 method add_project pkg info ?oodefine ?
1478 method add_tool pkg info ?oodefine ?
1480 method build-tclcore
1482 Compile the Tcl core. If the define tk is true, compile the Tk
1483 core as well
1484 method child which
1486 method linktype
1488 method project pkg ?args?
1490 Exercise the methods of a sub-object
1491 method tclcore
1493 method tkcore
1495 method tool pkg ?args?
1497 CLASS PRACTCL::LIBRARY
1499 ancestors: practcl::project
1500 A toplevel project that produces a library
1502 Methods
1504 method clean PATH
1506 method project-compile-products
1508 method go
1510 method generate-decls pkgname path
1512 method implement path
1514 method generate-make path
1516 Backward compadible call
1517 method linktype
1519 method package-ifneeded ?args?
1521 Create a "package ifneeded" Args are a list of aliases for which
1522 this package will answer to
1523 method shared_library ?filename ?
1525 method static_library ?filename ?
1527 CLASS PRACTCL::TCLKIT
1529 ancestors: practcl::library
1530 A toplevel project that produces a self-contained executable
1532 Methods
1534 method build-tclkit_main PROJECT PKG_OBJS
1536 method Collate_Source CWD
1538 method wrap PWD exename vfspath ?args?
1540 Wrap an executable
1541 CLASS PRACTCL::DISTRIBUTION
1543 Standalone class to manage code distribution This class is intended to
1544 be mixed into another class (Thus the lack of ancestors)
1545 Class Methods
1547 classmethod Sandbox object
1549 classmethod select object
1551 classmethod claim_option
1553 classmethod claim_object object
1555 classmethod claim_path path
1557 Methods
1559 method scm_info
1561 method DistroMixIn
1563 method Sandbox
1565 method SrcDir
1567 method ScmTag
1569 method ScmClone
1571 method ScmUnpack
1573 method ScmUpdate
1575 method Unpack
1577 CLASS PRACTCL::DISTRIBUTION.SNAPSHOT
1579 ancestors: practcl::distribution
1580 A file distribution from zip, tarball, or other non-scm archive format
1582 Class Methods
1584 classmethod claim_object object
1586 classmethod claim_option
1588 classmethod claim_path path
1590 Methods
1592 method ScmUnpack
1594 CLASS PRACTCL::DISTRIBUTION.FOSSIL
1596 ancestors: practcl::distribution
1597 A file distribution based on fossil
1599 Class Methods
1601 classmethod claim_object obj
1603 Check for markers in the metadata
1604 classmethod claim_option
1606 classmethod claim_path path
1608 Check for markers in the source root
1609 Methods
1611 method scm_info
1613 method ScmClone
1615 Clone the source
1616 method ScmTag
1618 method ScmUnpack
1620 method ScmUpdate
1622 CLASS PRACTCL::DISTRIBUTION.GIT
1624 ancestors: practcl::distribution
1625 A file distribution based on git
1627 Class Methods
1629 classmethod claim_object obj
1631 classmethod claim_option
1633 classmethod claim_path path
1635 Methods
1637 method ScmTag
1639 method ScmUnpack
1641 method ScmUpdate
1643 CLASS PRACTCL::SUBPROJECT
1645 ancestors: practcl::module
1646 A subordinate project
1648 Methods
1650 method _MorphPatterns
1652 method BuildDir PWD
1654 method child which
1656 method compile
1658 method go
1660 method install ?args?
1662 Install project into the local build system
1663 method linktype
1665 method linker-products configdict
1667 method linker-external configdict
1669 method linker-extra configdict
1671 method env-bootstrap
1673 Methods for packages/tools that can be downloaded possibly built
1674 and used internally by this Practcl process Load the facility
1675 into the interpreter
1676 method env-exec
1678 Return a file path that exec can call
1679 method env-install
1681 Install the tool into the local environment
1682 method env-load
1684 Do whatever is necessary to get the tool into the local environ‐
1685 ment
1686 method env-present
1688 Check if tool is available for load/already loaded
1689 method sources
1691 method update
1693 method unpack
1695 CLASS PRACTCL::SUBPROJECT.SOURCE
1697 ancestors: practcl::subproject practcl::library
1698 A project which the kit compiles and integrates the source for itself
1700 Methods
1702 method env-bootstrap
1704 method env-present
1706 method linktype
1708 CLASS PRACTCL::SUBPROJECT.TEAPOT
1710 ancestors: practcl::subproject
1711 a copy from the teapot
1713 Methods
1715 method env-bootstrap
1717 method env-install
1719 method env-present
1721 method install DEST
1723 CLASS PRACTCL::SUBPROJECT.KETTLE
1725 ancestors: practcl::subproject
1726 Methods
1728 method kettle path ?args?
1730 method install DEST
1732 CLASS PRACTCL::SUBPROJECT.CRITCL
1734 ancestors: practcl::subproject
1735 Methods
1737 method install DEST
1739 CLASS PRACTCL::SUBPROJECT.SAK
1741 ancestors: practcl::subproject
1742 Methods
1744 method env-bootstrap
1746 method env-install
1748 method env-present
1750 method install DEST
1752 method install-module DEST ?args?
1754 CLASS PRACTCL::SUBPROJECT.PRACTCL
1756 ancestors: practcl::subproject
1757 Methods
1759 method env-bootstrap
1761 method env-install
1763 method install DEST
1765 method install-module DEST ?args?
1767 CLASS PRACTCL::SUBPROJECT.BINARY
1769 ancestors: practcl::subproject
1770 A subordinate binary package
1772 Methods
1774 method clean
1776 method env-install
1778 method project-compile-products
1780 method ComputeInstall
1782 method go
1784 method linker-products configdict
1786 method project-static-packages
1788 method BuildDir PWD
1790 method compile
1792 method Configure
1794 method install DEST
1796 CLASS PRACTCL::SUBPROJECT.TEA
1798 ancestors: practcl::subproject.binary
1799 A subordinate TEA based binary package
1801 CLASS PRACTCL::SUBPROJECT.LIBRARY
1803 ancestors: practcl::subproject.binary practcl::library
1804 A subordinate C library built by this project
1806 Methods
1808 method install DEST
1810 CLASS PRACTCL::SUBPROJECT.EXTERNAL
1812 ancestors: practcl::subproject.binary
1813 A subordinate external C library
1815 Methods
1817 method install DEST
1819 CLASS PRACTCL::SUBPROJECT.CORE
1821 ancestors: practcl::subproject.binary
1822 Methods
1824 method env-bootstrap
1826 method env-present
1828 method env-install
1830 method go
1832 method linktype
1834
1836 This document, and the package it describes, will undoubtedly contain
1837 bugs and other problems. Please report such in the category practcl of
1838 the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please
1839 also report any ideas for enhancements you may have for either package
1840 and/or documentation.
1841 When proposing code changes, please provide unified diffs, i.e the out‐
1843 put of diff -u.
1844 Note further that attachments are strongly preferred over inlined
1846 patches. Attachments can be made by going to the Edit form of the
1847 ticket immediately after its creation, and then using the left-most
1848 button in the secondary navigation bar.
1849
1851 practcl
1852
1854 TclOO
1855
1857 Copyright (c) 2016-2018 Sean Woods <yoda@etoyoc.com>
1858tcllib 0.16.4 practcl(n)