octave: libinterp/corefcn/environment.cc annotate

annotate libinterp/corefcn/environment.cc @ 33617:ec2635a02328 bytecode-interpreter tip

maint: Merge default to bytecode-interpreter.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Tue, 21 May 2024 18:29:03 +0200
parents	1a6cb4552775
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 32589 diff changeset	3 // Copyright (C) 2017-2024 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	25
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	26 #if defined (HAVE_CONFIG_H)
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	27 # include "config.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	28 #endif
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	29
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	30 #include <string>
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	31
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	32 #include "dir-ops.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	33 #include "oct-env.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	34 #include "file-stat.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	35 #include "pathsearch.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	36 #include "str-vec.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	37
25460 627d6bde9b8d solve installation info initialization problem differently John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	38 #include "defaults.h"
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	39 #include "defun.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	40 #include "environment.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	41 #include "interpreter.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	42 #include "variables.h"
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	43
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30588 diff changeset	44 OCTAVE_BEGIN_NAMESPACE(octave)
29960 939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	45
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	46 static void append_to_shell_path (const std::string& exec_path)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	47 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	48 // FIXME: should there be a way to remove a previous setting from
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	49 // PATH?
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	50
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	51 if (exec_path.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	52 return;
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	53
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	54 // FIXME: should we really be modifying PATH in the environment?
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	55
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	56 std::string shell_path = sys::env::getenv ("PATH");
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	57
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	58 if (shell_path.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	59 sys::env::putenv ("PATH", exec_path);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	60 else
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	61 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	62 // If PATH doesn't already have exec_path, append it.
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	63 // FIXME: should we search for the elements individually, and
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	64 // only append those that are missing?
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	65
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	66 std::string path_sep = directory_path::path_sep_str ();
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	67
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	68 if (shell_path.find (exec_path) == std::string::npos)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	69 sys::env::putenv ("PATH", shell_path + path_sep + exec_path);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	70 }
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	71 }
27101 097774bed4ed move some static functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	72
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	73 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	74 environment::editor (const octave_value_list& args, int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	75 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	76 return set_internal_variable (m_editor, args, nargout, "EDITOR", false);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	77 }
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	78
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	79
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	80 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	81 environment::exec_path (const octave_value_list& args, int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	82 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	83 octave_value retval
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	84 = set_internal_variable (m_exec_path, args, nargout, "EXEC_PATH", false);
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	85
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	86 append_to_shell_path (m_exec_path);
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	87
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	88 return retval;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	89 }
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	90
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	91 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	92 environment::exec_path (const std::string& path)
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	93 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	94 std::string old_val = set (m_exec_path, path);
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	95
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	96 append_to_shell_path (m_exec_path);
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	97
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	98 return old_val;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	99 }
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	100
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	101 octave_value
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	102 environment::image_path (const octave_value_list& args, int nargout)
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	103 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	104 return set_internal_variable (m_image_path, args, nargout, "IMAGE_PATH",
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	105 false);
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	106 }
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	107
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	108 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	109 environment::init_editor ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	110 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	111 std::string retval = "emacs";
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	112
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	113 std::string env_editor = sys::env::getenv ("EDITOR");
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	114
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	115 if (! env_editor.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	116 retval = env_editor;
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	117
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	118 return retval;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	119 }
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	120
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	121 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	122 environment::init_exec_path ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	123 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	124 std::string exec_path = sys::env::getenv ("OCTAVE_EXEC_PATH");
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	125
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	126 std::string path_sep = directory_path::path_sep_str ();
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	127
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	128 if (exec_path.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	129 exec_path = (config::local_ver_arch_lib_dir () + path_sep
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	130 + config::local_api_arch_lib_dir () + path_sep
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	131 + config::local_arch_lib_dir () + path_sep
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	132 + config::arch_lib_dir () + path_sep
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	133 + config::bin_dir ());
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	134
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	135 append_to_shell_path (exec_path);
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	136
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	137 return exec_path;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	138 }
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	139
32589 05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	140 std::string
05b4479c29d8 maint: C++ style check for libinterp/ before 9.1 release. Rik <rik@octave.org> parents: 31771 diff changeset	141 environment::init_image_path ()
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	142 {
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	143 std::string image_path = ".";
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	144
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	145 std::string path_sep = directory_path::path_sep_str ();
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	146
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	147 std::string env_path = sys::env::getenv ("OCTAVE_IMAGE_PATH");
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	148
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	149 if (! env_path.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	150 image_path += path_sep + env_path;
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	151
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	152 std::string gen_path = genpath (config::image_dir (), "");
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	153
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	154 if (! gen_path.empty ())
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	155 image_path += path_sep + gen_path;
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	156
31607 aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	157 return image_path;
aac27ad79be6 maint: Re-indent code after switch to using namespace macros. Rik <rik@octave.org> parents: 31605 diff changeset	158 }
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	159
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	160 DEFMETHOD (EDITOR, interp, args, nargout,
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	161 doc: /* -- texinfo --
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	162 @deftypefn {} {@var{val} =} EDITOR ()
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	163 @deftypefnx {} {@var{old_val} =} EDITOR (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30564 diff changeset	164 @deftypefnx {} {@var{old_val} =} EDITOR (@var{new_val}, "local")
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	165 Query or set the internal variable that specifies the default text editor.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	166
33054 1a6cb4552775 doc: Force Texinfo to render a space after @w{} macro. Rik <rik@octave.org> parents: 32632 diff changeset	167 The default value is taken from the environment variable @w{@env{EDITOR}}@
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	168 when Octave starts. If the environment variable is not initialized,
33054 1a6cb4552775 doc: Force Texinfo to render a space after @w{} macro. Rik <rik@octave.org> parents: 32632 diff changeset	169 @w{@env{EDITOR}}@ will be set to @qcode{"emacs"}.
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	170
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	171 When called from inside a function with the @qcode{"local"} option, the
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	172 variable is changed locally for the function and any subroutines it calls.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	173 The original variable value is restored when exiting the function.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	174
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	175 @seealso{edit, edit_history}
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	176 @end deftypefn */)
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	177 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	178 environment& env = interp.get_environment ();
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	179
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	180 return env.editor (args, nargout);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	181 }
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	182
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	183 /*
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	184 %!test
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	185 %! orig_val = EDITOR ();
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	186 %! old_val = EDITOR ("X");
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	187 %! assert (orig_val, old_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	188 %! assert (EDITOR (), "X");
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	189 %! EDITOR (orig_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	190 %! assert (EDITOR (), orig_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	191
28930 2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests. Rik <rik@octave.org> parents: 27923 diff changeset	192 %!error EDITOR (1, 2)
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	193 */
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	194
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	195 DEFMETHOD (EXEC_PATH, interp, args, nargout,
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	196 doc: /* -- texinfo --
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	197 @deftypefn {} {@var{val} =} EXEC_PATH ()
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	198 @deftypefnx {} {@var{old_val} =} EXEC_PATH (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30564 diff changeset	199 @deftypefnx {} {@var{old_val} =} EXEC_PATH (@var{new_val}, "local")
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	200 Query or set the internal variable that specifies a colon separated
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	201 list of directories to append to the shell PATH when executing external
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	202 programs.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	203
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	204 The initial value of is taken from the environment variable
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	205 @w{@env{OCTAVE_EXEC_PATH}}, but that value can be overridden by the command
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	206 line argument @option{--exec-path PATH}.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	207
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	208 When called from inside a function with the @qcode{"local"} option, the
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	209 variable is changed locally for the function and any subroutines it calls.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	210 The original variable value is restored when exiting the function.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	211
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	212 @seealso{IMAGE_PATH, OCTAVE_HOME, OCTAVE_EXEC_HOME}
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	213 @end deftypefn */)
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	214 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	215 environment& env = interp.get_environment ();
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	216
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	217 return env.exec_path (args, nargout);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	218 }
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	219
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	220 /*
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	221 %!test
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	222 %! orig_val = EXEC_PATH ();
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	223 %! old_val = EXEC_PATH ("X");
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	224 %! assert (orig_val, old_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	225 %! assert (EXEC_PATH (), "X");
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	226 %! EXEC_PATH (orig_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	227 %! assert (EXEC_PATH (), orig_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	228
28930 2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests. Rik <rik@octave.org> parents: 27923 diff changeset	229 %!error EXEC_PATH (1, 2)
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	230 */
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	231
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	232 DEFMETHOD (IMAGE_PATH, interp, args, nargout,
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	233 doc: /* -- texinfo --
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	234 @deftypefn {} {@var{val} =} IMAGE_PATH ()
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	235 @deftypefnx {} {@var{old_val} =} IMAGE_PATH (@var{new_val})
30588 ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681) Rik <rik@octave.org> parents: 30564 diff changeset	236 @deftypefnx {} {@var{old_val} =} IMAGE_PATH (@var{new_val}, "local")
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	237 Query or set the internal variable that specifies a colon separated
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	238 list of directories in which to search for image files.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	239
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	240 When called from inside a function with the @qcode{"local"} option, the
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	241 variable is changed locally for the function and any subroutines it calls.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	242 The original variable value is restored when exiting the function.
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	243
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	244 @seealso{EXEC_PATH, OCTAVE_HOME, OCTAVE_EXEC_HOME}
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	245 @end deftypefn */)
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	246 {
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29960 diff changeset	247 environment& env = interp.get_environment ();
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	248
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	249 return env.image_path (args, nargout);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	250 }
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	251
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	252 /*
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	253 %!test
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	254 %! orig_val = IMAGE_PATH ();
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	255 %! old_val = IMAGE_PATH ("X");
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	256 %! assert (orig_val, old_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	257 %! assert (IMAGE_PATH (), "X");
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	258 %! IMAGE_PATH (orig_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	259 %! assert (IMAGE_PATH (), orig_val);
69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	260
28930 2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests. Rik <rik@octave.org> parents: 27923 diff changeset	261 %!error IMAGE_PATH (1, 2)
23719 69a111259a2c eliminate some global variables John W. Eaton <jwe@octave.org> parents: diff changeset	262 */
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	263
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30588 diff changeset	264 OCTAVE_END_NAMESPACE(octave)

Mercurial > octave

annotate libinterp/corefcn/environment.cc @ 33617:ec2635a02328 bytecode-interpreter tip