gp_widget_tbox.h

Go to the documentation of this file.

//SPDX-License-Identifier: LGPL-2.0-or-later
 
/*
 
   Copyright (c) 2014-2024 Cyril Hrubis <metan@ucw.cz>
 
 */
 
#ifndef GP_WIDGET_TBOX_H
#define GP_WIDGET_TBOX_H
 
#include <utils/gp_seek.h>
#include <utils/gp_utf_pos.h>
 
enum gp_widget_tbox_type {
        GP_WIDGET_TBOX_NONE,
        GP_WIDGET_TBOX_HIDDEN,
        GP_WIDGET_TBOX_URL,
        GP_WIDGET_TBOX_PATH,
        GP_WIDGET_TBOX_FILENAME,
        /* @brief Last used type + 1. */
        GP_WIDGET_TBOX_MAX,
};
 
struct gp_widget_tbox {
        /* Text buffer */
        char *buf;
        size_t size;
 
        /* Help text shown when tbox is empty */
        char *help;
 
        /*
         * If not NULL the tbox can contain only characters from this
         * string, this is used as a hint when minimal tbox size is
         * accounted for.
         */
        const char *filter;
 
        /*
         * Delimiter list for double click selection.
         *
         * If NULL defaults to whitespaces.
         *
         * This is set automatically by a certain tbox types.
         */
        const char *delim;
 
        /* enum gp_widget_tbox_type */
        uint16_t type;
 
        uint16_t alert:1;
        uint16_t clear_on_input:1;
 
        size_t max_size;
 
        /* Cursor position */
        gp_utf8_pos cur_pos;
        gp_utf8_pos cur_pos_saved;
        /* Offset on left size, part of a string that is not shown */
        gp_utf8_pos off_left;
 
        /* Selection */
        gp_utf8_pos sel_left;
        gp_utf8_pos sel_right;
 
        gp_widget_tattr tattr;
 
 
        //TODO: Move to event state
        uint64_t last_click;
        uint32_t click_cursor_x;
 
        char payload[];
};
 
enum gp_widget_tbox_event_type {
        GP_WIDGET_TBOX_TRIGGER,
        GP_WIDGET_TBOX_PRE_FILTER,
        GP_WIDGET_TBOX_POST_FILTER,
        GP_WIDGET_TBOX_EDIT,
        GP_WIDGET_TBOX_SET,
        GP_WIDGET_TBOX_PASTE,
};
 
#define GP_TBOX_FILTER_INT "0123456789"
#define GP_TBOX_FILTER_HEX "0123456789abcdefABCDEF"
 
gp_widget *gp_widget_tbox_new(const char *text, gp_widget_tattr tattr,
                              unsigned int len, unsigned int max_len,
                              const char *filter, enum gp_widget_tbox_type type);
 
int gp_widget_tbox_printf(gp_widget *self, const char *fmt, ...)
                          __attribute__((format (printf, 2, 3)));
 
 
void gp_widget_tbox_set(gp_widget *self, const char *str);
 
void gp_widget_tbox_clear(gp_widget *self);
 
const char *gp_widget_tbox_text(gp_widget *self);
 
 
static inline int gp_widget_tbox_is_empty(gp_widget *self)
{
        const char *text = gp_widget_tbox_text(self);
 
        if (!text || !text[0])
                return 1;
 
        return 0;
}
 
gp_utf8_pos gp_widget_tbox_cursor_get(gp_widget *self);
 
void gp_widget_tbox_cursor_set(gp_widget *self, ssize_t off,
                               enum gp_seek_whence whence);
 
void gp_widget_tbox_ins(gp_widget *self, ssize_t off,
                        enum gp_seek_whence whence, const char *str);
 
static inline void gp_widget_tbox_append(gp_widget *self, const char *str)
{
        gp_widget_tbox_ins(self, 0, GP_SEEK_CUR, str);
}
 
void gp_widget_tbox_del(gp_widget *self, ssize_t off,
                        enum gp_seek_whence whence, size_t len);
 
void gp_widget_tbox_sel_set(gp_widget *self, ssize_t off,
                            enum gp_seek_whence whence, size_t len);
 
void gp_widget_tbox_sel_all(gp_widget *self);
 
void gp_widget_tbox_sel_clr(gp_widget *self);
 
void gp_widget_tbox_sel_del(gp_widget *self);
 
gp_utf8_pos gp_widget_tbox_sel_len(gp_widget *self);
 
gp_utf8_pos gp_widget_tbox_sel_off(gp_widget *self);
 
static inline int gp_widget_tbox_sel(gp_widget *self)
{
        return !!gp_widget_tbox_sel_len(self).bytes;
}
 
void gp_widget_tbox_sel_delim_set(gp_widget *self, const char *delim);
 
void gp_widget_tbox_type_set(gp_widget *self, enum gp_widget_tbox_type type);
 
void gp_widget_tbox_help_set(gp_widget *self, const char *help);
 
void gp_widget_tbox_clear_on_input(gp_widget *self);
 
#endif /* GP_WIDGET_TBOX_H */