xpcom/build/FileLocation.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_FileLocation_h
   8 #define mozilla_FileLocation_h
   9
  10 #include "nsString.h"
  11 #include "nsCOMPtr.h"
  12 #include "nsIFile.h"
  13 #include "FileUtils.h"
  14
  15 class nsZipArchive;
  16 class nsZipItem;
  17
  18 namespace mozilla {
  19
  20 class FileLocation {
  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   FileLocation(const FileLocation& aOther);
  37   FileLocation(FileLocation&& aOther);
  38
  39   FileLocation& operator=(const FileLocation&) = default;
  40
  41   /**
  42    * Constructor for plain files
  43    */
  44   explicit FileLocation(nsIFile* aFile);
  45
  46   /**
  47    * Constructors for path within an archive. The archive can be given either
  48    * as nsIFile or nsZipArchive.
  49    */
  50   FileLocation(nsIFile* aZip, const char* aPath);
  51
  52   FileLocation(nsZipArchive* aZip, const char* aPath);
  53
  54   /**
  55    * Creates a new file location relative to another one.
  56    */
  57   FileLocation(const FileLocation& aFile, const char* aPath);
  58
  59   /**
  60    * Initialization functions corresponding to constructors
  61    */
  62   void Init(nsIFile* aFile);
  63
  64   void Init(nsIFile* aZip, const char* aPath);
  65
  66   void Init(nsZipArchive* aZip, const char* aPath);
  67
  68   /**
  69    * Returns an URI string corresponding to the file location
  70    */
  71   void GetURIString(nsACString& aResult) const;
  72
  73   /**
  74    * Returns the base file of the location, where base file is defined as:
  75    * - The file itself when the location is on a filesystem
  76    * - The archive file when the location is in an archive
  77    * - The outer archive file when the location is in an archive in an archive
  78    */
  79   already_AddRefed<nsIFile> GetBaseFile();
  80
  81   nsZipArchive* GetBaseZip() { return mBaseZip; }
  82
  83   /**
  84    * Returns whether the "base file" (see GetBaseFile) is an archive
  85    */
  86   bool IsZip() const { return !mPath.IsEmpty(); }
  87
  88   /**
  89    * Returns the path within the archive, when within an archive
  90    */
  91   void GetPath(nsACString& aResult) const { aResult = mPath; }
  92
  93   /**
  94    * Boolean value corresponding to whether the file location is initialized
  95    * or not.
  96    */
  97   explicit operator bool() const { return mBaseFile || mBaseZip; }
  98
  99   /**
 100    * Returns whether another FileLocation points to the same resource
 101    */
 102   bool Equals(const FileLocation& aFile) const;
 103
 104   /**
 105    * Data associated with a FileLocation.
 106    */
 107   class Data {
 108    public:
 109     /**
 110      * Returns the data size
 111      */
 112     nsresult GetSize(uint32_t* aResult);
 113
 114     /**
 115      * Copies the data in the given buffer
 116      */
 117     nsresult Copy(char* aBuf, uint32_t aLen);
 118
 119    protected:
 120     friend class FileLocation;
 121     nsZipItem* mItem;
 122     RefPtr<nsZipArchive> mZip;
 123     mozilla::AutoFDClose mFd;
 124   };
 125
 126   /**
 127    * Returns the data associated with the resource pointed at by the file
 128    * location.
 129    */
 130   nsresult GetData(Data& aData);
 131
 132  private:
 133   nsCOMPtr<nsIFile> mBaseFile;
 134   RefPtr<nsZipArchive> mBaseZip;
 135   nsCString mPath;
 136 }; /* class FileLocation */
 137
 138 } /* namespace mozilla */
 139
 140 #endif /* mozilla_FileLocation_h */