// OpenSTA, Static Timing Analyzer
// Copyright (c) 2025, Parallax Software, Inc.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, 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 GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
// 
// The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software.
// 
// Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
// 
// This notice may not be removed or altered from any source distribution.

#pragma once

#include "RiseFallMinMax.hh"
#include "SdcClass.hh"

namespace sta {

class PortDelay;

typedef Vector<PortDelay*> PortDelaySeq;

// set_input_delay arrival, set_output_delay departure
class PortDelay
{
public:
  RiseFallMinMax *delays() { return &delays_; }
  const Pin *pin() const { return pin_; }
  PinSet &leafPins() { return leaf_pins_; }
  Clock *clock() const;
  const ClockEdge *clkEdge() const { return clk_edge_; }
  bool sourceLatencyIncluded() const;
  void setSourceLatencyIncluded(bool included);
  bool networkLatencyIncluded() const;
  void setNetworkLatencyIncluded(bool included);
  const Pin *refPin() const { return ref_pin_; }
  void setRefPin(const Pin *ref_pin);
  const RiseFall *refTransition() const;

protected:
  PortDelay(const Pin *pin,
	    const ClockEdge *clk_edge,
            const Network *network);

  const Pin *pin_;
  const ClockEdge *clk_edge_;
  bool source_latency_included_;
  bool network_latency_included_;
  const Pin *ref_pin_;
  RiseFallMinMax delays_;
  PinSet leaf_pins_;
};

class InputDelay : public PortDelay
{
public:
  int index() const { return index_; }

protected:
  InputDelay(const Pin *pin,
	     const ClockEdge *clk_edge,
	     int index,
	     const Network *network);

private:
  int index_;

  friend class Sdc;
};

class OutputDelay : public PortDelay
{
public:

protected:
  OutputDelay(const Pin *pin,
	      const ClockEdge *clk_edge,
	      const Network *network);

private:
  friend class Sdc;
};

// Prediate used to sort port delays.
class PortDelayLess
{
public:
  explicit PortDelayLess(const Network *network);
  bool operator()(const PortDelay *delay1,
		  const PortDelay *delay2) const;

private:
  const Network *network_;
};

} // namespace