Source/core/html/TimeRanges.h

/*
 * Copyright (C) 2007, 2009 Apple 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:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``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 APPLE COMPUTER, INC. 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 TimeRanges_h
#define TimeRanges_h

#include "bindings/core/v8/ScriptWrappable.h"
#include "core/CoreExport.h"
#include "platform/heap/Handle.h"
#include "public/platform/WebTimeRange.h"
#include "wtf/Allocator.h"
#include "wtf/Vector.h"

#include <algorithm>

namespace blink {

class ExceptionState;

class CORE_EXPORT TimeRanges : public GarbageCollectedFinalized<TimeRanges>, public ScriptWrappable {
    DEFINE_WRAPPERTYPEINFO();
public:
    // We consider all the Ranges to be semi-bounded as follow: [start, end[
    struct Range {
        ALLOW_ONLY_INLINE_ALLOCATION();
    public:
        Range() { }
        Range(double start, double end)
        {
            m_start = start;
            m_end = end;
        }
        double m_start;
        double m_end;

        inline bool isPointInRange(double point) const
        {
            return m_start <= point && point < m_end;
        }

        inline bool isOverlappingRange(const Range& range) const
        {
            return isPointInRange(range.m_start) || isPointInRange(range.m_end) || range.isPointInRange(m_start);
        }

        inline bool isContiguousWithRange(const Range& range) const
        {
            return range.m_start == m_end || range.m_end == m_start;
        }

        inline Range unionWithOverlappingOrContiguousRange(const Range& range) const
        {
            Range ret;

            ret.m_start = std::min(m_start, range.m_start);
            ret.m_end = std::max(m_end, range.m_end);

            return ret;
        }

        inline bool isBeforeRange(const Range& range) const
        {
            return range.m_start >= m_end;
        }
    };

    static TimeRanges* create()
    {
        return new TimeRanges;
    }
    static TimeRanges* create(double start, double end)
    {
        return new TimeRanges(start, end);
    }
    static TimeRanges* create(const WebTimeRanges&);

    TimeRanges* copy() const;
    void intersectWith(const TimeRanges*);
    void unionWith(const TimeRanges*);

    unsigned length() const { return m_ranges.size(); }
    double start(unsigned index, ExceptionState&) const;
    double end(unsigned index, ExceptionState&) const;

    void add(double start, double end);

    bool contain(double time) const;

    double nearest(double newPlaybackPosition, double currentPlaybackPosition) const;

    DEFINE_INLINE_TRACE() { }

private:
    TimeRanges() { }

    TimeRanges(double start, double end);

    void invert();

    Vector<Range> m_ranges;
};

} // namespace blink

#endif // TimeRanges_h