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

Go to the documentation of this file.

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

   Generic provider of file system abstraction.
   -------------------------------------------------------------------
   Author: Giancarlo Niccolai
   Begin: Thu, 11 Sep 2008 08:58:33 +0200

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

   See LICENSE file for licensing details.
*/

#ifndef flc_vfs_provider_H
#define flc_vfs_provider_H

#include <falcon/setup.h>
#include <falcon/basealloc.h>
#include <falcon/filestat.h>
#include <falcon/dir_sys.h>
#include <falcon/string.h>
#include <falcon/uri.h>

namespace Falcon {

class Error;

class FALCON_DYN_CLASS VFSProvider: public BaseAlloc
{
   String m_servedProto;

protected:
   VFSProvider( const String &name ):
      m_servedProto( name )
   {}

public:
   virtual ~VFSProvider();

   class OParams {
      uint32 m_oflags;
      uint32 m_shflags;
      friend class VSFProvider;

   public:
      OParams():
         m_oflags(0),
         m_shflags(0)
      {}

      OParams& rdOnly() { m_oflags |= 0x1; return *this; }
      bool isRdOnly() const { return (m_oflags & 0x1) == 0x1; }

      OParams& wrOnly() { m_oflags |= 0x2; return *this; }
      bool isWrOnly() const { return (m_oflags & 0x2) == 0x2; }

      OParams& rdwr() { m_oflags |= 0x3; return *this; }
      bool isRdwr() const { return (m_oflags & 0x3) == 0x3; }

      OParams& append() { m_oflags |= 0x4; return *this; }
      bool isAppend() const { return (m_oflags & 0x4) == 0x4; }

      OParams& truncate() { m_oflags |= 0x8; return *this; }
      bool isTruncate() const { return (m_oflags & 0x8) == 0x8; }

      OParams& shNoRead() { m_shflags |= 0x1; return *this; }
      bool isShNoRead() const { return (m_shflags & 0x1) == 0x1; }

      OParams& shNoWrite() { m_shflags |= 0x2; return *this; }
      bool isShNoWrite() const { return (m_shflags & 0x2) == 0x2; }

      OParams& shNone() { m_shflags |= 0x3; return *this; }
      bool isShNone() const { return (m_shflags & 0x3) == 0x3; }
   };

   class CParams: public OParams
   {
      uint32 m_cflags;
      uint32 m_cmode;
      friend class VFSProvider;

   public:
      CParams():
         m_cflags(0),
         m_cmode( 0644 )
      {}

      CParams& noOvr() { m_cflags |= 0x1; return *this; }
      bool isNoOvr() const { return (m_cflags & 0x1) == 0x1; }

      CParams& noStream() { m_cflags |= 0x2; return *this; }
      bool isNoStream() const { return (m_cflags & 0x2) == 0x2; }

      CParams& createMode( uint32 cm ) { m_cmode = cm; return *this; }
      uint32 createMode() const { return m_cmode; }
   };

   inline const String& protocol() const { return m_servedProto; }

   inline Stream *open( const URI &uri ) {
      return open( uri, OParams() );
   }

   virtual Stream* open( const URI &uri, const OParams &p )=0;

   inline Stream* create( const URI &uri ) {
      bool dummy;
      return create( uri, CParams(), dummy );
   }

   inline Stream* create( const URI& uri, bool &bSuccess ) {
      return create( uri, CParams(), bSuccess );
   }

   inline Stream* create( const URI& uri, const CParams &p ) {
      bool dummy;
      return create( uri, p, dummy );
   }

   virtual bool link( const URI &uri1, const URI &uri2, bool bSymbolic )=0;
   virtual bool unlink( const URI &uri )=0;

   virtual Stream *create( const URI &uri, const CParams &p, bool &bSuccess )=0;

   virtual DirEntry* openDir( const URI &uri )=0;

   virtual bool mkdir( const URI &uri, uint32 mode )=0;
   virtual bool rmdir( const URI &uri )=0;
   virtual bool move( const URI &suri, const URI &duri )=0;

   virtual bool readStats( const URI &uri, FileStat &s )=0;
   virtual bool writeStats( const URI &uri, const FileStat &s )=0;

   virtual bool chown( const URI &uri, int uid, int gid )=0;
   virtual bool chmod( const URI &uri, int mode )=0;

   virtual int64 getLastFsError()=0;

   virtual Error *getLastError()=0;
};
}

#endif

/* end of vsfprovider.h */

---