Mercurial > pytave
changeset 429:c8543d9a4bff draft default tip @
Empty the repository, leave a note about where development has been moved
| author | Mike Miller <mtmiller@octave.org> |
|---|---|
| date | Fri, 25 Oct 2019 13:53:09 -0700 |
| parents | 3af3665348a1 |
| children | |
| files | .hgignore @py/py.m @py/subsref.m @pyobject/cell.m @pyobject/char.m @pyobject/display.m @pyobject/dummy.m @pyobject/fieldnames.m @pyobject/methods.m @pyobject/pyobject.m @pyobject/subsasgn.m @pyobject/subsref.m CONTRIBUTORS.md COPYING Doxyfile Makefile.am README.md __py_struct_from_dict__.cc __py_tests__.m bitbucket-pipelines.yml configure.ac m4/ax_octave.m4 m4/ax_python_devel.m4 m4/std-gnu11.m4 oct-py-error.cc oct-py-error.h oct-py-eval.cc oct-py-eval.h oct-py-init.cc oct-py-init.h oct-py-object.h oct-py-types.cc oct-py-types.h oct-py-util.cc oct-py-util.h pyargs.m pycall.cc pyeval.cc pyexec.cc pyversion.m |
| diffstat | 40 files changed, 5 insertions(+), 9433 deletions(-) [+] |
line wrap: on
line diff
--- a/.hgignore Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ -syntax: regexp -# The recurrent (^|/) idiom in the regexps below should be understood -# to mean "at any directory" while the ^ idiom means "from the -# project's top-level directory". - -# These directories and files are created by GNU autotools -^Makefile\.in$ -^aclocal\.m4$ -^autom4te\.cache($|/) -^build-aux($|/) -^config\.h\.in$ -^configure$ - -# This directory contains m4 files managed by GNU libtool, but also contains -# some files maintained in the repository -^m4/(libtool|lt.+)\.m4$ - -# These files are created by running configure -(^|/)Makefile$ -(^|/)config\.h$ -(^|/)config\.log$ -(^|/)config\.status$ -(^|/)libtool$ -(^|/)stamp-h1$ - -# These files are normal build system artifacts -(^|/).+\.cc-tst$ -(^|/).+\.l?[ao]$ -(^|/).+\.oct$ -(^|/).+\.tar\.gz$ -(^|/)PKG_(ADD|DEL)$ -(^|/)\.deps($|/) -(^|/)\.libs($|/) -(^|/)fntests\.log$ -(^|/)octave-workspace$ - -# This directory contains Doxygen generated documentation -^doc($|/)
--- a/@py/py.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,59 +0,0 @@ -## Copyright (C) 2016 Mike Miller -## -## This file is part of Pytave. -## -## Pytave 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. -## -## Pytave 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 Pytave; see the file COPYING. If not, see -## <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @deftypefn {} {} py -## @deftypefnx {} {} py.@var{pyname} -## Get the value of a Python object or call a Python function. -## @end deftypefn - -function p = py () - p = class (struct (), "py"); -endfunction - -%!assert (py.math.sqrt (2), sqrt (2)) -%!assert (ischar (char (py.sys.version))) - -%!test -%! if (double (py.sys.hexversion) >= 0x03000000) -%! assert (isobject (py.int (0))) -%! else -%! assert (py.int (0), int64 (0)) -%! endif - -%!test -%! if (double (py.sys.hexversion) < 0x03000000) -%! assert (py.int (2147483647), int64 (2147483647)) -%! endif - -%!test -%! if (double (py.sys.hexversion) < 0x03000000) -%! assert (isobject (py.long (0))) -%! endif - -%!test -%! if (double (py.sys.hexversion) >= 0x03000000) -%! assert (isobject (py.int (2^100))) -%! else -%! assert (isobject (py.long (2^100))) -%! endif - -## Cannot use '@' to make a handle to a Python function -%!xtest -%! fn = @py.math.abs; -%! assert (fn (-3), 3)
--- a/@py/subsref.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,72 +0,0 @@ -## Copyright (C) 2016 Mike Miller -## -## This file is part of Pytave. -## -## Pytave 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. -## -## Pytave 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 Pytave; see the file COPYING. If not, see -## <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @deftypefn {} {} subsref (@var{x}, @var{idx}) -## Implements Python name lookup via dot indexing. -## @enddeftypefn - -function varargout = subsref (x, idx) - - if (nargin != 2) - print_usage (); - endif - - if (! isa (x, "py")) - error ("py: invalid call to subsref"); - endif - - if (isempty (idx) || ! isstruct (idx)) - error ("py: invalid call to subsref without indices"); - endif - - type = idx(1).type; - subs = idx(1).subs; - - if (type != ".") - error ("py: invalid indexing type"); - endif - - if (type == "." && ((numel (idx) == 1) || (idx(2).type != "."))) - try - y = pyeval (subs); - catch - y = pycall ("__import__", subs); - end_try_catch - else - y = pycall ("__import__", subs); - endif - - if (numel (idx) > 1) - y = subsref (y, idx(2:end)); - endif - - ## If the *last* indexing operation is ".name", and the object returned - ## is a Python callable, then call it with no arguments to be compatible - ## with how Octave functions are evaluated. - if (idx(end).type == ".") - if (isa (y, "py.collections.Callable")) - y = pycall (y); - endif - endif - - if (nargout > 0 || ! __py_is_none__ (y)) - varargout{1} = y; - endif - -endfunction
--- a/@pyobject/cell.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,102 +0,0 @@ -## Copyright (C) 2016 Colin B. Macdonald -## Copyright (C) 2016 Mike Miller -## -## This file is part of Pytave -## -## Pytave 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. -## -## This software 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 this software; see the file COPYING. -## If not, see <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defmethod @@pyobject cell (@var{x}) -## Convert a Python list or other object implementing the Sequence protocol -## to a cell array. -## -## For example, by default Python lists are not automatically -## converted into native Octave objects: -## @example -## @group -## L = pyeval ("[10.0, 20.0, 'hello']") -## @result{} L = [Python object of type list] -## -## [10.0, 20.0, 'hello'] -## @end group -## @end example -## -## However, we can convert the list to a cell array: -## @example -## @group -## @c FIXME: display of cell array in flux: https://savannah.gnu.org/bugs/?50756 -## @c doctest: +XFAIL -## C = cell (L) -## @result{} C = -## @{ -## [1,1] = 10 -## [1,2] = 20 -## [1,3] = [Python object of type str] -## -## hello -## @} -## @end group -## @end example -## -## The conversion is not recursive, in the following sense: -## @example -## @group -## @c FIXME: display of cell array in flux: https://savannah.gnu.org/bugs/?50756 -## @c doctest: +XFAIL -## L = pyeval ("[10.0, 20.0, [33.0, 44.0], 50.0]"); -## C = cell (L) -## @result{} C = -## @{ -## [1,1] = 10 -## [1,2] = 20 -## [1,3] = [Python object of type list] -## -## [33.0, 44.0] -## -## [1,4] = 50 -## @} -## @end group -## @end example -## -## @seealso{cell2mat} -## @end defmethod - - -function c = cell (x) - ## FIXME: when subsref returns the right number of output args, this can - ## simply be "c = {x{:}}" - n = length (x); - c = cell (1, n); - if (n > 0) - [c{:}] = subsref (x, struct ("type", "{}", "subs", {{":"}})); - endif -endfunction - - -%!assert (cell (pyeval ("[]")), cell (1, 0)) -%!assert (cell (pyeval ("[1.]")), {1}) -%!assert (cell (pyeval ("[1., 2., 3.]")), {1, 2, 3}) -%!assert (cell (pyeval ("(1., 2., 3.)")), {1, 2, 3}) -%!assert (cellfun (@char, cell (pyobject ("asdf")), "uniformoutput", false), {"a", "s", "d", "f"}) - -%!test -%! c = cell (pyeval ("range(10)")); -%! c = cellfun (@(x) eval ("double (x)"), c, "uniformoutput", false); -%! assert (c, num2cell (0:9)) - -%!error cell (pyobject ()) -%!error cell (pyeval ("None")) -%!error cell (pyobject (1))
--- a/@pyobject/char.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,39 +0,0 @@ -## Copyright (C) 2016 Mike Miller -## -## This file is part of Pytave. -## -## Pytave 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. -## -## Pytave 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 Pytave; see the file COPYING. If not, see -## <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defmethod @@pyobject char (@var{x}) -## Conversion method to string. -## -## Example: -## @example -## @group -## s = pyobject ("hello world"); -## char (s) -## @result{} hello world -## @end group -## @end example -## @seealso{@@pyobject/disp} -## @end defmethod - -function s = char (x) - - s = __py_string_value__ (x); - -endfunction
--- a/@pyobject/display.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,66 +0,0 @@ -## Copyright (C) 2016 Colin B. Macdonald -## -## This file is part of Pytave -## -## Pytave 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. -## -## This software 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 this software; see the file COPYING. -## If not, see <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defmethod @@pyobject display (@var{x}) -## Custom display for pyobjects. -## -## Example: -## @example -## @group -## pyexec ("import sys") -## sysmodule = pyeval ("sys") -## @result{} sysmodule = [Python object of type module] -## -## <module 'sys' (built-in)> -## -## @end group -## @end example -## -## @seealso{@@pyobject/char, @@pyobject/disp} -## @end defmethod - - -function display (x) - - try - [~, spacing] = format (); - loose = strcmp (spacing, "loose"); - catch - loose = ! __compactformat__ (); - end_try_catch - - printf ("%s = [Python object of type %s]\n", inputname (1), __py_class_name__ (x)); - s = char (x); - s = make_indented (s); - if (loose), printf ("\n"); endif - disp (s) - if (loose), printf ("\n"); endif - -endfunction - - -function s = make_indented (s, n) - if (nargin == 1) - n = 2; - endif - pad = char (double (" ") * ones (1,n)); - s = strrep (s, "\n", ["\n" pad]); - s = [pad s]; # first line -endfunction
--- a/@pyobject/dummy.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,167 +0,0 @@ -## Copyright (C) 2016 Colin B. Macdonald -## -## This file is part of Pytave -## -## Pytave 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. -## -## This software 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 this software; see the file COPYING. -## If not, see <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defmethod @@pyobject dummy (@var{x}) -## Does nothing, stores doctests and other misc docs for now. -## -## -## Some simple Python objects are converted to equivalent Octave values: -## @example -## @group -## pyeval ("6.0") -## @result{} ans = 6 -## @end group -## @end example -## -## To ensure the return value is a @@pyobject, it can be cast: -## @example -## @group -## g = pyobject (int32 (6)) -## @result{} g = [Python object of type int] -## -## 6 -## -## sort (methods (g)) -## @result{} ans = -## @{ -## [1,1] = bit_length -## ... -## @} -## -## sort (fieldnames (g)) -## @result{} ans = -## @{ -## [1,1] = denominator -## [2,1] = imag -## [3,1] = numerator -## [4,1] = real -## @} -## -## double (g.numerator) -## @result{} ans = 6 -## double (g.denominator) -## @result{} ans = 1 -## @end group -## @end example -## -## -## You can delete an object in Python and it will persist: -## @example -## @group -## pyexec ("d = dict(two=2)") -## x = pyeval ("d") -## @result{} x = [Python object of type dict] -## @{'two': 2@} -## -## # oops, overwrote d in Python: -## pyexec ("d = 42") -## -## # but have no fear, we still have a reference to it: -## x -## @result{} x = [Python object of type dict] -## @{'two': 2@} -## @end group -## @end example -## -## We can accesss ``callables'' (methods) of objects: -## @example -## @group -## double (x.pop ("two")) -## @result{} ans = 2 -## @end group -## @end example -## And note this has changed the Python dict @code{x}: -## @example -## @group -## x -## @result{} x = [Python object of type dict] -## @{@} -## @end group -## @end example -## -## -## @code{pyeval} returns a @@pyobject for things it cannot convert to -## Octave-native objects: -## @example -## @group -## pyexec ("import sys") -## sysmodule = pyeval ("sys") -## @result{} sysmodule = [Python object of type module] -## <module 'sys' (built-in)> -## @end group -## @end example -## -## After you have the object, you can access its properties: -## @example -## @group -## sysmodule.version -## @result{} ans = ... -## @end group -## @end example -## -## -## A Python list is returned as a @@pyobject: -## @example -## @group -## L = pyeval ("[42.0, 'hello', sys]") -## @result{} L = [Python object of type list] -## [42.0, 'hello', <module 'sys' (built-in)>] -## @end group -## @end example -## -## Elements of the list can be accessed directly -## @example -## @group -## L@{1@} -## @result{} ans = 42 -## @end group -## @end example -## or if needed, the list can be converted to a cell array: -## @example -## @group -## @c FIXME: display of cell array in flux: https://savannah.gnu.org/bugs/?50756 -## @c doctest: +XFAIL -## cell (L) -## @result{} ans = -## @{ -## [1,1] = 42 -## [1,2] = [Python object of type str] -## hello -## [1,3] = [Python object of type module] -## <module 'sys' (built-in)> -## @} -## @end group -## @end example -## -## A @@pyobject can be passed back to Python. This does not make -## a copy but rather a reference to the original object. -## For example: -## @example -## @group -## char (pycall ("repr", sysmodule)) -## @result{} <module 'sys' (built-in)> -## @end group -## @end example -## -## @seealso{pyobject} -## @end defmethod - -function dummy (x) -endfunction
--- a/@pyobject/fieldnames.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,82 +0,0 @@ -## Copyright (C) 2016 Mike Miller -## -## This file is part of Pytave -## -## Pytave 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. -## -## This software 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 this software; see the file COPYING. -## If not, see <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defmethod @@pyobject fieldnames (@var{x}) -## List the properties of a Python object. -## -## Returns a cell array of strings containing the names of the properties -## of @var{x}. -## -## Example: -## @example -## @group -## pyexec ("import sys") -## sys = pyeval ("sys"); -## fieldnames (sys) -## @result{} ans = -## @{ -## [1,1] = ... -## [2,1] = ... -## ... = path -## ... = version -## ... -## @} -## @end group -## @end example -## -## @seealso{fieldnames, @@pyobject/methods} -## @end defmethod - - -function names = fieldnames (x) - - cmd = pyeval (["lambda x: [a for a in dir(x)" ... - " if not callable(getattr(x, a))" ... - " and not isinstance(getattr(x, a), __import__('types').ModuleType)" ... - " and not a.startswith('_')]"]); - - names_obj = pycall (cmd, x); - names = cellfun (@char, cell (names_obj), "uniformoutput", false); - names = names(:); - -endfunction - - -%!test -%! sys = pycall ("__import__", "sys"); -%! lst = fieldnames (sys); -%! assert (iscell (lst)) -%! assert (length (lst) >= 32) -%! assert (any (strcmp (lst, "path"))) -%! assert (any (strcmp (lst, "prefix"))) -%! assert (any (strcmp (lst, "stderr"))) -%! assert (any (strcmp (lst, "stdin"))) -%! assert (any (strcmp (lst, "stdout"))) -%! assert (any (strcmp (lst, "version"))) - -%!test -%! lst = fieldnames (pyeval ("__builtins__")); -%! assert (any (strcmp (lst, "False"))) -%! assert (any (strcmp (lst, "None"))) -%! assert (any (strcmp (lst, "True"))) - -%!assert (fieldnames (pyeval ("object()")), cell (0, 1)) -%!assert (fieldnames (pyeval ("{}")), cell (0, 1)) -%!assert (ismember ("denominator", fieldnames (pycall ("fractions.Fraction"))))
--- a/@pyobject/methods.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,142 +0,0 @@ -## Copyright (C) 2016 Colin B. Macdonald -## Copyright (C) 2017 NVS Abhilash -## -## This file is part of Pytave -## -## Pytave 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. -## -## This software 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 this software; see the file COPYING. -## If not, see <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defmethod @@pyobject methods (@var{x}) -## @defmethodx @@pyobject methods (@var{x}, "-all") -## List the properties/callables of a Python object. -## -## Returns a cell array of strings, the names of the ``callables'' -## of @var{x}. -## -## If provided with an option @qcode{"-all"}, private methods are also included. -## -## Example: -## @example -## @group -## pyexec ("import os") -## os = pyeval ("os"); -## methods (os) -## @print{} Methods for Python module 'os': -## @print{} ... -## @print{} chdir ... -## @print{} ... -## x = methods (os) -## @result{} x = -## @{ -## [1,1] = ... -## [2,1] = ... -## ... = chdir -## ... = getenv -## ... -## @} -## @end group -## @end example -## -## To get the properties (non-callables) of an object, -## @pxref{@@pyobject/fieldnames}. -## -## Note that if you instead want the methods implemented by -## the Octave class @code{@@pyobject}, you can always do: -## @example -## @group -## methods pyobject -## @print{} Methods for class pyobject: -## @print{} ... display ... -## @comment this doctest may need updating as we add methods -## @end group -## @end example -## -## @seealso{methods, @@pyobject/fieldnames} -## @end defmethod - - -function mtds = methods (x, option) - - if (nargin < 1 || nargin > 2) - print_usage (); - endif - - show_all = false; - if (nargin == 2) - if (ischar (option)) - switch (tolower (option)) - case "-all" - show_all = true; - otherwise - warning ("methods: unrecognized OPTION '%s'", option); - endswitch - else - error ("methods: OPTION must be a string"); - endif - endif - - query_end = ""; - if (! show_all) - query_end = "and not a.startswith('_')"; - endif - - query = sprintf (["lambda x: [a for a in dir(x)" ... - " if callable(getattr(x, a)) %s]"], query_end); - - cmd = pyeval (query); - - mtds_list_obj = pycall (cmd, x); - - mtds_list = cellfun (@char, cell (mtds_list_obj), "uniformoutput", false); - - if (nargout == 0) - if (isa (x, "py.types.ModuleType")) - modulename = char (pycall ("getattr", x, "__name__")); - printf ("Methods for Python module '%s':\n", modulename); - else - printf ("Methods for Python class '%s':\n", __py_class_name__ (x)); - endif - disp (list_in_columns (mtds_list)); - else - mtds = mtds_list(:); - endif - -endfunction - - -%!test -%! sys = pycall ("__import__", "sys"); -%! m = methods (sys); -%! assert (iscellstr (m)) -%! assert (any (strcmp (m, "exit"))) - -%!test -%! os = pycall ("__import__", "os"); -%! m = methods (os); -%! assert (iscellstr (m)) -%! assert (any (strcmp (m, "chdir"))) -%! assert (any (strcmp (m, "getcwd"))) -%! assert (any (strcmp (m, "getenv"))) -%! assert (any (strcmp (m, "getpid"))) - -%!assert (methods (pyeval ("object()")), cell (0, 1)) -%!assert (ismember ("append", methods (pyeval ("[]")))) -%!assert (ismember ("keys", methods (pyeval ("{}")))) - -%!assert (! ismember ("__reversed__", methods (pyeval ("[]")))) -%!assert (ismember ("__reversed__", methods (pyeval ("[]"), "-all"))) -%!assert (! ismember ("__contains__", methods (pyeval ("{}")))) -%!assert (ismember ("__contains__", methods (pyeval ("{}"), "-all")))
--- a/@pyobject/pyobject.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,426 +0,0 @@ -## Copyright (C) 2016 Colin B. Macdonald -## -## This file is part of Pytave -## -## Pytave 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. -## -## This software 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 this software; see the file COPYING. -## If not, see <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defun pyobject (@var{s}) -## Wrap a Python object. -## -## TODO: where/how to document classdef classes? -## -## @seealso{pyexec, pyeval} -## @end defun - - -classdef pyobject < handle - properties - m_id - endproperties - - - methods - function obj = pyobject (x, id) - if (nargin == 0) - obj = pyeval ("None"); - elseif (nargin == 1) - ## Convert the input to a pyobject - if (isa (x, "pyobject")) - obj = x; - else - obj.m_id = __py_objstore_put__ (x); - endif - elseif (nargin == 2) - ## The actual constructor. Nicer to split this off to static method - ## like `pyobject.new` but I don't know how to call from pycall.cc. - ## Warning: not intended for casual use: you must also insert the - ## object into the Python object store with key `id`. - obj.m_id = id; - else - error ("pyobject: unexpected input to the constructor") - endif - endfunction - - function delete (x) - # Called on clear of the last reference---for subclasses of - # handle; not called at all for "value classes". - # - # FIXME: #46497 this is never called! - # Workaround: call @code{delete(x)} right before @code{clear x}. But - # be careful, @code{x} needs to be the last reference: don't do this: - # @example - # d = pyobject (...); - # d2 = d; - # delete (d) - # clear d - # d2 - # @print{} ... KeyError ... - # @end example - - #disp ("delete") - - __py_objstore_del__ (x.m_id); - endfunction - - # methods defined in external files - char (x) - dummy (x) - display (x) - subsref (x, idx) - - function r = id (x); - r = x.m_id; - endfunction - - function varargout = disp (x) - s = char (x); - if (nargout == 0) - disp (s) - else - varargout = {s}; - endif - endfunction - - function s = class (x) - s = __py_class_name__ (x); - s = sprintf ("py.%s", s); - endfunction - - function y = double (x) - if (isa (x, "py.array.array")) - c = cell (x); - y = cellfun (@(t) eval ("double (t)"), c); - else - y = pycall ("float", x); - endif - endfunction - - function y = single (x) - y = single (double (x)); - endfunction - - function y = int8 (x) - y = int8 (__py_int64_scalar_value__ (x)); - endfunction - - function y = int16 (x) - y = int16 (__py_int64_scalar_value__ (x)); - endfunction - - function y = int32 (x) - y = int32 (__py_int64_scalar_value__ (x)); - endfunction - - function y = int64 (x) - y = __py_int64_scalar_value__ (x); - endfunction - - function y = uint8 (x) - y = uint8 (__py_uint64_scalar_value__ (x)); - endfunction - - function y = uint16 (x) - y = uint16 (__py_uint64_scalar_value__ (x)); - endfunction - - function y = uint32 (x) - y = uint32 (__py_uint64_scalar_value__ (x)); - endfunction - - function y = uint64 (x) - y = __py_uint64_scalar_value__ (x); - endfunction - - function y = isa (x, typestr) - assert (nargin == 2); - assert (ischar (typestr) || iscellstr (typestr)); - - if (ischar (typestr)) - typestr = { typestr }; - endif - - y = false (size (typestr)); - - for i = 1:numel (typestr) - if ((numel (typestr{i}) > 3) && (typestr{i}(1:3) == "py.")) - y(i) = __py_isinstance__ (x, typestr{i}); - else - y(i) = builtin ("isa", x, typestr{i}); - endif - endfor - endfunction - - function y = struct (x) - y = __py_struct_from_dict__ (x); - endfunction - - function vargout = help (x) - idx = struct ("type", ".", "subs", "__doc__"); - s = subsref (x, idx); - if (nargout == 0) - disp (s) - else - vargout = {s}; - endif - endfunction - - function len = length (x) - try - len = double (pycall ("len", x)); - catch - len = 1; - end_try_catch - endfunction - - - function [n, varargout] = size (x, d) - assert (nargin <= 2) - try - idx = struct ("type", ".", "subs", "shape"); - sz = subsref (x, idx); - sz = cellfun (@(x) eval ("double (x)"), cell (sz)); - catch - ## if it had no shape, make it a row vector - sz = [1 length(x)]; - end_try_catch - - ## simplest case - if (nargout <= 1 && nargin == 1) - n = sz; - return - endif - - ## quirk: pad extra dimensions with ones - if (nargin < 2) - d = 1; - endif - sz(end+1:max (d,nargout-end)) = 1; - - if (nargin > 1) - assert (nargout <= 1) - n = sz(d); - return - endif - - ## multiple outputs - n = sz(1); - for i = 2:(nargout-1) - varargout{i-1} = sz(i); - endfor - ## last is product of all remaining - varargout{nargout-1} = prod (sz(nargout:end)); - endfunction - - function n = ndims (x) - assert (nargin == 1) - n = length (size (x)); - endfunction - - function r = end (x, index_pos, num_indices) - assert (nargin == 3) - assert (isscalar (index_pos)) - if (num_indices == 1) - r = prod (size (x)); - else - r = size (x, index_pos); - endif - endfunction - - function res = isequal (varargin) - assert (nargin >= 2) - res = all (strcmp ("pyobject", cellfun ("class", varargin, "uniformoutput", false))); - for i = 2:nargin - if (! res) - return; - endif - res = res && pycall("bool", pycall ("operator.eq", varargin{1}, varargin{i})); - endfor - endfunction - endmethods -endclassdef - - -%!test -%! pyexec ("import sys") -%! A = pyeval ("sys"); -%! assert (isa (A, "pyobject")) - -%!test -%! pyobj = pyeval ("{1:2, 2:3, 3:4}"); -%! assert (isa (pyobj, "pyobject")) -%! assert (length (pyobj), 3) - -%!test -%! pyexec ("import sys"); -%! pyobj = pyeval ("sys"); -%! assert (length (pyobj), 1) - -%!assert (size (pyeval ("[10, 20, 30]")), [1 3]) -%!assert (size (pyeval ("[10, 20, 30]"), 1), 1) -%!assert (size (pyeval ("[10, 20, 30]"), 2), 3) -%!assert (size (pyeval ("[10, 20, 30]"), 3), 1) - -%!test -%! L = pyeval ("[10, 20, 30]"); -%! a = size (L); -%! assert (a, [1, 3]) -%! [a b] = size (L); -%! assert ([a b], [1 3]) -%! [a b c] = size (L); -%! assert ([a b c], [1 3 1]) - -%!assert (numel (pyeval ("[10, 20, 30]")), 1) - -%!test -%! L = pyeval ("[10, 20, 30]"); -%! assert (double (L{end}), 30) -%! assert (double (L{end-1}), 20) - -%!test -%! % ensure "end" works for iterables that are not lists -%! myrange = pyeval ( ... -%! "range if __import__('sys').hexversion >= 0x03000000 else xrange"); -%! R = pycall (myrange, int32 (5), int32 (10), int32 (2)); -%! assert (double (R{end}), 9) - -%!shared a -%! pyexec ("class _myclass(): shape = (3, 4, 5)") -%! a = pyeval ("_myclass()"); -%!assert (size (a), [3 4 5]) -%!assert (size (a, 3), 5) -%!test -%! s = size (a); -%! assert (s, [3 4 5]) -%!test -%! [n m] = size (a); -%! assert ([n m], [3 20]) -%!test -%! [n m o] = size (a); -%! assert ([n m o], [3 4 5]) -%!test -%! [n m o p] = size (a); -%! assert ([n m o p], [3 4 5 1]) -%!assert (numel (a), 1) -%!assert (ndims (a), 3) -%!shared - -## Test conversion of scalar struct into a Python dict -%!shared s1 -%! s1.name = "Octave"; -%! s1.value = 42; -%! s1.counts = {1, 2, 3}; -%! s1.ok = true; -%!assert (isa (pyobject (s1), "pyobject")) -%!assert (class (pyobject (s1)), "py.dict") -%!assert (char (pyobject (s1){"name"}), "Octave") -%!assert (pyobject (s1){"value"}, 42) -%!assert (pyobject (s1){"ok"}, true) - -%!error pyobject (struct ("a", {})) -%!error pyobject (struct ("a", {1, 2})) - -%!assert (char (pyeval ("None")), "None") -%!assert (char (pyeval ("'this is a string'")), "this is a string") -%!assert (char (pyeval ("[1, 2, 3, 4, 5]")), "[1, 2, 3, 4, 5]") -%!assert (char (pyeval ("(1, 2, 3, 4, 5)")), "(1, 2, 3, 4, 5)") -%!assert (char (pyeval ("__import__('sys')")), "<module 'sys' (built-in)>") - -%!assert (isa (pyobject (), "pyobject")) -%!assert (isa (pyobject ("a string"), "pyobject")) -%!assert (isa (pyobject (42.2), "pyobject")) -%!assert (isa (pyobject (int32 (42)), "pyobject")) -%!assert (isa (pyobject (pyobject ()), "pyobject")) - -%!assert (class (pyeval ("{}")), "py.dict") -%!assert (class (pyeval ("[]")), "py.list") -%!assert (class (pyeval ("()")), "py.tuple") -%!assert (class (pyeval ("set()")), "py.set") -%!assert (class (pyeval ("None")), "py.NoneType") -%!assert (class (pyeval ("2.5")), "double") - -## Test conversion method pyobject.double -%!assert (double (pyobject (2.5)), 2.5) -%!assert (double (pyobject (42)), 42) -%!assert (double (pyobject ("42")), 42) -%!assert (double (pyobject (false)), 0) -%!assert (double (pycall ("array.array", "d", {31, 32, 33, 34})), [31, 32, 33, 34]) - -%!error double (pyobject ("this is not a number")) -%!error double (pyobject ()) -%!error double (pyeval ("[1, 2, 3]")) - -## Test class type check method pyobject.isa -%!assert (isa (pyobject (), "handle")) -%!assert (isa (pyobject (), "pyobject")) -%!assert (! isa (pyobject (), "py.None")) -%!assert (isa (pyobject (0), "handle")) -%!assert (isa (pyobject (0), "pyobject")) -%!assert (isa (pyobject (0), "py.float")) -%!assert (isa (pyobject (int32 (0)), "py.int")) -%!assert (isa (pyobject (true), "py.bool")) -%!assert (isa (pyobject ("a string"), "py.str")) -%!assert (isa (pyobject (struct ()), "py.dict")) -%!assert (isa (pyobject (cell ()), "py.tuple")) -%!assert (isa (pyobject ([]), "py.array.array")) -%!assert (isa (pyobject ([1, 2, 3, 4]), "py.array.array")) -%!assert (isa (pyobject ([1; 2; 3; 4]), "py.array.array")) -%!assert (all (isa (pyobject (0), {"pyobject", "py.float", "py.numbers.Number"}))) - -## Test conversion method pyobject.int64 -%!assert (int64 (pyobject (int8 (0))), int64 (0)) -%!assert (int64 (pyobject (int64 (42))), int64 (42)) -%!assert (int64 (pyobject (intmax ("int64"))), intmax ("int64")) -%!assert (int64 (pyobject (intmin ("int64"))), intmin ("int64")) -%!assert (int64 (pycall ("int", 1e100)), intmax ("int64")) -%!assert (int64 (pycall ("int", -1e100)), intmin ("int64")) - -## Test conversion method pyobject.struct -%!assert (struct (pycall ("dict")), struct ()) -%!assert (struct (pyobject (struct ())), struct ()) -%!test -%! a = struct ("a", 1, "b", 2, "three", 3); -%! b = pyobject (a); -%! c = struct (b); -%! assert (c, a) -%!test -%! a = struct ("a", 1, "b", 2, "three", 3); -%! b = pycall ("dict", pyargs ("a", 1, "b", 2, "three", 3)); -%! c = struct (b); -%! assert (c, a) - -%!error struct (pyeval ("{1:2, 3:4}")); -%!error struct (pyobject ("this is not a dict")) -%!error struct (pyobject ({1, 2, 3})) -%!error struct (pyobject ()) - -## Octave fails to resolve function overloads via function handles -%!xtest -%! fn = @double; -%! x = pyobject (int64 (42)); -%! assert (fn (x), double (x)) - -%!error (isequal (pyobject ())) -%!assert (! isequal (pyobject (1.2), 1.2)) -%!assert (isequal (pyobject ("a string"), pyobject ("a string"))) -%!assert (isequal (pyeval ("None"), pyeval ("None"))) -%!assert (! isequal (pyeval ("None"), pyeval ("None"), pyobject (10))) -%!assert (isequal (pyobject (10), pyobject (10.0), pyobject (int8 (10)))) - -%!test -%! A = pyeval ("[1, 2, 3]"); -%! B = pycall ("list", {1, 2, 3}); -%! assert (isequal (A, B))
--- a/@pyobject/subsasgn.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,132 +0,0 @@ -## Copyright (C) 2016 Colin B. Macdonald -## -## This file is part of Pytave. -## -## Pytave 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. -## -## This software 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 this software; see the file COPYING. -## If not, see <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defop Method @@pyobject subsasgn (@var{x}, @var{idx}, @var{rhs}) -## @defopx Operator @@pyobject {@var{x}.@var{property} =} {@var{rhs}} -## @defopx Operator @@pyobject {@var{x}@{@var{i}@} =} {@var{rhs}} -## @defopx Operator @@pyobject {@var{x}@{@var{i}, @var{j}, @dots{}@} =} {@var{rhs}} -## @defopx Operator @@pyobject {@var{x}@{@var{a}@} =} {@var{rhs}} -## Indexed assignment to Python objects. -## -## @seealso{@@pyobject/subsref} -## @end defop - -function r = subsasgn(x, idx, rhs) - - if (nargin != 3) - print_usage (); - endif - - ## If rhs is a pyobject but x is not, dispatch to the builtin subsasgn - if (! isa (x, "pyobject")) - r = builtin ("subsasgn", x, idx, rhs); - return; - endif - - switch idx.type - case "." - assert (ischar (idx.subs)) - pycall ("setattr", x, idx.subs, rhs); - r = x; - - case "{}" - ## XXX: doesn't support slices or anything like that yet - - ## Subtract one from index: do this for lists, numpy arrays, etc - x_is_sequence = any (isa (x, {"py.collections.Sequence", ... - "py.numpy.ndarray"})); - for i = 1:length (idx.subs) - j = idx.subs{i}; - if (x_is_sequence && isindex (j) && isnumeric (j)) - idx.subs{i} = cast (j, class (sizemax ())) - 1; - endif - endfor - - if (isscalar (idx.subs)) - ind = idx.subs{1}; - else - ind = pycall ("tuple", idx.subs); - endif - - pycall ("operator.setitem", x, ind, rhs); - r = x; - - otherwise - idx - rhs - error ("@pyobject/subsasgn: not implemented") - endswitch -endfunction - - -%!test -%! pyexec ("class MyClass: a = 1") -%! t = pyeval ("MyClass()"); -%! t.b = 6; -%! assert (t.b, 6) - -%!test -%! % list indexing -%! L = pyeval ("[10., 20.]"); -%! L{2} = "Octave"; -%! assert (length (L) == 2) -%! assert (L{1}, 10) -%! assert (char (L{2}), "Octave") - -%!test -%! % dict assignment, adding new keys -%! d = pyeval ("dict()"); -%! d{"a"} = 3; -%! d{"b"} = 4; -%! assert (d{"a"}, 3) -%! assert (d{"b"}, 4) - -%!test -%! % dict assignment, update existing key -%! d = pyeval ("{'a':1}"); -%! d{"a"} = 3; -%! assert (d{"a"}, 3) - -%!test -%! % dict assignment, other keys (e.g., Issue #10). -%! d = pyeval ("dict()"); -%! d{"5"} = 10; -%! d{5.5} = 11; -%! d{5} = 12; -%! assert (d{"5"}, 10) -%! assert (d{5.5}, 11) -%! assert (d{5}, 12) - -## Test that depends on implicit creation of NumPy arrays, do we want this? -%!xtest -%! % 2D array indexing -%! A = pyobject ([1.1 2 3; 4 5 6]); -%! A{1, 1} = 10; -%! A{1, 3} = 30; -%! A{2, 1} = 40; -%! assert (A{1, 1}, 10) -%! assert (A{1, 3}, 30) -%! assert (A{2, 1}, 40) -%! assert (A{2, 2}, 5) - -## Test of string key assignment, fails in the general case -%!xtest -%! d = pyobject (struct ()); -%! d{"value"} = 1;
--- a/@pyobject/subsref.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,293 +0,0 @@ -## Copyright (C) 2016 Colin B. Macdonald -## -## This file is part of Pytave -## -## Pytave 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. -## -## This software 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 this software; see the file COPYING. -## If not, see <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @documentencoding UTF-8 -## @defop Method @@pyobject subsref (@var{x}, @var{idx}) -## @defopx Operator @@pyobject {@var{x}.@var{property}} {} -## @defopx Operator @@pyobject {@var{x}.@var{method}(@var{a}, @dots{})} {} -## @defopx Operator @@pyobject {@var{x}@{@var{i}@}} {} -## @defopx Operator @@pyobject {@var{x}@{@var{i}, @var{j}, @dots{}@}} {} -## @defopx Operator @@pyobject {@var{x}(@var{a})} {} -## @defopx Operator @@pyobject {@var{x}(@var{a}, @var{b}, @dots{})} {} -## Call methods and access properties of a Python object. -## -## -## @seealso{@@pyobject/subsasgn} -## @end defop - - -function varargout = subsref (x, idx) - - t = idx(1); - switch (t.type) - case "." - assert (ischar (t.subs)) - r = pycall ("getattr", x, t.subs); - - case "()" - ## Determine the types and protocols that we are able to index into - x_is_callable = __py_isinstance__ (x, "py.collections.Callable"); - x_is_sequence = __py_isinstance__ (x, "py.collections.Sequence") ... - | __py_isinstance__ (x, "py.array.array") ... - | __py_isinstance__ (x, "py.numpy.ndarray"); - - if (! (x_is_callable || x_is_sequence)) - error ("subsref: cannot index Python object, not sequence or callable"); - endif - - if (x_is_sequence) - error ("subsref: slice indexing of Python objects not yet implemented"); - endif - - r = pycall (x, t.subs{:}); - - case "{}" - ## Determine the types and protocols that we are able to index into - x_is_mapping = __py_isinstance__ (x, "py.collections.Mapping"); - x_is_sequence = __py_isinstance__ (x, "py.collections.Sequence") ... - | __py_isinstance__ (x, "py.array.array") ... - | __py_isinstance__ (x, "py.numpy.ndarray"); - - if (! (x_is_mapping || x_is_sequence)) - error ("subsref: cannot index Python object, not sequence or mapping"); - endif - - ## Subtract one from index: do this for lists, arrays, numpy arrays, etc - for i = 1:length (t.subs) - j = t.subs{i}; - if (isindex (j) && isnumeric (j) && x_is_sequence) - t.subs{i} = cast (j, class (sizemax ())) - 1; - endif - endfor - - if (ischar (t.subs{1}) && strcmp (t.subs{1}, ":")) - if (x_is_mapping) - ind = ":"; - else - ind = int32 ([1:length(x)] - 1); - endif - elseif (isscalar (t.subs)) - ind = t.subs{1}; - else - ind = pycall ("tuple", t.subs); - endif - - if (isempty (ind) && x_is_sequence) - r = pyobject (); - elseif (isnumeric (ind) && length (ind) > 1) - r = {}; - for k = 1:length (ind) - r(end+1) = pycall ("operator.getitem", x, ind(k)); - endfor - else - r = pycall ("operator.getitem", x, ind); - endif - - otherwise - t - error ("@pyobject/subsref: not implemented") - endswitch - - ## deal with additional indexing (might be recursive) - if (length (idx) > 1) - r = subsref (r, idx(2:end)); - endif - - ## unpack results, ensure "ans" works (see also pycall) - if (nargout == 0 && ! __py_is_none__ (r)) - varargout{1} = r; - elseif (nargout == 1) - varargout{1} = r; - elseif (nargout >= 2) - assert (length (r) == nargout, ... - "pyobject/subsref: number of outputs must match") - [varargout{1:nargout}] = subsref (r, struct ("type", "{}", "subs", {{1:nargout}})); - endif -endfunction - - -%!test -%! % list indexing -%! L = pyeval ("[10., 20.]"); -%! assert (L{1}, 10) -%! assert (L{2}, 20) - -%!test -%! % list indexing, slice -%! L = pyeval ("[10., 20., [30., 40.]]"); -%! L2 = L{:}; -%! assert (L2{1}, 10) -%! assert (L2{2}, 20) -%! assert (L2{3}{1}, 30) -%! assert (L2{3}{2}, 40) - -%!test -%! % list indexing, nested list -%! L = pyeval ("[1., 2., [10., 11., 12.]]"); -%! assert (L{2}, 2) -%! assert (L{3}{1}, 10) -%! assert (L{3}{3}, 12) - -%!test -%! % list indexing, assign to vars -%! L = pyeval ("[1., 2., 'Octave']"); -%! [a, b, c] = L{:}; -%! assert (a, 1) -%! assert (b, 2) -%! assert (char (c), "Octave") - -## Test that depends on implicit creation of NumPy arrays, do we want this? -%!xtest -%! % 2D array indexing -%! A = pyobject ([1. 2.; 3. 4.]); -%! assert (A{1, 1}, 1) -%! assert (A{2, 1}, 3) -%! assert (A{1, 2}, 2) - -## Test element indexing on array.array types -%!test -%! a = pycall ("array.array", "d", {11, 12, 13, 14}); -%! assert (a{1}, 11) -%! assert (a{2}, 12) -%! assert (a{end}, 14) - -%!test -%! % dict: str key access -%! d = pyeval ("{'one':1., 5:5, 6:6}"); -%! assert (d{"one"}, 1) - -%!test -%! % dict: integer key access -%! d = pyeval ("{5:42., 6:42.}"); -%! assert (d{6}, 42) - -%!test -%! % dict: integer key should not subtract one -%! d = pyeval ("{5:40., 6:42.}"); -%! assert (d{6}, 42) - -%!test -%! % dict: floating point keys should work -%! d = pyeval ("{5.5:'ok'}"); -%! assert (char (d{5.5}), "ok") - -%!test -%! % dict: make sure key ":" doesn't break anything -%! d = pyeval ("{'a':1., ':':2.}"); -%! assert (d{'a'}, 1) -%! assert (d{':'}, 2) - -%!test -%! % method call with args -%! s = pyeval ("set({1, 2})"); -%! s.add (42) -%! assert (length (s) == 3) - -%!test -%! % get a callable -%! s = pyeval ("set({1, 2})"); -%! sa = s.add; -%! assert (isa (sa, "pyobject")) -%! % and then call it -%! sa (42) -%! assert (length (s) == 3) - -%!test -%! % callable can return something -%! s = pyeval ("set({1., 2.})"); -%! v = s.pop (); -%! assert (length (s) == 1) -%! assert (v == 1 || v == 2) - -%!test -%! % chain -%! pyexec ("import sys") -%! s = pyeval ("set({sys})"); -%! ver = s.pop ().version; -%! assert (isa (ver, "pyobject")) -%! assert (ischar (char (ver))) - -%!test -%! % don't set "ans" if no return value -%! s = pyeval ("set({1, 2})"); -%! sa = s.add; -%! clear ans -%! sa (42) -%! assert (! exist ("ans", "var")) - -%!test -%! % *do* set "ans" if return value -%! s = pyeval ("set({1, 2})"); -%! clear ans -%! s.pop (); -%! assert (exist ("ans", "var")) -%! assert (length (s) == 1) - -%!test -%! % multiple return values: can get all of them -%! f = pyeval ("lambda: (1, 2, 3)"); -%! a = f (); -%! assert (length (a) == 3) - -%!test -%! % multiple return values: separate them -%! f = pyeval ("lambda: (1., 2., 3.)"); -%! [a, b, c] = f (); -%! assert (a, 1) -%! assert (b, 2) -%! assert (c, 3) - -%!test -%! % multiple return values: set ans -%! f = pyeval ("lambda: (1, 2, 3)"); -%! f (); -%! assert (length (ans) == 3) - -%!test -%! % ensure None is returned if nargout > 0 -%! L = pyeval ("[1, None, 3]"); -%! a = L{2}; -%! assert (char (a), "None") - -## Test of multi-element indexing, fails to return correct number of output args -%!xtest -%! a = {1, 2, 3, 4, 5, 6}; -%! b = pyobject (a); -%! b{:}; -%! assert (ans, a{end}) - -%!xtest -%! a = {1, 2, 3, 4, 5, 6}; -%! b = pyobject (a); -%! c = {b{:}}; -%! assert (c, a) - -%!error <cannot index Python object> -%! f = pyeval ("abs"); -%! f{1} - -%!error <outputs must match> -%! % multiple return values: too many outputs -%! f = pyeval ("lambda: (1, 2)"); -%! [a, b, c] = f (); - -%!error <outputs must match> -%! % multiple return values: not enough outputs -%! f = pyeval ("lambda: (1, 2, 3)"); -%! [a, b] = f ();
--- a/CONTRIBUTORS.md Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -Contributors -============ - -* Mike Miller -* Colin Macdonald -* Juan Pablo Carbajal -* Abhinav Tripathi -* NVS Abhilash -* Vijay Krishnavanshi - ---- - -Thanks to the authors of the original Pytave project, which served as -the origin and inspiration of this project: - -* David Grundberg -* Håkan Fors Nilsson -* Jaroslav Hájek
--- a/COPYING Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program 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. - - This program 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 this program. If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>.
--- a/Doxyfile Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,2434 +0,0 @@ -# Doxyfile 1.8.9.1 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = Pytave - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = ./doc - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = YES - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = YES - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = YES - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if <section_label> ... \endif and \cond <section_label> -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. -# Note: If this tag is empty the current directory is searched. - -INPUT = . - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf \ - *.as \ - *.js - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = NO - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# <filter> <input-file> -# -# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# compiled with the --with-libclang option. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use <access key> + S -# (what the <access key> is depends on the OS and browser, but it is typically -# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down -# key> to jump into the search results window, the results can be navigated -# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel -# the search. The filter options can be selected when the cursor is inside the -# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> -# to select a filter and <Enter> or <escape> to activate or cancel the filter -# option. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a web server instead of a web client using Javascript. There -# are two flavors of web server based searching depending on the EXTERNAL_SEARCH -# setting. When disabled, doxygen will generate a PHP script for searching and -# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing -# and searching needs to be provided by external tools. See the section -# "External Indexing and Searching" for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SERVER_BASED_SEARCH = NO - -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP -# script for searching. Instead the search results are written to an XML file -# which needs to be processed by an external indexer. Doxygen will invoke an -# external search engine pointed to by the SEARCHENGINE_URL option to obtain the -# search results. -# -# Doxygen ships with an example indexer (doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). -# -# See the section "External Indexing and Searching" for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH = NO - -# The SEARCHENGINE_URL should point to a search engine hosted by a web server -# which will return the search results when EXTERNAL_SEARCH is enabled. -# -# Doxygen ships with an example indexer (doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and -# Searching" for details. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHENGINE_URL = - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed -# search data is written to a file for indexing by an external tool. With the -# SEARCHDATA_FILE tag the name of this file can be specified. -# The default file is: searchdata.xml. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHDATA_FILE = searchdata.xml - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the -# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is -# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple -# projects and redirect the results back to the right project. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH_ID = - -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen -# projects other than the one defined by this configuration file, but that are -# all added to the same external search index. Each project needs to have a -# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of -# to a relative location where the documentation can be found. The format is: -# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTRA_SEARCH_MAPPINGS = - -#--------------------------------------------------------------------------- -# Configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. -# The default value is: YES. - -GENERATE_LATEX = YES - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: latex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. -# -# Note that when enabling USE_PDFLATEX this option is only used for generating -# bitmaps for formulas in the HTML output, but not in the Makefile that is -# written to the output directory. -# The default file is: latex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate -# index for LaTeX. -# The default file is: makeindex. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX -# documents. This may be useful for small projects and may help to save some -# trees in general. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used by the -# printer. -# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x -# 14 inches) and executive (7.25 x 10.5 inches). -# The default value is: a4. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -PAPER_TYPE = a4 - -# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names -# that should be included in the LaTeX output. To get the times font for -# instance you can specify -# EXTRA_PACKAGES=times -# If left blank no extra packages will be included. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the -# generated LaTeX document. The header should contain everything until the first -# chapter. If it is left blank doxygen will generate a standard header. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. -# -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber, -# $projectbrief, $projectlogo. Doxygen will replace $title with the empty -# string, for the replacement values of the other commands the user is referred -# to HTML_HEADER. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_HEADER = - -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the -# generated LaTeX document. The footer should contain everything after the last -# chapter. If it is left blank doxygen will generate a standard footer. See -# LATEX_HEADER for more information on how to generate a default footer and what -# special commands can be used inside the footer. -# -# Note: Only use a user-defined footer if you know what you are doing! -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_FOOTER = - -# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# LaTeX style sheets that are included after the standard style sheets created -# by doxygen. Using this option one can overrule certain style aspects. Doxygen -# will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_EXTRA_STYLESHEET = - -# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the LATEX_OUTPUT output -# directory. Note that the files will be copied as-is; there are no commands or -# markers available. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_EXTRA_FILES = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is -# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will -# contain links (just like the HTML output) instead of page references. This -# makes the output suitable for online browsing using a PDF viewer. -# The default value is: YES. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES, to get a -# higher quality PDF documentation. -# The default value is: YES. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_BATCHMODE = NO - -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the -# index chapters (such as File Index, Compound Index, etc.) in the output. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_HIDE_INDICES = NO - -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_SOURCE_CODE = NO - -# The LATEX_BIB_STYLE tag can be used to specify the style to use for the -# bibliography, e.g. plainnat, or ieeetr. See -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_BIB_STYLE = plain - -#--------------------------------------------------------------------------- -# Configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The -# RTF output is optimized for Word 97 and may not look too pretty with other RTF -# readers/editors. -# The default value is: NO. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: rtf. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF -# documents. This may be useful for small projects and may help to save some -# trees in general. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will -# contain hyperlink fields. The RTF file will contain links (just like the HTML -# output) instead of page references. This makes the output suitable for online -# browsing using Word or some other Word compatible readers that support those -# fields. -# -# Note: WordPad (write) and others do not support links. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's config -# file, i.e. a series of assignments. You only have to provide replacements, -# missing definitions are set to their default value. -# -# See also section "Doxygen usage" for information on how to generate the -# default style sheet that doxygen normally uses. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's config file. A template extensions file can be generated -# using doxygen -e rtf extensionFile. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_EXTENSIONS_FILE = - -# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code -# with syntax highlighting in the RTF output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_SOURCE_CODE = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for -# classes and files. -# The default value is: NO. - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. A directory man3 will be created inside the directory specified by -# MAN_OUTPUT. -# The default directory is: man. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to the generated -# man pages. In case the manual section does not start with a number, the number -# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is -# optional. -# The default value is: .3. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_EXTENSION = .3 - -# The MAN_SUBDIR tag determines the name of the directory created within -# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by -# MAN_EXTENSION with the initial . removed. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_SUBDIR = - -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it -# will generate one additional man file for each entity documented in the real -# man page(s). These additional files only source the real man page, but without -# them the man command would be unable to find the correct page. -# The default value is: NO. -# This tag requires that the tag GENERATE_MAN is set to YES. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that -# captures the structure of the code including all documentation. -# The default value is: NO. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: xml. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_OUTPUT = xml - -# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program -# listings (including syntax highlighting and cross-referencing information) to -# the XML output. Note that enabling this will significantly increase the size -# of the XML output. -# The default value is: YES. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the DOCBOOK output -#--------------------------------------------------------------------------- - -# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files -# that can be used to generate PDF. -# The default value is: NO. - -GENERATE_DOCBOOK = NO - -# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in -# front of it. -# The default directory is: docbook. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_OUTPUT = docbook - -# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the -# program listings (including syntax highlighting and cross-referencing -# information) to the DOCBOOK output. Note that enabling this will significantly -# increase the size of the DOCBOOK output. -# The default value is: NO. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_PROGRAMLISTING = NO - -#--------------------------------------------------------------------------- -# Configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sf.net) file that captures the -# structure of the code including all documentation. Note that this feature is -# still experimental and incomplete at the moment. -# The default value is: NO. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module -# file that captures the structure of the code including all documentation. -# -# Note that this feature is still experimental and incomplete at the moment. -# The default value is: NO. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary -# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI -# output from the Perl module output. -# The default value is: NO. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely -# formatted so it can be parsed by a human reader. This is useful if you want to -# understand what is going on. On the other hand, if this tag is set to NO, the -# size of the Perl module output will be much smaller and Perl will parse it -# just the same. -# The default value is: YES. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file are -# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful -# so different doxyrules.make files included by the same Makefile don't -# overwrite each other's variables. -# This tag requires that the tag GENERATE_PERLMOD is set to YES. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all -# C-preprocessor directives found in the sources and include files. -# The default value is: YES. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names -# in the source code. If set to NO, only conditional compilation will be -# performed. Macro expansion can be done in a controlled way by setting -# EXPAND_ONLY_PREDEF to YES. -# The default value is: NO. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -MACRO_EXPANSION = NO - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then -# the macro expansion is limited to the macros specified with the PREDEFINED and -# EXPAND_AS_DEFINED tags. -# The default value is: NO. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES, the include files in the -# INCLUDE_PATH will be searched if a #include is found. -# The default value is: YES. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by the -# preprocessor. -# This tag requires that the tag SEARCH_INCLUDES is set to YES. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will be -# used. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that are -# defined before the preprocessor is started (similar to the -D option of e.g. -# gcc). The argument of the tag is a list of macros of the form: name or -# name=definition (no spaces). If the definition and the "=" are omitted, "=1" -# is assumed. To prevent a macro definition from being undefined via #undef or -# recursively expanded use the := operator instead of the = operator. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -PREDEFINED = - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this -# tag can be used to specify a list of macro names that should be expanded. The -# macro definition that is found in the sources will be used. Use the PREDEFINED -# tag if you want to use a different macro definition that overrules the -# definition found in the source code. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will -# remove all references to function-like macros that are alone on a line, have -# an all uppercase name, and do not end with a semicolon. Such function macros -# are typically used for boiler-plate code, and will confuse the parser if not -# removed. -# The default value is: YES. -# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES tag can be used to specify one or more tag files. For each tag -# file the location of the external documentation should be added. The format of -# a tag file without this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where loc1 and loc2 can be relative or absolute paths or URLs. See the -# section "Linking to external documentation" for more information about the use -# of tag files. -# Note: Each tag file must have a unique name (where the name does NOT include -# the path). If a tag file is not located in the directory in which doxygen is -# run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a -# tag file that is based on the input files it reads. See section "Linking to -# external documentation" for more information about the usage of tag files. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES, all external class will be listed in -# the class index. If set to NO, only the inherited external classes will be -# listed. -# The default value is: NO. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will be -# listed. -# The default value is: YES. - -EXTERNAL_GROUPS = YES - -# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in -# the related pages index. If set to NO, only the current project's pages will -# be listed. -# The default value is: YES. - -EXTERNAL_PAGES = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = YES - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - -# If set to YES the inheritance and collaboration graphs will hide inheritance -# and usage relations if the target is undocumented or is not a class. -# The default value is: YES. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent -# Bell Labs. The other options in this section have no effect if this option is -# set to NO -# The default value is: YES. - -HAVE_DOT = YES - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed -# to run in parallel. When set to 0 doxygen will base this on the number of -# processors available in the system. You can set it explicitly to a value -# larger than 0 to get control over the balance between CPU load and processing -# speed. -# Minimum value: 0, maximum value: 32, default value: 0. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_NUM_THREADS = 0 - -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTPATH = - -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a -# graph for each documented class showing the direct and indirect implementation -# dependencies (inheritance, containment, and class references variables) of the -# class with other documented classes. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -UML_LOOK = NO - -# If the UML_LOOK tag is enabled, the fields and methods are shown inside the -# class node. If there are many fields or methods and many nodes the graph may -# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the -# number of items for each type to make the size more manageable. Set this to 0 -# for no limit. Note that the threshold may be exceeded by 50% before the limit -# is enforced. So when you set the threshold to 10, up to 15 fields may appear, -# but if the number exceeds 15, the total amount of fields shown is limited to -# 10. -# Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -UML_LIMIT_NUM_FIELDS = 10 - -# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and -# collaboration graphs will show the relations between templates and their -# instances. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -TEMPLATE_RELATIONS = NO - -# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to -# YES then doxygen will generate a graph for each documented file showing the -# direct and indirect include dependencies of the file with other documented -# files. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -INCLUDE_GRAPH = YES - -# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are -# set to YES then doxygen will generate a graph for each documented file showing -# the direct and indirect include dependencies of the file with other documented -# files. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call -# dependency graph for every global function or class method. -# -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -CALL_GRAPH = NO - -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller -# dependency graph for every global function or class method. -# -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -CALLER_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical -# hierarchy of all classes instead of a textual one. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the -# dependencies a directory has on other directories in a graphical way. The -# dependency relations are determined by the #include relations between the -# files in the directories. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. -# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order -# to make the SVG files visible in IE 9+ (other browsers do not have this -# requirement). -# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, -# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, -# gif:cairo:gd, gif:gd, gif:gd:gd and svg. -# The default value is: png. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_IMAGE_FORMAT = png - -# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to -# enable generation of interactive SVG images that allow zooming and panning. -# -# Note that this requires a modern browser other than Internet Explorer. Tested -# and working are Firefox, Chrome, Safari, and Opera. -# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make -# the SVG files visible. Older versions of IE do not have SVG support. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -INTERACTIVE_SVG = NO - -# The DOT_PATH tag can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the \dotfile -# command). -# This tag requires that the tag HAVE_DOT is set to YES. - -DOTFILE_DIRS = - -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the \mscfile -# command). - -MSCFILE_DIRS = - -# The DIAFILE_DIRS tag can be used to specify one or more directories that -# contain dia files that are included in the documentation (see the \diafile -# command). - -DIAFILE_DIRS = - -# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the -# path where java can find the plantuml.jar file. If left blank, it is assumed -# PlantUML is not used or called during a preprocessing step. Doxygen will -# generate a warning when it encounters a \startuml command in this case and -# will not generate output for the diagram. - -PLANTUML_JAR_PATH = - -# When using plantuml, the specified paths are searched for files specified by -# the !include statement in a plantuml block. - -PLANTUML_INCLUDE_PATH = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes -# that will be shown in the graph. If the number of nodes in a graph becomes -# larger than this value, doxygen will truncate the graph, which is visualized -# by representing a node as a red box. Note that doxygen if the number of direct -# children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that -# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. -# Minimum value: 0, maximum value: 10000, default value: 50. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs -# generated by dot. A depth value of 3 means that only nodes reachable from the -# root by following a path via at most 3 edges will be shown. Nodes that lay -# further from the root node will be omitted. Note that setting this option to 1 -# or 2 may greatly reduce the computation time needed for large code bases. Also -# note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. -# Minimum value: 0, maximum value: 1000, default value: 0. -# This tag requires that the tag HAVE_DOT is set to YES. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) support -# this, this feature is disabled by default. -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page -# explaining the meaning of the various boxes and arrows in the dot generated -# graphs. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot -# files that are used to generate the various graphs. -# The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_CLEANUP = YES
--- a/Makefile.am Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,142 +0,0 @@ -# Makefile for Pytave -# -# Copyright (C) 2015-2016 Mike Miller -# Copyright (C) 2008 David Grundberg, Håkan Fors Nilsson -# Copyright (C) 2009 Jaroslav Hajek, VZLU Prague -# -# This file is part of Pytave. -# -# Pytave 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. -# -# Pytave 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 Pytave; see the file COPYING. If not, see -# <http://www.gnu.org/licenses/>. - -ACLOCAL_AMFLAGS = -I m4 - -AM_CPPFLAGS = $(OCTAVE_CPPFLAGS) $(PYTHON_CPPFLAGS) -AM_CXXFLAGS = -W -Wall - -INCFLAGS = $(DEFAULT_INCLUDES) -export INCFLAGS - -COMMON_SOURCE_FILES = \ - oct-py-error.cc \ - oct-py-eval.cc \ - oct-py-init.cc \ - oct-py-types.cc \ - oct-py-util.cc - -DOC_FILES = \ - CONTRIBUTORS.md \ - README.md - -M_FILES = \ - @py/py.m \ - @py/subsref.m \ - @pyobject/cell.m \ - @pyobject/char.m \ - @pyobject/display.m \ - @pyobject/dummy.m \ - @pyobject/fieldnames.m \ - @pyobject/methods.m \ - @pyobject/pyobject.m \ - @pyobject/subsasgn.m \ - @pyobject/subsref.m \ - __py_tests__.m \ - pyargs.m \ - pyversion.m - -OCT_FILES = \ - __py_struct_from_dict__.oct \ - pycall.oct \ - pyeval.oct \ - pyexec.oct - -OCT_SOURCE_FILES = $(patsubst %.oct, %.cc, $(OCT_FILES)) - -PYTAVE_HEADER_FILES = \ - config.h \ - oct-py-error.h \ - oct-py-eval.h \ - oct-py-init.h \ - oct-py-object.h \ - oct-py-types.h \ - oct-py-util.h - -TST_FILES = $(addsuffix -tst,$(OCT_SOURCE_FILES)) - -EXTRA_DIST = $(DOC_FILES) $(M_FILES) $(OCT_SOURCE_FILES) - -noinst_LTLIBRARIES = liboctpython.la -liboctpython_la_CPPFLAGS = $(AM_CPPFLAGS) -liboctpython_la_SOURCES = $(COMMON_SOURCE_FILES) $(PYTAVE_HEADER_FILES) - -CLEANFILES = *.oct *-tst PKG_ADD PKG_DEL fntests.log -SUFFIXES = .oct - -AM_V_MKOCTFILE = $(am__v_MKOCTFILE_$(V)) -am__v_MKOCTFILE_ = $(am__v_MKOCTFILE_$(AM_DEFAULT_VERBOSITY)) -am__v_MKOCTFILE_0 = @echo " MKOCTFIL" $@; -am__v_MKOCTFILE_1 = - -OCT_LIBS = liboctpython.la $(PYTHON_LIBS) -OCT_LINK = $(LIBTOOL) $(AM_V_lt) --tag=CXX $(AM_LIBTOOLFLAGS) $(LIBTOOLFLAGS) \ - --mode=link $(MKOCTFILE) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) \ - $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CXXFLAGS) $(CXXFLAGS) $(LDFLAGS) -o $@ - -%.oct: %.cc liboctpython.la $(PYTAVE_HEADER_FILES) - $(AM_V_MKOCTFILE)$(OCT_LINK) $< $(OCT_LIBS) - -%.cc-tst: %.cc - $(AM_V_GEN)rm -f $@-t $@ && \ - ( echo "## DO NOT EDIT! Generated automatically from $(<F) by Make."; \ - $(GREP) '^%!' $< \ - ) > $@-t && \ - mv $@-t $@ - -PKG_ADD: $(OCT_SOURCE_FILES) - $(AM_V_GEN)for f in $(OCT_SOURCE_FILES); do \ - b=$${f%.cc}; \ - if test -f $$f; then d=.; else d=$(srcdir); fi; \ - funcs=`$(SED) -n 's/^DEFUN.*(\(\w\+\),.*/\1/p' $$d/$$f | grep -v $$b`; \ - if test -n "$$funcs"; then \ - echo "$$funcs" | $(SED) "s/.*/autoload (\"&\", \"$$b.oct\");/" > $@-t && \ - mv $@-t $@ || exit $?; \ - fi; \ - done - -PKG_DEL: $(OCT_SOURCE_FILES) - $(AM_V_GEN)for f in $(OCT_SOURCE_FILES); do \ - b=$${f%.cc}; \ - if test -f $$f; then d=.; else d=$(srcdir); fi; \ - funcs=`$(SED) -n 's/^DEFUN.*(\(\w\+\),.*/\1/p' $$d/$$f | grep -v $$b`; \ - if test -n "$$funcs"; then \ - echo "$$funcs" | $(SED) "s/.*/autoload (\"&\", which (\"&\"), \"remove\");/" > $@-t && \ - mv $@-t $@ || exit $?; \ - fi; \ - done - -all-local: $(OCT_FILES) PKG_ADD PKG_DEL - @echo "" - @echo "Pytave successfully built. Now choose from the following:" - @echo "" - @echo " * run the test suite" - @echo " make check" - @echo "" - @echo " * run an Octave session with py* functions" - @echo " octave --path=\"\$$(pwd)\"" - @echo "" - -check-local: $(M_FILES) $(TST_FILES) - $(OCTAVE) --no-gui-libs --no-history --no-window-system --norc \ - --path="$(abs_builddir)" --path="$(abs_srcdir)" \ - $(srcdir)/__py_tests__.m $(M_FILES) $(TST_FILES)
--- a/README.md Thu Feb 22 15:55:15 2018 -0800 +++ b/README.md Fri Oct 25 13:53:09 2019 -0700 @@ -1,84 +1,10 @@ Octave Python Interface ======================= -This project is for development of a native Python calling interface for -[GNU Octave](http://www.octave.org). - -Goals ------ - -The goals of this extension include - -* call any loadable Python modules, classes, and functions -* automatic translation of certain Octave data types into Python - arguments -* hold reference to and performing operations on any Python data type as - Octave variables -* automatic translation of certain Python data types into Octave return - values -* be as compatible as possible with Matlab's own Python calling - interface - -Examples --------- - -A few examples are listed here to give a brief introduction to how the -Python runtime is translated to Octave. - -Add a directory to the Python module search path - - py.sys.path.insert (int32 (0), "/path/to/module"); - -Use a vectorized NumPy function - - x = py.numpy.sqrt (1:10); - -Call a function with keyword arguments - - a = py.int ("5ba0", pyargs ("base", int32 (16))); - -Read an entire text file into a string - - s = py.str ().join (py.open ("/etc/passwd").readlines ()); +Development on the Python language interface continues in the Pythonic package! -Installation ------------- - -There is currently no support for installing this project as an Octave -package or in a system or user directory for regular use. This is -intentional, since the project is still being developed and is not -stable enough for actual use yet. - -What is supported is building and running the project from the build -directory. Building requires Octave and Python development libraries and -GNU autotools. - -1. `hg clone https://bitbucket.org/mtmiller/pytave` -2. `cd pytave` -3. `autoreconf -i` -4. `./configure` -5. `make` -6. Run Octave with the build directory added to the load path +This repository has been converted and moved, the current development +repository can be found at https://gitlab.com/mtmiller/octave-pythonic -Development ------------ - -We welcome all contributors, bug reports, test results, and ideas for -improvement. Contributions in any of the following forms, in no -particular order, are needed and appreciated. - -* Testing on different operating systems and in different environments -* Testing for full functionality with a variety of Python libraries -* Bug reports detailing problems encountered or unexpected behavior -* Code contributions -* Documentation in the form of examples, improvements to help texts, or - some sort of user manual - -Other Resources ---------------- - -Please discuss or ask questions about this project on the Octave -[maintainers mailing list](https://lists.gnu.org/mailman/listinfo/octave-maintainers). - -The [wiki page](http://wiki.octave.org/Python_interface) contains more -examples and ideas about the project. +* https://gitlab.com/mtmiller/octave-pythonic +* https://wiki.octave.org/Pythonic
--- a/__py_struct_from_dict__.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,344 +0,0 @@ -/* - -Copyright (C) 2016 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> -#include <octave/oct.h> - -#include "oct-py-init.h" -#include "oct-py-object.h" -#include "oct-py-types.h" -#include "oct-py-util.h" - -DEFUN_DLD (__py_class_name__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_class_name__ (@var{obj})\n\ -Return the name of the class of the Python object @var{obj}.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - if (args.length () != 1) - print_usage (); - - if (! (args(0).is_object () && args(0).class_name () == "pyobject")) - error ("__py_class_name__: argument must be a valid Python object"); - - pytave::py_init (); - - pytave::python_object obj = pytave::pyobject_unwrap_object (args(0)); - std::string name = pytave::py_object_class_name (obj); - - return ovl (name); -} - -/* -%!assert (__py_class_name__ (pyeval ("None")), "NoneType") -%!assert (__py_class_name__ (pyeval ("'Octave'")), "str") -%!assert (__py_class_name__ (pyeval ("{}")), "dict") -%!assert (__py_class_name__ (pyeval ("[]")), "list") -%!assert (__py_class_name__ (pyeval ("()")), "tuple") -%!assert (__py_class_name__ (pyeval ("__import__('array').array('d')")), "array.array") - -%% Test an anonymous class with its __module__ property set to None -%!assert (__py_class_name__ (pyeval ("[[t() for t.__module__ in (None,)][0] for t in (type('foo', (), {}),)][0]")), "foo") - -%!error __py_class_name__ () -%!error __py_class_name__ (1) -%!error __py_class_name__ (1, 2) -*/ - -DEFUN_DLD (__py_int64_scalar_value__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_int64_scalar_value__ (@var{x})\n\ -Extract a scalar int64 value from the Python integer @var{x}.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - if (args.length () != 1) - print_usage (); - - if (! (args(0).is_object () && args(0).class_name () == "pyobject")) - error ("pyobject.int64: argument must be a Python object"); - - pytave::py_init (); - - pytave::python_object obj = pytave::pyobject_unwrap_object (args(0)); - octave_int64 retval = pytave::extract_py_int64 (obj); - - return ovl (retval); -} - -/* -%!assert (__py_int64_scalar_value__ (pyobject (pyeval ("0"))), int64 (0)) -%!assert (__py_int64_scalar_value__ (pyobject (pyeval ("2**62"))), int64 (2^62)) -%!assert (__py_int64_scalar_value__ (pyobject (pyeval ("-2**62"))), int64 (-2^62)) -%!assert (__py_int64_scalar_value__ (pyobject (pyeval ("2**128"))), intmax ("int64")) -%!assert (__py_int64_scalar_value__ (pyobject (pyeval ("-2**128"))), intmin ("int64")) - -%!error __py_int64_scalar_value__ () -%!error __py_int64_scalar_value__ (1) -%!error __py_int64_scalar_value__ (pyeval ("None")) -%!error __py_int64_scalar_value__ (1, 2) -*/ - -DEFUN_DLD (__py_uint64_scalar_value__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_uint64_scalar_value__ (@var{x})\n\ -Extract a scalar uint64 value from the Python integer @var{x}.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - if (args.length () != 1) - print_usage (); - - if (! (args(0).is_object () && args(0).class_name () == "pyobject")) - error ("pyobject.uint64: argument must be a Python object"); - - pytave::py_init (); - - pytave::python_object obj = pytave::pyobject_unwrap_object (args(0)); - octave_uint64 retval = pytave::extract_py_uint64 (obj); - - return ovl (retval); -} - -/* -%!assert (__py_uint64_scalar_value__ (pyobject (pyeval ("0"))), uint64 (0)) -%!assert (__py_uint64_scalar_value__ (pyobject (pyeval ("2**62"))), uint64 (2^62)) -%!assert (__py_uint64_scalar_value__ (pyobject (pyeval ("2**128"))), intmax ("uint64")) -%!assert (__py_uint64_scalar_value__ (pyobject (pyeval ("-2**128"))), intmin ("uint64")) - -%!error __py_uint64_scalar_value__ () -%!error __py_uint64_scalar_value__ (1) -%!error __py_uint64_scalar_value__ (pyeval ("None")) -%!error __py_uint64_scalar_value__ (1, 2) -*/ - -DEFUN_DLD (__py_is_none__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_is_none__ (@var{x})\n\ -Check whether the Python object @var{obj} is the @code{None} object.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - if (args.length () != 1) - print_usage (); - - pytave::py_init (); - - pytave::python_object obj = pytave::pyobject_unwrap_object (args(0)); - - return ovl (obj.is_none ()); -} - -/* -%!assert (__py_is_none__ (pyobject ())) -%!assert (__py_is_none__ (pyeval ("None"))) -%!assert (! __py_is_none__ (1)) -%!assert (! __py_is_none__ ("None")) -%!assert (! __py_is_none__ (pyobject (1))) -%!assert (! __py_is_none__ (pyobject ("None"))) - -%!error __py_is_none__ () -%!error __py_is_none__ (1, 2) -*/ - -DEFUN_DLD (__py_isinstance__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_isinstance__ (@var{x})\n\ -Check whether the Python object @var{obj} is an instance of a Python type\n\ -specified by the string @var{type}.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - octave_value_list retval; - - int nargin = args.length (); - if (nargin != 2) - { - print_usage (); - return retval; - } - - if (! (args(0).is_object () && args(0).class_name () == "pyobject")) - error ("pyobject.isa: OBJ must be a Python object"); - - if (! args(1).is_string ()) - error ("pyobject.isa: TYPE must be a string naming a Python type (py.*)"); - - std::string typestr = args(1).string_value (); - if (! ((typestr.size () > 3) && (typestr.compare (0, 3, "py.") == 0))) - error ("pyobject.isa: TYPE must be a string naming a Python type (py.*)"); - - typestr = typestr.substr (3); - - pytave::py_init (); - - pytave::python_object obj = pytave::pyobject_unwrap_object (args(0)); - retval(0) = pytave::py_isinstance (obj, typestr); - - return retval; -} - -DEFUN_DLD (__py_objstore_del__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_objstore_del__ (@var{key})\n\ -Delete the Python object stored under @var{key} from the object store.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - if (args.length () != 1) - print_usage (); - - pytave::py_init (); - - uint64_t key = args(0).xuint64_scalar_value ("__py_objstore_del__: KEY must be an integer"); - pytave::py_objstore_del (key); - - return ovl (); -} - -DEFUN_DLD (__py_objstore_get__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_objstore_get__ (@var{key})\n\ -Get the Python object stored under @var{key} from the object store.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - if (args.length () != 1) - print_usage (); - - pytave::py_init (); - - uint64_t key = args(0).xuint64_scalar_value ("__py_objstore_get__: KEY must be an integer"); - PyObject *obj = pytave::py_objstore_get (key); - - if (! obj) - error ("__py_objstore_get__: no existing Python object found for key %ju", key); - - octave_value retval = pytave::pyobject_wrap_object (obj); - - return ovl (retval); -} - -DEFUN_DLD (__py_objstore_put__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_objstore_put__ (@var{value})\n\ -Convert @var{value} to a Python value and store in the object store.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - if (args.length () != 1) - print_usage (); - - pytave::py_init (); - - pytave::python_object obj = pytave::py_implicitly_convert_argument (args(0)); - - if (! obj) - error ("__py_objstore_put__: VALUE must be convertible to a Python value"); - - uint64_t key = pytave::py_objstore_put (obj.release ()); - - return ovl (octave_uint64 (key)); -} - -DEFUN_DLD (__py_string_value__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_string_value__ (@var{obj})\n\ -Return the string value or representation of the Python object @var{obj}.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - if (args.length () != 1) - print_usage (); - - if (! (args(0).is_object () && args(0).class_name () == "pyobject")) - error ("pyobject.char: argument must be a valid Python object"); - - pytave::py_init (); - - pytave::python_object obj = pytave::pyobject_unwrap_object (args(0)); - if (! obj) - error ("pyobject.char: argument must be a valid Python object"); - - std::string str; - - if (PyBytes_Check (obj) || PyUnicode_Check (obj)) - str = pytave::extract_py_str (obj); - else if (Py_TYPE (obj)->tp_str != nullptr) - { - pytave::python_object s = PyObject_Str (obj); - str = pytave::extract_py_str (s); - } - else - error ("pyobject.char: cannot convert Python object to string"); - - return ovl (str); -} - -DEFUN_DLD (__py_struct_from_dict__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __py_struct_from_dict__ (@var{dict})\n\ -Extract a scalar struct from the Python dict @var{dict}.\n\ -\n\ -This is a private internal function not intended for direct use.\n\ -@end deftypefn") -{ - octave_value_list retval; - std::string id; - - int nargin = args.length (); - - if (nargin != 1) - { - print_usage (); - return retval; - } - - if (! (args(0).is_object () && args(0).class_name () == "pyobject")) - error ("pyobject.struct: argument must be a Python object"); - - pytave::py_init (); - - pytave::python_object obj = pytave::pyobject_unwrap_object (args(0)); - retval(0) = pytave::extract_py_scalar_map (obj); - - return retval; -} - -/* -## No test needed for internal helper function. -%!assert (1) -*/
--- a/__py_tests__.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,173 +0,0 @@ -## Copyright (C) 2017 Mike Miller -## Copyright (C) 2005-2017 David Bateman -## -## This file is part of Pytave. -## -## Pytave 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. -## -## Pytave 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 Pytave; see the file COPYING. If not, see -## <http://www.gnu.org/licenses/>. - -## This is a script file, derived from Octave's __run_test_suite__.m -true; - -function retval = __run_py_tests__ (varargin) - - files_with_no_tests = {}; - files_with_tests = {}; - - pso = page_screen_output (); - orig_wstate = warning (); - - logfile = make_absolute_filename ("fntests.log"); - unwind_protect - page_screen_output (false); - warning ("off", "Octave:data-file-in-path"); - try - fid = fopen (logfile, "wt"); - if (fid < 0) - error ("__run_test_suite__: could not open %s for writing", logfile); - endif - test ("", "explain", fid); - dp = dn = dxf = dsk = drtsk = 0; - puts ("\nIntegrated test scripts:\n\n"); - for i = 1:length (varargin) - f = varargin{i}; - if (has_tests (f)) - print_test_file_name (f); - if (nargout ("test") < 5) - rtsk = 0; - [p, n, xf, sk] = test (f, "quiet", fid); - else - [p, n, xf, sk, rtsk] = test (f, "quiet", fid); - endif - print_pass_fail (p, n, xf, sk, rtsk); - dp += p; - dn += n; - dxf += xf; - dsk += sk; - drtsk += rtsk; - files_with_tests(end+1) = f; - else - ## To reduce the list length, only mark .cc files that contain - ## DEFUN definitions. - files_with_no_tests(end+1) = f; - endif - endfor - - puts ("\nSummary:\n\n"); - nfail = dn - dp - dxf; - printf (" PASS %6d\n", dp); - printf (" FAIL %6d\n", nfail); - if (dxf > 0) - printf (" XFAIL %6d\n", dxf); - endif - if (dsk > 0) - printf (" SKIPPED (feature) %6d\n", dsk); - endif - if (drtsk > 0) - printf (" SKIPPED (run-time condition) %6d\n", drtsk); - endif - puts ("\n"); - printf ("See the file %s for additional details.\n", logfile); - if (dxf > 0) - puts ("\n"); - puts ("Items listed as XFAIL above are known bugs.\n"); - puts ("Bug report numbers for them may be found in the log file:\n"); - puts (logfile); - puts ("\nPlease help improve Pytave by contributing fixes for them.\n"); - endif - if (dsk > 0 || drtsk > 0) - puts ("\n"); - puts ("Tests are most often skipped because the features they require\n"); - puts ("have been disabled. Features are most often disabled because\n"); - puts ("they require dependencies that were not present when Octave or\n"); - puts ("Pytave was built.\n"); - endif - - report_files_with_no_tests (files_with_tests, files_with_no_tests, ".m"); - - puts ("\nPlease help improve Pytave by contributing tests for these files\n"); - printf ("(see the list in the file %s).\n\n", logfile); - - fprintf (fid, "\nFiles with no tests:\n\n%s", - list_in_columns (files_with_no_tests, 80)); - fclose (fid); - catch - disp (lasterr ()); - end_try_catch - unwind_protect_cleanup - warning ("off", "all"); - warning (orig_wstate); - page_screen_output (pso); - end_unwind_protect - retval = (nfail != 0); -endfunction - -function print_test_file_name (nm) - filler = repmat (".", 1, 60-length (nm)); - printf (" %s %s", nm, filler); -endfunction - -function print_pass_fail (p, n, xf, sk, rtsk) - - if ((n + sk + rtsk) > 0) - printf (" PASS %4d/%-4d", p, n); - nfail = n - p - xf; - if (nfail > 0) - printf ("\n%71s %3d", "FAIL ", nfail); - endif - if (sk > 0) - printf ("\n%71s %3d", "(missing feature) SKIP ", sk); - endif - if (rtsk > 0) - printf ("\n%71s %3d", "(run-time condition) SKIP ", rtsk); - endif - if (xf > 0) - printf ("\n%71s %3d", "XFAIL", xf); - endif - endif - puts ("\n"); - -endfunction - -function retval = has_tests (f) - - fid = fopen (f); - if (fid < 0) - error ("__run_test_suite__: fopen failed: %s", f); - endif - - str = fread (fid, "*char")'; - fclose (fid); - retval = ! isempty (regexp (str, - '^%!(assert|error|fail|test|xtest|warning)', - 'lineanchors', 'once')); - -endfunction - -function n = num_elts_matching_pattern (lst, pat) - n = sum (! cellfun ("isempty", regexp (lst, pat, 'once'))); -endfunction - -function report_files_with_no_tests (with, without, typ) - pat = ['\' typ "$"]; - n_with = num_elts_matching_pattern (with, pat); - n_without = num_elts_matching_pattern (without, pat); - n_tot = n_with + n_without; - printf ("\n%d (of %d) %s files have no tests.\n", n_without, n_tot, typ); -endfunction - -exit (__run_py_tests__ (argv (){:})); - -## Mark this file as fully tested. -%!assert (1)
--- a/bitbucket-pipelines.yml Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -image: mtmiller/octave-snapshot - -pipelines: - default: - - step: - script: - - apt-get update - - apt-get install -y python-dev python3-dev - - apt-get install -y python-numpy python3-numpy - - autoreconf -i - - mkdir -p py2 py3 - - ( cd py2 && ../configure PYTHON_VERSION=2 ) - - make -C py2 all - - make -C py2 check - - ( cd py3 && ../configure PYTHON_VERSION=3 ) - - make -C py3 all - - make -C py3 check
--- a/configure.ac Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,67 +0,0 @@ -dnl Process this file with autoconf to produce a configure script. -dnl -dnl Copyright (C) 2015-2017 Mike Miller -### -### This file is part of Pytave. -### -### Pytave 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. -### -### Pytave 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 Pytave; see the file COPYING. If not, see -### <http://www.gnu.org/licenses/>. - -AC_PREREQ(2.61) -AC_INIT(pytave, dev, [[https://bitbucket.org/mtmiller/pytave/issues]]) - -AC_CONFIG_AUX_DIR([build-aux]) -AC_CONFIG_FILES([Makefile]) -AC_CONFIG_HEADER([config.h]) -AC_CONFIG_MACRO_DIR([m4]) -AC_CONFIG_SRCDIR([oct-py-eval.cc]) - -AM_INIT_AUTOMAKE([foreign -Wno-portability]) - -AC_USE_SYSTEM_EXTENSIONS - -LT_INIT - -AC_PROG_CXX - -AC_LANG(C++) - -### Check for Octave library and mkoctfile - -AX_OCTAVE([OCTAVE_CONFIG], [], - [AC_MSG_FAILURE([unable to find Octave development files])]) - -### Check for Python library and interpreter - -AX_PYTHON_DEVEL -for opt in $PYTHON_LIBS; do - case "$opt" in #( - -L/usr*) : ;; #( - -L*) PYTHON_LIBS="-R${opt#-L} $PYTHON_LIBS" ;; #( - *) : ;; - esac -done - -AC_OUTPUT - -AC_MSG_NOTICE([ - -Pytave is now configured for the following - - Octave header files: $OCTAVE_INCLUDEDIR - Octave libraries: $OCTAVE_LIBRARYDIR - Python header files: $PYTHON_CPPFLAGS - Python library: $PYTHON_LIBS - Python executable: $PYTHON -])
--- a/m4/ax_octave.m4 Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,235 +0,0 @@ -# =========================================================================== -# -# =========================================================================== -# -# SYNOPSIS -# -# AX_OCTAVE([OCTAVE_CONFIG], [ACTION_IF_FOUND], [ACTION_IF_NOT_FOUND]) -# -# DESCRIPTION -# -# This macro does a Octave development environment check. -# -# It accepts one optional argument, OCTAVE_CONFIG. This is the full -# path the the octave-config used to find out the environment. -# -# If OCTAVE_CONFIG is not set, or empty, a octave-config executable -# is searched for using AC_PATH_TOOL. If the executable is not -# found, or does not return results, the Octave interpreter will be -# used instead. -# -# As a final check, a simple test program is compiled and linked -# against the found Octave installation. If the check is -# successful, ACTION_IF_FOUND is executed, otherwise -# ACTION_IF_NOT_FOUND. -# -# AX_OCTAVE substitutes OCTAVE_CPPFLAGS, OCTAVE_LDFLAGS and -# OCTAVE_LIBS, along with the optional OCTAVE_LIBRARYDIR and -# OCTAVE_INCLUDEDIR. -# -# Typical usage: -# -# AX_OCTAVE([], [], [ -# AC_MSG_ERROR([[Octave required but not available]]) -# ]) -# LIBS="$LIBS $OCTAVE_LIBS" -# CPPFLAGS="$CPPFLAGS $OCTAVE_CPPFLAGS" -# LDFLAGS="$LDFLAGS $OCTAVE_LDFLAGS" -# -# LAST MODIFICATION -# -# 2009-05-04 -# -# COPYING -# -# Copyright (c) 2009 David Grundberg -# -# This program 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 2 of the License, or (at your -# option) any later version. -# -# This program 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 this program. If not, see <http://www.gnu.org/licenses/>. -# -# As a special exception, the respective Autoconf Macro's copyright owner -# gives unlimited permission to copy, distribute and modify the configure -# scripts that are the output of Autoconf when processing the Macro. You -# need not follow the terms of the GNU General Public License when using -# or distributing such scripts, even though portions of the text of the -# Macro appear in them. The GNU General Public License (GPL) does govern -# all other use of the material that constitutes the Autoconf Macro. -# -# This special exception to the GPL applies to versions of the Autoconf -# Macro released by the Autoconf Macro Archive. When you make and -# distribute a modified version of the Autoconf Macro, you may extend this -# special exception to the GPL to apply to your modified version as well. - -AC_DEFUN([AX_OCTAVE],[ - # These are the variables AX_OCTAVE uses - OCTAVE_LDFLAGS= - OCTAVE_LIBS= - OCTAVE_CPPFLAGS= - OCTAVE_INCLUDEDIR= - OCTAVE_LIBRARYDIR= - - AC_ARG_VAR([MKOCTFILE], [mkoctfile command]) - AC_ARG_VAR([OCTAVE], [octave command]) - AC_ARG_VAR([OCTAVE_CONFIG], [octave-config command]) - AC_ARG_VAR([OCTAVE_VERSION], [the full version of Octave to use]) - - AS_IF([test -n "$OCTAVE_VERSION"], - [ax_octave_suffix="-$OCTAVE_VERSION"], - [ax_octave_suffix=""]) - - AC_ARG_WITH([octave], - AS_HELP_STRING([--with-octave], - [specify root directory of Octave installation])) - AS_IF([test -n "$with_octave"], - [AS_IF([test -z "$MKOCTFILE" && test -f "$with_octave/bin/mkoctfile$ax_octave_suffix"], - [MKOCTFILE="$with_octave/bin/mkoctfile$ax_octave_suffix"]) - AS_IF([test -z "$OCTAVE" && test -f "$with_octave/bin/octave$ax_octave_suffix"], - [OCTAVE="$with_octave/bin/octave$ax_octave_suffix"]) - AS_IF([test -z "$OCTAVE_CONFIG" && test -f "$with_octave/bin/octave-config$ax_octave_suffix"], - [OCTAVE_CONFIG="$with_octave/bin/octave-config$ax_octave_suffix"])], - [AC_CHECK_TOOLS([MKOCTFILE], [mkoctfile$ax_octave_suffix]) - AC_CHECK_TOOLS([OCTAVE], [octave$ax_octave_suffix]) - AC_CHECK_TOOLS([OCTAVE_CONFIG], [octave-config$ax_octave_suffix])]) - - ax_octave_config="[$]$1" - ax_octave_ok= - - AC_MSG_CHECKING([for octave-config filename]) - AS_IF([test -z "$ax_octave_config"], [ - AC_MSG_RESULT([determined from path]) - AC_PATH_TOOL([ax_octave_config], [octave-config], []) - AS_IF([test -z "$ax_octave_config"], [ - AC_MSG_WARN([Could not find octave-config.]) - ], []) - ], [ - AC_MSG_RESULT([specified $ax_octave_config]) - ]) - - AS_IF([test -n "$ax_octave_config"], [ - AC_MSG_CHECKING([for Octave library path]) - OCTAVE_LIBRARYDIR=`$ax_octave_config -p OCTLIBDIR` - AC_MSG_RESULT([$OCTAVE_LIBRARYDIR]) - - AC_MSG_CHECKING([for Octave include path]) - OCTAVE_INCLUDEDIR=`$ax_octave_config -p OCTINCLUDEDIR` - AC_MSG_RESULT([$OCTAVE_INCLUDEDIR]) - ]) - - AS_IF([[test -z "$OCTAVE_LIBRARYDIR" -o -z "$OCTAVE_INCLUDEDIR"]], [ - AC_MSG_WARN([[ -======================================================================== -Octave library or include path not found using octave-config, trying -Octave interpreter. - -This could be a sign that the Octave development package is missing. -========================================================================]]) - - OCTAVE_LIBRARYDIR= - OCTAVE_INCLUDEDIR= - - AC_MSG_NOTICE([[checking for Octave interpreter]]) - AC_PATH_TOOL([ax_octave_interpreter], [octave], []) - AS_IF([test -z "$ax_octave_interpreter"], [ - AC_MSG_WARN([Could not find Octave interpreter.]) - ], [ - AC_MSG_CHECKING([for Octave library path (alt)]) - OCTAVE_LIBRARYDIR=`$ax_octave_interpreter -q --eval "printf(octave_config_info.octlibdir)"` - AC_MSG_RESULT([$OCTAVE_LIBRARYDIR]) - - AC_MSG_CHECKING([for Octave include path (alt)]) - OCTAVE_INCLUDEDIR=`$ax_octave_interpreter -q --eval "printf(octave_config_info.octincludedir)"` - AC_MSG_RESULT([$OCTAVE_INCLUDEDIR]) - ]) - - AS_IF([[test -z "$OCTAVE_LIBRARYDIR" -o -z "$OCTAVE_INCLUDEDIR"]], [ - ax_octave_ok=no - ]) - ]) - - AS_IF([test -z "$ax_octave_ok"], [ - if test -f "$OCTAVE_INCLUDEDIR/oct.h" ; then - OCTAVE_INCLUDEDIR=`AS_DIRNAME(["$OCTAVE_INCLUDEDIR"])` - fi - - OCTAVE_LDFLAGS="-L$OCTAVE_LIBRARYDIR" - OCTAVE_LIBS="-loctinterp -loctave" - OCTAVE_CPPFLAGS="-I$OCTAVE_INCLUDEDIR -I$OCTAVE_INCLUDEDIR/octave" - - AC_CACHE_CHECK([whether linking to Octave works], [ax_octave_cv_lib_octave], - [ - ax_octave_cv_lib_octave=no - - AC_LANG_PUSH([C++]) - - ax_octave_old_ldflags="$LDFLAGS" - ax_octave_old_cppflags="$CPPFLAGS" - ax_octave_old_libs="$LIBS" - - LDFLAGS="$OCTAVE_LDFLAGS $ax_octave_old_ldflags" - CPPFLAGS="$OCTAVE_CPPFLAGS $ax_octave_old_cppflags" - LIBS="$OCTAVE_LIBS $ax_octave_old_libs" - - AC_LANG_ASSERT(C++) - AC_LINK_IFELSE([AC_LANG_PROGRAM( - [[#include <octave/oct.h> - #include <octave/Matrix.h> ]], - [[MatrixType()]])], - [ax_octave_cv_lib_octave=yes], - [ax_octave_cv_lib_octave=no]) - - LDFLAGS="$ax_octave_old_ldflags" - CPPFLAGS="$ax_octave_old_cppflags" - LIBS="$ax_octave_old_libs" - - AC_LANG_POP([C++]) - ]) - AS_IF([test "x$ax_octave_cv_lib_octave" != "xyes"], [ - ax_octave_ok=no - ]) - ]) - - AS_IF([test -n "$ax_octave_ok"], [ - OCTAVE_LDFLAGS= - OCTAVE_LIBS= - OCTAVE_CPPFLAGS= - OCTAVE_INCLUDEDIR= - OCTAVE_LIBRARYDIR= - - AC_MSG_WARN([[ -======================================================================== -Can not link with Octave. - -Make sure the Octave development package is installed. -========================================================================]]) - ]) - AS_IF([test -z "$ax_octave_ok"], [ - AC_DEFINE([HAVE_OCTAVE], [1], [Define to 1 if you have Octave.]) - AC_DEFINE_UNQUOTED([OCTAVE_INCLUDEDIR], ["$OCTAVE_INCLUDEDIR"], - [Octave include directory.]) - AC_DEFINE_UNQUOTED([OCTAVE_LIBRARYDIR], ["$OCTAVE_LIBRARYDIR"], - [Octave library directory.]) - ]) - - AC_SUBST([OCTAVE_LDFLAGS]) - AC_SUBST([OCTAVE_CPPFLAGS]) - AC_SUBST([OCTAVE_LIBS]) - AC_SUBST([OCTAVE_INCLUDEDIR]) - AC_SUBST([OCTAVE_LIBRARYDIR]) - - # Execute ACTION_IF_FOUND or ACTION_IF_NOT_FOUND - if test -z "$ax_octave_ok" ; then - m4_ifvaln([$2],[$2],[:])dnl - m4_ifvaln([$3],[else $3])dnl - fi - -])
--- a/m4/ax_python_devel.m4 Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,327 +0,0 @@ -# =========================================================================== -# https://www.gnu.org/software/autoconf-archive/ax_python_devel.html -# =========================================================================== -# -# SYNOPSIS -# -# AX_PYTHON_DEVEL([version]) -# -# DESCRIPTION -# -# Note: Defines as a precious variable "PYTHON_VERSION". Don't override it -# in your configure.ac. -# -# This macro checks for Python and tries to get the include path to -# 'Python.h'. It provides the $(PYTHON_CPPFLAGS) and $(PYTHON_LIBS) output -# variables. It also exports $(PYTHON_EXTRA_LIBS) and -# $(PYTHON_EXTRA_LDFLAGS) for embedding Python in your code. -# -# You can search for some particular version of Python by passing a -# parameter to this macro, for example ">= '2.3.1'", or "== '2.4'". Please -# note that you *have* to pass also an operator along with the version to -# match, and pay special attention to the single quotes surrounding the -# version number. Don't use "PYTHON_VERSION" for this: that environment -# variable is declared as precious and thus reserved for the end-user. -# -# This macro should work for all versions of Python >= 2.1.0. As an end -# user, you can disable the check for the python version by setting the -# PYTHON_NOVERSIONCHECK environment variable to something else than the -# empty string. -# -# If you need to use this macro for an older Python version, please -# contact the authors. We're always open for feedback. -# -# LICENSE -# -# Copyright (c) 2009 Sebastian Huber <sebastian-huber@web.de> -# Copyright (c) 2009 Alan W. Irwin -# Copyright (c) 2009 Rafael Laboissiere <rafael@laboissiere.net> -# Copyright (c) 2009 Andrew Collier -# Copyright (c) 2009 Matteo Settenvini <matteo@member.fsf.org> -# Copyright (c) 2009 Horst Knorr <hk_classes@knoda.org> -# Copyright (c) 2013 Daniel Mullner <muellner@math.stanford.edu> -# -# This program 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. -# -# This program 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 this program. If not, see <https://www.gnu.org/licenses/>. -# -# As a special exception, the respective Autoconf Macro's copyright owner -# gives unlimited permission to copy, distribute and modify the configure -# scripts that are the output of Autoconf when processing the Macro. You -# need not follow the terms of the GNU General Public License when using -# or distributing such scripts, even though portions of the text of the -# Macro appear in them. The GNU General Public License (GPL) does govern -# all other use of the material that constitutes the Autoconf Macro. -# -# This special exception to the GPL applies to versions of the Autoconf -# Macro released by the Autoconf Archive. When you make and distribute a -# modified version of the Autoconf Macro, you may extend this special -# exception to the GPL to apply to your modified version as well. - -#serial 20 - -AU_ALIAS([AC_PYTHON_DEVEL], [AX_PYTHON_DEVEL]) -AC_DEFUN([AX_PYTHON_DEVEL],[ - # - # Allow the use of a (user set) custom python version - # - AC_ARG_VAR([PYTHON_VERSION],[The installed Python - version to use, for example '2.3'. This string - will be appended to the Python interpreter - canonical name.]) - - AC_PATH_PROG([PYTHON],[python[$PYTHON_VERSION]]) - if test -z "$PYTHON"; then - AC_MSG_ERROR([Cannot find python$PYTHON_VERSION in your system path]) - PYTHON_VERSION="" - fi - - # - # Check for a version of Python >= 2.1.0 - # - AC_MSG_CHECKING([for a version of Python >= '2.1.0']) - ac_supports_python_ver=`$PYTHON -c "import sys; \ - ver = sys.version.split ()[[0]]; \ - print (ver >= '2.1.0')"` - if test "$ac_supports_python_ver" != "True"; then - if test -z "$PYTHON_NOVERSIONCHECK"; then - AC_MSG_RESULT([no]) - AC_MSG_FAILURE([ -This version of the AC@&t@_PYTHON_DEVEL macro -doesn't work properly with versions of Python before -2.1.0. You may need to re-run configure, setting the -variables PYTHON_CPPFLAGS, PYTHON_LIBS, PYTHON_SITE_PKG, -PYTHON_EXTRA_LIBS and PYTHON_EXTRA_LDFLAGS by hand. -Moreover, to disable this check, set PYTHON_NOVERSIONCHECK -to something else than an empty string. -]) - else - AC_MSG_RESULT([skip at user request]) - fi - else - AC_MSG_RESULT([yes]) - fi - - # - # if the macro parameter ``version'' is set, honour it - # - if test -n "$1"; then - AC_MSG_CHECKING([for a version of Python $1]) - ac_supports_python_ver=`$PYTHON -c "import sys; \ - ver = sys.version.split ()[[0]]; \ - print (ver $1)"` - if test "$ac_supports_python_ver" = "True"; then - AC_MSG_RESULT([yes]) - else - AC_MSG_RESULT([no]) - AC_MSG_ERROR([this package requires Python $1. -If you have it installed, but it isn't the default Python -interpreter in your system path, please pass the PYTHON_VERSION -variable to configure. See ``configure --help'' for reference. -]) - PYTHON_VERSION="" - fi - fi - - # - # Check if you have distutils, else fail - # - AC_MSG_CHECKING([for the distutils Python package]) - ac_distutils_result=`$PYTHON -c "import distutils" 2>&1` - if test $? -eq 0; then - AC_MSG_RESULT([yes]) - else - AC_MSG_RESULT([no]) - AC_MSG_ERROR([cannot import Python module "distutils". -Please check your Python installation. The error was: -$ac_distutils_result]) - PYTHON_VERSION="" - fi - - # - # Check for Python include path - # - AC_MSG_CHECKING([for Python include path]) - if test -z "$PYTHON_CPPFLAGS"; then - python_path=`$PYTHON -c "import distutils.sysconfig; \ - print (distutils.sysconfig.get_python_inc ());"` - plat_python_path=`$PYTHON -c "import distutils.sysconfig; \ - print (distutils.sysconfig.get_python_inc (plat_specific=1));"` - if test -n "${python_path}"; then - if test "${plat_python_path}" != "${python_path}"; then - python_path="-I$python_path -I$plat_python_path" - else - python_path="-I$python_path" - fi - fi - PYTHON_CPPFLAGS=$python_path - fi - AC_MSG_RESULT([$PYTHON_CPPFLAGS]) - AC_SUBST([PYTHON_CPPFLAGS]) - - # - # Check for Python library path - # - AC_MSG_CHECKING([for Python library path]) - if test -z "$PYTHON_LIBS"; then - # (makes two attempts to ensure we've got a version number - # from the interpreter) - ac_python_version=`cat<<EOD | $PYTHON - - -# join all versioning strings, on some systems -# major/minor numbers could be in different list elements -from distutils.sysconfig import * -e = get_config_var('VERSION') -if e is not None: - print(e) -EOD` - - if test -z "$ac_python_version"; then - if test -n "$PYTHON_VERSION"; then - ac_python_version=$PYTHON_VERSION - else - ac_python_version=`$PYTHON -c "import sys; \ - print (sys.version[[:3]])"` - fi - fi - - # Make the versioning information available to the compiler - AC_DEFINE_UNQUOTED([HAVE_PYTHON], ["$ac_python_version"], - [If available, contains the Python version number currently in use.]) - - # First, the library directory: - ac_python_libdir=`cat<<EOD | $PYTHON - - -# There should be only one -import distutils.sysconfig -e = distutils.sysconfig.get_config_var('LIBDIR') -if e is not None: - print (e) -EOD` - - # Now, for the library: - ac_python_library=`cat<<EOD | $PYTHON - - -import distutils.sysconfig -c = distutils.sysconfig.get_config_vars() -if 'LDVERSION' in c: - print ('python'+c[['LDVERSION']]) -else: - print ('python'+c[['VERSION']]) -EOD` - - # This small piece shamelessly adapted from PostgreSQL python macro; - # credits goes to momjian, I think. I'd like to put the right name - # in the credits, if someone can point me in the right direction... ? - # - if test -n "$ac_python_libdir" -a -n "$ac_python_library" - then - # use the official shared library - ac_python_library=`echo "$ac_python_library" | sed "s/^lib//"` - PYTHON_LIBS="-L$ac_python_libdir -l$ac_python_library" - else - # old way: use libpython from python_configdir - ac_python_libdir=`$PYTHON -c \ - "from distutils.sysconfig import get_python_lib as f; \ - import os; \ - print (os.path.join(f(plat_specific=1, standard_lib=1), 'config'));"` - PYTHON_LIBS="-L$ac_python_libdir -lpython$ac_python_version" - fi - - if test -z "PYTHON_LIBS"; then - AC_MSG_ERROR([ - Cannot determine location of your Python DSO. Please check it was installed with - dynamic libraries enabled, or try setting PYTHON_LIBS by hand. - ]) - fi - fi - AC_MSG_RESULT([$PYTHON_LIBS]) - AC_SUBST([PYTHON_LIBS]) - - # - # Check for site packages - # - AC_MSG_CHECKING([for Python site-packages path]) - if test -z "$PYTHON_SITE_PKG"; then - PYTHON_SITE_PKG=`$PYTHON -c "import distutils.sysconfig; \ - print (distutils.sysconfig.get_python_lib(0,0));"` - fi - AC_MSG_RESULT([$PYTHON_SITE_PKG]) - AC_SUBST([PYTHON_SITE_PKG]) - - # - # libraries which must be linked in when embedding - # - AC_MSG_CHECKING(python extra libraries) - if test -z "$PYTHON_EXTRA_LDFLAGS"; then - PYTHON_EXTRA_LDFLAGS=`$PYTHON -c "import distutils.sysconfig; \ - conf = distutils.sysconfig.get_config_var; \ - print (conf('LIBS') + ' ' + conf('SYSLIBS'))"` - fi - AC_MSG_RESULT([$PYTHON_EXTRA_LDFLAGS]) - AC_SUBST(PYTHON_EXTRA_LDFLAGS) - - # - # linking flags needed when embedding - # - AC_MSG_CHECKING(python extra linking flags) - if test -z "$PYTHON_EXTRA_LIBS"; then - PYTHON_EXTRA_LIBS=`$PYTHON -c "import distutils.sysconfig; \ - conf = distutils.sysconfig.get_config_var; \ - print (conf('LINKFORSHARED'))"` - fi - AC_MSG_RESULT([$PYTHON_EXTRA_LIBS]) - AC_SUBST(PYTHON_EXTRA_LIBS) - - # - # final check to see if everything compiles alright - # - AC_MSG_CHECKING([consistency of all components of python development environment]) - # save current global flags - ac_save_LIBS="$LIBS" - ac_save_LDFLAGS="$LDFLAGS" - ac_save_CPPFLAGS="$CPPFLAGS" - LIBS="$ac_save_LIBS $PYTHON_LIBS $PYTHON_EXTRA_LIBS $PYTHON_EXTRA_LIBS" - LDFLAGS="$ac_save_LDFLAGS $PYTHON_EXTRA_LDFLAGS" - CPPFLAGS="$ac_save_CPPFLAGS $PYTHON_CPPFLAGS" - AC_LANG_PUSH([C]) - AC_LINK_IFELSE([ - AC_LANG_PROGRAM([[#include <Python.h>]], - [[Py_Initialize();]]) - ],[pythonexists=yes],[pythonexists=no]) - AC_LANG_POP([C]) - # turn back to default flags - CPPFLAGS="$ac_save_CPPFLAGS" - LIBS="$ac_save_LIBS" - LDFLAGS="$ac_save_LDFLAGS" - - AC_MSG_RESULT([$pythonexists]) - - if test ! "x$pythonexists" = "xyes"; then - AC_MSG_FAILURE([ - Could not link test program to Python. Maybe the main Python library has been - installed in some non-standard library path. If so, pass it to configure, - via the LIBS environment variable. - Example: ./configure LIBS="-L/usr/non-standard-path/python/lib" - ============================================================================ - ERROR! - You probably have to install the development version of the Python package - for your distribution. The exact name of this package varies among them. - ============================================================================ - ]) - PYTHON_VERSION="" - fi - - # - # all done! - # -])
--- a/m4/std-gnu11.m4 Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,824 +0,0 @@ -# Prefer GNU C11 and C++11 to earlier versions. -*- coding: utf-8 -*- - -# This implementation is taken from GNU Autoconf lib/autoconf/c.m4 -# commit 739cdc82b5325402231f3f5e1a38f681fcbd1db2 -# dated Tue Mar 15 09:34:11 2016 -0700. -# This implementation will be obsolete once we can assume Autoconf 2.70 -# or later is installed everywhere a Gnulib program might be developed. - - -# Copyright (C) 2001-2016 Free Software Foundation, Inc. - -# This program 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. -# -# This program 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 this program. If not, see <http://www.gnu.org/licenses/>. - -# Written by David MacKenzie, with help from -# Akim Demaille, Paul Eggert, -# François Pinard, Karl Berry, Richard Pixley, Ian Lance Taylor, -# Roland McGrath, Noah Friedman, david d zuhn, and many others. - - -# AC_PROG_CC([COMPILER ...]) -# -------------------------- -# COMPILER ... is a space separated list of C compilers to search for. -# This just gives the user an opportunity to specify an alternative -# search list for the C compiler. -AC_DEFUN_ONCE([AC_PROG_CC], -[AC_LANG_PUSH(C)dnl -AC_ARG_VAR([CC], [C compiler command])dnl -AC_ARG_VAR([CFLAGS], [C compiler flags])dnl -_AC_ARG_VAR_LDFLAGS()dnl -_AC_ARG_VAR_LIBS()dnl -_AC_ARG_VAR_CPPFLAGS()dnl -m4_ifval([$1], - [AC_CHECK_TOOLS(CC, [$1])], -[AC_CHECK_TOOL(CC, gcc) -if test -z "$CC"; then - dnl Here we want: - dnl AC_CHECK_TOOL(CC, cc) - dnl but without the check for a tool without the prefix. - dnl Until the check is removed from there, copy the code: - if test -n "$ac_tool_prefix"; then - AC_CHECK_PROG(CC, [${ac_tool_prefix}cc], [${ac_tool_prefix}cc]) - fi -fi -if test -z "$CC"; then - AC_CHECK_PROG(CC, cc, cc, , , /usr/ucb/cc) -fi -if test -z "$CC"; then - AC_CHECK_TOOLS(CC, cl.exe) -fi -if test -z "$CC"; then - AC_CHECK_TOOL(CC, clang) -fi -]) - -test -z "$CC" && AC_MSG_FAILURE([no acceptable C compiler found in \$PATH]) - -# Provide some information about the compiler. -_AS_ECHO_LOG([checking for _AC_LANG compiler version]) -set X $ac_compile -ac_compiler=$[2] -for ac_option in --version -v -V -qversion -version; do - _AC_DO_LIMIT([$ac_compiler $ac_option >&AS_MESSAGE_LOG_FD]) -done - -m4_expand_once([_AC_COMPILER_EXEEXT])[]dnl -m4_expand_once([_AC_COMPILER_OBJEXT])[]dnl -_AC_LANG_COMPILER_GNU -if test $ac_compiler_gnu = yes; then - GCC=yes -else - GCC= -fi -_AC_PROG_CC_G -dnl -dnl Set ac_prog_cc_stdc to the supported C version. -dnl Also set the documented variable ac_cv_prog_cc_stdc; -dnl its name was chosen when it was cached, but it is no longer cached. -_AC_PROG_CC_C11([ac_prog_cc_stdc=c11 - ac_cv_prog_cc_stdc=$ac_cv_prog_cc_c11], - [_AC_PROG_CC_C99([ac_prog_cc_stdc=c99 - ac_cv_prog_cc_stdc=$ac_cv_prog_cc_c99], - [_AC_PROG_CC_C89([ac_prog_cc_stdc=c89 - ac_cv_prog_cc_stdc=$ac_cv_prog_cc_c89], - [ac_prog_cc_stdc=no - ac_cv_prog_cc_stdc=no])])]) -dnl -AC_LANG_POP(C)dnl -])# AC_PROG_CC - - - -# AC_PROG_CXX([LIST-OF-COMPILERS]) -# -------------------------------- -# LIST-OF-COMPILERS is a space separated list of C++ compilers to search -# for (if not specified, a default list is used). This just gives the -# user an opportunity to specify an alternative search list for the C++ -# compiler. -# aCC HP-UX C++ compiler much better than `CC', so test before. -# FCC Fujitsu C++ compiler -# KCC KAI C++ compiler -# RCC Rational C++ -# xlC_r AIX C Set++ (with support for reentrant code) -# xlC AIX C Set++ -AC_DEFUN([AC_PROG_CXX], -[AC_LANG_PUSH(C++)dnl -AC_ARG_VAR([CXX], [C++ compiler command])dnl -AC_ARG_VAR([CXXFLAGS], [C++ compiler flags])dnl -_AC_ARG_VAR_LDFLAGS()dnl -_AC_ARG_VAR_LIBS()dnl -_AC_ARG_VAR_CPPFLAGS()dnl -_AC_ARG_VAR_PRECIOUS([CCC])dnl -if test -z "$CXX"; then - if test -n "$CCC"; then - CXX=$CCC - else - AC_CHECK_TOOLS(CXX, - [m4_default([$1], - [g++ c++ gpp aCC CC cxx cc++ cl.exe FCC KCC RCC xlC_r xlC clang++])], - g++) - fi -fi -# Provide some information about the compiler. -_AS_ECHO_LOG([checking for _AC_LANG compiler version]) -set X $ac_compile -ac_compiler=$[2] -for ac_option in --version -v -V -qversion; do - _AC_DO_LIMIT([$ac_compiler $ac_option >&AS_MESSAGE_LOG_FD]) -done - -m4_expand_once([_AC_COMPILER_EXEEXT])[]dnl -m4_expand_once([_AC_COMPILER_OBJEXT])[]dnl -_AC_LANG_COMPILER_GNU -if test $ac_compiler_gnu = yes; then - GXX=yes -else - GXX= -fi -_AC_PROG_CXX_G -_AC_PROG_CXX_CXX11([ac_prog_cxx_stdcxx=cxx11 - ac_cv_prog_cxx_stdcxx=$ac_cv_prog_cxx_cxx11 - ac_cv_prog_cxx_cxx98=$ac_cv_prog_cxx_cxx11], - [_AC_PROG_CXX_CXX98([ac_prog_cxx_stdcxx=cxx98 - ac_cv_prog_cxx_stdcxx=$ac_cv_prog_cxx_cxx98], - [ac_prog_cxx_stdcxx=no - ac_cv_prog_cxx_stdcxx=no])]) -AC_LANG_POP(C++)dnl -])# AC_PROG_CXX - - -# _AC_C_STD_TRY(STANDARD, TEST-PROLOGUE, TEST-BODY, OPTION-LIST, -# ACTION-IF-AVAILABLE, ACTION-IF-UNAVAILABLE) -# -------------------------------------------------------------- -# Check whether the C compiler accepts features of STANDARD (e.g `c89', `c99') -# by trying to compile a program of TEST-PROLOGUE and TEST-BODY. If this fails, -# try again with each compiler option in the space-separated OPTION-LIST; if one -# helps, append it to CC. If eventually successful, run ACTION-IF-AVAILABLE, -# else ACTION-IF-UNAVAILABLE. -AC_DEFUN([_AC_C_STD_TRY], -[AC_MSG_CHECKING([for $CC option to enable ]m4_translit($1, [c], [C])[ features]) -AC_CACHE_VAL(ac_cv_prog_cc_$1, -[ac_cv_prog_cc_$1=no -ac_save_CC=$CC -AC_LANG_CONFTEST([AC_LANG_PROGRAM([$2], [$3])]) -for ac_arg in '' $4 -do - CC="$ac_save_CC $ac_arg" - _AC_COMPILE_IFELSE([], [ac_cv_prog_cc_$1=$ac_arg]) - test "x$ac_cv_prog_cc_$1" != "xno" && break -done -rm -f conftest.$ac_ext -CC=$ac_save_CC -])# AC_CACHE_VAL -ac_prog_cc_stdc_options= -case "x$ac_cv_prog_cc_$1" in - x) - AC_MSG_RESULT([none needed]) ;; - xno) - AC_MSG_RESULT([unsupported]) ;; - *) - ac_prog_cc_stdc_options=" $ac_cv_prog_cc_$1" - CC=$CC$ac_prog_cc_stdc_options - AC_MSG_RESULT([$ac_cv_prog_cc_$1]) ;; -esac -AS_IF([test "x$ac_cv_prog_cc_$1" != xno], [$5], [$6]) -])# _AC_C_STD_TRY - -# _AC_C_C99_TEST_HEADER -# --------------------- -# A C header suitable for testing for C99. -AC_DEFUN([_AC_C_C99_TEST_HEADER], -[[#include <stdarg.h> -#include <stdbool.h> -#include <stddef.h> -#include <stdlib.h> -#include <wchar.h> -#include <stdio.h> - -// Check varargs macros. These examples are taken from C99 6.10.3.5. -#define debug(...) fprintf (stderr, __VA_ARGS__) -#define showlist(...) puts (#__VA_ARGS__) -#define report(test,...) ((test) ? puts (#test) : printf (__VA_ARGS__)) -static void -test_varargs_macros (void) -{ - int x = 1234; - int y = 5678; - debug ("Flag"); - debug ("X = %d\n", x); - showlist (The first, second, and third items.); - report (x>y, "x is %d but y is %d", x, y); -} - -// Check long long types. -#define BIG64 18446744073709551615ull -#define BIG32 4294967295ul -#define BIG_OK (BIG64 / BIG32 == 4294967297ull && BIG64 % BIG32 == 0) -#if !BIG_OK - your preprocessor is broken; -#endif -#if BIG_OK -#else - your preprocessor is broken; -#endif -static long long int bignum = -9223372036854775807LL; -static unsigned long long int ubignum = BIG64; - -struct incomplete_array -{ - int datasize; - double data[]; -}; - -struct named_init { - int number; - const wchar_t *name; - double average; -}; - -typedef const char *ccp; - -static inline int -test_restrict (ccp restrict text) -{ - // See if C++-style comments work. - // Iterate through items via the restricted pointer. - // Also check for declarations in for loops. - for (unsigned int i = 0; *(text+i) != '\0'; ++i) - continue; - return 0; -} - -// Check varargs and va_copy. -static bool -test_varargs (const char *format, ...) -{ - va_list args; - va_start (args, format); - va_list args_copy; - va_copy (args_copy, args); - - const char *str = ""; - int number = 0; - float fnumber = 0; - - while (*format) - { - switch (*format++) - { - case 's': // string - str = va_arg (args_copy, const char *); - break; - case 'd': // int - number = va_arg (args_copy, int); - break; - case 'f': // float - fnumber = va_arg (args_copy, double); - break; - default: - break; - } - } - va_end (args_copy); - va_end (args); - - return *str && number && fnumber; -}]])# _AC_C_C99_TEST_HEADER - -# _AC_C_C99_TEST_BODY -# ------------------- -# A C body suitable for testing for C99, assuming the corresponding header. -AC_DEFUN([_AC_C_C99_TEST_BODY], -[[ - // Check bool. - _Bool success = false; - - // Check restrict. - if (test_restrict ("String literal") == 0) - success = true; - char *restrict newvar = "Another string"; - - // Check varargs. - success &= test_varargs ("s, d' f .", "string", 65, 34.234); - test_varargs_macros (); - - // Check flexible array members. - struct incomplete_array *ia = - malloc (sizeof (struct incomplete_array) + (sizeof (double) * 10)); - ia->datasize = 10; - for (int i = 0; i < ia->datasize; ++i) - ia->data[i] = i * 1.234; - - // Check named initializers. - struct named_init ni = { - .number = 34, - .name = L"Test wide string", - .average = 543.34343, - }; - - ni.number = 58; - - int dynamic_array[ni.number]; - dynamic_array[ni.number - 1] = 543; - - // work around unused variable warnings - return (!success || bignum == 0LL || ubignum == 0uLL || newvar[0] == 'x' - || dynamic_array[ni.number - 1] != 543); -]]) - -# _AC_PROG_CC_C99 ([ACTION-IF-AVAILABLE], [ACTION-IF-UNAVAILABLE]) -# ---------------------------------------------------------------- -# If the C compiler is not in ISO C99 mode by default, try to add an -# option to output variable CC to make it so. This macro tries -# various options that select ISO C99 on some system or another. It -# considers the compiler to be in ISO C99 mode if it handles _Bool, -# // comments, flexible array members, inline, long long int, mixed -# code and declarations, named initialization of structs, restrict, -# va_copy, varargs macros, variable declarations in for loops and -# variable length arrays. -AC_DEFUN([_AC_PROG_CC_C99], -[_AC_C_STD_TRY([c99], -[_AC_C_C99_TEST_HEADER], -[_AC_C_C99_TEST_BODY], -dnl Try -dnl GCC -std=gnu99 (unused restrictive modes: -std=c99 -std=iso9899:1999) -dnl IBM XL C -qlanglvl=extc1x (V12.1; does not pass C11 test) -dnl IBM XL C -qlanglvl=extc99 -dnl (pre-V12.1; unused restrictive mode: -qlanglvl=stdc99) -dnl HP cc -AC99 -dnl Intel ICC -std=c99, -c99 (deprecated) -dnl IRIX -c99 -dnl Solaris -D_STDC_C99= -dnl cc's -xc99 option uses linker magic to define the external -dnl symbol __xpg4 as if by "int __xpg4 = 1;", which enables C99 -dnl behavior for C library functions. This is not wanted here, -dnl because it means that a single module compiled with -xc99 -dnl alters C runtime behavior for the entire program, not for -dnl just the module. Instead, define the (private) symbol -dnl _STDC_C99, which suppresses a bogus failure in <stdbool.h>. -dnl The resulting compiler passes the test case here, and that's -dnl good enough. For more, please see the thread starting at: -dnl http://lists.gnu.org/archive/html/autoconf/2010-12/msg00059.html -dnl Tru64 -c99 -dnl with extended modes being tried first. -[[-std=gnu99 -std=c99 -c99 -AC99 -D_STDC_C99= -qlanglvl=extc1x -qlanglvl=extc99]], [$1], [$2])[]dnl -])# _AC_PROG_CC_C99 - - -# _AC_PROG_CC_C11 ([ACTION-IF-AVAILABLE], [ACTION-IF-UNAVAILABLE]) -# ---------------------------------------------------------------- -# If the C compiler is not in ISO C11 mode by default, try to add an -# option to output variable CC to make it so. This macro tries -# various options that select ISO C11 on some system or another. It -# considers the compiler to be in ISO C11 mode if it handles _Alignas, -# _Alignof, _Noreturn, _Static_assert, UTF-8 string literals, -# duplicate typedefs, and anonymous structures and unions. -AC_DEFUN([_AC_PROG_CC_C11], -[_AC_C_STD_TRY([c11], -[_AC_C_C99_TEST_HEADER[ -// Check _Alignas. -char _Alignas (double) aligned_as_double; -char _Alignas (0) no_special_alignment; -extern char aligned_as_int; -char _Alignas (0) _Alignas (int) aligned_as_int; - -// Check _Alignof. -enum -{ - int_alignment = _Alignof (int), - int_array_alignment = _Alignof (int[100]), - char_alignment = _Alignof (char) -}; -_Static_assert (0 < -_Alignof (int), "_Alignof is signed"); - -// Check _Noreturn. -int _Noreturn does_not_return (void) { for (;;) continue; } - -// Check _Static_assert. -struct test_static_assert -{ - int x; - _Static_assert (sizeof (int) <= sizeof (long int), - "_Static_assert does not work in struct"); - long int y; -}; - -// Check UTF-8 literals. -#define u8 syntax error! -char const utf8_literal[] = u8"happens to be ASCII" "another string"; - -// Check duplicate typedefs. -typedef long *long_ptr; -typedef long int *long_ptr; -typedef long_ptr long_ptr; - -// Anonymous structures and unions -- taken from C11 6.7.2.1 Example 1. -struct anonymous -{ - union { - struct { int i; int j; }; - struct { int k; long int l; } w; - }; - int m; -} v1; -]], -[_AC_C_C99_TEST_BODY[ - v1.i = 2; - v1.w.k = 5; - _Static_assert ((offsetof (struct anonymous, i) - == offsetof (struct anonymous, w.k)), - "Anonymous union alignment botch"); -]], -dnl Try -dnl GCC -std=gnu11 (unused restrictive mode: -std=c11) -dnl with extended modes being tried first. -dnl -dnl Do not try -qlanglvl=extc1x, because IBM XL C V12.1 (the latest version as -dnl of September 2012) does not pass the C11 test. For now, try extc1x when -dnl compiling the C99 test instead, since it enables _Static_assert and -dnl _Noreturn, which is a win. If -qlanglvl=extc11 or -qlanglvl=extc1x passes -dnl the C11 test in some future version of IBM XL C, we'll add it here, -dnl preferably extc11. -[[-std=gnu11]], [$1], [$2])[]dnl -])# _AC_PROG_CC_C11 - - -# AC_PROG_CC_C89 -# -------------- -# Do not use AU_ALIAS here and in AC_PROG_CC_C99 and AC_PROG_CC_STDC, -# as that'd be incompatible with how Automake redefines AC_PROG_CC. See -# <http://lists.gnu.org/archive/html/autoconf/2012-10/msg00048.html>. -AU_DEFUN([AC_PROG_CC_C89], - [AC_REQUIRE([AC_PROG_CC])], - [$0 is obsolete; use AC_PROG_CC] -) - -# AC_PROG_CC_C99 -# -------------- -AU_DEFUN([AC_PROG_CC_C99], - [AC_REQUIRE([AC_PROG_CC])], - [$0 is obsolete; use AC_PROG_CC] -) - -# AC_PROG_CC_STDC -# --------------- -AU_DEFUN([AC_PROG_CC_STDC], - [AC_REQUIRE([AC_PROG_CC])], - [$0 is obsolete; use AC_PROG_CC] -) - - -# AC_C_PROTOTYPES -# --------------- -# Check if the C compiler supports prototypes, included if it needs -# options. -AC_DEFUN([AC_C_PROTOTYPES], -[AC_REQUIRE([AC_PROG_CC])dnl -if test "$ac_prog_cc_stdc" != no; then - AC_DEFINE(PROTOTYPES, 1, - [Define to 1 if the C compiler supports function prototypes.]) - AC_DEFINE(__PROTOTYPES, 1, - [Define like PROTOTYPES; this can be used by system headers.]) -fi -])# AC_C_PROTOTYPES - - -# _AC_CXX_STD_TRY(STANDARD, TEST-PROLOGUE, TEST-BODY, OPTION-LIST, -# ACTION-IF-AVAILABLE, ACTION-IF-UNAVAILABLE) -# ---------------------------------------------------------------- -# Check whether the C++ compiler accepts features of STANDARD (e.g -# `cxx98', `cxx11') by trying to compile a program of TEST-PROLOGUE -# and TEST-BODY. If this fails, try again with each compiler option -# in the space-separated OPTION-LIST; if one helps, append it to CXX. -# If eventually successful, run ACTION-IF-AVAILABLE, else -# ACTION-IF-UNAVAILABLE. -AC_DEFUN([_AC_CXX_STD_TRY], -[AC_MSG_CHECKING([for $CXX option to enable ]m4_translit(m4_translit($1, [x], [+]), [a-z], [A-Z])[ features]) -AC_LANG_PUSH(C++)dnl -AC_CACHE_VAL(ac_cv_prog_cxx_$1, -[ac_cv_prog_cxx_$1=no -ac_save_CXX=$CXX -AC_LANG_CONFTEST([AC_LANG_PROGRAM([$2], [$3])]) -for ac_arg in '' $4 -do - CXX="$ac_save_CXX $ac_arg" - _AC_COMPILE_IFELSE([], [ac_cv_prog_cxx_$1=$ac_arg]) - test "x$ac_cv_prog_cxx_$1" != "xno" && break -done -rm -f conftest.$ac_ext -CXX=$ac_save_CXX -])# AC_CACHE_VAL -ac_prog_cxx_stdcxx_options= -case "x$ac_cv_prog_cxx_$1" in - x) - AC_MSG_RESULT([none needed]) ;; - xno) - AC_MSG_RESULT([unsupported]) ;; - *) - ac_prog_cxx_stdcxx_options=" $ac_cv_prog_cxx_$1" - CXX=$CXX$ac_prog_cxx_stdcxx_options - AC_MSG_RESULT([$ac_cv_prog_cxx_$1]) ;; -esac -AC_LANG_POP(C++)dnl -AS_IF([test "x$ac_cv_prog_cxx_$1" != xno], [$5], [$6]) -])# _AC_CXX_STD_TRY - -# _AC_CXX_CXX98_TEST_HEADER -# ------------------------- -# A C++ header suitable for testing for CXX98. -AC_DEFUN([_AC_CXX_CXX98_TEST_HEADER], -[[ -#include <algorithm> -#include <cstdlib> -#include <fstream> -#include <iomanip> -#include <iostream> -#include <list> -#include <map> -#include <set> -#include <sstream> -#include <stdexcept> -#include <string> -#include <utility> -#include <vector> - -namespace test { - typedef std::vector<std::string> string_vec; - typedef std::pair<int,bool> map_value; - typedef std::map<std::string,map_value> map_type; - typedef std::set<int> set_type; - - template<typename T> - class printer { - public: - printer(std::ostringstream& os): os(os) {} - void operator() (T elem) { os << elem << std::endl; } - private: - std::ostringstream& os; - }; -} -]])# _AC_CXX_CXX98_TEST_HEADER - -# _AC_CXX_CXX98_TEST_BODY -# ----------------------- -# A C++ body suitable for testing for CXX98, assuming the corresponding header. -AC_DEFUN([_AC_CXX_CXX98_TEST_BODY], -[[ - -try { - // Basic string. - std::string teststr("ASCII text"); - teststr += " string"; - - // Simple vector. - test::string_vec testvec; - testvec.push_back(teststr); - testvec.push_back("foo"); - testvec.push_back("bar"); - if (testvec.size() != 3) { - throw std::runtime_error("vector size is not 1"); - } - - // Dump vector into stringstream and obtain string. - std::ostringstream os; - for (test::string_vec::const_iterator i = testvec.begin(); - i != testvec.end(); ++i) { - if (i + 1 != testvec.end()) { - os << teststr << '\n'; - } - } - // Check algorithms work. - std::for_each(testvec.begin(), testvec.end(), test::printer<std::string>(os)); - std::string os_out = os.str(); - - // Test pair and map. - test::map_type testmap; - testmap.insert(std::make_pair(std::string("key"), - std::make_pair(53,false))); - - // Test set. - int values[] = {9, 7, 13, 15, 4, 18, 12, 10, 5, 3, 14, 19, 17, 8, 6, 20, 16, 2, 11, 1}; - test::set_type testset(values, values + sizeof(values)/sizeof(values[0])); - std::list<int> testlist(testset.begin(), testset.end()); - std::copy(testset.begin(), testset.end(), std::back_inserter(testlist)); -} catch (const std::exception& e) { - std::cerr << "Caught exception: " << e.what() << std::endl; - - // Test fstream - std::ofstream of("test.txt"); - of << "Test ASCII text\n" << std::flush; - of << "N= " << std::hex << std::setw(8) << std::left << 534 << std::endl; - of.close(); -} -std::exit(0); -]]) - -# _AC_CXX_CXX11_TEST_HEADER -# ------------------------- -# A C++ header suitable for testing for CXX11. -AC_DEFUN([_AC_CXX_CXX11_TEST_HEADER], -[[ -#include <deque> -#include <functional> -#include <memory> -#include <tuple> -#include <array> -#include <regex> -#include <iostream> - -namespace cxx11test -{ - typedef std::shared_ptr<std::string> sptr; - typedef std::weak_ptr<std::string> wptr; - - typedef std::tuple<std::string,int,double> tp; - typedef std::array<int, 20> int_array; - - constexpr int get_val() { return 20; } - - struct testinit - { - int i; - double d; - }; - - class delegate { - public: - delegate(int n) : n(n) {} - delegate(): delegate(2354) {} - - virtual int getval() { return this->n; }; - protected: - int n; - }; - - class overridden : public delegate { - public: - overridden(int n): delegate(n) {} - virtual int getval() override final { return this->n * 2; } - }; - - class nocopy { - public: - nocopy(int i): i(i) {} - nocopy() = default; - nocopy(const nocopy&) = delete; - nocopy & operator=(const nocopy&) = delete; - private: - int i; - }; -} -]])# _AC_CXX_CXX11_TEST_HEADER - -# _AC_CXX_CXX11_TEST_BODY -# ----------------------- -# A C++ body suitable for testing for CXX11, assuming the corresponding header. -AC_DEFUN([_AC_CXX_CXX11_TEST_BODY], -[[ -{ - // Test auto and decltype - std::deque<int> d; - d.push_front(43); - d.push_front(484); - d.push_front(3); - d.push_front(844); - int total = 0; - for (auto i = d.begin(); i != d.end(); ++i) { total += *i; } - - auto a1 = 6538; - auto a2 = 48573953.4; - auto a3 = "String literal"; - - decltype(a2) a4 = 34895.034; -} -{ - // Test constexpr - short sa[cxx11test::get_val()] = { 0 }; -} -{ - // Test initialiser lists - cxx11test::testinit il = { 4323, 435234.23544 }; -} -{ - // Test range-based for and lambda - cxx11test::int_array array = {9, 7, 13, 15, 4, 18, 12, 10, 5, 3, 14, 19, 17, 8, 6, 20, 16, 2, 11, 1}; - for (int &x : array) { x += 23; } - std::for_each(array.begin(), array.end(), [](int v1){ std::cout << v1; }); -} -{ - using cxx11test::sptr; - using cxx11test::wptr; - - sptr sp(new std::string("ASCII string")); - wptr wp(sp); - sptr sp2(wp); -} -{ - cxx11test::tp tuple("test", 54, 45.53434); - double d = std::get<2>(tuple); - std::string s; - int i; - std::tie(s,i,d) = tuple; -} -{ - static std::regex filename_regex("^_?([a-z0-9_.]+-)+[a-z0-9]+$"); - std::string testmatch("Test if this string matches"); - bool match = std::regex_search(testmatch, filename_regex); -} -{ - cxx11test::int_array array = {9, 7, 13, 15, 4, 18, 12, 10, 5, 3, 14, 19, 17, 8, 6, 20, 16, 2, 11, 1}; - cxx11test::int_array::size_type size = array.size(); -} -{ - // Test constructor delegation - cxx11test::delegate d1; - cxx11test::delegate d2(); - cxx11test::delegate d3(45); -} -{ - // Test override and final - cxx11test::overridden o1(55464); -} -{ - // Test nullptr - char *c = nullptr; -} -{ - // Test template brackets - std::vector<std::pair<int,char*>> v1; -} -{ - // Unicode literals - char const *utf8 = u8"UTF-8 string \u2500"; - char16_t const *utf16 = u"UTF-8 string \u2500"; - char32_t const *utf32 = U"UTF-32 string \u2500"; -} -]]) - -# _AC_PROG_CXX_CXX98 ([ACTION-IF-AVAILABLE], [ACTION-IF-UNAVAILABLE]) -# ------------------------------------------------------------------- - -# If the C++ compiler is not in ISO C++98 mode by default, try to add -# an option to output variable CXX to make it so. This macro tries -# various options that select ISO C++98 on some system or another. It -# considers the compiler to be in ISO C++98 mode if it handles basic -# features of the std namespace including: string, containers (list, -# map, set, vector), streams (fstreams, iostreams, stringstreams, -# iomanip), pair, exceptions and algorithms. - - -AC_DEFUN([_AC_PROG_CXX_CXX98], -[_AC_CXX_STD_TRY([cxx98], -[_AC_CXX_CXX98_TEST_HEADER], -[_AC_CXX_CXX98_TEST_BODY], -dnl Try -dnl GCC -std=gnu++98 (unused restrictive mode: -std=c++98) -dnl IBM XL C -qlanglvl=extended -dnl HP aC++ -AA -dnl Intel ICC -std=gnu++98 -dnl Solaris N/A (default) -dnl Tru64 N/A (default, but -std gnu could be used) -dnl with extended modes being tried first. -[[-std=gnu++98 -std=c++98 -qlanglvl=extended -AA]], [$1], [$2])[]dnl -])# _AC_PROG_CXX_CXX98 - -# _AC_PROG_CXX_CXX11 ([ACTION-IF-AVAILABLE], [ACTION-IF-UNAVAILABLE]) -# ------------------------------------------------------------------- -# If the C++ compiler is not in ISO CXX11 mode by default, try to add -# an option to output variable CXX to make it so. This macro tries -# various options that select ISO C++11 on some system or another. It -# considers the compiler to be in ISO C++11 mode if it handles all the -# tests from the C++98 checks, plus the following: Language features -# (auto, constexpr, decltype, default/deleted constructors, delegate -# constructors, final, initialiser lists, lambda functions, nullptr, -# override, range-based for loops, template brackets without spaces, -# unicode literals) and library features (array, memory (shared_ptr, -# weak_ptr), regex and tuple types). -AC_DEFUN([_AC_PROG_CXX_CXX11], -[_AC_CXX_STD_TRY([cxx11], -[_AC_CXX_CXX11_TEST_HEADER -_AC_CXX_CXX98_TEST_HEADER], -[_AC_CXX_CXX11_TEST_BODY -_AC_CXX_CXX98_TEST_BODY], -dnl Try -dnl GCC -std=gnu++11 (unused restrictive mode: -std=c++11) [and 0x variants] -dnl IBM XL C -qlanglvl=extended0x -dnl (pre-V12.1; unused restrictive mode: -qlanglvl=stdcxx11) -dnl HP aC++ -AA -dnl Intel ICC -std=c++11 -std=c++0x -dnl Solaris N/A (no support) -dnl Tru64 N/A (no support) -dnl with extended modes being tried first. -[[-std=gnu++11 -std=c++11 -std=gnu++0x -std=c++0x -qlanglvl=extended0x -AA]], [$1], [$2])[]dnl -])# _AC_PROG_CXX_CXX11
--- a/oct-py-error.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,84 +0,0 @@ -/* - -Copyright (C) 2017 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> -#include <octave/error.h> - -#include "oct-py-error.h" -#include "oct-py-eval.h" -#include "oct-py-object.h" -#include "oct-py-types.h" - -namespace pytave -{ - - void - error_conversion_invalid_python_object (const std::string& to) - { - error ("unable to convert to %s, invalid Python object", to.c_str ()); - } - - void - error_conversion_mismatch_python_type (const std::string& to, - const std::string& must) - { - error ("unable to convert to %s, must be a Python %s", to.c_str (), - must.c_str ()); - } - - void - error_python_exception () - { - const char *format_exception_only = "traceback.format_exception_only"; - - PyObject *ptype, *pvalue, *ptraceback; - PyErr_Fetch (&ptype, &pvalue, &ptraceback); - PyErr_NormalizeException (&ptype, &pvalue, &ptraceback); - - python_object args = PyTuple_Pack (2, ptype, pvalue); - python_object lines = py_call_function (format_exception_only, args); - - if (lines && PySequence_Check (lines)) - { - Py_ssize_t len = PySequence_Size (lines); - python_object last_line = PySequence_GetItem (lines, len - 1); - - std::string msg = extract_py_str (last_line); - if (msg.back () == '\n') - msg.resize (msg.size () - 1); - - error ("%s", msg.c_str ()); - } - else - { - PyErr_Restore (ptype, pvalue, ptraceback); - PyErr_Print (); - error ("runtime failed to get exception information from %s", - format_exception_only); - } - } - -}
--- a/oct-py-error.h Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,54 +0,0 @@ -/* - -Copyright (C) 2017 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if ! defined (pytave_oct_py_error_h) -#define pytave_oct_py_error_h 1 - -#include <string> - -#if defined (__GNUC__) -# define PYTAVE_ATTR_NORETURN __attribute__((__noreturn__)) -#else -# define PYTAVE_ATTR_NORETURN -#endif - -namespace pytave -{ - - void - error_conversion_invalid_python_object (const std::string& to) - PYTAVE_ATTR_NORETURN; - - void - error_conversion_mismatch_python_type (const std::string& to, - const std::string& must) - PYTAVE_ATTR_NORETURN; - - void - error_python_exception () - PYTAVE_ATTR_NORETURN; - -} - -#undef PYTAVE_ATTR_NORETURN - -#endif
--- a/oct-py-eval.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,139 +0,0 @@ -/* - -Copyright (C) 2016 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> -#include <string> -#include <octave/ov.h> -#include <octave/ovl.h> - -#include "oct-py-error.h" -#include "oct-py-eval.h" -#include "oct-py-object.h" -#include "oct-py-util.h" -#include "oct-py-types.h" - -namespace pytave -{ - - PyObject * - py_call_function (const std::string& func, const octave_value_list& args) - { - python_object func_obj = py_find_function (func); - python_object retval = py_call_function (func_obj, args); - return retval.release (); - } - - PyObject * - py_call_function (const std::string& func, PyObject *args, PyObject *kwargs) - { - python_object func_obj = py_find_function (func); - python_object retval = py_call_function (func_obj, args, kwargs); - return retval.release (); - } - - PyObject * - py_call_function (PyObject *callable, const octave_value_list& args) - { - python_object kwargs; - python_object args_list = PyList_New (0); - if (! args_list) - octave_throw_bad_alloc (); - - for (int i = 0; i < args.length (); ++i) - { - python_object obj = py_implicitly_convert_argument (args(i)); - - if (pytave::is_py_kwargs_argument (obj)) - kwargs = pytave::update_py_dict (kwargs, obj); - else - PyList_Append (args_list, obj.release ()); - } - - python_object args_tuple = PyList_AsTuple (args_list); - - python_object retval = py_call_function (callable, args_tuple, kwargs); - - return retval.release (); - } - - PyObject * - py_call_function (PyObject *callable, PyObject *args, PyObject *kwargs) - { - python_object retval = PyEval_CallObjectWithKeywords (callable, args, kwargs); - if (! retval) - error_python_exception (); - - return retval.release (); - } - - PyObject * - py_run_string_safe (const std::string& expr, int start, PyObject *globals, - PyObject *locals) - { - bool alloc = false; - - if (! globals || (globals == Py_None)) - { - python_object main = py_import_module ("__main__"); - globals = PyModule_GetDict (main); - if (! globals) - { - globals = PyDict_New (); - alloc = true; - } - } - - if (! locals || (locals == Py_None)) - locals = globals; - - // Evaluate all expressions under "from __future__ import print_function" - PyCompilerFlags flags { CO_FUTURE_PRINT_FUNCTION }; - - python_object retval = PyRun_StringFlags (expr.c_str (), start, globals, locals, - &flags); - - if (alloc) - Py_DECREF (globals); - - if (! retval) - error_python_exception (); - - return retval.release (); - } - - PyObject * - py_eval_string (const std::string& expr, PyObject *globals, PyObject *locals) - { - return py_run_string_safe (expr, Py_eval_input, globals, locals); - } - - PyObject * - py_exec_string (const std::string& expr, PyObject *globals, PyObject *locals) - { - return py_run_string_safe (expr, Py_file_input, globals, locals); - } - -}
--- a/oct-py-eval.h Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,92 +0,0 @@ -/* - -Copyright (C) 2016 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if ! defined (pytave_oct_py_eval_h) -#define pytave_oct_py_eval_h 1 - -#include <Python.h> -#include <string> - -class octave_value_list; - -namespace pytave -{ - - //! Call a Python function by name with the given argument list. - //! - //! The @a func string may be the name of a builtin function or of a function - //! in a loadable module in the form @c module.function. - //! - //! If @a args contains one or more values created by the @c pyargs function, - //! they are automatically interpreted as keyword arguments. - //! - //! @param func name of a Python function - //! @param args Octave argument list to be converted and passed to @a func - //! @return return value of @a func - PyObject * - py_call_function (const std::string& func, const octave_value_list& args); - - //! Call a Python function by name with arguments and keyword arguments. - //! - //! The @a func string may be the name of a builtin function or of a function - //! in a loadable module in the form @c module.function. - //! - //! @param func name of a Python function - //! @param args tuple of positional arguments - //! @param kwargs dictionary of keyword arguments - //! @return return value of @a func - PyObject * - py_call_function (const std::string& func, PyObject *args, - PyObject *kwargs = nullptr); - - //! Call a Python function with the given argument list. - //! - //! If @a args contains one or more values created by the @c pyargs function, - //! they are automatically interpreted as keyword arguments. - //! - //! @param callable Python function or other callable object - //! @param args Octave argument list to be converted and passed to @a func - //! @return return value of @a func - PyObject * - py_call_function (PyObject *callable, const octave_value_list& args); - - //! Call a Python function with arguments and keyword arguments. - //! - //! @param callable Python function or other callable object - //! @param args tuple of positional arguments - //! @param kwargs dictionary of keyword arguments - //! @return return value of @a func - PyObject * - py_call_function (PyObject *callable, PyObject *args, - PyObject *kwargs = nullptr); - - PyObject * - py_eval_string (const std::string& expr, PyObject *globals = nullptr, - PyObject *locals = nullptr); - - PyObject * - py_exec_string (const std::string& expr, PyObject *globals = nullptr, - PyObject *locals = nullptr); - -} - -#endif
--- a/oct-py-init.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,53 +0,0 @@ -/* - -Copyright (C) 2017 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> - -#include "oct-py-init.h" - -namespace pytave -{ - -#if PY_VERSION_HEX >= 0x03000000 - static wchar_t sys_argv0[] {L'\0'}; - static wchar_t *sys_argv[] {sys_argv0, nullptr}; -#else - static char sys_argv0[] {'\0'}; - static char *sys_argv[] {sys_argv0, nullptr}; -#endif - - void - py_init () - { - bool is_initialized = Py_IsInitialized (); - - Py_Initialize (); - - if (! is_initialized) - PySys_SetArgvEx (1, sys_argv, 0); - } - -}
--- a/oct-py-init.h Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,35 +0,0 @@ -/* - -Copyright (C) 2017 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if ! defined (pytave_oct_py_init_h) -#define pytave_oct_py_init_h 1 - -namespace pytave -{ - - //! Initialize the Python interpreter and execution environment. - void - py_init (); - -} - -#endif
--- a/oct-py-object.h Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,110 +0,0 @@ -/* - -Copyright (C) 2017 Abhinav Tripathi - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if ! defined (pytave_oct_py_object_h) -#define pytave_oct_py_object_h 1 - -#include <Python.h> - -namespace pytave -{ - - class python_object - { - public: - python_object (PyObject *obj = nullptr) - { - pyobj = obj; - isowned = pyobj != nullptr; - } - - python_object (const python_object& oth) - { - pyobj = oth.pyobj; - isowned = oth.isowned; - if (isowned) - Py_INCREF (pyobj); - } - - ~python_object () - { - if (isowned) - Py_DECREF (pyobj); - } - - python_object& - operator = (const python_object& oth) - { - if (isowned) - Py_DECREF (pyobj); - pyobj = oth.pyobj; - isowned = oth.isowned; - if (isowned) - Py_INCREF (pyobj); - return *this; - } - - python_object& - operator = (PyObject *obj) - { - if (isowned) - Py_DECREF (pyobj); - pyobj = obj; - isowned = pyobj != nullptr; - if (isowned) - Py_INCREF (pyobj); - return *this; - } - - operator bool () const - { - return isowned; - } - - operator PyObject * () - { - return pyobj; - } - - bool - is_none () const - { - return pyobj && pyobj == Py_None; - } - - PyObject * - release () - { - isowned = false; - PyObject *ret = pyobj; - pyobj = nullptr; - return ret; - } - - private: - PyObject *pyobj; - bool isowned; - }; - -} - -#endif
--- a/oct-py-types.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,538 +0,0 @@ -/* - -Copyright (C) 2016 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> -#include <limits> -#include <octave/Cell.h> -#include <octave/oct-map.h> -#include <octave/quit.h> -#include <octave/ov-null-mat.h> - -#include "oct-py-error.h" -#include "oct-py-eval.h" -#include "oct-py-object.h" -#include "oct-py-types.h" -#include "oct-py-util.h" - -namespace pytave -{ - - PyObject * - make_py_bool (bool value) - { - python_object retval = value ? Py_True : Py_False; - Py_INCREF (retval); - return retval.release (); - } - - PyObject * - make_py_complex (std::complex<double> value) - { - Py_complex py_complex_value {value.real (), value.imag ()}; - return PyComplex_FromCComplex (py_complex_value); - } - - PyObject * - make_py_float (double value) - { - return PyFloat_FromDouble (value); - } - - bool - extract_py_bool (PyObject *obj) - { - if (! obj) - error_conversion_invalid_python_object ("a boolean value"); - - if (! PyBool_Check (obj)) - error_conversion_mismatch_python_type ("a boolean value", "bool"); - - return (obj == Py_True); - } - - std::complex<double> - extract_py_complex (PyObject *obj) - { - if (! obj) - error_conversion_invalid_python_object ("a complex value"); - - if (! PyComplex_Check (obj)) - error_conversion_mismatch_python_type ("a complex value", "complex"); - - Py_complex value = PyComplex_AsCComplex (obj); - return std::complex<double> {value.real, value.imag}; - } - - double - extract_py_float (PyObject *obj) - { - if (! obj) - error_conversion_invalid_python_object ("a floating point value"); - - if (! PyFloat_Check (obj)) - error_conversion_mismatch_python_type ("a floating point value", "float"); - - return PyFloat_AsDouble (obj); - } - - PyObject * - make_py_int (int32_t value) - { -#if PY_VERSION_HEX >= 0x03000000 - return PyLong_FromLong (value); -#else - return PyInt_FromLong (value); -#endif - } - - PyObject * - make_py_int (uint32_t value) - { - return PyLong_FromUnsignedLong (value); - } - - PyObject * - make_py_int (int64_t value) - { -#if (defined (HAVE_LONG_LONG) && (SIZEOF_LONG_LONG > SIZEOF_LONG)) - return PyLong_FromLongLong (value); -#else - return PyLong_FromLong (value); -#endif - } - - PyObject * - make_py_int (uint64_t value) - { -#if (defined (HAVE_LONG_LONG) && (SIZEOF_LONG_LONG > SIZEOF_LONG)) - return PyLong_FromUnsignedLongLong (value); -#else - return PyLong_FromUnsignedLong (value); -#endif - } - - PyObject * - make_py_array (const void *data, size_t len, char typecode) - { - if (! typecode) - error ("unable to create array, invalid array type code"); - - std::string arg { typecode }; - python_object array = py_call_function ("array.array", ovl (arg)); - - if (len > 0) - { - // create a byte buffer containing a copy of the array binary data - const char *cdata = reinterpret_cast<const char *> (data); - python_object buf = PyBytes_FromStringAndSize (cdata, len); - if (! buf) - octave_throw_bad_alloc (); - - PyObject *frombytes = (PyObject_HasAttrString (array, "frombytes") ? - PyObject_GetAttrString (array, "frombytes") : - PyObject_GetAttrString (array, "fromstring")); - python_object args = PyTuple_Pack (1, buf.release ()); - py_call_function (frombytes, args); - } - - return array.release (); - } - - // Prefer the 'q' and 'Q' typecodes if they are available (if Python 3 and - // built with support for long long integers) - -#if (PY_VERSION_HEX >= 0x03000000) && defined (HAVE_LONG_LONG) -# define ARRAY_INT64_TYPECODE 'q' -# define ARRAY_UINT64_TYPECODE 'Q' -#elif (SIZEOF_LONG == 8) -# define ARRAY_INT64_TYPECODE 'l' -# define ARRAY_UINT64_TYPECODE 'L' -#else -# define ARRAY_INT64_TYPECODE 0 -# define ARRAY_UINT64_TYPECODE 0 -#endif - - template <typename T> - struct py_array_info { }; - - template <> - struct py_array_info<octave_int8> { static const char typecode = 'b'; }; - - template <> - struct py_array_info<octave_int16> { static const char typecode = 'h'; }; - - template <> - struct py_array_info<octave_int32> { static const char typecode = 'i'; }; - - template <> - struct py_array_info<octave_int64> - { - static const char typecode = ARRAY_INT64_TYPECODE; - }; - - template <> - struct py_array_info<octave_uint8> { static const char typecode = 'B'; }; - - template <> - struct py_array_info<octave_uint16> { static const char typecode = 'H'; }; - - template <> - struct py_array_info<octave_uint32> { static const char typecode = 'I'; }; - - template <> - struct py_array_info<octave_uint64> { - static const char typecode = ARRAY_UINT64_TYPECODE; - }; - - PyObject * - make_py_array (const NDArray& nda) - { - return make_py_array (nda.data (), nda.numel () * sizeof (double), 'd'); - } - - PyObject * - make_py_array (const FloatNDArray& nda) - { - return make_py_array (nda.data (), nda.numel () * sizeof (float), 'f'); - } - - template <typename T> - PyObject * - make_py_array (const intNDArray<T>& nda) - { - return make_py_array (nda.data (), nda.numel () * sizeof (T), - py_array_info<T>::typecode); - } - - // Instantiate all possible integer array template functions needed - - template PyObject * make_py_array<octave_int8> (const int8NDArray&); - template PyObject * make_py_array<octave_int16> (const int16NDArray&); - template PyObject * make_py_array<octave_int32> (const int32NDArray&); - template PyObject * make_py_array<octave_int64> (const int64NDArray&); - template PyObject * make_py_array<octave_uint8> (const uint8NDArray&); - template PyObject * make_py_array<octave_uint16> (const uint16NDArray&); - template PyObject * make_py_array<octave_uint32> (const uint32NDArray&); - template PyObject * make_py_array<octave_uint64> (const uint64NDArray&); - - PyObject * - make_py_numeric_value (const octave_value& value) - { - if (! value.is_scalar_type ()) - error ("unable to convert non-scalar type \"%s\" to a Python number", - value.type_name ().c_str ()); - - if (value.is_bool_type ()) - return make_py_bool (value.bool_value ()); - - else if (value.is_int8_type ()) - return make_py_int (value.int8_scalar_value ().value ()); - else if (value.is_int16_type ()) - return make_py_int (value.int16_scalar_value ().value ()); - else if (value.is_int32_type ()) - return make_py_int (value.int32_scalar_value ().value ()); - else if (value.is_int64_type ()) - return make_py_int (value.int64_scalar_value ().value ()); - - else if (value.is_uint8_type ()) - return make_py_int (value.uint8_scalar_value ().value ()); - else if (value.is_uint16_type ()) - return make_py_int (value.uint16_scalar_value ().value ()); - else if (value.is_uint32_type ()) - return make_py_int (value.uint32_scalar_value ().value ()); - else if (value.is_uint64_type ()) - return make_py_int (value.uint64_scalar_value ().value ()); - - else if (value.is_complex_type ()) - return make_py_complex (value.complex_value ()); - else if (value.is_float_type ()) - return make_py_float (value.double_value ()); - else - error ("unable to convert unhandled scalar type \"%s\" to a " - "Python number", value.type_name ().c_str ()); - - return nullptr; - } - - PyObject * - make_py_array (const octave_value& value) - { - if (! (value.is_numeric_type () && ! value.is_complex_type () - && value.ndims () == 2 - && (value.columns () <= 1 || value.rows () <= 1))) - error ("unable to convert non-vector type \"%s\" to a Python array", - value.type_name ().c_str ()); - - if (value.is_double_type ()) - return make_py_array (value.array_value ()); - else if (value.is_single_type ()) - return make_py_array (value.float_array_value ()); - - else if (value.is_int8_type ()) - return make_py_array (value.int8_array_value ()); - else if (value.is_int16_type ()) - return make_py_array (value.int16_array_value ()); - else if (value.is_int32_type ()) - return make_py_array (value.int32_array_value ()); - else if (value.is_int64_type ()) - return make_py_array (value.int64_array_value ()); - - else if (value.is_uint8_type ()) - return make_py_array (value.uint8_array_value ()); - else if (value.is_uint16_type ()) - return make_py_array (value.uint16_array_value ()); - else if (value.is_uint32_type ()) - return make_py_array (value.uint32_array_value ()); - else if (value.is_uint64_type ()) - return make_py_array (value.uint64_array_value ()); - else - error ("unable to convert unhandled vector type \"%s\" to a " - "Python array", value.type_name ().c_str ()); - - return nullptr; - } - - octave_scalar_map - extract_py_scalar_map (PyObject *obj) - { - if (! obj) - error_conversion_invalid_python_object ("an Octave struct"); - - if (! PyDict_Check (obj)) - error_conversion_mismatch_python_type ("an Octave struct", "dict"); - - octave_scalar_map map; - - Py_ssize_t pos = 0; - PyObject *py_key = nullptr; - PyObject *py_value = nullptr; - - while (PyDict_Next (obj, &pos, &py_key, &py_value)) - { - if (! PyBytes_Check (py_key) && ! PyUnicode_Check (py_key)) - error ("unable to convert Python dict to Octave struct, " - "all keys in the dict must be strings"); - - std::string key = extract_py_str (py_key); - octave_value value = py_implicitly_convert_return_value (py_value); - map.setfield (key, value); - } - - return map; - } - - PyObject * - make_py_dict (const octave_scalar_map& map) - { - PyObject *dict = PyDict_New (); - if (! dict) - octave_throw_bad_alloc (); - - for (auto p = map.begin (); p != map.end (); ++p) - { - PyObject *key = make_py_str (map.key (p)); - if (! key) - octave_throw_bad_alloc (); - - PyObject *item = py_implicitly_convert_argument (map.contents (p)); - - if (PyDict_SetItem (dict, key, item) < 0) - error_python_exception (); - } - - return dict; - } - - int64_t - extract_py_int64 (PyObject *obj) - { - if (! obj) - error_conversion_invalid_python_object ("a signed integer value"); - - if (PyLong_Check (obj)) - { - int overflow = 0; -#if (defined (HAVE_LONG_LONG) && (SIZEOF_LONG_LONG == 8)) - PY_LONG_LONG value = PyLong_AsLongLongAndOverflow (obj, &overflow); -#else - long value = PyLong_AsLongAndOverflow (obj, &overflow); -#endif - if (overflow) - { - if (overflow > 0) - value = std::numeric_limits<int64_t>::max (); - else - value = std::numeric_limits<int64_t>::min (); - } - return static_cast<int64_t> (value); - } -#if PY_VERSION_HEX < 0x03000000 - else if (PyInt_Check (obj)) - return PyInt_AsLong (obj); -#endif - else - error_conversion_mismatch_python_type ("a signed integer value", - "int or long"); - - return 0; - } - - uint64_t - extract_py_uint64 (PyObject *obj) - { - if (! obj) - error_conversion_invalid_python_object ("an unsigned integer value"); - - if (PyLong_Check (obj)) - { - // FIXME: if (value < 0), may be very implementation dependent - if (Py_SIZE (obj) < 0) - return 0; - -#if (defined (HAVE_LONG_LONG) && (SIZEOF_LONG_LONG == 8)) - unsigned PY_LONG_LONG value = PyLong_AsUnsignedLongLong (obj); - bool overflow = (value == static_cast<unsigned PY_LONG_LONG> (-1)); -#else - unsigned long value = PyLong_AsUnsignedLong (obj); - bool overflow = (value == static_cast<unsigned long> (-1)); -#endif - if (overflow) - { - value = std::numeric_limits<uint64_t>::max (); - PyErr_Clear (); - } - - return static_cast<uint64_t> (value); - } -#if PY_VERSION_HEX < 0x03000000 - else if (PyInt_Check (obj)) - return static_cast<uint64_t> (PyInt_AsLong (obj)); -#endif - else - error_conversion_mismatch_python_type ("an unsigned integer value", - "int or long"); - - return 0; - } - - PyObject * - make_py_tuple (const Cell& cell) - { - if (! (cell.is_empty () || cell.is_vector ())) - error ("unable to convert multidimensional cell array to a Python tuple"); - - octave_idx_type size = cell.numel (); - PyObject *tuple = PyTuple_New (size); - if (! tuple) - octave_throw_bad_alloc (); - - for (octave_idx_type i = 0; i < size; ++i) - { - PyObject *item = py_implicitly_convert_argument (cell.xelem (i)); - PyTuple_SET_ITEM (tuple, i, item); - } - - return tuple; - } - - std::string - extract_py_str (PyObject *obj) - { - std::string retval; - - if (! obj) - error_conversion_invalid_python_object ("a string value"); - - if (PyBytes_Check (obj)) - { - retval.assign (PyBytes_AsString (obj), PyBytes_Size (obj)); - } - else if (PyUnicode_Check (obj)) - { - python_object enc = PyUnicode_AsUTF8String (obj); - if (enc && PyBytes_Check (enc)) - retval.assign (PyBytes_AsString (enc), PyBytes_Size (enc)); - else - octave_throw_bad_alloc (); - } - else - error_conversion_mismatch_python_type ("a string value", "str"); - - return retval; - } - - PyObject * - make_py_str (const std::string& str) - { -#if PY_VERSION_HEX >= 0x03000000 - return PyUnicode_FromStringAndSize (str.data (), str.size ()); -#else - return PyString_FromStringAndSize (str.data (), str.size ()); -#endif - } - - PyObject * - py_implicitly_convert_argument (const octave_value& value) - { - if (value.is_object () && value.class_name () == "pyobject") - return pyobject_unwrap_object (value); - else if (value.is_string () && value.rows () > 1) - error ("unable to convert multirow char array to a Python object"); - else if (value.is_string ()) - return make_py_str (value.string_value ()); - else if (value.is_scalar_type ()) - return make_py_numeric_value (value); - else if (value.is_cell ()) - return make_py_tuple (value.cell_value ()); - else if (value.is_numeric_type () && value.ndims () == 2 - && (value.columns () <= 1 || value.rows () <= 1)) - return make_py_array (value); - else if (value.is_map () && value.numel () == 1) - return make_py_dict (value.scalar_map_value ()); - else - error ("unable to convert unhandled Octave type to a Python object"); - - return nullptr; - } - - octave_value - py_implicitly_convert_return_value (PyObject *obj) - { - if (PyBool_Check (obj)) - return octave_value {extract_py_bool (obj)}; -#if PY_VERSION_HEX < 0x03000000 - else if (PyInt_Check (obj)) - return octave_value {octave_int64 (extract_py_int64 (obj))}; -#endif - else if (PyComplex_Check (obj)) - return octave_value {extract_py_complex (obj)}; - else if (PyFloat_Check (obj)) - return octave_value {extract_py_float (obj)}; - else - return pyobject_wrap_object (obj); - } - -}
--- a/oct-py-types.h Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,268 +0,0 @@ -/* - -Copyright (C) 2016 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if ! defined (pytave_oct_py_types_h) -#define pytave_oct_py_types_h 1 - -#include <Python.h> -#include <complex> -#include <string> - -class Cell; -class FloatNDArray; -class NDArray; -template <typename T> class intNDArray; -class octave_scalar_map; -class octave_value; - -namespace pytave -{ - - //! Extract the integer value of the given Python bool object. - //! - //! @param obj Python bool object - //! @return @c true or @c false value of @a obj - bool - extract_py_bool (PyObject *obj); - - //! Create a Python bool object with the value of the given @c bool value. - //! - //! @param value @c true or @c false value - //! @return Python bool object - PyObject * - make_py_bool (bool value); - - //! Extract the complex value of the given Python complex object. - //! - //! @param obj Python complex object - //! @return complex value of @a obj - std::complex<double> - extract_py_complex (PyObject *obj); - - //! Create a Python complex object with the value of the given @c complex - //! value. - //! - //! @param value complex value - //! @return Python complex object - PyObject * - make_py_complex (std::complex<double> value); - - //! Extract the floating point value of the given Python float object. - //! - //! @param obj Python float object - //! @return floating point value of @a obj - double - extract_py_float (PyObject *obj); - - //! Create a Python float object with the value of the given @c double value. - //! - //! @param value floating point value - //! @return Python float object - PyObject * - make_py_float (double value); - - //! Extract an Octave scalar map from the given Python dict object. - //! - //! @param obj Python dict object - //! @return Octave scalar map containing the items of @a obj - octave_scalar_map - extract_py_scalar_map (PyObject *obj); - - //! Create a Python dict object from the given Octave scalar map value. - //! - //! The values contained in the map are recursively converted to appropriate - //! Python values. - //! - //! @param map Octave scalar map - //! @return Python dict object - PyObject * - make_py_dict (const octave_scalar_map& map); - - //! Extract the integer value of the given Python int or long object. - //! - //! @param obj Python int or long object - //! @return integer value of @a obj - int64_t - extract_py_int64 (PyObject *obj); - - //! Extract the integer value of the given Python int or long object. - //! - //! @param obj Python int or long object - //! @return integer value of @a obj - uint64_t - extract_py_uint64 (PyObject *obj); - - //! Create a Python int object with the value of the given @c int32_t value. - //! - //! @param value integer value - //! @return Python int or long object - PyObject * - make_py_int (int32_t value); - - //! Create a Python int object with the value of the given @c uint32_t value. - //! - //! @param value integer value - //! @return Python int or long object - PyObject * - make_py_int (uint32_t value); - - //! Create a Python int object with the value of the given @c int64_t value. - //! - //! @param value integer value - //! @return Python int or long object - PyObject * - make_py_int (int64_t value); - - //! Create a Python int object with the value of the given @c uint64_t value. - //! - //! @param value integer value - //! @return Python int or long object - PyObject * - make_py_int (uint64_t value); - - //! Create a Python array object with the value of the given Octave array. - //! - //! @param nda array value - //! @return Python array object - PyObject * - make_py_array (const NDArray& nda); - - //! Create a Python array object with the value of the given Octave array. - //! - //! @param nda array value - //! @return Python array object - PyObject * - make_py_array (const FloatNDArray& nda); - - //! Create a Python array object with the value of the given Octave array. - //! - //! @param nda array value - //! @return Python array object - template <typename T> - PyObject * - make_py_array (const intNDArray<T>& nda); - - //! Create a Python array object from the given Octave numeric vector. - //! - //! All Octave real floating point and integer values are converted to - //! corresponding Python array types by this function. - //! - //! @warning Depending on the version of Python and how it is configured, - //! @c int64 and @c uint64 vectors may not be supported. - //! - //! @param value Octave numeric or boolean scalar value - //! @return Python array object - PyObject * - make_py_array (const octave_value& value); - - //! Create a Python tuple object from the given Octave cell array value. - //! - //! The values contained in the cell array are recursively converted to - //! appropriate Python values. - //! - //! @param cell Octave cell array - //! @return Python tuple object - PyObject * - make_py_tuple (const Cell& cell); - - //! Create a Python numeric object from the given Octave numeric or boolean - //! scalar value. - //! - //! The following implicit type conversions are implemented by this function: - //! - //! @arg @c bool from Octave logical scalar, - //! @arg @c complex from Octave double or single precision complex scalar, - //! @arg @c float from Octave double or single precision scalar, - //! @arg @c int from any Octave integer-valued scalar, - //! @arg @c long from any Octave @c uint32, @c int64, or @c uint64, and only - //! if running against Python 2. - //! - //! @param value Octave numeric or boolean scalar value - //! @return Python numeric object (@c bool, @c int, @c long, @c float, or - //! @c complex) - PyObject * - make_py_numeric_value (const octave_value& value); - - //! Extract the string value of the given Python str, bytes, or unicode - //! object. - //! - //! @param obj Python str, bytes, or unicode object - //! @return string value of @a obj - std::string - extract_py_str (PyObject *obj); - - //! Create a Python str object from the given @c string value. - //! - //! @param str string value - //! @return Python str object - PyObject * - make_py_str (const std::string& str); - - //! Perform an implicit conversion of the given Octave @c value to a Python - //! argument. - //! - //! The following implicit type conversions are implemented by this function: - //! - //! @arg @c bool from Octave logical scalar, - //! @arg @c complex from Octave double or single precision complex scalar, - //! @arg @c float from Octave double or single precision scalar, - //! @arg @c int from any Octave integer-valued scalar, - //! @arg @c long from Octave @c uint32, @c int64, or @c uint64, and only if - //! running against Python 2, - //! @arg @c str from Octave string (@c char row vector), - //! @arg @c array.array from Octave numeric column or row vector, - //! @arg @c dict from Octave scalar map (consisting entirely of implicitly - //! convertible elements), - //! @arg @c tuple from Octave cell array (consisting entirely of implicitly - //! convertible elements). - //! - //! If @c value refers to a previously created Python object, then a reference - //! to the existing object is returned. - //! - //! Otherwise, a conversion error is raised. - //! - //! @param value Octave value - //! @return Python object - PyObject * - py_implicitly_convert_argument (const octave_value& value); - - //! Perform an implicit conversion of the given Python object to an Octave - //! return value. - //! - //! The following implicit type conversions are implemented by this function: - //! - //! @arg @c logical scalar from Python @c bool, - //! @arg @c complex @c double from Python @c complex, - //! @arg @c double from Python @c float, - //! @arg @c int64 from Python @c int, only if running against Python 2. - //! - //! Otherwise, @c obj is left unconverted, a reference is maintained to it, - //! and an Octave value containing that reference is returned. - //! - //! @param obj Python object - //! @return Octave value - octave_value - py_implicitly_convert_return_value (PyObject *obj); - -} - -#endif
--- a/oct-py-util.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,259 +0,0 @@ -/* - -Copyright (C) 2016 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> -#include <octave/oct.h> -#include <octave/parse.h> - -#include "oct-py-error.h" -#include "oct-py-object.h" -#include "oct-py-types.h" -#include "oct-py-util.h" - -namespace pytave -{ - - inline std::string - py_builtins_module_name () - { -#if PY_VERSION_HEX >= 0x03000000 - return "builtins"; -#else - return "__builtin__"; -#endif - } - - PyObject * - py_builtins_module () - { - return py_import_module (py_builtins_module_name ()); - } - - PyObject * - py_find_function (PyObject *module, const std::string& name) - { - if (module && PyModule_Check (module)) - { - PyObject *obj = PyObject_GetAttrString (module, name.c_str ()); - if (obj && ! PyCallable_Check (obj)) - { - Py_CLEAR (obj); - } - - return obj; - } - - return 0; - } - - PyObject * - py_find_function (const std::string& module, const std::string& name) - { - python_object mod = py_import_module (module); - PyObject *func = py_find_function (mod, name); - return func; - } - - PyObject * - py_find_function (const std::string& name) - { - std::string::size_type idx = name.rfind ("."); - if (idx == std::string::npos) - { - PyObject *func = py_find_function ("__main__", name); - if (! func) - func = py_find_function (py_builtins_module (), name); - return func; - } - else - { - std::string module = name.substr (0, idx); - std::string function = name.substr (idx + 1); - return py_find_function (module, function); - } - } - - PyObject * - py_find_type (const std::string& name) - { - python_object obj = py_find_function (name); - if (obj && PyType_Check (obj)) - return obj.release (); - - return 0; - } - - PyObject * - py_import_module (const std::string& name) - { - return PyImport_ImportModule (name.c_str ()); - } - - bool - py_isinstance (PyObject *obj, PyObject *type) - { - if (obj && type) - return static_cast<bool> (PyObject_IsInstance (obj, type)); - - return false; - } - - std::string - py_object_class_name (PyObject *obj) - { - std::string retval; - - python_object type = obj ? PyObject_GetAttrString (obj, "__class__") : 0; - if (type) - { - python_object mod = PyObject_GetAttrString (type, "__module__"); - - python_object name; - if (PyObject_HasAttrString (type, "__qualname__")) - name = PyObject_GetAttrString (type, "__qualname__"); - else - name = PyObject_GetAttrString (type, "__name__"); - - std::string mod_str = !mod.is_none () ? extract_py_str (mod) : ""; - std::string name_str = name ? extract_py_str (name) : ""; - - if (mod_str.empty () || mod_str == py_builtins_module_name ()) - retval = name_str; - else - retval = mod_str + "." + name_str; - } - - return retval; - } - - // FIXME: could make this into a class/singleton wrapper a la Octave core - PyObject *objstore = nullptr; - - inline PyObject * - py_objstore () - { - if (! objstore) - { - python_object main = py_import_module ("__main__"); - python_object ns = main ? PyObject_GetAttrString (main, "__dict__") : 0; - PyObject *dict = ns ? PyDict_GetItemString (ns, "_in_octave") : 0; - - if (dict) - Py_INCREF (dict); - - if (! dict) - { - dict = PyDict_New (); - if (dict && ns) - PyDict_SetItemString (ns, "_in_octave", dict); - } - - if (! dict) - error_python_exception (); - - objstore = dict; - } - return objstore; - } - - void - py_objstore_del (uint64_t key) - { - python_object store = py_objstore (); - python_object key_obj = make_py_int (key); - python_object key_fmt = PyNumber_ToBase (key_obj, 16); - PyDict_DelItem (store, key_fmt); - store.release (); - } - - PyObject * - py_objstore_get (uint64_t key) - { - python_object store = py_objstore (); - python_object key_obj = make_py_int (key); - python_object key_fmt = PyNumber_ToBase (key_obj, 16); - PyObject *obj = PyDict_GetItem (store, key_fmt); - store.release (); - if (obj) - Py_INCREF (obj); - return obj; - } - - uint64_t - py_objstore_put (PyObject *obj) - { - python_object store = py_objstore (); - uint64_t key = reinterpret_cast<uint64_t> (obj); - python_object key_obj = make_py_int (key); - python_object key_fmt = PyNumber_ToBase (key_obj, 16); - PyDict_SetItem (store, key_fmt, obj); - store.release (); - return key; - } - - octave_value - pyobject_wrap_object (PyObject *obj) - { - uint64_t key = py_objstore_put (obj); - octave_value_list out = feval ("pyobject", ovl (0, octave_uint64 (key)), 1); - return out(0); - } - - PyObject * - pyobject_unwrap_object (const octave_value& value) - { - if (value.is_object () && value.class_name () == "pyobject") - { - octave_value_list out = feval ("id", ovl (value), 1); - uint64_t key = out(0).uint64_scalar_value (); - return py_objstore_get (key); - } - - return 0; - } - - bool - is_py_kwargs_argument (PyObject *obj) - { - if (obj && py_object_class_name (obj) == "__main__._OctaveKwargs" - && PyObject_HasAttrString (obj, "is_kwargs_argument")) - { - PyObject *flag = PyObject_GetAttrString (obj, "is_kwargs_argument"); - if (flag && PyBool_Check (flag) && PyObject_IsTrue (flag)) - return true; - } - return false; - } - - PyObject * - update_py_dict (PyObject *dict_orig, PyObject *dict_new) - { - PyObject *dict = dict_orig ? dict_orig : PyDict_New (); - PyDict_Update (dict, dict_new); - return dict; - } - -}
--- a/oct-py-util.h Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,124 +0,0 @@ -/* - -Copyright (C) 2016 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if ! defined (pytave_oct_py_util_h) -#define pytave_oct_py_util_h 1 - -#include <Python.h> -#include <stdint.h> -#include <string> - -class octave_value; - -namespace pytave -{ - - //! Return a reference to the builtins module. - //! - //! @return reference to the builtins module - PyObject * - py_builtins_module (); - - //! Return a reference to the named function in the given module. - //! - //! @param module module to find the function in - //! @param name name of the function - //! @return a reference to the function, or a null pointer - PyObject * - py_find_function (PyObject *module, const std::string& name); - - //! Return a reference to the named function in the given module. - //! - //! @param module name of the module to find the function in - //! @param name name of the function - //! @return a reference to the function, or a null pointer - PyObject * - py_find_function (const std::string& module, const std::string& name); - - //! Return a reference to the fully-qualified function name. - //! - //! @param name fully-qualified name of the function - //! @return a reference to the function, or a null pointer - PyObject * - py_find_function (const std::string& name); - - //! Return a reference to the fully-qualified type name. - //! - //! @param name fully-qualified name of the type - //! @return a reference to the type, or a null pointer - PyObject * - py_find_type (const std::string& name); - - //! Return a reference to the named module. - //! - //! @param name fully-qualified name of the module - //! @return a reference to the module, or a null pointer - PyObject * - py_import_module (const std::string& name); - - //! Check whether an object is an instance of a type. - //! - //! @param obj Python object - //! @param type Python type - //! @return @c true if @a obj is an instance of @a type, @c false otherwise - bool - py_isinstance (PyObject *obj, PyObject *type); - - //! Check whether an object is an instance of a type. - //! - //! @param obj Python object - //! @param typestr name of a Python type - //! @return @c true if @a obj is an instance of the type named by @a typestr, - //! @c false otherwise - inline bool - py_isinstance (PyObject *obj, const std::string& typestr) - { - return py_isinstance (obj, py_find_type (typestr)); - } - - std::string - py_object_class_name (PyObject *obj); - - void - py_objstore_del (uint64_t key); - - PyObject * - py_objstore_get (uint64_t key); - - uint64_t - py_objstore_put (PyObject *obj); - - octave_value - pyobject_wrap_object (PyObject *obj); - - PyObject * - pyobject_unwrap_object (const octave_value& value); - - bool - is_py_kwargs_argument (PyObject *obj); - - PyObject * - update_py_dict (PyObject *dict_orig, PyObject *dict_new); - -} - -#endif
--- a/pyargs.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,99 +0,0 @@ -## Copyright (C) 2016 Mike Miller -## -## This file is part of Pytave. -## -## Pytave 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. -## -## Pytave 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 Pytave; see the file COPYING. If not, see -## <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @deftypefn {} {} pyargs (@var{name}, @var{value}) -## @deftypefnx {} {} pyargs (@var{name}, @var{value}, @dots{}) -## Construct a set of Python keyword arguments suitable for passing to -## a Python function. -## -## Python keyword arguments are similar to optional named parameters accepted -## by some Octave functions such as @code{cellfun} or @code{set}. -## -## For example, a dictionary can be initialized with -## -## @example -## @group -## py.dict (pyargs ("one", 1, "two", 2)) -## @result{} [Python object of type dict] -## @{...@} -## sort (cellfun (@@char, cell (py.list (ans.keys ())), "uniformoutput", false)) -## @result{} -## @{ -## [1,1] = one -## [1,2] = two -## @} -## @end group -## @end example -## -## And a list can be sorted in reverse order with the @code{reverse} keyword -## -## @example -## @group -## x = py.list (num2cell (int32 ([1, 2, 3]))); -## x.sort (pyargs ("reverse", true)); -## x -## @result{} x = [Python object of type list] -## [3, 2, 1] -## @end group -## @end example -## @end deftypefn - -function args = pyargs (varargin) - - if (mod (nargin, 2) != 0) - error ("pyargs: must be called with NAME, VALUE pairs of arguments"); - endif - - keys_vals = {}; - for i = 1:(nargin / 2) - k = varargin{2*i - 1}; - v = varargin{2*i}; - if (! (ischar (k) && isrow (k))) - error ("pyargs: NAME %d must be a string", i); - endif - try - v = pyobject (v); - catch - error ("pyargs: VALUE %d must be convertible to a Python object", i); - end_try_catch - - keys_vals{i} = {k, v}; - endfor - - ## This function needs to return a Python mapping object that will be - ## recognized by other functions as containing keyword arguments. - ## Define the class using a type specifier so it can be defined and - ## instantiated as a single expression. - class_name = "_OctaveKwargs"; - props = "{'is_kwargs_argument': False}"; - args = pyeval (sprintf ("type('%s', (dict,), %s)()", class_name, props)); - args.update (keys_vals); - args.is_kwargs_argument = true; - -endfunction - - -%!assert (isa (pyargs (), "pyobject")) -%!assert (cell (py.list (py.dict (pyargs ()).keys ())), cell (1, 0)) -%!assert (sort (cellfun (@char, cell (py.list (py.dict (pyargs ("one", 1)).keys ())), "uniformoutput", false)), {"one"}) -%!assert (sort (cellfun (@char, cell (py.list (py.dict (pyargs ("one", 1, "two", 2)).keys ())), "uniformoutput", false)), {"one", "two"}) - -%!error pyargs (1) -%!error pyargs (1, 2) -%!error pyargs ("one")
--- a/pycall.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,260 +0,0 @@ -/* - -Copyright (C) 2015-2016 Mike Miller - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> -#include <octave/oct.h> - -#include "oct-py-eval.h" -#include "oct-py-init.h" -#include "oct-py-object.h" -#include "oct-py-types.h" -#include "oct-py-util.h" - -DEFUN_DLD (pycall, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {} pycall (@var{func})\n\ -@deftypefnx {} {@var{x} =} pycall (@var{func})\n\ -@deftypefnx {} {@var{x} =} pycall (@var{func}, @var{arg1}, @var{arg2}, @dots{})\n\ -Call a Python function or callable, passing Octave values as arguments.\n\ -\n\ -Examples:\n\ -@example\n\ -@group\n\ -pycall (\"float\", 6)\n\ - @result{} 6\n\ -pycall (\"os.getuid\")\n\ - @result{} ...\n\ -pycall (\"math.sqrt\", 2)\n\ - @result{} 1.4142\n\ -@end group\n\ -@end example\n\ -\n\ -If the callable has no return, and an lvalue is specified, it will be set\n\ -to @code{None}. However, if no lvalue was specified, @code{ans} will not\n\ -be set. For example:\n\ -@example\n\ -@group\n\ -s = pyeval (\"set([1, 2])\");\n\ -pycall (s.add, 3)\n\ -\n\ -r = pycall (s.add, 4)\n\ - @result{} r = [Python object of type NoneType]\n\ -\n\ - None\n\ -\n\ -@end group\n\ -@end example\n\ -\n\ -@seealso{pyeval, pyexec}\n\ -@end deftypefn") -{ - octave_value_list retval; - std::string id; - - int nargin = args.length (); - - if (nargin < 1) - { - print_usage (); - return retval; - } - - if (! (args(0).is_string () || (args(0).is_object () - && args(0).class_name () == "pyobject"))) - error ("pycall: FUNC must be a string or a Python reference"); - - pytave::py_init (); - - pytave::python_object callable; - if (args(0).is_string ()) - { - callable = pytave::py_find_function (args(0).string_value ()); - if (! callable) - error ("pycall: no such Python function or callable: %s", - args(0).string_value ().c_str ()); - } - else - { - callable = pytave::pyobject_unwrap_object (args(0)); - if (! callable) - error("pycall: FUNC must be a valid Python reference"); - } - - octave_value_list arglist = args.slice (1, nargin - 1); - pytave::python_object res = pytave::py_call_function (callable, arglist); - - // Ensure reasonable "ans" behaviour, consistent with Python's "_". - if (nargout > 0 || ! res.is_none ()) - retval(0) = pytave::py_implicitly_convert_return_value (res); - - return retval; -} - -/* -%!assert (isreal (pycall ("random.random"))) -%!assert (double (pycall ("math.exp", 3)), exp (3)) -%!assert (double (pycall ("math.trunc", pi)), fix (pi)) -%!assert (double (pycall ("math.sqrt", 2)), sqrt (2)) -%!assert (double (pycall ("cmath.sqrt", 2j)), sqrt (2j)) -%!assert (double (pycall ("int", 10.2)), 10) -%!assert (isa (pycall ("os.getcwd"), "pyobject")) -%!assert (isa (pycall ("object"), "pyobject")) -%!assert (isa (pycall ("dict"), "pyobject")) -%!assert (isa (pycall ("list"), "pyobject")) -%!assert (isa (pycall ("tuple"), "pyobject")) - -## Test argument type conversion of values into Python -%!test -%! pyexec (["def typename(x):\n" ... -%! " s = type(x).__name__\n" ... -%! " if s == 'long':\n" ... -%! " return 'int'\n" ... -%! " return s"]); -%!assert (char (pycall ("typename", 0)), "float") -%!assert (char (pycall ("typename", pi)), "float") -%!assert (char (pycall ("typename", 2j)), "complex") -%!assert (char (pycall ("typename", int32 (0))), "int") -%!assert (char (pycall ("typename", false)), "bool") -%!assert (char (pycall ("typename", true)), "bool") -%!assert (char (pycall ("typename", "Hello world")), "str") -%!assert (char (pycall ("typename", char ([1, 2, 3]))), "str") - -## Test construction of sequence types from cell arrays -%!assert (char (pycall ("list")), "[]") -%!assert (char (pycall ("list", {})), "[]") -%!assert (char (pycall ("list", {1, 2, 3})), "[1.0, 2.0, 3.0]") -%!assert (char (pycall ("list", {int8(1), int8(2), int8(3)})), "[1, 2, 3]") -%!assert (char (pycall ("tuple")), "()") -%!assert (char (pycall ("tuple", {})), "()") -%!assert (char (pycall ("tuple", {1, 2, 3})), "(1.0, 2.0, 3.0)") -%!assert (char (pycall ("tuple", {int8(1), int8(2), int8(3)})), "(1, 2, 3)") -%!error (pycall ("list", {1, 2, 3; 4, 5, 6})) -%!error (pycall ("dict", {1, 2, 3})) - -## Test failure to convert char arrays to strings -%!error (pycall ("str", ("hello")')) -%!error (pycall ("str", ["hello"; "world"])) - -## Test construction of dict from pyargs -%!test -%! a = pycall ("dict", pyargs ("a", 1, "b", 2, "c", 3)); -%! assert (sort (cellfun (@char, cell (pycall ("list", a.keys ())), "uniformoutput", false)), {"a", "b", "c"}) -%! assert (sort (double (pycall ("array.array", "d", a.values ()))), [1, 2, 3]) - -## Test copy construction of dict from dict -%!test -%! a = pycall ("dict", pyargs ("a", 1, "b", 2, "c", 3)); -%! b = pycall ("dict", a); -%! assert (isequal (a, b)) - -## Test construction of dict from sequence of key value pairs -%!test -%! a = pycall ("dict", pyargs ("a", 1, "b", 2, "c", 3)); -%! b = pycall ("dict", pycall ("zip", {"a", "b", "c"}, {1, 2, 3})); -%! assert (isequal (a, b)) - -## Test round trip type preservation / conversion -%!test -%! pyexec ("def roundtrip(x): return x"); -%! values = { 0, pi, 2j, eps, false, true }; -%! for i = 1:numel (values) -%! assert (pycall ("roundtrip", values{i}), values{i}); -%! endfor - -## Test conversion of integer types into Python -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 0"), int8 (0))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == -2**7 "), intmin ("int8"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 2**7 -1"), intmax ("int8"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 0"), intmin ("uint8"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 2**8 -1"), intmax ("uint8"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 0"), int16 (0))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == -2**15 "), intmin ("int16"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 2**15-1"), intmax ("int16"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 0"), intmin ("uint16"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 2**16-1"), intmax ("uint16"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 0"), int32 (0))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == -2**31 "), intmin ("int32"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(0) and x == 2**31-1"), intmax ("int32"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(2**64) and x == 0"), intmin ("uint32"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(2**64) and x == 2**32-1"), intmax ("uint32"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(2**64) and x == 0"), int64 (0))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(2**64) and x == -2**63 "), intmin ("int64"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(2**64) and x == 2**63-1"), intmax ("int64"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(2**64) and x == 0"), intmin ("uint64"))) -%!assert (pycall (pyeval ("lambda x: type(x) == type(2**64) and x == 2**64-1"), intmax ("uint64"))) - -%!error <unable to convert unhandled Octave type> -%! pyexec ("def intwrapper(x): return int(x)"); -%! pycall ("intwrapper", ftp ()); - -## Test conversion of integer types from Python -%!test -%! if (pyeval ("__import__('sys').hexversion >= 0x03000000")) -%! assert (isa (pycall ("int", 0), "pyobject")) -%! assert (isa (pycall ("int", 2^31-1), "pyobject")) -%! assert (isa (pycall ("int", -2^31), "pyobject")) -%! assert (double (pycall ("int", 0)), 0) -%! assert (double (pycall ("int", 2^31-1)), 2^31-1) -%! assert (double (pycall ("int", -2^31)), -2^31) -%! else -%! assert (pycall ("int", 0), int64 (0)) -%! assert (pycall ("int", 2^31-1), int64 (2^31-1)) -%! assert (pycall ("int", -2^31), int64 (-2^31)) -%! assert (isa (pycall ("long", 0), "pyobject")) -%! assert (isa (pycall ("long", 2^31-1), "pyobject")) -%! assert (isa (pycall ("long", -2^31), "pyobject")) -%! assert (double (pycall ("long", 0)), 0) -%! assert (double (pycall ("long", 2^31-1)), 2^31-1) -%! assert (double (pycall ("long", -2^31)), -2^31) -%! endif -%!assert (isa (pycall ("int", 2^100), "pyobject")) - -%!test -%! pyexec (["def pyfunc(x):\n" ... -%! " if x is True:\n return 30\n" ... -%! " elif x is False:\n return 20\n" ... -%! " else:\n return 10"]); -%! assert (double (pycall ("pyfunc", true)), 30) -%! assert (double (pycall ("pyfunc", false)), 20) -%! assert (double (pycall ("pyfunc", 10)), 10) - -%!error <NameError> -%! pyexec ("def raiseException(): raise NameError('oops')") -%! pycall ("raiseException") - -## None as a return value -%!test -%! f = pyeval ("lambda: None"); -%! r = pycall (f); -%! assert (__py_is_none__ (r)) - -## But returning None will not set "ans" -%!test -%! f = pyeval ("lambda: None"); -%! clear ans -%! pycall (f); -%! assert (! exist ("ans", "var")) -*/
--- a/pyeval.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,187 +0,0 @@ -/* - -Copyright (C) 2016 Colin B. Macdonald - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> -#include <octave/oct.h> - -#include "oct-py-eval.h" -#include "oct-py-init.h" -#include "oct-py-object.h" -#include "oct-py-types.h" -#include "oct-py-util.h" - -DEFUN_DLD (pyeval, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {} pyeval (@var{expr})\n\ -@deftypefnx {} {} pyeval (@var{expr}, @var{localns})\n\ -@deftypefnx {} {@var{x} =} pyeval (@dots{})\n\ -Evaluate a Python expression and return the result.\n\ -\n\ -When called with an optional second argument, @var{localns} is a\n\ -@code{py.dict} that acts as the namespace for any assignments or other\n\ -side effects of the expression.\n\ -\n\ -Examples:\n\ -@example\n\ -@group\n\ -pyexec (\"import sys\")\n\ -pyeval (\"sys.version\")\n\ - @result{} ...\n\ -pyeval (\"dict(two=2)\")\n\ - @result{} [Python object of type dict]\n\ - @{'two': 2@}\n\ -@end group\n\ -@end example\n\ -@seealso{pycall, pyexec}\n\ -@end deftypefn") -{ - octave_value_list retval; - - int nargin = args.length (); - - if (nargin < 1 || nargin > 2) - { - print_usage (); - return retval; - } - - std::string code = args(0).string_value (); - - pytave::py_init (); - - PyObject *local_namespace = nullptr; - if (nargin > 1) - { - local_namespace = pytave::pyobject_unwrap_object (args(1)); - if (! local_namespace) - error ("pyeval: NAMESPACE must be a valid Python reference"); - } - - pytave::python_object res = pytave::py_eval_string (code, 0, local_namespace); - - if (nargout > 0 || ! res.is_none ()) - retval(0) = pytave::py_implicitly_convert_return_value (res); - - return retval; -} - -/* -%!assert (isnumeric (double (pyeval ("0")))) -%!assert (isreal (double (pyeval ("0")))) -%!assert (double (pyeval ("0")), 0) - -%!assert (isnumeric (pyeval ("10.1"))) -%!assert (isreal (pyeval ("10.1"))) -%!assert (pyeval ("10.1"), 10.1) - -%!assert (isnumeric (pyeval ("2j"))) -%!assert (iscomplex (pyeval ("2j"))) -%!assert (pyeval ("2j"), 2j) - -%!assert (ischar (char (pyeval ("\"I <3 Octave\"")))) -%!assert (char (pyeval ("\"I <3 Octave\"")), "I <3 Octave") - -%!assert (islogical (pyeval ("True"))) -%!assert (islogical (pyeval ("False"))) -%!assert (pyeval ("True"), true) -%!assert (pyeval ("False"), false) -%!assert (class (pyeval ("True")), "logical") -%!assert (class (pyeval ("False")), "logical") - -%!assert (isa (pyeval ("object()"), "pyobject")) - -%!assert (isnumeric (double (pyeval ("__import__('sys').maxsize")))) -%!assert (double (pyeval ("99999999999999")), 99999999999999) -%!assert (double (pyeval ("-99999999999999")), -99999999999999) - -%!test -%! z = pyeval ("{'x': 1., 'y': 2.}"); -%! assert (isa (z, "pyobject")) -%! assert (z{"x"}, 1) - -%!test -%! z = pyeval ("[1., 2., 3.]"); -%! assert (isa (z, "pyobject")) -%! assert ({z{1}, z{2}, z{3}}, {1, 2, 3}) - -%!test -%! z = pyeval ("(4., 5., 6.)"); -%! assert (isa (z, "pyobject")) -%! assert ({z{1}, z{2}, z{3}}, {4, 5, 6}) - -%!test -%! z = pyeval ("[1., [21., 22.], 3., [41., [421., 422.], 43.]]"); -%! assert (isa (z, "pyobject")) -%! assert (isa (z{2}, "pyobject")) -%! assert (z{2}{1}, 21) -%! assert (z{2}{2}, 22) -%! assert (isa (z{4}{2}, "pyobject")) -%! assert (z{4}{2}{1}, 421) -%! assert (z{4}{2}{2}, 422) - -%!error <NameError> -%! pyexec ("def raiseException(): raise NameError ('oops')") -%! pyeval ("raiseException()") - -%!test -%! % Variable defined in global namespace is available locally -%! myNS = pyeval ("{}"); -%! pyexec ("myvar = 1.") -%! assert (pyeval ("myvar", myNS), 1); - -%!test -%! % Variables with same name can have different values in different namespaces -%! myNS1 = pyeval ("{}"); -%! myNS2 = pyeval ("{}"); -%! pyexec ("myvar = 1.") -%! pyexec ("myvar = 2.", myNS1) -%! pyexec ("myvar = 3.", myNS2) -%! assert (pyeval ("myvar"), 1) -%! assert (pyeval ("myvar", myNS1), 2) -%! assert (pyeval ("myvar", myNS2), 3) - -%!error <NameError> -%! pyexec ("if 'myvar' in globals(): del myvar") -%! % Variable defined in local namespace MUST not be available globally -%! myNS = pyeval ("{}"); -%! pyexec ("myvar = 1.", myNS) -%! pyeval ("myvar"); - -%!error <NameError> -%! pyexec ("if 'myvar' in globals(): del myvar") -%! % Variable defined in one local namespace MUST not be available in another -%! myNS1 = pyeval ("{}"); -%! myNS2 = pyeval ("{}"); -%! pyexec ("myvar = 1.", myNS1) -%! pyeval ("myvar", myNS2); - -%!error <NameError> -%! pyexec ("if 'sys' in globals(): del sys") -%! % Modules imported in local namespace MUST not be accessible globally -%! myNS = pyeval ("{}"); -%! pyexec ("import sys", myNS); -%! pyeval ("sys"); -*/
--- a/pyexec.cc Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,91 +0,0 @@ -/* - -Copyright (C) 2016 Colin B. Macdonald - -This file is part of Pytave. - -Pytave 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. - -Pytave 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 Pytave; see the file COPYING. If not, see -<http://www.gnu.org/licenses/>. - -*/ - -#if defined (HAVE_CONFIG_H) -# include <config.h> -#endif - -#include <Python.h> -#include <octave/oct.h> - -#include "oct-py-eval.h" -#include "oct-py-init.h" -#include "oct-py-util.h" - -DEFUN_DLD (pyexec, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} pyexec (@var{expr})\n\ -@deftypefnx {} {} pyexec (@var{expr}, @var{localns})\n\ -Execute a Python expression or block of code.\n\ -\n\ -When called with an optional second argument, @var{localns} is a\n\ -@code{py.dict} that acts as the namespace for any assignments or other\n\ -side effects of the expression.\n\ -\n\ -Examples:\n\ -@example\n\ -@group\n\ -@c FIXME: Python stdout not same as Octave's https://bitbucket.org/mtmiller/pytave/issues/58\n\ -@c doctest: +XFAIL\n\ -pyexec (\"print(42)\")\n\ - @print{} 42\n\ -@end group\n\ -@end example\n\ -@seealso{pycall, pyeval}\n\ -@end deftypefn") -{ - octave_value_list retval; - - int nargin = args.length (); - - if (nargin < 1 || nargin > 2) - { - print_usage (); - return retval; - } - - std::string code = args(0).string_value (); - - pytave::py_init (); - - PyObject *local_namespace = nullptr; - if (nargin > 1) - { - local_namespace = pytave::pyobject_unwrap_object (args(1)); - if (! local_namespace) - error ("pyexec: NAMESPACE must be a valid Python reference"); - } - - // FIXME: figure out exec return code: - pytave::py_exec_string (code, 0, local_namespace); - - return retval; -} - -/* -%!error <NameError> -%! pyexec ("raise NameError ('oops')") - -%!error <AttributeError> -%! pyexec ("import sys") -%! pyexec ("sys.no_such_thing") -*/
--- a/pyversion.m Thu Feb 22 15:55:15 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,88 +0,0 @@ -## Copyright (C) 2016 Mike Miller -## -## This file is part of Pytave. -## -## Pytave 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. -## -## Pytave 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 Pytave; see the file COPYING. If not, see -## <http://www.gnu.org/licenses/>. - -## -*- texinfo -*- -## @deftypefn {} {} pyversion -## @deftypefnx {} {@var{ver} =} pyversion -## @deftypefnx {} {[@var{ver}, @var{exec}, @var{loaded}] =} pyversion -## List information about the Python runtime used by Octave Python functions. -## @end deftypefn - -function varargout = pyversion () - - if (nargin > 0) - print_usage (); - endif - - ver = char (pycall ("sysconfig.get_python_version")); - - if ((nargout == 0) || (nargout > 1)) - exec = char (py.sys.executable); - endif - - ## FIXME: determine whether the Python runtime has been loaded yet - if ((nargout == 0) || (nargout > 2)) - loaded = true; - endif - - if (nargout == 0) - dlllibrary = char (pycall ("sysconfig.get_config_var", "DLLLIBRARY")); - if (isempty (dlllibrary)) - libdir = pycall ("sysconfig.get_config_var", "LIBDIR"); - ldlibrary = pycall ("sysconfig.get_config_var", "LDLIBRARY"); - else - libdir = pycall ("sysconfig.get_config_var", "BINDIR"); - ldlibrary = dlllibrary; - endif - multiarch = pycall ("sysconfig.get_config_var", "MULTIARCH"); - lib = char (pycall ("os.path.join", libdir, multiarch, ldlibrary)); - prefix = char (pycall ("sysconfig.get_config_var", "prefix")); - - printf (" version: \"%s\"\n", ver); - printf (" executable: \"%s\"\n", exec); - printf (" library: \"%s\"\n", lib); - printf (" prefix: \"%s\"\n", prefix); - printf (" loaded: %d\n", loaded); - else - if (nargout > 0) - varargout{1} = ver; - endif - if (nargout > 1) - varargout{2} = exec; - endif - if (nargout > 2) - varargout{3} = loaded; - endif - endif - -endfunction - - -%!assert (ischar (pyversion ())) - -%!test -%! [m, n] = regexp (pyversion (), '^(\d\.\d)$'); -%! assert ([m, n], [1, 3]) - -%!test -%! [~, ~, v] = pyversion (); -%! assert (v, true) - -%!error pyversion (1) -%!error pyversion ("python") -%!error pyversion ("/usr/bin/python")