mirror of
https://github.com/reactos/reactos.git
synced 2024-10-04 08:25:53 +00:00
4e697fee2c
As code grows, this will allow for better maintenance of the console stream code. In particular the input stream module will contain special code for handling TTYs, and this is something not all console programs will need. Having this code in a separate module will allow for the linker to possibly remove this code when it is unused.
163 lines
3.1 KiB
C
163 lines
3.1 KiB
C
/*
|
|
* PROJECT: ReactOS Console Utilities Library
|
|
* LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+)
|
|
* PURPOSE: Provides basic abstraction wrappers around CRT streams or
|
|
* Win32 console API I/O functions, to deal with i18n + Unicode
|
|
* related problems.
|
|
* COPYRIGHT: Copyright 2017-2018 ReactOS Team
|
|
* Copyright 2017-2018 Hermes Belusca-Maito
|
|
*/
|
|
|
|
#ifndef __OUTSTREAM_H__
|
|
#define __OUTSTREAM_H__
|
|
|
|
#pragma once
|
|
|
|
/*
|
|
* Enable this define if you want to only use CRT functions to output
|
|
* UNICODE stream to the console, as in the way explained by
|
|
* http://archives.miloush.net/michkap/archive/2008/03/18/8306597.html
|
|
*/
|
|
/** NOTE: Experimental! Don't use USE_CRT yet because output to console is a bit broken **/
|
|
// #define USE_CRT
|
|
|
|
#ifndef _UNICODE
|
|
#error The ConUtils library at the moment only supports compilation with _UNICODE defined!
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
// Shadow type, implementation-specific
|
|
typedef struct _CON_STREAM CON_STREAM, *PCON_STREAM;
|
|
|
|
// typedef INT (__stdcall *CON_READ_FUNC)(IN PCON_STREAM, IN PTCHAR, IN DWORD);
|
|
// Stream, szStr, len
|
|
typedef INT (__stdcall *CON_WRITE_FUNC)(IN PCON_STREAM, IN PTCHAR, IN DWORD);
|
|
|
|
|
|
/*
|
|
* Console I/O utility API -- Output
|
|
*/
|
|
|
|
INT
|
|
__stdcall
|
|
ConWrite(
|
|
IN PCON_STREAM Stream,
|
|
IN PTCHAR szStr,
|
|
IN DWORD len);
|
|
|
|
INT
|
|
ConStreamWrite(
|
|
IN PCON_STREAM Stream,
|
|
IN PTCHAR szStr,
|
|
IN DWORD len);
|
|
|
|
INT
|
|
ConPuts(
|
|
IN PCON_STREAM Stream,
|
|
IN LPWSTR szStr);
|
|
|
|
INT
|
|
ConPrintfV(
|
|
IN PCON_STREAM Stream,
|
|
IN LPWSTR szStr,
|
|
IN va_list args); // arg_ptr
|
|
|
|
INT
|
|
__cdecl
|
|
ConPrintf(
|
|
IN PCON_STREAM Stream,
|
|
IN LPWSTR szStr,
|
|
...);
|
|
|
|
INT
|
|
ConResPutsEx(
|
|
IN PCON_STREAM Stream,
|
|
IN HINSTANCE hInstance OPTIONAL,
|
|
IN UINT uID);
|
|
|
|
INT
|
|
ConResPuts(
|
|
IN PCON_STREAM Stream,
|
|
IN UINT uID);
|
|
|
|
INT
|
|
ConResPrintfExV(
|
|
IN PCON_STREAM Stream,
|
|
IN HINSTANCE hInstance OPTIONAL,
|
|
IN UINT uID,
|
|
IN va_list args); // arg_ptr
|
|
|
|
INT
|
|
ConResPrintfV(
|
|
IN PCON_STREAM Stream,
|
|
IN UINT uID,
|
|
IN va_list args); // arg_ptr
|
|
|
|
INT
|
|
__cdecl
|
|
ConResPrintfEx(
|
|
IN PCON_STREAM Stream,
|
|
IN HINSTANCE hInstance OPTIONAL,
|
|
IN UINT uID,
|
|
...);
|
|
|
|
INT
|
|
__cdecl
|
|
ConResPrintf(
|
|
IN PCON_STREAM Stream,
|
|
IN UINT uID,
|
|
...);
|
|
|
|
INT
|
|
ConMsgPuts(
|
|
IN PCON_STREAM Stream,
|
|
IN DWORD dwFlags,
|
|
IN LPCVOID lpSource OPTIONAL,
|
|
IN DWORD dwMessageId,
|
|
IN DWORD dwLanguageId);
|
|
|
|
INT
|
|
ConMsgPrintf2V(
|
|
IN PCON_STREAM Stream,
|
|
IN DWORD dwFlags,
|
|
IN LPCVOID lpSource OPTIONAL,
|
|
IN DWORD dwMessageId,
|
|
IN DWORD dwLanguageId,
|
|
IN va_list args); // arg_ptr
|
|
|
|
INT
|
|
ConMsgPrintfV(
|
|
IN PCON_STREAM Stream,
|
|
IN DWORD dwFlags,
|
|
IN LPCVOID lpSource OPTIONAL,
|
|
IN DWORD dwMessageId,
|
|
IN DWORD dwLanguageId,
|
|
IN va_list args); // arg_ptr
|
|
|
|
INT
|
|
__cdecl
|
|
ConMsgPrintf(
|
|
IN PCON_STREAM Stream,
|
|
IN DWORD dwFlags,
|
|
IN LPCVOID lpSource OPTIONAL,
|
|
IN DWORD dwMessageId,
|
|
IN DWORD dwLanguageId,
|
|
...);
|
|
|
|
|
|
|
|
VOID
|
|
ConClearLine(IN PCON_STREAM Stream);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __OUTSTREAM_H__ */
|
|
|
|
/* EOF */
|