notification.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause */
 
#ifndef DUNST_NOTIFICATION_H
#define DUNST_NOTIFICATION_H
 
#include <glib.h>
#include <stdbool.h>
#include <pango/pango-layout.h>
#include <cairo.h>
 
#include "markup.h"
#include "draw.h"
 
#define DUNST_NOTIF_MAX_CHARS 50000
 
enum icon_position {
        ICON_LEFT,
        ICON_RIGHT,
        ICON_TOP,
        ICON_OFF
};
 
enum behavior_fullscreen {
        FS_NULL,      
        FS_DELAY,     
        FS_PUSHBACK,  
        FS_SHOW,      
};

enum urgency {
        URG_NONE = -1, 
        URG_MIN = 0,   
        URG_LOW = 0,   
        URG_NORM = 1,  
        URG_CRIT = 2,  
        URG_MAX = 2,   
};
 
typedef struct _notification_private NotificationPrivate;
 
struct notification_colors {
        struct color frame;
        struct color bg;
        struct color fg;
        struct gradient *highlight;
};
 
struct notification {
        NotificationPrivate *priv;
        gint id;
        char *dbus_client;
        bool dbus_valid;
 
        // We keep the original notification properties here when it is modified
        struct rule *original;
 
        char *appname;
        char *summary;
        char *body;
        char *category;
        char *desktop_entry;     
        enum urgency urgency;
        int override_pause_level;
 
        cairo_surface_t *icon;         
        char *icon_id;           
        gint64 icon_time;        
        char *iconname;          
        char *icon_path;         
        char *default_icon_name; 
        int min_icon_size;  
        int max_icon_size; 
        enum icon_position icon_position;       
        bool receiving_raw_icon; 
 
        gint64 start;      
        gint64 timestamp;  
        gint64 timeout;    
        gint64 dbus_timeout; 
        int locked;     
        PangoAlignment progress_bar_alignment; 
 
        GHashTable *actions;
        char *default_action_name; 
 
        enum markup_mode markup;
        char *format;
        char **scripts;
        int script_count;
        struct notification_colors colors;
 
        char *stack_tag;    
 
        /* Hints */
        bool transient;     
        int progress;       
        int history_ignore; 
        int skip_display;   
 
        /* internal */
        bool redisplayed;       
        bool first_render;      
        int dup_count;          
        int displayed_height;
        enum behavior_fullscreen fullscreen; 
        bool script_run;        
        guint8 marked_for_closure;
        guint8 marked_for_removal; 
        bool word_wrap;
        PangoEllipsizeMode ellipsize;
        PangoAlignment alignment;
        bool hide_text;
 
        /* derived fields */
        char *msg;            
        char *text_to_render; 
        char *urls;           
};

struct notification *notification_create(void);

gint notification_refcount_get(struct notification *n);

void notification_ref(struct notification *n);

void notification_init(struct notification *n);

void notification_unref(struct notification *n);

int notification_cmp(const struct notification *a, const struct notification *b);

int notification_cmp_data(const void *va, const void *vb, void *data);
 
bool notification_is_duplicate(const struct notification *a, const struct notification *b);
 
bool notification_is_locked(struct notification *n);
 
struct notification *notification_lock(struct notification *n);
 
struct notification *notification_unlock(struct notification *n);

void notification_transfer_icon(struct notification *from, struct notification *to);

void notification_icon_replace_path(struct notification *n, const char *new_icon);

void notification_icon_replace_data(struct notification *n, GVariant *new_icon);
 
void notification_replace_format(struct notification *n, const char *format);

void notification_run_script(struct notification *n);
void notification_print(const struct notification *n);

void notification_replace_single_field(char **haystack,
                                       char **needle,
                                       const char *replacement,
                                       enum markup_mode markup_mode);
 
void notification_update_text_to_render(struct notification *n);

void notification_do_action(struct notification *n);

void notification_open_url(struct notification *n);

void notification_open_context_menu(struct notification *n);

void notification_invalidate_actions(struct notification *n);
 
const char *notification_urgency_to_string(const enum urgency urgency);

const char *enum_to_string_fullscreen(enum behavior_fullscreen in);
 
void notification_keep_original(struct notification *n);
 
#endif