source: git/src/img.h @ 081ef63

RELEASE/1.0RELEASE/1.1RELEASE/1.2debug-cidebug-ci-sanitisersfaster-cavernloglog-selectstereostereo-2025walls-datawalls-data-hanging-as-warningwarn-only-for-hanging-survey
Last change on this file since 081ef63 was a2ad284, checked in by Olly Betts <olly@…>, 24 years ago

Enhanced img to read arbitrarily long title and datestamp.

git-svn-id: file:///home/survex-svn/survex/trunk@1305 4b37db11-9a0c-4f06-9ece-9ab7cdaee568

  • Property mode set to 100644
File size: 4.8 KB
Line 
1/* > img.h
2 * Header file for routines to read and write Survex ".3d" image files
3 * Copyright (C) Olly Betts 1993,1994,1997,2001
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18 */
19
20#ifndef IMG_H
21# define IMG_H
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27#include <stdio.h>
28
29# ifdef IMG_HOSTED
30#  include "useful.h"
31# endif
32
33# define img_BAD   -2
34# define img_STOP  -1
35# define img_MOVE   0
36# define img_LINE   1
37/* NB: img_CROSS is never output and ignored on input.
38 * Put crosses where labels are. */
39/* # define img_CROSS  2 */
40# define img_LABEL  3
41
42# define img_FLAG_SURFACE   0x01
43# define img_FLAG_DUPLICATE 0x02
44# define img_FLAG_SPLAY     0x04
45
46# define img_SFLAG_SURFACE     0x01
47# define img_SFLAG_UNDERGROUND 0x02
48# define img_SFLAG_ENTRANCE    0x04
49# define img_SFLAG_EXPORTED    0x08
50# define img_SFLAG_FIXED       0x10
51
52typedef struct {
53   double x, y, z;
54} img_point;
55   
56typedef struct {
57   /* members you can access when reading (don't touch when writing) */
58   char *label;
59   int flags;
60   char *title;
61   char *datestamp;
62   /* all other members are for internal use only */
63   FILE *fh;          /* file handle of image file */
64   char *label_buf;
65   size_t buf_len;
66   size_t label_len;
67# ifdef IMG_HOSTED
68   bool fRead;        /* fTrue for reading, fFalse for writing */
69# else
70   int fRead;        /* fTrue for reading, fFalse for writing */
71# endif
72   long start;
73   /* version of file format (0 => 0.01 ascii, 1 => 0.01 binary,
74    * 2 => byte actions and flags, 3 => prefixes for legs; compressed
75    * prefixes) */
76   int version;
77   char *survey;
78   size_t survey_len;
79   int pending; /* for old style text format files and survey filtering */
80   img_point mv;
81} img;
82
83/* Which version of the file format to output (defaults to newest) */
84extern unsigned int img_output_version;
85
86/* Open a .3d file for reading
87 * fnm is the filename
88 * Returns pointer to an img struct or NULL
89 */
90#define img_open(F) img_open_survey((F), NULL)
91
92/* Open a .3d file for reading
93 * fnm is the filename
94 * Returns pointer to an img struct or NULL
95 * survey points to a survey name to restrict reading to (or NULL for all
96 * survey data in the file)
97 */
98img *img_open_survey(const char *fnm, const char *survey);
99
100/* Open a .3d file for output
101 * fnm is the filename
102 * title_buf is the title
103 * fBinary == 0 for ASCII .3d file
104 *         != 0 for binary .3d file
105 * NB only the original .3d file format has an ASCII variant
106 * Returns pointer to an img struct or NULL for error (check img_error()
107 * for details)
108 */
109# ifdef IMG_HOSTED
110img *img_open_write(const char *fnm, char *title_buf, bool fBinary);
111# else
112img *img_open_write(const char *fnm, char *title_buf, int fBinary);
113# endif
114
115/* Read an item from a .3d file
116 * pimg is a pointer to an img struct returned by img_open()
117 * coordinates are returned in p
118 * flags and label name are returned in fields in pimg
119 * Returns img_XXXX as #define-d above
120 */
121int img_read_item(img *pimg, img_point *p);
122
123/* Write a item to a .3d file
124 * pimg is a pointer to an img struct returned by img_open_write()
125 * code is one of the img_XXXX #define-d above
126 * flags is the leg or station flags (meaningful for img_LINE and img_LABEL
127 * s is the label (only meaningful for img_LABEL)
128 * x, y, z are the coordinates
129 */
130void img_write_item(img *pimg, int code, int flags, const char *s,
131                    double x, double y, double z);
132
133/* rewind a .3d file opened for reading so the data can be read in
134 * several passes
135 * pimg is a pointer to an img struct returned by img_open()
136 */
137void img_rewind(img *pimg);
138
139/* Close a .3d file
140 * pimg is a pointer to an img struct returned by img_open() or
141 *   img_open_write()
142 * Returns: non-zero for success, zero for error (check img_error() for
143 *   details)
144 */
145int img_close(img *pimg);
146
147/* Codes returned by img_error */
148# ifndef IMG_HOSTED
149typedef enum {
150   IMG_NONE = 0, IMG_FILENOTFOUND, IMG_OUTOFMEMORY,
151   IMG_CANTOPENOUT, IMG_BADFORMAT, IMG_DIRECTORY,
152   IMG_READERROR, IMG_WRITEERROR, IMG_TOONEW
153} img_errcode;
154
155/* Read the error code
156 * if img_open() or img_open_write() returns NULL, you can call this
157 * to discover why */
158img_errcode img_error(void);
159# else
160int img_error(void);
161# endif
162
163#ifdef __cplusplus
164}
165#endif
166
167#endif
Note: See TracBrowser for help on using the repository browser.