mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-11 20:35:50 +00:00
175 lines
5.7 KiB
Plaintext
175 lines
5.7 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* The contents of this file are subject to the Netscape Public
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
* implied. See the License for the specific language governing
|
|
* rights and limitations under the License.
|
|
*
|
|
* The Original Code is Mozilla Communicator client code,
|
|
* released March 31, 1998.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape Communications
|
|
* Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998-1999 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Doug Turner <dougt@netscape.com>
|
|
* Darin Fisher <darin@netscape.com>
|
|
*/
|
|
|
|
#include "nsIFile.idl"
|
|
|
|
%{C++
|
|
#include "prio.h"
|
|
#include "prlink.h"
|
|
#include <stdio.h>
|
|
#include "nsAString.h"
|
|
%}
|
|
|
|
[ptr] native PRFileDescStar(PRFileDesc);
|
|
[ptr] native PRLibraryStar(PRLibrary);
|
|
[ptr] native FILE(FILE);
|
|
|
|
/**
|
|
* This interface adds methods to nsIFile that are particular to a file
|
|
* that is accessible via the local file system.
|
|
*
|
|
* It follows the same string conventions as nsIFile.
|
|
*
|
|
* @status UNDER_REVIEW
|
|
*/
|
|
[scriptable, uuid(aa610f20-a889-11d3-8c81-000064657374)]
|
|
interface nsILocalFile : nsIFile
|
|
{
|
|
/**
|
|
* initWith[Native]Path
|
|
*
|
|
* This function will initialize the nsILocalFile object. Any
|
|
* internal state information will be reset.
|
|
*
|
|
* NOTE: This function has a known bug on the macintosh and
|
|
* other OSes which do not represent file locations as paths.
|
|
* If you do use this function, be very aware of this problem!
|
|
*
|
|
* @param filePath
|
|
* A string which specifies a full file path to a
|
|
* location. Relative paths will be treated as an
|
|
* error (NS_ERROR_FILE_UNRECOGNIZED_PATH). This
|
|
* path must in native.
|
|
*/
|
|
void initWithPath(in AUTF8String filePath);
|
|
[noscript] void initWithNativePath(in ACString filePath);
|
|
|
|
/**
|
|
* initWithFile
|
|
*
|
|
* Initialize this object with another file
|
|
*
|
|
* @param aFile
|
|
* the file this becomes equivalent to
|
|
*/
|
|
void initWithFile(in nsILocalFile aFile);
|
|
|
|
/**
|
|
* followLinks
|
|
*
|
|
* This attribute will determine if the nsLocalFile will auto
|
|
* resolve symbolic links. By default, this value will be false
|
|
* on all non unix systems. On unix, this attribute is effectively
|
|
* a noop.
|
|
*
|
|
* Be aware that changing this attribute from true to false after
|
|
* the nsILocalFile has been initialized may lead to errors. This
|
|
* could happen if there were resolved symlink in the initialized
|
|
* path. For example if you had /a/b/c where |b| was a symlink,
|
|
* and you change this attribute to false, the next usage would
|
|
* mostlikely fail.
|
|
*/
|
|
attribute PRBool followLinks;
|
|
|
|
[noscript] PRFileDescStar openNSPRFileDesc(in long flags, in long mode);
|
|
[noscript] FILE openANSIFileDesc(in string mode);
|
|
|
|
[noscript] PRLibraryStar load();
|
|
|
|
readonly attribute PRInt64 diskSpaceAvailable; // maybe we should put this somewhere else.
|
|
|
|
/**
|
|
* appendRelative[Native]Path
|
|
*
|
|
* Append a relative path to the current path of the nsILocalFile object.
|
|
*
|
|
* @param relativeFilePath
|
|
* relativeFilePath is a native relative path. For security reasons,
|
|
* this cannot contain .. or cannot start with a directory separator
|
|
* XXXbe Why not? Bogus!
|
|
*/
|
|
void appendRelativePath(in AUTF8String relativeFilePath);
|
|
[noscript] void appendRelativeNativePath(in ACString relativeFilePath);
|
|
|
|
/**
|
|
* Accessor to a null terminated string which will specify
|
|
* the file in a persistent manner for disk storage.
|
|
*
|
|
* The character set of this attribute is undefined. Do not try to
|
|
* interpret it as human readable text.
|
|
*/
|
|
attribute ACString persistentDescriptor;
|
|
|
|
/**
|
|
* reveal
|
|
*
|
|
* Ask the operating system to open the folder which contains
|
|
* this file or folder. This routine only works on platforms which
|
|
* support the ability to open a folder...
|
|
*/
|
|
void reveal();
|
|
|
|
/**
|
|
* launch
|
|
*
|
|
* Ask the operating system to attempt to open the file.
|
|
* this really just simulates "double clicking" the file on your platform.
|
|
* This routine only works on platforms which support this functionality.
|
|
*/
|
|
void launch();
|
|
|
|
/**
|
|
* getRelativeDescriptor
|
|
*
|
|
* Returns a UTF-8 encoded relative file path in an XP format.
|
|
* It is therefore not a native path.
|
|
*
|
|
* @param fromFile
|
|
* the file from which the descriptor is relative
|
|
*/
|
|
AUTF8String getRelativeDescriptor(in nsILocalFile fromFile);
|
|
|
|
/**
|
|
* setRelativeDescriptor
|
|
*
|
|
* Initializes the file to the location relative to fromFile using
|
|
* a string returned by getRelativeDescriptor.
|
|
*
|
|
* @param fromFile
|
|
* the file to which the descriptor is relative
|
|
*/
|
|
void setRelativeDescriptor(in nsILocalFile fromFile, in AUTF8String relativeDesc);
|
|
};
|
|
|
|
%{C++
|
|
#define NS_LOCAL_FILE_CONTRACTID "@mozilla.org/file/local;1"
|
|
#define NS_LOCAL_FILE_CLASSNAME "Local File Specification"
|
|
|
|
extern "C" NS_EXPORT nsresult
|
|
NS_NewLocalFile(const nsACString &path, PRBool followLinks, nsILocalFile* *result);
|
|
extern "C" NS_EXPORT nsresult
|
|
NS_NewNativeLocalFile(const nsACString &path, PRBool followLinks, nsILocalFile* *result);
|
|
%}
|