1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/dom/file/FileHelper.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,99 @@
1.4 +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
1.5 +/* vim: set ts=2 et sw=2 tw=80: */
1.6 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this file,
1.8 + * You can obtain one at http://mozilla.org/MPL/2.0/. */
1.9 +
1.10 +#ifndef mozilla_dom_file_filehelper_h__
1.11 +#define mozilla_dom_file_filehelper_h__
1.12 +
1.13 +#include "FileCommon.h"
1.14 +
1.15 +#include "nsIRequestObserver.h"
1.16 +
1.17 +class nsIFileStorage;
1.18 +
1.19 +BEGIN_FILE_NAMESPACE
1.20 +
1.21 +class FileHelper;
1.22 +class FileRequest;
1.23 +class FileOutputStreamWrapper;
1.24 +class LockedFile;
1.25 +
1.26 +class FileHelperListener
1.27 +{
1.28 +public:
1.29 + NS_IMETHOD_(MozExternalRefCountType)
1.30 + AddRef() = 0;
1.31 +
1.32 + NS_IMETHOD_(MozExternalRefCountType)
1.33 + Release() = 0;
1.34 +
1.35 + virtual void
1.36 + OnFileHelperComplete(FileHelper* aFileHelper) = 0;
1.37 +};
1.38 +
1.39 +/**
1.40 + * Must be subclassed. The subclass must implement DoAsyncRun. It may then
1.41 + * choose to implement GetSuccessResult to properly set the result of the
1.42 + * success event. Call Enqueue to start the file operation.
1.43 + */
1.44 +class FileHelper : public nsIRequestObserver
1.45 +{
1.46 + friend class FileRequest;
1.47 + friend class FileOutputStreamWrapper;
1.48 +
1.49 +public:
1.50 + NS_DECL_THREADSAFE_ISUPPORTS
1.51 + NS_DECL_NSIREQUESTOBSERVER
1.52 +
1.53 + nsresult
1.54 + Enqueue();
1.55 +
1.56 + nsresult
1.57 + AsyncRun(FileHelperListener* aListener);
1.58 +
1.59 + void
1.60 + OnStreamProgress(uint64_t aProgress, uint64_t aProgressMax);
1.61 +
1.62 + void
1.63 + OnStreamClose();
1.64 +
1.65 + void
1.66 + OnStreamDestroy();
1.67 +
1.68 + static LockedFile*
1.69 + GetCurrentLockedFile();
1.70 +
1.71 +protected:
1.72 + FileHelper(LockedFile* aLockedFile, FileRequest* aRequest);
1.73 +
1.74 + virtual ~FileHelper();
1.75 +
1.76 + virtual nsresult
1.77 + DoAsyncRun(nsISupports* aStream) = 0;
1.78 +
1.79 + virtual nsresult
1.80 + GetSuccessResult(JSContext* aCx, JS::MutableHandle<JS::Value> aVal);
1.81 +
1.82 + virtual void
1.83 + ReleaseObjects();
1.84 +
1.85 + void
1.86 + Finish();
1.87 +
1.88 + nsCOMPtr<nsIFileStorage> mFileStorage;
1.89 + nsRefPtr<LockedFile> mLockedFile;
1.90 + nsRefPtr<FileRequest> mFileRequest;
1.91 +
1.92 + nsRefPtr<FileHelperListener> mListener;
1.93 + nsCOMPtr<nsIRequest> mRequest;
1.94 +
1.95 +private:
1.96 + nsresult mResultCode;
1.97 + bool mFinished;
1.98 +};
1.99 +
1.100 +END_FILE_NAMESPACE
1.101 +
1.102 +#endif // mozilla_dom_file_filehelper_h__
