as2js: as2js::StringOutput Class Reference

#include <stream.h>

Inheritance diagram for as2js::StringOutput:
Collaboration diagram for as2js::StringOutput:
Public Types typedef std::shared_ptr< StringOutputpointer_t   Public Member Functions Positionget_position ()  Get the position object of the input object. More...
  Position const & get_position () const  Get the position object of the input object. More...
  String const & get_string () const  Retrieve a copy of the output string. More...
  void write (String const &data)  Write data to this output stream. More...
  Protected Attributes Position f_position = Position()   Private Member Functions virtual void internal_write (String const &data)  Write to the output string. More...
  Private Attributes String f_string = String()   Detailed Description

Definition at line 300 of file stream.h.

Member Typedef Documentation
typedef std::shared_ptr<StringOutput> as2js::StringOutput::pointer_t

Definition at line 304 of file stream.h.

Member Function Documentation
Position & as2js::Output::get_position ( ) inherited

The stream manages a position object. The call can use this function to retrieve a read/write version of the current position.

Returns
A modifiable version of the position object.

Definition at line 825 of file stream.cpp.

References as2js::Input::f_position.

Position const & as2js::Output::get_position ( ) const inherited

The stream manages a position object. The call can use this function to retrieve a read-only version of the current position.

Returns
A constant version of the position object.

Definition at line 838 of file stream.cpp.

References as2js::Input::f_position.

String const & as2js::StringOutput::get_string ( ) const

This function is used to retrieve the output string used as a buffer each time the write() function is called.

Returns
A reference to the internal string.

Definition at line 980 of file stream.cpp.

void as2js::StringOutput::internal_write ( String const &  data) privatevirtual

This function writes the specified data string to this output string.

Parameters
[in]dataThe string to write to the output file.

Implements as2js::Output.

Definition at line 992 of file stream.cpp.

void as2js::Output::write ( String const &  data) inherited

This function writes the specified string to the output stream. Since we pretty much only support text based files, we just use this format.

All outputs are done in UTF-8.

If the function cannot write to the destination, then it throws an error.

Parameters
[in]dataThe string to be written to the output stream.

Definition at line 857 of file stream.cpp.

Member Data Documentation
Position as2js::Output::f_position = Position() protectedinherited

Definition at line 268 of file stream.h.

String as2js::StringOutput::f_string = String() private

Definition at line 311 of file stream.h.


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