2025-12-03 22:00:29 +11:00
|
|
|
#pragma once
|
2025-12-28 13:59:44 +09:00
|
|
|
#include <functional>
|
2025-12-12 22:13:34 +11:00
|
|
|
#include <memory>
|
feat: footnote anchor navigation (#1245)
## 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
2026-03-06 20:10:45 +02:00
|
|
|
#include <optional>
|
|
|
|
|
#include <string>
|
2025-12-12 22:13:34 +11:00
|
|
|
|
2025-12-03 22:00:29 +11:00
|
|
|
#include "Epub.h"
|
|
|
|
|
|
|
|
|
|
class Page;
|
2025-12-08 22:06:09 +11:00
|
|
|
class GfxRenderer;
|
2025-12-03 22:00:29 +11:00
|
|
|
|
|
|
|
|
class Section {
|
2025-12-12 22:13:34 +11:00
|
|
|
std::shared_ptr<Epub> epub;
|
2025-12-03 22:00:29 +11:00
|
|
|
const int spineIndex;
|
2025-12-08 22:06:09 +11:00
|
|
|
GfxRenderer& renderer;
|
2025-12-29 12:19:54 +10:00
|
|
|
std::string filePath;
|
2025-12-30 15:09:30 +10:00
|
|
|
FsFile file;
|
2025-12-03 22:00:29 +11:00
|
|
|
|
2026-01-02 01:21:48 -06:00
|
|
|
void writeSectionFileHeader(int fontId, float lineCompression, bool extraParagraphSpacing, uint8_t paragraphAlignment,
|
2026-02-06 02:49:04 -05:00
|
|
|
uint16_t viewportWidth, uint16_t viewportHeight, bool hyphenationEnabled,
|
2026-03-03 16:59:06 +01:00
|
|
|
bool embeddedStyle, uint8_t imageRendering);
|
2025-12-30 15:09:30 +10:00
|
|
|
uint32_t onPageComplete(std::unique_ptr<Page> page);
|
2025-12-03 22:00:29 +11:00
|
|
|
|
|
|
|
|
public:
|
2025-12-31 12:11:36 +10:00
|
|
|
uint16_t pageCount = 0;
|
2025-12-03 22:00:29 +11:00
|
|
|
int currentPage = 0;
|
|
|
|
|
|
2025-12-12 22:13:34 +11:00
|
|
|
explicit Section(const std::shared_ptr<Epub>& epub, const int spineIndex, GfxRenderer& renderer)
|
2025-12-21 15:43:53 +11:00
|
|
|
: epub(epub),
|
|
|
|
|
spineIndex(spineIndex),
|
|
|
|
|
renderer(renderer),
|
2025-12-29 12:19:54 +10:00
|
|
|
filePath(epub->getCachePath() + "/sections/" + std::to_string(spineIndex) + ".bin") {}
|
2025-12-03 22:00:29 +11:00
|
|
|
~Section() = default;
|
2026-01-02 01:21:48 -06:00
|
|
|
bool loadSectionFile(int fontId, float lineCompression, bool extraParagraphSpacing, uint8_t paragraphAlignment,
|
2026-03-03 16:59:06 +01:00
|
|
|
uint16_t viewportWidth, uint16_t viewportHeight, bool hyphenationEnabled, bool embeddedStyle,
|
|
|
|
|
uint8_t imageRendering);
|
2025-12-12 22:13:34 +11:00
|
|
|
bool clearCache() const;
|
2026-01-02 01:21:48 -06:00
|
|
|
bool createSectionFile(int fontId, float lineCompression, bool extraParagraphSpacing, uint8_t paragraphAlignment,
|
2026-02-06 02:49:04 -05:00
|
|
|
uint16_t viewportWidth, uint16_t viewportHeight, bool hyphenationEnabled, bool embeddedStyle,
|
2026-03-03 16:59:06 +01:00
|
|
|
uint8_t imageRendering, const std::function<void()>& popupFn = nullptr);
|
2025-12-29 12:19:54 +10:00
|
|
|
std::unique_ptr<Page> loadPageFromSectionFile();
|
feat: footnote anchor navigation (#1245)
## 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
2026-03-06 20:10:45 +02:00
|
|
|
|
|
|
|
|
// Look up the page number for an anchor id from the section cache file.
|
|
|
|
|
std::optional<uint16_t> getPageForAnchor(const std::string& anchor) const;
|
2025-12-03 22:00:29 +11:00
|
|
|
};
|