lxml.h

Go to the documentation of this file.

/*
 * XetPan: a libEtPan! based Mail User Agent
 * Copyright (C) 2002-2003 Melvin Hadasht
 *
 * This program 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 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef LXML_H
#define LXML_H

/* #ifdef USE_MMAP */
#include <sys/stat.h>
/* #endif */

#include "cntree.h"
#include "clist.h"

typedef struct LXMLhandle_s LXMLhandle;

typedef struct LXMLelement_s LXMLelement;

typedef struct LXMLstore_s LXMLstore;

typedef struct LXMLelement_callbacks_s LXMLelement_callbacks;

struct LXMLstore_s
{
  char *attr;      
  int value_type;  
  void **dest;     
  int dest_kind;   
};

struct LXMLelement_callbacks_s
{
  char *element_name; 
  int (*callback)(cntree *atree, void **data, void **data_iter, int op); 
  void **data; 
};

enum
  {
    LXML_String = 1, 
    LXML_Int,        
    LXML_Boolean     
  };

enum
  {
    LXML_Unique = 1, 
    LXML_List        
  };

enum
  {
    LXML_None, 
    LXML_Read, 
    LXML_Write 
  };

/* XML file <-> tree conversion */

LXMLhandle *
lxml_new(void);

void
lxml_free(LXMLhandle *handle);

int
lxml_set_filename(LXMLhandle *handle, const char *filename);

int
lxml_set_encoding(LXMLhandle *handle, const char *encoding);

const char *
lxml_get_encoding(LXMLhandle *handle);

int
lxml_set_dtd(LXMLhandle *handle, const char *dtd);

const char *
lxml_get_dtd(LXMLhandle *handle);

int
lxml_file_open(LXMLhandle *handle, int mode);
  
int
lxml_file_close(LXMLhandle *handle);

cntree *
lxml_file_read(LXMLhandle *handle);

int
lxml_file_write(LXMLhandle *handle, cntree *ntree);

/* tree handling functions */

cntree *
lxml_tree_new(void);

void
lxml_tree_free(cntree *ntree);

void
lxml_tree_free_structural_data(cntree *ntree);

LXMLelement *
lxml_tree_get_element(cntree *ntree);

/* tree <-> application data conversion */

int 
lxml_tree_for_each_element_in_path(cntree *ntree, char **path,
                               int (*callback)(cntree *atree, 
                                               void *adata, 
                                               int aop), 
                               void *data,
                               int op);

int
lxml_tree_convert(cntree *ntree, LXMLelement_callbacks *element_cb, int op);

/* Element handling functions */

int
lxml_element_name(LXMLelement *element, char *name, int op);

int
lxml_element_store_attr(LXMLelement *element, LXMLstore *store, int op);

int
lxml_element_attr_count(LXMLelement *element);

#endif

/* vim: set cindent shiftwidth=2 tabstop=2 expandtab :*/  

---