reactos

mirror of https://github.com/reactos/reactos.git synced 2024-07-02 18:54:25 +00:00

History

Hermès Bélusca-Maïto f982d77b8a [CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions. - Start to doxygenate the library, focusing in great details on the functions of the "outstream" module. - Add a K32LoadStringEx function that expands (K32)LoadString by allowing a LanguageId parameter to be able to load strings from other languages than the current one. - Add "ConResMsg" helper functions to be able to (format and) print message strings with inserts that come NOT* from a message table (as usual) BUT from resource string tables. Will be helpful for CORE-14265 in particular. [CMD] Fix the call to ConMsgPrintfV().		2018-02-02 00:41:54 +01:00
..
CMakeLists.txt	[CONUTILS] Split stream.c into input and output stream modules.	2018-01-31 02:10:41 +01:00
conutils.h	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
instream.c	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
instream.h	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
outstream.c	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
outstream.h	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
pager.c	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
pager.h	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
README.txt	[CONUTILS] Split stream.c into input and output stream modules.	2018-01-31 02:10:41 +01:00
screen.c	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
screen.h	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
stream.c	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
stream.h	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
stream_private.h	[CONUTILS] Split stream.c into input and output stream modules.	2018-01-31 02:10:41 +01:00
utils.c	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00
utils.h	[CONUTILS] Diverse improvements: start doxygenating and add some resource messsage helper functions.	2018-02-02 00:41:54 +01:00

README.txt

The ReactOS Console Utilities Library v0.2
==========================================

LICENSE:    GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+)
COPYRIGHT:  Copyright 2017-2018 ReactOS Team
            Copyright 2017-2018 Hermes Belusca-Maito
CREDITS:    Thanks to the many people who originally wrote the code that finally
            ended up inside this library, with more or less refactoring, or
            whose code served as a basis for some functions of the library.


INTRODUCTION
~-~-~-~-~-~-

This library contains common functions used in many places inside the ReactOS
console utilities and the ReactOS Command-Line Interpreter. Most of these
functions are related with internationalisation and the problem of correctly
displaying Unicode text on the console. Besides those, helpful functions for
retrieving strings and messages from application resources are provided,
together with printf-like functionality.


CONTENTS
~-~-~-~-

-- Main ConUtils Library --

0. "BASE" (utils.c and utils.h): Base set of functions for loading
   string resources and message strings, and handle type identification.

1. "STREAM" (stream.c and stream.h, instream.c and instream.h, outstream.c
   and outstream.h): Console Stream API (CON_STREAM):
   Stream initialization, basic ConStreamRead/Write. Stream utility functions:
   ConPuts/Printf, ConResPuts/Printf, ConMsgPuts/Printf. Depends on "BASE".

2. "SCREEN" (screen.c and screen.h): Console Screen API (CON_SCREEN):
   Introduces the notion of console/terminal screen around the streams. Manages
   console/terminal screen metrics for Win32 consoles and TTYs (serial...).
   Additional Screen utility functions.
   Depends on "STREAM", and indirectly on "BASE".

3. "PAGER" (pager.c and pager.h): Console Pager API (CON_PAGER):
   Implements core console/terminal paging functionality around console screens.
   Depends on "SCREEN", and indirectly on "STREAM" and "BASE".