1 /*****************************************************************************/
5 /* Main program for the ca65 macroassembler */
9 /* (C) 1998-2013, 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 /*****************************************************************************/
45 #include "debugflag.h"
48 #include "scopedefs.h"
84 /*****************************************************************************/
86 /*****************************************************************************/
90 static void Usage (void)
91 /* Print usage information and exit */
93 printf ("Usage: %s [options] file\n"
95 " -D name[=value]\t\tDefine a symbol\n"
96 " -I dir\t\t\tSet an include directory search path\n"
97 " -U\t\t\t\tMark unresolved symbols as import\n"
98 " -V\t\t\t\tPrint the assembler version\n"
99 " -W n\t\t\t\tSet warning level n\n"
100 " -d\t\t\t\tDebug mode\n"
101 " -g\t\t\t\tAdd debug info to object file\n"
102 " -h\t\t\t\tHelp (this text)\n"
103 " -i\t\t\t\tIgnore case of symbols\n"
104 " -l name\t\t\tCreate a listing file if assembly was ok\n"
105 " -mm model\t\t\tSet the memory model\n"
106 " -o name\t\t\tName the output file\n"
107 " -s\t\t\t\tEnable smart mode\n"
108 " -t sys\t\t\tSet the target system\n"
109 " -v\t\t\t\tIncrease verbosity\n"
112 " --auto-import\t\t\tMark unresolved symbols as import\n"
113 " --bin-include-dir dir\t\tSet a search path for binary includes\n"
114 " --cpu type\t\t\tSet cpu type\n"
115 " --create-dep name\t\tCreate a make dependency file\n"
116 " --create-full-dep name\tCreate a full make dependency file\n"
117 " --debug\t\t\tDebug mode\n"
118 " --debug-info\t\t\tAdd debug info to object file\n"
119 " --feature name\t\tSet an emulation feature\n"
120 " --help\t\t\tHelp (this text)\n"
121 " --ignore-case\t\t\tIgnore case of symbols\n"
122 " --include-dir dir\t\tSet an include directory search path\n"
123 " --large-alignment\t\tDon't warn about large alignments\n"
124 " --listing name\t\tCreate a listing file if assembly was ok\n"
125 " --list-bytes n\t\tMaximum number of bytes per listing line\n"
126 " --macpack-dir dir\t\tSet a macro package directory\n"
127 " --memory-model model\t\tSet the memory model\n"
128 " --pagelength n\t\tSet the page length for the listing\n"
129 " --relax-checks\t\tRelax some checks (see docs)\n"
130 " --smart\t\t\tEnable smart mode\n"
131 " --target sys\t\t\tSet the target system\n"
132 " --verbose\t\t\tIncrease verbosity\n"
133 " --version\t\t\tPrint the assembler version\n",
139 static void SetOptions (void)
140 /* Set the option for the translator */
142 StrBuf Buf = STATIC_STRBUF_INITIALIZER;
144 /* Set the translator */
145 SB_Printf (&Buf, "ca65 V%s", GetVersionAsString ());
146 OptTranslator (&Buf);
148 /* Set date and time */
149 OptDateTime ((unsigned long) time(0));
151 /* Release memory for the string */
157 static void NewSymbol (const char* SymName, long Val)
158 /* Define a symbol with a fixed numeric value in the current scope */
163 /* Convert the name to a string buffer */
164 StrBuf SymBuf = STATIC_STRBUF_INITIALIZER;
165 SB_CopyStr (&SymBuf, SymName);
167 /* Search for the symbol, allocate a new one if it doesn't exist */
168 Sym = SymFind (CurrentScope, &SymBuf, SYM_ALLOC_NEW);
170 /* Check if have already a symbol with this name */
171 if (SymIsDef (Sym)) {
172 AbEnd ("`%s' is already defined", SymName);
175 /* Generate an expression for the symbol */
176 Expr = GenLiteralExpr (Val);
178 /* Mark the symbol as defined */
179 SymDef (Sym, Expr, ADDR_SIZE_DEFAULT, SF_NONE);
181 /* Free string buffer memory */
187 static void CBMSystem (const char* Sys)
188 /* Define a CBM system */
190 NewSymbol ("__CBM__", 1);
196 static void SetSys (const char* Sys)
197 /* Define a target system */
199 switch (Target = FindTarget (Sys)) {
205 AbEnd ("Cannot use `module' as a target for the assembler");
209 NewSymbol ("__ATARI5200__", 1);
213 NewSymbol ("__ATARI__", 1);
217 NewSymbol ("__ATARI__", 1);
218 NewSymbol ("__ATARIXL__", 1);
222 CBMSystem ("__C16__");
226 CBMSystem ("__C64__");
230 CBMSystem ("__VIC20__");
234 CBMSystem ("__C128__");
238 CBMSystem ("__C16__");
239 NewSymbol ("__PLUS4__", 1);
243 CBMSystem ("__CBM510__");
247 CBMSystem ("__CBM610__");
251 CBMSystem ("__PET__");
255 NewSymbol ("__APPLE2__", 1);
259 NewSymbol ("__APPLE2__", 1);
260 NewSymbol ("__APPLE2ENH__", 1);
264 NewSymbol ("__GAMATE__", 1);
268 /* Do not handle as a CBM system */
269 NewSymbol ("__GEOS__", 1);
270 NewSymbol ("__GEOS_CBM__", 1);
274 NewSymbol ("__ATMOS__", 1);
278 NewSymbol ("__BBC__", 1);
281 case TGT_CREATIVISION:
282 NewSymbol ("__CREATIVISION__", 1);
286 NewSymbol ("__GEOS__", 1);
287 NewSymbol ("__GEOS_APPLE__", 1);
291 /* Do not handle as a CBM system */
292 NewSymbol ("__GEOS__", 1);
293 NewSymbol ("__GEOS_CBM__", 1);
297 NewSymbol ("__LUNIX__", 1);
301 NewSymbol ("__LYNX__", 1);
305 NewSymbol ("__NES__", 1);
309 NewSymbol ("__SIM6502__", 1);
313 NewSymbol ("__SIM65C02__", 1);
317 NewSymbol ("__OSIC1P__", 1);
321 NewSymbol ("__PCE__", 1);
324 case TGT_SUPERVISION:
325 NewSymbol ("__SUPERVISION__", 1);
329 AbEnd ("Invalid target name: `%s'", Sys);
333 /* Initialize the translation tables for the target system */
339 static void FileNameOption (const char* Opt, const char* Arg, StrBuf* Name)
340 /* Handle an option that remembers a file name for later */
342 /* Cannot have the option twice */
343 if (SB_NotEmpty (Name)) {
344 AbEnd ("Cannot use option `%s' twice", Opt);
346 /* Remember the file name for later */
347 SB_CopyStr (Name, Arg);
353 static void DefineSymbol (const char* Def)
354 /* Define a symbol from the command line */
358 StrBuf SymName = AUTO_STRBUF_INITIALIZER;
361 /* The symbol must start with a character or underline */
362 if (!IsIdStart (Def [0])) {
367 /* Copy the symbol, checking the rest */
368 while (IsIdChar (*P)) {
369 SB_AppendChar (&SymName, *P++);
371 SB_Terminate (&SymName);
373 /* Do we have a value given? */
380 /* We have a value */
384 if (sscanf (P, "%lx", &Val) != 1) {
388 if (sscanf (P, "%li", &Val) != 1) {
394 /* Define the new symbol */
395 NewSymbol (SB_GetConstBuf (&SymName), Val);
397 /* Release string memory */
403 static void OptAutoImport (const char* Opt attribute ((unused)),
404 const char* Arg attribute ((unused)))
405 /* Mark unresolved symbols as imported */
412 static void OptBinIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
413 /* Add an include search path for binaries */
415 AddSearchPath (BinSearchPath, Arg);
420 static void OptCPU (const char* Opt attribute ((unused)), const char* Arg)
421 /* Handle the --cpu option */
423 cpu_t CPU = FindCPU (Arg);
424 if (CPU == CPU_UNKNOWN) {
425 AbEnd ("Invalid CPU: `%s'", Arg);
433 static void OptCreateDep (const char* Opt, const char* Arg)
434 /* Handle the --create-dep option */
436 FileNameOption (Opt, Arg, &DepName);
441 static void OptCreateFullDep (const char* Opt attribute ((unused)),
443 /* Handle the --create-full-dep option */
445 FileNameOption (Opt, Arg, &FullDepName);
450 static void OptDebug (const char* Opt attribute ((unused)),
451 const char* Arg attribute ((unused)))
452 /* Compiler debug mode */
459 static void OptDebugInfo (const char* Opt attribute ((unused)),
460 const char* Arg attribute ((unused)))
461 /* Add debug info to the object file */
468 static void OptFeature (const char* Opt attribute ((unused)), const char* Arg)
469 /* Set an emulation feature */
471 /* Make a string buffer from Arg */
474 /* Set the feature, check for errors */
475 if (SetFeature (SB_InitFromString (&Feature, Arg)) == FEAT_UNKNOWN) {
476 AbEnd ("Illegal emulation feature: `%s'", Arg);
482 static void OptHelp (const char* Opt attribute ((unused)),
483 const char* Arg attribute ((unused)))
484 /* Print usage information and exit */
492 static void OptIgnoreCase (const char* Opt attribute ((unused)),
493 const char* Arg attribute ((unused)))
494 /* Ignore case on symbols */
501 static void OptIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
502 /* Add an include search path */
504 AddSearchPath (IncSearchPath, Arg);
509 static void OptLargeAlignment (const char* Opt attribute ((unused)),
510 const char* Arg attribute ((unused)))
511 /* Don't warn about large alignments */
518 static void OptListBytes (const char* Opt, const char* Arg)
519 /* Set the maximum number of bytes per listing line */
524 /* Convert the argument to a number */
525 if (sscanf (Arg, "%u%c", &Num, &Check) != 1) {
529 /* Check the bounds */
530 if (Num != 0 && (Num < MIN_LIST_BYTES || Num > MAX_LIST_BYTES)) {
531 AbEnd ("Argument for option `%s' is out of range", Opt);
540 static void OptListing (const char* Opt, const char* Arg)
541 /* Create a listing file */
543 /* Since the meaning of -l and --listing has changed, print an error if
544 ** the filename is empty or begins with the option char.
546 if (Arg == 0 || *Arg == '\0' || *Arg == '-') {
547 Fatal ("The meaning of `%s' has changed. It does now "
548 "expect a file name as argument.", Opt);
551 /* Get the file name */
552 FileNameOption (Opt, Arg, &ListingName);
557 static void OptMemoryModel (const char* Opt, const char* Arg)
558 /* Set the memory model */
562 /* Check the current memory model */
563 if (MemoryModel != MMODEL_UNKNOWN) {
564 AbEnd ("Cannot use option `%s' twice", Opt);
567 /* Translate the memory model name and check it */
568 M = FindMemoryModel (Arg);
569 if (M == MMODEL_UNKNOWN) {
570 AbEnd ("Unknown memory model: %s", Arg);
571 } else if (M == MMODEL_HUGE) {
572 AbEnd ("Unsupported memory model: %s", Arg);
575 /* Set the memory model */
581 static void OptPageLength (const char* Opt attribute ((unused)), const char* Arg)
582 /* Handle the --pagelength option */
584 int Len = atoi (Arg);
585 if (Len != -1 && (Len < MIN_PAGE_LEN || Len > MAX_PAGE_LEN)) {
586 AbEnd ("Invalid page length: %d", Len);
593 static void OptRelaxChecks (const char* Opt attribute ((unused)),
594 const char* Arg attribute ((unused)))
595 /* Handle the --relax-checks options */
602 static void OptSmart (const char* Opt attribute ((unused)),
603 const char* Arg attribute ((unused)))
604 /* Handle the -s/--smart options */
611 static void OptTarget (const char* Opt attribute ((unused)), const char* Arg)
612 /* Set the target system */
619 static void OptVerbose (const char* Opt attribute ((unused)),
620 const char* Arg attribute ((unused)))
621 /* Increase verbosity */
628 static void OptVersion (const char* Opt attribute ((unused)),
629 const char* Arg attribute ((unused)))
630 /* Print the assembler version */
632 fprintf (stderr, "ca65 V%s\n", GetVersionAsString ());
637 static void DoPCAssign (void)
638 /* Start absolute code */
640 long PC = ConstExpression ();
641 if (PC < 0 || PC > 0xFFFFFF) {
642 Error ("Range error");
644 EnterAbsoluteMode (PC);
650 static void OneLine (void)
651 /* Assemble one line */
654 unsigned long PC = 0;
659 /* Initialize the new listing line if we are actually reading from file
660 ** and not from internally pushed input.
662 if (!HavePushedInput ()) {
666 /* Single colon means unnamed label */
667 if (CurTok.Tok == TOK_COLON) {
672 /* If the first token on the line is an identifier, check for a macro or
675 if (CurTok.Tok == TOK_IDENT) {
676 if (UbiquitousIdents) {
677 /* Macros CAN be instructions, so check for them first */
678 Mac = FindMacro (&CurTok.SVal);
680 Instr = FindInstruction (&CurTok.SVal);
683 /* Macros and symbols may NOT use the names of instructions */
684 Instr = FindInstruction (&CurTok.SVal);
686 Mac = FindMacro (&CurTok.SVal);
691 /* Handle an identifier. This may be a cheap local symbol, or a fully
692 ** scoped identifier which may start with a namespace token (for global
695 if (CurTok.Tok == TOK_LOCAL_IDENT ||
696 CurTok.Tok == TOK_NAMESPACE ||
697 (CurTok.Tok == TOK_IDENT && Instr < 0 && Mac == 0)) {
699 /* Did we have whitespace before the ident? */
700 int HadWS = CurTok.WS;
702 /* Generate the symbol table entry, then skip the name */
703 Sym = ParseAnySymName (SYM_ALLOC_NEW);
705 /* If a colon follows, this is a label definition. If there
706 ** is no colon, it's an assignment.
708 if (CurTok.Tok == TOK_EQ || CurTok.Tok == TOK_ASSIGN) {
710 /* Determine the symbol flags from the assignment token */
711 unsigned Flags = (CurTok.Tok == TOK_ASSIGN)? SF_LABEL : SF_NONE;
716 /* Define the symbol with the expression following the '=' */
717 SymDef (Sym, Expression(), ADDR_SIZE_DEFAULT, Flags);
719 /* Don't allow anything after a symbol definition */
723 } else if (CurTok.Tok == TOK_SET) {
727 /* .SET defines variables (= redefinable symbols) */
730 /* Read the assignment expression, which must be constant */
731 Expr = GenLiteralExpr (ConstExpression ());
733 /* Define the symbol with the constant expression following
736 SymDef (Sym, Expr, ADDR_SIZE_DEFAULT, SF_VAR);
738 /* Don't allow anything after a symbol definition */
744 /* A label. Remember the current segment, so we can later
745 ** determine the size of the data stored under the label.
750 /* Define the label */
751 SymDef (Sym, GenCurrentPC (), ADDR_SIZE_DEFAULT, SF_LABEL);
753 /* Skip the colon. If NoColonLabels is enabled, allow labels
754 ** without a colon if there is no whitespace before the
757 if (CurTok.Tok != TOK_COLON) {
758 if (HadWS || !NoColonLabels) {
759 Error ("`:' expected");
760 /* Try some smart error recovery */
761 if (CurTok.Tok == TOK_NAMESPACE) {
770 /* If we come here, a new identifier may be waiting, which may
771 ** be a macro or instruction.
773 if (CurTok.Tok == TOK_IDENT) {
774 if (UbiquitousIdents) {
775 /* Macros CAN be instructions, so check for them first */
776 Mac = FindMacro (&CurTok.SVal);
778 Instr = FindInstruction (&CurTok.SVal);
781 /* Macros and symbols may NOT use the names of instructions */
782 Instr = FindInstruction (&CurTok.SVal);
784 Mac = FindMacro (&CurTok.SVal);
791 /* We've handled a possible label, now handle the remainder of the line */
792 if (CurTok.Tok >= TOK_FIRSTPSEUDO && CurTok.Tok <= TOK_LASTPSEUDO) {
793 /* A control command */
795 } else if (Mac != 0) {
796 /* A macro expansion */
797 MacExpandStart (Mac);
798 } else if (Instr >= 0) {
799 /* A mnemonic - assemble one instruction */
800 HandleInstruction (Instr);
801 } else if (PCAssignment && (CurTok.Tok == TOK_STAR || CurTok.Tok == TOK_PC)) {
803 if (CurTok.Tok != TOK_EQ) {
804 Error ("`=' expected");
807 /* Skip the equal sign */
809 /* Enter absolute mode */
814 /* If we have defined a label, remember its size. Sym is also set by
815 ** a symbol assignment, but in this case Done is false, so we don't
820 if (Seg == ActiveSeg) {
822 Size = GetPC () - PC;
824 /* The line has switched the segment */
827 DefSizeOfSymbol (Sym, Size);
830 /* Line separator must come here */
836 static void Assemble (void)
837 /* Start the ball rolling ... */
842 /* Assemble lines until end of file */
843 while (CurTok.Tok != TOK_EOF) {
850 static void CreateObjFile (void)
851 /* Create the object file */
853 /* Open the object, write the header */
856 /* Write the object file options */
859 /* Write the list of input files */
862 /* Write the segment data to the file */
865 /* Write the import list */
868 /* Write the export list */
871 /* Write debug symbols if requested */
874 /* Write the scopes if requested */
877 /* Write line infos if requested */
880 /* Write the string pool */
883 /* Write the assertions */
886 /* Write the spans */
889 /* Write an updated header and close the file */
895 int main (int argc, char* argv [])
896 /* Assembler main program */
898 /* Program long options */
899 static const LongOpt OptTab[] = {
900 { "--auto-import", 0, OptAutoImport },
901 { "--bin-include-dir", 1, OptBinIncludeDir },
902 { "--cpu", 1, OptCPU },
903 { "--create-dep", 1, OptCreateDep },
904 { "--create-full-dep", 1, OptCreateFullDep },
905 { "--debug", 0, OptDebug },
906 { "--debug-info", 0, OptDebugInfo },
907 { "--feature", 1, OptFeature },
908 { "--help", 0, OptHelp },
909 { "--ignore-case", 0, OptIgnoreCase },
910 { "--include-dir", 1, OptIncludeDir },
911 { "--large-alignment", 0, OptLargeAlignment },
912 { "--list-bytes", 1, OptListBytes },
913 { "--listing", 1, OptListing },
914 { "--memory-model", 1, OptMemoryModel },
915 { "--pagelength", 1, OptPageLength },
916 { "--relax-checks", 0, OptRelaxChecks },
917 { "--smart", 0, OptSmart },
918 { "--target", 1, OptTarget },
919 { "--verbose", 0, OptVerbose },
920 { "--version", 0, OptVersion },
923 /* Name of the global name space */
924 static const StrBuf GlobalNameSpace = STATIC_STRBUF_INITIALIZER;
928 /* Initialize the cmdline module */
929 InitCmdLine (&argc, &argv, "ca65");
931 /* Initialize the string pool */
934 /* Initialize the include search paths */
937 /* Create the predefined segments */
940 /* Enter the base lexical level. We must do that here, since we may
941 ** define symbols using -D.
943 SymEnterLevel (&GlobalNameSpace, SCOPE_FILE, ADDR_SIZE_DEFAULT, 0);
945 /* Initialize the line infos. Must be done here, since we need line infos
946 ** for symbol definitions.
950 /* Check the parameters */
952 while (I < ArgCount) {
954 /* Get the argument */
955 const char* Arg = ArgVec [I];
957 /* Check for an option */
962 LongOption (&I, OptTab, sizeof(OptTab)/sizeof(OptTab[0]));
970 OptDebugInfo (Arg, 0);
978 OptIgnoreCase (Arg, 0);
982 OptListing (Arg, GetArg (&I, 2));
987 OptMemoryModel (Arg, GetArg (&I, 3));
994 OutFile = GetArg (&I, 2);
1002 OptTarget (Arg, GetArg (&I, 2));
1006 OptVerbose (Arg, 0);
1010 DefineSymbol (GetArg (&I, 2));
1014 OptIncludeDir (Arg, GetArg (&I, 2));
1018 OptAutoImport (Arg, 0);
1022 OptVersion (Arg, 0);
1026 WarnLevel = atoi (GetArg (&I, 2));
1030 UnknownOption (Arg);
1035 /* Filename. Check if we already had one */
1037 fprintf (stderr, "%s: Don't know what to do with `%s'\n",
1039 exit (EXIT_FAILURE);
1049 /* Do we have an input file? */
1051 fprintf (stderr, "%s: No input files\n", ProgName);
1052 exit (EXIT_FAILURE);
1055 /* Add the default include search paths. */
1056 FinishIncludePaths ();
1058 /* If no CPU given, use the default CPU for the target */
1059 if (GetCPU () == CPU_UNKNOWN) {
1060 if (Target != TGT_UNKNOWN) {
1061 SetCPU (GetTargetProperties (Target)->DefaultCPU);
1067 /* If no memory model was given, use the default */
1068 if (MemoryModel == MMODEL_UNKNOWN) {
1069 SetMemoryModel (MMODEL_NEAR);
1072 /* Set the default segment sizes according to the memory model */
1075 /* Initialize the scanner, open the input file */
1076 InitScanner (InFile);
1078 /* Define the default options */
1081 /* Assemble the input */
1084 /* If we didn't have any errors, check the pseudo insn stacks */
1085 if (ErrorCount == 0) {
1089 /* If we didn't have any errors, check and cleanup the unnamed labels */
1090 if (ErrorCount == 0) {
1094 /* If we didn't have any errors, check the symbol table */
1095 if (ErrorCount == 0) {
1099 /* If we didn't have any errors, check the hll debug symbols */
1100 if (ErrorCount == 0) {
1104 /* If we didn't have any errors, close the file scope lexical level */
1105 if (ErrorCount == 0) {
1109 /* If we didn't have any errors, check and resolve the segment data */
1110 if (ErrorCount == 0) {
1114 /* If we didn't have any errors, check the assertions */
1115 if (ErrorCount == 0) {
1120 if (Verbosity >= 2) {
1125 /* If we didn't have an errors, finish off the line infos */
1128 /* If we didn't have any errors, create the object, listing and
1131 if (ErrorCount == 0) {
1133 if (SB_GetLen (&ListingName) > 0) {
1136 CreateDependencies ();
1139 /* Close the input file */
1142 /* Return an apropriate exit code */
1143 return (ErrorCount == 0)? EXIT_SUCCESS : EXIT_FAILURE;