iTermAutomaticProfileSwitcher.h

//
//  iTermAutomaticProfileSwitching.h
//  iTerm2
//
//  Created by George Nachman on 2/28/16.
//
//

#import <Foundation/Foundation.h>
#import "ProfileModel.h"

NS_ASSUME_NONNULL_BEGIN

// Describes all the possible state of a profile needed to restore it.
@interface iTermSavedProfile : NSObject
@property(nonatomic, copy, nullable) Profile *profile;
@property(nonatomic, copy) Profile *originalProfile;
@property(nonatomic, assign) BOOL isDivorced;
@property(nonatomic, retain, nullable) NSMutableSet *overriddenFields;
@end

// The session that uses automatic profile switching should implement this protocol.
@protocol iTermAutomaticProfileSwitcherDelegate<NSObject>

// Make the |savedProfile| into the current profile, respecting overridden fields, etc.
- (void)automaticProfileSwitcherLoadProfile:(iTermSavedProfile *)savedProfile;

// Returns the current profile, including local changes.
- (Profile *)automaticProfileSwitcherCurrentProfile;

// Returns the current profile. Only the name and GUID are needed.
- (iTermSavedProfile *)automaticProfileSwitcherCurrentSavedProfile;

// Returns all profiles in user defaults. Exposed for testing.
- (NSArray<Profile *> *)automaticProfileSwitcherAllProfiles;

// Returns the session's name for logging.
- (NSString *)automaticProfileSwitcherSessionName;

@end

// This class encapsulates the logic needed by automatic profile switching.
@interface iTermAutomaticProfileSwitcher : NSObject

// You should set this or nothing will work.
@property(nonatomic, weak) id<iTermAutomaticProfileSwitcherDelegate> delegate;
@property(nonatomic, readonly) NSString *profileStackString;  // For tests

- (instancetype)initWithDelegate:(id<iTermAutomaticProfileSwitcherDelegate>)delegate NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithDelegate:(id<iTermAutomaticProfileSwitcherDelegate>)delegate
                      savedState:(NSDictionary *)savedState;
- (instancetype)init NS_UNAVAILABLE;

- (NSDictionary *)savedState;

// Call this when the hostname, username, or path changes.
- (void)setHostname:(nullable NSString *)hostname
           username:(nullable NSString *)username
               path:(nullable NSString *)path
                job:(nullable NSString *)job;

@end

NS_ASSUME_NONNULL_END