Skip to content

Navigation fix #97

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

Merged
ABKQPO merged 3 commits into from
Oct 8, 2026
Merged

Navigation fix #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6175480
add composite key
ABKQPO Oct 7, 2026
b781733
strengthen the md check
ABKQPO Oct 7, 2026
2a3bca5
Spotless apply for branch navigation-fix for #97 (#98)
github-actions[bot] Oct 7, 2026
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
29 changes: 15 additions & 14 deletions src/main/java/com/hfstudio/guidenh/guide/internal/GuideScreen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
import java.time.format.DateTimeFormatter;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Deque;
import java.util.LinkedHashMap;
Expand Down Expand Up @@ -783,7 +782,9 @@ private void expandNavigationParentsToCurrentPage() {
if (!hasContentRoute()) {
return;
}
navBar.expandParentsTo(resolveNavigationTree(), currentAnchor.pageId(), bookmarkState);
ResourceLocation currentGuideId = currentRoute != null && currentRoute.isContent() ? currentRoute.guideId()
: guide != null ? guide.getId() : null;
navBar.expandParentsTo(resolveNavigationTree(), currentGuideId, currentAnchor.pageId(), bookmarkState);
}

private void applyPendingRestoreScroll() {
Expand Down Expand Up @@ -818,9 +819,9 @@ private void rememberNavigationState() {

private void updateSavedExpansionStates(List<ExpansionChange> changes, @Nullable ResourceLocation currentGuideId) {
Map<ResourceLocation, GuideNavBarState> savedStates = new LinkedHashMap<>();
Map<ResourceLocation, LinkedHashSet<ResourceLocation>> expandedPageIdsByGuide = new LinkedHashMap<>();
Map<ResourceLocation, LinkedHashSet<NavigationNode.Key>> expandedNodeKeysByGuide = new LinkedHashMap<>();
for (ExpansionChange change : changes) {
ResourceLocation guideId = change.guideId();
ResourceLocation guideId = change.guideId() != null ? change.guideId() : currentGuideId;
if (guideId == null && currentGuideId == null) {
continue;
}
Expand All @@ -829,14 +830,14 @@ private void updateSavedExpansionStates(List<ExpansionChange> changes, @Nullable
ignored -> ClientProxy.getLytHost()
.getNavigation()
.recallNavigationState(guideId));
LinkedHashSet<ResourceLocation> expandedPageIds = expandedPageIdsByGuide.computeIfAbsent(
LinkedHashSet<NavigationNode.Key> expandedNodeKeys = expandedNodeKeysByGuide.computeIfAbsent(
guideId,
ignored -> new LinkedHashSet<>(
saved.expandedPageIds() != null ? saved.expandedPageIds() : Collections.emptySet()));
ignored -> new LinkedHashSet<>(saved.expandedNodeKeys() != null ? saved.expandedNodeKeys() : Set.of()));
NavigationNode.Key key = new NavigationNode.Key(guideId, change.pageId());
if (change.expanded()) {
expandedPageIds.add(change.pageId());
expandedNodeKeys.add(key);
} else {
expandedPageIds.remove(change.pageId());
expandedNodeKeys.remove(key);
}
}
for (Map.Entry<ResourceLocation, GuideNavBarState> entry : savedStates.entrySet()) {
Expand All @@ -845,9 +846,9 @@ private void updateSavedExpansionStates(List<ExpansionChange> changes, @Nullable
.getNavigation()
.rememberNavBarState(
entry.getKey(),
GuideNavBarState.create(
GuideNavBarState.createExpandedNodes(
saved.bookmarkGroupExpanded(),
expandedPageIdsByGuide.get(entry.getKey()),
expandedNodeKeysByGuide.get(entry.getKey()),
saved.scrollY()));
}
}
Expand Down Expand Up @@ -2547,7 +2548,7 @@ private void navigateBackInHistory() {
.guideId() : null;
ResourceLocation oldGuideId = guide != null ? guide.getId() : null;
boolean guideChanged = !Objects.equals(oldGuideId, prevGuideId);
Set<ResourceLocation> carryOver = guideChanged ? navBar.getExpandedPageIdsSnapshot() : null;
Set<NavigationNode.Key> carryOver = guideChanged ? navBar.getExpandedNodeKeysSnapshot() : null;
restoreViewState(prev);
if (guideChanged) {
navBar.activateGuide(
Expand Down Expand Up @@ -2584,7 +2585,7 @@ private void navigateForwardInHistory() {
.guideId() : null;
ResourceLocation oldGuideId = guide != null ? guide.getId() : null;
boolean guideChanged = !Objects.equals(oldGuideId, nextGuideId);
Set<ResourceLocation> carryOver = guideChanged ? navBar.getExpandedPageIdsSnapshot() : null;
Set<NavigationNode.Key> carryOver = guideChanged ? navBar.getExpandedNodeKeysSnapshot() : null;
restoreViewState(next);
if (guideChanged) {
navBar.activateGuide(
Expand Down Expand Up @@ -6843,7 +6844,7 @@ public void navigateTo(ResourceLocation guideId, PageAnchor anchor) {
suppressGuideEditorTextFocusUntilGuideHotkeyRelease();
rememberCurrentContentStateIfEligible();
rememberNavigationState();
Set<ResourceLocation> carryOver = navBar.getExpandedPageIdsSnapshot();
Set<NavigationNode.Key> carryOver = navBar.getExpandedNodeKeysSnapshot();
restoreViewState(GuideScreenViewState.of(GuideScreenRoute.content(guideId, anchor), 0));
navBar.activateGuide(
guideId,
Expand Down
116 changes: 71 additions & 45 deletions src/main/java/com/hfstudio/guidenh/guide/internal/screen/GuideNavBar.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
Expand Down Expand Up @@ -168,7 +167,7 @@ public interface GuideExpansionListener {
public record ExpansionChange(@Nullable ResourceLocation guideId, ResourceLocation pageId, boolean expanded) {}

private final List<Row> rows = new ArrayList<>();
private final Set<ResourceLocation> expandedPageIds = new HashSet<>();
private final Set<NavigationNode.Key> expandedNodeKeys = new HashSet<>();
private final GuideNavProjection projection = new GuideNavProjection();
private final StickyStack stickyStack = new StickyStack();
@Nullable
Expand Down Expand Up @@ -270,16 +269,16 @@ public void update(int mouseX, int mouseY, @Nullable NavigationTree tree, GuideB
}

public GuideNavBarState captureState() {
return GuideNavBarState.create(bookmarkGroupExpanded, new LinkedHashSet<>(expandedPageIds), scrollY);
return GuideNavBarState
.createExpandedNodes(bookmarkGroupExpanded, new LinkedHashSet<>(expandedNodeKeys), scrollY);
}

public void restoreState(GuideNavBarState state, GuideBookmarkState bookmarkState) {
releaseScrollbar(0);
GuideNavBarState effectiveState = state != null ? state : GuideNavBarState.defaultState();
bookmarkGroupExpanded = effectiveState.bookmarkGroupExpanded();
expandedPageIds.clear();
expandedPageIds.addAll(
effectiveState.expandedPageIds() != null ? effectiveState.expandedPageIds() : Collections.emptySet());
expandedNodeKeys.clear();
expandedNodeKeys.addAll(resolveExpansionKeys(effectiveState.expandedNodeKeys(), lastTree));
expandedStateVersion++;
scrollY = effectiveState.scrollY();
visualScrollY.snapTo(scrollY);
Expand All @@ -290,25 +289,24 @@ public void restoreState(GuideNavBarState state, GuideBookmarkState bookmarkStat

/**
* Switch the nav bar to a different guide's expansion state.
* Replaces {@code expandedPageIds} with the saved state for the new guide,
* Replaces the expanded node keys with the saved state for the new guide,
* then expands ancestors of {@code currentPageId}.
* Caller is responsible for saving the old guide's state before calling this.
*/
public void activateGuide(@Nullable ResourceLocation guideId, GuideNavBarState savedState,
@Nullable NavigationTree tree, GuideBookmarkState bookmarkState, @Nullable ResourceLocation currentPageId,
Set<ResourceLocation> carryOverIds) {
Set<NavigationNode.Key> carryOverKeys) {

// 1. Replace with new guide's saved state
expandedPageIds.clear();
if (savedState.expandedPageIds() != null) {
expandedPageIds.addAll(savedState.expandedPageIds());
}

// 2. Merge carry-over IDs that exist in the new tree (captured before restoreViewState)
if (carryOverIds != null && tree != null) {
for (ResourceLocation id : carryOverIds) {
if (tree.getNodeById(id) != null) {
expandedPageIds.add(id);
expandedNodeKeys.clear();
expandedNodeKeys.addAll(resolveExpansionKeys(savedState.expandedNodeKeys(), tree));

// 2. Merge carry-over expansions that exist in the new tree.
if (carryOverKeys != null && tree != null) {
for (NavigationNode.Key key : carryOverKeys) {
NavigationNode node = tree.getNodeById(guideId, key.pageId());
if (node != null && node.key() != null) {
expandedNodeKeys.add(node.key());
}
}
}
Expand All @@ -324,12 +322,12 @@ public void activateGuide(@Nullable ResourceLocation guideId, GuideNavBarState s

// 3. Expand ancestors of current page (inline, single rebuild at end)
if (currentPageId != null && tree != null) {
var path = tree.getPathTo(currentPageId);
var path = tree.getPathTo(guideId, currentPageId);
for (int i = 0; i < path.size() - 1; i++) {
ResourceLocation parentId = path.get(i)
.pageId();
if (parentId != null) {
expandedPageIds.add(parentId);
NavigationNode.Key parentKey = path.get(i)
.key();
if (parentKey != null) {
expandedNodeKeys.add(parentKey);
}
}
}
Expand All @@ -341,24 +339,42 @@ public void activateGuide(@Nullable ResourceLocation guideId, GuideNavBarState s
}
}

/** Snapshot of current expanded page IDs for carry-over before navigation. */
public Set<ResourceLocation> getExpandedPageIdsSnapshot() {
return new HashSet<>(expandedPageIds);
/** Snapshot of current expanded node keys for carry-over before navigation. */
public Set<NavigationNode.Key> getExpandedNodeKeysSnapshot() {
return new HashSet<>(expandedNodeKeys);
}

public void expandParentsTo(@Nullable NavigationTree tree, @Nullable ResourceLocation pageId,
GuideBookmarkState bookmarkState) {
private Set<NavigationNode.Key> resolveExpansionKeys(Set<NavigationNode.Key> keys, @Nullable NavigationTree tree) {
if (keys == null || keys.isEmpty() || tree == null) {
return keys == null ? Set.of() : new HashSet<>(keys);
}
Set<NavigationNode.Key> resolved = new HashSet<>();
for (NavigationNode.Key key : keys) {
if (key == null) {
continue;
}
NavigationNode node = key.guideId() == null ? tree.getNodeById(key.pageId())
: tree.getNodeById(key.guideId(), key.pageId());
if (node != null && node.key() != null) {
resolved.add(node.key());
}
}
return resolved;
}

public void expandParentsTo(@Nullable NavigationTree tree, @Nullable ResourceLocation guideId,
@Nullable ResourceLocation pageId, GuideBookmarkState bookmarkState) {
if (tree == null || pageId == null) {
return;
}

var path = tree.getPathTo(pageId);
var path = tree.getPathTo(guideId, pageId);
boolean changed = false;
for (int index = 0; index < path.size() - 1; index++) {
ResourceLocation parentPageId = path.get(index)
.pageId();
if (parentPageId != null) {
changed |= expandedPageIds.add(parentPageId);
NavigationNode.Key parentKey = path.get(index)
.key();
if (parentKey != null) {
changed |= expandedNodeKeys.add(parentKey);
}
}
if (changed) {
Expand Down Expand Up @@ -404,7 +420,7 @@ private void rebuildRows(@Nullable NavigationTree tree, GuideBookmarkState bookm
return;
}
GuideNavProjection.ProjectionResult projected = projection
.project(tree, bookmarkState, expandedPageIds, bookmarkGroupExpanded);
.project(tree, bookmarkState, expandedNodeKeys, bookmarkGroupExpanded);
projected = projection.withTemplates(projected, templateRows, templateGroupExpanded);
for (GuideNavProjection.ProjectedRow projectedRow : projected.rows()) {
rows.add(new Row(projectedRow));
Expand Down Expand Up @@ -900,7 +916,8 @@ private boolean isCollapsed(Row row) {
}

private boolean isExpanded(Row row) {
return row.pageId() != null && expandedPageIds.contains(row.pageId());
NavigationNode.Key key = row.navigationKey();
return key != null && expandedNodeKeys.contains(key);
}

private void toggleExpand(Row row, GuideBookmarkState bookmarkState) {
Expand All @@ -918,25 +935,29 @@ private void toggleExpand(Row row, GuideBookmarkState bookmarkState) {
if (lastTree == null || pageId == null) {
return;
}
NavigationNode node = lastTree.getNodeById(pageId);
NavigationNode node = lastTree.getNodeById(row.guideId(), pageId);
if (node == null) {
return;
}
updateExpansionState(List.of(node), !expandedPageIds.contains(pageId), bookmarkState);
NavigationNode.Key key = node.key();
updateExpansionState(List.of(node), key == null || !expandedNodeKeys.contains(key), bookmarkState);
}

private void toggleExpandedDescendants(Row row, GuideBookmarkState bookmarkState) {
ResourceLocation pageId = row.pageId();
if (lastTree == null || pageId == null) {
return;
}
NavigationNode node = lastTree.getNodeById(pageId);
NavigationNode node = lastTree.getNodeById(row.guideId(), pageId);
if (node == null) {
return;
}
List<NavigationNode> nodes = collectExpandableNodes(node);
boolean allExpanded = !nodes.isEmpty() && nodes.stream()
.allMatch(expandableNode -> expandedPageIds.contains(expandableNode.pageId()));
.allMatch(expandableNode -> {
NavigationNode.Key key = expandableNode.key();
return key != null && expandedNodeKeys.contains(key);
});
updateExpansionState(nodes, !allExpanded, bookmarkState);
}

Expand Down Expand Up @@ -977,20 +998,20 @@ private void updateExpansionState(List<NavigationNode> nodes, boolean expanded,
private void updateExpansionState(List<NavigationNode> nodes, boolean expanded, GuideBookmarkState bookmarkState,
boolean allCollapsed) {
List<ExpansionChange> changes = new ArrayList<>();
boolean changed = allCollapsed && !expandedPageIds.isEmpty();
boolean changed = allCollapsed && !expandedNodeKeys.isEmpty();
for (NavigationNode node : nodes) {
ResourceLocation pageId = node.pageId();
if (pageId == null) {
NavigationNode.Key key = node.key();
if (key == null) {
continue;
}
boolean nodeChanged = expanded ? expandedPageIds.add(pageId) : expandedPageIds.remove(pageId);
boolean nodeChanged = expanded ? expandedNodeKeys.add(key) : expandedNodeKeys.remove(key);
changed |= nodeChanged;
if (nodeChanged) {
changes.add(new ExpansionChange(node.guideId(), pageId, expanded));
changes.add(new ExpansionChange(key.guideId(), key.pageId(), expanded));
}
}
if (allCollapsed) {
expandedPageIds.clear();
expandedNodeKeys.clear();
}
if (!changed) {
return;
Expand Down Expand Up @@ -1378,6 +1399,11 @@ public ResourceLocation pageId() {
return pageId;
}

@Nullable
public NavigationNode.Key navigationKey() {
return pageId != null ? new NavigationNode.Key(guideId, pageId) : null;
}

public GuideNavProjection.RowKind kind() {
return displayRow.kind();
}
Expand Down
Loading