git.sur5r.net Git - cc65/blob - include/conio.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  conio.h                                  */
   4 /*                                                                           */
   5 /*                            Direct console I/O                             */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2004 Ullrich von Bassewitz                                       */
  10 /*               Römerstraße 52                                              */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 /*
  37  * This is the direct console interface for cc65. I do not like the function
  38  * names very much, but the first version started as a rewrite of Borlands
  39  * conio, and, even if the interface has changed, the names did not.
  40  *
  41  * The interface does direct screen I/O, so it is fast enough for most
  42  * programs. I did not implement text windows, since many applications do
  43  * not need them and should not pay for the additional overhead. It should
  44  * be easy to add text windows on a higher level if needed,
  45  *
  46  * Most routines do not check the parameters. This may be unfortunate but is
  47  * also related to speed. The coordinates are always 0/0 based.
  48  */
  49
  50
  51
  52 #ifndef _CONIO_H
  53 #define _CONIO_H
  54
  55
  56
  57 #if !defined(_STDARG_H)
  58 #  include <stdarg.h>
  59 #endif
  60
  61 /* Include the correct machine specific file */
  62 #if defined(__APPLE2__) && !defined(_APPLE2_H)
  63 #  include <apple2.h>
  64 #elif defined(__APPLE2ENH__) && !defined(_APPLE2ENH_H)
  65 #  include <apple2enh.h>
  66 #elif defined(__ATARI__) && !defined(_ATARI_H)
  67 #  include <atari.h>
  68 #elif defined(__ATMOS__) && !defined(_ATMOS_H)
  69 #  include <atmos.h>
  70 #elif defined(__CBM__) && !defined(_CBM_H)
  71 #  include <cbm.h>
  72 #elif defined(__NES__) && !defined(_NES_H)
  73 #  include <nes.h>
  74 #else
  75 #  error "Unknown platform in conio.h"
  76 #endif
  77
  78
  79
  80 /*****************************************************************************/
  81 /*                                 Functions                                 */
  82 /*****************************************************************************/
  83
  84
  85
  86 void clrscr (void);
  87 /* Clear the whole screen and put the cursor into the top left corner */
  88
  89 unsigned char kbhit (void);
  90 /* Return true if there's a key waiting, return false if not */
  91
  92 void __fastcall__ gotox (unsigned char x);
  93 /* Set the cursor to the specified X position, leave the Y position untouched */
  94
  95 void __fastcall__ gotoy (unsigned char y);
  96 /* Set the cursor to the specified Y position, leave the X position untouched */
  97
  98 void __fastcall__ gotoxy (unsigned char x, unsigned char y);
  99 /* Set the cursor to the specified position */
 100
 101 unsigned char wherex (void);
 102 /* Return the X position of the cursor */
 103
 104 unsigned char wherey (void);
 105 /* Return the Y position of the cursor */
 106
 107 void __fastcall__ cputc (char c);
 108 /* Output one character at the current cursor position */
 109
 110 void __fastcall__ cputcxy (unsigned char x, unsigned char y, char c);
 111 /* Same as "gotoxy (x, y); cputc (c);" */
 112
 113 void __fastcall__ cputs (const char* s);
 114 /* Output a NUL terminated string at the current cursor position */
 115
 116 void __fastcall__ cputsxy (unsigned char x, unsigned char y, const char* s);
 117 /* Same as "gotoxy (x, y); puts (s);" */
 118
 119 int cprintf (const char* format, ...);
 120 /* Like printf, but uses direct screen I/O */
 121
 122 int __fastcall__ vcprintf (const char* format, va_list ap);
 123 /* Like vprintf, but uses direct screen I/O */
 124
 125 char cgetc (void);
 126 /* Return a character from the keyboard. If there is no character available,
 127  * the functions waits until the user does press a key. If cursor is set to
 128  * 1 (see below), a blinking cursor is displayed while waiting.
 129  */
 130
 131 unsigned char __fastcall__ cursor (unsigned char onoff);
 132 /* If onoff is 1, a cursor is display when waiting for keyboard input. If
 133  * onoff is 0, the cursor is hidden when waiting for keyboard input. The
 134  * function returns the old cursor setting.
 135  */
 136
 137 unsigned char __fastcall__ revers (unsigned char onoff);
 138 /* Enable/disable reverse character display. This may not be supported by
 139  * the output device. Return the old setting.
 140  */
 141
 142 unsigned char __fastcall__ textcolor (unsigned char color);
 143 /* Set the color for text output. The old color setting is returned. */
 144
 145 unsigned char __fastcall__ bgcolor (unsigned char color);
 146 /* Set the color for the background. The old color setting is returned. */
 147
 148 unsigned char __fastcall__ bordercolor (unsigned char color);
 149 /* Set the color for the border. The old color setting is returned. */
 150
 151 void __fastcall__ chline (unsigned char length);
 152 /* Output a horizontal line with the given length starting at the current
 153  * cursor position.
 154  */
 155
 156 void __fastcall__ chlinexy (unsigned char x, unsigned char y, unsigned char length);
 157 /* Same as "gotoxy (x, y); chline (length);" */
 158
 159 void __fastcall__ cvline (unsigned char length);
 160 /* Output a vertical line with the given length at the current cursor
 161  * position.
 162  */
 163
 164 void __fastcall__ cvlinexy (unsigned char x, unsigned char y, unsigned char length);
 165 /* Same as "gotoxy (x, y); cvline (length);" */
 166
 167 void __fastcall__ cclear (unsigned char length);
 168 /* Clear part of a line (write length spaces). */
 169
 170 void __fastcall__ cclearxy (unsigned char x, unsigned char y, unsigned char length);
 171 /* Same as "gotoxy (x, y); cclear (length);" */
 172
 173 void __fastcall__ screensize (unsigned char* x, unsigned char* y);
 174 /* Return the current screen size. */
 175
 176 void __fastcall__ cputhex8 (unsigned char val);
 177 void __fastcall__ cputhex16 (unsigned val);
 178 /* These shouldn't be here... */
 179
 180
 181
 182 /* End of conio.h */
 183 #endif
 184
 185
 186