xpcom/io/nsNativeCharsetUtils.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsNativeCharsetUtils_h__
   8 #define nsNativeCharsetUtils_h__
   9
  10 /*****************************************************************************\
  11  *                                                                           *
  12  *                             **** NOTICE ****                              *
  13  *                                                                           *
  14  *             *** THESE ARE NOT GENERAL PURPOSE CONVERTERS ***              *
  15  *                                                                           *
  16  *    NS_CopyNativeToUnicode / NS_CopyUnicodeToNative should only be used    *
  17  *    for converting *FILENAMES* between bytes and UTF-16. They are not      *
  18  *    designed or tested for general encoding converter use.                 *
  19  *                                                                           *
  20  *    On Windows, these functions convert to and from the system's legacy    *
  21  *    code page, which cannot represent all of Unicode. Elsewhere, these     *
  22  *    convert to and from UTF-8.                                             *
  23  *                                                                           *
  24 \*****************************************************************************/
  25
  26 #include "nsError.h"
  27 #include "nsStringFwd.h"
  28
  29 /**
  30  * thread-safe conversion routines that do not depend on uconv libraries.
  31  */
  32 nsresult NS_CopyNativeToUnicode(const nsACString& aInput, nsAString& aOutput);
  33 nsresult NS_CopyUnicodeToNative(const nsAString& aInput, nsACString& aOutput);
  34
  35 /*
  36  * This function indicates whether the character encoding used in the file
  37  * system (more exactly what's used for |GetNativeFoo| and |SetNativeFoo|
  38  * of |nsIFile|) is UTF-8 or not. Knowing that helps us avoid an
  39  * unncessary encoding conversion in some cases. For instance, to get the leaf
  40  * name in UTF-8 out of nsIFile, we can just use |GetNativeLeafName| rather
  41  * than using |GetLeafName| and converting the result to UTF-8 if the file
  42  * system  encoding is UTF-8.
  43  */
  44 inline constexpr bool NS_IsNativeUTF8() {
  45 #ifdef XP_WIN
  46   return false;
  47 #else
  48   return true;
  49 #endif
  50 }
  51
  52 #endif  // nsNativeCharsetUtils_h__