/*
 *  nextpnr -- Next Generation Place and Route
 *
 *  Copyright (C) 2018  Clifford Wolf <clifford@clifford.at>
 *
 *  Permission to use, copy, modify, and/or distribute this software for any
 *  purpose with or without fee is hereby granted, provided that the above
 *  copyright notice and this permission notice appear in all copies.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 */

#include "design.h"

#ifndef CHIP_H
#define CHIP_H

struct DelayInfo
{
	float delay = 0;

	float raiseDelay() { return delay; }
	float fallDelay() { return delay; }
};

typedef IdString BelType;
typedef IdString PortPin;

static inline IdString belTypeToId(BelType type) { return type; }
static inline IdString portPinToId(PortPin type) { return type; }

static inline BelType belTypeFromId(IdString id) { return id; }
static inline PortPin portPinFromId(IdString id) { return id; }

typedef IdString BelId;
typedef IdString WireId;
typedef IdString PipId;

struct BelPin
{
	BelId bel;
	PortPin pin;
};

struct ChipArgs
{
};

struct Chip
{
	Chip(ChipArgs args);

	BelId getBelByName(IdString name) const;

	IdString getBelName(BelId bel) const;
	void bindBel(BelId bel, IdString cell);
	void unbindBel(BelId bel);
	bool checkBelAvail(BelId bel) const;
	const vector<BelId> &getBels() const;
	const vector<BelId> &getBelsByType(BelType type) const;
	BelType getBelType(BelId bel) const;
	WireId getWireBelPin(BelId bel, PortPin pin) const;
	BelPin getBelPinUphill(WireId wire) const;
	const vector<BelPin> &getBelPinsDownhill(WireId wire) const;

	WireId getWireByName(IdString name) const;
	IdString getWireName(WireId wire) const;
	void bindWire(WireId bel, IdString net);
	void unbindWire(WireId bel);
	bool checkWireAvail(WireId bel) const;
	const vector<WireId> &getWires() const;

	PipId getPipByName(IdString name) const;
	IdString getPipName(PipId pip) const;
	void bindPip(PipId bel, IdString net);
	void unbindPip(PipId bel);
	bool checkPipAvail(PipId bel) const;
	const vector<PipId> &getPips() const;
	WireId getPipSrcWire(PipId pip) const;
	WireId getPipDstWire(PipId pip) const;
	DelayInfo getPipDelay(PipId pip) const;
	const vector<PipId> &getPipsDownhill(WireId wire) const;
	const vector<PipId> &getPipsUphill(WireId wire) const;
	const vector<PipId> &getWireAliases(WireId wire) const;

	void getBelPosition(BelId bel, float &x, float &y) const;
	void getWirePosition(WireId wire, float &x, float &y) const;
	void getPipPosition(PipId pip, float &x, float &y) const;
	vector<GraphicElement> getBelGraphics(BelId bel) const;
	vector<GraphicElement> getWireGraphics(WireId wire) const;
	vector<GraphicElement> getPipGraphics(PipId pip) const;
	vector<GraphicElement> getFrameGraphics() const;
};

#endif