Main Page | Modules | Class List | Directories | File List | Class Members | File Members

axis2_om_node.h

Go to the documentation of this file.
00001 /*
00002  * Copyright 2004,2005 The Apache Software Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *      http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef AXIS2_OM_NODE_H
00018 #define AXIS2_OM_NODE_H
00019 
00031 #include <axis2_env.h>
00032 #include <axis2.h>
00033 
00034 #ifdef __cplusplus
00035 extern "C"
00036 {
00037 #endif
00038 
00039     struct axis2_om_node ;
00040     struct axis2_om_node_ops;
00041     struct axis2_om_output;
00042 
00052     typedef enum axis2_om_types_t
00053     {
00055         AXIS2_OM_INVALID = 0,
00057         AXIS2_OM_DOCUMENT,
00059         AXIS2_OM_ELEMENT,
00061         AXIS2_OM_DOCTYPE,
00063         AXIS2_OM_COMMENT,
00065         AXIS2_OM_ATTRIBUTE,
00067         AXIS2_OM_NAMESPACE,
00069         AXIS2_OM_PROCESSING_INSTRUCTION,
00071         AXIS2_OM_TEXT
00072     } axis2_om_types_t;
00073 
00078   AXIS2_DECLARE_DATA   typedef struct axis2_om_node_ops
00079     {
00086         axis2_status_t (AXIS2_CALL *free) (struct axis2_om_node *om_node,
00087                                            axis2_env_t **env);
00095         axis2_status_t (AXIS2_CALL *add_child) (struct axis2_om_node *om_node,
00096                                                 axis2_env_t **env,
00097                                                 struct axis2_om_node *parent);
00098 
00106         struct axis2_om_node *(AXIS2_CALL *detach) (struct axis2_om_node *om_node,
00107                                                     axis2_env_t **env);
00108 
00116         axis2_status_t (AXIS2_CALL *insert_sibling_after)
00117                                         (struct axis2_om_node *om_node,
00118                                          axis2_env_t **env,
00119                                          struct axis2_om_node * node_to_insert);
00120 
00128         axis2_status_t (AXIS2_CALL *insert_sibling_before)
00129                                          (struct axis2_om_node *om_node,
00130                                           axis2_env_t **env,
00131                                           struct axis2_om_node * node_to_insert);
00132 
00141         axis2_status_t (AXIS2_CALL *set_parent) (struct axis2_om_node *om_node,
00142                                                  axis2_env_t **env,
00143                                                  struct axis2_om_node *parent_node);
00144 
00145        
00154         axis2_status_t (AXIS2_CALL *serialize) (struct axis2_om_node * om_node, axis2_env_t **env,
00155                                     struct axis2_om_output *om_output);
00163         struct axis2_om_node* (AXIS2_CALL *get_parent)
00164                                             (struct axis2_om_node *om_node,
00165                                              axis2_env_t **env);
00166 
00175         struct axis2_om_node* (AXIS2_CALL *get_first_child)
00176                                                     (struct axis2_om_node *om_node,
00177                                                     axis2_env_t **env);
00185         struct axis2_om_node* (AXIS2_CALL *get_last_child)
00186                                             (struct axis2_om_node *om_node,
00187                                              axis2_env_t **env);
00196         struct axis2_om_node* (AXIS2_CALL *get_previous_sibling)
00197                                             (struct axis2_om_node *om_node,
00198                                             axis2_env_t **env);
00207         struct axis2_om_node* (AXIS2_CALL *get_next_sibling)
00208                                             (struct axis2_om_node *om_node,
00209                                              axis2_env_t **env);
00219         axis2_om_types_t (AXIS2_CALL *get_node_type)
00220                                             (struct axis2_om_node *om_node,
00221                                              axis2_env_t **env);
00231         void* (AXIS2_CALL *get_data_element)(struct axis2_om_node *om_node,
00232                                              axis2_env_t **env);    
00240         axis2_bool_t (AXIS2_CALL *get_build_status)
00241                                             (struct axis2_om_node *om_node,
00242                                              axis2_env_t **env); 
00250         axis2_status_t (AXIS2_CALL *set_first_child)
00251                                             (struct axis2_om_node *om_node,
00252                                              axis2_env_t **env,
00253                                              struct axis2_om_node *first_child);
00262         axis2_status_t (AXIS2_CALL *set_last_child)
00263                                              (struct axis2_om_node *om_node,
00264                                               axis2_env_t **env,
00265                                               struct axis2_om_node *last_child);
00274         axis2_status_t (AXIS2_CALL *set_next_sibling)
00275                                             (struct axis2_om_node *om_node,
00276                                              axis2_env_t **env,
00277                                              struct axis2_om_node *last_sibling);
00287         axis2_status_t (AXIS2_CALL *set_previous_sibling)
00288                                             (struct axis2_om_node *om_node,
00289                                              axis2_env_t **env,
00290                                              struct axis2_om_node *prev_sibling);
00300         axis2_status_t (AXIS2_CALL *set_node_type)
00301                                             (struct axis2_om_node *om_node,
00302                                              axis2_env_t **env,
00303                                              axis2_om_types_t type);
00312         axis2_status_t (AXIS2_CALL *set_data_element)
00313                                             (struct axis2_om_node *om_node,
00314                                              axis2_env_t **env,
00315                                              void* data_element);
00323         axis2_status_t (AXIS2_CALL *set_build_status)
00324                                             (struct axis2_om_node *om_node,
00325                                              axis2_env_t **env,
00326                                              axis2_bool_t done);
00327     } axis2_om_node_ops_t;
00328 
00329 
00334     typedef struct axis2_om_node
00335     {
00337         axis2_om_node_ops_t *ops;
00338                
00339     } axis2_om_node_t;
00340 
00346 AXIS2_DECLARE(axis2_om_node_t *) axis2_om_node_create (axis2_env_t **env);
00347 
00349 #define AXIS2_OM_NODE_FREE_TREE(om_node,env) ((om_node)->ops->free(om_node,env))
00352 #define AXIS2_OM_NODE_ADD_CHILD(om_node,env,parent) \
00353         ((parent)->ops->add_child(om_node,env,parent))
00356 #define AXIS2_OM_NODE_DETACH(om_node,env) ((om_node)->ops->detach(om_node,env))
00359 #define AXIS2_OM_NODE_INSERT_SIBLING_AFTER(om_node,env,node_to_insert) \
00360         ((om_node)->ops->insert_sibling_after(om_node,env,node_to_insert))
00362 #define AXIS2_OM_NODE_INSERT_SIBLING_BEFORE(om_node,env,node_to_insert) \
00363         ((om_node)->ops->insert_sibling_before(om_node,env,node_to_insert))
00364    
00366 #define AXIS2_OM_NODE_SET_PARENT(om_node,env,parent_node) \
00367         ((om_node)->ops->set_parent(om_node,env,parent_node))
00369 #define AXIS2_OM_NODE_SERIALIZE(om_node,env, om_output) \
00370         ((om_node)->ops->serialize(om_node,env,om_output))
00372 #define AXIS2_OM_NODE_GET_PARENT(om_node,env) \
00373         ((om_node)->ops->get_parent(om_node,env))
00375 #define AXIS2_OM_NODE_GET_FIRST_CHILD(om_node,env) \
00376         ((om_node)->ops->get_first_child(om_node,env))
00378 #define AXIS2_OM_NODE_GET_LAST_CHILD(om_node,env) \
00379         ((om_node)->ops->get_last_child(om_node,env))
00381 #define AXIS2_OM_NODE_GET_NEXT_SIBLING(om_node,env) \
00382         ((om_node)->ops->get_next_sibling(om_node,env))
00384 #define AXIS2_OM_NODE_GET_PREVIOUS_SIBLING(om_node,env) \
00385         ((om_node)->ops->get_previous_sibling(om_node,env))
00387 #define AXIS2_OM_NODE_GET_BUILD_STATUS(om_node,env) \
00388         ((om_node)->ops->get_build_status(om_node,env))
00390 #define AXIS2_OM_NODE_GET_DATA_ELEMENT(om_node,env) \
00391         ((om_node)->ops->get_data_element(om_node,env))
00392         
00394 #define AXIS2_OM_NODE_GET_NODE_TYPE(om_node,env) \
00395         ((om_node)->ops->get_node_type(om_node,env))       
00396 /*** set last child  */
00397 #define AXIS2_OM_NODE_SET_LAST_CHILD(om_node,env,last_child) \
00398         ((om_node)->ops->set_last_child(om_node,env,last_child))
00400 #define AXIS2_OM_NODE_SET_FIRST_CHILD(om_node,env,first_child)\
00401         ((om_node)->ops->set_first_child(om_node,env,first_child))
00403 #define AXIS2_OM_NODE_SET_PREVIOUS_SIBLING(om_node,env,prev_sibling) \
00404         ((om_node)->ops->set_previous_sibling(om_node,env,prev_sibling))
00406 #define AXIS2_OM_NODE_SET_NEXT_SIBLING(om_node,env,next_sibling) \
00407         ((om_node)->ops->set_next_sibling(om_node,env,next_sibling))
00409 #define AXIS2_OM_NODE_SET_BUILD_STATUS(om_node,env,done) \
00410         ((om_node)->ops->set_build_status(om_node,env,done))
00412 #define AXIS2_OM_NODE_SET_DATA_ELEMENT(om_node,env,data_element) \
00413         ((om_node)->ops->set_data_element(om_node,env,data_element))
00415 #define AXIS2_OM_NODE_SET_NODE_TYPE(om_node,env,node_type) \
00416         ((om_node)->ops->set_node_type(om_node,env,node_type))  
00417 
00420 #ifdef __cplusplus
00421 }
00422 #endif
00423 
00424 #endif                          /* AXIS2_OM_NODE_H */

Generated on Thu Nov 24 13:58:30 2005 for Axis2/C by  doxygen 1.4.2