Mercurial > hg > octave-lyh
annotate scripts/miscellaneous/edit.m @ 9724:f22bbc5d56e9
Fix various incorrect usages of TeXinfo deffn and deftypefn macros
which were causing bad entries in the function index.
| author | Rik <rdrider0-list@yahoo.com> |
|---|---|
| date | Tue, 13 Oct 2009 21:10:37 -0700 |
| parents | 5247e89688e1 |
| children | 95c3e38098bf |
| rev | line source |
|---|---|
| 8920 | 1 ## Copyright (C) 2001, 2007, 2008, 2009 Paul Kienzle |
| 7325 | 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 | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 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 | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
|
9724
f22bbc5d56e9
Fix various incorrect usages of TeXinfo deffn and deftypefn macros
Rik <rdrider0-list@yahoo.com>
parents:
9153
diff
changeset
|
20 ## @deftypefn {Command} {} edit @var{name} |
|
f22bbc5d56e9
Fix various incorrect usages of TeXinfo deffn and deftypefn macros
Rik <rdrider0-list@yahoo.com>
parents:
9153
diff
changeset
|
21 ## @deftypefnx {Command} {} edit @var{field} @var{value} |
| 7650 | 22 ## @deftypefnx {Command} {@var{value} =} edit get @var{field} |
| 7325 | 23 ## Edit the named function, or change editor settings. |
| 24 ## | |
| 25 ## If @code{edit} is called with the name of a file or function as | |
| 26 ## its argument it will be opened in a text editor. | |
| 27 ## | |
| 28 ## @itemize @bullet | |
| 29 ## @item | |
| 30 ## If the function @var{name} is available in a file on your path and | |
| 31 ## that file is modifiable, then it will be edited in place. If it | |
| 32 ## is a system function, then it will first be copied to the directory | |
| 33 ## @code{HOME} (see further down) and then edited. | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
34 ## If no file is found, then the m-file |
|
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
35 ## variant, ending with ".m", will be considered. If still no file |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
36 ## is found, then variants with a leading "@@" and then with both a |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
37 ## leading "@@" and trailing ".m" will be considered. |
| 7325 | 38 ## |
| 39 ## @item | |
| 40 ## If @var{name} is the name of a function defined in the interpreter but | |
| 41 ## not in an m-file, then an m-file will be created in @code{HOME} | |
| 42 ## to contain that function along with its current definition. | |
| 43 ## | |
| 44 ## @item | |
| 45 ## If @code{name.cc} is specified, then it will search for @code{name.cc} | |
| 46 ## in the path and try to modify it, otherwise it will create a new | |
| 47 ## @file{.cc} file in @code{HOME}. If @var{name} happens to be an | |
| 48 ## m-file or interpreter defined function, then the text of that | |
| 49 ## function will be inserted into the .cc file as a comment. | |
| 50 ## | |
| 51 ## @item | |
|
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
52 ## If @var{name.ext} is on your path then it will be edited, otherwise |
| 7325 | 53 ## the editor will be started with @file{HOME/name.ext} as the |
| 54 ## filename. If @file{name.ext} is not modifiable, it will be copied to | |
| 55 ## @code{HOME} before editing. | |
| 56 ## | |
| 57 ## @strong{WARNING!} You may need to clear name before the new definition | |
| 58 ## is available. If you are editing a .cc file, you will need | |
| 59 ## to mkoctfile @file{name.cc} before the definition will be available. | |
| 60 ## @end itemize | |
| 61 ## | |
| 62 ## If @code{edit} is called with @var{field} and @var{value} variables, | |
| 63 ## the value of the control field @var{field} will be @var{value}. | |
| 64 ## If an output argument is requested and the first argument is @code{get} | |
| 65 ## then @code{edit} will return the value of the control field @var{field}. | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
66 ## If the control field does not exist, edit will return a structure |
|
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
67 ## containing all fields and values. Thus, @code{edit get all} returns |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
68 ## a complete control structure. |
| 7325 | 69 ## The following control fields are used: |
| 70 ## | |
| 71 ## @table @samp | |
| 72 ## @item editor | |
| 73 ## This is the editor to use to modify the functions. By default it uses | |
| 74 ## Octave's @code{EDITOR} built-in function, which comes from | |
| 75 ## @code{getenv("EDITOR")} and defaults to @code{emacs}. Use @code{%s} | |
| 76 ## In place of the function name. For example, | |
| 77 ## @table @samp | |
| 78 ## @item [EDITOR, " %s"] | |
| 79 ## Use the editor which Octave uses for @code{bug_report}. | |
| 80 ## @item "xedit %s &" | |
| 81 ## pop up simple X11 editor in a separate window | |
| 82 ## @item "gnudoit -q \"(find-file \\\"%s\\\")\"" | |
| 83 ## Send it to current Emacs; must have @code{(gnuserv-start)} in @file{.emacs}. | |
| 84 ## @end table | |
| 85 ## | |
|
8795
bb38a86efa1b
improve documentation for edit.m
Ivan Sutoris <ivan.sutoris@gmail.com>
parents:
8746
diff
changeset
|
86 ## See also field 'mode', which controls how the editor is run by Octave. |
|
bb38a86efa1b
improve documentation for edit.m
Ivan Sutoris <ivan.sutoris@gmail.com>
parents:
8746
diff
changeset
|
87 ## |
|
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
88 ## On Cygwin, you will need to convert the Cygwin path to a Windows |
| 7325 | 89 ## path if you are using a native Windows editor. For example |
|
9153
5247e89688e1
Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
90 ## @c Set example in small font to prevent overfull line |
|
5247e89688e1
Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
91 ## @smallexample |
| 7325 | 92 ## '"C:/Program Files/Good Editor/Editor.exe" "$(cygpath -wa %s)"' |
|
9153
5247e89688e1
Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents:
9038
diff
changeset
|
93 ## @end smallexample |
| 7325 | 94 ## |
| 95 ## @item home | |
|
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
96 ## This is the location of user local m-files. Be be sure it is in your |
|
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
97 ## path. The default is @file{~/octave}. |
| 7325 | 98 ## |
| 99 ## @item author | |
| 100 ## This is the name to put after the "## Author:" field of new functions. | |
| 101 ## By default it guesses from the @code{gecos} field of password database. | |
| 102 ## | |
| 103 ## @item email | |
| 104 ## This is the e-mail address to list after the name in the author field. | |
| 105 ## By default it guesses @code{<$LOGNAME@@$HOSTNAME>}, and if @code{$HOSTNAME} | |
| 106 ## is not defined it uses @code{uname -n}. You probably want to override this. | |
| 107 ## Be sure to use @code{<user@@host>} as your format. | |
| 108 ## | |
| 109 ## @item license | |
| 110 ## @table @samp | |
| 111 ## @item gpl | |
| 112 ## GNU General Public License (default). | |
| 113 ## @item bsd | |
| 114 ## BSD-style license without advertising clause. | |
| 115 ## @item pd | |
| 116 ## Public domain. | |
| 117 ## @item "text" | |
| 118 ## Your own default copyright and license. | |
| 119 ## @end table | |
| 120 ## | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
121 ## Unless you specify @samp{pd}, edit will prepend the copyright statement |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
122 ## with "Copyright (C) yyyy Function Author". |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
123 ## |
| 7325 | 124 ## @item mode |
| 125 ## This value determines whether the editor should be started in async mode | |
|
8795
bb38a86efa1b
improve documentation for edit.m
Ivan Sutoris <ivan.sutoris@gmail.com>
parents:
8746
diff
changeset
|
126 ## (editor is started in the background and Octave continues) or sync mode |
|
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
127 ## (Octave waits until the editor exits). Set it to "async" to start the editor |
|
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
128 ## in async mode. The default is "sync" (see also "system"). |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
129 ## |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
130 ## @item editinplace |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
131 ## Determines whether files should be edited in place, without regard to |
|
9038
fca0dc2fb042
Cleanup documentation files stmt.texi and func.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
132 ## whether they are modifiable or not. The default is @code{false}. |
| 7325 | 133 ## @end table |
| 134 ## @end deftypefn | |
| 135 | |
| 136 ## Author: Paul Kienzle <pkienzle@users.sf.net> | |
| 137 | |
| 138 ## Original version by Paul Kienzle distributed as free software in the | |
| 139 ## public domain. | |
| 140 | |
| 141 function ret = edit (file, state) | |
| 142 | |
| 143 ## Pick up globals or default them. | |
| 144 | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
145 persistent FUNCTION = struct ("EDITOR", cstrcat (EDITOR (), " %s"), |
| 7325 | 146 "HOME", fullfile (default_home, "octave"), |
| 147 "AUTHOR", default_user(1), | |
| 148 "EMAIL", [], | |
| 149 "LICENSE", "GPL", | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
150 "MODE", "sync", |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
151 "EDITINPLACE", false); |
| 7325 | 152 |
| 8506 | 153 ## Make sure the state variables survive "clear functions". |
| 154 mlock; | |
| 7325 | 155 |
| 156 if (nargin == 2) | |
| 157 switch (toupper (file)) | |
| 158 case "EDITOR" | |
| 159 FUNCTION.EDITOR = state; | |
| 160 case "HOME" | |
| 161 if (! isempty (state) && state(1) == "~") | |
| 162 state = [ default_home, state(2:end) ]; | |
| 163 endif | |
| 164 FUNCTION.HOME = state; | |
| 165 case "AUTHOR" | |
| 166 FUNCTION.AUTHOR = state; | |
| 167 case "EMAIL" | |
| 168 FUNCTION.EMAIL = state; | |
| 169 case "LICENSE" | |
| 170 FUNCTION.LICENSE = state; | |
| 171 case "MODE" | |
| 172 if (strcmp (state, "sync") || strcmp (state, "async")) | |
| 173 FUNCTION.MODE = state; | |
| 174 else | |
| 175 error('expected "edit MODE sync|async"'); | |
| 176 endif | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
177 case "EDITINPLACE" |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
178 if (ischar (state)) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
179 if (strcmpi (state, "true")) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
180 state = true; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
181 elseif (strcmpi (state, "false")) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
182 state = false; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
183 else |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
184 state = eval (state); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
185 endif |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
186 endif |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
187 FUNCTION.EDITINPLACE = state; |
| 7325 | 188 case "GET" |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
189 if (isfield (FUNCTION, toupper(state))) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
190 ret = FUNCTION.(toupper (state)); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
191 else |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
192 ret = FUNCTION; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
193 endif |
| 7325 | 194 otherwise |
| 195 error ("expected \"edit EDITOR|HOME|AUTHOR|EMAIL|LICENSE|MODE val\""); | |
| 196 endswitch | |
| 197 return | |
| 198 endif | |
| 199 | |
| 200 ## Start the editor without a file if no file is given. | |
| 201 if (nargin < 1) | |
| 202 if (exist (FUNCTION.HOME, "dir") == 7 && (isunix () || ! ispc ())) | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
203 system (cstrcat ("cd \"", FUNCTION.HOME, "\" ; ", |
| 7325 | 204 sprintf (FUNCTION.EDITOR, "")), |
| 205 [], FUNCTION.MODE); | |
| 206 else | |
| 207 system (sprintf (FUNCTION.EDITOR,""), [], FUNCTION.MODE); | |
| 208 endif | |
| 209 return; | |
| 210 endif | |
| 211 | |
| 212 ## Check whether the user is trying to edit a builtin of compiled function. | |
| 213 switch (exist (file)) | |
| 214 case {3, 5} | |
| 215 error ("unable to edit a built-in or compiled function"); | |
| 216 endswitch | |
| 217 | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
218 ## Checks for whether the file is |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
219 ## absolute or relative should be handled inside file_in_loadpath. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
220 ## That way, it will be possible to look up files correctly given |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
221 ## partial path information. For example, you should be able to |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
222 ## edit a particular overloaded function by doing any one of |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
223 ## |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
224 ## edit classname/foo |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
225 ## edit classname/foo.m |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
226 ## edit @classname/foo |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
227 ## edit @classname/foo.m |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
228 ## |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
229 ## This functionality is needed for other functions as well (at least |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
230 ## help and type; there may be more). So the place to fix that is in |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
231 ## file_in_loadpath, possibly with some help from the load_path class. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
232 |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
233 ## The code below includes a portion that serves as a place-holder for |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
234 ## the changes suggested above. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
235 |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
236 ## Create list of explicit and implicit file names. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
237 filelist = {file}; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
238 ## If file has no extension, add file.m and file.cc to the list. |
| 7325 | 239 idx = rindex (file, "."); |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
240 if (idx == 0) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
241 ## Create the list of files to look for |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
242 filelist = {file}; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
243 if (isempty (regexp (file, "\\.m$"))) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
244 ## No ".m" at the end of the file, add to the list. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
245 filelist{end+1} = cat (2, file, ".m"); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
246 endif |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
247 if (isempty (regexp (file, "\\.cc$"))) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
248 ## No ".cc" at the end of the file, add to the list. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
249 filelist{end+1} = cat (2, file, ".cc"); |
| 7325 | 250 endif |
| 251 endif | |
| 252 | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
253 ## If the file includes a path, it may be an overloaded function. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
254 if (! strcmp (file, "@") && index (file, filesep)) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
255 ## No "@" at the beginning of the file, add to the list. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
256 numfiles = numel(filelist); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
257 for n = 1:numfiles |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
258 filelist{n+numfiles} = cat (2, "@", filelist{n}); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
259 endfor |
| 7325 | 260 endif |
| 261 | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
262 ## Search the entire path for the 1st instance of a file in the list. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
263 fileandpath = ""; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
264 for n = 1:numel(filelist) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
265 filetoedit = file_in_path (path, filelist{n}); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
266 if (! isempty (filetoedit)) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
267 ## The path is explicitly included. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
268 fileandpath = filetoedit; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
269 break; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
270 endif |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
271 endfor |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
272 |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
273 if (! isempty (fileandpath)) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
274 ## If the file exists, then edit it. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
275 if (FUNCTION.EDITINPLACE) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
276 ## Edit in place even if it is protected. |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
277 system (sprintf (FUNCTION.EDITOR, cstrcat ("\"", fileandpath, "\"")), |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
278 [], FUNCTION.MODE); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
279 return; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
280 else |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
281 ## If the file is modifiable in place then edit it, otherwise make |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
282 ## a copy in HOME and then edit it. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
283 fid = fopen (fileandpath, "r+t"); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
284 if (fid < 0) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
285 from = fileandpath; |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
286 fileandpath = cstrcat (FUNCTION.HOME, from (rindex (from, filesep):end)); |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
287 [status, msg] = copyfile (from, fileandpath, 1); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
288 if (status == 0) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
289 error (msg); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
290 endif |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
291 else |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
292 fclose (fid); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
293 endif |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
294 system (sprintf (FUNCTION.EDITOR, cstrcat ("\"", fileandpath, "\"")), |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
295 [], FUNCTION.MODE); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
296 return; |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
297 endif |
| 7325 | 298 endif |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
299 |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
300 ## If editing a new file that is neither a m-file or an oct-file, |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
301 ## just edit it. |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
302 fileandpath = file; |
| 7325 | 303 idx = rindex (file, "."); |
| 304 name = file(1:idx-1); | |
| 305 ext = file(idx+1:end); | |
| 306 switch (ext) | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
307 case {"cc", "m"} |
| 7325 | 308 0; |
| 309 otherwise | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
310 system (sprintf (FUNCTION.EDITOR, cstrcat ("\"", fileandpath, "\"")), |
| 7325 | 311 [], FUNCTION.MODE); |
| 312 return; | |
| 313 endswitch | |
| 314 | |
| 315 ## The file doesn't exist in path so create it, put in the function | |
| 316 ## template and edit it. | |
| 317 | |
| 318 ## Guess the email name if it was not given. | |
| 319 if (isempty (FUNCTION.EMAIL)) | |
| 320 host = getenv("HOSTNAME"); | |
| 321 if (isempty (host) && ispc ()) | |
| 322 host = getenv ("COMPUTERNAME"); | |
| 323 endif | |
| 324 if (isempty (host)) | |
| 325 [status, host] = system ("uname -n"); | |
| 326 ## trim newline from end of hostname | |
| 327 if (! isempty (host)) | |
| 328 host = host(1:end-1); | |
| 329 endif | |
| 330 endif | |
| 331 if (isempty (host)) | |
| 332 FUNCTION.EMAIL = " "; | |
| 333 else | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
334 FUNCTION.EMAIL = cstrcat ("<", default_user(0), "@", host, ">"); |
| 7325 | 335 endif |
| 336 endif | |
| 337 | |
| 338 ## Fill in the revision string. | |
| 339 now = localtime (time); | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
340 revs = cstrcat ("Created: ", strftime ("%Y-%m-%d", now)); |
| 7325 | 341 |
| 342 ## Fill in the copyright string. | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
343 copyright = cstrcat (strftime ("Copyright (C) %Y ", now), FUNCTION.AUTHOR); |
| 7325 | 344 |
| 345 ## Fill in the author tag field. | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
346 author = cstrcat ("Author: ", FUNCTION.AUTHOR, " ", FUNCTION.EMAIL); |
| 7325 | 347 |
| 348 ## Fill in the header. | |
| 349 uclicense = toupper (FUNCTION.LICENSE); | |
| 350 switch (uclicense) | |
| 351 case "GPL" | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
352 head = cstrcat (copyright, "\n\n", "\ |
| 7325 | 353 This program is free software; you can redistribute it and/or modify\n\ |
| 354 it under the terms of the GNU General Public License as published by\n\ | |
| 355 the Free Software Foundation; either version 2 of the License, or\n\ | |
| 356 (at your option) any later version.\n\ | |
| 357 \n\ | |
| 358 This program is distributed in the hope that it will be useful,\n\ | |
| 359 but WITHOUT ANY WARRANTY; without even the implied warranty of\n\ | |
| 360 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\ | |
| 361 GNU General Public License for more details.\n\ | |
| 362 \n\ | |
| 363 You should have received a copy of the GNU General Public License\n\ | |
| 7444 | 364 along with Octave; see the file COPYING. If not, see\n\ |
| 365 <http://www.gnu.org/licenses/>.\ | |
| 7325 | 366 "); |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
367 tail = cstrcat (author, "\n", revs); |
| 7325 | 368 |
| 369 case "BSD" | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
370 head = cstrcat (copyright, "\n\n", "\ |
| 7325 | 371 This program is free software; redistribution and use in source and\n\ |
| 372 binary forms, with or without modification, are permitted provided that\n\ | |
| 373 the following conditions are met:\n\ | |
| 374 \n\ | |
| 375 1.Redistributions of source code must retain the above copyright\n\ | |
| 376 notice, this list of conditions and the following disclaimer.\n\ | |
| 377 2.Redistributions in binary form must reproduce the above copyright\n\ | |
| 378 notice, this list of conditions and the following disclaimer in the\n\ | |
| 379 documentation and/or other materials provided with the distribution.\n\ | |
| 380 \n\ | |
| 381 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND\n\ | |
| 382 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n\ | |
| 383 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\n\ | |
| 384 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE\n\ | |
| 385 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n\ | |
| 386 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\n\ | |
| 387 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\n\ | |
| 388 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\n\ | |
| 389 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\n\ | |
| 390 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\n\ | |
| 391 SUCH DAMAGE.\ | |
| 392 "); | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
393 tail = cstrcat (author, "\n", revs); |
| 7325 | 394 |
| 395 case "PD" | |
| 396 head = ""; | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
397 tail = cstrcat (author, "\n", revs, "\n\n", |
| 7434 | 398 "This program is granted to the public domain."); |
| 7325 | 399 |
| 400 otherwise | |
| 401 head = ""; | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
402 tail = cstrcat (copyright, "\n\n", FUNCTION.LICENSE, "\n", |
| 7434 | 403 author, "\n", revs); |
| 7325 | 404 endswitch |
| 405 | |
| 406 ## Generate the function template. | |
| 407 exists = exist (name); | |
| 408 switch (ext) | |
| 409 case {"cc", "C", "cpp"} | |
| 410 if (isempty (head)) | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
411 comment = cstrcat ("/*\n", tail, "\n\n*/\n\n"); |
| 7325 | 412 else |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
413 comment = cstrcat ("/*\n", head, "\n\n", tail, "\n\n*/\n\n"); |
| 7325 | 414 endif |
| 415 ## If we are shadowing an m-file, paste the code for the m-file. | |
| 416 if (any (exists == [2, 103])) | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
417 code = cstrcat ("\\ ", strrep (type (name), "\n", "\n// ")); |
| 7325 | 418 else |
| 419 code = " "; | |
| 420 endif | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
421 body = cstrcat ("#include <octave/oct.h>\n\n", |
| 7325 | 422 "DEFUN_DLD(", name, ",args,nargout,\"\\\n", |
| 423 name, "\\n\\\n\")\n{\n", | |
| 424 " octave_value_list retval;\n", | |
| 425 " int nargin = args.length();\n\n", | |
| 426 code, "\n return retval;\n}\n"); | |
| 427 | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
428 text = cstrcat (comment, body); |
| 7325 | 429 case "m" |
| 430 ## If we are editing a function defined on the fly, paste the | |
| 431 ## code. | |
| 432 if (any (exists == [2, 103])) | |
| 433 body = type (name); | |
| 434 else | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
435 body = cstrcat ("function [ ret ] = ", name, " ()\n\nendfunction\n"); |
| 7325 | 436 endif |
| 437 if (isempty (head)) | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
438 comment = cstrcat ("## ", name, "\n\n", |
| 7325 | 439 "## ", strrep (tail, "\n", "\n## "), "\n\n"); |
| 440 else | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
441 comment = cstrcat ("## ", strrep(head,"\n","\n## "), "\n\n", ... |
| 7325 | 442 "## ", name, "\n\n", ... |
| 443 "## ", strrep (tail, "\n", "\n## "), "\n\n"); | |
| 444 endif | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
445 text = cstrcat (comment, body); |
| 7325 | 446 endswitch |
| 447 | |
| 448 ## Write the initial file (if there is anything to write) | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
449 fid = fopen (fileandpath, "wt"); |
| 7325 | 450 if (fid < 0) |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
451 error ("edit: could not create %s", fileandpath); |
| 7325 | 452 endif |
| 453 fputs (fid, text); | |
| 454 fclose (fid); | |
| 455 | |
| 456 ## Finally we are ready to edit it! | |
|
7540
3422f39573b1
strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents:
7502
diff
changeset
|
457 system (sprintf (FUNCTION.EDITOR, cstrcat ("\"", fileandpath, "\"")), |
| 7325 | 458 [], FUNCTION.MODE); |
| 459 | |
| 460 endfunction | |
| 461 | |
| 462 function ret = default_home () | |
| 463 | |
| 464 ret = getenv ("HOME"); | |
| 465 if (isempty (ret)) | |
| 466 ret = glob ("~"); | |
| 467 if (! isempty (ret)) | |
| 468 ret = ret{1}; | |
| 469 else | |
| 470 ret = ""; | |
| 471 endif | |
| 472 endif | |
| 473 | |
| 474 endfunction | |
| 475 | |
| 7434 | 476 ## Return the name associated with the current user ID. |
| 7325 | 477 ## |
| 7434 | 478 ## If LONG_FORM is 1, return the full name. This will be the |
| 479 ## default author. Otherwise return the login name. | |
| 7325 | 480 ## login@host will be the default email address. |
| 481 | |
| 482 function ret = default_user (long_form) | |
| 483 | |
| 484 ent = getpwuid (getuid); | |
| 485 if (! isstruct (ent)) | |
| 486 ret = getenv ("USER"); | |
| 7330 | 487 if (isempty (ret)) |
| 7325 | 488 ret = getenv ("USERNAME"); |
| 489 endif | |
| 490 elseif (long_form) | |
| 491 ret = ent.gecos; | |
| 7434 | 492 pos = strfind (ret, ","); |
| 493 if (! isempty (pos)) | |
| 494 ret = ret(1:pos-1); | |
| 495 endif | |
| 7325 | 496 else |
| 497 ret = ent.name; | |
| 498 endif | |
| 499 | |
| 500 endfunction | |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
501 |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
502 %!test |
|
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8506
diff
changeset
|
503 %! s.editor = edit ("get", "editor"); |
|
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8506
diff
changeset
|
504 %! s.home = edit ("get", "home"); |
|
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8506
diff
changeset
|
505 %! s.author = edit ("get", "author"); |
|
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8506
diff
changeset
|
506 %! s.email = edit ("get", "email"); |
|
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8506
diff
changeset
|
507 %! s.license = edit ("get", "license"); |
|
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8506
diff
changeset
|
508 %! s.editinplace = edit ("get", "editinplace"); |
|
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8506
diff
changeset
|
509 %! s.mode = edit ("get", "mode"); |
|
7502
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
510 %! edit editor none |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
511 %! edit home none |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
512 %! edit author none |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
513 %! edit email none |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
514 %! edit license none |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
515 %! edit ("editinplace", !s.editinplace) |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
516 %! if (s.mode(1) == "a") |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
517 %! edit mode sync |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
518 %! else |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
519 %! edit mode async |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
520 %! endif |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
521 %! edit ("editor", s.editor); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
522 %! edit ("home", s.home); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
523 %! edit ("author", s.author); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
524 %! edit ("email", s.email); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
525 %! edit ("license", s.license); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
526 %! edit ("editinplace", s.editinplace); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
527 %! edit ("mode", s.mode); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
528 %! assert (edit ("get", "editor"), s.editor); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
529 %! assert (edit ("get", "home"), s.home); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
530 %! assert (edit ("get", "author"), s.author); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
531 %! assert (edit ("get", "email"), s.email); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
532 %! assert (edit ("get", "license"), s.license); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
533 %! assert (edit ("get", "editinplace"), s.editinplace); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
534 %! assert (edit ("get", "mode"), s.mode); |
|
2ce6b4258e96
Modified for consistency with Matlab. Modified to respect partial paths needed for overloaded functions.
Ben Abbott <bpabbott@mac.com>
parents:
7444
diff
changeset
|
535 |