OOPListSchemaVerifier(OOPrivate) Category Reference

Instance Methods
(BOOL)	- delegateVerifierWithPropertyList:named:testProperty:atPath:againstType:error:
(BOOL)	- delegateVerifierWithPropertyList:named:failedForProperty:withError:expectedType:
(BOOL)	- verifyPList:named:subProperty:againstSchemaType:atPath:tentative:error:stop:
(NSDictionary *)	- resolveSchemaType:atPath:error:

Detailed Description

Definition at line 157 of file OOPListSchemaVerifier.m.

Method Documentation

delegateVerifierWithPropertyList:named:failedForProperty:withError:expectedType:

- (BOOL) delegateVerifierWithPropertyList:		(id)	rootPList
named:		(NSString *)	name
failedForProperty:		(id)	subPList
withError:		(NSError *)	error
expectedType:		(NSDictionary *)	localSchema

Extends class OOPListSchemaVerifier.

Definition at line 376 of file OOPListSchemaVerifier.m.

                                        :(id)rootPList
                                   named:(NSString *)name
                       failedForProperty:(id)subPList
                               withError:(NSError *)error
                            expectedType:(NSDictionary *)localSchema
{
    BOOL                    result;
    
    if ([_delegate respondsToSelector:@selector(verifier:withPropertyList:named:failedForProperty:withError:expectedType:)])
    {
        @try
        {
            result = [_delegate verifier:self
                        withPropertyList:rootPList
                                   named:name
                       failedForProperty:subPList
                               withError:error
                            expectedType:localSchema];
        }
        @catch (NSException *exception)
        {
            OOLog(@"plistVerifier.delegateException", @"Property list schema verifier: delegate threw exception (%@) in -verifier:withPropertyList:named:failedForProperty:atPath:expectedType: at %@ in %@ -- stopping.", [exception name], [error plistKeyPathDescription], name);
            result = NO;
        }
    }
    else
    {
        OOLog(@"plistVerifier.failed", @"Verification of property list \"%@\" failed at %@: %@", name, [error plistKeyPathDescription], [error localizedFailureReason]);
        result = NO;
    }
    return result;
}

References OOLog.

delegateVerifierWithPropertyList:named:testProperty:atPath:againstType:error:

- (BOOL) delegateVerifierWithPropertyList:		(id)	rootPList
named:		(NSString *)	name
testProperty:		(id)	subPList
atPath:		(BackLinkChain)	keyPath
againstType:		(NSString *)	typeKey
error:		(NSError **)	outError

Extends class OOPListSchemaVerifier.

Definition at line 323 of file OOPListSchemaVerifier.m.

                                        :(id)rootPList
                                   named:(NSString *)name
                            testProperty:(id)subPList
                                  atPath:(BackLinkChain)keyPath
                             againstType:(NSString *)typeKey
                                   error:(NSError **)outError
{
    BOOL                    result;
    NSError                 *error = nil;
    
    if ([_delegate respondsToSelector:@selector(verifier:withPropertyList:named:testProperty:atPath:againstType:error:)])
    {
        @try
        {
            result = [_delegate verifier:self
                        withPropertyList:rootPList
                                   named:name
                            testProperty:subPList
                                  atPath:KeyPathToArray(keyPath)
                             againstType:typeKey
                                   error:&error];
        }
        @catch (NSException *exception)
        {
            OOLog(@"plistVerifier.delegateException", @"Property list schema verifier: delegate threw exception (%@) in -verifier:withPropertyList:named:testProperty:atPath:againstType: for type \"%@\" at %@ in %@ -- treating as failure.", [exception name], typeKey,KeyPathToString(keyPath), name);
            result = NO;
            error = nil;
        }
        
        if (outError != NULL)
        {
            if (!result || error != nil)
            {
                // Note: Generates an error if delegate returned NO (meaning stop) or if delegate produced an error but did not request a stop.
                *outError = ErrorWithProperty(kPListDelegatedTypeError, &keyPath, NSUnderlyingErrorKey, error, @"Value at %@ does not match delegated type \"%@\".", KeyPathToString(keyPath), typeKey);
            }
            else *outError = nil;
        }
    }
    else
    {
        if (!_badDelegateWarning)
        {
            OOLog(@"plistVerifier.badDelegate", @"%@", @"Property list schema verifier: delegate does not handle delegated types.");
            _badDelegateWarning = YES;
        }
        result = YES;
    }
    
    return result;
}

References ErrorWithProperty(), KeyPathToString(), kPListDelegatedTypeError, nil, and OOLog.

Here is the call graph for this function:

resolveSchemaType:atPath:error:

- (NSDictionary *) resolveSchemaType:		(id)	specifier
atPath:		(BackLinkChain)	keyPath
error:		(NSError **)	outError

Extends class OOPListSchemaVerifier.

Definition at line 496 of file OOPListSchemaVerifier.m.

                                   :(id)specifier
                             atPath:(BackLinkChain)keyPath
                              error:(NSError **)outError
{
    id                      typeVal = nil;
    NSString                *complaint = nil;
    
    assert(outError != NULL);
    
    if (![specifier isKindOfClass:[NSString class]] && ![specifier isKindOfClass:[NSDictionary class]])  goto BAD_TYPE;
    
    for (;;)
    {
        if ([specifier isKindOfClass:[NSString class]])  specifier = [NSDictionary dictionaryWithObject:specifier forKey:@"type"];
        typeVal = [(NSDictionary *)specifier objectForKey:@"type"];
        
        if ([typeVal isKindOfClass:[NSString class]])
        {
            if ([typeVal hasPrefix:@"$"])
            {
                // Macro reference; look it up in $definitions
                specifier = [_definitions objectForKey:typeVal];
                if (specifier == nil)
                {
                    *outError = ErrorWithProperty(kPListErrorSchemaUndefiniedMacroReference, &keyPath, kUndefinedMacroErrorKey, typeVal, @"Bad schema: reference to undefined macro \"%@\".", StringForErrorReport(typeVal));
                    return nil;
                }
            }
            else
            {
                // Non-macro string
                return specifier;
            }
        }
        else if ([typeVal isKindOfClass:[NSDictionary class]])
        {
            specifier = typeVal;    
        }
        else
        {
            goto BAD_TYPE;
        }
    }
    
BAD_TYPE:
    // Error: bad type
    if (typeVal == nil)  complaint = @"no type specified";
    else  complaint = @"not string or dictionary";
                
    *outError = Error(kPListErrorSchemaBadTypeSpecifier, &keyPath, @"Bad schema: invalid type specifier for path %@ (%@).", KeyPathToString(keyPath), complaint);
    return nil;
}

References Error(), ErrorWithProperty(), KeyPathToString(), kPListErrorSchemaBadTypeSpecifier, kPListErrorSchemaUndefiniedMacroReference, kUndefinedMacroErrorKey, nil, and StringForErrorReport().

Here is the call graph for this function:

verifyPList:named:subProperty:againstSchemaType:atPath:tentative:error:stop:

- (BOOL) verifyPList:		(id)	rootPList
named:		(NSString *)	name
subProperty:		(id)	subProperty
againstSchemaType:		(id)	subSchema
atPath:		(BackLinkChain)	keyPath
tentative:		(BOOL)	tentative
error:		(NSError **)	outError
stop:		(BOOL *)	outStop

Extends class OOPListSchemaVerifier.

Definition at line 410 of file OOPListSchemaVerifier.m.

                   :(id)rootPList
              named:(NSString *)name
        subProperty:(id)subProperty
  againstSchemaType:(id)subSchema
             atPath:(BackLinkChain)keyPath
          tentative:(BOOL)tentative
              error:(NSError **)outError
               stop:(BOOL *)outStop
{
    SchemaType                type = kTypeUnknown;
    NSError                 *error = nil;
    NSDictionary            *resolvedSpecifier = nil;
    NSAutoreleasePool       *pool = nil;
    
    assert(outStop != NULL);
    
    pool = [[NSAutoreleasePool alloc] init];
    
    DebugDumpPushIndent();
    
    @try
    {
        DebugDumpIndent();
        
        resolvedSpecifier = [self resolveSchemaType:subSchema atPath:keyPath error:&error];
        if (resolvedSpecifier != nil)  type = StringToSchemaType([resolvedSpecifier objectForKey:@"type"], &error);
        
        #define VERIFY_CASE(T) case kType##T: error = Verify_##T(self, subProperty, resolvedSpecifier, rootPList, name, keyPath, tentative, outStop); break;
        
        switch (type)
        {
            VERIFY_CASE(String);
            VERIFY_CASE(Array);
            VERIFY_CASE(Dictionary);
            VERIFY_CASE(Integer);
            VERIFY_CASE(PositiveInteger);
            VERIFY_CASE(Float);
            VERIFY_CASE(PositiveFloat);
            VERIFY_CASE(OneOf);
            VERIFY_CASE(Enumeration);
            VERIFY_CASE(Boolean);
            VERIFY_CASE(FuzzyBoolean);
            VERIFY_CASE(Vector);
            VERIFY_CASE(Quaternion);
            VERIFY_CASE(DelegatedType);
            
            case kTypeUnknown:
                // resolveSchemaType:... or StringToSchemaType() should have provided an error.
                *outStop = YES;
        }
    }
    @catch (NSException *exception)
    {
        error = Error(kPListErrorInternal, (BackLinkChain *)&keyPath, @"Uncaught exception %@: %@ in plist verifier for \"%@\" at %@.", [exception name], [exception reason], name, KeyPathToString(keyPath));
    }
    
    DebugDumpPopIndent();
    
    if (error != nil)
    {
        if (!tentative && !IsFailureAlreadyReportedError(error))
        {
            *outStop = ![self delegateVerifierWithPropertyList:rootPList
                                                         named:name
                                             failedForProperty:subProperty
                                                     withError:error
                                                  expectedType:subSchema];
        }
        else if (tentative)  *outStop = YES;
    }
    
    if (outError != NULL && error != nil)
    {
        *outError = [error retain];
        [pool release];
        [error autorelease];
    }
    else
    {
        [pool release];
    }
    
    return error == nil;
}

References DebugDumpIndent, DebugDumpPopIndent, DebugDumpPushIndent, OOPListSchemaVerifier::delegateVerifierWithPropertyList:named:failedForProperty:withError:expectedType:, Error(), IsFailureAlreadyReportedError(), KeyPathToString(), kPListErrorInternal, kTypeUnknown, nil, OOPListSchemaVerifier::resolveSchemaType:atPath:error:, StringToSchemaType(), and VERIFY_CASE.

Here is the call graph for this function:

---

The documentation for this category was generated from the following file:

• src/Core/OXPVerifier/OOPListSchemaVerifier.m