as2js: as2js::DecodingFilter Class Reference

#include <stream.h>

Inheritance diagram for as2js::DecodingFilter:
Public Types typedef unsigned char byte_t   typedef std::vector< byte_tbyte_vector_t   typedef std::shared_ptr< DecodingFilterpointer_t   Public Member Functions virtual ~DecodingFilter ()  Destructor. More...
  as_char_t getc ()  Retrieve the next character. More...
  void putc (byte_t c)  Push one byte in the decoder. More...
  Protected Member Functions virtual as_char_t get_char ()=0   Protected Attributes byte_vector_t f_buffer = byte_vector_t()   Detailed Description

Definition at line 48 of file stream.h.

Member Typedef Documentation
typedef unsigned char as2js::DecodingFilter::byte_t

Definition at line 52 of file stream.h.

Definition at line 53 of file stream.h.

Definition at line 51 of file stream.h.

Constructor & Destructor Documentation
as2js::DecodingFilter::~DecodingFilter ( ) virtual

This is our virtual destructor, which is required to ensure proper clean up of this class and derivatives.

Definition at line 57 of file stream.cpp.

Member Function Documentation
Input::char_t as2js::DecodingFilter::getc ( )

This function retrieves the next input character.

If there is data, but not enough of it, it returns Input::INPUT_NAC. Processing can safely continue.

If possible, the function avoids returning with the Input::INPUT_NAC result (i.e. if a filter returns that value when there is still data available in the buffer, their get_char() function gets called again.)

If there is data, but it cannot properly be converted to a valid character, it returns Input::INPUT_ERR.

If there is no data, then Input::INPUT_EOF is returned.

Returns
The next character available or one of the Input::INPUT_... result (EOF, NAC, ERR).

Definition at line 96 of file stream.cpp.

References f_buffer, get_char(), and as2js::Input::INPUT_EOF.

void as2js::DecodingFilter::putc ( byte_t  c)

This function pushes exactly one byte in the decoder.

In most cases decoders expects their getc() function to be called right after each putc(), although it is not mandatory.

Parameters
[in]cThe character to append to this decoding filter.

Definition at line 71 of file stream.cpp.

References f_buffer.

Member Data Documentation
The documentation for this class was generated from the following files:
  • /home/snapwebsites/snapcpp/contrib/as2js/include/as2js/stream.h
  • /home/snapwebsites/snapcpp/contrib/as2js/lib/stream.cpp

This document is part of the Snap! Websites Project.

Copyright by Made to Order Software Corp.

Syndicate content

Snap! Websites
An Open Source CMS System in C++

Contact Us Directly