stream.cpp@ 34147

Last change on this file since 34147 was 32464, checked in by vboxsync, 14 years ago
Runtime: only include critsect.h in stream.cpp if it is needed
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 22.5 KB

Line
1	/* $Id: stream.cpp 32464 2010-09-14 08:48:32Z vboxsync $ */
2	/** @file
3	* IPRT - I/O Stream.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 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
28
29	#if defined(RT_OS_LINUX) /* PORTME: check for the _unlocked functions in stdio.h */
30	#define HAVE_FWRITE_UNLOCKED
31	#endif
32
33	/*******************************************************************************
34	* Header Files *
35	*******************************************************************************/
36	#include <iprt/stream.h>
37	#include "internal/iprt.h"
38
39	#include <iprt/asm.h>
40	#ifndef HAVE_FWRITE_UNLOCKED
41	# include <iprt/critsect.h>
42	#endif
43	#include <iprt/string.h>
44	#include <iprt/assert.h>
45	#include <iprt/alloc.h>
46	#include <iprt/err.h>
47	#include <iprt/param.h>
48	#include <iprt/string.h>
49
50	#include "internal/alignmentchecks.h"
51	#include "internal/magics.h"
52
53	#include <stdio.h>
54	#include <errno.h>
55
56
57	/*******************************************************************************
58	* Structures and Typedefs *
59	*******************************************************************************/
60	/**
61	* File stream.
62	*/
63	typedef struct RTSTREAM
64	{
65	/** Magic value used to validate the stream. (RTSTREAM_MAGIC) */
66	uint32_t u32Magic;
67	/** File stream error. */
68	int32_t volatile i32Error;
69	/** Pointer to the LIBC file stream. */
70	FILE *pFile;
71	#ifndef HAVE_FWRITE_UNLOCKED
72	/** Critical section for serializing access to the stream. */
73	PRTCRITSECT pCritSect;
74	#endif
75	} RTSTREAM;
76
77
78	/*******************************************************************************
79	* Global Variables *
80	*******************************************************************************/
81	/** The standard input stream. */
82	static RTSTREAM g_StdIn =
83	{
84	RTSTREAM_MAGIC,
85	0,
86	stdin
87	#ifndef HAVE_FWRITE_UNLOCKED
88	, NULL
89	#endif
90	};
91
92	/** The standard error stream. */
93	static RTSTREAM g_StdErr =
94	{
95	RTSTREAM_MAGIC,
96	0,
97	stderr
98	#ifndef HAVE_FWRITE_UNLOCKED
99	, NULL
100	#endif
101	};
102
103	/** The standard output stream. */
104	static RTSTREAM g_StdOut =
105	{
106	RTSTREAM_MAGIC,
107	0,
108	stdout
109	#ifndef HAVE_FWRITE_UNLOCKED
110	, NULL
111	#endif
112	};
113
114	/** Pointer to the standard input stream. */
115	RTDATADECL(PRTSTREAM) g_pStdIn = &g_StdIn;
116
117	/** Pointer to the standard output stream. */
118	RTDATADECL(PRTSTREAM) g_pStdErr = &g_StdErr;
119
120	/** Pointer to the standard output stream. */
121	RTDATADECL(PRTSTREAM) g_pStdOut = &g_StdOut;
122
123
124	#ifndef HAVE_FWRITE_UNLOCKED
125	/**
126	* Allocates and acquires the lock for the stream.
127	*
128	* @returns IPRT status.
129	* @param pStream The stream (valid).
130	*/
131	static int rtStrmAllocLock(PRTSTREAM pStream)
132	{
133	Assert(pStream->pCritSect == NULL);
134
135	PRTCRITSECT pCritSect = (PRTCRITSECT)RTMemAlloc(sizeof(*pCritSect));
136	if (!pCritSect)
137	return VERR_NO_MEMORY;
138
139	/* The native stream lock are normally not recursive. */
140	int rc = RTCritSectInitEx(pCritSect, RTCRITSECT_FLAGS_NO_NESTING,
141	NIL_RTLOCKVALCLASS, RTLOCKVAL_SUB_CLASS_NONE, "RTSemSpinMutex");
142	if (RT_SUCCESS(rc))
143	{
144	rc = RTCritSectEnter(pCritSect);
145	if (RT_SUCCESS(rc))
146	{
147	if (RT_LIKELY(ASMAtomicCmpXchgPtr(&pStream->pCritSect, pCritSect, NULL)))
148	return VINF_SUCCESS;
149
150	RTCritSectLeave(pCritSect);
151	}
152	RTCritSectDelete(pCritSect);
153	}
154	RTMemFree(pCritSect);
155
156	/* Handle the lost race case... */
157	pCritSect = ASMAtomicReadPtrT(&pStream->pCritSect, PRTCRITSECT);
158	if (pCritSect)
159	return RTCritSectEnter(pCritSect);
160
161	return rc;
162	}
163	#endif /* !HAVE_FWRITE_UNLOCKED */
164
165
166	/**
167	* Locks the stream. May have to allocate the lock as well.
168	*
169	* @param pStream The stream (valid).
170	*/
171	DECLINLINE(void) rtStrmLock(PRTSTREAM pStream)
172	{
173	#ifdef HAVE_FWRITE_UNLOCKED
174	flockfile(pStream->pFile);
175	#else
176	if (RT_LIKELY(pStream->pCritSect))
177	RTCritSectEnter(pStream->pCritSect);
178	else
179	rtStrmAllocLock(pStream);
180	#endif
181	}
182
183
184	/**
185	* Unlocks the stream.
186	*
187	* @param pStream The stream (valid).
188	*/
189	DECLINLINE(void) rtStrmUnlock(PRTSTREAM pStream)
190	{
191	#ifdef HAVE_FWRITE_UNLOCKED
192	funlockfile(pStream->pFile);
193	#else
194	if (RT_LIKELY(pStream->pCritSect))
195	RTCritSectLeave(pStream->pCritSect);
196	#endif
197	}
198
199
200	/**
201	* Opens a file stream.
202	*
203	* @returns iprt status code.
204	* @param pszFilename Path to the file to open.
205	* @param pszMode The open mode. See fopen() standard.
206	* Format: <a\|r\|w>[+][b\|t]
207	* @param ppStream Where to store the opened stream.
208	*/
209	RTR3DECL(int) RTStrmOpen(const char pszFilename, const char pszMode, PRTSTREAM *ppStream)
210	{
211	/*
212	* Validate input.
213	*/
214	if (!pszMode \|\| !*pszMode)
215	{
216	AssertMsgFailed(("No pszMode!\n"));
217	return VERR_INVALID_PARAMETER;
218	}
219	if (!pszFilename)
220	{
221	AssertMsgFailed(("No pszFilename!\n"));
222	return VERR_INVALID_PARAMETER;
223	}
224	bool fOk = true;
225	switch (*pszMode)
226	{
227	case 'a':
228	case 'w':
229	case 'r':
230	switch (pszMode[1])
231	{
232	case '\0':
233	break;
234	case '+':
235	switch (pszMode[2])
236	{
237	case '\0':
238	//case 't':
239	case 'b':
240	break;
241	default:
242	fOk = false;
243	break;
244	}
245	break;
246	//case 't':
247	case 'b':
248	break;
249	default:
250	fOk = false;
251	break;
252	}
253	break;
254	default:
255	fOk = false;
256	break;
257	}
258	if (!fOk)
259	{
260	AssertMsgFailed(("Invalid pszMode='%s', '<a\|r\|w>[+][b\|t]'\n", pszMode));
261	return VINF_SUCCESS;
262	}
263
264	/*
265	* Allocate the stream handle and try open it.
266	*/
267	PRTSTREAM pStream = (PRTSTREAM)RTMemAlloc(sizeof(*pStream));
268	if (pStream)
269	{
270	pStream->u32Magic = RTSTREAM_MAGIC;
271	pStream->i32Error = VINF_SUCCESS;
272	#ifndef HAVE_FWRITE_UNLOCKED
273	pStream->pCritSect = NULL;
274	#endif /* HAVE_FWRITE_UNLOCKED */
275	pStream->pFile = fopen(pszFilename, pszMode);
276	if (pStream->pFile)
277	{
278	*ppStream = pStream;
279	return VINF_SUCCESS;
280	}
281	return RTErrConvertFromErrno(errno);
282	}
283	return VERR_NO_MEMORY;
284	}
285
286
287	/**
288	* Opens a file stream.
289	*
290	* @returns iprt status code.
291	* @param pszMode The open mode. See fopen() standard.
292	* Format: <a\|r\|w>[+][b\|t]
293	* @param ppStream Where to store the opened stream.
294	* @param pszFilenameFmt Filename path format string.
295	* @param args Arguments to the format string.
296	*/
297	RTR3DECL(int) RTStrmOpenFV(const char pszMode, PRTSTREAM ppStream, const char *pszFilenameFmt, va_list args)
298	{
299	int rc;
300	char szFilename[RTPATH_MAX];
301	size_t cch = RTStrPrintfV(szFilename, sizeof(szFilename), pszFilenameFmt, args);
302	if (cch < sizeof(szFilename))
303	rc = RTStrmOpen(szFilename, pszMode, ppStream);
304	else
305	{
306	AssertMsgFailed(("The filename is too long cch=%d\n", cch));
307	rc = VERR_FILENAME_TOO_LONG;
308	}
309	return rc;
310	}
311
312
313	/**
314	* Opens a file stream.
315	*
316	* @returns iprt status code.
317	* @param pszMode The open mode. See fopen() standard.
318	* Format: <a\|r\|w>[+][b\|t]
319	* @param ppStream Where to store the opened stream.
320	* @param pszFilenameFmt Filename path format string.
321	* @param ... Arguments to the format string.
322	*/
323	RTR3DECL(int) RTStrmOpenF(const char pszMode, PRTSTREAM ppStream, const char *pszFilenameFmt, ...)
324	{
325	va_list args;
326	va_start(args, pszFilenameFmt);
327	int rc = RTStrmOpenFV(pszMode, ppStream, pszFilenameFmt, args);
328	va_end(args);
329	return rc;
330	}
331
332
333	/**
334	* Closes the specified stream.
335	*
336	* @returns iprt status code.
337	* @param pStream The stream to close.
338	*/
339	RTR3DECL(int) RTStrmClose(PRTSTREAM pStream)
340	{
341	if (pStream && pStream->u32Magic == RTSTREAM_MAGIC)
342	{
343	if (!fclose(pStream->pFile))
344	{
345	pStream->u32Magic = 0xdeaddead;
346	pStream->pFile = NULL;
347	#ifndef HAVE_FWRITE_UNLOCKED
348	if (pStream->pCritSect)
349	{
350	RTCritSectEnter(pStream->pCritSect);
351	RTCritSectLeave(pStream->pCritSect);
352	RTCritSectDelete(pStream->pCritSect);
353	RTMemFree(pStream->pCritSect);
354	pStream->pCritSect = NULL;
355	}
356	#endif
357	RTMemFree(pStream);
358	return VINF_SUCCESS;
359	}
360
361	return RTErrConvertFromErrno(errno);
362	}
363	else
364	{
365	AssertMsgFailed(("Invalid stream!\n"));
366	return VERR_INVALID_PARAMETER;
367	}
368	}
369
370
371	/**
372	* Get the pending error of the stream.
373	*
374	* @returns iprt status code. of the stream.
375	* @param pStream The stream.
376	*/
377	RTR3DECL(int) RTStrmError(PRTSTREAM pStream)
378	{
379	int rc;
380	if (pStream && pStream->u32Magic == RTSTREAM_MAGIC)
381	rc = pStream->i32Error;
382	else
383	{
384	AssertMsgFailed(("Invalid stream!\n"));
385	rc = VERR_INVALID_PARAMETER;
386	}
387	return rc;
388	}
389
390
391	/**
392	* Clears stream error condition.
393	*
394	* All stream operations save RTStrmClose and this will fail
395	* while an error is asserted on the stream
396	*
397	* @returns iprt status code.
398	* @param pStream The stream.
399	*/
400	RTR3DECL(int) RTStrmClearError(PRTSTREAM pStream)
401	{
402	int rc;
403	if (pStream && pStream->u32Magic == RTSTREAM_MAGIC)
404	{
405	clearerr(pStream->pFile);
406	ASMAtomicXchgS32(&pStream->i32Error, VINF_SUCCESS);
407	rc = VINF_SUCCESS;
408	}
409	else
410	{
411	AssertMsgFailed(("Invalid stream!\n"));
412	rc = VERR_INVALID_PARAMETER;
413	}
414	return rc;
415	}
416
417
418	/**
419	* Rewinds the stream.
420	*
421	* Stream errors will be reset on success.
422	*
423	* @returns IPRT status code.
424	*
425	* @param pStream The stream.
426	*
427	* @remarks Not all streams are rewindable and that behavior is currently
428	* undefined for those.
429	*/
430	RTR3DECL(int) RTStrmRewind(PRTSTREAM pStream)
431	{
432	AssertPtrReturn(pStream, VERR_INVALID_HANDLE);
433	AssertReturn(pStream->u32Magic == RTSTREAM_MAGIC, VERR_INVALID_HANDLE);
434
435	int rc;
436	clearerr(pStream->pFile);
437	errno = 0;
438	if (!fseek(pStream->pFile, 0, SEEK_SET))
439	{
440	ASMAtomicXchgS32(&pStream->i32Error, VINF_SUCCESS);
441	rc = VINF_SUCCESS;
442	}
443	else
444	{
445	rc = RTErrConvertFromErrno(errno);
446	ASMAtomicXchgS32(&pStream->i32Error, rc);
447	}
448
449	return rc;
450	}
451
452
453	/**
454	* Reads from a file stream.
455	*
456	* @returns iprt status code.
457	* @param pStream The stream.
458	* @param pvBuf Where to put the read bits.
459	* Must be cbRead bytes or more.
460	* @param cbRead Number of bytes to read.
461	* @param pcbRead Where to store the number of bytes actually read.
462	* If NULL cbRead bytes are read or an error is returned.
463	*/
464	RTR3DECL(int) RTStrmReadEx(PRTSTREAM pStream, void pvBuf, size_t cbRead, size_t pcbRead)
465	{
466	int rc;
467	if (pStream && pStream->u32Magic == RTSTREAM_MAGIC)
468	{
469	rc = pStream->i32Error;
470	if (RT_SUCCESS(rc))
471	{
472	if (pcbRead)
473	{
474	/*
475	* Can do with a partial read.
476	*/
477	*pcbRead = fread(pvBuf, 1, cbRead, pStream->pFile);
478	if ( *pcbRead == cbRead
479	\|\| !ferror(pStream->pFile))
480	return VINF_SUCCESS;
481	if (feof(pStream->pFile))
482	{
483	if (*pcbRead)
484	return VINF_EOF;
485	rc = VERR_EOF;
486	}
487	else if (ferror(pStream->pFile))
488	rc = VERR_READ_ERROR;
489	else
490	{
491	AssertMsgFailed(("This shouldn't happen\n"));
492	rc = VERR_INTERNAL_ERROR;
493	}
494	}
495	else
496	{
497	/*
498	* Must read it all!
499	*/
500	if (fread(pvBuf, cbRead, 1, pStream->pFile) == 1)
501	return VINF_SUCCESS;
502
503	/* possible error/eof. */
504	if (feof(pStream->pFile))
505	rc = VERR_EOF;
506	else if (ferror(pStream->pFile))
507	rc = VERR_READ_ERROR;
508	else
509	{
510	AssertMsgFailed(("This shouldn't happen\n"));
511	rc = VERR_INTERNAL_ERROR;
512	}
513	}
514	ASMAtomicXchgS32(&pStream->i32Error, rc);
515	}
516	}
517	else
518	{
519	AssertMsgFailed(("Invalid stream!\n"));
520	rc = VERR_INVALID_PARAMETER;
521	}
522	return rc;
523	}
524
525
526	/**
527	* Writes to a file stream.
528	*
529	* @returns iprt status code.
530	* @param pStream The stream.
531	* @param pvBuf Where to get the bits to write from.
532	* @param cbWrite Number of bytes to write.
533	* @param pcbWritten Where to store the number of bytes actually written.
534	* If NULL cbWrite bytes are written or an error is returned.
535	*/
536	RTR3DECL(int) RTStrmWriteEx(PRTSTREAM pStream, const void pvBuf, size_t cbWrite, size_t pcbWritten)
537	{
538	int rc;
539	if (pStream && pStream->u32Magic == RTSTREAM_MAGIC)
540	{
541	rc = pStream->i32Error;
542	if (RT_SUCCESS(rc))
543	{
544	if (pcbWritten)
545	{
546	IPRT_ALIGNMENT_CHECKS_DISABLE(); /* glibc / mempcpy again */
547	*pcbWritten = fwrite(pvBuf, 1, cbWrite, pStream->pFile);
548	IPRT_ALIGNMENT_CHECKS_ENABLE();
549	if ( *pcbWritten == cbWrite
550	\|\| !ferror(pStream->pFile))
551	return VINF_SUCCESS;
552	rc = VERR_WRITE_ERROR;
553	}
554	else
555	{
556	/*
557	* Must write it all!
558	*/
559	IPRT_ALIGNMENT_CHECKS_DISABLE(); /* glibc / mempcpy again */
560	size_t cbWritten = fwrite(pvBuf, cbWrite, 1, pStream->pFile);
561	IPRT_ALIGNMENT_CHECKS_ENABLE();
562	if (cbWritten == 1)
563	return VINF_SUCCESS;
564	if (!ferror(pStream->pFile))
565	return VINF_SUCCESS; /* WEIRD! But anyway... */
566
567	rc = VERR_WRITE_ERROR;
568	}
569	ASMAtomicXchgS32(&pStream->i32Error, rc);
570	}
571	}
572	else
573	{
574	AssertMsgFailed(("Invalid stream!\n"));
575	rc = VERR_INVALID_PARAMETER;
576	}
577	return rc;
578	}
579
580
581	/**
582	* Reads a character from a file stream.
583	*
584	* @returns The char as an unsigned char cast to int.
585	* @returns -1 on failure.
586	* @param pStream The stream.
587	*/
588	RTR3DECL(int) RTStrmGetCh(PRTSTREAM pStream)
589	{
590	unsigned char ch;
591	int rc = RTStrmReadEx(pStream, &ch, 1, NULL);
592	if (RT_SUCCESS(rc))
593	return ch;
594	return -1;
595	}
596
597
598	/**
599	* Writes a character to a file stream.
600	*
601	* @returns iprt status code.
602	* @param pStream The stream.
603	* @param ch The char to write.
604	*/
605	RTR3DECL(int) RTStrmPutCh(PRTSTREAM pStream, int ch)
606	{
607	return RTStrmWriteEx(pStream, &ch, 1, NULL);
608	}
609
610
611	/**
612	* Writes a string to a file stream.
613	*
614	* @returns iprt status code.
615	* @param pStream The stream.
616	* @param pszString The string to write.
617	* No newlines or anything is appended or prepended.
618	* The terminating '\\0' is not written, of course.
619	*/
620	RTR3DECL(int) RTStrmPutStr(PRTSTREAM pStream, const char *pszString)
621	{
622	size_t cch = strlen(pszString);
623	return RTStrmWriteEx(pStream, pszString, cch, NULL);
624	}
625
626
627	/**
628	* Reads a line from a file stream.
629	* A line ends with a '\\n', '\\0' or the end of the file.
630	*
631	* @returns iprt status code.
632	* @returns VINF_BUFFER_OVERFLOW if the buffer wasn't big enough to read an entire line.
633	* @param pStream The stream.
634	* @param pszString Where to store the line.
635	* The line will NOT contain any '\\n'.
636	* @param cchString The size of the string buffer.
637	*/
638	RTR3DECL(int) RTStrmGetLine(PRTSTREAM pStream, char *pszString, size_t cchString)
639	{
640	int rc;
641	if (pStream && pStream->u32Magic == RTSTREAM_MAGIC)
642	{
643	if (pszString && cchString > 1)
644	{
645	rc = pStream->i32Error;
646	if (RT_SUCCESS(rc))
647	{
648	cchString--; /* save space for the terminator. */
649	rtStrmLock(pStream);
650	for (;;)
651	{
652	#ifdef HAVE_FWRITE_UNLOCKED /** @todo darwin + freebsd(?) has fgetc_unlocked but not fwrite_unlocked, optimize... */
653	int ch = fgetc_unlocked(pStream->pFile);
654	#else
655	int ch = fgetc(pStream->pFile);
656	#endif
657	if (ch == EOF)
658	{
659	#ifdef HAVE_FWRITE_UNLOCKED
660	if (feof_unlocked(pStream->pFile))
661	#else
662	if (feof(pStream->pFile))
663	#endif
664	{
665	rc = VERR_EOF;
666	break;
667	}
668	#ifdef HAVE_FWRITE_UNLOCKED
669	if (ferror_unlocked(pStream->pFile))
670	#else
671	if (ferror(pStream->pFile))
672	#endif
673	rc = VERR_READ_ERROR;
674	else
675	{
676	AssertMsgFailed(("This shouldn't happen\n"));
677	rc = VERR_INTERNAL_ERROR;
678	}
679	break;
680	}
681	if (ch == '\0' \|\| ch == '\n' \|\| ch == '\r')
682	break;
683	*pszString++ = ch;
684	if (--cchString <= 0)
685	{
686	rc = VINF_BUFFER_OVERFLOW;
687	break;
688	}
689	}
690	rtStrmUnlock(pStream);
691
692	*pszString = '\0';
693	if (RT_FAILURE(rc))
694	ASMAtomicXchgS32(&pStream->i32Error, rc);
695	}
696	}
697	else
698	{
699	AssertMsgFailed(("no buffer or too small buffer!\n"));
700	rc = VERR_INVALID_PARAMETER;
701	}
702	}
703	else
704	{
705	AssertMsgFailed(("Invalid stream!\n"));
706	rc = VERR_INVALID_PARAMETER;
707	}
708	return rc;
709	}
710
711
712	/**
713	* Flushes a stream.
714	*
715	* @returns iprt status code.
716	* @param pStream The stream to flush.
717	*/
718	RTR3DECL(int) RTStrmFlush(PRTSTREAM pStream)
719	{
720	if (!fflush(pStream->pFile))
721	return VINF_SUCCESS;
722	return RTErrConvertFromErrno(errno);
723	}
724
725
726	/**
727	* Output callback.
728	*
729	* @returns number of bytes written.
730	* @param pvArg User argument.
731	* @param pachChars Pointer to an array of utf-8 characters.
732	* @param cchChars Number of bytes in the character array pointed to by pachChars.
733	*/
734	static DECLCALLBACK(size_t) rtstrmOutput(void pvArg, const char pachChars, size_t cchChars)
735	{
736	if (cchChars)
737	{
738	PRTSTREAM pStream = (PRTSTREAM)pvArg;
739	int rc = pStream->i32Error;
740	if (RT_SUCCESS(rc))
741	{
742	IPRT_ALIGNMENT_CHECKS_DISABLE(); /* glibc / mempcpy again */
743	#ifdef HAVE_FWRITE_UNLOCKED
744	if (fwrite_unlocked(pachChars, cchChars, 1, pStream->pFile) != 1)
745	#else
746	if (fwrite(pachChars, cchChars, 1, pStream->pFile) != 1)
747	#endif
748	ASMAtomicXchgS32(&pStream->i32Error, VERR_WRITE_ERROR);
749	IPRT_ALIGNMENT_CHECKS_ENABLE();
750	}
751	}
752	/* else: ignore termination call. */
753	return cchChars;
754	}
755
756
757	/**
758	* Prints a formatted string to the specified stream.
759	*
760	* @returns Number of bytes printed.
761	* @param pStream The stream to print to.
762	* @param pszFormat IPRT format string.
763	* @param args Arguments specified by pszFormat.
764	*/
765	RTR3DECL(int) RTStrmPrintfV(PRTSTREAM pStream, const char *pszFormat, va_list args)
766	{
767	int rc;
768	if (pStream && pStream->u32Magic == RTSTREAM_MAGIC)
769	{
770	rc = pStream->i32Error;
771	if (RT_SUCCESS(rc))
772	{
773	rtStrmLock(pStream);
774	rc = (int)RTStrFormatV(rtstrmOutput, pStream, NULL, NULL, pszFormat, args);
775	rtStrmUnlock(pStream);
776	Assert(rc >= 0);
777	}
778	else
779	rc = -1;
780	}
781	else
782	{
783	AssertMsgFailed(("Invalid stream!\n"));
784	rc = -1;
785	}
786	return rc;
787	}
788
789
790	/**
791	* Prints a formatted string to the specified stream.
792	*
793	* @returns Number of bytes printed.
794	* @param pStream The stream to print to.
795	* @param pszFormat IPRT format string.
796	* @param ... Arguments specified by pszFormat.
797	*/
798	RTR3DECL(int) RTStrmPrintf(PRTSTREAM pStream, const char *pszFormat, ...)
799	{
800	va_list args;
801	va_start(args, pszFormat);
802	int rc = RTStrmPrintfV(pStream, pszFormat, args);
803	va_end(args);
804	return rc;
805	}
806
807
808	/**
809	* Prints a formatted string to the standard output stream (g_pStdOut).
810	*
811	* @returns Number of bytes printed.
812	* @param pszFormat IPRT format string.
813	* @param args Arguments specified by pszFormat.
814	*/
815	RTR3DECL(int) RTPrintfV(const char *pszFormat, va_list args)
816	{
817	return RTStrmPrintfV(g_pStdOut, pszFormat, args);
818	}
819
820
821	/**
822	* Prints a formatted string to the standard output stream (g_pStdOut).
823	*
824	* @returns Number of bytes printed.
825	* @param pszFormat IPRT format string.
826	* @param ... Arguments specified by pszFormat.
827	*/
828	RTR3DECL(int) RTPrintf(const char *pszFormat, ...)
829	{
830	va_list args;
831	va_start(args, pszFormat);
832	int rc = RTStrmPrintfV(g_pStdOut, pszFormat, args);
833	va_end(args);
834	return rc;
835	}
836

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Runtime/r3/stream.cpp@ 34147

Download in other formats: