xref: /aosp_15_r20/system/chre/external/flatbuffers/README.md (revision 84e339476a462649f82315436d70fd732297a399)
1*84e33947SAndroid Build Coastguard Worker# flatbuffers
2*84e33947SAndroid Build Coastguard Worker
3*84e33947SAndroid Build Coastguard WorkerThis folder contains a modified version of the FlatBuffers implementation header
4*84e33947SAndroid Build Coastguard Workerfile (flatbuffers.h) which customizes it for running in the CHRE environment.
5*84e33947SAndroid Build Coastguard WorkerWhen upgrading to a newer FlatBuffers release, be sure to manually merge the
6*84e33947SAndroid Build Coastguard Workerchanges described in the comment at the top of flatbuffers.h, and apply them to
7*84e33947SAndroid Build Coastguard Workernew additions as well (e.g. removal of std::string usage) to maintain support.
8*84e33947SAndroid Build Coastguard WorkerThe FlatBuffers IDL compiler (flatc) can be used without modification, but must
9*84e33947SAndroid Build Coastguard Workermatch the version of the Flatbuffers library used here.
10*84e33947SAndroid Build Coastguard Worker
11*84e33947SAndroid Build Coastguard WorkerThe FlatBuffers project is hosted at https://github.com/google/flatbuffers/
12*84e33947SAndroid Build Coastguard Worker
13*84e33947SAndroid Build Coastguard Worker## Current version
14*84e33947SAndroid Build Coastguard Worker
15*84e33947SAndroid Build Coastguard WorkerThe version currently supported is [v1.12.0](https://github.com/google/flatbuffers/releases/tag/v1.12.0).
16*84e33947SAndroid Build Coastguard Worker
17*84e33947SAndroid Build Coastguard Worker### Building flatc
18*84e33947SAndroid Build Coastguard Worker
19*84e33947SAndroid Build Coastguard WorkerOfficial build instructions: https://flatbuffers.dev/flatbuffers_guide_building.html
20*84e33947SAndroid Build Coastguard Worker
21*84e33947SAndroid Build Coastguard WorkerInstructions updated May 29, 2024.
22*84e33947SAndroid Build Coastguard Worker
23*84e33947SAndroid Build Coastguard Worker```shell
24*84e33947SAndroid Build Coastguard Workermkdir /tmp/flatbuffer-v1.12.0
25*84e33947SAndroid Build Coastguard Workercd /tmp/flatbuffer-v1.12.0
26*84e33947SAndroid Build Coastguard Workerwget https://github.com/google/flatbuffers/archive/refs/tags/v1.12.0.tar.gz -O flatbuffers-1.12.0.tar.gz
27*84e33947SAndroid Build Coastguard Workertar -xzvf flatbuffers-1.12.0.tar.gz
28*84e33947SAndroid Build Coastguard Workercd flatbuffers-1.12.0
29*84e33947SAndroid Build Coastguard Workercmake .
30*84e33947SAndroid Build Coastguard Workermake flatc
31*84e33947SAndroid Build Coastguard Worker```
32*84e33947SAndroid Build Coastguard Worker
33*84e33947SAndroid Build Coastguard WorkerAdding flatc to your PATH
34*84e33947SAndroid Build Coastguard Worker```shell
35*84e33947SAndroid Build Coastguard Workerexport PATH=$PATH:/tmp/flatbuffer-v1.12.0/flatbuffers-1.12.0
36*84e33947SAndroid Build Coastguard Worker```
37