Source/core/html/HTMLImportData.h

/*
 * Copyright (C) 2013 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 HTMLImportData_h
#define HTMLImportData_h

#include "core/html/HTMLImportResourceOwner.h"
#include "wtf/Vector.h"

namespace WebCore {

class Document;
class DocumentWriter;
class HTMLImport;
class HTMLImportDataClient;

//
// Owning imported Document lifetime. It also implements ResourceClient through HTMLImportResourceOwner
// to feed fetched bytes to the DocumentWriter of the imported document.
// HTMLImportData is owned by and shared between HTMLImportChild.
//
// FIXME: Should be renamed to HTMLImportLoader
//
class HTMLImportData : public RefCounted<HTMLImportData>, public HTMLImportResourceOwner {
public:
    enum State {
        StateLoading,
        StateWritten,
        StateError,
        StateReady
    };

    static PassRefPtr<HTMLImportData> create(HTMLImport*, ResourceFetcher*);

    virtual ~HTMLImportData();

    Document* document() const { return m_importedDocument.get(); }
    Document* importedDocument() const;
    void addClient(HTMLImportDataClient*);
    void removeClient(HTMLImportDataClient*);

    bool isDone() const { return m_state == StateReady || m_state == StateError; }
    bool isLoaded() const { return m_state == StateReady; }
    bool isProcessing() const;

    void startLoading(const ResourcePtr<RawResource>&);
    void didFinishParsing();
    bool isOwnedBy(const HTMLImport* import) const { return m_import == import; }

private:
    HTMLImportData(HTMLImport*, ResourceFetcher*);

    // RawResourceClient
    virtual void responseReceived(Resource*, const ResourceResponse&) OVERRIDE;
    virtual void dataReceived(Resource*, const char* data, int length) OVERRIDE;
    virtual void notifyFinished(Resource*) OVERRIDE;

    State startWritingAndParsing(const ResourceResponse&);
    State finishWriting();
    State finishParsing();

    void setState(State);
    void didFinish();

    HTMLImport* m_import;
    ResourceFetcher* m_fetcher;
    Vector<HTMLImportDataClient*> m_clients;
    State m_state;
    RefPtr<Document> m_importedDocument;
    RefPtr<DocumentWriter> m_writer;
};

} // namespace WebCore

#endif // HTMLImportData_h