1/*
2 * Copyright (C) 2010 Google Inc.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef FileWriter_h
32#define FileWriter_h
33
34#include "bindings/v8/ScriptWrappable.h"
35#include "core/dom/ActiveDOMObject.h"
36#include "core/dom/EventTarget.h"
37#include "core/dom/ScriptExecutionContext.h"
38#include "modules/filesystem/AsyncFileWriterClient.h"
39#include "modules/filesystem/FileWriterBase.h"
40#include "wtf/PassRefPtr.h"
41#include "wtf/RefPtr.h"
42
43namespace WebCore {
44
45class Blob;
46class ExceptionState;
47class ScriptExecutionContext;
48
49class FileWriter : public ScriptWrappable, public FileWriterBase, public ActiveDOMObject, public EventTarget, public AsyncFileWriterClient {
50public:
51    static PassRefPtr<FileWriter> create(ScriptExecutionContext*);
52
53    enum ReadyState {
54        INIT = 0,
55        WRITING = 1,
56        DONE = 2
57    };
58
59    void write(Blob*, ExceptionState&);
60    void seek(long long position, ExceptionState&);
61    void truncate(long long length, ExceptionState&);
62    void abort(ExceptionState&);
63    ReadyState readyState() const { return m_readyState; }
64    FileError* error() const { return m_error.get(); }
65
66    // AsyncFileWriterClient
67    void didWrite(long long bytes, bool complete);
68    void didTruncate();
69    void didFail(FileError::ErrorCode);
70
71    // ActiveDOMObject
72    virtual bool canSuspend() const;
73    virtual void stop();
74
75    // EventTarget
76    virtual const AtomicString& interfaceName() const;
77    virtual ScriptExecutionContext* scriptExecutionContext() const { return ActiveDOMObject::scriptExecutionContext(); }
78
79    using RefCounted<FileWriterBase>::ref;
80    using RefCounted<FileWriterBase>::deref;
81
82    DEFINE_ATTRIBUTE_EVENT_LISTENER(writestart);
83    DEFINE_ATTRIBUTE_EVENT_LISTENER(progress);
84    DEFINE_ATTRIBUTE_EVENT_LISTENER(write);
85    DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
86    DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
87    DEFINE_ATTRIBUTE_EVENT_LISTENER(writeend);
88
89private:
90    enum Operation {
91        OperationNone,
92        OperationWrite,
93        OperationTruncate,
94        OperationAbort
95    };
96
97    FileWriter(ScriptExecutionContext*);
98
99    virtual ~FileWriter();
100
101    // EventTarget
102    virtual void refEventTarget() { ref(); }
103    virtual void derefEventTarget() { deref(); }
104    virtual EventTargetData* eventTargetData() { return &m_eventTargetData; }
105    virtual EventTargetData* ensureEventTargetData() { return &m_eventTargetData; }
106
107    void completeAbort();
108
109    void doOperation(Operation);
110
111    void signalCompletion(FileError::ErrorCode);
112
113    void fireEvent(const AtomicString& type);
114
115    void setError(FileError::ErrorCode, ExceptionState&);
116
117    RefPtr<FileError> m_error;
118    EventTargetData m_eventTargetData;
119    ReadyState m_readyState;
120    Operation m_operationInProgress;
121    Operation m_queuedOperation;
122    long long m_bytesWritten;
123    long long m_bytesToWrite;
124    long long m_truncateLength;
125    long long m_numAborts;
126    long long m_recursionDepth;
127    double m_lastProgressNotificationTimeMS;
128    RefPtr<Blob> m_blobBeingWritten;
129};
130
131} // namespace WebCore
132
133#endif // FileWriter_h
134