xref: /aosp_15_r20/external/parameter-framework/upstream/parameter/MappingData.h (revision c33452fb792a5495ec310a9626f2638b053af5dd)

/*
 * Copyright (c) 2011-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 <map>

class CMappingData
{
    typedef std::map<std::string, std::string>::const_iterator KeyToValueMapConstIterator;

public:
    /** Initialize mapping data through a raw value
     *
     * @param[in] rawMapping the raw mapping data which has to be parsed.
     *            This raw value is a succession of pair "key:value" separated with comma.
     * @param[out] error description of the error if there is one, empty otherwise
     * @return true on success, false otherwise
     */
    bool init(const std::string &rawMapping, std::string &error);

    // Query
    bool getValue(const std::string &strkey, const std::string *&pStrValue) const;

    /**
     * Formats the mapping as a list of comma-space separated key:value pairs
     *
     * @return the formatted std::string
     */
    std::string asString() const;

private:
    bool addValue(const std::string &strkey, const std::string &strValue);

    std::map<std::string, std::string> _keyToValueMap;
};