FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
OME Type Support

Classes

class  OMEarrayStorage
 Reference-counted maintainer of a sparse array. More...
 
class  OMEarray
 Implements sparse array of OMEtype elements. More...
 
class  OMEassocKeyPair
 Holds the string / data tuple for an element of an OMEassoc sparse array. More...
 
class  OMEassocStorage
 Reference-counted maintainer of an associative array. Used internally by OMEassoc. More...
 
class  OMEassoc
 Implements associative array of OMEtype elements. More...
 
class  OMEextendedType
 Storage record for large-sized elements on 32-bit hardware. More...
 
class  OME_TypeCheck
 Utility class for type check operations on OMEtype interactions. More...
 
class  OMEtype
 Fundamental ANY type for FARGOS/VISTA Object Management Environment. More...
 
class  OMEprofileRecord
 Base class for OME profiling variable. More...
 
class  OMEprofileCounter< NUMTYPE >
 Base class for application profiling counters or numerical system information. More...
 
class  OMEprofileString< MAXLEN >
 Base type for system information represented as strings. More...
 
class  OMEencodeBufferElement
 Holds data for a single encoded OMEtype element. Multiple OMEencodeBufferElement objects are linked together to represent sequences of data. More...
 
class  OMEencodeBuffer
 Buffer into which OMEtype data is encoded. More...
 
struct  OMEencodeRoutines
 Description for OME encoding routines for a specific encoding version. More...
 
struct  _OMEfixedConstant
 Internal data type to generate fixed-point constant from floating-point value. More...
 
class  OMEfixedStorage
 Reference-counted storage for OMEfixedStorage type. More...
 
class  OMEfixed
 Public interface to OME fixed-point type. More...
 
class  OMEnlmStorage
 Referenced-counted storage for an OME Native Language Message. More...
 
class  OMEnlm
 Public interface to an OME Native Language Message. More...
 
class  OMEnlmCatalog
 Interface to OME Native Language Message catalog. More...
 
class  OMEnlmData
 Identifier for an OME Native Language Message. More...
 
struct  OMEoidID
 Fundamental elements of an OME object identifier. More...
 
class  OMEoidStorageBase
 Abstract interface for storage of OMEoid objects that hides the internal vs. external implementation. More...
 
class  OMEoidStorage
 Reference-counted link to OMEoidStorageBase object. More...
 
class  OMEoid
 Public interface to an OME Object Identifier. More...
 
class  OMEoidStorageInternal
 Interface to an internal OME object. More...
 
class  OMEoidStorageExternal
 Interface to an external OME object. More...
 
class  OMEreferenceCount
 Base class for reference-counted data. More...
 
class  OMEreferenceToData< C >
 Templated type-specific reference to a reference-counted object. More...
 
class  OMEsetStorage
 Reference-counted maintainer of an ordered list of OMEtype elements. Used internally by OMEset. More...
 
class  OMEset
 Implements an ordered list of OMEtype elements. More...
 
class  OMEstringStorage
 Reference-counted storage for OMEstring objects. More...
 
class  OMEstring
 Implements text and binary string storage. More...
 
struct  _OMEtypeDescription
 Internal structure to describe OME fundamental types. More...
 

Macros

#define OME_ARRAY_SUBSCRIPT_t(v)   static_cast<OMEarray::ARRAY_SUBSCRIPT_t>(v)
 
#define OME_ASSOC_SUB(v)   static_cast<OMEassoc::ASSOC_HASH_KEY_t>(v)
 
#define FORCE_OME_EXTENDED_TYPE   0
 
#define OME_EXT_TYPE(member)   value.extType->extValue. member
 
#define OMEdebugMethodInvocations   (2 << 0)
 
#define OMEdebugObjectCreate   (2 << 1)
 
#define OMEdebugObjectDelete   (2 << 2)
 
#define OMEdebugThreadDelete   (2 << 3)
 
#define OMEdebugIncludeArguments   (2 << 4)
 
#define OMEdebugEvents   (2 << 5)
 
#define OMEdebugExceptions   (2 << 6)
 
#define OMEdebugBlockedInvocations   (2 << 7)
 
#define OMEdebugOIL2instructions   (2 << 9)
 
#define OMEdebugBadParameter   (2 << 10)
 
#define OMEdebugProfileCounters   (2 << 11)
 
#define __OME_LOG_LEVEL_BASE   20
 
#define OMEdebugLogLevel0   (1 << (__OME_LOG_LEVEL_BASE + 0))
 
#define OMEdebugLogLevel1   (1 << (__OME_LOG_LEVEL_BASE + 1))
 
#define OMEdebugLogLevel2   (1 << (__OME_LOG_LEVEL_BASE + 2))
 
#define OMEdebugLogLevel3   (1 << (__OME_LOG_LEVEL_BASE + 3))
 
#define OMEdebugEverything   (~0)
 
#define OMEdebugAlways   (~0)
 
#define OMEdebugNever   (0)
 
#define OME_DEBUG_LEVEL_FLAG(l)   (2 << (OME_LOG_LEVEL_BASE + l))
 Mask bit for debug log level. More...
 
#define NOTE_DEFAULT_NLM(s)   __defaultMess = s
 Declare the default message within a DEFINE_NLM_MESSAGE() block. More...
 
#define DEFINE_NLM_MESSAGE(Lvl, MessID, AppName)
 Define an Native Language Message. More...
 
#define AND_OUTPUT_NLM(o, t)
 Render NLM data to an output stream. More...
 
#define AND_ASSIGN_INTO(v)
 Store an NLM into an OMEtype variable. More...
 
#define NEXT_NLM_PARAM   param[_paramSub++]
 Define value for next positional parameter. More...
 
#define OME_SIMPLE_TYPE   1
 A simple native type. More...
 
#define OME_EXTENDED_TYPE   2
 An extended native type. More...
 
#define OME_REFERENCE_TYPE   3
 A complex, reference counted type. More...
 
#define OMEtypeClass(t)   (_OMEtypeTable[(t) & 0x1f].typeClass)
 
#define OMEfundamentalType(t)   (_OMEtypeTable[(t) & 0x1f].basicType)
 
#define OME_FLAG_SORT_ASCENDING   0
 Sort ascending. More...
 
#define OME_FLAG_SORT_DESCENDING   1
 Sort descending. More...
 
#define OME_FLAG_SORT_BY_KEY   2
 Sort by associative array key. More...
 
#define OME_FLAG_SORT_CASE_INSENSITIVE   4
 Ignore case during sort. More...
 

Typedefs

typedef class OMEtypeOMEbaseTypeP
 
typedef class OMEassocKeyPairOME_KEY_PAIR
 
typedef int(* OMEencodeRoutineFP) (OMEencodeBuffer *, const class OMEtype &)
 
typedef OMEtype *(* OMEdecodeRoutineFP) (uint32_t version, const OMEstring *encodedData, size_t *offset)
 
typedef class OMEtypeOMEbaseTypeP
 
typedef struct M_APM_struct * M_APM
 
typedef struct _OMEfixedConstant OMEfixedConstant
 
typedef class OMEtypeOMEbaseTypeP
 
typedef class OMEtypeOMEbaseTypeP
 
typedef class OMEtypeOMEbaseTypeP
 
typedef const class OMEtypeREAD_ONLY_OMEtype
 A convenience typedef for performing read-only access to sparse and associative arrays. This inhibits copy-on-write activity. More...
 

Enumerations

enum  OME_character_set_t {
  OME_CHARSET_UNDEFINED = 0, OME_CHARSET_MASK_CHARSET = 0x1f, OME_CHARSET_STRING_IN_ROM = 0x20, OME_CHARSET_MASK_WIDE_CHARS = 0x10,
  OME_CHARSET_ASCII = 1, OME_CHARSET_EBCDIC = 2, OME_CHARSET_BINARY = 3, OME_CHARSET_UNICODE = (4 | OME_CHARSET_MASK_WIDE_CHARS),
  OME_DEFAULT_CHARSET = OME_CHARSET_ASCII
}
 

Functions

template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &outputStream, const OMEarray &data)
 Write an OMEarray to an output stream. More...
 
template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &outputStream, const OMEassoc &data)
 Output an OMEassoc object to an output stream. More...
 
OME_DLL_EXPORT int OMEsetDebugFlag (const char *flagName, bool setFlag=1) NONNULL_PARAMETERS(1)
 Set or clear named debug flag. More...
 
OME_DLL_EXPORT void OMEinitDebugFlag (const char *paramLine=nullptr)
 Set initial default flags, then parse a line of debugging options and set/clear specified flags. More...
 
OME_DLL_EXPORT void OMEdisplayModuleComments ()
 Convenience function to display module comments on standard error. More...
 
OME_DLL_EXPORT void OMEnoteModuleComment (const char *commentText)
 Note a comment module which can be display on demand. More...
 
OME_DLL_EXPORT int32_t OMEshutdownRequested ()
 Returns indication if the shutdown of the FARGOS/VISTA-based component has been requested. More...
 
OME_DLL_EXPORT void OMEdefineEncodeRoutinesForVersion (OMEencodeRoutines *routines)
 Register encoding routines for OMEtype data. More...
 
OME_DLL_EXPORT void OMEloadVersion1Encodings ()
 
OME_DLL_EXPORT uint_fast16_t OMElistDefinedEncodingVersions (class OMEarray &retList)
 Obtain a list of available encoding routines. More...
 
OME_DLL_EXPORT OMEstringOMEcompressString (const OMEstring &data)
 Compress a string. More...
 
OME_DLL_EXPORT OMEstringOMEuncompressString (const OMEstring &data)
 Uncompress a previously compressed string. More...
 
OME_DLL_EXPORT OMEstringOMEgzipString (const OMEstring &data)
 Compress a string into RFC 1952 format. More...
 
OME_DLL_EXPORT OMEstringOMEgunzipString (const OMEstring &data)
 Uncompress a string in RFC 1592 format. More...
 
template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &outputStream, const OMEfixed &data)
 
template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &outputStream, const OMEnlm &data)
 Output an OMEnlm object to an output stream. More...
 
template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &o, const OMEoidID &data)
 
template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &outputStream, const OMEoid &data)
 
template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &outputStream, const OMEtype &data)
 
template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &outputStream, const OMEset &data)
 Write an OMEset to an output stream. More...
 
constexpr uint_fast8_t UTF8characterLength (uint_fast8_t firstByte)
 Return the number of bytes needed to represent the UTF character. More...
 
uint_fast8_t UTF8characterLength (const void *charPtr)
 Return the number of bytes needed to represent the UTF character at the indicated address. More...
 
template<typename STREAMTYPE >
STREAMTYPE & operator<< (STREAMTYPE &outputStream, const OMEstring &data)
 Output an OMEstring to an output stream. More...
 
ssize_t findSubstring (const unsigned char *source, size_t srcLen, const unsigned char *subString, size_t subLen)
 Searches for a substring within a buffer. More...
 
ssize_t findLastSubstring (const unsigned char *source, size_t srcLen, const unsigned char *subString, size_t subLen)
 
OMEstringconvertCaseOfString (const OMEstring &str, uint_fast8_t toLower=0)
 
int caseInsensitiveCompare (const OMEstring &str1, const OMEstring &str2, bool fuzzy=false)
 
OMEstringsubstituteText (const OMEstring &srcStr, const class OMEassoc &v)
 
OMEstringOMEbinaryToBase64 (const OMEstring &source, bool breakIntoLines=true)
 Convert binary data to base64 text encoding. More...
 
OMEstringOMEbase64ToBinary (const OMEstring &source)
 Convert base-64 encoded text to its binary representation. More...
 
size_t OMEhexToBinary (const unsigned char *src, size_t srcLen, unsigned char *dest, size_t destLen)
 Convert hexadecimal text to binary. More...
 
OMEstringOMEhexToBinary (const OMEstring &source)
 Convert a text string of hexadecimal characters into its binary equivalent. More...
 
OMEstringOMEbinaryToHex (const OMEstring &source)
 Convert a string of binary data into a text string of hexadecimal characters. More...
 
OMEstringOMEbinaryToHex (const unsigned char *source, size_t sourceLen)
 Convert binary data to hexadecimal characters. More...
 
OMEstringOMEconvertURIescapes (const OMEstring &source)
 Convert Uniform Resource Identifier escape sequences. More...
 
OMEstringOMEmakeSafeURI (const OMEstring &source)
 Escape any special characters in an Uniform Resource Identifier. More...
 
OME_FAST_CALL int stringToArrayOfTokens (OMEtype &result, const OMEstring &source, const char *delimeterList=nullptr, const int convertFlag=0)
 Tokenizes a string and saves the parsed tokens as individual elements of an array. More...
 
OME_FAST_CALL int stringToArrayOfTokens (OMEtype &result, const char *source, const int srcLen, const char *delimeterList=nullptr, const int convertFlag=0, const int charSet=OME_CHARSET_UNDEFINED)
 Tokenizes a buffer and saves the parsed tokens as individual elements of an array. More...
 
OME_FAST_CALL void OMEconvertString (OMEtype &result, OMEstring *source, const uint_fast16_t forceBase=10, const bool discard=false)
 Converts text strings into numeric values. More...
 
OME_FAST_CALL int subscriptsInOrder (OMEtype &result, const OMEtype &list, uint_fast8_t descending=OME_FLAG_SORT_ASCENDING)
 Examines an array (either sparse or associative) and returns a list of subscripts that allow the elements of the array to be accessed in the requested order. More...
 
template<typename TO_TYPE >
TO_TYPE OMEtype::convertToNumericType () const
 
 OMEtype::operator int32_t () const
 
 OMEtype::operator uint32_t () const
 
 OMEtype::operator int64_t () const
 
 OMEtype::operator uint64_t () const
 
 OMEtype::operator float () const
 
 OMEtype::operator double () const
 
 OMEoidStorage::OMEoidStorage (class OMEoidStorageExternal *ptr)
 
template<typename STREAMTYPE >
STREAMTYPE & OMEarrayStorage::outputOnStream (STREAMTYPE &outputStream, int_fast16_t indent=0, uint8_t includeTypePrefix=OME_DEFAULT_COMPLEX_OUTPUT_MODE) const
 
template<typename STREAMTYPE >
STREAMTYPE & OMEassocKeyPair::outputOnStream (STREAMTYPE &outputOnStream, int_fast16_t indent=0, uint8_t includeTypePrefix=OME_DEFAULT_COMPLEX_OUTPUT_MODE) const
 
template<typename STREAMTYPE >
STREAMTYPE & OMEassocStorage::outputOnStream (STREAMTYPE &outputOnStream, int_fast16_t indent=0, uint8_t includeTypePrefix=OME_DEFAULT_COMPLEX_OUTPUT_MODE) const
 
template<typename STREAMTYPE >
STREAMTYPE & OMEnlmStorage::outputOnStream (STREAMTYPE &outputStream, int_fast16_t indent=0, uint8_t includeTypePrefix=OME_DEFAULT_COMPLEX_OUTPUT_MODE, const OMEstring *lang=nullptr) const
 
template<typename STREAMTYPE >
static STREAMTYPE & OMEnlm::outputFormattedData (STREAMTYPE &o, const class OMEtype &data, const class OMEtype &annotation, const char *fieldModifier, int modifierLen)
 
template<typename STREAMTYPE >
STREAMTYPE & OMEoidStorageExternal::outputOnStream (STREAMTYPE &outputStream, int_fast16_t indent=0, bool fullInfo=false) const
 
template<typename STREAMTYPE >
STREAMTYPE & OMEoidStorage::outputOnStream (STREAMTYPE &outputStream, int_fast16_t indent=0, bool fullInfo=false) const
 
template<typename STREAMTYPE >
STREAMTYPE & OMEsetStorage::outputOnStream (STREAMTYPE &outputStream, int_fast16_t indent=0, uint8_t includeTypePrefix=OME_DEFAULT_COMPLEX_OUTPUT_MODE) const
 
template<typename STREAMTYPE >
STREAMTYPE & OMEtype::outputOnStream (STREAMTYPE &outputOnStream, int_fast16_t indent=0, uint8_t includeTypePrefix=OUTPUT_TYPENAME) const
 
template<typename STREAMTYPE >
STREAMTYPE & OMEstringStorage::outputOnStream (STREAMTYPE &outputStream, int_fast16_t indent=0, uint8_t includeTypePrefix=0) const
 
template<typename STREAMTYPE >
STREAMTYPE & OMEstringStorage::outputOnStreamAsHex (STREAMTYPE &outputStream, int_fast16_t indent=0, bool dense=false) const
 

Variables

const typedef void * OMEstringInROM
 Points to immovable, read-only string data. More...
 
OME_DLL_EXPORT SMV_StandaloneNumeric< uint32_t > OMEdebugFlag
 
OME_DLL_EXPORT SMV_StandaloneNumeric< uint32_t > OMEstopFlag
 External flag used to trigger stop of a FARGOS/VISTA Object Management Environment. More...
 
OME_DLL_EXPORT SMV_StandaloneString< 128 > OMEstopReason
 
OME_DLL_EXPORT SMV_StandaloneString< 128 > OMEadminStopReason
 
OME_DLL_EXPORT SMV_StandaloneString< 128 > OMEadminProcessLabel
 
OME_DLL_EXPORT OMEprofileCounter< uint32_t > OMEmajorVersion
 Specifies FARGOS/VISTA Version major number. More...
 
OME_DLL_EXPORT OMEprofileCounter< uint32_t > OMEminorVersion
 Specifies FARGOS/VISTA Version minor number. More...
 
OME_DLL_EXPORT OMEprofileCounter< uint32_t > OMEreleaseVersion
 Specifies FARGOS/VISTA Version release number. More...
 
OME_DLL_EXPORT OMEprofileString< 32 > OMEvistaOS
 Specifies name of underlying native operating system. More...
 
OME_DLL_EXPORT OMEprofileString< 32 > OMEvistaCPU
 Specifies name of the underlying CPU architecture. More...
 
const _OMEtypeDescription _OMEtypeTable []
 
int OMEabortOnError
 If non-zero, abort() called on type error. More...
 

Detailed Description

Macro Definition Documentation

◆ __OME_LOG_LEVEL_BASE

#define __OME_LOG_LEVEL_BASE   20

◆ AND_ASSIGN_INTO

#define AND_ASSIGN_INTO (   v)
Value:
OMEnlm __nlmRec(__defaultMess, &param, &__messID, &__catName, &paramInfo); \
v = __nlmRec; \
}

Store an NLM into an OMEtype variable.

Parameters
vis the variable into which the NLM variable should be assigned.

◆ AND_OUTPUT_NLM

#define AND_OUTPUT_NLM (   o,
 
)
Value:
OMEnlm __nlmRec(__defaultMess, &param, &__messID, &__catName, &paramInfo); \
o << __nlmRec << t; \
}

Render NLM data to an output stream.

The AND_OUTPUT_NLM() macro closes a scope opened by the DEFINE_NLM_MESSAGE() macro and outputs the result onto an output stream or equivalent object that supports the "<<" operator.

Parameters
ospecifies the output stream
tspecifies any additional trailing output that should be added. Typically, this is a newline "\\n". If no trailing output is desired, specify the null string ("").

◆ DEFINE_NLM_MESSAGE

#define DEFINE_NLM_MESSAGE (   Lvl,
  MessID,
  AppName 
)
Value:
if (((Lvl) == ~0) || ((Lvl) &OMEdebugFlag)) { \
OMEtype __messID, __nlmMessage; \
OMEarray param, paramInfo; \
OMEstring __defaultMess, __catName; \
uint32_t _paramSub = 0; \
__messID = MessID; \
__catName = AppName

Define an Native Language Message.

The DEFINE_NLM_MESSAGE() macro makes it easy to create a native language message and store it into an OMEtype variable or write it onto an output stream under control of debugging flags.

Parameters
Lvlspecifies a bitmask which is compared against the global variable OMEdebugFlag to determine if the message should be generated. The predefined constant OMEdebugAlways can be used to indicate the operation should always be performed.
MessIDspecifies the message Id. It can be either an integer or string constant. String constants are easier to work with, but integer constants take up less space and can be used when maintaining compatibility with many conventional internationalization techniques. It is possible to use the default message text as the message Id, as is the case with Uniforum-style internationalization using gettext(), by specifying MessId as the null string ("").
AppNamespecifies the application or catalog name. Specify the null string ("") to use the default application name, which is set by OMEnlmData::initialize().

The DEFINE_NLM_MESSAGE() macro introduces a conditional scope within which an native language message can be created and used. The scope is closed by either an AND_OUTPUT_NLM() or AND_ASSIGN_INTO() macro. Within the scope, there should be one usage of NOTE_DEFAULT_NLM() to set the default message text.

The various parameters to the message should be assigned, in order, using the NEXT_NLM_PARAM macro. Use of NEXT_NLM_PARAM() rather than explicit positional parameter subscripts simplifies many aspects. Perhaps most importantly, it enables modification of the source without requiring editing of each line to renumber shifted parameters.

Examples
DEFINE_NLM_MESSAGE(OMEdebugExceptions, "noService", "");
      NOTE_DEFAULT_NLM("Named service destination $1 not defined.");
      NEXT_NLM_PARAM = destination;
AND_OUTPUT_NLM(std::cerr, "\n");
DEFINE_NLM_MESSAGE(OMEdebugAlways, "noSuchClass", "ome");
      NOTE_DEFAULT_NLM("$1: no such class: $2.$3($4)");
      NEXT_NLM_PARAM = classInfo[(uint32_t) 2]; // namespace
      NEXT_NLM_PARAM = classInfo[(uint32_t) 0];       // class
      NEXT_NLM_PARAM = classInfo[(uint32_t) 1]; // version
      NEXT_NLM_PARAM = "createObjectOfClass";
AND_ASSIGN_INTO(*errRet);

Simplest Uniforum-style usage:

DEFINE_NLM_MESSAGE(OMEdebugAlways, "", "");
      NOTE_DEFAULT_NLM("this is what gets used as a last resort");
AND_OUTPUT_NLM(cerr, "\n");
See also
AND_OUTPUT_NLM()
AND_ASSIGN_INTO()
NEXT_NLM_PARAM()
NOTE_DEFAULT_NLM()

◆ FORCE_OME_EXTENDED_TYPE

#define FORCE_OME_EXTENDED_TYPE   0

◆ NEXT_NLM_PARAM

#define NEXT_NLM_PARAM   param[_paramSub++]

Define value for next positional parameter.

Use as the left-hand side of an assignment statement.

◆ NOTE_DEFAULT_NLM

#define NOTE_DEFAULT_NLM (   s)    __defaultMess = s

Declare the default message within a DEFINE_NLM_MESSAGE() block.

If an external message catalog is not available, a native language message (nlm) uses the default message. Translators can search for the NOTE_DEFAULT_NLM pattern to extract the key/text-to-be-translated.

Parameters
sspecifies the default text.
See also
DEFINE_NLM_MESSAGE()

◆ OME_ARRAY_SUBSCRIPT_t

#define OME_ARRAY_SUBSCRIPT_t (   v)    static_cast<OMEarray::ARRAY_SUBSCRIPT_t>(v)

◆ OME_ASSOC_SUB

#define OME_ASSOC_SUB (   v)    static_cast<OMEassoc::ASSOC_HASH_KEY_t>(v)

◆ OME_DEBUG_LEVEL_FLAG

#define OME_DEBUG_LEVEL_FLAG (   l)    (2 << (OME_LOG_LEVEL_BASE + l))

Mask bit for debug log level.

◆ OME_EXT_TYPE

#define OME_EXT_TYPE (   member)    value.extType->extValue. member

◆ OME_EXTENDED_TYPE

#define OME_EXTENDED_TYPE   2

An extended native type.

◆ OME_FLAG_SORT_ASCENDING

#define OME_FLAG_SORT_ASCENDING   0

Sort ascending.

◆ OME_FLAG_SORT_BY_KEY

#define OME_FLAG_SORT_BY_KEY   2

Sort by associative array key.

◆ OME_FLAG_SORT_CASE_INSENSITIVE

#define OME_FLAG_SORT_CASE_INSENSITIVE   4

Ignore case during sort.

◆ OME_FLAG_SORT_DESCENDING

#define OME_FLAG_SORT_DESCENDING   1

Sort descending.

◆ OME_REFERENCE_TYPE

#define OME_REFERENCE_TYPE   3

A complex, reference counted type.

◆ OME_SIMPLE_TYPE

#define OME_SIMPLE_TYPE   1

A simple native type.

◆ OMEdebugAlways

#define OMEdebugAlways   (~0)

◆ OMEdebugBadParameter

#define OMEdebugBadParameter   (2 << 10)

◆ OMEdebugBlockedInvocations

#define OMEdebugBlockedInvocations   (2 << 7)

◆ OMEdebugEvents

#define OMEdebugEvents   (2 << 5)

◆ OMEdebugEverything

#define OMEdebugEverything   (~0)

◆ OMEdebugExceptions

#define OMEdebugExceptions   (2 << 6)

◆ OMEdebugIncludeArguments

#define OMEdebugIncludeArguments   (2 << 4)

◆ OMEdebugLogLevel0

#define OMEdebugLogLevel0   (1 << (__OME_LOG_LEVEL_BASE + 0))

◆ OMEdebugLogLevel1

#define OMEdebugLogLevel1   (1 << (__OME_LOG_LEVEL_BASE + 1))

◆ OMEdebugLogLevel2

#define OMEdebugLogLevel2   (1 << (__OME_LOG_LEVEL_BASE + 2))

◆ OMEdebugLogLevel3

#define OMEdebugLogLevel3   (1 << (__OME_LOG_LEVEL_BASE + 3))

◆ OMEdebugMethodInvocations

#define OMEdebugMethodInvocations   (2 << 0)

◆ OMEdebugNever

#define OMEdebugNever   (0)

◆ OMEdebugObjectCreate

#define OMEdebugObjectCreate   (2 << 1)

◆ OMEdebugObjectDelete

#define OMEdebugObjectDelete   (2 << 2)

◆ OMEdebugOIL2instructions

#define OMEdebugOIL2instructions   (2 << 9)

◆ OMEdebugProfileCounters

#define OMEdebugProfileCounters   (2 << 11)

◆ OMEdebugThreadDelete

#define OMEdebugThreadDelete   (2 << 3)

◆ OMEfundamentalType

#define OMEfundamentalType (   t)    (_OMEtypeTable[(t) & 0x1f].basicType)

◆ OMEtypeClass

#define OMEtypeClass (   t)    (_OMEtypeTable[(t) & 0x1f].typeClass)

Typedef Documentation

◆ M_APM

typedef struct M_APM_struct* M_APM

◆ OME_KEY_PAIR

typedef class OMEassocKeyPair* OME_KEY_PAIR

◆ OMEbaseTypeP [1/5]

typedef class OMEtype* OMEbaseTypeP

◆ OMEbaseTypeP [2/5]

typedef class OMEtype* OMEbaseTypeP

◆ OMEbaseTypeP [3/5]

typedef class OMEtype* OMEbaseTypeP

◆ OMEbaseTypeP [4/5]

typedef class OMEtype* OMEbaseTypeP

◆ OMEbaseTypeP [5/5]

typedef class OMEtype* OMEbaseTypeP

◆ OMEdecodeRoutineFP

typedef OMEtype*(* OMEdecodeRoutineFP) (uint32_t version, const OMEstring *encodedData, size_t *offset)

◆ OMEencodeRoutineFP

typedef int(* OMEencodeRoutineFP) (OMEencodeBuffer *, const class OMEtype &)

◆ OMEfixedConstant

◆ READ_ONLY_OMEtype

A convenience typedef for performing read-only access to sparse and associative arrays. This inhibits copy-on-write activity.

Enumeration Type Documentation

◆ OME_character_set_t

Enumerator
OME_CHARSET_UNDEFINED 
OME_CHARSET_MASK_CHARSET 
OME_CHARSET_STRING_IN_ROM 
OME_CHARSET_MASK_WIDE_CHARS 
OME_CHARSET_ASCII 
OME_CHARSET_EBCDIC 
OME_CHARSET_BINARY 
OME_CHARSET_UNICODE 
OME_DEFAULT_CHARSET 

Function Documentation

◆ OMEoidStorage()

OMEoidStorage::OMEoidStorage ( class OMEoidStorageExternal ptr)
inlineexplicit

◆ caseInsensitiveCompare()

int caseInsensitiveCompare ( const OMEstring str1,
const OMEstring str2,
bool  fuzzy = false 
)

References OMEstring::length().

Referenced by compareStrings().

◆ convertCaseOfString()

OMEstring* convertCaseOfString ( const OMEstring str,
uint_fast8_t  toLower = 0 
)

◆ convertToNumericType()

template<typename TO_TYPE >
TO_TYPE OMEtype::convertToNumericType
inline

◆ findLastSubstring()

ssize_t findLastSubstring ( const unsigned char *  source,
size_t  srcLen,
const unsigned char *  subString,
size_t  subLen 
)

◆ findSubstring()

ssize_t findSubstring ( const unsigned char *  source,
size_t  srcLen,
const unsigned char *  subString,
size_t  subLen 
)

Searches for a substring within a buffer.

Parameters
sourceis a pointer to the buffer.
srcLenindicates the length of the source buffer.
subStringis a pointer to the string to be found.
subLenindicates the length of the substring.
Returns
~0 is returned if the substring is not found; otherwise the offset of the first instance on the substring within the source buffer is returned.

References MAX_CHARS_IN_A_BYTE.

Referenced by decodeMultiPart(), expandSSIvars(), main(), parseMIMEheaderLines(), parseStringIntoSSIelements(), stringToArrayOfTokens(), substituteText(), and OMEstringStorage::substr().

◆ OMEbase64ToBinary()

OMEstring* OMEbase64ToBinary ( const OMEstring source)

Convert base-64 encoded text to its binary representation.

Parameters
sourceis the base-64 encoded text.
Returns
The binary data represented by the base-64 encoded text is returned.
See also
OMEbinaryToBase64()

Referenced by base64ToASCII(), main(), OMEgetLicenseAttribute(), and OMEgetLocalizedData().

◆ OMEbinaryToBase64()

OMEstring* OMEbinaryToBase64 ( const OMEstring source,
bool  breakIntoLines 
)

Convert binary data to base64 text encoding.

Parameters
sourceholds the data to be converted to base-64 text.
breakIntoLinesis a Boolean flag indicating if the output text should be broken into lines of 72-characters.
Returns
A pointer to the OMEstring holding the text output.
See also
OMEbase64ToBinary()

References l, and OMEstring::length().

Referenced by asciiToBase64().

◆ OMEbinaryToHex() [1/2]

OMEstring* OMEbinaryToHex ( const OMEstring source)

Convert a string of binary data into a text string of hexadecimal characters.

Parameters
sourceis an OMEstring holding the data to be converted into a hexadecimal text string.
Returns
A pointer to an OMEstring holding the hexadecimal text string is returned.
See also
OMEbinaryToBase64()
OMEhexToBinary()

References OMEstring::length(), and OMEbinaryToHex().

◆ OMEbinaryToHex() [2/2]

OMEstring* OMEbinaryToHex ( const unsigned char *  srcBfr,
size_t  srcLen 
)

Convert binary data to hexadecimal characters.

Parameters
srcBfrpoints to the data buffer to be encoded.
srcLenindicates the length of the source buffer.
Returns
A pointer to an OMEstring holding the hexadecimal text string is returned.
See also
OMEhexToBinary()
OMEbinaryToBase64()

References OMEstring::determineCharacterSet(), and OMEhexDigits.

Referenced by OMEbinaryToHex(), and skipAndOutputSetToStreamAsHex().

◆ OMEcompressString()

OME_DLL_EXPORT OMEstring* OMEcompressString ( const OMEstring data)

Compress a string.

Parameters
dataholds the source data.
Returns
A string holding the compressed data.
See also
OMEuncompressString()

References OMEstring::getCharacterSet(), htonl, OMEstring::length(), and OMEstring::truncateToLength().

Referenced by compressString().

◆ OMEconvertString()

OME_FAST_CALL void OMEconvertString ( OMEtype result,
OMEstring token,
const uint_fast16_t  forceBase,
const bool  discard 
)

Converts text strings into numeric values.

Numeric data is sometimes encountered in the form of text strings. Frequently, this is a result of human input. If computation is to be performed, the data needs to be converted to an appropriate native representation, such as an integer or floating-point value.

Parameters
resultis a reference to an OMEtype variable into which the result will be stored.
tokenis a pointer to an OMEstring that holds the string to be examined.
forceBasespecifies the default base for numbers. If not specified, it defaults to 10. Recognition of a hexadecimal value can be forced by prefixing the string with the pattern "0x", irrespective of the value of forceBase.
discardis a Boolean flag that indicates if the source string should be deleted after processing.

References l, and OMEstring::length().

Referenced by stringToArrayOfTokens(), and stringToNumber().

◆ OMEconvertURIescapes()

OMEstring* OMEconvertURIescapes ( const OMEstring arg)

Convert Uniform Resource Identifier escape sequences.

Parameters
argis a string that potentially has URI escapes.
Returns
A pointer to an OMEstring containing the processed string is returned.
Note
If no escapes are present in the source arg string, the returned result is another reference to the source arg string, thus a new string is created only if required.
See also
OMEmakeSafeURI()

References OMEstring::getCharacterSet(), OMEstring::length(), and OMEstring::noteCharacterSet().

Referenced by convertURIescapes().

◆ OMEdefineEncodeRoutinesForVersion()

OME_DLL_EXPORT void OMEdefineEncodeRoutinesForVersion ( OMEencodeRoutines routines)

Register encoding routines for OMEtype data.

Parameters
routinesis a pointer to an OMEencodeRoutines structure.

References OMEencodeRoutines::next.

Referenced by OMEloadVersion1Encodings().

◆ OMEdisplayModuleComments()

OME_DLL_EXPORT void OMEdisplayModuleComments ( )

Convenience function to display module comments on standard error.

See also
OMEnoteModuleComment()

◆ OMEgunzipString()

OME_DLL_EXPORT OMEstring* OMEgunzipString ( const OMEstring data)

Uncompress a string in RFC 1592 format.

Parameters
datais a string of compressed data.
Returns
The uncompressed data is returned.
See also
OMEgzipString()

References OMEstring::length(), LOG_CERR, and LOG_ENDLINE.

Referenced by gunzipString().

◆ OMEgzipString()

OME_DLL_EXPORT OMEstring* OMEgzipString ( const OMEstring data)

Compress a string into RFC 1952 format.

Parameters
dataholds the data to be compressed.
Returns
Returns a pointer to an OMEstring holding the compressed data in RFC 1952 format.
See also
OMEgunzipString()

References htonl, OMEstring::length(), LOG_CERR, LOG_ENDLINE, and OMEstring::truncateToLength().

Referenced by gzipString().

◆ OMEhexToBinary() [1/2]

OMEstring* OMEhexToBinary ( const OMEstring source)

Convert a text string of hexadecimal characters into its binary equivalent.

See also
OMEbinaryToHex()

References OMEstring::determineCharacterSet(), OMEstring::length(), and OMEhexToBinary().

◆ OMEhexToBinary() [2/2]

size_t OMEhexToBinary ( const unsigned char *  src,
size_t  srcLen,
unsigned char *  dest,
size_t  destLen 
)

Convert hexadecimal text to binary.

Parameters
srcpoints to the buffer of hexadecimal characters.
srcLenindicates the length of the data to be processed.
destpoints to a buffer into which the binary data should be placed.
destLenindicates the maximum length of the destination buffer.
Returns
The length of the binary data is returned.
See also
OMEbinaryToHex()

Referenced by hexToBinary(), and OMEhexToBinary().

◆ OMEinitDebugFlag()

OME_DLL_EXPORT void OMEinitDebugFlag ( const char *  param)

Set initial default flags, then parse a line of debugging options and set/clear specified flags.

Parameters
paramis an optional argument pointing to a null-terminated C string.

If param is not specified, the contents of the environment variable OME_DEBUG_FLAGS are used. The param is a space- or comma-separated list of debug flag names prefixed with a +d or -d directive, which indicates to set or clear a flag.

* +d methods,args -d log1 +d blocked
* 
See also
OMEsetDebugFlag()

References SMV_StandaloneNumeric< NUMTYPE >::getAddress(), OMEdebugExceptions, and OMEdebugFlag.

Referenced by OMEinitSystem().

◆ OMElistDefinedEncodingVersions()

OME_DLL_EXPORT uint_fast16_t OMElistDefinedEncodingVersions ( OMEarray list)

Obtain a list of available encoding routines.

Parameters
listis an OMEarray that will be filled with the version information.
Returns
A count of the number of available encoding versions is returned.

Referenced by listEncodingVersions().

◆ OMEloadVersion1Encodings()

OME_DLL_EXPORT void OMEloadVersion1Encodings ( )

References OMEdefineEncodeRoutinesForVersion().

Referenced by main().

◆ OMEmakeSafeURI()

OMEstring* OMEmakeSafeURI ( const OMEstring arg)

Escape any special characters in an Uniform Resource Identifier.

Parameters
argis an OMEstring holding the characters to be examined.
Returns
A pointer to an OMEstring containing the processed string is returned.
Note
If no escapes are present in the source arg string, the returned result is another reference to the source arg string, thus a new string is created only if required.
See also
OMEconvertURIescapes()

References OMEstring::getCharacterSet(), OMEstring::length(), OMEstring::noteCharacterSet(), and OMEhexDigits.

Referenced by safeURI().

◆ OMEnoteModuleComment()

OME_DLL_EXPORT void OMEnoteModuleComment ( const char *  commentText)

Note a comment module which can be display on demand.

Module comments can be used to specify copyright or acknowledgements.

Parameters
commentTextis a pointer to a permanent null-terminated C string, typically within a read-only text segment.
See also
OMEdisplayModuleComments()

◆ OMEsetDebugFlag()

OME_DLL_EXPORT int OMEsetDebugFlag ( const char *  flagName,
bool  setFlag 
)

Set or clear named debug flag.

Parameters
flagNameidentifies the flag to be modified.
setFlagis an optional Boolean parameter that indicates the flag is to be set or cleared. If not specified, it defaults to 1.

The recognized flag names are:

  • methods method invocations
  • creates object creation
  • deletes object deletion
  • threads thread creation
  • args also display arguments to methods
  • events I/O and timer events
  • exceptions runtime exceptions
  • log1 debug log level 1
  • log2 debug log level 2
  • log3 debug log level 3
  • blocked methods invocations delayed or blocked due to contention
  • interpreter OIL2 interpreter
  • counters performance counters
  • everything all available debugging
Return values
0the flag name was recognized.
-1the flag name was not recognized.

References SMV_StandaloneNumeric< NUMTYPE >::getAddress(), OMEdebugBlockedInvocations, OMEdebugEvents, OMEdebugEverything, OMEdebugExceptions, OMEdebugFlag, OMEdebugIncludeArguments, OMEdebugLogLevel1, OMEdebugLogLevel2, OMEdebugLogLevel3, OMEdebugMethodInvocations, OMEdebugObjectCreate, OMEdebugObjectDelete, OMEdebugOIL2instructions, OMEdebugProfileCounters, and OMEdebugThreadDelete.

◆ OMEshutdownRequested()

OME_DLL_EXPORT int32_t OMEshutdownRequested ( )

Returns indication if the shutdown of the FARGOS/VISTA-based component has been requested.

Return values
0indicates no shutdown has been requested.
1indicates a shutdown has been requested.

References OMEstopFlag.

◆ OMEuncompressString()

OME_DLL_EXPORT OMEstring* OMEuncompressString ( const OMEstring data)

Uncompress a previously compressed string.

Parameters
dataholds the compressed data.
Returns
A string holding the uncompressed data.
See also
OMEcompressString()

References OMEstring::length(), OMEstring::noteCharacterSet(), ntohl, and OMEstring::truncateToLength().

Referenced by decodeVersion2(), and uncompressString().

◆ operator double()

OMEtype::operator double ( ) const
inlineexplicit

◆ operator float()

OMEtype::operator float ( ) const
inlineexplicit

◆ operator int32_t()

OMEtype::operator int32_t ( ) const
inlineexplicit

◆ operator int64_t()

OMEtype::operator int64_t ( ) const
inlineexplicit

◆ operator uint32_t()

OMEtype::operator uint32_t ( ) const
inlineexplicit

◆ operator uint64_t()

OMEtype::operator uint64_t ( ) const
inlineexplicit

◆ operator<<() [1/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  o,
const OMEoidID data 
)
inline

◆ operator<<() [2/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  outputStream,
const OMEarray data 
)
inline

Write an OMEarray to an output stream.

References OMEarray::outputOnStream().

◆ operator<<() [3/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  outputStream,
const OMEassoc data 
)
inline

Output an OMEassoc object to an output stream.

References OMEassoc::outputOnStream().

◆ operator<<() [4/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  outputStream,
const OMEfixed data 
)
inline

◆ operator<<() [5/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  outputStream,
const OMEnlm data 
)
inline

Output an OMEnlm object to an output stream.

References OMEnlm::outputOnStream().

◆ operator<<() [6/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  outputStream,
const OMEoid data 
)
inline

◆ operator<<() [7/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  outputStream,
const OMEset data 
)
inline

Write an OMEset to an output stream.

References OMEset::outputOnStream().

◆ operator<<() [8/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  outputStream,
const OMEstring data 
)
inline

Output an OMEstring to an output stream.

References OME_DISABLE_QUOTE_OUTPUT, and OMEstring::outputOnStream().

◆ operator<<() [9/9]

template<typename STREAMTYPE >
STREAMTYPE& operator<< ( STREAMTYPE &  outputStream,
const OMEtype data 
)
inline

◆ outputFormattedData()

template<typename STREAMTYPE >
STREAMTYPE & OMEnlm::outputFormattedData ( STREAMTYPE &  o,
const class OMEtype data,
const class OMEtype annotation,
const char *  fieldModifier,
int  modifierLen 
)
inlinestatic

◆ outputOnStream() [1/9]

template<typename STREAMTYPE >
STREAMTYPE & OMEassocKeyPair::outputOnStream ( STREAMTYPE &  outputOnStream,
int_fast16_t  indent = 0,
uint8_t  includeTypePrefix = OME_DEFAULT_COMPLEX_OUTPUT_MODE 
) const
private

◆ outputOnStream() [2/9]

template<typename STREAMTYPE >
STREAMTYPE & OMEassocStorage::outputOnStream ( STREAMTYPE &  outputOnStream,
int_fast16_t  indent = 0,
uint8_t  includeTypePrefix = OME_DEFAULT_COMPLEX_OUTPUT_MODE 
) const
inlineprivate

◆ outputOnStream() [3/9]

◆ outputOnStream() [4/9]

template<typename STREAMTYPE >
STREAMTYPE & OMEoidStorage::outputOnStream ( STREAMTYPE &  outputStream,
int_fast16_t  indent = 0,
bool  fullInfo = false 
) const
inline

◆ outputOnStream() [5/9]

template<typename STREAMTYPE >
STREAMTYPE & OMEoidStorageExternal::outputOnStream ( STREAMTYPE &  outputStream,
int_fast16_t  indent = 0,
bool  fullInfo = false 
) const
inline

◆ outputOnStream() [6/9]

template<typename STREAMTYPE >
STREAMTYPE & OMEstringStorage::outputOnStream ( STREAMTYPE &  outputStream,
int_fast16_t  indent = 0,
uint8_t  includeTypePrefix = 0 
) const
inlineprivate

◆ outputOnStream() [7/9]

template<typename STREAMTYPE >
STREAMTYPE & OMEsetStorage::outputOnStream ( STREAMTYPE &  outputStream,
int_fast16_t  indent = 0,
uint8_t  includeTypePrefix = OME_DEFAULT_COMPLEX_OUTPUT_MODE 
) const
inlineprivate

◆ outputOnStream() [8/9]

template<typename STREAMTYPE >
STREAMTYPE & OMEarrayStorage::outputOnStream ( STREAMTYPE &  outputStream,
int_fast16_t  indent = 0,
uint8_t  includeTypePrefix = OME_DEFAULT_COMPLEX_OUTPUT_MODE 
) const
inlineprivate

◆ outputOnStream() [9/9]

template<typename STREAMTYPE >
STREAMTYPE & OMEnlmStorage::outputOnStream ( STREAMTYPE &  outputStream,
int_fast16_t  indent = 0,
uint8_t  includeTypePrefix = OME_DEFAULT_COMPLEX_OUTPUT_MODE,
const OMEstring lang = nullptr 
) const
inlineprivate

◆ outputOnStreamAsHex()

template<typename STREAMTYPE >
STREAMTYPE & OMEstringStorage::outputOnStreamAsHex ( STREAMTYPE &  outputStream,
int_fast16_t  indent = 0,
bool  dense = false 
) const
inlineprivate

◆ stringToArrayOfTokens() [1/2]

OME_FAST_CALL int stringToArrayOfTokens ( OMEtype result,
const char *  source,
const int  srcLen,
const char *  delimeterList,
const int  convertFlag,
int  charSet 
)

Tokenizes a buffer and saves the parsed tokens as individual elements of an array.

See also
stringToArrayOfTokens(OMEtype, const OMEstring, const char *, const int)

References OMEstring::determineCharacterSet(), findSubstring(), OMEtype::initializeAsType(), OMEstring::noteCharacterSet(), OME_ARRAY, OME_CHARSET_UNDEFINED, and OMEconvertString().

◆ stringToArrayOfTokens() [2/2]

OME_FAST_CALL int stringToArrayOfTokens ( OMEtype result,
const OMEstring source,
const char *  delimeterList,
const int  convertFlag 
)

Tokenizes a string and saves the parsed tokens as individual elements of an array.

It is frequently desirable to parse a string composed of variable length elements separated by delimeter characters. For example, comma-separated-value files separate each respective column by a comma character. Command line input is typically separated by spaces or tabs. If a token needs to include a delimeter character, some provision for escaping it is required. By using double quote marks ("), groups of words can be forced to be treated as a single and unconverted token.

Parameters
resultis a reference to an OMEtype variable into which the result array should be stored.
sourceis a reference to the OMEstring to be tokenized. It will not be modified.
delimeterListis a null-terminated C string containing a list of characters that delimit tokens. If not specified or passed as null (0), the default list of space, tab, carriage return and newline is used.
convertFlagenables conversion of tokenized elements prior to storage in the result array. If set to the default value of 0, no conversion is performed. A non-zero value will cause OMEconvertString() to be called to process each parsed token.
Returns
The result is stored in the result parameter. An integer value is returned that indicates the number of tokens recognized. A zero value thus indicates no tokens were parsed.

References OMEstring::getCharacterSet(), and OMEstring::length().

Referenced by tokenizeString().

◆ subscriptsInOrder()

OME_FAST_CALL int subscriptsInOrder ( OMEtype result,
const OMEtype list,
uint_fast8_t  descending 
)

Examines an array (either sparse or associative) and returns a list of subscripts that allow the elements of the array to be accessed in the requested order.

This is a very efficient routine for sorting sparse and associative arrays. The source array list is not modified, so it can be of arbitrary length without concern as to the impact of a triggering a copy-on-write operation.

Parameters
resultis a reference to an OMEtype into which will be stored an array of ordered subscripts.
listis a read-only reference to an OMEtype which holds either an OMEarray or OMEassoc array.
descendingis an optional flag indicating how the contents of list should be sorted. The default value of 0 indicates an ascending sort by element value. The following constants are declared and can be combined together using the logical OR operator (|):
  • OME_FLAG_SORT_ASCENDING sort order is ascending
  • OME_FLAG_SORT_DESCENDING sort order is descending
  • OME_FLAG_SORT_BY_KEY sort by associative array key
  • OME_FLAG_CASE_INSENSITIVE ignore case during sort
Returns
an integer value indicating the number of subscripts stored in the result array.

Associative arrays can be sorted by either the value of each element or the subscript key (include the OME_FLAG_SORT_BY_KEY flag).

References OMEtype::array, OMEtype::assoc, OMEassoc::elementCount(), OMEarray::elementCount(), OMEarray::indexExists(), OMEassoc::indexExists(), OMEtype::initializeAsType(), OMEarray::nextIndex(), OMEassoc::nextIndex(), OME_ARRAY, OME_ASSOC, OME_FLAG_SORT_BY_KEY, OMEtype::type, and OMEtype::value.

Referenced by orderSubscripts(), and sortArray().

◆ substituteText()

OMEstring* substituteText ( const OMEstring srcStr,
const class OMEassoc v 
)

◆ UTF8characterLength() [1/2]

uint_fast8_t UTF8characterLength ( const void *  charPtr)
inline

Return the number of bytes needed to represent the UTF character at the indicated address.

References UTF8characterLength().

◆ UTF8characterLength() [2/2]

constexpr uint_fast8_t UTF8characterLength ( uint_fast8_t  firstByte)
inlineconstexpr

Return the number of bytes needed to represent the UTF character.

References OME_EXPECT_TRUE.

Referenced by OMEstringStorage::lengthInCharacters(), OMEstringStorage::midMBCSchar(), OMEstringStorage::midMBCSstr(), and UTF8characterLength().

Variable Documentation

◆ _OMEtypeTable

const _OMEtypeDescription _OMEtypeTable[]

◆ OMEabortOnError

int OMEabortOnError

If non-zero, abort() called on type error.

Referenced by OMEbadType().

◆ OMEadminProcessLabel

OME_DLL_EXPORT SMV_StandaloneString<128> OMEadminProcessLabel

◆ OMEadminStopReason

OME_DLL_EXPORT SMV_StandaloneString<128> OMEadminStopReason

◆ OMEdebugFlag

◆ OMEmajorVersion

OME_DLL_EXPORT OMEprofileCounter<uint32_t> OMEmajorVersion

Specifies FARGOS/VISTA Version major number.

◆ OMEminorVersion

OME_DLL_EXPORT OMEprofileCounter<uint32_t> OMEminorVersion

Specifies FARGOS/VISTA Version minor number.

◆ OMEreleaseVersion

OME_DLL_EXPORT OMEprofileCounter<uint32_t> OMEreleaseVersion

Specifies FARGOS/VISTA Version release number.

◆ OMEstopFlag

OME_DLL_EXPORT SMV_StandaloneNumeric<uint32_t> OMEstopFlag

External flag used to trigger stop of a FARGOS/VISTA Object Management Environment.

Referenced by OMErequestShutdown(), OMEshutdown(), and OMEshutdownRequested().

◆ OMEstopReason

Referenced by OMEcleanupGlobalData().

◆ OMEstringInROM

OMEstringInROM

◆ OMEvistaCPU

Specifies name of the underlying CPU architecture.

◆ OMEvistaOS

Specifies name of underlying native operating system.

OMEdebugFlag
OME_DLL_EXPORT SMV_StandaloneNumeric< uint32_t > OMEdebugFlag
OMEnlm
Public interface to an OME Native Language Message.
Definition: OMEnlm.h:98
Generated: Fri Jul 31 2020 18:19:16
Support Information