Split plugin classes and derive AIFilePicker from BasicPluginBase (part 3).
This commit deletes all indra/media_plugins and copied one-on-one the indra/plugins directory from my (imprudence) statemachine branch (which contains the AIFilePicker patch). git shows this as a lot of 'renamed' files because originally it was a rename. However, there are a lot of changes as well: it's both an upgrade to a newer plugin system (changes by LL) as well as an upgrade to my refactored plugin system with a file picker as plugin. Since this commit is a one-on-one copy, it disregards any changes that were in Singularity and not in imprudence in indra/media_plugins however. I will add those back in the next commit.
This commit is contained in:
Aleric Inglewood
39
indra/plugins/base_basic/CMakeLists.txt
Normal file
39
indra/plugins/base_basic/CMakeLists.txt
Normal file
@@ -0,0 +1,39 @@
|
||||
# -*- cmake -*-
|
||||
|
||||
project(basic_plugin_base)
|
||||
|
||||
include(00-Common)
|
||||
include(LLCommon)
|
||||
include(LLPlugin)
|
||||
include(Linking)
|
||||
include(PluginAPI)
|
||||
|
||||
include_directories(
|
||||
${LLPLUGIN_INCLUDE_DIRS}
|
||||
${LLCOMMON_INCLUDE_DIRS}
|
||||
)
|
||||
|
||||
### basic_plugin_base
|
||||
|
||||
if(NOT CMAKE_SIZEOF_VOID_P MATCHES 4)
|
||||
if(WINDOWS)
|
||||
add_definitions(/FIXED:NO)
|
||||
else(WINDOWS) # not windows therefore gcc LINUX and DARWIN
|
||||
add_definitions(-fPIC)
|
||||
endif(WINDOWS)
|
||||
endif (NOT CMAKE_SIZEOF_VOID_P MATCHES 4)
|
||||
|
||||
set(basic_plugin_base_SOURCE_FILES
|
||||
basic_plugin_base.cpp
|
||||
)
|
||||
|
||||
set(basic_plugin_base_HEADER_FILES
|
||||
CMakeLists.txt
|
||||
|
||||
basic_plugin_base.h
|
||||
)
|
||||
|
||||
add_library(basic_plugin_base
|
||||
${basic_plugin_base_SOURCE_FILES}
|
||||
)
|
||||
|
||||
136
indra/plugins/base_basic/basic_plugin_base.cpp
Executable file
136
indra/plugins/base_basic/basic_plugin_base.cpp
Executable file
@@ -0,0 +1,136 @@
|
||||
/**
|
||||
* @file basic_plugin_base.cpp
|
||||
* @brief Basic plugin base class for Basic API plugin system
|
||||
*
|
||||
* All plugins should be a subclass of BasicPluginBase.
|
||||
*
|
||||
* @cond
|
||||
* $LicenseInfo:firstyear=2010&license=viewergpl$
|
||||
*
|
||||
* Copyright (c) 2010, Linden Research, Inc.
|
||||
*
|
||||
* Second Life Viewer Source Code
|
||||
* The source code in this file ("Source Code") is provided by Linden Lab
|
||||
* to you under the terms of the GNU General Public License, version 2.0
|
||||
* ("GPL"), unless you have obtained a separate licensing agreement
|
||||
* ("Other License"), formally executed by you and Linden Lab. Terms of
|
||||
* the GPL can be found in doc/GPL-license.txt in this distribution, or
|
||||
* online at http://secondlife.com/developers/opensource/gplv2
|
||||
*
|
||||
* There are special exceptions to the terms and conditions of the GPL as
|
||||
* it is applied to this Source Code. View the full text of the exception
|
||||
* in the file doc/FLOSS-exception.txt in this software distribution, or
|
||||
* online at
|
||||
* http://secondlife.com/developers/opensource/flossexception
|
||||
*
|
||||
* By copying, modifying or distributing this software, you acknowledge
|
||||
* that you have read and understood your obligations described above,
|
||||
* and agree to abide by those obligations.
|
||||
*
|
||||
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
|
||||
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
|
||||
* COMPLETENESS OR PERFORMANCE.
|
||||
* $/LicenseInfo$
|
||||
*
|
||||
* @endcond
|
||||
*/
|
||||
|
||||
#include "linden_common.h"
|
||||
#include "basic_plugin_base.h"
|
||||
|
||||
|
||||
// TODO: Make sure that the only symbol exported from this library is LLPluginInitEntryPoint
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// Basic plugin constructor.
|
||||
///
|
||||
/// @param[in] send_message_function Function for sending messages from plugin to plugin loader shell
|
||||
/// @param[in] plugin_instance Message data for messages from plugin to plugin loader shell
|
||||
BasicPluginBase::BasicPluginBase(LLPluginInstance::sendMessageFunction send_message_function, LLPluginInstance* plugin_instance)
|
||||
{
|
||||
mSendMessageFunction = send_message_function;
|
||||
mPluginInstance = plugin_instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Receive message from plugin loader shell.
|
||||
*
|
||||
* @param[in] message_string Message string
|
||||
* @param[in] user_data Message data
|
||||
*
|
||||
*/
|
||||
void BasicPluginBase::staticReceiveMessage(char const* message_string, BasicPluginBase** self_ptr)
|
||||
{
|
||||
BasicPluginBase* self = *self_ptr;
|
||||
if(self != NULL)
|
||||
{
|
||||
self->receiveMessage(message_string);
|
||||
|
||||
// If the plugin has processed the delete message, delete it.
|
||||
if(self->mDeleteMe)
|
||||
{
|
||||
delete self;
|
||||
*self_ptr = NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// This is the SLPlugin process.
|
||||
// This is the loaded DSO.
|
||||
//
|
||||
// Call this function to send 'message' to the viewer.
|
||||
/**
|
||||
* Send message to plugin loader shell.
|
||||
*
|
||||
* @param[in] message Message data being sent to plugin loader shell
|
||||
*
|
||||
*/
|
||||
void BasicPluginBase::sendMessage(const LLPluginMessage &message)
|
||||
{
|
||||
std::string output = message.generate();
|
||||
mSendMessageFunction(output.c_str(), &mPluginInstance);
|
||||
}
|
||||
|
||||
#if LL_WINDOWS
|
||||
# define LLSYMEXPORT __declspec(dllexport)
|
||||
#elif LL_LINUX
|
||||
# define LLSYMEXPORT __attribute__ ((visibility("default")))
|
||||
#else
|
||||
# define LLSYMEXPORT /**/
|
||||
#endif
|
||||
|
||||
extern "C"
|
||||
{
|
||||
LLSYMEXPORT int LLPluginInitEntryPoint(LLPluginInstance::sendMessageFunction send_message_function,
|
||||
LLPluginInstance* plugin_instance,
|
||||
LLPluginInstance::receiveMessageFunction* receive_message_function,
|
||||
BasicPluginBase** plugin_object);
|
||||
}
|
||||
|
||||
/**
|
||||
* Plugin initialization and entry point. Establishes communication channel for messages between plugin and plugin loader shell. TODO:DOC - Please check!
|
||||
*
|
||||
* @param[in] send_message_function Function for sending messages from plugin to viewer
|
||||
* @param[in] plugin_instance Message data for messages from plugin to plugin loader shell
|
||||
* @param[out] receive_message_function Function for receiving message from viewer to plugin
|
||||
* @param[out] plugin_object Pointer to plugin instance
|
||||
*
|
||||
* @return int, where 0=success
|
||||
*
|
||||
*/
|
||||
LLSYMEXPORT int
|
||||
LLPluginInitEntryPoint(LLPluginInstance::sendMessageFunction send_message_function,
|
||||
LLPluginInstance* plugin_instance,
|
||||
LLPluginInstance::receiveMessageFunction* receive_message_function,
|
||||
BasicPluginBase** plugin_object)
|
||||
{
|
||||
*receive_message_function = BasicPluginBase::staticReceiveMessage;
|
||||
return create_plugin(send_message_function, plugin_instance, plugin_object);
|
||||
}
|
||||
|
||||
#ifdef WIN32
|
||||
int WINAPI DllEntryPoint( HINSTANCE hInstance, unsigned long reason, void* params )
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
#endif
|
||||
2
indra/plugins/base_basic/basic_plugin_base.exp
Normal file
2
indra/plugins/base_basic/basic_plugin_base.exp
Normal file
@@ -0,0 +1,2 @@
|
||||
_LLPluginInitEntryPoint
|
||||
|
||||
88
indra/plugins/base_basic/basic_plugin_base.h
Executable file
88
indra/plugins/base_basic/basic_plugin_base.h
Executable file
@@ -0,0 +1,88 @@
|
||||
/**
|
||||
* @file basic_plugin_base.h
|
||||
* @brief Basic plugin base class for Basic API plugin system
|
||||
*
|
||||
* @cond
|
||||
* $LicenseInfo:firstyear=2010&license=viewergpl$
|
||||
*
|
||||
* Copyright (c) 2010, Linden Research, Inc.
|
||||
*
|
||||
* Second Life Viewer Source Code
|
||||
* The source code in this file ("Source Code") is provided by Linden Lab
|
||||
* to you under the terms of the GNU General Public License, version 2.0
|
||||
* ("GPL"), unless you have obtained a separate licensing agreement
|
||||
* ("Other License"), formally executed by you and Linden Lab. Terms of
|
||||
* the GPL can be found in doc/GPL-license.txt in this distribution, or
|
||||
* online at http://secondlife.com/developers/opensource/gplv2
|
||||
*
|
||||
* There are special exceptions to the terms and conditions of the GPL as
|
||||
* it is applied to this Source Code. View the full text of the exception
|
||||
* in the file doc/FLOSS-exception.txt in this software distribution, or
|
||||
* online at
|
||||
* http://secondlife.com/developers/opensource/flossexception
|
||||
*
|
||||
* By copying, modifying or distributing this software, you acknowledge
|
||||
* that you have read and understood your obligations described above,
|
||||
* and agree to abide by those obligations.
|
||||
*
|
||||
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
|
||||
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
|
||||
* COMPLETENESS OR PERFORMANCE.
|
||||
* $/LicenseInfo$
|
||||
*
|
||||
* @endcond
|
||||
*/
|
||||
|
||||
#ifndef BASIC_PLUGIN_BASE_H
|
||||
#define BASIC_PLUGIN_BASE_H
|
||||
|
||||
#include <sstream>
|
||||
|
||||
#include "linden_common.h"
|
||||
|
||||
#include "llplugininstance.h"
|
||||
#include "llpluginmessage.h"
|
||||
#include "llpluginmessageclasses.h"
|
||||
|
||||
class BasicPluginBase
|
||||
{
|
||||
public:
|
||||
BasicPluginBase(LLPluginInstance::sendMessageFunction send_message_function, LLPluginInstance* plugin_instance);
|
||||
//! Basic plugin destructor.
|
||||
virtual ~BasicPluginBase() {}
|
||||
|
||||
//! Handle received message from plugin loader shell.
|
||||
virtual void receiveMessage(char const* message_string) = 0;
|
||||
|
||||
// This function is actually called and then calls the member function above.
|
||||
static void staticReceiveMessage(char const* message_string, BasicPluginBase** self_ptr);
|
||||
|
||||
protected:
|
||||
void sendMessage(LLPluginMessage const& message);
|
||||
|
||||
//! Message data being sent to plugin loader shell by mSendMessageFunction.
|
||||
LLPluginInstance* mPluginInstance;
|
||||
|
||||
//! Function to send message from plugin to plugin loader shell.
|
||||
LLPluginInstance::sendMessageFunction mSendMessageFunction;
|
||||
|
||||
//! Flag to delete plugin instance (self).
|
||||
bool mDeleteMe;
|
||||
};
|
||||
|
||||
/** The plugin <b>must</b> define this function to create its instance.
|
||||
* It should look something like this:
|
||||
* @code
|
||||
* {
|
||||
* *plugin_object = new FooPluginBar(send_message_function, plugin_instance);
|
||||
* return 0;
|
||||
* }
|
||||
* @endcode
|
||||
*/
|
||||
int create_plugin(
|
||||
LLPluginInstance::sendMessageFunction send_message_function,
|
||||
LLPluginInstance* plugin_instance,
|
||||
BasicPluginBase** plugin_object);
|
||||
|
||||
#endif // BASIC_PLUGIN_BASE
|
||||
|
||||
Reference in New Issue
Block a user