[irc/quakenet/newserv.git] / helpmod2 / hed.h

/* H/G text editor */
#ifndef HED_H
#define HED_H

/* Maximum number of lines in buffer */
#define HED_BUFFER_LINES 16

#define HELPMOD_TEXT_DIR "./helpmod2/text"
#define HED_FILENAME_LENGTH 64

/* Forward declarations */
struct hchannel_struct;
struct huser_struct;

typedef enum
{
    HED_COMMAND,
    HED_INPUT_INSERT,
    HED_INPUT_APPEND
} hed_state;

typedef enum
{
    HED_ERR_NO_ERROR,
    HED_ERR_NO_COMMAND,
    HED_ERR_SYNTAX_ERROR,
    HED_ERR_UNKNOWN_COMMAND,
    HED_ERR_COMMAND_NOT_SUPPORTED,
    HED_ERR_INVALID_ARGUMENT,
    HED_ERR_LINE_TOO_LONG,
    HED_ERR_BUFFER_FULL,
    HED_ERR_CLIPBOARD_EMPTY,
    HED_ERR_UNSAVED
} hed_error;

typedef enum
{
    HED_FLAG_VERBOSE_ERRORS = 1 << 0,
    HED_FLAG_UNSAVED        = 1 << 1
} hed_flag;

#define HED_FLAGS_DEFAULT (0)

typedef struct helpmod_editor_line_struct
{
    char line[384];
    struct helpmod_editor_line_struct *next;
} hed_line;

typedef struct helpmod_editor_struct
{
    char filename[HED_FILENAME_LENGTH];
    hed_line buffers[HED_BUFFER_LINES];

    hed_line *start;
    hed_line *free_lines;
    hed_line *clipboard;

    int line;
    int flags;

    struct huser_struct *user;

    hed_state state;
    hed_error last_error;

    struct helpmod_editor_struct *next;
} helpmod_editor;

extern helpmod_editor *helpmod_editors;

helpmod_editor *hed_open(struct huser_struct *, const char *);
helpmod_editor *hed_close(helpmod_editor *);
helpmod_editor *hed_write(helpmod_editor *);

int hed_byte_count(helpmod_editor*);
int hed_line_count(helpmod_editor*);
int hed_is_valid_filename(const char *);

/* Get by filename */
helpmod_editor *hed_get(const char *);

void hed_command (struct huser_struct *sender, channel* returntype, char* ostr, int argc, char *argv[]);

const char *hed_error_text(hed_error);

char *hed_add_line(helpmod_editor *, int);
void hed_del_line(helpmod_editor *, int);
char *hed_get_line(helpmod_editor *, int);

void hed_clear_clipboard(helpmod_editor *);
void hed_paste(helpmod_editor *, int);

#endif
Commit	Line	Data
f9d450b2	1	/* H/G text editor */
	2	#ifndef HED_H
	3	#define HED_H
	4
	5	/* Maximum number of lines in buffer */
	6	#define HED_BUFFER_LINES 16
	7
	8	#define HELPMOD_TEXT_DIR "./helpmod2/text"
135d6084	9	#define HED_FILENAME_LENGTH 64
f9d450b2	10
	11	/* Forward declarations */
	12	struct hchannel_struct;
	13	struct huser_struct;
	14
	15	typedef enum
	16	{
	17	HED_COMMAND,
	18	HED_INPUT_INSERT,
	19	HED_INPUT_APPEND
	20	} hed_state;
	21
	22	typedef enum
	23	{
	24	HED_ERR_NO_ERROR,
	25	HED_ERR_NO_COMMAND,
	26	HED_ERR_SYNTAX_ERROR,
	27	HED_ERR_UNKNOWN_COMMAND,
	28	HED_ERR_COMMAND_NOT_SUPPORTED,
	29	HED_ERR_INVALID_ARGUMENT,
	30	HED_ERR_LINE_TOO_LONG,
	31	HED_ERR_BUFFER_FULL,
	32	HED_ERR_CLIPBOARD_EMPTY,
	33	HED_ERR_UNSAVED
	34	} hed_error;
	35
	36	typedef enum
	37	{
	38	HED_FLAG_VERBOSE_ERRORS = 1 << 0,
	39	HED_FLAG_UNSAVED = 1 << 1
	40	} hed_flag;
	41
	42	#define HED_FLAGS_DEFAULT (0)
	43
	44	typedef struct helpmod_editor_line_struct
	45	{
	46	char line[384];
	47	struct helpmod_editor_line_struct *next;
	48	} hed_line;
	49
	50	typedef struct helpmod_editor_struct
	51	{
135d6084	52	char filename[HED_FILENAME_LENGTH];
f9d450b2	53	hed_line buffers[HED_BUFFER_LINES];
	54
	55	hed_line *start;
	56	hed_line *free_lines;
	57	hed_line *clipboard;
	58
	59	int line;
	60	int flags;
	61
	62	struct huser_struct *user;
	63
	64	hed_state state;
	65	hed_error last_error;
	66
	67	struct helpmod_editor_struct *next;
	68	} helpmod_editor;
	69
	70	extern helpmod_editor *helpmod_editors;
	71
	72	helpmod_editor hed_open(struct huser_struct , const char *);
	73	helpmod_editor hed_close(helpmod_editor );
	74	helpmod_editor hed_write(helpmod_editor );
	75
	76	int hed_byte_count(helpmod_editor*);
	77	int hed_line_count(helpmod_editor*);
	78	int hed_is_valid_filename(const char *);
	79
	80	/* Get by filename */
	81	helpmod_editor hed_get(const char );
	82
	83	void hed_command (struct huser_struct sender, channel returntype, char* ostr, int argc, char *argv[]);
	84
	85	const char *hed_error_text(hed_error);
	86
	87	char hed_add_line(helpmod_editor , int);
	88	void hed_del_line(helpmod_editor *, int);
	89	char hed_get_line(helpmod_editor , int);
	90
	91	void hed_clear_clipboard(helpmod_editor *);
	92	void hed_paste(helpmod_editor *, int);
	93
	94	#endif