upstream/test/functional-tests/include/Config.hpp

/*
 * Copyright (c) 2015, Intel Corporation
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation and/or
 * other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#pragma once

#include <string>
#include <list>
#include <utility>

namespace parameterFramework
{

/** Parameter Framework configuration. */
struct Config
{
    Config() = default;

    /** Emulate C named parameter.
     * { .instances = "fuu" } <=> { &Config::instances, "fuu" }
     * Passing multiple named parameters is not implemented. */
    template <class M, class T = M>
    Config(M(Config::*member), T &&value)
    {
        (this->*member) = std::forward<T>(value);
    }

    /** Mapping attribute of the test subsystem. */
    std::string subsystemMapping;

    /** Instances of the test subsystem.
     *
     * Content of the configuration
     * SystemClass/Subsystem[name=test]/InstanceDefinition xml node.
     */
    std::string instances;
    /** Content of the configuartion ConfigurableDomains xml node. */
    std::string domains;
    /** Content of the configuration SubsystemPlugins xml node. */
    std::string components;

    struct Plugin
    {
        using Location = std::string;
        using Name = std::string;
        /** Each plugin has a location and a path.
         *  Locations can be factorized by using */
        using Collection = std::list<std::pair<Location, std::list<Name>>>;
    };
    using Plugins = Plugin::Collection;
    Plugins plugins;

    /** Subsystem type. Virtual by default. */
    std::string subsystemType = "Virtual";
};

} // parameterFramework