Changeset 96089 in vbox for trunk/include

Timestamp:

Aug 7, 2022 2:12:29 AM (2 years ago)

Author:

vboxsync

Message:

IPRT/RTStream: Added RTStrmSeek, RTStrmTell, RTStrmSetBufferingMode and RTStrmQueryFileHandle. bugref:10261

Location:

trunk/include/iprt

Files:

• mangling.h (modified) (2 diffs)
• stream.h (modified) (4 diffs)

trunk/include/iprt/mangling.h

@@ -2290 +2290 @@
 # define RTStrmOpenFV                                   RT_MANGLER(RTStrmOpenFV)
 # define RTStrmOpenFileHandle                           RT_MANGLER(RTStrmOpenFileHandle)
+# define RTStrmQueryFileHandle                          RT_MANGLER(RTStrmQueryFileHandle)
 # define RTStrmPrintf                                   RT_MANGLER(RTStrmPrintf)
 # define RTStrmPrintfV                                  RT_MANGLER(RTStrmPrintfV)
@@ -2299 +2300 @@
 # define RTStrmReadEx                                   RT_MANGLER(RTStrmReadEx)
 # define RTStrmRewind                                   RT_MANGLER(RTStrmRewind)
+# define RTStrmSetBufferingMode                         RT_MANGLER(RTStrmSetBufferingMode)
 # define RTStrmSetMode                                  RT_MANGLER(RTStrmSetMode)
+# define RTStrmSeek                                     RT_MANGLER(RTStrmSeek)
+# define RTStrmTell                                     RT_MANGLER(RTStrmTell)
 # define RTStrmWriteEx                                  RT_MANGLER(RTStrmWriteEx)
 # define RTStrmIsTerminal                               RT_MANGLER(RTStrmIsTerminal)

trunk/include/iprt/stream.h

@@ -144 +144 @@
 
 /**
+ * Queries the file handle backing the stream.
+ *
+ * @returns iprt status code.
+ * @retval  VERR_NOT_AVAILABLE if the stream has no valid handle associated with
+ *          it.
+ *
+ * @param   pStream         The stream.
+ * @param   phFile          Where to return the file handle.  This should not be
+ *                          closed!
+ */
+RTR3DECL(int) RTStrmQueryFileHandle(PRTSTREAM pStream, PRTFILE phFile);
+
+/**
  * Closes the specified stream.
  *
@@ -188 +201 @@
 RTR3DECL(int) RTStrmSetMode(PRTSTREAM pStream, int fBinary, int fCurrentCodeSet);
 
+/** Stream buffering modes. */
+typedef enum RTSTRMBUFMODE
+{
+    RTSTRMBUFMODE_INVALID = 0,
+    RTSTRMBUFMODE_FULL,         /**< Full buffering. */
+    RTSTRMBUFMODE_LINE,         /**< Line buffering. On Windows this could be the same as RTSTRMBUFMODE_FULL. */
+    RTSTRMBUFMODE_UNBUFFERED,   /**< No buffering. */
+    RTSTRMBUFMODE_END,
+    RTSTRMBUFMODE_32BIT_HACK = 0x7fffffff
+} RTSTRMBUFMODE;
+
+/**
+ * Changes the stream buffering mode.
+ *
+ * @returns iprt status code.
+ * @param   pStream         The stream.
+ * @param   enmBufMode      The new buffering mode.
+ */
+RTR3DECL(int) RTStrmSetBufferingMode(PRTSTREAM pStream, RTSTRMBUFMODE enmBufMode);
+
 /**
  * Returns the current echo mode.
+ *
  * This works only for standard input streams.
  *
@@ -201 +235 @@
 /**
  * Changes the behavior for echoing inpit characters on the command line.
+ *
  * This works only for standard input streams.
  *
@@ -242 +277 @@
  */
 RTR3DECL(int) RTStrmRewind(PRTSTREAM pStream);
+
+/**
+ * Changes the file position.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   pStream         The stream.
+ * @param   off             The seek offset.
+ * @param   uMethod         Seek method, i.e. one of the RTFILE_SEEK_* defines.
+ *
+ * @remarks Not all streams are seekable and that behavior is currently
+ *          undefined for those.
+ */
+RTR3DECL(int) RTStrmSeek(PRTSTREAM pStream, RTFOFF off, uint32_t uMethod);
+
+/**
+ * Tells the stream position.
+ *
+ * @returns Stream position or IPRT error status. Non-negative numbers are
+ *          stream positions, while negative numbers are IPRT error stauses.
+ *
+ * @param   pStream         The stream.
+ *
+ * @remarks Not all streams have a position and that behavior is currently
+ *          undefined for those.
+ */
+RTR3DECL(RTFOFF) RTStrmTell(PRTSTREAM pStream);
 
 /**