FunctionGraphBuilder.hpp

/***************************************************************************
  tag: Peter Soetens  Mon Jan 19 14:11:21 CET 2004  ProgramGraph.hpp

                        ProgramGraph.hpp -  description
                           -------------------
    begin                : Mon January 19 2004
    copyright            : (C) 2004 Peter Soetens
    email                : peter.soetens@mech.kuleuven.ac.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/

#ifndef PROGRAMGRAPH_HPP
#define PROGRAMGRAPH_HPP

#include "FunctionGraph.hpp"
#include "DataSourceBase.hpp"

#include <utility>                   // for std::pair
#include <stack>
#include <map>
#include <string>
#include <boost/graph/graph_traits.hpp>

namespace RTT
{

    class RTT_API FunctionGraphBuilder
    {
    public:

        typedef EdgeCondition::EdgeProperty EdgeProperty;
        typedef VertexNode::VertProperty    VertProperty;

        typedef boost::adjacency_list<boost::vecS, boost::listS, boost::directedS, VertProperty, EdgeProperty> Graph;
        typedef boost::graph_traits<Graph>::vertex_descriptor Vertex;
        typedef boost::graph_traits<Graph>::edge_descriptor Edge;

        typedef FunctionGraph::Vertex CommandNode ;

        typedef FunctionGraph::Edge ConditionEdge ;

        FunctionGraphBuilder();

        ~FunctionGraphBuilder();

        void setLineNumber( int ln );

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

        FunctionGraphPtr startFunction( const std::string& fname );

        void returnFunction( ConditionInterface* cond, int line );

        FunctionGraphPtr endFunction( int line = 0 );

        FunctionGraphPtr getFunction();

        void startIfStatement( ConditionInterface* cond, int linenumber );
        void endIfBlock(int linenumber);
        void endElseBlock(int linenumber);

        void startWhileStatement( ConditionInterface* cond, int linenumber );
        void endWhileBlock(int linenumber);

        bool inLoop();
        bool breakLoop();

        CommandNode addCommand( ConditionInterface* cond,  CommandInterface* com );

        void addConditionEdge( ConditionInterface* cond, CommandNode vert );

        void closeConditionEdge( CommandNode vert, ConditionInterface* cond );

        CommandNode moveTo( CommandNode _build, CommandNode _next, int linenr );

        void setCommand( CommandInterface* comm );

        CommandInterface* getCommand( CommandNode cn );

        void setCommand( CommandNode vert, CommandInterface* comm);

        CommandNode appendFunction( ConditionInterface* cond, FunctionGraphPtr fn, std::vector<DataSourceBase::shared_ptr> fnargs);

        CommandNode setFunction( FunctionGraphPtr fn, std::vector<DataSourceBase::shared_ptr> fnargs);

        CommandNode proceedToNext( int line_nr = 0 );

        CommandNode proceedToNext( ConditionInterface* cond, int line_nr = 0 );

        void connectToNext( CommandNode v, ConditionInterface* cond );

        CommandNode buildNode() const;

        size_t buildEdges() const;

        CommandNode nextNode() const;

        CommandNode build;

        CommandNode next;

    private:

        FunctionGraphPtr func;

        Graph* graph;

        std::stack<CommandNode> branch_stack;

        std::stack<CommandNode> break_stack;
    };
}

#endif