base/substring_set_matcher/matcher_string_pattern.h

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

#ifndef BASE_SUBSTRING_SET_MATCHER_MATCHER_STRING_PATTERN_H_
#define BASE_SUBSTRING_SET_MATCHER_MATCHER_STRING_PATTERN_H_

#include <string>

#include "base/base_export.h"
#include "base/compiler_specific.h"

namespace base {

// An individual pattern of a substring or regex matcher. A pattern consists of
// a string (interpreted as individual bytes, no character encoding) and an
// identifier.
// IDs are returned to the caller of SubstringSetMatcher::Match() or
// RegexMatcher::MatchURL() to help the caller to figure out what
// patterns matched a string. All patterns registered to a matcher
// need to contain unique IDs.
class BASE_EXPORT MatcherStringPattern {
 public:
  using ID = size_t;

  // An invalid ID value. Clients must not use this as the id.
  static constexpr ID kInvalidId = static_cast<ID>(-1);

  MatcherStringPattern(std::string pattern, ID id);

  MatcherStringPattern(const MatcherStringPattern&) = delete;
  MatcherStringPattern& operator=(const MatcherStringPattern&) = delete;

  ~MatcherStringPattern();
  MatcherStringPattern(MatcherStringPattern&&);
  MatcherStringPattern& operator=(MatcherStringPattern&&);
  const std::string& pattern() const LIFETIME_BOUND { return pattern_; }
  ID id() const { return id_; }

  bool operator<(const MatcherStringPattern& rhs) const;

 private:
  std::string pattern_;
  ID id_;
};

}  // namespace base

#endif  // BASE_SUBSTRING_SET_MATCHER_MATCHER_STRING_PATTERN_H_