/home/gian/Progetti/falcon/core/include/falcon/sequence.h

Go to the documentation of this file.

/*
   FALCON - The Falcon Programming Language.
   FILE: sequence.h

   Definition of abstract sequence class.
   -------------------------------------------------------------------
   Author: Giancarlo Niccolai
   Begin: 2007-12-01

   -------------------------------------------------------------------
   (C) Copyright 2004: the FALCON developers (see list in AUTHORS file)

   See LICENSE file for licensing details.
*/

#ifndef flc_sequence_H
#define flc_sequence_H

#include <falcon/setup.h>
#include <falcon/falcondata.h>

namespace Falcon {

class VMachine;
class Iterator;
class Item;
class Garbageable;

class FALCON_DYN_CLASS Sequence: public FalconData
{
   Garbageable* m_owner;
protected:
   mutable Iterator* m_iterList;

public:
   Sequence():
      m_owner(0),
      m_iterList(0)
      {}
      
   virtual ~Sequence()
   {
      invalidateAllIters();
   }
   
   void invalidateAllIters();
   
   void invalidateAnyOtherIter( Iterator* iter );
   
   virtual void invalidateIteratorOnCriterion() const;
   
   virtual bool onCriterion( Iterator* elem ) const {return false;}
   

   virtual bool isSequence() const { return true; }

   virtual bool isDictionary() const { return false; }

   virtual const Item &front() const = 0;

   virtual const Item &back() const = 0;

   virtual void clear() = 0;

   virtual bool empty() const =0;

   virtual void append( const Item &data ) = 0;

   virtual void prepend( const Item &data ) = 0;

   virtual void comprehension( VMachine* vm, const Item& compounder, const Item& filter );

   void owner( Garbageable* owner ) { m_owner = owner; }
   Garbageable* owner() { return m_owner; }
   virtual void gcMark( uint32 gen );

   //==============================================================
   // Iterator management
   //

protected:
   friend class Iterator;

   virtual void getIterator( Iterator& tgt, bool tail = false ) const;

   virtual void copyIterator( Iterator& tgt, const Iterator& source ) const;

   virtual void disposeIterator( Iterator& tgt ) const;
   

   virtual void insert( Iterator &iter, const Item &data ) = 0;

   virtual void erase( Iterator &iter ) = 0;
   virtual bool hasNext( const Iterator &iter ) const = 0;
   virtual bool hasPrev( const Iterator &iter ) const = 0;
   virtual bool hasCurrent( const Iterator &iter ) const = 0;

   virtual bool next( Iterator &iter ) const = 0;
   virtual bool prev( Iterator &iter ) const = 0;

   virtual Item& getCurrent( const Iterator &iter ) = 0;
   virtual Item& getCurrentKey( const Iterator &iter ) = 0;

   virtual bool equalIterator( const Iterator &first, const Iterator &second ) const = 0;

};

}

#endif

/* end of sequence.h */

---