xpcom/ds/nsIUnicharBuffer.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37 #ifndef nsIUnicharBuffer_h___
  38 #define nsIUnicharBuffer_h___
  39
  40 #include "nscore.h"
  41 #include "nsISupports.h"
  42
  43 #define NS_IUNICHARBUFFER_IID \
  44 { 0x14cf6970, 0x93b5, 0x11d1, \
  45   {0x89, 0x5b, 0x00, 0x60, 0x08, 0x91, 0x1b, 0x81} }
  46
  47 /// Interface to a buffer that holds unicode characters
  48 class nsIUnicharBuffer : public nsISupports {
  49 public:
  50   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IUNICHARBUFFER_IID)
  51
  52   NS_IMETHOD Init(PRUint32 aBufferSize) = 0;
  53   NS_IMETHOD_(PRInt32) GetLength() const = 0;
  54   NS_IMETHOD_(PRInt32) GetBufferSize() const = 0;
  55   NS_IMETHOD_(PRUnichar*) GetBuffer() const = 0;
  56   NS_IMETHOD_(PRBool) Grow(PRInt32 aNewSize) = 0;
  57 };
  58
  59 NS_DEFINE_STATIC_IID_ACCESSOR(nsIUnicharBuffer, NS_IUNICHARBUFFER_IID)
  60
  61 /// Factory method for nsIUnicharBuffer.
  62 extern NS_COM nsresult
  63 NS_NewUnicharBuffer(nsIUnicharBuffer** aInstancePtrResult,
  64                     nsISupports* aOuter,
  65                     PRUint32 aBufferSize = 0);
  66
  67 #define NS_UNICHARBUFFER_CID                         \
  68 { /* c81fd8f0-0d6b-11d3-9331-00104ba0fd40 */         \
  69     0xc81fd8f0,                                      \
  70     0x0d6b,                                          \
  71     0x11d3,                                          \
  72     {0x93, 0x31, 0x00, 0x10, 0x4b, 0xa0, 0xfd, 0x40} \
  73 }
  74
  75 #endif /* nsIUnicharBuffer_h___ */