您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

【投稿】Xcode 插件 XBookmark 開發筆記

編輯:iOS 開發基礎

本文為投稿文章,作者:everettjf。程式碼:https://github.com/everettjf/XBookmark

效果

在主選單中的位置如下:

使用方式

先安裝插件管理器 Alcatraz,搜尋 XBookmark 並安裝,重啟 Xcode 後就能在 Edit 選單裡看到這些功能:

  • 在對應的程式碼行按 F3,可新增或刪除書籤
  • Shift+F3:顯示書籤列表
  • Command+F3:跳到下一個書籤
  • Shift+Ctrl+F3:跳到上一個書籤

為什麼會做這個插件

剛入門 iOS 開發時,我發現自己在 Visual Studio 裡天天用的書籤功能,Xcode 竟然沒有。上網找了一輪,大約有以下幾種替代方案:

  • 拿中斷點當書籤用(Disabled Breakpoint)
  • 用 XToDo 插件,加上 BOOKMARK 標籤,然後在想標記的程式碼行補一個 BOOKMARK 註解
  • 用 XcodeBookmark 插件(不是本文的 XBookmark),但它似乎不支援 Xcode 7,而且原理仍然是輔助建立中斷點

這三種方法我都試過,但都不太理想:沒辦法快速在上一個/下一個書籤之間切換,也無法為書籤加上註解說明。

於是決定自己寫一個,就叫 XBookmark。

開發前的功課

Xcode 插件相關文章:

  • https://studentdeng.github.io/blog/2014/02/21/xcode-plugin-fun/
  • https://www.poboke.com/study/write-a-xcode-plugin-to-auto-select-all-targets.html
  • https://www.onevcat.com/2013/02/xcode-plugin/

Mac 開發相關:

  • https://www.raywenderlich.com/17811/how-to-make-a-simple-mac-app-on-os-x-10-7-tutorial-part-1

另外也讀了幾個插件的原始碼。

開發步驟簡記

安裝模板並建立專案

在 Alcatraz 的 Templates 分頁搜尋 Xcode Plugin,安裝後即可用這個模板建立工程。

增加選單

NSMenuItem *menuItem = [[NSApp mainMenu] itemWithTitle:@"Edit"];
if (menuItem) {
    [[menuItem submenu] addItem:[NSMenuItem separatorItem]];

    NSMenuItem *actionMenuItem = [[NSMenuItem alloc] initWithTitle:@"Toggle Bookmark"
                                                          action:@selector(toggleBookmark)
                                                   keyEquivalent:@"f3"];
    [actionMenuItem setKeyEquivalentModifierMask:0];
    [actionMenuItem setTarget:self];
    [[menuItem submenu] addItem:actionMenuItem];

    // ... 其餘選單項同理
}

取得書籤位置

IDESourceCodeEditor *editor = [XcodeUtil currentEditor];
NSTextView *textView = editor.textView;
if (nil == textView) return;

NSRange range = [textView.selectedRanges[0] rangeValue];
NSUInteger lineNumber = [[[textView string] substringToIndex:range.location]
                          componentsSeparatedByString:@"\n"].count;

// "file://" 的長度是 7
NSString *sourcePath = [[editor.sourceCodeDocument.fileURL absoluteString] substringFromIndex:7];

XBookmarkEntity *bookmark = [[XBookmarkEntity alloc] initWithSourcePath:sourcePath
                                                          withLineNumber:lineNumber];
[[XBookmarkModel sharedModel] toggleBookmark:bookmark];

書籤列表

發布到 Alcatraz

流程很簡單:修改設定檔,再建立一個 Pull Request 即可,細節見 supermarin/alcatraz-packages 的 README。

結語

目前只完成了基本功能,還有幾處值得改進:

  • 程式碼行定位:這部分程式碼參考自 XToDo,但某些情況下定位速度偏慢,需要找出原因並改善。
  • 書籤標識:在程式碼行前方顯示書籤圖示,例如對號之類的記號。
  • 註解功能:讓使用者能為書籤補上說明文字。
  • Mnemonic 書籤:參考 IntelliJ 系列的設計。
  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved