TaskBrowser.hpp

Go to the documentation of this file.

#ifndef NO_GPL
/***************************************************************************
  tag: Peter Soetens  Thu Jul 3 15:31:33 CEST 2008  TaskBrowser.hpp

                        TaskBrowser.hpp -  description
                           -------------------
    begin                : Thu July 03 2008
    copyright            : (C) 2008 Peter Soetens
    email                : peter.soetens@fmtc.be

 ***************************************************************************
 *                                                                         *
 *   This program 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; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 ***************************************************************************/
#else
/***************************************************************************
  tag: Peter Soetens  Tue Dec 21 22:43:08 CET 2004  TaskBrowser.hpp

                        TaskBrowser.hpp -  description
                           -------------------
    begin                : Tue December 21 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 Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   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 Lesser 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                                *
 *                                                                         *
 ***************************************************************************/
#endif

#ifndef ORO_TASKBROWSER_HPP
#define ORO_TASKBROWSER_HPP


#include <rtt/RTT.hpp>
#include <rtt/TaskContext.hpp>
#include <rtt/Service.hpp>
#include <deque>
#include <string>
#include <sstream>
#include <vector>
#if defined(HAS_READLINE) && !defined(HAS_EDITLINE) && defined(_POSIX_VERSION)
#include <signal.h>
#endif

#include <ocl/OCL.hpp>

namespace OCL
{
    class OCL_API TaskBrowser
        : public RTT::TaskContext
    {
        // the 'current' task context
        static RTT::TaskContext* taskcontext;
        // the TC we are using for completion.
        static RTT::TaskContext* peer;
        // the TaskBrowser
        static RTT::TaskContext* tb;
        // the current Context: is tb or taskcontext
        static RTT::TaskContext* context;
        static RTT::Service::shared_ptr taskobject;
        RTT::internal::DataSource<bool>::shared_ptr   accepted;

        int debug;
        /* A static variable for holding the line. */
        char *line_read;
        int lastc; // last command's number

        std::string storedname; 
        int storedline; 
        bool usehex;

        std::deque<RTT::TaskContext*> taskHistory;

        // store TC + program/state name + line number
        typedef std::map<std::pair<RTT::TaskContext*,std::string>,int> PTrace;
        PTrace ptraces;
        PTrace straces;

        //file to store history
        const char* histfile;

        base::DataSourceBase::shared_ptr last_expr;
#if defined(HAS_READLINE) || defined(HAS_EDITLINE)
#if defined(_POSIX_VERSION) && !defined(HAS_EDITLINE)
        static void rl_sigwinch_handler(int sig, siginfo_t *si, void *ctxt);
        static int rl_received_signal;
        static void rl_signal_handler(int sig, siginfo_t *si, void *ctxt);

        /* Custom implementation of rl_getc() to handle signals correctly. */
        static int rl_getc(FILE *);
#endif

        /* Read a string, and return a pointer to it.
           Returns NULL on EOF. */
        char *rl_gets ();

        // use this vector to generate candidate strings
        static std::vector<std::string> candidates;
        // Add successful matches of candidate strings to completes.
        static std::vector<std::string> completes;
        static std::vector<std::string>::iterator complete_iter;

        static std::string component_found;
        static std::string component;
        static std::string peerpath;
        static std::string text;

        // helper function
        static char* dupstr( const char *s );

        static void find_completes();

        static void find_ops();
        static void find_peers(std::string::size_type startpos);

        static char ** orocos_hmi_completion ( const char *text, int start, int end );

        static char *command_generator( const char *_text, int state );
#endif
        static RTT::TaskContext* findPeer( std::string comm );

    protected:

        void listText(std::stringstream& txtss,int start, int end, int ln, char s);

        void doPrint( RTT::base::DataSourceBase::shared_ptr ds, bool recurse);

        void enterTask();
        void leaveTask();

        bool macrorecording;
        std::string macrotext;
        std::string macroname;
        std::stringstream sresult;
        void recordMacro(std::string name);
        void cancelMacro();
        void endMacro();

        void checkPorts();
        Service::shared_ptr stringToService(std::string const& names);
    public:

        enum ColorTheme { nocolors, 
                          darkbg, 
                          whitebg  
        };

        void setColorTheme( ColorTheme t );

        void switchTaskContext(std::string& path);

        void switchTaskContext( RTT::TaskContext* tc, bool store = true);

        void switchBack();

        void browserAction(std::string& act );

        void printResult( RTT::base::DataSourceBase* ds, bool recurse);

        void printHelp();

        void printHelp(std::string command);

        void printInfo(const std::string& peerpath);

        void printSource( const std::string m );

        void printOperation( const std::string m, Service::shared_ptr ops );

        bool printService( const std::string name);

        bool printGlobals();

        void printProgram( const std::string& pn, int line = -1, RTT::TaskContext* progpeer = 0 );

        void printProgram( int line = -1 );

        TaskBrowser( RTT::TaskContext* c );

        ~TaskBrowser();

        void loop();

        void evaluate(std::string& comm );

        void switchTask( RTT::TaskContext* c);

        static std::string prompt;
        static std::string coloron;
        static std::string underline;
        static std::string coloroff;

        static std::string red;

        static std::string green;

        static std::string blue;

        void evalCommand(std::string& comm );


    };

}

#endif