[WTF] Import std::optional reference implementation as WTF::Optional
[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     static Ref<File> create(const String& path)
41     {
42         return adoptRef(*new File(path));
43     }
44
45     // Create a File using the 'new File' constructor.
46     static Ref<File> create(Vector<BlobPart> blobParts, const String& filename, const String& contentType, int64_t lastModified)
47     {
48         return adoptRef(*new File(WTFMove(blobParts), filename, contentType, lastModified));
49     }
50
51     static Ref<File> deserialize(const String& path, const URL& srcURL, const String& type, const String& name)
52     {
53         return adoptRef(*new File(deserializationContructor, path, srcURL, type, name));
54     }
55
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 Ref<File> createWithName(const String& path, const String& nameOverride)
58     {
59         if (nameOverride.isEmpty())
60             return adoptRef(*new File(path));
61         return adoptRef(*new File(path, nameOverride));
62     }
63
64     bool isFile() const override { return true; }
65
66     const String& path() const { return m_path; }
67     const String& name() const { return m_name; }
68     WEBCORE_EXPORT double lastModified() const;
69
70     static String contentTypeForFile(const String& path);
71
72 #if ENABLE(FILE_REPLACEMENT)
73     static bool shouldReplaceFile(const String& path);
74 #endif
75
76 private:
77     WEBCORE_EXPORT explicit File(const String& path);
78     File(const String& path, const String& nameOverride);
79     File(Vector<BlobPart>&& blobParts, const String& filename, const String& contentType, int64_t lastModified);
80
81     File(DeserializationContructor, const String& path, const URL& srcURL, const String& type, const String& name);
82
83     static void computeNameAndContentType(const String& path, const String& nameOverride, String& effectiveName, String& effectiveContentType);
84 #if ENABLE(FILE_REPLACEMENT)
85     static void computeNameAndContentTypeForReplacedFile(const String& path, const String& nameOverride, String& effectiveName, String& effectiveContentType);
86 #endif
87
88     String m_path;
89     String m_name;
90
91     std::optional<int64_t> m_overrideLastModifiedDate;
92 };
93
94 } // namespace WebCore
95
96 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::File)
97     static bool isType(const WebCore::Blob& blob) { return blob.isFile(); }
98 SPECIALIZE_TYPE_TRAITS_END()