plugin.h

Go to the documentation of this file.

/*! \file
  \brief  The base class for GL Studio plugin file loaders, disti::Plugin.

  \par Copyright Information

  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef INCLUDED_GLS_RUNTIME_PLUGIN_H
#define INCLUDED_GLS_RUNTIME_PLUGIN_H

#include "gls_include.h"
#include <cstring>
#include <iostream>

namespace disti
{
class DistiAttributePluginData;

/** The Plugin class
  */
class Plugin
{
public:
    /// For Polymorphic deletion
    virtual ~Plugin() {} // = default;

    /** \return A description string used for informational display 
      * by the plugin GUI
      */
    virtual const char* Description() = 0;

    /** \return A version string used for informational display 
      * by the plugin GUI
      */
    virtual const char* Version() = 0;

    /** \return The type of the plugin 
      */
    virtual const char* PluginType() = 0;

    /** Allows plugin to specify the name of
      * its entry in the PluginData section
      * of the .gls file.
      * This may contain spaces but shall not contain a ':' or a newline.
      * If this is not overriden, PluginData will
      * not be saved or restored.
      */
    virtual const char* PluginDataName() { return NULL; }

    /** Allows plugin to write out any persistant data
      * in the form 
      *  SomeAttribute: SomeValue
      * Data must all be single-line.
      * PluginDataName() must be overriden for this to be called.
      */
    virtual void WritePluginData( DistiAttributePluginData* /*pluginData*/ ) {}

    /** Allows plugin to read in any persistant data
      * of the form 
      *  SomeAttribute: SomeValue
      * Data will all be single-line.
      * Data will be terminated by '}' or EOF
      * PluginDataName() must be overriden for this to be called.
      */
    virtual void ReadPluginData( DistiAttributePluginData* /*pluginData*/ ) {}

    /** Allows plugin to reset its attributes back to
      * their default value.  This allows for new documents
      * to use the default attributes rather
      * than whatever was used last
      * PluginDataName() must be overriden for this to be called.
      */
    virtual void ResetPluginData() {}

    /** Indicates if the plugin is of the specified type. 
      * \param str  The type of the plugin
      * \return true if plugin is the type specified
      * \remarks Used by the plug-in manager as a workaround on systems where RTTI is broken
      */
    bool IsPluginType( const char* str ) { return 0 == std::strncmp( str, PluginType(), BUFSIZ ); }

    /* Allows plugin to handle destruction of its own data.
     */
    virtual void Destroy() = 0;
};

} // namespace disti

#endif