Skip to content

Latest commit

 

History

History
159 lines (107 loc) · 4.14 KB

README.md

File metadata and controls

159 lines (107 loc) · 4.14 KB
Raw

ofxJsonUtils

utilities for ofJson

API

ofJson ofLoadJson (const std::filesystem::path& filename )

  • compatible to oF 0.10

bool ofSaveJson(const std::filesystem::path& filename, const ofJson & json)

  • compatible to oF 0.10

bool ofSavePrettyJson(const std::filesystem::path& filename, const ofJson & json)

  • compatible to oF 0.10

ofJson ofxParseXxx(const std::vector<std::uint8_t> &binary)

  • load CONVERTIABLE_TYPE binary to json.
  • ex. ofxParseBson, ofxParseMessagePack, etc... see below.

ofJson ofLoadXxx(const std::filesystem::path &filename)

  • load CONVERTIBLE_TYPE binary file to json

std::vector<std::uint8_t> ofxConvertToXxx(const ofJson &json)

  • convert to CONVERTIBLE_TYPE binary from json

bool ofxSaveJsonAsXxx(const std::filesystem::path &filename, const ofJson &json)

  • save json as CONVERTIBLE_TYPE

Xxx : CONVERTIBLE_TYPE

  • Bson
  • Cbor
  • MessagePack
  • UBJson

ofJson convert(const T &value)

void parse(const ofJson &json, T &value)

  • allowed type
    • ofJson (a.k.a. nlohmann::json)
    • arithmetic type (i.e., int, float, ...)
    • std::string
    • ofVecNf
    • ofMatrix4x4
    • ofQuaternion
    • ofRectangle
    • ofColor_<PixelType>
    • glm::vecN
    • glm::matMxN
    • glm::quat
    • std::vector<allowed type>
    • std::array<allowed type, N>
    • std::deque<allowed type>
    • std::map<std::string, allowed type>
    • ofParameter<allowed type>
    • ofParameterGroup
    • custom class has toJson / loadJson

ofJson create(std::string key, T &value, [...])

  • utility for custom class

void load(const ofJson &json, const std::string &key, T &value, [...])

  • utility for custom class

Dependencies

nlohmann/json

v3.6.1

MIT License.

MIT License 

Copyright (c) 2013-2019 Niels Lohmann

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Update history

2019/11/30 ver 0.2.0 release

  • update nlohman::json to v3.6.1
  • add load / parse / save about BSON, CBOR, MessagePack, UBJSON

2018/07/29 ver 0.1.1 release

  • refactor
  • add parse / convert about glm

2017/10/01 ver 0.1.0 release

  • big refactor
  • add NDJson support
  • add of0.10 API
    • ofLoadJson
    • ofSaveJson
    • ofSavePrettyJson
    • ofSerialize
    • ofDeserialize

2017/03/05 ver 0.0.3 release

  • tiny bugfixes.

2016/09/12 ver 0.0.2 release

2016/05/23 ver 0.0.1 release

Special Thanks

License

MIT License.

Author

  • ISHII 2bit
  • i[at]2bit.jp

At the last

Please create a new issue if there is a problem. And please throw a pull request if you have a cool idea!!

If you get happy with using this addon, and you're rich, please donation for support continuous development.

Bitcoin: 17AbtW73aydfYH3epP8T3UDmmDCcXSGcaf