]> git.sur5r.net Git - cc65/blob - include/cbm.h
Moved CH_ESC back to cbm.h
[cc65] / include / cbm.h
1 /*****************************************************************************/
2 /*                                                                           */
3 /*                                   cbm.h                                   */
4 /*                                                                           */
5 /*                      CBM system specific definitions                      */
6 /*                                                                           */
7 /*                                                                           */
8 /*                                                                           */
9 /* (C) 1998-2002 Ullrich von Bassewitz                                       */
10 /*               Wacholderweg 14                                             */
11 /*               D-70597 Stuttgart                                           */
12 /* EMail:        uz@musoftware.de                                            */
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 #ifndef _CBM_H
37 #define _CBM_H
38
39
40
41 /* Check for errors */
42 #if !defined(__CBM__)
43 #  error This module may only be used when compiling for CBM machines!
44 #endif
45
46
47
48 /* Load the system specific files here, if needed */
49 #if defined(__C64__) && !defined(_C64_H)
50 #  include <c64.h>
51 #elif defined(__VIC20__) && !defined(_VIC20_H)
52 #  include <vic20.h>
53 #elif defined(__C128__) && !defined(_C128_H)
54 #  include <c128.h>
55 #elif defined(__PLUS4__) && !defined(_PLUS4_H)
56 #  include <plus4.h>
57 #elif defined(__C16__) && !defined(_C16_H)
58 #  include <c16.h>
59 #elif defined(__CBM510__) && !defined(_CBM510_H)
60 #  include <cbm510.h>
61 #elif defined(__CBM610__) && !defined(_CBM610_H)
62 #  include <cbm610.h>
63 #elif defined(__PET__) && !defined(_PET_H)
64 #  include <pet.h>
65 #endif
66
67
68
69 /*****************************************************************************/
70 /*                                 Variables                                 */
71 /*****************************************************************************/
72
73
74
75 /* The file stream implementation and the POSIX I/O functions will use the
76  * following variables to determine the file type and the disk unit to use.
77  */
78 extern unsigned char _curunit;          /* Default 8 */
79 extern unsigned char _filetype;         /* Default 'u' */
80
81
82
83 /*****************************************************************************/
84 /*                      Characters codes (CBM charset)                       */
85 /*****************************************************************************/
86
87
88
89 #define CH_HLINE                 96
90 #define CH_VLINE                125
91 #define CH_ULCORNER             176
92 #define CH_URCORNER             174
93 #define CH_LLCORNER             173
94 #define CH_LRCORNER             189
95 #define CH_TTEE                 178
96 #define CH_RTEE                 179
97 #define CH_BTEE                 177
98 #define CH_LTEE                 171
99 #define CH_CROSS                123
100 #define CH_CURS_UP              145
101 #define CH_CURS_DOWN             17
102 #define CH_CURS_LEFT            157
103 #define CH_CURS_RIGHT            29
104 #define CH_PI                   126
105 #define CH_DEL                   20
106 #define CH_INS                  148
107 #define CH_ENTER                '\n'
108 #define CH_STOP                   3
109 #define CH_ESC                   27
110
111
112
113 /*****************************************************************************/
114 /*                               Machine info                                */
115 /*****************************************************************************/
116
117
118
119 #if defined(__C16__) || defined(__C64__) || defined(__C128__) || defined(__PLUS4__)
120
121 #define TV_NTSC 0
122 #define TV_PAL  1
123
124 unsigned char __fastcall__ get_tv (void);
125 /* Return the video mode the machine is using */
126
127 #endif
128
129
130
131 /*****************************************************************************/
132 /*                           CBM kernal functions                            */
133 /*****************************************************************************/
134
135
136
137 /* Constants to use with cbm_open() for opening a file for reading or
138  * writing without the need to append ",r" or ",w" to the filename.
139  *
140  * e.g.: cbm_open(2, 8, CBM_READ, "data,s");
141  */
142 #define CBM_READ    0
143 #define CBM_WRITE   1
144
145 /* Kernel level functions */
146 void __fastcall__ cbm_k_setlfs (unsigned char LFN, unsigned char DEV,
147                                 unsigned char SA);
148 void __fastcall__ cbm_k_setnam (const char* Name);
149 unsigned int __fastcall__ cbm_k_load(unsigned char flag, unsigned addr);
150 unsigned char __fastcall__ cbm_k_save(unsigned int start, unsigned int end);
151 unsigned char __fastcall__ cbm_k_open (void);
152 void __fastcall__ cbm_k_close (unsigned char FN);
153 unsigned char __fastcall__ cbm_k_readst (void);
154 unsigned char __fastcall__ cbm_k_chkin (unsigned char FN);
155 unsigned char __fastcall__ cbm_k_ckout (unsigned char FN);
156 unsigned char __fastcall__ cbm_k_basin (void);
157 void __fastcall__ cbm_k_bsout (unsigned char C);
158 void __fastcall__ cbm_k_clrch (void);
159
160
161
162 /*****************************************************************************/
163 /*                       BASIC-like file I/O functions                       */
164 /*****************************************************************************/
165
166
167
168 /* All cbm_* IO functions set _oserror (see errno.h) in case of an
169  * error.
170  *
171  * errorcode    BASIC error
172  *      1   =   too many files
173  *      2   =   file open
174  *      3   =   file not open
175  *      4   =   file not found
176  *      5   =   device not present
177  *      6   =   not input file
178  *      7   =   not output file
179  *      8   =   missing filename
180  *      9   =   illegal device number
181  */
182
183
184
185 unsigned int cbm_load (const char* name, unsigned char device, void* data);
186 /* Loads file "name" from given device to given address or to the load
187  * address of the file if "data" is the null pointer (like load"name",8,1
188  * in BASIC).
189  * Returns number of bytes that where loaded if loading was successful
190  * otherwise 0. "_oserror" contains an errorcode then (see table below).
191  */
192
193 unsigned char cbm_save (const char* name, unsigned char device,
194                         const void* data, unsigned int size);
195 /* Saves "size" bytes starting at "data" to a file.
196  * Returns 0 if saving was successful, otherwise an errorcode (see table
197  * below).
198  */
199
200 unsigned char __fastcall__ cbm_open (unsigned char lfn,
201                                      unsigned char device,
202                                      unsigned char sec_addr,
203                                      const char* name);
204 /* Opens a file. Works just like the BASIC command.
205  * Returns 0 if opening was successful, otherwise an errorcode (see table
206  * below).
207  */
208
209 void __fastcall__ cbm_close (unsigned char lfn);
210 /* Closes a file */
211
212 int __fastcall__ cbm_read (unsigned char lfn, void* buffer, unsigned int size);
213 /* Reads up to "size" bytes from a file to "buffer".
214  * Returns the number of actually read bytes, 0 if there are no bytes left
215  * (EOF) or -1 in case of an error. _oserror contains an errorcode then (see
216  * table below).
217  */
218
219 int __fastcall__ cbm_write (unsigned char lfn, void* buffer, unsigned int size);
220 /* Writes up to "size" bytes from "buffer" to a file.
221  * Returns the number of actually written bytes or -1 in case of an error.
222  * _oserror contains an errorcode then (see table below).
223  */
224
225
226
227
228 /* End of cbm.h */
229 #endif
230
231