Mercurial > octave-nkf
view libinterp/corefcn/defaults.cc @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 19 Aug 2013 20:46:38 -0700 |
parents | 23f6852052bb |
children | d63878346099 |
line wrap: on
line source
/* Copyright (C) 1996-2012 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 "gripes.h" #include "help.h" #include "input.h" #include "load-path.h" #include "oct-obj.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_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_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_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 {Built-in Function} {@var{val} =} EDITOR ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} EDITOR (@var{new_val})\n\ @deftypefnx {Built-in Function} {} EDITOR (@var{new_val}, \"local\")\n\ Query or set the internal variable that specifies the editor to\n\ use with the @code{edit_history} command. The default value is taken from\n\ the environment variable @w{@env{EDITOR}} when Octave starts. If the\n\ environment variable is not initialized, @w{@env{EDITOR}} will be set to\n\ @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_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 {Built-in Function} {@var{val} =} EXEC_PATH ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} EXEC_PATH (@var{new_val})\n\ @deftypefnx {Built-in Function} {} 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. The initial value of is taken from the environment variable\n\ @w{@env{OCTAVE_EXEC_PATH}}, but that value can be overridden by\n\ the command 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 {Built-in Function} {@var{val} =} IMAGE_PATH ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} IMAGE_PATH (@var{new_val})\n\ @deftypefnx {Built-in Function} {} 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 {Built-in Function} {} OCTAVE_HOME ()\n\ Return the name of the top-level Octave installation directory.\n\ \n\ @seealso{EXEC_PATH, IMAGE_PATH}\n\ @end deftypefn") { octave_value retval; if (args.length () == 0) retval = Voctave_home; else print_usage (); return retval; } /* %!assert (ischar (OCTAVE_HOME ())) %!error OCTAVE_HOME (1) */ DEFUNX ("OCTAVE_VERSION", FOCTAVE_VERSION, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} OCTAVE_VERSION ()\n\ Return the version number of Octave, as a string.\n\ @end deftypefn") { octave_value retval; int nargin = args.length (); if (nargin == 0) retval = OCTAVE_VERSION; else print_usage (); return retval; } /* %!assert (ischar (OCTAVE_VERSION ())) %!error OCTAVE_VERSION (1) */