Back to index

lightning-sunbird  0.9+nobinonly
nsUint8Array.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is mozilla.org code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corp.
00018  * Portions created by the Initial Developer are Copyright (C) 1995
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #ifndef _nsUint8Array_H_
00038 #define _nsUint8Array_H_
00039 
00040 #include "nscore.h"
00041 #include "nsCRT.h"
00042 #include "prmem.h"
00043 #include "msgCore.h"
00044 
00045 class NS_MSG_BASE nsUint8Array 
00046 {
00047 
00048 public:
00049 
00050 // Construction
00051        nsUint8Array();
00052 
00053 // Attributes
00054        PRInt32 GetSize() const;
00055        PRInt32 GetUpperBound() const;
00056        void SetSize(PRInt32 nNewSize, PRInt32 nGrowBy = -1);
00057   void AllocateSpace(PRUint32 nNewSize) { if (nNewSize == 0) return; PRInt32 saveSize = m_nSize; SetSize(nNewSize); m_nSize = saveSize;};
00058 
00059 // Operations
00060        // Clean up
00061        void FreeExtra();
00062        void RemoveAll();
00063 
00064        // Accessing elements
00065        PRUint8 GetAt(PRInt32 nIndex) const;
00066        void SetAt(PRInt32 nIndex, PRUint8 newElement);
00067        PRUint8& ElementAt(PRInt32 nIndex);
00068 
00069        // Potentially growing the array
00070        void SetAtGrow(PRInt32 nIndex, PRUint8 newElement);
00071        PRInt32 Add(PRUint8 newElement);
00072 
00073        // overloaded operator helpers
00074        PRUint8 operator[](PRInt32 nIndex) const;
00075        PRUint8& operator[](PRInt32 nIndex);
00076 
00077        // Operations that move elements around
00078        nsresult InsertAt(PRInt32 nIndex, PRUint8 newElement, PRInt32 nCount = 1);
00079        void RemoveAt(PRInt32 nIndex, PRInt32 nCount = 1);
00080        nsresult InsertAt(PRInt32 nStartIndex, nsUint8Array* pNewArray);
00081        void CopyArray(nsUint8Array &aSrcArray);
00082 
00083        // use carefully!
00084        PRUint8*                           GetArray(void) {return((PRUint8*)m_pData);}             // only valid until another function called on the array (like GetBuffer() in CString)
00085 
00086 // Implementation
00087 protected:
00088        PRUint8* m_pData;   // the actual array of data
00089        PRInt32 m_nSize;     // # of elements (upperBound - 1)
00090        PRInt32 m_nMaxSize;  // max allocated
00091        PRInt32 m_nGrowBy;   // grow amount
00092 
00093 public:
00094        ~nsUint8Array();
00095 
00096 #ifdef _DEBUG
00097        void AssertValid() const;
00098 #endif
00099 
00100 };
00101 
00102 #endif