FACT++  1.0
ConsoleStream Class Reference

This is an extension to the Readline class provding a colored output. More...

#include <Console.h>

+ Inheritance diagram for ConsoleStream:
+ Collaboration diagram for ConsoleStream:

Public Member Functions

 ConsoleStream (const char *name)
 
 ~ConsoleStream ()
 
void SetNullOutput (bool null)
 
WindowLogGetStreamOut ()
 
WindowLogGetStreamIn ()
 
const WindowLogGetStreamOut () const
 
const WindowLogGetStreamIn () const
 
void Lock ()
 
void Run (const char *=0)
 Just usleep until Stop() was called. More...
 
void Unlock ()
 
- Public Member Functions inherited from Readline
 Readline (const char *prgname)
 
virtual ~Readline ()
 
void BindKeySequence (const char *seq, int(*func)(int, int))
 
virtual bool PrintGeneralHelp ()
 
virtual bool PrintCommands ()
 
virtual bool PrintKeyBindings ()
 
std::string GetName () const
 
void AddToHistory (const std::string &str, int skip=2)
 
std::vector< const char * > GetHistory () const
 Return a list of pointer to the history contents. More...
 
void SetMaxSize (int lines)
 
void UpdatePrompt (const std::string &prompt) const
 
void UpdatePrompt () const
 
virtual bool PreProcess (const std::string &str)
 
virtual bool Process (const std::string &str)
 
virtual std::string GetUpdatePrompt () const
 
virtual bool PromptEOF (std::string &str)
 
virtual std::string Prompt (const std::string &prompt)
 
virtual bool ExecuteShellCommand (const std::string &cmd)
 
int Execute (const std::string &fname, const std::map< std::string, std::string > &args=std::map< std::string, std::string >())
 
bool IsStopped () const
 
void ProcessLine (const std::string &str)
 
void SetLabel (int l)
 
int GetLine () const
 
virtual std::string GetLinePrompt () const
 
int GetCols () const
 Get the number of cols readline assumes the screen size to be. More...
 
int GetRows () const
 Get the number of rows readline assumes the screen size to be. More...
 

Private Member Functions

void PrintReadlineError (const std::string &str)
 

Private Attributes

WindowLog fLogO
 

Additional Inherited Members

- Static Public Member Functions inherited from Readline
static bool RedirectionWrapper (std::ostream &out, bool(*function)())
 
static bool DumpVariables ()
 
static bool DumpFunctions ()
 
static bool DumpFunmap ()
 
static bool DumpHistory ()
 
static bool ClearHistory ()
 
static void Stop ()
 
static void StopScript ()
 
static bool IsScriptStopped ()
 
static int GetScriptDepth ()
 
static void SetScriptDepth (unsigned int d)
 
static void SetExternalInput (const std::string &inp)
 
static std::string GetScript ()
 
static std::string GetExternalInput ()
 
static char * Compare (const std::string &str, const std::string &txt)
 
static char ** CompletionMatches (const char *text, char *(*func)(const char *, int))
 
static FILE * SetStreamOut (FILE *f)
 
static FILE * SetStreamIn (FILE *f)
 
static std::string GetPrompt ()
 
static std::string GetBuffer ()
 
static int GetAbsCursor ()
 return strlen(rl_display_prompt) + rl_point More...
 
static int GetCursor ()
 return rl_point (the current cursor position within the line buffer) More...
 
static int GetBufferLength ()
 
static int GetLineLength ()
 return the length of the prompt plus the length of the line buffer More...
 
static void Resize ()
 
static void Resize (int w, int h)
 
static ReadlineInstance ()
 
static void StaticPushHistory (const std::string &fname)
 
static std::string StaticPrompt (const std::string &prompt)
 
static void StaticPopHistory (const std::string &fname)
 
- Protected Member Functions inherited from Readline
virtual int Getc (FILE *)
 The non static implementations of the callback funtions above. More...
 
virtual void Startup ()
 Default: Do nothing. More...
 
virtual void EventHook (bool newline=false)
 
virtual void Shutdown (const char *buf)
 
virtual void Redisplay ()
 Default: call rl_redisplay() More...
 
virtual void CompletionDisplay (char **matches, int num, int max)
 Default: call rl_completion_display_matches() More...
 
virtual char * Complete (const char *text, int state)
 Functions dealing with auto completion. More...
 
virtual char ** Completion (const char *text, int start, int end)
 
void SetCompletion (const std::vector< std::string > *v)
 
char ** Complete (const std::vector< std::string > &v, const char *text)
 
virtual void SetSection (int)
 
- Protected Attributes inherited from Readline
const std::vector< std::string > * fCompletion
 Pointer to a list of possible matched for auto-completion. More...
 
- Static Protected Attributes inherited from Readline
static ReadlineThis = 0
 
static std::string fScript
 

Detailed Description

This is an extension to the Readline class provding a colored output.

This in an extension to the Readline class. It's purpose is just to have a colored output stream available. It's main idea is that it is used in environments without user interaction as a replacement the Console class. This is interesting to be able to do everything identical as if Console would be used, but Run() does not prompt but just wait until Stop() was called. The advantage is that some functions of Readline can be used like Execute and the history (just for Execute() commands of course)

Definition at line 7 of file Console.h.


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