osflag.h

/******************************************************************************
 
    @file    IntrOS: osflag.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_FLG_H
#define __INTROS_FLG_H
 
#include "oskernel.h"
#include "osclock.h"

 
/* -------------------------------------------------------------------------- */
 
#define flgAny          0U 
#define flgAll          1U 
#define flgNew          2U 
 
#define flgAnyNew     ( flgAny | flgNew  ) 
#define flgAllNew     ( flgAll | flgNew  ) 

 
typedef struct __flg flg_t;
 
struct __flg
{
    obj_t    obj;   
 
    unsigned flags; 
};
 
typedef struct __flg flg_id [];
 
/******************************************************************************
 *
 * Name              : _FLG_INIT
 *
 * Description       : create and initialize a flag object
 *
 * Parameters
 *   init            : initial value of flag
 *
 * Return            : flag object
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _FLG_INIT( _init ) { _OBJ_INIT(), _init }
 
/******************************************************************************
 *
 * Name              : _VA_FLG
 *
 * Description       : calculate initial value of flag from optional parameter
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _VA_FLG( _init ) ( _init + 0 )

 
#define             OS_FLG( flg, ... ) \
                       flg_t flg[] = { _FLG_INIT( _VA_FLG(__VA_ARGS__) ) }

/** static alias of OS_FLG() */
#define         static_FLG( flg, ... ) \
                static flg_t flg[] = { _FLG_INIT( _VA_FLG(__VA_ARGS__) ) }

 
#ifndef __cplusplus
#define                FLG_INIT( ... ) \
                      _FLG_INIT( _VA_FLG(__VA_ARGS__) )
#endif

 
#ifndef __cplusplus
#define                FLG_CREATE( ... ) \
                     { FLG_INIT  ( _VA_FLG(__VA_ARGS__) ) }
/** alias of FLG_CREATE() */
#define                FLG_NEW \
                       FLG_CREATE
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

 
void flg_init( flg_t *flg, unsigned init );

 
void flg_reset( flg_t *flg );

__STATIC_INLINE
void flg_kill( flg_t *flg ) { flg_reset(flg); }

 
unsigned flg_take( flg_t *flg, unsigned flags, unsigned mode );

__STATIC_INLINE
unsigned flg_tryWait( flg_t *flg, unsigned flags, unsigned mode ) { return flg_take(flg, flags, mode); }

 
int flg_waitFor( flg_t *flg, unsigned flags, unsigned mode, cnt_t delay );

 
int flg_waitUntil( flg_t *flg, unsigned flags, unsigned mode, cnt_t time );

 
__STATIC_INLINE
int flg_wait( flg_t *flg, unsigned flags, unsigned mode ) { return flg_waitFor(flg, flags, mode, INFINITE); }

 
unsigned flg_give( flg_t *flg, unsigned flags );

__STATIC_INLINE
unsigned flg_set( flg_t *flg, unsigned flags ) { return flg_give(flg, flags); }

 
unsigned flg_clear( flg_t *flg, unsigned flags );

 
unsigned flg_get( flg_t *flg );
 
#ifdef __cplusplus
}
#endif
 
/* -------------------------------------------------------------------------- */
 
#if defined(__cplusplus)
namespace intros {

 
struct Flag : public __flg
{
    constexpr
    Flag( const unsigned _init = 0 ): __flg _FLG_INIT(_init) {}
 
    ~Flag() { assert(__flg::obj.queue == nullptr); }

    /// move constructor
    Flag( Flag&& _src ): __flg(_src)
    {
        assert(_src.obj.queue == nullptr);
    }
 
    Flag( const Flag& ) = delete;
    Flag& operator=( Flag&& ) = delete;
    Flag& operator=( const Flag& ) = delete;
 
    void     reset    ()                                                   {        flg_reset    (this); }                                      
    void     kill     ()                                                   {        flg_kill     (this); }                                      
    unsigned take     ( unsigned _flags, unsigned _mode = flgAll )         { return flg_take     (this, _flags, _mode); }                       
    unsigned tryWait  ( unsigned _flags, unsigned _mode = flgAll )         { return flg_tryWait  (this, _flags, _mode); }                       
    template<typename T>
    int      waitFor  ( unsigned _flags, unsigned _mode, const T& _delay ) { return flg_waitFor  (this, _flags, _mode, Clock::count(_delay)); } 
    template<typename T>
    int      waitUntil( unsigned _flags, unsigned _mode, const T& _time )  { return flg_waitUntil(this, _flags, _mode, Clock::until(_time)); }  
    int      wait     ( unsigned _flags, unsigned _mode = flgAll )         { return flg_wait     (this, _flags, _mode); }                       
    unsigned give     ( unsigned _flags )                                  { return flg_give     (this, _flags); }                              
    unsigned set      ( unsigned _flags )                                  { return flg_set      (this, _flags); }                              
    unsigned clear    ( unsigned _flags )                                  { return flg_clear    (this, _flags); }                              
    unsigned get      ()                                                   { return flg_get      (this); }                                      
};
 
}     //  namespace
#endif//__cplusplus
 
/* -------------------------------------------------------------------------- */

 
#endif//__INTROS_FLG_H