Pregenerated C API documentation. --- /dev/null +++ b/doc/capi/html/Trf_CheckOptions.html @@ -0,0 +1,108 @@ + +Trf_CheckOptions - Interface to procedures to check an option container. + + +

NAME

+Trf_CheckOptions - Interface to procedures to check an option container. +

SYNOPSIS

#include <transform.h>
+
+int Trf_CheckOptions
+(
+	Trf_Options options,
+	Tcl_Interp *interp,
+	const Trf_BaseOptions *baseOptions,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_Options options: +Container with options to check. +
+Tcl_Interp *interp: +Interpreter to write error +messages to (NULL possible!). +
+const Trf_BaseOptions *baseOptions: +Info about common options. +
+ClientData clientData: +Arbitrary information, as defined +in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+The procedure has to check the contents of the specified +container for errors, consistency, etc. It is allowed to +set default values into unspecified slots. Return value +is a standard tcl error code. In case of failure and interp +not NULL an error message should be left in the result area +of the specified interpreter. +

NAME

+Trf_ClearCtrlBlock - Interface for procedures to reset the internal state of an encoder/decoder. +

SYNOPSIS

#include <transform.h>
+
+void Trf_ClearCtrlBlock
+(
+	Trf_ControlBlock ctrlBlock,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_ControlBlock ctrlBlock: +State of +encoder/decoder. +
+ClientData clientData: +Arbitrary +information, +as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+The generic io layer of tcl sometimes discards its input buffer. A procedure +of this type will be called in such a case to reset the internal state of +the control structure and to discard buffered characters. +

NAME

+Trf_ConverterOptions - Return the set of option processing procedures required by conversion transformers. +

SYNOPSIS

#include <transform.h>
+
+Trf_OptionVectors *Trf_ConverterOptions(void);
+

DESCRIPTION

+Return the set of option processing procedures required by conversion transformers. +

NAME

+Trf_CreateCtrlBlock - Interface to procedure for creation of encoder/decoder control structures. +

SYNOPSIS

#include <transform.h>
+
+Trf_ControlBlock Trf_CreateCtrlBlock
+(
+	ClientData writeClientData,
+	Trf_WriteProc *fun,
+	Trf_Options optInfo,
+	Tcl_Interp *interp,
+	ClientData clientData
+);
+

PARAMETERS

+ClientData writeClientData: +Arbitrary information +given as clientdata +to 'fun'. +
+Trf_WriteProc *fun: +Vector to use for writing +generated results. +
+Trf_Options optInfo: +Options to configure the +control. +
+Tcl_Interp *interp: +Interpreter for error +messages. +
+ClientData clientData: +Arbitrary information, +as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+The procedure has to create a control structure for an encoder/decoder. The +structure must be initialized with the contents of the the option +container. Return value is an opaque handle aof the control structure or NULL +in case of failure. An error message should be left in the result area +of the specified interpreter then. +

NAME

+Trf_CreateOptions - Interface to procedures to create a container holding option values. +

SYNOPSIS

#include <transform.h>
+
+Trf_Options Trf_CreateOptions(ClientData clientData);
+

PARAMETERS

+ClientData clientData: +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+It is the responsibility of the procedure to create and +initialize a container to hold option values. An opaque +handle to the new container has to be returned. +

NAME

+Trf_DeleteCtrlBlock - Interface to procedure for destruction of encoder/decoder control structures. +

SYNOPSIS

#include <transform.h>
+
+void Trf_DeleteCtrlBlock
+(
+	Trf_ControlBlock ctrlBlock,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_ControlBlock ctrlBlock: +Control structure to destroy. +
+ClientData clientData: +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+It is the responsibility of the procedure to clear and release all memory +associated to the specified control structure (which must have been created +by the appropriate procedure of type 'Trf_CreateCtrlBlock'). +

NAME

+Trf_DeleteOptions - Interface to proceduress to delete a container made with 'Trf_CreateOptions'. +

SYNOPSIS

#include <transform.h>
+
+void Trf_DeleteOptions
+(
+	Trf_Options options,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_Options options: +The container to destroy. +
+ClientData clientData: +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+It is the responsibility of this procedure to clear and release +all memory of the specified container (which must have been +created by the corresponding procedure of type 'Trf_CreateOptions'). +

NAME

+Trf_FlipRegisterLong - Swap the bytes of all 4-byte words contained in the buffer. +

SYNOPSIS

#include <transform.h>
+
+void Trf_FlipRegisterLong
+(
+	void *buffer,
+	int length
+);
+

PARAMETERS

+void *buffer: +Data to swap. +
+int length: +Length of buffer (in byte). +

DESCRIPTION

+Swap the bytes of all 4-byte words contained in the buffer. +

NAME

+Trf_FlipRegisterShort - Swap the bytes of all 2-byte words contained in the buffer. +

SYNOPSIS

#include <transform.h>
+
+void Trf_FlipRegisterShort
+(
+	void *buffer,
+	int length
+);
+

PARAMETERS

+void *buffer: +Data to swap. +
+int length: +Length of buffer (in byte). +

DESCRIPTION

+Swap the bytes of all 2-byte words contained in the buffer. +

NAME

+Trf_FlushTransformation - Interface to procedures used to flush buffered characters. +

SYNOPSIS

#include <transform.h>
+
+int Trf_FlushTransformation
+(
+	Trf_ControlBlock ctrlBlock,
+	Tcl_Interp *interp,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_ControlBlock ctrlBlock: +State of encoder/decoder. +
+Tcl_Interp *interp: +Interpreter for error messages +(NULL posssible). +
+ClientData clientData: +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+An encoder/decoder is allowed to buffer characters internally. A procedure +of this type is called just before destruction to invoke special processing +of such characters. Return value is a standard tcl error code. In case of +failure and interp not NULL an error message should be left in the result +area of the specified interpreter. +

NAME

+Trf_Init - Initialize extension in standard interpreter. +

SYNOPSIS

#include <transform.h>
+
+int Trf_Init(Tcl_Interp *interp);
+

PARAMETERS

+Tcl_Interp *interp: +Interpreter to initialize. +

DESCRIPTION

+Extends the interpreter with extension-specific +structures and installs the globally visible +command of Tcl-TRF. Will catch attempts for +multiple initialization of an interpreter. +

NAME

+Trf_InitStubs - Convenience declaration of Trf_InitStubs. +

SYNOPSIS

#include <transform.h>
+
+extern char *Trf_InitStubs
+(
+	Tcl_Interp *interp,
+	const char *version,
+	int exact
+);
+

PARAMETERS

+Tcl_Interp *interp: +Not Documented. +
+const char *version: +Not Documented. +
+int exact: +Not Documented. +

DESCRIPTION

+This function is not *implemented* by the trf library, so the storage +class is neither DLLEXPORT nor DLLIMPORT. +

NAME

+Trf_IsInitialized - Check initialization state of specified interpreter. +

SYNOPSIS

#include <transform.h>
+
+int Trf_IsInitialized(Tcl_Interp *interp);
+

PARAMETERS

+Tcl_Interp *interp: +Interpreter to check for initialization. +

DESCRIPTION

+Check, wether this extension was initialized for the +specified interpreter or not. +

NAME

+Trf_LoadLibrary - General purpose library loader functionality. +

SYNOPSIS

#include <transform.h>
+
+int Trf_LoadLibrary
+(
+	Tcl_Interp *interp,
+	const char *libName,
+	void **handlePtr,
+	char **symbols,
+	int num
+);
+

PARAMETERS

+Tcl_Interp *interp: +Not Documented. +
+const char *libName: +Not Documented. +
+void **handlePtr: +Not Documented. +
+char **symbols: +Not Documented. +
+int num: +Not Documented. +

DESCRIPTION

+Used by -> TrfLoadZlib, -> TrfLoadLibdes. +

NAME

+Trf_MDCheck - Interface to procedures for check/manipulation of the environment (shared libraries, ...). +

SYNOPSIS

#include <transform.h>
+
+int Trf_MDCheck(Tcl_Interp *interp);
+

PARAMETERS

+Tcl_Interp *interp: +The interpreter for error messages. +

DESCRIPTION

+A procedure of this type is called before doing any sort of processing. +

NAME

+Trf_MDFinal - Interface to procedures for generation of the final digest from a MD state. +

SYNOPSIS

#include <transform.h>
+
+void Trf_MDFinal
+(
+	void *context,
+	void *digest
+);
+

PARAMETERS

+void *context: +State to finalize. +
+void *digest: +Result area to fill. +

DESCRIPTION

+A procedure of this type is called after processing the final character. It +is its responsibility to finalize the internal state of the MD algorithm and +to generate the resulting digest from this. +

NAME

+Trf_MDStart - Interface to procedures for initialization of a MD context. +

SYNOPSIS

#include <transform.h>
+
+void Trf_MDStart(void *context);
+

PARAMETERS

+void *context: +State to initialize. +

DESCRIPTION

+A procedure of this type is called to initialize the structure +containing the state of a special message digest algorithm. The +memory block was allocated by the caller, with the size as specified +in the 'Trf_MessageDigestDescription' structure of the algorithm. +

NAME

+Trf_MDUpdateBuf - Interface to procedures for update of a MD context. +

SYNOPSIS

#include <transform.h>
+
+void Trf_MDUpdateBuf
+(
+	void *context,
+	unsigned char *buf,
+	int bufLen
+);
+

PARAMETERS

+void *context: +State to update. +
+unsigned char *buf: +Buffer to hash into the state. +
+int bufLen: +Number of characters in the buffer. +

DESCRIPTION

+A procedure of this type is called for character buffer to hash +into the final digest. This procedure is optional, its definition +has precedence over 'Trf_MDUpdate'. +

NAME

+Trf_MDUpdate - Interface to procedures for update of a MD context. +

SYNOPSIS

#include <transform.h>
+
+void Trf_MDUpdate
+(
+	void *context,
+	unsigned int character
+);
+

PARAMETERS

+void *context: +State to update. +
+unsigned int character: +Character to hash into the state. +

DESCRIPTION

+A procedure of this type is called for every character to hash +into the final digest. +

NAME

+Trf_QueryMaxRead - Interface for procedures to query a transformation about the max. +

SYNOPSIS

#include <transform.h>
+
+int Trf_QueryMaxRead
+(
+	Trf_ControlBlock ctrlBlock,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_ControlBlock ctrlBlock: +State of +encoder/decoder. +
+ClientData clientData: +Arbitrary +information, as +defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+ Number of bytes to read in the next call to the down channel. +This procedure will be called by the generic trf layer just before reading +data from the channel below the transformation. This way a transformation +is able to control its consumption of characters. An example would be +'identity with stop after n characters'. This would transfer at most n +characters and then basically fake higher transformations into believing +that EOF occured. Then popping it would reveal the truth. Pattern matching +could be used here too (internet protocols !). +

NAME

+Trf_QueryOptions - Interface to procedures to query an option container. +

SYNOPSIS

#include <transform.h>
+
+int Trf_QueryOptions
+(
+	Trf_Options options,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_Options options: +Option container to query. +
+ClientData clientData: +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+The result value decides wether the encoder- or decoder-set of vectors +must be used during immediate execution of the transformer configured +with the container contents. +

RETURNS

+0: +Use decoder. +
+1: +Use encoder. +

NAME

+Trf_Register - Register the specified transformation at the given interpreter. +

SYNOPSIS

#include <transform.h>
+
+int Trf_Register
+(
+	Tcl_Interp *interp,
+	const Trf_TypeDefinition *type
+);
+

PARAMETERS

+Tcl_Interp *interp: +Interpreter to register at. +
+const Trf_TypeDefinition *type: +Transformation to register. +

DESCRIPTION

+Extends the given interpreter with a new command giving access +to the transformation described in 'type'. 'Type->name' is used +as name of the command. +

NAME

+Trf_RegisterMessageDigest - Procedure to register a message digest algorithm in an interpreter. +

SYNOPSIS

#include <transform.h>
+
+int Trf_RegisterMessageDigest
+(
+	Tcl_Interp *interp,
+	const Trf_MessageDigestDescription *md_desc
+);
+

PARAMETERS

+Tcl_Interp *interp: +Interpreter to register the MD algorithm at. +
+const Trf_MessageDigestDescription *md_desc: +Description of the MD +algorithm. +

DESCRIPTION

+The procedure registers the described MDA at the given interpreter. Return +value is a standard tcl error code. In case of failure an error message +should be left in the result area of the given interpreter. +

NAME

+Trf_SafeInit - Initialize extension in SAFE interpreter. +

SYNOPSIS

#include <transform.h>
+
+int Trf_SafeInit(Tcl_Interp *interp);
+

PARAMETERS

+Tcl_Interp *interp: +Interpreter to initialize. +

DESCRIPTION

+Same as --> Trf_Init. The only security +relevant operations are reading from and +writing to a file. As Tcl-Handles are +given to these commands it is assumed that +they were checked and cleared beforehand. +

NAME

+Trf_SeekQueryOptions - Interface to procedures to query an option container. +

SYNOPSIS

#include <transform.h>
+
+void Trf_SeekQueryOptions
+(
+	Tcl_Interp *interp,
+	Trf_Options options,
+	Trf_SeekInformation *seekInfo,
+	ClientData clientData
+);
+

PARAMETERS

+Tcl_Interp *interp: +Interpreter to use +for reflecting the +query up into tcl, +if necessary. +
+Trf_Options options: +Option container +to query. +
+Trf_SeekInformation *seekInfo: +The policy to modify. +
+ClientData clientData: +Arbitrary +information, as +defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+The procedure is allowed to change the natural seek policy defined for the +transformation according to the current configuration. +

RETURNS

+Nothing. +

NAME

+Trf_SetObjOption - Interface to procedures to define the value of an option. +

SYNOPSIS

#include <transform.h>
+
+int Trf_SetObjOption
+(
+	Trf_Options options,
+	Tcl_Interp *interp,
+	const char *optname,
+	const Tcl_Obj *optvalue,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_Options options: +Container to place the value into. +
+Tcl_Interp *interp: +Interpreter for error messages +(NULL possible). +
+const char *optname: +Name of option to define. +
+const Tcl_Obj *optvalue: +Value to set into the container. +
+ClientData clientData: +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+The procedure takes the specified optionname (rejecting +illegal ones) and places the given optionvalue into the +container. All necessary conversions from a Tcl_Obj to the +required type should be done here. Return value is a standard +tcl error code. In case of failure and interp not NULL an +error message should be left in the result area of the +specified interpreter. This procedure makes sense for tcl +version 8 and above only. +

NAME

+Trf_SetOption - Interface to procedures to define the value of an option. +

SYNOPSIS

#include <transform.h>
+
+int Trf_SetOption
+(
+	Trf_Options options,
+	Tcl_Interp *interp,
+	const char *optname,
+	const char *optvalue,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_Options options: +Container to place the value into. +
+Tcl_Interp *interp: +Interpreter for error messages +(NULL possible). +
+const char *optname: +Name of option to define. +
+const char *optvalue: +Value to set into the container. +
+ClientData clientData: +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +

DESCRIPTION

+The procedure takes the specified optionname (rejecting +illegal ones) and places the given optionvalue into the +container. All necessary conversions from a string to the +required type should be done here. Return value is a standard +tcl error code. In case of failure and interp not NULL an +error message should be left in the result area of the +specified interpreter. +

NAME

+Trf_ShiftRegister - Shift the register. +

SYNOPSIS

#include <transform.h>
+
+void Trf_ShiftRegister
+(
+	void *buffer,
+	void *in,
+	int shift,
+	int buffer_length
+);
+

PARAMETERS

+void *buffer: +Data shifted to the left. +
+void *in: +2nd register shifted into the buffer. +
+int shift: +Number of bytes to shift out (and in). +
+int buffer_length: +Length of buffer and in (in byte). +

DESCRIPTION

+The register is shifted 'shift' bytes to the left. The same +number of bytes from the left of the 2nd register ('in') is +inserted at the right of 'buffer' to replace the lost bytes. +

NAME

+Trf_TransformBuffer - Interface to procedures for transformation of character sequences. +

SYNOPSIS

#include <transform.h>
+
+int Trf_TransformBuffer
+(
+	Trf_ControlBlock ctrlBlock,
+	unsigned char *buf,
+	int bufLen,
+	Tcl_Interp *interp,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_ControlBlock ctrlBlock: +State of encoder/decoder. +
+unsigned char *buf: +Characters to transform. +
+int bufLen: +Number of characters. +
+Tcl_Interp *interp: +Interpreter for error messages +(NULL possible). +
+ClientData clientData: +Arbitrary information, as defined +in Trf_TypeDefinition.clientData. +

DESCRIPTION

+A procedure of this type is called to encode/decode a complete buffer. Return +value is a standard tcl error code. In case of failure and interp not +NULL an error message should be left in the result area of the specified +interpreter. Only one of 'Trf_TransformCharacter' and 'Trf_TransformBuffer' +must be provided. The first named is easier to implement, this one should be +faster. If both are provided, -> 'Trf_TransformBuffer' takes precedence. +

NAME

+Trf_TransformCharacter - Interface to procedures for transformation of a single character. +

SYNOPSIS

#include <transform.h>
+
+int Trf_TransformCharacter
+(
+	Trf_ControlBlock ctrlBlock,
+	unsigned int character,
+	Tcl_Interp *interp,
+	ClientData clientData
+);
+

PARAMETERS

+Trf_ControlBlock ctrlBlock: +State of encoder/decoder. +
+unsigned int character: +Character to transform. +
+Tcl_Interp *interp: +Interpreter for error messages +(NULL possible). +
+ClientData clientData: +Arbitrary information, as defined +in Trf_TypeDefinition.clientData. +

DESCRIPTION

+A procedure of this type is called to encode/decode a single +character. Return value is a standard tcl error code. In case of +failure and interp not NULL an error message should be left in the +result area of the specified interpreter. Only one of 'Trf_TransformCharacter' +and 'Trf_TransformBuffer' must be provided. This one is easier to +implement, the second one should be faster. If both are +provided, -> 'Trf_TransformBuffer' takes precedence. +

NAME

+Trf_WriteProc - Interface to procedures used by an encoder/decoder to write its transformation results. +

SYNOPSIS

#include <transform.h>
+
+int Trf_WriteProc
+(
+	ClientData clientData,
+	unsigned char *outString,
+	int outLen,
+	Tcl_Interp *interp
+);
+

PARAMETERS

+ClientData clientData: +Arbitrary information, defined during +controlblock creation. +
+unsigned char *outString: +Buffer with characters to write. +
+int outLen: +Number of characters in buffer. +
+Tcl_Interp *interp: +Interpreter for error messages +(NULL possible). +

DESCRIPTION

+Procedures of this type are called by an encoder/decoder to write +(partial) transformation results, decoupling the final destination +from result generation. Return value is a standard tcl error code. In +case of failure and interp not NULL an error message should be left +in the result area of the specified interpreter. +

NAME

+Trf_XorBuffer - XOR the bytes in a buffer with a mask. +

SYNOPSIS

#include <transform.h>
+
+void Trf_XorBuffer
+(
+	void *buffer,
+	void *mask,
+	int length
+);
+

PARAMETERS

+void *buffer: +Buffer to xor the mask with. +
+void *mask: +Mask bytes xor'ed into the buffer. +
+int length: +Length of mask and buffer (in byte). +

DESCRIPTION

+Internally used by the implementation of the +various stream modes available to blockciphers. +

+Trf_Init +, +Trf_SafeInit +, +Trf_IsInitialized +, +Trf_CreateOptions +, +Trf_DeleteOptions +, +Trf_CheckOptions +, +Trf_SetOption +, +Trf_SetObjOption +, +Trf_QueryOptions +, +Trf_SeekQueryOptions +, +Trf_WriteProc +, +Trf_CreateCtrlBlock +, +Trf_DeleteCtrlBlock +, +Trf_TransformCharacter +, +Trf_TransformBuffer +, +Trf_FlushTransformation +, +Trf_ClearCtrlBlock +, +Trf_QueryMaxRead +, +Trf_Register +, +Trf_ConverterOptions +, +Trf_MDStart +, +Trf_MDUpdate +, +Trf_MDUpdateBuf +, +Trf_MDFinal +, +Trf_MDCheck +, +Trf_RegisterMessageDigest +, +Trf_LoadLibrary +, +Trf_ShiftRegister +, +Trf_FlipRegisterShort +, +Trf_FlipRegisterLong +, +Trf_InitStubs + + + --- /dev/null +++ b/doc/capi/man/Trf_CheckOptions.3 @@ -0,0 +1,78 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_CheckOptions" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_CheckOptions \- Interface to procedures to check an option container. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_CheckOptions +.br +( +.br + Trf_Options options, +.br + Tcl_Interp *interp, +.br + const Trf_BaseOptions *baseOptions, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_Options options" +Container with options to check. +.TP +.B "Tcl_Interp *interp" +Interpreter to write error +messages to (NULL possible!). +.TP +.B "const Trf_BaseOptions *baseOptions" +Info about common options. +.TP +.B "ClientData clientData" +Arbitrary information, as defined +in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +The procedure has to check the contents of the specified +container for errors, consistency, etc. It is allowed to +set default values into unspecified slots. Return value +is a standard tcl error code. In case of failure and interp +not NULL an error message should be left in the result area +of the specified interpreter. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_ClearCtrlBlock.3 @@ -0,0 +1,66 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_ClearCtrlBlock" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_ClearCtrlBlock \- Interface for procedures to reset the internal state of an encoder/decoder. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_ClearCtrlBlock +.br +( +.br + Trf_ControlBlock ctrlBlock, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_ControlBlock ctrlBlock" +State of +encoder/decoder. +.TP +.B "ClientData clientData" +Arbitrary +information, +as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +The generic io layer of tcl sometimes discards its input buffer. A procedure +of this type will be called in such a case to reset the internal state of +the control structure and to discard buffered characters. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_ConverterOptions.3 @@ -0,0 +1,45 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_ConverterOptions" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_ConverterOptions \- Return the set of option processing procedures required by conversion transformers. +.SH "SYNOPSIS" +.ft B +#include +.sp +Trf_OptionVectors *Trf_ConverterOptions(void); +.ft R +.SH "DESCRIPTION" +Return the set of option processing procedures required by conversion transformers. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_CreateCtrlBlock.3 @@ -0,0 +1,86 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_CreateCtrlBlock" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_CreateCtrlBlock \- Interface to procedure for creation of encoder/decoder control structures. +.SH "SYNOPSIS" +.ft B +#include +.sp +Trf_ControlBlock Trf_CreateCtrlBlock +.br +( +.br + ClientData writeClientData, +.br + Trf_WriteProc *fun, +.br + Trf_Options optInfo, +.br + Tcl_Interp *interp, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "ClientData writeClientData" +Arbitrary information +given as clientdata +to 'fun'. +.TP +.B "Trf_WriteProc *fun" +Vector to use for writing +generated results. +.TP +.B "Trf_Options optInfo" +Options to configure the +control. +.TP +.B "Tcl_Interp *interp" +Interpreter for error +messages. +.TP +.B "ClientData clientData" +Arbitrary information, +as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +The procedure has to create a control structure for an encoder/decoder. The +structure must be initialized with the contents of the the option +container. Return value is an opaque handle aof the control structure or NULL +in case of failure. An error message should be left in the result area +of the specified interpreter then. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_CreateOptions.3 @@ -0,0 +1,52 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_CreateOptions" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_CreateOptions \- Interface to procedures to create a container holding option values. +.SH "SYNOPSIS" +.ft B +#include +.sp +Trf_Options Trf_CreateOptions(ClientData clientData); +.ft R +.SH "PARAMETERS" +.TP +.B "ClientData clientData" +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +It is the responsibility of the procedure to create and +initialize a container to hold option values. An opaque +handle to the new container has to be returned. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_DeleteCtrlBlock.3 @@ -0,0 +1,63 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_DeleteCtrlBlock" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_DeleteCtrlBlock \- Interface to procedure for destruction of encoder/decoder control structures. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_DeleteCtrlBlock +.br +( +.br + Trf_ControlBlock ctrlBlock, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_ControlBlock ctrlBlock" +Control structure to destroy. +.TP +.B "ClientData clientData" +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +It is the responsibility of the procedure to clear and release all memory +associated to the specified control structure (which must have been created +by the appropriate procedure of type 'Trf_CreateCtrlBlock'). +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_DeleteOptions.3 @@ -0,0 +1,63 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_DeleteOptions" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_DeleteOptions \- Interface to proceduress to delete a container made with 'Trf_CreateOptions'. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_DeleteOptions +.br +( +.br + Trf_Options options, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_Options options" +The container to destroy. +.TP +.B "ClientData clientData" +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +It is the responsibility of this procedure to clear and release +all memory of the specified container (which must have been +created by the corresponding procedure of type 'Trf_CreateOptions'). +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_FlipRegisterLong.3 @@ -0,0 +1,60 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_FlipRegisterLong" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_FlipRegisterLong \- Swap the bytes of all 4-byte words contained in the buffer. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_FlipRegisterLong +.br +( +.br + void *buffer, +.br + int length +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "void *buffer" +Data to swap. +.TP +.B "int length" +Length of buffer (in byte). +.SH "DESCRIPTION" +Swap the bytes of all 4-byte words contained in the buffer. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_FlipRegisterShort.3 @@ -0,0 +1,60 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_FlipRegisterShort" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_FlipRegisterShort \- Swap the bytes of all 2-byte words contained in the buffer. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_FlipRegisterShort +.br +( +.br + void *buffer, +.br + int length +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "void *buffer" +Data to swap. +.TP +.B "int length" +Length of buffer (in byte). +.SH "DESCRIPTION" +Swap the bytes of all 2-byte words contained in the buffer. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_FlushTransformation.3 @@ -0,0 +1,71 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_FlushTransformation" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_FlushTransformation \- Interface to procedures used to flush buffered characters. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_FlushTransformation +.br +( +.br + Trf_ControlBlock ctrlBlock, +.br + Tcl_Interp *interp, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_ControlBlock ctrlBlock" +State of encoder/decoder. +.TP +.B "Tcl_Interp *interp" +Interpreter for error messages +(NULL posssible). +.TP +.B "ClientData clientData" +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +An encoder/decoder is allowed to buffer characters internally. A procedure +of this type is called just before destruction to invoke special processing +of such characters. Return value is a standard tcl error code. In case of +failure and interp not NULL an error message should be left in the result +area of the specified interpreter. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_Init.3 @@ -0,0 +1,52 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_Init" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_Init \- Initialize extension in standard interpreter. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_Init(Tcl_Interp *interp); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +Interpreter to initialize. +.SH "DESCRIPTION" +Extends the interpreter with extension-specific +structures and installs the globally visible +command of Tcl-TRF. Will catch attempts for +multiple initialization of an interpreter. +.SH "SEE ALSO" +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_InitStubs.3 @@ -0,0 +1,66 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_InitStubs" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_InitStubs \- Convenience declaration of Trf_InitStubs. +.SH "SYNOPSIS" +.ft B +#include +.sp +extern char *Trf_InitStubs +.br +( +.br + Tcl_Interp *interp, +.br + const char *version, +.br + int exact +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +Not Documented. +.TP +.B "const char *version" +Not Documented. +.TP +.B "int exact" +Not Documented. +.SH "DESCRIPTION" +This function is not *implemented* by the trf library, so the storage +class is neither DLLEXPORT nor DLLIMPORT. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3) --- /dev/null +++ b/doc/capi/man/Trf_IsInitialized.3 @@ -0,0 +1,50 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_IsInitialized" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_IsInitialized \- Check initialization state of specified interpreter. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_IsInitialized(Tcl_Interp *interp); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +Interpreter to check for initialization. +.SH "DESCRIPTION" +Check, wether this extension was initialized for the +specified interpreter or not. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_LoadLibrary.3 @@ -0,0 +1,75 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_LoadLibrary" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_LoadLibrary \- General purpose library loader functionality. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_LoadLibrary +.br +( +.br + Tcl_Interp *interp, +.br + const char *libName, +.br + void **handlePtr, +.br + char **symbols, +.br + int num +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +Not Documented. +.TP +.B "const char *libName" +Not Documented. +.TP +.B "void **handlePtr" +Not Documented. +.TP +.B "char **symbols" +Not Documented. +.TP +.B "int num" +Not Documented. +.SH "DESCRIPTION" +Used by -> TrfLoadZlib, -> TrfLoadLibdes. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_MDCheck.3 @@ -0,0 +1,49 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_MDCheck" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_MDCheck \- Interface to procedures for check/manipulation of the environment (shared libraries, ...). +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_MDCheck(Tcl_Interp *interp); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +The interpreter for error messages. +.SH "DESCRIPTION" +A procedure of this type is called before doing any sort of processing. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_MDFinal.3 @@ -0,0 +1,62 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_MDFinal" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_MDFinal \- Interface to procedures for generation of the final digest from a MD state. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_MDFinal +.br +( +.br + void *context, +.br + void *digest +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "void *context" +State to finalize. +.TP +.B "void *digest" +Result area to fill. +.SH "DESCRIPTION" +A procedure of this type is called after processing the final character. It +is its responsibility to finalize the internal state of the MD algorithm and +to generate the resulting digest from this. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_MDStart.3 @@ -0,0 +1,52 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_MDStart" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_MDStart \- Interface to procedures for initialization of a MD context. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_MDStart(void *context); +.ft R +.SH "PARAMETERS" +.TP +.B "void *context" +State to initialize. +.SH "DESCRIPTION" +A procedure of this type is called to initialize the structure +containing the state of a special message digest algorithm. The +memory block was allocated by the caller, with the size as specified +in the 'Trf_MessageDigestDescription' structure of the algorithm. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_MDUpdate.3 @@ -0,0 +1,61 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_MDUpdate" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_MDUpdate \- Interface to procedures for update of a MD context. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_MDUpdate +.br +( +.br + void *context, +.br + unsigned int character +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "void *context" +State to update. +.TP +.B "unsigned int character" +Character to hash into the state. +.SH "DESCRIPTION" +A procedure of this type is called for every character to hash +into the final digest. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_MDUpdateBuf.3 @@ -0,0 +1,67 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_MDUpdateBuf" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_MDUpdateBuf \- Interface to procedures for update of a MD context. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_MDUpdateBuf +.br +( +.br + void *context, +.br + unsigned char *buf, +.br + int bufLen +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "void *context" +State to update. +.TP +.B "unsigned char *buf" +Buffer to hash into the state. +.TP +.B "int bufLen" +Number of characters in the buffer. +.SH "DESCRIPTION" +A procedure of this type is called for character buffer to hash +into the final digest. This procedure is optional, its definition +has precedence over 'Trf_MDUpdate'. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_QueryMaxRead.3 @@ -0,0 +1,71 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_QueryMaxRead" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_QueryMaxRead \- Interface for procedures to query a transformation about the max. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_QueryMaxRead +.br +( +.br + Trf_ControlBlock ctrlBlock, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_ControlBlock ctrlBlock" +State of +encoder/decoder. +.TP +.B "ClientData clientData" +Arbitrary +information, as +defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" + Number of bytes to read in the next call to the down channel. +This procedure will be called by the generic trf layer just before reading +data from the channel below the transformation. This way a transformation +is able to control its consumption of characters. An example would +be 'identity with stop after n characters'. This would transfer at most n +characters and then basically fake higher transformations into believing +that EOF occured. Then popping it would reveal the truth. Pattern matching +could be used here too (internet protocols !). +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_QueryOptions.3 @@ -0,0 +1,70 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_QueryOptions" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_QueryOptions \- Interface to procedures to query an option container. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_QueryOptions +.br +( +.br + Trf_Options options, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_Options options" +Option container to query. +.TP +.B "ClientData clientData" +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +The result value decides wether the encoder- or decoder-set of vectors +must be used during immediate execution of the transformer configured +with the container contents. +.SH "RETURNS" +.TP +.B "0" +Use decoder. +.TP +.B "1" +Use encoder. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_Register.3 @@ -0,0 +1,62 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_Register" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_Register \- Register the specified transformation at the given interpreter. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_Register +.br +( +.br + Tcl_Interp *interp, +.br + const Trf_TypeDefinition *type +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +Interpreter to register at. +.TP +.B "const Trf_TypeDefinition *type" +Transformation to register. +.SH "DESCRIPTION" +Extends the given interpreter with a new command giving access +to the transformation described in 'type'. 'Type->name' is used +as name of the command. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_RegisterMessageDigest.3 @@ -0,0 +1,63 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_RegisterMessageDigest" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_RegisterMessageDigest \- Procedure to register a message digest algorithm in an interpreter. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_RegisterMessageDigest +.br +( +.br + Tcl_Interp *interp, +.br + const Trf_MessageDigestDescription *md_desc +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +Interpreter to register the MD algorithm at. +.TP +.B "const Trf_MessageDigestDescription *md_desc" +Description of the MD +algorithm. +.SH "DESCRIPTION" +The procedure registers the described MDA at the given interpreter. Return +value is a standard tcl error code. In case of failure an error message +should be left in the result area of the given interpreter. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_SafeInit.3 @@ -0,0 +1,53 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_SafeInit" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_SafeInit \- Initialize extension in SAFE interpreter. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_SafeInit(Tcl_Interp *interp); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +Interpreter to initialize. +.SH "DESCRIPTION" +Same as --> Trf_Init. The only security +relevant operations are reading from and +writing to a file. As Tcl-Handles are +given to these commands it is assumed that +they were checked and cleared beforehand. +.SH "SEE ALSO" +Trf_Init(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_SeekQueryOptions.3 @@ -0,0 +1,80 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_SeekQueryOptions" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_SeekQueryOptions \- Interface to procedures to query an option container. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_SeekQueryOptions +.br +( +.br + Tcl_Interp *interp, +.br + Trf_Options options, +.br + Trf_SeekInformation *seekInfo, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Tcl_Interp *interp" +Interpreter to use +for reflecting the +query up into tcl, +if necessary. +.TP +.B "Trf_Options options" +Option container +to query. +.TP +.B "Trf_SeekInformation *seekInfo" +The policy to modify. +.TP +.B "ClientData clientData" +Arbitrary +information, as +defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +The procedure is allowed to change the natural seek policy defined for the +transformation according to the current configuration. +.SH "RETURNS" +Nothing. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_SetObjOption.3 @@ -0,0 +1,84 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_SetObjOption" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_SetObjOption \- Interface to procedures to define the value of an option. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_SetObjOption +.br +( +.br + Trf_Options options, +.br + Tcl_Interp *interp, +.br + const char *optname, +.br + const Tcl_Obj *optvalue, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_Options options" +Container to place the value into. +.TP +.B "Tcl_Interp *interp" +Interpreter for error messages +(NULL possible). +.TP +.B "const char *optname" +Name of option to define. +.TP +.B "const Tcl_Obj *optvalue" +Value to set into the container. +.TP +.B "ClientData clientData" +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +The procedure takes the specified optionname (rejecting +illegal ones) and places the given optionvalue into the +container. All necessary conversions from a Tcl_Obj to the +required type should be done here. Return value is a standard +tcl error code. In case of failure and interp not NULL an +error message should be left in the result area of the +specified interpreter. This procedure makes sense for tcl +version 8 and above only. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_SetOption.3 @@ -0,0 +1,83 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_SetOption" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_SetOption \- Interface to procedures to define the value of an option. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_SetOption +.br +( +.br + Trf_Options options, +.br + Tcl_Interp *interp, +.br + const char *optname, +.br + const char *optvalue, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_Options options" +Container to place the value into. +.TP +.B "Tcl_Interp *interp" +Interpreter for error messages +(NULL possible). +.TP +.B "const char *optname" +Name of option to define. +.TP +.B "const char *optvalue" +Value to set into the container. +.TP +.B "ClientData clientData" +Arbitrary information, as defined in +Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +The procedure takes the specified optionname (rejecting +illegal ones) and places the given optionvalue into the +container. All necessary conversions from a string to the +required type should be done here. Return value is a standard +tcl error code. In case of failure and interp not NULL an +error message should be left in the result area of the +specified interpreter. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_ShiftRegister.3 @@ -0,0 +1,72 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_ShiftRegister" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_ShiftRegister \- Shift the register. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_ShiftRegister +.br +( +.br + void *buffer, +.br + void *in, +.br + int shift, +.br + int buffer_length +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "void *buffer" +Data shifted to the left. +.TP +.B "void *in" +2nd register shifted into the buffer. +.TP +.B "int shift" +Number of bytes to shift out (and in). +.TP +.B "int buffer_length" +Length of buffer and in (in byte). +.SH "DESCRIPTION" +The register is shifted 'shift' bytes to the left. The same +number of bytes from the left of the 2nd register ('in') is +inserted at the right of 'buffer' to replace the lost bytes. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_TransformBuffer.3 @@ -0,0 +1,82 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_TransformBuffer" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_TransformBuffer \- Interface to procedures for transformation of character sequences. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_TransformBuffer +.br +( +.br + Trf_ControlBlock ctrlBlock, +.br + unsigned char *buf, +.br + int bufLen, +.br + Tcl_Interp *interp, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_ControlBlock ctrlBlock" +State of encoder/decoder. +.TP +.B "unsigned char *buf" +Characters to transform. +.TP +.B "int bufLen" +Number of characters. +.TP +.B "Tcl_Interp *interp" +Interpreter for error messages +(NULL possible). +.TP +.B "ClientData clientData" +Arbitrary information, as defined +in Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +A procedure of this type is called to encode/decode a complete buffer. Return +value is a standard tcl error code. In case of failure and interp not +NULL an error message should be left in the result area of the specified +interpreter. Only one of 'Trf_TransformCharacter' and 'Trf_TransformBuffer' +must be provided. The first named is easier to implement, this one should be +faster. If both are provided, -> 'Trf_TransformBuffer' takes precedence. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_TransformCharacter.3 @@ -0,0 +1,78 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_TransformCharacter" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_TransformCharacter \- Interface to procedures for transformation of a single character. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_TransformCharacter +.br +( +.br + Trf_ControlBlock ctrlBlock, +.br + unsigned int character, +.br + Tcl_Interp *interp, +.br + ClientData clientData +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "Trf_ControlBlock ctrlBlock" +State of encoder/decoder. +.TP +.B "unsigned int character" +Character to transform. +.TP +.B "Tcl_Interp *interp" +Interpreter for error messages +(NULL possible). +.TP +.B "ClientData clientData" +Arbitrary information, as defined +in Trf_TypeDefinition.clientData. +.SH "DESCRIPTION" +A procedure of this type is called to encode/decode a single +character. Return value is a standard tcl error code. In case of +failure and interp not NULL an error message should be left in the +result area of the specified interpreter. Only one of 'Trf_TransformCharacter' +and 'Trf_TransformBuffer' must be provided. This one is easier to +implement, the second one should be faster. If both are +provided, -> 'Trf_TransformBuffer' takes precedence. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_WriteProc.3 @@ -0,0 +1,76 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_WriteProc" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_WriteProc \- Interface to procedures used by an encoder/decoder to write its transformation results. +.SH "SYNOPSIS" +.ft B +#include +.sp +int Trf_WriteProc +.br +( +.br + ClientData clientData, +.br + unsigned char *outString, +.br + int outLen, +.br + Tcl_Interp *interp +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "ClientData clientData" +Arbitrary information, defined during +controlblock creation. +.TP +.B "unsigned char *outString" +Buffer with characters to write. +.TP +.B "int outLen" +Number of characters in buffer. +.TP +.B "Tcl_Interp *interp" +Interpreter for error messages +(NULL possible). +.SH "DESCRIPTION" +Procedures of this type are called by an encoder/decoder to write +(partial) transformation results, decoupling the final destination +from result generation. Return value is a standard tcl error code. In +case of failure and interp not NULL an error message should be left +in the result area of the specified interpreter. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_XorBuffer(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3) --- /dev/null +++ b/doc/capi/man/Trf_XorBuffer.3 @@ -0,0 +1,66 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "Trf_XorBuffer" 3 "27 August 2002" "c2man transform.h" +.SH "NAME" +Trf_XorBuffer \- XOR the bytes in a buffer with a mask. +.SH "SYNOPSIS" +.ft B +#include +.sp +void Trf_XorBuffer +.br +( +.br + void *buffer, +.br + void *mask, +.br + int length +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "void *buffer" +Buffer to xor the mask with. +.TP +.B "void *mask" +Mask bytes xor'ed into the buffer. +.TP +.B "int length" +Length of mask and buffer (in byte). +.SH "DESCRIPTION" +Internally used by the implementation of the +various stream modes available to blockciphers. +.SH "SEE ALSO" +Trf_Init(3), +Trf_SafeInit(3), +Trf_IsInitialized(3), +Trf_CreateOptions(3), +Trf_DeleteOptions(3), +Trf_CheckOptions(3), +Trf_SetOption(3), +Trf_SetObjOption(3), +Trf_QueryOptions(3), +Trf_SeekQueryOptions(3), +Trf_WriteProc(3), +Trf_CreateCtrlBlock(3), +Trf_DeleteCtrlBlock(3), +Trf_TransformCharacter(3), +Trf_TransformBuffer(3), +Trf_FlushTransformation(3), +Trf_ClearCtrlBlock(3), +Trf_QueryMaxRead(3), +Trf_Register(3), +Trf_ConverterOptions(3), +Trf_MDStart(3), +Trf_MDUpdate(3), +Trf_MDUpdateBuf(3), +Trf_MDFinal(3), +Trf_MDCheck(3), +Trf_RegisterMessageDigest(3), +Trf_LoadLibrary(3), +Trf_ShiftRegister(3), +Trf_FlipRegisterShort(3), +Trf_FlipRegisterLong(3), +Trf_InitStubs(3)