Skip to content
Navigation Menu
{{ message }}
forked from onevcat/VVDocumenter-Xcode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathVVDocumenterManager.m
More file actions
232 lines (192 loc) · 11.2 KB
/
Copy pathVVDocumenterManager.m
File metadata and controls
232 lines (192 loc) · 11.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
//
// VVDocumenterManager.m
// VVDocumenter-Xcode
//
// Created by 王 巍 on 13-7-16.
//
// Copyright (c) 2015 Wei Wang <onevcat@gmail.com>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#import "VVDocumenterManager.h"
#import "NSTextView+VVTextGetter.h"
#import "NSString+VVSyntax.h"
#import "VVDocumenter.h"
#import "VVKeyboardEventSender.h"
#import "VVDSettingPanelWindowController.h"
#import "VVDocumenterSetting.h"
#import "VVTextResult.h"
@interface VVDocumenterManager()
@property (nonatomic, strong) id eventMonitor;
@property (nonatomic, assign) BOOL prefixTyped;
@property (nonatomic, strong) VVDSettingPanelWindowController *settingPanel;
@end
@implementation VVDocumenterManager
+(void)pluginDidLoad:(NSBundle *)plugin {
VVLog(@"VVDocumenter: Plugin loaded successfully");
[self shared];
}
+(instancetype) shared {
static dispatch_once_t once;
static id instance = nil;
dispatch_once(&once, ^{
instance = [[self alloc] init];
});
return instance;
}
- (instancetype)init {
if (self = [super init]) {
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(applicationDidFinishLaunching:)
name:NSApplicationDidFinishLaunchingNotification
object:nil];
}
return self;
}
- (void) applicationDidFinishLaunching: (NSNotification*) noti {
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(textStorageDidChange:)
name:NSTextDidChangeNotification
object:nil];
[self addSettingMenu];
}
-(void) addSettingMenu
{
NSMenuItem *editMenuItem = [[NSApp mainMenu] itemWithTitle:@"Window"];
if (editMenuItem) {
[[editMenuItem submenu] addItem:[NSMenuItem separatorItem]];
NSMenuItem *newMenuItem = [[NSMenuItem alloc] initWithTitle:@"VVDocumenter" action:@selector(showSettingPanel:) keyEquivalent:@""];
[newMenuItem setTarget:self];
[[editMenuItem submenu] addItem:newMenuItem];
}
}
-(void) showSettingPanel:(NSNotification *)noti {
self.settingPanel = [[VVDSettingPanelWindowController alloc] initWithWindowNibName:@"VVDSettingPanelWindowController"];
[self.settingPanel showWindow:self.settingPanel];
}
- (void) textStorageDidChange:(NSNotification *)noti {
if ([[noti object] isKindOfClass:[NSTextView class]]) {
NSTextView *textView = (NSTextView *)[noti object];
VVTextResult *currentLineResult = [textView vv_textResultOfCurrentLine];
if (currentLineResult) {
//Check if there is a "//" already typed in. We do this to solve the undo issue
//Otherwise when you press Cmd+Z, "///" will be recognized and trigger the doc inserting, so you can not perform an undo.
NSString *triggerString = [[VVDocumenterSetting defaultSetting] triggerString];
if (triggerString.length > 1) {
NSString *preTypeString = [triggerString substringToIndex:triggerString.length - 2];
self.prefixTyped = [currentLineResult.string vv_matchesPatternRegexPattern:[NSString stringWithFormat:@"^\\s*%@$",[NSRegularExpression escapedPatternForString:preTypeString]]] | self.prefixTyped;
} else {
self.prefixTyped = YES;
}
if ([currentLineResult.string vv_matchesPatternRegexPattern:[NSString stringWithFormat:@"^\\s*%@$",[NSRegularExpression escapedPatternForString:triggerString]]] && self.prefixTyped) {
VVTextResult *previousLineResult = [textView vv_textResultOfPreviousLine];
// Previous line is a documentation comment, so ignore this
if ([previousLineResult.string vv_matchesPatternRegexPattern:@"^\\s*///"]) {
return;
}
VVTextResult *nextLineResult = [textView vv_textResultOfNextLine];
// Next line is a documentation comment, so ignore this
if ([nextLineResult.string vv_matchesPatternRegexPattern:@"^\\s*///"]) {
return;
}
//Get a @"///" (triggerString) typed in by user. Do work!
self.prefixTyped = NO;
__block BOOL shouldReplace = NO;
//Decide which is closer to the cursor. A semicolon or a half brace.
//We just want to document the next valid line.
VVTextResult *resultUntilSemiColon = [textView vv_textResultUntilNextString:@";"];
VVTextResult *resultUntilBrace = [textView vv_textResultUntilNextString:@"{"];
VVTextResult *resultUntilFileEnd = [textView vv_textResultToEndOfFile];
VVTextResult *resultToDocument = nil;
if (resultUntilSemiColon && resultUntilBrace) {
resultToDocument = (resultUntilSemiColon.range.length < resultUntilBrace.range.length) ? resultUntilSemiColon : resultUntilBrace;
} else if (resultUntilBrace) {
resultToDocument = resultUntilBrace;
} else if (resultUntilSemiColon) {
resultToDocument = resultUntilSemiColon;
} else {
resultToDocument = resultUntilFileEnd;
}
//We always write document until semicolon for enum. (Maybe struct later)
if ([resultToDocument.string vv_isEnum]) {
resultToDocument = resultUntilSemiColon;
shouldReplace = YES;
}
NSString *inputCode = nil;
if ([resultToDocument.string vv_isSwiftEnum]) {
inputCode = [textView vv_textResultWithPairOpenString:@"{" closeString:@"}"].string;
} else {
inputCode = [resultToDocument.string vv_stringByConvertingToUniform];
}
VVDocumenter *doc = [[VVDocumenter alloc] initWithCode:inputCode];
NSString *documentationString = [doc document];
if (!documentationString) {
//Leave the user's input there.
//It might be no need to parse doc or something wrong.
return;
}
//Now we are using a simulation of keyboard event to insert the docs, instead of using the IDE's private method.
//See more at https://github.com/onevcat/VVDocumenter-Xcode/issues/3
//Save current content in paste board
NSPasteboard *pasteBoard = [NSPasteboard generalPasteboard];
NSString *originPBString = [pasteBoard stringForType:NSPasteboardTypeString];
//Set the doc comments in it
[pasteBoard declareTypes:[NSArray arrayWithObject:NSStringPboardType] owner:nil];
[pasteBoard setString:documentationString forType:NSStringPboardType];
//Begin to simulate keyborad pressing
VVKeyboardEventSender *kes = [[VVKeyboardEventSender alloc] init];
[kes beginKeyBoradEvents];
//Cmd+delete Delete current line
[kes sendKeyCode:kVK_Delete withModifierCommand:YES alt:NO shift:NO control:NO];
//if (shouldReplace) [textView setSelectedRange:resultToDocument.range];
//Cmd+V, paste (which key to actually use is based on the current keyboard layout)
NSInteger kKeyVCode = [[VVDocumenterSetting defaultSetting] keyVCode];
[kes sendKeyCode:kKeyVCode withModifierCommand:YES alt:NO shift:NO control:NO];
//The key down is just a defined finish signal by me. When we receive this key, we know operation above is finished.
[kes sendKeyCode:kVK_F20];
self.eventMonitor = [NSEvent addLocalMonitorForEventsMatchingMask:NSKeyDownMask handler:^NSEvent *(NSEvent *incomingEvent) {
if ([incomingEvent type] == NSKeyDown && [incomingEvent keyCode] == kVK_F20) {
//Finish signal arrived, no need to observe the event
[NSEvent removeMonitor:self.eventMonitor];
self.eventMonitor = nil;
//Restore previois patse board content
[pasteBoard setString:originPBString forType:NSStringPboardType];
//Set cursor before the inserted documentation. So we can use tab to begin edit.
int baseIndentationLength = (int)[doc baseIndentation].length;
[textView setSelectedRange:NSMakeRange(currentLineResult.range.location + baseIndentationLength, 0)];
//Send a 'tab' after insert the doc. For our lazy programmers. :)
[kes sendKeyCode:kVK_Tab];
[kes endKeyBoradEvents];
shouldReplace = NO;
//Invalidate the finish signal, in case you set it to do some other thing.
return nil;
} else if ([incomingEvent type] == NSKeyDown && [incomingEvent keyCode] == kKeyVCode && shouldReplace == YES) {
//Select input line and the define code block.
NSRange r = [textView vv_textResultUntilNextString:@";"].range;
//NSRange r begins from the starting of enum(struct) line. Select 1 character before to include the trigger input line.
[textView setSelectedRange:NSMakeRange(r.location - 1, r.length + 1)];
return incomingEvent;
} else {
return incomingEvent;
}
}];
}
}
}
}
@end
You can’t perform that action at this time.