vlString.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 1992-2025 MAK Technologies, Inc
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vlutil/vlMachineTypes.h>
#include <vector>
#include <iosfwd>

#if _MSC_VER >= 1920 //VC16 2019
#include <xstring>
#endif

#if __has_include(<compare>)
#  include <compare>
#  if defined(__cpp_lib_three_way_comparison) && __cpp_lib_three_way_comparison >= 201907
#    define DtSPACESHIP_OPERATOR_IS_SUPPORTED 1
#  endif
#endif

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

   class DT_DLL_VLUTIL DtString
   {
   public:

      DtString();

      DtString( const char* str );

      DtString( const char* str, int length );

      DtString( const std::string& str );

      DtString( const DtString& orig );


      DtString( double val );
      DtString( int val );
      DtString( long val );
      DtString( char val );
      DtString( unsigned int val );
      DtString( unsigned long val );


      virtual ~DtString();


      virtual DtString& operator = ( const char* orig );
      virtual DtString& operator = ( const DtString& orig );


      [[deprecated("Use c_str() instead.")]] virtual operator const char*() const;

      virtual DtString* clone() const;


      friend DT_DLL_VLUTIL bool operator < ( const DtString& str1, const DtString& str2 );
      friend DT_DLL_VLUTIL bool operator > ( const DtString& str1, const DtString& str2 );
      friend DT_DLL_VLUTIL bool operator == ( const DtString& str1, const DtString& str2 );
      friend DT_DLL_VLUTIL bool operator != ( const DtString& str1, const DtString& str2 );
      friend DT_DLL_VLUTIL bool operator <= ( const DtString& str1, const DtString& str2 );
      friend DT_DLL_VLUTIL bool operator >= ( const DtString& str1, const DtString& str2 );

      virtual bool operator < ( const char* str ) const;
      virtual bool operator > ( const char* str ) const;
      virtual bool operator == ( const char* str ) const;
      virtual bool operator != ( const char* str ) const;
      virtual bool operator <= ( const char* str ) const;
      virtual bool operator >= ( const char* str ) const;

#if DtSPACESHIP_OPERATOR_IS_SUPPORTED
   // Note:  Since DtString implicitly casts to const char*, this operator is necessary to prevent
   // the pointer version of <=> from being used which will compare memory addresses instead of string contents.
      std::strong_ordering operator<=>(const DtString& s1, const DtString& s2)
      {
         if (s1 == s2) return std::strong_ordering::equal;
         if (s1 < s2) return std::strong_ordering::less;
         return std::strong_ordering::greater;
      }
#endif



      virtual bool caseCompare(const char* str) const;
      virtual bool caseCompare(const DtString& str) const;



      friend DT_DLL_VLUTIL DtString operator + ( const char* str1, const DtString& str2 );
      friend DT_DLL_VLUTIL DtString operator + ( const DtString& str1, const DtString& str2 );

      virtual DtString operator + ( const char* str ) const;
      virtual DtString& operator += ( const char* str );
      virtual DtString& operator += ( const DtString& str );



      virtual char& operator [] ( int index );
      virtual const char& operator [] ( int index ) const;



      virtual bool snipFront( const char ch, bool toLastCh = false );
      virtual bool snipBack( const char ch, bool fromFirstCh = false );


      virtual bool chompFront();
      virtual bool chompBack();

      virtual void tokenize( const char delimiter, std::vector<DtString>& tokens ) const;

      virtual int toInt( bool* ok = 0 ) const;

      virtual unsigned int toUInt( bool* ok = 0 ) const;

      virtual float toFloat( bool* ok = 0 ) const;

      virtual double toDouble( bool* ok = 0 ) const;

      virtual bool toBoolean( bool* ok = 0 ) const;

      virtual void toUpper();

      virtual void toLower();

      virtual int findChar( const char ch );

      virtual int findLastChar( const char ch );

      virtual int findString( const DtString& string ) const;

      virtual int findLastString( const DtString& string );

      bool snipFrontToLast( const char ch )
      {
         return snipFront( ch, true );
      }

      bool snipBackToFirst( const char ch )
      {
         return snipBack( ch, true );
      }

      virtual int count( const char ch ) const;

      virtual int length() const;

      virtual int size() const;

      virtual std::string stdString() const;

      virtual const char* string() const;

      virtual const char* c_str() const;

      virtual bool isEmpty() const;

      virtual DtString section(const char sep, int start, int end = -1) const;

   public:

      static const DtString& nullString();

      static const DtString& nullId();

   protected:

      friend DT_DLL_VLUTIL std::ostream& operator << ( std::ostream& os, const DtString& str );
      friend DT_DLL_VLUTIL std::istream& operator >> ( std::istream& is, DtString& str );

      void clear();

      void setString( const char* str );

   protected:

      enum
      {
         theDefaultBufferSize = 64
      };

      char myDefaultBuffer[theDefaultBufferSize]; 
      char* myString; 
      bool myStringAlloced; 
      unsigned int myBufSize; 

      static const int theMaxInsertionStringSize;

   };


   inline bool DtString::isEmpty() const
   {
      return (myString[0] == '\0');
   }

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif