/*
 *   mooutils/moomarkup.h
 *
 *   Copyright (C) 2004-2005 by Yevgen Muntyan <muntyan@math.tamu.edu>
 *
 *   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.
 *
 *   See COPYING file that comes with this distribution.
 */

#ifndef MOOUTILS_MOOMARKUP_H
#define MOOUTILS_MOOMARKUP_H

#include <glib/gerror.h>
#include <glib-object.h>

G_BEGIN_DECLS

#define MOO_TYPE_MARKUP_DOC (moo_markup_doc_get_type())

#if 0
// #define MOO_TYPE_MARKUP_NODE_TYPE (moo_markup_node_type_get_type ())
// GType moo_markup_node_type_get_type (void);
#endif

typedef enum {
    MOO_MARKUP_DOC_NODE,
    MOO_MARKUP_ELEMENT_NODE,
    MOO_MARKUP_TEXT_NODE,
    MOO_MARKUP_COMMENT_NODE
} MooMarkupNodeType;


typedef struct _MooMarkupNode MooMarkupNode;
typedef struct _MooMarkupDoc MooMarkupDoc;
typedef struct _MooMarkupElement MooMarkupElement;
typedef struct _MooMarkupText MooMarkupText;
typedef struct _MooMarkupText MooMarkupComment;


#ifndef ENABLE_DEBUG
#define MOO_MARKUP_NODE(n)      ((MooMarkupNode*)(n))
#define MOO_MARKUP_DOC(n)       ((MooMarkupDoc*)(n))
#define MOO_MARKUP_ELEMENT(n)   ((MooMarkupElement*)(n))
#define MOO_MARKUP_TEXT(n)      ((MooMarkupText*)(n))
#define MOO_MARKUP_COMMENT(n)   ((MooMarkupComment*)(n))
#else /* ENABLE_DEBUG */
MooMarkupNode      *MOO_MARKUP_NODE    (gpointer node);
MooMarkupDoc       *MOO_MARKUP_DOC     (gpointer node);
MooMarkupElement   *MOO_MARKUP_ELEMENT (gpointer node);
MooMarkupText      *MOO_MARKUP_TEXT    (gpointer node);
MooMarkupComment   *MOO_MARKUP_COMMENT (gpointer node);
#endif /* ENABLE_DEBUG */
#define MOO_MARKUP_IS_DOC(n)        ((n) != NULL && MOO_MARKUP_NODE(n)->type == MOO_MARKUP_DOC_NODE)
#define MOO_MARKUP_IS_ELEMENT(n)    ((n) != NULL && MOO_MARKUP_NODE(n)->type == MOO_MARKUP_ELEMENT_NODE)
#define MOO_MARKUP_IS_TEXT(n)       ((n) != NULL && MOO_MARKUP_NODE(n)->type == MOO_MARKUP_TEXT_NODE)
#define MOO_MARKUP_IS_COMMENT(n)    ((n) != NULL && MOO_MARKUP_NODE(n)->type == MOO_MARKUP_COMMENT_NODE)


struct _MooMarkupNode {
    void                    *_private;  /* application data */
    MooMarkupNodeType        type;      /* type of the node */
    char                    *name;      /* the name of the node */
    MooMarkupNode           *children;  /* parent->childs link */
    MooMarkupNode           *last;      /* last child link */
    MooMarkupNode           *parent;    /* child->parent link */
    MooMarkupNode           *next;      /* next sibling link  */
    MooMarkupNode           *prev;      /* previous sibling link  */
    MooMarkupDoc            *doc;       /* the containing document */
};


struct _MooMarkupDoc {
    void                    *_private;  /* application data */
    MooMarkupNodeType        type;      /* MOO_MARKUP_DOC_NODE */
    char                    *name;      /* name/filename/URI of the document */
    MooMarkupNode           *children;  /* the document tree */
    MooMarkupNode           *last;      /* last child link */
    MooMarkupNode           *parent;    /* child->parent link */
    MooMarkupNode           *next;      /* NULL */
    MooMarkupNode           *prev;      /* NULL */
    MooMarkupDoc            *doc;       /* self */
    guint                    ref_count;
};


struct _MooMarkupElement {
    void                    *_private;  /* application data */
    MooMarkupNodeType        type;      /* MOO_MARKUP_ELEMENT_NODE */
    char                    *name;      /* name */
    MooMarkupNode           *children;  /* content */
    MooMarkupNode           *last;      /* last child link */
    MooMarkupNode           *parent;    /* child->parent link */
    MooMarkupNode           *next;      /* next sibling */
    MooMarkupNode           *prev;      /* previous sibling */
    MooMarkupDoc            *doc;       /* containing document */

    char                    *content;   /* text content of the node */
    char                   **attr_names;/* NULL-terminated list of attribute names */
    char                   **attr_vals; /* NULL-terminated list of attribute values */
    guint                    n_attrs;
};


struct _MooMarkupText {
    void                    *_private;  /* application data */
    MooMarkupNodeType        type;      /* MOO_MARKUP_TEXT_NODE */
    char                    *name;      /* "TEXT" */
    MooMarkupNode           *children;  /* NULL */
    MooMarkupNode           *last;      /* NULL */
    MooMarkupNode           *parent;    /* child->parent link */
    MooMarkupNode           *next;      /* next sibling link  */
    MooMarkupNode           *prev;      /* previous sibling link  */
    MooMarkupDoc            *doc;       /* the containing document */

    char                    *text;      /* 0-terminated content of the node */
    guint                    size;      /* strlen (text) */
};


GType            moo_markup_doc_get_type    (void);

MooMarkupDoc    *moo_markup_doc_new         (const char         *name);

MooMarkupDoc    *moo_markup_parse_file      (const char         *filename,
                                             GError            **error);
MooMarkupDoc    *moo_markup_parse_memory    (const char         *buffer,
                                             int                 size,
                                             GError            **error);
gboolean         moo_markup_save            (MooMarkupDoc       *doc,
                                             const char         *filename,
                                             GError            **error);

char            *moo_markup_node_get_string (MooMarkupNode      *node);

MooMarkupDoc    *moo_markup_doc_ref         (MooMarkupDoc       *doc);
void             moo_markup_doc_unref       (MooMarkupDoc       *doc);

MooMarkupElement*moo_markup_get_root_element(MooMarkupDoc       *doc,
                                             const char         *name);
MooMarkupElement*moo_markup_get_element     (MooMarkupNode      *node,
                                             const char         *path);

const char      *moo_markup_get_prop        (MooMarkupElement   *node,
                                             const char         *prop_name);
char            *moo_markup_element_get_path(MooMarkupElement   *node);

void             moo_markup_delete_node     (MooMarkupNode      *node);
MooMarkupElement*moo_markup_create_root_element
                                            (MooMarkupDoc       *doc,
                                             const char         *name);
void             moo_markup_create_text_element
                                            (MooMarkupElement   *node,
                                             const char         *path,
                                             const char         *content);


G_END_DECLS

#endif /* MOOUTILS_MOOMARKUP_H */