.: Blob.slice support.
[WebKit-https.git] / WebCore / html / Blob.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 #ifndef Blob_h
32 #define Blob_h
33
34 #include "ExceptionCode.h"
35 #include "PlatformString.h"
36 #include <time.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefCounted.h>
39
40 namespace WebCore {
41
42 class Blob : public RefCounted<Blob> {
43 public:
44 #if ENABLE(BLOB_SLICE)
45     static const int toEndOfFile = -1;
46     static const double doNotCheckFileChange = 0;
47 #endif
48
49     static PassRefPtr<Blob> create(const String& path)
50     {
51         return adoptRef(new Blob(path));
52     }
53
54     virtual ~Blob() { }
55
56 #if ENABLE(BLOB_SLICE)
57     PassRefPtr<Blob> slice(long long start, long long length) const;
58 #endif
59
60     const String& path() const { return m_path; }
61     unsigned long long size() const;
62 #if ENABLE(BLOB_SLICE)
63     long long start() const { return m_start; }
64     long long length() const { return m_length; }
65     double modificationTime() const { return m_snapshotModificationTime; }
66 #endif
67
68 protected:
69     Blob(const String& path);
70
71 private:
72 #if ENABLE(BLOB_SLICE)
73     Blob(const String& path, long long start, long long length, long long snapshotSize, double snapshotModificationTime);
74 #endif
75
76     // The underlying path of the file-based blob. 
77     String m_path;
78
79 #if ENABLE(BLOB_SLICE)
80     // The starting position of the file-based blob.
81     long long m_start;
82
83     // The length of the file-based blob. The value of -1 means to the end of the file.
84     long long m_length;
85
86     // A flag to tell if a snapshot has been captured.
87     bool m_snapshotCaptured;
88
89     // The size of the file when a snapshot is captured. It can be 0 if the file is empty.
90     long long m_snapshotSize;
91
92     // The last modification time of the file when a snapshot is captured. The value of 0 also means that the snapshot is not captured.
93     double m_snapshotModificationTime;
94 #endif
95 };
96
97 } // namespace WebCore
98
99 #endif // Blob_h