Source/CDMultiFileVisitor.m

   1 // -*- mode: ObjC -*-
   2
   3 //  This file is part of class-dump, a utility for examining the Objective-C segment of Mach-O files.
   4 //  Copyright (C) 1997-2019 Steve Nygard.
   5
   6 #import "CDMultiFileVisitor.h"
   7
   8 #import "CDClassDump.h"
   9 #import "CDClassFrameworkVisitor.h"
  10 #import "CDOCCategory.h"
  11 #import "CDOCClass.h"
  12 #import "CDOCProtocol.h"
  13 #import "CDOCInstanceVariable.h"
  14 #import "CDTypeController.h"
  15
  16 @interface CDMultiFileVisitor ()
  17
  18 // NSString (class name) -> NSString (framework name)
  19 @property (strong) NSDictionary *frameworkNamesByClassName;
  20
  21 // NSString (protocol name) -> NSString (framework name)
  22 @property (strong) NSDictionary *frameworkNamesByProtocolName;
  23
  24 // Location in output string to insert the protocol imports and forward class declarations.
  25 // We don't know what classes and protocols will be referenced until the rest of the output is generated.
  26 @property (assign) NSUInteger referenceLocation;
  27
  28 // Class and protocol references
  29 @property (readonly) NSMutableSet *referencedClassNames;
  30 @property (readonly) NSMutableSet *referencedProtocolNames;
  31 @property (readonly) NSMutableSet *weaklyReferencedProtocolNames; // Protocols that can be forward-declared instead of imported
  32
  33 @property (nonatomic, readonly) NSArray *referencedClassNamesSortedByName;
  34 @property (nonatomic, readonly) NSArray *referencedProtocolNamesSortedByName;
  35 @property (nonatomic, readonly) NSArray *weaklyReferencedProtocolNamesSortedByName;
  36
  37 @property (nonatomic, readonly) NSString *referenceString;
  38
  39 @end
  40
  41 #pragma mark -
  42
  43 @implementation CDMultiFileVisitor
  44 {
  45     NSString *_outputPath;
  46
  47     NSDictionary *_frameworkNamesByClassName;
  48     NSMutableSet *_referencedClassNames;
  49     NSMutableSet *_referencedProtocolNames;
  50     NSUInteger _referenceLocation;
  51 }
  52
  53 - (id)init;
  54 {
  55     if ((self = [super init])) {
  56         _referencedClassNames = [[NSMutableSet alloc] init];
  57         _referencedProtocolNames = [[NSMutableSet alloc] init];
  58         _weaklyReferencedProtocolNames = [[NSMutableSet alloc] init];
  59     }
  60
  61     return self;
  62 }
  63
  64 #pragma mark -
  65
  66 - (void)willBeginVisiting;
  67 {
  68     [super willBeginVisiting];
  69
  70     [self.classDump appendHeaderToString:self.resultString];
  71
  72     if (self.classDump.hasObjectiveCRuntimeInfo) {
  73         [self buildClassFrameworks];
  74         [self createOutputPathIfNecessary];
  75         [self generateStructureHeader];
  76     } else {
  77         // TODO: (2007-06-14) Make sure this generates no output files in this case.
  78         NSLog(@"Warning: This file does not contain any Objective-C runtime information.");
  79     }
  80 }
  81
  82 - (void)willVisitClass:(CDOCClass *)aClass;
  83 {
  84     // First, we set up some context...
  85     [self.resultString setString:@""];
  86     [self.classDump appendHeaderToString:self.resultString];
  87
  88     [self removeAllClassNameProtocolNameReferences];
  89     NSString *str = [self importStringForClassName:aClass.superClassName];
  90     if (str != nil) {
  91         [self.resultString appendString:str];
  92         [self.resultString appendString:@"\n"];
  93     }
  94
  95     self.referenceLocation = [self.resultString length];
  96
  97     // And then generate the regular output
  98     [super willVisitClass:aClass];
  99
 100     [self addReferencesToProtocolNamesInArray:aClass.protocolNames];
 101 }
 102
 103 - (void)didVisitClass:(CDOCClass *)aClass;
 104 {
 105     // Generate the regular output
 106     [super didVisitClass:aClass];
 107
 108     // Then insert the imports and write the file.
 109     [self removeReferenceToClassName:aClass.name];
 110     [self removeReferenceToClassName:aClass.superClassName];
 111     NSString *referenceString = self.referenceString;
 112     if (referenceString != nil)
 113         [self.resultString insertString:referenceString atIndex:self.referenceLocation];
 114
 115     NSString *filename = [NSString stringWithFormat:@"%@.h", aClass.name];
 116     if (self.outputPath != nil)
 117         filename = [self.outputPath stringByAppendingPathComponent:filename];
 118
 119     [[self.resultString dataUsingEncoding:NSUTF8StringEncoding] writeToFile:filename atomically:YES];
 120 }
 121
 122 - (void)willVisitCategory:(CDOCCategory *)category;
 123 {
 124     // First, we set up some context...
 125     [self.resultString setString:@""];
 126     [self.classDump appendHeaderToString:self.resultString];
 127
 128     [self removeAllClassNameProtocolNameReferences];
 129     NSString *str = [self importStringForClassName:category.className];
 130     if (str != nil) {
 131         [self.resultString appendString:str];
 132         [self.resultString appendString:@"\n"];
 133     }
 134     self.referenceLocation = [self.resultString length];
 135
 136     // And then generate the regular output
 137     [super willVisitCategory:category];
 138
 139     [self addReferencesToProtocolNamesInArray:category.protocolNames];
 140 }
 141
 142 - (void)didVisitCategory:(CDOCCategory *)category;
 143 {
 144     // Generate the regular output
 145     [super didVisitCategory:category];
 146
 147     // Then insert the imports and write the file.
 148     [self removeReferenceToClassName:category.className];
 149     NSString *referenceString = self.referenceString;
 150     if (referenceString != nil)
 151         [self.resultString insertString:referenceString atIndex:self.referenceLocation];
 152
 153     NSString *filename = [NSString stringWithFormat:@"%@-%@.h", category.className, category.name];
 154     if (self.outputPath != nil)
 155         filename = [self.outputPath stringByAppendingPathComponent:filename];
 156
 157     [[self.resultString dataUsingEncoding:NSUTF8StringEncoding] writeToFile:filename atomically:YES];
 158 }
 159
 160 - (void)willVisitProtocol:(CDOCProtocol *)protocol;
 161 {
 162     [self.resultString setString:@""];
 163     [self.classDump appendHeaderToString:self.resultString];
 164
 165     [self removeAllClassNameProtocolNameReferences];
 166     self.referenceLocation = [self.resultString length];
 167
 168     // And then generate the regular output
 169     [super willVisitProtocol:protocol];
 170
 171     [self addReferencesToProtocolNamesInArray:protocol.protocolNames];
 172 }
 173
 174 - (void)didVisitProtocol:(CDOCProtocol *)protocol;
 175 {
 176     // Generate the regular output
 177     [super didVisitProtocol:protocol];
 178
 179     // Then insert the imports and write the file.
 180     NSString *referenceString = self.referenceString;
 181     if (referenceString != nil)
 182         [self.resultString insertString:referenceString atIndex:self.referenceLocation];
 183
 184     NSString *filename = [NSString stringWithFormat:@"%@-Protocol.h", protocol.name];
 185     if (self.outputPath != nil)
 186         filename = [self.outputPath stringByAppendingPathComponent:filename];
 187
 188     [[self.resultString dataUsingEncoding:NSUTF8StringEncoding] writeToFile:filename atomically:YES];
 189 }
 190
 191 #pragma mark - CDTypeControllerDelegate
 192
 193 - (void)typeController:(CDTypeController *)typeController didReferenceClassName:(NSString *)name;
 194 {
 195     [self addReferenceToClassName:name];
 196 }
 197
 198 - (void)typeController:(CDTypeController *)typeController didReferenceProtocolNames:(NSArray *)names;
 199 {
 200     [self addWeakReferencesToProtocolNamesInArray:names];
 201 }
 202
 203 #pragma mark -
 204
 205 - (NSString *)frameworkForClassName:(NSString *)name;
 206 {
 207     NSString *framework = self.frameworkNamesByClassName[name];
 208
 209     // Map public CoreFoundation classes to Foundation, because that is where the headers are exposed
 210     if ([framework isEqualToString:@"CoreFoundation"] && [name hasPrefix:@"NS"]) {
 211         framework = @"Foundation";
 212     }
 213
 214     return framework;
 215 }
 216
 217 - (NSString *)frameworkForProtocolName:(NSString *)name;
 218 {
 219     return self.frameworkNamesByProtocolName[name];
 220 }
 221
 222 - (NSString *)importStringForClassName:(NSString *)name;
 223 {
 224     if (name != nil) {
 225         NSString *framework = [self frameworkForClassName:name];
 226         if (framework == nil)
 227             return [NSString stringWithFormat:@"#import \"%@.h\"\n", name];
 228         else
 229             return [NSString stringWithFormat:@"#import <%@/%@.h>\n", framework, name];
 230     }
 231
 232     return nil;
 233 }
 234
 235 - (NSString *)importStringForProtocolName:(NSString *)name;
 236 {
 237     if (name != nil) {
 238         NSString *framework = [self frameworkForProtocolName:name];
 239         NSString *headerName = [name stringByAppendingString:@"-Protocol.h"];
 240         if (framework == nil)
 241             return [NSString stringWithFormat:@"#import \"%@\"\n", headerName];
 242         else
 243             return [NSString stringWithFormat:@"#import <%@/%@>\n", framework, headerName];
 244     }
 245
 246     return nil;
 247 }
 248
 249 #pragma mark - Class and Protocol name tracking
 250
 251 - (NSArray *)referencedClassNamesSortedByName;
 252 {
 253     return [[self.referencedClassNames allObjects] sortedArrayUsingSelector:@selector(compare:)];
 254 }
 255
 256 - (NSArray *)referencedProtocolNamesSortedByName;
 257 {
 258     return [[self.referencedProtocolNames allObjects] sortedArrayUsingSelector:@selector(compare:)];
 259 }
 260
 261 - (NSArray *)weaklyReferencedProtocolNamesSortedByName;
 262 {
 263     return [[self.weaklyReferencedProtocolNames allObjects] sortedArrayUsingSelector:@selector(compare:)];
 264 }
 265
 266 - (void)addReferenceToClassName:(NSString *)className;
 267 {
 268     [self.referencedClassNames addObject:className];
 269 }
 270
 271 - (void)removeReferenceToClassName:(NSString *)className;
 272 {
 273     if (className != nil)
 274         [self.referencedClassNames removeObject:className];
 275 }
 276
 277 - (void)addReferencesToProtocolNamesInArray:(NSArray *)protocolNames;
 278 {
 279     [self.referencedProtocolNames addObjectsFromArray:protocolNames];
 280 }
 281
 282 - (void)addWeakReferencesToProtocolNamesInArray:(NSArray *)protocolNames;
 283 {
 284     [self.weaklyReferencedProtocolNames addObjectsFromArray:protocolNames];
 285 }
 286
 287 - (void)removeAllClassNameProtocolNameReferences;
 288 {
 289     [self.referencedClassNames removeAllObjects];
 290     [self.referencedProtocolNames removeAllObjects];
 291     [self.weaklyReferencedProtocolNames removeAllObjects];
 292 }
 293
 294 #pragma mark -
 295
 296 - (void)createOutputPathIfNecessary;
 297 {
 298     if (self.outputPath != nil) {
 299         BOOL isDirectory;
 300
 301         NSFileManager *fileManager = [NSFileManager defaultManager];
 302         if ([fileManager fileExistsAtPath:self.outputPath isDirectory:&isDirectory] == NO) {
 303             NSError *error = nil;
 304             BOOL result = [fileManager createDirectoryAtPath:self.outputPath withIntermediateDirectories:YES attributes:nil error:&error];
 305             if (result == NO) {
 306                 NSLog(@"Error: Couldn't create output directory: %@", self.outputPath);
 307                 NSLog(@"error: %@", error); // TODO: Test this
 308                 return;
 309             }
 310         } else if (isDirectory == NO) {
 311             NSLog(@"Error: File exists at output path: %@", self.outputPath);
 312             return;
 313         }
 314     }
 315 }
 316
 317 #pragma mark -
 318
 319 // - imports for each referenced protocol
 320 // - forward declarations for each referenced class
 321
 322 - (NSString *)referenceString;
 323 {
 324     NSMutableString *referenceString = [[NSMutableString alloc] init];
 325
 326     if ([self.referencedProtocolNames count] > 0) {
 327         for (NSString *name in self.referencedProtocolNamesSortedByName) {
 328             NSString *str = [self importStringForProtocolName:name];
 329             if (str != nil)
 330                 [referenceString appendString:str];
 331         }
 332
 333         [referenceString appendString:@"\n"];
 334     }
 335
 336     BOOL addNewline = NO;
 337     if ([self.referencedClassNames count] > 0) {
 338         [referenceString appendFormat:@"@class %@;\n", [self.referencedClassNamesSortedByName componentsJoinedByString:@", "]];
 339         addNewline = YES;
 340     }
 341
 342     if ([self.weaklyReferencedProtocolNames count] > 0) {
 343         [referenceString appendFormat:@"@protocol %@;\n", [self.weaklyReferencedProtocolNamesSortedByName componentsJoinedByString:@", "]];
 344         addNewline = YES;
 345     }
 346
 347     if (addNewline)
 348         [referenceString appendString:@"\n"];
 349
 350     if ([referenceString length] == 0)
 351         return nil;
 352
 353     return [referenceString copy];
 354 }
 355
 356 #pragma mark -
 357
 358 - (void)buildClassFrameworks;
 359 {
 360     CDClassFrameworkVisitor *visitor = [[CDClassFrameworkVisitor alloc] init];
 361     visitor.classDump = self.classDump;
 362
 363     [self.classDump recursivelyVisit:visitor];
 364     self.frameworkNamesByClassName = visitor.frameworkNamesByClassName;
 365     self.frameworkNamesByProtocolName = visitor.frameworkNamesByProtocolName;
 366 }
 367
 368 - (void)generateStructureHeader;
 369 {
 370     [self.resultString setString:@""];
 371     [self.classDump appendHeaderToString:self.resultString];
 372
 373     [self removeAllClassNameProtocolNameReferences];
 374     self.referenceLocation = [self.resultString length];
 375
 376     [[self.classDump typeController] appendStructuresToString:self.resultString];
 377
 378     NSString *referenceString = [self referenceString];
 379     if (referenceString != nil)
 380         [self.resultString insertString:referenceString atIndex:self.referenceLocation];
 381
 382     NSString *filename = @"CDStructures.h";
 383     if (self.outputPath != nil)
 384         filename = [self.outputPath stringByAppendingPathComponent:filename];
 385
 386     [[self.resultString dataUsingEncoding:NSUTF8StringEncoding] writeToFile:filename atomically:YES];
 387 }
 388
 389 @end