2001-09-29 00:14:13 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
|
1999-08-10 23:18:39 +04:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* The contents of this file are subject to the Netscape Public License
|
|
|
|
* Version 1.1 (the "License"); you may not use this file except in
|
|
|
|
* compliance with the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/NPL/
|
1999-08-10 23:18:39 +04:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
1999-08-10 23:18:39 +04:00
|
|
|
*
|
1999-11-06 06:43:54 +03:00
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
1999-11-06 06:43:54 +03:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the NPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the NPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
1999-08-10 23:18:39 +04:00
|
|
|
|
|
|
|
#ifndef nsSegmentedBuffer_h__
|
|
|
|
#define nsSegmentedBuffer_h__
|
|
|
|
|
2000-06-03 13:46:12 +04:00
|
|
|
#include "nsMemory.h"
|
1999-08-10 23:18:39 +04:00
|
|
|
#include "prclist.h"
|
|
|
|
|
|
|
|
class nsSegmentedBuffer
|
|
|
|
{
|
|
|
|
public:
|
2003-03-15 04:04:32 +03:00
|
|
|
nsSegmentedBuffer()
|
|
|
|
: mSegmentSize(0), mMaxSize(0),
|
|
|
|
mSegAllocator(nsnull), mSegmentArray(nsnull),
|
|
|
|
mSegmentArrayCount(0),
|
|
|
|
mFirstSegmentIndex(0), mLastSegmentIndex(0) {}
|
1999-08-10 23:18:39 +04:00
|
|
|
|
2003-03-15 04:04:32 +03:00
|
|
|
~nsSegmentedBuffer() {
|
|
|
|
Empty();
|
|
|
|
NS_IF_RELEASE(mSegAllocator);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
NS_COM nsresult Init(PRUint32 segmentSize, PRUint32 maxSize,
|
2000-06-03 13:46:12 +04:00
|
|
|
nsIMemory* allocator = nsnull);
|
1999-08-24 12:45:17 +04:00
|
|
|
|
2003-03-15 04:04:32 +03:00
|
|
|
NS_COM char* AppendNewSegment(); // pushes at end
|
1999-08-10 23:18:39 +04:00
|
|
|
|
|
|
|
// returns true if no more segments remain:
|
|
|
|
PRBool DeleteFirstSegment(); // pops from beginning
|
|
|
|
|
1999-11-16 22:12:41 +03:00
|
|
|
// returns true if no more segments remain:
|
|
|
|
PRBool DeleteLastSegment(); // pops from beginning
|
|
|
|
|
|
|
|
// Call Realloc() on last segment. This is used to reduce memory
|
|
|
|
// consumption when data is not an exact multiple of segment size.
|
|
|
|
PRBool ReallocLastSegment(size_t newSize);
|
|
|
|
|
2003-03-15 04:04:32 +03:00
|
|
|
NS_COM void Empty(); // frees all segments
|
1999-08-10 23:18:39 +04:00
|
|
|
|
2003-03-15 04:04:32 +03:00
|
|
|
NS_COM PRUint32 GetSegmentCount() {
|
1999-08-10 23:18:39 +04:00
|
|
|
if (mFirstSegmentIndex <= mLastSegmentIndex)
|
|
|
|
return mLastSegmentIndex - mFirstSegmentIndex;
|
|
|
|
else
|
|
|
|
return mSegmentArrayCount + mLastSegmentIndex - mFirstSegmentIndex;
|
|
|
|
}
|
|
|
|
|
2003-03-15 04:04:32 +03:00
|
|
|
NS_COM PRUint32 GetSegmentSize() { return mSegmentSize; }
|
2003-01-18 05:15:14 +03:00
|
|
|
PRUint32 GetMaxSize() { return mMaxSize; }
|
1999-08-10 23:18:39 +04:00
|
|
|
PRUint32 GetSize() { return GetSegmentCount() * mSegmentSize; }
|
|
|
|
|
2003-03-15 04:04:32 +03:00
|
|
|
NS_COM char* GetSegment(PRUint32 indx) {
|
2002-10-01 01:49:35 +04:00
|
|
|
NS_ASSERTION(indx < GetSegmentCount(), "index out of bounds");
|
1999-10-09 00:41:19 +04:00
|
|
|
PRInt32 i = ModSegArraySize(mFirstSegmentIndex + (PRInt32)indx);
|
1999-08-10 23:18:39 +04:00
|
|
|
return mSegmentArray[i];
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
PRInt32 ModSegArraySize(PRInt32 n) {
|
|
|
|
PRUint32 result = n & (mSegmentArrayCount - 1);
|
|
|
|
NS_ASSERTION(result == n % mSegmentArrayCount,
|
|
|
|
"non-power-of-2 mSegmentArrayCount");
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
1999-11-16 22:12:41 +03:00
|
|
|
PRBool IsFull() {
|
1999-08-10 23:18:39 +04:00
|
|
|
return ModSegArraySize(mLastSegmentIndex + 1) == mFirstSegmentIndex;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
PRUint32 mSegmentSize;
|
|
|
|
PRUint32 mMaxSize;
|
2000-06-03 13:46:12 +04:00
|
|
|
nsIMemory* mSegAllocator;
|
1999-08-10 23:18:39 +04:00
|
|
|
char** mSegmentArray;
|
|
|
|
PRUint32 mSegmentArrayCount;
|
|
|
|
PRInt32 mFirstSegmentIndex;
|
|
|
|
PRInt32 mLastSegmentIndex;
|
|
|
|
};
|
|
|
|
|
|
|
|
// NS_SEGMENTARRAY_INITIAL_SIZE: This number needs to start out as a
|
|
|
|
// power of 2 given how it gets used. We double the segment array
|
|
|
|
// when we overflow it, and use that fact that it's a power of 2
|
|
|
|
// to compute a fast modulus operation in IsFull.
|
|
|
|
//
|
|
|
|
// 32 segment array entries can accommodate 128k of data if segments
|
|
|
|
// are 4k in size. That seems like a reasonable amount that will avoid
|
|
|
|
// needing to grow the segment array.
|
|
|
|
#define NS_SEGMENTARRAY_INITIAL_COUNT 32
|
|
|
|
|
|
|
|
#endif // nsSegmentedBuffer_h__
|