1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-06-17 23:55:32 +00:00
elinks/src/document/forms.h
2018-09-09 19:18:53 +02:00

123 lines
2.8 KiB
C

#ifndef EL__DOCUMENT_FORMS_H
#define EL__DOCUMENT_FORMS_H
#include "util/lists.h"
struct document;
struct menu_item;
enum form_method {
FORM_METHOD_GET,
FORM_METHOD_POST,
FORM_METHOD_POST_MP,
FORM_METHOD_POST_TEXT_PLAIN,
};
struct form {
LIST_HEAD(struct form);
/** The value of @c form_num serves both as a unique ID of the form.
* However @c form_num and #form_end also stores information about where
* in the source the form is positioned. Combined they are used to
* figured which form items belong to which forms after rendering
* tables.
*
* Initially the range between @c form_num and #form_end will
* stretch from 0 to INT_MAX. When a new form is added the
* range is partitioned so the forms each has unique source
* ranges. */
int form_num;
int form_end; /**< @see #form_num */
unsigned char *action;
unsigned char *name;
unsigned char *onsubmit;
unsigned char *target;
enum form_method method;
LIST_OF(struct el_form_control) items;
};
enum form_type {
FC_TEXT,
FC_PASSWORD,
FC_FILE,
FC_TEXTAREA,
FC_CHECKBOX,
FC_RADIO,
FC_SELECT,
FC_SUBMIT,
FC_IMAGE,
FC_RESET,
FC_BUTTON,
FC_HIDDEN,
};
enum form_mode {
FORM_MODE_NORMAL,
FORM_MODE_READONLY,
FORM_MODE_DISABLED,
};
#define form_field_is_readonly(field) ((field)->mode != FORM_MODE_NORMAL)
enum form_wrap {
FORM_WRAP_NONE,
FORM_WRAP_SOFT,
FORM_WRAP_HARD,
};
struct el_form_control {
LIST_HEAD(struct el_form_control);
struct form *form;
int g_ctrl_num;
/** The value of @c position is relative to the place of the
* form item in the source. */
int position;
enum form_type type;
enum form_mode mode;
unsigned char *id; /**< used by scripts */
unsigned char *name;
unsigned char *alt;
/** Default value, cannot be changed by document scripts.
* - For ::FC_TEXT, ::FC_PASSWORD, and ::FC_TEXTAREA:
* @c default_value is in the charset of the document.
* - For ::FC_FILE: The parser does not set @c default_value. */
unsigned char *default_value;
int default_state;
int size;
int cols, rows;
enum form_wrap wrap;
int maxlength;
int nvalues;
unsigned char **values;
/** Labels in a selection menu.
* - For ::FC_SELECT: @c labels are in the charset of the terminal.
* (That charset can be UTF-8 only if CONFIG_UTF8 is defined,
* and is assumed to be unibyte otherwise.) The charset of
* the document and the UTF-8 I/O option have no effect here. */
unsigned char **labels;
struct menu_item *menu;
};
/* Numerical form type <-> form type name */
int str2form_type(unsigned char *s);
unsigned char *form_type2str(enum form_type num);
struct form *init_form(void);
void done_form(struct form *form);
int has_form_submit(struct form *form);
int get_form_control_link(struct document *document, struct el_form_control *fc);
void done_form_control(struct el_form_control *fc);
#endif