apps-projectcenter/PCLib/PCProjectManager.m

/*
   GNUstep ProjectCenter - http://www.gnustep.org

   Copyright (C) 2000-2002 Free Software Foundation

   Author: Philippe C.D. Robert <probert@siggraph.org>

   This file is part of GNUstep.

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

   This application 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 General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.

   $Id$
*/

#include "PCProjectManager.h"
#include "PCDefines.h"
#include "PCProject.h"
#include "PCServer.h"
#include "PCBrowserController.h"
#include "PCEditorController.h"
#include "ProjectComponent.h"
#include "ProjectType.h"
#include "PCProject+ComponentHandling.h"
#include "ProjectBuilder.h"

#include "PCProjectManager+UInterface.h"

#define SavePeriodDCN @"SavePeriodDidChangeNotification"

NSString *ActiveProjectDidChangeNotification = @"ActiveProjectDidChange";

@implementation PCProjectManager

// ===========================================================================
// ==== Intialization & deallocation
// ===========================================================================

- (id)init
{
    if ((self = [super init])) {
        NSUserDefaults *defs = [NSUserDefaults standardUserDefaults];
	SEL sall = @selector(saveAllProjectsIfNeeded);
	SEL spdc = @selector(resetSaveTimer:);
	NSTimeInterval interval = [[defs objectForKey:AutoSavePeriod] intValue];

       	loadedProjects = [[NSMutableDictionary alloc] init];

        rootBuildPath = [[defs stringForKey:RootBuildDirectory] copy];
        if (!rootBuildPath || [rootBuildPath isEqualToString:@""]) {
            rootBuildPath = [NSTemporaryDirectory() copy];
        }

        if( [[defs objectForKey:AutoSave] isEqualToString:@"YES"] ) {
	    saveTimer = [NSTimer scheduledTimerWithTimeInterval:interval
	                                                 target:self
	                                               selector:sall
                                                       userInfo:nil
                                                        repeats:YES];
        }

        [[NSNotificationCenter defaultCenter] addObserver:self 
	                                         selector:spdc 
						     name:SavePeriodDCN 
						   object:nil];

	_needsReleasing = NO;
    }
    return self;
}

- (void)dealloc
{
    RELEASE(rootBuildPath);
    RELEASE(loadedProjects);

    if( [saveTimer isValid] )
    {
        [saveTimer invalidate];
    }

    [[NSNotificationCenter defaultCenter] removeObserver:self];
  
    if (_needsReleasing) 
    {
      RELEASE(inspector);
      RELEASE(inspectorView);
      RELEASE(inspectorPopup);
    }
  
    [super dealloc];
}

// ===========================================================================
// ==== Delegate
// ===========================================================================

- (id)delegate
{
    return delegate;
}

- (void)setDelegate:(id)aDelegate
{
    delegate = aDelegate;
}

// ===========================================================================
// ==== Timer handling
// ===========================================================================

- (void)resetSaveTimer:(NSNotification *)notif
{
    NSTimeInterval interval = [[notif object] intValue];
    SEL sall = @selector(saveAllProjectsIfNeeded);

    if( [saveTimer isValid] ) 
    {
        [saveTimer invalidate];
    }
  
    saveTimer = [NSTimer scheduledTimerWithTimeInterval:interval
						 target:self
					       selector:sall
					       userInfo:nil
						repeats:YES];
}

// ===========================================================================
// ==== Project management
// ===========================================================================

- (NSMutableDictionary *)loadedProjects
{
    return loadedProjects;
}

- (PCProject *)activeProject
{
  return activeProject;
}

- (void)setActiveProject:(PCProject *)aProject
{
    if (aProject != activeProject) {
        activeProject = aProject;

        [[NSNotificationCenter defaultCenter] postNotificationName:ActiveProjectDidChangeNotification object:activeProject];
    
        //~ Is this needed?
        if (activeProject) {
            [[activeProject projectWindow] makeKeyAndOrderFront:self];
        }
    
        if ([inspector isVisible]) {
          [self inspectorPopupDidChange:inspectorPopup];
        }
    }
}

- (void)saveAllProjectsIfNeeded
{
    NSUserDefaults *defs = [NSUserDefaults standardUserDefaults];

    if( [[defs objectForKey:AutoSave] isEqualToString:@"YES"] ) 
    {
        [self saveAllProjects];
    }
    else 
    {
        if( [saveTimer isValid] ) 
	{
	    [saveTimer invalidate];
	}
    }
}

- (void)saveAllProjects
{
    NSEnumerator *enumerator = [loadedProjects keyEnumerator];
    NSString *key;
    BOOL ret;
    PCProject *project;

    while ( (key = [enumerator nextObject]) )
    {
        project = [loadedProjects objectForKey:key];
	ret = [project save];

        if( ret == NO ) 
	{
            NSRunAlertPanel(@"Attention!",
                            @"Couldn't save project %@!", 
                            @"OK",nil,nil,[project projectName]);
        }
    }
}

- (NSString *)rootBuildPath
{
    return rootBuildPath;
}

- (NSString *)projectPath
{
  return [activeProject projectPath];
}

- (NSString *)selectedFileName
{
  return [[activeProject browserController] nameOfSelectedFile];
}

// ===========================================================================
// ==== Project actions
// ===========================================================================

- (PCProject *)loadProjectAt:(NSString *)aPath
{    
  if (delegate && [delegate respondsToSelector:@selector(projectTypes)])
  {
    NSDictionary *builders = [delegate projectTypes];
    NSEnumerator *enumerator = [builders keyEnumerator];
    NSString 	 *builderKey;
    
    while ((builderKey = [enumerator nextObject]))
    {
      id<ProjectType>	concretBuilder;
      PCProject		*project;
      
#ifdef DEBUG
      NSLog([NSString stringWithFormat:@"Builders %@ for key %@",[builders description],builderKey]);
#endif // DEBUG
      
      concretBuilder = [NSClassFromString([builders objectForKey:builderKey]) sharedCreator];
      
      if ((project = [concretBuilder openProjectAt:aPath])) 
      {
	return project;
      }
    }
  }

  NSRunAlertPanel(@"Loading Project Failed!",@"Could not load project '%@'!",@"OK",nil,nil,aPath); 

  return nil;
}

- (BOOL)openProjectAt:(NSString *)aPath
{
    BOOL isDir = NO;

    if ([loadedProjects objectForKey:aPath]) 
    {
        NSRunAlertPanel(@"Attention!",
	                @"Project '%@' has already been opened!", 
			@"OK",nil,nil,aPath);
	return NO;
    }
    
    if ([[NSFileManager defaultManager] fileExistsAtPath:aPath 
                                             isDirectory:&isDir] && !isDir) 
    {
	PCProject *project = [self loadProjectAt:aPath];
      
	if (!project) 
	{
	    return NO;
	}
      
	[project setProjectBuilder:self];
	[loadedProjects setObject:project forKey:aPath];
	[self setActiveProject:project];
	[project setDelegate:self];

	[project validateProjectDict];

	return YES;
    }
    return NO;
}

- (BOOL)createProjectOfType:(NSString *)projectType path:(NSString *)aPath
{
    Class	creatorClass = NSClassFromString(projectType);
    PCProject * project;

    if (![creatorClass conformsToProtocol:@protocol(ProjectType)]) 
    {
        [NSException raise:NOT_A_PROJECT_TYPE_EXCEPTION 
	            format:@"%@ does not conform to ProjectType!",projectType];
        return NO;
    }

    if (!(project = [[creatorClass sharedCreator] createProjectAt:aPath])) 
    {
        return NO;
    }

    [[project projectWindow] center];

    [project setProjectBuilder:self];
    
    aPath = [aPath stringByAppendingPathComponent: [aPath lastPathComponent]];
    aPath = [aPath stringByAppendingPathExtension: @"pcproj"];
    [loadedProjects setObject:project forKey:aPath];
    
    [self setActiveProject:project];
    [project setDelegate:self];
    
    return YES;
}

- (BOOL)saveProject
{
  BOOL ret;

  if (![self activeProject])
    {
      return NO;
    }

  // Save PC.project and the makefiles!
  ret = [activeProject save];
  if( ret == NO )
    {
      NSRunAlertPanel(@"Attention!",
		      @"Couldn't save project %@!", 
		      @"OK",nil,nil,[activeProject projectName]);
    }
  return YES;
}

- (BOOL)saveProjectAs:(NSString *)projName
{
  return NO;
}

- (void)inspectorPopupDidChange:(id)sender
{
    NSView *view = nil;
  
    if (![self activeProject]) 
    {
	return;
    }
  
    switch([sender indexOfSelectedItem]) 
    {
	case 0:
	    view = [[[self activeProject] updatedAttributeView] retain];
	    break;
	case 1:
	    view = [[[self activeProject] updatedProjectView] retain];
	    break;
	case 2:
	    view = [[[self activeProject] updatedFilesView] retain];
	    break;
    }

    [(NSBox *)inspectorView setContentView:view];
    [inspectorView display];
}

- (void)showInspectorForProject:(PCProject *)aProject
{
    if (!inspectorPopup) 
    {
	[self _initUI];

	[inspectorPopup removeAllItems];
	[inspectorPopup addItemWithTitle:@"Build Attributes"];
	[inspectorPopup addItemWithTitle:@"Project Attributes"];
	[inspectorPopup addItemWithTitle:@"File Attributes"];
    }
  
    [self inspectorPopupDidChange:inspectorPopup];  

    if (![inspector isVisible]) 
    {
	[inspector setFrameUsingName:@"Inspector"];
    }
    [inspector makeKeyAndOrderFront:self];
}

- (void)revertToSaved
{
}

- (BOOL)newSubproject
{
    return NO;
}

- (BOOL)addSubprojectAt:(NSString *)path
{
    return NO;
}

- (void)removeSubproject
{
}

- (void)closeProject:(PCProject *)aProject
{
  PCProject *currentProject = nil;
  NSString  *path = [aProject projectPath];
  NSString  *projectName = [path lastPathComponent];
  NSString  *key;

  key = [path stringByAppendingPathComponent:projectName];
  key = [key stringByAppendingPathExtension:@"pcproj"];

  currentProject = RETAIN([loadedProjects objectForKey:key]);
  if (!currentProject)
    {
      return;
    }

  // Remove it from the loaded projects! This is the only place it
  // is retained, so it should dealloc after this.
  [loadedProjects removeObjectForKey:key];
  if ([loadedProjects count] == 0)
    [self setActiveProject: nil];
  else if (currentProject == [self activeProject])
    [self setActiveProject:[[loadedProjects allValues] lastObject]];

  if ([loadedProjects count] == 0) 
    {
      [inspector performClose:self];
    }

  RELEASE(currentProject);
}

- (void)closeProject
{
  [[[self activeProject] projectWindow] performClose:self];
}

// ===========================================================================
// ==== File actions
// ===========================================================================

- (BOOL)saveAllFiles
{
  return [[activeProject editorController] saveAllFiles];
}

- (BOOL)saveFile
{
  return [[activeProject editorController] saveFile];
}

- (BOOL)saveFileAs:(NSString *)path
{
  return [[activeProject editorController] saveFileAs:path];
}

- (BOOL)saveFileTo:(NSString *)path
{
  return [[activeProject editorController] saveFileTo:path];
}

- (BOOL)revertFileToSaved
{
  return [[activeProject editorController] revertFileToSaved];
}

- (void)closeFile
{
  return [[activeProject editorController] closeFile:self];
}

- (BOOL)renameFileTo:(NSString *)path
{
  return YES;
}

- (BOOL)removeFilesPermanently:(BOOL)yn
{
  if (!activeProject)
    {
      return NO;
    }

  return [activeProject removeSelectedFilesPermanently:yn];
}

@end

@implementation  PCProjectManager (FileManagerDelegates)

- (NSString *)fileManager:(id)sender willCreateFile:(NSString *)aFile withKey:(NSString *)key
{
    NSString *path = nil;
  
#ifdef DEBUG
    NSLog(@"%@ %x: will create file %@ for key %@",[self class],self,aFile,key);
#endif // DEBUG

    if ([activeProject doesAcceptFile:aFile forKey:key] ) 
    {
	path = [[activeProject projectPath] stringByAppendingPathComponent:aFile];
    }

    return path;
}

- (void)fileManager:(id)sender didCreateFile:(NSString *)aFile withKey:(NSString *)key
{
#ifdef DEBUG
    NSLog(@"%@ %x: did create file %@ for key %@",[self class],self,aFile,key);
#endif // DEBUG

    [activeProject addFile:aFile forKey:key];
}

- (id)fileManagerWillAddFiles:(id)sender
{
    return activeProject;
}

- (BOOL)fileManager:(id)sender shouldAddFile:(NSString *)file forKey:(NSString *)key
{
    NSMutableString *fn = [NSMutableString stringWithString:[file lastPathComponent]];

#ifdef DEBUG
    NSLog(@"%@ %x: should add file %@ for key %@",[self class],self,file,key);
#endif // DEBUG
  
    if ([key isEqualToString:PCLibraries]) 
    {
	[fn deleteCharactersInRange:NSMakeRange(1,3)];
	fn = (NSMutableString *)[fn stringByDeletingPathExtension];
    }
  
    if ([[[activeProject projectDict] objectForKey:key] containsObject:fn]) 
    {
	NSRunAlertPanel(@"Attention!",
	                @"The file %@ is already part of project %@!",
			@"OK",nil,nil,fn,[activeProject projectName]);
	return NO;
    }
    return YES;
}

- (void)fileManager:(id)sender didAddFile:(NSString *)file forKey:(NSString *)key
{
#ifdef DEBUG
    NSLog(@"%@ %x: did add file %@ for key %@",[self class],self,file,key);
#endif // DEBUG

    [activeProject addFile:file forKey:key];
}

@end