gint gkrellm_plugin_export_label(GkrellmMonitor *mon_plugin, gchar *mon_name, gchar key, gchar *(*func)(gchar key, gchar *which)); void gkrellm_plugin_cancel_label(GkrellmMonitor *mon_plugin, gint id);Monitors must be updated to call this to get a plugin's label (currently net monitor only).
gchar *gkrellm_plugin_get_exported_label(GkrellmMonitor *mon, gchar key, gchar *which);For an example of these, I've patched GKrellM2-show_ip to export its ip address string for a net interface to the builtin Net monitor. With the plugin enabled, you can enter a "$A" variable in the Net monitor "Format String for Chart Labels" to diplay an IP address returned from GKrellM2-show_ip.
For gkrellmd server plugins:
GkrellmdTicks *gkrellmd_ticks(void);
gint gkrellmd_get_timer_ticks(void);
[monitor-name] config line 0 config line 1 ... [/monitor-name]gkrellmd plugins can read the config lines with:
const gchar *gkrellmd_config_getline(GkrellmdMonitor *mon);
gboolean gkrellm_client_send_to_server(gchar *key_name, gchar *line); void gkrellmd_client_input_connect(GkrellmdMonitor *mon, void (*func)(GkrellmdClient *, gchar *));
GkrellmDecal *gkrellm_create_decal_text_markup(GkrellmPanel *p, gchar *string, GkrellmTextstyle *ts, GkrellmStyle *style, gint x, gint y, gint w); void gkrellm_decal_text_markup_insert(GkrellmDecal *d, gchar *s, GkrellmTextstyle *ts, gint x_off, gint y_off); void gkrellm_decal_text_nth_inserted_set_offset(GkrellmDecal *d, gint n, gint x_off, gint y_off); void gkrellm_decal_text_nth_inserted_get_offset(GkrellmDecal *d, gint n, gint *x_off, gint *y_off); void gkrellm_config_instant_apply(GkrellmMonitor *mon); GtkTreeSelection *gkrellm_gtk_scrolled_selection(GtkTreeView *treeview, GtkWidget *box, GtkSelectionMode s_mode, GtkPolicyType h_policy, GtkPolicyType v_policy, void (*func_cb)(), gpointer data); void gkrellm_text_markup_extents(PangoFontDescription *font_desc, gchar *text, gint len, gint *width, gint *height, gint *baseline, gint *y_ink); gint gkrellm_gdk_string_markup_width(PangoFontDescription *, gchar *); gint gkrellm_gdk_text_markup_width(PangoFontDescription *font_desc, const gchar *string, gint len); void gkrellm_gdk_draw_string_markup(GdkDrawable *drawable, PangoFontDescription *font, GdkGC *gc, gint x, gint y, gchar *string); void gkrellm_gdk_draw_text_markup(GdkDrawable *drawable, PangoFontDescription *font, GdkGC *gc, gint x, gint y, gchar *string, gint len);
void gkrellm_panel_label_get_position(GkrellmStyle *style,
gint *x_position, gint *y_off);
void gkrellm_draw_decal_markup(GkrellmPanel *p, GkrellmDecal *d, gchar *text);
void gkrellm_decal_scroll_text_set_markup(GkrellmPanel *p,
GkrellmDecal *d, gchar *text);
The gkrellm_decal_scroll_text_set_text() function introduced in 2.2.0
no longer uses markup.
#if !GKRELLM_CHECK_VERSION(2,2,0) #define gkrellm_gdk_string_width gdk_string_width #endif
General new functions:void gkrellm_decal_get_size(GkrellmDecal *d, gint *w, gint *h); void gkrellm_decal_text_set_offset(GkrellmDecal *d, gint x, gint y); void gkrellm_decal_text_get_offset(GkrellmDecal *d, gint *x, gint *y); void gkrellm_chart_reuse_text_format(GkrellmChart *cp); gchar *gkrellm_get_hostname(void);New functions to minimize Pango drawing when scrolling text:void gkrellm_decal_scroll_text_set_text(GkrellmPanel *p, GkrellmDecal *d, gchar *text); void gkrellm_decal_scroll_text_get_size(GkrellmDecal *d, gint *w, gint *h); void gkrellm_decal_scroll_text_align_center(GkrellmDecal *d, gboolean center); void gkrellm_decal_scroll_text_horizontal_loop(GkrellmDecal *d, gboolean loop); void gkrellm_decal_scroll_text_vertical_loop(GkrellmDecal *d, gboolean loop);Some convenience functions for transitioning from GdkFont to PangoFontDescription:void gkrellm_text_extents(PangoFontDescription *font_desc, gchar *text, gint len, gint *width, gint *height, gint *baseline, gint *y_ink); gint gkrellm_gdk_string_width(PangoFontDescription *, gchar *); void gkrellm_gdk_draw_string(GdkDrawable *drawable, PangoFontDescription *font, GdkGC *gc, gint x, gint y, gchar *string); void gkrellm_gdk_draw_text(GdkDrawable *drawable, PangoFontDescription *font, GdkGC *gc, gint x, gint y, gchar *string, gint len);New functions to implement client/server capable plugins:/* -------- gkrellm client plugin functions ----------- */ gboolean gkrellm_client_mode(void); void gkrellm_client_plugin_get_setup(gchar *key_name, void (*setup_func_cb)(gchar *str)); void gkrellm_client_plugin_serve_data_connect(GkrellmMonitor *mon, gchar *key_name, void (*func_cb)(gchar *line)); void gkrellm_client_plugin_reconnect_connect(gchar *key_name, void (*func_cb)()); /* -------- gkrellmd server plugin functions ----------- */ void gkrellmd_plugin_serve_setup(GkrellmdMonitor *mon, gchar *name, gchar *line); void gkrellmd_need_serve(GkrellmdMonitor *mon); void gkrellmd_set_serve_name(GkrellmdMonitor *mon, const gchar *name); void gkrellmd_serve_data(GkrellmdMonitor *mon, gchar *line); void gkrellmd_add_serveflag_done(gboolean *); /* -------- Small set of useful gkrellmd plugin functions -- */ void gkrellmd_free_glist_and_data(GList **list_head); gchar *gkrellmd_dup_token(gchar **string, gchar *delimeters); gboolean gkrellmd_dup_string(gchar **dst, gchar *src);Changes for version 2.1.23 - 2.1.28
noneChanges for version 2.1.22
Fix omission of check_func in alert plugin interface. Replace gkrellm_alert_plugin_connect() with:void gkrellm_alert_plugin_alert_connect(GkrellmAlertPlugin *gap, void (*alarm_func)(), void (*warn_func)(), void (*update_func)(), void (*check_func)(), void (*destroy_func)());(changes the API, but no plugins are using this yet).Changes for version 2.1.17 - 2.1.21
noneChanges for version 2.1.16
Added a plugin API for alerts:void gkrellm_alert_get_alert_state(GkrellmAlert *alert, gboolean *alarm_state, gboolean *warn_state); GkrellmAlertPlugin *gkrellm_alert_plugin_add(GkrellmMonitor *mon, gchar *name); void gkrellm_alert_plugin_connect(GkrellmAlertPlugin *gap, void (*alarm_func)(), void (*warn_func)(), void (*update_func)(), void (*destroy_func)()); void gkrellm_alert_plugin_config_connect(GkrellmAlertPlugin *gap, gchar *tab_name, void (*config_create_func)(), void (*config_done_func), void (*config_save_func)(),void (*config_load_func)()); gchar *gkrellm_alert_plugin_config_get_id_string(GkrellmAlert *alert); void gkrellm_alert_plugin_alert_attach(GkrellmAlertPlugin *gap, GkrellmAlert *alert, gpointer data); void gkrellm_alert_plugin_alert_detach(GkrellmAlertPlugin *gap, GkrellmAlert *alert); gpointer gkrellm_alert_plugin_get_data(GkrellmAlertPlugin *gap, GkrellmAlert *alert); void gkrellm_alert_plugin_command_process(GkrellmAlert *alert, gchar *src, gchar *dst, gint dst_size);Other new functions:GtkWidget *gkrellm_gtk_category_vbox(GtkWidget *box, gchar *category_header, gint header_pad, gint box_pad, gboolean pack_start); void gkrellm_remove_launcher(GkrellmLauncher *launch);
`pkg-config gkrellm --cflags` `pkg-config gkrellm --libs`New functions:
void gkrellm_decal_text_clear(GkrellmDecal *d); void gkrellm_decal_text_insert(GkrellmDecal *d, gchar *s, GkrellmTextstyle *ts, gint x_off, gint y_off); GkrellmDecal *gkrellm_create_decal_text_with_height(GkrellmPanel *p, GkrellmTextstyle *ts, GkrellmStyle *style, gint x, gint y, gint w, gint h, gint y_baseline); void gkrellm_chartconfig_callback_block(GkrellmChartconfig *, gboolean);
GkrellmPiximage *gkrellm_piximage_new_from_inline(const guint8 *data, gboolean copy_pixels); gboolean gkrellm_load_piximage_from_inline(gchar *name, const guint8 *data, GkrellmPiximage **image, gchar *subdir, gboolean copy_pixels); void gkrellm_alert_commands_config(GkrellmAlert *alert, gboolean alarm, gboolean warn); void gkrellm_reset_alert_soft(GkrellmAlert *alert);See the GKrellM2 plugin programmers reference for descriptions.
void gkrellm_panel_label_on_top_of_decals(GkrellmPanel *p, gboolean mode); gboolean gkrellm_alert_is_activated(GkrellmAlert *alert); void gkrellm_alert_dup(GkrellmAlert **ap, GkrellmAlert *a_src); void gkrellm_alert_config_create_connect(GkrellmAlert *alert, void (*func)(), gpointer data); void gkrellm_alert_command_process_connect(GkrellmAlert *alert, void (*func)(), gpointer data); gboolean gkrellm_alert_decal_visible(GkrellmAlert *alert); void gkrellm_alert_set_delay(GkrellmAlert *alert, gint delay); void gkrellm_alert_delay_config(GkrellmAlert *alert, gint step, gint high, gint low); void gkrellm_gtk_alert_button(GtkWidget *box, GtkWidget **button, gboolean expand, gboolean fill, gint pad, gboolean pack_start, void (*cb_func)(), gpointer data);The GKrellM2 plugin programmers reference is updated with these functions and now includes a link to a tutorial demo-alert.c.
gkrellm_load_piximae("foo", foo_xpm, &foo_piximage, FOO_STYLE_NAME);
#if defined(GKRELLM_HAVE_THEME_SCALE)
/* New function scales to multiple of frame height and does not require
| the plugin to maintain a pixmap and mask.
*/
foo_decal = gkrellm_make_scaled_decal_pixmap(panel, foo_piximage, style,
N_FOO_FRAMES, -1, -1, 0, 0);
#else
gkrellm_scale_piximage_to_pixmap(foo_piximage, &foo_pixmap,
&foo_mask, 0, 0);
foo_decal = gkrellm_create_decal_pixmap(p, foo_pixmap, foo_mask,
N_FOO_FRAMES, style, -1, -1);
#endif
However, if the plugin needs to maintain the pixmap and mask, you can
handle things yourself by
scaling the decal frame height by the theme_scale value and
then creating the pixmap height to be a multiple of the frame height:
#if defined(GKRELLM_HAVE_THEME_SCALE) h = gdk_pixbuf_get_height(foo_piximage->pixbuf) / N_FOO_FRAMES; h *= gkrellm_get_theme_scale(); /* New function */ h *= N_FOO_FRAMES; w = -1; /* Scales to drawn image size * theme_scale */ #else h = 0; /* Will scale to drawn image size */ w = 0; #endif gkrellm_scale_piximage_to_pixmap(foo_piximage, &foo_pixmap, &foo_mask, w, h); foo_decal = gkrellm_create_decal_pixmap(panel, foo_pixmap, foo_mask, N_FOO_FRAMES, style, -1, -1);Code that places decals relative to margins or to other decal/krell positions and sizes should be fine, but if you place at hardwired locations, the x,y location values might need to be scaled by gkrellm_get_theme_scale() for things to look right when the user changes the theme scale.
gkrellm_spacers_set_types(GkrellmMonitor *mon, gint top, gint bottom);where top and bottom are GKRELLM_SPACER_CHART or GKRELLM_SPACER_METER. Hybrid monitors can now make this call to let gkrellm know what it is doing. See the builtin mem.c and my plugin gkrellmss (version 2.1) for examples of its usage.
Style *gkrellm_meter_style_by_name(gchar *name); Style *gkrellm_panel_style_by_name(gchar *name); Style *gkrellm_chart_style_by_name(gchar *name);which provide for using a custom style with values set with StyleMeter or StylePanel lines in the gkrellmrc. If you have extra krells you want to allow to be themed, this can clean up your code by eliminating a bunch of gkrellm_get_gkrellmrc_integer() or gkrellm_get_gkrellmrc_string() calls. See the Themes file and gkrellmss.c in GKrellMSS 0.4 (when I release it) for a working example of this.
Style margin changes for more layout control. Usually these will be set by a theme author in the gkrellmrc:
void gkrellm_set_krell_expand(Style *, gchar *); void gkrellm_insert_krell_nth(Panel *, Krell *, gint); void gkrellm_insert_decal_nth(Panel *, Decal *, gint); gboolean gkrellm_in_decal(Decal *, GdkEventButton *); void gkrellm_decal_button_connect(DecalButton *, void (*func)(), void *); void gkrellm_decal_button_right_connect(DecalButton *, void (*func)(), void *); void gkrellm_set_button_sensitive(DecalButton *, gboolean); void gkrellm_hide_button(DecalButton *); void gkrellm_show_button(DecalButton *);The DecalButton callback function prototype adds a "gpointer data" so you don't have to reference button->data.
void gkrellm_set_krell_margins(Panel *, Krell *k, gint, gint); void gkrellm_move_krell_yoff(Panel *, Krell *, gint); void gkrellm_draw_decal_on_chart(Chart *, Decal *, gint, gint); void gkrellm_move_decal(Panel *, Decal *, gint, gint); void gkrellm_decal_on_top_layer(Decal *, gboolean);
Look at the revised demos in the programmers reference. Also look at the bottom of gkrellm_public_proto.h for the list of functions that should be replaced.
Looking ahead a bit (some months?) when I get to 1.1.0 I want the gkrellm namespace to be cleaned up. I'm defining that to mean that if you do a "nm -u plugin.so" the undefined symbols expected to link to gkrellm will be only GK and gkrellm_XXX symbols. Starting with 1.0.4 gkrellm_private_proto.h is no longer included by gkrellm.h and it is not installed in the include directory. I have temporarily moved some symbols affecting a few plugins from private to public proto.h. I hope I moved enough so that all current plugins I know of will still compile. The plan is when 1.1.0 arrives I will do the "Cut Here" at the bottom of gkrellm_public_proto.h, so source will need to be in sync by then.
To check if you need changes, #ifdef out the part that will be cut and see if you get warnings compiling with -Wall.
If you have changes to make or want to use any new functions below, make your source dependent on version 1.0.4 as described in the changes for version 1.0.3.Added some handy utility routines (most were already in gkrellm_private_proto.h without a gkrellm_ prefix):
GtkWidget *gkrellm_create_tab(GtkWidget *, gchar *); gchar *gkrellm_entry_get_text(GtkWidget **); void gkrellm_spin_button(GtkWidget *, GtkWidget **, gfloat, gfloat, gfloat, gfloat, gfloat, gint, gint, void (*func)(), gpointer, gboolean, gchar *); void gkrellm_check_button(GtkWidget *, GtkWidget **, gboolean, gboolean, gint, gchar *); gchar *gkrellm_homedir(void); gboolean gkrellm_dup_string(gchar **, gchar *); gchar *gkrellm_make_config_file_name(gchar *, gchar *); struct tm *gkrellm_get_current_time();Other uninteresting changes are: Added some session manager plugin helper functions so I could write the gkrellm-gnome plugin and exported sensor reading functions for special purpose sensor monitoring plugins.
void gkrellm_get_top_bottom_margins(Style *s, gint *top, gint *bot)
This routine determines if a theme is using the new top_margin and
bottom_margin values and returns them, otherwise it will return the old
top and bottom border values so existing themes will not break.
Style *gkrellm_copy_style(Style *src_style);
TextStyle *gkrellm_copy_textstyle(TextStyle *src_style);
Previously I had suggested
copying a style to a plugin local style like so:
Style *my_style, *style;
style = gkrellm_meter_style(DEFAULT_STYLE);
my_style = gkrellm_style_new0();
*my_style = *style;
But I goofed and this is no good. If you have such code please change it.
It should now be done like so:
Style *my_style, *style;
style = gkrellm_meter_style(style_id);
my_style = gkrellm_copy_style(style);
NOTE: Just to emphasize a point, you should never have a static
local Style or TextStyle declared. You should use the above copy
function so the style can be initialized with a themes gkrellmrc settings.
#include <gkrellm/gkrellm.h>
#if !defined(GKRELLM_VERSION_MAJOR) \
|| (GKRELLM_VERSION_MAJOR==1 && GKRELLM_VERSION_MINOR==0 && GKRELLM_VERSION_REV<3)
#error This plugin requires GKrellM version >= 1.0.3
#endif
Notice that in 1.0.3 you can now use GKRELLM_VERSION_MAJOR instead of just
VERSION_MAJOR.
Similarly, if you want to clean out ugly #ifdef'ed code sections
for previous versions of your plugin, just do it!
But if you want to conditional on a GKrellM version prior to 1.0.3, you
can't use the GKRELLM_VERSION_MAJOR.
Ie. if you #ifdef'ed in some of the new functions for 0.10.0, clean them
out and put in your header:
#include <gkrellm/gkrellm.h>
#if   (VERSION_MAJOR==0) && (VERSION_MINOR<10)
#error This plugin requires GKrellM version >= 0.10.0
#endif
But, if you are going to do this, why not just make a clean break?
Go ahead and use the first example using GKRELLM_VERSION_XXX defines,
and be done with it!
#ifdef GRAVITY #define MY_PLACEMENT (MON_APM | GRAVITY(8)) #else #define MY_PLACEMENT (MON_APM) #endi