-
Notifications
You must be signed in to change notification settings - Fork 4
/
ncl-doc.el
443 lines (381 loc) · 15.6 KB
/
ncl-doc.el
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
;;; ncl-doc.el --- NCL doc lookup helper
;; Copyright (C) 2011-2018 Yagnesh Raghava Yakkala <http://yagnesh.org>
;; Author: Yagnesh Raghava Yakkala <hi@yagnesh.org>
;; URL: https://github.com/yyr/ncl-mode
;; Maintainer: Yagnesh Raghava Yakkala <hi@yagnesh.org>
;; Package-Requires: ((ncl-mode "0.99a"))
;; Created: Saturday, September 24 2011
;; Keywords: doc,lookup,ncl
;; This file is NOT part of GNU Emacs.
;; ncl-doc.el 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 3 of the License, or
;; (at your option) any later version.
;; ncl-doc.el 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 file. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; ncl-doc minor mode helps you read NCL documentation from UCAR website
;; ----------------------------------------------------------
;; Setup: put the following your .emacs/init.el
;; (require 'ncl-doc)
;; (add-hook 'ncl-mode-hook
;; (lambda ()
;; (ncl-doc-minor-mode 1)))
;; ----------------------------------------------------------
;; Usage:
;; M-x ncl-doc-query-at-point ( C-c C-s )
;; This function does few things.
;; 1) It prompts for a string/keyword and collects a given string
;; 2) It tries to find a URL for the given string
;; + if it finds URL for the string call the browser to open that URL
;; + If no URL is found, then goes on to search for the given
;; string.
;; + Displays all search matches in separate buffer category wise.
;; In that buffer RET in any search match will call browser for
;; take you to that page.
;; + If no matches found for a given string it leaves you there
;;
;; M-x ncl-doc-query-open ( C-c C-o )
;; Use this function you lets you choose from the all keywords ncl-doc
;; has in its database and takes you to that page.
;;
;; ----------------------------------------------------------
;; Customization:
;; M-x customize-group RET ncl-doc RET
;; check out the following variables
;; `ncl-doc-url-base' defaults to "http://www.ncl.ucar.edu"
;; `ncl-doc-minor-mode-hook'
;; README.org file has little more info
;; ----------------------------------------------------------
;; acknowledgment:
;; Parts of the major mode section is based on pylookup.el
;;; Code:
(require 'ncl-mode-keywords)
(eval-when-compile
(require 'cl))
(defgroup ncl-doc nil
"*Ncl documentation lookup helper"
:group 'ncl
:group 'docs)
;;=================================================================
;; user options
;;=================================================================
(defcustom ncl-doc-url-base
"http://www.ncl.ucar.edu"
"Ncl documentation website base url. To construct URLs individual pages."
:group 'ncl-doc
:type 'string)
(defcustom ncl-doc-cache-dir ; cache is not yet implemented
"~/.ncl-doc/"
"Directory to store the cache."
:group 'ncl-doc
:type 'string)
(defcustom ncl-doc-mode-hook nil ; major mode hook
"Hook runs after enabling the `ncl-doc-mode' major mode."
:group 'ncl-doc)
(defcustom ncl-doc-minor-mode-hook nil
"Hook runs after enabling the ncl-doc-minormode-hook."
:group 'ncl-doc)
;;=================================================================
;; internal variables
;;=================================================================
(defvar ncl-doc-url-suffix
".shtml"
"Suffix of URLs. haven't checked if its same for all.")
(defvar ncl-doc-resources-page
"list_alpha_res.shtml"
"Suffix of URLs. haven't checked if its same for all.")
(defvar ncl-doc-url-alist
;;
'(("builtin" . "/Document/Functions/Built-in/")
("contrib" . "/Document/Functions/Contributed/")
("diag" . "/Document/Functions/Diagnostics/")
("pop" . "/Document/Functions/Pop_remap/")
("shea" . "/Document/Functions/Shea_util/")
("skewt" . "/Document/Functions/Skewt_func/")
("user" . "/Document/Functions/User_contributed/")
("wrfarw" . "/Document/Functions/WRF_arw/")
("wrfcontrib" . "/Document/Functions/WRF_contributed/")
("windrose" . "/Document/Functions/Wind_rose/")
("gsn" . "/Document/Graphics/Interfaces/")
("resources" . "/Document/Graphics/Resources/")
("keywords" . "Document/Manuals/Ref_Manual/")
) "Url alist for different categories.")
;;;
(defvar ncl-doc-key-cat
(mapcar (lambda (x)
(car x))
ncl-doc-url-alist)
"Categories in the ncl. This variable is prepared from `ncl-doc-url-alist'.")
(defvar ncl-doc-key-all
(apply 'append (mapcar (lambda (x)
(symbol-value (intern (format "ncl-key-%s" x))))
ncl-doc-key-cat))
"All keys in ncl.")
;;=================================================================
;; Internal functions
;;=================================================================
(defun ncl-doc-cache-dir-create ()
"Create cache dir."
(interactive)
(unless (file-directory-p ncl-doc-cache-dir)
(make-directory ncl-doc-cache-dir)))
;;; search functions
(defun ncl-doc-keys-search-cat (cat term)
"Search all CAT for a TERM."
(let ((cat-keys cat))
(remove nil
(mapcar (lambda (x)
(if (string-match term x)
x))
cat-keys))))
(defun ncl-doc-keys-search (term)
"Take a search TERM, Return an alist with all matched items.
Here alist is category and matched keywords."
(let* ((st term)
(cats (mapcar (lambda (x)
(car x))
ncl-doc-url-alist))
(cats (mapcar (lambda (x) ;make list of keyword vars
(concat "ncl-key-" x))
cats)))
(mapcar (lambda (cat)
(let ((klst (symbol-value (intern cat))))
(ncl-doc-keys-search-cat klst term)))
cats)))
;;; URL construction function
(defun ncl-doc-construct-url (kword)
"Construct a url from the KWORD."
(let ((kwd kword)
;; cats: all categories in the ncl-doc-url-alist
(cats (mapcar (lambda (cat)
(car cat))
ncl-doc-url-alist)))
(catch 'break
(while cats ; loop on all categories
(let ((ct (car cats)))
(if (member (format "%s" kwd)
(symbol-value (intern (concat "ncl-key-" ct))))
(throw 'break
(if (string= ct "resources")
(format "%s%s%s#%s"
ncl-doc-url-base (cdr (assoc ct ncl-doc-url-alist))
ncl-doc-resources-page kwd)
(if (string= ct "keywords")
"keyword"
(format "%s%s%s%s"
ncl-doc-url-base (cdr (assoc ct ncl-doc-url-alist))
kwd ncl-doc-url-suffix))))))
(setq cats (cdr cats))))))
;;=================================================================
;; Define minor mode
;;=================================================================
(defvar ncl-doc-minor-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-s") 'ncl-doc-query-at-point)
(define-key map (kbd "C-c C-p") 'ncl-doc-query-at-point)
(define-key map (kbd "C-c C-o") 'ncl-doc-query-open)
map)
"Key bindings function `ncl-doc-minor-mode'.")
;;;###autoload
(define-minor-mode ncl-doc-minor-mode
"Minor mode to help to read on line documentation of ncl
functions and resources
see the functions `ncl-doc-query-open' and `ncl-doc-query-at-point'
"
nil " ncl-doc"
:set 'custom-set-minor-mode
:initialize 'custom-initialize-default
:type 'boolean
:keymap ncl-doc-minor-mode-map
:group 'ncl-doc
:require 'ncl
(run-mode-hooks))
(defvar ncl-doc-completing-read
(if (null ido-mode) 'completing-read 'ido-completing-read)
"Ido support with convenience.")
;;=================================================================
;; Major Mode stuff
;;=================================================================
(defvar ncl-doc-temp-buffer-name
"*ncl doc buffer*")
(defvar ncl-doc-return-window-config nil
"Previous window config.")
(defvar ncl-doc-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-m" 'ncl-doc-browse-url)
(define-key map " " 'ncl-doc-browse-url)
(define-key map "f" 'ncl-doc-browse-url)
(define-key map "q" 'ncl-doc-quit-window)
(define-key map "Q" 'ncl-doc-exit-window)
(define-key map "n" 'ncl-doc-move-next-line)
(define-key map "p" 'ncl-doc-move-prev-line)
(define-key map "s" 'ncl-doc-query-at-point)
(define-key map "o" 'ncl-doc-query-open)
(define-key map "/" 'isearch-forward)
(define-key map "l" 'recenter)
(define-key map "<" 'beginning-of-buffer)
(define-key map ">" 'end-of-buffer)
(define-key map "v" 'scroll-down)
map)
"Keymap for `ncl-doc-mode'.")
(define-derived-mode ncl-doc-mode fundamental-mode "ncl-doc"
"major mode to help read NCL docs from UCAR website"
:group 'ncl-doc
(kill-all-local-variables)
(setq mode-name "ncl-doc")
(use-local-map ncl-doc-mode-map)
(setq buffer-read-only t)
(run-mode-hooks))
(defun ncl-doc-move-prev-line ()
"Move to previous entry."
(interactive)
(when (< 3 (line-number-at-pos))
(call-interactively 'previous-line)))
(defun ncl-doc-move-next-line ()
"Move to next entry."
(interactive)
(when (< (line-number-at-pos)
(- (line-number-at-pos (point-max)) 1))
(call-interactively 'next-line)))
(defun ncl-doc-browse-url ()
"Lookup the current line in a browser."
(interactive)
(beginning-of-line)
(let* ((wd (thing-at-point 'symbol))
(url (ncl-doc-construct-url wd)))
(if url
(if (string= url "keyword")
(message "\"%s\" is a NCL builtin keyword and has no specific page to look at
Consult User Manual Here: http://www.ncl.ucar.edu/Document/Manuals/Ref_Manual/"
wd)
(progn
(message "Browsing: \"%s\"" url)
(browse-url url)))
(error "No URL on this line"))))
(defun ncl-doc-exit-window ()
"Leave the completions window."
(interactive)
(let ((buf (current-buffer)))
(set-window-configuration ncl-doc-return-window-config)
(kill-buffer buf)))
(defun ncl-doc-quit-window ()
"Leave the completions window."
(interactive)
(set-window-configuration ncl-doc-return-window-config))
;;=================================================================
;; user functions
;;=================================================================
;;;###autoload
(defun ncl-doc-query-at-point ()
"Ask for a keyword to search and match inbuilt function."
(interactive)
(let* ((default-word (thing-at-point 'symbol))
(default-prompt
(concat "NCL Keyword "
(if default-word
(concat "[" default-word "]") nil) ": "))
(default-query
(funcall #'(lambda (str)
"Remove Whitespace from beginning and end of a string."
(replace-regexp-in-string "^[ \n\t]*\\(.*?\\)[ \n\t]*$"
"\\1"
str))
(completing-read default-prompt ncl-doc-key-all))))
(if (= 0 (string-width default-query)) ;protect if the user input is empty
(set 'default-query default-word)) ;then it should be default word only
(if (string= "" default-query)
(message "default-query is nothing "))
(let ((url (ncl-doc-construct-url default-query)))
;; if url is a keyword tell that there is no url for that
(if (string= url "keyword") ; if its a ncl keyword its in the ref manual
(message "\"%s\" is a NCL builtin keyword and has no specific page to look at
Consult User Manual Here: http://www.ncl.ucar.edu/Document/Manuals/Ref_Manual/"
default-query)
(if url
;; gets an url call the browser
(progn
(message "Browsing: \"%s\"" url)
(browse-url url))
;; lets try if search bring anything
(let ((matches (ncl-doc-keys-search default-query)))
(cond
((eq (remove nil matches) nil)
;; no search results; leave with fun message
(message
":( May NCL GOD will help you; NO search results for \"%s\" from all keywords"
default-query))
;; if any matches call the major mode to display
(t
(let* ((cur-window-conf (current-window-configuration))
(tmpbuf (get-buffer-create ncl-doc-temp-buffer-name)))
(display-buffer tmpbuf)
(pop-to-buffer tmpbuf)
(setq buffer-read-only nil)
(erase-buffer)
;; Write what we are looking for
(insert (format "NCL keyword Search for \"%s\":"
default-query))
(insert "\n")
;; insert text
(let ((idx 0)
(ln (length ncl-doc-key-cat)))
(while (> ln idx)
(let ((ct (nth idx ncl-doc-key-cat))
(mts (nth idx matches)))
(if mts
(insert (format "\n;; Matches in the category \"%s\":\n" ct)))
;; loop over matches
(mapc (lambda (x)
(insert (format "%s\n" x)))
mts))
(incf idx)))
(goto-char (point-min))
(forward-line (1- 3))
;; Major mode stuff
(ncl-doc-mode)
(font-lock-add-keywords
nil
'("\\(^;.*\\)"
(1 font-lock-comment-face)))
(font-lock-add-keywords
nil `((,(format "\\(%s\\|%s\\|%s\\)"
default-query
(upcase default-query)
(upcase-initials default-query))
1
font-lock-warning-face prepend)))
(setq font-lock-keywords-case-fold-search t)
;; store window conf
(set (make-local-variable 'ncl-doc-return-window-config)
cur-window-conf)
;; make fit to screen
(shrink-window-if-larger-than-buffer (get-buffer-window tmpbuf)))))))))))
;;;###autoload
(defun ncl-doc-query-open (keyword)
"Queries for a KEYWORD and search the database for it to gather
its documentation url. Then calls web browser to open that url."
(interactive
(list
(let ((initial (thing-at-point 'symbol)))
(funcall ncl-doc-completing-read
"Query: " ncl-doc-key-all nil nil initial t))))
(let ((url (ncl-doc-construct-url keyword)))
(progn
(message "Browsing: \"%s\"" url)
(browse-url url))))
;;;###autoload
(eval-after-load 'ncl-mode
;; load the keys for ncl
'(add-hook 'ncl-mode-hook 'ncl-doc-minor-mode))
;;;###autoload
(eval-after-load 'inf-ncl
;; load the keys for ncl
'(add-hook 'ncl-mode-hook 'ncl-doc-minor-mode))
(provide 'ncl-doc)
;;; ncl-doc.el ends here