Defining XML Serializable Objects Using Macros

It is often necessary to make your C++ objects serializable to/from XML. It is simple to do so in Java or C#, for example, by using reflection, but not always in C++. It would be interesting to introduce some brief but portable way to describe objects' serializable properties. The prototype presented allows defining XML serializable objects using macros in an MSVC++ 7 unmanaged code attributes-like manner because each serializable object/property needs to be described only once in the class definition, for example:

class CEmployee : public CXmlSerializable
      META_PROP(CSTLString,     Region)

class COrder : public CXmlSerializable
      META_PROP(CSTLString,     ShipCity)
      META_PROP(CSTLString,     EmployeeName)
      META_OBJECTS(CEmployee,   Employees)

class CCustomer : public CXmlSerializable
      META_PROP(CSTLString,     CustomerID)
      META_PROP(CSTLString,     ContactName)
      META_OBJECTS(COrder,      Orders)

class CCustomersList : public CXmlSerializable
      META_OBJECTS(CCustomer,   Customers)

Microsoft SAX parser implementation is used here to read XML. The META_PROP and META_OBJECTS macros assemble mapping arrays of helper methods for the parser content handler and the bodies of the objects ToXml() methods.

One small challenge here was finding a way to assemble something like a linked list at compile time to glue properties declarations together. The solution found is to use templatized inner classes along with the __LINE__ ANSI Predefined macro (this code is a part of the META_PROP macro, back slashes at the row ends are omitted here, all the __LINE__ values are equal inside each META_PROP or META_OBJECTS macro):

template<> struct CDescriptor<__LINE__>
      ESetDataFuncPos = CDescriptor<__LINE__-1>::ESetDataFuncPos,
      EAddObjFuncPos  = CDescriptor<__LINE__-1>::EAddObjFuncPos + 1
   static void Setup(CMetaInfo* pInfo)
      pInfo->m_pAddObjFunc[EAddObjFuncPos].first = L#name;
      pInfo->m_pAddObjFunc[EAddObjFuncPos].second =

ClassAddNew##name here is a static inner helper function; it has the next prototype:

typedef bool (* SET_DATA_FUNC)(CXmlSerializable*,
                               const wchar_t*, size_t);

Objects data writing to XML is implemented in the similar manner. Because the

template<typename T>
inline bool Convert(const wchar_t* pwsz, size_t nLength, T& out)


template<typename T>
inline void WriteField(std::wostream& s, const T& data)

data exchange functions involved are templatized, they can be customized for specific data types such as COleDateTime or std::vector<BYTE> for binary/image data.

The XS_BASE macro can be manipulated to hide implementation details in the separate data access objects library.

The sample application is intended to demonsrate the mechanism proposed. It just loads an XML document example to the data object and then makes the object write itself to the standard output stream. It's as simple as that (error handling omitted for brevity):

CComPtr<ISAXXMLReader> pSAXXMLReader;
CSAXObjectContentHandlerImpl saxObjectContentHandler;

HRESULT hr = pSAXXMLReader.CoCreateInstance(__uuidof(SAXXMLReader));

hr = pSAXXMLReader->putContentHandler(&saxObjectContentHandler);

CCustomersList customersList;
// add root objects
saxObjectContentHandler.AddRootObject(L"ROOT", &customersList);

hr = pSAXXMLReader->parse(CComVariant(g_pszXml));

std::wostringstream ostr;



  • Serializing a class with setter and getter methods

    Posted by gabriel927 on 08/25/2005 12:33pm

    Is there a way to serialize the class with getter and setter methods?  If so, please show me how.

Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • Moving from an on-premises environment to Office 365 does not remove the need to plan for disruptions or reduce the business risk requirements for protecting email services. If anything, some risks increase with a move to the cloud. Read how to ease the transition every business faces if considering or already migrating to cloud email. This white paper discusses: Setting expectations when migrating to Office 365 Understanding the implications of relying solely on Exchange Online security Necessary archiving …

  • Lenovo recommends Windows 8 Pro. "I dropped my laptop getting out of the taxi." This probably sounds familiar to most IT professionals. If your employees are traveling, you know their devices are in for a rough go. Whether it's a trip to the conference room or a convention out of town, any time equipment leaves a user's desk it is at risk of being put into harm's way. Stay connected at all times, whether at the office or on the go, with agile, durable, and flexible devices like the Lenovo® …

Most Popular Programming Stories

More for Developers

RSS Feeds

Thanks for your registration, follow us on our social networks to keep up-to-date