mirror of
https://github.com/daveallie/crosspoint-reader.git
synced 2026-02-07 16:17:38 +03:00
f89ce514c8
Closes #712 ## Summary **What is the goal of this PR?** - To add new settings for toggling on/off embedded CSS styles in the reader. This gives more control and customization to the user over how the ereader experience looks. **What changes are included?** - Added new "Embedded Style" option to the Reader settings - Added new "Book's Style" option for "Paragraph Alignment" - User's selected "Paragraph Alignment" will take precedence and override the embedded CSS `text-align` property, _unless_ the user has "Book's Style" set as their "Paragraph Alignment" ## Additional Context  https://github.com/user-attachments/assets/9e404b13-c7e0-41c7-9406-4715f389166a Addresses feedback from the community about the new CSS feature: https://github.com/crosspoint-reader/crosspoint-reader/pull/700 --- ### 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? _**YES**_, Claude Code
349 lines
13 KiB
C++
349 lines
13 KiB
C++
#include "CrossPointSettings.h"
|
|
|
|
#include <HardwareSerial.h>
|
|
#include <SDCardManager.h>
|
|
#include <Serialization.h>
|
|
|
|
#include <cstring>
|
|
|
|
#include "fontIds.h"
|
|
|
|
// Initialize the static instance
|
|
CrossPointSettings CrossPointSettings::instance;
|
|
|
|
void readAndValidate(FsFile& file, uint8_t& member, const uint8_t maxValue) {
|
|
uint8_t tempValue;
|
|
serialization::readPod(file, tempValue);
|
|
if (tempValue < maxValue) {
|
|
member = tempValue;
|
|
}
|
|
}
|
|
|
|
namespace {
|
|
constexpr uint8_t SETTINGS_FILE_VERSION = 1;
|
|
// Increment this when adding new persisted settings fields
|
|
constexpr uint8_t SETTINGS_COUNT = 30;
|
|
constexpr char SETTINGS_FILE[] = "/.crosspoint/settings.bin";
|
|
|
|
// Validate front button mapping to ensure each hardware button is unique.
|
|
// If duplicates are detected, reset to the default physical order to prevent invalid mappings.
|
|
void validateFrontButtonMapping(CrossPointSettings& settings) {
|
|
// Snapshot the logical->hardware mapping so we can compare for duplicates.
|
|
const uint8_t mapping[] = {settings.frontButtonBack, settings.frontButtonConfirm, settings.frontButtonLeft,
|
|
settings.frontButtonRight};
|
|
for (size_t i = 0; i < 4; i++) {
|
|
for (size_t j = i + 1; j < 4; j++) {
|
|
if (mapping[i] == mapping[j]) {
|
|
// Duplicate detected: restore the default physical order (Back, Confirm, Left, Right).
|
|
settings.frontButtonBack = CrossPointSettings::FRONT_HW_BACK;
|
|
settings.frontButtonConfirm = CrossPointSettings::FRONT_HW_CONFIRM;
|
|
settings.frontButtonLeft = CrossPointSettings::FRONT_HW_LEFT;
|
|
settings.frontButtonRight = CrossPointSettings::FRONT_HW_RIGHT;
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Convert legacy front button layout into explicit logical->hardware mapping.
|
|
void applyLegacyFrontButtonLayout(CrossPointSettings& settings) {
|
|
switch (static_cast<CrossPointSettings::FRONT_BUTTON_LAYOUT>(settings.frontButtonLayout)) {
|
|
case CrossPointSettings::LEFT_RIGHT_BACK_CONFIRM:
|
|
settings.frontButtonBack = CrossPointSettings::FRONT_HW_LEFT;
|
|
settings.frontButtonConfirm = CrossPointSettings::FRONT_HW_RIGHT;
|
|
settings.frontButtonLeft = CrossPointSettings::FRONT_HW_BACK;
|
|
settings.frontButtonRight = CrossPointSettings::FRONT_HW_CONFIRM;
|
|
break;
|
|
case CrossPointSettings::LEFT_BACK_CONFIRM_RIGHT:
|
|
settings.frontButtonBack = CrossPointSettings::FRONT_HW_CONFIRM;
|
|
settings.frontButtonConfirm = CrossPointSettings::FRONT_HW_LEFT;
|
|
settings.frontButtonLeft = CrossPointSettings::FRONT_HW_BACK;
|
|
settings.frontButtonRight = CrossPointSettings::FRONT_HW_RIGHT;
|
|
break;
|
|
case CrossPointSettings::BACK_CONFIRM_RIGHT_LEFT:
|
|
settings.frontButtonBack = CrossPointSettings::FRONT_HW_BACK;
|
|
settings.frontButtonConfirm = CrossPointSettings::FRONT_HW_CONFIRM;
|
|
settings.frontButtonLeft = CrossPointSettings::FRONT_HW_RIGHT;
|
|
settings.frontButtonRight = CrossPointSettings::FRONT_HW_LEFT;
|
|
break;
|
|
case CrossPointSettings::BACK_CONFIRM_LEFT_RIGHT:
|
|
default:
|
|
settings.frontButtonBack = CrossPointSettings::FRONT_HW_BACK;
|
|
settings.frontButtonConfirm = CrossPointSettings::FRONT_HW_CONFIRM;
|
|
settings.frontButtonLeft = CrossPointSettings::FRONT_HW_LEFT;
|
|
settings.frontButtonRight = CrossPointSettings::FRONT_HW_RIGHT;
|
|
break;
|
|
}
|
|
}
|
|
} // namespace
|
|
|
|
bool CrossPointSettings::saveToFile() const {
|
|
// Make sure the directory exists
|
|
SdMan.mkdir("/.crosspoint");
|
|
|
|
FsFile outputFile;
|
|
if (!SdMan.openFileForWrite("CPS", SETTINGS_FILE, outputFile)) {
|
|
return false;
|
|
}
|
|
|
|
serialization::writePod(outputFile, SETTINGS_FILE_VERSION);
|
|
serialization::writePod(outputFile, SETTINGS_COUNT);
|
|
serialization::writePod(outputFile, sleepScreen);
|
|
serialization::writePod(outputFile, extraParagraphSpacing);
|
|
serialization::writePod(outputFile, shortPwrBtn);
|
|
serialization::writePod(outputFile, statusBar);
|
|
serialization::writePod(outputFile, orientation);
|
|
serialization::writePod(outputFile, frontButtonLayout); // legacy
|
|
serialization::writePod(outputFile, sideButtonLayout);
|
|
serialization::writePod(outputFile, fontFamily);
|
|
serialization::writePod(outputFile, fontSize);
|
|
serialization::writePod(outputFile, lineSpacing);
|
|
serialization::writePod(outputFile, paragraphAlignment);
|
|
serialization::writePod(outputFile, sleepTimeout);
|
|
serialization::writePod(outputFile, refreshFrequency);
|
|
serialization::writePod(outputFile, screenMargin);
|
|
serialization::writePod(outputFile, sleepScreenCoverMode);
|
|
serialization::writeString(outputFile, std::string(opdsServerUrl));
|
|
serialization::writePod(outputFile, textAntiAliasing);
|
|
serialization::writePod(outputFile, hideBatteryPercentage);
|
|
serialization::writePod(outputFile, longPressChapterSkip);
|
|
serialization::writePod(outputFile, hyphenationEnabled);
|
|
serialization::writeString(outputFile, std::string(opdsUsername));
|
|
serialization::writeString(outputFile, std::string(opdsPassword));
|
|
serialization::writePod(outputFile, sleepScreenCoverFilter);
|
|
serialization::writePod(outputFile, uiTheme);
|
|
serialization::writePod(outputFile, frontButtonBack);
|
|
serialization::writePod(outputFile, frontButtonConfirm);
|
|
serialization::writePod(outputFile, frontButtonLeft);
|
|
serialization::writePod(outputFile, frontButtonRight);
|
|
serialization::writePod(outputFile, fadingFix);
|
|
serialization::writePod(outputFile, embeddedStyle);
|
|
// New fields added at end for backward compatibility
|
|
outputFile.close();
|
|
|
|
Serial.printf("[%lu] [CPS] Settings saved to file\n", millis());
|
|
return true;
|
|
}
|
|
|
|
bool CrossPointSettings::loadFromFile() {
|
|
FsFile inputFile;
|
|
if (!SdMan.openFileForRead("CPS", SETTINGS_FILE, inputFile)) {
|
|
return false;
|
|
}
|
|
|
|
uint8_t version;
|
|
serialization::readPod(inputFile, version);
|
|
if (version != SETTINGS_FILE_VERSION) {
|
|
Serial.printf("[%lu] [CPS] Deserialization failed: Unknown version %u\n", millis(), version);
|
|
inputFile.close();
|
|
return false;
|
|
}
|
|
|
|
uint8_t fileSettingsCount = 0;
|
|
serialization::readPod(inputFile, fileSettingsCount);
|
|
|
|
// load settings that exist (support older files with fewer fields)
|
|
uint8_t settingsRead = 0;
|
|
// Track whether remap fields were present in the settings file.
|
|
bool frontButtonMappingRead = false;
|
|
do {
|
|
readAndValidate(inputFile, sleepScreen, SLEEP_SCREEN_MODE_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
serialization::readPod(inputFile, extraParagraphSpacing);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, shortPwrBtn, SHORT_PWRBTN_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, statusBar, STATUS_BAR_MODE_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, orientation, ORIENTATION_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, frontButtonLayout, FRONT_BUTTON_LAYOUT_COUNT); // legacy
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, sideButtonLayout, SIDE_BUTTON_LAYOUT_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, fontFamily, FONT_FAMILY_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, fontSize, FONT_SIZE_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, lineSpacing, LINE_COMPRESSION_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, paragraphAlignment, PARAGRAPH_ALIGNMENT_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, sleepTimeout, SLEEP_TIMEOUT_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, refreshFrequency, REFRESH_FREQUENCY_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
serialization::readPod(inputFile, screenMargin);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, sleepScreenCoverMode, SLEEP_SCREEN_COVER_MODE_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
{
|
|
std::string urlStr;
|
|
serialization::readString(inputFile, urlStr);
|
|
strncpy(opdsServerUrl, urlStr.c_str(), sizeof(opdsServerUrl) - 1);
|
|
opdsServerUrl[sizeof(opdsServerUrl) - 1] = '\0';
|
|
}
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
serialization::readPod(inputFile, textAntiAliasing);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, hideBatteryPercentage, HIDE_BATTERY_PERCENTAGE_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
serialization::readPod(inputFile, longPressChapterSkip);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
serialization::readPod(inputFile, hyphenationEnabled);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
{
|
|
std::string usernameStr;
|
|
serialization::readString(inputFile, usernameStr);
|
|
strncpy(opdsUsername, usernameStr.c_str(), sizeof(opdsUsername) - 1);
|
|
opdsUsername[sizeof(opdsUsername) - 1] = '\0';
|
|
}
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
{
|
|
std::string passwordStr;
|
|
serialization::readString(inputFile, passwordStr);
|
|
strncpy(opdsPassword, passwordStr.c_str(), sizeof(opdsPassword) - 1);
|
|
opdsPassword[sizeof(opdsPassword) - 1] = '\0';
|
|
}
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, sleepScreenCoverFilter, SLEEP_SCREEN_COVER_FILTER_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
serialization::readPod(inputFile, uiTheme);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, frontButtonBack, FRONT_BUTTON_HARDWARE_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, frontButtonConfirm, FRONT_BUTTON_HARDWARE_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, frontButtonLeft, FRONT_BUTTON_HARDWARE_COUNT);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
readAndValidate(inputFile, frontButtonRight, FRONT_BUTTON_HARDWARE_COUNT);
|
|
frontButtonMappingRead = true;
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
serialization::readPod(inputFile, fadingFix);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
serialization::readPod(inputFile, embeddedStyle);
|
|
if (++settingsRead >= fileSettingsCount) break;
|
|
// New fields added at end for backward compatibility
|
|
} while (false);
|
|
|
|
if (frontButtonMappingRead) {
|
|
validateFrontButtonMapping(*this);
|
|
} else {
|
|
applyLegacyFrontButtonLayout(*this);
|
|
}
|
|
|
|
inputFile.close();
|
|
Serial.printf("[%lu] [CPS] Settings loaded from file\n", millis());
|
|
return true;
|
|
}
|
|
|
|
float CrossPointSettings::getReaderLineCompression() const {
|
|
switch (fontFamily) {
|
|
case BOOKERLY:
|
|
default:
|
|
switch (lineSpacing) {
|
|
case TIGHT:
|
|
return 0.95f;
|
|
case NORMAL:
|
|
default:
|
|
return 1.0f;
|
|
case WIDE:
|
|
return 1.1f;
|
|
}
|
|
case NOTOSANS:
|
|
switch (lineSpacing) {
|
|
case TIGHT:
|
|
return 0.90f;
|
|
case NORMAL:
|
|
default:
|
|
return 0.95f;
|
|
case WIDE:
|
|
return 1.0f;
|
|
}
|
|
case OPENDYSLEXIC:
|
|
switch (lineSpacing) {
|
|
case TIGHT:
|
|
return 0.90f;
|
|
case NORMAL:
|
|
default:
|
|
return 0.95f;
|
|
case WIDE:
|
|
return 1.0f;
|
|
}
|
|
}
|
|
}
|
|
|
|
unsigned long CrossPointSettings::getSleepTimeoutMs() const {
|
|
switch (sleepTimeout) {
|
|
case SLEEP_1_MIN:
|
|
return 1UL * 60 * 1000;
|
|
case SLEEP_5_MIN:
|
|
return 5UL * 60 * 1000;
|
|
case SLEEP_10_MIN:
|
|
default:
|
|
return 10UL * 60 * 1000;
|
|
case SLEEP_15_MIN:
|
|
return 15UL * 60 * 1000;
|
|
case SLEEP_30_MIN:
|
|
return 30UL * 60 * 1000;
|
|
}
|
|
}
|
|
|
|
int CrossPointSettings::getRefreshFrequency() const {
|
|
switch (refreshFrequency) {
|
|
case REFRESH_1:
|
|
return 1;
|
|
case REFRESH_5:
|
|
return 5;
|
|
case REFRESH_10:
|
|
return 10;
|
|
case REFRESH_15:
|
|
default:
|
|
return 15;
|
|
case REFRESH_30:
|
|
return 30;
|
|
}
|
|
}
|
|
|
|
int CrossPointSettings::getReaderFontId() const {
|
|
switch (fontFamily) {
|
|
case BOOKERLY:
|
|
default:
|
|
switch (fontSize) {
|
|
case SMALL:
|
|
return BOOKERLY_12_FONT_ID;
|
|
case MEDIUM:
|
|
default:
|
|
return BOOKERLY_14_FONT_ID;
|
|
case LARGE:
|
|
return BOOKERLY_16_FONT_ID;
|
|
case EXTRA_LARGE:
|
|
return BOOKERLY_18_FONT_ID;
|
|
}
|
|
case NOTOSANS:
|
|
switch (fontSize) {
|
|
case SMALL:
|
|
return NOTOSANS_12_FONT_ID;
|
|
case MEDIUM:
|
|
default:
|
|
return NOTOSANS_14_FONT_ID;
|
|
case LARGE:
|
|
return NOTOSANS_16_FONT_ID;
|
|
case EXTRA_LARGE:
|
|
return NOTOSANS_18_FONT_ID;
|
|
}
|
|
case OPENDYSLEXIC:
|
|
switch (fontSize) {
|
|
case SMALL:
|
|
return OPENDYSLEXIC_8_FONT_ID;
|
|
case MEDIUM:
|
|
default:
|
|
return OPENDYSLEXIC_10_FONT_ID;
|
|
case LARGE:
|
|
return OPENDYSLEXIC_12_FONT_ID;
|
|
case EXTRA_LARGE:
|
|
return OPENDYSLEXIC_14_FONT_ID;
|
|
}
|
|
}
|
|
}
|