1 <!doctype linuxdoc system>
5 <title>cc65 Library Overview
6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
10 An overview over the runtime and C libraries that come with the cc65 compiler,
11 including a discussion of the differences to the ISO standard.
14 <!-- Table of contents -->
17 <!-- Begin the document -->
21 This file contains a description of the library routines available for the
22 cc65 C compiler. It is not complete in some areas, so if you miss something,
23 have a look into the header files. All functions, that are not defined by the
24 ISO C standard have a short comment in the headers, explaining their use.
28 <sect>ISO C compatible library<p>
30 The C library contains a large subset of the ISO C library. Functions are
31 usually missing in areas, where there is no support on typical 6502 systems.
32 Wide character sets are an example for this.
34 I will not go into detail about the ISO functions. If a function is not
35 mentioned here explicitly, expect it to be available and to behave as defined
38 Functions that are NOT available:
42 <item>ftell/fseek/fgetpos/fsetpos
46 <item>The scanf family of functions
48 <item>time/asctime/ctime/difftime/asctime/gmtime/localtime/mktime/strftime
52 <item>All functions that handle floating point numbers in some manner.
54 <item>The div and ldiv functions (because cc65 is not able to return
57 <item>All functions handling wide character strings.
59 <item>Signals and all related functions (having SIGSEGV would be cool:-)
61 <item>rename/remove/rewind
63 <item>setbuf/setvbuf/ungetc
67 Functions that are limited in any way:
71 <item>fopen/fread/fwrite/fclose/fputs/fgets/fscanf....
73 These functions are built on open/read/write/close. Neither of these low
74 level functions is currently available for the supported systems, and so,
75 fopen and friends do not work. However, the functions exist and are tested
76 to some degree under the ACE operating systems (which is no longer
80 <item>strcspn/strpbrk/strspn
82 These functions have a length limitation of 256 for the second string
83 argument. Since this string gives a character set, and there are only 256
84 distinct characters, this shouldn't be a problem.
89 Since there is no such thing as an environment on all supported systems, the
90 getenv function will always return a NULL pointer.
95 There is no other locale than the "C" locale. The native locale is identical
101 In addition to these limitations, some more functions are limited if inlined
102 versions are requested by using -Os:
106 <item>The strlen function only works for strings with a maximum length of
109 <item>The isxxx character classification functions from <tt/<ctype.h>/
110 will give unpredictable results if the argument is not in character range
111 (0..255). This limitation may be removed by #undef'ing the function name
112 (when using -Os, the functions are actually macros that expand to inline
113 assembler code, but the real functions are still available if the macro
114 definition is removed).
120 <sect>CPU specific stuff - 6502.h<p>
122 The header file 6502.h contains some functions that make only sense with the
123 6502 CPU. Examples are macros to insert more or less useful instructions into
124 your C code, or a function to call arbitrary machine language subroutines,
125 passing registers in and out.
129 <sect>Target specific stuff<p>
131 For each supported system there's a header file that contains calls or defines
132 specific for this system. So, when programming for the C64, include c64.h, for
133 the C128, include c128.h and so on. To make the task for the Commodore systems
134 easier, there is also a header file named cbm.h that will define stuff common
135 for all CBM systems, and include the header file for the specific target
138 The header files contain
142 <item>Defines for special keys (like function keys)
144 <item>Defines for special characters (like the graphics characters)
146 <item>Variables with a fixed address in memory that may be used to access
147 special hardware. For the C64 and C128 there is a variable struct named
148 <tt/SID/. Writing to the fields of this struct will write to the SID device
149 instead. Using these variables will make your program more readable and more
150 portable. Don't fear ineffective code when using these variables, the
151 compiler will translate reads and writes to these structs into direct memory
154 <item>Other routines that make only sense for a specific system. One example
155 are routines to write memory locations in the system bank for the CBM
156 600/700 family (called B128/B256 in the US).
161 <sect>Direct console I/O - <tt/conio.h/<p>
163 The <tt/conio.h/ header file contains a large set of functions that do screen
164 and keyboard I/O. The functions will write directly to the screen or poll the
165 keyboard directly with no more help from the operating system than needed.
166 This has some disadvantages, but on the other side it's fast and reasonably
167 portable. conio implementations exist for the following targets:
174 <item>cbm610 (all CBM series-II computers with 80 column video)
175 <item>pet (all CBM PET systems except the 2001)
179 The conio.h header file does also include the system specific header files
180 which define constants for special characters and keys.
184 <sect>Using the joystick - <tt/joystick.h/<p>
186 For systems that have a joystick, <tt/joystick.h/ will define a subroutine to
187 read the current value, including constants to evaluate the result of this
188 function. To help in writing portable code, the header file will define the
189 symbol <tt/__JOYSTICK__/ on systems that have a joystick.
193 <sect>Using a mouse - <tt/mouse.h/<p>
195 Some target machines support a mouse. Mouse support is currently in beta and
196 available for the following targets:
203 The available functions are declared in <tt/mouse.h/ To help writing portable
204 code, the header file will define the symbol <tt/__MOUSE__/ in systems that
208 <sect>Bugs/Feedback<p>
210 If you have problems using the library, if you find any bugs, or if you're
211 doing something interesting with it, I would be glad to hear from you. Feel
212 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
213 name="uz@cc65.org">).
219 This C runtime library implementation for the cc65 compiler is (C)
220 Copyright 1998-1999 Ullrich von Bassewitz. For usage of the binaries
221 and/or sources the following conditions do apply:
223 This software is provided 'as-is', without any expressed or implied
224 warranty. In no event will the authors be held liable for any damages
225 arising from the use of this software.
227 Permission is granted to anyone to use this software for any purpose,
228 including commercial applications, and to alter it and redistribute it
229 freely, subject to the following restrictions:
232 <item> The origin of this software must not be misrepresented; you must not
233 claim that you wrote the original software. If you use this software
234 in a product, an acknowledgment in the product documentation would be
235 appreciated but is not required.
236 <item> Altered source versions must be plainly marked as such, and must not
237 be misrepresented as being the original software.
238 <item> This notice may not be removed or altered from any source