2011-03-04 Ilya Tikhonovsky <loislo@chromium.org>
[WebKit-https.git] / Source / WebCore / inspector / CodeGeneratorInspector.pm
1 # Copyright (c) 2010 The Chromium Authors. All rights reserved.
2 # Use of this source code is governed by a BSD-style license that can be
3 # found in the LICENSE file.
4
5 package CodeGeneratorInspector;
6
7 use strict;
8
9 use Class::Struct;
10 use File::stat;
11
12 my %typeTransform;
13 $typeTransform{"ApplicationCache"} = {
14     "forward" => "InspectorApplicationCacheAgent",
15     "header" => "InspectorApplicationCacheAgent.h",
16     "domainAccessor" => "m_inspectorAgent->applicationCacheAgent()",
17 };
18 $typeTransform{"CSS"} = {
19     "forward" => "InspectorCSSAgent",
20     "header" => "InspectorCSSAgent.h",
21     "domainAccessor" => "m_inspectorAgent->cssAgent()",
22 };
23 $typeTransform{"Console"} = {
24     "forward" => "InspectorConsoleAgent",
25     "header" => "InspectorConsoleAgent.h",
26     "domainAccessor" => "m_inspectorAgent->consoleAgent()",
27 };
28 $typeTransform{"Debugger"} = {
29     "forward" => "InspectorDebuggerAgent",
30     "header" => "InspectorDebuggerAgent.h",
31     "domainAccessor" => "m_inspectorAgent->debuggerAgent()",
32 };
33 $typeTransform{"BrowserDebugger"} = {
34     "forward" => "InspectorBrowserDebuggerAgent",
35     "header" => "InspectorBrowserDebuggerAgent.h",
36     "domainAccessor" => "m_inspectorAgent->browserDebuggerAgent()",
37 };
38 $typeTransform{"Database"} = {
39     "forward" => "InspectorDatabaseAgent",
40     "header" => "InspectorDatabaseAgent.h",
41     "domainAccessor" => "m_inspectorAgent->databaseAgent()",
42 };
43 $typeTransform{"DOM"} = {
44     "forward" => "InspectorDOMAgent",
45     "header" => "InspectorDOMAgent.h",
46     "domainAccessor" => "m_inspectorAgent->domAgent()",
47 };
48 $typeTransform{"DOMStorage"} = {
49     "forward" => "InspectorDOMStorageAgent",
50     "header" => "InspectorDOMStorageAgent.h",
51     "domainAccessor" => "m_inspectorAgent->domStorageAgent()",
52 };
53 $typeTransform{"FileSystem"} = {
54     "forward" => "InspectorFileSystemAgent",
55     "header" => "InspectorFileSystemAgent.h",
56     "domainAccessor" => "m_inspectorAgent->fileSystemAgent()",
57 };
58 $typeTransform{"Inspector"} = {
59     "forwardHeader" => "InspectorAgent.h",
60     "domainAccessor" => "m_inspectorAgent",
61 };
62 $typeTransform{"Network"} = {
63     "forward" => "InspectorResourceAgent",
64     "header" => "InspectorResourceAgent.h",
65     "domainAccessor" => "m_inspectorAgent->resourceAgent()",
66 };
67 $typeTransform{"Profiler"} = {
68     "forward" => "InspectorProfilerAgent",
69     "header" => "InspectorProfilerAgent.h",
70     "domainAccessor" => "m_inspectorAgent->profilerAgent()",
71 };
72 $typeTransform{"Runtime"} = {
73     "forward" => "InspectorRuntimeAgent",
74     "header" => "InspectorRuntimeAgent.h",
75     "domainAccessor" => "m_inspectorAgent->runtimeAgent()",
76 };
77 $typeTransform{"Timeline"} = {
78     "forward" => "InspectorTimelineAgent",
79     "header" => "InspectorTimelineAgent.h",
80     "domainAccessor" => "m_inspectorAgent->timelineAgent()",
81 };
82
83 $typeTransform{"Frontend"} = {
84     "forward" => "InspectorFrontend",
85     "header" => "InspectorFrontend.h",
86 };
87 $typeTransform{"InspectorClient"} = {
88     "forward" => "InspectorClient",
89     "header" => "InspectorClient.h",
90 };
91 $typeTransform{"PassRefPtr"} = {
92     "forwardHeader" => "wtf/PassRefPtr.h",
93 };
94 $typeTransform{"Object"} = {
95     "param" => "PassRefPtr<InspectorObject>",
96     "variable" => "RefPtr<InspectorObject>",
97     "defaultValue" => "InspectorObject::create()",
98     "forward" => "InspectorObject",
99     "header" => "InspectorValues.h",
100     "JSONType" => "Object",
101     "JSType" => "object",
102     "DocType" => "%s"
103 };
104 $typeTransform{"Array"} = {
105     "param" => "PassRefPtr<InspectorArray>",
106     "variable" => "RefPtr<InspectorArray>",
107     "defaultValue" => "InspectorArray::create()",
108     "forward" => "InspectorArray",
109     "header" => "InspectorValues.h",
110     "JSONType" => "Array",
111     "JSType" => "object",
112     "DocType" => "array of %s"
113 };
114 $typeTransform{"Value"} = {
115     "param" => "PassRefPtr<InspectorValue>",
116     "variable" => "RefPtr<InspectorValue>",
117     "defaultValue" => "InspectorValue::null()",
118     "forward" => "InspectorValue",
119     "header" => "InspectorValues.h",
120     "JSONType" => "Value",
121     "JSType" => "",
122     "DocType" => "value"
123 };
124 $typeTransform{"String"} = {
125     "param" => "const String&",
126     "variable" => "String",
127     "return" => "String",
128     "defaultValue" => "\"\"",
129     "forwardHeader" => "PlatformString.h",
130     "header" => "PlatformString.h",
131     "JSONType" => "String",
132     "JSType" => "string"
133 };
134 $typeTransform{"long"} = {
135     "param" => "long",
136     "variable" => "long",
137     "defaultValue" => "0",
138     "forward" => "",
139     "header" => "",
140     "JSONType" => "Number",
141     "JSType" => "number"
142 };
143 $typeTransform{"int"} = {
144     "param" => "int",
145     "variable" => "int",
146     "defaultValue" => "0",
147     "forward" => "",
148     "header" => "",
149     "JSONType" => "Number",
150     "JSType" => "number"
151 };
152 $typeTransform{"unsigned long"} = {
153     "param" => "unsigned long",
154     "variable" => "unsigned long",
155     "defaultValue" => "0u",
156     "forward" => "",
157     "header" => "",
158     "JSONType" => "Number",
159     "JSType" => "number"
160 };
161 $typeTransform{"unsigned int"} = {
162     "param" => "unsigned int",
163     "variable" => "unsigned int",
164     "defaultValue" => "0u",
165     "forward" => "",
166     "header" => "",
167     "JSONType" => "Number",
168     "JSType" => "number"
169 };
170 $typeTransform{"double"} = {
171     "param" => "double",
172     "variable" => "double",
173     "defaultValue" => "0.0",
174     "forward" => "",
175     "header" => "",
176     "JSONType" => "Number",
177     "JSType" => "number"
178 };
179 $typeTransform{"boolean"} = {
180     "param" => "bool",
181     "variable"=> "bool",
182     "defaultValue" => "false",
183     "forward" => "",
184     "header" => "",
185     "JSONType" => "Boolean",
186     "JSType" => "boolean"
187 };
188 $typeTransform{"void"} = {
189     "forward" => "",
190     "header" => ""
191 };
192
193 # Default License Templates
194
195 my $licenseTemplate = << "EOF";
196 // Copyright (c) 2010 The Chromium Authors. All rights reserved.
197 // Use of this source code is governed by a BSD-style license that can be
198 // found in the LICENSE file.
199 EOF
200
201 my $codeGenerator;
202 my $outputDir;
203 my $outputHeadersDir;
204 my $writeDependencies;
205 my $verbose;
206
207 my $namespace;
208
209 my $backendClassName;
210 my $backendJSStubName;
211 my %backendTypes;
212 my @backendMethods;
213 my @backendMethodsImpl;
214 my %backendMethodSignatures;
215 my $backendConstructor;
216 my @backendConstantDeclarations;
217 my @backendConstantDefinitions;
218 my $backendFooter;
219 my @backendJSStubs;
220
221 my $frontendClassName;
222 my %frontendTypes;
223 my @frontendMethods;
224 my @frontendAgentFields;
225 my @frontendMethodsImpl;
226 my %frontendMethodSignatures;
227 my $frontendConstructor;
228 my @frontendConstantDeclarations;
229 my @frontendConstantDefinitions;
230 my @frontendFooter;
231
232 my @documentationToc;
233 my @documentationLines;
234
235 # Default constructor
236 sub new
237 {
238     my $object = shift;
239     my $reference = { };
240
241     $codeGenerator = shift;
242     $outputDir = shift;
243     $outputHeadersDir = shift;
244     shift; # $useLayerOnTop
245     shift; # $preprocessor
246     $writeDependencies = shift;
247     $verbose = shift;
248
249     bless($reference, $object);
250     return $reference;
251 }
252
253 # Params: 'idlDocument' struct
254 sub GenerateModule
255 {
256     my $object = shift;
257     my $dataNode = shift;
258
259     $namespace = $dataNode->module;
260     $namespace =~ s/core/WebCore/;
261
262     $frontendClassName = "InspectorFrontend";
263     $frontendConstructor = "    ${frontendClassName}(InspectorClient*);";
264     push(@frontendFooter, "private:");
265     push(@frontendFooter, "    InspectorClient* m_inspectorClient;");
266     $frontendTypes{"String"} = 1;
267     $frontendTypes{"InspectorClient"} = 1;
268     $frontendTypes{"PassRefPtr"} = 1;
269
270     $backendClassName = "InspectorBackendDispatcher";
271     $backendJSStubName = "InspectorBackendStub";
272     my @backendHead;
273     push(@backendHead, "    ${backendClassName}(InspectorAgent* inspectorAgent) : m_inspectorAgent(inspectorAgent) { }");
274     push(@backendHead, "    void reportProtocolError(const long callId, const String& errorText) const;");
275     push(@backendHead, "    void dispatch(const String& message);");
276     push(@backendHead, "    static bool getCommandName(const String& message, String* result);");
277     $backendConstructor = join("\n", @backendHead);
278     $backendFooter = "    InspectorAgent* m_inspectorAgent;";
279     $backendTypes{"Inspector"} = 1;
280     $backendTypes{"InspectorClient"} = 1;
281     $backendTypes{"PassRefPtr"} = 1;
282     $backendTypes{"Object"} = 1;
283 }
284
285 # Params: 'idlDocument' struct
286 sub GenerateInterface
287 {
288     my $object = shift;
289     my $interface = shift;
290     my $defines = shift;
291
292     my %agent = (
293         methodDeclarations => [],
294         methodSignatures => {}
295     );
296     generateFunctions($interface, \%agent);
297     if (@{%agent->{methodDeclarations}}) {
298         generateAgentDeclaration($interface, \%agent);
299     }
300 }
301
302 sub generateAgentDeclaration
303 {
304     my $interface = shift;
305     my $agent = shift;
306     my $agentName = $interface->name;
307     push(@frontendMethods, "    class ${agentName} {");
308     push(@frontendMethods, "    public:");
309     push(@frontendMethods, "        ${agentName}(InspectorClient* inspectorClient) : m_inspectorClient(inspectorClient) { }");
310     push(@frontendMethods, @{$agent->{methodDeclarations}});
311     push(@frontendMethods, "    private:");
312     push(@frontendMethods, "        InspectorClient* m_inspectorClient;");
313     push(@frontendMethods, "    };");
314     push(@frontendMethods, "");
315
316     my $getterName = lc($agentName);
317     push(@frontendMethods, "    ${agentName}* ${getterName}() { return &m_${getterName}; }");
318     push(@frontendMethods, "");
319
320     push(@frontendFooter, "    ${agentName} m_${getterName};");
321
322     push(@frontendAgentFields, "m_${getterName}");
323 }
324
325 sub generateFrontendConstructorImpl
326 {
327     my @frontendConstructorImpl;
328     push(@frontendConstructorImpl, "${frontendClassName}::${frontendClassName}(InspectorClient* inspectorClient)");
329     push(@frontendConstructorImpl, "    : m_inspectorClient(inspectorClient)");
330     foreach my $agentField (@frontendAgentFields) {
331         push(@frontendConstructorImpl, "    , ${agentField}(inspectorClient)");
332     }
333     push(@frontendConstructorImpl, "{");
334     push(@frontendConstructorImpl, "}");
335     return @frontendConstructorImpl;
336 }
337
338 sub generateFunctions
339 {
340     my $interface = shift;
341     my $agent = shift;
342
343     foreach my $function (@{$interface->functions}) {
344         if ($function->signature->extendedAttributes->{"event"}) {
345             generateFrontendFunction($interface, $function, $agent);
346         } else {
347             generateBackendFunction($interface, $function);
348         }
349     }
350
351     push(@documentationToc, "<li><a href='#" . $interface->name . "'>" . $interface->name . "</a></li>");
352     push(@documentationLines, "<h2 id='" . $interface->name . "'><a name=" . $interface->name . "></a>" . $interface->name . "</h2>");
353
354     push(@documentationLines, "<h3>Events</h3>");
355     foreach my $function (grep($_->signature->extendedAttributes->{"event"}, @{$interface->functions}) ) {
356         generateDocumentationEvent($interface, $function);
357     }
358
359     push(@documentationLines, "<h3>Commands</h3>");
360     foreach my $function (grep(!$_->signature->extendedAttributes->{"event"}, @{$interface->functions})) {
361         generateDocumentationCommand($interface, $function);
362     }
363
364     collectBackendJSStubFunctions($interface);
365 }
366
367 sub generateFrontendFunction
368 {
369     my $interface = shift;
370     my $function = shift;
371     my $agent = shift;
372
373     my $functionName = $function->signature->name;
374
375     my $domain = $interface->name;
376     my @argsFiltered = grep($_->direction eq "out", @{$function->parameters}); # just keep only out parameters for frontend interface.
377     map($frontendTypes{$_->type} = 1, @argsFiltered); # register required types.
378     my $arguments = join(", ", map(typeTraits($_->type, "param") . " " . $_->name, @argsFiltered)); # prepare arguments for function signature.
379
380     my $signature = "        void ${functionName}(${arguments});";
381     !$agent->{methodSignatures}->{$signature} || die "Duplicate frontend function was detected for signature '$signature'.";
382     $agent->{methodSignatures}->{$signature} = 1;
383     push(@{$agent->{methodDeclarations}}, $signature);
384
385     my @function;
386     push(@function, "void ${frontendClassName}::${domain}::${functionName}(${arguments})");
387     push(@function, "{");
388     push(@function, "    RefPtr<InspectorObject> ${functionName}Message = InspectorObject::create();");
389     push(@function, "    ${functionName}Message->setString(\"type\", \"event\");");
390     push(@function, "    ${functionName}Message->setString(\"domain\", \"$domain\");");
391     push(@function, "    ${functionName}Message->setString(\"event\", \"$functionName\");");
392     push(@function, "    RefPtr<InspectorObject> bodyObject = InspectorObject::create();");
393     my @pushArguments = map("    bodyObject->set" . typeTraits($_->type, "JSONType") . "(\"" . $_->name . "\", " . $_->name . ");", @argsFiltered);
394     push(@function, @pushArguments);
395     push(@function, "    ${functionName}Message->setObject(\"body\", bodyObject);");
396     push(@function, "    m_inspectorClient->sendMessageToFrontend(${functionName}Message->toJSONString());");
397     push(@function, "}");
398     push(@function, "");
399     push(@frontendMethodsImpl, @function);
400 }
401
402 sub generateDocumentationEvent
403 {
404     my $interface = shift;
405     my $function = shift;
406
407     my $functionName = $function->signature->name;
408     my $domain = $interface->name;
409
410     my @argsFiltered = grep($_->direction eq "out", @{$function->parameters});
411
412     my @lines;
413     push(@lines, "<h4>" . $interface->name . "." . ${functionName} . "</h4>");
414     my $doc = $function->signature->extendedAttributes->{"doc"};
415     if ($doc) {
416         push(@lines, $doc);
417     }
418
419     push(@lines, "<pre style='background: lightGrey; padding: 10px'>");
420     push(@lines, "{");
421     push(@lines, "    seq: &lt;number&gt;,");
422     push(@lines, "    type: \"event\",");
423     push(@lines, "    domain: \"$domain\",");
424     if (scalar(@argsFiltered)) {
425         push(@lines, "    event: \"${functionName}\",");
426         push(@lines, "    data: {");
427         my @parameters;
428         foreach my $parameter (@argsFiltered) {
429             push(@parameters, "        " . parameterDocLine($parameter));
430         }
431         push(@lines, join(",\n", @parameters));
432         push(@lines, "    }");
433     } else {
434         push(@lines, "    event: \"${functionName}\"");
435     }
436     push(@lines, "}");
437     push(@lines, "</pre>");
438     push(@documentationLines, @lines);
439 }
440
441 sub camelCase
442 {
443     my $value = shift;
444     $value =~ s/\b(\w)/\U$1/g; # make a camel-case name for type name
445     $value =~ s/ //g;
446     return $value;
447 }
448
449 sub generateBackendFunction
450 {
451     my $interface = shift;
452     my $function = shift;
453
454     my $functionName = $function->signature->name;
455     my $fullQualifiedFunctionName = $interface->name . "_" . $function->signature->name;
456
457     push(@backendConstantDeclarations, "    static const char* ${fullQualifiedFunctionName}Cmd;");
458     push(@backendConstantDefinitions, "const char* ${backendClassName}::${fullQualifiedFunctionName}Cmd = \"${fullQualifiedFunctionName}\";");
459
460     map($backendTypes{$_->type} = 1, @{$function->parameters}); # register required types
461     my @inArgs = grep($_->direction eq "in" && !($_->name eq "callId") , @{$function->parameters});
462     my @outArgs = grep($_->direction eq "out", @{$function->parameters});
463     
464     my $signature = "    void ${fullQualifiedFunctionName}(long callId, InspectorObject* requestMessageObject);";
465     !$backendMethodSignatures{${signature}} || die "Duplicate function was detected for signature '$signature'.";
466     $backendMethodSignatures{${signature}} = "$fullQualifiedFunctionName";
467     push(@backendMethods, ${signature});
468
469     my @function;
470     my $requestMessageObject = scalar(@inArgs) ? " requestMessageObject" : "";
471     push(@function, "void ${backendClassName}::${fullQualifiedFunctionName}(long callId, InspectorObject*$requestMessageObject)");
472     push(@function, "{");
473     push(@function, "    RefPtr<InspectorArray> protocolErrors = InspectorArray::create();");
474     push(@function, "");
475
476     my $domain = $interface->name;
477     my $domainAccessor = typeTraits($domain, "domainAccessor");
478     $backendTypes{$domain} = 1;
479     push(@function, "    if (!$domainAccessor)");
480     push(@function, "        protocolErrors->pushString(\"Protocol Error: $domain handler is not available.\");");
481     push(@function, "");
482
483     # declare local variables for out arguments.
484     push(@function, map("    " . typeTraits($_->type, "variable") . " " . $_->name . " = " . typeTraits($_->type, "defaultValue") . ";", @outArgs));
485
486     my $indent = "";
487     if (scalar(@inArgs)) {
488         push(@function, "    if (RefPtr<InspectorObject> argumentsContainer = requestMessageObject->getObject(\"arguments\")) {");
489
490         foreach my $parameter (@inArgs) {
491             my $name = $parameter->name;
492             my $type = $parameter->type;
493             my $typeString = camelCase($parameter->type);
494             push(@function, "        " . typeTraits($type, "variable") . " $name = get$typeString(argumentsContainer.get(), \"$name\", protocolErrors.get());");
495         }
496         push(@function, "");
497         $indent = "    ";
498     }
499
500     push(@function, "$indent    ErrorString error;");
501     my $args = join(", ", ("&error", map($_->name, @inArgs), map("&" . $_->name, @outArgs)));
502     push(@function, "$indent    if (!protocolErrors->length())");
503     push(@function, "$indent        $domainAccessor->$functionName($args);");
504     push(@function, "$indent    if (error.length())");
505     push(@function, "$indent        protocolErrors->pushString(error);");
506     if (scalar(@inArgs)) {
507         push(@function, "    } else {");
508         push(@function, "        protocolErrors->pushString(\"Protocol Error: 'arguments' property with type 'object' was not found.\");");
509         push(@function, "    }");
510     }
511
512     push(@function, "    // use InspectorFrontend as a marker of WebInspector availability");
513     push(@function, "    if ((callId || protocolErrors->length()) && m_inspectorAgent->hasFrontend()) {");
514     push(@function, "        RefPtr<InspectorObject> responseMessage = InspectorObject::create();");
515     push(@function, "        responseMessage->setNumber(\"seq\", callId);");
516     push(@function, "");
517     push(@function, "        if (protocolErrors->length())");
518     push(@function, "            responseMessage->setArray(\"errors\", protocolErrors);");
519     if (scalar(@outArgs)) {
520         push(@function, "        else {");
521         push(@function, "            RefPtr<InspectorObject> responseBody = InspectorObject::create();");
522         push(@function, map("            responseBody->set" . typeTraits($_->type, "JSONType") . "(\"" . $_->name . "\", " . $_->name . ");", @outArgs));
523         push(@function, "            responseMessage->setObject(\"body\", responseBody);");
524         push(@function, "        }");
525     }
526     push(@function, "        m_inspectorAgent->inspectorClient()->sendMessageToFrontend(responseMessage->toJSONString());");
527     push(@function, "    }");
528
529
530     push(@function, "}");
531     push(@function, "");
532     push(@backendMethodsImpl, @function);
533 }
534
535 sub generateDocumentationCommand
536 {
537     my $interface = shift;
538     my $function = shift;
539
540     my $functionName = $function->signature->name;
541     my $domain = $interface->name;
542
543     my @lines;
544
545     push(@lines, "<h4>" . $interface->name . "." . ${functionName} . "</h4>");
546     my $doc = $function->signature->extendedAttributes->{"doc"};
547     if ($doc) {
548         push(@lines, $doc);
549     }
550
551     my @inArgs = grep($_->direction eq "in" && !($_->name eq "callId") , @{$function->parameters});
552     push(@lines, "<pre style='background: lightGrey; padding: 10px'>");
553     push(@lines, "request: {");
554     push(@lines, "    seq: &lt;number&gt;,");
555     push(@lines, "    type: \"request\",");
556     push(@lines, "    domain: \"" . $interface->name . "\",");
557     if (scalar(@inArgs)) {
558         push(@lines, "    command: \"${functionName}\",");
559         push(@lines, "    arguments: {");
560         my @parameters;
561         foreach my $parameter (@inArgs) {
562             push(@parameters, "        " . parameterDocLine($parameter));
563         }
564         push(@lines, join(",\n", @parameters));
565         push(@lines, "    }");
566     } else {
567         push(@lines, "    command: \"${functionName}\"");
568     }
569     push(@lines, "}");
570
571     my @outArgs = grep($_->direction eq "out", @{$function->parameters});    
572     push(@lines, "");
573     push(@lines, "response: {");
574     push(@lines, "    seq: &lt;number&gt;,");
575     if (scalar(@outArgs)) {
576         push(@lines, "    type: \"response\",");
577         push(@lines, "    body: {");
578             my @parameters;
579             foreach my $parameter (@outArgs) {
580                 push(@parameters, "        " . parameterDocLine($parameter));
581             }
582             push(@lines, join(",\n", @parameters));
583         push(@lines, "    }");
584     } else {
585         push(@lines, "    type: \"response\"");
586     }
587     push(@lines, "}");
588     push(@lines, "</pre>");
589
590     push(@documentationLines, @lines);
591 }
592
593 sub generateBackendReportProtocolError
594 {
595     my $reportProtocolError = << "EOF";
596
597 void ${backendClassName}::reportProtocolError(const long callId, const String& errorText) const
598 {
599     RefPtr<InspectorObject> message = InspectorObject::create();
600     message->setNumber("seq", callId);
601     RefPtr<InspectorArray> errors = InspectorArray::create();
602     errors->pushString(errorText);
603     message->setArray("errors", errors);
604     m_inspectorAgent->inspectorClient()->sendMessageToFrontend(message->toJSONString());
605 }
606 EOF
607     return split("\n", $reportProtocolError);
608 }
609
610 sub generateArgumentGetters
611 {
612     my $type = shift;
613     my $json = typeTraits($type, "JSONType");
614     my $variable = typeTraits($type, "variable");
615     my $defaultValue = typeTraits($type, "defaultValue");
616     my $return  = typeTraits($type, "return") ? typeTraits($type, "return") : typeTraits($type, "param");
617
618     my $typeString = camelCase($type);
619     push(@backendConstantDeclarations, "    $return get$typeString(InspectorObject* object, const String& name, InspectorArray* protocolErrors);");
620     my $getterBody = << "EOF";
621
622 $return InspectorBackendDispatcher::get$typeString(InspectorObject* object, const String& name, InspectorArray* protocolErrors)
623 {
624     ASSERT(object);
625     ASSERT(protocolErrors);
626
627     $variable value = $defaultValue;
628     InspectorObject::const_iterator end = object->end();
629     InspectorObject::const_iterator valueIterator = object->find(name);
630
631     if (valueIterator == end)
632         protocolErrors->pushString(String::format("Protocol Error: Argument '\%s' with type '$json' was not found.", name.utf8().data()));
633     else {
634         if (!valueIterator->second->as$json(&value))
635             protocolErrors->pushString(String::format("Protocol Error: Argument '\%s' has wrong type. It should be '$json'.", name.utf8().data()));
636     }
637     return value;
638 }
639 EOF
640
641     return split("\n", $getterBody);
642 }
643
644 sub generateBackendDispatcher
645 {
646     my @body;
647     my @mapEntries = map("        dispatchMap.add(${_}Cmd, &${backendClassName}::$_);", map ($backendMethodSignatures{$_}, @backendMethods));
648     my $mapEntries = join("\n", @mapEntries);
649
650     my $backendDispatcherBody = << "EOF";
651 void ${backendClassName}::dispatch(const String& message)
652 {
653     typedef void (${backendClassName}::*CallHandler)(long callId, InspectorObject* messageObject);
654     typedef HashMap<String, CallHandler> DispatchMap;
655     DEFINE_STATIC_LOCAL(DispatchMap, dispatchMap, );
656     long callId = 0;
657
658     if (dispatchMap.isEmpty()) {
659 $mapEntries
660     }
661
662     RefPtr<InspectorValue> parsedMessage = InspectorValue::parseJSON(message);
663     if (!parsedMessage) {
664         reportProtocolError(callId, "Protocol Error: Invalid message format. Message should be in JSON format.");
665         return;
666     }
667
668     RefPtr<InspectorObject> messageObject = parsedMessage->asObject();
669     if (!messageObject) {
670         reportProtocolError(callId, "Protocol Error: Invalid message format. The message should be a JSONified object.");
671         return;
672     }
673
674     RefPtr<InspectorValue> commandValue = messageObject->get("command");
675     if (!commandValue) {
676         reportProtocolError(callId, "Protocol Error: Invalid message format. 'command' property wasn't found.");
677         return;
678     }
679
680     String command;
681     if (!commandValue->asString(&command)) {
682         reportProtocolError(callId, "Protocol Error: Invalid message format. The type of 'command' property should be string.");
683         return;
684     }
685
686     RefPtr<InspectorValue> domainValue = messageObject->get("domain");
687     if (!domainValue) {
688         reportProtocolError(callId, "Protocol Error: Invalid message format. 'domain' property wasn't found.");
689         return;
690     }
691
692     String domain;
693     if (!domainValue->asString(&domain)) {
694         reportProtocolError(callId, "Protocol Error: Invalid message format. The type of 'domain' property should be string.");
695         return;
696     }
697
698     RefPtr<InspectorValue> callIdValue = messageObject->get("seq");
699     if (!callIdValue) {
700         reportProtocolError(callId, "Protocol Error: Invalid message format. 'seq' property was not found in the request.");
701         return;
702     }
703
704     if (!callIdValue->asNumber(&callId)) {
705         reportProtocolError(callId, "Protocol Error: Invalid message format. The type of 'seq' property should be number.");
706         return;
707     }
708
709     HashMap<String, CallHandler>::iterator it = dispatchMap.find(makeString(domain, "_", command));
710     if (it == dispatchMap.end()) {
711         reportProtocolError(callId, makeString("Protocol Error: Invalid command was received. '", command, "' wasn't found in domain ", domain, "."));
712         return;
713     }
714
715     ((*this).*it->second)(callId, messageObject.get());
716 }
717 EOF
718     return split("\n", $backendDispatcherBody);
719 }
720
721 sub generateBackendMessageParser
722 {
723     my $messageParserBody = << "EOF";
724 bool ${backendClassName}::getCommandName(const String& message, String* result)
725 {
726     RefPtr<InspectorValue> value = InspectorValue::parseJSON(message);
727     if (!value)
728         return false;
729
730     RefPtr<InspectorObject> object = value->asObject();
731     if (!object)
732         return false;
733
734     RefPtr<InspectorValue> commandValue = object->get("command");
735     if (!commandValue)
736         return false;
737
738     return commandValue->asString(result);
739 }
740 EOF
741     return split("\n", $messageParserBody);
742 }
743
744 sub collectBackendJSStubFunctions
745 {
746     my $interface = shift;
747     my @functions = grep(!$_->signature->extendedAttributes->{"event"}, @{$interface->functions});
748     my $domain = $interface->name;
749
750     foreach my $function (@functions) {
751         my $name = $function->signature->name;
752         my $argumentNames = join(",", map("\"" . $_->name . "\": \"" . typeTraits($_->type, "JSType") . "\"", grep($_->direction eq "in", @{$function->parameters})));
753         push(@backendJSStubs, "    this._registerDelegate('{" .
754             "\"seq\": 0, " .
755             "\"domain\": \"$domain\", " .
756             "\"command\": \"$name\", " .
757             "\"arguments\": {$argumentNames}" .
758         "}');");
759     }
760 }
761
762 sub generateBackendStubJS
763 {
764     my $JSStubs = join("\n", @backendJSStubs);
765     my $inspectorBackendStubJS = << "EOF";
766 $licenseTemplate
767
768 InspectorBackendStub = function()
769 {
770     this._lastCallbackId = 1;
771     this._pendingResponsesCount = 0;
772     this._callbacks = {};
773     this._domainDispatchers = {};
774 $JSStubs
775 }
776
777 InspectorBackendStub.prototype = {
778     _wrap: function(callback)
779     {
780         var callbackId = this._lastCallbackId++;
781         ++this._pendingResponsesCount;
782         this._callbacks[callbackId] = callback || function() {};
783         return callbackId;
784     },
785
786     _registerDelegate: function(commandInfo)
787     {
788         var commandObject = JSON.parse(commandInfo);
789         var agentName = commandObject.domain + "Agent";
790         if (!window[agentName])
791             window[agentName] = {};
792         window[agentName][commandObject.command] = this.sendMessageToBackend.bind(this, commandInfo);
793     },
794
795     sendMessageToBackend: function()
796     {
797         var args = Array.prototype.slice.call(arguments);
798         var request = JSON.parse(args.shift());
799
800         for (var key in request.arguments) {
801             if (args.length === 0) {
802                 console.error("Protocol Error: Invalid number of arguments for '" + request.domain + "Agent." + request.command + "' call. It should have the next arguments '" + JSON.stringify(request.arguments) + "'.");
803                 return;
804             }
805             var value = args.shift();
806             if (request.arguments[key] && typeof value !== request.arguments[key]) {
807                 console.error("Protocol Error: Invalid type of argument '" + key + "' for '" + request.domain + "Agent." + request.command + "' call. It should be '" + request.arguments[key] + "' but it is '" + typeof value + "'.");
808                 return;
809             }
810             request.arguments[key] = value;
811         }
812
813         var callback;
814         if (args.length === 1) {
815             if (typeof args[0] !== "function" && typeof args[0] !== "undefined") {
816                 console.error("Protocol Error: Optional callback argument for '" + request.domain + "Agent." + request.command + "' call should be a function but its type is '" + typeof args[0] + "'.");
817                 return;
818             }
819             callback = args[0];
820         }
821         request.seq = this._wrap(callback || function() {});
822
823         if (window.dumpInspectorProtocolMessages)
824             console.log("frontend: " + JSON.stringify(request));
825
826         var message = JSON.stringify(request);
827         InspectorFrontendHost.sendMessageToBackend(message);
828     },
829
830     registerDomainDispatcher: function(domain, dispatcher)
831     {
832         this._domainDispatchers[domain] = dispatcher;
833     },
834
835     dispatch: function(message)
836     {
837         if (window.dumpInspectorProtocolMessages)
838             console.log("backend: " + ((typeof message === "string") ? message : JSON.stringify(message)));
839
840         var messageObject = (typeof message === "string") ? JSON.parse(message) : message;
841
842         var arguments = [];
843         if (messageObject.body)
844             for (var key in messageObject.body)
845                 arguments.push(messageObject.body[key]);
846
847         if ("seq" in messageObject) { // just a response for some request
848             if (!messageObject.errors)
849                 this._callbacks[messageObject.seq].apply(null, arguments);
850             else
851                 this.reportProtocolError(messageObject);
852
853             --this._pendingResponsesCount;
854             delete this._callbacks[messageObject.seq];
855
856             if (this._scripts && !this._pendingResponsesCount)
857                 this.runAfterPendingDispatches();
858
859             return;
860         }
861
862         if (messageObject.type === "event") {
863             if (!(messageObject.domain in this._domainDispatchers)) {
864                 console.error("Protocol Error: the message is for non-existing domain '" + messageObject.domain + "'");
865                 return;
866             }
867             var dispatcher = this._domainDispatchers[messageObject.domain];
868             if (!(messageObject.event in dispatcher)) {
869                 console.error("Protocol Error: Attempted to dispatch an unimplemented method '" + messageObject.domain + "." + messageObject.event + "'");
870                 return;
871             }
872             dispatcher[messageObject.event].apply(dispatcher, arguments);
873         }
874     },
875
876     reportProtocolError: function(messageObject)
877     {
878         console.error("Protocol Error: InspectorBackend request with seq = " + messageObject.seq + " failed.");
879         for (var i = 0; i < messageObject.errors.length; ++i)
880             console.error("    " + messageObject.errors[i]);
881     },
882
883     runAfterPendingDispatches: function(script)
884     {
885         if (!this._scripts)
886             this._scripts = [];
887
888         if (script)
889             this._scripts.push(script);
890
891         if (!this._pendingResponsesCount) {
892             var scripts = this._scripts;
893             this._scripts = []
894             for (var id = 0; id < scripts.length; ++id)
895                  scripts[id].call(this);
896         }
897     }
898 }
899
900 InspectorBackend = new InspectorBackendStub();
901
902 EOF
903     return split("\n", $inspectorBackendStubJS);
904 }
905
906 sub generateHeader
907 {
908     my $className = shift;
909     my $types = shift;
910     my $constructor = shift;
911     my $constants = shift;
912     my $methods = shift;
913     my $footer = shift;
914
915     my $forwardHeaders = join("\n", sort(map("#include <" . typeTraits($_, "forwardHeader") . ">", grep(typeTraits($_, "forwardHeader"), keys %{$types}))));
916     my $forwardDeclarations = join("\n", sort(map("class " . typeTraits($_, "forward") . ";", grep(typeTraits($_, "forward"), keys %{$types}))));
917     my $constantDeclarations = join("\n", @{$constants});
918     my $methodsDeclarations = join("\n", @{$methods});
919
920     my $headerBody = << "EOF";
921 // Copyright (c) 2010 The Chromium Authors. All rights reserved.
922 // Use of this source code is governed by a BSD-style license that can be
923 // found in the LICENSE file.
924 #ifndef ${className}_h
925 #define ${className}_h
926
927 ${forwardHeaders}
928
929 namespace $namespace {
930
931 $forwardDeclarations
932
933 typedef String ErrorString;
934
935 class $className {
936 public:
937 $constructor
938
939 $constantDeclarations
940 $methodsDeclarations
941
942 $footer
943 };
944
945 } // namespace $namespace
946 #endif // !defined(${className}_h)
947
948 EOF
949     return $headerBody;
950 }
951
952 sub generateSource
953 {
954     my $className = shift;
955     my $types = shift;
956     my $constants = shift;
957     my $methods = shift;
958
959     my @sourceContent = split("\r", $licenseTemplate);
960     push(@sourceContent, "\n#include \"config.h\"");
961     push(@sourceContent, "#include \"$className.h\"");
962     push(@sourceContent, "#include <wtf/text/StringConcatenate.h>");
963     push(@sourceContent, "#include <wtf/text/CString.h>");
964     push(@sourceContent, "");
965     push(@sourceContent, "#if ENABLE(INSPECTOR)");
966     push(@sourceContent, "");
967
968     my %headers;
969     foreach my $type (keys %{$types}) {
970         $headers{"#include \"" . typeTraits($type, "header") . "\""} = 1 if !typeTraits($type, "header") eq  "";
971     }
972     push(@sourceContent, sort keys %headers);
973     push(@sourceContent, "");
974     push(@sourceContent, "namespace $namespace {");
975     push(@sourceContent, "");
976     push(@sourceContent, join("\n", @{$constants}));
977     push(@sourceContent, "");
978     push(@sourceContent, @{$methods});
979     push(@sourceContent, "");
980     push(@sourceContent, "} // namespace $namespace");
981     push(@sourceContent, "");
982     push(@sourceContent, "#endif // ENABLE(INSPECTOR)");
983     push(@sourceContent, "");
984     return @sourceContent;
985 }
986
987 sub typeTraits
988 {
989     my $type = shift;
990     my $trait = shift;
991     return $typeTransform{$type}->{$trait};
992 }
993
994 sub parameterDocType
995 {
996     my $parameter = shift;
997     my $subtype = $parameter->extendedAttributes->{"type"};
998     if ($subtype) {
999         my $pattern = typeTraits($parameter->type, "DocType");
1000         return sprintf($pattern, "&lt;$subtype&gt;");
1001     }
1002
1003     my $subtypeRef = $parameter->extendedAttributes->{"typeRef"};
1004     if ($subtypeRef) {
1005         my $pattern = typeTraits($parameter->type, "DocType");
1006         return sprintf($pattern, "&lt;<a href='#$subtypeRef'>" . $subtypeRef . "</a>&gt;");
1007     }
1008
1009     return "&lt;" . typeTraits($parameter->type, "JSType") . "&gt;";
1010 }
1011
1012 sub parameterDocLine
1013 {
1014     my $parameter = shift;
1015
1016     my $result = $parameter->name . ": " . parameterDocType($parameter);
1017     my $doc = $parameter->extendedAttributes->{"doc"};
1018     if ($doc) {
1019         $result = $result . " // " . $doc;
1020     }
1021     return $result;
1022 }
1023
1024 sub finish
1025 {
1026     my $object = shift;
1027
1028     push(@backendMethodsImpl, generateBackendDispatcher());
1029     push(@backendMethodsImpl, generateBackendReportProtocolError());
1030     unshift(@frontendMethodsImpl, generateFrontendConstructorImpl(), "");
1031
1032     open(my $SOURCE, ">$outputDir/$frontendClassName.cpp") || die "Couldn't open file $outputDir/$frontendClassName.cpp";
1033     print $SOURCE join("\n", generateSource($frontendClassName, \%frontendTypes, \@frontendConstantDefinitions, \@frontendMethodsImpl));
1034     close($SOURCE);
1035     undef($SOURCE);
1036
1037     open(my $HEADER, ">$outputHeadersDir/$frontendClassName.h") || die "Couldn't open file $outputHeadersDir/$frontendClassName.h";
1038     print $HEADER generateHeader($frontendClassName, \%frontendTypes, $frontendConstructor, \@frontendConstantDeclarations, \@frontendMethods, join("\n", @frontendFooter));
1039     close($HEADER);
1040     undef($HEADER);
1041
1042     # Make dispatcher methods private on the backend.
1043     push(@backendConstantDeclarations, "");
1044     push(@backendConstantDeclarations, "private:");
1045
1046     foreach my $type (keys %backendTypes) {
1047         if (typeTraits($type, "JSONType")) {
1048             push(@backendMethodsImpl, generateArgumentGetters($type));
1049         }
1050     }
1051
1052     push(@backendMethodsImpl, generateBackendMessageParser());
1053     push(@backendMethodsImpl, "");
1054
1055     push(@backendConstantDeclarations, "");
1056
1057     open($SOURCE, ">$outputDir/$backendClassName.cpp") || die "Couldn't open file $outputDir/$backendClassName.cpp";
1058     print $SOURCE join("\n", generateSource($backendClassName, \%backendTypes, \@backendConstantDefinitions, \@backendMethodsImpl));
1059     close($SOURCE);
1060     undef($SOURCE);
1061
1062     open($HEADER, ">$outputHeadersDir/$backendClassName.h") || die "Couldn't open file $outputHeadersDir/$backendClassName.h";
1063     print $HEADER join("\n", generateHeader($backendClassName, \%backendTypes, $backendConstructor, \@backendConstantDeclarations, \@backendMethods, $backendFooter));
1064     close($HEADER);
1065     undef($HEADER);
1066
1067     open(my $JS_STUB, ">$outputDir/$backendJSStubName.js") || die "Couldn't open file $outputDir/$backendJSStubName.js";
1068     print $JS_STUB join("\n", generateBackendStubJS());
1069     close($JS_STUB);
1070     undef($JS_STUB);
1071
1072     open(my $DOCS, ">$outputDir/WebInspectorProtocol.html") || die "Couldn't open file $outputDir/WebInspectorProtocol.html";
1073     print $DOCS "<ol class='toc' style='list-style: none; padding: 0'>";
1074     print $DOCS join("\n", @documentationToc);
1075     print $DOCS "</ol>";
1076     print $DOCS join("\n", @documentationLines);
1077     close($DOCS);
1078     undef($DOCS);
1079 }
1080
1081 1;