TextMap.hpp

Go to the documentation of this file.

/*
 *
 * ---
 *
 *  Copyright (C) 2023 Anselm Schmidt (ans[ät]ohai.su)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version in addition to the terms of any
 *  licences already herein identified.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 * ---
 *
 * TextMap.hpp
 *
 * Text map (entries) used to annotate parts of a corpus (e.g. to store the dates or articles contained in these parts).
 *
 *  Created on: Mar 4, 2020
 *      Author: ans
 */

#ifndef STRUCT_TEXTMAP_HPP_
#define STRUCT_TEXTMAP_HPP_

#include "../Helper/Memory.hpp"

#include <cstddef>  // std::size_t
#include <string>   // std::string
#include <utility>  // std::pair, std::swap
#include <vector>   // std::vector

namespace crawlservpp::Struct {


    struct TextMapEntry {


        std::size_t p{};

        std::size_t l{};


        std::string value;


        TextMapEntry() = default;


        TextMapEntry(
                std::size_t setPos,
                std::size_t setLength
        ) : p(setPos), l(setLength) {}


        TextMapEntry(
                std::size_t setPos,
                std::size_t setLength,
                const std::string& setValue
        ) : p(setPos), l(setLength), value(setValue) {}



        void swap(TextMapEntry& other) {
            std::swap(*this, other);
        }


        void free() {
            this->p = 0;
            this->l = 0;

            Helper::Memory::free(this->value);
        }
        
        

        [[nodiscard]] std::string str() const {
                std::string result{"pos="};
                
                result += std::to_string(this->p);
                result += "; length=";
                result += std::to_string(this->l);
                result += "; value=\"";
                result += this->value;
                result += "\"";
                
                return result;
        }



        static std::size_t& pos(TextMapEntry& entry) {
            return entry.p;
        }


        static std::size_t& pos(std::pair<std::size_t, std::size_t>& entry) {
            return entry.first;
        }


        static std::size_t pos(const TextMapEntry& entry) {
            return entry.p;
        }


        static std::size_t pos(const std::pair<std::size_t, std::size_t>& entry) {
            return entry.first;
        }


        template<typename T> static std::size_t end(const T& entry) {
            return TextMapEntry::pos(entry) + TextMapEntry::length(entry);
        }


        static std::size_t& length(TextMapEntry& entry) {
            return entry.l;
        }


        static std::size_t& length(std::pair<std::size_t, std::size_t>& entry) {
            return entry.second;
        }


        static std::size_t length(const TextMapEntry& entry) {
            return entry.l;
        }


        static std::size_t length(const std::pair<std::size_t, std::size_t>& entry) {
            return entry.second;
        }

    };

    using TextMap = std::vector<TextMapEntry>;

} /* namespace crawlservpp::Struct */

#endif /* STRUCT_TEXTMAP_HPP_ */