1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
#if !defined( MOCCHAN_INCLUDED ) /* Include this file only once */
#define MOCCHAN_INCLUDED
/*
*+
* Name:
* mocchan.h
* Type:
* C include file.
* Purpose:
* Define the interface to the MocChan class.
* Invocation:
* #include "mocchan.h"
* Description:
* This include file defines the interface to the MocChan class and
* provides the type definitions, function prototypes and macros,
* etc. needed to use this class.
*
* The MocChan class provides facilities for reading and writing AST
* Moc Objects in either JSON or string form, using the serialisations
* defined in the IVOA's MOC recommendation, version 1.1.
* Inheritance:
* The MocChan class inherits from the Channel class.
* Copyright:
* Copyright (C) 2019 East Asian Observatory
* All Rights Reserved.
* Licence:
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, either
* version 3 of the License, or (at your option) any later
* version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
* Authors:
* DSB: D.S. Berry (EAO)
* History:
* 7-MAY-2019 (DSB):
* Original version.
*-
*/
/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "channel.h" /* I/O channels (parent class) */
/* C header files. */
/* --------------- */
#if defined(astCLASS) /* Protected */
#include <stddef.h>
#endif
/* Macros. */
/* ------- */
#if defined(astCLASS) || defined(astFORTRAN77)
#define STATUS_PTR status
#else
#define STATUS_PTR astGetStatusPtr
#endif
/* Define constants used to size global arrays in this module. */
/* Define other numerical constants for use in this module. */
#define AST__MOCCHAN_GETATTRIB_BUFF_LEN 200
/* Type Definitions. */
/* ================= */
/* MocChan structure. */
/* ------------------ */
/* This structure contains all information that is unique to each object in
the class (e.g. its instance variables). */
typedef struct AstMocChan {
/* Attributes inherited from the parent class. */
AstChannel channel; /* Parent class structure */
/* Attributes specific to objects in this class. */
int mocformat; /* Encoding scheme */
int moclinelen; /* Buffer length */
} AstMocChan;
/* Virtual function table. */
/* ----------------------- */
/* This table contains all information that is the same for all
objects in the class (e.g. pointers to its virtual functions). */
#if defined(astCLASS) /* Protected */
typedef struct AstMocChanVtab {
/* Properties (e.g. methods) inherited from the parent class. */
AstChannelVtab channel_vtab; /* Parent class virtual function table */
/* A Unique identifier to determine class membership. */
AstClassIdentifier id;
/* Properties (e.g. methods) specific to this class. */
int (* GetMocFormat)( AstMocChan *, int * );
int (* TestMocFormat)( AstMocChan *, int * );
void (* SetMocFormat)( AstMocChan *, int, int * );
void (* ClearMocFormat)( AstMocChan *, int * );
int (* GetMocLineLen)( AstMocChan *, int * );
int (* TestMocLineLen)( AstMocChan *, int * );
void (* ClearMocLineLen)( AstMocChan *, int * );
void (* SetMocLineLen)( AstMocChan *, int, int * );
} AstMocChanVtab;
#if defined(THREAD_SAFE)
typedef struct AstMocChanGlobals {
AstMocChanVtab Class_Vtab;
int Class_Init;
char GetAttrib_Buff[ AST__MOCCHAN_GETATTRIB_BUFF_LEN + 1 ];
} AstMocChanGlobals;
#endif
#endif
/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(MocChan) /* Check class membership */
astPROTO_ISA(MocChan) /* Test class membership */
/* Constructor. */
#if defined(astCLASS) /* Protected. */
AstMocChan *astMocChan_( const char *(*)( void ), void (*)( const char * ),
const char *, int *, ...);
#else
AstMocChan *astMocChanId_( const char *(*)( void ), void (*)( const char * ),
const char *, ... );
AstMocChan *astMocChanForId_( const char *(*)( void ),
char *(*)( const char *(*)( void ), int * ),
void (*)( const char * ),
void (*)( void (*)( const char * ),
const char *, int * ),
const char *, ... );
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
AstMocChan *astInitMocChan_( void *, size_t, int, AstMocChanVtab *,
const char *, const char *(*)( void ),
char *(*)( const char *(*)( void ), int * ),
void (*)( const char * ),
void (*)( void (*)( const char * ),
const char *, int * ), int * );
/* Vtab initialiser. */
void astInitMocChanVtab_( AstMocChanVtab *, const char *, int * );
/* Loader. */
AstMocChan *astLoadMocChan_( void *, size_t, AstMocChanVtab *,
const char *, AstChannel *, int * );
/* Thread-safe initialiser for all global data used by this module. */
#if defined(THREAD_SAFE)
void astInitMocChanGlobals_( AstMocChanGlobals * );
#endif
#endif
/* Prototypes for member functions. */
/* -------------------------------- */
# if defined(astCLASS) /* Protected */
int astGetMocFormat_( AstMocChan *, int * );
int astTestMocFormat_( AstMocChan *, int * );
void astSetMocFormat_( AstMocChan *, int, int * );
void astClearMocFormat_( AstMocChan *, int * );
int astGetMocLineLen_( AstMocChan *, int * );
int astTestMocLineLen_( AstMocChan *, int * );
void astClearMocLineLen_( AstMocChan *, int * );
void astSetMocLineLen_( AstMocChan *, int, int * );
#endif
/* Function interfaces. */
/* ==================== */
/* These macros are wrap-ups for the functions defined by this class
to make them easier to invoke (e.g. to avoid type mis-matches when
passing pointers to objects from derived classes). */
/* Interfaces to standard class functions. */
/* --------------------------------------- */
/* Some of these functions provide validation, so we cannot use them
to validate their own arguments. We must use a cast when passing
object pointers (so that they can accept objects from derived
classes). */
/* Check class membership. */
#define astCheckMocChan(this) astINVOKE_CHECK(MocChan,this,0)
#define astVerifyMocChan(this) astINVOKE_CHECK(MocChan,this,1)
/* Test class membership. */
#define astIsAMocChan(this) astINVOKE_ISA(MocChan,this)
/* Constructor. */
#if defined(astCLASS) /* Protected. */
#define astMocChan astINVOKE(F,astMocChan_)
#else
#define astMocChan astINVOKE(F,astMocChanId_)
#define astMocChanFor astINVOKE(F,astMocChanForId_)
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
#define astInitMocChan(mem,size,init,vtab,name,source,source_wrap,sink,sink_wrap) \
astINVOKE(O,astInitMocChan_(mem,size,init,vtab,name,source,source_wrap,sink,sink_wrap,STATUS_PTR))
/* Vtab Initialiser. */
#define astInitMocChanVtab(vtab,name) astINVOKE(V,astInitMocChanVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadMocChan(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadMocChan_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
#endif
/* Interfaces to member functions. */
/* ------------------------------- */
/* Here we make use of astCheckMocChan to validate MocChan pointers
before use. This provides a contextual error report if a pointer
to the wrong sort of Object is supplied. */
#if defined(astCLASS) /* Protected */
#define astClearMocFormat(this) \
astINVOKE(V,astClearMocFormat_(astCheckMocChan(this),STATUS_PTR))
#define astGetMocFormat(this) \
astINVOKE(V,astGetMocFormat_(astCheckMocChan(this),STATUS_PTR))
#define astSetMocFormat(this,mocformat) \
astINVOKE(V,astSetMocFormat_(astCheckMocChan(this),mocformat,STATUS_PTR))
#define astTestMocFormat(this) \
astINVOKE(V,astTestMocFormat_(astCheckMocChan(this),STATUS_PTR))
#define astClearMocLineLen(this) \
astINVOKE(V,astClearMocLineLen_(astCheckMocChan(this),STATUS_PTR))
#define astGetMocLineLen(this) \
astINVOKE(V,astGetMocLineLen_(astCheckMocChan(this),STATUS_PTR))
#define astSetMocLineLen(this,moclinelen) \
astINVOKE(V,astSetMocLineLen_(astCheckMocChan(this),moclinelen,STATUS_PTR))
#define astTestMocLineLen(this) \
astINVOKE(V,astTestMocLineLen_(astCheckMocChan(this),STATUS_PTR))
#endif
#endif
|
