Skip to content

Make external modded pattern file reload work. Make ext-modded data reload safe. #2457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

Make external modded pattern file reload work. Make ext-modded data reload safe. #2457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
6e19ad4
Initial fix attempt
shewitt-au Sep 25, 2025
3f0ad9f
Make pattern file reload work. Make file provider reload safe
shewitt-au Sep 25, 2025
8998218
Fix formatting
shewitt-au Sep 25, 2025
382cfd1
Fix formatting
shewitt-au Sep 25, 2025
193d4be
Merge branch 'reload_fixes' of https://github.com/shewitt-au/SteveImH…
shewitt-au Sep 25, 2025
99b7452
Fix formatting
shewitt-au Sep 25, 2025
5ecfae9
Merge branch 'reload_fixes' of https://github.com/shewitt-au/SteveImH…
shewitt-au Sep 25, 2025
a76eae2
build: Updated libwolv
WerWolv Sep 25, 2025
3eacdc7
Initial fix attempt
shewitt-au Sep 25, 2025
70fd54f
Make pattern file reload work. Make file provider reload safe
shewitt-au Sep 25, 2025
fdace6f
Fix formatting
shewitt-au Sep 25, 2025
8bb2423
Merge branch 'reload_fixes' of https://github.com/shewitt-au/SteveImH…
shewitt-au Sep 25, 2025
6e6188c
Fix formatting
shewitt-au Sep 25, 2025
4ebec70
Fix formatting
shewitt-au Sep 25, 2025
931a8b3
Merge
shewitt-au Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/external/libwolv
Open in desktop
Submodule libwolv updated 5 files
+20 −5 libs/io/include/wolv/io/file.hpp
+29 −8 libs/io/source/io/file.cpp
+16 −6 libs/io/source/io/file_unix.cpp
+4 −3 libs/io/source/io/file_win.cpp
+2 −0 libs/utils/lib/jthread/includes/jthread.hpp
1 change: 1 addition & 0 deletions plugins/builtin/include/content/providers/file_provider.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ namespace hex::plugin::builtin {
void convertToDirectAccess();

private:
void fileChangedCallback();
void handleFileChange();

bool open(bool memoryMapped);
Expand Down
3 changes: 2 additions & 1 deletion plugins/builtin/include/content/views/view_pattern_editor.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,8 @@ namespace hex::plugin::builtin {
void registerMenuItems();
void registerHandlers();

void handleFileChange(prv::Provider *provider);
void fileChangedCallback(prv::Provider *provider, const std::fs::path &path);
void handleFileChange(prv::Provider *provider, const std::fs::path &path);

void openPatternFile(bool trackFile);
void savePatternToCurrentFile(bool trackFile);
Expand Down
10 changes: 9 additions & 1 deletion plugins/builtin/source/content/providers/file_provider.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ namespace hex::plugin::builtin {
m_data = m_file.readVectorAtomic(0x00, m_fileSize);
if (!m_data.empty()) {
m_changeTracker = wolv::io::ChangeTracker(m_file);
m_changeTracker.startTracking([this]{ this->handleFileChange(); });
m_changeTracker.startTracking([this]{ this->fileChangedCallback(); });
m_file.close();
m_loadedIntoMemory = true;
}
Expand Down Expand Up @@ -359,6 +359,14 @@ namespace hex::plugin::builtin {
this->open(true);
}

// WARNING: this function is called from the context of a worker thread!
void FileProvider::fileChangedCallback() {
// Arrange for a call from the UI thread
TaskManager::doLater(
[this]{this->handleFileChange();}
);
}

void FileProvider::handleFileChange() {
if (m_ignoreNextChangeEvent) {
m_ignoreNextChangeEvent = false;
Expand Down
19 changes: 14 additions & 5 deletions plugins/builtin/source/content/views/view_pattern_editor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1593,7 +1593,7 @@ namespace hex::plugin::builtin {
m_sourceCode.get(provider) = code;
if (trackFile) {
m_changeTracker.get(provider) = wolv::io::ChangeTracker(file);
m_changeTracker.get(provider).startTracking([this, provider]{ this->handleFileChange(provider); });
m_changeTracker.get(provider).startTracking([this, provider, path]{ this->fileChangedCallback(provider, path); });
}
m_textHighlighter.m_needsToUpdateColors = false;
TaskManager::createBackgroundTask("hex.builtin.task.parsing_pattern", [this, code, provider](auto&) { this->parsePattern(code, provider); });
Expand Down Expand Up @@ -2510,7 +2510,15 @@ namespace hex::plugin::builtin {
});
}

void ViewPatternEditor::handleFileChange(prv::Provider *provider) {
// WARNING: this function is called from the context of a worker thread!
void ViewPatternEditor::fileChangedCallback(prv::Provider *provider, const std::fs::path &path) {
// Arrange for a call from the UI thread
TaskManager::doLater(
[this, provider, path]{this->handleFileChange(provider, path);}
);
}

void ViewPatternEditor::handleFileChange(prv::Provider *provider, const std::fs::path &path) {
if (m_ignoreNextChangeEvent.get(provider)) {
m_ignoreNextChangeEvent.get(provider) = false;
return;
Expand All @@ -2521,9 +2529,10 @@ namespace hex::plugin::builtin {
}

m_changeEventAcknowledgementPending.get(provider) = true;
hex::ui::BannerButton::open(ICON_VS_INFO, "hex.builtin.provider.file.reload_changes", ImColor(66, 104, 135), "hex.builtin.provider.file.reload_changes.reload", [this, provider] {
m_changeEventAcknowledgementPending.get(provider) = false;
hex::ui::BannerButton::open(ICON_VS_INFO, "hex.builtin.provider.file.reload_changes", ImColor(66, 104, 135), "hex.builtin.provider.file.reload_changes.reload", [this, provider, path] {
loadPatternFile(path, provider, true);
});
m_changeEventAcknowledgementPending.get(provider) = false;
}

void ViewPatternEditor::openPatternFile(bool trackFile) {
Expand Down Expand Up @@ -2593,7 +2602,7 @@ namespace hex::plugin::builtin {

if (trackFile) {
m_changeTracker.get(provider) = wolv::io::ChangeTracker(file);
m_changeTracker.get(provider).startTracking([this, provider]{ this->handleFileChange(provider); });
m_changeTracker.get(provider).startTracking([this, provider, path]{ this->fileChangedCallback(provider, path); });
m_ignoreNextChangeEvent.get(provider) = true;
}
}
Expand Down