sdk/lib/conutils/stream.h

   1 /*
   2  * COPYRIGHT:       See COPYING in the top level directory
   3  * PROJECT:         ReactOS Console Utilities Library
   4  * FILE:            sdk/lib/conutils/stream.h
   5  * PURPOSE:         Provides basic abstraction wrappers around CRT streams or
   6  *                  Win32 console API I/O functions, to deal with i18n + Unicode
   7  *                  related problems.
   8  * PROGRAMMERS:     - Hermes Belusca-Maito (for the library);
   9  *                  - All programmers who wrote the different console applications
  10  *                    from which I took those functions and improved them.
  11  */
  12
  13 #ifndef __STREAM_H__
  14 #define __STREAM_H__
  15
  16 /*
  17  * Enable this define if you want to only use CRT functions to output
  18  * UNICODE stream to the console, as in the way explained by
  19  * http://archives.miloush.net/michkap/archive/2008/03/18/8306597.html
  20  */
  21 /** NOTE: Experimental! Don't use USE_CRT yet because output to console is a bit broken **/
  22 // #define USE_CRT
  23
  24 #ifndef _UNICODE
  25 #error The ConUtils library at the moment only supports compilation with _UNICODE defined!
  26 #endif
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /*
  33  * Console I/O streams
  34  */
  35
  36 /*
  37  * See http://archives.miloush.net/michkap/archive/2009/08/14/9869928.html
  38  * for more information.
  39  */
  40 typedef enum _CON_STREAM_MODE
  41 {
  42     Binary = 0, // #define _O_BINARY    0x8000  // file mode is binary (untranslated)
  43                 // #define _O_RAW       _O_BINARY
  44     AnsiText,   // #define _O_TEXT      0x4000  // file mode is text (translated) -- "ANSI"
  45     WideText,   // #define _O_WTEXT     0x10000 // file mode is UTF16 with BOM (translated) -- "Unicode" of Windows
  46     UTF16Text,  // #define _O_U16TEXT   0x20000 // file mode is UTF16   no BOM (translated) --    ""          ""
  47     UTF8Text,   // #define _O_U8TEXT    0x40000 // file mode is UTF8    no BOM (translated)
  48 } CON_STREAM_MODE, *PCON_STREAM_MODE;
  49
  50 #define INVALID_CP  ((UINT)-1)
  51
  52 // Shadow type, implementation-specific
  53 typedef struct _CON_STREAM CON_STREAM, *PCON_STREAM;
  54
  55 // typedef INT (__stdcall *CON_READ_FUNC)(IN PCON_STREAM, IN PTCHAR, IN DWORD);
  56                                         // Stream,         szStr,     len
  57 typedef INT (__stdcall *CON_WRITE_FUNC)(IN PCON_STREAM, IN PTCHAR, IN DWORD);
  58
  59 /*
  60  * Standard console streams, initialized by
  61  * calls to ConStreamInit/ConInitStdStreams.
  62  */
  63 #if 0 // FIXME!
  64 extern CON_STREAM StdStreams[3];
  65 #define StdIn   (&StdStreams[0])
  66 #define StdOut  (&StdStreams[1])
  67 #define StdErr  (&StdStreams[2])
  68 #else
  69 extern CON_STREAM csStdIn;
  70 extern CON_STREAM csStdOut;
  71 extern CON_STREAM csStdErr;
  72 #define StdIn   (&csStdIn )
  73 #define StdOut  (&csStdOut)
  74 #define StdErr  (&csStdErr)
  75 #endif
  76
  77 BOOL
  78 ConStreamInitEx(
  79     OUT PCON_STREAM Stream,
  80     IN  PVOID Handle,
  81     IN  CON_STREAM_MODE Mode,
  82     IN  UINT CacheCodePage OPTIONAL,
  83     // IN ReadWriteMode ????
  84     // IN  CON_READ_FUNC ReadFunc OPTIONAL,
  85     IN  CON_WRITE_FUNC WriteFunc OPTIONAL);
  86
  87 BOOL
  88 ConStreamInit(
  89     OUT PCON_STREAM Stream,
  90     IN  PVOID Handle,
  91     // IN ReadWriteMode ????
  92     IN  CON_STREAM_MODE Mode,
  93     IN  UINT CacheCodePage OPTIONAL);
  94
  95
  96 /* Console Standard Streams initialization helpers */
  97 #ifdef USE_CRT
  98 #define ConInitStdStreamsAndMode(Mode, CacheCodePage) \
  99 do { \
 100     ConStreamInit(StdIn , stdin , (Mode), (CacheCodePage)); \
 101     ConStreamInit(StdOut, stdout, (Mode), (CacheCodePage)); \
 102     ConStreamInit(StdErr, stderr, (Mode), (CacheCodePage)); \
 103 } while(0)
 104 #else
 105 #define ConInitStdStreamsAndMode(Mode, CacheCodePage) \
 106 do { \
 107     ConStreamInit(StdIn , GetStdHandle(STD_INPUT_HANDLE) , (Mode), (CacheCodePage)); \
 108     ConStreamInit(StdOut, GetStdHandle(STD_OUTPUT_HANDLE), (Mode), (CacheCodePage)); \
 109     ConStreamInit(StdErr, GetStdHandle(STD_ERROR_HANDLE) , (Mode), (CacheCodePage)); \
 110 } while(0)
 111 #endif /* defined(USE_CRT) */
 112
 113 #ifdef _UNICODE
 114 /*
 115  * Use UTF8 by default for file output, because this mode is back-compatible
 116  * with ANSI, and it displays nice on terminals that support UTF8 by default
 117  * (not many terminals support UTF16 on the contrary).
 118  */
 119 #define ConInitStdStreams() \
 120     ConInitStdStreamsAndMode(UTF8Text, INVALID_CP); // Cache code page unused
 121 #else
 122 /* Use ANSI by default for file output */
 123 #define ConInitStdStreams() \
 124     ConInitStdStreamsAndMode(AnsiText, INVALID_CP);
 125 #endif /* defined(_UNICODE) */
 126
 127 /* Stream translation modes */
 128 BOOL
 129 ConStreamSetMode(
 130     IN PCON_STREAM Stream,
 131     IN CON_STREAM_MODE Mode,
 132     IN UINT CacheCodePage OPTIONAL);
 133
 134 #ifdef USE_CRT
 135 // FIXME!
 136 #warning The ConStreamSetCacheCodePage function does not make much sense with the CRT!
 137 #else
 138 BOOL
 139 ConStreamSetCacheCodePage(
 140     IN PCON_STREAM Stream,
 141     IN UINT CacheCodePage);
 142 #endif
 143
 144 HANDLE
 145 ConStreamGetOSHandle(
 146     IN PCON_STREAM Stream);
 147
 148 BOOL
 149 ConStreamSetOSHandle(
 150     IN PCON_STREAM Stream,
 151     IN HANDLE Handle);
 152
 153
 154 /*
 155  * Console I/O utility API
 156  * (for the moment, only Output)
 157  */
 158
 159 INT
 160 __stdcall
 161 ConWrite(
 162     IN PCON_STREAM Stream,
 163     IN PTCHAR szStr,
 164     IN DWORD len);
 165
 166 INT
 167 ConStreamWrite(
 168     IN PCON_STREAM Stream,
 169     IN PTCHAR szStr,
 170     IN DWORD len);
 171
 172 INT
 173 ConPuts(
 174     IN PCON_STREAM Stream,
 175     IN LPWSTR szStr);
 176
 177 INT
 178 ConPrintfV(
 179     IN PCON_STREAM Stream,
 180     IN LPWSTR  szStr,
 181     IN va_list args); // arg_ptr
 182
 183 INT
 184 __cdecl
 185 ConPrintf(
 186     IN PCON_STREAM Stream,
 187     IN LPWSTR szStr,
 188     ...);
 189
 190 INT
 191 ConResPutsEx(
 192     IN PCON_STREAM Stream,
 193     IN HINSTANCE hInstance OPTIONAL,
 194     IN UINT uID);
 195
 196 INT
 197 ConResPuts(
 198     IN PCON_STREAM Stream,
 199     IN UINT uID);
 200
 201 INT
 202 ConResPrintfExV(
 203     IN PCON_STREAM Stream,
 204     IN HINSTANCE hInstance OPTIONAL,
 205     IN UINT    uID,
 206     IN va_list args); // arg_ptr
 207
 208 INT
 209 ConResPrintfV(
 210     IN PCON_STREAM Stream,
 211     IN UINT    uID,
 212     IN va_list args); // arg_ptr
 213
 214 INT
 215 __cdecl
 216 ConResPrintfEx(
 217     IN PCON_STREAM Stream,
 218     IN HINSTANCE hInstance OPTIONAL,
 219     IN UINT uID,
 220     ...);
 221
 222 INT
 223 __cdecl
 224 ConResPrintf(
 225     IN PCON_STREAM Stream,
 226     IN UINT uID,
 227     ...);
 228
 229 INT
 230 ConMsgPuts(
 231     IN PCON_STREAM Stream,
 232     IN DWORD   dwFlags,
 233     IN LPCVOID lpSource OPTIONAL,
 234     IN DWORD   dwMessageId,
 235     IN DWORD   dwLanguageId);
 236
 237 INT
 238 ConMsgPrintf2V(
 239     IN PCON_STREAM Stream,
 240     IN DWORD   dwFlags,
 241     IN LPCVOID lpSource OPTIONAL,
 242     IN DWORD   dwMessageId,
 243     IN DWORD   dwLanguageId,
 244     IN va_list args); // arg_ptr
 245
 246 INT
 247 ConMsgPrintfV(
 248     IN PCON_STREAM Stream,
 249     IN DWORD   dwFlags,
 250     IN LPCVOID lpSource OPTIONAL,
 251     IN DWORD   dwMessageId,
 252     IN DWORD   dwLanguageId,
 253     IN va_list args); // arg_ptr
 254
 255 INT
 256 __cdecl
 257 ConMsgPrintf(
 258     IN PCON_STREAM Stream,
 259     IN DWORD   dwFlags,
 260     IN LPCVOID lpSource OPTIONAL,
 261     IN DWORD   dwMessageId,
 262     IN DWORD   dwLanguageId,
 263     ...);
 264
 265
 266
 267 VOID
 268 ConClearLine(IN PCON_STREAM Stream);
 269
 270
 271 #ifdef __cplusplus
 272 }
 273 #endif
 274 #endif  /* __STREAM_H__ */