juce_JSON.h

Go to the documentation of this file.

 /*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  JSON
{
public:
    //==============================================================================
    static Result parse (const String& text, var& parsedResult);
 
    static var parse (const String& text);
 
    static var parse (const File& file);
 
    static var parse (InputStream& input);
 
    enum class Spacing
    {
        none,           
        singleLine,     
        multiLine,      
    };
 
    class [[nodiscard]] FormatOptions
    {
    public:
        FormatOptions withSpacing (Spacing x)      const { return withMember (*this, &FormatOptions::spacing, x); }
 
        FormatOptions withMaxDecimalPlaces (int x) const { return withMember (*this, &FormatOptions::maxDecimalPlaces, x); }
 
        FormatOptions withIndentLevel (int x)      const { return withMember (*this, &FormatOptions::indent, x); }
 
        Spacing getSpacing()      const { return spacing; }
 
        int getMaxDecimalPlaces() const { return maxDecimalPlaces; }
 
        int getIndentLevel()      const { return indent; }
 
    private:
        Spacing spacing = Spacing::multiLine;
        int maxDecimalPlaces = 15;
        int indent = 0;
    };
 
    //==============================================================================
    static String toString (const var& objectToFormat,
                            bool allOnOneLine = false,
                            int maximumDecimalPlaces = 15);
 
    static String toString (const var& objectToFormat,
                            const FormatOptions& formatOptions);
 
    static var fromString (StringRef);
 
    static void writeToStream (OutputStream& output,
                               const var& objectToFormat,
                               bool allOnOneLine = false,
                               int maximumDecimalPlaces = 15);
 
    static void writeToStream (OutputStream& output,
                               const var& objectToFormat,
                               const FormatOptions& formatOptions);
 
    static String escapeString (StringRef);
 
    static Result parseQuotedString (String::CharPointerType& text, var& result);
 
private:
    //==============================================================================
    JSON() = delete; // This class can't be instantiated - just use its static methods.
};
 
} // namespace juce