Mercurial > hg > index.cgi

comparison docs/manual/x591.html @ 231:2cc599f1bebf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added --define to lwasm documentation. Added documentation of the -D/--define command line option for lwasm. It has been present for a long time but has somehow escaped documentation.
author William Astle <lost@l-w.ca>
date Sun, 15 Jul 2012 23:12:09 -0600
parents
children ed1009bce533
comparison
equal deleted inserted replaced
230:e09985968e64 231:2cc599f1bebf
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >Assembler Modes and Pragmas</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 REL="HOME"
10 TITLE="LW Tool Chain"
11 HREF="index.html"><LINK
12 REL="UP"
13 TITLE="LWASM"
14 HREF="c45.html"><LINK
15 REL="PREVIOUS"
16 TITLE="Object Files and Sections"
17 HREF="x527.html"><LINK
18 REL="NEXT"
19 TITLE="LWLINK"
20 HREF="c681.html"></HEAD
21 ><BODY
22 CLASS="SECTION"
23 BGCOLOR="#FFFFFF"
24 TEXT="#000000"
25 LINK="#0000FF"
26 VLINK="#840084"
27 ALINK="#0000FF"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 SUMMARY="Header navigation table"
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >LW Tool Chain</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="x527.html"
49 ACCESSKEY="P"
50 >Prev</A
51 ></TD
52 ><TD
53 WIDTH="80%"
54 ALIGN="center"
55 VALIGN="bottom"
56 >Chapter 3. LWASM</TD
57 ><TD
58 WIDTH="10%"
59 ALIGN="right"
60 VALIGN="bottom"
61 ><A
62 HREF="c681.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><DIV
72 CLASS="SECTION"
73 ><H1
74 CLASS="SECTION"
75 ><A
76 NAME="AEN591"
77 >3.10. Assembler Modes and Pragmas</A
78 ></H1
79 ><P
80 >There are a number of options that affect the way assembly is performed.
81 Some of these options can only be specified on the command line because
82 they determine something absolute about the assembly process. These include
83 such things as the output target. Other things may be switchable during
84 the assembly process. These are known as pragmas and are, by definition,
85 not portable between assemblers.</P
86 ><P
87 >LWASM supports a number of pragmas that affect code generation or
88 otherwise affect the behaviour of the assembler. These may be specified by
89 way of a command line option or by assembler directives. The directives
90 are as follows.</P
91 ><P
92 ></P
93 ><DIV
94 CLASS="VARIABLELIST"
95 ><DL
96 ><DT
97 >PRAGMA <CODE
98 CLASS="PARAMETER"
99 >pragma[,...]</CODE
100 ></DT
101 ><DD
102 ><P
103 >Specifies that the assembler should bring into force all <CODE
104 CLASS="PARAMETER"
105 >pragma</CODE
106 >s
107 specified. Any unrecognized pragma will cause an assembly error. The new
108 pragmas will take effect immediately. This directive should be used when
109 the program will assemble incorrectly if the pragma is ignored or not supported.</P
110 ></DD
111 ><DT
112 >*PRAGMA <CODE
113 CLASS="PARAMETER"
114 >pragma[,...]</CODE
115 ></DT
116 ><DD
117 ><P
118 >This is identical to the PRAGMA directive except no error will occur with
119 unrecognized or unsupported pragmas. This directive, by virtue of starting
120 with a comment character, will also be ignored by assemblers that do not
121 support this directive. Use this variation if the pragma is not required
122 for correct functioning of the code.</P
123 ></DD
124 ><DT
125 >*PRAGMAPUSH <CODE
126 CLASS="PARAMETER"
127 >pragma[,...]</CODE
128 ></DT
129 ><DD
130 ><P
131 >This directive saves the current state of the specified pragma(s) for later retrieval. See discussion below for more information.</P
132 ><P
133 >This directive will not throw any errors for any reason.</P
134 ></DD
135 ><DT
136 >*PRAGMAPOP <CODE
137 CLASS="PARAMETER"
138 >pragma[,...]</CODE
139 ></DT
140 ><DD
141 ><P
142 >This directive restores the previously saved state of the specified pragma(s). See discussion below for more information.</P
143 ><P
144 >This directive will not throw any errors for any reason.</P
145 ></DD
146 ></DL
147 ></DIV
148 ><P
149 >Each pragma supported has a positive version and a negative version.
150 The positive version enables the pragma while the negative version disables
151 it. The negatitve version is simply the positive version with "no" prefixed
152 to it. For instance, "pragma" vs. "nopragma". When only one version is
153 listed below, its opposite can be obtained by prepending "no" if it is not
154 present or removing "no" from the beginning if it is present.</P
155 ><P
156 >Pragmas are not case sensitive.</P
157 ><P
158 ></P
159 ><DIV
160 CLASS="VARIABLELIST"
161 ><DL
162 ><DT
163 >index0tonone</DT
164 ><DD
165 ><P
166 >When in force, this pragma enables an optimization affecting indexed addressing
167 modes. When the offset expression in an indexed mode evaluates to zero but is
168 not explicity written as 0, this will replace the operand with the equivalent
169 no offset mode, thus creating slightly faster code. Because of the advantages
170 of this optimization, it is enabled by default.</P
171 ></DD
172 ><DT
173 >cescapes</DT
174 ><DD
175 ><P
176 >This pragma will cause strings in the FCC, FCS, and FCN pseudo operations to
177 have C-style escape sequences interpreted. The one departure from the official
178 spec is that unrecognized escape sequences will return either the character
179 immediately following the backslash or some undefined value. Do not rely
180 on the behaviour of undefined escape sequences.</P
181 ></DD
182 ><DT
183 >importundefexport</DT
184 ><DD
185 ><P
186 >This pragma is only valid for targets that support external references. When
187 in force, it will cause the EXPORT directive to act as IMPORT if the symbol
188 to be exported is not defined. This is provided for compatibility with the
189 output of gcc6809 and should not be used in hand written code. Because of
190 the confusion this pragma can cause, it is disabled by default.</P
191 ></DD
192 ><DT
193 >undefextern</DT
194 ><DD
195 ><P
196 >This pragma is only valid for targets that support external references. When in
197 force, if the assembler sees an undefined symbol on the second pass, it will
198 automatically define it as an external symbol. This automatic definition will
199 apply for the remainder of the assembly process, even if the pragma is
200 subsequently turned off. Because this behaviour would be potentially surprising,
201 this pragma defaults to off.</P
202 ><P
203 >The primary use for this pragma is for projects that share a large number of
204 symbols between source files. In such cases, it is impractical to enumerate
205 all the external references in every source file. This allows the assembler
206 and linker to do the heavy lifting while not preventing a particular source
207 module from defining a local symbol of the same name as an external symbol
208 if it does not need the external symbol. (This pragma will not cause an
209 automatic external definition if there is already a locally defined symbol.)</P
210 ><P
211 >This pragma will often be specified on the command line for large projects.
212 However, depending on the specific dynamics of the project, it may be sufficient
213 for one or two files to use this pragma internally.</P
214 ></DD
215 ><DT
216 >dollarlocal</DT
217 ><DD
218 ><P
219 >When set, a "$" in a symbol makes it local. When not set, "$" does not
220 cause a symbol to be local. It is set by default except when using the OS9
221 target.</P
222 ></DD
223 ><DT
224 >dollarnotlocal</DT
225 ><DD
226 ><P
227 > This is the same as the "dollarlocal" pragma except its sense is
228 reversed. That is, "dollarlocal" and "nodollarnotlocal" are equivalent and
229 "nodollarlocal" and "dollarnotlocal" are equivalent. </P
230 ></DD
231 ><DT
232 >pcaspcr</DT
233 ><DD
234 ><P
235 > Normally, LWASM makes a distinction between PC and PCR in program
236 counter relative addressing. In particular, the use of PC means an absolute
237 offset from PC while PCR causes the assembler to calculate the offset to the
238 specified operand and use that as the offset from PC. By setting this
239 pragma, you can have PC treated the same as PCR. </P
240 ></DD
241 ><DT
242 >shadow</DT
243 ><DD
244 ><P
245 >When this pragma is in effect, it becomes possible to define a macro
246 that matches an internal operation code. Thus, it makes it possible to
247 redefine either CPU instructions or pseudo operations. Because this feature
248 is of dubious utility, it is disabled by default.</P
249 ></DD
250 ><DT
251 >nolist</DT
252 ><DD
253 ><P
254 >Lines where this pragma is in effect will not appear in the assembly
255 listing. Also, any symbols defined under this pragma will not show up in
256 the symbol list. This is most useful in include files to avoid spamming the
257 assembly listing with dozens, hundreds, or thousands of irrelevant
258 symbols.</P
259 ></DD
260 ><DT
261 >autobranchlength</DT
262 ><DD
263 ><P
264 >One of the perennial annoyances for 6809 programmers is that the
265 mneumonics for the short and long branch instructions are different (bxx vs.
266 lbxx), which is at odds with the rest of the instruction set. This pragma
267 is a solution to those annoying byte overflow errors that short branch
268 instructions tend to aquire.</P
269 ><P
270 >When this pragma is in effect, which is not the default, whenever any
271 relative branch instruction is used, its size will be automatically
272 determined based on the actual distance to the destination. In other words,
273 one can write code with long or short branches everywhere and the assembler
274 will choose a size for the branch.</P
275 ><P
276 >Also, while this pragma is in effect, the &#62; and &#60; symbols can be used
277 to force the branch size, analogous to their use for other instructions with
278 &#60; forcing 8 bit offsets and &#62; forcing 16 bit offets.</P
279 ><P
280 >Because this pragma leads to source that is incompatible with other
281 assemblers, it is strongly recommended that it be invoked using the PRAGMA
282 directive within the source code rather than on the command line or via the
283 *PRAGMA directive. This way, an error will be raised if someone tries to
284 assemble the code under a different assembler.</P
285 ></DD
286 ><DT
287 >nosymbolcase, symbolnocase</DT
288 ><DD
289 ><P
290 >Any symbol defined while this pragma is in force will be treated as
291 case insensitive, regardless whether the pragma is in force when the symbol
292 is referenced.</P
293 ><P
294 >It is important to note that this pragma will not work as expected in
295 all cases when using the object file assembly target. It is intended for
296 use only when the assembler will be producing the final binary.</P
297 ></DD
298 ><DT
299 >condundefzero</DT
300 ><DD
301 ><P
302 >This pragma will cause the assembler to change the way it handles
303 symbols in conditional expressions. Ordinarily, any symbol that is not
304 defined prior to the conditional will throw an undefined symbol error. With
305 this pragma in effect, symbols that are not yet defined at the point the
306 conditional is encountered will be treated as zero.</P
307 ><P
308 >This is not the default because it encourages poor code design. One
309 should use the "IFDEF" or "IFNDEF" conditionals to test for the presence of
310 a symbol.</P
311 ><P
312 >It is important to note that if a symbol is defined but it does not
313 yet evaluate to a constant value at the point where the conditional appears,
314 the assembler will still complain about a non constant condition.</P
315 ></DD
316 ></DL
317 ></DIV
318 ><P
319 >As a convenience, each input file has a pragma state stack. This
320 allows, through the use of *PRAGMAPUSH and *PRAGMAPOP, a file to change a
321 pragma state and then restore it to the precise state it had previously.
322 If, at the end of an input file, all pragma states have not been popped,
323 they will be removed from the stack. Thus, it is critical to employ
324 *PRAGMAPOP correctly. Because each input file has its own pragma stack,
325 using *PRAGMAPUSH in one file and *PRAGMAPOP in another file will not
326 work.</P
327 ><P
328 >Pragma stacks are more useful in include files, in particular in
329 conjunction with the nolist pragma. One can push the state of the nolist
330 pragma, engage the nolist pragma, and then pop the state of the nolist
331 pragma at the end of the include file. This will cause the entire include
332 file to operate under the nolist pragma. However, if the file is included
333 while nolist is already engaged, it will not undo that state.</P
334 ></DIV
335 ><DIV
336 CLASS="NAVFOOTER"
337 ><HR
338 ALIGN="LEFT"
339 WIDTH="100%"><TABLE
340 SUMMARY="Footer navigation table"
341 WIDTH="100%"
342 BORDER="0"
343 CELLPADDING="0"
344 CELLSPACING="0"
345 ><TR
346 ><TD
347 WIDTH="33%"
348 ALIGN="left"
349 VALIGN="top"
350 ><A
351 HREF="x527.html"
352 ACCESSKEY="P"
353 >Prev</A
354 ></TD
355 ><TD
356 WIDTH="34%"
357 ALIGN="center"
358 VALIGN="top"
359 ><A
360 HREF="index.html"
361 ACCESSKEY="H"
362 >Home</A
363 ></TD
364 ><TD
365 WIDTH="33%"
366 ALIGN="right"
367 VALIGN="top"
368 ><A
369 HREF="c681.html"
370 ACCESSKEY="N"
371 >Next</A
372 ></TD
373 ></TR
374 ><TR
375 ><TD
376 WIDTH="33%"
377 ALIGN="left"
378 VALIGN="top"
379 >Object Files and Sections</TD
380 ><TD
381 WIDTH="34%"
382 ALIGN="center"
383 VALIGN="top"
384 ><A
385 HREF="c45.html"
386 ACCESSKEY="U"
387 >Up</A
388 ></TD
389 ><TD
390 WIDTH="33%"
391 ALIGN="right"
392 VALIGN="top"
393 >LWLINK</TD
394 ></TR
395 ></TABLE
396 ></DIV
397 ></BODY
398 ></HTML
399 >