dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gimp/app/widgets/gimpdashboard.h

85 lines
4.4 KiB
C
Raw Normal View History

app, menus, icons: add dashboard dockable The dashboard dockable shows the current GEGL cache and swap sizes, and their recent history. It has options to control the update rate and history duration of the data, and an option to warn (by raising/blinking the dialog) when the swap size approaches its limit.
2017-12-19 07:54:17 +08:00
/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpdashboard.h
* Copyright (C) 2017 Ell
*
* This program 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.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
Change the license URL from http://www.gnu.org/licenses/ to https://
2018-07-12 05:27:07 +08:00
* along with this program. If not, see <https://www.gnu.org/licenses/>.
app, menus, icons: add dashboard dockable The dashboard dockable shows the current GEGL cache and swap sizes, and their recent history. It has options to control the update rate and history duration of the data, and an option to warn (by raising/blinking the dialog) when the swap size approaches its limit.
2017-12-19 07:54:17 +08:00
*/
#ifndef __GIMP_DASHBOARD_H__
#define __GIMP_DASHBOARD_H__
#include "gimpeditor.h"
#define GIMP_TYPE_DASHBOARD (gimp_dashboard_get_type ())
#define GIMP_DASHBOARD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_DASHBOARD, GimpDashboard))
#define GIMP_DASHBOARD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_DASHBOARD, GimpDashboardClass))
#define GIMP_IS_DASHBOARD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_DASHBOARD))
#define GIMP_IS_DASHBOARD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_DASHBOARD))
#define GIMP_DASHBOARD_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_DASHBOARD, GimpDashboardClass))
app: various GimpDashboard improvements Refactor GimpDashboard to autogenerate the UI based on a description of the different variables, fields, and groups. Allow individual groups to be expanded/collapsed, and individual fields to be enabled/disabled. Save the relevant state in the dashboard's aux-info. Add fields for the new GeglStats properties, as per GEGL commit 25c39ce6c9bb618f06ac96d118e624be66464d74. The new fields are not enabled by default. Add "reset" action, to clear the history, and reset cumulative data.
2017-12-31 02:43:09 +08:00
typedef struct _GimpDashboardPrivate GimpDashboardPrivate;
typedef struct _GimpDashboardClass GimpDashboardClass;
app, menus, icons: add dashboard dockable The dashboard dockable shows the current GEGL cache and swap sizes, and their recent history. It has options to control the update rate and history duration of the data, and an option to warn (by raising/blinking the dialog) when the swap size approaches its limit.
2017-12-19 07:54:17 +08:00
struct _GimpDashboard
{
app: various GimpDashboard improvements Refactor GimpDashboard to autogenerate the UI based on a description of the different variables, fields, and groups. Allow individual groups to be expanded/collapsed, and individual fields to be enabled/disabled. Save the relevant state in the dashboard's aux-info. Add fields for the new GeglStats properties, as per GEGL commit 25c39ce6c9bb618f06ac96d118e624be66464d74. The new fields are not enabled by default. Add "reset" action, to clear the history, and reset cumulative data.
2017-12-31 02:43:09 +08:00
GimpEditor parent_instance;
app, menus, icons: add dashboard dockable The dashboard dockable shows the current GEGL cache and swap sizes, and their recent history. It has options to control the update rate and history duration of the data, and an option to warn (by raising/blinking the dialog) when the swap size approaches its limit.
2017-12-19 07:54:17 +08:00
app: various GimpDashboard improvements Refactor GimpDashboard to autogenerate the UI based on a description of the different variables, fields, and groups. Allow individual groups to be expanded/collapsed, and individual fields to be enabled/disabled. Save the relevant state in the dashboard's aux-info. Add fields for the new GeglStats properties, as per GEGL commit 25c39ce6c9bb618f06ac96d118e624be66464d74. The new fields are not enabled by default. Add "reset" action, to clear the history, and reset cumulative data.
2017-12-31 02:43:09 +08:00
GimpDashboardPrivate *priv;
app, menus, icons: add dashboard dockable The dashboard dockable shows the current GEGL cache and swap sizes, and their recent history. It has options to control the update rate and history duration of the data, and an option to warn (by raising/blinking the dialog) when the swap size approaches its limit.
2017-12-19 07:54:17 +08:00
};
struct _GimpDashboardClass
{
GimpEditorClass parent_class;
};
app: various GimpDashboard improvements Refactor GimpDashboard to autogenerate the UI based on a description of the different variables, fields, and groups. Allow individual groups to be expanded/collapsed, and individual fields to be enabled/disabled. Save the relevant state in the dashboard's aux-info. Add fields for the new GeglStats properties, as per GEGL commit 25c39ce6c9bb618f06ac96d118e624be66464d74. The new fields are not enabled by default. Add "reset" action, to clear the history, and reset cumulative data.
2017-12-31 02:43:09 +08:00
GType gimp_dashboard_get_type (void) G_GNUC_CONST;
app, icons, menus: add performance-log recording to the dashboard Add an option to record a performance log through the dashboard. The log contains a series of samples of the dashboard variables, as well as the full program backtrace, when available. As such, it essentially acts as a built-in profiler, which allows us to correlate program execution with the information available through the dashboard. It is meant to be used for creating logs to accompany perofrmance-related bug reports, as well as for profiling GIMP during development. The sample frequency defaults to 10 samples per second, but can be overridden using the GIMP_PERFORMANCE_LOG_SAMPLE_FREQUENCY environment variable. Backtraces are included by default when available, but can be suppressed using the GIMP_PERFORMANCE_LOG_NO_BACKTRACE environment variable. Logs are created through the new "record" button at the bottom of the dashboard dialog. When pressed, a file dialog is opened to select the log file, and, once confirmed, data is being recorded to the selected file. Recording is stopped by pressing the "record" button again (we use a highlight to indicate that recording is active.) While recording, the "reset" button is replaced with an "add marker" button, which can be used to add event markers to the log. These can be used to mark events of interest, such as "started painting" and "stopped painting", which then appear in the log as part of the sample stream. Markers are numbered sequentually, and the number of the next (to-be-added) marker appears on the button. Shift- clicking the button adds an empty (description-less) marker, which is only identified by its number; this can be used when markers need to be added quickly. The log is an XML file, containing some extra information (such as the output of "$ gimp -v", and symbol information) in addition to the samples. The data in the file is delta-encoded to reduce the file size, meaning that samples (as well as some other elements) only specify the changes since the previous sample. This adds a necessary decoding step before data can be processed; the next commit adds a tool that does that. There are currently no tools to actually analyze the data -- that's still TBD -- but at least we can start gathering it.
2018-09-02 13:46:27 +08:00
GtkWidget * gimp_dashboard_new (Gimp *gimp,
GimpMenuFactory *menu_factory);
gboolean gimp_dashboard_log_start_recording (GimpDashboard *dashboard,
GFile *file,
GError **error);
gboolean gimp_dashboard_log_stop_recording (GimpDashboard *dashboard,
GError **error);
gboolean gimp_dashboard_log_is_recording (GimpDashboard *dashboard);
void gimp_dashboard_log_add_marker (GimpDashboard *dashboard,
const gchar *description);
void gimp_dashboard_reset (GimpDashboard *dashboard);
void gimp_dashboard_set_update_interval (GimpDashboard *dashboard,
GimpDashboardUpdateInteval update_interval);
GimpDashboardUpdateInteval gimp_dashboard_get_update_interval (GimpDashboard *dashboard);
void gimp_dashboard_set_history_duration (GimpDashboard *dashboard,
GimpDashboardHistoryDuration history_duration);
GimpDashboardHistoryDuration gimp_dashboard_get_history_duration (GimpDashboard *dashboard);
void gimp_dashboard_set_low_swap_space_warning (GimpDashboard *dashboard,
gboolean low_swap_space_warning);
gboolean gimp_dashboard_get_low_swap_space_warning (GimpDashboard *dashboard);
void gimp_dashboard_menu_setup (GimpUIManager *manager,
const gchar *ui_path);
app: allow hiding groups in the dashboard Add a "groups" submenu to the dashboard popup menu, which can be used to control which groups are shown in the dashboard.
2018-04-03 04:24:09 +08:00
app, menus, icons: add dashboard dockable The dashboard dockable shows the current GEGL cache and swap sizes, and their recent history. It has options to control the update rate and history duration of the data, and an option to warn (by raising/blinking the dialog) when the swap size approaches its limit.
2017-12-19 07:54:17 +08:00
#endif /* __GIMP_DASHBOARD_H__ */