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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  main.c                                   */
   4 /*                                                                           */
   5 /*                 Main program for the ca65 macroassembler                  */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2003 Ullrich von Bassewitz                                       */
  10 /*               Römerstraße 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 <stdlib.h>
  38 #include <string.h>
  39 #include <time.h>
  40
  41 /* common */
  42 #include "addrsize.h"
  43 #include "chartype.h"
  44 #include "cmdline.h"
  45 #include "mmodel.h"
  46 #include "print.h"
  47 #include "target.h"
  48 #include "tgttrans.h"
  49 #include "version.h"
  50
  51 /* ca65 */
  52 #include "abend.h"
  53 #include "asserts.h"
  54 #include "error.h"
  55 #include "expr.h"
  56 #include "feature.h"
  57 #include "filetab.h"
  58 #include "global.h"
  59 #include "incpath.h"
  60 #include "instr.h"
  61 #include "istack.h"
  62 #include "lineinfo.h"
  63 #include "listing.h"
  64 #include "macro.h"
  65 #include "nexttok.h"
  66 #include "objfile.h"
  67 #include "options.h"
  68 #include "pseudo.h"
  69 #include "scanner.h"
  70 #include "segment.h"
  71 #include "sizeof.h"
  72 #include "spool.h"
  73 #include "symtab.h"
  74 #include "ulabel.h"
  75
  76
  77
  78 /*****************************************************************************/
  79 /*                                   Code                                    */
  80 /*****************************************************************************/
  81
  82
  83
  84 static void Usage (void)
  85 /* Print usage information and exit */
  86 {
  87     fprintf (stderr,
  88              "Usage: %s [options] file\n"
  89              "Short options:\n"
  90              "  -D name[=value]\tDefine a symbol\n"
  91              "  -I dir\t\tSet an include directory search path\n"
  92              "  -U\t\t\tMark unresolved symbols as import\n"
  93              "  -V\t\t\tPrint the assembler version\n"
  94              "  -W n\t\t\tSet warning level n\n"
  95              "  -g\t\t\tAdd debug info to object file\n"
  96              "  -h\t\t\tHelp (this text)\n"
  97              "  -i\t\t\tIgnore case of symbols\n"
  98              "  -l\t\t\tCreate a listing if assembly was ok\n"
  99              "  -mm model\t\tSet the memory model\n"
 100              "  -o name\t\tName the output file\n"
 101              "  -s\t\t\tEnable smart mode\n"
 102              "  -t sys\t\tSet the target system\n"
 103              "  -v\t\t\tIncrease verbosity\n"
 104              "\n"
 105              "Long options:\n"
 106              "  --auto-import\t\tMark unresolved symbols as import\n"
 107              "  --cpu type\t\tSet cpu type\n"
 108              "  --debug-info\t\tAdd debug info to object file\n"
 109              "  --feature name\tSet an emulation feature\n"
 110              "  --help\t\tHelp (this text)\n"
 111              "  --ignore-case\t\tIgnore case of symbols\n"
 112              "  --include-dir dir\tSet an include directory search path\n"
 113              "  --listing\t\tCreate a listing if assembly was ok\n"
 114              "  --memory-model model\tSet the memory model\n"
 115              "  --pagelength n\tSet the page length for the listing\n"
 116              "  --smart\t\tEnable smart mode\n"
 117              "  --target sys\t\tSet the target system\n"
 118              "  --verbose\t\tIncrease verbosity\n"
 119              "  --version\t\tPrint the assembler version\n",
 120              ProgName);
 121 }
 122
 123
 124
 125 static void SetOptions (void)
 126 /* Set the option for the translator */
 127 {
 128     char Buf [256];
 129
 130     /* Set the translator */
 131     sprintf (Buf, "ca65 V%u.%u.%u", VER_MAJOR, VER_MINOR, VER_PATCH);
 132     OptTranslator (Buf);
 133
 134     /* Set date and time */
 135     OptDateTime ((unsigned long) time(0));
 136 }
 137
 138
 139
 140 static void DefineSymbol (const char* Def)
 141 /* Define a symbol from the command line */
 142 {
 143     const char* P;
 144     unsigned I;
 145     long Val;
 146     char SymName [MAX_STR_LEN+1];
 147     SymEntry* Sym;
 148     ExprNode* Expr;
 149
 150
 151     /* The symbol must start with a character or underline */
 152     if (Def [0] != '_' && !IsAlpha (Def [0])) {
 153         InvDef (Def);
 154     }
 155     P = Def;
 156
 157     /* Copy the symbol, checking the rest */
 158     I = 0;
 159     while (IsAlNum (*P) || *P == '_') {
 160         if (I <= MAX_STR_LEN) {
 161             SymName [I++] = *P;
 162         }
 163         ++P;
 164     }
 165     SymName [I] = '\0';
 166
 167     /* Do we have a value given? */
 168     if (*P != '=') {
 169         if (*P != '\0') {
 170             InvDef (Def);
 171         }
 172         Val = 0;
 173     } else {
 174         /* We have a value */
 175         ++P;
 176         if (*P == '$') {
 177             ++P;
 178             if (sscanf (P, "%lx", &Val) != 1) {
 179                 InvDef (Def);
 180             }
 181         } else {
 182             if (sscanf (P, "%li", &Val) != 1) {
 183                 InvDef (Def);
 184             }
 185         }
 186     }
 187
 188     /* Search for the symbol, allocate a new one if it doesn't exist */
 189     Sym = SymFind (CurrentScope, SymName, SYM_ALLOC_NEW);
 190
 191     /* Check if have already a symbol with this name */
 192     if (SymIsDef (Sym)) {
 193         AbEnd ("`%s' is already defined", SymName);
 194     }
 195
 196     /* Generate an expression for the symbol */
 197     Expr = GenLiteralExpr (Val);
 198
 199     /* Mark the symbol as defined */
 200     SymDef (Sym, Expr, ADDR_SIZE_DEFAULT, SF_NONE);
 201 }
 202
 203
 204
 205 static void OptAutoImport (const char* Opt attribute ((unused)),
 206                            const char* Arg attribute ((unused)))
 207 /* Mark unresolved symbols as imported */
 208 {
 209     AutoImport = 1;
 210 }
 211
 212
 213
 214 static void OptCPU (const char* Opt attribute ((unused)), const char* Arg)
 215 /* Handle the --cpu option */
 216 {
 217     cpu_t CPU = FindCPU (Arg);
 218     if (CPU == CPU_UNKNOWN) {
 219         AbEnd ("Invalid CPU: `%s'", Arg);
 220     } else {
 221         SetCPU (CPU);
 222     }
 223 }
 224
 225
 226
 227 static void OptDebugInfo (const char* Opt attribute ((unused)),
 228                           const char* Arg attribute ((unused)))
 229 /* Add debug info to the object file */
 230 {
 231     DbgSyms = 1;
 232 }
 233
 234
 235
 236 static void OptFeature (const char* Opt attribute ((unused)), const char* Arg)
 237 /* Set an emulation feature */
 238 {
 239     /* Set the feature, check for errors */
 240     if (SetFeature (Arg) == FEAT_UNKNOWN) {
 241         AbEnd ("Illegal emulation feature: `%s'", Arg);
 242     }
 243 }
 244
 245
 246
 247 static void OptHelp (const char* Opt attribute ((unused)),
 248                      const char* Arg attribute ((unused)))
 249 /* Print usage information and exit */
 250 {
 251     Usage ();
 252     exit (EXIT_SUCCESS);
 253 }
 254
 255
 256
 257 static void OptIgnoreCase (const char* Opt attribute ((unused)),
 258                            const char* Arg attribute ((unused)))
 259 /* Ignore case on symbols */
 260 {
 261     IgnoreCase = 1;
 262 }
 263
 264
 265
 266 static void OptIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
 267 /* Add an include search path */
 268 {
 269     AddIncludePath (Arg);
 270 }
 271
 272
 273
 274 static void OptListing (const char* Opt attribute ((unused)),
 275                         const char* Arg attribute ((unused)))
 276 /* Create a listing file */
 277 {
 278     Listing = 1;
 279 }
 280
 281
 282
 283 static void OptMemoryModel (const char* Opt, const char* Arg)
 284 /* Set the memory model */
 285 {
 286     mmodel_t M;
 287
 288     /* Check the current memory model */
 289     if (MemoryModel != MMODEL_UNKNOWN) {
 290         AbEnd ("Cannot use option `%s' twice", Opt);
 291     }
 292
 293     /* Translate the memory model name and check it */
 294     M = FindMemoryModel (Arg);
 295     if (M == MMODEL_UNKNOWN) {
 296         AbEnd ("Unknown memory model: %s", Arg);
 297     } else if (M == MMODEL_HUGE) {
 298         AbEnd ("Unsupported memory model: %s", Arg);
 299     }
 300
 301     /* Set the memory model */
 302     SetMemoryModel (M);
 303 }
 304
 305
 306
 307 static void OptPageLength (const char* Opt attribute ((unused)), const char* Arg)
 308 /* Handle the --pagelength option */
 309 {
 310     int Len = atoi (Arg);
 311     if (Len != -1 && (Len < MIN_PAGE_LEN || Len > MAX_PAGE_LEN)) {
 312         AbEnd ("Invalid page length: %d", Len);
 313     }
 314     PageLength = Len;
 315 }
 316
 317
 318
 319 static void OptSmart (const char* Opt attribute ((unused)),
 320                       const char* Arg attribute ((unused)))
 321 /* Handle the -s/--smart options */
 322 {
 323     SmartMode = 1;
 324 }
 325
 326
 327
 328 static void OptTarget (const char* Opt attribute ((unused)), const char* Arg)
 329 /* Set the target system */
 330 {
 331     /* Map the target name to a target id */
 332     Target = FindTarget (Arg);
 333     if (Target == TGT_UNKNOWN) {
 334         AbEnd ("Invalid target name: `%s'", Arg);
 335     } else if (Target == TGT_MODULE) {
 336         AbEnd ("Cannot use `module' as a target for the assembler");
 337     }
 338 }
 339
 340
 341
 342 static void OptVerbose (const char* Opt attribute ((unused)),
 343                         const char* Arg attribute ((unused)))
 344 /* Increase verbosity */
 345 {
 346     ++Verbosity;
 347 }
 348
 349
 350
 351 static void OptVersion (const char* Opt attribute ((unused)),
 352                         const char* Arg attribute ((unused)))
 353 /* Print the assembler version */
 354 {
 355     fprintf (stderr,
 356              "ca65 V%u.%u.%u - %s\n",
 357              VER_MAJOR, VER_MINOR, VER_PATCH, Copyright);
 358 }
 359
 360
 361
 362 static void DoPCAssign (void)
 363 /* Start absolute code */
 364 {
 365     long PC = ConstExpression ();
 366     if (PC < 0 || PC > 0xFFFFFF) {
 367         Error ("Range error");
 368     } else {
 369         SetAbsPC (PC);
 370     }
 371 }
 372
 373
 374
 375 static void OneLine (void)
 376 /* Assemble one line */
 377 {
 378     Segment*      Seg   = 0;
 379     unsigned long PC    = 0;
 380     SymEntry*     Sym   = 0;
 381     int           Done  = 0;
 382     int           Macro = 0;
 383     int           Instr = -1;
 384
 385     /* Initialize the new listing line if we are actually reading from file
 386      * and not from internally pushed input.
 387      */
 388     if (!HavePushedInput ()) {
 389         InitListingLine ();
 390     }
 391
 392     if (Tok == TOK_COLON) {
 393         /* An unnamed label */
 394         ULabDef ();
 395         NextTok ();
 396     }
 397
 398     /* If the first token on the line is an identifier, check for a macro or
 399      * an instruction.
 400      */
 401     if (Tok == TOK_IDENT) {
 402         if (!UbiquitousIdents) {
 403             /* Macros and symbols cannot use instruction names */
 404             Instr = FindInstruction (SVal);
 405             if (Instr < 0) {
 406                 Macro = IsMacro (SVal);
 407             }
 408         } else {
 409             /* Macros and symbols may use the names of instructions */
 410             Macro = IsMacro (SVal);
 411         }
 412     }
 413
 414     /* Handle an identifier */
 415     if (Tok == TOK_LOCAL_IDENT || (Tok == TOK_IDENT && Instr < 0 && !Macro)) {
 416
 417         /* Did we have whitespace before the ident? */
 418         int HadWS = WS;
 419
 420         /* Generate the symbol table entry, then skip the name */
 421         if (Tok == TOK_IDENT) {
 422             Sym = SymFind (CurrentScope, SVal, SYM_ALLOC_NEW);
 423         } else {
 424             Sym = SymFindLocal (SymLast, SVal, SYM_ALLOC_NEW);
 425         }
 426         NextTok ();
 427
 428         /* If a colon follows, this is a label definition. If there
 429          * is no colon, it's an assignment.
 430          */
 431         if (Tok == TOK_EQ || Tok == TOK_ASSIGN) {
 432             /* If it's an assign token, we have a label */
 433             unsigned Flags = (Tok == TOK_ASSIGN)? SF_LABEL : SF_NONE;
 434             /* Skip the '=' */
 435             NextTok ();
 436             /* Define the symbol with the expression following the '=' */
 437             SymDef (Sym, Expression(), ADDR_SIZE_DEFAULT, Flags);
 438             /* Don't allow anything after a symbol definition */
 439             Done = 1;
 440         } else {
 441             /* A label. Remember the current segment, so we can later
 442              * determine the size of the data stored under the label.
 443              */
 444             Seg = ActiveSeg;
 445             PC  = GetPC ();
 446
 447             /* Define the label */
 448             SymDef (Sym, GenCurrentPC (), ADDR_SIZE_DEFAULT, SF_LABEL);
 449
 450             /* Skip the colon. If NoColonLabels is enabled, allow labels
 451              * without a colon if there is no whitespace before the
 452              * identifier.
 453              */
 454             if (Tok != TOK_COLON) {
 455                 if (HadWS || !NoColonLabels) {
 456                     Error ("`:' expected");
 457                     /* Try some smart error recovery */
 458                     if (Tok == TOK_NAMESPACE) {
 459                         NextTok ();
 460                     }
 461                 }
 462             } else {
 463                 /* Skip the colon */
 464                 NextTok ();
 465             }
 466         }
 467     }
 468
 469     if (!Done) {
 470
 471         if (Tok >= TOK_FIRSTPSEUDO && Tok <= TOK_LASTPSEUDO) {
 472             /* A control command */
 473             HandlePseudo ();
 474         } else if (Macro) {
 475             /* A macro expansion */
 476             MacExpandStart ();
 477         } else if (Instr >= 0 ||
 478                    (UbiquitousIdents && ((Instr = FindInstruction (SVal)) >= 0))) {
 479             /* A mnemonic - assemble one instruction */
 480             HandleInstruction (Instr);
 481         } else if (PCAssignment && (Tok == TOK_STAR || Tok == TOK_PC)) {
 482             NextTok ();
 483             if (Tok != TOK_EQ) {
 484                 Error ("`=' expected");
 485                 SkipUntilSep ();
 486             } else {
 487                 /* Skip the equal sign */
 488                 NextTok ();
 489                 /* Enter absolute mode */
 490                 DoPCAssign ();
 491             }
 492         }
 493
 494         /* If we have defined a label, remember its size. Sym is also set by
 495          * a symbol assignment, but in this case Done is false, so we don't
 496          * come here.
 497          */
 498         if (Sym) {
 499             unsigned long Size;
 500             if (Seg == ActiveSeg) {
 501                 /* Same segment */
 502                 Size = GetPC () - PC;
 503             } else {
 504                 /* The line has switched the segment */
 505                 Size = 0;
 506             }
 507             DefSizeOfSymbol (Sym, Size);
 508         }
 509     }
 510
 511     /* Line separator must come here */
 512     ConsumeSep ();
 513 }
 514
 515
 516
 517 static void Assemble (void)
 518 /* Start the ball rolling ... */
 519 {
 520     /* Prime the pump */
 521     NextTok ();
 522
 523     /* Assemble lines until end of file */
 524     while (Tok != TOK_EOF) {
 525         OneLine ();
 526     }
 527 }
 528
 529
 530
 531 static void CreateObjFile (void)
 532 /* Create the object file */
 533 {
 534     /* Open the object, write the header */
 535     ObjOpen ();
 536
 537     /* Write the object file options */
 538     WriteOptions ();
 539
 540     /* Write the list of input files */
 541     WriteFiles ();
 542
 543     /* Write the segment data to the file */
 544     WriteSegments ();
 545
 546     /* Write the import list */
 547     WriteImports ();
 548
 549     /* Write the export list */
 550     WriteExports ();
 551
 552     /* Write debug symbols if requested */
 553     WriteDbgSyms ();
 554
 555     /* Write line infos if requested */
 556     WriteLineInfo ();
 557
 558     /* Write the string pool */
 559     WriteStrPool ();
 560
 561     /* Write the assertions */
 562     WriteAssertions ();
 563
 564     /* Write an updated header and close the file */
 565     ObjClose ();
 566 }
 567
 568
 569
 570 int main (int argc, char* argv [])
 571 /* Assembler main program */
 572 {
 573     /* Program long options */
 574     static const LongOpt OptTab[] = {
 575         { "--auto-import",      0,      OptAutoImport           },
 576         { "--cpu",              1,      OptCPU                  },
 577         { "--debug-info",       0,      OptDebugInfo            },
 578         { "--feature",          1,      OptFeature              },
 579         { "--help",             0,      OptHelp                 },
 580         { "--ignore-case",      0,      OptIgnoreCase           },
 581         { "--include-dir",      1,      OptIncludeDir           },
 582         { "--listing",          0,      OptListing              },
 583         { "--memory-model",     1,      OptMemoryModel          },
 584         { "--pagelength",       1,      OptPageLength           },
 585         { "--smart",            0,      OptSmart                },
 586         { "--target",           1,      OptTarget               },
 587         { "--verbose",          0,      OptVerbose              },
 588         { "--version",          0,      OptVersion              },
 589     };
 590
 591     unsigned I;
 592
 593     /* Initialize the cmdline module */
 594     InitCmdLine (&argc, &argv, "ca65");
 595
 596     /* Enter the base lexical level. We must do that here, since we may
 597      * define symbols using -D.
 598      */
 599     SymEnterLevel ("", ST_GLOBAL, ADDR_SIZE_DEFAULT);
 600
 601     /* Check the parameters */
 602     I = 1;
 603     while (I < ArgCount) {
 604
 605         /* Get the argument */
 606         const char* Arg = ArgVec [I];
 607
 608         /* Check for an option */
 609         if (Arg[0] == '-') {
 610             switch (Arg[1]) {
 611
 612                 case '-':
 613                     LongOption (&I, OptTab, sizeof(OptTab)/sizeof(OptTab[0]));
 614                     break;
 615
 616                 case 'g':
 617                     OptDebugInfo (Arg, 0);
 618                     break;
 619
 620                 case 'h':
 621                     OptHelp (Arg, 0);
 622                     break;
 623
 624                 case 'i':
 625                     OptIgnoreCase (Arg, 0);
 626                     break;
 627
 628                 case 'l':
 629                     OptListing (Arg, 0);
 630                     break;
 631
 632                 case 'm':
 633                     if (Arg[2] == 'm') {
 634                         OptMemoryModel (Arg, GetArg (&I, 3));
 635                     } else {
 636                         UnknownOption (Arg);
 637                     }
 638                     break;
 639
 640                 case 'o':
 641                     OutFile = GetArg (&I, 2);
 642                     break;
 643
 644                 case 's':
 645                     OptSmart (Arg, 0);
 646                     break;
 647
 648                 case 't':
 649                     OptTarget (Arg, GetArg (&I, 2));
 650                     break;
 651
 652                 case 'v':
 653                     OptVerbose (Arg, 0);
 654                     break;
 655
 656                 case 'D':
 657                     DefineSymbol (GetArg (&I, 2));
 658                     break;
 659
 660                 case 'I':
 661                     OptIncludeDir (Arg, GetArg (&I, 2));
 662                     break;
 663
 664                 case 'U':
 665                     OptAutoImport (Arg, 0);
 666                     break;
 667
 668                 case 'V':
 669                     OptVersion (Arg, 0);
 670                     break;
 671
 672                 case 'W':
 673                     WarnLevel = atoi (GetArg (&I, 2));
 674                     break;
 675
 676                 default:
 677                     UnknownOption (Arg);
 678                     break;
 679
 680             }
 681         } else {
 682             /* Filename. Check if we already had one */
 683             if (InFile) {
 684                 fprintf (stderr, "%s: Don't know what to do with `%s'\n",
 685                          ProgName, Arg);
 686                 exit (EXIT_FAILURE);
 687             } else {
 688                 InFile = Arg;
 689             }
 690         }
 691
 692         /* Next argument */
 693         ++I;
 694     }
 695
 696     /* Do we have an input file? */
 697     if (InFile == 0) {
 698         fprintf (stderr, "%s: No input files\n", ProgName);
 699         exit (EXIT_FAILURE);
 700     }
 701
 702     /* If no CPU given, use the default CPU for the target */
 703     if (GetCPU () == CPU_UNKNOWN) {
 704         if (Target != TGT_UNKNOWN) {
 705             SetCPU (DefaultCPU[Target]);
 706         } else {
 707             SetCPU (CPU_6502);
 708         }
 709     }
 710
 711     /* If no memory model was given, use the default */
 712     if (MemoryModel == MMODEL_UNKNOWN) {
 713         SetMemoryModel (MMODEL_NEAR);
 714     }
 715
 716     /* Intialize the target translation tables */
 717     TgtTranslateInit ();
 718
 719     /* Initialize the segments */
 720     InitSegments ();
 721
 722     /* Initialize the scanner, open the input file */
 723     InitScanner (InFile);
 724
 725     /* Define the default options */
 726     SetOptions ();
 727
 728     /* Assemble the input */
 729     Assemble ();
 730
 731     /* If we didn't have any errors, check the segment stack */
 732     if (ErrorCount == 0) {
 733         SegStackCheck ();
 734     }
 735
 736     /* If we didn't have any errors, check the unnamed labels */
 737     if (ErrorCount == 0) {
 738         ULabCheck ();
 739     }
 740
 741     /* If we didn't have any errors, check the symbol table */
 742     if (ErrorCount == 0) {
 743         SymCheck ();
 744     }
 745
 746     /* If we didn't have any errors, check and resolve the segment data */
 747     if (ErrorCount == 0) {
 748         SegCheck ();
 749     }
 750
 751     /* If we didn't have an errors, index the line infos */
 752     MakeLineInfoIndex ();
 753
 754     /* Dump the data */
 755     if (Verbosity >= 2) {
 756         SymDump (stdout);
 757         SegDump ();
 758     }
 759
 760     /* If we didn't have any errors, create the object and listing files */
 761     if (ErrorCount == 0) {
 762         CreateObjFile ();
 763         if (Listing) {
 764             CreateListing ();
 765         }
 766     }
 767
 768     /* Close the input file */
 769     DoneScanner ();
 770
 771     /* Return an apropriate exit code */
 772     return (ErrorCount == 0)? EXIT_SUCCESS : EXIT_FAILURE;
 773 }
 774
 775
 776