spiegel-keyman/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.h
Marc Durdin 01b192796a feat(mac): user-controllable legacy app list
Fixes #1953.

Makes it possible to specify additional apps that need 'legacy' handling
without requiring an updated build of Keyman for Mac. The list should be
stored in user defaults under the `KMLegacyApps` key. It can be viewed
with the command:

```
defaults read keyman.inputmethod.Keyman KMLegacyApps
```

And updated with

```
defaults write keyman.inputmethod.Keyman KMLegacyApps -array value1 value2 ...
defaults write keyman.inputmethod.Keyman KMLegacyApps -array-add value1 value2 ...
```

Each entry should be a regex that matches the client app id.

For example:

```
defaults write keyman.inputmethod.Keyman KMLegacyApps -array com.microsoft.Word '^com.github.atom$'
```

(Note for purity, the `.` should be escaped in the regex but it'll
actually be fine without...)

This commit also adds the `keymanDataPath` method on
`KMInputMethodAppDelegate`, so we can place additional configuration
data there in the future (as opposed to in the shared config which is
less easy for users to edit.)
2020-11-25 16:56:52 +11:00

132 lines
5 KiB
Objective-C

//
// KMInputMethodAppDelegate.h
// Keyman4MacIM
//
// Created by Serkan Kurt on 12/02/2015.
// Copyright (c) 2017 SIL International. All rights reserved.
//
#ifndef KMInputMethodAppDelegate_h
#define KMInputMethodAppDelegate_h
#import <Foundation/Foundation.h>
#import <Cocoa/Cocoa.h>
#import <KeymanEngine4Mac/KeymanEngine4Mac.h>
#import "KMInputController.h"
#import "KMAboutWindowController.h"
#import "KMInfoWindowController.h"
#import "KMKeyboardHelpWindowController.h"
#import "OSKWindowController.h"
#import "NSWindow+SuppMethods.h"
#import "NSString+SuppMethods.h"
typedef void(^PostEventCallback)(CGEventRef eventToPost);
extern NSString *const kKMSelectedKeyboardKey;
extern NSString *const kKMActiveKeyboardsKey;
extern NSString *const kKeymanKeyboardDownloadCompletedNotification;
extern NSString *const kPackage;
extern NSString *const kButtons;
extern NSString *const kStartMenu;
extern NSString *const kStartMenuEntries;
extern NSString *const kInfo;
extern NSString *const kFiles;
extern NSString *const kAuthor;
extern NSString *const kCopyright;
extern NSString *const kFile;
extern NSString *const kFont;
extern NSString *const kGraphicFile;
extern NSString *const kKeyboard;
extern NSString *const kName;
extern NSString *const kReadMeFile;
extern NSString *const kVersion;
extern NSString *const kWebSite;
typedef struct {
NSString *sentryEnvironment;
NSString *versionRelease;
NSString *versionWithTag;
NSString *tier;
NSString *keymanCom;
NSString *helpKeymanCom;
NSString *apiKeymanCom;
} KeymanVersionInfo;
@interface KMInputMethodAppDelegate : NSObject
#define USE_ALERT_SHOW_HELP_TO_FORCE_EASTER_EGG_CRASH_FROM_ENGINE 1
#ifdef USE_ALERT_SHOW_HELP_TO_FORCE_EASTER_EGG_CRASH_FROM_ENGINE
<NSAlertDelegate>
#endif
{
IBOutlet NSMenu *_menu;
}
@property (nonatomic, strong) KMEngine *kme;
@property (nonatomic, strong) KMXFile *kmx;
@property (nonatomic, strong) KVKFile *kvk;
@property (nonatomic, strong) NSString *keyboardsPath;
@property (nonatomic, strong) NSString *fontsPath;
@property (nonatomic, strong) NSMutableArray *kmxFileList;
@property (nonatomic, strong) NSString *selectedKeyboard;
@property (nonatomic, strong) NSMutableArray *activeKeyboards;
@property (nonatomic, strong) NSMutableString *contextBuffer;
@property (nonatomic, assign) NSEventModifierFlags currentModifierFlags;
@property (nonatomic, assign) CFMachPortRef lowLevelEventTap;
@property (nonatomic, assign) CFRunLoopSourceRef runLoopEventSrc;
@property (nonatomic, assign) BOOL sleeping;
@property (nonatomic, assign) BOOL contextChangingEventDetected;
@property (nonatomic, strong) OSKWindowController *oskWindow;
@property (nonatomic, strong) NSString *keyboardName;
@property (nonatomic, strong) NSImage *keyboardIcon;
@property (nonatomic, strong) NSAlert *downloadInfoView;
@property (nonatomic, strong) NSProgressIndicator *progressIndicator;
@property (nonatomic, weak) KMInputController *inputController;
@property (nonatomic, strong) NSWindowController *configWindow;
@property (nonatomic, strong) NSWindowController *downloadKBWindow;
@property (nonatomic, strong) KMAboutWindowController *aboutWindow;
@property (nonatomic, strong) KMInfoWindowController *infoWindow;
@property (nonatomic, strong) KMKeyboardHelpWindowController *kbHelpWindow;
@property (nonatomic, strong) NSURLConnection *connection;
@property (nonatomic, strong) NSString *downloadFilename;
@property (nonatomic, strong) NSMutableData *receivedData;
@property (nonatomic, assign) NSUInteger expectedBytes;
@property (nonatomic, assign) BOOL alwaysShowOSK;
@property (nonatomic, assign) BOOL useVerboseLogging;
@property (nonatomic, assign) BOOL useNullChar;
@property (nonatomic, assign) BOOL debugMode;
- (NSMenu *)menu;
- (void)saveActiveKeyboards;
- (void)loadSavedStores;
- (void)saveStore:(NSNumber *)storeKey withValue:(NSString* )value;
- (void)showAboutWindow;
- (void)showOSK;
- (void)showConfigurationWindow;
- (void)sleepFollowingDeactivationOfServer:(id)lastServer;
- (void)wakeUpWith:(id)newServer;
- (void)handleKeyEvent:(NSEvent *)event;
- (BOOL)unzipFile:(NSString *)filePath;
- (NSWindowController *)downloadKBWindow_;
- (NSWindowController *)aboutWindow_;
- (NSWindowController *)infoWindow_;
- (NSWindowController *)kbHelpWindow_;
- (void)processURL:(NSString*)rawUrl;
- (void)downloadKeyboardFromKeyboardId:(NSString *)keyboardId;
- (NSString *)kmxFilePathAtIndex:(NSUInteger)index;
- (NSString *)packagePathAtIndex:(NSUInteger)index;
- (NSInteger)indexForPackageFolder:(NSString *)packageFolder;
- (NSString *)packageFolderFromPath:(NSString *)path;
- (NSString *)packageNameFromFolder:(NSString *)packageFolder;
- (NSArray *)keyboardNamesFromFolder:(NSString *)packageFolder;
- (NSDictionary *)infoDictionaryFromFile:(NSString *)infoFile;
- (NSString *)kvkFilePathFromFilename:(NSString *)kvkFilename;
- (NSString *)oskWindowTitle;
- (void)postKeyboardEventWithSource: (CGEventSourceRef)source code:(CGKeyCode) virtualKey postCallback:(PostEventCallback)postEvent;
- (KeymanVersionInfo)versionInfo;
- (NSString *)keymanDataPath;
- (NSArray *)legacyAppsUserDefaults;
@end
#endif /* KMInputMethodAppDelegate_h */