-
Notifications
You must be signed in to change notification settings - Fork 0
/
popc.txt
executable file
·406 lines (354 loc) · 16.3 KB
/
popc.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
*popc.txt* A layer based context manager for buffers, bookmarks and worksapces.
*popc*
_/_/_/
_/ _/ _/_/ _/_/_/ _/_/
_/_/_/ _/ _/ _/ _/ _/ _/
_/ _/ _/ _/ _/ _/
_/ _/_/ _/_/_/ _/_/_/
_/
_/
================================================================================
Table of Contents *popc-toc*
1. Overview |popc-overview|
2. Usage |popc-usage|
2.1 Installation |popc-installation|
2.2 Configuration |popc-configuration|
2.3 Statusline |popc-statusline|
2.4 Tabline |popc-tabline|
2.5 Highlight |popc-highlight|
3. Layer |popc-layer|
3.1 Buffer layer |popc-buffer|
3.2 Bookmark layer |popc-bookmark|
3.3 Workspace layer |popc-workspace|
3.4 Common mapping for layer |popc-common|
4. Add customized layer |popc-add-layer|
5. License |popc-license|
================================================================================
1. Overview *popc-overview*
Popc is a layer based context manager, including layer for buffers, bookmarks
and worksapces.....
|popc-toc|
================================================================================
2. Usage *popc-usage*
--------------------------------------------------------------------------------
2.1 Installation *popc-installation*
Example for vim-plug:
>
Plug 'yehuohan/popc'
<
You should meet the requirements below:
>
vim8.0+ or neovim
enable hidden option
<
|popc-toc|
--------------------------------------------------------------------------------
2.2 Configuration *popc-configuration*
There are some options start with `g:Popc_` (like `g:Popc_jsonPath`) used to
config popc. The default is listed below:
>
let s:conf = {
\ 'jsonPath' : $HOME, " where to store popc's json configuration
\ 'useFloatingWin' : 0,
\ 'useNerdSymbols' : 1,
\ 'symbols' : {},
\ 'highlight' : {
\ 'text' : 'Pmenu',
\ 'selected' : 'PmenuSel',
\ 'lineTxt' : 'Pmenu',
\ 'lineSel' : 'PmenuSel',
\ 'modifiedTxt' : '',
\ 'modifiedSel' : 'DiffAdd',
\ 'labelTxt' : 'IncSearch',
\ 'blankTxt' : 'Normal',
\ },
\ 'maxHeight' : 0,
\ 'useTabline' : 1,
\ 'useStatusline' : 1,
\ 'statusLine' : 'popc#stl#StatusLine()',
\ 'tabLine' : 'popc#stl#TabLine()',
\ 'tabLineLayout' : {'left' : 'buffer', 'right': 'tab'},
\ 'useLayer' : {'Buffer': 1, 'Bookmark': 1, 'Workspace': 1},
\ 'bufShowUnlisted' : 1,
\ 'bufIgnoredType' : ['Popc', 'qf'],
\ 'wksRootPatterns' : ['.popc', '.git', '.svn', '.hg'],
\ 'wksSaveUnderRoot': 0, " Store workspace under current root or global `jsonPath`
\ 'operationMaps' : {
\ 'moveCursorDown' : ['j', 'C-j'],
\ 'moveCursorUp' : ['k', 'C-k'],
\ 'moveCursorBottom' : ['J'],
\ 'moveCursorTop' : ['K'],
\ 'moveCursorPgDown' : ['M-j'],
\ 'moveCursorPgUp' : ['M-k'],
\ 'help' : ['?'],
\ 'back' : ['q'],
\ 'quit' : ['Esc']
\ },
\ 'enableLog' : 0
\ }
<
default symbols:
>
let s:defaultSymbols = {
\ 'unicode' : {
\ 'Popc' : '❖',
\ 'Buf' : '',
\ 'Wks' : '',
\ 'Bms' : '',
\ 'CTab' : '',
\ 'DTab' : '',
\ 'Tab' : '',
\ 'CWin' : '▪',
\ 'Win' : '▫',
\ 'Rank' : '≡',
\ 'Arr' : '',
\ 'Dots' : '…',
\ 'Ptr' : '',
\ 'Sep' : ['', ''],
\ 'SubSep' : ['', ''],
\ 'Nums' : ['⁰', '¹', '²', '³', '⁴', '⁵', '⁶', '⁷', '⁸', '⁹']
\ },
\ 'ascii' : {
\ 'Popc' : '#',
\ 'Buf' : '@',
\ 'Wks' : '&',
\ 'Bms' : '$',
\ 'Tab' : '~',
\ 'CTab' : '%',
\ 'DTab' : '.',
\ 'CWin' : '*',
\ 'Win' : '-',
\ 'Rank' : '=',
\ 'Arr' : '->',
\ 'Dots' : '...',
\ 'Ptr' : '>',
\ 'Sep' : ['', ''],
\ 'SubSep' : ['\', '/'],
\ 'Nums' : ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9'],
\ },
\ }
<
|popc-toc|
--------------------------------------------------------------------------------
2.3 Statusline *popc-statusline*
Set your own statusline with `g:Popc_statusLine` and `g:Popc_useStatusline`.
`popc#stl#StatusLineGetSegments()` can get the content for statusline.
An example with airline:
>
function! StatusLine()
let [l:left, l:center, l:right] = popc#stl#StatusLineGetSegments('a')
let b = airline#builder#new({ 'active': 1 })
call b.add_section('airline_a', l:left)
call b.add_section('airline_b', '')
call b.add_section('airline_c', l:center)
call b.split()
call b.add_section('airline_y', '')
call b.add_section('airline_z', l:right)
return b.build()
endfunction
let g:Popc_useStatusline=1
let g:Popc_statusLine='StatusLine()'
<
|popc-toc|
--------------------------------------------------------------------------------
2.4 Tabline *popc-tabline*
Set your own tabline with `g:Popc_tabLine` and `g:Popc_useTabline`.
`popc#layer#buf#GetTabs()` and `popc#layer#buf#GetBufs()` can get buffer and
tabpages context from buffer layer.
Attention: the tabline of popc is used for buffer layer. So if `useTabLine` is
enabled, `useLayer.Buffer` will be enabled automatically.
Switch your tabline layout with `popc#stl#TabLineSetLayout()`:
>
function! PopcTablineToggleLayout(lyt)
if a:lyt == 0
call popc#stl#TabLineSetLayout('buffer', 'tab')
elseif a:lyt == 1
call popc#stl#TabLineSetLayout('tab', 'buffer')
elseif a:lyt == 2
call popc#stl#TabLineSetLayout('buffer', '')
elseif a:lyt == 3
call popc#stl#TabLineSetLayout('', 'tab')
endif
endfunction
<
|popc-toc|
--------------------------------------------------------------------------------
2.5 Highlight *popc-highlight*
Customize highlight with `g:Popc_highlight` and `popc#stl#InitHighLight()`:
>
let g:hi = {
\ 'text' : 'Pmenu',
\ 'selected' : 'PmenuSel',
\ 'lineTxt' : 'Pmenu',
\ 'lineSel' : 'PmenuSel',
\ 'modifiedTxt' : '',
\ 'modifiedSel' : 'DiffAdd',
\ 'labelTxt' : 'IncSearch',
\ 'blankTxt' : 'Normal',
\ }
call popc#stl#InitHighLight(g:hi)
<
`g:hi` is a dictionary to save highlight name. `g:hi.text` and `g:hi.selected`
are required for `g:hi` at least.
|popc-toc|
================================================================================
3. Layer *popc-layer*
--------------------------------------------------------------------------------
3.1 Buffer layer *popc-buffer*
`Buffer layer` will track all buffers and tabpages automatically, and displays
buffers scooped under tabpages at the tabline.
In buffer layer you can switch buffers and tabpaes easily.
An example mapping to open buffer layer:
>
nnoremap <leader><leader>h :PopcBuffer<CR>
<
Example mappings to switch buffers and tabpages, which is very convenient with
tabline.
>
nnoremap <M-i> :PopcBufferSwitchTabLeft<CR> " switch to left tab
nnoremap <M-o> :PopcBufferSwitchTabRight<CR> " switch to right tab
nnoremap <M-u> :PopcBufferSwitchLeft<CR> " switch to left buffer
nnoremap <M-p> :PopcBufferSwitchRight<CR> " switch to right buffer
nnoremap <C-u> :PopcBufferJumpPrev<CR> " jump to prev buffer location
nnoremap <C-p> :PopcBufferJumpNext<CR> " jump to next buffer location
cnoremap q<CR> :PopcBufferClose<CR> " close current buffer NOT keep window when buffer number > 1 of current tab
cnoremap Q<CR> :PopcBufferClose!<CR> " close current buffer but keep window
<
An example to search all buffer contents with LeaderF:
>
" a:type = 'sigtab' search text in buffers of current tab
" a:type = 'alltab' search text in buffers of all tab
function! PopcBufSearch(pat, type)
let l:files = popc#layer#buf#GetFiles(a:type)
if !empty(l:files)
execute ':Leaderf rg -e ' a:pat . ' ' . join(l:files, ' ')
endif
endfunction
" search context in buffers with fuzzy
nnoremap <leader>bc :call PopcBufSearch('""', 'sigtab')<CR>
nnoremap <leader>bC :call PopcBufSearch('""', 'alltab')<CR>
" search context string from input
:call PopcBufSearch(<string-to-search>, 'sigtab')
:call PopcBufSearch(<string-to-search>, 'alltab')
<
In buffer layer, press '?' to see all operations:
>
h,a,l | Pop buffers layer (h-Tab buffers, a-All buffers, l-Tab list)
CR,Space | Load buffers (Space to stay in popc)
s,S,v,V,t,T | Split or tab buffers (SVT to stay in popc)
p | Show/hide full path of buffers
g,G | Goto window contain the current buffer(G to stay in popc)
c,C | Close one buffer (C-Close tab's all buffer)
i,o | Switch to left/right(i/o) tab
I,O | Move buffer to left/right(I/O) tab
n | Set current tab name
e | Edit a new file
<
|popc-toc|
--------------------------------------------------------------------------------
3.2 Bookmark layer *popc-bookmark*
`Bookmark layer` is a convenient manager for bookmark files. All bookmark layer
data is saved to `<jsonPath>/.popc.json`.
An Example mapping to open bookmark layer:
>
nnoremap <leader><leader>b :PopcBookmark<CR>
<
An example to search contexts of all bookmarked files with LeaderF:
>
function! PopcBmsSearch(pat)
let l:files = popc#layer#bms#GetBmsFiles()
if !empty(l:files)
execute ':Leaderf rg -e ' a:pat . ' ' . join(l:files, ' ')
endif
endfunction
nnoremap <leader>bs :call PopcBmsSearch()<CR>
<
In bookmark layer, press '?' to see all operations:
>
b | Pop bookmarks layer
CR,Space,s,S,v,V,t,T | Load bookmark (CR-Open, Space-Stay, sSvV-Split, tT-Tab)
a | Add file as bookmark
d | Delete one bookmark
g | Display sorted bookmaks
<
|popc-toc|
--------------------------------------------------------------------------------
3.3 Workspace layer *popc-workspace*
`Workspace layer` is mainly for saving/loading specified vim session along with
user's settings required for workspace and layout of `buffer layer`.
All workspace data is saved to `<jsonPath>/.popc.json`.
If `wksSaveUnderRoot = 0`, workspace session files are stored under `<jsonPath>/.popc/`.
If `wksSaveUnderRoot = 1`, workspace session files are stored under `<WorkspaceRoot>/.popc/`.
An example mapping to open workspace layer:
>
nnoremap <leader><leader>w :PopcWorkspace<CR>
<
An example to search files or contexts of workspace with LeaderF:
>
function! PopcWksSearchFile()
let l:wks_root = popc#layer#wks#GetCurrentWks('root')
if !empty(l:wks_root)
execute ':LeaderfFile ' . l:wks_root
endif
endfunction
function! PopcWksSearchContext()
let l:wks_root = popc#layer#wks#GetCurrentWks('root')
if !empty(l:wks_root)
execute ':Leaderf rg -e "" ' . l:wks_root
endif
endfunction
nnoremap <leader>wf :call PopcWksSearchFile()<CR>
nnoremap <leader>wc :call PopcWksSearchContext()<CR>
<
An example to save and load specified workspace settings in `dict` format:
>
let g:ws = {'settings': {'key': 'test'}}
autocmd User PopcLayerWksSavePre call popc#layer#wks#SetSettings(g:ws.settings)
autocmd User PopcLayerWksLoaded let g:ws.settings = popc#layer#wks#GetSettings()
<
In workspace layer, press '?' to see all operations:
>
w | Pop workspace layer
CR,Space,t,T | Load workspace (CR-Open, Space-Stay, tT-Tab)
a | Add new workspace
s,S | Save the workspace (S-Save in force)
d | Delete the workspace
C | Close current workspace
n | Set name of workspace
r | Set root of workspace
g | Display sorted workspaces
<
|popc-toc|
--------------------------------------------------------------------------------
3.4 Common mappings for layers *popc-common*
There are common mappings to switch from layer to another layer:
>
h | Goto buffers layer
b | Goto bookmarks layer
w | Goto workspace layer
<
|popc-toc|
================================================================================
4. Add customized layer *popc-add-layer*
All you need to do is implementing one `layer` struct and add to `s:popc`. The
file `autoload/popc/layer/exp.vim` can be a good example layer to start.
|popc-toc|
================================================================================
5. License *popc-license*
MIT License
Copyright (c) 2019 yehuohan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.