woden/include/woden_documentation.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_DOCUMENTATION_H
#define WODEN_DOCUMENTATION_H

/**
 * @file woden_documentation.h
 * @brief Axis2 Documentation Interface
 * This class implements support for parsing, creating and manipulating a
 * WSDL 2.0 <wsdl:documentation> XML element.
 * The <wsdl:documentation> element may contain mixed content, but this 
 * class does not attempt to understand that content. Instead it just wraps
 * the <wsdl:documentation> element's content model as a void *. 
 * 
 */

#include <woden.h>
#include <woden_documentation_element.h>
#include <woden_wsdl_element.h>

/** @defgroup woden_documentation Documentation
  * @ingroup woden
  * @{
  */

typedef union woden_documentation_base woden_documentation_base_t;
typedef struct woden_documentation woden_documentation_t;
typedef struct woden_documentation_ops woden_documentation_ops_t;
struct woden_documentation_element;

#ifdef __cplusplus
extern "C"
{
#endif

struct woden_documentation_ops
{
   /** 
     * Deallocate memory
     * @return status code
     */
    axis2_status_t (AXIS2_CALL *
    free) (void *documentation,
            const axis2_env_t *env);
    
    axis2_hash_t *(AXIS2_CALL *
    super_objs) (void *documentation,
            const axis2_env_t *env);
    
    woden_obj_types_t (AXIS2_CALL *
    type) (void *documentation,
            const axis2_env_t *env);
    /**
     * @return the base implementation class
     */
    woden_wsdl_element_t *(AXIS2_CALL *
    get_base_impl) (
            void *documentation,
            const axis2_env_t *env);
};

union woden_documentation_base
{
    woden_wsdl_element_t wsdl_element;
    woden_documentation_element_t documentation_element;
};

struct woden_documentation
{
    woden_documentation_base_t base;
    woden_documentation_ops_t *ops;
};

AXIS2_EXTERN woden_documentation_t * AXIS2_CALL
woden_documentation_create(
        const axis2_env_t *env);

/************************Woden C Internal Methods******************************/
AXIS2_EXTERN woden_documentation_t * AXIS2_CALL
woden_documentation_to_documentation_element(
        void *documentation,
        const axis2_env_t *env);

AXIS2_EXTERN woden_documentation_t * AXIS2_CALL
woden_documentation_to_attr_extensible(
        void *documentation,
        const axis2_env_t *env);

AXIS2_EXTERN woden_documentation_t * AXIS2_CALL
woden_documentation_to_element_extensible(
        void *documentation,
        const axis2_env_t *env);

AXIS2_EXTERN axis2_status_t AXIS2_CALL
woden_documentation_resolve_methods(
        woden_documentation_t *documentation,
        const axis2_env_t *env,
        woden_documentation_t *documentation_impl,
        axis2_hash_t *methods);
/************************End of Woden C Internal Methods***********************/


#define WODEN_DOCUMENTATION_FREE(documentation, env) \
      (((woden_documentation_t *) documentation)->ops->free(documentation, env))

#define WODEN_DOCUMENTATION_SUPER_OBJS(documentation, env) \
      (((woden_documentation_t *) documentation)->ops->\
         super_objs(documentation, env))

#define WODEN_DOCUMENTATION_TYPE(documentation, env) \
      (((woden_documentation_t *) documentation)->ops->type(documentation, env))

#define WODEN_DOCUMENTATION_GET_BASE_IMPL(documentation, env) \
      (((woden_documentation_t *) documentation)->ops->\
         get_base_impl(documentation, env))


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