input-history.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Zlib */
 
#ifndef GIRARA_INPUT_HISTORY_H
#define GIRARA_INPUT_HISTORY_H
 
#include <glib-object.h>
 
#include "types.h"
#include "macros.h"
 
struct girara_input_history_io_interface_s {
  GTypeInterface parent_iface;
 
  /* interface methods */

  void (*append)(GiraraInputHistoryIO* io, const char* input);

  girara_list_t* (*read)(GiraraInputHistoryIO* io);
 
  /* reserved for further methods */
  void (*reserved1)(void);
  void (*reserved2)(void);
  void (*reserved3)(void);
  void (*reserved4)(void);
};
 
#define GIRARA_TYPE_INPUT_HISTORY_IO (girara_input_history_io_get_type())
#define GIRARA_INPUT_HISTORY_IO(obj)                                                                                   \
  (G_TYPE_CHECK_INSTANCE_CAST((obj), GIRARA_TYPE_INPUT_HISTORY_IO, GiraraInputHistoryIO))
#define GIRARA_IS_INPUT_HISTORY_IO(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GIRARA_TYPE_INPUT_HISTORY_IO))
#define GIRARA_INPUT_HISTORY_IO_GET_INTERFACE(obj)                                                                     \
  (G_TYPE_INSTANCE_GET_INTERFACE((obj), GIRARA_TYPE_INPUT_HISTORY_IO, GiraraInputHistoryIOInterface))
 
GType girara_input_history_io_get_type(void) G_GNUC_CONST GIRARA_VISIBLE;
 
void girara_input_history_io_append(GiraraInputHistoryIO* io, const char* input) GIRARA_VISIBLE;
 
girara_list_t* girara_input_history_io_read(GiraraInputHistoryIO* io) GIRARA_VISIBLE;
 
struct girara_input_history_s {
  GObject parent;
};
 
struct girara_input_history_class_s {
  GObjectClass parent_class;
 
  /* methods */

  void (*append)(GiraraInputHistory* history, const char* input);

  girara_list_t* (*list)(GiraraInputHistory* history);

  const char* (*next)(GiraraInputHistory* history, const char* current_input);

  const char* (*previous)(GiraraInputHistory* history, const char* current_input);

  void (*reset)(GiraraInputHistory* history);
 
  /* reserved for further methods */
  void (*reserved1)(void);
  void (*reserved2)(void);
  void (*reserved3)(void);
  void (*reserved4)(void);
};
 
#define GIRARA_TYPE_INPUT_HISTORY (girara_input_history_get_type())
#define GIRARA_INPUT_HISTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GIRARA_TYPE_INPUT_HISTORY, GiraraInputHistory))
#define GIRARA_INPUT_HISTORY_CLASS(obj)                                                                                \
  (G_TYPE_CHECK_CLASS_CAST((obj), GIRARA_TYPE_INPUT_HISTORY, GiraraInputHistoryClass))
#define GIRARA_IS_INPUT_HISTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GIRARA_TYPE_INPUT_HISTORY))
#define GIRARA_IS_INPUT_HISTORY_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((obj), GIRARA_TYPE_INPUT_HISTORY))
#define GIRARA_INPUT_HISTORY_GET_CLASS(obj)                                                                            \
  (G_TYPE_INSTANCE_GET_CLASS((obj), GIRARA_TYPE_INPUT_HISTORY, GiraraInputHistoryClass))

GType girara_input_history_get_type(void) G_GNUC_CONST GIRARA_VISIBLE;

GiraraInputHistory* girara_input_history_new(GiraraInputHistoryIO* io) GIRARA_VISIBLE;

void girara_input_history_append(GiraraInputHistory* history, const char* input) GIRARA_VISIBLE;

const char* girara_input_history_next(GiraraInputHistory* history, const char* current_input) GIRARA_VISIBLE;

const char* girara_input_history_previous(GiraraInputHistory* history, const char* current_input) GIRARA_VISIBLE;

void girara_input_history_reset(GiraraInputHistory* history) GIRARA_VISIBLE;

girara_list_t* girara_input_history_list(GiraraInputHistory* history) GIRARA_VISIBLE;
 
#endif