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 <wtf/Assertions.h>
32#include <wtf/FileSystem.h>
33
34namespace WebCore {
35
36class WEBCORE_EXPORT FileHandle final {
37public:
38 FileHandle() = default;
39 FileHandle(const String& path, FileSystem::FileOpenMode);
40 FileHandle(const String& path, FileSystem::FileOpenMode, OptionSet<FileSystem::FileLockMode>);
41 FileHandle(const FileHandle& other) = delete;
42 FileHandle(FileHandle&& other);
43
44 ~FileHandle();
45
46 FileHandle& operator=(const FileHandle& other) = delete;
47 FileHandle& operator=(FileHandle&& other);
48
49 explicit operator bool() const;
50
51 bool open(const String& path, FileSystem::FileOpenMode);
52 bool open();
53 int read(void* data, int length);
54 int write(const void* data, int length);
55 bool printf(const char* format, ...) WTF_ATTRIBUTE_PRINTF(2, 3);
56 void close();
57
58private:
59 String m_path;
60 FileSystem::FileOpenMode m_mode { FileSystem::FileOpenMode::Read };
61 FileSystem::PlatformFileHandle m_fileHandle { FileSystem::invalidPlatformFileHandle };
62 OptionSet<FileSystem::FileLockMode> m_lockMode;
63 bool m_shouldLock { false };
64};
65
66} // namespace WebCore
67