//
//  MulleScionObjectModel+Printing.h
//  MulleScion
//
//  Created by Nat! on 24.02.13.
//
//  Copyright (c) 2013 Nat! - Mulle kybernetiK
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are met:
//
//  Redistributions of source code must retain the above copyright notice, this
//  list of conditions and the following disclaimer.
//
//  Redistributions in binary form must reproduce the above copyright notice,
//  this list of conditions and the following disclaimer in the documentation
//  and/or other materials provided with the distribution.
//
//  Neither the name of Mulle kybernetiK nor the names of its contributors
//  may be used to endorse or promote products derived from this software
//  without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
//  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
//  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
//  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
//  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
//  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
//  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//

#import "MulleScionObjectModel.h"

#import "MulleScionDataSourceProtocol.h"
#import "MulleScionOutputProtocol.h"


@interface MulleScionObject( Printing)

- (MulleScionObject *) renderInto:(id <MulleScionOutput>) output
                   localVariables:(NSMutableDictionary *) locals
                       dataSource:(id <MulleScionDataSource>) dataSource;
@end


extern NSString   *MulleScionRenderOutputKey;
extern NSString   *MulleScionCurrentFileKey;
extern NSString   *MulleScionCurrentLineKey;
extern NSString   *MulleScionCurrentFunctionKey;
extern NSString   *MulleScionFoundationKey;
extern NSString   *MulleScionFunctionTableKey;
extern NSString   *MulleScionArgumentsKey;
extern NSString   *MulleScionVersionKey;
extern NSString   *MulleScionShouldFilterPlainTextKey;

extern NSString   *MulleScionForOpenerKey;
extern NSString   *MulleScionForSeparatorKey;
extern NSString   *MulleScionForCloserKey;

extern NSString   *MulleScionEvenKey;
extern NSString   *MulleScionOddKey;


@interface MulleScionTemplate( Printing)

- (NSMutableDictionary *) localVariablesWithDefaultValues:(NSDictionary *) defaults;
+ (NSMutableDictionary *) mulleScionDefaultBuiltinFunctionTable;

@end


NSString  *MulleScionFilteredString( NSString *value,
                                    NSMutableDictionary *locals,
                                    id <MulleScionDataSource> dataSource,
                                    NSUInteger bit);

void   MulleScionRenderString( NSString *value,
                               id <MulleScionOutput> output,
                               NSMutableDictionary *locals,
                               id <MulleScionDataSource> dataSource);

void   MulleScionRenderPlaintextString( NSString *value,
                                        id <MulleScionOutput> output,
                                        NSMutableDictionary *locals,
                                        id <MulleScionDataSource> dataSource);