ADTF
Loading...
Searching...
No Matches
adtf::services::thor::IMacroResolver Class Referenceabstract

More...

#include <macroresolver_intf.h>

Inherits adtf::services::ant::IMacroResolver.

Inherited by adtf::services::vision::IMacroResolver.

Public Member Functions

 ADTF_IID (IMacroResolver, "macroresolver.thor.base.adtf.iid")
 defintion of interace id
 
virtual void ListMacros (bool bIncludeEnvironmentVariables, const ucom::nitro::ifunction< void(const char *, const char *, bool)> &fnCallback) const =0
 
- Public Member Functions inherited from adtf::services::ant::IMacroResolver
 ADTF_IID (IMacroResolver, "macroresolver.ant.base.adtf.iid")
 defintion of interace id
 
virtual tResult ResolveMacros (const char *strSource, base::IString &&strResolvedString)=0
 
virtual tResult RegisterMacro (const char *strMacro, const char *strReplacement, uint32_t ui32Flags=0)=0
 
virtual tResult UnregisterMacro (const char *strMacro)=0
 
virtual void Clear ()=0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 

Additional Inherited Members

- Public Types inherited from adtf::services::ant::IMacroResolver
enum  tMacroResolverFlags { MRF_None = 0x00 , MRF_Overwrite = 0x01 }
 
- Protected Member Functions inherited from adtf::ucom::ant::IObject
 ~IObject ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 

Detailed Description

The IMacroResolver interface provides methods for resolving macros in strings.

Macros must have following layout:

  • $MACRO$
See also
adtf_resolve_macros, adtf_register_macro.

Member Function Documentation

◆ ListMacros()

virtual void adtf::services::thor::IMacroResolver::ListMacros ( bool bIncludeEnvironmentVariables,
const ucom::nitro::ifunction< void(const char *, const char *, bool)> & fnCallback ) const
pure virtual

List all macros and environment variables.

Parameters
[in]bIncludeEnvironmentVariablesIf 'true' macros and environment variables will be listed. If macros and environment variables exist that have the same key, then only the macro is returned.
fnCallbackCallback function with variable name, value and a indicator of whether this is a macro or an environment variable.

The documentation for this class was generated from the following file: