#ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include "libcustomindicator/custom-indicator.h" #include "libcustomindicator/custom-indicator-enum-types.h" /** CustomIndicatorPrivate: @id: The ID of the indicator. Maps to CustomIndicator::id. @category: Which category the indicator is. Maps to CustomIndicator::category. @status: The status of the indicator. Maps to CustomIndicator::status. @icon_name: The name of the icon to use. Maps to CustomIndicator::icon-name. @attention_icon_name: The name of the attention icon to use. Maps to CustomIndicator::attention-icon-name. @menu: The menu for this indicator. Maps to CustomIndicator::menu @watcher_proxy: The proxy connection to the watcher we're connected to. If we're not connected to one this will be #NULL. All of the private data in an instance of a custom indicator. */ typedef struct _CustomIndicatorPrivate CustomIndicatorPrivate; struct _CustomIndicatorPrivate { /* Properties */ gchar * id; CustomIndicatorCategory category; CustomIndicatorStatus status; gchar * icon_name; gchar * attention_icon_name; DbusmenuServer * menu; /* Fun stuff */ DBusGProxy * watcher_proxy; }; /* Signals Stuff */ enum { NEW_ICON, NEW_ATTENTION_ICON, NEW_STATUS, CONNECTION_CHANGED, LAST_SIGNAL }; static guint signals[LAST_SIGNAL] = { 0 }; /* Enum for the properties so that they can be quickly found and looked up. */ enum { PROP_0, PROP_ID, PROP_CATEGORY, PROP_STATUS, PROP_ICON_NAME, PROP_ATTENTION_ICON_NAME, PROP_MENU, PROP_CONNECTED }; /* The strings so that they can be slowly looked up. */ #define PROP_ID_S "id" #define PROP_CATEGORY_S "category" #define PROP_STATUS_S "status" #define PROP_ICON_NAME_S "icon-name" #define PROP_ATTENTION_ICON_NAME_S "attention-icon-name" #define PROP_MENU_S "menu" #define PROP_CONNECTED_S "connected" /* Private macro, shhhh! */ #define CUSTOM_INDICATOR_GET_PRIVATE(o) \ (G_TYPE_INSTANCE_GET_PRIVATE ((o), CUSTOM_INDICATOR_TYPE, CustomIndicatorPrivate)) /* Boiler plate */ static void custom_indicator_class_init (CustomIndicatorClass *klass); static void custom_indicator_init (CustomIndicator *self); static void custom_indicator_dispose (GObject *object); static void custom_indicator_finalize (GObject *object); /* Property functions */ static void custom_indicator_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec); static void custom_indicator_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec); /* Other stuff */ static void check_connect (CustomIndicator * self); /* GObject type */ G_DEFINE_TYPE (CustomIndicator, custom_indicator, G_TYPE_OBJECT); static void custom_indicator_class_init (CustomIndicatorClass *klass) { GObjectClass *object_class = G_OBJECT_CLASS (klass); g_type_class_add_private (klass, sizeof (CustomIndicatorPrivate)); /* Clean up */ object_class->dispose = custom_indicator_dispose; object_class->finalize = custom_indicator_finalize; /* Property funcs */ object_class->set_property = custom_indicator_set_property; object_class->get_property = custom_indicator_get_property; /* Properties */ g_object_class_install_property(object_class, PROP_ID, g_param_spec_string(PROP_ID_S, "The ID for this indicator", "An ID that should be unique, but used consistently by this program and it's indicator.", NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property(object_class, PROP_CATEGORY, g_param_spec_enum(PROP_CATEGORY_S, "Indicator Category", "The type of indicator that this represents. Please don't use 'other'. Defaults to 'Application Status'.", CUSTOM_INDICATOR_TYPE_INDICATOR_CATEGORY, CUSTOM_INDICATOR_CATEGORY_APPLICATION_STATUS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property(object_class, PROP_STATUS, g_param_spec_enum(PROP_STATUS_S, "Indicator Status", "Whether the indicator is shown or requests attention. Defaults to 'off'.", CUSTOM_INDICATOR_TYPE_INDICATOR_STATUS, CUSTOM_INDICATOR_STATUS_OFF, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property(object_class, PROP_ICON_NAME, g_param_spec_string(PROP_ICON_NAME_S, "An icon for the indicator", "The default icon that is shown for the indicator.", NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property(object_class, PROP_ATTENTION_ICON_NAME, g_param_spec_string(PROP_ATTENTION_ICON_NAME_S, "An icon to show when the indicator request attention.", "If the indicator sets it's status to 'attention' then this icon is shown.", NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property(object_class, PROP_MENU, g_param_spec_object(PROP_MENU_S, "The Menu for the indicator", "A DBus Menu Server object that can have a menu attached to it. The object from this menu will be sent across the bus for the client to connect to and signal.", DBUSMENU_TYPE_SERVER, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property(object_class, PROP_CONNECTED, g_param_spec_boolean(PROP_CONNECTED_S, "Whether we're conneced to a watcher", "Pretty simple, true if we have a reasonable expectation of being displayed through this object. You should hide your TrayIcon if so.", FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); /* Signals */ /** CustomIndicator::new-icon: @arg0: The #CustomIndicator object Signaled when there is a new icon set for the object. */ signals[NEW_ICON] = g_signal_new (CUSTOM_INDICATOR_SIGNAL_NEW_ICON, G_TYPE_FROM_CLASS(klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (CustomIndicatorClass, new_icon), NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0, G_TYPE_NONE); /** CustomIndicator::new-attention-icon: @arg0: The #CustomIndicator object Signaled when there is a new attention icon set for the object. */ signals[NEW_ATTENTION_ICON] = g_signal_new (CUSTOM_INDICATOR_SIGNAL_NEW_ATTENTION_ICON, G_TYPE_FROM_CLASS(klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (CustomIndicatorClass, new_attention_icon), NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0, G_TYPE_NONE); /** CustomIndicator::new-status: @arg0: The #CustomIndicator object @arg1: The string value of the #CustomIndicatorStatus enum. Signaled when the status of the indicator changes. */ signals[NEW_STATUS] = g_signal_new (CUSTOM_INDICATOR_SIGNAL_NEW_STATUS, G_TYPE_FROM_CLASS(klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (CustomIndicatorClass, new_status), NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE, 1, G_TYPE_STRING, G_TYPE_NONE); /** CustomIndicator::connection-changed: @arg0: The #CustomIndicator object @arg1: Whether we're connected or not Signaled when we connect to a watcher, or when it drops away. */ signals[CONNECTION_CHANGED] = g_signal_new (CUSTOM_INDICATOR_SIGNAL_CONNECTION_CHANGED, G_TYPE_FROM_CLASS(klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (CustomIndicatorClass, connection_changed), NULL, NULL, g_cclosure_marshal_VOID__BOOLEAN, G_TYPE_NONE, 1, G_TYPE_BOOLEAN, G_TYPE_NONE); return; } static void custom_indicator_init (CustomIndicator *self) { CustomIndicatorPrivate * priv = CUSTOM_INDICATOR_GET_PRIVATE(self); g_return_if_fail(priv != NULL); priv->id = NULL; priv->category = CUSTOM_INDICATOR_CATEGORY_OTHER; priv->status = CUSTOM_INDICATOR_STATUS_OFF; priv->icon_name = NULL; priv->attention_icon_name = NULL; priv->menu = NULL; priv->watcher_proxy = NULL; return; } static void custom_indicator_dispose (GObject *object) { G_OBJECT_CLASS (custom_indicator_parent_class)->dispose (object); return; } static void custom_indicator_finalize (GObject *object) { G_OBJECT_CLASS (custom_indicator_parent_class)->finalize (object); return; } #define WARN_BAD_TYPE(prop, value) g_warning("Can not work with property '%s' with value of type '%s'.", prop, G_VALUE_TYPE_NAME(value)) /* Set some properties */ static void custom_indicator_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec) { CustomIndicator * self = CUSTOM_INDICATOR(object); g_return_if_fail(self != NULL); CustomIndicatorPrivate * priv = CUSTOM_INDICATOR_GET_PRIVATE(self); g_return_if_fail(priv != NULL); switch (prop_id) { /* *********************** */ case PROP_ID: if (G_VALUE_HOLDS_STRING(value)) { if (priv->id != NULL) { g_warning("Resetting ID value when I already had a value of: %s", priv->id); g_free(priv->id); priv->id = NULL; } priv->id = g_strdup(g_value_get_string(value)); } else { WARN_BAD_TYPE(PROP_ID_S, value); } check_connect(self); break; /* *********************** */ case PROP_CATEGORY: if (G_VALUE_HOLDS_INT(value)) { priv->category = g_value_get_int(value); } else if (G_VALUE_HOLDS_STRING(value)) { GParamSpecEnum * enumspec = G_PARAM_SPEC_ENUM(pspec); if (enumspec != NULL) { GEnumValue * enumval = g_enum_get_value_by_nick(enumspec->enum_class, g_value_get_string(value)); if (enumval != NULL) { priv->category = enumval->value; } else { g_error("Value '%s' is not in the '%s' property enum.", g_value_get_string(value), PROP_CATEGORY_S); } } else { g_assert_not_reached(); } } else { WARN_BAD_TYPE(PROP_CATEGORY_S, value); } break; /* *********************** */ case PROP_STATUS: if (G_VALUE_HOLDS_INT(value)) { priv->status = g_value_get_int(value); } else if (G_VALUE_HOLDS_STRING(value)) { GParamSpecEnum * enumspec = G_PARAM_SPEC_ENUM(pspec); if (enumspec != NULL) { GEnumValue * enumval = g_enum_get_value_by_nick(enumspec->enum_class, g_value_get_string(value)); if (enumval != NULL) { priv->status = enumval->value; } else { g_error("Value '%s' is not in the '%s' property enum.", g_value_get_string(value), PROP_STATUS_S); } } else { g_assert_not_reached(); } } else { WARN_BAD_TYPE(PROP_STATUS_S, value); } break; /* *********************** */ case PROP_ICON_NAME: if (G_VALUE_HOLDS_STRING(value)) { const gchar * instr = g_value_get_string(value); gboolean changed = FALSE; if (priv->icon_name == NULL) { priv->icon_name = g_strdup(instr); changed = TRUE; } else if (!g_strcmp0(instr, priv->icon_name)) { changed = FALSE; } else { g_free(priv->icon_name); priv->icon_name = g_strdup(instr); changed = TRUE; } if (changed) { g_signal_emit(object, signals[NEW_ICON], 0, TRUE); } } else { WARN_BAD_TYPE(PROP_ICON_NAME_S, value); } break; /* *********************** */ case PROP_ATTENTION_ICON_NAME: if (G_VALUE_HOLDS_STRING(value)) { const gchar * instr = g_value_get_string(value); gboolean changed = FALSE; if (priv->attention_icon_name == NULL) { priv->attention_icon_name = g_strdup(instr); changed = TRUE; } else if (!g_strcmp0(instr, priv->attention_icon_name)) { changed = FALSE; } else { g_free(priv->attention_icon_name); priv->attention_icon_name = g_strdup(instr); changed = TRUE; } if (changed) { g_signal_emit(object, signals[NEW_ATTENTION_ICON], 0, TRUE); } } else { WARN_BAD_TYPE(PROP_ATTENTION_ICON_NAME_S, value); } break; /* *********************** */ case PROP_MENU: if (G_VALUE_HOLDS_OBJECT(value)) { if (priv->menu != NULL) { g_object_unref(G_OBJECT(priv->menu)); } priv->menu = DBUSMENU_SERVER(g_value_get_object(value)); g_object_ref(G_OBJECT(priv->menu)); } else { WARN_BAD_TYPE(PROP_MENU_S, value); } break; /* *********************** */ default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } return; } /* Function to fill our value with the property it's requesting. */ static void custom_indicator_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec) { CustomIndicator * self = CUSTOM_INDICATOR(object); g_return_if_fail(self != NULL); CustomIndicatorPrivate * priv = CUSTOM_INDICATOR_GET_PRIVATE(self); g_return_if_fail(priv != NULL); switch (prop_id) { /* *********************** */ case PROP_ID: if (G_VALUE_HOLDS_STRING(value)) { g_value_set_string(value, priv->id); } else { WARN_BAD_TYPE(PROP_ID_S, value); } break; /* *********************** */ case PROP_CATEGORY: if (G_VALUE_HOLDS_INT(value)) { /* We want the enum value */ g_value_set_int(value, priv->category); } else if (G_VALUE_HOLDS_STRING(value)) { GParamSpecEnum * enumspec = G_PARAM_SPEC_ENUM(pspec); if (enumspec != NULL) { GEnumValue * enumval = g_enum_get_value(enumspec->enum_class, priv->category); g_value_set_string(value, enumval->value_nick); } else { g_assert_not_reached(); } } else { WARN_BAD_TYPE(PROP_CATEGORY_S, value); } break; /* *********************** */ case PROP_STATUS: if (G_VALUE_HOLDS_INT(value)) { /* We want the enum value */ g_value_set_int(value, priv->status); } else if (G_VALUE_HOLDS_STRING(value)) { GParamSpecEnum * enumspec = G_PARAM_SPEC_ENUM(pspec); if (enumspec != NULL) { GEnumValue * enumval = g_enum_get_value(enumspec->enum_class, priv->status); g_value_set_string(value, enumval->value_nick); } else { g_assert_not_reached(); } } else { WARN_BAD_TYPE(PROP_STATUS_S, value); } break; /* *********************** */ case PROP_ICON_NAME: if (G_VALUE_HOLDS_STRING(value)) { g_value_set_string(value, priv->icon_name); } else { WARN_BAD_TYPE(PROP_ICON_NAME_S, value); } break; /* *********************** */ case PROP_ATTENTION_ICON_NAME: if (G_VALUE_HOLDS_STRING(value)) { g_value_set_string(value, priv->attention_icon_name); } else { WARN_BAD_TYPE(PROP_ATTENTION_ICON_NAME_S, value); } break; /* *********************** */ case PROP_MENU: if (G_VALUE_HOLDS_OBJECT(value)) { g_value_set_object(value, priv->menu); } else { WARN_BAD_TYPE(PROP_MENU_S, value); } break; /* *********************** */ case PROP_CONNECTED: if (G_VALUE_HOLDS_BOOLEAN(value)) { g_value_set_boolean(value, priv->watcher_proxy != NULL ? TRUE : FALSE); } else { WARN_BAD_TYPE(PROP_CONNECTED_S, value); } break; /* *********************** */ default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } return; } /* This function is used to see if we have enough information to connect to things. If we do, and we're not connected, it connects for us. */ static void check_connect (CustomIndicator * self) { }