resolve.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_RESOLVE_H_
#define A11_FLOW_RESOLVE_H_
 
#include <string>
#include <string_view>
#include <vector>
 
#include "a11/flow/diagnostic.h"
#include "a11/flow/graph.h"
#include "a11/flow/parser.h"
#include "a11/flow/plan.h"
#include "a11/flow/syntax.h"
 
namespace a11::flow {
 
enum class SymbolKind {
  kInputPort,
  kOutputPort,
  kHeader,
  kCall,
  kNode,
  kNodeMap,
  kBarrier,
  kLoopVariable,
  kCarry,
  kValue,
};
 
struct Symbol {
  SymbolKind kind = SymbolKind::kInputPort;
  std::string name;
  syntax::Location location;
  bool implicit = false;
  bool readable = true;
  bool writable = false;
  std::string action;
  bool tolerant = false;
  const FlowPlan* absl_nullable target = nullptr;
  int reads = 0;
  int writes = 0;
  int status_reads = 0;
  // The graph ref this name reads and writes, when a graph was built: a port, a
  // node, a header, a loop variable.
  graph::RefId ref = graph::kNone;
  graph::StepId step = graph::kNone;
  graph::RefId value_source = graph::kNone;
  int value_offset = 0;
  // The `match` pattern this value came out of, where it came out of a literal
  // one.
  std::string pattern;
  bool value_part = false;
};
 
struct ResolvedFlow {
  FlowPlan plan;
  // The executable graph, when [Resolve] was asked for one.
  graph::FlowGraph graph;
  std::vector<Symbol> symbols;
  const syntax::FlowDeclaration* absl_nullable declaration = nullptr;
};
 
struct ResolveResult {
  Program program;
  std::vector<ResolvedFlow> flows;
  std::vector<Diagnostic> diagnostics;
 
  [[nodiscard]] bool HasErrors() const;
  [[nodiscard]] const Diagnostic* absl_nullable FirstError() const;
};
 
ResolveResult Resolve(std::string_view source, const ParseResult& parsed,
                      bool build_graph = false);
 
std::string_view SymbolKindName(SymbolKind kind);
 
}  // namespace a11::flow
 
#endif  // A11_FLOW_RESOLVE_H_