├── .gitignore ├── .travis.yml ├── include └── libespm │ ├── GameId.h │ ├── Subrecord.h │ ├── FormId.h │ ├── Group.h │ ├── Record.h │ └── Plugin.h ├── README.md ├── src └── tests │ ├── main.cpp │ ├── FormIdTest.h │ └── PluginTest.h ├── CMakeLists.txt └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: cpp 3 | compiler: 4 | - clang 5 | - gcc 6 | 7 | # Need GCC 5 and Boost 1.54+, which aren't in the 12.04 repositories - install 8 | # from PPAs. 9 | addons: 10 | apt: 11 | sources: 12 | - boost-latest 13 | - llvm-toolchain-precise-3.8 14 | - ubuntu-toolchain-r-test 15 | packages: 16 | - libboost-filesystem1.55-dev 17 | - libboost-iostreams1.55-dev 18 | - libboost-locale1.55-dev 19 | - gcc-5 20 | - g++-5 21 | - clang-3.8 22 | - libstdc++-5-dev 23 | 24 | before_script: 25 | # Use the latest version of Clang/GCC. 26 | - if [ "$CXX" = "clang++" ]; then export CXX="clang++-3.8" CC="clang-3.8"; fi 27 | - if [ "$CXX" = "g++" ]; then export CXX="g++-5" CC="gcc-5"; fi 28 | - mkdir build && cd build 29 | # Travis machines are 64 bit, and the dependencies use dynamic linking. 30 | - cmake .. -DPROJECT_STATIC_RUNTIME=OFF 31 | 32 | script: make tests && ./tests 33 | -------------------------------------------------------------------------------- /include/libespm/GameId.h: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #ifndef LIBESPM_GAME_ID 21 | #define LIBESPM_GAME_ID 22 | 23 | namespace libespm { 24 | enum class GameId { 25 | OBLIVION, 26 | SKYRIM, 27 | FALLOUT3 = SKYRIM, 28 | FALLOUTNV = SKYRIM, 29 | MORROWIND, 30 | FALLOUT4 = SKYRIM, 31 | }; 32 | } 33 | 34 | #endif 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Libespm 2 | ======= 3 | 4 | [![Build Status](https://travis-ci.org/WrinklyNinja/libespm.svg?branch=master)](https://travis-ci.org/WrinklyNinja/libespm) 5 | 6 | **Note: Libespm has been deprecated in favour of [esplugin](https://github.com/WrinklyNinja/esplugin), a library that exposes similar functionality through Rust and C APIs.** 7 | 8 | A free software library for reading Elder Scrolls Plugin (`.esp`) and Elder Scrolls Master (`.esm`) files. It can currently parse plugins for the following games: 9 | 10 | * TES III: Morrowind 11 | * TES IV: Oblivion 12 | * TES V: Skyrim 13 | * Fallout 3 14 | * Fallout: New Vegas 15 | * Fallout 4 16 | 17 | Libespm focuses on providing a useful API to [libloadorder](https://github.com/WrinklyNinja/libloadorder) and [LOOT](https://github.com/loot/loot), rather than a general-purpose plugin parser. 18 | 19 | ## Requirements 20 | 21 | * [Boost](http://www.boost.org) Filesystem, Iostreams and Locale libraries (tested with v1.55.0 and v1.59.0) 22 | 23 | ## Build Instructions 24 | 25 | Libespm itself is a header-only library, so if you want to use it, only the Boost libraries need to be built. 26 | 27 | Libespm's test suite also requires [Google Test](https://github.com/google/googletest) (tested with v1.7.0), and build files can be generated using [CMake](http://cmake.org). The [Travis config file](.travis.yml) documents the process of building on Linux with GCC. The process on Windows with MSVC is equivalent. 28 | -------------------------------------------------------------------------------- /src/tests/main.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #include "PluginTest.h" 21 | #include "FormIdTest.h" 22 | 23 | #include 24 | 25 | namespace libespm { 26 | void PrintTo(const FormId& value, ::std::ostream* os) { 27 | *os << "libespm::FormId(\"" << value.getPluginName() << "\", 0x" 28 | << std::hex << std::uppercase 29 | << value.getObjectIndex() 30 | << std::nouppercase << std::dec 31 | << ")"; 32 | } 33 | 34 | void PrintTo(GameId value, ::std::ostream* os) { 35 | if (value == GameId::OBLIVION) 36 | *os << "GameId::OBLIVION"; 37 | else if (value == GameId::SKYRIM) 38 | *os << "GameId::SKYRIM"; 39 | else if (value == GameId::FALLOUT3) 40 | *os << "GameId::FALLOUT3"; 41 | else if (value == GameId::FALLOUTNV) 42 | *os << "GameId::FALLOUTNV"; 43 | else if (value == GameId::FALLOUT4) 44 | *os << "GameId::FALLOUT4"; 45 | else 46 | *os << "GameId::MORROWIND"; 47 | } 48 | } 49 | 50 | int main(int argc, char **argv) { 51 | // Set the locale to get UTF-8 conversions working correctly. 52 | std::locale::global(std::locale(std::locale(), new std::codecvt_utf8_utf16)); 53 | boost::filesystem::path::imbue(std::locale()); 54 | 55 | ::testing::InitGoogleTest(&argc, argv); 56 | return RUN_ALL_TESTS(); 57 | } 58 | -------------------------------------------------------------------------------- /include/libespm/Subrecord.h: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #ifndef LIBESPM_SUBRECORD 21 | #define LIBESPM_SUBRECORD 22 | 23 | #include 24 | #include 25 | #include 26 | 27 | #include "GameId.h" 28 | 29 | namespace libespm { 30 | class Subrecord { 31 | private: 32 | std::string type; 33 | std::shared_ptr rawData; 34 | uint32_t rawDataLength; 35 | 36 | static const int typeLength = 4; 37 | static const int normalFieldSizeLength = 2; 38 | public: 39 | inline Subrecord() : rawDataLength(0) { 40 | type.resize(typeLength); 41 | } 42 | 43 | inline void read(std::istream& input, GameId gameId, uint32_t dataLengthOverride = 0) { 44 | input.read(reinterpret_cast(&type[0]), typeLength); 45 | 46 | if (gameId == GameId::MORROWIND) { 47 | input.read(reinterpret_cast(&rawDataLength), sizeof(rawDataLength)); 48 | } else if (dataLengthOverride != 0) { 49 | input.ignore(normalFieldSizeLength); 50 | rawDataLength = dataLengthOverride; 51 | } else { 52 | input.read(reinterpret_cast(&rawDataLength), normalFieldSizeLength); 53 | } 54 | 55 | rawData = std::shared_ptr(new char[rawDataLength], std::default_delete()); 56 | input.read(rawData.get(), rawDataLength); 57 | } 58 | 59 | inline std::string getType() const { 60 | return type; 61 | } 62 | 63 | inline std::pair, uint32_t> getRawData() const { 64 | return std::make_pair(rawData, rawDataLength); 65 | } 66 | }; 67 | } 68 | 69 | #endif 70 | -------------------------------------------------------------------------------- /include/libespm/FormId.h: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #ifndef LIBESPM_FORM_ID 21 | #define LIBESPM_FORM_ID 22 | 23 | #include 24 | #include 25 | #include 26 | #include 27 | 28 | namespace libespm { 29 | class FormId { 30 | private: 31 | uint32_t objectIndex; 32 | std::string pluginName; 33 | public: 34 | inline FormId(const std::string& parentPluginName, const std::vector& masters, uint32_t formId) { 35 | unsigned int modIndex = formId >> 24; 36 | objectIndex = formId & ~((uint32_t)modIndex << 24); 37 | 38 | if (modIndex >= masters.size()) 39 | pluginName = parentPluginName; 40 | else 41 | pluginName = masters[modIndex]; 42 | } 43 | 44 | inline uint32_t getObjectIndex() const { 45 | return objectIndex; 46 | } 47 | 48 | inline std::string getPluginName() const { 49 | return pluginName; 50 | } 51 | 52 | inline bool operator < (const FormId& rhs) const { 53 | if (objectIndex != rhs.getObjectIndex()) 54 | return objectIndex < rhs.getObjectIndex(); 55 | 56 | return std::lexicographical_compare(begin(pluginName), 57 | end(pluginName), 58 | begin(rhs.pluginName), 59 | end(rhs.pluginName), 60 | [](char lhs, char rhs) { 61 | return tolower(lhs) < tolower(rhs); 62 | }); 63 | } 64 | 65 | inline bool operator == (const FormId& rhs) const { 66 | return objectIndex == rhs.getObjectIndex() 67 | && pluginName.size() == rhs.pluginName.size() 68 | && std::equal(begin(pluginName), end(pluginName), begin(rhs.pluginName), [](char lhs, char rhs) { 69 | return tolower(lhs) == tolower(rhs); 70 | }); 71 | } 72 | 73 | inline bool operator != (const FormId& rhs) const { 74 | return !(*this == rhs); 75 | } 76 | }; 77 | } 78 | 79 | #endif 80 | -------------------------------------------------------------------------------- /include/libespm/Group.h: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #ifndef LIBESPM_GROUP 21 | #define LIBESPM_GROUP 22 | 23 | #include 24 | #include 25 | #include 26 | 27 | #include "Record.h" 28 | 29 | namespace libespm { 30 | class Group { 31 | private: 32 | std::set formIds; 33 | 34 | static const uint32_t groupType = 0x50555247; //"GRUP" 35 | static const int typeLength = 4; 36 | public: 37 | inline void read(std::istream& input, GameId gameId, bool skipSubrecords) { 38 | // Header length varies by game. 39 | size_t headerLengthToSkip = getHeaderLengthToSkip(gameId); 40 | 41 | uint32_t totalRecordsSize = readHeader(input, headerLengthToSkip); 42 | readRecords(input, gameId, totalRecordsSize, skipSubrecords); 43 | } 44 | 45 | inline std::set getRecordFormIds() const { 46 | return formIds; 47 | } 48 | 49 | private: 50 | inline uint32_t readHeader(std::istream& input, size_t headerLengthToSkip) { 51 | uint32_t groupSize = 0; 52 | 53 | // Ignore the group type. 54 | input.ignore(typeLength); 55 | 56 | // Read the total group size. 57 | input.read(reinterpret_cast(&groupSize), sizeof(groupSize)); 58 | 59 | // Skip to the end of the header. 60 | input.ignore(headerLengthToSkip); 61 | 62 | return groupSize - (typeLength + sizeof(groupSize) + headerLengthToSkip); 63 | } 64 | 65 | inline void readRecords(std::istream& input, GameId gameId, uint32_t totalRecordsSize, bool skipSubrecords) { 66 | std::streampos startingInputPos = input.tellg(); 67 | while (input.good() && input.tellg() - startingInputPos < totalRecordsSize) { 68 | // Groups can contain records or subgroups. 69 | if (peekNextType(input) == groupType) { 70 | Group subGroup; 71 | subGroup.read(input, gameId, skipSubrecords); 72 | std::set subGroupFormIds = subGroup.getRecordFormIds(); 73 | this->formIds.insert(begin(subGroupFormIds), end(subGroupFormIds)); 74 | } 75 | else { 76 | Record record; 77 | record.read(input, gameId, skipSubrecords); 78 | formIds.insert(record.getFormId()); 79 | } 80 | } 81 | } 82 | 83 | inline uint32_t peekNextType(std::istream& input) const { 84 | uint32_t type; 85 | input.read(reinterpret_cast(&type), typeLength); 86 | input.seekg(-typeLength, std::ios_base::cur); 87 | 88 | return type; 89 | } 90 | 91 | inline size_t getHeaderLengthToSkip(GameId game) const { 92 | if (game == GameId::OBLIVION) 93 | return 12; 94 | else 95 | return 16; 96 | } 97 | }; 98 | } 99 | 100 | #endif 101 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | ############################## 2 | # General Settings 3 | ############################## 4 | 5 | cmake_minimum_required(VERSION 2.8) 6 | project(libespm) 7 | include(ExternalProject) 8 | 9 | option(PROJECT_STATIC_RUNTIME "Build with static runtime libs (/MT)" ON) 10 | 11 | set (Boost_USE_STATIC_LIBS ${PROJECT_STATIC_RUNTIME}) 12 | set (Boost_USE_MULTITHREADED ON) 13 | set (Boost_USE_STATIC_RUNTIME ${PROJECT_STATIC_RUNTIME}) 14 | 15 | find_package(Boost REQUIRED COMPONENTS iostreams filesystem system locale) 16 | 17 | ExternalProject_Add(GTest 18 | PREFIX "external" 19 | URL "https://github.com/google/googletest/archive/release-1.7.0.tar.gz" 20 | INSTALL_COMMAND "") 21 | ExternalProject_Get_Property(GTest SOURCE_DIR BINARY_DIR) 22 | set (GTEST_INCLUDE_DIRS "${SOURCE_DIR}/include") 23 | set (GTEST_LIBRARIES "${BINARY_DIR}/${CMAKE_CFG_INTDIR}/${CMAKE_STATIC_LIBRARY_PREFIX}gtest${CMAKE_STATIC_LIBRARY_SUFFIX}") 24 | 25 | ExternalProject_Add(testing-plugins 26 | PREFIX "external" 27 | URL "https://github.com/WrinklyNinja/testing-plugins/archive/1.2.0.tar.gz" 28 | CONFIGURE_COMMAND "" 29 | BUILD_COMMAND "" 30 | INSTALL_COMMAND "") 31 | 32 | set(PROJECT_HEADERS "${CMAKE_SOURCE_DIR}/include/libespm/FormId.h" 33 | "${CMAKE_SOURCE_DIR}/include/libespm/GameId.h" 34 | "${CMAKE_SOURCE_DIR}/include/libespm/Group.h" 35 | "${CMAKE_SOURCE_DIR}/include/libespm/Plugin.h" 36 | "${CMAKE_SOURCE_DIR}/include/libespm/Record.h" 37 | "${CMAKE_SOURCE_DIR}/include/libespm/Subrecord.h") 38 | 39 | set(TESTER_SRC "${CMAKE_SOURCE_DIR}/src/tests/main.cpp") 40 | 41 | set(TESTER_HEADERS "${CMAKE_SOURCE_DIR}/src/tests/PluginTest.h" 42 | "${CMAKE_SOURCE_DIR}/src/tests/FormIdTest.h") 43 | 44 | source_group("Header Files" FILES ${PROJECT_HEADERS} ${TESTER_HEADERS}) 45 | 46 | # Include source and library directories. 47 | include_directories("${CMAKE_SOURCE_DIR}/src" 48 | "${CMAKE_SOURCE_DIR}/include" 49 | ${Boost_INCLUDE_DIRS} 50 | ${GTEST_INCLUDE_DIRS}) 51 | 52 | ############################## 53 | # Platform-Specific Settings 54 | ############################## 55 | 56 | # Fix codepage warnings. 57 | IF (CMAKE_SYSTEM_NAME MATCHES "Windows") 58 | add_definitions (-DUNICODE -D_UNICODE) 59 | ENDIF () 60 | 61 | # GCC and Clang settings. 62 | if (CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") 63 | set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O3") 64 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3 -std=c++11") 65 | 66 | set(PROJECT_LIBRARIES "pthread") 67 | else (MSVC) 68 | IF (PROJECT_STATIC_RUNTIME) 69 | FOREACH(flag 70 | CMAKE_C_FLAGS_RELEASE CMAKE_C_FLAGS_RELWITHDEBINFO 71 | CMAKE_C_FLAGS_DEBUG CMAKE_C_FLAGS_DEBUG_INIT 72 | CMAKE_CXX_FLAGS_RELEASE CMAKE_CXX_FLAGS_RELWITHDEBINFO 73 | CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_DEBUG_INIT) 74 | STRING(REPLACE "/MD" "/MT" "${flag}" "${${flag}}") 75 | SET("${flag}" "${${flag}} /EHsc") 76 | ENDFOREACH() 77 | ENDIF () 78 | endif () 79 | 80 | ############################## 81 | # Define Targets 82 | ############################## 83 | 84 | add_executable (tests ${TESTER_SRC} ${PROJECT_HEADERS} ${TESTER_HEADERS}) 85 | add_dependencies (tests GTest testing-plugins) 86 | target_link_libraries (tests ${GTEST_LIBRARIES} ${Boost_LIBRARIES} ${PROJECT_LIBRARIES}) 87 | 88 | # Copy testing plugins 89 | ExternalProject_Get_Property(testing-plugins SOURCE_DIR) 90 | add_custom_command(TARGET tests POST_BUILD 91 | COMMAND ${CMAKE_COMMAND} -E copy_directory 92 | ${SOURCE_DIR} 93 | $) 94 | -------------------------------------------------------------------------------- /include/libespm/Record.h: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #ifndef LIBESPM_RECORD 21 | #define LIBESPM_RECORD 22 | 23 | #include 24 | #include 25 | #include 26 | 27 | #include "Subrecord.h" 28 | 29 | namespace libespm { 30 | class Record { 31 | private: 32 | std::string type; 33 | uint32_t flags; 34 | uint32_t formId; 35 | std::vector subrecords; 36 | 37 | static const int typeLength = 4; 38 | public: 39 | Record() : flags(0), formId(0), type(typeLength, '\0') {} 40 | 41 | inline void read(std::istream& input, GameId gameId, bool skipSubrecords) { 42 | subrecords.clear(); 43 | 44 | uint32_t totalSubrecordsSize = readHeader(input, gameId); 45 | if (skipSubrecords) 46 | input.ignore(totalSubrecordsSize); 47 | else 48 | readSubrecords(input, gameId, totalSubrecordsSize); 49 | } 50 | 51 | inline std::string getType() const { 52 | return type; 53 | } 54 | 55 | inline uint32_t getFlags() const { 56 | return flags; 57 | } 58 | 59 | inline const std::vector& getSubrecords() const { 60 | return subrecords; 61 | } 62 | 63 | inline uint32_t getFormId() const { 64 | return formId; 65 | } 66 | 67 | private: 68 | inline uint32_t readHeader(std::istream& input, GameId gameId) { 69 | uint32_t totalSubrecordsSize = 0; 70 | 71 | // Read in the record type. 72 | input.read(&type[0], typeLength); 73 | 74 | // Read the total subrecords size. 75 | input.read(reinterpret_cast(&totalSubrecordsSize), sizeof(totalSubrecordsSize)); 76 | 77 | if (gameId == GameId::MORROWIND) 78 | input.ignore(4); // Skip the next 4 (unknown) bytes. 79 | 80 | // Read the record flags. 81 | input.read(reinterpret_cast(&flags), sizeof(flags)); 82 | 83 | // Read the record FormID. Morrowind doesn't have FormIDs. 84 | if (gameId != GameId::MORROWIND) { 85 | input.read(reinterpret_cast(&formId), sizeof(formId)); 86 | 87 | // Skip to the end of the header. Header length varies by game. 88 | input.ignore(getHeaderLengthToSkip(gameId)); 89 | } 90 | 91 | return totalSubrecordsSize; 92 | } 93 | 94 | inline void readSubrecords(std::istream& input, GameId gameId, uint32_t totalSubrecordsSize) { 95 | // Subrecords can be compressed, in which case they must be uncompressed 96 | // before they can be read. However, there's currently no need to 97 | // actually read such subrecords, so just skip over them. 98 | if (areFieldsCompressed()) { 99 | input.ignore(totalSubrecordsSize); 100 | return; 101 | } 102 | 103 | const std::streampos startingInputPos = input.tellg(); 104 | uint32_t largeSubrecordSize = 0; 105 | while (input.good() && input.tellg() - startingInputPos < totalSubrecordsSize) { 106 | Subrecord subrecord; 107 | subrecord.read(input, gameId, largeSubrecordSize); 108 | 109 | if (subrecord.getType() == "XXXX") { 110 | largeSubrecordSize = *reinterpret_cast(subrecord.getRawData().first.get()); 111 | } else { 112 | largeSubrecordSize = 0; 113 | subrecords.push_back(subrecord); 114 | } 115 | } 116 | } 117 | 118 | inline size_t getHeaderLengthToSkip(GameId game) const { 119 | if (game == GameId::OBLIVION) 120 | return 4; 121 | else 122 | return 8; 123 | } 124 | 125 | inline bool areFieldsCompressed() const { 126 | return (flags & 0x00040000) != 0; 127 | } 128 | }; 129 | } 130 | 131 | #endif 132 | -------------------------------------------------------------------------------- /src/tests/FormIdTest.h: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #include 21 | 22 | #include 23 | #include 24 | 25 | #include "libespm/FormId.h" 26 | 27 | namespace libespm { 28 | namespace tests { 29 | class FormIdTest : public ::testing::Test { 30 | protected: 31 | std::string parentPluginName; 32 | std::vector masters; 33 | 34 | inline virtual void SetUp() { 35 | parentPluginName = "plugin1"; 36 | masters = std::vector({ 37 | "plugin2", 38 | "plugin3" 39 | }); 40 | } 41 | }; 42 | 43 | TEST_F(FormIdTest, objectIndexForFormIdsWithAZeroModIndexShouldBeEqualToOriginalFormId) { 44 | FormId formId(parentPluginName, masters, 0x01); 45 | EXPECT_EQ(0x01, formId.getObjectIndex()); 46 | } 47 | 48 | TEST_F(FormIdTest, objectIndexForFormIdsWithANonZeroModIndexShouldBeEqualToLast3BytesOfOriginalFormId) { 49 | FormId formId(parentPluginName, masters, 0x01000001); 50 | EXPECT_EQ(0x01, formId.getObjectIndex()); 51 | } 52 | 53 | TEST_F(FormIdTest, zeroModIndexWithNoMastersShouldUseParentPluginAsPlugin) { 54 | FormId formId(parentPluginName, std::vector(), 0x05000001); 55 | 56 | EXPECT_EQ(parentPluginName, formId.getPluginName()); 57 | } 58 | 59 | TEST_F(FormIdTest, nonZeroModIndexWithNoMastersShouldUseParentPluginAsPlugin) { 60 | FormId formId(parentPluginName, std::vector(), 0x05000001); 61 | 62 | EXPECT_EQ(parentPluginName, formId.getPluginName()); 63 | } 64 | 65 | TEST_F(FormIdTest, pluginForFormIdWithAZeroModIndexAndAtLeastOneMasterShouldBeTheFirstMaster) { 66 | FormId formId(parentPluginName, masters, 0x01); 67 | EXPECT_EQ(masters[0], formId.getPluginName()); 68 | } 69 | 70 | TEST_F(FormIdTest, pluginForFormIdWithAModIndexLessThanTheNumberOfMastersShouldBeTheMasterAtThatIndex) { 71 | FormId formId(parentPluginName, masters, 0x01000001); 72 | EXPECT_EQ(masters[1], formId.getPluginName()); 73 | } 74 | 75 | TEST_F(FormIdTest, pluginForFormIdWithAModIndexGreaterThanTheLastMastersIndexShouldBeTheParentPlugin) { 76 | FormId formId(parentPluginName, masters, 0x02000001); 77 | EXPECT_EQ(parentPluginName, formId.getPluginName()); 78 | } 79 | 80 | TEST_F(FormIdTest, formIdsWithEqualObjectIndicesButDifferentModIndiciesShouldNotBeEqual) { 81 | FormId formId(parentPluginName, masters, 0x01); 82 | FormId otherFormId(parentPluginName, masters, 0x05000001); 83 | 84 | EXPECT_NE(formId, otherFormId); 85 | } 86 | 87 | TEST_F(FormIdTest, formIdsWithEqualModIndicesButDifferentObjectIndiciesShouldNotBeEqual) { 88 | FormId formId(parentPluginName, masters, 0x05000001); 89 | FormId otherFormId(parentPluginName, masters, 0x05000002); 90 | 91 | EXPECT_NE(formId, otherFormId); 92 | } 93 | 94 | TEST_F(FormIdTest, formIdsWithEqualModIndicesAndNoMastersAndDifferentParentPluginNamesShouldNotBeEqual) { 95 | FormId formId(parentPluginName, std::vector(), 0x01); 96 | FormId otherFormId(parentPluginName + ".ghost", std::vector(), 0x01); 97 | 98 | EXPECT_NE(formId, otherFormId); 99 | } 100 | 101 | TEST_F(FormIdTest, identicalFormIdsShouldBeEqual) { 102 | FormId formId(parentPluginName, masters, 0x01); 103 | FormId otherFormId(parentPluginName, masters, 0x01); 104 | 105 | EXPECT_EQ(formId, otherFormId); 106 | } 107 | 108 | TEST_F(FormIdTest, formIdWithLowerObjectIndexShouldBeLessThanAnotherWithTheSamePlugin) { 109 | FormId formId(parentPluginName, masters, 0x01); 110 | FormId otherFormId(parentPluginName, masters, 0x02); 111 | 112 | EXPECT_LT(formId, otherFormId); 113 | EXPECT_FALSE(otherFormId < formId); 114 | } 115 | 116 | TEST_F(FormIdTest, formIdWithCaseInsensitiveLexicographicallyLowerPluginShouldBeLessThanAnotherWithTheSameObjectIndex) { 117 | FormId formId("A", std::vector(), 0x01); 118 | FormId otherFormId("b", std::vector(), 0x01); 119 | 120 | EXPECT_LT(formId, otherFormId); 121 | EXPECT_FALSE(otherFormId < formId); 122 | } 123 | 124 | TEST_F(FormIdTest, identicalFormIdsShouldNotBeLessThanOneAnother) { 125 | FormId formId(parentPluginName, masters, 0x01); 126 | FormId otherFormId(parentPluginName, masters, 0x01); 127 | 128 | EXPECT_FALSE(formId < otherFormId); 129 | EXPECT_FALSE(otherFormId < formId); 130 | } 131 | } 132 | } 133 | -------------------------------------------------------------------------------- /include/libespm/Plugin.h: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #ifndef LIBESPM_PLUGIN 21 | #define LIBESPM_PLUGIN 22 | 23 | #include 24 | #include 25 | #include 26 | 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | 33 | #include "FormId.h" 34 | #include "Group.h" 35 | 36 | namespace libespm { 37 | class Plugin { 38 | private: 39 | GameId gameId; 40 | 41 | std::string name; 42 | Record headerRecord; 43 | std::set formIds; 44 | 45 | public: 46 | inline Plugin(GameId gameId) : gameId(gameId) {} 47 | 48 | inline void load(const boost::filesystem::path& filepath, bool loadHeaderOnly = false) { 49 | name = filepath.filename().string(); 50 | 51 | // Memory-map the file, this can save memory and significantly improve 52 | // performance when reading large plugins. 53 | boost::iostreams::mapped_file_source mmap(filepath); 54 | boost::iostreams::stream input(mmap, std::ios::binary); 55 | input.exceptions(std::ios_base::badbit | std::ios_base::failbit); 56 | 57 | headerRecord.read(input, gameId, false); 58 | if ((gameId == GameId::MORROWIND && headerRecord.getType() != "TES3") 59 | || (gameId != GameId::MORROWIND && headerRecord.getType() != "TES4")) 60 | throw std::runtime_error(name + " is not a valid plugin."); 61 | 62 | if (loadHeaderOnly) 63 | return; 64 | 65 | // If the filename ends in ".ghost", trim that extension. 66 | std::string trimmedName = trimToEspm(name); 67 | 68 | std::vector masters = getMasters(); 69 | uintmax_t fileSize = boost::filesystem::file_size(filepath); 70 | if (gameId == GameId::MORROWIND) { 71 | while (input.good() && (uintmax_t)input.tellg() < fileSize) { 72 | Record record; 73 | record.read(input, gameId, false); 74 | formIds.insert(FormId(trimmedName, masters, record.getFormId())); 75 | } 76 | } 77 | else { 78 | while (input.good() && (uintmax_t)input.tellg() < fileSize) { 79 | Group group; 80 | group.read(input, gameId, true); 81 | for (const auto& formId : group.getRecordFormIds()) { 82 | formIds.insert(FormId(trimmedName, masters, formId)); 83 | } 84 | } 85 | } 86 | } 87 | 88 | inline std::string getName() const { 89 | return name; 90 | } 91 | 92 | inline bool isMasterFile() const { 93 | if (gameId == GameId::MORROWIND) { 94 | if (name.length() < 5) 95 | return false; 96 | 97 | const std::string masterFileExtension = ".esm"; 98 | std::string fileExtension = name.substr(name.length() - 4); 99 | 100 | return std::equal(begin(fileExtension), 101 | end(fileExtension), 102 | begin(masterFileExtension), 103 | [](char lhs, char rhs) { 104 | return tolower(lhs) == tolower(rhs); 105 | }); 106 | } 107 | else 108 | return (headerRecord.getFlags() & 0x00000001) != 0; 109 | } 110 | 111 | inline static bool isValid(const boost::filesystem::path& filepath, GameId gameId, bool loadHeaderOnly = false) { 112 | Plugin plugin(gameId); 113 | try { 114 | plugin.load(filepath, loadHeaderOnly); 115 | return true; 116 | } 117 | catch (std::exception&) { 118 | return false; 119 | } 120 | } 121 | 122 | inline std::vector getMasters() const { 123 | std::vector masterFilenames; 124 | for (const auto& subrecord : headerRecord.getSubrecords()) { 125 | if (subrecord.getType() == "MAST") { 126 | auto rawData = subrecord.getRawData(); 127 | std::string masterFilename(rawData.first.get()); 128 | masterFilenames.push_back(convertToUtf8(masterFilename)); 129 | } 130 | } 131 | return masterFilenames; 132 | } 133 | 134 | inline std::string getDescription() const { 135 | std::string targetSubrecordType("SNAM"); 136 | ptrdiff_t descriptionOffset(0); 137 | if (gameId == GameId::MORROWIND) { 138 | targetSubrecordType = "HEDR"; 139 | descriptionOffset = 40; 140 | } 141 | 142 | for (const auto& subrecord : headerRecord.getSubrecords()) { 143 | if (subrecord.getType() == targetSubrecordType) { 144 | auto rawData = subrecord.getRawData(); 145 | return convertToUtf8(std::string(rawData.first.get() + descriptionOffset)); 146 | } 147 | } 148 | return ""; 149 | } 150 | 151 | inline std::set getFormIds() const { 152 | if (gameId == GameId::MORROWIND) 153 | throw std::domain_error("Cannot get FormIDs for a Morrowind plugin: Morrowind does not use FormIDs."); 154 | 155 | return formIds; 156 | } 157 | 158 | inline uint32_t getRecordAndGroupCount() const { 159 | ptrdiff_t countOffset(4); 160 | if (gameId == GameId::MORROWIND) 161 | countOffset = 296; 162 | 163 | for (const auto& subrecord : headerRecord.getSubrecords()) { 164 | if (subrecord.getType() == "HEDR") { 165 | auto rawData = subrecord.getRawData(); 166 | return *reinterpret_cast(rawData.first.get() + countOffset); 167 | } 168 | } 169 | return 0; 170 | } 171 | 172 | private: 173 | inline static std::string trimToEspm(const std::string& filename) { 174 | size_t pos = filename.find(".esp"); 175 | if (pos != std::string::npos && pos != filename.length() - 4) 176 | return filename.substr(0, pos + 4); 177 | 178 | pos = filename.find(".esm"); 179 | if (pos != std::string::npos && pos != filename.length() - 4) 180 | return filename.substr(0, pos + 4); 181 | 182 | return filename; 183 | } 184 | 185 | inline static std::string convertToUtf8(const std::string& windows1252String) { 186 | return boost::locale::conv::to_utf(windows1252String, "Windows-1252", boost::locale::conv::stop); 187 | } 188 | }; 189 | } 190 | 191 | #endif 192 | -------------------------------------------------------------------------------- /src/tests/PluginTest.h: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of libespm 3 | * 4 | * Copyright (C) 2015 Oliver Hamlet 5 | * 6 | * libespm is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * libespm is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with libespm. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | 23 | #include "libespm/Plugin.h" 24 | 25 | namespace libespm { 26 | namespace tests { 27 | class PluginTest : public ::testing::TestWithParam { 28 | protected: 29 | PluginTest() : 30 | gameId(GetParam()), 31 | plugin(GetParam()), 32 | dataPath(getGamePath(GetParam())), 33 | missingPlugin(dataPath / "Blank.missing.esm"), 34 | emptyFile(dataPath / "EmptyFile.esm"), 35 | invalidPlugin(dataPath / "NotAPlugin.esm"), 36 | nonAsciiPlugin(dataPath / "Русский.esm"), 37 | blankEsm(dataPath / "Blank.esm"), 38 | blankMasterDependentEsm(dataPath / "Blank - Master Dependent.esm"), 39 | blankEsp(dataPath / "Blank.esp"), 40 | blankBsa(dataPath / "Blank.bsa") {} 41 | 42 | inline virtual void SetUp() { 43 | ASSERT_FALSE(boost::filesystem::exists(missingPlugin)); 44 | 45 | ASSERT_TRUE(boost::filesystem::exists(blankEsm)); 46 | ASSERT_TRUE(boost::filesystem::exists(blankMasterDependentEsm)); 47 | ASSERT_TRUE(boost::filesystem::exists(blankEsp)); 48 | 49 | // Write out an empty file. 50 | boost::filesystem::ofstream out(emptyFile.string()); 51 | out.close(); 52 | ASSERT_TRUE(boost::filesystem::exists(emptyFile)); 53 | 54 | // Write out an non-empty, non-plugin file. 55 | out.open(invalidPlugin.string()); 56 | out << "This isn't a valid plugin file."; 57 | out.close(); 58 | ASSERT_TRUE(boost::filesystem::exists(invalidPlugin)); 59 | 60 | // Copy a valid plugin to be the non-ASCII plugin. 61 | ASSERT_NO_THROW(boost::filesystem::copy(blankEsm, nonAsciiPlugin)); 62 | ASSERT_TRUE(boost::filesystem::exists(nonAsciiPlugin)); 63 | 64 | // Make sure each test starts with a new Plugin object. 65 | plugin = Plugin(gameId); 66 | } 67 | 68 | inline virtual void TearDown() { 69 | ASSERT_NO_THROW(boost::filesystem::remove(emptyFile)); 70 | ASSERT_NO_THROW(boost::filesystem::remove(invalidPlugin)); 71 | ASSERT_NO_THROW(boost::filesystem::remove(nonAsciiPlugin)); 72 | } 73 | 74 | inline boost::filesystem::path getGamePath(GameId game) const { 75 | if (game == GameId::OBLIVION) 76 | return "./Oblivion/Data"; 77 | else if (game == GameId::MORROWIND) 78 | return "./Morrowind/Data Files"; 79 | else 80 | return "./Skyrim/Data"; 81 | } 82 | 83 | const boost::filesystem::path dataPath; 84 | const boost::filesystem::path missingPlugin; 85 | const boost::filesystem::path emptyFile; 86 | const boost::filesystem::path invalidPlugin; 87 | const boost::filesystem::path nonAsciiPlugin; 88 | const boost::filesystem::path blankEsm; 89 | const boost::filesystem::path blankMasterDependentEsm; 90 | const boost::filesystem::path blankEsp; 91 | const boost::filesystem::path blankBsa; 92 | 93 | Plugin plugin; 94 | GameId gameId; 95 | }; 96 | 97 | // Pass an empty first argument, as it's a prefix for the test instantation, 98 | // but we only have the one so no prefix is necessary. 99 | INSTANTIATE_TEST_CASE_P(, 100 | PluginTest, 101 | ::testing::Values( 102 | GameId::SKYRIM, 103 | GameId::OBLIVION, 104 | GameId::FALLOUT3, 105 | GameId::FALLOUTNV, 106 | GameId::FALLOUT4, 107 | GameId::MORROWIND)); 108 | 109 | TEST_P(PluginTest, loadShouldThrowIfPluginDoesNotExist) { 110 | EXPECT_ANY_THROW(plugin.load(missingPlugin)); 111 | } 112 | 113 | TEST_P(PluginTest, loadShouldNotThrowIfValidPluginExists) { 114 | EXPECT_NO_THROW(plugin.load(blankEsm)); 115 | } 116 | 117 | TEST_P(PluginTest, loadShouldNotThrowIfAValidPluginWithANonAsciiPathExists) { 118 | EXPECT_NO_THROW(plugin.load(nonAsciiPlugin)); 119 | } 120 | 121 | TEST_P(PluginTest, loadingAnEmptyFileShouldThrow) { 122 | EXPECT_ANY_THROW(plugin.load(emptyFile)); 123 | } 124 | 125 | TEST_P(PluginTest, loadingAnInvalidPluginShouldThrow) { 126 | EXPECT_ANY_THROW(plugin.load(invalidPlugin)); 127 | } 128 | 129 | TEST_P(PluginTest, loadingASkyrimBsaShouldThrow) { 130 | if (GetParam() != GameId::SKYRIM) 131 | return; 132 | 133 | EXPECT_ANY_THROW(plugin.load(blankBsa)); 134 | } 135 | 136 | TEST_P(PluginTest, isValidShouldCorrectlyIdentifyAValidPlugin) { 137 | EXPECT_TRUE(Plugin::isValid(blankEsm, gameId)); 138 | } 139 | 140 | TEST_P(PluginTest, isValidShouldCorrectlyIdentifyAnInvalidPlugin) { 141 | EXPECT_FALSE(Plugin::isValid(invalidPlugin, gameId)); 142 | } 143 | 144 | TEST_P(PluginTest, isValidShouldCorrectlyIdentifyASkyrimBsaAsAnInvalidPlugin) { 145 | if (GetParam() != GameId::SKYRIM) 146 | return; 147 | 148 | EXPECT_FALSE(Plugin::isValid(blankBsa, gameId)); 149 | } 150 | 151 | TEST_P(PluginTest, isValidShouldCorrectlyIdentifyAValidPluginWhenOnlyTheHeaderIsChecked) { 152 | EXPECT_TRUE(Plugin::isValid(blankEsm, gameId, true)); 153 | } 154 | 155 | TEST_P(PluginTest, isValidShouldCorrectlyIdentifyAnInvalidPluginWhenOnlyTheHeaderIsChecked) { 156 | EXPECT_FALSE(Plugin::isValid(invalidPlugin, gameId, true)); 157 | } 158 | 159 | TEST_P(PluginTest, isValidShouldCorrectlyIdentifyASkyrimBsaAsAnInvalidPluginWhenOnlyTheHeaderIsChecked) { 160 | if (GetParam() != GameId::SKYRIM) 161 | return; 162 | 163 | EXPECT_FALSE(Plugin::isValid(blankBsa, gameId, true)); 164 | } 165 | 166 | TEST_P(PluginTest, blankDotEsmShouldHaveCorrectName) { 167 | ASSERT_NO_THROW(plugin.load(blankEsm)); 168 | 169 | EXPECT_EQ(blankEsm.filename().string(), plugin.getName()); 170 | } 171 | 172 | TEST_P(PluginTest, blankDotEspShouldHaveCorrectName) { 173 | ASSERT_NO_THROW(plugin.load(blankEsp)); 174 | 175 | EXPECT_EQ(blankEsp.filename().string(), plugin.getName()); 176 | } 177 | 178 | TEST_P(PluginTest, blankDotEsmShouldBeAMaster) { 179 | ASSERT_NO_THROW(plugin.load(blankEsm)); 180 | 181 | EXPECT_TRUE(plugin.isMasterFile()); 182 | } 183 | 184 | TEST_P(PluginTest, blankDotEspShouldNotBeAMaster) { 185 | ASSERT_NO_THROW(plugin.load(blankEsp)); 186 | 187 | EXPECT_FALSE(plugin.isMasterFile()); 188 | } 189 | 190 | TEST_P(PluginTest, blankDotEsmShouldHaveNoMasters) { 191 | ASSERT_NO_THROW(plugin.load(blankEsm)); 192 | 193 | EXPECT_TRUE(plugin.getMasters().empty()); 194 | } 195 | 196 | TEST_P(PluginTest, blankMasterDependentEsmShouldHaveBlankEsmAsAMaster) { 197 | ASSERT_NO_THROW(plugin.load(blankMasterDependentEsm)); 198 | 199 | std::vector masters = plugin.getMasters(); 200 | EXPECT_EQ(1, masters.size()); 201 | EXPECT_EQ(blankEsm.filename().string(), masters[0]); 202 | } 203 | 204 | TEST_P(PluginTest, blankEsmShouldHaveVersionInDescription) { 205 | ASSERT_NO_THROW(plugin.load(blankEsm)); 206 | 207 | EXPECT_EQ("v5.0", plugin.getDescription()); 208 | } 209 | 210 | TEST_P(PluginTest, blankEspShouldHaveANonAsciiDescription) { 211 | ASSERT_NO_THROW(plugin.load(blankEsp)); 212 | 213 | EXPECT_EQ("€ƒŠ", plugin.getDescription()); 214 | } 215 | 216 | TEST_P(PluginTest, blankMasterDependentEsmShouldHaveAnEmptyDescription) { 217 | ASSERT_NO_THROW(plugin.load(blankMasterDependentEsm)); 218 | 219 | EXPECT_TRUE(plugin.getDescription().empty()); 220 | } 221 | 222 | TEST_P(PluginTest, gettingFormIdsShouldThrowForMorrowindButNotForOtherGames) { 223 | if (gameId == GameId::MORROWIND) 224 | EXPECT_THROW(plugin.getFormIds(), std::domain_error); 225 | else 226 | EXPECT_NO_THROW(plugin.getFormIds()); 227 | } 228 | 229 | TEST_P(PluginTest, blankEsmShouldHave10RecordsWithTheCorrectFormIdsForNonMorrowindGames) { 230 | // No point testing for Morrowind, we know it throws from another test. 231 | if (gameId == GameId::MORROWIND) 232 | return; 233 | 234 | ASSERT_NO_THROW(plugin.load(blankEsm)); 235 | 236 | std::vector masters = plugin.getMasters(); 237 | EXPECT_EQ(std::set({ 238 | FormId(plugin.getName(), masters, 0xCF0), 239 | FormId(plugin.getName(), masters, 0xCF1), 240 | FormId(plugin.getName(), masters, 0xCF2), 241 | FormId(plugin.getName(), masters, 0xCF3), 242 | FormId(plugin.getName(), masters, 0xCF4), 243 | FormId(plugin.getName(), masters, 0xCF5), 244 | FormId(plugin.getName(), masters, 0xCF6), 245 | FormId(plugin.getName(), masters, 0xCF7), 246 | FormId(plugin.getName(), masters, 0xCF8), 247 | FormId(plugin.getName(), masters, 0xCF9), 248 | }), plugin.getFormIds()); 249 | } 250 | 251 | TEST_P(PluginTest, gettingTheFormIdsOfAGhostedBlankEsmShouldTrimTheGhostExtensionInTheFormIdObject) { 252 | // No point testing for Morrowind, we know it throws from another test. 253 | if (gameId == GameId::MORROWIND) 254 | return; 255 | 256 | ASSERT_NO_THROW(boost::filesystem::copy(blankEsm, blankEsm.string() + ".ghost")); 257 | 258 | EXPECT_NO_THROW(plugin.load(blankEsm.string() + ".ghost")); 259 | 260 | std::vector masters = plugin.getMasters(); 261 | EXPECT_EQ(std::set({ 262 | FormId(blankEsm.filename().string(), masters, 0xCF0), 263 | FormId(blankEsm.filename().string(), masters, 0xCF1), 264 | FormId(blankEsm.filename().string(), masters, 0xCF2), 265 | FormId(blankEsm.filename().string(), masters, 0xCF3), 266 | FormId(blankEsm.filename().string(), masters, 0xCF4), 267 | FormId(blankEsm.filename().string(), masters, 0xCF5), 268 | FormId(blankEsm.filename().string(), masters, 0xCF6), 269 | FormId(blankEsm.filename().string(), masters, 0xCF7), 270 | FormId(blankEsm.filename().string(), masters, 0xCF8), 271 | FormId(blankEsm.filename().string(), masters, 0xCF9), 272 | }), plugin.getFormIds()); 273 | 274 | ASSERT_NO_THROW(boost::filesystem::remove(blankEsm.string() + ".ghost")); 275 | } 276 | 277 | TEST_P(PluginTest, blankMasterDependentEsmShouldHave8RecordsWithTheCorrectFormIdsForNonMorrowindGames) { 278 | // No point testing for Morrowind, we know it throws from another test. 279 | if (gameId == GameId::MORROWIND) 280 | return; 281 | 282 | ASSERT_NO_THROW(plugin.load(blankMasterDependentEsm)); 283 | 284 | std::vector masters = plugin.getMasters(); 285 | EXPECT_EQ(std::set({ 286 | FormId(blankEsm.filename().string(), masters, 0xCF0), 287 | FormId(blankEsm.filename().string(), masters, 0xCF1), 288 | FormId(blankEsm.filename().string(), masters, 0xCF2), 289 | FormId(blankEsm.filename().string(), masters, 0xCF3), 290 | FormId(plugin.getName(), masters, 0x01000CEA), 291 | FormId(plugin.getName(), masters, 0x01000CEB), 292 | FormId(plugin.getName(), masters, 0x01000CEC), 293 | FormId(plugin.getName(), masters, 0x01000CED), 294 | }), plugin.getFormIds()); 295 | } 296 | 297 | TEST_P(PluginTest, loadingBlankEsmsHeaderOnlyShouldReadItsFilenameAsBlankEsm) { 298 | ASSERT_NO_THROW(plugin.load(blankEsm, true)); 299 | 300 | EXPECT_EQ(blankEsm.filename().string(), plugin.getName()); 301 | } 302 | 303 | TEST_P(PluginTest, loadingBlankEsmsHeaderOnlyShouldReadItBeingAMaster) { 304 | ASSERT_NO_THROW(plugin.load(blankEsm, true)); 305 | 306 | EXPECT_TRUE(plugin.isMasterFile()); 307 | } 308 | 309 | TEST_P(PluginTest, loadingBlankEsmsHeaderOnlyShouldReadItsHavingNoMasters) { 310 | ASSERT_NO_THROW(plugin.load(blankEsm, true)); 311 | 312 | EXPECT_TRUE(plugin.getMasters().empty()); 313 | } 314 | 315 | TEST_P(PluginTest, loadingBlankEsmsHeaderOnlyShouldReadAVersionInItsDescription) { 316 | ASSERT_NO_THROW(plugin.load(blankEsm, true)); 317 | 318 | EXPECT_EQ("v5.0", plugin.getDescription()); 319 | } 320 | 321 | TEST_P(PluginTest, loadingBlankEsmsHeaderOnlyShouldSkipItsOtherRecords) { 322 | // No point testing for Morrowind, we know it throws from another test. 323 | if (gameId == GameId::MORROWIND) 324 | return; 325 | 326 | ASSERT_NO_THROW(plugin.load(blankEsm, true)); 327 | 328 | EXPECT_TRUE(plugin.getFormIds().empty()); 329 | } 330 | 331 | TEST_P(PluginTest, gettingTheRecordAndGroupCountShouldWorkWhenLoadingPlugin) { 332 | ASSERT_NO_THROW(plugin.load(blankEsm)); 333 | 334 | if (gameId == GameId::MORROWIND) 335 | EXPECT_EQ(10, plugin.getRecordAndGroupCount()); 336 | else if (gameId == GameId::OBLIVION) 337 | EXPECT_EQ(14, plugin.getRecordAndGroupCount()); 338 | else 339 | EXPECT_EQ(15, plugin.getRecordAndGroupCount()); 340 | } 341 | 342 | TEST_P(PluginTest, gettingTheRecordAndGroupCountShouldWorkWhenLoadingPluginHeaderOnly) { 343 | ASSERT_NO_THROW(plugin.load(blankEsm, true)); 344 | 345 | if (gameId == GameId::MORROWIND) 346 | EXPECT_EQ(10, plugin.getRecordAndGroupCount()); 347 | else if (gameId == GameId::OBLIVION) 348 | EXPECT_EQ(14, plugin.getRecordAndGroupCount()); 349 | else 350 | EXPECT_EQ(15, plugin.getRecordAndGroupCount()); 351 | } 352 | } 353 | } 354 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------