plan.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_PLAN_H_
#define A11_FLOW_PLAN_H_
 
#include <cstddef>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include <absl/base/nullability.h>
#include <absl/time/time.h>
 
#include "a11/flow/syntax.h"
 
namespace a11::flow {
 
struct PortPlan {
  std::string name;
  syntax::PortDirection direction = syntax::PortDirection::kInput;
  std::string declared;
  std::string type;
  bool unary = true;
  bool required = false;
  std::string description;
  syntax::Location location;
};
 
struct FieldPlan {
  std::string name;
  std::string declared;
  std::string type;
  std::string element;
  std::string dto_name;
  std::string element_dto_name;
  bool required = false;
  bool unique = false;
  syntax::FieldRange range;
  std::string pattern;
  bool has_pattern = false;
  std::vector<syntax::Constant> enumeration;
  bool has_enumeration = false;
  syntax::Constant default_value;
  bool has_default = false;
  std::string description;
  syntax::Location location;
};
 
struct DtoPlan {
  std::string name;
  std::string description;
  std::vector<FieldPlan> fields;
  // Whether the shape holds bytes anywhere in it, directly or through another
  // shape it names.
  bool binary = false;
  syntax::Location location;
 
  [[nodiscard]] const FieldPlan* absl_nullable Field(
      std::string_view field_name) const;
 
  [[nodiscard]] std::vector<std::string> FieldNames() const;
};
 
struct HeaderPlan {
  std::string name;
  std::string alias;
  syntax::Constant default_value;
  bool has_default = false;
  std::string description;
  syntax::Location location;
};
 
struct StepPlan {
  std::string kind;
  std::string label;
  std::vector<std::string> after;
  std::string action;
  std::string mode;
  std::string node_map;
  std::optional<absl::Duration> timeout;
  bool tolerant = false;
  bool tee = false;
  std::string source;
  std::string destination;
  std::vector<std::vector<StepPlan>> bodies;
  syntax::Location location;
};
 
struct FlowPlan {
  std::string name;
  bool entry = false;
  std::string description;
  std::vector<PortPlan> ports;
  std::vector<HeaderPlan> headers;
  std::vector<std::string> node_maps;
  std::vector<StepPlan> steps;
  syntax::Location location;
 
  [[nodiscard]] const PortPlan* absl_nullable Port(
      std::string_view port_name, syntax::PortDirection direction) const;
 
  [[nodiscard]] bool HasPort(std::string_view port_name,
                             syntax::PortDirection direction) const {
    return Port(port_name, direction) != nullptr;
  }
 
  [[nodiscard]] std::vector<std::string> PortNames(
      syntax::PortDirection direction) const;
};
 
struct Program {
  std::string source_name;
  std::vector<FlowPlan> flows;
  std::vector<DtoPlan> dtos;
 
  [[nodiscard]] const FlowPlan* absl_nullable Flow(std::string_view name) const;
 
  [[nodiscard]] const FlowPlan* absl_nullable Entry() const;
 
  [[nodiscard]] const DtoPlan* absl_nullable Dto(std::string_view name) const;
};
 
inline constexpr std::string_view kPlanFormat = "flow.plan/v1";
 
}  // namespace a11::flow
 
#endif  // A11_FLOW_PLAN_H_