octave::output_system Class Reference

#include "pager.h"

Collaboration diagram for octave::output_system:

Public Member Functions
	output_system (const output_system &)=delete
	output_system (interpreter &interp)
	~output_system (void)=default
std::ostream &	__diary__ (void)
std::ostream &	__stdout__ (void)
void	clear_external_pager (void)
void	close_diary (void)
diary_stream &	diary (void)
std::string	diary_file_name (const std::string &nm)
std::string	diary_file_name (void) const
std::ofstream &	external_diary_file (void)
void	flush_stdout (void)
bool	flushing_output_to_pager (bool flag)
bool	flushing_output_to_pager (void) const
void	open_diary (void)
output_system &	operator= (const output_system &)=delete
bool	page_output_immediately (bool flag)
octave_value	page_output_immediately (const octave_value_list &args, int nargout)
bool	page_output_immediately (void) const
bool	page_screen_output (bool flag)
octave_value	page_screen_output (const octave_value_list &args, int nargout)
bool	page_screen_output (void) const
octave_value	PAGER (const octave_value_list &args, int nargout)
std::string	PAGER (const std::string &s)
pager_stream &	pager (void)
std::string	PAGER (void) const
std::string	pager_command (void) const
octave_value	PAGER_FLAGS (const octave_value_list &args, int nargout)
std::string	PAGER_FLAGS (const std::string &s)
std::string	PAGER_FLAGS (void) const
bool	really_flush_to_pager (bool flag)
bool	really_flush_to_pager (void) const
void	reset (void)
bool	sync (const char *msg, int len)
bool	write_to_diary_file (bool flag)
bool	write_to_diary_file (void) const

Private Member Functions
void	do_sync (const char *msg, int len, bool bypass_pager)
void	start_external_pager (void)

Private Attributes
std::string	m_diary_file_name
diary_stream	m_diary_stream
std::ofstream	m_external_diary_file
oprocstream *	m_external_pager = nullptr
bool	m_flushing_output_to_pager
interpreter &	m_interpreter
bool	m_page_output_immediately
bool	m_page_screen_output
std::string	m_PAGER
std::string	m_PAGER_FLAGS
pager_stream	m_pager_stream
bool	m_really_flush_to_pager
bool	m_write_to_diary_file

Detailed Description

Definition at line 134 of file pager.h.

Constructor & Destructor Documentation

output_system() [1/2]

octave::output_system::output_system

(

interpreter &

interp

)

Definition at line 267 of file pager.cc.

output_system() [2/2]

octave::output_system::output_system ( const output_system &  )

delete

~output_system()

octave::output_system::~output_system ( void  )

default

Member Function Documentation

__diary__()

std::ostream& octave::output_system::__diary__ ( void  )

inline

Definition at line 262 of file pager.h.

References m_diary_stream, and octave::diary_stream::stream().

Referenced by octave::__diary__().

__stdout__()

std::ostream& octave::output_system::__stdout__ ( void  )

inline

Definition at line 260 of file pager.h.

References m_pager_stream, and octave::pager_stream::stream().

Referenced by octave::stream_list::stream_list(), and octave::__stdout__().

clear_external_pager()

void octave::output_system::clear_external_pager

(

void

)

Definition at line 407 of file pager.cc.

References octave::interpreter::get_child_list(), m_external_pager, m_interpreter, procstreambase::pid(), and octave::child_list::remove().

Referenced by flush_stdout().

close_diary()

void octave::output_system::close_diary

(

void

)

Definition at line 343 of file pager.cc.

References octave::pager_stream::flush_current_contents_to_diary(), m_external_diary_file, m_pager_stream, and octave_diary.

Referenced by Fdiary(), and open_diary().

diary()

diary_stream& octave::output_system::diary ( void  )

inline

Definition at line 148 of file pager.h.

References m_diary_stream.

diary_file_name() [1/2]

std::string octave::output_system::diary_file_name ( const std::string &  nm )

inline

Definition at line 152 of file pager.h.

References m_diary_file_name.

diary_file_name() [2/2]

std::string octave::output_system::diary_file_name ( void  ) const

inline

Definition at line 150 of file pager.h.

References m_diary_file_name.

Referenced by Fdiary().

do_sync()

void octave::output_system::do_sync ( const char *  msg, int  len, bool  bypass_pager  )

private

Definition at line 438 of file pager.cc.

References len, m_external_pager, and start_external_pager().

Referenced by sync().

external_diary_file()

std::ofstream& octave::output_system::external_diary_file ( void  )

inline

Definition at line 246 of file pager.h.

References m_external_diary_file.

Referenced by octave::diary_buf::sync().

flush_stdout()

void octave::output_system::flush_stdout

(

void

)

Definition at line 323 of file pager.cc.

References clear_external_pager(), m_flushing_output_to_pager, m_pager_stream, m_really_flush_to_pager, octave::action_container::protect_var(), and octave::pager_stream::stream().

Referenced by octave::flush_stdout(), and reset().

flushing_output_to_pager() [1/2]

bool octave::output_system::flushing_output_to_pager ( bool  flag )

inline

Definition at line 237 of file pager.h.

References m_flushing_output_to_pager.

flushing_output_to_pager() [2/2]

bool octave::output_system::flushing_output_to_pager ( void  ) const

inline

Definition at line 232 of file pager.h.

References m_flushing_output_to_pager.

open_diary()

void octave::output_system::open_diary

(

void

)

Definition at line 365 of file pager.cc.

References close_diary(), error(), m_diary_file_name, m_external_diary_file, m_pager_stream, and octave::pager_stream::set_diary_skip().

Referenced by Fdiary().

operator=()

output_system& octave::output_system::operator= ( const output_system &  )

delete

page_output_immediately() [1/3]

bool octave::output_system::page_output_immediately ( bool  flag )

inline

Definition at line 189 of file pager.h.

References m_page_output_immediately.

page_output_immediately() [2/3]

octave_value octave::output_system::page_output_immediately	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 290 of file pager.cc.

References m_page_output_immediately, and set_internal_variable().

Referenced by Fpage_output_immediately().

page_output_immediately() [3/3]

bool octave::output_system::page_output_immediately ( void  ) const

inline

Definition at line 184 of file pager.h.

References m_page_output_immediately.

page_screen_output() [1/3]

bool octave::output_system::page_screen_output ( bool  flag )

inline

Definition at line 201 of file pager.h.

References m_page_screen_output.

page_screen_output() [2/3]

octave_value octave::output_system::page_screen_output	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 298 of file pager.cc.

References m_page_screen_output, and set_internal_variable().

Referenced by Fmore(), and Fpage_screen_output().

page_screen_output() [3/3]

bool octave::output_system::page_screen_output ( void  ) const

inline

Definition at line 199 of file pager.h.

References m_page_screen_output.

PAGER() [1/3]

octave_value octave::output_system::PAGER	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 276 of file pager.cc.

References m_PAGER, and set_internal_variable().

Referenced by FPAGER().

PAGER() [2/3]

std::string octave::output_system::PAGER ( const std::string &  s )

inline

Definition at line 163 of file pager.h.

References m_PAGER.

pager()

pager_stream& octave::output_system::pager ( void  )

inline

Definition at line 146 of file pager.h.

References m_pager_stream.

PAGER() [3/3]

std::string octave::output_system::PAGER ( void  ) const

inline

Definition at line 161 of file pager.h.

References m_PAGER.

pager_command()

std::string octave::output_system::pager_command

(

void

)

const

Definition at line 305 of file pager.cc.

References m_PAGER, and m_PAGER_FLAGS.

Referenced by start_external_pager().

PAGER_FLAGS() [1/3]

octave_value octave::output_system::PAGER_FLAGS	(	const octave_value_list &	args,
		int	nargout
	)

Definition at line 282 of file pager.cc.

References m_PAGER_FLAGS, and set_internal_variable().

Referenced by FPAGER_FLAGS().

PAGER_FLAGS() [2/3]

std::string octave::output_system::PAGER_FLAGS ( const std::string &  s )

inline

Definition at line 174 of file pager.h.

References m_PAGER_FLAGS.

PAGER_FLAGS() [3/3]

std::string octave::output_system::PAGER_FLAGS ( void  ) const

inline

Definition at line 172 of file pager.h.

References m_PAGER_FLAGS.

really_flush_to_pager() [1/2]

bool octave::output_system::really_flush_to_pager ( bool  flag )

inline

Definition at line 225 of file pager.h.

References m_really_flush_to_pager.

really_flush_to_pager() [2/2]

bool octave::output_system::really_flush_to_pager ( void  ) const

inline

Definition at line 220 of file pager.h.

References m_really_flush_to_pager.

reset()

void octave::output_system::reset

(

void

)

Definition at line 315 of file pager.cc.

References flush_stdout(), m_diary_stream, m_pager_stream, octave::pager_stream::reset(), and octave::diary_stream::reset().

start_external_pager()

void octave::output_system::start_external_pager ( void  )

private

Definition at line 420 of file pager.cc.

References octave::interpreter::get_child_list(), octave::child_list::insert(), m_external_pager, m_interpreter, pager_command(), octave::pager_event_handler(), and procstreambase::pid().

Referenced by do_sync().

sync()

bool octave::output_system::sync	(	const char *	msg,
		int	len
	)

Definition at line 380 of file pager.cc.

References do_sync(), octave::application::forced_interactive(), octave::interpreter::interactive(), len, m_interpreter, m_page_output_immediately, m_page_screen_output, m_really_flush_to_pager, and octave::more_than_a_screenful().

Referenced by octave::pager_buf::sync().

write_to_diary_file() [1/2]

bool octave::output_system::write_to_diary_file ( bool  flag )

inline

Definition at line 213 of file pager.h.

References m_write_to_diary_file.

write_to_diary_file() [2/2]

bool octave::output_system::write_to_diary_file ( void  ) const

inline

Definition at line 208 of file pager.h.

References m_write_to_diary_file.

Referenced by Fdiary(), and octave::diary_buf::sync().

Member Data Documentation

m_diary_file_name

std::string octave::output_system::m_diary_file_name

private

Definition at line 279 of file pager.h.

Referenced by diary_file_name(), and open_diary().

m_diary_stream

diary_stream octave::output_system::m_diary_stream

private

Definition at line 270 of file pager.h.

Referenced by __diary__(), diary(), and reset().

m_external_diary_file

std::ofstream octave::output_system::m_external_diary_file

private

Definition at line 276 of file pager.h.

Referenced by close_diary(), external_diary_file(), and open_diary().

m_external_pager

oprocstream* octave::output_system::m_external_pager = nullptr

private

Definition at line 273 of file pager.h.

Referenced by clear_external_pager(), do_sync(), and start_external_pager().

m_flushing_output_to_pager

bool octave::output_system::m_flushing_output_to_pager

private

Definition at line 301 of file pager.h.

Referenced by flush_stdout(), and flushing_output_to_pager().

m_interpreter

interpreter& octave::output_system::m_interpreter

private

Definition at line 266 of file pager.h.

Referenced by clear_external_pager(), start_external_pager(), and sync().

m_page_output_immediately

bool octave::output_system::m_page_output_immediately

private

Definition at line 290 of file pager.h.

Referenced by page_output_immediately(), and sync().

m_page_screen_output

bool octave::output_system::m_page_screen_output

private

Definition at line 294 of file pager.h.

Referenced by page_screen_output(), and sync().

m_PAGER

std::string octave::output_system::m_PAGER

private

Definition at line 282 of file pager.h.

Referenced by PAGER(), and pager_command().

m_PAGER_FLAGS

std::string octave::output_system::m_PAGER_FLAGS

private

Definition at line 285 of file pager.h.

Referenced by pager_command(), and PAGER_FLAGS().

m_pager_stream

pager_stream octave::output_system::m_pager_stream

private

Definition at line 268 of file pager.h.

Referenced by __stdout__(), close_diary(), flush_stdout(), open_diary(), pager(), and reset().

m_really_flush_to_pager

bool octave::output_system::m_really_flush_to_pager

private

Definition at line 299 of file pager.h.

Referenced by flush_stdout(), really_flush_to_pager(), and sync().

m_write_to_diary_file

bool octave::output_system::m_write_to_diary_file

private

Definition at line 297 of file pager.h.

Referenced by write_to_diary_file().

---

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

• libinterp/corefcn/pager.h
• libinterp/corefcn/pager.cc