textwriter.h File Reference

#include <mce/config.h>
#include <libxml/xmlwriter.h>
#include <mce/helper.h>

Go to the source code of this file.

Macros
#define	MCE_DEFAULT   0x0
#define	MCE_IGNORABLE   0x1
#define	MCE_MUSTUNDERSTAND   0x2

Typedefs
typedef struct MCE_TEXTWRITER_STRUCT	mceTextWriter

Functions
mceTextWriter *	mceTextWriterCreateIO (xmlOutputWriteCallback iowrite, xmlOutputCloseCallback ioclose, void *ioctx, xmlCharEncodingHandlerPtr encoder)
mceTextWriter *	mceNewTextWriterFile (FILE *file)
int	mceTextWriterFree (mceTextWriter *w)
int	mceTextWriterStartDocument (mceTextWriter *w)
int	mceTextWriterEndDocument (mceTextWriter *w)
int	mceTextWriterStartElement (mceTextWriter *w, const xmlChar *ns, const xmlChar *ln)
int	mceTextWriterEndElement (mceTextWriter *w, const xmlChar *ns, const xmlChar *ln)
int	mceTextWriterWriteString (mceTextWriter *w, const xmlChar *content)
const xmlChar *	mceTextWriterRegisterNamespace (mceTextWriter *w, const xmlChar *ns, const xmlChar *prefix, int flags)
int	mceTextWriterProcessContent (mceTextWriter *w, const xmlChar *ns, const xmlChar *ln)
int	mceTextWriterAttributeF (mceTextWriter *w, const xmlChar *ns, const xmlChar *ln, const char *value,...)
int	mceTextWriterStartAlternateContent (mceTextWriter *w)
int	mceTextWriterEndAlternateContent (mceTextWriter *w)
int	mceTextWriterStartChoice (mceTextWriter *w, const xmlChar *ns)
int	mceTextWriterEndChoice (mceTextWriter *w)
int	mceTextWriterStartFallback (mceTextWriter *w)
int	mceTextWriterEndFallback (mceTextWriter *w)
xmlTextWriterPtr	mceTextWriterIntern (mceTextWriter *w)
xmlTextWriterPtr	xmlNewTextWriterFile (FILE *file)

Macro Definition Documentation

#define MCE_DEFAULT   0x0

Default flags for an MCE namespace declaration.

Examples:

mce_write.c.

#define MCE_IGNORABLE   0x1

Flags MCE namespace declaration "ignorable".

Examples:

mce_write.c.

#define MCE_MUSTUNDERSTAND   0x2

Flags MCE namespace declaration "must understand".

Typedef Documentation

typedef struct MCE_TEXTWRITER_STRUCT mceTextWriter

The MCE text writer context.

Function Documentation

mceTextWriter* mceNewTextWriterFile

(

FILE *

file

)

Helper which create a new MCE text writer for a FILE handle.

int mceTextWriterAttributeF	(	mceTextWriter *	w,
		const xmlChar *	ns,
		const xmlChar *	ln,
		const char *	value,
			...
	)

Writes a formatted attribute.

See also

http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterWriteFormatAttribute

Examples:

mce_write.c.

mceTextWriter* mceTextWriterCreateIO	(	xmlOutputWriteCallback	iowrite,
		xmlOutputCloseCallback	ioclose,
		void *	ioctx,
		xmlCharEncodingHandlerPtr	encoder
	)

Create a new MCE text writer.

See also

http://xmlsoft.org/html/libxml-xmlIO.html#xmlOutputBufferCreateIO

http://xmlsoft.org/html/libxml-xmlwriter.html#xmlNewTextWriter

int mceTextWriterEndAlternateContent

(

mceTextWriter *

w

)

Ends an MCE alternate content section.

int mceTextWriterEndChoice

(

mceTextWriter *

w

)

Ends an MCE choice.

int mceTextWriterEndDocument

(

mceTextWriter *

w

)

See also

http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterEndDocument

Examples:

mce_write.c.

int mceTextWriterEndElement	(	mceTextWriter *	w,
		const xmlChar *	ns,
		const xmlChar *	ln
	)

See also

http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterEndElement

Examples:

mce_write.c.

int mceTextWriterEndFallback

(

mceTextWriter *

w

)

Ends an MCE fallback.

int mceTextWriterFree

(

mceTextWriter *

w

)

Free all resources for .

Examples:

mce_write.c.

xmlTextWriterPtr mceTextWriterIntern

(

mceTextWriter *

w

)

Returns the underlying xmlTextWriter.

int mceTextWriterProcessContent	(	mceTextWriter *	w,
		const xmlChar *	ns,
		const xmlChar *	ln
	)

Register qname (ns, ln) as a "process content" element wrt. MCE. Must be called before mceTextWriterStartElement.

Examples:

mce_write.c.

const xmlChar* mceTextWriterRegisterNamespace	(	mceTextWriter *	w,
		const xmlChar *	ns,
		const xmlChar *	prefix,
		int	flags
	)

Register a namespace. Must be called before mceTextWriterStartElement.

See also

MCE_DEFAULT

MCE_IGNORABLE

MCE_MUSTUNDERSTAND

Examples:

mce_write.c.

int mceTextWriterStartAlternateContent

(

mceTextWriter *

w

)

Starts an MCE alternate content section.

int mceTextWriterStartChoice	(	mceTextWriter *	w,
		const xmlChar *	ns
	)

Start an MCE choice.

int mceTextWriterStartDocument

(

mceTextWriter *

w

)

See also

http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterStartDocument

Examples:

mce_write.c.

int mceTextWriterStartElement	(	mceTextWriter *	w,
		const xmlChar *	ns,
		const xmlChar *	ln
	)

Start a new XML element. If ns==NULL then there is no namespace and ""==ns means the default namespace.

See also

http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterStartElement

http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterStartElementNS

Examples:

mce_write.c.

int mceTextWriterStartFallback

(

mceTextWriter *

w

)

Start an MCE fallback.

int mceTextWriterWriteString	(	mceTextWriter *	w,
		const xmlChar *	content
	)

See also

http://xmlsoft.org/html/libxml-xmlwriter.html#xmlTextWriterWriteString

xmlTextWriterPtr xmlNewTextWriterFile

(

FILE *

file

)

Helper which create a new xmlTextWriterPtr for a FILE handle.

Examples:

opc_part.c.