├── .gitignore
├── addon-info.json
├── CHANGELOG.md
├── .travis.yml
├── plugin
    ├── commands.vim
    └── mappings.vim
├── CONTRIBUTING.md
├── vroom
    ├── setupvroom.vim
    └── main.vroom
├── instant
    └── flags.vim
├── README.md
├── doc
    └── syncopate.txt
├── autoload
    └── syncopate.vim
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | doc/tags
2 | 


--------------------------------------------------------------------------------
/addon-info.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "syncopate",
 3 |   "description": "Syntax-highlighted copy-paste",
 4 |   "version": "0.2.0",
 5 |   "author": "Google",
 6 |   "repository": {"type": "git", "url": "git://github.com/google/vim-syncopate"},
 7 |   "dependencies": {
 8 |     "maktaba": {"type": "git", "url": "git://github.com/google/vim-maktaba"}
 9 |   }
10 | }
11 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Current changes
 2 | 
 3 | ## Features
 4 | 
 5 | - New `'operatorfunc'` function `syncopate#ClipboardOperatorfunc()`, and default mapping `,<`.
 6 |   - This lets you do things like `,<ip` to export the current paragraph.
 7 | * New `clear_bg` flag lets `:SyncopateExportToClipboard` output transparent backgrounds.
 8 | 
 9 | # 0.2.0
10 | 
11 | *2014-12-08*
12 | 
13 | ## Features
14 | 
15 | * New `:SyncopateExportToClipboard` command now exports directly to clipboard using `xclip`
16 |   * `<Leader><>` mapping uses this instead of browser export
17 | * `:HtmlExport` renamed to `:SyncopateExportToBrowser` for clarity
18 | * Users can choose browser command with `browser` option (see `:help syncopate:browser`)
19 | 
20 | ## Bugfixes
21 | 
22 | * Syncopate failed in non-writable directories (#2)
23 | * HTML output was unreadable (yellow-on-white) when `t_Co=8` (#5)
24 | * Better handling of `'background'` option (important for `solarized` colorscheme) (#6)
25 | * Direct-to-clipboard was eliminating users' background colours (#16)
26 | 
27 | # 0.1.0
28 | 
29 | *2014-11-19*
30 | 
31 | ## Features
32 | 
33 | * `:HtmlExport` command exports to a browser tab
34 | * Optional mapping (default: `<Leader><>`) to run `:HtmlExport`
35 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: generic
 2 | env:
 3 |   matrix:
 4 |     - CI_TARGET=vim MAKTABA_VERSION=1.9.0
 5 |     - CI_TARGET=vim MAKTABA_VERSION=master
 6 |     - CI_TARGET=neovim MAKTABA_VERSION=master
 7 | before_script:
 8 |   - sudo apt-get update
 9 |   - sudo apt-get install python3-dev
10 |   - if [ $CI_TARGET = vim ]; then
11 |       sudo apt-get install vim-gnome;
12 |     elif [ $CI_TARGET = neovim ]; then
13 |       eval "$(curl -Ss https://raw.githubusercontent.com/neovim/bot-ci/master/scripts/travis-setup.sh) nightly-x64" &&
14 |       wget https://bootstrap.pypa.io/get-pip.py &&
15 |       sudo python3 get-pip.py --allow-external sudo &&
16 |       sudo pip3 install neovim;
17 |     fi
18 |   - wget https://github.com/google/vroom/releases/download/v0.12.0/vroom_0.12.0-1_all.deb
19 |   - sudo dpkg -i ./vroom_0.12.0-1_all.deb
20 |   - git clone -b ${MAKTABA_VERSION} https://github.com/google/vim-maktaba.git ../maktaba/
21 |   - git clone https://github.com/google/vim-glaive.git ../glaive/
22 | services:
23 |   - xvfb
24 | script:
25 |   - '[ $CI_TARGET = neovim ] && VROOM_ARGS="--neovim" || VROOM_ARGS=""'
26 |   - vroom $VROOM_ARGS --crawl ./vroom/
27 | matrix:
28 |   fast_finish: true
29 |   allow_failures:
30 |     - env: CI_TARGET=neovim MAKTABA_VERSION=master
31 | 


--------------------------------------------------------------------------------
/plugin/commands.vim:
--------------------------------------------------------------------------------
 1 | " Copyright 2014 Google Inc. All rights reserved.
 2 | "
 3 | " Licensed under the Apache License, Version 2.0 (the "License");
 4 | " you may not use this file except in compliance with the License.
 5 | " You may obtain a copy of the License at
 6 | "
 7 | "     http://www.apache.org/licenses/LICENSE-2.0
 8 | "
 9 | " Unless required by applicable law or agreed to in writing, software
10 | " distributed under the License is distributed on an "AS IS" BASIS,
11 | " WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | " See the License for the specific language governing permissions and
13 | " limitations under the License.
14 | 
15 | " Maktaba boilerplate (which also prevents re-entry).
16 | let [s:plugin, s:enter] = maktaba#plugin#Enter(expand('<sfile>:p'))
17 | if !s:enter
18 |   finish
19 | endif
20 | 
21 | 
22 | ""
23 | " Export syntax-highlighted text, in HTML format, to a browser tab.
24 | command -nargs=0 -range=% SyncopateExportToBrowser
25 |     \ <line1>,<line2>call syncopate#ExportToBrowser()
26 | 
27 | 
28 | ""
29 | " Export syntax-highlighted text, in HTML format, to the clipboard.
30 | " Requires xclip to be installed on your system.
31 | command -nargs=0 -range=% SyncopateExportToClipboard
32 |     \ <line1>,<line2>call syncopate#ExportToClipboard()
33 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | Want to contribute? Great! First, read this page (including the small print at the end).
 2 | 
 3 | ### Before you contribute
 4 | Before we can use your code, you must sign the
 5 | [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1)
 6 | (CLA), which you can do online. The CLA is necessary mainly because you own the
 7 | copyright to your changes, even after your contribution becomes part of our
 8 | codebase, so we need your permission to use and distribute your code. We also
 9 | need to be sure of various other things—for instance that you'll tell us if you
10 | know that your code infringes on other people's patents. You don't have to sign
11 | the CLA until after you've submitted your code for review and a member has
12 | approved it, but you must do it before we can put your code into our codebase.
13 | Before you start working on a larger contribution, you should get in touch with
14 | us first through the issue tracker with your idea so that we can help out and
15 | possibly guide you. Coordinating up front makes it much easier to avoid
16 | frustration later on.
17 | 
18 | ### Code reviews
19 | All submissions, including submissions by project members, require review. We
20 | use Github pull requests for this purpose.
21 | 
22 | ### The small print
23 | Contributions made by corporations are covered by a different agreement than
24 | the one above, the Software Grant and Corporate Contributor License Agreement.
25 | 


--------------------------------------------------------------------------------
/plugin/mappings.vim:
--------------------------------------------------------------------------------
 1 | " Copyright 2014 Google Inc. All rights reserved.
 2 | "
 3 | " Licensed under the Apache License, Version 2.0 (the "License");
 4 | " you may not use this file except in compliance with the License.
 5 | " You may obtain a copy of the License at
 6 | "
 7 | "     http://www.apache.org/licenses/LICENSE-2.0
 8 | "
 9 | " Unless required by applicable law or agreed to in writing, software
10 | " distributed under the License is distributed on an "AS IS" BASIS,
11 | " WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | " See the License for the specific language governing permissions and
13 | " limitations under the License.
14 | 
15 | " Maktaba boilerplate (which also prevents re-entry).
16 | let [s:plugin, s:enter] = maktaba#plugin#Enter(expand('<sfile>:p'))
17 | if !s:enter
18 |   finish
19 | endif
20 | 
21 | 
22 | let s:prefix = s:plugin.MapPrefix('<')
23 | 
24 | 
25 | ""
26 | " Export syntax-highlighted text to a browser tab as HTML, using the current
27 | " syncopate settings.
28 | "
29 | " In visual mode, this only exports the selected text.
30 | let s:clipboard_map = s:prefix . '>'
31 | execute 'noremap <unique> <silent>' s:clipboard_map
32 |     \ ':SyncopateExportToClipboard<CR>'
33 | " noremap, followed by ounmap, makes the mapping valid in normal and visual
34 | " modes.
35 | execute 'ounmap' s:clipboard_map
36 | 
37 | 
38 | ""
39 | " 'operatorfunc' mapping, suitable for use with text objects.
40 | execute 'nnoremap <unique> <silent>' s:prefix
41 |     \ ':set operatorfunc=syncopate#ClipboardOperatorfunc<CR>g@'
42 | 


--------------------------------------------------------------------------------
/vroom/setupvroom.vim:
--------------------------------------------------------------------------------
 1 | " Copyright 2015 Google Inc. All rights reserved.
 2 | "
 3 | " Licensed under the Apache License, Version 2.0 (the "License");
 4 | " you may not use this file except in compliance with the License.
 5 | " You may obtain a copy of the License at
 6 | "
 7 | "     http://www.apache.org/licenses/LICENSE-2.0
 8 | "
 9 | " Unless required by applicable law or agreed to in writing, software
10 | " distributed under the License is distributed on an "AS IS" BASIS,
11 | " WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | " See the License for the specific language governing permissions and
13 | " limitations under the License.
14 | 
15 | " This file is used from vroom scripts to bootstrap the syncopate plugin and
16 | " configure it to work properly under vroom.
17 | 
18 | " Syncopate does not support compatible mode.
19 | set nocompatible
20 | 
21 | " Install maktaba from local dir.
22 | let s:repo = expand('<sfile>:p:h:h')
23 | let s:search_dir = fnamemodify(s:repo, ':h')
24 | " We'd like to use maktaba#path#Join, but maktaba doesn't exist yet.
25 | let s:slash = exists('+shellslash') && !&shellslash ? '\' : '/'
26 | for s:plugin_dirname in ['maktaba', 'vim-maktaba']
27 |   let s:bootstrap_path = join([s:search_dir, s:plugin_dirname, 'bootstrap.vim'],
28 |       \ s:slash)
29 |   if filereadable(s:bootstrap_path)
30 |     execute 'source' s:bootstrap_path
31 |     break
32 |   endif
33 | endfor
34 | 
35 | " Install the syncopate plugin.
36 | call maktaba#plugin#GetOrInstall(s:repo)
37 | 
38 | " Install Glaive from local dir.
39 | for s:plugin_dirname in ['glaive', 'vim-glaive']
40 |   let s:bootstrap_path =
41 |       \ maktaba#path#Join([s:search_dir, s:plugin_dirname, 'bootstrap.vim'])
42 |   if filereadable(s:bootstrap_path)
43 |     execute 'source' s:bootstrap_path
44 |     break
45 |   endif
46 | endfor
47 | 
48 | " Force plugin/ files to load since vroom installs the plugin after
49 | " |load-plugins| time.
50 | call maktaba#plugin#Get('syncopate').Load()
51 | 
52 | " Load :TOhtml command (dependency of syncopate), normally loaded automatically
53 | " at vim startup.
54 | runtime plugin/tohtml.vim
55 | 
56 | " Support vroom's fake shell executable and don't try to override it to sh.
57 | call maktaba#syscall#SetUsableShellRegex('\v<shell\.vroomfaker$')
58 | 


--------------------------------------------------------------------------------
/vroom/main.vroom:
--------------------------------------------------------------------------------
 1 | Syncopate makes it very easy to share beautiful code in webmail windows, Google
 2 | Docs, etc. It uses vim's syntax highlighting capabilities to send colored,
 3 | formatted code from a vim buffer either to your clipboard directly or into a
 4 | web browser view you can copy from.
 5 | 
 6 | This file demonstrates the basics of syncopate usage.
 7 | 
 8 | In order for these tests to work, maktaba MUST be in the same parent directory
 9 | as syncopate. Given that that's the case, all we have to do is source the
10 | setupvroom.vim file, which bootstraps the codefmt plugin and configures it to
11 | work properly under vroom.
12 | 
13 |   :source $VROOMDIR/setupvroom.vim
14 |   :syntax on
15 | 
16 | First, let's put some vimscript code into a buffer and tell vim it's vimscript.
17 | 
18 |   :set filetype=vim
19 |   % let x = empty('foo') ? 1 : 2
20 | 
21 | Now we'll use :SyncopateExportToClipboard to send it as rich colored text to the
22 | clipboard. (Instead of sending it to your actual clipboard, we'll redirect it to
23 | a temporary file so we can inspect the contents below.)
24 | 
25 |   :let $VROOM_TEMPFILE = tempname()
26 |   :SyncopateExportToClipboard
27 |   ! xclip -t text/html -selection clipboard 2>.*
28 |   $ cat > $VROOM_TEMPFILE (command)
29 |   ~ Syncopate exported the entire file.
30 | 
31 | Now it's in the clipboard as rich colored text. The "let" keyword is highlighted
32 | in the appropriate color (from the default colorscheme). Other syntax is also
33 | there, highlighted in various other colors.
34 | 
35 |   :echomsg join(readfile($VROOM_TEMPFILE), '')
36 |   ~ *<font color="#??????">let</font>*x*empty*'foo'*?*1*:*2* (glob)
37 | 
38 | 
39 | 
40 | You can also use :SyncopateExportToBrowser to send the rich colored text to a
41 | browser window instead of the clipboard.
42 | 
43 |   :set filetype=vim
44 |   % echo 'Beam me up!'
45 |   :SyncopateExportToBrowser
46 |   ! sensible-browser (\S+) 2>.*
47 |   $ cat \1 > $VROOM_TEMPFILE (command)
48 | 
49 |   :echomsg join(readfile($VROOM_TEMPFILE), '')
50 |   ~ *echo*<font color="#??????">'Beam me up!'</font>* (glob)
51 | 
52 | It uses sensible-browser by default. You can override it to use any browser via
53 | the "browser" flag. This is a maktaba flag, configured using the :Glaive tool.
54 | 
55 |   :Glaive syncopate browser=google-chrome
56 |   :SyncopateExportToBrowser
57 |   ! google-chrome (\S+) 2>.*
58 |   $ 
59 | 


--------------------------------------------------------------------------------
/instant/flags.vim:
--------------------------------------------------------------------------------
 1 | " Copyright 2014 Google Inc. All rights reserved.
 2 | "
 3 | " Licensed under the Apache License, Version 2.0 (the "License");
 4 | " you may not use this file except in compliance with the License.
 5 | " You may obtain a copy of the License at
 6 | "
 7 | "     http://www.apache.org/licenses/LICENSE-2.0
 8 | "
 9 | " Unless required by applicable law or agreed to in writing, software
10 | " distributed under the License is distributed on an "AS IS" BASIS,
11 | " WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | " See the License for the specific language governing permissions and
13 | " limitations under the License.
14 | 
15 | 
16 | ""
17 | " @section Introduction, intro
18 | " @order intro standard-config config commands functions
19 | " Syncopate makes it very easy to share beautiful code in webmail windows,
20 | " Google Docs, etc.
21 | "
22 | " Use the @command(SyncopateExportToBrowser) command to open a new browser tab
23 | " with your buffer's contents, syntax highlighting and all.  (If you're in
24 | " |visual-mode|, only the selected text will be exported.)  Then you can
25 | " copy-paste from the browser tab into your intended destination.
26 | "
27 | " Use a keymapping for even more convenience (see @flag(plugin[mappings])).
28 | " The default mapping is "<Leader><>".  So if your |<Leader>| is set to ",",
29 | " then the mapping ",<>" will run @command(SyncopateExportToBrowser) for you.
30 | " (Mnemonic: "<>" is reminiscent of HTML tags, and it triggers HTML output.)
31 | "
32 | " Syncopate will automatically switch to the default colorscheme before output,
33 | " since this tends to show up better (and be less error-prone!) on white
34 | " backgrounds.  You can change this behaviour with the @flag(change_colorscheme)
35 | " and @flag(colorscheme) settings.  In any case, Syncopate restores your
36 | " original colorscheme once it's finished.
37 | 
38 | ""
39 | " @section Configuring with standard settings, standard-config
40 | " Syncopate is based on the built-in |convert-to-HTML| functionality, which
41 | " already has a wealth of configurable settings.  We try to use these settings
42 | " wherever possible.  (For additional, Syncopate-specific settings, see
43 | " @section(config).)
44 | "
45 | " For example: many people who use line numbers in vim do not want them in the
46 | " HTML output, since they would show up when recipients copy-paste the code into
47 | " an editor window.  By default, HTML output includes line numbers whenever vim
48 | " does.  To force them not to appear, use the @setting(html_number_lines)
49 | " setting: add >
50 | "   let g:html_number_lines = 0
51 | " < to your vimrc.
52 | "
53 | " To browse all available settings, go to the first one
54 | " (@setting(html_diff_one_file)) and scroll down from there.
55 | 
56 | " Maktaba boilerplate (which also prevents re-entry).
57 | let [s:plugin, s:enter] = maktaba#plugin#Enter(expand('<sfile>:p'))
58 | if !s:enter
59 |   finish
60 | endif
61 | 
62 | 
63 | ""
64 | " Use a different colorscheme for the HTML output.  This can make the text more
65 | " readable.
66 | call s:plugin.Flag('change_colorscheme', 1)
67 | 
68 | 
69 | ""
70 | " The colorscheme to switch to for the HTML output.  The default is "default",
71 | " since it shows up nicely on a white background (as in most webmail windows).
72 | "
73 | " This setting has no effect if @flag(change_colorscheme) is false.
74 | call s:plugin.Flag('colorscheme', 'default')
75 | 
76 | 
77 | ""
78 | " The browser command which @command(SyncopateExportToBrowser) will use.
79 | "
80 | " The default, "sensible-browser", only works on Debian-based systems (including
81 | " Ubuntu).  It can be configured by the "update-alternatives" command.  If you
82 | " don't want to do this (or if you're not using a Debian-based system), you will
83 | " need to set this flag for the browser export to work.
84 | call s:plugin.Flag('browser', 'sensible-browser')
85 | 
86 | 
87 | ""
88 | " Controls whether @command(SyncopateExportToClipboard) will clear the
89 | " background colour.
90 | "
91 | " This can be useful for copy-pasting into a destination (e.g., some talk
92 | " slides) whose background colour might be slightly different than the
93 | " background in the editor.
94 | call s:plugin.Flag('clear_bg', 0)
95 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # syncopate
  2 | 
  3 | (**Syn**)tax (**cop**)y-p(**a**)s(**te**).
  4 | 
  5 | ## What's it for?
  6 | 
  7 | To make sharing beautiful code as frictionless as possible.
  8 | 
  9 | Say you have a nicely syntax-highlighted buffer in vim.
 10 | This plugin lets you open a browser tab with that buffer's contents, including the highlighting.
 11 | If you copy-paste into a webmail window, a Google Doc, etc., the syntax highlighting stays intact.
 12 | 
 13 | Best of all, it cleans up after itself: it won't clutter your directories with `.html` files.
 14 | 
 15 | ## How do I install it?
 16 | 
 17 | Depends on your plugin manager.
 18 | 
 19 | Note that syncopate is a [maktaba](https://github.com/google/vim-maktaba) plugin, so you will need to install maktaba (if your plugin manager doesn't handle dependencies).
 20 | If you want to configure the plugin, we strongly recommend installing [glaive](https://github.com/google/vim-glaive) as well.
 21 | 
 22 | Here are instructions for Vundle, the most popular plugin manager.
 23 | Add the following lines between your `call vundle#begin()` and `call vundle#end()` lines.
 24 | 
 25 | ```vim
 26 | " Dependency; required for vim-syncopate.
 27 | Plugin google/vim-maktaba
 28 | 
 29 | " Strongly recommended: easy configuration of maktaba plugins.
 30 | Plugin google/vim-glaive
 31 | 
 32 | Plugin google/vim-syncopate
 33 | ```
 34 | 
 35 | Syncopate is expected to work on any platform vim supports, but the default
 36 | configuration may not work on your system and direct-to-clipboard support hasn't
 37 | been implemented for some platforms. Contributions welcome!
 38 | 
 39 | ### xclip
 40 | 
 41 | Syncopate requires `xclip` to manipulate the clipboard.  In most cases,
 42 | installing it from your package manager should just work.
 43 | 
 44 | Arch Linux's official repository has an `xclip` (0.12.4) which is too old: it
 45 | doesn't support `--target`. Arch users should install `xclip-svn` from AUR:
 46 | 
 47 | ```
 48 | yaourt -S xclip-svn
 49 | ```
 50 | 
 51 | ## How do I use it?
 52 | 
 53 | ### Use the clipboard directly
 54 | 
 55 | Use the `:SyncopateExportToClipboard` command.
 56 | It populates the clipboard with the contents of your buffer (or just part of it, if you're in visual mode), including highlighting.
 57 | You can then paste your beautiful code into a compose window (such as Gmail).
 58 | 
 59 | Of course, it's even better with a keymapping, which you can enable using Glaive:
 60 | 
 61 | ```vim
 62 | " This line needs to go anywhere after 'call vundle#end()'.
 63 | call glaive#Install()
 64 | 
 65 | " Enable keymappings.
 66 | Glaive syncopate plugin[mappings]
 67 | ```
 68 | 
 69 | By default, syncopate's mappings all start with the prefix `<Leader><`.
 70 | You can change the prefix by giving `plugin[mappings]` a value, like so:
 71 | ```vim
 72 | Glaive syncopate plugin[mappings]='qwer'
 73 | ```
 74 | The following examples will assume you're using the default prefix, and that your [`<Leader>`](http://stackoverflow.com/questions/1764263/what-is-the-leader-in-a-vimrc-file) is `,`.
 75 | 
 76 | - `,<` calls `:SyncopateExportToClipboard` on whatever motion you choose.
 77 |   (e.g., `,<ip` will copy the current paragraph (`ip`) to the clipboard.)
 78 | - `,<>` calls `:SyncopateExportToClipboard` on the whole buffer (or your selection in visual mode).
 79 | 
 80 | ### Put it in a browser window
 81 | 
 82 | Alternatively, you can use the `:SyncopateExportToBrowser` command.
 83 | It opens the HTML in a new browser tab, so you can select regions interactively.
 84 | Syncopate automatically cleans up the HTML file after opening the tab.
 85 | 
 86 | If you use `:SyncopateExportToBrowser`, be sure to copy with `Ctrl-C` (as opposed to mouse selection/middle-click); otherwise, the highlighting will not be retained.
 87 | 
 88 | ## How do I configure it?
 89 | 
 90 | There are a variety of syncopate-specific options: whether to change the colorscheme, which browser to use, etc.
 91 | See `:help syncopate-config`.
 92 | 
 93 | For everything else, use the built-in options for the `:TOhtml` command: `:help 2html.vim`.
 94 | (Options are down below, starting at `:help g:html_diff_one_file`.)
 95 | 
 96 | For example, the following line will exclude line numbers from the output, even if you use them in vim:
 97 | 
 98 | ```vim
 99 | let g:html_number_lines = 0
100 | ```
101 | 
102 | ## So how's this different from plain :TOhtml?
103 | 
104 | Mainly convenience.
105 | Under the hood, `:SyncopateExportToClipboard` will:
106 | 
107 | 1. Switch to the default `colorscheme` (it shows up better on white backgrounds).
108 | 2. Create the HTML version of your vim buffer.
109 | 3. Export it to the clipboard.
110 | 4. Restore your `colorscheme`, and any other settings it needed to change.
111 | 
112 | Simply running `:TOhtml` only does the second step.
113 | In particular, the third step is difficult to remember how to do.
114 | Without it, `:TOhtml` usually involves tiresome saving-and-subsequently-deleting of HTML files, and fiddling with a browser.
115 | 


--------------------------------------------------------------------------------
/doc/syncopate.txt:
--------------------------------------------------------------------------------
  1 | *syncopate.txt*	Syntax-highlighted copy-paste
  2 | Google                                                             *syncopate*
  3 | 
  4 | ==============================================================================
  5 | CONTENTS                                                  *syncopate-contents*
  6 |   1. Introduction............................................|syncopate-intro|
  7 |   2. Configuring with standard settings............|syncopate-standard-config|
  8 |   3. Configuration..........................................|syncopate-config|
  9 |   4. Commands.............................................|syncopate-commands|
 10 |   5. Functions...........................................|syncopate-functions|
 11 | 
 12 | ==============================================================================
 13 | INTRODUCTION                                                 *syncopate-intro*
 14 | 
 15 | Syncopate makes it very easy to share beautiful code in webmail windows,
 16 | Google Docs, etc.
 17 | 
 18 | Use the |:SyncopateExportToBrowser| command to open a new browser tab with
 19 | your buffer's contents, syntax highlighting and all.  (If you're in
 20 | |visual-mode|, only the selected text will be exported.)  Then you can
 21 | copy-paste from the browser tab into your intended destination.
 22 | 
 23 | Use a keymapping for even more convenience (see |syncopate:plugin[mappings]|).
 24 | The default mapping is "<Leader><>".  So if your |<Leader>| is set to ",",
 25 | then the mapping ",<>" will run |:SyncopateExportToBrowser| for you.
 26 | (Mnemonic: "<>" is reminiscent of HTML tags, and it triggers HTML output.)
 27 | 
 28 | Syncopate will automatically switch to the default colorscheme before output,
 29 | since this tends to show up better (and be less error-prone!) on white
 30 | backgrounds.  You can change this behaviour with the
 31 | |syncopate:change_colorscheme| and |syncopate:colorscheme| settings.  In any
 32 | case, Syncopate restores your original colorscheme once it's finished.
 33 | 
 34 | ==============================================================================
 35 | CONFIGURING WITH STANDARD SETTINGS                 *syncopate-standard-config*
 36 | 
 37 | Syncopate is based on the built-in |convert-to-HTML| functionality, which
 38 | already has a wealth of configurable settings.  We try to use these settings
 39 | wherever possible.  (For additional, Syncopate-specific settings, see
 40 | |syncopate-config|.)
 41 | 
 42 | For example: many people who use line numbers in vim do not want them in the
 43 | HTML output, since they would show up when recipients copy-paste the code into
 44 | an editor window.  By default, HTML output includes line numbers whenever vim
 45 | does.  To force them not to appear, use the |g:html_number_lines| setting: add
 46 | >
 47 |   let g:html_number_lines = 0
 48 | <
 49 | to your vimrc.
 50 | 
 51 | To browse all available settings, go to the first one (|g:html_diff_one_file|)
 52 | and scroll down from there.
 53 | 
 54 | ==============================================================================
 55 | CONFIGURATION                                               *syncopate-config*
 56 | 
 57 | This plugin uses maktaba flags for configuration. Install Glaive
 58 | (https://github.com/google/glaive) and use the |:Glaive| command to configure
 59 | them.
 60 | 
 61 |                                                 *syncopate:change_colorscheme*
 62 | Use a different colorscheme for the HTML output.  This can make the text more
 63 | readable.
 64 | Default: 1 `
 65 | 
 66 |                                                        *syncopate:colorscheme*
 67 | The colorscheme to switch to for the HTML output.  The default is "default",
 68 | since it shows up nicely on a white background (as in most webmail windows).
 69 | 
 70 | This setting has no effect if |syncopate:change_colorscheme| is false.
 71 | Default: 'default' `
 72 | 
 73 |                                                            *syncopate:browser*
 74 | The browser command which |:SyncopateExportToBrowser| will use.
 75 | 
 76 | The default, "sensible-browser", only works on Debian-based systems (including
 77 | Ubuntu).  It can be configured by the "update-alternatives" command.  If you
 78 | don't want to do this (or if you're not using a Debian-based system), you will
 79 | need to set this flag for the browser export to work.
 80 | Default: 'sensible-browser' `
 81 | 
 82 |                                                           *syncopate:clear_bg*
 83 | Controls whether |:SyncopateExportToClipboard| will clear the background
 84 | colour.
 85 | 
 86 | This can be useful for copy-pasting into a destination (e.g., some talk
 87 | slides) whose background colour might be slightly different than the
 88 | background in the editor.
 89 | Default: 0 `
 90 | 
 91 |                                                   *syncopate:plugin[commands]*
 92 | Configures whether plugin/commands.vim should be loaded.
 93 | Default: 1 `
 94 | 
 95 |                                                   *syncopate:plugin[mappings]*
 96 | Configures whether plugin/mappings.vim should be loaded.
 97 | Default: 0 `
 98 | 
 99 | ==============================================================================
100 | COMMANDS                                                  *syncopate-commands*
101 | 
102 | :[range]SyncopateExportToBrowser                   *:SyncopateExportToBrowser*
103 |   Export syntax-highlighted text, in HTML format, to a browser tab.
104 | 
105 | :[range]SyncopateExportToClipboard               *:SyncopateExportToClipboard*
106 |   Export syntax-highlighted text, in HTML format, to the clipboard. Requires
107 |   xclip to be installed on your system.
108 | 
109 | ==============================================================================
110 | FUNCTIONS                                                *syncopate-functions*
111 | 
112 | syncopate#ClipboardOperatorfunc({type})    *syncopate#ClipboardOperatorfunc()*
113 |   An operator function to integrate with text objects.
114 | 
115 |   We ignore the {type}, since 2html.vim only seems to work linewise.
116 | 
117 | 
118 | vim:tw=78:ts=8:ft=help:norl:
119 | 


--------------------------------------------------------------------------------
/autoload/syncopate.vim:
--------------------------------------------------------------------------------
  1 | " Copyright 2014 Google Inc. All rights reserved.
  2 | "
  3 | " Licensed under the Apache License, Version 2.0 (the "License");
  4 | " you may not use this file except in compliance with the License.
  5 | " You may obtain a copy of the License at
  6 | "
  7 | "     http://www.apache.org/licenses/LICENSE-2.0
  8 | "
  9 | " Unless required by applicable law or agreed to in writing, software
 10 | " distributed under the License is distributed on an "AS IS" BASIS,
 11 | " WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | " See the License for the specific language governing permissions and
 13 | " limitations under the License.
 14 | 
 15 | let s:plugin = maktaba#plugin#Get('syncopate')
 16 | 
 17 | 
 18 | " Change vim settings to prepare for HTML export, and save the old values for
 19 | " s:SyncopateRestoreSettings().
 20 | "
 21 | " NOTE: Do not change this function without making a corresponding change in
 22 | " s:SyncopateRestoreSettings().
 23 | function! s:SyncopateSaveAndChangeSettings()
 24 |   let l:change_colorscheme = maktaba#ensure#IsBool(
 25 |       \ s:plugin.Flag('change_colorscheme'))
 26 | 
 27 |   " For vim (as opposed to gvim), we will need to muck with 't_Co' to avoid
 28 |   " outputting really hideous/unreadable colors for HTML (which should always
 29 |   " have 256 colours available).
 30 |   let l:should_set_t_Co = !has('gui')
 31 | 
 32 |   " Save any settings we'll need to restore later.
 33 |   let l:setting_names = ['g:html_use_css']
 34 |   if l:change_colorscheme
 35 |     call extend(l:setting_names, ['&background', 'g:colors_name'])
 36 |   endif
 37 |   if l:should_set_t_Co
 38 |     call extend(l:setting_names, ['&t_Co'])
 39 |   endif
 40 |   let l:settings = maktaba#value#SaveAll(l:setting_names)
 41 | 
 42 |   " Syncopate forces g:html_use_css to 0 (false).  This outputs ugly deprecated
 43 |   " <font> tags, but it's necessary to make sure the HTML shows up correctly in
 44 |   " email clients (which usually strip out <style> sections).
 45 |   let g:html_use_css = 0
 46 | 
 47 |   if l:should_set_t_Co
 48 |     set t_Co=256
 49 |   endif
 50 | 
 51 |   " Choose a more readable colorscheme for the HTML output, if desired.
 52 |   if l:change_colorscheme
 53 |     execute 'colorscheme' maktaba#ensure#IsString(s:plugin.Flag('colorscheme'))
 54 |   endif
 55 | 
 56 |   return l:settings
 57 | endfunction
 58 | 
 59 | 
 60 | " Restore any {settings} we changed to export the HTML.
 61 | "
 62 | " NOTE: Do not change this function without making a corresponding change in
 63 | " s:SyncopateSaveAndChangeSettings().
 64 | function! s:SyncopateRestoreSettings(settings)
 65 |   " We must restore the settings *before* changing the colorscheme, so that
 66 |   " g:colors_name will have its original value.
 67 |   call maktaba#value#Restore(a:settings)
 68 |   if maktaba#ensure#IsBool(s:plugin.Flag('change_colorscheme'))
 69 |     execute 'colorscheme' get(g:, 'colors_name', 'default')
 70 | 
 71 |     " We restore them again, because :colorscheme can change some of the
 72 |     " settings and we want to leave everything as we found it.  It may be
 73 |     " unlikely that anybody relies on g:colors_name being unset; however, the
 74 |     " performance hit should be truly negligible.
 75 |     call maktaba#value#Restore(a:settings)
 76 |   endif
 77 | endfunction
 78 | 
 79 | 
 80 | " Tell the user which lines were copied.
 81 | function! s:InformUserAboutCopiedText(first, last)
 82 |   redraw
 83 |   let l:message_opener = 'Syncopate exported'
 84 |   if a:first == 1 && a:last == line('$')
 85 |     echomsg l:message_opener 'the entire file.'
 86 |   else
 87 |     let l:num_lines = a:last - a:first + 1
 88 |     echomsg l:message_opener l:num_lines 'lines:' a:first 'to' a:last
 89 |   endif
 90 | endfunction
 91 | 
 92 | 
 93 | ""
 94 | " Export syntax-highlighted content to a new browser tab.
 95 | "
 96 | " @throws WrongType
 97 | function! syncopate#ExportToBrowser() range
 98 |   let l:browser = maktaba#ensure#IsString(s:plugin.Flag('browser'))
 99 | 
100 |   " Change any necessary settings to prepare for the HTML export.
101 |   let l:settings = s:SyncopateSaveAndChangeSettings()
102 | 
103 |   " Generate the HTML.
104 |   execute a:firstline . ',' . a:lastline 'TOhtml'
105 | 
106 |   " Try to save the HTML to a file and open it in the browser.
107 |   let l:html_file = tempname()
108 |   silent execute 'saveas!' l:html_file
109 |   try
110 |     call maktaba#syscall#Create([l:browser, l:html_file]).Call()
111 |   catch /ERROR(ShellError):/
112 |     call maktaba#error#Shout(v:exception)
113 |   endtry
114 | 
115 |   " Kill the HTML buffer (and file, if necessary).
116 |   bwipeout!
117 |   if maktaba#path#Exists(l:html_file)
118 |     call delete(l:html_file)
119 |   endif
120 | 
121 |   " Restore any settings necessary.
122 |   call s:SyncopateRestoreSettings(l:settings)
123 | endfunction
124 | 
125 | 
126 | ""
127 | " Export syntax-highlighted content directly to the clipboard.
128 | "
129 | " @throws WrongType
130 | function! syncopate#ExportToClipboard() range
131 |   " Change any necessary settings to prepare for the HTML export.
132 |   let l:settings = s:SyncopateSaveAndChangeSettings()
133 | 
134 |   " Generate the HTML; send it to the clipboard; kill the HTML buffer.
135 |   execute a:firstline . ',' . a:lastline 'TOhtml'
136 |   call s:PutDivInBody()
137 |   let l:contents = join(getline(1, '$'), "\n")
138 |   let l:succeeded = 0
139 |   try
140 |     call maktaba#syscall#Create([
141 |         \ 'xclip',
142 |         \ '-t', 'text/html',
143 |         \ '-selection', 'clipboard']).WithStdin(l:contents).Call()
144 |     let l:succeeded = 1
145 |   catch /ERROR(ShellError):/
146 |     call maktaba#error#Shout(v:exception)
147 |   endtry
148 |   bwipeout!
149 | 
150 |   " Restore any settings necessary.
151 |   call s:SyncopateRestoreSettings(l:settings)
152 | 
153 |   if l:succeeded
154 |     " Tell the user what we did.
155 |     call s:InformUserAboutCopiedText(a:firstline, a:lastline)
156 |   endif
157 | endfunction
158 | 
159 | 
160 | " Replace a pattern on the current line in the buffer.
161 | function! s:ReplaceOnCurrentLine(pattern, replacement)
162 |   " We add a copy and delete the original, instead of just using 's//', to avoid
163 |   " clobbering the @/ register.
164 |   put =substitute(getline('.'), a:pattern, a:replacement, '')
165 |   -
166 |   silent! delete _
167 | endfunction
168 | 
169 | 
170 | ""
171 | " @public
172 | " An operator function to integrate with text objects.
173 | "
174 | " We ignore the {type}, since 2html.vim only seems to work linewise.
175 | function! syncopate#ClipboardOperatorfunc(type)
176 |   '[,'] call syncopate#ExportToClipboard()
177 | endfunction
178 | 
179 | 
180 | " Put a <div> inside the <body>, with the bgcolor and text attributes (if any)
181 | " turned into a style attribute.
182 | "
183 | " This is intended to piggyback on 2html.vim's guesses for foreground and
184 | " background colours.
185 | function! s:PutDivInBody()
186 |   " Should this <div> set a background colour, or not?
187 |   let l:clear_bg = maktaba#ensure#IsBool(s:plugin.Flag('clear_bg'))
188 | 
189 |   " Find the <body>-line, and follow it up with a similar <div>-line.
190 |   1
191 |   call search('<body')
192 |   put =substitute(getline('.'), 'body', 'div', '')
193 |   call s:ReplaceOnCurrentLine('text=\"\(#......\)\"', 'color: \1;')
194 |   let l:bg_replacement = l:clear_bg ? '' : 'background-color: \1;'
195 |   call s:ReplaceOnCurrentLine('bgcolor=\"\(#......\)\"', l:bg_replacement)
196 |   call s:ReplaceOnCurrentLine('<div \(.*\)>', '<div style=\"\1\">')
197 | 
198 |   " Find the </body>-line, and precede it with a similar </div>-line.
199 |   $
200 |   call search('</body>', 'b')
201 |   put! =substitute(getline('.'), 'body', 'div', '')
202 | endfunction
203 | 


--------------------------------------------------------------------------------
/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 [yyyy] [name of copyright owner]
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 | 


--------------------------------------------------------------------------------