/usr/include/octave-4.2.2/octave/ov-usr-fcn.h is in liboctave-dev 4.2.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 | /*
Copyright (C) 1996-2017 John W. Eaton
This file is part of Octave.
Octave is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.
Octave is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with Octave; see the file COPYING. If not, see
<http://www.gnu.org/licenses/>.
*/
#if ! defined (octave_ov_usr_fcn_h)
#define octave_ov_usr_fcn_h 1
#include "octave-config.h"
#include <ctime>
#include <string>
#include <stack>
#include "comment-list.h"
#include "ovl.h"
#include "ov-fcn.h"
#include "ov-typeinfo.h"
#include "symtab.h"
#include "unwind-prot.h"
class string_vector;
class octave_value;
class tree_parameter_list;
class tree_statement_list;
class tree_va_return_list;
class tree_expression;
class tree_walker;
#if defined (HAVE_LLVM)
class jit_function_info;
#endif
class
octave_user_code : public octave_function
{
public:
octave_user_code (void)
: octave_function () { }
~octave_user_code (void) { }
bool is_user_code (void) const { return true; }
virtual std::map<std::string, octave_value> subfunctions (void) const;
virtual tree_statement_list *body (void) = 0;
protected:
octave_user_code (const std::string& nm,
const std::string& ds = "")
: octave_function (nm, ds) { }
private:
// No copying!
octave_user_code (const octave_user_code& f);
octave_user_code& operator = (const octave_user_code& f);
};
// Scripts.
class
octave_user_script : public octave_user_code
{
public:
octave_user_script (void);
octave_user_script (const std::string& fnm, const std::string& nm,
tree_statement_list *cmds,
const std::string& ds = "");
octave_user_script (const std::string& fnm, const std::string& nm,
const std::string& ds = "");
~octave_user_script (void);
octave_function *function_value (bool = false) { return this; }
octave_user_script *user_script_value (bool = false) { return this; }
octave_user_code *user_code_value (bool = false) { return this; }
// Scripts and user functions are both considered "scripts" because
// they are written in Octave's scripting language.
bool is_user_script (void) const { return true; }
void stash_fcn_file_name (const std::string& nm) { file_name = nm; }
void mark_fcn_file_up_to_date (const octave::sys::time& t) { t_checked = t; }
void stash_fcn_file_time (const octave::sys::time& t)
{
t_parsed = t;
mark_fcn_file_up_to_date (t);
}
std::string fcn_file_name (void) const { return file_name; }
octave::sys::time time_parsed (void) const { return t_parsed; }
octave::sys::time time_checked (void) const { return t_checked; }
octave_value subsref (const std::string& type,
const std::list<octave_value_list>& idx)
{
octave_value_list tmp = subsref (type, idx, 1);
return tmp.length () > 0 ? tmp(0) : octave_value ();
}
octave_value_list subsref (const std::string& type,
const std::list<octave_value_list>& idx,
int nargout);
octave_value_list
do_multi_index_op (int nargout, const octave_value_list& args);
tree_statement_list *body (void) { return cmd_list; }
void accept (tree_walker& tw);
private:
// The list of commands that make up the body of this function.
tree_statement_list *cmd_list;
// The name of the file we parsed.
std::string file_name;
// The time the file was parsed.
octave::sys::time t_parsed;
// The time the file was last checked to see if it needs to be
// parsed again.
octave::sys::time t_checked;
// Used to keep track of recursion depth.
int call_depth;
// No copying!
octave_user_script (const octave_user_script& f);
octave_user_script& operator = (const octave_user_script& f);
DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
};
// User-defined functions.
class
octave_user_function : public octave_user_code
{
public:
octave_user_function (symbol_table::scope_id sid = -1,
tree_parameter_list *pl = 0,
tree_parameter_list *rl = 0,
tree_statement_list *cl = 0);
~octave_user_function (void);
symbol_table::context_id active_context () const
{
return is_anonymous_function ()
? 0 : static_cast<symbol_table::context_id>(call_depth);
}
octave_function *function_value (bool = false) { return this; }
octave_user_function *user_function_value (bool = false) { return this; }
octave_user_code *user_code_value (bool = false) { return this; }
octave_user_function *define_param_list (tree_parameter_list *t);
octave_user_function *define_ret_list (tree_parameter_list *t);
void stash_fcn_file_name (const std::string& nm);
void stash_fcn_location (int line, int col)
{
location_line = line;
location_column = col;
}
int beginning_line (void) const { return location_line; }
int beginning_column (void) const { return location_column; }
void stash_fcn_end_location (int line, int col)
{
end_location_line = line;
end_location_column = col;
}
int ending_line (void) const { return end_location_line; }
int ending_column (void) const { return end_location_column; }
void maybe_relocate_end (void);
void stash_parent_fcn_name (const std::string& p) { parent_name = p; }
void stash_parent_fcn_scope (symbol_table::scope_id ps) { parent_scope = ps; }
void stash_leading_comment (octave_comment_list *lc) { lead_comm = lc; }
void stash_trailing_comment (octave_comment_list *tc) { trail_comm = tc; }
void mark_fcn_file_up_to_date (const octave::sys::time& t) { t_checked = t; }
void stash_fcn_file_time (const octave::sys::time& t)
{
t_parsed = t;
mark_fcn_file_up_to_date (t);
}
std::string fcn_file_name (void) const { return file_name; }
std::string profiler_name (void) const;
std::string parent_fcn_name (void) const { return parent_name; }
symbol_table::scope_id parent_fcn_scope (void) const { return parent_scope; }
symbol_table::scope_id scope (void) { return local_scope; }
octave::sys::time time_parsed (void) const { return t_parsed; }
octave::sys::time time_checked (void) const { return t_checked; }
void mark_as_system_fcn_file (void);
bool is_system_fcn_file (void) const { return system_fcn_file; }
bool is_user_function (void) const { return true; }
void erase_subfunctions (void)
{
symbol_table::erase_subfunctions_in_scope (local_scope);
}
bool takes_varargs (void) const;
bool takes_var_return (void) const;
void mark_as_private_function (const std::string& cname = "")
{
symbol_table::mark_subfunctions_in_scope_as_private (local_scope, cname);
octave_function::mark_as_private_function (cname);
}
void lock_subfunctions (void);
void unlock_subfunctions (void);
std::map<std::string, octave_value> subfunctions (void) const;
bool has_subfunctions (void) const;
void stash_subfunction_names (const std::list<std::string>& names);
std::list<std::string> subfunction_names (void) const
{
return subfcn_names;
}
octave_value_list all_va_args (const octave_value_list& args);
void stash_function_name (const std::string& s) { my_name = s; }
void mark_as_subfunction (void) { subfunction = true; }
bool is_subfunction (void) const { return subfunction; }
void mark_as_inline_function (void) { inline_function = true; }
bool is_inline_function (void) const { return inline_function; }
void mark_as_anonymous_function (void) { anonymous_function = true; }
bool is_anonymous_function (void) const { return anonymous_function; }
bool is_anonymous_function_of_class
(const std::string& cname = "") const
{
return anonymous_function
? (cname.empty ()
? (! dispatch_class ().empty ())
: cname == dispatch_class ())
: false;
}
// If we are a special expression, then the function body consists of exactly
// one expression. The expression's result is the return value of the
// function.
bool is_special_expr (void) const
{
return is_inline_function () || is_anonymous_function ();
}
bool is_nested_function (void) const { return nested_function; }
void mark_as_nested_function (void) { nested_function = true; }
void mark_as_class_constructor (void) { class_constructor = legacy; }
void mark_as_classdef_constructor (void) { class_constructor = classdef; }
bool is_class_constructor (const std::string& cname = "") const
{
return class_constructor == legacy
? (cname.empty () ? true : cname == dispatch_class ()) : false;
}
bool is_classdef_constructor (const std::string& cname = "") const
{
return class_constructor == classdef
? (cname.empty () ? true : cname == dispatch_class ()) : false;
}
void mark_as_class_method (void) { class_method = true; }
bool is_class_method (const std::string& cname = "") const
{
return class_method
? (cname.empty () ? true : cname == dispatch_class ()) : false;
}
octave_value subsref (const std::string& type,
const std::list<octave_value_list>& idx)
{
octave_value_list tmp = subsref (type, idx, 1);
return tmp.length () > 0 ? tmp(0) : octave_value ();
}
octave_value_list subsref (const std::string& type,
const std::list<octave_value_list>& idx,
int nargout);
octave_value_list subsref (const std::string& type,
const std::list<octave_value_list>& idx,
int nargout,
const std::list<octave_lvalue>* lvalue_list);
octave_value_list
do_multi_index_op (int nargout, const octave_value_list& args);
octave_value_list
do_multi_index_op (int nargout, const octave_value_list& args,
const std::list<octave_lvalue>* lvalue_list);
tree_parameter_list *parameter_list (void) { return param_list; }
tree_parameter_list *return_list (void) { return ret_list; }
tree_statement_list *body (void) { return cmd_list; }
octave_comment_list *leading_comment (void) { return lead_comm; }
octave_comment_list *trailing_comment (void) { return trail_comm; }
// If is_special_expr is true, retrieve the sigular expression that forms the
// body. May be null (even if is_special_expr is true).
tree_expression *special_expr (void);
bool subsasgn_optimization_ok (void);
void accept (tree_walker& tw);
template <typename T>
bool local_protect (T& variable)
{
if (curr_unwind_protect_frame)
{
curr_unwind_protect_frame->protect_var (variable);
return true;
}
else
return false;
}
#if defined (HAVE_LLVM)
jit_function_info *get_info (void) { return jit_info; }
void stash_info (jit_function_info *info) { jit_info = info; }
#endif
#if 0
void print_symtab_info (std::ostream& os) const;
#endif
private:
enum class_ctor_type
{
none,
legacy,
classdef
};
// List of arguments for this function. These are local variables.
tree_parameter_list *param_list;
// List of parameters we return. These are also local variables in
// this function.
tree_parameter_list *ret_list;
// The list of commands that make up the body of this function.
tree_statement_list *cmd_list;
// The comments preceding the FUNCTION token.
octave_comment_list *lead_comm;
// The comments preceding the ENDFUNCTION token.
octave_comment_list *trail_comm;
// The name of the file we parsed.
std::string file_name;
// Location where this function was defined.
int location_line;
int location_column;
int end_location_line;
int end_location_column;
// The name of the parent function, if any.
std::string parent_name;
// The list of subfunctions (if any) in the order they appear in the
// file.
std::list<std::string> subfcn_names;
// The time the file was parsed.
octave::sys::time t_parsed;
// The time the file was last checked to see if it needs to be
// parsed again.
octave::sys::time t_checked;
// True if this function came from a file that is considered to be a
// system function. This affects whether we check the time stamp
// on the file to see if it has changed.
bool system_fcn_file;
// Used to keep track of recursion depth.
int call_depth;
// The number of arguments that have names.
int num_named_args;
// TRUE means this subfunction of a primary function.
bool subfunction;
// TRUE means this is an inline function.
bool inline_function;
// TRUE means this is an anonymous function.
bool anonymous_function;
// TRUE means this is a nested function. (either a child or parent)
bool nested_function;
// Enum describing whether this function is the constructor for class object.
class_ctor_type class_constructor;
// TRUE means this function is a method for a class.
bool class_method;
// The scope of the parent function, if any.
symbol_table::scope_id parent_scope;
symbol_table::scope_id local_scope;
// pointer to the current unwind_protect frame of this function.
octave::unwind_protect *curr_unwind_protect_frame;
#if defined (HAVE_LLVM)
jit_function_info *jit_info;
#endif
void maybe_relocate_end_internal (void);
void print_code_function_header (void);
void print_code_function_trailer (void);
void bind_automatic_vars (const string_vector& arg_names, int nargin,
int nargout, const octave_value_list& va_args,
const std::list<octave_lvalue> *lvalue_list);
void restore_warning_states (void);
// No copying!
octave_user_function (const octave_user_function& fn);
octave_user_function& operator = (const octave_user_function& fn);
DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
};
#endif
|