DevTools: eliminate 1k lines of generated code in InspectorBackendDispatcher.cpp

Source/core/inspector/CodeGeneratorInspectorStrings.py

 # Copyright (c) 2013 Google Inc. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above
 # copyright notice, this list of conditions and the following disclaimer
@@ skipping 26 matching lines @@
         void flush() { m_inspectorFrontendChannel->flush(); }
     private:
         InspectorFrontendChannel* m_inspectorFrontendChannel;
     };
 
     $domainClassName* $domainFieldName() { return &m_$domainFieldName; }
 
 """)
 
 backend_method = (
-"""void InspectorBackendDispatcherImpl::${domainName}_$methodName(long callId, JSONObject*$requestMessageObject)
+"""void InspectorBackendDispatcherImpl::${domainName}_$methodName(long callId, JSONObject*$requestMessageObject, JSONArray* protocolErrors)
 {
-    RefPtr<JSONArray> protocolErrors = JSONArray::create();

[yurys, 2014/06/10 07:36:19]

I'd rather we left previous implementation where protocolErrors was a local
variable inside the method as it is used only here. I don't see why we should
pass it as argument unless there may be errors passed by the caller.

-
     if (!$agentField)
         protocolErrors->pushString("${domainName} handler is not available.");
-$methodOutCode
-$methodInCode
-    RefPtr<JSONObject> result = JSONObject::create();
-    RefPtr<JSONValue> resultErrorData;
+$methodCode
+    if (protocolErrors->length()) {
+        reportProtocolError(&callId, InvalidParams, String::format(InvalidParamsFormatString, commandName($commandNameIndex)), protocolErrors);
+        return;
+    }
     ErrorString error;
-    if (!protocolErrors->length()) {
-        $agentField->$methodName(&error$agentCallParams);
-
-$errorCook${responseCook}
-    }
-    sendResponse(callId, result, commandName($commandNameIndex), protocolErrors, error, resultErrorData);
+    $agentField->$methodName(&error$agentCallParams);
+$responseCook
+    sendResponse(callId, $sendResponseCallParams);
 }
 """)
 
 frontend_method = ("""void InspectorFrontend::$domainName::$eventName($parameters)
 {
     RefPtr<JSONObject> jsonMessage = JSONObject::create();
     jsonMessage->setString("method", "$domainName.$eventName");
 $code    if (m_inspectorFrontendChannel)
         m_inspectorFrontendChannel->sendMessageToFrontend(jsonMessage.release());
 }
@@ skipping 166 matching lines @@
     InspectorBackendDispatcherImpl(InspectorFrontendChannel* inspectorFrontendChannel)
         : m_inspectorFrontendChannel(inspectorFrontendChannel)
 $constructorInit
     { }
 
     virtual void clearFrontend() { m_inspectorFrontendChannel = 0; }
     virtual void dispatch(const String& message);
     virtual void reportProtocolError(const long* const callId, CommonErrorCode, const String& errorMessage, PassRefPtr<JSONValue> data) const;
     using InspectorBackendDispatcher::reportProtocolError;
 
-    void sendResponse(long callId, PassRefPtr<JSONObject> result, const ErrorString&invocationError, PassRefPtr<JSONValue> errorData);
+    void sendResponse(long callId, const ErrorString& invocationError, PassRefPtr<JSONValue> errorData, PassRefPtr<JSONObject> result);
     bool isActive() { return m_inspectorFrontendChannel; }
 
 $setters
 private:
 $methodDeclarations
 
     InspectorFrontendChannel* m_inspectorFrontendChannel;
 $fieldDeclarations
 
     template<typename R, typename V, typename V0>
     static R getPropertyValueImpl(JSONObject* object, const char* name, bool* valueFound, JSONArray* protocolErrors, V0 initial_value, bool (*as_method)(JSONValue*, V*), const char* type_name);
 
     static int getInt(JSONObject* object, const char* name, bool* valueFound, JSONArray* protocolErrors);
     static double getDouble(JSONObject* object, const char* name, bool* valueFound, JSONArray* protocolErrors);
     static String getString(JSONObject* object, const char* name, bool* valueFound, JSONArray* protocolErrors);
     static bool getBoolean(JSONObject* object, const char* name, bool* valueFound, JSONArray* protocolErrors);
     static PassRefPtr<JSONObject> getObject(JSONObject* object, const char* name, bool* valueFound, JSONArray* protocolErrors);
     static PassRefPtr<JSONArray> getArray(JSONObject* object, const char* name, bool* valueFound, JSONArray* protocolErrors);
 
-    void sendResponse(long callId, PassRefPtr<JSONObject> result, const char* commandName, PassRefPtr<JSONArray> protocolErrors, ErrorString invocationError, PassRefPtr<JSONValue> errorData);
+    void sendResponse(long callId, ErrorString invocationError, PassRefPtr<JSONObject> result)
+    {
+        sendResponse(callId, invocationError, RefPtr<JSONValue>(), result);
+    }
+    void sendResponse(long callId, ErrorString invocationError)
+    {
+        sendResponse(callId, invocationError, RefPtr<JSONValue>(), JSONObject::create());
+    }
+    static const char InvalidParamsFormatString[];
+};
 
-};
+const char InspectorBackendDispatcherImpl::InvalidParamsFormatString[] = "Some arguments of method '%s' can't be processed";
 
 $methods
 
 PassRefPtr<InspectorBackendDispatcher> InspectorBackendDispatcher::create(InspectorFrontendChannel* inspectorFrontendChannel)
 {
     return adoptRef(new InspectorBackendDispatcherImpl(inspectorFrontendChannel));
 }
 
 
 void InspectorBackendDispatcherImpl::dispatch(const String& message)
 {
     RefPtr<InspectorBackendDispatcher> protect = this;
-    typedef void (InspectorBackendDispatcherImpl::*CallHandler)(long callId, JSONObject* messageObject);
+    typedef void (InspectorBackendDispatcherImpl::*CallHandler)(long callId, JSONObject* messageObject, JSONArray* protocolErrors);
     typedef HashMap<String, CallHandler> DispatchMap;
     DEFINE_STATIC_LOCAL(DispatchMap, dispatchMap, );
     long callId = 0;
 
     if (dispatchMap.isEmpty()) {
         static const CallHandler handlers[] = {
 $messageHandlers
         };
         for (size_t i = 0; i < kMethodNamesEnumSize; ++i)
             dispatchMap.add(commandName(static_cast<MethodNames>(i)), handlers[i]);
@@ skipping 33 matching lines @@
         reportProtocolError(&callId, InvalidRequest, "The type of 'method' property must be string");
         return;
     }
 
     HashMap<String, CallHandler>::iterator it = dispatchMap.find(method);
     if (it == dispatchMap.end()) {
         reportProtocolError(&callId, MethodNotFound, "'" + method + "' wasn't found");
         return;
     }
 
-    ((*this).*it->value)(callId, messageObject.get());
+    RefPtr<JSONArray> protocolErrors = JSONArray::create();
+    ((*this).*it->value)(callId, messageObject.get(), protocolErrors.get());
 }
 
-void InspectorBackendDispatcherImpl::sendResponse(long callId, PassRefPtr<JSONObject> result, const char* commandName, PassRefPtr<JSONArray> protocolErrors, ErrorString invocationError, PassRefPtr<JSONValue> errorData)
-{
-    if (protocolErrors->length()) {
-        String errorMessage = String::format("Some arguments of method '%s' can't be processed", commandName);
-        reportProtocolError(&callId, InvalidParams, errorMessage, protocolErrors);
-        return;
-    }
-    sendResponse(callId, result, invocationError, errorData);
-}
-
-void InspectorBackendDispatcherImpl::sendResponse(long callId, PassRefPtr<JSONObject> result, const ErrorString& invocationError, PassRefPtr<JSONValue> errorData)
+void InspectorBackendDispatcherImpl::sendResponse(long callId, const ErrorString& invocationError, PassRefPtr<JSONValue> errorData, PassRefPtr<JSONObject> result)
 {
     if (invocationError.length()) {
         reportProtocolError(&callId, ServerError, invocationError, errorData);
         return;
     }
 
     RefPtr<JSONObject> responseMessage = JSONObject::create();
     responseMessage->setNumber("id", callId);
     responseMessage->setObject("result", result);
     if (m_inspectorFrontendChannel)
@@ skipping 138 matching lines @@
 
 bool InspectorBackendDispatcher::CallbackBase::isActive()
 {
     return !m_alreadySent && m_backendImpl->isActive();
 }
 
 void InspectorBackendDispatcher::CallbackBase::sendIfActive(PassRefPtr<JSONObject> partialMessage, const ErrorString& invocationError, PassRefPtr<JSONValue> errorData)
 {
     if (m_alreadySent)
         return;
-    m_backendImpl->sendResponse(m_id, partialMessage, invocationError, errorData);
+    m_backendImpl->sendResponse(m_id, invocationError, errorData, partialMessage);
     m_alreadySent = true;
 }
 
 } // namespace WebCore
 
 """)
 
 frontend_cpp = (
 """
 
@@ skipping 372 matching lines @@
 
 #endif // $validatorIfdefName
 
 } // namespace WebCore
 
 """)
 
 param_container_access_code = """
     RefPtr<JSONObject> paramsContainer = requestMessageObject->getObject("params");
     JSONObject* paramsContainerPtr = paramsContainer.get();
-    JSONArray* protocolErrorsPtr = protocolErrors.get();
 """
 
 class_binding_builder_part_1 = (
 """        AllFieldsSet = %s
     };
 
     template<int STATE>
     class Builder {
     private:
         RefPtr<JSONObject> m_result;
@@ skipping 36 matching lines @@
     };
 
 """)
 
 class_binding_builder_part_4 = (
 """    static Builder<NoFieldsSet> create()
     {
         return Builder<NoFieldsSet>(JSONObject::create());
     }
 """)