| 1 | /* $Id: errinfo.cpp 106061 2024-09-16 14:03:52Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Error Info, Setters.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2010-2024 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * The contents of this file may alternatively be used under the terms
|
|---|
| 26 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 28 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 29 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 30 | *
|
|---|
| 31 | * You may elect to license modified versions of this file under the
|
|---|
| 32 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 33 | *
|
|---|
| 34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 |
|
|---|
| 38 | /*********************************************************************************************************************************
|
|---|
| 39 | * Header Files *
|
|---|
| 40 | *********************************************************************************************************************************/
|
|---|
| 41 | #include "internal/iprt.h"
|
|---|
| 42 | #include <iprt/errcore.h>
|
|---|
| 43 |
|
|---|
| 44 | #include <iprt/assert.h>
|
|---|
| 45 | #include <iprt/string.h>
|
|---|
| 46 |
|
|---|
| 47 |
|
|---|
| 48 | RTDECL(int) RTErrInfoSet(PRTERRINFO pErrInfo, int rc, const char *pszMsg)
|
|---|
| 49 | {
|
|---|
| 50 | if (pErrInfo)
|
|---|
| 51 | {
|
|---|
| 52 | AssertPtr(pErrInfo);
|
|---|
| 53 | Assert((pErrInfo->fFlags & RTERRINFO_FLAGS_MAGIC_MASK) == RTERRINFO_FLAGS_MAGIC);
|
|---|
| 54 |
|
|---|
| 55 | RTStrCopy(pErrInfo->pszMsg, pErrInfo->cbMsg, pszMsg);
|
|---|
| 56 | pErrInfo->rc = rc;
|
|---|
| 57 | pErrInfo->fFlags |= RTERRINFO_FLAGS_SET;
|
|---|
| 58 | }
|
|---|
| 59 | return rc;
|
|---|
| 60 | }
|
|---|
| 61 |
|
|---|
| 62 |
|
|---|
| 63 | RTDECL(int) RTErrInfoSetF(PRTERRINFO pErrInfo, int rc, const char *pszFormat, ...)
|
|---|
| 64 | {
|
|---|
| 65 | va_list va;
|
|---|
| 66 | va_start(va, pszFormat);
|
|---|
| 67 | RTErrInfoSetV(pErrInfo, rc, pszFormat, va);
|
|---|
| 68 | va_end(va);
|
|---|
| 69 | return rc;
|
|---|
| 70 | }
|
|---|
| 71 |
|
|---|
| 72 |
|
|---|
| 73 | RTDECL(int) RTErrInfoSetV(PRTERRINFO pErrInfo, int rc, const char *pszFormat, va_list va)
|
|---|
| 74 | {
|
|---|
| 75 | if (pErrInfo)
|
|---|
| 76 | {
|
|---|
| 77 | AssertPtr(pErrInfo);
|
|---|
| 78 | Assert((pErrInfo->fFlags & RTERRINFO_FLAGS_MAGIC_MASK) == RTERRINFO_FLAGS_MAGIC);
|
|---|
| 79 |
|
|---|
| 80 | RTStrPrintfV(pErrInfo->pszMsg, pErrInfo->cbMsg, pszFormat, va);
|
|---|
| 81 | pErrInfo->rc = rc;
|
|---|
| 82 | pErrInfo->fFlags |= RTERRINFO_FLAGS_SET;
|
|---|
| 83 | }
|
|---|
| 84 | return rc;
|
|---|
| 85 | }
|
|---|
| 86 |
|
|---|
| 87 |
|
|---|
| 88 | RTDECL(int) RTErrInfoAdd(PRTERRINFO pErrInfo, int rc, const char *pszMsg)
|
|---|
| 89 | {
|
|---|
| 90 | if (pErrInfo)
|
|---|
| 91 | {
|
|---|
| 92 | AssertPtr(pErrInfo);
|
|---|
| 93 | if (pErrInfo->fFlags & RTERRINFO_FLAGS_SET)
|
|---|
| 94 | RTStrCat(pErrInfo->pszMsg, pErrInfo->cbMsg, pszMsg);
|
|---|
| 95 | else
|
|---|
| 96 | {
|
|---|
| 97 | while (*pszMsg == ' ')
|
|---|
| 98 | pszMsg++;
|
|---|
| 99 | return RTErrInfoSet(pErrInfo, rc, pszMsg);
|
|---|
| 100 | }
|
|---|
| 101 | }
|
|---|
| 102 | return rc;
|
|---|
| 103 | }
|
|---|
| 104 |
|
|---|
| 105 |
|
|---|
| 106 | RTDECL(int) RTErrInfoAddF(PRTERRINFO pErrInfo, int rc, const char *pszFormat, ...)
|
|---|
| 107 | {
|
|---|
| 108 | va_list va;
|
|---|
| 109 | va_start(va, pszFormat);
|
|---|
| 110 | RTErrInfoAddV(pErrInfo, rc, pszFormat, va);
|
|---|
| 111 | va_end(va);
|
|---|
| 112 | return rc;
|
|---|
| 113 | }
|
|---|
| 114 |
|
|---|
| 115 |
|
|---|
| 116 | RTDECL(int) RTErrInfoAddV(PRTERRINFO pErrInfo, int rc, const char *pszFormat, va_list va)
|
|---|
| 117 | {
|
|---|
| 118 | if (pErrInfo)
|
|---|
| 119 | {
|
|---|
| 120 | AssertPtr(pErrInfo);
|
|---|
| 121 | Assert((pErrInfo->fFlags & RTERRINFO_FLAGS_MAGIC_MASK) == RTERRINFO_FLAGS_MAGIC);
|
|---|
| 122 | if (pErrInfo->fFlags & RTERRINFO_FLAGS_SET)
|
|---|
| 123 | {
|
|---|
| 124 | char *pszOut = (char *)memchr(pErrInfo->pszMsg, '\0', pErrInfo->cbMsg - 2);
|
|---|
| 125 | if (pszOut)
|
|---|
| 126 | RTStrPrintfV(pszOut, &pErrInfo->pszMsg[pErrInfo->cbMsg] - pszOut, pszFormat, va);
|
|---|
| 127 | }
|
|---|
| 128 | else
|
|---|
| 129 | {
|
|---|
| 130 | while (*pszFormat == ' ')
|
|---|
| 131 | pszFormat++;
|
|---|
| 132 | return RTErrInfoSetV(pErrInfo, rc, pszFormat, va);
|
|---|
| 133 | }
|
|---|
| 134 | }
|
|---|
| 135 | return rc;
|
|---|
| 136 | }
|
|---|
| 137 |
|
|---|
