├── .gitignore
├── lib
    ├── libooz.a
    └── ooz.lib
├── .deepsource.toml
├── ooz.hpp
├── extract.hpp
├── utils.hpp
├── mmap
    ├── mmap.hpp
    └── mmap.cpp
├── CMakeLists.txt
├── argh
    ├── LICENSE
    └── argh.h
├── .github
    └── workflows
    │   └── build.yml
├── README.md
├── main.cpp
├── utils.cpp
├── extract.cpp
└── COPYING


/.gitignore:
--------------------------------------------------------------------------------
1 | .vscode/
2 | build/
3 | 


--------------------------------------------------------------------------------
/lib/libooz.a:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/brunoanc/EternalResourceExtractor/HEAD/lib/libooz.a


--------------------------------------------------------------------------------
/lib/ooz.lib:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/brunoanc/EternalResourceExtractor/HEAD/lib/ooz.lib


--------------------------------------------------------------------------------
/.deepsource.toml:
--------------------------------------------------------------------------------
1 | version = 1
2 | 
3 | exclude_patterns = ["argh/argh.h"]
4 | 
5 | [[analyzers]]
6 | name = "cxx"
7 | 


--------------------------------------------------------------------------------
/ooz.hpp:
--------------------------------------------------------------------------------
 1 | #ifndef OOZ_HPP
 2 | #define OOZ_HPP
 3 | 
 4 | #include <cstdint>
 5 | #include <cstddef>
 6 | 
 7 | #define SAFE_SPACE 64
 8 | 
 9 | extern "C" {
10 |     int Kraken_Compress(uint8_t* src, size_t src_len, uint8_t* dst, int level);
11 |     int Kraken_Decompress(const uint8_t *src, size_t src_len, uint8_t *dst, size_t dst_len);
12 | };
13 | 
14 | #endif
15 | 


--------------------------------------------------------------------------------
/extract.hpp:
--------------------------------------------------------------------------------
 1 | #ifndef WAD7_HPP
 2 | #define WAD7_HPP
 3 | 
 4 | #include <vector>
 5 | #include <regex>
 6 | #include "mmap/mmap.hpp"
 7 | 
 8 | size_t extractResource(MemoryMappedFile *memoryMappedFile, const std::string &outPath, const std::vector<std::regex> &regexesToMatch, const std::vector<std::regex> &regexesNotToMatch);
 9 | size_t extractWad7(MemoryMappedFile *memoryMappedFile, const std::string &outPath, const std::vector<std::regex> &regexesToMatch, const std::vector<std::regex> &regexesNotToMatch);
10 | 
11 | #endif
12 | 


--------------------------------------------------------------------------------
/utils.hpp:
--------------------------------------------------------------------------------
 1 | #ifndef UTILS_HPP
 2 | #define UTILS_HPP
 3 | 
 4 | #include <vector>
 5 | #include <regex>
 6 | #include <filesystem>
 7 | 
 8 | namespace fs = std::filesystem;
 9 | 
10 | void pressAnyKey();
11 | void throwError(const std::string &error);
12 | std::string formatPath(std::string path);
13 | std::vector<std::string> splitString(std::string stringToSplit, const char delimiter);
14 | int mkpath(const fs::path &filePath, size_t startPos);
15 | void compileRegexes(std::vector<std::regex> &regexesToMatch, std::vector<std::regex> &regexesNotToMatch, const std::vector<std::pair<std::string, std::string>> &params);
16 | 
17 | #endif
18 | 


--------------------------------------------------------------------------------
/mmap/mmap.hpp:
--------------------------------------------------------------------------------
 1 | #ifndef MMAP_HPP
 2 | #define MMAP_HPP
 3 | 
 4 | #include <filesystem>
 5 | 
 6 | namespace fs = std::filesystem;
 7 | 
 8 | // Cross platform memory mapped file
 9 | class MemoryMappedFile {
10 | public:
11 |     std::string filePath;
12 |     unsigned char *memp;
13 |     uint64_t size = 0;
14 | 
15 |     MemoryMappedFile(const fs::path &path, size_t size = -1, bool create = false, bool sequential = false);
16 |     ~MemoryMappedFile();
17 | 
18 |     void unmapFile();
19 |     uint32_t readUint32LE(size_t &offset);
20 |     uint64_t readUint64LE(size_t &offset);
21 |     uint32_t readUint32BE(size_t &offset);
22 |     uint64_t readUint64BE(size_t &offset);
23 | private:
24 | #ifdef _WIN32
25 |     void *fileHandle;
26 |     void *fileMapping;
27 | #else
28 |     int fileDescriptor;
29 | #endif
30 | };
31 | 
32 | #endif
33 | 


--------------------------------------------------------------------------------
/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | cmake_minimum_required(VERSION 3.12)
 2 | project(EternalResourceExtractor)
 3 | 
 4 | set(CMAKE_CXX_STANDARD 17)
 5 | 
 6 | file(GLOB SOURCES
 7 |         ./main.cpp
 8 |         ./extract.cpp
 9 |         ./extract.hpp
10 |         ./utils.cpp
11 |         ./utils.hpp
12 |         ./ooz.hpp
13 |         ./mmap/mmap.cpp
14 |         ./mmap/mmap.hpp
15 |         ./argh/argh.hpp
16 |         )
17 | 
18 | if (MSVC)
19 |         add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
20 |         set(CMAKE_CXX_FLAGS "/O2 /Oi /Ot /GL /EHsc")
21 | else()
22 |         set (CMAKE_CXX_FLAGS "-Ofast -DNDEBUG -s")
23 | endif()
24 | 
25 | add_executable(EternalResourceExtractor ${SOURCES})
26 | 
27 | if(MSVC)
28 |         target_link_options(EternalResourceExtractor PUBLIC "/LTCG")
29 | endif()
30 | 
31 | if(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
32 |         target_link_libraries(EternalResourceExtractor ${CMAKE_SOURCE_DIR}/lib/ooz.lib)
33 | elseif(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
34 |         target_link_libraries(EternalResourceExtractor ${CMAKE_DL_LIBS} ${CMAKE_SOURCE_DIR}/lib/libooz.a)
35 | endif()
36 | 


--------------------------------------------------------------------------------
/argh/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2016, Adi Shavit 
 2 | All rights reserved. 
 3 | 
 4 | Redistribution and use in source and binary forms, with or without 
 5 | modification, are permitted provided that the following conditions are met: 
 6 | 
 7 |  * Redistributions of source code must retain the above copyright notice, 
 8 |    this list of conditions and the following disclaimer. 
 9 |  * Redistributions in binary form must reproduce the above copyright 
10 |    notice, this list of conditions and the following disclaimer in the 
11 |    documentation and/or other materials provided with the distribution. 
12 |  * Neither the name of  nor the names of its contributors may be used to 
13 |    endorse or promote products derived from this software without specific 
14 |    prior written permission. 
15 | 
16 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
17 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
18 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
19 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
20 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
21 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
22 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
23 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
24 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
25 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
26 | POSSIBILITY OF SUCH DAMAGE. 
27 | 


--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
 1 | name: Build
 2 | 
 3 | on:
 4 |   push:
 5 |     tags:
 6 |       - "v*"
 7 | 
 8 | env:
 9 |   BUILD_TYPE: Release
10 | 
11 | jobs:
12 |   windows-build:
13 |     runs-on: windows-latest
14 | 
15 |     steps:
16 |       - name: Clone repo
17 |         uses: actions/checkout@v4
18 | 
19 |       - name: Configure CMake
20 |         run: cmake -B build
21 | 
22 |       - name: Build
23 |         run: cmake --build build --config ${{env.BUILD_TYPE}}
24 | 
25 |       - name: Rename
26 |         run: mv build\Release\EternalResourceExtractor.exe EternalResourceExtractor-Windows.exe
27 | 
28 |       - name: Upload Exe
29 |         uses: svenstaro/upload-release-action@v2
30 |         with:
31 |           repo_token: ${{secrets.GITHUB_TOKEN}}
32 |           file: ${{github.workspace}}/EternalResourceExtractor-Windows.exe
33 |           tag: ${{github.ref}}
34 | 
35 |   linux-build:
36 |     runs-on: ubuntu-latest
37 | 
38 |     steps:
39 |       - name: Clone repo
40 |         uses: actions/checkout@v4
41 | 
42 |       - name: Setup Alpine
43 |         uses: jirutka/setup-alpine@v1
44 |         with:
45 |           packages: build-base cmake
46 |           branch: v3.20
47 | 
48 |       - name: Configure CMake
49 |         run: cmake -B build -DCMAKE_FIND_LIBRARY_SUFFIXES=".a" -DCMAKE_EXE_LINKER_FLAGS="-static"
50 |         shell: alpine.sh {0}
51 | 
52 |       - name: Build
53 |         run: cmake --build build --config ${{env.BUILD_TYPE}}
54 |         shell: alpine.sh {0}
55 | 
56 |       - name: Rename binary
57 |         run: mv build/EternalResourceExtractor EternalResourceExtractor-Linux
58 |         shell: alpine.sh {0}
59 | 
60 |       - uses: marvinpinto/action-automatic-releases@latest
61 |         with:
62 |           repo_token: "${{secrets.GITHUB_TOKEN}}"
63 |           prerelease: false
64 |           files: |
65 |             ${{github.workspace}}/EternalResourceExtractor-Linux
66 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # EternalResourceExtractor
 2 | 
 3 | ![Build Status](https://github.com/PowerBall253/EternalResourceExtractor/actions/workflows/build.yml/badge.svg)
 4 | 
 5 | Small C++ utility to extract files from a DOOM Eternal .resources or .wad7 file.
 6 | 
 7 | ## Features
 8 | 
 9 | * Supports launching from command line with arguments, double clicking on it, and dragging and dropping.
10 | * ~2-3x faster than QuickBMS on extracting files.
11 | * Standalone, does not require any additional files.
12 | * Lighter than QuickBMS and other extraction tools.
13 | * Supports Windows and Linux.
14 | 
15 | ## Usage
16 | 
17 | The syntax for the CMD is:
18 | 
19 | ```
20 | EternalResourceExtractor.exe [path to .resources/.wad7 file] [out path] [options]
21 | ```
22 | 
23 | The supported options are:
24 | 
25 | * `-h`, `--help`: Displays the help message and exits.
26 | * `-q`, `--quiet`: Silences output during the extraction process.
27 | * `-f`, `--filter=FILTERS`: Indicates a pattern the filename must match to be extracted,  using `*` for matching various characters and `?` to match exactly one. You can also prepend a `!` at the beginning of a filter to indicate it must not be matched, and separate various filters with a `;`.
28 | * `-r`, `--regex=REGEXES`: Similar to `-f`, but allows full ECMAScript-style regular expressions to be passed.
29 | 
30 | You can also double click on it or drag and drop the .resources file to get started.
31 | 
32 | ## Compiling
33 | 
34 | The project uses CMake to compile. It also needs MSVC or the MinGW toolchain on MSYS to compile on Windows.
35 | 
36 | First clone the repo by running:
37 | 
38 | ```
39 | git clone https://github.com/PowerBall253/EternalResourceExtractor.git
40 | ```
41 | 
42 | Then, generate the makefile by running:
43 | 
44 | ```
45 | cmake -B "build" # Append "-G 'MSYS Makefiles'" on MSYS
46 | ```
47 | 
48 | Afterwards you can build with:
49 | 
50 | ```
51 | cmake --build "build" --config Release
52 | ```
53 | 
54 | The EternalResourceExtractor executable will be in the `build` folder in Linux/MinGW and in the `build\Release` folder in MSVC.
55 | 
56 | ## Credits
57 | 
58 | * aluigi: For the QuickBMS resource extractor script for The New Colossus.
59 | * One of infogram's friends: For editing the script to work with DOOM Eternal.
60 | * tjoener: For the WAD7 file format.
61 | 


--------------------------------------------------------------------------------
/mmap/mmap.cpp:
--------------------------------------------------------------------------------
  1 | #include <algorithm>
  2 | #include <filesystem>
  3 | 
  4 | #ifdef _WIN32
  5 | #define WIN32_LEAN_AND_MEAN
  6 | #include <Windows.h>
  7 | #else
  8 | #include <unistd.h>
  9 | #include <fcntl.h>
 10 | #include <sys/mman.h>
 11 | #endif
 12 | 
 13 | #include "mmap.hpp"
 14 | 
 15 | // MemoryMappedFile constructor
 16 | MemoryMappedFile::MemoryMappedFile(const fs::path &path, size_t size, bool create, bool sequential)
 17 | {
 18 |     filePath = path.string();
 19 | 
 20 |     if (size == -1)
 21 |         size = fs::file_size(path);
 22 | 
 23 |     if (size <= 0)
 24 |         throw std::exception();
 25 | 
 26 | #ifdef _WIN32
 27 |     // Open the file
 28 |     fileHandle = CreateFileW(path.c_str(), GENERIC_READ | GENERIC_WRITE, 0, nullptr, (create ? CREATE_ALWAYS : OPEN_EXISTING), (sequential ? FILE_FLAG_SEQUENTIAL_SCAN : FILE_ATTRIBUTE_NORMAL), nullptr);
 29 | 
 30 |     if ((GetLastError() != ERROR_SUCCESS && GetLastError() != 183) || fileHandle == INVALID_HANDLE_VALUE)
 31 |         throw std::exception();
 32 | 
 33 |     // Map the file to memory
 34 |     fileMapping = CreateFileMappingW(fileHandle, nullptr, PAGE_READWRITE, *((DWORD*)&size + 1), *(DWORD*)&size, nullptr);
 35 | 
 36 |     if (GetLastError() != ERROR_SUCCESS || fileMapping == nullptr) {
 37 |         CloseHandle(fileHandle);
 38 |         throw std::exception();
 39 |     }
 40 | 
 41 |     // Get file's memory view
 42 |     memp = (unsigned char*)MapViewOfFile(fileMapping, FILE_MAP_READ | FILE_MAP_WRITE, 0, 0, 0);
 43 | 
 44 |     if (GetLastError() != ERROR_SUCCESS || memp == nullptr) {
 45 |         CloseHandle(fileHandle);
 46 |         CloseHandle(fileMapping);
 47 |         throw std::exception();
 48 |     }
 49 | #else
 50 |     // Open the file
 51 |     fileDescriptor = open(filePath.c_str(), O_RDWR);
 52 | 
 53 |     if (fileDescriptor == -1)
 54 |         throw std::exception();
 55 | 
 56 |     // Map the file to memory
 57 |     memp = reinterpret_cast<unsigned char*>(mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fileDescriptor, 0));
 58 | 
 59 |     if (memp == nullptr) {
 60 |         close(fileDescriptor);
 61 |         throw std::exception();
 62 |     }
 63 | 
 64 |     madvise(memp, size, MADV_WILLNEED);
 65 | #endif
 66 | }
 67 | 
 68 | // MemoryMappedFile destructor
 69 | MemoryMappedFile::~MemoryMappedFile()
 70 | {
 71 |     unmapFile();
 72 | }
 73 | 
 74 | // Unmap the file from memory
 75 | void MemoryMappedFile::unmapFile()
 76 | {
 77 |     if (memp == nullptr)
 78 |         return;
 79 | 
 80 | #ifdef _WIN32
 81 |     UnmapViewOfFile(memp);
 82 |     CloseHandle(fileMapping);
 83 |     CloseHandle(fileHandle);
 84 | #else
 85 |     munmap(memp, size);
 86 |     close(fileDescriptor);
 87 | #endif
 88 | 
 89 |     size = 0;
 90 |     memp = nullptr;
 91 | }
 92 | 
 93 | // Read functions
 94 | uint32_t MemoryMappedFile::readUint32LE(size_t &offset)
 95 | {
 96 |     uint32_t result = *reinterpret_cast<uint32_t*>(memp + offset);
 97 |     offset += 4;
 98 |     return result;
 99 | }
100 | 
101 | uint64_t MemoryMappedFile::readUint64LE(size_t &offset)
102 | {
103 |     uint64_t result = *reinterpret_cast<uint64_t*>(memp + offset);
104 |     offset += 8;
105 |     return result;
106 | }
107 | 
108 | uint32_t MemoryMappedFile::readUint32BE(size_t &offset)
109 | {
110 |     uint32_t result = *reinterpret_cast<uint32_t*>(memp + offset);
111 |     std::reverse(reinterpret_cast<unsigned char*>(&result), reinterpret_cast<unsigned char*>(&result) + 4);
112 |     offset += 4;
113 |     return result;
114 | }
115 | 
116 | uint64_t MemoryMappedFile::readUint64BE(size_t &offset)
117 | {
118 |     uint64_t result = *reinterpret_cast<uint64_t*>(memp + offset);
119 |     std::reverse(reinterpret_cast<unsigned char*>(&result), reinterpret_cast<unsigned char*>(&result) + 8);
120 |     offset += 8;
121 |     return result;
122 | }
123 | 


--------------------------------------------------------------------------------
/main.cpp:
--------------------------------------------------------------------------------
  1 | #include <iostream>
  2 | #include <cstring>
  3 | #include <chrono>
  4 | #include <array>
  5 | #include "extract.hpp"
  6 | #include "utils.hpp"
  7 | #include "argh/argh.h"
  8 | 
  9 | namespace chrono = std::chrono;
 10 | 
 11 | int main(int argc, char **argv)
 12 | {
 13 |     // Disable sync with stdio
 14 |     std::ios::sync_with_stdio(false);
 15 | 
 16 |     // Buffer stdout
 17 |     std::array<char, 8192> buffer;
 18 |     std::cout.rdbuf()->pubsetbuf(buffer.data(), buffer.size());
 19 | 
 20 |     std::cout << "EternalResourceExtractor v4.0.0 by powerball253\n\n";
 21 | 
 22 |     // Parse arguments
 23 |     argh::parser cmdl;
 24 |     cmdl.add_params({"-f", "--filter", "-r", "--regex"});
 25 |     cmdl.parse(argc, argv);
 26 | 
 27 |     if (cmdl[{"-h", "--help"}]) {
 28 |         std::cout << "Usage:\n";
 29 |         std::cout << "EternalResourceExtractor [path to .resources file] [out path] [options]\n\n";
 30 |         std::cout << "Options:\n\n";
 31 |         std::cout << "-h, --help\t\tDisplay this help message and exit\n\n";
 32 |         std::cout << "-q, --quiet\t\tSilences output during the extraction process.\n\n";
 33 |         std::cout << "-f, --filter=FILTERS\tIndicate a pattern the filename must match to be extracted, using\n"
 34 |             << "\t\t\t'*' for matching various characters and '?' to match exactly one.\n";
 35 |         std::cout << "\t\t\tYou can also prepend a '!' at the beginning of a filter to indicate it\n"
 36 |         << "\t\t\tmust not be matched, and separate various filters with a ';'.\n\n";
 37 |         std::cout << "-r, --regex=REGEXES\tSimilar to -f, but allows full regular expressions to be passed.\n\n";
 38 |         std::cout.flush();
 39 |         return 1;
 40 |     }
 41 | 
 42 |     if (cmdl[{"-q", "--quiet"}])
 43 |         std::cout.setstate(std::ios::failbit); // Makes cout not output anything
 44 | 
 45 |     // Get resource & out path
 46 |     const std::vector<std::string> args = cmdl.pos_args();
 47 |     std::string resourcePath;
 48 |     std::string outPath;
 49 |     std::error_code ec;
 50 | 
 51 |     switch (args.size()) {
 52 |         case 1:
 53 |             std::cout << "Input the path to the .resources file: ";
 54 |             std::cout.flush();
 55 |             std::getline(std::cin, resourcePath);
 56 | 
 57 |             std::cout << "Input the path to the out directory: ";
 58 |             std::cout.flush();
 59 |             std::getline(std::cin, outPath);
 60 | 
 61 |             std::cout << '\n';
 62 |             break;
 63 |         case 2:
 64 |             resourcePath = args[1];
 65 | 
 66 |             std::cout << "Input the path to the out directory: ";
 67 |             std::cout.flush();
 68 |             std::getline(std::cin, outPath);
 69 | 
 70 |             std::cout << '\n';
 71 |             break;
 72 |         default:
 73 |             resourcePath = args[1];
 74 |             outPath = args[2];
 75 |             break;
 76 |     }
 77 | 
 78 |     // Get full path for resource & out directory
 79 |     if (resourcePath.empty())
 80 |         throwError("Resource file was not specified.");
 81 | 
 82 |     if (outPath.empty())
 83 |         throwError("Out directory was not specified.");
 84 | 
 85 |     resourcePath = fs::absolute(formatPath(resourcePath), ec).string();
 86 | 
 87 |     if (ec.value() != 0)
 88 |         throwError("Failed to get resource path: " + ec.message());
 89 | 
 90 |     outPath = fs::absolute(formatPath(outPath), ec).string();
 91 | 
 92 |     if (ec.value() != 0)
 93 |         throwError("Failed to get out path: " + ec.message());
 94 | 
 95 |     if (outPath[outPath.length() - 1] != fs::path::preferred_separator)
 96 |         outPath.push_back(fs::path::preferred_separator);
 97 | 
 98 | #ifdef _WIN32
 99 |     // "\\?\" alongside the wide string functions is used to bypass PATH_MAX
100 |     // Check https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=cmd for details
101 |     outPath = "\\\\?\\" + outPath;
102 | #endif
103 | 
104 |     // Get regexes to match/not match
105 |     std::vector<std::regex> regexesToMatch;
106 |     std::vector<std::regex> regexesNotToMatch;
107 |     compileRegexes(regexesToMatch, regexesNotToMatch, cmdl.params());
108 | 
109 |     // Time program
110 |     chrono::steady_clock::time_point begin = chrono::steady_clock::now();
111 | 
112 |     // Open the resource file
113 |     MemoryMappedFile *memoryMappedFile;
114 | 
115 |     try {
116 |         memoryMappedFile = new MemoryMappedFile(resourcePath);
117 |     }
118 |     catch (const std::exception &e) {
119 |         throwError("Failed to open " + resourcePath + " for reading.");
120 |     }
121 |     
122 |     // Create out path
123 |     fs::create_directories(outPath, ec);
124 | 
125 |     if (ec.value() != 0)
126 |         throwError("Failed to create out directory: " + ec.message());
127 | 
128 |     size_t filesExtracted = 0;
129 | 
130 |     // Identify file using magic and extract
131 |     if (memcmp(memoryMappedFile->memp, "IDCL", 4) == 0)
132 |         filesExtracted = extractResource(memoryMappedFile, outPath, regexesToMatch, regexesNotToMatch);
133 |     else if (*reinterpret_cast<uint32_t*>(memoryMappedFile->memp) == 131121354)
134 |         filesExtracted = extractWad7(memoryMappedFile, outPath, regexesToMatch, regexesNotToMatch);
135 |     else
136 |         throwError(fs::path(resourcePath).filename().string() + " is not a valid .resources or .wad7 file.");
137 | 
138 |     delete memoryMappedFile;
139 | 
140 |     // Exit
141 |     chrono::steady_clock::time_point end = chrono::steady_clock::now();
142 |     double totalTime = static_cast<double>(chrono::duration_cast<chrono::microseconds>(end - begin).count());
143 |     double totalTimeSeconds = totalTime / 1000000;
144 | 
145 |     std::cout.clear();
146 |     std::cout << "\nDone, " << filesExtracted << " files extracted in " << totalTimeSeconds << " seconds." << std::endl;
147 |     pressAnyKey();
148 | }
149 | 


--------------------------------------------------------------------------------
/utils.cpp:
--------------------------------------------------------------------------------
  1 | #include <iostream>
  2 | #include <string>
  3 | #include <vector>
  4 | #include <cstring>
  5 | #include <sys/stat.h>
  6 | #include "utils.hpp"
  7 | 
  8 | #ifdef _WIN32
  9 | #define WIN32_LEAN_AND_MEAN
 10 | #include <Windows.h>
 11 | #include <conio.h>
 12 | #include <direct.h>
 13 | #endif
 14 | 
 15 | #ifdef _WIN32
 16 | // Check if process is running on a terminal by checking the console processes
 17 | inline bool isRunningOnTerminal()
 18 | {
 19 |     DWORD buffer[1];
 20 |     return GetConsoleProcessList(buffer, 1) > 1;
 21 | }
 22 | #endif
 23 | 
 24 | // Display the 'press any key to exit' if process is not running in a terminal (Windows only)
 25 | void pressAnyKey()
 26 | {
 27 | #ifdef _WIN32
 28 |     if (isRunningOnTerminal())
 29 |         return;
 30 | 
 31 |     std::cout << "\nPress any key to exit..." << std::endl;
 32 |     _getch();
 33 | #endif
 34 | }
 35 | 
 36 | // Display error and exit
 37 | void throwError(const std::string &error)
 38 | {
 39 |     std::cout.flush();
 40 |     std::cerr << "\nERROR: " << error << std::endl;
 41 |     pressAnyKey();
 42 |     exit(1);
 43 | }
 44 | 
 45 | // Format path by removing whitespace and double quotes
 46 | std::string formatPath(std::string path)
 47 | {
 48 |     // Trim whitespace and quotes in string
 49 |     path.erase(path.find_last_not_of(" \t\n\r\f\v\"") + 1);
 50 |     path.erase(0, path.find_first_not_of(" \t\n\r\f\v\""));
 51 |     return path;
 52 | }
 53 | 
 54 | // Split the given string using the given delimiter
 55 | std::vector<std::string> splitString(std::string stringToSplit, const char delimiter)
 56 | {
 57 |     std::vector<std::string> resultVector;
 58 |     size_t pos;
 59 |     std::string part;
 60 | 
 61 |     while ((pos = stringToSplit.find(delimiter)) != std::string::npos) {
 62 |         part = stringToSplit.substr(0, pos);
 63 |         resultVector.push_back(part);
 64 |         stringToSplit.erase(0, pos + 1);
 65 |     }
 66 | 
 67 |     resultVector.push_back(stringToSplit);
 68 | 
 69 |     return resultVector;
 70 | }
 71 | 
 72 | // Recursive mkdir
 73 | #ifdef _WIN32
 74 | int mkpath(const fs::path &filePath, size_t startPos)
 75 | {
 76 |     auto *path = _wcsdup(filePath.c_str());
 77 |     const char separator = fs::path::preferred_separator;
 78 | 
 79 |     for (wchar_t *p = wcschr(path + startPos, separator); p != nullptr; p = wcschr(p + 1, separator)) {
 80 |         *p = '\0';
 81 | 
 82 |         if (_wmkdir(path) == -1 && errno != EEXIST) {
 83 |             *p = separator;
 84 |             return -1;
 85 |         }
 86 | 
 87 |         *p = separator;
 88 |     }
 89 | 
 90 |     free(path);
 91 |     return 0;
 92 | }
 93 | #else
 94 | int mkpath(const fs::path &filePath, size_t startPos)
 95 | {
 96 |     auto *path = strdup(filePath.c_str());
 97 |     const char separator = fs::path::preferred_separator;
 98 | 
 99 |     for (char *p = strchr(path + startPos, separator); p != nullptr; p = strchr(p + 1, separator)) {
100 |         *p = '\0';
101 | 
102 |         if (mkdir(path, 0777) == -1) {
103 |             if (errno == EEXIST) {
104 |                 if (fs::is_regular_file(path)) {
105 |                     fs::path newPath(path);
106 |                     newPath += " (1)";
107 |                     fs::rename(path, newPath);
108 | 
109 |                     if (mkdir(path, 0777) == -1) {
110 |                         *p = separator;
111 |                         return -1;
112 |                     }
113 |                 }
114 |             }
115 |             else {
116 |                 *p = separator;
117 |                 return -1;
118 |             }
119 |         }
120 | 
121 |         *p = separator;
122 |     }
123 | 
124 |     free(path);
125 |     return 0;
126 | }
127 | #endif
128 | 
129 | // Populate regex resources from parameters
130 | void compileRegexes(std::vector<std::regex> &regexesToMatch, std::vector<std::regex> &regexesNotToMatch, const std::vector<std::pair<std::string, std::string>> &params)
131 | {
132 |     const std::string charsToEscape = "\\^$*+?.()|{}[]";
133 |     
134 |     for (const auto& param : params) {
135 |         if (param.first == "r" || param.first == "regex") {
136 |             for (const auto& regex : splitString(param.second, ';')) {
137 |                 // Push regex to vector
138 |                 try {
139 |                     if (regex[0] == '!')
140 |                         regexesNotToMatch.emplace_back(regex.substr(1), std::regex_constants::ECMAScript | std::regex_constants::optimize);
141 |                     else
142 |                         regexesToMatch.emplace_back(regex, std::regex_constants::ECMAScript | std::regex_constants::optimize);
143 |                 }
144 |                 catch (const std::exception& e) {
145 |                     throwError("Failed to parse " + regex + " regular expression: " + e.what());
146 |                 }
147 |             }
148 |         }
149 |         else if (param.first == "f" || param.first == "filter") {
150 |             for (const auto& filter : splitString(param.second, ';')) {
151 |                 // Convert filter into valid regex
152 |                 std::string regex;
153 |     
154 |                 for (const auto& c : filter) {
155 |                     switch (c) {
156 |                         case '?':
157 |                             regex.push_back('.');
158 |                             break;
159 |                         case '*':
160 |                             regex += ".*";
161 |                             break;
162 |                         default:
163 |                             if (charsToEscape.find(c) != std::string::npos)
164 |                                 regex.push_back('\\'); // Escape character with backslash
165 |     
166 |                             regex.push_back(c);
167 |                             break;
168 |                     }
169 |                 }
170 |     
171 |                 // Push regex to vector
172 |                 try {
173 |                     if (regex[0] == '!')
174 |                         regexesNotToMatch.emplace_back(regex.substr(1), std::regex_constants::ECMAScript | std::regex_constants::optimize);
175 |                     else
176 |                         regexesToMatch.emplace_back(regex, std::regex_constants::ECMAScript | std::regex_constants::optimize);
177 |                 }
178 |                 catch (const std::exception &e) {
179 |                     throwError("Failed to parse " + filter + " filter: " + e.what());
180 |                 }
181 |             }
182 |         }
183 |     }
184 | }
185 | 


--------------------------------------------------------------------------------
/extract.cpp:
--------------------------------------------------------------------------------
  1 | #include <filesystem>
  2 | #include <iostream>
  3 | #include <regex>
  4 | #include <cstring>
  5 | #include "utils.hpp"
  6 | #include "ooz.hpp"
  7 | #include "mmap/mmap.hpp"
  8 | 
  9 | // Extract file from memory
 10 | void extractFile(const MemoryMappedFile *memoryMappedFile, const std::string &name, const std::string &outPath, size_t offset, size_t size, size_t zSize, size_t compressionMode)
 11 | {
 12 |     std::cout << "Extracting " << name << "...\n";
 13 | 
 14 |     // Create out directory
 15 |     auto filePath = fs::path(outPath + name).make_preferred();
 16 |     mkpath(filePath, outPath.length());
 17 | 
 18 |     if (mkpath(filePath, outPath.length()) != 0)
 19 |         throwError("Failed to create " + filePath.parent_path().string() + " path for extraction: " + strerror(errno));
 20 | 
 21 |     if (fs::is_directory(filePath)) {
 22 |         filePath += " (1)";
 23 |     }
 24 | 
 25 |     if (size == 0) {
 26 |         // Create empty file and continue
 27 | #ifdef _WIN32
 28 |         FILE *exportFile = _wfopen(filePath.c_str(), L"wb");
 29 | #else
 30 |         FILE *exportFile = fopen(filePath.c_str(), "wb");
 31 | #endif
 32 |         fclose(exportFile);
 33 |     }
 34 |     else if (size == zSize) {
 35 |         // File is decompressed, extract as-is
 36 | #ifdef _WIN32
 37 |         MemoryMappedFile *outFile;
 38 | 
 39 |         try {
 40 |             outFile = new MemoryMappedFile(filePath, size, true, true);
 41 |         }
 42 |         catch (const std::exception &e) {
 43 |             throwError("Failed to extract " + filePath.string() + " for reading.");
 44 |         }
 45 | 
 46 |         memcpy(outFile->memp, memoryMappedFile->memp + offset, size);
 47 |         delete outFile;
 48 | #else
 49 |         FILE *exportFile = fopen(filePath.c_str(), "wb");
 50 | 
 51 |         if (exportFile == nullptr)
 52 |             throwError("Failed to open " + filePath.string() + " for writing: " + strerror(errno));
 53 | 
 54 |         fwrite(memoryMappedFile->memp + offset, 1, size, exportFile);
 55 |         fclose(exportFile);
 56 | #endif
 57 |     }
 58 |     else {
 59 |         // File is kraken-compressed, decompress with ooz
 60 | 
 61 |         // Check oodle flags
 62 |         if ((compressionMode & 4) != 0) {
 63 |             offset += 12;
 64 |             zSize -= 12;
 65 |         }
 66 | 
 67 |         // Decompress file
 68 |         auto *decBytes = new(std::nothrow) unsigned char[size + SAFE_SPACE];
 69 | 
 70 |         if (decBytes == nullptr)
 71 |             throwError("Failed to allocate memory for extraction.");
 72 | 
 73 |         if (Kraken_Decompress(memoryMappedFile->memp + offset, static_cast<int32_t>(zSize),
 74 |         decBytes, size) != size)
 75 |             throwError("Failed to decompress " + name + ".");
 76 | 
 77 |         // Write file to disk
 78 | #ifdef _WIN32
 79 |         MemoryMappedFile *outFile;
 80 | 
 81 |         try {
 82 |             outFile = new MemoryMappedFile(filePath, size, true, true);
 83 |         }
 84 |         catch (const std::exception &e) {
 85 |             throwError("Failed to open " + filePath.string() + " for writing.");
 86 |         }
 87 | 
 88 |         memcpy(outFile->memp, decBytes, size);
 89 |         delete outFile;
 90 | #else
 91 |         FILE *exportFile = fopen(filePath.c_str(), "wb");
 92 | 
 93 |         if (exportFile == nullptr)
 94 |             throwError("Failed to open " + filePath.string() + " for writing: " + strerror(errno));
 95 | 
 96 |         fwrite(decBytes, 1, size, exportFile);
 97 |         fclose(exportFile);
 98 | #endif
 99 | 
100 |         delete[] decBytes;
101 |     }
102 | }
103 | 
104 | // Check whether we should extract the file based on the include/exclude regexes
105 | bool shouldExtractFile(const std::string &name, const std::vector<std::regex> &regexesToMatch, const std::vector<std::regex> &regexesNotToMatch)
106 | {
107 |     bool extract = regexesToMatch.empty();
108 | 
109 |     for (const auto &regex : regexesToMatch) {
110 |         if (std::regex_match(name, regex)) {
111 |             extract = true;
112 |             break;
113 |         }
114 |     }
115 | 
116 |     if (!extract) {
117 |         return false;
118 |     }
119 | 
120 |     for (const auto &regex : regexesNotToMatch) {
121 |         if (std::regex_match(name, regex)) {
122 |             extract = false;
123 |             break;
124 |         }
125 |     }
126 |     
127 |     return extract;
128 | }
129 | 
130 | // Extract all files from resources file
131 | size_t extractResource(MemoryMappedFile *memoryMappedFile, const std::string &outPath, const std::vector<std::regex> &regexesToMatch, const std::vector<std::regex> &regexesNotToMatch)
132 | {
133 |     // Read resource data
134 |     size_t memPosition = 4;
135 | 
136 |     uint32_t version = memoryMappedFile->readUint32LE(memPosition);
137 | 
138 |     if (version >= 0xD) {
139 |         memPosition = 36;
140 |     }
141 |     else {
142 |         memPosition = 32;
143 |     }
144 | 
145 |     uint32_t fileCount = memoryMappedFile->readUint32LE(memPosition);
146 |     memPosition += 4;
147 | 
148 |     uint32_t dummyCount = memoryMappedFile->readUint32LE(memPosition);
149 |     memPosition += 20;
150 | 
151 |     // Get offsets
152 |     uint64_t namesOffset = memoryMappedFile->readUint64LE(memPosition);
153 |     memPosition += 8;
154 | 
155 |     uint64_t infoOffset = memoryMappedFile->readUint64LE(memPosition);
156 |     memPosition += 8;
157 | 
158 |     uint64_t dummyOffset = memoryMappedFile->readUint64LE(memPosition) + dummyCount * sizeof(dummyCount);
159 | 
160 |     memPosition = namesOffset;
161 | 
162 |     // Get filenames for exporting
163 |     uint64_t nameCount = memoryMappedFile->readUint64LE(memPosition);
164 | 
165 |     std::vector<std::string> names;
166 |     names.reserve(nameCount);
167 | 
168 |     size_t currentPosition = memPosition;
169 | 
170 |     for (int i = 0; i < nameCount; i++) {
171 |         memPosition = currentPosition + static_cast<size_t>(i) * 8;
172 |         uint64_t currentNameOffset = memoryMappedFile->readUint64LE(memPosition);
173 | 
174 |         memPosition = namesOffset + nameCount * 8 + currentNameOffset + 8;
175 |         std::string name(reinterpret_cast<char*>(memoryMappedFile->memp) + memPosition);
176 | 
177 |         memPosition += name.length();
178 |         names.push_back(name);
179 |     }
180 | 
181 |     memPosition = infoOffset;
182 | 
183 |     // Extract files
184 |     size_t filesExtracted = 0;
185 | 
186 |     for (int i = 0; i < fileCount; i++) {
187 |         memPosition += 32;
188 | 
189 |         // Read file info for extracting
190 |         uint64_t nameIdOffset = memoryMappedFile->readUint64LE(memPosition);
191 |         memPosition += 16;
192 | 
193 |         uint64_t offset = memoryMappedFile->readUint64LE(memPosition);
194 |         uint64_t zSize = memoryMappedFile->readUint64LE(memPosition);
195 |         uint64_t size = memoryMappedFile->readUint64LE(memPosition);
196 | 
197 |         memPosition += 32;
198 | 
199 |         uint64_t zipFlags = memoryMappedFile->readUint64LE(memPosition);
200 |         memPosition += 24;
201 | 
202 |         nameIdOffset = (nameIdOffset + 1) * 8 + dummyOffset;
203 |         currentPosition = memPosition;
204 |         memPosition = nameIdOffset;
205 | 
206 |         uint64_t nameId = memoryMappedFile->readUint64LE(memPosition);
207 |         std::string name = names[nameId];
208 | 
209 |         // Match filename with regexes
210 |         if (!shouldExtractFile(name, regexesToMatch, regexesNotToMatch)) {
211 |             memPosition = currentPosition;
212 |             continue;
213 |         }
214 | 
215 |         // Extract file
216 |         extractFile(memoryMappedFile, name, outPath, offset, size, zSize, zipFlags);
217 |         filesExtracted++;
218 | 
219 |         // Seek back to info section
220 |         memPosition = currentPosition;
221 |     }
222 |     
223 |     return filesExtracted;
224 | }
225 | 
226 | // Extract all files from WAD7 file
227 | size_t extractWad7(MemoryMappedFile *memoryMappedFile, const std::string &outPath, const std::vector<std::regex> &regexesToMatch, const std::vector<std::regex> &regexesNotToMatch)
228 | {
229 |     size_t memPosition = 19;
230 | 
231 |     // Get index position and size
232 |     uint64_t indexStart = memoryMappedFile->readUint64BE(memPosition);
233 |     uint64_t indexSize = memoryMappedFile->readUint64BE(memPosition);
234 | 
235 |     memPosition = indexStart;
236 | 
237 |     // Get entry count
238 |     uint32_t entryCount = memoryMappedFile->readUint32BE(memPosition);
239 | 
240 |     // Extract files
241 |     size_t filesExtracted = 0;
242 | 
243 |     for (int i = 0; i < entryCount; i++) {
244 |         // Get entry name
245 |         uint32_t nameSize = memoryMappedFile->readUint32LE(memPosition);
246 | 
247 |         std::string name(reinterpret_cast<char*>(memoryMappedFile->memp) + memPosition, nameSize);
248 |         memPosition += nameSize;
249 |         
250 |         // Match filename with regexes
251 |         if (!shouldExtractFile(name, regexesToMatch, regexesNotToMatch)) {
252 |             memPosition += 32;
253 |             continue;
254 |         }
255 | 
256 |         // Get data offset
257 |         uint64_t offset = memoryMappedFile->readUint64BE(memPosition);
258 | 
259 |         // Get uncompressed size
260 |         uint32_t size = memoryMappedFile->readUint32BE(memPosition);
261 | 
262 |         // Get compressed size
263 |         uint32_t zSize = memoryMappedFile->readUint32BE(memPosition);
264 |         
265 |         // Get compression mode
266 |         uint32_t compressionMode = memoryMappedFile->readUint32BE(memPosition);
267 | 
268 |         // Extract file
269 |         extractFile(memoryMappedFile, name, outPath, offset, size, zSize, compressionMode);
270 |         filesExtracted++;
271 |         memPosition += 12;
272 |     }
273 |     
274 |     return filesExtracted;
275 | }
276 | 


--------------------------------------------------------------------------------
/argh/argh.h:
--------------------------------------------------------------------------------
  1 | #pragma once
  2 | 
  3 | #include <algorithm>
  4 | #include <sstream>
  5 | #include <limits>
  6 | #include <string>
  7 | #include <vector>
  8 | #include <set>
  9 | #include <map>
 10 | #include <cassert>
 11 | 
 12 | namespace argh
 13 | {
 14 |    // Terminology:
 15 |    // A command line is composed of 2 types of args:
 16 |    // 1. Positional args, i.e. free standing values
 17 |    // 2. Options: args beginning with '-'. We identify two kinds:
 18 |    //    2.1: Flags: boolean options =>  (exist ? true : false)
 19 |    //    2.2: Parameters: a name followed by a non-option value
 20 | 
 21 | #if !defined(__GNUC__) || (__GNUC__ >= 5)
 22 |    using string_stream = std::istringstream;
 23 | #else
 24 |     // Until GCC 5, istringstream did not have a move constructor.
 25 |     // stringstream_proxy is used instead, as a workaround.
 26 |    class stringstream_proxy
 27 |    {
 28 |    public:
 29 |       stringstream_proxy() = default;
 30 | 
 31 |       // Construct with a value.
 32 |       stringstream_proxy(std::string const& value) :
 33 |          stream_(value)
 34 |       {}
 35 | 
 36 |       // Copy constructor.
 37 |       stringstream_proxy(const stringstream_proxy& other) :
 38 |          stream_(other.stream_.str())
 39 |       {
 40 |          stream_.setstate(other.stream_.rdstate());
 41 |       }
 42 | 
 43 |       void setstate(std::ios_base::iostate state) { stream_.setstate(state); }
 44 | 
 45 |       // Stream out the value of the parameter.
 46 |       // If the conversion was not possible, the stream will enter the fail state,
 47 |       // and operator bool will return false.
 48 |       template<typename T>
 49 |       stringstream_proxy& operator >> (T& thing)
 50 |       {
 51 |          stream_ >> thing;
 52 |          return *this;
 53 |       }
 54 | 
 55 | 
 56 |       // Get the string value.
 57 |       std::string str() const { return stream_.str(); }
 58 | 
 59 |       std::stringbuf* rdbuf() const { return stream_.rdbuf(); }
 60 | 
 61 |       // Check the state of the stream.
 62 |       // False when the most recent stream operation failed
 63 |       explicit operator bool() const { return !!stream_; }
 64 | 
 65 |       ~stringstream_proxy() = default;
 66 |    private:
 67 |       std::istringstream stream_;
 68 |    };
 69 |    using string_stream = stringstream_proxy;
 70 | #endif
 71 | 
 72 |    class parser
 73 |    {
 74 |    public:
 75 |       enum Mode { PREFER_FLAG_FOR_UNREG_OPTION = 1 << 0,
 76 |                   PREFER_PARAM_FOR_UNREG_OPTION = 1 << 1,
 77 |                   NO_SPLIT_ON_EQUALSIGN = 1 << 2,
 78 |                   SINGLE_DASH_IS_MULTIFLAG = 1 << 3,
 79 |                 };
 80 | 
 81 |       parser() = default;
 82 | 
 83 |       parser(std::initializer_list<char const* const> pre_reg_names)
 84 |       {  add_params(pre_reg_names); }
 85 | 
 86 |       parser(const char* const argv[], int mode = PREFER_FLAG_FOR_UNREG_OPTION)
 87 |       {  parse(argv, mode); }
 88 | 
 89 |       parser(int argc, const char* const argv[], int mode = PREFER_FLAG_FOR_UNREG_OPTION)
 90 |       {  parse(argc, argv, mode); }
 91 | 
 92 |       void add_param(std::string const& name);
 93 |       void add_params(std::initializer_list<char const* const> init_list);
 94 | 
 95 |       void parse(const char* const argv[], int mode = PREFER_FLAG_FOR_UNREG_OPTION);
 96 |       void parse(int argc, const char* const argv[], int mode = PREFER_FLAG_FOR_UNREG_OPTION);
 97 | 
 98 |       std::multiset<std::string>          const& flags()    const { return flags_;    }
 99 |       std::vector<std::pair<std::string, std::string>>  const& params()   const { return params_;   }
100 |       std::vector<std::string>            const& pos_args() const { return pos_args_; }
101 | 
102 |       // begin() and end() for using range-for over positional args.
103 |       std::vector<std::string>::const_iterator begin() const { return pos_args_.cbegin(); }
104 |       std::vector<std::string>::const_iterator end()   const { return pos_args_.cend();   }
105 |       size_t size()                                    const { return pos_args_.size();   }
106 | 
107 |       //////////////////////////////////////////////////////////////////////////
108 |       // Accessors
109 | 
110 |       // flag (boolean) accessors: return true if the flag appeared, otherwise false.
111 |       bool operator[](std::string const& name) const;
112 | 
113 |       // multiple flag (boolean) accessors: return true if at least one of the flag appeared, otherwise false.
114 |       bool operator[](std::initializer_list<char const* const> init_list) const;
115 | 
116 |       // returns positional arg string by order. Like argv[] but without the options
117 |       std::string const& operator[](size_t ind) const;
118 | 
119 |       // returns a std::istream that can be used to convert a positional arg to a typed value.
120 |       string_stream operator()(size_t ind) const;
121 | 
122 |       // same as above, but with a default value in case the arg is missing (index out of range).
123 |       template<typename T>
124 |       string_stream operator()(size_t ind, T&& def_val) const;
125 | 
126 |       // parameter accessors, give a name get an std::istream that can be used to convert to a typed value.
127 |       // call .str() on result to get as string
128 |       string_stream operator()(std::string const& name) const;
129 | 
130 |       // accessor for a parameter with multiple names, give a list of names, get an std::istream that can be used to convert to a typed value.
131 |       // call .str() on result to get as string
132 |       // returns the first value in the list to be found.
133 |       string_stream operator()(std::initializer_list<char const* const> init_list) const;
134 | 
135 |       // same as above, but with a default value in case the param was missing.
136 |       // Non-string def_val types must have an operator<<() (output stream operator)
137 |       // If T only has an input stream operator, pass the string version of the type as in "3" instead of 3.
138 |       template<typename T>
139 |       string_stream operator()(std::string const& name, T&& def_val) const;
140 | 
141 |       // same as above but for a list of names. returns the first value to be found.
142 |       template<typename T>
143 |       string_stream operator()(std::initializer_list<char const* const> init_list, T&& def_val) const;
144 | 
145 |    private:
146 |       string_stream bad_stream() const;
147 |       std::string trim_leading_dashes(std::string const& name) const;
148 |       bool is_number(std::string const& arg) const;
149 |       bool is_option(std::string const& arg) const;
150 |       bool got_flag(std::string const& name) const;
151 |       bool is_param(std::string const& name) const;
152 | 
153 |    private:
154 |       std::vector<std::string> args_;
155 |       //std::map<std::string, std::string> params_;
156 |       std::vector<std::pair<std::string, std::string>> params_;
157 |       std::vector<std::string> pos_args_;
158 |       std::multiset<std::string> flags_;
159 |       std::set<std::string> registeredParams_;
160 |       std::string empty_;
161 |    };
162 | 
163 | 
164 |    //////////////////////////////////////////////////////////////////////////
165 | 
166 |    inline void parser::parse(const char * const argv[], int mode)
167 |    {
168 |       int argc = 0;
169 |       for (auto argvp = argv; *argvp; ++argc, ++argvp);
170 |       parse(argc, argv, mode);
171 |    }
172 | 
173 |    //////////////////////////////////////////////////////////////////////////
174 | 
175 |    inline void parser::parse(int argc, const char* const argv[], int mode /*= PREFER_FLAG_FOR_UNREG_OPTION*/)
176 |    {
177 |       // convert to strings
178 |       args_.resize(static_cast<decltype(args_)::size_type>(argc));
179 |       std::transform(argv, argv + argc, args_.begin(), [](const char* const arg) { return arg;  });
180 | 
181 |       // parse line
182 |       for (auto i = 0u; i < args_.size(); ++i)
183 |       {
184 |          if (!is_option(args_[i]))
185 |          {
186 |             pos_args_.emplace_back(args_[i]);
187 |             continue;
188 |          }
189 | 
190 |          auto name = trim_leading_dashes(args_[i]);
191 | 
192 |          if (!(mode & NO_SPLIT_ON_EQUALSIGN))
193 |          {
194 |             auto equalPos = name.find('=');
195 |             if (equalPos != std::string::npos)
196 |             {
197 |                params_.emplace_back(name.substr(0, equalPos), name.substr(equalPos + 1));
198 |                continue;
199 |             }
200 |          }
201 | 
202 |          // if the option is unregistered and should be a multi-flag
203 |          if (1 == (args_[i].size() - name.size()) &&         // single dash
204 |             argh::parser::SINGLE_DASH_IS_MULTIFLAG & mode && // multi-flag mode
205 |             !is_param(name))                                  // unregistered
206 |          {
207 |             std::string keep_param;
208 | 
209 |             if (!name.empty() && is_param(std::string(1ul, name.back()))) // last char is param
210 |             {
211 |                keep_param += name.back();
212 |                name.resize(name.size() - 1);
213 |             }
214 | 
215 |             for (auto const& c : name)
216 |             {
217 |                flags_.emplace(std::string{ c });
218 |             }
219 | 
220 |             if (!keep_param.empty())
221 |             {
222 |                name = keep_param;
223 |             }
224 |             else
225 |             {
226 |                continue; // do not consider other options for this arg
227 |             }
228 |          }
229 | 
230 |          // any potential option will get as its value the next arg, unless that arg is an option too
231 |          // in that case it will be determined a flag.
232 |          if (i == args_.size() - 1 || is_option(args_[i + 1]))
233 |          {
234 |             flags_.emplace(name);
235 |             continue;
236 |          }
237 | 
238 |          // if 'name' is a pre-registered option, then the next arg cannot be a free parameter to it is skipped
239 |          // otherwise we have 2 modes:
240 |          // PREFER_FLAG_FOR_UNREG_OPTION: a non-registered 'name' is determined a flag.
241 |          //                               The following value (the next arg) will be a free parameter.
242 |          //
243 |          // PREFER_PARAM_FOR_UNREG_OPTION: a non-registered 'name' is determined a parameter, the next arg
244 |          //                                will be the value of that option.
245 | 
246 |          assert(!(mode & argh::parser::PREFER_FLAG_FOR_UNREG_OPTION)
247 |              || !(mode & argh::parser::PREFER_PARAM_FOR_UNREG_OPTION));
248 | 
249 |          bool preferParam = mode & argh::parser::PREFER_PARAM_FOR_UNREG_OPTION;
250 | 
251 |          if (is_param(name) || preferParam)
252 |          {
253 |             params_.emplace_back(name, args_[i + 1]);
254 |             ++i; // skip next value, it is not a free parameter
255 |             continue;
256 |          }
257 |          else
258 |          {
259 |             flags_.emplace(name);
260 |          }
261 |       }
262 |    }
263 | 
264 |    //////////////////////////////////////////////////////////////////////////
265 | 
266 |    inline string_stream parser::bad_stream() const
267 |    {
268 |       string_stream bad;
269 |       bad.setstate(std::ios_base::failbit);
270 |       return bad;
271 |    }
272 | 
273 |    //////////////////////////////////////////////////////////////////////////
274 | 
275 |    inline bool parser::is_number(std::string const& arg) const
276 |    {
277 |       // inefficient but simple way to determine if a string is a number (which can start with a '-')
278 |       std::istringstream istr(arg);
279 |       double number;
280 |       istr >> number;
281 |       return !(istr.fail() || istr.bad());
282 |    }
283 | 
284 |    //////////////////////////////////////////////////////////////////////////
285 | 
286 |    inline bool parser::is_option(std::string const& arg) const
287 |    {
288 |       assert(0 != arg.size());
289 |       if (is_number(arg))
290 |          return false;
291 |       return '-' == arg[0];
292 |    }
293 | 
294 |    //////////////////////////////////////////////////////////////////////////
295 | 
296 |    inline std::string parser::trim_leading_dashes(std::string const& name) const
297 |    {
298 |       auto pos = name.find_first_not_of('-');
299 |       return std::string::npos != pos ? name.substr(pos) : name;
300 |    }
301 | 
302 |    //////////////////////////////////////////////////////////////////////////
303 | 
304 |    inline bool argh::parser::got_flag(std::string const& name) const
305 |    {
306 |       return flags_.end() != flags_.find(trim_leading_dashes(name));
307 |    }
308 | 
309 |    //////////////////////////////////////////////////////////////////////////
310 | 
311 |    inline bool argh::parser::is_param(std::string const& name) const
312 |    {
313 |       return registeredParams_.count(name);
314 |    }
315 | 
316 |    //////////////////////////////////////////////////////////////////////////
317 | 
318 |    inline bool parser::operator[](std::string const& name) const
319 |    {
320 |       return got_flag(name);
321 |    }
322 | 
323 |    //////////////////////////////////////////////////////////////////////////
324 | 
325 |    inline bool parser::operator[](std::initializer_list<char const* const> init_list) const
326 |    {
327 |       return std::any_of(init_list.begin(), init_list.end(), [&](char const* const name) { return got_flag(name); });
328 |    }
329 | 
330 |    //////////////////////////////////////////////////////////////////////////
331 | 
332 |    inline std::string const& parser::operator[](size_t ind) const
333 |    {
334 |       if (ind < pos_args_.size())
335 |          return pos_args_[ind];
336 |       return empty_;
337 |    }
338 | 
339 |    //////////////////////////////////////////////////////////////////////////
340 | 
341 |    inline string_stream parser::operator()(std::string const& name) const
342 |    {
343 |        for (const auto& param : params_)
344 |            if (param.first == trim_leading_dashes(name))
345 |                return string_stream(param.second);
346 | 
347 |       return bad_stream();
348 |    }
349 | 
350 |    //////////////////////////////////////////////////////////////////////////
351 | 
352 |    inline string_stream parser::operator()(std::initializer_list<char const* const> init_list) const
353 |    {
354 |       for (auto& name : init_list)
355 |       {
356 |          for (const auto& param : params_)
357 |            if (param.first == trim_leading_dashes(name))
358 |                return string_stream(param.second);
359 |       }
360 |       return bad_stream();
361 |    }
362 | 
363 |    //////////////////////////////////////////////////////////////////////////
364 | 
365 |    template<typename T>
366 |    string_stream parser::operator()(std::string const& name, T&& def_val) const
367 |    {
368 |       for (const auto& param : params_)
369 |            if (param.first == trim_leading_dashes(name))
370 |                return string_stream(param.second);
371 | 
372 |       std::ostringstream ostr;
373 |       ostr.precision(std::numeric_limits<long double>::max_digits10);
374 |       ostr << def_val;
375 |       return string_stream(ostr.str()); // use default
376 |    }
377 | 
378 |    //////////////////////////////////////////////////////////////////////////
379 | 
380 |    // same as above but for a list of names. returns the first value to be found.
381 |    template<typename T>
382 |    string_stream parser::operator()(std::initializer_list<char const* const> init_list, T&& def_val) const
383 |    {
384 |       for (auto& name : init_list)
385 |       {
386 |          for (const auto& param : params_)
387 |            if (param.first == trim_leading_dashes(name))
388 |                return string_stream(param.second);
389 |       }
390 |       std::ostringstream ostr;
391 |       ostr.precision(std::numeric_limits<long double>::max_digits10);
392 |       ostr << def_val;
393 |       return string_stream(ostr.str()); // use default
394 |    }
395 | 
396 |    //////////////////////////////////////////////////////////////////////////
397 | 
398 |    inline string_stream parser::operator()(size_t ind) const
399 |    {
400 |       if (pos_args_.size() <= ind)
401 |          return bad_stream();
402 | 
403 |       return string_stream(pos_args_[ind]);
404 |    }
405 | 
406 |    //////////////////////////////////////////////////////////////////////////
407 | 
408 |    template<typename T>
409 |    string_stream parser::operator()(size_t ind, T&& def_val) const
410 |    {
411 |       if (pos_args_.size() <= ind)
412 |       {
413 |          std::ostringstream ostr;
414 |          ostr.precision(std::numeric_limits<long double>::max_digits10);
415 |          ostr << def_val;
416 |          return string_stream(ostr.str());
417 |       }
418 | 
419 |       return string_stream(pos_args_[ind]);
420 |    }
421 | 
422 |    //////////////////////////////////////////////////////////////////////////
423 | 
424 |    inline void parser::add_param(std::string const& name)
425 |    {
426 |       registeredParams_.insert(trim_leading_dashes(name));
427 |    }
428 | 
429 |    //////////////////////////////////////////////////////////////////////////
430 | 
431 |    inline void parser::add_params(std::initializer_list<char const* const> init_list)
432 |    {
433 |       for (auto& name : init_list)
434 |          registeredParams_.insert(trim_leading_dashes(name));
435 |    }
436 | }
437 | 


--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  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 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
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 <https://www.gnu.org/licenses/>.
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 |     <program>  Copyright (C) <year>  <name of author>
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 | <https://www.gnu.org/licenses/>.
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 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------