libs-base/Source/NSError.m

/** Implementation for NSError for GNUStep
   Copyright (C) 2004 Free Software Foundation, Inc.

   Written by:  Richard Frith-Macdonald <rfm@gnu.org>
   Date: May 2004

   This file is part of the GNUstep Base Library.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 31 Milk Street #960789 Boston, MA 02196 USA.
   */

#import "common.h"
#define	EXPOSE_NSError_IVARS	1
#import	"Foundation/NSDictionary.h"
#import	"Foundation/NSException.h"
#import	"Foundation/NSError.h"
#import	"Foundation/NSCoder.h"
#import	"Foundation/NSArray.h"

#import	"GSFastEnumeration.h"

@implementation	NSError

/* For NSFileManager we have a private method which produces an error
 * with mutable userInfo so that information can be added before the
 * file manager returns the error to higher level code.
 */
+ (NSError*) _error: (NSInteger)aCode
        description: (NSString*)description
{
  NSError		*e = [self allocWithZone: NSDefaultMallocZone()];
  NSMutableDictionary	*m;

  e = [e initWithDomain: NSCocoaErrorDomain code: aCode userInfo: nil];
  m = [NSMutableDictionary allocWithZone: NSDefaultMallocZone()];
  e->_userInfo = [m initWithCapacity: 3];
  [m setObject: description forKey: NSLocalizedDescriptionKey];
  return AUTORELEASE(e);
}

+ (id) errorWithDomain: (NSErrorDomain)aDomain
		  code: (NSInteger)aCode
	      userInfo: (NSDictionary*)aDictionary
{

  NSError	*e = [self allocWithZone: NSDefaultMallocZone()];

  e = [e initWithDomain: aDomain code: aCode userInfo: aDictionary];
  return AUTORELEASE(e);
}

- (NSInteger) code
{
  return _code;
}

- (id) copyWithZone: (NSZone*)z
{
  NSError	*e = [[self class] allocWithZone: z];

  e = [e initWithDomain: _domain code: _code userInfo: _userInfo];
  return e;
}

- (void) dealloc
{
  DESTROY(_domain);
  DESTROY(_userInfo);
  [super dealloc];
}

- (NSString*) _fallback
{
  return [NSString stringWithFormat: @"Error Domain=%@ Code=%lld",
    [self domain], (long long)[self code]];
}

- (NSString*) description
{
  NSMutableString	*m = [NSMutableString stringWithCapacity: 200];
  NSUInteger		count = [_userInfo count];
  NSString		*loc = [self localizedDescription];
  NSString		*fallback = [self _fallback];

  [m appendString: fallback];
  if (NO == [fallback isEqual: loc])
    {
      [m appendFormat: @" \"%@\"", loc];
    }

  if ([loc isEqual: [_userInfo objectForKey: NSLocalizedDescriptionKey]])
    {
      count--;	// Don't repeat this information
    }

  if (count > 0)
    {
      NSArray		*keys = [_userInfo allKeys];
      BOOL		first = YES;

      keys = [keys sortedArrayUsingSelector: @selector(compare:)];
      [m appendString: @" UserInfo={"];
      FOR_IN(NSString*, k, keys)
	{
	  id	o = [_userInfo objectForKey: k];

	  if ([k isEqualToString: NSLocalizedDescriptionKey])
	    {
	      continue;
	    }

	  if (first)
	    {
	      first = NO;
	    }
	  else
	    {
	      [m appendString: @", "];
	    }
	  [m appendString: k];
	  [m appendString: @"="];
	  if ([k isEqualToString: NSUnderlyingErrorKey])
	    {
	      [m appendFormat: @"%p {%@}", o, [o description]];
	    }
	  else
	    {
	      [m appendString: [o description]];
	    }
	}
      END_FOR_IN(keys)

      [m appendString: @"}"];
    }
  return m;
}

- (NSErrorDomain) domain
{
  return _domain;
}

- (void) encodeWithCoder: (NSCoder*)aCoder
{
  if ([aCoder allowsKeyedCoding])
    {
      [aCoder encodeInt: _code forKey: @"NSCode"];
      [aCoder encodeObject: _domain forKey: @"NSDomain"];
      [aCoder encodeObject: _userInfo forKey: @"NSUserInfo"];
    }
  else
    {
      [aCoder encodeValueOfObjCType: @encode(int) at: &_code];
      [aCoder encodeValueOfObjCType: @encode(id) at: &_domain];
      [aCoder encodeValueOfObjCType: @encode(id) at: &_userInfo];
    }
}

- (id) init
{
  return [self initWithDomain: nil code: 0 userInfo: nil];
}

- (id) initWithCoder: (NSCoder*)aCoder
{
  if ([aCoder allowsKeyedCoding])
    {
      int	c;
      id	d;
      id	u;

      c = [aCoder decodeIntForKey: @"NSCode"];
      d = [aCoder decodeObjectForKey: @"NSDomain"];
      u = [aCoder decodeObjectForKey: @"NSUserInfo"];
      self = [self initWithDomain: d code: c userInfo: u];
    }
  else
    {
      [aCoder decodeValueOfObjCType: @encode(int) at: &_code];
      [aCoder decodeValueOfObjCType: @encode(id) at: &_domain];
      [aCoder decodeValueOfObjCType: @encode(id) at: &_userInfo];
    }
  return self;
}

- (id) initWithDomain: (NSErrorDomain)aDomain
		 code: (NSInteger)aCode
	     userInfo: (NSDictionary*)aDictionary
{
  if (aDomain == nil)
    {
      NSLog(@"[%@-%@] with nil domain",
	NSStringFromClass([self class]), NSStringFromSelector(_cmd));
      DESTROY(self);
    }
  else if ((self = [super init]) != nil)
    {
      ASSIGN(_domain, aDomain);
      _code = aCode;
      ASSIGN(_userInfo, aDictionary);
    }
  return self;
}

- (NSString *) localizedDescription
{
  NSString	*s = [_userInfo objectForKey: NSLocalizedDescriptionKey];

  if (nil == s)
    {
      s = [_userInfo objectForKey: NSLocalizedFailureReasonErrorKey];
      if (s)
	{
	  s = [NSString stringWithFormat: @"Operation failed %@", s];
	}
      else
        {
          s = [self _fallback];
        }
    }
  return s;
}

- (NSString *) localizedFailureReason
{
  return [_userInfo objectForKey: NSLocalizedFailureReasonErrorKey];
}

- (NSArray *) localizedRecoveryOptions
{
  return [_userInfo objectForKey: NSLocalizedRecoveryOptionsErrorKey];
}

- (NSString *) localizedRecoverySuggestion
{
  return [_userInfo objectForKey: NSLocalizedRecoverySuggestionErrorKey];
}

- (id) recoveryAttempter
{
  return [_userInfo objectForKey: NSRecoveryAttempterErrorKey];
}

- (NSDictionary*) userInfo
{
  return _userInfo;
}
@end