| 1 | /** @file
|
|---|
| 2 | * IPRT - Message Formatting.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2011 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef ___iprt_msg_h
|
|---|
| 27 | #define ___iprt_msg_h
|
|---|
| 28 |
|
|---|
| 29 | #include <iprt/cdefs.h>
|
|---|
| 30 | #include <iprt/types.h>
|
|---|
| 31 | #include <iprt/stdarg.h>
|
|---|
| 32 |
|
|---|
| 33 | RT_C_DECLS_BEGIN
|
|---|
| 34 |
|
|---|
| 35 | /** @defgroup grp_rt_msg RTMsg - Message Formatting
|
|---|
| 36 | * @ingroup grp_rt
|
|---|
| 37 | * @{
|
|---|
| 38 | */
|
|---|
| 39 |
|
|---|
| 40 | /**
|
|---|
| 41 | * Sets the program name to use.
|
|---|
| 42 | *
|
|---|
| 43 | * @returns IPRT status code.
|
|---|
| 44 | * @param pszFormat The program name format string.
|
|---|
| 45 | * @param ... Format arguments.
|
|---|
| 46 | */
|
|---|
| 47 | RTDECL(int) RTMsgSetProgName(const char *pszFormat, ...);
|
|---|
| 48 |
|
|---|
| 49 | /**
|
|---|
| 50 | * Print error message to standard error.
|
|---|
| 51 | *
|
|---|
| 52 | * The message will be prefixed with the file name part of process image name
|
|---|
| 53 | * (i.e. no path) and "error: ". If the message doesn't end with a new line,
|
|---|
| 54 | * one will be added. The caller should call this with an empty string if
|
|---|
| 55 | * unsure whether the cursor is currently position at the start of a new line.
|
|---|
| 56 | *
|
|---|
| 57 | * @returns IPRT status code.
|
|---|
| 58 | * @param pszFormat The message format string.
|
|---|
| 59 | * @param ... Format arguments.
|
|---|
| 60 | */
|
|---|
| 61 | RTDECL(int) RTMsgError(const char *pszFormat, ...);
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Print error message to standard error.
|
|---|
| 65 | *
|
|---|
| 66 | * The message will be prefixed with the file name part of process image name
|
|---|
| 67 | * (i.e. no path) and "error: ". If the message doesn't end with a new line,
|
|---|
| 68 | * one will be added. The caller should call this with an empty string if
|
|---|
| 69 | * unsure whether the cursor is currently position at the start of a new line.
|
|---|
| 70 | *
|
|---|
| 71 | * @returns IPRT status code.
|
|---|
| 72 | * @param pszFormat The message format string.
|
|---|
| 73 | * @param va Format arguments.
|
|---|
| 74 | */
|
|---|
| 75 | RTDECL(int) RTMsgErrorV(const char *pszFormat, va_list va);
|
|---|
| 76 |
|
|---|
| 77 | /**
|
|---|
| 78 | * Same as RTMsgError() except for the return value.
|
|---|
| 79 | *
|
|---|
| 80 | * @returns @a enmExitCode
|
|---|
| 81 | * @param enmExitCode What to exit code to return. This is mainly for
|
|---|
| 82 | * saving some vertical space in the source file.
|
|---|
| 83 | * @param pszFormat The message format string.
|
|---|
| 84 | * @param ... Format arguments.
|
|---|
| 85 | */
|
|---|
| 86 | RTDECL(RTEXITCODE) RTMsgErrorExit(RTEXITCODE enmExitcode, const char *pszFormat, ...);
|
|---|
| 87 |
|
|---|
| 88 | /**
|
|---|
| 89 | * Same as RTMsgErrorV() except for the return value.
|
|---|
| 90 | *
|
|---|
| 91 | * @returns @a enmExitCode
|
|---|
| 92 | * @param enmExitCode What to exit code to return. This is mainly for
|
|---|
| 93 | * saving some vertical space in the source file.
|
|---|
| 94 | * @param pszFormat The message format string.
|
|---|
| 95 | * @param va Format arguments.
|
|---|
| 96 | */
|
|---|
| 97 | RTDECL(RTEXITCODE) RTMsgErrorExitV(RTEXITCODE enmExitCode, const char *pszFormat, va_list va);
|
|---|
| 98 |
|
|---|
| 99 | /**
|
|---|
| 100 | * Same as RTMsgError() except for the return value.
|
|---|
| 101 | *
|
|---|
| 102 | * @returns @a rcRet
|
|---|
| 103 | * @param rcRet What IPRT status to return. This is mainly for
|
|---|
| 104 | * saving some vertical space in the source file.
|
|---|
| 105 | * @param pszFormat The message format string.
|
|---|
| 106 | * @param ... Format arguments.
|
|---|
| 107 | */
|
|---|
| 108 | RTDECL(int) RTMsgErrorRc(int rc, const char *pszFormat, ...);
|
|---|
| 109 |
|
|---|
| 110 | /**
|
|---|
| 111 | * Same as RTMsgErrorV() except for the return value.
|
|---|
| 112 | *
|
|---|
| 113 | * @returns @a rcRet
|
|---|
| 114 | * @param rcRet What IPRT status to return. This is mainly for
|
|---|
| 115 | * saving some vertical space in the source file.
|
|---|
| 116 | * @param pszFormat The message format string.
|
|---|
| 117 | * @param va Format arguments.
|
|---|
| 118 | */
|
|---|
| 119 | RTDECL(int) RTMsgErrorRcV(int rc, const char *pszFormat, va_list va);
|
|---|
| 120 |
|
|---|
| 121 | /**
|
|---|
| 122 | * Print an error message for a RTR3Init failure and suggest an exit code.
|
|---|
| 123 | *
|
|---|
| 124 | * @code
|
|---|
| 125 | *
|
|---|
| 126 | * int rc = RTR3Init();
|
|---|
| 127 | * if (RT_FAILURE(rc))
|
|---|
| 128 | * return RTMsgInitFailure(rc);
|
|---|
| 129 | *
|
|---|
| 130 | * @endcode
|
|---|
| 131 | *
|
|---|
| 132 | * @returns Appropriate exit code.
|
|---|
| 133 | * @param rcRTR3Init The status code returned by RTR3Init.
|
|---|
| 134 | */
|
|---|
| 135 | RTDECL(RTEXITCODE) RTMsgInitFailure(int rcRTR3Init);
|
|---|
| 136 |
|
|---|
| 137 | /**
|
|---|
| 138 | * Print informational message to standard error.
|
|---|
| 139 | *
|
|---|
| 140 | * The message will be prefixed with the file name part of process image name
|
|---|
| 141 | * (i.e. no path) and "warning: ". If the message doesn't end with a new line,
|
|---|
| 142 | * one will be added. The caller should call this with an empty string if
|
|---|
| 143 | * unsure whether the cursor is currently position at the start of a new line.
|
|---|
| 144 | *
|
|---|
| 145 | * @returns IPRT status code.
|
|---|
| 146 | * @param pszFormat The message format string.
|
|---|
| 147 | * @param ... Format arguments.
|
|---|
| 148 | */
|
|---|
| 149 | RTDECL(int) RTMsgWarning(const char *pszFormat, ...);
|
|---|
| 150 |
|
|---|
| 151 | /**
|
|---|
| 152 | * Print informational message to standard error.
|
|---|
| 153 | *
|
|---|
| 154 | * The message will be prefixed with the file name part of process image name
|
|---|
| 155 | * (i.e. no path) and "warning: ". If the message doesn't end with a new line,
|
|---|
| 156 | * one will be added. The caller should call this with an empty string if
|
|---|
| 157 | * unsure whether the cursor is currently position at the start of a new line.
|
|---|
| 158 | *
|
|---|
| 159 | * @returns IPRT status code.
|
|---|
| 160 | * @param pszFormat The message format string.
|
|---|
| 161 | * @param va Format arguments.
|
|---|
| 162 | */
|
|---|
| 163 | RTDECL(int) RTMsgWarningV(const char *pszFormat, va_list va);
|
|---|
| 164 |
|
|---|
| 165 | /**
|
|---|
| 166 | * Print informational message to standard output.
|
|---|
| 167 | *
|
|---|
| 168 | * The message will be prefixed with the file name part of process image name
|
|---|
| 169 | * (i.e. no path) and "info: ". If the message doesn't end with a new line,
|
|---|
| 170 | * one will be added. The caller should call this with an empty string if
|
|---|
| 171 | * unsure whether the cursor is currently position at the start of a new line.
|
|---|
| 172 | *
|
|---|
| 173 | * @returns IPRT status code.
|
|---|
| 174 | * @param pszFormat The message format string.
|
|---|
| 175 | * @param ... Format arguments.
|
|---|
| 176 | */
|
|---|
| 177 | RTDECL(int) RTMsgInfo(const char *pszFormat, ...);
|
|---|
| 178 |
|
|---|
| 179 | /**
|
|---|
| 180 | * Print informational message to standard output.
|
|---|
| 181 | *
|
|---|
| 182 | * The message will be prefixed with the file name part of process image name
|
|---|
| 183 | * (i.e. no path) and "info: ". If the message doesn't end with a new line,
|
|---|
| 184 | * one will be added. The caller should call this with an empty string if
|
|---|
| 185 | * unsure whether the cursor is currently position at the start of a new line.
|
|---|
| 186 | *
|
|---|
| 187 | * @returns IPRT status code.
|
|---|
| 188 | * @param pszFormat The message format string.
|
|---|
| 189 | * @param va Format arguments.
|
|---|
| 190 | */
|
|---|
| 191 | RTDECL(int) RTMsgInfoV(const char *pszFormat, va_list va);
|
|---|
| 192 |
|
|---|
| 193 | /** @} */
|
|---|
| 194 |
|
|---|
| 195 | RT_C_DECLS_END
|
|---|
| 196 |
|
|---|
| 197 | #endif
|
|---|
| 198 |
|
|---|
