'\" '\" Generated from file 'critcl_bitmap\&.man' by tcllib/doctools with format 'nroff' '\" Copyright (c) 2011-2018 Andreas Kupries '\" .TH "critcl::bitmap" 3tcl 1\&.0\&.1 doc "C Runtime In Tcl (CriTcl)" .\" The -*- nroff -*- definitions below are for supplemental macros used .\" in Tcl/Tk manual entries. .\" .\" .AP type name in/out ?indent? .\" Start paragraph describing an argument to a library procedure. .\" type is type of argument (int, etc.), in/out is either "in", "out", .\" or "in/out" to describe whether procedure reads or modifies arg, .\" and indent is equivalent to second arg of .IP (shouldn't ever be .\" needed; use .AS below instead) .\" .\" .AS ?type? ?name? .\" Give maximum sizes of arguments for setting tab stops. Type and .\" name are examples of largest possible arguments that will be passed .\" to .AP later. If args are omitted, default tab stops are used. .\" .\" .BS .\" Start box enclosure. From here until next .BE, everything will be .\" enclosed in one large box. .\" .\" .BE .\" End of box enclosure. .\" .\" .CS .\" Begin code excerpt. .\" .\" .CE .\" End code excerpt. .\" .\" .VS ?version? ?br? .\" Begin vertical sidebar, for use in marking newly-changed parts .\" of man pages. The first argument is ignored and used for recording .\" the version when the .VS was added, so that the sidebars can be .\" found and removed when they reach a certain age. If another argument .\" is present, then a line break is forced before starting the sidebar. .\" .\" .VE .\" End of vertical sidebar. .\" .\" .DS .\" Begin an indented unfilled display. .\" .\" .DE .\" End of indented unfilled display. .\" .\" .SO ?manpage? .\" Start of list of standard options for a Tk widget. The manpage .\" argument defines where to look up the standard options; if .\" omitted, defaults to "options". The options follow on successive .\" lines, in three columns separated by tabs. .\" .\" .SE .\" End of list of standard options for a Tk widget. .\" .\" .OP cmdName dbName dbClass .\" Start of description of a specific option. cmdName gives the .\" option's name as specified in the class command, dbName gives .\" the option's name in the option database, and dbClass gives .\" the option's class in the option database. .\" .\" .UL arg1 arg2 .\" Print arg1 underlined, then print arg2 normally. .\" .\" .QW arg1 ?arg2? .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). .\" .\" .PQ arg1 ?arg2? .\" Print an open parenthesis, arg1 in quotes, then arg2 normally .\" (for trailing punctuation) and then a closing parenthesis. .\" .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b .\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ . ie !"\\$2"" .TP \\n()Cu . el .TP 15 .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ \&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ .br .ie !"\\$2"" \{\ \&\\$1 \\fI\\$2\\fP .\} .el \{\ \&\\fI\\$1\\fP .\} .\} .. .\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out .\" # BS - start boxed text .\" # ^y = starting y location .\" # ^b = 1 .de BS .br .mk ^y .nr ^b 1u .if n .nf .if n .ti 0 .if n \l'\\n(.lu\(ul' .if n .fi .. .\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 .mk ^t .ie n \l'\\n(^lu\(ul' .el \{\ .\" Draw four-sided box normally, but don't draw top of .\" box if the box started on an earlier page. .ie !\\n(^b-1 \{\ \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .el \}\ \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' .\} .\} .fi .br .nr ^b 0 .. .\" # VS - start vertical sidebar .\" # ^Y = starting y location .\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. .\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ .ev 2 .nf .ti 0 .mk ^t \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' .sp -1 .fi .ev .\} .nr ^v 0 .. .\" # Special macro to handle page bottom: finish off current .\" # box/sidebar if in box/sidebar mode, then invoked standard .\" # page bottom macro. .de ^B .ev 2 'ti 0 'nf .mk ^t .if \\n(^b \{\ .\" Draw three-sided box if this is the box's first page, .\" draw two sides but no top otherwise. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c .\} .if \\n(^v \{\ .nr ^x \\n(^tu+1v-\\n(^Yu \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c .\} .bp 'fi .ev .if \\n(^b \{\ .mk ^y .nr ^b 2 .\} .if \\n(^v \{\ .mk ^Y .\} .. .\" # DS - begin display .de DS .RS .nf .sp .. .\" # DE - end display .de DE .fi .RE .sp .. .\" # SO - start of list of standard options .de SO 'ie '\\$1'' .ds So \\fBoptions\\fR 'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf .ta 5.5c 11c .ft B .. .\" # SE - end of list of standard options .de SE .fi .ft R .LP See the \\*(So manual entry for details on the standard options. .. .\" # OP - start of full description for a single option .de OP .LP .nf .ta 4c Command-Line Name: \\fB\\$1\\fR Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi .IP .. .\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. .\" # CE - end code excerpt .de CE .fi .RE .. .\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. .\" # QW - apply quotation marks to word .de QW .ie '\\*(lq'"' ``\\$1''\\$2 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\$2 .. .\" # PQ - apply parens and quotation marks to word .de PQ .ie '\\*(lq'"' (``\\$1''\\$2)\\$3 .\"" fix emacs highlighting .el (\\*(lq\\$1\\*(rq\\$2)\\$3 .. .\" # QR - quoted range .de QR .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 .\"" fix emacs highlighting .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 .. .\" # MT - "empty" string .de MT .QW "" .. .BS .SH NAME critcl::bitmap \- CriTcl Utilities: Bitset en- and decoding .SH SYNOPSIS package require \fBTcl 8\&.4\fR .sp package require \fBcritcl ?3\&.1\&.11?\fR .sp package require \fBcritcl::bitmap ?1\&.0\&.1?\fR .sp \fB::critcl::bitmap::def\fR \fIname\fR \fIdefinition\fR ?\fIexclusions\fR? .sp .BE .SH DESCRIPTION .PP \fIC Runtime In Tcl\fR, or \fICriTcl\fR , is a system for compiling C code embedded in Tcl on the fly and either loading the resulting objects into Tcl for immediate use or packaging them for distribution\&. Use \fICriTcl\fR to improve performance by rewriting in C those routines that are performance bottlenecks\&. .PP This document is the reference manpage for the \fBcritcl::bitmap\fR package\&. This package provides convenience commands for advanced functionality built on top of both critcl core and package \fBcritcl::iassoc\fR\&. .PP C level libraries often use bit-sets to encode many flags into a single value\&. Tcl bindings to such libraries now have the task of converting a Tcl representation of such flags (like a list of strings) into such bit-sets, and back\&. \fINote\fR here that the C-level information has to be something which already exists\&. The package does \fInot\fR create these values\&. This is in contrast to the package \fBcritcl::enum\fR which creates an enumeration based on the specified symbolic names\&. .PP This package was written to make the declaration and management of such bit-sets and their associated conversions functions easy, hiding all attendant complexity from the user\&. .PP Its intended audience are mainly developers wishing to write Tcl packages with embedded C code\&. .PP This package resides in the Core Package Layer of CriTcl\&. .PP .PS .nf +----------------+ |Applications | | critcl | | critcl::app | +----------------+ *================* |Core Packages | | critcl | | critcl::util | *================* +----------------+ |Support Packages| | stubs::* | | md5, platform | | \&.\&.\&. | +----------------+ .fi .PE .PP .SH API .TP \fB::critcl::bitmap::def\fR \fIname\fR \fIdefinition\fR ?\fIexclusions\fR? This command defines two C functions for the conversion of the \fIname\fRd bit-set into Tcl lists, and vice versa\&. The underlying mapping tables are automatically initialized on first access, and finalized on interpreter destruction\&. .sp The \fIdefinition\fR dictionary provides the mapping from the Tcl-level symbolic names of the flags to their C expressions (often the name of the macro specifying the actual value)\&. \fINote\fR here that the C-level information has to be something which already exists\&. The package does \fInot\fR create these values\&. This is in contrast to the package \fBcritcl::enum\fR which creates an enumeration based on the specified symbolic names\&. .sp The optional \fIexlusion\fR list is for the flags/bit-sets for which conversion from bit-set to flag, i\&.e\&. decoding makes no sense\&. One case for such, for example, are flags representing a combination of other flags\&. .sp The package generates multiple things (declarations and definitions) with names derived from \fIname\fR, which has to be a proper C identifier\&. .RS .TP \fIname\fR_encode The function for encoding a Tcl list of strings into the equivalent bit-set\&. Its signature is .sp .CS int \fIname\fR_encode (Tcl_Interp* interp, Tcl_Obj* flags, int* result); .CE .sp The return value of the function is a Tcl error code, i\&.e\&. \fBTCL_OK\fR, \fBTCL_ERROR\fR, etc\&. .TP \fIname\fR_decode The function for decoding a bit-set into the equivalent Tcl list of strings\&. Its signature is .sp .CS Tcl_Obj* \fIname\fR_decode (Tcl_Interp* interp, int flags); .CE .TP \fIname\fR\&.h A header file containing the declarations for the two conversion functions, for use by other parts of the system, if necessary\&. .sp The generated file is stored in a place where it will not interfere with the overall system outside of the package, yet also be available for easy inclusion by package files (\fBcsources\fR)\&. .TP \fIname\fR The name of a critcl argument type encapsulating the encoder function for use by \fBcritcl::cproc\fR\&. .TP \fIname\fR The name of a critcl result type encapsulating the decoder function for use by \fBcritcl::cproc\fR\&. .RE .PP .SH EXAMPLE The example shown below is the specification of the event flags pulled from the draft work on a Tcl binding to Linux's inotify APIs\&. .CS package require Tcl 8\&.5 package require critcl 3\&.1\&.11 critcl::buildrequirement { package require critcl::bitmap } critcl::bitmap::def tcl_inotify_events { accessed IN_ACCESS all IN_ALL_EVENTS attribute IN_ATTRIB closed IN_CLOSE closed-nowrite IN_CLOSE_NOWRITE closed-write IN_CLOSE_WRITE created IN_CREATE deleted IN_DELETE deleted-self IN_DELETE_SELF dir-only IN_ONLYDIR dont-follow IN_DONT_FOLLOW modified IN_MODIFY move IN_MOVE moved-from IN_MOVED_FROM moved-self IN_MOVE_SELF moved-to IN_MOVED_TO oneshot IN_ONESHOT open IN_OPEN overflow IN_Q_OVERFLOW unmount IN_UNMOUNT } { all closed move oneshot } # Declarations: tcl_inotify_events\&.h # Encoder: int tcl_inotify_events_encode (Tcl_Interp* interp, Tcl_Obj* flags, int* result); # Decoder: Tcl_Obj* tcl_inotify_events_decode (Tcl_Interp* interp, int flags); # crit arg-type tcl_inotify_events # crit res-type tcl_inotify_events .CE .SH AUTHORS Andreas Kupries .SH "BUGS, IDEAS, FEEDBACK" This document, and the package it describes, will undoubtedly contain bugs and other problems\&. Please report such at \fIhttps://github\&.com/andreas-kupries/critcl\fR\&. Please also report any ideas for enhancements you may have for either package and/or documentation\&. .SH KEYWORDS C code, Embedded C Code, Tcl Interp Association, bitmask, bitset, code generator, compile & run, compiler, dynamic code generation, dynamic compilation, flags, generate package, linker, on demand compilation, on-the-fly compilation, singleton .SH CATEGORY Glueing/Embedded C code .SH COPYRIGHT .nf Copyright (c) 2011-2018 Andreas Kupries .fi