cxx_config_ini.hh revision 10458:64809024b924 
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 "base/str.hh"
51#include "sim/cxx_config.hh"
52
53/** CxxConfigManager interface for using .ini files */
54class CxxIniFile : public CxxConfigFileBase
55{
56  protected:
57    IniFile iniFile;
58
59  public:
60    CxxIniFile() { }
61
62    /* Most of these functions work by mapping 'object' onto 'section' */
63
64    bool getParam(const std::string &object_name,
65        const std::string &param_name,
66        std::string &value) const;
67
68    bool getParamVector(const std::string &object_name,
69        const std::string &param_name,
70        std::vector<std::string> &values) const;
71
72    bool getPortPeers(const std::string &object_name,
73        const std::string &port_name,
74        std::vector<std::string> &peers) const;
75
76    bool objectExists(const std::string &object_name) const;
77
78    void getAllObjectNames(std::vector<std::string> &list) const;
79
80    void getObjectChildren(const std::string &object_name,
81        std::vector<std::string> &children,
82        bool return_paths = false) const;
83
84    bool load(const std::string &filename);
85};
86
87#endif // __SIM_CXX_CONFIG_INI_HH__
88