]> git.sur5r.net Git - cc65/blob - doc/cc65.sgml
Correct missed doc label
[cc65] / doc / cc65.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4 <title>cc65 Users Guide
5 <author><url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
6 <url url="mailto:gregdk@users.sf.net" name="Greg King">
7 <date>2017-03-21
8
9 <abstract>
10 cc65 is a C compiler for 6502 targets. It supports several 6502 based home
11 computers like the Commodore and Atari machines, but it is easily retargetable.
12 </abstract>
13
14 <!-- Table of contents -->
15 <toc>
16
17 <!-- Begin the document -->
18
19 <sect>Overview<p>
20
21 cc65 was originally a C compiler for the Atari 8-bit machines written by
22 John R. Dunning. In prior releases I've described the compiler by listing
23 up the changes made by me. I have made many more changes in the meantime
24 (and rewritten major parts of the compiler), so I will no longer do that,
25 since the list would be too large and of no use to anyone. Instead I will
26 describe the compiler in respect to the ANSI/ISO C standard.
27
28 There are separate documents named <url url="library.html"> and <url
29 url="funcref.html"> that cover the library that is available for the compiler.
30 If you know C, and are interested in doing actual programming, the library
31 documentation is probably of much more use than this document.
32
33 If you need some hints for getting the best code out of the compiler, you
34 may have a look at <url url="coding.html"> which covers some code generation
35 issues.
36
37
38
39 <sect>Usage<p>
40
41 The compiler translates C files into files containing assembly code that
42 may be translated by the ca65 macroassembler (for more information about
43 the assembler, have a look at <url url="ca65.html">).
44
45
46 <sect1>Command line option overview<p>
47
48 The compiler may be called as follows:
49
50 <tscreen><verb>
51 ---------------------------------------------------------------------------
52 Usage: cc65 [options] file
53 Short options:
54   -Cl                           Make local variables static
55   -Dsym[=defn]                  Define a symbol
56   -E                            Stop after the preprocessing stage
57   -I dir                        Set an include directory search path
58   -O                            Optimize code
59   -Oi                           Optimize code, inline more code
60   -Or                           Enable register variables
61   -Os                           Inline some standard functions
62   -T                            Include source as comment
63   -V                            Print the compiler version number
64   -W warning[,...]              Suppress warnings
65   -d                            Debug mode
66   -g                            Add debug info to object file
67   -h                            Help (this text)
68   -j                            Default characters are signed
69   -mm model                     Set the memory model
70   -o name                       Name the output file
71   -r                            Enable register variables
72   -t sys                        Set the target system
73   -v                            Increase verbosity
74
75 Long options:
76   --add-source                  Include source as comment
77   --all-cdecl                   Make functions default to __cdecl__
78   --bss-name seg                Set the name of the BSS segment
79   --check-stack                 Generate stack overflow checks
80   --code-name seg               Set the name of the CODE segment
81   --codesize x                  Accept larger code by factor x
82   --cpu type                    Set cpu type (6502, 65c02)
83   --create-dep name             Create a make dependency file
84   --create-full-dep name        Create a full make dependency file
85   --data-name seg               Set the name of the DATA segment
86   --debug                       Debug mode
87   --debug-info                  Add debug info to object file
88   --debug-opt name              Debug optimization steps
89   --dep-target target           Use this dependency target
90   --disable-opt name            Disable an optimization step
91   --eagerly-inline-funcs        Eagerly inline some known functions
92   --enable-opt name             Enable an optimization step
93   --help                        Help (this text)
94   --include-dir dir             Set an include directory search path
95   --inline-stdfuncs             Inline some standard functions
96   --list-opt-steps              List all optimizer steps and exit
97   --list-warnings               List available warning types for -W
98   --local-strings               Emit string literals immediately
99   --memory-model model          Set the memory model
100   --register-space b            Set space available for register variables
101   --register-vars               Enable register variables
102   --rodata-name seg             Set the name of the RODATA segment
103   --signed-chars                Default characters are signed
104   --standard std                Language standard (c89, c99, cc65)
105   --static-locals               Make local variables static
106   --target sys                  Set the target system
107   --verbose                     Increase verbosity
108   --version                     Print the compiler version number
109   --writable-strings            Make string literals writable
110 ---------------------------------------------------------------------------
111 </verb></tscreen>
112
113
114 <sect1>Command line options in detail<p>
115
116 Here is a description of all the command line options:
117
118 <descrip>
119
120   <tag><tt>--all-cdecl</tt></tag>
121
122   Tells the compiler that functions which aren't declared explicitly with
123   either the <tt/__cdecl__/ or <tt/__fastcall__/ calling conventions should
124   have the cdecl convention.  (Normally, functions that aren't variadic are
125   fast-called.)
126
127
128   <label id="option-bss-name">
129   <tag><tt>--bss-name seg</tt></tag>
130
131   Set the name of the bss segment. See also <tt/<ref id="pragma-bss-name"
132   name="#pragma&nbsp;bss-name">/.
133
134
135   <label id="option-check-stack">
136   <tag><tt>--check-stack</tt></tag>
137
138   Tells the compiler to generate code that checks for stack overflows. See
139   <tt/<ref id="pragma-check-stack" name="#pragma&nbsp;check-stack">/ for an
140   explanation of this feature.
141
142
143   <label id="option-code-name">
144   <tag><tt>--code-name seg</tt></tag>
145
146   Set the name of the code segment. See also <tt/<ref id="pragma-code-name"
147   name="#pragma&nbsp;code-name">/
148
149
150   <label id="option-codesize">
151   <tag><tt>--codesize x</tt></tag>
152
153   This options allows finer control about speed vs. size decisions in the code
154   generation and optimization phases. It gives the allowed size increase
155   factor (in percent). The default is 100 when not using <tt/-Oi/ and 200 when
156   using <tt/-Oi/ (<tt/-Oi/ is the same as <tt/-O --codesize&nbsp;200/).
157
158
159   <label id="option--cpu">
160   <tag><tt>--cpu CPU</tt></tag>
161
162   Set the CPU, the compiler generates code for. You may specify "6502" or
163   "65C02" as the CPU. The default depends on the selected target (see option
164   <tt/<ref id="option-t" name="-t">/). It is the 6502 CPU for most targets or
165   if no target has been set. Specifying 65C02 will use a few 65C02
166   instructions when generating code. Don't expect too much from this option:
167   In most cases the difference in size and speed is just 1-2%.
168
169
170   <label id="option-create-dep">
171   <tag><tt>--create-dep name</tt></tag>
172
173   Tells the compiler to generate a file containing the dependency list for the
174   compiled module in makefile syntax. The output is written to a file with the
175   given name. The output does not include system include files (in angle
176   brackets).
177
178
179   <label id="option-create-full-dep">
180   <tag><tt>--create-full-dep name</tt></tag>
181
182   Tells the compiler to generate a file containing the dependency list for the
183   compiled module in makefile syntax. The output is written to a file with the
184   given name. The output does include system include files (in angle
185   brackets).
186
187
188   <label id="option-data-name">
189   <tag><tt>--data-name seg</tt></tag>
190
191   Set the name of the data segment. See also <tt/<ref id="pragma-data-name"
192   name="#pragma&nbsp;data-name">/
193
194
195   <tag><tt>-d, --debug</tt></tag>
196
197   Enables debug mode, something that should not be needed for mere
198   mortals:-)
199
200
201   <label id="option-dep-target">
202   <tag><tt>--dep-target target</tt></tag>
203
204   When generating a dependency file, don't use the actual output file as the
205   target of the dependency, but the file specified with this option. The
206   option has no effect if neither <tt/<ref id="option-create-dep"
207   name="--create-dep">/ nor <tt/<ref id="option-create-full-dep"
208   name="--create-full-dep">/ is specified.
209
210
211   <tag><tt>-D sym[=definition]</tt></tag>
212
213   Define a macro on the command line. If no definition is given, the macro
214   is defined to the value "1".
215
216
217   <tag><tt>-g, --debug-info</tt></tag>
218
219   This will cause the compiler to insert a <tt/.DEBUGINFO/ command into the
220   generated assembler code. This will cause the assembler to include all
221   symbols in a special section in the object file.
222
223
224   <label id="option-eagerly-inline-funcs">
225   <tag><tt>--eagerly-inline-funcs</tt></tag>
226
227   Have the compiler eagerly inline these functions from the C library:
228   <itemize>
229   <item><tt/memcpy()/
230   <item><tt/memset()/
231   <item><tt/strcmp()/
232   <item><tt/strcpy()/
233   <item><tt/strlen()/
234   <item>most of the functions declared in <tt/&lt;ctype.h&gt;/
235   </itemize>
236
237   Note: This has two consequences:
238   <itemize>
239   <item>You may not use names of standard C functions for your own functions.
240         If you do that, your program is not standard-compliant anyway; but,
241         using <tt/--eagerly-inline-funcs/ actually will break things.
242         <p>
243   <item>The inlined string and memory functions will not handle strings or
244         memory areas larger than 255 bytes.  Similarly, the inlined <tt/is..()/
245         functions will not work with values outside the char. range (such as
246         <tt/EOF/).
247         <p>
248   </itemize>
249
250   <tt/--eagerly-inline-funcs/ implies the <tt><ref id="option-inline-stdfuncs"
251   name="--inline-stdfuncs"></tt> command line option.
252
253   See also <tt><ref id="pragma-allow-eager-inline" name="#pragma&nbsp;allow-eager-inline"></tt>.
254
255
256   <tag><tt>-h, --help</tt></tag>
257
258   Print the short option summary shown above.
259
260
261   <label id="option-inline-stdfuncs">
262   <tag><tt>--inline-stdfuncs</tt></tag>
263
264   Allow the compiler to inline some standard functions from the C library like
265   strlen.  This will not only remove the overhead for a function call, but will
266   make the code visible for the optimizer.  See also the <tt><ref id="option-O"
267   name="-Os"></tt> command line option and <tt><ref id="pragma-inline-stdfuncs"
268   name="#pragma&nbsp;inline-stdfuncs"></tt>.
269
270
271   <label id="option-list-warnings">
272   <tag><tt>--list-warnings</tt></tag>
273
274   List the names of warning types available for use with <tt><ref
275   id="option-W" name="-W"></tt>.
276
277
278   <label id="option-local-strings">
279   <tag><tt>--local-strings</tt></tag>
280
281   Emit string literals into the rodata segment as soon as they're encountered
282   in the source (even if you do nothing but get the sizeof those strings). The
283   default is to keep string literals until end of assembly, merge read only
284   literals if possible, and then output the literals into the data or rodata
285   segment that is active at that point. Use of this option prevents merging of
286   duplicate strings, but the options that change the name of one of the data
287   segments will work.
288
289   You can also use <tt><ref id="pragma-local-strings"
290   name="#pragma&nbsp;local-strings"></tt> for fine grained control.
291
292
293   <tag><tt>-o name</tt></tag>
294
295   Specify the name of the output file. If you don't specify a name, the
296   name of the C input file is used, with the extension replaced by ".s".
297
298
299   <label id="option-register-vars">
300   <tag><tt>-r, --register-vars</tt></tag>
301
302   <tt/-r/ will make the compiler honor the <tt/register/ keyword. Local
303   variables may be placed in registers (which are actually zero page
304   locations). There is some overhead involved with register variables, since
305   the old contents of the registers must be saved and restored. Since register
306   variables are of limited use without the optimizer, there is also a combined
307   switch: <tt/-Or/ will enable both, the optimizer and register variables.
308
309   For more information about register variables see <ref id="register-vars"
310   name="register variables">.
311
312   The compiler setting can also be changed within the source file by using
313   <tt/<ref id="pragma-register-vars" name="#pragma&nbsp;register-vars">/.
314
315
316   <label id="option-register-space">
317   <tag><tt>--register-space</tt></tag>
318
319   This option takes a numeric parameter and is used to specify, how much
320   zero page register space is available. Please note that just giving this
321   option will not increase or decrease by itself, it will just tell the
322   compiler about the available space. You will have to allocate that space
323   yourself using an assembler module with the necessary allocations, and a
324   linker configuration that matches the assembler module. The default value
325   for this option is 6 (bytes).
326
327   If you don't know what all this means, please don't use this option.
328
329
330   <label id="option-rodata-name">
331   <tag><tt>--rodata-name seg</tt></tag>
332
333   Set the name of the rodata segment (the segment used for readonly data).
334   See also <tt/<ref id="pragma-rodata-name" name="#pragma&nbsp;rodata-name">/
335
336   <label id="option-signed-chars">
337   <tag><tt>-j, --signed-chars</tt></tag>
338
339   Using this option, you can make the default characters signed. Since the
340   6502 has no provisions for sign extending characters (which is needed on
341   almost any load operation), this will make the code larger and slower. A
342   better way is to declare characters explicitly as "signed" if needed. You
343   can also use <tt><ref id="pragma-signed-chars"
344   name="#pragma&nbsp;signed-chars"></tt> for better control of this option.
345
346
347   <label id="option--standard">
348   <tag><tt>--standard std</tt></tag>
349
350   This option allows to set the language standard supported. The argument is
351   one of
352   <descrip>
353     <tag/c89/
354       This disables anything that is illegal in C89/C90. Among those things
355       are <tt>//</tt> comments and the non-standard keywords without
356       underscores. Please note that cc65 is not a fully C89 compliant compiler
357       despite this option. A few more things (like floats) are missing.
358
359     <tag/c99/
360       This enables a few features from the C99 standard. With this option,
361       <tt>//</tt> comments are allowed. It will also cause warnings and even
362       errors in a few situations that are allowed with <tt/--standard c89/.
363       For example, a call to a function without a prototype is an error in
364       this mode.
365
366     <tag/cc65/
367       This is the default mode. It is like c99 mode, but additional features
368       are enabled. Among these are "void data", non-standard keywords without
369       the underlines, unnamed function parameters and the requirement for
370       main() to return an int.
371   </descrip>
372
373   Please note that the compiler does not support the C99 standard and never
374   will. c99 mode is actually c89 mode with a few selected C99 extensions.
375
376
377   <label id="option-t">
378   <tag><tt>-t target, --target target</tt></tag>
379
380   This option is used to set the target system. The target system determines
381   the character set that is used for strings and character constants and the
382   default CPU. The CPU setting can be overriden by use of the <tt/<ref
383   id="option--cpu" name="--cpu">/ option.
384
385   The following target systems are supported:
386
387   <itemize>
388   <item>none
389   <item>apple2
390   <item>apple2enh
391   <item>atari
392   <item>atarixl
393   <item>atmos
394   <item>c16 (works also for the c116 with memory up to 32K)
395   <item>c64
396   <item>c128
397   <item>cbm510 (CBM-II series with 40 column video)
398   <item>cbm610 (all CBM-II II computers with 80 column video)
399   <item>geos-apple
400   <item>geos-cbm
401   <item>lunix
402   <item>lynx
403   <item>nes
404   <item>osic1p
405   <item>pet (all CBM PET systems except the 2001)
406   <item>plus4
407   <item>sim6502
408   <item>sim65c02
409   <item>supervision
410   <item>vic20
411   </itemize>
412
413   <tag><tt>-v, --verbose</tt></tag>
414
415   Using this option, the compiler will be somewhat more verbose if errors
416   or warnings are encountered.
417
418
419   <label id="option-writable-strings">
420   <tag><tt>--writable-strings</tt></tag>
421
422   Make string literals writable by placing them into the data segment instead
423   of the rodata segment. You can also use <tt><ref id="pragma-writable-strings"
424   name="#pragma&nbsp;writable-strings"></tt> to control this option from within
425   the source file.
426
427
428   <label id="option-static-locals">
429   <tag><tt>-Cl, --static-locals</tt></tag>
430
431   Use static storage for local variables instead of storage on the stack.
432   Since the stack is emulated in software, this gives shorter and usually
433   faster code, but the code is no longer reentrant. The difference between
434   <tt/-Cl/ and declaring local variables as static yourself is, that
435   initializer code is executed each time, the function is entered. So when
436   using
437
438   <tscreen><verb>
439         void f (void)
440         {
441             unsigned a = 1;
442             ...
443         }
444   </verb></tscreen>
445
446   the variable <tt/a/ will always have the value <tt/1/ when entering the
447   function and using <tt/-Cl/, while in
448
449   <tscreen><verb>
450         void f (void)
451         {
452             static unsigned a = 1;
453             ....
454         }
455   </verb></tscreen>
456
457   the variable <tt/a/ will have the value <tt/1/ only the first time that the
458   function is entered, and will keep the old value from one call of the
459   function to the next.
460
461   You may also use <tt><ref id="pragma-static-locals"
462   name="#pragma&nbsp;static-locals"></tt> to change this setting in your
463   sources.
464
465
466   <label id="option-include-dir">
467   <tag><tt>-I dir, --include-dir dir</tt></tag>
468
469   Set a directory where the compiler searches for include files. You may
470   use this option multiple times to add more than one directory to the
471   search list.
472
473
474   <label id="option-O">
475   <tag><tt>-O, -Oi, -Or, -Os</tt></tag>
476
477   Enable an optimizer run over the produced code.
478
479   Using <tt/-Oi/, the code generator will inline some code where otherwise a
480   runtime functions would have been called, even if the generated code is
481   larger. This will not only remove the overhead for a function call, but will
482   make the code visible for the optimizer. <tt/-Oi/ is an alias for
483   <tt/-O --codesize&nbsp;200/.
484
485   <tt/-Or/ will make the compiler honor the <tt/register/ keyword. Local
486   variables may be placed in registers (which are actually zero page
487   locations). See also the <tt/<ref id="option-register-vars"
488   name="--register-vars">/ command line option, and the <ref
489   id="register-vars" name="discussion of register variables"> below.
490
491   Using <tt/-Os/ will allow the compiler to inline some standard functions
492   from the C library like strlen.  This will not only remove the overhead
493   for a function call, but will make the code visible for the optimizer.
494   See also the <tt/<ref id="option-inline-stdfuncs" name="--inline-stdfuncs">/
495   command line option.
496
497   It is possible to concatenate the modifiers for <tt/-O/. For example, to
498   enable register variables and inlining of standard functions, you may use
499   <tt/-Ors/.
500
501
502   <tag><tt>-T, --add-source</tt></tag>
503
504   This include the source code as comments in the generated code. This is
505   normally not needed.
506
507
508   <tag><tt>-V, --version</tt></tag>
509
510   Print the version number of the compiler. When submitting a bug report,
511   please include the operating system you're using, and the compiler
512   version.
513
514
515   <label id="option-W">
516   <tag><tt>-W name[,name,...]</tt></tag>
517
518   This option allows to control warnings generated by the compiler. It is
519   followed by a comma-separated list of warnings that should be enabled or
520   disabled. To disable a warning, its name is prefixed by a minus sign. If
521   no such prefix exists, or the name is prefixed by a plus sign, the warning
522   is enabled.
523
524   The following warning names currently are recognized:
525   <descrip>
526   <tag><tt/const-comparison/</tag>
527         Warn if the result of a comparison is constant.
528   <tag><tt/error/</tag>
529         Treat all warnings as errors.
530   <tag><tt/no-effect/</tag>
531         Warn about statements that don't have an effect.
532   <tag><tt/remap-zero/</tag>
533         Warn about a <tt/<ref id="pragma-charmap" name="#pragma charmap()">/
534         that changes a character's code number from/to 0x00.
535   <tag><tt/struct-param/</tag>
536         Warn when passing structs by value.
537   <tag><tt/unknown-pragma/</tag>
538         Warn about #pragmas that aren't recognized by cc65.
539   <tag><tt/unused-label/</tag>
540         Warn about unused labels.
541   <tag><tt/unused-param/</tag>
542         Warn about unused function parameters.
543   <tag><tt/unused-var/</tag>
544         Warn about unused variables.
545   </descrip>
546
547   The full list of available warning names can be retrieved by using the
548   option <tt><ref id="option-list-warnings" name="--list-warnings"></tt>.
549
550   You may use also <tt><ref id="pragma-warn" name="#pragma&nbsp;warn"></tt> to
551   control this setting, for smaller pieces of code, from within your sources.
552
553 </descrip><p>
554
555
556
557 <sect>Input and output<p>
558
559 The compiler will accept one C file per invocation and create a file with
560 the same base name, but with the extension replaced by ".s". The output
561 file contains assembler code suitable for use with the ca65 macro
562 assembler.
563
564 Include files in quotes are searched in the following places:
565 <enum>
566 <item>The current file's directory.
567 <item>Any directory added with the <tt/-I/ option on the command line.
568 <item>The value of the environment variable <tt/CC65_INC/ if it is defined.
569 </enum>
570
571 Include files in angle brackets are searched in the following places:
572 <enum>
573 <item>Any directory added with the <tt/-I/ option on the command line.
574 <item>The value of the environment variable <tt/CC65_INC/ if it is defined.
575 <item>A subdirectory named <tt/include/ of the directory defined in the
576       environment variable <tt/CC65_HOME/, if it is defined.
577 <item>An optionally compiled-in directory.
578 </enum>
579
580
581
582 <sect>Differences to the ISO standard<p>
583
584 Apart from the things listed below, the compiler does support additional
585 keywords, has several functions in the standard headers with names outside the
586 reserved namespace and a few syntax extensions. All these can be disabled with
587 the <tt><ref id="option--standard" name="--standard"></tt> command line
588 option. Its use for maximum standards compatibility is advised.
589
590 Here is a list of differences between the language, the compiler accepts,
591 and the one defined by the ISO standard:
592
593 <itemize>
594
595 <item>  The datatypes "float" and "double" are not available.
596         <p>
597 <item>  C Functions may not return structs (or unions), and structs may not
598         be passed as parameters by value. However, struct assignment *is*
599         possible.
600         <p>
601 <item>  Most of the C library is available with only the fastcall calling
602         convention (<ref id="extension-fastcall" name="see below">).  It means
603         that you must not mix pointers to those functions with pointers to
604         user-written, cdecl functions (the calling conventions are incompatible).
605         <p>
606 <item>  The <tt/volatile/ keyword has almost no effect. That is not as bad
607         as it sounds, since the 6502 has so few registers that it isn't
608         possible to keep values in registers anyway.
609         <p>
610 </itemize>
611
612 There may be some more minor differences I'm currently not aware of. The
613 biggest problem is the missing float data type. With this limitation in
614 mind, you should be able to write fairly portable code.
615
616
617
618 <sect>Extensions<p>
619
620 This cc65 version has some extensions to the ISO C standard.
621
622 <itemize>
623
624 <item>  The compiler allows to insert assembler statements into the output
625         file. The syntax is
626
627         <tscreen><verb>
628         asm [optional volatile] (&lt;string literal&gt;[, optional parameters]) ;
629         </verb></tscreen>
630         or
631         <tscreen><verb>
632         __asm__ [optional volatile] (&lt;string literal&gt;[, optional parameters]) ;
633         </verb></tscreen>
634
635         The first form is in the user namespace; and, is disabled if the <tt/-A/
636         switch is given.
637
638         There is a whole section covering inline assembler statements,
639         <ref id="inline-asm" name="see there">.
640         <p>
641
642 <label id="extension-fastcall">
643 <item>  The normal calling convention -- for non-variadic functions -- is
644         named "fastcall". The syntax for a function declaration that
645         <em/explicitly/ uses fastcall is
646
647         <tscreen><verb>
648         &lt;return type&gt; fastcall &lt;function name&gt; (&lt;parameter list&gt;)
649         </verb></tscreen>
650         or
651         <tscreen><verb>
652         &lt;return type&gt; __fastcall__ &lt;function name&gt; (&lt;parameter list&gt;)
653         </verb></tscreen>
654         An example is
655         <tscreen><verb>
656         void __fastcall__ f (unsigned char c)
657         </verb></tscreen>
658         The first form of the fastcall keyword is in the user namespace and can
659         therefore be disabled with the <tt><ref id="option--standard"
660         name="--standard"></tt> command line option.
661
662         For functions that are <tt/fastcall/, the rightmost parameter is not
663         pushed on the stack but left in the primary register when the function
664         is called. That significantly reduces the cost of calling those functions.
665         <p>
666
667 <item>  There is another calling convention named "cdecl". Variadic functions
668         (their prototypes have an ellipsis &lsqb;<tt/.../&rsqb;) always use that
669         convention. The syntax for a function declaration using cdecl is
670
671         <tscreen><verb>
672         &lt;return type&gt; cdecl &lt;function name&gt; (&lt;parameter list&gt;)
673         </verb></tscreen>
674         or
675         <tscreen><verb>
676         &lt;return type&gt; __cdecl__ &lt;function name&gt; (&lt;parameter list&gt;)
677         </verb></tscreen>
678         An example is
679         <tscreen><verb>
680         int* __cdecl__ f (unsigned char c)
681         </verb></tscreen>
682
683         The first form of the cdecl keyword is in the user namespace;
684         and therefore, can be disabled with the <tt/<ref id="option--standard"
685         name="--standard">/ command-line option.
686
687         For functions that are <tt/cdecl/, the rightmost parameter is pushed
688         onto the stack before the function is called. That increases the cost
689         of calling those functions, especially when they are called from many
690         places.
691         <p>
692
693 <item>  There are two pseudo variables named <tt/__AX__/ and <tt/__EAX__/.
694         Both refer to the primary register that is used by the compiler to
695         evaluate expressions or return function results. <tt/__AX__/ is of
696         type <tt/unsigned int/ and <tt/__EAX__/ of type <tt/long unsigned int/
697         respectively. The pseudo variables may be used as lvalue and rvalue as
698         every other variable. They are most useful together with short
699         sequences of assembler code. For example, the macro
700
701         <tscreen><verb>
702         #define hi(x)           \
703             (__AX__ = (x),      \
704              asm ("txa"),       \
705              asm ("ldx #$00"),  \
706              __AX__)
707         </verb></tscreen>
708
709         will give the high byte of any unsigned value.
710         <p>
711
712 <item>  Inside a function, the identifier <tt/__func__/ gives the name of the
713         current function as a string. Outside of functions, <tt/__func__/ is
714         undefined.
715         Example:
716
717         <tscreen><verb>
718         #define PRINT_DEBUG(s)  printf ("%s: %s\n", __func__, s);
719         </verb></tscreen>
720
721         The macro will print the name of the current function plus a given
722         string.
723         <p>
724
725 <item>  cc65 allows the initialization of <tt/void/ variables. This may be
726         used to create arbitrary structures that are more compatible with
727         interfaces written for assembler languages. Here is an example:
728
729         <tscreen><verb>
730         void GCmd = { (char)3, (unsigned)0x2000, (unsigned)0x3000 };
731         </verb></tscreen>
732
733         That will be translated as follows:
734
735         <tscreen><verb>
736         _GCmd:
737                 .byte   3
738                 .word   $2000
739                 .word   $3000
740         </verb></tscreen>
741
742         Since the variable is of type <tt/void/, you may not use it as-is.
743         However, taking the address of the variable results in a <tt/void*/
744         which may be passed to any function expecting a pointer.  Also, the
745         <tt/sizeof/ operator will give the length of the initializer:
746
747         <tscreen><verb>
748         GLen = sizeof GCmd;
749         </verb></tscreen>
750
751         will assign the value 5 to <tt/GLen/.
752
753         See the <url url="geos.html" name="GEOS library document"> for examples
754         on how to use that feature.
755         <p>
756
757 <item>  cc65 implements flexible array struct members as defined in the C99 ISO
758         standard. As an extension, these fields may be initialized. There are
759         several exceptions, however (which is probably the reason why the
760         standard does not define this feature, because it is highly
761         unorthogonal). Flexible array members cannot be initialized ...
762
763         <itemize>
764         <item>... when defining an array of structs with flexible
765                 members.
766         <item>... if such a struct is a member field of another struct
767                 which is not the last field.
768         <item>... if the struct which contains a flexible array member is
769                 declared as <tt/register/, and the size and compiler settings
770                 do allow the compiler actually to place the struct into the
771                 register bank in the zero page.
772         </itemize>
773
774         Please note that -- as defined in the ISO C standard -- the <tt/sizeof/
775         operator returns the struct size with the flexible array member having
776         size zero, even if it is initialized.
777         <p>
778
779 </itemize>
780 <p>
781
782
783
784 <sect>Predefined macros<p>
785
786 The compiler defines several macros at startup:
787
788 <descrip>
789   <tag><tt>__APPLE2__</tt></tag>
790
791   This macro is defined if the target is the Apple ][ (-t apple2) or the enhanced Apple //e (-t apple2enh).
792
793   <tag><tt>__APPLE2ENH__</tt></tag>
794
795   This macro is defined if the target is the enhanced Apple //e (-t apple2enh).
796
797   <tag><tt>__ATARI2600__</tt></tag>
798
799   This macro is defined if the target is the Atari 2600 game console.
800
801   <tag><tt>__ATARI5200__</tt></tag>
802
803   This macro is defined if the target is the Atari 5200 game console.
804
805   <tag><tt>__ATARI__</tt></tag>
806
807   This macro is defined if the target is the Atari 400/800 (-t atari) or the Atari 800XL/130XE (-t atarixl).
808
809   <tag><tt>__ATARIXL__</tt></tag>
810
811   This macro is defined if the target is the Atari 800XL/130XE (-t atarixl).
812
813   <tag><tt>__ATMOS__</tt></tag>
814
815   This macro is defined if the target is the Oric Atmos (-t atmos).
816
817   <tag><tt>__C128__</tt></tag>
818
819   This macro is defined if the target is the Commodore 128 (-t c128).
820
821   <tag><tt>__C16__</tt></tag>
822
823   This macro is defined if the target is the Commodore 16/116 (-t c16) or the Commodore Plus/4 (-t plus4).
824
825   <tag><tt>__C64__</tt></tag>
826
827   This macro is defined if the target is the Commodore 64 (-t c64).
828
829   <tag><tt>__CBM__</tt></tag>
830
831   This macro is defined if the target system is one of the CBM targets.
832
833   <tag><tt>__CBM510__</tt></tag>
834
835   This macro is defined if the target is the CBM 500 series of computers.
836
837   <tag><tt>__CBM610__</tt></tag>
838
839   This macro is defined if the target is one of the CBM 600/700 family of
840   computers (called B series in the US).
841
842   <tag><tt>__CC65__</tt></tag>
843
844   This macro is always defined. Its value is the version number of the
845   compiler in hex.  For example, version 2.14 of the compiler has this macro
846   defined as <tt/0x02E0/.
847
848   <tag><tt>__CC65_STD__</tt></tag>
849
850   This macro is defined to one of the following depending on the <tt><ref
851   id="option--standard" name="--standard"></tt> command line option:
852   <itemize>
853   <item><tt/__CC65_STD_C89__/
854   <item><tt/__CC65_STD_C99__/
855   <item><tt/__CC65_STD_CC65__/
856   </itemize>
857
858   <tag><tt>__DATE__</tt></tag>
859
860   This macro expands to the date of translation of the preprocessing
861   translation unit in the form "Mmm dd yyyy".
862
863   <tag><tt>__EAGERLY_INLINE_FUNCS__</tt></tag>
864
865   Is defined if the compiler was called with the <tt><ref id="option-eagerly-inline-funcs"
866   name="--eagerly-inline-funcs"></tt> command line option.
867
868   <tag><tt>__FILE__</tt></tag>
869
870   This macro expands to a string containing the name of the C source file.
871
872   <tag><tt>__GEOS__</tt></tag>
873
874   This macro is defined if you are compiling for one of the GEOS systems.
875
876   <tag><tt>__GEOS_APPLE__</tt></tag>
877
878   This macro is defined if you are compiling for the Apple GEOS system (-t geos-apple).
879
880   <tag><tt>__GEOS_CBM__</tt></tag>
881
882   This macro is defined if you are compiling for the GEOS 64/128 system (-t geos-cbm).
883
884   <tag><tt>__LINE__</tt></tag>
885
886   This macro expands to the current line number.
887
888   <tag><tt>__LUNIX__</tt></tag>
889
890   This macro is defined if you are compiling for the LUnix system (-t lunix).
891
892   <tag><tt>__LYNX__</tt></tag>
893
894   This macro is defined if the target is the Atari Lynx (-t lynx).
895
896   <tag><tt>__NES__</tt></tag>
897
898   This macro is defined if the target is the Nintendo Entertainment System (-t nes).
899
900   <tag><tt>__OPT__</tt></tag>
901
902   Is defined if the compiler was called with the <tt/-O/ command line option.
903
904   <tag><tt>__OPT_i__</tt></tag>
905
906   Is defined if the compiler was called with the <tt/-Oi/ command line option.
907
908   <tag><tt>__OPT_r__</tt></tag>
909
910   Is defined if the compiler was called with the <tt/-Or/ command line option.
911
912   <tag><tt>__OPT_s__</tt></tag>
913
914   Is defined if the compiler was called with the <tt/-Os/ command line option.
915
916   <tag><tt>__OSIC1P__</tt></tag>
917
918   This macro is defined if the target is the Ohio Scientific Challenger 1P
919   (-t osic1p).
920
921   <tag><tt>__PET__</tt></tag>
922
923   This macro is defined if the target is the PET family of computers (-t pet).
924
925   <tag><tt>__PLUS4__</tt></tag>
926
927   This macro is defined if the target is the Commodore Plus/4 (-t plus4).
928
929   <tag><tt>__STDC_HOSTED__</tt></tag>
930
931   This macro is expands to the integer constant 1.
932
933   <tag><tt>__SIM6502__</tt></tag>
934
935   This macro is defined if the target is sim65 in 6502 mode (-t sim6502).
936
937   <tag><tt>__SIM65C02__</tt></tag>
938   This macro is defined if the target is sim65 in 65C02 mode (-t sim65c02).
939
940   <tag><tt>__SUPERVISION__</tt></tag>
941
942   This macro is defined if the target is the Supervision (-t supervision).
943
944   <tag><tt>__TIME__</tt></tag>
945
946   This macro expands to the time of translation of the preprocessing
947   translation unit in the form "hh:mm:ss".
948
949   <tag><tt>__VIC20__</tt></tag>
950
951   This macro is defined if the target is the Commodore VIC20 (-t vic20).
952 </descrip>
953
954
955
956 <sect>&num;pragmas<label id="pragmas"><p>
957
958 The compiler understands some pragmas that may be used to change code
959 generation and other stuff. Some of these pragmas understand a special form:
960 If the first parameter is <tt/push/, the old value is saved onto a stack
961 before changing it. The value may later be restored by using the <tt/pop/
962 parameter with the <tt/#pragma/.
963
964
965 <sect1><tt>#pragma allow-eager-inline ([push,] on|off)</tt><label id="pragma-allow-eager-inline"><p>
966
967   Allow eager inlining of known functions.  If the argument is "off", eager
968   inlining is disabled, otherwise it is enabled. Please note that (in contrast
969   to the <tt><ref id="option-eagerly-inline-funcs" name="--eagerly-inline-funcs"></tt>
970   command line option) this pragma does not imply the <tt><ref id="option-inline-stdfuncs"
971   name="--inline-stdfuncs"></tt> command line option.  Rather it marks code to be safe for
972   eager inlining of known functions if inlining of standard functions is enabled.
973
974   The <tt/#pragma/ understands the push and pop parameters as explained above.
975
976
977 <sect1><tt>#pragma bss-name (&lsqb;push,&rsqb; &lt;name&gt;)</tt><label id="pragma-bss-name"><p>
978
979   This pragma changes the name used for the BSS segment (the BSS segment
980   is used to store uninitialized data). The argument is a string enclosed
981   in double quotes.
982
983   Note: The default linker configuration file does only map the standard
984   segments. If you use other segments, you have to create a new linker
985   configuration file.
986
987   Beware: The startup code will zero only the default BSS segment. If you
988   use another BSS segment, you have to do that yourself, otherwise
989   uninitialized variables do not have the value zero.
990
991   The <tt/#pragma/ understands the push and pop parameters as explained above.
992
993   Example:
994   <tscreen><verb>
995         #pragma bss-name ("MyBSS")
996   </verb></tscreen>
997
998
999 <sect1><tt>#pragma charmap (&lt;index&gt;, &lt;code&gt;)</tt><label id="pragma-charmap"><p>
1000
1001   Each literal string and each literal character in the source is translated
1002   by use of a translation table. That translation table is preset when the
1003   compiler is started, depending on the target system; for example, to map
1004   ISO-8859-1 characters into PETSCII if the target is a Commodore machine.
1005
1006   This pragma allows to change entries in the translation table, so the
1007   translation for individual characters, or even the complete table may be
1008   adjusted. Both arguments are assumed to be unsigned characters with a valid
1009   range of 0-255.
1010
1011   Beware of some pitfalls:
1012   <itemize>
1013   <item>The character index is actually the code of the character in the
1014         C source; so, character mappings do always depend on the source
1015         character set. That means that <tt/#pragma&nbsp;charmap()/ is not
1016         portable -- it depends on the build environment.
1017   <item>While it is possible to use character literals as indices, the
1018         result may be somewhat unexpected, since character literals are
1019         themselves translated. For that reason, I would suggest to avoid
1020         character literals, and use numeric character codes instead.
1021   <item>It is risky to change index <tt/0x00/, because string functions depend
1022         on it. If it is changed, then the <tt/'\0'/ at the end of string
1023         literals will become non-zero. Functions that are used on those
1024         literals won't stop at the end of them. cc65 will warn you if you do
1025         change that code number. You can turn off that <tt/remap-zero/ warning
1026         if you are certain that you know what you are doing (see <tt/<ref
1027         id="pragma-warn" name="#pragma&nbsp;warn()">/).
1028   </itemize>
1029
1030   Example:
1031   <tscreen><verb>
1032   /* Use a space wherever an 'a' occurs in ISO-8859-1 source */
1033   #pragma charmap (0x61, 0x20);
1034   </verb></tscreen>
1035
1036
1037 <sect1><tt>#pragma check-stack ([push,] on|off)</tt><label id="pragma-check-stack"><p>
1038
1039   Tells the compiler to insert calls to a stack checking subroutine to detect
1040   stack overflows. The stack checking code will lead to somewhat larger and
1041   slower programs, so you may want to use this pragma when debugging your
1042   program and switch it off for the release version. If a stack overflow is
1043   detected, the program is aborted.
1044
1045   If the argument is "off", stack checks are disabled (the default), otherwise
1046   they're enabled.
1047
1048   The <tt/#pragma/ understands the push and pop parameters as explained above.
1049
1050
1051 <sect1><tt>#pragma code-name ([push,] &lt;name&gt;)</tt><label id="pragma-code-name"><p>
1052
1053   This pragma changes the name used for the CODE segment (the CODE segment
1054   is used to store executable code). The argument is a string enclosed in
1055   double quotes.
1056
1057   Note: The default linker configuration file does only map the standard
1058   segments. If you use other segments, you have to create a new linker
1059   configuration file.
1060
1061   The <tt/#pragma/ understands the push and pop parameters as explained above.
1062
1063   Example:
1064   <tscreen><verb>
1065         #pragma code-name ("MyCODE")
1066   </verb></tscreen>
1067
1068
1069 <sect1><tt>#pragma codesize ([push,] &lt;int&gt;)</tt><label id="pragma-codesize"><p>
1070
1071   This pragma allows finer control about speed vs. size decisions in the code
1072   generation and optimization phase. It gives the allowed size increase factor
1073   (in percent). The default is can be changed by use of the <tt/<ref
1074   id="option-codesize" name="--codesize">/ compiler option.
1075
1076   The <tt/#pragma/ understands the push and pop parameters as explained above.
1077
1078
1079 <sect1><tt>#pragma data-name ([push,] &lt;name&gt;)</tt><label id="pragma-data-name"><p>
1080
1081   This pragma changes the name used for the DATA segment (the DATA segment
1082   is used to store initialized data). The argument is a string enclosed in
1083   double quotes.
1084
1085   Note: The default linker configuration file does only map the standard
1086   segments. If you use other segments, you have to create a new linker
1087   configuration file.
1088
1089   The <tt/#pragma/ understands the push and pop parameters as explained above.
1090
1091   Example:
1092   <tscreen><verb>
1093         #pragma data-name ("MyDATA")
1094   </verb></tscreen>
1095
1096
1097 <sect1><tt>#pragma inline-stdfuncs ([push,] on|off)</tt><label id="pragma-inline-stdfuncs"><p>
1098
1099   Allow the compiler to inline some standard functions from the C library like
1100   strlen.  If the argument is "off", inlining is disabled, otherwise it is enabled.
1101
1102   See also the <tt/<ref id="option-inline-stdfuncs" name="--inline-stdfuncs">/
1103   command line option.
1104
1105   The <tt/#pragma/ understands the push and pop parameters as explained above.
1106
1107
1108 <sect1><tt>#pragma local-strings ([push,] on|off)</tt><label id="pragma-local-strings"><p>
1109
1110   When "on", emit string literals to the data segment when they're encountered
1111   in the source. The default ("off") is to keep string literals until end of
1112   assembly, merge read only literals if possible, and then output the literals
1113   into the data or rodata segment that is active at that point.
1114
1115   Using this <tt/#pragma/ it is possible to control the behaviour from within
1116   the source. When <tt/#pragma local-strings/ is active, string literals are
1117   output immediately, which means that they go into the currently active data
1118   or rodata segment, but cannot be merged. When inactive, string literals are
1119   remembered and output as a whole when translation is finished.
1120
1121
1122 <sect1><tt>#pragma optimize ([push,] on|off)</tt><label id="pragma-optimize"><p>
1123
1124   Switch optimization on or off. If the argument is "off", optimization is
1125   disabled, otherwise it is enabled. Please note that this pragma only effects
1126   whole functions. The setting in effect when the function is encountered will
1127   determine if the generated code is optimized or not.
1128
1129   Optimization and code generation is also controlled by the <ref
1130   id="pragma-codesize" name="codesize pragma">.
1131
1132   The default is "off", but may be changed with the <tt/<ref name="-O"
1133   id="option-O">/ compiler option.
1134
1135   The <tt/#pragma/ understands the push and pop parameters as explained above.
1136
1137
1138 <sect1><tt>#pragma rodata-name ([push,] &lt;name&gt;)</tt><label id="pragma-rodata-name"><p>
1139
1140   This pragma changes the name used for the RODATA segment (the RODATA
1141   segment is used to store readonly data). The argument is a string
1142   enclosed in double quotes.
1143
1144   Note: The default linker configuration file does only map the standard
1145   segments. If you use other segments, you have to create a new linker
1146   configuration file.
1147
1148   The <tt/#pragma/ understands the push and pop parameters as explained above.
1149
1150   Example:
1151   <tscreen><verb>
1152         #pragma rodata-name ("MyRODATA")
1153   </verb></tscreen>
1154
1155
1156 <sect1><tt>#pragma regvaraddr ([push,] on|off)</tt><label id="pragma-regvaraddr"><p>
1157
1158   The compiler does not allow to take the address of register variables.
1159   The regvaraddr pragma changes this. Taking the address of a register
1160   variable is allowed after using this pragma with "on" as argument.
1161   Using "off" as an argument switches back to the default behaviour.
1162
1163   Beware: The C standard does not allow taking the address of a variable
1164   declared as register. So your programs become non-portable if you use
1165   this pragma. In addition, your program may not work. This is usually the
1166   case if a subroutine is called with the address of a register variable,
1167   and this subroutine (or a subroutine called from there) uses
1168   register variables. So be careful with this #pragma.
1169
1170   The <tt/#pragma/ understands the push and pop parameters as explained above.
1171
1172   Example:
1173   <tscreen><verb>
1174         #pragma regvaraddr(on)  /* Allow taking the address
1175                                  * of register variables
1176                                  */
1177   </verb></tscreen>
1178
1179
1180 <sect1><tt>#pragma register-vars ([push,] on|off)</tt><label id="pragma-register-vars"><p>
1181
1182   Enables or disables use of register variables. If register variables are
1183   disabled (the default), the <tt/register/ keyword is ignored. Register
1184   variables are explained in more detail in <ref id="register-vars" name="a separate
1185   chapter">.
1186
1187   The <tt/#pragma/ understands the push and pop parameters as explained above.
1188
1189
1190 <sect1><tt>#pragma signed-chars ([push,] on|off)</tt><label id="pragma-signed-chars"><p>
1191
1192   Changes the signedness of the default character type. If the argument is
1193   "on", default characters are signed, otherwise characters are unsigned. The
1194   compiler default is to make characters unsigned since this creates a lot
1195   better code. This default may be overridden by the <tt/<ref
1196   name="--signed-chars" id="option-signed-chars">/ command line option.
1197
1198   The <tt/#pragma/ understands the push and pop parameters as explained above.
1199
1200
1201 <sect1><tt>#pragma static-locals ([push,] on|off)</tt><label id="pragma-static-locals"<p>
1202
1203   Use variables in the bss segment instead of variables on the stack. This
1204   pragma changes the default set by the compiler option <tt/<ref
1205   name="--static-locals" id="option-static-locals">/. If the argument is "on",
1206   local variables are allocated in the BSS segment, leading to shorter and in
1207   most cases faster, but non-reentrant code.
1208
1209   The <tt/#pragma/ understands the push and pop parameters as explained above.
1210
1211
1212 <sect1><tt>#pragma warn (name, [push,] on|off)</tt><label id="pragma-warn"><p>
1213
1214   Switch compiler warnings on or off. "name" is the name of a warning (see the
1215   <tt/<ref name="-W" id="option-W">/ compiler option for a list). The name is
1216   followed either by "pop", which restores the last pushed state, or by "on" or
1217   "off", optionally preceeded by "push" to push the current state before
1218   changing it.
1219
1220   Example:
1221   <tscreen><verb>
1222         /* Don't warn about the unused parameter in function func */
1223         #pragma warn (unused-param, push, off)
1224         static int func (int unused)
1225         {
1226             return 0;
1227         }
1228         #pragma warn (unused-param, pop)
1229   </verb></tscreen>
1230
1231
1232 <sect1><tt>#pragma wrapped-call (&lt;push&rt;, &lt;name&gt;, &lt;identifier&gt;)</tt><label id="pragma-wrapped-call"><p>
1233
1234   This pragma sets a wrapper for functions, often used for trampolines.
1235   The name is either a function returning void and taking no parameters,
1236   or the address of an array in memory (for a RAM trampoline). The identifier
1237   is an 8-bit number that's set to tmp4.
1238
1239   The address of the function is passed in ptr4.
1240
1241   This is useful for example with banked memory, to automatically
1242   switch banks to where this function resides, and then restore
1243   the bank when it returns.
1244
1245   The <tt/#pragma/ requires the push and pop parameters as explained above.
1246
1247   Example:
1248   <tscreen><verb>
1249         void mytrampoline(void);
1250
1251         #pragma wrapped-call (push, mytrampoline, 0)
1252         void somefunc(void);
1253         #pragma wrapped-call (pop)
1254   </verb></tscreen>
1255
1256
1257 <sect1><tt>#pragma writable-strings ([push,] on|off)</tt><label id="pragma-writable-strings"><p>
1258
1259   Changes the storage location of string literals. For historical reasons,
1260   the C standard defines that string literals are of type "char[]", but
1261   writing to such a literal causes undefined behaviour. Most compilers
1262   (including cc65) place string literals in the read-only data segment, which
1263   may cause problems with old C code that writes to string literals.
1264
1265   Using this pragma (or the corresponding command line option <tt/<ref
1266   name="--writable-strings" id="option-writable-strings">/) causes the
1267   literals to be placed in the data segment so they can be written to without
1268   worry.
1269
1270   The <tt/#pragma/ understands the push and pop parameters as explained above.
1271
1272
1273 <sect1><tt>#pragma zpsym (&lt;name&gt;)</tt><p>
1274
1275   Tell the compiler that the -- previously as external declared -- symbol with
1276   the given name is a zero page symbol (usually from an assembler file).
1277   The compiler will create a matching import declaration for the assembler.
1278
1279   Example:
1280   <tscreen><verb>
1281         extern int foo;
1282         #pragma zpsym ("foo");  /* foo is in the zeropage */
1283   </verb></tscreen>
1284
1285
1286
1287 <sect>Register variables<label id="register-vars"><p>
1288
1289 The runtime for all supported platforms has 6 bytes of zero page space
1290 available for register variables (this could be increased, but I think it's a
1291 good value). So you can declare register variables up to a total size of 6 per
1292 function. The compiler will allocate register space on a "first come, first
1293 served" base and convert any <tt/register/ declarations that exceed the
1294 available register space silently to <tt/auto/. Parameters can also be
1295 declared as <tt/register/, this will in fact give slightly shorter code than
1296 using a register variable.
1297
1298 Since a function must save the current values of the registers on entry and
1299 restore them on exit, there is an overhead associated with register variables,
1300 and this overhead is quite high (about 20 bytes per variable). This means that
1301 just declaring anything as <tt/register/ is not a good idea.
1302
1303 The best use for register variables are pointers, especially those that point
1304 to structures. The magic number here is about 3 uses of a struct field: If the
1305 function contains this number or even more, the generated code will be usually
1306 shorter and faster when using a register variable for the struct pointer. The
1307 reason for this is that the register variable can in many cases be used as a
1308 pointer directly. Having a pointer in an auto variable means that this pointer
1309 must first be copied into a zero page location, before it can be dereferenced.
1310
1311 Second best use for register variables are counters. However, there is not
1312 much difference in the code generated for counters, so you will need at least
1313 100 operations on this variable (for example in a loop) to make it worth the
1314 trouble. The only savings you get here are by the use of a zero page variable
1315 instead of one on the stack or in the data segment.
1316
1317 Register variables must be explicitly enabled, either by using <tt/<ref
1318 name="-Or" id="option-O">/ or <tt/<ref name="--register-vars"
1319 id="option-register-vars">/ on the command line or by use of <tt/<ref
1320 name="#pragma register-vars" id="pragma-register-vars">/. Register variables
1321 are only accepted on function top level, register variables declared in
1322 interior blocks are silently converted to <tt/auto/. With register variables
1323 disabled, all variables declared as <tt/register/ are actually auto variables.
1324
1325 Please take care when using register variables: While they are helpful and can
1326 lead to a tremendous speedup when used correctly, improper usage will cause
1327 bloated code and a slowdown.
1328
1329
1330
1331 <sect>Inline assembler<label id="inline-asm"><p>
1332
1333 The compiler allows to insert assembler statements into the output file. The
1334 syntax is
1335
1336 <tscreen><verb>
1337         asm [optional volatile] (&lt;string literal&gt;[, optional parameters]) ;
1338 </verb></tscreen>
1339 or
1340 <tscreen><verb>
1341         __asm__ [optional volatile] (&lt;string literal&gt;[, optional parameters]) ;
1342 </verb></tscreen>
1343 <p>
1344
1345 The first form is in the user namespace; and, is disabled by <tt><ref
1346 id="option--standard" name="--standard"></tt> if the argument is not <tt/cc65/.
1347
1348 The <tt/asm/ statement can be used only inside a function.  Please note that
1349 the result of an inline assembler expression is always of type <tt/void/.
1350
1351 The contents of the string literal are preparsed by the compiler; and, inserted
1352 into the generated assembly output, so that it can be processed further by
1353 the backend -- and, especially the optimizer. For that reason, the compiler does
1354 allow only regular 6502 opcodes to be used with the inline assembler. Pseudo
1355 instructions (like <tt/.import/, <tt/.byte/, and so on) are <em/not/ allowed,
1356 even if the ca65 assembler (which is used to translate the generated assembler
1357 code) would accept them. The built-in inline assembler is not a replacement for
1358 the full-blown macro assembler which comes with the compiler.
1359
1360 Note: Inline assembler statements are subject to all optimizations done by the
1361 compiler. There currently is no way to protect an inline assembler statement
1362 -- alone -- from being moved or removed completely by the optimizer. If in
1363 doubt, check the generated assembler output; or, disable optimizations (for
1364 that function).
1365
1366 As a shortcut, you can put the <tt/volatile/ qualifier in your <tt/asm/
1367 statements.  It will disable optimization for the functions in which those
1368 <tt/asm volatile/ statements sit.  The effect is the same as though you put
1369 <tt/#pragma optimize(push, off)/ above those functions, and <tt/#pragma
1370 optimize(pop)/ below those functions.
1371
1372 The string literal may contain format specifiers from the following list. For
1373 each format specifier, an argument is expected which is inserted instead of
1374 the format specifier, before passing the assembly code line to the backend.
1375
1376 <itemize>
1377   <item><tt/%b/ - Numerical 8-bit value
1378   <item><tt/%w/ - Numerical 16-bit value
1379   <item><tt/%l/ - Numerical 32-bit value
1380   <item><tt/%v/ - Assembler name of a global variable or function
1381   <item><tt/%o/ - Stack offset of a local variable
1382   <item><tt/%g/ - Assembler name of a C label
1383   <item><tt/%s/ - The argument is converted to a string
1384   <item><tt/%%/ - The % sign itself
1385 </itemize><p>
1386
1387 Using those format specifiers, you can access C <tt/#defines/, variables, or
1388 similar stuff from the inline assembler. For example, to load the value of
1389 a C <tt/#define/ into the Y index register, one would use
1390
1391 <tscreen><verb>
1392         #define OFFS  23
1393         __asm__ ("ldy #%b", OFFS);
1394 </verb></tscreen>
1395
1396 Or, to access a struct member of a static variable:
1397
1398 <tscreen><verb>
1399         typedef struct {
1400             unsigned char x;
1401             unsigned char y;
1402             unsigned char color;
1403         } pixel_t;
1404         static pixel_t pixel;
1405         __asm__ ("ldy #%b", offsetof(pixel_t, color));
1406         __asm__ ("lda %v,y", pixel);
1407 </verb></tscreen>
1408 <p>
1409 The next example shows how to use global variables to exchange data between C
1410 and assembler; and, how to handle assembler jumps:
1411
1412 <tscreen><verb>
1413         static unsigned char globalSubA, globalSubB, globalSubResult;
1414
1415         /* return a-b, return 255 if b>a */
1416         unsigned char sub (unsigned char a, unsigned char b)
1417         {
1418             globalSubA = a;
1419             globalSubB = b;
1420             __asm__ ("sec");
1421             __asm__ ("lda %v", globalSubA);
1422             __asm__ ("sbc %v", globalSubB);
1423             __asm__ ("bcs %g", jumpSubNoError);
1424             __asm__ ("lda #$FF");
1425         jumpSubNoError:
1426             __asm__ ("sta %v", globalSubResult);
1427             return globalSubResult;
1428         }
1429 </verb></tscreen>
1430 <p>
1431
1432 Arrays also can be accessed:
1433
1434 <tscreen><verb>
1435         static const unsigned char globalSquareTable[] = {
1436             0, 1, 4, 9, 16, 25, 36, 49, 64, 81,
1437             100, 121, 144, 169, 196, 225
1438         };
1439         static unsigned char globalSquareA, globalSquareResult;
1440
1441         /* return a*a for a<16, else 255 */
1442         unsigned char square (unsigned char a)
1443         {
1444             if (a > 15) {
1445                 return 255;
1446             }
1447             globalSquareA = a;
1448             __asm__ ("ldx %v", globalSquareA);
1449             __asm__ ("lda %v,x", globalSquareTable);
1450             __asm__ ("sta %v", globalSquareResult);
1451             return globalSquareResult;
1452         }
1453 </verb></tscreen>
1454 <p>
1455
1456 Note: Do not embed the assembler labels that are used as names of global
1457 variables or functions into your <tt/asm/ statements. Code such as this:
1458
1459 <tscreen><verb>
1460         int foo;
1461         int bar (void) { return 1; }
1462         ...
1463         __asm__ ("lda _foo");           /* DON'T DO THAT! */
1464         ...
1465         __asm__ ("jsr _bar");           /* DON'T DO THAT EITHER! */
1466 </verb></tscreen>
1467 <p>
1468
1469 might stop working if the way that the compiler generates those names is changed in
1470 a future version. Instead, use the format specifiers from the table above:
1471
1472 <tscreen><verb>
1473         __asm__ ("lda %v", foo);        /* OK */
1474         ...
1475         __asm__ ("jsr %v", bar);        /* OK */
1476 </verb></tscreen>
1477 <p>
1478
1479
1480
1481 <sect>Implementation-defined behavior<p>
1482
1483 This section describes the behavior of cc65 when the standard describes the
1484 behavior as implementation-defined.
1485
1486 (to be done)
1487
1488 <sect>Copyright<p>
1489
1490 This is the original compiler copyright:
1491
1492 <tscreen><verb>
1493 --------------------------------------------------------------------------
1494   -*- Mode: Text -*-
1495
1496      This is the copyright notice for RA65, LINK65, LIBR65, and other
1497   Atari 8-bit programs.  Said programs are Copyright 1989, by John R.
1498   Dunning.  All rights reserved, with the following exceptions:
1499
1500       Anyone may copy or redistribute these programs, provided that:
1501
1502   1:  You don't charge anything for the copy.  It is permissable to
1503       charge a nominal fee for media, etc.
1504
1505   2:  All source code and documentation for the programs is made
1506       available as part of the distribution.
1507
1508   3:  This copyright notice is preserved verbatim, and included in
1509       the distribution.
1510
1511       You are allowed to modify these programs, and redistribute the
1512   modified versions, provided that the modifications are clearly noted.
1513
1514       There is NO WARRANTY with this software, it comes as is, and is
1515   distributed in the hope that it may be useful.
1516
1517       This copyright notice applies to any program which contains
1518   this text, or the refers to this file.
1519
1520       This copyright notice is based on the one published by the Free
1521   Software Foundation, sometimes known as the GNU project.  The idea
1522   is the same as theirs, ie the software is free, and is intended to
1523   stay that way.  Everybody has the right to copy, modify, and re-
1524   distribute this software.  Nobody has the right to prevent anyone
1525   else from copying, modifying or redistributing it.
1526
1527 --------------------------------------------------------------------------
1528 </verb></tscreen>
1529
1530 Small parts of the compiler (parts of the preprocessor and main parser) are
1531 still covered by this copyright. The main portion is covered by the usual
1532 cc65 license, which reads:
1533
1534 This software is provided 'as-is', without any expressed or implied
1535 warranty.  In no event will the authors be held liable for any damages
1536 arising from the use of this software.
1537
1538 Permission is granted to anyone to use this software for any purpose,
1539 including commercial applications, and to alter it and redistribute it
1540 freely, subject to the following restrictions:
1541
1542 <enum>
1543 <item>  The origin of this software must not be misrepresented; you must not
1544         claim that you wrote the original software. If you use this software
1545         in a product, an acknowledgment in the product documentation would be
1546         appreciated but is not required.
1547 <item>  Altered source versions must be plainly marked as such, and must not
1548         be misrepresented as being the original software.
1549 <item>  This notice may not be removed or altered from any source
1550         distribution.
1551 </enum>
1552
1553 </article>