defun-dld.h File Reference

#include "octave-config.h"
#include "defun-int.h"

Include dependency graph for defun-dld.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	DEFMETHOD_DLD(name, interp_name, args_name, nargout_name, doc)
	Macro to define an at run time dynamically loadable builtin method. More...
#define	DEFMETHODX_DLD(name, fname, gname, interp_name, args_name, nargout_name, doc)
#define	DEFUN_DLD(name, args_name, nargout_name, doc)
	Macro to define an at run time dynamically loadable builtin function. More...
#define	DEFUNX_DLD(name, fname, gname, args_name, nargout_name, doc)

Macro Definition Documentation

DEFMETHOD_DLD

#define DEFMETHOD_DLD	(		name,
			interp_name,
			args_name,
			nargout_name,
			doc
	)

Value:

FORWARD_DECLARE_METHOD (name);                                        \
  DEFINE_FUN_INSTALLER_FUN (name, doc)                                  \
  DECLARE_METHOD (name, interp_name, args_name, nargout_name)

Macro to define an at run time dynamically loadable builtin method.

For detailed information, see Important Macros.

Parameters

name	The unqouted name of the method that should be installed on the octave::symbol_table and can be called by the interpreter. Internally, the method name is prepended by an F.
interp_name	The name of the octave::interpreter reference that can be used by this method. If this value is omitted, there is no access to the interpreter and one should use DEFUN to define a function instead.
args_name	The name of the octave_value_list variable used to pass the argument list to this method. If this value is omitted, the method cannot access the argument list.
nargout_name	The name of the int variable used to pass the number of output arguments this method is expected to produce from the caller. If this value is omitted, the method cannot access this number.
doc	Texinfo help text (docstring) for the method.

See also

DEFUN_DLD

Definition at line 96 of file defun-dld.h.

DEFMETHODX_DLD

#define DEFMETHODX_DLD	(		name,
			fname,
			gname,
			interp_name,
			args_name,
			nargout_name,
			doc
	)

Value:

FORWARD_DECLARE_METHODX (fname);                                      \
  DEFINE_FUNX_INSTALLER_FUN (name, fname, gname, doc)                   \
  DECLARE_METHODX (fname, interp_name, args_name, nargout_name)

Definition at line 101 of file defun-dld.h.

DEFUN_DLD

#define DEFUN_DLD	(		name,
			args_name,
			nargout_name,
			doc
	)

Value:

FORWARD_DECLARE_FUN (name);                           \
  DEFINE_FUN_INSTALLER_FUN (name, doc)                  \
  DECLARE_FUN (name, args_name, nargout_name)

Macro to define an at run time dynamically loadable builtin function.

For detailed information, see Important Macros.

Parameters

name	The unqouted name of the function that should be installed on the octave::symbol_table and can be called by the interpreter. Internally, the function name is prepended by an F.
args_name	The name of the octave_value_list variable used to pass the argument list to this function. If this value is omitted, the function cannot access the argument list.
nargout_name	The name of the int variable used to pass the number of output arguments this function is expected to produce from the caller. If this value is omitted, the function cannot access this number.
doc	Texinfo help text (docstring) for the function.

See also

DEFMETHOD_DLD

Definition at line 58 of file defun-dld.h.

DEFUNX_DLD

#define DEFUNX_DLD	(		name,
			fname,
			gname,
			args_name,
			nargout_name,
			doc
	)

Value:

FORWARD_DECLARE_FUNX (fname);                                         \
  DEFINE_FUNX_INSTALLER_FUN (name, fname, gname, doc)                   \
  DECLARE_FUNX (fname, args_name, nargout_name)

Definition at line 63 of file defun-dld.h.