annotate libinterp/corefcn/sysdep.cc @ 31605:e88a07dec498 stable

maint: Use macros to begin/end C++ namespaces. * oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE, OCTAVE_END_NAMESPACE) that can be used to start/end a namespace. * mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc, __dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc, auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h, besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h, call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc, defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc, display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc, ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h, event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc, fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc, graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc, help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h, interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h, inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc, latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h, lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc, ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h, mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc, oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h, oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h, oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy, ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc, pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h, sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc, sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h, stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h, symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h, text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc, url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc, variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h, __delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc, audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh, mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc, cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h, cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h, cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc, ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h, ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc, ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc, op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc, op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc, op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc, op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc, op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc, op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h, anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h, comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc, oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h, pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h, pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h, pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h, pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h, pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc, pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc, pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc, pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc, pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc, pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc, pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h, pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h, range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc, chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h, lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h, oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h, oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc, qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc, randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc, sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc, child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc, file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h, mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h, oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc, oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h, base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h, file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc, lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h, oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h, oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h, oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h, pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h, url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.
author Rik <rik@octave.org>
date Thu, 01 Dec 2022 14:23:45 -0800
parents 670a0d878af1
children aac27ad79be6
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 //
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 30390
diff changeset
3 // Copyright (C) 1993-2022 The Octave Project Developers
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
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
31605
e88a07dec498 maint: Use macros to begin/end C++ namespaces.
Rik <rik@octave.org>
parents: 31105
diff changeset
106 OCTAVE_BEGIN_NAMESPACE(octave)
29960
939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
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 {
29654
d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
166 std::size_t pos = bin_dir.rfind (R"(\bin\)");
27101
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 }
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29950
diff changeset
191
19856
5c1a38089f89 Change open_with_system_app to internal function.
Rik <rik@octave.org>
parents: 19849
diff changeset
192 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
193 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
194 @deftypefn {} {@var{status} =} __open_with_system_app__ (@var{file})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
195 Return 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
196 @end deftypefn */)
19271
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
197 {
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
198 if (args.length () != 1)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
199 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
200
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
201 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
202
21979
d04da18a407a use OCTAVE_USE_WINDOWS_API more consistently
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
203 #if defined (OCTAVE_USE_WINDOWS_API)
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
204 std::wstring wfile = sys::u8_to_wstring (file);
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
205 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
206
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
207 // ShellExecute returns a value greater than 32 if successful.
29654
d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
208 return octave_value (reinterpret_cast<std::ptrdiff_t> (status) > 32);
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 #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
210 // Quote file path
28752
810eb29fc227 maint: Use C++ raw string literals to simplify backlsashing.
Rik <rik@octave.org>
parents: 28371
diff changeset
211 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
212
27143
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
213 # 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
214 # 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
215 # else
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
216 # 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
217 # endif
20961
f55251db0833 Add support for the Mac OS X "open" command.
Ben Abbott <bpabbott@mac.com>
parents: 20941
diff changeset
218 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
219 = 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
220 false, "async"),
f55251db0833 Add support for the Mac OS X "open" command.
Ben Abbott <bpabbott@mac.com>
parents: 20941
diff changeset
221 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
222 # undef FSYSTEM_OPEN_STR
19271
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
223
27143
64ff1053ffbf F__open_with_system_app__: Consistent return value for all platforms.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27126
diff changeset
224 // 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
225 // 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
226 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
227 #endif
19271
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
228 }
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents: 19270
diff changeset
229
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
230 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
231 doc: /* -*- texinfo -*-
28753
e82484e1b2f6 doc: grammarcheck documentation.
Rik <rik@octave.org>
parents: 28752
diff changeset
232 @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
233 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
234
28753
e82484e1b2f6 doc: grammarcheck documentation.
Rik <rik@octave.org>
parents: 28752
diff changeset
235 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
236 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
237 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
238 @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
239 {
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 #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
241 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
242 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
243
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 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
245 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
246
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 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
248 {
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 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
250 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
251 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
252 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
253 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
254 }
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 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
257 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
258
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 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
260
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 #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
262 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
263 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
264 "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
265 #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
266 }
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
28371
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
268 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
269 doc: /* -*- texinfo -*-
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
270 @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
271 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
272
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
273 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
274 @end deftypefn */)
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
275 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
276 #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
277 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
278 print_usage ();
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
279
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
280 // 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
281 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
282
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
283 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
284 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
285 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
286
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
287 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
288 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
289 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
290 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
291 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
292 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
293 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
294 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
295 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
296 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
297 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
298 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
299 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
300 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
301 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
302 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
303 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
304 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
305 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
306 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
307 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
308 }
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
309 else
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
310 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
311 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
312 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
313 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
314 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
315 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
316 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
317 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
318 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
319 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
320 }
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 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
323
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
324 // 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
325 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
326
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
327 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
328
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
329 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
330
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
331 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
332 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
333 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
334 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
335 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
336 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
337 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
338 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
339 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
340 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
341 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
342 }
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
343 else
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
344 {
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
345 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
346 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
347 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
348 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
349 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
350 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
351 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
352 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
353 }
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 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
356
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
357 #else
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
358 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
359 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
360 #endif
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
361 }
401599248e4d Add function to query memory information on Windows (patch #9924).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28261
diff changeset
362
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
363 #if defined (__MINGW32__)
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
364
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
365 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
366 MINGW_init (void)
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 w32_init ();
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
369 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
370
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
371 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
372
6080
40ab35ab651c [project @ 2006-10-25 03:26:36 by jwe]
jwe
parents: 5823
diff changeset
373 #if defined (_MSC_VER)
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
374
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
375 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
376 MSVC_init (void)
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 w32_init ();
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
379 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
380
6080
40ab35ab651c [project @ 2006-10-25 03:26:36 by jwe]
jwe
parents: 5823
diff changeset
381 #endif
40ab35ab651c [project @ 2006-10-25 03:26:36 by jwe]
jwe
parents: 5823
diff changeset
382
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
383 // 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
384
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
385 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
386 {
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21662
diff changeset
387 #if defined (OCTAVE_USE_WINDOWS_API)
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
388
27576
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
389 // 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
390 // 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
391
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
392 bool retval = false;
6691
c6ee6c342699 [project @ 2007-06-05 05:50:10 by jwe]
jwe
parents: 6677
diff changeset
393
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
394 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
395 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
396 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
397 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
398
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
399 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
400 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
401
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
402 // Windows native code
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
403 // 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
404
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
405 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
406
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
407 HANDLE hfile1
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
408 = 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
409 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
410
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
411 if (hfile1 != INVALID_HANDLE_VALUE)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
412 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
413 HANDLE hfile2
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
414 = 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
415 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
416
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
417 if (hfile2 != INVALID_HANDLE_VALUE)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
418 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
419 BY_HANDLE_FILE_INFORMATION hfi1;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
420 BY_HANDLE_FILE_INFORMATION hfi2;
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
421
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
422 if (GetFileInformationByHandle (hfile1, &hfi1)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
423 && GetFileInformationByHandle (hfile2, &hfi2))
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
424 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
425 retval = (hfi1.dwVolumeSerialNumber == hfi2.dwVolumeSerialNumber
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
426 && 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
427 && 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
428 && 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
429 && 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
430 && hfi1.ftLastWriteTime.dwLowDateTime
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
431 == hfi2.ftLastWriteTime.dwLowDateTime
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
432 && hfi1.ftLastWriteTime.dwHighDateTime
3b50efa29be4 improve file equaliy check for MS Windows (bug #55161).
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 27420
diff changeset
433 == hfi2.ftLastWriteTime.dwHighDateTime);
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
434 }
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
435
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
436 CloseHandle (hfile2);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
437 }
6691
c6ee6c342699 [project @ 2007-06-05 05:50:10 by jwe]
jwe
parents: 6677
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 (hfile1);
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 return retval;
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
443
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
444 #else
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
445
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
446 // POSIX Code
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
447
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
448 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
449 sys::file_stat fs_file2 (file2);
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
450
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
451 return (fs_file1 && fs_file2
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
452 && 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
453 && fs_file1.dev () == fs_file2.dev ());
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
454
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
455 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
456 }
6598
ce819776ee76 [project @ 2007-04-27 17:34:27 by jwe]
jwe
parents: 6423
diff changeset
457
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
458 // 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
459
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
460 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
461 {
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
462 #if defined (OCTAVE_USE_WINDOWS_API)
29654
d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
463 std::size_t len = name.length ();
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
464 bool candidate = false;
26995
ab5bfee22d18 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26844
diff changeset
465 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
466 && (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
467 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
468 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
469 {
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 // It starts with two slashes. Find the next slash.
29572
aef11bb4e6d1 use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents: 29492
diff changeset
471 std::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
472 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
473 {
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
474 // Check if it ends with the share
29572
aef11bb4e6d1 use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents: 29492
diff changeset
475 std::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
476 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
477 || (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
478 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
479 }
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
480 }
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
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 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
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 // 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
485 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
486 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
487 = 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
488 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
489 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
490 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
491 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
492 {
f07542e3a9b9 Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents: 26617
diff changeset
493 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
494 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
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 }
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
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 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
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 #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
501
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 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
503
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 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
505
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 #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
507 }
26995
ab5bfee22d18 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26844
diff changeset
508
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
509 void sysdep_init (void)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
510 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
511 // 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
512 // 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
513 // 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
514 #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
515 omp_get_num_threads ();
21554
9f0088f3f335 call openmp function at initialization (bug #47372)
John W. Eaton <jwe@octave.org>
parents: 20788
diff changeset
516 #endif
9f0088f3f335 call openmp function at initialization (bug #47372)
John W. Eaton <jwe@octave.org>
parents: 20788
diff changeset
517
14861
f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory
Rik <octave@nomad.inbox5.com>
parents: 14445
diff changeset
518 #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
519 BSD_init ();
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
520 #elif defined (__MINGW32__)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
521 MINGW_init ();
6080
40ab35ab651c [project @ 2006-10-25 03:26:36 by jwe]
jwe
parents: 5823
diff changeset
522 #elif defined (_MSC_VER)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
523 MSVC_init ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
524 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
525 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
526
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
527 void sysdep_cleanup (void)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
528 {
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
529 #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
530 // 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
531 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
532 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
533 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents: 5395
diff changeset
534
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
535 // 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
536 //
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
537 // 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
538 // "Raw mode" means
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
539 // 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
540 // 2. Input is not echoed.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
541 // 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
542 // 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
543 // 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
544 // etc. are NOT disabled.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
545 // 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
546
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
547 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
548 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
549 static bool curr_on = false;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
550
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
551 int tty_fd = STDIN_FILENO;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
552 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
553 {
31105
670a0d878af1 eliminate WHO arguments from interpreter-private functions
John W. Eaton <jwe@octave.org>
parents: 30888
diff changeset
554 interpreter& interp = __get_interpreter__ ();
27301
a2b1ba6c92d5 eliminate unnecessary application::interative function
John W. Eaton <jwe@octave.org>
parents: 27277
diff changeset
555
a2b1ba6c92d5 eliminate unnecessary application::interative function
John W. Eaton <jwe@octave.org>
parents: 27277
diff changeset
556 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
557 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
558 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
559
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
560 if (on == curr_on)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
561 return;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
562
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
563 #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
564 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
565 struct termios s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
566 static struct termios save_term;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
567
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
568 if (on)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
569 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
570 // Get terminal modes.
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
571
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
572 tcgetattr (tty_fd, &s);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
573
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
574 // 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
575
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
576 save_term = s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
577 // ospeed = s.c_cflag & CBAUD;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
578 // 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
579 // kill_char = s.c_cc[VKILL];
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
580
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
581 // 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
582
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
583 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
584 s.c_oflag |= (OPOST | ONLCR);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
585 #if defined (OCRNL)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
586 s.c_oflag &= ~(OCRNL);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
587 #endif
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
588 #if defined (ONOCR)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
589 s.c_oflag &= ~(ONOCR);
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 (ONLRET)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
592 s.c_oflag &= ~(ONLRET);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
593 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
594 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
595 s.c_cc[VTIME] = 0;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
596 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
597 else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
598 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
599 // Restore saved modes.
1358
dc9c01f66a19 [project @ 1995-09-05 21:10:01 by jwe]
jwe
parents: 1352
diff changeset
600
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
601 s = save_term;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
602 }
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
diff changeset
603
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
604 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
605 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
606 #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
607 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
608 struct termio s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
609 static struct termio save_term;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
610
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
611 if (on)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
612 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
613 // Get terminal modes.
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
614
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
615 ioctl (tty_fd, TCGETA, &s);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
616
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
617 // 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
618
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
619 save_term = s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
620 // ospeed = s.c_cflag & CBAUD;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
621 // 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
622 // kill_char = s.c_cc[VKILL];
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
623
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
624 // 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
625
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
626 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
627 s.c_oflag |= (OPOST | ONLCR);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
628 #if defined (OCRNL)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
629 s.c_oflag &= ~(OCRNL);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
630 #endif
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
631 #if defined (ONOCR)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
632 s.c_oflag &= ~(ONOCR);
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 (ONLRET)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
635 s.c_oflag &= ~(ONLRET);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
636 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
637 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
638 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
639 else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
640 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
641 // Restore saved modes.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
642
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
643 s = save_term;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
644 }
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 ioctl (tty_fd, TCSETAW, &s);
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 #elif defined (HAVE_SGTTY_H)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
649 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
650 octave_unused_parameter (wait);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
651
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
652 struct sgttyb s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
653 static struct sgttyb save_term;
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 if (on)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
656 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
657 // Get terminal modes.
1358
dc9c01f66a19 [project @ 1995-09-05 21:10:01 by jwe]
jwe
parents: 1352
diff changeset
658
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
659 ioctl (tty_fd, TIOCGETP, &s);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
660
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
661 // 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
662
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
663 save_term = s;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
664 // ospeed = s.sg_ospeed;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
665 // erase_char = s.sg_erase;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
666 // kill_char = s.sg_kill;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
667
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
668 // 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
669
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
670 s.sg_flags |= CBREAK;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
671 s.sg_flags &= ~(ECHO);
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
672 }
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
673 else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
674 {
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
675 // Restore saved modes.
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
676
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
677 s = save_term;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
678 }
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 ioctl (tty_fd, TIOCSETN, &s);
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 #else
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
683
24118
f87c9f5c0f43 maint: silence several compiler warnings when building for Windows
Mike Miller <mtmiller@octave.org>
parents: 23812
diff changeset
684 octave_unused_parameter (wait);
f87c9f5c0f43 maint: silence several compiler warnings when building for Windows
Mike Miller <mtmiller@octave.org>
parents: 23812
diff changeset
685
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
686 warn_disabled_feature ("", "raw mode console I/O");
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
687
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
688 // 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
689 on = curr_on;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
690 #endif
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
691
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
692 curr_on = on;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
693 }
529
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 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
696 {
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
697 #if defined (__MINGW32__) || defined (_MSC_VER)
29950
6549fa7558ba eliminate some unnecessary octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents: 29655
diff changeset
698 std::wstring wcommand = sys::u8_to_wstring (command);
6549fa7558ba eliminate some unnecessary octave:: namespace tags
John W. Eaton <jwe@octave.org>
parents: 29655
diff changeset
699 std::wstring wmode = sys::u8_to_wstring (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
700
29492
be4b78fb4411 Replace Unicode conversion functions from gnulib with STL functions.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29359
diff changeset
701 // Use binary mode on Windows if unspecified
be4b78fb4411 Replace Unicode conversion functions from gnulib with STL functions.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29359
diff changeset
702 if (wmode.length () < 2)
be4b78fb4411 Replace Unicode conversion functions from gnulib with STL functions.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29359
diff changeset
703 wmode += L'b';
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
704
29492
be4b78fb4411 Replace Unicode conversion functions from gnulib with STL functions.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29359
diff changeset
705 return _wpopen (wcommand.c_str (), wmode.c_str ());
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
706 #else
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
707 return ::popen (command, mode);
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
708 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
709 }
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
710
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
711 int pclose (FILE *f)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
712 {
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
713 #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
714 return ::_pclose (f);
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
715 #else
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
716 return ::pclose (f);
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
717 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
718 }
6726
6b7ba4a31876 [project @ 2007-06-14 20:16:44 by jwe]
jwe
parents: 6691
diff changeset
719
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
720 // Read one character from the terminal.
767
42731861ee09 [project @ 1994-10-05 21:26:54 by jwe]
jwe
parents: 712
diff changeset
721
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
722 int kbhit (bool wait)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
723 {
20788
a2b96b523472 Rewrite a8ee668e7fd7 to use #if defined rather than #ifdef.
Rik <rik@octave.org>
parents: 20786
diff changeset
724 #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
725 // 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
726
7894624afc47 Fix pause() with no arguments called on Windows (bug #55943)
Mike Miller <mtmiller@octave.org>
parents: 27011
diff changeset
727 // 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
728 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
729
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
730 int c;
20786
a8ee668e7fd7 Fix kbhit and pause on Windows systems.
Rik <rik@octave.org>
parents: 20181
diff changeset
731
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
732 if (wait)
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
733 c = _getch ();
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
734 else
27045
7894624afc47 Fix pause() with no arguments called on Windows (bug #55943)
Mike Miller <mtmiller@octave.org>
parents: 27011
diff changeset
735 c = (! _kbhit ()) ? eof : _getch ();
20786
a8ee668e7fd7 Fix kbhit and pause on Windows systems.
Rik <rik@octave.org>
parents: 20181
diff changeset
736
4067
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 4064
diff changeset
737 #else
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
738 raw_mode (true, wait);
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
diff changeset
739
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
740 // Get current handler.
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
741 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
742 = ignore_interrupts ();
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
743
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
744 // 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
745 // read can be interrupted.
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
746
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
747 set_interrupt_handler (saved_interrupt_handler, false);
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
748
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
749 int c = std::cin.get ();
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11572
diff changeset
750
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
751 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
752 {
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
753 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
754 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
755 }
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
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, 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
758 set_interrupt_handler (saved_interrupt_handler, true);
5770
6a9244f89a2a [project @ 2006-04-18 17:44:33 by jwe]
jwe
parents: 5455
diff changeset
759
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
760 raw_mode (false, true);
4067
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 4064
diff changeset
761 #endif
3658
808f399398c9 [project @ 2000-04-11 19:45:44 by jwe]
jwe
parents: 3657
diff changeset
762
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
763 return c;
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
764 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
765
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
766 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
767 {
21979
d04da18a407a use OCTAVE_USE_WINDOWS_API more consistently
John W. Eaton <jwe@octave.org>
parents: 21966
diff changeset
768 #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
769
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
770 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
771
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
772 #if defined (P_tmpdir)
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
773 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
774 #endif
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
775
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
776 // 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
777 // 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
778 // 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
779
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
780 if (retval.empty () || retval == R"(\)")
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
781 {
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
782 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
783
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
784 if (retval.empty ())
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
785 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
786
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
787 if (retval.empty ())
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
788 retval = R"(c:\temp)";
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
789 }
12228
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
790
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
791 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
792
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
793 #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
794
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
795 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
796
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
797 #else
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
798
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
799 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
800
0f70c5db58c3 try to get better value than \ for P_tmpdir on Windows systems
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
801 #endif
25649
85c3e315bd43 move libinterp/corefcn/sysdep functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 25646
diff changeset
802 }
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29950
diff changeset
803
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
804 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
805 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
806 @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
807 @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
808 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
809 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
810 {
16537
106a38d7b396 optionall disable redisplay in command editor clear screen function
John W. Eaton <jwe@octave.org>
parents: 16404
diff changeset
811 bool skip_redisplay = true;
106a38d7b396 optionall disable redisplay in command editor clear screen function
John W. Eaton <jwe@octave.org>
parents: 16404
diff changeset
812
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
813 command_editor::clear_screen (skip_redisplay);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
814
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
815 return ovl ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
816 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
817
549
75a371805554 [project @ 1994-07-22 19:44:41 by jwe]
jwe
parents: 545
diff changeset
818 DEFALIAS (home, clc);
75a371805554 [project @ 1994-07-22 19:44:41 by jwe]
jwe
parents: 545
diff changeset
819
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
820 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
821 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
822 @deftypefn {} {@var{val} =} getenv ("@var{var}")
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
823 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
824
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
825 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
826
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
827 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
828 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
829 @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
830
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
831 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
832 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
833 @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
834 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
835 {
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20799
diff changeset
836 if (args.length () != 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
837 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
838
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
839 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
840
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
841 return ovl (sys::env::getenv (name));
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
842 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
843
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
844 /*
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
845 %!assert (ischar (getenv ("OCTAVE_HOME")))
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
846 */
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
847
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
848 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
849 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
850 @deftypefn {} {} setenv ("@var{var}", @var{value})
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
851 @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
852 @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
853 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
854
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
855 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
856 string.
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
857
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
858 Programming Note: @code{putenv} is an alias for @code{setenv} and can be used
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
859 interchangeably.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
860 @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
861 @end deftypefn */)
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
862 {
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
863 int nargin = args.length ();
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
864
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
865 if (nargin < 1 || nargin > 2)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
866 print_usage ();
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
867
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
868 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
869
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
870 std::string val = (nargin == 2
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
871 ? 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
872 : "");
20582
ba2b07c13913 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20555
diff changeset
873
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
874 sys::env::putenv (var, val);
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
875
21078
49852ff04747 maint: Remove unnecessary declarations of retval.
Rik <rik@octave.org>
parents: 21017
diff changeset
876 return ovl ();
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
877 }
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
878
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
879 DEFALIAS (putenv, setenv);
1706
6bb0c67bbf24 [project @ 1996-01-07 05:40:05 by jwe]
jwe
parents: 1670
diff changeset
880
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
881 /*
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
882 %!test
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
883 %! 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
884 %! 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
885 %! unsetenv ("dummy_variable_that_cannot_matter");
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
886 %! assert (getenv ("dummy_variable_that_cannot_matter"), "");
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
887 */
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
888
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
889 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
890 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
891 @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
892 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
893
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
894 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
895 occurred.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
896 @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
897 @end deftypefn */)
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
898 {
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20799
diff changeset
899 if (args.length () != 1)
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
900 print_usage ();
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
901
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
902 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
903
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
904 return ovl (sys::unsetenv_wrapper (tmp));
19167
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
905 }
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
906
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
907 /*
6f0290863d50 Add new function unsetenv from gnulib to Octave.
Rik <rik@octave.org>
parents: 18674
diff changeset
908 ## 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
909 */
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
910
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
911 #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
912
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
913 static void
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
914 reg_close_key_wrapper (HKEY key)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
915 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
916 RegCloseKey (key);
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
917 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
918
27126
3d9e72cac668 allow Windows build to work again
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
919 // 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
920 // 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
921
3d9e72cac668 allow Windows build to work again
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
922 LONG
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
923 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
924 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
925 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
926 LONG result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
927 HKEY h_subkey;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
928
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
929 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
930 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
931 &h_subkey);
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
932
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
933 if (result != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
934 return result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
935
28857
43ad651cf5a0 eliminate unnecessary uses of octave:: namespace qualifier
John W. Eaton <jwe@octave.org>
parents: 28851
diff changeset
936 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
937
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
938 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
939 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
940 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
941 nullptr, &length);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
942 if (result != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
943 return result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
944
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
945 DWORD type = 0;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
946 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
947 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
948 data, &length);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
949 if (result != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
950 return result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
951
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
952 if (type == REG_DWORD)
27421
edeacebc8800 maint: merge stable to default.
Rik <rik@octave.org>
parents: 27346 27420
diff changeset
953 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
954 else if (type == REG_SZ || type == REG_EXPAND_SZ)
30265
3c60814448ea winqueryreg: Strings in Windows registry might not be zero terminated.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29961
diff changeset
955 {
3c60814448ea winqueryreg: Strings in Windows registry might not be zero terminated.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29961
diff changeset
956 // strings in registry might not be zero terminated
30631
51770116f835 winqueryreg: Don't include terminating zero in string.
Markus Mützel <markus.muetzel@gmx.de>
parents: 30564
diff changeset
957 wchar_t *dataw = reinterpret_cast<wchar_t *> (data);
51770116f835 winqueryreg: Don't include terminating zero in string.
Markus Mützel <markus.muetzel@gmx.de>
parents: 30564
diff changeset
958 DWORD lengthw = length / sizeof (wchar_t);
30265
3c60814448ea winqueryreg: Strings in Windows registry might not be zero terminated.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29961
diff changeset
959 std::wstring reg_string
30631
51770116f835 winqueryreg: Don't include terminating zero in string.
Markus Mützel <markus.muetzel@gmx.de>
parents: 30564
diff changeset
960 = std::wstring (dataw, lengthw - (dataw[lengthw-1]==0));
30265
3c60814448ea winqueryreg: Strings in Windows registry might not be zero terminated.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29961
diff changeset
961 value = string_vector (sys::u8_from_wstring (reg_string));
3c60814448ea winqueryreg: Strings in Windows registry might not be zero terminated.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29961
diff changeset
962 }
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
963
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
964 return result;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
965 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
966
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
967 static LONG
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
968 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
969 std::list<std::string> &fields)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
970 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
971 LONG retval;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
972 HKEY h_subkey;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
973
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
974 fields.clear ();
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
975
28175
b895daca20e2 Avoid potential lifetime issues with temporary std::wstring objects.
Markus Mützel <markus.muetzel@gmx.de>
parents: 27932
diff changeset
976 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
977 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
978 &h_subkey);
27101
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
979 if (retval != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
980 return retval;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
981
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
982 DWORD idx = 0;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
983 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
984 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
985 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
986
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
987 while (true)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
988 {
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
989 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
990 nullptr, nullptr, nullptr, nullptr);
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
991 if (retval != ERROR_SUCCESS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
992 break;
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27101
diff changeset
993 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
994 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
995 idx++;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
996 }
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
997
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
998 if (retval == ERROR_NO_MORE_ITEMS)
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
999 retval = ERROR_SUCCESS;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1000
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1001 RegCloseKey (h_subkey);
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 return retval;
097774bed4ed move some static functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27046
diff changeset
1004 }
24710
a979bb895b64 avoid reinterpret_cast on function pointer in previous change
John W. Eaton <jwe@octave.org>
parents: 24709
diff changeset
1005
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1006 #endif
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1007
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1008 DEFUN (winqueryreg, args, ,
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1009 doc: /* -*- texinfo -*-
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1010 @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
1011 @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
1012 @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
1013
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1014 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
1015
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1016 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
1017 @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
1018 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
1019 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
1020 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
1021 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
1022 @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
1023 returned.
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1024
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1025 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
1026 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
1027
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1028 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
1029
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1030 @table @asis
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1031 @item @nospell{HKCR}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1032 @itemx @nospell{HKEY_CLASSES_ROOT}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1033
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1034 @item @nospell{HKEY_CURRENT_CONFIG}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1035
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1036 @item @nospell{HKCU}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1037 @itemx @nospell{HKEY_CURRENT_USER}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1038
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1039 @item @nospell{HKLM}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1040 @itemx @nospell{HKEY_LOCAL_MACHINE}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1041
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{HKU}
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1044 @itemx @nospell{HKEY_USERS}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1045
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1046
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24720
diff changeset
1047 @item @nospell{HKEY_PERFORMANCE_DATA}
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1048
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1049 @end table
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1050
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1051 Examples:
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1052
29117
10a35049bad7 doc: Cleanup Texinfo macros use in documentation.
Rik <rik@octave.org>
parents: 28930
diff changeset
1053 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
1054 @nospell{@qcode{'HKCU@backslashchar{}Environment'}}:
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 @example
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1057 @group
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1058 @var{valuenames} = winqueryreg ("name", "HKEY_CURRENT_USER", ...
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1059 "Environment");
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1060 @end group
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1061 @end example
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1062
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1063 For each @var{valuenames}, display the value:
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1064
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1065 @example
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1066 @group
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1067 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
1068 @var{val} = winqueryreg ("HKEY_CURRENT_USER", "Environment", ...
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1069 @var{valuenames}@{@var{k}@});
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1070 @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
1071 disp (@var{str});
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1072 endfor
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1073 @end group
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1074 @end example
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1075
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1076 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
1077 @end deftypefn */)
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1078 {
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1079 #if defined (OCTAVE_USE_WINDOWS_API)
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1080 if ((args.length () < 2) || (args.length () > 3))
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1081 print_usage ();
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1082
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1083 // 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
1084 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
1085 = 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
1086 "or a valid ROOTKEY identifier");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1087 std::string subkey_name = "";
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1088 std::string value_name = "";
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1089 bool get_names = false;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1090 if (rootkey_name.compare ("name") == 0)
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1091 {
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1092 if (args.length () < 3)
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1093 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
1094 "ROOTKEY and SUBKEY must be given");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1095 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
1096 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
1097 = 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
1098 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
1099 = 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
1100 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1101 else
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1102 {
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 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
1104 = 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
1105
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1106 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
1107 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
1108 = 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
1109 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1110
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1111 // Get rootkey handle
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1112 HKEY h_rootkey;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1113 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
1114 h_rootkey = HKEY_CLASSES_ROOT;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1115 else if (rootkey_name == "HKEY_CURRENT_CONFIG")
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1116 h_rootkey = HKEY_CURRENT_CONFIG;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1117 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
1118 h_rootkey = HKEY_CURRENT_USER;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1119 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
1120 h_rootkey = HKEY_LOCAL_MACHINE;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1121 else if (rootkey_name == "HKEY_PERFORMANCE_DATA")
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1122 h_rootkey = HKEY_PERFORMANCE_DATA;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1123 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
1124 h_rootkey = HKEY_USERS;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1125 else
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1126 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
1127
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1128 if (get_names)
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1129 {
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1130 std::list<std::string> fields;
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1131
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1132 LONG retval = 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
1133 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
1134 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
1135
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1136 Cell fieldnames (dim_vector (1, fields.size ()));
29654
d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
1137 std::size_t i;
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1138 std::list<std::string>::const_iterator it;
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1139 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
1140 fieldnames(i) = *it;
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1141
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1142 return ovl (fieldnames);
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1143 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1144 else
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1145 {
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1146 octave_value key_val;
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1147 LONG retval = get_regkey_value (h_rootkey, subkey_name,
30390
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release.
Rik <rik@octave.org>
parents: 30265
diff changeset
1148 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
1149 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
1150 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
1151 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
1152 subkey_name.c_str ());
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1153 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
1154 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
1155
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1156 return ovl (key_val);
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1157 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1158 #else
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1159
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1160 octave_unused_parameter (args);
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1161
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1162 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
1163
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1164 #endif
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1165 }
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1166
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1167 /*
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1168 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1169 %! assert (ischar (winqueryreg ("HKEY_LOCAL_MACHINE",
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1170 %! 'SOFTWARE\Microsoft\Windows\CurrentVersion',
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1171 %! "ProgramFilesDir")));
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1172 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1173 %! assert (isa (winqueryreg ("HKEY_LOCAL_MACHINE",
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1174 %! 'SYSTEM\CurrentControlSet\Control\FileSystem',
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1175 %! "Win31FileSystem"), "int32"));
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1176 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1177 %! assert (iscellstr (winqueryreg ("name", "HKEY_LOCAL_MACHINE",
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1178 %! 'SOFTWARE\Microsoft\Windows\CurrentVersion')));
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1179 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1180 %! fail ('winqueryreg (1, ''SOFTWARE\Microsoft\Windows\CurrentVersion'')',
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1181 %! "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
1182 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1183 %! 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
1184 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1185 %! fail (['winqueryreg ("HKEY_LOCAL_MACHINE", ', ...
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1186 %! '''SOFTWARE\Microsoft\Windows\CurrentVersion'', 1)'],
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1187 %! "VALUENAME must be a string");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1188 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1189 %! fail (['winqueryreg ("FOO", ', ...
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1190 %! '''SOFTWARE\Microsoft\Windows\CurrentVersion'')'],
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1191 %! "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
1192 %!testif ; ispc ()
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1193 %! 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
1194 %! "no value found for");
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 ("HKEY_LOCAL_MACHINE", ', ...
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1197 %! '''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
1198 %! "no value found for");
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 ("name", "HKEY_LOCAL_MACHINE")',
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1201 %! "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
1202 %!testif ; ispc ()
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1203 %! fail (['winqueryreg ("name", 1, ', ...
24665
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1204 %! '''SOFTWARE\Microsoft\Windows\CurrentVersion'')'],
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1205 %! "ROOTKEY must be a string");
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", 1)',
4a9793818fca Use Octave coding conventions in cset a829062fdea4.
Rik <rik@octave.org>
parents: 24664
diff changeset
1208 %! "SUBKEY must be a string");
24664
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1209 */
a829062fdea4 Add function "winqueryreg" (bug #52935).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24534
diff changeset
1210
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1211 // 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
1212
27335
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1213 DEFMETHOD (kbhit, interp, args, ,
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1214 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1215 @deftypefn {} {@var{c} =} kbhit ()
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1216 @deftypefnx {} {@var{c} =} kbhit (1)
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1217 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
1218
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1219 If called with an argument (typically 1), don't wait for a keypress and
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1220 immediately return the next keystroke in the keyboard input buffer or an empty
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1221 string ("") if no keystroke is available.
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
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1223 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
1224
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1225 @example
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1226 c = kbhit ();
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1227 @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
1228
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1229 @noindent
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1230 will set @var{c} to the next character typed at the keyboard as soon as it is
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1231 typed.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1232
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1233 @example
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1234 c = kbhit (1);
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1235 @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
1236
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1237 @noindent
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1238 is identical to the above example, but doesn't wait for a keypress, returning
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1239 the empty string if no key is available.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1240 @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
1241 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1242 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1243 // FIXME: add timeout and default value args?
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1244
27335
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1245 Fdrawnow (interp);
6423
a90b54016b12 [project @ 2007-03-21 13:15:03 by jwe]
jwe
parents: 6419
diff changeset
1246
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1247 int c = kbhit (args.length () == 0);
3657
a908150a3a32 [project @ 2000-04-11 19:02:03 by jwe]
jwe
parents: 3531
diff changeset
1248
25311
10ec5795bd06 allow kbhit to work in command-line scripts (bug #53412)
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
1249 if (c == -1)
10ec5795bd06 allow kbhit to work in command-line scripts (bug #53412)
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
1250 c = 0;
16015
d910b9211cca Plug memory leak in kbhit().
Rik <rik@octave.org>
parents: 15423
diff changeset
1251
25311
10ec5795bd06 allow kbhit to work in command-line scripts (bug #53412)
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
1252 char s[2] = { static_cast<char> (c), '\0' };
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
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 return octave_value (s);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1255 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1256
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1257 // State of the pause system
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1258 static bool Vpause_enabled = true;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1259
27335
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1260 DEFMETHOD (pause, interp, args, nargout,
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1261 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
1262 @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
1263 @deftypefnx {} {} pause (@var{n})
26046
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1264 @deftypefnx {} {@var{old_state} =} pause ("on")
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1265 @deftypefnx {} {@var{old_state} =} pause ("off")
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1266 @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
1267 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
1268
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1269 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
1270 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
1271 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
1272
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1273 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1274 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1275 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
1276 @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
1277 @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
1278 @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
1279
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1280 The following example prints a message and then waits 5 seconds before clearing
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1281 the screen.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1282
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1283 @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 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1285 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
1286 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
1287 clc;
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1288 @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
1289 @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
1290
26046
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1291 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
1292 @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
1293 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
1294 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
1295 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
1296
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1297 @example
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1298 @group
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1299 old_state = pause ("off");
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1300 tic; pause (0.05); toc
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1301 @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
1302 pause (old_state);
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1303 @end group
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1304 @end example
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1305
26046
ff0aa19333c9 doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents: 26026
diff changeset
1306 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
1307 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
1308
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1309 @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
1310 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1311 {
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1312 octave_value_list retval;
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1313
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1314 int nargin = args.length ();
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1315
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
1316 if (nargin > 1)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
1317 print_usage ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 505
diff changeset
1318
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1319 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
1320 {
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1321 bool saved_state = Vpause_enabled;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1322 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
1323
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1324 if (state == "on")
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1325 Vpause_enabled = true;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1326 else if (state == "off")
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1327 Vpause_enabled = false;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1328 else if (state == "query")
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1329 ;// Do nothing
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1330 else
28752
810eb29fc227 maint: Use C++ raw string literals to simplify backlsashing.
Rik <rik@octave.org>
parents: 28371
diff changeset
1331 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
1332
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1333 if (nargout > 0 || state == "query")
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1334 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
1335 }
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1336 else if (Vpause_enabled)
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1337 {
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1338 double dval;
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1339
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1340 if (nargin == 0)
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1341 dval = octave_Inf;
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1342 else
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1343 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
1344
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1345 if (math::isnan (dval))
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1346 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
1347 else
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1348 {
27335
50216d7a2f6b eliminate static wrapper functions in gh_manager class
John W. Eaton <jwe@octave.org>
parents: 27301
diff changeset
1349 Fdrawnow (interp);
26617
98afb8bbd1f6 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1350
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1351 sleep (dval, true);
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1352 }
3234
be8e0ba13644 [project @ 1999-01-29 03:52:30 by jwe]
jwe
parents: 3124
diff changeset
1353 }
26026
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1354
511295347a27 Allow pause state to be changed (bug #53723)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25961
diff changeset
1355 return retval;
2630
fdee6fe3e73b [project @ 1997-01-27 19:08:47 by jwe]
jwe
parents: 2610
diff changeset
1356 }
fdee6fe3e73b [project @ 1997-01-27 19:08:47 by jwe]
jwe
parents: 2610
diff changeset
1357
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1358 /*
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1359 %!test
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1360 %! pause (1);
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14160
diff changeset
1361
28930
2883b3d08b7e maint: Remove unnecessary parentheses bracketing %!error BIST tests.
Rik <rik@octave.org>
parents: 28905
diff changeset
1362 %!error pause (1, 2)
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
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1365 // 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
1366 // point functions really work.
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1367
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
1368 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
1369 doc: /* -*- texinfo -*-
30559
841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory.
Rik <rik@octave.org>
parents: 30390
diff changeset
1370 @deftypefn {} {@var{tf} =} 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
1371 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
1372 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
1373
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1374 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
1375 @end deftypefn */)
862
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1376 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1377 mach_info::float_format flt_fmt = mach_info::native_float_format ();
2317
8c09c04f7747 [project @ 1996-07-14 22:30:15 by jwe]
jwe
parents: 2086
diff changeset
1378
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1379 return ovl (flt_fmt == mach_info::flt_fmt_ieee_little_endian
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1380 || flt_fmt == mach_info::flt_fmt_ieee_big_endian);
862
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1381 }
61d83ce7368c [project @ 1994-10-31 20:39:30 by jwe]
jwe
parents: 844
diff changeset
1382
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1383 /*
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14160
diff changeset
1384 %!assert (islogical (isieee ()))
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1385 */
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1386
4600
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1387 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
1388 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1389 @deftypefn {} {@var{fmtstr} =} 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
1390 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
1391 @end deftypefn */)
4600
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1392 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1393 mach_info::float_format flt_fmt = mach_info::native_float_format ();
4600
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1394
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1395 return ovl (mach_info::float_format_as_string (flt_fmt));
4600
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1396 }
3680bb30de0b [project @ 2003-11-12 18:25:53 by jwe]
jwe
parents: 4574
diff changeset
1397
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1398 /*
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14160
diff changeset
1399 %!assert (ischar (native_float_format ()))
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1400 */
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1401
1957
0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe]
jwe
parents: 1884
diff changeset
1402 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
1403 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1404 @deftypefn {} {@var{newstr} =} tilde_expand (@var{string})
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1405 @deftypefnx {} {@var{newcstr} =} tilde_expand (@var{cellstr})
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1406 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
1407
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1408 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
1409 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
1410 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
1411 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
1412 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
1413 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
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 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
1416 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
1417
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1418 Examples:
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1419
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1420 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1421 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1422 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
1423 @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
1424 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
1425 @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
1426 @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
1427 @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
1428 @end deftypefn */)
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
1429 {
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20799
diff changeset
1430 if (args.length () != 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5775
diff changeset
1431 print_usage ();
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
1432
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20789
diff changeset
1433 octave_value arg = args(0);
6116
b64fb24bf4a0 [project @ 2006-10-27 18:04:49 by jwe]
jwe
parents: 6086
diff changeset
1434
20990
fc9cca99b2de Deprecate all_strings, replace with string_vector_value.
Rik <rik@octave.org>
parents: 20961
diff changeset
1435 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
1436
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1437 sv = 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
1438
23575
e95738a119da maint: Deprecate is_cellstr and replace with iscellstr.
Rik <rik@octave.org>
parents: 23459
diff changeset
1439 if (arg.iscellstr ())
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20923
diff changeset
1440 return ovl (Cell (arg.dims (), sv));
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
1441 else
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20923
diff changeset
1442 return ovl (sv);
1750
fd0d12493223 [project @ 1996-01-13 09:31:07 by jwe]
jwe
parents: 1742
diff changeset
1443 }
12825
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1444
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1445 /*
a1dcb854a4f9 codesprint: new tests for sysdep.cc functions
John W. Eaton <jwe@octave.org>
parents: 12483
diff changeset
1446 %!test
20016
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1447 %! 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
1448 %! 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
1449 %! 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
1450 %! 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
1451 */
17851
af685269e06c avoid symbol conflicts in display.cc
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
1452
20016
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1453 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
1454 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
1455 @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
1456 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
1457
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21949
diff changeset
1458 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
1459 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
1460 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
1461 @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
1462 @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
1463 @end deftypefn */)
20016
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1464 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1465 return ovl (sys::env::get_home_directory ());
20016
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1466 }
47d420d769ba * sysdep.cc (Fget_home_directory): New function.
John W. Eaton <jwe@octave.org>
parents: 19861
diff changeset
1467
20024
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1468 /*
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1469 %!test
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1470 %! if (! ispc ())
20181
aa36fb998a4d maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents: 20172
diff changeset
1471 %! 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
1472 %! endif
cf9b94a89620 Document get_home_directory in Octave manual and NEWS file.
Rik <rik@octave.org>
parents: 20016
diff changeset
1473 */
24714
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1474
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1475 DEFUN (__blas_version__, , ,
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1476 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1477 @deftypefn {} {@var{verstr} =} __blas_version__ ()
24714
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1478 Undocumented internal function.
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1479 @end deftypefn */)
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1480 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1481 return ovl (sys::blas_version ());
24714
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1482 }
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1483
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1484 DEFUN (__lapack_version__, , ,
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1485 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30632
diff changeset
1486 @deftypefn {} {@var{verstr} =} __lapack_version__ ()
24714
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1487 Undocumented internal function.
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1488 @end deftypefn */)
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1489 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29960
diff changeset
1490 return ovl (sys::lapack_version ());
24714
d2c727a438ab Add "-blas" and "-lapack" options to "version" (bug #45659).
Markus Mützel <markus.muetzel@gmx.de>
parents: 24710
diff changeset
1491 }
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29950
diff changeset
1492
31605
e88a07dec498 maint: Use macros to begin/end C++ namespaces.
Rik <rik@octave.org>
parents: 31105
diff changeset
1493 OCTAVE_END_NAMESPACE(octave)