4 * Copyright 1993 Robert J. Amstadt
5 * Copyright 1995 Martin von Loewis
6 * Copyright 1995, 1996, 1997, 2004 Alexandre Julliard
7 * Copyright 1997 Eric Youngdale
8 * Copyright 1999 Ulrich Weigand
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include "wine/port.h"
41 static char ParseBuffer[512];
42 static char TokenBuffer[512];
43 static char *ParseNext = ParseBuffer;
44 static FILE *input_file;
46 static const char *separator_chars;
47 static const char *comment_chars;
49 static const char * const TypeNames[TYPE_NBTYPES] =
51 "variable", /* TYPE_VARIABLE */
52 "pascal", /* TYPE_PASCAL */
53 "equate", /* TYPE_ABS */
54 "stub", /* TYPE_STUB */
55 "stdcall", /* TYPE_STDCALL */
56 "cdecl", /* TYPE_CDECL */
57 "varargs", /* TYPE_VARARGS */
58 "extern" /* TYPE_EXTERN */
61 static const char * const FlagNames[] =
63 "norelay", /* FLAG_NORELAY */
64 "noname", /* FLAG_NONAME */
65 "ret16", /* FLAG_RET16 */
66 "ret64", /* FLAG_RET64 */
67 "i386", /* FLAG_I386 */
68 "register", /* FLAG_REGISTER */
69 "private", /* FLAG_PRIVATE */
73 static int IsNumberString(const char *s)
75 while (*s) if (!isdigit(*s++)) return 0;
79 inline static int is_token_separator( char ch )
81 return strchr( separator_chars, ch ) != NULL;
84 inline static int is_token_comment( char ch )
86 return strchr( comment_chars, ch ) != NULL;
89 /* get the next line from the input file, or return 0 if at eof */
90 static int get_next_line(void)
92 ParseNext = ParseBuffer;
94 return (fgets(ParseBuffer, sizeof(ParseBuffer), input_file) != NULL);
97 static const char * GetToken( int allow_eol )
100 char *token = TokenBuffer;
104 /* remove initial white space */
106 while (isspace(*p)) p++;
108 if (*p == '\\' && p[1] == '\n') /* line continuation */
110 if (!get_next_line())
112 if (!allow_eol) error( "Unexpected end of file\n" );
119 if ((*p == '\0') || is_token_comment(*p))
121 if (!allow_eol) error( "Declaration not terminated properly\n" );
128 if (is_token_separator(*p))
130 /* a separator is always a complete token */
133 else while (*p != '\0' && !is_token_separator(*p) && !isspace(*p))
136 if (*p) *token++ = *p++;
144 static ORDDEF *add_entry_point( DLLSPEC *spec )
146 if (spec->nb_entry_points == spec->alloc_entry_points)
148 spec->alloc_entry_points += 128;
149 spec->entry_points = xrealloc( spec->entry_points,
150 spec->alloc_entry_points * sizeof(*spec->entry_points) );
152 return &spec->entry_points[spec->nb_entry_points++];
155 /*******************************************************************
156 * parse_spec_variable
158 * Parse a variable definition in a .spec file.
160 static int parse_spec_variable( ORDDEF *odp, DLLSPEC *spec )
165 int value_array_size;
168 if (spec->type == SPEC_WIN32)
170 error( "'variable' not supported in Win32, use 'extern' instead\n" );
174 if (!(token = GetToken(0))) return 0;
177 error( "Expected '(' got '%s'\n", token );
182 value_array_size = 25;
183 value_array = xmalloc(sizeof(*value_array) * value_array_size);
187 if (!(token = GetToken(0)))
195 value_array[n_values++] = strtol(token, &endptr, 0);
196 if (n_values == value_array_size)
198 value_array_size += 25;
199 value_array = xrealloc(value_array,
200 sizeof(*value_array) * value_array_size);
203 if (endptr == NULL || *endptr != '\0')
205 error( "Expected number value, got '%s'\n", token );
211 odp->u.var.n_values = n_values;
212 odp->u.var.values = xrealloc(value_array, sizeof(*value_array) * n_values);
217 /*******************************************************************
220 * Parse an exported function definition in a .spec file.
222 static int parse_spec_export( ORDDEF *odp, DLLSPEC *spec )
230 if (odp->type == TYPE_STDCALL)
232 error( "'stdcall' not supported for Win16\n" );
237 if (odp->type == TYPE_PASCAL)
239 error( "'pascal' not supported for Win32\n" );
247 if (!(token = GetToken(0))) return 0;
250 error( "Expected '(' got '%s'\n", token );
254 for (i = 0; i < sizeof(odp->u.func.arg_types); i++)
256 if (!(token = GetToken(0))) return 0;
260 if (!strcmp(token, "word"))
261 odp->u.func.arg_types[i] = 'w';
262 else if (!strcmp(token, "s_word"))
263 odp->u.func.arg_types[i] = 's';
264 else if (!strcmp(token, "long") || !strcmp(token, "segptr"))
265 odp->u.func.arg_types[i] = 'l';
266 else if (!strcmp(token, "ptr"))
267 odp->u.func.arg_types[i] = 'p';
268 else if (!strcmp(token, "str"))
269 odp->u.func.arg_types[i] = 't';
270 else if (!strcmp(token, "wstr"))
271 odp->u.func.arg_types[i] = 'W';
272 else if (!strcmp(token, "segstr"))
273 odp->u.func.arg_types[i] = 'T';
274 else if (!strcmp(token, "double"))
276 odp->u.func.arg_types[i++] = 'l';
277 if (get_ptr_size() == 4 && i < sizeof(odp->u.func.arg_types))
278 odp->u.func.arg_types[i] = 'l';
282 error( "Unknown argument type '%s'\n", token );
286 if (spec->type == SPEC_WIN32)
288 if (strcmp(token, "long") &&
289 strcmp(token, "ptr") &&
290 strcmp(token, "str") &&
291 strcmp(token, "wstr") &&
292 strcmp(token, "double"))
294 error( "Type '%s' not supported for Win32\n", token );
299 if ((*token != ')') || (i >= sizeof(odp->u.func.arg_types)))
301 error( "Too many arguments\n" );
305 odp->u.func.arg_types[i] = '\0';
306 if (odp->type == TYPE_VARARGS)
307 odp->flags |= FLAG_NORELAY; /* no relay debug possible for varags entry point */
309 if (!(token = GetToken(1)))
311 if (!strcmp( odp->name, "@" ))
313 error( "Missing handler name for anonymous function\n" );
316 odp->link_name = xstrdup( odp->name );
320 odp->link_name = xstrdup( token );
321 if (strchr( odp->link_name, '.' ))
323 if (spec->type == SPEC_WIN16)
325 error( "Forwarded functions not supported for Win16\n" );
328 odp->flags |= FLAG_FORWARD;
335 /*******************************************************************
338 * Parse an 'equate' definition in a .spec file.
340 static int parse_spec_equate( ORDDEF *odp, DLLSPEC *spec )
346 if (spec->type == SPEC_WIN32)
348 error( "'equate' not supported for Win32\n" );
351 if (!(token = GetToken(0))) return 0;
352 value = strtol(token, &endptr, 0);
353 if (endptr == NULL || *endptr != '\0')
355 error( "Expected number value, got '%s'\n", token );
358 if (value < -0x8000 || value > 0xffff)
360 error( "Value %d for absolute symbol doesn't fit in 16 bits\n", value );
363 odp->u.abs.value = value;
368 /*******************************************************************
371 * Parse a 'stub' definition in a .spec file
373 static int parse_spec_stub( ORDDEF *odp, DLLSPEC *spec )
375 odp->u.func.arg_types[0] = '\0';
376 odp->link_name = xstrdup("");
377 odp->flags |= FLAG_I386; /* don't bother generating stubs for Winelib */
382 /*******************************************************************
385 * Parse an 'extern' definition in a .spec file.
387 static int parse_spec_extern( ORDDEF *odp, DLLSPEC *spec )
391 if (spec->type == SPEC_WIN16)
393 error( "'extern' not supported for Win16, use 'variable' instead\n" );
396 if (!(token = GetToken(1)))
398 if (!strcmp( odp->name, "@" ))
400 error( "Missing handler name for anonymous extern\n" );
403 odp->link_name = xstrdup( odp->name );
407 odp->link_name = xstrdup( token );
408 if (strchr( odp->link_name, '.' )) odp->flags |= FLAG_FORWARD;
414 /*******************************************************************
417 * Parse the optional flags for an entry point in a .spec file.
419 static const char *parse_spec_flags( ORDDEF *odp )
426 if (!(token = GetToken(0))) break;
427 for (i = 0; FlagNames[i]; i++)
428 if (!strcmp( FlagNames[i], token )) break;
431 error( "Unknown flag '%s'\n", token );
434 odp->flags |= 1 << i;
436 } while (token && *token == '-');
442 /*******************************************************************
445 * Parse an ordinal definition in a .spec file.
447 static int parse_spec_ordinal( int ordinal, DLLSPEC *spec )
451 ORDDEF *odp = add_entry_point( spec );
452 memset( odp, 0, sizeof(*odp) );
454 if (!(token = GetToken(0))) goto error;
456 for (odp->type = 0; odp->type < TYPE_NBTYPES; odp->type++)
457 if (TypeNames[odp->type] && !strcmp( token, TypeNames[odp->type] ))
460 if (odp->type >= TYPE_NBTYPES)
462 error( "Expected type after ordinal, found '%s' instead\n", token );
466 if (!(token = GetToken(0))) goto error;
467 if (*token == '-' && !(token = parse_spec_flags( odp ))) goto error;
469 odp->name = xstrdup( token );
470 odp->lineno = current_line;
471 odp->ordinal = ordinal;
476 if (!parse_spec_variable( odp, spec )) goto error;
482 if (!parse_spec_export( odp, spec )) goto error;
485 if (!parse_spec_equate( odp, spec )) goto error;
488 if (!parse_spec_stub( odp, spec )) goto error;
491 if (!parse_spec_extern( odp, spec )) goto error;
497 if ((target_cpu != CPU_x86) && (odp->flags & FLAG_I386))
499 /* ignore this entry point on non-Intel archs */
500 spec->nb_entry_points--;
508 error( "Ordinal 0 is not valid\n" );
511 if (ordinal >= MAX_ORDINALS)
513 error( "Ordinal number %d too large\n", ordinal );
516 if (ordinal > spec->limit) spec->limit = ordinal;
517 if (ordinal < spec->base) spec->base = ordinal;
518 odp->ordinal = ordinal;
521 if (spec->type == SPEC_WIN32 && odp->flags & FLAG_REGISTER)
523 error( "-register flag not supported for Win32 entry points\n" );
527 if (odp->type == TYPE_STDCALL && !(odp->flags & FLAG_PRIVATE))
529 if (!strcmp( odp->name, "DllRegisterServer" ) ||
530 !strcmp( odp->name, "DllUnregisterServer" ) ||
531 !strcmp( odp->name, "DllGetClassObject" ) ||
532 !strcmp( odp->name, "DllGetVersion" ) ||
533 !strcmp( odp->name, "DllInstall" ) ||
534 !strcmp( odp->name, "DllCanUnloadNow" ))
536 warning( "Function %s should be marked private\n", odp->name );
537 if (strcmp( odp->name, odp->link_name ))
538 warning( "Function %s should not use a different internal name (%s)\n",
539 odp->name, odp->link_name );
543 if (!strcmp( odp->name, "@" ) || odp->flags & FLAG_NONAME)
547 error( "Nameless function needs an explicit ordinal number\n" );
550 if (spec->type != SPEC_WIN32)
552 error( "Nameless functions not supported for Win16\n" );
555 if (!strcmp( odp->name, "@" )) free( odp->name );
556 else odp->export_name = odp->name;
562 spec->nb_entry_points--;
568 static int name_compare( const void *ptr1, const void *ptr2 )
570 const ORDDEF *odp1 = *(const ORDDEF * const *)ptr1;
571 const ORDDEF *odp2 = *(const ORDDEF * const *)ptr2;
572 const char *name1 = odp1->name ? odp1->name : odp1->export_name;
573 const char *name2 = odp2->name ? odp2->name : odp2->export_name;
574 return strcmp( name1, name2 );
577 /*******************************************************************
580 * Build the name array and catch duplicates.
582 static void assign_names( DLLSPEC *spec )
584 int i, j, nb_exp_names = 0;
588 for (i = 0; i < spec->nb_entry_points; i++)
589 if (spec->entry_points[i].name) spec->nb_names++;
590 else if (spec->entry_points[i].export_name) nb_exp_names++;
592 if (!spec->nb_names && !nb_exp_names) return;
594 /* check for duplicates */
596 all_names = xmalloc( (spec->nb_names + nb_exp_names) * sizeof(all_names[0]) );
597 for (i = j = 0; i < spec->nb_entry_points; i++)
598 if (spec->entry_points[i].name || spec->entry_points[i].export_name)
599 all_names[j++] = &spec->entry_points[i];
601 qsort( all_names, j, sizeof(all_names[0]), name_compare );
603 for (i = 0; i < j - 1; i++)
605 const char *name1 = all_names[i]->name ? all_names[i]->name : all_names[i]->export_name;
606 const char *name2 = all_names[i+1]->name ? all_names[i+1]->name : all_names[i+1]->export_name;
607 if (!strcmp( name1, name2 ))
609 current_line = max( all_names[i]->lineno, all_names[i+1]->lineno );
610 error( "'%s' redefined\n%s:%d: First defined here\n",
611 name1, input_file_name,
612 min( all_names[i]->lineno, all_names[i+1]->lineno ) );
619 spec->names = xmalloc( spec->nb_names * sizeof(spec->names[0]) );
620 for (i = j = 0; i < spec->nb_entry_points; i++)
621 if (spec->entry_points[i].name) spec->names[j++] = &spec->entry_points[i];
623 /* sort the list of names */
624 qsort( spec->names, spec->nb_names, sizeof(spec->names[0]), name_compare );
628 /*******************************************************************
631 * Build the ordinal array.
633 static void assign_ordinals( DLLSPEC *spec )
635 int i, count, ordinal;
637 /* start assigning from base, or from 1 if no ordinal defined yet */
639 spec->base = MAX_ORDINALS;
641 for (i = 0; i < spec->nb_entry_points; i++)
643 ordinal = spec->entry_points[i].ordinal;
644 if (ordinal == -1) continue;
645 if (ordinal > spec->limit) spec->limit = ordinal;
646 if (ordinal < spec->base) spec->base = ordinal;
648 if (spec->base == MAX_ORDINALS) spec->base = 1;
649 if (spec->limit < spec->base) spec->limit = spec->base;
651 count = max( spec->limit + 1, spec->base + spec->nb_entry_points );
652 spec->ordinals = xmalloc( count * sizeof(spec->ordinals[0]) );
653 memset( spec->ordinals, 0, count * sizeof(spec->ordinals[0]) );
655 /* fill in all explicitly specified ordinals */
656 for (i = 0; i < spec->nb_entry_points; i++)
658 ordinal = spec->entry_points[i].ordinal;
659 if (ordinal == -1) continue;
660 if (spec->ordinals[ordinal])
662 current_line = max( spec->entry_points[i].lineno, spec->ordinals[ordinal]->lineno );
663 error( "ordinal %d redefined\n%s:%d: First defined here\n",
664 ordinal, input_file_name,
665 min( spec->entry_points[i].lineno, spec->ordinals[ordinal]->lineno ) );
667 else spec->ordinals[ordinal] = &spec->entry_points[i];
670 /* now assign ordinals to the rest */
671 for (i = 0, ordinal = spec->base; i < spec->nb_entry_points; i++)
673 if (spec->entry_points[i].ordinal != -1) continue;
674 while (spec->ordinals[ordinal]) ordinal++;
675 if (ordinal >= MAX_ORDINALS)
677 current_line = spec->entry_points[i].lineno;
678 fatal_error( "Too many functions defined (max %d)\n", MAX_ORDINALS );
680 spec->entry_points[i].ordinal = ordinal;
681 spec->ordinals[ordinal] = &spec->entry_points[i];
683 if (ordinal > spec->limit) spec->limit = ordinal;
687 /*******************************************************************
690 * Parse a .spec file.
692 int parse_spec_file( FILE *file, DLLSPEC *spec )
699 comment_chars = "#;";
700 separator_chars = "()-";
702 while (get_next_line())
704 if (!(token = GetToken(1))) continue;
705 if (strcmp(token, "@") == 0)
707 if (spec->type != SPEC_WIN32)
709 error( "'@' ordinals not supported for Win16\n" );
712 if (!parse_spec_ordinal( -1, spec )) continue;
714 else if (IsNumberString(token))
716 if (!parse_spec_ordinal( atoi(token), spec )) continue;
720 error( "Expected ordinal declaration, got '%s'\n", token );
723 if ((token = GetToken(1))) error( "Syntax error near '%s'\n", token );
726 current_line = 0; /* no longer parsing the input file */
727 assign_names( spec );
728 assign_ordinals( spec );
733 /*******************************************************************
736 * Parse a LIBRARY declaration in a .def file.
738 static int parse_def_library( DLLSPEC *spec )
740 const char *token = GetToken(1);
742 if (!token) return 1;
743 if (strcmp( token, "BASE" ))
745 free( spec->file_name );
746 spec->file_name = xstrdup( token );
747 if (!(token = GetToken(1))) return 1;
749 if (strcmp( token, "BASE" ))
751 error( "Expected library name or BASE= declaration, got '%s'\n", token );
754 if (!(token = GetToken(0))) return 0;
755 if (strcmp( token, "=" ))
757 error( "Expected '=' after BASE, got '%s'\n", token );
760 if (!(token = GetToken(0))) return 0;
761 /* FIXME: do something with base address */
767 /*******************************************************************
768 * parse_def_stack_heap_size
770 * Parse a STACKSIZE or HEAPSIZE declaration in a .def file.
772 static int parse_def_stack_heap_size( int is_stack, DLLSPEC *spec )
774 const char *token = GetToken(0);
778 if (!token) return 0;
779 size = strtoul( token, &end, 0 );
782 error( "Invalid number '%s'\n", token );
785 if (is_stack) spec->stack_size = size / 1024;
786 else spec->heap_size = size / 1024;
787 if (!(token = GetToken(1))) return 1;
788 if (strcmp( token, "," ))
790 error( "Expected ',' after size, got '%s'\n", token );
793 if (!(token = GetToken(0))) return 0;
794 /* FIXME: do something with reserve size */
799 /*******************************************************************
802 * Parse an export declaration in a .def file.
804 static int parse_def_export( char *name, DLLSPEC *spec )
807 const char *token = GetToken(1);
809 ORDDEF *odp = add_entry_point( spec );
810 memset( odp, 0, sizeof(*odp) );
812 odp->lineno = current_line;
815 args = remove_stdcall_decoration( odp->name );
816 if (args == -1) odp->type = TYPE_CDECL;
819 odp->type = TYPE_STDCALL;
820 args /= get_ptr_size();
821 if (args >= sizeof(odp->u.func.arg_types))
823 error( "Too many arguments in stdcall function '%s'\n", odp->name );
826 for (i = 0; i < args; i++) odp->u.func.arg_types[i] = 'l';
829 /* check for optional internal name */
831 if (token && !strcmp( token, "=" ))
833 if (!(token = GetToken(0))) goto error;
834 odp->link_name = xstrdup( token );
835 remove_stdcall_decoration( odp->link_name );
840 odp->link_name = xstrdup( name );
843 /* check for optional ordinal */
845 if (token && token[0] == '@')
849 if (!IsNumberString( token+1 ))
851 error( "Expected number after '@', got '%s'\n", token+1 );
854 ordinal = atoi( token+1 );
857 error( "Ordinal 0 is not valid\n" );
860 if (ordinal >= MAX_ORDINALS)
862 error( "Ordinal number %d too large\n", ordinal );
865 odp->ordinal = ordinal;
869 /* check for other optional keywords */
871 if (token && !strcmp( token, "NONAME" ))
873 if (odp->ordinal == -1)
875 error( "NONAME requires an ordinal\n" );
878 odp->export_name = odp->name;
880 odp->flags |= FLAG_NONAME;
883 if (token && !strcmp( token, "PRIVATE" ))
885 odp->flags |= FLAG_PRIVATE;
888 if (token && !strcmp( token, "DATA" ))
890 odp->type = TYPE_EXTERN;
895 error( "Garbage text '%s' found at end of export declaration\n", token );
901 spec->nb_entry_points--;
907 /*******************************************************************
912 int parse_def_file( FILE *file, DLLSPEC *spec )
921 separator_chars = ",=";
923 while (get_next_line())
925 if (!(token = GetToken(1))) continue;
927 if (!strcmp( token, "LIBRARY" ) || !strcmp( token, "NAME" ))
929 if (!parse_def_library( spec )) continue;
932 else if (!strcmp( token, "STACKSIZE" ))
934 if (!parse_def_stack_heap_size( 1, spec )) continue;
937 else if (!strcmp( token, "HEAPSIZE" ))
939 if (!parse_def_stack_heap_size( 0, spec )) continue;
942 else if (!strcmp( token, "EXPORTS" ))
945 if (!(token = GetToken(1))) continue;
947 else if (!strcmp( token, "IMPORTS" ))
950 if (!(token = GetToken(1))) continue;
952 else if (!strcmp( token, "SECTIONS" ))
955 if (!(token = GetToken(1))) continue;
958 if (!in_exports) continue; /* ignore this line */
959 if (!parse_def_export( xstrdup(token), spec )) continue;
962 if ((token = GetToken(1))) error( "Syntax error near '%s'\n", token );
965 current_line = 0; /* no longer parsing the input file */
966 assign_names( spec );
967 assign_ordinals( spec );