// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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.

// This file comes from the portion of the UX Write editor that
// works on both Apple platforms (that is, it can run on either
// OS X or iOS). It's in the repository for illustrative purposes
// only, to assist with the creation of the framework for the
// Corinthia editor UI. The code does not compile independently in
// its present form.

#import <Foundation/Foundation.h>

////////////////////////////////////////////////////////////////////////////////////////////////////
//                                                                                                //
//                                           EDScanMatch                                          //
//                                                                                                //
////////////////////////////////////////////////////////////////////////////////////////////////////

@interface EDScanMatch : NSObject

@property (assign, readonly) int matchId;
@property (copy, readonly) NSString *text;

- (EDScanMatch *)initWithMatchId:(int)matchId text:(NSString *)text;

@end

////////////////////////////////////////////////////////////////////////////////////////////////////
//                                                                                                //
//                                      EDScanResultsSection                                      //
//                                                                                                //
////////////////////////////////////////////////////////////////////////////////////////////////////

@interface EDScanResultsSection : NSObject

@property (copy, readonly) NSString *title;
@property (strong, readonly) NSMutableArray *matches;

- (EDScanResultsSection *)initWithTitle:(NSString *)title;

@end

////////////////////////////////////////////////////////////////////////////////////////////////////
//                                                                                                //
//                                          EDScanResults                                         //
//                                                                                                //
////////////////////////////////////////////////////////////////////////////////////////////////////

@interface EDScanResults : NSObject

@property (readonly) NSMutableArray *sections;

- (EDScanResults *)init;
- (NSUInteger)matchCount;
- (EDScanMatch *)matchAtIndex:(NSUInteger)index;
- (void)addMatch:(EDScanMatch *)match;
- (void)removeMatch:(EDScanMatch *)match;

@end