octave: liboctave/cruft/misc/f77-fcn.h annotate

annotate liboctave/cruft/misc/f77-fcn.h @ 21227:25150962bfd3

eliminate CRUFT_API macro * oct-conf-post.in.h (CRUFT_API): Delete definition. * f77-fcn.h, lo-error.h, quit.h: Use OCTAVE_API instead of CRUFT_API.

author	John W. Eaton <jwe@octave.org>
date	Mon, 08 Feb 2016 20:40:55 -0500
parents	f7121e111991
children	a83e7a384ee0

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
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	3 Copyright (C) 1996-2015 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
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	8 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6253 diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6253 diff changeset	10 option) any later version.
2544 a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	11
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	15 for more details.
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
4268 363d406ec86c [project @ 2003-01-03 15:55:01 by jwe] jwe parents: 4182 diff changeset	26 #include "quit.h"
363d406ec86c [project @ 2003-01-03 15:55:01 by jwe] jwe parents: 4182 diff changeset	27
2544 a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	28 #ifdef __cplusplus
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	29 extern "C" {
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	30 #endif
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	31
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 3950 diff changeset	32 /* Hack to stringize macro results. */
3887 7da18459c08b [project @ 2002-04-04 00:44:21 by jwe] jwe parents: 2847 diff changeset	33 #define xSTRINGIZE(x) #x
7da18459c08b [project @ 2002-04-04 00:44:21 by jwe] jwe parents: 2847 diff changeset	34 #define STRINGIZE(x) xSTRINGIZE(x)
2544 a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	35
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	36 /* How to print an error for the F77_XFCN macro. */
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	37
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	38 #define F77_XFCN_ERROR(f, F) \
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	39 (*current_liboctave_error_handler) \
3887 7da18459c08b [project @ 2002-04-04 00:44:21 by jwe] jwe parents: 2847 diff changeset	40 ("exception encountered in Fortran subroutine %s", \
7da18459c08b [project @ 2002-04-04 00:44:21 by jwe] jwe parents: 2847 diff changeset	41 STRINGIZE (F77_FUNC (f, F)))
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 /* 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	44 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	45 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	46 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	47 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	48 to the top level. */
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 #define F77_XFCN(f, F, args) \
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	51 do \
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	52 { \
4182 4d1d7c51205c [project @ 2002-11-15 20:33:47 by jwe] jwe parents: 4180 diff changeset	53 octave_jmp_buf saved_context; \
5767 26f92fb8ba33 [project @ 2006-04-18 15:28:34 by jwe] jwe parents: 5760 diff changeset	54 sig_atomic_t saved_octave_interrupt_immediately = octave_interrupt_immediately; \
2544 a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	55 f77_exception_encountered = 0; \
5760 8d7162924bd3 [project @ 2006-04-14 04:01:37 by jwe] jwe parents: 5701 diff changeset	56 octave_save_current_context (saved_context); \
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 3950 diff changeset	57 if (octave_set_current_context) \
9930 1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	58 { \
1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	59 octave_interrupt_immediately = saved_octave_interrupt_immediately; \
5760 8d7162924bd3 [project @ 2006-04-14 04:01:37 by jwe] jwe parents: 5701 diff changeset	60 octave_restore_current_context (saved_context); \
9930 1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	61 if (f77_exception_encountered) \
1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	62 F77_XFCN_ERROR (f, F); \
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 3950 diff changeset	63 else \
9930 1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	64 octave_rethrow_exception (); \
1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	65 } \
2544 a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	66 else \
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 3950 diff changeset	67 { \
9930 1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	68 octave_interrupt_immediately++; \
1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	69 F77_FUNC (f, F) args; \
1ddc25c3623a libcruft/misc: untabify sources John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	70 octave_interrupt_immediately--; \
5760 8d7162924bd3 [project @ 2006-04-14 04:01:37 by jwe] jwe parents: 5701 diff changeset	71 octave_restore_current_context (saved_context); \
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 3950 diff changeset	72 } \
2544 a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	73 } \
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	74 while (0)
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	75
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	76 /* 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	77 OCTAVE_API extern int f77_exception_encountered;
2544 a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	78
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20545 diff changeset	79 #if ! defined (F77_FCN)
3938 028eb74026bc [project @ 2002-05-16 16:15:42 by jwe] jwe parents: 3887 diff changeset	80 #define F77_FCN(f, F) F77_FUNC (f, F)
028eb74026bc [project @ 2002-05-16 16:15:42 by jwe] jwe parents: 3887 diff changeset	81 #endif
028eb74026bc [project @ 2002-05-16 16:15:42 by jwe] jwe parents: 3887 diff changeset	82
15128 4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	83 /*
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	84
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	85 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	86 conventions. They are defined below for three different types of
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	87 systems, Cray (possibly now obsolete), Visual Fortran, and any system
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	88 that is compatible with the f2c calling conventions, including g77 and
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	89 gfortran. Note that gfortran is not completely compatible with the
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	90 f2c calling conventions, but that we only use the parts that are
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	91 compatible. For example, f2c and gfortran differ in the way they
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	92 handle Fortran functions that return complex values, but Octave does
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	93 not call any Fortran functions like that directly from C or C++.
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	94
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	95 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	96
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	97 F77_CHAR_ARG(x)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	98 F77_CONST_CHAR_ARG(x)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	99 F77_CXX_STRING_ARG(x)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	100 F77_CHAR_ARG_LEN(l)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	101 F77_CHAR_ARG_DECL
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	102 F77_CONST_CHAR_ARG_DECL
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	103 F77_CHAR_ARG_LEN_DECL
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	104
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	105 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	106 Fortran-style character strings:
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	107
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	108 F77_CHAR_ARG_DEF(s, len)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	109 F77_CONST_CHAR_ARG_DEF(s, len)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	110 F77_CHAR_ARG_LEN_DEF(len)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	111 F77_CHAR_ARG_USE(s)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	112 F77_CHAR_ARG_LEN_USE(s, len)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	113
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	114 Use this macro to declare the return type of a C-language function
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	115 that is supposed to act like a Fortran subroutine:
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	116
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	117 F77_RET_T int
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	118
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	119 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	120 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	121 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	122 "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	123 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	124 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	125 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	126 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	127 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	128
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	129 F77_RETURN(retval)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	130 F77_NORETURN(retval)
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	131
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	132 */
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	133
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	134 #if defined (F77_USES_CRAY_CALLING_CONVENTION)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	135
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	136 #include <fortran.h>
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	137
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	138 /* Use these macros to pass character strings from C to Fortran. */
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	139 #define F77_CHAR_ARG(x) octave_make_cray_ftn_ch_dsc (x, strlen (x))
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	140 #define F77_CONST_CHAR_ARG(x) \
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	141 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	142 #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	143 #define F77_CONST_CHAR_ARG2(x, l) octave_make_cray_const_ftn_ch_dsc (x, l)
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	144 #define F77_CXX_STRING_ARG(x) \
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	145 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	146 #define F77_CHAR_ARG_LEN(l)
4577 233512ebf15d [project @ 2003-10-31 06:31:14 by jwe] jwe parents: 4572 diff changeset	147 #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	148 #define F77_CONST_CHAR_ARG_DECL octave_cray_ftn_ch_dsc
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	149 #define F77_CHAR_ARG_LEN_DECL
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	150
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	151 /* 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	152 Fortran-style character strings. */
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	153 #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	154 #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	155 #define F77_CHAR_ARG_LEN_DEF(len)
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	156 #define F77_CHAR_ARG_USE(s) s.ptr
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	157 #define F77_CHAR_ARG_LEN_USE(s, len) (s.mask.len>>3)
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	158
15128 4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	159 /* Use this macro to declare the return type of a C-language function
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	160 that is supposed to act like a Fortran subroutine. */
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	161 #define F77_RET_T int
15128 4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	162
4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	163 /* 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	164 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	165 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	166 tagged with a "noreturn" attribute. */
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	167 #define F77_RETURN(retval) return retval;
15127 87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning. John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	168 #if defined (HAVE_ATTR_NORETURN)
21202 f7121e111991 maint: indent #ifdef blocks in liboctave and src directories. Rik <rik@octave.org> parents: 21076 diff changeset	169 # 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	170 #else
21202 f7121e111991 maint: indent #ifdef blocks in liboctave and src directories. Rik <rik@octave.org> parents: 21076 diff changeset	171 # 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	172 #endif
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	173
21066 258c787cd9ce maint: Use "FIXME:" consistently in code base. Rik <rik@octave.org> parents: 21040 diff changeset	174 /* 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	175 need to be changed for others. */
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	176
4558 239df9c618ef [project @ 2003-10-28 18:48:07 by jwe] jwe parents: 4555 diff changeset	177 typedef union
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	178 {
4558 239df9c618ef [project @ 2003-10-28 18:48:07 by jwe] jwe parents: 4555 diff changeset	179 const char *const_ptr;
239df9c618ef [project @ 2003-10-28 18:48:07 by jwe] jwe parents: 4555 diff changeset	180 char *ptr;
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	181 struct
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	182 {
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	183 unsigned off : 6;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	184 unsigned len : 26;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	185 unsigned add : 32;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	186 } mask;
4558 239df9c618ef [project @ 2003-10-28 18:48:07 by jwe] jwe parents: 4555 diff changeset	187 } octave_cray_descriptor;
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	188
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	189 typedef void *octave_cray_ftn_ch_dsc;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	190
4555 fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe] jwe parents: 4552 diff changeset	191 #ifdef __cplusplus
21202 f7121e111991 maint: indent #ifdef blocks in liboctave and src directories. Rik <rik@octave.org> parents: 21076 diff changeset	192 # define OCTAVE_F77_FCN_INLINE inline
4558 239df9c618ef [project @ 2003-10-28 18:48:07 by jwe] jwe parents: 4555 diff changeset	193 #else
21202 f7121e111991 maint: indent #ifdef blocks in liboctave and src directories. Rik <rik@octave.org> parents: 21076 diff changeset	194 # define OCTAVE_F77_FCN_INLINE
4555 fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe] jwe parents: 4552 diff changeset	195 #endif
fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe] jwe parents: 4552 diff changeset	196
fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe] jwe parents: 4552 diff changeset	197 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	198 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	199 {
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	200 octave_cray_descriptor desc;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	201 desc.ptr = ptr_arg;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	202 desc.mask.len = len_arg << 3;
4558 239df9c618ef [project @ 2003-10-28 18:48:07 by jwe] jwe parents: 4555 diff changeset	203 return ((octave_cray_ftn_ch_dsc ) &desc);
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	204 }
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	205
4555 fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe] jwe parents: 4552 diff changeset	206 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	207 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	208 {
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	209 octave_cray_descriptor desc;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	210 desc.const_ptr = ptr_arg;
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	211 desc.mask.len = len_arg << 3;
4558 239df9c618ef [project @ 2003-10-28 18:48:07 by jwe] jwe parents: 4555 diff changeset	212 return ((octave_cray_ftn_ch_dsc ) &desc);
4552 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
4555 fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe] jwe parents: 4552 diff changeset	215 #ifdef __cplusplus
21202 f7121e111991 maint: indent #ifdef blocks in liboctave and src directories. Rik <rik@octave.org> parents: 21076 diff changeset	216 # undef OCTAVE_F77_FCN_INLINE
4555 fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe] jwe parents: 4552 diff changeset	217 #endif
fe70d8074644 [project @ 2003-10-27 22:17:36 by jwe] jwe parents: 4552 diff changeset	218
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	219 #elif defined (F77_USES_VISUAL_FORTRAN_CALLING_CONVENTION)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	220
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	221 /* Use these macros to pass character strings from C to Fortran. */
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	222 #define F77_CHAR_ARG(x) x, strlen (x)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	223 #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	224 #define F77_CHAR_ARG2(x, l) x, l
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	225 #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	226 #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	227 #define F77_CHAR_ARG_LEN(l)
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	228 #define F77_CHAR_ARG_DECL char *, int
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	229 #define F77_CONST_CHAR_ARG_DECL const char *, int
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	230 #define F77_CHAR_ARG_LEN_DECL
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	231
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	232 #define F77_CHAR_ARG_DEF(s, len) char *s, int len
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	233 #define F77_CONST_CHAR_ARG_DEF(s, len) const char *s, int len
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	234 #define F77_CHAR_ARG_LEN_DEF(len)
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	235 #define F77_CHAR_ARG_USE(s) s
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	236 #define F77_CHAR_ARG_LEN_USE(s, len) len
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	237
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	238 #define F77_RET_T void
15128 4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	239
15127 87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning. John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	240 #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	241 #define F77_NORETURN(retval)
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	242
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	243 #else
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	244
4572 4623ef02a605 [project @ 2003-10-31 03:07:05 by jwe] jwe parents: 4558 diff changeset	245 /* Assume f2c-compatible calling convention. */
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	246
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	247 #define F77_CHAR_ARG(x) x
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	248 #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	249 #define F77_CHAR_ARG2(x, l) x
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	250 #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	251 #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	252 #define F77_CHAR_ARG_LEN(l) , l
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	253 #define F77_CHAR_ARG_DECL char *
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	254 #define F77_CONST_CHAR_ARG_DECL const char *
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	255 #define F77_CHAR_ARG_LEN_DECL , long
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	256
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	257 #define F77_CHAR_ARG_DEF(s, len) char *s
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	258 #define F77_CONST_CHAR_ARG_DEF(s, len) const char *s
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	259 #define F77_CHAR_ARG_LEN_DEF(len) , long len
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	260 #define F77_CHAR_ARG_USE(s) s
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	261 #define F77_CHAR_ARG_LEN_USE(s, len) len
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	262
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	263 #define F77_RET_T int
15128 4d52239daef5 improve internal documentation of F77_ macros. John W. Eaton <jwe@octave.org> parents: 15127 diff changeset	264
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	265 #define F77_RETURN(retval) return retval;
15127 87411930d6c4 avoid "function declared 'noreturn' has a return statement" warning. John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	266 #if defined (HAVE_ATTR_NORETURN)
21202 f7121e111991 maint: indent #ifdef blocks in liboctave and src directories. Rik <rik@octave.org> parents: 21076 diff changeset	267 # 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	268 #else
21202 f7121e111991 maint: indent #ifdef blocks in liboctave and src directories. Rik <rik@octave.org> parents: 21076 diff changeset	269 # 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	270 #endif
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	271
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	272 #endif
6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	273
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	274
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	275 /* 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	276 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	277 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	278 Needs to include <cstring> and <vector>. */
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	279
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	280 #define F77_CSTRING(s, len, cs) \
6253 f1676652d808 [project @ 2007-01-24 20:43:36 by jwe] jwe parents: 6107 diff changeset	281 OCTAVE_LOCAL_BUFFER (char, cs, F77_CHAR_ARG_LEN_USE (s, len) + 1); \
6072 4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	282 memcpy (cs, F77_CHAR_ARG_USE (s), F77_CHAR_ARG_LEN_USE (s, len)); \
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	283 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	284
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe] jwe parents: 5775 diff changeset	285
21227 25150962bfd3 eliminate CRUFT_API macro John W. Eaton <jwe@octave.org> parents: 21202 diff changeset	286 OCTAVE_NORETURN OCTAVE_API extern
21076 b433f9990452 strip trailing whitespace from files John W. Eaton <jwe@octave.org> parents: 21066 diff changeset	287 F77_RET_T
4801 b022780ac0b4 [project @ 2004-02-25 04:40:54 by jwe] jwe parents: 4577 diff changeset	288 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	289 F77_CHAR_ARG_LEN_DECL);
4552 6f3382e08a52 [project @ 2003-10-27 20:38:02 by jwe] jwe parents: 4268 diff changeset	290
2544 a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	291 #ifdef __cplusplus
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	292 }
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	293 #endif
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	294
a33bbd3fadd7 [project @ 1996-11-20 05:09:29 by jwe] jwe parents: diff changeset	295 #endif

Mercurial > octave

annotate liboctave/cruft/misc/f77-fcn.h @ 21227:25150962bfd3