dom/filesystem/FileSystemUtils.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 file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_FileSystemUtils_h
   8 #define mozilla_dom_FileSystemUtils_h
   9
  10 class nsIFile;
  11 class nsIRunnable;
  12
  13 namespace mozilla {
  14 namespace dom {
  15
  16 #define FILESYSTEM_DOM_PATH_SEPARATOR_LITERAL "/"
  17 #define FILESYSTEM_DOM_PATH_SEPARATOR_CHAR '/'
  18
  19 /*
  20  * This class is for error handling.
  21  * All methods in this class are static.
  22  */
  23 class FileSystemUtils {
  24  public:
  25   /*
  26    * Return true if aDescendantPath is a descendant of aPath.
  27    */
  28   static bool IsDescendantPath(const nsAString& aPath,
  29                                const nsAString& aDescendantPath);
  30
  31   /**
  32    * Return true if this is valid DOMPath. It also splits the path in
  33    * subdirectories and stores them in aParts.
  34    */
  35   static bool IsValidRelativeDOMPath(const nsAString& aPath,
  36                                      nsTArray<nsString>& aParts);
  37
  38   /**
  39    * Helper method. If aGlobal is null, the SystemGroup EventTarget will be
  40    * used.
  41    */
  42   static nsresult DispatchRunnable(nsIGlobalObject* aGlobal,
  43                                    already_AddRefed<nsIRunnable>&& aRunnable);
  44 };
  45
  46 }  // namespace dom
  47 }  // namespace mozilla
  48
  49 #endif  // mozilla_dom_FileSystemUtils_h