byte-tag-list.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008 INRIA
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef BYTE_TAG_LIST_H
#define BYTE_TAG_LIST_H

#include <stdint.h>
#include "ns3/type-id.h"
#include "tag-buffer.h"

namespace ns3 {

struct ByteTagListData;

class ByteTagList
{
public:
  /*
   * \brief An iterator for iterating through a byte tag list
   *
   * An iterator for iterating through a byte tag list
   *
   */
  class Iterator
  {
public:
    /*
     * \brief An item specifies an individual tag within a byte buffer
     *
     * An item specifies an individual tag within a byte buffer
     *
     */
    struct Item 
    {
      TypeId tid;             
      uint32_t size;          
      int32_t start;          
      int32_t end;            
      TagBuffer buf;          
      Item (TagBuffer buf);   
private:
      friend class ByteTagList;
      friend class ByteTagList::Iterator;
    };
    
    /*
     * \brief Used to determine if the iterator is at the end of the byteTagList
     *
     * \returns true if there are more Items in the list
     */
    bool HasNext (void) const;

    /*
     * \brief Returns the next Item from the ByteTagList
     *
     * \returns the next Item in the ByteTagList
     */        
    struct ByteTagList::Iterator::Item Next (void);
    
    /*
     * \brief Returns the offset from the start of the virtual byte buffer to the ByteTagList
     *
     * \returns offset to the start of this ByteTagList
     */     
    uint32_t GetOffsetStart (void) const;
private:
    friend class ByteTagList;
    Iterator (uint8_t *start, uint8_t *end, int32_t offsetStart, int32_t offsetEnd);
    void PrepareForNext (void);
    uint8_t *m_current;
    uint8_t *m_end;
    int32_t m_offsetStart;
    int32_t m_offsetEnd;
    uint32_t m_nextTid;
    uint32_t m_nextSize;
    int32_t m_nextStart;
    int32_t m_nextEnd;
  };

  ByteTagList ();
  
  ByteTagList (const ByteTagList &o);
  
  ByteTagList &operator = (const ByteTagList &o);
  ~ByteTagList ();

  TagBuffer Add (TypeId tid, uint32_t bufferSize, int32_t start, int32_t end);

  void Add (const ByteTagList &o);

  void RemoveAll (void);

  ByteTagList::Iterator Begin (int32_t offsetStart, int32_t offsetEnd) const;

  void AddAtEnd (int32_t adjustment, int32_t appendOffset);
  void AddAtStart (int32_t adjustment, int32_t prependOffset);

private:
  bool IsDirtyAtEnd (int32_t appendOffset);
  bool IsDirtyAtStart (int32_t prependOffset);
  ByteTagList::Iterator BeginAll (void) const;

  struct ByteTagListData *Allocate (uint32_t size);
  void Deallocate (struct ByteTagListData *data);

  uint16_t m_used;
  struct ByteTagListData *m_data;
};

} // namespace ns3

#endif /* BYTE_TAG_LIST_H */