annotate scripts/miscellaneous/perl.m @ 27928:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.
author John W. Eaton <jwe@octave.org>
date Wed, 08 Jan 2020 11:59:41 -0500
parents 1891570abac8
children 0a5b15007766
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27928
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27924
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27924
diff changeset
2 ##
27924
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27923
diff changeset
3 ## Copyright (C) 2008-2020 The Octave Project Developers
27923
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26702
diff changeset
4 ##
27928
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27924
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27924
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
7 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
8 ## This file is part of Octave.
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 ## (at your option) any later version.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
14 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
18 ## GNU General Public License for more details.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
19 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
22 ## <https://www.gnu.org/licenses/>.
27928
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27924
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27924
diff changeset
24 ########################################################################
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
25
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20713
diff changeset
27 ## @deftypefn {} {@var{output} =} perl (@var{scriptfile})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20713
diff changeset
28 ## @deftypefnx {} {@var{output} =} perl (@var{scriptfile}, @var{argument1}, @var{argument2}, @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20713
diff changeset
29 ## @deftypefnx {} {[@var{output}, @var{status}] =} perl (@dots{})
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
30 ## Invoke Perl script @var{scriptfile}, possibly with a list of command line
19215
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
31 ## arguments.
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
32 ##
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
33 ## Return output in @var{output} and optional status in @var{status}. If
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 19697
diff changeset
34 ## @var{scriptfile} is not an absolute filename it is searched for in the
19215
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
35 ## current directory and then in the Octave loadpath.
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
36 ## @seealso{system, python}
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
37 ## @end deftypefn
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
38
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
39 function [output, status] = perl (scriptfile = "-e ''", varargin)
7679
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
40
26702
775643b5eae4 maint: Fix typos in comments where "intial" instead of "initial" used.
Rik <rik@octave.org>
parents: 26379
diff changeset
41 ## VARARGIN is initialized to {}(1x0) if no additional arguments are
7679
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
42 ## supplied, so there is no need to check for it, or provide an
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
43 ## initial value in the argument list of the function definition.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
44
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
45 if (ischar (scriptfile)
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
46 && ( (nargin == 1 && ! isempty (scriptfile))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
47 || (nargin != 1 && iscellstr (varargin))))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
48 if (! strcmp (scriptfile(1:2), "-e"))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
49 ## Attempt to find file in loadpath. No effect for absolute filenames.
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
50 scriptfile = file_in_loadpath (scriptfile);
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
51 endif
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
52
16994
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14818
diff changeset
53 [status, output] = system (["perl " scriptfile ...
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14818
diff changeset
54 sprintf(" %s", varargin{:})]);
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
55 else
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
56 error ("perl: invalid arguments");
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
57 endif
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
58
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
59 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 16994
diff changeset
60
19215
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
61
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
62 %!error <invalid arguments> perl (123)