Mercurial > octave

annotate scripts/general/display.m @ 21076:b433f9990452

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
strip trailing whitespace from files * NEWS, oop.txi, ov.h, dSparse.h, f77-fcn.h, lo-array-gripes.h, display.m, int2str.m, num2str.m, subsindex.m, fileattrib.m, parser.tst: Strip trailing whitespace.
author John W. Eaton <jwe@octave.org>
date Fri, 15 Jan 2016 12:46:58 -0500
parents a9ed4104ecfd
children dba88797f69f
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 -*-
21072
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
20 ## @deftypefn {} {} display (@var{obj})
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
21 ## Display the contents of the object @var{obj}.
20158
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
22 ##
21072
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
23 ## The Octave interpreter calls the @code{display} function whenever it needs
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
24 ## to present a class on-screen. Typically, this would be a statement which
21076
b433f9990452 strip trailing whitespace from files
John W. Eaton <jwe@octave.org>
parents: 21072
diff changeset
25 ## does not end in a semicolon to suppress output. For example,
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ##
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 ## @example
21072
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
28 ## myobj = myclass (@dots{})
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 ## @end example
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ##
21072
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
31 ## User-defined classes should overload the @code{display} method so that
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
32 ## something useful is printed for a class object. Otherwise, Octave will
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
33 ## report only that the object is an instance of its class.
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 ##
21072
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
35 ## @example
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
36 ## myobj = myclass (@dots{})
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
37 ## @result{} myobj = <class myclass>
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
38 ## @end example
21076
b433f9990452 strip trailing whitespace from files
John W. Eaton <jwe@octave.org>
parents: 21072
diff changeset
39 ##
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 ## @seealso{class, subsref, subsasgn}
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 ## @end deftypefn
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
42
21072
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
43 function display (obj)
13835
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
44
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
45 if (nargin != 1)
10783
fc9e07fdf9c2 display.m: print usage message if nargin != 1
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
46 print_usage ();
fc9e07fdf9c2 display.m: print usage message if nargin != 1
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
47 endif
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
48
21072
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
49 ## Only reason we got here is that there was no overloaded display function.
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
50 ## This may mean it is a built-in class.
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
51 str = disp (obj);
13835
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
52 if (isempty (strfind (str, "<class ")))
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
53 disp (str);
13835
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
54 else
21072
a9ed4104ecfd doc: Rewrite documentation for Object Oriented Programming.
Rik <rik@octave.org>
parents: 20852
diff changeset
55 error ('display: not defined for class "%s"', class (obj));
13835
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 endif
fc9f34e17486 display.m: Extend display to work on builtin classes (Bug #34637)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57
8212
ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods
David Bateman <dbateman@free.fr>
parents:
diff changeset
58 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17281
diff changeset
59