annotate liboctave/cruft/misc/f77-fcn.h @ 22843:a2809b2938d6

* f77-fcn.h (to_f77_int): New inline function.
author John W. Eaton <jwe@octave.org>
date Tue, 29 Nov 2016 01:00:15 -0500
parents 60405b73e439
children 5126040e8f49
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
1 /*
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
2
22323
bac0d6f07a3e maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents: 22197
diff changeset
3 Copyright (C) 1996-2016 John W. Eaton
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
4
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
6
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22410
diff changeset
8 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22410
diff changeset
9 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22410
diff changeset
10 (at your option) any later version.
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
11
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22410
diff changeset
12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22410
diff changeset
13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22410
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22410
diff changeset
15 GNU General Public License for more details.
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
16
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6253
diff changeset
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6253
diff changeset
19 <http://www.gnu.org/licenses/>.
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
20
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
21 */
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
22
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 20545
diff changeset
23 #if ! defined (octave_f77_fcn_h)
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
24 #define octave_f77_fcn_h 1
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
25
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21229
diff changeset
26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21229
diff changeset
27
22843
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
28 #include "lo-error.h"
4268
363d406ec86c [project @ 2003-01-03 15:55:01 by jwe]
jwe
parents: 4182
diff changeset
29 #include "quit.h"
363d406ec86c [project @ 2003-01-03 15:55:01 by jwe]
jwe
parents: 4182
diff changeset
30
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21662
diff changeset
31 #if defined (__cplusplus)
22843
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
32 # include <limits>
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
33 #endif
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
34
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
35 #if defined (__cplusplus)
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
36 extern "C" {
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
37 #endif
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
38
4153
6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe]
jwe
parents: 3950
diff changeset
39 /* Hack to stringize macro results. */
3887
7da18459c08b [project @ 2002-04-04 00:44:21 by jwe]
jwe
parents: 2847
diff changeset
40 #define xSTRINGIZE(x) #x
7da18459c08b [project @ 2002-04-04 00:44:21 by jwe]
jwe
parents: 2847
diff changeset
41 #define STRINGIZE(x) xSTRINGIZE(x)
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
42
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
43 /* How to print an error for the F77_XFCN macro. */
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
44
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
45 #define F77_XFCN_ERROR(f, F) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
46 (*current_liboctave_error_handler) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
47 ("exception encountered in Fortran subroutine %s", \
3887
7da18459c08b [project @ 2002-04-04 00:44:21 by jwe]
jwe
parents: 2847
diff changeset
48 STRINGIZE (F77_FUNC (f, F)))
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
49
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
50 /* This can be used to call a Fortran subroutine that might call
4153
6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe]
jwe
parents: 3950
diff changeset
51 XSTOPX. XSTOPX will call lonjmp with current_context. Once back
6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe]
jwe
parents: 3950
diff changeset
52 here, we'll restore the previous context and return. We may also
6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe]
jwe
parents: 3950
diff changeset
53 end up here if an interrupt is processed when the Fortran
6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe]
jwe
parents: 3950
diff changeset
54 subroutine is called. In that case, we resotre the context and go
20545
c547458dc10e eliminate error_state from most header files
John W. Eaton <jwe@octave.org>
parents: 19697
diff changeset
55 to the top level. */
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
56
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
57 #define F77_XFCN(f, F, args) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
58 do \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
59 { \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
60 octave_jmp_buf saved_context; \
5767
26f92fb8ba33 [project @ 2006-04-18 15:28:34 by jwe]
jwe
parents: 5760
diff changeset
61 sig_atomic_t saved_octave_interrupt_immediately = octave_interrupt_immediately; \
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
62 f77_exception_encountered = 0; \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
63 octave_save_current_context (saved_context); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
64 if (octave_set_current_context) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
65 { \
9930
1ddc25c3623a libcruft/misc: untabify sources
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
66 octave_interrupt_immediately = saved_octave_interrupt_immediately; \
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
67 octave_restore_current_context (saved_context); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
68 if (f77_exception_encountered) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
69 F77_XFCN_ERROR (f, F); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
70 else \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
71 octave_rethrow_exception (); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
72 } \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
73 else \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
74 { \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
75 octave_interrupt_immediately++; \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
76 F77_FUNC (f, F) args; \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
77 octave_interrupt_immediately--; \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
78 octave_restore_current_context (saved_context); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
79 } \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
80 } \
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
81 while (0)
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
82
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
83 /* So we can check to see if an exception has occurred. */
21227
25150962bfd3 eliminate CRUFT_API macro
John W. Eaton <jwe@octave.org>
parents: 21202
diff changeset
84 OCTAVE_API extern int f77_exception_encountered;
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
85
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 20545
diff changeset
86 #if ! defined (F77_FCN)
3938
028eb74026bc [project @ 2002-05-16 16:15:42 by jwe]
jwe
parents: 3887
diff changeset
87 #define F77_FCN(f, F) F77_FUNC (f, F)
028eb74026bc [project @ 2002-05-16 16:15:42 by jwe]
jwe
parents: 3887
diff changeset
88 #endif
028eb74026bc [project @ 2002-05-16 16:15:42 by jwe]
jwe
parents: 3887
diff changeset
89
15128
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
90 /*
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
91
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
92 The following macros are used for handling Fortran <-> C calling
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
93 conventions. They are defined below for three different types of
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
94 systems, Cray (possibly now obsolete), Visual Fortran, and gfortran.
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
95 Note that we don't attempt to handle Fortran functions, we always use
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
96 subroutine wrappers for them and pass the return value as an extra
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
97 argument.
15128
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
98
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
99 Use these macros to pass character strings from C to Fortran:
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
100
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
101 F77_CHAR_ARG(x)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
102 F77_CONST_CHAR_ARG(x)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
103 F77_CXX_STRING_ARG(x)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
104 F77_CHAR_ARG_LEN(l)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
105 F77_CHAR_ARG_DECL
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
106 F77_CONST_CHAR_ARG_DECL
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
107 F77_CHAR_ARG_LEN_DECL
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
108
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
109 Use these macros to write C-language functions that accept
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
110 Fortran-style character strings:
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
111
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
112 F77_CHAR_ARG_DEF(s, len)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
113 F77_CONST_CHAR_ARG_DEF(s, len)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
114 F77_CHAR_ARG_LEN_DEF(len)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
115 F77_CHAR_ARG_USE(s)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
116 F77_CHAR_ARG_LEN_USE(s, len)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
117
22133
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
118 Use these macros for C++ code
15128
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
119
22133
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
120 F77_INT Equivalent to Fortran INTEGER type
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
121 F77_INT4 Equivalent to Fortran INTEGER*4 type
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
122 F77_DBLE Equivalent to Fortran DOUBLE PRECISION type
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
123 F77_REAL Equivalent to Fortran REAL type
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
124 F77_CMPLX Equivalent to Fortran COMPLEX type
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
125 F77_DBLE_CMPLX Equivalent to Fortran DOUBLE COMPLEX type
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
126 F77_LOGICAL Equivalent to Fortran LOGICAL type
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
127 F77_RET_T Return type of a C++ function that acts like a
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
128 Fortran subroutine.
15128
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
129
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
130 Use these macros to return from C-language functions that are supposed
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
131 to act like Fortran subroutines. F77_NORETURN is intended to be used
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
132 as the last statement of such a function that has been tagged with a
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
133 "noreturn" attribute. If the compiler supports the "noreturn"
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
134 attribute or if F77_RET_T is void, then it should expand to nothing so
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
135 that we avoid warnings about functions tagged as "noreturn"
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
136 containing a return statement. Otherwise, it should expand to a
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
137 statement that returns the given value so that we avoid warnings about
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
138 not returning a value from a function declared to return something.
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
139
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
140 F77_RETURN(retval)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
141 F77_NORETURN(retval)
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
142
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
143 */
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
144
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
145 #if defined (F77_USES_CRAY_CALLING_CONVENTION)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
146
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
147 #include <fortran.h>
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
148
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
149 /* Use these macros to pass character strings from C to Fortran. Cray
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
150 Fortran uses a descriptor structure to pass a pointer to the string
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
151 and the length in a single argument. */
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
152
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
153 #define F77_CHAR_ARG(x) octave_make_cray_ftn_ch_dsc (x, strlen (x))
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
154 #define F77_CONST_CHAR_ARG(x) \
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
155 octave_make_cray_const_ftn_ch_dsc (x, strlen (x))
4577
233512ebf15d [project @ 2003-10-31 06:31:14 by jwe]
jwe
parents: 4572
diff changeset
156 #define F77_CHAR_ARG2(x, l) octave_make_cray_ftn_ch_dsc (x, l)
233512ebf15d [project @ 2003-10-31 06:31:14 by jwe]
jwe
parents: 4572
diff changeset
157 #define F77_CONST_CHAR_ARG2(x, l) octave_make_cray_const_ftn_ch_dsc (x, l)
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
158 #define F77_CXX_STRING_ARG(x) \
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
159 octave_make_cray_const_ftn_ch_dsc (x.c_str (), x.length ())
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
160 #define F77_CHAR_ARG_LEN(l)
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
161 #define F77_CHAR_ARG_LEN_TYPE
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
162 #define F77_CHAR_ARG_LEN_DECL
4577
233512ebf15d [project @ 2003-10-31 06:31:14 by jwe]
jwe
parents: 4572
diff changeset
163 #define F77_CHAR_ARG_DECL octave_cray_ftn_ch_dsc
233512ebf15d [project @ 2003-10-31 06:31:14 by jwe]
jwe
parents: 4572
diff changeset
164 #define F77_CONST_CHAR_ARG_DECL octave_cray_ftn_ch_dsc
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
165
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
166 /* Use these macros to write C-language functions that accept
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
167 Fortran-style character strings. */
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
168 #define F77_CHAR_ARG_DEF(s, len) octave_cray_ftn_ch_dsc s
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
169 #define F77_CONST_CHAR_ARG_DEF(s, len) octave_cray_ftn_ch_dsc s
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
170 #define F77_CHAR_ARG_LEN_DEF(len)
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
171 #define F77_CHAR_ARG_USE(s) s.ptr
21662
5b9868c2e212 maint: Octave coding convention cleanups.
Rik <rik@octave.org>
parents: 21244
diff changeset
172 #define F77_CHAR_ARG_LEN_USE(s, len) (s.mask.len >> 3)
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
173
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
174 #define F77_RET_T int
15128
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
175
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
176 /* Use these macros to return from C-language functions that are
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
177 supposed to act like Fortran subroutines. F77_NORETURN is intended
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
178 to be used as the last statement of such a function that has been
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
179 tagged with a "noreturn" attribute. */
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
180
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
181 #define F77_RETURN(retval) return retval;
21229
a83e7a384ee0 create and install a subset of config.h in octave-config.h
John W. Eaton <jwe@octave.org>
parents: 21227
diff changeset
182 #if defined (HAVE_OCTAVE_NORETURN_ATTR)
21202
f7121e111991 maint: indent #ifdef blocks in liboctave and src directories.
Rik <rik@octave.org>
parents: 21076
diff changeset
183 # define F77_NORETURN(retval)
15127
87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning.
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
184 #else
21202
f7121e111991 maint: indent #ifdef blocks in liboctave and src directories.
Rik <rik@octave.org>
parents: 21076
diff changeset
185 # define F77_NORETURN(retval) return retval;
15127
87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning.
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
186 #endif
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
187
21066
258c787cd9ce maint: Use "FIXME:" consistently in code base.
Rik <rik@octave.org>
parents: 21040
diff changeset
188 /* FIXME: These should work for SV1 or Y-MP systems but will
258c787cd9ce maint: Use "FIXME:" consistently in code base.
Rik <rik@octave.org>
parents: 21040
diff changeset
189 need to be changed for others. */
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
190
4558
239df9c618ef [project @ 2003-10-28 18:48:07 by jwe]
jwe
parents: 4555
diff changeset
191 typedef union
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
192 {
4558
239df9c618ef [project @ 2003-10-28 18:48:07 by jwe]
jwe
parents: 4555
diff changeset
193 const char *const_ptr;
239df9c618ef [project @ 2003-10-28 18:48:07 by jwe]
jwe
parents: 4555
diff changeset
194 char *ptr;
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
195 struct
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
196 {
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
197 unsigned off : 6;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
198 unsigned len : 26;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
199 unsigned add : 32;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
200 } mask;
4558
239df9c618ef [project @ 2003-10-28 18:48:07 by jwe]
jwe
parents: 4555
diff changeset
201 } octave_cray_descriptor;
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
202
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
203 typedef void *octave_cray_ftn_ch_dsc;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
204
22133
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
205 #if defined (__cplusplus)
21202
f7121e111991 maint: indent #ifdef blocks in liboctave and src directories.
Rik <rik@octave.org>
parents: 21076
diff changeset
206 # define OCTAVE_F77_FCN_INLINE inline
4558
239df9c618ef [project @ 2003-10-28 18:48:07 by jwe]
jwe
parents: 4555
diff changeset
207 #else
21202
f7121e111991 maint: indent #ifdef blocks in liboctave and src directories.
Rik <rik@octave.org>
parents: 21076
diff changeset
208 # define OCTAVE_F77_FCN_INLINE
4555
fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe]
jwe
parents: 4552
diff changeset
209 #endif
fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe]
jwe
parents: 4552
diff changeset
210
fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe]
jwe
parents: 4552
diff changeset
211 static OCTAVE_F77_FCN_INLINE octave_cray_ftn_ch_dsc
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
212 octave_make_cray_ftn_ch_dsc (char *ptr_arg, unsigned long len_arg)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
213 {
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
214 octave_cray_descriptor desc;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
215 desc.ptr = ptr_arg;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
216 desc.mask.len = len_arg << 3;
4558
239df9c618ef [project @ 2003-10-28 18:48:07 by jwe]
jwe
parents: 4555
diff changeset
217 return *((octave_cray_ftn_ch_dsc *) &desc);
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
218 }
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
219
4555
fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe]
jwe
parents: 4552
diff changeset
220 static OCTAVE_F77_FCN_INLINE octave_cray_ftn_ch_dsc
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
221 octave_make_cray_const_ftn_ch_dsc (const char *ptr_arg, unsigned long len_arg)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
222 {
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
223 octave_cray_descriptor desc;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
224 desc.const_ptr = ptr_arg;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
225 desc.mask.len = len_arg << 3;
4558
239df9c618ef [project @ 2003-10-28 18:48:07 by jwe]
jwe
parents: 4555
diff changeset
226 return *((octave_cray_ftn_ch_dsc *) &desc);
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
227 }
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
228
22133
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
229 #undef OCTAVE_F77_FCN_INLINE
22157
c5842206aaea maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 22135
diff changeset
230
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
231 #elif defined (F77_USES_VISUAL_FORTRAN_CALLING_CONVENTION)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
232
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
233 /* Use these macros to pass character strings from C to Fortran.
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
234 Visual Fortran inserts the length after each character string
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
235 argument. */
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
236
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
237 #define F77_CHAR_ARG(x) x, strlen (x)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
238 #define F77_CONST_CHAR_ARG(x) F77_CHAR_ARG (x)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
239 #define F77_CHAR_ARG2(x, l) x, l
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
240 #define F77_CONST_CHAR_ARG2(x, l) F77_CHAR_ARG2 (x, l)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
241 #define F77_CXX_STRING_ARG(x) F77_CONST_CHAR_ARG2 (x.c_str (), x.length ())
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
242 #define F77_CHAR_ARG_LEN(l)
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
243 #define F77_CHAR_ARG_LEN_TYPE int
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
244 #define F77_CHAR_ARG_LEN_DECL
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
245 #define F77_CHAR_ARG_DECL char *, F77_CHAR_ARG_LEN_TYPE
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
246 #define F77_CONST_CHAR_ARG_DECL const char *, F77_CHAR_ARG_LEN_TYPE
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
247
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
248 #define F77_CHAR_ARG_DEF(s, len) char *s, F77_CHAR_ARG_LEN_TYPE len
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
249 #define F77_CONST_CHAR_ARG_DEF(s, len) const char *s, F77_CHAR_ARG_LEN_TYPE len
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
250 #define F77_CHAR_ARG_LEN_DEF(len)
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
251 #define F77_CHAR_ARG_USE(s) s
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
252 #define F77_CHAR_ARG_LEN_USE(s, len) len
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
253
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
254 #define F77_RET_T void
15128
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
255
15127
87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning.
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
256 #define F77_RETURN(retval) return;
87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning.
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
257 #define F77_NORETURN(retval)
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
258
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
259 #elif defined (F77_USES_GFORTRAN_CALLING_CONVENTION)
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
260
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
261 /* Use these macros to pass character strings from C to Fortran.
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
262 gfortran appends length arguments for assumed size character
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
263 strings to the and ignores others.
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
264
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
265 FIXME: I don't think we correctly handle the case of mixing some
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
266 fixed-length and some assumed-length character string arguments as
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
267 we don't handle each case separately, so it seems there could be
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
268 mismatch? However, I don't think we currently have to handle this
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
269 case in Octave. */
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
270
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
271 #define F77_CHAR_ARG(x) x
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
272 #define F77_CONST_CHAR_ARG(x) F77_CHAR_ARG (x)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
273 #define F77_CHAR_ARG2(x, l) x
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
274 #define F77_CONST_CHAR_ARG2(x, l) F77_CHAR_ARG2 (x, l)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
275 #define F77_CXX_STRING_ARG(x) F77_CONST_CHAR_ARG2 (x.c_str (), x.length ())
5760
8d7162924bd3 [project @ 2006-04-14 04:01:37 by jwe]
jwe
parents: 5701
diff changeset
276 #define F77_CHAR_ARG_LEN(l) , l
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
277 #define F77_CHAR_ARG_LEN_TYPE int
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
278 #define F77_CHAR_ARG_LEN_DECL , F77_CHAR_ARG_LEN_TYPE
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
279 #define F77_CHAR_ARG_DECL char *
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
280 #define F77_CONST_CHAR_ARG_DECL const char *
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
281
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
282 #define F77_CHAR_ARG_DEF(s, len) char *s
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
283 #define F77_CONST_CHAR_ARG_DEF(s, len) const char *s
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
284 #define F77_CHAR_ARG_LEN_DEF(len) , F77_CHAR_ARG_LEN_TYPE len
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
285 #define F77_CHAR_ARG_USE(s) s
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
286 #define F77_CHAR_ARG_LEN_USE(s, len) len
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
287
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
288 #define F77_RET_T void
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
289
22410
bc38c1ff6698 fix definition of F77_RETURN for gfortran
John W. Eaton <jwe@octave.org>
parents: 22402
diff changeset
290 #define F77_RETURN(retval) return;
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
291 #if defined (HAVE_OCTAVE_NORETURN_ATTR)
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
292 # define F77_NORETURN(retval)
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
293 #else
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
294 # define F77_NORETURN(retval) return retval;
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
295 #endif
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
296
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
297 #elif defined (F77_USES_F2C_CALLING_CONVENTION)
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
298
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
299 /* Assume f2c-compatible calling convention. */
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
300
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
301 /* Use these macros to pass character strings from C to Fortran. f2c
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
302 appends all length arguments at the end of the parameter list. */
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
303
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
304 #define F77_CHAR_ARG(x) x
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
305 #define F77_CONST_CHAR_ARG(x) F77_CHAR_ARG (x)
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
306 #define F77_CHAR_ARG2(x, l) x
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
307 #define F77_CONST_CHAR_ARG2(x, l) F77_CHAR_ARG2 (x, l)
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
308 #define F77_CXX_STRING_ARG(x) F77_CONST_CHAR_ARG2 (x.c_str (), x.length ())
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
309 #define F77_CHAR_ARG_LEN(l) , l
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
310 #define F77_CHAR_ARG_LEN_TYPE long
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
311 #define F77_CHAR_ARG_LEN_DECL , F77_CHAR_ARG_LEN_TYPE
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
312 #define F77_CHAR_ARG_DECL char *
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
313 #define F77_CONST_CHAR_ARG_DECL const char *
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
314
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
315 #define F77_CHAR_ARG_DEF(s, len) char *s
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
316 #define F77_CONST_CHAR_ARG_DEF(s, len) const char *s
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
317 #define F77_CHAR_ARG_LEN_DEF(len) , F77_CHAR_ARG_LEN_TYPE len
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
318 #define F77_CHAR_ARG_USE(s) s
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
319 #define F77_CHAR_ARG_LEN_USE(s, len) len
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
320
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
321 #define F77_RET_T int
15128
4d52239daef5 improve internal documentation of F77_ macros.
John W. Eaton <jwe@octave.org>
parents: 15127
diff changeset
322
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
323 #define F77_RETURN(retval) return retval;
21229
a83e7a384ee0 create and install a subset of config.h in octave-config.h
John W. Eaton <jwe@octave.org>
parents: 21227
diff changeset
324 #if defined (HAVE_OCTAVE_NORETURN_ATTR)
21202
f7121e111991 maint: indent #ifdef blocks in liboctave and src directories.
Rik <rik@octave.org>
parents: 21076
diff changeset
325 # define F77_NORETURN(retval)
15127
87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning.
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
326 #else
21202
f7121e111991 maint: indent #ifdef blocks in liboctave and src directories.
Rik <rik@octave.org>
parents: 21076
diff changeset
327 # define F77_NORETURN(retval) return retval;
15127
87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning.
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
328 #endif
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
329
22134
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
330 #else
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
331
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
332 #error "unknown C++ to Fortran calling convention"
a51d5c5c71e6 handle gfortran and f2c calling conventions separately
John W. Eaton <jwe@octave.org>
parents: 22133
diff changeset
333
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
334 #endif
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
335
22841
5605a786086d use typedefs instead of macros for F77 types
John W. Eaton <jwe@octave.org>
parents: 22755
diff changeset
336 typedef double F77_DBLE;
5605a786086d use typedefs instead of macros for F77 types
John W. Eaton <jwe@octave.org>
parents: 22755
diff changeset
337 typedef float F77_REAL;
5605a786086d use typedefs instead of macros for F77 types
John W. Eaton <jwe@octave.org>
parents: 22755
diff changeset
338 typedef double _Complex F77_DBLE_CMPLX;
5605a786086d use typedefs instead of macros for F77 types
John W. Eaton <jwe@octave.org>
parents: 22755
diff changeset
339 typedef float _Complex F77_CMPLX;
22842
60405b73e439 provide separate typedefs for octave_idx_type and octave_f77_int_type
John W. Eaton <jwe@octave.org>
parents: 22841
diff changeset
340 typedef octave_f77_int_type F77_INT;
22841
5605a786086d use typedefs instead of macros for F77 types
John W. Eaton <jwe@octave.org>
parents: 22755
diff changeset
341 typedef int32_t F77_INT4;
22842
60405b73e439 provide separate typedefs for octave_idx_type and octave_f77_int_type
John W. Eaton <jwe@octave.org>
parents: 22841
diff changeset
342 typedef octave_f77_int_type F77_LOGICAL;
22133
59cadee1c74b new macros for F77 data types
John W. Eaton <jwe@octave.org>
parents: 22022
diff changeset
343
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
344 #define F77_CMPLX_ARG(x) \
22135
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531)
John W. Eaton <jwe@octave.org>
parents: 22134
diff changeset
345 reinterpret_cast<float _Complex *> (x)
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531)
John W. Eaton <jwe@octave.org>
parents: 22134
diff changeset
346
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
347 #define F77_CONST_CMPLX_ARG(x) \
22135
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531)
John W. Eaton <jwe@octave.org>
parents: 22134
diff changeset
348 reinterpret_cast<const float _Complex *> (x)
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531)
John W. Eaton <jwe@octave.org>
parents: 22134
diff changeset
349
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
350 #define F77_DBLE_CMPLX_ARG(x) \
22135
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531)
John W. Eaton <jwe@octave.org>
parents: 22134
diff changeset
351 reinterpret_cast<double _Complex *> (x)
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531)
John W. Eaton <jwe@octave.org>
parents: 22134
diff changeset
352
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
353 #define F77_CONST_DBLE_CMPLX_ARG(x) \
22135
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531)
John W. Eaton <jwe@octave.org>
parents: 22134
diff changeset
354 reinterpret_cast<const double _Complex *> (x)
407c66ae1e20 reduce warnings from GCC's link-time optimization feature (bug #48531)
John W. Eaton <jwe@octave.org>
parents: 22134
diff changeset
355
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
356 /* Build a C string local variable CS from the Fortran string parameter S
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
357 declared as F77_CHAR_ARG_DEF(s, len) or F77_CONST_CHAR_ARG_DEF(s, len).
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
358 The string will be cleaned up at the end of the current block.
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
359 Needs to include <cstring> and <vector>. */
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
360
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
361 #define F77_CSTRING(s, len, cs) \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
362 OCTAVE_LOCAL_BUFFER (char, cs, F77_CHAR_ARG_LEN_USE (s, len) + 1); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
363 memcpy (cs, F77_CHAR_ARG_USE (s), F77_CHAR_ARG_LEN_USE (s, len)); \
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22157
diff changeset
364 cs[F77_CHAR_ARG_LEN_USE(s, len)] = '\0'
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 5775
diff changeset
365
21227
25150962bfd3 eliminate CRUFT_API macro
John W. Eaton <jwe@octave.org>
parents: 21202
diff changeset
366 OCTAVE_NORETURN OCTAVE_API extern
21076
b433f9990452 strip trailing whitespace from files
John W. Eaton <jwe@octave.org>
parents: 21066
diff changeset
367 F77_RET_T
4801
b022780ac0b4 [project @ 2004-02-25 04:40:54 by jwe]
jwe
parents: 4577
diff changeset
368 F77_FUNC (xstopx, XSTOPX) (F77_CONST_CHAR_ARG_DECL
21029
e3b3bb522d62 maint: Move GCC_ attributes to start of declaration for future compatibility.
Rik <rik@octave.org>
parents: 20791
diff changeset
369 F77_CHAR_ARG_LEN_DECL);
4552
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe]
jwe
parents: 4268
diff changeset
370
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21662
diff changeset
371 #if defined (__cplusplus)
22843
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
372
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
373 inline F77_INT
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
374 to_f77_int (octave_idx_type x)
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
375 {
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
376 // FIXME: How to do this job in C, not knowing in advance the actual
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
377 // type of F77_INT?
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
378
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
379 if (x < std::numeric_limits<F77_INT>::min ()
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
380 || x > std::numeric_limits<F77_INT>::max ())
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
381 (*current_liboctave_error_handler)
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
382 ("integer dimension or index out of range for Fortran INTEGER type");
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
383
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
384 return static_cast<F77_INT> (x);
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
385 }
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
386
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
387 #endif
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
388
a2809b2938d6 * f77-fcn.h (to_f77_int): New inline function.
John W. Eaton <jwe@octave.org>
parents: 22842
diff changeset
389 #if defined (__cplusplus)
2544
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
390 }
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
391 #endif
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
392
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe]
jwe
parents:
diff changeset
393 #endif
22402
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
394