octave: libinterp/corefcn/utils.h annotate

annotate libinterp/corefcn/utils.h @ 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	c9788d7f6e65
children	aac27ad79be6

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: 29960 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
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_utils_h)
383 0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe] jwe parents: 339 diff changeset	27 #define octave_utils_h 1
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20925 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20925 diff changeset	30
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3523 diff changeset	31 #include <cstdarg>
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3523 diff changeset	32
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	33 #include <iosfwd>
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1738 diff changeset	34 #include <string>
10033 f349847c4541 optimize cellfun (@subsref, args, {subs}, uniformoutput, true) case Jaroslav Hajek <highegg@gmail.com> parents: 9705 diff changeset	35 #include <list>
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1738 diff changeset	36
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 4302 diff changeset	37 #include "dMatrix.h"
1966 4b8e9571bbdf [project @ 1996-02-17 02:52:04 by jwe] jwe parents: 1884 diff changeset	38 #include "lo-utils.h"
4b8e9571bbdf [project @ 1996-02-17 02:52:04 by jwe] jwe parents: 1884 diff changeset	39
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3350 diff changeset	40 class octave_value;
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 2042 diff changeset	41 class octave_value_list;
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1738 diff changeset	42 class string_vector;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	43
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30896 diff changeset	44 OCTAVE_BEGIN_NAMESPACE(octave)
29960 939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	45
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	46 extern OCTINTERP_API bool valid_identifier (const char *s);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	47 extern OCTINTERP_API bool valid_identifier (const std::string& s);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	48
29091 b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	49 //! Helper class for `make_valid_name` function calls.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	50 //!
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	51 //! Extracting options separately for multiple (e.g. 1000+) function calls
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	52 //! avoids expensive repetitive parsing of the very same options.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	53
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	54 class
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	55 OCTINTERP_API
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	56 make_valid_name_options
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	57 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	58 public:
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	59
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	60 //! Default options for `make_valid_name` function calls.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	61 //!
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	62 //! Calling the constructor without arguments is equivalent to:
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	63 //!
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	64 //! @code{.cc}
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	65 //! make_valid_name_options (ovl ("ReplacementStyle", "underscore",
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	66 //! "Prefix", "x"));
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	67 //! @endcode
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	68
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	69 make_valid_name_options () = default;
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	70
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	71 //! Extract attribute-value-pairs from an octave_value_list of strings.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	72 //!
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	73 //! If attributes occur multiple times, the rightmost pair is chosen.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	74 //!
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	75 //! @code{.cc}
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	76 //! make_valid_name_options (ovl ("ReplacementStyle", "hex", ...));
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	77 //! @endcode
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	78
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	79 make_valid_name_options (const octave_value_list& args);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	80
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	81 //! @return ReplacementStyle, see `help matlab.lang.makeValidName`.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	82
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	83 const std::string&
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	84 get_replacement_style () const { return m_replacement_style; }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	85
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	86 //! @return Prefix, see `help matlab.lang.makeValidName`.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	87
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	88 const std::string& get_prefix () const { return m_prefix; }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	89
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	90 private:
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	91
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	92 std::string m_replacement_style{"underscore"};
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	93 std::string m_prefix{"x"};
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	94 };
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	95
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	96 //! Modify @p str to be a valid variable name.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	97 //!
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	98 //! @param str input string
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	99 //! @param options see also `help matlab.lang.makeValidName`.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	100 //!
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	101 //! @return true, if @p str was modified.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	102
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	103 extern OCTINTERP_API bool
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	104 make_valid_name (std::string& str, const make_valid_name_options& options);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28078 diff changeset	105
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	106 extern OCTINTERP_API bool
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	107 same_file (const std::string& f, const std::string& g);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	108
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	109 extern OCTINTERP_API int almost_match (const std::string& std,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	110 const std::string& s,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	111 int min_match_len = 1,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	112 int case_sens = 1);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	113
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	114 extern OCTINTERP_API int
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	115 keyword_almost_match (const char * const std, int min_len,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	116 const std::string& s, int min_toks_to_match,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	117 int max_toks);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	118
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	119 extern OCTINTERP_API std::string
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	120 search_path_for_file (const std::string&, const string_vector&);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	121
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	122 extern OCTINTERP_API string_vector
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	123 search_path_for_all_files (const std::string&, const string_vector&);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	124
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	125 extern OCTINTERP_API std::string
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	126 file_in_path (const std::string&, const std::string&);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	127
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	128 extern OCTINTERP_API std::string
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	129 find_data_file_in_load_path (const std::string& fcn,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	130 const std::string& file,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	131 bool require_regular_file = false);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	132
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	133 extern OCTINTERP_API std::string contents_file_in_path (const std::string&);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	134
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	135 extern OCTINTERP_API std::string fcn_file_in_path (const std::string&);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	136
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	137 extern OCTINTERP_API std::string do_string_escapes (const std::string& s);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	138
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	139 extern OCTINTERP_API const char * undo_string_escape (char c);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	140
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	141 extern OCTINTERP_API std::string undo_string_escapes (const std::string& s);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	142
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	143 extern OCTINTERP_API void
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	144 check_dimensions (dim_vector& dim, const char *warnfor);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	145
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	146 extern OCTINTERP_API void
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	147 get_dimensions (const octave_value& a, const char *warn_for,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	148 dim_vector& dim);
607 ae3b8b2924a0 [project @ 1994-08-13 20:11:17 by jwe] jwe parents: 578 diff changeset	149
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	150 extern OCTINTERP_API void
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	151 get_dimensions (const octave_value& a, const octave_value& b,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	152 const char *warn_for, octave_idx_type& nr,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	153 octave_idx_type& nc);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	154
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	155 extern OCTINTERP_API void
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	156 get_dimensions (const octave_value& a, const char *warn_for,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	157 octave_idx_type& nr, octave_idx_type& nc);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	158
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	159 extern OCTINTERP_API octave_idx_type
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	160 dims_to_numel (const dim_vector& dims, const octave_value_list& idx);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	161
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	162 extern OCTINTERP_API Matrix
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	163 identity_matrix (octave_idx_type nr, octave_idx_type nc);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	164
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	165 extern OCTINTERP_API FloatMatrix
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	166 float_identity_matrix (octave_idx_type nr, octave_idx_type nc);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	167
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	168 extern OCTINTERP_API std::size_t
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	169 format (std::ostream& os, const char *fmt, ...);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	170
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	171 extern OCTINTERP_API std::size_t
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	172 vformat (std::ostream& os, const char *fmt, va_list args);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	173
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	174 extern OCTINTERP_API std::string
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	175 vasprintf (const char *fmt, va_list args);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	176
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	177 extern OCTINTERP_API std::string asprintf (const char *fmt, ...);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	178
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25646 diff changeset	179 extern OCTINTERP_API void sleep (double seconds,
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25646 diff changeset	180 bool do_graphics_events = false);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	181
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	182 extern OCTINTERP_API
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	183 octave_value_list
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30822 diff changeset	184 do_simple_cellfun (octave_value_list (*fcn) (const octave_value_list&, int),
c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30822 diff changeset	185 const char *fcn_name, const octave_value_list& args,
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	186 int nargout);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	187
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	188 extern OCTINTERP_API
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	189 octave_value
30896 c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30822 diff changeset	190 do_simple_cellfun (octave_value_list (*fcn) (const octave_value_list&, int),
c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/. Rik <rik@octave.org> parents: 30822 diff changeset	191 const char *fcn_name, const octave_value_list& args);
29960 939bef0b66e0 merge "namespace octave" and OCTAVE_NAMESPACE_BEGIN/END blocks John W. Eaton <jwe@octave.org> parents: 29655 diff changeset	192
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30896 diff changeset	193 OCTAVE_END_NAMESPACE(octave)
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	194
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	195 #endif

Mercurial > octave

annotate libinterp/corefcn/utils.h @ 31605:e88a07dec498 stable