There are project files for Visual Studio and Xcode that should allow you to build the compiler flatc, the samples and the tests out of the box.
Alternatively, the distribution comes with a cmake file that should allow you to build project/make files for any platform. For details on cmake, see http://www.cmake.org. In brief, depending on your platform, use one of e.g.:
cmake -G "Unix Makefiles" +Alternatively, the distribution comes with a
cmakefile that should allow you to build project/make files for any platform. For details oncmake, see http://www.cmake.org. In brief, depending on your platform, use one of e.g.:cmake -G "Unix Makefiles" cmake -G "Visual Studio 10" cmake -G "Xcode"Then, build as normal for your platform. This should result in a
diff --git a/docs/html/md__compiler.html b/docs/html/md__compiler.html index fab13cd77..21bd4d476 100644 --- a/docs/html/md__compiler.html +++ b/docs/html/md__compiler.html @@ -3,7 +3,7 @@ - +flatcexecutable, essential for the next steps. Note that to use clang instead of gcc, you may need to set up your environment variables, e.g.CC=/usr/bin/clang CXX=/usr/bin/clang++ cmake -G "Unix Makefiles".FlatBuffers: Using the schema compiler @@ -32,7 +32,7 @@
Usage:
-flatc [ -c ] [ -j ] [ -b ] [ -t ] file1 file2 .. +- +Usage:
flatc [ -c ] [ -j ] [ -b ] [ -t ] file1 file2 ..The files are read and parsed in order, and can contain either schemas or data (see below). Later files can make use of definitions in earlier files. Depending on the flags passed, additional files may be generated for each file processed:
- diff --git a/docs/html/md__cpp_usage.html b/docs/html/md__cpp_usage.html index 4023544f6..386fffc86 100644 --- a/docs/html/md__cpp_usage.html +++ b/docs/html/md__cpp_usage.html @@ -3,7 +3,7 @@ - +
-c: Generate a C++ header for all definitions in this file (asfilename_generated.h). Skips data.FlatBuffers: Use in C++ @@ -32,7 +32,7 @@
There's experimental support for reading FlatBuffers in Java. Generate code for Java with the -j option to flatc.
See javaTest.java for an example. Essentially, you read a FlatBuffer binary file into a byte[], which you then turn into a ByteBuffer, which you pass to the getRootAsMonster function:
ByteBuffer bb = ByteBuffer.wrap(data); +See
javaTest.javafor an example. Essentially, you read a FlatBuffer binary file into abyte[], which you then turn into aByteBuffer, which you pass to thegetRootAsMonsterfunction:ByteBuffer bb = ByteBuffer.wrap(data); Monster monster = Monster.getRootAsMonster(bb); -Now you can access values much like C++:
-short hp = monster.hp(); +Now you can access values much like C++:
short hp = monster.hp(); Vec3 pos = monster.pos();Note that whenever you access a new object like in the
posexample above, a new temporary accessor object gets created. If your code is very performance sensitive (you iterate through a lot of objects), there's a secondpos()method to which you can pass aVec3object you've already created. This allows you to reuse it across many calls and reduce the amount of object allocation (and thus garbage collection) your program does.Sadly the string accessors currently always create a new string when accessed, since FlatBuffer's UTF-8 strings can't be read in-place by Java.
-Vector access is also a bit different from C++: you pass an extra index to the vector field accessor. Then a second method with the same name suffixed by
-_lengthlet's you know the number of elements you can access:for (int i = 0; i < monster.inventory_length(); i++) +Vector access is also a bit different from C++: you pass an extra index to the vector field accessor. Then a second method with the same name suffixed by
_lengthlet's you know the number of elements you can access:for (int i = 0; i < monster.inventory_length(); i++) monster.inventory(i); // do something here -You can also construct these buffers in Java using the static methods found in the generated code, and the FlatBufferBuilder class:
-FlatBufferBuilder fbb = new FlatBufferBuilder(); -Create strings:
-int str = fbb.createString("MyMonster"); -Create a table with a struct contained therein:
-Monster.startMonster(fbb); +You can also construct these buffers in Java using the static methods found in the generated code, and the FlatBufferBuilder class:
FlatBufferBuilder fbb = new FlatBufferBuilder(); +Create strings:
int str = fbb.createString("MyMonster"); +Create a table with a struct contained therein:
Monster.startMonster(fbb); Monster.addPos(fbb, Vec3.createVec3(fbb, 1.0f, 2.0f, 3.0f, 3.0, (byte)4, (short)5, (byte)6)); Monster.addHp(fbb, (short)80); Monster.addName(fbb, str); @@ -80,8 +74,7 @@ Monster.addTest(fbb, mon2); Monster.addTest4(fbb, test4s); int mon = Monster.endMonster(fbb);As you can see, the Java code for tables does not use a convenient
-createMonstercall like the C++ code. This is to create the buffer without using temporary object allocation (since theVec3is an inline component ofMonster, it has to be created right where it is added, whereas the name and the inventory are not inline). Structs do have convenient methods that even have arguments for nested structs.Vectors also use this start/end pattern to allow vectors of both scalar types and structs:
-Monster.startInventoryVector(fbb, 5); +Vectors also use this start/end pattern to allow vectors of both scalar types and structs:
Monster.startInventoryVector(fbb, 5); for (byte i = 4; i >=0; i--) fbb.addByte(i); int inv = fbb.endVector();You can use the generated method
diff --git a/docs/html/md__schemas.html b/docs/html/md__schemas.html index d1faa73c7..f4b82c6a0 100644 --- a/docs/html/md__schemas.html +++ b/docs/html/md__schemas.html @@ -3,7 +3,7 @@ - +startInventoryVectorto conveniently callstartVectorwith the right element size. You pass the number of elements you want to write. You write the elements backwards since the buffer is being constructed back to front.FlatBuffers: Writing a schema @@ -32,7 +32,7 @@
The syntax of the schema language (aka IDL, Interface Definition Language) should look quite familiar to users of any of the C family of languages, and also to users of other IDLs. Let's look at an example first:
-// example IDL file +- +The syntax of the schema language (aka IDL, Interface Definition Language) should look quite familiar to users of any of the C family of languages, and also to users of other IDLs. Let's look at an example first:
// example IDL file namespace MyGame; diff --git a/docs/html/md__white_paper.html b/docs/html/md__white_paper.html index b2ea61035..b64f58180 100644 --- a/docs/html/md__white_paper.html +++ b/docs/html/md__white_paper.html @@ -3,7 +3,7 @@ - +FlatBuffers: FlatBuffers white paper @@ -32,7 +32,7 @@
