drwnInterfaces.h

/*****************************************************************************
** DARWIN: A FRAMEWORK FOR MACHINE LEARNING RESEARCH AND DEVELOPMENT
** Distributed under the terms of the BSD license (see the LICENSE file)
** Copyright (c) 2007-2015, Stephen Gould
** All rights reserved.
**
******************************************************************************
** FILENAME:    drwnInterfaces.h
** AUTHOR(S):   Stephen Gould <stephen.gould@anu.edu.au>
**
*****************************************************************************/

#pragma once

#include <cstdlib>
#include <cassert>

#include "drwnXMLParser.h"

using namespace std;

// drwnTypeable -------------------------------------------------------------

class drwnTypeable {
 public:
    virtual ~drwnTypeable() { /* do nothing */ }

    virtual const char *type() const = 0;
};

// drwnCloneable ------------------------------------------------------------

class drwnCloneable {
 public:
    virtual ~drwnCloneable() { /* do nothing */ }

    virtual drwnCloneable *clone() const = 0;
};

// drwnWriteable ------------------------------------------------------------

class drwnWriteable : public drwnTypeable {
 public:
    virtual ~drwnWriteable() { /* do nothing */ }

    bool write(const char *filename) const;
    bool read(const char *filename);

    virtual bool save(drwnXMLNode& xml) const = 0;
    virtual bool load(drwnXMLNode& xml) = 0;

    void dump() const;
};

// drwnStdObjIface ----------------------------------------------------------

class drwnStdObjIface : public drwnWriteable, public drwnCloneable {
 public:
    virtual ~drwnStdObjIface() { /* do nothing */ }
};

// helper macros ------------------------------------------------------------

#define DRWN_TYPE_AND_CLONE_IMPL(C) \
    virtual const char *type() const { return #C; } \
    virtual C* clone() const { return new C(*this); }