// // FLEXObjectListViewController.m // Flipboard // // Created by Ryan Olson on 5/28/14. // Copyright (c) 2014 Flipboard. All rights reserved. // #import "FLEXObjectListViewController.h" #import "FLEXObjectExplorerFactory.h" #import "FLEXObjectExplorerViewController.h" #import "FLEXCollectionContentSection.h" #import "FLEXRuntimeUtility.h" #import "FLEXUtility.h" #import "FLEXHeapEnumerator.h" #import "FLEXObjectRef.h" #import "NSString+FLEX.h" #import "NSObject+Reflection.h" #import "FLEXTableViewCell.h" #import @interface FLEXObjectListViewController () @property (nonatomic) NSArray *sections; @property (nonatomic, readonly) NSArray *allSections; /// Array of [[section], [section], ...] /// where [section] is [["row title", instance], ["row title", instance], ...] @property (nonatomic) NSArray *references; @end @implementation FLEXObjectListViewController #pragma mark - Reference Grouping + (NSPredicate *)defaultPredicateForSection:(NSInteger)section { // These are the types of references that we typically don't care about. // We want this list of "object-ivar pairs" split into two sections. BOOL(^isObserver)(FLEXObjectRef *, NSDictionary *) = ^BOOL(FLEXObjectRef *ref, NSDictionary *bindings) { NSString *row = ref.reference; return [row isEqualToString:@"__NSObserver object"] || [row isEqualToString:@"_CFXNotificationObjcObserverRegistration _object"]; }; /// These are common AutoLayout related references we also rarely care about. BOOL(^isConstraintRelated)(FLEXObjectRef *, NSDictionary *) = ^BOOL(FLEXObjectRef *ref, NSDictionary *bindings) { static NSSet *ignored = nil; static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ ignored = [NSSet setWithArray:@[ @"NSLayoutConstraint _container", @"NSContentSizeLayoutConstraint _container", @"NSAutoresizingMaskLayoutConstraint _container", @"MASViewConstraint _installedView", @"MASLayoutConstraint _container", @"MASViewAttribute _view" ]]; }); NSString *row = ref.reference; return ([row hasPrefix:@"NSLayout"] && [row hasSuffix:@" _referenceItem"]) || ([row hasPrefix:@"NSIS"] && [row hasSuffix:@" _delegate"]) || ([row hasPrefix:@"_NSAutoresizingMask"] && [row hasSuffix:@" _referenceItem"]) || [ignored containsObject:row]; }; BOOL(^isEssential)(FLEXObjectRef *, NSDictionary *) = ^BOOL(FLEXObjectRef *ref, NSDictionary *bindings) { return !(isObserver(ref, bindings) || isConstraintRelated(ref, bindings)); }; switch (section) { case 0: return [NSPredicate predicateWithBlock:isEssential]; case 1: return [NSPredicate predicateWithBlock:isConstraintRelated]; case 2: return [NSPredicate predicateWithBlock:isObserver]; default: return nil; } } + (NSArray *)defaultPredicates { return @[[self defaultPredicateForSection:0], [self defaultPredicateForSection:1], [self defaultPredicateForSection:2]]; } + (NSArray *)defaultSectionTitles { return @[@"", @"AutoLayout", @"Trivial"]; } #pragma mark - Initialization - (id)initWithReferences:(NSArray *)references { return [self initWithReferences:references predicates:nil sectionTitles:nil]; } - (id)initWithReferences:(NSArray *)references predicates:(NSArray *)predicates sectionTitles:(NSArray *)sectionTitles { NSParameterAssert(predicates.count == sectionTitles.count); self = [super initWithStyle:UITableViewStylePlain]; if (self) { self.references = references; if (predicates.count) { [self buildSections:sectionTitles predicates:predicates]; } else { _sections = _allSections = @[[self makeSection:references title:nil]]; } } return self; } + (instancetype)instancesOfClassWithName:(NSString *)className { const char *classNameCString = className.UTF8String; NSMutableArray *instances = [NSMutableArray array]; [FLEXHeapEnumerator enumerateLiveObjectsUsingBlock:^(__unsafe_unretained id object, __unsafe_unretained Class actualClass) { if (strcmp(classNameCString, class_getName(actualClass)) == 0) { // Note: objects of certain classes crash when retain is called. // It is up to the user to avoid tapping into instance lists for these classes. // Ex. OS_dispatch_queue_specific_queue // In the future, we could provide some kind of warning for classes that are known to be problematic. if (malloc_size((__bridge const void *)(object)) > 0) { [instances addObject:object]; } } }]; NSArray *references = [FLEXObjectRef referencingAll:instances]; FLEXObjectListViewController *controller = [[self alloc] initWithReferences:references]; controller.title = [NSString stringWithFormat:@"%@ (%lu)", className, (unsigned long)instances.count]; return controller; } + (instancetype)subclassesOfClassWithName:(NSString *)className { NSArray *classes = FLEXGetAllSubclasses(NSClassFromString(className), NO); NSArray *references = [FLEXObjectRef referencingClasses:classes]; FLEXObjectListViewController *controller = [[self alloc] initWithReferences:references]; controller.title = [NSString stringWithFormat:@"Subclasses of %@ (%lu)", className, (unsigned long)classes.count ]; return controller; } + (instancetype)objectsWithReferencesToObject:(id)object { static Class SwiftObjectClass = nil; static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ SwiftObjectClass = NSClassFromString(@"SwiftObject"); if (!SwiftObjectClass) { SwiftObjectClass = NSClassFromString(@"Swift._SwiftObject"); } }); NSMutableArray *instances = [NSMutableArray array]; [FLEXHeapEnumerator enumerateLiveObjectsUsingBlock:^(__unsafe_unretained id tryObject, __unsafe_unretained Class actualClass) { // Get all the ivars on the object. Start with the class and and travel up the inheritance chain. // Once we find a match, record it and move on to the next object. There's no reason to find multiple matches within the same object. Class tryClass = actualClass; while (tryClass) { unsigned int ivarCount = 0; Ivar *ivars = class_copyIvarList(tryClass, &ivarCount); for (unsigned int ivarIndex = 0; ivarIndex < ivarCount; ivarIndex++) { Ivar ivar = ivars[ivarIndex]; NSString *typeEncoding = @(ivar_getTypeEncoding(ivar) ?: ""); if (typeEncoding.flex_typeIsObjectOrClass) { ptrdiff_t offset = ivar_getOffset(ivar); uintptr_t *fieldPointer = (__bridge void *)tryObject + offset; if (*fieldPointer == (uintptr_t)(__bridge void *)object) { NSString *ivarName = @(ivar_getName(ivar) ?: "???"); [instances addObject:[FLEXObjectRef referencing:tryObject ivar:ivarName]]; return; } } } tryClass = class_getSuperclass(tryClass); } }]; NSArray *predicates = [self defaultPredicates]; NSArray *sectionTitles = [self defaultSectionTitles]; FLEXObjectListViewController *viewController = [[self alloc] initWithReferences:instances predicates:predicates sectionTitles:sectionTitles ]; viewController.title = [NSString stringWithFormat:@"Referencing %@ %p", NSStringFromClass(object_getClass(object)), object ]; return viewController; } #pragma mark - Lifecycle - (void)viewDidLoad { [super viewDidLoad]; self.showsSearchBar = YES; } #pragma mark - Private - (void)buildSections:(NSArray *)titles predicates:(NSArray *)predicates { NSParameterAssert(titles.count == predicates.count); NSParameterAssert(titles); NSParameterAssert(predicates); _sections = _allSections = [NSArray flex_forEachUpTo:titles.count map:^id(NSUInteger i) { NSArray *rows = [self.references filteredArrayUsingPredicate:predicates[i]]; return [self makeSection:rows title:titles[i]]; }]; } - (FLEXCollectionContentSection *)makeSection:(NSArray *)rows title:(NSString *)title { FLEXCollectionContentSection *section = [FLEXCollectionContentSection forCollection:rows]; // We need custom filtering because we do custom cell configuration section.customFilter = ^BOOL(NSString *filterText, FLEXObjectRef *ref) { if (ref.summary && [ref.summary localizedCaseInsensitiveContainsString:filterText]) { return YES; } return [ref.reference localizedCaseInsensitiveContainsString:filterText]; }; // Use custom title, or hide title entirely if (title) { section.customTitle = title; } else { section.hideSectionTitle = YES; } return section; } - (NSArray *)nonemptySections { return [self.allSections flex_filtered:^BOOL(FLEXTableViewSection *section, NSUInteger idx) { return section.numberOfRows > 0; }]; } - (FLEXObjectRef *)referenceForIndexPath:(NSIndexPath *)ip { return [self.sections[ip.section] objectForRow:ip.row]; } #pragma mark - Search - (void)updateSearchResults:(NSString *)newText; { // Sections will adjust data based on this property for (FLEXTableViewSection *section in self.allSections) { section.filterText = newText; } // Recalculate empty sections self.sections = [self nonemptySections]; // Refresh table view if (self.isViewLoaded) { [self.tableView reloadData]; } } #pragma mark - Table View Data Source - (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView { return self.sections.count; } - (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section { return self.sections[section].numberOfRows; } - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath { UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:kFLEXDetailCell forIndexPath:indexPath]; FLEXObjectRef *ref = [self referenceForIndexPath:indexPath]; cell.textLabel.text = ref.reference; cell.detailTextLabel.text = ref.summary; cell.accessoryType = UITableViewCellAccessoryDisclosureIndicator; return cell; } - (NSString *)tableView:(UITableView *)tableView titleForHeaderInSection:(NSInteger)section { return self.sections[section].title; } #pragma mark - Table View Delegate - (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath { [self.navigationController pushViewController:[FLEXObjectExplorerFactory explorerViewControllerForObject:[self referenceForIndexPath:indexPath].object ] animated:YES]; } @end