1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
|
########################################################################
##
## Copyright (C) 2016-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} grabcode @var{filename}
## @deftypefnx {} {} grabcode @var{url}
## @deftypefnx {} {@var{code_str} =} grabcode (@dots{})
##
## Grab the code from a report created by the @code{publish} function.
##
## The grabbed code inside the published report must be enclosed by the
## strings @samp{##### SOURCE BEGIN #####} and @samp{##### SOURCE END #####}.
## The @code{publish} function creates this format automatically.
##
## If no return value is requested the code is saved to a temporary file and
## opened in the default editor. NOTE: The temporary file must be saved to a
## new filename or the code will be lost.
##
## If an output is requested the grabbed code will be returned as string
## @var{code_str}.
##
## Example:
##
## @example
## @group
## publish ("my_script.m");
## grabcode ("html/my_script.html");
## @end group
## @end example
##
## The example above publishes @file{my_script.m} to the default location
## @file{html/my_script.html}. Next, the published Octave script is grabbed to
## edit its content in a new temporary file.
##
## @seealso{publish}
## @end deftypefn
function code_str = grabcode (url)
if (nargin < 1)
print_usage ();
endif
if (exist (url) == 2)
## URL is a local file
oct_code = fileread (url);
else
## Otherwise, try to read remote URL
[oct_code, success, message] = urlread (url);
if (! success)
error (["grabcode: " message]);
endif
endif
## Extract relevant part
oct_code = regexp (oct_code, ...
'##### SOURCE BEGIN #####\n(.*)##### SOURCE END #####', "once", "tokens");
oct_code = oct_code{1};
if (nargout == 1)
code_str = oct_code;
else
## Open temporary file in editor
fname = [tempname() ".m"];
fid = fopen (fname, "w");
if (fid < 0)
error ("grabcode: could not open temporary file");
endif
fprintf (fid, "%s", oct_code);
fclose (fid);
edit (fname);
warndlg (["grabcode: Make sure to save the temporary file\n\n\t", ...
fname, "\n\nto a location of your choice. ", ...
"Otherwise all grabbed code will be lost!"]);
endif
endfunction
## Test input validation
%!error <Invalid call> grabcode ()
|