XMLWriter - A Simple Reusable Class

• Download source and PDF documentation - 82.4 KB
• Download demo project and PDF documentation - 266 KB

Introduction

XMLwriter is a simple class that can be used in your application to create/generate XML output. All you need to do is include the xmlwriter.h and xmlwriter.cpp into your project, and enjoy.

The implementation uses only standard CPP libraries and STLs, this can be used for applications in Windows as well as Linux. I have used this in a Windows environment, Cygwin (Linux emulator), and in Linux systems. It works fine in all the three. I hope the same will be the result in other operating systems also.

This XMLWriter class doesn’t support all the features of XML but surely satisfies the basic needs you will have in most of your applications. You can use this code free of cost, but at your own risk. (Please test the application.)

Features

1. Easily creates nodes
2. Easily creates elements
3. Easily adds attributes
4. Closes all the open tags with one simple command (Stack to keep track of all the open tags)
5. No need to worry about file operations (All handled internally)

Features Missing

1. No verification and validation is done on the file (User's responsibility to ensure that file is well formed and valid)
2. Right now, provision to add processing instructions and CDATA sections are missing. This can be easily added to the XML class (if you need it).

I have organized the tutorial into three main sections:

• Section 1: How to use?
• Section 2: Example implementation
• Section 3: Design overview (so that you can add, remove and modify existing features)

Section 1: How to Use?

Usage is very simple and easy.

Windows Users

1. Create a simple project in the IDE that you are using.
2. Add the files xmlwriter.cpp and xmlwriter.h.
3. Create a main application.
4. Create an object of ‘xmlwriter’ and use the member functions to add nodes, elements, etc.

Linux Users

Copy the files xmlwriter.cpp and xmlwriter.h into your working directory. Create a main application, say for example, testxmlwriter.cpp. Create a make file.

#make file created by boby
#March-2006

CC = g++ -Wno-deprecated
CFLAGS = -c

XMLwriter_cygwin : xmlwriter.o testxmlwriter.o
        $(CC) xmlwriter.o testxmlwriter.o  -o XMLwriter_cygwin

xmlwriter.o : xmlwriter.cpp
        $(CC) $(CFLAGS) xmlwriter.cpp

testxmlwriter.o : testxmlwriter.cpp
        $(CC) $(CFLAGS)  testxmlwriter.cpp

clean:
        -rm -f *.o

Section 2: Example Implementation

xmlwriter MyXml("boby.xml");
//creates an object of type xmlwriter'. This object 
//is closely coupled to the xml file boby.xml.
//Whatever operation you perform on this object 
//will be reflected in the boby.xml file.
//Constructor adds the following lines to the xml files. 
//Change the constructor code if you want to
//change the encoding format.

<?xml version="1.0" encoding="UTF-8" ?>
MyXml.AddAtributes("age","25");
//add an attribute "age" with value "25" into memory.
//This attribute will be added to the next tag which will be created.
//You can add any number of attributes before adding the tag.
//All the attributes will be added to the next tag created.

MyXml.AddAtributes("Profession","Software");
// add one more attribute.

MyXml.Createtag("Boby");
// this will create a tag boby with two attributes
// "age" and "Profession".

MyXml.AddComment("Personal information");
MyXml.Createtag("Home"); // create node boby

MyXml.CreateChild("Address","Pazheparampil"); // add element

MyXml.CreateChild("Mobile","09844400873");
MyXml.CloseLasttag(); // close boby

MyXml.AddComment("Office information");
MyXml.Createtag("Office"); // create node boby

MyXml.CreateChild("Address","Bangalore"); // add element

MyXml.CreateChild("Ph","0091234567");
MyXml.CloseLasttag(); // close Office


MyXml.CloseAlltags();
//This will close all the open tags. After going deep 
//into the file creating lots of XML nodes,
//you can close the all opened tags with this single function call.
//A stack has been implemented to keep track of all the open tags.

Section 3: Design Overview

Class Diagram

Summary

This XML writer class is a typical example for a reusable class. Since the class handles only XML operations, this can be easily reused in any application without any code modification.