/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Outhink - support for typeFileURL
 *     
 * Port to the D programming language:
 *     Jacob Carlborg <doob@me.com>
 *******************************************************************************/
module dwt.dnd.FileTransfer;

import dwt.dwthelper.utils;

import dwt.internal.cocoa.NSArray;
import dwt.internal.cocoa.NSMutableArray;
import dwt.internal.cocoa.NSString;
import dwt.internal.cocoa.OS;

import dwt.dnd.ByteArrayTransfer;
import dwt.dnd.DND;
import dwt.dnd.TransferData;
import dwt.internal.objc.cocoa.Cocoa;
 
/**
 * The class <code>FileTransfer</code> provides a platform specific mechanism 
 * for converting a list of files represented as a java <code>String[]</code> to a 
 * platform specific representation of the data and vice versa.  
 * Each <code>String</code> in the array contains the absolute path for a single 
 * file or directory.
 * 
 * <p>An example of a java <code>String[]</code> containing a list of files is shown 
 * below:</p>
 * 
 * <code><pre>
 *     File file1 = new File("C:\temp\file1");
 *     File file2 = new File("C:\temp\file2");
 *     String[] fileData = new String[2];
 *     fileData[0] = file1.getAbsolutePath();
 *     fileData[1] = file2.getAbsolutePath();
 * </code></pre>
 *
 * @see Transfer
 */
public class FileTransfer : ByteArrayTransfer {
    
    static FileTransfer _instance;
    static const String ID_NAME;
    static const int ID;
    
    static this ()
    {
        _instance = new FileTransfer();
        ID_NAME = OS.NSFilenamesPboardType.getString();
        ID = registerType(ID_NAME);        
    }
    
this() {}

/**
 * Returns the singleton instance of the FileTransfer class.
 *
 * @return the singleton instance of the FileTransfer class
 */
public static FileTransfer getInstance () {
    return _instance;
}

/**
 * This implementation of <code>javaToNative</code> converts a list of file names
 * represented by a java <code>String[]</code> to a platform specific representation.
 * Each <code>String</code> in the array contains the absolute path for a single 
 * file or directory.
 * 
 * @param object a java <code>String[]</code> containing the file names to be converted
 * @param transferData an empty <code>TransferData</code> object that will
 *      be filled in on return with the platform specific format of the data
 * 
 * @see Transfer#nativeToJava
 */
public void javaToNative(Object object, TransferData transferData) {
    if (!checkFile(object) || !isSupportedType(transferData)) {
        DND.error(DND.ERROR_INVALID_DATA);
    }
    String[] files = (cast(ArrayWrapperString2)object).array;
    NSUInteger length = files.length;
    NSMutableArray array = NSMutableArray.arrayWithCapacity(length);
    for (NSUInteger i = 0; i < length; i++) {
        String fileName = files[i];
        NSString string = NSString.stringWith(fileName);
        array.addObject(string);
    }
    transferData.data = array;
}
/**
 * This implementation of <code>nativeToJava</code> converts a platform specific 
 * representation of a list of file names to a java <code>String[]</code>.  
 * Each String in the array contains the absolute path for a single file or directory. 
 * 
 * @param transferData the platform specific representation of the data to be converted
 * @return a java <code>String[]</code> containing a list of file names if the conversion
 *      was successful; otherwise null
 * 
 * @see Transfer#javaToNative
 */
public Object nativeToJava(TransferData transferData) {
    if (!isSupportedType(transferData) || transferData.data is null) return null;
    NSArray array = cast(NSArray) transferData.data;
    if (array.count() is 0) return null;
    int count = cast(int)/*64*/array.count();
    String[] fileNames = new String[count];
    for (int i=0; i<count; i++) {
        NSString string = new NSString(array.objectAtIndex(i));
        fileNames[i] = string.getString();
    }
    return new ArrayWrapperString2(fileNames);
}

protected int[] getTypeIds(){
    return [ID];
}

protected String[] getTypeNames(){
    return [ID_NAME];
}

bool checkFile(Object object) {
    if (object is null || !(cast(ArrayWrapperString2)object) || (cast(ArrayWrapperString2)object).array.length is 0) return false;
    String[] strings = (cast(ArrayWrapperString2)object).array;
    for (int i = 0; i < strings.length; i++) {
        if (strings[i] is null || strings[i].length() is 0) return false;
    }
    return true;
}

protected bool validate(Object object) {
    return checkFile(object);
}
}