/*

 * Copyright (C) 2010. Adam Barth. 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. 

 * 3.  Neither the name of Adam Barth. ("Adam Barth") 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 APPLE 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 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.

 */

#ifndef DocumentWriter_h

#define DocumentWriter_h

#include "KURL.h"

#include "PlatformString.h"

namespace WebCore {

class Document;

class Frame;

class SecurityOrigin;

class TextResourceDecoder;

class DocumentWriter : public Noncopyable {

public:

    DocumentWriter(Frame*);

    // This is only called by ScriptController::executeIfJavaScriptURL

    // and always contains the result of evaluating a javascript: url.

    void replaceDocument(const String&);

    void begin();

    void begin(const KURL&, bool dispatchWindowObjectAvailable = true, SecurityOrigin* forcedSecurityOrigin = 0);

    void addData(const char* string, int length = -1, bool flush = false);

    void end();

    void endIfNotLoadingMainResource();

    void clear();

    String encoding() const;

    void setEncoding(const String& encoding, bool userChosen);

    // FIXME: It's really unforunate to need to expose this piece of state.

    // I suspect a better design is to disentangle user-provided encodings,

    // default encodings, and the decoding we're currently using.

    String deprecatedFrameEncoding() const;

    const String& mimeType() const { return m_mimeType; }

    void setMIMEType(const String& type) { m_mimeType = type; }

    void setDecoder(TextResourceDecoder*);

    // Exposed for DoucmentParser::appendBytes

    TextResourceDecoder* createDecoderIfNeeded();

    void reportDataRecieved();

private:

    PassRefPtr<Document> createDocument(const KURL&);

    Frame* m_frame;

    bool m_receivedData;

    String m_mimeType;

    bool m_encodingWasChosenByUser;

    String m_encoding;

    RefPtr<TextResourceDecoder> m_decoder;

};

} // namespace WebCore

#endif // DocumentWriter_h