annotate @pyobject/display.m @ 280:3bf799e80ca5

pyobject: add char conversion method, refactor disp and display to use char * @pyobject/pyobject.m (@pyobject/char): New method. (@pyobject/disp): Use it. * @pyobject/display.m: Use char directly instead of disp.
author Mike Miller <mtmiller@octave.org>
date Fri, 29 Jul 2016 20:15:39 -0700
parents 4acc64f89d67
children b0677c492655
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
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
42 loose = ! __compactformat__ ();
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
43
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
44 printf ("%s = [pyobject %s]\n", inputname (1), getid (x));
280
3bf799e80ca5 pyobject: add char conversion method, refactor disp and display to use char
Mike Miller <mtmiller@octave.org>
parents: 246
diff changeset
45 s = char (x);
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
46 s = make_indented (s);
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
47 if (loose), printf ("\n"); endif
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
48 disp (s)
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
49 if (loose), printf ("\n"); endif
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
50
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
51 endfunction
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
52
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
53
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
54 function s = make_indented (s, n)
216
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
55 if (nargin == 1)
3b2b7db7d709 Improve display
Colin Macdonald <cbm@m.fsf.org>
parents:
diff changeset
56 n = 2;
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
57 endif
227
c56b85f405ba maint: apply Octave whitespace rules
Mike Miller <mtmiller@octave.org>
parents: 224
diff changeset
58 pad = char (double (" ") * ones (1,n));
224
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
59 s = strrep (s, "\n", ["\n" pad]);
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
60 s = [pad s]; # first line
7feece80fbfa pyobject: Octave-style formatting, minor edits
Colin Macdonald <cbm@m.fsf.org>
parents: 216
diff changeset
61 endfunction