]> git.sur5r.net Git - cc65/blob - include/cbm.h
completed and testet cbm_read()
[cc65] / include / cbm.h
1 /*****************************************************************************/
2 /*                                                                           */
3 /*                                   cbm.h                                   */
4 /*                                                                           */
5 /*                      CBM system specific definitions                      */
6 /*                                                                           */
7 /*                                                                           */
8 /*                                                                           */
9 /* (C) 1998-2000 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 /* Load the system specific files here, if needed */
42 #ifdef __C64__
43 #ifndef _C64_H
44 #include <c64.h>
45 #endif
46 #endif
47
48 #ifdef __C128__
49 #ifndef _C128_H
50 #include <c128.h>
51 #endif
52 #endif
53
54 #ifdef __PLUS4__
55 #ifndef _PLUS4_H
56 #include <plus4.h>
57 #endif
58 #endif
59
60 #ifdef __CBM610__
61 #ifndef _CBM610_H
62 #include <cbm610.h>
63 #endif
64 #endif
65
66 #ifdef __PET__
67 #ifndef _PET_H
68 #include <pet.h>
69 #endif
70 #endif
71
72
73
74 /* Characters codes (CBM charset) */
75 #define CH_HLINE                 96
76 #define CH_VLINE                125
77 #define CH_ULCORNER             176
78 #define CH_URCORNER             174
79 #define CH_LLCORNER             173
80 #define CH_LRCORNER             189
81 #define CH_TTEE                 178
82 #define CH_RTEE                 179
83 #define CH_BTEE                 177
84 #define CH_LTEE                 171
85 #define CH_CROSS                123
86 #define CH_CURS_UP              145
87 #define CH_CURS_DOWN             17
88 #define CH_CURS_LEFT            157
89 #define CH_CURS_RIGHT            29
90 #define CH_PI                   126
91 #define CH_DEL                   20
92 #define CH_INS                  148
93 #define CH_ESC                   95
94
95
96
97 /* Kernel level functions */
98 void __fastcall__ cbm_k_setlfs (unsigned char LFN, unsigned char DEV,
99                                 unsigned char SA);
100 void __fastcall__ cbm_k_setnam (const char* Name);
101 unsigned char __fastcall__ cbm_k_load(unsigned char flag, unsigned addr);
102 unsigned char __fastcall__ cbm_k_save(unsigned int start, unsigned int end);
103 unsigned char __fastcall__ cbm_k_open (void);
104 void __fastcall__ cbm_k_close (unsigned char FN);
105 unsigned char __fastcall__ cbm_k_readst (void);
106 unsigned char __fastcall__ cbm_k_chkin (unsigned char FN);
107 unsigned char __fastcall__ cbm_k_basin (void);
108 void __fastcall__ cbm_k_clrch (void);
109
110 /* BASIC-like functions */
111 unsigned char cbm_load(const char* name, unsigned char device, unsigned int addr);
112 /* Loads file "name" from given device to given address or to the load address
113  * of the file if addr is 0 (like load"name",8,1 in BASIC)
114  * Returns 0 if loading was successful otherwise an errorcode (see table below).
115  */
116
117 unsigned char cbm_save(const char* name, unsigned char device,
118                       unsigned int start, unsigned int end);
119 /* Saves a memory area from start to end-1 to a file.
120  * Returns 0 if saving was successful, otherwise an errorcode (see table below).
121  */
122
123 unsigned char cbm_open(unsigned char lfn, unsigned char device,
124                        unsigned char sec_addr, const char* name);
125 /* Opens a file. Works just like the BASIC command.
126  * Returns 0 if opening was successful, otherwise an errorcode (see table below).
127  */
128
129 void __fastcall__ cbm_close (unsigned char lfn);
130 /* Closes a file */
131
132 int cbm_read(unsigned char lfn, void* buffer, unsigned int size);
133 /* Reads up to "size" bytes from a file to "buffer".
134  * Returns the number of actually read bytes, 0 if there are no bytes left (EOF)
135  * or -1 in case of an error. _oserror contains an errorcode then (see table below).
136  */
137
138 /* Errorcodes of cbm_* I/O functions:
139  *
140  * errorcode    BASIC error
141  *      1   =   too many files
142  *      2   =   file open
143  *      3   =   file not open
144  *      4   =   file not found
145  *      5   =   device not present
146  *      6   =   not input file
147  *      7   =   not output file
148  *      8   =   missing filename
149  *      9   =   illegal device number
150  */
151
152 /* End of cbm.h */
153 #endif