Feature show changelog (#82)

* show changelog on update

* cosmetic changes

* remove unsafe pointer member

* tidy

* add version to window title

* add missing include vector

Author: krupkat

xpano/constants.h

@@ -72,6 +72,7 @@ constexpr float kMaxMatchConf = 0.4f;
 
 const std::string kAppConfigFilename = "app_config.alpaca";
 const std::string kUserConfigFilename = "user_config.alpaca";
+const std::string kChangelogFilename = "CHANGELOG.md";
 
 constexpr int kCropEdgeTolerance = 10;
 constexpr int kAutoCropSamplingDistance = 512;

xpano/gui/layout.cc

@@ -4,13 +4,13 @@
 #include <imgui_internal.h>
 
 #include "xpano/constants.h"
+#include "xpano/utils/imgui_.h"
 
 namespace xpano::gui::layout {
 
 namespace {
 void InitDockSpaceFirstTime(ImGuiID dockspace_id, ImVec2 viewport_size) {
-  const auto text_base_width = ImGui::CalcTextSize("A").x;
-  const auto sidebar_width = kSidebarWidth * text_base_width;
+  const auto sidebar_width = utils::imgui::DpiAwareSize(kSidebarWidth, 0).x;
 
   ImGuiID dock_main_id = dockspace_id;
   ImGuiID dock_id_thumbnails = ImGui::DockBuilderSplitNode(

xpano/gui/panels/about.cc

@@ -2,6 +2,7 @@
 
 #include <algorithm>
 #include <iterator>
+#include <optional>
 #include <sstream>
 #include <string>
 #include <utility>
@@ -11,6 +12,7 @@
 
 #include "xpano/constants.h"
 #include "xpano/utils/future.h"
+#include "xpano/utils/imgui_.h"
 #include "xpano/utils/text.h"
 
 namespace xpano::gui {
@@ -59,30 +61,45 @@ AboutPane::AboutPane(std::future<utils::Texts> licenses)
 
 void AboutPane::Show() { show_ = true; }
 
+std::optional<utils::Text> AboutPane::GetText(const std::string& name) {
+  if (licenses_future_.valid()) {
+    WaitForLicenseLoading();
+  }
+  auto result = std::find_if(
+      licenses_.begin(), licenses_.end(),
+      [&name](const utils::Text& text) { return text.name == name; });
+  if (result == licenses_.end()) {
+    return {};
+  }
+  return *result;
+}
+
+void AboutPane::WaitForLicenseLoading() {
+  auto temp_licenses = licenses_future_.get();
+  std::copy(temp_licenses.begin(), temp_licenses.end(),
+            std::back_inserter(licenses_));
+}
+
 void AboutPane::Draw() {
   if (!show_) {
     return;
   }
 
+  if (licenses_.size() == 1 &&
+      xpano::utils::future::IsReady(licenses_future_)) {
+    WaitForLicenseLoading();
+  }
+
   ImGuiWindowFlags window_flags = ImGuiWindowFlags_NoDocking |
                                   ImGuiWindowFlags_NoCollapse |
                                   ImGuiWindowFlags_NoSavedSettings;
 
-  const auto text_base_width = ImGui::CalcTextSize("A").x;
-  ImGui::SetNextWindowSize(ImVec2(kAboutBoxWidth * text_base_width,
-                                  kAboutBoxHeight * ImGui::GetTextLineHeight()),
-                           ImGuiCond_Once);
+  ImGui::SetNextWindowSize(
+      utils::imgui::DpiAwareSize(kAboutBoxWidth, kAboutBoxHeight),
+      ImGuiCond_Once);
   ImGui::Begin("About", &show_, window_flags);
 
   ImGui::SetNextItemWidth(ImGui::GetContentRegionAvail().x);
-
-  if (licenses_.size() == 1 &&
-      xpano::utils::future::IsReady(licenses_future_)) {
-    auto temp_licenses = licenses_future_.get();
-    std::copy(temp_licenses.begin(), temp_licenses.end(),
-              std::back_inserter(licenses_));
-  }
-
   if (ImGui::BeginCombo("##license_combo",
                         licenses_[current_license_].name.c_str())) {
     for (int i = 0; i < licenses_.size(); ++i) {
@@ -93,20 +110,8 @@ void AboutPane::Draw() {
     ImGui::EndCombo();
   }
 
-  ImGui::BeginChild("License", ImVec2(0, 0));
-  const auto& license = licenses_[current_license_];
-
-  ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0, 0));
-  ImGuiListClipper clipper;
-  int num_lines = static_cast<int>(license.lines.size());
-  clipper.Begin(num_lines);
-  while (clipper.Step()) {
-    for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) {
-      ImGui::TextUnformatted(license.lines[i].c_str());
-    }
-  }
-  ImGui::PopStyleVar();
-  ImGui::EndChild();
+  utils::imgui::DrawScrollableText("License",
+                                   licenses_[current_license_].lines);
 
   ImGui::End();
 }

xpano/gui/panels/about.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <future>
+#include <optional>
 
 #include "xpano/utils/text.h"
 
@@ -12,7 +13,11 @@ class AboutPane {
   void Draw();
   void Show();
 
+  std::optional<utils::Text> GetText(const std::string& name);
+
  private:
+  void WaitForLicenseLoading();
+
   bool show_ = false;
   int current_license_ = 0;
   std::future<utils::Texts> licenses_future_;

xpano/gui/panels/warning_pane.cc

@@ -1,10 +1,12 @@
 #include "xpano/gui/panels/warning_pane.h"
 
 #include <imgui.h>
+#include <spdlog/fmt/fmt.h>
 #include <spdlog/spdlog.h>
 
 #include "xpano/constants.h"
-#include "xpano/gui/action.h"
+#include "xpano/utils/imgui_.h"
+#include "xpano/version_fmt.h"
 
 namespace xpano::gui {
 
@@ -15,18 +17,17 @@ const char* WarningMessage(WarningType warning) {
       return "Only 8-bit stitching pipeline is implemented!\nHigher bit depth "
              "images are converted to 8-bit.";
     case WarningType::kFirstTimeLaunch:
-      return "Your friendly panorama stitching app:\n"
-             " - default settings are designed to work out of the box with "
-             "most images\n"
-             " - hover over the little question marks for detailed "
-             "instructions";
+      return "Your friendly panorama stitching app";
     case WarningType::kUserPrefBreakingChange:
-      return "The user settings format has changed, reverting to defaults.";
+      return "The user settings format has "
+             "changed, reverting to defaults.";
     case WarningType::kUserPrefCouldntLoad:
       return "Couldn't load user settings, reverting to defaults.";
     case WarningType::kUserPrefResetOnRequest:
       return "User settings were reset to default values,\nyou can keep "
              "experimenting!";
+    case WarningType::kNewVersion:
+      return "Xpano was updated!";
     default:
       return "";
   }
@@ -36,6 +37,8 @@ const char* Title(WarningType warning) {
   switch (warning) {
     case WarningType::kFirstTimeLaunch:
       return "Welcome to Xpano!";
+    case WarningType::kNewVersion:
+      return "Version update";
     case WarningType::kUserPrefResetOnRequest:
       return "Info";
     default:
@@ -51,10 +54,14 @@ bool EnableSnooze(WarningType warning) {
       return false;
   }
 }
+
 }  // namespace
 
 void WarningPane::Draw() {
-  if (current_warning_ == WarningType::kNone && !pending_warnings_.empty()) {
+  if (current_warning_ == WarningType::kNone) {
+    if (pending_warnings_.empty()) {
+      return;
+    }
     Show(pending_warnings_.front());
     pending_warnings_.pop();
   }
@@ -65,12 +72,12 @@ void WarningPane::Draw() {
   if (ImGui::BeginPopupModal(Title(current_warning_), nullptr,
                              ImGuiWindowFlags_AlwaysAutoResize)) {
     ImGui::TextUnformatted(WarningMessage(current_warning_));
+    DrawExtra(current_warning_);
     ImGui::Spacing();
     ImGui::Separator();
     ImGui::Spacing();
 
-    const auto text_base_width = ImGui::CalcTextSize("A").x;
-    if (ImGui::Button("OK", ImVec2(text_base_width * kWideButtonWidth, 0))) {
+    if (ImGui::Button("OK", utils::imgui::DpiAwareSize(kWideButtonWidth, 0))) {
       ImGui::CloseCurrentPopup();
       current_warning_ = WarningType::kNone;
     }
@@ -89,10 +96,48 @@ void WarningPane::Draw() {
   }
 }
 
+void WarningPane::DrawExtra(WarningType warning) {
+  switch (warning) {
+    case WarningType::kFirstTimeLaunch: {
+      ImGui::Text(
+          " - default settings are designed to work out of the box with most "
+          "images");
+      ImGui::Text(
+          " - hover over the little question marks for detailed instructions:");
+      ImGui::SameLine();
+      utils::imgui::InfoMarker(
+          "(?)", "You can try importing a whole directory at once");
+      break;
+    }
+    case WarningType::kNewVersion: {
+      ImGui::TextUnformatted(new_version_message_.c_str());
+      if (changelog_) {
+        ImGui::Spacing();
+        ImGui::Separator();
+        ImGui::Spacing();
+        utils::imgui::DrawScrollableText(
+            "Changelog", changelog_->lines,
+            utils::imgui::DpiAwareSize(kAboutBoxWidth, kAboutBoxHeight / 2));
+      }
+      break;
+    }
+    default:
+      break;
+  }
+}
+
 void WarningPane::Queue(WarningType warning) {
   pending_warnings_.push(warning);
 }
 
+void WarningPane::QueueNewVersion(version::Triplet previous_version,
+                                  std::optional<utils::Text> changelog) {
+  pending_warnings_.push(WarningType::kNewVersion);
+  new_version_message_ = fmt::format(" - from version {} to version {}",
+                                     previous_version, version::Current());
+  changelog_ = std::move(changelog);
+}
+
 void WarningPane::Show(WarningType warning) {
   if (!dont_show_again_.contains(warning)) {
     ImGui::OpenPopup(Title(warning));

xpano/gui/panels/warning_pane.h

@@ -1,9 +1,12 @@
 #pragma once
 
+#include <optional>
 #include <queue>
+#include <string>
 #include <unordered_set>
 
-#include "xpano/gui/action.h"
+#include "xpano/utils/text.h"
+#include "xpano/version.h"
 
 namespace xpano::gui {
 
@@ -13,13 +16,17 @@ enum class WarningType {
   kFirstTimeLaunch,
   kUserPrefBreakingChange,
   kUserPrefCouldntLoad,
-  kUserPrefResetOnRequest
+  kUserPrefResetOnRequest,
+  kNewVersion
 };
 
 class WarningPane {
  public:
   void Draw();
+  void DrawExtra(WarningType warning);
   void Queue(WarningType warning);
+  void QueueNewVersion(version::Triplet previous_version,
+                       std::optional<utils::Text> changelog);
 
  private:
   void Show(WarningType warning);
@@ -28,6 +35,9 @@ class WarningPane {
 
   std::queue<WarningType> pending_warnings_;
   std::unordered_set<WarningType> dont_show_again_;
+
+  std::string new_version_message_;
+  std::optional<utils::Text> changelog_;
 };
 
 }  // namespace xpano::gui

xpano/gui/pano_gui.cc

@@ -27,6 +27,7 @@
 #include "xpano/utils/config.h"
 #include "xpano/utils/future.h"
 #include "xpano/utils/imgui_.h"
+#include "xpano/version.h"
 
 template <>
 struct fmt::formatter<xpano::gui::StatusMessage> : formatter<std::string> {
@@ -252,12 +253,16 @@ WarningType GetWarningType(utils::config::LoadingStatus loading_status) {
 PanoGui::PanoGui(backends::Base* backend, logger::Logger* logger,
                  const utils::config::Config& config,
                  std::future<utils::Texts> licenses)
-    : plot_pane_(backend),
-      thumbnail_pane_(backend),
+    : options_(config.user_options),
       log_pane_(logger),
+      about_pane_(std::move(licenses)),
       bugreport_pane_(logger),
-      options_(config.user_options),
-      about_pane_(std::move(licenses)) {
+      plot_pane_(backend),
+      thumbnail_pane_(backend) {
+  if (config.app_state.xpano_version != version::Current()) {
+    warning_pane_.QueueNewVersion(config.app_state.xpano_version,
+                                  about_pane_.GetText(kChangelogFilename));
+  }
   if (config.user_options_status != utils::config::LoadingStatus::kSuccess) {
     warning_pane_.Queue(GetWarningType(config.user_options_status));
   }

xpano/main.cc

@@ -38,6 +38,7 @@
 #include "xpano/utils/resource.h"
 #include "xpano/utils/sdl_.h"
 #include "xpano/utils/text.h"
+#include "xpano/version_fmt.h"
 
 #if !SDL_VERSION_ATLEAST(2, 0, 17)
 #error This backend requires SDL 2.0.17+ because of SDL_RenderGeometry() function
@@ -96,9 +97,10 @@ int main(int /*unused*/, char** /*unused*/) {
 
   // Setup SDL Window + Renderer
   auto window_flags = SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI;
+  auto window_title = fmt::format("Xpano {}", xpano::version::Current());
   SDL_Window* window =
-      SDL_CreateWindow("Xpano", SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED,
-                       config.app_state.window_width,
+      SDL_CreateWindow(window_title.c_str(), SDL_WINDOWPOS_CENTERED,
+                       SDL_WINDOWPOS_CENTERED, config.app_state.window_width,
                        config.app_state.window_height, window_flags);
 
   SDL_Renderer* renderer = SDL_CreateRenderer(

xpano/utils/imgui_.cc

@@ -4,6 +4,7 @@
 #include <filesystem>
 #include <optional>
 #include <utility>
+#include <vector>
 
 #include <imgui.h>
 #include <imgui_impl_sdlrenderer.h>
@@ -82,4 +83,25 @@ std::string InitIniFilePath(
                        : ini_file_name;
 }
 
+void DrawScrollableText(const char* label,
+                        const std::vector<std::string>& lines, ImVec2 size) {
+  ImGui::BeginChild(label, size);
+  ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(0, 0));
+  ImGuiListClipper clipper;
+  int num_lines = static_cast<int>(lines.size());
+  clipper.Begin(num_lines);
+  while (clipper.Step()) {
+    for (int i = clipper.DisplayStart; i < clipper.DisplayEnd; i++) {
+      ImGui::TextUnformatted(lines[i].c_str());
+    }
+  }
+  ImGui::PopStyleVar();
+  ImGui::EndChild();
+}
+
+ImVec2 DpiAwareSize(int width, int height) {
+  return {static_cast<float>(width) * ImGui::CalcTextSize("A").x,
+          static_cast<float>(height) * ImGui::GetTextLineHeight()};
+}
+
 }  // namespace xpano::utils::imgui