Mercurial > octave

comparison libinterp/corefcn/utils.h @ 31607:aac27ad79be6 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Re-indent code after switch to using namespace macros. * build-env.h, build-env.in.cc, Cell.h, __betainc__.cc, __eigs__.cc, __ftp__.cc, __ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __magick_read__.cc, __pchip_deriv__.cc, amd.cc, base-text-renderer.cc, base-text-renderer.h, besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.h, call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, dasrt.cc, data.cc, debug.cc, defaults.cc, defaults.h, det.cc, display.cc, display.h, dlmread.cc, dynamic-ld.cc, dynamic-ld.h, 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, file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc, gsvd.cc, gtk-manager.cc, gtk-manager.h, help.cc, help.h, 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, latex-text-renderer.cc, latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h, lookup.cc, ls-hdf5.cc, ls-mat4.cc, ls-mat5.cc, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex.cc, mexproto.h, mxarray.h, mxtypes.in.h, oct-errno.in.cc, oct-hdf5-types.cc, oct-hist.cc, oct-hist.h, oct-map.cc, oct-map.h, oct-opengl.h, oct-prcstrm.h, oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.h, octave-default-image.h, ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-output.cc, psi.cc, qr.cc, quadcc.cc, rand.cc, regexp.cc, settings.cc, settings.h, sighandlers.cc, sighandlers.h, sparse-xpow.cc, sqrtm.cc, stack-frame.cc, stack-frame.h, stream-euler.cc, strfns.cc, svd.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h, symscope.cc, symscope.h, symtab.cc, symtab.h, sysdep.cc, sysdep.h, text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc, toplev.cc, typecast.cc, url-handle-manager.cc, url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc, variables.h, xdiv.cc, __delaunayn__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audioread.cc, convhulln.cc, gzip.cc, 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-diag.cc, ov-base-int.cc, ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.cc, ov-base.cc, ov-base.h, ov-bool-mat.cc, ov-bool-mat.h, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.h, ov-cell.cc, ov-ch-mat.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h, ov-complex.cc, ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-dld-fcn.cc, ov-dld-fcn.h, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h, ov-float.cc, ov-flt-complex.cc, ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-diag.cc, ov-flt-re-mat.cc, ov-flt-re-mat.h, ov-intx.h, ov-java.cc, ov-lazy-idx.cc, ov-legacy-range.cc, ov-magic-int.cc, ov-mex-fcn.cc, ov-mex-fcn.h, ov-null-mat.cc, ov-perm.cc, ov-range.cc, ov-re-diag.cc, ov-re-mat.cc, ov-re-mat.h, ov-re-sparse.cc, ov-scalar.cc, ov-str-mat.cc, ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, ovl.h, octave.cc, octave.h, op-b-sbm.cc, op-bm-sbm.cc, op-cs-scm.cc, op-fm-fcm.cc, op-fs-fcm.cc, op-s-scm.cc, op-scm-cs.cc, op-scm-s.cc, op-sm-cs.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, oct-lvalue.cc, oct-lvalue.h, 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-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: Re-indent code after switch to using namespace macros.
author Rik <rik@octave.org>
date Thu, 01 Dec 2022 18:02:15 -0800
parents e88a07dec498
children 597f3ee61a48
comparison
equal deleted inserted replaced
31605:e88a07dec498 31607:aac27ad79be6
41 class octave_value_list; 41 class octave_value_list;
42 class string_vector; 42 class string_vector;
43 43
44 OCTAVE_BEGIN_NAMESPACE(octave) 44 OCTAVE_BEGIN_NAMESPACE(octave)
45 45
46 extern OCTINTERP_API bool valid_identifier (const char *s); 46 extern OCTINTERP_API bool valid_identifier (const char *s);
47 extern OCTINTERP_API bool valid_identifier (const std::string& s); 47 extern OCTINTERP_API bool valid_identifier (const std::string& s);
48 48
49 //! Helper class for `make_valid_name` function calls. 49 //! Helper class for `make_valid_name` function calls.
50 //!
51 //! Extracting options separately for multiple (e.g. 1000+) function calls
52 //! avoids expensive repetitive parsing of the very same options.
53
54 class
55 OCTINTERP_API
56 make_valid_name_options
57 {
58 public:
59
60 //! Default options for `make_valid_name` function calls.
50 //! 61 //!
51 //! Extracting options separately for multiple (e.g. 1000+) function calls 62 //! Calling the constructor without arguments is equivalent to:
52 //! avoids expensive repetitive parsing of the very same options. 63 //!
64 //! @code{.cc}
65 //! make_valid_name_options (ovl ("ReplacementStyle", "underscore",
66 //! "Prefix", "x"));
67 //! @endcode
53 68
54 class 69 make_valid_name_options () = default;
55 OCTINTERP_API
56 make_valid_name_options
57 {
58 public:
59 70
60 //! Default options for `make_valid_name` function calls. 71 //! Extract attribute-value-pairs from an octave_value_list of strings.
61 //! 72 //!
62 //! Calling the constructor without arguments is equivalent to: 73 //! If attributes occur multiple times, the rightmost pair is chosen.
63 //! 74 //!
64 //! @code{.cc} 75 //! @code{.cc}
65 //! make_valid_name_options (ovl ("ReplacementStyle", "underscore", 76 //! make_valid_name_options (ovl ("ReplacementStyle", "hex", ...));
66 //! "Prefix", "x")); 77 //! @endcode
67 //! @endcode
68 78
69 make_valid_name_options () = default; 79 make_valid_name_options (const octave_value_list& args);
70 80
71 //! Extract attribute-value-pairs from an octave_value_list of strings. 81 //! @return ReplacementStyle, see `help matlab.lang.makeValidName`.
72 //!
73 //! If attributes occur multiple times, the rightmost pair is chosen.
74 //!
75 //! @code{.cc}
76 //! make_valid_name_options (ovl ("ReplacementStyle", "hex", ...));
77 //! @endcode
78 82
79 make_valid_name_options (const octave_value_list& args); 83 const std::string&
84 get_replacement_style () const { return m_replacement_style; }
80 85
81 //! @return ReplacementStyle, see `help matlab.lang.makeValidName`. 86 //! @return Prefix, see `help matlab.lang.makeValidName`.
82 87
83 const std::string& 88 const std::string& get_prefix () const { return m_prefix; }
84 get_replacement_style () const { return m_replacement_style; }
85 89
86 //! @return Prefix, see `help matlab.lang.makeValidName`. 90 private:
87 91
88 const std::string& get_prefix () const { return m_prefix; } 92 std::string m_replacement_style{"underscore"};
93 std::string m_prefix{"x"};
94 };
89 95
90 private: 96 //! Modify @p str to be a valid variable name.
97 //!
98 //! @param str input string
99 //! @param options see also `help matlab.lang.makeValidName`.
100 //!
101 //! @return true, if @p str was modified.
91 102
92 std::string m_replacement_style{"underscore"}; 103 extern OCTINTERP_API bool
93 std::string m_prefix{"x"}; 104 make_valid_name (std::string& str, const make_valid_name_options& options);
94 };
95 105
96 //! Modify @p str to be a valid variable name. 106 extern OCTINTERP_API bool
97 //! 107 same_file (const std::string& f, const std::string& g);
98 //! @param str input string
99 //! @param options see also `help matlab.lang.makeValidName`.
100 //!
101 //! @return true, if @p str was modified.
102 108
103 extern OCTINTERP_API bool 109 extern OCTINTERP_API int almost_match (const std::string& std,
104 make_valid_name (std::string& str, const make_valid_name_options& options); 110 const std::string& s,
111 int min_match_len = 1,
112 int case_sens = 1);
105 113
106 extern OCTINTERP_API bool 114 extern OCTINTERP_API int
107 same_file (const std::string& f, const std::string& g); 115 keyword_almost_match (const char *const *std, int *min_len,
116 const std::string& s, int min_toks_to_match,
117 int max_toks);
108 118
109 extern OCTINTERP_API int almost_match (const std::string& std, 119 extern OCTINTERP_API std::string
110 const std::string& s, 120 search_path_for_file (const std::string&, const string_vector&);
111 int min_match_len = 1,
112 int case_sens = 1);
113 121
114 extern OCTINTERP_API int 122 extern OCTINTERP_API string_vector
115 keyword_almost_match (const char * const *std, int *min_len, 123 search_path_for_all_files (const std::string&, const string_vector&);
116 const std::string& s, int min_toks_to_match,
117 int max_toks);
118 124
119 extern OCTINTERP_API std::string 125 extern OCTINTERP_API std::string
120 search_path_for_file (const std::string&, const string_vector&); 126 file_in_path (const std::string&, const std::string&);
121 127
122 extern OCTINTERP_API string_vector 128 extern OCTINTERP_API std::string
123 search_path_for_all_files (const std::string&, const string_vector&); 129 find_data_file_in_load_path (const std::string& fcn,
130 const std::string& file,
131 bool require_regular_file = false);
124 132
125 extern OCTINTERP_API std::string 133 extern OCTINTERP_API std::string contents_file_in_path (const std::string&);
126 file_in_path (const std::string&, const std::string&);
127 134
128 extern OCTINTERP_API std::string 135 extern OCTINTERP_API std::string fcn_file_in_path (const std::string&);
129 find_data_file_in_load_path (const std::string& fcn,
130 const std::string& file,
131 bool require_regular_file = false);
132 136
133 extern OCTINTERP_API std::string contents_file_in_path (const std::string&); 137 extern OCTINTERP_API std::string do_string_escapes (const std::string& s);
134 138
135 extern OCTINTERP_API std::string fcn_file_in_path (const std::string&); 139 extern OCTINTERP_API const char * undo_string_escape (char c);
136 140
137 extern OCTINTERP_API std::string do_string_escapes (const std::string& s); 141 extern OCTINTERP_API std::string undo_string_escapes (const std::string& s);
138 142
139 extern OCTINTERP_API const char * undo_string_escape (char c); 143 extern OCTINTERP_API void
144 check_dimensions (dim_vector& dim, const char *warnfor);
140 145
141 extern OCTINTERP_API std::string undo_string_escapes (const std::string& s); 146 extern OCTINTERP_API void
147 get_dimensions (const octave_value& a, const char *warn_for,
148 dim_vector& dim);
142 149
143 extern OCTINTERP_API void 150 extern OCTINTERP_API void
144 check_dimensions (dim_vector& dim, const char *warnfor); 151 get_dimensions (const octave_value& a, const octave_value& b,
152 const char *warn_for, octave_idx_type& nr,
153 octave_idx_type& nc);
145 154
146 extern OCTINTERP_API void 155 extern OCTINTERP_API void
147 get_dimensions (const octave_value& a, const char *warn_for, 156 get_dimensions (const octave_value& a, const char *warn_for,
148 dim_vector& dim); 157 octave_idx_type& nr, octave_idx_type& nc);
149 158
150 extern OCTINTERP_API void 159 extern OCTINTERP_API octave_idx_type
151 get_dimensions (const octave_value& a, const octave_value& b, 160 dims_to_numel (const dim_vector& dims, const octave_value_list& idx);
152 const char *warn_for, octave_idx_type& nr,
153 octave_idx_type& nc);
154 161
155 extern OCTINTERP_API void 162 extern OCTINTERP_API Matrix
156 get_dimensions (const octave_value& a, const char *warn_for, 163 identity_matrix (octave_idx_type nr, octave_idx_type nc);
157 octave_idx_type& nr, octave_idx_type& nc);
158 164
159 extern OCTINTERP_API octave_idx_type 165 extern OCTINTERP_API FloatMatrix
160 dims_to_numel (const dim_vector& dims, const octave_value_list& idx); 166 float_identity_matrix (octave_idx_type nr, octave_idx_type nc);
161 167
162 extern OCTINTERP_API Matrix 168 extern OCTINTERP_API std::size_t
163 identity_matrix (octave_idx_type nr, octave_idx_type nc); 169 format (std::ostream& os, const char *fmt, ...);
164 170
165 extern OCTINTERP_API FloatMatrix 171 extern OCTINTERP_API std::size_t
166 float_identity_matrix (octave_idx_type nr, octave_idx_type nc); 172 vformat (std::ostream& os, const char *fmt, va_list args);
167 173
168 extern OCTINTERP_API std::size_t 174 extern OCTINTERP_API std::string
169 format (std::ostream& os, const char *fmt, ...); 175 vasprintf (const char *fmt, va_list args);
170 176
171 extern OCTINTERP_API std::size_t 177 extern OCTINTERP_API std::string asprintf (const char *fmt, ...);
172 vformat (std::ostream& os, const char *fmt, va_list args);
173 178
174 extern OCTINTERP_API std::string 179 extern OCTINTERP_API void sleep (double seconds,
175 vasprintf (const char *fmt, va_list args); 180 bool do_graphics_events = false);
176 181
177 extern OCTINTERP_API std::string asprintf (const char *fmt, ...); 182 extern OCTINTERP_API
183 octave_value_list
184 do_simple_cellfun (octave_value_list (*fcn) (const octave_value_list&, int),
185 const char *fcn_name, const octave_value_list& args,
186 int nargout);
178 187
179 extern OCTINTERP_API void sleep (double seconds, 188 extern OCTINTERP_API
180 bool do_graphics_events = false); 189 octave_value
181 190 do_simple_cellfun (octave_value_list (*fcn) (const octave_value_list&, int),
182 extern OCTINTERP_API 191 const char *fcn_name, const octave_value_list& args);
183 octave_value_list
184 do_simple_cellfun (octave_value_list (*fcn) (const octave_value_list&, int),
185 const char *fcn_name, const octave_value_list& args,
186 int nargout);
187
188 extern OCTINTERP_API
189 octave_value
190 do_simple_cellfun (octave_value_list (*fcn) (const octave_value_list&, int),
191 const char *fcn_name, const octave_value_list& args);
192 192
193 OCTAVE_END_NAMESPACE(octave) 193 OCTAVE_END_NAMESPACE(octave)
194 194
195 #endif 195 #endif