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)
29 for( int ofs = 0; ofs < Count; )
31 int esc_len = Term_HandleVT100(Term, Count - ofs, (const void*)(Buffer + ofs));
34 //LOG("%i '%*C'", esc_len, esc_len, Buffer+ofs);
35 LOG("%i '%.*s'", esc_len, esc_len, Buffer+ofs);
36 VT_int_PutRawString(Term, Buffer + ofs, esc_len);
37 //Debug("Raw string '%.*s'", esc_len, Buffer+ofs);
40 //Debug("Escape code '%.*s'", esc_len, Buffer+ofs);
42 ASSERTCR(esc_len, >, 0, );
46 VT_int_UpdateScreen( Term, 1 );
49 void VT_int_PutRawString(tVTerm *Term, const Uint8 *String, size_t Bytes)
51 for( int i = 0; i < Bytes; ) {
53 i += ReadUTF8(String+i, &val);
54 VT_int_PutChar(Term, val);
59 * \fn void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
60 * \brief Write a single character to a VTerm
62 void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
68 const size_t maxrows = VT_int_GetBufferRows(Term);
69 const size_t limit = maxrows * Term->TextWidth;
70 tVT_Pos *wrpos = VT_int_GetWritePosPtr(Term);
71 tVT_Char *buffer = (Term->Flags & VT_FLAG_ALTBUF ? Term->AltBuf : Term->Text);
73 // If writing with the cursor on righthand edge, wrap down to next line
74 // TODO: Wrap to same line?
75 if( wrpos->Col >= Term->TextWidth )
77 ASSERTC(wrpos->Col, <=, Term->TextWidth);
78 VT_int_UpdateScreen( Term, 0 );
83 // Scroll entire buffer (about to write outside limit)
84 if( wrpos->Row >= maxrows )
86 ASSERTC(wrpos->Row, <, maxrows + 1);
87 VT_int_ScrollText(Term, 1);
91 // Bring written cell into view
92 if( !(Term->Flags & VT_FLAG_ALTBUF) )
94 if( wrpos->Row >= Term->ViewTopRow + Term->TextHeight )
96 size_t new_pos = wrpos->Row - (Term->TextHeight - 1);
97 size_t count = new_pos - Term->ViewTopRow;
98 VT_int_ScrollFramebuffer(Term, count);
99 //Debug("VT_int_PutChar: VScroll down to %i", new_pos);
100 Term->ViewTopRow = new_pos;
102 else if( wrpos->Row < Term->ViewTopRow )
104 size_t new_pos = wrpos->Row;
105 size_t count = Term->ViewTopRow - new_pos;
106 VT_int_ScrollFramebuffer(Term, -count);
107 //Debug("VT_int_PutChar: VScroll up to %i", new_pos);
108 Term->ViewTopRow = new_pos;
112 // no action, cell is visible
116 size_t write_pos = wrpos->Row * Term->TextWidth + wrpos->Col;
117 ASSERTC(write_pos, <, limit);
121 case '\0': // Ignore NULL byte
124 VT_int_UpdateScreen( Term, 0 ); // Update the line before newlining
126 // TODO: Force scroll?
132 size_t col = wrpos->Col;
134 buffer[ write_pos ].Ch = '\0';
135 buffer[ write_pos ].Colour = Term->CurColour;
138 } while( (col & 7) && col < Term->TextWidth );
142 // Backspace is invalid at Offset 0
143 if(write_pos == 0) break;
147 if(buffer[ write_pos ].Ch != '\0') {
148 buffer[ write_pos ].Ch = 0;
149 buffer[ write_pos ].Colour = Term->CurColour;
153 i = 7; // Limit it to 8
155 buffer[ write_pos ].Ch = 0;
156 buffer[ write_pos ].Colour = Term->CurColour;
158 } while(write_pos && i-- && buffer[ write_pos ].Ch == '\0');
159 if(buffer[ write_pos ].Ch != '\0')
161 wrpos->Col = write_pos % Term->TextWidth;
165 buffer[ write_pos ].Ch = Ch;
166 buffer[ write_pos ].Colour = Term->CurColour;
167 // Update the line before wrapping
168 if( (write_pos + 1) % Term->TextWidth == 0 )
169 VT_int_UpdateScreen( Term, 0 );
175 ASSERTC(write_pos, <=, limit);
182 void VT_int_ScrollText(tVTerm *Term, int Count)
185 int scroll_top, scroll_height;
189 // Get buffer pointer and attributes
190 size_t height = VT_int_GetBufferRows(Term);
191 tVT_Pos *wrpos = VT_int_GetWritePosPtr(Term);
193 if( Term->Flags & VT_FLAG_ALTBUF )
196 scroll_top = Term->ScrollTop;
197 scroll_height = Term->ScrollHeight;
203 scroll_height = height;
206 const tVT_Pos init_wrpos = *wrpos;
208 // Scroll text upwards (more space at bottom)
212 if(Count > scroll_height) Count = scroll_height;
213 size_t chars = Term->TextWidth*Count;
214 size_t base = Term->TextWidth*scroll_top;
215 size_t len = Term->TextWidth*(scroll_height - Count);
217 // Scroll terminal cache
218 ASSERTC( base + chars + len, <=, Term->TextWidth*height );
219 memmove( &buf[base], &buf[base+chars], len*sizeof(tVT_Char) );
222 for( int i = 0; i < chars; i ++ )
224 ASSERTC(base + len + i, <, Term->TextWidth*height);
225 buf[ base + len + i ].Ch = 0;
226 buf[ base + len + i ].Colour = Term->CurColour;
230 VT_int_ScrollFramebuffer( Term, Count );
231 if( Term->Flags & VT_FLAG_ALTBUF )
232 wrpos->Row = scroll_top;
234 wrpos->Row = Term->ViewTopRow + (Term->TextHeight - Count);
235 for( int i = 0; i < Count; i ++ )
237 VT_int_UpdateScreen( Term, 0 );
244 if(Count > scroll_height) Count = scroll_height;
246 size_t chars = Term->TextWidth*Count;
247 size_t base = Term->TextWidth*scroll_top;
248 size_t len = Term->TextWidth*scroll_height - chars;
250 // Scroll terminal cache
251 ASSERTC( base + chars + len, <=, Term->TextWidth*height );
252 memmove( &buf[base+chars], &buf[base], len*sizeof(tVT_Char) );
254 // Clear preceding rows
255 for( int i = 0; i < chars; i ++ )
258 buf[ i ].Colour = Term->CurColour;
261 // Update screen (shift framebuffer, re-render revealed lines)
262 VT_int_ScrollFramebuffer( Term, -Count );
263 if( Term->Flags & VT_FLAG_ALTBUF )
264 wrpos->Row = scroll_top;
266 wrpos->Row = Term->ViewTopRow;
267 for( int i = 0; i < Count; i ++ )
269 VT_int_UpdateScreen( Term, 0 );
280 * \brief Clears a line in a virtual terminal
281 * \param Term Terminal to modify
282 * \param Num Line number to clear
284 void VT_int_ClearLine(tVTerm *Term, int Row)
288 size_t height = VT_int_GetBufferRows(Term);
289 tVT_Char *buffer = (Term->Flags & VT_FLAG_ALTBUF ? Term->AltBuf : Term->Text);
290 ASSERTCR(Row, >=, 0, );
291 ASSERTCR(Row, <, height, );
293 size_t base = Row * Term->TextWidth;
295 for( int i = 0; i < Term->TextWidth; i ++ )
297 buffer[ base + i ].Ch = 0;
298 buffer[ base + i ].Colour = Term->CurColour;
304 void VT_int_ClearInLine(tVTerm *Term, int Row, int FirstCol, int LastCol)
308 size_t height = VT_int_GetBufferRows(Term);
309 tVT_Char *buffer = (Term->Flags & VT_FLAG_ALTBUF ? Term->AltBuf : Term->Text);
310 ASSERTCR(Row, >=, 0, );
311 ASSERTCR(Row, <, height, );
313 ASSERTCR(FirstCol, <=, LastCol, );
314 ASSERTCR(FirstCol, <, Term->TextWidth, );
315 ASSERTCR(LastCol, <=, Term->TextWidth, );
317 size_t base = Row * Term->TextWidth;
318 for( int i = FirstCol; i < LastCol; i ++ )
320 ASSERTC(base + i, <, height * Term->TextWidth);
321 buffer[ base + i ].Ch = 0;
322 buffer[ base + i ].Colour = Term->CurColour;
329 * \brief Update the screen mode
330 * \param Term Terminal to update
331 * \param NewMode New mode to set
332 * \param NewWidth New framebuffer width
333 * \param NewHeight New framebuffer height
335 void VT_int_Resize(tVTerm *Term, int NewWidth, int NewHeight)
337 int oldW = Term->Width;
338 int oldTW = Term->TextWidth;
339 int oldH = Term->Height;
340 int oldTH = Term->TextHeight;
341 tVT_Char *oldTBuf = Term->Text;
342 Uint32 *oldFB = Term->Buffer;
347 // TODO: Increase RealWidth/RealHeight when this happens
348 if(NewWidth > giVT_RealWidth) NewWidth = giVT_RealWidth;
349 if(NewHeight > giVT_RealHeight) NewHeight = giVT_RealHeight;
351 // Fast exit if no resolution change
352 if(NewWidth == Term->Width && NewHeight == Term->Height)
355 // Calculate new dimensions
356 Term->Width = NewWidth;
357 Term->Height = NewHeight;
358 Term->TextWidth = NewWidth / giVT_CharWidth;
359 Term->TextHeight = NewHeight / giVT_CharHeight;
360 Term->ScrollHeight = Term->TextHeight - (oldTH - Term->ScrollHeight) - Term->ScrollTop;
362 // Allocate new buffers
365 Term->TextWidth * Term->TextHeight * (giVT_Scrollback+1),
370 w = (oldTW > Term->TextWidth) ? Term->TextWidth : oldTW;
371 h = (oldTH > Term->TextHeight) ? Term->TextHeight : oldTH;
372 h *= giVT_Scrollback + 1;
373 for( int i = 0; i < h; i ++ )
376 &Term->Text[i*Term->TextWidth],
385 Term->AltBuf = realloc(
387 Term->TextWidth * Term->TextHeight * sizeof(tVT_Char)
392 Term->Buffer = calloc( Term->Width * Term->Height, sizeof(Uint32) );
394 w = (oldW > Term->Width) ? Term->Width : oldW;
395 h = (oldH > Term->Height) ? Term->Height : oldH;
396 for( int i = 0; i < h; i ++ )
399 &Term->Buffer[i*Term->Width],
412 Log_Log("VTerm", "Set VT %p to text mode (%ix%i)",
413 Term, Term->TextWidth, Term->TextHeight);
416 Log_Log("VTerm", "Set VT %p to framebuffer mode (%ix%i)",
417 Term, Term->Width, Term->Height);
419 //case TERM_MODE_2DACCEL:
420 //case TERM_MODE_3DACCEL:
429 void VT_int_ToggleAltBuffer(tVTerm *Term, int Enabled)
432 Term->Flags |= VT_FLAG_ALTBUF;
434 Term->Flags &= ~VT_FLAG_ALTBUF;
435 VT_int_UpdateScreen(Term, 1);
438 tVT_Pos *VT_int_GetWritePosPtr(tVTerm *Term)
440 return ((Term->Flags & VT_FLAG_ALTBUF) ? &Term->AltWritePos : &Term->WritePos);
443 size_t VT_int_GetBufferRows(tVTerm *Term)
445 return ((Term->Flags & VT_FLAG_ALTBUF) ? 1 : (giVT_Scrollback+1))*Term->TextHeight;