[WebIDL] Support callbacks with arbitrary return types
[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 #pragma once
27
28 #include "Blob.h"
29 #include <wtf/Optional.h>
30 #include <wtf/Ref.h>
31 #include <wtf/TypeCasts.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35
36 class URL;
37
38 class File final : public Blob {
39 public:
40     struct PropertyBag : BlobPropertyBag {
41         std::optional<long long> lastModified;
42     };
43
44     static Ref<File> create(const String& path)
45     {
46         return adoptRef(*new File(path));
47     }
48
49     // Create a File using the 'new File' constructor.
50     static Ref<File> create(Vector<BlobPartVariant>&& blobPartVariants, const String& filename, const PropertyBag& propertyBag)
51     {
52         return adoptRef(*new File(WTFMove(blobPartVariants), filename, propertyBag));
53     }
54
55     static Ref<File> deserialize(const String& path, const URL& srcURL, const String& type, const String& name)
56     {
57         return adoptRef(*new File(deserializationContructor, path, srcURL, type, name));
58     }
59
60     // 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.
61     static Ref<File> createWithName(const String& path, const String& nameOverride)
62     {
63         if (nameOverride.isEmpty())
64             return adoptRef(*new File(path));
65         return adoptRef(*new File(path, nameOverride));
66     }
67
68     bool isFile() const override { return true; }
69
70     const String& path() const { return m_path; }
71     const String& name() const { return m_name; }
72     WEBCORE_EXPORT double lastModified() const;
73
74     static String contentTypeForFile(const String& path);
75
76 #if ENABLE(FILE_REPLACEMENT)
77     static bool shouldReplaceFile(const String& path);
78 #endif
79
80 private:
81     WEBCORE_EXPORT explicit File(const String& path);
82     File(const String& path, const String& nameOverride);
83     File(Vector<BlobPartVariant>&& blobPartVariants, const String& filename, const PropertyBag&);
84
85     File(DeserializationContructor, const String& path, const URL& srcURL, const String& type, const String& name);
86
87     static void computeNameAndContentType(const String& path, const String& nameOverride, String& effectiveName, String& effectiveContentType);
88 #if ENABLE(FILE_REPLACEMENT)
89     static void computeNameAndContentTypeForReplacedFile(const String& path, const String& nameOverride, String& effectiveName, String& effectiveContentType);
90 #endif
91
92     String m_path;
93     String m_name;
94
95     std::optional<int64_t> m_overrideLastModifiedDate;
96 };
97
98 } // namespace WebCore
99
100 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::File)
101     static bool isType(const WebCore::Blob& blob) { return blob.isFile(); }
102 SPECIALIZE_TYPE_TRAITS_END()