RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-25 05:37:43 +00:00
Code Issues Activity Actions

HexEditor: Save and load annotations to/from JSON files

Browse source 
This is a fairly simple JSON format: A single array, containing objects,
with the Annotation fields as key:value pairs.

When reading a file, we let invalid or missing keys fall back to the
default values. This is mostly intended to set a pattern so that if we
add new fields in the future, we won't fail to load old annotations
files. If loading the file fails though, we keep the previously loaded
set of annotations.
This commit is contained in:
Sam Atkins 2024-01-30 12:33:36 +00:00 • committed by Sam Atkins
parent b2bb7d919d
commit 56caee44e3
4 changed files with 110 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

56
Userland/Applications/HexEditor/AnnotationsModel.cpp
View file

@ -5,6 +5,8 @@
*/
#include "AnnotationsModel.h"
#include <AK/JsonArray.h>
#include <AK/JsonObject.h>
GUI::Variant AnnotationsModel::data(GUI::ModelIndex const& index, GUI::ModelRole role) const
{
@ -66,3 +68,57 @@ Optional<Annotation&> AnnotationsModel::closest_annotation_at(size_t position)
return result;
}
ErrorOr<void> AnnotationsModel::save_to_file(Core::File& file) const
{
JsonArray array {};
array.ensure_capacity(m_annotations.size());
for (auto const& annotation : m_annotations) {
JsonObject object;
object.set("start_offset", annotation.start_offset);
object.set("end_offset", annotation.end_offset);
object.set("background_color", annotation.background_color.to_byte_string());
object.set("comments", annotation.comments.to_byte_string());
TRY(array.append(object));
}
auto json_string = array.to_byte_string();
TRY(file.write_until_depleted(json_string.bytes()));
return {};
}
ErrorOr<void> AnnotationsModel::load_from_file(Core::File& file)
{
auto json_bytes = TRY(file.read_until_eof());
StringView json_string { json_bytes };
auto json = TRY(JsonValue::from_string(json_string));
if (!json.is_array())
return Error::from_string_literal("Failed to read annotations from file: Not a JSON array.");
auto& json_array = json.as_array();
Vector<Annotation> new_annotations;
TRY(new_annotations.try_ensure_capacity(json_array.size()));
TRY(json_array.try_for_each([&](JsonValue const& json_value) -> ErrorOr<void> {
if (!json_value.is_object())
return Error::from_string_literal("Failed to read annotation from file: Annotation not a JSON object.");
auto& json_object = json_value.as_object();
Annotation annotation;
if (auto start_offset = json_object.get_u64("start_offset"sv); start_offset.has_value())
annotation.start_offset = start_offset.value();
if (auto end_offset = json_object.get_u64("end_offset"sv); end_offset.has_value())
annotation.end_offset = end_offset.value();
if (auto background_color = json_object.get_byte_string("background_color"sv).map([](auto& string) { return Color::from_string(string); }); background_color.has_value())
annotation.background_color = background_color->value();
if (auto comments = json_object.get_byte_string("comments"sv); comments.has_value())
annotation.comments = MUST(String::from_byte_string(comments.value()));
new_annotations.append(annotation);
return {};
}));
m_annotations = move(new_annotations);
invalidate();
return {};
}