1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
/* $Id: messagerefentry.cpp $ */
/** @file
* IPRT - Program usage and help formatting.
*/
/*
* Copyright (C) 2009-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#include "internal/iprt.h"
#include <iprt/message.h>
#include <iprt/env.h>
#include <iprt/errcore.h>
#include <iprt/path.h>
#include <iprt/string.h>
#include <iprt/stream.h>
#include "internal/process.h"
/*********************************************************************************************************************************
* Global Variables *
*********************************************************************************************************************************/
/** Spaces for intending. */
static const char g_szSpaces[] = " ";
/**
* Retruns the width for the given handle.
*
* @returns Screen width.
* @param pStrm The stream, g_pStdErr or g_pStdOut.
*/
static uint32_t getScreenWidth(PRTSTREAM pStrm)
{
static uint32_t s_acch[2] = { 0, 0 };
uint32_t iWhich = pStrm == g_pStdErr ? 1 : 0;
uint32_t cch = s_acch[iWhich];
if (cch)
return cch;
const char *psz = RTEnvGet("IPRT_SCREEN_WIDTH");
if ( !psz
|| RTStrToUInt32Full(psz, 0, &cch) != VINF_SUCCESS
|| cch == 0)
{
int rc = RTStrmQueryTerminalWidth(pStrm, &cch);
if (rc == VERR_INVALID_FUNCTION)
{
/* It's not a console, but in case we're being piped to less/more/list
we look for a console handle on the other standard output handle
and standard input. (Latter doesn't work on windows.) */
rc = RTStrmQueryTerminalWidth(pStrm == g_pStdErr ? g_pStdOut : g_pStdErr, &cch);
if (rc == VERR_INVALID_FUNCTION || rc == VERR_INVALID_HANDLE)
rc = RTStrmQueryTerminalWidth(g_pStdIn, &cch);
if (RT_FAILURE(rc))
cch = 80;
}
}
s_acch[iWhich] = cch;
return cch;
}
/**
* Prints a string table string (paragraph), performing non-breaking-space
* replacement and wrapping.
*
* @returns IRPT status code.
* @param pStrm The output stream.
* @param psz The string table string to print.
* @param cchMaxWidth The maximum output width.
* @param fFlags String flags that may affect formatting.
* @param pcLinesWritten Pointer to variable to update with written lines.
*/
static int printString(PRTSTREAM pStrm, const char *psz, uint32_t cchMaxWidth, uint64_t fFlags, uint32_t *pcLinesWritten)
{
uint32_t cLinesWritten;
size_t cch = strlen(psz);
const char *pszNbsp = strchr(psz, RTMSGREFENTRY_NBSP);
int rc;
/*
* No-wrap case is simpler, so handle that separately.
*/
if (cch <= cchMaxWidth)
{
if (!pszNbsp)
rc = RTStrmWrite(pStrm, psz, cch);
else
{
do
{
rc = RTStrmWrite(pStrm, psz, pszNbsp - psz);
if (RT_SUCCESS(rc))
rc = RTStrmPutCh(pStrm, ' ');
psz = pszNbsp + 1;
pszNbsp = strchr(psz, RTMSGREFENTRY_NBSP);
} while (pszNbsp && RT_SUCCESS(rc));
if (RT_SUCCESS(rc))
rc = RTStrmWrite(pStrm, psz, strlen(psz));
}
if (RT_SUCCESS(rc))
rc = RTStrmPutCh(pStrm, '\n');
cLinesWritten = 1;
}
/*
* We need to wrap stuff, too bad.
*/
else
{
/* Figure the paragraph indent level first. */
uint32_t cchIndent = 0;
while (*psz == ' ')
cchIndent++, psz++;
Assert(cchIndent + 4 + 1 <= RT_ELEMENTS(g_szSpaces));
if (cchIndent + 8 >= cchMaxWidth)
cchMaxWidth += cchIndent + 8;
/* Work our way thru the string, line by line. */
uint32_t cchHangingIndent = 0;
cLinesWritten = 0;
do
{
rc = RTStrmWrite(pStrm, g_szSpaces, cchIndent + cchHangingIndent);
if (RT_FAILURE(rc))
break;
size_t offLine = cchIndent + cchHangingIndent;
bool fPendingSpace = false;
do
{
const char *pszSpace = strchr(psz, ' ');
size_t cchWord = pszSpace ? pszSpace - psz : strlen(psz);
if ( offLine + cchWord + fPendingSpace > cchMaxWidth
&& offLine != cchIndent
&& fPendingSpace /* don't stop before first word */)
break;
pszNbsp = (const char *)memchr(psz, RTMSGREFENTRY_NBSP, cchWord);
while (pszNbsp)
{
size_t cchSubWord = pszNbsp - psz;
if (fPendingSpace)
{
rc = RTStrmPutCh(pStrm, ' ');
if (RT_FAILURE(rc))
break;
}
rc = RTStrmWrite(pStrm, psz, cchSubWord);
if (RT_FAILURE(rc))
break;
offLine += cchSubWord + fPendingSpace;
psz += cchSubWord + 1;
cchWord -= cchSubWord + 1;
pszNbsp = (const char *)memchr(psz, RTMSGREFENTRY_NBSP, cchWord);
fPendingSpace = true;
}
if (RT_FAILURE(rc))
break;
if (fPendingSpace)
{
rc = RTStrmPutCh(pStrm, ' ');
if (RT_FAILURE(rc))
break;
}
rc = RTStrmWrite(pStrm, psz, cchWord);
if (RT_FAILURE(rc))
break;
offLine += cchWord + fPendingSpace;
psz = pszSpace ? pszSpace + 1 : strchr(psz, '\0');
fPendingSpace = true;
} while (offLine < cchMaxWidth && *psz != '\0' && RT_SUCCESS(rc));
if (RT_SUCCESS(rc))
rc = RTStrmPutCh(pStrm, '\n');
if (RT_FAILURE(rc))
break;
cLinesWritten++;
/* Set up hanging indent if relevant. */
if (fFlags & RTMSGREFENTRYSTR_FLAGS_SYNOPSIS)
cchHangingIndent = 4;
} while (*psz != '\0');
}
*pcLinesWritten += cLinesWritten;
return rc;
}
/**
* Checks if the given string is empty (only spaces).
* @returns true if empty, false if not.
* @param psz The string to examine.
*/
DECLINLINE(bool) isEmptyString(const char *psz)
{
char ch;
while ((ch = *psz) == ' ')
psz++;
return ch == '\0';
}
/**
* Prints a string table.
*
* @returns Current number of pending blank lines.
* @param pStrm The output stream.
* @param pStrTab The string table.
* @param fScope The selection scope.
* @param pcPendingBlankLines In: Pending blank lines from previous string
* table. Out: Pending blank lines.
* @param pcLinesWritten Pointer to variable that should be incremented
* by the number of lines written. Optional.
*/
RTDECL(int) RTMsgRefEntryPrintStringTable(PRTSTREAM pStrm, PCRTMSGREFENTRYSTRTAB pStrTab, uint64_t fScope,
uint32_t *pcPendingBlankLines, uint32_t *pcLinesWritten)
{
uint32_t cPendingBlankLines = pcPendingBlankLines ? *pcPendingBlankLines : 0;
uint32_t cLinesWritten = 0;
uint32_t cchWidth = getScreenWidth(pStrm);
uint64_t fPrevScope = fScope;
int rc = VINF_SUCCESS;
for (uint32_t i = 0; i < pStrTab->cStrings; i++)
{
uint64_t fCurScope = pStrTab->paStrings[i].fScope;
if ((fCurScope & RTMSGREFENTRYSTR_SCOPE_MASK) == RTMSGREFENTRYSTR_SCOPE_SAME)
{
fCurScope &= ~RTMSGREFENTRYSTR_SCOPE_MASK;
fCurScope |= (fPrevScope & RTMSGREFENTRYSTR_SCOPE_MASK);
}
if (fCurScope & RTMSGREFENTRYSTR_SCOPE_MASK & fScope)
{
const char *psz = pStrTab->paStrings[i].psz;
if (psz && !isEmptyString(psz))
{
while (cPendingBlankLines > 0 && RT_SUCCESS(rc))
{
cPendingBlankLines--;
rc = RTStrmPutCh(pStrm, '\n');
cLinesWritten++;
}
if (RT_SUCCESS(rc))
rc = printString(pStrm, psz, cchWidth, fCurScope & RTMSGREFENTRYSTR_FLAGS_MASK, &cLinesWritten);
if (RT_FAILURE(rc))
break;
}
else
cPendingBlankLines++;
}
fPrevScope = fCurScope;
}
if (pcLinesWritten)
*pcLinesWritten += cLinesWritten;
if (pcPendingBlankLines)
*pcPendingBlankLines = cPendingBlankLines;
return rc;
}
RTDECL(int) RTMsgRefEntrySynopsisEx(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry, uint64_t fScope, uint32_t fFlags)
{
AssertReturn(!(fFlags & ~RTMSGREFENTRY_SYNOPSIS_F_USAGE), VERR_INVALID_FLAGS);
if (!pStrm)
pStrm = g_pStdOut;
int rc = VINF_SUCCESS;
if (fFlags & RTMSGREFENTRY_SYNOPSIS_F_USAGE)
RTStrmPutStr(pStrm, "Usage: ");
if (RT_SUCCESS(rc))
rc = RTMsgRefEntryPrintStringTable(pStrm, &pEntry->Synopsis, fScope, NULL, NULL);
return rc;
}
RTDECL(int) RTMsgRefEntrySynopsis(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry)
{
return RTMsgRefEntrySynopsisEx(pStrm, pEntry, UINT64_MAX, true /*fPrintUsage*/);
}
RTDECL(int) RTMsgRefEntryHelpEx(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry, uint64_t fScope, uint32_t fFlags)
{
AssertReturn(!fFlags, VERR_INVALID_FLAGS);
if (!pStrm)
pStrm = g_pStdOut;
return RTMsgRefEntryPrintStringTable(pStrm, &pEntry->Help, fScope, NULL, NULL);
}
RTDECL(int) RTMsgRefEntryHelp(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry)
{
return RTMsgRefEntryHelpEx(pStrm, pEntry, UINT64_MAX, 0 /*fFlags*/);
}
|
