1 /*****************************************************************************/
5 /* The scanner for the ca65 macroassembler */
9 /* (C) 1998-2003 Ullrich von Bassewitz */
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 /*****************************************************************************/
41 #include <sys/types.h> /* EMX needs this */
66 /*****************************************************************************/
68 /*****************************************************************************/
72 enum Token Tok = TOK_NONE; /* Current token */
73 int WS; /* Flag: Whitespace before token */
74 long IVal; /* Integer token attribute */
75 char SVal [MAX_STR_LEN+1]; /* String token attribute */
77 FilePos CurPos = { 0, 0, 0 }; /* Name and position in current file */
81 /* Struct to handle include files. Note: The length of the input line may
82 * not exceed 255+1, since the column is stored in the file position struct
83 * as a character. Increasing this value means changing the FilePos struct,
84 * and the read and write routines in the assembler and linker.
86 typedef struct InputFile_ InputFile;
88 FILE* F; /* Input file descriptor */
89 FilePos Pos; /* Position in file */
90 enum Token Tok; /* Last token */
91 int C; /* Last character */
92 char Line[256]; /* The current input line */
93 InputFile* Next; /* Linked list of input files */
96 /* Struct to handle textual input data */
97 typedef struct InputData_ InputData;
99 char* Data; /* Pointer to the data */
100 const char* Pos; /* Pointer to current position */
101 int Malloced; /* Memory was malloced */
102 enum Token Tok; /* Last token */
103 int C; /* Last character */
104 InputData* Next; /* Linked list of input data */
107 /* Current input variables */
108 static InputFile* IFile = 0; /* Current input file */
109 static InputData* IData = 0; /* Current input memory data */
110 static unsigned ICount = 0; /* Count of input files */
111 static int C = 0; /* Current input character */
113 /* Force end of assembly */
116 /* List of dot keywords with the corresponding tokens */
118 const char* Key; /* MUST be first field */
123 { ".ADDR", TOK_ADDR },
124 { ".ALIGN", TOK_ALIGN },
125 { ".AND", TOK_BOOLAND },
126 { ".ASCIIZ", TOK_ASCIIZ },
127 { ".ASSERT", TOK_ASSERT },
128 { ".AUTOIMPORT", TOK_AUTOIMPORT },
129 { ".BITAND", TOK_AND },
130 { ".BITNOT", TOK_NOT },
131 { ".BITOR", TOK_OR },
132 { ".BITXOR", TOK_XOR },
133 { ".BLANK", TOK_BLANK },
135 { ".BYT", TOK_BYTE },
136 { ".BYTE", TOK_BYTE },
137 { ".CASE", TOK_CASE },
138 { ".CHARMAP", TOK_CHARMAP },
139 { ".CODE", TOK_CODE },
140 { ".CONCAT", TOK_CONCAT },
141 { ".CONDES", TOK_CONDES },
142 { ".CONST", TOK_CONST },
143 { ".CONSTRUCTOR", TOK_CONSTRUCTOR },
145 { ".DATA", TOK_DATA },
147 { ".DBYT", TOK_DBYT },
148 { ".DEBUGINFO", TOK_DEBUGINFO },
149 { ".DEF", TOK_DEFINED },
150 { ".DEFINE", TOK_DEFINE },
151 { ".DEFINED", TOK_DEFINED },
152 { ".DESTRUCTOR", TOK_DESTRUCTOR },
153 { ".DWORD", TOK_DWORD },
154 { ".ELSE", TOK_ELSE },
155 { ".ELSEIF", TOK_ELSEIF },
157 { ".ENDIF", TOK_ENDIF },
158 { ".ENDMAC", TOK_ENDMACRO },
159 { ".ENDMACRO", TOK_ENDMACRO },
160 { ".ENDPROC", TOK_ENDPROC },
161 { ".ENDREP", TOK_ENDREP },
162 { ".ENDREPEAT", TOK_ENDREP },
163 { ".ENDSCOPE", TOK_ENDSCOPE },
164 { ".ENDSTRUCT", TOK_ENDSTRUCT },
165 { ".ERROR", TOK_ERROR },
166 { ".EXITMAC", TOK_EXITMACRO },
167 { ".EXITMACRO", TOK_EXITMACRO },
168 { ".EXPORT", TOK_EXPORT },
169 { ".EXPORTZP", TOK_EXPORTZP },
170 { ".FARADDR", TOK_FARADDR },
171 { ".FEATURE", TOK_FEATURE },
172 { ".FILEOPT", TOK_FILEOPT },
173 { ".FOPT", TOK_FILEOPT },
174 { ".FORCEIMPORT", TOK_FORCEIMPORT },
175 { ".FORCEWORD", TOK_FORCEWORD },
176 { ".GLOBAL", TOK_GLOBAL },
177 { ".GLOBALZP", TOK_GLOBALZP },
181 { ".IFBLANK", TOK_IFBLANK },
182 { ".IFCONST", TOK_IFCONST },
183 { ".IFDEF", TOK_IFDEF },
184 { ".IFNBLANK", TOK_IFNBLANK },
185 { ".IFNCONST", TOK_IFNCONST },
186 { ".IFNDEF", TOK_IFNDEF },
187 { ".IFNREF", TOK_IFNREF },
188 { ".IFP02", TOK_IFP02 },
189 { ".IFP816", TOK_IFP816 },
190 { ".IFPC02", TOK_IFPC02 },
191 { ".IFPSC02", TOK_IFPSC02 },
192 { ".IFREF", TOK_IFREF },
193 { ".IMPORT", TOK_IMPORT },
194 { ".IMPORTZP", TOK_IMPORTZP },
195 { ".INCBIN", TOK_INCBIN },
196 { ".INCLUDE", TOK_INCLUDE },
197 { ".LEFT", TOK_LEFT },
198 { ".LINECONT", TOK_LINECONT },
199 { ".LIST", TOK_LIST },
200 { ".LISTBYTES", TOK_LISTBYTES },
201 { ".LOCAL", TOK_LOCAL },
202 { ".LOCALCHAR", TOK_LOCALCHAR },
203 { ".MAC", TOK_MACRO },
204 { ".MACPACK", TOK_MACPACK },
205 { ".MACRO", TOK_MACRO },
206 { ".MATCH", TOK_MATCH },
209 { ".NOT", TOK_BOOLNOT },
210 { ".NULL", TOK_NULL },
211 { ".OR", TOK_BOOLOR },
215 { ".P816", TOK_P816 },
216 { ".PAGELEN", TOK_PAGELENGTH },
217 { ".PAGELENGTH", TOK_PAGELENGTH },
218 { ".PARAMCOUNT", TOK_PARAMCOUNT },
219 { ".PC02", TOK_PC02 },
220 { ".POPSEG", TOK_POPSEG },
221 { ".PROC", TOK_PROC },
222 { ".PSC02", TOK_PSC02 },
223 { ".PUSHSEG", TOK_PUSHSEG },
224 { ".REF", TOK_REFERENCED },
225 { ".REFERENCED", TOK_REFERENCED },
226 { ".RELOC", TOK_RELOC },
227 { ".REPEAT", TOK_REPEAT },
229 { ".RIGHT", TOK_RIGHT },
230 { ".RODATA", TOK_RODATA },
231 { ".SCOPE", TOK_SCOPE },
232 { ".SEGMENT", TOK_SEGMENT },
233 { ".SETCPU", TOK_SETCPU },
236 { ".SMART", TOK_SMART },
237 { ".STRAT", TOK_STRAT },
238 { ".STRING", TOK_STRING },
239 { ".STRLEN", TOK_STRLEN },
240 { ".STRUCT", TOK_STRUCT },
241 { ".SUNPLUS", TOK_SUNPLUS },
243 { ".TCOUNT", TOK_TCOUNT },
244 { ".TIME", TOK_TIME },
245 { ".UNION", TOK_UNION },
246 { ".VERSION", TOK_VERSION },
247 { ".WARNING", TOK_WARNING },
248 { ".WORD", TOK_WORD },
249 { ".XMATCH", TOK_XMATCH },
250 { ".XOR", TOK_BOOLXOR },
251 { ".ZEROPAGE", TOK_ZEROPAGE },
256 /*****************************************************************************/
258 /*****************************************************************************/
262 static void NextChar (void);
263 /* Read the next character from the input file */
267 /*****************************************************************************/
268 /* Character classification functions */
269 /*****************************************************************************/
273 static int IsIdChar (int C)
274 /* Return true if the character is a valid character for an identifier */
276 return IsAlNum (C) ||
278 (C == '@' && AtInIdents) ||
279 (C == '$' && DollarInIdents);
284 static int IsIdStart (int C)
285 /* Return true if the character may start an identifier */
287 return IsAlpha (C) || C == '_';
292 /*****************************************************************************/
294 /*****************************************************************************/
298 void NewInputFile (const char* Name)
299 /* Open a new input file */
304 /* First try to open the file */
305 F = fopen (Name, "r");
310 /* Error (fatal error if this is the main file) */
312 Fatal ("Cannot open input file `%s': %s", Name, strerror (errno));
315 /* We are on include level. Search for the file in the include
318 PathName = FindInclude (Name);
319 if (PathName == 0 || (F = fopen (PathName, "r")) == 0) {
320 /* Not found or cannot open, print an error and bail out */
321 Error ("Cannot open include file `%s': %s", Name, strerror (errno));
324 /* Free the allocated memory */
329 /* check again if we do now have an open file */
334 /* Stat the file and remember the values */
336 if (fstat (fileno (F), &Buf) != 0) {
337 Fatal ("Cannot stat input file `%s': %s", Name, strerror (errno));
340 /* Add the file to the input file table and remember the index */
341 FileIdx = AddFile (Name, Buf.st_size, Buf.st_mtime);
343 /* Create a new state variable and initialize it */
344 I = xmalloc (sizeof (*I));
348 I->Pos.Name = FileIdx;
353 /* Use the new file */
365 void DoneInputFile (void)
366 /* Close the current input file */
370 /* Restore the old token */
374 /* Save a pointer to the current struct, then set it back */
378 /* Cleanup the current stuff */
386 void NewInputData (char* Data, int Malloced)
387 /* Add a chunk of input data to the input stream */
391 /* Create a new state variable and initialize it */
392 I = xmalloc (sizeof (*I));
395 I->Malloced = Malloced;
399 /* Use the new data */
409 static void DoneInputData (void)
410 /* End the current input data stream */
414 /* Restore the old token */
418 /* Save a pointer to the current struct, then set it back */
422 /* Cleanup the current stuff */
431 static unsigned DigitVal (unsigned char C)
432 /* Convert a digit into it's numerical representation */
437 return toupper (C) - 'A' + 10;
443 static void NextChar (void)
444 /* Read the next character from the input file */
446 /* If we have an input data structure, read from there */
451 /* End of input data, will set to last file char */
457 /* Check for end of line, read the next line if needed */
458 while (IFile->Line [IFile->Pos.Col] == '\0') {
460 /* End of current line reached, read next line */
461 if (fgets (IFile->Line, sizeof (IFile->Line), IFile->F) == 0) {
462 /* End of file. Add an empty line to the listing. This is a
463 * small hack needed to keep the PC output in sync.
465 NewListingLine ("", IFile->Pos.Name, ICount);
474 /* Remember the new line for the listing */
475 NewListingLine (IFile->Line, IFile->Pos.Name, ICount);
479 /* Return the next character from the file */
480 C = IFile->Line [IFile->Pos.Col++];
487 void LocaseSVal (void)
488 /* Make SVal lower case */
492 SVal [I] = tolower (SVal [I]);
499 void UpcaseSVal (void)
500 /* Make SVal upper case */
504 SVal [I] = toupper (SVal [I]);
511 static int CmpDotKeyword (const void* K1, const void* K2)
512 /* Compare function for the dot keyword search */
514 return strcmp (((struct DotKeyword*)K1)->Key, ((struct DotKeyword*)K2)->Key);
519 static unsigned char FindDotKeyword (void)
520 /* Find the dot keyword in SVal. Return the corresponding token if found,
521 * return TOK_NONE if not found.
524 static const struct DotKeyword K = { SVal, 0 };
525 struct DotKeyword* R;
527 /* If we aren't in ignore case mode, we have to uppercase the keyword */
532 /* Search for the keyword */
533 R = bsearch (&K, DotKeywords, sizeof (DotKeywords) / sizeof (DotKeywords [0]),
534 sizeof (DotKeywords [0]), CmpDotKeyword);
544 static void ReadIdent (unsigned Index)
545 /* Read an identifier from the current input position into Ident. Filling SVal
546 * starts at Index with the current character in C. It is assumed that any
547 * characters already filled in are ok, and the character in C is checked.
550 /* Read the identifier */
552 if (Index < MAX_STR_LEN) {
556 } while (IsIdChar (C));
559 /* If we should ignore case, convert the identifier to upper case */
567 static unsigned ReadStringConst (int StringTerm)
568 /* Read a string constant into SVal. Check for maximum string length and all
569 * other stuff. The length of the string is returned.
574 /* Skip the leading string terminator */
577 /* Read the string */
580 if (C == StringTerm) {
583 if (C == '\n' || C == EOF) {
584 Error ("Newline in string constant");
588 /* Check for string length, print an error message once */
589 if (I == MAX_STR_LEN) {
590 Error ("Maximum string size exceeded");
591 } else if (I < MAX_STR_LEN) {
596 /* Skip the character */
600 /* Skip the trailing terminator */
603 /* Terminate the string */
604 if (I >= MAX_STR_LEN) {
609 /* Return the length of the string */
615 void NextRawTok (void)
616 /* Read the next raw token from the input stream */
618 /* If we've a forced end of assembly, don't read further */
625 /* Check if we have tokens from another input source */
626 if (InputFromStack ()) {
631 /* Skip whitespace, remember if we had some */
632 if ((WS = IsBlank (C)) != 0) {
635 } while (IsBlank (C));
638 /* If we're reading from the file, update the location from where the
639 * next token will be read. If we're reading from input data, keep the
646 /* Hex number or PC symbol? */
650 /* Hex digit must follow or DollarIsPC must be enabled */
656 Error ("Hexadecimal digit expected");
660 /* Read the number */
662 while (IsXDigit (C)) {
663 if (IVal & 0xF0000000) {
664 Error ("Overflow in hexadecimal number");
667 IVal = (IVal << 4) + DigitVal (C);
671 /* This is an integer constant */
680 /* 0 or 1 must follow */
682 Error ("Binary digit expected");
685 /* Read the number */
687 while (IsBDigit (C)) {
688 if (IVal & 0x80000000) {
689 Error ("Overflow in binary number");
692 IVal = (IVal << 1) + DigitVal (C);
696 /* This is an integer constant */
701 /* Decimal number? */
704 /* Read the number */
706 while (IsDigit (C)) {
707 if (IVal > (long) (0xFFFFFFFFUL / 10)) {
708 Error ("Overflow in decimal number");
711 IVal = (IVal * 10) + DigitVal (C);
715 /* This is an integer constant */
720 /* Control command? */
723 /* Remember and skip the dot */
726 /* Check if it's just a dot */
727 if (!IsIdStart (C)) {
734 /* Read the remainder of the identifier */
738 /* Dot keyword, search for it */
739 Tok = FindDotKeyword ();
740 if (Tok == TOK_NONE) {
742 if (LeadingDotInIdents) {
743 /* An identifier with a dot */
746 /* Invalid pseudo instruction */
747 Error ("`%s' is not a recognized control command", SVal);
757 if (C == LocalStart) {
759 /* Read the identifier */
762 /* Start character alone is not enough */
763 if (SVal [1] == '\0') {
764 Error ("Invalid cheap local symbol");
774 /* Identifier or keyword? */
777 /* Read the identifier */
780 /* Check for special names */
781 if (SVal[1] == '\0') {
782 switch (toupper (SVal [0])) {
787 Tok = TOK_OVERRIDE_ABS;
796 Tok = TOK_OVERRIDE_FAR;
817 Tok = TOK_OVERRIDE_ZP;
829 /* Search for an opcode */
830 IVal = FindInstruction (SVal);
832 /* This is a mnemonic */
834 } else if (IsDefine (SVal)) {
835 /* This is a define style macro - expand it */
845 /* Ok, let's do the switch */
939 while (C != '\n' && C != EOF) {
974 } else if (C == '<') {
977 } else if (C == '>') {
1000 } else if (C == '>') {
1014 /* Hack: If we allow ' as terminating character for strings, read
1015 * the following stuff as a string, and check for a one character
1018 if (LooseStringTerm) {
1019 if (ReadStringConst ('\'') == 1) {
1026 /* Always a character constant */
1028 if (C == '\n' || C == EOF) {
1029 Error ("Illegal character constant");
1036 Error ("Illegal character constant");
1044 ReadStringConst ('\"');
1049 /* Line continuation? */
1053 /* Handle as white space */
1067 /* Check if we have any open .IFs in this file */
1069 /* Check if we have any open token lists in this file */
1072 /* If this was an include file, then close it and handle like a
1073 * separator. Do not close the main file, but return EOF.
1084 /* If we go here, we could not identify the current character. Skip it
1087 Error ("Invalid input character: 0x%02X", C & 0xFF);
1094 int TokHasSVal (enum Token Tok)
1095 /* Return true if the given token has an attached SVal */
1097 return (Tok == TOK_IDENT || Tok == TOK_STRCON);
1102 int TokHasIVal (enum Token Tok)
1103 /* Return true if the given token has an attached IVal */
1105 return (Tok == TOK_INTCON || Tok == TOK_CHARCON || Tok == TOK_MNEMO);
1110 int GetSubKey (const char** Keys, unsigned Count)
1111 /* Search for a subkey in a table of keywords. The current token must be an
1112 * identifier and all keys must be in upper case. The identifier will be
1113 * uppercased in the process. The function returns the index of the keyword,
1114 * or -1 if the keyword was not found.
1119 /* Must have an identifier */
1120 PRECONDITION (Tok == TOK_IDENT);
1122 /* If we aren't in ignore case mode, we have to uppercase the identifier */
1127 /* Do a linear search (a binary search is not worth the effort) */
1128 for (I = 0; I < Count; ++I) {
1129 if (strcmp (SVal, Keys [I]) == 0) {
1141 unsigned char ParseAddrSize (void)
1142 /* Check if the next token is a keyword that denotes an address size specifier.
1143 * If so, return the corresponding address size constant, otherwise output an
1144 * error message and return ADDR_SIZE_DEFAULT.
1147 static const char* Keys[] = {
1148 "DIRECT", "ZEROPAGE", "ZP",
1149 "ABSOLUTE", "ABS", "NEAR",
1153 /* Check for an identifier */
1154 if (Tok != TOK_IDENT) {
1155 Error ("Address size specifier expected");
1156 return ADDR_SIZE_DEFAULT;
1159 /* Search for the attribute */
1160 switch (GetSubKey (Keys, sizeof (Keys) / sizeof (Keys [0]))) {
1163 case 2: return ADDR_SIZE_ZP;
1166 case 5: return ADDR_SIZE_ABS;
1167 case 6: return ADDR_SIZE_FAR;
1169 Error ("Address size specifier expected");
1170 return ADDR_SIZE_DEFAULT;
1176 void InitScanner (const char* InFile)
1177 /* Initialize the scanner, open the given input file */
1179 /* Open the input file */
1180 NewInputFile (InFile);
1185 void DoneScanner (void)
1186 /* Release scanner resources */