sml/string.h

Go to the documentation of this file.

/******************************************************************************
 *
 * \file sml/sml.h
 * \brief SML string class
 *
 * \if NODOC
 * $Log: string.h_v $
 * Revision 1.4  2008/10/23 20:38:13  scowan
 * Moved function prototypes from sml include file.
 *
 * Revision 1.3  2007/08/02 20:42:07  dwilliss
 * const
 *
 * Revision 1.2  2007/05/08 15:46:22  dwilliss
 * SML namespace
 *
 * Revision 1.1  2007/05/04 20:44:34  dwilliss
 * Initial revision
 *
 * \endif
*/
/*****************************************************************************/

#ifndef INC_SML_STRING_H
#define INC_SML_STRING_H

#ifndef INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

#ifndef INC_MI32_USERDATA_H
#include <sml/userdata.h>
#endif

#ifdef RVCSYSDLL
   #define RVCSYSLIBEXPORT MI_DLLEXPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSEXPORT
#else
   #define RVCSYSLIBEXPORT MI_DLLIMPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSIMPORT
#endif

namespace SML {
union ARG;
class FLAG;
class PARM;

/***************************************************************************/
class RVCSYSLIBCLASSEXPORT STRING : public MISTRING {

   #if defined (RVCSYSDLL)
   public:
   #else
   private:
   #endif

#ifndef GENERATING_DOXYGEN_OUTPUT

   STRING (
      );

   STRING (
      const char *s
      );

   STRING (
      const void *s,
      CHAR_ENCODING encoding
      );

   STRING (
      const MIUNICODE *s
      );

   STRING (
      const UINT8 *s
      );

   STRING (
      const STRING& rhs
      );

private:
   
   virtual ~STRING();

#endif // GENERATING_DOXYGEN_OUTPUT
public:

   void AttachUserData (
      USERDATA* data
      );

   void DetachUserData (
      USERDATA* data
      );


   USERDATA* GetUserData (
      USERDATA::TAG tag
      );

   void AddRef ();

   void Release ();

   int FlagTextToValueSingle (
      const FLAG *flags,      
      UINT32 *FlagVal      
      ) const;

   int FlagTextToValueSingle (
      const PARM *flags,      
      UINT32 *FlagVal      
      ) const;

   int FlagTextToValueMultiple (
      const FLAG *flags,      
      UINT32 *FlagVal      
      ) const;

   int FlagTextToValueMultiple (
      const PARM *flags,      
      UINT32 *FlagVal      
      ) const;

   int FlagValueToTextSingle (
      const FLAG *flags,      
      UINT32 *FlagVal      
      );

   int FlagValueToTextSingle (
      const PARM *flags,      
      UINT32 *FlagVal      
      );

   int FlagValueToTextMultiple (
      const FLAG *flags,      
      UINT32 *FlagVal      
      );

   int FlagValueToTextMultiple (
      const PARM *flags,      
      UINT32 *FlagVal      
      );

#ifndef GENERATING_DOXYGEN_OUTPUT
#ifdef RVCSYSDLL
   // Old versions which we need to export for a while (until about 6 Aug 07)
   // but don't want other code to use yet
   int FlagTextToValueSingle (
      FLAG *flags,      
      UINT32 *FlagVal      
      );

   int FlagTextToValueSingle (
      PARM *flags,      
      UINT32 *FlagVal      
      );

   int FlagTextToValueMultiple (
      FLAG *flags,      
      UINT32 *FlagVal      
      );

   int FlagTextToValueMultiple (
      PARM *flags,      
      UINT32 *FlagVal      
      );

   int FlagValueToTextSingle (
      FLAG *flags,      
      UINT32 *FlagVal      
      );

   int FlagValueToTextSingle (
      PARM *flags,      
      UINT32 *FlagVal      
      );

   int FlagValueToTextMultiple (
      FLAG *flags,      
      UINT32 *FlagVal      
      );

   int FlagValueToTextMultiple (
      PARM *flags,      
      UINT32 *FlagVal      
      );
#endif
#endif

   DEPRECATED_MSG("Just construct a STRUTF8 from *smlstr") STRUTF8 GetSTRUTF8 (
      ) const;

   DEPRECATED_MSG("Use Assign instead") void SetString (
      const char* str
      );

private:
#ifndef GENERATING_DOXYGEN_OUTPUT
   int m_refcount;
   USERDATACONTAINER m_userdata;

   friend class CONTEXT;   // to shut up VC7 warning about having private dtor and no friends.  Dtor is called by DecRefCound when refcount is decremented to 0.
#endif // GENERATING_DOXYGEN_OUTPUT
   };

RVCSYSLIBEXPORT void PrintfSubMISTRING (
   MISTRING& output, 
   int numargs,      
   SML::ARG *args,      
   UINT8 *type       
   );
   
} // end of SML namespace

typedef SML::STRING SMLSTRING;
#define _SML_PrintfSubMISTRING SML::PrintfSubMISTRING

#undef RVCSYSLIBEXPORT
#undef RVCSYSLIBCLASSEXPORT

#endif      //  INC_SML_STRING_H

---