-
Notifications
You must be signed in to change notification settings - Fork 9
/
q_goto_documentation.py
186 lines (145 loc) · 6.94 KB
/
q_goto_documentation.py
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
# GotoDocumentation Sublime Plugin
# Jun 2014
#modified from GotoDocumentation to work with q/kdb
import webbrowser
import sublime, sublime_plugin
import re, os
import subprocess
default_docs = {
"ahk": "http://www.autohotkey.com/docs/commands/%(query)s.htm",
"rails": "http://api.rubyonrails.org/?q=%(query)s",
"controller": "http://api.rubyonrails.org/?q=%(query)s",
"ruby": "http://ruby-doc.com/search.html?q=%(query)s",
"js": "https://developer.mozilla.org/en-US/search?q=%(query)s&topic=js",
"html": "https://developer.mozilla.org/en-US/search?q=%(query)s&topic=html",
"coffee": "https://developer.mozilla.org/en-US/search?q=%(query)s",
"php": "http://php.net/manual-lookup.php?pattern=%(query)s",
"clojure": "http://clojuredocs.org/search?x=0&y=0&q=%(query)s",
"go": "http://golang.org/search?q=%(query)s",
"c": "http://www.cplusplus.com/search.do?q=%(query)s",
"cpp": "http://www.cplusplus.com/search.do?q=%(query)s",
"smarty": "http://www.smarty.net/%(query)s",
"cmake": "http://cmake.org/cmake/help/v2.8.8/cmake.html#command:%(query)s",
"perl": "http://perldoc.perl.org/search.html?q=%(query)s",
"cs": "http://social.msdn.microsoft.com/Search/?query=%(query)s",
"lua": "http://pgl.yoyo.org/luai/i/%(query)s",
"pgsql": "http://www.postgresql.org/search/?u=%%2Fdocs%%2Fcurrent%%2F&q=%(query)s",
"erlang": "http://erldocs.com/R16B03/?search=%(query)s",
"haskell": "http://hayoo.fh-wedel.de/?query=%(query)s",
"scala": "http://scalex.org/?q=%(query)s",
"css": "http://devdocs.io/#q=%(scope)s+%(query)s",
"scss": "http://devdocs.io/#q=%(scope)s+%(query)s",
"less": "http://devdocs.io/#q=%(scope)s+%(query)s",
"google": "https://google.com/search?q=%(scope)s+%(query)s",
"python": {
"command": ["python", "-m", "pydoc", "%(query)s"],
"failTest": ".*no Python documentation found for.*",
"changeMatch": "(Related help topics)",
"changeWith": "-------\n\\1",
"url": "http://docs.python.org/3/search.html?q=%(query)s"
}
}
def combineDicts(dictionary1, dictionary2):
new_dict = dictionary1.copy()
new_dict.update(dictionary2)
return new_dict
class QGotoDocumentationCommand(sublime_plugin.TextCommand):
"""
Search the selected text or the current word
"""
def run(self, edit):
# grab the word or the selection from the view
for region in self.view.sel():
location = False
if region.empty():
# if we have no selection grab the current word
location = self.view.word(region)
else:
# grab the selection
location = region
if location and not location.empty():
q = self.view.substr(location)
else:
# if no word, just open the reference card
q = '' #empty query string will open reference card
scope = self.view.scope_name(location.begin()).rpartition('.')[2].strip()
self.open_doc(q, scope)
def open_doc(self, query, scope):
settings = sublime.load_settings("goto_documentation.sublime-settings")
substitue_map = settings.get('substitute')
# attach the prefix and suffix
query = settings.get('prefix', '') + query + settings.get('suffix', '')
# merge the default docs with the one provided by the user
docs = combineDicts(default_docs, settings.get('docs'))
if not scope in docs:
scope = settings.get('fallback_scope', 'google')
if not scope in docs:
self.show_status("No docs available for the current scope !")
return
if scope == "q":
print("before " + scope + ":" + query)
query = query.lower()
if (scope in substitue_map and query in substitue_map[scope]):
query = substitue_map[scope][query]
query = query.replace("\\", "") # backslash causes Sublime on OSX to open all available browsers
print("after " + scope + ":" + query)
# if we have the scope defined in settings
# build the url and open it
doc = docs[scope]
# if it is a dict we must have:
# - a command to run
# - a regex to check against
# - an optional fallback url
if type(doc) is dict:
# build the command
command = [x%{'query': query, 'scope': scope} for x in doc['command']]
# Per http://bugs.python.org/issue8557 shell=True
shell = os.name == 'nt'
# run it
process = subprocess.Popen(command, shell=shell, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
stdout = [x.decode('unicode_escape').rstrip() for x in process.stdout.readlines()]
stdout = '\n'.join(stdout)
# match the result agains the regex
reg = re.compile(doc['failTest'])
if reg.match(stdout):
# use the fallback url
if 'url' in doc:
fullUrl = doc['url']%{'query': query, 'scope': scope}
webbrowser.open(fullUrl)
else:
self.show_status("No docs available for the current word !")
else:
# regex to change something before it's sent to the panel
if 'changeMatch' in doc and 'changeWith' in doc:
stdout = re.sub(doc['changeMatch'], doc['changeWith'], stdout)
# we have a valid result from console
# so we place it in the output panel
self.panel(stdout)
else:
if not doc:
self.show_status("This scope is disabled !")
return
# we have an url so we build and open it
fullUrl = doc%{'query': query, 'scope': scope}
webbrowser.open(fullUrl)
# Open and write on the output panel
def panel(self, output):
active_window = sublime.active_window()
if not hasattr(self, 'output_view'):
self.output_view = active_window.get_output_panel("gotodocumentation")
self.output_view.set_read_only(False)
self.output_view.run_command('goto_documentation_output', {
'output': output,
'clear': True
})
self.output_view.set_read_only(True)
active_window.run_command("show_panel", {"panel": "output.gotodocumentation"})
def show_status(self, status):
sublime.status_message(status)
print("\nGoto Documentation Plugin: " + status + "\n")
class GotoDocumentationOutputCommand(sublime_plugin.TextCommand):
def run(self, edit, output = '', output_file = None, clear = False):
if clear:
region = sublime.Region(0, self.view.size())
self.view.erase(edit, region)
self.view.insert(edit, 0, output)