pjs/string/public/nsSlidingString.h

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/*
 * The contents of this file are subject to the Mozilla Public
 * License Version 1.1 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.mozilla.org/MPL/
 * 
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 * 
 * The Original Code is Mozilla strings.
 * 
 * The Initial Developer of the Original Code is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 2000 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s):
 *   Scott Collins <scc@mozilla.org> (original author)
 *
 */

#ifndef nsSlidingString_h___
#define nsSlidingString_h___

#include "nsAReadableString.h"
#include "nsSharedBufferList.h"


  /**
   * Maintains the sequence from the prev-most referenced buffer to the last buffer.
   * As prev-most buffers become un-referenced, they are unlinked from the list
   * and destroyed.
   *
   * One or more |nsSlidingSubstring|s may reference into the list.  Each |nsSlidingSubstring|
   * holds a reference into the prev-most buffer intersecting the 
   * substring it describes.  The destructor of a |nsSlidingSubstring| releases this
   * reference, allowing the buffer list to destroy the contiguous prefix of
   * unreferenced buffers.
   *
   * A single instance of |nsSlidingString| may reference this list.
   * Through that interface, new data can be appended onto the next-most end
   * of the list.  |nsSlidingString| also the client to advance its starting point.
   * 
   */
class nsSlidingSharedBufferList
    : public nsSharedBufferList
  {
    public:
      nsSlidingSharedBufferList( Buffer* aBuffer ) : nsSharedBufferList(aBuffer), mRefCount(0) { }

      void  AcquireReference()    { ++mRefCount; }
      void  ReleaseReference()    { if ( !--mRefCount ) delete this; }

      void  DiscardUnreferencedPrefix( Buffer* );

    private:
      PRUint32 mRefCount;
  };





  /**
   * a substring over a buffer list, this 
   */
class nsSlidingSubstring
     : public nsPromiseReadable<PRUnichar>
  {
    friend class nsSlidingSharedBufferList;

    public:
      nsSlidingSubstring( nsSlidingSharedBufferList& aBufferList, const nsSharedBufferList::Position& aStart, const nsSharedBufferList::Position& aEnd );
      nsSlidingSubstring( nsSlidingSharedBufferList& aBufferList );
     ~nsSlidingSubstring();

      // need to take care of
      //  copy-constructor
      //  copy-assignment

      virtual PRUint32 Length() const { return mLength; }

    protected:
      virtual const PRUnichar* GetReadableFragment( nsReadableFragment<PRUnichar>&, nsFragmentRequest, PRUint32 ) const;
      
    protected:
      nsSharedBufferList::Position  mStart;
      nsSharedBufferList::Position  mEnd;
      nsSlidingSharedBufferList&    mBufferList;
      PRUint32                      mLength;
  };




  /**
   * An |nsSlidingSharedBufferList| may be modified by zero or one instances of this class.
   *  
   */
class nsSlidingString
    : public nsSlidingSubstring
  {
    public:
      nsSlidingString( PRUnichar* aStorageStart, PRUnichar* aDataEnd, PRUnichar* aStorageEnd );

        // you are giving ownership to the string, it takes and keeps your buffer, deleting it when done
      void AppendBuffer( PRUnichar* aStorageStart, PRUnichar* aDataEnd, PRUnichar* aStorageEnd );
//    void Append( ... ); do you want some |Append|s that copy the supplied data?

      void DiscardPrefix( const nsReadingIterator<PRUnichar>& );
        // any other way you want to do this?
  };


#if 0
  // this (or something similar) is what should appear in the parser, I think
#include "nsSlidingString.h"

typedef nsSlidingString     nsParserString;
typedef nsSlidingSubstring  nsParserToken;
#endif

#endif // !defined(nsSlidingString_h___)