XMLParser.h

Go to the documentation of this file.

/** @file XMLParser.h
* @author Gabor Madl
* @date Created 06/2005
* @brief XML Parser library.
*
*
* =================================================================
* DREAM License v2.0
* 
* DREAM - Distributed Real-time Embedded Analysis Method
* http://dre.sourceforge.net.
* Copyright (c) 2005-2007 Gabor Madl, All Rights Reserved.
* 
* This file is part of DREAM.
* 
* DREAM is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation. No future versions of
* the GPL license may be automatically applied to DREAM. It is in
* the sole discretion of the copyright holder to determine whether
* DREAM may be released under a different license or terms. There
* are no restrictions on the use of DREAM for any purpose.
* 
* DREAM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
* 
* By submitting comments, suggestions, code, code snippets,
* techniques (including that of usage), and algorithms, submitters
* acknowledge that they have the right to do so, that any such
* submissions are given freely and unreservedly, and that they
* waive any claims to copyright or ownership. In addition,
* submitters acknowledge that any such submission might become
* part of the copyright maintained on the overall body of code,
* which comprises DREAM. By making a submission, submitter agrees
* to these terms. Furthermore, submitters acknowledge that the
* incorporation or modification of such submissions is entirely
* at the discretion of the moderators of the DREAM project.
* 
* DREAM links to the Libxml2 third party library. Please see 
* COPYING-libxml for the copyright information of Libxml2.
* =================================================================
*/

#ifndef DREAM_XMLPARSER
#define DREAM_XMLPARSER

#include "../core/System.h"
#include <libxml/xmlreader.h> 

namespace DREAM
{

/** XML Parser class.
* Parses an XML file using libxml.
*/
class XMLParser
{
public:
        /** Constructor. */
        XMLParser () {};

        /** Destructor. */
        ~XMLParser () {};

        /** Starts the parsing of the XML input into the System root. */
        void parse (char* xmlFile, DREAM::System* system)
                throw (DREAM::Exception);

        /** Sets the system_ptr_ root pointer for DREAM::System. 
        * @param system_ptr is the pointer to be set in system_ptr_.
        */
        void set_system (DREAM::System* system_ptr);

private:

        /** Verifies whether each timer, task and channel is mapped to threads, and whether each thread is mapped to a CPU. */
        void check_mapping ()
                throw (DREAM::Exception);

        /** Looks up a temporarily stored node in node_map_. 
        * @param name is the name of the node to be searched for.
        * @return pointer to the Node.
        */
        DREAM::Node* find_node (const std::string& name)
                throw (DREAM::Exception);

        /** Looks up a temporarily stored node in thread_map_. 
        * @param name is the name of the thread to be searched for.
        * @return pointer to the Thread.
        */
        DREAM::Thread* find_thread (const std::string& name)
                throw (DREAM::Exception);

        /** Handler for libxml.
        * This is the entry point for XML parsing.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_node (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <task/> node.
        * This function processes a <task/> node from the XML input and creates the corresponding DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_task (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <channel/> node.
        * This function processes a <channel/> node from the XML input and creates the corresponding DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_channel (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <timer/> node.
        * This function processes a <timer/> node from the XML input and creates the corresponding DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_timer (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <thread/> node.
        * This function processes a <thread/> node from the XML input and creates the corresponding DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_thread (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <timertotask/> connection.
        * This function processes a <timertotask/> connection from the XML input and creates the corresponding connections in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_timer_to_task (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <tasktotask/> connection.
        * This function processes a <timertotask/> connection from the XML input and creates the corresponding connections in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_task_to_task (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <tasktochannel/> connection.
        * This function processes a <timertotask/> connection from the XML input and creates the corresponding connections in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_task_to_channel (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <channeltotask/> connection.
        * This function processes a <timertotask/> connection from the XML input and creates the corresponding connections in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_channel_to_task (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <taskmapping/> mapping.
        * This function processes a <taskmapping/> mapping from the XML input and creates the corresponding mappings in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_task_mapping (xmlTextReaderPtr reader)
                throw (DREAM::Exception);
        
        /** Processes an XML <channelmapping/> mapping.
        * This function processes a <channelmapping/> mapping from the XML input and creates the corresponding mappings in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_channel_mapping (xmlTextReaderPtr reader)
                throw (DREAM::Exception);
        
        /** Processes an XML <timermapping/> mapping.
        * This function processes a <timermapping/> mapping from the XML input and creates the corresponding mappings in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_timer_mapping (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <componentmapping/> mapping.
        * This function processes a <componentmapping/> mapping from the XML input and creates the corresponding mappings in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        * @todo Handling components by the parser.
        * @todo Handling power aware tasks by the parser.
        */
        void process_component_mapping (xmlTextReaderPtr reader);

        /** Processes an XML <CPU/> node.
        * This function processes a <CPU/> node from the XML input and creates the corresponding DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_CPU (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Processes an XML <threadmapping/> mapping.
        * This function processes a <threadmapping/> mapping from the XML input and creates the corresponding mappings in the DREAM representation.
        * @param reader is a pointer to the xmlTextReader.
        */
        void process_thread_mapping (xmlTextReaderPtr reader)
                throw (DREAM::Exception);

        /** Stores DREAM::Node and inherited implementations.
        * Connections between elements are built using this list.
        */
        DREAM::NODE_MAP node_map_;

        /** Stores DREAM::Thread and inherited implementations.
        * Connections between elements are built using this list.
        */
        DREAM::THREAD_STR_MAP thread_map_;

        /** Pointer to the last Thread used. */
        DREAM::Thread* current_thread_;

        /** Pointer to the last Scheduler used. */
        DREAM::Scheduler* current_scheduler_;

        /** Pointer to the system root. */
        DREAM::System* system_ptr_;
};

};

#endif

---