mirror of
https://github.com/SerenityOS/serenity
synced 2024-07-21 01:55:07 +00:00
8464da1439
`Stream` will be qualified as `AK::Stream` until we remove the `Core::Stream` namespace. `IODevice` now reuses the `SeekMode` that is defined by `SeekableStream`, since defining its own would require us to qualify it with `AK::SeekMode` everywhere.
133 lines
3.1 KiB
C++
133 lines
3.1 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
* Copyright (c) 2022, the SerenityOS developers.
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/EnumBits.h>
|
|
#include <AK/Forward.h>
|
|
#include <AK/Stream.h>
|
|
#include <LibCore/Object.h>
|
|
|
|
namespace Core {
|
|
|
|
class IODevice;
|
|
|
|
// This is not necessarily a valid iterator in all contexts,
|
|
// if we had concepts, this would be InputIterator, not Copyable, Movable.
|
|
class LineIterator {
|
|
AK_MAKE_NONCOPYABLE(LineIterator);
|
|
|
|
public:
|
|
explicit LineIterator(IODevice&, bool is_end = false);
|
|
|
|
bool operator==(LineIterator const& other) const { return &other == this || (at_end() && other.is_end()) || (other.at_end() && is_end()); }
|
|
bool is_end() const { return m_is_end; }
|
|
bool at_end() const;
|
|
|
|
LineIterator& operator++();
|
|
|
|
StringView operator*() const { return m_buffer; }
|
|
|
|
private:
|
|
NonnullRefPtr<IODevice> m_device;
|
|
bool m_is_end { false };
|
|
DeprecatedString m_buffer;
|
|
};
|
|
|
|
class LineRange {
|
|
public:
|
|
LineRange() = delete;
|
|
explicit LineRange(IODevice& device)
|
|
: m_device(device)
|
|
{
|
|
}
|
|
LineIterator begin();
|
|
LineIterator end();
|
|
|
|
private:
|
|
IODevice& m_device;
|
|
};
|
|
|
|
enum class OpenMode : unsigned {
|
|
NotOpen = 0,
|
|
ReadOnly = 1,
|
|
WriteOnly = 2,
|
|
ReadWrite = 3,
|
|
Append = 4,
|
|
Truncate = 8,
|
|
MustBeNew = 16,
|
|
KeepOnExec = 32,
|
|
};
|
|
|
|
AK_ENUM_BITWISE_OPERATORS(OpenMode)
|
|
|
|
class IODevice : public Object {
|
|
C_OBJECT_ABSTRACT(IODevice)
|
|
public:
|
|
virtual ~IODevice() override = default;
|
|
|
|
int fd() const { return m_fd; }
|
|
OpenMode mode() const { return m_mode; }
|
|
bool is_open() const { return m_mode != OpenMode::NotOpen; }
|
|
bool eof() const { return m_eof; }
|
|
|
|
int error() const { return m_error; }
|
|
char const* error_string() const;
|
|
|
|
bool has_error() const { return m_error != 0; }
|
|
|
|
int read(u8* buffer, int length);
|
|
|
|
ByteBuffer read(size_t max_size);
|
|
ByteBuffer read_all();
|
|
DeprecatedString read_line(size_t max_size = 16384);
|
|
|
|
bool write(u8 const*, int size);
|
|
bool write(StringView);
|
|
|
|
bool truncate(off_t);
|
|
|
|
bool can_read_line() const;
|
|
|
|
bool can_read() const;
|
|
bool can_read_only_from_buffer() const { return !m_buffered_data.is_empty() && !can_read_from_fd(); }
|
|
|
|
bool seek(i64, SeekMode = SeekMode::SetPosition, off_t* = nullptr);
|
|
|
|
virtual bool open(OpenMode) = 0;
|
|
virtual bool close();
|
|
|
|
LineIterator line_begin() & { return LineIterator(*this); }
|
|
LineIterator line_end() { return LineIterator(*this, true); }
|
|
LineRange lines()
|
|
{
|
|
return LineRange(*this);
|
|
}
|
|
|
|
protected:
|
|
explicit IODevice(Object* parent = nullptr);
|
|
|
|
void set_fd(int);
|
|
void set_mode(OpenMode mode) { m_mode = mode; }
|
|
void set_error(int error) const { m_error = error; }
|
|
void set_eof(bool eof) const { m_eof = eof; }
|
|
|
|
virtual void did_update_fd(int) { }
|
|
|
|
private:
|
|
bool populate_read_buffer(size_t size = 1024) const;
|
|
bool can_read_from_fd() const;
|
|
|
|
int m_fd { -1 };
|
|
OpenMode m_mode { OpenMode::NotOpen };
|
|
mutable int m_error { 0 };
|
|
mutable bool m_eof { false };
|
|
mutable Vector<u8> m_buffered_data;
|
|
};
|
|
|
|
}
|