1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2018-2021 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// 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
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
#if ! defined (octave_syminfo_h)
#define octave_syminfo_h 1
#include "octave-config.h"
#include <string>
#include <iosfwd>
#include "base-list.h"
#include "ov.h"
class octave_map;
namespace octave
{
struct whos_parameter
{
char command;
char modifier;
int parameter_length;
int first_parameter_length;
int balance;
std::string text;
std::string line;
};
class symbol_info
{
public:
symbol_info (const std::string& name, const octave_value& value,
bool is_formal, bool is_global, bool is_persistent)
: m_name (name), m_value (value), m_is_complex (value.iscomplex ()),
m_is_formal (is_formal), m_is_global (is_global),
m_is_persistent (is_persistent)
{ }
std::string name (void) const { return m_name; }
octave_value value (void) const { return m_value; }
bool is_complex (void) const { return m_is_complex; }
bool is_formal (void) const { return m_is_formal; }
bool is_global (void) const { return m_is_global; }
bool is_persistent (void) const { return m_is_persistent; }
void display_line (std::ostream& os,
const std::list<whos_parameter>& params) const;
private:
std::string m_name;
octave_value m_value;
bool m_is_complex;
bool m_is_formal;
bool m_is_global;
bool m_is_persistent;
};
class symbol_info_list : public base_list<symbol_info>
{
public:
symbol_info_list (void) = default;
symbol_info_list (const symbol_info_list&) = default;
symbol_info_list& operator = (const symbol_info_list&) = default;
~symbol_info_list (void) = default;
octave_value varval (const std::string& name) const;
std::list<std::string> names (void) const;
octave_map map_value (const std::string& caller_function_name,
int nesting_level) const;
// Print a line of information for a given symbol.
void print_descriptor (std::ostream& os,
const std::list<whos_parameter> params) const;
void display (std::ostream& os, const std::string& format) const;
// Parse FORMAT, and return a parameter list,
// containing all information needed to print the given
// attributes of the symbols.
std::list<whos_parameter>
parse_whos_line_format (const std::string& format) const;
};
}
#endif
|