Skip to content

Refactor Pattern value/format accessors into base class #258

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

Open
ddmitv wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Refactor Pattern value/format accessors into base class #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
116 changes: 78 additions & 38 deletions lib/include/pl/patterns/pattern.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,12 @@ namespace pl::ptrn {

[[nodiscard]] virtual std::string getFormattedName() const = 0;

/**
* @brief Pattern's short string representation.
*
* Tries the user [[format]] function first, then falls back to defaultToDisplayValue() to format with pattern's default display value formatter.
* The result is cached.
*/
[[nodiscard]] std::string getFormattedValue() {
if (this->m_cachedDisplayValue != nullptr)
return *this->m_cachedDisplayValue;
Expand All @@ -271,7 +277,8 @@ namespace pl::ptrn {
this->m_evaluator->setReadOffset(startOffset);
};

auto result = this->formatDisplayValue();
auto userResult = this->callUserFormatFunc();
auto result = userResult.has_value() ? std::move(*userResult) : this->defaultToDisplayValue();
this->m_cachedDisplayValue = std::make_unique<std::string>(result);
this->m_validDisplayValue = true;

Expand All @@ -288,20 +295,34 @@ namespace pl::ptrn {
return this->m_validDisplayValue;
}

[[nodiscard]] virtual std::string toString() {
auto result = fmt::format("{} {} @ 0x{:X}", this->getTypeName(), this->getVariableName(), this->getOffset());

/**
* @brief Pattern's full string representation.
*
* Tries to format with user [[format]] function, then uses defaultToString() to format with pattern's default formatter
*/
[[nodiscard]] std::string toString() const {
try {
return this->callUserFormatFunc(this->getValue(), true).value_or(result);
auto userResult = this->callUserFormatFunc(true);
return userResult.has_value() ? std::move(*userResult) : this->defaultToString();
} catch (std::exception &e) {
return e.what();
}
}

[[nodiscard]] virtual core::Token::Literal getValue() const {
auto pattern = this->clone();
/**
* @brief Pattern's value after [[transform]] function is applied.
*/
[[nodiscard]] core::Token::Literal getValue() const {
return this->transformValue(this->getRawValue());
}

return this->transformValue(std::move(pattern));
/**
* @brief Pattern's value before [[transform]] function is applied.
*
* Default implementation clones pattern by calling clone() method.
*/
[[nodiscard]] virtual core::Token::Literal getRawValue() const {
return this->clone();
}

[[nodiscard]] virtual std::vector<std::pair<u64, Pattern*>> getChildren() {
Expand Down Expand Up @@ -581,11 +602,27 @@ namespace pl::ptrn {
m_arrayIndex = index;
}

[[nodiscard]] virtual std::string formatDisplayValue() = 0;

protected:
std::optional<std::endian> m_endian;

/**
* @brief Fallback for toString() when no user [[format]] function applies.
* @note Implementations of this method should use getValue() instead of getRawValue(), because default formatter should respect [[transform]].
*/
[[nodiscard]] virtual std::string defaultToString() const {
return fmt::format("{} {} @ 0x{:X}", this->getTypeName(), this->getVariableName(), this->getOffset());
}

/**
* @brief Fallback for getFormattedValue() when no user [[format]] function applies. Cached by getFormattedValue().
* @note Implementations of this method should use getValue() instead of getRawValue(), because default formatter should respect [[transform]].
*
* Default implementation calls defaultToString().
*/
[[nodiscard]] virtual std::string defaultToDisplayValue() const {
return this->defaultToString();
}

[[nodiscard]] core::Token::Literal transformValue(const core::Token::Literal &value) const {
auto evaluator = this->getEvaluator();

Expand All @@ -612,39 +649,42 @@ namespace pl::ptrn {
}

/**
* @brief Calls an user-defined PL function to format the given literal (pattern), if existing. Else, returns defaultValue
* @brief Runs the user [[format]] function if one is registered.
*
* The argument passed to the [[format]] function is getRawValue() (before [[transform]] is applied).
*/
[[nodiscard]] std::optional<std::string> callUserFormatFunc(const core::Token::Literal &literal, bool fromCast = false) const {
[[nodiscard]] std::optional<std::string> callUserFormatFunc(bool fromCast = false) const {
const auto &formatterFunctionName = this->getReadFormatterFunction();
if (formatterFunctionName.empty())
return {};
else {
const auto function = this->m_evaluator->findFunction(formatterFunctionName);
if (function.has_value()) {
auto startHeap = this->m_evaluator->getHeap();
ON_SCOPE_EXIT { this->m_evaluator->getHeap() = startHeap; };

// Preserve pattern variable name
std::string patternName;
if (literal.isPattern()) {
patternName = literal.toPattern()->getVariableName();
}
ON_SCOPE_EXIT {
if (!patternName.empty())
literal.toPattern()->setVariableName(patternName);
};

auto result = function->func(this->m_evaluator, { literal });
if (result.has_value()) {
if (fromCast && result->isPattern() && result->toPattern()->getTypeName() == this->getTypeName()) {
return {};
} else {
return result->toString(true);
}
if (formatterFunctionName.empty()) {
return std::nullopt;
}
const auto literal = this->getRawValue();

const auto function = this->m_evaluator->findFunction(formatterFunctionName);
if (function.has_value()) {
auto startHeap = this->m_evaluator->getHeap();
ON_SCOPE_EXIT { this->m_evaluator->getHeap() = startHeap; };

// Preserve pattern variable name
std::string patternName;
if (literal.isPattern()) {
patternName = literal.toPattern()->getVariableName();
}
ON_SCOPE_EXIT {
if (!patternName.empty())
literal.toPattern()->setVariableName(patternName);
};

auto result = function->func(this->m_evaluator, { literal });
if (result.has_value()) {
if (fromCast && result->isPattern() && result->toPattern()->getTypeName() == this->getTypeName()) {
return {};
} else {
return result->toString(true);
}
}
return {};
}
return std::nullopt;
}

template<typename T>
Expand Down
61 changes: 30 additions & 31 deletions lib/include/pl/patterns/pattern_array_dynamic.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,33 +158,6 @@ namespace pl::ptrn {
this->setBaseColor(this->m_entries.front()->getColor());
}

[[nodiscard]] std::string toString() override {
std::string result;

result += "[ ";

size_t entryCount = 0;
for (const auto &entry : this->m_entries) {
if (entryCount > 50) {
result += fmt::format("..., ");
break;
}

result += fmt::format("{}, ", entry->toString());
entryCount++;
}

if (entryCount > 0) {
// Remove trailing ", "
result.pop_back();
result.pop_back();
}

result += " ]";

return Pattern::callUserFormatFunc(this->reference(), true).value_or(result);
}

[[nodiscard]] bool operator==(const Pattern &other) const override {
if (!compareCommonProperties<decltype(*this)>(other))
return false;
Expand Down Expand Up @@ -216,10 +189,6 @@ namespace pl::ptrn {
v.visit(*this);
}

std::string formatDisplayValue() override {
return Pattern::callUserFormatFunc(this->reference()).value_or("[ ... ]");
}

std::vector<u8> getRawBytes() override {
std::vector<u8> result;

Expand All @@ -243,6 +212,36 @@ namespace pl::ptrn {

Pattern::clearFormatCache();
}
protected:
std::string defaultToString() const override {
std::string result;

result += "[ ";

size_t entryCount = 0;
for (const auto &entry : this->m_entries) {
if (entryCount > 50) {
result += fmt::format("..., ");
break;
}

result += fmt::format("{}, ", entry->toString());
entryCount++;
}

if (entryCount > 0) {
// Remove trailing ", "
result.pop_back();
result.pop_back();
}

result += " ]";
return result;
}

std::string defaultToDisplayValue() const override {
return "[ ... ]";
}

private:
std::vector<std::shared_ptr<Pattern>> m_entries;
Expand Down
53 changes: 26 additions & 27 deletions lib/include/pl/patterns/pattern_array_static.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,11 +199,32 @@ namespace pl::ptrn {
v.visit(*this);
}

std::string formatDisplayValue() override {
return Pattern::callUserFormatFunc(this->reference()).value_or("[ ... ]");
std::vector<u8> getRawBytes() override {
std::vector<u8> result;

if (this->isSealed()) {
result.resize(this->getSize());
this->getEvaluator()->readData(this->getOffset(), result.data(), result.size(), this->getSection());
} else {
this->forEachEntry(0, this->getEntryCount(), [&](u64, const auto &entry) {
auto bytes = entry->getBytes();
std::copy(bytes.begin(), bytes.end(), std::back_inserter(result));
});
}

return result;
}

[[nodiscard]] std::string toString() override {
void clearFormatCache() override {
this->m_template->clearFormatCache();

for (auto &highlightTemplate : this->m_highlightTemplates)
highlightTemplate->clearFormatCache();

Pattern::clearFormatCache();
}
protected:
std::string defaultToString() const override {
std::string result;

result += "[ ";
Expand All @@ -228,33 +249,11 @@ namespace pl::ptrn {
}

result += " ]";

return Pattern::callUserFormatFunc(this->reference(), true).value_or(result);
}

std::vector<u8> getRawBytes() override {
std::vector<u8> result;

if (this->isSealed()) {
result.resize(this->getSize());
this->getEvaluator()->readData(this->getOffset(), result.data(), result.size(), this->getSection());
} else {
this->forEachEntry(0, this->getEntryCount(), [&](u64, const auto &entry) {
auto bytes = entry->getBytes();
std::copy(bytes.begin(), bytes.end(), std::back_inserter(result));
});
}

return result;
}

void clearFormatCache() override {
this->m_template->clearFormatCache();

for (auto &highlightTemplate : this->m_highlightTemplates)
highlightTemplate->clearFormatCache();

Pattern::clearFormatCache();
std::string defaultToDisplayValue() const override {
return "[ ... ]";
}

private:
Expand Down
Loading
Loading