1/*
2 * Copyright (C) 2014 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 WebLeakDetector_h
32#define WebLeakDetector_h
33
34#include "WebFrame.h"
35#include "public/platform/WebCommon.h"
36
37namespace blink {
38
39class WebLeakDetectorClient {
40public:
41    struct Result {
42        unsigned numberOfLiveAudioNodes;
43        unsigned numberOfLiveDocuments;
44        unsigned numberOfLiveNodes;
45        unsigned numberOfLiveRenderObjects;
46        unsigned numberOfLiveResources;
47    };
48
49    virtual void onLeakDetectionComplete(const Result&) = 0;
50};
51
52class WebLeakDetector {
53public:
54    virtual ~WebLeakDetector() { }
55
56    BLINK_EXPORT static WebLeakDetector* create(WebLeakDetectorClient*);
57
58    // Cleans up the DOM objects and counts them. |WebLeakDetectorClient::onLeakDetectionComplete()| is called when done.
59    // This is supposed to be used for detecting DOM-object leaks.
60    virtual void collectGarbageAndGetDOMCounts(WebLocalFrame*) = 0;
61};
62
63} // namespace blink
64
65#endif // WebLeakDetector_h
66