147 lines
3.9 KiB
C++
147 lines
3.9 KiB
C++
//
|
|
// OVModule.h
|
|
//
|
|
// Copyright (c) 2007-2010 Lukhnos D. Liu
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person
|
|
// obtaining a copy of this software and associated documentation
|
|
// files (the "Software"), to deal in the Software without
|
|
// restriction, including without limitation the rights to use,
|
|
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following
|
|
// conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be
|
|
// included in all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
// OTHER DEALINGS IN THE SOFTWARE.
|
|
//
|
|
|
|
#ifndef OVModule_h
|
|
#define OVModule_h
|
|
|
|
#if defined(__APPLE__)
|
|
#include <OpenVanilla/OVEventHandlingContext.h>
|
|
#include <OpenVanilla/OVKeyValueMap.h>
|
|
#include <OpenVanilla/OVPathInfo.h>
|
|
#else
|
|
#include "OVEventHandlingContext.h"
|
|
#include "OVKeyValueMap.h"
|
|
#include "OVPathInfo.h"
|
|
#endif
|
|
|
|
namespace OpenVanilla {
|
|
using namespace std;
|
|
|
|
class OVModule : public OVBase {
|
|
public:
|
|
OVModule()
|
|
: m_initialized(false)
|
|
, m_usable(false)
|
|
{
|
|
}
|
|
|
|
virtual bool isInitialized() const
|
|
{
|
|
return m_initialized;
|
|
}
|
|
|
|
virtual bool isUsable() const
|
|
{
|
|
return m_usable;
|
|
}
|
|
|
|
virtual bool isPreprocessor() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
virtual bool isInputMethod() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
virtual bool isOutputFilter() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
virtual bool isAroundFilter() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// the smaller it gets, the closer the the filter gets to the commit event
|
|
virtual int suggestedOrder() const
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
virtual OVEventHandlingContext* createContext()
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
virtual const string identifier() const = 0;
|
|
|
|
virtual const string localizedName(const string& locale)
|
|
{
|
|
return identifier();
|
|
|
|
}
|
|
|
|
virtual bool moduleInitialize(OVPathInfo* pathInfo, OVLoaderService* loaderService)
|
|
{
|
|
if (m_initialized)
|
|
return false;
|
|
|
|
m_usable = initialize(pathInfo, loaderService);
|
|
m_initialized = true;
|
|
return m_usable;
|
|
}
|
|
|
|
virtual bool initialize(OVPathInfo* pathInfo, OVLoaderService* loaderService)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
virtual void finalize()
|
|
{
|
|
}
|
|
|
|
virtual void loadConfig(OVKeyValueMap* moduleConfig, OVLoaderService* loaderService)
|
|
{
|
|
}
|
|
|
|
virtual void saveConfig(OVKeyValueMap* moduleConfig, OVLoaderService* loaderService)
|
|
{
|
|
}
|
|
|
|
enum AroundFilterDisplayOption {
|
|
ShownAsPreprocessor,
|
|
ShownAsOutputFilter,
|
|
ShownAsBoth
|
|
};
|
|
|
|
// around filter modules need to tell loader how it wishes to be placed in the menu
|
|
virtual AroundFilterDisplayOption aroundFilterPreferredDisplayOption()
|
|
{
|
|
return ShownAsBoth;
|
|
}
|
|
|
|
protected:
|
|
bool m_initialized;
|
|
bool m_usable;
|
|
};
|
|
};
|
|
|
|
#endif
|