//-*-c++-*-
#ifndef FILEQUEUE_HH
#define FILEQUEUE_HH
// Copyright (c) 1994-1996 Ohio Board of Regents and the University of
// Cincinnati.  All Rights Reserved.

// BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 
// FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT 
// PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, 
// EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
// PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 
// PROGRAM IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME 
// THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 

// IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 
// WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 
// REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR 
// DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL 
// DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM 
// (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED 
// INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF 
// THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER 
// OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 
//
// $Id: FileQueue.hh,v 1.1.1.1 2007/03/15 15:45:06 rmadhoun Exp $
//
//------------------------------------------------------------------------

#include <iostream.h>
#include <fstream.h>
#include <stdlib.h>
#include "SortedList.hh"
#include "FileData.hh"

#include "../../../JackyDebugStream.h"  //for jacky-debug-mode
#ifdef JACKY_DEBUG
#include <string>
#endif

extern int FileDataCompareTime(const FileData*, const FileData*);

class FileQueue : public SortedList<FileData> {
private:
  ostream *outFile;
  // to determine if it is a normal output file or pipe to stdout
  int statusBit;
public:
  FileQueue();
  FileQueue(const char*);
  FileQueue(int);
  virtual ~FileQueue();
  void open(const char*);
  void open(const char*, ios::open_mode);
  void insert(FileData*);
  void gcollect(const VTime&);
  void rollbackTo(const VTime&);
  void close();
  // We instantiate a out file queue for writing output to stdout.  This
  // is done as follows: FileQueue is newed with the constructor having
  // the argument FileQueue::standardOut.  This tells the file queue to
  // output all the data that it recieves to stdout and not to a file.
  // The file id is also accessed as FileQueue::standardOut.
  static int standardOut;

  char* outFileName;
  
#ifdef JACKY_DEBUG 
  //print out the fileQ for debugging purpose  
  void printFileQ(ostream& os); 
  string getOutFileName() const; 
#endif 
  
};
#endif