]> git.sur5r.net Git - cc65/blob - doc/library.sgml
add "invalid parameter" error code -- contributed by Stefan Haubenthal
[cc65] / doc / library.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <title>cc65 Library Overview
6 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
7 <date>2000-12-02, 2002-11-26
8
9 <abstract>
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.
12 </abstract>
13
14 <!-- Table of contents -->
15 <toc>
16
17 <!-- Begin the document -->
18
19 <sect>Overview<p>
20
21 This file contains a short overview of the libraries available for the cc65 C
22 compiler. Please have a look at the <htmlurl url="funcref.html" name="function
23 reference"> for a list function by function. Since the function reference is
24 not complete (I'm working on that) it may happen that you don't find a
25 specific function. In this case, have a look into the header files. All
26 functions, that are not defined by the ISO C standard have a short comment in
27 the headers, explaining their use.
28
29
30
31 <sect>ISO C compatible library<p>
32
33 The C library contains a large subset of the ISO C library. Functions are
34 usually missing in areas, where there is no support on typical 6502 systems.
35 Wide character sets are an example for this.
36
37 I will not go into detail about the ISO functions. If a function is not
38 mentioned here explicitly, expect it to be available and to behave as defined
39 in the C standard.
40
41 Functions that are <em/not/ available:
42
43 <itemize>
44   <item><tt>tmpfile/tmpnam</tt>
45   <p>
46   <item><tt>system</tt>
47   <p>
48   <item>All functions that handle floating point numbers in some manner.
49   <p>
50   <item>The <tt/ldiv/ function (cc65 is currently not able to return structs
51   with a size not equal to 1, 2 or 4 bytes by value).
52   <p>
53   <item>All functions handling wide character strings.
54   <p>
55   <item>Signals and all related functions (having <tt/SIGSEGV/ would be
56   cool:-)
57   <p>
58   <item><tt>setbuf/setvbuf</tt>
59 </itemize>
60
61 Functions not available on all supported systems:
62
63 <itemize>
64   <item><tt>fopen/fread/fwrite/fclose/fputs/fgets/fscanf</tt>: The functions
65   are built on open/read/write/close. These latter functions are not available
66   on all systems.
67   <p>
68   <item><tt>ftell/fseek/fgetpos/fsetpos</tt>: Support depends on the
69   capabilities of the target machine.
70   <p>
71   <item><tt>rename/remove/rewind</tt>: Support depends on the capabilities of
72   the target machine.
73   <p>
74   <item><tt>time</tt>: Since many of the supported systems do not have a real
75   time clock, which means that the <tt/time/ function is not available. Please
76   note that the other functions from <tt/time.h/ <em/are/ available.
77 </itemize>
78
79
80 Functions that are limited in any way:
81
82 <itemize>
83   <item><tt>strcspn/strpbrk/strspn</tt>: These functions have a length
84   limitation of 256 for the second string argument. Since this string gives a
85   character set, and there are only 256 distinct characters, this shouldn't be
86   a problem.
87   <p>
88   <item><tt>getenv</tt>: Since there is no such thing as an environment on all
89   supported systems, the <tt/getenv/ function will always return a <tt/NULL/
90   pointer.
91   <p>
92   <item><tt>locale</tt>: There is no other locale than the "C" locale. The
93   native locale is identical to the "C" locale.
94 </itemize>
95
96
97 In addition to these limitations, some more functions are limited if inlined
98 versions are requested by using -Os:
99
100 <itemize>
101   <item>The <tt/strlen/ function only works for strings with a maximum length
102   of 255 characters.
103   <p>
104   <item>The <tt/isxxx/ character classification functions from
105   <tt/&lt;ctype.h&gt;/ will give unpredictable results if the argument is not
106   in character range (0..255). This limitation may be removed by #undef'ing
107   the function name (when using <tt/-Os/, the functions are actually macros
108   that expand to inline assembler code, but the real functions are still
109   available if the macro definition is removed).
110 </itemize>
111
112
113
114 <sect>CPU specific stuff - 6502.h<p>
115
116 The header file 6502.h contains some functions that make only sense with the
117 6502 CPU. Examples are macros to insert more or less useful instructions into
118 your C code, or a function to call arbitrary machine language subroutines,
119 passing registers in and out.
120
121
122
123 <sect>Target specific stuff<p>
124
125 For each supported system there's a header file that contains calls or defines
126 specific for this system. So, when programming for the C64, include c64.h, for
127 the C128, include c128.h and so on. To make the task for the Commodore systems
128 easier, there is also a header file named cbm.h that will define stuff common
129 for all CBM systems, and include the header file for the specific target
130 system.
131
132 The header files contain
133
134 <itemize>
135
136   <item>Defines for special keys (like function keys)
137
138   <item>Defines for special characters (like the graphics characters)
139
140   <item>Variables with a fixed address in memory that may be used to access
141   special hardware. For the C64 and C128 there is a variable struct named
142   <tt/SID/. Writing to the fields of this struct will write to the SID device
143   instead. Using these variables will make your program more readable and more
144   portable. Don't fear ineffective code when using these variables, the
145   compiler will translate reads and writes to these structs into direct memory
146   accesses.
147
148   <item>Other routines that make only sense for a specific system. One example
149   are routines to write memory locations in the system bank for the CBM PET-II
150   family.
151
152 </itemize>
153
154
155 <sect>Direct console I/O - <tt/conio.h/<p>
156
157 The <tt/conio.h/ header file contains a large set of functions that do screen
158 and keyboard I/O. The functions will write directly to the screen or poll the
159 keyboard directly with no more help from the operating system than needed.
160 This has some disadvantages, but on the other side it's fast and reasonably
161 portable. conio implementations exist for the following targets:
162
163   <itemize>
164   <item>apple2
165   <item>apple2enh
166   <item>atari
167   <item>atmos
168   <item>c16 (works also for the c116 with up to 32K memory)
169   <item>c64
170   <item>c128
171   <item>plus4 (or expanded c16/c116)
172   <item>cbm510 (40 column video)
173   <item>cbm610 (all CBM series-II computers with 80 column video)
174   <item>geos-apple
175   <item>geos-cbm
176   <item>nes
177   <item>pet (all CBM PET systems except the 2001)
178   <item>vic20
179   </itemize>
180
181 The conio.h header file does also include the system specific header files
182 which define constants for special characters and keys.
183
184
185
186 <sect>Using the joystick - <tt/joystick.h/<p>
187
188 For systems that have a joystick, <tt/joystick.h/ will define a subroutine to
189 read the current value, including constants to evaluate the result of this
190 function. To help in writing portable code, the header file will define the
191 symbol <tt/__JOYSTICK__/ on systems that have a joystick.
192
193
194
195 <sect>Using a mouse - <tt/mouse.h/<p>
196
197 Some target machines support a mouse. Mouse support is currently available for
198 the following targets:
199
200   <itemize>
201   <item>apple2
202   <item>apple2enh
203   <item>atari
204   <item>c64
205   <item>c128
206   <item>cbm510
207   </itemize>
208
209 The available functions are declared in <tt/mouse.h/ To help writing portable
210 code, the header file will define the symbol <tt/__MOUSE__/ in systems that
211 support a mouse.
212
213
214 <sect>Bugs/Feedback<p>
215
216 If you have problems using the library, if you find any bugs, or if you're
217 doing something interesting with it, I would be glad to hear from you. Feel
218 free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
219 name="uz@cc65.org">).
220
221
222
223 <sect>Copyright<p>
224
225 This C runtime library implementation for the cc65 compiler is (C)
226 Copyright 1998-2002 Ullrich von Bassewitz. For usage of the binaries
227 and/or sources the following conditions do apply:
228
229 This software is provided 'as-is', without any expressed or implied
230 warranty.  In no event will the authors be held liable for any damages
231 arising from the use of this software.
232
233 Permission is granted to anyone to use this software for any purpose,
234 including commercial applications, and to alter it and redistribute it
235 freely, subject to the following restrictions:
236
237 <enum>
238 <item>  The origin of this software must not be misrepresented; you must not
239         claim that you wrote the original software. If you use this software
240         in a product, an acknowledgment in the product documentation would be
241         appreciated but is not required.
242 <item>  Altered source versions must be plainly marked as such, and must not
243         be misrepresented as being the original software.
244 <item>  This notice may not be removed or altered from any source
245         distribution.
246 </enum>
247
248 </article>
249
250
251