File: use_counter.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (81 lines) | stat: -rw-r--r-- 3,227 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_INSTRUMENTATION_USE_COUNTER_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_INSTRUMENTATION_USE_COUNTER_H_

#include "third_party/blink/public/mojom/use_counter/metrics/web_feature.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/use_counter/metrics/webdx_feature.mojom-blink-forward.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"

namespace blink {

// TODO(yhirano): Remove this.
using WebFeature = mojom::WebFeature;
using WebDXFeature = mojom::blink::WebDXFeature;

// Definition for UseCounter features can be found in:
// third_party/blink/public/mojom/use_counter/metrics/web_feature.mojom and
// third_party/blink/public/mojom/use_counter/metrics/webdx_feature.mojom
//
// UseCounter is used for counting the number of times features of
// Blink are used on real web pages and help us know commonly
// features are used and thus when it's safe to remove or change them. It's
// counting whether a feature is used in a context (e.g., a page), so calling
// a counting function multiple times for the same UseCounter with the same
// feature will be ignored.
//
// The Chromium Content layer controls what is done with this data.
//
// For instance, in Google Chrome, these counts are submitted anonymously
// through the UMA histogram recording system in Chrome for users who have the
// "Automatically send usage statistics and crash reports to Google" setting
// enabled:
// http://www.google.com/chrome/intl/en/privacy.html
//
// This is a pure virtual interface class with some utility static functions.
class UseCounter : public GarbageCollectedMixin {
 public:
  static void Count(UseCounter* use_counter, mojom::WebFeature feature) {
    if (use_counter) {
      use_counter->CountUse(feature);
    }
  }
  static void Count(UseCounter& use_counter, mojom::WebFeature feature) {
    use_counter.CountUse(feature);
  }
  static void CountDeprecation(UseCounter* use_counter,
                               mojom::WebFeature feature) {
    if (use_counter) {
      use_counter->CountDeprecation(feature);
    }
  }
  static void CountWebDXFeature(UseCounter* use_counter, WebDXFeature feature) {
    if (use_counter) {
      use_counter->CountWebDXFeature(feature);
    }
  }
  static void CountWebDXFeature(UseCounter& use_counter, WebDXFeature feature) {
    use_counter.CountWebDXFeature(feature);
  }

  UseCounter() = default;
  UseCounter(const UseCounter&) = delete;
  UseCounter& operator=(const UseCounter&) = delete;
  virtual ~UseCounter() = default;

  // Counts a use of the given feature. Repeated calls are ignored.
  virtual void CountUse(mojom::WebFeature feature) = 0;

  // Counts a use of the given feature which is being deprecated. Repeated
  // calls are ignored.
  virtual void CountDeprecation(mojom::WebFeature feature) = 0;

  // Counts a use of the given feature. Repeated calls are ignored.
  virtual void CountWebDXFeature(WebDXFeature feature) = 0;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_INSTRUMENTATION_USE_COUNTER_H_