complete.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_COMPLETE_H_
#define A11_FLOW_COMPLETE_H_
 
#include <cstddef>
#include <string>
#include <string_view>
#include <vector>
 
#include "a11/flow/catalogue.h"
 
namespace a11::flow {
 
enum class ProposalKind {
  kStatement,
  kDeclaration,
  kModifier,
  kStage,
  kFunction,
  kType,
  kStatusCode,
  kLogLevel,
  kConstant,
  kPortModifier,
  kFlow,
  kPort,
  kNode,
  kNodeMap,
  kCall,
  kBarrier,
  kVariable,
  kHeader,
  kField,
};
 
struct Proposal {
  std::string name;
  ProposalKind kind = ProposalKind::kStatement;
  std::string insert;
  int caret = -1;
  std::string tail;
  std::string type;
  // The whole of what is known about it, as Markdown, for the popup an editor
  // shows beside the list.
  std::string documentation;
};
 
struct CompleteResult {
  std::vector<Proposal> proposals;
  std::string prefix;
  size_t prefix_start = 0;
};
 
CompleteResult CompleteAt(
    std::string_view source, size_t offset,
    const catalogue::Catalogue& known = catalogue::Catalogue::Builtin());
 
std::string_view ProposalKindName(ProposalKind kind);
 
inline constexpr std::string_view kCompletionsFormat = "flow.completions/v1";
 
}  // namespace a11::flow
 
#endif  // A11_FLOW_COMPLETE_H_