annotate libinterp/corefcn/sysdep.cc @ 29354:6c2fa2293242

Increase Windows API version to Windows 7 (bug #60014). * configure.ac: Increase minimum value of _WIN32_WINNT to 0x0601 (Windows 7). * libinterp/corefcn/sysdep.cc (set_application_id): Call "SetCurrentProcessExplicitAppUserModelID" directly. * liboctave/system/oct-time.cc (base_tm::init): Call "GetTimeZoneInformationForYear" unconditionally. * NEWS: Add note about new minimum Windows version.
author Markus Mützel <markus.muetzel@gmx.de>
date Sat, 06 Feb 2021 11:14:13 +0100
parents 10a35049bad7
children 7854d5752dd2
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 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
3 // Copyright (C) 1993-2020 The Octave Project Developers
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 ////////////////////////////////////////////////////////////////////////
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
25
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21662
diff changeset
26 #if defined (HAVE_CONFIG_H)
21301
40de9f8f23a6 Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents: 21200
diff changeset
27 # include "config.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
28 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
29
23662
bd77ab816e43 eliminate obsolete file lo-math.h
John W. Eaton <jwe@octave.org>
parents: 23575
diff changeset
30 #include <cmath>
1343
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe]
jwe
parents: 1318
diff changeset
31 #include <cstddef>
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe]
jwe
parents: 1318
diff changeset
32
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 3372
diff changeset
33 #include <iostream>
1728
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe]
jwe
parents: 1711
diff changeset
34 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe]
jwe
parents: 1711
diff changeset
35
1430
045e70a15a8f [project @ 1995-09-19 07:05:37 by jwe]
jwe
parents: 1415
diff changeset
36 #if defined (HAVE_TERMIOS_H)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21115
diff changeset
37 # include <termios.h>
1430
045e70a15a8f [project @ 1995-09-19 07:05:37 by jwe]
jwe
parents: 1415
diff changeset
38 #elif defined (HAVE_TERMIO_H)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21115
diff changeset
39 # include <termio.h>
1430
045e70a15a8f [project @ 1995-09-19 07:05:37 by jwe]
jwe
parents: 1415
diff changeset
40 #elif defined (HAVE_SGTTY_H)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21115
diff changeset
41 # include <sgtty.h>
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
42 #endif
4067
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 4064
diff changeset
43
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 4064
diff changeset
44 #if defined (HAVE_CONIO_H)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21115
diff changeset
45 # include <conio.h>
1430
045e70a15a8f [project @ 1995-09-19 07:05:37 by jwe]
jwe
parents: 1415
diff changeset
46 #endif
045e70a15a8f [project @ 1995-09-19 07:05:37 by jwe]
jwe
parents: 1415
diff changeset
47
3248
68259f410026 [project @ 1999-07-13 03:34:54 by jwe]
jwe
parents: 3234
diff changeset
48 #if defined (HAVE_SYS_IOCTL_H)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21115
diff changeset
49 # include <sys/ioctl.h>
3248
68259f410026 [project @ 1999-07-13 03:34:54 by jwe]
jwe
parents: 3234
diff changeset
50 #endif
68259f410026 [project @ 1999-07-13 03:34:54 by jwe]
jwe
parents: 3234
diff changeset
51
1463
592291d9dfbb [project @ 1995-09-22 07:18:44 by jwe]
jwe
parents: 1430
diff changeset
52 #if defined (HAVE_FLOATINGPOINT_H)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21115
diff changeset
53 # include <floatingpoint.h>
1463
592291d9dfbb [project @ 1995-09-22 07:18:44 by jwe]
jwe
parents: 1430
diff changeset
54 #endif
592291d9dfbb [project @ 1995-09-22 07:18:44 by jwe]
jwe
parents: 1430
diff changeset
55
2508
f8d5dbbbc50a [project @ 1996-11-13 17:21:07 by jwe]
jwe
parents: 2493
diff changeset
56 #if defined (HAVE_IEEEFP_H)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21115
diff changeset
57 # include <ieeefp.h>
2508
f8d5dbbbc50a [project @ 1996-11-13 17:21:07 by jwe]
jwe
parents: 2493
diff changeset
58 #endif
f8d5dbbbc50a [project @ 1996-11-13 17:21:07 by jwe]
jwe
parents: 2493
diff changeset
59
21554
9f0088f3f335 call openmp function at initialization (bug #47372)
John W. Eaton <jwe@octave.org>
parents: 20788
diff changeset
60 #if defined (HAVE_OMP_H)
21556
12f207a534aa maint: merge stable to default.
John W. Eaton <jwe@octave.org>
parents: 21301 21554
diff changeset
61 # include <omp.h>
21554
9f0088f3f335 call openmp function at initialization (bug #47372)
John W. Eaton <jwe@octave.org>
parents: 20788
diff changeset
62 #endif
9f0088f3f335 call openmp function at initialization (bug #47372)
John W. Eaton <jwe@octave.org>
parents: 20788
diff changeset
63
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2893
diff changeset
64 #include "cmd-edit.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2893
diff changeset
65 #include "file-ops.h"
2893
9fd1df4b464a [project @ 1997-04-28 02:07:38 by jwe]
jwe
parents: 2847
diff changeset
66 #include "lo-mappers.h"
24714
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
67 #include "lo-sysinfo.h"
2317
8c09c04f7747 [project @ 1996-07-14 22:30:15 by jwe]
jwe
parents: 2086
diff changeset
68 #include "mach-info.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2893
diff changeset
69 #include "oct-env.h"
25530
197126863d95 sysdep.cc: Use wide character versions of Windows API functions (bug #49118).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25311
diff changeset
70 #include "uniconv-wrappers.h"
21910
4d723ba06b4a provide wrappers for some unistd.h functions
John W. Eaton <jwe@octave.org>
parents: 21888
diff changeset
71 #include "unistd-wrappers.h"
1769
bc7ae9be3378 [project @ 1996-01-23 06:49:08 by jwe]
jwe
parents: 1755
diff changeset
72
22097
5ad67277b007 include builtin-defun-decls.h as needed
John W. Eaton <jwe@octave.org>
parents: 22096
diff changeset
73 #include "builtin-defun-decls.h"
6208
323be5eeed1f [project @ 2006-12-06 20:23:18 by jwe]
jwe
parents: 6135
diff changeset
74 #include "Cell.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
75 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
76 #include "error.h"
21115
629643522cc0 include errwarn.h in all files that use gripe_disabled_feature
John W. Eaton <jwe@octave.org>
parents: 21109
diff changeset
77 #include "errwarn.h"
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
78 #include "input.h"
27301
a2b1ba6c92d5 eliminate unnecessary application::interative function
John W. Eaton <jwe@octave.org>
parents: 27277
diff changeset
79 #include "interpreter-private.h"
22089
c2c668b3051b use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents: 22051
diff changeset
80 #include "octave.h"
c2c668b3051b use classes for octave application and interpreter
John W. Eaton <jwe@octave.org>
parents: 22051
diff changeset
81 #include "ov.h"
20940
48b2ad5ee801 maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
Rik <rik@octave.org>
parents: 20939
diff changeset
82 #include "ovl.h"
3234
be8e0ba13644 [project @ 1999-01-29 03:52:30 by jwe]
jwe
parents: 3124
diff changeset
83 #include "pager.h"
6419
73fcbac81f33 [project @ 2007-03-20 17:18:24 by jwe]
jwe
parents: 6208
diff changeset
84 #include "parse.h"
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
85 #include "sighandlers.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
86 #include "sysdep.h"
22094
9203833cab7d move new interpreter class to separate file
John W. Eaton <jwe@octave.org>
parents: 22089
diff changeset
87 #include "interpreter.h"
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
88 #include "utils.h"
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
89 #include "file-stat.h"
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
90
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21662
diff changeset
91 #if ! defined (STDIN_FILENO)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21115
diff changeset
92 # define STDIN_FILENO 1
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
93 #endif
444
ba637cc5c5f3 [project @ 1994-06-02 17:15:07 by jwe]
jwe
parents: 401
diff changeset
94
22019
2d8e9bdf5683 Dont use OCTAVE_USE_WINDOWS_API for w32_XXXX function definitions (Bug #48352)
John Donoghue
parents: 21989
diff changeset
95 #if defined (__MINGW32__) || defined (_MSC_VER)
13771
80b30e186b73 [Win32] Use Toolhelp32 APi to find octinterp module path.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13751
diff changeset
96
80b30e186b73 [Win32] Use Toolhelp32 APi to find octinterp module path.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13751
diff changeset
97 #define WIN32_LEAN_AND_MEAN
21949
baeffde5c87d fix build for Windows systems
John W. Eaton <jwe@octave.org>
parents: 21910
diff changeset
98 #include <windows.h>
13771
80b30e186b73 [Win32] Use Toolhelp32 APi to find octinterp module path.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13751
diff changeset
99 #include <tlhelp32.h>
28371
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
100 #include <psapi.h>
21949
baeffde5c87d fix build for Windows systems
John W. Eaton <jwe@octave.org>
parents: 21910
diff changeset
101 #include <shellapi.h>
29354
6c2fa2293242 Increase Windows API version to Windows 7 (bug #60014).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29117
diff changeset
102 #include <shobjidl.h>
13771
80b30e186b73 [Win32] Use Toolhelp32 APi to find octinterp module path.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13751
diff changeset
103
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
104 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
105
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
106 namespace octave
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
107 {
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
108 #if defined (__386BSD__) || defined (__FreeBSD__) || defined (__NetBSD__)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
109
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
110 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
111 BSD_init (void)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
112 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
113 # if defined (HAVE_FLOATINGPOINT_H)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
114 // Disable trapping on common exceptions.
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
115 # if ! defined (FP_X_DNML)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
116 # define FP_X_DNML 0
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
117 # endif
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
118 fpsetmask (~(FP_X_OFL|FP_X_INV|FP_X_DZ|FP_X_DNML|FP_X_UFL|FP_X_IMP));
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
119 # endif
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
120 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
121
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
122 #endif
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
123
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
124 #if defined (__MINGW32__) || defined (_MSC_VER)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
125
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
126 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
127 w32_set_octave_home (void)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
128 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
129 std::string bin_dir;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
130
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
131 HANDLE h = CreateToolhelp32Snapshot (TH32CS_SNAPMODULE
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
132 #if defined (TH32CS_SNAPMODULE32)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
133 | TH32CS_SNAPMODULE32
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
134 #endif
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
135 , 0);
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
136
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
137 if (h != INVALID_HANDLE_VALUE)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
138 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
139 MODULEENTRY32W mod_info;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
140
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
141 ZeroMemory (&mod_info, sizeof (mod_info));
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
142 mod_info.dwSize = sizeof (mod_info);
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
143
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
144 if (Module32FirstW (h, &mod_info))
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
145 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
146 do
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
147 {
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
148 std::string mod_name (sys::u8_from_wstring (mod_info.szModule));
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
149
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
150 if (mod_name.find ("octinterp") != std::string::npos)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
151 {
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
152 bin_dir = sys::u8_from_wstring (mod_info.szExePath);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
153 if (! bin_dir.empty () && bin_dir.back () != '\\')
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
154 bin_dir.push_back ('\\');
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
155 break;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
156 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
157 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
158 while (Module32NextW (h, &mod_info));
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
159 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
160
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
161 CloseHandle (h);
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
162 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
163
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
164 if (! bin_dir.empty ())
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
165 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
166 size_t pos = bin_dir.rfind (R"(\bin\)");
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
167
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
168 if (pos != std::string::npos)
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
169 sys::env::putenv ("OCTAVE_HOME", bin_dir.substr (0, pos));
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
170 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
171 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
172
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
173 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
174 w32_init (void)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
175 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
176 w32_set_octave_home ();
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
177
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
178 command_editor::prefer_env_winsize (true);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
179 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
180
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
181 #endif
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
182
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
183 void set_application_id (void)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
184 {
22165
20e684ec108e move system dependent code to sysdep.cc
John W. Eaton <jwe@octave.org>
parents: 22141
diff changeset
185 #if defined (__MINGW32__) || defined (_MSC_VER)
20e684ec108e move system dependent code to sysdep.cc
John W. Eaton <jwe@octave.org>
parents: 22141
diff changeset
186
29354
6c2fa2293242 Increase Windows API version to Windows 7 (bug #60014).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29117
diff changeset
187 SetCurrentProcessExplicitAppUserModelID (L"gnu.octave." VERSION);
22165
20e684ec108e move system dependent code to sysdep.cc
John W. Eaton <jwe@octave.org>
parents: 22141
diff changeset
188
20e684ec108e move system dependent code to sysdep.cc
John W. Eaton <jwe@octave.org>
parents: 22141
diff changeset
189 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
190 }
22165
20e684ec108e move system dependent code to sysdep.cc
John W. Eaton <jwe@octave.org>
parents: 22141
diff changeset
191 }
20e684ec108e move system dependent code to sysdep.cc
John W. Eaton <jwe@octave.org>
parents: 22141
diff changeset
192
19856
5c1a38089f89 Change open_with_system_app to internal function.
Rik <rik@octave.org>
parents: 19849
diff changeset
193 DEFUN (__open_with_system_app__, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
194 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
195 @deftypefn {} {} __open_with_system_app__ (@var{file})
27143
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
196 Internal function. Returns 1 on successful system call and 0 otherwise.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
197 @end deftypefn */)
19271
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
198 {
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
199 if (args.length () != 1)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
200 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
201
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
202 std::string file = args(0).xstring_value ("__open_with_system_app__: argument must be a filename");
19271
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
203
21979
d04da18a407a use OCTAVE_USE_WINDOWS_API more consistently
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
204 #if defined (OCTAVE_USE_WINDOWS_API)
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
205 std::wstring wfile = octave::sys::u8_to_wstring (file);
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
206 HINSTANCE status = ShellExecuteW (0, 0, wfile.c_str (), 0, 0, SW_SHOWNORMAL);
19271
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
207
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
208 // ShellExecute returns a value greater than 32 if successful.
27143
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
209 return octave_value (reinterpret_cast<ptrdiff_t> (status) > 32);
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
210 #else
27346
1effc78e7cd1 open.m: Allow files with space in their path to be open.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27335
diff changeset
211 // Quote file path
28752
810eb29fc227 maint: Use C++ raw string literals to simplify backlsashing.
Rik <rik@octave.org>
parents: 28371
diff changeset
212 file = '"' + file + '"';
27346
1effc78e7cd1 open.m: Allow files with space in their path to be open.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 27335
diff changeset
213
27143
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
214 # if defined (__APPLE__)
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
215 # define FSYSTEM_OPEN_STR "open "
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
216 # else
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
217 # define FSYSTEM_OPEN_STR "xdg-open "
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
218 # endif
20961
f55251db0833 Add support for the Mac OS X "open" command.
Ben Abbott <bpabbott@mac.com>
parents: 20941
diff changeset
219 octave_value_list tmp
27143
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
220 = Fsystem (ovl (FSYSTEM_OPEN_STR + file + " 2> /dev/null",
20961
f55251db0833 Add support for the Mac OS X "open" command.
Ben Abbott <bpabbott@mac.com>
parents: 20941
diff changeset
221 false, "async"),
f55251db0833 Add support for the Mac OS X "open" command.
Ben Abbott <bpabbott@mac.com>
parents: 20941
diff changeset
222 1);
27143
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
223 # undef FSYSTEM_OPEN_STR
19271
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
224
27143
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
225 // Asynchronous Fsystem calls return the new child process identifier,
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
226 // which must be greater than 1 if successful.
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
227 return octave_value (tmp(0).double_value () > 1);
19774
904912f18357 make open_with_system_app a built-in function
John W. Eaton <jwe@octave.org>
parents: 19697
diff changeset
228 #endif
19271
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
229 }
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
230
28260
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
231 DEFUN (__is_elevated_process__, args, ,
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
232 doc: /* -*- texinfo -*-
28753
e82484e1b2f6 doc: grammarcheck documentation.
Rik <rik@octave.org>
parents: 28752
diff changeset
233 @deftypefn {} {@var{retval} =} __is_elevated_process__ ()
28260
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
234 Check if current process has elevated rights.
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
235
28753
e82484e1b2f6 doc: grammarcheck documentation.
Rik <rik@octave.org>
parents: 28752
diff changeset
236 On Windows, return true if the current process has elevated right. Otherwise,
28260
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
237 return false.
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
238 On non-Windows platforms, this function fails with an error.
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
239 @end deftypefn */)
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
240 {
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
241 #if defined (OCTAVE_USE_WINDOWS_API)
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
242 if (args.length () != 0)
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
243 print_usage ();
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
244
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
245 bool retval = false;
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
246 HANDLE h_token = nullptr;
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
247
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
248 if (OpenProcessToken (GetCurrentProcess (), TOKEN_QUERY, &h_token))
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
249 {
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
250 TOKEN_ELEVATION elevation;
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
251 DWORD return_length = sizeof (TOKEN_ELEVATION);
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
252 if (GetTokenInformation (h_token, TokenElevation, &elevation,
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
253 sizeof (elevation), &return_length))
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
254 retval = elevation.TokenIsElevated;
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
255 }
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
256
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
257 if (h_token)
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
258 CloseHandle (h_token);
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
259
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
260 return ovl (retval);
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
261
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
262 #else
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
263 octave_unused_parameter (args);
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
264 error ("__is_elevated_process__: "
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
265 "Function is only supported on Windows platforms.");
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
266 #endif
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
267 }
ec77c790fce2 pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28175
diff changeset
268
28371
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
269 DEFUN (__wmemory__, args, ,
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
270 doc: /* -*- texinfo -*-
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
271 @deftypefn {} {[@var{proc}, @var{sys}] =} __wmemory__ ()
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
272 Return memory information on Windows.
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
273
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
274 On non-Windows platforms, this function fails with an error.
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
275 @end deftypefn */)
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
276 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
277 #if defined (OCTAVE_USE_WINDOWS_API)
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
278 if (args.length () != 0)
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
279 print_usage ();
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
280
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
281 // Get memory usage of the current process
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
282 octave_scalar_map proc_struct;
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
283
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
284 HANDLE h_proc = GetCurrentProcess ();
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
285 if (h_proc == nullptr)
28905
89a425f2c202 maint: Use Octave convention that error() messages don't end with a period.
Rik <rik@octave.org>
parents: 28857
diff changeset
286 error ("__wmemory__: Couldn't open handle to own process");
28371
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
287
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
288 PROCESS_MEMORY_COUNTERS proc_mem_count;
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
289 if (GetProcessMemoryInfo (h_proc, &proc_mem_count, sizeof (proc_mem_count)))
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
290 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
291 proc_struct.setfield ("PageFaultCount",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
292 proc_mem_count.PageFaultCount);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
293 proc_struct.setfield ("PeakWorkingSetSize",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
294 proc_mem_count.PeakWorkingSetSize);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
295 proc_struct.setfield ("WorkingSetSize",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
296 proc_mem_count.WorkingSetSize);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
297 proc_struct.setfield ("QuotaPeakPagedPoolUsage",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
298 proc_mem_count.QuotaPeakPagedPoolUsage);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
299 proc_struct.setfield ("QuotaPagedPoolUsage",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
300 proc_mem_count.QuotaPagedPoolUsage);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
301 proc_struct.setfield ("QuotaPeakNonPagedPoolUsage",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
302 proc_mem_count.QuotaPeakNonPagedPoolUsage);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
303 proc_struct.setfield ("QuotaNonPagedPoolUsage",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
304 proc_mem_count.QuotaNonPagedPoolUsage);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
305 proc_struct.setfield ("PagefileUsage",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
306 proc_mem_count.PagefileUsage);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
307 proc_struct.setfield ("PeakPagefileUsage",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
308 proc_mem_count.PeakPagefileUsage);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
309 }
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
310 else
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
311 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
312 proc_struct.setfield ("PageFaultCount", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
313 proc_struct.setfield ("PeakWorkingSetSize", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
314 proc_struct.setfield ("WorkingSetSize", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
315 proc_struct.setfield ("QuotaPeakPagedPoolUsage", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
316 proc_struct.setfield ("QuotaPagedPoolUsage", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
317 proc_struct.setfield ("QuotaPeakNonPagedPoolUsage", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
318 proc_struct.setfield ("QuotaNonPagedPoolUsage", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
319 proc_struct.setfield ("PagefileUsage", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
320 proc_struct.setfield ("PeakPagefileUsage", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
321 }
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
322
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
323 CloseHandle (h_proc);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
324
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
325 // Get system memory usage
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
326 octave_scalar_map sys_struct;
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
327
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
328 MEMORYSTATUSEX mem_stat;
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
329
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
330 mem_stat.dwLength = sizeof (mem_stat);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
331
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
332 if (GlobalMemoryStatusEx (&mem_stat))
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
333 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
334 sys_struct.setfield ("MemoryLoad", mem_stat.dwMemoryLoad);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
335 sys_struct.setfield ("TotalPhys", mem_stat.ullTotalPhys);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
336 sys_struct.setfield ("AvailPhys", mem_stat.ullAvailPhys);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
337 sys_struct.setfield ("TotalPageFile", mem_stat.ullTotalPageFile);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
338 sys_struct.setfield ("AvailPageFile", mem_stat.ullAvailPageFile);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
339 sys_struct.setfield ("TotalVirtual", mem_stat.ullTotalVirtual);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
340 sys_struct.setfield ("AvailVirtual", mem_stat.ullAvailVirtual);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
341 sys_struct.setfield ("AvailExtendedVirtual",
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
342 mem_stat.ullAvailExtendedVirtual);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
343 }
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
344 else
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
345 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
346 sys_struct.setfield ("MemoryLoad", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
347 sys_struct.setfield ("TotalPhys", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
348 sys_struct.setfield ("AvailPhys", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
349 sys_struct.setfield ("TotalPageFile", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
350 sys_struct.setfield ("AvailPageFile", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
351 sys_struct.setfield ("TotalVirtual", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
352 sys_struct.setfield ("AvailVirtual", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
353 sys_struct.setfield ("AvailExtendedVirtual", 0);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
354 }
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
355
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
356 return ovl (proc_struct, sys_struct);
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
357
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
358 #else
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
359 octave_unused_parameter (args);
28905
89a425f2c202 maint: Use Octave convention that error() messages don't end with a period.
Rik <rik@octave.org>
parents: 28857
diff changeset
360 error ("__wmemory__: Function is only supported on Windows platforms");
28371
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
361 #endif
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
362 }
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
363
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
364 namespace octave
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
365 {
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
366 #if defined (__MINGW32__)
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
367
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
368 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
369 MINGW_init (void)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
370 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
371 w32_init ();
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
372 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
373
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
374 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
375
6080
40ab35ab651c [project @ 2006-10-25 03:26:36 by jwe]
jwe
parents: 5823
diff changeset
376 #if defined (_MSC_VER)
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
377
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
378 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
379 MSVC_init (void)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
380 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
381 w32_init ();
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
382 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
383
6080
40ab35ab651c [project @ 2006-10-25 03:26:36 by jwe]
jwe
parents: 5823
diff changeset
384 #endif
40ab35ab651c [project @ 2006-10-25 03:26:36 by jwe]
jwe
parents: 5823
diff changeset
385
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
386 // Return TRUE if FILE1 and FILE2 refer to the same (physical) file.
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
387
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
388 bool same_file_internal (const std::string& file1, const std::string& file2)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
389 {
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21662
diff changeset
390 #if defined (OCTAVE_USE_WINDOWS_API)
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
391
27576
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
392 // FIXME: When Octave switches to C++17, consider replacing this function
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
393 // by https://en.cppreference.com/w/cpp/filesystem/equivalent.
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
394
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
395 bool retval = false;
6691
c6ee6c342699 [project @ 2007-06-05 05:50:10 by jwe]
jwe
parents: 6677
diff changeset
396
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
397 std::wstring file1w = sys::u8_to_wstring (file1);
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
398 std::wstring file2w = sys::u8_to_wstring (file2);
25714
ad0b4817c09d Fix lifetime issue with C string references from C++ strings (bug #54398)
Markus Mützel <markus.muetzel@gmx.de>
parents: 25655
diff changeset
399 const wchar_t *f1 = file1w.c_str ();
ad0b4817c09d Fix lifetime issue with C string references from C++ strings (bug #54398)
Markus Mützel <markus.muetzel@gmx.de>
parents: 25655
diff changeset
400 const wchar_t *f2 = file2w.c_str ();
16564
aa5299a1d770 * sysdep.cc (same_file_internal): Handle directories on Windows systems.
John W. Eaton <jwe@octave.org>
parents: 16537
diff changeset
401
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
402 bool f1_is_dir = GetFileAttributesW (f1) & FILE_ATTRIBUTE_DIRECTORY;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
403 bool f2_is_dir = GetFileAttributesW (f2) & FILE_ATTRIBUTE_DIRECTORY;
16564
aa5299a1d770 * sysdep.cc (same_file_internal): Handle directories on Windows systems.
John W. Eaton <jwe@octave.org>
parents: 16537
diff changeset
404
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
405 // Windows native code
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
406 // Reference: http://msdn2.microsoft.com/en-us/library/aa363788.aspx
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
407
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
408 DWORD share = FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE;
16564
aa5299a1d770 * sysdep.cc (same_file_internal): Handle directories on Windows systems.
John W. Eaton <jwe@octave.org>
parents: 16537
diff changeset
409
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
410 HANDLE hfile1
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
411 = CreateFileW (f1, 0, share, 0, OPEN_EXISTING,
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
412 f1_is_dir ? FILE_FLAG_BACKUP_SEMANTICS : 0, 0);
6691
c6ee6c342699 [project @ 2007-06-05 05:50:10 by jwe]
jwe
parents: 6677
diff changeset
413
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
414 if (hfile1 != INVALID_HANDLE_VALUE)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
415 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
416 HANDLE hfile2
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
417 = CreateFileW (f2, 0, share, 0, OPEN_EXISTING,
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
418 f2_is_dir ? FILE_FLAG_BACKUP_SEMANTICS : 0, 0);
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
419
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
420 if (hfile2 != INVALID_HANDLE_VALUE)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
421 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
422 BY_HANDLE_FILE_INFORMATION hfi1;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
423 BY_HANDLE_FILE_INFORMATION hfi2;
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
424
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
425 if (GetFileInformationByHandle (hfile1, &hfi1)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
426 && GetFileInformationByHandle (hfile2, &hfi2))
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
427 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
428 retval = (hfi1.dwVolumeSerialNumber == hfi2.dwVolumeSerialNumber
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
429 && hfi1.nFileIndexHigh == hfi2.nFileIndexHigh
27576
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
430 && hfi1.nFileIndexLow == hfi2.nFileIndexLow
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
431 && hfi1.nFileSizeHigh == hfi2.nFileSizeHigh
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
432 && hfi1.nFileSizeLow == hfi2.nFileSizeLow
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
433 && hfi1.ftLastWriteTime.dwLowDateTime
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
434 == hfi2.ftLastWriteTime.dwLowDateTime
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
435 && hfi1.ftLastWriteTime.dwHighDateTime
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
436 == hfi2.ftLastWriteTime.dwHighDateTime);
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
437 }
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
438
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
439 CloseHandle (hfile2);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
440 }
6691
c6ee6c342699 [project @ 2007-06-05 05:50:10 by jwe]
jwe
parents: 6677
diff changeset
441
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
442 CloseHandle (hfile1);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
443 }
6691
c6ee6c342699 [project @ 2007-06-05 05:50:10 by jwe]
jwe
parents: 6677
diff changeset
444
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
445 return retval;
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
446
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
447 #else
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
448
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
449 // POSIX Code
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
450
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
451 sys::file_stat fs_file1 (file1);
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
452 sys::file_stat fs_file2 (file2);
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
453
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
454 return (fs_file1 && fs_file2
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
455 && fs_file1.ino () == fs_file2.ino ()
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
456 && fs_file1.dev () == fs_file2.dev ());
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
457
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
458 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
459 }
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
460
26843
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
461 // Return TRUE if NAME refers to an existing drive letter or UNC share
26995
ab5bfee22d18 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26844
diff changeset
462
26843
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
463 bool drive_or_unc_share (const std::string& name)
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
464 {
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
465 #if defined (OCTAVE_USE_WINDOWS_API)
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
466 size_t len = name.length ();
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
467 bool candidate = false;
26995
ab5bfee22d18 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26844
diff changeset
468 if (len > 1 && isalpha(name[0]) && name[1]==':'
27932
b018f553fd85 maint: Use Octave coding conventions in libinterp/
Rik <rik@octave.org>
parents: 27923
diff changeset
469 && (len == 2 || (len == 3 && name[2] == '\\')))
26843
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
470 candidate = true;
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
471 if (len > 4 && name[0] == '\\' && name[1] == '\\')
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
472 {
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
473 // It starts with two slashes. Find the next slash.
28752
810eb29fc227 maint: Use C++ raw string literals to simplify backlsashing.
Rik <rik@octave.org>
parents: 28371
diff changeset
474 size_t next_slash = name.find ('\\', 3);
27741
b5e88a4bce43 Stop compilation warning regarding signed/unsigned comparison in MXE Octave (bug #52720)
Rik <rik@octave.org>
parents: 27577
diff changeset
475 if (next_slash != std::string::npos && len > next_slash+1)
26843
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
476 {
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
477 // Check if it ends with the share
28752
810eb29fc227 maint: Use C++ raw string literals to simplify backlsashing.
Rik <rik@octave.org>
parents: 28371
diff changeset
478 size_t last_slash = name.find ('\\', next_slash+1);
27741
b5e88a4bce43 Stop compilation warning regarding signed/unsigned comparison in MXE Octave (bug #52720)
Rik <rik@octave.org>
parents: 27577
diff changeset
479 if (last_slash == std::string::npos
b5e88a4bce43 Stop compilation warning regarding signed/unsigned comparison in MXE Octave (bug #52720)
Rik <rik@octave.org>
parents: 27577
diff changeset
480 || (len > next_slash+2 && last_slash == len-1))
26843
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
481 candidate = true;
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
482 }
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
483 }
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
484
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
485 if (candidate)
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
486 {
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
487 // Open a handle to the file.
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
488 std::wstring wname = sys::u8_to_wstring (name);
27277
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
489 HANDLE h
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
490 = CreateFileW (wname.c_str (), FILE_READ_ATTRIBUTES,
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
491 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
492 nullptr, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS,
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
493 nullptr);
26843
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
494 if (h != INVALID_HANDLE_VALUE)
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
495 {
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
496 CloseHandle (h);
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
497 return true;
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
498 }
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
499 }
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
500
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
501 return false;
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
502
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
503 #else
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
504
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
505 octave_unused_parameter (name);
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
506
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
507 return false;
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
508
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
509 #endif
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
510 }
26995
ab5bfee22d18 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26844
diff changeset
511
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
512 void sysdep_init (void)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
513 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
514 // Use a function from libgomp to force loading of OpenMP library.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
515 // Otherwise, a dynamically loaded library making use of OpenMP such
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
516 // as GraphicsMagick will segfault on exit (bug #41699).
21554
9f0088f3f335 call openmp function at initialization (bug #47372)
John W. Eaton <jwe@octave.org>
parents: 20788
diff changeset
517 #if defined (HAVE_OMP_GET_NUM_THREADS)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
518 omp_get_num_threads ();
21554
9f0088f3f335 call openmp function at initialization (bug #47372)
John W. Eaton <jwe@octave.org>
parents: 20788
diff changeset
519 #endif
9f0088f3f335 call openmp function at initialization (bug #47372)
John W. Eaton <jwe@octave.org>
parents: 20788
diff changeset
520
14861
f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory
Rik <octave@nomad.inbox5.com>
parents: 14445
diff changeset
521 #if defined (__386BSD__) || defined (__FreeBSD__) || defined (__NetBSD__)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
522 BSD_init ();
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
523 #elif defined (__MINGW32__)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
524 MINGW_init ();
6080
40ab35ab651c [project @ 2006-10-25 03:26:36 by jwe]
jwe
parents: 5823
diff changeset
525 #elif defined (_MSC_VER)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
526 MSVC_init ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
527 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
528 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
529
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
530 void sysdep_cleanup (void)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
531 {
21989
6bce4d23af6b eliminate OCTAVE_USE_WINDOWS_API and OCTAVE_USE_OS_X_API from header files
John W. Eaton <jwe@octave.org>
parents: 21979
diff changeset
532 #if defined (OCTAVE_USE_WINDOWS_API)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
533 // Let us fail immediately without displaying any dialog.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
534 SetProcessShutdownParameters (0x280, SHUTDOWN_NORETRY);
21989
6bce4d23af6b eliminate OCTAVE_USE_WINDOWS_API and OCTAVE_USE_OS_X_API from header files
John W. Eaton <jwe@octave.org>
parents: 21979
diff changeset
535 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
536 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
537
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
538 // Set terminal in raw mode. From less-177.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
539 //
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
540 // Change terminal to "raw mode", or restore to "normal" mode.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
541 // "Raw mode" means
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
542 // 1. An outstanding read will complete on receipt of a single keystroke.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
543 // 2. Input is not echoed.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
544 // 3. On output, \n is mapped to \r\n.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
545 // 4. \t is NOT expanded into spaces.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
546 // 5. Signal-causing characters such as ctrl-C (interrupt),
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
547 // etc. are NOT disabled.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
548 // It doesn't matter whether an input \n is mapped to \r, or vice versa.
767
42731861ee09 [project @ 1994-10-05 21:26:54 by jwe]
jwe
parents: 712
diff changeset
549
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
550 void raw_mode (bool on, bool wait)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
551 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
552 static bool curr_on = false;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
553
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
554 int tty_fd = STDIN_FILENO;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
555 if (! octave_isatty_wrapper (tty_fd))
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
556 {
27301
a2b1ba6c92d5 eliminate unnecessary application::interative function
John W. Eaton <jwe@octave.org>
parents: 27277
diff changeset
557 interpreter& interp = __get_interpreter__ ("raw_mode");
a2b1ba6c92d5 eliminate unnecessary application::interative function
John W. Eaton <jwe@octave.org>
parents: 27277
diff changeset
558
a2b1ba6c92d5 eliminate unnecessary application::interative function
John W. Eaton <jwe@octave.org>
parents: 27277
diff changeset
559 if (interp.interactive () && ! application::forced_interactive ())
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
560 error ("stdin is not a tty!");
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
561 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
562
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
563 if (on == curr_on)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
564 return;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
565
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
566 #if defined (HAVE_TERMIOS_H)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
567 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
568 struct termios s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
569 static struct termios save_term;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
570
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
571 if (on)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
572 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
573 // Get terminal modes.
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
574
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
575 tcgetattr (tty_fd, &s);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
576
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
577 // Save modes and set certain variables dependent on modes.
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
578
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
579 save_term = s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
580 // ospeed = s.c_cflag & CBAUD;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
581 // erase_char = s.c_cc[VERASE];
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
582 // kill_char = s.c_cc[VKILL];
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
583
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
584 // Set the modes to the way we want them.
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
585
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
586 s.c_lflag &= ~(ICANON | ECHO | ECHOE | ECHOK | ECHONL);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
587 s.c_oflag |= (OPOST | ONLCR);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
588 #if defined (OCRNL)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
589 s.c_oflag &= ~(OCRNL);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
590 #endif
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
591 #if defined (ONOCR)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
592 s.c_oflag &= ~(ONOCR);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
593 #endif
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
594 #if defined (ONLRET)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
595 s.c_oflag &= ~(ONLRET);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
596 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
597 s.c_cc[VMIN] = (wait ? 1 : 0);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
598 s.c_cc[VTIME] = 0;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
599 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
600 else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
601 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
602 // Restore saved modes.
1358
dc9c01f66a19 [project @ 1995-09-05 21:10:01 by jwe]
jwe
parents: 1352
diff changeset
603
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
604 s = save_term;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
605 }
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
diff changeset
606
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
607 tcsetattr (tty_fd, wait ? TCSAFLUSH : TCSADRAIN, &s);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
608 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
609 #elif defined (HAVE_TERMIO_H)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
610 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
611 struct termio s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
612 static struct termio save_term;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
613
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
614 if (on)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
615 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
616 // Get terminal modes.
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
617
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
618 ioctl (tty_fd, TCGETA, &s);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
619
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
620 // Save modes and set certain variables dependent on modes.
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
621
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
622 save_term = s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
623 // ospeed = s.c_cflag & CBAUD;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
624 // erase_char = s.c_cc[VERASE];
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
625 // kill_char = s.c_cc[VKILL];
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
626
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
627 // Set the modes to the way we want them.
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
628
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
629 s.c_lflag &= ~(ICANON | ECHO | ECHOE | ECHOK | ECHONL);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
630 s.c_oflag |= (OPOST | ONLCR);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
631 #if defined (OCRNL)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
632 s.c_oflag &= ~(OCRNL);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
633 #endif
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
634 #if defined (ONOCR)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
635 s.c_oflag &= ~(ONOCR);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
636 #endif
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
637 #if defined (ONLRET)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
638 s.c_oflag &= ~(ONLRET);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
639 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
640 s.c_cc[VMIN] = (wait ? 1 : 0);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
641 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
642 else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
643 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
644 // Restore saved modes.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
645
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
646 s = save_term;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
647 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
648
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
649 ioctl (tty_fd, TCSETAW, &s);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
650 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
651 #elif defined (HAVE_SGTTY_H)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
652 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
653 octave_unused_parameter (wait);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
654
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
655 struct sgttyb s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
656 static struct sgttyb save_term;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
657
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
658 if (on)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
659 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
660 // Get terminal modes.
1358
dc9c01f66a19 [project @ 1995-09-05 21:10:01 by jwe]
jwe
parents: 1352
diff changeset
661
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
662 ioctl (tty_fd, TIOCGETP, &s);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
663
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
664 // Save modes and set certain variables dependent on modes.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
665
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
666 save_term = s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
667 // ospeed = s.sg_ospeed;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
668 // erase_char = s.sg_erase;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
669 // kill_char = s.sg_kill;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
670
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
671 // Set the modes to the way we want them.
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
diff changeset
672
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
673 s.sg_flags |= CBREAK;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
674 s.sg_flags &= ~(ECHO);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
675 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
676 else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
677 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
678 // Restore saved modes.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
679
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
680 s = save_term;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
681 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
682
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
683 ioctl (tty_fd, TIOCSETN, &s);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
684 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
685 #else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
686
24118
f87c9f5c0f43 maint: silence several compiler warnings when building for Windows
Mike Miller <mtmiller@octave.org>
parents: 23812
diff changeset
687 octave_unused_parameter (wait);
f87c9f5c0f43 maint: silence several compiler warnings when building for Windows
Mike Miller <mtmiller@octave.org>
parents: 23812
diff changeset
688
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
689 warn_disabled_feature ("", "raw mode console I/O");
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
690
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
691 // Make sure the current mode doesn't toggle.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
692 on = curr_on;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
693 #endif
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
694
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
695 curr_on = on;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
696 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
697
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
698 FILE * popen (const char *command, const char *mode)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
699 {
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
700 #if defined (__MINGW32__) || defined (_MSC_VER)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
701 wchar_t *wcommand = u8_to_wchar (command);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
702 wchar_t *wmode = u8_to_wchar (mode);
25530
197126863d95 sysdep.cc: Use wide character versions of Windows API functions (bug #49118).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25311
diff changeset
703
28857
43ad651cf5a0 eliminate unnecessary uses of octave:: namespace qualifier
John W. Eaton <jwe@octave.org>
parents: 28851
diff changeset
704 unwind_action free_memory ([=] ()
43ad651cf5a0 eliminate unnecessary uses of octave:: namespace qualifier
John W. Eaton <jwe@octave.org>
parents: 28851
diff changeset
705 {
43ad651cf5a0 eliminate unnecessary uses of octave:: namespace qualifier
John W. Eaton <jwe@octave.org>
parents: 28851
diff changeset
706 ::free (wcommand);
43ad651cf5a0 eliminate unnecessary uses of octave:: namespace qualifier
John W. Eaton <jwe@octave.org>
parents: 28851
diff changeset
707 ::free (wmode);
43ad651cf5a0 eliminate unnecessary uses of octave:: namespace qualifier
John W. Eaton <jwe@octave.org>
parents: 28851
diff changeset
708 });
25530
197126863d95 sysdep.cc: Use wide character versions of Windows API functions (bug #49118).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25311
diff changeset
709
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
710 if (wmode && wmode[0] && ! wmode[1])
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
711 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
712 // Use binary mode on Windows if unspecified
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
713 wchar_t tmode[3] = {wmode[0], L'b', L'\0'};
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
714
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
715 return _wpopen (wcommand, tmode);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
716 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
717 else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
718 return _wpopen (wcommand, wmode);
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
719 #else
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
720 return ::popen (command, mode);
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
721 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
722 }
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
723
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
724 int pclose (FILE *f)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
725 {
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
726 #if defined (__MINGW32__) || defined (_MSC_VER)
25655
be7ba25bb5bf Fix Windows cross-build after 85c3e315bd43.
Markus Mützel <markus.muetzel@gmx.de>
parents: 25649
diff changeset
727 return ::_pclose (f);
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
728 #else
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
729 return ::pclose (f);
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
730 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
731 }
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
732
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
733 // Read one character from the terminal.
767
42731861ee09 [project @ 1994-10-05 21:26:54 by jwe]
jwe
parents: 712
diff changeset
734
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
735 int kbhit (bool wait)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
736 {
20788
a2b96b523472 Rewrite a8ee668e7fd7 to use #if defined rather than #ifdef.
Rik <rik@octave.org>
parents: 20786
diff changeset
737 #if defined (HAVE__KBHIT) && defined (HAVE__GETCH)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
738 // This essentially means we are on a Windows system.
27045
7894624afc47 Fix pause() with no arguments called on Windows (bug #55943)
Mike Miller <mtmiller@octave.org>
parents: 27011
diff changeset
739
7894624afc47 Fix pause() with no arguments called on Windows (bug #55943)
Mike Miller <mtmiller@octave.org>
parents: 27011
diff changeset
740 // The value to return when wait is false and no input is ready.
7894624afc47 Fix pause() with no arguments called on Windows (bug #55943)
Mike Miller <mtmiller@octave.org>
parents: 27011
diff changeset
741 static constexpr int eof = std::istream::traits_type::eof ();
7894624afc47 Fix pause() with no arguments called on Windows (bug #55943)
Mike Miller <mtmiller@octave.org>
parents: 27011
diff changeset
742
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
743 int c;
20786
a8ee668e7fd7 Fix kbhit and pause on Windows systems.
Rik <rik@octave.org>
parents: 20181
diff changeset
744
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
745 if (wait)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
746 c = _getch ();
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
747 else
27045
7894624afc47 Fix pause() with no arguments called on Windows (bug #55943)
Mike Miller <mtmiller@octave.org>
parents: 27011
diff changeset
748 c = (! _kbhit ()) ? eof : _getch ();
20786
a8ee668e7fd7 Fix kbhit and pause on Windows systems.
Rik <rik@octave.org>
parents: 20181
diff changeset
749
4067
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 4064
diff changeset
750 #else
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
751 raw_mode (true, wait);
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
diff changeset
752
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
753 // Get current handler.
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
754 interrupt_handler saved_interrupt_handler
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
755 = ignore_interrupts ();
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
756
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
757 // Restore it, disabling system call restarts (if possible) so the
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
758 // read can be interrupted.
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
759
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
760 set_interrupt_handler (saved_interrupt_handler, false);
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
761
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
762 int c = std::cin.get ();
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
763
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
764 if (std::cin.fail () || std::cin.eof ())
27011
c3716220d5b9 fix pause and kbhit with glibc 2.28 end-of-file state behavior (bug #55029)
Mike Miller <mtmiller@octave.org>
parents: 26617
diff changeset
765 {
c3716220d5b9 fix pause and kbhit with glibc 2.28 end-of-file state behavior (bug #55029)
Mike Miller <mtmiller@octave.org>
parents: 26617
diff changeset
766 std::cin.clear ();
c3716220d5b9 fix pause and kbhit with glibc 2.28 end-of-file state behavior (bug #55029)
Mike Miller <mtmiller@octave.org>
parents: 26617
diff changeset
767 clearerr (stdin);
c3716220d5b9 fix pause and kbhit with glibc 2.28 end-of-file state behavior (bug #55029)
Mike Miller <mtmiller@octave.org>
parents: 26617
diff changeset
768 }
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
diff changeset
769
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
770 // Restore it, enabling system call restarts (if possible).
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
771 set_interrupt_handler (saved_interrupt_handler, true);
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
772
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
773 raw_mode (false, true);
4067
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 4064
diff changeset
774 #endif
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
diff changeset
775
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
776 return c;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
777 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
778
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
779 std::string get_P_tmpdir (void)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
780 {
21979
d04da18a407a use OCTAVE_USE_WINDOWS_API more consistently
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
781 #if defined (OCTAVE_USE_WINDOWS_API)
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
782
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
783 std::string retval;
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
784
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
785 #if defined (P_tmpdir)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
786 retval = P_tmpdir;
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
787 #endif
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
788
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
789 // Apparently some versions of MinGW and MSVC either don't define
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
790 // P_tmpdir, or they define it to a single backslash, neither of which
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
791 // is particularly helpful.
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
792
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
793 if (retval.empty () || retval == R"(\)")
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
794 {
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
795 retval = sys::env::getenv ("TEMP");
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
796
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
797 if (retval.empty ())
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
798 retval = sys::env::getenv ("TMP");
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
799
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
800 if (retval.empty ())
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
801 retval = R"(c:\temp)";
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
802 }
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
803
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
804 return retval;
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
805
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
806 #elif defined (P_tmpdir)
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
807
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
808 return P_tmpdir;
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
809
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
810 #else
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
811
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
812 return "/tmp";
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
813
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
814 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
815 }
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
816 }
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
817
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
818 DEFUN (clc, , ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
819 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
820 @deftypefn {} {} clc ()
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
821 @deftypefnx {} {} home ()
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
822 Clear the terminal screen and move the cursor to the upper left corner.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
823 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
824 {
16537
106a38d7b396 optionall disable redisplay in command editor clear screen function
John W. Eaton <jwe@octave.org>
parents: 16404
diff changeset
825 bool skip_redisplay = true;
106a38d7b396 optionall disable redisplay in command editor clear screen function
John W. Eaton <jwe@octave.org>
parents: 16404
diff changeset
826
21748
176536b15d68 use namespace for command_editor and command_history classes
John W. Eaton <jwe@octave.org>
parents: 21739
diff changeset
827 octave::command_editor::clear_screen (skip_redisplay);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
828
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
829 return ovl ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
830 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
831
549
75a371805554 [project @ 1994-07-22 19:44:41 by jwe]
jwe
parents: 545
diff changeset
832 DEFALIAS (home, clc);
75a371805554 [project @ 1994-07-22 19:44:41 by jwe]
jwe
parents: 545
diff changeset
833
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
834 DEFUN (getenv, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
835 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
836 @deftypefn {} {} getenv (@var{var})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
837 Return the value of the environment variable @var{var}.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
838
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
839 For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
840
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
841 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
842 getenv ("PATH")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
843 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
844
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
845 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
846 returns a string containing the value of your path.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
847 @seealso{setenv, unsetenv}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
848 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
849 {
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20799
diff changeset
850 if (args.length () != 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
851 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
852
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
853 std::string name = args(0).string_value ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
854
21732
6a1eded90355 use namespace for system env class
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
855 return ovl (octave::sys::env::getenv (name));
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
856 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
857
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
858 /*
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
859 %!assert (ischar (getenv ("OCTAVE_HOME")))
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
860 */
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
861
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
862 DEFUN (setenv, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
863 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
864 @deftypefn {} {} setenv (@var{var}, @var{value})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
865 @deftypefnx {} {} setenv (@var{var})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
866 @deftypefnx {} {} putenv (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
867 Set the value of the environment variable @var{var} to @var{value}.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
868
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
869 If no @var{value} is specified then the variable will be assigned the null
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
870 string.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
871 @seealso{unsetenv, getenv}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
872 @end deftypefn */)
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
873 {
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
874 int nargin = args.length ();
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
875
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
876 if (nargin < 1 || nargin > 2)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
877 print_usage ();
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
878
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
879 std::string var = args(0).xstring_value ("setenv: VAR must be a string");
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
880
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
881 std::string val = (nargin == 2
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
882 ? args(1).xstring_value ("setenv: VALUE must be a string")
21017
93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents: 20990
diff changeset
883 : "");
20582
ba2b07c13913 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20555
diff changeset
884
21732
6a1eded90355 use namespace for system env class
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
885 octave::sys::env::putenv (var, val);
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
886
21078
49852ff04747 maint: Remove unnecessary declarations of retval.
Rik <rik@octave.org>
parents: 21017
diff changeset
887 return ovl ();
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
888 }
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
889
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
890 DEFALIAS (putenv, setenv);
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
891
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
892 /*
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
893 %!test
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
894 %! setenv ("dummy_variable_that_cannot_matter", "foobar");
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
895 %! assert (getenv ("dummy_variable_that_cannot_matter"), "foobar");
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
896 %! unsetenv ("dummy_variable_that_cannot_matter");
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
897 %! assert (getenv ("dummy_variable_that_cannot_matter"), "");
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
898 */
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
899
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
900 DEFUN (unsetenv, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
901 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
902 @deftypefn {} {@var{status} =} unsetenv (@var{var})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
903 Delete the environment variable @var{var}.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
904
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
905 Return 0 if the variable was deleted, or did not exist, and -1 if an error
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
906 occurred.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
907 @seealso{setenv, getenv}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
908 @end deftypefn */)
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
909 {
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20799
diff changeset
910 if (args.length () != 1)
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
911 print_usage ();
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
912
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
913 std::string tmp = args(0).string_value ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
914
25916
3f2282954600 Support non-ASCII characters in environment variables on Windows (bug #53922).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25714
diff changeset
915 return ovl (octave::sys::unsetenv_wrapper (tmp));
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
916 }
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
917
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
918 /*
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
919 ## Test for unsetenv is in setenv test
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
920 */
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
921
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
922 #if defined (OCTAVE_USE_WINDOWS_API)
24710
a979bb895b64 avoid reinterpret_cast on function pointer in previous change
John W. Eaton <jwe@octave.org>
parents: 24709
diff changeset
923
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
924 namespace octave
24710
a979bb895b64 avoid reinterpret_cast on function pointer in previous change
John W. Eaton <jwe@octave.org>
parents: 24709
diff changeset
925 {
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
926 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
927 reg_close_key_wrapper (HKEY key)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
928 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
929 RegCloseKey (key);
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
930 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
931
27126
3d9e72cac668 allow Windows build to work again
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
932 // This function is also used in ov-java.cc, so don't declare static.
3d9e72cac668 allow Windows build to work again
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
933 // Maybe the functions that use it should be here instead?
3d9e72cac668 allow Windows build to work again
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
934
3d9e72cac668 allow Windows build to work again
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
935 LONG
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
936 get_regkey_value (HKEY h_rootkey, const std::string subkey,
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
937 const std::string name, octave_value& value)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
938 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
939 LONG result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
940 HKEY h_subkey;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
941
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
942 std::wstring wsubkey = sys::u8_to_wstring (subkey);
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
943 result = RegOpenKeyExW (h_rootkey, wsubkey.c_str (), 0, KEY_READ,
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
944 &h_subkey);
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
945
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
946 if (result != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
947 return result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
948
28857
43ad651cf5a0 eliminate unnecessary uses of octave:: namespace qualifier
John W. Eaton <jwe@octave.org>
parents: 28851
diff changeset
949 unwind_action restore_keys ([=] () { reg_close_key_wrapper (h_subkey); });
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
950
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
951 std::wstring wname = sys::u8_to_wstring (name);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
952 DWORD length = 0;
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
953 result = RegQueryValueExW (h_subkey, wname.c_str (), nullptr, nullptr,
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
954 nullptr, &length);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
955 if (result != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
956 return result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
957
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
958 DWORD type = 0;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
959 OCTAVE_LOCAL_BUFFER (BYTE, data, length);
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
960 result = RegQueryValueExW (h_subkey, wname.c_str (), nullptr, &type,
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
961 data, &length);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
962 if (result != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
963 return result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
964
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
965 if (type == REG_DWORD)
27421
edeacebc8800 maint: merge stable to default.
Rik <rik@octave.org>
parents: 27346 27420
diff changeset
966 value = octave_int32 (*(reinterpret_cast<DWORD *> (data)));
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
967 else if (type == REG_SZ || type == REG_EXPAND_SZ)
27276
7455523fdf01 style fixes: avoid breaking lines immediately after '('
John W. Eaton <jwe@octave.org>
parents: 27143
diff changeset
968 value = string_vector (sys::u8_from_wstring (reinterpret_cast<wchar_t *> (data)));
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
969
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
970 return result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
971 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
972
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
973 static LONG
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
974 get_regkey_names (HKEY h_rootkey, const std::string subkey,
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
975 std::list<std::string> &fields)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
976 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
977 LONG retval;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
978 HKEY h_subkey;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
979
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
980 fields.clear ();
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
981
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
982 std::wstring wsubkey = sys::u8_to_wstring (subkey);
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
983 retval = RegOpenKeyExW (h_rootkey, wsubkey.c_str (), 0, KEY_READ,
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
984 &h_subkey);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
985 if (retval != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
986 return retval;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
987
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
988 DWORD idx = 0;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
989 const int MAX_VALUE_NAME_SIZE = 32766;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
990 wchar_t value_name[MAX_VALUE_NAME_SIZE+1];
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
991 DWORD value_name_size = MAX_VALUE_NAME_SIZE;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
992
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
993 while (true)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
994 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
995 retval = RegEnumValueW (h_subkey, idx, value_name, &value_name_size,
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
996 nullptr, nullptr, nullptr, nullptr);
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
997 if (retval != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
998 break;
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
999 fields.push_back (sys::u8_from_wstring (value_name));
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1000 value_name_size = MAX_VALUE_NAME_SIZE;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1001 idx++;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1002 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1003
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1004 if (retval == ERROR_NO_MORE_ITEMS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1005 retval = ERROR_SUCCESS;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1006
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1007 RegCloseKey (h_subkey);
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1008
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1009 return retval;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1010 }
24710
a979bb895b64 avoid reinterpret_cast on function pointer in previous change
John W. Eaton <jwe@octave.org>
parents: 24709
diff changeset
1011 }
a979bb895b64 avoid reinterpret_cast on function pointer in previous change
John W. Eaton <jwe@octave.org>
parents: 24709
diff changeset
1012
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1013 #endif
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1014
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1015 DEFUN (winqueryreg, args, ,
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1016 doc: /* -*- texinfo -*-
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1017 @deftypefn {} {@var{value} =} winqueryreg (@var{rootkey}, @var{subkey}, @var{valuename})
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1018 @deftypefnx {} {@var{value} =} winqueryreg (@var{rootkey}, @var{subkey})
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1019 @deftypefnx {} {@var{names} =} winqueryreg (@code{"name"}, @var{rootkey}, @var{subkey})
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1020
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1021 Query names or value from the Windows registry.
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1022
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1023 On Windows, return the value of the registry key @var{subkey} from the root key
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1024 @var{rootkey}. You can specify the name of the queried registry value with the
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1025 optional argument @var{valuename}. Otherwise, if called with only two
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1026 arguments or @var{valuename} is empty, then the default value of @var{subkey}
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1027 is returned. If the registry value is of type @nospell{@qcode{"REG_DWORD"}}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1028 then @var{value} is of class int32. If the value is of the type
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1029 @nospell{@qcode{"REG_SZ"}} or @nospell{@qcode{"REG_EXPAND_SZ"}} a string is
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1030 returned.
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1031
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1032 If the first argument is @qcode{"name"}, a cell array of strings with the names
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1033 of the values at that key is returned.
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1034
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1035 The variable @var{rootkey} must be a string with a valid root key identifier:
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1036
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1037 @table @asis
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1038 @item @nospell{HKCR}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1039 @itemx @nospell{HKEY_CLASSES_ROOT}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1040
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1041 @item @nospell{HKEY_CURRENT_CONFIG}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1042
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1043 @item @nospell{HKCU}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1044 @itemx @nospell{HKEY_CURRENT_USER}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1045
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1046 @item @nospell{HKLM}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1047 @itemx @nospell{HKEY_LOCAL_MACHINE}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1048
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1049
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1050 @item @nospell{HKU}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1051 @itemx @nospell{HKEY_USERS}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1052
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1053
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1054 @item @nospell{HKEY_PERFORMANCE_DATA}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1055
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1056 @end table
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1057
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1058 Examples:
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1059
29117
10a35049bad7 doc: Cleanup Texinfo macros use in documentation.
Rik <rik@octave.org>
parents: 28930
diff changeset
1060 Get a list of value names at the key
10a35049bad7 doc: Cleanup Texinfo macros use in documentation.
Rik <rik@octave.org>
parents: 28930
diff changeset
1061 @nospell{@qcode{'HKCU@backslashchar{}Environment'}}:
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1062
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1063 @example
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1064 @group
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1065 @var{valuenames} = winqueryreg ("name", "HKEY_CURRENT_USER", ...
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1066 "Environment");
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1067 @end group
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1068 @end example
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1069
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1070 For each @var{valuenames}, display the value:
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1071
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1072 @example
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1073 @group
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1074 for @var{k} = 1:numel (@var{valuenames})
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1075 @var{val} = winqueryreg ("HKEY_CURRENT_USER", "Environment", ...
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1076 @var{valuenames}@{@var{k}@});
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1077 @var{str} = sprintf ("%s = %s", @var{valuenames}@{@var{k}@}, num2str (@var{val}));
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1078 disp (@var{str});
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1079 endfor
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1080 @end group
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1081 @end example
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1082
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1083 On non-Windows platforms this function fails with an error.
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1084 @end deftypefn */)
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1085 {
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1086 #if defined (OCTAVE_USE_WINDOWS_API)
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1087 if ((args.length () < 2) || (args.length () > 3))
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1088 print_usage ();
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1089
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1090 // Input check
27277
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1091 std::string rootkey_name
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1092 = args(0).xstring_value ("winqueryreg: the first argument must be 'name' "
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1093 "or a valid ROOTKEY identifier");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1094 std::string subkey_name = "";
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1095 std::string value_name = "";
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1096 bool get_names = false;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1097 if (rootkey_name.compare ("name") == 0)
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1098 {
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1099 if (args.length () < 3)
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1100 error ("winqueryreg: if the first argument is 'name', "
25103
078b795c5219 maint: style check C++ ahead of 4.4 release.
Rik <rik@octave.org>
parents: 25054
diff changeset
1101 "ROOTKEY and SUBKEY must be given");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1102 get_names = true;
27277
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1103 rootkey_name
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1104 = args(1).xstring_value ("winqueryreg: ROOTKEY must be a string");
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1105 subkey_name
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1106 = args(2).xstring_value ("winqueryreg: SUBKEY must be a string");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1107 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1108 else
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1109 {
27277
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1110 subkey_name
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1111 = args(1).xstring_value ("winqueryreg: SUBKEY must be a string");
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1112
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1113 if (args.length () == 3)
27277
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1114 value_name
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1115 = args(2).xstring_value ("winqueryreg: VALUENAME must be a string");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1116 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1117
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1118 // Get rootkey handle
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1119 HKEY h_rootkey;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1120 if (rootkey_name == "HKEY_CLASSES_ROOT" || rootkey_name == "HKCR")
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1121 h_rootkey = HKEY_CLASSES_ROOT;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1122 else if (rootkey_name == "HKEY_CURRENT_CONFIG")
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1123 h_rootkey = HKEY_CURRENT_CONFIG;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1124 else if (rootkey_name == "HKEY_CURRENT_USER" || rootkey_name == "HKCU")
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1125 h_rootkey = HKEY_CURRENT_USER;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1126 else if (rootkey_name == "HKEY_LOCAL_MACHINE" || rootkey_name == "HKLM")
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1127 h_rootkey = HKEY_LOCAL_MACHINE;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1128 else if (rootkey_name == "HKEY_PERFORMANCE_DATA")
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1129 h_rootkey = HKEY_PERFORMANCE_DATA;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1130 else if (rootkey_name == "HKEY_USERS" || rootkey_name == "HKU")
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1131 h_rootkey = HKEY_USERS;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1132 else
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1133 error ("winqueryreg: ROOTKEY is not a valid root key identifier");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1134
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1135 if (get_names)
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1136 {
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1137 std::list<std::string> fields;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1138
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1139 LONG retval = octave::get_regkey_names (h_rootkey, subkey_name, fields);
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1140 if (retval != ERROR_SUCCESS)
26162
ef1ef6364a6a Silence compiler warnings about incorrect format specifiers cross-compiling (bug #55046).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26046
diff changeset
1141 error ("winqueryreg: error %ld reading names from registry", retval);
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1142
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1143 Cell fieldnames (dim_vector (1, fields.size ()));
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1144 size_t i;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1145 std::list<std::string>::const_iterator it;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1146 for (i = 0, it = fields.begin (); it != fields.end (); ++it, ++i)
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1147 fieldnames(i) = *it;
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1148
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1149 return ovl (fieldnames);
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1150 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1151 else
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1152 {
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1153 octave_value key_val;
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1154 LONG retval = octave::get_regkey_value (h_rootkey, subkey_name,
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1155 value_name, key_val);
24720
48f22c5b22aa winqueryreg: Fix error on Windows XP (bug #50463).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24714
diff changeset
1156 if (retval == ERROR_FILE_NOT_FOUND)
28905
89a425f2c202 maint: Use Octave convention that error() messages don't end with a period.
Rik <rik@octave.org>
parents: 28857
diff changeset
1157 error ("winqueryreg: no value found for '%s' at %s\\%s",
24720
48f22c5b22aa winqueryreg: Fix error on Windows XP (bug #50463).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24714
diff changeset
1158 value_name.c_str (), rootkey_name.c_str (),
48f22c5b22aa winqueryreg: Fix error on Windows XP (bug #50463).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24714
diff changeset
1159 subkey_name.c_str ());
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1160 if (retval != ERROR_SUCCESS)
26162
ef1ef6364a6a Silence compiler warnings about incorrect format specifiers cross-compiling (bug #55046).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26046
diff changeset
1161 error ("winqueryreg: error %ld reading the specified key", retval);
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1162
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1163 return ovl (key_val);
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1164 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1165 #else
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1166
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1167 octave_unused_parameter (args);
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1168
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1169 error ("winqueryreg: function is only supported on Windows platforms");
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1170
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1171 #endif
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1172 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1173
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1174 /*
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1175 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1176 %! assert (ischar (winqueryreg ("HKEY_LOCAL_MACHINE",
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1177 %! 'SOFTWARE\Microsoft\Windows\CurrentVersion',
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1178 %! "ProgramFilesDir")));
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1179 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1180 %! assert (isa (winqueryreg ("HKEY_LOCAL_MACHINE",
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1181 %! 'SYSTEM\CurrentControlSet\Control\FileSystem',
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1182 %! "Win31FileSystem"), "int32"));
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1183 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1184 %! assert (iscellstr (winqueryreg ("name", "HKEY_LOCAL_MACHINE",
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1185 %! 'SOFTWARE\Microsoft\Windows\CurrentVersion')));
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1186 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1187 %! fail ('winqueryreg (1, ''SOFTWARE\Microsoft\Windows\CurrentVersion'')',
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1188 %! "first argument must be 'name' or a valid ROOTKEY identifier");
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1189 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1190 %! fail ('winqueryreg ("HKEY_LOCAL_MACHINE", 1)', "SUBKEY must be a string");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1191 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1192 %! fail (['winqueryreg ("HKEY_LOCAL_MACHINE", ', ...
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1193 %! '''SOFTWARE\Microsoft\Windows\CurrentVersion'', 1)'],
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1194 %! "VALUENAME must be a string");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1195 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1196 %! fail (['winqueryreg ("FOO", ', ...
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1197 %! '''SOFTWARE\Microsoft\Windows\CurrentVersion'')'],
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1198 %! "ROOTKEY is not a valid root key identifier");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1199 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1200 %! fail ('winqueryreg ("HKEY_LOCAL_MACHINE", ''FOO\bar'')',
24720
48f22c5b22aa winqueryreg: Fix error on Windows XP (bug #50463).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24714
diff changeset
1201 %! "no value found for");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1202 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1203 %! fail (['winqueryreg ("HKEY_LOCAL_MACHINE", ', ...
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1204 %! '''SOFTWARE\Microsoft\Windows\CurrentVersion'', "foo")'],
24720
48f22c5b22aa winqueryreg: Fix error on Windows XP (bug #50463).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24714
diff changeset
1205 %! "no value found for");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1206 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1207 %! fail ('winqueryreg ("name", "HKEY_LOCAL_MACHINE")',
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1208 %! "if the first argument is 'name', ROOTKEY and SUBKEY must be given");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1209 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1210 %! fail (['winqueryreg ("name", 1, ', ...
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1211 %! '''SOFTWARE\Microsoft\Windows\CurrentVersion'')'],
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1212 %! "ROOTKEY must be a string");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1213 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1214 %! fail ('winqueryreg ("name", "HKEY_LOCAL_MACHINE", 1)',
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1215 %! "SUBKEY must be a string");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1216 */
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1217
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1218 // FIXME: perhaps kbhit should also be able to print a prompt?
3372
f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe]
jwe
parents: 3333
diff changeset
1219
27335
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1220 DEFMETHOD (kbhit, interp, args, ,
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1221 doc: /* -*- texinfo -*-
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1222 @deftypefn {} {} kbhit ()
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1223 @deftypefnx {} {} kbhit (1)
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1224 Read a single keystroke from the keyboard.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1225
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1226 If called with an argument, don't wait for a keypress.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1227
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1228 For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1229
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1230 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1231 x = kbhit ();
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1232 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1233
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1234 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1235 will set @var{x} to the next character typed at the keyboard as soon as
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1236 it is typed.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1237
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1238 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1239 x = kbhit (1);
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1240 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1241
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1242 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1243 is identical to the above example, but doesn't wait for a keypress,
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1244 returning the empty string if no key is available.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1245 @seealso{input, pause}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1246 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1247 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1248 // FIXME: add timeout and default value args?
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1249
27335
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1250 Fdrawnow (interp);
6423
a90b54016b12 [project @ 2007-03-21 13:15:03 by jwe]
jwe
parents: 6419
diff changeset
1251
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
1252 int c = octave::kbhit (args.length () == 0);
3657
a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe]
jwe
parents: 3531
diff changeset
1253
25311
10ec5795bd06 allow kbhit to work in command-line scripts (bug #53412)
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
1254 if (c == -1)
10ec5795bd06 allow kbhit to work in command-line scripts (bug #53412)
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
1255 c = 0;
16015
d910b9211cca Plug memory leak in kbhit().
Rik <rik@octave.org>
parents: 15423
diff changeset
1256
25311
10ec5795bd06 allow kbhit to work in command-line scripts (bug #53412)
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
1257 char s[2] = { static_cast<char> (c), '\0' };
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1258
25311
10ec5795bd06 allow kbhit to work in command-line scripts (bug #53412)
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
1259 return octave_value (s);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1260 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1261
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1262 // State of the pause system
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1263 static bool Vpause_enabled = true;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1264
27335
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1265 DEFMETHOD (pause, interp, args, nargout,
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1266 doc: /* -*- texinfo -*-
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1267 @deftypefn {} {} pause ()
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1268 @deftypefnx {} {} pause (@var{n})
26046
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1269 @deftypefnx {} {@var{old_state} =} pause ("on")
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1270 @deftypefnx {} {@var{old_state} =} pause ("off")
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1271 @deftypefnx {} {@var{old_state} =} pause ("query")
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1272 Suspend the execution of the program or change the state of the pause function.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1273
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1274 If invoked without an input arguments then the program is suspended until a
26046
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1275 character is typed. If argument @var{n} is a positive real value, it indicates
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1276 the number of seconds the program shall be suspended, for example:
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1277
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1278 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1279 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1280 tic; pause (0.05); toc
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1281 @print{} Elapsed time is 0.05039 seconds.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1282 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1283 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1284
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1285 The following example prints a message and then waits 5 seconds before
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1286 clearing the screen.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1287
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1288 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1289 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1290 disp ("wait please...");
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1291 pause (5);
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1292 clc;
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1293 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1294 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1295
26046
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1296 If invoked with a string argument @qcode{"on"}, @qcode{"off"}, or
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1297 @qcode{"query"}, the state of the pause function is changed or queried. When
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1298 the state is @qcode{"off"}, the pause function returns immediately. The
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1299 optional return value contains the previous state of the pause function. In
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1300 the following example pause is disabled locally:
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1301
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1302 @example
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1303 @group
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1304 old_state = pause ("off");
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1305 tic; pause (0.05); toc
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1306 @print{} Elapsed time is 3.00407e-05 seconds.
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1307 pause (old_state);
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1308 @end group
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1309 @end example
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1310
26046
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1311 While the program is suspended Octave still handles figures painting and
25961
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25916
diff changeset
1312 graphics callbacks execution.
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25916
diff changeset
1313
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1314 @seealso{kbhit}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1315 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1316 {
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1317 octave_value_list retval;
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1318
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1319 int nargin = args.length ();
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1320
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
1321 if (nargin > 1)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
1322 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1323
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1324 if (nargin == 1 && args(0).is_string ())
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1325 {
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1326 bool saved_state = Vpause_enabled;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1327 std::string state = args(0).string_value ();
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1328
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1329 if (state == "on")
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1330 Vpause_enabled = true;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1331 else if (state == "off")
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1332 Vpause_enabled = false;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1333 else if (state == "query")
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1334 ;// Do nothing
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1335 else
28752
810eb29fc227 maint: Use C++ raw string literals to simplify backlsashing.
Rik <rik@octave.org>
parents: 28371
diff changeset
1336 error (R"(pause: first argument must be "on", "off", or "query")");
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1337
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1338 if (nargout > 0 || state == "query")
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1339 retval.append (saved_state ? "on" : "off");
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1340 }
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1341 else if (Vpause_enabled)
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1342 {
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1343 double dval;
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1344
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1345 if (nargin == 0)
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1346 dval = octave_Inf;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1347 else
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1348 dval = args(0).xdouble_value ("pause: N must be a scalar real value");
6419
73fcbac81f33 [project @ 2007-03-20 17:18:24 by jwe]
jwe
parents: 6208
diff changeset
1349
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1350 if (octave::math::isnan (dval))
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1351 warning ("pause: NaN is an invalid delay");
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1352 else
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1353 {
27335
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1354 Fdrawnow (interp);
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1355
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1356 octave::sleep (dval, true);
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1357 }
3234
be8e0ba13644 [project @ 1999-01-29 03:52:30 by jwe]
jwe
parents: 3124
diff changeset
1358 }
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1359
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1360 return retval;
2630
fdee6fe3e73b [project @ 1997-01-27 19:08:47 by jwe]
jwe
parents: 2610
diff changeset
1361 }
fdee6fe3e73b [project @ 1997-01-27 19:08:47 by jwe]
jwe
parents: 2610
diff changeset
1362
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1363 /*
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1364 %!test
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1365 %! pause (1);
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14160
diff changeset
1366
28930
2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents: 28905
diff changeset
1367 %!error pause (1, 2)
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1368 */
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1369
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1370 // FIXME: maybe this should only return 1 if IEEE floating
862
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1371 // point functions really work.
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1372
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
1373 DEFUN (isieee, , ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1374 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1375 @deftypefn {} {} isieee ()
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1376 Return true if your computer @emph{claims} to conform to the IEEE standard
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1377 for floating point calculations.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1378
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1379 No actual tests are performed.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1380 @end deftypefn */)
862
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1381 {
27277
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1382 octave::mach_info::float_format flt_fmt
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1383 = octave::mach_info::native_float_format ();
2317
8c09c04f7747 [project @ 1996-07-14 22:30:15 by jwe]
jwe
parents: 2086
diff changeset
1384
21739
c4ab2e54f100 use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents: 21736
diff changeset
1385 return ovl (flt_fmt == octave::mach_info::flt_fmt_ieee_little_endian
c4ab2e54f100 use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents: 21736
diff changeset
1386 || flt_fmt == octave::mach_info::flt_fmt_ieee_big_endian);
862
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1387 }
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1388
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1389 /*
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14160
diff changeset
1390 %!assert (islogical (isieee ()))
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1391 */
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1392
4600
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1393 DEFUN (native_float_format, , ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1394 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1395 @deftypefn {} {} native_float_format ()
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1396 Return the native floating point format as a string.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1397 @end deftypefn */)
4600
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1398 {
27277
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1399 octave::mach_info::float_format flt_fmt
db687716fed6 style fixes: generally aim to break long lines before operators, not after
John W. Eaton <jwe@octave.org>
parents: 27276
diff changeset
1400 = octave::mach_info::native_float_format ();
4600
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1401
21739
c4ab2e54f100 use namespace for oct_mach_info class
John W. Eaton <jwe@octave.org>
parents: 21736
diff changeset
1402 return ovl (octave::mach_info::float_format_as_string (flt_fmt));
4600
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1403 }
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1404
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1405 /*
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14160
diff changeset
1406 %!assert (ischar (native_float_format ()))
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1407 */
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1408
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
1409 DEFUN (tilde_expand, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1410 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1411 @deftypefn {} {} tilde_expand (@var{string})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1412 @deftypefnx {} {} tilde_expand (@var{cellstr})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1413 Perform tilde expansion on @var{string}.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1414
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1415 If @var{string} begins with a tilde character, (@samp{~}), all of the
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1416 characters preceding the first slash (or all characters, if there is no
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1417 slash) are treated as a possible user name, and the tilde and the following
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1418 characters up to the slash are replaced by the home directory of the named
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1419 user. If the tilde is followed immediately by a slash, the tilde is
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1420 replaced by the home directory of the user running Octave.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1421
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1422 If the input is a cell array of strings @var{cellstr} then tilde expansion
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1423 is performed on each string element.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1424
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1425 Examples:
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1426
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1427 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1428 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1429 tilde_expand ("~joeuser/bin")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1430 @result{} "/home/joeuser/bin"
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1431 tilde_expand ("~/bin")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1432 @result{} "/home/jwe/bin"
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1433 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1434 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1435 @end deftypefn */)
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
1436 {
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20799
diff changeset
1437 if (args.length () != 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1438 print_usage ();
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
1439
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
1440 octave_value arg = args(0);
6116
b64fb24bf4a0 [project @ 2006-10-27 18:04:49 by jwe]
jwe
parents: 6086
diff changeset
1441
20990
fc9cca99b2de Deprecate all_strings, replace with string_vector_value.
Rik <rik@octave.org>
parents: 20961
diff changeset
1442 string_vector sv = arg.xstring_vector_value ("tilde_expand: argument must be char or cellstr object");
6116
b64fb24bf4a0 [project @ 2006-10-27 18:04:49 by jwe]
jwe
parents: 6086
diff changeset
1443
21733
cb0fdd941d84 use namespace for system file_ops class
John W. Eaton <jwe@octave.org>
parents: 21732
diff changeset
1444 sv = octave::sys::file_ops::tilde_expand (sv);
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
1445
23575
e95738a119da maint: Deprecate is_cellstr and replace with iscellstr.
Rik <rik@octave.org>
parents: 23459
diff changeset
1446 if (arg.iscellstr ())
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20923
diff changeset
1447 return ovl (Cell (arg.dims (), sv));
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
1448 else
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20923
diff changeset
1449 return ovl (sv);
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
1450 }
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1451
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1452 /*
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1453 %!test
20016
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1454 %! home = get_home_directory ();
20064
ab7582167810 Fix failing BIST test for tilde_expand() on Windows (bug #44796).
Rik <rik@octave.org>
parents: 20024
diff changeset
1455 %! assert (tilde_expand ("~/foobar"), [home "/foobar"]);
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1456 %! assert (tilde_expand ("/foo/bar"), "/foo/bar");
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1457 %! assert (tilde_expand ("foo/bar"), "foo/bar");
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1458 */
17851
af685269e06c avoid symbol conflicts in display.cc
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
1459
20016
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1460 DEFUN (get_home_directory, , ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1461 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1462 @deftypefn {} {@var{homedir} =} get_home_directory ()
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1463 Return the current home directory.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1464
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1465 On most systems, this is equivalent to @code{getenv ("HOME")}. On Windows
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1466 systems, if the environment variable @env{HOME} is not set then it is
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1467 equivalent to
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1468 @code{fullfile (getenv ("HOMEDRIVE"), getenv ("HOMEPATH"))}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1469 @seealso{getenv}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1470 @end deftypefn */)
20016
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1471 {
21732
6a1eded90355 use namespace for system env class
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
1472 return ovl (octave::sys::env::get_home_directory ());
20016
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1473 }
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1474
20024
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1475 /*
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1476 %!test
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1477 %! if (! ispc ())
20181
aa36fb998a4d maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents: 20172
diff changeset
1478 %! assert (get_home_directory (), getenv ("HOME"));
20024
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1479 %! endif
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1480 */
24714
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1481
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1482 DEFUN (__blas_version__, , ,
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1483 doc: /* -*- texinfo -*-
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1484 @deftypefn {} {} __blas_version__ ()
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1485 Undocumented internal function.
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1486 @end deftypefn */)
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1487 {
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1488 return ovl (octave::sys::blas_version ());
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1489 }
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1490
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1491 DEFUN (__lapack_version__, , ,
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1492 doc: /* -*- texinfo -*-
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1493 @deftypefn {} {} __lapack_version__ ()
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1494 Undocumented internal function.
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1495 @end deftypefn */)
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1496 {
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1497 return ovl (octave::sys::lapack_version ());
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1498 }