2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Console Driver DLL
4 * FILE: win32ss/user/winsrv/consrv/condrv/text.c
5 * PURPOSE: Console Output Functions for text-mode screen-buffers
6 * PROGRAMMERS: Jeffrey Morlan
7 * Hermes Belusca-Maito (hermes.belusca@sfr.fr)
10 /* INCLUDES *******************************************************************/
17 /* GLOBALS ********************************************************************/
21 /* PRIVATE FUNCTIONS **********************************************************/
23 CONSOLE_IO_OBJECT_TYPE
24 TEXTMODE_BUFFER_GetType(PCONSOLE_SCREEN_BUFFER This
)
26 // return This->Header.Type;
27 return TEXTMODE_BUFFER
;
30 static CONSOLE_SCREEN_BUFFER_VTBL TextVtbl
=
32 TEXTMODE_BUFFER_GetType
,
37 ClearLineBuffer(PTEXTMODE_SCREEN_BUFFER Buff
);
41 CONSOLE_SCREEN_BUFFER_Initialize(OUT PCONSOLE_SCREEN_BUFFER
* Buffer
,
42 IN OUT PCONSOLE Console
,
45 CONSOLE_SCREEN_BUFFER_Destroy(IN OUT PCONSOLE_SCREEN_BUFFER Buffer
);
49 TEXTMODE_BUFFER_Initialize(OUT PCONSOLE_SCREEN_BUFFER
* Buffer
,
50 IN OUT PCONSOLE Console
,
51 IN PTEXTMODE_BUFFER_INFO TextModeInfo
)
53 NTSTATUS Status
= STATUS_SUCCESS
;
54 PTEXTMODE_SCREEN_BUFFER NewBuffer
= NULL
;
56 if (Console
== NULL
|| Buffer
== NULL
|| TextModeInfo
== NULL
)
57 return STATUS_INVALID_PARAMETER
;
61 Status
= CONSOLE_SCREEN_BUFFER_Initialize((PCONSOLE_SCREEN_BUFFER
*)&NewBuffer
,
63 sizeof(TEXTMODE_SCREEN_BUFFER
));
64 if (!NT_SUCCESS(Status
)) return Status
;
65 NewBuffer
->Header
.Type
= TEXTMODE_BUFFER
;
66 NewBuffer
->Vtbl
= &TextVtbl
;
68 NewBuffer
->Buffer
= ConsoleAllocHeap(HEAP_ZERO_MEMORY
,
69 TextModeInfo
->ScreenBufferSize
.X
*
70 TextModeInfo
->ScreenBufferSize
.Y
*
72 if (NewBuffer
->Buffer
== NULL
)
74 CONSOLE_SCREEN_BUFFER_Destroy((PCONSOLE_SCREEN_BUFFER
)NewBuffer
);
75 return STATUS_INSUFFICIENT_RESOURCES
;
78 NewBuffer
->ScreenBufferSize
= NewBuffer
->OldScreenBufferSize
79 = TextModeInfo
->ScreenBufferSize
;
80 NewBuffer
->ViewSize
= NewBuffer
->OldViewSize
81 = Console
->ConsoleSize
;
83 NewBuffer
->ViewOrigin
.X
= NewBuffer
->ViewOrigin
.Y
= 0;
84 NewBuffer
->VirtualY
= 0;
86 NewBuffer
->CursorBlinkOn
= NewBuffer
->ForceCursorOff
= FALSE
;
87 NewBuffer
->CursorInfo
.bVisible
= (TextModeInfo
->IsCursorVisible
&& (TextModeInfo
->CursorSize
!= 0));
88 NewBuffer
->CursorInfo
.dwSize
= min(max(TextModeInfo
->CursorSize
, 0), 100);
90 NewBuffer
->ScreenDefaultAttrib
= TextModeInfo
->ScreenAttrib
;
91 NewBuffer
->PopupDefaultAttrib
= TextModeInfo
->PopupAttrib
;
93 /* Initialize buffer to be empty with default attributes */
94 for (NewBuffer
->CursorPosition
.Y
= 0 ; NewBuffer
->CursorPosition
.Y
< NewBuffer
->ScreenBufferSize
.Y
; NewBuffer
->CursorPosition
.Y
++)
96 ClearLineBuffer(NewBuffer
);
98 NewBuffer
->CursorPosition
.X
= NewBuffer
->CursorPosition
.Y
= 0;
100 NewBuffer
->Mode
= ENABLE_PROCESSED_OUTPUT
| ENABLE_WRAP_AT_EOL_OUTPUT
;
102 *Buffer
= (PCONSOLE_SCREEN_BUFFER
)NewBuffer
;
103 return STATUS_SUCCESS
;
107 TEXTMODE_BUFFER_Destroy(IN OUT PCONSOLE_SCREEN_BUFFER Buffer
)
109 PTEXTMODE_SCREEN_BUFFER Buff
= (PTEXTMODE_SCREEN_BUFFER
)Buffer
;
112 * IMPORTANT !! Reinitialize the type so that we don't enter a recursive
113 * infinite loop when calling CONSOLE_SCREEN_BUFFER_Destroy.
115 Buffer
->Header
.Type
= SCREEN_BUFFER
;
117 ConsoleFreeHeap(Buff
->Buffer
);
119 CONSOLE_SCREEN_BUFFER_Destroy(Buffer
);
124 ConioCoordToPointer(PTEXTMODE_SCREEN_BUFFER Buff
, ULONG X
, ULONG Y
)
126 return &Buff
->Buffer
[((Y
+ Buff
->VirtualY
) % Buff
->ScreenBufferSize
.Y
) * Buff
->ScreenBufferSize
.X
+ X
];
130 ClearLineBuffer(PTEXTMODE_SCREEN_BUFFER Buff
)
132 PCHAR_INFO Ptr
= ConioCoordToPointer(Buff
, 0, Buff
->CursorPosition
.Y
);
135 for (Pos
= 0; Pos
< Buff
->ScreenBufferSize
.X
; Pos
++, Ptr
++)
138 Ptr
->Char
.UnicodeChar
= L
' ';
139 Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
144 ConioComputeUpdateRect(IN PTEXTMODE_SCREEN_BUFFER Buff
,
145 IN OUT PSMALL_RECT UpdateRect
,
149 if (Buff
->ScreenBufferSize
.X
<= Start
->X
+ Length
)
151 UpdateRect
->Left
= 0;
155 UpdateRect
->Left
= Start
->X
;
157 if (Buff
->ScreenBufferSize
.X
<= Start
->X
+ Length
)
159 UpdateRect
->Right
= Buff
->ScreenBufferSize
.X
- 1;
163 UpdateRect
->Right
= Start
->X
+ Length
- 1;
165 UpdateRect
->Top
= Start
->Y
;
166 UpdateRect
->Bottom
= Start
->Y
+ (Start
->X
+ Length
- 1) / Buff
->ScreenBufferSize
.X
;
167 if (Buff
->ScreenBufferSize
.Y
<= UpdateRect
->Bottom
)
169 UpdateRect
->Bottom
= Buff
->ScreenBufferSize
.Y
- 1;
174 * Move from one rectangle to another. We must be careful about the order that
175 * this is done, to avoid overwriting parts of the source before they are moved.
178 ConioMoveRegion(PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
179 PSMALL_RECT SrcRegion
,
180 PSMALL_RECT DstRegion
,
181 PSMALL_RECT ClipRegion
,
184 int Width
= ConioRectWidth(SrcRegion
);
185 int Height
= ConioRectHeight(SrcRegion
);
196 /* Moving down: work from bottom up */
197 SY
= SrcRegion
->Bottom
;
198 DY
= DstRegion
->Bottom
;
201 for (i
= 0; i
< Height
; i
++)
203 PCHAR_INFO SRow
= ConioCoordToPointer(ScreenBuffer
, 0, SY
);
204 PCHAR_INFO DRow
= ConioCoordToPointer(ScreenBuffer
, 0, DY
);
206 SX
= SrcRegion
->Left
;
207 DX
= DstRegion
->Left
;
211 /* Moving right: work from right to left */
212 SX
= SrcRegion
->Right
;
213 DX
= DstRegion
->Right
;
216 for (j
= 0; j
< Width
; j
++)
218 CHAR_INFO Cell
= SRow
[SX
];
219 if (SX
>= ClipRegion
->Left
&& SX
<= ClipRegion
->Right
&&
220 SY
>= ClipRegion
->Top
&& SY
<= ClipRegion
->Bottom
)
224 if (DX
>= ClipRegion
->Left
&& DX
<= ClipRegion
->Right
&&
225 DY
>= ClipRegion
->Top
&& DY
<= ClipRegion
->Bottom
)
238 ConioEffectiveCursorSize(PCONSOLE Console
, DWORD Scale
)
240 DWORD Size
= (Console
->ActiveBuffer
->CursorInfo
.dwSize
* Scale
+ 99) / 100;
241 /* If line input in progress, perhaps adjust for insert toggle */
242 if (Console
->LineBuffer
&& !Console
->LineComplete
&& (Console
->InsertMode
? !Console
->LineInsertToggle
: Console
->LineInsertToggle
))
243 return (Size
* 2 <= Scale
) ? (Size
* 2) : (Size
/ 2);
248 ConioResizeBuffer(PCONSOLE Console
,
249 PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
255 WORD CurrentAttribute
;
257 PCHAR_INFO OldBuffer
;
261 /* Buffer size is not allowed to be smaller than the view size */
262 if (Size
.X
< ScreenBuffer
->ViewSize
.X
|| Size
.Y
< ScreenBuffer
->ViewSize
.Y
)
263 return STATUS_INVALID_PARAMETER
;
265 if (Size
.X
== ScreenBuffer
->ScreenBufferSize
.X
&& Size
.Y
== ScreenBuffer
->ScreenBufferSize
.Y
)
267 // FIXME: Trigger a buffer resize event ??
268 return STATUS_SUCCESS
;
271 if (Console
->FixedSize
)
274 * The console is in fixed-size mode, so we cannot resize anything
275 * at the moment. However, keep those settings somewhere so that
276 * we can try to set them up when we will be allowed to do so.
278 ScreenBuffer
->OldScreenBufferSize
= Size
;
279 return STATUS_NOT_SUPPORTED
; // STATUS_SUCCESS
282 Buffer
= ConsoleAllocHeap(HEAP_ZERO_MEMORY
, Size
.X
* Size
.Y
* sizeof(CHAR_INFO
));
283 if (!Buffer
) return STATUS_NO_MEMORY
;
285 DPRINT1("Resizing (%d,%d) to (%d,%d)\n", ScreenBuffer
->ScreenBufferSize
.X
, ScreenBuffer
->ScreenBufferSize
.Y
, Size
.X
, Size
.Y
);
286 OldBuffer
= ScreenBuffer
->Buffer
;
288 for (CurrentY
= 0; CurrentY
< ScreenBuffer
->ScreenBufferSize
.Y
&& CurrentY
< Size
.Y
; CurrentY
++)
290 ptr
= ConioCoordToPointer(ScreenBuffer
, 0, CurrentY
);
291 if (Size
.X
<= ScreenBuffer
->ScreenBufferSize
.X
)
294 RtlCopyMemory(Buffer
+ Offset
, ptr
, Size
.X
* sizeof(CHAR_INFO
));
300 RtlCopyMemory(Buffer
+ Offset
, ptr
, ScreenBuffer
->ScreenBufferSize
.X
* sizeof(CHAR_INFO
));
301 Offset
+= ScreenBuffer
->ScreenBufferSize
.X
;
303 /* The attribute to be used is the one of the last cell of the current line */
304 CurrentAttribute
= ConioCoordToPointer(ScreenBuffer
,
305 ScreenBuffer
->ScreenBufferSize
.X
- 1,
306 CurrentY
)->Attributes
;
308 diff
= Size
.X
- ScreenBuffer
->ScreenBufferSize
.X
;
310 /* Zero-out the new part of the buffer */
311 for (i
= 0; i
< diff
; i
++)
313 ptr
= Buffer
+ Offset
;
314 ptr
->Char
.UnicodeChar
= L
' ';
315 ptr
->Attributes
= CurrentAttribute
;
321 if (Size
.Y
> ScreenBuffer
->ScreenBufferSize
.Y
)
323 diff
= Size
.X
* (Size
.Y
- ScreenBuffer
->ScreenBufferSize
.Y
);
325 /* Zero-out the new part of the buffer */
326 for (i
= 0; i
< diff
; i
++)
328 ptr
= Buffer
+ Offset
;
329 ptr
->Char
.UnicodeChar
= L
' ';
330 ptr
->Attributes
= ScreenBuffer
->ScreenDefaultAttrib
;
335 (void)InterlockedExchangePointer((PVOID
volatile*)&ScreenBuffer
->Buffer
, Buffer
);
336 ConsoleFreeHeap(OldBuffer
);
337 ScreenBuffer
->ScreenBufferSize
= ScreenBuffer
->OldScreenBufferSize
= Size
;
338 ScreenBuffer
->VirtualY
= 0;
340 /* Ensure cursor and window are within buffer */
341 if (ScreenBuffer
->CursorPosition
.X
>= Size
.X
)
342 ScreenBuffer
->CursorPosition
.X
= Size
.X
- 1;
343 if (ScreenBuffer
->CursorPosition
.Y
>= Size
.Y
)
344 ScreenBuffer
->CursorPosition
.Y
= Size
.Y
- 1;
345 if (ScreenBuffer
->ViewOrigin
.X
> Size
.X
- ScreenBuffer
->ViewSize
.X
)
346 ScreenBuffer
->ViewOrigin
.X
= Size
.X
- ScreenBuffer
->ViewSize
.X
;
347 if (ScreenBuffer
->ViewOrigin
.Y
> Size
.Y
- ScreenBuffer
->ViewSize
.Y
)
348 ScreenBuffer
->ViewOrigin
.Y
= Size
.Y
- ScreenBuffer
->ViewSize
.Y
;
351 * Trigger a buffer resize event
353 if (Console
->InputBuffer
.Mode
& ENABLE_WINDOW_INPUT
)
357 er
.EventType
= WINDOW_BUFFER_SIZE_EVENT
;
358 er
.Event
.WindowBufferSizeEvent
.dwSize
= ScreenBuffer
->ScreenBufferSize
;
360 ConioProcessInputEvent(Console
, &er
);
363 return STATUS_SUCCESS
;
367 ConioNextLine(PTEXTMODE_SCREEN_BUFFER Buff
, PSMALL_RECT UpdateRect
, PUINT ScrolledLines
)
369 /* If we hit bottom, slide the viewable screen */
370 if (++Buff
->CursorPosition
.Y
== Buff
->ScreenBufferSize
.Y
)
372 Buff
->CursorPosition
.Y
--;
373 if (++Buff
->VirtualY
== Buff
->ScreenBufferSize
.Y
)
378 ClearLineBuffer(Buff
);
379 if (UpdateRect
->Top
!= 0)
384 UpdateRect
->Left
= 0;
385 UpdateRect
->Right
= Buff
->ScreenBufferSize
.X
- 1;
386 UpdateRect
->Bottom
= Buff
->CursorPosition
.Y
;
390 ConioWriteConsole(PCONSOLE Console
,
391 PTEXTMODE_SCREEN_BUFFER Buff
,
398 SMALL_RECT UpdateRect
;
399 SHORT CursorStartX
, CursorStartY
;
402 CursorStartX
= Buff
->CursorPosition
.X
;
403 CursorStartY
= Buff
->CursorPosition
.Y
;
404 UpdateRect
.Left
= Buff
->ScreenBufferSize
.X
;
405 UpdateRect
.Top
= Buff
->CursorPosition
.Y
;
406 UpdateRect
.Right
= -1;
407 UpdateRect
.Bottom
= Buff
->CursorPosition
.Y
;
410 for (i
= 0; i
< Length
; i
++)
413 * If we are in processed mode, interpret special characters and
414 * display them correctly. Otherwise, just put them into the buffer.
416 if (Buff
->Mode
& ENABLE_PROCESSED_OUTPUT
)
419 if (Buffer
[i
] == L
'\r')
421 Buff
->CursorPosition
.X
= 0;
422 UpdateRect
.Left
= min(UpdateRect
.Left
, Buff
->CursorPosition
.X
);
423 UpdateRect
.Right
= max(UpdateRect
.Right
, Buff
->CursorPosition
.X
);
427 else if (Buffer
[i
] == L
'\n')
429 Buff
->CursorPosition
.X
= 0;
430 ConioNextLine(Buff
, &UpdateRect
, &ScrolledLines
);
434 else if (Buffer
[i
] == L
'\b')
436 /* Only handle BS if we're not on the first pos of the first line */
437 if (0 != Buff
->CursorPosition
.X
|| 0 != Buff
->CursorPosition
.Y
)
439 if (0 == Buff
->CursorPosition
.X
)
441 /* slide virtual position up */
442 Buff
->CursorPosition
.X
= Buff
->ScreenBufferSize
.X
- 1;
443 Buff
->CursorPosition
.Y
--;
444 UpdateRect
.Top
= min(UpdateRect
.Top
, Buff
->CursorPosition
.Y
);
448 Buff
->CursorPosition
.X
--;
450 Ptr
= ConioCoordToPointer(Buff
, Buff
->CursorPosition
.X
, Buff
->CursorPosition
.Y
);
451 Ptr
->Char
.UnicodeChar
= L
' ';
452 Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
453 UpdateRect
.Left
= min(UpdateRect
.Left
, Buff
->CursorPosition
.X
);
454 UpdateRect
.Right
= max(UpdateRect
.Right
, Buff
->CursorPosition
.X
);
459 else if (Buffer
[i
] == L
'\t')
463 UpdateRect
.Left
= min(UpdateRect
.Left
, Buff
->CursorPosition
.X
);
464 EndX
= (Buff
->CursorPosition
.X
+ TAB_WIDTH
) & ~(TAB_WIDTH
- 1);
465 EndX
= min(EndX
, (UINT
)Buff
->ScreenBufferSize
.X
);
466 Ptr
= ConioCoordToPointer(Buff
, Buff
->CursorPosition
.X
, Buff
->CursorPosition
.Y
);
467 while (Buff
->CursorPosition
.X
< EndX
)
469 Ptr
->Char
.UnicodeChar
= L
' ';
470 Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
472 Buff
->CursorPosition
.X
++;
474 UpdateRect
.Right
= max(UpdateRect
.Right
, Buff
->CursorPosition
.X
- 1);
475 if (Buff
->CursorPosition
.X
== Buff
->ScreenBufferSize
.X
)
477 if (Buff
->Mode
& ENABLE_WRAP_AT_EOL_OUTPUT
)
479 Buff
->CursorPosition
.X
= 0;
480 ConioNextLine(Buff
, &UpdateRect
, &ScrolledLines
);
484 Buff
->CursorPosition
.X
--;
490 // else if (Buffer[i] == L'\a')
492 // // FIXME: This MUST BE moved to the terminal emulator frontend!!
493 // DPRINT1("Bell\n");
494 // // SendNotifyMessage(Console->hWindow, PM_CONSOLE_BEEP, 0, 0);
498 UpdateRect
.Left
= min(UpdateRect
.Left
, Buff
->CursorPosition
.X
);
499 UpdateRect
.Right
= max(UpdateRect
.Right
, Buff
->CursorPosition
.X
);
501 Ptr
= ConioCoordToPointer(Buff
, Buff
->CursorPosition
.X
, Buff
->CursorPosition
.Y
);
502 Ptr
->Char
.UnicodeChar
= Buffer
[i
];
503 if (Attrib
) Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
505 Buff
->CursorPosition
.X
++;
506 if (Buff
->CursorPosition
.X
== Buff
->ScreenBufferSize
.X
)
508 if (Buff
->Mode
& ENABLE_WRAP_AT_EOL_OUTPUT
)
510 Buff
->CursorPosition
.X
= 0;
511 ConioNextLine(Buff
, &UpdateRect
, &ScrolledLines
);
515 Buff
->CursorPosition
.X
= CursorStartX
;
520 if (!ConioIsRectEmpty(&UpdateRect
) && (PCONSOLE_SCREEN_BUFFER
)Buff
== Console
->ActiveBuffer
)
522 TermWriteStream(Console
, &UpdateRect
, CursorStartX
, CursorStartY
,
523 ScrolledLines
, Buffer
, Length
);
526 return STATUS_SUCCESS
;
530 ConDrvChangeScreenBufferAttributes(IN PCONSOLE Console
,
531 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
532 IN USHORT NewScreenAttrib
,
533 IN USHORT NewPopupAttrib
)
539 ULONG NumCodesToWrite
;
540 USHORT OldScreenAttrib
;
542 if (Console
== NULL
|| Buffer
== NULL
)
544 return STATUS_INVALID_PARAMETER
;
548 ASSERT(Console
== Buffer
->Header
.Console
);
550 NumCodesToWrite
= Buffer
->ScreenBufferSize
.X
* Buffer
->ScreenBufferSize
.Y
;
551 OldScreenAttrib
= Buffer
->ScreenDefaultAttrib
;
554 Y
= (TopLeft
.Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
555 Length
= NumCodesToWrite
;
557 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
558 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
562 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
563 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
566 * Change the current colors only if they are the old ones.
569 /* Foreground color */
570 if ((Ptr
->Attributes
& 0x0F) == (OldScreenAttrib
& 0x0F))
571 Ptr
->Attributes
= (Ptr
->Attributes
& 0xFFF0) | (NewScreenAttrib
& 0x0F);
573 /* Background color */
574 if ((Ptr
->Attributes
& 0xF0) == (OldScreenAttrib
& 0xF0))
575 Ptr
->Attributes
= (Ptr
->Attributes
& 0xFF0F) | (NewScreenAttrib
& 0xF0);
579 if (++X
== Buffer
->ScreenBufferSize
.X
)
583 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
590 /* Save foreground and background colors for both screen and popup */
591 Buffer
->ScreenDefaultAttrib
= (NewScreenAttrib
& 0x00FF);
592 Buffer
->PopupDefaultAttrib
= (NewPopupAttrib
& 0x00FF);
594 /* Refresh the display if needed */
595 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
597 SMALL_RECT UpdateRect
;
598 ConioComputeUpdateRect(Buffer
, &UpdateRect
, &TopLeft
, NumCodesToWrite
);
599 TermDrawRegion(Console
, &UpdateRect
);
602 return STATUS_SUCCESS
;
606 /* PUBLIC DRIVER APIS *********************************************************/
609 ConDrvReadConsoleOutput(IN PCONSOLE Console
,
610 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
612 OUT PCHAR_INFO CharInfo
/*Buffer*/,
613 IN OUT PSMALL_RECT ReadRegion
)
616 SMALL_RECT ScreenBuffer
;
617 PCHAR_INFO CurCharInfo
;
618 SMALL_RECT CapturedReadRegion
;
621 if (Console
== NULL
|| Buffer
== NULL
|| CharInfo
== NULL
|| ReadRegion
== NULL
)
623 return STATUS_INVALID_PARAMETER
;
627 ASSERT(Console
== Buffer
->Header
.Console
);
629 CapturedReadRegion
= *ReadRegion
;
631 /* Make sure ReadRegion is inside the screen buffer */
632 ConioInitRect(&ScreenBuffer
, 0, 0,
633 Buffer
->ScreenBufferSize
.Y
- 1, Buffer
->ScreenBufferSize
.X
- 1);
634 if (!ConioGetIntersection(&CapturedReadRegion
, &ScreenBuffer
, &CapturedReadRegion
))
637 * It is okay to have a ReadRegion completely outside
638 * the screen buffer. No data is read then.
640 return STATUS_SUCCESS
;
643 CurCharInfo
= CharInfo
;
645 for (Y
= CapturedReadRegion
.Top
; Y
<= CapturedReadRegion
.Bottom
; ++Y
)
647 Ptr
= ConioCoordToPointer(Buffer
, CapturedReadRegion
.Left
, Y
);
648 for (X
= CapturedReadRegion
.Left
; X
<= CapturedReadRegion
.Right
; ++X
)
652 CurCharInfo
->Char
.UnicodeChar
= Ptr
->Char
.UnicodeChar
;
656 // ConsoleUnicodeCharToAnsiChar(Console, &CurCharInfo->Char.AsciiChar, &Ptr->Char.UnicodeChar);
657 WideCharToMultiByte(Console
->OutputCodePage
, 0, &Ptr
->Char
.UnicodeChar
, 1,
658 &CurCharInfo
->Char
.AsciiChar
, 1, NULL
, NULL
);
660 CurCharInfo
->Attributes
= Ptr
->Attributes
;
666 *ReadRegion
= CapturedReadRegion
;
668 return STATUS_SUCCESS
;
672 ConDrvWriteConsoleOutput(IN PCONSOLE Console
,
673 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
675 IN PCHAR_INFO CharInfo
/*Buffer*/,
676 IN OUT PSMALL_RECT WriteRegion
)
679 SMALL_RECT ScreenBuffer
;
680 PCHAR_INFO CurCharInfo
;
681 SMALL_RECT CapturedWriteRegion
;
684 if (Console
== NULL
|| Buffer
== NULL
|| CharInfo
== NULL
|| WriteRegion
== NULL
)
686 return STATUS_INVALID_PARAMETER
;
690 ASSERT(Console
== Buffer
->Header
.Console
);
692 CapturedWriteRegion
= *WriteRegion
;
694 /* Make sure WriteRegion is inside the screen buffer */
695 ConioInitRect(&ScreenBuffer
, 0, 0,
696 Buffer
->ScreenBufferSize
.Y
- 1, Buffer
->ScreenBufferSize
.X
- 1);
697 if (!ConioGetIntersection(&CapturedWriteRegion
, &ScreenBuffer
, &CapturedWriteRegion
))
700 * It is okay to have a WriteRegion completely outside
701 * the screen buffer. No data is written then.
703 return STATUS_SUCCESS
;
706 CurCharInfo
= CharInfo
;
708 for (Y
= CapturedWriteRegion
.Top
; Y
<= CapturedWriteRegion
.Bottom
; ++Y
)
710 Ptr
= ConioCoordToPointer(Buffer
, CapturedWriteRegion
.Left
, Y
);
711 for (X
= CapturedWriteRegion
.Left
; X
<= CapturedWriteRegion
.Right
; ++X
)
715 Ptr
->Char
.UnicodeChar
= CurCharInfo
->Char
.UnicodeChar
;
719 ConsoleAnsiCharToUnicodeChar(Console
, &Ptr
->Char
.UnicodeChar
, &CurCharInfo
->Char
.AsciiChar
);
721 Ptr
->Attributes
= CurCharInfo
->Attributes
;
727 TermDrawRegion(Console
, &CapturedWriteRegion
);
729 *WriteRegion
= CapturedWriteRegion
;
731 return STATUS_SUCCESS
;
735 ConDrvWriteConsole(IN PCONSOLE Console
,
736 IN PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
738 IN PVOID StringBuffer
,
739 IN ULONG NumCharsToWrite
,
740 OUT PULONG NumCharsWritten OPTIONAL
)
742 NTSTATUS Status
= STATUS_SUCCESS
;
743 PWCHAR Buffer
= NULL
;
747 if (Console
== NULL
|| ScreenBuffer
== NULL
/* || StringBuffer == NULL */)
748 return STATUS_INVALID_PARAMETER
;
750 /* Validity checks */
751 ASSERT(Console
== ScreenBuffer
->Header
.Console
);
752 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCharsToWrite
== 0));
754 // if (Console->PauseFlags & (PAUSED_FROM_KEYBOARD | PAUSED_FROM_SCROLLBAR | PAUSED_FROM_SELECTION))
755 if (Console
->PauseFlags
&& Console
->UnpauseEvent
!= NULL
)
757 return STATUS_PENDING
;
762 Buffer
= StringBuffer
;
766 Length
= MultiByteToWideChar(Console
->OutputCodePage
, 0,
770 Buffer
= RtlAllocateHeap(RtlGetProcessHeap(), 0, Length
* sizeof(WCHAR
));
773 MultiByteToWideChar(Console
->OutputCodePage
, 0,
776 (PWCHAR
)Buffer
, Length
);
780 Status
= STATUS_NO_MEMORY
;
786 if (NT_SUCCESS(Status
))
788 Status
= ConioWriteConsole(Console
,
793 if (NT_SUCCESS(Status
))
795 Written
= NumCharsToWrite
;
799 if (!Unicode
) RtlFreeHeap(RtlGetProcessHeap(), 0, Buffer
);
802 if (NumCharsWritten
) *NumCharsWritten
= Written
;
808 ConDrvReadConsoleOutputString(IN PCONSOLE Console
,
809 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
810 IN CODE_TYPE CodeType
,
811 OUT PVOID StringBuffer
,
812 IN ULONG NumCodesToRead
,
814 // OUT PCOORD EndCoord,
815 OUT PULONG NumCodesRead OPTIONAL
)
823 if (Console
== NULL
|| Buffer
== NULL
|| ReadCoord
== NULL
/* || EndCoord == NULL */)
825 return STATUS_INVALID_PARAMETER
;
828 /* Validity checks */
829 ASSERT(Console
== Buffer
->Header
.Console
);
830 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCodesToRead
== 0));
832 if (NumCodesRead
) *NumCodesRead
= 0;
837 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, AsciiChar
);
841 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, UnicodeChar
);
845 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, Attribute
);
849 return STATUS_INVALID_PARAMETER
;
852 ReadBuffer
= StringBuffer
;
854 Ypos
= (ReadCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
857 * MSDN (ReadConsoleOutputAttribute and ReadConsoleOutputCharacter) :
859 * If the number of attributes (resp. characters) to be read from extends
860 * beyond the end of the specified screen buffer row, attributes (resp.
861 * characters) are read from the next row. If the number of attributes
862 * (resp. characters) to be read from extends beyond the end of the console
863 * screen buffer, attributes (resp. characters) up to the end of the console
864 * screen buffer are read.
866 * TODO: Do NOT loop up to NumCodesToRead, but stop before
867 * if we are going to overflow...
869 // Ptr = ConioCoordToPointer(Buffer, Xpos, Ypos); // Doesn't work
870 for (i
= 0; i
< min(NumCodesToRead
, Buffer
->ScreenBufferSize
.X
* Buffer
->ScreenBufferSize
.Y
); ++i
)
872 // Ptr = ConioCoordToPointer(Buffer, Xpos, Ypos); // Doesn't work either
873 Ptr
= &Buffer
->Buffer
[Xpos
+ Ypos
* Buffer
->ScreenBufferSize
.X
];
878 ConsoleUnicodeCharToAnsiChar(Console
, (PCHAR
)ReadBuffer
, &Ptr
->Char
.UnicodeChar
);
882 *(PWCHAR
)ReadBuffer
= Ptr
->Char
.UnicodeChar
;
886 *(PWORD
)ReadBuffer
= Ptr
->Attributes
;
889 ReadBuffer
= (PVOID
)((ULONG_PTR
)ReadBuffer
+ CodeSize
);
894 if (Xpos
== Buffer
->ScreenBufferSize
.X
)
899 if (Ypos
== Buffer
->ScreenBufferSize
.Y
)
906 // EndCoord->X = Xpos;
907 // EndCoord->Y = (Ypos - Buffer->VirtualY + Buffer->ScreenBufferSize.Y) % Buffer->ScreenBufferSize.Y;
910 *NumCodesRead
= (ULONG
)((ULONG_PTR
)ReadBuffer
- (ULONG_PTR
)StringBuffer
) / CodeSize
;
913 return STATUS_SUCCESS
;
917 ConDrvWriteConsoleOutputString(IN PCONSOLE Console
,
918 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
919 IN CODE_TYPE CodeType
,
920 IN PVOID StringBuffer
,
921 IN ULONG NumCodesToWrite
,
922 IN PCOORD WriteCoord
,
923 // OUT PCOORD EndCoord,
924 OUT PULONG NumCodesWritten OPTIONAL
)
926 NTSTATUS Status
= STATUS_SUCCESS
;
927 PVOID WriteBuffer
= NULL
;
928 PWCHAR tmpString
= NULL
;
929 DWORD X
, Y
, Length
; // , Written = 0;
933 if (Console
== NULL
|| Buffer
== NULL
|| WriteCoord
== NULL
/* || EndCoord == NULL */)
935 return STATUS_INVALID_PARAMETER
;
938 /* Validity checks */
939 ASSERT(Console
== Buffer
->Header
.Console
);
940 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCodesToWrite
== 0));
942 if (NumCodesWritten
) *NumCodesWritten
= 0;
947 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, AsciiChar
);
951 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, UnicodeChar
);
955 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, Attribute
);
959 return STATUS_INVALID_PARAMETER
;
962 if (CodeType
== CODE_ASCII
)
964 /* Convert the ASCII string into Unicode before writing it to the console */
965 Length
= MultiByteToWideChar(Console
->OutputCodePage
, 0,
969 tmpString
= WriteBuffer
= RtlAllocateHeap(RtlGetProcessHeap(), 0, Length
* sizeof(WCHAR
));
972 MultiByteToWideChar(Console
->OutputCodePage
, 0,
975 (PWCHAR
)WriteBuffer
, Length
);
979 Status
= STATUS_NO_MEMORY
;
984 /* For CODE_UNICODE or CODE_ATTRIBUTE, we are already OK */
985 WriteBuffer
= StringBuffer
;
988 if (WriteBuffer
== NULL
|| !NT_SUCCESS(Status
)) goto Cleanup
;
991 Y
= (WriteCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
992 Length
= NumCodesToWrite
;
993 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
994 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
998 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
999 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
1005 Ptr
->Char
.UnicodeChar
= *(PWCHAR
)WriteBuffer
;
1008 case CODE_ATTRIBUTE
:
1009 Ptr
->Attributes
= *(PWORD
)WriteBuffer
;
1012 WriteBuffer
= (PVOID
)((ULONG_PTR
)WriteBuffer
+ CodeSize
);
1016 if (++X
== Buffer
->ScreenBufferSize
.X
)
1020 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
1027 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
1029 SMALL_RECT UpdateRect
;
1030 ConioComputeUpdateRect(Buffer
, &UpdateRect
, WriteCoord
, NumCodesToWrite
);
1031 TermDrawRegion(Console
, &UpdateRect
);
1035 // EndCoord->Y = (Y + Buffer->ScreenBufferSize.Y - Buffer->VirtualY) % Buffer->ScreenBufferSize.Y;
1038 if (tmpString
) RtlFreeHeap(RtlGetProcessHeap(), 0, tmpString
);
1040 if (NumCodesWritten
) *NumCodesWritten
= NumCodesToWrite
; // Written;
1045 ConDrvFillConsoleOutput(IN PCONSOLE Console
,
1046 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1047 IN CODE_TYPE CodeType
,
1048 IN CODE_ELEMENT Code
,
1049 IN ULONG NumCodesToWrite
,
1050 IN PCOORD WriteCoord
,
1051 OUT PULONG NumCodesWritten OPTIONAL
)
1053 DWORD X
, Y
, Length
; // , Written = 0;
1056 if (Console
== NULL
|| Buffer
== NULL
|| WriteCoord
== NULL
)
1058 return STATUS_INVALID_PARAMETER
;
1061 /* Validity check */
1062 ASSERT(Console
== Buffer
->Header
.Console
);
1064 if (NumCodesWritten
) *NumCodesWritten
= 0;
1066 if (CodeType
== CODE_ASCII
)
1068 /* Conversion from the ASCII char to the UNICODE char */
1070 ConsoleAnsiCharToUnicodeChar(Console
, &tmp
.UnicodeChar
, &Code
.AsciiChar
);
1075 Y
= (WriteCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
1076 Length
= NumCodesToWrite
;
1077 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
1078 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
1082 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
1083 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
1089 Ptr
->Char
.UnicodeChar
= Code
.UnicodeChar
;
1092 case CODE_ATTRIBUTE
:
1093 Ptr
->Attributes
= Code
.Attribute
;
1099 if (++X
== Buffer
->ScreenBufferSize
.X
)
1103 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
1110 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
1112 SMALL_RECT UpdateRect
;
1113 ConioComputeUpdateRect(Buffer
, &UpdateRect
, WriteCoord
, NumCodesToWrite
);
1114 TermDrawRegion(Console
, &UpdateRect
);
1117 if (NumCodesWritten
) *NumCodesWritten
= NumCodesToWrite
; // Written;
1118 return STATUS_SUCCESS
;
1122 ConDrvGetConsoleScreenBufferInfo(IN PCONSOLE Console
,
1123 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1124 OUT PCOORD ScreenBufferSize
,
1125 OUT PCOORD CursorPosition
,
1126 OUT PCOORD ViewOrigin
,
1127 OUT PCOORD ViewSize
,
1128 OUT PCOORD MaximumViewSize
,
1129 OUT PWORD Attributes
)
1131 if (Console
== NULL
|| Buffer
== NULL
|| ScreenBufferSize
== NULL
||
1132 CursorPosition
== NULL
|| ViewOrigin
== NULL
|| ViewSize
== NULL
||
1133 MaximumViewSize
== NULL
|| Attributes
== NULL
)
1135 return STATUS_INVALID_PARAMETER
;
1138 /* Validity check */
1139 ASSERT(Console
== Buffer
->Header
.Console
);
1141 *ScreenBufferSize
= Buffer
->ScreenBufferSize
;
1142 *CursorPosition
= Buffer
->CursorPosition
;
1143 *ViewOrigin
= Buffer
->ViewOrigin
;
1144 *ViewSize
= Buffer
->ViewSize
;
1145 *Attributes
= Buffer
->ScreenDefaultAttrib
;
1147 // FIXME: Refine the computation
1148 *MaximumViewSize
= Buffer
->ScreenBufferSize
;
1150 return STATUS_SUCCESS
;
1154 ConDrvSetConsoleTextAttribute(IN PCONSOLE Console
,
1155 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1158 if (Console
== NULL
|| Buffer
== NULL
)
1159 return STATUS_INVALID_PARAMETER
;
1161 /* Validity check */
1162 ASSERT(Console
== Buffer
->Header
.Console
);
1164 Buffer
->ScreenDefaultAttrib
= Attributes
;
1165 return STATUS_SUCCESS
;
1169 ConDrvSetConsoleScreenBufferSize(IN PCONSOLE Console
,
1170 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1175 if (Console
== NULL
|| Buffer
== NULL
|| Size
== NULL
)
1176 return STATUS_INVALID_PARAMETER
;
1178 /* Validity check */
1179 ASSERT(Console
== Buffer
->Header
.Console
);
1181 Status
= ConioResizeBuffer(Console
, Buffer
, *Size
);
1182 if (NT_SUCCESS(Status
)) TermResizeTerminal(Console
);
1188 ConDrvScrollConsoleScreenBuffer(IN PCONSOLE Console
,
1189 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1191 IN PSMALL_RECT ScrollRectangle
,
1192 IN BOOLEAN UseClipRectangle
,
1193 IN PSMALL_RECT ClipRectangle OPTIONAL
,
1194 IN PCOORD DestinationOrigin
,
1195 IN CHAR_INFO FillChar
)
1197 COORD CapturedDestinationOrigin
;
1198 SMALL_RECT ScreenBuffer
;
1199 SMALL_RECT SrcRegion
;
1200 SMALL_RECT DstRegion
;
1201 SMALL_RECT UpdateRegion
;
1202 SMALL_RECT CapturedClipRectangle
;
1204 if (Console
== NULL
|| Buffer
== NULL
|| ScrollRectangle
== NULL
||
1205 (UseClipRectangle
? ClipRectangle
== NULL
: FALSE
) || DestinationOrigin
== NULL
)
1207 return STATUS_INVALID_PARAMETER
;
1210 /* Validity check */
1211 ASSERT(Console
== Buffer
->Header
.Console
);
1213 CapturedDestinationOrigin
= *DestinationOrigin
;
1215 /* Make sure the source rectangle is inside the screen buffer */
1216 ConioInitRect(&ScreenBuffer
, 0, 0,
1217 Buffer
->ScreenBufferSize
.Y
- 1, Buffer
->ScreenBufferSize
.X
- 1);
1218 if (!ConioGetIntersection(&SrcRegion
, &ScreenBuffer
, ScrollRectangle
))
1220 return STATUS_SUCCESS
;
1223 /* If the source was clipped on the left or top, adjust the destination accordingly */
1224 if (ScrollRectangle
->Left
< 0)
1226 CapturedDestinationOrigin
.X
-= ScrollRectangle
->Left
;
1228 if (ScrollRectangle
->Top
< 0)
1230 CapturedDestinationOrigin
.Y
-= ScrollRectangle
->Top
;
1233 if (UseClipRectangle
)
1235 CapturedClipRectangle
= *ClipRectangle
;
1236 if (!ConioGetIntersection(&CapturedClipRectangle
, &CapturedClipRectangle
, &ScreenBuffer
))
1238 return STATUS_SUCCESS
;
1243 CapturedClipRectangle
= ScreenBuffer
;
1246 ConioInitRect(&DstRegion
,
1247 CapturedDestinationOrigin
.Y
,
1248 CapturedDestinationOrigin
.X
,
1249 CapturedDestinationOrigin
.Y
+ ConioRectHeight(&SrcRegion
) - 1,
1250 CapturedDestinationOrigin
.X
+ ConioRectWidth(&SrcRegion
) - 1);
1255 ConsoleAnsiCharToUnicodeChar(Console
, &tmp
, &FillChar
.Char
.AsciiChar
);
1256 FillChar
.Char
.UnicodeChar
= tmp
;
1259 ConioMoveRegion(Buffer
, &SrcRegion
, &DstRegion
, &CapturedClipRectangle
, FillChar
);
1261 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
1263 ConioGetUnion(&UpdateRegion
, &SrcRegion
, &DstRegion
);
1264 if (ConioGetIntersection(&UpdateRegion
, &UpdateRegion
, &CapturedClipRectangle
))
1266 /* Draw update region */
1267 TermDrawRegion(Console
, &UpdateRegion
);
1271 return STATUS_SUCCESS
;
1275 ConDrvSetConsoleWindowInfo(IN PCONSOLE Console
,
1276 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1277 IN BOOLEAN Absolute
,
1278 IN PSMALL_RECT WindowRect
)
1280 SMALL_RECT CapturedWindowRect
;
1282 if (Console
== NULL
|| Buffer
== NULL
|| WindowRect
== NULL
)
1283 return STATUS_INVALID_PARAMETER
;
1285 /* Validity check */
1286 ASSERT(Console
== Buffer
->Header
.Console
);
1288 CapturedWindowRect
= *WindowRect
;
1290 if (Absolute
== FALSE
)
1292 /* Relative positions given. Transform them to absolute ones */
1293 CapturedWindowRect
.Left
+= Buffer
->ViewOrigin
.X
;
1294 CapturedWindowRect
.Top
+= Buffer
->ViewOrigin
.Y
;
1295 CapturedWindowRect
.Right
+= Buffer
->ViewOrigin
.X
+ Buffer
->ViewSize
.X
- 1;
1296 CapturedWindowRect
.Bottom
+= Buffer
->ViewOrigin
.Y
+ Buffer
->ViewSize
.Y
- 1;
1299 /* See MSDN documentation on SetConsoleWindowInfo about the performed checks */
1300 if ( (CapturedWindowRect
.Left
< 0) || (CapturedWindowRect
.Top
< 0) ||
1301 (CapturedWindowRect
.Right
>= Buffer
->ScreenBufferSize
.X
) ||
1302 (CapturedWindowRect
.Bottom
>= Buffer
->ScreenBufferSize
.Y
) ||
1303 (CapturedWindowRect
.Right
<= CapturedWindowRect
.Left
) ||
1304 (CapturedWindowRect
.Bottom
<= CapturedWindowRect
.Top
) )
1306 return STATUS_INVALID_PARAMETER
;
1309 Buffer
->ViewOrigin
.X
= CapturedWindowRect
.Left
;
1310 Buffer
->ViewOrigin
.Y
= CapturedWindowRect
.Top
;
1312 Buffer
->ViewSize
.X
= CapturedWindowRect
.Right
- CapturedWindowRect
.Left
+ 1;
1313 Buffer
->ViewSize
.Y
= CapturedWindowRect
.Bottom
- CapturedWindowRect
.Top
+ 1;
1315 // TermResizeTerminal(Console);
1317 return STATUS_SUCCESS
;