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 FileReader_h
32#define FileReader_h
33
34#include "bindings/v8/ScriptWrappable.h"
35#include "core/dom/ActiveDOMObject.h"
36#include "core/events/EventTarget.h"
37#include "core/fileapi/FileError.h"
38#include "core/fileapi/FileReaderLoader.h"
39#include "core/fileapi/FileReaderLoaderClient.h"
40#include "wtf/Forward.h"
41#include "wtf/RefCounted.h"
42#include "wtf/ThreadSpecific.h"
43#include "wtf/text/WTFString.h"
44
45namespace WebCore {
46
47class Blob;
48class ExceptionState;
49class ExecutionContext;
50
51class FileReader : public RefCounted<FileReader>, public ScriptWrappable, public ActiveDOMObject, public EventTargetWithInlineData, public FileReaderLoaderClient {
52    REFCOUNTED_EVENT_TARGET(FileReader);
53public:
54    static PassRefPtr<FileReader> create(ExecutionContext*);
55
56    virtual ~FileReader();
57
58    enum ReadyState {
59        EMPTY = 0,
60        LOADING = 1,
61        DONE = 2
62    };
63
64    void readAsArrayBuffer(Blob*, ExceptionState&);
65    void readAsBinaryString(Blob*, ExceptionState&);
66    void readAsText(Blob*, const String& encoding, ExceptionState&);
67    void readAsText(Blob*, ExceptionState&);
68    void readAsDataURL(Blob*, ExceptionState&);
69    void abort();
70
71    void doAbort();
72
73    ReadyState readyState() const { return m_state; }
74    PassRefPtr<FileError> error() { return m_error; }
75    FileReaderLoader::ReadType readType() const { return m_readType; }
76    PassRefPtr<ArrayBuffer> arrayBufferResult() const;
77    String stringResult();
78
79    // ActiveDOMObject
80    virtual void stop();
81
82    // EventTarget
83    virtual const AtomicString& interfaceName() const OVERRIDE;
84    virtual ExecutionContext* executionContext() const OVERRIDE { return ActiveDOMObject::executionContext(); }
85
86    // FileReaderLoaderClient
87    virtual void didStartLoading();
88    virtual void didReceiveData();
89    virtual void didFinishLoading();
90    virtual void didFail(FileError::ErrorCode);
91
92    DEFINE_ATTRIBUTE_EVENT_LISTENER(loadstart);
93    DEFINE_ATTRIBUTE_EVENT_LISTENER(progress);
94    DEFINE_ATTRIBUTE_EVENT_LISTENER(load);
95    DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
96    DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
97    DEFINE_ATTRIBUTE_EVENT_LISTENER(loadend);
98
99private:
100    class ThrottlingController;
101
102    FileReader(ExecutionContext*);
103
104    void terminate();
105    void readInternal(Blob*, FileReaderLoader::ReadType, ExceptionState&);
106    void fireErrorEvent(int httpStatusCode);
107    void fireEvent(const AtomicString& type);
108
109    static ThreadSpecific<ThrottlingController>& throttlingController();
110    void executePendingRead();
111
112    ReadyState m_state;
113
114    // Internal loading state, which could differ from ReadyState as it's
115    // for script-visible state while this one's for internal state.
116    enum LoadingState {
117        LoadingStateNone,
118        LoadingStatePending,
119        LoadingStateLoading,
120        LoadingStateAborted
121    };
122    LoadingState m_loadingState;
123
124    RefPtr<Blob> m_blob;
125    FileReaderLoader::ReadType m_readType;
126    String m_encoding;
127
128    OwnPtr<FileReaderLoader> m_loader;
129    RefPtr<FileError> m_error;
130    double m_lastProgressNotificationTimeMS;
131};
132
133} // namespace WebCore
134
135#endif // FileReader_h
136