summaryrefslogtreecommitdiff
path: root/test/text/glyph_atlas.test.cpp
blob: fe27e4c6fe859ce28f1d9c4c3c3eb3794b6f7e61 (plain)
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
#include <mbgl/test/util.hpp>
#include <mbgl/test/stub_file_source.hpp>
#include <mbgl/test/stub_style_observer.hpp>

#include <mbgl/text/glyph_set.hpp>
#include <mbgl/text/glyph_atlas.hpp>
#include <mbgl/util/run_loop.hpp>
#include <mbgl/util/string.hpp>
#include <mbgl/util/io.hpp>
#include <mbgl/util/logging.hpp>

using namespace mbgl;

class GlyphAtlasTest : public GlyphRequestor {
public:
    util::RunLoop loop;
    StubFileSource fileSource;
    StubStyleObserver observer;
    GlyphAtlas glyphAtlas{ { 32, 32 }, fileSource };
    GlyphPositionMap glyphPositions;
    GlyphRangeSet loadedRanges;

    void run(const std::string& url, const FontStack& fontStack, const GlyphRangeSet& glyphRanges) {
        // Squelch logging.
        Log::setObserver(std::make_unique<Log::NullObserver>());

        glyphAtlas.setObserver(&observer);
        glyphAtlas.setURL(url);
        GlyphDependencies glyphDependencies;
        for (const auto& range : glyphRanges) {
            glyphDependencies[fontStack].insert(range.first);
        }
        glyphAtlas.getGlyphs(*this, glyphDependencies);
        glyphAtlas.hasGlyphRanges(fontStack, glyphRanges);

        loop.run();
    }
    void addGlyphs(GlyphRequestor& requestor, const GlyphDependencies& glyphDependencies) {
        glyphAtlas.addGlyphs(requestor, glyphDependencies);
    }
    
    bool hasGlyphRanges(const FontStack& fontStack, const GlyphRangeSet& ranges) const {
        return glyphAtlas.hasGlyphRanges(fontStack, ranges);
    }

    void end() {
        loop.stop();
    }
    
    virtual void onGlyphsAvailable(GlyphPositionMap positions, GlyphRangeSet _loadedRanges) {
        glyphPositions = std::move(positions);
        loadedRanges = std::move(_loadedRanges);
    }
};

TEST(GlyphAtlas, LoadingSuccess) {
    GlyphAtlasTest test;

    test.fileSource.glyphsResponse = [&] (const Resource& resource) {
        EXPECT_EQ(Resource::Kind::Glyphs, resource.kind);
        Response response;
        response.data = std::make_shared<std::string>(util::read_file("test/fixtures/resources/glyphs.pbf"));
        return response;
    };

    test.observer.glyphsError = [&] (const FontStack&, const GlyphRange&, std::exception_ptr) {
        FAIL();
        test.end();
    };

    test.observer.glyphsLoaded = [&] (const FontStack&, const GlyphRange&) {
        if (!test.hasGlyphRanges({{"Test Stack"}}, {{0, 255}, {256, 511}}))
            return;

        auto& glyphSet = test.glyphAtlas.getGlyphSet({{"Test Stack"}});
        ASSERT_FALSE(glyphSet.getSDFs().empty());

        test.end();
    };

    test.run(
        "test/fixtures/resources/glyphs.pbf",
        {{"Test Stack"}},
        {{0, 255}, {256, 511}});
}

TEST(GlyphAtlas, LoadingFail) {
    GlyphAtlasTest test;

    test.fileSource.glyphsResponse = [&] (const Resource&) {
        Response response;
        response.error = std::make_unique<Response::Error>(
            Response::Error::Reason::Other,
            "Failed by the test case");
        return response;
    };

    test.observer.glyphsError = [&] (const FontStack& fontStack, const GlyphRange& glyphRange, std::exception_ptr error) {
        EXPECT_EQ(fontStack, FontStack({"Test Stack"}));
        EXPECT_EQ(glyphRange, GlyphRange(0, 255));

        EXPECT_TRUE(error != nullptr);
        EXPECT_EQ(util::toString(error), "Failed by the test case");

        ASSERT_TRUE(test.glyphAtlas.getGlyphSet({{"Test Stack"}}).getSDFs().empty());
        ASSERT_FALSE(test.hasGlyphRanges({{"Test Stack"}}, {{0, 255}}));

        test.end();
    };

    test.run(
        "test/fixtures/resources/glyphs.pbf",
        {{"Test Stack"}},
        {{0, 255}});
}

TEST(GlyphAtlas, LoadingCorrupted) {
    GlyphAtlasTest test;

    test.fileSource.glyphsResponse = [&] (const Resource&) {
        Response response;
        response.data = std::make_unique<std::string>("CORRUPTED");
        return response;
    };

    test.observer.glyphsError = [&] (const FontStack& fontStack, const GlyphRange& glyphRange, std::exception_ptr error) {
        EXPECT_EQ(fontStack, FontStack({"Test Stack"}));
        EXPECT_EQ(glyphRange, GlyphRange(0, 255));

        EXPECT_TRUE(error != nullptr);
        EXPECT_EQ(util::toString(error), "unknown pbf field type exception");

        ASSERT_TRUE(test.glyphAtlas.getGlyphSet({{"Test Stack"}}).getSDFs().empty());
        ASSERT_FALSE(test.hasGlyphRanges({{"Test Stack"}}, {{0, 255}}));

        test.end();
    };

    test.run(
        "test/fixtures/resources/glyphs.pbf",
        {{"Test Stack"}},
        {{0, 255}});
}

TEST(GlyphAtlas, LoadingCancel) {
    GlyphAtlasTest test;

    test.fileSource.glyphsResponse = [&] (const Resource&) {
        test.end();
        return optional<Response>();
    };

    test.observer.glyphsLoaded = [&] (const FontStack&, const GlyphRange&) {
        FAIL() << "Should never be called";
    };

    test.run(
        "test/fixtures/resources/glyphs.pbf",
        {{"Test Stack"}},
        {{0, 255}});
}

TEST(GlyphAtlas, InvalidSDFGlyph) {
    const FontStack fontStack{ "Mock Font" };

    GlyphAtlasTest test;

    auto& glyphSet = test.glyphAtlas.getGlyphSet(fontStack);
    glyphSet.insert(66, SDFGlyph{ 66 /* ASCII 'B' */,
                                  AlphaImage({7, 7}), /* correct */
                                  { 1 /* width */, 1 /* height */, 0 /* left */, 0 /* top */,
                                    0 /* advance */ } });
    glyphSet.insert(67, SDFGlyph{ 67 /* ASCII 'C' */,
                                  AlphaImage({518, 8}), /* correct */
                                  { 512 /* width */, 2 /* height */, 0 /* left */, 0 /* top */,
                                    0 /* advance */ } });

    GlyphDependencies glyphDependencies = {{fontStack, {'A','B','C'}}};
    test.addGlyphs(test, glyphDependencies);
    GlyphPositions positions = test.glyphPositions[fontStack];

    ASSERT_EQ(2u, positions.size());

    // 'A' was not placed because not in the glyph set.
    ASSERT_EQ(positions.end(), positions.find(65));

    // 'B' was placed at the top left.
    ASSERT_NE(positions.end(), positions.find(66));
    // Width is 12 because actual dimensions are 1+6 pixels, with 1px border added, rounded up to
    // the next multiple of 4.
    ASSERT_EQ((Rect<uint16_t>{ 0, 0, 12, 12 }), positions[66].rect);

    // 'C' was not placed because the width is too big.
    ASSERT_NE(positions.end(), positions.find(67));
    ASSERT_EQ((Rect<uint16_t>{ 0, 0, 0, 0 }), positions[67].rect);

}