ladybird/Userland/Applications/HexEditor/HexDocument.h
Sam Atkins 8cac2e89a9 HexEditor: Store annotations in a Model
A model is necessary for displaying a list of them in the UI. We might
as well make that their home.
2024-01-30 23:34:49 +00:00

123 lines
3.4 KiB
C++

/*
* Copyright (c) 2021, Arne Elster <arne@elster.li>
* Copyright (c) 2024, Sam Atkins <atkinssj@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include "AnnotationsModel.h"
#include <AK/HashMap.h>
#include <AK/NonnullOwnPtr.h>
#include <AK/String.h>
#include <AK/StringView.h>
#include <AK/Time.h>
#include <AK/Types.h>
#include <AK/WeakPtr.h>
#include <LibCore/Forward.h>
#include <LibGUI/Command.h>
#include <LibGfx/Color.h>
constexpr Duration COMMAND_COMMIT_TIME = Duration::from_milliseconds(400);
class HexDocument : public Weakable<HexDocument> {
public:
enum class Type {
Memory,
File
};
struct Cell {
u8 value;
bool modified;
};
virtual ~HexDocument() = default;
virtual Cell get(size_t position) = 0;
virtual u8 get_unchanged(size_t position) = 0;
virtual void set(size_t position, u8 value);
virtual size_t size() const = 0;
virtual Type type() const = 0;
virtual bool is_dirty() const;
virtual void clear_changes() = 0;
AnnotationsModel& annotations() { return *m_annotations; }
protected:
HexDocument();
HashMap<size_t, u8> m_changes;
NonnullRefPtr<AnnotationsModel> m_annotations;
};
class HexDocumentMemory final : public HexDocument {
public:
explicit HexDocumentMemory(ByteBuffer&& buffer);
virtual ~HexDocumentMemory() = default;
Cell get(size_t position) override;
u8 get_unchanged(size_t position) override;
size_t size() const override;
Type type() const override;
void clear_changes() override;
ErrorOr<void> write_to_file(Core::File& file);
private:
ByteBuffer m_buffer;
};
class HexDocumentFile final : public HexDocument {
public:
static ErrorOr<NonnullOwnPtr<HexDocumentFile>> create(NonnullOwnPtr<Core::File> file);
virtual ~HexDocumentFile() = default;
HexDocumentFile(HexDocumentFile&&) = default;
HexDocumentFile(HexDocumentFile const&) = delete;
ErrorOr<void> set_file(NonnullOwnPtr<Core::File> file);
NonnullOwnPtr<Core::File> const& file() const;
ErrorOr<void> write_to_file();
ErrorOr<void> write_to_file(Core::File& file);
Cell get(size_t position) override;
u8 get_unchanged(size_t position) override;
size_t size() const override;
Type type() const override;
void clear_changes() override;
private:
explicit HexDocumentFile(NonnullOwnPtr<Core::File> file);
ErrorOr<void> initialize_internal_state();
void ensure_position_in_buffer(size_t position);
NonnullOwnPtr<Core::File> m_file;
size_t m_file_size;
Array<u8, 2048> m_buffer;
size_t m_buffer_file_pos;
};
class HexDocumentUndoCommand : public GUI::Command {
public:
HexDocumentUndoCommand(WeakPtr<HexDocument> document, size_t position);
virtual void undo() override;
virtual void redo() override;
virtual ByteString action_text() const override { return "Update cell"; }
virtual bool merge_with(GUI::Command const& other) override;
ErrorOr<void> try_add_changed_byte(u8 old_value, u8 new_value);
ErrorOr<void> try_add_changed_bytes(ByteBuffer old_values, ByteBuffer new_values);
private:
bool commit_time_expired() const { return MonotonicTime::now() - m_timestamp >= COMMAND_COMMIT_TIME; }
MonotonicTime m_timestamp = MonotonicTime::now();
WeakPtr<HexDocument> m_document;
size_t m_position;
ByteBuffer m_old;
ByteBuffer m_new;
};