maxdz Software GmbH

mdz_ansi_alg Overview and Reference

mdz_ansi_alg Advantages

1. High portability: the whole code conforms to ANSI C 89/90 Standard.

2. Little dependencies: basically, mdz_ansi_alg functions are only dependent on standard C-library functions. It means you can use library in your code without any further dependencies except standard platform libraries/APIs.

3. Fast: Our functions are very fast, concerning operations like searching, insertion, deletion, etc. especially for very large (like hundreds of megabytes or gigabytes) strings.

4. Flexibilty: nearly all library functions contain not only "left position" but also "right position" parameters to limit processed area from right. Also library contains more string functions than according STL, boost or glib analogs have.

5. Extended error-checking: all functions use strict error-checking and return distinct error codes pointing the problem precisely.

6. Extended control: functions do only explicit operations. It means for example, when "insert" function is called - it will return error if there is not enough capacity in string. No implicit reservations will be made.

7. No memory overhead: functions are algorithms for processing input data. There are no memory allocations happen inside functions and no dynamic memory use.

Please refer to mdz_ansi_alg Wiki for API details.

mdz_ansi_alg General Information and Functions

mdz_ansi_alg is algorithms library for contiguous single-byte string, containing ASCII (0..127) and "ANSI" (128 - 255) characters.
There are no dynamic memory-allocations happen inside functions, only data and items buffers passed from outside are processed.

String may contain 0-terminators ('\0') inside, and must end with 0-terminator.

Capacity - how many bytes of memory is reserved for string content. Capacity does not include 0-terminator byte, thus reserved memory should be at least 1 byte bigger than Capacity.
Size - how many characters are actually residing in a string.

Init functions:

mdz_ansi_alg_init
mdz_ansi_alg_insert

Find functions:

mdz_ansi_alg_findSingle
mdz_ansi_alg_find
mdz_ansi_alg_rfindSingle
mdz_ansi_alg_rfind
mdz_ansi_alg_firstOf
mdz_ansi_alg_firstNotOf
mdz_ansi_alg_lastOf
mdz_ansi_alg_lastNotOf

Remove functions:

mdz_ansi_alg_removeFrom
mdz_ansi_alg_remove
mdz_ansi_alg_trimLeft
mdz_ansi_alg_trimRight
mdz_ansi_alg_trim

Miscellaneous functions:

mdz_ansi_alg_compare
mdz_ansi_alg_count

mdz_ansi_alg_init

Initializes mdz_ansi_alg library and license. This function should be called before any other function of the library.

mdz_bool mdz_ansi_alg_init(const unsigned long* pnFirstNameHash, const unsigned long* pnLastNameHash, const unsigned long* pnEmailHash, const unsigned long* pnLicenseHash);

mdz_ansi_alg_insert

Insert pcItems into pcData from nLeftPos position. pcData and pcItems cannot overlap. New size is returned in pnDataSize.
Size and capacity - do not include 0-terminator; thus size and capacity of empty string with no free space are 0

enum mdz_error mdz_ansi_alg_insert(char* pcData, size_t* pnDataSize, size_t nDataCapacity, size_t nLeftPos, const char* pcItems, size_t nCount);

mdz_ansi_alg_findSingle

Find first occurrence of cItem in pcData. Returns 0-based position of match (if found), or SIZE_MAX if not found or error happened. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_findSingle(const char* pcData, size_t nLeftPos, size_t nRightPos, char cItem, enum mdz_error* penError);

mdz_ansi_alg_find

Find first occurrence of pcItems in pcData. Returns 0-based position of match (if found), or SIZE_MAX if not found or error happened. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_find(const char* pcData, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_ansi_find_method enFindMethod, enum mdz_error* penError);

mdz_ansi_alg_rfindSingle

Find last occurrence of cItem in pcData. Returns 0-based position of match (if found), or SIZE_MAX if not found or error happened. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_rfindSingle(const char* pcData, size_t nLeftPos, size_t nRightPos, char cItem, enum mdz_error* penError);

mdz_ansi_alg_rfind

Find last occurrence of pcItems in pcData. Returns 0-based position of match (if found), or SIZE_MAX if not found or error happened. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_rfind(const char* pcData, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_ansi_find_method enFindMethod, enum mdz_error* penError);

mdz_ansi_alg_firstOf

Find first occurrence of any item of pcItems in string. Returns 0-based position of match (if found), or SIZE_MAX if not found or error happened. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_firstOf(const char* pcData, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_error* penError);

mdz_ansi_alg_firstNotOf

Find first non-occurrence of any item of pcItems in string. Returns 0-based position of match (if found), or SIZE_MAX if not found or error happened. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_firstNotOf(const char* pcData, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_error* penError);

mdz_ansi_alg_lastOf

Find last occurrence of any item of pcItems in string. Returns 0-based position of match (if found), or SIZE_MAX if not found or error happened. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_lastOf(const char* pcData, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_error* penError);

mdz_ansi_alg_lastNotOf

Find last non-occurrence of any item of pcItems in string. Returns 0-based position of match (if found), or SIZE_MAX if not found or error happened. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_lastNotOf(const char* pcData, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_error* penError);

mdz_ansi_alg_removeFrom

Remove nCount item(s) starting from 0-based nLeftPos position

enum mdz_error mdz_ansi_alg_removeFrom(char* pcData, size_t* pnDataSize, size_t nLeftPos, size_t nCount);

mdz_ansi_alg_remove

Remove all ocurrences of nCount item(s) matching to pcItems, residing between nLeftPos and nRightPos

enum mdz_error mdz_ansi_alg_remove(char* pcData, size_t* pnDataSize, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount);

mdz_ansi_alg_trimLeft

Remove items which are contained in pcItems from left, until first non-contained in pcItems item is reached.

enum mdz_error mdz_ansi_alg_trimLeft(char* pcData, size_t* pnDataSize, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount);

mdz_ansi_alg_trimRight

Remove items which are contained in pcItems from right, until first non-contained in pcItems item is reached.

enum mdz_error mdz_ansi_alg_trimRight(char* pcData, size_t* pnDataSize, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount);

mdz_ansi_alg_trim

Remove items which are contained in pcItems from left and from right, until first non-contained in pcItems item is reached.

enum mdz_error mdz_ansi_alg_trim(char* pcData, size_t* pnDataSize, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount);

mdz_ansi_alg_compare

Compare content of string with pcItems. If penError is not NULL, error will be written there

enum mdz_ansi_compare_result mdz_ansi_alg_compare(const char* pcData, size_t nDataSize, size_t nLeftPos, const char* pcItems, size_t nCount, mdz_bool bPartialCompare, enum mdz_error* penError);

mdz_ansi_alg_count

Counts number of pcItems substring occurences in string. If penError is not NULL, error will be written there

size_t mdz_ansi_alg_count(const char* pcData, size_t nLeftPos, size_t nRightPos, const char* pcItems, size_t nCount, enum mdz_ansi_find_method enFindMethod, mdz_bool bAllowOverlapped, enum mdz_error* penError);