├── LICENSE ├── README.md ├── autoload └── tortf.vim └── plugin └── tortf.vim /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2024 Aaron Patterson 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vim to RTF 2 | 3 | Converts the current buffer or visually selected text to syntax highlighted RTF 4 | text and puts it in the paste buffer. 5 | 6 | Watch it in action: 7 | 8 | 9 | 10 | Inspired by [vim-copy-as-rtf](https://github.com/zerowidth/vim-copy-as-rtf). 11 | 12 | I wrote this because I write code examples in Vim, and I want to paste them 13 | in to Keynote but maintain the syntax highlighting. I've been using 14 | vim-copy-as-rtf for years, but it uses a macOS utility called `textutil`, and 15 | that utility has started giving me problems. vim-copy-as-rtf would convert 16 | the source to HTML, then use `textutil` to convert the HTML to RTF. This 17 | plugin directly converts the text to RTF without an intermediate HTML file. 18 | 19 | ## Installation 20 | 21 | ``` 22 | $ git submodule add https://github.com/tenderlove/vim-to-rtf.git pack/dist/start/vim-to-rtf 23 | ``` 24 | 25 | ## Usage 26 | 27 | Convert the entire buffer to RTF and put it in the paste buffer: 28 | 29 | ``` 30 | :ToRTF 31 | ``` 32 | 33 | To select lines and put in the paste buffer, just visual select, then do 34 | 35 | ``` 36 | :ToRTF 37 | ``` 38 | 39 | ## Configuration 40 | 41 | The default font it uses is `Courier`, but you can change it like this: 42 | 43 | ```vim 44 | g:tortf_font = "SF Mono" 45 | ``` 46 | 47 | No font size is specified by default, but you can specify a font size like this: 48 | 49 | ```vim 50 | g:tortf_font_size = 32 51 | ``` 52 | -------------------------------------------------------------------------------- /autoload/tortf.vim: -------------------------------------------------------------------------------- 1 | vim9script 2 | 3 | # This class keeps track of the colors we've encountered while processing 4 | # We use it to emit a "color table" used by RTF. Colored text needs to 5 | # refer to a color in the color map by index, so this class returns the 6 | # index corresponding to the text's color 7 | class ColorMap 8 | var indexMap: dict 9 | var mapIndex: number 10 | 11 | def new() 12 | this.indexMap = {} 13 | this.mapIndex = 1 14 | enddef 15 | 16 | # Find the color table index for r, g, b 17 | def ColorIndex(rgb: string): number 18 | if !has_key(this.indexMap, rgb) 19 | this.indexMap[rgb] = this.mapIndex 20 | this.mapIndex = this.mapIndex + 1 21 | endif 22 | 23 | return this.indexMap[rgb] 24 | enddef 25 | 26 | # Returns the sorted color map so we can transform it in to an RTF color table 27 | def ColorIndexes(): list 28 | var colormap = items(this.indexMap) 29 | 30 | sort(colormap, (i1, i2) => i1[1] - i2[1] ) 31 | 32 | return colormap 33 | enddef 34 | endclass 35 | 36 | # Converts text to RTF 37 | class RTFHighlight 38 | var colorMap: ColorMap 39 | 40 | def new() 41 | this.colorMap = ColorMap.new() 42 | enddef 43 | 44 | def Highlight(syntaxID: number, text: string): string 45 | var colorIdx = this._ColorIndex(syntaxID, text) 46 | 47 | var syntax = synIDtrans(syntaxID) 48 | var bold = synIDattr(syntax, "bold") == "1" 49 | var italic = synIDattr(syntax, "italic") == "1" 50 | 51 | if bold || italic 52 | var header = "{" .. (bold ? "\\b1 " : "") .. (italic ? "\\i1 " : "") 53 | return header .. this._EscapeChunk(colorIdx, text) .. "}" 54 | else 55 | return this._EscapeChunk(colorIdx, text) 56 | endif 57 | enddef 58 | 59 | def RTFColorTable(): string 60 | var colormap = this.colorMap.ColorIndexes() 61 | var colors = [] 62 | 63 | for [rgb, i] in colormap 64 | var r = str2nr(strpart(rgb, 0, 2), 16) 65 | var g = str2nr(strpart(rgb, 2, 2), 16) 66 | var b = str2nr(strpart(rgb, 4, 2), 16) 67 | add(colors, "\\red" .. r .. "\\green" .. g .. "\\blue" .. b) 68 | endfor 69 | 70 | return "{\\colortbl;" .. join(colors, ";") .. ";}" 71 | enddef 72 | 73 | def _RGB(syntaxID: number, text: string): string 74 | var syntax = synIDtrans(syntaxID) 75 | return strpart(synIDattr(syntax, "fg#"), 1, 6) 76 | enddef 77 | 78 | def _ColorIndex(syntaxID: number, text: string): number 79 | return this.colorMap.ColorIndex(this._RGB(syntaxID, text)) 80 | enddef 81 | 82 | def _EscapeChunk(colorIdx: number, text: string): string 83 | if text !~ '\S' 84 | # If it's only whitespace, return whitespace 85 | return text 86 | else 87 | var str = text 88 | 89 | if str =~ '[\\{}]' 90 | str = substitute(str, "[\\{}]", '\\\0', "g") 91 | endif 92 | 93 | # If there are non-ascii characters, we need to escape them 94 | if str =~ '[^\U0000-\U007F]' 95 | str = substitute(str, '[^\U0000-\U007F]', 96 | (m) => this._ConvertUnicode(m[0]), "g") 97 | endif 98 | 99 | return "\\cf" .. colorIdx .. " " .. str 100 | endif 101 | enddef 102 | 103 | def _ConvertUnicode(char: string): string 104 | var value = char2nr(char, 1) 105 | 106 | # If the character is too big, encode it as a surrogate pair 107 | if value > 0xFFFF 108 | value = value - 0x10000 109 | var upper = or(0xD800, and(value >> 10, 0x3FF)) 110 | var lower = or(0xDC00, and(0x3FF, value)) 111 | return "\\u" .. upper .. " \\u" .. lower .. "?" 112 | else 113 | # RTF uses signed integers, so if it's too big, encode it as negative 114 | if value > 0x7FFF 115 | return "\\u" .. (value - 0x10000) .. "?" 116 | else 117 | return "\\u" .. value .. "?" 118 | endif 119 | endif 120 | enddef 121 | endclass 122 | 123 | export def ToRTF(start: number, finish: number): void 124 | var line = start 125 | 126 | var rtfFilename = tempname() .. ".rtf" 127 | var newbuf = bufnr(rtfFilename, 1) 128 | bufload(newbuf) 129 | setbufline(newbuf, 1, "{\\rtf1\\ansi\\ansicpg1252\\cocoartf2636") 130 | 131 | var font = get(g:, 'tortf_font', "Courier") 132 | 133 | appendbufline(newbuf, "$", "{\\fonttbl{\\f0 " .. font .. ";}}") 134 | appendbufline(newbuf, "$", "{\\f0") 135 | 136 | if has_key(g:, "tortf_font_size") 137 | appendbufline(newbuf, "$", "\\fs" .. g:tortf_font_size * 2) 138 | endif 139 | 140 | var rtfHighlight = RTFHighlight.new() 141 | 142 | # For each line 143 | while line <= finish 144 | var column = 0 145 | var linelen = strlen(getline(line)) 146 | 147 | var rtfLine = [] 148 | 149 | # For each column 150 | while column < linelen 151 | var span = column 152 | var bytes = 0 153 | var syntaxID = synID(line, span + 1, 1) 154 | 155 | while span < linelen && syntaxID == synID(line, span + 1, 1) 156 | bytes += 1 157 | span += 1 158 | endwhile 159 | 160 | # synID is per byte, so we need to take byte slices 161 | var text = strpart(getline(line), column, bytes) 162 | 163 | add(rtfLine, rtfHighlight.Highlight(syntaxID, text)) 164 | 165 | column = span 166 | 167 | endwhile 168 | 169 | appendbufline(newbuf, "$", join(rtfLine, "") .. "\\") 170 | line = line + 1 171 | endwhile 172 | 173 | appendbufline(newbuf, 1, rtfHighlight.RTFColorTable()) 174 | appendbufline(newbuf, "$", "}") 175 | appendbufline(newbuf, "$", "}") 176 | 177 | silent exe ":sbu " .. newbuf 178 | silent exe ":w" 179 | silent exe "!cat " .. rtfFilename .. " | pbcopy" 180 | silent bd! 181 | call delete(rtfFilename) 182 | enddef 183 | -------------------------------------------------------------------------------- /plugin/tortf.vim: -------------------------------------------------------------------------------- 1 | vim9script 2 | 3 | import autoload "tortf.vim" 4 | 5 | def ToRTF(f: number, g: number) 6 | call tortf#ToRTF(f, g) 7 | enddef 8 | 9 | command! -range=% ToRTF :call ToRTF(, ) 10 | --------------------------------------------------------------------------------