Replace "the the" with "the"
[external/binutils.git] / opcodes / xc16x-asm.c
1 /* DO NOT EDIT!  -*- buffer-read-only: t -*- vi:set ro:  */
2 /* Assembler interface for targets using CGEN. -*- C -*-
3    CGEN: Cpu tools GENerator
4
5    THIS FILE IS MACHINE GENERATED WITH CGEN.
6    - the resultant file is machine generated, cgen-asm.in isn't
7
8    Copyright (C) 1996-2019 Free Software Foundation, Inc.
9
10    This file is part of libopcodes.
11
12    This library is free software; you can redistribute it and/or modify
13    it under the terms of the GNU General Public License as published by
14    the Free Software Foundation; either version 3, or (at your option)
15    any later version.
16
17    It is distributed in the hope that it will be useful, but WITHOUT
18    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
20    License for more details.
21
22    You should have received a copy of the GNU General Public License
23    along with this program; if not, write to the Free Software Foundation, Inc.,
24    51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
25
26
27 /* ??? Eventually more and more of this stuff can go to cpu-independent files.
28    Keep that in mind.  */
29
30 #include "sysdep.h"
31 #include <stdio.h>
32 #include "ansidecl.h"
33 #include "bfd.h"
34 #include "symcat.h"
35 #include "xc16x-desc.h"
36 #include "xc16x-opc.h"
37 #include "opintl.h"
38 #include "xregex.h"
39 #include "libiberty.h"
40 #include "safe-ctype.h"
41
42 #undef  min
43 #define min(a,b) ((a) < (b) ? (a) : (b))
44 #undef  max
45 #define max(a,b) ((a) > (b) ? (a) : (b))
46
47 static const char * parse_insn_normal
48   (CGEN_CPU_DESC, const CGEN_INSN *, const char **, CGEN_FIELDS *);
49 \f
50 /* -- assembler routines inserted here.  */
51
52 /* -- asm.c */
53 /* Handle '#' prefixes (i.e. skip over them).  */
54
55 static const char *
56 parse_hash (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
57             const char **strp,
58             int opindex ATTRIBUTE_UNUSED,
59             long *valuep ATTRIBUTE_UNUSED)
60 {
61   if (**strp == '#')
62     {
63       ++*strp;
64       return NULL;
65     }
66   return _("Missing '#' prefix");
67 }
68
69 /* Handle '.' prefixes (i.e. skip over them).  */
70
71 static const char *
72 parse_dot (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
73            const char **strp,
74            int opindex ATTRIBUTE_UNUSED,
75            long *valuep ATTRIBUTE_UNUSED)
76 {
77   if (**strp == '.')
78     {
79       ++*strp;
80       return NULL;
81     }
82   return _("Missing '.' prefix");
83 }
84
85 /* Handle 'pof:' prefixes (i.e. skip over them).  */
86
87 static const char *
88 parse_pof (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
89            const char **strp,
90            int opindex ATTRIBUTE_UNUSED,
91            long *valuep ATTRIBUTE_UNUSED)
92 {
93   if (strncasecmp (*strp, "pof:", 4) == 0)
94     {
95       *strp += 4;
96       return NULL;
97     }
98   return _("Missing 'pof:' prefix");
99 }
100
101 /* Handle 'pag:' prefixes (i.e. skip over them).  */
102
103 static const char *
104 parse_pag (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
105            const char **strp,
106            int opindex ATTRIBUTE_UNUSED,
107            long *valuep ATTRIBUTE_UNUSED)
108 {
109   if (strncasecmp (*strp, "pag:", 4) == 0)
110     {
111       *strp += 4;
112       return NULL;
113     }
114   return _("Missing 'pag:' prefix");
115 }
116
117 /* Handle 'sof' prefixes (i.e. skip over them).  */
118
119 static const char *
120 parse_sof (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
121            const char **strp,
122            int opindex ATTRIBUTE_UNUSED,
123            long *valuep ATTRIBUTE_UNUSED)
124 {
125   if (strncasecmp (*strp, "sof:", 4) == 0)
126     {
127       *strp += 4;
128       return NULL;
129     }
130   return _("Missing 'sof:' prefix");
131 }
132
133 /* Handle 'seg' prefixes (i.e. skip over them).  */
134
135 static const char *
136 parse_seg (CGEN_CPU_DESC cd ATTRIBUTE_UNUSED,
137            const char **strp,
138            int opindex ATTRIBUTE_UNUSED,
139            long *valuep ATTRIBUTE_UNUSED)
140 {
141   if (strncasecmp (*strp, "seg:", 4) == 0)
142     {
143       *strp += 4;
144       return NULL;
145     }
146   return _("Missing 'seg:' prefix");
147 }
148 /* -- */
149
150 const char * xc16x_cgen_parse_operand
151   (CGEN_CPU_DESC, int, const char **, CGEN_FIELDS *);
152
153 /* Main entry point for operand parsing.
154
155    This function is basically just a big switch statement.  Earlier versions
156    used tables to look up the function to use, but
157    - if the table contains both assembler and disassembler functions then
158      the disassembler contains much of the assembler and vice-versa,
159    - there's a lot of inlining possibilities as things grow,
160    - using a switch statement avoids the function call overhead.
161
162    This function could be moved into `parse_insn_normal', but keeping it
163    separate makes clear the interface between `parse_insn_normal' and each of
164    the handlers.  */
165
166 const char *
167 xc16x_cgen_parse_operand (CGEN_CPU_DESC cd,
168                            int opindex,
169                            const char ** strp,
170                            CGEN_FIELDS * fields)
171 {
172   const char * errmsg = NULL;
173   /* Used by scalar operands that still need to be parsed.  */
174   long junk ATTRIBUTE_UNUSED;
175
176   switch (opindex)
177     {
178     case XC16X_OPERAND_REGNAM :
179       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_psw_names, & fields->f_reg8);
180       break;
181     case XC16X_OPERAND_BIT01 :
182       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_BIT01, (unsigned long *) (& fields->f_op_1bit));
183       break;
184     case XC16X_OPERAND_BIT1 :
185       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_BIT1, (unsigned long *) (& fields->f_op_bit1));
186       break;
187     case XC16X_OPERAND_BIT2 :
188       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_BIT2, (unsigned long *) (& fields->f_op_bit2));
189       break;
190     case XC16X_OPERAND_BIT4 :
191       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_BIT4, (unsigned long *) (& fields->f_op_bit4));
192       break;
193     case XC16X_OPERAND_BIT8 :
194       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_BIT8, (unsigned long *) (& fields->f_op_bit8));
195       break;
196     case XC16X_OPERAND_BITONE :
197       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_BITONE, (unsigned long *) (& fields->f_op_onebit));
198       break;
199     case XC16X_OPERAND_CADDR :
200       {
201         bfd_vma value = 0;
202         errmsg = cgen_parse_address (cd, strp, XC16X_OPERAND_CADDR, 0, NULL,  & value);
203         fields->f_offset16 = value;
204       }
205       break;
206     case XC16X_OPERAND_COND :
207       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_conditioncode_names, & fields->f_condcode);
208       break;
209     case XC16X_OPERAND_DATA8 :
210       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_DATA8, (unsigned long *) (& fields->f_data8));
211       break;
212     case XC16X_OPERAND_DATAHI8 :
213       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_DATAHI8, (unsigned long *) (& fields->f_datahi8));
214       break;
215     case XC16X_OPERAND_DOT :
216       errmsg = parse_dot (cd, strp, XC16X_OPERAND_DOT, (long *) (& junk));
217       break;
218     case XC16X_OPERAND_DR :
219       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_gr_names, & fields->f_r1);
220       break;
221     case XC16X_OPERAND_DRB :
222       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_grb_names, & fields->f_r1);
223       break;
224     case XC16X_OPERAND_DRI :
225       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_gr_names, & fields->f_r4);
226       break;
227     case XC16X_OPERAND_EXTCOND :
228       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_extconditioncode_names, & fields->f_extccode);
229       break;
230     case XC16X_OPERAND_GENREG :
231       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_r8_names, & fields->f_regb8);
232       break;
233     case XC16X_OPERAND_HASH :
234       errmsg = parse_hash (cd, strp, XC16X_OPERAND_HASH, (long *) (& junk));
235       break;
236     case XC16X_OPERAND_ICOND :
237       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_conditioncode_names, & fields->f_icondcode);
238       break;
239     case XC16X_OPERAND_LBIT2 :
240       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_LBIT2, (unsigned long *) (& fields->f_op_lbit2));
241       break;
242     case XC16X_OPERAND_LBIT4 :
243       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_LBIT4, (unsigned long *) (& fields->f_op_lbit4));
244       break;
245     case XC16X_OPERAND_MASK8 :
246       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_MASK8, (unsigned long *) (& fields->f_mask8));
247       break;
248     case XC16X_OPERAND_MASKLO8 :
249       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_MASKLO8, (unsigned long *) (& fields->f_datahi8));
250       break;
251     case XC16X_OPERAND_MEMGR8 :
252       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_memgr8_names, & fields->f_memgr8);
253       break;
254     case XC16X_OPERAND_MEMORY :
255       {
256         bfd_vma value = 0;
257         errmsg = cgen_parse_address (cd, strp, XC16X_OPERAND_MEMORY, 0, NULL,  & value);
258         fields->f_memory = value;
259       }
260       break;
261     case XC16X_OPERAND_PAG :
262       errmsg = parse_pag (cd, strp, XC16X_OPERAND_PAG, (long *) (& junk));
263       break;
264     case XC16X_OPERAND_PAGENUM :
265       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_PAGENUM, (unsigned long *) (& fields->f_pagenum));
266       break;
267     case XC16X_OPERAND_POF :
268       errmsg = parse_pof (cd, strp, XC16X_OPERAND_POF, (long *) (& junk));
269       break;
270     case XC16X_OPERAND_QBIT :
271       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_QBIT, (unsigned long *) (& fields->f_qbit));
272       break;
273     case XC16X_OPERAND_QHIBIT :
274       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_QHIBIT, (unsigned long *) (& fields->f_qhibit));
275       break;
276     case XC16X_OPERAND_QLOBIT :
277       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_QLOBIT, (unsigned long *) (& fields->f_qlobit));
278       break;
279     case XC16X_OPERAND_REG8 :
280       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_r8_names, & fields->f_reg8);
281       break;
282     case XC16X_OPERAND_REGB8 :
283       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_grb8_names, & fields->f_regb8);
284       break;
285     case XC16X_OPERAND_REGBMEM8 :
286       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_regbmem8_names, & fields->f_regmem8);
287       break;
288     case XC16X_OPERAND_REGHI8 :
289       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_r8_names, & fields->f_reghi8);
290       break;
291     case XC16X_OPERAND_REGMEM8 :
292       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_regmem8_names, & fields->f_regmem8);
293       break;
294     case XC16X_OPERAND_REGOFF8 :
295       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_r8_names, & fields->f_regoff8);
296       break;
297     case XC16X_OPERAND_REL :
298       errmsg = cgen_parse_signed_integer (cd, strp, XC16X_OPERAND_REL, (long *) (& fields->f_rel8));
299       break;
300     case XC16X_OPERAND_RELHI :
301       errmsg = cgen_parse_signed_integer (cd, strp, XC16X_OPERAND_RELHI, (long *) (& fields->f_relhi8));
302       break;
303     case XC16X_OPERAND_SEG :
304       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_SEG, (unsigned long *) (& fields->f_seg8));
305       break;
306     case XC16X_OPERAND_SEGHI8 :
307       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_SEGHI8, (unsigned long *) (& fields->f_segnum8));
308       break;
309     case XC16X_OPERAND_SEGM :
310       errmsg = parse_seg (cd, strp, XC16X_OPERAND_SEGM, (long *) (& junk));
311       break;
312     case XC16X_OPERAND_SOF :
313       errmsg = parse_sof (cd, strp, XC16X_OPERAND_SOF, (long *) (& junk));
314       break;
315     case XC16X_OPERAND_SR :
316       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_gr_names, & fields->f_r2);
317       break;
318     case XC16X_OPERAND_SR2 :
319       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_gr_names, & fields->f_r0);
320       break;
321     case XC16X_OPERAND_SRB :
322       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_grb_names, & fields->f_r2);
323       break;
324     case XC16X_OPERAND_SRC1 :
325       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_gr_names, & fields->f_r1);
326       break;
327     case XC16X_OPERAND_SRC2 :
328       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_gr_names, & fields->f_r2);
329       break;
330     case XC16X_OPERAND_SRDIV :
331       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_regdiv8_names, & fields->f_reg8);
332       break;
333     case XC16X_OPERAND_U4 :
334       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_reg0_name, & fields->f_uimm4);
335       break;
336     case XC16X_OPERAND_UIMM16 :
337       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_UIMM16, (unsigned long *) (& fields->f_uimm16));
338       break;
339     case XC16X_OPERAND_UIMM2 :
340       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_ext_names, & fields->f_uimm2);
341       break;
342     case XC16X_OPERAND_UIMM3 :
343       errmsg = cgen_parse_keyword (cd, strp, & xc16x_cgen_opval_reg0_name1, & fields->f_uimm3);
344       break;
345     case XC16X_OPERAND_UIMM4 :
346       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_UIMM4, (unsigned long *) (& fields->f_uimm4));
347       break;
348     case XC16X_OPERAND_UIMM7 :
349       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_UIMM7, (unsigned long *) (& fields->f_uimm7));
350       break;
351     case XC16X_OPERAND_UIMM8 :
352       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_UIMM8, (unsigned long *) (& fields->f_uimm8));
353       break;
354     case XC16X_OPERAND_UPAG16 :
355       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_UPAG16, (unsigned long *) (& fields->f_uimm16));
356       break;
357     case XC16X_OPERAND_UPOF16 :
358       {
359         bfd_vma value = 0;
360         errmsg = cgen_parse_address (cd, strp, XC16X_OPERAND_UPOF16, 0, NULL,  & value);
361         fields->f_memory = value;
362       }
363       break;
364     case XC16X_OPERAND_USEG16 :
365       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_USEG16, (unsigned long *) (& fields->f_offset16));
366       break;
367     case XC16X_OPERAND_USEG8 :
368       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_USEG8, (unsigned long *) (& fields->f_seg8));
369       break;
370     case XC16X_OPERAND_USOF16 :
371       errmsg = cgen_parse_unsigned_integer (cd, strp, XC16X_OPERAND_USOF16, (unsigned long *) (& fields->f_offset16));
372       break;
373
374     default :
375       /* xgettext:c-format */
376       opcodes_error_handler
377         (_("internal error: unrecognized field %d while parsing"),
378          opindex);
379       abort ();
380   }
381
382   return errmsg;
383 }
384
385 cgen_parse_fn * const xc16x_cgen_parse_handlers[] =
386 {
387   parse_insn_normal,
388 };
389
390 void
391 xc16x_cgen_init_asm (CGEN_CPU_DESC cd)
392 {
393   xc16x_cgen_init_opcode_table (cd);
394   xc16x_cgen_init_ibld_table (cd);
395   cd->parse_handlers = & xc16x_cgen_parse_handlers[0];
396   cd->parse_operand = xc16x_cgen_parse_operand;
397 #ifdef CGEN_ASM_INIT_HOOK
398 CGEN_ASM_INIT_HOOK
399 #endif
400 }
401
402 \f
403
404 /* Regex construction routine.
405
406    This translates an opcode syntax string into a regex string,
407    by replacing any non-character syntax element (such as an
408    opcode) with the pattern '.*'
409
410    It then compiles the regex and stores it in the opcode, for
411    later use by xc16x_cgen_assemble_insn
412
413    Returns NULL for success, an error message for failure.  */
414
415 char *
416 xc16x_cgen_build_insn_regex (CGEN_INSN *insn)
417 {
418   CGEN_OPCODE *opc = (CGEN_OPCODE *) CGEN_INSN_OPCODE (insn);
419   const char *mnem = CGEN_INSN_MNEMONIC (insn);
420   char rxbuf[CGEN_MAX_RX_ELEMENTS];
421   char *rx = rxbuf;
422   const CGEN_SYNTAX_CHAR_TYPE *syn;
423   int reg_err;
424
425   syn = CGEN_SYNTAX_STRING (CGEN_OPCODE_SYNTAX (opc));
426
427   /* Mnemonics come first in the syntax string.  */
428   if (! CGEN_SYNTAX_MNEMONIC_P (* syn))
429     return _("missing mnemonic in syntax string");
430   ++syn;
431
432   /* Generate a case sensitive regular expression that emulates case
433      insensitive matching in the "C" locale.  We cannot generate a case
434      insensitive regular expression because in Turkish locales, 'i' and 'I'
435      are not equal modulo case conversion.  */
436
437   /* Copy the literal mnemonic out of the insn.  */
438   for (; *mnem; mnem++)
439     {
440       char c = *mnem;
441
442       if (ISALPHA (c))
443         {
444           *rx++ = '[';
445           *rx++ = TOLOWER (c);
446           *rx++ = TOUPPER (c);
447           *rx++ = ']';
448         }
449       else
450         *rx++ = c;
451     }
452
453   /* Copy any remaining literals from the syntax string into the rx.  */
454   for(; * syn != 0 && rx <= rxbuf + (CGEN_MAX_RX_ELEMENTS - 7 - 4); ++syn)
455     {
456       if (CGEN_SYNTAX_CHAR_P (* syn))
457         {
458           char c = CGEN_SYNTAX_CHAR (* syn);
459
460           switch (c)
461             {
462               /* Escape any regex metacharacters in the syntax.  */
463             case '.': case '[': case '\\':
464             case '*': case '^': case '$':
465
466 #ifdef CGEN_ESCAPE_EXTENDED_REGEX
467             case '?': case '{': case '}':
468             case '(': case ')': case '*':
469             case '|': case '+': case ']':
470 #endif
471               *rx++ = '\\';
472               *rx++ = c;
473               break;
474
475             default:
476               if (ISALPHA (c))
477                 {
478                   *rx++ = '[';
479                   *rx++ = TOLOWER (c);
480                   *rx++ = TOUPPER (c);
481                   *rx++ = ']';
482                 }
483               else
484                 *rx++ = c;
485               break;
486             }
487         }
488       else
489         {
490           /* Replace non-syntax fields with globs.  */
491           *rx++ = '.';
492           *rx++ = '*';
493         }
494     }
495
496   /* Trailing whitespace ok.  */
497   * rx++ = '[';
498   * rx++ = ' ';
499   * rx++ = '\t';
500   * rx++ = ']';
501   * rx++ = '*';
502
503   /* But anchor it after that.  */
504   * rx++ = '$';
505   * rx = '\0';
506
507   CGEN_INSN_RX (insn) = xmalloc (sizeof (regex_t));
508   reg_err = regcomp ((regex_t *) CGEN_INSN_RX (insn), rxbuf, REG_NOSUB);
509
510   if (reg_err == 0)
511     return NULL;
512   else
513     {
514       static char msg[80];
515
516       regerror (reg_err, (regex_t *) CGEN_INSN_RX (insn), msg, 80);
517       regfree ((regex_t *) CGEN_INSN_RX (insn));
518       free (CGEN_INSN_RX (insn));
519       (CGEN_INSN_RX (insn)) = NULL;
520       return msg;
521     }
522 }
523
524 \f
525 /* Default insn parser.
526
527    The syntax string is scanned and operands are parsed and stored in FIELDS.
528    Relocs are queued as we go via other callbacks.
529
530    ??? Note that this is currently an all-or-nothing parser.  If we fail to
531    parse the instruction, we return 0 and the caller will start over from
532    the beginning.  Backtracking will be necessary in parsing subexpressions,
533    but that can be handled there.  Not handling backtracking here may get
534    expensive in the case of the m68k.  Deal with later.
535
536    Returns NULL for success, an error message for failure.  */
537
538 static const char *
539 parse_insn_normal (CGEN_CPU_DESC cd,
540                    const CGEN_INSN *insn,
541                    const char **strp,
542                    CGEN_FIELDS *fields)
543 {
544   /* ??? Runtime added insns not handled yet.  */
545   const CGEN_SYNTAX *syntax = CGEN_INSN_SYNTAX (insn);
546   const char *str = *strp;
547   const char *errmsg;
548   const char *p;
549   const CGEN_SYNTAX_CHAR_TYPE * syn;
550 #ifdef CGEN_MNEMONIC_OPERANDS
551   /* FIXME: wip */
552   int past_opcode_p;
553 #endif
554
555   /* For now we assume the mnemonic is first (there are no leading operands).
556      We can parse it without needing to set up operand parsing.
557      GAS's input scrubber will ensure mnemonics are lowercase, but we may
558      not be called from GAS.  */
559   p = CGEN_INSN_MNEMONIC (insn);
560   while (*p && TOLOWER (*p) == TOLOWER (*str))
561     ++p, ++str;
562
563   if (* p)
564     return _("unrecognized instruction");
565
566 #ifndef CGEN_MNEMONIC_OPERANDS
567   if (* str && ! ISSPACE (* str))
568     return _("unrecognized instruction");
569 #endif
570
571   CGEN_INIT_PARSE (cd);
572   cgen_init_parse_operand (cd);
573 #ifdef CGEN_MNEMONIC_OPERANDS
574   past_opcode_p = 0;
575 #endif
576
577   /* We don't check for (*str != '\0') here because we want to parse
578      any trailing fake arguments in the syntax string.  */
579   syn = CGEN_SYNTAX_STRING (syntax);
580
581   /* Mnemonics come first for now, ensure valid string.  */
582   if (! CGEN_SYNTAX_MNEMONIC_P (* syn))
583     abort ();
584
585   ++syn;
586
587   while (* syn != 0)
588     {
589       /* Non operand chars must match exactly.  */
590       if (CGEN_SYNTAX_CHAR_P (* syn))
591         {
592           /* FIXME: While we allow for non-GAS callers above, we assume the
593              first char after the mnemonic part is a space.  */
594           /* FIXME: We also take inappropriate advantage of the fact that
595              GAS's input scrubber will remove extraneous blanks.  */
596           if (TOLOWER (*str) == TOLOWER (CGEN_SYNTAX_CHAR (* syn)))
597             {
598 #ifdef CGEN_MNEMONIC_OPERANDS
599               if (CGEN_SYNTAX_CHAR(* syn) == ' ')
600                 past_opcode_p = 1;
601 #endif
602               ++ syn;
603               ++ str;
604             }
605           else if (*str)
606             {
607               /* Syntax char didn't match.  Can't be this insn.  */
608               static char msg [80];
609
610               /* xgettext:c-format */
611               sprintf (msg, _("syntax error (expected char `%c', found `%c')"),
612                        CGEN_SYNTAX_CHAR(*syn), *str);
613               return msg;
614             }
615           else
616             {
617               /* Ran out of input.  */
618               static char msg [80];
619
620               /* xgettext:c-format */
621               sprintf (msg, _("syntax error (expected char `%c', found end of instruction)"),
622                        CGEN_SYNTAX_CHAR(*syn));
623               return msg;
624             }
625           continue;
626         }
627
628 #ifdef CGEN_MNEMONIC_OPERANDS
629       (void) past_opcode_p;
630 #endif
631       /* We have an operand of some sort.  */
632       errmsg = cd->parse_operand (cd, CGEN_SYNTAX_FIELD (*syn), &str, fields);
633       if (errmsg)
634         return errmsg;
635
636       /* Done with this operand, continue with next one.  */
637       ++ syn;
638     }
639
640   /* If we're at the end of the syntax string, we're done.  */
641   if (* syn == 0)
642     {
643       /* FIXME: For the moment we assume a valid `str' can only contain
644          blanks now.  IE: We needn't try again with a longer version of
645          the insn and it is assumed that longer versions of insns appear
646          before shorter ones (eg: lsr r2,r3,1 vs lsr r2,r3).  */
647       while (ISSPACE (* str))
648         ++ str;
649
650       if (* str != '\0')
651         return _("junk at end of line"); /* FIXME: would like to include `str' */
652
653       return NULL;
654     }
655
656   /* We couldn't parse it.  */
657   return _("unrecognized instruction");
658 }
659 \f
660 /* Main entry point.
661    This routine is called for each instruction to be assembled.
662    STR points to the insn to be assembled.
663    We assume all necessary tables have been initialized.
664    The assembled instruction, less any fixups, is stored in BUF.
665    Remember that if CGEN_INT_INSN_P then BUF is an int and thus the value
666    still needs to be converted to target byte order, otherwise BUF is an array
667    of bytes in target byte order.
668    The result is a pointer to the insn's entry in the opcode table,
669    or NULL if an error occured (an error message will have already been
670    printed).
671
672    Note that when processing (non-alias) macro-insns,
673    this function recurses.
674
675    ??? It's possible to make this cpu-independent.
676    One would have to deal with a few minor things.
677    At this point in time doing so would be more of a curiosity than useful
678    [for example this file isn't _that_ big], but keeping the possibility in
679    mind helps keep the design clean.  */
680
681 const CGEN_INSN *
682 xc16x_cgen_assemble_insn (CGEN_CPU_DESC cd,
683                            const char *str,
684                            CGEN_FIELDS *fields,
685                            CGEN_INSN_BYTES_PTR buf,
686                            char **errmsg)
687 {
688   const char *start;
689   CGEN_INSN_LIST *ilist;
690   const char *parse_errmsg = NULL;
691   const char *insert_errmsg = NULL;
692   int recognized_mnemonic = 0;
693
694   /* Skip leading white space.  */
695   while (ISSPACE (* str))
696     ++ str;
697
698   /* The instructions are stored in hashed lists.
699      Get the first in the list.  */
700   ilist = CGEN_ASM_LOOKUP_INSN (cd, str);
701
702   /* Keep looking until we find a match.  */
703   start = str;
704   for ( ; ilist != NULL ; ilist = CGEN_ASM_NEXT_INSN (ilist))
705     {
706       const CGEN_INSN *insn = ilist->insn;
707       recognized_mnemonic = 1;
708
709 #ifdef CGEN_VALIDATE_INSN_SUPPORTED
710       /* Not usually needed as unsupported opcodes
711          shouldn't be in the hash lists.  */
712       /* Is this insn supported by the selected cpu?  */
713       if (! xc16x_cgen_insn_supported (cd, insn))
714         continue;
715 #endif
716       /* If the RELAXED attribute is set, this is an insn that shouldn't be
717          chosen immediately.  Instead, it is used during assembler/linker
718          relaxation if possible.  */
719       if (CGEN_INSN_ATTR_VALUE (insn, CGEN_INSN_RELAXED) != 0)
720         continue;
721
722       str = start;
723
724       /* Skip this insn if str doesn't look right lexically.  */
725       if (CGEN_INSN_RX (insn) != NULL &&
726           regexec ((regex_t *) CGEN_INSN_RX (insn), str, 0, NULL, 0) == REG_NOMATCH)
727         continue;
728
729       /* Allow parse/insert handlers to obtain length of insn.  */
730       CGEN_FIELDS_BITSIZE (fields) = CGEN_INSN_BITSIZE (insn);
731
732       parse_errmsg = CGEN_PARSE_FN (cd, insn) (cd, insn, & str, fields);
733       if (parse_errmsg != NULL)
734         continue;
735
736       /* ??? 0 is passed for `pc'.  */
737       insert_errmsg = CGEN_INSERT_FN (cd, insn) (cd, insn, fields, buf,
738                                                  (bfd_vma) 0);
739       if (insert_errmsg != NULL)
740         continue;
741
742       /* It is up to the caller to actually output the insn and any
743          queued relocs.  */
744       return insn;
745     }
746
747   {
748     static char errbuf[150];
749     const char *tmp_errmsg;
750 #ifdef CGEN_VERBOSE_ASSEMBLER_ERRORS
751 #define be_verbose 1
752 #else
753 #define be_verbose 0
754 #endif
755
756     if (be_verbose)
757       {
758         /* If requesting verbose error messages, use insert_errmsg.
759            Failing that, use parse_errmsg.  */
760         tmp_errmsg = (insert_errmsg ? insert_errmsg :
761                       parse_errmsg ? parse_errmsg :
762                       recognized_mnemonic ?
763                       _("unrecognized form of instruction") :
764                       _("unrecognized instruction"));
765
766         if (strlen (start) > 50)
767           /* xgettext:c-format */
768           sprintf (errbuf, "%s `%.50s...'", tmp_errmsg, start);
769         else
770           /* xgettext:c-format */
771           sprintf (errbuf, "%s `%.50s'", tmp_errmsg, start);
772       }
773     else
774       {
775         if (strlen (start) > 50)
776           /* xgettext:c-format */
777           sprintf (errbuf, _("bad instruction `%.50s...'"), start);
778         else
779           /* xgettext:c-format */
780           sprintf (errbuf, _("bad instruction `%.50s'"), start);
781       }
782
783     *errmsg = errbuf;
784     return NULL;
785   }
786 }