src/configuration_parser/WidgetConfigurationManager.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /*
  17  * @file        WidgetConfigurationManager.h
  18  * @author      Piotr Fatyga (p.fatyga@samsung.com)
  19  * @author      Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
  20  * @version     0.1
  21  * @brief
  22  */
  23 #ifndef _WIDGETCONFIGURATIONMANAGER_H
  24 #define _WIDGETCONFIGURATIONMANAGER_H
  25
  26 #include <dpl/singleton.h>
  27 #include <dpl/string.h>
  28 #include <dpl/optional.h>
  29 #include <dpl/wrt-dao-ro/config_parser_data.h>
  30 #include <dpl/wrt-dao-rw/widget_dao.h>
  31 #include <list>
  32
  33 class WidgetConfigurationManager
  34 {
  35   public:
  36     class Exception
  37     {
  38       public:
  39         DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  40         DECLARE_EXCEPTION_TYPE(Base, ProcessFailed)
  41     };
  42
  43     /**
  44      * This method is used to process the config.xml of widget, get
  45      * the corresponding configuration to pWidgetConfigInfo
  46      *
  47      * @param[in] path Specified the widget archive file path (absolute path).
  48      * @return         Configuration information of  widget
  49      */
  50     void processFile(const std::string& path,
  51                      WrtDB::WidgetRegisterInfo &wConfig);
  52
  53   private:
  54     typedef std::list<std::pair<DPL::String, DPL::String> > StringPairList;
  55
  56     bool locateAndParseConfigurationFile(const std::string& currentPath,
  57             WrtDB::WidgetRegisterInfo& pWidgetConfigInfo,
  58             const std::string& baseFolder,
  59             int* pErrCode);
  60 };
  61
  62 typedef DPL::Singleton<WidgetConfigurationManager>
  63 WidgetConfigurationManagerSingleton;
  64
  65 #endif // _WIDGETCONFIGURATIONMANAGER_H