git.sur5r.net Git - cc65/blob - src/ca65/listing.c

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 listing.c                                 */
   4 /*                                                                           */
   5 /*                Listing support for the ca65 crossassembler                */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2008 Ullrich von Bassewitz                                       */
  10 /*               Roemerstrasse 52                                            */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  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.                                    */
  18 /*                                                                           */
  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:                            */
  22 /*                                                                           */
  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              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #include <stdio.h>
  37 #include <string.h>
  38 #include <errno.h>
  39
  40 /* common */
  41 #include "check.h"
  42 #include "fname.h"
  43 #include "fragdefs.h"
  44 #include "version.h"
  45 #include "xmalloc.h"
  46
  47 /* ca65 */
  48 #include "error.h"
  49 #include "filetab.h"
  50 #include "global.h"
  51 #include "listing.h"
  52 #include "segment.h"
  53
  54
  55
  56 /*****************************************************************************/
  57 /*                                   Data                                    */
  58 /*****************************************************************************/
  59
  60
  61
  62 /* Single linked list of lines */
  63 ListLine*       LineList = 0;           /* List of listing lines */
  64 ListLine*       LineCur  = 0;           /* Current listing line */
  65 ListLine*       LineLast = 0;           /* Last (current) listing line */
  66
  67 /* Page and other formatting */
  68 int             PageLength = -1;        /* Length of a listing page */
  69 static unsigned PageNumber = 1;         /* Current listing page number */
  70 static int      PageLines  = 0;         /* Current line on page */
  71 static unsigned ListBytes  = 12;        /* Number of bytes to list for one line */
  72
  73 /* Switch the listing on/off */
  74 static int      ListingEnabled = 1;     /* Enabled if > 0 */
  75
  76
  77
  78 /*****************************************************************************/
  79 /*                                   Code                                    */
  80 /*****************************************************************************/
  81
  82
  83
  84 void NewListingLine (const char* Line, unsigned char File, unsigned char Depth)
  85 /* Create a new ListLine struct and insert it */
  86 {
  87     /* Store only if listing is enabled */
  88     if (Listing) {
  89
  90         ListLine* L;
  91
  92         /* Get the length of the line */
  93         unsigned Len = strlen (Line);
  94
  95         /* Ignore trailing newlines */
  96         while (Len > 0 && Line[Len-1] == '\n') {
  97             --Len;
  98         }
  99
 100         /* Allocate memory */
 101         L = xmalloc (sizeof (ListLine) + Len);
 102
 103         /* Initialize the fields. */
 104         L->Next         = 0;
 105         L->FragList     = 0;
 106         L->FragLast     = 0;
 107         L->PC           = GetPC ();
 108         L->Reloc        = GetRelocMode ();
 109         L->File         = File;
 110         L->Depth        = Depth;
 111         L->Output       = (ListingEnabled > 0);
 112         L->ListBytes    = (unsigned char) ListBytes;
 113         memcpy (L->Line, Line, Len);
 114         L->Line [Len] = '\0';
 115
 116         /* Insert the line into the list of lines */
 117         if (LineList == 0) {
 118             LineList = L;
 119         } else {
 120             LineLast->Next = L;
 121         }
 122         LineLast = L;
 123     }
 124 }
 125
 126
 127
 128 void EnableListing (void)
 129 /* Enable output of lines to the listing */
 130 {
 131     if (Listing) {
 132         /* If we're about to enable the listing, do this for the current line
 133          * also, so we will see the source line that did this.
 134          */
 135         if (ListingEnabled++ == 0) {
 136             LineCur->Output = 1;
 137         }
 138     }
 139 }
 140
 141
 142
 143 void DisableListing (void)
 144 /* Disable output of lines to the listing */
 145 {
 146     if (Listing) {
 147         if (ListingEnabled == 0) {
 148             /* Cannot switch the listing off once more */
 149             Error ("Counter underflow");
 150         } else {
 151             --ListingEnabled;
 152         }
 153     }
 154 }
 155
 156
 157
 158 void SetListBytes (int Bytes)
 159 /* Set the maximum number of bytes listed for one line */
 160 {
 161     if (Bytes < 0) {
 162         Bytes = 0;      /* Encode "unlimited" as zero */
 163     }
 164     ListBytes = Bytes;
 165 }
 166
 167
 168
 169 void InitListingLine (void)
 170 /* Initialize the current listing line */
 171 {
 172     if (Listing) {
 173         /* Make the last loaded line the current line */
 174         /* ###### This code is a hack! We really need to do it right
 175          * as soon as we know, how:-(
 176          */
 177         if (LineCur && LineCur->Next && LineCur->Next != LineLast) {
 178             ListLine* L = LineCur;
 179             do {
 180                 L = L->Next;
 181                 /* Set the values for this line */
 182                 CHECK (L != 0);
 183                 L->PC            = GetPC ();
 184                 L->Reloc         = GetRelocMode ();
 185                 L->Output        = (ListingEnabled > 0);
 186                 L->ListBytes = (unsigned char) ListBytes;
 187             } while (L->Next != LineLast);
 188         }
 189         LineCur = LineLast;
 190
 191         /* Set the values for this line */
 192         CHECK (LineCur != 0);
 193         LineCur->PC         = GetPC ();
 194         LineCur->Reloc      = GetRelocMode ();
 195         LineCur->Output     = (ListingEnabled > 0);
 196         LineCur->ListBytes  = (unsigned char) ListBytes;
 197     }
 198 }
 199
 200
 201
 202 static char* AddHex (char* S, unsigned Val)
 203 /* Add a hex byte in ASCII to the given string and return the new pointer */
 204 {
 205     static const char HexTab [16] = {
 206         '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'
 207     };
 208
 209     *S++ = HexTab [(Val >> 4) & 0x0F];
 210     *S++ = HexTab [Val & 0x0F];
 211
 212     return S;
 213 }
 214
 215
 216
 217 static void PrintPageHeader (FILE* F, const ListLine* L)
 218 /* Print the header for a new page. It is assumed that the given line is the
 219  * last line of the previous page.
 220  */
 221 {
 222     /* Gte a pointer to the current input file */
 223     const StrBuf* CurFile = GetFileName (L->File);
 224
 225     /* Print the header on the new page */
 226     fprintf (F,
 227              "ca65 V%u.%u.%u - %s\n"
 228              "Main file   : %s\n"
 229              "Current file: %.*s\n"
 230              "\n",
 231              VER_MAJOR, VER_MINOR, VER_PATCH,
 232              Copyright,
 233              InFile,
 234              SB_GetLen (CurFile), SB_GetConstBuf (CurFile));
 235
 236     /* Count pages, reset lines */
 237     ++PageNumber;
 238     PageLines = 4;
 239 }
 240
 241
 242
 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 */
 245 {
 246     /* Print the given line */
 247     fprintf (F, "%s%s\n", Header, Line);
 248
 249     /* Increment the current line */
 250     ++PageLines;
 251
 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.
 254      */
 255     if (PageLength > 0 && PageLines >= PageLength && L->Next != 0) {
 256         /* Do a formfeed */
 257         putc ('\f', F);
 258         /* Print the header on the new page */
 259         PrintPageHeader (F, L);
 260     }
 261 }
 262
 263
 264
 265 static char* AddMult (char* S, char C, unsigned Count)
 266 /* Add multiple instances of character C to S, return updated S. */
 267 {
 268     memset (S, C, Count);
 269     return S + Count;
 270 }
 271
 272
 273
 274 static char* MakeLineHeader (char* H, const ListLine* L)
 275 /* Prepare the line header */
 276 {
 277     char Mode;
 278     char Depth;
 279
 280     /* Setup the PC mode */
 281     Mode = (L->Reloc)? 'r' : ' ';
 282
 283     /* Set up the include depth */
 284     Depth = (L->Depth < 10)? L->Depth + '0' : '+';
 285
 286     /* Format the line */
 287     sprintf (H, "%06lX%c %c", L->PC, Mode, Depth);
 288     memset (H+9, ' ', LINE_HEADER_LEN-9);
 289
 290     /* Return the buffer */
 291     return H;
 292 }
 293
 294
 295
 296 void CreateListing (void)
 297 /* Create the listing */
 298 {
 299     FILE* F;
 300     Fragment* Frag;
 301     ListLine* L;
 302     char HeaderBuf [LINE_HEADER_LEN+1];
 303
 304     /* Create the name of the listing file if needed */
 305     if (ListFile == 0) {
 306         ListFile = MakeFilename (InFile, ListExt);
 307     }
 308
 309     /* Open the real listing file */
 310     F = fopen (ListFile, "w");
 311     if (F == 0) {
 312         Fatal ("Cannot open listing file: %s", strerror (errno));
 313     }
 314
 315     /* Reset variables, print the header for the first page */
 316     PageNumber = 0;
 317     PrintPageHeader (F, LineList);
 318
 319     /* Terminate the header buffer. The last byte will never get overwritten */
 320     HeaderBuf [LINE_HEADER_LEN] = '\0';
 321
 322     /* Walk through all listing lines */
 323     L = LineList;
 324     while (L) {
 325
 326         char* Buf;
 327         char* B;
 328         unsigned Count;
 329         unsigned I;
 330         char* Line;
 331
 332         /* If we should not output this line, go to the next */
 333         if (L->Output == 0) {
 334             L = L->Next;
 335             continue;
 336         }
 337
 338         /* If we don't have a fragment list for this line, things are easy */
 339         if (L->FragList == 0) {
 340             PrintLine (F, MakeLineHeader (HeaderBuf, L), L->Line, L);
 341             L = L->Next;
 342             continue;
 343         }
 344
 345         /* Count the number of bytes in the complete fragment list */
 346         Count = 0;
 347         Frag = L->FragList;
 348         while (Frag) {
 349             Count += Frag->Len;
 350             Frag = Frag->LineList;
 351         }
 352
 353         /* Allocate memory for the given number of bytes */
 354         Buf = xmalloc (Count*2+1);
 355
 356         /* Copy an ASCII representation of the bytes into the buffer */
 357         B = Buf;
 358         Frag = L->FragList;
 359         while (Frag) {
 360
 361             /* Write data depending on the type */
 362             switch (Frag->Type) {
 363
 364                 case FRAG_LITERAL:
 365                     for (I = 0; I < Frag->Len; ++I) {
 366                         B = AddHex (B, Frag->V.Data[I]);
 367                     }
 368                     break;
 369
 370                 case FRAG_EXPR:
 371                 case FRAG_SEXPR:
 372                     B = AddMult (B, 'r', Frag->Len*2);
 373                     break;
 374
 375                 case FRAG_FILL:
 376                     B = AddMult (B, 'x', Frag->Len*2);
 377                     break;
 378
 379                 default:
 380                     Internal ("Invalid fragment type: %u", Frag->Type);
 381
 382             }
 383
 384             /* Next fragment */
 385             Frag = Frag->LineList;
 386
 387         }
 388
 389         /* Limit the number of bytes actually printed */
 390         if (L->ListBytes != 0) {
 391             /* Not unlimited */
 392             if (Count > L->ListBytes) {
 393                 Count = L->ListBytes;
 394             }
 395         }
 396
 397         /* Output the data. The format of a listing line is:
 398          *
 399          *      PPPPPPm I  11 22 33 44
 400          *
 401          * where
 402          *
 403          *      PPPPPP  is the PC
 404          *      m       is the mode ('r' or empty)
 405          *      I       is the include level
 406          *      11 ..   are code or data bytes
 407          */
 408         Line = L->Line;
 409         B    = Buf;
 410         while (Count) {
 411
 412             unsigned    Chunk;
 413             char*       P;
 414
 415             /* Prepare the line header */
 416             MakeLineHeader (HeaderBuf, L);
 417
 418             /* Get the number of bytes for the next line */
 419             Chunk = Count;
 420             if (Chunk > 4) {
 421                 Chunk = 4;
 422             }
 423             Count -= Chunk;
 424
 425             /* Increment the program counter. Since we don't need the PC stored
 426              * in the LineList object for anything else, just increment this
 427              * variable.
 428              */
 429             L->PC += Chunk;
 430
 431             /* Copy the bytes into the line */
 432             P = HeaderBuf + 11;
 433             for (I = 0; I < Chunk; ++I) {
 434                 *P++ = *B++;
 435                 *P++ = *B++;
 436                 *P++ = ' ';
 437             }
 438
 439             /* Output this line */
 440             PrintLine (F, HeaderBuf, Line, L);
 441
 442             /* Don't output a line twice */
 443             Line = "";
 444
 445         }
 446
 447         /* Delete the temporary buffer */
 448         xfree (Buf);
 449
 450         /* Next line */
 451         L = L->Next;
 452
 453     }
 454
 455     /* Close the listing file */
 456     (void) fclose (F);
 457 }
 458
 459
 460