CharTraits.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/CharTraits.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_CharTraits_h
#define __PCL_CharTraits_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Utility.h>
 
#include <ctype.h>
#include <memory.h>
#include <string.h>
 
#ifdef __PCL_WINDOWS
#  include <windows.h>
#else // POSIX
#  include <wchar.h>
#  include <wctype.h>
#endif // !__PCL_WINDOWS
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
char16_type PCL_FUNC PCL_ToCaseFolded( char16_type );
char16_type PCL_FUNC PCL_ToLowercase( char16_type );
char16_type PCL_FUNC PCL_ToUppercase( char16_type );
 
extern const uint8* PCL_DATA PCL_toLowercaseLatin1;
extern const uint8* PCL_DATA PCL_toUppercaseLatin1;
 
// ----------------------------------------------------------------------------
 
// ----------------------------------------------------------------------------
 
#define PCL_COMPARE_CODE_POINTS()                                             \
   PCL_PRECONDITION( n1 == 0 || n2 == 0 || s1 != nullptr && s2 != nullptr )   \
   if ( caseSensitive )                                                       \
   {                                                                          \
      for ( size_type n = pcl::Min( n1, n2 ); n > 0; --n, ++s1, ++s2 )        \
         if ( *s1 != *s2 )                                                    \
            return (*s1 < *s2) ? -1 : +1;                                     \
   }                                                                          \
   else                                                                       \
   {                                                                          \
      for ( size_type n = pcl::Min( n1, n2 ); n > 0; --n, ++s1, ++s2 )        \
      {                                                                       \
         char_type c1 = ToCaseFolded( *s1 ), c2 = ToCaseFolded( *s2 );        \
         if ( c1 != c2 )                                                      \
            return (c1 < c2) ? -1 : +1;                                       \
      }                                                                       \
   }                                                                          \
   return (n1 == n2) ? 0 : ((n1 < n2) ? -1 : +1)
 
// ----------------------------------------------------------------------------
 
/*
 * Wildcard string matching algorithm adapted from:
 *
 * Kirk J. Krauss (2014): Matching Wildcards: An Empirical Way to Tame an
 * Algorithm, Dr. Dobb's Magazine, October 7, 2014.
 *
 * http://www.drdobbs.com/architecture-and-design/matching-wildcards-an-empirical-way-to-t/240169123
 */
 
template <typename Tt, typename Tp> inline
bool WildMatch( const Tt* t, size_type nt, const Tp* p, size_type np )
{
   PCL_PRECONDITION( nt == 0 || np == 0 || t != nullptr && p != nullptr )
 
   if ( nt == 0 || np == 0 )
      return false;
 
   const Tt* et = t + nt;
   const Tp* ep = p + np;
   const Tt* bt = nullptr;
   const Tp* bp = nullptr;
 
   for ( ;; )
   {
      Tp c = *p;
 
      if ( c == Tp( '*' ) )
      {
         do
            if ( ++p == ep )
               return true;
         while ( (c = *p) == Tp( '*' ) );
 
         if ( c != Tp( '?' ) )
            while ( Tt( c ) != *t )
               if ( ++t == et )
                  return false;
 
         bp = p;
         bt = t;
      }
      else if ( Tt( c ) != *t && c != Tp( '?' ) )
      {
         if ( bp != nullptr )
         {
            if ( p != bp )
            {
               p = bp;
 
               if ( Tt( *p ) != *t )
               {
                  t = ++bt;
                  continue;
               }
 
               ++p;
            }
 
            if ( t < et )
            {
               ++t;
               continue;
            }
         }
 
         return false;
      }
 
      ++t;
      ++p;
 
      if ( t == et )
      {
         if ( p == ep )
            return true;
 
         while ( *p == Tp( '*' ) )
            if ( ++p == ep )
               return true;
 
         return false;
      }
   }
}
 
template <typename Tt, typename Tp, class Ut, class Up> inline
bool WildMatchIC( const Tt* t, size_type nt, const Tp* p, size_type np, Ut ut, Up up )
{
   PCL_PRECONDITION( nt == 0 || np == 0 || t != nullptr && p != nullptr && ut != nullptr && up != nullptr )
 
   if ( nt == 0 || np == 0 )
      return false;
 
   const Tt* et = t + nt;
   const Tp* ep = p + np;
   const Tt* bt = nullptr;
   const Tp* bp = nullptr;
 
   for ( ;; )
   {
      Tp c = *p;
 
      if ( c == Tp( '*' ) )
      {
         do
            if ( ++p == ep )
               return true;
         while ( (c = *p) == Tp( '*' ) );
 
         if ( c != Tp( '?' ) )
         {
            c = up( c );
            while ( Tt( c ) != ut( *t ) )
               if ( ++t == et )
                  return false;
         }
 
         bp = p;
         bt = t;
      }
      else if ( c != Tp( '?' ) )
      {
         Tt ft = ut( *t );
 
         if ( Tt( up( c ) ) != ft )
         {
            if ( bp != nullptr )
            {
               if ( p != bp )
               {
                  p = bp;
 
                  if ( Tt( up( *p ) ) != ft )
                  {
                     t = ++bt;
                     continue;
                  }
 
                  ++p;
               }
 
               if ( t < et )
               {
                  ++t;
                  continue;
               }
            }
 
            return false;
         }
      }
 
      ++t;
      ++p;
 
      if ( t == et )
      {
         if ( p == ep )
            return true;
 
         while ( *p == Tp( '*' ) )
            if ( ++p == ep )
               return true;
 
         return false;
      }
   }
}
 
// ----------------------------------------------------------------------------
 
template <typename T>
class PCL_CLASS GenericCharTraits
{
public:
 
   using char_type = T;
 
   static constexpr size_type BytesPerChar() noexcept
   {
      return sizeof( char_type );
   }
 
   static size_type Length( const char_type* s ) noexcept
   {
      const char_type* __restrict__ t = s;
      if ( s != nullptr )
         for ( ; *t != Null(); ++t ) {}
      return size_type( t - s );
   }
 
   static void Fill( char_type* __restrict__ s, char_type c, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n )
         *s++ = c;
   }
 
   static void Copy( char_type* __restrict__ dst, const char_type* __restrict__ src, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || dst != nullptr && src != nullptr )
      ::memcpy( dst, src, n*sizeof( char_type ) );
   }
 
   static void CopyOverlapped( char_type* dst, const char_type* src, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || dst != nullptr && src != nullptr )
      ::memmove( dst, src, n*sizeof( char_type ) );
   }
 
   static int CompareCodePoints( const char_type* __restrict__ s1, size_type n1,
                                 const char_type* __restrict__ s2, size_type n2, bool caseSensitive = true ) noexcept
   {
      PCL_COMPARE_CODE_POINTS();
   }
 
   static int Compare( const char_type* __restrict__ s1, size_type n1,
                       const char_type* __restrict__ s2, size_type n2, bool caseSensitive = true, bool localeAware = true ) noexcept
   {
      return CompareCodePoints( s1, n1, s2, n2, caseSensitive );
   }
 
   static bool WildMatch( const char_type* __restrict__ t, size_type nt,
                          const char_type* __restrict__ p, size_type np, bool caseSensitive = true ) noexcept
   {
      if ( caseSensitive )
         return pcl::WildMatch( t, nt, p, np );
      return pcl::WildMatchIC( t, nt, p, np, ToCaseFolded, ToCaseFolded );
   }
 
   static char_type ToCaseFolded( char_type c ) noexcept
   {
      return ToLowercase( c );
   }
 
   static constexpr char_type ToLowercase( char_type c ) noexcept
   {
      return (c >= char_type(  65 ) && c <= char_type(  90 )
           || c >= char_type( 192 ) && c <= char_type( 214 )
           || c >= char_type( 216 ) && c <= char_type( 222 )) ? c + 32 : c;
   }
 
   static constexpr char_type ToUppercase( char_type c ) noexcept
   {
      return (c >= char_type(  97 ) && c <= char_type( 122 )
           || c >= char_type( 224 ) && c <= char_type( 246 )
           || c >= char_type( 248 ) && c <= char_type( 254 )) ? c - 32 : c;
   }
 
   static void ToLowercase( char_type* __restrict__ s, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n, ++s )
         *s = ToLowercase( *s );
   }
 
   static void ToUppercase( char_type* __restrict__ s, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n, ++s )
         *s = ToUppercase( *s );
   }
 
   static constexpr char_type Null() noexcept
   {
      return char_type( 0 );
   }
 
   static constexpr char_type Blank() noexcept
   {
      return char_type( ' ' );
   }
 
   static constexpr char_type Tab() noexcept
   {
      return char_type( '\t' );
   }
 
   static constexpr char_type CR() noexcept
   {
      return char_type( '\r' );
   }
 
   static constexpr char_type LF() noexcept
   {
      return char_type( '\n' );
   }
 
   static constexpr char_type Comma() noexcept
   {
      return char_type( ',' );
   }
 
   static constexpr char_type Colon() noexcept
   {
      return char_type( ':' );
   }
 
   static constexpr char_type Semicolon() noexcept
   {
      return char_type( ';' );
   }
 
   static constexpr char_type Hyphen() noexcept
   {
      return char_type( '-' );
   }
 
   static constexpr char_type PlusSign() noexcept
   {
      return char_type( '+' );
   }
 
   static constexpr char_type MinusSign() noexcept
   {
      return char_type( '-' );
   }
 
   static constexpr char_type DecimalSeparator() noexcept
   {
      return char_type( '.' );
   }
 
   static constexpr char_type ExponentDelimiter() noexcept
   {
      return char_type( 'e' );
   }
 
   static constexpr char_type Underscore() noexcept
   {
      return char_type( '_' );
   }
 
   static constexpr char_type SingleQuote() noexcept
   {
      return char_type( '\'' );
   }
 
   static constexpr char_type DoubleQuote() noexcept
   {
      return char_type( '\"' );
   }
 
   static constexpr bool IsNull( char_type c ) noexcept
   {
      return c == Null();
   }
 
   static constexpr bool IsSpace( char_type c ) noexcept
   {
      return c == Blank() || c == Tab() || c == CR() || c == LF();
   }
 
   static constexpr bool IsTrimable( char_type c ) noexcept
   {
      return IsSpace( c );
   }
 
   static constexpr bool IsDigit( char_type c ) noexcept
   {
      return c >= char_type( '0' ) && c <= char_type( '9' );
   }
 
   static constexpr bool IsHexDigit( char_type c ) noexcept
   {
      return IsDigit( c ) || c >= char_type( 'A' ) && c <= char_type( 'F' ) ||
                             c >= char_type( 'a' ) && c <= char_type( 'f' );
   }
 
   static constexpr bool IsAlpha( char_type c ) noexcept
   {
      return IsLowercaseAlpha( c ) || IsUppercaseAlpha( c );
   }
 
   static constexpr bool IsLowercaseAlpha( char_type c ) noexcept
   {
      return c >= char_type( 'a' ) && c <= char_type( 'z' );
   }
 
   static constexpr bool IsUppercaseAlpha( char_type c ) noexcept
   {
      return c >= char_type( 'A' ) && c <= char_type( 'Z' );
   }
 
   static constexpr bool IsUnderscore( char_type c ) noexcept
   {
      return c == Underscore();
   }
 
   static constexpr bool IsSymbolDigit( char_type c ) noexcept
   {
      return IsAlpha( c ) || IsDigit( c ) || IsUnderscore( c );
   }
 
   static constexpr bool IsStartingSymbolDigit( char_type c ) noexcept
   {
      return IsAlpha( c ) || IsUnderscore( c );
   }
 
   static constexpr bool IsSign( char_type c ) noexcept
   {
      return c == MinusSign() || c == PlusSign();
   }
 
   static constexpr bool IsDecimalSeparator( char_type c ) noexcept
   {
      return c == DecimalSeparator();
   }
 
   static constexpr bool IsExponentDelimiter( char_type c ) noexcept
   {
      return c == char_type( 'e' ) || c == char_type( 'E' ) || c == char_type( 'd' ) || c == char_type( 'D' );
   }
 
   static constexpr bool IsWildcard( char_type c ) noexcept
   {
      return c == char_type( '*' ) || c == char_type( '?' );
   }
 
   template <typename Ptr1, typename Ptr2>
   static Ptr1 SearchTrimLeft( Ptr1 i, Ptr2 j ) noexcept
   {
      for ( ; i < j && IsTrimable( *i ); ++i ) {}
      return i;
   }
 
   template <typename Ptr1, typename Ptr2>
   static Ptr2 SearchTrimRight( Ptr1 i, Ptr2 j ) noexcept
   {
      for ( ; i < j && IsTrimable( *(j-1) ); --j ) {}
      return j;
   }
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS IsoCharTraits : public GenericCharTraits<char>
{
public:
 
   using traits_base = GenericCharTraits<char>;
 
   using char_type = traits_base::char_type;
 
   static constexpr size_type Length( const char_type* __restrict__ s ) noexcept
   {
      return (s != nullptr) ? ::strlen( s ) : 0;
   }
 
   static void Fill( char_type* __restrict__ s, char_type c, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      ::memset( s, c, n );
   }
 
   static void Copy( char_type* __restrict__ dst, const char_type* __restrict__ src, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || dst != nullptr && src != nullptr )
      ::memcpy( dst, src, n );
   }
 
   static void CopyOverlapped( char_type* dst, const char_type* src, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || dst != nullptr && src != nullptr )
      ::memmove( dst, src, n );
   }
 
   static int CompareCodePoints( const char_type* __restrict__ s1, size_type n1,
                                 const char_type* __restrict__ s2, size_type n2, bool caseSensitive = true ) noexcept
   {
      PCL_COMPARE_CODE_POINTS();
   }
 
   static int Compare( const char_type* __restrict__ s1, size_type n1,
                       const char_type* __restrict__ s2, size_type n2, bool caseSensitive = true, bool localeAware = true ) noexcept;
 
   static bool WildMatch( const char_type* __restrict__ t, size_type nt,
                          const char_type* __restrict__ p, size_type np, bool caseSensitive = true ) noexcept
   {
      if ( caseSensitive )
         return pcl::WildMatch( t, nt, p, np );
      return pcl::WildMatchIC( t, nt, p, np,
                               []( char_type c ) { return ToCaseFolded( c ); },
                               []( char_type c ) { return ToCaseFolded( c ); } );
   }
 
   static char_type ToCaseFolded( char_type c ) noexcept
   {
      return ToLowercase( c );
   }
 
   static char_type ToLowercase( char_type c ) noexcept
   {
      return char_type( PCL_toLowercaseLatin1[uint8( c )] );
   }
 
   static char_type ToUppercase( char_type c ) noexcept
   {
      return char_type( PCL_toUppercaseLatin1[uint8( c )] );
   }
 
   static void ToCaseFolded( char_type* s, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n, ++s )
         *s = ToCaseFolded( *s );
   }
 
   static void ToLowercase( char_type* s, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n, ++s )
         *s = ToLowercase( *s );
   }
 
   static void ToUppercase( char_type* s, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n, ++s )
         *s = ToUppercase( *s );
   }
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS CharTraits : public GenericCharTraits<char16_type>
{
public:
 
   using traits_base = GenericCharTraits<char16_type>;
 
   using char_type = traits_base::char_type;
 
   static size_type Length( const char_type* __restrict__ s ) noexcept
   {
#ifdef __PCL_WINDOWS
      return (s != nullptr) ? ::wcslen( reinterpret_cast<const wchar_t*>( s ) ) : 0u;
#else
      return traits_base::Length( s );
#endif
   }
 
   static void Copy( char_type* __restrict__ dst, const char_type* __restrict__ src, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || dst != nullptr && src != nullptr )
      ::memcpy( dst, src, n << 1 );
   }
 
   static void CopyOverlapped( char_type* dst, const char_type* src, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || dst != nullptr && src != nullptr )
      ::memmove( dst, src, n << 1 );
   }
 
   static int CompareCodePoints( const char_type* __restrict__ s1, size_type n1,
                                 const char_type* __restrict__ s2, size_type n2, bool caseSensitive = true ) noexcept
   {
      PCL_COMPARE_CODE_POINTS();
   }
 
   static int Compare( const char_type* __restrict__ s1, size_type n1,
                       const char_type* __restrict__ s2, size_type n2, bool caseSensitive = true, bool localeAware = true ) noexcept;
 
   static bool WildMatch( const char_type* __restrict__ t, size_type nt,
                          const char_type* __restrict__ p, size_type np, bool caseSensitive = true ) noexcept
   {
      if ( caseSensitive )
         return pcl::WildMatch( t, nt, p, np );
      return pcl::WildMatchIC( t, nt, p, np,
                               []( char_type c ) { return ToCaseFolded( c ); },
                               []( char_type c ) { return ToCaseFolded( c ); } );
   }
 
   static bool WildMatch( const char_type* __restrict__ t, size_type nt,
                          const char* __restrict__ p, size_type np, bool caseSensitive = true ) noexcept
   {
      if ( caseSensitive )
         return pcl::WildMatch( t, nt, p, np );
      return pcl::WildMatchIC( t, nt, p, np,
                               []( char_type c ) { return ToCaseFolded( c ); },
                               []( char c ) { return IsoCharTraits::ToCaseFolded( c ); } );
   }
 
   static char_type ToCaseFolded( char_type c ) noexcept
   {
      if ( c < 256 )
      {
         if ( c >= 65 && c <= 90 || c >= 192 && c <= 214 || c >= 216 && c <= 222 )
            return c + 32;
         return c;
      }
      return PCL_ToCaseFolded( c );
   }
 
   static char_type ToLowercase( char_type c ) noexcept
   {
      if ( c < 256 )
      {
         if ( c >= 65 && c <= 90 || c >= 192 && c <= 214 || c >= 216 && c <= 222 )
            return c + 32;
         return c;
      }
      return PCL_ToLowercase( c );
   }
 
   static char_type ToUppercase( char_type c ) noexcept
   {
      if ( c < 256 )
      {
         if ( c >= 97 && c <= 122 || c >= 224 && c <= 246 || c >= 248 && c <= 254 )
            return c - 32;
         return c;
      }
      return PCL_ToUppercase( c );
   }
 
   static void ToCaseFolded( char_type* s, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n, ++s )
         *s = ToCaseFolded( *s );
   }
 
   static void ToLowercase( char_type* s, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n, ++s )
         *s = ToLowercase( *s );
   }
 
   static void ToUppercase( char_type* s, size_type n ) noexcept
   {
      PCL_PRECONDITION( n == 0 || s != nullptr )
      for ( ; n > 0; --n, ++s )
         *s = ToUppercase( *s );
   }
 
   static constexpr bool IsHighSurrogate( char_type c16 ) noexcept
   {
      return (c16 & 0xFC00) == 0xD800;
   }
 
   static constexpr char_type HighSurrogate( char32_type c32 ) noexcept
   {
      return char_type( (c32 >> 10) + 0xD7C0 );
   }
 
   static constexpr bool IsLowSurrogate( char_type c16 ) noexcept
   {
      return (c16 & 0xFC00) == 0xDC00;
   }
 
   static constexpr char_type LowSurrogate( char32_type c32 ) noexcept
   {
      return char_type( (c32%0x400) + 0xDC00 );
   }
 
   static constexpr char32_type SurrogatePairToUTF32( char_type high, char_type low ) noexcept
   {
      return (char32_type( high ) << 10) + low - 0x035FDC00;
   }
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_CharTraits_h
 
// ----------------------------------------------------------------------------
// EOF pcl/CharTraits.h - Released 2024-01-13T15:47:58Z