xpcom/io/nsNativeCharsetUtils.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2002
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Darin Fisher <darin@netscape.com>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * 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
  38 #ifndef nsNativeCharsetUtils_h__
  39 #define nsNativeCharsetUtils_h__
  40
  41
  42 /*****************************************************************************\
  43  *                                                                           *
  44  *                             **** NOTICE ****                              *
  45  *                                                                           *
  46  *             *** THESE ARE NOT GENERAL PURPOSE CONVERTERS ***              *
  47  *                                                                           *
  48  *    NS_CopyNativeToUnicode / NS_CopyUnicodeToNative should only be used    *
  49  *    for converting *FILENAMES* between native and unicode. They are not    *
  50  *    designed or tested for general encoding converter use.                 *
  51  *                                                                           *
  52 \*****************************************************************************/
  53
  54 /**
  55  * thread-safe conversion routines that do not depend on uconv libraries.
  56  */
  57 NS_COM nsresult NS_CopyNativeToUnicode(const nsACString &input, nsAString  &output);
  58 NS_COM nsresult NS_CopyUnicodeToNative(const nsAString  &input, nsACString &output);
  59
  60 /*
  61  * This function indicates whether the character encoding used in the file
  62  * system (more exactly what's used for |GetNativeFoo| and |SetNativeFoo|
  63  * of |nsILocalFile|) is UTF-8 or not. Knowing that helps us avoid an
  64  * unncessary encoding conversion in some cases. For instance, to get the leaf
  65  * name in UTF-8 out of nsILocalFile, we can just use |GetNativeLeafName| rather
  66  * than using |GetLeafName| and converting the result to UTF-8 if the file
  67  * system  encoding is UTF-8.
  68  * On Unix (but not on Mac OS X), it depends on the locale and is not known
  69  * in advance (at the compilation time) so that this function needs to be
  70  * a real function. On Mac OS X and BeOS, it's always UTF-8 while on Windows
  71  * and other platforms (e.g. OS2), it's never UTF-8.
  72  */
  73 #if defined(XP_UNIX) && !defined(XP_MACOSX)
  74 NS_COM PRBool NS_IsNativeUTF8();
  75 #else
  76 inline PRBool NS_IsNativeUTF8()
  77 {
  78 #if defined(XP_MACOSX) || defined(XP_BEOS)
  79     return PR_TRUE;
  80 #else
  81     return PR_FALSE;
  82 #endif
  83 }
  84 #endif
  85
  86
  87 /**
  88  * internal
  89  */
  90 void NS_StartupNativeCharsetUtils();
  91 void NS_ShutdownNativeCharsetUtils();
  92
  93 #endif // nsNativeCharsetUtils_h__