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 ("__ATARI__", 1);
213 NewSymbol ("__ATARI__", 1);
214 NewSymbol ("__ATARIXL__", 1);
218 CBMSystem ("__C16__");
222 CBMSystem ("__C64__");
226 CBMSystem ("__VIC20__");
230 CBMSystem ("__C128__");
234 CBMSystem ("__C16__");
235 NewSymbol ("__PLUS4__", 1);
239 CBMSystem ("__CBM510__");
243 CBMSystem ("__CBM610__");
247 CBMSystem ("__PET__");
251 NewSymbol ("__BBC__", 1);
255 NewSymbol ("__APPLE2__", 1);
259 NewSymbol ("__APPLE2__", 1);
260 NewSymbol ("__APPLE2ENH__", 1);
264 /* Do not handle as a CBM system */
265 NewSymbol ("__GEOS__", 1);
266 NewSymbol ("__GEOS_CBM__", 1);
270 NewSymbol ("__GEOS__", 1);
271 NewSymbol ("__GEOS_APPLE__", 1);
275 NewSymbol ("__LUNIX__", 1);
279 NewSymbol ("__ATMOS__", 1);
283 NewSymbol ("__NES__", 1);
286 case TGT_SUPERVISION:
287 NewSymbol ("__SUPERVISION__", 1);
291 NewSymbol ("__LYNX__", 1);
295 NewSymbol ("__SIM6502__", 1);
299 NewSymbol ("__SIM65C02__", 1);
303 AbEnd ("Invalid target name: `%s'", Sys);
307 /* Initialize the translation tables for the target system */
313 static void FileNameOption (const char* Opt, const char* Arg, StrBuf* Name)
314 /* Handle an option that remembers a file name for later */
316 /* Cannot have the option twice */
317 if (SB_NotEmpty (Name)) {
318 AbEnd ("Cannot use option `%s' twice", Opt);
320 /* Remember the file name for later */
321 SB_CopyStr (Name, Arg);
327 static void DefineSymbol (const char* Def)
328 /* Define a symbol from the command line */
332 StrBuf SymName = AUTO_STRBUF_INITIALIZER;
335 /* The symbol must start with a character or underline */
336 if (!IsIdStart (Def [0])) {
341 /* Copy the symbol, checking the rest */
342 while (IsIdChar (*P)) {
343 SB_AppendChar (&SymName, *P++);
345 SB_Terminate (&SymName);
347 /* Do we have a value given? */
354 /* We have a value */
358 if (sscanf (P, "%lx", &Val) != 1) {
362 if (sscanf (P, "%li", &Val) != 1) {
368 /* Define the new symbol */
369 NewSymbol (SB_GetConstBuf (&SymName), Val);
371 /* Release string memory */
377 static void OptAutoImport (const char* Opt attribute ((unused)),
378 const char* Arg attribute ((unused)))
379 /* Mark unresolved symbols as imported */
386 static void OptBinIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
387 /* Add an include search path for binaries */
389 AddSearchPath (BinSearchPath, Arg);
394 static void OptCPU (const char* Opt attribute ((unused)), const char* Arg)
395 /* Handle the --cpu option */
397 cpu_t CPU = FindCPU (Arg);
398 if (CPU == CPU_UNKNOWN) {
399 AbEnd ("Invalid CPU: `%s'", Arg);
407 static void OptCreateDep (const char* Opt, const char* Arg)
408 /* Handle the --create-dep option */
410 FileNameOption (Opt, Arg, &DepName);
415 static void OptCreateFullDep (const char* Opt attribute ((unused)),
417 /* Handle the --create-full-dep option */
419 FileNameOption (Opt, Arg, &FullDepName);
424 static void OptDebug (const char* Opt attribute ((unused)),
425 const char* Arg attribute ((unused)))
426 /* Compiler debug mode */
433 static void OptDebugInfo (const char* Opt attribute ((unused)),
434 const char* Arg attribute ((unused)))
435 /* Add debug info to the object file */
442 static void OptFeature (const char* Opt attribute ((unused)), const char* Arg)
443 /* Set an emulation feature */
445 /* Make a string buffer from Arg */
448 /* Set the feature, check for errors */
449 if (SetFeature (SB_InitFromString (&Feature, Arg)) == FEAT_UNKNOWN) {
450 AbEnd ("Illegal emulation feature: `%s'", Arg);
456 static void OptHelp (const char* Opt attribute ((unused)),
457 const char* Arg attribute ((unused)))
458 /* Print usage information and exit */
466 static void OptIgnoreCase (const char* Opt attribute ((unused)),
467 const char* Arg attribute ((unused)))
468 /* Ignore case on symbols */
475 static void OptIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
476 /* Add an include search path */
478 AddSearchPath (IncSearchPath, Arg);
483 static void OptLargeAlignment (const char* Opt attribute ((unused)),
484 const char* Arg attribute ((unused)))
485 /* Don't warn about large alignments */
492 static void OptListBytes (const char* Opt, const char* Arg)
493 /* Set the maximum number of bytes per listing line */
498 /* Convert the argument to a number */
499 if (sscanf (Arg, "%u%c", &Num, &Check) != 1) {
503 /* Check the bounds */
504 if (Num != 0 && (Num < MIN_LIST_BYTES || Num > MAX_LIST_BYTES)) {
505 AbEnd ("Argument for option `%s' is out of range", Opt);
514 static void OptListing (const char* Opt, const char* Arg)
515 /* Create a listing file */
517 /* Since the meaning of -l and --listing has changed, print an error if
518 * the filename is empty or begins with the option char.
520 if (Arg == 0 || *Arg == '\0' || *Arg == '-') {
521 Fatal ("The meaning of `%s' has changed. It does now "
522 "expect a file name as argument.", Opt);
525 /* Get the file name */
526 FileNameOption (Opt, Arg, &ListingName);
531 static void OptMemoryModel (const char* Opt, const char* Arg)
532 /* Set the memory model */
536 /* Check the current memory model */
537 if (MemoryModel != MMODEL_UNKNOWN) {
538 AbEnd ("Cannot use option `%s' twice", Opt);
541 /* Translate the memory model name and check it */
542 M = FindMemoryModel (Arg);
543 if (M == MMODEL_UNKNOWN) {
544 AbEnd ("Unknown memory model: %s", Arg);
545 } else if (M == MMODEL_HUGE) {
546 AbEnd ("Unsupported memory model: %s", Arg);
549 /* Set the memory model */
555 static void OptPageLength (const char* Opt attribute ((unused)), const char* Arg)
556 /* Handle the --pagelength option */
558 int Len = atoi (Arg);
559 if (Len != -1 && (Len < MIN_PAGE_LEN || Len > MAX_PAGE_LEN)) {
560 AbEnd ("Invalid page length: %d", Len);
567 static void OptRelaxChecks (const char* Opt attribute ((unused)),
568 const char* Arg attribute ((unused)))
569 /* Handle the --relax-checks options */
576 static void OptSmart (const char* Opt attribute ((unused)),
577 const char* Arg attribute ((unused)))
578 /* Handle the -s/--smart options */
585 static void OptTarget (const char* Opt attribute ((unused)), const char* Arg)
586 /* Set the target system */
593 static void OptVerbose (const char* Opt attribute ((unused)),
594 const char* Arg attribute ((unused)))
595 /* Increase verbosity */
602 static void OptVersion (const char* Opt attribute ((unused)),
603 const char* Arg attribute ((unused)))
604 /* Print the assembler version */
606 fprintf (stderr, "ca65 V%s\n", GetVersionAsString ());
611 static void DoPCAssign (void)
612 /* Start absolute code */
614 long PC = ConstExpression ();
615 if (PC < 0 || PC > 0xFFFFFF) {
616 Error ("Range error");
618 EnterAbsoluteMode (PC);
624 static void OneLine (void)
625 /* Assemble one line */
628 unsigned long PC = 0;
633 /* Initialize the new listing line if we are actually reading from file
634 * and not from internally pushed input.
636 if (!HavePushedInput ()) {
640 /* Single colon means unnamed label */
641 if (CurTok.Tok == TOK_COLON) {
646 /* If the first token on the line is an identifier, check for a macro or
649 if (CurTok.Tok == TOK_IDENT) {
650 if (UbiquitousIdents) {
651 /* Macros CAN be instructions, so check for them first */
652 Mac = FindMacro (&CurTok.SVal);
654 Instr = FindInstruction (&CurTok.SVal);
657 /* Macros and symbols may NOT use the names of instructions */
658 Instr = FindInstruction (&CurTok.SVal);
660 Mac = FindMacro (&CurTok.SVal);
665 /* Handle an identifier. This may be a cheap local symbol, or a fully
666 * scoped identifier which may start with a namespace token (for global
669 if (CurTok.Tok == TOK_LOCAL_IDENT ||
670 CurTok.Tok == TOK_NAMESPACE ||
671 (CurTok.Tok == TOK_IDENT && Instr < 0 && Mac == 0)) {
673 /* Did we have whitespace before the ident? */
674 int HadWS = CurTok.WS;
676 /* Generate the symbol table entry, then skip the name */
677 Sym = ParseAnySymName (SYM_ALLOC_NEW);
679 /* If a colon follows, this is a label definition. If there
680 * is no colon, it's an assignment.
682 if (CurTok.Tok == TOK_EQ || CurTok.Tok == TOK_ASSIGN) {
684 /* Determine the symbol flags from the assignment token */
685 unsigned Flags = (CurTok.Tok == TOK_ASSIGN)? SF_LABEL : SF_NONE;
690 /* Define the symbol with the expression following the '=' */
691 SymDef (Sym, Expression(), ADDR_SIZE_DEFAULT, Flags);
693 /* Don't allow anything after a symbol definition */
697 } else if (CurTok.Tok == TOK_SET) {
701 /* .SET defines variables (= redefinable symbols) */
704 /* Read the assignment expression, which must be constant */
705 Expr = GenLiteralExpr (ConstExpression ());
707 /* Define the symbol with the constant expression following
710 SymDef (Sym, Expr, ADDR_SIZE_DEFAULT, SF_VAR);
712 /* Don't allow anything after a symbol definition */
718 /* A label. Remember the current segment, so we can later
719 * determine the size of the data stored under the label.
724 /* Define the label */
725 SymDef (Sym, GenCurrentPC (), ADDR_SIZE_DEFAULT, SF_LABEL);
727 /* Skip the colon. If NoColonLabels is enabled, allow labels
728 * without a colon if there is no whitespace before the
731 if (CurTok.Tok != TOK_COLON) {
732 if (HadWS || !NoColonLabels) {
733 Error ("`:' expected");
734 /* Try some smart error recovery */
735 if (CurTok.Tok == TOK_NAMESPACE) {
744 /* If we come here, a new identifier may be waiting, which may
745 * be a macro or instruction.
747 if (CurTok.Tok == TOK_IDENT) {
748 if (UbiquitousIdents) {
749 /* Macros CAN be instructions, so check for them first */
750 Mac = FindMacro (&CurTok.SVal);
752 Instr = FindInstruction (&CurTok.SVal);
755 /* Macros and symbols may NOT use the names of instructions */
756 Instr = FindInstruction (&CurTok.SVal);
758 Mac = FindMacro (&CurTok.SVal);
765 /* We've handled a possible label, now handle the remainder of the line */
766 if (CurTok.Tok >= TOK_FIRSTPSEUDO && CurTok.Tok <= TOK_LASTPSEUDO) {
767 /* A control command */
769 } else if (Mac != 0) {
770 /* A macro expansion */
771 MacExpandStart (Mac);
772 } else if (Instr >= 0) {
773 /* A mnemonic - assemble one instruction */
774 HandleInstruction (Instr);
775 } else if (PCAssignment && (CurTok.Tok == TOK_STAR || CurTok.Tok == TOK_PC)) {
777 if (CurTok.Tok != TOK_EQ) {
778 Error ("`=' expected");
781 /* Skip the equal sign */
783 /* Enter absolute mode */
788 /* If we have defined a label, remember its size. Sym is also set by
789 * a symbol assignment, but in this case Done is false, so we don't
794 if (Seg == ActiveSeg) {
796 Size = GetPC () - PC;
798 /* The line has switched the segment */
801 DefSizeOfSymbol (Sym, Size);
804 /* Line separator must come here */
810 static void Assemble (void)
811 /* Start the ball rolling ... */
816 /* Assemble lines until end of file */
817 while (CurTok.Tok != TOK_EOF) {
824 static void CreateObjFile (void)
825 /* Create the object file */
827 /* Open the object, write the header */
830 /* Write the object file options */
833 /* Write the list of input files */
836 /* Write the segment data to the file */
839 /* Write the import list */
842 /* Write the export list */
845 /* Write debug symbols if requested */
848 /* Write the scopes if requested */
851 /* Write line infos if requested */
854 /* Write the string pool */
857 /* Write the assertions */
860 /* Write the spans */
863 /* Write an updated header and close the file */
869 int main (int argc, char* argv [])
870 /* Assembler main program */
872 /* Program long options */
873 static const LongOpt OptTab[] = {
874 { "--auto-import", 0, OptAutoImport },
875 { "--bin-include-dir", 1, OptBinIncludeDir },
876 { "--cpu", 1, OptCPU },
877 { "--create-dep", 1, OptCreateDep },
878 { "--create-full-dep", 1, OptCreateFullDep },
879 { "--debug", 0, OptDebug },
880 { "--debug-info", 0, OptDebugInfo },
881 { "--feature", 1, OptFeature },
882 { "--help", 0, OptHelp },
883 { "--ignore-case", 0, OptIgnoreCase },
884 { "--include-dir", 1, OptIncludeDir },
885 { "--large-alignment", 0, OptLargeAlignment },
886 { "--list-bytes", 1, OptListBytes },
887 { "--listing", 1, OptListing },
888 { "--memory-model", 1, OptMemoryModel },
889 { "--pagelength", 1, OptPageLength },
890 { "--relax-checks", 0, OptRelaxChecks },
891 { "--smart", 0, OptSmart },
892 { "--target", 1, OptTarget },
893 { "--verbose", 0, OptVerbose },
894 { "--version", 0, OptVersion },
897 /* Name of the global name space */
898 static const StrBuf GlobalNameSpace = STATIC_STRBUF_INITIALIZER;
902 /* Initialize the cmdline module */
903 InitCmdLine (&argc, &argv, "ca65");
905 /* Initialize the string pool */
908 /* Initialize the include search paths */
911 /* Create the predefined segments */
914 /* Enter the base lexical level. We must do that here, since we may
915 * define symbols using -D.
917 SymEnterLevel (&GlobalNameSpace, SCOPE_FILE, ADDR_SIZE_DEFAULT, 0);
919 /* Initialize the line infos. Must be done here, since we need line infos
920 * for symbol definitions.
924 /* Check the parameters */
926 while (I < ArgCount) {
928 /* Get the argument */
929 const char* Arg = ArgVec [I];
931 /* Check for an option */
936 LongOption (&I, OptTab, sizeof(OptTab)/sizeof(OptTab[0]));
944 OptDebugInfo (Arg, 0);
952 OptIgnoreCase (Arg, 0);
956 OptListing (Arg, GetArg (&I, 2));
961 OptMemoryModel (Arg, GetArg (&I, 3));
968 OutFile = GetArg (&I, 2);
976 OptTarget (Arg, GetArg (&I, 2));
984 DefineSymbol (GetArg (&I, 2));
988 OptIncludeDir (Arg, GetArg (&I, 2));
992 OptAutoImport (Arg, 0);
1000 WarnLevel = atoi (GetArg (&I, 2));
1004 UnknownOption (Arg);
1009 /* Filename. Check if we already had one */
1011 fprintf (stderr, "%s: Don't know what to do with `%s'\n",
1013 exit (EXIT_FAILURE);
1023 /* Do we have an input file? */
1025 fprintf (stderr, "%s: No input files\n", ProgName);
1026 exit (EXIT_FAILURE);
1029 /* Add the default include search paths. */
1030 FinishIncludePaths ();
1032 /* If no CPU given, use the default CPU for the target */
1033 if (GetCPU () == CPU_UNKNOWN) {
1034 if (Target != TGT_UNKNOWN) {
1035 SetCPU (GetTargetProperties (Target)->DefaultCPU);
1041 /* If no memory model was given, use the default */
1042 if (MemoryModel == MMODEL_UNKNOWN) {
1043 SetMemoryModel (MMODEL_NEAR);
1046 /* Set the default segment sizes according to the memory model */
1049 /* Initialize the scanner, open the input file */
1050 InitScanner (InFile);
1052 /* Define the default options */
1055 /* Assemble the input */
1058 /* If we didn't have any errors, check the pseudo insn stacks */
1059 if (ErrorCount == 0) {
1063 /* If we didn't have any errors, check and cleanup the unnamed labels */
1064 if (ErrorCount == 0) {
1068 /* If we didn't have any errors, check the symbol table */
1069 if (ErrorCount == 0) {
1073 /* If we didn't have any errors, check the hll debug symbols */
1074 if (ErrorCount == 0) {
1078 /* If we didn't have any errors, close the file scope lexical level */
1079 if (ErrorCount == 0) {
1083 /* If we didn't have any errors, check and resolve the segment data */
1084 if (ErrorCount == 0) {
1088 /* If we didn't have any errors, check the assertions */
1089 if (ErrorCount == 0) {
1094 if (Verbosity >= 2) {
1099 /* If we didn't have an errors, finish off the line infos */
1102 /* If we didn't have any errors, create the object, listing and
1105 if (ErrorCount == 0) {
1107 if (SB_GetLen (&ListingName) > 0) {
1110 CreateDependencies ();
1113 /* Close the input file */
1116 /* Return an apropriate exit code */
1117 return (ErrorCount == 0)? EXIT_SUCCESS : EXIT_FAILURE;