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
,
43 IN PCONSOLE_SCREEN_BUFFER_VTBL Vtbl
,
46 CONSOLE_SCREEN_BUFFER_Destroy(IN OUT PCONSOLE_SCREEN_BUFFER Buffer
);
50 TEXTMODE_BUFFER_Initialize(OUT PCONSOLE_SCREEN_BUFFER
* Buffer
,
51 IN OUT PCONSOLE Console
,
52 IN PTEXTMODE_BUFFER_INFO TextModeInfo
)
54 NTSTATUS Status
= STATUS_SUCCESS
;
55 PTEXTMODE_SCREEN_BUFFER NewBuffer
= NULL
;
57 if (Console
== NULL
|| Buffer
== NULL
|| TextModeInfo
== NULL
)
58 return STATUS_INVALID_PARAMETER
;
62 Status
= CONSOLE_SCREEN_BUFFER_Initialize((PCONSOLE_SCREEN_BUFFER
*)&NewBuffer
,
65 sizeof(TEXTMODE_SCREEN_BUFFER
));
66 if (!NT_SUCCESS(Status
)) return Status
;
67 NewBuffer
->Header
.Type
= TEXTMODE_BUFFER
;
69 NewBuffer
->Buffer
= ConsoleAllocHeap(HEAP_ZERO_MEMORY
,
70 TextModeInfo
->ScreenBufferSize
.X
*
71 TextModeInfo
->ScreenBufferSize
.Y
*
73 if (NewBuffer
->Buffer
== NULL
)
75 CONSOLE_SCREEN_BUFFER_Destroy((PCONSOLE_SCREEN_BUFFER
)NewBuffer
);
76 return STATUS_INSUFFICIENT_RESOURCES
;
79 NewBuffer
->ScreenBufferSize
= NewBuffer
->OldScreenBufferSize
80 = TextModeInfo
->ScreenBufferSize
;
81 NewBuffer
->ViewSize
= NewBuffer
->OldViewSize
82 = Console
->ConsoleSize
;
84 NewBuffer
->ViewOrigin
.X
= NewBuffer
->ViewOrigin
.Y
= 0;
85 NewBuffer
->VirtualY
= 0;
87 NewBuffer
->CursorBlinkOn
= NewBuffer
->ForceCursorOff
= FALSE
;
88 NewBuffer
->CursorInfo
.bVisible
= (TextModeInfo
->IsCursorVisible
&& (TextModeInfo
->CursorSize
!= 0));
89 NewBuffer
->CursorInfo
.dwSize
= min(max(TextModeInfo
->CursorSize
, 0), 100);
91 NewBuffer
->ScreenDefaultAttrib
= TextModeInfo
->ScreenAttrib
;
92 NewBuffer
->PopupDefaultAttrib
= TextModeInfo
->PopupAttrib
;
94 /* Initialize buffer to be empty with default attributes */
95 for (NewBuffer
->CursorPosition
.Y
= 0 ; NewBuffer
->CursorPosition
.Y
< NewBuffer
->ScreenBufferSize
.Y
; NewBuffer
->CursorPosition
.Y
++)
97 ClearLineBuffer(NewBuffer
);
99 NewBuffer
->CursorPosition
.X
= NewBuffer
->CursorPosition
.Y
= 0;
101 NewBuffer
->Mode
= ENABLE_PROCESSED_OUTPUT
| ENABLE_WRAP_AT_EOL_OUTPUT
;
103 *Buffer
= (PCONSOLE_SCREEN_BUFFER
)NewBuffer
;
104 return STATUS_SUCCESS
;
108 TEXTMODE_BUFFER_Destroy(IN OUT PCONSOLE_SCREEN_BUFFER Buffer
)
110 PTEXTMODE_SCREEN_BUFFER Buff
= (PTEXTMODE_SCREEN_BUFFER
)Buffer
;
113 * IMPORTANT !! Reinitialize the type so that we don't enter a recursive
114 * infinite loop when calling CONSOLE_SCREEN_BUFFER_Destroy.
116 Buffer
->Header
.Type
= SCREEN_BUFFER
;
118 ConsoleFreeHeap(Buff
->Buffer
);
120 CONSOLE_SCREEN_BUFFER_Destroy(Buffer
);
125 ConioCoordToPointer(PTEXTMODE_SCREEN_BUFFER Buff
, ULONG X
, ULONG Y
)
127 return &Buff
->Buffer
[((Y
+ Buff
->VirtualY
) % Buff
->ScreenBufferSize
.Y
) * Buff
->ScreenBufferSize
.X
+ X
];
131 ClearLineBuffer(PTEXTMODE_SCREEN_BUFFER Buff
)
133 PCHAR_INFO Ptr
= ConioCoordToPointer(Buff
, 0, Buff
->CursorPosition
.Y
);
136 for (Pos
= 0; Pos
< Buff
->ScreenBufferSize
.X
; Pos
++, Ptr
++)
139 Ptr
->Char
.UnicodeChar
= L
' ';
140 Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
145 ConioComputeUpdateRect(IN PTEXTMODE_SCREEN_BUFFER Buff
,
146 IN OUT PSMALL_RECT UpdateRect
,
150 if (Buff
->ScreenBufferSize
.X
<= Start
->X
+ Length
)
152 UpdateRect
->Left
= 0;
156 UpdateRect
->Left
= Start
->X
;
158 if (Buff
->ScreenBufferSize
.X
<= Start
->X
+ Length
)
160 UpdateRect
->Right
= Buff
->ScreenBufferSize
.X
- 1;
164 UpdateRect
->Right
= Start
->X
+ Length
- 1;
166 UpdateRect
->Top
= Start
->Y
;
167 UpdateRect
->Bottom
= Start
->Y
+ (Start
->X
+ Length
- 1) / Buff
->ScreenBufferSize
.X
;
168 if (Buff
->ScreenBufferSize
.Y
<= UpdateRect
->Bottom
)
170 UpdateRect
->Bottom
= Buff
->ScreenBufferSize
.Y
- 1;
175 * Move from one rectangle to another. We must be careful about the order that
176 * this is done, to avoid overwriting parts of the source before they are moved.
179 ConioMoveRegion(PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
180 PSMALL_RECT SrcRegion
,
181 PSMALL_RECT DstRegion
,
182 PSMALL_RECT ClipRegion
,
185 int Width
= ConioRectWidth(SrcRegion
);
186 int Height
= ConioRectHeight(SrcRegion
);
197 /* Moving down: work from bottom up */
198 SY
= SrcRegion
->Bottom
;
199 DY
= DstRegion
->Bottom
;
202 for (i
= 0; i
< Height
; i
++)
204 PCHAR_INFO SRow
= ConioCoordToPointer(ScreenBuffer
, 0, SY
);
205 PCHAR_INFO DRow
= ConioCoordToPointer(ScreenBuffer
, 0, DY
);
207 SX
= SrcRegion
->Left
;
208 DX
= DstRegion
->Left
;
212 /* Moving right: work from right to left */
213 SX
= SrcRegion
->Right
;
214 DX
= DstRegion
->Right
;
217 for (j
= 0; j
< Width
; j
++)
219 CHAR_INFO Cell
= SRow
[SX
];
220 if (SX
>= ClipRegion
->Left
&& SX
<= ClipRegion
->Right
&&
221 SY
>= ClipRegion
->Top
&& SY
<= ClipRegion
->Bottom
)
225 if (DX
>= ClipRegion
->Left
&& DX
<= ClipRegion
->Right
&&
226 DY
>= ClipRegion
->Top
&& DY
<= ClipRegion
->Bottom
)
239 ConioResizeBuffer(PCONSOLE Console
,
240 PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
246 WORD CurrentAttribute
;
248 PCHAR_INFO OldBuffer
;
252 /* Buffer size is not allowed to be smaller than the view size */
253 if (Size
.X
< ScreenBuffer
->ViewSize
.X
|| Size
.Y
< ScreenBuffer
->ViewSize
.Y
)
254 return STATUS_INVALID_PARAMETER
;
256 if (Size
.X
== ScreenBuffer
->ScreenBufferSize
.X
&& Size
.Y
== ScreenBuffer
->ScreenBufferSize
.Y
)
258 // FIXME: Trigger a buffer resize event ??
259 return STATUS_SUCCESS
;
262 if (Console
->FixedSize
)
265 * The console is in fixed-size mode, so we cannot resize anything
266 * at the moment. However, keep those settings somewhere so that
267 * we can try to set them up when we will be allowed to do so.
269 ScreenBuffer
->OldScreenBufferSize
= Size
;
270 return STATUS_NOT_SUPPORTED
; // STATUS_SUCCESS
273 Buffer
= ConsoleAllocHeap(HEAP_ZERO_MEMORY
, Size
.X
* Size
.Y
* sizeof(CHAR_INFO
));
274 if (!Buffer
) return STATUS_NO_MEMORY
;
276 DPRINT1("Resizing (%d,%d) to (%d,%d)\n", ScreenBuffer
->ScreenBufferSize
.X
, ScreenBuffer
->ScreenBufferSize
.Y
, Size
.X
, Size
.Y
);
277 OldBuffer
= ScreenBuffer
->Buffer
;
279 for (CurrentY
= 0; CurrentY
< ScreenBuffer
->ScreenBufferSize
.Y
&& CurrentY
< Size
.Y
; CurrentY
++)
281 ptr
= ConioCoordToPointer(ScreenBuffer
, 0, CurrentY
);
282 if (Size
.X
<= ScreenBuffer
->ScreenBufferSize
.X
)
285 RtlCopyMemory(Buffer
+ Offset
, ptr
, Size
.X
* sizeof(CHAR_INFO
));
291 RtlCopyMemory(Buffer
+ Offset
, ptr
, ScreenBuffer
->ScreenBufferSize
.X
* sizeof(CHAR_INFO
));
292 Offset
+= ScreenBuffer
->ScreenBufferSize
.X
;
294 /* The attribute to be used is the one of the last cell of the current line */
295 CurrentAttribute
= ConioCoordToPointer(ScreenBuffer
,
296 ScreenBuffer
->ScreenBufferSize
.X
- 1,
297 CurrentY
)->Attributes
;
299 diff
= Size
.X
- ScreenBuffer
->ScreenBufferSize
.X
;
301 /* Zero-out the new part of the buffer */
302 for (i
= 0; i
< diff
; i
++)
304 ptr
= Buffer
+ Offset
;
305 ptr
->Char
.UnicodeChar
= L
' ';
306 ptr
->Attributes
= CurrentAttribute
;
312 if (Size
.Y
> ScreenBuffer
->ScreenBufferSize
.Y
)
314 diff
= Size
.X
* (Size
.Y
- ScreenBuffer
->ScreenBufferSize
.Y
);
316 /* Zero-out the new part of the buffer */
317 for (i
= 0; i
< diff
; i
++)
319 ptr
= Buffer
+ Offset
;
320 ptr
->Char
.UnicodeChar
= L
' ';
321 ptr
->Attributes
= ScreenBuffer
->ScreenDefaultAttrib
;
326 (void)InterlockedExchangePointer((PVOID
volatile*)&ScreenBuffer
->Buffer
, Buffer
);
327 ConsoleFreeHeap(OldBuffer
);
328 ScreenBuffer
->ScreenBufferSize
= ScreenBuffer
->OldScreenBufferSize
= Size
;
329 ScreenBuffer
->VirtualY
= 0;
331 /* Ensure cursor and window are within buffer */
332 if (ScreenBuffer
->CursorPosition
.X
>= Size
.X
)
333 ScreenBuffer
->CursorPosition
.X
= Size
.X
- 1;
334 if (ScreenBuffer
->CursorPosition
.Y
>= Size
.Y
)
335 ScreenBuffer
->CursorPosition
.Y
= Size
.Y
- 1;
336 if (ScreenBuffer
->ViewOrigin
.X
> Size
.X
- ScreenBuffer
->ViewSize
.X
)
337 ScreenBuffer
->ViewOrigin
.X
= Size
.X
- ScreenBuffer
->ViewSize
.X
;
338 if (ScreenBuffer
->ViewOrigin
.Y
> Size
.Y
- ScreenBuffer
->ViewSize
.Y
)
339 ScreenBuffer
->ViewOrigin
.Y
= Size
.Y
- ScreenBuffer
->ViewSize
.Y
;
342 * Trigger a buffer resize event
344 if (Console
->InputBuffer
.Mode
& ENABLE_WINDOW_INPUT
)
348 er
.EventType
= WINDOW_BUFFER_SIZE_EVENT
;
349 er
.Event
.WindowBufferSizeEvent
.dwSize
= ScreenBuffer
->ScreenBufferSize
;
351 ConioProcessInputEvent(Console
, &er
);
354 return STATUS_SUCCESS
;
358 ConioNextLine(PTEXTMODE_SCREEN_BUFFER Buff
, PSMALL_RECT UpdateRect
, PUINT ScrolledLines
)
360 /* If we hit bottom, slide the viewable screen */
361 if (++Buff
->CursorPosition
.Y
== Buff
->ScreenBufferSize
.Y
)
363 Buff
->CursorPosition
.Y
--;
364 if (++Buff
->VirtualY
== Buff
->ScreenBufferSize
.Y
)
369 ClearLineBuffer(Buff
);
370 if (UpdateRect
->Top
!= 0)
375 UpdateRect
->Left
= 0;
376 UpdateRect
->Right
= Buff
->ScreenBufferSize
.X
- 1;
377 UpdateRect
->Bottom
= Buff
->CursorPosition
.Y
;
381 ConioWriteConsole(PCONSOLE Console
,
382 PTEXTMODE_SCREEN_BUFFER Buff
,
389 SMALL_RECT UpdateRect
;
390 SHORT CursorStartX
, CursorStartY
;
393 CursorStartX
= Buff
->CursorPosition
.X
;
394 CursorStartY
= Buff
->CursorPosition
.Y
;
395 UpdateRect
.Left
= Buff
->ScreenBufferSize
.X
;
396 UpdateRect
.Top
= Buff
->CursorPosition
.Y
;
397 UpdateRect
.Right
= -1;
398 UpdateRect
.Bottom
= Buff
->CursorPosition
.Y
;
401 for (i
= 0; i
< Length
; i
++)
404 * If we are in processed mode, interpret special characters and
405 * display them correctly. Otherwise, just put them into the buffer.
407 if (Buff
->Mode
& ENABLE_PROCESSED_OUTPUT
)
410 if (Buffer
[i
] == L
'\r')
412 Buff
->CursorPosition
.X
= 0;
413 UpdateRect
.Left
= min(UpdateRect
.Left
, Buff
->CursorPosition
.X
);
414 UpdateRect
.Right
= max(UpdateRect
.Right
, Buff
->CursorPosition
.X
);
418 else if (Buffer
[i
] == L
'\n')
420 Buff
->CursorPosition
.X
= 0;
421 ConioNextLine(Buff
, &UpdateRect
, &ScrolledLines
);
425 else if (Buffer
[i
] == L
'\b')
427 /* Only handle BS if we're not on the first pos of the first line */
428 if (0 != Buff
->CursorPosition
.X
|| 0 != Buff
->CursorPosition
.Y
)
430 if (0 == Buff
->CursorPosition
.X
)
432 /* slide virtual position up */
433 Buff
->CursorPosition
.X
= Buff
->ScreenBufferSize
.X
- 1;
434 Buff
->CursorPosition
.Y
--;
435 UpdateRect
.Top
= min(UpdateRect
.Top
, Buff
->CursorPosition
.Y
);
439 Buff
->CursorPosition
.X
--;
441 Ptr
= ConioCoordToPointer(Buff
, Buff
->CursorPosition
.X
, Buff
->CursorPosition
.Y
);
442 Ptr
->Char
.UnicodeChar
= L
' ';
443 Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
444 UpdateRect
.Left
= min(UpdateRect
.Left
, Buff
->CursorPosition
.X
);
445 UpdateRect
.Right
= max(UpdateRect
.Right
, Buff
->CursorPosition
.X
);
450 else if (Buffer
[i
] == L
'\t')
454 UpdateRect
.Left
= min(UpdateRect
.Left
, Buff
->CursorPosition
.X
);
455 EndX
= (Buff
->CursorPosition
.X
+ TAB_WIDTH
) & ~(TAB_WIDTH
- 1);
456 EndX
= min(EndX
, (UINT
)Buff
->ScreenBufferSize
.X
);
457 Ptr
= ConioCoordToPointer(Buff
, Buff
->CursorPosition
.X
, Buff
->CursorPosition
.Y
);
458 while (Buff
->CursorPosition
.X
< EndX
)
460 Ptr
->Char
.UnicodeChar
= L
' ';
461 Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
463 Buff
->CursorPosition
.X
++;
465 UpdateRect
.Right
= max(UpdateRect
.Right
, Buff
->CursorPosition
.X
- 1);
466 if (Buff
->CursorPosition
.X
== Buff
->ScreenBufferSize
.X
)
468 if (Buff
->Mode
& ENABLE_WRAP_AT_EOL_OUTPUT
)
470 Buff
->CursorPosition
.X
= 0;
471 ConioNextLine(Buff
, &UpdateRect
, &ScrolledLines
);
475 Buff
->CursorPosition
.X
--;
481 // else if (Buffer[i] == L'\a')
483 // // FIXME: This MUST BE moved to the terminal emulator frontend!!
484 // DPRINT1("Bell\n");
485 // // SendNotifyMessage(Console->hWindow, PM_CONSOLE_BEEP, 0, 0);
489 UpdateRect
.Left
= min(UpdateRect
.Left
, Buff
->CursorPosition
.X
);
490 UpdateRect
.Right
= max(UpdateRect
.Right
, Buff
->CursorPosition
.X
);
492 Ptr
= ConioCoordToPointer(Buff
, Buff
->CursorPosition
.X
, Buff
->CursorPosition
.Y
);
493 Ptr
->Char
.UnicodeChar
= Buffer
[i
];
494 if (Attrib
) Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
496 Buff
->CursorPosition
.X
++;
497 if (Buff
->CursorPosition
.X
== Buff
->ScreenBufferSize
.X
)
499 if (Buff
->Mode
& ENABLE_WRAP_AT_EOL_OUTPUT
)
501 Buff
->CursorPosition
.X
= 0;
502 ConioNextLine(Buff
, &UpdateRect
, &ScrolledLines
);
506 Buff
->CursorPosition
.X
= CursorStartX
;
511 if (!ConioIsRectEmpty(&UpdateRect
) && (PCONSOLE_SCREEN_BUFFER
)Buff
== Console
->ActiveBuffer
)
513 TermWriteStream(Console
, &UpdateRect
, CursorStartX
, CursorStartY
,
514 ScrolledLines
, Buffer
, Length
);
517 return STATUS_SUCCESS
;
521 ConDrvChangeScreenBufferAttributes(IN PCONSOLE Console
,
522 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
523 IN USHORT NewScreenAttrib
,
524 IN USHORT NewPopupAttrib
)
530 ULONG NumCodesToWrite
;
531 USHORT OldScreenAttrib
;
533 if (Console
== NULL
|| Buffer
== NULL
)
535 return STATUS_INVALID_PARAMETER
;
539 ASSERT(Console
== Buffer
->Header
.Console
);
541 NumCodesToWrite
= Buffer
->ScreenBufferSize
.X
* Buffer
->ScreenBufferSize
.Y
;
542 OldScreenAttrib
= Buffer
->ScreenDefaultAttrib
;
545 Y
= (TopLeft
.Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
546 Length
= NumCodesToWrite
;
548 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
549 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
553 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
554 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
557 * Change the current colors only if they are the old ones.
560 /* Foreground color */
561 if ((Ptr
->Attributes
& 0x0F) == (OldScreenAttrib
& 0x0F))
562 Ptr
->Attributes
= (Ptr
->Attributes
& 0xFFF0) | (NewScreenAttrib
& 0x0F);
564 /* Background color */
565 if ((Ptr
->Attributes
& 0xF0) == (OldScreenAttrib
& 0xF0))
566 Ptr
->Attributes
= (Ptr
->Attributes
& 0xFF0F) | (NewScreenAttrib
& 0xF0);
570 if (++X
== Buffer
->ScreenBufferSize
.X
)
574 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
581 /* Save foreground and background colors for both screen and popup */
582 Buffer
->ScreenDefaultAttrib
= (NewScreenAttrib
& 0x00FF);
583 Buffer
->PopupDefaultAttrib
= (NewPopupAttrib
& 0x00FF);
585 /* Refresh the display if needed */
586 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
588 SMALL_RECT UpdateRect
;
589 ConioComputeUpdateRect(Buffer
, &UpdateRect
, &TopLeft
, NumCodesToWrite
);
590 TermDrawRegion(Console
, &UpdateRect
);
593 return STATUS_SUCCESS
;
597 /* PUBLIC DRIVER APIS *********************************************************/
600 ConDrvReadConsoleOutput(IN PCONSOLE Console
,
601 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
603 OUT PCHAR_INFO CharInfo
/*Buffer*/,
604 IN OUT PSMALL_RECT ReadRegion
)
607 SMALL_RECT ScreenBuffer
;
608 PCHAR_INFO CurCharInfo
;
609 SMALL_RECT CapturedReadRegion
;
612 if (Console
== NULL
|| Buffer
== NULL
|| CharInfo
== NULL
|| ReadRegion
== NULL
)
614 return STATUS_INVALID_PARAMETER
;
618 ASSERT(Console
== Buffer
->Header
.Console
);
620 CapturedReadRegion
= *ReadRegion
;
622 /* Make sure ReadRegion is inside the screen buffer */
623 ConioInitRect(&ScreenBuffer
, 0, 0,
624 Buffer
->ScreenBufferSize
.Y
- 1, Buffer
->ScreenBufferSize
.X
- 1);
625 if (!ConioGetIntersection(&CapturedReadRegion
, &ScreenBuffer
, &CapturedReadRegion
))
628 * It is okay to have a ReadRegion completely outside
629 * the screen buffer. No data is read then.
631 return STATUS_SUCCESS
;
634 CurCharInfo
= CharInfo
;
636 for (Y
= CapturedReadRegion
.Top
; Y
<= CapturedReadRegion
.Bottom
; ++Y
)
638 Ptr
= ConioCoordToPointer(Buffer
, CapturedReadRegion
.Left
, Y
);
639 for (X
= CapturedReadRegion
.Left
; X
<= CapturedReadRegion
.Right
; ++X
)
643 CurCharInfo
->Char
.UnicodeChar
= Ptr
->Char
.UnicodeChar
;
647 // ConsoleUnicodeCharToAnsiChar(Console, &CurCharInfo->Char.AsciiChar, &Ptr->Char.UnicodeChar);
648 WideCharToMultiByte(Console
->OutputCodePage
, 0, &Ptr
->Char
.UnicodeChar
, 1,
649 &CurCharInfo
->Char
.AsciiChar
, 1, NULL
, NULL
);
651 CurCharInfo
->Attributes
= Ptr
->Attributes
;
657 *ReadRegion
= CapturedReadRegion
;
659 return STATUS_SUCCESS
;
663 ConDrvWriteConsoleOutput(IN PCONSOLE Console
,
664 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
666 IN PCHAR_INFO CharInfo
/*Buffer*/,
667 IN OUT PSMALL_RECT WriteRegion
)
670 SMALL_RECT ScreenBuffer
;
671 PCHAR_INFO CurCharInfo
;
672 SMALL_RECT CapturedWriteRegion
;
675 if (Console
== NULL
|| Buffer
== NULL
|| CharInfo
== NULL
|| WriteRegion
== NULL
)
677 return STATUS_INVALID_PARAMETER
;
681 ASSERT(Console
== Buffer
->Header
.Console
);
683 CapturedWriteRegion
= *WriteRegion
;
685 /* Make sure WriteRegion is inside the screen buffer */
686 ConioInitRect(&ScreenBuffer
, 0, 0,
687 Buffer
->ScreenBufferSize
.Y
- 1, Buffer
->ScreenBufferSize
.X
- 1);
688 if (!ConioGetIntersection(&CapturedWriteRegion
, &ScreenBuffer
, &CapturedWriteRegion
))
691 * It is okay to have a WriteRegion completely outside
692 * the screen buffer. No data is written then.
694 return STATUS_SUCCESS
;
697 CurCharInfo
= CharInfo
;
699 for (Y
= CapturedWriteRegion
.Top
; Y
<= CapturedWriteRegion
.Bottom
; ++Y
)
701 Ptr
= ConioCoordToPointer(Buffer
, CapturedWriteRegion
.Left
, Y
);
702 for (X
= CapturedWriteRegion
.Left
; X
<= CapturedWriteRegion
.Right
; ++X
)
706 Ptr
->Char
.UnicodeChar
= CurCharInfo
->Char
.UnicodeChar
;
710 ConsoleAnsiCharToUnicodeChar(Console
, &Ptr
->Char
.UnicodeChar
, &CurCharInfo
->Char
.AsciiChar
);
712 Ptr
->Attributes
= CurCharInfo
->Attributes
;
718 TermDrawRegion(Console
, &CapturedWriteRegion
);
720 *WriteRegion
= CapturedWriteRegion
;
722 return STATUS_SUCCESS
;
726 ConDrvWriteConsole(IN PCONSOLE Console
,
727 IN PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
729 IN PVOID StringBuffer
,
730 IN ULONG NumCharsToWrite
,
731 OUT PULONG NumCharsWritten OPTIONAL
)
733 NTSTATUS Status
= STATUS_SUCCESS
;
734 PWCHAR Buffer
= NULL
;
738 if (Console
== NULL
|| ScreenBuffer
== NULL
/* || StringBuffer == NULL */)
739 return STATUS_INVALID_PARAMETER
;
741 /* Validity checks */
742 ASSERT(Console
== ScreenBuffer
->Header
.Console
);
743 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCharsToWrite
== 0));
745 /* Stop here if the console is paused */
746 if (Console
->UnpauseEvent
!= NULL
) return STATUS_PENDING
;
750 Buffer
= StringBuffer
;
754 Length
= MultiByteToWideChar(Console
->OutputCodePage
, 0,
758 Buffer
= RtlAllocateHeap(RtlGetProcessHeap(), 0, Length
* sizeof(WCHAR
));
761 MultiByteToWideChar(Console
->OutputCodePage
, 0,
764 (PWCHAR
)Buffer
, Length
);
768 Status
= STATUS_NO_MEMORY
;
774 if (NT_SUCCESS(Status
))
776 Status
= ConioWriteConsole(Console
,
781 if (NT_SUCCESS(Status
))
783 Written
= NumCharsToWrite
;
787 if (!Unicode
) RtlFreeHeap(RtlGetProcessHeap(), 0, Buffer
);
790 if (NumCharsWritten
) *NumCharsWritten
= Written
;
796 ConDrvReadConsoleOutputString(IN PCONSOLE Console
,
797 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
798 IN CODE_TYPE CodeType
,
799 OUT PVOID StringBuffer
,
800 IN ULONG NumCodesToRead
,
802 // OUT PCOORD EndCoord,
803 OUT PULONG NumCodesRead OPTIONAL
)
811 if (Console
== NULL
|| Buffer
== NULL
|| ReadCoord
== NULL
/* || EndCoord == NULL */)
813 return STATUS_INVALID_PARAMETER
;
816 /* Validity checks */
817 ASSERT(Console
== Buffer
->Header
.Console
);
818 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCodesToRead
== 0));
820 if (NumCodesRead
) *NumCodesRead
= 0;
825 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, AsciiChar
);
829 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, UnicodeChar
);
833 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, Attribute
);
837 return STATUS_INVALID_PARAMETER
;
840 ReadBuffer
= StringBuffer
;
842 Ypos
= (ReadCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
845 * MSDN (ReadConsoleOutputAttribute and ReadConsoleOutputCharacter) :
847 * If the number of attributes (resp. characters) to be read from extends
848 * beyond the end of the specified screen buffer row, attributes (resp.
849 * characters) are read from the next row. If the number of attributes
850 * (resp. characters) to be read from extends beyond the end of the console
851 * screen buffer, attributes (resp. characters) up to the end of the console
852 * screen buffer are read.
854 * TODO: Do NOT loop up to NumCodesToRead, but stop before
855 * if we are going to overflow...
857 // Ptr = ConioCoordToPointer(Buffer, Xpos, Ypos); // Doesn't work
858 for (i
= 0; i
< min(NumCodesToRead
, Buffer
->ScreenBufferSize
.X
* Buffer
->ScreenBufferSize
.Y
); ++i
)
860 // Ptr = ConioCoordToPointer(Buffer, Xpos, Ypos); // Doesn't work either
861 Ptr
= &Buffer
->Buffer
[Xpos
+ Ypos
* Buffer
->ScreenBufferSize
.X
];
866 ConsoleUnicodeCharToAnsiChar(Console
, (PCHAR
)ReadBuffer
, &Ptr
->Char
.UnicodeChar
);
870 *(PWCHAR
)ReadBuffer
= Ptr
->Char
.UnicodeChar
;
874 *(PWORD
)ReadBuffer
= Ptr
->Attributes
;
877 ReadBuffer
= (PVOID
)((ULONG_PTR
)ReadBuffer
+ CodeSize
);
882 if (Xpos
== Buffer
->ScreenBufferSize
.X
)
887 if (Ypos
== Buffer
->ScreenBufferSize
.Y
)
894 // EndCoord->X = Xpos;
895 // EndCoord->Y = (Ypos - Buffer->VirtualY + Buffer->ScreenBufferSize.Y) % Buffer->ScreenBufferSize.Y;
898 *NumCodesRead
= (ULONG
)((ULONG_PTR
)ReadBuffer
- (ULONG_PTR
)StringBuffer
) / CodeSize
;
901 return STATUS_SUCCESS
;
905 ConDrvWriteConsoleOutputString(IN PCONSOLE Console
,
906 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
907 IN CODE_TYPE CodeType
,
908 IN PVOID StringBuffer
,
909 IN ULONG NumCodesToWrite
,
910 IN PCOORD WriteCoord
,
911 // OUT PCOORD EndCoord,
912 OUT PULONG NumCodesWritten OPTIONAL
)
914 NTSTATUS Status
= STATUS_SUCCESS
;
915 PVOID WriteBuffer
= NULL
;
916 PWCHAR tmpString
= NULL
;
917 DWORD X
, Y
, Length
; // , Written = 0;
921 if (Console
== NULL
|| Buffer
== NULL
|| WriteCoord
== NULL
/* || EndCoord == NULL */)
923 return STATUS_INVALID_PARAMETER
;
926 /* Validity checks */
927 ASSERT(Console
== Buffer
->Header
.Console
);
928 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCodesToWrite
== 0));
930 if (NumCodesWritten
) *NumCodesWritten
= 0;
935 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, AsciiChar
);
939 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, UnicodeChar
);
943 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, Attribute
);
947 return STATUS_INVALID_PARAMETER
;
950 if (CodeType
== CODE_ASCII
)
952 /* Convert the ASCII string into Unicode before writing it to the console */
953 Length
= MultiByteToWideChar(Console
->OutputCodePage
, 0,
957 tmpString
= WriteBuffer
= RtlAllocateHeap(RtlGetProcessHeap(), 0, Length
* sizeof(WCHAR
));
960 MultiByteToWideChar(Console
->OutputCodePage
, 0,
963 (PWCHAR
)WriteBuffer
, Length
);
967 Status
= STATUS_NO_MEMORY
;
970 // FIXME: Quick fix: fix the CodeType and CodeSize since the
971 // ASCII string was converted into UNICODE.
972 // A proper fix needs to be written.
973 CodeType
= CODE_UNICODE
;
974 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, UnicodeChar
);
978 /* For CODE_UNICODE or CODE_ATTRIBUTE, we are already OK */
979 WriteBuffer
= StringBuffer
;
982 if (WriteBuffer
== NULL
|| !NT_SUCCESS(Status
)) goto Cleanup
;
985 Y
= (WriteCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
986 Length
= NumCodesToWrite
;
987 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
988 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
992 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
993 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
999 Ptr
->Char
.UnicodeChar
= *(PWCHAR
)WriteBuffer
;
1002 case CODE_ATTRIBUTE
:
1003 Ptr
->Attributes
= *(PWORD
)WriteBuffer
;
1006 WriteBuffer
= (PVOID
)((ULONG_PTR
)WriteBuffer
+ CodeSize
);
1010 if (++X
== Buffer
->ScreenBufferSize
.X
)
1014 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
1021 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
1023 SMALL_RECT UpdateRect
;
1024 ConioComputeUpdateRect(Buffer
, &UpdateRect
, WriteCoord
, NumCodesToWrite
);
1025 TermDrawRegion(Console
, &UpdateRect
);
1029 // EndCoord->Y = (Y + Buffer->ScreenBufferSize.Y - Buffer->VirtualY) % Buffer->ScreenBufferSize.Y;
1032 if (tmpString
) RtlFreeHeap(RtlGetProcessHeap(), 0, tmpString
);
1034 if (NumCodesWritten
) *NumCodesWritten
= NumCodesToWrite
; // Written;
1039 ConDrvFillConsoleOutput(IN PCONSOLE Console
,
1040 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1041 IN CODE_TYPE CodeType
,
1042 IN CODE_ELEMENT Code
,
1043 IN ULONG NumCodesToWrite
,
1044 IN PCOORD WriteCoord
,
1045 OUT PULONG NumCodesWritten OPTIONAL
)
1047 DWORD X
, Y
, Length
; // , Written = 0;
1050 if (Console
== NULL
|| Buffer
== NULL
|| WriteCoord
== NULL
)
1052 return STATUS_INVALID_PARAMETER
;
1055 /* Validity check */
1056 ASSERT(Console
== Buffer
->Header
.Console
);
1058 if (NumCodesWritten
) *NumCodesWritten
= 0;
1060 if (CodeType
== CODE_ASCII
)
1062 /* Conversion from the ASCII char to the UNICODE char */
1064 ConsoleAnsiCharToUnicodeChar(Console
, &tmp
.UnicodeChar
, &Code
.AsciiChar
);
1069 Y
= (WriteCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
1070 Length
= NumCodesToWrite
;
1071 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
1072 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
1076 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
1077 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
1083 Ptr
->Char
.UnicodeChar
= Code
.UnicodeChar
;
1086 case CODE_ATTRIBUTE
:
1087 Ptr
->Attributes
= Code
.Attribute
;
1093 if (++X
== Buffer
->ScreenBufferSize
.X
)
1097 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
1104 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
1106 SMALL_RECT UpdateRect
;
1107 ConioComputeUpdateRect(Buffer
, &UpdateRect
, WriteCoord
, NumCodesToWrite
);
1108 TermDrawRegion(Console
, &UpdateRect
);
1111 if (NumCodesWritten
) *NumCodesWritten
= NumCodesToWrite
; // Written;
1112 return STATUS_SUCCESS
;
1116 ConDrvGetConsoleScreenBufferInfo(IN PCONSOLE Console
,
1117 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1118 OUT PCOORD ScreenBufferSize
,
1119 OUT PCOORD CursorPosition
,
1120 OUT PCOORD ViewOrigin
,
1121 OUT PCOORD ViewSize
,
1122 OUT PCOORD MaximumViewSize
,
1123 OUT PWORD Attributes
)
1125 if (Console
== NULL
|| Buffer
== NULL
|| ScreenBufferSize
== NULL
||
1126 CursorPosition
== NULL
|| ViewOrigin
== NULL
|| ViewSize
== NULL
||
1127 MaximumViewSize
== NULL
|| Attributes
== NULL
)
1129 return STATUS_INVALID_PARAMETER
;
1132 /* Validity check */
1133 ASSERT(Console
== Buffer
->Header
.Console
);
1135 *ScreenBufferSize
= Buffer
->ScreenBufferSize
;
1136 *CursorPosition
= Buffer
->CursorPosition
;
1137 *ViewOrigin
= Buffer
->ViewOrigin
;
1138 *ViewSize
= Buffer
->ViewSize
;
1139 *Attributes
= Buffer
->ScreenDefaultAttrib
;
1141 // FIXME: Refine the computation
1142 *MaximumViewSize
= Buffer
->ScreenBufferSize
;
1144 return STATUS_SUCCESS
;
1148 ConDrvSetConsoleTextAttribute(IN PCONSOLE Console
,
1149 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1152 if (Console
== NULL
|| Buffer
== NULL
)
1153 return STATUS_INVALID_PARAMETER
;
1155 /* Validity check */
1156 ASSERT(Console
== Buffer
->Header
.Console
);
1158 Buffer
->ScreenDefaultAttrib
= Attributes
;
1159 return STATUS_SUCCESS
;
1163 ConDrvSetConsoleScreenBufferSize(IN PCONSOLE Console
,
1164 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1169 if (Console
== NULL
|| Buffer
== NULL
|| Size
== NULL
)
1170 return STATUS_INVALID_PARAMETER
;
1172 /* Validity check */
1173 ASSERT(Console
== Buffer
->Header
.Console
);
1175 Status
= ConioResizeBuffer(Console
, Buffer
, *Size
);
1176 if (NT_SUCCESS(Status
)) TermResizeTerminal(Console
);
1182 ConDrvScrollConsoleScreenBuffer(IN PCONSOLE Console
,
1183 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1185 IN PSMALL_RECT ScrollRectangle
,
1186 IN BOOLEAN UseClipRectangle
,
1187 IN PSMALL_RECT ClipRectangle OPTIONAL
,
1188 IN PCOORD DestinationOrigin
,
1189 IN CHAR_INFO FillChar
)
1191 COORD CapturedDestinationOrigin
;
1192 SMALL_RECT ScreenBuffer
;
1193 SMALL_RECT SrcRegion
;
1194 SMALL_RECT DstRegion
;
1195 SMALL_RECT UpdateRegion
;
1196 SMALL_RECT CapturedClipRectangle
;
1198 if (Console
== NULL
|| Buffer
== NULL
|| ScrollRectangle
== NULL
||
1199 (UseClipRectangle
? ClipRectangle
== NULL
: FALSE
) || DestinationOrigin
== NULL
)
1201 return STATUS_INVALID_PARAMETER
;
1204 /* Validity check */
1205 ASSERT(Console
== Buffer
->Header
.Console
);
1207 CapturedDestinationOrigin
= *DestinationOrigin
;
1209 /* Make sure the source rectangle is inside the screen buffer */
1210 ConioInitRect(&ScreenBuffer
, 0, 0,
1211 Buffer
->ScreenBufferSize
.Y
- 1, Buffer
->ScreenBufferSize
.X
- 1);
1212 if (!ConioGetIntersection(&SrcRegion
, &ScreenBuffer
, ScrollRectangle
))
1214 return STATUS_SUCCESS
;
1217 /* If the source was clipped on the left or top, adjust the destination accordingly */
1218 if (ScrollRectangle
->Left
< 0)
1220 CapturedDestinationOrigin
.X
-= ScrollRectangle
->Left
;
1222 if (ScrollRectangle
->Top
< 0)
1224 CapturedDestinationOrigin
.Y
-= ScrollRectangle
->Top
;
1227 if (UseClipRectangle
)
1229 CapturedClipRectangle
= *ClipRectangle
;
1230 if (!ConioGetIntersection(&CapturedClipRectangle
, &CapturedClipRectangle
, &ScreenBuffer
))
1232 return STATUS_SUCCESS
;
1237 CapturedClipRectangle
= ScreenBuffer
;
1240 ConioInitRect(&DstRegion
,
1241 CapturedDestinationOrigin
.Y
,
1242 CapturedDestinationOrigin
.X
,
1243 CapturedDestinationOrigin
.Y
+ ConioRectHeight(&SrcRegion
) - 1,
1244 CapturedDestinationOrigin
.X
+ ConioRectWidth(&SrcRegion
) - 1);
1249 ConsoleAnsiCharToUnicodeChar(Console
, &tmp
, &FillChar
.Char
.AsciiChar
);
1250 FillChar
.Char
.UnicodeChar
= tmp
;
1253 ConioMoveRegion(Buffer
, &SrcRegion
, &DstRegion
, &CapturedClipRectangle
, FillChar
);
1255 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
1257 ConioGetUnion(&UpdateRegion
, &SrcRegion
, &DstRegion
);
1258 if (ConioGetIntersection(&UpdateRegion
, &UpdateRegion
, &CapturedClipRectangle
))
1260 /* Draw update region */
1261 TermDrawRegion(Console
, &UpdateRegion
);
1265 return STATUS_SUCCESS
;
1269 ConDrvSetConsoleWindowInfo(IN PCONSOLE Console
,
1270 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1271 IN BOOLEAN Absolute
,
1272 IN PSMALL_RECT WindowRect
)
1274 SMALL_RECT CapturedWindowRect
;
1276 if (Console
== NULL
|| Buffer
== NULL
|| WindowRect
== NULL
)
1277 return STATUS_INVALID_PARAMETER
;
1279 /* Validity check */
1280 ASSERT(Console
== Buffer
->Header
.Console
);
1282 CapturedWindowRect
= *WindowRect
;
1284 if (Absolute
== FALSE
)
1286 /* Relative positions given. Transform them to absolute ones */
1287 CapturedWindowRect
.Left
+= Buffer
->ViewOrigin
.X
;
1288 CapturedWindowRect
.Top
+= Buffer
->ViewOrigin
.Y
;
1289 CapturedWindowRect
.Right
+= Buffer
->ViewOrigin
.X
+ Buffer
->ViewSize
.X
- 1;
1290 CapturedWindowRect
.Bottom
+= Buffer
->ViewOrigin
.Y
+ Buffer
->ViewSize
.Y
- 1;
1293 /* See MSDN documentation on SetConsoleWindowInfo about the performed checks */
1294 if ( (CapturedWindowRect
.Left
< 0) || (CapturedWindowRect
.Top
< 0) ||
1295 (CapturedWindowRect
.Right
>= Buffer
->ScreenBufferSize
.X
) ||
1296 (CapturedWindowRect
.Bottom
>= Buffer
->ScreenBufferSize
.Y
) ||
1297 (CapturedWindowRect
.Right
<= CapturedWindowRect
.Left
) ||
1298 (CapturedWindowRect
.Bottom
<= CapturedWindowRect
.Top
) )
1300 return STATUS_INVALID_PARAMETER
;
1303 Buffer
->ViewOrigin
.X
= CapturedWindowRect
.Left
;
1304 Buffer
->ViewOrigin
.Y
= CapturedWindowRect
.Top
;
1306 Buffer
->ViewSize
.X
= CapturedWindowRect
.Right
- CapturedWindowRect
.Left
+ 1;
1307 Buffer
->ViewSize
.Y
= CapturedWindowRect
.Bottom
- CapturedWindowRect
.Top
+ 1;
1309 // TermResizeTerminal(Console);
1311 return STATUS_SUCCESS
;