2011-05-23 Adam Klein <adamk@chromium.org>
[WebKit-https.git] / Source / WebCore / fileapi / File.h
1 /*
2  * Copyright (C) 2008 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef File_h
27 #define File_h
28
29 #include "Blob.h"
30 #include "PlatformString.h"
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RefCounted.h>
33
34 namespace WebCore {
35
36 class KURL;
37
38 class File : public Blob {
39 public:
40     static PassRefPtr<File> create(const String& path)
41     {
42         return adoptRef(new File(path));
43     }
44
45     // For deserialization.
46     static PassRefPtr<File> create(const String& path, const KURL& srcURL, const String& type)
47     {
48         return adoptRef(new File(path, srcURL, type));
49     }
50
51 #if ENABLE(DIRECTORY_UPLOAD)
52     static PassRefPtr<File> createWithRelativePath(const String& path, const String& relativePath);
53 #endif
54
55 #if ENABLE(FILE_SYSTEM)
56     // Create a file with a name exposed to the author (via File.name and associated DOM properties) that differs from the one provided in the path.
57     static PassRefPtr<File> createWithName(const String& path, const String& name)
58     {
59         return adoptRef(new File(path, name));
60     }
61 #endif
62
63     virtual unsigned long long size() const;
64     virtual bool isFile() const { return true; }
65
66     const String& path() const { return m_path; }
67     const String& name() const { return m_name; }
68     double lastModifiedDate() const;
69 #if ENABLE(DIRECTORY_UPLOAD)
70     // Returns the relative path of this file in the context of a directory selection.
71     const String& webkitRelativePath() const { return m_relativePath; }
72 #endif
73
74     // Note that this involves synchronous file operation. Think twice before calling this function.
75     void captureSnapshot(long long& snapshotSize, double& snapshotModificationTime) const;
76
77     // FIXME: obsolete attributes. To be removed.
78     const String& fileName() const { return name(); }
79     unsigned long long fileSize() const { return size(); }
80
81 private:
82     File(const String& path);
83
84     // For deserialization.
85     File(const String& path, const KURL& srcURL, const String& type);
86
87 #if ENABLE(FILE_SYSTEM)
88     File(const String& path, const String& name);
89 #endif
90
91     String m_path;
92     String m_name;
93 #if ENABLE(DIRECTORY_UPLOAD)
94     String m_relativePath;
95 #endif
96 };
97
98 } // namespace WebCore
99
100 #endif // File_h