Component Modification Working!

Components can now be modified, with the GpuPage updating accordingly. A bunch of bug fixes too.

Updated lib.rs:
- Updated some links with "<>" brackets to enable for cargo docs

Updated MainWindow class:
- Updated comment headers of "create_gpu_page()" and "close_request()" functions to enable for cargo docs

Updated GpuPage class:
- Removed some old (and now invalid) psuedocode
- Added a "signals()" function for declaring any signals
- Added a signal ("update-views"): this tells the parent GpuPage object to refresh the views stored (and switch back to the correct view if a modification)
- Updated comment headers of "load_views()" and "create_updater()" functions to enable for cargo docs
- Updated some links with "<>" brackets to enable for cargo docs
- Updated ModificationWindow creation to pass a self-reference
- Removed the reload call from the ModificationWindow creation
- Added "none" to the possible properties, giving pretty-label of "None"
- Added check for "none" to "create_updater()" function, to set value to "N/A" rather than attempting a call to the provider
- Added a connect_closure call to self that reloads the views (and switches back to the correct one) when recieving the "update-views" signal
- Added TODO comments next to lists of properties - need to make this a global list, both normal and pretty versions

Updated ModificationWindow class:
- Added a "ParentContainer" struct for holding an optional reference to the parent window: will enable sending a signal to update the parent window when changes are made in this window
- Made "uuid", "old_view_id", "new_view_id", "old_view_title", "new_view_title" all private struct members
- Added "parent_window" public struct member for keeping track of the parent window, stores as reference using "ParentContainer" struct
- Added  "dropdowns" public struct member for keeping track of the dynamic drop down menus and their state
- Modified "update_stored_data()" function to check dropdowns (using struct member "dropdowns") for any modified view components: this enables changing components!
- Commented out a lot of debug print statements
- Switched from "None" to "none" nomenclature for empty dropdowns, with "None" becoming the pretty-label
- Updated "view_components_amount_changed()" function, a scrollwheel template callback, to update the new dropdowns struct member
- Updated comment header of "close_request()" function to enable for cargo docs
- Updated constructor to store referenec to parent in "parent_window" struct member
- Added TODO comments next to lists of properties - need to make this a global list, both normal and pretty versions
- Updated "setup_widgets()" function to update "dropdowns" struct member when creating dynamic dropdowns
- Added a signal emission call ("update-views") to the apply and delete buttons: this tells the parent GpuPage object to refresh the views stored (and switch back to the correct view if a modification)

Updated Formatter class:
- Updated comment header of "format()" function to enable for cargo docs

Signed-off-by: Deren Vural <[email protected]>

Author: Deren Vural

src/formatter/mod.rs

@@ -101,7 +101,7 @@ impl Formatter {
             .expect("`settings` should not be set before calling `setup_settings`.");
     }
 
-    /*
+    /**
      * Name:
      * format
      *

src/gpu_page/imp.rs

@@ -23,7 +23,7 @@ use adwaita::{gio, glib, prelude::*, ViewStack, ViewSwitcherBar};
 use gio::Settings;
 use glib::{
     once_cell::sync::Lazy, once_cell::sync::OnceCell, subclass::InitializingObject, FromVariant,
-    ParamSpec, ToValue, Value,
+    ParamSpec, ToValue, Value, subclass::Signal, subclass::SignalType
 };
 use gtk::{subclass::prelude::*, CompositeTemplate, TemplateChild};
 use std::{cell::Cell, cell::RefCell, rc::Rc};
@@ -90,11 +90,7 @@ impl ObjectSubclass for GpuPage {
  */
 #[gtk::template_callbacks]
 impl GpuPage {
-    // #[template_callback]
-    // fn get_gpu_data(&self, _label: &Label) {
-    //     //
-    //     println!("TEST callback");//TEST
-    // }
+    //
 }
 
 impl GpuPage {
@@ -366,6 +362,38 @@ impl ObjectImpl for GpuPage {
             _ => panic!("Property `{}` does not exist..", pspec.name()),
         }
     }
+
+    /**
+     * Name:
+     * signals
+     *
+     * Description:
+     * Defines the list of signals
+     *
+     * Made:
+     * 07/01/2023
+     *
+     * Made by:
+     * Deren Vural
+     *
+     * Notes:
+     * beware that you need to use kebab-case (<https://en.wikipedia.org/wiki/Letter_case#Kebab_case>)
+     *
+     * <https://gtk-rs.org/gtk4-rs/stable/latest/book/g_object_signals.html>
+     *
+     * SignalType::from(i32::static_type())
+     */
+    fn signals() -> &'static [Signal] {
+        static SIGNALS: Lazy<Vec<Signal>> = Lazy::new(|| {
+            vec![
+                Signal::builder("update-views",
+                    &[SignalType::from(i32::static_type())],
+                    SignalType::from(i32::static_type()))
+                .build()
+            ]
+        });
+        SIGNALS.as_ref()
+    }
 }
 
 /**

src/gpu_page/mod.rs

@@ -24,7 +24,7 @@ use imp::ModificationWindowContainer;
 // Imports
 use adwaita::{gio, glib, Application, ViewStack};
 use gio::Settings;
-use glib::{clone, translate::FromGlib, Object, SourceId};
+use glib::{clone, translate::FromGlib, Object, SourceId, closure_local, closure};
 use gtk::{prelude::*, subclass::prelude::*, Align, Button, Grid, Label, LayoutChild, Orientation};
 use std::{cell::RefMut, sync::Arc, sync::Mutex, sync::MutexGuard};
 
@@ -133,7 +133,7 @@ impl GpuPage {
             .expect("`settings` should be set in `setup_settings`.")
     }
 
-    /*
+    /**
      * Name:
      * load_views
      *
@@ -250,18 +250,14 @@ impl GpuPage {
                                         let app: Application = Application::builder().application_id(APP_ID).build();
 
                                         // Create new modification window
-                                        let new_modification_window: ModificationWindow = ModificationWindow::new(&app, 0, &gpage.property::<String>("uuid"));
+                                        let new_modification_window: ModificationWindow = ModificationWindow::new(&app, 0, &gpage.property::<String>("uuid"), &gpage);
 
                                         // Show new modification window
                                         new_modification_window.show();
 
                                         // Store object and state back in container
                                         modification_window_container.open = true;
                                         modification_window_container.window = Some(new_modification_window);
-
-                                        // Re-create views & properties
-                                        //NOTE: any changes are saved to settings on close
-                                        gpage.load_views();
                                     },
                                     true => {
                                         println!("....window already open");//DEBUG
@@ -276,18 +272,14 @@ impl GpuPage {
                                 let app: Application = Application::builder().application_id(APP_ID).build();
 
                                 // Create modification window
-                                let new_modification_window: ModificationWindow = ModificationWindow::new(&app, 0, &gpage.property::<String>("uuid"));
+                                let new_modification_window: ModificationWindow = ModificationWindow::new(&app, 0, &gpage.property::<String>("uuid"), &gpage);
 
                                 // Show new modification window
                                 new_modification_window.show();
 
                                 // Store object and state back in container
                                 modification_window_container.open = true;
                                 modification_window_container.window = Some(new_modification_window);
-
-                                // Re-create views & properties
-                                //NOTE: any changes are saved to settings on close
-                                gpage.load_views();
                             },
                         }
 
@@ -309,7 +301,7 @@ impl GpuPage {
             // Add object
             new_stack.add_titled(&new_grid, Some("default"), "Default");
             // Add icon
-            //NOTE: see https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/libadwaita/struct.ViewStack.html
+            //NOTE: see <https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/libadwaita/struct.ViewStack.html>
             //      function "add_titled_with_icon" not in stable yet
             let new_item = new_stack.page(&new_grid);
             new_item.set_icon_name(Some("package-x-generic-symbolic"));
@@ -428,18 +420,14 @@ impl GpuPage {
                                             let app: Application = Application::builder().application_id(APP_ID).build();
 
                                             // Create new modification window
-                                            let new_modification_window: ModificationWindow = ModificationWindow::new(&app, index as i32, &gpage.property::<String>("uuid"));
+                                            let new_modification_window: ModificationWindow = ModificationWindow::new(&app, index as i32, &gpage.property::<String>("uuid"), &gpage);
 
                                             // Show new modification window
                                             new_modification_window.show();
 
                                             // Store object and state back in container
                                             modification_window_container.open = true;
                                             modification_window_container.window = Some(new_modification_window);
-
-                                            // Re-create views & properties
-                                            //NOTE: any changes are saved to settings on close
-                                            gpage.load_views();
                                         },
                                         true => {
                                             println!("....window already open");//DEBUG
@@ -454,18 +442,14 @@ impl GpuPage {
                                     let app: Application = Application::builder().application_id(APP_ID).build();
 
                                     // Create modification window
-                                    let new_modification_window: ModificationWindow = ModificationWindow::new(&app, index as i32, &gpage.property::<String>("uuid"));
+                                    let new_modification_window: ModificationWindow = ModificationWindow::new(&app, index as i32, &gpage.property::<String>("uuid"), &gpage);
 
                                     // Show new modification window
                                     new_modification_window.show();
 
                                     // Store object and state back in container
                                     modification_window_container.open = true;
                                     modification_window_container.window = Some(new_modification_window);
-
-                                    // Re-create views & properties
-                                    //NOTE: any changes are saved to settings on close
-                                    gpage.load_views();
                                 },
                             }
 
@@ -491,7 +475,7 @@ impl GpuPage {
                 );
                 // println!("NEW STACK ITEM: `{}`", new_stack_item_name);//TEST
                 // Add icon
-                //NOTE: see https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/libadwaita/struct.ViewStack.html
+                //NOTE: see <https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/stable/latest/docs/libadwaita/struct.ViewStack.html>
                 //      function "add_titled_with_icon" not in stable yet
                 let new_item = new_stack.page(&new_view_grid);
                 new_item.set_icon_name(Some("package-x-generic-symbolic"));
@@ -653,6 +637,7 @@ impl GpuPage {
                     // Decide on title label size
                     let space: i32;
                     let pretty_label: &str;
+                    //TODO: Update to use global list
                     match property.to_owned().as_str() {
                         "util" => {
                             pretty_label = "GPU Utilization";
@@ -690,6 +675,10 @@ impl GpuPage {
                             pretty_label = "Power Usage";
                             space = 8
                         }
+                        "none" => {
+                            pretty_label = "None";
+                            space = 5
+                        }
                         _ => {
                             pretty_label = property;
                             space = 5
@@ -721,7 +710,7 @@ impl GpuPage {
                     // Decide on content label size
                     let space: i32;
                     match property.to_owned().as_str() {
-                        "util" | "fan_speed" | "temp" => space = 5,
+                        "util" | "fan_speed" | "temp" | "none" => space = 5,
                         "memory_usage" | "memory_total" => space = 8,
                         _ => space = 5,
                     }
@@ -758,7 +747,7 @@ impl GpuPage {
         (grid, labels)
     }
 
-    /*
+    /**
      * Name:
      * create_updater
      *
@@ -840,23 +829,36 @@ impl GpuPage {
             match &mut *provider_container {
                 Some(current_provider) => {
                     for property in properties.iter() {
-                        // Grab current Property from provider
-                        match current_provider.get_gpu_data(&uuid, property) {
-                            Ok(property_value) => {
-                                // For each output label of the page
-                                for label in labels_container.iter() {
-                                    // println!("COMPARING AGAINST 1: `{}`", property);
-                                    // println!("COMPARING AGAINST 2: `{}`", label.widget_name());
-
-                                    // Check if correct label
-                                    if *property.to_owned() == label.widget_name() {
-                                        label.set_label(&property_value);
-                                    }
+                        // println!("property: `{}`", property); //TEST
+
+                        if property == "none" {
+                            // Check if correct label
+                            for label in labels_container.iter() {
+                                if *property.to_owned() == label.widget_name() {
+                                    label.set_label("N/A");
+                                    // no break here - could be duplicates
                                 }
                             }
-                            Err(err) => {
-                                println!("panicked when fetching gpu data: `{}`", err);
-                                return Continue(false);
+                        } else {
+                            // Grab current Property from provider
+                            match current_provider.get_gpu_data(&uuid, property) {
+                                Ok(property_value) => {
+                                    // For each output label of the page
+                                    for label in labels_container.iter() {
+                                        // println!("COMPARING AGAINST 1: `{}`", property);
+                                        // println!("COMPARING AGAINST 2: `{}`", label.widget_name());
+
+                                        // Check if correct label
+                                        if *property.to_owned() == label.widget_name() {
+                                            label.set_label(&property_value);
+                                            // no break here - could be duplicates
+                                        }
+                                    }
+                                }
+                                Err(err) => {
+                                    println!("panicked when fetching gpu data: `{}`", err);
+                                    return Continue(false);
+                                }
                             }
                         }
                     }
@@ -895,7 +897,33 @@ impl GpuPage {
      *
      */
     fn setup_widgets(&self) {
+        // Load stored views
         self.load_views();
+
+        // Connect closure to re-load (now updated) stored views when a modification window is closed
+        //NOTE: expected return value seems to be broken - look at imp.rs:395
+        self.connect_closure("update-views", false, closure!(move |gpage: GpuPage, current_view: i32| {
+            // println!("closure parameter: `{}`", current_view); //TEST
+
+            // Reload views
+            // println!("reloading views.."); //TEST
+            gpage.load_views();
+            // println!("views reloaded.."); //TEST
+
+            // If and edit is made (and not a delete)
+            if current_view != -1 {
+                // println!("switching to page: `{}`", current_view); //TEST
+
+                // Set to correct view
+                gpage.imp().view_switcher.stack().unwrap().set_visible_child_name((current_view.to_string() + "_stack_item").as_str());
+            }
+
+            // Return final value
+            //0.to_value()  // "Invalid return value: expected (), got gint",
+            0  // "Invalid return value: expected (), got gint",
+            //() // 'Closure returned no value but the caller expected a value of type gint'
+            //   // 'Closure returned no value but the caller expected a value of type gint'
+        }));
     }
 }
 

src/lib.rs

@@ -92,8 +92,8 @@ pub fn create_app() -> Application {
  * <https://github.com/gtk-rs/gtk4-rs/blob/master/book/listings/todo/5/main.rs>
  * <https://gtk-rs.org/gtk4-rs/stable/latest/book/todo_3.html>
  *
- * https://gtk-rs.org/gtk4-rs/git/book/actions.html
- * https://gtk-rs.org/gtk4-rs/git/docs/gtk4/struct.Window.html#actions
+ * <https://gtk-rs.org/gtk4-rs/git/book/actions.html>
+ * <https://gtk-rs.org/gtk4-rs/git/docs/gtk4/struct.Window.html#actions>
  */
 fn setup_shortcuts(app: &Application) {
     //app.set_accels_for_action("win.filter('All')", &["<Ctrl>a"]);

src/mainwindow/imp.rs

@@ -149,7 +149,7 @@ impl MainWindow {
         }
     }
 
-    /*
+    /**
      * Name:
      * create_gpu_page
      *
@@ -1777,7 +1777,7 @@ impl WidgetImpl for MainWindow {}
  *
  */
 impl WindowImpl for MainWindow {
-    /*
+    /**
      * Name:
      * close_request
      *