tools/make_requests

   1 #! /usr/bin/perl -w
   2 #
   3 # Build the server/trace.c and server/request.h files
   4 # from the contents of include/wine/server.h.
   5 #
   6 # Copyright (C) 1998 Alexandre Julliard
   7 #
   8 # This library is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU Lesser General Public
  10 # License as published by the Free Software Foundation; either
  11 # version 2.1 of the License, or (at your option) any later version.
  12 #
  13 # This library is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # Lesser General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Lesser General Public
  19 # License along with this library; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21 #
  22
  23 %formats =
  24 (
  25     "int"           => "%d",
  26     "short int"     => "%d",
  27     "char"          => "%c",
  28     "unsigned char" => "%02x",
  29     "unsigned short"=> "%04x",
  30     "unsigned int"  => "%08x",
  31     "void*"         => "%p",
  32     "time_t"        => "%ld",
  33     "size_t"        => "%d",
  34     "obj_handle_t"  => "%d",
  35     "atom_t"        => "%04x",
  36     "user_handle_t" => "%08x",
  37     "rectangle_t"   => "&dump_rectangle",
  38     "char_info_t"   => "&dump_char_info",
  39 );
  40
  41 my @requests = ();
  42 my %replies = ();
  43
  44 my @trace_lines = ();
  45
  46 # Get the server protocol version
  47 my $protocol = &GET_PROTOCOL_VERSION;
  48
  49 ### Create server_protocol.h and print header
  50
  51 open SERVER_PROT, ">include/wine/server_protocol.h" or die "Cannot create include/wine/server_protocol.h";
  52 print SERVER_PROT "/*\n * Wine server protocol definitions\n *\n";
  53 print SERVER_PROT " * This file is automatically generated; DO NO EDIT!\n";
  54 print SERVER_PROT " * Edit server/protocol.def instead and re-run tools/make_requests\n";
  55 print SERVER_PROT " */\n\n";
  56 print SERVER_PROT "#ifndef __WINE_WINE_SERVER_PROTOCOL_H\n";
  57 print SERVER_PROT "#define __WINE_WINE_SERVER_PROTOCOL_H\n";
  58
  59 ### Parse requests to find request/reply structure definitions
  60
  61 &PARSE_REQUESTS;
  62
  63 ### Build the request list and structures
  64
  65 print SERVER_PROT "\n\nenum request\n{\n";
  66 foreach $req (@requests) { print SERVER_PROT "    REQ_$req,\n"; }
  67 print SERVER_PROT "    REQ_NB_REQUESTS\n};\n\n";
  68
  69 print SERVER_PROT "union generic_request\n{\n";
  70 print SERVER_PROT "    struct request_max_size max_size;\n";
  71 print SERVER_PROT "    struct request_header request_header;\n";
  72 foreach $req (@requests) { print SERVER_PROT "    struct ${req}_request ${req}_request;\n"; }
  73 print SERVER_PROT "};\n";
  74
  75 print SERVER_PROT "union generic_reply\n{\n";
  76 print SERVER_PROT "    struct request_max_size max_size;\n";
  77 print SERVER_PROT "    struct reply_header reply_header;\n";
  78 foreach $req (@requests) { print SERVER_PROT "    struct ${req}_reply ${req}_reply;\n"; }
  79 print SERVER_PROT "};\n\n";
  80
  81 printf SERVER_PROT "#define SERVER_PROTOCOL_VERSION %d\n\n", $protocol + 1;
  82 print SERVER_PROT "#endif /* __WINE_WINE_SERVER_PROTOCOL_H */\n";
  83 close SERVER_PROT;
  84
  85 ### Output the dumping function tables
  86
  87 push @trace_lines, "static const dump_func req_dumpers[REQ_NB_REQUESTS] = {\n";
  88 foreach $req (@requests)
  89 {
  90     push @trace_lines, "    (dump_func)dump_${req}_request,\n";
  91 }
  92 push @trace_lines, "};\n\n";
  93
  94 push @trace_lines, "static const dump_func reply_dumpers[REQ_NB_REQUESTS] = {\n";
  95 foreach $req (@requests)
  96 {
  97     push @trace_lines, "    (dump_func)", $replies{$req} ? "dump_${req}_reply,\n" : "0,\n";
  98 }
  99 push @trace_lines, "};\n\n";
 100
 101 push @trace_lines, "static const char * const req_names[REQ_NB_REQUESTS] = {\n";
 102 foreach $req (@requests)
 103 {
 104     push @trace_lines, "    \"$req\",\n";
 105 }
 106 push @trace_lines, "};\n";
 107
 108 REPLACE_IN_FILE( "server/trace.c", @trace_lines );
 109
 110 ### Output the request handlers list
 111
 112 my @request_lines = ();
 113
 114 foreach $req (@requests) { push @request_lines, "DECL_HANDLER($req);\n"; }
 115 push @request_lines, "\n#ifdef WANT_REQUEST_HANDLERS\n\n";
 116 push @request_lines, "typedef void (*req_handler)( const void *req, void *reply );\n";
 117 push @request_lines, "static const req_handler req_handlers[REQ_NB_REQUESTS] =\n{\n";
 118 foreach $req (@requests)
 119 {
 120     push @request_lines, "    (req_handler)req_$req,\n";
 121 }
 122 push @request_lines, "};\n#endif  /* WANT_REQUEST_HANDLERS */\n";
 123
 124 REPLACE_IN_FILE( "server/request.h", @request_lines );
 125
 126 ### Parse the request definitions
 127
 128 sub PARSE_REQUESTS
 129 {
 130     # states: 0 = header 1 = declarations 2 = inside @REQ 3 = inside @REPLY
 131     my $state = 0;
 132     my $name = "";
 133     my @in_struct = ();
 134     my @out_struct = ();
 135
 136     open(PROTOCOL,"server/protocol.def") or die "Can't open server/protocol.def";
 137
 138     while (<PROTOCOL>)
 139     {
 140         my ($type, $var);
 141         # strip comments
 142         s!/\*.*\*/!!g;
 143         # strip white space at end of line
 144         s/\s+$//;
 145
 146         if (/^\@HEADER/)
 147         {
 148             die "Misplaced \@HEADER" unless $state == 0;
 149             $state++;
 150             next;
 151         }
 152
 153         # ignore everything while in state 0
 154         next if $state == 0;
 155
 156         if (/^\@REQ\(\s*(\w+)\s*\)/)
 157         {
 158             $name = $1;
 159             die "Misplaced \@REQ" unless $state == 1;
 160             # start a new request
 161             @in_struct = ();
 162             @out_struct = ();
 163             print SERVER_PROT "struct ${name}_request\n{\n";
 164             print SERVER_PROT "    struct request_header __header;\n";
 165             $state++;
 166             next;
 167         }
 168
 169         if (/^\@REPLY/)
 170         {
 171             die "Misplaced \@REPLY" unless $state == 2;
 172             print SERVER_PROT "};\n";
 173             print SERVER_PROT "struct ${name}_reply\n{\n";
 174             print SERVER_PROT "    struct reply_header __header;\n";
 175             $state++;
 176             next;
 177         }
 178
 179         if (/^\@END/)
 180         {
 181             die "Misplaced \@END" unless ($state == 2 || $state == 3);
 182             print SERVER_PROT "};\n";
 183
 184             if ($state == 2)  # build dummy reply struct
 185             {
 186                 print SERVER_PROT "struct ${name}_reply\n{\n";
 187                 print SERVER_PROT "    struct reply_header __header;\n";
 188                 print SERVER_PROT "};\n";
 189             }
 190
 191             # got a complete request
 192             push @requests, $name;
 193             &DO_DUMP_FUNC( $name, "request", @in_struct);
 194             if ($#out_struct >= 0)
 195             {
 196                 $replies{$name} = 1;
 197                 &DO_DUMP_FUNC( $name, "reply", @out_struct);
 198             }
 199             $state = 1;
 200             next;
 201         }
 202
 203         if ($state != 1)
 204         {
 205             # skip empty lines (but keep them in output file)
 206             if (/^$/)
 207             {
 208                 print SERVER_PROT "\n";
 209                 next;
 210             }
 211
 212             if (/^\s*VARARG\((\w+),(\w+),(\w+)\)/)
 213             {
 214                 $var = $1;
 215                 $type = "dump_varargs_" . $2 . "( min(cur_size,req->" . $3 . ") )";
 216                 s!(VARARG\(.*\)\s*;)!/* $1 */!;
 217             }
 218             elsif (/^\s*VARARG\((\w+),(\w+)\)/)
 219             {
 220                 $var = $1;
 221                 $type = "dump_varargs_" . $2 . "( cur_size )";
 222                 s!(VARARG\(.*\)\s*;)!/* $1 */!;
 223             }
 224             elsif (/^\s*(\w+\**(\s+\w+\**)*)\s+(\w+);/)
 225             {
 226                 $type = $1;
 227                 $var = $3;
 228                 die "Unrecognized type $type" unless defined($formats{$type});
 229             }
 230             else
 231             {
 232                 die "Unrecognized syntax $_";
 233             }
 234             if ($state == 2) { push @in_struct, $type, $var; }
 235             if ($state == 3) { push @out_struct, $type, $var; }
 236         }
 237
 238         # Pass it through into the output file
 239         print SERVER_PROT $_ . "\n";
 240     }
 241     close PROTOCOL;
 242 }
 243
 244 ### Generate a dumping function
 245
 246 sub DO_DUMP_FUNC
 247 {
 248     my $name = shift;
 249     my $req = shift;
 250     push @trace_lines, "static void dump_${name}_$req( const struct ${name}_$req *req )\n{\n";
 251     while ($#_ >= 0)
 252     {
 253         my $type = shift;
 254         my $var = shift;
 255         if (defined($formats{$type}))
 256         {
 257             if ($formats{$type} =~ /^&(.*)/)
 258             {
 259                 my $func = $1;
 260                 push @trace_lines, "    fprintf( stderr, \" $var=\" );\n";
 261                 push @trace_lines, "    $func( &req->$var );\n";
 262                 push @trace_lines, "    fprintf( stderr, \",\" );\n" if ($#_ > 0);
 263             }
 264             else
 265             {
 266                 push @trace_lines, "    fprintf( stderr, \" $var=$formats{$type}";
 267                 push @trace_lines, "," if ($#_ > 0);
 268                 push @trace_lines, "\", ";
 269                 push @trace_lines, "req->$var );\n";
 270             }
 271         }
 272         else  # must be some varargs format
 273         {
 274             my $func = $type;
 275             push @trace_lines, "    fprintf( stderr, \" $var=\" );\n";
 276             push @trace_lines, "    $func;\n";
 277             push @trace_lines, "    fputc( ',', stderr );\n" if ($#_ > 0);
 278         }
 279     }
 280     push @trace_lines, "}\n\n";
 281 }
 282
 283 ### Retrieve the server protocol version from the existing server_protocol.h file
 284
 285 sub GET_PROTOCOL_VERSION
 286 {
 287     my $protocol = 0;
 288     open SERVER_PROT, "include/wine/server_protocol.h" or return 0;
 289     while (<SERVER_PROT>)
 290     {
 291         if (/^\#define SERVER_PROTOCOL_VERSION (\d+)/) { $protocol = $1; last; }
 292     }
 293     close SERVER_PROT;
 294     return $protocol;
 295 }
 296
 297 ### Replace the contents of a file between ### make_requests ### marks
 298
 299 sub REPLACE_IN_FILE
 300 {
 301     my $name = shift;
 302     my @data = @_;
 303     my @lines = ();
 304     open(FILE,$name) or die "Can't open $name";
 305     while (<FILE>)
 306     {
 307         push @lines, $_;
 308         last if /\#\#\# make_requests begin \#\#\#/;
 309     }
 310     push @lines, "\n", @data;
 311     while (<FILE>)
 312     {
 313         if (/\#\#\# make_requests end \#\#\#/) { push @lines, "\n", $_; last; }
 314     }
 315     push @lines, <FILE>;
 316     open(FILE,">$name") or die "Can't modify $name";
 317     print FILE @lines;
 318     close(FILE);
 319 }