mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 08:35:26 +00:00
112 lines
4.4 KiB
C++
112 lines
4.4 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.0 (the "NPL"); you may not use this file except in
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
* for the specific language governing rights and limitations under the
|
|
* NPL.
|
|
*
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1999 Netscape Communications Corporation. All Rights
|
|
* Reserved.
|
|
*/
|
|
#ifndef _nsMsgLineBuffer_H
|
|
#define _nsMsgLineBuffer_H
|
|
|
|
#include "msgCore.h" // precompiled header...
|
|
|
|
// I can't believe I have to have this stupid class, but I can't find
|
|
// anything suitable (nsStrImpl might be, when its done). nsIByteBuffer
|
|
// would do, if I had a stream for input, which I don't.
|
|
|
|
class NS_MSG_BASE nsByteArray
|
|
{
|
|
public:
|
|
nsByteArray();
|
|
virtual ~nsByteArray();
|
|
PRUint32 GetSize() {return m_bufferSize;}
|
|
PRUint32 GetBufferPos() {return m_bufferPos;}
|
|
nsresult GrowBuffer(PRUint32 desired_size, PRUint32 quantum = 1024);
|
|
nsresult AppendString(const char *string);
|
|
nsresult AppendBuffer(const char *buffer, PRUint32 length);
|
|
void ResetWritePos() {m_bufferPos = 0;}
|
|
char *GetBuffer() {return m_buffer;}
|
|
protected:
|
|
char *m_buffer;
|
|
PRUint32 m_bufferSize;
|
|
PRUint32 m_bufferPos; // write Pos in m_buffer - where the next byte should go.
|
|
};
|
|
|
|
|
|
class NS_MSG_BASE nsMsgLineBufferHandler : public nsByteArray
|
|
{
|
|
public:
|
|
virtual PRInt32 HandleLine(char *line, PRUint32 line_length) = 0;
|
|
};
|
|
|
|
class NS_MSG_BASE nsMsgLineBuffer : public nsByteArray
|
|
{
|
|
public:
|
|
nsMsgLineBuffer(nsMsgLineBufferHandler *handler, PRBool convertNewlinesP);
|
|
|
|
virtual ~nsMsgLineBuffer();
|
|
PRInt32 BufferInput(const char *net_buffer, PRInt32 net_buffer_size);
|
|
// Not sure why anyone cares, by NNTPHost seems to want to know the buf pos.
|
|
PRUint32 GetBufferPos() {return m_bufferPos;}
|
|
|
|
virtual PRInt32 HandleLine(char *line, PRUint32 line_length);
|
|
// flush last line, though it won't be CRLF terminated.
|
|
virtual PRInt32 FlushLastLine();
|
|
protected:
|
|
nsMsgLineBuffer(PRBool convertNewlinesP);
|
|
|
|
PRInt32 ConvertAndSendBuffer();
|
|
|
|
nsMsgLineBufferHandler *m_handler;
|
|
PRBool m_convertNewlinesP;
|
|
};
|
|
|
|
// I'm adding this utility class here for lack of a better place. This utility class is similar to nsMsgLineBuffer
|
|
// except it works from an input stream. It is geared towards efficiently parsing new lines out of a stream by storing
|
|
// read but unprocessed bytes in a buffer. I envision the primary use of this to be our mail protocols such as imap, news and
|
|
// pop which need to process line by line data being returned in the form of a proxied stream from the server.
|
|
|
|
class nsIInputStream;
|
|
|
|
class NS_MSG_BASE nsMsgLineStreamBuffer
|
|
{
|
|
public:
|
|
// aBufferSize -- size of the buffer you want us to use for buffering stream data
|
|
// aEndOfLinetoken -- The delimeter string to be used for determining the end of line. This
|
|
// allows us to parse platform specific end of line endings by making it
|
|
// a parameter.
|
|
// aAllocateNewLines -- PR_TRUE if you want calls to ReadNextLine to allocate new memory for the line.
|
|
// if false, the char * returned is just a ptr into the buffer. Subsequent calls to
|
|
// ReadNextLine will alter the data so your ptr only has a life time of a per call.
|
|
// aEatCRLFs -- PR_TRUE if you don't want to see the CRLFs on the lines returned by ReadNextLine.
|
|
// PR_FALSE if you do want to see them.
|
|
nsMsgLineStreamBuffer(PRUint32 aBufferSize, const char * aEndOfLineToken, PRBool aAllocateNewLines, PRBool aEatCRLFs = PR_TRUE); // specify the size of the buffer you want the class to use....
|
|
virtual ~nsMsgLineStreamBuffer();
|
|
|
|
// Caller must free the line returned using PR_Free
|
|
// aEndOfLinetoken -- delimeter used to denote the end of a line.
|
|
// aNumBytesInLine -- The number of bytes in the line returned
|
|
// aPauseForMoreData -- There is not enough data in the stream to make a line at this time...
|
|
char * ReadNextLine(nsIInputStream * aInputStream, PRUint32 &anumBytesInLine, PRBool &aPauseForMoreData);
|
|
protected:
|
|
PRBool m_eatCRLFs;
|
|
PRBool m_allocateNewLines;
|
|
char * m_dataBuffer;
|
|
char * m_startPos;
|
|
const char * m_endOfLineToken;
|
|
PRUint32 m_dataBufferSize;
|
|
};
|
|
|
|
|
|
#endif
|