GetDirectoryListingTask.h

/* -*- 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_GetDirectoryListing_h
#define mozilla_dom_GetDirectoryListing_h

#include "mozilla/dom/Directory.h"
#include "mozilla/dom/FileSystemTaskBase.h"

namespace mozilla {
class ErrorResult;

namespace dom {

class BlobImpl;
class FileSystemGetDirectoryListingParams;
class OwningFileOrDirectory;

class GetDirectoryListingTaskChild final : public FileSystemTaskChildBase {
 public:
  static already_AddRefed<GetDirectoryListingTaskChild> Create(
      FileSystemBase* aFileSystem, Directory* aDirectory, nsIFile* aTargetPath,
      const nsAString& aFilters, ErrorResult& aRv);

  virtual ~GetDirectoryListingTaskChild();

  already_AddRefed<Promise> GetPromise();

 private:
  // If aDirectoryOnly is set, we should ensure that the target is a directory.
  GetDirectoryListingTaskChild(nsIGlobalObject* aGlobalObject,
                               FileSystemBase* aFileSystem,
                               Directory* aDirectory, nsIFile* aTargetPath,
                               const nsAString& aFilters);

  virtual FileSystemParams GetRequestParams(const nsString& aSerializedDOMPath,
                                            ErrorResult& aRv) const override;

  virtual void SetSuccessRequestResult(const FileSystemResponseValue& aValue,
                                       ErrorResult& aRv) override;

  virtual void HandlerCallback() override;

  RefPtr<Promise> mPromise;
  RefPtr<Directory> mDirectory;
  nsCOMPtr<nsIFile> mTargetPath;
  nsString mFilters;

  FallibleTArray<OwningFileOrDirectory> mTargetData;
};

class GetDirectoryListingTaskParent final : public FileSystemTaskParentBase {
 public:
  static already_AddRefed<GetDirectoryListingTaskParent> Create(
      FileSystemBase* aFileSystem,
      const FileSystemGetDirectoryListingParams& aParam,
      FileSystemRequestParent* aParent, ErrorResult& aRv);

  nsresult GetTargetPath(nsAString& aPath) const override;

 private:
  GetDirectoryListingTaskParent(
      FileSystemBase* aFileSystem,
      const FileSystemGetDirectoryListingParams& aParam,
      FileSystemRequestParent* aParent);

  virtual FileSystemResponseValue GetSuccessRequestResult(
      ErrorResult& aRv) const override;

  virtual nsresult IOWork() override;

  virtual nsresult MainThreadWork() override;

  virtual bool MainThreadNeeded() const override;

  nsCOMPtr<nsIFile> mTargetPath;
  nsString mDOMPath;
  nsString mFilters;

  struct FileOrDirectoryPath {
    nsString mPath;

    // Set on the main-thread
    nsString mContentType;

    enum { eFilePath, eDirectoryPath } mType;
  };

  FallibleTArray<FileOrDirectoryPath> mTargetData;
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_GetDirectoryListing_h