factory.hh

Go to the documentation of this file.

/* Rapicorn
 * Copyright (C) 2002-2006 Tim Janik
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This 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
 * Lesser General Public License for more details.
 *
 * A copy of the GNU Lesser General Public License should ship along
 * with this library; if not, see http://www.gnu.org/copyleft/.
 */
#ifndef __RAPICORN_FACTORY_HH__
#define __RAPICORN_FACTORY_HH__

#include <ui/item.hh>
#include <list>

namespace Rapicorn {

namespace Factory {

/* --- Factory API --- */
typedef map<String,String>       VariableMap;
typedef std::vector<String>      ArgumentList;  /* elements: key=utf8string */
int /*-errno*/  parse_file       (const String           &i18n_domain,
                                  const String           &file_name,
                                  const String           &domain = "",
                                  vector<String>         *definitions = NULL);
int /*-errno*/ parse_string      (const String           &xml_string,
                                  const String           &i18n_domain,
                                  const String           &domain = "",
                                  vector<String>         *definitions = NULL);
ItemImpl&       create_item      (const String           &item_identifier,
                                  const ArgumentList     &arguments = ArgumentList(),
                                  const ArgumentList     &env_variables = ArgumentList());
ContainerImpl&  create_container (const String           &container_identifier,
                                  const ArgumentList     &arguments = ArgumentList(),
                                  const ArgumentList     &env_variables = ArgumentList());
Wind0wIface&    create_wind0w    (const String           &wind0w_identifier,
                                  const ArgumentList     &arguments = ArgumentList(),
                                  const ArgumentList     &env_variables = ArgumentList());

String     factory_context_name    (FactoryContext *fc);
StringList factory_context_tags    (FactoryContext *fc);
bool       item_definition_is_window (const String   &item_identifier);

/* --- item type registration --- */
struct ItemTypeFactory : protected Deletable, protected NonCopyable {
  const String  qualified_type;
protected:
  static void   register_item_factory   (const ItemTypeFactory  *itfactory);
  static void   sanity_check_identifier (const char             *namespaced_ident);
public:
  explicit      ItemTypeFactory         (const char             *namespaced_ident,
                                         bool _isevh, bool _iscontainer, bool);
  virtual ItemImpl* create_item             (FactoryContext         *fc) const = 0;
  inline String type_name               () const { return qualified_type; }
  static void   initialize_factories    ();
  const bool iseventhandler, iscontainer;
};

} // Factory

// namespace Rapicorn

/* --- item factory template --- */
template<class Type>
class ItemFactory : Factory::ItemTypeFactory {
  virtual ItemImpl*
  create_item (FactoryContext *fc) const
  {
    ItemImpl *item = new Type();
    item->factory_context (fc);
    return item;
  }
public:
  explicit ItemFactory (const char *namespaced_ident) :
    ItemTypeFactory (namespaced_ident,
                     TraitConvertible<EventHandler,Type>::TRUTH,
                     TraitConvertible<ContainerImpl,Type>::TRUTH,
                     TraitConvertible<int,Type>::TRUTH)
  {
    sanity_check_identifier (namespaced_ident);
    register_item_factory (this);
  }
};

} // Rapicorn

#endif /* __RAPICORN_FACTORY_HH__ */