Skip to content

Commit

Permalink
GUI/NetWatch: Update code style and remove Qt4 compatibility
Browse files Browse the repository at this point in the history 
- Comment format
- Use enum class
- Use initialiser lists
- assert(false) for invalid paths
  • Loading branch information
@luke-jr
luke-jr committed Sep 29, 2021
1 parent 3fbc22b commit 1401001
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 77 deletions.
109 changes: 56 additions & 53 deletions src/qt/netwatch.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,14 @@ const CTxOut* GetNonDatacarrierOutput(const CTransactionRef& tx, const size_t tx

} // namespace

const QString LogEntry::LogEntryTypeAbbreviation(const LogEntryType log_entry_type)
const QString LogEntry::LogEntryTypeAbbreviation(const Type log_entry_type)
{
switch (log_entry_type) {
case LET_BLOCK: return QObject::tr("Blk", "Tx Watch: Block type abbreviation");
case LET_TX: return QObject::tr("Txn", "Tx Watch: Transaction type abbreviation");
}
return QString();
case Type::Block: return QObject::tr("Blk", "Tx Watch: Block type abbreviation");
case Type::Transaction: return QObject::tr("Txn", "Tx Watch: Transaction type abbreviation");
} // no default case, so the compiler can warn about missing cases

assert(false);
}

void LogEntry::init(const LogEntry& other)
Expand All @@ -102,6 +103,7 @@ void LogEntry::init(const LogEntry& other)
case 3: // CTransactionWeakref
init(relTimestamp, *other.get<CTransactionWeakref>(), true);
break;
default: assert(false);
}
}

Expand Down Expand Up @@ -172,6 +174,7 @@ void LogEntry::clear()
case 3: // CTransactionWeakref
get<CTransactionWeakref>()->~CTransactionWeakref();
break;
default: assert(false);
}
delete m_data;
}
Expand Down Expand Up @@ -210,10 +213,10 @@ uint64_t LogEntry::getTimestamp(uint64_t now) const
return ts;
}

LogEntry::LogEntryType LogEntry::getType() const
LogEntry::Type LogEntry::getType() const
{
const meta_t n = *(meta_t*)m_data;
return (n >> 31) ? LET_TX : LET_BLOCK;
return (n >> 31) ? Type::Transaction : Type::Block;
}

const CBlockIndex& LogEntry::getBlockIndex() const
Expand Down Expand Up @@ -321,18 +324,18 @@ int NetWatchLogModel::rowCount(const QModelIndex& parent) const

int NetWatchLogModel::columnCount(const QModelIndex& parent) const
{
return NWLMHeaderCount;
return HeaderCount;
}

QVariant NetWatchLogModel::data(const CBlockIndex& blockindex, int txout_index, const Header header) const
{
switch (header) {
case NWLMH_TYPE:
return LogEntry::LogEntryTypeAbbreviation(LogEntry::LET_BLOCK);
case NWLMH_ID:
case Header::Type:
return LogEntry::LogEntryTypeAbbreviation(LogEntry::Type::Block);
case Header::Id:
return QString::fromStdString(blockindex.GetBlockHash().GetHex());
case NWLMH_ADDR:
case NWLMH_VALUE: {
case Header::Address:
case Header::Value: {
if (blockindex.nTx == 0 || !(blockindex.nStatus & BLOCK_HAVE_DATA)) {
return QVariant();
}
Expand All @@ -344,19 +347,20 @@ QVariant NetWatchLogModel::data(const CBlockIndex& blockindex, int txout_index,
assert(block.vtx.size());
return data(block.vtx[0], txout_index, header);
}
case NWLMH_TIME: ; // Not valid here
case Header::Time: // Not valid here
assert(false);
}
return QVariant();
}

QVariant NetWatchLogModel::data(const CTransactionRef& tx, int txout_index, const Header header) const
{
switch (header) {
case NWLMH_TYPE:
return LogEntry::LogEntryTypeAbbreviation(LogEntry::LET_TX);
case NWLMH_ID:
case Header::Type:
return LogEntry::LogEntryTypeAbbreviation(LogEntry::Type::Transaction);
case Header::Id:
return QString::fromStdString(tx->GetHash().GetHex());
case NWLMH_ADDR: {
case Header::Address: {
const CTxOut *ptxout = GetNonDatacarrierOutput(tx, txout_index);
if (!ptxout) {
// Only datacarriers
Expand All @@ -370,7 +374,7 @@ QVariant NetWatchLogModel::data(const CTransactionRef& tx, int txout_index, cons
}
return QString::fromStdString(EncodeDestination(txdest));
}
case NWLMH_VALUE: {
case Header::Value: {
const CTxOut *ptxout = GetNonDatacarrierOutput(tx, txout_index);
if (!ptxout) {
ptxout = &tx->vout[0];
Expand All @@ -381,7 +385,8 @@ QVariant NetWatchLogModel::data(const CTransactionRef& tx, int txout_index, cons
return qlonglong(ptxout->nValue);
}
}
case NWLMH_TIME: ; // Not valid here
case Header::Time: // Not valid here
assert(false);
}
return QVariant();
}
Expand Down Expand Up @@ -427,14 +432,14 @@ QVariant NetWatchLogModel::data(const QModelIndex& index, int role) const
if (!data(index, Qt::DisplayRole).isValid()) {
return m_widget->palette().brush(QPalette::WindowText);
}
LogEntry::LogEntryType type;
LogEntry::Type type;
{
int entry_row;
LOCK(cs);
const LogEntry& le = findLogEntry(index.row(), entry_row);
type = le.getType();
}
if (type == LogEntry::LET_BLOCK) {
if (type == LogEntry::Type::Block) {
return m_widget->palette().brush(QPalette::AlternateBase);
}
return QVariant();
Expand All @@ -457,12 +462,12 @@ QVariant NetWatchLogModel::data(const QModelIndex& index, int role) const
return QVariant();
}
case Qt::TextAlignmentRole:
if (header == NWLMH_VALUE) {
if (header == Header::Value) {
return QVariant(Qt::AlignRight | Qt::AlignVCenter);
}
return QVariant();
case Qt::FontRole:
if (header == NWLMH_ID) {
if (header == Header::Id) {
return GUIUtil::fixedPitchFont();
}
return QVariant();
Expand All @@ -472,15 +477,15 @@ QVariant NetWatchLogModel::data(const QModelIndex& index, int role) const
int entry_row;
LOCK(cs);
const LogEntry& le = findLogEntry(index.row(), entry_row);
if (header == NWLMH_TIME) {
if (header == Header::Time) {
return GUIUtil::dateTimeStr(le.getTimestamp(GetTime()));
}
const LogEntry::LogEntryType type = le.getType();
if (type == LogEntry::LET_BLOCK) {
const LogEntry::Type type = le.getType();
if (type == LogEntry::Type::Block) {
return data(le.getBlockIndex(), entry_row, header);
}
if (header == NWLMH_TYPE) {
return LogEntry::LogEntryTypeAbbreviation(LogEntry::LET_TX);
if (header == Header::Type) {
return LogEntry::LogEntryTypeAbbreviation(LogEntry::Type::Transaction);
}

if (le.expired()) {
Expand All @@ -494,12 +499,12 @@ QVariant NetWatchLogModel::headerData(int section, Qt::Orientation orientation,
if (orientation != Qt::Horizontal || role != Qt::DisplayRole) {
return QVariant();
}
switch (section) {
case NWLMH_TIME: return tr("Time" , "NetWatch: Time header");
case NWLMH_TYPE: return tr("Type" , "NetWatch: Type header");
case NWLMH_ID: return tr("Id" , "NetWatch: Block hash / Txid header");
case NWLMH_ADDR: return tr("Address", "NetWatch: Address header");
case NWLMH_VALUE:
switch (Header(section)) {
case Header::Time: return tr("Time" , "NetWatch: Time header");
case Header::Type: return tr("Type" , "NetWatch: Type header");
case Header::Id: return tr("Id" , "NetWatch: Block hash / Txid header");
case Header::Address: return tr("Address", "NetWatch: Address header");
case Header::Value:
if (m_client_model) {
return BitcoinUnits::getAmountColumnTitle(m_client_model->getOptionsModel()->getDisplayUnit());
} else {
Expand All @@ -525,15 +530,15 @@ NetWatchLogSearch::NetWatchLogSearch(const QString& query, int display_unit) :

bool NetWatchLogSearch::match(const NetWatchLogModel& model, int row) const
{
if (model.data(model.index(row, NetWatchLogModel::NWLMH_TIME)).toString().contains(m_query)) {
if (model.data(model.index(row, int(NetWatchLogModel::Header::Time))).toString().contains(m_query)) {
return true;
} else if (m_check_type && model.data(model.index(row, NetWatchLogModel::NWLMH_TYPE)).toString().contains(m_query, Qt::CaseInsensitive)) {
} else if (m_check_type && model.data(model.index(row, int(NetWatchLogModel::Header::Type))).toString().contains(m_query, Qt::CaseInsensitive)) {
return true;
} else if (m_check_id && model.data(model.index(row, NetWatchLogModel::NWLMH_ID)).toString().contains(m_query, Qt::CaseInsensitive)) {
} else if (m_check_id && model.data(model.index(row, int(NetWatchLogModel::Header::Id))).toString().contains(m_query, Qt::CaseInsensitive)) {
return true;
} else if (m_check_addr && model.data(model.index(row, NetWatchLogModel::NWLMH_ADDR)).toString().contains(m_query, Qt::CaseInsensitive)) {
} else if (m_check_addr && model.data(model.index(row, int(NetWatchLogModel::Header::Address))).toString().contains(m_query, Qt::CaseInsensitive)) {
return true;
} else if (m_check_value && model.data(model.index(row, NetWatchLogModel::NWLMH_VALUE)).toString().contains(m_query)) {
} else if (m_check_value && model.data(model.index(row, int(NetWatchLogModel::Header::Value))).toString().contains(m_query)) {
return true;
}
return false;
Expand Down Expand Up @@ -679,8 +684,8 @@ void NetWatchLogModel::setClientModel(ClientModel *model)

void NetWatchLogModel::updateDisplayUnit()
{
Q_EMIT headerDataChanged(Qt::Horizontal, NWLMH_VALUE, NWLMH_VALUE);
Q_EMIT dataChanged(index(0, NWLMH_VALUE), index(rowCount() - 1, NWLMH_VALUE));
Q_EMIT headerDataChanged(Qt::Horizontal, int(Header::Value), int(Header::Value));
Q_EMIT dataChanged(index(0, int(Header::Value)), index(rowCount() - 1, int(Header::Value)));
}

int NetWatchLogTestModel::rowCount(const QModelIndex& parent) const
Expand All @@ -691,25 +696,25 @@ int NetWatchLogTestModel::rowCount(const QModelIndex& parent) const
QVariant NetWatchLogTestModel::data(const QModelIndex& index, int role) const
{
const NetWatchLogModel::Header header = NetWatchLogModel::Header(index.column());
if (role == Qt::FontRole && header == NWLMH_ID) {
if (role == Qt::FontRole && header == Header::Id) {
return GUIUtil::fixedPitchFont();
} else if (role != Qt::DisplayRole) {
return QVariant();
}
switch (header) {
case NWLMH_TIME:
case Header::Time:
return QString{GUIUtil::dateTimeStr(GetTime()) + "4"};
case NWLMH_TYPE:
return LogEntry::LogEntryTypeAbbreviation(LogEntry::LogEntryType(index.row()));
case NWLMH_ID:
case Header::Type:
return LogEntry::LogEntryTypeAbbreviation(LogEntry::Type(index.row()));
case Header::Id:
return QString(64, '0');
case NWLMH_ADDR:
case Header::Address:
if (index.row()) {
return QString{"bc1" + QString(LONGEST_BECH32_ADDRESS-3, 'x')};
} else {
return QString(LONGEST_BASE58_ADDRESS, 'W');
}
case NWLMH_VALUE:
case Header::Value:
return "20000000.00000000";
}
return QVariant();
Expand All @@ -721,9 +726,7 @@ GuiNetWatch::GuiNetWatch(const PlatformStyle *platformStyle, const NetworkStyle
QVBoxLayout * const layout = new QVBoxLayout(this);

m_search_editor = new QLineEdit(this);
#if QT_VERSION >= 0x040700
m_search_editor->setPlaceholderText("Search");
#endif
layout->addWidget(m_search_editor);

m_log_view = new QTableView(this);
Expand All @@ -745,7 +748,7 @@ GuiNetWatch::GuiNetWatch(const PlatformStyle *platformStyle, const NetworkStyle

setWindowTitle(tr(PACKAGE_NAME) + " - " + tr("Network Watch") + " " + networkStyle->getTitleAddText());
setMinimumSize(640, 480);
resize(layout->contentsMargins().left() + (m_log_view->frameWidth() * 2) + m_log_view->columnViewportPosition(NetWatchLogModel::NWLMHeaderCount-1) + m_log_view->columnWidth(NetWatchLogModel::NWLMHeaderCount-1) + m_log_view->verticalScrollBar()->size().width() + layout->contentsMargins().right(), 480);
resize(layout->contentsMargins().left() + (m_log_view->frameWidth() * 2) + m_log_view->columnViewportPosition(NetWatchLogModel::HeaderCount-1) + m_log_view->columnWidth(NetWatchLogModel::HeaderCount-1) + m_log_view->verticalScrollBar()->size().width() + layout->contentsMargins().right(), 480);
setWindowIcon(networkStyle->getTrayAndWindowIcon());

connect(m_search_editor, &QLineEdit::textChanged, this, &GuiNetWatch::doSearch);
Expand Down Expand Up @@ -811,7 +814,7 @@ void GuiNetWatch::doSearch(const QString& query)
sel.select(log_model->index(row, 0), QItemSelectionModel::Rows | QItemSelectionModel::Select);
}
m_dont_cancel_search = false;
m_log_view->scrollTo(log_model->index(results.back(), NetWatchLogModel::NWLMH_ID));
m_log_view->scrollTo(log_model->index(results.back(), int(NetWatchLogModel::Header::Id)));
}

void GuiNetWatch::moreSearchResults(const QList<int>& rows)
Expand Down
49 changes: 25 additions & 24 deletions src/qt/netwatch.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,20 @@ static constexpr int LONGEST_BECH32_ADDRESS{62}; // NOTE: Up to 74 in theory, b

class LogEntry {
private:
/* m_data is a uint32_t (meta_t) with the top two bits used for:
/**
* m_data is a uint32_t (meta_t) with the top two bits used for:
* 1: CBlockIndex*
* 2: CTransactionRef
* 3: weak_ptr<const CTransaction>
* The subsequent 30 bits are the timestamp, assumed to be most recent to the current time.
* Following this, and any padding necessary for alignment, the object itself is stored
*/
uint8_t *m_data = nullptr;
uint8_t *m_data{nullptr};

typedef uint32_t meta_t;
typedef std::weak_ptr<const CTransaction> CTransactionWeakref;
static const uint32_t rel_ts_mask = 0x3fffffff;
static const uint64_t rel_ts_mask64 = rel_ts_mask;
static constexpr uint32_t rel_ts_mask{0x3fffffff};
static constexpr uint64_t rel_ts_mask64{rel_ts_mask};

template<typename T> static size_t data_sizeof(size_t& offset) {
void *p = (void *)intptr_t(sizeof(meta_t));
Expand Down Expand Up @@ -71,11 +72,11 @@ class LogEntry {
void clear();

public:
enum LogEntryType {
LET_BLOCK,
LET_TX,
enum class Type {
Block,
Transaction,
};
static const QString LogEntryTypeAbbreviation(LogEntryType);
static const QString LogEntryTypeAbbreviation(Type);

LogEntry(const LogEntry&);
LogEntry() { }
Expand All @@ -89,7 +90,7 @@ class LogEntry {
explicit operator bool() const;
int32_t getRelTimestamp() const;
uint64_t getTimestamp(uint64_t now) const;
LogEntryType getType() const;
Type getType() const;

template <typename T> T* get() const {
void *p = m_data + sizeof(meta_t);
Expand Down Expand Up @@ -129,33 +130,33 @@ class NetWatchLogModel : public QAbstractTableModel

private:
QWidget * const m_widget;
ClientModel *m_client_model = nullptr;
ClientModel *m_client_model{nullptr};

NetWatchValidationInterface *m_validation_interface;

mutable RecursiveMutex cs;
std::vector<LogEntry> m_log GUARDED_BY(cs);
static const size_t logsizelimit = 0x400;
size_t m_logpos GUARDED_BY(cs) = 0;
size_t m_logskip GUARDED_BY(cs) = 0;
static constexpr size_t logsizelimit{0x400};
size_t m_logpos GUARDED_BY(cs) {0};
size_t m_logskip GUARDED_BY(cs) {0};

static const size_t max_nonweak_txouts = 0x200;
static const size_t max_vout_per_tx = 0x100;
static constexpr size_t max_nonweak_txouts{0x200};
static constexpr size_t max_vout_per_tx{0x100};

NetWatchLogSearch *m_current_search GUARDED_BY(cs) = nullptr;
NetWatchLogSearch *m_current_search GUARDED_BY(cs) {nullptr};

const LogEntry& getLogEntryRow(int row) const EXCLUSIVE_LOCKS_REQUIRED(cs);
LogEntry& getLogEntryRow(int row) EXCLUSIVE_LOCKS_REQUIRED(cs);
void log_append(const LogEntry&, size_t& rows_used) EXCLUSIVE_LOCKS_REQUIRED(cs);

public:
static const int NWLMHeaderCount = 5;
enum Header {
NWLMH_TIME,
NWLMH_TYPE,
NWLMH_ID,
NWLMH_ADDR,
NWLMH_VALUE,
static constexpr int HeaderCount{5};
enum class Header {
Time,
Type,
Id,
Address,
Value,
};

explicit NetWatchLogModel(QWidget *parent);
Expand Down Expand Up @@ -212,7 +213,7 @@ class GuiNetWatch: public QWidget
void setClientModel(ClientModel *model);

NetWatchLogModel *log_model;
bool m_dont_cancel_search = false;
bool m_dont_cancel_search{false};

QLineEdit *m_search_editor;
QTableView *m_log_view;
Expand Down

0 comments on commit 1401001

Please sign in to comment.