ViBundle.h

/*
 * Copyright (c) 2008-2012 Martin Hedenfalk <martin@vicoapp.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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 "ViLanguage.h"
#import "ViCommon.h"
#import "Nu.h"

@class ViBundleCommand;
@class ViTextView;

@interface ViBundle : NSObject
{
	NSString		*_path;
	NSDictionary		*_info;
	NSMutableArray		*_languages;
	NSMutableArray		*_preferences;
	NSMutableArray		*_items;
	NSMutableDictionary	*_cachedPreferences;
	NSMutableDictionary	*_uuids;
	NuParser		*_parser;
}

@property(nonatomic,readonly) NSMutableArray *languages;
@property(nonatomic,readonly) NSString *path;
@property(nonatomic,readonly) NSArray *items;
@property(nonatomic,readonly) NSArray *preferences;
@property(nonatomic,readonly) NSString *name;
@property(nonatomic,readonly) NSString *uuid;

+ (NSColor *)hashRGBToColor:(NSString *)hashRGB;
+ (void)normalizeSettings:(NSDictionary *)settings
	   intoDictionary:(NSMutableDictionary *)normalizedPreference
               withParser:(NuParser *)aParser;
+ (void)normalizeSettings:(NSDictionary *)settings
	   intoDictionary:(NSMutableDictionary *)normalizedPreference;
+ (void)normalizePreference:(NSDictionary *)preference
             intoDictionary:(NSMutableDictionary *)normalizedPreference;
+ (void)setupEnvironment:(NSMutableDictionary *)env
             forTextView:(ViTextView *)textView
	      inputRange:(NSRange)inputRange
		  window:(NSWindow *)window
		  bundle:(ViBundle *)bundle;
+ (void)setupEnvironment:(NSMutableDictionary *)env
             forTextView:(ViTextView *)textView
		  window:(NSWindow *)aWindow
		  bundle:(ViBundle *)bundle;

- (ViBundle *)initWithDirectory:(NSString *)bundleDirectory;
- (BOOL)loadPluginCode;
- (NSString *)supportPath;
- (NSDictionary *)preferenceItem:(NSString *)prefsName;
- (NSDictionary *)preferenceItems:(NSArray *)prefsNames;
- (NSMenu *)menuForScope:(ViScope *)scope
            hasSelection:(BOOL)hasSelection
                    font:(NSFont *)aFont;

/**
 * @returns Global bundle environment variables. No text- or file-related variables will be set.
 * @see [ViTextView environment] and [ViWindowController environment]
 */
+ (NSDictionary *)environment;

@end