annotate @pyobject/display.m @ 380:b054a6833022

Merged in vikikrishna/pytave (pull request #47) pyobject.display: remove hash value and show class in display (fixes issue #71)
author Mike Miller <mike@mtmxr.com>
date Thu, 23 Mar 2017 17:35:43 +0000
parents c90d70aec553 24546b7021db
children 750a86973625
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
1 ## Copyright (C) 2016 Colin B. Macdonald
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
2 ##
246
4acc64f89d67 maint: fix copyright header comment blocks
Mike Miller <mtmiller@octave.org>
parents: 227
diff changeset
3 ## This file is part of Pytave
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
4 ##
246
4acc64f89d67 maint: fix copyright header comment blocks
Mike Miller <mtmiller@octave.org>
parents: 227
diff changeset
5 ## Pytave is free software; you can redistribute it and/or modify
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
6 ## it under the terms of the GNU General Public License as published
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
7 ## by the Free Software Foundation; either version 3 of the License,
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
8 ## or (at your option) any later version.
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
9 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
10 ## This software is distributed in the hope that it will be useful,
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
11 ## but WITHOUT ANY WARRANTY; without even the implied warranty
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
12 ## of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
13 ## the GNU General Public License for more details.
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
14 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
15 ## You should have received a copy of the GNU General Public
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
16 ## License along with this software; see the file COPYING.
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
17 ## If not, see <http://www.gnu.org/licenses/>.
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
18
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
19 ## -*- texinfo -*-
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
20 ## @documentencoding UTF-8
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
21 ## @defmethod @@pyobject display (@var{x})
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
22 ## Custom display for pyobjects.
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
23 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
24 ## Example:
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
25 ## @example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
26 ## @group
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
27 ## pyexec ("import sys")
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
28 ## sysmodule = pyeval ("sys")
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
29 ## @result{} sysmodule = [pyobject ...]
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
30 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
31 ## <module 'sys' (built-in)>
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
32 ##
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
33 ## @end group
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
34 ## @end example
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
35 ##
280
3bf799e80ca5 pyobject: add char conversion method, refactor disp and display to use char
Mike Miller <mtmiller@octave.org>
parents: 246
diff changeset
36 ## @seealso{@@pyobject/char, @@pyobject/disp}
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
37 ## @end defmethod
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
38
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
39
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
40 function display (x)
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
41
378
c90d70aec553 pyobject.display: make display compatible to octave 4.3.0 (fixes issue #77)
Vijay Krishnavanshi <vijaykrishnavanshi@gmail.com>
parents: 362
diff changeset
42 try
c90d70aec553 pyobject.display: make display compatible to octave 4.3.0 (fixes issue #77)
Vijay Krishnavanshi <vijaykrishnavanshi@gmail.com>
parents: 362
diff changeset
43 [~, spacing] = format ();
c90d70aec553 pyobject.display: make display compatible to octave 4.3.0 (fixes issue #77)
Vijay Krishnavanshi <vijaykrishnavanshi@gmail.com>
parents: 362
diff changeset
44 loose = strcmp (spacing, "loose");
c90d70aec553 pyobject.display: make display compatible to octave 4.3.0 (fixes issue #77)
Vijay Krishnavanshi <vijaykrishnavanshi@gmail.com>
parents: 362
diff changeset
45 catch
c90d70aec553 pyobject.display: make display compatible to octave 4.3.0 (fixes issue #77)
Vijay Krishnavanshi <vijaykrishnavanshi@gmail.com>
parents: 362
diff changeset
46 loose = ! __compactformat__ ();
c90d70aec553 pyobject.display: make display compatible to octave 4.3.0 (fixes issue #77)
Vijay Krishnavanshi <vijaykrishnavanshi@gmail.com>
parents: 362
diff changeset
47 end_try_catch
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
48
379
24546b7021db pyobject.display: remove hash value and show class in display (fixes issue #71)
Vijay Krishnavanshi <vijaykrishnavanshi@gmail.com>
parents: 362
diff changeset
49 printf ("%s = [Python object of type %s]\n", inputname (1), __py_class_name__ (x));
280
3bf799e80ca5 pyobject: add char conversion method, refactor disp and display to use char
Mike Miller <mtmiller@octave.org>
parents: 246
diff changeset
50 s = char (x);
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
51 s = make_indented (s);
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
52 if (loose), printf ("\n"); endif
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
53 disp (s)
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
54 if (loose), printf ("\n"); endif
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
55
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
56 endfunction
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
57
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
58
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
59 function s = make_indented (s, n)
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
60 if (nargin == 1)
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
61 n = 2;
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
62 endif
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
63 pad = char (double (" ") * ones (1,n));
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
64 s = strrep (s, "\n", ["\n" pad]);
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
65 s = [pad s]; # first line
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
66 endfunction