API-ref-idrs16/html_c/_c_search_context__interface_8h_source.html

#ifndef CSEARCHCONTEXT_INTERFACE_H


#define CSEARCHCONTEXT_INTERFACE_H


#include "CObjPtr_interface.h"

#include "idrs_string_interface.h"

#include "ArrayInterface.h"


#include "idrs_common.h"


#ifdef __cplusplus

extern "C" {

#endif


enum SearchType {


    SearchNumber = 0,

    SearchDate = 1,

    SearchText = 2,

    SearchRegex = 3


};


enum MatchPosition {


    MatchPositionUp = 1,

    MatchPositionDown = 16,

    MatchPositionLeft = 64,

    MatchPositionRight = 4,

    MatchPositionUpLeft = 128,

    MatchPositionUpRight = 2,

    MatchPositionDownLeft = 32,

    MatchPositionDownRight = 8


};


enum SearchType CSearchContext_GetType(const CSearchContext argCSearchContext, idrs_exception *pargException);


void CSearchContext_SetIdentifier(CSearchContext argCSearchContext, const idrs_string strIdentifier, idrs_exception *pargException);


const idrs_string CSearchContext_GetIdentifier(const CSearchContext argCSearchContext, idrs_exception *pargException);


CSearchContext CSearchContext_FollowedBy(CSearchContext argCSearchContext, enum MatchPosition evMatchPosition, const CSearchContext objContext, idrs_exception *pargException);


CSearchContextArray ArrayInterface_Create_CSearchContextArray(idrs_exception *pargException);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* CSEARCHCONTEXT_INTERFACE_H */

ArrayInterface.h
Interface for TObjPtrArray wrapper.

CObjPtr_interface.h
Interface for CObjPtr wrapper.

SearchType
SearchType
Types of searches supported.
Definition CSearchContext_interface.h:24

SearchNumber
@ SearchNumber
Search for occurrences matching number formats, including eventual prefixes or suffixes.
Definition CSearchContext_interface.h:32

SearchText
@ SearchText
Search for occurrences matching a provided text.
Definition CSearchContext_interface.h:48

SearchDate
@ SearchDate
Search for occurrences matching date formats.
Definition CSearchContext_interface.h:41

SearchRegex
@ SearchRegex
Search for occurrences matching a provided regex.
Definition CSearchContext_interface.h:55

ArrayInterface_Create_CSearchContextArray
CSearchContextArray ArrayInterface_Create_CSearchContextArray(idrs_exception *pargException)
Creates a new CSearchContextArray object.

CSearchContext_SetIdentifier
void CSearchContext_SetIdentifier(CSearchContext argCSearchContext, const idrs_string strIdentifier, idrs_exception *pargException)
Sets a unique identifier to the context.

CSearchContext_FollowedBy
CSearchContext CSearchContext_FollowedBy(CSearchContext argCSearchContext, enum MatchPosition evMatchPosition, const CSearchContext objContext, idrs_exception *pargException)
Specifies the next context to be searched for, after the current context has been matched.

CSearchContext_GetIdentifier
const idrs_string CSearchContext_GetIdentifier(const CSearchContext argCSearchContext, idrs_exception *pargException)
Gets the context identifier.

MatchPosition
MatchPosition
Position of a search match in the context of chained searches.
Definition CSearchContext_interface.h:65

MatchPositionUpRight
@ MatchPositionUpRight
The following match must be found on top right of the current match.
Definition CSearchContext_interface.h:108

MatchPositionLeft
@ MatchPositionLeft
The following match must be found on the left of the current match.
Definition CSearchContext_interface.h:87

MatchPositionDownRight
@ MatchPositionDownRight
The following match must be found on bottom right of the current match.
Definition CSearchContext_interface.h:122

MatchPositionUp
@ MatchPositionUp
The following match must be found on top of the current match.
Definition CSearchContext_interface.h:73

MatchPositionUpLeft
@ MatchPositionUpLeft
The following match must be found on top left of the current match.
Definition CSearchContext_interface.h:101

MatchPositionDownLeft
@ MatchPositionDownLeft
The following match must be found on bottom left of the current match.
Definition CSearchContext_interface.h:115

MatchPositionRight
@ MatchPositionRight
The following match must be found on the right of the current match.
Definition CSearchContext_interface.h:94

MatchPositionDown
@ MatchPositionDown
The following match must be found on bottom of the current match.
Definition CSearchContext_interface.h:80

CSearchContext_GetType
enum SearchType CSearchContext_GetType(const CSearchContext argCSearchContext, idrs_exception *pargException)
Gets the context search type.

CSearchContext
Base class for data search contexts.

idrs_string
Class that handles a string of characters.

idrs_common.h

idrs_string_interface.h
Interface for idrs_string wrapper.