/usr/include/octave-3.8.1/octave/f77-fcn.h is in liboctave-dev 3.8.1-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
Copyright (C) 1996-2013 John W. Eaton
This file is part of Octave.
Octave is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.
Octave 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 General Public License
for more details.
You should have received a copy of the GNU General Public License
along with Octave; see the file COPYING. If not, see
<http://www.gnu.org/licenses/>.
*/
#if !defined (octave_f77_fcn_h)
#define octave_f77_fcn_h 1
#include "quit.h"
#ifdef __cplusplus
extern "C" {
#endif
/* Hack to stringize macro results. */
#define xSTRINGIZE(x) #x
#define STRINGIZE(x) xSTRINGIZE(x)
/* How to print an error for the F77_XFCN macro. */
#define F77_XFCN_ERROR(f, F) \
(*current_liboctave_error_handler) \
("exception encountered in Fortran subroutine %s", \
STRINGIZE (F77_FUNC (f, F)))
/* This can be used to call a Fortran subroutine that might call
XSTOPX. XSTOPX will call lonjmp with current_context. Once back
here, we'll restore the previous context and return. We may also
end up here if an interrupt is processed when the Fortran
subroutine is called. In that case, we resotre the context and go
to the top level. The error_state should be checked immediately
after this macro is used. */
#define F77_XFCN(f, F, args) \
do \
{ \
octave_jmp_buf saved_context; \
sig_atomic_t saved_octave_interrupt_immediately = octave_interrupt_immediately; \
f77_exception_encountered = 0; \
octave_save_current_context (saved_context); \
if (octave_set_current_context) \
{ \
octave_interrupt_immediately = saved_octave_interrupt_immediately; \
octave_restore_current_context (saved_context); \
if (f77_exception_encountered) \
F77_XFCN_ERROR (f, F); \
else \
octave_rethrow_exception (); \
} \
else \
{ \
octave_interrupt_immediately++; \
F77_FUNC (f, F) args; \
octave_interrupt_immediately--; \
octave_restore_current_context (saved_context); \
} \
} \
while (0)
/* So we can check to see if an exception has occurred. */
CRUFT_API extern int f77_exception_encountered;
#if !defined (F77_FCN)
#define F77_FCN(f, F) F77_FUNC (f, F)
#endif
/*
The following macros are used for handling Fortran <-> C calling
conventions. They are defined below for three different types of
systems, Cray (possibly now obsolete), Visual Fortran, and any system
that is compatible with the f2c calling conventions, including g77 and
gfortran. Note that gfortran is not completely compatible with the
f2c calling conventions, but that we only use the parts that are
compatible. For example, f2c and gfortran differ in the way they
handle Fortran functions that return complex values, but Octave does
not call any Fortran functions like that directly from C or C++.
Use these macros to pass character strings from C to Fortran:
F77_CHAR_ARG(x)
F77_CONST_CHAR_ARG(x)
F77_CXX_STRING_ARG(x)
F77_CHAR_ARG_LEN(l)
F77_CHAR_ARG_DECL
F77_CONST_CHAR_ARG_DECL
F77_CHAR_ARG_LEN_DECL
Use these macros to write C-language functions that accept
Fortran-style character strings:
F77_CHAR_ARG_DEF(s, len)
F77_CONST_CHAR_ARG_DEF(s, len)
F77_CHAR_ARG_LEN_DEF(len)
F77_CHAR_ARG_USE(s)
F77_CHAR_ARG_LEN_USE(s, len)
Use this macro to declare the return type of a C-language function
that is supposed to act like a Fortran subroutine:
F77_RET_T int
Use these macros to return from C-language functions that are supposed
to act like Fortran subroutines. F77_NORETURN is intended to be used
as the last statement of such a function that has been tagged with a
"noreturn" attribute. If the compiler supports the "noreturn"
attribute or if F77_RET_T is void, then it should expand to nothing so
that we avoid warnings about functions tagged as "noreturn"
containing a return statement. Otherwise, it should expand to a
statement that returns the given value so that we avoid warnings about
not returning a value from a function declared to return something.
F77_RETURN(retval)
F77_NORETURN(retval)
*/
#if defined (F77_USES_CRAY_CALLING_CONVENTION)
#include <fortran.h>
/* Use these macros to pass character strings from C to Fortran. */
#define F77_CHAR_ARG(x) octave_make_cray_ftn_ch_dsc (x, strlen (x))
#define F77_CONST_CHAR_ARG(x) \
octave_make_cray_const_ftn_ch_dsc (x, strlen (x))
#define F77_CHAR_ARG2(x, l) octave_make_cray_ftn_ch_dsc (x, l)
#define F77_CONST_CHAR_ARG2(x, l) octave_make_cray_const_ftn_ch_dsc (x, l)
#define F77_CXX_STRING_ARG(x) \
octave_make_cray_const_ftn_ch_dsc (x.c_str (), x.length ())
#define F77_CHAR_ARG_LEN(l)
#define F77_CHAR_ARG_DECL octave_cray_ftn_ch_dsc
#define F77_CONST_CHAR_ARG_DECL octave_cray_ftn_ch_dsc
#define F77_CHAR_ARG_LEN_DECL
/* Use these macros to write C-language functions that accept
Fortran-style character strings. */
#define F77_CHAR_ARG_DEF(s, len) octave_cray_ftn_ch_dsc s
#define F77_CONST_CHAR_ARG_DEF(s, len) octave_cray_ftn_ch_dsc s
#define F77_CHAR_ARG_LEN_DEF(len)
#define F77_CHAR_ARG_USE(s) s.ptr
#define F77_CHAR_ARG_LEN_USE(s, len) (s.mask.len>>3)
/* Use this macro to declare the return type of a C-language function
that is supposed to act like a Fortran subroutine. */
#define F77_RET_T int
/* Use these macros to return from C-language functions that are
supposed to act like Fortran subroutines. F77_NORETURN is intended
to be used as the last statement of such a function that has been
tagged with a "noreturn" attribute. */
#define F77_RETURN(retval) return retval;
#if defined (HAVE_ATTR_NORETURN)
#define F77_NORETURN(retval)
#else
#define F77_NORETURN(retval) return retval;
#endif
/* FIXME -- these should work for SV1 or Y-MP systems but will
need to be changed for others. */
typedef union
{
const char *const_ptr;
char *ptr;
struct
{
unsigned off : 6;
unsigned len : 26;
unsigned add : 32;
} mask;
} octave_cray_descriptor;
typedef void *octave_cray_ftn_ch_dsc;
#ifdef __cplusplus
#define OCTAVE_F77_FCN_INLINE inline
#else
#define OCTAVE_F77_FCN_INLINE
#endif
static OCTAVE_F77_FCN_INLINE octave_cray_ftn_ch_dsc
octave_make_cray_ftn_ch_dsc (char *ptr_arg, unsigned long len_arg)
{
octave_cray_descriptor desc;
desc.ptr = ptr_arg;
desc.mask.len = len_arg << 3;
return *((octave_cray_ftn_ch_dsc *) &desc);
}
static OCTAVE_F77_FCN_INLINE octave_cray_ftn_ch_dsc
octave_make_cray_const_ftn_ch_dsc (const char *ptr_arg, unsigned long len_arg)
{
octave_cray_descriptor desc;
desc.const_ptr = ptr_arg;
desc.mask.len = len_arg << 3;
return *((octave_cray_ftn_ch_dsc *) &desc);
}
#ifdef __cplusplus
#undef OCTAVE_F77_FCN_INLINE
#endif
#elif defined (F77_USES_VISUAL_FORTRAN_CALLING_CONVENTION)
/* Use these macros to pass character strings from C to Fortran. */
#define F77_CHAR_ARG(x) x, strlen (x)
#define F77_CONST_CHAR_ARG(x) F77_CHAR_ARG (x)
#define F77_CHAR_ARG2(x, l) x, l
#define F77_CONST_CHAR_ARG2(x, l) F77_CHAR_ARG2 (x, l)
#define F77_CXX_STRING_ARG(x) F77_CONST_CHAR_ARG2 (x.c_str (), x.length ())
#define F77_CHAR_ARG_LEN(l)
#define F77_CHAR_ARG_DECL char *, int
#define F77_CONST_CHAR_ARG_DECL const char *, int
#define F77_CHAR_ARG_LEN_DECL
#define F77_CHAR_ARG_DEF(s, len) char *s, int len
#define F77_CONST_CHAR_ARG_DEF(s, len) const char *s, int len
#define F77_CHAR_ARG_LEN_DEF(len)
#define F77_CHAR_ARG_USE(s) s
#define F77_CHAR_ARG_LEN_USE(s, len) len
#define F77_RET_T void
#define F77_RETURN(retval) return;
#define F77_NORETURN(retval)
#else
/* Assume f2c-compatible calling convention. */
#define F77_CHAR_ARG(x) x
#define F77_CONST_CHAR_ARG(x) F77_CHAR_ARG (x)
#define F77_CHAR_ARG2(x, l) x
#define F77_CONST_CHAR_ARG2(x, l) F77_CHAR_ARG2 (x, l)
#define F77_CXX_STRING_ARG(x) F77_CONST_CHAR_ARG2 (x.c_str (), x.length ())
#define F77_CHAR_ARG_LEN(l) , l
#define F77_CHAR_ARG_DECL char *
#define F77_CONST_CHAR_ARG_DECL const char *
#define F77_CHAR_ARG_LEN_DECL , long
#define F77_CHAR_ARG_DEF(s, len) char *s
#define F77_CONST_CHAR_ARG_DEF(s, len) const char *s
#define F77_CHAR_ARG_LEN_DEF(len) , long len
#define F77_CHAR_ARG_USE(s) s
#define F77_CHAR_ARG_LEN_USE(s, len) len
#define F77_RET_T int
#define F77_RETURN(retval) return retval;
#if defined (HAVE_ATTR_NORETURN)
#define F77_NORETURN(retval)
#else
#define F77_NORETURN(retval) return retval;
#endif
#endif
/* Build a C string local variable CS from the Fortran string parameter S
declared as F77_CHAR_ARG_DEF(s, len) or F77_CONST_CHAR_ARG_DEF(s, len).
The string will be cleaned up at the end of the current block.
Needs to include <cstring> and <vector>. */
#define F77_CSTRING(s, len, cs) \
OCTAVE_LOCAL_BUFFER (char, cs, F77_CHAR_ARG_LEN_USE (s, len) + 1); \
memcpy (cs, F77_CHAR_ARG_USE (s), F77_CHAR_ARG_LEN_USE (s, len)); \
cs[F77_CHAR_ARG_LEN_USE(s, len)] = '\0'
extern CRUFT_API F77_RET_T
F77_FUNC (xstopx, XSTOPX) (F77_CONST_CHAR_ARG_DECL
F77_CHAR_ARG_LEN_DECL) GCC_ATTR_NORETURN;
#ifdef __cplusplus
}
#endif
#endif
|