Mercurial > octave
view scripts/path/pathdef.m @ 33559:62fca924fe85 default tip @
doc: Update NEWS.10.md file.
* NEWS.10.md: Indent NEWS.10.md for clarity.
Add note about changes to colormap() functionality.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 09 May 2024 18:23:33 -0700 |
parents | 2e484f9f1f18 |
children |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2005-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 {} {@var{val} =} pathdef () ## Return the default path for Octave. ## ## The path information is extracted from one of four sources. ## The possible sources, in order of preference, are: ## ## @enumerate ## @item @file{.octaverc} ## ## @item @file{~/.octaverc} ## ## @item @file{<OCTAVE_HOME>/@dots{}/<version>/m/startup/octaverc} ## ## @item Octave's path prior to changes by any octaverc file. ## @end enumerate ## @seealso{path, addpath, rmpath, genpath, savepath} ## @end deftypefn function val = pathdef () ## Locate any project-specific .octaverc file. proj_octaverc = fullfile (pwd, ".octaverc"); if (exist (proj_octaverc, "file")) proj_path = __extractpath__ (proj_octaverc); if (! isempty (proj_path)) val = proj_path; return; endif endif ## Locate the user's ~/.octaverc file. user_octaverc = fullfile ("~", ".octaverc"); if (exist (user_octaverc, "file")) user_path = __extractpath__ (user_octaverc); if (! isempty (user_path)) val = user_path; return; endif endif ## No user octaverc file, locate the site octaverc file. pathdir = __octave_config_info__ ("localstartupfiledir"); site_octaverc = fullfile (pathdir, "octaverc"); site_path = __extractpath__ (site_octaverc); if (! isempty (site_path)) val = site_path; return; endif ## No project, user, or site octaverc file. Use Octave's default. val = __pathorig__ (); endfunction ## Extract the path information from the script/function @var{file}, created by ## @file{savepath.m}. If successful, @code{__extractpath__} returns the path ## specified in @var{file}. function path = __extractpath__ (savefile) [filelines, startline, endline] = getsavepath (savefile); if (startline > 0) tmp = regexprep (filelines(startline+1:endline-1), "^.*path \\('([^\']+)'.*$", "$1"); path = strjoin (tmp, ":"); else path = ""; endif endfunction ## Test that pathdef does not contain a newly added directory %!test %! path_orig = path (); %! tmp_dir = tempname (); %! unwind_protect %! mkdir (tmp_dir); %! ## Required on Windows to make sure an 8.3 name is converted to full name %! ## which is what is always stored in path(). See bug #59039. %! tmp_dir = canonicalize_file_name (tmp_dir); %! addpath (tmp_dir); %! p1 = path (); %! p2 = pathdef (); %! assert (! isempty (strfind (p1, tmp_dir))); %! assert (isempty (strfind (p2, tmp_dir))); %! unwind_protect_cleanup %! sts = rmdir (tmp_dir); %! path (path_orig); %! end_unwind_protect ## Test that pathdef does not modify the current load path %!test <*51994> %! path_orig = path (); %! tmp_dir = tempname (); %! unwind_protect %! mkdir (tmp_dir); %! tmp_dir = canonicalize_file_name (tmp_dir); %! addpath (tmp_dir); %! path_1 = path (); %! p = pathdef (); %! path_2 = path (); %! assert (path_1, path_2); %! unwind_protect_cleanup %! sts = rmdir (tmp_dir); %! path (path_orig); %! end_unwind_protect ## Test input validation %!error pathdef (1) %!error pathdef ("/")