woden/include/woden_qname_list_or_token_any_attr.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_H
#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_H

/**
 * @file woden_qname_list_or_token_any_attr.h
 * @brief Axis2 QName List or Token Any Attribute Interface
 *          This class represents XML attribute information items of type
 * "        Union of list of QName or xs:token #any"
 *          (e.g. the wsoap:subcodes extension attribute of binding fault).
 */

#include <woden.h>
#include <woden_xml_attr.h>
#include <axis2_array_list.h>

/** @defgroup woden_qname_list_or_token_any_attr QName List or Token Any Attribute
  * @ingroup woden
  * @{
  */

typedef struct woden_qname_list_or_token_any_attr 
        woden_qname_list_or_token_any_attr_t;
typedef struct woden_qname_list_or_token_any_attr_ops 
        woden_qname_list_or_token_any_attr_ops_t;
struct axiom_element;
struct axiom_node;

#ifdef __cplusplus
extern "C"
{
#endif

struct woden_qname_list_or_token_any_attr_ops
{
   /** 
     * Deallocate memory
     * @return status code
     */
    axis2_status_t (AXIS2_CALL *
    free) (
            void *list_token_attr,
            const axis2_env_t *env);
    
    axis2_status_t (AXIS2_CALL *
    to_qname_list_or_token_any_attr_free) (
            void *list_token_attr,
            const axis2_env_t *env);
    
    woden_obj_types_t (AXIS2_CALL *
    type) (
            void *list_token_attr,
            const axis2_env_t *env);

    /**
     * @return the base implementation class
     */
    woden_xml_attr_t *(AXIS2_CALL *
    get_base_impl) (
            void *list_token_attr,
            const axis2_env_t *env);

    /* ************************************************************
     *  QNameAttr interface declared methods 
     * ************************************************************/

    axis2_bool_t (AXIS2_CALL *
    is_qname_list) (
            void *list_token_attr,
            const axis2_env_t *env); 

    axis2_bool_t (AXIS2_CALL *
    is_token) (
            void *list_token_attr,
            const axis2_env_t *env);


    axis2_array_list_t *(AXIS2_CALL *
    get_qnames) (
            void *list_token_attr,
            const axis2_env_t *env);

    axis2_char_t *(AXIS2_CALL *
    get_token) (
            void *list_token_attr,
            const axis2_env_t *env);

    /* ************************************************************
     *  Non-API implementation methods 
     * ************************************************************/

    /*
     * Convert a string of type "Union of list of xs:QName or xs:token #any" to a 
     * axis2_qname_t or  array or a String.
     * A null argument will return a null value.
     * Any conversion error will be reported and a null value will be returned.
     */
    void *(AXIS2_CALL *
    convert) (
            void *list_token_attr,
            const axis2_env_t *env,
            struct axiom_element *owner_el,
            struct axiom_node *owner_node,
            axis2_char_t *attr_value);

};

struct woden_qname_list_or_token_any_attr
{
    woden_xml_attr_t base;
    woden_qname_list_or_token_any_attr_ops_t *ops;
};

/*
 * TODO This constructor is not used for extension attributes, but may be useful if
 * parsing of native WSDL attributes is changed to use the XMLAttr interface.
 */
AXIS2_EXTERN woden_qname_list_or_token_any_attr_t * AXIS2_CALL
woden_qname_list_or_token_any_attr_create(
        const axis2_env_t *env,
        struct axiom_element *owner_el,
        struct axiom_node *owner_node,
        axis2_qname_t *attr_type,
        axis2_char_t *attr_value);


/************************Woden C Internal Methods******************************/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
woden_qname_list_or_token_any_attr_resolve_methods(
        woden_qname_list_or_token_any_attr_t *list_token_attr,
        const axis2_env_t *env,
        axis2_hash_t *methods);
/************************End of Woden C Internal Methods***********************/

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_FREE(list_token_attr, env) \
      (((woden_qname_list_or_token_any_attr_t *) \
          list_token_attr)->ops->free(list_token_attr, env))

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_TO_QNAME_LIST_OR_TOKEN_ANY_ATTR_FREE(\
        list_token_attr, env) \
      (((woden_qname_list_or_token_any_attr_t *) list_token_attr)->ops->\
         to_qname_list_or_token_any_attr_free(list_token_attr, env))

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_TYPE(list_token_attr, env) \
      (((woden_qname_list_or_token_any_attr_t *) list_token_attr)->ops->\
         type(list_token_attr, env))

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_GET_BASE_IMPL(list_token_attr, \
        env) \
      (((woden_qname_list_or_token_any_attr_t *) \
          list_token_attr)->ops->get_base_impl(list_token_attr, \
                                                          env))

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_IS_QNAME_LIST(list_token_attr, \
        env) \
      (((woden_qname_list_or_token_any_attr_t *) \
          list_token_attr)->ops->is_qname_list(list_token_attr, \
                                                            env))

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_IS_TOKEN(list_token_attr, env) \
      (((woden_qname_list_or_token_any_attr_t *) \
          list_token_attr)->ops->is_token(list_token_attr, \
                                                       env))

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_GET_QNAMES(list_token_attr, \
        env) \
      (((woden_qname_list_or_token_any_attr_t *) \
          list_token_attr)->ops->get_qnames(list_token_attr, \
                                                         env))

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_GET_TOKEN(list_token_attr, \
        env) \
      (((woden_qname_list_or_token_any_attr_t *) \
          list_token_attr)->ops->get_token(list_token_attr, \
                                                         env))

#define WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_CONVERT(list_token_attr, env) \
      (((woden_qname_list_or_token_any_attr_t *) \
          list_token_attr)->ops->convert(list_token_attr, \
                                                      env))

/** @} */
#ifdef __cplusplus
}
#endif
#endif /* WODEN_QNAME_LIST_OR_TOKEN_ANY_ATTR_H */