flatcc 24.3.25

Build-time convenience utilities for flatbuffers
Documentation 
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254

# Copyright 2022 Google Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from flatc_test import *


class CppTests:
    def Flatten(self):
        # Generate just foo with a "flatten" import of bar.
        flatc(["--cpp", "foo.fbs"])

        # Foo should be generated in place and include bar flatten
        assert_file_and_contents("foo_generated.h", '#include "bar_generated.h"')

    def FlattenAbsolutePath(self):
        # Generate just foo with a "flatten" import of bar.
        flatc(["--cpp", make_absolute("foo.fbs")])

        # Foo should be generated in place and include bar flatten
        assert_file_and_contents("foo_generated.h", '#include "bar_generated.h"')

    def FlattenSubDirectory(self):
        # Generate just foo with a "flatten" import of bar.
        flatc(["--cpp", "bar/bar.fbs"])

        # Bar should be generated in place and include baz
        assert_file_and_contents("bar_generated.h", '#include "baz_generated.h"')

    def FlattenOutPath(self):
        # Generate just foo with a "flatten" import of bar.
        flatc(["--cpp", "-o", ".tmp", "foo.fbs"])

        # Foo should be generated in the out path and include bar flatten to the out path.
        assert_file_and_contents(".tmp/foo_generated.h", '#include "bar_generated.h"')

    def FlattenOutPathSuperDirectory(self):
        # Generate just foo with a "flatten" import of bar.
        flatc(["--cpp", "-o", "../.tmp", "foo.fbs"])

        # Foo should be generated in the out path and include bar flatten to the out path.
        assert_file_and_contents(
            "../.tmp/foo_generated.h", '#include "bar_generated.h"'
        )

    def FlattenOutPathSubDirectory(self):
        # Generate just foo with a "flatten" import of bar.
        flatc(["--cpp", "-o", ".tmp", "bar/bar.fbs"])

        # Bar should be generated in the out path and include baz flatten to the out path.
        assert_file_and_contents(".tmp/bar_generated.h", '#include "baz_generated.h"')

    def KeepPrefix(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--keep-prefix", "foo.fbs"])

        assert_file_and_contents("foo_generated.h", '#include "bar/bar_generated.h"')

    def KeepPrefixAbsolutePath(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--keep-prefix", make_absolute("foo.fbs")])

        assert_file_and_contents("foo_generated.h", '#include "bar/bar_generated.h"')

    def KeepPrefixSubDirectory(self):
        # Generate with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--keep-prefix", "bar/bar.fbs"])

        assert_file_and_contents("bar_generated.h", '#include "baz/baz_generated.h"')

    def KeepPrefixOutPath(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--keep-prefix", "-o", ".tmp", "foo.fbs"])

        assert_file_and_contents(
            ".tmp/foo_generated.h",
            '#include "bar/bar_generated.h"',
        )

    def KeepPrefixOutPathSubDirectory(self):
        # Generate with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--keep-prefix", "-o", ".tmp", "bar/bar.fbs"])

        assert_file_and_contents(
            ".tmp/bar_generated.h", '#include "baz/baz_generated.h"'
        )

    def IncludePrefix(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--include-prefix", "test", "foo.fbs"])

        assert_file_and_contents("foo_generated.h", '#include "test/bar_generated.h"')

    def IncludePrefixAbolutePath(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--include-prefix", "test", make_absolute("foo.fbs")])

        assert_file_and_contents("foo_generated.h", '#include "test/bar_generated.h"')

    def IncludePrefixSubDirectory(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--include-prefix", "test", "bar/bar.fbs"])

        assert_file_and_contents("bar_generated.h", '#include "test/baz_generated.h"')

    def IncludePrefixOutPath(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--include-prefix", "test", "-o", ".tmp", "foo.fbs"])

        assert_file_and_contents(
            ".tmp/foo_generated.h", '#include "test/bar_generated.h"'
        )

    def IncludePrefixOutPathSubDirectory(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--include-prefix", "test", "-o", ".tmp", "bar/bar.fbs"])

        assert_file_and_contents(
            ".tmp/bar_generated.h", '#include "test/baz_generated.h"'
        )

    def KeepPrefixIncludePrefix(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--keep-prefix", "--include-prefix", "test", "foo.fbs"])

        # The include prefix should come first, with the kept prefix next.
        assert_file_and_contents(
            "foo_generated.h", '#include "test/bar/bar_generated.h"'
        )

    def KeepPrefixIncludePrefixAbsolutePath(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(
            [
                "--cpp",
                "--keep-prefix",
                "--include-prefix",
                "test",
                make_absolute("foo.fbs"),
            ]
        )

        # The include prefix should come first, with the kept prefix next.
        assert_file_and_contents(
            "foo_generated.h", '#include "test/bar/bar_generated.h"'
        )

    def KeepPrefixIncludePrefixSubDirectory(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(["--cpp", "--keep-prefix", "--include-prefix", "test", "bar/bar.fbs"])

        # The include prefix should come first, with the kept prefix next.
        assert_file_and_contents(
            "bar_generated.h", '#include "test/baz/baz_generated.h"'
        )

    def KeepPrefixIncludePrefixOutPathSubDirectory(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(
            [
                "--cpp",
                "--keep-prefix",
                "--include-prefix",
                "test",
                "-o",
                ".tmp",
                "bar/bar.fbs",
            ]
        )

        # The include prefix should come first, with the kept prefix next.
        assert_file_and_contents(
            ".tmp/bar_generated.h", '#include "test/baz/baz_generated.h"'
        )

    def KeepPrefixIncludePrefixOutPathSuperDirectory(self):
        # Generate just foo with the import of bar keeping the prefix of where it is located.
        flatc(
            [
                "--cpp",
                "--keep-prefix",
                "--include-prefix",
                "test",
                "-o",
                "../.tmp",
                "bar/bar.fbs",
            ]
        )

        # The include prefix should come first, with the kept prefix next.
        assert_file_and_contents(
            "../.tmp/bar_generated.h", '#include "test/baz/baz_generated.h"'
        )

    def KeepPrefixIncludePrefixoutPathAbsoluePaths_SuperDirectoryReference(self):
        # Generate bar_with_foo that references a type in a super directory.
        flatc(
            [
                "--cpp",
                "--keep-prefix",
                "--include-prefix",
                "generated",
                "-I",
                str(script_path.absolute()),
                "-o",
                str(Path(script_path, ".tmp").absolute()),
                str(Path(script_path, "bar/bar_with_foo.fbs").absolute()),
            ]
        )

        # The include prefix should come first, with the kept prefix next.
        assert_file_and_contents(
            ".tmp/bar_with_foo_generated.h",
            [
                '#include "generated/baz/baz_generated.h"',
                '#include "generated/foo_generated.h"',
            ],
        )

    def KeepPrefixIncludePrefixoutPath_SuperDirectoryReference(self):
        # Generate bar_with_foo that references a type in a super directory.
        flatc(
            [
                "--cpp",
                "--keep-prefix",
                "--include-prefix",
                "generated",
                "-I",
                "./",
                "-o",
                ".tmp",
                "bar/bar_with_foo.fbs",
            ]
        )

        # The include prefix should come first, with the kept prefix next.
        assert_file_and_contents(
            ".tmp/bar_with_foo_generated.h",
            [
                '#include "generated/baz/baz_generated.h"',
                '#include "generated/foo_generated.h"',
            ],
            unlink=False,
        )