1 /*****************************************************************************/
5 /* Listing support for the ca65 crossassembler */
9 /* (C) 2000 Ullrich von Bassewitz */
11 /* D-70597 Stuttgart */
12 /* EMail: uz@musoftware.de */
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 /*****************************************************************************/
40 #include "../common/fname.h"
41 #include "../common/segdefs.h"
42 #include "../common/version.h"
43 #include "../common/xmalloc.h"
52 /*****************************************************************************/
54 /*****************************************************************************/
58 /* Single linked list of lines */
59 ListLine* LineList = 0; /* List of listing lines */
60 ListLine* LineCur = 0; /* Current listing line */
61 ListLine* LineLast = 0; /* Last (current) listing line */
63 /* Page and other formatting */
64 int PageLength = -1; /* Length of a listing page */
65 static unsigned PageNumber = 1; /* Current listing page number */
66 static unsigned PageLines = 0; /* Current line on page */
67 static unsigned ListBytes = 12; /* Number of bytes to list for one line */
69 /* Switch the listing on/off */
70 static int ListingEnabled = 1; /* Enabled if > 0 */
74 /*****************************************************************************/
76 /*****************************************************************************/
80 void NewListingLine (const char* Line, unsigned char File, unsigned char Depth)
81 /* Create a new ListLine struct and insert it */
83 /* Store only if listing is enabled */
88 /* Get the length of the line */
89 unsigned Len = strlen (Line);
91 /* Ignore trailing newlines */
92 while (Len > 0 && Line[Len-1] == '\n') {
97 L = xmalloc (sizeof (ListLine) + Len);
99 /* Initialize the fields. */
104 L->Reloc = RelocMode;
107 L->Output = (ListingEnabled > 0);
108 L->ListBytes = (unsigned char) ListBytes;
109 memcpy (L->Line, Line, Len);
110 L->Line [Len] = '\0';
112 /* Insert the line into the list of lines */
124 void EnableListing (void)
125 /* Enable output of lines to the listing */
128 /* If we're about to enable the listing, do this for the current line
129 * also, so we will see the source line that did this.
131 if (ListingEnabled++ == 0) {
139 void DisableListing (void)
140 /* Disable output of lines to the listing */
143 if (ListingEnabled == 0) {
144 /* Cannot switch the listing off once more */
145 Error (ERR_COUNTER_UNDERFLOW);
154 void SetListBytes (int Bytes)
155 /* Set the maximum number of bytes listed for one line */
158 Bytes = 0; /* Encode "unlimited" as zero */
165 void InitListingLine (void)
166 /* Initialize the current listing line */
169 /* Make the last loaded line the current line */
172 /* Set the values for this line */
173 CHECK (LineCur != 0);
174 LineCur->PC = GetPC ();
175 LineCur->Reloc = RelocMode;
176 LineCur->Output = (ListingEnabled > 0);
177 LineCur->ListBytes = (unsigned char) ListBytes;
183 static char* AddHex (char* S, unsigned Val)
184 /* Add a hex byte in ASCII to the given string and return the new pointer */
186 static const char HexTab [16] = {
187 '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'
190 *S++ = HexTab [(Val >> 4) & 0x0F];
191 *S++ = HexTab [Val & 0x0F];
198 static void PrintPageHeader (FILE* F, const ListLine* L)
199 /* Print the header for a new page. It is assumed that the given line is the
200 * last line of the previous page.
203 /* Print the header on the new page */
205 "ca65 V%u.%u.%u - (C) Copyright 1998-2000 Ullrich von Bassewitz\n"
209 VER_MAJOR, VER_MINOR, VER_PATCH,
211 GetFileName (L->File));
213 /* Count pages, reset lines */
220 static void PrintLine (FILE* F, const char* Header, const char* Line, const ListLine* L)
221 /* Print one line to the listing file, adding a newline and counting lines */
223 /* Print the given line */
224 fprintf (F, "%s%s\n", Header, Line);
226 /* Increment the current line */
229 /* Switch to a new page if needed. Do not switch, if the current line is
230 * the last one, to avoid pages that consist of just the header.
232 if (PageLength > 0 && PageLines >= PageLength && L->Next != 0) {
235 /* Print the header on the new page */
236 PrintPageHeader (F, L);
242 static char* AddMult (char* S, char C, unsigned Count)
243 /* Add multiple instances of character C to S, return updated S. */
245 memset (S, C, Count);
251 static char* MakeLineHeader (char* H, const ListLine* L)
252 /* Prepare the line header */
257 /* Setup the PC mode */
258 Mode = (L->Reloc)? 'r' : ' ';
260 /* Set up the include depth */
261 Depth = (L->Depth < 10)? L->Depth + '0' : '+';
263 /* Format the line */
264 sprintf (H, "%06lX%c %c", L->PC, Mode, Depth);
265 memset (H+9, ' ', LINE_HEADER_LEN-9);
267 /* Return the buffer */
273 void CreateListing (void)
274 /* Create the listing */
279 char HeaderBuf [LINE_HEADER_LEN+1];
281 /* Create the name of the listing file if needed */
283 ListFile = MakeFilename (InFile, ListExt);
286 /* Open the real listing file */
287 F = fopen (ListFile, "w");
289 Fatal (FAT_CANNOT_OPEN_LISTING, strerror (errno));
292 /* Reset variables, print the header for the first page */
294 PrintPageHeader (F, LineList);
296 /* Terminate the header buffer. The last byte will never get overwritten */
297 HeaderBuf [LINE_HEADER_LEN] = '\0';
299 /* Walk through all listing lines */
309 /* If we should not output this line, go to the next */
310 if (L->Output == 0) {
315 /* If we don't have a fragment list for this line, things are easy */
316 if (L->FragList == 0) {
317 PrintLine (F, MakeLineHeader (HeaderBuf, L), L->Line, L);
322 /* Count the number of bytes in the complete fragment list */
327 Frag = Frag->LineList;
330 /* Allocate memory for the given number of bytes */
331 Buf = xmalloc (Count*2+1);
333 /* Copy an ASCII representation of the bytes into the buffer */
338 /* Write data depending on the type */
339 switch (Frag->Type) {
342 for (I = 0; I < Frag->Len; ++I) {
343 B = AddHex (B, Frag->V.Data[I]);
349 B = AddMult (B, 'r', Frag->Len*2);
353 B = AddMult (B, 'x', Frag->Len*2);
357 Internal ("Invalid fragment type: %u", Frag->Type);
362 Frag = Frag->LineList;
366 /* Limit the number of bytes actually printed */
367 if (L->ListBytes != 0) {
369 if (Count > L->ListBytes) {
370 Count = L->ListBytes;
374 /* Output the data. The format of a listing line is:
376 * PPPPPPm I 11 22 33 44
381 * m is the mode ('r' or empty)
382 * I is the include level
383 * 11 .. are code or data bytes
392 /* Prepare the line header */
393 MakeLineHeader (HeaderBuf, L);
395 /* Get the number of bytes for the next line */
402 /* Increment the program counter. Since we don't need the PC stored
403 * in the LineList object for anything else, just increment this
408 /* Copy the bytes into the line */
410 for (I = 0; I < Chunk; ++I) {
416 /* Output this line */
417 PrintLine (F, HeaderBuf, Line, L);
419 /* Don't output a line twice */
424 /* Delete the temporary buffer */
432 /* Close the listing file */