makefiles: Add a more generic handling of makefile generation flags.
[wine] / tools / make_makefiles
1 #!/usr/bin/perl -w
2 #
3 # Build the auto-generated parts of the Wine makefiles.
4 #
5 # Copyright 2006 Alexandre Julliard
6 #
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2.1 of the License, or (at your option) any later version.
11 #
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 # Lesser General Public License for more details.
16 #
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 #
21
22 use strict;
23
24 # Make rules files
25 my %makerules =
26 (
27  "MAKE_RULES" => "Make.rules",
28  "MAKE_DLL_RULES" => "dlls/Makedll.rules",
29  "MAKE_IMPLIB_RULES" => "dlls/Makeimplib.rules",
30  "MAKE_TEST_RULES" => "Maketest.rules",
31  "MAKE_PROG_RULES" => "programs/Makeprog.rules",
32 );
33
34 # Programs that we want to install in the bin directory too
35 my %bin_install =
36 (
37   "msiexec" => 1,
38   "notepad" => 1,
39   "regedit" => 1,
40   "regsvr32" => 1,
41   "wineboot" => 1,
42   "winecfg" => 1,
43   "wineconsole" => 1,
44   "winedbg" => 1,
45   "winefile" => 1,
46   "winemine" => 1,
47   "winepath" => 1,
48 );
49
50 # Programs that we don't want to install at all
51 my %dont_install =
52 (
53   "cmdlgtst" => 1,
54   "view" => 1,
55   "winetest" => 1,
56 );
57
58 # Dlls and programs that are 16-bit specific
59 my %modules16 =
60 (
61   "ifsmgr.vxd" => 1,
62   "mmdevldr.vxd" => 1,
63   "monodebg.vxd" => 1,
64   "vdhcp.vxd" => 1,
65   "vmm.vxd" => 1,
66   "vnbt.vxd" => 1,
67   "vnetbios.vxd" => 1,
68   "vtdapi.vxd" => 1,
69   "vwin32.vxd" => 1,
70   "w32skrnl.dll" => 1,
71   "winevdm.exe" => 1,
72   "wow32.dll" => 1,
73 );
74
75 # Default patterns for top-level .gitignore
76 my @ignores = (
77     "*.[oa]",
78     "*.exe",
79     "*.fake",
80     "*.man",
81     "*.ok",
82     "*.res",
83     "*.so",
84     "/autom4te.cache",
85     "/config.cache",
86     "/config.log",
87     "/config.status",
88     "/configure.lineno",
89     "/TAGS",
90     "/tags",
91     "/wine",
92     "/wine64",
93     "Makefile",
94     "dlldata.c",
95     "dlls/*/*.def",
96     "dlls/shell32/AUTHORS",
97     "*/*/tests/testlist.c",
98     "include/config.h",
99     "include/stamp-h",
100     "msg.pot",
101     "programs/winetest/build.nfo",
102     "programs/winetest/build.rc",
103     "rsrc.pot",
104     "tools/makedep",
105 );
106
107 # Source files and their resulting target to ignore
108 my @ignore_srcs = (
109     [ 'BISON_SRCS',   '\.y',   '.tab.c' ],
110     [ 'BISON_SRCS',   '\.y',   '.tab.h' ],
111     [ 'LEX_SRCS',     '\.l',   '.yy.c' ],
112     [ 'IDL_TLB_SRCS', '\.idl', '.tlb' ],
113     [ 'IDL_H_SRCS',   '\.idl', '.h' ],
114     [ 'IDL_C_SRCS',   '\.idl', '.h' ],
115     [ 'IDL_I_SRCS',   '\.idl', '.h' ],
116     [ 'IDL_P_SRCS',   '\.idl', '.h' ],
117     [ 'IDL_S_SRCS',   '\.idl', '.h' ],
118     [ 'IDL_C_SRCS',   '\.idl', '_c.c' ],
119     [ 'IDL_I_SRCS',   '\.idl', '_i.c' ],
120     [ 'IDL_P_SRCS',   '\.idl', '_p.c' ],
121     [ 'IDL_S_SRCS',   '\.idl', '_s.c' ],
122     [ 'PUBLIC_IDL_H_SRCS',  '\.idl', '.h' ],
123     [ 'PRIVATE_IDL_H_SRCS', '\.idl', '.h' ],
124     [ 'XTEMPLATE_SRCS',     '\.x',   '.h' ],
125 );
126
127 my %exported_wine_headers = (
128     "wine/debug.h" => 1,
129     "wine/exception.h" => 1,
130     "wine/library.h" => 1,
131     "wine/unicode.h" => 1,
132     "wine/itss.idl" => 1,
133     "wine/svcctl.idl" => 1,
134 );
135
136 my %private_idl_headers = (
137     "access.idl" => 1,
138     "asynot.idl" => 1,
139     "asysta.idl" => 1,
140     "axcore.idl" => 1,
141     "axextend.idl" => 1,
142     "binres.idl" => 1,
143     "cmdbas.idl" => 1,
144     "cmdtxt.idl" => 1,
145     "crtrow.idl" => 1,
146     "dbccmd.idl" => 1,
147     "dbcses.idl" => 1,
148     "dbdsad.idl" => 1,
149     "dbinit.idl" => 1,
150     "dbprop.idl" => 1,
151     "dbs.idl" => 1,
152     "devenum.idl" => 1,
153     "dyngraph.idl" => 1,
154     "opnrst.idl" => 1,
155     "row.idl" => 1,
156     "rowchg.idl" => 1,
157     "rstbas.idl" => 1,
158     "rstinf.idl" => 1,
159     "rstloc.idl" => 1,
160     "sesprp.idl" => 1,
161     "vmrender.idl" => 1,
162     "xmldom.idl" => 1,
163     "xmldso.idl" => 1,
164     "wine/winedxgi.idl" => 1,
165 );
166
167 my %ignored_source_files = (
168     "dlls/wineps.drv/afm2c.c" => 1,
169     "dlls/wineps.drv/mkagl.c" => 1,
170     "programs/winetest/dist.rc" => 1,
171 );
172
173 my (@linguas, @makefiles, %makefiles);
174
175 sub dirname($)
176 {
177     my $ret = shift;
178     return "" unless $ret =~ /\//;
179     $ret =~ s!/[^/]*$!!;
180     return $ret;
181 }
182
183 # update a file if changed
184 sub update_file($)
185 {
186     my $file = shift;
187     my $ret = !(-f $file) || system "cmp $file $file.new >/dev/null";
188     if (!$ret)
189     {
190         unlink "$file.new";
191     }
192     else
193     {
194         rename "$file.new", "$file";
195         print "$file updated\n";
196         if ($file eq "configure.ac")
197         {
198             system "autoconf";
199             print "configure updated\n";
200         }
201     }
202     return $ret;
203 }
204
205 # replace some lines in a file between two markers
206 sub replace_in_file($$$@)
207 {
208     my $file = shift;
209     my $start = shift;
210     my $end = shift;
211
212     open NEW_FILE, ">$file.new" or die "cannot create $file.new";
213
214     if (defined($start))
215     {
216         open OLD_FILE, "$file" or die "cannot open $file";
217         while (<OLD_FILE>)
218         {
219             last if /$start/;
220             print NEW_FILE $_;
221         }
222     }
223
224     print NEW_FILE @_;
225
226     if (defined($end))
227     {
228         my $skip=1;
229         while (<OLD_FILE>)
230         {
231             print NEW_FILE $_ unless $skip;
232             $skip = 0 if /$end/;
233         }
234     }
235
236     close OLD_FILE if defined($start);
237     close NEW_FILE;
238     return update_file($file);
239 }
240
241 # replace a variable in a makefile
242 sub replace_makefile_variable($$)
243 {
244     my ($file, $var) = @_;
245     my $make = $makefiles{$file};
246     my $replaced = 0;
247
248     return unless defined ${$make}{"=$var"};
249
250     my @values = @{${$make}{"=$var"}};
251     ${$make}{$var} = \@values;
252
253     open NEW_FILE, ">$file.in.new" or die "cannot create $file.in.new";
254
255     open OLD_FILE, "$file.in" or die "cannot open $file.in";
256     while (<OLD_FILE>)
257     {
258         if (/^\s*($var\s*)=/)
259         {
260             # try to preserve formatting
261             my $prefix = $1;
262             my $multiline = /\\$/ || (@values > 1);
263             while (/\\$/)
264             {
265                 $_ = <OLD_FILE>;
266                 last unless $_;
267             }
268             if ($multiline)
269             {
270                 print NEW_FILE "$var = \\\n\t" . join(" \\\n\t", sort @values) . "\n";
271             }
272             else
273             {
274                 print NEW_FILE "$prefix= @values\n";
275             }
276             $replaced = 1;
277             next;
278         }
279         if (/^\@MAKE/ && !$replaced)
280         {
281             print NEW_FILE "$var = \\\n\t" . join(" \\\n\t", sort @values) . "\n";
282         }
283         print NEW_FILE $_;
284     }
285     close OLD_FILE;
286     close NEW_FILE;
287     return update_file("$file.in");
288 }
289
290 # parse the specified makefile and load the variables
291 sub parse_makefile($)
292 {
293     my $file = shift;
294     my %make;
295
296     ($make{"=dir"} = $file) =~ s/[^\/]+$//;
297
298     open MAKE, "$file.in" or die "cannot open $file.in\n";
299
300     while (<MAKE>)
301     {
302         chomp;
303         next if (/^\s*#/);
304         while (/\\$/) { chop; $_ .= <MAKE>; chomp; }  # merge continued lines
305         next if (/^\s*$/);
306
307         if (/^\@(MAKE.*RULES)\@/)
308         {
309             my $var = $1;
310             $make{"=rules"} = $makerules{$var};
311             next;
312         }
313         if (/^\s*(MODULE|IMPORTLIB|TESTDLL)\s*=\s*(.*)/)
314         {
315             my $var = $1;
316             $make{$var} = $2;
317             push @{$make{"=flags"}}, "implib" if $var eq "IMPORTLIB";
318             next;
319         }
320         if (/^\s*(BISON_SRCS|LEX_SRCS|IDL_[CHIPRS]_SRCS|IDL_TLB_SRCS|IMPLIB_SRCS|C_SRCS|MC_SRCS|RC_SRCS|PO_SRCS|SVG_SRCS|PROGRAMS)\s*=\s*(.*)/)
321         {
322             my $var = $1;
323             my @list = split(/\s+/, $2);
324             $make{$var} = \@list;
325             push @{$make{"=flags"}}, "mc" if $var eq "MC_SRCS";
326             push @{$make{"=flags"}}, "po" if $var eq "PO_SRCS";
327             push @{$make{"=flags"}}, "staticimplib" if $var eq "IMPLIB_SRCS";
328             next;
329         }
330         if (/^\s*(TOPSRCDIR|TOPOBJDIR|SRCDIR|VPATH)\s*=\s*(.*)/)
331         {
332             die "Variable $1 in $file.in is obsolete";
333         }
334     }
335
336     if ($file =~ /^programs\/([^\/]+)\/Makefile/)
337     {
338         push @{$make{"=flags"}}, "install" unless $dont_install{$1};
339         push @{$make{"=flags"}}, "installbin" if $bin_install{$1};
340     }
341
342     return %make;
343 }
344
345 # assign source files to their respective makefile
346 sub assign_sources_to_makefiles(@)
347 {
348     my %subdirs;
349
350     foreach my $file (@_)
351     {
352         next if defined $ignored_source_files{$file};
353         my $dir = dirname( $file );
354         my $subdir = $dir;
355
356         while ($dir && !defined $makefiles{"$dir/Makefile"}) { $dir = dirname( $dir ); }
357         $subdir =~ s/^$dir\/?//;
358         $subdirs{"$dir/ $subdir"} = 1 if $subdir;
359         next unless $dir;
360
361         die "no makefile found for $file\n" unless defined $makefiles{"$dir/Makefile"};
362
363         my $make = $makefiles{"$dir/Makefile"};
364         my $name = substr( $file, length($dir) + 1 );
365
366         if ($dir eq "include")
367         {
368             next if ($name =~ /\.in$/);
369             if ($name =~ /^wine\// && !$exported_wine_headers{$name})
370             {
371                 if ($private_idl_headers{$name}) { push @{${$make}{"=PRIVATE_IDL_H_SRCS"}}, $name; }
372                 next;
373             }
374             if ($name =~ /stdole2\.idl$/) { push @{${$make}{"=IDL_TLB_SRCS"}}, $name; }
375             elsif ($private_idl_headers{$name}) { push @{${$make}{"=SRCDIR_INCLUDES"}}, $name; }
376             elsif ($name =~ /\.h$/) { push @{${$make}{"=SRCDIR_INCLUDES"}}, $name; }
377             elsif ($name =~ /\.x$/) { push @{${$make}{"=XTEMPLATE_SRCS"}}, $name; }
378             elsif ($name =~ /\.rh$/) { push @{${$make}{"=SRCDIR_INCLUDES"}}, $name; }
379             elsif ($name =~ /\.inl$/) { push @{${$make}{"=SRCDIR_INCLUDES"}}, $name; }
380             elsif ($name =~ /\.idl$/) { push @{${$make}{"=PUBLIC_IDL_H_SRCS"}}, $name; }
381             else { die "unknown file $name in include dir"; }
382         }
383         else
384         {
385             if ($name =~ /\.c$/) { push @{${$make}{"=C_SRCS"}}, $name; }
386             elsif ($name =~ /\.l$/) { push @{${$make}{"=LEX_SRCS"}}, $name; }
387             elsif ($name =~ /\.y$/) { push @{${$make}{"=BISON_SRCS"}}, $name; }
388             elsif ($name =~ /\.rc$/) { push @{${$make}{"=RC_SRCS"}}, $name; }
389             elsif ($name =~ /\.mc$/) { push @{${$make}{"=MC_SRCS"}}, $name; }
390             elsif ($name =~ /\.svg$/) { push @{${$make}{"=SVG_SRCS"}}, $name; }
391         }
392     }
393     foreach my $key (keys %subdirs)
394     {
395         my ($dir, $subdir) = split " ", $key;
396         if ($dir eq "/") { $dir = ""; }
397         push @{${$makefiles{"${dir}Makefile"}}{"=EXTRASUBDIRS"}}, $subdir;
398     }
399
400     # add extra variables to include source list
401     my $make = $makefiles{"include/Makefile"};
402     unshift @{${$make}{"=SRCDIR_INCLUDES"}}, "\$(XTEMPLATE_SRCS)";
403     unshift @{${$make}{"=SRCDIR_INCLUDES"}}, "\$(PUBLIC_IDL_H_SRCS)";
404     unshift @{${$make}{"=SRCDIR_INCLUDES"}}, "\$(IDL_TLB_SRCS)";
405 }
406
407 ################################################################
408 # update the makefile list in configure.ac
409
410 sub update_makefiles(@)
411 {
412     my (@lines);
413
414     foreach my $var (sort { $makerules{$a} cmp $makerules{$b}; } keys %makerules)
415     {
416         my $file = $makerules{$var};
417         my %make = %{$makefiles{$file}};
418         my $rules = $make{"=rules"} ? ",[$make{\"=rules\"}]" : "";
419         push @lines, "WINE_CONFIG_MAKERULES([$file],[$var]$rules)\n";
420     }
421     push @lines, "\n";
422
423     foreach my $file (sort @_)
424     {
425         my %make = %{$makefiles{$file}};
426         my $rules = $make{"=rules"};
427         my $args = "";
428         my $is_win16 = $make{"MODULE"} && ($make{"MODULE"} =~ /16$/ || $modules16{$make{"MODULE"}});
429         my $flag_args = defined $make{"=flags"} ? ",[" . join(",",sort @{$make{"=flags"}}) ."]" : "";
430         if ($rules eq $makerules{"MAKE_DLL_RULES"})
431         {
432             (my $name = $file) =~ s/^dlls\/(.*)\/Makefile/$1/;
433             if ($name =~ /\./)
434             {
435                 die "Invalid MODULE in $file" unless $make{"MODULE"} eq $name;
436             }
437             else
438             {
439                 die "Invalid MODULE in $file" unless $make{"MODULE"} eq "$name.dll";
440             }
441             my $implib = $make{"IMPORTLIB"} || "";
442             $args .= "," if $is_win16 || defined $make{"=flags"};
443             $args .= "enable_win16" if $is_win16;
444             $args .= $flag_args;
445             $args .= ",[$implib]" if $implib && $implib ne $name;
446             push @lines, "WINE_CONFIG_DLL($name$args)\n";
447         }
448         elsif ($rules eq $makerules{"MAKE_PROG_RULES"})
449         {
450             (my $name = $file) =~ s/^programs\/(.*)\/Makefile/$1/;
451             if ($name =~ /\./)
452             {
453                 die "Invalid MODULE in $file" unless $make{"MODULE"} eq $name;
454             }
455             else
456             {
457                 die "Invalid MODULE in $file" unless $make{"MODULE"} eq "$name.exe";
458             }
459             $args .= "," if $is_win16 || defined $make{"=flags"};
460             $args .= "enable_win16" if $is_win16;
461             push @lines, "WINE_CONFIG_PROGRAM($name$args$flag_args)\n";
462         }
463         elsif ($rules eq $makerules{"MAKE_TEST_RULES"})
464         {
465             (my $dir = $file) =~ s/^(.*)\/Makefile/$1/;
466             push @lines, "WINE_CONFIG_TEST($dir$flag_args)\n";
467         }
468         elsif ($rules eq $makerules{"MAKE_IMPLIB_RULES"})
469         {
470             (my $name = $file) =~ s/^dlls\/(.*)\/Makefile/$1/;
471             push @lines, "WINE_CONFIG_LIB($name$flag_args)\n";
472         }
473         elsif ($file =~ /^tools.*\/Makefile$/)
474         {
475             (my $name = $file) =~ s/^(.*)\/Makefile/$1/;
476             push @lines, "WINE_CONFIG_TOOL($name$flag_args)\n";
477         }
478         elsif ($file =~ /\/Makefile$/)
479         {
480             (my $name = $file) =~ s/^(.*)\/Makefile/$1/;
481             $args = "[$name]";
482             $args .= "," if defined $make{"=flags"};
483             push @lines, "WINE_CONFIG_MAKEFILE($args$flag_args)\n";
484         }
485     }
486
487     push @lines, "\nAC_SUBST([LINGUAS],[\"\\\n", join( " \\\n", sort @linguas ), "\"])\n\n";
488
489     # update the source variables in all the makefiles
490
491     foreach my $file (sort @_)
492     {
493         replace_makefile_variable( $file, "LEX_SRCS" );
494         replace_makefile_variable( $file, "BISON_SRCS" );
495         replace_makefile_variable( $file, "MC_SRCS" );
496         replace_makefile_variable( $file, "SVG_SRCS" );
497         replace_makefile_variable( $file, "C_SRCS" );
498         replace_makefile_variable( $file, "RC_SRCS" );
499         replace_makefile_variable( $file, "PRIVATE_IDL_H_SRCS" );
500         replace_makefile_variable( $file, "PUBLIC_IDL_H_SRCS" );
501         replace_makefile_variable( $file, "IDL_TLB_SRCS" );
502         replace_makefile_variable( $file, "XTEMPLATE_SRCS" );
503         replace_makefile_variable( $file, "SRCDIR_INCLUDES" );
504         replace_makefile_variable( $file, "EXTRASUBDIRS" );
505     }
506
507     push @lines, "dnl End of auto-generated output commands\n";
508     replace_in_file( "configure.ac", '^WINE_CONFIG_MAKERULES', '^dnl End of auto-generated output commands\n$', @lines);
509 }
510
511
512 ################################################################
513 # process ignore targets for generic source files
514
515 sub update_ignores(@)
516 {
517     my @ignores;
518
519     foreach my $file (sort @_)
520     {
521         my %makefile = %{$makefiles{$file}};
522         my @list;
523
524         foreach my $src (@ignore_srcs)
525         {
526             my @pattern = @{$src};
527             next unless defined $makefile{$pattern[0]};
528             push @list, map { (my $ret = $_) =~ s/$pattern[1]$/$pattern[2]/; $ret; } @{$makefile{$pattern[0]}};
529         }
530         foreach my $f (@list)
531         {
532             push @ignores, $makefile{"=dir"} . $f unless $f =~ /\$\(.*\)/;  # skip make variables
533         }
534
535         if (defined $makefile{"IMPORTLIB"})
536         {
537             if ($makefile{"IMPORTLIB"} =~ /^([a-zA-Z0-9_.]+)/)
538             {
539                 if ("dlls/$1/" ne $makefile{"=dir"}) { push @ignores, "dlls/lib$1.def"; }
540             }
541             else
542             {
543                 die "invalid importlib name $makefile{IMPORTLIB} in $file";
544             }
545         }
546     }
547     return @ignores;
548 }
549
550
551 ################################################################
552 # update the main .gitignore
553
554 sub update_gitignore(@)
555 {
556     my @ignores = values %makerules;
557
558     foreach my $make (@makefiles)
559     {
560         my %makefile = %{$makefiles{$make}};
561         my $dir = $makefile{"=dir"};
562         if (defined $makefile{"PROGRAMS"})
563         {
564             push @ignores, map { s/\$\(EXEEXT\)//; $dir . $_; } @{$makefile{"PROGRAMS"}};
565         }
566     }
567
568     # prepend a slash to paths that don't have one
569     @ignores = map { $_ =~ s/^([^\/]+)$/\/$1/; $_; } @ignores;
570
571     # get rid of duplicates
572     my %ignores = ();
573     foreach my $i (@ignores, @_) { $ignores{$i} = 1; }
574
575     replace_in_file( ".gitignore", undef, undef,
576                      "# Automatically generated by make_makefiles; DO NOT EDIT!!\n",
577                      join("\n", sort keys %ignores), "\n" );
578 }
579
580
581 ################################################################
582 # update the LINGUAS file
583
584 sub update_linguas(@)
585 {
586     replace_in_file( "po/LINGUAS", undef, undef, join("\n", sort @_), "\n" );
587 }
588
589
590 die "needs to be run from a git checkout" unless -d ".git";
591
592 my @all_files = split /\0/, `git ls-files -c -z`;
593 @linguas = map { (my $ret = $_) =~ s/^po\/(.*)\.po/$1/; $ret; } grep /^po\/.*\.po$/, @all_files;
594 @makefiles = map { (my $ret = $_) =~ s/\.in$//; $ret; } grep /Makefile.in$/, @all_files;
595
596 foreach my $file (sort values %makerules, @makefiles)
597 {
598     my %make = parse_makefile( $file );
599     $makefiles{$file} = \%make;
600 }
601
602 assign_sources_to_makefiles( @all_files );
603 update_linguas( @linguas );
604 update_makefiles( @makefiles );
605 push @ignores, update_ignores( @makefiles );
606 update_gitignore( @ignores );