gem-graph-client/include/widget.h

/**
 * @file
 * widgets hierarchy header
 *
 * This file is part of Gem-graph.
 *
 * @cond LICENSE
 * Copyright © 2021 Libre en Communs <contact@a-lec.org>
 * Copyright © 2021-2024 Adrien Bourmault <neox@a-lec.org>
 * Copyright © 2021-2024 Jean Sirmai <jean@a-lec.org>
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * This program 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 Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * @endcond
 */


#pragma once
#include <gtk-4.0/gtk/gtk.h>

/******************************************************************************/
/*                                W I N D O W S                               */
/******************************************************************************/
#define W_MY_SCREEN 1920   /**<   1920 x 960  =  ad hoc  (pour mon écran)) */
#define H_MY_SCREEN 1000   /**<   Full HD (1920 x 1080 pixels) */

#define W_TEXT_WINDOW 550  /**<   ad hoc  (mais sans conséquences ici) */
#define H_TEXT_WINDOW H_MY_SCREEN /**< == */


//    called  in signal / switch_state_rules_data() / gtk_window_set_child()
//    defined in widget / dispatch

GtkWindow *widget_get_main_window();
GtkWindow *widget_get_dialog_window();
GtkWindow *widget_get_text_window();


//    called  in widget / dispatch.c / on_windows_activation()
//    defined in widget / topbar / dispatch.c
//         -     widget / topbar / dialog.c
//         -     widget / topbar / polytext.c
//   (after                        gtk_application_window_new (app) x 3)

void widget_design_main_window   (GtkWindow *main_window, GtkApplication *app);
void widget_design_dialog_window (GtkWindow *main_window, GtkWindow *dialog_window);
void widget_design_text_window   (GtkWindow *main_window, GtkWindow *text_window);


/******************************************************************************/
/*                                 W I D G E T S                              */
/******************************************************************************/
#define W_TREE 160                   /**< arbitrary */
#define W_DO_UNDO_REDO_BOX 1300      /**< arbitrary */
#define W_XYZ_BOX 62                 /**< arbitrary */
#define H_XYZ_BOX 200                /**< arbitrary */
#define H_E_COLI 760                 /**< arbitrary */
#define H_OBJECTS_SITUATIONS 130     /**< arbitrary */
#define W_COMPARATOR 64              /**< arbitrary */
#define W_RULES_USE 90               /**< arbitrary */

#define W_IMAGE_800 800              /**< arbitrary */
#define W_IMAGE_100 100              /**< arbitrary */



/******************************************************************************/
/*                                  T O P B A R                               */
/******************************************************************************/
//    called  in widget / topbar / dispatch.c / widget_design_main_window()
//    defined in topbar / left.c

const char *widget_get_btt_label_synth();
const char *widget_get_btt_label_state();
const char *widget_get_btt_label_rules();
const char *widget_get_btt_label_data();

//    called  in widget / topbar / dispatch.c / widget_design_main_window()
//    defined in widget / topbar / left.c
//         -     widget / topbar / right.c

void window_design_topbar_center (GtkWidget *topbar);
void window_design_topbar_left (GtkWidget *header_bar);
void window_design_topbar_right (GtkWidget *header_bar, GtkApplication *app);


//    called  in signal.c / fsm_get_state_rules_data()
//    defined in widget / synth / dispatch.c
//         -     widget / state / dispatch.c
//         -     widgetvoid on_windows_activation (GtkApplication *app) / rules / dispatch.c
//         -     widget / data / dispatch.c
//         -     widget / measure / dispatch.c

GtkWidget *widget_get_topbar(GtkApplication *app);
void *widget_get_page_synth();   //  in : widget / synth / dispatch.c
void *widget_get_page_state();   //  in : widget / state / dispatch.c
void *widget_get_page_data();    //  in : widget / data / dispatch.c
void *widget_get_page_measure(); //  in : widget / measure / dispatch.c
//void *widget_get_page_engine();  //  in : fsm / engine / engine.c

/*  The rules page consists of two half-pages in a GtkPaned widget :
 *  - on the left,  widgets for controlling or editing all the rules.
 *  - on the right, widgets for controlling or editing the selected rule.
 *  This distribution is therefore moved into signal switch_state_rules_data()
 *  and the previous "widget_get_rules_page()" function which was in:
 *  widget / rules / dispatch.c is replaced (2024-09-10) by the two functions :
 *  - widget_get_all_rules_left_pane()       in widget / all_rules / dispatch
 *  - widget_get_selected_rule_right_pane()  in widget / one_rule / dispatch */

#define ALL_VS_SELECTED 340                   /**< arbitrary */

/******************************************************************************/
/*                                   S Y N T H                                */
/******************************************************************************/
//    call: widget / synth / dispatch.c / widget_get_synth_page()
//    def: widget / synth / time.c
//                                  repartitions.c  WIP
//                                  correlations.c  WIP

#define H_PARTITION_SYNTH 1600                /**< arbitrary */
#define W_PARTITION_SYNTH 400                 /**< arbitrary */

void *widget_get_time_dependent();
void *widget_get_space_vs_non_time_dependent();
void *widget_get_non_time_dependent();


/******************************************************************************/
/*                                   S T A T E                                */
/******************************************************************************/
//    call: widget / state / dispatch.c / widget_get_state_page()
//    def: widget / state / middle
//    def: widget / state / bottom

#define PARTITION_STATE_TOP 600                  /**< arbitrary */
#define PARTITION_SPACE_VS_CONTROLS_1 920        /**< arbitrary */
#define PARTITION_SPACE_VS_CONTROLS_2 800        /**< arbitrary */
#define PARTITION_SPACE_VS_CAMERA_IN_STATE 1850  /**< arbitrary */
#define PARTITION_SPACE_VS_CAMERA_IN_SYNTH 1560  /**< arbitrary */

void *widget_get_space_view (int partition_space_vs_camera);    //  middle
void *widget_get_graph_view_control();                          //  middle

void *widget_get_space_edit_control();  //  bottom
void *widget_get_sequence_control();    //  bottom


//    call: widget / state / top.c / get_situations_box()
//    call: prefer.c
//    def: widget / state / top.c

void widget_set_situations_value (int value);
void widget_set_objects_value (int rank, int value);
int widget_get_object_transparency (int i);


//    call: signal.c
//    def: widget / state / middle


void widget_reset_XYZ_in_state_pane();
/*
void widget_reset_XYZ_scrollbars_rule();
void widget_reset_XYZ_scrollbars_state();
void widget_reset_XYZ_scrollbars_synth();
*/

/******************************************************************************/
/*                             A L L    R U L E S                             */
/******************************************************************************/
/******************************************************************************/
/*                             O N E     R U L E                              */
/******************************************************************************/
//    call: widget / rules / dispatch.c / widget_get_rules_page()
//    def: widget / rules / tree_tools / dispatch.c    (= left)
//    def: widget / rules / selected / dispatch.c      (= right)

#define LIST_W 190                 /**< arbitrary */
#define LIST_H 114                 /**< arbitrary */

void *widget_get_pane_all_rules_left();
void *widget_get_pane_selected_rule_right();

//void *widget_get_rule_geometry_and_algebra();

//    call: widget / rules / tree_tools / dispatch.c / widget_get_all_rules_left_pane()
//    def: widget / rules / tree_tools / pilot_box.c
//    def: widget / rules / tree_tools / freq.c

void *widget_get_rules_pilot_box();     // pilot_box.c
void *widget_get_rules_tree_tools();    // pilot_box.c
void *widget_get_rules_use();           // freq.c


//    call: widget / rules / selected / dispatch.c / widget_get_one_rule_right_pane()
//    def: widget / rules / selected / dispatch.c
//    def: widget / rules / selected / edit.c
//    def: widget / rules / selected / enquire.c

void *widget_get_selected_rule();       //  dispatch.c
void *widget_get_rule_edition_tools();  //  one_rule/geometry/edit_tools
void *widget_get_rule_investigation_tools();  //  one_rule/geometry/investigate

//    call: widget / rules / selected / dispatch.c / widget_get_selected_rule()
//    def: widget / rules / selected / text.c
//    def: widget / rules / selected / image.c

void *widget_get_selected_rule_algebra();
void *widget_get_selected_rule_geometry();
void *widget_get_selected_rule_conditions_list_btt();
void *widget_get_selected_rule_assignations_list_btt();
void *widget_get_selected_rule_identity_btt();

//    def: widget / rules / selected / wip_menu.c
GtkEntry widget_set_item_text (GtkWidget *list_box, const char *text, bool editable);
void *widget_get_selected_rule_camera();
void *widget_get_selected_rule_before_after();

/******************************************************************************/
/*                                    D A T A                                 */
/******************************************************************************/
//    call: widget / results / dispatch / widget_get_page_data()
//    def: widget / results / organize.c
//                                    display.c

#define H_PARTITION_RESULTS 140                 /**< arbitrary */

void *widget_get_results_box_organize();
void *widget_get_results_box_display();
void *widget_get_results_box_time ();


/******************************************************************************/
/*                                T R E E                                     */
/******************************************************************************/


/** phantom documentation used to test the functioning of doxygen */

struct TreeNode_t {
    gchar *text;        /**< *text   phantom documentation */
    struct TreeNode_t
        *child,         /**< *child  phantom documentation */
        *next;          /**< *next   phantom documentation */
};

struct TreeNode_t *widget_create_user_rules_tree_node (const gchar* text);

void widget_add_tree_child_node (struct TreeNode_t *parent, struct TreeNode_t *child); // def: util/tree

void *widget_get_user_rules_tree ();
    // def:   widget/rules/tree_tools/labo.c
    // call:  widget/rules/tree_tools/pilot_box.c  widget_get_rules_tree_tools()


/******************************************************************************/
/*                                 T E X T S                                  */
/******************************************************************************/
//    called by : widget / topbar / polytext.c
//    texts  in : data / text

void *widget_get_text_from_address (gchar *text_name);

char *widget_get_address_text_theory ();
char *widget_get_address_text_practice ();
char *widget_get_address_text_alpha_index (); // def: widget/topbar/dispatch  
                                              // call widget/topbar/modal (47))


/******************************************************************************/
/*                                I M A G E S                                 */
/******************************************************************************/
//                      images    in :  data / image /
//                      used by      :  widget / rules.c

void *widget_get_an_impression_of_what_a_rules_comparator_could_be();

/******************************************************************************/
/*                                   L A B O                                  */
/******************************************************************************/
//                  now in : widget / rules / tree_tools
//                  called by tree.c / widget_get_user_rules_tree()

void widget_let_us_create_a_complex_useless_and_expensive_tree (struct TreeNode_t *tree_root);


/******************************************************************************/
/*                                M E N U                                     */
/******************************************************************************/


/******************************************************************************/
/*                               M E A S U R E S                              */
/******************************************************************************/
//    called  by : signal.c
//    def: widget / measure / dispatch.c

void *widget_measure_new();
//    La séquence logique à suivre pour créer une nouvelle mesure
void *widget_measure_do_select_rules_first();
void *widget_measure_do_depends_on_one_or_two_events();
void *widget_measure_do_depends_on_a_single_event();
void *widget_measure_do_depends_on_two_events();
void *widget_measure_do_select_a_second_rules_set();
void *widget_measure_do_choose_an_event_type();
void *widget_measure_do_correlate();
void *widget_measure_do_insert_in_measurements_list();
void *widget_measure_do_end_creation_of_measurement_process();

//    Les cinq types de mesures possibles
void *widget_measure_event_occurences_nb();
void *widget_measure_event_occurences_dates();
void *widget_measure_event_occurences_situations();
void *widget_measure_time_elapsed_between_two_events();
void *widget_measure_third_event_occurences_in_between();