1 /*

     2  * Copyright (C) 2009 Google Inc. All rights reserved.

     3  *

     4  * Redistribution and use in source and binary forms, with or without

     5  * modification, are permitted provided that the following conditions are

     6  * met:

     7  *

     8  *     * Redistributions of source code must retain the above copyright

     9  * notice, this list of conditions and the following disclaimer.

    10  *     * Redistributions in binary form must reproduce the above

    11  * copyright notice, this list of conditions and the following disclaimer

    12  * in the documentation and/or other materials provided with the

    13  * distribution.

    14  *     * Neither the name of Google Inc. nor the names of its

    15  * contributors may be used to endorse or promote products derived from

    16  * this software without specific prior written permission.

    17  *

    18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

    19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

    20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

    21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

    22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

    23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

    24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

    25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

    26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

    27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    29  */

    30 

    31 #ifndef WebCommonWorkerClient_h

    32 #define WebCommonWorkerClient_h

    33 

    34 namespace WebKit {

    35 

    36 class WebApplicationCacheHost;

    37 class WebApplicationCacheHostClient;

    38 class WebFrame;

    39 class WebNotificationPresenter;

    40 class WebString;

    41 class WebWorker;

    42 class WebWorkerClient;

    43 

    44 // Provides an interface back to the in-page script object for a worker.

    45 // This interface contains common APIs used by both shared and dedicated

    46 // workers.

    47 // All functions are expected to be called back on the thread that created

    48 // the Worker object, unless noted.

    49 class WebCommonWorkerClient {

    50 public:

    51     virtual void postExceptionToWorkerObject(

    52         const WebString& errorString, int lineNumber,

    53         const WebString& sourceURL) = 0;

    54 

    55     // FIXME: the below is for compatibility only and should be   

    56     // removed once Chromium is updated to remove message

    57     // destination parameter <http://webkit.org/b/37155>.

    58     virtual void postConsoleMessageToWorkerObject(int, int sourceIdentifier, int messageType, int messageLevel,

    59                                                   const WebString& message, int lineNumber, const WebString& sourceURL) = 0;

    60 

    61     virtual void postConsoleMessageToWorkerObject(int sourceIdentifier, int messageType, int messageLevel,

    62                                                   const WebString& message, int lineNumber, const WebString& sourceURL)

    63     {

    64         postConsoleMessageToWorkerObject(0, sourceIdentifier, messageType, messageLevel,

    65                                          message, lineNumber, sourceURL);

    66     }

    67 

    68     virtual void workerContextClosed() = 0;

    69     virtual void workerContextDestroyed() = 0;

    70 

    71     // Returns the notification presenter for this worker context.  Pointer

    72     // is owned by the object implementing WebCommonWorkerClient.

    73     virtual WebNotificationPresenter* notificationPresenter() = 0;

    74 

    75     // This can be called on any thread to create a nested WebWorker.

    76     // WebSharedWorkers are not instantiated via this API - instead

    77     // they are created via the WebSharedWorkerRepository.

    78     virtual WebWorker* createWorker(WebWorkerClient* client) = 0;

    79 

    80     // Called on the main webkit thread in the worker process during initialization.

    81     virtual WebApplicationCacheHost* createApplicationCacheHost(WebApplicationCacheHostClient*) = 0;

    82 

    83     // Called on the main webkit thread before opening a web database.

    84     virtual bool allowDatabase(WebFrame*, const WebString& name, const WebString& displayName, unsigned long estimatedSize) = 0;

    85 

    86 protected:

    87     ~WebCommonWorkerClient() { }

    88 };

    89 

    90 } // namespace WebKit

    91 

    92 #endif