osrawbuffer.h

/******************************************************************************
 
    @file    IntrOS: osrawbuffer.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_RAW_H
#define __INTROS_RAW_H
 
#include "oskernel.h"
#include "osclock.h"


 
typedef struct __raw raw_t;
 
struct __raw
{
    obj_t    obj;   
 
    size_t   count; 
    size_t   limit; 
 
    size_t   head;  
    size_t   tail;  
    char *   data;  
};
 
typedef struct __raw raw_id [];
 
/******************************************************************************
 *
 * Name              : _RAW_INIT
 *
 * Description       : create and initialize a raw buffer object
 *
 * Parameters
 *   limit           : size of a buffer (max number of stored bytes)
 *   data            : raw buffer data
 *
 * Return            : raw buffer object
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _RAW_INIT( _limit, _data ) { _OBJ_INIT(), 0, _limit, 0, 0, _data }
 
/******************************************************************************
 *
 * Name              : _RAW_DATA
 *
 * Description       : create a raw buffer data
 *
 * Parameters
 *   limit           : size of a buffer (max number of stored bytes)
 *
 * Return            : raw buffer data
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#ifndef __cplusplus
#define               _RAW_DATA( _limit ) (char[_limit]){ 0 }
#endif
 
/******************************************************************************
 *
 * Name              : _VA_RAW
 *
 * Description       : calculate buffer size from optional parameter
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _VA_RAW( _limit, _size ) ( (_size + 0) ? ((_limit) * (_size + 0)) : (_limit) )

 
#define             OS_RAW_BUFFER( buf, limit, ... ) \
                       char buf[_VA_RAW(limit, __VA_ARGS__)]

 
#define             OS_RAW( raw, limit, ... )                       \
                static char raw##__buf[_VA_RAW(limit, __VA_ARGS__)]; \
                       raw_t raw[] = { _RAW_INIT( _VA_RAW(limit, __VA_ARGS__), raw##__buf ) }

/** static alias of OS_RAW() */
#define         static_RAW( raw, limit, ... )                       \
                static char raw##__buf[_VA_RAW(limit, __VA_ARGS__)]; \
                static raw_t raw[] = { _RAW_INIT( _VA_RAW(limit, __VA_ARGS__), raw##__buf ) }

 
#ifndef __cplusplus
#define                RAW_INIT( limit, ... ) \
                      _RAW_INIT( _VA_RAW(limit, __VA_ARGS__), _RAW_DATA( _VA_RAW(limit, __VA_ARGS__) ) )
#endif

 
#ifndef __cplusplus
#define                RAW_CREATE( limit, ... ) \
                     { RAW_INIT  ( _VA_RAW(limit, __VA_ARGS__) ) }
/** alias of RAW_CREATE() */
#define                RAW_NEW \
                       RAW_CREATE
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

 
void raw_init( raw_t *raw, void *data, size_t bufsize );

 
void raw_reset( raw_t *raw );

__STATIC_INLINE
void raw_kill( raw_t *raw ) { raw_reset(raw); }

 
int raw_take( raw_t *raw, void *data, size_t size, size_t *read );

__STATIC_INLINE
int raw_tryWait( raw_t *raw, void *data, size_t size, size_t *read ) { return raw_take(raw, data, size, read); }

 
int raw_waitFor( raw_t *raw, void *data, size_t size, size_t *read, cnt_t delay );

 
int raw_waitUntil( raw_t *raw, void *data, size_t size, size_t *read, cnt_t time );

 
__STATIC_INLINE
int raw_wait( raw_t *raw, void *data, size_t size, size_t *read ) { return raw_waitFor(raw, data, size, read, INFINITE); }

 
int raw_give( raw_t *raw, const void *data, size_t size );

 
int raw_sendFor( raw_t *raw, const void *data, size_t size, cnt_t delay );

 
int raw_sendUntil( raw_t *raw, const void *data, size_t size, cnt_t time );

 
__STATIC_INLINE
int raw_send( raw_t *raw, const void *data, size_t size ) { return raw_sendFor(raw, data, size, INFINITE); }

 
int raw_push( raw_t *raw, const void *data, size_t size );

 
size_t raw_count( raw_t *raw );

 
size_t raw_space( raw_t *raw );

 
size_t raw_limit( raw_t *raw );
 
#ifdef __cplusplus
}
#endif
 
/* -------------------------------------------------------------------------- */
 
#if defined(__cplusplus)
namespace intros {

 
template<size_t limit_>
struct RawBufferT : public __raw
{
    constexpr
    RawBufferT(): __raw _RAW_INIT(limit_, data_) {}
 
    ~RawBufferT() { assert(__raw::obj.queue == nullptr); }

    /// move constructor
    RawBufferT( RawBufferT&& _src ): __raw _RAW_INIT(limit_, data_)
    {
        assert(_src.__raw::count == 0 && _src.obj.queue == nullptr);
        (void) _src;
    }
 
    RawBufferT( const RawBufferT& ) = delete;
    RawBufferT& operator=( RawBufferT&& ) = delete;
    RawBufferT& operator=( const RawBufferT& ) = delete;
 
    void   reset    ()                                                                   {        raw_reset    (this); }                                            
    void   kill     ()                                                                   {        raw_kill     (this); }                                            
    int    take     (       void *_data, size_t _size, size_t *_read = nullptr )         { return raw_take     (this, _data, _size, _read); }                       
    int    tryWait  (       void *_data, size_t _size, size_t *_read = nullptr )         { return raw_tryWait  (this, _data, _size, _read); }                       
    template<typename T>
    int    waitFor  (       void *_data, size_t _size, size_t *_read,  const T& _delay ) { return raw_waitFor  (this, _data, _size, _read, Clock::count(_delay)); } 
    template<typename T>
    int    waitUntil(       void *_data, size_t _size, size_t *_read,  const T& _time )  { return raw_waitUntil(this, _data, _size, _read, Clock::until(_time)); }  
    int    wait     (       void *_data, size_t _size, size_t *_read = nullptr )         { return raw_wait     (this, _data, _size, _read); }                       
    int    give     ( const void *_data, size_t _size )                                  { return raw_give     (this, _data, _size); }                              
    template<typename T>
    int    sendFor  ( const void *_data, size_t _size, const T& _delay )                 { return raw_sendFor  (this, _data, _size, Clock::count(_delay)); }        
    template<typename T>
    int    sendUntil( const void *_data, size_t _size, const T& _time )                  { return raw_sendUntil(this, _data, _size, Clock::until(_time)); }         
    int    send     ( const void *_data, size_t _size )                                  { return raw_send     (this, _data, _size); }                              
    int    push     ( const void *_data, size_t _size )                                  { return raw_push     (this, _data, _size); }                              
    size_t count    ()                                                                   { return raw_count    (this); }                                            
    size_t space    ()                                                                   { return raw_space    (this); }                                            
    size_t limit    ()                                                                   { return raw_limit    (this); }                                            
 
    private:
    char data_[limit_];
};

 
template<unsigned limit_, class C>
struct RawBufferTT : public RawBufferT<limit_*sizeof(C)>
{
    constexpr
    RawBufferTT(): RawBufferT<limit_*sizeof(C)>() {}
 
    int take     (       C *_data )                  { return raw_take     (this, _data, sizeof(C), nullptr); }                       
    int tryWait  (       C *_data )                  { return raw_tryWait  (this, _data, sizeof(C), nullptr); }                       
    template<typename T>                               
    int waitFor  (       C *_data, const T& _delay ) { return raw_waitFor  (this, _data, sizeof(C), nullptr, Clock::count(_delay)); } 
    template<typename T>                               
    int waitUntil(       C *_data, const T& _time )  { return raw_waitUntil(this, _data, sizeof(C), nullptr, Clock::until(_time)); }  
    int wait     (       C *_data )                  { return raw_wait     (this, _data, sizeof(C), nullptr); }                       
    int give     ( const C *_data )                  { return raw_give     (this, _data, sizeof(C)); }                                
    template<typename T>                               
    int sendFor  ( const C *_data, const T& _delay ) { return raw_sendFor  (this, _data, sizeof(C), Clock::count(_delay)); }          
    template<typename T>                               
    int sendUntil( const C *_data, const T& _time )  { return raw_sendUntil(this, _data, sizeof(C), Clock::until(_time)); }           
    int send     ( const C *_data )                  { return raw_send     (this, _data, sizeof(C)); }                                
    int push     ( const C *_data )                  { return raw_push     (this, _data, sizeof(C)); }                                
};
 
}     //  namespace
#endif//__cplusplus
 
/* -------------------------------------------------------------------------- */

 
#endif//__INTROS_RAW_H