fifo.h

Go to the documentation of this file.

//    sampalib.org ESL library and tools
//    Copyright (C) 2007  Thierry Grellier
//
//    This program is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License version 2 as
//    published by the Free Software Foundation.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License along
//    with this program; if not, write to the Free Software Foundation, Inc.,
//    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//    contact: www.sampalib.org

#ifndef SAMPA_FIFO_H
#define SAMPA_FIFO_H

#include "sampa/core/object.h"

namespace Sampa {
 
  class Fifo : public Object {
  public:
    Fifo(const Name& name);
    bool  is_empty() const     { return m_size == 0; } 
    bool  is_full() const      { return m_size == get_capacity(); } 
    short peek() const         { return m_rd_ptr & m_depth_mask; } 
    short pop()                { short rd = m_rd_ptr; m_rd_ptr = (m_rd_ptr+1) & m_depth_mask; m_size--; return rd; } 
    short push()               { short wr = m_wr_ptr; m_wr_ptr = (m_wr_ptr+1) & m_depth_mask; m_size++; return wr; } 
    short pushable() const     { return m_size < get_capacity(); } 
    short get_capacity() const { return m_depth_mask + 1; } 
    short get_size() const     { return m_size; } 
    //@cond
  private:
    short m_size;
    short m_rd_ptr;
    short m_wr_ptr;
    short m_depth_mask;
    SAMPA_PERSISTENT(Fifo);
    //@endcond
  };

  class TraceFifo : public Object {
  public:
    TraceFifo(const Name& name);
    bool  is_empty() const     { return m_size == 0; } 
    bool  is_full() const      { return m_size == get_capacity(); } 
    short peek() const         { return m_rd_ptr & m_depth_mask; } 
    short pop();  
    short push(); 
    short pushable() const     { return m_size < get_capacity(); } 
    short get_capacity() const { return m_depth_mask + 1; } 
    short get_size() const     { return m_size; } 
    //@cond
  private:
    short m_size;
    short m_rd_ptr;
    short m_wr_ptr;
    short m_depth_mask;
    SAMPA_PERSISTENT(TraceFifo);
    //@endcond
  };

}

#endif

---