FLEX/Classes/ObjectExplorers/Controllers/FLEXObjectExplorerViewController.h

//
//  FLEXObjectExplorerViewController.h
//  Flipboard
//
//  Created by Ryan Olson on 2014-05-03.
//  Copyright (c) 2014 Flipboard. All rights reserved.
//

#ifndef _FLEXObjectExplorerViewController_h
#define _FLEXObjectExplorerViewController_h
#endif

#import "FLEXTableViewController.h"

typedef NS_ENUM(NSUInteger, FLEXObjectExplorerSection) {
    FLEXObjectExplorerSectionDescription,
    FLEXObjectExplorerSectionCustom,
    FLEXObjectExplorerSectionProperties,
    FLEXObjectExplorerSectionIvars,
    FLEXObjectExplorerSectionMethods,
    FLEXObjectExplorerSectionClassMethods,
    FLEXObjectExplorerSectionSuperclasses,
    FLEXObjectExplorerSectionReferencingInstances
};

@interface FLEXObjectExplorerViewController : FLEXTableViewController

@property (nonatomic) id object;

// Subclasses can override the methods below to provide data in a custom section.
// The subclass should provide an array of "row cookies" to allow retrieval of individual row data later on.
// The objects in the rowCookies array will be used to call the row title, subtitle, etc methods to construct the rows.
// The cookies approach is used here because we may filter the visible rows based on the search text entered by the user.
- (NSString *)customSectionTitle;
- (NSArray *)customSectionRowCookies;
- (NSString *)customSectionTitleForRowCookie:(id)rowCookie;
- (NSString *)customSectionSubtitleForRowCookie:(id)rowCookie;
- (BOOL)customSectionCanDrillIntoRowWithCookie:(id)rowCookie;
- (UIViewController *)customSectionDrillInViewControllerForRowCookie:(id)rowCookie;
- (UIView *)customViewForRowCookie:(id)rowCookie;

// More subclass configuration hooks.

/// Whether to allow showing/drilling in to current values for ivars and properties. Default is YES.
- (BOOL)canHaveInstanceState;

/// Whether to allow drilling in to method calling interfaces for instance methods. Default is YES.
- (BOOL)canCallInstanceMethods;

/// If the custom section data makes the description redundant, subclasses can choose to hide it. Default is YES.
- (BOOL)shouldShowDescription;

/// Subclasses can reorder/change which sections can display directly by overriding this method.
- (NSArray *)possibleExplorerSections;

/// Subclasses can override to provide a more useful description
- (NSString *)displayedObjectDescription;

@end

@interface FLEXObjectExplorerViewController (Shortcuts)

/// @brief Names of properties to supply as shortcuts. If this array is empty, no shortcuts are displayed.
///
/// @discussion Populating this array in a subclass will make FLEXObjectExplorerViewController show a custom
/// section with row titles like "@property NSString *foo" and subtitles with their values.
/// customSectionRowCookies will return this array. Every row in the section is drillable by default.
///
/// For an example on how to use the default behavior provided or to override it,
/// see FLEXViewExplorerViewController
- (NSArray<NSString *> *)shortcutPropertyNames;

@end