Render the Settings page and the Library via view models #227

Merged
savanni merged 4 commits from kifu/settings-view-model into main 2024-03-22 03:36:13 +00:00
10 changed files with 146 additions and 206 deletions
Showing only changes of commit db9efbaedd - Show all commits

View File

@ -35,7 +35,7 @@ macro_rules! define_config {
$($name($struct)),+ $($name($struct)),+
} }
#[derive(Clone, Debug)] #[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct Config { pub struct Config {
values: std::collections::HashMap<ConfigName, ConfigOption>, values: std::collections::HashMap<ConfigName, ConfigOption>,
} }

View File

@ -1,6 +1,23 @@
/*
Copyright 2024, Savanni D'Gerinel <savanni@luminescent-dreams.com>
This file is part of Kifu.
Kifu is free software: you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
Kifu is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License along with Kifu. If not, see <https://www.gnu.org/licenses/>.
*/
use crate::{ use crate::{
database::Database, database::Database,
types::{AppState, Config, ConfigOption, GameState, LibraryPath, Player, Rank}, types::{AppState, Config, ConfigOption, GameState, LibraryPath, Player, Rank},
settings,
}; };
use async_std::{ use async_std::{
channel::{Receiver, Sender}, channel::{Receiver, Sender},
@ -18,8 +35,10 @@ pub trait Observable<T> {
fn subscribe(&self) -> Receiver<T>; fn subscribe(&self) -> Receiver<T>;
} }
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Clone, Debug, Serialize, Deserialize)]
pub enum CoreRequest { pub enum CoreRequest {
Settings(settings::SettingsRequest)
/*
ChangeSetting(ChangeSettingRequest), ChangeSetting(ChangeSettingRequest),
CreateGame(CreateGameRequest), CreateGame(CreateGameRequest),
Home, Home,
@ -27,6 +46,7 @@ pub enum CoreRequest {
PlayingField, PlayingField,
PlayStone(PlayStoneRequest), PlayStone(PlayStoneRequest),
StartGame, StartGame,
*/
} }
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
@ -66,15 +86,22 @@ impl From<HotseatPlayerRequest> for Player {
} }
} }
/*
#[derive(Clone, Debug, Serialize, Deserialize)] #[derive(Clone, Debug, Serialize, Deserialize)]
pub enum CoreResponse { pub enum CoreResponse {
Settings(settings::SettingsResponse)
/*
ConfigurationView(ConfigurationView), ConfigurationView(ConfigurationView),
HomeView(HomeView), HomeView(HomeView),
PlayingFieldView(PlayingFieldView), PlayingFieldView(PlayingFieldView),
UpdatedConfigurationView(ConfigurationView), UpdatedConfigurationView(ConfigurationView),
}
*/ */
}
impl From<settings::SettingsResponse> for CoreResponse {
fn from(r: settings::SettingsResponse) -> Self {
Self::Settings(r)
}
}
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub enum CoreNotification { pub enum CoreNotification {
@ -92,6 +119,7 @@ pub struct Core {
impl Core { impl Core {
pub fn new(config: Config) -> Self { pub fn new(config: Config) -> Self {
println!("config: {:?}", config);
Self { Self {
config: Arc::new(RwLock::new(config)), config: Arc::new(RwLock::new(config)),
// state, // state,
@ -123,6 +151,12 @@ impl Core {
self.library.read().unwrap() self.library.read().unwrap()
} }
pub async fn dispatch(&self, request: CoreRequest) -> CoreResponse {
match request {
CoreRequest::Settings(request) => settings::handle(&self, request).await.into(),
}
}
/* /*
pub async fn dispatch(&self, request: CoreRequest) -> CoreResponse { pub async fn dispatch(&self, request: CoreRequest) -> CoreResponse {
match request { match request {

View File

@ -1,7 +1,7 @@
extern crate config_derive; extern crate config_derive;
mod api; mod api;
pub use api::{Core, CoreNotification, Observable}; pub use api::{Core, CoreNotification, CoreRequest, CoreResponse, Observable};
mod board; mod board;
pub use board::*; pub use board::*;
@ -11,3 +11,4 @@ mod database;
mod types; mod types;
pub use types::{BoardError, Color, Config, ConfigOption, LibraryPath, Player, Rank, Size}; pub use types::{BoardError, Color, Config, ConfigOption, LibraryPath, Player, Rank, Size};
pub mod settings;

37
kifu/core/src/settings.rs Normal file
View File

@ -0,0 +1,37 @@
/*
Copyright 2024, Savanni D'Gerinel <savanni@luminescent-dreams.com>
This file is part of Kifu.
Kifu is free software: you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
Kifu is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License along with Kifu. If not, see <https://www.gnu.org/licenses/>.
*/
use crate::{types::LibraryPath, Core, Config};
use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum SettingsRequest {
Get,
Set(Config),
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct SettingsResponse(pub Config);
pub async fn handle(model: &Core, request: SettingsRequest) -> SettingsResponse {
match request {
SettingsRequest::Get => SettingsResponse(model.get_config()),
SettingsRequest::Set(config) => {
model.set_config(config).await;
SettingsResponse(model.get_config())
}
}
}

View File

@ -14,20 +14,19 @@ General Public License for more details.
You should have received a copy of the GNU General Public License along with Kifu. If not, see <https://www.gnu.org/licenses/>. You should have received a copy of the GNU General Public License along with Kifu. If not, see <https://www.gnu.org/licenses/>.
*/ */
use crate::CoreApi;
use adw::prelude::*; use adw::prelude::*;
/* use async_std::task::{block_on, spawn};
use gio::resources_lookup_data; use kifu_core::settings::SettingsResponse;
use glib::IsA; use kifu_core::CoreResponse;
use gtk::STYLE_PROVIDER_PRIORITY_USER; use kifu_core::{settings::SettingsRequest, Config, CoreRequest};
*/
use kifu_core::{Config, Core};
use std::sync::{Arc, RwLock}; use std::sync::{Arc, RwLock};
use crate::{view_models::HomeViewModel, view_models::SettingsViewModel}; use crate::view_models::HomeViewModel;
use crate::views::SettingsView;
#[derive(Clone)] #[derive(Clone)]
enum AppView { enum AppView {
Settings(SettingsViewModel),
Home(HomeViewModel), Home(HomeViewModel),
} }
@ -52,15 +51,15 @@ pub struct AppWindow {
// Overlays are for transient content, such as about and settings, which can be accessed from // Overlays are for transient content, such as about and settings, which can be accessed from
// anywhere but shouldn't be part of the main application flow. // anywhere but shouldn't be part of the main application flow.
panel_overlay: gtk::Overlay, panel_overlay: gtk::Overlay,
core: Core, core: CoreApi,
// Not liking this, but I have to keep track of the settings view model separately from // Not liking this, but I have to keep track of the settings view model separately from
// anything else. I'll have to look into this later. // anything else. I'll have to look into this later.
settings_view_model: Arc<RwLock<Option<SettingsViewModel>>>, settings_view_model: Arc<RwLock<Option<SettingsView>>>,
} }
impl AppWindow { impl AppWindow {
pub fn new(app: &adw::Application, core: Core) -> Self { pub fn new(app: &adw::Application, core: CoreApi) -> Self {
let window = Self::setup_window(app); let window = Self::setup_window(app);
let header = Self::setup_header(); let header = Self::setup_header();
let panel_overlay = Self::setup_panel_overlay(); let panel_overlay = Self::setup_panel_overlay();
@ -87,22 +86,52 @@ impl AppWindow {
} }
pub fn open_settings(&self) { pub fn open_settings(&self) {
let view_model = SettingsViewModel::new(&self.window, self.core.clone(), { // This should return instantly and allow the UI to continue being functional. However,
// some tests indicate that this may not actually be working correctly, and that a
// long-running background thread may delay things.
glib::spawn_future_local({
let s = self.clone(); let s = self.clone();
move || { async move {
s.close_overlay(); let CoreResponse::Settings(SettingsResponse(settings)) = s
.core
.dispatch(CoreRequest::Settings(SettingsRequest::Get))
.await;
let view_model = SettingsView::new(
&s.window,
settings,
{
let s = s.clone();
move |config| {
glib::spawn_future_local({
let s = s.clone();
async move {
s.core.dispatch(CoreRequest::Settings(SettingsRequest::Set(
config,
))).await
}
});
s.close_overlay();
}
},
{
let s = s.clone();
move || {
s.close_overlay();
}
},
);
s.panel_overlay.add_overlay(&view_model);
*s.settings_view_model.write().unwrap() = Some(view_model);
} }
}); });
self.panel_overlay.add_overlay(&view_model.widget);
*self.settings_view_model.write().unwrap() = Some(view_model);
} }
pub fn close_overlay(&self) { pub fn close_overlay(&self) {
let mut vm = self.settings_view_model.write().unwrap(); let mut view = self.settings_view_model.write().unwrap();
match *vm { match *view {
Some(ref mut view_model) => { Some(ref mut settings) => {
self.panel_overlay.remove_overlay(&view_model.widget); self.panel_overlay.remove_overlay(settings);
*vm = None; *view = None;
} }
None => {} None => {}
} }
@ -140,7 +169,7 @@ impl AppWindow {
gtk::Overlay::new() gtk::Overlay::new()
} }
fn setup_content(core: Core) -> (adw::NavigationView, Vec<AppView>) { fn setup_content(core: CoreApi) -> (adw::NavigationView, Vec<AppView>) {
let stack = adw::NavigationView::new(); let stack = adw::NavigationView::new();
let mut content = Vec::new(); let mut content = Vec::new();
@ -152,19 +181,7 @@ impl AppWindow {
.child(&nothing_page) .child(&nothing_page)
.build(), .build(),
); );
content.push(AppView::Home(HomeViewModel::new(core.clone()))); content.push(AppView::Home(HomeViewModel::new(core)));
/*
match *core.library() {
Some(_) => {
}
None => {
let settings_vm = SettingsViewModel::new(core.clone());
let _ = stack.push(&adw::NavigationPage::new(&settings_vm.widget, "Settings"));
content.push(AppView::Settings(settings_vm));
}
}
*/
(stack, content) (stack, content)
} }

View File

@ -22,31 +22,20 @@ pub use app_window::AppWindow;
mod view_models; mod view_models;
mod views; mod views;
use async_std::task::yield_now; use async_std::task::{spawn, yield_now};
use kifu_core::{Core, Observable}; use kifu_core::{Core, Observable, CoreRequest, CoreResponse};
use std::{rc::Rc, sync::Arc}; use std::{rc::Rc, sync::Arc};
use tokio::runtime::Runtime; use tokio::runtime::Runtime;
#[derive(Clone)] #[derive(Clone)]
pub struct CoreApi { pub struct CoreApi {
pub rt: Arc<Runtime>,
pub core: Core, pub core: Core,
} }
impl CoreApi { impl CoreApi {
/* pub async fn dispatch(&self, request: CoreRequest) -> CoreResponse {
pub fn dispatch(&self, request: CoreRequest) { self.core.dispatch(request).await
/*
spawn({
/*
let gtk_tx = self.gtk_tx.clone();
let core = self.core.clone();
async move { gtk_tx.send(core.dispatch(request).await) }
*/
});
*/
} }
*/
} }
pub fn perftrace<F, A>(trace_name: &str, f: F) -> A pub fn perftrace<F, A>(trace_name: &str, f: F) -> A

View File

@ -90,7 +90,8 @@ fn setup_app_configuration_action(app: &adw::Application, app_window: AppWindow)
println!("setup_app_configuration_action"); println!("setup_app_configuration_action");
let action = ActionEntry::builder("show_settings") let action = ActionEntry::builder("show_settings")
.activate(move |_app: &adw::Application, _, _| { .activate(move |_app: &adw::Application, _, _| {
app_window.open_settings(); let app_window = app_window.clone();
app_window.open_settings()
}) })
.build(); .build();
app.add_action_entries([action]); app.add_action_entries([action]);
@ -109,28 +110,7 @@ fn main() {
let config = load_config(&app_id); let config = load_config(&app_id);
let runtime = Arc::new( let core = Core::new(config.clone());
tokio::runtime::Builder::new_multi_thread()
.enable_all()
.build()
.unwrap(),
);
/*
let config_path = std::env::var("CONFIG")
.map(std::path::PathBuf::from)
.or({
std::env::var("HOME").map(|base| {
let mut config_path = std::path::PathBuf::from(base);
config_path.push(".config");
config_path.push("kifu");
config_path
})
})
.expect("no config path could be found");
*/
let core = Core::new(config);
spawn({ spawn({
let notifier = core.subscribe(); let notifier = core.subscribe();
@ -138,70 +118,22 @@ fn main() {
handler(notifier, app_id) handler(notifier, app_id)
}); });
/*
let core_handle = runtime.spawn({
let core = core.clone();
async move {
core.run().await;
}
});
*/
let app = adw::Application::builder() let app = adw::Application::builder()
.application_id("com.luminescent-dreams.kifu-gtk") .application_id("com.luminescent-dreams.kifu-gtk")
.resource_base_path("/com/luminescent-dreams/kifu-gtk") .resource_base_path("/com/luminescent-dreams/kifu-gtk")
.build(); .build();
app.connect_activate({ app.connect_activate({
let runtime = runtime.clone();
move |app| { move |app| {
let mut app_window = AppWindow::new(app, core.clone()); let core_api = CoreApi { core: core.clone() };
let app_window = AppWindow::new(app, core_api);
match *core.library() {
Some(_) => {}
None => app_window.open_settings(),
}
setup_app_configuration_action(app, app_window.clone()); setup_app_configuration_action(app, app_window.clone());
/*
let api = CoreApi {
rt: runtime.clone(),
core: core.clone(),
};
*/
/*
let action_config = gio::SimpleAction::new("show-config", None);
action_config.connect_activate({
let api = api.clone();
move |_, _| {
api.dispatch(CoreRequest::OpenConfiguration);
}
});
app.add_action(&action_config);
*/
app_window.window.present(); app_window.window.present();
/*
gtk_rx.attach(None, {
let api = api.clone();
move |message| {
perftrace("handle_response", || {
handle_response(api.clone(), &app_window, message)
});
glib::ControlFlow::Continue
}
});
*/
// api.dispatch(CoreRequest::Home);
} }
}); });
println!("running the gtk loop"); println!("running the gtk loop");
app.run(); app.run();
/* let _ = runtime.block_on(core_handle); */
} }

View File

@ -16,18 +16,22 @@ You should have received a copy of the GNU General Public License along with Kif
use crate::LocalObserver; use crate::LocalObserver;
use kifu_core::{Core, CoreNotification}; use kifu_core::{Core, CoreNotification};
use crate::CoreApi;
use std::sync::Arc; use std::sync::Arc;
/// Home controls the view that the user sees when starting the application if there are no games in progress. It provides a window into the database, showing a list of recently recorded games. It also provides the UI for starting a new game. This will render an empty database view if the user hasn't configured a database yet. /// Home controls the view that the user sees when starting the application if there are no games in progress. It provides a window into the database, showing a list of recently recorded games. It also provides the UI for starting a new game. This will render an empty database view if the user hasn't configured a database yet.
#[derive(Clone)] #[derive(Clone)]
pub struct HomeViewModel { pub struct HomeViewModel {
core: Core, /*
core: CoreApi,
notification_observer: Arc<LocalObserver<CoreNotification>>, notification_observer: Arc<LocalObserver<CoreNotification>>,
widget: gtk::Box, widget: gtk::Box,
*/
} }
impl HomeViewModel { impl HomeViewModel {
pub fn new(core: Core) -> Self { pub fn new(core: CoreApi) -> Self {
/*
let notification_observer = LocalObserver::new(&core, |msg| { let notification_observer = LocalObserver::new(&core, |msg| {
println!("HomeViewModel handler called with message: {:?}", msg) println!("HomeViewModel handler called with message: {:?}", msg)
}); });
@ -37,6 +41,8 @@ impl HomeViewModel {
notification_observer: Arc::new(notification_observer), notification_observer: Arc::new(notification_observer),
widget: gtk::Box::new(gtk::Orientation::Horizontal, 0), widget: gtk::Box::new(gtk::Orientation::Horizontal, 0),
} }
*/
Self {}
} }
/// Create a new game with the given parameters. /// Create a new game with the given parameters.

View File

@ -28,6 +28,3 @@ pub use game_review_view_model::GameReviewViewModel;
mod home_view_model; mod home_view_model;
pub use home_view_model::HomeViewModel; pub use home_view_model::HomeViewModel;
mod settings_view_model;
pub use settings_view_model::SettingsViewModel;

View File

@ -1,73 +0,0 @@
/*
Copyright 2024, Savanni D'Gerinel <savanni@luminescent-dreams.com>
This file is part of Kifu.
Kifu is free software: you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
Kifu is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License along with Kifu. If not, see <https://www.gnu.org/licenses/>.
*/
use crate::{views, views::SettingsView, LocalObserver};
use async_std::task::spawn;
use gtk::prelude::*;
use kifu_core::{Config, Core, CoreNotification};
use std::{sync::Arc, rc::Rc};
/// SettingsViewModel
///
/// Listens for messages from the core, and serves as intermediary between the Settings UI and the
/// core. Because it needs to respond to events from the core, it owns the widget, which allows it
/// to tell the widget to update after certain events.
#[derive(Clone)]
pub struct SettingsViewModel {
core: Core,
// Technically, Settings doesn't care about any events from Core. We will keep this around for
// now as reference, until something which does care shows up.
notification_observer: Arc<LocalObserver<CoreNotification>>,
pub widget: views::SettingsView,
}
impl SettingsViewModel {
pub fn new(parent: &impl IsA<gtk::Window>, core: Core, on_close: impl Fn() + 'static) -> Self {
let on_close = Arc::new(on_close);
let notification_observer = LocalObserver::new(&core, |msg| {
println!("SettingsViewModel called with message: {:?}", msg)
});
let config = core.get_config();
let widget = SettingsView::new(
parent,
config,
{
let core = core.clone();
let on_close = on_close.clone();
move |new_config| {
spawn({
let core = core.clone();
on_close();
async move {
println!("running set_config in the background");
core.set_config(new_config).await;
}
});
}
},
move || on_close(),
);
Self {
core: core.clone(),
notification_observer: Arc::new(notification_observer),
widget,
}
}
}