vos/corelibs/typehelper/typehelper.hh

Go to the documentation of this file.

/*
    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001-2003 Peter Amstutz <tetron@interreality.org>

    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 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
*/

#ifndef _TYPEHELPER_HH_
#define _TYPEHELPER_HH_

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef TYPEHELPER_EXPORTS
#  define TYPEHELPER_API __declspec(dllexport)
# else
#  define TYPEHELPER_API __declspec(dllimport)
# endif
#else
# define TYPEHELPER_API
#endif

#include <list>
#include <deque>
#include <map>
#include <set>
#include <string>
#include <stdexcept>

using namespace std;

/** Use a subclass of this class to specify action performed when a running
 * helper process ends by passing an instance to
 * TypeHeler::addProcessEndCallback().
 */
class TYPEHELPER_API ProcessEndCallback
{
public:
    /// Override this method.
    virtual void notifyProcessTerminate(int pid) = 0;
};

/** A ProcessEndCallback that deletes a file when called. */
class TYPEHELPER_API DeleteTempFile : public ProcessEndCallback
{
private:
    string file;
    set<int>* other_pids;
public:
    /** Deletes a file when called back.
     * @param f     The name of the file to delete.
     */
    DeleteTempFile(const string& f);

    /** Removes the PID for the helper associated with this callback from
     * the given set of PIDs. If that set is then empty, then the file
     * is deleted and the PID set is freed from the heap.
     * Use a new instance of DeleteTempFile for each process, and pass each of
     * them a pointer to the PID set.
     * @param f         File to delete when the PID set becomes empty.
     * @param pidset    The PID set. If NULL, then behavior will be as described
     *                  in DeleteTempFile(const string&).
     */
    DeleteTempFile(const string& f, set<int>* pidset);

    virtual ~DeleteTempFile();
    virtual void notifyProcessTerminate(int pid);
};

class TYPEHELPER_API TypeHelper {
private:
    string type;
    deque<string> parameters;
    string target;
    typedef enum { DATA, VOBJECT } RunFunc;
    RunFunc runFunc;

public:

    TypeHelper() :
        runFunc(DATA)
    { }

    TypeHelper(string init_type) :
        type(init_type),
        runFunc(DATA)
    { }

    static void init(string filename);
    static deque<TypeHelper> findVobjectHelpers(const set<string>& s, const string& objpath);
    static deque<TypeHelper> findDataHelpers(const string& s, const string& tempfile);
    static void addHelper(const string& configline);
    static void addProcessEndCallback(int pid, ProcessEndCallback* pec);
    static void removeProcessEndCallback(int pid, ProcessEndCallback* pec);
    static void checkProcesses();

    string getType() { return type; }
    const deque<string>& getParameters() { return parameters; }
    string getCommand();
    int run();

    void setType(string t) { type = t; }
    void setParameters(deque<string> params) { parameters = params; }
    void setCommand(const string& cmd);
};

#endif

---