osevent.h

/******************************************************************************
 
    @file    IntrOS: osevent.h
    @author  Rajmund Szymanski
    @date    17.11.2025
    @brief   This file contains definitions for IntrOS.
 
 ******************************************************************************
 
   Copyright (c) 2018-2022 Rajmund Szymanski. All rights reserved.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to
   deal in the Software without restriction, including without limitation the
   rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   sell copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
   IN THE SOFTWARE.
 
 ******************************************************************************/
 
#ifndef __INTROS_EVT_H
#define __INTROS_EVT_H
 
#include "oskernel.h"
#include "osclock.h"


 
typedef struct __evt evt_t;
 
struct __evt
{
    obj_t    obj;   
};
 
typedef struct __evt evt_id [];
 
/******************************************************************************
 *
 * Name              : _EVT_INIT
 *
 * Description       : create and initialize an event object
 *
 * Parameters        : none
 *
 * Return            : event object
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _EVT_INIT() { _OBJ_INIT() }

 
#define             OS_EVT( evt ) \
                       evt_t evt[] = { _EVT_INIT() }

/** static alias of OS_EVT() */
#define         static_EVT( evt ) \
                static evt_t evt[] = { _EVT_INIT() }

 
#ifndef __cplusplus
#define                EVT_INIT() \
                      _EVT_INIT()
#endif

 
#ifndef __cplusplus
#define                EVT_CREATE() \
                     { EVT_INIT  () }
/** alias of EVT_CREATE() */
#define                EVT_NEW \
                       EVT_CREATE
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

 
void evt_init( evt_t *evt );

 
void evt_reset( evt_t *evt );

__STATIC_INLINE
void evt_kill( evt_t *evt ) { evt_reset(evt); }

 
int evt_waitFor( evt_t *evt, unsigned *event, cnt_t delay );

 
int evt_waitUntil( evt_t *evt, unsigned *event, cnt_t time );

 
__STATIC_INLINE
int evt_wait( evt_t *evt, unsigned *event ) { return evt_waitFor(evt, event, INFINITE); }

 
void evt_give( evt_t *evt, unsigned event );
 
#ifdef __cplusplus
}
#endif
 
/* -------------------------------------------------------------------------- */
 
#if defined(__cplusplus)
namespace intros {

 
struct Event : public __evt
{
    constexpr
    Event(): __evt _EVT_INIT() {}
 
    ~Event() { assert(__evt::obj.queue == nullptr); }

    /// move constructor
    Event( Event&& _src ): __evt(_src)
    {
        assert(_src.obj.queue == nullptr);
    }
 
    Event( const Event& ) = delete;
    Event& operator=( Event&& ) = delete;
    Event& operator=( const Event& ) = delete;
 
    void reset    ()                                    {        evt_reset    (this); }                                
    void kill     ()                                    {        evt_kill     (this); }                                
    template<typename T>
    int  waitFor  ( unsigned *_event, const T& _delay ) { return evt_waitFor  (this,  _event, Clock::count(_delay)); } 
    template<typename T>
    int  waitFor  ( unsigned &_event, const T& _delay ) { return evt_waitFor  (this, &_event, Clock::count(_delay)); } 
    template<typename T>
    int  waitUntil( unsigned *_event, const T& _time )  { return evt_waitUntil(this,  _event, Clock::until(_time)); }  
    template<typename T>
    int  waitUntil( unsigned &_event, const T& _time )  { return evt_waitUntil(this, &_event, Clock::until(_time)); }  
    int  wait     ( unsigned *_event = nullptr )        { return evt_wait     (this,  _event); }                       
    int  wait     ( unsigned &_event )                  { return evt_wait     (this, &_event); }                       
    void give     ( unsigned  _event )                  {        evt_give     (this,  _event); }                       
 
};
 
}     //  namespace
#endif//__cplusplus
 
/* -------------------------------------------------------------------------- */

 
#endif//__INTROS_EVT_H