您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 訊息 >> iOS 相關資訊

【投稿】動手做一個 Xcode 書籤插件:XBookmark 開發筆記

編輯:iOS 相關資訊

本文為投稿文章,作者:everettjf
專案網址:https://github.com/everettjf/XBookmark

先看效果

menu

使用方式

第一步是裝好插件管理器 Alcatraz,在其中搜尋 XBookmark 並安裝。重啟 Xcode 之後,Edit 選單裡就會多出這幾個功能:

  • 在對應的程式碼行按 F3,即可新增或移除書籤
  • Shift + F3:叫出書籤清單
  • Command + F3:跳到下一個書籤
  • Shift + Ctrl + F3:回到上一個書籤

為什麼要自己寫一個

剛接觸 iOS 開發時我發現,過去在 Visual Studio 裡用得非常順手的書籤功能,Xcode 竟然沒有。翻了一輪資料,替代方案大致只有三種:

  • 拿(停用狀態的)中斷點充當書籤
  • 透過 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

此外也把幾個現成插件的原始碼翻了一遍。

開發步驟速覽

1. 安裝模板並建立工程
在 Alcatraz 的 Templates 分頁搜尋 Xcode Plugin,安裝之後直接由這個模板建立工程。

2. 把功能掛進選單

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];
    }
    // ...
}

3. 取得書籤所在位置

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];
// ...

4. 書籤清單

發佈到 Alcatraz

這一步反而最省事:修改設定檔、送出一個 Pull Request 即可,細節可參考 supermarin/alcatraz-packages 的 README。

還沒做完的部分

目前只完成了最基礎的功能,仍有幾處值得繼續打磨:

  • 程式碼行定位。這段邏輯參考自 XToDo,但某些情境下速度偏慢,需要找出瓶頸並改善。
  • 書籤標記。希望在程式碼行行首直接顯示書籤圖示,讓人一眼就看得到。
  • 註解功能。讓每個書籤都能帶一段說明文字。
  • Mnemonic 書籤。參考 IntelliJ 系列的做法,用字母快速跳轉。
  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved