mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-08 20:47:44 +00:00
66 lines
2.4 KiB
Plaintext
66 lines
2.4 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* 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/. */
|
|
|
|
#include "nsIProtocolHandler.idl"
|
|
|
|
interface nsIFile;
|
|
|
|
[scriptable, uuid(1fb25bd5-4354-4dcd-8d97-621b7b3ed2e4)]
|
|
interface nsIFileProtocolHandler : nsIProtocolHandler
|
|
{
|
|
/**
|
|
* This method constructs a new file URI
|
|
*
|
|
* @param aFile nsIFile
|
|
* @return reference to a new nsIURI object
|
|
*/
|
|
nsIURI newFileURI(in nsIFile aFile);
|
|
|
|
/**
|
|
* Converts the nsIFile to the corresponding URL string. NOTE: under
|
|
* some platforms this is a lossy conversion (e.g., Mac Carbon build).
|
|
* If the nsIFile is a local file, then the result will be a file://
|
|
* URL string.
|
|
*
|
|
* The resulting string may contain URL-escaped characters.
|
|
* NOTE: Callers should use getURLSpecFromActualFile or
|
|
* getURLSpecFromDirFile if possible, for performance reasons.
|
|
*/
|
|
AUTF8String getURLSpecFromFile(in nsIFile file);
|
|
|
|
/**
|
|
* Converts the nsIFile to the corresponding URL string. Should
|
|
* only be called on files which are not directories. Otherwise
|
|
* identical to getURLSpecFromFile, but is usually more efficient.
|
|
* WARNING: This restriction may not be enforced at runtime!
|
|
*/
|
|
AUTF8String getURLSpecFromActualFile(in nsIFile file);
|
|
|
|
/**
|
|
* Converts the nsIFile to the corresponding URL string. Should
|
|
* only be called on files which are directories. Otherwise
|
|
* identical to getURLSpecFromFile, but is usually more efficient.
|
|
* WARNING: This restriction may not be enforced at runtime!
|
|
*/
|
|
AUTF8String getURLSpecFromDir(in nsIFile file);
|
|
|
|
/**
|
|
* Converts the URL string into the corresponding nsIFile if possible.
|
|
* A local file will be created if the URL string begins with file://.
|
|
*/
|
|
nsIFile getFileFromURLSpec(in AUTF8String url);
|
|
|
|
/**
|
|
* Takes a local file and tries to interpret it as an internet shortcut
|
|
* (e.g. .url files on windows).
|
|
* @param file The local file to read
|
|
* @return The URI the file refers to
|
|
*
|
|
* @throw NS_ERROR_NOT_AVAILABLE if the OS does not support such files.
|
|
* @throw NS_ERROR_NOT_AVAILABLE if this file is not an internet shortcut.
|
|
*/
|
|
nsIURI readURLFile(in nsIFile file);
|
|
};
|