sack::containers::text Namespace

namespace sets

Name	Description
Functions	The following table lists functions in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Types	The following table lists types in this documentation.
Variables	The following table lists variables in this documentation.
Macros	The following table lists macros in this documentation.

Functions

	Name	Description
	BuildLineExEx	This is function sack::containers::text::BuildLineExEx.
	BuildLineExx	define BuildLineEx(b,pt,single) BuildLineEx(b,pt,single DBG_SRC )
	burstEx	static CTEXTSTR normal_punctuation=WIDE("'"\({[<>]}):@%/,;!?=*&$^~#`");
	CompareStrings	This is function sack::containers::text::CompareStrings.
	CreateUserInputBuffer	This is function sack::containers::text::CreateUserInputBuffer.
	DestroyUserInputBuffer	This is function sack::containers::text::DestroyUserInputBuffer.
	DumpText	PTEXT DumpText( PTEXT somestring ) PTExT (single data segment with full description r in text)
	EnqueUserInputHistory	This is function sack::containers::text::EnqueUserInputHistory.
	FlattenLine	This is function sack::containers::text::FlattenLine.
	FloatCreateFromSeg	This is function sack::containers::text::FloatCreateFromSeg.
	FloatCreateFromText	This is function sack::containers::text::FloatCreateFromText.
	GatherUserInput	This is function sack::containers::text::GatherUserInput.
	GetApplicationPointer	similar to GetIndirect - but results in the literal pointer instead of the text that the application may have registered to result with.
	GetIndirect	This is function sack::containers::text::GetIndirect.
	GetSegmentLength	This is function sack::containers::text::GetSegmentLength.
	GetSegmentLengthEx	This is function sack::containers::text::GetSegmentLengthEx.
	GetSegmentSpace	This is function sack::containers::text::GetSegmentSpace.
	GetSegmentSpaceEx	This is function sack::containers::text::GetSegmentSpaceEx.
	GetText	This is function sack::containers::text::GetText.
	GetTextFlags	This is function sack::containers::text::GetTextFlags.
	GetTextSize	This is function sack::containers::text::GetTextSize.
	IntCreateFromSeg	This is function sack::containers::text::IntCreateFromSeg.
	IntCreateFromText	This is function sack::containers::text::IntCreateFromText.
	IsSegAnyNumberEx	Tests the content of a PTEXT to see if it might be a number.
	LikeText	This is function sack::containers::text::LikeText.
	LineDuplicateEx	This is function sack::containers::text::LineDuplicateEx.
	LineLengthExEx	This is function sack::containers::text::LineLengthExEx.
	LineLengthExx	This is function sack::containers::text::LineLengthExx.
	LineReleaseEx	This is function sack::containers::text::LineReleaseEx.
	RecallUserInput	This is function sack::containers::text::RecallUserInput.
	RegisterTextExtension	by registering for TF_APPLICTION is set on the segment and flags anded with the segment flags match, the function is called.... the result is the actual segment of this - since a TF_APPLICATION is also TF_INDIRECT - using the size to point to some application defined structure instead of a PTEXT structure.
	SameText	these return 1 for more(l1>l2) -1 for (l1
	SegAppend	This is function sack::containers::text::SegAppend.
	SegBreak	This is function sack::containers::text::SegBreak.
	SegConcatEx	This is function sack::containers::text::SegConcatEx.
	SegCreateEx	#define LikeText( l1, l2 ) ( strnicmp( GetText(l1), GetText(l2), textmin( GetTextSize(l1), GetTextSize(l2) ) ) ) #define TextIs(text,string) ( !stricmp( GetText(text), string ) ) #define TextLike(text,string) ( !stricmp( GetText(text), string ) )
	SegCreateFrom_64Ex	This is function sack::containers::text::SegCreateFrom_64Ex.
	SegCreateFromFloatEx
	SegCreateFromIntEx
	SegCreateFromTextEx
	SegCreateIndirectEx
	SegDelete	Removes a segment from a list. It also releases the segment.
	SegDuplicateEx
	SegExpandEx
	SegGrab	removes segment from any list it might be in, returns segment. This substitutes a text segment 'this' with 'that. The segment may be substituted by a list of segments. (Replace the word 'the' with ('this','little','apple') ).
	SegInsert	Inserts a segment before another segment.
	SegReleaseEx	See Also DBG_PASS SegRelease
	SegSplitEx
	SegSubst	This is function sack::containers::text::SegSubst.
	SegUnlink	Removes a segment from a list of segments. Links what was prior and what was after together. Sets both next and prior of the segment unlinked to NULL.
	SetApplicationPointer	Used to set the content of a segment to some application defined value. This allows a users application to store chunks of data in lists of text. These external chunks are handled like other words.
	SetUserInputInsert	bInsert < 0 toggle insert. bInsert == 0 clear isnert(set overwrite) else set insert (clear overwrite )
	SetUserInputPosition	Updates the current input position, for things like input, etc. Some external process indicates where in the line to set the cursor position.
	TextDuplicateEx
	TextIs	Compares if text is like a C string. Case Sensitive. Returns TRUE if they are alike. FALSE if they are different. Parameters
	TextLike	Compares if text is like a C string. Case insensitive (like).
	TextParse	text parse - more generic flavor of burst. static CTEXTSTR normal_punctuation=WIDE("'"\({[<>]}):@%/,;!?=*&$^~#`"); filter_to_space WIDE(" t")
	VarTextAddCharacterEx	This is function sack::containers::text::VarTextAddCharacterEx.
	VarTextCreateEx	This is function sack::containers::text::VarTextCreateEx.
	VarTextCreateExEx	This is function sack::containers::text::VarTextCreateExEx.
	VarTextDestroyEx	This is function sack::containers::text::VarTextDestroyEx.
	VarTextEmptyEx	This is function sack::containers::text::VarTextEmptyEx.
	VarTextEndEx	move any collected text to commit... Commits the currently collected text to segment, and adds the segment to the internal line accumulator.
	VarTextExpandEx	This is function sack::containers::text::VarTextExpandEx.
	VarTextGetEx	This is function sack::containers::text::VarTextGetEx.
	VarTextInitEx	This is function sack::containers::text::VarTextInitEx.
	VarTextLength	This is function sack::containers::text::VarTextLength.
	VarTextPeekEx	This is function sack::containers::text::VarTextPeekEx.
	vtprintfEx	TYPELIB_PROC int vtprintfEx( PVARTEXT pvt DBG_PASS TYPELIB_CALLTYPE CTEXTSTR format, ... ;
	vvtprintf	This is function sack::containers::text::vvtprintf.
	WcharConvert	This is function sack::containers::text::WcharConvert.

Macros

Name	Description
BuildLine	Flattens all segments in a line to a single segment result.
BuildLineEx
burst	Process a line of PTEXT into another line of PTEXT, but with words parsed as appropriate for common language.
COMMAND_POS_CUR	This is macro sack::containers::text::COMMAND_POS_CUR.
COMMAND_POS_SET	negative with SEEK_SET is SEEK_END -nPos
DECLTEXT	This is macro sack::containers::text::DECLTEXT.
DECLTEXTSZ	This is macro sack::containers::text::DECLTEXTSZ.
DECLTEXTSZTYPE	This is macro sack::containers::text::DECLTEXTSZTYPE.
DEFTEXT	This is macro sack::containers::text::DEFTEXT.
FORALLTEXT	This is macro sack::containers::text::FORALLTEXT.
HAS_WHITESPACE	This is macro sack::containers::text::HAS_WHITESPACE.
IGNORE_CURSOR_POS	special coordinate which is NO coordinate
IS_DATA_FLAGS	flag combinatoin which represents actual data is present even with 0 size extended format operations (position, ops) are also considered data.
IsFltNumber	Tests a PTEXT segment to see if it might be a floating point number.
IsIntNumber	IsSegAnyNumber returns 0 if no, 1 if is int, 2 if is float if pfNumber or piNumber are available then the text pointer will be updated to the next segment after what was used to resolve the number. bUseAllSegs is for testing pTexts which are indirect, such that only all segments within the indirect segment will result valid. pfNumber and piNumber may be passed as NULL, and the function can still be used to determine ifnumber the number resulting in the values pointed to will be filled in with (*pfNumber)=FltCreateFromSeg(p) (or Int as appropriate) #define IsNumber(p) IsSegAnyNumberEx( &(p), NULL,... more
IsSegAnyNumber
LineDuplicate	Duplicates the structure of a line. The resulting line is an exact duplicate of the input line. All segments linked in exactly the same sorts of ways.
LineLength	Computes the length of characters in a line, if all segments in the line are flattened into a single word.
LineLengthEx
LineLengthExx	This is macro sack::containers::text::LineLengthExx.
LineRelease	Release a line of text. A line may be a single segment. This is the proper way to dispose of PTEXT segments. Any segment in the line may be passed, the first segment is found, and then all segments in the line are deleted.
NEXTLINE	A convenient macro to go from one segment in a line of text to the next segment.
PRIORLINE	A convenient macro to go from one segment in a line of text to the prior segment.
SegConcat	looks like it takes a peice of one segment and appends it to another.... Needs More research to document correctly and exemplify.
SegCreate	Create a PTEXT with specified number of character capacity.
SegCreateFrom_64	Create a text segment from a _64 bit value. (long long int)
SegCreateFromFloat	Creates a text segment from a floating point value. Probably uses something like '%g' to format output. Fairly limited.
SegCreateFromInt	Creates a text segment from a 64 bit integer.
SegCreateFromText	Creates a PTEXT segment from a string.
SegCreateIndirect	Creates a text segment that refers to the parameter indirectly. The new segment is not really a clone, but a reference of the original PTEXT.
SegDuplicate	This duplicates a specific segment. It duplicates the first segment of a string. If the segment has indirect data, then the first segment of the indirect data is duplicated.
SegExpand	This is macro sack::containers::text::SegExpand.
SegRelease	Release a single segment. UNSAFE. Does not respect that it is in a list.
SegSplit	Split a PTEXT segment.
SetEnd	Sets a PTEXT to the last segment that it points to.
SetIndirect	Set segment's indirect data.
SETNEXTLINE	Link one PTEXT segment to another. Sets one half of the links appropriate for usage.
SETPRIORLINE	Link one PTEXT segment to another. Sets one half of the links appropriate for usage.
SetStart	Sets a pointer to PTEXT to the first text segment in the list.
SetTextSize	might also check to see if pseg is an indirect - setting this size would be BAD
TextDuplicate	Duplicate the whole string of text to another string with exactly the same content.
textmin	define SameText( l1, l2 ) ( strcmp( GetText(l1), GetText(l2) ) )
TF_APPLICATION	this is something special do not treat as text indirect.
TF_BINARY	set for non-text variable
TF_BRACE	braced expression
TF_BRACKET	bracketed expression
TF_COMPLETE	set during burst for last segment...
TF_DEEP	on release release indrect also...
TF_EQUAL	boundry may be ON this value...
TF_FORMATABS	format position is x/y - else space count
TF_FORMATEX	foreground is FORMAT_OP
TF_FORMATPOS	test flag, format has position data
TF_FORMATREL	x,y position used (relative)
TF_INDIRECT	size field extually points at PTEXT
TF_LOWER	Low bound of value...
TF_NORETURN	set on first segment to send to omit lead rn
TF_PAREN	parenthised expression ()
TF_QUOTE	double quoted string segment "
TF_SQUOTE	single quoted string '
TF_STATIC	declared in program data.... do NOT release
TF_TAG	HTML tag like expression <>
TF_TEMP	this segment is not a permanent part (SubstToken)
TF_UPPER	Upper bound of a value...
VarTextAddCharacter	Adds a single character to a PVARTEXT collector.
VarTextCreate	The simplest, most general way to create a PVARTEXT collector. The most extended vartext creator allows specification of how long the initial buffer is, and how much the buffer expands by when required. This was added to optimize building HUGE SQL queries, working withing 100k buffers that expanded by 50k at a time was a lot less operations than expanding 32 bytes or something at a time.
VarTextCreateExx	This is macro sack::containers::text::VarTextCreateExx.
VarTextDestroy	Destroy a VarText collector.
VarTextEmpty	Empties a PVARTEXT structure.
VarTextEnd	This is macro sack::containers::text::VarTextEnd.
VarTextExpand	Add a specified number of characters to the amount of space in the VARTEXT collector.
VarTextGet	Gets the text segment built in the VarText. The PVARTEXT is set to empty.
VarTextInit	Probably should not be exported. Initializes a VARTEXT structure to prepare it for subsequent VarText operations.
VarTextPeek	Returns the PTEXT that is currently in a PVARTEXT. It does not alter the contents of the PVARTEXT. Do not LineRelease this peeked value.
vtprintf

Structs, Records, Enums

	Name	Description
	format_info_tag	extended position, added more information reduced color, 16 colors is really all that there are... 4 bits... added bits for extended formatting like blink, bold, wide, high foreground/background values will be sufficient... they retain full informaiton
	FORMAT_OPS	these enumerated ops put in the foreground field of a format with a flag of TF_FORMATEX will cause the specified operation to be carried out on a display (not files) or generated into the appropriate sequence (ansi out encode) -- correction this is encoded into its own field for the format size, due to machine optimization, 16 bits were free this was expanded and used for all information a segment may contain extended op, color, attributes, and text, everything short of a font for it... not sure how to address that issue... there's certainly modifications to current font... italic... more
	text_segment_tag	A Text segment, it is based on DataBlock that has a length and an addtional region at the end of the structure which contains the text of the segment. Segments may have formatting attributes. Segments may be linked to other segments in a NEXTLINE/PRIORLINE. Segments may have indirect content, which may represent phrases. Sets of segments may represent sentence diagrams. A Pointer to a TEXT type. TEXT is a type I created to provide a variety of functions. One particular application was a common language processor, and I created the TEXT structure to store elements which are... more
	user_input_buffer_tag	extended command entry stuff... handles editing buffers with insert/overwrite/copy/paste/etc...
	FORMAT	extended position, added more information reduced color, 16 colors is really all that there are... 4 bits... added bits for extended formatting like blink, bold, wide, high foreground/background values will be sufficient... they retain full informaiton
	PFORMAT	extended position, added more information reduced color, 16 colors is really all that there are... 4 bits... added bits for extended formatting like blink, bold, wide, high foreground/background values will be sufficient... they retain full informaiton
	PTEXT	A Text segment, it is based on DataBlock that has a length and an addtional region at the end of the structure which contains the text of the segment. Segments may have formatting attributes. Segments may be linked to other segments in a NEXTLINE/PRIORLINE. Segments may have indirect content, which may represent phrases. Sets of segments may represent sentence diagrams. A Pointer to a TEXT type. TEXT is a type I created to provide a variety of functions. One particular application was a common language processor, and I created the TEXT structure to store elements which are... more
	PUSER_INPUT_BUFFER	extended command entry stuff... handles editing buffers with insert/overwrite/copy/paste/etc...
	TEXT	A Text segment, it is based on DataBlock that has a length and an addtional region at the end of the structure which contains the text of the segment. Segments may have formatting attributes. Segments may be linked to other segments in a NEXTLINE/PRIORLINE. Segments may have indirect content, which may represent phrases. Sets of segments may represent sentence diagrams. A Pointer to a TEXT type. TEXT is a type I created to provide a variety of functions. One particular application was a common language processor, and I created the TEXT structure to store elements which are... more
	USER_INPUT_BUFFER	extended command entry stuff... handles editing buffers with insert/overwrite/copy/paste/etc...

Types

Name	Description
PVARTEXT	This is a string collector type. It has an interface to be able to vtprintf( vartext, "format string", ... ); which appends the specified string to the collected text.

Variables

Name	Description
blank	This is variable sack::containers::text::blank.
newline	This is variable sack::containers::text::newline.

Links

sack::containers Namespace, Legend, Topics, Functions, Macros, Structs, Records, Enums, Types, Variables

Contents | Index | Home

What do you think about this topic? Send feedback!