zircon/system/host/fidl/include/fidl/json_generator.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef ZIRCON_SYSTEM_HOST_FIDL_INCLUDE_FIDL_JSON_GENERATOR_H_
#define ZIRCON_SYSTEM_HOST_FIDL_INCLUDE_FIDL_JSON_GENERATOR_H_

#include <memory>
#include <sstream>
#include <string>
#include <vector>

#include "flat_ast.h"
#include "string_view.h"

namespace fidl {

struct NameLocation {
    explicit NameLocation(const SourceLocation& location)
        : filename(location.source_file().filename()) {
      location.SourceLine(&position);
    }

    // TODO(FIDL-596): We are incorrectly assuming that the provided name is not
    // anonymous, and relying on callers to avoid derefencing a nullptr
    // location.
    explicit NameLocation(const flat::Name& name) : NameLocation(*name.maybe_location()) {}

    const std::string filename;
    SourceFile::Position position;
};

// Methods or functions named "Emit..." are the actual interface to
// the JSON output.

// Methods named "Generate..." directly generate JSON output via the
// "Emit" routines.

// Methods named "Produce..." indirectly generate JSON output by calling
// the Generate methods, and should not call the "Emit" functions
// directly.

class JSONGenerator {
public:
    explicit JSONGenerator(const flat::Library* library)
        : library_(library) {}

    ~JSONGenerator() = default;

    std::ostringstream Produce();

private:
    enum class Position {
        kFirst,
        kSubsequent,
    };

    void GenerateEOF();

    template <typename Iterator>
    void GenerateArray(Iterator begin, Iterator end);

    template <typename Collection>
    void GenerateArray(const Collection& collection);

    void GenerateObjectPunctuation(Position position);

    template <typename Callback>
    void GenerateObject(Callback callback);

    template <typename Type>
    void GenerateObjectMember(StringView key, const Type& value,
                              Position position = Position::kSubsequent);

    template <typename T>
    void Generate(const std::unique_ptr<T>& value);

    void Generate(const flat::Decl* decl);

    template <typename T>
    void Generate(const std::vector<T>& value);

    void Generate(bool value);
    void Generate(StringView value);
    void Generate(SourceLocation value);
    void Generate(NameLocation value);
    void Generate(uint32_t value);

    void Generate(types::HandleSubtype value);
    void Generate(types::Nullability value);
    void Generate(types::PrimitiveSubtype value);

    void Generate(const raw::Identifier& value);
    void Generate(const raw::Literal& value);
    void Generate(const raw::TypeConstructor& value);
    void Generate(const raw::Attribute& value);
    void Generate(const raw::AttributeList& value);
    void Generate(const raw::Ordinal& value);

    void Generate(const flat::Name& value);
    void Generate(const flat::Type* value);
    void Generate(const flat::Constant& value);
    void Generate(const flat::Bits& value);
    void Generate(const flat::Bits::Member& value);
    void Generate(const flat::Const& value);
    void Generate(const flat::Enum& value);
    void Generate(const flat::Enum::Member& value);
    void Generate(const flat::Interface& value);
    void Generate(const flat::Interface::Method* value);
    void GenerateRequest(const std::string& prefix, const flat::Struct& value);
    void Generate(const flat::Struct& value);
    void Generate(const flat::Struct::Member& value);
    void Generate(const flat::Table& value);
    void Generate(const flat::Table::Member& value);
    void Generate(const flat::Union& value);
    void Generate(const flat::Union::Member& value);
    void Generate(const flat::XUnion& value);
    void Generate(const flat::XUnion::Member& value);
    void Generate(const flat::Library* library);

    void GenerateDeclarationsEntry(int count, const flat::Name& name, StringView decl);
    void GenerateDeclarationsMember(const flat::Library* library,
                                    Position position = Position::kSubsequent);

    const flat::Library* library_;
    int indent_level_;
    std::ostringstream json_file_;
};

} // namespace fidl

#endif // ZIRCON_SYSTEM_HOST_FIDL_INCLUDE_FIDL_JSON_GENERATOR_H_