Changeset 68836 in vbox

Timestamp:

Sep 22, 2017 4:37:46 PM (7 years ago)

Author:

vboxsync

Message:

IPRT: Added RTStrmIsTerminal and RTStrmQueryTerminalWidth.

Location:

trunk

Files:

• include/iprt/mangling.h (modified) (2 diffs)
• include/iprt/stream.h (modified) (1 diff)
• src/VBox/Runtime/r3/stream.cpp (modified) (2 diffs)

trunk/include/iprt/mangling.h

@@ -1933 +1933 @@
 # define RTStrmFlush                                    RT_MANGLER(RTStrmFlush)
 # define RTStrmGetCh                                    RT_MANGLER(RTStrmGetCh)
-# define RTStrmInputGetEchoChars                        RT_MANGLER(RTStrmInputGetEchoChars)
 # define RTStrmGetLine                                  RT_MANGLER(RTStrmGetLine)
 # define RTStrmOpen                                     RT_MANGLER(RTStrmOpen)
@@ -1945 +1944 @@
 # define RTStrmReadEx                                   RT_MANGLER(RTStrmReadEx)
 # define RTStrmRewind                                   RT_MANGLER(RTStrmRewind)
-# define RTStrmInputSetEchoChars                        RT_MANGLER(RTStrmInputSetEchoChars)
 # define RTStrmSetMode                                  RT_MANGLER(RTStrmSetMode)
 # define RTStrmWriteEx                                  RT_MANGLER(RTStrmWriteEx)
+# define RTStrmIsTerminal                               RT_MANGLER(RTStrmIsTerminal)
+# define RTStrmInputGetEchoChars                        RT_MANGLER(RTStrmInputGetEchoChars)
+# define RTStrmInputSetEchoChars                        RT_MANGLER(RTStrmInputSetEchoChars)
+# define RTStrmQueryTerminalWidth                       RT_MANGLER(RTStrmQueryTerminalWidth)
 # define RTStrNCmp                                      RT_MANGLER(RTStrNCmp)
 # define RTStrNICmp                                     RT_MANGLER(RTStrNICmp)

trunk/include/iprt/stream.h

@@ -148 +148 @@
 
 /**
+ * Checks if this is a terminal (TTY) or not.
+ *
+ * @returns true if it is, false if it isn't or the stream isn't valid.
+ * @param   pStream         The stream.
+ */
+RTR3DECL(bool) RTStrmIsTerminal(PRTSTREAM pStream);
+
+/**
+ * Gets the width of the terminal the stream is associated with.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_INVALID_FUNCTION if not connected to a terminal.
+ * @param   pStream         The stream.
+ * @param   pcchWidth       Where to return the width.  This will never be zero
+ *                          and always be set, even on error.
+ */
+RTR3DECL(int) RTStrmQueryTerminalWidth(PRTSTREAM pStream, uint32_t *pcchWidth);
+
+/**
  * Rewinds the stream.
  *

trunk/src/VBox/Runtime/r3/stream.cpp

@@ -60 +60 @@
 #ifdef RT_OS_WINDOWS
 # include <iprt/win/windows.h>
-#endif
-#ifndef RT_OS_WINDOWS
+#else
 # include <termios.h>
 # include <unistd.h>
@@ -553 +552 @@
     return rc;
 }
+
+
+RTR3DECL(bool) RTStrmIsTerminal(PRTSTREAM pStream)
+{
+    AssertPtrReturn(pStream, false);
+    AssertReturn(pStream->u32Magic == RTSTREAM_MAGIC, false);
+
+    if (pStream->pFile)
+    {
+        int fh = fileno(pStream->pFile);
+        if (isatty(fh))
+        {
+#ifdef RT_OS_WINDOWS
+            DWORD  dwMode;
+            HANDLE hCon = (HANDLE)_get_osfhandle(fh);
+            if (GetConsoleMode(hCon, &dwMode))
+                return true;
+#else
+            return true;
+#endif
+        }
+    }
+    return false;
+}
+
+
+RTR3DECL(int) RTStrmQueryTerminalWidth(PRTSTREAM pStream, uint32_t *pcchWidth)
+{
+    AssertPtrReturn(pcchWidth, VERR_INVALID_HANDLE);
+    *pcchWidth = 80;
+
+    AssertPtrReturn(pStream, VERR_INVALID_HANDLE);
+    AssertReturn(pStream->u32Magic == RTSTREAM_MAGIC, VERR_INVALID_HANDLE);
+
+    if (pStream->pFile)
+    {
+        int fh = fileno(pStream->pFile);
+        if (isatty(fh))
+        {
+#ifdef RT_OS_WINDOWS
+            CONSOLE_SCREEN_BUFFER_INFO Info;
+            HANDLE hCon = (HANDLE)_get_osfhandle(fh);
+            RT_ZERO(Info);
+            if (GetConsoleScreenBufferInfo(hCon, &Info))
+            {
+                *pcchWidth = Info.dwSize.X ? Info.dwSize.X : 80;
+                return VINF_SUCCESS;
+            }
+            return RTErrConvertFromWin32(GetLastError());
+#else
+            struct winsize Info;
+            RT_ZERO(Info);
+            int rc = ioctl(fh, TIOCGWINSZ, &Info);
+            if (rc >= 0)
+            {
+                *pcchWidth = Info.ws_row ? Info.ws_row : 80;
+                return VINF_SUCCESS;
+            }
+            return RTErrConvertFromErrno(errno);
+#endif
+        }
+    }
+    return VERR_INVALID_FUNCTION;
+}
+