Source/WebCore/Modules/highlight/HighlightRangeGroup.h

/*
 * Copyright (C) 2019 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 INC. AND ITS 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 APPLE INC. OR ITS 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.
 */

#pragma once

#include "ExceptionOr.h"
#include "StaticRange.h"
#include <wtf/RefCounted.h>

namespace WebCore {

class CSSStyleDeclaration;
class StaticRange;
class PropertySetCSSStyleDeclaration;

class HighlightRangeGroup : public RefCounted<HighlightRangeGroup> {
public:
    static Ref<HighlightRangeGroup> create(StaticRange&);

    ExceptionOr<void> addRange(StaticRange&);
    ExceptionOr<void> removeRange(StaticRange&);
    
    Vector<Ref<StaticRange>> ranges;

    WEBCORE_EXPORT CSSStyleDeclaration& style();
    
    class Iterator {
    public:
        explicit Iterator(HighlightRangeGroup&);
        RefPtr<StaticRange> next();
        
    private:
        Ref<HighlightRangeGroup> m_group;
        size_t m_index { 0 }; // FIXME: There needs to be a mechanism to handle when ranges are added or removed from the middle of the HighlightRangeGroup.
    };
    Iterator createIterator() { return Iterator(*this); }
    
private:
    HighlightRangeGroup(StaticRange&);
};

}