CoverStoryCoverageData.h

//
//  CoverStoryCoverageData.h
//  CoverStory
//
//  Created by dmaclach on 12/24/06.
//  Copyright 2006-2008 Google Inc.
//  Licensed under the Apache License, Version 2.0 (the "License"); you may not
//  use this file except in compliance with the License.  You may obtain a copy
//  of the License at
// 
//  http://www.apache.org/licenses/LICENSE-2.0
// 
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
//  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
//  License for the specific language governing permissions and limitations under
//  the License.
//

#import <Cocoa/Cocoa.h>

@class CoverStoryDocument;

enum {
  // Value for hitCount for lines that aren't executed
  kCoverStoryNotExecutedMarker = -1,
  // Value for hitCount for lines that are non-feasible
  kCoverStoryNonFeasibleMarker = -2
};

@protocol CoverStoryLineCoverageProtocol
- (void)coverageTotalLines:(NSInteger *)outTotal
                 codeLines:(NSInteger *)outCode // doesn't include non-feasible
              hitCodeLines:(NSInteger *)outHitCode
          nonFeasibleLines:(NSInteger *)outNonFeasible
            coverageString:(NSString **)outCoverageString
                  coverage:(float *)outCoverage; // use the string for display,
                                                 // this is just here for calcs
                                                 // and sorts
@end

@interface NSEnumerator (CodeCoverage)
- (void)coverageTotalLines:(NSInteger *)outTotal
                 codeLines:(NSInteger *)outCode
              hitCodeLines:(NSInteger *)outHitCode
          nonFeasibleLines:(NSInteger *)outNonFeasible
            coverageString:(NSString **)outCoverageString
                  coverage:(float *)outCoverage; // use the string for display,
                                                 // this is just here for calcs
                                                 // and sorts
@end

// methods to get feedback while the data is processed
@protocol CoverStoryCoverageProcessingProtocol
- (void)coverageErrorForPath:(NSString*)path message:(NSString *)format, ...;
- (void)coverageWarningForPath:(NSString*)path message:(NSString *)format, ...;
@end

// Keeps track of the data for a whole source file.

@interface CoverStoryCoverageFileData : NSObject<CoverStoryLineCoverageProtocol> {
 @private
  NSMutableArray *lines_; // of CoverStoryCoverageLineData
  NSInteger hitLines_;
  NSInteger codeLines_;
  NSInteger nonfeasible_;
  NSString *sourcePath_;
  NSMutableArray *warnings_;
  __weak CoverStoryDocument *document_;
}

@property (readonly, nonatomic, assign) CoverStoryDocument *document;
@property (readonly, nonatomic, copy) NSString *sourcePath;
@property (readonly, nonatomic, retain) NSArray *lines;
// this is only vended for the table to sort with
@property (readonly, nonatomic, retain) NSNumber *coverage;

+ (id)coverageFileDataFromPath:(NSString *)path
                      document:(CoverStoryDocument *)document
               messageReceiver:(id<CoverStoryCoverageProcessingProtocol>)receiver;
- (id)initWithPath:(NSString *)path
          document:(CoverStoryDocument *)document
   messageReceiver:(id<CoverStoryCoverageProcessingProtocol> )receiver;

@end


// Keeps track of a set of source files.

@interface CoverStoryCoverageSet : NSObject<CoverStoryLineCoverageProtocol> {
@private
  NSMutableArray *fileDatas_;
}
- (void)removeAllData;
- (BOOL)addFileData:(CoverStoryCoverageFileData *)fileData
    messageReceiver:(id<CoverStoryCoverageProcessingProtocol>)receiver;
@end
                    
                     
// Keeps track of the number of times a line of code has been hit. There is
// one CoverStoryCoverageLineData object per line of code in the file. 

@interface CoverStoryCoverageLineData : NSObject {
 @private
  NSInteger hitCount_;  // how many times this line has been hit
  NSString *line_;  //  the line
  __weak CoverStoryCoverageFileData *coverageFile_;
}

@property (readonly, nonatomic, assign) NSInteger hitCount;
@property (readonly, nonatomic, copy) NSString *line;
@property (readonly, nonatomic, assign) CoverStoryCoverageFileData *coverageFile;

+ (id)coverageLineDataWithLine:(NSString*)line 
                      hitCount:(NSInteger)hitCount 
                  coverageFile:(CoverStoryCoverageFileData *)coverageFile;
- (id)initWithLine:(NSString*)line 
          hitCount:(NSInteger)hitCount
      coverageFile:(CoverStoryCoverageFileData *)coverageFile;
- (void)addHits:(NSInteger)newHits;
@end