/* * This file is part of libdom. * Licensed under the MIT License, * http://www.opensource.org/licenses/mit-license.php * Copyright 2009 Bo Yang */ #include #include #include #include "html/html_form_element.h" #include "html/html_input_element.h" #include "html/html_select_element.h" #include "html/html_text_area_element.h" #include "html/html_button_element.h" #include "html/html_collection.h" #include "html/html_document.h" #include "core/node.h" #include "utils/utils.h" static struct dom_element_protected_vtable _protect_vtable = { { DOM_NODE_PROTECT_VTABLE_HTML_FORM_ELEMENT }, DOM_HTML_FORM_ELEMENT_PROTECT_VTABLE }; static bool _dom_is_form_control(struct dom_node_internal *node, void *ctx); /** * Create a dom_html_form_element object * * \param params The html element creation parameters * \param ele The returned element object * \return DOM_NO_ERR on success, appropriate dom_exception on failure. */ dom_exception _dom_html_form_element_create( struct dom_html_element_create_params *params, struct dom_html_form_element **ele) { struct dom_node_internal *node; *ele = malloc(sizeof(dom_html_form_element)); if (*ele == NULL) return DOM_NO_MEM_ERR; /* Set up vtables */ node = (struct dom_node_internal *) *ele; node->base.vtable = &_dom_html_element_vtable; node->vtable = &_protect_vtable; return _dom_html_form_element_initialise(params, *ele); } /** * Initialise a dom_html_form_element object * * \param params The html element creation parameters * \param ele The dom_html_form_element object * \return DOM_NO_ERR on success, appropriate dom_exception on failure. */ dom_exception _dom_html_form_element_initialise( struct dom_html_element_create_params *params, struct dom_html_form_element *ele) { dom_exception err; err = _dom_html_element_initialise(params, &ele->base); return err; } /** * Finalise a dom_html_form_element object * * \param ele The dom_html_form_element object */ void _dom_html_form_element_finalise(struct dom_html_form_element *ele) { _dom_html_element_finalise(&ele->base); } /** * Destroy a dom_html_form_element object * * \param ele The dom_html_form_element object */ void _dom_html_form_element_destroy(struct dom_html_form_element *ele) { _dom_html_form_element_finalise(ele); free(ele); } /*------------------------------------------------------------------------*/ /* The protected virtual functions */ /* The virtual function used to parse attribute value, see src/core/element.c * for detail */ dom_exception _dom_html_form_element_parse_attribute(dom_element *ele, dom_string *name, dom_string *value, dom_string **parsed) { UNUSED(ele); UNUSED(name); dom_string_ref(value); *parsed = value; return DOM_NO_ERR; } /* The virtual destroy function, see src/core/node.c for detail */ void _dom_virtual_html_form_element_destroy(dom_node_internal *node) { _dom_html_form_element_destroy((struct dom_html_form_element *) node); } /* The virtual copy function, see src/core/node.c for detail */ dom_exception _dom_html_form_element_copy( dom_node_internal *old, dom_node_internal **copy) { dom_html_form_element *new_node; dom_exception err; new_node = malloc(sizeof(dom_html_form_element)); if (new_node == NULL) return DOM_NO_MEM_ERR; err = dom_html_form_element_copy_internal(old, new_node); if (err != DOM_NO_ERR) { free(new_node); return err; } *copy = (dom_node_internal *) new_node; return DOM_NO_ERR; } dom_exception _dom_html_form_element_copy_internal( dom_html_form_element *old, dom_html_form_element *new) { dom_exception err; err = dom_html_element_copy_internal(old, new); if (err != DOM_NO_ERR) { return err; } return DOM_NO_ERR; } /*-----------------------------------------------------------------------*/ /* Public APIs */ /** * Get the form controls under this form element * * \param ele The form object * \param col The collection of form controls * \return DOM_NO_ERR on success, appropriate dom_exception on failure. */ dom_exception dom_html_form_element_get_elements(dom_html_form_element *ele, struct dom_html_collection **col) { dom_exception err; dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele); assert(doc != NULL); err = _dom_html_collection_create(doc, (dom_node_internal *) doc, _dom_is_form_control, ele, col); return err; } /** * Get the number of form controls under this form element * * \param ele The form object * \param len The number of controls * \return DOM_NO_ERR on success, appropriate dom_exception on failure. */ dom_exception dom_html_form_element_get_length(dom_html_form_element *ele, uint32_t *len) { dom_exception err; dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele); dom_html_collection *col; assert(doc != NULL); err = _dom_html_collection_create(doc, (dom_node_internal *) doc, _dom_is_form_control, ele, &col); if (err != DOM_NO_ERR) return err; err = dom_html_collection_get_length(col, len); dom_html_collection_unref(col); return err; } #define SIMPLE_GET_SET(attr) \ dom_exception dom_html_form_element_get_##attr( \ dom_html_form_element *element, \ dom_string **attr) \ { \ dom_exception ret; \ dom_string *_memo_##attr; \ \ _memo_##attr = \ ((struct dom_html_document *) \ ((struct dom_node_internal *)element)->owner)->\ memoised[hds_##attr]; \ \ ret = dom_element_get_attribute(element, _memo_##attr, attr); \ \ return ret; \ } \ \ dom_exception dom_html_form_element_set_##attr( \ dom_html_form_element *element, \ dom_string *attr) \ { \ dom_exception ret; \ dom_string *_memo_##attr; \ \ _memo_##attr = \ ((struct dom_html_document *) \ ((struct dom_node_internal *)element)->owner)->\ memoised[hds_##attr]; \ \ ret = dom_element_set_attribute(element, _memo_##attr, attr); \ \ return ret; \ } SIMPLE_GET_SET(accept_charset) SIMPLE_GET_SET(action) SIMPLE_GET_SET(enctype) SIMPLE_GET_SET(method) SIMPLE_GET_SET(target) /** * Submit this form * * \param ele The form object * \return DOM_NO_ERR on success, appropriate dom_exception on failure. */ dom_exception dom_html_form_element_submit(dom_html_form_element *ele) { struct dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele); bool success = false; assert(doc != NULL); /* Dispatch an event and let the default action handler to deal with * the submit action, and a 'submit' event is bubbling and cancelable */ return _dom_dispatch_generic_event((dom_document *)doc, (dom_event_target *) ele, doc->memoised[hds_submit], true, true, &success); } /** * Reset this form * * \param ele The form object * \return DOM_NO_ERR on success, appropriate dom_exception on failure. */ dom_exception dom_html_form_element_reset(dom_html_form_element *ele) { struct dom_html_document *doc = (dom_html_document *) dom_node_get_owner(ele); bool success = false; assert(doc != NULL); /* Dispatch an event and let the default action handler to deal with * the reset action, and a 'reset' event is bubbling and cancelable */ return _dom_dispatch_generic_event((dom_document *) doc, (dom_event_target *) ele, doc->memoised[hds_reset], true, true, &success); } /*-----------------------------------------------------------------------*/ /* Internal functions */ /* Callback function to test whether certain node is a form control, see * src/html/html_collection.h for detail. */ static bool _dom_is_form_control(struct dom_node_internal *node, void *ctx) { struct dom_html_document *doc = (struct dom_html_document *)(node->owner); struct dom_html_form_element *form = ctx; assert(node->type == DOM_ELEMENT_NODE); /* Form controls are INPUT TEXTAREA SELECT and BUTTON*/ if (dom_string_caseless_isequal(node->name, doc->elements[DOM_HTML_ELEMENT_TYPE_INPUT])) return ((dom_html_input_element *)node)->form == form; if (dom_string_caseless_isequal(node->name, doc->elements[DOM_HTML_ELEMENT_TYPE_TEXTAREA])) return ((dom_html_text_area_element *)node)->form == form; if (dom_string_caseless_isequal(node->name, doc->elements[DOM_HTML_ELEMENT_TYPE_SELECT])) return ((dom_html_select_element *)node)->form == form; if (dom_string_caseless_isequal(node->name, doc->elements[DOM_HTML_ELEMENT_TYPE_BUTTON])) { return ((dom_html_button_element *)node)->form == form; } return false; }