diff options
Diffstat (limited to 'axiom/src/om')
| -rw-r--r-- | axiom/src/om/axiom_document_internal.h | 240 | ||||
| -rw-r--r-- | axiom/src/om/axiom_element_internal.h | 294 | 
2 files changed, 267 insertions, 267 deletions
| diff --git a/axiom/src/om/axiom_document_internal.h b/axiom/src/om/axiom_document_internal.h index daf28c8..44c65ba 100644 --- a/axiom/src/om/axiom_document_internal.h +++ b/axiom/src/om/axiom_document_internal.h @@ -1,120 +1,120 @@ -/*
 - * 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 AXIOM_DOCUMENT_INTERNAL_H_
 -#define AXIOM_DOCUMENT_INTERNAL_H_
 -
 -#include <axiom_document.h>
 -
 -#ifdef __cplusplus
 -extern "C"
 -{
 -#endif
 -
 -    /**
 -      * creates an axiom_document_t struct
 -      * @param env Environment. MUST NOT be NULL.
 -      * @param root pointer to document's root node. Optional, can be NULL
 -      * @param builder pointer to axiom_stax_builder
 -      * @return pointer to the newly created document.
 -      */
 -    axiom_document_t *AXIS2_CALL
 -    axiom_document_create(
 -        const axutil_env_t * env,
 -        axiom_node_t * root,
 -        struct axiom_stax_builder *builder);
 -
 -    /**
 -      * Free document struct
 -      * @param document pointer to axiom_document_t struct to be freed
 -      * @param env Environment. MUST NOT be NULL
 -      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE.
 -      */
 -    void AXIS2_CALL
 -    axiom_document_free(
 -        struct axiom_document *document,
 -        const axutil_env_t * env);
 -
 -    /**
 -     * Free document struct only, Does not free the associated axiom structure.
 -     * @param document pointer to axiom_document_t struct to be freed
 -     * @param env Environment. MUST NOT be NULL
 -     * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE.
 -     */
 -    void AXIS2_CALL
 -    axiom_document_free_self(
 -        struct axiom_document *document,
 -        const axutil_env_t * env);
 -
 -    /**
 -      * set the root element of the document. IF a root node is already exist,it is freed
 -      * before setting to root element
 -      * @param document document struct to return the root of
 -      * @param env Environment. MUST NOT be NULL.
 -      * @return returns status code AXIS2_SUCCESS on success ,AXIS2_FAILURE on error.
 -      */
 -    axis2_status_t AXIS2_CALL
 -    axiom_document_set_root_element(
 -        struct axiom_document *document,
 -        const axutil_env_t * env,
 -        axiom_node_t * om_node);
 -
 -#if 0
 -    /* these methods are commented, because it is not used anymore (1.6.0)*/
 -
 -    /**
 -     * get builder
 -     * @param document pointer to axiom_document_t struct to be built.
 -     * @param env environment MUST NOT be NULL.
 -     * @return builder, returns NULL if a builder is not associated with
 -     * document
 -     */
 -    AXIS2_EXTERN struct axiom_stax_builder *AXIS2_CALL
 -    axiom_document_get_builder(
 -        struct axiom_document *document,
 -        const axutil_env_t * env);
 -
 -    /**
 -     * sets builder for document.
 -     * @param document pointer to axiom_document_t struct to be built.
 -     * @param env environment MUST NOT be NULL.
 -     * @param builder pointer to builder to associate with document
 -     */
 -    AXIS2_EXTERN void AXIS2_CALL
 -    axiom_document_set_builder(
 -        axiom_document_t * document,
 -        const axutil_env_t * env,
 -        struct axiom_stax_builder * builder);
 -
 -    /**
 -     * @param om_document
 -     * @return status code AXIS2_SUCCESS on success , otherwise AXIS2_FAILURE
 -     */
 -    AXIS2_EXTERN axis2_status_t AXIS2_CALL
 -    axiom_document_serialize(
 -        struct axiom_document *document,
 -        const axutil_env_t * env,
 -        axiom_output_t * om_output);
 -
 -
 -#endif
 -
 -#ifdef __cplusplus
 -}
 -#endif
 -
 -#endif /* AXIOM_DOCUMENT_INTERNAL_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 AXIOM_DOCUMENT_INTERNAL_H_ +#define AXIOM_DOCUMENT_INTERNAL_H_ + +#include <axiom_document.h> + +#ifdef __cplusplus +extern "C" +{ +#endif + +    /** +      * creates an axiom_document_t struct +      * @param env Environment. MUST NOT be NULL. +      * @param root pointer to document's root node. Optional, can be NULL +      * @param builder pointer to axiom_stax_builder +      * @return pointer to the newly created document. +      */ +    axiom_document_t *AXIS2_CALL +    axiom_document_create( +        const axutil_env_t * env, +        axiom_node_t * root, +        struct axiom_stax_builder *builder); + +    /** +      * Free document struct +      * @param document pointer to axiom_document_t struct to be freed +      * @param env Environment. MUST NOT be NULL +      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE. +      */ +    void AXIS2_CALL +    axiom_document_free( +        struct axiom_document *document, +        const axutil_env_t * env); + +    /** +     * Free document struct only, Does not free the associated axiom structure. +     * @param document pointer to axiom_document_t struct to be freed +     * @param env Environment. MUST NOT be NULL +     * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE. +     */ +    void AXIS2_CALL +    axiom_document_free_self( +        struct axiom_document *document, +        const axutil_env_t * env); + +    /** +      * set the root element of the document. IF a root node is already exist,it is freed +      * before setting to root element +      * @param document document struct to return the root of +      * @param env Environment. MUST NOT be NULL. +      * @return returns status code AXIS2_SUCCESS on success ,AXIS2_FAILURE on error. +      */ +    axis2_status_t AXIS2_CALL +    axiom_document_set_root_element( +        struct axiom_document *document, +        const axutil_env_t * env, +        axiom_node_t * om_node); + +#if 0 +    /* these methods are commented, because it is not used anymore (1.6.0)*/ + +    /** +     * get builder +     * @param document pointer to axiom_document_t struct to be built. +     * @param env environment MUST NOT be NULL. +     * @return builder, returns NULL if a builder is not associated with +     * document +     */ +    AXIS2_EXTERN struct axiom_stax_builder *AXIS2_CALL +    axiom_document_get_builder( +        struct axiom_document *document, +        const axutil_env_t * env); + +    /** +     * sets builder for document. +     * @param document pointer to axiom_document_t struct to be built. +     * @param env environment MUST NOT be NULL. +     * @param builder pointer to builder to associate with document +     */ +    AXIS2_EXTERN void AXIS2_CALL +    axiom_document_set_builder( +        axiom_document_t * document, +        const axutil_env_t * env, +        struct axiom_stax_builder * builder); + +    /** +     * @param om_document +     * @return status code AXIS2_SUCCESS on success , otherwise AXIS2_FAILURE +     */ +    AXIS2_EXTERN axis2_status_t AXIS2_CALL +    axiom_document_serialize( +        struct axiom_document *document, +        const axutil_env_t * env, +        axiom_output_t * om_output); + + +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* AXIOM_DOCUMENT_INTERNAL_H_ */ diff --git a/axiom/src/om/axiom_element_internal.h b/axiom/src/om/axiom_element_internal.h index adbce79..df515f9 100644 --- a/axiom/src/om/axiom_element_internal.h +++ b/axiom/src/om/axiom_element_internal.h @@ -1,147 +1,147 @@ -/*
 - * 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 AXIOM_ELEMENT_INTERNAL_H_
 -#define AXIOM_ELEMENT_INTERNAL_H_
 -
 -/** @defgroup axiom AXIOM (Axis Object Model)
 - * @ingroup axis2
 - * @{
 - */
 -
 -/** @} */
 -
 -#include <axiom_element.h>
 -
 -#ifdef __cplusplus
 -extern "C"
 -{
 -#endif
 -
 -    /**
 -     * @defgroup axiom_element element
 -     * @ingroup axiom
 -     * @{
 -     */
 -
 -    /**
 -     * Collect all the namespaces with distinct prefixes in the parents of the given element.
 -     * Effectively this is the set of namespaces declared above this element that are inscope at
 -     * this element and might be used by it or its children.
 -     * @param om_element pointer to om_element
 -     * @param env environment MUST not be NULL
 -     * @param om_node pointer to this element node
 -     * @returns pointer to hash of relevant namespaces
 -     */
 -    axutil_hash_t * AXIS2_CALL
 -    axiom_element_gather_parent_namespaces(
 -        axiom_element_t * om_element,
 -        const axutil_env_t * env,
 -        axiom_node_t * om_node);
 -
 -    /**
 -     * Examines the subtree beginning at the provided element for each element or attribute,
 -     * if it refers to a namespace declared in a parent of the subtree root element, if not already
 -     * declared, redeclares that namespace at the level of the subtree root and removes
 -     * it from the set of parent inscope_namespaces. inscope_namespaces contains all the parent
 -     * namespaces which should be redeclared at some point.
 -     * @param om_element pointer to om_element
 -     * @param env environment MUST not be NULL
 -     * @param om_node pointer to this element node
 -     * @param inscope_namespaces pointer to hash of parent namespaces
 -     */
 -    void AXIS2_CALL
 -    axiom_element_redeclare_parent_namespaces(
 -        axiom_element_t * om_element,
 -        const axutil_env_t * env,
 -        axiom_node_t * om_node,
 -        axutil_hash_t *inscope_namespaces);
 -
 -    /**
 -     * If the provided namespace used by the provided element is one of the namespaces from the
 -     * parent of the root element, redeclares that namespace at the root element and removes it
 -     * from the hash of parent namespaces
 -     * @param om_element pointer to om_element
 -     * @param env environment MUST not be NULL
 -     * @param om_node pointer to this element node
 -     * @param ns pointer to namespace to redeclare
 -     * @param inscope_namespaces pointer to hash of parent namespaces
 -     */
 -    void AXIS2_CALL
 -    axiom_element_use_parent_namespace(
 -        axiom_element_t * om_element,
 -        const axutil_env_t * env,
 -        axiom_node_t * om_node,
 -        axiom_namespace_t *ns,
 -        axutil_hash_t *inscope_namespaces);
 -
 -    /**
 -     * retrieves the default namespace of this element
 -     * @param om_element pointer to om element
 -     * @param env axutil_environment MUST Not be NULL
 -     * @param element_node corresponding om element node of this om element
 -     * @returns pointer to default namespace if available , NULL otherwise
 -     */
 -    axiom_namespace_t *AXIS2_CALL
 -    axiom_element_get_default_namespace(
 -        axiom_element_t * om_element,
 -        const axutil_env_t * env,
 -        axiom_node_t * element_node);
 -
 -    /**
 -     * Serializes the start part of the given element
 -     * @param element element to be serialized.
 -     * @param env Environment. MUST NOT be NULL.
 -     * @param om_output AXIOM output handler to be used in serializing
 -     * @return status of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE
 -     */
 -    axis2_status_t AXIS2_CALL
 -    axiom_element_serialize_start_part(
 -        axiom_element_t * om_element,
 -        const axutil_env_t * env,
 -        axiom_output_t * om_output,
 -        axiom_node_t * ele_node);
 -
 -    /**
 -     * Serializes the end part of the given element. serialize_start_part must
 -     *     have been called before calling this method.
 -     * @param om_element pointer to om_element
 -     * @param env environment MUST not be NULL
 -     * @param om_node pointer to this element node
 -     * @param om_output AXIOM output handler to be used in serializing
 -     * @return status of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE
 -     */
 -    axis2_status_t AXIS2_CALL
 -    axiom_element_serialize_end_part(
 -        axiom_element_t * om_element,
 -        const axutil_env_t * env,
 -        axiom_output_t * om_output);
 -
 -    /**
 -     * Set whether the element is empty or not
 -     * @param om_element pointer to om_element
 -     * @param env environment MUST not be NULL
 -     * @param is_empty AXIS2_TRUE if empty AXIS2_FALSE if not empty
 -     * @return VOID
 -     */
 -    void AXIS2_CALL
 -    axiom_element_set_is_empty(
 -        axiom_element_t * om_element,
 -        const axutil_env_t * env,
 -        axis2_bool_t is_empty);
 -
 -#endif /* AXIOM_ELEMENT_INTERNAL_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 AXIOM_ELEMENT_INTERNAL_H_ +#define AXIOM_ELEMENT_INTERNAL_H_ + +/** @defgroup axiom AXIOM (Axis Object Model) + * @ingroup axis2 + * @{ + */ + +/** @} */ + +#include <axiom_element.h> + +#ifdef __cplusplus +extern "C" +{ +#endif + +    /** +     * @defgroup axiom_element element +     * @ingroup axiom +     * @{ +     */ + +    /** +     * Collect all the namespaces with distinct prefixes in the parents of the given element. +     * Effectively this is the set of namespaces declared above this element that are inscope at +     * this element and might be used by it or its children. +     * @param om_element pointer to om_element +     * @param env environment MUST not be NULL +     * @param om_node pointer to this element node +     * @returns pointer to hash of relevant namespaces +     */ +    axutil_hash_t * AXIS2_CALL +    axiom_element_gather_parent_namespaces( +        axiom_element_t * om_element, +        const axutil_env_t * env, +        axiom_node_t * om_node); + +    /** +     * Examines the subtree beginning at the provided element for each element or attribute, +     * if it refers to a namespace declared in a parent of the subtree root element, if not already +     * declared, redeclares that namespace at the level of the subtree root and removes +     * it from the set of parent inscope_namespaces. inscope_namespaces contains all the parent +     * namespaces which should be redeclared at some point. +     * @param om_element pointer to om_element +     * @param env environment MUST not be NULL +     * @param om_node pointer to this element node +     * @param inscope_namespaces pointer to hash of parent namespaces +     */ +    void AXIS2_CALL +    axiom_element_redeclare_parent_namespaces( +        axiom_element_t * om_element, +        const axutil_env_t * env, +        axiom_node_t * om_node, +        axutil_hash_t *inscope_namespaces); + +    /** +     * If the provided namespace used by the provided element is one of the namespaces from the +     * parent of the root element, redeclares that namespace at the root element and removes it +     * from the hash of parent namespaces +     * @param om_element pointer to om_element +     * @param env environment MUST not be NULL +     * @param om_node pointer to this element node +     * @param ns pointer to namespace to redeclare +     * @param inscope_namespaces pointer to hash of parent namespaces +     */ +    void AXIS2_CALL +    axiom_element_use_parent_namespace( +        axiom_element_t * om_element, +        const axutil_env_t * env, +        axiom_node_t * om_node, +        axiom_namespace_t *ns, +        axutil_hash_t *inscope_namespaces); + +    /** +     * retrieves the default namespace of this element +     * @param om_element pointer to om element +     * @param env axutil_environment MUST Not be NULL +     * @param element_node corresponding om element node of this om element +     * @returns pointer to default namespace if available , NULL otherwise +     */ +    axiom_namespace_t *AXIS2_CALL +    axiom_element_get_default_namespace( +        axiom_element_t * om_element, +        const axutil_env_t * env, +        axiom_node_t * element_node); + +    /** +     * Serializes the start part of the given element +     * @param element element to be serialized. +     * @param env Environment. MUST NOT be NULL. +     * @param om_output AXIOM output handler to be used in serializing +     * @return status of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE +     */ +    axis2_status_t AXIS2_CALL +    axiom_element_serialize_start_part( +        axiom_element_t * om_element, +        const axutil_env_t * env, +        axiom_output_t * om_output, +        axiom_node_t * ele_node); + +    /** +     * Serializes the end part of the given element. serialize_start_part must +     *     have been called before calling this method. +     * @param om_element pointer to om_element +     * @param env environment MUST not be NULL +     * @param om_node pointer to this element node +     * @param om_output AXIOM output handler to be used in serializing +     * @return status of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE +     */ +    axis2_status_t AXIS2_CALL +    axiom_element_serialize_end_part( +        axiom_element_t * om_element, +        const axutil_env_t * env, +        axiom_output_t * om_output); + +    /** +     * Set whether the element is empty or not +     * @param om_element pointer to om_element +     * @param env environment MUST not be NULL +     * @param is_empty AXIS2_TRUE if empty AXIS2_FALSE if not empty +     * @return VOID +     */ +    void AXIS2_CALL +    axiom_element_set_is_empty( +        axiom_element_t * om_element, +        const axutil_env_t * env, +        axis2_bool_t is_empty); + +#endif /* AXIOM_ELEMENT_INTERNAL_H_ */ | 
