The JShell clas can be used to interact with the shell via I/O streams. More...

#include <JShell.hh>

Inheritance diagram for JSYSTEM::JShell:

Public Member Functions
	JShell (const std::size_t size=65536)
	Constructor.

	~JShell ()
	Destructor.

const std::string &	getPrompt () const
	Get prompt.

template<class T >
bool	get (T &value)
	Get value.

bool	getline (std::string &buffer, const char eol='\n')
	Get line of text.

JShell &	flush (std::ostream &out=null)
	Extracts characters from this shell and flush them to the given output stream until the prompt is read.

virtual bool	getStatus () const override
	Get status of this shell.

void	exit ()
	Exit this shell.

JFileInputStreamBuffer *	getInputStreamBuffer (const std::size_t size=65536)
	Get pointer to input stream buffer connected to the normal output stream.

JFileInputStreamBuffer *	getErrorStreamBuffer (const std::size_t size=65536)
	Get pointer to input stream buffer connected to the error output stream.

JFileOutputStreamBuffer *	getOutputStreamBuffer (const std::size_t size=65536)
	Get pointer to output stream buffer connected to the normal input stream.

	operator bool () const
	Type conversion operator.

bool	operator! () const
	Negated status of this object.

Static Public Member Functions
static JShell &	getInstance ()
	Get reference to unique instance of this class object.

Protected Types
typedef traits_type::int_type	int_type

typedef traits_type::int_type	int_type

typedef std::streamsize	streamsize

Protected Member Functions
void	execute (const char path, const char arg0, const char arg1=(char ) NULL, const char arg2=(char ) NULL, const char arg3=(char ) NULL, const char arg4=(char ) NULL, const char arg5=(char ) NULL, const char arg6=(char ) NULL, const char arg7=(char ) NULL, const char arg8=(char ) NULL, const char arg9=(char ) NULL)
	Execute command.

virtual int_type	underflow () override
	Check underflow.

bool	in_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of input.

virtual int_type	overflow (int_type c) override
	Check overflow.

virtual int	sync () override
	Synchronise buffer.

bool	out_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of output.

int	flush ()
	Flush internal buffer.

Protected Attributes
std::string	prompt

int	out

int	err

int	in

JFile	in

std::size_t	memory

JFile	out

Private Member Functions
	JShell (const JShell &)

	JShell (JShell &&)

JShell &	operator= (const JShell &)

JShell &	operator= (JShell &&)

Private Attributes
JFileInputStreamBuffer *	gOut

JFileInputStreamBuffer *	gErr

JFileOutputStreamBuffer *	gIn

Detailed Description

The JShell clas can be used to interact with the shell via I/O streams.

Definition at line 32 of file JShell.hh.

Member Typedef Documentation

◆ int_type [1/2]

traits_type::int_type JLANG::JFileInputStreamBuffer::int_type

inherited

Definition at line 32 of file JFileStreamBuffer.hh.

◆ int_type [2/2]

traits_type::int_type JLANG::JFileOutputStreamBuffer::int_type

inherited

Definition at line 121 of file JFileStreamBuffer.hh.

◆ streamsize

std::streamsize JLANG::JFileOutputStreamBuffer::streamsize

inherited

Definition at line 122 of file JFileStreamBuffer.hh.

Constructor & Destructor Documentation

◆ JShell() [1/3]

JSYSTEM::JShell::JShell ( const std::size_t size = 65536 )

inline

Constructor.

Parameters

size	size of internal buffer

Definition at line 47 of file JShell.hh.

                                          :
      JProcess(),
      JFileStream(JProcess::out, JProcess::in, size)
    {
      using namespace std;
 
      prompt = "_abc321_";
 
      static_cast<ostream&>(*this) << "set prompt=" << prompt << endl;
      static_cast<ostream&>(*this) << "echo hello"            << endl;
 
      flush();
    }

◆ ~JShell()

JSYSTEM::JShell::~JShell ( )

inline

Destructor.

Definition at line 65 of file JShell.hh.

    {
      this->exit();
    }

◆ JShell() [2/3]

JSYSTEM::JShell::JShell ( const JShell & )

private

◆ JShell() [3/3]

JSYSTEM::JShell::JShell ( JShell && )

private

Member Function Documentation

◆ getInstance()

static JShell & JSYSTEM::JShell::getInstance ( )

inlinestatic

Get reference to unique instance of this class object.

Returns: reference to this class object

Definition at line 76 of file JShell.hh.

    {
      static JShell shell;
 
      return shell;
    }

◆ getPrompt()

const std::string & JSYSTEM::JShell::getPrompt ( ) const

inline

Get prompt.

Returns: prompt

Definition at line 89 of file JShell.hh.

    {
      return prompt;
    }

◆ get()

template<class T >

bool JSYSTEM::JShell::get ( T & value )

inline

Get value.

Note that

in case of success, the input stream is flushed; and
in case of failure, the input stream is cleared and flushed.

Parameters

value value

Returns: true if valid; else false

Definition at line 106 of file JShell.hh.

    {
      using namespace std;
 
      if (*this >> value) {
 
        this->flush();
 
        return true;
 
      } else {
 
        static_cast<istream&>(*this).clear();
 
        this->flush();
 
        return false;
      }
    }

◆ getline()

bool JSYSTEM::JShell::getline	(	std::string &	buffer,
		const char	eol = '\n' )

inline

Get line of text.

Extracts characters from this shell and stores them into the given buffer until the end of line character is found or the prompt is read.

Parameters

buffer	buffer
eol	end of line character

Returns: true if valid; else false

Definition at line 137 of file JShell.hh.

    {
      using namespace std;
 
      buffer.clear();
 
      while (this->getStatus()) {
 
        const int c = this->get();
 
        if        (c == streambuf::traits_type::eof()) {
          
          return !buffer.empty();
 
        } else if (c == eol) {
          
          return true;
          
        } else {
          
          buffer += (char) c;
 
          if (buffer.size() >= prompt.size()) {
 
            const size_t pos = buffer.size() - this->prompt.size();
          
            if (buffer.substr(pos) == this->prompt) {
 
              buffer.erase(pos);
 
              return !buffer.empty();
            }
          }
        }
      }
 
      return false;
    }

◆ flush() [1/2]

JShell & JSYSTEM::JShell::flush ( std::ostream & out = null )

inline

Extracts characters from this shell and flush them to the given output stream until the prompt is read.

Parameters

out	output stream

Returns: this shell

Definition at line 184 of file JShell.hh.

    {
      using namespace std;
 
      for (string buffer; this->getline(buffer); ) {
        out << buffer << endl;
      }
 
      return *this;
    }

◆ getStatus()

virtual bool JSYSTEM::JShell::getStatus ( ) const

inlineoverridevirtual

Get status of this shell.

Returns: status of this shell

Implements JLANG::JAbstractObjectStatus.

Definition at line 201 of file JShell.hh.

    { 
      return ((bool) static_cast<const std::ostream&>(*this) && 
              (bool) static_cast<const std::istream&>(*this));
    }

◆ exit()

void JSYSTEM::JShell::exit ( )

inline

Exit this shell.

Definition at line 211 of file JShell.hh.

    { 
      using namespace std;
 
      static_cast<ostream&>(*this) << "exit" << endl;
    }

◆ operator=() [1/2]

JShell & JSYSTEM::JShell::operator= ( const JShell & )

private

◆ operator=() [2/2]

JShell & JSYSTEM::JShell::operator= ( JShell && )

private

◆ getInputStreamBuffer()

JFileInputStreamBuffer * JSYSTEM::JProcess::getInputStreamBuffer ( const std::size_t size = 65536 )

inlineinherited

Get pointer to input stream buffer connected to the normal output stream.

Parameters

size	size of internal buffers

Returns: pointer input stream buffer

Definition at line 86 of file JProcess.hh.

    {
      if (gOut == NULL) {
        gOut = new JFileInputStreamBuffer(out, size);
      }
 
      return gOut;
    }

◆ getErrorStreamBuffer()

JFileInputStreamBuffer * JSYSTEM::JProcess::getErrorStreamBuffer ( const std::size_t size = 65536 )

inlineinherited

Get pointer to input stream buffer connected to the error output stream.

Parameters

size	size of internal buffers

Returns: pointer to input stream buffer

Definition at line 102 of file JProcess.hh.

    {
      if (gErr == NULL) {
        gErr = new JFileInputStreamBuffer(err, size);
      }
 
      return gErr;
    }

◆ getOutputStreamBuffer()

JFileOutputStreamBuffer * JSYSTEM::JProcess::getOutputStreamBuffer ( const std::size_t size = 65536 )

inlineinherited

Get pointer to output stream buffer connected to the normal input stream.

Parameters

size	size of internal buffers

Returns: pointer to output stream buffer

Definition at line 118 of file JProcess.hh.

    {
      if (gIn == NULL) {
        gIn = new JFileOutputStreamBuffer(in, size);
      }
 
      return gIn;
    }

◆ execute()

void JSYSTEM::JProcess::execute	(	const char *	path,
		const char *	arg0,
		const char *	arg1 = (char*) NULL,
		const char *	arg2 = (char*) NULL,
		const char *	arg3 = (char*) NULL,
		const char *	arg4 = (char*) NULL,
		const char *	arg5 = (char*) NULL,
		const char *	arg6 = (char*) NULL,
		const char *	arg7 = (char*) NULL,
		const char *	arg8 = (char*) NULL,
		const char *	arg9 = (char*) NULL )

inlineprotectedinherited

Execute command.

Parameters

path	path
arg0	comma separted argument list
arg1	comma separted argument list
arg2	comma separted argument list
arg3	comma separted argument list
arg4	comma separted argument list
arg5	comma separted argument list
arg6	comma separted argument list
arg7	comma separted argument list
arg8	comma separted argument list
arg9	comma separted argument list

Definition at line 143 of file JProcess.hh.

    {
      int pipe_stdin [2];
      int pipe_stdout[2];
      int pipe_stderr[2];
 
      if (pipe(pipe_stdin))  { THROW(JPipeOpenException, "Error at pipe of standard input.");  }
      if (pipe(pipe_stdout)) { THROW(JPipeOpenException, "Error at pipe of standard output."); }
      if (pipe(pipe_stderr)) { THROW(JPipeOpenException, "Error at pipe of standard error.");  }
      
      const pid_t pid = fork();
 
      if (pid < 0) 
 
        // error
 
        THROW(JForkException, "JProcess::fork() failed");
 
      else if (pid == 0) {
 
        // child
 
        close(pipe_stdin [1]);
        if (dup2 (pipe_stdin [0], STDIN_FILENO)  == -1) { JSystemException("dup2-stdin"); }
 
        close(pipe_stdout[0]);
        if (dup2 (pipe_stdout[1], STDOUT_FILENO) == -1) { JSystemException("dup2-stdout"); }
 
        close(pipe_stdout[0]);
        if (dup2 (pipe_stdout[1], STDERR_FILENO) == -1) { JSystemException("dup2-stderr"); }
 
        execl(path, arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, (char*) NULL);
 
        THROW(JSystemException, path);
 
      } else {
 
        // parent
 
        in  = pipe_stdin [1];
        out = pipe_stdout[0];
        err = pipe_stderr[0];
 
        close(pipe_stdin [0]);
        close(pipe_stdout[1]);
        close(pipe_stderr[1]);
      }
    }

◆ underflow()

virtual int_type JLANG::JFileInputStreamBuffer::underflow ( )

inlineoverridevirtualinherited

Check underflow.

This method reads as many bytes as possible.

Returns: first character if OK; else EOF

Definition at line 60 of file JFileStreamBuffer.hh.

    {   
      if (gptr() >= egptr()) {
 
        char* __begin = this->data();
 
        if (eback() == __begin) { 
          
          // push put back characters
 
          memmove(__begin, egptr() - memory, memory);
        
          __begin += memory;
        }
        
        const size_t len = in.read(__begin, this->size() - (__begin - this->data()));
        
        if (len != 0)
          setg(this->data(), __begin, __begin + len);
        else
          return traits_type::eof();
      }
        
      return *gptr();
    } 

◆ in_avail()

bool JLANG::JFileInputStreamBuffer::in_avail ( JTimeval timeout = JTimeval::min() ) const

inlineinherited

Check availability of input.

This method returns true if at least one byte can be read without blocking.

Parameters

timeout timeout

Returns: true if ready to read; else false

Definition at line 94 of file JFileStreamBuffer.hh.

    {
      return JFileDescriptorMask(in).in_avail(timeout);
    }

◆ overflow()

virtual int_type JLANG::JFileOutputStreamBuffer::overflow ( int_type c )

inlineoverridevirtualinherited

Check overflow.

This method writes one byte if possible.

Parameters

c character

Returns: c if OK; else EOF

Definition at line 159 of file JFileStreamBuffer.hh.

    {
      if (c != traits_type::eof()) {
 
        *pptr() = (char) c;
 
        pbump(1);
 
        if (flush() == traits_type::eof()) {
          return traits_type::eof();
        }
      }
 
      return c;
    }

◆ sync()

virtual int JLANG::JFileOutputStreamBuffer::sync ( )

inlineoverridevirtualinherited

Synchronise buffer.

Definition at line 179 of file JFileStreamBuffer.hh.

    {
      if (flush() == traits_type::eof())
        return -1;
      else
        return  0;
    }

◆ out_avail()

bool JLANG::JFileOutputStreamBuffer::out_avail ( JTimeval timeout = JTimeval::min() ) const

inlineinherited

Check availability of output.

This method returns true if at least one byte can be written without blocking.

Parameters

timeout timeout

Returns: true if ready to write; else false

Definition at line 195 of file JFileStreamBuffer.hh.

    {
      return JFileDescriptorMask(out).out_avail(timeout);
    }

◆ flush() [2/2]

int JLANG::JFileOutputStreamBuffer::flush ( )

inlineprotectedinherited

Flush internal buffer.

Definition at line 204 of file JFileStreamBuffer.hh.

    {
      const int len = pptr() - pbase();
      
      if (len != 0) {
 
        if (out.write(this->data(), len) != len) {
          return traits_type::eof();
        }
 
        pbump(-len);
      }
 
      return len;
    }

◆ operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const

inlineinherited

Type conversion operator.

Returns: status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

    {
      return this->getStatus();
    }

◆ operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const

inlineinherited

Negated status of this object.

Returns: negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

    {
      return !(this->getStatus());
    }

Member Data Documentation

◆ prompt

std::string JSYSTEM::JShell::prompt

protected

Definition at line 220 of file JShell.hh.

◆ out [1/2]

int JSYSTEM::JProcess::out

protectedinherited

Definition at line 202 of file JProcess.hh.

◆ err

int JSYSTEM::JProcess::err

protectedinherited

Definition at line 203 of file JProcess.hh.

◆ in [1/2]

int JSYSTEM::JProcess::in

protectedinherited

Definition at line 204 of file JProcess.hh.

◆ gOut

JFileInputStreamBuffer* JSYSTEM::JProcess::gOut

privateinherited

Definition at line 207 of file JProcess.hh.

◆ gErr

JFileInputStreamBuffer* JSYSTEM::JProcess::gErr

privateinherited

Definition at line 208 of file JProcess.hh.

◆ gIn

JFileOutputStreamBuffer* JSYSTEM::JProcess::gIn

privateinherited

Definition at line 209 of file JProcess.hh.

◆ in [2/2]

JFile JLANG::JFileInputStreamBuffer::in

protectedinherited

Definition at line 100 of file JFileStreamBuffer.hh.

◆ memory

std::size_t JLANG::JFileInputStreamBuffer::memory

protectedinherited

Definition at line 101 of file JFileStreamBuffer.hh.

◆ out [2/2]

JFile JLANG::JFileOutputStreamBuffer::out

protectedinherited

Definition at line 221 of file JFileStreamBuffer.hh.

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

JShell.hh

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ int_type [1/2]

◆ int_type [2/2]

◆ streamsize

Constructor & Destructor Documentation

◆ JShell() [1/3]

◆ ~JShell()

◆ JShell() [2/3]

◆ JShell() [3/3]

Member Function Documentation

◆ getInstance()

◆ getPrompt()

◆ get()

◆ getline()

◆ flush() [1/2]

◆ getStatus()

◆ exit()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ getInputStreamBuffer()

◆ getErrorStreamBuffer()

◆ getOutputStreamBuffer()

◆ execute()

◆ underflow()

◆ in_avail()

◆ overflow()

◆ sync()

◆ out_avail()

◆ flush() [2/2]

◆ operator bool()

◆ operator!()

Member Data Documentation

◆ prompt

◆ out [1/2]

◆ err

◆ in [1/2]

◆ gOut

◆ gErr

◆ gIn

◆ in [2/2]

◆ memory

◆ out [2/2]