1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2021 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING. If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
#if defined (HAVE_CONFIG_H)
# include "config.h"
#endif
#include <string>
#include "defun.h"
#include "dynamic-ld.h"
#include "error.h"
#include "help.h"
#include "ov.h"
#include "ov-builtin.h"
#include "ov-dld-fcn.h"
#include "ov-fcn.h"
#include "ov-mex-fcn.h"
#include "ov-usr-fcn.h"
#include "ovl.h"
#include "oct-lvalue.h"
#include "pager.h"
#include "interpreter-private.h"
#include "interpreter.h"
#include "symtab.h"
#include "variables.h"
#include "parse.h"
// Print the usage part of the doc string of FCN (user-defined or DEFUN).
void
print_usage (void)
{
octave::tree_evaluator& tw = octave::__get_evaluator__ ("print_usage");
const octave_function *cur = tw.current_function ();
if (cur)
print_usage (cur->name ());
else
error ("print_usage: invalid function");
}
void
print_usage (const std::string& name)
{
octave::feval ("print_usage", octave_value (name), 0);
}
void
check_version (const std::string& version, const std::string& fcn)
{
if (version != OCTAVE_API_VERSION)
{
error ("API version %s found in .oct file function '%s'\n"
" does not match the running Octave (API version %s)\n"
" this can lead to incorrect results or other failures\n"
" you can fix this problem by recompiling this .oct file",
version.c_str (), fcn.c_str (), OCTAVE_API_VERSION);
}
}
// Install variables and functions in the symbol tables.
void
install_dld_function (octave_dld_function::fcn f, const std::string& name,
const octave::dynamic_library& shl, const std::string& doc,
bool relative)
{
octave_dld_function *fcn = new octave_dld_function (f, shl, name, doc);
if (relative)
fcn->mark_relative ();
octave_value fval (fcn);
octave::symbol_table& symtab
= octave::__get_symbol_table__ ("install_dld_function");
symtab.install_built_in_function (name, fval);
}
void
install_dld_function (octave_dld_function::meth m, const std::string& name,
const octave::dynamic_library& shl, const std::string& doc,
bool relative)
{
octave_dld_function *fcn = new octave_dld_function (m, shl, name, doc);
if (relative)
fcn->mark_relative ();
octave_value fval (fcn);
octave::symbol_table& symtab
= octave::__get_symbol_table__ ("install_dld_function");
symtab.install_built_in_function (name, fval);
}
void
install_mex_function (void *fptr, bool fmex, const std::string& name,
const octave::dynamic_library& shl, bool relative)
{
octave_mex_function *fcn = new octave_mex_function (fptr, fmex, shl, name);
if (relative)
fcn->mark_relative ();
octave_value fval (fcn);
octave::symbol_table& symtab
= octave::__get_symbol_table__ ("install_mex_function");
symtab.install_built_in_function (name, fval);
}
octave::dynamic_library
get_current_shlib (void)
{
octave::dynamic_library retval;
octave::tree_evaluator& tw = octave::__get_evaluator__ ("get_current_shlib");
octave_function *curr_fcn = tw.current_function ();
if (curr_fcn)
{
if (curr_fcn->is_dld_function ())
{
octave_dld_function *dld
= dynamic_cast<octave_dld_function *> (curr_fcn);
retval = dld->get_shlib ();
}
else if (curr_fcn->is_mex_function ())
{
octave_mex_function *mex
= dynamic_cast<octave_mex_function *> (curr_fcn);
retval = mex->get_shlib ();
}
}
return retval;
}
|