StrClass.h

Go to the documentation of this file.

// WEP  3/31/2005  \will120\Include\StrClass.h

#ifndef __STRCLASS_H
#define __STRCLASS_H

#ifndef __MACROS_H
#include "Macros.h"
#endif

#ifndef __ALLOCATE_H
#include "Allocate.h"
#endif

class Time;

#define STRINGALLOC( baz )          (char *)AllocString((size_t)baz )
#define STRINGFREE( baz )           {if (baz){FreeString( baz );baz=NULL;}}
#define STRINGSIZE                  255

#define periodch '.' //these were for linked file matchnames v10.01 v10.02,
#define periodch_r ((char)255)
#define pathch_r ((char)254)
#define quotech '\"' //this now seperates linked file matchnames v10.03

#ifdef _OSX
#define NATIVESEPARATOR '/'
#elif defined(_OS9)
#define NATIVESEPARATOR ':'
#else
#define NATIVESEPARATOR '\\' 
#endif

class CWnd;

class FILEIOEXPORT String {
public:
   char *buf;             // SHOULD CHANGE THIS TO PROTECTED OR PRIVATE

#if _MEMDEBUG
   void *operator new( size_t size, char *file, const int line ) { return ALLOCACT( size, file, line ); }
#else
   void *operator new( size_t size ) { return AllocAct( size ); }
#endif   
   void  operator delete( void *ptr ) { FreeAct( ptr ); }

   String() { buf = NULL; }

   String( int size, BOOL unused ) { buf = STRINGALLOC(size); }

   String( const String & );
   String( const char * );                 // CONVERT CHAR * TO STRING
   String( char );
   String( SWORD );
   String( ULONG );
   String( LONG );
   String( float );
   String( double );
   String( float, float precision );
   String( int );
   String( char, int count );
   void Set(const char *other, int len );
   ~String() { STRINGFREE( buf ); buf = NULL; }
   char *Get() const { return buf; }
   char operator [] ( int index ) const
   {
      if (buf)
         return buf[index];
      else
         return 0;
   }
//   operator char * () const;         // CONVERT STRING TO CHAR *, THE CAN'T USE COMPILER OFTEN GETS CONFUSED ON WHICH OVERLOADED FUNCTION TO CALL

   BOOL IsEmpty() const { return (buf == NULL) || (*buf=='\0'); }
   void Empty() { STRINGFREE( buf ); buf = NULL; }
   BOOL operator==( const String & ) const;
   BOOL operator!=( const String &other ) const { return !(*this == other); }
   String &operator=( const String & );  
   String &operator=( const char * );  
   void operator+=( const String & );
   size_t length() const;

   String Left( int count ) const;
   String Right( int count ) const;
   String Mid( int start, int count ) const;
   String ToUpper() const;
   String ToLower() const;
   String GetPathOnly() const;
   String GetNameOnly() const;
   String GetSuffixOnly() const;
   String GetWithoutSuffix() const;
   String GetNameOnlyWithoutSuffix() const;
   String GetWithoutDigits() const;
   String GetFileDigits() const;
   int    GetEndingNumber() const;
   String GetWithoutCRLFs() const;
   String GetAbbreviated( int cchMax, BOOL bAtLeastName = TRUE ) const;
   String GetAbbreviated( CWnd *window ) const;
   String GetRelativePath() const; //Always UNC
   String GetNonRelativePath() const;
   String GetAbsolutePath() const;
   String GetAbsolutePath(BOOL forceunc) const;
   String GetUNCFileName() const;
   String GetServerFileName() const;
   String NumberFrame(LONG frame) const;
   String StripLeadingSlash() const;
   String StripPunctuation();
   String NetSharePlaceHolder() const;
   String GetFileNamesMatchName() const; //assumes string is an UNC filename on pc for speed
   String GetMatchNameRelativeForFile() const;
   String GetMatchNameAbsoluteFromFile() const;
   void   ReplaceWackyForMac(char find, char replace); //only to convert v10.01 v10.02 files
   String ToRelativePathDescription() const;  //converts descriptions to linked files
   String ToAbsolutePathDescription( float productversion, BOOL &askforfile ) const;
   
   PLUGINEXPORT float  GetCM() const;
   String FitWidth(CDC *dc, int maxwidth, const String &padwith) const;

   String GetEncrypted( String password ) const;
   void   Decrypt( String password );

   BOOL operator < ( const String & ) const;
   BOOL operator > ( const String & ) const;
   BOOL operator <= ( const String & ) const;
   BOOL operator >= ( const String & ) const;
   friend String operator + ( const String &, const String & );

   void TrimRight();                      // new functions like MFC CString
   void TrimLeft();
   int Find(char ch) const;               // like "C" strchr -1 if not found
   int Find(int startindex, char ch) const;
   int Find(const String &sub) const;     // like "C" strstr
   int Find(int startindex, const String &sub) const;     // like "C" strstr
   int ReverseFind(char ch) const;
   void Format(const String &format, ...);
   int FindOneOf(const String &charset) const;
   String SpanIncluding(const String &charset) const;
   String SpanExcluding(const String &charset) const;
   void Replace(const String &find, const String &replace);
   String GetFileTitle() const;
   String GetToolTip();
   String GetStatusMessageText();
   Time ToTime(int fps, int timeunits, BOOL treatasdelta=FALSE) const;

   static String GetAppPath();
   static String GetOsPath();
   static String GetTempPath();
   static String GetAppDataPath();
   
   FILEIOEXPORT friend String GetRegisteredOwner();
   String StrTok(String separators);

};

inline String::String( const String &init )
{
   if (init.buf && (buf = STRINGALLOC((init.length()+1 ))))
      strcpy( buf, init.buf ); 
   else
      buf = NULL;    
}

inline String::String( const char *init )
{
   if (init && (buf = STRINGALLOC((strlen(init)+1 ))))
      strcpy( buf, init );
   else
      buf = NULL;    
}

inline String::String( char init )
{
   if (buf = STRINGALLOC( 2 )) {
      buf[0] = init;
      buf[1] = '\0';
   }   
}

inline String::String( char init, int count )
{
   if ( buf = STRINGALLOC(( count+1 ))) {
      for (int i = 0; i < count; ++i)
         buf[i] = init;
      buf[count] = '\0';
   }   
}

inline String::String( SWORD number )
{
   char init[20];
   
   sprintf( init, "%hd", number );
   if (buf = STRINGALLOC(( strlen(init)+1 )))
      strcpy( buf, init ); 
}

inline String::String( LONG number )
{
   char init[20];
   
   sprintf( init, "%ld", number );
   if (buf = STRINGALLOC(( strlen(init)+1 )))
      strcpy( buf, init ); 
}

inline String::String( ULONG number )
{
   char init[20];
   
   sprintf( init, "%lu", number );
   if (buf = STRINGALLOC(( strlen(init)+1 )))
      strcpy( buf, init ); 
}

inline String::String( float number )
{
   char init[20];
   
   sprintf( init, "%g", number );
   if (buf = STRINGALLOC(( strlen(init)+1 )))
      strcpy( buf, init ); 
}

inline String::String( double number )
{
   char init[20];
   
   sprintf( init, "%g", number );
   if (buf = STRINGALLOC(( strlen(init)+1 )))
      strcpy( buf, init ); 
}

inline String::String( float number, float precision )
{
   char init[20];

   Round( number, precision );
/*
   double dnum = number;  // same code as Round()
   double modulo = precision;
   dnum += SIGN(dnum) * 0.5 * modulo;
   dnum -= fmod(dnum, modulo);
   number = (float)dnum;
*/
   sprintf( init, "%g", number );
   if (buf = STRINGALLOC(( strlen(init)+1 )))
      strcpy( buf, init ); 
}

inline String::String( int number )
{
   char init[20];
   
   sprintf( init, "%d", number );
   if (buf = STRINGALLOC(( strlen(init)+1 )))
      strcpy( buf, init ); 
}

inline size_t String::length() const
{
   if(buf)
      return strlen(buf); 
   else
      return 0;   
}

inline String operator + ( const String &left, const String &right )
{
   String result( left );
   result += right;
   return result;
}   

inline String &String::operator=(const char *other )
{
   STRINGFREE(buf);
   if (other && (buf = STRINGALLOC((strlen(other)+1 ))))
      strcpy( buf, other );
   else
      buf = NULL;
   return *this;
}

inline void String::Set(const char *other, int len )
{
   STRINGFREE(buf);
   if (other && len && (buf = STRINGALLOC(len+1 ))) {
      memcpy( buf, other, len );
      buf[len] = '\0';
   }
   else
      buf = NULL;
}

inline BOOL String::operator==(const String &other ) const 
{
   if (buf == NULL)
      return (other.buf == NULL);
   if (other.buf == NULL)
      return FALSE;
   return ( _stricmp( buf, other.buf ) == 0);
}

FILEIOEXPORT String FormatTime(LONG sec, BOOL force = FALSE);
void StripOffName( String & );
FILEIOEXPORT void AddNameToPath( String &, const String & );
FILEIOEXPORT String CombineNameToPath(const String &path, const String &name);
FILEIOEXPORT String AddNameToExeDirectory(String name);
FILEIOEXPORT String AddNameToDataDirectory(String name);
FILEIOEXPORT void FreeAppPath();

FILEIOEXPORT void AFXAPI DDX_Text(CDataExchange* pDX, int nIDC, String& value);
FILEIOEXPORT String NativeToUniversal( const String &nativepath );
FILEIOEXPORT String UniversalToNative( const String &puniversalpath );

enum { UNIT_NONE, UNIT_CENTIMETERS, UNIT_METERS, UNIT_FEET, UNIT_INCHES, UNIT_FEETANDINCHES, UNIT_PERCENTAGE, UNIT_ANGLE, UNIT_SMPTE, UNIT_FRAMES };
PLUGINEXPORT int GetMeasurementUnits();
PLUGINEXPORT void SetMeasurementUnits( int pmeasurementunits );
PLUGINEXPORT CString UnitToString( float cm, int pmeasurementunits=-1, int fps=-1, float modulo=.01f );
PLUGINEXPORT void AFXAPI DDX_Unit(CDataExchange *pDX, int nIDC, float &cm);
PLUGINEXPORT void AFXAPI DDV_MinMaxUnit(CDataExchange* pDX, float const& value, float minVal, float maxVal);

#endif  // __STRCLASS_H

---