mirror of
https://github.com/reactos/reactos.git
synced 2024-05-16 18:32:06 +00:00
31322f5df9
- Implement caching of individual (newline-separated) text lines; this behaviour can be enabled with a flag (enabled by MORE): CON_PAGER_CACHE_INCOMPLETE_LINE. This feature is necessary when reading a text file, whose text lines may span across two or more successive temporary read buffers, and is required for correctly determining whether the lines being read are blank and may be squeezed. - When squeezing blank lines, the blank-line check must be done for each line segment corresponding to the screen line (and following) that need to be displayed. This matches the behaviour of MS MORE.COM. - Fix the IsBlankLine() check to not consider FORM-FEEDs as being blank characters: This is necessary for correctly handling FORM-FEED expansion. Also note that MS MORE.COM only checks for spaces and TABs, so we are slightly overdoing these checks (considering other types of whitespace). - Get rid of ConCallPagerLine() and the intermediate CON_PAGER_DONT_OUTPUT state flag that were used repeatedly for each and every small line chunks. Instead, call directly the user-specified 'PagerLine' callback when we are about to start treating the next line segment to be displayed (see comment above). - Fix the exit return condition of ConPagerWorker(): it should return TRUE whenever we displayed all the required lines, and FALSE otherwise. Otherwise, the previous (buggy) condition on the data being read from the text file, may lead to the prompt not showing when a screenful of text has been displayed, if it happened that the current text buffer becomes empty at the same time (even if, overall, the text file hasn't been fully displayed). - In MorePagerLine(), when we encounter for the first time a blank line that will be squeezed with other successive ones, display a single blank line. But for that, just display one space and a newline: this single space is especially needed in order to force line wrapping when the ENABLE_VIRTUAL_TERMINAL_PROCESSING or DISABLE_NEWLINE_AUTO_RETURN console modes are enabled. Otherwise the cursor remains at the previous line (without wrapping), and just outputting one newline will not make it move past 2 lines as one would naively expect. |
||
|---|---|---|
| .. | ||
| CMakeLists.txt | ||
| conutils.h | ||
| instream.c | ||
| instream.h | ||
| outstream.c | ||
| outstream.h | ||
| pager.c | ||
| pager.h | ||
| README.txt | ||
| screen.c | ||
| screen.h | ||
| stream.c | ||
| stream.h | ||
| stream_private.h | ||
| utils.c | ||
| utils.h | ||
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".