io.h

/*
 * vim: ts=4 sw=4 et tw=0 wm=0
 *
 * libdialect - A library for computing DiAlEcT layouts:
 *                 D = Decompose/Distribute
 *                 A = Arrange
 *                 E = Expand/Emend
 *                 T = Transform
 *
 * Copyright (C) 2018  Monash University
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * See the file LICENSE.LGPL distributed with the library.
 *
 * This library 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.
 *
 * Author(s):   Steve Kieffer   <http://skieffer.info>
*/

#ifndef DIALECT_IO_H
#define DIALECT_IO_H

#include <istream>
#include <string>
#include <memory>
#include <iostream>
#include <cstdio>

namespace dialect {

class Graph;

/*
 * Support for TGLF: Trivial Graph Layout Format.
 *
 * TGLF looks like this:
 *
 * cx0 cy0 w0 h0
 * cx1 cy1 w1 h1
 * ...
 * xn yn wn hn
 * #
 * i0 i1
 * i2 i3 a  b  c  d
 * i4 i5 a' b'
 * i6 i7
 * ...
 * #
 * j0 j1 D  R  G
 * j2 j3 D' R' G'
 * ...
 *
 * and is of the form:
 *
 * NODES
 * #
 * LINKS
 * #
 * SEPCOS
 *
 * where
 *
 * NODES defines one node per line, giving the x and y coordinates of the
 * centre of the node, followed by its width and height. All values are floats.
 *
 * LINKS defines one link (or "edge" or "connector") per line. A line begins
 * with two zero-based indices referring to the nodes in the order defined
 * in NODES. This is followed by zero or more pairs of floats giving
 * the coordinates of route points. The centres of the source and target
 * nodes are implicit route points, and should not be listed.
 *
 * SEPCOS defines one separation constraint per line. As with the LINKS,
 * a line begins with two zero-based indices referring to the nodes in the
 * order defined in NODES. This is followed by a DIRECTION D in [NSEWUDLRXY],
 * (North, South, East, West, Up, Down, Left, Right, x-dimension, y-dimension)
 * a RELATION R in [EM] (Exact, Minimal), and a GAP, which is a float.
 *
 * Note: For the DIRECTION, X is a synonym for R, and Y a synonym for D.
 *
 * The NODES section must be nonempty, but either or both of the LINKS
 * and SEPCOS sections may be empty or omitted.
 *
*/

std::shared_ptr<Graph> buildGraphFromTglf(std::istream &in);

std::shared_ptr<Graph> buildGraphFromTglf(std::string &s);

std::shared_ptr<Graph> buildGraphFromTglfFile(const std::string &filepath);

void writeStringToFile(const std::string &s, const std::string &filepath);

} // namespace dialect

#endif // DIALECT_IO_H