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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 /* valid characters in ordinal names */
50 static const char valid_ordname_chars[] = "/$:-_@?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
52 static const char * const TypeNames[TYPE_NBTYPES] =
54 "variable", /* TYPE_VARIABLE */
55 "pascal", /* TYPE_PASCAL */
56 "equate", /* TYPE_ABS */
57 "stub", /* TYPE_STUB */
58 "stdcall", /* TYPE_STDCALL */
59 "cdecl", /* TYPE_CDECL */
60 "varargs", /* TYPE_VARARGS */
61 "extern" /* TYPE_EXTERN */
64 static const char * const FlagNames[] =
66 "norelay", /* FLAG_NORELAY */
67 "noname", /* FLAG_NONAME */
68 "ret16", /* FLAG_RET16 */
69 "ret64", /* FLAG_RET64 */
70 "register", /* FLAG_REGISTER */
71 "private", /* FLAG_PRIVATE */
72 "ordinal", /* FLAG_ORDINAL */
76 static int IsNumberString(const char *s)
78 while (*s) if (!isdigit(*s++)) return 0;
82 static inline int is_token_separator( char ch )
84 return strchr( separator_chars, ch ) != NULL;
87 static inline int is_token_comment( char ch )
89 return strchr( comment_chars, ch ) != NULL;
92 /* get the next line from the input file, or return 0 if at eof */
93 static int get_next_line(void)
95 ParseNext = ParseBuffer;
97 return (fgets(ParseBuffer, sizeof(ParseBuffer), input_file) != NULL);
100 static const char * GetToken( int allow_eol )
103 char *token = TokenBuffer;
107 /* remove initial white space */
109 while (isspace(*p)) p++;
111 if (*p == '\\' && p[1] == '\n') /* line continuation */
113 if (!get_next_line())
115 if (!allow_eol) error( "Unexpected end of file\n" );
122 if ((*p == '\0') || is_token_comment(*p))
124 if (!allow_eol) error( "Declaration not terminated properly\n" );
131 if (is_token_separator(*p))
133 /* a separator is always a complete token */
136 else while (*p != '\0' && !is_token_separator(*p) && !isspace(*p))
139 if (*p) *token++ = *p++;
147 static ORDDEF *add_entry_point( DLLSPEC *spec )
149 if (spec->nb_entry_points == spec->alloc_entry_points)
151 spec->alloc_entry_points += 128;
152 spec->entry_points = xrealloc( spec->entry_points,
153 spec->alloc_entry_points * sizeof(*spec->entry_points) );
155 return &spec->entry_points[spec->nb_entry_points++];
158 /*******************************************************************
159 * parse_spec_variable
161 * Parse a variable definition in a .spec file.
163 static int parse_spec_variable( ORDDEF *odp, DLLSPEC *spec )
168 int value_array_size;
171 if (spec->type == SPEC_WIN32)
173 error( "'variable' not supported in Win32, use 'extern' instead\n" );
177 if (!(token = GetToken(0))) return 0;
180 error( "Expected '(' got '%s'\n", token );
185 value_array_size = 25;
186 value_array = xmalloc(sizeof(*value_array) * value_array_size);
190 if (!(token = GetToken(0)))
198 value_array[n_values++] = strtol(token, &endptr, 0);
199 if (n_values == value_array_size)
201 value_array_size += 25;
202 value_array = xrealloc(value_array,
203 sizeof(*value_array) * value_array_size);
206 if (endptr == NULL || *endptr != '\0')
208 error( "Expected number value, got '%s'\n", token );
214 odp->u.var.n_values = n_values;
215 odp->u.var.values = xrealloc(value_array, sizeof(*value_array) * n_values);
220 /*******************************************************************
223 * Parse an exported function definition in a .spec file.
225 static int parse_spec_export( ORDDEF *odp, DLLSPEC *spec )
233 if (odp->type == TYPE_STDCALL)
235 error( "'stdcall' not supported for Win16\n" );
240 if (odp->type == TYPE_PASCAL)
242 error( "'pascal' not supported for Win32\n" );
250 if (!(token = GetToken(0))) return 0;
253 error( "Expected '(' got '%s'\n", token );
257 for (i = 0; i < sizeof(odp->u.func.arg_types); i++)
259 if (!(token = GetToken(0))) return 0;
263 if (!strcmp(token, "word"))
264 odp->u.func.arg_types[i] = 'w';
265 else if (!strcmp(token, "s_word"))
266 odp->u.func.arg_types[i] = 's';
267 else if (!strcmp(token, "long") || !strcmp(token, "segptr"))
268 odp->u.func.arg_types[i] = 'l';
269 else if (!strcmp(token, "ptr"))
270 odp->u.func.arg_types[i] = 'p';
271 else if (!strcmp(token, "str"))
272 odp->u.func.arg_types[i] = 't';
273 else if (!strcmp(token, "wstr"))
274 odp->u.func.arg_types[i] = 'W';
275 else if (!strcmp(token, "segstr"))
276 odp->u.func.arg_types[i] = 'T';
277 else if (!strcmp(token, "double"))
279 odp->u.func.arg_types[i++] = 'l';
280 if (get_ptr_size() == 4 && i < sizeof(odp->u.func.arg_types))
281 odp->u.func.arg_types[i] = 'l';
285 error( "Unknown argument type '%s'\n", token );
289 if (spec->type == SPEC_WIN32)
291 if (strcmp(token, "long") &&
292 strcmp(token, "ptr") &&
293 strcmp(token, "str") &&
294 strcmp(token, "wstr") &&
295 strcmp(token, "double"))
297 error( "Type '%s' not supported for Win32\n", token );
302 if ((*token != ')') || (i >= sizeof(odp->u.func.arg_types)))
304 error( "Too many arguments\n" );
308 odp->u.func.arg_types[i] = '\0';
309 if (odp->type == TYPE_VARARGS)
310 odp->flags |= FLAG_NORELAY; /* no relay debug possible for varags entry point */
312 if (!(token = GetToken(1)))
314 if (!strcmp( odp->name, "@" ))
316 error( "Missing handler name for anonymous function\n" );
319 odp->link_name = xstrdup( odp->name );
323 odp->link_name = xstrdup( token );
324 if (strchr( odp->link_name, '.' ))
326 if (spec->type == SPEC_WIN16)
328 error( "Forwarded functions not supported for Win16\n" );
331 odp->flags |= FLAG_FORWARD;
338 /*******************************************************************
341 * Parse an 'equate' definition in a .spec file.
343 static int parse_spec_equate( ORDDEF *odp, DLLSPEC *spec )
349 if (spec->type == SPEC_WIN32)
351 error( "'equate' not supported for Win32\n" );
354 if (!(token = GetToken(0))) return 0;
355 value = strtol(token, &endptr, 0);
356 if (endptr == NULL || *endptr != '\0')
358 error( "Expected number value, got '%s'\n", token );
361 if (value < -0x8000 || value > 0xffff)
363 error( "Value %d for absolute symbol doesn't fit in 16 bits\n", value );
366 odp->u.abs.value = value;
371 /*******************************************************************
374 * Parse a 'stub' definition in a .spec file
376 static int parse_spec_stub( ORDDEF *odp, DLLSPEC *spec )
378 odp->u.func.arg_types[0] = '\0';
379 odp->link_name = xstrdup("");
380 odp->flags |= FLAG_CPU(CPU_x86) | FLAG_CPU(CPU_x86_64); /* don't bother generating stubs for Winelib */
385 /*******************************************************************
388 * Parse an 'extern' definition in a .spec file.
390 static int parse_spec_extern( ORDDEF *odp, DLLSPEC *spec )
394 if (spec->type == SPEC_WIN16)
396 error( "'extern' not supported for Win16, use 'variable' instead\n" );
399 if (!(token = GetToken(1)))
401 if (!strcmp( odp->name, "@" ))
403 error( "Missing handler name for anonymous extern\n" );
406 odp->link_name = xstrdup( odp->name );
410 odp->link_name = xstrdup( token );
411 if (strchr( odp->link_name, '.' )) odp->flags |= FLAG_FORWARD;
417 /*******************************************************************
420 * Parse the optional flags for an entry point in a .spec file.
422 static const char *parse_spec_flags( ORDDEF *odp )
429 if (!(token = GetToken(0))) break;
430 if (!strncmp( token, "arch=", 5))
432 char *args = xstrdup( token + 5 );
433 char *cpu_name = strtok( args, "," );
436 enum target_cpu cpu = get_cpu_from_name( cpu_name );
439 error( "Unknown architecture '%s'\n", cpu_name );
442 odp->flags |= FLAG_CPU( cpu );
443 cpu_name = strtok( NULL, "," );
447 else if (!strcmp( token, "i386" )) /* backwards compatibility */
449 odp->flags |= FLAG_CPU(CPU_x86);
453 for (i = 0; FlagNames[i]; i++)
454 if (!strcmp( FlagNames[i], token )) break;
457 error( "Unknown flag '%s'\n", token );
460 odp->flags |= 1 << i;
463 } while (token && *token == '-');
469 /*******************************************************************
472 * Parse an ordinal definition in a .spec file.
474 static int parse_spec_ordinal( int ordinal, DLLSPEC *spec )
479 ORDDEF *odp = add_entry_point( spec );
480 memset( odp, 0, sizeof(*odp) );
482 if (!(token = GetToken(0))) goto error;
484 for (odp->type = 0; odp->type < TYPE_NBTYPES; odp->type++)
485 if (TypeNames[odp->type] && !strcmp( token, TypeNames[odp->type] ))
488 if (odp->type >= TYPE_NBTYPES)
490 error( "Expected type after ordinal, found '%s' instead\n", token );
494 if (!(token = GetToken(0))) goto error;
495 if (*token == '-' && !(token = parse_spec_flags( odp ))) goto error;
497 odp->name = xstrdup( token );
498 odp->lineno = current_line;
499 odp->ordinal = ordinal;
501 len = strspn( odp->name, valid_ordname_chars );
502 if (len < strlen( odp->name ))
504 error( "Character '%c' is not allowed in exported name '%s'\n", odp->name[len], odp->name );
511 if (!parse_spec_variable( odp, spec )) goto error;
517 if (!parse_spec_export( odp, spec )) goto error;
520 if (!parse_spec_equate( odp, spec )) goto error;
523 if (!parse_spec_stub( odp, spec )) goto error;
526 if (!parse_spec_extern( odp, spec )) goto error;
532 if ((odp->flags & FLAG_CPU_MASK) && !(odp->flags & FLAG_CPU(target_cpu)))
534 /* ignore this entry point */
535 spec->nb_entry_points--;
543 error( "Ordinal 0 is not valid\n" );
546 if (ordinal >= MAX_ORDINALS)
548 error( "Ordinal number %d too large\n", ordinal );
551 if (ordinal > spec->limit) spec->limit = ordinal;
552 if (ordinal < spec->base) spec->base = ordinal;
553 odp->ordinal = ordinal;
556 if (odp->type == TYPE_STDCALL && !(odp->flags & FLAG_PRIVATE))
558 if (!strcmp( odp->name, "DllRegisterServer" ) ||
559 !strcmp( odp->name, "DllUnregisterServer" ) ||
560 !strcmp( odp->name, "DllGetClassObject" ) ||
561 !strcmp( odp->name, "DllGetVersion" ) ||
562 !strcmp( odp->name, "DllInstall" ) ||
563 !strcmp( odp->name, "DllCanUnloadNow" ))
565 warning( "Function %s should be marked private\n", odp->name );
566 if (strcmp( odp->name, odp->link_name ))
567 warning( "Function %s should not use a different internal name (%s)\n",
568 odp->name, odp->link_name );
572 if (!strcmp( odp->name, "@" ) || odp->flags & (FLAG_NONAME | FLAG_ORDINAL))
576 if (!strcmp( odp->name, "@" ))
577 error( "Nameless function needs an explicit ordinal number\n" );
579 error( "Function imported by ordinal needs an explicit ordinal number\n" );
582 if (spec->type != SPEC_WIN32)
584 error( "Nameless functions not supported for Win16\n" );
587 if (!strcmp( odp->name, "@" ))
592 else if (!(odp->flags & FLAG_ORDINAL)) /* -ordinal only affects the import library */
594 odp->export_name = odp->name;
601 spec->nb_entry_points--;
607 static int name_compare( const void *ptr1, const void *ptr2 )
609 const ORDDEF *odp1 = *(const ORDDEF * const *)ptr1;
610 const ORDDEF *odp2 = *(const ORDDEF * const *)ptr2;
611 const char *name1 = odp1->name ? odp1->name : odp1->export_name;
612 const char *name2 = odp2->name ? odp2->name : odp2->export_name;
613 return strcmp( name1, name2 );
616 /*******************************************************************
619 * Build the name array and catch duplicates.
621 static void assign_names( DLLSPEC *spec )
623 int i, j, nb_exp_names = 0;
627 for (i = 0; i < spec->nb_entry_points; i++)
628 if (spec->entry_points[i].name) spec->nb_names++;
629 else if (spec->entry_points[i].export_name) nb_exp_names++;
631 if (!spec->nb_names && !nb_exp_names) return;
633 /* check for duplicates */
635 all_names = xmalloc( (spec->nb_names + nb_exp_names) * sizeof(all_names[0]) );
636 for (i = j = 0; i < spec->nb_entry_points; i++)
637 if (spec->entry_points[i].name || spec->entry_points[i].export_name)
638 all_names[j++] = &spec->entry_points[i];
640 qsort( all_names, j, sizeof(all_names[0]), name_compare );
642 for (i = 0; i < j - 1; i++)
644 const char *name1 = all_names[i]->name ? all_names[i]->name : all_names[i]->export_name;
645 const char *name2 = all_names[i+1]->name ? all_names[i+1]->name : all_names[i+1]->export_name;
646 if (!strcmp( name1, name2 ))
648 current_line = max( all_names[i]->lineno, all_names[i+1]->lineno );
649 error( "'%s' redefined\n%s:%d: First defined here\n",
650 name1, input_file_name,
651 min( all_names[i]->lineno, all_names[i+1]->lineno ) );
658 spec->names = xmalloc( spec->nb_names * sizeof(spec->names[0]) );
659 for (i = j = 0; i < spec->nb_entry_points; i++)
660 if (spec->entry_points[i].name) spec->names[j++] = &spec->entry_points[i];
662 /* sort the list of names */
663 qsort( spec->names, spec->nb_names, sizeof(spec->names[0]), name_compare );
667 /*******************************************************************
670 * Build the ordinal array.
672 static void assign_ordinals( DLLSPEC *spec )
674 int i, count, ordinal;
676 /* start assigning from base, or from 1 if no ordinal defined yet */
678 spec->base = MAX_ORDINALS;
680 for (i = 0; i < spec->nb_entry_points; i++)
682 ordinal = spec->entry_points[i].ordinal;
683 if (ordinal == -1) continue;
684 if (ordinal > spec->limit) spec->limit = ordinal;
685 if (ordinal < spec->base) spec->base = ordinal;
687 if (spec->base == MAX_ORDINALS) spec->base = 1;
688 if (spec->limit < spec->base) spec->limit = spec->base;
690 count = max( spec->limit + 1, spec->base + spec->nb_entry_points );
691 spec->ordinals = xmalloc( count * sizeof(spec->ordinals[0]) );
692 memset( spec->ordinals, 0, count * sizeof(spec->ordinals[0]) );
694 /* fill in all explicitly specified ordinals */
695 for (i = 0; i < spec->nb_entry_points; i++)
697 ordinal = spec->entry_points[i].ordinal;
698 if (ordinal == -1) continue;
699 if (spec->ordinals[ordinal])
701 current_line = max( spec->entry_points[i].lineno, spec->ordinals[ordinal]->lineno );
702 error( "ordinal %d redefined\n%s:%d: First defined here\n",
703 ordinal, input_file_name,
704 min( spec->entry_points[i].lineno, spec->ordinals[ordinal]->lineno ) );
706 else spec->ordinals[ordinal] = &spec->entry_points[i];
709 /* now assign ordinals to the rest */
710 for (i = 0, ordinal = spec->base; i < spec->nb_entry_points; i++)
712 if (spec->entry_points[i].ordinal != -1) continue;
713 while (spec->ordinals[ordinal]) ordinal++;
714 if (ordinal >= MAX_ORDINALS)
716 current_line = spec->entry_points[i].lineno;
717 fatal_error( "Too many functions defined (max %d)\n", MAX_ORDINALS );
719 spec->entry_points[i].ordinal = ordinal;
720 spec->ordinals[ordinal] = &spec->entry_points[i];
722 if (ordinal > spec->limit) spec->limit = ordinal;
726 /*******************************************************************
729 * Parse a .spec file.
731 int parse_spec_file( FILE *file, DLLSPEC *spec )
738 comment_chars = "#;";
739 separator_chars = "()-";
741 while (get_next_line())
743 if (!(token = GetToken(1))) continue;
744 if (strcmp(token, "@") == 0)
746 if (spec->type != SPEC_WIN32)
748 error( "'@' ordinals not supported for Win16\n" );
751 if (!parse_spec_ordinal( -1, spec )) continue;
753 else if (IsNumberString(token))
755 if (!parse_spec_ordinal( atoi(token), spec )) continue;
759 error( "Expected ordinal declaration, got '%s'\n", token );
762 if ((token = GetToken(1))) error( "Syntax error near '%s'\n", token );
765 current_line = 0; /* no longer parsing the input file */
766 assign_names( spec );
767 assign_ordinals( spec );
772 /*******************************************************************
775 * Parse a LIBRARY declaration in a .def file.
777 static int parse_def_library( DLLSPEC *spec )
779 const char *token = GetToken(1);
781 if (!token) return 1;
782 if (strcmp( token, "BASE" ))
784 free( spec->file_name );
785 spec->file_name = xstrdup( token );
786 if (!(token = GetToken(1))) return 1;
788 if (strcmp( token, "BASE" ))
790 error( "Expected library name or BASE= declaration, got '%s'\n", token );
793 if (!(token = GetToken(0))) return 0;
794 if (strcmp( token, "=" ))
796 error( "Expected '=' after BASE, got '%s'\n", token );
799 if (!(token = GetToken(0))) return 0;
800 /* FIXME: do something with base address */
806 /*******************************************************************
807 * parse_def_stack_heap_size
809 * Parse a STACKSIZE or HEAPSIZE declaration in a .def file.
811 static int parse_def_stack_heap_size( int is_stack, DLLSPEC *spec )
813 const char *token = GetToken(0);
817 if (!token) return 0;
818 size = strtoul( token, &end, 0 );
821 error( "Invalid number '%s'\n", token );
824 if (is_stack) spec->stack_size = size / 1024;
825 else spec->heap_size = size / 1024;
826 if (!(token = GetToken(1))) return 1;
827 if (strcmp( token, "," ))
829 error( "Expected ',' after size, got '%s'\n", token );
832 if (!(token = GetToken(0))) return 0;
833 /* FIXME: do something with reserve size */
838 /*******************************************************************
841 * Parse an export declaration in a .def file.
843 static int parse_def_export( char *name, DLLSPEC *spec )
846 const char *token = GetToken(1);
848 ORDDEF *odp = add_entry_point( spec );
849 memset( odp, 0, sizeof(*odp) );
851 odp->lineno = current_line;
854 args = remove_stdcall_decoration( odp->name );
855 if (args == -1) odp->type = TYPE_CDECL;
858 odp->type = TYPE_STDCALL;
859 args /= get_ptr_size();
860 if (args >= sizeof(odp->u.func.arg_types))
862 error( "Too many arguments in stdcall function '%s'\n", odp->name );
865 for (i = 0; i < args; i++) odp->u.func.arg_types[i] = 'l';
868 /* check for optional internal name */
870 if (token && !strcmp( token, "=" ))
872 if (!(token = GetToken(0))) goto error;
873 odp->link_name = xstrdup( token );
874 remove_stdcall_decoration( odp->link_name );
879 odp->link_name = xstrdup( name );
882 /* check for optional ordinal */
884 if (token && token[0] == '@')
888 if (!IsNumberString( token+1 ))
890 error( "Expected number after '@', got '%s'\n", token+1 );
893 ordinal = atoi( token+1 );
896 error( "Ordinal 0 is not valid\n" );
899 if (ordinal >= MAX_ORDINALS)
901 error( "Ordinal number %d too large\n", ordinal );
904 odp->ordinal = ordinal;
908 /* check for other optional keywords */
910 if (token && !strcmp( token, "NONAME" ))
912 if (odp->ordinal == -1)
914 error( "NONAME requires an ordinal\n" );
917 odp->export_name = odp->name;
919 odp->flags |= FLAG_NONAME;
922 if (token && !strcmp( token, "PRIVATE" ))
924 odp->flags |= FLAG_PRIVATE;
927 if (token && !strcmp( token, "DATA" ))
929 odp->type = TYPE_EXTERN;
934 error( "Garbage text '%s' found at end of export declaration\n", token );
940 spec->nb_entry_points--;
946 /*******************************************************************
951 int parse_def_file( FILE *file, DLLSPEC *spec )
960 separator_chars = ",=";
962 while (get_next_line())
964 if (!(token = GetToken(1))) continue;
966 if (!strcmp( token, "LIBRARY" ) || !strcmp( token, "NAME" ))
968 if (!parse_def_library( spec )) continue;
971 else if (!strcmp( token, "STACKSIZE" ))
973 if (!parse_def_stack_heap_size( 1, spec )) continue;
976 else if (!strcmp( token, "HEAPSIZE" ))
978 if (!parse_def_stack_heap_size( 0, spec )) continue;
981 else if (!strcmp( token, "EXPORTS" ))
984 if (!(token = GetToken(1))) continue;
986 else if (!strcmp( token, "IMPORTS" ))
989 if (!(token = GetToken(1))) continue;
991 else if (!strcmp( token, "SECTIONS" ))
994 if (!(token = GetToken(1))) continue;
997 if (!in_exports) continue; /* ignore this line */
998 if (!parse_def_export( xstrdup(token), spec )) continue;
1001 if ((token = GetToken(1))) error( "Syntax error near '%s'\n", token );
1004 current_line = 0; /* no longer parsing the input file */
1005 assign_names( spec );
1006 assign_ordinals( spec );