Skip to content

Commit 8891264

Browse files
dnfieldaardappel
dnfield
authored and
aardappel
committed
Add [Dart] support (google#4676)
* Add [Dart] support * fix enum vectors * Allow for opt out of string interning * fix comment style, make interning opt in * remove Offset<T>, prefer int * avoid creating unnecessary vtable objects * start work on tests - do not generate builder if struct has 0 fields - add int64 * support reading structs properly * correctly handle reading vectors of structs, dartfmt * support structs, fix unnecessary prepares * fix bool customizations * undo unintentional removal of file * docs updates, complete tutorial, bug fix for codegen * more documentation * Update docs, add to doxygen file * update package structure, add samples script/code * rearrange sample * Tests * Add readme for pub * cleanup package for pub * update docs for renamed file * remove custom matcher, use `closeTo` instead * remove unintentional file * remove unintended file checkin * use auto, move method, cleanup * refactor to ObjectBuilders, add Builders * Update tests, examples * Add files missing from previous commit * documentation and example updates * Update LICENSE, make dartanalyzer happy, fix minor bugs, get rid of duplicate files, publish script * fix sample for slightly different schema * Update pubspec.yaml
1 parent c43a0be commit 8891264

27 files changed

+5547
-20
lines changed

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ grpctest
4545
grpctest.exe
4646
snapshot.sh
4747
tags
48+
tests/dart_gen
4849
tests/go_gen
4950
tests/monsterdata_java_wire.mon
5051
tests/monsterdata_java_wire_sp.mon
@@ -94,3 +95,9 @@ js/flatbuffers.mjs
9495
build.ninja
9596
rules.ninja
9697
.vscode
98+
dart/.pub/
99+
dart/.packages
100+
dart/pubspec.lock
101+
dart/.dart_tool/
102+
dart/build/
103+
dart/doc/api/

‎BUILD

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ cc_binary(
8686
"grpc/src/compiler/schema_interface.h",
8787
"src/flatc_main.cpp",
8888
"src/idl_gen_cpp.cpp",
89+
"src/idl_gen_dart.cpp",
8990
"src/idl_gen_general.cpp",
9091
"src/idl_gen_go.cpp",
9192
"src/idl_gen_grpc.cpp",

‎CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ set(FlatBuffers_Library_SRCS
4545
set(FlatBuffers_Compiler_SRCS
4646
${FlatBuffers_Library_SRCS}
4747
src/idl_gen_cpp.cpp
48+
src/idl_gen_dart.cpp
4849
src/idl_gen_general.cpp
4950
src/idl_gen_go.cpp
5051
src/idl_gen_js.cpp

‎dart/LICENSE

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,233 @@
1+
The code in lib/flat_buffers.dart is based on code that was releases under the
2+
following license:
3+
4+
Copyright 2012, the Dart project authors. All rights reserved.
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are
7+
met:
8+
* Redistributions of source code must retain the above copyright
9+
notice, this list of conditions and the following disclaimer.
10+
* Redistributions in binary form must reproduce the above
11+
copyright notice, this list of conditions and the following
12+
disclaimer in the documentation and/or other materials provided
13+
with the distribution.
14+
* Neither the name of Google Inc. nor the names of its
15+
contributors may be used to endorse or promote products derived
16+
from this software without specific prior written permission.
17+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28+
29+
To the extent permissible, the changes to that code and the other assets in
30+
this package are licensed under the Apache2 license:
31+
32+
33+
Apache License
34+
Version 2.0, January 2004
35+
http://www.apache.org/licenses/
36+
37+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
38+
39+
1. Definitions.
40+
41+
"License" shall mean the terms and conditions for use, reproduction,
42+
and distribution as defined by Sections 1 through 9 of this document.
43+
44+
"Licensor" shall mean the copyright owner or entity authorized by
45+
the copyright owner that is granting the License.
46+
47+
"Legal Entity" shall mean the union of the acting entity and all
48+
other entities that control, are controlled by, or are under common
49+
control with that entity. For the purposes of this definition,
50+
"control" means (i) the power, direct or indirect, to cause the
51+
direction or management of such entity, whether by contract or
52+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
53+
outstanding shares, or (iii) beneficial ownership of such entity.
54+
55+
"You" (or "Your") shall mean an individual or Legal Entity
56+
exercising permissions granted by this License.
57+
58+
"Source" form shall mean the preferred form for making modifications,
59+
including but not limited to software source code, documentation
60+
source, and configuration files.
61+
62+
"Object" form shall mean any form resulting from mechanical
63+
transformation or translation of a Source form, including but
64+
not limited to compiled object code, generated documentation,
65+
and conversions to other media types.
66+
67+
"Work" shall mean the work of authorship, whether in Source or
68+
Object form, made available under the License, as indicated by a
69+
copyright notice that is included in or attached to the work
70+
(an example is provided in the Appendix below).
71+
72+
"Derivative Works" shall mean any work, whether in Source or Object
73+
form, that is based on (or derived from) the Work and for which the
74+
editorial revisions, annotations, elaborations, or other modifications
75+
represent, as a whole, an original work of authorship. For the purposes
76+
of this License, Derivative Works shall not include works that remain
77+
separable from, or merely link (or bind by name) to the interfaces of,
78+
the Work and Derivative Works thereof.
79+
80+
"Contribution" shall mean any work of authorship, including
81+
the original version of the Work and any modifications or additions
82+
to that Work or Derivative Works thereof, that is intentionally
83+
submitted to Licensor for inclusion in the Work by the copyright owner
84+
or by an individual or Legal Entity authorized to submit on behalf of
85+
the copyright owner. For the purposes of this definition, "submitted"
86+
means any form of electronic, verbal, or written communication sent
87+
to the Licensor or its representatives, including but not limited to
88+
communication on electronic mailing lists, source code control systems,
89+
and issue tracking systems that are managed by, or on behalf of, the
90+
Licensor for the purpose of discussing and improving the Work, but
91+
excluding communication that is conspicuously marked or otherwise
92+
designated in writing by the copyright owner as "Not a Contribution."
93+
94+
"Contributor" shall mean Licensor and any individual or Legal Entity
95+
on behalf of whom a Contribution has been received by Licensor and
96+
subsequently incorporated within the Work.
97+
98+
2. Grant of Copyright License. Subject to the terms and conditions of
99+
this License, each Contributor hereby grants to You a perpetual,
100+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
101+
copyright license to reproduce, prepare Derivative Works of,
102+
publicly display, publicly perform, sublicense, and distribute the
103+
Work and such Derivative Works in Source or Object form.
104+
105+
3. Grant of Patent License. Subject to the terms and conditions of
106+
this License, each Contributor hereby grants to You a perpetual,
107+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
108+
(except as stated in this section) patent license to make, have made,
109+
use, offer to sell, sell, import, and otherwise transfer the Work,
110+
where such license applies only to those patent claims licensable
111+
by such Contributor that are necessarily infringed by their
112+
Contribution(s) alone or by combination of their Contribution(s)
113+
with the Work to which such Contribution(s) was submitted. If You
114+
institute patent litigation against any entity (including a
115+
cross-claim or counterclaim in a lawsuit) alleging that the Work
116+
or a Contribution incorporated within the Work constitutes direct
117+
or contributory patent infringement, then any patent licenses
118+
granted to You under this License for that Work shall terminate
119+
as of the date such litigation is filed.
120+
121+
4. Redistribution. You may reproduce and distribute copies of the
122+
Work or Derivative Works thereof in any medium, with or without
123+
modifications, and in Source or Object form, provided that You
124+
meet the following conditions:
125+
126+
(a) You must give any other recipients of the Work or
127+
Derivative Works a copy of this License; and
128+
129+
(b) You must cause any modified files to carry prominent notices
130+
stating that You changed the files; and
131+
132+
(c) You must retain, in the Source form of any Derivative Works
133+
that You distribute, all copyright, patent, trademark, and
134+
attribution notices from the Source form of the Work,
135+
excluding those notices that do not pertain to any part of
136+
the Derivative Works; and
137+
138+
(d) If the Work includes a "NOTICE" text file as part of its
139+
distribution, then any Derivative Works that You distribute must
140+
include a readable copy of the attribution notices contained
141+
within such NOTICE file, excluding those notices that do not
142+
pertain to any part of the Derivative Works, in at least one
143+
of the following places: within a NOTICE text file distributed
144+
as part of the Derivative Works; within the Source form or
145+
documentation, if provided along with the Derivative Works; or,
146+
within a display generated by the Derivative Works, if and
147+
wherever such third-party notices normally appear. The contents
148+
of the NOTICE file are for informational purposes only and
149+
do not modify the License. You may add Your own attribution
150+
notices within Derivative Works that You distribute, alongside
151+
or as an addendum to the NOTICE text from the Work, provided
152+
that such additional attribution notices cannot be construed
153+
as modifying the License.
154+
155+
You may add Your own copyright statement to Your modifications and
156+
may provide additional or different license terms and conditions
157+
for use, reproduction, or distribution of Your modifications, or
158+
for any such Derivative Works as a whole, provided Your use,
159+
reproduction, and distribution of the Work otherwise complies with
160+
the conditions stated in this License.
161+
162+
5. Submission of Contributions. Unless You explicitly state otherwise,
163+
any Contribution intentionally submitted for inclusion in the Work
164+
by You to the Licensor shall be under the terms and conditions of
165+
this License, without any additional terms or conditions.
166+
Notwithstanding the above, nothing herein shall supersede or modify
167+
the terms of any separate license agreement you may have executed
168+
with Licensor regarding such Contributions.
169+
170+
6. Trademarks. This License does not grant permission to use the trade
171+
names, trademarks, service marks, or product names of the Licensor,
172+
except as required for reasonable and customary use in describing the
173+
origin of the Work and reproducing the content of the NOTICE file.
174+
175+
7. Disclaimer of Warranty. Unless required by applicable law or
176+
agreed to in writing, Licensor provides the Work (and each
177+
Contributor provides its Contributions) on an "AS IS" BASIS,
178+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
179+
implied, including, without limitation, any warranties or conditions
180+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
181+
PARTICULAR PURPOSE. You are solely responsible for determining the
182+
appropriateness of using or redistributing the Work and assume any
183+
risks associated with Your exercise of permissions under this License.
184+
185+
8. Limitation of Liability. In no event and under no legal theory,
186+
whether in tort (including negligence), contract, or otherwise,
187+
unless required by applicable law (such as deliberate and grossly
188+
negligent acts) or agreed to in writing, shall any Contributor be
189+
liable to You for damages, including any direct, indirect, special,
190+
incidental, or consequential damages of any character arising as a
191+
result of this License or out of the use or inability to use the
192+
Work (including but not limited to damages for loss of goodwill,
193+
work stoppage, computer failure or malfunction, or any and all
194+
other commercial damages or losses), even if such Contributor
195+
has been advised of the possibility of such damages.
196+
197+
9. Accepting Warranty or Additional Liability. While redistributing
198+
the Work or Derivative Works thereof, You may choose to offer,
199+
and charge a fee for, acceptance of support, warranty, indemnity,
200+
or other liability obligations and/or rights consistent with this
201+
License. However, in accepting such obligations, You may act only
202+
on Your own behalf and on Your sole responsibility, not on behalf
203+
of any other Contributor, and only if You agree to indemnify,
204+
defend, and hold each Contributor harmless for any liability
205+
incurred by, or claims asserted against, such Contributor by reason
206+
of your accepting any such warranty or additional liability.
207+
208+
END OF TERMS AND CONDITIONS
209+
210+
APPENDIX: How to apply the Apache License to your work.
211+
212+
To apply the Apache License to your work, attach the following
213+
boilerplate notice, with the fields enclosed by brackets "[]"
214+
replaced with your own identifying information. (Don't include
215+
the brackets!) The text should be enclosed in the appropriate
216+
comment syntax for the file format. We also recommend that a
217+
file or class name and description of purpose be included on the
218+
same "printed page" as the copyright notice for easier
219+
identification within third-party archives.
220+
221+
Copyright 2014 Google Inc.
222+
223+
Licensed under the Apache License, Version 2.0 (the "License");
224+
you may not use this file except in compliance with the License.
225+
You may obtain a copy of the License at
226+
227+
http://www.apache.org/licenses/LICENSE-2.0
228+
229+
Unless required by applicable law or agreed to in writing, software
230+
distributed under the License is distributed on an "AS IS" BASIS,
231+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
232+
See the License for the specific language governing permissions and
233+
limitations under the License.

‎dart/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# FlatBuffers for Dart
2+
3+
This package is used to read and write FlatBuffer files in Dart.
4+
5+
Most consumers will want to use the [`flatc`](https://github.com/google/flatbuffers)
6+
compiler to generate Dart code from a FlatBuffers IDL schema. For example, the
7+
`monster_my_game.sample_generated.dart` was generated with `flatc` from
8+
`monster.fbs` in the example folder. The generated classes can be used to read
9+
or write binary files that are interoperable with other languages and platforms
10+
supported by FlatBuffers, as illustrated in the `example.dart` in the
11+
examples folder.
12+
13+
Additional documentation and examples are available [at the FlatBuffers site](https://google.github.io/flatbuffers/index.html)

0 commit comments

Comments
 (0)