GNU Octave 7.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
octave::symbol_record Class Reference

#include "symrec.h"

Collaboration diagram for octave::symbol_record:
Collaboration graph
[legend]

Classes

class  symbol_record_rep
 

Public Types

typedef std::size_t context_id
 
enum  symrec_t : unsigned char { LOCAL = 1 , FORMAL = 2 , ADDED_STATIC = 4 , VARIABLE = 8 }
 

Public Member Functions

 symbol_record (const std::string &nm, const octave_value &, symrec_t sc=LOCAL)
 
 symbol_record (const std::string &nm="", symrec_t sc=LOCAL)
 
 symbol_record (const symbol_record &)=default
 
 ~symbol_record (void)=default
 
std::size_t data_offset (void) const
 
octave_value dump (void) const
 
symbol_record dup (void) const
 
std::size_t frame_offset (void) const
 
bool is_added_static (void) const
 
bool is_formal (void) const
 
bool is_local (void) const
 
bool is_valid (void) const
 
bool is_variable (void) const
 
void mark_added_static (void)
 
void mark_as_variable (void)
 
void mark_formal (void)
 
void mark_local (void)
 
std::string name (void) const
 
 operator bool () const
 
symbol_record & operator= (const symbol_record &)=default
 
void rename (const std::string &new_name)
 
void set_data_offset (std::size_t offset)
 
void set_frame_offset (std::size_t offset)
 
unsigned int storage_class (void) const
 
void unmark_added_static (void)
 
void unmark_as_variable (void)
 
void unmark_formal (void)
 
void unmark_local (void)
 

Private Member Functions

 symbol_record (const std::shared_ptr< symbol_record_rep > &new_rep)
 

Private Attributes

std::shared_ptr< symbol_record_rep > m_rep
 

Detailed Description

Definition at line 45 of file symrec.h.

Member Typedef Documentation

◆ context_id

typedef std::size_t octave::symbol_record::context_id

Definition at line 49 of file symrec.h.

Member Enumeration Documentation

◆ symrec_t

enum octave::symbol_record::symrec_t : unsigned char
Enumerator
LOCAL 
FORMAL 
ADDED_STATIC 
VARIABLE 

Definition at line 51 of file symrec.h.

Constructor & Destructor Documentation

◆ symbol_record() [1/4]

octave::symbol_record::symbol_record ( const std::string &  nm = "",
symrec_t  sc = LOCAL 
)
inline

Definition at line 178 of file symrec.h.

Referenced by dup().

◆ symbol_record() [2/4]

octave::symbol_record::symbol_record ( const std::string &  nm,
const octave_value &  ,
symrec_t  sc = LOCAL 
)
inline

Definition at line 182 of file symrec.h.

◆ symbol_record() [3/4]

octave::symbol_record::symbol_record ( const symbol_record &  )
default

◆ ~symbol_record()

octave::symbol_record::~symbol_record ( void  )
default

◆ symbol_record() [4/4]

octave::symbol_record::symbol_record ( const std::shared_ptr< symbol_record_rep > &  new_rep)
inlineprivate

Definition at line 235 of file symrec.h.

Member Function Documentation

◆ data_offset()

std::size_t octave::symbol_record::data_offset ( void  ) const
inline

Definition at line 203 of file symrec.h.

References m_rep.

Referenced by octave::script_stack_frame::get_val_offsets(), octave::script_stack_frame::get_val_offsets_internal(), octave::script_stack_frame::get_val_offsets_with_insert(), octave::script_stack_frame::mark_scope(), octave::user_fcn_stack_frame::mark_scope(), octave::scope_stack_frame::mark_scope(), octave::script_stack_frame::resize_and_update_script_offsets(), octave::user_fcn_stack_frame::scope_flag(), octave::scope_stack_frame::scope_flag(), octave::script_stack_frame::set_script_offsets_internal(), octave::user_fcn_stack_frame::varref(), octave::scope_stack_frame::varref(), octave::user_fcn_stack_frame::varval(), and octave::scope_stack_frame::varval().

◆ dump()

octave_value octave::symbol_record::dump ( void  ) const
inline

Definition at line 228 of file symrec.h.

References m_rep.

Referenced by octave::symbol_scope_rep::dump_symbols_map().

◆ dup()

symbol_record octave::symbol_record::dup ( void  ) const
inline

Definition at line 205 of file symrec.h.

References symbol_record(), and m_rep.

Referenced by octave::script_stack_frame::lookup_symbol().

◆ frame_offset()

std::size_t octave::symbol_record::frame_offset ( void  ) const
inline

Definition at line 199 of file symrec.h.

References m_rep.

Referenced by octave::script_stack_frame::get_val_offsets(), octave::script_stack_frame::get_val_offsets_internal(), octave::script_stack_frame::get_val_offsets_with_insert(), octave::script_stack_frame::insert_symbol(), octave::script_stack_frame::lookup_symbol(), octave::user_fcn_stack_frame::mark_scope(), octave::user_fcn_stack_frame::scope_flag(), octave::script_stack_frame::set_script_offsets_internal(), octave::user_fcn_stack_frame::varref(), and octave::user_fcn_stack_frame::varval().

◆ is_added_static()

bool octave::symbol_record::is_added_static ( void  ) const
inline

Definition at line 213 of file symrec.h.

References m_rep.

Referenced by octave::tree_identifier::evaluate_n(), and octave::tree_identifier::lvalue().

◆ is_formal()

bool octave::symbol_record::is_formal ( void  ) const
inline

Definition at line 212 of file symrec.h.

References m_rep.

Referenced by octave::symbol_record::symbol_record_rep::dump(), octave::stack_frame::make_persistent(), and octave::symbol_scope_rep::update_nest().

◆ is_local()

bool octave::symbol_record::is_local ( void  ) const
inline

Definition at line 211 of file symrec.h.

References m_rep.

Referenced by octave::symbol_record::symbol_record_rep::dump().

◆ is_valid()

bool octave::symbol_record::is_valid ( void  ) const
inline

Definition at line 193 of file symrec.h.

References m_rep.

Referenced by operator bool().

◆ is_variable()

bool octave::symbol_record::is_variable ( void  ) const
inline

Definition at line 214 of file symrec.h.

References m_rep.

◆ mark_added_static()

void octave::symbol_record::mark_added_static ( void  )
inline

Definition at line 218 of file symrec.h.

References m_rep.

Referenced by octave::symbol_scope_rep::insert().

◆ mark_as_variable()

void octave::symbol_record::mark_as_variable ( void  )
inline

Definition at line 219 of file symrec.h.

References m_rep.

◆ mark_formal()

void octave::symbol_record::mark_formal ( void  )
inline

Definition at line 217 of file symrec.h.

References m_rep.

Referenced by octave::tree_identifier::mark_as_formal_parameter().

◆ mark_local()

void octave::symbol_record::mark_local ( void  )
inline

Definition at line 216 of file symrec.h.

References m_rep.

◆ name()

std::string octave::symbol_record::name ( void  ) const
inline

Definition at line 207 of file symrec.h.

References m_rep.

Referenced by octave::tree_identifier::evaluate_n(), octave::script_stack_frame::get_val_offsets_internal(), octave::script_stack_frame::get_val_offsets_with_insert(), octave::symbol_scope_rep::insert_symbol_record(), octave::stack_frame::install_variable(), octave::stack_frame::make_global(), octave::stack_frame::make_persistent(), octave::symbol_cleaner::maybe_clear_symbol(), octave::tree_identifier::name(), octave::script_stack_frame::resize_and_update_script_offsets(), octave::script_stack_frame::varref(), octave::user_fcn_stack_frame::varref(), octave::scope_stack_frame::varref(), octave::script_stack_frame::varval(), octave::user_fcn_stack_frame::varval(), and octave::scope_stack_frame::varval().

◆ operator bool()

octave::symbol_record::operator bool ( ) const
inlineexplicit

Definition at line 195 of file symrec.h.

References is_valid().

◆ operator=()

symbol_record & octave::symbol_record::operator= ( const symbol_record &  )
default

◆ rename()

void octave::symbol_record::rename ( const std::string &  new_name)
inline

Definition at line 209 of file symrec.h.

References m_rep.

Referenced by octave::symbol_scope_rep::rename().

◆ set_data_offset()

void octave::symbol_record::set_data_offset ( std::size_t  offset)
inline

Definition at line 201 of file symrec.h.

References m_rep.

Referenced by octave::symbol_scope_rep::insert(), octave::symbol_scope_rep::insert_symbol_record(), and octave::symbol_scope_rep::look_nonlocal().

◆ set_frame_offset()

void octave::symbol_record::set_frame_offset ( std::size_t  offset)
inline

Definition at line 197 of file symrec.h.

References m_rep.

Referenced by octave::symbol_scope_rep::look_nonlocal(), and octave::script_stack_frame::lookup_symbol().

◆ storage_class()

unsigned int octave::symbol_record::storage_class ( void  ) const
inline

Definition at line 226 of file symrec.h.

References m_rep.

◆ unmark_added_static()

void octave::symbol_record::unmark_added_static ( void  )
inline

Definition at line 223 of file symrec.h.

References m_rep.

◆ unmark_as_variable()

void octave::symbol_record::unmark_as_variable ( void  )
inline

Definition at line 224 of file symrec.h.

References m_rep.

◆ unmark_formal()

void octave::symbol_record::unmark_formal ( void  )
inline

Definition at line 222 of file symrec.h.

References m_rep.

◆ unmark_local()

void octave::symbol_record::unmark_local ( void  )
inline

Definition at line 221 of file symrec.h.

References m_rep.

Member Data Documentation

◆ m_rep

std::shared_ptr<symbol_record_rep> octave::symbol_record::m_rep
private

Definition at line 232 of file symrec.h.

Referenced by data_offset(), dump(), dup(), frame_offset(), is_added_static(), is_formal(), is_local(), is_valid(), is_variable(), mark_added_static(), mark_as_variable(), mark_formal(), mark_local(), name(), rename(), set_data_offset(), set_frame_offset(), storage_class(), unmark_added_static(), unmark_as_variable(), unmark_formal(), and unmark_local().

The documentation for this class was generated from the following file: