/*
 *  Config
 *
 *  Author: Andrew Salamon
 *  Date: Tue Feb 27, 2008
 *
 *  Copyright (c) 2008 Machine Perception Laboratory
 *  University of California San Diego.
 *
 * 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. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 *
 */

#ifndef __CERT_CONFIG__
#define __CERT_CONFIG__

#include <string>
#include <map>
#include <vector>
#include <exception>
#include <stdexcept>
#include <iostream>

namespace CERT
{
    /** ConfigItem's each represent one CERT plugin.
     * This is mostly an internal class used by the main Config class and by the plugin system.
     * Each item has several hard coded properties. All other properties are accessed through either
     * of two sets of methods depending on what type of property it is.
     * Strings, integers, floats and arrays of any of those three are accessed through the first set of
     * methods: getProperties, getValueForKey, etc. These are all handled internally as vectors of strings.
     * Map type properties use the second set of methods: getMapForKey, etc. Maps just add one more level of
     * hierarchy to the property.
     * Examples of all of this are in the config files that ship with CERT.
     */
    class ConfigItem
    {
    public:
        typedef std::map< std::string, std::vector<std::string> > PropertyType;

    public:
        ConfigItem();
        ~ConfigItem();

        std::string getPluginID() const;
        void setPluginID( const std::string &_id );

        std::string getName() const;
        void setName( const std::string &_name );

        std::string getInternalName() const;
        void setInternalName( const std::string &_name );

        std::string getPluginType() const;
        void setPluginType( const std::string &_type );

        bool getEnabled() const;
        void setEnabled( bool _enabled );

        bool getDisplay() const;
        void setDisplay( bool _display );

        PropertyType getProperties() const { return properties; }
        std::vector<std::string> getValueForKey( const std::string &key );
        void setValueForKey( const std::string &value, const std::string &key );
        void setValueForKey( const std::vector<std::string> &value, const std::string &key );

        bool hasIntValueForKey( const std::string &key );
        int getIntValueForKey( const std::string &key );
        bool hasFloatValueForKey( const std::string &key );
        int getFloatValueForKey( const std::string &key );

        friend std::ostream& operator<<( std::ostream &os, const CERT::ConfigItem &item );

    private:
        std::string id;
        std::string name;
        std::string internalName;
        std::string type;
        bool enabled;
        bool display;

        PropertyType properties;

    // Separate methods and data members for any "map" type properties
    public:
        PropertyType getMapForKey( const std::string &key );
        void setValueForKey( const PropertyType &value, const std::string &key );
    private:
        std::map< std::string, PropertyType > mapProperties;
    };

    /** A class for parsing config files for CERT.
     * Parses a config file from a given path, creating config items for each plugin in the config file
     * plus reading any global config properties.
     */
    class Config
    {
    public:
        Config( const std::string &_path = std::string("") ); ///< Will throw an exception if there's an error during parsing.
        ~Config();

        std::vector<ConfigItem *> getItems() const; ///< A vector of all non-global config items (e.g. plugins)
        std::vector<ConfigItem *> itemsOfType( const std::string &type ) const; ///< Obsolete.

        void addItem( ConfigItem *item ); ///< The Config object takes posession of the ConfigItem and will delete it in the destructor.

        const ConfigItem &getGlobalItem() const { return global; } ///< Return the ConfigItem that holds all global config properties.
        ConfigItem &getGlobalItem() { return global; } ///< Return the ConfigItem that holds all global config properties.

        class exception : public std::runtime_error
        {
            public:
            exception( const std::string &msg ) : std::runtime_error(msg) { }
        };

        friend std::ostream& operator<<( std::ostream &os, const CERT::Config &config );
    private:
        std::vector<ConfigItem *> items;
        std::string path;
        ConfigItem global; // for global settings
    };

}

#endif