emit_json.h

Go to the documentation of this file.

/*
 * Copyright 2026 The A11 Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef A11_FLOW_EMIT_JSON_H_
#define A11_FLOW_EMIT_JSON_H_
 
#include <string>
#include <string_view>
 
#include <absl/types/span.h>
#include <nlohmann/json_fwd.hpp>
 
#include "a11/flow/complete.h"
#include "a11/flow/diagnostic.h"
#include "a11/flow/format.h"
#include "a11/flow/parser.h"
#include "a11/flow/plan.h"
#include "a11/flow/syntax.h"
 
namespace a11::flow {
 
inline constexpr std::string_view kDiagnosticsFormat = "flow.diagnostics/v1";
inline constexpr std::string_view kCodesFormat = "flow.codes/v1";
inline constexpr std::string_view kSyntaxFormat = "flow.syntax/v1";
inline constexpr std::string_view kTokensFormat = "flow.tokens/v1";
inline constexpr std::string_view kVocabularyFormat = "flow.vocabulary/v1";
inline constexpr std::string_view kFormatFormat = "flow.format/v1";
 
nlohmann::json DiagnosticToJsonValue(const Diagnostic& diagnostic);
 
// A diagnostic read back from its JSON, for frontends that consume the envelope
// rather than the library -- the IntelliJ plugin, a CI script.
Diagnostic DiagnosticFromJsonValue(const nlohmann::json& value);
 
nlohmann::json DiagnosticsToJsonValue(std::string_view source,
                                      absl::Span<const Diagnostic> diagnostics);
 
std::string DiagnosticsToJson(std::string_view source,
                              absl::Span<const Diagnostic> diagnostics);
 
nlohmann::json CodesToJsonValue();
 
nlohmann::json VocabularyToJsonValue();
 
nlohmann::json DiagnosticsToSarifValue(
    std::string_view source, absl::Span<const Diagnostic> diagnostics);
 
std::string DiagnosticsToSarif(std::string_view source,
                               absl::Span<const Diagnostic> diagnostics);
 
nlohmann::json NodeToJsonValue(const syntax::Node& node);
 
nlohmann::json ConstantToJsonValue(const syntax::Constant& constant);
 
nlohmann::json SyntaxToJsonValue(std::string_view source,
                                 const ParseResult& result);
 
std::string SyntaxToJson(std::string_view source, const ParseResult& result);
 
nlohmann::json TokensToJsonValue(std::string_view source_name,
                                 std::string_view source);
 
std::string TokensToJson(std::string_view source_name, std::string_view source);
 
nlohmann::json FormatToJsonValue(const FormatResult& result);
 
nlohmann::json CompletionsToJsonValue(const CompleteResult& result);
 
nlohmann::json PlanToJsonValue(std::string_view source_name,
                               const Program& program);
 
nlohmann::json DtoToJsonValue(const DtoPlan& dto,
                              const Program* absl_nullable program = nullptr);
 
std::string PlanToJson(std::string_view source_name, const Program& program);
 
// One diagnostic on one line, in the shape editors and compilers have used for
// decades: `path:line:column: severity: message [code]`.
std::string DiagnosticToText(std::string_view source,
                             const Diagnostic& diagnostic);
 
}  // namespace a11::flow
 
#endif  // A11_FLOW_EMIT_JSON_H_