gecko-dev/xpcom/io/nsIFile.idl

/* -*- 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 <dougt@netscape.com>
 */


// 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.

#include "nsISupports.idl"
interface nsISimpleEnumerator;

[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;
    
     
    /**
     *  appendPath
     *
     *  This function is used for constructing a descendat of the
     *  current nsIFile.  Non-terminal nodes will be resolved. An 
     *  error will be returned if a non-terminal is a file 
     *  (NS_ERROR_FILE_INVALID_PATH).  
     *
     *  @param relativePath    
     *      A unix style string which is intented to be a relative 
     *      path of the nsIFile.  Starting and trailing '/' will 
     *      be ignored.  If this path is not a unix style path, an 
     *      error will be returned (NS_ERROR_FILE_UNRECONGNIZED_PATH).
     */

    void appendPath([const] in string relativePath);

      /**
    * 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
     *       This 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. 
     */
    readonly attribute string leafName;
    
    /**
     *  copyTo
     *
     *  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 will NOT resolve aliases/shortcuts during the copy.
     *
     *   @param newParentDir
     *       This param is the destination directory. If the 
     *       newParentDir is nsnull, copyTo() will simply  
     *       rename the file. If the newParentDir is not 
     *       null and does not exists, an error will be 
     *       returned (NS_ERROR_FILE_DESTINATION_NOT_DIR)
     *
     *   @param newName
     *       This param allows you to specify a new name
     *       for the file to be copied.  This can be nsnull.
     *
     */

    void copyTo(in nsIFile newParentDir, [const] in string newName);
     
    /**
     *  copyToFollowingLinks
     *
     *  This function is identical to copyTo except it, as
     *  the name implies, follows symbolic links.
     */

    void copyToFollowingLinks(in nsIFile newParentDir, [const] in string newName);
    
    /**
     *  moveTo
     *
     *  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 nsnull, moveTo() will simply  
     *       rename the file. If the newParentDir is not 
     *       null and does not exists, an error will be 
     *       returned (NS_ERROR_FILE_DESTINATION_NOT_DIR)
     *
     *   @param newName
     *       This param allows you to specify a new name
     *       for the file to be moved.  This can be nsnull.
     *
     */
    void moveTo(in nsIFile newParentDir, [const] in string newName);

    /**
     *  This will try to execute this file.  It will not block for
     *  execution.  'args' will be passed through on the command line
     *  if the OS supports that.
     */
    void spawn([const] in string args);
    
    /**
     *  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 delete(in boolean recursive);

    /**
     *  Attributes of nsIFile.
     */
    
    attribute unsigned long permissions;
    attribute unsigned long permissionsOfLink;
    
    attribute PRInt64 lastModificationDate;
    attribute PRInt64 lastModificationDateOfLink;
    
    attribute PRInt64 fileSize;
    readonly attribute PRInt64 fileSizeOfLink;
    
    /**
     *  target & path
     *
     *  Accessor to the string path.  These strings are
     *  not guaranteed to be a usable path to pass to NSPR 
     *  or the C stdlib.  There are problem which affects 
     *  platforms in which a path does not fully specify a 
     *  file, because two volumes can have the same name.  
     *  This is solved by holding a "private" native data.  
     *  This 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.
     */

    readonly attribute string target;
    readonly attribute string path;
    
    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(); 
    

        
    /**
      * 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 the file is a descendant of the parameter inFile.
     * If |recur| is true, it will descend subdirectories looking for 
     */
    boolean isContainedIn(in nsIFile inFile, in boolean recur);


    /**
     * Parent will be nsnull 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_PROGID "component://netscape/file"
#define NS_FILE_CLASSNAME "File Specification"


#define NS_ERROR_FILE_UNRECOGNIZED_PATH         NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 1)
#define NS_ERROR_FILE_UNRESOLVABLE_SYMLINK      NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 2)
#define NS_ERROR_FILE_EXECUTION_FAILED       NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 3)
#define NS_ERROR_FILE_UNKNOWN_TYPE        NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 4)
#define NS_ERROR_FILE_DESTINATION_NOT_DIR    NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 5)
#define NS_ERROR_FILE_TARGET_DOES_NOT_EXIST     NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 6)
#define NS_ERROR_FILE_COPY_OR_MOVE_FAILED    NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 7)
#define NS_ERROR_FILE_ALREADY_EXISTS         NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 8)
#define NS_ERROR_FILE_INVALID_PATH        NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 9)
#define NS_ERROR_FILE_DISK_FULL           NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 10)
#define NS_ERROR_FILE_CORRUPTED           NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 11)
#define NS_ERROR_FILE_NOT_DIRECTORY           NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 12)
#define NS_ERROR_FILE_IS_DIRECTORY                 NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 13)
#define NS_ERROR_FILE_IS_LOCKED               NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 14)
#define NS_ERROR_FILE_TOO_BIG                      NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 15)
#define NS_ERROR_FILE_NO_DEVICE_SPACE              NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 16)
#define NS_ERROR_FILE_NAME_TOO_LONG               NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 17)
#define NS_ERROR_FILE_NOT_FOUND               NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 18)
#define NS_ERROR_FILE_READ_ONLY               NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 19)
#define NS_ERROR_FILE_DIR_NOT_EMPTY       NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 20)
#define NS_ERROR_FILE_ACCESS_DENIED       NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_FILES, 21)

%}