1 /*****************************************************************************/
5 /* Listing support for the ca65 crossassembler */
9 /* (C) 2000-2011, Ullrich von Bassewitz */
10 /* Roemerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
15 /* This software is provided 'as-is', without any expressed or implied */
16 /* warranty. In no event will the authors be held liable for any damages */
17 /* arising from the use of this software. */
19 /* Permission is granted to anyone to use this software for any purpose, */
20 /* including commercial applications, and to alter it and redistribute it */
21 /* freely, subject to the following restrictions: */
23 /* 1. The origin of this software must not be misrepresented; you must not */
24 /* claim that you wrote the original software. If you use this software */
25 /* in a product, an acknowledgment in the product documentation would be */
26 /* appreciated but is not required. */
27 /* 2. Altered source versions must be plainly marked as such, and must not */
28 /* be misrepresented as being the original software. */
29 /* 3. This notice may not be removed or altered from any source */
32 /*****************************************************************************/
57 /*****************************************************************************/
59 /*****************************************************************************/
63 /* Single linked list of lines */
64 ListLine* LineList = 0; /* List of listing lines */
65 ListLine* LineCur = 0; /* Current listing line */
66 ListLine* LineLast = 0; /* Last (current) listing line */
68 /* Page and other formatting */
69 int PageLength = -1; /* Length of a listing page */
70 static unsigned PageNumber = 1; /* Current listing page number */
71 static int PageLines = 0; /* Current line on page */
72 static unsigned ListBytes = 12; /* Number of bytes to list for one line */
74 /* Switch the listing on/off */
75 static int ListingEnabled = 1; /* Enabled if > 0 */
79 /*****************************************************************************/
81 /*****************************************************************************/
85 void NewListingLine (const StrBuf* Line, unsigned char File, unsigned char Depth)
86 /* Create a new ListLine struct and insert it */
88 /* Store only if listing is enabled */
89 if (SB_GetLen (&ListingName) > 0) {
93 /* Get the length of the line */
94 unsigned Len = SB_GetLen (Line);
96 /* Ignore trailing newlines */
97 while (Len > 0 && SB_AtUnchecked (Line, Len-1) == '\n') {
101 /* Allocate memory */
102 L = xmalloc (sizeof (ListLine) + Len);
104 /* Initialize the fields. */
109 L->Reloc = GetRelocMode ();
112 L->Output = (ListingEnabled > 0);
113 L->ListBytes = (unsigned char) ListBytes;
114 memcpy (L->Line, SB_GetConstBuf (Line), Len);
117 /* Insert the line into the list of lines */
129 void EnableListing (void)
130 /* Enable output of lines to the listing */
132 if (SB_GetLen (&ListingName) > 0) {
133 /* If we're about to enable the listing, do this for the current line
134 * also, so we will see the source line that did this.
136 if (ListingEnabled++ == 0) {
144 void DisableListing (void)
145 /* Disable output of lines to the listing */
147 if (SB_GetLen (&ListingName) > 0) {
148 if (ListingEnabled == 0) {
149 /* Cannot switch the listing off once more */
150 Error ("Counter underflow");
159 void SetListBytes (int Bytes)
160 /* Set the maximum number of bytes listed for one line */
163 Bytes = 0; /* Encode "unlimited" as zero */
170 void InitListingLine (void)
171 /* Initialize the current listing line */
173 if (SB_GetLen (&ListingName) > 0) {
174 /* Make the last loaded line the current line */
175 /* ###### This code is a hack! We really need to do it right
176 * as soon as we know, how:-(
178 if (LineCur && LineCur->Next && LineCur->Next != LineLast) {
179 ListLine* L = LineCur;
182 /* Set the values for this line */
185 L->Reloc = GetRelocMode ();
186 L->Output = (ListingEnabled > 0);
187 L->ListBytes = (unsigned char) ListBytes;
188 } while (L->Next != LineLast);
192 /* Set the values for this line */
193 CHECK (LineCur != 0);
194 LineCur->PC = GetPC ();
195 LineCur->Reloc = GetRelocMode ();
196 LineCur->Output = (ListingEnabled > 0);
197 LineCur->ListBytes = (unsigned char) ListBytes;
203 static char* AddHex (char* S, unsigned Val)
204 /* Add a hex byte in ASCII to the given string and return the new pointer */
206 static const char HexTab [16] = {
207 '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'
210 *S++ = HexTab [(Val >> 4) & 0x0F];
211 *S++ = HexTab [Val & 0x0F];
218 static void PrintPageHeader (FILE* F, const ListLine* L)
219 /* Print the header for a new page. It is assumed that the given line is the
220 * last line of the previous page.
223 /* Gte a pointer to the current input file */
224 const StrBuf* CurFile = GetFileName (L->File);
226 /* Print the header on the new page */
230 "Current file: %.*s\n"
232 GetVersionAsString (), Copyright,
234 (int) SB_GetLen (CurFile), SB_GetConstBuf (CurFile));
236 /* Count pages, reset lines */
243 static void PrintLine (FILE* F, const char* Header, const char* Line, const ListLine* L)
244 /* Print one line to the listing file, adding a newline and counting lines */
246 /* Print the given line */
247 fprintf (F, "%s%s\n", Header, Line);
249 /* Increment the current line */
252 /* Switch to a new page if needed. Do not switch, if the current line is
253 * the last one, to avoid pages that consist of just the header.
255 if (PageLength > 0 && PageLines >= PageLength && L->Next != 0) {
258 /* Print the header on the new page */
259 PrintPageHeader (F, L);
265 static char* AddMult (char* S, char C, unsigned Count)
266 /* Add multiple instances of character C to S, return updated S. */
268 memset (S, C, Count);
274 static char* MakeLineHeader (char* H, const ListLine* L)
275 /* Prepare the line header */
280 /* Setup the PC mode */
281 Mode = (L->Reloc)? 'r' : ' ';
283 /* Set up the include depth */
284 Depth = (L->Depth < 10)? L->Depth + '0' : '+';
286 /* Format the line */
287 sprintf (H, "%06lX%c %c", L->PC, Mode, Depth);
288 memset (H+9, ' ', LINE_HEADER_LEN-9);
290 /* Return the buffer */
296 void CreateListing (void)
297 /* Create the listing */
302 char HeaderBuf [LINE_HEADER_LEN+1];
304 /* Open the real listing file */
305 F = fopen (SB_GetConstBuf (&ListingName), "w");
307 Fatal ("Cannot open listing file `%s': %s",
308 SB_GetConstBuf (&ListingName),
312 /* Reset variables, print the header for the first page */
314 PrintPageHeader (F, LineList);
316 /* Terminate the header buffer. The last byte will never get overwritten */
317 HeaderBuf [LINE_HEADER_LEN] = '\0';
319 /* Walk through all listing lines */
329 /* If we should not output this line, go to the next */
330 if (L->Output == 0) {
335 /* If we don't have a fragment list for this line, things are easy */
336 if (L->FragList == 0) {
337 PrintLine (F, MakeLineHeader (HeaderBuf, L), L->Line, L);
342 /* Count the number of bytes in the complete fragment list */
347 Frag = Frag->LineList;
350 /* Allocate memory for the given number of bytes */
351 Buf = xmalloc (Count*2+1);
353 /* Copy an ASCII representation of the bytes into the buffer */
358 /* Write data depending on the type */
359 switch (Frag->Type) {
362 for (I = 0; I < Frag->Len; ++I) {
363 B = AddHex (B, Frag->V.Data[I]);
369 B = AddMult (B, 'r', Frag->Len*2);
373 B = AddMult (B, 'x', Frag->Len*2);
377 Internal ("Invalid fragment type: %u", Frag->Type);
382 Frag = Frag->LineList;
386 /* Limit the number of bytes actually printed */
387 if (L->ListBytes != 0) {
389 if (Count > L->ListBytes) {
390 Count = L->ListBytes;
394 /* Output the data. The format of a listing line is:
396 * PPPPPPm I 11 22 33 44
401 * m is the mode ('r' or empty)
402 * I is the include level
403 * 11 .. are code or data bytes
412 /* Prepare the line header */
413 MakeLineHeader (HeaderBuf, L);
415 /* Get the number of bytes for the next line */
422 /* Increment the program counter. Since we don't need the PC stored
423 * in the LineList object for anything else, just increment this
428 /* Copy the bytes into the line */
430 for (I = 0; I < Chunk; ++I) {
436 /* Output this line */
437 PrintLine (F, HeaderBuf, Line, L);
439 /* Don't output a line twice */
444 /* Delete the temporary buffer */
452 /* Close the listing file */