Back to index

lightning-sunbird  0.9+nobinonly
nsPrimitiveHelpers.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is Mozilla Communicator.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corp.
00020  * Portions created by the Initial Developer are Copyright (C) 1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Mike Pinkerton
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #ifndef nsPrimitiveHelpers_h___
00041 #define nsPrimitiveHelpers_h___
00042 
00043 #include "prtypes.h"
00044 #include "nsError.h"
00045 #include "nscore.h"
00046 
00047 class nsISupports;
00048 
00049 
00050 class nsPrimitiveHelpers
00051 {
00052 public:
00053 
00054     // Given some data and the flavor it corresponds to, creates the appropriate
00055     // nsISupports* wrapper for passing across IDL boundaries. The length parameter
00056     // should not include the null if the data is null terminated.
00057   static void CreatePrimitiveForData ( const char* aFlavor, void* aDataBuff, 
00058                                          PRUint32 aDataLen, nsISupports** aPrimitive ) ;
00059 
00060     // Given a nsISupports* primitive and the flavor it represents, creates a new data
00061     // buffer with the data in it. This data will be null terminated, but the length
00062     // parameter does not reflect that.
00063   static void CreateDataFromPrimitive ( const char* aFlavor, nsISupports* aPrimitive, 
00064                                          void** aDataBuff, PRUint32 aDataLen ) ;
00065 
00066     // Given a unicode buffer (flavor text/unicode), this converts it to plain text using
00067     // the appropriate platform charset encoding. |inUnicodeLen| is the length of the input
00068     // string, not the # of bytes in the buffer. |outPlainTextData| is null terminated, 
00069     // but its length parameter, |outPlainTextLen|, does not reflect that.
00070   static nsresult ConvertUnicodeToPlatformPlainText ( PRUnichar* inUnicode, PRInt32 inUnicodeLen, 
00071                                                     char** outPlainTextData, PRInt32* outPlainTextLen ) ;
00072 
00073     // Given a char buffer (flavor text/plaikn), this converts it to unicode using
00074     // the appropriate platform charset encoding. |outUnicode| is null terminated, 
00075     // but its length parameter, |outUnicodeLen|, does not reflect that. |outUnicodeLen| is
00076     // the length of the string in characters, not bytes.
00077   static nsresult ConvertPlatformPlainTextToUnicode ( const char* inText, PRInt32 inTextLen, 
00078                                                     PRUnichar** outUnicode, PRInt32* outUnicodeLen ) ;
00079 
00080 }; // class nsPrimitiveHelpers
00081 
00082 
00083 
00084 class nsLinebreakHelpers
00085 {
00086 public:
00087 
00088     // Given some data, convert from the platform linebreaks into the LF expected by the
00089     // DOM. This will attempt to convert the data in place, but the buffer may still need to
00090     // be reallocated regardless (disposing the old buffer is taken care of internally, see
00091     // the note below).
00092     //
00093     // NOTE: this assumes that it can use nsMemory to dispose of the old buffer.
00094   static nsresult ConvertPlatformToDOMLinebreaks ( const char* inFlavor, void** ioData, PRInt32* ioLengthInBytes ) ;
00095 
00096 }; // class nsLinebreakHelpers
00097 
00098 
00099 #endif // nsPrimitiveHelpers_h___