Fixed VTerm Clear to use current colour instead of black
[tpg/acess2.git] / Kernel / drv / vterm.c
1 /*
2  * Acess2 Virtual Terminal Driver
3  */
4 #include <common.h>
5 #include <fs_devfs.h>
6 #include <modules.h>
7 #include <tpl_drv_video.h>
8 #include <tpl_drv_keyboard.h>
9
10 // === CONSTANTS ===
11 #define NUM_VTS 4
12 #define MAX_INPUT_CHARS 64
13 #define VT_SCROLLBACK   1       // 4 Screens of text
14 #define DEFAULT_OUTPUT  "/Devices/VGA"
15 #define DEFAULT_INPUT   "/Devices/PS2Keyboard"
16 #define DEFAULT_WIDTH   80
17 #define DEFAULT_HEIGHT  25
18 #define DEFAULT_COLOUR  (VT_COL_BLACK|(VT_COL_WHITE<<16))
19
20 #define VT_FLAG_HIDECSR 0x01
21
22 enum eVT_Modes {
23         VT_MODE_TEXT8,  // UTF-8 Text Mode (VT100 Emulation)
24         VT_MODE_TEXT32, // UTF-32 Text Mode (Acess Native)
25         VT_MODE_8BPP,   // 256 Colour Mode
26         VT_MODE_16BPP,  // 16 bit Colour Mode
27         VT_MODE_24BPP,  // 24 bit Colour Mode
28         VT_MODE_32BPP,  // 32 bit Colour Mode
29         NUM_VT_MODES
30 };
31
32 // === TYPES ===
33 typedef struct {
34          int    Mode;
35          int    Flags;
36          int    Width, Height;
37          int    ViewPos, WritePos;
38         Uint32  CurColour;
39         char    Name[2];
40          int    InputRead;
41          int    InputWrite;
42         Uint32  InputBuffer[MAX_INPUT_CHARS];
43         union {
44                 tVT_Char        *Text;
45                 Uint32          *Buffer;
46         };
47         tVFS_Node       Node;
48 } tVTerm;
49
50 // === PROTOTYPES ===
51  int    VT_Install(char **Arguments);
52 char    *VT_ReadDir(tVFS_Node *Node, int Pos);
53 tVFS_Node       *VT_FindDir(tVFS_Node *Node, char *Name);
54 Uint64  VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
55 Uint64  VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
56  int    VT_IOCtl(tVFS_Node *Node, int Id, void *Data);
57 void    VT_KBCallBack(Uint32 Codepoint);
58 void    VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count);
59  int    VT_int_ParseEscape(tVTerm *Term, char *Buffer);
60 void    VT_int_PutChar(tVTerm *Term, Uint32 Ch);
61 void    VT_int_UpdateScreen( tVTerm *Term, int UpdateAll );
62
63 // === CONSTANTS ===
64 const Uint16    caVT100Colours[] = {
65                 VT_COL_BLACK, 0x700, 0x070, 0x770, 0x007, 0x707, 0x077, VT_COL_LTGREY,
66                 VT_COL_GREY, 0xF00, 0x0F0, 0xFF0, 0x00F, 0xF0F, 0x0FF, VT_COL_WHITE
67         };
68
69 // === GLOBALS ===
70 MODULE_DEFINE(0, 0x0032, VTerm, VT_Install, NULL, NULL);
71 tDevFS_Driver   gVT_DrvInfo = {
72         NULL, "VTerm",
73         {
74         .Flags = VFS_FFLAG_DIRECTORY,
75         .Inode = -1,
76         .NumACLs = 0,
77         .ReadDir = VT_ReadDir,
78         .FindDir = VT_FindDir
79         }
80 };
81 tVTerm  gVT_Terminals[NUM_VTS];
82 char    *gsVT_OutputDevice = NULL;
83 char    *gsVT_InputDevice = NULL;
84  int    giVT_OutputDevHandle = -2;
85  int    giVT_InputDevHandle = -2;
86  int    giVT_CurrentTerminal = 0;
87
88 // === CODE ===
89 /**
90  * \fn int VT_Install(char **Arguments)
91  * \brief Installs the Virtual Terminal Driver
92  */
93 int VT_Install(char **Arguments)
94 {
95         char    **args = Arguments;
96         char    *arg;
97          int    i;
98         
99         // Scan Arguments
100         if(Arguments)
101         {
102                 for( ; (arg = *args); args++ )
103                 {
104                         if(arg[0] != '-')       continue;
105                         
106                         switch(arg[1])
107                         {
108                         // Set output device
109                         case 'o':
110                                 if(args[1] ==  NULL)    break;
111                                 if(gsVT_OutputDevice)   free(gsVT_OutputDevice);
112                                 gsVT_OutputDevice = malloc(strlen(args[1])+1);
113                                 strcpy(gsVT_OutputDevice, args[1]);
114                                 args ++;
115                                 break;
116                         
117                         // Set input device
118                         case 'i':
119                                 if(args[1] == NULL)     break;
120                                 if(gsVT_InputDevice)    free(gsVT_InputDevice);
121                                 gsVT_InputDevice = malloc(strlen(args[1])+1);
122                                 strcpy(gsVT_InputDevice, args[1]);
123                                 args ++;
124                                 break;
125                         
126                         }
127                 }
128         }
129         
130         // Apply Defaults
131         if(!gsVT_OutputDevice)  gsVT_OutputDevice = DEFAULT_OUTPUT;
132         if(!gsVT_InputDevice)   gsVT_InputDevice = DEFAULT_INPUT;
133         
134         LOG("Using '%s' as output", gsVT_OutputDevice);
135         LOG("Using '%s' as input", gsVT_InputDevice);
136         
137         // Create Nodes
138         for( i = 0; i < NUM_VTS; i++ )
139         {
140                 gVT_Terminals[i].Mode = VT_MODE_TEXT8;
141                 gVT_Terminals[i].Flags = 0;
142                 gVT_Terminals[i].Width = DEFAULT_WIDTH;
143                 gVT_Terminals[i].Height = DEFAULT_HEIGHT;
144                 gVT_Terminals[i].CurColour = DEFAULT_COLOUR;
145                 gVT_Terminals[i].WritePos = 0;
146                 gVT_Terminals[i].ViewPos = 0;
147                 
148                 gVT_Terminals[i].Buffer = malloc( DEFAULT_WIDTH*DEFAULT_HEIGHT*VT_SCROLLBACK*sizeof(tVT_Char) );
149                 memset( gVT_Terminals[i].Buffer, 0, DEFAULT_WIDTH*DEFAULT_HEIGHT*VT_SCROLLBACK*sizeof(tVT_Char) );
150                 
151                 gVT_Terminals[i].Name[0] = '0'+i;
152                 gVT_Terminals[i].Name[1] = '\0';
153                 gVT_Terminals[i].Node.Inode = i;
154                 gVT_Terminals[i].Node.NumACLs = 0;      // Only root can open virtual terminals
155                 
156                 gVT_Terminals[i].Node.Read = VT_Read;
157                 gVT_Terminals[i].Node.Write = VT_Write;
158                 gVT_Terminals[i].Node.IOCtl = VT_IOCtl;
159         }
160         
161         // Add to DevFS
162         DevFS_AddDevice( &gVT_DrvInfo );
163         
164         return 0;
165 }
166
167 /**
168  * \fn void VT_InitOutput()
169  * \brief Initialise Video Output
170  */
171 void VT_InitOutput()
172 {
173         giVT_OutputDevHandle = VFS_Open(gsVT_OutputDevice, VFS_OPENFLAG_WRITE);
174         LOG("giVT_OutputDevHandle = %x\n", giVT_OutputDevHandle);
175 }
176
177 /**
178  * \fn void VT_InitInput()
179  * \brief Initialises the input
180  */
181 void VT_InitInput()
182 {
183         giVT_InputDevHandle = VFS_Open(gsVT_InputDevice, VFS_OPENFLAG_READ);
184         LOG("giVT_InputDevHandle = %x\n", giVT_InputDevHandle);
185         if(giVT_InputDevHandle == -1)   return ;
186         VFS_IOCtl(giVT_InputDevHandle, KB_IOCTL_SETCALLBACK, VT_KBCallBack);
187 }
188
189 /**
190  * \fn char *VT_ReadDir(tVFS_Node *Node, int Pos)
191  * \brief Read from the VTerm Directory
192  */
193 char *VT_ReadDir(tVFS_Node *Node, int Pos)
194 {
195         if(Pos < 0)     return NULL;
196         if(Pos >= NUM_VTS)      return NULL;
197         return gVT_Terminals[Pos].Name;
198 }
199
200 /**
201  * \fn tVFS_Node *VT_FindDir(tVFS_Node *Node, char *Name)
202  * \brief Find an item in the VTerm directory
203  */
204 tVFS_Node *VT_FindDir(tVFS_Node *Node, char *Name)
205 {
206          int    num;
207         
208         //ENTER("pNode sName", Node, Name);
209         
210         // Open the input and output files if needed
211         if(giVT_OutputDevHandle == -2)  VT_InitOutput();
212         if(giVT_InputDevHandle == -2)   VT_InitInput();
213         
214         // Sanity check name
215         if(Name[0] < '0' || Name[0] > '9' || Name[1] != '\0') {
216                 LEAVE('n');
217                 return NULL;
218         }
219         // Get index
220         num = Name[0] - '0';
221         if(num >= NUM_VTS) {
222                 LEAVE('n');
223                 return NULL;
224         }
225         // Return node
226         //LEAVE('p', &gVT_Terminals[num].Node);
227         return &gVT_Terminals[num].Node;
228 }
229
230 /**
231  * \fn Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
232  * \brief Read from a virtual terminal
233  */
234 Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
235 {
236          int    pos = 0;
237         tVTerm  *term = &gVT_Terminals[ Node->Inode ];
238         
239         // Check current mode
240         switch(term->Mode)
241         {
242         case VT_MODE_TEXT8:
243                 while(pos < Length)
244                 {
245                         while(term->InputRead == term->InputWrite)      Proc_Yield();
246                         while(term->InputRead != term->InputWrite)
247                         {
248                                 LOG("WriteUTF8(%p, 0x%x)", Buffer+pos, term->InputBuffer[term->InputRead]);
249                                 pos += WriteUTF8(Buffer+pos, term->InputBuffer[term->InputRead]);
250                                 term->InputRead ++;
251                                 term->InputRead %= MAX_INPUT_CHARS;
252                         }
253                 }
254                 break;
255         
256         case VT_MODE_TEXT32:
257                 while(pos < Length)
258                 {
259                         while(term->InputRead == term->InputWrite)      Proc_Yield();
260                         while(term->InputRead != term->InputWrite)
261                         {
262                                 ((Uint32*)Buffer)[pos] = term->InputBuffer[term->InputRead];
263                                 pos ++;
264                                 term->InputRead ++;
265                                 term->InputRead %= MAX_INPUT_CHARS;
266                         }
267                 }
268                 break;
269         }
270         return 0;
271 }
272
273 /**
274  * \fn Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
275  * \brief Write to a virtual terminal
276  */
277 Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
278 {
279         tVTerm  *term = &gVT_Terminals[ Node->Inode ];
280         
281         //ENTER("pNode XOffset XLength pBuffer",  Node, Offset, Length, Buffer);
282         
283         // Write
284         switch( term->Mode )
285         {
286         case VT_MODE_TEXT8:
287                 VT_int_PutString(term, Buffer, Length);
288                 break;
289         case VT_MODE_TEXT32:
290                 //VT_int_PutString32(term, Buffer, Length);
291                 break;
292         }
293         
294         //LEAVE('i', 0);
295         return 0;
296 }
297
298 /**
299  * \fn int VT_IOCtl(tVFS_Node *Node, int Id, void *Data)
300  * \brief Call an IO Control on a virtual terminal
301  */
302 int VT_IOCtl(tVFS_Node *Node, int Id, void *Data)
303 {
304         return 0;
305 }
306
307 /**
308  * \fn void VT_KBCallBack(Uint32 Codepoint)
309  * \brief Called on keyboard interrupt
310  */
311 void VT_KBCallBack(Uint32 Codepoint)
312 {
313         tVTerm  *term = &gVT_Terminals[giVT_CurrentTerminal];
314         
315         term->InputBuffer[ term->InputWrite ] = Codepoint;
316         term->InputWrite ++;
317         term->InputWrite %= MAX_INPUT_CHARS;
318         if(term->InputRead == term->InputWrite) {
319                 term->InputRead ++;
320                 term->InputRead %= MAX_INPUT_CHARS;
321         }
322 }
323
324 /**
325  * \fn void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
326  * \brief Print a string to the Virtual Terminal
327  */
328 void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
329 {
330         Uint32  val;
331          int    i;
332         for( i = 0; i < Count; i++ )
333         {
334                 if( Buffer[i] == 0x1B ) // Escape Sequence
335                 {
336                         i ++;
337                         i += VT_int_ParseEscape(Term, (char*)&Buffer[i]);
338                         continue;
339                 }
340                 
341                 if( Buffer[i] < 128 )   // Plain ASCII
342                         VT_int_PutChar(Term, Buffer[i]);
343                 else {  // UTF-8
344                         i += ReadUTF8(&Buffer[i], &val);
345                         VT_int_PutChar(Term, val);
346                 }
347         }
348         
349         // Update cursor
350         if( !(Term->Flags & VT_FLAG_HIDECSR) )
351         {
352                 tVideo_IOCtl_Pos        pos;
353                 pos.x = Term->WritePos % Term->Width;
354                 pos.y = Term->WritePos / Term->Width;
355                 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETCURSOR, &pos);
356         }
357 }
358
359 /**
360  * \fn void VT_int_ClearLine(tVTerm *Term, int Num)
361  * \brief Clears a line in a virtual terminal
362  */
363 void VT_int_ClearLine(tVTerm *Term, int Num)
364 {
365          int    i;
366         memset(Term->Text, 0, Term->Width*Term->Height*VT_SCROLLBACK*sizeof(tVT_Char));
367         for( i = Term->Width; i++; )
368         {
369                 Term->Text[ Num*Term->Width + i ].Ch = 0;
370                 Term->Text[ Num*Term->Width + i ].Colour = Term->CurColour;
371         }
372 }
373
374 /**
375  * \fn int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
376  * \brief Parses a VT100 Escape code
377  */
378 int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
379 {
380         char    c;
381          int    argc = 0, j = 1;
382          int    args[4] = {0,0,0,0};
383         
384         switch(Buffer[0]) {
385         //Large Code
386         case '[':
387                 // Get Arguments
388                 c = Buffer[1];
389                 do {
390                         while('0' <= c && c <= '9') {
391                                 args[argc] *= 10;
392                                 args[argc] += c-'0';
393                                 c = Buffer[++j];
394                         }
395                         argc ++;
396                 } while(c == ';');
397                 
398                 // Get string (what does this do?)
399                 if(c == '"') {
400                         c = Buffer[++j];
401                         while(c != '"')
402                                 c = Buffer[++j];
403                 }
404                 
405                 // Get Command
406                 if(     ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z'))
407                 {
408                         switch(c) {
409                         //Clear By Line
410                         case 'J':
411                                 // Clear Screen
412                                 switch(args[0])
413                                 {
414                                 case 2:
415                                         {
416                                          int    i = Term->Height * VT_SCROLLBACK;;
417                                         while( i-- )    VT_int_ClearLine(Term, i);
418                                         Term->WritePos = 0;
419                                         Term->ViewPos = 0;
420                                         VT_int_UpdateScreen(Term, 1);
421                                         }
422                                         break;
423                                 }
424                                 break;
425                         // Set Font flags
426                         case 'm':
427                                 for( ; argc--; )
428                                 {
429                                         // Flags
430                                         if( 0 <= args[argc] && args[argc] <= 8)
431                                         {
432                                                 switch(args[argc])
433                                                 {
434                                                 case 0: Term->CurColour = DEFAULT_COLOUR;       break;  // Reset
435                                                 case 1: Term->CurColour |= 0x80000000;  break;  // Bright
436                                                 case 2: Term->CurColour &= ~0x80000000; break;  // Dim
437                                                 }
438                                         }
439                                         // Foreground Colour
440                                         else if(30 <= args[argc] && args[argc] <= 37) {
441                                                 Term->CurColour &= 0xF000FFFF;
442                                                 Term->CurColour |= (Uint32)caVT100Colours[ args[argc]-30+(Term->CurColour>>28) ] << 16;
443                                         }
444                                         // Background Colour
445                                         else if(40 <= args[argc] && args[argc] <= 47) {
446                                                 Term->CurColour &= 0xFFFF8000;
447                                                 Term->CurColour |= caVT100Colours[ args[argc]-40+((Term->CurColour>>12)&15) ];
448                                         }
449                                 }
450                                 break;
451                         }
452                 }
453                 break;
454                 
455         default:
456                 break;
457         }
458         
459         return j + 1;
460 }
461
462 /**
463  * \fn void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
464  * \brief Write a single character to a VTerm
465  */
466 void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
467 {
468          int    i;
469         //ENTER("pTerm xCh", Term, Ch);
470         //LOG("Term = {WritePos:%i, ViewPos:%i}\n", Term->WritePos, Term->ViewPos);
471         
472         switch(Ch)
473         {
474         case 0: return; // Ignore NULL byte
475         case '\n':
476                 Term->WritePos += Term->Width;
477         case '\r':
478                 Term->WritePos -= Term->WritePos % Term->Width;
479                 break;
480         
481         case '\t':
482                 do {
483                         Term->Text[ Term->WritePos ].Ch = '\t';
484                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
485                         Term->WritePos ++;
486                 } while(Term->WritePos & 7);
487                 break;
488         
489         case '\b':
490                 // Backspace is invalid at Offset 0
491                 if(Term->WritePos == 0) break;
492                 
493                 Term->WritePos --;
494                 // Singe Character
495                 if(Term->Text[ Term->WritePos ].Ch != '\t') {
496                         Term->Text[ Term->WritePos ].Ch = 0;
497                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
498                         break;
499                 }
500                 // Tab
501                 i = 7;  // Limit it to 8
502                 do {
503                         Term->Text[ Term->WritePos ].Ch = 0;
504                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
505                         Term->WritePos --;
506                 } while(Term->WritePos && i-- && Term->Text[ Term->WritePos ].Ch == '\t');
507                 break;
508         
509         default:
510                 Term->Text[ Term->WritePos ].Ch = Ch;
511                 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
512                 Term->WritePos ++;
513                 break;
514         }
515                 
516         
517         // Move Screen
518         if(Term->WritePos >= Term->Width*Term->Height*VT_SCROLLBACK)
519         {
520                  int    base, i;
521                 Term->WritePos -= Term->Width;
522                 
523                 // Update view position
524                 base = Term->Width*Term->Height*(VT_SCROLLBACK-1);
525                 if(Term->ViewPos < base)        Term->ViewPos += Term->Width;
526                 if(Term->ViewPos > base)        Term->ViewPos = base;
527                 
528                 // Scroll terminal cache
529                 base = Term->Width*(Term->Height*VT_SCROLLBACK-1);
530                 
531                 // Scroll Back
532                 memcpy(
533                         Term->Text,
534                         &Term->Text[Term->Width],
535                         Term->Width*(Term->Height-1)*VT_SCROLLBACK*sizeof(tVT_Char)
536                         );
537                 
538                 // Clear last row
539                 for( i = 0; i < Term->Width; i ++ )
540                 {
541                         Term->Text[ base + i ].Ch = 0;
542                         Term->Text[ base + i ].Colour = Term->CurColour;
543                 }
544                 
545                 VT_int_UpdateScreen( Term, 1 );
546         }
547         else if(Term->WritePos > Term->Width*Term->Height+Term->ViewPos)
548         {
549                 Term->ViewPos += Term->Width;
550                 VT_int_UpdateScreen( Term, 1 );
551         }
552         else
553                 VT_int_UpdateScreen( Term, 0 );
554         
555         //LEAVE('-');
556 }
557
558 /**
559  * \fn void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
560  * \brief Updates the video framebuffer
561  */
562 void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
563 {
564         if(UpdateAll) {
565                 VFS_WriteAt(
566                         giVT_OutputDevHandle,
567                         0,
568                         Term->Width*Term->Height*sizeof(tVT_Char),
569                         &Term->Text[Term->ViewPos]
570                         );
571         } else {
572                  int    pos = Term->WritePos - Term->WritePos % Term->Width;
573                 VFS_WriteAt(
574                         giVT_OutputDevHandle,
575                         (pos - Term->ViewPos)*sizeof(tVT_Char),
576                         Term->Width*sizeof(tVT_Char),
577                         &Term->Text[pos]
578                         );
579         }
580 }
581
582 // ---
583 // Font Render
584 // ---
585 #define MONOSPACE_FONT  10816
586
587 #if MONOSPACE_FONT == 10808     // 8x8
588 # include "vterm_font_8x8.h"
589 #elif MONOSPACE_FONT == 10816   // 8x16
590 # include "vterm_font_8x16.h"
591 #endif
592
593
594 int VT_Font_GetWidth(Uint32 Codepoint)
595 {
596         return FONT_WIDTH;
597 }
598 int VT_Font_GetHeight(Uint32 Codepoint)
599 {
600         return FONT_HEIGHT;
601 }
602
603 void VT_Font_Render(Uint32 Codepoint, void *Buffer, Uint32 BGC, Uint32 FGC)
604 {
605 //      Uint8   *font;
606         
607 }
608
609 /**
610  * \fn Uint8 *VT_Font_GetChar(Uint32 Codepoint)
611  * \brief Gets an index into the font array given a Unicode Codepoint
612  * \note See http://en.wikipedia.org/wiki/CP437
613  */
614 Uint8 *VT_Font_GetChar(Uint32 Codepoint)
615 {
616          int    index = 0;
617         if(Codepoint < 128)
618                 return &VTermFont[Codepoint*FONT_HEIGHT];
619         switch(Codepoint)
620         {
621         case 0xC7:      index = 128;    break;  // Ç
622         case 0xFC:      index = 129;    break;  // ü
623         case 0xE9:      index = 130;    break;  // é
624         case 0xE2:      index = 131;    break;  // â
625         case 0xE4:      index = 132;    break;  // ä
626         case 0xE0:      index = 133;    break;  // à
627         case 0xE5:      index = 134;    break;  // å
628         case 0xE7:      index = 135;    break;  // ç
629         case 0xEA:      index = 136;    break;  // ê
630         case 0xEB:      index = 137;    break;  // ë
631         case 0xE8:      index = 138;    break;  // è
632         case 0xEF:      index = 139;    break;  // ï
633         case 0xEE:      index = 140;    break;  // î
634         case 0xEC:      index = 141;    break;  // ì
635         case 0xC4:      index = 142;    break;  // Ä
636         case 0xC5:      index = 143;    break;  // Å
637         }
638         
639         return &VTermFont[index*FONT_HEIGHT];
640 }

UCC git Repository :: git.ucc.asn.au