1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*
Copyright (c) 2008 Robin Vobruba <hoijui.quaero@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _AIINTERFACELIBRARY_H
#define _AIINTERFACELIBRARY_H
#include "Platform/SharedLib.h"
#include "ExternalAI/Interface/ELevelOfSupport.h"
#include "ExternalAI/Interface/SAIInterfaceLibrary.h"
#include "ExternalAI/Interface/SAIInterfaceCallback.h"
#include "ExternalAI/SkirmishAIKey.h"
#include <string>
#include <map>
class CAIInterfaceLibraryInfo;
class CSkirmishAILibrary;
class CSkirmishAILibraryInfo;
/**
* The engines container for an AI Interface library.
* An instance of this class may represent the Java or the C AI Interface.
*/
class CAIInterfaceLibrary {
public:
CAIInterfaceLibrary(const CAIInterfaceLibraryInfo& info);
virtual ~CAIInterfaceLibrary();
virtual AIInterfaceKey GetKey() const;
virtual LevelOfSupport GetLevelOfSupportFor(
const std::string& engineVersionString, int engineVersionNumber) const;
/**
* @brief how many times is this interface loaded
* Thought the AI library may be loaded only once, it can be logically
* loaded multiple times.
* Example: If we load one RAI and two AAIs over this interface,
* the interface load counter will be three.
*/
virtual int GetLoadCount() const;
// Skirmish AI methods
/**
* @brief loads the AI library
* This only loads the AI library, and does not yet create an instance
* for a team.
* For the C and C++ AI interface eg, this will load a shared library.
* Increments the load counter.
*/
virtual const CSkirmishAILibrary* FetchSkirmishAILibrary(const CSkirmishAILibraryInfo& aiInfo);
/**
* @brief unloads the Skirmish AI library
* This unloads the Skirmish AI library.
* For the C and C++ AI interface eg, this will unload a shared library.
* This should not be done when any instances
* of that AI are still in use, as it will result in a crash.
* Decrements the load counter.
*/
virtual int ReleaseSkirmishAILibrary(const SkirmishAIKey& sAISpecifier);
/**
* @brief how many times is the Skirmish AI loaded
* Thought the AI library may be loaded only once, it can be logically
* loaded multiple times (load counter).
*/
virtual int GetSkirmishAILibraryLoadCount(const SkirmishAIKey& sAISpecifier) const;
/**
* @brief is the Skirmish AI library loaded
*/
bool IsSkirmishAILibraryLoaded(const SkirmishAIKey& key) const {
return GetSkirmishAILibraryLoadCount(key) > 0;
}
/**
* @brief unloads all AIs
* Unloads all AI libraries currently loaded through this interface.
*/
virtual int ReleaseAllSkirmishAILibraries();
/**
* @brief path to the library file
* Returns the path to the shared library file wrapped by this class.
*/
const std::string& GetLibraryFilePath() const {
return libFilePath;
}
private:
int interfaceId;
struct SAIInterfaceCallback callback;
void InitStatic();
void ReleaseStatic();
private:
std::string libFilePath;
SharedLib* sharedLib;
SAIInterfaceLibrary sAIInterfaceLibrary;
const CAIInterfaceLibraryInfo& info;
std::map<const SkirmishAIKey, CSkirmishAILibrary*> loadedSkirmishAILibraries;
std::map<const SkirmishAIKey, int> skirmishAILoadCount;
private:
static const int MAX_INFOS = 128;
static void reportInterfaceFunctionError(const std::string* libFileName,
const std::string* functionName);
int InitializeFromLib(const std::string& libFilePath);
std::string FindLibFile();
};
#endif // _AIINTERFACELIBRARY_H
|
