src/components.h

   1 /*
   2   Copyright (c) 2007 Paolo Capriotti <p.capriotti@gmail.com>
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8 */
   9
  10 #ifndef COMPONENTS_H
  11 #define COMPONENTS_H
  12
  13 #include <memory>
  14 #include <QMap>
  15
  16 #include "variant.h"
  17
  18 class IAnimator;
  19 class IAnimatorFactory;
  20 class IColor;
  21 class IMoveSerializer;
  22 class INamer;
  23 class IPolicy;
  24 class IState;
  25 class IStateFactory;
  26 class IValidator;
  27 class TaguaAPI;
  28 class Variant;
  29
  30 /**
  31   * @brief A utility class to simplify the interaction with variant components.
  32   *
  33   * A component object holds all official components of a variant, and exposes
  34   * utility methods to retrieve them, or create them using the appropriate
  35   * factories.
  36   *
  37   * Most methods return a component owned by the variant, but those that start
  38   * with 'create' use a factory to instantiate a new component that will be
  39   * owned by the caller.
  40   */
  41 class Components {
  42   std::auto_ptr<Variant> m_variant;
  43
  44   IAnimatorFactory* m_animator_factory;
  45   IStateFactory* m_state_factory;
  46
  47   QMap<QString, IMoveSerializer*> m_move_serializers;
  48   INamer* m_namer;
  49   IPolicy* m_policy;
  50   IValidator* m_validator;
  51   QMap<int, IColor*> m_players;
  52 public:
  53   explicit Components(Variant*);
  54
  55   void setVariant(Variant*);
  56
  57   IAnimator* createAnimator(TaguaAPI* api) const;
  58   IState* createState() const;
  59
  60   IMoveSerializer* moveSerializer(const QString& type);
  61   INamer* namer();
  62   IPolicy* policy();
  63   IValidator* validator();
  64   IColor* player(int index);
  65   QMap<int, IColor*> players();
  66
  67   Variant* variant();
  68 };
  69
  70 #endif // COMPONENTS_H
  71