File: esmcommon.hpp

package info (click to toggle)
openmw 0.49.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,992 kB
  • sloc: cpp: 372,479; xml: 2,149; sh: 1,403; python: 797; makefile: 26
file content (207 lines) | stat: -rw-r--r-- 6,771 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
#ifndef OPENMW_ESM_COMMON_H
#define OPENMW_ESM_COMMON_H

#include <cassert>
#include <cstdint>
#include <cstring>
#include <filesystem>
#include <limits>
#include <string>
#include <string_view>
#include <type_traits>
#include <vector>

namespace ESM
{
    enum RecordFlag
    {
        // This flag exists, but is not used to determine if a record has been deleted while loading
        FLAG_Deleted = 0x00000020,
        FLAG_Persistent = 0x00000400,
        FLAG_Ignored = 0x00001000,
        FLAG_Blocked = 0x00002000
    };

    using StringSizeType = std::uint32_t;

    template <std::size_t capacity>
    struct FixedString
    {
        static_assert(capacity > 0);

        static constexpr std::size_t sCapacity = capacity;

        char mData[capacity];

        FixedString() = default;

        template <std::size_t size>
        constexpr FixedString(const char (&value)[size]) noexcept
            : mData()
        {
            if constexpr (capacity == sizeof(std::uint32_t))
            {
                static_assert(capacity == size || capacity + 1 == size);
                if constexpr (capacity + 1 == size)
                    assert(value[capacity] == '\0');
                for (std::size_t i = 0; i < capacity; ++i)
                    mData[i] = value[i];
            }
            else
            {
                const std::size_t length = std::min(capacity, size);
                for (std::size_t i = 0; i < length; ++i)
                    mData[i] = value[i];
                mData[std::min(capacity - 1, length)] = '\0';
            }
        }

        constexpr explicit FixedString(std::uint32_t value) noexcept
            : mData()
        {
            static_assert(capacity == sizeof(std::uint32_t));
            for (std::size_t i = 0; i < capacity; ++i)
                mData[i] = static_cast<char>((value >> (i * std::numeric_limits<std::uint8_t>::digits))
                    & std::numeric_limits<std::uint8_t>::max());
        }

        template <class T>
        constexpr explicit FixedString(T value) noexcept
            : FixedString(static_cast<std::uint32_t>(value))
        {
        }

        std::string_view toStringView() const noexcept { return std::string_view(mData, strnlen(mData, capacity)); }

        std::string toString() const { return std::string(toStringView()); }

        std::uint32_t toInt() const noexcept
        {
            static_assert(capacity == sizeof(std::uint32_t));
            std::uint32_t value;
            std::memcpy(&value, mData, capacity);
            return value;
        }

        void clear() noexcept { std::memset(mData, 0, capacity); }

        void assign(std::string_view value) noexcept
        {
            if (value.empty())
            {
                clear();
                return;
            }

            if (value.size() < capacity)
            {
                if constexpr (capacity == sizeof(std::uint32_t))
                    std::memset(mData, 0, capacity);
                std::memcpy(mData, value.data(), value.size());
                if constexpr (capacity != sizeof(std::uint32_t))
                    mData[value.size()] = '\0';
                return;
            }

            std::memcpy(mData, value.data(), capacity);

            if constexpr (capacity != sizeof(std::uint32_t))
                mData[capacity - 1] = '\0';
        }

        FixedString& operator=(std::uint32_t value) noexcept
        {
            static_assert(capacity == sizeof(value));
            std::memcpy(&mData, &value, capacity);
            return *this;
        }
    };

    template <std::size_t capacity>
    inline bool operator==(const FixedString<capacity>& lhs, std::string_view rhs) noexcept
    {
        for (std::size_t i = 0, n = std::min(rhs.size(), capacity); i < n; ++i)
        {
            if (lhs.mData[i] != rhs[i])
                return false;
            if (lhs.mData[i] == '\0')
                return true;
        }
        return rhs.size() <= capacity || rhs[capacity] == '\0';
    }

    template <std::size_t capacity, class T, typename = std::enable_if_t<std::is_same_v<T, char>>>
    inline bool operator==(const FixedString<capacity>& lhs, const T* const& rhs) noexcept
    {
        return lhs == std::string_view(rhs, capacity);
    }

    template <std::size_t capacity, std::size_t rhsSize>
    inline bool operator==(const FixedString<capacity>& lhs, const char (&rhs)[rhsSize]) noexcept
    {
        return strnlen(rhs, rhsSize) == strnlen(lhs.mData, capacity) && std::strncmp(lhs.mData, rhs, capacity) == 0;
    }

    inline bool operator==(const FixedString<4>& lhs, std::uint32_t rhs) noexcept
    {
        return lhs.toInt() == rhs;
    }

    inline bool operator==(const FixedString<4>& lhs, const FixedString<4>& rhs) noexcept
    {
        return lhs.toInt() == rhs.toInt();
    }

    template <class T, typename = std::enable_if_t<std::is_same_v<T, char>>>
    inline bool operator==(const FixedString<4>& lhs, const T* const& rhs) noexcept
    {
        return lhs == std::string_view(rhs, 5);
    }

    template <std::size_t capacity, class Rhs>
    inline bool operator!=(const FixedString<capacity>& lhs, const Rhs& rhs) noexcept
    {
        return !(lhs == rhs);
    }

    using NAME = FixedString<4>;
    using NAME32 = FixedString<32>;
    using NAME64 = FixedString<64>;

    static_assert(std::is_standard_layout_v<NAME> && std::is_trivial_v<NAME>);
    static_assert(std::is_standard_layout_v<NAME32> && std::is_trivial_v<NAME32>);
    static_assert(std::is_standard_layout_v<NAME64> && std::is_trivial_v<NAME64>);

    static_assert(sizeof(NAME) == 4);
    static_assert(sizeof(NAME32) == 32);
    static_assert(sizeof(NAME64) == 64);

    /* This struct defines a file 'context' which can be saved and later
       restored by an ESMReader instance. It will save the position within
       a file, and when restored will let you read from that position as
       if you never left it.
     */
    struct ESM_Context
    {
        std::filesystem::path filename;
        std::streamsize leftRec;
        std::uint32_t leftSub;
        std::streamsize leftFile;
        NAME recName, subName;
        // When working with multiple esX files, we will generate lists of all files that
        //  actually contribute to a specific cell. Therefore, we need to store the index
        //  of the file belonging to this contest. See CellStore::(list/load)refs for details.
        int index;
        std::vector<int> parentFileIndices;

        // True if subName has been read but not used.
        bool subCached;

        // File position. Only used for stored contexts, not regularly
        // updated within the reader itself.
        size_t filePos;
    };

}

#endif