Home | History | Annotate | Download | only in web 
      1 /*
      2  * Copyright (C) 2012 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 
     32 #ifndef WebViewBenchmarkSupport_h
     33 #define WebViewBenchmarkSupport_h
     34 
     35 #include "../platform/WebCanvas.h"
     36 #include "../platform/WebSize.h"
     37 
     38 namespace WebKit {
     39 
     40 // Support for benchmarks accessing the WebView.
     41 class WebViewBenchmarkSupport {
     42 public:
     43     enum PaintMode {
     44         // Paint the entire page.
     45         PaintModeEverything
     46     };
     47 
     48     // Client for creating canvases where multiple canvases
     49     // may be used for layered rendering and sizes defined by the benchmark.
     50     // Also contains reporting methods called by the WebViewBenchmarkSupport
     51     // when painting is about to occur and when painting is complete.
     52     class PaintClient {
     53     public:
     54         // Called by the WebViewBenchmarkSupport when painting is about to occur.
     55         // PaintClient is expected to return an appropriately-sized canvas
     56         // for the WebViewBenchmarkSupport to paint on.
     57         virtual WebCanvas* willPaint(const WebSize&) { return 0; }
     58 
     59         // Called by the WebViewBenchmarkSupport when painting is complete.
     60         // The canvas will not be used after this call and can be destroyed
     61         // if necessary.
     62         virtual void didPaint(WebCanvas*) { }
     63     protected:
     64         virtual ~PaintClient() { }
     65     };
     66 
     67     // Paints the web view on canvases created from the client, using the given
     68     // paint mode.
     69     virtual void paint(PaintClient*, PaintMode) = 0;
     70 
     71 protected:
     72     virtual ~WebViewBenchmarkSupport() { }
     73 };
     74 } // namespace WebKit
     75 
     76 #endif // WebViewBenchmarkSupport_h
     77