jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/String.h>
30#include <LibCore/IODevice.h>
31
32namespace Core {
33
34class File final : public IODevice {
35 C_OBJECT(File)
36public:
37 virtual ~File() override;
38
39 static RefPtr<File> open(const String& filename, IODevice::OpenMode, mode_t = 0644);
40
41 String filename() const { return m_filename; }
42 void set_filename(const StringView& filename) { m_filename = filename; }
43
44 bool is_directory() const;
45 static bool is_directory(const String& filename);
46
47 static bool exists(const String& filename);
48
49 virtual bool open(IODevice::OpenMode) override;
50
51 enum class ShouldCloseFileDescription {
52 No = 0,
53 Yes
54 };
55 bool open(int fd, IODevice::OpenMode, ShouldCloseFileDescription);
56
57private:
58 File(Object* parent = nullptr)
59 : IODevice(parent)
60 {
61 }
62 explicit File(const StringView&, Object* parent = nullptr);
63
64 bool open_impl(IODevice::OpenMode, mode_t);
65
66 String m_filename;
67 ShouldCloseFileDescription m_should_close_file_descriptor { ShouldCloseFileDescription::Yes };
68};
69
70}