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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
#if !defined( TABLE_INCLUDED ) /* Include this file only once */
#define TABLE_INCLUDED
/*
*+
* Name:
* table.h
* Type:
* C include file.
* Purpose:
* Define the interface to the Table class.
* Invocation:
* #include "table.h"
* Description:
* This include file defines the interface to the Table class and
* provides the type definitions, function prototypes and macros,
* etc. needed to use this class.
* Inheritance:
* The Table class inherits from the KeyMap class.
* Copyright:
* Copyright (C) 2010 Science & Technology Facilities Council.
* 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: David S. Berry (Starlink)
* History:
* 22-NOV-2010 (DSB):
* Original version.
*-
*/
/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "keymap.h" /* Parent class */
#if defined(astCLASS) /* Protected */
#include "channel.h" /* I/O channels */
#endif
/* C header files. */
/* --------------- */
#if defined(astCLASS) /* Protected */
#include <stddef.h>
#endif
/* Macros */
/* ====== */
/* Define a dummy __attribute__ macro for use on non-GNU compilers. */
#ifndef __GNUC__
# define __attribute__(x) /*NOTHING*/
#endif
#if defined(astCLASS) /* Protected */
/* Maximum length of a column name */
#define AST__MXCOLNAMLEN 100
/* Maximum length of a key for a column cell */
#define AST__MXCOLKEYLEN ( AST__MXCOLNAMLEN + 23 )
#endif
/* Type Definitions. */
/* ================= */
/* Table structure. */
/* ----------------- */
/* This structure contains all information that is unique to each
object in the class (e.g. its instance variables). */
typedef struct AstTable {
/* Attributes inherited from the parent class. */
AstKeyMap keymap; /* Parent class structure */
/* Attributes specific to objects in this class. */
int nrow; /* Mo. of rows in table */
AstKeyMap *columns; /* KeyMap holding column definitions */
AstKeyMap *parameters; /* KeyMap holding parameter definitions */
} AstTable;
/* 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 AstTableVtab {
/* Properties (e.g. methods) inherited from the parent class. */
AstKeyMapVtab keymap_vtab; /* Parent class virtual function table */
/* A Unique identifier to determine class membership. */
AstClassIdentifier id;
/* Properties (e.g. methods) specific to this class. */
AstKeyMap *(* ColumnProps)( AstTable *, int * );
AstKeyMap *(* ParameterProps)( AstTable *, int * );
const char *(* ColumnName)( AstTable *, int, int * );
const char *(* ParameterName)( AstTable *, int, int * );
const char *(* GetColumnUnit)( AstTable *, const char *, int * );
int (* GetColumnLenC)( AstTable *, const char *, int * );
int (* GetColumnLength)( AstTable *, const char *, int * );
int (* GetColumnNdim)( AstTable *, const char *, int * );
int (* GetColumnType)( AstTable *, const char *, int * );
int (* GetNcolumn)( AstTable *, int * );
int (* GetNparameter)( AstTable *, int * );
int (* GetNrow)( AstTable *, int * );
int (* HasColumn)( AstTable *, const char *, int * );
int (* HasParameter)( AstTable *, const char *, int * );
void (* AddColumn)( AstTable *, const char *, int, int, int *, const char *, int * );
void (* AddParameter)( AstTable *, const char *, int * );
void (* ColumnShape)( AstTable *, const char *, int, int *, int *, int * );
void (* PurgeRows)( AstTable *, int * );
void (* RemoveColumn)( AstTable *, const char *, int * );
void (* RemoveParameter)( AstTable *, const char *, int * );
void (* RemoveRow)( AstTable *, int, int * );
void (* SetNrow)( AstTable *, int, int * );
} AstTableVtab;
#if defined(THREAD_SAFE)
/* Define a structure holding all data items that are global within the
object.c file. */
typedef struct AstTableGlobals {
AstTableVtab Class_Vtab;
int Class_Init;
char GetAttrib_Buff[ 101 ];
} AstTableGlobals;
/* Thread-safe initialiser for all global data used by this module. */
void astInitTableGlobals_( AstTableGlobals * );
#endif
#endif
/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(Table) /* Check class membership */
astPROTO_ISA(Table) /* Test class membership */
/* Constructor. */
#if defined(astCLASS) /* Protected. */
AstTable *astTable_( const char *, int *, ...);
#else
AstTable *astTableId_( const char *, ... )__attribute__((format(printf,1,2)));
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
AstTable *astInitTable_( void *, size_t, int, AstTableVtab *,
const char *, int * );
/* Vtab initialiser. */
void astInitTableVtab_( AstTableVtab *, const char *, int * );
/* Loader. */
AstTable *astLoadTable_( void *, size_t, AstTableVtab *,
const char *, AstChannel *, int * );
#endif
/* Prototypes for member functions. */
/* -------------------------------- */
void astAddColumn_( AstTable *, const char *, int, int, int *, const char *, int * );
void astAddParameter_( AstTable *, const char *, int * );
void astRemoveColumn_( AstTable *, const char *, int * );
void astRemoveParameter_( AstTable *, const char *, int * );
void astRemoveRow_( AstTable *, int, int * );
void astPurgeRows_( AstTable *, int * );
const char *astColumnName_( AstTable *, int, int * );
const char *astParameterName_( AstTable *, int, int * );
void astColumnShape_( AstTable *, const char *, int, int *, int *, int * );
int astHasColumn_( AstTable *, const char *, int * );
int astHasParameter_( AstTable *, const char *, int * );
#if defined(astCLASS) /* Protected */
AstKeyMap *astColumnProps_( AstTable *, int * );
AstKeyMap *astParameterProps_( AstTable *, int * );
const char *astGetColumnUnit_( AstTable *, const char *, int * );
int astGetColumnLenC_( AstTable *, const char *, int * );
int astGetColumnLength_( AstTable *, const char *, int * );
int astGetColumnNdim_( AstTable *, const char *, int * );
int astGetColumnType_( AstTable *, const char *, int * );
int astGetNcolumn_( AstTable *, int * );
int astGetNparameter_( AstTable *, int * );
int astGetNrow_( AstTable *, int * );
void astSetNrow_( AstTable *, 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 astCheckTable(this) astINVOKE_CHECK(Table,this,0)
#define astVerifyTable(this) astINVOKE_CHECK(Table,this,1)
/* Test class membership. */
#define astIsATable(this) astINVOKE_ISA(Table,this)
/* Constructor. */
#if defined(astCLASS) /* Protected. */
#define astTable astINVOKE(F,astTable_)
#else
#define astTable astINVOKE(F,astTableId_)
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
#define astInitTable(mem,size,init,vtab,name) \
astINVOKE(O,astInitTable_(mem,size,init,vtab,name,STATUS_PTR))
/* Vtab Initialiser. */
#define astInitTableVtab(vtab,name) astINVOKE(V,astInitTableVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadTable(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadTable_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
#endif
/* Interfaces to public member functions. */
/* -------------------------------------- */
/* Here we make use of astCheckTable to validate Table pointers
before use. This provides a contextual error report if a pointer
to the wrong sort of Object is supplied. */
#define astAddColumn(this,name,type,ndim,dims,unit) astINVOKE(V,astAddColumn_(astCheckTable(this),name,type,ndim,dims,unit, STATUS_PTR))
#define astAddParameter(this,name) astINVOKE(V,astAddParameter_(astCheckTable(this),name,STATUS_PTR))
#define astRemoveColumn(this,name) astINVOKE(V,astRemoveColumn_(astCheckTable(this),name,STATUS_PTR))
#define astRemoveParameter(this,name) astINVOKE(V,astRemoveParameter_(astCheckTable(this),name,STATUS_PTR))
#define astRemoveRow(this,index) astINVOKE(V,astRemoveRow_(astCheckTable(this),index,STATUS_PTR))
#define astPurgeRows(this) astINVOKE(V,astPurgeRows_(astCheckTable(this),STATUS_PTR))
#define astColumnName(this,index) astINVOKE(V,astColumnName_(astCheckTable(this),index,STATUS_PTR))
#define astParameterName(this,index) astINVOKE(V,astParameterName_(astCheckTable(this),index,STATUS_PTR))
#define astColumnShape(this,column,mxdim,ndim,dims) astINVOKE(V,astColumnShape_(astCheckTable(this),column,mxdim,ndim,dims,STATUS_PTR))
#define astHasColumn(this,column) astINVOKE(V,astHasColumn_(astCheckTable(this),column,STATUS_PTR))
#define astHasParameter(this,param) astINVOKE(V,astHasParameter_(astCheckTable(this),param,STATUS_PTR))
#if defined(astCLASS) /* Protected */
#define astColumnProps(this) \
astINVOKE(O,astColumnProps_(astCheckTable(this),STATUS_PTR))
#define astParameterProps(this) \
astINVOKE(O,astParameterProps_(astCheckTable(this),STATUS_PTR))
#define astGetNcolumn(this) \
astINVOKE(V,astGetNcolumn_(astCheckTable(this),STATUS_PTR))
#define astGetNparameter(this) \
astINVOKE(V,astGetNparameter_(astCheckTable(this),STATUS_PTR))
#define astGetNrow(this) \
astINVOKE(V,astGetNrow_(astCheckTable(this),STATUS_PTR))
#define astSetNrow(this,value) \
astINVOKE(V,astSetNrow_(astCheckTable(this),value,STATUS_PTR))
#define astGetColumnLenC(this,column) \
astINVOKE(V,astGetColumnLenC_(astCheckTable(this),column,STATUS_PTR))
#define astGetColumnLength(this,column) \
astINVOKE(V,astGetColumnLength_(astCheckTable(this),column,STATUS_PTR))
#define astGetColumnNdim(this,column) \
astINVOKE(V,astGetColumnNdim_(astCheckTable(this),column,STATUS_PTR))
#define astGetColumnType(this,column) \
astINVOKE(V,astGetColumnType_(astCheckTable(this),column,STATUS_PTR))
#define astGetColumnUnit(this,column) \
astINVOKE(V,astGetColumnUnit_(astCheckTable(this),column,STATUS_PTR))
#endif
#endif
|
