widget/src/xpwidgets/nsPrimitiveHelpers.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Communicator.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corp.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Mike Pinkerton
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef nsPrimitiveHelpers_h___
  41 #define nsPrimitiveHelpers_h___
  42
  43 #include "prtypes.h"
  44 #include "nsError.h"
  45 #include "nscore.h"
  46
  47 class nsISupports;
  48
  49
  50 class nsPrimitiveHelpers
  51 {
  52 public:
  53
  54     // Given some data and the flavor it corresponds to, creates the appropriate
  55     // nsISupports* wrapper for passing across IDL boundaries. The length parameter
  56     // should not include the null if the data is null terminated.
  57   static void CreatePrimitiveForData ( const char* aFlavor, void* aDataBuff,
  58                                          PRUint32 aDataLen, nsISupports** aPrimitive ) ;
  59
  60     // Given a nsISupports* primitive and the flavor it represents, creates a new data
  61     // buffer with the data in it. This data will be null terminated, but the length
  62     // parameter does not reflect that.
  63   static void CreateDataFromPrimitive ( const char* aFlavor, nsISupports* aPrimitive,
  64                                          void** aDataBuff, PRUint32 aDataLen ) ;
  65
  66     // Given a unicode buffer (flavor text/unicode), this converts it to plain text using
  67     // the appropriate platform charset encoding. |inUnicodeLen| is the length of the input
  68     // string, not the # of bytes in the buffer. |outPlainTextData| is null terminated,
  69     // but its length parameter, |outPlainTextLen|, does not reflect that.
  70   static nsresult ConvertUnicodeToPlatformPlainText ( PRUnichar* inUnicode, PRInt32 inUnicodeLen,
  71                                                     char** outPlainTextData, PRInt32* outPlainTextLen ) ;
  72
  73     // Given a char buffer (flavor text/plaikn), this converts it to unicode using
  74     // the appropriate platform charset encoding. |outUnicode| is null terminated,
  75     // but its length parameter, |outUnicodeLen|, does not reflect that. |outUnicodeLen| is
  76     // the length of the string in characters, not bytes.
  77   static nsresult ConvertPlatformPlainTextToUnicode ( const char* inText, PRInt32 inTextLen,
  78                                                     PRUnichar** outUnicode, PRInt32* outUnicodeLen ) ;
  79
  80 }; // class nsPrimitiveHelpers
  81
  82
  83
  84 class nsLinebreakHelpers
  85 {
  86 public:
  87
  88     // Given some data, convert from the platform linebreaks into the LF expected by the
  89     // DOM. This will attempt to convert the data in place, but the buffer may still need to
  90     // be reallocated regardless (disposing the old buffer is taken care of internally, see
  91     // the note below).
  92     //
  93     // NOTE: this assumes that it can use nsMemory to dispose of the old buffer.
  94   static nsresult ConvertPlatformToDOMLinebreaks ( const char* inFlavor, void** ioData, PRInt32* ioLengthInBytes ) ;
  95
  96 }; // class nsLinebreakHelpers
  97
  98
  99 #endif // nsPrimitiveHelpers_h___