3 * - By John Hodge (thePowersGang)
6 * - Virtual Terminal - Terminal buffer manipulation
9 #define DEBUG_CHECKHEAP 0
13 # define HEAP_VALIDATE() Heap_Validate()
15 # define HEAP_VALIDATE() do{}while(0)
18 extern int Term_HandleVT100(tVTerm *Term, int Len, const char *Buf);
23 * \fn void VT_int_PutString(tVTerm *Term, const Uint8 *Buffer, Uint Count)
24 * \brief Print a string to the Virtual Terminal
26 void VT_int_PutString(tVTerm *Term, const Uint8 *Buffer, Uint Count)
28 ENTER("pTerm pBuffer iCount", Term, Buffer, Count);
30 for( int ofs = 0; ofs < Count; )
32 int esc_len = Term_HandleVT100(Term, Count - ofs, (const void*)(Buffer + ofs));
35 //LOG("%i '%*C'", esc_len, esc_len, Buffer+ofs);
36 LOG("%i '%.*s'", esc_len, esc_len, Buffer+ofs);
37 VT_int_PutRawString(Term, Buffer + ofs, esc_len);
38 //Debug("Raw string '%.*s'", esc_len, Buffer+ofs);
41 //Debug("Escape code '%.*s'", esc_len, Buffer+ofs);
43 ASSERTCR(esc_len, >, 0, );
48 VT_int_UpdateScreen( Term, 0 );
52 void VT_int_PutRawString(tVTerm *Term, const Uint8 *String, size_t Bytes)
54 for( int i = 0; i < Bytes; ) {
56 i += ReadUTF8(String+i, &val);
57 VT_int_PutChar(Term, val);
62 * \fn void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
63 * \brief Write a single character to a VTerm
65 void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
71 const size_t maxrows = VT_int_GetBufferRows(Term);
72 const size_t limit = maxrows * Term->TextWidth;
73 tVT_Pos *wrpos = VT_int_GetWritePosPtr(Term);
74 tVT_Char *buffer = (Term->Flags & VT_FLAG_ALTBUF ? Term->AltBuf : Term->Text);
76 // If writing with the cursor on righthand edge, wrap down to next line
77 // TODO: Wrap to same line?
78 if( wrpos->Col >= Term->TextWidth )
80 ASSERTC(wrpos->Col, <=, Term->TextWidth);
81 VT_int_UpdateScreen( Term, 0 );
86 // Scroll entire buffer (about to write outside limit)
87 if( wrpos->Row >= maxrows )
89 ASSERTC(wrpos->Row, <, maxrows + 1);
90 VT_int_ScrollText(Term, 1);
94 // Bring written cell into view
95 if( !(Term->Flags & VT_FLAG_ALTBUF) )
97 if( wrpos->Row >= Term->ViewTopRow + Term->TextHeight )
99 size_t new_pos = wrpos->Row - (Term->TextHeight - 1);
100 size_t count = new_pos - Term->ViewTopRow;
101 VT_int_ScrollFramebuffer(Term, count);
102 //Debug("VT_int_PutChar: VScroll down to %i", new_pos);
103 Term->ViewTopRow = new_pos;
105 else if( wrpos->Row < Term->ViewTopRow )
107 size_t new_pos = wrpos->Row;
108 size_t count = Term->ViewTopRow - new_pos;
109 VT_int_ScrollFramebuffer(Term, -count);
110 //Debug("VT_int_PutChar: VScroll up to %i", new_pos);
111 Term->ViewTopRow = new_pos;
115 // no action, cell is visible
119 size_t write_pos = wrpos->Row * Term->TextWidth + wrpos->Col;
120 ASSERTC(write_pos, <, limit);
124 case '\0': // Ignore NULL byte
127 LOG("Newline, update");
128 VT_int_UpdateScreen( Term, 0 ); // Update the line before newlining
130 // TODO: Force scroll?
136 size_t col = wrpos->Col;
138 buffer[ write_pos ].Ch = '\0';
139 buffer[ write_pos ].Colour = Term->CurColour;
142 } while( (col & 7) && col < Term->TextWidth );
146 // Backspace is invalid at Offset 0
147 if(write_pos == 0) break;
151 if(buffer[ write_pos ].Ch != '\0') {
152 buffer[ write_pos ].Ch = 0;
153 buffer[ write_pos ].Colour = Term->CurColour;
157 i = 7; // Limit it to 8
159 buffer[ write_pos ].Ch = 0;
160 buffer[ write_pos ].Colour = Term->CurColour;
162 } while(write_pos && i-- && buffer[ write_pos ].Ch == '\0');
163 if(buffer[ write_pos ].Ch != '\0')
165 wrpos->Col = write_pos % Term->TextWidth;
169 buffer[ write_pos ].Ch = Ch;
170 buffer[ write_pos ].Colour = Term->CurColour;
171 // Update the line before wrapping
172 if( (write_pos + 1) % Term->TextWidth == 0 ) {
173 LOG("Line wrap, update");
174 VT_int_UpdateScreen( Term, 0 );
181 ASSERTC(write_pos, <=, limit);
185 // TODO: Schedule a delayed screen update
188 void VT_int_ScrollText(tVTerm *Term, int Count)
190 ENTER("pTerm iCount", Term, Count);
192 int scroll_top, scroll_height;
196 // Get buffer pointer and attributes
197 size_t height = VT_int_GetBufferRows(Term);
198 tVT_Pos *wrpos = VT_int_GetWritePosPtr(Term);
200 if( Term->Flags & VT_FLAG_ALTBUF )
203 scroll_top = Term->ScrollTop;
204 scroll_height = Term->ScrollHeight;
210 scroll_height = height;
213 const tVT_Pos init_wrpos = *wrpos;
215 // Scroll text upwards (more space at bottom)
219 if(Count > scroll_height) Count = scroll_height;
220 size_t chars = Term->TextWidth*Count;
221 size_t base = Term->TextWidth*scroll_top;
222 size_t len = Term->TextWidth*(scroll_height - Count);
224 // Scroll terminal cache
225 ASSERTC( base + chars + len, <=, Term->TextWidth*height );
226 memmove( &buf[base], &buf[base+chars], len*sizeof(tVT_Char) );
229 for( int i = 0; i < chars; i ++ )
231 ASSERTC(base + len + i, <, Term->TextWidth*height);
232 buf[ base + len + i ].Ch = 0;
233 buf[ base + len + i ].Colour = Term->CurColour;
237 VT_int_ScrollFramebuffer( Term, Count );
238 if( Term->Flags & VT_FLAG_ALTBUF )
239 wrpos->Row = scroll_top;
241 wrpos->Row = Term->ViewTopRow + (Term->TextHeight - Count);
242 for( int i = 0; i < Count; i ++ )
244 VT_int_UpdateScreen( Term, 0 );
251 if(Count > scroll_height) Count = scroll_height;
253 size_t chars = Term->TextWidth*Count;
254 size_t base = Term->TextWidth*scroll_top;
255 size_t len = Term->TextWidth*scroll_height - chars;
257 // Scroll terminal cache
258 ASSERTC( base + chars + len, <=, Term->TextWidth*height );
259 memmove( &buf[base+chars], &buf[base], len*sizeof(tVT_Char) );
261 // Clear preceding rows
262 for( int i = 0; i < chars; i ++ )
265 buf[ i ].Colour = Term->CurColour;
268 // Update screen (shift framebuffer, re-render revealed lines)
269 VT_int_ScrollFramebuffer( Term, -Count );
270 if( Term->Flags & VT_FLAG_ALTBUF )
271 wrpos->Row = scroll_top;
273 wrpos->Row = Term->ViewTopRow;
274 for( int i = 0; i < Count; i ++ )
276 VT_int_UpdateScreen( Term, 0 );
288 * \brief Clears a line in a virtual terminal
289 * \param Term Terminal to modify
290 * \param Num Line number to clear
292 void VT_int_ClearLine(tVTerm *Term, int Row)
296 size_t height = VT_int_GetBufferRows(Term);
297 tVT_Char *buffer = (Term->Flags & VT_FLAG_ALTBUF ? Term->AltBuf : Term->Text);
298 ASSERTCR(Row, >=, 0, );
299 ASSERTCR(Row, <, height, );
301 size_t base = Row * Term->TextWidth;
303 for( int i = 0; i < Term->TextWidth; i ++ )
305 buffer[ base + i ].Ch = 0;
306 buffer[ base + i ].Colour = Term->CurColour;
312 void VT_int_ClearInLine(tVTerm *Term, int Row, int FirstCol, int LastCol)
316 size_t height = VT_int_GetBufferRows(Term);
317 tVT_Char *buffer = (Term->Flags & VT_FLAG_ALTBUF ? Term->AltBuf : Term->Text);
318 ASSERTCR(Row, >=, 0, );
319 ASSERTCR(Row, <, height, );
321 ASSERTCR(FirstCol, <=, LastCol, );
322 ASSERTCR(FirstCol, <, Term->TextWidth, );
323 ASSERTCR(LastCol, <=, Term->TextWidth, );
325 size_t base = Row * Term->TextWidth;
326 for( int i = FirstCol; i < LastCol; i ++ )
328 ASSERTC(base + i, <, height * Term->TextWidth);
329 buffer[ base + i ].Ch = 0;
330 buffer[ base + i ].Colour = Term->CurColour;
337 * \brief Update the screen mode
338 * \param Term Terminal to update
339 * \param NewMode New mode to set
340 * \param NewWidth New framebuffer width
341 * \param NewHeight New framebuffer height
343 void VT_int_Resize(tVTerm *Term, int NewWidth, int NewHeight)
345 int oldW = Term->Width;
346 int oldTW = Term->TextWidth;
347 int oldH = Term->Height;
348 int oldTH = Term->TextHeight;
349 tVT_Char *oldTBuf = Term->Text;
350 Uint32 *oldFB = Term->Buffer;
355 // TODO: Increase RealWidth/RealHeight when this happens
356 if(NewWidth > giVT_RealWidth) NewWidth = giVT_RealWidth;
357 if(NewHeight > giVT_RealHeight) NewHeight = giVT_RealHeight;
359 // Fast exit if no resolution change
360 if(NewWidth == Term->Width && NewHeight == Term->Height)
363 // Calculate new dimensions
364 Term->Width = NewWidth;
365 Term->Height = NewHeight;
366 Term->TextWidth = NewWidth / giVT_CharWidth;
367 Term->TextHeight = NewHeight / giVT_CharHeight;
368 Term->ScrollHeight = Term->TextHeight - (oldTH - Term->ScrollHeight) - Term->ScrollTop;
370 // Allocate new buffers
373 Term->TextWidth * Term->TextHeight * (giVT_Scrollback+1),
378 w = (oldTW > Term->TextWidth) ? Term->TextWidth : oldTW;
379 h = (oldTH > Term->TextHeight) ? Term->TextHeight : oldTH;
380 h *= giVT_Scrollback + 1;
381 for( int i = 0; i < h; i ++ )
384 &Term->Text[i*Term->TextWidth],
393 Term->AltBuf = realloc(
395 Term->TextWidth * Term->TextHeight * sizeof(tVT_Char)
400 Term->Buffer = calloc( Term->Width * Term->Height, sizeof(Uint32) );
402 w = (oldW > Term->Width) ? Term->Width : oldW;
403 h = (oldH > Term->Height) ? Term->Height : oldH;
404 for( int i = 0; i < h; i ++ )
407 &Term->Buffer[i*Term->Width],
420 Log_Log("VTerm", "Set VT %p to text mode (%ix%i)",
421 Term, Term->TextWidth, Term->TextHeight);
424 Log_Log("VTerm", "Set VT %p to framebuffer mode (%ix%i)",
425 Term, Term->Width, Term->Height);
427 //case TERM_MODE_2DACCEL:
428 //case TERM_MODE_3DACCEL:
437 void VT_int_ToggleAltBuffer(tVTerm *Term, int Enabled)
440 Term->Flags |= VT_FLAG_ALTBUF;
442 Term->Flags &= ~VT_FLAG_ALTBUF;
443 VT_int_UpdateScreen(Term, 1);
446 tVT_Pos *VT_int_GetWritePosPtr(tVTerm *Term)
448 return ((Term->Flags & VT_FLAG_ALTBUF) ? &Term->AltWritePos : &Term->WritePos);
451 size_t VT_int_GetBufferRows(tVTerm *Term)
453 return ((Term->Flags & VT_FLAG_ALTBUF) ? 1 : (giVT_Scrollback+1))*Term->TextHeight;