home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: Science / Science.zip / imdisp79.zip / DF.H < prev    next >
Text File  |  2003-02-02  |  12KB  |  267 lines
  1. /*****************************************************************************
  2. * 
  3. *              NCSA HDF version 3.00
  4. *                December, 1989
  5. *
  6. * NCSA HDF Version 3.00 source code and documentation are in the public
  7. * domain.  Specifically, we give to the public domain all rights for future
  8. * licensing of the source code, all resale rights, and all publishing rights.
  9. * 
  10. * We ask, but do not require, that the following message be included in all
  11. * derived works:
  12. * 
  13. * Portions developed at the National Center for Supercomputing Applications at
  14. * the University of Illinois at Urbana-Champaign.
  15. * 
  16. * THE UNIVERSITY OF ILLINOIS GIVES NO WARRANTY, EXPRESSED OR IMPLIED, FOR THE
  17. * SOFTWARE AND/OR DOCUMENTATION PROVIDED, INCLUDING, WITHOUT LIMITATION,
  18. * WARRANTY OF MERCHANTABILITY AND WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE
  19. * 
  20. *****************************************************************************/
  21.  
  22. /*-----------------------------------------------------------------------------
  23.  * File:    df.h
  24.  * Purpose: header file for HDF routines
  25.  * Invokes: dfi.h
  26.  * Contents: 
  27.  *  Structure definitions: DFddh, DFdd, DFdesc, DFdle, DF, DFdi, DFdata
  28.  *  Procedure type definitions
  29.  *  Global variables
  30.  *  Tag definitions
  31.  *  Error return codes
  32.  *  Logical constants
  33.  * Remarks: This file is included with user programs
  34.  *          Since it includes stdio.h etc., do not include these after df.h
  35.  *---------------------------------------------------------------------------*/
  36.  
  37.  
  38. #ifndef DFTAG_NULL              /* avoid re-inclusion */
  39.  
  40. /* include DF (internal) header information */
  41. #include "dfi.h"
  42. #ifdef UNICOS
  43. #include <fortran.h>
  44. #endif /*UNICOS*/
  45.  
  46. /*-------------------------------------------------------------------------*/
  47. /*                      Type declarations                                   */
  48.  
  49. typedef struct DFddh {        /*format of data descriptor headers in file*/
  50.     int16 dds;            /* number of dds in header block */
  51.     int32 next;            /* offset of next header block */
  52. } DFddh;
  53.  
  54. typedef struct DFdd {        /* format of data descriptors as in file */
  55.     uint16 tag;            /* data tag */
  56.     uint16 ref;            /* data reference number */
  57.     int32 offset;        /* offset of data element in file */
  58.     int32 length;        /* number of bytes */
  59. } DFdd;
  60.  
  61. /* descriptor structure is same as dd structure.  ###Note: may be changed */
  62. typedef DFdd DFdesc;
  63.  
  64. /* DLE is the internal structure which stores data descriptor information */
  65. /* It is a linked list of DDs */
  66. typedef struct DFdle {        /* Data List element */
  67.     struct DFdle *next;        /* link to next dle */
  68.     DFddh ddh;            /* To store headers */
  69.     DFdd dd[1];            /* dummy size */
  70. } DFdle;
  71.  
  72. /* DF is the internal structure associated with each DF file */
  73. /* It holds information associated with the file as a whole */
  74. /* ### Note: there are hooks for having multiple DF files open at a time */
  75. typedef struct DF {
  76.     DFdle *list;        /* Pointer to the DLE list */
  77.     DFdle *last_dle;        /* last_dle and last_dd are used in searches */
  78.                 /* to indicate element returned */
  79.                 /* by previous call to DFfind */
  80.     int type;            /* 0= not in use, 1= normal, -1 = multiple */
  81.                 /* this is a hook for when */
  82.                 /* multiple files are open */
  83.     int access;            /* permitted access types: */
  84.                 /* 0=none, 1=r, 2=w, 3=r/w */
  85.     int changed;        /* True if anything in DDs modified */
  86.                 /* since last write */
  87.     uint16 last_tag;        /* Last tag searched for by DFfind */
  88.     uint16 last_ref;        /* Last reference number searched for */
  89.     int last_dd;        /* see last_dle */
  90.     int defdds;            /* default numer of DD's in each block */
  91.     int up_access;        /* access permissions to element being */
  92.                 /* read/updated. Used by DFstart */
  93.     DFdd *up_dd;        /* DD of element being read/updated, */
  94.                 /* used by DFstart */
  95.     /* file handle is a file pointer or file descriptor depending on whether */
  96.     /* we use buffered or unbuffered i/o */
  97. #ifdef DF_BUFFIO
  98.     FILE *file;            /* file pointer */
  99. #else /*DF_BUFFIO*/
  100.     int file;            /* file descriptor */
  101. #endif /*DF_BUFFIO*/
  102. } DF;
  103.  
  104.  
  105. typedef struct DFdi {   /* data identifier: specifies data element uniquely */
  106.     uint16 tag;
  107.     uint16 ref;
  108. } DFdi;
  109.  
  110.  
  111.  
  112. typedef struct DFdata { /* structure for returning status information */
  113.     int version;        /* version number of program */
  114. } DFdata;
  115.  
  116. /*--------------------------------------------------------------------------*/
  117. /*                          Procedure types                                 */
  118.  
  119. #ifndef VMS
  120. DF *DFopen();
  121. int32 DFgetelement(), DFread(), DFseek(), DFwrite();
  122. uint16 DFnewref();
  123. char *DFIgetspace(), *DFIfreespace(), *DFIf2cstring();
  124. #else /*VMS*/
  125.             /* for VMS need to prepend _ to avoid name conflict with Fortran */
  126. DF *_DFopen();
  127. int32 _DFgetelement(), _DFread(), _DFseek(), _DFwrite();
  128. uint16 _DFnewref();
  129. char *_DFIgetspace(), *_DFIfreespace(), *_DFIf2cstring();
  130. #endif /*VMS*/
  131.  
  132. /*--------------------------------------------------------------------------*/
  133. /*                          Global Variables                                */
  134.  
  135. #ifndef DFMASTER
  136. extern
  137. #endif /*DFMASTER*/
  138. int DFerror;            /* Error code for DF routines */
  139.  
  140. /*--------------------------------------------------------------------------*/
  141. /*                           Tag Definitions                                */
  142.  
  143. #define DFREF_WILDCARD ((uint16)0) /* wildcard ref for searches */
  144.  
  145. #define DFTAG_WILDCARD ((uint16)0) /* wildcard tag for searches */
  146. #define DFTAG_NULL  ((uint16)1)    /* empty DD */
  147.  
  148. /* utility set */
  149. #define DFTAG_FID   ((uint16)100) /* File identifier */
  150. #define DFTAG_FD    ((uint16)101) /* File description */
  151. #define DFTAG_TID   ((uint16)102) /* Tag identifier */
  152. #define DFTAG_TD    ((uint16)103) /* Tag descriptor */
  153. #define DFTAG_DIL   ((uint16)104) /* data identifier label */
  154. #define DFTAG_DIA   ((uint16)105) /* data identifier annotation */
  155. #define DFTAG_NT    ((uint16)106) /* number type */
  156. #define DFTAG_MT    ((uint16)107) /* machine type */
  157.  
  158. /* raster-8 set */
  159. #define DFTAG_ID8   ((uint16)200) /* 8-bit Image dimension */
  160. #define DFTAG_IP8   ((uint16)201) /* 8-bit Image palette */
  161. #define DFTAG_RI8   ((uint16)202) /* Raster-8 image */
  162. #define DFTAG_CI8   ((uint16)203) /* RLE compressed 8-bit image */
  163. #define DFTAG_II8   ((uint16)204) /* IMCOMP compressed 8-bit image */
  164.  
  165. /* Raster Image set */
  166. #define DFTAG_ID    ((uint16)300) /* Image DimRec */
  167. #define DFTAG_LUT   ((uint16)301) /* Image Palette */
  168. #define DFTAG_RI    ((uint16)302) /* Raster Image */
  169. #define DFTAG_CI    ((uint16)303) /* Compressed Image */
  170.  
  171. #define DFTAG_RIG   ((uint16)306) /* Raster Image Group */
  172. #define DFTAG_LD    ((uint16)307) /* Palette DimRec */
  173. #define DFTAG_MD    ((uint16)308) /* Matte DimRec */
  174. #define DFTAG_MA    ((uint16)309) /* Matte Data */
  175. #define DFTAG_CCN   ((uint16)310) /* color correction */
  176. #define DFTAG_CFM   ((uint16)311) /* color format */
  177. #define DFTAG_AR    ((uint16)312) /* aspect ratio */
  178.  
  179. #define DFTAG_DRAW  ((uint16)400) /* Draw these images in sequence */
  180. #define DFTAG_RUN   ((uint16)401) /* run this as a program/script */
  181.  
  182. #define DFTAG_XYP   ((uint16)500) /* x-y position */
  183. #define DFTAG_MTO   ((uint16)501) /* machine-type override */
  184.  
  185. /* Tektronix */
  186. #define DFTAG_T14   ((uint16)602) /* TEK 4014 data */
  187. #define DFTAG_T105  ((uint16)603) /* TEK 4105 data */
  188.  
  189. /* Scientific Data set */
  190. #define DFTAG_SDG   ((uint16)700) /* Scientific Data Group */
  191. #define DFTAG_SDD   ((uint16)701) /* Scientific Data DimRec */
  192. #define DFTAG_SD    ((uint16)702) /* Scientific Data */
  193. #define DFTAG_SDS   ((uint16)703) /* Scales */
  194. #define DFTAG_SDL   ((uint16)704) /* Labels */
  195. #define DFTAG_SDU   ((uint16)705) /* Units */
  196. #define DFTAG_SDF   ((uint16)706) /* Formats */
  197. #define DFTAG_SDM   ((uint16)707) /* Max/Min */
  198. #define DFTAG_SDC   ((uint16)708) /* Coord sys */
  199. #define DFTAG_SDT   ((uint16)709) /* Transpose */
  200.  
  201. /* compression schemes */
  202. #define DFTAG_RLE   ((uint16)11) /* run length encoding */
  203. #define DFTAG_IMC   ((uint16)12) /* IMCOMP compression */
  204.  
  205. /*--------------------------------------------------------------------------*/
  206. /*                          Error Return Codes                              */
  207.  
  208. #define DFE_NOERROR     0   /* No error */
  209. #define DFE_FNF         -1  /* File not found error */
  210. #define DFE_DENIED      -2  /* Access to file denied */
  211. #define DFE_ALROPEN     -3  /* File already open */
  212. #define DFE_TOOMANY     -4  /* Too Many DF's or files open */
  213. #define DFE_BADNAME     -5  /* Bad file name on open */
  214. #define DFE_BADACC      -6  /* Bad file access mode */
  215. #define DFE_BADOPEN     -7  /* Other open error */
  216. #define DFE_NOTOPEN     -8  /* File can't be closed 'cause it isn't open */
  217. #define DFE_CANTCLOSE   -9  /* fclose wouldn't work! */
  218. #define DFE_DFNULL      -10 /* DF is a null pointer */
  219. #define DFE_ILLTYPE     -11 /* DF has an illegal type: internal error */
  220. #define DFE_UNSUPPORTED -12 /* Feature not currently supported */
  221. #define DFE_BADDDLIST   -13 /* The DD list is non-existent: internal error */
  222. #define DFE_NOTDFFILE   -14 /* This is not a DF file and it is not 0 length */
  223. #define DFE_SEEDTWICE   -15 /* The DD list already seeded: internal error */
  224. #define DFE_NOSPACE     -16 /* Malloc failed */
  225. #define DFE_NOSUCHTAG   -17 /* There is no such tag in the file: search failed*/
  226. #define DFE_READERROR   -18 /* There was a read error */
  227. #define DFE_WRITEERROR  -19 /* There was a write error */
  228. #define DFE_SEEKERROR   -20 /* There was a seek error */
  229. #define DFE_NOFREEDD    -21 /* There are no free DD's left: internal error */
  230. #define DFE_BADTAG      -22 /* illegal WILDCARD tag */
  231. #define DFE_BADREF      -23 /* illegal WILDCARD reference # */
  232. #define DFE_RDONLY      -24 /* The DF is read only */
  233. #define DFE_BADCALL     -25 /* Calls in wrong order */
  234. #define DFE_BADPTR      -26 /* NULL ptr argument */
  235. #define DFE_BADLEN      -27 /* negative len specified */
  236. #define DFE_BADSEEK     -28 /* Attempt to seek past end of element */
  237. #define DFE_NOMATCH     -29 /* No (more) DDs which match specified tag/ref */
  238. #define DFE_NOTINSET    -30 /* Warning: Set contained unknown tag: ignored */
  239. #define DFE_BADDIM      -31 /* negative or zero dimensions specified */
  240. #define DFE_BADOFFSET   -32 /* Illegal offset specified */
  241. #define DFE_BADSCHEME   -33 /* Unknown compression scheme specified */
  242. #define DFE_NODIM       -34 /* No dimension record associated with image */
  243. #define DFE_NOTENOUGH   -35 /* space provided insufficient for size of data */
  244. #define DFE_NOVALS      -36 /* Values not available */
  245. #define DFE_CORRUPT     -37 /* File is corrupted */
  246. #define DFE_BADCONV     -37 /* Don't know how to convert data type */
  247. #define DFE_BADFP       -38 /* The file contained an illegal floating point no*/
  248. #define DFE_NOREF       -39 /* no more reference numbers are available */
  249. #define DFE_BADDATATYPE -40 /* unknown or unavailable data type specified */
  250. #define DFE_BADMCTYPE   -41 /* unknown or unavailable machine type specified */
  251. #define DFE_BADNUMTYPE  -42 /* unknown or unavailable number type specified */
  252. #define DFE_BADORDER    -43 /* unknown or illegal array order specified */
  253. #define DFE_NOTIMPL     -44 /* This feature not yet implemented */
  254.  
  255. /*--------------------------------------------------------------------------*/
  256. /*                          Logical Constants                               */
  257.  
  258. #define DFACC_READ      1   /* Read Access */
  259. #define DFACC_WRITE     2   /* Write Access */
  260. #define DFACC_CREATE    4   /* force file to be created */
  261. #define DFACC_ALL       7   /* the logical and of all the above values */
  262.  
  263. #ifdef PC
  264. #include "hdf_func.h"        /* function prototypes to the hdf functions */
  265. #endif    /* PC */
  266. #endif /*DFTAG_NULL*/
  267.