src/sim/cxx_config_ini.hh

   1 /*
   2  * Copyright (c) 2014 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * Authors: Andrew Bardsley
  38  */
  39
  40 /**
  41  * @file
  42  *
  43  *  .ini file reading wrapper for use with CxxConfigManager
  44  */
  45
  46 #ifndef __SIM_CXX_CONFIG_INI_HH__
  47 #define __SIM_CXX_CONFIG_INI_HH__
  48
  49 #include "base/inifile.hh"
  50 #include "sim/cxx_config.hh"
  51
  52 /** CxxConfigManager interface for using .ini files */
  53 class CxxIniFile : public CxxConfigFileBase
  54 {
  55   protected:
  56     IniFile iniFile;
  57
  58   public:
  59     CxxIniFile() { }
  60
  61     /* Most of these functions work by mapping 'object' onto 'section' */
  62
  63     bool getParam(const std::string &object_name,
  64         const std::string &param_name,
  65         std::string &value) const;
  66
  67     bool getParamVector(const std::string &object_name,
  68         const std::string &param_name,
  69         std::vector<std::string> &values) const;
  70
  71     bool getPortPeers(const std::string &object_name,
  72         const std::string &port_name,
  73         std::vector<std::string> &peers) const;
  74
  75     bool objectExists(const std::string &object_name) const;
  76
  77     void getAllObjectNames(std::vector<std::string> &list) const;
  78
  79     void getObjectChildren(const std::string &object_name,
  80         std::vector<std::string> &children,
  81         bool return_paths = false) const;
  82
  83     bool load(const std::string &filename);
  84 };
  85
  86 #endif // __SIM_CXX_CONFIG_INI_HH__