loot/libloot
0
0
Fork 0
mirror of https://github.com/loot/libloot.git synced 2026-07-27 14:16:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Rename PluginMessage to SimpleMessage

Browse Source
This commit is contained in:
Oliver Hamlet
2016-08-24 08:08:26 +01:00
parent fc226efce5
commit 1292815e48
8 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CMakeLists.txt
+1 -1
View File
@@ -249,8 +249,8 @@ set (LOOT_API_HEADERS "${CMAKE_SOURCE_DIR}/include/loot/api.h"
"${CMAKE_SOURCE_DIR}/include/loot/masterlist_info.h"
"${CMAKE_SOURCE_DIR}/include/loot/message_type.h"
"${CMAKE_SOURCE_DIR}/include/loot/plugin_cleanliness.h"
"${CMAKE_SOURCE_DIR}/include/loot/plugin_message.h"
"${CMAKE_SOURCE_DIR}/include/loot/plugin_tags.h"
"${CMAKE_SOURCE_DIR}/include/loot/simple_message.h"
"${CMAKE_SOURCE_DIR}/src/api/api_database.h")
set (LOOT_VALIDATOR_SRC "${CMAKE_SOURCE_DIR}/src/validator/main.cpp")
docs/api/reference.rst
+1 -1
View File
@@ -21,7 +21,7 @@ Public-Field Data Structures
.. doxygenstruct:: loot::MasterlistInfo
:members:
.. doxygenstruct:: loot::PluginMessage
.. doxygenstruct:: loot::SimpleMessage
:members:
.. doxygenstruct:: loot::PluginTags
include/loot/database_interface.h
+2 -2
View File
@@ -30,8 +30,8 @@
#include "loot/language_code.h"
#include "loot/masterlist_info.h"
#include "loot/plugin_cleanliness.h"
#include "loot/plugin_message.h"
#include "loot/plugin_tags.h"
#include "loot/simple_message.h"
/**
* @file
@@ -174,7 +174,7 @@ public:
* @returns A vector of messages associated with the specified plugin. Empty
* if the plugin has no messages associated with it.
*/
virtual std::vector<PluginMessage> GetPluginMessages(const std::string& plugin,
virtual std::vector<SimpleMessage> GetPluginMessages(const std::string& plugin,
const LanguageCode language) = 0;
/**
include/loot/message_type.h
+1 -1
View File
@@ -27,7 +27,7 @@ along with LOOT. If not, see
/**
* @file
* @brief Contains the message type codes used by the PluginMessage structure.
* @brief Contains the message type codes used by the SimpleMessage structure.
*/
/**
include/loot/plugin_message.h → include/loot/simple_message.h
+4 -4
View File
@@ -21,19 +21,19 @@
along with LOOT. If not, see
<https://www.gnu.org/licenses/>.
*/
#ifndef LOOT_PLUGIN_MESSAGE
#define LOOT_PLUGIN_MESSAGE
#ifndef LOOT_SIMPLE_MESSAGE
#define LOOT_SIMPLE_MESSAGE
#include "loot/message_type.h"
/**
* @file
* @brief Contains the PluginMessage structure.
* @brief Contains the SimpleMessage structure.
*/
namespace loot {
/** @brief A structure that holds the type of a message and the message string itself. */
struct PluginMessage {
struct SimpleMessage {
/** @brief The type of the message. */
MessageType type;
src/api/api_database.cpp
+4 -4
View File
@@ -163,9 +163,9 @@ PluginTags ApiDatabase::GetPluginTags(const std::string& plugin) {
return tags;
}
std::vector<PluginMessage> ApiDatabase::GetPluginMessages(const std::string& plugin,
std::vector<SimpleMessage> ApiDatabase::GetPluginMessages(const std::string& plugin,
const LanguageCode language) {
std::vector<PluginMessage> messages;
std::vector<SimpleMessage> messages;
PluginMetadata pluginMetadata = game_.GetMasterlist().FindPlugin(PluginMetadata(plugin));
for (const auto& message : pluginMetadata.Messages()) {
@@ -243,8 +243,8 @@ void ApiDatabase::WriteMinimalList(const std::string& outputFile, const bool ove
out << yout.c_str();
out.close();
}
PluginMessage ApiDatabase::convertMessage(const Message& message, const LanguageCode language) {
PluginMessage pluginMessage;
SimpleMessage ApiDatabase::convertMessage(const Message& message, const LanguageCode language) {
SimpleMessage pluginMessage;
MessageContent content = message.GetContent(language);
pluginMessage.type = message.GetType();
src/api/api_database.h
+2 -2
View File
@@ -54,7 +54,7 @@ struct ApiDatabase : public DatabaseInterface {
PluginTags GetPluginTags(const std::string& plugin);
std::vector<PluginMessage> GetPluginMessages(const std::string& plugin,
std::vector<SimpleMessage> GetPluginMessages(const std::string& plugin,
const LanguageCode language);
PluginCleanliness GetPluginCleanliness(const std::string& plugin);
@@ -62,7 +62,7 @@ struct ApiDatabase : public DatabaseInterface {
void WriteMinimalList(const std::string& outputFile,
const bool overwrite);
private:
PluginMessage convertMessage(const Message& message, const LanguageCode language);
SimpleMessage convertMessage(const Message& message, const LanguageCode language);
Game game_;
src/tests/api/database_interface_test.h
+5 -5
View File
@@ -329,7 +329,7 @@ TEST_P(DatabaseInterfaceTest, getPluginTagsShouldOutputTheCorrectBashTagsForPlug
}
TEST_P(DatabaseInterfaceTest, getPluginMessagesShouldReturnOkAndOutputANullArrayIfAPluginWithNoMessagesIsQueried) {
std::vector<PluginMessage> messages;
std::vector<SimpleMessage> messages;
EXPECT_NO_THROW(messages = db_->GetPluginMessages(blankEsp, LanguageCode::english));
EXPECT_TRUE(messages.empty());
}
@@ -338,7 +338,7 @@ TEST_P(DatabaseInterfaceTest, getPluginMessagesShouldReturnOkAndOutputANoteIfAPl
ASSERT_NO_THROW(GenerateMasterlist());
ASSERT_NO_THROW(db_->LoadLists(masterlistPath.string(), ""));
std::vector<PluginMessage> messages;
std::vector<SimpleMessage> messages;
EXPECT_NO_THROW(messages = db_->GetPluginMessages(blankEsm, LanguageCode::english));
ASSERT_EQ(1, messages.size());
EXPECT_EQ(MessageType::say, messages[0].type);
@@ -350,7 +350,7 @@ TEST_P(DatabaseInterfaceTest, getPluginMessagesShouldReturnOkAndOutputAWarningIf
ASSERT_NO_THROW(GenerateMasterlist());
ASSERT_NO_THROW(db_->LoadLists(masterlistPath.string(), ""));
std::vector<PluginMessage> messages;
std::vector<SimpleMessage> messages;
EXPECT_NO_THROW(messages = db_->GetPluginMessages(blankDifferentEsm, LanguageCode::english));
ASSERT_EQ(1, messages.size());
EXPECT_EQ(MessageType::warn, messages[0].type);
@@ -362,7 +362,7 @@ TEST_P(DatabaseInterfaceTest, getPluginMessagesShouldReturnOkAndOutputAnErrorIfA
ASSERT_NO_THROW(GenerateMasterlist());
ASSERT_NO_THROW(db_->LoadLists(masterlistPath.string(), ""));
std::vector<PluginMessage> messages;
std::vector<SimpleMessage> messages;
EXPECT_NO_THROW(messages = db_->GetPluginMessages(blankDifferentEsp, LanguageCode::english));
ASSERT_EQ(1, messages.size());
EXPECT_EQ(MessageType::error, messages[0].type);
@@ -374,7 +374,7 @@ TEST_P(DatabaseInterfaceTest, getPluginMessagesShouldReturnOkAndOutputMultipleMe
ASSERT_NO_THROW(GenerateMasterlist());
ASSERT_NO_THROW(db_->LoadLists(masterlistPath.string(), ""));
std::vector<PluginMessage> messages;
std::vector<SimpleMessage> messages;
EXPECT_NO_THROW(messages = db_->GetPluginMessages(blankDifferentMasterDependentEsp, LanguageCode::english));
ASSERT_EQ(3, messages.size());
EXPECT_EQ(MessageType::say, messages[0].type);