Mercurial > octave
view libinterp/corefcn/defaults.cc @ 21100:e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
* libinterp/corefcn/errwarn.h, libinterp/corefcn/errwarn.cc: New header and .cc
file with common errors and warnings for libinterp.
* libinterp/corefcn/module.mk: Add errwarn.h, errwarn.cc to build system.
* liboctave/util/lo-array-errwarn.h, liboctave/util/lo-array-errwarn.cc: New
header and .cc file with common errors and warnings for liboctave.
* liboctave/util/module.mk: Add lo-array-errwarn.h, lo-array-errwarn.cc to
build system.
* lo-array-gripes.h: #include "lo-array-errwarn.h" for access to class
index_exception. Remove const char *error_id_XXX prototypes.
* lo-array-gripes.cc: Remove const char *error_id_XXX initializations.
Remove index_exception method definitions.
* Cell.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, betainc.cc, cellfun.cc,
daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc,
dirfns.cc, eig.cc, fft.cc, fft2.cc, fftn.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, graphics.in.h, help.cc, hess.cc, hex2num.cc,
input.cc, inv.cc, jit-typeinfo.cc, load-save.cc, lookup.cc, ls-hdf5.cc,
ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-binary.cc, ls-oct-text.cc,
lsode.cc, lu.cc, luinc.cc, max.cc, mgorth.cc, oct-hist.cc, oct-procbuf.cc,
oct-stream.cc, oct.h, pager.cc, pinv.cc, pr-output.cc, quad.cc, qz.cc, rand.cc,
rcond.cc, regexp.cc, schur.cc, sparse-xdiv.cc, sparse-xpow.cc, sparse.cc,
spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc,
sylvester.cc, syscalls.cc, typecast.cc, utils.cc, variables.cc, xdiv.cc,
xnorm.cc, xpow.cc, __eigs__.cc, __glpk__.cc, __magick_read__.cc,
__osmesa_print__.cc, audiodevinfo.cc, audioread.cc, chol.cc, dmperm.cc,
fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-base-diag.cc, ov-base-int.cc,
ov-base-mat.cc, ov-base-scalar.cc, ov-base-sparse.cc, ov-base.cc,
ov-bool-mat.cc, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.cc, ov-cell.cc,
ov-ch-mat.cc, ov-class.cc, ov-complex.cc, ov-complex.h, ov-cs-list.cc,
ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-fcn-handle.cc,
ov-fcn-inline.cc, ov-float.cc, ov-float.h, ov-flt-complex.cc, ov-flt-complex.h,
ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-intx.h, ov-mex-fcn.cc, ov-perm.cc,
ov-range.cc, ov-re-mat.cc, ov-re-sparse.cc, ov-scalar.cc, ov-scalar.h,
ov-str-mat.cc, ov-struct.cc, ov-type-conv.h, ov-uint16.cc, ov-uint32.cc,
ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.cc, op-b-b.cc, op-b-bm.cc,
op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc,
op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc,
op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dms-template.cc, op-double-conv.cc, op-fcdm-fcdm.cc, op-fcdm-fdm.cc,
op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc,
op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc,
op-float-conv.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc,
op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc,
op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc, op-int-conv.cc,
op-int.h, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc,
op-m-sm.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-range.cc, op-s-cm.cc,
op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc,
op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc,
op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc,
op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc,
op-struct.cc, op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc,
ops.h, lex.ll, pt-assign.cc, pt-eval.cc, pt-idx.cc, pt-loop.cc, pt-mat.cc,
pt-stmt.cc, Array-util.cc, Array-util.h, Array.cc, CColVector.cc,
CDiagMatrix.cc, CMatrix.cc, CNDArray.cc, CRowVector.cc, CSparse.cc,
DiagArray2.cc, MDiagArray2.cc, MSparse.cc, PermMatrix.cc, Range.cc, Sparse.cc,
dColVector.cc, dDiagMatrix.cc, dMatrix.cc, dNDArray.cc, dRowVector.cc,
dSparse.cc, fCColVector.cc, fCDiagMatrix.cc, fCMatrix.cc, fCNDArray.cc,
fCRowVector.cc, fColVector.cc, fDiagMatrix.cc, fMatrix.cc, fNDArray.cc,
fRowVector.cc, idx-vector.cc, CmplxGEPBAL.cc, dbleGEPBAL.cc, fCmplxGEPBAL.cc,
floatGEPBAL.cc, Sparse-diag-op-defs.h, Sparse-op-defs.h, Sparse-perm-op-defs.h,
mx-inlines.cc, mx-op-defs.h, oct-binmap.h:
Replace 'include "gripes.h"' with 'include "errwarn.h". Change all gripe_XXX
to err_XXX or warn_XXX or errwarn_XXX.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 18 Jan 2016 18:28:06 -0800 |
parents | 48b2ad5ee801 |
children | df7891224709 |
line wrap: on
line source
/* Copyright (C) 1996-2015 John W. Eaton 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 <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include <cstdlib> #include <algorithm> #include <iostream> #include <string> #include <sys/types.h> #include <unistd.h> #include "dir-ops.h" #include "oct-env.h" #include "file-stat.h" #include "pathsearch.h" #include "str-vec.h" #include <defaults.h> #include "defun.h" #include "error.h" #include "file-ops.h" #include "errwarn.h" #include "help.h" #include "input.h" #include "load-path.h" #include "ovl.h" #include "ov.h" #include "parse.h" #include "toplev.h" #include "unwind-prot.h" #include "variables.h" #include <version.h> std::string Voctave_home; std::string Vbin_dir; std::string Vinfo_dir; std::string Vdata_dir; std::string Vlibexec_dir; std::string Varch_lib_dir; std::string Vlocal_arch_lib_dir; std::string Vlocal_api_arch_lib_dir; std::string Vlocal_ver_arch_lib_dir; std::string Vlocal_ver_oct_file_dir; std::string Vlocal_api_oct_file_dir; std::string Vlocal_oct_file_dir; std::string Vlocal_ver_fcn_file_dir; std::string Vlocal_api_fcn_file_dir; std::string Vlocal_fcn_file_dir; std::string Voct_data_dir; std::string Voct_etc_dir; std::string Voct_locale_dir; std::string Voct_file_dir; std::string Vfcn_file_dir; std::string Vimage_dir; // The path that will be searched for programs that we execute. // (--exec-path path) static std::string VEXEC_PATH; // Name of the editor to be invoked by the edit_history command. std::string VEDITOR; static std::string VIMAGE_PATH; std::string Vlocal_site_defaults_file; std::string Vsite_defaults_file; std::string Vbuilt_in_docstrings_file; std::string subst_octave_home (const std::string& s) { std::string retval; std::string prefix = OCTAVE_PREFIX; retval = s; if (Voctave_home != prefix) { octave_idx_type len = prefix.length (); if (s.substr (0, len) == prefix) retval.replace (0, len, Voctave_home); } if (file_ops::dir_sep_char () != '/') std::replace (retval.begin (), retval.end (), '/', file_ops::dir_sep_char ()); return retval; } static void set_octave_home (void) { std::string oh = octave_env::getenv ("OCTAVE_HOME"); Voctave_home = oh.empty () ? std::string (OCTAVE_PREFIX) : oh; } static void set_default_info_dir (void) { Vinfo_dir = subst_octave_home (OCTAVE_INFODIR); } static void set_default_data_dir (void) { Vdata_dir = subst_octave_home (OCTAVE_DATADIR); } static void set_default_libexec_dir (void) { Vlibexec_dir = subst_octave_home (OCTAVE_LIBEXECDIR); } static void set_default_arch_lib_dir (void) { Varch_lib_dir = subst_octave_home (OCTAVE_ARCHLIBDIR); } static void set_default_local_arch_lib_dir (void) { Vlocal_arch_lib_dir = subst_octave_home (OCTAVE_LOCALARCHLIBDIR); } static void set_default_local_api_arch_lib_dir (void) { Vlocal_api_arch_lib_dir = subst_octave_home (OCTAVE_LOCALAPIARCHLIBDIR); } static void set_default_local_ver_arch_lib_dir (void) { Vlocal_ver_arch_lib_dir = subst_octave_home (OCTAVE_LOCALVERARCHLIBDIR); } static void set_default_local_ver_oct_file_dir (void) { Vlocal_ver_oct_file_dir = subst_octave_home (OCTAVE_LOCALVEROCTFILEDIR); } static void set_default_local_api_oct_file_dir (void) { Vlocal_api_oct_file_dir = subst_octave_home (OCTAVE_LOCALAPIOCTFILEDIR); } static void set_default_local_oct_file_dir (void) { Vlocal_oct_file_dir = subst_octave_home (OCTAVE_LOCALOCTFILEDIR); } static void set_default_local_ver_fcn_file_dir (void) { Vlocal_ver_fcn_file_dir = subst_octave_home (OCTAVE_LOCALVERFCNFILEDIR); } static void set_default_local_api_fcn_file_dir (void) { Vlocal_api_fcn_file_dir = subst_octave_home (OCTAVE_LOCALAPIFCNFILEDIR); } static void set_default_local_fcn_file_dir (void) { Vlocal_fcn_file_dir = subst_octave_home (OCTAVE_LOCALFCNFILEDIR); } static void set_default_fcn_file_dir (void) { Vfcn_file_dir = subst_octave_home (OCTAVE_FCNFILEDIR); } static void set_default_image_dir (void) { Vimage_dir = subst_octave_home (OCTAVE_IMAGEDIR); } static void set_default_oct_data_dir (void) { Voct_data_dir = subst_octave_home (OCTAVE_OCTDATADIR); } static void set_default_oct_etc_dir (void) { Voct_etc_dir = subst_octave_home (OCTAVE_OCTETCDIR); } static void set_default_oct_locale_dir (void) { Voct_locale_dir = subst_octave_home (OCTAVE_OCTLOCALEDIR); } static void set_default_oct_file_dir (void) { Voct_file_dir = subst_octave_home (OCTAVE_OCTFILEDIR); } static void set_default_bin_dir (void) { Vbin_dir = subst_octave_home (OCTAVE_BINDIR); } void set_exec_path (const std::string& path_arg) { std::string tpath = path_arg; if (tpath.empty ()) tpath = octave_env::getenv ("OCTAVE_EXEC_PATH"); if (tpath.empty ()) tpath = Vlocal_ver_arch_lib_dir + dir_path::path_sep_str () + Vlocal_api_arch_lib_dir + dir_path::path_sep_str () + Vlocal_arch_lib_dir + dir_path::path_sep_str () + Varch_lib_dir + dir_path::path_sep_str () + Vbin_dir; VEXEC_PATH = tpath; // FIXME: should we really be modifying PATH in the environment? // The way things are now, Octave will ignore directories set in the // PATH with calls like // // setenv ("PATH", "/my/path"); // // To fix this, I think Octave should be searching the combination of // PATH and EXEC_PATH for programs that it executes instead of setting // the PATH in the environment and relying on the shell to do the // searching. // This is static so that even if set_exec_path is called more than // once, shell_path is the original PATH from the environment, // before we start modifying it. static std::string shell_path = octave_env::getenv ("PATH"); if (! shell_path.empty ()) tpath = shell_path + dir_path::path_sep_str () + tpath; octave_env::putenv ("PATH", tpath); } void set_image_path (const std::string& path) { VIMAGE_PATH = "."; std::string tpath = path; if (tpath.empty ()) tpath = octave_env::getenv ("OCTAVE_IMAGE_PATH"); if (! tpath.empty ()) VIMAGE_PATH += dir_path::path_sep_str () + tpath; tpath = genpath (Vimage_dir, ""); if (! tpath.empty ()) VIMAGE_PATH += dir_path::path_sep_str () + tpath; } static void set_default_doc_cache_file (void) { if (Vdoc_cache_file.empty ()) { std::string def_file = subst_octave_home (OCTAVE_DOC_CACHE_FILE); std::string env_file = octave_env::getenv ("OCTAVE_DOC_CACHE_FILE"); Vdoc_cache_file = env_file.empty () ? def_file : env_file; } } static void set_default_texi_macros_file (void) { if (Vtexi_macros_file.empty ()) { std::string def_file = subst_octave_home (OCTAVE_TEXI_MACROS_FILE); std::string env_file = octave_env::getenv ("OCTAVE_TEXI_MACROS_FILE"); Vtexi_macros_file = env_file.empty () ? def_file : env_file; } } static void set_default_info_file (void) { if (Vinfo_file.empty ()) { std::string std_info_file = subst_octave_home (OCTAVE_INFOFILE); std::string oct_info_file = octave_env::getenv ("OCTAVE_INFO_FILE"); Vinfo_file = oct_info_file.empty () ? std_info_file : oct_info_file; } } static void set_default_info_prog (void) { if (Vinfo_program.empty ()) { std::string oct_info_prog = octave_env::getenv ("OCTAVE_INFO_PROGRAM"); if (oct_info_prog.empty ()) Vinfo_program = "info"; else Vinfo_program = std::string (oct_info_prog); } } static void set_default_editor (void) { VEDITOR = "emacs"; std::string env_editor = octave_env::getenv ("EDITOR"); if (! env_editor.empty ()) VEDITOR = env_editor; } static void set_local_site_defaults_file (void) { std::string lsf = octave_env::getenv ("OCTAVE_SITE_INITFILE"); if (lsf.empty ()) { Vlocal_site_defaults_file = subst_octave_home (OCTAVE_LOCALSTARTUPFILEDIR); Vlocal_site_defaults_file.append ("/octaverc"); } else Vlocal_site_defaults_file = lsf; } static void set_site_defaults_file (void) { std::string sf = octave_env::getenv ("OCTAVE_VERSION_INITFILE"); if (sf.empty ()) { Vsite_defaults_file = subst_octave_home (OCTAVE_STARTUPFILEDIR); Vsite_defaults_file.append ("/octaverc"); } else Vsite_defaults_file = sf; } static void set_built_in_docstrings_file (void) { if (Vbuilt_in_docstrings_file.empty ()) { std::string df = octave_env::getenv ("OCTAVE_BUILT_IN_DOCSTRINGS_FILE"); if (df.empty ()) Vbuilt_in_docstrings_file = Voct_etc_dir + file_ops::dir_sep_str () + "built-in-docstrings"; else Vbuilt_in_docstrings_file = df; } } void install_defaults (void) { // OCTAVE_HOME must be set first! set_octave_home (); set_default_info_dir (); set_default_data_dir (); set_default_libexec_dir (); set_default_arch_lib_dir (); set_default_local_ver_arch_lib_dir (); set_default_local_api_arch_lib_dir (); set_default_local_arch_lib_dir (); set_default_local_ver_oct_file_dir (); set_default_local_api_oct_file_dir (); set_default_local_oct_file_dir (); set_default_local_ver_fcn_file_dir (); set_default_local_api_fcn_file_dir (); set_default_local_fcn_file_dir (); set_default_oct_data_dir (); set_default_oct_etc_dir (); set_default_oct_locale_dir (); set_default_fcn_file_dir (); set_default_oct_file_dir (); set_default_image_dir (); set_default_bin_dir (); set_exec_path (); set_image_path (); set_default_doc_cache_file (); set_default_texi_macros_file (); set_default_info_file (); set_default_info_prog (); set_default_editor (); set_local_site_defaults_file (); set_site_defaults_file (); set_built_in_docstrings_file (); } DEFUN (EDITOR, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {@var{val} =} EDITOR ()\n\ @deftypefnx {} {@var{old_val} =} EDITOR (@var{new_val})\n\ @deftypefnx {} {} EDITOR (@var{new_val}, \"local\")\n\ Query or set the internal variable that specifies the default text editor.\n\ \n\ The default value is taken from the environment variable @w{@env{EDITOR}}\n\ when Octave starts. If the environment variable is not initialized,\n\ @w{@env{EDITOR}} will be set to @qcode{\"emacs\"}.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ \n\ @seealso{edit, edit_history}\n\ @end deftypefn") { return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (EDITOR); } /* %!test %! orig_val = EDITOR (); %! old_val = EDITOR ("X"); %! assert (orig_val, old_val); %! assert (EDITOR (), "X"); %! EDITOR (orig_val); %! assert (EDITOR (), orig_val); %!error (EDITOR (1, 2)) */ DEFUN (EXEC_PATH, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {@var{val} =} EXEC_PATH ()\n\ @deftypefnx {} {@var{old_val} =} EXEC_PATH (@var{new_val})\n\ @deftypefnx {} {} EXEC_PATH (@var{new_val}, \"local\")\n\ Query or set the internal variable that specifies a colon separated\n\ list of directories to append to the shell PATH when executing external\n\ programs.\n\ \n\ The initial value of is taken from the environment variable\n\ @w{@env{OCTAVE_EXEC_PATH}}, but that value can be overridden by the command\n\ line argument @option{--exec-path PATH}.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ \n\ @seealso{IMAGE_PATH, OCTAVE_HOME}\n\ @end deftypefn") { octave_value retval = SET_NONEMPTY_INTERNAL_STRING_VARIABLE (EXEC_PATH); if (args.length () > 0) set_exec_path (VEXEC_PATH); return retval; } /* %!test %! orig_val = EXEC_PATH (); %! old_val = EXEC_PATH ("X"); %! assert (orig_val, old_val); %! assert (EXEC_PATH (), "X"); %! EXEC_PATH (orig_val); %! assert (EXEC_PATH (), orig_val); %!error (EXEC_PATH (1, 2)) */ DEFUN (IMAGE_PATH, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {@var{val} =} IMAGE_PATH ()\n\ @deftypefnx {} {@var{old_val} =} IMAGE_PATH (@var{new_val})\n\ @deftypefnx {} {} IMAGE_PATH (@var{new_val}, \"local\")\n\ Query or set the internal variable that specifies a colon separated\n\ list of directories in which to search for image files.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ \n\ @seealso{EXEC_PATH, OCTAVE_HOME}\n\ @end deftypefn") { return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (IMAGE_PATH); } /* %!test %! orig_val = IMAGE_PATH (); %! old_val = IMAGE_PATH ("X"); %! assert (orig_val, old_val); %! assert (IMAGE_PATH (), "X"); %! IMAGE_PATH (orig_val); %! assert (IMAGE_PATH (), orig_val); %!error (IMAGE_PATH (1, 2)) */ DEFUN (OCTAVE_HOME, args, , "-*- texinfo -*-\n\ @deftypefn {} {} OCTAVE_HOME ()\n\ Return the name of the top-level Octave installation directory.\n\ @seealso{EXEC_PATH, IMAGE_PATH}\n\ @end deftypefn") { if (args.length () != 0) print_usage (); return octave_value (Voctave_home); } /* %!assert (ischar (OCTAVE_HOME ())) %!error OCTAVE_HOME (1) */ DEFUNX ("OCTAVE_VERSION", FOCTAVE_VERSION, args, , "-*- texinfo -*-\n\ @deftypefn {} {} OCTAVE_VERSION ()\n\ Return the version number of Octave as a string.\n\ @seealso{ver, version}\n\ @end deftypefn") { if (args.length () != 0) print_usage (); return octave_value (OCTAVE_VERSION); } /* %!assert (ischar (OCTAVE_VERSION ())) %!error OCTAVE_VERSION (1) */