asciidag.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2021  Music Technology Group - Universitat Pompeu Fabra
 *
 * This file is part of Essentia
 *
 * Essentia is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation (FSF), either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the Affero GNU General Public License
 * version 3 along with this program.  If not, see http://www.gnu.org/licenses/
 */
 
#ifndef ESSENTIA_UTILS_ASCIIDAG_H
#define ESSENTIA_UTILS_ASCIIDAG_H
 
#include <vector>
#include <string>
#include "types.h"
 
namespace essentia {
 
class Position {
 public:
  int x, y;
 
  Position(int x_, int y_) : x(x_), y(y_) {}
 
  Position operator+(const Position& other) const {
    return Position(x+other.x, y+other.y);
  }
 
  bool operator==(const Position& other) const {
    return x == other.x && y == other.y;
  }
};
 
inline std::ostream& operator<<(std::ostream& out, const Position& pos) {
  return out << '<' << pos.x << ',' << pos.y << '>';
}
 
typedef Position Direction;
 
 
 
std::vector<std::string> makeRectangle(const std::string& network);
 
std::vector<std::string> makeRectangle(const char* const* network, int size);
 
 
class AsciiCanvas : public std::vector<std::string> {
 public:
  // NB: template is only used so that ARRAY_SIZE can work, we only want const char*[] here
  template <typename NetworkType>
  explicit AsciiCanvas(const NetworkType& network) {
    (*this) = makeRectangle(network, ARRAY_SIZE(network));
  }
 
  AsciiCanvas& operator=(const std::vector<std::string>& other);
 
  int height() const { return (int)size(); }
  int width() const { return (height() == 0) ? 0 : at(0).size(); }
 
  void addBorder();
 
  void fill(char c);
 
  const std::string& at(int i) const { return std::vector<std::string>::at(i); }
        std::string& at(int i)       { return std::vector<std::string>::at(i); }
 
  char  at(const Position& pos) const { return (*this)[pos.y][pos.x]; }
  char& at(const Position& pos)       { return (*this)[pos.y][pos.x]; }
};
 
inline std::ostream& operator<<(std::ostream& out, const AsciiCanvas& canvas) {
  out << '\n';
  for (int i=0; i<canvas.height(); i++) out << canvas.at(i) << '\n';
  return out;
}
 
 
class AsciiBox {
 public:
  int posX, posY;    // position of the top-left corner
  int width, height; // size of the box
  std::string title; // title of the box (main name contained in it)
 
  AsciiBox(const std::vector<std::string>& network, int x, int y);
 
  bool borderContains(int x, int y) const;
 
  static bool isBox(const std::vector<std::string>& network, int x, int y);
 
  static std::vector<AsciiBox> findBoxes(const std::vector<std::string>& network);
 
};
 
 
} // namespace essentia
 
#endif // ESSENTIA_UTILS_ASCIIDAG_H