Update DiagnosticLoggingClient::logDiagnosticMessageWithValue() to take in the value...
[WebKit-https.git] / Source / WebCore / page / DiagnosticLoggingClient.h
1 /*
2  * Copyright (C) 2014 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "DiagnosticLoggingResultType.h"
29 #include <wtf/FastMalloc.h>
30 #include <wtf/Forward.h>
31 #include <wtf/RandomNumber.h>
32
33 namespace WebCore {
34
35 enum class ShouldSample { No, Yes };
36
37 class DiagnosticLoggingClient {
38     WTF_MAKE_FAST_ALLOCATED;
39 public:
40     virtual void logDiagnosticMessage(const String& message, const String& description, ShouldSample) = 0;
41     virtual void logDiagnosticMessageWithResult(const String& message, const String& description, DiagnosticLoggingResultType, ShouldSample) = 0;
42     virtual void logDiagnosticMessageWithValue(const String& message, const String& description, double value, unsigned significantFigures, ShouldSample) = 0;
43
44     static bool shouldLogAfterSampling(ShouldSample);
45
46     virtual ~DiagnosticLoggingClient() { }
47 };
48
49 inline bool DiagnosticLoggingClient::shouldLogAfterSampling(ShouldSample shouldSample)
50 {
51     if (shouldSample == ShouldSample::No)
52         return true;
53
54     static const double selectionProbability = 0.05;
55     return randomNumber() <= selectionProbability;
56 }
57
58 } // namespace WebCore