onesdk_string.h

Go to the documentation of this file.

/*
    Copyright 2017-2018 Dynatrace LLC

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

#ifndef ONESDK_STRING_H_INCLUDED
#define ONESDK_STRING_H_INCLUDED

/*========================================================================================================================================*/

#include "onesdk/onesdk_common.h"

#include <string.h>     /* for strlen */

#if defined(_WIN32)
#include <wchar.h>      /* for wcslen */
#endif

/*========================================================================================================================================*/

/*========================================================================================================================================*/

typedef uint16_t onesdk_ccsid_t;

typedef struct onesdk_string {
    void const* data;           
    onesdk_size_t byte_length;  
    onesdk_ccsid_t ccsid;       
} onesdk_string_t;

/*========================================================================================================================================*/

#define ONESDK_CCSID_NULL       ((onesdk_ccsid_t)   0)

#define ONESDK_CCSID_ASCII      ((onesdk_ccsid_t) 367)  
#define ONESDK_CCSID_ISO8859_1  ((onesdk_ccsid_t) 819)  
#define ONESDK_CCSID_UTF8       ((onesdk_ccsid_t)1209)  
#define ONESDK_CCSID_UTF16_BE   ((onesdk_ccsid_t)1201)  
#define ONESDK_CCSID_UTF16_LE   ((onesdk_ccsid_t)1203)  
#if defined(ONESDK_BUILD_DOC)
#define ONESDK_CCSID_UTF16_NATIVE
#endif

#if defined(ONESDK_LITTLE_ENDIAN)
#define ONESDK_CCSID_UTF16_NATIVE ONESDK_CCSID_UTF16_LE
#endif

#if defined(ONESDK_BIG_ENDIAN)
#define ONESDK_CCSID_UTF16_NATIVE ONESDK_CCSID_UTF16_BE
#endif

/*========================================================================================================================================*/

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_string_t) onesdk_str(void const* data, onesdk_size_t byte_length, onesdk_ccsid_t ccsid) {
    onesdk_string_t str = { NULL, 0, 0 };
    str.data = data;
    str.byte_length = byte_length;
    str.ccsid = ccsid;
    return str;
}

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_string_t) onesdk_bytestr(char const* data, onesdk_ccsid_t ccsid) {
    return onesdk_str(data, data ? ((onesdk_size_t)strlen(data)) : 0, ccsid);
}

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_string_t) onesdk_asciistr(char const* data) {
    return onesdk_bytestr(data, ONESDK_CCSID_ASCII);
}

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_string_t) onesdk_utf8str(char const* data) {
    return onesdk_bytestr(data, ONESDK_CCSID_UTF8);
}

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_string_t) onesdk_nullstr(void) {
    return onesdk_str(0, 0, ONESDK_CCSID_NULL);
}

#if (defined(_WIN32) && defined(ONESDK_CCSID_UTF16_NATIVE)) || defined(ONESDK_BUILD_DOC)

ONESDK_DEFINE_INLINE_FUNCTION(onesdk_string_t) onesdk_wstr(wchar_t const* data) {
    return onesdk_str(data, data ? ((onesdk_size_t)wcslen(data) * 2) : 0, ONESDK_CCSID_UTF16_NATIVE);
}

#endif

/*========================================================================================================================================*/

/*========================================================================================================================================*/

#endif /* ONESDK_STRING_H_INCLUDED */