dom/filesystem/FileSystemUtils.h
author Sylvestre Ledru <sledru@mozilla.com>
Mon, 19 Nov 2018 15:55:00 +0000
changeset 447015 845fe0e51d436da422c6e64ca7627f57d9dec0ae
parent 351354 611184e06d808e4184db57f6030936b83fbf8709
child 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Bug 1508128 - Update our coding style config files r=Ehsan Differential Revision: https://phabricator.services.mozilla.com/D12221

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_FileSystemUtils_h
#define mozilla_dom_FileSystemUtils_h

class nsIFile;
class nsIRunnable;

namespace mozilla {
namespace dom {

#define FILESYSTEM_DOM_PATH_SEPARATOR_LITERAL "/"
#define FILESYSTEM_DOM_PATH_SEPARATOR_CHAR '/'

/*
 * This class is for error handling.
 * All methods in this class are static.
 */
class FileSystemUtils
{
public:
  /*
   * Return true if aDescendantPath is a descendant of aPath.
   */
  static bool
  IsDescendantPath(const nsAString& aPath,
                   const nsAString& aDescendantPath);

  /**
   * Return true if this is valid DOMPath. It also splits the path in
   * subdirectories and stores them in aParts.
   */
  static bool
  IsValidRelativeDOMPath(const nsAString& aPath,
                         nsTArray<nsString>& aParts);

  /**
   * Helper method. If aGlobal is null, the SystemGroup EventTarget will be
   * used.
   */
  static nsresult
  DispatchRunnable(nsIGlobalObject* aGlobal,
                   already_AddRefed<nsIRunnable>&& aRunnable);
};

} // namespace dom
} // namespace mozilla

#endif // mozilla_dom_FileSystemUtils_h