Skip to content
This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Swift Class Comment Support#229

Open
tonyli508 wants to merge 4 commits into
base:master
Choose a base branch
from
Open

Swift Class Comment Support #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ea2d80
Add comment support for Swift Class
tonyli508 Jun 17, 2016
8d72ac8
Disable inheritance info for swift class, add comments
tonyli508 Jun 17, 2016
3e905b1
Change back NSPredicate predicateWithBlock default parameter
tonyli508 Jun 17, 2016
6696b84
Remove NSPredicate from VVSwiftClassCommenter
tonyli508 Jun 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions VVDocumenter-Xcode.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@
objects = {

/* Begin PBXBuildFile section */
1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
4B06DF741B315E9D007D69BE /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
4B50A2701B315CF3008A4400 /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
53C67935184501030030C553 /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 893D8F7F18262EF500E8A00C /* Carbon.framework */; };
Expand DownExpand Up@@ -73,6 +75,8 @@
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftClassCommenter.h; sourceTree = "<group>"; };
1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftClassCommenter.m; sourceTree = "<group>"; };
4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftExtensionCommenter.h; sourceTree = "<group>"; };
4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftExtensionCommenter.m; sourceTree = "<group>"; };
893D8F7F18262EF500E8A00C /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
Expand DownExpand Up@@ -309,6 +313,8 @@
D16AFCE81796E0D6006719AA /* VVVariableCommenter.m */,
4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */,
4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */,
1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */,
1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */,
);
path = Commenter;
sourceTree = "<group>";
Expand DownExpand Up@@ -517,6 +523,7 @@
D124614717AC16820095F9D6 /* VVDocumenterSetting.m in Sources */,
C4052CFB1B3BB10700ED0CF0 /* VVWorkspaceManager.m in Sources */,
D124614817AC16820095F9D6 /* VVDSettingPanelWindowController.m in Sources */,
1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand All@@ -537,6 +544,7 @@
D1A6B1D1198A0D8600BCED83 /* VVSwiftPropertyCommenter.m in Sources */,
D14110B51988C12F00A7083F /* NSTextView+VVTextGetter.m in Sources */,
D14110B61988C12F00A7083F /* VVDocumenterManager.m in Sources */,
10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */,
D14110B71988C12F00A7083F /* VVDocumenter.m in Sources */,
D14110A81988C12000A7083F /* VVArgument.m in Sources */,
D1C6124919891B3700FDB554 /* VVSwiftEnumCommenter.m in Sources */,
Expand Down
1 change: 1 addition & 0 deletions VVDocumenter-Xcode/Commenter/VVCommenter.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,5 +40,6 @@
#import "VVSwiftEnumCommenter.h"
#import "VVSwiftPropertyCommenter.h"
#import "VVSwiftExtensionCommenter.h"
#import "VVSwiftClassCommenter.h"

#endif
13 changes: 13 additions & 0 deletions VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
//
// VVSwiftClassCommenter.h
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVCommenter.h"

@interface VVSwiftClassCommenter : VVBaseCommenter

@end
85 changes: 85 additions & 0 deletions VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.m
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
//
// VVSwiftClassCommenter.m
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVSwiftClassCommenter.h"
#import "NSString+VVTextGetter.h"
#import "VVTextResult.h"
#import "VVArgument.h"

@interface VVSwiftClassCommenter()

@property (nonatomic, strong) NSString *className;
@property (nonatomic, strong) NSArray *inheritances;

@end

@implementation VVSwiftClassCommenter

/**
* Capture class name from extracted regex groups
*
* @param groups regex groups
*/
-(void) captureClassNameFrom:(NSArray *)groups
{
self.className = [groups objectAtIndex:1];
// if there are additional annotations like `public`, `private`, `final`
if ([groups count] > 3) {
self.className = [groups objectAtIndex:2];
}
}

/**
* Capture inheritances from extracted regex groups
*
* @param groups regex groups
*/
-(void) captureInheritancesFrom:(NSArray *)groups {

NSMutableArray *nonEmptyStrings = [NSMutableArray new];
NSArray *potentialInheritances = [[groups lastObject] componentsSeparatedByString:@","];

for(NSString *string in potentialInheritances) {
NSString *strippedString = [string stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
if (strippedString.length > 0) {
[nonEmptyStrings addObject:strippedString];
}
}

self.inheritances = [NSArray arrayWithArray:nonEmptyStrings];
}

/**
* Append inheritance info string to comment string
*
* @param string comment string want to append to
*/
-(void) appendInheritanceStringTo:(NSMutableString *)string {
if ([self.inheritances count] > 0) {
[string appendString:@"inherits from or conforms to:\n"];
for (NSString *inheritance in self.inheritances) {
[string appendFormat:@"%@: <#Description#>\n", [inheritance stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
}
}
}

// override super document function to change default comment behavior
-(NSString *) document
{
NSArray *groups = [self.code vv_stringsByExtractingGroupsUsingRegexPattern:@"^\\s*((.*\\s)?class\\s+)([^:]+):?(.*)\\{"];

[self captureClassNameFrom:groups];

NSMutableString *commentString = [NSMutableString new];
[commentString appendFormat:@"/**\n%@@class %@\n\n@abstract <#Description#>\n", self.indent, self.className];
[commentString appendFormat:@"\n %@*/", self.indent];

return commentString;
}

@end
11 changes: 8 additions & 3 deletions VVDocumenter-Xcode/OCCategory/NSString+PDRegex/NSString+PDRegex.m
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,14 @@ -(NSArray *) vv_stringsByExtractingGroupsUsingRegexPattern:(NSString *)regex cas
__block NSMutableArray *retVal = [NSMutableArray array];
[pattern enumerateMatchesInString:self options:0 range:NSMakeRange(0, [self length]) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
//Note, we only want to return the things in parens, so we're skipping index 0 intentionally
for (int i=1; i<[result numberOfRanges]; i++) {
NSString *matchedString=[self substringWithRange:[result rangeAtIndex:i]];
[retVal addObject:matchedString];
if ([result numberOfRanges] > 1) {
for (int i=1; i<[result numberOfRanges]; i++) {
NSRange range = [result rangeAtIndex:i];
if (range.location != NSNotFound) {
NSString *matchedString=[self substringWithRange:range];
[retVal addObject:matchedString];
}
}
}
}];
return retVal;
Expand Down
1 change: 1 addition & 0 deletions VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
-(BOOL) vv_isStruct;
-(BOOL) vv_isUnion;
-(BOOL) vv_isComplieKeyword;
-(BOOL) vv_isSwiftClass;
-(BOOL) vv_isSwiftFunction;
-(BOOL) vv_isSwiftEnum;
-(BOOL) vv_isSwiftProperty;
Expand Down
9 changes: 7 additions & 2 deletions VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.m
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,15 +92,20 @@ -(BOOL) vv_isSwiftFunction
return ![self vv_isObjCMethod] && ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(func\\s+)|(init|deinit|subscript)"];
}

-(BOOL) vv_isSwiftClass
{
return ![self vv_isSwiftFunction] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"];
}

-(BOOL) vv_isSwiftEnum
{
return ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?enum\\s+"];
}

-(BOOL) vv_isSwiftProperty
{
// Opt out the situation of `class func`
if ([self vv_matchesPatternRegexPattern:@"class func"]) {
// Opt out the situation of `class func` and `class`
if ([self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"]) {
return NO;
}

Expand Down
2 changes: 2 additions & 0 deletions VVDocumenter-Xcode/VVDocumenter.m
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,6 +90,8 @@ -(NSString *) document
commenter = [[VVStructCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
} else if ([trimCode vv_isObjCMethod]) {
commenter = [[VVMethodCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
} else if ([trimCode vv_isSwiftClass]) {
commenter = [[VVSwiftClassCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
} else if ([trimCode vv_isSwiftFunction]) {
commenter = [[VVSwiftFunctionCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
} else if ([trimCode vv_isSwiftProperty]) {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Swift Class Comment Support by tonyli508 · Pull Request #229 · onevcat/VVDocumenter-Xcode · GitHub
Skip to content

This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Swift Class Comment Support#229
 Open

tonyli508
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


Swift Class Comment Support
#229
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2ea2d80

Add comment support for Swift Class


tonyli508 Jun 17, 2016
8d72ac8

Disable inheritance info for swift class, add comments


tonyli508 Jun 17, 2016
3e905b1

Change back NSPredicate predicateWithBlock default parameter


tonyli508 Jun 17, 2016
6696b84

Remove NSPredicate from VVSwiftClassCommenter


tonyli508 Jun 17, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
VVDocumenter-Xcode.xcodeproj/project.pbxproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@
	objects = {

/* Begin PBXBuildFile section */
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 4B06DF741B315E9D007D69BE /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 4B50A2701B315CF3008A4400 /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 53C67935184501030030C553 /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 893D8F7F18262EF500E8A00C /* Carbon.framework */; };
Expand DownExpand Up@@ -73,6 +75,8 @@
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftClassCommenter.h; sourceTree = "<group>"; };
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftClassCommenter.m; sourceTree = "<group>"; };
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftExtensionCommenter.h; sourceTree = "<group>"; };
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftExtensionCommenter.m; sourceTree = "<group>"; };
 893D8F7F18262EF500E8A00C /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
Expand DownExpand Up@@ -309,6 +313,8 @@
 D16AFCE81796E0D6006719AA /* VVVariableCommenter.m */,
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */,
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */,
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */,
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */,
 );
 path = Commenter;
 sourceTree = "<group>";
Expand DownExpand Up@@ -517,6 +523,7 @@
 D124614717AC16820095F9D6 /* VVDocumenterSetting.m in Sources */,
 C4052CFB1B3BB10700ED0CF0 /* VVWorkspaceManager.m in Sources */,
 D124614817AC16820095F9D6 /* VVDSettingPanelWindowController.m in Sources */,
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */,
 );
 runOnlyForDeploymentPostprocessing = 0;
 };
Expand All@@ -537,6 +544,7 @@
 D1A6B1D1198A0D8600BCED83 /* VVSwiftPropertyCommenter.m in Sources */,
 D14110B51988C12F00A7083F /* NSTextView+VVTextGetter.m in Sources */,
 D14110B61988C12F00A7083F /* VVDocumenterManager.m in Sources */,
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */,
 D14110B71988C12F00A7083F /* VVDocumenter.m in Sources */,
 D14110A81988C12000A7083F /* VVArgument.m in Sources */,
 D1C6124919891B3700FDB554 /* VVSwiftEnumCommenter.m in Sources */,
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/Commenter/VVCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,5 +40,6 @@
#import "VVSwiftEnumCommenter.h"
#import "VVSwiftPropertyCommenter.h"
#import "VVSwiftExtensionCommenter.h"
#import "VVSwiftClassCommenter.h"

#endif

13 changes: 13 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
//
// VVSwiftClassCommenter.h
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVCommenter.h"

@interface VVSwiftClassCommenter : VVBaseCommenter

@end

85 changes: 85 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
//
// VVSwiftClassCommenter.m
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVSwiftClassCommenter.h"
#import "NSString+VVTextGetter.h"
#import "VVTextResult.h"
#import "VVArgument.h"

@interface VVSwiftClassCommenter()

@property (nonatomic, strong) NSString *className;
@property (nonatomic, strong) NSArray *inheritances;

@end

@implementation VVSwiftClassCommenter

/**
 * Capture class name from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureClassNameFrom:(NSArray *)groups
{
 self.className = [groups objectAtIndex:1];
 // if there are additional annotations like `public`, `private`, `final`
 if ([groups count] > 3) {
 self.className = [groups objectAtIndex:2];
 }
}

/**
 * Capture inheritances from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureInheritancesFrom:(NSArray *)groups {

 NSMutableArray *nonEmptyStrings = [NSMutableArray new];
 NSArray *potentialInheritances = [[groups lastObject] componentsSeparatedByString:@","];

 for(NSString *string in potentialInheritances) {
 NSString *strippedString = [string stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 if (strippedString.length > 0) {
 [nonEmptyStrings addObject:strippedString];
 }
 }

 self.inheritances = [NSArray arrayWithArray:nonEmptyStrings];
}

/**
 * Append inheritance info string to comment string
 *
 * @param string comment string want to append to
 */
-(void) appendInheritanceStringTo:(NSMutableString *)string {
 if ([self.inheritances count] > 0) {
 [string appendString:@"inherits from or conforms to:\n"];
 for (NSString *inheritance in self.inheritances) {
 [string appendFormat:@"%@: <#Description#>\n", [inheritance stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
 }
 }
}

// override super document function to change default comment behavior
-(NSString *) document
{
 NSArray *groups = [self.code vv_stringsByExtractingGroupsUsingRegexPattern:@"^\\s*((.*\\s)?class\\s+)([^:]+):?(.*)\\{"];

 [self captureClassNameFrom:groups];

 NSMutableString *commentString = [NSMutableString new];
 [commentString appendFormat:@"/**\n%@@class %@\n\n@abstract <#Description#>\n", self.indent, self.className];
 [commentString appendFormat:@"\n %@*/", self.indent];

 return commentString;
}

@end

11 changes: 8 additions & 3 deletions
VVDocumenter-Xcode/OCCategory/NSString+PDRegex/NSString+PDRegex.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,14 @@ -(NSArray *) vv_stringsByExtractingGroupsUsingRegexPattern:(NSString *)regex cas
 __block NSMutableArray *retVal = [NSMutableArray array];
 [pattern enumerateMatchesInString:self options:0 range:NSMakeRange(0, [self length]) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
 //Note, we only want to return the things in parens, so we're skipping index 0 intentionally
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSString *matchedString=[self substringWithRange:[result rangeAtIndex:i]];
 [retVal addObject:matchedString];
 if ([result numberOfRanges] > 1) {
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSRange range = [result rangeAtIndex:i];
 if (range.location != NSNotFound) {
 NSString *matchedString=[self substringWithRange:range];
 [retVal addObject:matchedString];
 }
 }
 }
 }];
 return retVal;
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
-(BOOL) vv_isStruct;
-(BOOL) vv_isUnion;
-(BOOL) vv_isComplieKeyword;
-(BOOL) vv_isSwiftClass;
-(BOOL) vv_isSwiftFunction;
-(BOOL) vv_isSwiftEnum;
-(BOOL) vv_isSwiftProperty;
Expand Down

9 changes: 7 additions & 2 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,15 +92,20 @@ -(BOOL) vv_isSwiftFunction
 return ![self vv_isObjCMethod] && ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(func\\s+)|(init|deinit|subscript)"];
}

-(BOOL) vv_isSwiftClass
{
 return ![self vv_isSwiftFunction] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"];
}

-(BOOL) vv_isSwiftEnum
{
 return ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?enum\\s+"];
}

-(BOOL) vv_isSwiftProperty
{
 // Opt out the situation of `class func`
 if ([self vv_matchesPatternRegexPattern:@"class func"]) {
 // Opt out the situation of `class func` and `class`
 if ([self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"]) {
 return NO;
 }

Expand Down

2 changes: 2 additions & 0 deletions
VVDocumenter-Xcode/VVDocumenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -90,6 +90,8 @@ -(NSString *) document
 commenter = [[VVStructCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isObjCMethod]) {
 commenter = [[VVMethodCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftClass]) {
 commenter = [[VVSwiftClassCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftFunction]) {
 commenter = [[VVSwiftFunctionCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftProperty]) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Swift Class Comment Support by tonyli508 · Pull Request #229 · onevcat/VVDocumenter-Xcode · GitHub
Skip to content

This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Swift Class Comment Support#229
 Open

tonyli508
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


Swift Class Comment Support
#229
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2ea2d80

Add comment support for Swift Class


tonyli508 Jun 17, 2016
8d72ac8

Disable inheritance info for swift class, add comments


tonyli508 Jun 17, 2016
3e905b1

Change back NSPredicate predicateWithBlock default parameter


tonyli508 Jun 17, 2016
6696b84

Remove NSPredicate from VVSwiftClassCommenter


tonyli508 Jun 17, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
VVDocumenter-Xcode.xcodeproj/project.pbxproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@
	objects = {

/* Begin PBXBuildFile section */
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 4B06DF741B315E9D007D69BE /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 4B50A2701B315CF3008A4400 /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 53C67935184501030030C553 /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 893D8F7F18262EF500E8A00C /* Carbon.framework */; };
Expand DownExpand Up@@ -73,6 +75,8 @@
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftClassCommenter.h; sourceTree = "<group>"; };
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftClassCommenter.m; sourceTree = "<group>"; };
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftExtensionCommenter.h; sourceTree = "<group>"; };
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftExtensionCommenter.m; sourceTree = "<group>"; };
 893D8F7F18262EF500E8A00C /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
Expand DownExpand Up@@ -309,6 +313,8 @@
 D16AFCE81796E0D6006719AA /* VVVariableCommenter.m */,
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */,
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */,
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */,
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */,
 );
 path = Commenter;
 sourceTree = "<group>";
Expand DownExpand Up@@ -517,6 +523,7 @@
 D124614717AC16820095F9D6 /* VVDocumenterSetting.m in Sources */,
 C4052CFB1B3BB10700ED0CF0 /* VVWorkspaceManager.m in Sources */,
 D124614817AC16820095F9D6 /* VVDSettingPanelWindowController.m in Sources */,
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */,
 );
 runOnlyForDeploymentPostprocessing = 0;
 };
Expand All@@ -537,6 +544,7 @@
 D1A6B1D1198A0D8600BCED83 /* VVSwiftPropertyCommenter.m in Sources */,
 D14110B51988C12F00A7083F /* NSTextView+VVTextGetter.m in Sources */,
 D14110B61988C12F00A7083F /* VVDocumenterManager.m in Sources */,
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */,
 D14110B71988C12F00A7083F /* VVDocumenter.m in Sources */,
 D14110A81988C12000A7083F /* VVArgument.m in Sources */,
 D1C6124919891B3700FDB554 /* VVSwiftEnumCommenter.m in Sources */,
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/Commenter/VVCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,5 +40,6 @@
#import "VVSwiftEnumCommenter.h"
#import "VVSwiftPropertyCommenter.h"
#import "VVSwiftExtensionCommenter.h"
#import "VVSwiftClassCommenter.h"

#endif

13 changes: 13 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
//
// VVSwiftClassCommenter.h
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVCommenter.h"

@interface VVSwiftClassCommenter : VVBaseCommenter

@end

85 changes: 85 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
//
// VVSwiftClassCommenter.m
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVSwiftClassCommenter.h"
#import "NSString+VVTextGetter.h"
#import "VVTextResult.h"
#import "VVArgument.h"

@interface VVSwiftClassCommenter()

@property (nonatomic, strong) NSString *className;
@property (nonatomic, strong) NSArray *inheritances;

@end

@implementation VVSwiftClassCommenter

/**
 * Capture class name from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureClassNameFrom:(NSArray *)groups
{
 self.className = [groups objectAtIndex:1];
 // if there are additional annotations like `public`, `private`, `final`
 if ([groups count] > 3) {
 self.className = [groups objectAtIndex:2];
 }
}

/**
 * Capture inheritances from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureInheritancesFrom:(NSArray *)groups {

 NSMutableArray *nonEmptyStrings = [NSMutableArray new];
 NSArray *potentialInheritances = [[groups lastObject] componentsSeparatedByString:@","];

 for(NSString *string in potentialInheritances) {
 NSString *strippedString = [string stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 if (strippedString.length > 0) {
 [nonEmptyStrings addObject:strippedString];
 }
 }

 self.inheritances = [NSArray arrayWithArray:nonEmptyStrings];
}

/**
 * Append inheritance info string to comment string
 *
 * @param string comment string want to append to
 */
-(void) appendInheritanceStringTo:(NSMutableString *)string {
 if ([self.inheritances count] > 0) {
 [string appendString:@"inherits from or conforms to:\n"];
 for (NSString *inheritance in self.inheritances) {
 [string appendFormat:@"%@: <#Description#>\n", [inheritance stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
 }
 }
}

// override super document function to change default comment behavior
-(NSString *) document
{
 NSArray *groups = [self.code vv_stringsByExtractingGroupsUsingRegexPattern:@"^\\s*((.*\\s)?class\\s+)([^:]+):?(.*)\\{"];

 [self captureClassNameFrom:groups];

 NSMutableString *commentString = [NSMutableString new];
 [commentString appendFormat:@"/**\n%@@class %@\n\n@abstract <#Description#>\n", self.indent, self.className];
 [commentString appendFormat:@"\n %@*/", self.indent];

 return commentString;
}

@end

11 changes: 8 additions & 3 deletions
VVDocumenter-Xcode/OCCategory/NSString+PDRegex/NSString+PDRegex.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,14 @@ -(NSArray *) vv_stringsByExtractingGroupsUsingRegexPattern:(NSString *)regex cas
 __block NSMutableArray *retVal = [NSMutableArray array];
 [pattern enumerateMatchesInString:self options:0 range:NSMakeRange(0, [self length]) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
 //Note, we only want to return the things in parens, so we're skipping index 0 intentionally
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSString *matchedString=[self substringWithRange:[result rangeAtIndex:i]];
 [retVal addObject:matchedString];
 if ([result numberOfRanges] > 1) {
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSRange range = [result rangeAtIndex:i];
 if (range.location != NSNotFound) {
 NSString *matchedString=[self substringWithRange:range];
 [retVal addObject:matchedString];
 }
 }
 }
 }];
 return retVal;
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
-(BOOL) vv_isStruct;
-(BOOL) vv_isUnion;
-(BOOL) vv_isComplieKeyword;
-(BOOL) vv_isSwiftClass;
-(BOOL) vv_isSwiftFunction;
-(BOOL) vv_isSwiftEnum;
-(BOOL) vv_isSwiftProperty;
Expand Down

9 changes: 7 additions & 2 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,15 +92,20 @@ -(BOOL) vv_isSwiftFunction
 return ![self vv_isObjCMethod] && ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(func\\s+)|(init|deinit|subscript)"];
}

-(BOOL) vv_isSwiftClass
{
 return ![self vv_isSwiftFunction] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"];
}

-(BOOL) vv_isSwiftEnum
{
 return ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?enum\\s+"];
}

-(BOOL) vv_isSwiftProperty
{
 // Opt out the situation of `class func`
 if ([self vv_matchesPatternRegexPattern:@"class func"]) {
 // Opt out the situation of `class func` and `class`
 if ([self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"]) {
 return NO;
 }

Expand Down

2 changes: 2 additions & 0 deletions
VVDocumenter-Xcode/VVDocumenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -90,6 +90,8 @@ -(NSString *) document
 commenter = [[VVStructCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isObjCMethod]) {
 commenter = [[VVMethodCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftClass]) {
 commenter = [[VVSwiftClassCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftFunction]) {
 commenter = [[VVSwiftFunctionCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftProperty]) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Swift Class Comment Support by tonyli508 · Pull Request #229 · onevcat/VVDocumenter-Xcode · GitHub
Skip to content

This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Swift Class Comment Support#229
 Open

tonyli508
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


Swift Class Comment Support
#229
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2ea2d80

Add comment support for Swift Class


tonyli508 Jun 17, 2016
8d72ac8

Disable inheritance info for swift class, add comments


tonyli508 Jun 17, 2016
3e905b1

Change back NSPredicate predicateWithBlock default parameter


tonyli508 Jun 17, 2016
6696b84

Remove NSPredicate from VVSwiftClassCommenter


tonyli508 Jun 17, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
VVDocumenter-Xcode.xcodeproj/project.pbxproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@
	objects = {

/* Begin PBXBuildFile section */
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 4B06DF741B315E9D007D69BE /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 4B50A2701B315CF3008A4400 /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 53C67935184501030030C553 /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 893D8F7F18262EF500E8A00C /* Carbon.framework */; };
Expand DownExpand Up@@ -73,6 +75,8 @@
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftClassCommenter.h; sourceTree = "<group>"; };
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftClassCommenter.m; sourceTree = "<group>"; };
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftExtensionCommenter.h; sourceTree = "<group>"; };
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftExtensionCommenter.m; sourceTree = "<group>"; };
 893D8F7F18262EF500E8A00C /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
Expand DownExpand Up@@ -309,6 +313,8 @@
 D16AFCE81796E0D6006719AA /* VVVariableCommenter.m */,
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */,
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */,
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */,
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */,
 );
 path = Commenter;
 sourceTree = "<group>";
Expand DownExpand Up@@ -517,6 +523,7 @@
 D124614717AC16820095F9D6 /* VVDocumenterSetting.m in Sources */,
 C4052CFB1B3BB10700ED0CF0 /* VVWorkspaceManager.m in Sources */,
 D124614817AC16820095F9D6 /* VVDSettingPanelWindowController.m in Sources */,
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */,
 );
 runOnlyForDeploymentPostprocessing = 0;
 };
Expand All@@ -537,6 +544,7 @@
 D1A6B1D1198A0D8600BCED83 /* VVSwiftPropertyCommenter.m in Sources */,
 D14110B51988C12F00A7083F /* NSTextView+VVTextGetter.m in Sources */,
 D14110B61988C12F00A7083F /* VVDocumenterManager.m in Sources */,
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */,
 D14110B71988C12F00A7083F /* VVDocumenter.m in Sources */,
 D14110A81988C12000A7083F /* VVArgument.m in Sources */,
 D1C6124919891B3700FDB554 /* VVSwiftEnumCommenter.m in Sources */,
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/Commenter/VVCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,5 +40,6 @@
#import "VVSwiftEnumCommenter.h"
#import "VVSwiftPropertyCommenter.h"
#import "VVSwiftExtensionCommenter.h"
#import "VVSwiftClassCommenter.h"

#endif

13 changes: 13 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
//
// VVSwiftClassCommenter.h
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVCommenter.h"

@interface VVSwiftClassCommenter : VVBaseCommenter

@end

85 changes: 85 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
//
// VVSwiftClassCommenter.m
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVSwiftClassCommenter.h"
#import "NSString+VVTextGetter.h"
#import "VVTextResult.h"
#import "VVArgument.h"

@interface VVSwiftClassCommenter()

@property (nonatomic, strong) NSString *className;
@property (nonatomic, strong) NSArray *inheritances;

@end

@implementation VVSwiftClassCommenter

/**
 * Capture class name from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureClassNameFrom:(NSArray *)groups
{
 self.className = [groups objectAtIndex:1];
 // if there are additional annotations like `public`, `private`, `final`
 if ([groups count] > 3) {
 self.className = [groups objectAtIndex:2];
 }
}

/**
 * Capture inheritances from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureInheritancesFrom:(NSArray *)groups {

 NSMutableArray *nonEmptyStrings = [NSMutableArray new];
 NSArray *potentialInheritances = [[groups lastObject] componentsSeparatedByString:@","];

 for(NSString *string in potentialInheritances) {
 NSString *strippedString = [string stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 if (strippedString.length > 0) {
 [nonEmptyStrings addObject:strippedString];
 }
 }

 self.inheritances = [NSArray arrayWithArray:nonEmptyStrings];
}

/**
 * Append inheritance info string to comment string
 *
 * @param string comment string want to append to
 */
-(void) appendInheritanceStringTo:(NSMutableString *)string {
 if ([self.inheritances count] > 0) {
 [string appendString:@"inherits from or conforms to:\n"];
 for (NSString *inheritance in self.inheritances) {
 [string appendFormat:@"%@: <#Description#>\n", [inheritance stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
 }
 }
}

// override super document function to change default comment behavior
-(NSString *) document
{
 NSArray *groups = [self.code vv_stringsByExtractingGroupsUsingRegexPattern:@"^\\s*((.*\\s)?class\\s+)([^:]+):?(.*)\\{"];

 [self captureClassNameFrom:groups];

 NSMutableString *commentString = [NSMutableString new];
 [commentString appendFormat:@"/**\n%@@class %@\n\n@abstract <#Description#>\n", self.indent, self.className];
 [commentString appendFormat:@"\n %@*/", self.indent];

 return commentString;
}

@end

11 changes: 8 additions & 3 deletions
VVDocumenter-Xcode/OCCategory/NSString+PDRegex/NSString+PDRegex.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,14 @@ -(NSArray *) vv_stringsByExtractingGroupsUsingRegexPattern:(NSString *)regex cas
 __block NSMutableArray *retVal = [NSMutableArray array];
 [pattern enumerateMatchesInString:self options:0 range:NSMakeRange(0, [self length]) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
 //Note, we only want to return the things in parens, so we're skipping index 0 intentionally
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSString *matchedString=[self substringWithRange:[result rangeAtIndex:i]];
 [retVal addObject:matchedString];
 if ([result numberOfRanges] > 1) {
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSRange range = [result rangeAtIndex:i];
 if (range.location != NSNotFound) {
 NSString *matchedString=[self substringWithRange:range];
 [retVal addObject:matchedString];
 }
 }
 }
 }];
 return retVal;
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
-(BOOL) vv_isStruct;
-(BOOL) vv_isUnion;
-(BOOL) vv_isComplieKeyword;
-(BOOL) vv_isSwiftClass;
-(BOOL) vv_isSwiftFunction;
-(BOOL) vv_isSwiftEnum;
-(BOOL) vv_isSwiftProperty;
Expand Down

9 changes: 7 additions & 2 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,15 +92,20 @@ -(BOOL) vv_isSwiftFunction
 return ![self vv_isObjCMethod] && ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(func\\s+)|(init|deinit|subscript)"];
}

-(BOOL) vv_isSwiftClass
{
 return ![self vv_isSwiftFunction] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"];
}

-(BOOL) vv_isSwiftEnum
{
 return ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?enum\\s+"];
}

-(BOOL) vv_isSwiftProperty
{
 // Opt out the situation of `class func`
 if ([self vv_matchesPatternRegexPattern:@"class func"]) {
 // Opt out the situation of `class func` and `class`
 if ([self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"]) {
 return NO;
 }

Expand Down

2 changes: 2 additions & 0 deletions
VVDocumenter-Xcode/VVDocumenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -90,6 +90,8 @@ -(NSString *) document
 commenter = [[VVStructCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isObjCMethod]) {
 commenter = [[VVMethodCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftClass]) {
 commenter = [[VVSwiftClassCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftFunction]) {
 commenter = [[VVSwiftFunctionCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftProperty]) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Swift Class Comment Support by tonyli508 · Pull Request #229 · onevcat/VVDocumenter-Xcode · GitHub
Skip to content

This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Swift Class Comment Support#229
 Open

tonyli508
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


Swift Class Comment Support
#229
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2ea2d80

Add comment support for Swift Class


tonyli508 Jun 17, 2016
8d72ac8

Disable inheritance info for swift class, add comments


tonyli508 Jun 17, 2016
3e905b1

Change back NSPredicate predicateWithBlock default parameter


tonyli508 Jun 17, 2016
6696b84

Remove NSPredicate from VVSwiftClassCommenter


tonyli508 Jun 17, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
VVDocumenter-Xcode.xcodeproj/project.pbxproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@
	objects = {

/* Begin PBXBuildFile section */
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 4B06DF741B315E9D007D69BE /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 4B50A2701B315CF3008A4400 /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 53C67935184501030030C553 /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 893D8F7F18262EF500E8A00C /* Carbon.framework */; };
Expand DownExpand Up@@ -73,6 +75,8 @@
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftClassCommenter.h; sourceTree = "<group>"; };
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftClassCommenter.m; sourceTree = "<group>"; };
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftExtensionCommenter.h; sourceTree = "<group>"; };
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftExtensionCommenter.m; sourceTree = "<group>"; };
 893D8F7F18262EF500E8A00C /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
Expand DownExpand Up@@ -309,6 +313,8 @@
 D16AFCE81796E0D6006719AA /* VVVariableCommenter.m */,
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */,
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */,
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */,
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */,
 );
 path = Commenter;
 sourceTree = "<group>";
Expand DownExpand Up@@ -517,6 +523,7 @@
 D124614717AC16820095F9D6 /* VVDocumenterSetting.m in Sources */,
 C4052CFB1B3BB10700ED0CF0 /* VVWorkspaceManager.m in Sources */,
 D124614817AC16820095F9D6 /* VVDSettingPanelWindowController.m in Sources */,
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */,
 );
 runOnlyForDeploymentPostprocessing = 0;
 };
Expand All@@ -537,6 +544,7 @@
 D1A6B1D1198A0D8600BCED83 /* VVSwiftPropertyCommenter.m in Sources */,
 D14110B51988C12F00A7083F /* NSTextView+VVTextGetter.m in Sources */,
 D14110B61988C12F00A7083F /* VVDocumenterManager.m in Sources */,
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */,
 D14110B71988C12F00A7083F /* VVDocumenter.m in Sources */,
 D14110A81988C12000A7083F /* VVArgument.m in Sources */,
 D1C6124919891B3700FDB554 /* VVSwiftEnumCommenter.m in Sources */,
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/Commenter/VVCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,5 +40,6 @@
#import "VVSwiftEnumCommenter.h"
#import "VVSwiftPropertyCommenter.h"
#import "VVSwiftExtensionCommenter.h"
#import "VVSwiftClassCommenter.h"

#endif

13 changes: 13 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
//
// VVSwiftClassCommenter.h
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVCommenter.h"

@interface VVSwiftClassCommenter : VVBaseCommenter

@end

85 changes: 85 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
//
// VVSwiftClassCommenter.m
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVSwiftClassCommenter.h"
#import "NSString+VVTextGetter.h"
#import "VVTextResult.h"
#import "VVArgument.h"

@interface VVSwiftClassCommenter()

@property (nonatomic, strong) NSString *className;
@property (nonatomic, strong) NSArray *inheritances;

@end

@implementation VVSwiftClassCommenter

/**
 * Capture class name from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureClassNameFrom:(NSArray *)groups
{
 self.className = [groups objectAtIndex:1];
 // if there are additional annotations like `public`, `private`, `final`
 if ([groups count] > 3) {
 self.className = [groups objectAtIndex:2];
 }
}

/**
 * Capture inheritances from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureInheritancesFrom:(NSArray *)groups {

 NSMutableArray *nonEmptyStrings = [NSMutableArray new];
 NSArray *potentialInheritances = [[groups lastObject] componentsSeparatedByString:@","];

 for(NSString *string in potentialInheritances) {
 NSString *strippedString = [string stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 if (strippedString.length > 0) {
 [nonEmptyStrings addObject:strippedString];
 }
 }

 self.inheritances = [NSArray arrayWithArray:nonEmptyStrings];
}

/**
 * Append inheritance info string to comment string
 *
 * @param string comment string want to append to
 */
-(void) appendInheritanceStringTo:(NSMutableString *)string {
 if ([self.inheritances count] > 0) {
 [string appendString:@"inherits from or conforms to:\n"];
 for (NSString *inheritance in self.inheritances) {
 [string appendFormat:@"%@: <#Description#>\n", [inheritance stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
 }
 }
}

// override super document function to change default comment behavior
-(NSString *) document
{
 NSArray *groups = [self.code vv_stringsByExtractingGroupsUsingRegexPattern:@"^\\s*((.*\\s)?class\\s+)([^:]+):?(.*)\\{"];

 [self captureClassNameFrom:groups];

 NSMutableString *commentString = [NSMutableString new];
 [commentString appendFormat:@"/**\n%@@class %@\n\n@abstract <#Description#>\n", self.indent, self.className];
 [commentString appendFormat:@"\n %@*/", self.indent];

 return commentString;
}

@end

11 changes: 8 additions & 3 deletions
VVDocumenter-Xcode/OCCategory/NSString+PDRegex/NSString+PDRegex.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,14 @@ -(NSArray *) vv_stringsByExtractingGroupsUsingRegexPattern:(NSString *)regex cas
 __block NSMutableArray *retVal = [NSMutableArray array];
 [pattern enumerateMatchesInString:self options:0 range:NSMakeRange(0, [self length]) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
 //Note, we only want to return the things in parens, so we're skipping index 0 intentionally
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSString *matchedString=[self substringWithRange:[result rangeAtIndex:i]];
 [retVal addObject:matchedString];
 if ([result numberOfRanges] > 1) {
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSRange range = [result rangeAtIndex:i];
 if (range.location != NSNotFound) {
 NSString *matchedString=[self substringWithRange:range];
 [retVal addObject:matchedString];
 }
 }
 }
 }];
 return retVal;
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
-(BOOL) vv_isStruct;
-(BOOL) vv_isUnion;
-(BOOL) vv_isComplieKeyword;
-(BOOL) vv_isSwiftClass;
-(BOOL) vv_isSwiftFunction;
-(BOOL) vv_isSwiftEnum;
-(BOOL) vv_isSwiftProperty;
Expand Down

9 changes: 7 additions & 2 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,15 +92,20 @@ -(BOOL) vv_isSwiftFunction
 return ![self vv_isObjCMethod] && ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(func\\s+)|(init|deinit|subscript)"];
}

-(BOOL) vv_isSwiftClass
{
 return ![self vv_isSwiftFunction] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"];
}

-(BOOL) vv_isSwiftEnum
{
 return ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?enum\\s+"];
}

-(BOOL) vv_isSwiftProperty
{
 // Opt out the situation of `class func`
 if ([self vv_matchesPatternRegexPattern:@"class func"]) {
 // Opt out the situation of `class func` and `class`
 if ([self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"]) {
 return NO;
 }

Expand Down

2 changes: 2 additions & 0 deletions
VVDocumenter-Xcode/VVDocumenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -90,6 +90,8 @@ -(NSString *) document
 commenter = [[VVStructCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isObjCMethod]) {
 commenter = [[VVMethodCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftClass]) {
 commenter = [[VVSwiftClassCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftFunction]) {
 commenter = [[VVSwiftFunctionCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftProperty]) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Swift Class Comment Support by tonyli508 · Pull Request #229 · onevcat/VVDocumenter-Xcode · GitHub
Skip to content

This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Swift Class Comment Support#229
 Open

tonyli508
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


Swift Class Comment Support
#229
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2ea2d80

Add comment support for Swift Class


tonyli508 Jun 17, 2016
8d72ac8

Disable inheritance info for swift class, add comments


tonyli508 Jun 17, 2016
3e905b1

Change back NSPredicate predicateWithBlock default parameter


tonyli508 Jun 17, 2016
6696b84

Remove NSPredicate from VVSwiftClassCommenter


tonyli508 Jun 17, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
VVDocumenter-Xcode.xcodeproj/project.pbxproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@
	objects = {

/* Begin PBXBuildFile section */
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 4B06DF741B315E9D007D69BE /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 4B50A2701B315CF3008A4400 /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 53C67935184501030030C553 /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 893D8F7F18262EF500E8A00C /* Carbon.framework */; };
Expand DownExpand Up@@ -73,6 +75,8 @@
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftClassCommenter.h; sourceTree = "<group>"; };
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftClassCommenter.m; sourceTree = "<group>"; };
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftExtensionCommenter.h; sourceTree = "<group>"; };
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftExtensionCommenter.m; sourceTree = "<group>"; };
 893D8F7F18262EF500E8A00C /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
Expand DownExpand Up@@ -309,6 +313,8 @@
 D16AFCE81796E0D6006719AA /* VVVariableCommenter.m */,
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */,
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */,
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */,
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */,
 );
 path = Commenter;
 sourceTree = "<group>";
Expand DownExpand Up@@ -517,6 +523,7 @@
 D124614717AC16820095F9D6 /* VVDocumenterSetting.m in Sources */,
 C4052CFB1B3BB10700ED0CF0 /* VVWorkspaceManager.m in Sources */,
 D124614817AC16820095F9D6 /* VVDSettingPanelWindowController.m in Sources */,
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */,
 );
 runOnlyForDeploymentPostprocessing = 0;
 };
Expand All@@ -537,6 +544,7 @@
 D1A6B1D1198A0D8600BCED83 /* VVSwiftPropertyCommenter.m in Sources */,
 D14110B51988C12F00A7083F /* NSTextView+VVTextGetter.m in Sources */,
 D14110B61988C12F00A7083F /* VVDocumenterManager.m in Sources */,
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */,
 D14110B71988C12F00A7083F /* VVDocumenter.m in Sources */,
 D14110A81988C12000A7083F /* VVArgument.m in Sources */,
 D1C6124919891B3700FDB554 /* VVSwiftEnumCommenter.m in Sources */,
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/Commenter/VVCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,5 +40,6 @@
#import "VVSwiftEnumCommenter.h"
#import "VVSwiftPropertyCommenter.h"
#import "VVSwiftExtensionCommenter.h"
#import "VVSwiftClassCommenter.h"

#endif

13 changes: 13 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
//
// VVSwiftClassCommenter.h
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVCommenter.h"

@interface VVSwiftClassCommenter : VVBaseCommenter

@end

85 changes: 85 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
//
// VVSwiftClassCommenter.m
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVSwiftClassCommenter.h"
#import "NSString+VVTextGetter.h"
#import "VVTextResult.h"
#import "VVArgument.h"

@interface VVSwiftClassCommenter()

@property (nonatomic, strong) NSString *className;
@property (nonatomic, strong) NSArray *inheritances;

@end

@implementation VVSwiftClassCommenter

/**
 * Capture class name from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureClassNameFrom:(NSArray *)groups
{
 self.className = [groups objectAtIndex:1];
 // if there are additional annotations like `public`, `private`, `final`
 if ([groups count] > 3) {
 self.className = [groups objectAtIndex:2];
 }
}

/**
 * Capture inheritances from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureInheritancesFrom:(NSArray *)groups {

 NSMutableArray *nonEmptyStrings = [NSMutableArray new];
 NSArray *potentialInheritances = [[groups lastObject] componentsSeparatedByString:@","];

 for(NSString *string in potentialInheritances) {
 NSString *strippedString = [string stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 if (strippedString.length > 0) {
 [nonEmptyStrings addObject:strippedString];
 }
 }

 self.inheritances = [NSArray arrayWithArray:nonEmptyStrings];
}

/**
 * Append inheritance info string to comment string
 *
 * @param string comment string want to append to
 */
-(void) appendInheritanceStringTo:(NSMutableString *)string {
 if ([self.inheritances count] > 0) {
 [string appendString:@"inherits from or conforms to:\n"];
 for (NSString *inheritance in self.inheritances) {
 [string appendFormat:@"%@: <#Description#>\n", [inheritance stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
 }
 }
}

// override super document function to change default comment behavior
-(NSString *) document
{
 NSArray *groups = [self.code vv_stringsByExtractingGroupsUsingRegexPattern:@"^\\s*((.*\\s)?class\\s+)([^:]+):?(.*)\\{"];

 [self captureClassNameFrom:groups];

 NSMutableString *commentString = [NSMutableString new];
 [commentString appendFormat:@"/**\n%@@class %@\n\n@abstract <#Description#>\n", self.indent, self.className];
 [commentString appendFormat:@"\n %@*/", self.indent];

 return commentString;
}

@end

11 changes: 8 additions & 3 deletions
VVDocumenter-Xcode/OCCategory/NSString+PDRegex/NSString+PDRegex.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,14 @@ -(NSArray *) vv_stringsByExtractingGroupsUsingRegexPattern:(NSString *)regex cas
 __block NSMutableArray *retVal = [NSMutableArray array];
 [pattern enumerateMatchesInString:self options:0 range:NSMakeRange(0, [self length]) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
 //Note, we only want to return the things in parens, so we're skipping index 0 intentionally
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSString *matchedString=[self substringWithRange:[result rangeAtIndex:i]];
 [retVal addObject:matchedString];
 if ([result numberOfRanges] > 1) {
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSRange range = [result rangeAtIndex:i];
 if (range.location != NSNotFound) {
 NSString *matchedString=[self substringWithRange:range];
 [retVal addObject:matchedString];
 }
 }
 }
 }];
 return retVal;
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
-(BOOL) vv_isStruct;
-(BOOL) vv_isUnion;
-(BOOL) vv_isComplieKeyword;
-(BOOL) vv_isSwiftClass;
-(BOOL) vv_isSwiftFunction;
-(BOOL) vv_isSwiftEnum;
-(BOOL) vv_isSwiftProperty;
Expand Down

9 changes: 7 additions & 2 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,15 +92,20 @@ -(BOOL) vv_isSwiftFunction
 return ![self vv_isObjCMethod] && ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(func\\s+)|(init|deinit|subscript)"];
}

-(BOOL) vv_isSwiftClass
{
 return ![self vv_isSwiftFunction] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"];
}

-(BOOL) vv_isSwiftEnum
{
 return ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?enum\\s+"];
}

-(BOOL) vv_isSwiftProperty
{
 // Opt out the situation of `class func`
 if ([self vv_matchesPatternRegexPattern:@"class func"]) {
 // Opt out the situation of `class func` and `class`
 if ([self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"]) {
 return NO;
 }

Expand Down

2 changes: 2 additions & 0 deletions
VVDocumenter-Xcode/VVDocumenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -90,6 +90,8 @@ -(NSString *) document
 commenter = [[VVStructCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isObjCMethod]) {
 commenter = [[VVMethodCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftClass]) {
 commenter = [[VVSwiftClassCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftFunction]) {
 commenter = [[VVSwiftFunctionCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftProperty]) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Swift Class Comment Support by tonyli508 · Pull Request #229 · onevcat/VVDocumenter-Xcode · GitHub
Skip to content

This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Swift Class Comment Support#229
 Open

tonyli508
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


Swift Class Comment Support
#229
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2ea2d80

Add comment support for Swift Class


tonyli508 Jun 17, 2016
8d72ac8

Disable inheritance info for swift class, add comments


tonyli508 Jun 17, 2016
3e905b1

Change back NSPredicate predicateWithBlock default parameter


tonyli508 Jun 17, 2016
6696b84

Remove NSPredicate from VVSwiftClassCommenter


tonyli508 Jun 17, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
VVDocumenter-Xcode.xcodeproj/project.pbxproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@
	objects = {

/* Begin PBXBuildFile section */
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 4B06DF741B315E9D007D69BE /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 4B50A2701B315CF3008A4400 /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 53C67935184501030030C553 /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 893D8F7F18262EF500E8A00C /* Carbon.framework */; };
Expand DownExpand Up@@ -73,6 +75,8 @@
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftClassCommenter.h; sourceTree = "<group>"; };
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftClassCommenter.m; sourceTree = "<group>"; };
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftExtensionCommenter.h; sourceTree = "<group>"; };
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftExtensionCommenter.m; sourceTree = "<group>"; };
 893D8F7F18262EF500E8A00C /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
Expand DownExpand Up@@ -309,6 +313,8 @@
 D16AFCE81796E0D6006719AA /* VVVariableCommenter.m */,
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */,
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */,
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */,
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */,
 );
 path = Commenter;
 sourceTree = "<group>";
Expand DownExpand Up@@ -517,6 +523,7 @@
 D124614717AC16820095F9D6 /* VVDocumenterSetting.m in Sources */,
 C4052CFB1B3BB10700ED0CF0 /* VVWorkspaceManager.m in Sources */,
 D124614817AC16820095F9D6 /* VVDSettingPanelWindowController.m in Sources */,
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */,
 );
 runOnlyForDeploymentPostprocessing = 0;
 };
Expand All@@ -537,6 +544,7 @@
 D1A6B1D1198A0D8600BCED83 /* VVSwiftPropertyCommenter.m in Sources */,
 D14110B51988C12F00A7083F /* NSTextView+VVTextGetter.m in Sources */,
 D14110B61988C12F00A7083F /* VVDocumenterManager.m in Sources */,
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */,
 D14110B71988C12F00A7083F /* VVDocumenter.m in Sources */,
 D14110A81988C12000A7083F /* VVArgument.m in Sources */,
 D1C6124919891B3700FDB554 /* VVSwiftEnumCommenter.m in Sources */,
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/Commenter/VVCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,5 +40,6 @@
#import "VVSwiftEnumCommenter.h"
#import "VVSwiftPropertyCommenter.h"
#import "VVSwiftExtensionCommenter.h"
#import "VVSwiftClassCommenter.h"

#endif

13 changes: 13 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
//
// VVSwiftClassCommenter.h
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVCommenter.h"

@interface VVSwiftClassCommenter : VVBaseCommenter

@end

85 changes: 85 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
//
// VVSwiftClassCommenter.m
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVSwiftClassCommenter.h"
#import "NSString+VVTextGetter.h"
#import "VVTextResult.h"
#import "VVArgument.h"

@interface VVSwiftClassCommenter()

@property (nonatomic, strong) NSString *className;
@property (nonatomic, strong) NSArray *inheritances;

@end

@implementation VVSwiftClassCommenter

/**
 * Capture class name from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureClassNameFrom:(NSArray *)groups
{
 self.className = [groups objectAtIndex:1];
 // if there are additional annotations like `public`, `private`, `final`
 if ([groups count] > 3) {
 self.className = [groups objectAtIndex:2];
 }
}

/**
 * Capture inheritances from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureInheritancesFrom:(NSArray *)groups {

 NSMutableArray *nonEmptyStrings = [NSMutableArray new];
 NSArray *potentialInheritances = [[groups lastObject] componentsSeparatedByString:@","];

 for(NSString *string in potentialInheritances) {
 NSString *strippedString = [string stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 if (strippedString.length > 0) {
 [nonEmptyStrings addObject:strippedString];
 }
 }

 self.inheritances = [NSArray arrayWithArray:nonEmptyStrings];
}

/**
 * Append inheritance info string to comment string
 *
 * @param string comment string want to append to
 */
-(void) appendInheritanceStringTo:(NSMutableString *)string {
 if ([self.inheritances count] > 0) {
 [string appendString:@"inherits from or conforms to:\n"];
 for (NSString *inheritance in self.inheritances) {
 [string appendFormat:@"%@: <#Description#>\n", [inheritance stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
 }
 }
}

// override super document function to change default comment behavior
-(NSString *) document
{
 NSArray *groups = [self.code vv_stringsByExtractingGroupsUsingRegexPattern:@"^\\s*((.*\\s)?class\\s+)([^:]+):?(.*)\\{"];

 [self captureClassNameFrom:groups];

 NSMutableString *commentString = [NSMutableString new];
 [commentString appendFormat:@"/**\n%@@class %@\n\n@abstract <#Description#>\n", self.indent, self.className];
 [commentString appendFormat:@"\n %@*/", self.indent];

 return commentString;
}

@end

11 changes: 8 additions & 3 deletions
VVDocumenter-Xcode/OCCategory/NSString+PDRegex/NSString+PDRegex.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,14 @@ -(NSArray *) vv_stringsByExtractingGroupsUsingRegexPattern:(NSString *)regex cas
 __block NSMutableArray *retVal = [NSMutableArray array];
 [pattern enumerateMatchesInString:self options:0 range:NSMakeRange(0, [self length]) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
 //Note, we only want to return the things in parens, so we're skipping index 0 intentionally
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSString *matchedString=[self substringWithRange:[result rangeAtIndex:i]];
 [retVal addObject:matchedString];
 if ([result numberOfRanges] > 1) {
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSRange range = [result rangeAtIndex:i];
 if (range.location != NSNotFound) {
 NSString *matchedString=[self substringWithRange:range];
 [retVal addObject:matchedString];
 }
 }
 }
 }];
 return retVal;
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
-(BOOL) vv_isStruct;
-(BOOL) vv_isUnion;
-(BOOL) vv_isComplieKeyword;
-(BOOL) vv_isSwiftClass;
-(BOOL) vv_isSwiftFunction;
-(BOOL) vv_isSwiftEnum;
-(BOOL) vv_isSwiftProperty;
Expand Down

9 changes: 7 additions & 2 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,15 +92,20 @@ -(BOOL) vv_isSwiftFunction
 return ![self vv_isObjCMethod] && ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(func\\s+)|(init|deinit|subscript)"];
}

-(BOOL) vv_isSwiftClass
{
 return ![self vv_isSwiftFunction] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"];
}

-(BOOL) vv_isSwiftEnum
{
 return ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?enum\\s+"];
}

-(BOOL) vv_isSwiftProperty
{
 // Opt out the situation of `class func`
 if ([self vv_matchesPatternRegexPattern:@"class func"]) {
 // Opt out the situation of `class func` and `class`
 if ([self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"]) {
 return NO;
 }

Expand Down

2 changes: 2 additions & 0 deletions
VVDocumenter-Xcode/VVDocumenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -90,6 +90,8 @@ -(NSString *) document
 commenter = [[VVStructCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isObjCMethod]) {
 commenter = [[VVMethodCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftClass]) {
 commenter = [[VVSwiftClassCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftFunction]) {
 commenter = [[VVSwiftFunctionCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftProperty]) {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Swift Class Comment Support by tonyli508 · Pull Request #229 · onevcat/VVDocumenter-Xcode · GitHub
Skip to content

This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Swift Class Comment Support#229
 Open

tonyli508
wants to merge
4
commits into

base:master
Choose a base branch

from

 Open


Swift Class Comment Support
#229
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2ea2d80

Add comment support for Swift Class


tonyli508 Jun 17, 2016
8d72ac8

Disable inheritance info for swift class, add comments


tonyli508 Jun 17, 2016
3e905b1

Change back NSPredicate predicateWithBlock default parameter


tonyli508 Jun 17, 2016
6696b84

Remove NSPredicate from VVSwiftClassCommenter


tonyli508 Jun 17, 2016

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
VVDocumenter-Xcode.xcodeproj/project.pbxproj

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,8 @@
	objects = {

/* Begin PBXBuildFile section */
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */; };
 4B06DF741B315E9D007D69BE /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 4B50A2701B315CF3008A4400 /* VVSwiftExtensionCommenter.m in Sources */ = {isa = PBXBuildFile; fileRef = 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */; };
 53C67935184501030030C553 /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 893D8F7F18262EF500E8A00C /* Carbon.framework */; };
Expand DownExpand Up@@ -73,6 +75,8 @@
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftClassCommenter.h; sourceTree = "<group>"; };
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftClassCommenter.m; sourceTree = "<group>"; };
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VVSwiftExtensionCommenter.h; sourceTree = "<group>"; };
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = VVSwiftExtensionCommenter.m; sourceTree = "<group>"; };
 893D8F7F18262EF500E8A00C /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
Expand DownExpand Up@@ -309,6 +313,8 @@
 D16AFCE81796E0D6006719AA /* VVVariableCommenter.m */,
 4B50A26E1B315CF3008A4400 /* VVSwiftExtensionCommenter.h */,
 4B50A26F1B315CF3008A4400 /* VVSwiftExtensionCommenter.m */,
 1082EFFE1D13ECF800DDAC35 /* VVSwiftClassCommenter.h */,
 1082EFFF1D13ECF800DDAC35 /* VVSwiftClassCommenter.m */,
 );
 path = Commenter;
 sourceTree = "<group>";
Expand DownExpand Up@@ -517,6 +523,7 @@
 D124614717AC16820095F9D6 /* VVDocumenterSetting.m in Sources */,
 C4052CFB1B3BB10700ED0CF0 /* VVWorkspaceManager.m in Sources */,
 D124614817AC16820095F9D6 /* VVDSettingPanelWindowController.m in Sources */,
 1082F0001D13ECF800DDAC35 /* VVSwiftClassCommenter.m in Sources */,
 );
 runOnlyForDeploymentPostprocessing = 0;
 };
Expand All@@ -537,6 +544,7 @@
 D1A6B1D1198A0D8600BCED83 /* VVSwiftPropertyCommenter.m in Sources */,
 D14110B51988C12F00A7083F /* NSTextView+VVTextGetter.m in Sources */,
 D14110B61988C12F00A7083F /* VVDocumenterManager.m in Sources */,
 10E70BFA1D13FFD000C85E27 /* VVSwiftClassCommenter.m in Sources */,
 D14110B71988C12F00A7083F /* VVDocumenter.m in Sources */,
 D14110A81988C12000A7083F /* VVArgument.m in Sources */,
 D1C6124919891B3700FDB554 /* VVSwiftEnumCommenter.m in Sources */,
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/Commenter/VVCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,5 +40,6 @@
#import "VVSwiftEnumCommenter.h"
#import "VVSwiftPropertyCommenter.h"
#import "VVSwiftExtensionCommenter.h"
#import "VVSwiftClassCommenter.h"

#endif

13 changes: 13 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
//
// VVSwiftClassCommenter.h
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVCommenter.h"

@interface VVSwiftClassCommenter : VVBaseCommenter

@end

85 changes: 85 additions & 0 deletions
VVDocumenter-Xcode/Commenter/VVSwiftClassCommenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
//
// VVSwiftClassCommenter.m
// VVDocumenter-Xcode
//
// Created by Li Jiantang on 16/06/2016.
// Copyright © 2016 OneV's Den. All rights reserved.
//

#import "VVSwiftClassCommenter.h"
#import "NSString+VVTextGetter.h"
#import "VVTextResult.h"
#import "VVArgument.h"

@interface VVSwiftClassCommenter()

@property (nonatomic, strong) NSString *className;
@property (nonatomic, strong) NSArray *inheritances;

@end

@implementation VVSwiftClassCommenter

/**
 * Capture class name from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureClassNameFrom:(NSArray *)groups
{
 self.className = [groups objectAtIndex:1];
 // if there are additional annotations like `public`, `private`, `final`
 if ([groups count] > 3) {
 self.className = [groups objectAtIndex:2];
 }
}

/**
 * Capture inheritances from extracted regex groups
 *
 * @param groups regex groups
 */
-(void) captureInheritancesFrom:(NSArray *)groups {

 NSMutableArray *nonEmptyStrings = [NSMutableArray new];
 NSArray *potentialInheritances = [[groups lastObject] componentsSeparatedByString:@","];

 for(NSString *string in potentialInheritances) {
 NSString *strippedString = [string stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 if (strippedString.length > 0) {
 [nonEmptyStrings addObject:strippedString];
 }
 }

 self.inheritances = [NSArray arrayWithArray:nonEmptyStrings];
}

/**
 * Append inheritance info string to comment string
 *
 * @param string comment string want to append to
 */
-(void) appendInheritanceStringTo:(NSMutableString *)string {
 if ([self.inheritances count] > 0) {
 [string appendString:@"inherits from or conforms to:\n"];
 for (NSString *inheritance in self.inheritances) {
 [string appendFormat:@"%@: <#Description#>\n", [inheritance stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]];
 }
 }
}

// override super document function to change default comment behavior
-(NSString *) document
{
 NSArray *groups = [self.code vv_stringsByExtractingGroupsUsingRegexPattern:@"^\\s*((.*\\s)?class\\s+)([^:]+):?(.*)\\{"];

 [self captureClassNameFrom:groups];

 NSMutableString *commentString = [NSMutableString new];
 [commentString appendFormat:@"/**\n%@@class %@\n\n@abstract <#Description#>\n", self.indent, self.className];
 [commentString appendFormat:@"\n %@*/", self.indent];

 return commentString;
}

@end

11 changes: 8 additions & 3 deletions
VVDocumenter-Xcode/OCCategory/NSString+PDRegex/NSString+PDRegex.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,9 +58,14 @@ -(NSArray *) vv_stringsByExtractingGroupsUsingRegexPattern:(NSString *)regex cas
 __block NSMutableArray *retVal = [NSMutableArray array];
 [pattern enumerateMatchesInString:self options:0 range:NSMakeRange(0, [self length]) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
 //Note, we only want to return the things in parens, so we're skipping index 0 intentionally
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSString *matchedString=[self substringWithRange:[result rangeAtIndex:i]];
 [retVal addObject:matchedString];
 if ([result numberOfRanges] > 1) {
 for (int i=1; i<[result numberOfRanges]; i++) {
 NSRange range = [result rangeAtIndex:i];
 if (range.location != NSNotFound) {
 NSString *matchedString=[self substringWithRange:range];
 [retVal addObject:matchedString];
 }
 }
 }
 }];
 return retVal;
Expand Down

1 change: 1 addition & 0 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
-(BOOL) vv_isStruct;
-(BOOL) vv_isUnion;
-(BOOL) vv_isComplieKeyword;
-(BOOL) vv_isSwiftClass;
-(BOOL) vv_isSwiftFunction;
-(BOOL) vv_isSwiftEnum;
-(BOOL) vv_isSwiftProperty;
Expand Down

9 changes: 7 additions & 2 deletions
VVDocumenter-Xcode/OCCategory/NSString+VVSyntax/NSString+VVSyntax.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,15 +92,20 @@ -(BOOL) vv_isSwiftFunction
 return ![self vv_isObjCMethod] && ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(func\\s+)|(init|deinit|subscript)"];
}

-(BOOL) vv_isSwiftClass
{
 return ![self vv_isSwiftFunction] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"];
}

-(BOOL) vv_isSwiftEnum
{
 return ![self vv_isSwiftProperty] && [self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?enum\\s+"];
}

-(BOOL) vv_isSwiftProperty
{
 // Opt out the situation of `class func`
 if ([self vv_matchesPatternRegexPattern:@"class func"]) {
 // Opt out the situation of `class func` and `class`
 if ([self vv_matchesPatternRegexPattern:@"^\\s*(.*\\s+)?(class\\s+).*\\{"]) {
 return NO;
 }

Expand Down

2 changes: 2 additions & 0 deletions
VVDocumenter-Xcode/VVDocumenter.m

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -90,6 +90,8 @@ -(NSString *) document
 commenter = [[VVStructCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isObjCMethod]) {
 commenter = [[VVMethodCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftClass]) {
 commenter = [[VVSwiftClassCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftFunction]) {
 commenter = [[VVSwiftFunctionCommenter alloc] initWithIndentString:baseIndent codeString:trimCode];
 } else if ([trimCode vv_isSwiftProperty]) {
Expand Down
Loading