//
// hfstools - a Macintosh filesystem access tool
// (C) Copyright 1993 by Equivalence
//
// This file part of hfs.
//
// hfs is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2, or (at your option)
// any later version.
// 
// hfs 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 hfs; see the file COPYING.  If not, write to
// the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  
//
//
// $Id: volume.h,v 1.9 1994/07/08 12:00:59 craigs Exp $
// $Log: volume.h,v $
// Revision 1.9  1994/07/08  12:00:59  craigs
// Fixed problem with displaying misleading error messages
// Changed part command to display drive name rather than partition name
//
// Revision 1.8  1994/07/02  05:04:21  craigs
// Added support for CDROM drives under MSDOS
//
// Revision 1.7  1994/06/30  14:54:31  craigs
// Removed return value to EnumeratePartitions
//
// Revision 1.6  1994/06/30  14:39:24  craigs
// Changes for bigger blocks and partitions
//
// Revision 1.5  1994/01/11  00:45:48  craigs
// Added InvalidateCache call so Filesystem::Unmount will work properly
//
// Revision 1.4  1994/01/06  03:05:08  craigs
// Final checkin to include GNU header
//
// Revision 1.3  1993/11/24  21:36:05  craigs
// Various changes remove warnings under MSDOS/NT
//     by robertj
//
// Revision 1.2  1993/11/23  20:18:16  craigs
// Added MSDOS/Windows compatibility
//     by robertj
//
// Revision 1.1  1993/11/22  22:27:51  craigs
// Initial revision
//
//
//

#ifndef _VOLUME_H
#define _VOLUME_H

#if defined(WIN32)
#include <stdarg.h>
#include <windef.h>
#include <winbase.h>
#include <winioctl.h>
#endif

#include "mac.h"
#include "misc.h"

//////////////////////////////////////////////
//
//  Volume
//  A volume is a single disk/file/partition that contains a 
//      Macintosh filesystem 
//

class Volume {
  public:
    enum { LogicalBlockShift = 9 };
      // number of bits to shift a logical block number right
      // to make a byte offset

    enum { LogicalBlockSize = 512 };
      // size of a logical block in bytes

    Volume(const char * newDeviceName);
      // save the name of the volume about to be created

    int EnumeratePartitions(BOOL showAll);
      // enumerate the partitions on the volume

    int Mount(int partition);
      // mount the volume

    int Unmount() { return 0; }
      // unmount the volume

    virtual int Read (ULONG logical_block, void * buffer) = 0;
      // read a logical block

    virtual int Write (ULONG logical_block, void * buffer) = 0;
      // write a logical block

    virtual inline void InvalidateCache()  { }
      // invalidate the cache - used when the disk is refreshed

    MDB mdb;       
      // copy of MDB for disk

    protected:
      int    block_count;
      ULONG  partitionOffset;
      char * deviceName;
      char * partitionName;
};


//////////////////////////////////////////////
//
//  FileVolume
//  A Macintosh filesystem mounted inside a host system file
//

class FileVolume : public Volume {
  public:
    FileVolume(const char * device_name);

    virtual ~FileVolume();

    int Read  (ULONG logical_block, void * buffer);

    int Write (ULONG logical_block, void * buffer);

  private:
    int fd;
};


//////////////////////////////////////////////
//
//  DeviceVolume
//  A Macintosh filesystem mounted on a device
//

class DeviceVolume : public Volume {
  public:
    DeviceVolume(const char * device_name);

    BOOL Read  (ULONG logical_block, void * buffer);

    BOOL Write (ULONG logical_block, void * buffer);

    void InvalidateCache();

    static BOOL IsDeviceName(const char * devname);

  private:
    enum { CacheSize = 20 };
    struct Cache {
      ULONG block;
      ULONG lastUsed;
      char  buffer[LogicalBlockSize];
    } cache[CacheSize];
    ULONG countLRU;
    
#if defined(_MSDOS)
    BOOL isCDROM;
    UINT driveNum, numHeads, numTracks, numSectors;
#elif defined(WIN32)
    HANDLE hDrive;
#else
    int fd;
#endif
};

#endif