libaria_string.h

Microchip Technology Inc.

File Name

libaria_string.h

Description

Module for Microchip Graphics Library - Aria User Interface Library

This is a string library implementation that is used internally by the Aria user interface library. All of the memory operations are handled by the memory interface that is provided by the active libaria context. Applications that wish to use this implementation must ensure that the appropriate libaria context is active when calling these functions.

This implementation relies on the GFXU_CHAR definition for characters provided by the GFX Utils library. This chararcter definition is 32 bits in size and allows libaria to support international character code points and Unicode encoding standards.

Functions

	Name	Description
	laString_Allocate	Attempts to resize the local data buffer for a string.
	laString_Append	Appends a string onto the end of another string
	laString_Capacity	Returns the capacity of a string
	laString_CharAt	Extracts the code point for the character in a string at a given index.
	laString_Clear	Sets a string's length to zero and its string table reference to NULL. Does not free any associated data and preserves capacity.
	laString_Compare	Compares two string objects
	laString_CompareBuffer	Compares a string object and a GFXU_CHAR* buffer
	laString_Copy	Copies the values from one string into another
	laString_CreateFromBuffer	Creates a string object from a GFXU_CHAR buffer and a font asset pointer
	laString_CreateFromCharBuffer	Creates a string object from a const char* buffer and a font asset pointer. This method provides compatibility with standard c-style strings. Input string will be converted from 8-bit with to 32-bit width.
	laString_CreateFromID	Creates a string object that simply references a string in the string table.
	laString_Delete	Deletes all memory associated with a string object
	laString_Destroy	Destroys a string object. This frees the strings internal data buffer, if it exists, sets its string table reference to null, and clears all supporting attributes.
	laString_Draw	Wrapper around GFX Utility string draw function for Aria user interface library. Internal use only.
	laString_DrawClipped	Wrapper around GFX Utility string draw function for Aria user interface library. Draws only a clipped area of a string. Internal use only.
	laString_DrawSubStringClipped	Wrapper around GFX Utility string draw function for Aria user interface library. Draws the substring between the start and end offset, and draws only the section of the string within the clipping rectangle. Internal use only.
	laString_ExtractFromTable	Extracts a read-only string from the string table into a modifiable string object. This relies on the active context to indicate which string table to reference as well as which language entry to extract.
	laString_GetAscent	Returns the ascent of a string by referencing its associated font asset data.
	laString_GetCharIndexAtPoint	Given an offset in pixels returns the corresponding character index.
	laString_GetCharOffset	Returns the offset of a given character index in pixels.
	laString_GetCharWidth	Given a character index, gets the width of that character. Only accurate if the string has a font associated with it and that font contains all the characters in the string in question.
	laString_GetHeight	Returns the height of a string by referencing its associated font asset data.
	laString_GetLineRect	Calculates the rectangle for a line in a string object. References the associated font for the height but must perform a summation for each character in the string by doing a font meta-data lookup. The line ends when a line feed or end of string is reached.
	laString_GetMultiLineRect	Calculates the rectangle for a given multi-line string object. References the associated font for the height but must perform a summation for each character in the string by doing a font meta-data lookup. The height the sum of the heights of the bounding rectangles for each line and the width is the widest among the bounding rectangles.
	laString_GetRect	Calculates the rectangle for a given string object. References the associated font for the height but must perform a summation for each character in the string by doing a font meta-data lookup.
	laString_Initialize	Initializes a string struct to default
	laString_Insert	Inserts a string into another string at a given index
	laString_IsEmpty	Returns a boolean indicating if the provided string contains data or has a link to the string table.
	laString_Length	Calculates the length of a string in characters
	laString_New	Allocates a memory for a new string
	laString_ReduceLength	Reduces the length of a string. This simply slides the null terminator to the left and does not affect the string's capacity value.
	laString_Remove	Removes a number of characters from a string at a given index
	laString_Set	Attempts to set the local data buffer of a string to an input buffer
	laString_SetCapacity	Attempts to adjust the capacity of a string
	laString_ToCharBuffer	Extracts the data buffer from a string and copies it into the provided buffer argument.

Structures

	Name	Description
	laString_t	String definition
	laString	String definition

Types

	Name	Description
	laContext	An instance of the Aria user interface library.

MPLAB® Harmony Graphics Suite > Graphics Library > Aria Graphics Library > Files > libaria_string.h

MPLAB® Harmony Graphics Suite

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support