From 9dc5d378b147a6c70799810f8db0754dd89ea12e Mon Sep 17 00:00:00 2001 From: Wouter van Oortmerssen Date: Mon, 9 Nov 2015 17:23:32 -0800 Subject: [PATCH] Updated supported languages in the docs. Change-Id: I607f5f33b609c47fe32342f5e9d066f61f5546cd --- docs/html/index.html | 12 ++++++++---- docs/html/md__support.html | 36 +++++++++++++++++++----------------- docs/source/FlatBuffers.md | 19 ++++++++++++------- docs/source/Support.md | 36 +++++++++++++++++++----------------- 4 files changed, 58 insertions(+), 45 deletions(-) diff --git a/docs/html/index.html b/docs/html/index.html index a59c95b..f5d8353 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -61,19 +61,19 @@ $(document).ready(function(){initNavTree('index.html','');});
FlatBuffers Documentation
-

FlatBuffers is an efficient cross platform serialization library for C++, with support for Java, C# and Go. It was created at Google specifically for game development and other performance-critical applications.

+

FlatBuffers is an efficient cross platform serialization library for C++, Java, C#, Go, Python and JavaScript (C, PHP & Ruby in progress). It was originally created at Google for game development and other performance-critical applications.

It is available as Open Source on GitHub under the Apache license, v2 (see LICENSE.txt).

Why use FlatBuffers?

  • Access to serialized data without parsing/unpacking - What sets FlatBuffers apart is that it represents hierarchical data in a flat binary buffer in such a way that it can still be accessed directly without parsing/unpacking, while also still supporting data structure evolution (forwards/backwards compatibility).
    • -
  • Memory efficiency and speed - The only memory needed to access your data is that of the buffer. It requires 0 additional allocations. FlatBuffers is also very suitable for use with mmap (or streaming), requiring only part of the buffer to be in memory. Access is close to the speed of raw struct access with only one extra indirection (a kind of vtable) to allow for format evolution and optional fields. It is aimed at projects where spending time and space (many memory allocations) to be able to access or construct serialized data is undesirable, such as in games or any other performance sensitive applications. See the benchmarks for details.
    • +
  • Memory efficiency and speed - The only memory needed to access your data is that of the buffer. It requires 0 additional allocations (in C++, other languages may vary). FlatBuffers is also very suitable for use with mmap (or streaming), requiring only part of the buffer to be in memory. Access is close to the speed of raw struct access with only one extra indirection (a kind of vtable) to allow for format evolution and optional fields. It is aimed at projects where spending time and space (many memory allocations) to be able to access or construct serialized data is undesirable, such as in games or any other performance sensitive applications. See the benchmarks for details.
  • Flexible - Optional fields means not only do you get great forwards and backwards compatibility (increasingly important for long-lived games: don't have to update all data with each new version!). It also means you have a lot of choice in what data you write and what data you don't, and how you design data structures.
  • Tiny code footprint - Small amounts of generated code, and just a single small header as the minimum dependency, which is very easy to integrate. Again, see the benchmark section for details.
  • Strongly typed - Errors happen at compile time rather than manually having to write repetitive and error prone run-time checks. Useful code can be generated for you.

  • Convenient to use - Generated C++ code allows for terse access & construction code. Then there's optional functionality for parsing schemas and JSON-like text representations at runtime efficiently if needed (faster and more memory efficient than other JSON parsers).

    -

    Java and Go code supports object-reuse.

    +

    Java and Go code supports object-reuse. C# has efficient struct based accessors.

    • -
  • Cross platform C++11/Java/C#/Go code with no dependencies - will work with any recent gcc/clang and VS2010. Comes with build files for the tests & samples (Android .mk files, and cmake for all other platforms).
    • +
  • Cross platform code with no dependencies - C++ code will work with any recent gcc/clang and VS2010. Comes with build files for the tests & samples (Android .mk files, and cmake for all other platforms).

Why not use Protocol Buffers, or .. ?

Protocol Buffers is indeed relatively similar to FlatBuffers, with the primary difference being that FlatBuffers does not need a parsing/ unpacking step to a secondary representation before you can access data, often coupled with per-object memory allocation. The code is an order of magnitude bigger, too. Protocol Buffers has neither optional text import/export nor schema language features like unions.

@@ -115,6 +115,10 @@ $(document).ready(function(){initNavTree('index.html','');});
  • Landing page
  • FlatBuffers Google Group
  • FlatBuffers Issues Tracker
    • +
  • Independent implementations & tools:
      +
    • FlatCC Alternative FlatBuffers parser, code generator and runtime all in C.
      • +
    +
  • Videos:
    • Colt's DevByte.
    • GDC 2015 Lightning Talk.
      • diff --git a/docs/html/md__support.html b/docs/html/md__support.html index 5ac173f..833f033 100644 --- a/docs/html/md__support.html +++ b/docs/html/md__support.html @@ -71,41 +71,43 @@ $(document).ready(function(){initNavTree('md__support.html','');});

      NOTE: this table is a start, it needs to be extended.

      - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
      Feature C++ Java C# Go Python JS
      Feature C++ Java C# Go Python JS C PHP Ruby
      Codegen for all basic features Yes Yes Yes Yes Yes WIP
      Codegen for all basic features Yes Yes Yes Yes Yes Yes WiP WiP WiP
      JSON parsing Yes No No No No No
      JSON parsing Yes No No No No No No No No
      Simple mutation Yes WIP WIP No No No
      Simple mutation Yes WIP WIP No No No No No No
      Reflection Yes No No No No No
      Reflection Yes No No No No No No No No
      Buffer verifier Yes No No No No No
      Buffer verifier Yes No No No No No No No No
      Testing: basic Yes Yes Yes Yes Yes WIP
      Testing: basic Yes Yes Yes Yes Yes Yes ? ? ?
      Testing: fuzz Yes No No Yes Yes No
      Testing: fuzz Yes No No Yes Yes No ? ? ?
      Performance: Superb Great Great Great Ok ?
      Performance: Superb Great Great Great Ok ? Superb? ?
      Platform: Windows VS2010 Yes Yes ? ? ?
      Platform: Windows VS2010 Yes Yes ? ? ? ? ? ?
      Platform: Linux GCC282 Yes ? Yes Yes ?
      Platform: Linux GCC282 Yes ? Yes Yes ? ? ? ?
      Platform: OS X Xcode4 ? ? ? Yes ?
      Platform: OS X Xcode4 ? ? ? Yes ? ? ? ?
      Platform: Android NDK10d Yes ? ? ? ?
      Platform: Android NDK10d Yes ? ? ? ? ? ? ?
      Platform: iOS ? ? ? ? ? ?
      Platform: iOS ? ? ? ? ? ? ? ? ?
      Engine: Unity ? ? Yes ? ? ?
      Engine: Unity ? ? Yes ? ? ? ? ? ?
      Primary authors (github) wvo wvo (ev/js)rw rw (ev)
      Primary authors (github) gwvo gwvo ev*/js*rw rw evanw/ev* mik* ch* rw
      • ev = evolutional
        • -
      • js = jonsimantov
        • +
      • js = jonsimantov
        • +
      • mik = mikkelfj
        • +
      • ch = chobie
    • diff --git a/docs/source/FlatBuffers.md b/docs/source/FlatBuffers.md index 3f5258f..79846d7 100644 --- a/docs/source/FlatBuffers.md +++ b/docs/source/FlatBuffers.md @@ -1,8 +1,9 @@ # FlatBuffers -FlatBuffers is an efficient cross platform serialization library for C++, -with support for Java, C# and Go. It was created at Google specifically for game -development and other performance-critical applications. +FlatBuffers is an efficient cross platform serialization library for C++, Java, +C#, Go, Python and JavaScript (C, PHP & Ruby in progress). +It was originally created at Google for game development and other +performance-critical applications. It is available as Open Source on [GitHub](http://github.com/google/flatbuffers) under the Apache license, v2 (see LICENSE.txt). @@ -16,8 +17,8 @@ under the Apache license, v2 (see LICENSE.txt). structure evolution (forwards/backwards compatibility). - **Memory efficiency and speed** - The only memory needed to access - your data is that of the buffer. It requires 0 additional allocations. - FlatBuffers is also very + your data is that of the buffer. It requires 0 additional allocations + (in C++, other languages may vary). FlatBuffers is also very suitable for use with mmap (or streaming), requiring only part of the buffer to be in memory. Access is close to the speed of raw struct access with only one extra indirection (a kind of vtable) to @@ -47,9 +48,10 @@ under the Apache license, v2 (see LICENSE.txt). needed (faster and more memory efficient than other JSON parsers). - Java and Go code supports object-reuse. + Java and Go code supports object-reuse. C# has efficient struct based + accessors. -- **Cross platform C++11/Java/C#/Go code with no dependencies** - will work +- **Cross platform code with no dependencies** - C++ code will work with any recent gcc/clang and VS2010. Comes with build files for the tests & samples (Android .mk files, and cmake for all other platforms). @@ -139,6 +141,9 @@ sections provide a more in-depth usage guide. - [Landing page](http://google.github.io/flatbuffers) - [FlatBuffers Google Group](http://group.google.com/group/flatbuffers) - [FlatBuffers Issues Tracker](http://github.com/google/flatbuffers/issues) +- Independent implementations & tools: + - [FlatCC](https://github.com/dvidelabs/flatcc) Alternative FlatBuffers + parser, code generator and runtime all in C. - Videos: - Colt's [DevByte](https://www.youtube.com/watch?v=iQTxMkSJ1dQ). - GDC 2015 [Lightning Talk](https://www.youtube.com/watch?v=olmL1fUnQAQ). diff --git a/docs/source/Support.md b/docs/source/Support.md index 6271bfe..7df4249 100755 --- a/docs/source/Support.md +++ b/docs/source/Support.md @@ -17,23 +17,25 @@ In general: NOTE: this table is a start, it needs to be extended. -Feature | C++ | Java | C# | Go | Python | JS ------------------------------- | ------ | ------ | ------ | ------ | ------ | ------ -Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | WIP -JSON parsing | Yes | No | No | No | No | No -Simple mutation | Yes | WIP | WIP | No | No | No -Reflection | Yes | No | No | No | No | No -Buffer verifier | Yes | No | No | No | No | No -Testing: basic | Yes | Yes | Yes | Yes | Yes | WIP -Testing: fuzz | Yes | No | No | Yes | Yes | No -Performance: | Superb | Great | Great | Great | Ok | ? -Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? -Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? -Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? -Platform: Android | NDK10d | Yes | ? | ? | ? | ? -Platform: iOS | ? | ? | ? | ? | ? | ? -Engine: Unity | ? | ? | Yes | ? | ? | ? -Primary authors (github) | wvo | wvo | (ev/js)| rw | rw | (ev) +Feature | C++ | Java | C# | Go | Python | JS | C | PHP | Ruby +------------------------------ | ------ | ------ | ------ | ------ | ------ | --------- | ---- | --- | ---- +Codegen for all basic features | Yes | Yes | Yes | Yes | Yes | Yes | WiP | WiP | WiP +JSON parsing | Yes | No | No | No | No | No | No | No | No +Simple mutation | Yes | WIP | WIP | No | No | No | No | No | No +Reflection | Yes | No | No | No | No | No | No | No | No +Buffer verifier | Yes | No | No | No | No | No | No | No | No +Testing: basic | Yes | Yes | Yes | Yes | Yes | Yes | ? | ? | ? +Testing: fuzz | Yes | No | No | Yes | Yes | No | ? | ? | ? +Performance: | Superb | Great | Great | Great | Ok | ? |Superb| ? | ? +Platform: Windows | VS2010 | Yes | Yes | ? | ? | ? | ? | ? | ? +Platform: Linux | GCC282 | Yes | ? | Yes | Yes | ? | ? | ? | ? +Platform: OS X | Xcode4 | ? | ? | ? | Yes | ? | ? | ? | ? +Platform: Android | NDK10d | Yes | ? | ? | ? | ? | ? | ? | ? +Platform: iOS | ? | ? | ? | ? | ? | ? | ? | ? | ? +Engine: Unity | ? | ? | Yes | ? | ? | ? | ? | ? | ? +Primary authors (github) | gwvo | gwvo | ev*/js*| rw | rw | evanw/ev* | mik* | ch* | rw * ev = evolutional * js = jonsimantov + * mik = mikkelfj + * ch = chobie -- 2.7.4