GNU Octave  4.0.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ov-dld-fcn.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1996-2015 John W. Eaton
4 
5 This file is part of Octave.
6 
7 Octave is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 Octave is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with Octave; see the file COPYING. If not, see
19 <http://www.gnu.org/licenses/>.
20 
21 */
22 
23 #if !defined (octave_ov_dld_fcn_h)
24 #define octave_ov_dld_fcn_h 1
25 
26 #include <string>
27 
28 #include "oct-shlib.h"
29 
30 #include "ov-fcn.h"
31 #include "ov-builtin.h"
32 #include "ov-typeinfo.h"
33 
34 class octave_shlib;
35 
36 class octave_value;
37 class octave_value_list;
38 
39 // Dynamically-linked functions.
40 
41 class
44 {
45 public:
46 
48  : sh_lib (), t_checked (), system_fcn_file ()
49  { }
50 
52  const std::string& nm = std::string (),
53  const std::string& ds = std::string ());
54 
55  ~octave_dld_function (void);
56 
57  void mark_fcn_file_up_to_date (const octave_time& t) { t_checked = t; }
58 
59  std::string fcn_file_name (void) const;
60 
61  octave_time time_parsed (void) const;
62 
63  octave_time time_checked (void) const { return t_checked; }
64 
65  bool is_system_fcn_file (void) const { return system_fcn_file; }
66 
67  bool is_builtin_function (void) const { return false; }
68 
69  bool is_dld_function (void) const { return true; }
70 
71  static octave_dld_function* create (octave_builtin::fcn ff,
72  const octave_shlib& shl,
73  const std::string& nm = std::string (),
74  const std::string& ds = std::string ());
75 
76  octave_shlib get_shlib (void) const
77  { return sh_lib; }
78 
79 private:
80 
82 
83  // The time the file was last checked to see if it needs to be
84  // parsed again.
86 
87  // True if this function came from a file that is considered to be a
88  // system function. This affects whether we check the time stamp
89  // on the file to see if it has changed.
91 
92  // No copying!
93 
95 
97 
98 
100 };
101 
102 #endif
octave_value_list(* fcn)(const octave_value_list &, int)
Definition: ov-builtin.h:45
octave_time time_checked(void) const
Definition: ov-dld-fcn.h:63
bool is_builtin_function(void) const
Definition: ov-dld-fcn.h:67
octave_time t_checked
Definition: ov-dld-fcn.h:85
#define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
Definition: ov-base.h:142
static std::string fcn_file_name(const octave_value &fcn)
Definition: symtab.cc:1163
void mark_fcn_file_up_to_date(const octave_time &t)
Definition: ov-dld-fcn.h:57
#define OCTINTERP_API
Definition: mexproto.h:66
octave_dld_function(void)
Definition: ov-dld-fcn.h:47
bool is_system_fcn_file(void) const
Definition: ov-dld-fcn.h:65
octave_shlib get_shlib(void) const
Definition: ov-dld-fcn.h:76
octave_shlib sh_lib
Definition: ov-dld-fcn.h:81
bool is_dld_function(void) const
Definition: ov-dld-fcn.h:69
octave_value_list & operator=(const octave_value_list &obj)
Definition: oct-obj.h:68