5ff8a43719c0d9083947e1c8eaddd7d49d87b495
[WebKit-https.git] / Source / WebCore / platform / FileHandle.h
1 /*
2  * Copyright (C) 2016 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #include "FileSystem.h"
32
33 #include <wtf/Assertions.h>
34
35 namespace WebCore {
36
37 class WEBCORE_EXPORT FileHandle final {
38 public:
39     FileHandle() = default;
40     FileHandle(const String& path, FileSystem::FileOpenMode);
41     FileHandle(const String& path, FileSystem::FileOpenMode, OptionSet<FileSystem::FileLockMode>);
42     FileHandle(const FileHandle& other) = delete;
43     FileHandle(FileHandle&& other);
44
45     ~FileHandle();
46
47     FileHandle& operator=(const FileHandle& other) = delete;
48     FileHandle& operator=(FileHandle&& other);
49
50     explicit operator bool() const;
51
52     bool open(const String& path, FileSystem::FileOpenMode);
53     bool open();
54     int read(void* data, int length);
55     int write(const void* data, int length);
56     bool printf(const char* format, ...) WTF_ATTRIBUTE_PRINTF(2, 3);
57     void close();
58
59 private:
60     String m_path;
61     FileSystem::FileOpenMode m_mode { FileSystem::FileOpenMode::Read };
62     FileSystem::PlatformFileHandle m_fileHandle { FileSystem::invalidPlatformFileHandle };
63     bool m_shouldLock { false };
64     OptionSet<FileSystem::FileLockMode> m_lockMode;
65 };
66
67 } // namespace WebCore