block.h

// Copyright 2018-2019 Delft University of Technology
//
// 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.
 
#pragma once
 
#include <vector>
#include <string>
#include <algorithm>
#include <optional>
 
namespace cerata::vhdl {
 
struct Line {
  Line() = default;
  explicit Line(const std::string &str) {
    parts.push_back(str);
  }
  [[nodiscard]] bool IsBlank() const {
    if (parts.empty()) {
      return true;
    }
    if (parts.size() == 1) {
      if (parts[0] == "\n") {
        return true;
      }
    }
    return false;
  }
  [[nodiscard]] std::string ToString() const;
  std::vector<std::string> parts;
};
 
struct Block {
  explicit Block(int indent = 0) : indent(indent) {}
  [[nodiscard]] std::vector<size_t> GetAlignments() const;
  Block &Reverse();
  Block &AppendBlankLineIfNotEmpty();
 
  Block &Sort(std::optional<char> c = std::nullopt);
 
  [[nodiscard]] std::string ToString() const;
 
  std::vector<Line> lines;
  int indent = 0;
};
 
struct MultiBlock {
  explicit MultiBlock(int indent = 0) : indent(indent) {}
  [[nodiscard]] std::string ToString() const;
  std::vector<Block> blocks;
  int indent = 0;
};
 
Line &operator+=(Line &lhs, const std::string &str); //NOLINT
 
Line &operator<<(Line &lhs, const std::string &str);
 
Line &operator<<(Line &lhs, const Line &rhs);
 
Block &operator<<(Block &lhs, const Line &line);
 
Block &operator<<(Block &lhs, const Block &rhs);
 
Block &operator<<(Block &lhs, const std::string &rhs);
 
Block &operator<<=(Block &lhs, const std::string &rhs); //NOLINT
 
Block &Prepend(const std::string &lhs, Block *rhs, const std::string &sep = "_");
 
MultiBlock &operator<<(MultiBlock &lhs, const Block &rhs);
 
MultiBlock &operator<<(MultiBlock &lhs, const MultiBlock &rhs);
 
MultiBlock &operator<<(MultiBlock &lhs, const Line &rhs);
 
std::string ToString(const std::vector<Block> &blocks);
 
}  // namespace cerata::vhdl