Uri Tauber
8fbb37b359
## Summary: Enable footnote anchor navigation in EPUB reader This PR extracts the core anchor-to-page mapping mechanism from PR #1143 (TOC fragment navigation) to provide immediate footnote navigation support. By merging this focused subset first, users get a complete footnote experience now while simplifying the eventual review and merge of the full #1143 PR. --- ## What this extracts from PR #1143 PR #1143 implements comprehensive TOC fragment navigation for EPUBs with multi-chapter spine files. This PR takes only the anchor resolution infrastructure: - Anchor-to-page mapping in section cache: During page layout, ChapterHtmlSlimParser records which page each HTML id attribute lands on, serializing the map into the .bin cache file. - Anchor resolution in `EpubReaderActivity`: When navigating to a footnote link with a fragment (e.g., `chapter2.xhtml#note1`), the reader resolves the anchor to a page number and jumps directly to it. - Section file format change: Bumped to version 15, adds anchor map offset in header. --- ## Simplified scope vs. PR #1143 To minimize conflicts and complexity, this PR differs from #1143 in key ways: * **Anchors tracked** * **Origin:** Only TOC anchors (passed via `std::set`) * **This branch:** All `id` attributes * **Page breaks** * **Origin**: Forces new page at TOC chapter boundaries * **This branch:** None — natural flow * **TOC integration** * **Origin**: `tocBoundaries`, `getTocIndexForPage()`, chapter skip * **This branch:** None — just footnote links * **Bug fix** * **This branch:** Fixed anchor page off-by-1/2 bug The anchor recording bug (recording page number before `makePages()` flushes previous block) was identified and fixed during this extraction. The fix uses a deferred `pendingAnchorId` pattern that records the anchor after page completion. --- ## Positioning for future merge Changes are structured to minimize conflicts when #1143 eventually merges: - `ChapterHtmlSlimParser.cpp` `startElement()`: Both branches rewrite the same if `(!idAttr.empty())` block. The merged version will combine both approaches (TOC anchors get page breaks + immediate recording; footnote anchors get deferred recording). - `EpubReaderActivity.cpp` `render()`: The `pendingAnchor` resolution block is positioned at the exact same insertion point where #1143 places its `pendingTocIndex` block (line 596, right after `nextPageNumber` assignment). During merge, both blocks will sit side-by-side. --- ## Why merge separately? 1. Immediate user value: Footnote navigation works now without waiting for the full TOC overhaul 2. Easier review: ~100 lines vs. 500+ lines in #1143 3. Bug fix included: The page recording bug is fixed here and will carry into #1143 4. Minimal conflicts: Structured for clean merge — both PRs touch the same files but in complementary ways --- ### AI Usage Did you use AI tools to help write this code? _**< YES >**_ Done by Claude Opus 4.6
65 lines
2.5 KiB
C++
65 lines
2.5 KiB
C++
#pragma once
|
|
#include <Epub.h>
|
|
#include <Epub/FootnoteEntry.h>
|
|
#include <Epub/Section.h>
|
|
|
|
#include "EpubReaderMenuActivity.h"
|
|
#include "activities/Activity.h"
|
|
|
|
class EpubReaderActivity final : public Activity {
|
|
std::shared_ptr<Epub> epub;
|
|
std::unique_ptr<Section> section = nullptr;
|
|
int currentSpineIndex = 0;
|
|
int nextPageNumber = 0;
|
|
// Set when navigating to a footnote href with a fragment (e.g. #note1).
|
|
// Cleared on the next render after the new section loads and resolves it to a page.
|
|
std::string pendingAnchor;
|
|
int pagesUntilFullRefresh = 0;
|
|
int cachedSpineIndex = 0;
|
|
int cachedChapterTotalPageCount = 0;
|
|
unsigned long lastPageTurnTime = 0UL;
|
|
unsigned long pageTurnDuration = 0UL;
|
|
// Signals that the next render should reposition within the newly loaded section
|
|
// based on a cross-book percentage jump.
|
|
bool pendingPercentJump = false;
|
|
// Normalized 0.0-1.0 progress within the target spine item, computed from book percentage.
|
|
float pendingSpineProgress = 0.0f;
|
|
bool pendingScreenshot = false;
|
|
bool skipNextButtonCheck = false; // Skip button processing for one frame after subactivity exit
|
|
bool automaticPageTurnActive = false;
|
|
|
|
// Footnote support
|
|
std::vector<FootnoteEntry> currentPageFootnotes;
|
|
struct SavedPosition {
|
|
int spineIndex;
|
|
int pageNumber;
|
|
};
|
|
static constexpr int MAX_FOOTNOTE_DEPTH = 3;
|
|
SavedPosition savedPositions[MAX_FOOTNOTE_DEPTH] = {};
|
|
int footnoteDepth = 0;
|
|
|
|
void renderContents(std::unique_ptr<Page> page, int orientedMarginTop, int orientedMarginRight,
|
|
int orientedMarginBottom, int orientedMarginLeft);
|
|
void renderStatusBar() const;
|
|
void saveProgress(int spineIndex, int currentPage, int pageCount);
|
|
// Jump to a percentage of the book (0-100), mapping it to spine and page.
|
|
void jumpToPercent(int percent);
|
|
void onReaderMenuConfirm(EpubReaderMenuActivity::MenuAction action);
|
|
void applyOrientation(uint8_t orientation);
|
|
void toggleAutoPageTurn(uint8_t selectedPageTurnOption);
|
|
void pageTurn(bool isForwardTurn);
|
|
|
|
// Footnote navigation
|
|
void navigateToHref(const std::string& href, bool savePosition = false);
|
|
void restoreSavedPosition();
|
|
|
|
public:
|
|
explicit EpubReaderActivity(GfxRenderer& renderer, MappedInputManager& mappedInput, std::unique_ptr<Epub> epub)
|
|
: Activity("EpubReader", renderer, mappedInput), epub(std::move(epub)) {}
|
|
void onEnter() override;
|
|
void onExit() override;
|
|
void loop() override;
|
|
void render(RenderLock&& lock) override;
|
|
bool isReaderActivity() const override { return true; }
|
|
};
|