Singularity-Viewer/SingularityViewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Split plugin classes and derive AIFilePicker from BasicPluginBase (part 3).

Browse Source 
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
2011-05-06 16:08:24 +02:00
parent 784fdd4f37
commit 16cd4c5c4b
44 changed files with 3666 additions and 1577 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
indra/plugins/base_basic/basic_plugin_base.cpp Executable file
View 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