/**
 * Provides a map of class/struct attributes and enumeration attributes
 */

#ifndef ATTRIBUTESMAP_HH
#define ATTRIBUTESMAP_HH

#include <map>
#include <string>
#include <fstream>
#include "sim_services/MemoryManager/include/attributes.h"

namespace Trick {

/**
 * These maps stores all the attributes by class/struct/enum name
 * So these 2 classes could inherit from a template or something fancy, but
 * they are so simple I decided to leave them separate.
 */

    class AttributesMap {

        public:
            /**
             * Returns a pointer to the singleton Trick::AttributesMap instance.
             * @return    A pointer to Trick::AttributesMap.
             */
            static AttributesMap * attributes_map() {
                if ( pInstance == NULL ) {
                    pInstance = new Trick::AttributesMap() ;
                }
                return pInstance ;
            }

            AttributesMap() {} ;
            ~AttributesMap() {} ;

            /**
             * Adds a type and the corresponding attributes
             * @param type    The name of the type.
             * @param attr    Pointer to the attributes.
             */
            void add_attr( std::string type , ATTRIBUTES * attr ) {
                name_to_attr_map[type] = attr ;
            }

            /**
             * Gets the attributes of a type.
             * @param type    The name of the type.
             * @return    The attributes of the type.
             */
            ATTRIBUTES * get_attr( std::string type ) {
                if ( name_to_attr_map.find(type) != name_to_attr_map.end() ) {
                    return name_to_attr_map[type] ;
                }
                return NULL ;
            }

            // routines to sanitize the xml output
            std::string & replace_special_chars( std::string & str) ;
            std::string & type_remove_dims( std::string & type ) ;

#if 0
            const char * get_sie_type( int type ) ;
#endif

            void print_xml( std::ofstream & outfile ) ;

        private:
            std::map<std::string, ATTRIBUTES *> name_to_attr_map ;
            static AttributesMap * pInstance ;

    } ;

}

#endif