third_party/blink/public/platform/web_time_range.h

/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_PUBLIC_PLATFORM_WEB_TIME_RANGE_H_
#define THIRD_PARTY_BLINK_PUBLIC_PLATFORM_WEB_TIME_RANGE_H_

#include <algorithm>
#include <vector>

#include "third_party/blink/public/platform/web_common.h"

namespace blink {

class WebTimeRange {
 public:
  WebTimeRange() : start(0), end(0) {}
  WebTimeRange(double s, double e) : start(s), end(e) {}

  double start;
  double end;

  inline bool IsPointInRange(double point) const {
    return start <= point && point < end;
  }

  inline bool IsOverlappingRange(const WebTimeRange& range) const {
    return IsPointInRange(range.start) || IsPointInRange(range.end) ||
           range.IsPointInRange(start);
  }

  inline bool IsContiguousWithRange(const WebTimeRange& range) const {
    return range.start == end || range.end == start;
  }

  inline WebTimeRange UnionWithOverlappingOrContiguousRange(
      const WebTimeRange& range) const {
    WebTimeRange ret;

    ret.start = std::min(start, range.start);
    ret.end = std::max(end, range.end);

    return ret;
  }

  inline bool IsBeforeRange(const WebTimeRange& range) const {
    return range.start >= end;
  }
};

class BLINK_PLATFORM_EXPORT WebTimeRanges {
 public:
  WebTimeRanges() = default;
  explicit WebTimeRanges(size_t size) : data_(size) {}

  // Constructs a WebTimeRanges with a single range.
  WebTimeRanges(double start, double end) : data_({WebTimeRange(start, end)}) {}

  size_t size() const { return data_.size(); }
  bool empty() const { return data_.empty(); }
  auto begin() const { return data_.begin(); }
  auto end() const { return data_.end(); }

  const WebTimeRange& operator[](size_t i) const { return data_[i]; }
  const WebTimeRange& front() const { return data_.front(); }
  const WebTimeRange& back() const { return data_.back(); }

  void clear() { data_.clear(); }

#if INSIDE_BLINK
  // Use this with caution not to break data integrity (e.g. ranges are sorted
  // and there are no overlapping/contiguous ranges).
  WebTimeRange& operator[](size_t i) { return data_[i]; }
#endif

  void IntersectWith(const WebTimeRanges& other);
  void UnionWith(const WebTimeRanges& other);
  void Add(double start, double end);
  bool Contain(double time) const;
  double Nearest(double new_playback_position,
                 double current_playback_position) const;
  void Invert();

 private:
  std::vector<WebTimeRange> data_;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_PUBLIC_PLATFORM_WEB_TIME_RANGE_H_