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 * "The lpMultiByteStr and lpWideCharStr pointers must not be the same.
22 * If they are the same, the function fails, and GetLastError returns
23 * ERROR_INVALID_PARAMETER."
25 #define ConsoleOutputUnicodeToAnsiChar(Console, dChar, sWChar) \
26 ASSERT((ULONG_PTR)dChar != (ULONG_PTR)sWChar); \
27 WideCharToMultiByte((Console)->OutputCodePage, 0, (sWChar), 1, (dChar), 1, NULL, NULL)
29 #define ConsoleOutputAnsiToUnicodeChar(Console, dWChar, sChar) \
30 ASSERT((ULONG_PTR)dWChar != (ULONG_PTR)sChar); \
31 MultiByteToWideChar((Console)->OutputCodePage, 0, (sChar), 1, (dWChar), 1)
33 /* PRIVATE FUNCTIONS **********************************************************/
35 CONSOLE_IO_OBJECT_TYPE
36 TEXTMODE_BUFFER_GetType(PCONSOLE_SCREEN_BUFFER This
)
38 // return This->Header.Type;
39 return TEXTMODE_BUFFER
;
42 static CONSOLE_SCREEN_BUFFER_VTBL TextVtbl
=
44 TEXTMODE_BUFFER_GetType
,
49 ClearLineBuffer(PTEXTMODE_SCREEN_BUFFER Buff
);
53 CONSOLE_SCREEN_BUFFER_Initialize(OUT PCONSOLE_SCREEN_BUFFER
* Buffer
,
55 IN PCONSOLE_SCREEN_BUFFER_VTBL Vtbl
,
58 CONSOLE_SCREEN_BUFFER_Destroy(IN OUT PCONSOLE_SCREEN_BUFFER Buffer
);
62 TEXTMODE_BUFFER_Initialize(OUT PCONSOLE_SCREEN_BUFFER
* Buffer
,
64 IN HANDLE ProcessHandle
,
65 IN PTEXTMODE_BUFFER_INFO TextModeInfo
)
67 NTSTATUS Status
= STATUS_SUCCESS
;
68 PTEXTMODE_SCREEN_BUFFER NewBuffer
= NULL
;
70 UNREFERENCED_PARAMETER(ProcessHandle
);
72 if (Console
== NULL
|| Buffer
== NULL
|| TextModeInfo
== NULL
)
73 return STATUS_INVALID_PARAMETER
;
77 Status
= CONSOLE_SCREEN_BUFFER_Initialize((PCONSOLE_SCREEN_BUFFER
*)&NewBuffer
,
80 sizeof(TEXTMODE_SCREEN_BUFFER
));
81 if (!NT_SUCCESS(Status
)) return Status
;
82 NewBuffer
->Header
.Type
= TEXTMODE_BUFFER
;
84 NewBuffer
->Buffer
= ConsoleAllocHeap(HEAP_ZERO_MEMORY
,
85 TextModeInfo
->ScreenBufferSize
.X
*
86 TextModeInfo
->ScreenBufferSize
.Y
*
88 if (NewBuffer
->Buffer
== NULL
)
90 CONSOLE_SCREEN_BUFFER_Destroy((PCONSOLE_SCREEN_BUFFER
)NewBuffer
);
91 return STATUS_INSUFFICIENT_RESOURCES
;
94 NewBuffer
->ScreenBufferSize
= NewBuffer
->OldScreenBufferSize
95 = TextModeInfo
->ScreenBufferSize
;
96 NewBuffer
->ViewSize
= NewBuffer
->OldViewSize
97 = Console
->ConsoleSize
;
99 NewBuffer
->ViewOrigin
.X
= NewBuffer
->ViewOrigin
.Y
= 0;
100 NewBuffer
->VirtualY
= 0;
102 NewBuffer
->CursorBlinkOn
= NewBuffer
->ForceCursorOff
= FALSE
;
103 NewBuffer
->CursorInfo
.bVisible
= (TextModeInfo
->IsCursorVisible
&& (TextModeInfo
->CursorSize
!= 0));
104 NewBuffer
->CursorInfo
.dwSize
= min(max(TextModeInfo
->CursorSize
, 0), 100);
106 NewBuffer
->ScreenDefaultAttrib
= TextModeInfo
->ScreenAttrib
;
107 NewBuffer
->PopupDefaultAttrib
= TextModeInfo
->PopupAttrib
;
109 /* Initialize buffer to be empty with default attributes */
110 for (NewBuffer
->CursorPosition
.Y
= 0 ; NewBuffer
->CursorPosition
.Y
< NewBuffer
->ScreenBufferSize
.Y
; NewBuffer
->CursorPosition
.Y
++)
112 ClearLineBuffer(NewBuffer
);
114 NewBuffer
->CursorPosition
.X
= NewBuffer
->CursorPosition
.Y
= 0;
116 NewBuffer
->Mode
= ENABLE_PROCESSED_OUTPUT
| ENABLE_WRAP_AT_EOL_OUTPUT
;
118 *Buffer
= (PCONSOLE_SCREEN_BUFFER
)NewBuffer
;
119 return STATUS_SUCCESS
;
123 TEXTMODE_BUFFER_Destroy(IN OUT PCONSOLE_SCREEN_BUFFER Buffer
)
125 PTEXTMODE_SCREEN_BUFFER Buff
= (PTEXTMODE_SCREEN_BUFFER
)Buffer
;
128 * IMPORTANT !! Reinitialize the type so that we don't enter a recursive
129 * infinite loop when calling CONSOLE_SCREEN_BUFFER_Destroy.
131 Buffer
->Header
.Type
= SCREEN_BUFFER
;
133 ConsoleFreeHeap(Buff
->Buffer
);
135 CONSOLE_SCREEN_BUFFER_Destroy(Buffer
);
140 ConioCoordToPointer(PTEXTMODE_SCREEN_BUFFER Buff
, ULONG X
, ULONG Y
)
142 return &Buff
->Buffer
[((Y
+ Buff
->VirtualY
) % Buff
->ScreenBufferSize
.Y
) * Buff
->ScreenBufferSize
.X
+ X
];
146 ClearLineBuffer(PTEXTMODE_SCREEN_BUFFER Buff
)
148 PCHAR_INFO Ptr
= ConioCoordToPointer(Buff
, 0, Buff
->CursorPosition
.Y
);
151 for (Pos
= 0; Pos
< Buff
->ScreenBufferSize
.X
; Pos
++, Ptr
++)
154 Ptr
->Char
.UnicodeChar
= L
' ';
155 Ptr
->Attributes
= Buff
->ScreenDefaultAttrib
;
160 ConioComputeUpdateRect(IN PTEXTMODE_SCREEN_BUFFER Buff
,
161 IN OUT PSMALL_RECT UpdateRect
,
165 if ((UINT
)Buff
->ScreenBufferSize
.X
<= Start
->X
+ Length
)
167 UpdateRect
->Left
= 0;
168 UpdateRect
->Right
= Buff
->ScreenBufferSize
.X
- 1;
172 UpdateRect
->Left
= Start
->X
;
173 UpdateRect
->Right
= Start
->X
+ Length
- 1;
175 UpdateRect
->Top
= Start
->Y
;
176 UpdateRect
->Bottom
= Start
->Y
+ (Start
->X
+ Length
- 1) / Buff
->ScreenBufferSize
.X
;
177 if (Buff
->ScreenBufferSize
.Y
<= UpdateRect
->Bottom
)
179 UpdateRect
->Bottom
= Buff
->ScreenBufferSize
.Y
- 1;
184 * Move from one rectangle to another. We must be careful about the order that
185 * this is done, to avoid overwriting parts of the source before they are moved.
188 ConioMoveRegion(PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
189 PSMALL_RECT SrcRegion
,
190 PSMALL_RECT DstRegion
,
191 PSMALL_RECT ClipRegion
,
194 int Width
= ConioRectWidth(SrcRegion
);
195 int Height
= ConioRectHeight(SrcRegion
);
206 /* Moving down: work from bottom up */
207 SY
= SrcRegion
->Bottom
;
208 DY
= DstRegion
->Bottom
;
211 for (i
= 0; i
< Height
; i
++)
213 PCHAR_INFO SRow
= ConioCoordToPointer(ScreenBuffer
, 0, SY
);
214 PCHAR_INFO DRow
= ConioCoordToPointer(ScreenBuffer
, 0, DY
);
216 SX
= SrcRegion
->Left
;
217 DX
= DstRegion
->Left
;
221 /* Moving right: work from right to left */
222 SX
= SrcRegion
->Right
;
223 DX
= DstRegion
->Right
;
226 for (j
= 0; j
< Width
; j
++)
228 CHAR_INFO Cell
= SRow
[SX
];
229 if (SX
>= ClipRegion
->Left
&& SX
<= ClipRegion
->Right
&&
230 SY
>= ClipRegion
->Top
&& SY
<= ClipRegion
->Bottom
)
234 if (DX
>= ClipRegion
->Left
&& DX
<= ClipRegion
->Right
&&
235 DY
>= ClipRegion
->Top
&& DY
<= ClipRegion
->Bottom
)
249 ConDrvWriteConsoleInput(IN PCONSOLE Console
,
250 IN PCONSOLE_INPUT_BUFFER InputBuffer
,
251 IN BOOLEAN AppendToEnd
,
252 IN PINPUT_RECORD InputRecord
,
253 IN ULONG NumEventsToWrite
,
254 OUT PULONG NumEventsWritten OPTIONAL
);
257 ConioResizeBuffer(PCONSOLE Console
,
258 PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
264 WORD CurrentAttribute
;
266 PCHAR_INFO OldBuffer
;
270 /* Buffer size is not allowed to be smaller than the view size */
271 if (Size
.X
< ScreenBuffer
->ViewSize
.X
|| Size
.Y
< ScreenBuffer
->ViewSize
.Y
)
272 return STATUS_INVALID_PARAMETER
;
274 if (Size
.X
== ScreenBuffer
->ScreenBufferSize
.X
&& Size
.Y
== ScreenBuffer
->ScreenBufferSize
.Y
)
276 // FIXME: Trigger a buffer resize event ??
277 return STATUS_SUCCESS
;
280 if (Console
->FixedSize
)
283 * The console is in fixed-size mode, so we cannot resize anything
284 * at the moment. However, keep those settings somewhere so that
285 * we can try to set them up when we will be allowed to do so.
287 ScreenBuffer
->OldScreenBufferSize
= Size
;
288 return STATUS_NOT_SUPPORTED
; // STATUS_SUCCESS
291 Buffer
= ConsoleAllocHeap(HEAP_ZERO_MEMORY
, Size
.X
* Size
.Y
* sizeof(CHAR_INFO
));
292 if (!Buffer
) return STATUS_NO_MEMORY
;
294 DPRINT("Resizing (%d,%d) to (%d,%d)\n", ScreenBuffer
->ScreenBufferSize
.X
, ScreenBuffer
->ScreenBufferSize
.Y
, Size
.X
, Size
.Y
);
295 OldBuffer
= ScreenBuffer
->Buffer
;
297 for (CurrentY
= 0; CurrentY
< ScreenBuffer
->ScreenBufferSize
.Y
&& CurrentY
< Size
.Y
; CurrentY
++)
299 ptr
= ConioCoordToPointer(ScreenBuffer
, 0, CurrentY
);
300 if (Size
.X
<= ScreenBuffer
->ScreenBufferSize
.X
)
303 RtlCopyMemory(Buffer
+ Offset
, ptr
, Size
.X
* sizeof(CHAR_INFO
));
309 RtlCopyMemory(Buffer
+ Offset
, ptr
, ScreenBuffer
->ScreenBufferSize
.X
* sizeof(CHAR_INFO
));
310 Offset
+= ScreenBuffer
->ScreenBufferSize
.X
;
312 /* The attribute to be used is the one of the last cell of the current line */
313 CurrentAttribute
= ConioCoordToPointer(ScreenBuffer
,
314 ScreenBuffer
->ScreenBufferSize
.X
- 1,
315 CurrentY
)->Attributes
;
317 diff
= Size
.X
- ScreenBuffer
->ScreenBufferSize
.X
;
319 /* Zero-out the new part of the buffer */
320 for (i
= 0; i
< diff
; i
++)
322 ptr
= Buffer
+ Offset
;
323 ptr
->Char
.UnicodeChar
= L
' ';
324 ptr
->Attributes
= CurrentAttribute
;
330 if (Size
.Y
> ScreenBuffer
->ScreenBufferSize
.Y
)
332 diff
= Size
.X
* (Size
.Y
- ScreenBuffer
->ScreenBufferSize
.Y
);
334 /* Zero-out the new part of the buffer */
335 for (i
= 0; i
< diff
; i
++)
337 ptr
= Buffer
+ Offset
;
338 ptr
->Char
.UnicodeChar
= L
' ';
339 ptr
->Attributes
= ScreenBuffer
->ScreenDefaultAttrib
;
344 (void)InterlockedExchangePointer((PVOID
volatile*)&ScreenBuffer
->Buffer
, Buffer
);
345 ConsoleFreeHeap(OldBuffer
);
346 ScreenBuffer
->ScreenBufferSize
= ScreenBuffer
->OldScreenBufferSize
= Size
;
347 ScreenBuffer
->VirtualY
= 0;
349 /* Ensure cursor and window are within buffer */
350 if (ScreenBuffer
->CursorPosition
.X
>= Size
.X
)
351 ScreenBuffer
->CursorPosition
.X
= Size
.X
- 1;
352 if (ScreenBuffer
->CursorPosition
.Y
>= Size
.Y
)
353 ScreenBuffer
->CursorPosition
.Y
= Size
.Y
- 1;
354 if (ScreenBuffer
->ViewOrigin
.X
> Size
.X
- ScreenBuffer
->ViewSize
.X
)
355 ScreenBuffer
->ViewOrigin
.X
= Size
.X
- ScreenBuffer
->ViewSize
.X
;
356 if (ScreenBuffer
->ViewOrigin
.Y
> Size
.Y
- ScreenBuffer
->ViewSize
.Y
)
357 ScreenBuffer
->ViewOrigin
.Y
= Size
.Y
- ScreenBuffer
->ViewSize
.Y
;
360 * Trigger a buffer resize event
362 if (Console
->InputBuffer
.Mode
& ENABLE_WINDOW_INPUT
)
364 ULONG NumEventsWritten
;
367 er
.EventType
= WINDOW_BUFFER_SIZE_EVENT
;
368 er
.Event
.WindowBufferSizeEvent
.dwSize
= ScreenBuffer
->ScreenBufferSize
;
370 // ConioProcessInputEvent(Console, &er);
371 ConDrvWriteConsoleInput(Console
,
372 &Console
->InputBuffer
,
379 return STATUS_SUCCESS
;
383 ConDrvChangeScreenBufferAttributes(IN PCONSOLE Console
,
384 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
385 IN USHORT NewScreenAttrib
,
386 IN USHORT NewPopupAttrib
)
392 ULONG NumCodesToWrite
;
393 USHORT OldScreenAttrib
, OldPopupAttrib
;
395 if (Console
== NULL
|| Buffer
== NULL
)
397 return STATUS_INVALID_PARAMETER
;
401 ASSERT(Console
== Buffer
->Header
.Console
);
403 NumCodesToWrite
= Buffer
->ScreenBufferSize
.X
* Buffer
->ScreenBufferSize
.Y
;
404 OldScreenAttrib
= Buffer
->ScreenDefaultAttrib
;
405 OldPopupAttrib
= Buffer
->PopupDefaultAttrib
;
408 Y
= (TopLeft
.Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
409 Length
= NumCodesToWrite
;
411 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
412 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
416 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
417 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
420 * Change the current colors only if they are the old ones.
423 /* Foreground color */
424 if ((Ptr
->Attributes
& 0x0F) == (OldScreenAttrib
& 0x0F))
425 Ptr
->Attributes
= (Ptr
->Attributes
& 0xFFF0) | (NewScreenAttrib
& 0x0F);
426 if ((Ptr
->Attributes
& 0x0F) == (OldPopupAttrib
& 0x0F))
427 Ptr
->Attributes
= (Ptr
->Attributes
& 0xFFF0) | (NewPopupAttrib
& 0x0F);
429 /* Background color */
430 if ((Ptr
->Attributes
& 0xF0) == (OldScreenAttrib
& 0xF0))
431 Ptr
->Attributes
= (Ptr
->Attributes
& 0xFF0F) | (NewScreenAttrib
& 0xF0);
432 if ((Ptr
->Attributes
& 0xF0) == (OldPopupAttrib
& 0xF0))
433 Ptr
->Attributes
= (Ptr
->Attributes
& 0xFF0F) | (NewPopupAttrib
& 0xF0);
437 if (++X
== Buffer
->ScreenBufferSize
.X
)
441 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
448 /* Save foreground and background colors for both screen and popup */
449 Buffer
->ScreenDefaultAttrib
= (NewScreenAttrib
& 0x00FF);
450 Buffer
->PopupDefaultAttrib
= (NewPopupAttrib
& 0x00FF);
452 /* Refresh the display if needed */
453 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
455 SMALL_RECT UpdateRect
;
456 ConioComputeUpdateRect(Buffer
, &UpdateRect
, &TopLeft
, NumCodesToWrite
);
457 TermDrawRegion(Console
, &UpdateRect
);
460 return STATUS_SUCCESS
;
464 /* PUBLIC DRIVER APIS *********************************************************/
467 ConDrvReadConsoleOutput(IN PCONSOLE Console
,
468 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
470 OUT PCHAR_INFO CharInfo
/*Buffer*/,
471 IN OUT PSMALL_RECT ReadRegion
)
474 SMALL_RECT ScreenBuffer
;
475 PCHAR_INFO CurCharInfo
;
476 SMALL_RECT CapturedReadRegion
;
479 if (Console
== NULL
|| Buffer
== NULL
|| CharInfo
== NULL
|| ReadRegion
== NULL
)
481 return STATUS_INVALID_PARAMETER
;
485 ASSERT(Console
== Buffer
->Header
.Console
);
487 CapturedReadRegion
= *ReadRegion
;
489 /* Make sure ReadRegion is inside the screen buffer */
490 ConioInitRect(&ScreenBuffer
, 0, 0,
491 Buffer
->ScreenBufferSize
.Y
- 1,
492 Buffer
->ScreenBufferSize
.X
- 1);
493 if (!ConioGetIntersection(&CapturedReadRegion
, &ScreenBuffer
, &CapturedReadRegion
))
496 * It is okay to have a ReadRegion completely outside
497 * the screen buffer. No data is read then.
499 return STATUS_SUCCESS
;
502 CurCharInfo
= CharInfo
;
504 for (Y
= CapturedReadRegion
.Top
; Y
<= CapturedReadRegion
.Bottom
; ++Y
)
506 Ptr
= ConioCoordToPointer(Buffer
, CapturedReadRegion
.Left
, Y
);
507 for (X
= CapturedReadRegion
.Left
; X
<= CapturedReadRegion
.Right
; ++X
)
511 CurCharInfo
->Char
.UnicodeChar
= Ptr
->Char
.UnicodeChar
;
515 // ConsoleOutputUnicodeToAnsiChar(Console, &CurCharInfo->Char.AsciiChar, &Ptr->Char.UnicodeChar);
516 WideCharToMultiByte(Console
->OutputCodePage
, 0, &Ptr
->Char
.UnicodeChar
, 1,
517 &CurCharInfo
->Char
.AsciiChar
, 1, NULL
, NULL
);
519 CurCharInfo
->Attributes
= Ptr
->Attributes
;
525 *ReadRegion
= CapturedReadRegion
;
527 return STATUS_SUCCESS
;
531 ConDrvWriteConsoleOutput(IN PCONSOLE Console
,
532 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
534 IN PCHAR_INFO CharInfo
/*Buffer*/,
535 IN OUT PSMALL_RECT WriteRegion
)
538 SMALL_RECT ScreenBuffer
;
539 PCHAR_INFO CurCharInfo
;
540 SMALL_RECT CapturedWriteRegion
;
543 if (Console
== NULL
|| Buffer
== NULL
|| CharInfo
== NULL
|| WriteRegion
== NULL
)
545 return STATUS_INVALID_PARAMETER
;
549 ASSERT(Console
== Buffer
->Header
.Console
);
551 CapturedWriteRegion
= *WriteRegion
;
553 /* Make sure WriteRegion is inside the screen buffer */
554 ConioInitRect(&ScreenBuffer
, 0, 0,
555 Buffer
->ScreenBufferSize
.Y
- 1,
556 Buffer
->ScreenBufferSize
.X
- 1);
557 if (!ConioGetIntersection(&CapturedWriteRegion
, &ScreenBuffer
, &CapturedWriteRegion
))
560 * It is okay to have a WriteRegion completely outside
561 * the screen buffer. No data is written then.
563 return STATUS_SUCCESS
;
566 CurCharInfo
= CharInfo
;
568 for (Y
= CapturedWriteRegion
.Top
; Y
<= CapturedWriteRegion
.Bottom
; ++Y
)
570 Ptr
= ConioCoordToPointer(Buffer
, CapturedWriteRegion
.Left
, Y
);
571 for (X
= CapturedWriteRegion
.Left
; X
<= CapturedWriteRegion
.Right
; ++X
)
575 Ptr
->Char
.UnicodeChar
= CurCharInfo
->Char
.UnicodeChar
;
579 ConsoleOutputAnsiToUnicodeChar(Console
, &Ptr
->Char
.UnicodeChar
, &CurCharInfo
->Char
.AsciiChar
);
581 Ptr
->Attributes
= CurCharInfo
->Attributes
;
587 TermDrawRegion(Console
, &CapturedWriteRegion
);
589 *WriteRegion
= CapturedWriteRegion
;
591 return STATUS_SUCCESS
;
595 * NOTE: This function is strongly inspired by ConDrvWriteConsoleOutput...
596 * FIXME: This function MUST be moved into consrv/conoutput.c because only
597 * consrv knows how to manipulate VDM screenbuffers.
600 ConDrvWriteConsoleOutputVDM(IN PCONSOLE Console
,
601 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
602 IN PCHAR_CELL CharInfo
/*Buffer*/,
603 IN COORD CharInfoSize
,
604 IN PSMALL_RECT WriteRegion
)
607 SMALL_RECT ScreenBuffer
;
608 PCHAR_CELL CurCharInfo
;
609 SMALL_RECT CapturedWriteRegion
;
612 if (Console
== NULL
|| Buffer
== NULL
|| CharInfo
== NULL
|| WriteRegion
== NULL
)
614 return STATUS_INVALID_PARAMETER
;
618 ASSERT(Console
== Buffer
->Header
.Console
);
620 CapturedWriteRegion
= *WriteRegion
;
622 /* Make sure WriteRegion is inside the screen buffer */
623 ConioInitRect(&ScreenBuffer
, 0, 0,
624 Buffer
->ScreenBufferSize
.Y
- 1,
625 Buffer
->ScreenBufferSize
.X
- 1);
626 if (!ConioGetIntersection(&CapturedWriteRegion
, &ScreenBuffer
, &CapturedWriteRegion
))
629 * It is okay to have a WriteRegion completely outside
630 * the screen buffer. No data is written then.
632 return STATUS_SUCCESS
;
635 // CurCharInfo = CharInfo;
637 for (Y
= CapturedWriteRegion
.Top
; Y
<= CapturedWriteRegion
.Bottom
; ++Y
)
639 /**/CurCharInfo
= CharInfo
+ Y
* CharInfoSize
.X
+ CapturedWriteRegion
.Left
;/**/
641 Ptr
= ConioCoordToPointer(Buffer
, CapturedWriteRegion
.Left
, Y
);
642 for (X
= CapturedWriteRegion
.Left
; X
<= CapturedWriteRegion
.Right
; ++X
)
644 ConsoleOutputAnsiToUnicodeChar(Console
, &Ptr
->Char
.UnicodeChar
, &CurCharInfo
->Char
);
645 Ptr
->Attributes
= CurCharInfo
->Attributes
;
651 return STATUS_SUCCESS
;
655 ConDrvWriteConsole(IN PCONSOLE Console
,
656 IN PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
658 IN PVOID StringBuffer
,
659 IN ULONG NumCharsToWrite
,
660 OUT PULONG NumCharsWritten OPTIONAL
)
662 NTSTATUS Status
= STATUS_SUCCESS
;
663 PWCHAR Buffer
= NULL
;
667 if (Console
== NULL
|| ScreenBuffer
== NULL
/* || StringBuffer == NULL */)
668 return STATUS_INVALID_PARAMETER
;
670 /* Validity checks */
671 ASSERT(Console
== ScreenBuffer
->Header
.Console
);
672 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCharsToWrite
== 0));
674 /* Stop here if the console is paused */
675 if (Console
->UnpauseEvent
!= NULL
) return STATUS_PENDING
;
677 /* Convert the string to UNICODE */
680 Buffer
= StringBuffer
;
684 Length
= MultiByteToWideChar(Console
->OutputCodePage
, 0,
688 Buffer
= RtlAllocateHeap(RtlGetProcessHeap(), 0, Length
* sizeof(WCHAR
));
691 MultiByteToWideChar(Console
->OutputCodePage
, 0,
694 (PWCHAR
)Buffer
, Length
);
698 Status
= STATUS_NO_MEMORY
;
705 if (NT_SUCCESS(Status
))
707 Status
= TermWriteStream(Console
,
712 if (NT_SUCCESS(Status
))
714 Written
= NumCharsToWrite
;
718 if (!Unicode
) RtlFreeHeap(RtlGetProcessHeap(), 0, Buffer
);
721 if (NumCharsWritten
) *NumCharsWritten
= Written
;
727 ConDrvReadConsoleOutputString(IN PCONSOLE Console
,
728 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
729 IN CODE_TYPE CodeType
,
730 OUT PVOID StringBuffer
,
731 IN ULONG NumCodesToRead
,
733 // OUT PCOORD EndCoord,
734 OUT PULONG NumCodesRead OPTIONAL
)
742 if (Console
== NULL
|| Buffer
== NULL
|| ReadCoord
== NULL
/* || EndCoord == NULL */)
744 return STATUS_INVALID_PARAMETER
;
747 /* Validity checks */
748 ASSERT(Console
== Buffer
->Header
.Console
);
749 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCodesToRead
== 0));
752 // FIXME: Make overflow checks on ReadCoord !!!!!!
755 if (NumCodesRead
) *NumCodesRead
= 0;
760 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, AsciiChar
);
764 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, UnicodeChar
);
768 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, Attribute
);
772 return STATUS_INVALID_PARAMETER
;
775 ReadBuffer
= StringBuffer
;
777 Ypos
= (ReadCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
780 * MSDN (ReadConsoleOutputAttribute and ReadConsoleOutputCharacter) :
782 * If the number of attributes (resp. characters) to be read from extends
783 * beyond the end of the specified screen buffer row, attributes (resp.
784 * characters) are read from the next row. If the number of attributes
785 * (resp. characters) to be read from extends beyond the end of the console
786 * screen buffer, attributes (resp. characters) up to the end of the console
787 * screen buffer are read.
789 * TODO: Do NOT loop up to NumCodesToRead, but stop before
790 * if we are going to overflow...
792 // Ptr = ConioCoordToPointer(Buffer, Xpos, Ypos); // Doesn't work
793 for (i
= 0; i
< min(NumCodesToRead
, (ULONG
)Buffer
->ScreenBufferSize
.X
* Buffer
->ScreenBufferSize
.Y
); ++i
)
795 // Ptr = ConioCoordToPointer(Buffer, Xpos, Ypos); // Doesn't work either
796 Ptr
= &Buffer
->Buffer
[Xpos
+ Ypos
* Buffer
->ScreenBufferSize
.X
];
801 ConsoleOutputUnicodeToAnsiChar(Console
, (PCHAR
)ReadBuffer
, &Ptr
->Char
.UnicodeChar
);
805 *(PWCHAR
)ReadBuffer
= Ptr
->Char
.UnicodeChar
;
809 *(PWORD
)ReadBuffer
= Ptr
->Attributes
;
812 ReadBuffer
= (PVOID
)((ULONG_PTR
)ReadBuffer
+ CodeSize
);
817 if (Xpos
== Buffer
->ScreenBufferSize
.X
)
822 if (Ypos
== Buffer
->ScreenBufferSize
.Y
)
829 // EndCoord->X = Xpos;
830 // EndCoord->Y = (Ypos - Buffer->VirtualY + Buffer->ScreenBufferSize.Y) % Buffer->ScreenBufferSize.Y;
833 *NumCodesRead
= (ULONG
)((ULONG_PTR
)ReadBuffer
- (ULONG_PTR
)StringBuffer
) / CodeSize
;
836 return STATUS_SUCCESS
;
840 ConDrvWriteConsoleOutputString(IN PCONSOLE Console
,
841 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
842 IN CODE_TYPE CodeType
,
843 IN PVOID StringBuffer
,
844 IN ULONG NumCodesToWrite
,
845 IN PCOORD WriteCoord
,
846 // OUT PCOORD EndCoord,
847 OUT PULONG NumCodesWritten OPTIONAL
)
849 NTSTATUS Status
= STATUS_SUCCESS
;
850 PVOID WriteBuffer
= NULL
;
851 PWCHAR tmpString
= NULL
;
852 ULONG X
, Y
, Length
; // , Written = 0;
856 if (Console
== NULL
|| Buffer
== NULL
|| WriteCoord
== NULL
/* || EndCoord == NULL */)
858 return STATUS_INVALID_PARAMETER
;
861 /* Validity checks */
862 ASSERT(Console
== Buffer
->Header
.Console
);
863 ASSERT((StringBuffer
!= NULL
) || (StringBuffer
== NULL
&& NumCodesToWrite
== 0));
866 // FIXME: Make overflow checks on WriteCoord !!!!!!
869 if (NumCodesWritten
) *NumCodesWritten
= 0;
874 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, AsciiChar
);
878 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, UnicodeChar
);
882 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, Attribute
);
886 return STATUS_INVALID_PARAMETER
;
889 if (CodeType
== CODE_ASCII
)
891 /* Convert the ASCII string into Unicode before writing it to the console */
892 Length
= MultiByteToWideChar(Console
->OutputCodePage
, 0,
896 tmpString
= WriteBuffer
= RtlAllocateHeap(RtlGetProcessHeap(), 0, Length
* sizeof(WCHAR
));
899 MultiByteToWideChar(Console
->OutputCodePage
, 0,
902 (PWCHAR
)WriteBuffer
, Length
);
906 Status
= STATUS_NO_MEMORY
;
909 // FIXME: Quick fix: fix the CodeType and CodeSize since the
910 // ASCII string was converted into UNICODE.
911 // A proper fix needs to be written.
912 CodeType
= CODE_UNICODE
;
913 CodeSize
= RTL_FIELD_SIZE(CODE_ELEMENT
, UnicodeChar
);
917 /* For CODE_UNICODE or CODE_ATTRIBUTE, we are already OK */
918 WriteBuffer
= StringBuffer
;
921 if (WriteBuffer
== NULL
|| !NT_SUCCESS(Status
)) goto Cleanup
;
924 Y
= (WriteCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
925 Length
= NumCodesToWrite
;
926 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
927 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
931 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
932 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
938 Ptr
->Char
.UnicodeChar
= *(PWCHAR
)WriteBuffer
;
942 Ptr
->Attributes
= *(PWORD
)WriteBuffer
;
945 WriteBuffer
= (PVOID
)((ULONG_PTR
)WriteBuffer
+ CodeSize
);
949 if (++X
== Buffer
->ScreenBufferSize
.X
)
953 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
960 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
962 SMALL_RECT UpdateRect
;
963 ConioComputeUpdateRect(Buffer
, &UpdateRect
, WriteCoord
, NumCodesToWrite
);
964 TermDrawRegion(Console
, &UpdateRect
);
968 // EndCoord->Y = (Y + Buffer->ScreenBufferSize.Y - Buffer->VirtualY) % Buffer->ScreenBufferSize.Y;
971 if (tmpString
) RtlFreeHeap(RtlGetProcessHeap(), 0, tmpString
);
973 if (NumCodesWritten
) *NumCodesWritten
= NumCodesToWrite
; // Written;
978 ConDrvFillConsoleOutput(IN PCONSOLE Console
,
979 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
980 IN CODE_TYPE CodeType
,
981 IN CODE_ELEMENT Code
,
982 IN ULONG NumCodesToWrite
,
983 IN PCOORD WriteCoord
,
984 OUT PULONG NumCodesWritten OPTIONAL
)
986 ULONG X
, Y
, Length
; // , Written = 0;
989 if (Console
== NULL
|| Buffer
== NULL
|| WriteCoord
== NULL
)
991 return STATUS_INVALID_PARAMETER
;
995 ASSERT(Console
== Buffer
->Header
.Console
);
998 // FIXME: Make overflow checks on WriteCoord !!!!!!
1001 if (NumCodesWritten
) *NumCodesWritten
= 0;
1003 if (CodeType
== CODE_ASCII
)
1005 /* Conversion from the ASCII char to the UNICODE char */
1007 ConsoleOutputAnsiToUnicodeChar(Console
, &tmp
.UnicodeChar
, &Code
.AsciiChar
);
1012 Y
= (WriteCoord
->Y
+ Buffer
->VirtualY
) % Buffer
->ScreenBufferSize
.Y
;
1013 Length
= NumCodesToWrite
;
1014 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work
1015 // Ptr = &Buffer->Buffer[X + Y * Buffer->ScreenBufferSize.X]; // May work
1019 // Ptr = ConioCoordToPointer(Buffer, X, Y); // Doesn't work either
1020 Ptr
= &Buffer
->Buffer
[X
+ Y
* Buffer
->ScreenBufferSize
.X
];
1026 Ptr
->Char
.UnicodeChar
= Code
.UnicodeChar
;
1029 case CODE_ATTRIBUTE
:
1030 Ptr
->Attributes
= Code
.Attribute
;
1036 if (++X
== Buffer
->ScreenBufferSize
.X
)
1040 if (++Y
== Buffer
->ScreenBufferSize
.Y
)
1047 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
1049 SMALL_RECT UpdateRect
;
1050 ConioComputeUpdateRect(Buffer
, &UpdateRect
, WriteCoord
, NumCodesToWrite
);
1051 TermDrawRegion(Console
, &UpdateRect
);
1054 if (NumCodesWritten
) *NumCodesWritten
= NumCodesToWrite
; // Written;
1055 return STATUS_SUCCESS
;
1059 ConDrvGetConsoleScreenBufferInfo(IN PCONSOLE Console
,
1060 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1061 OUT PCOORD ScreenBufferSize
,
1062 OUT PCOORD CursorPosition
,
1063 OUT PCOORD ViewOrigin
,
1064 OUT PCOORD ViewSize
,
1065 OUT PCOORD MaximumViewSize
,
1066 OUT PWORD Attributes
)
1068 COORD LargestWindowSize
;
1070 if (Console
== NULL
|| Buffer
== NULL
|| ScreenBufferSize
== NULL
||
1071 CursorPosition
== NULL
|| ViewOrigin
== NULL
|| ViewSize
== NULL
||
1072 MaximumViewSize
== NULL
|| Attributes
== NULL
)
1074 return STATUS_INVALID_PARAMETER
;
1077 /* Validity check */
1078 ASSERT(Console
== Buffer
->Header
.Console
);
1080 *ScreenBufferSize
= Buffer
->ScreenBufferSize
;
1081 *CursorPosition
= Buffer
->CursorPosition
;
1082 *ViewOrigin
= Buffer
->ViewOrigin
;
1083 *ViewSize
= Buffer
->ViewSize
;
1084 *Attributes
= Buffer
->ScreenDefaultAttrib
;
1087 * Retrieve the largest possible console window size, taking
1088 * into account the size of the console screen buffer.
1090 TermGetLargestConsoleWindowSize(Console
, &LargestWindowSize
);
1091 LargestWindowSize
.X
= min(LargestWindowSize
.X
, Buffer
->ScreenBufferSize
.X
);
1092 LargestWindowSize
.Y
= min(LargestWindowSize
.Y
, Buffer
->ScreenBufferSize
.Y
);
1093 *MaximumViewSize
= LargestWindowSize
;
1095 return STATUS_SUCCESS
;
1099 ConDrvSetConsoleTextAttribute(IN PCONSOLE Console
,
1100 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1103 if (Console
== NULL
|| Buffer
== NULL
)
1104 return STATUS_INVALID_PARAMETER
;
1106 /* Validity check */
1107 ASSERT(Console
== Buffer
->Header
.Console
);
1109 Buffer
->ScreenDefaultAttrib
= Attributes
;
1110 return STATUS_SUCCESS
;
1114 ConDrvSetConsoleScreenBufferSize(IN PCONSOLE Console
,
1115 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1120 if (Console
== NULL
|| Buffer
== NULL
|| Size
== NULL
)
1121 return STATUS_INVALID_PARAMETER
;
1123 /* Validity check */
1124 ASSERT(Console
== Buffer
->Header
.Console
);
1126 Status
= ConioResizeBuffer(Console
, Buffer
, *Size
);
1127 if (NT_SUCCESS(Status
)) TermResizeTerminal(Console
);
1133 ConDrvScrollConsoleScreenBuffer(IN PCONSOLE Console
,
1134 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1136 IN PSMALL_RECT ScrollRectangle
,
1137 IN BOOLEAN UseClipRectangle
,
1138 IN PSMALL_RECT ClipRectangle OPTIONAL
,
1139 IN PCOORD DestinationOrigin
,
1140 IN CHAR_INFO FillChar
)
1142 COORD CapturedDestinationOrigin
;
1143 SMALL_RECT ScreenBuffer
;
1144 SMALL_RECT SrcRegion
;
1145 SMALL_RECT DstRegion
;
1146 SMALL_RECT UpdateRegion
;
1147 SMALL_RECT CapturedClipRectangle
;
1149 if (Console
== NULL
|| Buffer
== NULL
|| ScrollRectangle
== NULL
||
1150 (UseClipRectangle
? ClipRectangle
== NULL
: FALSE
) || DestinationOrigin
== NULL
)
1152 return STATUS_INVALID_PARAMETER
;
1155 /* Validity check */
1156 ASSERT(Console
== Buffer
->Header
.Console
);
1158 CapturedDestinationOrigin
= *DestinationOrigin
;
1160 /* Make sure the source rectangle is inside the screen buffer */
1161 ConioInitRect(&ScreenBuffer
, 0, 0,
1162 Buffer
->ScreenBufferSize
.Y
- 1,
1163 Buffer
->ScreenBufferSize
.X
- 1);
1164 if (!ConioGetIntersection(&SrcRegion
, &ScreenBuffer
, ScrollRectangle
))
1166 return STATUS_SUCCESS
;
1169 /* If the source was clipped on the left or top, adjust the destination accordingly */
1170 if (ScrollRectangle
->Left
< 0)
1172 CapturedDestinationOrigin
.X
-= ScrollRectangle
->Left
;
1174 if (ScrollRectangle
->Top
< 0)
1176 CapturedDestinationOrigin
.Y
-= ScrollRectangle
->Top
;
1179 if (UseClipRectangle
)
1181 CapturedClipRectangle
= *ClipRectangle
;
1182 if (!ConioGetIntersection(&CapturedClipRectangle
, &CapturedClipRectangle
, &ScreenBuffer
))
1184 return STATUS_SUCCESS
;
1189 CapturedClipRectangle
= ScreenBuffer
;
1192 ConioInitRect(&DstRegion
,
1193 CapturedDestinationOrigin
.Y
,
1194 CapturedDestinationOrigin
.X
,
1195 CapturedDestinationOrigin
.Y
+ ConioRectHeight(&SrcRegion
) - 1,
1196 CapturedDestinationOrigin
.X
+ ConioRectWidth(&SrcRegion
) - 1);
1201 ConsoleOutputAnsiToUnicodeChar(Console
, &tmp
, &FillChar
.Char
.AsciiChar
);
1202 FillChar
.Char
.UnicodeChar
= tmp
;
1205 ConioMoveRegion(Buffer
, &SrcRegion
, &DstRegion
, &CapturedClipRectangle
, FillChar
);
1207 if ((PCONSOLE_SCREEN_BUFFER
)Buffer
== Console
->ActiveBuffer
)
1209 ConioGetUnion(&UpdateRegion
, &SrcRegion
, &DstRegion
);
1210 if (ConioGetIntersection(&UpdateRegion
, &UpdateRegion
, &CapturedClipRectangle
))
1212 /* Draw update region */
1213 TermDrawRegion(Console
, &UpdateRegion
);
1217 return STATUS_SUCCESS
;
1221 ConDrvSetConsoleWindowInfo(IN PCONSOLE Console
,
1222 IN PTEXTMODE_SCREEN_BUFFER Buffer
,
1223 IN BOOLEAN Absolute
,
1224 IN PSMALL_RECT WindowRect
)
1226 SMALL_RECT CapturedWindowRect
;
1227 COORD LargestWindowSize
;
1229 if (Console
== NULL
|| Buffer
== NULL
|| WindowRect
== NULL
)
1230 return STATUS_INVALID_PARAMETER
;
1232 /* Validity check */
1233 ASSERT(Console
== Buffer
->Header
.Console
);
1235 CapturedWindowRect
= *WindowRect
;
1239 /* Relative positions are given, transform them to absolute ones */
1240 CapturedWindowRect
.Left
+= Buffer
->ViewOrigin
.X
;
1241 CapturedWindowRect
.Top
+= Buffer
->ViewOrigin
.Y
;
1242 CapturedWindowRect
.Right
+= Buffer
->ViewOrigin
.X
+ Buffer
->ViewSize
.X
- 1;
1243 CapturedWindowRect
.Bottom
+= Buffer
->ViewOrigin
.Y
+ Buffer
->ViewSize
.Y
- 1;
1247 * The MSDN documentation on SetConsoleWindowInfo is partially wrong about
1248 * the performed checks this API performs. While it is correct that the
1249 * 'Right'/'Bottom' members cannot be strictly smaller than the 'Left'/'Top'
1250 * members, they can be equal.
1251 * Also, if the 'Left' or 'Top' members are negative, this is automatically
1252 * corrected for, and the window rectangle coordinates are shifted accordingly.
1254 if ((CapturedWindowRect
.Right
< CapturedWindowRect
.Left
) ||
1255 (CapturedWindowRect
.Bottom
< CapturedWindowRect
.Top
))
1257 return STATUS_INVALID_PARAMETER
;
1261 * Forbid window sizes larger than the largest allowed console window size,
1262 * taking into account the size of the console screen buffer.
1264 TermGetLargestConsoleWindowSize(Console
, &LargestWindowSize
);
1265 LargestWindowSize
.X
= min(LargestWindowSize
.X
, Buffer
->ScreenBufferSize
.X
);
1266 LargestWindowSize
.Y
= min(LargestWindowSize
.Y
, Buffer
->ScreenBufferSize
.Y
);
1267 if ((CapturedWindowRect
.Right
- CapturedWindowRect
.Left
+ 1 > LargestWindowSize
.X
) ||
1268 (CapturedWindowRect
.Bottom
- CapturedWindowRect
.Top
+ 1 > LargestWindowSize
.Y
))
1270 return STATUS_INVALID_PARAMETER
;
1273 /* Shift the window rectangle coordinates if 'Left' or 'Top' are negative */
1274 if (CapturedWindowRect
.Left
< 0)
1276 CapturedWindowRect
.Right
-= CapturedWindowRect
.Left
;
1277 CapturedWindowRect
.Left
= 0;
1279 if (CapturedWindowRect
.Top
< 0)
1281 CapturedWindowRect
.Bottom
-= CapturedWindowRect
.Top
;
1282 CapturedWindowRect
.Top
= 0;
1285 /* Clip the window rectangle to the screen buffer */
1286 CapturedWindowRect
.Right
= min(CapturedWindowRect
.Right
, Buffer
->ScreenBufferSize
.X
);
1287 CapturedWindowRect
.Bottom
= min(CapturedWindowRect
.Bottom
, Buffer
->ScreenBufferSize
.Y
);
1289 Buffer
->ViewOrigin
.X
= CapturedWindowRect
.Left
;
1290 Buffer
->ViewOrigin
.Y
= CapturedWindowRect
.Top
;
1292 Buffer
->ViewSize
.X
= CapturedWindowRect
.Right
- CapturedWindowRect
.Left
+ 1;
1293 Buffer
->ViewSize
.Y
= CapturedWindowRect
.Bottom
- CapturedWindowRect
.Top
+ 1;
1295 TermResizeTerminal(Console
);
1297 return STATUS_SUCCESS
;