Mercurial > octave-antonio

annotate scripts/general/display.m @ 19697:4197fc428c7d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Update copyright notices for 2015.
author John W. Eaton <jwe@octave.org>
date Wed, 11 Feb 2015 14:19:08 -0500
parents 446c46af4b42
children 7503499a252b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19593
diff changeset
1 ## Copyright (C) 2008-2015 David Bateman
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## @deftypefn {Function File} {} display (@var{a})
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8212
diff changeset
21 ## Display the contents of an object. If @var{a} is an object of the
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14138
diff changeset
22 ## class @qcode{"myclass"}, then @code{display} is called in a case like
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ##
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## @example
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 ## myclass (@dots{})
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ## @end example
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 ##
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 ## @noindent
9073
17ce09c3d030 Cleanup oop.texi
Rik <rdrider0-list@yahoo.com>
parents: 9051
diff changeset
29 ## where Octave is required to display the contents of a variable of the
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14138
diff changeset
30 ## type @qcode{"myclass"}.
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 ##
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 ## @seealso{class, subsref, subsasgn}
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 ## @end deftypefn
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
34
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 function idx = display (a)
13835
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
36
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
37 if (nargin != 1)
10783
fc9e07fdf9c2 display.m: print usage message if nargin != 1
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
38 print_usage ();
fc9e07fdf9c2 display.m: print usage message if nargin != 1
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
39 endif
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
40
13835
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
41 ## Only reason we got here is that there was no overloaded display()
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
42 ## function for object a. This may mean it is a built-in.
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
43 str = disp (a);
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
44 if (isempty (strfind (str, "<class ")))
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
45 disp (str);
13835
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
46 else
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
47 error ('display: not defined for class "%s"', class (a));
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
48 endif
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
49
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17281
diff changeset
51