tools/metrics/structured/templates_events.py

# -*- coding: utf-8 -*-
# Copyright 2021 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Templates for generating event builder classes for structured metrics."""

HEADER_FILE_TEMPLATE = """
// Generated from gen_events.py. DO NOT EDIT!
// source: structured.xml

#ifndef {file.guard_path}
#define {file.guard_path}

#include <cstdint>
#include <string>

#include "components/metrics/structured/event.h"

namespace metrics {{
namespace structured {{
namespace events {{
namespace v2 {{

{project_code}

}}  // namespace v2
}}  // namespace events
}}  // namespace structured
}}  // namespace metrics

#endif  // {file.guard_path}\
"""

HEADER_PROJECT_TEMPLATE = """\
namespace {project.namespace} {{

{enum_code} \

{event_code}\
}}  // namespace {project.namespace}

"""

HEADER_ENUM_TEMPLATE = """
enum class {enum.name} {{
{variants}
}};
"""

HEADER_EVENT_TEMPLATE = """\
class {event.name} final : public ::metrics::structured::Event {{
 public:
  {event.name}();
  ~{event.name}() override;

  {metric_code}\
}};

"""

HEADER_METRIC_TEMPLATE = """\
  {event.name}&& Set{metric.name}(const {metric.type} value) &&;
  {event.name}& Set{metric.name}(const {metric.type} value) &;
"""

IMPL_FILE_TEMPLATE = """\
// Generated from gen_events.py. DO NOT EDIT!
// source: structured.xml

#include "components/metrics/structured/{file.rootname}.h"

#include "base/strings/string_number_conversions.h"
#include "base/values.h"

namespace metrics {{
namespace structured {{
namespace events {{
namespace v2 {{

{project_code}
}}  // namespace v2
}}  // namespace events
}}  // namespace structured
}}  // namespace metrics\
"""

IMPL_PROJECT_TEMPLATE = """\
namespace {project.namespace} {{

{event_code}\
}}  // namespace {project.namespace}

"""

IMPL_EVENT_TEMPLATE = """\
{event.name}::{event.name}() :
  ::metrics::structured::Event(\"{event.project_name}\",
                               \"{event.name}\",
                               {event.is_event_sequence}) {{}}
{event.name}::~{event.name}() = default;

{metric_code}\
"""

IMPL_METRIC_TEMPLATE = """\
{event.name}&& {event.name}::Set{metric.name}(const {metric.type} value) && {{
  AddMetric(\"{metric.name}\", Event::MetricType::{metric.type_enum},
            {metric.base_value});
  return std::move(*this);
}}

{event.name}& {event.name}::Set{metric.name}(const {metric.type} value) & {{
  AddMetric(\"{metric.name}\", Event::MetricType::{metric.type_enum},
            {metric.base_value});
  return *this;
}}

"""

# Typescript templates
TS_FILE_TEMPLATE = """\
// Generated from gen_events.py. DO NOT EDIT!
// source: structured.xml
import {{Event as StructuredMetricsEvent}} from './event.mojom-webui.js';

{project_code}

"""

TS_PROJECT_TEMPLATE = """\
// {project.name} Enums and Event Declarations
{enum_code}

{event_code}
"""

TS_ENUM_TEMPLATE = """
export enum {project_info.name}_{enum.name} {{
{variants}
}};
    """

TS_EVENT_TEMPLATE = """\
export class {event.project_name}_{event.name} {{
private project_name: string = "{event.project_name}";
private is_event_sequence: boolean = {event.is_event_sequence};
private event_name: string = "{event.name}"
{metric_fields}

{metric_code}\

build(): StructuredMetricsEvent {{
  return {{
    projectName: this.project_name,
    eventName: this.event_name,
    isEventSequence: this.is_event_sequence,
    metrics: {{
      {metric_build_code}
    }},
    systemUptime: {event.systemUptime},
  }};
}}
}}
"""

TS_METRIC_FIELD_TEMPLATE = """\
private {metric.name}?: {metric.ts_type};
"""

TS_METRIC_TEMPLATE = """\
set{metric.name}(
    metric_value: {metric.ts_type}): {metric.project_name}_{metric.event_name} {{
  this.{metric.name} = metric_value;
  return this;
}}
"""

TS_METRIC_BUILD_TEMPLATE = """\
  \"{metric.name}\": {{{metric.type_enum}: this.{metric.name}}},
"""