input_crlf Class Reference

#include <crlf.h>

Inheritance diagram for input_crlf:


Public Member Functions
virtual	~input_crlf ()
	input_crlf (input &deeper, bool esc_nl=false)
nstring	name ()
long	length ()
void	keepalive ()
long	read_inner (void *data, size_t nbytes)
long	ftell_inner ()
bool	is_remote () const
Private Member Functions
	input_crlf ()
	input_crlf (const input_crlf &arg)
input_crlf &	operator= (const input_crlf &arg)
Private Attributes
input	deeper
long	pos
long	line_number
bool	prev_was_newline
nstring	name_cache
bool	newlines_may_be_escaped

Detailed Description

The input_crlf class is used to transparently filter CRLF sequences into NL sequences.

Definition at line 29 of file crlf.h.

Constructor & Destructor Documentation

virtual input_crlf::~input_crlf ( ) [virtual]

The destructor.

input_crlf::input_crlf	(	input &	deeper,
		bool	esc_nl = `false`
	)

The constructor.

Parameters:

	deeper	The data source we are to filter.
	esc_nl	true if we are to operate in a mode where \ and \\r\n sequences are to be removed.

input_crlf::input_crlf ( ) [private]

The default constructor. Do not use.

input_crlf::input_crlf ( const input_crlf & arg ) [private]

The copy constructor. Do not use.

Member Function Documentation

nstring input_crlf::name ( ) [virtual]

The name method is used to determine the name of the input.

Implements input_ty.

long input_crlf::length ( ) [virtual]

The length method is used to determine the length of the input. May return -1 if the length is unknown.

Implements input_ty.

void input_crlf::keepalive ( ) [virtual]

The keepalive method is used to set the SO_KEEPALIVE socket option, if the file is a socket. Does nothing otherwise.

Reimplemented from input_ty.

long input_crlf::read_inner	(	void *	data,
		size_t	nbytes
	)			`[virtual]`

The read_inner method is used to read unbuffered data from the given input stream. At most nbytes bytes will be read into data. The number of bytes actually read will be returned. At end-of-file, a value <= 0 will be returned, and data will be unchanged. All file read errors or format errors are fatal, and will cause the method to not return.

Parameters:

	data	Where to put the results of the read.
	nbytes	The maximum number of bytes to read.

Returns:: The actual number of bytes read, or zero for end-of-file.

Implements input_ty.

long input_crlf::ftell_inner ( ) [virtual]

The ftell_inner method is used to determine the unbuffered current position within the input.

Implements input_ty.

bool input_crlf::is_remote ( ) const [virtual]

The is_remote method is used to determine whether or not an input stream is from a local file or a remote source. This is only intended to be a generally informative thing, to provide information to the user, it isn't (and can't be) utterly precise.

Reimplemented from input_ty.

input_crlf& input_crlf::operator= ( const input_crlf & arg ) [private]