catalogue.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_CATALOGUE_H_
#define A11_FLOW_CATALOGUE_H_
 
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include <absl/base/nullability.h>
#include <nlohmann/json_fwd.hpp>
 
#include "a11/flow/plan.h"
 
namespace a11::flow {
 
namespace catalogue {
 
struct Origin {
  std::string file;
  int line = 1;
  int column = 1;
 
  friend bool operator==(const Origin&, const Origin&) = default;
};
 
struct PortInfo {
  std::string name;
  std::string type;
  std::string description;
  bool required = false;
  bool unary = true;
};
 
struct ActionInfo {
  std::string name;
  std::string description;
  std::vector<PortInfo> inputs;
  std::vector<PortInfo> outputs;
  std::vector<PortInfo> headers;
  std::optional<Origin> origin;
 
  [[nodiscard]] const PortInfo* absl_nullable Port(
      std::string_view port_name, syntax::PortDirection direction) const;
  [[nodiscard]] std::vector<std::string> PortNames(
      syntax::PortDirection direction) const;
};
 
struct TypeInfo {
  std::string tag;
  DtoPlan shape;
  std::optional<Origin> origin;
};
 
class Catalogue {
 public:
  static const Catalogue& Builtin();
 
  static Catalogue Of(std::vector<ActionInfo> actions,
                      std::vector<TypeInfo> types = {});
 
  static Catalogue FromJson(const nlohmann::json& value);
 
  [[nodiscard]] Catalogue MergedWith(const Catalogue& other) const;
 
  [[nodiscard]] const ActionInfo* absl_nullable Action(
      std::string_view name) const;
  [[nodiscard]] const TypeInfo* absl_nullable Type(std::string_view tag) const;
 
  [[nodiscard]] const std::vector<ActionInfo>& actions() const {
    return actions_;
  }
 
  [[nodiscard]] const std::vector<TypeInfo>& types() const { return types_; }
 
  [[nodiscard]] bool Empty() const {
    return actions_.empty() && types_.empty();
  }
 
  [[nodiscard]] nlohmann::json ToJson() const;
 
 private:
  std::vector<ActionInfo> actions_;
  std::vector<TypeInfo> types_;
};
 
inline constexpr std::string_view kCatalogueFormat = "flow.catalogue/v1";
 
}  // namespace catalogue
}  // namespace a11::flow
 
#endif  // A11_FLOW_CATALOGUE_H_