refactor: use tl::expected

Author: f0e

CMakeLists.txt

@@ -30,6 +30,7 @@ find_package(SDL3_image CONFIG REQUIRED)
 find_package(Freetype REQUIRED)
 find_package(glad CONFIG REQUIRED)
 find_package(GTest CONFIG REQUIRED)
+find_package(tl-expected CONFIG REQUIRED)
 
 # source files
 file(GLOB_RECURSE COMMON_SOURCES "src/common/*.cpp")
@@ -61,7 +62,7 @@ function(setup_target target)
   target_include_directories(${target} PRIVATE src)
   target_link_libraries(
     ${target} PRIVATE nlohmann_json::nlohmann_json cpr::cpr Boost::system
-                      Boost::filesystem Threads::Threads)
+                      Boost::filesystem Threads::Threads tl::expected)
   target_compile_definitions(${target} PRIVATE NOMINMAX BOOST_FILESYSTEM_NO_LIB
                                                BOOST_FILESYSTEM_STATIC_LINK=1)
   if(WIN32)

src/cli/cli.cpp

@@ -9,18 +9,17 @@ bool cli::run(
 	bool verbose,
 	bool disable_update_check
 ) {
-	auto res = blur.initialise(verbose, preview);
-
-	if (!res.success) { // todo: preview in cli
+	auto init_res = blur.initialise(verbose, preview);
+	if (!init_res) { // todo: preview in cli
 		u::log(L"Blur failed to initialise");
-		u::log("Reason: {}", res.error_message);
+		u::log("Reason: {}", init_res.error());
 		return false;
 	}
 
 	if (!disable_update_check) {
 		auto update_res = Blur::check_updates();
-		if (update_res.success && !update_res.is_latest) {
-			u::log("There's a newer version ({}) available at {}!", update_res.latest_tag, update_res.latest_tag_url);
+		if (update_res && !update_res->is_latest) {
+			u::log("There's a newer version ({}) available at {}!", update_res->latest_tag, update_res->latest_tag_url);
 		}
 	}
 

src/common/blur.cpp

@@ -7,7 +7,7 @@
 #include "config_app.h"
 #include "config_presets.h"
 
-Blur::InitialisationResponse Blur::initialise(bool _verbose, bool _using_preview) {
+tl::expected<void, std::string> Blur::initialise(bool _verbose, bool _using_preview) {
 	resources_path = u::get_resources_path();
 	settings_path = u::get_settings_path();
 
@@ -51,24 +51,15 @@ Blur::InitialisationResponse Blur::initialise(bool _verbose, bool _using_preview
 
 		// didn't use installer, check if dependencies are installed
 		if (!std::filesystem::exists(ffmpeg_path)) {
-			return {
-				.success = false,
-				.error_message = "FFmpeg could not be found. " + manual_troubleshooting_info,
-			};
+			return tl::unexpected("FFmpeg could not be found. " + manual_troubleshooting_info);
 		}
 
 		if (!std::filesystem::exists(ffprobe_path)) {
-			return {
-				.success = false,
-				.error_message = "FFprobe could not be found. " + manual_troubleshooting_info,
-			};
+			return tl::unexpected("FFprobe could not be found. " + manual_troubleshooting_info);
 		}
 
 		if (!std::filesystem::exists(vspipe_path)) {
-			return {
-				.success = false,
-				.error_message = "VapourSynth could not be found. " + manual_troubleshooting_info,
-			};
+			return tl::unexpected("VapourSynth could not be found. " + manual_troubleshooting_info);
 		}
 	}
 	else {
@@ -80,30 +71,21 @@ Blur::InitialisationResponse Blur::initialise(bool _verbose, bool _using_preview
 			ffmpeg_path = *_ffmpeg_path;
 		}
 		else {
-			return {
-				.success = false,
-				.error_message = "FFmpeg could not be found. " + manual_troubleshooting_info,
-			};
+			return tl::unexpected("FFmpeg could not be found. " + manual_troubleshooting_info);
 		}
 
 		if (auto _ffprobe_path = u::get_program_path("ffprobe")) {
 			ffprobe_path = *_ffprobe_path;
 		}
 		else {
-			return {
-				.success = false,
-				.error_message = "FFprobe could not be found. " + manual_troubleshooting_info,
-			};
+			return tl::unexpected("FFprobe could not be found. " + manual_troubleshooting_info);
 		}
 
 		if (auto _vspipe_path = u::get_program_path("vspipe")) {
 			vspipe_path = *_vspipe_path;
 		}
 		else {
-			return {
-				.success = false,
-				.error_message = "VapourSynth could not be found. " + manual_troubleshooting_info,
-			};
+			return tl::unexpected("VapourSynth could not be found. " + manual_troubleshooting_info);
 		}
 	}
 
@@ -125,10 +107,6 @@ Blur::InitialisationResponse Blur::initialise(bool _verbose, bool _using_preview
 	std::thread([this] {
 		initialise_rife_gpus();
 	}).detach();
-
-	return {
-		.success = true,
-	};
 }
 
 void Blur::initialise_base_temp_path() {
@@ -187,10 +165,10 @@ bool Blur::remove_temp_path(const std::filesystem::path& temp_path) {
 	}
 }
 
-updates::UpdateCheckRes Blur::check_updates() {
+tl::expected<updates::UpdateCheckRes, std::string> Blur::check_updates() {
 	auto config = config_app::get_app_config();
 	if (!config.check_updates)
-		return { .success = false };
+		return updates::UpdateCheckRes{};
 
 	return updates::is_latest_version(config.check_beta);
 }

src/common/blur.h

@@ -23,12 +23,7 @@ class Blur { // todo: switch all the classes which could be namespaces into name
 	std::filesystem::path ffprobe_path;
 	std::filesystem::path vspipe_path;
 
-	struct InitialisationResponse {
-		bool success;
-		std::string error_message;
-	};
-
-	InitialisationResponse initialise(bool _verbose, bool _using_preview);
+	tl::expected<void, std::string> initialise(bool _verbose, bool _using_preview);
 
 	void cleanup() const;
 
@@ -37,7 +32,7 @@ class Blur { // todo: switch all the classes which could be namespaces into name
 	[[nodiscard]] std::optional<std::filesystem::path> create_temp_path(const std::string& folder_name) const;
 	static bool remove_temp_path(const std::filesystem::path& temp_path);
 
-	static updates::UpdateCheckRes check_updates();
+	static tl::expected<updates::UpdateCheckRes, std::string> check_updates();
 	static void update(
 		const std::string& tag,
 		const std::optional<std::function<void(const std::string& text, bool done)>>& progress_callback = {}

src/common/common_pch.h

@@ -26,6 +26,7 @@
 // libs
 #include <nlohmann/json.hpp>
 #include <cpr/cpr.h>
+#include <tl/expected.hpp>
 
 #include <boost/process.hpp>
 #include <boost/asio.hpp>

src/common/config_blur.cpp

@@ -111,7 +111,7 @@ void config_blur::create(const std::filesystem::path& filepath, const BlurSettin
 	output << "blur amount tied to fps: " << (current_settings.blur_amount_tied_to_fps ? "true" : "false") << "\n";
 }
 
-config_blur::ConfigValidationResponse config_blur::validate(BlurSettings& config, bool fix) {
+tl::expected<void, std::string> config_blur::validate(BlurSettings& config, bool fix) {
 	std::set<std::string> errors;
 
 	if (!u::contains(SVP_INTERPOLATION_PRESETS, config.advanced.svp_interpolation_preset)) {
@@ -141,10 +141,10 @@ config_blur::ConfigValidationResponse config_blur::validate(BlurSettings& config
 			config.advanced.interpolation_blocksize = DEFAULT_CONFIG.advanced.interpolation_blocksize;
 	}
 
-	return ConfigValidationResponse{
-		.success = errors.empty(),
-		.error = u::join(errors, " "),
-	};
+	if (!errors.empty())
+		return tl::unexpected(u::join(errors, " "));
+
+	// ok:)
 }
 
 BlurSettings config_blur::parse(const std::filesystem::path& config_filepath) {
@@ -294,7 +294,7 @@ BlurSettings config_blur::get_config(const std::filesystem::path& config_filepat
 	return parse(cfg_path);
 }
 
-BlurSettings::ToJsonResult BlurSettings::to_json() const {
+tl::expected<nlohmann::json, std::string> BlurSettings::to_json() const {
 	nlohmann::json j;
 
 	j["blur"] = this->blur;
@@ -358,23 +358,17 @@ BlurSettings::ToJsonResult BlurSettings::to_json() const {
 	j["interpolation_mask_area"] = this->advanced.interpolation_mask_area;
 
 	auto rife_model_path = get_rife_model_path();
-	if (!rife_model_path.success) {
-		return {
-			.success = false,
-			.error_message = rife_model_path.error_message,
-		};
-	}
-	j["rife_model"] = *rife_model_path.rife_model_path;
+	if (!rife_model_path)
+		return tl::unexpected(rife_model_path.error());
+
+	j["rife_model"] = *rife_model_path;
 
 	j["manual_svp"] = this->advanced.manual_svp;
 	j["super_string"] = this->advanced.super_string;
 	j["vectors_string"] = this->advanced.vectors_string;
 	j["smooth_string"] = this->advanced.smooth_string;
 
-	return {
-		.success = true,
-		.json = j,
-	};
+	return j;
 }
 
 BlurSettings::BlurSettings() {
@@ -405,7 +399,7 @@ void BlurSettings::verify_gpu_encoding() {
 }
 
 // NOLINTBEGIN(readability-convert-member-functions-to-static) other platforms need it
-BlurSettings::GetRifeModelResult BlurSettings::get_rife_model_path() const {
+tl::expected<std::filesystem::path, std::string> BlurSettings::get_rife_model_path() const {
 	// NOLINTEND(readability-convert-member-functions-to-static)
 	std::filesystem::path rife_model_path;
 
@@ -419,16 +413,10 @@ BlurSettings::GetRifeModelResult BlurSettings::get_rife_model_path() const {
 #	endif
 
 	if (!std::filesystem::exists(rife_model_path))
-		return {
-			.success = false,
-			.error_message = std::format("RIFE model '{}' could not be found", this->advanced.rife_model),
-		};
+		return tl::unexpected(std::format("RIFE model '{}' could not be found", this->advanced.rife_model));
 #endif
 
-	return {
-		.success = true,
-		.rife_model_path = rife_model_path,
-	};
+	return rife_model_path;
 }
 
 void BlurSettings::set_fastest_rife_gpu() {
@@ -440,9 +428,10 @@ void BlurSettings::set_fastest_rife_gpu() {
 
 	if (sample_video_exists) {
 		auto rife_model_path = BlurSettings::get_rife_model_path();
-		if (rife_model_path.success) {
+
+		if (rife_model_path) {
 			int fastest_gpu_index =
-				u::get_fastest_rife_gpu_index(blur_copy.rife_gpus, *rife_model_path.rife_model_path, sample_video_path);
+				u::get_fastest_rife_gpu_index(blur_copy.rife_gpus, *rife_model_path, sample_video_path);
 
 			this->rife_gpu_index = fastest_gpu_index;
 			u::log("set rife_gpu_index to the fastest gpu ({})", fastest_gpu_index);

src/common/config_blur.h

@@ -77,21 +77,9 @@ struct BlurSettings {
 
 	void verify_gpu_encoding();
 
-	struct ToJsonResult {
-		bool success;
-		std::optional<nlohmann::json> json;
-		std::string error_message;
-	};
-
-	[[nodiscard]] ToJsonResult to_json() const;
-
-	struct GetRifeModelResult {
-		bool success;
-		std::optional<std::filesystem::path> rife_model_path;
-		std::string error_message;
-	};
+	[[nodiscard]] tl::expected<nlohmann::json, std::string> to_json() const;
 
-	[[nodiscard]] GetRifeModelResult get_rife_model_path() const;
+	[[nodiscard]] tl::expected<std::filesystem::path, std::string> get_rife_model_path() const;
 	void set_fastest_rife_gpu();
 };
 
@@ -112,12 +100,7 @@ namespace config_blur {
 
 	void create(const std::filesystem::path& filepath, const BlurSettings& current_settings = BlurSettings());
 
-	struct ConfigValidationResponse {
-		bool success;
-		std::string error;
-	};
-
-	ConfigValidationResponse validate(BlurSettings& config, bool fix);
+	tl::expected<void, std::string> validate(BlurSettings& config, bool fix);
 
 	BlurSettings parse(const std::filesystem::path& config_filepath);
 	BlurSettings parse_global_config();