Mercurial > hg > xemacs-beta
annotate lib-src/make-mswin-unicode.pl @ 4873:50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Tue, 12 Jan 2010 01:19:01 -0600 |
parents | 23ef20edf6ba |
children | 49de55c09f18 |
rev | line source |
---|---|
771 | 1 : #-*- Perl -*- |
2 | |
3 ### make-mswin-unicode --- generate Unicode-encapsulation code for MS Windows | |
4 | |
2367 | 5 ## Copyright (C) 2001, 2002, 2004 Ben Wing. |
771 | 6 |
7 ## Author: Ben Wing <ben@xemacs.org> | |
8 ## Maintainer: Ben Wing <ben@xemacs.org> | |
9 ## Current Version: 1.0, August 24, 2001 | |
10 | |
11 ## This file is part of XEmacs. | |
12 | |
13 ## XEmacs is free software; you can redistribute it and/or modify it | |
14 ## under the terms of the GNU General Public License as published by | |
15 ## the Free Software Foundation; either version 2, or (at your option) | |
16 ## any later version. | |
17 | |
18 ## XEmacs is distributed in the hope that it will be useful, but | |
19 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
21 ## General Public License for more details. | |
22 | |
23 ## You should have received a copy of the GNU General Public License | |
24 ## along with XEmacs; see the file COPYING. If not, write to the Free | |
25 ## Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
26 ## 02111-1307, USA. | |
27 | |
28 eval 'exec perl -w -S $0 ${1+"$@"}' | |
29 if 0; | |
30 | |
31 use strict; | |
32 use File::Basename; | |
33 use Getopt::Long; | |
34 | |
35 my ($myName, $myPath) = fileparse ($0); | |
36 | |
37 my $usage=" | |
38 Usage: $myName [--c-output FILE] [--h-output FILE] [--help] [FILES ...] | |
39 | |
40 The purpose of this script is to auto-generate Unicode-encapsulation | |
41 code for MS Windows library functions that come in two versions (ANSI | |
42 and Unicode). The MS Windows header files provide a way of | |
43 automatically calling the right version, but only at compile-time, | |
44 which is *NOT* sufficient for any real-world program. The solution is | |
45 run-time Unicode encapsulation, which is not conceptually difficult | |
46 but is time-consuming, and is not supported standardly only due to | |
47 evil marketing decisions made by Microsoft. See src/intl-win32.c | |
48 for more information. | |
49 | |
800 | 50 In XEmacs, this file is normally run using `nmake -f xemacs.mak |
51 unicode-encapsulate'. | |
52 | |
771 | 53 This script processes the specified files, looking for commands |
54 indicating library routines to Unicode-encapsulate, as follows: | |
55 | |
56 Portions of the files that should be processed are enclosed in lines | |
57 consisting only of the words \"begin-unicode-encapsulation-script\" | |
58 and \"end-unicode-encapsulation-script\". More than one section can | |
59 occur in a single file. Processed lines begin with a command word, | |
60 followed by one or more args (no quotes are necessary for spaces): | |
61 | |
62 file specifies a file to start reading from. | |
63 yes indicates a function to be automatically Unicode-encapsulated. | |
64 (All parameters either need no special processing or are LPTSTR or | |
65 LPCTSTR.) | |
66 soon indicates a function that should be automatically Unicode-encapsulated, | |
67 but we're not ready to process it yet. | |
68 no indicates a function we don't support (it will be #defined to cause | |
69 a compile error, with the text after the function included in the | |
70 erroneous definition to indicate why we don't support it). | |
71 skip indicates a function we support manually; only a comment about this | |
72 will be generated. | |
73 split indicates a function with a split structure (different versions | |
74 for Unicode and ANSI), but where the only difference is in pointer | |
75 types, and the actual size does not differ. The structure name | |
76 should follow the function name, and it will be automatically | |
77 Unicode-encapsulated with appropriate casts. | |
78 begin-bracket indicates a #if statement to be inserted here. | |
79 end-bracket indicates the corresponding #endif statement. | |
80 blank lines and lines beginning with // are ignored. | |
81 "; | |
82 | |
83 # ------------------ process command-line options ------------------ | |
84 | |
85 my %options; | |
86 my @SAVE_ARGV = @ARGV; | |
87 | |
88 $Getopt::Long::ignorecase = 0; | |
89 &GetOptions ( | |
90 \%options, | |
91 'c-output=s', | |
92 'h-output=s', | |
778 | 93 'includedir=s', |
771 | 94 'help', |
95 ); | |
96 | |
97 die $usage if $options{"help"}; | |
98 | |
99 my $in_script; | |
100 my $slurp; | |
101 | |
778 | 102 my ($cout, $hout, $dir) = ($options{"c-output"}, |
103 $options{"h-output"}, | |
104 $options{"includedir"}); | |
4873
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
105 |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
106 $dir = '/usr/include/w32api' if !$dir && -f '/usr/include/w32api/windows.h'; |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
107 |
778 | 108 if (!$dir) |
109 { | |
4467
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
110 for my $sdkroot (("WindowsSdkDir", "MSSdk", "MSVCDIR")) |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
111 { |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
112 if (defined $ENV{$sdkroot}) { |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
113 $dir = $ENV{$sdkroot}; |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
114 last; |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
115 } |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
116 } |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
117 unless (defined $dir) |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
118 { |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
119 die "Can't find the Windows SDK headers; run vcvars32.bat from your MSVC installation, or setenv.cmd from the Platform SDK installation"; |
23ef20edf6ba
Check %WindowsSdkDir%, %MSSddk% for the Windows header files too.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3728
diff
changeset
|
120 } |
778 | 121 } |
4873
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
122 $dir.='/include' if ((-f $dir.'/include/WINDOWS.H') || |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
123 (-f $dir.'/include/windows.h')); |
3728 | 124 die "Can't find MSVC include files in \"$dir\"" unless ((-f $dir.'/WINDOWS.H') || (-f $dir.'/windows.h')); |
771 | 125 |
126 open (COUT, ">$cout") or die "Can't open C output file $cout: $!"; | |
127 open (HOUT, ">$hout") or die "Can't open C output file $hout: $!"; | |
128 | |
129 select (STDOUT); $| = 1; | |
130 | |
131 print COUT "/* Automatically-generated Unicode-encapsulation file, | |
132 using the command | |
133 | |
134 $myPath$myName @SAVE_ARGV | |
135 | |
136 Do not edit. See `$myName'. | |
137 */ | |
138 | |
139 #include <config.h> | |
140 #include \"lisp.h\" | |
141 | |
142 #include \"syswindows.h\" | |
143 | |
144 "; | |
145 print HOUT "/* Automatically-generated Unicode-encapsulation header file. | |
146 Do not edit. See `$myName'. | |
147 */\n\n"; | |
148 | |
149 my %files; | |
150 my %processed; | |
151 my %bracket; | |
152 | |
153 my $current_file; | |
154 my @current_bracket; | |
155 | |
156 while (<>) | |
157 { | |
158 chomp; | |
800 | 159 # remove trailing CR. #### Should not be necessary! Perl should be |
160 # opening these in text mode by default, as the docs claim, and | |
161 # automatically remove the CR's. | |
162 tr/\r//d; | |
771 | 163 |
164 if (/^begin-unicode-encapsulation-script$/) | |
165 { | |
166 $in_script = 1; | |
167 } | |
168 elsif (/^end-unicode-encapsulation-script$/) | |
169 { | |
170 $in_script = 0; | |
171 } | |
172 elsif ($in_script) | |
173 { | |
174 next if (m!^//!); | |
175 next if (/^[ \t]*$/); | |
778 | 176 if (/(file|yes|soon|no|skip|split|begin-bracket|end-bracket)(?: (.*))?/) |
771 | 177 { |
178 my ($command, $parms) = ($1, $2); | |
778 | 179 if ($command eq "file") |
771 | 180 { |
181 $current_file = $parms; | |
182 } | |
183 elsif ($command eq "begin-bracket") | |
184 { | |
185 my $current_bracket = $current_bracket[$#current_bracket]; | |
186 if (defined ($current_bracket)) | |
187 { | |
188 $current_bracket .= "&& $parms"; | |
189 } | |
190 else | |
191 { | |
192 $current_bracket = "$parms"; | |
193 } | |
194 push @current_bracket, $current_bracket; | |
195 } | |
196 elsif ($command eq "end-bracket") | |
197 { | |
198 pop @current_bracket; | |
199 } | |
200 else | |
201 { | |
202 my ($fun, $reason) = split /\s+/, $parms, 2; | |
203 $files{$current_file}{$fun} = [$command, $reason]; | |
204 $bracket{$current_file}{$fun} = | |
205 $current_bracket[$#current_bracket]; | |
206 } | |
207 } | |
208 else | |
209 { | |
210 print "WARNING: Unknown line $_\n"; | |
211 } | |
212 } | |
213 } | |
214 | |
215 | |
216 foreach my $file (keys %files) | |
217 { | |
218 $slurp = &FileContents ($file); | |
219 print "Processing file $file\n"; | |
220 print HOUT "\n/* Processing file $file */\n\n"; | |
221 my $totalspace = 70 - length ("Processing file $file"); | |
222 $totalspace = 0 if $totalspace < 0; | |
223 my $alignspaceleft = $totalspace / 2; | |
224 my $alignspaceright = ($totalspace + 1) / 2; | |
225 print COUT " | |
226 /*----------------------------------------------------------------------*/ | |
227 /*" . (" " x $alignspaceleft) . "Processing file $file" . | |
228 (" " x $alignspaceright) . "*/ | |
229 /*----------------------------------------------------------------------*/ | |
230 | |
231 "; | |
232 | |
233 my ($ws_re, $must_ws_re, $tok_ch) = | |
234 ("\\s*", "\\s+", "\\w"); | |
235 # unfortunately there is no surefire way short of | |
236 # parsing all include files for typedefs to | |
237 # distinguish types from parameters, and prototypes | |
238 # appear in the include files both with and without | |
239 # parameters -- the latter kinds appear in a very | |
240 # different style and were obviously added later. so | |
241 # we rely on the fact that defined types are all | |
242 # upper-case, and parameters generally are not, and | |
243 # special-case the exceptions. | |
244 my $typeword_re = | |
245 # note the negative lookahead assertions: the first | |
246 # one excludes the words "X" and "Y" from type | |
247 # words, since they appear as parameter names in | |
248 # CreateWindowEx; the second prevents "void | |
249 # *Argument" from being parsed as a type "void *A" | |
250 # followed by a parameter "rgument". | |
4873
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
251 "(?:(?!(?:X\\b|Y\\b))(?:unsigned|int|long|const|short|va_list|[A-Z_0-9]+)(?!${tok_ch}))"; |
771 | 252 my $typetoken_re = "(?:$typeword_re$ws_re\\**$ws_re)"; |
253 my $arg_re = "(?:($typetoken_re+)(${tok_ch}+)?(?: OPTIONAL)?)"; | |
254 my $fun_re = "(SHSTDAPI_\\(${tok_ch}+\\)|${tok_ch}" . "[A-Za-z_0-9 \t\n\r\f]*?${tok_ch})${ws_re}(${tok_ch}+)W${ws_re}\\(((${ws_re}${arg_re}${ws_re},)*${ws_re}${arg_re}${ws_re})\\);"; | |
255 | |
256 # print "regexp: $fun_re\n"; | |
257 while ($slurp =~ /$fun_re/g) | |
258 { | |
259 my ($rettype, $fun, $args) = ($1, $2, $3); | |
4873
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
260 |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
261 if ($processed{$fun}) |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
262 { |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
263 print "Warning: Function $fun already seen\n"; |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
264 next; |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
265 } |
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
266 |
771 | 267 $processed{$fun} = 1; |
4873
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
268 |
771 | 269 print "Processing: $fun"; |
270 | |
271 my ($command, $reason) = ($files{$file}{$fun}[0], $files{$file}{$fun}[1]); | |
272 if (!defined ($command)) | |
273 { | |
274 print " (no command found)\n"; | |
275 } | |
276 else | |
277 { | |
278 print "\n"; | |
279 my $bracket = $bracket{$file}{$fun}; | |
280 if (defined ($bracket)) | |
281 { | |
282 print HOUT "#if $bracket\n"; | |
283 print COUT "#if $bracket\n\n"; | |
284 } | |
285 if ($command eq "no") | |
286 { | |
287 if (!defined ($reason)) | |
288 { | |
289 print "WARNING: No reason given for `no' with function $fun\n"; | |
290 $reason = ""; | |
291 } | |
292 | |
293 print HOUT "#undef $fun\n"; | |
2367 | 294 (my $munged_reason = $reason) =~ s/[^A-Za-z0-9]/_/g; |
295 print HOUT "#define $fun error_$munged_reason\n"; | |
771 | 296 print COUT "/* Error if $fun used: $reason */\n\n"; |
297 } | |
298 elsif ($command eq "skip") | |
299 { | |
300 if (!defined ($reason)) | |
301 { | |
302 print "WARNING: No reason given for `skip' with function $fun\n"; | |
303 $reason = ""; | |
304 } | |
305 | |
306 print HOUT "/* Skipping $fun because $reason */\n"; | |
307 print COUT "/* Skipping $fun because $reason */\n\n"; | |
308 } | |
309 elsif ($command eq "soon") | |
310 { | |
311 $reason = "" if !defined ($reason); | |
312 | |
313 print HOUT "/* Not yet: $fun $reason */\n"; | |
314 print COUT "/* Not yet: $fun $reason */\n\n"; | |
315 } | |
316 else | |
317 { | |
318 my (@args, %argtype, %ansiarg, %xarg, $split_struct, | |
319 $split_rettype); | |
320 if ($command eq "split") | |
321 { | |
322 ($split_struct, $reason) = split /\s+/, $reason, 2; | |
323 } | |
324 my $argno = 0; | |
325 while ($args =~ /$arg_re/g) | |
326 { | |
327 $argno++; | |
328 my ($argtype, $argname) = ($1, $2); | |
329 $argtype =~ s/\s*$//; | |
330 next if $argtype eq "void" || $argtype eq "VOID"; | |
331 $argname = "arg$argno" if !defined ($argname); | |
332 $argtype{$argname} = $argtype; | |
333 $ansiarg{$argname} = $argtype; | |
334 $ansiarg{$argname} =~ s/\bLPWSTR\b/LPSTR/; | |
335 $ansiarg{$argname} =~ s/\bLPCWSTR\b/LPCSTR/; | |
336 $xarg{$argname} = $argtype; | |
337 $xarg{$argname} =~ s/\bLPWSTR\b/Extbyte */; | |
338 $xarg{$argname} =~ s/\bLPCWSTR\b/const Extbyte */; | |
339 if (defined ($split_struct)) | |
340 { | |
341 my $fuck_cperl1 = "\\b${split_struct}W\\b"; | |
342 my $fuck_cperl2 = "${split_struct}A"; | |
343 $ansiarg{$argname} =~ s/$fuck_cperl1/$fuck_cperl2/; | |
344 } | |
345 push @args, $argname; | |
346 } | |
347 $rettype =~ s/\bSHSTDAPI_\((.*)\)/$1/; | |
348 $rettype =~ s/\s*WIN\w*?API\s*//g; | |
4873
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
349 $rettype =~ s/\bAPIENTRY\b\s*//; |
771 | 350 $rettype =~ s/\bSHSTDAPI\b/HRESULT/; |
4873
50861fea97f6
regenerate intl-auto-encap-win32.c, now possible from Cygwin /usr/include/w32api headers
Ben Wing <ben@xemacs.org>
parents:
4467
diff
changeset
|
351 $rettype =~ s/\bextern\b\s*//; |
771 | 352 if ($rettype =~ /LPC?WSTR/) |
353 { | |
354 $split_rettype = 1; | |
355 $rettype =~ s/\bLPWSTR\b/Extbyte */; | |
356 $rettype =~ s/\bLPCWSTR\b/const Extbyte */; | |
357 } | |
800 | 358 print HOUT "#ifdef ERROR_WHEN_NONINTERCEPTED_FUNS_USED\n"; |
359 print HOUT "#undef $fun\n"; | |
2367 | 360 print HOUT "#define $fun error_use_qxe${fun}_or_${fun}A_and_${fun}W\n"; |
800 | 361 print HOUT "#endif\n"; |
771 | 362 if (defined ($reason)) |
363 { | |
364 print COUT "/* NOTE: $reason */\n"; | |
365 } | |
366 print COUT "$rettype\nqxe$fun ("; | |
367 print HOUT "$rettype qxe$fun ("; | |
368 my $first = 1; | |
369 if (!@args) | |
370 { | |
371 print COUT "void"; | |
372 print HOUT "void"; | |
373 } | |
374 else | |
375 { | |
376 foreach my $x (@args) | |
377 { | |
378 print COUT ", " if !$first; | |
379 print HOUT ", " if !$first; | |
380 $first = 0; | |
381 print COUT "$xarg{$x} $x"; | |
382 print HOUT "$xarg{$x} $x"; | |
383 } | |
384 } | |
385 print HOUT ");\n"; | |
386 print COUT ")\n{\n if (XEUNICODE_P)\n "; | |
387 if ($rettype ne "void" && $rettype ne "VOID") | |
388 { | |
389 print COUT "return "; | |
390 print COUT "($rettype) " if $split_rettype; | |
391 } | |
392 print COUT "${fun}W ("; | |
393 $first = 1; | |
394 foreach my $x (@args) | |
395 { | |
396 print COUT ", " if !$first; | |
397 $first = 0; | |
398 print COUT ($argtype{$x} eq $xarg{$x} ? $x : | |
399 "($argtype{$x}) $x"); | |
400 } | |
401 print COUT ");\n else\n "; | |
402 if ($rettype ne "void" && $rettype ne "VOID") | |
403 { | |
404 print COUT "return "; | |
405 print COUT "($rettype) " if $split_rettype; | |
406 } | |
407 print COUT "${fun}A ("; | |
408 $first = 1; | |
409 foreach my $x (@args) | |
410 { | |
411 print COUT ", " if !$first; | |
412 $first = 0; | |
413 print COUT ($argtype{$x} eq $ansiarg{$x} ? $x : | |
414 "($ansiarg{$x}) $x"); | |
415 } | |
416 print COUT ");\n}\n\n"; | |
417 } | |
418 if (defined ($bracket)) | |
419 { | |
420 print HOUT "#endif /* $bracket */\n"; | |
421 print COUT "#endif /* $bracket */\n\n"; | |
422 } | |
800 | 423 print HOUT "\n"; |
771 | 424 } |
425 } | |
426 } | |
427 | |
428 foreach my $file (keys %files) | |
429 { | |
430 foreach my $fun (keys %{$files{$file}}) | |
431 { | |
432 if (!$processed{$fun} && $files{$file}{$fun}[0] =~ /^(yes|soon|split)$/) | |
433 { | |
434 print "WARNING: Can't locate prototype for $fun\n"; | |
435 } | |
436 } | |
437 } | |
438 | |
439 | |
440 sub FileContents | |
441 { | |
442 local $/ = undef; | |
778 | 443 open (FILE, "< $dir/$_[0]") or die "$dir/$_[0]: $!"; |
771 | 444 my $retval = scalar <FILE>; |
445 # must hack away CRLF junk. | |
446 $retval =~ s/\r\n/\n/g; | |
447 return $retval; | |
448 } |