BrawlLib.Internal.IO.FileMap Class Reference

Inheritance diagram for BrawlLib.Internal.IO.FileMap:

Public Member Functions
virtual void	Dispose ()

Static Public Member Functions
static FileMap	FromFile (string path)
static FileMap	FromFile (string path, FileMapProtect prot)
static FileMap	FromFile (string path, FileMapProtect prot, int offset, int length)
static FileMap	FromFile (string path, FileMapProtect prot, int offset, int length, FileOptions options)
static FileMap	FromTempFile (int length)
static FileMap	FromTempFile (int length, out string path)
static FileMap	FromStream (FileStream stream)
static FileMap	FromStream (FileStream stream, FileMapProtect prot)
static FileMap	FromStream (FileStream stream, FileMapProtect prot, int offset, int length)
static FileMap	FromStreamInternal (FileStream stream, FileMapProtect prot, int offset, int length)

Protected Attributes
VoidPtr	_addr
int	_length
string	_path
FileStream	_baseStream

Properties
VoidPtr	Address [get]
int	Length [get, set]
string	FilePath [get]
FileStream	BaseStream [get]

Member Function Documentation

Dispose()

virtual void BrawlLib.Internal.IO.FileMap.Dispose ( )

inlinevirtual

Reimplemented in BrawlLib.Internal.IO.wFileMap, and BrawlLib.Internal.IO.cFileMap.

        {
            if (_baseStream != null)
            {
                _baseStream.Close();
                _baseStream.Dispose();
                _baseStream = null;
            }
 
            //#if DEBUG
            //            Console.WriteLine("Closing file map: {0}", _path);
            //#endif
            GC.SuppressFinalize(this);
        }

FromFile() [1/4]

static FileMap BrawlLib.Internal.IO.FileMap.FromFile ( string  path )

inlinestatic

        {
            return FromFile(path, FileMapProtect.ReadWrite, 0, 0);
        }

FromFile() [2/4]

static FileMap BrawlLib.Internal.IO.FileMap.FromFile ( string  path, FileMapProtect  prot  )

inlinestatic

        {
            return FromFile(path, prot, 0, 0);
        }

FromFile() [3/4]

static FileMap BrawlLib.Internal.IO.FileMap.FromFile ( string  path, FileMapProtect  prot, int  offset, int  length  )

inlinestatic

        {
            return FromFile(path, prot, 0, 0, FileOptions.RandomAccess);
        }

FromFile() [4/4]

static FileMap BrawlLib.Internal.IO.FileMap.FromFile ( string  path, FileMapProtect  prot, int  offset, int  length, FileOptions  options  )

inlinestatic

        {
            FileStream stream;
            FileMap map;
 
            try // Use a temp file in order to prevent writelocks
            {
                string tempPath = Path.GetTempFileName();
                File.Copy(path, tempPath, true);
                stream = new FileStream(tempPath, FileMode.Open, FileAccess.ReadWrite, FileShare.Read, 8,
                    options | FileOptions.DeleteOnClose);
            }
            catch // Just open the file normally
            {
                stream = new FileStream(path, FileMode.Open,
                    prot == FileMapProtect.ReadWrite ? FileAccess.ReadWrite : FileAccess.Read, FileShare.Read, 8,
                    options);
            }
 
            try
            {
                map = FromStreamInternal(stream, prot, offset, length);
            }
            catch (Exception)
            {
                stream.Dispose();
                throw;
            }
 
            map._path = path; // Preserve true path
            return map;
        }

FromStream() [1/3]

static FileMap BrawlLib.Internal.IO.FileMap.FromStream ( FileStream  stream )

inlinestatic

        {
            return FromStream(stream, FileMapProtect.ReadWrite, 0, 0);
        }

FromStream() [2/3]

static FileMap BrawlLib.Internal.IO.FileMap.FromStream ( FileStream  stream, FileMapProtect  prot  )

inlinestatic

        {
            return FromStream(stream, prot, 0, 0);
        }

FromStream() [3/3]

static FileMap BrawlLib.Internal.IO.FileMap.FromStream ( FileStream  stream, FileMapProtect  prot, int  offset, int  length  )

inlinestatic

        {
            //FileStream newStream = new FileStream(stream.Name, FileMode.Open, prot == FileMapProtect.Read ? FileAccess.Read : FileAccess.ReadWrite, FileShare.Read, 8, FileOptions.RandomAccess);
            //try { return FromStreamInternal(newStream, prot, offset, length); }
            //catch (Exception x) { newStream.Dispose(); throw x; }
 
            if (length == 0)
            {
                length = (int) stream.Length;
            }
 
            switch (Environment.OSVersion.Platform)
            {
                case PlatformID.Win32NT:
                    return new wFileMap(stream.SafeFileHandle.DangerousGetHandle(), prot, offset, (uint) length)
                        {_path = stream.Name};
                default:
                    return new cFileMap(stream, prot, offset, length) {_path = stream.Name};
            }
 
            //#if DEBUG
            //            Console.WriteLine("Opening file map: {0}", stream.Name);
            //#endif
        }

FromStreamInternal()

static FileMap BrawlLib.Internal.IO.FileMap.FromStreamInternal ( FileStream  stream, FileMapProtect  prot, int  offset, int  length  )

inlinestatic

        {
            if (length == 0)
            {
                length = (int) stream.Length;
            }
 
            switch (Environment.OSVersion.Platform)
            {
                case PlatformID.Win32NT:
                    return new wFileMap(stream.SafeFileHandle.DangerousGetHandle(), prot, offset, (uint) length)
                        {_baseStream = stream, _path = stream.Name};
                default:
                    return new cFileMap(stream, prot, offset, length) {_baseStream = stream, _path = stream.Name};
            }
 
            //#if DEBUG
            //            Console.WriteLine("Opening file map: {0}", stream.Name);
            //#endif
        }

FromTempFile() [1/2]

static FileMap BrawlLib.Internal.IO.FileMap.FromTempFile ( int  length )

inlinestatic

        {
            return FromTempFile(length, out string path);
        }

FromTempFile() [2/2]

static FileMap BrawlLib.Internal.IO.FileMap.FromTempFile ( int  length, out string  path  )

inlinestatic

        {
            path = Path.GetTempFileName();
            FileStream stream = new FileStream(path, FileMode.Open, FileAccess.ReadWrite,
                FileShare.Read, 8, FileOptions.RandomAccess | FileOptions.DeleteOnClose);
            try
            {
                return FromStreamInternal(stream, FileMapProtect.ReadWrite, 0, length);
            }
            catch (Exception)
            {
                stream.Dispose();
                throw;
            }
        }

Member Data Documentation

_addr

VoidPtr BrawlLib.Internal.IO.FileMap._addr

protected

_baseStream

FileStream BrawlLib.Internal.IO.FileMap._baseStream

protected

_length

int BrawlLib.Internal.IO.FileMap._length

protected

_path

string BrawlLib.Internal.IO.FileMap._path

protected

Property Documentation

Address

VoidPtr BrawlLib.Internal.IO.FileMap.Address

get

BaseStream

FileStream BrawlLib.Internal.IO.FileMap.BaseStream

get

FilePath

string BrawlLib.Internal.IO.FileMap.FilePath

get

Length

int BrawlLib.Internal.IO.FileMap.Length

getset

        {
            get => _length;
            set => _length = value;
        }

---

The documentation for this class was generated from the following file:

• BrawlLib/Internal/IO/FileMap.cs