aboutsummaryrefslogtreecommitdiff
path: root/lua/buffer_browser.lua
blob: 701e5000bb9c371a6814f799566f8cb0b5fe917f (plain)
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
--[[
BUFFER BROWSER
Author: Marc Coquand
]]
local api = vim.api

--[[ STATE MANAGEMENT
We make use of a Zipper to keep track of the state of the buffers
(https://stackoverflow.com/questions/380438/what-is-the-zipper-data-structure-and-should-i-be-using-it)
]]
local function matchesFilter(filters, name)
	if filters == nil then
		return false
	end

	for _, filter in ipairs(filters) do
		if name == filter then
			return true
		end
	end
	return false
end


local function StateAppend(bufNr, stateFiletype, state, filters)
	if (state.current == bufNr) then
		return state
	end

	-- if filters matches the filetype of the buffer we change from, don't add it to history
	if (stateFiletype ~= nil and matchesFilter(filters, stateFiletype)) then
		state.current = bufNr
		return state
	else
		state.future = {}
		table.insert(state.previous, 1, state.current)
		state.current = bufNr

		return state
	end
end

local function StateGoBack(state)
	-- Go back in the state by setting current to the first element of previous, and appending the current to the future
	-- Check if past is empty, if so return state as is
	if #state.previous == 0 then
		return state
	end

	table.insert(state.future, 1, state.current)
	state.current = table.remove(state.previous, 1)
	return state
end

local function StateGoForward(state)
	-- Go forward in the state by setting current to the first element of future, and appending the current to the previous

	-- Check if future is empty, if so return state as is
	if #state.future == 0 then
		return state
	end

	table.insert(state.previous, 1, state.current)
	state.current = table.remove(state.future, 1)

	return state
end

local function StateDelete(state, bufNr)
	-- Delete bufNr from state.previous
	for i, v in ipairs(state.previous) do
		if v == bufNr then
			table.remove(state.previous, i)
		end
	end

	-- Delete bufNr from state.future
	for i, v in ipairs(state.future) do
		if v == bufNr then
			table.remove(state.future, i)
		end
	end

	-- If bufNr is current, set current to the first element of previous
	if state.current == bufNr and #state.previous > 0 then
		state.current = table.remove(state.previous, 1)
		return state
	end

	-- If bufNr is current and we have a future
	if state.current == bufNr and #state.future > 0 then
		state.current = table.remove(state.future, 1)
		return state
	end

	-- If bufNr is current, set current to the first element of future
	if state.current == bufNr then
		state.current = nil
		return state
	end
	return state
end

local function stateIsEmpty(state)
	return (state.current == nil and state.previous == nil and state.future == nil)
end


-- [[ EFFECTS ]]
local function setState(state)
	vim.w.buffer_browser_previous = state.previous
	vim.w.buffer_browser_current = state.current
	vim.w.buffer_browser_future = state.future
end

local function getState()
	local current = vim.w.buffer_browser_current
	local previous = vim.w.buffer_browser_previous
	local future = vim.w.buffer_browser_future
	return {
		current = current,
		previous = previous,
		future = future,
	}
end

local function initState(bufNr)
	vim.w.buffer_browser_current = bufNr
	vim.w.buffer_browser_previous = {}
	vim.w.buffer_browser_future = {}
end

local function getBufNr()
	local winnr = api.nvim_tabpage_get_win(0)
	return api.nvim_win_get_buf(winnr)
end

local function getFiletype(bufnr)
	if (bufnr == nil) then
		return ''
	end
	return vim.bo[bufnr].filetype
end

--[[ AUTO COMMANDS ]]
function BufferBrowserBufferEnter(args)
	local bufNr = args.buf
	local filters = vim.g.buffer_browser_filters

	local state = getState()
	if stateIsEmpty(state) then
		initState(bufNr)
	else
		if (state.current ~= bufNr) then
			local stateFiletype = getFiletype(state.current)
			StateAppend(bufNr, stateFiletype, state, filters)
			setState(state)
		end
	end
end

function BufferBrowserBufferWipeOut(args)
	local buf = args.buf
	local state = getState()
	if not stateIsEmpty(state) then
		StateDelete(state, buf)
		setState(state)
	end
end

local BufferBrowserGroup = api.nvim_create_augroup('BufferBrowser', { clear = true })

api.nvim_create_autocmd({ 'WinEnter', 'BufEnter' },
	{
		group = BufferBrowserGroup,
		pattern = '*',
		callback = function(args)
			BufferBrowserBufferEnter(args)
		end
	}
)

-- BufWipeout is called before deletion
api.nvim_create_autocmd('BufWipeout',
	{
		group = BufferBrowserGroup,
		pattern = '*',
		callback = function(args)
			BufferBrowserBufferWipeOut(args)
		end
	}
)


--[[ COMMANDS ]]
local function next()
	local bufnr = getBufNr()
	local state = getState()

	if stateIsEmpty(state) then
		initState(bufnr)
	else
		StateGoForward(state)
		setState(state)
	end
	api.nvim_command('buffer ' .. state.current)
end

local function prev()
	local bufnr = getBufNr()
	local state = getState()

	if stateIsEmpty(state) then
		initState(bufnr)
	else
		StateGoBack(state)
		setState(state)
	end
	api.nvim_command('buffer ' .. state.current)
end

--[[ DEBUG ]]
local function printBrowserHistory()
	local state = getState()
	print('Browser State Previous: ' .. vim.inspect(state.previous))
	print('Browser State Current: ' .. vim.inspect(state.current))
	print('Browser State Future: ' .. vim.inspect(state.future))
end


--[[ SETUP ]]
local function setup(opts)
	if (opts == nil) then
		local default = {
			'gitcommit', 'TelescopePrompt'
		}
		vim.g.buffer_browser_filters = default
	else
		-- Filter is based on filetype
		vim.g.buffer_browser_filters = opts.filetype_filters
	end
end

return {
	next = next,
	prev = prev,
	printBrowserHistory = printBrowserHistory,
	setup = setup
}