// OpenSTA, Static Timing Analyzer
// Copyright (c) 2026, 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 <string_view>
#include <vector>

#include "GraphClass.hh"
#include "Mode.hh"
#include "NetworkClass.hh"
#include "SdcClass.hh"
#include "StaState.hh"
#include "StringUtil.hh"

namespace sta {

class ClkNetwork;

using CheckError = StringSeq;
using CheckErrorSeq = std::vector<CheckError*>;

class CheckTiming : public StaState
{
public:
  CheckTiming(StaState *sta);
  ~CheckTiming() override;
  CheckErrorSeq &check(const Mode *mode,
                       bool no_input_delay,
                       bool no_output_delay,
                       bool reg_multiple_clks,
                       bool reg_no_clks,
                       bool unconstrained_endpoints,
                       bool loops,
                       bool generated_clks);

protected:
  void clear();
  void deleteErrors();
  void checkNoInputDelay();
  void checkNoOutputDelay();
  void checkRegClks(bool reg_multiple_clks,
                    bool reg_no_clks);
  void checkUnconstrainedEndpoints();
  bool hasClkedArrival(Vertex *vertex);
  void checkNoOutputDelay(PinSet &no_departure);
  void checkUnconstrainedOutputs(PinSet &unconstrained_ends);
  void checkUnconstrainedSetups(PinSet &unconstrained_ends);
  void checkLoops();
  bool hasClkedDepature(Pin *pin);
  bool hasClkedCheck(Vertex *vertex);
  bool hasMaxDelay(Pin *pin);
  void checkGeneratedClocks();
  void pushPinErrors(std::string_view msg,
                     PinSet &pins);
  void pushClkErrors(const char *msg,
                     ClockSet &clks);

  CheckErrorSeq errors_;
  const Mode *mode_{nullptr};
  const Sdc *sdc_{nullptr};
  const Sim *sim_{nullptr};
  const ClkNetwork *clk_network_{nullptr};
};

} // namespace sta
