readline_history Struct Reference

A readline history buffer. More...

#include <readline.h>

Data Fields
struct readline_history_entry	entries [READLINE_HISTORY_MAX_DEPTH+1]
	History entries. More...
unsigned int	next
	Position of next entry within buffer. More...
unsigned int	depth
	Current depth within history buffer. More...

Detailed Description

A readline history buffer.

Definition at line 31 of file readline.h.

Field Documentation

entries

struct readline_history_entry readline_history::entries[READLINE_HISTORY_MAX_DEPTH+1]

History entries.

This is a circular buffer, with entries in chronological order. The "next" entry is always empty except during a call to readline().

Definition at line 38 of file readline.h.

Referenced by history_cleanup(), history_entry(), and history_free().

next

unsigned int readline_history::next

Position of next entry within buffer.

This is incremented monotonically each time an entry is added to the buffer.

Definition at line 44 of file readline.h.

Referenced by history_append(), and history_entry().

depth

unsigned int readline_history::depth

Current depth within history buffer.

This is valid only during the call to readline()

Definition at line 49 of file readline.h.

Referenced by history_cleanup(), and history_move().

---

The documentation for this struct was generated from the following file:

• include/readline/readline.h