File: tutorial_description.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (103 lines) | stat: -rw-r--r-- 3,985 bytes parent folder | download | duplicates (5)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
// 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.

#include "components/user_education/common/tutorial/tutorial_description.h"

#include <string_view>
#include <variant>

#include "components/user_education/common/user_education_events.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/base/interaction/element_tracker.h"
#include "ui/base/interaction/interaction_sequence.h"

namespace user_education {

ScopedTutorialState::ScopedTutorialState(ui::ElementContext context)
    : context_(context) {}
ScopedTutorialState::~ScopedTutorialState() = default;

TutorialDescription::TutorialDescription() = default;
TutorialDescription::TutorialDescription(TutorialDescription&&) noexcept =
    default;
TutorialDescription& TutorialDescription::operator=(
    TutorialDescription&&) noexcept = default;
TutorialDescription::~TutorialDescription() = default;

TutorialDescription::Step::Step() = default;

TutorialDescription::Step::Step(ElementSpecifier element,
                                ui::InteractionSequence::StepType step_type,
                                HelpBubbleArrow arrow,
                                ui::CustomElementEventType event_type)
    : element_id_(std::holds_alternative<ui::ElementIdentifier>(element)
                      ? std::get<ui::ElementIdentifier>(element)
                      : ui::ElementIdentifier()),
      element_name_(std::holds_alternative<std::string>(element)
                        ? std::get<std::string>(element)
                        : std::string()),
      step_type_(step_type),
      event_type_(event_type) {}

TutorialDescription::Step::Step(const TutorialDescription::Step&) = default;
TutorialDescription::Step& TutorialDescription::Step::operator=(
    const TutorialDescription::Step&) = default;
TutorialDescription::Step::~Step() = default;

TutorialDescription::Step& TutorialDescription::Step::NameElement(
    std::string name) {
  return NameElements(base::BindRepeating(
      [](std::string name, ui::InteractionSequence* sequence,
         ui::TrackedElement* element) {
        sequence->NameElement(element, std::string_view(name));
        return true;
      },
      name));
}

bool TutorialDescription::Step::ShouldShowBubble() const {
  // Hide steps and steps with no body text are "hidden" steps.
  return body_text_id_ &&
         step_type_ != ui::InteractionSequence::StepType::kHidden &&
         step_type_ != ui::InteractionSequence::StepType::kSubsequence;
}

TutorialDescription::BubbleStep&
TutorialDescription::BubbleStep::AddDefaultNextButton() {
  return AddCustomNextButton(
      base::BindRepeating([](ui::TrackedElement* current_anchor) {
        ui::ElementTracker::GetFrameworkDelegate()->NotifyCustomEvent(
            current_anchor, kHelpBubbleNextButtonClickedEvent);
      }));
}

TutorialDescription::WaitForAnyOf::WaitForAnyOf(ElementSpecifier first,
                                                bool wait_for_event)
    : HiddenStep(ui::ElementIdentifier(),
                 ui::InteractionSequence::StepType::kSubsequence) {
  subsequence_mode_ = ui::InteractionSequence::SubsequenceMode::kAtLeastOne;
  Or(first, wait_for_event);
}

TutorialDescription::WaitForAnyOf& TutorialDescription::WaitForAnyOf::Or(
    ElementSpecifier element,
    bool wait_for_event) {
  branches_.emplace_back(
      AlwaysRun(), Steps(wait_for_event ? HiddenStep::WaitForShowEvent(element)
                                        : HiddenStep::WaitForShown(element)));
  return *this;
}

// static
TutorialDescription::ConditionalCallback TutorialDescription::AlwaysRun() {
  return base::BindRepeating([](const ui::TrackedElement*) { return true; });
}

// static
TutorialDescription::ConditionalCallback TutorialDescription::RunIfPresent() {
  return base::BindRepeating(
      [](const ui::TrackedElement* el) { return el != nullptr; });
}

}  // namespace user_education