character.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you 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 .
 */

/*
 * This file is part of LibreOffice published API.
 */

#ifndef INCLUDED_RTL_CHARACTER_HXX
#define INCLUDED_RTL_CHARACTER_HXX

#include "sal/config.h"

#include <cassert>
#include <cstddef>

#include "sal/types.h"

#if defined LIBO_INTERNAL_ONLY
#include <type_traits>
#endif

namespace rtl
{
inline SAL_CONSTEXPR bool isUnicodeCodePoint(sal_uInt32 code) { return code <= 0x10FFFF; }

inline SAL_CONSTEXPR bool isAscii(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code <= 0x7F;
}

#if defined LIBO_INTERNAL_ONLY
bool isAscii(char) = delete;
bool isAscii(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAscii(T code)
{
    return isAscii(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiLowerCase(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code >= 'a' && code <= 'z';
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiLowerCase(char) = delete;
bool isAsciiLowerCase(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiLowerCase(T code)
{
    return isAsciiLowerCase(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiUpperCase(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code >= 'A' && code <= 'Z';
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiUpperCase(char) = delete;
bool isAsciiUpperCase(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiUpperCase(T code)
{
    return isAsciiUpperCase(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiAlpha(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return isAsciiLowerCase(code) || isAsciiUpperCase(code);
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiAlpha(char) = delete;
bool isAsciiAlpha(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiAlpha(T code)
{
    return isAsciiAlpha(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiDigit(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code >= '0' && code <= '9';
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiDigit(char) = delete;
bool isAsciiDigit(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiDigit(T code)
{
    return isAsciiDigit(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiAlphanumeric(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return isAsciiDigit(code) || isAsciiAlpha(code);
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiAlphanumeric(char) = delete;
bool isAsciiAlphanumeric(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiAlphanumeric(T code)
{
    return isAsciiAlphanumeric(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiCanonicHexDigit(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return isAsciiDigit(code) || (code >= 'A' && code <= 'F');
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiCanonicHexDigit(char) = delete;
bool isAsciiCanonicHexDigit(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiCanonicHexDigit(T code)
{
    return isAsciiCanonicHexDigit(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiHexDigit(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return isAsciiCanonicHexDigit(code) || (code >= 'a' && code <= 'f');
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiHexDigit(char) = delete;
bool isAsciiHexDigit(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiHexDigit(T code)
{
    return isAsciiHexDigit(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiOctalDigit(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code >= '0' && code <= '7';
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiOctalDigit(char) = delete;
bool isAsciiOctalDigit(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiOctalDigit(T code)
{
    return isAsciiOctalDigit(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR bool isAsciiWhiteSpace(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code == ' ' || code == '\f' || code == '\n' || code == '\r' || code == '\t'
           || code == '\v';
}

#if defined LIBO_INTERNAL_ONLY
bool isAsciiWhiteSpace(char) = delete;
bool isAsciiWhiteSpace(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32), bool>
isAsciiWhiteSpace(T code)
{
    return isAsciiWhiteSpace(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR sal_uInt32 toAsciiUpperCase(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return isAsciiLowerCase(code) ? code - 32 : code;
}

#if defined LIBO_INTERNAL_ONLY
sal_uInt32 toAsciiUpperCase(char) = delete;
sal_uInt32 toAsciiUpperCase(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32),
                                  sal_uInt32>
toAsciiUpperCase(T code)
{
    return toAsciiUpperCase(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR sal_uInt32 toAsciiLowerCase(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return isAsciiUpperCase(code) ? code + 32 : code;
}

#if defined LIBO_INTERNAL_ONLY
sal_uInt32 toAsciiLowerCase(char) = delete;
sal_uInt32 toAsciiLowerCase(signed char) = delete;
template <typename T>
inline constexpr std::enable_if_t<std::is_integral_v<T> && sizeof(T) <= sizeof(sal_uInt32),
                                  sal_uInt32>
toAsciiLowerCase(T code)
{
    return toAsciiLowerCase(sal_uInt32(code));
}
#endif

inline SAL_CONSTEXPR sal_Int32 compareIgnoreAsciiCase(sal_uInt32 code1, sal_uInt32 code2)
{
    assert(isUnicodeCodePoint(code1));
    assert(isUnicodeCodePoint(code2));
    return static_cast<sal_Int32>(toAsciiLowerCase(code1))
           - static_cast<sal_Int32>(toAsciiLowerCase(code2));
}

namespace detail
{
sal_uInt32 const surrogatesHighFirst = 0xD800;
sal_uInt32 const surrogatesHighLast = 0xDBFF;
sal_uInt32 const surrogatesLowFirst = 0xDC00;
sal_uInt32 const surrogatesLowLast = 0xDFFF;
}

inline SAL_CONSTEXPR bool isSurrogate(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code >= detail::surrogatesHighFirst && code <= detail::surrogatesLowLast;
}

inline SAL_CONSTEXPR bool isHighSurrogate(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code >= detail::surrogatesHighFirst && code <= detail::surrogatesHighLast;
}

inline SAL_CONSTEXPR bool isLowSurrogate(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    return code >= detail::surrogatesLowFirst && code <= detail::surrogatesLowLast;
}

inline SAL_CONSTEXPR sal_Unicode getHighSurrogate(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    assert(code >= 0x10000);
    return static_cast<sal_Unicode>(((code - 0x10000) >> 10) | detail::surrogatesHighFirst);
}

inline SAL_CONSTEXPR sal_Unicode getLowSurrogate(sal_uInt32 code)
{
    assert(isUnicodeCodePoint(code));
    assert(code >= 0x10000);
    return static_cast<sal_Unicode>(((code - 0x10000) & 0x3FF) | detail::surrogatesLowFirst);
}

inline SAL_CONSTEXPR sal_uInt32 combineSurrogates(sal_uInt32 high, sal_uInt32 low)
{
    assert(isHighSurrogate(high));
    assert(isLowSurrogate(low));
    return ((high - detail::surrogatesHighFirst) << 10) + (low - detail::surrogatesLowFirst)
           + 0x10000;
}

inline SAL_CONSTEXPR std::size_t splitSurrogates(sal_uInt32 code, sal_Unicode* output)
{
    assert(isUnicodeCodePoint(code));
    assert(output != NULL);
    if (code < 0x10000)
    {
        output[0] = code;
        return 1;
    }
    else
    {
        output[0] = getHighSurrogate(code);
        output[1] = getLowSurrogate(code);
        return 2;
    }
}

inline SAL_CONSTEXPR bool isUnicodeScalarValue(sal_uInt32 code)
{
    return isUnicodeCodePoint(code) && !isSurrogate(code);
}
}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */