rvctext.h

Go to the documentation of this file.

/**
 * \file rvctext.h <mi32/rvctext.h>
 * \brief Definitions for RVC TEXT objects
 *
 * \if NODOC
 * $Id: rvctext.h_v 1.22 2004/03/11 17:31:47 mju Exp $
 *
 * $Log: rvctext.h_v $
 * Revision 1.22  2004/03/11 17:31:47  mju
 * Remove unused legacy obj selection dialog.
 *
 * Revision 1.21  2003/10/15 17:39:39  mju
 * Deprecate groupkey.
 *
 * Revision 1.20  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.19  2003/08/27 21:32:27  scowan
 * Removed functions to get linked file and other deprecated functions.
 *
 * Revision 1.18  2002/08/20 15:07:00  mju
 * Use prevent_memfunc().
 *
 * Revision 1.17  2002/05/08 22:03:37  scowan
 * Nothing.
 *
 * Revision 1.16  2002/03/27 15:33:05  mju
 * Remove MfPrintf functions except when compiling DLL.
 *
 * Revision 1.15  2002/03/11 18:15:35  scowan
 * Added methods a deprecated mem... functions.
 *
 * Revision 1.14  2001/09/14 14:58:40  mju
 * No Mdlg in win32native.
 *
 * Revision 1.13  2000/11/22 22:46:55  scowan
 * Add function to support wrapper class.
 *
 * Revision 1.12  2000/10/30 21:56:20  msmith
 * Genitor documentation.
 *
 * Revision 1.11  2000/08/24 21:47:51  scowan
 * *** empty log message ***
 *
 * Revision 1.10  2000/06/02 14:43:27  mju
 * Use const and default flags in MfTextWriteAll().
 *
 * Revision 1.9  2000/05/08 14:14:02  mju
 * Remove MfSeek/TellText prototypes except when compiling DLL.
 *
 * Revision 1.8  2000/03/29 03:27:28  scowan
 * Added assignment operators.
 *
 * Revision 1.7  2000/03/16 22:13:16  scowan
 * More const.
 *
 * Revision 1.6  1999/11/19 14:27:33  mju
 * MdlgGet... prompt const.
 *
 * Revision 1.5  1999/10/20  21:07:17  mju
 * Use const in WriteText fns.
 *
 * Revision 1.4  1999/10/05  22:48:42  scowan
 * Changed headers to use inheritance.
 *
 * Revision 1.3  1999/07/26 17:08:30  scowan
 * Added link file retrieve function.
 *
 * Revision 1.2  1999/06/14 13:34:54  mju
 * Add MdlgGetTextObject.
 *
 * Revision 1.1  1999/05/07  21:23:48  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_RVCTEXT_H
#define  INC_MI32_RVCTEXT_H

#ifndef  INC_MI32_RVCDEFNS_H
   #include <mi32/rvcdefns.h>
#endif

//! Forward Declaration
class MISTRING;

//! Text info class.
struct RVCTEXTINFO : public RVCGENINFO {
   UINT8 IsUnicode;                    //!< Unicode text
   UINT8 IsLink;                       //!< Link text
   #ifndef GENERATING_DOXYGEN_OUTPUT
   UINT8 spare_text[6];
   #endif //!< GENERATING_DOXYGEN_OUTPUT
   
   RVCTEXTINFO (
      ) {Clear();}
   
   RVCTEXTINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   RVCTEXTINFO& operator= (
      const RVCGENINFO& ginfo          //!< Text info class to copy from
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}
      
   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
   
   };

PREVENT_MEMFUNC(RVCTEXTINFO)

//! Query info class.
struct RVCQUERYINFO : public RVCTEXTINFO {
   UINT32 usage;                       //!< 1 if this is for a computed field
   UINT32 field;                       //!< Which field is this for?
   
   RVCQUERYINFO (
      ) {Clear();}
   
   RVCQUERYINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   RVCQUERYINFO& operator= (
      const RVCGENINFO& ginfo          //!< Query info class to copy from
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}
      
   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
   
   };

PREVENT_MEMFUNC(RVCQUERYINFO)

//! Read query header.
inline int MfReadQueryHeader (
   int fhandle,                        //!< Open file handle
   RVCINODENUM inode,                  //!< Object inode
   RVCQUERYINFO* info                  //!< Query header passed / returned
   ) {
   return (_MfReadHeader(fhandle,inode,info,sizeof(RVCQUERYINFO),RVCCONV_QueryInfo));
   }

//! Write query header.
inline int MfWriteQueryHeader (
   int fhandle,                        //!< Open file handle
   RVCINODENUM inode,                  //!< Object inode
   RVCQUERYINFO* info                  //!< Query header to write
   ) {
   return (_MfWriteHeader(fhandle,inode,info,sizeof(RVCQUERYINFO),RVCCONV_QueryInfo));
   }

extern "C" {
   //! Main level function to close opened text objects.
   RVCAPPLIBEXPORT int MfCloseText (
      int id,                          //!< Handle returned by MfOpenText()
      RVCTEXTINFO *info,               //!< Any header containing RVCTEXTINFO
      int isize,                       //!< Size of object header
      int hdrtype                      //!< RVCCONV_????
      );
   
   //! Main level function to make text objects.
   //!
   //! @returns: text object handle > 0 or error < 0
   //! If the "IsUnicode" flag is set in the header, the object will contain
   //! 2-byte Unicode text.  
   //! See Also: MfOpenText()
   RVCAPPLIBEXPORT int MfMakeText (
      int findex,                      //!< File handle returned by MfOpenFile()
      RVCTEXTINFO *info,               //!< Any header containing RVCTEXTINFO
      int isize,                       //!< Size of object header
      int hdrtype                      //!< RVCCONV_????
      );
   
   //! Main level function to open text objects
   //!
   //! @returns: text object handle > 0 or error < 0
   //! If the "IsUnicode" flag is set in the header, the object contains
   //! 2-byte Unicode text.  
   //! See Also: MfCloseText(), MfReadText(), MfReadTextUnicode(), MfReadTextLine()
   //!   MfReadTextLineUnicode(), MfWriteText(), MfWriteTextLine(), MfWriteTextUnicode()
   //!   MfSeekText(), MfTellText(), MfTruncateText(), MfTextLength(), MfTextIsUnicode()
   //!   MfReadTextIni(), MfTextReadAll()
   //!   MfTextWriteAll(), MfTextMakeLink()
   RVCAPPLIBEXPORT int MfOpenText (
      int fileindex,                   //!< File handle returned by MfOpenFile()
      INT32 inode,                     //!< Generic object inode to open
      RVCTEXTINFO *info,               //!< Any header containing RVCTEXTINFO
      int isize,                       //!< Size of object header structure
      int hdrtype,                     //!< Conversion type: RVCCONV_????
      UINT32 flags                     //!< Requires an RVCMODE_Write for writing
      );

   //! Read a buffer from a text object (ASCII).
   //!
   //! @return number of characters read or error < 0 R_ReadPastEnd if no more to read.
   //! If the object contains 2-Byte Unicode text, any character > 255 will be converted to 127.
   RVCAPPLIBEXPORT INT32 MfReadText (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      char *ptr,                       //!< Buffer to read into
      INT32 len                        //!< Number of characters to read
      );
   
   //! Read a text object to an in memory Ini buffer.
   RVCAPPLIBEXPORT int MfReadTextIni (
      int findex,                      //!< Open RVC file handle
      INT32 inode,                     //!< Inode of text object
      RVCTEXTINFO *info,               //!< Text object info or DispParm object info header
      int isize,                       //!< Size of header
      int hdrtype,                     //!< Header conversion type
      INIHANDLE handle                 //!< In memory Ini handle from IniOpen()
      );
   
   //! Read a line from a text object (ASCII).
   //!
   //! @returns number of characters read or error < 0 R_ReadPastEnd if no more to read.
   //! This function will read up (and including) the next newline ('\n')
   //! character or to the end of the object, or maxlen characters, which
   //! ever comes first.  The buffer will always be NULL-terminated.
   //! If the object contains 2-Byte Unicode text, any character > 255 will
   //! be converted to 127.
   RVCAPPLIBEXPORT INT32 MfReadTextLine (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      INT32 maxlen,                    //!< Maximum number of characters to read
      char *ptr                        //!< Buffer to read into
      );
   
   //! Read a line from a text object (Unicode).
   //!
   //! @returns number of characters read or error < 0 R_ReadPastEnd if no more to read.
   //! This function will read up (and including) the next newline ('\n')
   //! character or to the end of the object, or maxlen characters, which
   //! ever comes first.  If the object contains 1-byte ASCII text, all characters will be
   //! promoted to Unicode characters in the range 0 to 255.
   RVCAPPLIBEXPORT INT32 MfReadTextLineString (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      MISTRING& string                 //!< String to read into
      );
   
   //! Read a line from a text object (Unicode).
   //!
   //! @returns number of characters read or error < 0 R_ReadPastEnd if no more to read.
   //! This function will read up (and including) the next newline ('\n')
   //! character or to the end of the object, or maxlen characters, which
   //! ever comes first.  The buffer will always be NULL-terminated.
   //! If the object contains 1-byte ASCII text, all characters will be
   //! promoted to Unicode characters in the range 0 to 255.
   RVCAPPLIBEXPORT INT32 MfReadTextLineUnicode (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      INT32 maxlen,                    //!< Maximum number of characters (not bytes) to read
      UNICODE *ptr                     //!< Buffer to read into
      );
   
   //! Read a line from a text object (Unicode).
   //!
   //! @returns number of characters read or error < 0 R_ReadPastEnd if no more to read.
   //! This function will read up (and including) the next newline ('\n')
   //! character or to the end of the object, or maxlen characters, which
   //! ever comes first.  If the object contains 1-byte ASCII text, all characters will be
   //! promoted to Unicode characters in the range 0 to 255.
   RVCAPPLIBEXPORT INT32 MfReadTextString (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      MISTRING& string,                //!< String to read into
      INT32 maxlen                     //!< Maximum number of characters (not bytes) to read
      );
   
   //! Read a buffer from a text object (Unicode).
   //!
   //! @returns number of characters read or error < 0 R_ReadPastEnd if no more to read.
   //! If the object contains 1-byte ASCII text, all characters will be
   //! promoted to Unicode characters in the range 0 to 255.
   RVCAPPLIBEXPORT INT32 MfReadTextUnicode (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      UNICODE *uc,                     //!< Buffer to read into
      INT32 len                        //!< Number of characters (not bytes) to read
      );
   
   //! Main level function to return if the text object is in UNICODE.
   //!
   //! @return true if the text object is in UNICODE, false if not
   RVCAPPLIBEXPORT int MfTextIsUnicode(
      int id                           //!< Handle returned by MfMakeText or MfOpenText
      );
   
   //! Make a link to an external text file with a text object.
   RVCAPPLIBEXPORT int MfTextMakeLink (
      int findex,                      //!< File handle returned by MfOpenFile()
      RVCTEXTINFO *info,               //!< Any header containing RVCTEXTINFO
      int isize,                       //!< Size of object header
      int hdrtype,                     //!< RVCCONV_????
      const UNICODE *filename,         //!< Name of file to link to
      const char *encstr               //!< File encoding string, must be less than 64 bytes
      );
   
   //! Read complete text object into a UNICODE buffer.
   RVCAPPLIBEXPORT int MfTextReadAll (
      int fhandle,                     //!< File handle returned by MfOpenFile()
      INT32 inode,                     //!< Inode of text object to read
      RVCTEXTINFO *info,               //!< Any header containing RVCTEXTINFO
      int isize,                       //!< Size of object header
      int hdrtype,                     //!< RVCCONV_????
      UNICODE **buf,                   //!< Buffer to allocate and read into, free by using MfFree()
      UINT32 flags                     //!< Flags, see MfOpenText
      );
   
   //! Write complete text object from a UNICODE buffer.
   RVCAPPLIBEXPORT int MfTextWriteAll (
      int fhandle,                     //!< File handle returned by MfOpenFile()
      INT32 inode,                     //!< Inode of text object to read
      RVCTEXTINFO *info,               //!< Any header containing RVCTEXTINFO
      int isize,                       //!< Size of object header
      int hdrtype,                     //!< RVCCONV_????
      const UNICODE *buf,              //!< Buffer to write from
      UINT32 flags = 0                 //!< Flags, see MfOpenText
      );
   
   //! Resize test object to new length.
   RVCAPPLIBEXPORT int MfTruncateText (
      int id,                          //!< Handle from MfOpenText() or MfMakeText()
      INT32 size                       //!< New length to set it to
      );
   
   //! Write a buffer to a text object (ASCII).
   //!
   //! @return number of characters written or error < 0
   //! If the object contains 2-byte Unicode text, all characters will be
   //! promoted to Unicode characters in the range 0 to 255.
   RVCAPPLIBEXPORT INT32 MfWriteText (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      const char *ptr,                 //!< Buffer to write
      INT32 len                        //!< Number of characters to write
      );
   
   //! Write an in memory Ini buffer to a text object.
   //!
   //! @return error code if < 0, succesful if 0
   //! NOTE: If new object, these fields in the 'info' parameter must be set:
   //!      name, desc, source, parentinode, objtype
   RVCAPPLIBEXPORT int MfWriteTextIni (
      int findex,                      //!< Open RVC file handle
      INT32 inode,                     //!< Inode of text object, -1 if new, info.parentinode must be set
      RVCTEXTINFO *info,               //!< Text object info or DispParm object info header
      int isize,                       //!< Size of header
      int hdrtype,                     //!< Header conversion type
      INIHANDLE handle                 //!< In memory Ini handle from IniOpen()
      );
   
   //! Write a line to a text object (ASCII).
   //!
   //! @return number of characters written or error < 0
   //! If the object contains 2-byte Unicode text, all characters will be
   //! promoted to Unicode charactLineUnicode      Write a line to a text object (Unicode)
   RVCAPPLIBEXPORT INT32 MfWriteTextLine (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      const char *ptr                  //!< NULL-terminated buffer to write
      );
   
   //! Write a line to a text object (ASCII).
   //!
   //! @return number of characters written or error < 0
   //! If the object contains 1-Byte ASCII text, any character > 255 will
   //! be converted to 127 before being written out.
   RVCAPPLIBEXPORT INT32 MfWriteTextLineUnicode (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      const UNICODE *us                //!< NULL-terminated buffer to write
      );
   
   //! Write a buffer to a text object (Unicode).
   //!
   //! @return number of characters written or error < 0
   //! If the object contains 1-Byte ASCII text, any character > 255 will
   //! be converted to 127 before being written out.
   RVCAPPLIBEXPORT INT32 MfWriteTextUnicode (
      int id,                          //!< Handle returned by MfMakeText or MfOpenText
      const UNICODE *uc,               //!< Buffer to write
      INT32 len                        //!< Number of characters (not bytes) to write
      );

   }

#endif   //!< INC_MI32_RVCTEXT_H

---