summaryrefslogtreecommitdiff
path: root/VimperatorrcBuilder.py
blob: f21ffefa231eed1ac1b9493560ef98352f8b133d (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
# Copyright (C) 2014 Olivier Gayot
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

import time

class VimperatorrcBuilder():
	bookmarks = {}
	bookmark_pfx = '\\', '|'
	bang_shortcuts_pfx = 's', 'S'
	bang_shortcuts = {}
	default_engine = 'duckduckgo'
	toolbars = {
		'bookmarks': False,
		'addons': False,
		'menu': False,
		'navigation': True,
		'tabs': True,
		}

	cli_bindings = {
			'<C-j>': '<Return>',
			'<C-p>': '<Up>',
			'<C-n>': '<Down>',
			'<C-i>': '<Tab>',
			'<C-f>': '<Right>',
			'<C-b>': '<Left>',
			'<C-]>': '<Escape>',
			}

	vim_filetype = 'vim'

	def __init__(self):
		pass

	def register_bookmark(self, seq, url):
		""" Add a new bookmark and bind it to a given key-sequence """

		self.bookmarks[seq] = url

	def register_bang_shortcut(self, seq, bang_shortcut):
		""" Add a new bang shortcut and bind it to a key-sequence """

		self.bang_shortcuts[seq] = bang_shortcut

	def disable_toolbars(self):
		""" Disable the toolbars in the gui of the browser """

		self.toolbars['addons'] = False
		self.toolbars['bookmarks'] = False
		self.toolbars['menu'] = False
		self.toolbars['navigation'] = False
		self.toolbars['tabs'] = False

	def set_default_search_engine(self, engine):
		""" Set the default search engine (i.e. when you type 'open foo') """

		self.default_engine = engine

	def append_vim_filetype(self, filetype='vim'):
		""" Set how vim shall interpret the generated file """
		append_vim_filetype = filetype

	def disable_vim_filetype(self):
		""" Prevent the output of a vim: line """
		append_vim_filetype = None

	def get_output(self):
		''' Return a string containing the full output to redirect '''

		output = '" Generated using VimperatorrcBuilder\n'
		output += '" ' + time.ctime() + '\n'

		output += '\n" bookmarks\n'
		for key in self.bookmarks:
			output += 'map \'' + self.bookmark_pfx[0] + key + '\' :o<Space>' + self.bookmarks[key] + '<Return>\n'
			output += 'map \'' + self.bookmark_pfx[1] + key + '\' :t<Space>' + self.bookmarks[key] + '<Return>\n'

		output += '\n" default search engine\n'
		output += 'set defsearch=' + self.default_engine + '\n'

		output += '\n" toolbars displayed in the browser\n'
		output += 'set toolbars=' + ','.join(('no' if not value else '') + key for key,value in self.toolbars.items()) + '\n'

		output += '\n" bang shortcuts\n'
		for key in self.bang_shortcuts:
			output += "noremap '" + self.bang_shortcuts_pfx[0] + key + "' o!" + self.bang_shortcuts[key] + ' \n'
			output += "noremap '" + self.bang_shortcuts_pfx[1] + key + "' t!" + self.bang_shortcuts[key] + ' \n'

		output += '\n" command line bindings\n'
		for key in self.cli_bindings:
			output += 'cnoremap ' + key + ' ' + self.cli_bindings[key] + '\n'
			output += 'inoremap ' + key + ' ' + self.cli_bindings[key] + '\n'

		if self.vim_filetype is not None:
			# XXX dirty hack to avoid vim interpretation of the following line
			output += '\n" vim' + ': set ft=' + self.vim_filetype + ':\n'

		return output