refs #694 Use human readable names in cache validation messages.

This commit is contained in:
Mathew Sutcliffe
2016-07-30 21:13:56 +01:00
parent 87b2396edb
commit 98a2b3253a
3 changed files with 13 additions and 10 deletions

View File

@@ -538,10 +538,12 @@ namespace BlackMisc
struct CValuePage::Element struct CValuePage::Element
{ {
Element(const QString &key, int metaType, Validator validator, const CVariant &defaultValue, NotifySlot slot) : Element(const QString &key, const QString &name, int metaType, Validator validator, const CVariant &defaultValue, NotifySlot slot) :
m_key(key), m_metaType(metaType), m_validator(validator), m_default(defaultValue), m_notifySlot(slot) m_key(key), m_name(name), m_metaType(metaType), m_validator(validator), m_default(defaultValue), m_notifySlot(slot)
{} {}
const QString m_key; const QString m_key;
const QString m_name;
const QString m_nameWithKey = m_name.isEmpty() ? m_key : QString("%1 (%2)").arg(m_name, m_key);
LockFree<CVariant> m_value; LockFree<CVariant> m_value;
std::atomic<qint64> m_timestamp { 0 }; std::atomic<qint64> m_timestamp { 0 };
const int m_metaType = QMetaType::UnknownType; const int m_metaType = QMetaType::UnknownType;
@@ -552,13 +554,13 @@ namespace BlackMisc
bool m_saved = false; bool m_saved = false;
}; };
CValuePage::Element &CValuePage::createElement(const QString &key, int metaType, Validator validator, const CVariant &defaultValue, NotifySlot slot) CValuePage::Element &CValuePage::createElement(const QString &key, const QString &name, int metaType, Validator validator, const CVariant &defaultValue, NotifySlot slot)
{ {
Q_ASSERT_X(! m_elements.contains(key), "CValuePage", "Can't have two CCached in the same object referring to the same value"); Q_ASSERT_X(! m_elements.contains(key), "CValuePage", "Can't have two CCached in the same object referring to the same value");
Q_ASSERT_X(defaultValue.isValid() ? defaultValue.userType() == metaType : true, "CValuePage", "Metatype mismatch for default value"); Q_ASSERT_X(defaultValue.isValid() ? defaultValue.userType() == metaType : true, "CValuePage", "Metatype mismatch for default value");
Q_ASSERT_X(defaultValue.isValid() && validator ? validator(defaultValue) : true, "CValuePage", "Validator rejects default value"); Q_ASSERT_X(defaultValue.isValid() && validator ? validator(defaultValue) : true, "CValuePage", "Validator rejects default value");
auto &element = *(m_elements[key] = ElementPtr(new Element(key, metaType, validator, defaultValue, slot))); auto &element = *(m_elements[key] = ElementPtr(new Element(key, name, metaType, validator, defaultValue, slot)));
std::forward_as_tuple(element.m_value.uniqueWrite(), element.m_timestamp, element.m_saved) = m_cache->getValue(key); std::forward_as_tuple(element.m_value.uniqueWrite(), element.m_timestamp, element.m_saved) = m_cache->getValue(key);
auto status = validate(element, element.m_value.read(), CStatusMessage::SeverityDebug); auto status = validate(element, element.m_value.read(), CStatusMessage::SeverityDebug);
@@ -622,7 +624,7 @@ namespace BlackMisc
emit valuesWantToCache({ { { element.m_key, value } }, timestamp, save }); emit valuesWantToCache({ { { element.m_key, value } }, timestamp, save });
} }
// All good info // All good info
status = CStatusMessage(this).info("Set values in %1") << element.m_key; status = CStatusMessage(this).info("Set value %1") << element.m_nameWithKey;
} }
return status; return status;
} }
@@ -727,15 +729,15 @@ namespace BlackMisc
{ {
if (! value.isValid()) if (! value.isValid())
{ {
return CStatusMessage(this, invalidSeverity, QString("Empty cache value %1").arg(element.m_key), true); return CStatusMessage(this, invalidSeverity, QString("Empty cache value %1").arg(element.m_nameWithKey), true);
} }
else if (value.userType() != element.m_metaType) else if (value.userType() != element.m_metaType)
{ {
return CStatusMessage(this).error("Expected %1 but got %2 for %3") << QMetaType::typeName(element.m_metaType) << value.typeName() << element.m_key; return CStatusMessage(this).error("Expected %1 but got %2 for %3") << QMetaType::typeName(element.m_metaType) << value.typeName() << element.m_nameWithKey;
} }
else if (element.m_validator && ! element.m_validator(value)) else if (element.m_validator && ! element.m_validator(value))
{ {
return CStatusMessage(this).error("%1 is not valid for %2") << value.toQString() << element.m_key; return CStatusMessage(this).error("%1 is not valid for %2") << value.toQString() << element.m_nameWithKey;
} }
else else
{ {

View File

@@ -358,7 +358,7 @@ namespace BlackMisc
template <typename U, typename F> template <typename U, typename F>
CCached(CValueCache *cache, const QString &key, const QString &name, F validator, const T &defaultValue, U *owner, NotifySlot<U> slot = nullptr) : CCached(CValueCache *cache, const QString &key, const QString &name, F validator, const T &defaultValue, U *owner, NotifySlot<U> slot = nullptr) :
m_page(Private::CValuePage::getPageFor(owner, cache)), m_page(Private::CValuePage::getPageFor(owner, cache)),
m_element(m_page.createElement(key, qMetaTypeId<T>(), wrap(validator), CVariant::from(defaultValue), slot_cast(slot))) m_element(m_page.createElement(key, name, qMetaTypeId<T>(), wrap(validator), CVariant::from(defaultValue), slot_cast(slot)))
{ {
cache->setHumanReadableName(key, name); cache->setHumanReadableName(key, name);
} }

View File

@@ -66,11 +66,12 @@ namespace BlackMisc
//! Returns a new instance of the opaque Element type for use by CCached<T> to interact with CValuePage. //! Returns a new instance of the opaque Element type for use by CCached<T> to interact with CValuePage.
//! \param key The key string of the value in the cache. //! \param key The key string of the value in the cache.
//! \param name Human-readable name corresponding to the key.
//! \param metaType The Qt metatype ID of the value object's expected type. //! \param metaType The Qt metatype ID of the value object's expected type.
//! \param validator Optional functor which returns true if the value is valid. //! \param validator Optional functor which returns true if the value is valid.
//! \param defaultValue Optional value which is used in case the value is invalid. //! \param defaultValue Optional value which is used in case the value is invalid.
//! \param slot Optional member function of parent, will be called when value changes. //! \param slot Optional member function of parent, will be called when value changes.
Element &createElement(const QString &key, int metaType, Validator validator, const CVariant &defaultValue, NotifySlot slot); Element &createElement(const QString &key, const QString &name, int metaType, Validator validator, const CVariant &defaultValue, NotifySlot slot);
//! True if the currently paged value is a valid instance of the given type. //! True if the currently paged value is a valid instance of the given type.
//! \threadsafe //! \threadsafe