xpcom/build/FileLocation.h

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #ifndef mozilla_FileLocation_h
   6 #define mozilla_FileLocation_h
   7
   8 #include "nsString.h"
   9 #include "nsCOMPtr.h"
  10 #include "nsAutoPtr.h"
  11 #include "nsIFile.h"
  12 #include "FileUtils.h"
  13
  14 class nsZipArchive;
  15 class nsZipItem;
  16
  17 namespace mozilla {
  18
  19 class FileLocation
  20 {
  21 public:
  22   /**
  23    * FileLocation is an helper to handle different kind of file locations
  24    * within Gecko:
  25    * - on filesystems
  26    * - in archives
  27    * - in archives within archives
  28    * As such, it stores a path within an archive, as well as the archive
  29    * path itself, or the complete file path alone when on a filesystem.
  30    * When the archive is in an archive, an nsZipArchive is stored instead
  31    * of a file path.
  32    */
  33   FileLocation();
  34   ~FileLocation();
  35
  36   /**
  37    * Constructor for plain files
  38    */
  39   explicit FileLocation(nsIFile* aFile);
  40
  41   /**
  42    * Constructors for path within an archive. The archive can be given either
  43    * as nsIFile or nsZipArchive.
  44    */
  45   FileLocation(nsIFile* aZip, const char* aPath);
  46
  47   FileLocation(nsZipArchive* aZip, const char* aPath);
  48
  49   /**
  50    * Creates a new file location relative to another one.
  51    */
  52   FileLocation(const FileLocation& aFile, const char* aPath = nullptr);
  53
  54   /**
  55    * Initialization functions corresponding to constructors
  56    */
  57   void Init(nsIFile* aFile);
  58
  59   void Init(nsIFile* aZip, const char* aPath);
  60
  61   void Init(nsZipArchive* aZip, const char* aPath);
  62
  63   /**
  64    * Returns an URI string corresponding to the file location
  65    */
  66   void GetURIString(nsACString& aResult) const;
  67
  68   /**
  69    * Returns the base file of the location, where base file is defined as:
  70    * - The file itself when the location is on a filesystem
  71    * - The archive file when the location is in an archive
  72    * - The outer archive file when the location is in an archive in an archive
  73    */
  74   already_AddRefed<nsIFile> GetBaseFile();
  75
  76   /**
  77    * Returns whether the "base file" (see GetBaseFile) is an archive
  78    */
  79   bool IsZip() const { return !mPath.IsEmpty(); }
  80
  81   /**
  82    * Returns the path within the archive, when within an archive
  83    */
  84   void GetPath(nsACString& aResult) const { aResult = mPath; }
  85
  86   /**
  87    * Boolean value corresponding to whether the file location is initialized
  88    * or not.
  89    */
  90   operator bool() const { return mBaseFile || mBaseZip; }
  91
  92   /**
  93    * Returns whether another FileLocation points to the same resource
  94    */
  95   bool Equals(const FileLocation& aFile) const;
  96
  97   /**
  98    * Data associated with a FileLocation.
  99    */
 100   class Data
 101   {
 102   public:
 103     /**
 104      * Returns the data size
 105      */
 106     nsresult GetSize(uint32_t* aResult);
 107
 108     /**
 109      * Copies the data in the given buffer
 110      */
 111     nsresult Copy(char* aBuf, uint32_t aLen);
 112   protected:
 113     friend class FileLocation;
 114     nsZipItem* mItem;
 115     nsRefPtr<nsZipArchive> mZip;
 116     mozilla::AutoFDClose mFd;
 117   };
 118
 119   /**
 120    * Returns the data associated with the resource pointed at by the file
 121    * location.
 122    */
 123   nsresult GetData(Data& aData);
 124 private:
 125   nsCOMPtr<nsIFile> mBaseFile;
 126   nsRefPtr<nsZipArchive> mBaseZip;
 127   nsCString mPath;
 128 }; /* class FileLocation */
 129
 130 } /* namespace mozilla */
 131
 132 #endif /* mozilla_FileLocation_h */