DeclareBuilder.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Copyright (C) 2009-2011 Cassio Neri Moreira
 *
 * This file is part of the KeyValue library.
 *
 * The KeyValue library 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 3 of the License, or (at
 * your option) any later version.
 *
 * The KeyValue library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with KeyValue. If not, see <http://www.gnu.org/licenses/>.
 *
 * If you modify this library, or any covered work, by linking or combining
 * it with Excel (or a modified version of that program), containing parts
 * covered by the terms of End-User License Agreement for Microsoft
 * Software, the licensors of KeyValue grant you additional permission to
 * convey the resulting work.
 *
 **************************************************************************/

#ifndef OBJECT_TYPE
  #error "Please, #define OBJECT_TYPE before including DeclareBuilder.h."
#endif

#ifndef TAG
  #error "Please, #define TAG before including DeclareBuilder.h."
#endif

namespace tag {
class TAG;
}

template <>
class Builder<tag::TAG> :

  #ifdef BUILDS_FROM
    public BuilderFrom<OBJECT_TYPE, BUILDS_FROM>
  #else
    public AbstractBuilder
  #endif

  #ifdef COMMAND
    , public Command
  #endif

  {

public:

  // Inherited from processor / User defined
  const char*
  getName() const;

  // Inherited from processor / Defined below
  value::Result
  getResult(const DataSet& data) const;

  // Inherited from AbstractBuilder / Defined below
  const ::std::type_info&
  getObjectType() const;

  #ifdef BUILDS_FROM
    // Inherited from BuilderFromVariant / User defined
    value::PtrTraits<ObjectType>::Type_
    getObject(const BUILDS_FROM& data) const;
  #endif

  #ifdef KV_COMMAND
    // Inherited from Command / User defined
    const char*
    getCommandName() const;
  #endif

  // Local / User defined
  value::PtrTraits<OBJECT_TYPE>::Type_
  getObject(const DataSet& data) const;

private:

  // Inherited from AbstractBuilder / Defined below
  void
  thrower() const;

  friend class ProcessorInstantiator<tag::TAG>;

  // Local / Defined below
  Builder();

}; // class Builder

/*--------------------------------------------------------------------------
 * Builder::getResult()
 *------------------------------------------------------------------------*/

value::Result
Builder<tag::TAG>::getResult(const DataSet& data) const {
  return getObject(data);
}

/*--------------------------------------------------------------------------
 * Builder::getObjectType()
 *------------------------------------------------------------------------*/

const ::std::type_info&
Builder<tag::TAG>::getObjectType() const {
  return typeid(OBJECT_TYPE);
}

/*--------------------------------------------------------------------------
 * Builder::thrower()
 *------------------------------------------------------------------------*/

void
Builder<tag::TAG>::thrower() const {
  throw static_cast<OBJECT_TYPE*>(0);
}

/*--------------------------------------------------------------------------
 * ProcessorInstantiator::getInstance()
 *------------------------------------------------------------------------*/

template <>
const Processor&
ProcessorInstantiator<tag::TAG>::getInstance() {
  static const Builder<tag::TAG> singleton;
  return singleton;
}

/*--------------------------------------------------------------------------
 * Builder::Builder()
 *------------------------------------------------------------------------*/

Builder<tag::TAG>::Builder() {
  util::Global<ProcessorMngr>::get()->add(*this);
}

/*--------------------------------------------------------------------------
 * Macro clean-up
 *------------------------------------------------------------------------*/

#undef OBJECT_TYPE
#undef TAG

#ifdef COMMAND
#undef COMMAND
#endif

#ifdef BUILDS_FROM
#undef BUILDS_FROM
#endif