Move some more assorted classes from ExceptionCode to Exception
[WebKit.git] / Source / WebCore / fileapi / FileReader.h
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 #pragma once
32
33 #include "ActiveDOMObject.h"
34 #include "EventTarget.h"
35 #include "ExceptionOr.h"
36 #include "FileError.h"
37 #include "FileReaderLoader.h"
38 #include "FileReaderLoaderClient.h"
39 #include <chrono>
40
41 namespace JSC {
42 class ArrayBuffer;
43 }
44
45 namespace WebCore {
46
47 class Blob;
48 class ScriptExecutionContext;
49
50 class FileReader final : public RefCounted<FileReader>, public ActiveDOMObject, public EventTargetWithInlineData, private FileReaderLoaderClient {
51 public:
52     static Ref<FileReader> create(ScriptExecutionContext&);
53
54     virtual ~FileReader();
55
56     enum ReadyState {
57         EMPTY = 0,
58         LOADING = 1,
59         DONE = 2
60     };
61
62     ExceptionOr<void> readAsArrayBuffer(Blob*);
63     ExceptionOr<void> readAsBinaryString(Blob*);
64     ExceptionOr<void> readAsText(Blob*, const String& encoding);
65     ExceptionOr<void> readAsDataURL(Blob*);
66     void abort();
67
68     void doAbort();
69
70     ReadyState readyState() const { return m_state; }
71     RefPtr<FileError> error() { return m_error; }
72     FileReaderLoader::ReadType readType() const { return m_readType; }
73     RefPtr<JSC::ArrayBuffer> arrayBufferResult() const;
74     String stringResult();
75
76     using RefCounted::ref;
77     using RefCounted::deref;
78
79 private:
80     explicit FileReader(ScriptExecutionContext&);
81
82     const char* activeDOMObjectName() const final;
83     bool canSuspendForDocumentSuspension() const final;
84     void stop() final;
85
86     EventTargetInterface eventTargetInterface() const final { return FileReaderEventTargetInterfaceType; }
87     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
88     void refEventTarget() final { ref(); }
89     void derefEventTarget() final { deref(); }
90
91     void didStartLoading() final;
92     void didReceiveData() final;
93     void didFinishLoading() final;
94     void didFail(int errorCode) final;
95
96     ExceptionOr<void> readInternal(Blob&, FileReaderLoader::ReadType);
97     void fireErrorEvent(int httpStatusCode);
98     void fireEvent(const AtomicString& type);
99
100     ReadyState m_state { EMPTY };
101     bool m_aborting { false };
102     RefPtr<Blob> m_blob;
103     FileReaderLoader::ReadType m_readType { FileReaderLoader::ReadAsBinaryString };
104     String m_encoding;
105     std::unique_ptr<FileReaderLoader> m_loader;
106     RefPtr<FileError> m_error;
107     std::chrono::steady_clock::time_point m_lastProgressNotificationTime;
108 };
109
110 } // namespace WebCore