| 1 | /* $Id: string.h 93115 2022-01-01 11:31:46Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Internal RTStr header.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2022 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 IPRT_INCLUDED_INTERNAL_string_h
|
|---|
| 28 | #define IPRT_INCLUDED_INTERNAL_string_h
|
|---|
| 29 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 30 | # pragma once
|
|---|
| 31 | #endif
|
|---|
| 32 |
|
|---|
| 33 | #include <iprt/string.h>
|
|---|
| 34 |
|
|---|
| 35 | RT_C_DECLS_BEGIN
|
|---|
| 36 |
|
|---|
| 37 | /** @def RTSTR_STRICT
|
|---|
| 38 | * Enables strict assertions on bad string encodings.
|
|---|
| 39 | */
|
|---|
| 40 | #ifdef DOXYGEN_RUNNING
|
|---|
| 41 | # define RTSTR_STRICT
|
|---|
| 42 | #endif
|
|---|
| 43 | /*#define RTSTR_STRICT*/
|
|---|
| 44 |
|
|---|
| 45 | #ifdef RTSTR_STRICT
|
|---|
| 46 | # define RTStrAssertMsgFailed(msg) AssertMsgFailed(msg)
|
|---|
| 47 | # define RTStrAssertMsgReturn(expr, msg, rc) AssertMsgReturn(expr, msg, rc)
|
|---|
| 48 | #else
|
|---|
| 49 | # define RTStrAssertMsgFailed(msg) do { } while (0)
|
|---|
| 50 | # define RTStrAssertMsgReturn(expr, msg, rc) do { if (!(expr)) return rc; } while (0)
|
|---|
| 51 | #endif
|
|---|
| 52 |
|
|---|
| 53 | DECLHIDDEN(size_t) rtStrFormatBadPointer(size_t cch, PFNRTSTROUTPUT pfnOutput, void *pvArgOutput, int cchWidth,
|
|---|
| 54 | unsigned fFlags, void const *pvStr, char szTmp[64], const char *pszTag, int cchTag);
|
|---|
| 55 | DECLHIDDEN(size_t) rtstrFormatRt(PFNRTSTROUTPUT pfnOutput, void *pvArgOutput, const char **ppszFormat, va_list *pArgs,
|
|---|
| 56 | int cchWidth, int cchPrecision, unsigned fFlags, char chArgSize);
|
|---|
| 57 | DECLHIDDEN(size_t) rtstrFormatType(PFNRTSTROUTPUT pfnOutput, void *pvArgOutput, const char **ppszFormat, va_list *pArgs,
|
|---|
| 58 | int cchWidth, int cchPrecision, unsigned fFlags, char chArgSize);
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * Format kernel address into @a pszBuf.
|
|---|
| 62 | *
|
|---|
| 63 | * @returns Number of bytes returned.
|
|---|
| 64 | * @param pszBuf The return buffer.
|
|---|
| 65 | * @param cbBuf The buffer size.
|
|---|
| 66 | * @param uPtr The ring-0 pointer value.
|
|---|
| 67 | * @param cchWidth The specified width, -1 if not given.
|
|---|
| 68 | * @param cchPrecision The specified precision.
|
|---|
| 69 | * @param fFlags Format flags, RTSTR_F_XXX.
|
|---|
| 70 | */
|
|---|
| 71 | DECLHIDDEN(size_t) rtStrFormatKernelAddress(char *pszBuf, size_t cbBuf, RTR0INTPTR uPtr, signed int cchWidth,
|
|---|
| 72 | signed int cchPrecision, unsigned int fFlags);
|
|---|
| 73 |
|
|---|
| 74 | #ifdef RT_WITH_ICONV_CACHE
|
|---|
| 75 | DECLHIDDEN(void) rtStrIconvCacheInit(struct RTTHREADINT *pThread);
|
|---|
| 76 | DECLHIDDEN(void) rtStrIconvCacheDestroy(struct RTTHREADINT *pThread);
|
|---|
| 77 | #endif
|
|---|
| 78 |
|
|---|
| 79 | /**
|
|---|
| 80 | * Indexes into RTTHREADINT::ahIconvs
|
|---|
| 81 | */
|
|---|
| 82 | typedef enum RTSTRICONV
|
|---|
| 83 | {
|
|---|
| 84 | /** UTF-8 to the locale codeset (LC_CTYPE). */
|
|---|
| 85 | RTSTRICONV_UTF8_TO_LOCALE = 0,
|
|---|
| 86 | /** The locale codeset (LC_CTYPE) to UTF-8. */
|
|---|
| 87 | RTSTRICONV_LOCALE_TO_UTF8,
|
|---|
| 88 | /** UTF-8 to the filesystem codeset - if different from the locale codeset. */
|
|---|
| 89 | RTSTRICONV_UTF8_TO_FS,
|
|---|
| 90 | /** The filesystem codeset to UTF-8. */
|
|---|
| 91 | RTSTRICONV_FS_TO_UTF8,
|
|---|
| 92 | /** The end of the valid indexes. */
|
|---|
| 93 | RTSTRICONV_END
|
|---|
| 94 | } RTSTRICONV;
|
|---|
| 95 |
|
|---|
| 96 | DECLHIDDEN(int) rtStrConvert(const char *pchInput, size_t cchInput, const char *pszInputCS,
|
|---|
| 97 | char **ppszOutput, size_t cbOutput, const char *pszOutputCS,
|
|---|
| 98 | unsigned cFactor, RTSTRICONV enmCacheIdx);
|
|---|
| 99 | DECLHIDDEN(void) rtStrLocalCacheInit(void **ppvTmpCache);
|
|---|
| 100 | DECLHIDDEN(int) rtStrLocalCacheConvert(const char *pchInput, size_t cchInput, const char *pszInputCS,
|
|---|
| 101 | char **ppszOutput, size_t cbOutput, const char *pszOutputCS,
|
|---|
| 102 | void **ppvTmpCache);
|
|---|
| 103 | DECLHIDDEN(void) rtStrLocalCacheDelete(void **ppvTmpCache);
|
|---|
| 104 | DECLHIDDEN(const char *) rtStrGetLocaleCodeset(void);
|
|---|
| 105 | DECLHIDDEN(bool) rtStrIsLocaleCodesetUtf8(void);
|
|---|
| 106 | DECLHIDDEN(bool) rtStrIsCodesetUtf8(const char *pszCodeset);
|
|---|
| 107 | DECLHIDDEN(int) rtUtf8Length(const char *psz, size_t cch, size_t *pcuc, size_t *pcchActual);
|
|---|
| 108 |
|
|---|
| 109 | DECLHIDDEN(int) rtStrToIpAddr6Str(const char *psz, char *pszAddrOut, size_t addrOutSize, char *pszPortOut, size_t portOutSize, bool followRfc);
|
|---|
| 110 |
|
|---|
| 111 | RT_C_DECLS_END
|
|---|
| 112 |
|
|---|
| 113 | #endif /* !IPRT_INCLUDED_INTERNAL_string_h */
|
|---|
| 114 |
|
|---|
