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 ("__BBC__", 1);
259 NewSymbol ("__APPLE2__", 1);
263 NewSymbol ("__APPLE2__", 1);
264 NewSymbol ("__APPLE2ENH__", 1);
268 /* Do not handle as a CBM system */
269 NewSymbol ("__GEOS__", 1);
270 NewSymbol ("__GEOS_CBM__", 1);
274 NewSymbol ("__GEOS__", 1);
275 NewSymbol ("__GEOS_APPLE__", 1);
279 NewSymbol ("__LUNIX__", 1);
283 NewSymbol ("__ATMOS__", 1);
287 NewSymbol ("__NES__", 1);
290 case TGT_SUPERVISION:
291 NewSymbol ("__SUPERVISION__", 1);
295 NewSymbol ("__LYNX__", 1);
299 NewSymbol ("__SIM6502__", 1);
303 NewSymbol ("__SIM65C02__", 1);
307 AbEnd ("Invalid target name: `%s'", Sys);
311 /* Initialize the translation tables for the target system */
317 static void FileNameOption (const char* Opt, const char* Arg, StrBuf* Name)
318 /* Handle an option that remembers a file name for later */
320 /* Cannot have the option twice */
321 if (SB_NotEmpty (Name)) {
322 AbEnd ("Cannot use option `%s' twice", Opt);
324 /* Remember the file name for later */
325 SB_CopyStr (Name, Arg);
331 static void DefineSymbol (const char* Def)
332 /* Define a symbol from the command line */
336 StrBuf SymName = AUTO_STRBUF_INITIALIZER;
339 /* The symbol must start with a character or underline */
340 if (!IsIdStart (Def [0])) {
345 /* Copy the symbol, checking the rest */
346 while (IsIdChar (*P)) {
347 SB_AppendChar (&SymName, *P++);
349 SB_Terminate (&SymName);
351 /* Do we have a value given? */
358 /* We have a value */
362 if (sscanf (P, "%lx", &Val) != 1) {
366 if (sscanf (P, "%li", &Val) != 1) {
372 /* Define the new symbol */
373 NewSymbol (SB_GetConstBuf (&SymName), Val);
375 /* Release string memory */
381 static void OptAutoImport (const char* Opt attribute ((unused)),
382 const char* Arg attribute ((unused)))
383 /* Mark unresolved symbols as imported */
390 static void OptBinIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
391 /* Add an include search path for binaries */
393 AddSearchPath (BinSearchPath, Arg);
398 static void OptCPU (const char* Opt attribute ((unused)), const char* Arg)
399 /* Handle the --cpu option */
401 cpu_t CPU = FindCPU (Arg);
402 if (CPU == CPU_UNKNOWN) {
403 AbEnd ("Invalid CPU: `%s'", Arg);
411 static void OptCreateDep (const char* Opt, const char* Arg)
412 /* Handle the --create-dep option */
414 FileNameOption (Opt, Arg, &DepName);
419 static void OptCreateFullDep (const char* Opt attribute ((unused)),
421 /* Handle the --create-full-dep option */
423 FileNameOption (Opt, Arg, &FullDepName);
428 static void OptDebug (const char* Opt attribute ((unused)),
429 const char* Arg attribute ((unused)))
430 /* Compiler debug mode */
437 static void OptDebugInfo (const char* Opt attribute ((unused)),
438 const char* Arg attribute ((unused)))
439 /* Add debug info to the object file */
446 static void OptFeature (const char* Opt attribute ((unused)), const char* Arg)
447 /* Set an emulation feature */
449 /* Make a string buffer from Arg */
452 /* Set the feature, check for errors */
453 if (SetFeature (SB_InitFromString (&Feature, Arg)) == FEAT_UNKNOWN) {
454 AbEnd ("Illegal emulation feature: `%s'", Arg);
460 static void OptHelp (const char* Opt attribute ((unused)),
461 const char* Arg attribute ((unused)))
462 /* Print usage information and exit */
470 static void OptIgnoreCase (const char* Opt attribute ((unused)),
471 const char* Arg attribute ((unused)))
472 /* Ignore case on symbols */
479 static void OptIncludeDir (const char* Opt attribute ((unused)), const char* Arg)
480 /* Add an include search path */
482 AddSearchPath (IncSearchPath, Arg);
487 static void OptLargeAlignment (const char* Opt attribute ((unused)),
488 const char* Arg attribute ((unused)))
489 /* Don't warn about large alignments */
496 static void OptListBytes (const char* Opt, const char* Arg)
497 /* Set the maximum number of bytes per listing line */
502 /* Convert the argument to a number */
503 if (sscanf (Arg, "%u%c", &Num, &Check) != 1) {
507 /* Check the bounds */
508 if (Num != 0 && (Num < MIN_LIST_BYTES || Num > MAX_LIST_BYTES)) {
509 AbEnd ("Argument for option `%s' is out of range", Opt);
518 static void OptListing (const char* Opt, const char* Arg)
519 /* Create a listing file */
521 /* Since the meaning of -l and --listing has changed, print an error if
522 ** the filename is empty or begins with the option char.
524 if (Arg == 0 || *Arg == '\0' || *Arg == '-') {
525 Fatal ("The meaning of `%s' has changed. It does now "
526 "expect a file name as argument.", Opt);
529 /* Get the file name */
530 FileNameOption (Opt, Arg, &ListingName);
535 static void OptMemoryModel (const char* Opt, const char* Arg)
536 /* Set the memory model */
540 /* Check the current memory model */
541 if (MemoryModel != MMODEL_UNKNOWN) {
542 AbEnd ("Cannot use option `%s' twice", Opt);
545 /* Translate the memory model name and check it */
546 M = FindMemoryModel (Arg);
547 if (M == MMODEL_UNKNOWN) {
548 AbEnd ("Unknown memory model: %s", Arg);
549 } else if (M == MMODEL_HUGE) {
550 AbEnd ("Unsupported memory model: %s", Arg);
553 /* Set the memory model */
559 static void OptPageLength (const char* Opt attribute ((unused)), const char* Arg)
560 /* Handle the --pagelength option */
562 int Len = atoi (Arg);
563 if (Len != -1 && (Len < MIN_PAGE_LEN || Len > MAX_PAGE_LEN)) {
564 AbEnd ("Invalid page length: %d", Len);
571 static void OptRelaxChecks (const char* Opt attribute ((unused)),
572 const char* Arg attribute ((unused)))
573 /* Handle the --relax-checks options */
580 static void OptSmart (const char* Opt attribute ((unused)),
581 const char* Arg attribute ((unused)))
582 /* Handle the -s/--smart options */
589 static void OptTarget (const char* Opt attribute ((unused)), const char* Arg)
590 /* Set the target system */
597 static void OptVerbose (const char* Opt attribute ((unused)),
598 const char* Arg attribute ((unused)))
599 /* Increase verbosity */
606 static void OptVersion (const char* Opt attribute ((unused)),
607 const char* Arg attribute ((unused)))
608 /* Print the assembler version */
610 fprintf (stderr, "ca65 V%s\n", GetVersionAsString ());
615 static void DoPCAssign (void)
616 /* Start absolute code */
618 long PC = ConstExpression ();
619 if (PC < 0 || PC > 0xFFFFFF) {
620 Error ("Range error");
622 EnterAbsoluteMode (PC);
628 static void OneLine (void)
629 /* Assemble one line */
632 unsigned long PC = 0;
637 /* Initialize the new listing line if we are actually reading from file
638 ** and not from internally pushed input.
640 if (!HavePushedInput ()) {
644 /* Single colon means unnamed label */
645 if (CurTok.Tok == TOK_COLON) {
650 /* If the first token on the line is an identifier, check for a macro or
653 if (CurTok.Tok == TOK_IDENT) {
654 if (UbiquitousIdents) {
655 /* Macros CAN be instructions, so check for them first */
656 Mac = FindMacro (&CurTok.SVal);
658 Instr = FindInstruction (&CurTok.SVal);
661 /* Macros and symbols may NOT use the names of instructions */
662 Instr = FindInstruction (&CurTok.SVal);
664 Mac = FindMacro (&CurTok.SVal);
669 /* Handle an identifier. This may be a cheap local symbol, or a fully
670 ** scoped identifier which may start with a namespace token (for global
673 if (CurTok.Tok == TOK_LOCAL_IDENT ||
674 CurTok.Tok == TOK_NAMESPACE ||
675 (CurTok.Tok == TOK_IDENT && Instr < 0 && Mac == 0)) {
677 /* Did we have whitespace before the ident? */
678 int HadWS = CurTok.WS;
680 /* Generate the symbol table entry, then skip the name */
681 Sym = ParseAnySymName (SYM_ALLOC_NEW);
683 /* If a colon follows, this is a label definition. If there
684 ** is no colon, it's an assignment.
686 if (CurTok.Tok == TOK_EQ || CurTok.Tok == TOK_ASSIGN) {
688 /* Determine the symbol flags from the assignment token */
689 unsigned Flags = (CurTok.Tok == TOK_ASSIGN)? SF_LABEL : SF_NONE;
694 /* Define the symbol with the expression following the '=' */
695 SymDef (Sym, Expression(), ADDR_SIZE_DEFAULT, Flags);
697 /* Don't allow anything after a symbol definition */
701 } else if (CurTok.Tok == TOK_SET) {
705 /* .SET defines variables (= redefinable symbols) */
708 /* Read the assignment expression, which must be constant */
709 Expr = GenLiteralExpr (ConstExpression ());
711 /* Define the symbol with the constant expression following
714 SymDef (Sym, Expr, ADDR_SIZE_DEFAULT, SF_VAR);
716 /* Don't allow anything after a symbol definition */
722 /* A label. Remember the current segment, so we can later
723 ** determine the size of the data stored under the label.
728 /* Define the label */
729 SymDef (Sym, GenCurrentPC (), ADDR_SIZE_DEFAULT, SF_LABEL);
731 /* Skip the colon. If NoColonLabels is enabled, allow labels
732 ** without a colon if there is no whitespace before the
735 if (CurTok.Tok != TOK_COLON) {
736 if (HadWS || !NoColonLabels) {
737 Error ("`:' expected");
738 /* Try some smart error recovery */
739 if (CurTok.Tok == TOK_NAMESPACE) {
748 /* If we come here, a new identifier may be waiting, which may
749 ** be a macro or instruction.
751 if (CurTok.Tok == TOK_IDENT) {
752 if (UbiquitousIdents) {
753 /* Macros CAN be instructions, so check for them first */
754 Mac = FindMacro (&CurTok.SVal);
756 Instr = FindInstruction (&CurTok.SVal);
759 /* Macros and symbols may NOT use the names of instructions */
760 Instr = FindInstruction (&CurTok.SVal);
762 Mac = FindMacro (&CurTok.SVal);
769 /* We've handled a possible label, now handle the remainder of the line */
770 if (CurTok.Tok >= TOK_FIRSTPSEUDO && CurTok.Tok <= TOK_LASTPSEUDO) {
771 /* A control command */
773 } else if (Mac != 0) {
774 /* A macro expansion */
775 MacExpandStart (Mac);
776 } else if (Instr >= 0) {
777 /* A mnemonic - assemble one instruction */
778 HandleInstruction (Instr);
779 } else if (PCAssignment && (CurTok.Tok == TOK_STAR || CurTok.Tok == TOK_PC)) {
781 if (CurTok.Tok != TOK_EQ) {
782 Error ("`=' expected");
785 /* Skip the equal sign */
787 /* Enter absolute mode */
792 /* If we have defined a label, remember its size. Sym is also set by
793 ** a symbol assignment, but in this case Done is false, so we don't
798 if (Seg == ActiveSeg) {
800 Size = GetPC () - PC;
802 /* The line has switched the segment */
805 DefSizeOfSymbol (Sym, Size);
808 /* Line separator must come here */
814 static void Assemble (void)
815 /* Start the ball rolling ... */
820 /* Assemble lines until end of file */
821 while (CurTok.Tok != TOK_EOF) {
828 static void CreateObjFile (void)
829 /* Create the object file */
831 /* Open the object, write the header */
834 /* Write the object file options */
837 /* Write the list of input files */
840 /* Write the segment data to the file */
843 /* Write the import list */
846 /* Write the export list */
849 /* Write debug symbols if requested */
852 /* Write the scopes if requested */
855 /* Write line infos if requested */
858 /* Write the string pool */
861 /* Write the assertions */
864 /* Write the spans */
867 /* Write an updated header and close the file */
873 int main (int argc, char* argv [])
874 /* Assembler main program */
876 /* Program long options */
877 static const LongOpt OptTab[] = {
878 { "--auto-import", 0, OptAutoImport },
879 { "--bin-include-dir", 1, OptBinIncludeDir },
880 { "--cpu", 1, OptCPU },
881 { "--create-dep", 1, OptCreateDep },
882 { "--create-full-dep", 1, OptCreateFullDep },
883 { "--debug", 0, OptDebug },
884 { "--debug-info", 0, OptDebugInfo },
885 { "--feature", 1, OptFeature },
886 { "--help", 0, OptHelp },
887 { "--ignore-case", 0, OptIgnoreCase },
888 { "--include-dir", 1, OptIncludeDir },
889 { "--large-alignment", 0, OptLargeAlignment },
890 { "--list-bytes", 1, OptListBytes },
891 { "--listing", 1, OptListing },
892 { "--memory-model", 1, OptMemoryModel },
893 { "--pagelength", 1, OptPageLength },
894 { "--relax-checks", 0, OptRelaxChecks },
895 { "--smart", 0, OptSmart },
896 { "--target", 1, OptTarget },
897 { "--verbose", 0, OptVerbose },
898 { "--version", 0, OptVersion },
901 /* Name of the global name space */
902 static const StrBuf GlobalNameSpace = STATIC_STRBUF_INITIALIZER;
906 /* Initialize the cmdline module */
907 InitCmdLine (&argc, &argv, "ca65");
909 /* Initialize the string pool */
912 /* Initialize the include search paths */
915 /* Create the predefined segments */
918 /* Enter the base lexical level. We must do that here, since we may
919 ** define symbols using -D.
921 SymEnterLevel (&GlobalNameSpace, SCOPE_FILE, ADDR_SIZE_DEFAULT, 0);
923 /* Initialize the line infos. Must be done here, since we need line infos
924 ** for symbol definitions.
928 /* Check the parameters */
930 while (I < ArgCount) {
932 /* Get the argument */
933 const char* Arg = ArgVec [I];
935 /* Check for an option */
940 LongOption (&I, OptTab, sizeof(OptTab)/sizeof(OptTab[0]));
948 OptDebugInfo (Arg, 0);
956 OptIgnoreCase (Arg, 0);
960 OptListing (Arg, GetArg (&I, 2));
965 OptMemoryModel (Arg, GetArg (&I, 3));
972 OutFile = GetArg (&I, 2);
980 OptTarget (Arg, GetArg (&I, 2));
988 DefineSymbol (GetArg (&I, 2));
992 OptIncludeDir (Arg, GetArg (&I, 2));
996 OptAutoImport (Arg, 0);
1000 OptVersion (Arg, 0);
1004 WarnLevel = atoi (GetArg (&I, 2));
1008 UnknownOption (Arg);
1013 /* Filename. Check if we already had one */
1015 fprintf (stderr, "%s: Don't know what to do with `%s'\n",
1017 exit (EXIT_FAILURE);
1027 /* Do we have an input file? */
1029 fprintf (stderr, "%s: No input files\n", ProgName);
1030 exit (EXIT_FAILURE);
1033 /* Add the default include search paths. */
1034 FinishIncludePaths ();
1036 /* If no CPU given, use the default CPU for the target */
1037 if (GetCPU () == CPU_UNKNOWN) {
1038 if (Target != TGT_UNKNOWN) {
1039 SetCPU (GetTargetProperties (Target)->DefaultCPU);
1045 /* If no memory model was given, use the default */
1046 if (MemoryModel == MMODEL_UNKNOWN) {
1047 SetMemoryModel (MMODEL_NEAR);
1050 /* Set the default segment sizes according to the memory model */
1053 /* Initialize the scanner, open the input file */
1054 InitScanner (InFile);
1056 /* Define the default options */
1059 /* Assemble the input */
1062 /* If we didn't have any errors, check the pseudo insn stacks */
1063 if (ErrorCount == 0) {
1067 /* If we didn't have any errors, check and cleanup the unnamed labels */
1068 if (ErrorCount == 0) {
1072 /* If we didn't have any errors, check the symbol table */
1073 if (ErrorCount == 0) {
1077 /* If we didn't have any errors, check the hll debug symbols */
1078 if (ErrorCount == 0) {
1082 /* If we didn't have any errors, close the file scope lexical level */
1083 if (ErrorCount == 0) {
1087 /* If we didn't have any errors, check and resolve the segment data */
1088 if (ErrorCount == 0) {
1092 /* If we didn't have any errors, check the assertions */
1093 if (ErrorCount == 0) {
1098 if (Verbosity >= 2) {
1103 /* If we didn't have an errors, finish off the line infos */
1106 /* If we didn't have any errors, create the object, listing and
1109 if (ErrorCount == 0) {
1111 if (SB_GetLen (&ListingName) > 0) {
1114 CreateDependencies ();
1117 /* Close the input file */
1120 /* Return an apropriate exit code */
1121 return (ErrorCount == 0)? EXIT_SUCCESS : EXIT_FAILURE;