maxdz Software GmbH

mdz_ansi_alg Overview and Reference

mdz_ansi_alg Advantages

1. High Portability: The entire codebase conforms to the ANSI C 89/90 standard.

2. Minimal Dependencies: mdz_ansi_alg functions solely depend on standard C-library functions. This means you can integrate the library into your code without any additional dependencies beyond the standard platform libraries/APIs.

3. Performance: The library functions are highly optimized for speed, particularly for operations like searching. Especially when processing very large string (e.g., hundreds of megabytes or gigabytes).

4. Flexibilty: Most library functions offer both "left position" and "right position" parameters, allowing you to limit the processing area. Additionally, the library provides more string functions than comparable libraries such as STL, Boost, or GLib.

5. Extended Error-Checking: All functions use strict error-checking mechanisms and return specific error codes pointing the problem precisely.

6. Extended Control: The functions perform only explicit operations. For example, when an "insert" function is called, it will return an error if there is not enough capacity in string - no implicit memory allocations/reservations will be made.

7. No Memory Overhead: The functions are designed to process input data without making internal memory allocations or using dynamic memory.

Please refer to mdz_ansi_alg Wiki for API details.

mdz_ansi_alg General Information and Functions

mdz_ansi_alg is algorithms library for processing contiguous single-byte string, containing ASCII (0..127) and "ANSI" (128 - 255) characters.
There are no memory allocations happen inside functions and there is no dynamic memory use.

String - String may contain 0-terminators ('\0') inside, and MUST end with 0-terminator.
Item - single element/character of String or of buffer passed as parameter for insertion, removing, find, etc. For this single-byte string library Item is always a byte.
Capacity - how many bytes of memory is reserved for string content. Capacity does NOT include ending 0-terminator byte
Size - how many characters are actually residing in a string.

Init functions:

mdz_ansi_alg_init

Insert/remove functions:

mdz_ansi_alg_insert
mdz_ansi_alg_append
mdz_ansi_alg_removeFrom
mdz_ansi_alg_remove
mdz_ansi_alg_trimLeft
mdz_ansi_alg_trimRight
mdz_ansi_alg_trim

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

Miscellaneous functions:

mdz_ansi_alg_equal
mdz_ansi_alg_compare
mdz_ansi_alg_count
mdz_ansi_alg_replace
mdz_ansi_alg_reverse

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_append

Append pcItems to pcData. 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_append(char* pcData, size_t* pnDataSize, size_t nDataCapacity, 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 using optimized Boyer-Moore-Horspool search. 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_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 using optimized Boyer-Moore-Horspool search. 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_error* penError);

mdz_ansi_alg_firstOf

Find first occurrence of any Item 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_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 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_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 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_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 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_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 characters/bytes from pcData, 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 pcItems from pcData, 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_bool bFromLeft);

mdz_ansi_alg_trimLeft

Remove leading characters/bytes contained in pcItems from pcData, starting from nLeftPos until first Item non-contained in pcItems 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 trailing characters/bytes contained in pcItems from pcData, starting from nRightPos until first Item non-contained in pcItems 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 leading and trailing characters/bytes contained in pcItems pcData, starting from nLeftPos and from nRightPos, until first Item non-contained in pcItems 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_equal

Compares pcData with pcItems on equalty by length and content. If penError is not NULL, error will be written there

enum mdz_ansi_compare_result mdz_ansi_alg_equal(const char* pcData, size_t nDataSize, const char* pcItems, size_t nCount, enum mdz_error* penError);

mdz_ansi_alg_compare

Compare content of pcData 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, enum mdz_error* penError);

mdz_ansi_alg_count

Counts number of pcItems occurences in pcData. 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, mdz_bool bAllowOverlapped, mdz_bool bFromLeft, enum mdz_error* penError);

mdz_ansi_alg_replace

Replace every occurence of pcItemsBefore with pcItemsAfter in pcData. There should be enough Capacity for replacing data.

enum mdz_error mdz_ansi_alg_replace(char* pcData, size_t* pnDataSize, size_t nDataCapacity, size_t nLeftPos, size_t nRightPos, const char* pcItemsBefore, size_t nCountBefore, const char* pcItemsAfter, size_t nCountAfter, mdz_bool bFromLeft, enum mdz_ansi_replace_type enReplacementType, size_t* pnNewSize);

mdz_ansi_alg_reverse

Reverses characters/bytes in pcData, like "1234" into "4321".

enum mdz_error mdz_ansi_alg_reverse(char* pcData, size_t nLeftPos, size_t nRightPos);