annotate src/ov-dld-fcn.h @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children a1ab9dbc9622
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
1 /*
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
2
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1996, 1997, 1999, 2000, 2002, 2003, 2004, 2005, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 John W. Eaton
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
5
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
7
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
9 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: 5307
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
11 option) any later version.
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
12
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
16 for more details.
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
17
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
18 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: 5307
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
20 <http://www.gnu.org/licenses/>.
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
21
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
22 */
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
23
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_dld_function_h)
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
25 #define octave_dld_function_h 1
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
26
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
27 #include <string>
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
28
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
29 #include "oct-shlib.h"
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
30
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
31 #include "ov-fcn.h"
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
32 #include "ov-builtin.h"
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
33 #include "ov-typeinfo.h"
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
34
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
35 class octave_shlib;
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
36
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
37 class octave_value;
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
38 class octave_value_list;
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
39
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
40 // Dynamically-linked functions.
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
41
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
42 class
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
43 octave_dld_function : public octave_builtin
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
44 {
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
45 public:
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
46
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4642
diff changeset
47 octave_dld_function (void) { }
4641
7604168d3e2a [project @ 2003-11-22 12:19:27 by jwe]
jwe
parents: 4612
diff changeset
48
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
49 octave_dld_function (octave_builtin::fcn ff, const octave_shlib& shl,
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3329
diff changeset
50 const std::string& nm = std::string (),
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3329
diff changeset
51 const std::string& ds = std::string ());
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
52
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
53 ~octave_dld_function (void);
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
54
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
55 void mark_fcn_file_up_to_date (const octave_time& t) { t_checked = t; }
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
56
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3329
diff changeset
57 std::string fcn_file_name (void) const;
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
58
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
59 octave_time time_parsed (void) const;
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
60
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
61 octave_time time_checked (void) const { return t_checked; }
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
62
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
63 bool is_system_fcn_file (void) const { return system_fcn_file; }
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
64
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
65 bool is_builtin_function (void) const { return false; }
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
66
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
67 bool is_dld_function (void) const { return true; }
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
68
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
69 private:
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
70
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
71 octave_shlib sh_lib;
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
72
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
73 // The time the file was last checked to see if it needs to be
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
74 // parsed again.
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
75 mutable octave_time t_checked;
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
76
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
77 // True if this function came from a file that is considered to be a
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
78 // system function. This affects whether we check the time stamp
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
79 // on the file to see if it has changed.
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
80 bool system_fcn_file;
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
81
4645
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4642
diff changeset
82 // No copying!
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4642
diff changeset
83
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4642
diff changeset
84 octave_dld_function (const octave_dld_function& fn);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4642
diff changeset
85
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4642
diff changeset
86 octave_dld_function& operator = (const octave_dld_function& fn);
bd2067547b40 [project @ 2003-11-23 08:07:52 by jwe]
jwe
parents: 4642
diff changeset
87
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4192
diff changeset
88 DECLARE_OCTAVE_ALLOCATOR
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
89
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4192
diff changeset
90 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
3329
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
91 };
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
92
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
93 #endif
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
94
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
95 /*
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
96 ;;; Local Variables: ***
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
97 ;;; mode: C++ ***
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
98 ;;; End: ***
e84e324db1de [project @ 1999-11-01 21:58:57 by jwe]
jwe
parents:
diff changeset
99 */