manes/root.h

   1 /* Quarn OS / Manes
   2  *
   3  * Root class
   4  *
   5  * Copyright (C) 2009 Pawel Dziepak
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  */
  22
  23 #ifndef _ROOT_H_
  24 #define _ROOT_H_
  25
  26 #include "creator.h"
  27 #include "type.h"
  28 #include "libs/pointer.h"
  29
  30 namespace manes {
  31         /**
  32          * @brief Main component creator.
  33          *
  34          * @details In most cases there is only one instance of this class. It stores
  35          * pointers to all child-creators.
  36          */
  37         class root : public creator {
  38         public:
  39                 virtual bool initialize(p<component>);
  40                 virtual bool type_added(type_name);
  41
  42                 /**
  43                  * @brief Get specific component.
  44                  *
  45                  * @details Search in compontens list for the specified one. If none is
  46                  * found then ask for it each known that is able to maintain such component.
  47                  * @param name The name of requested component.
  48                  * @return Requested component.
  49                  */
  50                 virtual p<component> get_component(const component_name &name);
  51         };
  52 }
  53
  54 #endif