CTK/Libs/PluginFramework/ctkPluginPrivate_p.h

/*=============================================================================

  Library: CTK

  Copyright (c) 2010 German Cancer Research Center,
    Division of Medical and Biological Informatics

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=============================================================================*/

#ifndef CTKPLUGINPRIVATE_P_H
#define CTKPLUGINPRIVATE_P_H

#include "ctkPlugin.h"
#include "ctkPluginException.h"

#include <QHash>

namespace ctk {

  class PluginActivator;
  class PluginArchive;
  class PluginFrameworkContextPrivate;

  class PluginPrivate {

  protected:

    Q_DECLARE_PUBLIC(Plugin)

    Plugin * const q_ptr;

  public:

    /**
     * Construct a new plugin based on a PluginArchive.
     *
     * @param fw PluginFrameworkContext for this plugin.
     * @param ba Plugin archive representing the shared library and cached data
     * @param checkContext AccessConrolContext to do permission checks against.
     * @exception std::invalid_argument Faulty manifest for bundle
     */
    PluginPrivate(Plugin& qq, PluginFrameworkContextPrivate* fw,
               PluginArchive* pa /*, Object checkContext*/);

    /**
     * Construct a new empty Plugin.
     *
     * Only called for the system plugin
     *
     * @param fw Framework for this plugin.
     */
    PluginPrivate(Plugin& qq,
                  PluginFrameworkContextPrivate* fw,
                  int id,
                  const QString& loc,
                  const QString& sym,
                  const Version& ver);

    virtual ~PluginPrivate();

    /**
     * Get updated plugin state. That means check if an installed
     * plugin has been resolved.
     *
     * @return Plugin state
     */
    Plugin::States getUpdatedState();

    QHash<QString, QString> getHeaders(const QString& locale);


    /**
     * Union of flags allowing plugin class access
     */
    static const Plugin::States RESOLVED_FLAGS;

    PluginFrameworkContextPrivate * const fwCtx;

    /**
     * Plugin identifier
     */
    const int id;

    /**
     * Plugin location identifier
     */
    const QString location;

    /**
     * Plugin symbolic name
     */
    QString symbolicName;

    /**
     * Plugin version
     */
    Version version;

    /**
     * State of the plugin
     */
    Plugin::State state;

    /**
     * Plugin archive
     */
    PluginArchive* archive;

    /**
     * PluginContext for the plugin
     */
    PluginContext* pluginContext;

    /**
     * PluginActivator for the plugin
     */
    PluginActivator* pluginActivator;

    /**
     * Time when the plugin was last modified
     */
    long lastModified;

    /**
     * Stores the default locale entries when uninstalled
     */
    QHash<QString, QString> cachedHeaders;

    /**
     * Stores the raw manifest headers
     */
    QHash<QString, QString> cachedRawHeaders;

    bool lazyActivation;

    /** True during the finalization of an activation. */
    bool activating;

    /** True during the state change from active to resolved. */
    bool deactivating;

    /** Saved exception of resolve failure */
    PluginException resolveFailException;

  private:

    /**
     * Check manifest and cache certain manifest headers as variables.
     */
    void checkManifestHeaders();


  };

}

#endif // CTKPLUGINPRIVATE_P_H