Mercurial > octave
annotate scripts/miscellaneous/ver.m @ 23083:e9a0469dedd9 stable
maint: strip extra trailing newlines from files.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 20 Jan 2017 12:19:08 -0500 |
parents | bac0d6f07a3e |
children | ef4d915df748 3ac9f9ecfae5 |
rev | line source |
---|---|
22323
bac0d6f07a3e
maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents:
21915
diff
changeset
|
1 ## Copyright (C) 2005-2016 William Poetra Yoga Hadisoeseno |
5546 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
5546 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
5546 | 18 |
19 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
20 ## @deftypefn {} {} ver |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
21 ## @deftypefnx {} {} ver Octave |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
22 ## @deftypefnx {} {} ver @var{package} |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
23 ## @deftypefnx {} {v =} ver (@dots{}) |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
24 ## |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
25 ## Display a header containing the current Octave version number, license |
19187 | 26 ## string, and operating system. The header is followed by a list of installed |
27 ## packages, versions, and installation directories. | |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
28 ## |
19187 | 29 ## Use the package name @var{package} or Octave to limit the listing to a |
30 ## desired component. | |
16491
b10a23fe80bb
doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility.
Rik <rik@octave.org>
parents:
16489
diff
changeset
|
31 ## |
19187 | 32 ## When called with an output argument, return a vector of structures |
33 ## describing Octave and each installed package. The structure includes the | |
34 ## following fields. | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
35 ## |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
36 ## @table @code |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
37 ## @item Name |
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
38 ## Package name. |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
39 ## |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
40 ## @item Version |
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
41 ## Version of the package. |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
42 ## |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
43 ## @item Revision |
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
44 ## Revision of the package. |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
45 ## |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
46 ## @item Date |
16491
b10a23fe80bb
doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility.
Rik <rik@octave.org>
parents:
16489
diff
changeset
|
47 ## Date of the version/revision. |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
48 ## @end table |
12208
9611014e7cf1
Add function compare_versions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
49 ## |
21434
1da428cbf401
deprecate octave_config_info
John W. Eaton <jwe@octave.org>
parents:
20852
diff
changeset
|
50 ## @seealso{version, usejava, pkg} |
5546 | 51 ## @end deftypefn |
52 | |
53 ## Author: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com> | |
54 | |
19187 | 55 function retval = ver (package = "") |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
56 |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
57 if (nargin > 1) |
6046 | 58 print_usage (); |
5546 | 59 endif |
60 | |
19187 | 61 if (nargout == 0) |
62 [unm, err] = uname (); | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
63 |
19187 | 64 if (err) |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
65 os_string = "unknown"; |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
66 else |
19187 | 67 os_string = sprintf ("%s %s %s %s", |
68 unm.sysname, unm.release, unm.version, unm.machine); | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
69 endif |
5546 | 70 |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
71 hbar(1:70) = "-"; |
19187 | 72 desc = {hbar |
73 ["GNU Octave Version: " OCTAVE_VERSION] | |
74 ["GNU Octave License: " license] | |
75 ["Operating System: " os_string] | |
76 hbar}; | |
77 | |
78 printf ("%s\n", desc{:}); | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
79 |
19187 | 80 if (isempty (package)) |
81 pkg ("list"); | |
82 elseif (strcmpi (package, "Octave")) | |
83 ## Nothing to do, Octave version was already reported | |
84 else | |
85 pkg ("list", package); | |
86 endif | |
5546 | 87 else |
19187 | 88 ## Get the installed packages |
89 if (isempty (package)) | |
90 lst = pkg ("list"); | |
91 ## Start with the version info for Octave | |
92 retval = struct ("Name", "Octave", "Version", version, | |
93 "Release", [], "Date", []); | |
94 for i = 1:numel (lst) | |
95 retval(end+1) = struct ("Name", lst{i}.name, "Version", lst{i}.version, | |
96 "Release", [], "Date", lst{i}.date); | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
97 endfor |
19187 | 98 elseif (strcmpi (package, "Octave")) |
99 retval = struct ("Name", "Octave", "Version", version, | |
100 "Release", [], "Date", []); | |
19597
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19596
diff
changeset
|
101 else |
19187 | 102 lst = pkg ("list", package); |
103 if (isempty (lst)) | |
21914
2c035963f469
ver.m: return empty struct for unknown package (bug #48235).
Garrett Euler <ggeuler@lanl.gov>
parents:
19697
diff
changeset
|
104 retval = struct ("Name", {}, "Version", {}, |
2c035963f469
ver.m: return empty struct for unknown package (bug #48235).
Garrett Euler <ggeuler@lanl.gov>
parents:
19697
diff
changeset
|
105 "Release", {}, "Date", {}); |
19187 | 106 else |
107 retval = struct ("Name", lst{1}.name, "Version", lst{1}.version, | |
108 "Release", [], "Date", lst{1}.date); | |
109 endif | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
110 endif |
5546 | 111 endif |
112 | |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
113 endfunction |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
114 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
115 |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
116 %!test |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
117 %! result = ver; |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
118 %! assert (result(1).Name, "Octave"); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
119 %! assert (result(1).Version, version); |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
120 %! result = ver ("octave"); |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
121 %! assert (result(1).Name, "Octave"); |
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
122 %! assert (result(1).Version, version); |
5546 | 123 |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
124 %!test |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
125 %! lst = pkg ("list"); |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
126 %! for n = 1:numel (lst) |
7499
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
127 %! expected = lst{n}.name; |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
128 %! result = ver (expected); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
129 %! assert (result.Name, expected); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
130 %! assert (isfield (result, "Version"), true); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
131 %! assert (isfield (result, "Release"), true); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
132 %! assert (isfield (result, "Date"), true); |
94d0cdd60dda
Added pkg version info and matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents:
7017
diff
changeset
|
133 %! endfor |
5546 | 134 |
21914
2c035963f469
ver.m: return empty struct for unknown package (bug #48235).
Garrett Euler <ggeuler@lanl.gov>
parents:
19697
diff
changeset
|
135 %!test |
2c035963f469
ver.m: return empty struct for unknown package (bug #48235).
Garrett Euler <ggeuler@lanl.gov>
parents:
19697
diff
changeset
|
136 %! result = ver ("%_an_unknown_package_%"); |
2c035963f469
ver.m: return empty struct for unknown package (bug #48235).
Garrett Euler <ggeuler@lanl.gov>
parents:
19697
diff
changeset
|
137 %! assert (isempty (result), true); |