LeechCraft Azoth
0.6.70-3565-g2d86529
Modular multiprotocol IM plugin for LeechCraft
Main Page
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
iprovidecommands.h
Go to the documentation of this file.
1
/**********************************************************************
2
* LeechCraft - modular cross-platform feature rich internet client.
3
* Copyright (C) 2006-2014 Georg Rudoy
4
*
5
* Boost Software License - Version 1.0 - August 17th, 2003
6
*
7
* Permission is hereby granted, free of charge, to any person or organization
8
* obtaining a copy of the software and accompanying documentation covered by
9
* this license (the "Software") to use, reproduce, display, distribute,
10
* execute, and transmit the Software, and to prepare derivative works of the
11
* Software, and to permit third-parties to whom the Software is furnished to
12
* do so, all subject to the following:
13
*
14
* The copyright notices in the Software and this entire statement, including
15
* the above license grant, this restriction and the following disclaimer,
16
* must be included in all copies of the Software, in whole or in part, and
17
* all derivative works of the Software, unless such copies or derivative
18
* works are solely in the form of machine-executable object code generated by
19
* a source language processor.
20
*
21
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
* FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24
* SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25
* FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27
* DEALINGS IN THE SOFTWARE.
28
**********************************************************************/
29
30
#pragma once
31
32
#include <functional>
33
#include <stdexcept>
34
#include <boost/variant.hpp>
35
#include <QStringList>
36
#include <QtPlugin>
37
38
namespace
LeechCraft
39
{
40
namespace
Azoth
41
{
42
class
ICLEntry;
43
44
struct
StringCommandResult
45
{
46
bool
StopProcessing_
;
47
QString
Message_
;
48
};
49
struct
TextMorphResult
50
{
51
QString
NewText_
;
52
};
53
typedef
boost::variant<bool, StringCommandResult, TextMorphResult>
CommandResult_t
;
54
55
typedef
std::function<CommandResult_t (ICLEntry*, QString&)>
Command_f
;
56
57
class
CommandException
:
public
std::runtime_error
58
{
59
const
QString Error_;
60
const
bool
TryOtherCommands_;
61
public
:
62
CommandException
(
const
QString& error,
bool
canTryOthers =
false
)
63
: std::runtime_error { error.toUtf8 ().constData () }
64
, Error_ { error }
65
, TryOtherCommands_ { canTryOthers }
66
{
67
}
68
69
const
QString&
GetError
()
const
70
{
71
return
Error_;
72
}
73
74
bool
CanTryOtherCommands
()
const
75
{
76
return
TryOtherCommands_;
77
}
78
};
79
80
struct
StaticCommand
81
{
82
QStringList
Names_
;
83
Command_f
Command_
;
84
85
QString
Description_
;
86
QString
Help_
;
87
88
StaticCommand
() =
default
;
89
StaticCommand
(
const
StaticCommand
&) =
default
;
90
91
StaticCommand
(
const
QStringList& names,
const
Command_f
& command)
92
:
Names_
{ names }
93
,
Command_
{ command }
94
{
95
}
96
97
StaticCommand
(
const
QStringList& names,
const
Command_f
& command,
98
const
QString& descr,
const
QString& help)
99
:
Names_
{ names }
100
,
Command_
{ command }
101
,
Description_
{ descr }
102
,
Help_
{ help }
103
{
104
}
105
};
106
107
typedef
QList<StaticCommand>
StaticCommands_t
;
108
109
class
IProvideCommands
110
{
111
public
:
112
virtual
~IProvideCommands
() {}
113
114
virtual
StaticCommands_t
GetStaticCommands
(
ICLEntry
*) = 0;
115
};
116
}
117
}
118
119
Q_DECLARE_INTERFACE
(
LeechCraft::Azoth::IProvideCommands
,
"org.LeechCraft.Azoth.IProvideCommands/1.0"
);
LeechCraft::Azoth::TextMorphResult::NewText_
QString NewText_
Definition:
iprovidecommands.h:51
LeechCraft::Azoth::CommandException::GetError
const QString & GetError() const
Definition:
iprovidecommands.h:69
LeechCraft::Azoth::StaticCommand::Description_
QString Description_
Definition:
iprovidecommands.h:85
LeechCraft::Azoth::CommandException::CanTryOtherCommands
bool CanTryOtherCommands() const
Definition:
iprovidecommands.h:74
LeechCraft::Azoth::TextMorphResult
Definition:
iprovidecommands.h:49
LeechCraft::Azoth::StaticCommand::StaticCommand
StaticCommand(const QStringList &names, const Command_f &command, const QString &descr, const QString &help)
Definition:
iprovidecommands.h:97
LeechCraft::Azoth::IProvideCommands::~IProvideCommands
virtual ~IProvideCommands()
Definition:
iprovidecommands.h:112
LeechCraft::Azoth::StaticCommand::Command_
Command_f Command_
Definition:
iprovidecommands.h:83
LeechCraft::Azoth::IProvideCommands::GetStaticCommands
virtual StaticCommands_t GetStaticCommands(ICLEntry *)=0
LeechCraft::Azoth::StaticCommand::Names_
QStringList Names_
Definition:
iprovidecommands.h:82
LeechCraft::Azoth::ICLEntry
Represents a single entry in contact list.
Definition:
iclentry.h:102
LeechCraft::Azoth::CommandResult_t
boost::variant< bool, StringCommandResult, TextMorphResult > CommandResult_t
Definition:
iprovidecommands.h:53
LeechCraft::Azoth::StaticCommand::StaticCommand
StaticCommand()=default
Q_DECLARE_INTERFACE
Q_DECLARE_INTERFACE(LeechCraft::Azoth::IProvideCommands,"org.LeechCraft.Azoth.IProvideCommands/1.0")
LeechCraft::Azoth::StringCommandResult
Definition:
iprovidecommands.h:44
LeechCraft::Azoth::IProvideCommands
Definition:
iprovidecommands.h:109
LeechCraft::Azoth::StaticCommand::Help_
QString Help_
Definition:
iprovidecommands.h:86
LeechCraft::Azoth::StringCommandResult::StopProcessing_
bool StopProcessing_
Definition:
iprovidecommands.h:46
LeechCraft::Azoth::StringCommandResult::Message_
QString Message_
Definition:
iprovidecommands.h:47
LeechCraft::Azoth::CommandException::CommandException
CommandException(const QString &error, bool canTryOthers=false)
Definition:
iprovidecommands.h:62
LeechCraft::Azoth::Command_f
std::function< CommandResult_t(ICLEntry *, QString &)> Command_f
Definition:
iprovidecommands.h:55
LeechCraft::Azoth::StaticCommands_t
QList< StaticCommand > StaticCommands_t
Definition:
iprovidecommands.h:107
LeechCraft::Azoth::CommandException
Definition:
iprovidecommands.h:57
LeechCraft::Azoth::StaticCommand
Definition:
iprovidecommands.h:80
LeechCraft::Azoth::StaticCommand::StaticCommand
StaticCommand(const QStringList &names, const Command_f &command)
Definition:
iprovidecommands.h:91
src
plugins
azoth
interfaces
azoth
iprovidecommands.h
Generated by
1.8.6