session.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Zlib */
 
#ifndef GIRARA_SESSION_H
#define GIRARA_SESSION_H
 
#include "types.h"
#include "macros.h"
#include "callbacks.h"
 
#include <gtk/gtk.h>
 
#ifdef GDK_WINDOWING_X11
#include <gtk/gtkx.h>
#else
typedef int Window;
#endif
 
struct girara_session_s {
  girara_session_private_t* private_data; 
  GiraraInputHistory* command_history;    
 
  struct {
    GtkWidget* window;            
    GtkBox* box;                  
    GtkWidget* view;              
    GtkWidget* viewport;          
    GtkWidget* statusbar;         
    GtkBox* statusbar_entries;    
    GtkWidget* notification_area; 
    GtkWidget* notification_text; 
    GtkBox* inputbar_box;         
    GtkWidget* inputbar;          
    GtkLabel* inputbar_dialog;    
    GtkEntry* inputbar_entry;     
    GtkBox* results;              
    Window embed;                 
  } gtk;
 
  struct {
    girara_list_t* mouse_events;       
    girara_list_t* commands;           
    girara_list_t* shortcuts;          
    girara_list_t* special_commands;   
    girara_list_t* inputbar_shortcuts; 
  } bindings;
 
  struct {
    void (*buffer_changed)(girara_session_t* session);                     
    bool (*unknown_command)(girara_session_t* session, const char* input); 
  } events;
 
  struct {
    GString* buffer;        
    void* data;             
    bool autohide_inputbar; 
    bool hide_statusbar;    
  } global;
 
  struct {
    girara_callback_inputbar_activate_t inputbar_custom_activate;               
    girara_callback_inputbar_key_press_event_t inputbar_custom_key_press_event; 
    void* inputbar_custom_data;                                                 
    int inputbar_activate;                                                      
    int inputbar_key_pressed;                                                   
    int inputbar_changed;                                                       
    int view_key_pressed;                                                       
    int view_button_press_event;                                                
    int view_button_release_event;                                              
    int view_motion_notify_event;                                               
    int view_scroll_event;                                                      
  } signals;
 
  struct {
    girara_list_t* identifiers; 
    girara_mode_t current_mode; 
    girara_mode_t normal;       
    girara_mode_t inputbar;     
  } modes;
};

girara_session_t* girara_session_create(void) GIRARA_VISIBLE;

bool girara_session_init(girara_session_t* session, const char* appname) GIRARA_VISIBLE;

bool girara_session_destroy(girara_session_t* session) GIRARA_VISIBLE;

bool girara_set_view(girara_session_t* session, GtkWidget* widget) GIRARA_VISIBLE;

char* girara_buffer_get(girara_session_t* session) GIRARA_VISIBLE;

void girara_notify(girara_session_t* session, int level, const char* format, ...) GIRARA_PRINTF(3, 4) GIRARA_VISIBLE;

void girara_dialog(girara_session_t* session, const char* dialog, bool invisible,
                   girara_callback_inputbar_key_press_event_t key_press_event,
                   girara_callback_inputbar_activate_t activate_event, void* data) GIRARA_VISIBLE;

girara_mode_t girara_mode_add(girara_session_t* session, const char* name) GIRARA_VISIBLE;

void girara_mode_set(girara_session_t* session, girara_mode_t mode) GIRARA_VISIBLE;

girara_mode_t girara_mode_get(girara_session_t* session) GIRARA_VISIBLE;

bool girara_set_window_title(girara_session_t* session, const char* name) GIRARA_VISIBLE;

bool girara_set_window_icon(girara_session_t* session, const char* name) GIRARA_VISIBLE;

girara_list_t* girara_get_command_history(girara_session_t* session) GIRARA_VISIBLE;

GiraraTemplate* girara_session_get_template(girara_session_t* session) GIRARA_VISIBLE;

void girara_session_set_template(girara_session_t* session, GiraraTemplate* template,
                                 bool init_variables) GIRARA_VISIBLE;
 
#endif