---

mlview-parsing-utils.h

Go to the documentation of this file.

/*
 *This file is part of MlView
 *
 *MlView is free software; you can redistribute it and/or modify it under the terms of 
 *the GNU General Public License as published by the Free Software Foundation; either version 2, 
 *or (at your option) any later version.
 *
 *MlView is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 *without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *See the GNU General Public License for more details.
 *
 *You should have received a copy of the GNU General Public License along with MlView; 
 *see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *
 *Copyright 2001-2002 Dodji Seketeli.
 */

#ifndef __MLVIEW_PARSING_UTILS_H__
#define __MLVIEW_PARSING_UTILS_H__

#ifdef __cplusplus
extern "C" {
#endif /*__cplusplus*/

#include <gnome.h>
#include <libxml/tree.h>
#include "mlview-app-context.h"


        enum NODE_INSERTION_SCHEME {
                /*Insert node before current selected node*/
                INSERT_BEFORE,

                /*insert node after current selected node*/
                INSERT_AFTER,

                /*add a child node*/
                ADD_CHILD
        };

        enum MLVIEW_PARSING_UTILS_STATUS {
                OK = 0,
                NOK,
                GENERIC_ASSERTION_ERROR,
                /*GENERIC VALUES*/

                BAD_PARAMETER,
                APP_SETTINGS_NOT_AVAILABLE,
                VALIDATION_IS_OFF,

                /*function specific values*/

                NO_SUBTREE_REQUIRED_BY_SCHEMA,
                ELEMENT_DESC_NOT_FOUND,
                ATTRIBUTE_DESC_NOT_FOUND,
                NULL_ELEMENT_CONTENT
        } ;


        typedef struct _MlViewExternalSubsetDefinition MlViewExternalSubsetDefinition ;
/*a data structure to define an external subset.*/
        struct _MlViewExternalSubsetDefinition{
                gchar * external_id ; /*the entity public id*/
                gchar * system_id ;
                gchar * root_element_name ;
        } ;

        MlViewExternalSubsetDefinition * 
        mlview_external_subset_definition_new(const gchar *a_root_element_name,
                                              const gchar * a_external_id,
                                              const gchar * a_system_id) ;

        void 
        mlview_external_subset_definition_destroy (MlViewExternalSubsetDefinition * a_def) ;

        MlViewExternalSubsetDefinition * 
        mlview_utils_get_a_copy_of_last_external_subset_def (void) ;

        xmlDoc * 
        mlview_parsing_utils_load_xml_file (gchar * a_file_name, 
                                            MlViewAppContext *a_app_context) ;

        xmlDtd * 
        mlview_parsing_utils_load_a_dtd (MlViewExternalSubsetDefinition * a_subset_def,
                                         MlViewAppContext * a_app_context) ;

        gint 
        mlview_parsing_utils_validate_dtd (xmlDoc * a_doc, xmlDtd * a_dtd, 
                                           MlViewAppContext * a_app_context) ;

        gint 
        mlview_parsing_utils_save_xml_doc (xmlDoc * a_xml_doc, gchar * a_file_path,
                                           MlViewAppContext * a_app_context);

        MlViewExternalSubsetDefinition  * 
        mlview_parsing_utils_let_user_choose_a_dtd (MlViewAppContext * a_app_context,
                                                    gchar *a_title) ;

        gint 
        mlview_parsing_utils_build_element_name_completion_list (MlViewAppContext *a_app_context,
                                                                 enum NODE_INSERTION_SCHEME a_insertion_scheme,
                                                                 xmlNode *a_current_xml_node,
                                                                 GList ** a_feasible_names_ptr) ;

        gint 
        mlview_parsing_utils_build_attribute_name_completion_list (MlViewAppContext *a_app_context,
                                                                   xmlNode * a_current_xml_node,
                                                                   GList**a_attr_names_compl_list,
                                                                   gboolean a_required_attributes_only) ;
        
        enum MLVIEW_PARSING_UTILS_STATUS
        mlview_parsing_utils_get_element_content_table (MlViewAppContext * a_app_context,
                                                        xmlElementContent *a_element_content,
                                                        GHashTable **a_element_content_table) ;

        enum MLVIEW_PARSING_UTILS_STATUS
        mlview_parsing_utils_build_required_children_tree (MlViewAppContext * a_app_context,
                                                           xmlNode **a_node) ;

        enum MLVIEW_PARSING_UTILS_STATUS
        mlview_parsing_utils_build_required_attributes_list (MlViewAppContext * a_app_context,
                                                             xmlNode *a_node) ;

        GList *
        mlview_parsing_utils_build_attribute_value_set (MlViewAppContext *a_app_context, 
                                                        xmlAttribute * a_attribute_desc,
                                                        gint *a_last_id) ;

        GList *
        mlview_parsing_utils_build_graphical_attribute_value_set (MlViewAppContext *a_app_context,
                                                                  xmlAttribute * a_attribute_desc,
                                                                  gint *a_last_id) ;

#ifdef __cplusplus
}
#endif /*__cplusplus*/

#endif

---