File: gmstcheck.cpp

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 (148 lines) | stat: -rw-r--r-- 5,380 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
#include "gmstcheck.hpp"

#include <sstream>
#include <stddef.h>

#include <apps/opencs/model/doc/messages.hpp>
#include <apps/opencs/model/prefs/category.hpp>
#include <apps/opencs/model/prefs/setting.hpp>
#include <apps/opencs/model/world/idcollection.hpp>
#include <apps/opencs/model/world/record.hpp>
#include <apps/opencs/model/world/universalid.hpp>

#include <components/esm3/loadgmst.hpp>

#include "../prefs/state.hpp"

#include "../world/defaultgmsts.hpp"

CSMTools::GmstCheckStage::GmstCheckStage(const CSMWorld::IdCollection<ESM::GameSetting>& gameSettings)
    : mGameSettings(gameSettings)
{
    mIgnoreBaseRecords = false;
}

int CSMTools::GmstCheckStage::setup()
{
    mIgnoreBaseRecords = CSMPrefs::get()["Reports"]["ignore-base-records"].isTrue();

    return mGameSettings.getSize();
}

void CSMTools::GmstCheckStage::perform(int stage, CSMDoc::Messages& messages)
{
    const CSMWorld::Record<ESM::GameSetting>& record = mGameSettings.getRecord(stage);

    // Skip "Base" records (setting!) and "Deleted" records
    if ((mIgnoreBaseRecords && record.mState == CSMWorld::RecordBase::State_BaseOnly) || record.isDeleted())
        return;

    const ESM::GameSetting& gmst = record.get();

    CSMWorld::UniversalId id(CSMWorld::UniversalId::Type_Gmst, gmst.mId);
    const std::string& gmstIdString = gmst.mId.getRefIdString();
    // Test for empty string
    if (gmst.mValue.getType() == ESM::VT_String && gmst.mValue.getString().empty())
        messages.add(id, gmstIdString + " is an empty string", "", CSMDoc::Message::Severity_Warning);

    // Checking type and limits
    // optimization - compare it to lists based on naming convention (f-float,i-int,s-string)
    if (gmst.mId.startsWith("f"))
    {
        for (size_t i = 0; i < CSMWorld::DefaultGmsts::FloatCount; ++i)
        {
            if (gmst.mId == ESM::RefId::stringRefId(CSMWorld::DefaultGmsts::Floats[i]))
            {
                if (gmst.mValue.getType() != ESM::VT_Float)
                {
                    std::ostringstream stream;
                    stream << "Expected float type for " << gmst.mId << " but found "
                           << varTypeToString(gmst.mValue.getType()) << " type";

                    messages.add(id, stream.str(), "", CSMDoc::Message::Severity_Error);
                }

                if (gmst.mValue.getFloat() < CSMWorld::DefaultGmsts::FloatLimits[i * 2])
                    messages.add(
                        id, gmstIdString + " is less than the suggested range", "", CSMDoc::Message::Severity_Warning);

                if (gmst.mValue.getFloat() > CSMWorld::DefaultGmsts::FloatLimits[i * 2 + 1])
                    messages.add(
                        id, gmstIdString + " is more than the suggested range", "", CSMDoc::Message::Severity_Warning);

                break; // for loop
            }
        }
    }
    else if (gmst.mId.startsWith("i"))
    {
        for (size_t i = 0; i < CSMWorld::DefaultGmsts::IntCount; ++i)
        {
            if (gmst.mId == ESM::RefId::stringRefId(CSMWorld::DefaultGmsts::Ints[i]))
            {
                if (gmst.mValue.getType() != ESM::VT_Int)
                {
                    std::ostringstream stream;
                    stream << "Expected int type for " << gmst.mId << " but found "
                           << varTypeToString(gmst.mValue.getType()) << " type";

                    messages.add(id, stream.str(), "", CSMDoc::Message::Severity_Error);
                }

                if (gmst.mValue.getInteger() < CSMWorld::DefaultGmsts::IntLimits[i * 2])
                    messages.add(
                        id, gmstIdString + " is less than the suggested range", "", CSMDoc::Message::Severity_Warning);

                if (gmst.mValue.getInteger() > CSMWorld::DefaultGmsts::IntLimits[i * 2 + 1])
                    messages.add(
                        id, gmstIdString + " is more than the suggested range", "", CSMDoc::Message::Severity_Warning);

                break; // for loop
            }
        }
    }
    else if (gmst.mId.startsWith("s"))
    {
        for (size_t i = 0; i < CSMWorld::DefaultGmsts::StringCount; ++i)
        {
            if (gmst.mId == ESM::RefId::stringRefId(CSMWorld::DefaultGmsts::Strings[i]))
            {
                ESM::VarType type = gmst.mValue.getType();

                if (type != ESM::VT_String && type != ESM::VT_None)
                {
                    std::ostringstream stream;
                    stream << "Expected string or none type for " << gmstIdString << " but found "
                           << varTypeToString(gmst.mValue.getType()) << " type";

                    messages.add(id, stream.str(), "", CSMDoc::Message::Severity_Error);
                }

                break; // for loop
            }
        }
    }
}

std::string CSMTools::GmstCheckStage::varTypeToString(ESM::VarType type)
{
    switch (type)
    {
        case ESM::VT_Unknown:
            return "unknown";
        case ESM::VT_None:
            return "none";
        case ESM::VT_Short:
            return "short";
        case ESM::VT_Int:
            return "int";
        case ESM::VT_Long:
            return "long";
        case ESM::VT_Float:
            return "float";
        case ESM::VT_String:
            return "string";
        default:
            return "unhandled";
    }
}