ProjectType.h

/*
    ProjectType.h
 
    Protocol declaration of the ProjectType protocol for the
    ProjectManager application.
 
    Copyright (C) 2005, 2006  Saso Kiselkov
 
    This program 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 program 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 General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
 
#import <Foundation/NSObject.h>
#import <Foundation/NSString.h>
#import <Foundation/NSDictionary.h>
 
@class NSArray, NSDictionary, NSImage;
 
@class ProjectDocument;

@protocol ProjectType <NSObject>
 
// ======== Class Methods =========

+ (NSString *) projectTypeID;

+ (NSString *) humanReadableProjectTypeName;

+ (NSString *) projectTypeDescription;

+ (NSImage *) projectTypeIcon;

+ (NSArray *) projectModules;

+ (NSDictionary *) projectTemplateDescriptions;

+ (NSString *) pathToProjectTemplate: (NSString *) templateName;
 
 
// ========= Instance Methods ==========

- initWithDocument: (ProjectDocument *) aProject
    infoDictionary: (NSDictionary *) infoDict
    projectModules: (NSArray *) modules;

- (NSDictionary *) infoDictionary;

- (BOOL) regenerateDerivedFiles;

- (NSString *) pathToSubprojectsDirectory;
 
@end

static inline NSDictionary *
PMCreateTemplateDescription(NSString * templateDescription,
                            NSImage * templateIcon)
{
  return [NSDictionary dictionaryWithObjectsAndKeys:
    templateDescription, @"Description",
    // templateIcon can be `nil' here!
    templateIcon, @"Icon",
    nil];
}