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-2007 Ullrich von Bassewitz                                       */
  10 /*               Roemerstrasse 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 Borland's
  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__)
  63 #  include <apple2.h>
  64 #elif defined(__APPLE2ENH__)
  65 #  include <apple2enh.h>
  66 #elif defined(__ATARI__)
  67 #  include <atari.h>
  68 #elif defined(__ATMOS__)
  69 #  include <atmos.h>
  70 #elif defined(__CBM__)
  71 #  include <cbm.h>
  72 #elif defined(__GEOS__)
  73 #  include <geos.h>
  74 #elif defined(__LUNIX__)
  75 #  include <lunix.h>
  76 #elif defined(__LYNX__)
  77 #  include <lynx.h>
  78 #elif defined(__NES__)
  79 #  include <nes.h>
  80 #endif
  81
  82
  83
  84 /*****************************************************************************/
  85 /*                                 Functions                                 */
  86 /*****************************************************************************/
  87
  88
  89
  90 void clrscr (void);
  91 /* Clear the whole screen and put the cursor into the top left corner */
  92
  93 unsigned char kbhit (void);
  94 /* Return true if there's a key waiting, return false if not */
  95
  96 void __fastcall__ gotox (unsigned char x);
  97 /* Set the cursor to the specified X position, leave the Y position untouched */
  98
  99 void __fastcall__ gotoy (unsigned char y);
 100 /* Set the cursor to the specified Y position, leave the X position untouched */
 101
 102 void __fastcall__ gotoxy (unsigned char x, unsigned char y);
 103 /* Set the cursor to the specified position */
 104
 105 unsigned char wherex (void);
 106 /* Return the X position of the cursor */
 107
 108 unsigned char wherey (void);
 109 /* Return the Y position of the cursor */
 110
 111 void __fastcall__ cputc (char c);
 112 /* Output one character at the current cursor position */
 113
 114 void __fastcall__ cputcxy (unsigned char x, unsigned char y, char c);
 115 /* Same as "gotoxy (x, y); cputc (c);" */
 116
 117 void __fastcall__ cputs (const char* s);
 118 /* Output a NUL-terminated string at the current cursor position */
 119
 120 void __fastcall__ cputsxy (unsigned char x, unsigned char y, const char* s);
 121 /* Same as "gotoxy (x, y); puts (s);" */
 122
 123 int cprintf (const char* format, ...);
 124 /* Like printf(), but uses direct screen output */
 125
 126 int __fastcall__ vcprintf (const char* format, va_list ap);
 127 /* Like vprintf(), but uses direct screen output */
 128
 129 char cgetc (void);
 130 /* Return a character from the keyboard. If there is no character available,
 131  * the function waits until the user does press a key. If cursor is set to
 132  * 1 (see below), a blinking cursor is displayed while waiting.
 133  */
 134
 135 int cscanf (const char* format, ...);
 136 /* Like scanf(), but uses direct keyboard input */
 137
 138 int __fastcall__ vcscanf (const char* format, va_list ap);
 139 /* Like vscanf(), but uses direct keyboard input */
 140
 141 unsigned char __fastcall__ cursor (unsigned char onoff);
 142 /* If onoff is 1, a cursor is displayed when waiting for keyboard input. If
 143  * onoff is 0, the cursor is hidden when waiting for keyboard input. The
 144  * function returns the old cursor setting.
 145  */
 146
 147 unsigned char __fastcall__ revers (unsigned char onoff);
 148 /* Enable/disable reverse character display. This may not be supported by
 149  * the output device. Return the old setting.
 150  */
 151
 152 unsigned char __fastcall__ textcolor (unsigned char color);
 153 /* Set the color for text output. The old color setting is returned. */
 154
 155 unsigned char __fastcall__ bgcolor (unsigned char color);
 156 /* Set the color for the background. The old color setting is returned. */
 157
 158 unsigned char __fastcall__ bordercolor (unsigned char color);
 159 /* Set the color for the border. The old color setting is returned. */
 160
 161 void __fastcall__ chline (unsigned char length);
 162 /* Output a horizontal line with the given length starting at the current
 163  * cursor position.
 164  */
 165
 166 void __fastcall__ chlinexy (unsigned char x, unsigned char y, unsigned char length);
 167 /* Same as "gotoxy (x, y); chline (length);" */
 168
 169 void __fastcall__ cvline (unsigned char length);
 170 /* Output a vertical line with the given length at the current cursor
 171  * position.
 172  */
 173
 174 void __fastcall__ cvlinexy (unsigned char x, unsigned char y, unsigned char length);
 175 /* Same as "gotoxy (x, y); cvline (length);" */
 176
 177 void __fastcall__ cclear (unsigned char length);
 178 /* Clear part of a line (write length spaces). */
 179
 180 void __fastcall__ cclearxy (unsigned char x, unsigned char y, unsigned char length);
 181 /* Same as "gotoxy (x, y); cclear (length);" */
 182
 183 void __fastcall__ screensize (unsigned char* x, unsigned char* y);
 184 /* Return the current screen size. */
 185
 186 void __fastcall__ cputhex8 (unsigned char val);
 187 void __fastcall__ cputhex16 (unsigned val);
 188 /* These shouldn't be here... */
 189
 190
 191
 192 /*****************************************************************************/
 193 /*                                  Macros                                   */
 194 /*****************************************************************************/
 195
 196
 197
 198 /* On some platforms, functions are not available or are dummys. To suppress
 199  * the call to these functions completely, the platform header files may
 200  * define macros for these functions that start with an underline. If such a
 201  * macro exists, a new macro is defined here, that expands to the one with the
 202  * underline. The reason for this two stepped approach is that it is sometimes
 203  * necessary to take the address of the function, which is not possible when
 204  * using a macro. Since the function prototype is still present, #undefining
 205  * the macro will give access to the actual function.
 206  */
 207
 208 #if defined(_textcolor)
 209 #  define textcolor(x)          _textcolor(x)
 210 #endif
 211 #if defined(_bgcolor)
 212 #  define bgcolor(x)            _bgcolor(x)
 213 #endif
 214 #if defined(_bordercolor)
 215 #  define bordercolor(x)        _bordercolor(x)
 216 #endif
 217
 218
 219
 220 /* End of conio.h */
 221 #endif
 222
 223
 224