port.h

// Copyright 2018-2019 Delft University of Technology
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <memory>
#include <string>
 
#include "cerata/node.h"
 
namespace cerata {
 
class Term {
 public:
  enum Dir { IN, OUT };
 
  static Dir Reverse(Dir dir);
 
  [[nodiscard]] inline Dir dir() const { return dir_; }
 
  explicit Term(Dir dir) : dir_(dir) {}
 
  inline bool IsInput() { return dir_ == IN; }
  inline bool IsOutput() { return dir_ == OUT; }
 
  static std::string str(Dir dir);
 
 protected:
  Dir dir_;
};
 
class Port : public NormalNode, public Synchronous, public Term {
 public:
  Port(std::string name, std::shared_ptr<Type> type, Term::Dir dir, std::shared_ptr<ClockDomain> domain);
  std::shared_ptr<Object> Copy() const override;
  Port &Reverse();
 
  std::string ToString() const override;
};
 
std::shared_ptr<Port> port(const std::string &name,
                           const std::shared_ptr<Type> &type,
                           Term::Dir dir,
                           const std::shared_ptr<ClockDomain> &domain = default_domain());
std::shared_ptr<Port> port(const std::shared_ptr<Type> &type,
                           Term::Dir dir,
                           const std::shared_ptr<ClockDomain> &domain = default_domain());
 
}  // namespace cerata