libs-gui/Source/GSInfoPanel.m

/*
   GSInfoPanel.m

   Standard GNUstep info panel

   Copyright (C) 2000 Free Software Foundation, Inc.

   Author:  Nicola Pero <n.pero@mi.flashnet.it>
   Date: January 2000

   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 <AppKit/NSApplication.h>
#include <AppKit/NSButton.h>
#include <AppKit/NSFont.h>
#include <AppKit/NSImage.h>
#include <AppKit/NSTextField.h>
#include <AppKit/GSInfoPanel.h>
#include <Foundation/NSBundle.h>
#include <Foundation/NSDictionary.h>
#include <Foundation/NSString.h>

static id 
_value_from_info_plist_for_key (NSString *key)
{
  static NSDictionary *d = nil;
  /* We use this additional BOOL so that if loading Info-gnustep.plist fails once, 
     we do not try again. */
  static BOOL load_failed = NO;
  
  if ((d == nil) && (load_failed == NO))
    {
      NSBundle *b;
      NSString *f;

      b = [NSBundle mainBundle];
      f = [b pathForResource: @"Info-gnustep" ofType: @"plist"];
      d = [NSDictionary dictionaryWithContentsOfFile: f];
      
      if (d == nil)
	load_failed = YES;
    }

  if (d)
    return [d objectForKey: key];      
  
  return nil;
}

static inline BOOL 
_nil_or_not_of_class (id object, Class class)
{
  return ((object == nil) || ([object isKindOfClass: class] == NO));
}

static NSTextField *
_new_label (NSString *value)
{
  NSTextField *t;

  t = [[NSTextField new] autorelease];
  [t setStringValue: value];
  [t setDrawsBackground: NO];
  [t setEditable: NO];
  [t setSelectable: NO];
  [t setBezeled: NO];
  [t setBordered: NO];
  [t setAlignment: NSLeftTextAlignment];
  return t;
}



/*
 * An object that displays a list of left-aligned strings (used for the authors)
 */
@interface _GSLabelListView: NSView
{
}
/* After initialization, its size is the size it needs, just move it
   where we want it to show */
-initWithStringArray: (NSArray *)array
		font: (NSFont *)font;
@end
@implementation _GSLabelListView
{
}
-initWithStringArray: (NSArray *)array
		font: (NSFont *)font
{
  int         count;
  NSTextField *field;
  int         i;
  float       height = 2;
  float       width = 0;
  NSRect      r;

  self = [super init];

  count = [array count];

  for (i = 0; i < count; i++)
    {
      if ([[array objectAtIndex: i] isKindOfClass: [NSString class]] == NO)
	continue;
      field = _new_label ([array objectAtIndex: i]);
      [field setFont: font];
      [field sizeToFit];
      [field setAutoresizingMask: NSViewNotSizable];
      r = [field frame];
      r.origin.x = 0;
      r.origin.y = height;
      if (r.size.width > width)
	width = r.size.width;
      height += r.size.height + 2;
      [field setFrame: r];
      [self setFrameSize: NSMakeSize (width, height)];
      [self addSubview: field];
    }
  [self setFrameSize: NSMakeSize (width, height - 2)];
  return self;
}
@end


@implementation GSInfoPanel: NSPanel
+ (void) initialize
{
  if (self == [GSInfoPanel class])
    {
      [self setVersion: 1];
    }
}

-(id) initWithDictionary: (NSDictionary *)dictionary;
{
  /* Info to show */
  NSString *name = nil;
  NSString *description = nil;
  NSImage  *icon = nil;
  NSString *release = nil;
  NSString *fullVersionID = nil;
  NSArray  *authors = nil;
  NSString *url = nil;
  NSString *copyright = nil;
  NSString *copyrightDescription = nil;

  /* GUI Objects used to show the Info */
  NSButton *iconButton;
  NSTextField *nameLabel;
  NSTextField *descriptionLabel = nil;
  NSTextField *versionLabel;
  _GSLabelListView *authorsList;
  NSTextField *authorTitleLabel;
  NSTextField *urlLabel = nil;
  NSTextField *copyrightLabel;
  NSTextField *copyrightDescriptionLabel = nil;
  NSFont      *smallFont;

  /* Minimum size we use for the panel */
  float       width = 241;
  float       height = 107;

  /* Used for computations */
  float       tmp_A;
  float       tmp_a;
  float       tmp_b;
  float       tmp_c;
  NSRect      f;
  NSView      *cv;
  
  /*
   * Gets what we need to show
   */
  
  /* Application Name */ 
  if (dictionary)
    name = [dictionary objectForKey: @"ApplicationName"];

  if (_nil_or_not_of_class (name, [NSString class]))
    {
      name = _value_from_info_plist_for_key (@"ApplicationName");
      
      if (_nil_or_not_of_class (name, [NSString class]))
	{
	  name = _value_from_info_plist_for_key (@"NSHumanReadableShortName");

	  if (_nil_or_not_of_class (name, [NSString class]))
	    name = [[NSProcessInfo processInfo] processName]; 
	}
    }
  /* Application Description */
  if (dictionary)
    description = [dictionary objectForKey: @"ApplicationDescription"];

  if (_nil_or_not_of_class (description, [NSString class]))
    {
      description = _value_from_info_plist_for_key 
	(@"ApplicationDescription");
      
      if ([description isKindOfClass: [NSString class]] == NO)
	description = nil;
    }
  /* NB: description might be nil */
  /* Application Icon */
  if (dictionary)
    icon = [dictionary objectForKey: @"ApplicationIcon"];
  
  if (_nil_or_not_of_class (icon, [NSImage class]))
    {
      icon = [NSImage imageNamed: @"NSApplicationIcon"];
      
      if (_nil_or_not_of_class (icon, [NSImage class]))
	icon = [NSApp applicationIconImage];
    }
  /* Release */
  if (dictionary)
    release = [dictionary objectForKey: @"ApplicationRelease"];
  
  if (_nil_or_not_of_class (release, [NSString class]))
    {
      if (dictionary)
	release = [dictionary objectForKey: @"ApplicationVersion"];
      
      if (_nil_or_not_of_class (release, [NSString class]))
	{
	  release = _value_from_info_plist_for_key (@"ApplicationRelease");
  
	  if (_nil_or_not_of_class (release, [NSString class]))
	    {
	      release = _value_from_info_plist_for_key (@"NSAppVersion");
	      
	      if (_nil_or_not_of_class (release, [NSString class]))
		release = @"Unknown";
	    }
	}
    }
  /* FullVersionID */
  if (dictionary)
    fullVersionID = [dictionary objectForKey: @"FullVersionID"];

  if (_nil_or_not_of_class (fullVersionID, [NSString class]))
    {
      if (dictionary)
	fullVersionID = [dictionary objectForKey: @"Version"];

      if (_nil_or_not_of_class (fullVersionID, [NSString class]))
	{
	  fullVersionID = _value_from_info_plist_for_key (@"NSBuildVersion");
	  if ([fullVersionID isKindOfClass: [NSString class]] == NO)
	    fullVersionID = nil;
	}
    }
  /* NB: fullVersionID can be nil! */

  /* Now we prepare the complete release string */
  release = [@"Release: " stringByAppendingString: release];
  if (fullVersionID)
    {
      release = [release stringByAppendingString: @" ("];
      release = [release stringByAppendingString: fullVersionID];
      release = [release stringByAppendingString: @")"];
    }
  /* Authors */
  if (dictionary)
    authors = [dictionary objectForKey: @"Authors"];

  if (_nil_or_not_of_class (authors, [NSArray class]))
    {
      authors = _value_from_info_plist_for_key (@"Authors");

      if (_nil_or_not_of_class (authors, [NSArray class]))
	authors = [NSArray arrayWithObject: @"Unknown"];
    }
  /* URL */
  if (dictionary)
    url = [dictionary objectForKey: @"URL"];

  if ([url isKindOfClass: [NSString class]] == NO)
    url = nil;
  /* NB: URL can be nil */

  /* Copyright */
  if (dictionary)
    copyright = [dictionary objectForKey: @"Copyright"];

  if (_nil_or_not_of_class (copyright, [NSString class]))
    {
      copyright = _value_from_info_plist_for_key (@"Copyright");

      if (_nil_or_not_of_class (copyright, [NSString class]))
	{
	  copyright = _value_from_info_plist_for_key 
	    (@"NSHumanReadableCopyright");
	  
	  if (_nil_or_not_of_class (copyright, [NSString class]))
	    copyright = @"Copyright Information Not Available";
	}
    }
  /* Copyright Description */
  if (dictionary)
    copyrightDescription = [dictionary objectForKey: @"CopyrightDescription"];

  if (_nil_or_not_of_class (copyrightDescription, [NSString class]))
    {
      copyrightDescription = _value_from_info_plist_for_key 
	(@"CopyrightDescription");

      if ([copyrightDescription isKindOfClass: [NSString class]] == NO)
	copyrightDescription = nil;
    }
  /* NB: copyrightDescription can be nil */
  
  /*
   * Create GUI Objects 
   */
  f = NSZeroRect;
  f.size = [icon size];
  iconButton = [[[NSButton alloc] initWithFrame: f] autorelease]; 
  [iconButton setImage: icon];
  [iconButton setBordered: NO];
  [iconButton setEnabled: NO];
  [iconButton setImagePosition: NSImageOnly];

  nameLabel = _new_label (name);
  [nameLabel setFont: [NSFont fontWithName: @"Helvetica-BoldOblique"
			      size: 32]];
  [nameLabel sizeToFit];
  // Workaround for a bug somewhere in NSFont with italic fonts
  f = [nameLabel frame];
  f.size.width += 20;
  [nameLabel setFrame: f];

  if (description)
    {
      descriptionLabel = _new_label (description);
      [descriptionLabel setFont: [NSFont fontWithName: 
					   @"Helvetica-BoldOblique"
					 size: 14]];
      [descriptionLabel sizeToFit];
      // Workaround for bug somewhere in NSFont with italic fonts
      f = [descriptionLabel frame];
      f.size.width += 20;
      [descriptionLabel setFrame: f];
    }

  //smallFont = [NSFont fontWithName: @"Helvetica-Narrow" size: 14];
  smallFont = [NSFont fontWithName: @"Helvetica" size: 12];
  
  versionLabel = _new_label (release);
  [versionLabel setFont: smallFont];
  [versionLabel sizeToFit];

  if ([authors count] == 1)
    {
      authorTitleLabel = _new_label (@"Author: ");
    }
  else
    {
      authorTitleLabel = _new_label (@"Authors: ");
    }
  [authorTitleLabel setFont: smallFont];
  [authorTitleLabel sizeToFit];

  authorsList = [[[_GSLabelListView alloc] initWithStringArray: authors
					   font: smallFont] autorelease];  
  
  if (url)
    {
      urlLabel = _new_label (url);
      [urlLabel setFont: smallFont];
      [urlLabel sizeToFit];
    }

  copyrightLabel = _new_label (copyright);
  [copyrightLabel setFont: smallFont];
  [copyrightLabel sizeToFit];

  if (copyrightDescription)
    {
      copyrightDescriptionLabel = _new_label (copyrightDescription);
      [copyrightDescriptionLabel setFont: smallFont];
      [copyrightDescriptionLabel sizeToFit];
    }

  /*
   * Compute width and height of the panel
   */

  /** width **/
  tmp_A = [icon size].width;
  /* distance between icon and title */
  tmp_A += 10;
  /* compute the maximum of the following three sizes */
  tmp_a = [nameLabel frame].size.width;
  if (description)
    {
      tmp_b = [descriptionLabel frame].size.width;

      if (tmp_a < tmp_b)
	tmp_a = tmp_b;
    }
  
  tmp_b = [versionLabel frame].size.width;

  if (tmp_a < tmp_b)
    tmp_a = tmp_b;
  /* Add in to tmp_A */
  tmp_A += tmp_a;
  /* Update width */
  if (width < tmp_A)
    width = tmp_A;

  tmp_A = [authorTitleLabel frame].size.width; 
  tmp_A += [authorsList frame].size.width;
  if (width < tmp_A)
    width = tmp_A;

  /* FIXME depending on where we put url */
  if (url)
    {
      tmp_A = [urlLabel frame].size.width;
      if (tmp_A > width)
	width = tmp_A;
    }

  tmp_A = [copyrightLabel frame].size.width;
  if (tmp_A > width)
    width = tmp_A;

  if (copyrightDescription)
    {
      tmp_A = [copyrightDescriptionLabel frame].size.width;
      if (tmp_A > width)
	width = tmp_A;
    }

  /* height */
  /* Warning: we implicitly assume icon height is approx of the standard height of 48.
     The code tries to be nice so that 50 or 47 should more or less work -- but beware 
     that 200 or 20 will *not* work. */
  tmp_A = [icon size].height;

  if (description)
    tmp_A += 10; 
  else
    tmp_A += 5;

  tmp_A += [versionLabel frame].size.height;
  tmp_A += 20;

  tmp_A += [authorsList frame].size.height;
  
  if (url)
    {
      tmp_A += [urlLabel frame].size.height + 2;
    }
  tmp_A += 25;
  tmp_A += [copyrightLabel frame].size.height;
  if (copyrightDescription)
    {
      tmp_A += 2;
      tmp_A += [copyrightDescriptionLabel frame].size.height;
    }

  if (tmp_A > height)
    height = tmp_A;

  /* Add border to both wihdt and height */
  width += 32;
  height += 36;

  /*
   * TODO: Adjust/check obtained width and height ?
   * (NB: If they are adjusted, code putting views in the panel 
   *  has to be adjusted too!)
   */

  /*
   * Creates the panel with the right width and height
   */
  self = [super initWithContentRect: NSMakeRect (100, 100, width, height)
		styleMask: (NSTitledWindowMask | NSClosableWindowMask) 
		backing: NSBackingStoreRetained defer: YES];
  /* 
   * Add objects to the panel in their position
   */
  cv = [self contentView];

  f = [iconButton frame];
  f.origin.x = 16;
  f.origin.y = height - 18 - f.size.height;
  tmp_a = f.origin.x + f.size.width + 10;
  tmp_b = f.origin.y;
  tmp_c = f.size.height;
  [cv addSubview: iconButton]; 
  [iconButton setFrame: f];

  f = [nameLabel frame];
  f.origin.x = tmp_a;
  /* NB: We relay upon the fact that the text in a text field is vertically centered 
     in its frame */
  if (description)
    f.origin.y = tmp_b + 10;
  else
    f.origin.y = tmp_b;
  f.size.height = tmp_c;
  [cv addSubview: nameLabel];
  [nameLabel setFrame: f];

  if (description)
    {
      f = [descriptionLabel frame];
      f.origin.x = tmp_a;
      f.origin.y = tmp_b - 5;
      [cv addSubview: descriptionLabel];
      [descriptionLabel setFrame: f];
    }

  f = [versionLabel frame];
  f.origin.x = width - 16 - f.size.width;
  if (description)
    f.origin.y = tmp_b - 10 - f.size.height;
  else
    f.origin.y = tmp_b - 5 - f.size.height;
  tmp_b = f.origin.y;
  [cv addSubview: versionLabel];
  [versionLabel setFrame: f];

  tmp_b -= 20;

  tmp_a = [authorTitleLabel frame].size.width;
  tmp_a += [authorsList frame].size.width;
  tmp_a = (width - tmp_a) / 2;
  
  f = [authorTitleLabel frame];
  f.origin.x = tmp_a;
  tmp_c = tmp_a + f.size.width;
  f.origin.y = tmp_b - f.size.height;
  [cv addSubview: authorTitleLabel];
  [authorTitleLabel setFrame: f];
  
  f = [authorsList frame];
  f.origin.x = tmp_c;
  f.origin.y = tmp_b - f.size.height;
  tmp_b = f.origin.y;
  [cv addSubview: authorsList];
  [authorsList setFrame: f];

  if (url)
    {
      /* FIXME position of this thing */
      f = [urlLabel frame];
      f.origin.x = tmp_a;
      f.origin.y = tmp_b - 2 - f.size.height;
      tmp_b = f.origin.y;
      [cv addSubview: urlLabel];
      [urlLabel setFrame: f];
    }

  f = [copyrightLabel frame];
  f.origin.x = (width - f.size.width) / 2;
  f.origin.y = tmp_b - 25 - f.size.height;
  tmp_b = f.origin.y;
  [cv addSubview: copyrightLabel];
  [copyrightLabel setFrame: f];

  if (copyrightDescription)
    {
      f = [copyrightDescriptionLabel frame];
      f.origin.x = (width - f.size.width) / 2;
      f.origin.y = tmp_b - 2 - f.size.height;
      [cv addSubview: copyrightDescriptionLabel];
      [copyrightDescriptionLabel setFrame: f];
    }

  [self center];
  return self;
}
@end