• Main
• Home
• Features
• Screenshots
• Downloads
• License
• Team profile
• Documentation
• Manual
• FAQ
• Reference

Search this page:

PCMPlugin.h

Go to the documentation of this file.

//
// This source file is a part of ParCompMark
// Parallel Compositing Benchmark Framework
//
// for latest info see http://parcompmark.sourceforge.net

//
// Copyright (C) 2006 IT2 ParCompMark Dev. Team
// 
// 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.


#ifndef __PCM_PLUGIN_H__
#  define __PCM_PLUGIN_H__

//
// Inner includes
//

#  include "PCMPremeditations.h"

#  include "PCMDynLoad.h"

#  include "PCMName.h"

#  include "PCMException.h"

#  include "PCMLogger.h"

#  include "PCMPointer.h"

//
// Outer includes
//

#  include <list>

namespace ParCompMark
{

  class Plugin:public DynLoad,
   public Name
  {

        //
        // Unit test class
        //
#  ifdef PARCOMPMARK_TEST
        friend class ParCompMarkTest::TestPlugin;
#  endif

        //
        // Enumerations
        //

   public:

        enum PluginType
        {

         BASIC_PLUGIN,

         RENDERER_PLUGIN
        };

        //
        // Typedefs
        //

   public:

        typedef ParCompMark::Pointer < Plugin,
        Mutex > Pointer;

   protected:

        typedef const char **(*pcmGetNeededLibsType) ();

        typedef void (*loggerFunctionType) (const void *, const char *);

        typedef int (*pcmSetPluginHandleType) (void *);

        typedef int (*pcmSetLoggerFunctionType) (loggerFunctionType);

        typedef int (*pcmOnLoadType) ();

        typedef int (*pcmOnUnloadType) ();

        typedef const char *(*pcmGetErrorMsgType) (const int);

        //
        // Variables
        //



   protected:

        PluginType mPluginType;

        bool mInitialized;

        std::list < std::string > mNeededLibs;

        s32 mLastError;


        //
        // Constructors & destructor
        //



   public:

        Plugin(const PluginType & type, const std::string & name, const std::string & filename);

        virtual ~ Plugin();


        //
        // Getters & setters
        //



   public:

        const Plugin::PluginType & getPluginType() const;

        const bool & getInitialized() const;

        const std::list < std::string > &getNeededLibs() const;

        const s32 & getLastError() const;


        //
        // Class methods
        //



   protected:

        static void _loggerFunction(const void *handle, const char *message);


        //
        // Methods
        //



   public:

        virtual void initialize();

        virtual void finalize();

   protected:

        virtual void _initializeSpecific() = 0;

        virtual void _finalizeSpecific() = 0;

        virtual void _getNeededLibs();

        virtual void _setPluginHandle();

        virtual void _setLoggerFunction();

        virtual void _onLoad();

        virtual void _onUnload();

        virtual const char *_getErrorMsg();

        virtual void _checkError();


  };

  //
  // Include header implementation
  //

#  include "PCMPlugin_impl.h"

}

#endif

© Copyright - 2006 (IT)² ParCompMark Dev. Team