oslist.h

/******************************************************************************
 
    @file    IntrOS: oslist.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_LST_H
#define __INTROS_LST_H
 
#include "oskernel.h"
#include "osclock.h"


 
typedef struct __que que_t;
 
struct __que
{
    que_t *  next; 
};
 
/******************************************************************************
 *
 * Name              : _QUE_INIT
 *
 * Description       : create and initialize a queue object
 *
 * Parameters        : none
 *
 * Return            : queue object
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _QUE_INIT() { NULL }

 
typedef struct __lst lst_t;
 
struct __lst
{
    obj_t    obj;   
 
    que_t    head;  
};
 
typedef struct __lst lst_id [];
 
/******************************************************************************
 *
 * Name              : _LST_INIT
 *
 * Description       : create and initialize a list object
 *
 * Parameters        : none
 *
 * Return            : list object
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _LST_INIT() { _OBJ_INIT(), _QUE_INIT() }

 
#define             OS_LST( lst ) \
                       lst_t lst[] = { _LST_INIT() }

/** static alias of OS_LST() */
#define         static_LST( lst ) \
                static lst_t lst[] = { _LST_INIT() }

 
#ifndef __cplusplus
#define                LST_INIT() \
                      _LST_INIT()
#endif

 
#ifndef __cplusplus
#define                LST_CREATE() \
                     { LST_INIT  () }
/** alias of LST_CREATE() */
#define                LST_NEW \
                       LST_CREATE
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

 
void lst_init( lst_t *lst );

 
void lst_reset( lst_t *lst );

__STATIC_INLINE
void lst_kill( lst_t *lst ) { lst_reset(lst); }

 
int lst_take( lst_t *lst, void **data );

__STATIC_INLINE
int lst_tryWait( lst_t *lst, void **data ) { return lst_take(lst, data); }

 
int lst_waitFor( lst_t *lst, void **data, cnt_t delay );

 
int lst_waitUntil( lst_t *lst, void **data, cnt_t time );

 
__STATIC_INLINE
int lst_wait( lst_t *lst, void **data ) { return lst_waitFor(lst, data, INFINITE); }

 
void lst_give( lst_t *lst, void *data );
 
#ifdef __cplusplus
}
#endif
 
/* -------------------------------------------------------------------------- */
 
#if defined(__cplusplus)
namespace intros {

 
template<class C>
struct ListTT : public __lst
{
    constexpr
    ListTT(): __lst _LST_INIT() {}
 
    ~ListTT() { assert(__lst::obj.queue == nullptr); }

    /// move constructor
    ListTT( ListTT&& _src ): __lst(_src)
    {
        assert(_src.obj.queue == nullptr && _src.head.next == nullptr);
    }
 
    ListTT( const ListTT& ) = delete;
    ListTT& operator=( ListTT&& ) = delete;
    ListTT& operator=( const ListTT& ) = delete;
 
    void reset    ()                               {        lst_reset    (this); }                                                         
    void kill     ()                               {        lst_kill     (this); }                                                         
    int  take     ( C   **_data )                  { return lst_take     (this, reinterpret_cast<void **>(_data)); }                       
    int  tryWait  ( C   **_data )                  { return lst_tryWait  (this, reinterpret_cast<void **>(_data)); }                       
    template<typename T>
    int  waitFor  ( C   **_data, const T& _delay ) { return lst_waitFor  (this, reinterpret_cast<void **>(_data), Clock::count(_delay)); } 
    template<typename T>
    int  waitUntil( C   **_data, const T& _time )  { return lst_waitUntil(this, reinterpret_cast<void **>(_data), Clock::until(_time)); }  
    int  wait     ( C   **_data )                  { return lst_wait     (this, reinterpret_cast<void **>(_data)); }                       
    void give     ( void *_data )                  {        lst_give     (this,                           _data); }                        
};

 
using List = ListTT<void>;
 
}     //  namespace
#endif//__cplusplus
 
/* -------------------------------------------------------------------------- */

 
#endif//__INTROS_LST_H