1 | /* $Id: string.h 56290 2015-06-09 14:01:31Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * IPRT - Internal RTStr header.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2015 Oracle Corporation
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | *
|
---|
17 | * The contents of this file may alternatively be used under the terms
|
---|
18 | * of the Common Development and Distribution License Version 1.0
|
---|
19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
20 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
21 | * CDDL are applicable instead of those of the GPL.
|
---|
22 | *
|
---|
23 | * You may elect to license modified versions of this file under the
|
---|
24 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
25 | */
|
---|
26 |
|
---|
27 | #ifndef ___internal_string_h
|
---|
28 | #define ___internal_string_h
|
---|
29 |
|
---|
30 | #include <iprt/string.h>
|
---|
31 |
|
---|
32 | RT_C_DECLS_BEGIN
|
---|
33 |
|
---|
34 | /** @def RTSTR_STRICT
|
---|
35 | * Enables strict assertions on bad string encodings.
|
---|
36 | */
|
---|
37 | #ifdef DOXYGEN_RUNNING
|
---|
38 | # define RTSTR_STRICT
|
---|
39 | #endif
|
---|
40 | /*#define RTSTR_STRICT*/
|
---|
41 |
|
---|
42 | #ifdef RTSTR_STRICT
|
---|
43 | # define RTStrAssertMsgFailed(msg) AssertMsgFailed(msg)
|
---|
44 | # define RTStrAssertMsgReturn(expr, msg, rc) AssertMsgReturn(expr, msg, rc)
|
---|
45 | #else
|
---|
46 | # define RTStrAssertMsgFailed(msg) do { } while (0)
|
---|
47 | # define RTStrAssertMsgReturn(expr, msg, rc) do { if (!(expr)) return rc; } while (0)
|
---|
48 | #endif
|
---|
49 |
|
---|
50 | DECLHIDDEN(size_t) rtstrFormatRt(PFNRTSTROUTPUT pfnOutput, void *pvArgOutput, const char **ppszFormat, va_list *pArgs,
|
---|
51 | int cchWidth, int cchPrecision, unsigned fFlags, char chArgSize);
|
---|
52 | DECLHIDDEN(size_t) rtstrFormatType(PFNRTSTROUTPUT pfnOutput, void *pvArgOutput, const char **ppszFormat, va_list *pArgs,
|
---|
53 | int cchWidth, int cchPrecision, unsigned fFlags, char chArgSize);
|
---|
54 |
|
---|
55 | #ifdef RT_WITH_ICONV_CACHE
|
---|
56 | DECLHIDDEN(void) rtStrIconvCacheInit(struct RTTHREADINT *pThread);
|
---|
57 | DECLHIDDEN(void) rtStrIconvCacheDestroy(struct RTTHREADINT *pThread);
|
---|
58 | #endif
|
---|
59 |
|
---|
60 | /**
|
---|
61 | * Indexes into RTTHREADINT::ahIconvs
|
---|
62 | */
|
---|
63 | typedef enum RTSTRICONV
|
---|
64 | {
|
---|
65 | /** UTF-8 to the locale codeset (LC_CTYPE). */
|
---|
66 | RTSTRICONV_UTF8_TO_LOCALE = 0,
|
---|
67 | /** The locale codeset (LC_CTYPE) to UTF-8. */
|
---|
68 | RTSTRICONV_LOCALE_TO_UTF8,
|
---|
69 | /** UTF-8 to the filesystem codeset - if different from the locale codeset. */
|
---|
70 | RTSTRICONV_UTF8_TO_FS,
|
---|
71 | /** The filesystem codeset to UTF-8. */
|
---|
72 | RTSTRICONV_FS_TO_UTF8,
|
---|
73 | /** The end of the valid indexes. */
|
---|
74 | RTSTRICONV_END
|
---|
75 | } RTSTRICONV;
|
---|
76 |
|
---|
77 | DECLHIDDEN(int) rtStrConvert(const char *pchInput, size_t cchInput, const char *pszInputCS,
|
---|
78 | char **ppszOutput, size_t cbOutput, const char *pszOutputCS,
|
---|
79 | unsigned cFactor, RTSTRICONV enmCacheIdx);
|
---|
80 | DECLHIDDEN(const char *) rtStrGetLocaleCodeset(void);
|
---|
81 | DECLHIDDEN(int) rtUtf8Length(const char *psz, size_t cch, size_t *pcuc, size_t *pcchActual);
|
---|
82 |
|
---|
83 | DECLHIDDEN(int) rtStrToIpAddr6Str(const char *psz, char *pszAddrOut, size_t addrOutSize, char *pszPortOut, size_t portOutSize, bool followRfc);
|
---|
84 |
|
---|
85 | RT_C_DECLS_END
|
---|
86 |
|
---|
87 | #endif
|
---|
88 |
|
---|