xref: /third_party/curl/lib/curl_multibyte.h (revision 13498266) 
1#ifndef HEADER_CURL_MULTIBYTE_H
2#define HEADER_CURL_MULTIBYTE_H
3/***************************************************************************
4 *                                  _   _ ____  _
5 *  Project                     ___| | | |  _ \| |
6 *                             / __| | | | |_) | |
7 *                            | (__| |_| |  _ <| |___
8 *                             \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11 *
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at https://curl.se/docs/copyright.html.
15 *
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
19 *
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
22 *
23 * SPDX-License-Identifier: curl
24 *
25 ***************************************************************************/
26#include "curl_setup.h"
27
28#if defined(_WIN32)
29
30 /*
31  * MultiByte conversions using Windows kernel32 library.
32  */
33
34wchar_t *curlx_convert_UTF8_to_wchar(const char *str_utf8);
35char *curlx_convert_wchar_to_UTF8(const wchar_t *str_w);
36#endif /* _WIN32 */
37
38/*
39 * Macros curlx_convert_UTF8_to_tchar(), curlx_convert_tchar_to_UTF8()
40 * and curlx_unicodefree() main purpose is to minimize the number of
41 * preprocessor conditional directives needed by code using these
42 * to differentiate UNICODE from non-UNICODE builds.
43 *
44 * In the case of a non-UNICODE build the tchar strings are char strings that
45 * are duplicated via strdup and remain in whatever the passed in encoding is,
46 * which is assumed to be UTF-8 but may be other encoding. Therefore the
47 * significance of the conversion functions is primarily for UNICODE builds.
48 *
49 * Allocated memory should be free'd with curlx_unicodefree().
50 *
51 * Note: Because these are curlx functions their memory usage is not tracked
52 * by the curl memory tracker memdebug. You'll notice that curlx function-like
53 * macros call free and strdup in parentheses, eg (strdup)(ptr), and that's to
54 * ensure that the curl memdebug override macros do not replace them.
55 */
56
57#if defined(UNICODE) && defined(_WIN32)
58
59#define curlx_convert_UTF8_to_tchar(ptr) curlx_convert_UTF8_to_wchar((ptr))
60#define curlx_convert_tchar_to_UTF8(ptr) curlx_convert_wchar_to_UTF8((ptr))
61
62typedef union {
63  unsigned short       *tchar_ptr;
64  const unsigned short *const_tchar_ptr;
65  unsigned short       *tbyte_ptr;
66  const unsigned short *const_tbyte_ptr;
67} xcharp_u;
68
69#else
70
71#define curlx_convert_UTF8_to_tchar(ptr) (strdup)(ptr)
72#define curlx_convert_tchar_to_UTF8(ptr) (strdup)(ptr)
73
74typedef union {
75  char                *tchar_ptr;
76  const char          *const_tchar_ptr;
77  unsigned char       *tbyte_ptr;
78  const unsigned char *const_tbyte_ptr;
79} xcharp_u;
80
81#endif /* UNICODE && _WIN32 */
82
83#define curlx_unicodefree(ptr)                          \
84  do {                                                  \
85    if(ptr) {                                           \
86      (free)(ptr);                                      \
87      (ptr) = NULL;                                     \
88    }                                                   \
89  } while(0)
90
91#endif /* HEADER_CURL_MULTIBYTE_H */
92