rvcdefns.h

Go to the documentation of this file.

/**
 * \file mi32/rvcdefns.h
 * \brief RVC Definitions Header File
 *
 * \if NODOC
 * $Id: rvcdefns.h_v 4.469 2005/06/28 14:46:38 mju Exp $
 *
 * $Log: rvcdefns.h_v $
 * Revision 4.469  2005/06/28 14:46:38  mju
 * Add mfLinkFileClearMissingList.
 *
 * Revision 4.468  2005/05/25 21:01:03  scowan
 * Add ability to mark an object as being deleted.
 *
 * Revision 4.467  2005/04/01 18:46:11  dwilliss
 * new prototype
 *
 * Revision 4.466  2005/03/31 16:57:20  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 4.465  2005/03/18 17:20:17  scowan
 * Changed parms of function.
 *
 * Revision 4.464  2005/03/03 23:37:33  scowan
 * Added another open file function.
 *
 * Revision 4.463  2005/03/03 18:47:25  scowan
 * Moved legacy georef functions to main library.
 *
 * Revision 4.462  2005/02/25 16:11:32  scowan
 * Removd unused functions from dll.
 *
 * Revision 4.461  2005/02/24 21:58:42  scowan
 * Moved remaining list legacy functions to prlist.
 *
 * Revision 4.460  2005/02/24 21:23:15  scowan
 * Moved most legacy list functions to private, non exported include file.
 *
 * Revision 4.459  2005/02/24 20:54:41  scowan
 * Moved and / or erased prototypes that no longer need to be seen.
 *
 * Revision 4.458  2005/02/14 23:44:49  scowan
 * Removed unused prototypes.
 *
 * Revision 4.457  2005/02/08 00:25:26  scowan
 * Removed unused function prototype.
 *
 * Revision 4.456  2005/02/04 21:43:29  dwilliss
 * Added a getobjflag
 *
 * Revision 4.455  2005/01/07 15:22:27  mju
 * Move crypto prototypes to own hdr.
 *
 * Revision 4.454  2005/01/03 21:55:32  mju
 * Show replacement for deprecated mdlgGetObject... fns.
 *
 * Revision 4.453  2005/01/03 16:46:29  mju
 * Deprecate rvcfilehandle.makeTemp.
 *
 * Revision 4.452  2005/01/03 16:18:32  mju
 * Use pragma to avoid deprecation warning on inlines/
 *
 * Revision 4.451  2005/01/03 15:56:21  mju
 * Deprecate legacy object selection dialogs.
 *
 * Revision 4.450  2004/12/29 16:04:20  dwilliss
 * Undid previous change.  Steve suggedted a better solution
 *
 * Revision 4.449  2004/12/29 15:29:16  dwilliss
 * Added a member to MfChildCallbackStruct
 *
 * Revision 4.448  2004/11/17 21:34:03  mju
 * Add flag for tracing raster boundary to control std attributes.
 *
 * Revision 4.447  2004/10/13 19:32:28  scowan
 * Added copy rvc flag.
 *
 * Revision 4.446  2004/09/14 20:20:14  scowan
 * Removed function prototype.
 *
 * Revision 4.445  2004/07/29 21:55:36  scowan
 * Removed unused prototypes.
 *
 * Revision 4.444  2004/07/27 22:13:04  scowan
 * Removed another unused prototype.
 *
 * Revision 4.443  2004/07/27 21:12:49  scowan
 * Removed 2d version of get object extents.
 *
 * Revision 4.442  2004/07/27 21:08:52  scowan
 * Removed use of mf get num object elements.
 *
 * Revision 4.441  2004/07/22 14:30:50  mju
 * Move objitem defns to own header.
 *
 * Revision 4.440  2004/07/20 15:51:13  scowan
 * Fixed annoying mac warning about comments.
 *
 * Revision 4.439  2004/07/19 23:18:58  scowan
 * Removed unused forward declaration.
 *
 * Revision 4.438  2004/07/19 13:53:02  mju
 * Add objitem.setnew variants using objectname/objectdesc.
 *
 * Revision 4.437  2004/06/16 19:53:27  scowan
 * Added flag to not generate the georeference for cross sections.
 *
 * Revision 4.436  2004/06/03 22:11:03  scowan
 * Removed unused defines.
 *
 * Revision 4.435  2004/06/03 21:36:40  scowan
 * Removed unused defines.
 *
 * Revision 4.434  2004/04/07 23:04:35  scowan
 * Added a copy flag.
 *
 * Revision 4.433  2004/03/31 22:38:56  mju
 * Remove unused getobjflag values.
 * Mark obsolete getobjflag_dftnew and _usefilter as deprecated.
 *
 * Revision 4.432  2004/03/30 15:43:16  scowan
 * Undeprecated folder usable flag.
 *
 * Revision 4.431  2004/03/22 18:14:50  scowan
 * Added field to link item.
 *
 * Revision 4.430  2004/03/19 18:41:29  scowan
 * Added callbacks for child operations.
 *
 * Revision 4.429  2004/03/11 16:29:21  mju
 * Change prototypes for mdlggetobject to not have extra form stuff.
 *
 * Revision 4.428  2004/03/10 23:15:02  scowan
 * Marked many functions as deprecated.
 *
 * Revision 4.427  2004/03/10 21:33:51  mju
 * Remove mdlgGetSubobject as no longer used.
 *
 * Revision 4.426  2004/01/28 23:14:27  scowan
 * Changed cross section prototype.
 *
 * Revision 4.425  2003/11/14 15:35:50  mju
 * REmove mdlgMaintProjectFile.
 *
 * Revision 4.424  2003/11/10 18:45:07  mju
 * Add objitem.setobjectinfo.
 *
 * Revision 4.423  2003/11/06 23:04:17  scowan
 * Removed prototype of removed function.
 *
 * Revision 4.422  2003/10/27 17:14:12  scowan
 * Changed not selectable filt flag to be the same as filt not usable.
 *
 * Revision 4.421  2003/10/22 17:46:03  scowan
 * Deprecated some filt flags.
 *
 * Revision 4.420  2003/10/15 17:39:12  mju
 * Deprecate groupkey.
 *
 * Revision 4.419  2003/10/08 22:27:49  scowan
 * Removed unused function call.
 *
 * Revision 4.418  2003/10/06 20:06:30  scowan
 * Pruned unused rfunctions.
 *
 * Revision 4.417  2003/10/03 21:30:29  scowan
 * nc.
 *
 * Revision 4.416  2003/10/02 19:15:27  scowan
 * Removed get localized name function.
 *
 * Revision 4.415  2003/09/26 19:56:07  scowan
 * Adjustment of include files.
 *
 * Revision 4.414  2003/09/26 15:57:04  scowan
 * Removed open link file function.
 *
 * Revision 4.413  2003/09/26 14:47:06  scowan
 * Do not export function that will soon be deprecated.
 *
 * Revision 4.412  2003/09/25 22:25:13  scowan
 * Removed unused functions and methods.
 *
 * Revision 4.411  2003/09/22 19:56:27  scowan
 * Removed call to copy file raw, it has been replaced.
 *
 * Revision 4.410  2003/09/15 23:00:14  scowan
 * Added callback reason.
 *
 * Revision 4.409  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 4.408  2003/09/02 17:10:44  scowan
 * Moved some prototypes.
 *
 * Revision 4.407  2003/09/02 16:56:36  dwilliss
 * Added COPYRVC flag to freeze computed fields
 *
 * Revision 4.406  2003/08/29 23:02:57  scowan
 * Removed unused functions.
 *
 * Revision 4.405  2003/08/29 21:45:27  scowan
 * Cleanup unused functions.
 *
 * Revision 4.404  2003/08/28 19:34:01  scowan
 * nc.
 *
 * Revision 4.403  2003/08/28 15:24:59  scowan
 * Removed use of fname obj list struct and functions.
 *
 * Revision 4.402  2003/08/27 21:31:26  scowan
 * Added structures and removed functions and other stuff.
 *
 * Revision 4.401  2003/08/15 16:42:05  scowan
 * Removed unused copy rvc flags.
 *
 * Revision 4.400  2003/08/13 21:43:24  scowan
 * Removed copy object "T" function prototypes.
 *
 * \endif
**/

#ifndef INC_MI32_RVCDEFNS_H
#define INC_MI32_RVCDEFNS_H

#if defined (__cplusplus)

#ifndef INC_MI32_STDDEFNS_H
   #include <mi32/stddefns.h>
#endif

#ifndef INC_MI32_FIXEDSTR_H
   #include <mi32/fixedstr.h>
#endif

#ifndef INC_MI32_FILEPATH_H
   #include <mi32/filepath.h>
#endif

#ifndef INC_MI32_RECT_H
   #include <mi32/rect.h>
#endif

#ifndef INC_MI32_MCB_H
   #include <mi32/mcb.h>
#endif

#ifndef INC_RVC_OBJTYPE_H
   #include <rvc/objtype.h>
#endif


#ifdef RVCLOWDLL
   #define RVCLOWLIBEXPORT MI_DLLEXPORT
#else
   #define RVCLOWLIBEXPORT MI_DLLIMPORT
#endif

#ifdef RVCAPPDLL
   #define RVCAPPLIBEXPORT MI_DLLEXPORT
   #define RVCAPPCLASSEXPORT MI_DLLCLASSEXPORT
#else
   #define RVCAPPLIBEXPORT MI_DLLIMPORT
   #define RVCAPPCLASSEXPORT MI_DLLCLASSIMPORT
#endif

#include <mi32/hdrtypes.h>

//! Forward declarations
struct RVCCADINFO;
struct RVCRASTINFO;
struct RVCTININFO;
struct RVCVECTINFO;
struct TEXTSTYLE;
struct TRANSPARM;
class POLYLINE;

namespace RVC {
   class OBJTYPESET;
   class OBJECT;
   class OBJITEM;
   class OPENOBJECT;
   typedef MILIST<OBJITEM> OBJITEMLIST;
   }


#define  MfValidNameChar(c)   ((c)=='_'||(c)>='A'&&(c)<='Z'||(c)>='a'&&(c)<='z'||(c)>='0'&&(c)<='9'||(c)>=160)
#define  FOLDERSEPARATOR      ' '
#define  OBJTYPESEPARATOR     '.'

/*--------------------------------------------------------------------------*/
/*    Definitions of basic object types supported by RVC                    */
/*--------------------------------------------------------------------------*/
/* mode for opening rvc objects of all kinds */
#define RVCMODE_Mask          0x7F000000
#define RVCMODE_WriteAttempt  0x10000000           //!<  Attempt to open for write, else open for read 
#define RVCMODE_Read          0x40000000
#define RVCMODE_Write         0x20000000
#define RVCMODE_RW            0x60000000
#define RVCMODE_RWAttempt     0x70000000
#define RVCMODE_ReadAhead     0x08000000
#define RVCMODE_Bogus         0x04000000

/* mode for opening rvc files */
#define RVCFILE_OpenMask            0x000000FF
#define RVCFILE_ReadLock            0x00000001
#define RVCFILE_WriteLock           0x00000002
#define RVCFILE_WriteLockAttempt    0x00000004
#define RVCFILE_SharedLock          0x00000008     //!<  Not Implemented Yet 
#define RVCFILE_NoLock              0x00000010     //!<  Not to be used unless file is system file (i.e. icons.ref) 
#define RVCFILE_ReadAbsolute        0x00000020     //!<  File is to be opened read-only, no lock file and no possibility of change 
#define RVCFILE_NoDialog            0x00000040     //!< Don't display dialog if file is locked, just return error
#define RVCFILE_WriteAbsolute       0x00000080     //!< Override ReadAbsolute system flag for a specific file

#define RVCFILE_TempFileMask        0x0000FF00
#define RVCFILE_DeleteOnClose       0x00000100
#define RVCFILE_DeleteOnExit        0x00000200
#define RVCFILE_NoDelete            0x00000800

#define RVCFILE_ForceUnlockBtn      0x00040000     //!<  Force 'unlock' button in mxopenfl.c 

/**************************************************************************
*  Listing of RVC object types
**************************************************************************/

//! ----- Top level RVC objects -----
#define OTYPE_ALL             0        //!< Used by Mf??? functions to allow all objects
#define OTYPE_FILE            1
#define OTYPE_FOLDER          2        //!< An object to contain other objects
#define OTYPE_RASTER          3        //!< Raster object
#define OTYPE_VECTOR          4        //!< Vector object
#define OTYPE_CAD             5        //!< CAD object
#define OTYPE_DBASE           6        //!< General database object
#define OTYPE_STYLE           7        //!< Drawing style object
#define OTYPE_DBQUERY         8        //!< Generic database query string
#define OTYPE_FILTER          9        //!< Spatial filter description
#define OTYPE_VIDEOSEQ        10       //!< Ref for sequence of frames on video disk
#define OTYPE_PRTCOLORBAL     30       //!< Printer color balance
#define OTYPE_DISP_GROUP      37       //!< Display group layout information
#define OTYPE_DISP2DWINDOW    38       //!< Display window layout information
#define OTYPE_TIN             39       //!< TIN object
#define OTYPE_LEGEND          41       //!< Legend object
#define OTYPE_REGION          45       //!< Region object
#define OTYPE_DISP_LAYOUT     54       //!< Display layout information
#define OTYPE_SML             55       //!< Stand-alone SML Script
#define OTYPE_SPECTRAL        56       //!< Spectral object
#define OTYPE_RASTERSET       57       //!< Raster Set object
#define OTYPE_DISP_SIM3D      59       //!< Display 3D simulation parameters object
#define OTYPE_HYPERSPECTRAL   60       //!< HyperSpectral object
#define OTYPE_LAYOUTTEMPLATE  65       //!< Layout Template object
#define OTYPE_THUMBNAIL       66       //!< Tumbnail object
#define OTYPE_HOUGHPARMS      71       //!< Hough transformation parameters object
//!#define OTYPE_SHAPE        72       // Geometric "Shape" object (Shapefile, Oracle Spatial, ...) [ USE RVC::OBJECT_Shape ]

//! ----- RVC subobjects common to multiple objects -----
#define OTYPE_GEOREF          11       //!< Georeference information
#define OTYPE_PAGELAYOUT      12       //!< Information for page layouts
#define OTYPE_HYPER           13       //!< Hyper-index information
#define OTYPE_DBFORM          14       //!< Database display layout
#define OTYPE_TIEPOINT        15       //!< Tie point list
#define OTYPE_DISPPARM        40       //!< Display parameter structure
#define OTYPE_TEXT            42       //!< Generic Text Object
#define OTYPE_ASSOCIATION     46       //!< External file association object
#define OTYPE_QTREE           47       //!< Search Quad Tree object
#define OTYPE_DBPARM          48       //!< Database parameters object
#define OTYPE_THEME           49       //!< Theme Mapping parameters object
//!#define OTYPE_METADATA     50       // Metadata object - text [ CONFLICTS WITH ORACLE INCLUDE FILE, USE RVC::OBJECT_Metadata ]
#define OTYPE_EDITPARM        53       //!< Object Editor parameter structure
#define OTYPE_SPATIALTREEOLD  67       //!< DEPRECATED
#define OTYPE_SPATIALTREEOLD2 69       //!< DEPRECATED
#define OTYPE_SPATIALTREE     70       //!< Vector element sort tree
//!#define OTYPE_ICMPROFILE      74       // ICM Profile object [ USE RVC::OBJTYPE_ICMProfile ]

//! ----- RVC subobjects common to raster objects -----
#define OTYPE_HISTO           16       //!< Raster histogram
#define OTYPE_CONTAB          17       //!< Contrasting table
#define OTYPE_2DHISTINFO      18       //!< Information about 2-D histogram
#define OTYPE_COLMAP          19       //!< Color table for rasters
#define OTYPE_RASTDBASE       20       //!< Database for raster cells
#define OTYPE_FREQPROCINFO    21       //!< Information to match frequency-domain rasters
#define OTYPE_RASTERTREND     22       //!< Trend Information
#define OTYPE_SPOTHEADER      23       //!< Header (leader) file from SPOT tape
#define OTYPE_CAMERACALIB     24       //!< Camera calibration information
#define OTYPE_SENSORINFOOLD   58       //!< Sensor calibration information for spectral bands (OLD)
#define OTYPE_HYPERHIST       62       //!< Hyperspectral histogram sub-object
#define OTYPE_HYPERSENSOR     63       //!< Hyperspectral sensor sub-object
#define OTYPE_SENSORINFO      64       //!< Sensor calibration information for spectral bands

//! ----- RVC subobjects common to vector objects -----
#define OTYPE_POINTDBASE      25       //!< Database for point elements
#define OTYPE_LINEDBASE       26       //!< Database for line elements
#define OTYPE_POLYDBASE       27       //!< Database for polygon elements
#define OTYPE_NODEDBASE       28       //!< Database for node elements
#define OTYPE_VECTDBASE       44       //!< Database for vector objects

//! ----- RVC subobjects common to CAD objects -----
#define OTYPE_CADDBASE        29       //!< Database for CAD objects

//! ----- RVC subobjects common to SHAPE objects -----
//!#define OTYPE_SHAPEDBASE      73       // Database for CAD objects

//! ----- RVC subobjects common to TIN objects -----
#define OTYPE_TINDBASE        43       //!< Database for TIN objects

//! ----- RVC subobjects common to database objects -----
//!#define OTYPE_TABLE        51       // Table OTYPE tag for databases [ CONFLICTS WITH ORACLE INCLUDE FILE, USE RVC::OBJECT_Table ]
#define OTYPE_INVDBLIST       52       //!< Database table to element lists
#define OTYPE_DBCONSTRAINT    61       //!< Database table constraint information
#define OTYPE_DBINDEX         68       //!< Database table constraint information

//! ----- RVC objects used in .REF files -----
#define OTYPE_PRINTDEF        31       //!< Description for raster printer devices
#define OTYPE_PLOTDEF         32       //!< Description for pen plotter devices
#define OTYPE_OFONT           33       //!< Outline(stroke) font
#define OTYPE_GENERICREF      34       //!< Generic reference object, not user-viewable object
#define OTYPE_SCANDEF         35       //!< Description for scanners
#define OTYPE_XYDIGDEF        36       //!< Description for XY digitizer devices

#define OTYPE_LAST            75       //!< Update rvcmain.c and messages.txt [rvc] section when change

#define  RVCCONV_RASTER          RVCCONV_RastInfo
#define  RVCCONV_CAD             RVCCONV_CADInfo
#define  RVCCONV_HISTO           RVCCONV_HistInfo
#define  RVCCONV_CONTAB          RVCCONV_ConTab
#define  RVCCONV_COLMAP          RVCCONV_CMapInfo
#define  RVCCONV_DBASE           RVCCONV_DbaseInfo
#define  RVCCONV_GEOREF          RVCCONV_GeoRefInfo
#define  RVCCONV_VECTOR          RVCCONV_VectInfo
#define  RVCCONV_TIEPOINT        RVCCONV_TiePointInfo
#define  RVCCONV_TIN             RVCCONV_TINInfo
#define  RVCCONV_CAMERACALIB     RVCCONV_CameraInfo
#define  RVCCONV_FILTER          RVCCONV_FiltInfo
#define  RVCCONV_STYLE           RVCCONV_StyleInfo
#define  RVCCONV_REGION          RVCCONV_RegionInfo
#define  RVCCONV_DISP2DWINDOW    0
#define  RVCCONV_DISP2DGROUP     0

/*----------------------------------------------------------------------------*/
/*    Definitions for general object headers                                  */
/*----------------------------------------------------------------------------*/

struct RVCDATETIME {
   UINT8 year;                         //!<  Add 1900 to get actual year 
   UINT8 month;                        //!<  1-12 
   UINT8 day;                          //!<  1-31 
   UINT8 hour;                         //!<  0-23 
   UINT8 minute;                       //!<  0-59 
   UINT8 second;                       //!<  0-59 
   UINT16 count;                       //!<  count; if more than one object created with this time 
   };

namespace RVC {

typedef FIXEDSTRING<16> OBJECTNAME, OBJECTSOURCE;
typedef FIXEDSTRING<64> OBJECTDESC;

}     //! End of RVC namespace

typedef RVC::OBJECTNAME RVCOBJECTNAME;
typedef RVC::OBJECTSOURCE RVCOBJECTSOURCE;
typedef RVC::OBJECTDESC RVCOBJECTDESC;

//! Basic rvc info structure.
struct RVCBASICINFO {
   RVC::OBJECTNAME name;               //!< Object name
   RVC::OBJECTDESC desc;               //!< Description
   RVCDATETIME create;                 //!< Create date
   RVCDATETIME lastmod;                //!< Modification date
   RVCDATETIME lastused;               //!< Used date
   RVC::OBJECTSOURCE source;           //!< Source

   RVCBASICINFO (
      ) {Clear();}
      
   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
      
   bool IsEqual (
      const RVCBASICINFO& rhs
      ) const {return (memcmp(static_cast<const void*>(this), static_cast<const void*>(&rhs), sizeof(*this)) == 0);}
      
   };
   
inline bool operator== (
   const RVCBASICINFO& lhs,
   const RVCBASICINFO& rhs
   ) {return (lhs.IsEqual(rhs));}
   
inline bool operator!= (
   const RVCBASICINFO& lhs,
   const RVCBASICINFO& rhs
   ) {return (!lhs.IsEqual(rhs));}
   

//! General rvc info structure.
struct RVCGENINFO : public RVCBASICINFO {
   UINT32 objtype;                     //!< Object type
   RVCINODENUM objectinode;            //!< Object inode
   RVCINODENUM parentinode;            //!< Parent inode
   INT32 Size;                         //!< Object size
   
   RVCGENINFO (
      ) {Clear();}
   
   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
      
   RVC::OBJTYPE GetObjectType (
      ) const { return (static_cast<RVC::OBJTYPE>(this->objtype)); }
   };

//! Array info structure.
struct RVCARRAYINFO : public RVCGENINFO {
   INT32 NumItems;                     //!< Number of items
   INT32 ItemSize;                     //!< Item size
   
   RVCARRAYINFO (
      ) {Clear();}
   
   RVCARRAYINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   RVCARRAYINFO& operator= (
      const RVCGENINFO& ginfo
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}

   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
   
   };

//! General list info structure.
struct RVCGENLISTINFO : public RVCGENINFO {
   INT32 NumItems;                     //!< Number of items
   INT32 MaxItemSize;                  //!< Maximum item size

   RVCGENLISTINFO (
      ) {Clear();}
   
   RVCGENLISTINFO (
      const RVCGENINFO& ginfo
      ) {Clear();*static_cast<RVCGENINFO*>(this) = ginfo;}
   
   RVCGENLISTINFO& operator= (
      const RVCGENINFO& ginfo
      ) {*static_cast<RVCGENINFO*>(this) = ginfo; return (*this);}

   void Clear (
      ) {memset(static_cast<void*>(this), 0, sizeof(*this));}
   
   };

//! Disallow memset/memcpy.
PREVENT_MEMFUNC(RVCBASICINFO)
PREVENT_MEMFUNC(RVCGENINFO)
PREVENT_MEMFUNC(RVCARRAYINFO)
PREVENT_MEMFUNC(RVCGENLISTINFO)


//! Structure to hold RVC link information.
struct RVCLINKDATAEX {
   FILEPATH m_FilePath;                //!< Path name
   MISTRING m_ObjName;                 //!< Holds full name returned by MfGetObjectName()
   
   bool IsEqual (
      const RVCLINKDATAEX& rhs
      ) const {return (m_FilePath == rhs.m_FilePath && m_ObjName == rhs.m_ObjName);}
      
   };
   
inline bool operator== (
   const RVCLINKDATAEX& lhs,
   const RVCLINKDATAEX& rhs
   ) {return (lhs.IsEqual(rhs));}   
   
inline bool operator!= (
   const RVCLINKDATAEX& lhs,
   const RVCLINKDATAEX& rhs
   ) {return (!lhs.IsEqual(rhs));}
   

namespace RVC {

struct LINKITEM {
   FILEPATH m_Filename;
   MISTRING m_ObjName;
   OBJTYPE m_ObjType;
   RVCINODENUM m_SrcInode;          //!< The source object that contains the link
   
   LINKITEM (
      ) : 
      m_ObjType(OBJTYPE_All),
      m_SrcInode(-1)
      {}
      
   };
   
class FILEHANDLE;
   
}     //! End of RVC namespace
      

//! GUI functions structure.
struct RVCGUIFUNCS {
   INT32 size;                         //!< Size
   int (*GetFile)(void*, MIUNICODE*, const MIUNICODE*, void*, int (*)(MIUNICODE*, char*, void*), void*, UINT32);  //! Get a file
   int (*OpenFile)(void*, const MIUNICODE*, UINT32);  //! Open a file
   int (*ChangeFileLock)(void*, int, UINT32);   //! Change the lock on a file
   void (*AddCallback)(McbCallbackFunc, void*, UINT32);  //! Add a callback
   int (*UsernamePasswordDialog)(void *dlgparent, MIUNICODE*, int, int*, int*, UINT32);   //! Username / password dialog
   void (*DisplayErrorCode)(void*, int);  //! Display an error code
   int (*OpenFileEx)(void*, const FILEPATH&, UINT32); //! Open a file
   int (*OpenFile2)(void*, const FILEPATH&, UINT32, RVC::FILEHANDLE*&); //! Open a file
   };

//! App functions structure.
struct RVCAPPFUNCS {
   INT32 size;                         //!< Size
   int (*GetStringExtents)(TEXTSTYLE*, DPOINT2D*, INT32, UINT32, const MIUNICODE*, DRECT2D*);   //! Get the extents of a string
   int (*GetFontName)(int, MIUNICODE*);   //! Get a font name
   int (*OpenFont)(const MIUNICODE*);     //! Open a font
   int (*GetStringExtentsJustify)(TEXTSTYLE*, DPOINT2D*, INT32, UINT32, const MIUNICODE*, DRECT2D*);  //! Get the extents of a justified string
   };

#ifndef INC_RVC_OBJITEM_H
   #include <rvc/objitem.h>
#endif

/*----------------------------------------------------------------------------*/
/* Flags for linking to external objects                                      */
/*----------------------------------------------------------------------------*/

#define  RVCLINKFLAG_LoHi        (0x00000001)      /* Linked object stored LoHi */
#define  RVCLINKFLAG_HiLo        (0x00000002)      /* Linked object stored HiLo */
#define  RVCLINKFLAG_RO          (0x00000004)      /* Linked object is on read only media (internal) */
#define  RVCLINKFLAG_Modified    (0x00000008)      /* Linked object may have been modified */

/*----------------------------------------------------------------------------*/
/* Point conversion modes for vector and CAD                                  */
/*----------------------------------------------------------------------------*/

#define  VECTMODE_ConvTo3D       0x0001   //!<  convert 2D->3D 
#define  VECTMODE_ConvTo2D       0x0002   //!<  convert 3D->2D 
#define  VECTMODE_Mask           0x0003   //!<  Mask for currently valid bits 

/*----------------------------------------------------------------------------*/
/* Values for PointType fields in headers                                     */
/*----------------------------------------------------------------------------*/

#define  VPOINT_2DXY    1              //!<  2-D coordinates, X and Y given (default) 
#define  VPOINT_2DXZ    2              //!<  2-D coordinates, X and Z given 
#define  VPOINT_2DYZ    3              //!<  2-D coordinates, Y and Z given 
#define  VPOINT_3DXY    4              //!<  3-D coordinates, X, Y given, Z constant 
#define  VPOINT_3DXZ    5              //!<  3-D coordinates, X, Z given, Y constant 
#define  VPOINT_3DYZ    6              //!<  3-D coordinates, Y, Z given, X constant 
#define  VPOINT_3DXYZ   7              //!<  3-D coordinates, X, Y and Z given 

/*----------------------------------------------------------------------------*/
/*    FNAMEINODE/FNAMEINODEUC structures                                      */
/*----------------------------------------------------------------------------*/

//! Filename / inode structure.
struct FNAMEINODEUC {
   MIUNICODE *filename;                //!< Filename
   RVCINODENUM inode;                  //!< Inode
   FNAMEINODEUC *next;                 //!< Next inode
   RVCGENINFO *objinfo;                //!< Object information
   void *userdata;                     //!< Reference data attached to the entry, useful for Motif list widgets 
   FNAMEINODEUC (
      ) { memset(this,0,sizeof(*this)); }
   };

/*----------------------------------------------------------------------------*/
/*    RVCFILELOCK structure      Used in MfGetFileLockInfo()                  */
/*----------------------------------------------------------------------------*/

//! File lock structure.
struct RVCFILELOCK {
   int serialnum;                      //!< TNTmips key serial number
   int processid;                      //!< Process ID
   int userid;                         //!< User ID if OS uses one
   int parentid;                       //!< Parent process ID if OS uses one
   MIUNICODE username[64];             //!< Owner of the lock
   MIUNICODE stationname[64];          //!< Station lock was generated from
   RVCDATETIME locktime;               //!< Time that the lock was created
   int IsReadOnly;                     //!< File requested is read only
   };

/*----------------------------------------------------------------------------*/
/*    Definitions (flags) for MfGet[File|Object]Status()                      */
/*----------------------------------------------------------------------------*/

#define RVCFS_ReadOnly        0x00000001
#define RVCFS_ReadLocked      0x00000002
#define RVCFS_Writable        0x00000004
#define RVCFS_WriteLocked     0x00000008
#define RVCFS_Modified        0x00000010
#define RVCFS_Tempfile        0x00000020
#define RVCFS_TNTlite         0x00000040        //!<  File was created by TNTlite 
#define RVCFS_Open            0x00000080        //!<  File is currently opened 

#define RVCOS_Composite       0x00000001 
#define RVCOS_Free            0x00000002 
#define RVCOS_Opened          0x00000004 
#define RVCOS_ReadOnly        0x00000008 
#define RVCOS_Writable        0x00000010 
#define RVCOS_Link            0x00000020 
#define RVCOS_ViewProtected   0x00000040
#define RVCOS_EditProtected   0x00000080
#define RVCOS_Bogus           0x00000100
#define RVCOS_TNTlite         0x00000200        //!<  Object was created by TNTlite 
#define RVCOS_BadInode        0x00000400
#define RVCOS_Deleting        0x00000800

/*----------------------------------------------------------------------------*/
/*    Definitions (flags) for MfCopyObject()                               */
/*----------------------------------------------------------------------------*/

#define  COPYRVC_SubObjects            0x00000001  //!<  Copy subobjects under object 
#define  COPYRVC_RasterLinks           0x00000002  //!<  Transfer raster links instead of copying the raster 
#define  COPYRVC_DBaseLinks            0x00000004  //!<  Transfer dbase links instead of copying the dbase 
#define  COPYRVC_DemoteIdentityTables  0x00000008 //!< Demote identity tables in MfDatabaseJoin() because they can no longer exist
#define  COPYRVC_PointDBase            0x00000010  //!<  MfCopyDatabase(): Convert OTYPE_DBASE to OTYPE_POINTDBASE 
#define  COPYRVC_MinimizeTableSize     0x00000020  //!<  MfDatabaseJoin(): Minimize table sizes (convert Identity and OneToOne to OneRecordPerElement)
#define  COPYRVC_DontRemoveRecords     0x00000200  //!<  MfDatabaseJoin(): Do not remove records while copying 
#define  COPYRVC_RVCLinks              0x00000400  //!<  Copy RVC object links instead of the objects themselves 
#define  COPYRVC_RemoveStdAttTables    0x00000800  //!<  Remove standard attribute tables in MfCopyDatabaseP() 
#define  COPYRVC_NoDBLists             0x00004000  //!<  MfCopyDatabase(): Don't copy DBList of database 
#define  COPYRVC_IgnoreStdAttTables    0x00040000  //!<  MfDatabaseJoin(): Ignore source standard attribute tables 
#define  COPYRVC_FreezeComputedFields  0x00080000 //!< MfCopyTable(): Computed fields in source become regular fields in dest.

#define  COPYRVC_AllLinks           (COPYRVC_RasterLinks | COPYRVC_DBaseLinks | COPYRVC_RVCLinks)

namespace RVC {

//! Flags for creating links.
enum MAKELINKFLAGS {
   MAKELINKFLAG_NoGeoreference =    0x0001,  //!< Don't create georeference subobjects
   MAKELINKFLAG_NoPyramidLinks =    0x0002,  //!< Don't create raster pyramid tier links
   MAKELINKFLAG_BuildHistograms =   0x0004,  //!< Build raster histogram subobjects when make link
   MAKELINKFLAG_BuildPyramids =     0x0008,  //!< Build raster pyramid tiers when make link
   MAKELINKFLAG_NoContrastTables =  0x0010,  //!< Don't create raster contrast tables
   MAKELINKFLAG_ColorComposite =    0x0020,  //!< Create raster links as color-composite (RGB) where appropriate
   MAKELINKFLAG_ColorSeparate =     0x0040,  //!< Create raster links as color separates where appropriate
   MAKELINKFLAG_None =              0x0000
   };
DEFINE_ENUM_OPERATORS(MAKELINKFLAGS);


//! TNTlite usability status.
enum LITEUSABILITY {
   LITEUSABILITY_OK =            0,    //!< Object and all subobjects are usable
   LITEUSABILITY_ObjectNo =      1,    //!< Object is not usable
   LITEUSABILITY_SubObjectNo =   2     //!< Object usable, but at least one subobject is not
   // Do not change these enum values as they are used as array indices!
   };

}  //! End of RVC namespace

/*-------------------------------------------------------------------------*/
/*    Define data types for .datatype fields                               */
/*-------------------------------------------------------------------------*/

#define  RVCTYPE_Unsigned     1        //!<  UINT8, UINT16, UINT32 and < 8 bit 
#define  RVCTYPE_Signed       2        //!<  INT8, INT16, INT32 
#define  RVCTYPE_Float        3        //!<  FLOAT, DOUBLE 
#define  RVCTYPE_RGB          8        //!<  RED, GREEN, BLUE packed (red high bits) 
#define  RVCTYPE_BGR          9        //!<  RED, GREEN, BLUE packed (blue high bits) 
#define  RVCTYPE_ComplexRI    16       //!<  Real, Imaginary 
#define  RVCTYPE_ComplexMP    17       //!<  Magnitude, Phase 

/* Due to an obsure but historical bug, 24 bit rasters are actually stored */
/* in the opposite order of what they say they are.  These #defines will */
/* allow you to account for that in a way that avoids the confusion */
#define  RVCTYPE_RGB24_Really 9        //!<  RED, GREEN, BLUE really 
#define  RVCTYPE_BGR24_Really 8        //!<  BLUE, GREEN, RED really 

/*----------------------------------------------------------------------------*/
/*    Definitions for object selection tools                                  */
/*----------------------------------------------------------------------------*/

#define  FILTMSGLEN  100

#define  FILT_NotVisible            0  //!<  Don't show object on list 
#define  FILT_NotUsable             0  //!<  Not usable (for GetLastUsed, CopySubObjects) 
#define  FILT_Selectable            1  //!<  Let user select 
#define  FILT_Usable                1  //!<  Usable (for GetLastUsed, CopySubObjects) 
#define  FILT_NotSelectable         FILT_NotUsable //!<  Show on list but don't let user select 
#define  FILT_FolderUsable          5  //!< Folder is usable

#if !defined(DEPRECATE_GROUPKEY)
#define  FILT_UsableSubobjects      4  //!<  Object not usable, but has usable subobjects 
#endif

/*-----------------------------------------------------------------------*/
/*    Defines for MfFindLinkFile...()                                    */
/*-----------------------------------------------------------------------*/

#define FINDFILE_Stored                0x1
#define FINDFILE_RefDrive              0x2
#define FINDFILE_RefPath               0x3
#define FINDFILE_Subtree               0x4
#define FINDFILE_DontAsk               0x80000000  //!<  Don't prompt if not found 

#define FINDFILE2(a,b) ((a) | (b<<4))
#define FINDFILE3(a,b,c) ((a) | (b<<4) | (c<<8))
#define FINDFILE4(a,b,c,d) ((a) | (b<<4) | (c<<8) | (d<<12))

#define FINDFILE_Default         FINDFILE4(FINDFILE_RefPath,FINDFILE_Stored,FINDFILE_RefDrive,FINDFILE_Subtree)
#define FINDFILE_StoredFirst     FINDFILE4(FINDFILE_Stored,FINDFILE_RefDrive,FINDFILE_RefPath,FINDFILE_Subtree)
#define FINDFILE_RefDriveFirst   FINDFILE4(FINDFILE_RefDrive,FINDFILE_RefPath,FINDFILE_Stored,FINDFILE_Subtree)

/* For backwards compatabilty, 1 implies FINDFILE_StoredFirst */

/*----------------------------------------------------------------------------*/
/*    Element number special values, used for database lookup and elsewhere   */
/*----------------------------------------------------------------------------*/

#define  ELEMENTNUM_DefaultList  -1
#define  ELEMENTNUM_None         -2

/*-------------------------------------------------------------------------*/
/*    Definitions for MfConvert... functions                               */
/*-------------------------------------------------------------------------*/

#define  CONVRASTCOMP_NoReserveStd64   0x00000001  //!<  Don't reserve 64 standard colors in output 

#define  CONVRASTLINE_Trace0Cells   0x0001
#define  CONVRASTLINE_Trace1Cells   0x0000

#define  CONVRASTBOUND_NoCreateTable      0x0001
#define  CONVRASTBOUND_DoImpliedGeoref    0x0002   //!< Output vector in implied map coordinates if possible 
#define  CONVRASTBOUND_ComputeStdAttrib   0x0004   //!< Compute standard attributes for vector.

#define  TINTORASTER_Linear         0
#define  TINTORASTER_Quintic        1
#define  TINTORASTER_CopyGeoref     0x0001
#define  TINTORASTER_AutoScale      0x0002
#define  TIN_ComputeStatistics      0x0001
#define  TIN_Optimize               0x0002

/*----------------------------------------------------------------------------*/
/*    Interpolation types for surface fitting conversions                     */
/*----------------------------------------------------------------------------*/

#define INTERPOLATE_Linear          1
#define INTERPOLATE_SplineCubic     2
#define INTERPOLATE_SplineQuad      3
#define INTERPOLATE_SplineBezier    4

#define SURFACEFIT_AutoRescale      0x0001
#define SURFACEFIT_MatchReference   0x0002
#define SURFACEFIT_UseDirection     0x0004

/*----------------------------------------------------------------------------*/
/*    MfCrossSectionCreate() flags                                            */
/*----------------------------------------------------------------------------*/

#define  CROSSSECTION_NoGeoreference   0x00000001

/*----------------------------------------------------------------------------*/
/*    Callback Structure and reasons for Mf(RVC) callbacks                    */
/*----------------------------------------------------------------------------*/

//! Callback structure
struct MfAnyCallbackStruct : public McbAnyCallbackStruct {
   int m_FileHandle;                   //!< File handle
   
   MfAnyCallbackStruct () {}           //! Default constructor, performs no initialization.
   MfAnyCallbackStruct (               //! Construct with specified reason value.
      int FileHandle,
      UINT32 ireason
      ):
      McbAnyCallbackStruct(ireason),
      m_FileHandle(FileHandle)
      { }
   };


typedef void (*MfCallbackFunc)(MfAnyCallbackStruct*,void*);

//! Callback structure
struct MfChildCallbackStruct : public MfAnyCallbackStruct {
   RVCINODENUM m_ParentInode;
   RVCINODENUM m_ObjectInode;
   
   MfChildCallbackStruct () {}            //! Default constructor, performs no initialization.
   MfChildCallbackStruct (             //! Construct with specified reason value.
      int FileHandle,
      RVCINODENUM ParentInode,
      RVCINODENUM ObjectInode,
      UINT32 ireason
      ):
      MfAnyCallbackStruct(FileHandle, ireason),
      m_ParentInode(ParentInode),
      m_ObjectInode(ObjectInode)
      { }
   };


//! Callback structure
struct MfExtentsCallbackStruct : public MfAnyCallbackStruct {
   DRECT3D m_Extents;
   
   MfExtentsCallbackStruct () {}          //! Default constructor, performs no initialization.
   MfExtentsCallbackStruct (              //! Construct with specified reason value.
      const DRECT3D& Extents,
      int FileHandle,
      UINT32 ireason
      ):
      MfAnyCallbackStruct(FileHandle, ireason),
      m_Extents(Extents)
      { }
   };


struct MfPointTypeCallbackStruct : public MfAnyCallbackStruct {
   int m_PointType;
   
   MfPointTypeCallbackStruct () {}           //! Default constructor, performs no initialization.
   MfPointTypeCallbackStruct (               //! Construct with specified reason value.
      int PointType,
      int FileHandle,
      UINT32 ireason
      ):
      MfAnyCallbackStruct(FileHandle, ireason),
      m_PointType(PointType)
      {}
   };


typedef void (*MfCallbackFunc)(MfAnyCallbackStruct*,void*);

#define MFCR_UndoBegin           0x00000101
#define MFCR_UndoEnd             0x00000102
#define MFCR_UndoPossible        0x00000104        //!< MfUndoMark() has been called, set buttons if needed
#define MFCR_ExtentsChanged      0x00000108
#define MFCR_PointTypeChanged    0x00000110
#define MFCR_NullValueChanged    0x00000111
#define MFCR_FileClosing         0x00000112
#define MFCR_ChildCreate         0x00000120
#define MFCR_ChildOpen           0x00000121
#define MFCR_ChildClosing        0x00000122

//---------------------------------------------------------------------------
//    Object Selection Dialog definitions
//---------------------------------------------------------------------------

//! Enumeration for flags used in object selection dialogs.
enum GETOBJFLAGS {
   GETOBJFLAG_None =             0x00000000, //!< No flags set
   GETOBJFLAG_NewOK =            0x00000001, //!< Let user create new objects
   GETOBJFLAG_DftNew =           0x00000002, //!< (OBSOLETE) Default to new object
   GETOBJFLAG_SkipOK =           0x00000004, //!< Allow user to skip this selection
   GETOBJFLAG_UseFilter =        0x00000020, //!< (OBSOLETE) Use the filter proc
   GETOBJFLAG_OnlyNew =          0x00000040, //!< Don't let user select existing objects
   GETOBJFLAG_Overwrite =        0x00000080, //!< Data in existing object will be overwritten
   GETOBJFLAG_AllowAll =         0x00000200, //!< Allow all object types in getrvcobjs()
   GETOBJFLAG_AllowFewer =       0x00008000, //!< Allow fewer than requested number of objects in RVC::DlgGetObjectSet()
   GETOBJFLAG_SkipNone =         0x00010000, //!< Change "Skip" button to "None", behavior same
   GETOBJFLAG_NoEditNameDesc =   0x00020000, //!< Don't allow user to edit Name/Description of existing object
   GETOBJFLAG_AllowAutoName =    0x00040000, //!< Allow "auto-name" for RVC::DlgGetObjectSet
   GETOBJFLAG_TablesAsSubObjs =  0x00100000, //!< Treat database tables as "subobjects" for selection purposes
   GETOBJFLAG_AllowDupObjs =     0x00200000, //!< Allow duplicate objects in DlgGetObjects()
   GETOBJFLAG_NoMetaData =       0x00400000, //!< Don't allow meta-data viewing/selection (used by meta-data editor)
   GETOBJFLAG_LabelsUnicode =    0x01000000, //!< Labels are MIUNICODE for MdlgGetObjectSet()
   GETOBJFLAG_NoChangeLevel =    0x02000000  //!< User can't navigate out from under initial object
   };
DEFINE_ENUM_OPERATORS(GETOBJFLAGS);
#define  GETOBJFLAG_NewOnly      GETOBJFLAG_OnlyNew
#define  GETOBJFLAG_MakeNew      GETOBJFLAG_Overwrite
#ifdef WIN32
#pragma deprecated("GETOBJFLAG_DftNew")
#pragma deprecated("GETOBJFLAG_UseFilter")
#pragma deprecated("GETOBJFLAG_MakeNew")
#endif


typedef int (*MfValidListProto) (const RVC::OBJITEMLIST&, void*, char*);

//!\addtogroup RVC RVC Object Funcions
//!@{

#if (defined(X_NATIVE) || defined(WIN32_MFC)) && !defined(NO_DEPRECATED)

//! Dialog allowing user to select an object of a specified type.
//! \deprecated Replaced by RVC::DlgGetObject().
DEPRECATED int MdlgGetObject (
   MDLGPARENT dlgparent,               //!< Parent of dialog
   FILEPATH& filepath,                 //!< Default file name
   INT32 *inode,                       //!< Object inode
   const void *prompt,                 //!< Prompt label
   int objtype,                        //!< Object type
   int hdrconv,                        //!< Header conversion
   void *vinfo,                        //!< Object header passed/returned
   int hdrsize,                        //!< Header size
   MfFiltFuncProto filter=0,           //!< Filter function
   void *filtuserdata=0,               //!< Filter function data
   GETOBJFLAGS flags=GETOBJFLAG_None   //!< Get object flags
   );

//! Dialog allowing user to select an object of a specified type.
//! \deprecated Replaced by RVC::DlgGetObject().
DEPRECATED int MdlgGetObject (
   MDLGPARENT dlgparent,               //!< Parent of dialog
   MIUNICODE *filename,                //!< Default file name
   INT32 *inode,                       //!< Object inode
   const void *prompt,                 //!< Prompt label
   int objtype,                        //!< Object type
   int hdrconv,                        //!< Header conversion
   void *vinfo,                        //!< Object header passed/returned
   int hdrsize,                        //!< Header size
   MfFiltFuncProto filter=0,           //!< Filter function
   void *filtuserdata=0,               //!< Filter function data
   GETOBJFLAGS flags=GETOBJFLAG_None   //!< Get object flags
   );

//! Dialog allowing user to select multiple objects of a specified type.
//! \deprecated Replaced by RVC::DlgGetObjects().
DEPRECATED int MdlgGetObjects (
   MDLGPARENT dlgparent,               //!< Parent of dialog
   FILEPATH& filepath,                 //!< Default filename
   INT32 parentinode,                  //!< Parent inode
   const void *prompt,                 //!< Prompt label
   int objtype,                        //!< Object type
   int minobjs,                        //!< Minimum number of objects required
   int maxobjs,                        //!< Maximum allowed to be selected, 0 if no limit
   RVC::OBJITEMLIST& ItemList,            //!< Item list returned
   MfFiltFuncProto filter=0,           //!< Filter function
   void *filtuserdata=0,               //!< Filter function data
   MfValidListProto validfunc=0,       //!< Validate function
   GETOBJFLAGS flags=GETOBJFLAG_None   //!< Get object flags
   );

//! Dialog allowing user to select multiple objects of a specified type.
//! \deprecated Replaced by RVC::DlgGetObjects().
DEPRECATED int MdlgGetObjects (
   MDLGPARENT dlgparent,               //!< Parent of dialog
   MIUNICODE *filename,                //!< Default filename
   INT32 parentinode,                  //!< Parent inode
   const void *prompt,                 //!< Prompt label
   int objtype,                        //!< Object type
   int minobjs,                        //!< Minimum number of objects required
   int maxobjs,                        //!< Maximum allowed to be selected, 0 if no limit
   FNAMEINODEUC **fnamein