Skip to content

Latest commit

 

History

History
65 lines (55 loc) · 1.77 KB

readers.rst

File metadata and controls

65 lines (55 loc) · 1.77 KB
Raw

Readers

Inlet has built-in support for three input file languages: JSON, Lua, and YAML. Due to language features, not all readers support all Inlet features. Below is a table that lists supported features:

Supported Language Features
  JSON Lua YAML
Primitive Types bool, double, int, string bool, double, int, string bool, double, int, string
Dictionaries X X X
Arrays X X X
Non-contiguous Arrays   X  
Mixed-typed key Arrays   X  
Callback Functions   X  

Extra Lua Functionality

The LuaReader class has the ability to access the entire Lua State via the protected member function LuaReader::solState(). This allows you fully utilize the Sol library, documented in Sol's documentation. This is an advanced feature and not recommended unless there is a good reason. We provide an example on how to create a derived reader class here:

.. literalinclude:: ../../examples/lua_library.cpp
   :start-after: _inlet_sol_state_start
   :end-before: _inlet_sol_state_end
   :language: C++

Inlet opens four Lua libraries by default: base, math, string, package. All libraries are documented in Sol's open_library documentation.

For example, you can add the io library by doing this:

.. literalinclude:: ../../examples/lua_library.cpp
   :start-after: _inlet_io_library_add_start
   :end-before: _inlet_io_library_add_end
   :language: C++