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
|
#if !defined( C2F77_INCLUDED ) /* Include this file only once */
#define C2F77_INCLUDED
/*
*+
* Name:
* c2f77.h
* Purpose:
* Define the interface to the c2f77 module.
* Description:
* This file defines language-specific functions which support the
* FORTRAN 77 interface to the AST library.
*
* Note that this module is not a class implementation, although it
* resembles one.
* Functions Defined:
* Public:
* None.
*
* Protected:
* astStringExport
* Export a C string to a FORTRAN string.
* Macros Defined:
* Public:
* None.
*
* Protected:
* astWatchSTATUS
* Execute C code while watching a FORTRAN STATUS variable.
* Copyright:
* Copyright (C) 1997-2006 Council for the Central Laboratory of the
* Research Councils
* 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:
* RFWS: R.F. Warren-Smith (Starlink)
* DSB: David S. Berry (Starlink)
* History:
* 15-NOV-1996 (RFWS):
* Original version.
* 16-JUL-1997 (RFWS):
* Added astWatchSTATUS.
* 13-JUN-2001 (DSB):
* Make astStringExport available to F77 interface modules as well
* as AST classes.
*-
*/
/* Macros. */
/* ======= */
/*
*+
* Name:
* astWatchSTATUS
* Type:
* Protected macro.
* Purpose:
* Execute C code while watching a FORTRAN STATUS variable.
* Synopsis:
* #include "c2f77.h"
* astWatchSTATUS(code)
* Description:
* This macro expands to code which executes the C code supplied
* via the "code" argument in a new C scope (delimited by
* {...}). The code supplied executes while the AST error status is
* equated to a variable called STATUS, which is an error status
* argument passed from a FORTRAN routine using the macros defined
* in the "f77.h" include file.
*
* The effect of this is roughly as if the astWatch function had
* been used to locally declare the FORTRAN STATUS argument as a
* new AST error status variable, except that this macro also works
* if STATUS is not an int.
* Parameters:
* code
* The C code to be executed.
* Examples:
* F77_SUBROUTINE(ast_doit)( INTEGER(STATUS) ) {
* astWatchSTATUS(
* astDoit();
* )
* }
* Causes the astDoit function to be invoked as if the AST error
* status were equated to the STATUS argument passed from
* FORTRAN. Typically, if STATUS is set to an error value,
* astDoit would detect this by means of the astOK macro and
* would not then execute. If an error occurs in astDoit,
* causing the AST error status to be set, then that value is
* transferred to STATUS after the C code has executed (i.e. at
* the end of the astWatchSTATUS macro).
* Notes:
* - The FORTRAN argument must be called STATUS and must appear in
* the C function's parameter list as an argument of the INTEGER()
* macro defined in the "f77.h" include file.
* - The C code supplied executes in a new scope, in which
* automatic variables may be declared. However, such variables
* will not exist after the macro's expansion has been executed.
* - The AST error status variable and its value remain unchanged
* after the expansion of this macro has executed.
*-
*/
/* Define the macro. */
#define astWatchSTATUS(code) \
\
/* Begin a new C scope. */ \
{ \
\
/* Ensure that a pointer to the STATUS argument exists. */ \
GENPTR_INTEGER(STATUS) \
\
/* Store the STATUS value in a local int. */ \
int ast_local_status = *STATUS; \
int *status = &ast_local_status; \
\
/* Make this int the AST error status variable, saving the address of \
the previous variable. */ \
int *ast_previous_status = astWatch( &ast_local_status ); \
\
/* Execute the code supplied using the new error status variable. */ \
code \
\
/* Restore the original error status variable. */ \
(void) astWatch( ast_previous_status ); \
\
/* Return the final error status to STATUS. */ \
*STATUS = ast_local_status; \
}
/* Function prototypes. */
/* ==================== */
void astStringExport_( const char *, char *, int );
/* Function interfaces. */
/* ==================== */
/* These wrap up the functions defined by this module to make them
easier to use. */
#define astStringExport astStringExport_
#endif
|
