tools/make_X11wrappers

   1 #!/usr/bin/perl -w
   2
   3 # Create threads safe wrappers around X11 calls.
   4 #
   5 # Copyright 1998 Kristian Nielsen.
   6 #
   7
   8 # FIXME: This does not do full C prototype parsing, but relies on
   9 # knowledge on how the X11 include files are formatted. It will
  10 # probably need to be modified for new include files. It also fails
  11 # for certain prototypes (notably those with function pointer
  12 # arguments or results), so these must be added manually. And it
  13 # relies on a fixed location of X11 includes (/usr/X11R6/include/).
  14 #
  15 # This program expects to be run from Wine's main directory.
  16
  17 $X11_include_dir = "/usr/X11R6/include";
  18 $outdir = "tsx11";
  19 $wantfile = "$outdir/X11_calls";
  20 @dolist = ("Xlib", "Xresource", "Xutil", "xpm", "XShm", "xf86dga", "xf86vmode");
  21
  22 # First read list of wanted function names.
  23
  24 open(WANT, $wantfile) || die "open";
  25 while(<WANT>) {
  26     next if /^\s*\#/;           # Skip comment lines.
  27     next if /^\s*$/;            # Skip empty lines.
  28     if(/^\s*([a-zA-Z0-9_]+)\s*$/) {
  29         $want{$1} = 1;
  30     } else {
  31         die "syntax error in file '$wantfile', in line '$_'";
  32     }
  33 }
  34 close(WANT);
  35
  36 foreach $name (@dolist) {
  37
  38     $ucname = uc $name;
  39     $lcname = lc $name;
  40
  41     $outfile = "/ts_$lcname";
  42     open(OUTC, ">$outdir/$outfile.c") || die "open";
  43     open(OUTH, ">include/$outfile.h") || die "open";
  44
  45     $x11_incl = "";
  46     $extensions_dir = "";
  47     $pre_file = "";
  48     $post_file = "";
  49     if($name eq "Xutil" || $name eq "Xresource" || $name eq "XShm") {
  50         $x11_incl = "#include <X11/Xlib.h>\n";
  51         # For Xutil, we need X11/Xresource.h for XUniqueContext().
  52         $x11_incl .= "#include <X11/Xresource.h>\n" if $name eq "Xutil";
  53     }
  54     if($name eq "xf86dga")  {
  55         $x11_incl = "#include <X11/Xlib.h>\n";
  56         $extensions_dir = "extensions/";
  57         $pre_file = "#ifdef HAVE_LIBXXF86DGA\n";
  58         $post_file = "#endif /* defined(HAVE_LIBXXF86DGA) */\n";
  59     }
  60     if($name eq "XShm") {
  61         $extensions_dir = "extensions/";
  62         $pre_file = "#ifdef HAVE_LIBXXSHM\n";
  63         $post_file = "#endif /* defined(HAVE_LIBXXSHM) */\n";
  64     }
  65     if($name eq "xpm") {
  66         $pre_file = "#ifdef HAVE_LIBXXPM\n";
  67         $post_file = "#endif /* defined(HAVE_LIBXXPM) */\n";
  68     }
  69     if($name eq "xf86vmode") {
  70         $x11_incl = "#include <X11/Xlib.h>\n";
  71         $extensions_dir = "extensions/";
  72         $pre_file = "#include \"windef.h\"\n#ifdef HAVE_LIBXXF86VM\n#define XMD_H\n#include \"basetsd.h\"\n";
  73         $post_file = "#endif /* defined(HAVE_LIBXXF86VM) */\n";
  74     }
  75
  76     print OUTH <<END;
  77 /*
  78  * Thread safe wrappers around $name calls.
  79  * Always include this file instead of <X11/$name.h>.
  80  * This file was generated automatically by tools/make_X11wrappers
  81  *
  82  * Copyright 1998 Kristian Nielsen
  83  */
  84
  85 #ifndef __WINE_TS_$ucname\_H
  86 #define __WINE_TS_$ucname\_H
  87
  88 #include "config.h"
  89
  90 #ifndef X_DISPLAY_MISSING
  91
  92 $pre_file
  93 $x11_incl#include <X11/$extensions_dir$name.h>
  94
  95 END
  96
  97     print OUTC <<END;
  98 /*
  99  * Thread safe wrappers around $name calls.
 100  * This file was generated automatically by tools/make_X11wrappers
 101  * DO NOT EDIT!
 102  */
 103
 104 #include "config.h"
 105
 106 #ifndef X_DISPLAY_MISSING
 107
 108 $pre_file
 109 $x11_incl#include <X11/$extensions_dir$name.h>
 110
 111 #include "debugtools.h"
 112 #include "ts_$lcname.h"
 113 #include "x11drv.h"
 114
 115 DEFAULT_DEBUG_CHANNEL(x11)
 116 END
 117
 118     if($name eq "xpm") {        # Handle as special case.
 119         output_fn("XpmCreatePixmapFromData", "int",
 120                   "Display *, Drawable, char **, Pixmap *, Pixmap *, XpmAttributes *",
 121                   "Display *a0, Drawable a1, char **a2, Pixmap *a3, Pixmap *a4, XpmAttributes *a5",
 122                   "a0, a1, a2, a3, a4, a5");
 123         output_fn("XpmAttributesSize", "int", "void", "void", "");
 124     } elsif($name eq "XShm") {
 125         output_fn("XShmQueryExtension", "Bool",
 126                   "Display *", "Display *a0", "a0");
 127         output_fn("XShmQueryVersion", "Bool",
 128                   "Display *, int *, int *, Bool *",
 129                   "Display *a0, int *a1, int *a2, Bool *a3", "a0, a1, a2, a3");
 130         output_fn("XShmPixmapFormat", "int",
 131                   "Display *", "Display *a0", "a0");
 132         output_fn("XShmAttach", Status,
 133                   "Display *, XShmSegmentInfo *",
 134                   "Display *a0, XShmSegmentInfo *a1", "a0, a1");
 135         output_fn("XShmDetach", Status,
 136                   "Display *, XShmSegmentInfo *",
 137                   "Display *a0, XShmSegmentInfo *a1", "a0, a1");
 138         output_fn("XShmPutImage", Status,
 139                   "Display *, Drawable, GC, XImage *, int, int, int, int, unsigned int, unsigned int, Bool",
 140                   "Display *a0, Drawable a1, GC a2, XImage *a3, int a4, int a5, int a6, int a7, unsigned int a8, unsigned int a9, Bool a10", "a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10");
 141         output_fn("XShmGetImage", Status,
 142                   "Display *, Drawable, XImage *, int, int, unsigned long",
 143                   "Display *a0, Drawable a1, XImage *a2, int a3, int a4, unsigned long a5",
 144                   "a0, a1, a2, a3, a4, a5");
 145         output_fn("XShmCreateImage", "XImage *",
 146                   "Display *, Visual *, unsigned int, int, char *, XShmSegmentInfo *, unsigned int, unsigned int",
 147                   "Display *a0, Visual *a1, unsigned int a2, int a3, char *a4, XShmSegmentInfo *a5, unsigned int a6, unsigned int a7",
 148                   "a0, a1, a2, a3, a4, a5, a6, a7");
 149         output_fn("XShmCreatePixmap", "Pixmap",
 150                   "Display *, Drawable, char *, XShmSegmentInfo *, unsigned int, unsigned int, unsigned int",
 151                   "Display *a0, Drawable a1, char *a2, XShmSegmentInfo *a3, unsigned int a4, unsigned int a5, unsigned int a6",
 152                   "a0, a1, a2, a3, a4, a5, a6");
 153     } elsif($name eq "xf86dga") {
 154         output_fn("XF86DGAQueryVersion",Bool,
 155                 "Display*,int*,int*",
 156                 "Display*a0,int*a1,int*a2",
 157                 "a0,a1,a2"
 158         );
 159         output_fn("XF86DGAQueryExtension",Bool,
 160                 "Display*,int*,int*",
 161                 "Display*a0,int*a1,int*a2",
 162                 "a0,a1,a2"
 163         );
 164         output_fn("XF86DGAGetVideo",Status,
 165                 "Display*,int,char**,int*,int*,int*",
 166                 "Display*a0,int a1,char**a2,int*a3,int*a4,int*a5",
 167                 "a0,a1,a2,a3,a4,a5"
 168         );
 169         output_fn("XF86DGADirectVideo",Status,
 170                 "Display*,int,int",
 171                 "Display*a0,int a1,int a2",
 172                 "a0,a1,a2"
 173         );
 174         output_fn("XF86DGAGetViewPortSize",Status,
 175                 "Display*,int,int*,int*",
 176                 "Display*a0,int a1,int *a2,int *a3",
 177                 "a0,a1,a2,a3"
 178         );
 179         output_fn("XF86DGASetViewPort",Status,
 180                 "Display*,int,int,int",
 181                 "Display*a0,int a1,int a2,int a3",
 182                 "a0,a1,a2,a3"
 183         );
 184         output_fn("XF86DGAInstallColormap",Status,
 185                 "Display*,int,Colormap",
 186                 "Display*a0,int a1,Colormap a2",
 187                 "a0,a1,a2"
 188         );
 189         output_fn("XF86DGAQueryDirectVideo",Status,
 190                 "Display*,int,int*",
 191                 "Display*a0,int a1,int *a2",
 192                 "a0,a1,a2"
 193         );
 194         output_fn("XF86DGAViewPortChanged",Status,
 195                 "Display*,int,int",
 196                 "Display*a0,int a1,int a2",
 197                 "a0,a1,a2"
 198         );
 199     } elsif($name eq "xf86vmode") {
 200         output_fn("XF86VidModeQueryVersion",Bool,
 201                 "Display*,int*,int*",
 202                 "Display*a0,int*a1,int*a2",
 203                 "a0,a1,a2"
 204         );
 205         output_fn("XF86VidModeQueryExtension",Bool,
 206                 "Display*,int*,int*",
 207                 "Display*a0,int*a1,int*a2",
 208                 "a0,a2,a2"
 209         );
 210         output_fn("XF86VidModeGetModeLine",Bool,
 211                 "Display*,int,int*,XF86VidModeModeLine*",
 212                 "Display*a0,int a1,int*a2,XF86VidModeModeLine*a3",
 213                 "a0,a1,a2,a3"
 214         );
 215         output_fn("XF86VidModeGetAllModeLines",Bool,
 216                 "Display*,int,int*,XF86VidModeModeInfo***",
 217                 "Display*a0,int a1,int*a2,XF86VidModeModeInfo***a3",
 218                 "a0,a1,a2,a3"
 219         );
 220         output_fn("XF86VidModeAddModeLine",Bool,
 221                 "Display*,int,XF86VidModeModeInfo*,XF86VidModeModeInfo*",
 222                 "Display*a0,int a1,XF86VidModeModeInfo*a2,XF86VidModeModeInfo*a3",
 223                 "a0,a1,a2,a3"
 224         );
 225         output_fn("XF86VidModeDeleteModeLine",Bool,
 226                 "Display*,int,XF86VidModeModeInfo*",
 227                 "Display*a0,int a1,XF86VidModeModeInfo*a2",
 228                 "a0,a1,a2"
 229         );
 230         output_fn("XF86VidModeModModeLine",Bool,
 231                 "Display*,int,XF86VidModeModeLine*",
 232                 "Display*a0,int a1,XF86VidModeModeLine*a2",
 233                 "a0,a1,a2"
 234         );
 235         output_fn("XF86VidModeValidateModeLine",Status,
 236                 "Display*,int,XF86VidModeModeInfo*",
 237                 "Display*a0,int a1,XF86VidModeModeInfo*a2",
 238                 "a0,a1,a2"
 239         );
 240         output_fn("XF86VidModeSwitchMode",Bool,
 241                 "Display*,int,int",
 242                 "Display*a0,int a1,int a2",
 243                 "a0,a1,a2"
 244         );
 245         output_fn("XF86VidModeSwitchToMode",Bool,
 246                 "Display*,int,XF86VidModeModeInfo*",
 247                 "Display*a0,int a1,XF86VidModeModeInfo*a2",
 248                 "a0,a1,a2"
 249         );
 250         output_fn("XF86VidModeLockModeSwitch",Bool,
 251                 "Display*,int,int",
 252                 "Display*a0,int a1,int a2",
 253                 "a0,a1,a2"
 254         );
 255         output_fn("XF86VidModeGetMonitor",Bool,
 256                 "Display*,int,XF86VidModeMonitor*",
 257                 "Display*a0,int a1,XF86VidModeMonitor*a2",
 258                 "a0,a1,a2"
 259         );
 260         output_fn("XF86VidModeGetViewPort",Bool,
 261                 "Display*,int,int*,int*",
 262                 "Display*a0,int a1,int*a2,int*a3",
 263                 "a0,a1,a2,a3"
 264         );
 265         output_fn("XF86VidModeSetViewPort",Bool,
 266                 "Display*,int,int,int",
 267                 "Display*a0,int a1,int a2,int a3",
 268                 "a0,a1,a2,a3"
 269         );
 270     } else {
 271         open(IN,
 272              "echo \"$x11_incl#include <X11/$extensions_dir$name.h>\" | " .
 273              "gcc -L$X11_include_dir -DNeedFunctionPrototypes -E - | " .
 274              "grep -v '^[ \t]*\$)' |"
 275              ) || die "open";
 276
 277       PROTO: while(<IN>) {
 278           if(m'extern\s+([^()]*)\b([a-zA-Z0-9_]+)\s*\(') {
 279               $result_type = $1;
 280               $fn_name = $2;
 281               $result_type = "int" if $result_type =~ /^\s*$/;
 282               @args = ();
 283               while(<IN>) {
 284                   last if m'\)\s*;';
 285                   # Give up on vararg functions and function pointer args.
 286                   if(m'\.\.\.|\(\*\)') {
 287                       undef $fn_name;
 288                       last;
 289                   }
 290                   if(m'\s*([^,]*[^, \t])\s*(,?\n)') {
 291                       $args[$#args+1] = $1;
 292                       if ($1 =~ /char\s*\[/) { # small hack for XQueryKeymap
 293                         $args[$#args] = "char*";
 294                       }
 295                   }
 296               }
 297               # Skip if vararg, function pointer arg, or not needed.
 298               next unless $fn_name;
 299               next unless $want{$fn_name} && $want{$fn_name} == 1;
 300
 301               # Special case for no arguments (which is specified as "void").
 302               if($#args == 0 && $args[0] eq "void") {
 303                   @args = ();
 304               }
 305               $proto = "";
 306               $formals = "";
 307               $actuals = "";
 308               for($i = 0; $i <= $#args; $i++) {
 309                   $comma = $i < $#args ? ", " : "";
 310                   $proto .= "$args[$i]$comma";
 311                   $formals .= "$args[$i] a$i$comma";
 312                   $actuals .= "a$i$comma";
 313               }
 314               $proto = $formals = "void" if $#args == -1;
 315               output_fn($fn_name, $result_type, $proto, $formals, $actuals);
 316           }
 317       }
 318     }
 319
 320     if($name eq "Xlib") {
 321         raw_output_fn("XSynchronize", "int (*r)(Display *)",
 322                   "int (*TSXSynchronize(Display *, Bool))(Display *)",
 323                   "int (*TSXSynchronize(Display *a0, Bool a1))(Display *)",
 324                   "a0, a1");
 325         print OUTC "\nextern void _XInitImageFuncPtrs(XImage *);\n";
 326         output_fn("_XInitImageFuncPtrs", "void", "XImage *", "XImage *a0", "a0");
 327     } elsif($name eq "Xutil") {
 328         output_fn("XDestroyImage", "int",
 329                   "struct _XImage *", "struct _XImage *a0", "a0");
 330         output_fn("XGetPixel", "unsigned long",
 331                   "struct _XImage *, int, int",
 332                   "struct _XImage *a0, int a1, int a2",
 333                   "a0, a1, a2");
 334         output_fn("XPutPixel", "int",
 335                   "struct _XImage *, int, int, unsigned long",
 336                   "struct _XImage *a0, int a1, int a2, unsigned long a3",
 337                   "a0, a1, a2, a3");
 338         output_fn("XSubImage", "struct _XImage *",
 339                   "struct _XImage *, int, int, unsigned int, unsigned int",
 340                   "struct _XImage *a0, int a1, int a2, unsigned int a3, unsigned int a4",
 341                   "a0, a1, a2, a3, a4");
 342         output_fn("XAddPixel", "int",
 343                   "struct _XImage *, long",
 344                   "struct _XImage *a0, long a1", "a0, a1");
 345         output_fn("XUniqueContext", "XContext", "void", "void", "");
 346     }
 347
 348     print OUTH <<END;
 349
 350 $post_file
 351 #endif /* !defined(X_DISPLAY_MISSING) */
 352
 353 #endif /* __WINE_TS_$ucname\_H */
 354 END
 355     print OUTC <<END;
 356
 357 $post_file
 358 #endif /* !defined(X_DISPLAY_MISSING) */
 359 END
 360
 361
 362
 363 }
 364
 365 foreach $i (keys %want) {
 366     if($want{$i} == 1) {
 367         print "Unresolved: $i\n";
 368     }
 369 }
 370
 371
 372 sub output_fn {
 373     # Example call:
 374     # output_fn("main", "int", "int, char **", "int a0, char **a1", "a0, a1")
 375     #
 376
 377     my ($fn_name, $result_type, $protos, $formals, $actuals) = @_;
 378
 379     return raw_output_fn($fn_name,
 380                          $result_type =~ /^\s*void\s*$/ ? "" : "$result_type r",
 381                          "$result_type TS$fn_name($protos)",
 382                          "$result_type TS$fn_name($formals)",
 383                          $actuals);
 384 }
 385
 386 sub raw_output_fn {
 387     # Example call:
 388     # output_fn("main", "int r", "int main(int, char **)", "int main(int a0, char **a1)", "a0, a1")
 389     #
 390
 391     my ($fn_name, $resultdecl, $protodecl, $defdecl, $actuals) = @_;
 392
 393     return undef unless $want{$fn_name} && $want{$fn_name} == 1;
 394
 395     print OUTC "\n$defdecl\n";
 396     print OUTH "extern $protodecl;\n";
 397 #    print OUTH "#define $fn_name TS$fn_name\n";
 398     print OUTC "{\n";
 399     print OUTC "  $resultdecl;\n" if $resultdecl;
 400     print OUTC "  TRACE(\"Call $fn_name\\n\");\n";
 401     print OUTC "  EnterCriticalSection( &X11DRV_CritSection );\n";
 402     print OUTC "  ";
 403     print OUTC "r = " if $resultdecl;
 404     print OUTC "$fn_name($actuals);\n";
 405     print OUTC "  LeaveCriticalSection( &X11DRV_CritSection );\n";
 406     print OUTC "  TRACE(\"Ret $fn_name\\n\");\n";
 407     print OUTC "  return r;\n" if $resultdecl;
 408     print OUTC "}\n";
 409     $want{$fn_name} = 2;
 410     return 1;
 411 }