├── LICENSE
├── README.md
└── plugin
└── display.vim
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU LESSER GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 |
9 | This version of the GNU Lesser General Public License incorporates
10 | the terms and conditions of version 3 of the GNU General Public
11 | License, supplemented by the additional permissions listed below.
12 |
13 | 0. Additional Definitions.
14 |
15 | As used herein, "this License" refers to version 3 of the GNU Lesser
16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU
17 | General Public License.
18 |
19 | "The Library" refers to a covered work governed by this License,
20 | other than an Application or a Combined Work as defined below.
21 |
22 | An "Application" is any work that makes use of an interface provided
23 | by the Library, but which is not otherwise based on the Library.
24 | Defining a subclass of a class defined by the Library is deemed a mode
25 | of using an interface provided by the Library.
26 |
27 | A "Combined Work" is a work produced by combining or linking an
28 | Application with the Library. The particular version of the Library
29 | with which the Combined Work was made is also called the "Linked
30 | Version".
31 |
32 | The "Minimal Corresponding Source" for a Combined Work means the
33 | Corresponding Source for the Combined Work, excluding any source code
34 | for portions of the Combined Work that, considered in isolation, are
35 | based on the Application, and not on the Linked Version.
36 |
37 | The "Corresponding Application Code" for a Combined Work means the
38 | object code and/or source code for the Application, including any data
39 | and utility programs needed for reproducing the Combined Work from the
40 | Application, but excluding the System Libraries of the Combined Work.
41 |
42 | 1. Exception to Section 3 of the GNU GPL.
43 |
44 | You may convey a covered work under sections 3 and 4 of this License
45 | without being bound by section 3 of the GNU GPL.
46 |
47 | 2. Conveying Modified Versions.
48 |
49 | If you modify a copy of the Library, and, in your modifications, a
50 | facility refers to a function or data to be supplied by an Application
51 | that uses the facility (other than as an argument passed when the
52 | facility is invoked), then you may convey a copy of the modified
53 | version:
54 |
55 | a) under this License, provided that you make a good faith effort to
56 | ensure that, in the event an Application does not supply the
57 | function or data, the facility still operates, and performs
58 | whatever part of its purpose remains meaningful, or
59 |
60 | b) under the GNU GPL, with none of the additional permissions of
61 | this License applicable to that copy.
62 |
63 | 3. Object Code Incorporating Material from Library Header Files.
64 |
65 | The object code form of an Application may incorporate material from
66 | a header file that is part of the Library. You may convey such object
67 | code under terms of your choice, provided that, if the incorporated
68 | material is not limited to numerical parameters, data structure
69 | layouts and accessors, or small macros, inline functions and templates
70 | (ten or fewer lines in length), you do both of the following:
71 |
72 | a) Give prominent notice with each copy of the object code that the
73 | Library is used in it and that the Library and its use are
74 | covered by this License.
75 |
76 | b) Accompany the object code with a copy of the GNU GPL and this license
77 | document.
78 |
79 | 4. Combined Works.
80 |
81 | You may convey a Combined Work under terms of your choice that,
82 | taken together, effectively do not restrict modification of the
83 | portions of the Library contained in the Combined Work and reverse
84 | engineering for debugging such modifications, if you also do each of
85 | the following:
86 |
87 | a) Give prominent notice with each copy of the Combined Work that
88 | the Library is used in it and that the Library and its use are
89 | covered by this License.
90 |
91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license
92 | document.
93 |
94 | c) For a Combined Work that displays copyright notices during
95 | execution, include the copyright notice for the Library among
96 | these notices, as well as a reference directing the user to the
97 | copies of the GNU GPL and this license document.
98 |
99 | d) Do one of the following:
100 |
101 | 0) Convey the Minimal Corresponding Source under the terms of this
102 | License, and the Corresponding Application Code in a form
103 | suitable for, and under terms that permit, the user to
104 | recombine or relink the Application with a modified version of
105 | the Linked Version to produce a modified Combined Work, in the
106 | manner specified by section 6 of the GNU GPL for conveying
107 | Corresponding Source.
108 |
109 | 1) Use a suitable shared library mechanism for linking with the
110 | Library. A suitable mechanism is one that (a) uses at run time
111 | a copy of the Library already present on the user's computer
112 | system, and (b) will operate properly with a modified version
113 | of the Library that is interface-compatible with the Linked
114 | Version.
115 |
116 | e) Provide Installation Information, but only if you would otherwise
117 | be required to provide such information under section 6 of the
118 | GNU GPL, and only to the extent that such information is
119 | necessary to install and execute a modified version of the
120 | Combined Work produced by recombining or relinking the
121 | Application with a modified version of the Linked Version. (If
122 | you use option 4d0, the Installation Information must accompany
123 | the Minimal Corresponding Source and Corresponding Application
124 | Code. If you use option 4d1, you must provide the Installation
125 | Information in the manner specified by section 6 of the GNU GPL
126 | for conveying Corresponding Source.)
127 |
128 | 5. Combined Libraries.
129 |
130 | You may place library facilities that are a work based on the
131 | Library side by side in a single library together with other library
132 | facilities that are not Applications and are not covered by this
133 | License, and convey such a combined library under terms of your
134 | choice, if you do both of the following:
135 |
136 | a) Accompany the combined library with a copy of the same work based
137 | on the Library, uncombined with any other library facilities,
138 | conveyed under the terms of this License.
139 |
140 | b) Give prominent notice with the combined library that part of it
141 | is a work based on the Library, and explaining where to find the
142 | accompanying uncombined form of the same work.
143 |
144 | 6. Revised Versions of the GNU Lesser General Public License.
145 |
146 | The Free Software Foundation may publish revised and/or new versions
147 | of the GNU Lesser General Public License from time to time. Such new
148 | versions will be similar in spirit to the present version, but may
149 | differ in detail to address new problems or concerns.
150 |
151 | Each version is given a distinguishing version number. If the
152 | Library as you received it specifies that a certain numbered version
153 | of the GNU Lesser General Public License "or any later version"
154 | applies to it, you have the option of following the terms and
155 | conditions either of that published version or of any later version
156 | published by the Free Software Foundation. If the Library as you
157 | received it does not specify a version number of the GNU Lesser
158 | General Public License, you may choose any version of the GNU Lesser
159 | General Public License ever published by the Free Software Foundation.
160 |
161 | If the Library as you received it specifies that a proxy can decide
162 | whether future versions of the GNU Lesser General Public License shall
163 | apply, that proxy's public statement of acceptance of any version is
164 | permanent authorization for you to choose that version for the
165 | Library.
166 |
167 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | vim-listchars
2 | ===
3 |
4 | (Neo)vim plugin that allows to cycle through different listchars configurations and when you finished
5 | cycling between configurations disables display of invisible chars.
6 | Next activation will reenable it and start cycling again from your first entry.
7 |
8 | To install
9 | ===
10 | For vim-plug:
11 | ```
12 | Plug 'teto/vim-listchars'
13 | ```
14 |
15 | How to configure
16 | ===
17 |
18 | If you don't like the default values, you can setup your own list of configurations
19 | ```vim
20 | let g:listchar_formats=[
21 | \"trail:·",
22 | \"tab:»·,eol:↲,nbsp:␣,extends:…,space:␣,precedes:<,extends:>,trail:·",
23 | \"tab:»·,nbsp:↲,trail:↲"
24 | \]
25 | ```
26 |
27 | There is no default mapping, you have to add it yourself, for instance:
28 |
29 | ```noremap (ToggleListchars)```
30 |
31 |
32 | Related:
33 | - https://github.com/tjdevries/cyclist.vim
34 |
--------------------------------------------------------------------------------
/plugin/display.vim:
--------------------------------------------------------------------------------
1 | " Vim global plugin for cycling through nolist/list/different listchars
2 | " configurations
3 | " Last Change: February 2016
4 | " Maintainer: Matthieu Coudron
5 | " License: This file is placed in the public domain
6 | scriptencoding utf8
7 |
8 | if exists("ToggleInvisibleChar")
9 | finish
10 | endif
11 |
12 | " show tab and trailing spaces
13 | " Ctrl+v, u, unicode hex code
14 | " "
15 | " " tab chars
16 | " " 21E2 ⇢
17 | " " 21E5 ⇥
18 | " " 21E8 ⇨
19 | " " 2192 → (rightwards arrow, →)
20 | " " 21D2 ⇒ (rightwards double arrow, ⇒)
21 | " " 25B8 ▸ (TextMate style)
22 | " "→
23 | " " trail chars
24 | " " 25CF ●
25 | " " 2639 ☹ (frowning face)
26 | " " 267A ♺ (recycling symbol)
27 | " " 261F ☟ (hand pointing down)
28 | " " F8FF (apple logo)
29 | " "
30 | " " eol chars
31 | " " 21B2 ↲
32 | " " 21B5 ↵ (carriage return, ↵)
33 | " " 21A9 ↩
34 | " " 23CE ⏎ (return symbol)
35 | " " 00AC ¬ (TextMate style)
36 |
37 | let g:current_listchar_id = 0
38 |
39 |
40 | "\"trail:·,tab:→\ ,eol:↲,precedes:<,extends:>",
41 | " d sds
42 | let g:listchar_formats=[
43 | \"trail:·",
44 | \"tab:»·,eol:↲,nbsp:␣,extends:…,space:␣,precedes:<,extends:>,trail:·",
45 | \"tab:»·,nbsp:↲,trail:↲"
46 | \]
47 |
48 | " lists are 0 indexed
49 | function! ToggleInvisibleChar()
50 |
51 | " l => local to the function
52 | let l:len = len(g:listchar_formats)
53 |
54 | "echom "Current=" . g:current_listchar_id . "with length" . l:len
55 | let g:current_listchar_id += 1
56 |
57 | if g:current_listchar_id >= l:len
58 | set nolist
59 | let g:current_listchar_id = -1
60 | else
61 | "echom "index=".g:current_listchar_id." format=".g:listchar_formats[g:current_listchar_id]
62 | " list is local to window while listchars is global
63 | set list
64 | execute "set listchars=".g:listchar_formats[g:current_listchar_id]
65 | endif
66 | endfunction
67 |
68 |
69 | command! ToggleListchars call ToggleInvisibleChar()
70 | map (ToggleListchars) :ToggleListchars
71 |
72 |
--------------------------------------------------------------------------------