sc_event.hh revision 12924
112837Sgabeblack@google.com/* 212837Sgabeblack@google.com * Copyright 2018 Google, Inc. 312837Sgabeblack@google.com * 412837Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512837Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612837Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712837Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812837Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912837Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012837Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112837Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212837Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312837Sgabeblack@google.com * this software without specific prior written permission. 1412837Sgabeblack@google.com * 1512837Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612837Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712837Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812837Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912837Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012837Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112837Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212837Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312837Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412837Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512837Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612837Sgabeblack@google.com * 2712837Sgabeblack@google.com * Authors: Gabe Black 2812837Sgabeblack@google.com */ 2912837Sgabeblack@google.com 3012837Sgabeblack@google.com#ifndef __SYSTEMC_EXT_CORE_SC_EVENT_HH__ 3112837Sgabeblack@google.com#define __SYSTEMC_EXT_CORE_SC_EVENT_HH__ 3212837Sgabeblack@google.com 3312837Sgabeblack@google.com#include <vector> 3412837Sgabeblack@google.com 3512837Sgabeblack@google.com#include "sc_time.hh" 3612837Sgabeblack@google.com 3712837Sgabeblack@google.comnamespace sc_core 3812837Sgabeblack@google.com{ 3912837Sgabeblack@google.com 4012837Sgabeblack@google.comclass sc_event; 4112837Sgabeblack@google.comclass sc_event_and_expr; 4212837Sgabeblack@google.comclass sc_event_or_expr; 4312924Sgabeblack@google.comclass sc_interface; 4412837Sgabeblack@google.comclass sc_object; 4512837Sgabeblack@google.comclass sc_port_base; 4612837Sgabeblack@google.com 4712837Sgabeblack@google.comclass sc_event_finder 4812837Sgabeblack@google.com{ 4912837Sgabeblack@google.com protected: 5012837Sgabeblack@google.com void warn_unimpl(const char *func) const; 5112924Sgabeblack@google.com 5212924Sgabeblack@google.com public: 5312924Sgabeblack@google.com // Should be "implementation defined" but used in the tests. 5412924Sgabeblack@google.com virtual const sc_event &find_event(sc_interface *if_p=NULL) const = 0; 5512837Sgabeblack@google.com}; 5612837Sgabeblack@google.com 5712837Sgabeblack@google.comtemplate <class IF> 5812837Sgabeblack@google.comclass sc_event_finder_t : public sc_event_finder 5912837Sgabeblack@google.com{ 6012837Sgabeblack@google.com public: 6112837Sgabeblack@google.com sc_event_finder_t(const sc_port_base &, 6212837Sgabeblack@google.com const sc_event & (IF::*event_method)() const) 6312837Sgabeblack@google.com { 6412837Sgabeblack@google.com warn_unimpl(__PRETTY_FUNCTION__); 6512837Sgabeblack@google.com } 6612924Sgabeblack@google.com 6712924Sgabeblack@google.com const sc_event & 6812924Sgabeblack@google.com find_event(sc_interface *if_p=NULL) const override 6912924Sgabeblack@google.com { 7012924Sgabeblack@google.com warn_unimpl(__PRETTY_FUNCTION__); 7112924Sgabeblack@google.com return *(const sc_event *)nullptr; 7212924Sgabeblack@google.com } 7312837Sgabeblack@google.com}; 7412837Sgabeblack@google.com 7512837Sgabeblack@google.comclass sc_event_and_list 7612837Sgabeblack@google.com{ 7712837Sgabeblack@google.com public: 7812837Sgabeblack@google.com sc_event_and_list(); 7912837Sgabeblack@google.com sc_event_and_list(const sc_event_and_list &); 8012837Sgabeblack@google.com sc_event_and_list(const sc_event &); 8112837Sgabeblack@google.com sc_event_and_list &operator = (const sc_event_and_list &); 8212837Sgabeblack@google.com 8312837Sgabeblack@google.com int size() const; 8412837Sgabeblack@google.com void swap(sc_event_and_list &); 8512837Sgabeblack@google.com 8612837Sgabeblack@google.com sc_event_and_list &operator &= (const sc_event &); 8712837Sgabeblack@google.com sc_event_and_list &operator &= (const sc_event_and_list &); 8812837Sgabeblack@google.com 8912837Sgabeblack@google.com sc_event_and_expr operator & (const sc_event &) const; 9012837Sgabeblack@google.com sc_event_and_expr operator & (const sc_event_and_list &); 9112837Sgabeblack@google.com}; 9212837Sgabeblack@google.com 9312837Sgabeblack@google.comclass sc_event_or_list 9412837Sgabeblack@google.com{ 9512837Sgabeblack@google.com public: 9612837Sgabeblack@google.com sc_event_or_list(); 9712837Sgabeblack@google.com sc_event_or_list(const sc_event_or_list &); 9812837Sgabeblack@google.com sc_event_or_list(const sc_event &); 9912837Sgabeblack@google.com sc_event_or_list& operator = (const sc_event_or_list &); 10012837Sgabeblack@google.com ~sc_event_or_list(); 10112837Sgabeblack@google.com 10212837Sgabeblack@google.com int size() const; 10312837Sgabeblack@google.com void swap(sc_event_or_list &); 10412837Sgabeblack@google.com 10512837Sgabeblack@google.com sc_event_or_list &operator |= (const sc_event &); 10612837Sgabeblack@google.com sc_event_or_list &operator |= (const sc_event_or_list &); 10712837Sgabeblack@google.com 10812837Sgabeblack@google.com sc_event_or_expr operator | (const sc_event &) const; 10912837Sgabeblack@google.com sc_event_or_expr operator | (const sc_event_or_list &) const; 11012837Sgabeblack@google.com}; 11112837Sgabeblack@google.com 11212837Sgabeblack@google.comclass sc_event_and_expr 11312837Sgabeblack@google.com{ 11412837Sgabeblack@google.com public: 11512837Sgabeblack@google.com operator const sc_event_and_list &() const; 11612837Sgabeblack@google.com}; 11712837Sgabeblack@google.com 11812837Sgabeblack@google.comsc_event_and_expr operator & (sc_event_and_expr, sc_event const &); 11912837Sgabeblack@google.comsc_event_and_expr operator & (sc_event_and_expr, sc_event_and_list const &); 12012837Sgabeblack@google.com 12112837Sgabeblack@google.comclass sc_event_or_expr 12212837Sgabeblack@google.com{ 12312837Sgabeblack@google.com public: 12412837Sgabeblack@google.com operator const sc_event_or_list &() const; 12512837Sgabeblack@google.com}; 12612837Sgabeblack@google.com 12712837Sgabeblack@google.comsc_event_or_expr operator | (sc_event_or_expr, sc_event const &); 12812837Sgabeblack@google.comsc_event_or_expr operator | (sc_event_or_expr, sc_event_or_list const &); 12912837Sgabeblack@google.com 13012837Sgabeblack@google.comclass sc_event 13112837Sgabeblack@google.com{ 13212837Sgabeblack@google.com public: 13312837Sgabeblack@google.com sc_event(); 13412837Sgabeblack@google.com explicit sc_event(const char *); 13512837Sgabeblack@google.com ~sc_event(); 13612837Sgabeblack@google.com 13712837Sgabeblack@google.com const char *name() const; 13812837Sgabeblack@google.com const char *basename() const; 13912837Sgabeblack@google.com bool in_hierarchy() const; 14012837Sgabeblack@google.com sc_object *get_parent_object() const; 14112837Sgabeblack@google.com 14212837Sgabeblack@google.com void notify(); 14312837Sgabeblack@google.com void notify(const sc_time &); 14412837Sgabeblack@google.com void notify(double, sc_time_unit); 14512837Sgabeblack@google.com void cancel(); 14612837Sgabeblack@google.com 14712900Sgabeblack@google.com // Nonstandard 14812900Sgabeblack@google.com // Returns whether this event is currently triggered. 14912900Sgabeblack@google.com bool triggered() const; 15012900Sgabeblack@google.com 15112915Sgabeblack@google.com // Deprecated 15212915Sgabeblack@google.com void notify_delayed(); 15312915Sgabeblack@google.com void notify_delayed(const sc_time &); 15412915Sgabeblack@google.com 15512837Sgabeblack@google.com sc_event_and_expr operator & (const sc_event &) const; 15612837Sgabeblack@google.com sc_event_and_expr operator & (const sc_event_and_list &) const; 15712837Sgabeblack@google.com sc_event_or_expr operator | (const sc_event &) const; 15812837Sgabeblack@google.com sc_event_or_expr operator | (const sc_event_or_list &) const; 15912837Sgabeblack@google.com 16012837Sgabeblack@google.com private: 16112837Sgabeblack@google.com // Disabled 16212837Sgabeblack@google.com sc_event(const sc_event &) {} 16312837Sgabeblack@google.com sc_event &operator = (const sc_event &) { return *this; } 16412837Sgabeblack@google.com}; 16512837Sgabeblack@google.com 16612837Sgabeblack@google.comconst std::vector<sc_event *> &sc_get_top_level_events(); 16712837Sgabeblack@google.comsc_event *sc_find_event(const char *); 16812837Sgabeblack@google.com 16912837Sgabeblack@google.com} // namespace sc_core 17012837Sgabeblack@google.com 17112837Sgabeblack@google.com#endif //__SYSTEMC_EXT_CORE_SC_INTERFACE_HH__ 172