dtk_string.hpp

Go to the documentation of this file.

#ifdef A93938D6857511E1B78E58294824019B
#    include "util/external/dtk_string_alt.hpp"
#else
 
#ifndef __DTK_STRING_HPP__
#define __DTK_STRING_HPP__
 
#ifdef _MSC_VER
#    pragma warning(disable:4786)
#    pragma warning(disable:4800)
#endif
 
#include <math.h>
#include "def/define.h"
#include "util/util_stl_dtk.hpp"
 
#include "dtk/config.hpp"
 
#include <cstdio>
#include <iosfwd>
#include <string>
 
 
 
#ifdef _MSC_VER
#    if (_MSC_VER > 1200)
#         define Dtk_defined__wchar_t
#    endif
#endif
class Dtk_status;
#if ( defined(Dtk_defined__wchar_t) && defined(_NATIVE_WCHAR_T_DEFINED) )
//#pragma message("_NATIVE_WCHAR_T_DEFINED")
#    define w_str _w_str_w
#else
#    define w_str _w_str_us
#endif
 
#define DTK_A Dtk_string(L"a")
#define DTK_AB Dtk_string(L"ab")
#define DTK_RB Dtk_string(L"rb")
#define DTK_RBP Dtk_string(L"rb+")
#define DTK_R Dtk_string(L"r")
#define DTK_W Dtk_string(L"w")
#define DTK_WP Dtk_string(L"w+")
#define DTK_WB Dtk_string(L"wb")
#define DTK_WBP Dtk_string(L"wb+")
#define DTK_RW Dtk_string(L"rw")
 
 
 
class Dtk_string
{
public:
     typedef size_t Size_t;
protected:
     Dtk_WChar_t                        *    m_Str;
     mutable char                  *    m_CStr;
     //This fields holds in memory the value of wcslen(m_Str). Caution : it may not be updated in case of user manipulation, if so, the Dtk_string is flagged as dirty (see isDirty()).
     //Due to the use of the last byte to hold this flag, any Dtk_string of size > 2^8 will wrongly be considered dirty
     mutable Size_t                     m_StrSize;
     mutable Size_t                     m_CStrSize;
private:
     void init();
     void UpdateLen() const;
protected:
     void _FillFromCharBuffer( const char* inBuffer, const Dtk_Size_t inSize = ( Dtk_Size_t )-1 );
 
public:
     ~Dtk_string();
     Dtk_string();
     Dtk_string( const char *s );
     Dtk_string( const char* s, const Dtk_Size_t& inCount );
 
     Dtk_string( const Dtk_string & );
 
#ifndef DTK_NO_CXX11_RVALUE_REFERENCES
     Dtk_string( Dtk_string && s ) DTK_NOEXCEPT : m_Str( s.m_Str ), m_CStr( s.m_CStr ), m_StrSize( s.m_StrSize ), m_CStrSize( s.m_CStrSize )
     {
          s.m_Str = 0;
          s.m_CStr = 0;
          s.m_StrSize = 0;
          s.m_CStrSize = 0;
     }
 
     Dtk_string& operator=( Dtk_string && s ) DTK_NOEXCEPT
     {
          if( this != &s )
          {
               delete[] m_Str;
               delete[] m_CStr;
               m_Str = s.m_Str;
               m_CStr = s.m_CStr;
               m_StrSize = s.m_StrSize;
               m_CStrSize = s.m_CStrSize;
 
               s.m_Str = 0;
               s.m_CStr = 0;
               s.m_StrSize = 0;
               s.m_CStrSize = 0;
          }
 
          return *this;
     }
#endif
     //Dtk_string(const int);
     Dtk_string( const double dbl_val );
     Dtk_string( const double dbl_val, Dtk_Int32 inWithMorePrecision );
     Dtk_string( const float float_val );
     void RawCopyFromASCII( const char * inStrToBeCopied, const Dtk_Size_t inCount = -1 );
     /*************************************/
     const char * c_str() const;
 
     void Split( const Dtk_string& inDelimiters, Dtk_tab<Dtk_string>& outResults ) const;
     void Split( Dtk_WChar_t * inDelimiters, Dtk_tab<Dtk_string>& outResults ) const;
 
#if ( defined(Dtk_defined__wchar_t))
     const unsigned short * _w_str_us() const;
     const __wchar_t * _w_str_w() const;
     Dtk_string( const unsigned short *s );
     Dtk_string( const __wchar_t *s );
     void get_wchar( unsigned short * str ) const;
     void get_wchar( __wchar_t * str ) const;
 
     int cmp( const unsigned short *s2 ) const;
     int cmp( const __wchar_t *s2 ) const;
     int ncmp( const unsigned short *s2, const int count ) const;
     int ncmp( const __wchar_t *s2, const int count ) const;
     int icmp( const unsigned short *s2 ) const;
     int icmp( const __wchar_t *s2 ) const;
     int nicmp( const unsigned short *s2, const size_t size ) const;
     int nicmp( const __wchar_t *s2, const size_t size ) const;
#else
     const Dtk_WChar_t * w_str() const;
     Dtk_string( const Dtk_WChar_t *s );
     void get_wchar( Dtk_WChar_t * str ) const;
     int cmp( const Dtk_WChar_t *s2 ) const;
     int ncmp( const Dtk_WChar_t *s2, const int count ) const;
     int icmp( const Dtk_WChar_t *s2 ) const;
     int nicmp( const Dtk_WChar_t *s2, const size_t size ) const;
#endif
 
     Dtk_string& operator = ( const Dtk_string& s );
     Dtk_string& operator = ( const char* s );
 
     Dtk_string& operator = ( const float fltval );
     Dtk_string& operator = ( const double dbl_val );
 
     Dtk_WChar_t& operator[] ( int );
     const Dtk_WChar_t& operator[] ( int i ) const;
 
     //SetAsDeprecated( "2021.4", "Use clear() method instead" )
     void free_mem();
     Dtk_Size_t FileSize() const;
     Dtk_status ToDtkInt32( Dtk_Int32& outRes ) const;
     Dtk_status ToDtkDouble64( Dtk_Double64& outRes ) const;
 
     char * ToUTF8String() const;
 
     Dtk_string Substring( const Dtk_Size_t& inStartIndex, const Dtk_Size_t& inLength ) const;
     void clear();
 
     void convert_from_int( const int integer, int force_unsigned_int = 0 );
     void ConvertFromUTF8String( const char * inUTF8String );
 
     /*utils functions*/
     Dtk_bool is_NULL() const;
     Dtk_bool is_not_NULL() const;
     int len() const;
 
 
     //SetAsDeprecated( "2021.4", "This method is insecure. Use get_char(char * inoutStr, const Dtk_Size_t inBufferSize ) method instead" )
     Dtk_Size_t get_char( char * inoutStr ) const;
     void cat( const Dtk_string &s2 );
 
     void ToUpper();
 
     void ToLower();
 
     int cmp( const Dtk_string &s2 ) const;
     int ncmp( const Dtk_string &s2, const int count ) const;
     int icmp( const Dtk_string &s2 ) const;
     int nicmp( const Dtk_string &s2, const size_t size ) const;
     void cpy( Dtk_string s2 );
     void ncpy( const Dtk_string & s2, size_t size );
     int find_substring( const Dtk_string &s1 ) const;
     int find_first( int character ) const;
     int find_last( int character ) const;
     Dtk_string left( int pos ) const;
     Dtk_string right( int pos ) const;
     Dtk_string left_exclusive( int pos ) const;
     void LeftExclusive( const int& pos, Dtk_string& outRes ) const;
     Dtk_string right_exclusive( int pos ) const;
     void RightExclusive( const int& pos, Dtk_string& outRes ) const;
 
     void TrimCharacters( const Dtk_WChar_t inCharToBeTrimmed,
                               const Dtk_bool inTrimLeadingCharacters = DTK_TRUE,
                               const Dtk_bool inTrimTrailingCharacters = DTK_TRUE );
     inline void TrimLeadingCharacters( const Dtk_WChar_t inCharToBeTrimmed )
     {
          TrimCharacters( inCharToBeTrimmed, DTK_TRUE, DTK_FALSE );
     }
     inline void TrimTrailingCharacters( const Dtk_WChar_t inCharToBeTrimmed )
     {
          TrimCharacters( inCharToBeTrimmed, DTK_FALSE, DTK_TRUE );
     }
     inline void TrimLeadingAndTrailingCharacters( const Dtk_WChar_t inCharToBeTrimmed )
     {
          TrimCharacters( inCharToBeTrimmed, DTK_TRUE, DTK_TRUE );
     }
     int count_substring_occurrences( const Dtk_string &substring ) const;
     int count_char_occurrences( const int car ) const;
 
     //SetAsDeprecated( "2024.2", "" )
     int traite_nom_fichier(
          Dtk_string * drive,
          Dtk_string * path,
          Dtk_string * filename,
          Dtk_string * extension ) const;
     int replace( const int& old_char, const int& new_char );
     int removechar( const int& removed_char );
 
     Dtk_string drive() const;
     Dtk_string path() const;
     Dtk_string filename() const;
     Dtk_string extension() const;
     int test_extension( const Dtk_string &ext ) const;
 
     void FullPath( Dtk_string& outFullPath ) const;
 
     void FileNameExtension( Dtk_string& outFileNameExtension ) const;
 
     //int test_extension(const char *ext);
     //int test_extension(const wchar_t * ext);
     FILE * ouvrir_fichier( const Dtk_string &droits ) const;
 
     FILE * OpenFile( const Dtk_string &inRights ) const;
 
     int unlink() const;
     int mkdir() const;
     int rmdir() const;
     Dtk_bool existe_fichier() const;
     SetAsDeprecated( "2022.3", "Use FileSize() method instead" )
          long taille_fichier() const;
 
     inline static const char PathSeparatorChar()
     {
# if defined(_WIN32) || defined(__CYGWIN__) // Windows default, including MinGW and Cygwin
          return '\\';
# else
          return '/';
# endif
     }
     inline static const Dtk_WChar_t PathSeparatorWChar()
     {
# if defined(_WIN32) || defined(__CYGWIN__) // Windows default, including MinGW and Cygwin
          return L'\\';
# else
          return L'/';
# endif
     }
     inline static const Dtk_string PathSeparatorString()
     {
# if defined(_WIN32) || defined(__CYGWIN__) // Windows default, including MinGW and Cygwin
          return L"\\";
# else
          return "/";
# endif
     }
 
     void FixPathSeparator();
 
     friend Dtk_string operator + ( const Dtk_string &s1, const Dtk_string &s2 );
 
     void add_int( const int integer, int force_unsigned_int = 0 );
 
     void Merge( const Dtk_string &s2 );
     Dtk_string& operator += ( const Dtk_string &s2 );
 
     friend bool operator == ( const Dtk_string &s1, const Dtk_string &s2 );
     friend bool operator > ( const Dtk_string &s1, const Dtk_string &s2 );
     friend bool operator < ( const Dtk_string &s1, const Dtk_string &s2 );
     friend bool operator >= ( const Dtk_string &s1, const Dtk_string &s2 );
     friend bool operator <= ( const Dtk_string &s1, const Dtk_string &s2 );
     friend bool operator != ( const Dtk_string &s1, const Dtk_string &s2 );
     friend std::ostream& operator<<( std::ostream&, const Dtk_string& );
 
 
 
};
 
namespace Dtk_StringUtility
{
     std::string ToUtf8( Dtk_string const & );
 
     Dtk_string FromUtf8( char const * );
}
 
 
#endif // __DTK_STRING_HPP__
 
#endif // A93938D6857511E1B78E58294824019B