/work/obj-fuzz/dist/include/nsNativeCharsetUtils.h

Source (jump to first uncovered line)
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsNativeCharsetUtils_h__
#define nsNativeCharsetUtils_h__


/*****************************************************************************\
 *                                                                           *
 *                             **** NOTICE ****                              *
 *                                                                           *
 *             *** THESE ARE NOT GENERAL PURPOSE CONVERTERS ***              *
 *                                                                           *
 *    NS_CopyNativeToUnicode / NS_CopyUnicodeToNative should only be used    *
 *    for converting *FILENAMES* between bytes and UTF-16. They are not      *
 *    designed or tested for general encoding converter use.                 *
 *                                                                           *
 *    On Windows, these functions convert to and from the system's legacy    *
 *    code page, which cannot represent all of Unicode. Elsewhere, these     *
 *    convert to and from UTF-8.                                             *
 *                                                                           *
\*****************************************************************************/

/**
 * thread-safe conversion routines that do not depend on uconv libraries.
 */
nsresult NS_CopyNativeToUnicode(const nsACString& aInput, nsAString& aOutput);
nsresult NS_CopyUnicodeToNative(const nsAString& aInput, nsACString& aOutput);

/*
 * This function indicates whether the character encoding used in the file
 * system (more exactly what's used for |GetNativeFoo| and |SetNativeFoo|
 * of |nsIFile|) is UTF-8 or not. Knowing that helps us avoid an
 * unncessary encoding conversion in some cases. For instance, to get the leaf
 * name in UTF-8 out of nsIFile, we can just use |GetNativeLeafName| rather
 * than using |GetLeafName| and converting the result to UTF-8 if the file
 * system  encoding is UTF-8.
 */
inline constexpr bool
NS_IsNativeUTF8()
{
#ifdef XP_WIN
  return false;
#else
  return true;
#endif
}

#endif // nsNativeCharsetUtils_h__

Coverage Report

Created: 2018-09-25 14:53

Line	Count	Source (jump to first uncovered line)
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		* *
13		* ** NOTICE ** *
14		* *
15		* * THESE ARE NOT GENERAL PURPOSE CONVERTERS * *
16		* *
17		* NS_CopyNativeToUnicode / NS_CopyUnicodeToNative should only be used *
18		* for converting FILENAMES between bytes and UTF-16. They are not *
19		* designed or tested for general encoding converter use. *
20		* *
21		* On Windows, these functions convert to and from the system's legacy *
22		* code page, which cannot represent all of Unicode. Elsewhere, these *
23		* convert to and from UTF-8. *
24		* *
25		\*****************************************************************************/
26
27		/**
28		* thread-safe conversion routines that do not depend on uconv libraries.
29		*/
30		nsresult NS_CopyNativeToUnicode(const nsACString& aInput, nsAString& aOutput);
31		nsresult NS_CopyUnicodeToNative(const nsAString& aInput, nsACString& aOutput);
32
33		/*
34		* This function indicates whether the character encoding used in the file
35		* system (more exactly what's used for \|GetNativeFoo\| and \|SetNativeFoo\|
36		* of \|nsIFile\|) is UTF-8 or not. Knowing that helps us avoid an
37		* unncessary encoding conversion in some cases. For instance, to get the leaf
38		* name in UTF-8 out of nsIFile, we can just use \|GetNativeLeafName\| rather
39		* than using \|GetLeafName\| and converting the result to UTF-8 if the file
40		* system encoding is UTF-8.
41		*/
42		inline constexpr bool
43		NS_IsNativeUTF8()
44	0	{
45		#ifdef XP_WIN
46		return false;
47		#else
48		return true;
49	0	#endif
50	0	}
51
52		#endif // nsNativeCharsetUtils_h__