Changeset 5109:4f9fc788fe91 in roaraudio for include/libroar/buffer.h


Ignore:
Timestamp:
07/28/11 16:32:34 (13 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

Started to use compiler attributes (Also see: #130)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • include/libroar/buffer.h

    r5011 r5109  
    5151#define ROAR_BUFFER_RESET                   1 
    5252 
     53#define _LIBROAR_BUFFER_STDATTRS _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL 
     54 
    5355struct roar_buffer; 
    5456 
     
    6567#define roar_buffer_free(x)    roar_buffer_unref(x) 
    6668 
    67 int roar_buffer_new_no_ma(struct roar_buffer ** buf, size_t len, void * data); // no internal malloc 
    68 int roar_buffer_delete   (struct roar_buffer *  buf, struct roar_buffer ** next); 
    69 int roar_buffer_add      (struct roar_buffer *  buf, struct roar_buffer *  next); 
     69int roar_buffer_new_no_ma(struct roar_buffer ** buf, size_t len, void * data) _LIBROAR_BUFFER_STDATTRS; // no internal malloc 
     70int roar_buffer_delete   (struct roar_buffer *  buf, struct roar_buffer ** next) _LIBROAR_BUFFER_STDATTRS; 
     71int roar_buffer_add      (struct roar_buffer *  buf, struct roar_buffer *  next) _LIBROAR_BUFFER_STDATTRS; 
    7072 
    71 int roar_buffer_ref      (struct roar_buffer *  buf); 
    72 int roar_buffer_unref    (struct roar_buffer *  buf); 
     73int roar_buffer_ref      (struct roar_buffer *  buf) _LIBROAR_ATTR_NONNULL_ALL; 
     74int roar_buffer_unref    (struct roar_buffer *  buf) _LIBROAR_ATTR_NONNULL_ALL; 
    7375 
    74 int roar_buffer_new_data (struct roar_buffer ** buf, size_t len, void ** data); 
     76int roar_buffer_new_data (struct roar_buffer ** buf, size_t len, void ** data) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1); 
    7577 
    76 int roar_buffer_ring_new (struct roar_buffer ** buf, size_t len, int free_running); 
     78int roar_buffer_ring_new (struct roar_buffer ** buf, size_t len, int free_running) _LIBROAR_BUFFER_STDATTRS; 
    7779 
    78 int roar_buffer_clear_next (struct roar_buffer *  buf); 
    79 int roar_buffer_get_next   (struct roar_buffer *  buf, struct roar_buffer ** next); 
     80int roar_buffer_clear_next (struct roar_buffer *  buf) _LIBROAR_BUFFER_STDATTRS _LIBROAR_ATTR_DEPRECATED; 
     81int roar_buffer_get_next   (struct roar_buffer *  buf, struct roar_buffer ** next) _LIBROAR_BUFFER_STDATTRS; 
    8082 
    81 int roar_buffer_get_data (struct roar_buffer *  buf, void   ** data); 
     83int roar_buffer_get_data (struct roar_buffer *  buf, void   ** data) _LIBROAR_BUFFER_STDATTRS; 
    8284 
    83 int roar_buffer_set_offset (struct roar_buffer *  buf, size_t off); 
     85int roar_buffer_set_offset (struct roar_buffer *  buf, size_t off) _LIBROAR_BUFFER_STDATTRS; 
    8486 
    85 int roar_buffer_shift_out (struct roar_buffer ** buf, void * data, size_t * len); 
     87int roar_buffer_shift_out (struct roar_buffer ** buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; 
    8688 
    87 int roar_buffer_set_meta    (struct roar_buffer *  buf, void    *  meta); 
    88 int roar_buffer_get_meta    (struct roar_buffer *  buf, void    ** meta); 
    89 int roar_buffer_set_meta_i32(struct roar_buffer *  buf, int32_t    meta); 
    90 int roar_buffer_get_meta_i32(struct roar_buffer *  buf, int32_t *  meta); 
     89int roar_buffer_set_meta    (struct roar_buffer *  buf, void    *  meta) _LIBROAR_BUFFER_STDATTRS; 
     90int roar_buffer_get_meta    (struct roar_buffer *  buf, void    ** meta) _LIBROAR_BUFFER_STDATTRS; 
     91int roar_buffer_set_meta_i32(struct roar_buffer *  buf, int32_t    meta) _LIBROAR_BUFFER_STDATTRS; 
     92int roar_buffer_get_meta_i32(struct roar_buffer *  buf, int32_t *  meta) _LIBROAR_BUFFER_STDATTRS; 
    9193 
    92 int roar_buffer_set_type    (struct roar_buffer *  buf, int        type); 
    93 int roar_buffer_get_type    (struct roar_buffer *  buf, int     *  type); 
     94int roar_buffer_set_type    (struct roar_buffer *  buf, int        type) _LIBROAR_BUFFER_STDATTRS; 
     95int roar_buffer_get_type    (struct roar_buffer *  buf, int     *  type) _LIBROAR_BUFFER_STDATTRS; 
    9496 
    95 int roar_buffer_set_len  (struct roar_buffer *  buf, size_t    len); 
    96 int roar_buffer_get_len  (struct roar_buffer *  buf, size_t *  len); 
     97int roar_buffer_set_len  (struct roar_buffer *  buf, size_t    len) _LIBROAR_BUFFER_STDATTRS; 
     98int roar_buffer_get_len  (struct roar_buffer *  buf, size_t *  len) _LIBROAR_BUFFER_STDATTRS; 
    9799 
    98 int roar_buffer_set_flag (struct roar_buffer *  buf, int flag, int reset); 
    99 int roar_buffer_get_flag (struct roar_buffer *  buf, int flag); 
     100int roar_buffer_set_flag (struct roar_buffer *  buf, int flag, int reset) _LIBROAR_BUFFER_STDATTRS; 
     101int roar_buffer_get_flag (struct roar_buffer *  buf, int flag) _LIBROAR_BUFFER_STDATTRS; 
    100102 
    101 int roar_buffer_duplicate (struct roar_buffer *  buf, struct roar_buffer ** copy); 
     103int roar_buffer_duplicate (struct roar_buffer *  buf, struct roar_buffer ** copy) _LIBROAR_BUFFER_STDATTRS; 
    102104 
    103 int roar_buffer_ring_stats (struct roar_buffer *  buf, struct roar_buffer_stats * stats); 
     105int roar_buffer_ring_stats (struct roar_buffer *  buf, struct roar_buffer_stats * stats) _LIBROAR_BUFFER_STDATTRS; 
    104106 
    105 int roar_buffer_ring_read  (struct roar_buffer *  buf, void * data, size_t * len); 
    106 int roar_buffer_ring_write (struct roar_buffer *  buf, void * data, size_t * len); 
     107int roar_buffer_ring_read  (struct roar_buffer *  buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; 
     108int roar_buffer_ring_write (struct roar_buffer *  buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; 
    107109 
    108 int roar_buffer_ring_avail(struct roar_buffer *  buf, size_t * readlen, size_t * writelen); 
     110int roar_buffer_ring_avail(struct roar_buffer *  buf, size_t * readlen, size_t * writelen) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1); 
    109111 
    110 int roar_buffer_ring_reset(struct roar_buffer *  buf); 
     112int roar_buffer_ring_reset(struct roar_buffer *  buf) _LIBROAR_BUFFER_STDATTRS; 
    111113 
    112114#endif 
Note: See TracChangeset for help on using the changeset viewer.