/* -*- Mode: C++; tab-width: 4; 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 * Christopher Blizzard * Darin Fisher */ #include "nsISupports.idl" interface nsISimpleEnumerator; /** * This is the only correct cross-platform way to specify a file. * Strings are not such a way. If you grew up on windows or unix, you * may think they are. Welcome to reality. * * All methods with string parameters have two forms. The preferred * form operates on UCS-2 encoded characters strings. An alternate * form operates on characters strings encoded in the "native" charset. * * A string containing characters encoded in the native charset cannot * be safely passed to javascript via xpconnect. Therefore, the "native * methods" are not scriptable. * * @status FROZEN */ [scriptable, uuid(c8c0a080-0868-11d3-915f-d9d889d48e3c)] interface nsIFile : nsISupports { /** * Create Types * * NORMAL_FILE_TYPE - A normal file. * DIRECTORY_TYPE - A directory/folder. */ const unsigned long NORMAL_FILE_TYPE = 0; const unsigned long DIRECTORY_TYPE = 1; /** * append[Native] * * This function is used for constructing a descendent of the * current nsIFile. * * @param node * A string which is intended to be a child node of the nsIFile. * For the |appendNative| method, the node must be in the native * filesystem charset. */ void append(in AString node); [noscript] void appendNative(in ACString node); /** * Normalize the pathName (e.g. removing .. and . components on Unix). */ void normalize(); /** * create * * This function will create a new file or directory in the * file system. Any nodes that have not been created or * resolved, will be. If the file or directory already * exists create() will return NS_ERROR_FILE_ALREADY_EXISTS. * * @param type * This specifies the type of file system object * to be made. The only two types at this time * are file and directory which are defined above. * If the type is unrecongnized, we will return an * error (NS_ERROR_FILE_UNKNOWN_TYPE). * * @param permissions * The unix style octal permissions. This may * be ignored on systems that do not need to do * permissions. */ void create(in unsigned long type, in unsigned long permissions); /** * Accessor to the leaf name of the file itself. * For the |nativeLeafName| method, the nativeLeafName must * be in the native filesystem charset. */ attribute AString leafName; [noscript] attribute ACString nativeLeafName; /** * copyTo[Native] * * This will copy this file to the specified newParentDir. * If a newName is specified, the file will be renamed. * If 'this' is not created we will return an error * (NS_ERROR_FILE_TARGET_DOES_NOT_EXIST). * * copyTo may fail if the file already exists in the destination * directory. * * copyTo will NOT resolve aliases/shortcuts during the copy. * * @param newParentDir * This param is the destination directory. If the * newParentDir is null, copyTo() will use the parent * directory of this file. If the newParentDir is not * empty and is not a directory, an error will be * returned (NS_ERROR_FILE_DESTINATION_NOT_DIR). For the * |CopyToNative| method, the newName must be in the * native filesystem charset. * * @param newName * This param allows you to specify a new name for * the file to be copied. This param may be empty, in * which case the current leaf name will be used. */ void copyTo(in nsIFile newParentDir, in AString newName); [noscript] void CopyToNative(in nsIFile newParentDir, in ACString newName); /** * copyToFollowingLinks[Native] * * This function is identical to copyTo with the exception that, * as the name implies, it follows symbolic links. The XP_UNIX * implementation always follow symbolic links when copying. For * the |CopyToFollowingLinks| method, the newName must be in the * native filesystem charset. */ void copyToFollowingLinks(in nsIFile newParentDir, in AString newName); [noscript] void copyToFollowingLinksNative(in nsIFile newParentDir, in ACString newName); /** * moveTo[Native] * * This will move this file to the specified newParentDir. * If a newName is specified, the file will be renamed. * If 'this' is not created we will return an error * (NS_ERROR_FILE_TARGET_DOES_NOT_EXIST). * * moveTo will NOT resolve aliases/shortcuts during the copy. * moveTo will do the right thing and allow copies across * volumes. * * @param newParentDir * This param is the destination directory. If the * newParentDir is empty, moveTo() will rename the file * within its current directory. If the newParentDir is * not empty and does not name a directory, an error will * be returned (NS_ERROR_FILE_DESTINATION_NOT_DIR). For * the |moveToNative| method, the newName must be in the * native filesystem charset. * * @param newName * This param allows you to specify a new name for * the file to be moved. This param may be empty, in * which case the current leaf name will be used. */ void moveTo(in nsIFile newParentDir, in AString newName); [noscript] void moveToNative(in nsIFile newParentDir, in ACString newName); /** * This will try to delete this file. The 'recursive' flag * must be PR_TRUE to delete directories which are not empty. * * This will not resolve any symlinks. */ void remove(in boolean recursive); /** * Attributes of nsIFile. */ attribute unsigned long permissions; attribute unsigned long permissionsOfLink; /** * File Times are to be in milliseconds from * midnight (00:00:00), January 1, 1970 Greenwich Mean * Time (GMT). */ attribute PRInt64 lastModifiedTime; attribute PRInt64 lastModifiedTimeOfLink; /** * WARNING! On the Mac, getting/setting the file size with nsIFile * only deals with the size of the data fork. If you need to * know the size of the combined data and resource forks use the * GetFileSizeWithResFork() method defined on nsILocalFileMac. */ attribute PRInt64 fileSize; readonly attribute PRInt64 fileSizeOfLink; /** * target & path * * Accessor to the string path. The native version of these * strings are not guaranteed to be a usable path to pass to * NSPR or the C stdlib. There are problems that affect * platforms on which a path does not fully specify a file * because two volumes can have the same name (e.g., XP_MAC). * This is solved by holding "private", native data in the * nsIFile implementation. This native data is lost when * you convert to a string. * * DO NOT PASS TO USE WITH NSPR OR STDLIB! * * target * Find out what the symlink points at. Will give error * (NS_ERROR_FILE_INVALID_PATH) if not a symlink. * * path * Find out what the nsIFile points at. * * Note that the ACString attributes are returned in the * native filesystem charset. * */ readonly attribute AString target; [noscript] readonly attribute ACString nativeTarget; readonly attribute AString path; [noscript] readonly attribute ACString nativePath; boolean exists(); boolean isWritable(); boolean isReadable(); boolean isExecutable(); boolean isHidden(); boolean isDirectory(); boolean isFile(); boolean isSymlink(); /** * Not a regular file, not a directory, not a symlink. */ boolean isSpecial(); /** * createUnique * * This function will create a new file or directory in the * file system. Any nodes that have not been created or * resolved, will be. If this file already exists, we try * variations on the leaf name "suggestedName" until we find * one that did not already exist. * * If the search for nonexistent files takes too long * (thousands of the variants already exist), we give up and * return NS_ERROR_FILE_TOO_BIG. * * @param type * This specifies the type of file system object * to be made. The only two types at this time * are file and directory which are defined above. * If the type is unrecongnized, we will return an * error (NS_ERROR_FILE_UNKNOWN_TYPE). * * @param permissions * The unix style octal permissions. This may * be ignored on systems that do not need to do * permissions. */ void createUnique(in unsigned long type, in unsigned long permissions); /** * clone() * * This function will allocate and initialize a nsIFile object to the * exact location of the |this| nsIFile. * * @param file * A nsIFile which this object will be initialize * with. * */ nsIFile clone(); /** * Will determine if the inFile equals this. */ boolean equals(in nsIFile inFile); /** * Will determine if inFile is a descendant of this file * If |recur| is true, look in subdirectories too */ boolean contains(in nsIFile inFile, in boolean recur); /** * Parent will be null when this is at the top of the volume. */ readonly attribute nsIFile parent; /** * Returns an enumeration of the elements in a directory. Each * element in the enumeration is an nsIFile. * * @return NS_ERROR_FILE_NOT_DIRECTORY if the current nsIFile does * not specify a directory. */ readonly attribute nsISimpleEnumerator directoryEntries; }; %{C++ #define NS_FILE_CONTRACTID "@mozilla.org/file;1" #define NS_FILE_CLASSNAME "File Specification" #ifndef MOZILLA_STRICT_API #include "nsDirectoryServiceUtils.h" #endif %}