Mercurial > octave
view libinterp/corefcn/variables.h @ 21662:5b9868c2e212
maint: Octave coding convention cleanups.
* Figure.cc, QtHandlesUtils.cc, files-dock-widget.cc, find-files-dialog.cc,
debug.cc, ls-hdf5.h, oct-fstrm.h, oct-iostrm.h, oct-stdstrm.h, oct-stream.h,
pr-output.cc, sysdep.cc, zfstream.h, pt-cbinop.cc, f77-fcn.h, DASPK.cc,
DASSL.cc, cmd-hist.cc, glob-match.h:
Cuddle angle bracket '<' next to C++ cast operator.
Space between variable reference and variable name (int& a).
Space between bitwise operators and their operands (A & B).
Create typedef tree_expression_ptr_t to avoid "tree_expression *&a"
which is unclear.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 02 May 2016 11:13:50 -0700 |
parents | 987c1a79d33f |
children | bcc30b45a225 |
line wrap: on
line source
/* Copyright (C) 1993-2015 John W. Eaton This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #if ! defined (octave_variables_h) #define octave_variables_h 1 #include "octave-config.h" class octave_function; class octave_user_function; class tree_identifier; class octave_value; class octave_value_list; class octave_builtin; class string_vector; #include <cfloat> #include <limits> #include <string> #include "lo-ieee.h" #include "ov.h" #include "ov-builtin.h" #include "symtab.h" extern OCTINTERP_API void clear_mex_functions (void); extern OCTINTERP_API octave_function * is_valid_function (const octave_value&, const std::string& = "", bool warn = false); extern OCTINTERP_API octave_function * is_valid_function (const std::string&, const std::string& = "", bool warn = false); extern OCTINTERP_API octave_function * extract_function (const octave_value& arg, const std::string& warn_for, const std::string& fname, const std::string& header, const std::string& trailer); extern OCTINTERP_API string_vector get_struct_elts (const std::string& text); extern OCTINTERP_API string_vector generate_struct_completions (const std::string& text, std::string& prefix, std::string& hint); extern OCTINTERP_API bool looks_like_struct (const std::string& text); extern OCTINTERP_API int symbol_exist (const std::string& name, const std::string& type = "any"); extern OCTINTERP_API std::string unique_symbol_name (const std::string& basename); extern OCTINTERP_API octave_value lookup_function_handle (const std::string& nm); extern OCTINTERP_API octave_value get_global_value (const std::string& nm, bool silent = false); extern OCTINTERP_API void set_global_value (const std::string& nm, const octave_value& val); extern OCTINTERP_API octave_value get_top_level_value (const std::string& nm, bool silent = false); extern OCTINTERP_API void set_top_level_value (const std::string& nm, const octave_value& val); extern OCTINTERP_API octave_value set_internal_variable (bool& var, const octave_value_list& args, int nargout, const char *nm); extern OCTINTERP_API octave_value set_internal_variable (char& var, const octave_value_list& args, int nargout, const char *nm); extern OCTINTERP_API octave_value set_internal_variable (int& var, const octave_value_list& args, int nargout, const char *nm, int minval = std::numeric_limits<int>::min (), int maxval = std::numeric_limits<int>::max ()); extern OCTINTERP_API octave_value set_internal_variable (double& var, const octave_value_list& args, int nargout, const char *nm, double minval = -octave_Inf, double maxval = octave_Inf); extern OCTINTERP_API octave_value set_internal_variable (std::string& var, const octave_value_list& args, int nargout, const char *nm, bool empty_ok = true); extern OCTINTERP_API octave_value set_internal_variable (std::string& var, const octave_value_list& args, int nargout, const char *nm, const char **choices); extern OCTINTERP_API octave_value set_internal_variable (int& var, const octave_value_list& args, int nargout, const char *nm, const char **choices); #define SET_INTERNAL_VARIABLE(NM) \ set_internal_variable (V ## NM, args, nargout, #NM) #define SET_NONEMPTY_INTERNAL_STRING_VARIABLE(NM) \ set_internal_variable (V ## NM, args, nargout, #NM, false) #define SET_INTERNAL_VARIABLE_WITH_LIMITS(NM, MINVAL, MAXVAL) \ set_internal_variable (V ## NM, args, nargout, #NM, MINVAL, MAXVAL) // in the following, CHOICES must be a C string array terminated by null. #define SET_INTERNAL_VARIABLE_CHOICES(NM, CHOICES) \ set_internal_variable (V ## NM, args, nargout, #NM, CHOICES) extern OCTINTERP_API std::string builtin_string_variable (const std::string&); extern OCTINTERP_API int builtin_real_scalar_variable (const std::string&, double&); extern OCTINTERP_API octave_value builtin_any_variable (const std::string&); extern OCTINTERP_API void bind_ans (const octave_value& val, bool print); OCTAVE_DEPRECATED ("note: internal variables have been replaced by functions; use 'feval' instead") OCTINTERP_API extern void bind_internal_variable (const std::string& fname, const octave_value& val); extern OCTINTERP_API void mlock (void); extern OCTINTERP_API void munlock (const std::string&); extern OCTINTERP_API bool mislocked (const std::string&); extern OCTINTERP_API void clear_function (const std::string& nm); extern OCTINTERP_API void clear_variable (const std::string& nm); extern OCTINTERP_API void clear_symbol (const std::string& nm); extern OCTINTERP_API void maybe_missing_function_hook (const std::string& name); #endif