annotate libinterp/corefcn/environment.cc @ 29961:7d6709900da7

eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more Files affected: __betainc__.cc, __contourc__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, balance.cc, besselj.cc, bsxfun.cc, call-stack.cc, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, defaults.cc, dirfns.cc, display.cc, dlmread.cc, dmperm.cc, dot.cc, eig.cc, ellipj.cc, environment.cc, error.cc, event-manager.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, find.cc, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, gsvd.cc, hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, jsondecode.cc, jsonencode.cc, load-path.cc, load-save.cc, lookup.cc, lsode.cc, lu.cc, max.cc, mgorth.cc, oct-hist.cc, ordqz.cc, ordschur.cc, pager.cc, pr-output.cc, psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, regexp.cc, schur.cc, settings.cc, sighandlers.cc, sparse.cc, spparms.cc, sqrtm.cc, stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, symbfact.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, typecast.cc, urlwrite.cc, utils.cc, variables.cc, __delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc, audioread.cc, convhulln.cc, fftw.cc, gzip.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, octave.cc, lex.ll, oct-parse.yy, profiler.cc, andpt-eval.cc.
author John W. Eaton <jwe@octave.org>
date Sat, 14 Aug 2021 22:48:52 -0400
parents 939bef0b66e0
children 796f54d4ddbf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 //
29358
0a5b15007766 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27923
diff changeset
3 // Copyright (C) 2017-2021 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
29960
939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
44 OCTAVE_NAMESPACE_BEGIN
939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
45
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
46 static void append_to_shell_path (const std::string& exec_path)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
47 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
48 // FIXME: should there be a way to remove a previous setting from
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
49 // PATH?
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
50
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
51 if (exec_path.empty ())
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
52 return;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
53
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
54 // FIXME: should we really be modifying PATH in the environment?
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
55
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
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
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
58 if (shell_path.empty ())
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
59 sys::env::putenv ("PATH", exec_path);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
60 else
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
61 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
62 // If PATH doesn't already have exec_path, append it.
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
63 // FIXME: should we search for the elements individually, and
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
64 // only append those that are missing?
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
65
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
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
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
68 if (shell_path.find (exec_path) == std::string::npos)
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
69 sys::env::putenv ("PATH", shell_path + path_sep + exec_path);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
70 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
71 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
72
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 octave_value
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74 environment::editor (const octave_value_list& args, int nargout)
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
75 {
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76 return set_internal_variable (m_editor, args, nargout, "EDITOR", false);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77 }
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
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
80 octave_value
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
81 environment::exec_path (const octave_value_list& args, int nargout)
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
82 {
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
83 octave_value retval
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
84 = set_internal_variable (m_exec_path, args, nargout, "EXEC_PATH", false);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
85
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
86 append_to_shell_path (m_exec_path);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
87
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
88 return retval;
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
89 }
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
90
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
91 std::string environment::exec_path (const std::string& path)
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
92 {
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
93 std::string old_val = set (m_exec_path, path);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
94
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
95 append_to_shell_path (m_exec_path);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
96
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
97 return old_val;
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
98 }
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
99
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
100 octave_value
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
101 environment::image_path (const octave_value_list& args, int nargout)
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
102 {
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
103 return set_internal_variable (m_image_path, args, nargout, "IMAGE_PATH",
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
104 false);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
105 }
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
106
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
107 std::string environment::init_editor (void)
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
108 {
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
109 std::string retval = "emacs";
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
110
25336
389757b7b6af eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
111 std::string env_editor = sys::env::getenv ("EDITOR");
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
112
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
113 if (! env_editor.empty ())
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
114 retval = env_editor;
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
115
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
116 return retval;
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
117 }
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
118
25460
627d6bde9b8d solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents: 25440
diff changeset
119 std::string environment::init_exec_path (void)
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
120 {
25336
389757b7b6af eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
121 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
122
25336
389757b7b6af eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
123 std::string path_sep = directory_path::path_sep_str ();
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
124
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
125 if (exec_path.empty ())
25460
627d6bde9b8d solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents: 25440
diff changeset
126 exec_path = (config::local_ver_arch_lib_dir () + path_sep
627d6bde9b8d solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents: 25440
diff changeset
127 + config::local_api_arch_lib_dir () + path_sep
627d6bde9b8d solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents: 25440
diff changeset
128 + config::local_arch_lib_dir () + path_sep
627d6bde9b8d solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents: 25440
diff changeset
129 + config::arch_lib_dir () + path_sep
627d6bde9b8d solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents: 25440
diff changeset
130 + config::bin_dir ());
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
131
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
132 append_to_shell_path (exec_path);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
133
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
134 return exec_path;
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
135 }
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
136
25460
627d6bde9b8d solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents: 25440
diff changeset
137 std::string environment::init_image_path (void)
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
138 {
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
139 std::string image_path = ".";
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
140
25336
389757b7b6af eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
141 std::string path_sep = directory_path::path_sep_str ();
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
142
25336
389757b7b6af eliminate redundant octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
143 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
144
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
145 if (! env_path.empty ())
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
146 image_path += path_sep + env_path;
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
147
25460
627d6bde9b8d solve installation info initialization problem differently
John W. Eaton <jwe@octave.org>
parents: 25440
diff changeset
148 std::string gen_path = genpath (config::image_dir (), "");
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
149
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
150 if (! gen_path.empty ())
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
151 image_path += path_sep + gen_path;
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
152
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
153 return image_path;
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
154 }
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29359
diff changeset
155
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
156 DEFMETHOD (EDITOR, interp, args, nargout,
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
157 doc: /* -*- texinfo -*-
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
158 @deftypefn {} {@var{val} =} EDITOR ()
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
159 @deftypefnx {} {@var{old_val} =} EDITOR (@var{new_val})
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
160 @deftypefnx {} {} EDITOR (@var{new_val}, "local")
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
161 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
162
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
163 The default value is taken from the environment variable @w{@env{EDITOR}}
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
164 when Octave starts. If the environment variable is not initialized,
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
165 @w{@env{EDITOR}} will be set to @qcode{"emacs"}.
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
166
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
167 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
168 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
169 The original variable value is restored when exiting the function.
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 @seealso{edit, edit_history}
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
172 @end deftypefn */)
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
173 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
174 environment& env = interp.get_environment ();
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
175
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
176 return env.editor (args, nargout);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
177 }
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
178
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 %!test
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
181 %! orig_val = EDITOR ();
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
182 %! old_val = EDITOR ("X");
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
183 %! assert (orig_val, old_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
184 %! assert (EDITOR (), "X");
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
185 %! EDITOR (orig_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
186 %! assert (EDITOR (), orig_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
187
28930
2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents: 27923
diff changeset
188 %!error EDITOR (1, 2)
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
189 */
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
190
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
191 DEFMETHOD (EXEC_PATH, interp, args, nargout,
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
192 doc: /* -*- texinfo -*-
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
193 @deftypefn {} {@var{val} =} EXEC_PATH ()
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
194 @deftypefnx {} {@var{old_val} =} EXEC_PATH (@var{new_val})
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
195 @deftypefnx {} {} EXEC_PATH (@var{new_val}, "local")
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
196 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
197 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
198 programs.
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
199
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
200 The initial value of is taken from the environment variable
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
201 @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
202 line argument @option{--exec-path PATH}.
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 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
205 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
206 The original variable value is restored when exiting the function.
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 @seealso{IMAGE_PATH, OCTAVE_HOME, OCTAVE_EXEC_HOME}
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
209 @end deftypefn */)
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
210 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
211 environment& env = interp.get_environment ();
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
212
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
213 return env.exec_path (args, nargout);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
214 }
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
215
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 %!test
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
218 %! orig_val = EXEC_PATH ();
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
219 %! old_val = EXEC_PATH ("X");
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
220 %! assert (orig_val, old_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
221 %! assert (EXEC_PATH (), "X");
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
222 %! EXEC_PATH (orig_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
223 %! assert (EXEC_PATH (), orig_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
224
28930
2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents: 27923
diff changeset
225 %!error EXEC_PATH (1, 2)
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
226 */
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
227
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
228 DEFMETHOD (IMAGE_PATH, interp, args, nargout,
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
229 doc: /* -*- texinfo -*-
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
230 @deftypefn {} {@var{val} =} IMAGE_PATH ()
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
231 @deftypefnx {} {@var{old_val} =} IMAGE_PATH (@var{new_val})
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
232 @deftypefnx {} {} IMAGE_PATH (@var{new_val}, "local")
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
233 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
234 list of directories in which to search for image files.
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
235
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
236 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
237 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
238 The original variable value is restored when exiting the function.
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 @seealso{EXEC_PATH, OCTAVE_HOME, OCTAVE_EXEC_HOME}
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
241 @end deftypefn */)
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
242 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
243 environment& env = interp.get_environment ();
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
244
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
245 return env.image_path (args, nargout);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
246 }
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
247
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 %!test
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
250 %! orig_val = IMAGE_PATH ();
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
251 %! old_val = IMAGE_PATH ("X");
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
252 %! assert (orig_val, old_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
253 %! assert (IMAGE_PATH (), "X");
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
254 %! IMAGE_PATH (orig_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
255 %! assert (IMAGE_PATH (), orig_val);
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
256
28930
2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents: 27923
diff changeset
257 %!error IMAGE_PATH (1, 2)
23719
69a111259a2c eliminate some global variables
John W. Eaton <jwe@octave.org>
parents:
diff changeset
258 */
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29359
diff changeset
259
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29359
diff changeset
260 OCTAVE_NAMESPACE_END