1*88cc0b97SApple OSS Distributions/* 2*88cc0b97SApple OSS Distributions * Copyright (c) 2015 Apple Inc. All rights reserved. 3*88cc0b97SApple OSS Distributions * 4*88cc0b97SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*88cc0b97SApple OSS Distributions * 6*88cc0b97SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*88cc0b97SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*88cc0b97SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*88cc0b97SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*88cc0b97SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*88cc0b97SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*88cc0b97SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*88cc0b97SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*88cc0b97SApple OSS Distributions * 15*88cc0b97SApple OSS Distributions * Please obtain a copy of the License at 16*88cc0b97SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*88cc0b97SApple OSS Distributions * 18*88cc0b97SApple OSS Distributions * The Original Code and all software distributed under the License are 19*88cc0b97SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*88cc0b97SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*88cc0b97SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*88cc0b97SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*88cc0b97SApple OSS Distributions * Please see the License for the specific language governing rights and 24*88cc0b97SApple OSS Distributions * limitations under the License. 25*88cc0b97SApple OSS Distributions * 26*88cc0b97SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*88cc0b97SApple OSS Distributions */ 28*88cc0b97SApple OSS Distributions 29*88cc0b97SApple OSS Distributions#import "KCDStructTypeDescription.h" 30*88cc0b97SApple OSS Distributions 31*88cc0b97SApple OSS Distributions#ifndef KCDATA_TYPE_MAX_WITH_DESC 32*88cc0b97SApple OSS Distributions#define KCDATA_TYPE_MAX_WITH_DESC 0x6 33*88cc0b97SApple OSS Distributions#endif 34*88cc0b97SApple OSS Distributions 35*88cc0b97SApple OSS Distributions@interface 36*88cc0b97SApple OSS DistributionsKCDStructTypeDescription () { 37*88cc0b97SApple OSS Distributions unsigned int _typeID; 38*88cc0b97SApple OSS Distributions NSString * _name; 39*88cc0b97SApple OSS Distributions NSMutableArray * _fields; 40*88cc0b97SApple OSS Distributions BOOL _needDescriptionAsKey; 41*88cc0b97SApple OSS Distributions BOOL _flagsRequestedMerge; 42*88cc0b97SApple OSS Distributions} 43*88cc0b97SApple OSS Distributions 44*88cc0b97SApple OSS Distributions@end 45*88cc0b97SApple OSS Distributions 46*88cc0b97SApple OSS Distributions@implementation KCDStructTypeDescription 47*88cc0b97SApple OSS Distributions 48*88cc0b97SApple OSS Distributions- (id)initWithType:(unsigned int)typeID withName:(NSString *)name 49*88cc0b97SApple OSS Distributions{ 50*88cc0b97SApple OSS Distributions if ((self = [super init])) { 51*88cc0b97SApple OSS Distributions _typeID = typeID; 52*88cc0b97SApple OSS Distributions _name = name; 53*88cc0b97SApple OSS Distributions _needDescriptionAsKey = NO; 54*88cc0b97SApple OSS Distributions if (typeID >= 0x1 && typeID <= KCDATA_TYPE_MAX_WITH_DESC) 55*88cc0b97SApple OSS Distributions _needDescriptionAsKey = YES; 56*88cc0b97SApple OSS Distributions 57*88cc0b97SApple OSS Distributions _fields = [[NSMutableArray alloc] init]; 58*88cc0b97SApple OSS Distributions _flagsRequestedMerge = NO; 59*88cc0b97SApple OSS Distributions return self; 60*88cc0b97SApple OSS Distributions } 61*88cc0b97SApple OSS Distributions return NULL; 62*88cc0b97SApple OSS Distributions} 63*88cc0b97SApple OSS Distributions 64*88cc0b97SApple OSS Distributions- (void)addFieldBasicType:(KCDBasicTypeDescription *)fieldType 65*88cc0b97SApple OSS Distributions{ 66*88cc0b97SApple OSS Distributions [_fields addObject:fieldType]; 67*88cc0b97SApple OSS Distributions} 68*88cc0b97SApple OSS Distributions 69*88cc0b97SApple OSS Distributions- (void)setFlagsRequestedMerge 70*88cc0b97SApple OSS Distributions{ 71*88cc0b97SApple OSS Distributions _flagsRequestedMerge = YES; 72*88cc0b97SApple OSS Distributions} 73*88cc0b97SApple OSS Distributions 74*88cc0b97SApple OSS Distributions- (NSDictionary *)parseData:(void *)dataBuffer ofLength:(uint32_t)length 75*88cc0b97SApple OSS Distributions{ 76*88cc0b97SApple OSS Distributions NSMutableDictionary * retval = [[NSMutableDictionary alloc] init]; 77*88cc0b97SApple OSS Distributions for (KCDataType * fi in _fields) { 78*88cc0b97SApple OSS Distributions NSDictionary * _d = [fi parseData:dataBuffer ofLength:length]; 79*88cc0b97SApple OSS Distributions if (!_d) { 80*88cc0b97SApple OSS Distributions return nil; 81*88cc0b97SApple OSS Distributions } 82*88cc0b97SApple OSS Distributions for (NSString * k in [_d keyEnumerator]) { 83*88cc0b97SApple OSS Distributions retval[k] = _d[k]; 84*88cc0b97SApple OSS Distributions } 85*88cc0b97SApple OSS Distributions } 86*88cc0b97SApple OSS Distributions if (_typeID == KCDATA_TYPE_TYPEDEFINTION){ 87*88cc0b97SApple OSS Distributions uint32_t elem_size = sizeof(struct kcdata_subtype_descriptor); 88*88cc0b97SApple OSS Distributions uint32_t elem_count = (length - offsetof(struct kcdata_type_definition, kct_elements))/elem_size; 89*88cc0b97SApple OSS Distributions NSMutableArray * fields_array = [NSMutableArray arrayWithCapacity:elem_count]; 90*88cc0b97SApple OSS Distributions struct kcdata_subtype_descriptor *fields_dsc = (struct kcdata_subtype_descriptor *) ((uintptr_t)dataBuffer + offsetof(struct kcdata_type_definition, kct_elements)); 91*88cc0b97SApple OSS Distributions int i = 0; 92*88cc0b97SApple OSS Distributions for (i = 0; i < elem_count; i++) { 93*88cc0b97SApple OSS Distributions KCDBasicTypeDescription * tmpdsc = [[KCDBasicTypeDescription alloc] initWithKCTypeDesc:&fields_dsc[i]]; 94*88cc0b97SApple OSS Distributions NSString *field_desc_str = [tmpdsc description]; 95*88cc0b97SApple OSS Distributions 96*88cc0b97SApple OSS Distributions [fields_array addObject:field_desc_str]; 97*88cc0b97SApple OSS Distributions } 98*88cc0b97SApple OSS Distributions retval[@"fields"] = fields_array; 99*88cc0b97SApple OSS Distributions } 100*88cc0b97SApple OSS Distributions if (_needDescriptionAsKey) { 101*88cc0b97SApple OSS Distributions NSString * desc = retval[@"desc"]; 102*88cc0b97SApple OSS Distributions NSObject * obj = retval[@"data"]; 103*88cc0b97SApple OSS Distributions retval[desc] = obj; 104*88cc0b97SApple OSS Distributions [retval removeObjectForKey:@"desc"]; 105*88cc0b97SApple OSS Distributions [retval removeObjectForKey:@"data"]; 106*88cc0b97SApple OSS Distributions } 107*88cc0b97SApple OSS Distributions return retval; 108*88cc0b97SApple OSS Distributions} 109*88cc0b97SApple OSS Distributions 110*88cc0b97SApple OSS Distributions- (BOOL)shouldMergeData 111*88cc0b97SApple OSS Distributions{ 112*88cc0b97SApple OSS Distributions /* 113*88cc0b97SApple OSS Distributions * If this is a type where the kcdata item itself carries the key name, or 114*88cc0b97SApple OSS Distributions * KCS_SUBTYPE_FLAGS_MERGE was used to define the type, then a member of 115*88cc0b97SApple OSS Distributions * this type should have it's dict merged into the parent container, 116*88cc0b97SApple OSS Distributions * instead of being represented as typename => dict. 117*88cc0b97SApple OSS Distributions */ 118*88cc0b97SApple OSS Distributions return _needDescriptionAsKey || _flagsRequestedMerge; 119*88cc0b97SApple OSS Distributions} 120*88cc0b97SApple OSS Distributions 121*88cc0b97SApple OSS Distributions- (NSString *)description 122*88cc0b97SApple OSS Distributions{ 123*88cc0b97SApple OSS Distributions return [NSString stringWithFormat:@"type: %d => \"%@\" ", _typeID, _name]; 124*88cc0b97SApple OSS Distributions} 125*88cc0b97SApple OSS Distributions 126*88cc0b97SApple OSS Distributions- (NSString *)name 127*88cc0b97SApple OSS Distributions{ 128*88cc0b97SApple OSS Distributions return _name; 129*88cc0b97SApple OSS Distributions} 130*88cc0b97SApple OSS Distributions 131*88cc0b97SApple OSS Distributions- (uint32_t)count 132*88cc0b97SApple OSS Distributions{ 133*88cc0b97SApple OSS Distributions return (uint32_t)[_fields count]; 134*88cc0b97SApple OSS Distributions} 135*88cc0b97SApple OSS Distributions 136*88cc0b97SApple OSS Distributions- (unsigned int)typeID 137*88cc0b97SApple OSS Distributions{ 138*88cc0b97SApple OSS Distributions return _typeID; 139*88cc0b97SApple OSS Distributions} 140*88cc0b97SApple OSS Distributions 141*88cc0b97SApple OSS Distributions@end 142