/** 
   EOQualifier.m <title>EOQualifier</title>

   Copyright (C) 2000,2002,2003,2004,2005 Free Software Foundation, Inc.

   Author: Mirko Viviani <mirko.viviani@gmail.com>
   Date: February 2000

   $Revision$
   $Date$

   <abstract></abstract>

   This file is part of the GNUstep Database Library.

   <license>
   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 3 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,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
   </license>
**/

#include "config.h"

RCS_ID("$Id$")

#include <stdio.h>
#include <string.h>
#include <stdarg.h>

#ifdef GNUSTEP
#include <Foundation/NSArray.h>
#include <Foundation/NSCoder.h>
#include <Foundation/NSDebug.h>
#include <Foundation/NSDictionary.h>
#include <Foundation/NSEnumerator.h>
#include <Foundation/NSException.h>
#include <Foundation/NSScanner.h>
#include <Foundation/NSSet.h>
#include <Foundation/NSValue.h>
#else
#include <Foundation/Foundation.h>
#endif

#ifndef GNUSTEP
#include <GNUstepBase/GNUstep.h>
#include <GNUstepBase/NSDebug+GNUstepBase.h>
#include <GNUstepBase/NSObject+GNUstepBase.h>
#endif

#include <GNUstepBase/GSObjCRuntime.h>

#include <EOControl/EOQualifier.h>
#include <EOControl/EONSAddOns.h>
#include <EOControl/EODebug.h>
#include <EOControl/EOClassDescription.h>

#include "EOPrivate.h"


NSString *EOQualifierVariableSubstitutionException=@"EOQualifierVariableSubstitutionException";


@implementation NSNumber (EOQualifierExtras)

- (id)initWithString: (NSString *)string
{
    double   dVal;
    float    fVal;
    int      iVal;

    dVal = [string doubleValue];
    fVal = [string floatValue];
    iVal = [string intValue];

    if (dVal == iVal)
      {
	return [self initWithInt: iVal];
      }
    else if (dVal == fVal)
      {
	return [self initWithFloat: fVal];
      }
    else
      {
	return [self initWithDouble: dVal];
      }
}
@end

@interface EOQualifier (Privat)
- (void) _addBindingsToDictionary: (NSMutableDictionary*)dictionary;
- (id) _qualifierMigratedToSubEntity: (id)param0
                    fromParentEntity: (id)param1;
@end

@implementation EOQualifier
static SEL cimSEL = NULL;
static NSCharacterSet *spaceSet;
static NSCharacterSet *alnumSet;
static NSCharacterSet *digitSet;
static BOOL (*spaceCIM)(id,SEL,unichar);
static BOOL (*alnumCIM)(id,SEL,unichar);
static BOOL (*digitCIM)(id,SEL,unichar);
+ (void)initialize
{
  if (cimSEL == NULL)
    {
      cimSEL = @selector(characterIsMember:);

      spaceSet
	= RETAIN([NSCharacterSet whitespaceAndNewlineCharacterSet]);
      spaceCIM = (BOOL(*)(id,SEL,unichar))[spaceSet methodForSelector: cimSEL];

      alnumSet
	= RETAIN([NSCharacterSet alphanumericCharacterSet]);
      alnumCIM = (BOOL(*)(id,SEL,unichar))[alnumSet methodForSelector: cimSEL];

      digitSet
	= RETAIN([NSCharacterSet decimalDigitCharacterSet]);
      digitCIM = (BOOL(*)(id,SEL,unichar))[digitSet methodForSelector: cimSEL];
    }
}

/**
 * Returns an autoreleased qualifier which is constructed by calling
 * [EOQualifier+qualifierWithQualifierFormat:varargList:]
 */
+ (EOQualifier *)qualifierWithQualifierFormat: (NSString *)qualifierFormat, ...
{
  EOQualifier *qualifier = nil;

  if(qualifierFormat)
    {
      va_list ap;

      va_start(ap, qualifierFormat);

      qualifier = [EOQualifier qualifierWithQualifierFormat: qualifierFormat
                               varargList: ap];

      va_end(ap);
    }

  return qualifier;
}

static NSString *getOperator(const unichar **cFormat, const unichar **s)
{
  NSString *operator;

  while (**s && spaceCIM(spaceSet,cimSEL,**s))
    (*s)++;

  *cFormat = *s;

  if (alnumCIM(alnumSet,cimSEL,**s))
    {
      while (**s && !spaceCIM(spaceSet,cimSEL,**s) 
	     && **s != '%' && **s != '\'')
        {
	  (*s)++;
        }

      operator = [NSString stringWithCharacters: *cFormat
			   length: *s - *cFormat];
    }
  else
    {
      while (**s && !alnumCIM(alnumSet, cimSEL, **s) 
	     && !spaceCIM(spaceSet, cimSEL, **s)
	     && **s != '%' && **s != '\'')
        {
	  NSDebugLog(@"avoid gcc 3.1.1 bug which optimizes to segfault");
	  (*s)++;
        }

      operator = [NSString stringWithCharacters: *cFormat 
			   length: *s - *cFormat];
    }

  *cFormat = *s;

  return operator;
}

static id
getKey(const unichar **cFormat, 
       const unichar **s,
       BOOL *isKeyValue,
       NSEnumerator *argsEnum,
       va_list *args)
{
  NSMutableString *key;
  NSString *classString = nil;
  unichar quoteChar;
  BOOL quoted = NO;
  BOOL literalNumber = NO;
  BOOL isQualVar = NO;
  BOOL isFormat = NO;

  while (**s && spaceCIM(spaceSet, cimSEL, **s))
    (*s)++;

  if (isKeyValue)
    {
      if (**s == '(')
        {
	  (*s)++; *cFormat = *s;

	  while (**s && **s != ')')
	    (*s)++;

	  NSCAssert(*s, @"Illegal Qualifer format missing bracket.");

	  classString = [NSString stringWithCharacters: *cFormat
				  length: *s - *cFormat];

	  (*s)++; *cFormat = *s;
        }
  
      if ((*s)[0] == 'n' && (*s)[1] == 'i' && (*s)[2] == 'l')
	{
	  unichar value = (*s)[3];

	  if (value != '_' && !alnumCIM(alnumSet,cimSEL,value))
	    {
	      *cFormat = *s = *s+3;
	      *isKeyValue = YES;
	      return nil;
	    }
	}
    }

  quoteChar = **s;
  if (quoteChar && (quoteChar == '"' || quoteChar == '\''))
    {
      quoted = YES;
      (*s)++;
    }
  
  *cFormat = *s;
  
  if (quoted)
    {
      while (**s && **s != quoteChar)
	(*s)++;

      key = [NSString stringWithCharacters: *cFormat length: *s - *cFormat];
      (*s)++; // skip closing quote
    }
  else
    {
      key = [NSMutableString stringWithCapacity:8];

      if (classString == nil 
	  && (digitCIM(digitSet, cimSEL, **s) 
	      || (**s == '-' && digitCIM(digitSet, cimSEL, *(*s+1)))))
	{
	  classString = @"NSNumber";
	  literalNumber = YES;
	}
	
      while (**s && (alnumCIM(alnumSet,cimSEL,**s) 
		     || **s == '@' || **s == '#' || **s == '_' || **s == '$' 
		     || **s == '%' || **s == '.' || **s == '-'))
        {
	  /* Parse format specifier */
	  if (**s == '%')
	    {
	      const char *argString;
	      NSString *argObj;
	      double argFloat; 
	      /* 'float' is promoted to 'double' when passed through '...'
		 (so you should pass 'double' not 'float' to `va_arg')
		 Ayers: I believe the compiler should do this promotion
		 implicitly but there are buggy compilers so cast to 
		 be safe.  */

	      int argInt;

	      /* TODO userInfo would be nice */
	      if (isQualVar)
		[NSException raise:NSInvalidArgumentException
				format:@"error parsing qualifier format"];

	      if (isKeyValue)
	        {
		  *isKeyValue = YES;
		}

	      switch (*(*s+1))
		{
		case '@':
		  if (args)
		    {
		      argObj = va_arg(*args, id);
		    }
		  else
		    {
		      argObj = [argsEnum nextObject];
		    }

		  if (isKeyValue && *isKeyValue == YES 
		      && quoted == NO && classString == nil)
		    {
		      *cFormat = *s = *s+2;
		      return argObj;
		    }
		  else
		    {
		      if (*cFormat != *s)
			{
			  NSString *str 
			    = [NSString stringWithCharacters: *cFormat
					length: *s - *cFormat];
			  [key appendString: str];
			}

		      [key appendString: [argObj description]];
		      *cFormat = *s+2;
		      (*s)++;
		    }
		  break;

		case 's':
		  if (args)
		    {
		      argString = va_arg(*args, const char *);
		    }
		  else
		    {
		      argString = [[argsEnum nextObject] cString];
		    }

		  if (isKeyValue && *isKeyValue == YES
		      && quoted == NO && classString == nil)
		    {
		      *cFormat = *s = *s + 2;
		      return [NSString stringWithCString: argString];
		    }
		  else
		    {
		      NSString *str;
		      if (*cFormat != *s)
			{
			  str = [NSString stringWithCharacters: *cFormat
					  length: *s - *cFormat];
			  [key appendString: str];
			}

		      str = [NSString stringWithCString: argString];
		      [key appendString: str];

		      *cFormat = *s + 2;
		      (*s)++;
		    }
		  break;

		case 'd':
		  if (args)
		    {
		      argInt = va_arg(*args, int);
		    }
		  else
		    {
		      argInt = [[argsEnum nextObject] intValue];
		    }

		  if (isKeyValue && *isKeyValue == YES
		      && quoted == NO && classString == nil)
		    {
		      *cFormat = *s = *s + 2;
		      return [NSNumber numberWithInt: argInt];
		    }
		  else
		    {
		      NSString *str;
		      if(*cFormat != *s)
			{
			  str = [NSString stringWithCharacters: *cFormat
					  length: *s - *cFormat];
			  [key appendString: str];
			}

		      str = [NSString stringWithFormat: @"%d", argInt];
		      [key appendString: str];

		      *cFormat = *s + 2;
		      (*s)++;
		    }
		  break;

		case 'f':
		  if (args)
		    {
		      /* 'float' is promoted to 'double' when passed through '...'
			 (so you should pass `double' not `float' to `va_arg') */
		      argFloat = va_arg(*args, double);
		    }
		  else
		    {
		      argFloat = [[argsEnum nextObject] doubleValue];
		    }

		  if (isKeyValue && *isKeyValue == YES && quoted == NO
		      && classString == nil)
		    {
		      *cFormat = *s = *s + 2;
		      return [NSNumber numberWithFloat: argFloat];
		    }
		  else
		    {
		      NSString *str;

		      if (*cFormat != *s)
			{
			  str = [NSString stringWithCharacters: *cFormat
					  length: *s - *cFormat];
			  [key appendString: str];
			}
				 
		      str = [NSString stringWithFormat: @"%f", argFloat];
		      [key appendString: str];

		      *cFormat = *s + 2;
		      (*s)++;
		    }
		  break;

		case '%':
		  {
		    /* The documentation states that '%%' results in a literal '%'.
		       The intention seems to be to allow key/key qualifiers like foo = %%foo
		       to be interpreted as foo = %foo. (Useful for in memory evaluation?) 
		       Yet WO45 actually fails to parse this, but we can do better.  */
		    NSString *str;

		    (*s)++;
		    str = [NSString stringWithCharacters: *cFormat
				    length: *s - *cFormat];
		    [key appendString: str];
					       
		    *cFormat = *s + 1;
		  }
		  break;

		default:
		  {
		    NSString *fmt 
		      = @"%@ -- %@: unrecognized character (%@) in the conversion specification";
		    NSString *specChar 
		      = [NSString stringWithCharacters: (*s + 1) length: 1];
		    [NSException raise: NSInvalidArgumentException 
				 format: fmt, @"EOQualifier", 
				 @"qualifierParser", specChar];
		    break;
		  } 
		}
	    }
	  else if (**s == '$')
	    {
 	      /* TODO userInfo would be nice */
	      if (isFormat)
		[NSException raise:NSInvalidArgumentException
				format:@"error parsing qualifier format"];
	      if (isKeyValue)
		{
		  *isKeyValue = YES;
		  isQualVar = YES;
		}
	    }

	  (*s)++;
        }

      if (*cFormat != *s)
	{
	  unsigned int length = *s - *cFormat;
	  const unichar *c = *cFormat;
	  NSString *str;

	  if (isKeyValue && c[0] == '$')
	    {
	      c++;
	      length--;	      
	    }

	  str  = [NSString stringWithCharacters: c 
				    length: length];
	  [key appendString: str];
	}
    }

  if (classString && (!(quoted || literalNumber)))
    {
      [NSException raise:NSInvalidArgumentException
		   format:@"expected string literal after cast to class"];
    }

  /* not sure about this !isQualVar */
  if (isQualVar)
    {
      if (!GDL2_isLegalDBName(key))
	{
	  NSString *format 
	    = [NSString stringWithFormat: @"illegal qualifier variable $%@",key];
	  [NSException raise:NSInvalidArgumentException
		       format:format];
	}
      key = (id)[[EOQualifierVariable alloc] initWithKey:key];
    }
  else if (isKeyValue)
    {
      *isKeyValue = (quoted || literalNumber);

      if (classString)
        {
	  Class cls = NSClassFromString(classString);
          key = AUTORELEASE([[cls alloc] initWithString: key]);
        }
    }
    
  *cFormat = *s;

  return key;
}

static BOOL
isNotQualifier(const unichar **cFormat, const unichar **s)
{
  while (**s && spaceCIM(spaceSet,cimSEL,**s))
    (*s)++;

  *cFormat = *s;

  if (((*s)[0]=='n' || (*s)[0]=='N')
      && ((*s)[1]=='o' || (*s)[1]=='O')
      && ((*s)[2]=='t' || (*s)[2]=='T'))
    {
      switch ((*s)[3])
        {
	case ' ':
	case '(':
	case 0:
	  *cFormat = *s = *s+3;
	  return YES;
        }
    }

  return NO;
}

static Class
whichQualifier(const unichar **cFormat, const unichar **s)
{
  while (**s && spaceCIM(spaceSet,cimSEL,**s))
    (*s)++;

  *cFormat = *s;

  if (((*s)[0]=='a' || (*s)[0]=='A')
      && ((*s)[1]=='n' || (*s)[1]=='N')
      && ((*s)[2]=='d' || (*s)[2]=='D'))
    {
      switch ((*s)[3])
        {
	case ' ':
	case '(':
	case 0:
	  *cFormat = *s = *s+3;
	  return [EOAndQualifier class];
        }
    }
  else if (((*s)[0]=='o' || (*s)[0]=='O')
	   && ((*s)[1]=='r' || (*s)[1]=='R'))
    {
      switch ((*s)[2])
        {
	case ' ':
	case '(':
	case 0:
	  *cFormat = *s = *s+2;
	  return [EOOrQualifier class];
        }
    }

  return Nil;
}

static EOQualifier *
_qualifierWithArgs(id self, SEL _cmd, NSString *format, NSArray *array, va_list *args)
{
  NSEnumerator *argEnum = [array objectEnumerator];
  unichar *s0;
  const unichar *s;
  const unichar *cFormat;
  NSMutableArray *bracketStack = nil;
  NSMutableArray *qualifierArray = nil;
  NSMutableArray *parentQualifiers = nil;
  EOQualifier *qualifier = nil;
  NSString *leftKey;
  NSString *rightKey;
  NSString *operator;
  SEL operatorSelector = NULL;
  BOOL isKeyValue = NO;
  BOOL notQual;
  Class lastQualifierClass = Nil;
  Class qualifierClass = Nil;
  unsigned formatLen;

  bracketStack = [NSMutableArray array];
  parentQualifiers = [NSMutableArray array];

  formatLen = [format length];
  s0 = GSAutoreleasedBuffer((formatLen+1) * sizeof(unichar));
  [format getCharacters: s0];
  s0[formatLen] = '\0';

  cFormat = s = s0;

  while (*s)
    {
      while (*s && spaceCIM(spaceSet,cimSEL,*s))
        (s)++;

      while (*s == '(' )
      {
	NSMutableDictionary *state;

	state = [NSMutableDictionary dictionaryWithCapacity:4];
	if (lastQualifierClass != Nil)
	  {
	    [state setObject: lastQualifierClass
		   forKey: @"lastQualifierClass"];
	    lastQualifierClass = Nil;
	  }
	if (qualifierArray != nil)
	  {
	    [state setObject: qualifierArray forKey: @"qualifierArray"];
	    qualifierArray = nil;
	  }
	if (qualifierClass != nil)
	  {
	    [state setObject: qualifierClass forKey: @"qualifierClass"];
	    qualifierClass = nil;
	  }
	[state setObject: parentQualifiers forKey: @"parentQualifiers"];
	parentQualifiers = [NSMutableArray new];

	[bracketStack addObject:state];

	(s)++; // skip '('
	while (*s && spaceCIM(spaceSet, cimSEL, *s))
	  (s)++;
      }
      
      notQual = isNotQualifier(&cFormat, &s);
      leftKey = getKey(&cFormat, &s, NULL, argEnum, args);
      operator = getOperator(&cFormat, &s);
      rightKey = getKey(&cFormat, &s, &isKeyValue, argEnum, args);

      operatorSelector = [EOQualifier operatorSelectorForString: operator];
      if (!operatorSelector)
	{
	  [NSException raise: NSInvalidArgumentException
		       format: @"%@ -- %@ 0x%x: no operator or unknown operator: '%@'",
		       NSStringFromClass([self class]),
		       NSStringFromSelector(_cmd),
		       self,
		       operator];
	}

      EOFLOGObjectLevelArgs(@"EOQualifier",
			    @"leftKey=%@ operatorSelector=%s rightKey=%@ class=%@",
			    leftKey,
			    GSNameFromSelector(operatorSelector),
			    rightKey,
			    isKeyValue?@"EOKeyValueQualifier":@"EOKeyComparisonQualifier");

      if (isKeyValue)
	qualifier = [EOKeyValueQualifier qualifierWithKey: leftKey
                                         operatorSelector: operatorSelector
                                         value: rightKey];
      else
	qualifier = [EOKeyComparisonQualifier
		      qualifierWithLeftKey: leftKey
		      operatorSelector: operatorSelector
		      rightKey: rightKey];
      
      EOFLOGObjectLevelArgs(@"EOQualifier",
			    @"qualifier=%@",
			    qualifier);

      if (notQual)
	qualifier = [EONotQualifier qualifierWithQualifier: qualifier];

      EOFLOGObjectLevelArgs(@"EOQualifier",
			    @"qualifier=%@",
			    qualifier);

      while (*s && spaceCIM(spaceSet,cimSEL,*s))
        (s)++;

      while (*s == ')' )
	{
	  NSMutableDictionary *state;

	  /* clean up inner qualifier */
	  if (qualifierArray != nil)
	    {
	      [qualifierArray addObject:qualifier];
	      qualifier 
		= AUTORELEASE([[qualifierClass alloc]
				initWithQualifierArray: qualifierArray]);
	      qualifierArray = nil;
	    }

	  while ([parentQualifiers count] != 0)
	    {
	      id       parent;
	      NSArray *quals;
	    
	      parent = [parentQualifiers lastObject];
	      quals = [[parent qualifiers] arrayByAddingObject: qualifier];
	      qualifier = AUTORELEASE([[[parent class] alloc]
					initWithQualifierArray: quals]);
	      [parentQualifiers removeLastObject];
	    }

	  DESTROY(parentQualifiers);

	  /* pop bracketStack */
	  state = [bracketStack lastObject];
	  qualifierArray = [state objectForKey:@"qualifierArray"];
	  lastQualifierClass = [state objectForKey:@"lastQualifierClass"];
	  qualifierClass = [state objectForKey:@"qualifierClass"];
	  parentQualifiers = [state objectForKey:@"parentQualifiers"];

	  [bracketStack removeLastObject];

	  (s)++; // skip ')'
	  while (*s && spaceCIM(spaceSet,cimSEL,*s))
	    (s)++;
	}

      qualifierClass = whichQualifier(&cFormat, &s);
      EOFLOGObjectLevelArgs(@"EOQualifier", @"qualifierClass=%@",
			    qualifierClass);

      if ([bracketStack count]==0)
        {
          if (qualifierClass == Nil)
            break;
        }
      if (lastQualifierClass == Nil)
        {
          qualifierArray = [NSMutableArray arrayWithObject: qualifier];
        }
      else if (lastQualifierClass == qualifierClass)
        {
	  [qualifierArray addObject: qualifier];
        }
      else /* lastQualifierClass set and != qualifierClass */
        {
	  [parentQualifiers addObject:
	     AUTORELEASE([[lastQualifierClass alloc]
			     initWithQualifierArray: qualifierArray])];

	  qualifierArray = [NSMutableArray arrayWithObject: qualifier];
        }

      lastQualifierClass = qualifierClass;
    }

  /* this is reached after the break */
  if (lastQualifierClass != Nil)
    {
      if (qualifier == nil)
        [NSException raise: NSInvalidArgumentException
		     format: @"%@ -- %@ 0x%x: missing qualifier",
                     NSStringFromSelector(_cmd),
		     NSStringFromClass([self class]), self];

      [qualifierArray addObject: qualifier];

      qualifier = AUTORELEASE([[lastQualifierClass alloc]
		     initWithQualifierArray: qualifierArray]);

      EOFLOGObjectLevelArgs(@"EOQualifier", 
			    @"qualifier=%@",
			    qualifier);
    }

  while ([parentQualifiers count] != 0)
    {
      id       parent;
      NSArray *quals;

      parent = [parentQualifiers lastObject];
      quals = [[parent qualifiers] arrayByAddingObject: qualifier];
      qualifier = AUTORELEASE([[[parent class] alloc]
				  initWithQualifierArray: quals]);
      [parentQualifiers removeLastObject];
    }

  return qualifier;
}

+ (EOQualifier *)qualifierWithQualifierFormat: (NSString *)format
				    arguments: (NSArray *)args
{
  return _qualifierWithArgs(self, _cmd, format, args, NULL);
}

+ (EOQualifier *)qualifierWithQualifierFormat: (NSString *)format
				   varargList: (va_list)args
{
  EOQualifier *qualifier;
  va_list varargs;

  va_copy(varargs, args);
  qualifier = _qualifierWithArgs(self, _cmd, format, nil, &varargs);
  va_end(varargs);
  return qualifier;
}

+ (EOQualifier *)qualifierToMatchAllValues: (NSDictionary *)values
{
  NSEnumerator *keyEnumerator;
  NSString *key;
  NSMutableArray *array;

  array = [NSMutableArray arrayWithCapacity: [values count]];

  keyEnumerator = [values keyEnumerator];
  while ((key = [keyEnumerator nextObject]))
    [array addObject: [EOKeyValueQualifier
			qualifierWithKey: key
			operatorSelector: EOQualifierOperatorEqual
			value: [values objectForKey: key]]];

  if ([array count] == 1)
    return [array objectAtIndex: 0];

  return [EOAndQualifier qualifierWithQualifierArray: array];
}

+ (EOQualifier *)qualifierToMatchAnyValue:(NSDictionary *)values
{
  NSEnumerator *keyEnumerator;
  NSString *key;
  NSMutableArray *array;

  array = [NSMutableArray arrayWithCapacity: [values count]];

  keyEnumerator = [values keyEnumerator];
  while ((key = [keyEnumerator nextObject]))
    [array addObject:[EOKeyValueQualifier
		       qualifierWithKey: key
		       operatorSelector: EOQualifierOperatorEqual
		       value: [values objectForKey: key]]];

  if ([array count] == 1)
    return [array objectAtIndex: 0];

  return [EOOrQualifier qualifierWithQualifierArray: array];
}

- (NSException *)_validateKey:(NSString*)key
     withRootClassDescription: (EOClassDescription *)classDescription
{
  if (!key)
    [NSException raise: NSInvalidArgumentException
                 format: @"%@ -- %@ 0x%x: nil key",
                 NSStringFromSelector(_cmd),
                 NSStringFromClass([self class]),
                 self];
  else
    {
      NSArray* keyParts = [key componentsSeparatedByString:@"."];
      int keyPartsCount=[keyParts count];
      int i = 0;
      BOOL stop=NO;
      for(i=0;i<keyPartsCount && !stop; i++)
        {
          NSString* keyPart = [keyParts objectAtIndex:i];
          NSArray* attributeKeys = [classDescription attributeKeys];
          if ([attributeKeys containsObject:keyPart])
            {
              stop=(i!=(keyPartsCount-1));
            } 
          else
            {
              classDescription = [classDescription classDescriptionForDestinationKey:keyPart];
              stop=(classDescription==nil);
            };
        };

      if (stop)
        {
          [NSException raise: NSInternalInconsistencyException
                       format: @"%@ -- %@ 0x%x: invalid key '%@'",
                       NSStringFromSelector(_cmd),
                       NSStringFromClass([self class]),
                       key];
        } ;
    };
  //TODO
  return nil;
};
      
- (NSException *)validateKeysWithRootClassDescription: (EOClassDescription *)classDescription
{
  return [self subclassResponsibility: _cmd];
}

+ (NSArray *)allQualifierOperators
{ // rivedere
  return [NSArray arrayWithObjects: @"=", @"!=", @"<=", @"<", @">=", @">",
		  @"doesContain", @"like", @"caseInsensitiveLike", nil];
}

+ (NSArray *)relationalQualifierOperators
{ // rivedere
  return [NSArray arrayWithObjects:@"=", @"!=", @"<=", @"<", @">=", @">", nil];
}

+ (NSString *)stringForOperatorSelector: (SEL)selector
{
  if (sel_isEqual(selector, EOQualifierOperatorEqual))
    return @"=";
  else if (sel_isEqual(selector, EOQualifierOperatorNotEqual))
    return @"<>";
  else if (sel_isEqual(selector, EOQualifierOperatorLessThan))
    return @"<";
  else if (sel_isEqual(selector, EOQualifierOperatorGreaterThan))
    return @">";
  else if (sel_isEqual(selector, EOQualifierOperatorLessThanOrEqualTo))
    return @"<=";
  else if (sel_isEqual(selector, EOQualifierOperatorGreaterThanOrEqualTo))
    return @">=";
  else if (sel_isEqual(selector, EOQualifierOperatorContains))
    return @"doesContain";
  else if (sel_isEqual(selector, EOQualifierOperatorLike))
    return @"like";
  else if (sel_isEqual(selector, EOQualifierOperatorCaseInsensitiveLike))
    return @"caseInsensitiveLike";

  return NSStringFromSelector(selector);
}

+ (SEL)operatorSelectorForString: (NSString *)string
{
  if ([string isEqualToString: @"="])
    return EOQualifierOperatorEqual;
  else if ([string isEqualToString: @"=="])
    return EOQualifierOperatorEqual;
  else if ([string isEqualToString: @"<="])
    return EOQualifierOperatorLessThanOrEqualTo;
  else if ([string isEqualToString: @"<"])
    return EOQualifierOperatorLessThan;
  else if ([string isEqualToString: @">="])
    return EOQualifierOperatorGreaterThanOrEqualTo;
  else if ([string isEqualToString: @">"])
    return EOQualifierOperatorGreaterThan;
  else if ([string isEqualToString: @"<>"])
    return EOQualifierOperatorNotEqual;
  else if ([string isEqualToString: @"!="])
    return EOQualifierOperatorNotEqual;
  else if ([string isEqualToString: @"contains"])
    return EOQualifierOperatorContains;
  else if ([string isEqualToString: @"doesContain"])
    return EOQualifierOperatorContains;
  else if ([string isEqualToString: @"like"])
    return EOQualifierOperatorLike;
  else if ([string isEqualToString: @"caseInsensitiveLike"])
    return EOQualifierOperatorCaseInsensitiveLike;
  else 
    {
      NSWarnMLog(@"No operator selector for string '%@'.", string);
      return (SEL)nil; // ????
    }
}

/**
 * NSCopying protocol
 * EOQualifiers are immutable.  Returns the receiver after retaining it.<br\>
 * If you wish to gain memory locality, you should recrate the qualifier
 * from scratch insuring that all referenced objects are also local to the new
 * zone.
 */
- (id)copyWithZone: (NSZone *)zone
{
  return RETAIN(self);
}

- (EOQualifier *)qualifierByApplyingBindings: (id)bindings
{
  return [self qualifierWithBindings: bindings
	       requiresAllVariables: NO];
}

- (EOQualifier *)qualifierByApplyingBindingsAllVariablesRequired: (id)bindings
{
  return [self qualifierWithBindings: bindings
	       requiresAllVariables: YES];
}

- (EOQualifier *)qualifierWithBindings: (NSDictionary *)bindings
		  requiresAllVariables: (BOOL)requiresAll
{
  return [self subclassResponsibility: _cmd];
}

/** Returns binding keys **/
- (NSArray *)bindingKeys
{
  NSMutableDictionary* bindings = (id)[NSMutableDictionary dictionary];
  [self _addBindingsToDictionary:bindings];
  return [bindings allValues];
}

//NO
- (BOOL)evaluateWithObject: (id)object
{
  [self notImplemented: _cmd];
  return NO;
}

- (NSString *)keyPathForBindingKey: (NSString *)key
{
  NSMutableDictionary* bindings = (NSMutableDictionary*)[NSMutableDictionary dictionary];
  [self _addBindingsToDictionary:bindings];
  return [bindings objectForKey:key];
}

- (EOQualifier *)qualifierMigratedFromEntity: (EOEntity *)entity 
                            relationshipPath: (NSString *)relationshipPath
{
  return [self notImplemented: _cmd]; //TODO
}

- (BOOL) usesDistinct
{
  [self notImplemented: _cmd]; //TODO
  return NO;
}

/**
 * Returns a set containing the keys of the qualifier tree starting
 * from the receiver.  Subclasses should override -addQualifierKeysToSet:
 * and rely on the implementation EOQualifier for this method.
 */
- (NSSet *)allQualifierKeys
{
  NSMutableSet *keys;
  keys = (id)[NSMutableSet set];
  [self addQualifierKeysToSet: keys];
  return [NSSet setWithSet: keys];
}

/**
 * Subclasses must override this method to add their qualifier keys to
 * the provided keys set.  Aggregate qualifiers, such as EOAndQualifer,
 * should traverse their contents invoking this method on each with the
 * provided set.
 */
- (void)addQualifierKeysToSet: (NSMutableSet *)keys
{
  [self subclassResponsibility: _cmd];
}

@end

@implementation EOQualifier (Privat)

- (id) _qualifierMigratedToSubEntity: (id)param0
                    fromParentEntity: (id)param1
{
  return [self notImplemented: _cmd]; //TODO
}

- (void) _addBindingsToDictionary: (NSMutableDictionary*)dictionary
{
  [self notImplemented: _cmd]; //TODO
}

@end


@implementation EOQualifierVariable

+ (EOQualifierVariable *)variableWithKey: (NSString *)key
{
  return AUTORELEASE([[self alloc] initWithKey: key]);
}

- (EOQualifierVariable *)initWithKey: (NSString *)key
{
  if ((self = [super init]))
    {
      ASSIGN(_key, key);
    }

  return self;
}

- (NSString *)key
{
  return _key;
}

- (void)encodeWithCoder: (NSCoder *)coder
{
  [coder encodeObject: _key];
}

- (id)initWithCoder: (NSCoder *)coder
{
  if ((self = [super init]))
    {
      _key = RETAIN([coder decodeObject]);
    }

  return self;
}

- (id)valueByApplyingBindings: (id)bindings
{
  return [self notImplemented: _cmd]; //TODO
}

- (id)requiredValueByApplyingBindings: (id)bindings
{
  return [self notImplemented: _cmd]; //TODO
}

- (id) initWithKeyValueUnarchiver: (EOKeyValueUnarchiver *)unarchiver
{
  if ((self = [super init]))
    {
      _key = RETAIN([unarchiver decodeObjectForKey: @"_key"]);
    }
  return self;
}

- (void)encodeWithKeyValueArchiver: (EOKeyValueArchiver *)archiver
{
  [archiver encodeObject: _key forKey: @"_key"];
}

- (NSString *) description
{
  return _key;
}

@end

/*
  This declaration is needed by the compiler to state that
  eventhough we know not all objects respond to -compare:,
  we want the compiler to generate code for the given
  prototype when calling -compare: in the following methods.
  We do not put this declaration in a header file to avoid
  the compiler seeing conflicting prototypes in user code.
*/
@interface NSObject (Comparison)
- (NSComparisonResult)compare: (id)other;
@end


@implementation NSObject (EORelationalSelectors)

- (BOOL)isEqualTo: (id)object
{
  return [self isEqual: object];
}

- (BOOL)isLessThanOrEqualTo: (id)object
{
  NSComparisonResult res = [self compare: object];

  return (res == NSOrderedAscending || res == NSOrderedSame ? YES : NO);
}

- (BOOL)isLessThan: (id)object
{
  return ([self compare:object] == NSOrderedAscending ? YES : NO);
}

- (BOOL)isGreaterThanOrEqualTo: (id)object
{
  NSComparisonResult res = [self compare:object];

  return (res == NSOrderedDescending || res == NSOrderedSame ? YES : NO);
}

- (BOOL)isGreaterThan: (id)object
{
  return ([self compare: object] == NSOrderedDescending ? YES : NO);
}

- (BOOL)isNotEqualTo: (id)object
{
  return ([self isEqualTo: object] ? NO : YES);
}

- (BOOL)doesContain: (id)object
{
  if ([self isKindOfClass: [NSArray class]])
    return [(NSArray *)self containsObject: object];

  return NO;
}

- (BOOL)isLike: (NSString *)object
{
  return NO;
}

- (BOOL)isCaseInsensitiveLike: (NSString *)object
{
  return NO;
}

@end


@implementation NSString (EORelationalSelectors)

static NSCharacterSet *isLikeWildCardSet = nil;
static NSString *isLikeWildCardTokenQ = @"?";
static NSString *isLikeWildCardTokenS = @"*";

static inline BOOL
_isLike (NSString *self, NSString *regExpr, BOOL isCaseSensative)
{
  NSScanner *regExScanner;
  NSScanner *valueScanner;
  NSString *scanned;
  unsigned c = 0;
  unsigned i = 0;
  GDL2_BUFFER (tokens, [regExpr length], id);

  if ([self isEqual: regExpr])
    {
      return YES;
    }

  if (isLikeWildCardSet == nil)
    isLikeWildCardSet 
      = [[NSCharacterSet characterSetWithCharactersInString: @"?*"] retain];

  regExScanner = [NSScanner scannerWithString: regExpr];
  valueScanner = [NSScanner scannerWithString: self];
  [valueScanner setCaseSensitive: isCaseSensative];

  while ([regExScanner isAtEnd] == NO)
    {
      if ([regExScanner scanUpToCharactersFromSet: isLikeWildCardSet
			intoString: &scanned])
	{
	  tokens[c++] = scanned;
	}
      if ([regExScanner isAtEnd] == NO)
	{
	  if ([regExScanner scanCharactersFromSet: isLikeWildCardSet
			    intoString: &scanned])
	    {
	      unsigned scannedLen;
	      unichar *cScanned;

	      scannedLen = [scanned length];
	      cScanned = GSAutoreleasedBuffer((scannedLen+1) * sizeof(unichar));
	      [scanned getCharacters: cScanned];
	      cScanned[scannedLen] = 0;

	      for (; *cScanned != 0; cScanned++)
		{
		  if (*cScanned == '?') 
		    {
		      /* sanitize the token list (*??bar -> ?*?bar -> ??*bar)
			 throughout this loop */
		      if (c != 0 && tokens[c - 1] == isLikeWildCardTokenS)
			{
			  /* replace *? with ?* which both match 1 or more */
			  tokens[c - 1] = isLikeWildCardTokenQ;
			  tokens[c++] = isLikeWildCardTokenS;
			}
		      else
			{
		          tokens[c++] = isLikeWildCardTokenQ;
			}
		    }
		  else if (*cScanned == '*' /* ignore ** */
		      && (c == 0 || tokens[c - 1] != isLikeWildCardTokenS))
		    {
		      tokens[c++] = isLikeWildCardTokenS;
		    }
		}
	    }
	}
    }

  for (i = 0; i < c; i++)
    {
      if (tokens[i] == isLikeWildCardTokenQ)
	{
	  if ([valueScanner isAtEnd])
	    {
	      return NO;
	    }
	  [valueScanner setScanLocation: [valueScanner scanLocation] + 1];
	}
      else if (tokens[i] == isLikeWildCardTokenS)
	{
	  // no more tokens except a * we have a match.
	  if (i == c - 1)
	    {
	      return YES;
	    }

	  // tokens[i + 1] should be the 'bar' in *bar  
	  [valueScanner scanUpToString: tokens[i + 1]
			intoString: 0];
	}
      else
	{
	  if ([valueScanner isAtEnd])
	    {
	      return NO;
	    }
	  if ([valueScanner scanString: tokens[i] intoString: 0] == NO)
	    {
	      return NO;
	    }
	}
    }
  
  return [valueScanner isAtEnd];
}

- (BOOL)isLike: (NSString *)object
{
  return _isLike(self, object, YES);
}

- (BOOL)isCaseInsensitiveLike: (NSString *)object
{
  return _isLike(self, object, NO);
}

@end

@implementation NSArray (EOQualifierExtras)

- (NSArray *)filteredArrayUsingQualifier: (EOQualifier *)qualifier
{
  unsigned    max = [self count];

  if (max != 0 && qualifier != nil)
    {
      unsigned  i;
      id        object;
      SEL       oaiSEL = @selector(objectAtIndex:);
      IMP       oaiIMP = [self methodForSelector:oaiSEL];
      SEL       ewoSEL = @selector(evaluateWithObject:);
      BOOL      (*ewoIMP)(id, SEL, id);
      GDL2_BUFFER(objP, max, id);

      ewoIMP = (BOOL (*)(id, SEL, id))[qualifier methodForSelector:ewoSEL];

      for(i=0; i < max; i++)
	{
	  object = (*oaiIMP)(self, oaiSEL, i);

	  if((*ewoIMP)(qualifier, ewoSEL, object))
	    {
	      *objP++=object;
	    }
	}
      return [NSArray arrayWithObjects: objP_base count: objP - objP_base];
    }
  else
    {
      return self;
    }
}


@end