Documentation browser, improved error messages

.gitignore

@@ -13,9 +13,12 @@ feather_autogen/
 feather.cbp
 src/config-feather.h
 src/assets_tor.qrc
+src/assets_docs.qrc
 feather.AppDir/*
 src/assets/tor/*
+src/assets/docs/*
 !src/assets/tor/.gitkeep
+!src/assets/docs/.gitkeep
 contrib/installers/windows/setup.nsi
 githash.txt
 guix/guix-build-*

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "src/third-party/polyseed"]
 	path = src/third-party/polyseed
 	url = https://github.com/tevador/polyseed.git
+[submodule "external/feather-docs"]
+	path = external/feather-docs
+	url = https://github.com/feather-wallet/feather-docs.git

CMakeLists.txt

@@ -145,6 +145,7 @@ if(UNIX AND NOT APPLE)
     endif()
 endif()
 
+include(GenerateDocs)
 include(TorQrcGenerator)
 
 # To build Feather with embedded (and static) Tor, pass CMake -DTOR_DIR=/path/to/tor/

cmake/GenerateDocs.cmake

@@ -0,0 +1,20 @@
+message(STATUS "Generating docs")
+
+find_package(Python3 COMPONENTS Interpreter)
+
+if(Python3_Interpreter_FOUND)
+    execute_process(COMMAND python3 contrib/docs/generate.py
+                    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
+
+    FILE(GLOB DOCS LIST_DIRECTORIES false "src/assets/docs/*")
+
+    foreach(FILE ${DOCS})
+        cmake_path(GET FILE FILENAME FILE_REL)
+        list(APPEND QRC_LIST "        <file alias=\"${FILE_REL}\">${FILE}</file>")
+    endforeach()
+
+    list(JOIN QRC_LIST "\n" QRC_DATA)
+    configure_file("cmake/assets_docs.qrc" "${CMAKE_CURRENT_SOURCE_DIR}/src/assets_docs.qrc")
+else()
+    message(WARNING "No Python3 interpreter, skipping docs.")
+endif()

cmake/assets_docs.qrc

@@ -0,0 +1,5 @@
+<!DOCTYPE RCC><RCC version="1.0">
+    <qresource prefix="/docs">
+        @QRC_DATA@
+    </qresource>
+</RCC>

contrib/docs/generate.py

@@ -0,0 +1,63 @@
+import os
+import glob
+
+DOCS_DIR = "external/feather-docs/content/_guides"
+OUT_DIR = "src/assets/docs"
+
+CATEGORY_MAP = {
+    "getting-started": "1. Getting started",
+    "howto": "2. How to",
+    "faq": "3. Faq",
+    "advanced": "4. Advanced",
+    "troubleshooting": "5. Troubleshooting",
+    "help": "6. Help",
+}
+
+if not os.path.isdir(DOCS_DIR):
+    print("feather-docs submodule not found. Run `git submodule update --init --recursive`")
+    exit(1)
+
+outfiles = glob.glob(f"{OUT_DIR}/*.md")
+for file in outfiles:
+    os.remove(file)
+
+files = glob.glob(f"{DOCS_DIR}/*.md")
+
+for file in files:
+    with open(file) as f:
+        doc = f.read()
+
+    if not doc:
+        continue
+
+    # yaml frontmatter missing
+    if doc.count("---") < 2:
+        continue
+
+    _, front, body = doc.split("---", 2)
+    front = {x: y.strip(" \"") for (x, y) in [x.split(':', 1) for x in front.splitlines()[1:]]}
+
+    if not all((x in front) for x in ['category', 'nav_title']):
+        continue
+
+    if front['category'] not in CATEGORY_MAP:
+        continue
+
+    title = front['nav_title'].replace("(", "\\(").replace(")", "\\)")
+
+    # We use this format to insert metadata while preventing it from showing up in QTextBrowser
+    # This is easier than adding item tags to .qrc files and parsing the XML
+    # We need to be able to setSource on a resource directly, otherwise history doesn't work
+    docString = f"""
+[nav_title]: # ({title})
+[category]: # ({CATEGORY_MAP[front['category']]})
+
+## {front['title']}
+{body}
+    """
+
+    _, filename = file.rsplit('/', 1)
+
+    with open(f"{OUT_DIR}/{filename}", 'w') as f:
+        print(filename)
+        f.write(docString)

src/CMakeLists.txt

@@ -29,7 +29,7 @@ if (CHECK_UPDATES)
     add_subdirectory(openpgp)
 endif()
 
-qt_add_resources(RESOURCES assets.qrc assets_tor.qrc)
+qt_add_resources(RESOURCES assets.qrc assets_tor.qrc assets_docs.qrc)
 
 # Compile source files (.h/.cpp)
 file(GLOB SOURCE_FILES

src/CalcWidget.cpp

@@ -101,19 +101,19 @@ void CalcWidget::initComboBox() {
     QList<QString> cryptoKeys = appData()->prices.markets.keys();
     QList<QString> fiatKeys = appData()->prices.rates.keys();
 
-    QStringList enabledCrypto = config()->get(Config::cryptoSymbols).toStringList();
+    QStringList enabledCrypto = conf()->get(Config::cryptoSymbols).toStringList();
     QStringList filteredCryptoKeys;
     for (const auto& symbol : cryptoKeys) {
         if (enabledCrypto.contains(symbol)) {
             filteredCryptoKeys.append(symbol);
         }
     }
 
-    QStringList enabledFiat = config()->get(Config::fiatSymbols).toStringList();
-    auto preferredFiat = config()->get(Config::preferredFiatCurrency).toString();
+    QStringList enabledFiat = conf()->get(Config::fiatSymbols).toStringList();
+    auto preferredFiat = conf()->get(Config::preferredFiatCurrency).toString();
     if (!enabledFiat.contains(preferredFiat) && fiatKeys.contains(preferredFiat)) {
         enabledFiat.append(preferredFiat);
-        config()->set(Config::fiatSymbols, enabledFiat);
+        conf()->set(Config::fiatSymbols, enabledFiat);
     }
     QStringList filteredFiatKeys;
     for (const auto &symbol : fiatKeys) {

src/CalcWidget.ui

@@ -131,13 +131,6 @@
      </item>
     </layout>
    </item>
-   <item>
-    <widget class="Line" name="line">
-     <property name="orientation">
-      <enum>Qt::Horizontal</enum>
-     </property>
-    </widget>
-   </item>
    <item>
     <layout class="QHBoxLayout" name="horizontalLayout">
      <item>

src/CoinsWidget.cpp

@@ -211,24 +211,22 @@ void CoinsWidget::onSweepOutputs() {
 
         QString keyImage = coin->keyImage();
         if (!coin->keyImageKnown()) {
-            QMessageBox::warning(this, "Unable to sweep outputs", "Unable to create transaction: selected output has unknown key image");
+            Utils::showError(this, "Unable to sweep outputs", "Selected output has unknown key image");
             return;
         }
 
         if (coin->spent()) {
-            QMessageBox::warning(this, "Unable to sweep outputs", "Unable to create transaction: selected output was already spent");
+            Utils::showError(this, "Unable to sweep outputs", "Selected output was already spent");
             return;
         }
 
         if (coin->frozen()) {
-            QMessageBox::warning(this, "Unable to sweep outputs", "Unable to create transaction: selected output is frozen.\n\n"
-                                                                  "Thaw the selected output(s) before spending.");
+            Utils::showError(this, "Unable to sweep outputs", "Selected output is frozen", {"Thaw the selected output(s) before spending"}, "freeze_thaw_outputs");
             return;
         }
 
         if (!coin->unlocked()) {
-            QMessageBox::warning(this, "Unable to sweep outputs", "Unable to create transaction: selected output is locked.\n\n"
-                                                                  "Wait until the output has reached the required number of confirmation before spending.");
+            Utils::showError(this, "Unable to sweep outputs", "Selected output is locked", {"Wait until the output has reached the required number of confirmation before spending."});
             return;
         }
 

src/ContactsWidget.cpp

@@ -127,7 +127,7 @@ void ContactsWidget::newContact(QString address, QString name)
 
     bool addressValid = WalletManager::addressValid(address, m_wallet->nettype());
     if (!addressValid) {
-        QMessageBox::warning(this, "Invalid address", "Invalid address");
+        Utils::showError(this, "Unable to add contact", "Invalid address", {"Use 'Tools -> Address checker' to check if the address is valid."}, "add_contact");
         return;
     }
 
@@ -141,12 +141,12 @@ void ContactsWidget::newContact(QString address, QString name)
         });
 
         if (address == address_entry) {
-            QMessageBox::warning(this, "Unable to add contact", "Duplicate address");
+            Utils::showError(this, "Unable to add contact", "Address already exists in contacts", {}, "add_contact");
             ui->contacts->setCurrentIndex(m_model->index(i,0)); // Highlight duplicate address
             return;
         }
         if (name == name_entry) {
-            QMessageBox::warning(this, "Unable to add contact", "Duplicate label");
+            Utils::showError(this, "Unable to add contact", "Label already exists in contacts", {}, "add_contact");
             this->newContact(address, name);
             return;
         }

src/HistoryWidget.cpp

@@ -45,17 +45,17 @@ HistoryWidget::HistoryWidget(Wallet *wallet, QWidget *parent)
 
     connect(ui->btn_moreInfo, &QPushButton::clicked, this, &HistoryWidget::showSyncNoticeMsg);
     connect(ui->btn_close, &QPushButton::clicked, [this]{
-        config()->set(Config::showHistorySyncNotice, false);
+        conf()->set(Config::showHistorySyncNotice, false);
         ui->syncNotice->hide();
     });
 
     connect(m_wallet, &Wallet::walletRefreshed, this, &HistoryWidget::onWalletRefreshed);
 
-    ui->syncNotice->setVisible(config()->get(Config::showHistorySyncNotice).toBool());
+    ui->syncNotice->setVisible(conf()->get(Config::showHistorySyncNotice).toBool());
     ui->history->setHistoryModel(m_model);
 
     // Load view state
-    QByteArray historyViewState = QByteArray::fromBase64(config()->get(Config::GUI_HistoryViewState).toByteArray());
+    QByteArray historyViewState = QByteArray::fromBase64(conf()->get(Config::GUI_HistoryViewState).toByteArray());
     if (!historyViewState.isEmpty()) {
         ui->history->setViewState(historyViewState);
     }
@@ -109,8 +109,8 @@ void HistoryWidget::onResendTransaction() {
 void HistoryWidget::resetModel()
 {
     // Save view state
-    config()->set(Config::GUI_HistoryViewState, ui->history->viewState().toBase64());
-    config()->sync();
+    conf()->set(Config::GUI_HistoryViewState, ui->history->viewState().toBase64());
+    conf()->sync();
 
     ui->history->setModel(nullptr);
 }
@@ -164,8 +164,8 @@ void HistoryWidget::copy(copyField field) {
             case copyField::Description:
                 return tx->description();
             case copyField::Date:
-                return tx->timestamp().toString(QString("%1 %2").arg(config()->get(Config::dateFormat).toString(),
-                                                                     config()->get(Config::timeFormat).toString()));
+                return tx->timestamp().toString(QString("%1 %2").arg(conf()->get(Config::dateFormat).toString(),
+                                                                     conf()->get(Config::timeFormat).toString()));
             case copyField::Amount:
                 return WalletManager::displayAmount(tx->balanceDelta());
             default: