plugin.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** 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 PLUGIN_H
#define PLUGIN_H
 
#include "typedefs.h"
#include "grassroots_plugin_library.h"
#include "linked_list.h"
#include "memory_allocations.h"
 
 
#ifdef __cplusplus
  extern "C" {
#endif
 
 
/*********** FORWARD DECLARATION ****************/
struct ServicesArray;
struct Client;
struct Handler;
struct JobsManager;
struct GrassrootsServer;
 
typedef enum PluginStatus
{
  PS_UNSET,
 
  PS_LOADED,
 
  PS_UNAVAILABLE,
 
  PS_CLOSING
 
} PluginStatus;
 
 
typedef enum PluginNature
{
  PN_UNKNOWN = -1,
 
  PN_SERVICE,
 
  PN_CLIENT,
 
  PN_HANDLER,
 
  PN_JOBS_MANAGER,
 
  PN_SERVERS_MANAGER,
 
  PN_NUM_TYPES
} PluginNature;
 
 
typedef union PluginValue
{
  struct ServicesArray *pv_services_p;
 
  struct Client *pv_client_p;
 
  struct Handler *pv_handler_p;
 
 
  struct JobsManager *pv_jobs_manager_p;
 
 
  struct ServersManager *pv_servers_manager_p;
 
} PluginValue;
 
 
 
 
typedef struct Plugin
{
  char *pl_path_s;
 
  MEM_FLAG pl_path_mem;
 
  char *pl_name_s;
 
  PluginStatus pl_status;
 
  PluginNature pl_type;
 
  PluginValue pl_value;
 
  int32 pl_open_count;
 
 
  struct GrassrootsServer *pl_server_p;
} Plugin;
 
 
 
typedef struct PluginListNode
{
  ListItem pln_node;
 
  Plugin *pln_plugin_p;
 
  MEM_FLAG pln_plugin_flag;
} PluginListNode;
 
 
/***********************************/
/**********  API METHODS  **********/
/***********************************/
 
 
 
GRASSROOTS_PLUGIN_API const char *GetPluginConfigName (const Plugin * const plugin_p);
 
GRASSROOTS_PLUGIN_API Plugin *AllocatePlugin (const char * const path_s, struct GrassrootsServer *server_p);
 
 
GRASSROOTS_PLUGIN_API void FreePlugin (Plugin * const plugin_p);
 
 
GRASSROOTS_PLUGIN_API bool OpenPlugin (Plugin * const plugin_p);
 
 
GRASSROOTS_PLUGIN_API void ClosePlugin (Plugin * const plugin_p);
 
 
GRASSROOTS_PLUGIN_API void *GetSymbolFromPlugin (Plugin *plugin_p, const char * const symbol_s);
 
 
GRASSROOTS_PLUGIN_API PluginListNode *AllocatePluginListNode (Plugin * const plugin_p);
 
 
GRASSROOTS_PLUGIN_API void FreePluginListNode (ListItem * const node_p);
 
 
GRASSROOTS_PLUGIN_API char *DeterminePluginName (const char * const full_plugin_path_s);
 
 
GRASSROOTS_PLUGIN_API char *MakePluginName (const char * const name_s);
 
 
 
GRASSROOTS_PLUGIN_API void IncrementPluginOpenCount (Plugin *plugin_p);
 
 
GRASSROOTS_PLUGIN_API void DecrementPluginOpenCount (Plugin *plugin_p);
 
 
GRASSROOTS_PLUGIN_API void ClearPluginValue (Plugin * const plugin_p);
 
 
/***********************************/
/*********  LOCAL METHODS  *********/
/***********************************/
 
 
GRASSROOTS_PLUGIN_LOCAL bool InitBasePlugin (Plugin * const plugin_p, const char * const path_p, struct GrassrootsServer *server_p);
 
GRASSROOTS_PLUGIN_LOCAL void ClearBasePlugin (Plugin * const plugin_p);
 
 
GRASSROOTS_PLUGIN_LOCAL void ClearPluginPath (Plugin * const plugin_p);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef PLUGIN_H */