annotate __py_struct_from_dict__.cc @ 345:baff3b90dcb1

__py_struct_from_dict__: new private compiled conversion function * __py_struct_from_dict__.cc: New private internal compiled function to convert a Python dict to a scalar struct. * Makefile.am (OCT_FILES): Add __py_struct_from_dict__.oct to the list.
author Mike Miller <mtmiller@octave.org>
date Tue, 16 Aug 2016 15:34:05 -0700
parents
children 6cd581661176
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
345
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
1 /*
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
2
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
3 Copyright (C) 2016 Mike Miller
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
4
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
5 This file is part of Pytave.
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
6
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
7 Pytave is free software: you can redistribute it and/or modify it
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
9 Free Software Foundation, either version 3 of the License, or (at your
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
10 option) any later version.
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
11
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
12 Pytave is distributed in the hope that it will be useful, but WITHOUT
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
15 for more details.
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
16
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
18 along with Pytave; see the file COPYING. If not, see
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
19 <http://www.gnu.org/licenses/>.
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
20
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
21 */
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
22
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
23 #if defined (HAVE_CONFIG_H)
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
24 # include <config.h>
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
25 #endif
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
26
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
27 #include <Python.h>
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
28 #include <octave/oct.h>
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
29
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
30 #define PYTAVE_DO_DECLARE_SYMBOL
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
31 #include "arrayobjectdefs.h"
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
32 #include "exceptions.h"
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
33 #include "oct-py-types.h"
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
34 #include "octave_to_python.h"
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
35
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
36 DEFUN_DLD (__py_struct_from_dict__, args, nargout,
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
37 "-*- texinfo -*-\n\
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
38 @deftypefn {} {} __py_struct_from_dict__ (@var{dict})\n\
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
39 Extract a scalar struct from the Python dict @var{dict}.\n\
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
40 \n\
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
41 This is a private internal function not intended for direct use.\n\
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
42 @end deftypefn")
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
43 {
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
44 octave_value_list retval;
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
45 std::string id;
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
46
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
47 int nargin = args.length ();
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
48
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
49 if (nargin != 1)
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
50 {
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
51 print_usage ();
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
52 return retval;
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
53 }
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
54
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
55 if (! (args(0).is_object () && args(0).class_name () == "pyobject"))
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
56 error ("pyobject.struct: argument must be a Python object");
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
57
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
58 Py_Initialize ();
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
59
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
60 try
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
61 {
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
62 // FIXME: PyObject *obj = look up stored pyobject reference (args(0));
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
63 boost::python::object arg;
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
64 pytave::octvalue_to_pyobj (arg, args(0));
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
65 PyObject *obj = arg.ptr ();
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
66
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
67 retval(0) = pytave::extract_py_scalar_map (obj);
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
68 }
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
69 catch (pytave::object_convert_exception const &)
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
70 {
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
71 error ("pyobject.struct: error in return value type conversion");
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
72 }
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
73 catch (boost::python::error_already_set const &)
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
74 {
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
75 std::string message = pytave::fetch_exception_message ();
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
76 error ("pyobject.struct: %s", message.c_str ());
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
77 }
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
78
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
79 return retval;
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
80 }
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
81
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
82 /*
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
83 ## No test needed for internal helper function.
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
84 %!assert (1)
baff3b90dcb1 __py_struct_from_dict__: new private compiled conversion function
Mike Miller <mtmiller@octave.org>
parents:
diff changeset
85 */