libs-gui/Source/NSSavePanel.m

/* -*- C++ -*-
   NSSavePanel.m

   Standard save panel for saving files

   Copyright (C) 1996 Free Software Foundation, Inc.

   Author:  Scott Christley <scottc@net-community.com>
   Date: 1996
   Author:  Daniel B<EFBFBD>hringer <boehring@biomed.ruhr-uni-bochum.de>
   Date: August 1998
   Source by Daniel B<EFBFBD>hringer integrated into Scott Christley's preliminary
   implementation by Felipe A. Rodriguez <far@ix.netcom.com>

   This file is part of the GNUstep GUI Library.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; see the file COPYING.LIB.
   If not, write to the Free Software Foundation,
   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#include <gnustep/gui/config.h>
#include <string.h>

#include <Foundation/NSArray.h>
#include <Foundation/NSString.h>
#include <Foundation/NSCoder.h>

#include <AppKit/NSApplication.h>
#include <AppKit/NSSavePanel.h>
#include <AppKit/NSOpenPanel.h>
#include <AppKit/NSBrowserCell.h>
#include <Foundation/NSFileManager.h>
#include <AppKit/NSMatrix.h>
#include <AppKit/IMLoading.h>
#include <AppKit/GMArchiver.h>

/*
 * toDo:
 * - interactive directory creation in SavePanel
 * - accessory view support
 * - parse ".hidden" files; array of suffixes of directories treated as single
 *   files
 */


/*
 * Fake class for gmodel
 */
/*
 * Class variables
 */
static NSSavePanel *gnustep_gui_save_panel = nil;

@interface _SavePanel : NSObject
-(void)browser : (NSBrowser *)sender createRowsForColumn: (int)column
		    inMatrix: (NSMatrix *)matrix;
-(void)browser : (NSBrowser *)sender willDisplayCell: (id)cell
		    atRow: (int)row
		   column: (int)column;
@end

/*
 * _SavePanel: used for loading gmodels, NSBrowser delegate
 */
@implementation _SavePanel

+ (id) init
{
  NSLog(@"asdasdasd");
  return (self = [super init]);
}
/*
 * Model stuff
 */
- (id) initWithModelUnarchiver : (GMUnarchiver*)unarchiver
{
  if (!gnustep_gui_save_panel)
    gnustep_gui_save_panel = [unarchiver decodeObjectWithName: @"panel"];

  return self;
}

- (void) encodeWithModelArchiver : (GMArchiver *)archiver
{
  if (gnustep_gui_save_panel)
    [archiver encodeObject: gnustep_gui_save_panel withName: @"panel"];
}

//
// Browser stuff
- (void) browser: (NSBrowser*)sender createRowsForColumn: (int)column
       inMatrix: (NSMatrix*)matrix
{
  NSFileManager *fm = [NSFileManager defaultManager];
  NSString *ptc = [sender pathToColumn: column];
  NSArray *files = [fm directoryContentsAtPath: ptc];
  unsigned i, count = [files count];

  if (!count)
    return;

  [matrix addColumn];
  for (i =0; i<count; ++i)
    {
      id cell;
      BOOL exists = NO, is_dir = NO;
      NSMutableString *s = [[[NSMutableString alloc] initWithString: ptc]
		 autorelease];

      if (i != 0)
	[matrix insertRow: i];

      cell = [matrix cellAtRow: i column: 0];
      [cell setStringValue: [files objectAtIndex: i]];

      [s appendString: @"/"];
      [s appendString: [files objectAtIndex: i]];
      exists = [fm fileExistsAtPath: s isDirectory: &is_dir];

      if (exists && is_dir)
	[cell setLeaf: NO];
      else
	[cell setLeaf: YES];
    }
}

- (void) browser: (NSBrowser*)sender willDisplayCell: (id)cell
	   atRow: (int)row
	  column: (int)column
{
}

- (BOOL) browser: (NSBrowser *)sender selectCellWithString: (NSString *)title
        inColumn: (int)column
{
  NSString *ptc = [sender pathToColumn: column];
  NSMutableString *s = [[[NSMutableString alloc] initWithString: ptc]
	     autorelease];

  NSLog(@"-browser: selectCellWithString {%@}", title);

  if (column > 0)
    [s appendString: @"/"];
  [s appendString: title];

  NSLog(@"-browser: source path: %@", s);
}

- (BOOL) fileManager: (NSFileManager*)fileManager
	 shouldProceedAfterError: (NSDictionary*)errorDictionary
{
  return YES;
}

@end

// Save panel
@implementation NSSavePanel

/*
 * Class methods
 */
+ (void) initialize
{
  if (self == [NSSavePanel class])
    [self setVersion: 1];             //initial version
}

/*
 * Creating an NSSavePanel
 */
+ (NSSavePanel *) savePanel
{
  if (!gnustep_gui_save_panel)
    {
      if (![GMModel loadIMFile : @"SavePanel" owner: [_SavePanel alloc]])
	{
	  NSLog(@"Cannot open save panel model file\n");
	  exit(1);
	}
    }

  return gnustep_gui_save_panel;
}

/*
 * Instance methods
 */
/*
 * Initialization
 */
- (void) setDefaults
{
  directory = @"\\";
  file_name = @"";
  _accessoryView = nil;
  panel_title = @"Save File";
  panel_prompt = @"";
  required_type = nil;
  treatsFilePackagesAsDirectories = YES;
}

- (id) init
{
  [super init];

  [self setDefaults];
  return self;
}

/*
 * Customizing the NSSavePanel
 */
- (void) setAccessoryView: (NSView *)aView
{
  _accessoryView = aView;
}

- (NSView *) accessoryView
{
  return _accessoryView;
}

-(void) validateVisibleColumns
{
}

- (void) setTitle: (NSString *)title
{
  [titleField setStringValue: title];
}

- (NSString *) title
{
  return [titleField stringValue];
}

- (void) setPrompt: (NSString *)prompt
{
  // does currently not work since i went with NSTextField instead of NSForm
  [[form cell] setTitle: prompt];
}

- (NSString *) prompt
{
  return [[form cell] title];
}

/*
 * Setting Directory and File Type
 */
- (NSString *) requiredFileType
{
  if (!requiredTypes || ![requiredTypes count])
    return nil;

  return [requiredTypes objectAtIndex: 0];
}

- (void) setDirectory: (NSString *)path
{
  NSString *standardizedPath = [path stringByStandardizingPath];

  if (standardizedPath)
    {
      [browser setPath: standardizedPath];
      if (lastValidPath)
	[lastValidPath autorelease];
      lastValidPath = [path retain];
    }
}
- (void) setRequiredFileType: (NSString *)type
{
  if (requiredTypes)
    [requiredTypes autorelease];
  requiredTypes = [[NSArray arrayWithObject: type] retain];
}

- (void) setTreatsFilePackagesAsDirectories: (BOOL)flag
{
  treatsFilePackagesAsDirectories = flag;
}

- (BOOL) treatsFilePackagesAsDirectories
{
  return treatsFilePackagesAsDirectories;
}

/*
 * Running the NSSavePanel
 */
- (int) runModalForDirectory: (NSString *)path file: (NSString *)name
{
  int ret;

  //[browser loadColumnZero];
  [self setDirectory: path];
  //[browser setPath: [NSString stringWithFormat: @"%@/%@",
  //[self directory], name]];
  //[form setStringValue: name];
  [self selectText: self];       // or should it be browser?
/*
  if ([self class] == [NSOpenPanel class])
    [okButton setEnabled:
	  ([browser selectedCell] && [self canChooseDirectories]) ||
		 [[browser selectedCell] isLeaf]];
*/
  [self makeKeyAndOrderFront: self];
  ret = [[NSApplication sharedApplication] runModalForWindow: self];

  // replace warning
/*
  if ([self class] == [NSSavePanel class]
     && [[browser selectedCell] isLeaf] && ret == NSOKButton)
    {
      //if (NSRunAlertPanel(@"Save",@"The file %@ in %@ exists. Replace it?",
      //dafplace",@"Cancel",nil,[form stringValue],
      // [self directory]) == NSAlertAlternateReturn)
      return NSCancelButton;
    }
*/

  return ret;
}

- (int) runModal
{
  return [self runModalForDirectory: [self directory] file: @""];
}

/*
 * Reading Save Information
 */
- (NSString *) directory
{
  NSString *path;

  if ([[browser selectedCell] isLeaf])     // remove file component of path
    path = [[browser path] stringByDeletingLastPathComponent];
  else
    path = [browser path];

  if (![path length])
    return lastValidPath;
  else
    return path;
}

- (NSString *) filename
{
  NSString *ret = [NSString stringWithFormat: @"%@/%@",[self directory],
						    [form stringValue]];

  /* if path does not exist ask the user to create each missing directory */
  if ([[self requiredFileType] length] && ![ret hasSuffix: [NSString
		stringWithFormat: @".%@",[self requiredFileType]]])
    ret = [NSString stringWithFormat: @"%@.%@",ret,[self requiredFileType]];

  return [ret stringByExpandingTildeInPath];
}

/*
 * Target and Action Methods
 */
- (void) ok: (id)sender
{
  if (![self panel: self isValidFilename: [self filename]])
    return;

  [[NSApplication sharedApplication] stopModalWithCode: NSOKButton];
  [self orderOut: self];
}

- (void) cancel: (id)sender
{
  [[NSApplication sharedApplication] stopModalWithCode: NSCancelButton];
  [self orderOut: self];
}

/*
 * Responding to User Input
 */
- (void) selectText: (id)sender
{
  [form selectText: sender];
}

/*
 * Methods Implemented by the Delegate
 */
- (NSComparisonResult) panel: (id)sender
	     compareFilename: (NSString *)filename1
			with: (NSString *)filename2
	       caseSensitive: (BOOL)caseSensitive
{
  if ([delegate respondsToSelector:
		@selector(panel: compareFilename: with: caseSensitive: )])
    return [delegate panel: sender
	   compareFilename: filename1
		      with: filename2
	     caseSensitive: caseSensitive];

  return NSOrderedSame;
}

- (BOOL) panel: (id)sender shouldShowFilename: (NSString *)filename
{
  if ([delegate respondsToSelector: @selector(panel: shouldShowFilename: )])
    return [delegate panel: sender shouldShowFilename: filename];
  return NO;
}

- (BOOL) panel: (id)sender isValidFilename: (NSString*)filename
{
  if ([self delegate] && [[self delegate]
    respondsToSelector: @selector(panel: isValidFilename: )])
    return [[self delegate] panel: sender isValidFilename: filename];

  return YES;
}

/*
 * NSCoding protocol
 */
- (void) encodeWithCoder: (NSCoder*)aCoder
{
  [aCoder encodeObject: _accessoryView];
  [aCoder encodeObject: panel_title];
  [aCoder encodeObject: panel_prompt];
  [aCoder encodeObject: directory];
  [aCoder encodeObject: file_name];
  [aCoder encodeObject: required_type];
  [aCoder encodeValueOfObjCType: @encode(BOOL) at: &required_type];
  [aCoder encodeConditionalObject: delegate];
}

- (id) initWithCoder: (NSCoder*)aDecoder
{
  _accessoryView = [aDecoder decodeObject];
  panel_title = [aDecoder decodeObject];
  panel_prompt = [aDecoder decodeObject];
  directory = [aDecoder decodeObject];
  file_name = [aDecoder decodeObject];
  required_type = [aDecoder decodeObject];
  [aDecoder decodeValueOfObjCType: @encode(BOOL) at: &required_type];
  delegate = [aDecoder decodeObject];

  return self;
}

@end