## Summary
* Definition and use of a central LOG function, that can later be
extended or completely be removed (for public use where debugging
information may not be required) to save flash by suppressing the
-DENABLE_SERIAL_LOG like in the slim branch
* **What changes are included?**
## Additional Context
* By using the central logger the usual:
```
#include <HardwareSerial.h>
...
Serial.printf("[%lu] [WCS] Obfuscating/deobfuscating %zu bytes\n", millis(), data.size());
```
would then become
```
#include <Logging.h>
...
LOG_DBG("WCS", "Obfuscating/deobfuscating %zu bytes", data.size());
```
You do have ``LOG_DBG`` for debug messages, ``LOG_ERR`` for error
messages and ``LOG_INF`` for informational messages. Depending on the
verbosity level defined (see below) soe of these message types will be
suppressed/not-compiled.
* The normal compilation (default) will create a firmware.elf file of
42.194.356 bytes, the same code via slim will create 42.024.048 bytes -
170.308 bytes less
* Firmware.bin : 6.469.984 bytes for default, 6.418.672 bytes for slim -
51.312 bytes less
### AI Usage
While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.
Did you use AI tools to help write this code? _NO_
---------
Co-authored-by: Xuan Son Nguyen <son@huggingface.co>
186 lines
5.1 KiB
C++
186 lines
5.1 KiB
C++
#include "TocNavParser.h"
|
|
|
|
#include <FsHelpers.h>
|
|
#include <Logging.h>
|
|
|
|
#include "../BookMetadataCache.h"
|
|
|
|
bool TocNavParser::setup() {
|
|
parser = XML_ParserCreate(nullptr);
|
|
if (!parser) {
|
|
LOG_DBG("NAV", "Couldn't allocate memory for parser");
|
|
return false;
|
|
}
|
|
|
|
XML_SetUserData(parser, this);
|
|
XML_SetElementHandler(parser, startElement, endElement);
|
|
XML_SetCharacterDataHandler(parser, characterData);
|
|
return true;
|
|
}
|
|
|
|
TocNavParser::~TocNavParser() {
|
|
if (parser) {
|
|
XML_StopParser(parser, XML_FALSE);
|
|
XML_SetElementHandler(parser, nullptr, nullptr);
|
|
XML_SetCharacterDataHandler(parser, nullptr);
|
|
XML_ParserFree(parser);
|
|
parser = nullptr;
|
|
}
|
|
}
|
|
|
|
size_t TocNavParser::write(const uint8_t data) { return write(&data, 1); }
|
|
|
|
size_t TocNavParser::write(const uint8_t* buffer, const size_t size) {
|
|
if (!parser) return 0;
|
|
|
|
const uint8_t* currentBufferPos = buffer;
|
|
auto remainingInBuffer = size;
|
|
|
|
while (remainingInBuffer > 0) {
|
|
void* const buf = XML_GetBuffer(parser, 1024);
|
|
if (!buf) {
|
|
LOG_DBG("NAV", "Couldn't allocate memory for buffer");
|
|
XML_StopParser(parser, XML_FALSE);
|
|
XML_SetElementHandler(parser, nullptr, nullptr);
|
|
XML_SetCharacterDataHandler(parser, nullptr);
|
|
XML_ParserFree(parser);
|
|
parser = nullptr;
|
|
return 0;
|
|
}
|
|
|
|
const auto toRead = remainingInBuffer < 1024 ? remainingInBuffer : 1024;
|
|
memcpy(buf, currentBufferPos, toRead);
|
|
|
|
if (XML_ParseBuffer(parser, static_cast<int>(toRead), remainingSize == toRead) == XML_STATUS_ERROR) {
|
|
LOG_DBG("NAV", "Parse error at line %lu: %s", XML_GetCurrentLineNumber(parser),
|
|
XML_ErrorString(XML_GetErrorCode(parser)));
|
|
XML_StopParser(parser, XML_FALSE);
|
|
XML_SetElementHandler(parser, nullptr, nullptr);
|
|
XML_SetCharacterDataHandler(parser, nullptr);
|
|
XML_ParserFree(parser);
|
|
parser = nullptr;
|
|
return 0;
|
|
}
|
|
|
|
currentBufferPos += toRead;
|
|
remainingInBuffer -= toRead;
|
|
remainingSize -= toRead;
|
|
}
|
|
return size;
|
|
}
|
|
|
|
void XMLCALL TocNavParser::startElement(void* userData, const XML_Char* name, const XML_Char** atts) {
|
|
auto* self = static_cast<TocNavParser*>(userData);
|
|
|
|
// Track HTML structure loosely - we mainly care about finding <nav epub:type="toc">
|
|
if (strcmp(name, "html") == 0) {
|
|
self->state = IN_HTML;
|
|
return;
|
|
}
|
|
|
|
if (self->state == IN_HTML && strcmp(name, "body") == 0) {
|
|
self->state = IN_BODY;
|
|
return;
|
|
}
|
|
|
|
// Look for <nav epub:type="toc"> anywhere in body (or nested elements)
|
|
if (self->state >= IN_BODY && strcmp(name, "nav") == 0) {
|
|
for (int i = 0; atts[i]; i += 2) {
|
|
if ((strcmp(atts[i], "epub:type") == 0 || strcmp(atts[i], "type") == 0) && strcmp(atts[i + 1], "toc") == 0) {
|
|
self->state = IN_NAV_TOC;
|
|
LOG_DBG("NAV", "Found nav toc element");
|
|
return;
|
|
}
|
|
}
|
|
return;
|
|
}
|
|
|
|
// Only process ol/li/a if we're inside the toc nav
|
|
if (self->state < IN_NAV_TOC) {
|
|
return;
|
|
}
|
|
|
|
if (strcmp(name, "ol") == 0) {
|
|
self->olDepth++;
|
|
self->state = IN_OL;
|
|
return;
|
|
}
|
|
|
|
if (self->state == IN_OL && strcmp(name, "li") == 0) {
|
|
self->state = IN_LI;
|
|
self->currentLabel.clear();
|
|
self->currentHref.clear();
|
|
return;
|
|
}
|
|
|
|
if (self->state == IN_LI && strcmp(name, "a") == 0) {
|
|
self->state = IN_ANCHOR;
|
|
// Get href attribute
|
|
for (int i = 0; atts[i]; i += 2) {
|
|
if (strcmp(atts[i], "href") == 0) {
|
|
self->currentHref = atts[i + 1];
|
|
break;
|
|
}
|
|
}
|
|
return;
|
|
}
|
|
}
|
|
|
|
void XMLCALL TocNavParser::characterData(void* userData, const XML_Char* s, const int len) {
|
|
auto* self = static_cast<TocNavParser*>(userData);
|
|
|
|
// Only collect text when inside an anchor within the TOC nav
|
|
if (self->state == IN_ANCHOR) {
|
|
self->currentLabel.append(s, len);
|
|
}
|
|
}
|
|
|
|
void XMLCALL TocNavParser::endElement(void* userData, const XML_Char* name) {
|
|
auto* self = static_cast<TocNavParser*>(userData);
|
|
|
|
if (strcmp(name, "a") == 0 && self->state == IN_ANCHOR) {
|
|
// Create TOC entry when closing anchor tag (we have all data now)
|
|
if (!self->currentLabel.empty() && !self->currentHref.empty()) {
|
|
std::string href = FsHelpers::normalisePath(self->baseContentPath + self->currentHref);
|
|
std::string anchor;
|
|
|
|
const size_t pos = href.find('#');
|
|
if (pos != std::string::npos) {
|
|
anchor = href.substr(pos + 1);
|
|
href = href.substr(0, pos);
|
|
}
|
|
|
|
if (self->cache) {
|
|
// olDepth gives us the nesting level (1-based from the outer ol)
|
|
self->cache->createTocEntry(self->currentLabel, href, anchor, self->olDepth);
|
|
}
|
|
|
|
self->currentLabel.clear();
|
|
self->currentHref.clear();
|
|
}
|
|
self->state = IN_LI;
|
|
return;
|
|
}
|
|
|
|
if (strcmp(name, "li") == 0 && (self->state == IN_LI || self->state == IN_OL)) {
|
|
self->state = IN_OL;
|
|
return;
|
|
}
|
|
|
|
if (strcmp(name, "ol") == 0 && self->state >= IN_NAV_TOC) {
|
|
self->olDepth--;
|
|
if (self->olDepth == 0) {
|
|
self->state = IN_NAV_TOC;
|
|
} else {
|
|
self->state = IN_LI; // Back to parent li
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (strcmp(name, "nav") == 0 && self->state >= IN_NAV_TOC) {
|
|
self->state = IN_BODY;
|
|
LOG_DBG("NAV", "Finished parsing nav toc");
|
|
return;
|
|
}
|
|
}
|