components/autofill_assistant/browser/selector.h

// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_SELECTOR_H_
#define COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_SELECTOR_H_

#include <ostream>
#include <string>
#include <vector>

#include "base/macros.h"
#include "components/autofill_assistant/browser/service.pb.h"

namespace autofill_assistant {

// A structure to represent a CSS selector.
struct Selector {
  // A sequence of CSS selectors. Any non-final CSS selector is expected to
  // arrive at a frame or an iframe, i.e. an element that contains another
  // document.
  std::vector<std::string> selectors;

  // If true, only match visible elements. Visible elements are elements that
  // have a box model. The box model is not checked at all, so an element with a
  // zero size bounding box is considered visible.
  bool must_be_visible = false;

  // If non-empty, this must be a regular expression that matches the inner text
  // of the element(s) matching selectors.
  std::string inner_text_pattern;

  // If non-empty, this must be a regular expression that matches the value
  // of the element(s) matching selectors.
  std::string value_pattern;

  // An optional pseudo type. This pseudo type is associated to the final
  // element matched by |selectors|, which means that we currently don't handle
  // matching an element inside a pseudo element.
  PseudoType pseudo_type = PseudoType::UNDEFINED;

  Selector();
  explicit Selector(const ElementReferenceProto& element);
  explicit Selector(std::vector<std::string> s);
  Selector(std::vector<std::string> s, PseudoType p);
  ~Selector();

  Selector(Selector&& other);
  Selector(const Selector& other);
  Selector& operator=(Selector&& other);
  Selector& operator=(const Selector& other);

  bool operator<(const Selector& other) const;
  bool operator==(const Selector& other) const;

  // Convenience function to update the visible field in a fluent style.
  Selector& MustBeVisible() {
    must_be_visible = true;
    return *this;
  }

  // The output operator. The actual selectors are only available in debug
  // builds.
  friend std::ostream& operator<<(std::ostream& out, const Selector& selector);

  // Checks whether this selector is empty.
  bool empty() const;

  // Convenience function to set inner_text_pattern in a fluent style.
  Selector& MatchingInnerText(const std::string& pattern) {
    inner_text_pattern = pattern;
    return *this;
  }

  // Convenience function to set inner_text_pattern in a fluent style.
  Selector& MatchingValue(const std::string& pattern) {
    value_pattern = pattern;
    return *this;
  }
};
}  // namespace autofill_assistant

#endif  // COMPONENTS_AUTOFILL_ASSISTANT_BROWSER_SELECTOR_H_