format.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_FORMAT_H_
#define A11_FLOW_FORMAT_H_
 
#include <string>
#include <string_view>
#include <vector>
 
#include "a11/flow/diagnostic.h"
 
namespace a11::flow {
 
struct FormatOptions {
  int indent = 2;
  bool align_ports = true;
};
 
struct FormatResult {
  std::string formatted;
  bool changed = false;
  // One edit that turns the input into `formatted`, trimmed to the part that
  // actually differs, so an editor applying it does not move the cursor or lose
  // a selection over a file that only changed at the bottom.
  std::vector<Edit> edits;
  std::vector<Diagnostic> diagnostics;
};
 
FormatResult Format(std::string_view source, FormatOptions options = {});
 
}  // namespace a11::flow
 
#endif  // A11_FLOW_FORMAT_H_