rvcparms.h

Go to the documentation of this file.

/**
 * \file rvcparms.h <mi32/rvcparms.h>
 * \brief 
 *
 * Functions for saving/loading structures in the style of dispwsl.c, but
 * much simpler.  Currently used for OTYPE_DBPARM.  Objects of this type are
 * based on OTYPE_TEXT with no changes to the structure.
 *
 * \if NODOC
 * $Id: rvcparms.h_v 1.21 2004/03/31 16:09:42 dwilliss Exp $
 *
 * $Log: rvcparms.h_v $
 * Revision 1.21  2004/03/31 16:09:42  dwilliss
 * Added MISTRING support
 *
 * Revision 1.20  2004/03/24 22:48:28  mju
 * Merge mistruct stuff here as not wanted elsewhere.
 *
 * Revision 1.19  2004/03/10 22:38:51  mju
 * Remove one more legacy dialog.
 *
 * Revision 1.18  2004/03/10 22:37:56  mju
 * Remove legacy object selection dialog inlines.
 *
 * Revision 1.17  2003/10/15 17:39:23  mju
 * Deprecate groupkey.
 *
 * Revision 1.16  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.15  2002/08/20 14:43:51  mju
 * Use prevent_memfunc on header.
 *
 * Revision 1.14  2002/03/08 18:20:02  scowan
 * Added clear and ctors and deprecated mem... functions.
 *
 * Revision 1.13  2001/09/14 14:58:22  mju
 * No Mdlg in win32native.
 *
 * Revision 1.12  2000/12/15 15:36:19  msmith
 * Genitor documentation.
 *
 * Revision 1.11  2000/03/29 03:27:37  scowan
 * Added assignment operators.
 *
 * Revision 1.10  1999/11/19 14:20:45  mju
 * Use const for MdlgGet... prompt.
 *
 * Revision 1.9  1999/10/05  22:47:23  scowan
 * Changed header to use inheritance.
 *
 * Revision 1.8  1999/06/11 15:23:09  mju
 * Obj sel dlg.
 *
 * Revision 1.7  1999/05/07  21:23:18  mju
 * Header restruct.
 *
 * Revision 1.6  1999/04/08  19:10:12  mju
 * Add inclusion guards.
 *
 * Revision 1.5  1999/01/05  19:12:31  scowan
 * Swapped multiple keywords
 *
 * Revision 1.4  1996/12/20 16:37:34  coffee!dwilliss
 * Added __cplusplus things
 *
 * Revision 1.1  1995/12/12  16:57:19  coffee!dwilliss
 * Initial revision
 * \endif
**/

#ifndef INC_MI32_RVCPARMS_H
#define INC_MI32_RVCPARMS_H

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

#ifndef  INC_MI32_RVCTEXT_H
   #include <mi32/rvctext.h>
#endif

struct MISTRUCTDATA {
   char *name;
   int type;
   int offset;
   int flags;
   int size;         //!<  only needed for structures 
   int count;        //!<  For fixed size arrays 
   MISTRUCTDATA *substruct;   //!<  Only needed for structures 
   };

/*
** Values for "flags" in the MISTRUCTDATA structure
*/
#define MISTRUCTFLAG_NoWrite0 0x0001   //!<  Don't write if blank 
#define MISTRUCTFLAG_NoWrite  0x0002   //!<  For old things 
#define MISTRUCTFLAG_NoRead      0x0004   //!<  For really old things 


/*
** The following flags are for the flags parm in 
** MstructRead() and MstructWrite()
*/
#define MISTRUCTFLAG_UseUnicode        0x8000
#define MISTRUCTFLAG_NoOuterBraces     0x4000   //!<  No open/close { } 
#define MISTRUCTFLAG_EqualsSigns       0x2000   //!<  Put "name=value" 

#define MISTRUCTFLAG_INIFormat (MISTRUCTFLAG_NoOuterBraces|MISTRUCTFLAG_EqualsSigns)


/*
** Values for "type" in the MISTRUCTDATA structure
*/

#define  MISTRUCT_End                  0
#define  MISTRUCT_String               1
#define  MISTRUCT_UByte                2
#define  MISTRUCT_Byte                 3
#define  MISTRUCT_UWord                4
#define  MISTRUCT_Word                 5
#define  MISTRUCT_ULong                6
#define  MISTRUCT_Long                 7
#define  MISTRUCT_UInt                 8
#define  MISTRUCT_Int                  9
#define  MISTRUCT_Double               10
#define  MISTRUCT_Color                11
#define  MISTRUCT_DRectXY              12
#define  MISTRUCT_UCString             13
#define  MISTRUCT_MLString             14    //!<  Multi-line String 
#define  MISTRUCT_MLUCString           15    //!<  Multi-line Unicode String 
#define  MISTRUCT_Float                16    //!<  The 4-byte variety 
#define  MISTRUCT_StringPtr            17    //!<  Just a pointer in the structure 
#define  MISTRUCT_Struct                 18
#define  MISTRUCT_StructPtr              19
#define  MISTRUCT_StructArray         20    //!<  An array of structures 
#define  MISTRUCT_MISTRING         21    

/*
** Note about MISTRUCT_StructArray
**  This assumes that the structure being read has something like...
**
**       ...
**       INT32 NumThings
**       SOMESTRUCT *things
**
**  It is important that the NumThings be saved/loaded BEFORE the array
**  of things and that they be right next to each other in the structure
**  as shown above.  The offset in the MISTRUCTDATA should point to the 
**  array pointer.  It looks at the long at offset-4 to determine how
**  large to allocate the array.  If the pointer is already non-NULL, it
**  will assume it's allready allocated and not allocate it again.
**  The NumThings is also used when saving to determine how many to save.
*/

//! Parameter header structure.
struct RVCPARMINFO : public RVCTEXTINFO {
   UINT16 usage;
   UINT16 version;
   UINT32 forobjtype;
   
   RVCPARMINFO (
      ) {Clear();}
   
   RVCPARMINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   //! Assignment operator
   RVCPARMINFO& operator= (
      const RVCGENINFO& ginfo          //!< RVCGENINFO structure to copy from
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}
      
   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
   
   };
typedef RVCPARMINFO RVCDPARMINFO;

PREVENT_MEMFUNC(RVCPARMINFO);

#define  DPARMUSAGE_Display         0
#define  DPARMUSAGE_Edit            1
#define  DPARMUSAGE_NumericOutput   2
#define  DPARMUSAGE_Surface         3
#define  DPARMUSAGE_Unspecified     99

//! Read parameter header.
inline int MfReadDispParmHeader (
   int fhandle,                        //!< Open file handle
   RVCINODENUM inode,                  //!< Parameter object inode
   RVCPARMINFO* info                   //!< Parameter header passed / returned
   ) {
   return (_MfReadHeader(fhandle,inode,info,sizeof(RVCDPARMINFO),RVCCONV_DispParm));
   }

//! Write parameter header.
inline int MfWriteDispParmHeader (
   int fhandle,                        //!< Open file handle
   RVCINODENUM inode,                  //!< Parameter object inode
   RVCPARMINFO* info                   //!< Parameter header to write
   ) {
   return (_MfWriteHeader(fhandle,inode,info,sizeof(RVCDPARMINFO),RVCCONV_DispParm));
   }

extern "C" {

//! Read the object.
//! \deprecated use SERIALIZER instead.
int DEPRECATED MfReadParms (
   int handle,                      //!< Object handle
   MISTRUCTDATA *kwdata,            //!< Reading parameters
   void *data,                      //!< Data structure to fill in
   UINT32 flags                     //!< Flags
   );

//! Write the object.
//! \deprecated use SERIALIZER instead.
int DEPRECATED MfWriteParms (
   int handle,                      //!< Object handle
   MISTRUCTDATA *kwdata,            //!< Writing parameters
   void *data,                      //!< Data structure to write
   UINT32 flags                     //!< Flags
   );

//! Close the object
int DEPRECATED MfCloseParms (
   int id,                          //!< Object handle
   RVCPARMINFO *info                //!< Structure 
   );

//! Open the object and make sure it's the right OTYPE of this.
int DEPRECATED MfOpenParms (
   int fid,                         //!< Open file handle
   INT32 inode,                     //!< Object inode
   RVCPARMINFO *info,               //!< RVCPARMINFO structure to fill in
   UINT32 flags                     //!< Flags
   );

//! Create the object and make sure it's the right OTYPE of this.
int DEPRECATED MfMakeParms (
   int fid,                         //!< Open file handle
   RVCPARMINFO *info,               //!< RVCPARMINFO structure to write from
   UINT32 flags                     //!< Flags
   );

}

#endif

---