rtxUTF8.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2023 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _RTXUTF8_H_
#define _RTXUTF8_H_

#include "rtxsrc/rtxContext.h"

#ifdef __cplusplus
extern "C" {
#endif

/* UTF-8 string functions */
EXTERNRT long rtxUTF8ToUnicode (OSCTXT* pctxt, const OSUTF8CHAR* inbuf,
                                 OSUNICHAR* outbuf, size_t outbufsiz);

EXTERNRT long rtxUTF8ToUnicode32 (OSCTXT* pctxt, const OSUTF8CHAR* inbuf,
                                 OS32BITCHAR* outbuf, size_t outbufsiz);

EXTERNRT int rtxValidateUTF8 (OSCTXT* pctxt, const OSUTF8CHAR* inbuf);

EXTERNRT size_t rtxUTF8Len (const OSUTF8CHAR* inbuf);
EXTERNRT size_t rtxCalcUTF8Len (const OSUTF8CHAR* inbuf, size_t inbufBytes);

EXTERNRT size_t rtxUTF8LenBytes (const OSUTF8CHAR* inbuf);

EXTERNRT int rtxUTF8CharSize (OS32BITCHAR wc);

EXTERNRT int rtxUTF8EncodeChar (OS32BITCHAR wc, OSOCTET* buf, size_t bufsiz);

EXTERNRT int rtxUTF8DecodeChar
(OSCTXT* pctxt, const OSUTF8CHAR* pinbuf, int* pInsize);

EXTERNRT OS32BITCHAR rtxUTF8CharToWC (const OSUTF8CHAR* buf, OSUINT32* len);

EXTERNRT OSUTF8CHAR* rtxUTF8StrChr (OSUTF8CHAR* utf8str,
                                     OS32BITCHAR utf8char);

EXTERNRT OSUTF8CHAR* rtxUTF8Strdup (OSCTXT* pctxt, const OSUTF8CHAR* utf8str);

EXTERNRT OSUTF8CHAR* rtxUTF8Strndup
(OSCTXT* pctxt, const OSUTF8CHAR* utf8str, size_t nbytes);

EXTERNRT OSUTF8CHAR* rtxUTF8StrRefOrDup
(OSCTXT* pctxt, const OSUTF8CHAR* utf8str);

EXTERNRT OSBOOL rtxUTF8StrEqual
(const OSUTF8CHAR* utf8str1, const OSUTF8CHAR* utf8str2);

EXTERNRT OSBOOL rtxUTF8StrnEqual (const OSUTF8CHAR* utf8str1,
                                   const OSUTF8CHAR* utf8str2,
                                   size_t count);

EXTERNRT int rtxUTF8Strcmp (const OSUTF8CHAR* utf8str1,
                             const OSUTF8CHAR* utf8str2);

EXTERNRT int rtxUTF8Strncmp (const OSUTF8CHAR* utf8str1,
                              const OSUTF8CHAR* utf8str2,
                              size_t count);
EXTERNRT OSUTF8CHAR* rtxUTF8Strcpy
(OSUTF8CHAR* dest, size_t bufsiz, const OSUTF8CHAR* src);

EXTERNRT OSUTF8CHAR* rtxUTF8Strncpy
(OSUTF8CHAR* dest, size_t bufsiz, const OSUTF8CHAR* src, size_t nchars);

EXTERNRT OSUINT32 rtxUTF8StrHash (const OSUTF8CHAR* str);

EXTERNRT const OSUTF8CHAR* rtxUTF8StrJoin
(OSCTXT* pctxt, const OSUTF8CHAR* str1, const OSUTF8CHAR* str2,
 const OSUTF8CHAR* str3, const OSUTF8CHAR* str4, const OSUTF8CHAR* str5);

EXTERNRT int rtxUTF8StrToBool (const OSUTF8CHAR* utf8str, OSBOOL* pvalue);

EXTERNRT int rtxUTF8StrnToBool
   (const OSUTF8CHAR* utf8str, size_t nbytes, OSBOOL* pvalue);

EXTERNRT int rtxUTF8StrToDouble (const OSUTF8CHAR* utf8str, OSREAL* pvalue);

EXTERNRT int rtxUTF8StrnToDouble
   (const OSUTF8CHAR* utf8str, size_t nbytes, OSREAL* pvalue);

EXTERNRT int rtxUTF8StrToInt (const OSUTF8CHAR* utf8str, OSINT32* pvalue);

#define rtxUTF8StrToInt32 rtxUTF8StrToInt

EXTERNRT int rtxUTF8StrnToInt
   (const OSUTF8CHAR* utf8str, size_t nbytes, OSINT32* pvalue);

EXTERNRT int rtxUTF8StrToUInt (const OSUTF8CHAR* utf8str, OSUINT32* pvalue);

#define rtxUTF8StrToUInt32 rtxUTF8StrToUInt

EXTERNRT int rtxUTF8StrnToUInt
   (const OSUTF8CHAR* utf8str, size_t nbytes, OSUINT32* pvalue);

EXTERNRT int rtxUTF8StrToSize (const OSUTF8CHAR* utf8str, size_t* pvalue);

EXTERNRT int rtxUTF8StrnToSize
   (const OSUTF8CHAR* utf8str, size_t nbytes, size_t* pvalue);

#ifndef _NO_INT64_SUPPORT

EXTERNRT int rtxUTF8StrToInt64 (const OSUTF8CHAR* utf8str, OSINT64* pvalue);

EXTERNRT int rtxUTF8StrnToInt64
   (const OSUTF8CHAR* utf8str, size_t nbytes, OSINT64* pvalue);

EXTERNRT int rtxUTF8StrToUInt64 (const OSUTF8CHAR* utf8str, OSUINT64* pvalue);

EXTERNRT int rtxUTF8StrnToUInt64
   (const OSUTF8CHAR* utf8str, size_t nbytes, OSUINT64* pvalue);

#endif /* _NO_INT64_SUPPORT */

EXTERNRT int rtxUTF8ToDynUniStr
   (OSCTXT* pctxt, const OSUTF8CHAR* utf8str,
    const OSUNICHAR** ppdata, OSUINT32* pnchars);

EXTERNRT int rtxUTF8ToDynUniStr32
   (OSCTXT* pctxt, const OSUTF8CHAR* utf8str,
    const OS32BITCHAR** ppdata, OSUINT32* pnchars);

EXTERNRT int rtxUTF8RemoveWhiteSpace
(const OSUTF8CHAR* utf8instr, size_t nbytes, const OSUTF8CHAR** putf8outstr);

#define RTUTF8STRCMPL(name,lstr) \
rtxUTF8Strcmp(name,(const OSUTF8CHAR*)lstr)

EXTERNRT int rtxUTF8StrToDynHexStr
(OSCTXT* pctxt, const OSUTF8CHAR* utf8str, OSDynOctStr* pvalue);

EXTERNRT int rtxUTF8StrnToDynHexStr
(OSCTXT* pctxt, const OSUTF8CHAR* utf8str, size_t nbytes, OSDynOctStr* pvalue);

EXTERNRT int rtxUTF8StrToNamedBits (OSCTXT* pctxt, const OSUTF8CHAR* utf8str,
   const OSBitMapItem* pBitMap, OSOCTET* pvalue, OSUINT32* pnbits,
   OSUINT32 bufsize);

EXTERNRT const OSUTF8CHAR* rtxUTF8StrNextTok
(OSUTF8CHAR* utf8str, OSUTF8CHAR** ppNext);

#define OSRTCHKUTF8LEN(str,lower,upper,stat) \
do { size_t nchars = rtxUTF8Len (str); \
stat = (nchars >= lower && nchars <= upper) ? 0 : RTERR_CONSVIO; } while(0)

#ifdef __cplusplus
}
#endif

#endif