Mercurial > emacs
annotate lisp/progmodes/idlw-help.el @ 79207:f19edd342e7b
Comment change.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 24 Oct 2007 08:24:36 +0000 |
parents | c1ec1c8a8d2e |
children | a1342e6e097a a55a536ce0db |
rev | line source |
---|---|
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1 ;;; idlw-help.el --- HTML Help code for IDLWAVE |
75347 | 2 |
3 ;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 | |
4 ;; Free Software Foundation, Inc. | |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
5 ;; |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
6 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu> |
64001
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
7 ;; Carsten Dominik <dominik@science.uva.nl> |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
8 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu> |
74105
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
9 ;; Version: 6.1_em22 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
10 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
11 ;; This file is part of GNU Emacs. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
12 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
13 ;; This file is free software; you can redistribute it and/or modify |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
14 ;; it under the terms of the GNU General Public License as published by |
78234
c1ec1c8a8d2e
Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents:
76395
diff
changeset
|
15 ;; the Free Software Foundation; either version 3, or (at your option) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
16 ;; any later version. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
17 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
18 ;; This file is distributed in the hope that it will be useful, |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
21 ;; GNU General Public License for more details. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
22 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
23 ;; You should have received a copy of the GNU General Public License |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
64085 | 25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 ;; Boston, MA 02110-1301, USA. | |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
27 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
28 ;;; Commentary: |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
29 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
30 ;; The help link information for IDLWAVE's online help feature for |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
31 ;; system routines is extracted automatically from the IDL |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
32 ;; documentation, and is available, along with general routine |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
33 ;; information, in the file idlw-rinfo.el. The HTML help file |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
34 ;; themselves are not distributable with Emacs, but are available, |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
35 ;; along with new versions of IDLWAVE, documentation, and more |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
36 ;; information, at: |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
37 ;; |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
38 ;; http://idlwave.org |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
39 ;; |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
40 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
41 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
42 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
43 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
44 ;;; Code: |
64001
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
45 (defvar idlwave-help-browse-url-available nil |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
46 "Whether browse-url is available") |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
47 |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
48 (setq idlwave-help-browse-url-available |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
49 (condition-case nil |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
50 (require 'browse-url) |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
51 (error nil))) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
52 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
53 (defgroup idlwave-online-help nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
54 "Online Help options for IDLWAVE mode." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
55 :group 'idlwave) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
56 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
57 (defcustom idlwave-html-help-pre-v6 nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
58 "Whether pre or post-v6.0 IDL help documents are being used." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
59 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
60 :type 'boolean) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
61 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
62 (defvar idlwave-html-link-sep |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
63 (if idlwave-html-help-pre-v6 "#" "#wp")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
64 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
65 (defcustom idlwave-html-system-help-location "help/online_help/" |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
66 "The directory, relative to idlwave-system-directory, where the idl |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
67 HTML help files live, for IDL 6.2 and later. This location, if found, |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
68 is used in preference to the old idlwave-html-help-location." |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
69 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
70 :type 'directory) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
71 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
72 (defcustom idlwave-html-help-location |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
73 (if (memq system-type '(ms-dos windows-nt)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
74 nil |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
75 "/usr/local/etc/") |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
76 "The directory where the idl_html_help/ dir lives. Obsolete for IDL |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
77 6.2 or later (see idlwave-html-system-help-location)." |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
78 :group 'idlwave-online-help |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
79 :type 'directory) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
80 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
81 (defvar idlwave-help-use-hh nil |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
82 "Obsolete variable.") |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
83 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
84 (defcustom idlwave-help-use-assistant t |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
85 "Whether to use the IDL Assistant as the help browser." |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
86 :group 'idlwave-online-help |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
87 :type 'boolean) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
88 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
89 (defcustom idlwave-help-browser-function browse-url-browser-function |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
90 "Function to use to display html help. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
91 Defaults to `browse-url-browser-function', which see." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
92 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
93 :type 'function) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
94 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
95 (defcustom idlwave-help-browser-generic-program browse-url-generic-program |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
96 "Program to run if using browse-url-generic-program." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
97 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
98 :type 'string) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
99 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
100 (defvar browse-url-generic-args) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
101 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
102 (defcustom idlwave-help-browser-generic-args |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
103 (if (boundp 'browse-url-generic-args) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
104 browse-url-generic-args "") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
105 "Program args to use if using browse-url-generic-program." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
106 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
107 :type 'string) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
108 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
109 (defcustom idlwave-help-browser-is-local nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
110 "Whether the browser will display locally in an Emacs window. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
111 Several browsers run and/or display inside Emacs windows, but most are |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
112 external programs. If the browser name contains \"-w3\", it is |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
113 assumed to be local to Emacs. For other local browsers, this variable |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
114 must be explicitly set non-nil in order for the variable |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
115 `idlwave-help-use-dedicated-frame' to function." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
116 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
117 :type 'boolean) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
118 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
119 (defvar idlwave-help-directory "" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
120 "Obsolete variable. See idlwave-html-help-location.") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
121 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
122 (defcustom idlwave-help-use-dedicated-frame t |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
123 "*Non-nil means, use a separate frame for Online Help if possible." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
124 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
125 :type 'boolean) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
126 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
127 (defcustom idlwave-help-frame-parameters |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
128 '((height . 32) (unsplittable . t)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
129 "The frame parameters for the special Online Help frame. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
130 See also `idlwave-help-use-dedicated-frame'. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
131 If you do not set the frame width here, the value specified in |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
132 `idlw-help.el' will be used." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
133 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
134 :type '(repeat |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
135 (cons symbol sexp))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
136 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
137 (defcustom idlwave-max-popup-menu-items 20 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
138 "Maximum number of items per pane in popup menus. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
139 Currently only used for class selection during completion help." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
140 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
141 :type 'integer) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
142 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
143 (defcustom idlwave-extra-help-function 'idlwave-help-with-source |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
144 "The function to call for online help if the normal help fails. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
145 Online help works only for system routines which are described in the |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
146 IDL manuals. A function may be specified to access help from other sources. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
147 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
148 The function must accept four arguments: NAME, TYPE, CLASS, KEYWORD. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
149 The Help buffer is current when this function is called, and the help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
150 text should be loaded into this buffer. If help is found, the |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
151 function should return the buffer position which should be used as |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
152 `window-start' in the help window. Also, the variable |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
153 `idlwave-help-mode-line-indicator' should be set to a useful string, |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
154 which will be displayed in the mode line of the help window. If |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
155 should also set the variable `idlwave-help-min-frame-width' to a |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
156 positive integer. IDLWAVE will ensure that the help frame is at least |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
157 that many columns wide. Failure to find help should be indicated by |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
158 throwing an error. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
159 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
160 When this variable is non-nil, IDLWAVE will allow the mouse-3 help click |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
161 for every routine and keyword, even though the item may not be highlighted |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
162 in blue (indicating the availability of system documentation). |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
163 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
164 The default value for this function is `idlwave-help-with-source' which |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
165 loads the routine source file into the help buffer. If you try to write |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
166 a different function which accesses a special help file or so, it is |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
167 probably a good idea to still call this function as a fallback." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
168 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
169 :type 'symbol) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
170 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
171 (defcustom idlwave-help-fontify-source-code nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
172 "*Non-nil means, fontify source code displayed as help like normal code." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
173 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
174 :type 'boolean) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
175 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
176 (defcustom idlwave-help-source-try-header t |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
177 "*Non-nil means, try to find help in routine header when displaying source. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
178 Routines which are not documented in the system manual use their source as |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
179 help text. When this variable is non-nil, we try to find a description of |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
180 the help item in the first routine doclib header above the routine definition. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
181 If the variable is nil, or if we cannot find/parse the header, the routine |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
182 definition is displayed instead." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
183 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
184 :type 'boolean) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
185 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
186 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
187 (defcustom idlwave-help-doclib-name "name" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
188 "*A regexp for the heading word to search for in doclib headers |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
189 which specifies the `name' section. Can be used for localization |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
190 support." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
191 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
192 :type 'string) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
193 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
194 (defcustom idlwave-help-doclib-keyword "KEYWORD" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
195 "*A regexp for the heading word to search for in doclib headers |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
196 which specifies the `keywords' section. Can be used for localization |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
197 support." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
198 :group 'idlwave-online-help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
199 :type 'string) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
200 |
63450
87216f91a211
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-413
Miles Bader <miles@gnu.org>
parents:
62772
diff
changeset
|
201 (defface idlwave-help-link |
64001
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
202 '((((class color)) (:foreground "Blue")) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
203 (t (:weight bold))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
204 "Face for highlighting links into IDLWAVE online help." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
205 :group 'idlwave-online-help) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
206 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
207 (defvar idlwave-help-activate-links-aggressively nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
208 "Obsolete variable.") |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
209 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
210 (defvar idlwave-completion-help-info) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
211 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
212 (defvar idlwave-help-frame nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
213 "The frame for display of IDL online help.") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
214 (defvar idlwave-help-frame-width 102 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
215 "The default width of the help frame.") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
216 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
217 (defvar idlwave-html-help-is-available nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
218 "Is the system online help text avaiable?") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
219 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
220 (defvar idlwave-help-mode-line-indicator "" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
221 "Used for the special mode line in the idlwave-help-mode.") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
222 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
223 (defvar idlwave-help-window-configuration nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
224 (defvar idlwave-help-special-topic-words nil) ; defined by get_rinfo |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
225 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
226 ;; Define the key bindings for the Help application |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
227 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
228 (defvar idlwave-help-mode-map (make-sparse-keymap) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
229 "The keymap used in idlwave-help-mode.") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
230 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
231 (define-key idlwave-help-mode-map "q" 'idlwave-help-quit) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
232 (define-key idlwave-help-mode-map "w" 'widen) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
233 (define-key idlwave-help-mode-map "\C-m" (lambda (arg) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
234 (interactive "p") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
235 (scroll-up arg))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
236 (define-key idlwave-help-mode-map " " 'scroll-up) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
237 (define-key idlwave-help-mode-map [delete] 'scroll-down) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
238 (define-key idlwave-help-mode-map "h" 'idlwave-help-find-header) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
239 (define-key idlwave-help-mode-map "H" 'idlwave-help-find-first-header) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
240 (define-key idlwave-help-mode-map "." 'idlwave-help-toggle-header-match-and-def) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
241 (define-key idlwave-help-mode-map "F" 'idlwave-help-fontify) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
242 (define-key idlwave-help-mode-map "\M-?" 'idlwave-help-return-to-calling-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
243 (define-key idlwave-help-mode-map "x" 'idlwave-help-return-to-calling-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
244 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
245 ;; Define the menu for the Help application |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
246 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
247 (easy-menu-define |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
248 idlwave-help-menu idlwave-help-mode-map |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
249 "Menu for Help IDLWAVE system" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
250 '("IDLHelp" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
251 ["Definition <-> Help Text" idlwave-help-toggle-header-match-and-def t] |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
252 ["Find DocLib Header" idlwave-help-find-header t] |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
253 ["Find First DocLib Header" idlwave-help-find-first-header t] |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
254 ["Fontify help buffer" idlwave-help-fontify t] |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
255 "--" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
256 ["Quit" idlwave-help-quit t])) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
257 |
64001
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
258 (defvar idlwave-help-def-pos) |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
259 (defvar idlwave-help-args) |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
260 (defvar idlwave-help-in-header) |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
261 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
262 (defun idlwave-help-mode () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
263 "Major mode for displaying IDL Help. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
264 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
265 This is a VIEW mode for the ASCII version of IDL Help files, |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
266 with some extras. Its main purpose is speed - so don't |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
267 expect a fully hyper-linked help. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
268 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
269 Scrolling: SPC DEL RET |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
270 Text Searches: Inside Topic: Use Emacs search functions |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
271 Exit: [q]uit or mouse button 3 will kill the frame |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
272 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
273 When the hep text is a source file, the following commands are available |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
274 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
275 Fontification: [F]ontify the buffer like source code |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
276 Jump: [h] to function doclib header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
277 [H] to file doclib header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
278 [.] back and forward between header and definition |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
279 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
280 Here are all keybindings. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
281 \\{idlwave-help-mode-map}" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
282 (kill-all-local-variables) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
283 (buffer-disable-undo) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
284 (setq major-mode 'idlwave-help-mode |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
285 mode-name "IDLWAVE Help") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
286 (use-local-map idlwave-help-mode-map) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
287 (easy-menu-add idlwave-help-menu idlwave-help-mode-map) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
288 (setq truncate-lines t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
289 (setq case-fold-search t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
290 (setq mode-line-format |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
291 (list "" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
292 'mode-line-modified |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
293 'mode-line-buffer-identification |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
294 ": " 'idlwave-help-mode-line-indicator |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
295 " -%-")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
296 (setq buffer-read-only t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
297 (set (make-local-variable 'idlwave-help-def-pos) nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
298 (set (make-local-variable 'idlwave-help-args) nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
299 (set (make-local-variable 'idlwave-help-in-header) nil) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
300 (run-hooks 'idlwave-help-mode-hook)) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
301 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
302 (defun idlwave-html-help-location () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
303 "Return the help directory where HTML files are, or nil if that is unknown." |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
304 (let ((syshelp-dir (expand-file-name |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
305 idlwave-html-system-help-location (idlwave-sys-dir))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
306 (help-dir (or (and (stringp idlwave-html-help-location) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
307 (> (length idlwave-html-help-location) 0) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
308 idlwave-html-help-location) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
309 (getenv "IDLWAVE_HELP_LOCATION")))) |
74105
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
310 (if (and syshelp-dir (file-directory-p syshelp-dir)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
311 syshelp-dir |
74105
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
312 (if help-dir |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
313 (progn |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
314 (setq help-dir (expand-file-name "idl_html_help" help-dir)) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
315 (if (file-directory-p help-dir) help-dir)))))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
316 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
317 (defvar idlwave-help-assistant-available nil) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
318 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
319 (defun idlwave-help-check-locations () |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
320 ;; Check help locations and assistant. |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
321 (let ((sys-dir (idlwave-sys-dir)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
322 (help-loc (idlwave-html-help-location))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
323 (if (or (not (file-directory-p sys-dir)) |
74105
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
324 (not help-loc) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
325 (not (file-directory-p help-loc))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
326 (message |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
327 "HTML help location not found: try setting `idlwave-system-directory' and/or `idlwave-html-help-location'.")) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
328 ;; see if we have the assistant |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
329 (when (and idlwave-help-use-assistant |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
330 (not (eq (idlwave-help-assistant-available) t))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
331 (message "Cannot locate IDL Assistant, enabling default browser.") |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
332 (setq idlwave-help-use-assistant nil) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
333 (unless idlwave-help-browse-url-available |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
334 (error "browse-url is not available; install it or IDL Assistant to use HTML help."))))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
335 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
336 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
337 (defvar idlwave-current-obj_new-class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
338 (defvar idlwave-help-diagnostics) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
339 (defvar idlwave-experimental) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
340 (defvar idlwave-last-context-help-pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
341 (defun idlwave-do-context-help (&optional arg) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
342 "Wrapper around the call to idlwave-context-help1. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
343 It collects and prints the diagnostics messages." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
344 (let ((marker (list (current-buffer) (point))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
345 (idlwave-help-diagnostics nil)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
346 ;; Check for frame switching. When the command is invoked twice |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
347 ;; at the same position, we try to switch to the help frame |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
348 ;; FIXME: Frame switching works only on XEmacs |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
349 (if (and idlwave-experimental |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
350 (equal last-command this-command) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
351 (equal idlwave-last-context-help-pos marker)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
352 (idlwave-help-select-help-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
353 ;; Do the real thing. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
354 (setq idlwave-last-context-help-pos marker) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
355 (idlwave-do-context-help1 arg) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
356 (if idlwave-help-diagnostics |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
357 (message "%s" (mapconcat 'identity |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
358 (nreverse idlwave-help-diagnostics) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
359 "; ")))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
360 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
361 (defvar idlwave-help-do-class-struct-tag nil) |
64001
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
362 (defvar idlwave-structtag-struct-location) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
363 (defvar idlwave-help-do-struct-tag nil) |
64001
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
364 (defvar idlwave-system-variables-alist) |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
365 (defvar idlwave-executive-commands-alist) |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
366 (defvar idlwave-system-class-info) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
367 (defun idlwave-do-context-help1 (&optional arg) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
368 "The work-horse version of `idlwave-context-help', which see." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
369 (save-excursion |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
370 (if (equal (char-after) ?/) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
371 (forward-char 1) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
372 (if (equal (char-before) ?=) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
373 (backward-char 1))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
374 (let* ((idlwave-query-class nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
375 (idlwave-force-class-query (equal arg '(4))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
376 (chars "a-zA-Z0-9_$.!") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
377 (beg (save-excursion (skip-chars-backward chars) (point))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
378 (end (save-excursion (skip-chars-forward chars) (point))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
379 (this-word (buffer-substring-no-properties beg end)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
380 (st-ass (assoc-string this-word |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
381 idlwave-help-special-topic-words t)) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
382 (classtag (and (string-match "self\\." this-word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
383 (< beg (- end 4)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
384 (structtag (and (fboundp 'idlwave-complete-structure-tag) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
385 (string-match "\\`\\([^.]+\\)\\." this-word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
386 (< beg (- end 4)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
387 module keyword cw mod1 mod2 mod3) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
388 (if (or arg |
76395
144d0dd66d84
(idlwave-do-context-help1): Don't visit special help topics for
J.D. Smith <jdsmith@as.arizona.edu>
parents:
75347
diff
changeset
|
389 (and (not classtag) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
390 (not structtag) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
391 (not (member (string-to-char this-word) '(?! ?.))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
392 ;; Need the module information |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
393 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
394 ;; MODULE is (name type class), for this or any inheriting class |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
395 (setq module (idlwave-what-module-find-class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
396 cw (nth 2 (idlwave-where))) ;what would we complete here? |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
397 ;; Correct for OBJ_NEW, we may need an INIT method instead. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
398 (if (equal (idlwave-downcase-safe (car module)) "obj_new") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
399 (let* ((bos (save-excursion (idlwave-beginning-of-statement) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
400 (point))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
401 (str (buffer-substring bos (point)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
402 (if (string-match "OBJ_NEW([ \t]*['\"]\\([a-zA-Z][a-zA-Z0-9$_]+\\)['\"]" str) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
403 (setq module (list "init" 'fun (match-string 1 str)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
404 idlwave-current-obj_new-class (match-string 1 str)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
405 ))))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
406 (cond |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
407 (arg (setq mod1 module)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
408 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
409 ;; A special topic -- only system help |
76395
144d0dd66d84
(idlwave-do-context-help1): Don't visit special help topics for
J.D. Smith <jdsmith@as.arizona.edu>
parents:
75347
diff
changeset
|
410 ((and st-ass (not (memq cw '(function-keyword procedure-keyword)))) |
144d0dd66d84
(idlwave-do-context-help1): Don't visit special help topics for
J.D. Smith <jdsmith@as.arizona.edu>
parents:
75347
diff
changeset
|
411 (setq mod1 (list (cdr st-ass)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
412 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
413 ;; A system variable -- only system help |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
414 ((string-match |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
415 "\\`!\\([a-zA-Z0-9_]+\\)\\(\.\\([A-Za-z0-9_]+\\)\\)?" |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
416 this-word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
417 (let* ((word (match-string-no-properties 1 this-word)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
418 (entry (assq (idlwave-sintern-sysvar word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
419 idlwave-system-variables-alist)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
420 (tag (match-string-no-properties 3 this-word)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
421 (tag-target (if tag |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
422 (cdr |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
423 (assq (idlwave-sintern-sysvartag tag) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
424 (cdr (assq 'tags entry)))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
425 (link (nth 1 (assq 'link entry)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
426 (if tag-target |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
427 (setq link (idlwave-substitute-link-target link |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
428 tag-target))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
429 (setq mod1 (list link)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
430 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
431 ;; An executive command -- only system help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
432 ((string-match "^\\.\\([A-Z_]+\\)" this-word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
433 (let* ((word (match-string 1 this-word)) |
62121
9d18baf82550
(idlwave-do-context-help1, idlwave-highlight-linked-completions): Replace
Juanma Barranquero <lekktu@gmail.com>
parents:
61394
diff
changeset
|
434 (link (cdr (assoc-string |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
435 word |
64001
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
436 idlwave-executive-commands-alist t)))) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
437 (setq mod1 (list link)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
438 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
439 ;; A class -- system OR in-text help (via class__define). |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
440 ((and (eq cw 'class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
441 (or (idlwave-in-quote) ; e.g. obj_new |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
442 (re-search-backward "\\<inherits[ \t]+[A-Za-z0-9_]*\\=" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
443 (max (point-min) (- (point) 40)) t))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
444 ;; Class completion inside string delimiters must be |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
445 ;; the class inside OBJ_NEW. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
446 (let* ((entry (assq |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
447 (idlwave-sintern-class this-word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
448 idlwave-system-class-info)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
449 (name (concat (downcase this-word) "__define")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
450 (link (nth 1 (assq 'link entry)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
451 (setq mod1 (list link name 'pro)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
452 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
453 ;; A class structure tag (self.BLAH) -- only in-text help available |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
454 (classtag |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
455 (let ((tag (substring this-word (match-end 0))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
456 class-with found-in) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
457 (when (setq class-with |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
458 (idlwave-class-or-superclass-with-tag |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
459 (nth 2 (idlwave-current-routine)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
460 tag)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
461 (setq found-in (idlwave-class-found-in class-with)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
462 (if (assq (idlwave-sintern-class class-with) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
463 idlwave-system-class-info) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
464 (error "No help available for system class tags")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
465 (setq idlwave-help-do-class-struct-tag t) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
466 (setq mod1 (list nil |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
467 (if found-in |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
468 (cons (concat found-in "__define") class-with) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
469 (concat class-with "__define")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
470 'pro |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
471 nil ; no class.... it's a procedure! |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
472 tag))))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
473 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
474 ;; A regular structure tag -- only in text, and if |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
475 ;; optional `complete-structtag' loaded. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
476 (structtag |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
477 (let ((var (match-string 1 this-word)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
478 (tag (substring this-word (match-end 0)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
479 ;; Check if we need to update the "current" structure |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
480 (idlwave-prepare-structure-tag-completion var) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
481 (setq idlwave-help-do-struct-tag |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
482 idlwave-structtag-struct-location |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
483 mod1 (list nil nil nil nil tag)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
484 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
485 ;; A routine keyword -- in text or system help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
486 ((and (memq cw '(function-keyword procedure-keyword)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
487 (stringp this-word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
488 (string-match "\\S-" this-word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
489 (not (string-match "!" this-word))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
490 (cond ((or (= (char-before beg) ?/) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
491 (save-excursion (goto-char end) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
492 (looking-at "[ \t]*="))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
493 ;; Certainly a keyword. Check for abbreviation etc. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
494 (setq keyword (idlwave-expand-keyword this-word module)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
495 (cond |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
496 ((null keyword) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
497 (idlwave-help-diagnostics |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
498 (format "%s does not accept `%s' kwd" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
499 (idlwave-make-full-name (nth 2 module) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
500 (car module)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
501 (upcase this-word)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
502 'ding)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
503 ((consp keyword) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
504 (idlwave-help-diagnostics |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
505 (format "%d matches for kwd abbrev `%s'" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
506 (length keyword) this-word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
507 'ding) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
508 ;; We continue anyway with the first match... |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
509 (setq keyword (car keyword)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
510 ;; Keyword, or just module |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
511 (setq mod1 (append (list t) module (list keyword))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
512 (setq mod2 (append (list t) module))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
513 ((equal (char-after end) ?\() |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
514 ;; A function - what-module will have caught this |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
515 (setq mod1 (append (list t) module))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
516 (t |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
517 ;; undecided - try function, keyword, then enclosing mod. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
518 ;; Check for keyword abbreviations, but do not report |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
519 ;; errors, because it might be something else. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
520 ;; FIXME: is this a good way to handle this? |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
521 (setq keyword (idlwave-expand-keyword this-word module)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
522 (if (consp keyword) (setq keyword (car keyword))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
523 (setq mod1 (append (list t) module (list keyword)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
524 mod2 (list t this-word 'fun nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
525 mod3 (append (list t) module))))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
526 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
527 ;; Everything else |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
528 (t |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
529 (setq mod1 (append (list t) module)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
530 (if mod3 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
531 (condition-case nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
532 (apply 'idlwave-online-help mod1) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
533 (error (condition-case nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
534 (apply 'idlwave-online-help mod2) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
535 (error (apply 'idlwave-online-help mod3))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
536 (if mod2 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
537 (condition-case nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
538 (apply 'idlwave-online-help mod1) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
539 (error (apply 'idlwave-online-help mod2))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
540 (if mod1 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
541 (apply 'idlwave-online-help mod1) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
542 (error "Don't know which item to show help for"))))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
543 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
544 (defun idlwave-do-mouse-completion-help (ev) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
545 "Display online help on an item in the *Completions* buffer. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
546 Needs additional info stored in global `idlwave-completion-help-info'." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
547 (let* ((cw (selected-window)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
548 (info idlwave-completion-help-info) ; global passed in |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
549 (what (nth 0 info)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
550 (name (nth 1 info)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
551 (type (nth 2 info)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
552 (class (nth 3 info)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
553 (need-class class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
554 (kwd (nth 4 info)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
555 (sclasses (nth 5 info)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
556 word link) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
557 (mouse-set-point ev) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
558 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
559 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
560 ;; See if we can also find help somewhere, e.g. for multiple classes |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
561 (setq word (idlwave-this-word)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
562 (if (string= word "") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
563 (error "No help item selected")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
564 (setq link (get-text-property 0 'link word)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
565 (select-window cw) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
566 (cond |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
567 ;; Routine name |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
568 ((memq what '(procedure function routine)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
569 (setq name word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
570 (if (or (eq class t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
571 (and (stringp class) sclasses)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
572 (let* ((classes (idlwave-all-method-classes |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
573 (idlwave-sintern-method name) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
574 type))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
575 (setq link t) ; No specific link valid yet |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
576 (if sclasses |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
577 (setq classes (idlwave-members-only |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
578 classes (cons class sclasses)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
579 (setq class (idlwave-popup-select ev classes |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
580 "Select Class" 'sort)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
581 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
582 ;; XXX is this necessary, given all-method-classes? |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
583 (if (stringp class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
584 (setq class (idlwave-find-inherited-class |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
585 (idlwave-sintern-routine-or-method name class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
586 type (idlwave-sintern-class class))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
587 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
588 ;; Keyword |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
589 ((eq what 'keyword) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
590 (setq kwd word) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
591 (if (or (eq class t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
592 (and (stringp class) sclasses)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
593 (let ((classes (idlwave-all-method-keyword-classes |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
594 (idlwave-sintern-method name) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
595 (idlwave-sintern-keyword kwd) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
596 type))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
597 (setq link t) ; Link can't be correct yet |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
598 (if sclasses |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
599 (setq classes (idlwave-members-only |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
600 classes (cons class sclasses)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
601 (setq class (idlwave-popup-select ev classes |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
602 "Select Class" 'sort)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
603 ;; XXX is this necessary, given all-method-keyword-classes? |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
604 (if (stringp class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
605 (setq class (idlwave-find-inherited-class |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
606 (idlwave-sintern-routine-or-method name class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
607 type (idlwave-sintern-class class))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
608 (if (string= (downcase name) "obj_new") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
609 (setq class idlwave-current-obj_new-class |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
610 name "Init")))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
611 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
612 ;; Class name |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
613 ((eq what 'class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
614 (setq class word |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
615 word nil)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
616 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
617 ;; A special named function to call which sets some of our variables |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
618 ((and (symbolp what) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
619 (fboundp what)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
620 (funcall what 'set word)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
621 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
622 (t (error "Cannot help with this item"))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
623 (if (and need-class (not class) (not (and link (not (eq link t))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
624 (error "Cannot help with this item")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
625 (idlwave-online-help link (or name word) type class kwd))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
626 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
627 (defvar idlwave-highlight-help-links-in-completion) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
628 (defvar idlwave-completion-help-links) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
629 (defun idlwave-highlight-linked-completions () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
630 "Highlight all completions for which help is available and attach link. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
631 Those words in `idlwave-completion-help-links' have links. The |
63450
87216f91a211
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-413
Miles Bader <miles@gnu.org>
parents:
62772
diff
changeset
|
632 `idlwave-help-link' face is used for this." |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
633 (if idlwave-highlight-help-links-in-completion |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
634 (with-current-buffer (get-buffer "*Completions*") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
635 (save-excursion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
636 (let* ((case-fold-search t) |
63450
87216f91a211
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-413
Miles Bader <miles@gnu.org>
parents:
62772
diff
changeset
|
637 (props (list 'face 'idlwave-help-link)) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
638 (info idlwave-completion-help-info) ; global passed in |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
639 (what (nth 0 info)) ; what was completed, or a func |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
640 (class (nth 3 info)) ; any class |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
641 word beg end doit) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
642 (goto-char (point-min)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
643 (re-search-forward "possible completions are:" nil t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
644 (while (re-search-forward "\\s-\\([A-Za-z0-9_.]+\\)\\(\\s-\\|\\'\\)" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
645 nil t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
646 (setq beg (match-beginning 1) end (match-end 1) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
647 word (match-string 1) doit nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
648 ;; Call special completion function test |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
649 (if (and (symbolp what) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
650 (fboundp what)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
651 (setq doit (funcall what 'test word)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
652 ;; Look for special link property passed in help-links |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
653 (if idlwave-completion-help-links |
62121
9d18baf82550
(idlwave-do-context-help1, idlwave-highlight-linked-completions): Replace
Juanma Barranquero <lekktu@gmail.com>
parents:
61394
diff
changeset
|
654 (setq doit (assoc-string |
9d18baf82550
(idlwave-do-context-help1, idlwave-highlight-linked-completions): Replace
Juanma Barranquero <lekktu@gmail.com>
parents:
61394
diff
changeset
|
655 word idlwave-completion-help-links t)))) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
656 (when doit |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
657 (if (consp doit) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
658 (setq props (append props `(link ,(cdr doit))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
659 (let ((buffer-read-only nil)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
660 (add-text-properties beg end props))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
661 (goto-char end))))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
662 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
663 ;; Arrange for this function to be called after completion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
664 (add-hook 'idlwave-completion-setup-hook |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
665 'idlwave-highlight-linked-completions) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
666 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
667 (defvar idlwave-help-return-frame nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
668 "The frame to return to from the help frame.") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
669 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
670 (defun idlwave-help-quit () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
671 "Exit IDLWAVE Help buffer. Kill the dedicated frame if any." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
672 (interactive) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
673 (cond ((and idlwave-help-use-dedicated-frame |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
674 (eq (selected-frame) idlwave-help-frame)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
675 (if (and idlwave-experimental |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
676 (frame-live-p idlwave-help-return-frame)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
677 ;; Try to select the return frame. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
678 ;; This can crash on slow network connections, obviously when |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
679 ;; we kill the help frame before the return-frame is selected. |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
680 ;; To protect the workings, we wait for up to one second |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
681 ;; and check if the return-frame *is* now selected. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
682 ;; This is marked "eperimental" since we are not sure when its OK. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
683 (let ((maxtime 1.0) (time 0.) (step 0.1)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
684 (select-frame idlwave-help-return-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
685 (while (and (sit-for step) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
686 (not (eq (selected-frame) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
687 idlwave-help-return-frame)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
688 (< (setq time (+ time step)) maxtime))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
689 (delete-frame idlwave-help-frame)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
690 ((window-configuration-p idlwave-help-window-configuration) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
691 (set-window-configuration idlwave-help-window-configuration) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
692 (select-window (previous-window))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
693 (t (kill-buffer (idlwave-help-get-help-buffer))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
694 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
695 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
696 (defvar default-toolbar-visible-p) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
697 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
698 (defun idlwave-help-display-help-window (&optional pos-or-func) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
699 "Display the help window. |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
700 Move window start to POS-OR-FUNC, if passed as a position, or call it |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
701 if passed as a function. See `idlwave-help-use-dedicated-frame'." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
702 (let ((cw (selected-window)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
703 (buf (idlwave-help-get-help-buffer))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
704 (if (and window-system idlwave-help-use-dedicated-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
705 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
706 (idlwave-help-show-help-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
707 (switch-to-buffer buf)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
708 ;; Do it in this frame and save the window configuration |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
709 (if (not (get-buffer-window buf nil)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
710 (setq idlwave-help-window-configuration |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
711 (current-window-configuration))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
712 (display-buffer buf nil (selected-frame)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
713 (select-window (get-buffer-window buf))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
714 (raise-frame) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
715 (if pos-or-func |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
716 (if (functionp pos-or-func) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
717 (funcall pos-or-func) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
718 (goto-char pos-or-func) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
719 (recenter 0))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
720 (select-window cw))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
721 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
722 (defun idlwave-help-select-help-frame () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
723 "Select the help frame." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
724 (if (and (frame-live-p idlwave-help-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
725 (not (eq (selected-frame) idlwave-help-frame))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
726 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
727 (setq idlwave-help-return-frame (selected-frame)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
728 (select-frame idlwave-help-frame)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
729 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
730 (defun idlwave-help-return-to-calling-frame () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
731 "Select the frame from which the help frame was selected." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
732 (interactive) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
733 (if (and (frame-live-p idlwave-help-return-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
734 (not (eq (selected-frame) idlwave-help-return-frame))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
735 (select-frame idlwave-help-return-frame))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
736 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
737 (defun idlwave-online-help (link &optional name type class keyword) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
738 "Display HTML or other special help on a certain topic. |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
739 Either loads an HTML link, if LINK is non-nil, or gets special-help on |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
740 the optional arguments, if any special help is defined. If LINK is |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
741 `t', first look up the optional arguments in the routine info list to |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
742 see if a link is set for it. Try extra help functions if necessary." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
743 ;; Lookup link |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
744 (if (eq link t) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
745 (let ((entry (idlwave-best-rinfo-assoc name type class |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
746 (idlwave-routines) nil t))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
747 (if entry |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
748 (cond |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
749 ;; Try keyword link |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
750 ((and keyword |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
751 (setq link (cdr |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
752 (idlwave-entry-find-keyword entry keyword))))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
753 ;; Default, regular entry link |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
754 (t (setq link (idlwave-entry-has-help entry)))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
755 (if (and |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
756 class |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
757 ;; Check for system class help |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
758 (setq entry (assq (idlwave-sintern-class class) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
759 idlwave-system-class-info) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
760 link (nth 1 (assq 'link entry)))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
761 (message |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
762 (concat "No routine info for %s" |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
763 ", falling back on class help.") |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
764 (idlwave-make-full-name class name)))))) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
765 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
766 (cond |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
767 ;; An explicit link |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
768 ((stringp link) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
769 (idlwave-help-html-link link)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
770 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
771 ;; Any extra help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
772 (idlwave-extra-help-function |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
773 (idlwave-help-get-special-help name type class keyword)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
774 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
775 ;; Nothing worked |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
776 (t (idlwave-help-error name type class keyword)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
777 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
778 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
779 (defun idlwave-help-get-special-help (name type class keyword) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
780 "Call the function given by `idlwave-extra-help-function'." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
781 (let* ((cw (selected-window)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
782 (help-pos (save-excursion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
783 (set-buffer (idlwave-help-get-help-buffer)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
784 (let ((buffer-read-only nil)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
785 (funcall idlwave-extra-help-function |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
786 name type class keyword))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
787 (if help-pos |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
788 (idlwave-help-display-help-window help-pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
789 (idlwave-help-error name type class keyword)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
790 (select-window cw))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
791 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
792 (defun idlwave-help-html-link (link) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
793 "Get html help on a given LINK." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
794 (let ((browse-url-browser-function idlwave-help-browser-function) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
795 (help-loc (idlwave-html-help-location)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
796 (browse-url-generic-program idlwave-help-browser-generic-program) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
797 ;(browse-url-generic-args idlwave-help-browser-generic-args) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
798 full-link) |
65235
115e36d1b11e
(browse-url-generic-args): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
64993
diff
changeset
|
799 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
800 ;; Just a regular file name (+ anchor name) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
801 (unless (and (stringp help-loc) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
802 (file-directory-p help-loc)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
803 (error "Invalid help location.")) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
804 (setq full-link (browse-url-file-url (expand-file-name link help-loc))) |
62121
9d18baf82550
(idlwave-do-context-help1, idlwave-highlight-linked-completions): Replace
Juanma Barranquero <lekktu@gmail.com>
parents:
61394
diff
changeset
|
805 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
806 ;; Select the browser |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
807 (cond |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
808 (idlwave-help-use-assistant |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
809 (idlwave-help-assistant-open-link link)) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
810 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
811 ((or idlwave-help-browser-is-local |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
812 (string-match "w3" (symbol-name idlwave-help-browser-function))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
813 (idlwave-help-display-help-window '(lambda () (browse-url full-link)))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
814 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
815 (t (browse-url full-link))))) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
816 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
817 ;; A special help routine for source-level syntax help in files. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
818 (defvar idlwave-help-fontify-source-code) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
819 (defvar idlwave-help-source-try-header) |
64001
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
820 (defvar idlwave-current-tags-buffer) |
82d080bf4f42
Updated to IDLWAVE v5.7 (see idlwave.org), and variable cleanup
J.D. Smith <jdsmith@as.arizona.edu>
parents:
63450
diff
changeset
|
821 (defvar idlwave-current-tags-class) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
822 (defun idlwave-help-with-source (name type class keyword) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
823 "Provide help for routines not documented in the IDL manuals. Works |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
824 by loading the routine source file into the help buffer. Depending on |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
825 the value of `idlwave-help-source-try-header', it attempts to show the |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
826 routine definition or the header description. If |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
827 `idlwave-help-do-class-struct-tag' is non-nil, keyword is a tag to |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
828 show help on from the class definition structure. If |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
829 `idlwave-help-do-struct-tag' is non-nil, show help from the matching |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
830 structure tag definition. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
831 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
832 This function can be used as `idlwave-extra-help-function'." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
833 (let* ((class-struct-tag idlwave-help-do-class-struct-tag) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
834 (struct-tag idlwave-help-do-struct-tag) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
835 (case-fold-search t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
836 (real-class (if (consp name) (cdr name))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
837 (name (if (consp name) (car name) name)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
838 (class-only (and (stringp class) (not (stringp name)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
839 file header-pos def-pos in-buf) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
840 (if class-only ;Help with class? Using "Init" as source. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
841 (setq name "Init" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
842 type 'fun)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
843 (if (not struct-tag) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
844 (setq file |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
845 (idlwave-routine-source-file |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
846 (nth 3 (idlwave-best-rinfo-assoc |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
847 name (or type t) class (idlwave-routines)))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
848 (setq idlwave-help-def-pos nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
849 idlwave-help-args (list name type class keyword) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
850 idlwave-help-in-header nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
851 idlwave-help-do-struct-tag nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
852 idlwave-help-do-class-struct-tag nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
853 (if (or struct-tag (stringp file)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
854 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
855 (setq in-buf ; structure-tag completion is always in current buffer |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
856 (if struct-tag |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
857 idlwave-current-tags-buffer |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
858 (idlwave-get-buffer-visiting file))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
859 ;; see if file is in a visited buffer, insert those contents |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
860 (if in-buf |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
861 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
862 (setq file (buffer-file-name in-buf)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
863 (erase-buffer) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
864 (insert-buffer-substring in-buf)) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
865 (if (file-exists-p file) ;; otherwise just load the file |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
866 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
867 (erase-buffer) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
868 (insert-file-contents file nil nil nil 'replace)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
869 (idlwave-help-error name type class keyword))) |
70137
49dd98fd173c
Ensure point at beginning of source help buffer, so class/tag finding works.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69831
diff
changeset
|
870 (goto-char (point-min)) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
871 (if (and idlwave-help-fontify-source-code (not in-buf)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
872 (idlwave-help-fontify))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
873 (idlwave-help-error name type class keyword)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
874 (setq idlwave-help-mode-line-indicator file) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
875 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
876 ;; Try to find a good place to display |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
877 (setq def-pos |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
878 ;; Find the class structure tag if that's what we're after |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
879 (cond |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
880 ;; Class structure tags: find the class or named structure |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
881 ;; definition |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
882 (class-struct-tag |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
883 (save-excursion |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
884 (setq class |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
885 (if (string-match "[a-zA-Z0-9]\\(__\\)" name) |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
886 (substring name 0 (match-beginning 1)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
887 idlwave-current-tags-class)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
888 (and |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
889 (idlwave-find-class-definition class nil real-class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
890 (idlwave-find-struct-tag keyword)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
891 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
892 ;; Generic structure tags: the structure definition |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
893 ;; location within the file has been recorded in |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
894 ;; `struct-tag' |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
895 (struct-tag |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
896 (save-excursion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
897 (and |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
898 (integerp struct-tag) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
899 (goto-char struct-tag) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
900 (idlwave-find-struct-tag keyword)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
901 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
902 ;; Just find the routine definition |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
903 (t |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
904 (if class-only (point-min) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
905 (idlwave-help-find-routine-definition name type class keyword)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
906 idlwave-help-def-pos def-pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
907 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
908 (if (and idlwave-help-source-try-header |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
909 (not (or struct-tag class-struct-tag))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
910 ;; Check if we can find the header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
911 (save-excursion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
912 (goto-char (or def-pos (point-max))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
913 (setq header-pos (idlwave-help-find-in-doc-header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
914 name type class keyword 'exact) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
915 idlwave-help-in-header header-pos))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
916 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
917 (if (or header-pos def-pos) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
918 (progn |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
919 (if (boundp 'idlwave-help-min-frame-width) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
920 (setq idlwave-help-min-frame-width 80)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
921 (goto-char (or header-pos def-pos))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
922 (idlwave-help-error name type class keyword)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
923 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
924 (point))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
925 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
926 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
927 (defun idlwave-help-find-routine-definition (name type class keyword) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
928 "Find the definition of routine CLASS::NAME in current buffer. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
929 KEYWORD is ignored. Returns the point of match if successful, nil otherwise." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
930 (save-excursion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
931 (goto-char (point-max)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
932 (if (re-search-backward |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
933 (concat "^[ \t]*" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
934 (if (eq type 'pro) "pro" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
935 (if (eq type 'fun) "function" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
936 "\\(pro\\|function\\)")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
937 "[ \t]+" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
938 (regexp-quote (downcase (idlwave-make-full-name class name))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
939 "[, \t\r\n]") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
940 nil t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
941 (match-beginning 0) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
942 nil))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
943 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
944 (defvar idlwave-doclib-start) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
945 (defvar idlwave-doclib-end) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
946 (defun idlwave-help-find-in-doc-header (name type class keyword |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
947 &optional exact) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
948 "Find the requested help in the doc-header above point. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
949 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
950 First checks if there is a doc-lib header which describes the correct |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
951 routine. Then tries to find the KEYWORDS section and the KEYWORD, if |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
952 given. Returns the point which should be window start of the help |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
953 window. If EXACT is non-nil, the full help position must be found - |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
954 down to the keyword requested. This setting is for context help, if |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
955 the exact spot is needed. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
956 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
957 If EXACT is nil, the position of the header is returned if it |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
958 describes the correct routine - even if the keyword description cannot |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
959 be found. TYPE is ignored. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
960 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
961 This function expects a more or less standard routine header. In |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
962 particlar it looks for the `NAME:' tag, either with a colon, or alone |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
963 on a line. Then `NAME:' must be followed by the routine name on the |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
964 same or the next line. When KEYWORD is non-nil, looks first for a |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
965 `KEYWORDS' section. It is amazing how inconsisten this is through |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
966 some IDL libraries I have seen. We settle for a line containing an |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
967 upper case \"KEYWORD\" string. If this line is not fould we search |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
968 for the keyword anyway to increase the hit-rate |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
969 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
970 When one of these sections exists we check for a line starting with any of |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
971 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
972 /KEYWORD KEYWORD- KEYWORD= KEYWORD |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
973 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
974 with spaces allowed between the keyword and the following dash or equal sign. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
975 If there is a match, we assume it is the keyword description." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
976 (let* ((case-fold-search t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
977 (rname (if (stringp class) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
978 (concat |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
979 "\\(" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
980 ;; Traditional name or class::name |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
981 "\\(" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
982 "\\(" (regexp-quote (downcase class)) "::\\)?" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
983 (regexp-quote (downcase name)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
984 "\\>\\)" |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
985 (concat |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
986 "\\|" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
987 ;; class__define or just class |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
988 (regexp-quote (downcase class)) "\\(__define\\)?") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
989 "\\)") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
990 (regexp-quote (downcase name)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
991 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
992 ;; NAME tag plus the routine name. The new version is from JD. |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
993 (name-re (concat |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
994 "\\(^;+\\*?[ \t]*" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
995 idlwave-help-doclib-name |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
996 "\\([ \t]*:\\|[ \t]*$\\)[ \t]*\\(\n;+[ \t]*\\)*" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
997 rname |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
998 "\\|" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
999 "^;+[ \t]*" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1000 rname |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1001 ":[ \t]*$\\)")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1002 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1003 ;; Header start plus name |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1004 (header-re (concat "\\(" idlwave-doclib-start "\\).*\n" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1005 "\\(^;+.*\n\\)*" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1006 "\\(" name-re "\\)")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1007 ;; A keywords section |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1008 (kwds-re (concat ; forgiving |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1009 "^;+\\*?[ \t]*" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1010 "\\([-A-Z_ ]*" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1011 idlwave-help-doclib-keyword |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1012 "[-A-Z_ ]*\\)" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1013 "\\(:\\|[ \t]*\n\\)")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1014 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1015 ;; The individual keyword description line. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1016 (kwd-re (if keyword ; hard (well...) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1017 (concat |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1018 "^;+[ \t]+" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1019 "\\(/" (regexp-quote (upcase keyword)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1020 "\\|" (regexp-quote (upcase keyword)) "[ \t]*[-=:\n]" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1021 "\\)"))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1022 (kwd-re2 (if keyword ; forgiving |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1023 (concat |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1024 "^;+[ \t]+" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1025 (regexp-quote (upcase keyword)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1026 "\\>"))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1027 dstart dend name-pos kwds-pos kwd-pos) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1028 (catch 'exit |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1029 (save-excursion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1030 (goto-char (point-min)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1031 (while (and (setq dstart (re-search-forward idlwave-doclib-start nil t)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1032 (setq dend (re-search-forward idlwave-doclib-end nil t))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1033 ;; found a routine header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1034 (goto-char dstart) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1035 (if (setq name-pos (re-search-forward name-re dend t)) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1036 (progn |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1037 (if keyword |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1038 ;; We do need a keyword |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1039 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1040 ;; Try to find a keyword section, but don't force it. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1041 (goto-char name-pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1042 (if (let ((case-fold-search nil)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1043 (re-search-forward kwds-re dend t)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1044 (setq kwds-pos (match-beginning 0))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1045 ;; Find the keyword description |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1046 (if (or (let ((case-fold-search nil)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1047 (re-search-forward kwd-re dend t)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1048 (re-search-forward kwd-re dend t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1049 (let ((case-fold-search nil)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1050 (re-search-forward kwd-re2 dend t)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1051 (re-search-forward kwd-re2 dend t)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1052 (setq kwd-pos (match-beginning 0)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1053 (if exact |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1054 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1055 (idlwave-help-diagnostics |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1056 (format "Could not find description of kwd %s" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1057 (upcase keyword))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1058 (throw 'exit nil)))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1059 ;; Return the best position we got |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1060 (throw 'exit (or kwd-pos kwds-pos name-pos dstart))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1061 (goto-char dend)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1062 (idlwave-help-diagnostics "Could not find doclib header") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1063 (throw 'exit nil)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1064 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1065 (defun idlwave-help-diagnostics (string &optional ding) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1066 "Add a diagnostics string to the list. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1067 When DING is non-nil, ring the bell as well." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1068 (if (boundp 'idlwave-help-diagnostics) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1069 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1070 (setq idlwave-help-diagnostics |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1071 (cons string idlwave-help-diagnostics)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1072 (if ding (ding))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1073 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1074 (defun idlwave-help-toggle-header-top-and-def (arg) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1075 (interactive "P") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1076 (let (pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1077 (if idlwave-help-in-header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1078 ;; Header was the last thing displayed |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1079 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1080 (setq idlwave-help-in-header nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1081 (setq pos idlwave-help-def-pos)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1082 ;; Try to display header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1083 (setq pos (idlwave-help-find-in-doc-header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1084 (nth 0 idlwave-help-args) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1085 (nth 1 idlwave-help-args) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1086 (nth 2 idlwave-help-args) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1087 nil)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1088 (if pos |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1089 (setq idlwave-help-in-header t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1090 (error "Cannot find doclib header for routine %s" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1091 (idlwave-make-full-name (nth 2 idlwave-help-args) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1092 (nth 0 idlwave-help-args))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1093 (if pos |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1094 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1095 (goto-char pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1096 (recenter 0))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1097 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1098 (defun idlwave-help-find-first-header (arg) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1099 (interactive "P") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1100 (let (pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1101 (save-excursion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1102 (goto-char (point-min)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1103 (if (re-search-forward idlwave-doclib-start nil t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1104 (setq pos (match-beginning 0)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1105 (if pos |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1106 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1107 (goto-char pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1108 (recenter 0)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1109 (error "No DocLib Header in current file")))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1110 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1111 (defun idlwave-help-find-header (arg) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1112 "Jump to the DocLib Header." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1113 (interactive "P") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1114 (if arg |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1115 (idlwave-help-find-first-header nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1116 (setq idlwave-help-in-header nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1117 (idlwave-help-toggle-header-match-and-def arg 'top))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1118 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1119 (defun idlwave-help-toggle-header-match-and-def (arg &optional top) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1120 (interactive "P") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1121 (let ((args idlwave-help-args) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1122 pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1123 (if idlwave-help-in-header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1124 ;; Header was the last thing displayed |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1125 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1126 (setq idlwave-help-in-header nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1127 (setq pos idlwave-help-def-pos)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1128 ;; Try to display header |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1129 (setq pos (apply 'idlwave-help-find-in-doc-header |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1130 (if top |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1131 (list (car args) (nth 1 args) (nth 2 args) nil) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1132 args))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1133 (if pos |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1134 (setq idlwave-help-in-header t) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1135 (error "Cannot find doclib header for routine %s" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1136 (idlwave-make-full-name (nth 2 idlwave-help-args) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1137 (nth 0 idlwave-help-args))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1138 (if pos |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1139 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1140 (goto-char pos) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1141 (recenter 0))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1142 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1143 (defvar font-lock-verbose) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1144 (defvar idlwave-mode-syntax-table) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1145 (defvar idlwave-font-lock-defaults) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1146 (defun idlwave-help-fontify () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1147 "Fontify the Help buffer as source code. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1148 Useful when source code is displayed as help. See the option |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1149 `idlwave-help-fontify-source-code'." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1150 (interactive) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1151 (if (featurep 'font-lock) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1152 (let ((major-mode 'idlwave-mode) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1153 (font-lock-verbose |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1154 (if (interactive-p) font-lock-verbose nil)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1155 (syntax-table (syntax-table))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1156 (unwind-protect |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1157 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1158 (set-syntax-table idlwave-mode-syntax-table) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1159 (set (make-local-variable 'font-lock-defaults) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1160 idlwave-font-lock-defaults) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1161 (font-lock-fontify-buffer)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1162 (set-syntax-table syntax-table))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1163 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1164 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1165 (defun idlwave-help-error (name type class keyword) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1166 (error "Can't find help on %s%s %s" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1167 (or (and (or class name) (idlwave-make-full-name class name)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1168 "<unknown>") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1169 (if keyword (format ", keyword %s" (upcase keyword)) "") |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1170 (if idlwave-html-help-location |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1171 "" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1172 "(help location unknown)"))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1173 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1174 (defun idlwave-help-show-help-frame () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1175 "Show the help frame, creating it if necessary" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1176 ;; Use a special frame for this |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1177 (unless (frame-live-p idlwave-help-frame) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1178 (setq idlwave-help-frame |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1179 (make-frame idlwave-help-frame-parameters)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1180 ;; Strip menubar (?) and toolbar from the Help frame. |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1181 (if (fboundp 'set-specifier) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1182 (progn |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1183 ;; XEmacs |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1184 (let ((sval (cons idlwave-help-frame nil))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1185 ;; (set-specifier menubar-visible-p sval) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1186 (set-specifier default-toolbar-visible-p sval))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1187 ;; Emacs |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1188 (modify-frame-parameters idlwave-help-frame |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1189 '(;;(menu-bar-lines . 0) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1190 (tool-bar-lines . 0))))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1191 (select-frame idlwave-help-frame)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1192 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1193 (defun idlwave-help-get-help-buffer () |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1194 "Return the IDLWAVE Help buffer. Make it first if necessary." |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1195 (let ((buf (get-buffer "*IDLWAVE Help*"))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1196 (if buf |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1197 nil |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1198 (setq buf (get-buffer-create "*IDLWAVE Help*")) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1199 (save-excursion |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1200 (set-buffer buf) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1201 (idlwave-help-mode))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1202 buf)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1203 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1204 (defun idlwave-grep (regexp list) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1205 (let (rtn) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1206 (while list |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1207 (if (string-match regexp (car list)) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1208 (setq rtn (cons (car list) rtn))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1209 (setq list (cdr list))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1210 (nreverse rtn))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1211 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1212 (defun idlwave-entry-has-help (entry) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1213 (and entry (car (nth 5 entry)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1214 |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1215 (defun idlwave-has-help (name type class) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1216 "Does this have help associated with it?" |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1217 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1218 (idlwave-entry-has-help entry))) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1219 |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1220 ;;----- Control the IDL Assistant, which shipped with IDL v6.2 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1221 (defvar idlwave-help-assistant-process nil) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1222 (defvar idlwave-help-assistant-socket nil) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1223 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1224 ;; The Windows version does not have a !DIR/bin/* set of front-end |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1225 ;; scripts, but instead only links directly to bin.x86. As a result, |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1226 ;; we must pass the -profile argument as well. |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1227 (defvar idlwave-help-assistant-command |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1228 (if (memq system-type '(ms-dos windows-nt)) |
76395
144d0dd66d84
(idlwave-do-context-help1): Don't visit special help topics for
J.D. Smith <jdsmith@as.arizona.edu>
parents:
75347
diff
changeset
|
1229 "bin/bin.x86/idl_assistant.exe" |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1230 "bin/idl_assistant") |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1231 "The command, rooted at idlwave-system-directory, which invokes the |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1232 IDL assistant.") |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1233 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1234 (defun idlwave-help-assistant-available () |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1235 (if idlwave-help-assistant-available |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1236 (eq idlwave-help-assistant-available t) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1237 (setq idlwave-help-assistant-available |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1238 (if (file-executable-p (idlwave-help-assistant-command)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1239 t |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1240 'not-available)))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1241 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1242 (defun idlwave-help-assistant-command () |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1243 (expand-file-name idlwave-help-assistant-command (idlwave-sys-dir))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1244 |
74105
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1245 (defun idlwave-help-assistant-start (&optional full-link) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1246 "Start the IDL Assistant, loading link FULL-LINK, if passed." |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1247 (when (or (not idlwave-help-assistant-socket) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1248 (not (eq (process-status idlwave-help-assistant-socket) 'open))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1249 (let* ((help-loc (idlwave-html-help-location)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1250 (command (idlwave-help-assistant-command)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1251 (extra-args |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1252 (nconc |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1253 (if (memq system-type '(ms-dos windows-nt)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1254 `("-profile" ,(expand-file-name "idl.adp" help-loc))) |
74105
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1255 (if full-link `("-file" ,full-link)))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1256 port) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1257 (if idlwave-help-assistant-socket |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1258 (delete-process idlwave-help-assistant-socket)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1259 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1260 (setq idlwave-help-assistant-process |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1261 (apply 'start-process |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1262 "IDL_ASSISTANT_PROC" nil command "-server" extra-args)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1263 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1264 (set-process-filter idlwave-help-assistant-process |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1265 (lambda (proc string) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1266 (setq port (string-to-number string)))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1267 (unless (accept-process-output idlwave-help-assistant-process 15) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1268 (error "Failed binding IDL_ASSISTANT socket")) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1269 (if (not port) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1270 (error "Unable to open IDL_ASSISTANT.") |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1271 (set-process-filter idlwave-help-assistant-process nil) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1272 (setq idlwave-help-assistant-socket |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1273 (open-network-stream "IDL_ASSISTANT_SOCK" |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1274 nil "localhost" port)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1275 (if (eq (process-status idlwave-help-assistant-socket) 'open) |
74105
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1276 (progn |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1277 (process-send-string idlwave-help-assistant-socket |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1278 (concat "setHelpPath " help-loc "\n")) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1279 t) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1280 (idlwave-help-assistant-close) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1281 (error "Cannot communicate with IDL_ASSISTANT")))))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1282 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1283 (defun idlwave-help-assistant-raise () |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1284 (idlwave-help-assistant-start) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1285 (process-send-string idlwave-help-assistant-socket "raise\n")) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1286 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1287 (defun idlwave-help-assistant-open-link (&optional link) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1288 ;; Open a link (file name with anchor, no leading path) in the assistant. |
74105
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1289 (let ((help-loc (idlwave-html-help-location)) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1290 topic anchor file just-started exists full-link) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1291 |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1292 (if (string-match "\.html" link) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1293 (setq topic (substring link 0 (match-beginning 0)) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1294 anchor (substring link (match-end 0))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1295 (error "Malformed help link.")) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1296 |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1297 (setq file (expand-file-name (concat topic ".html") help-loc)) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1298 (if (file-exists-p file) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1299 (setq exists t) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1300 (setq file (expand-file-name |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1301 (concat (upcase topic) ".html") help-loc)) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1302 (setq exists (file-exists-p file))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1303 |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1304 (setq full-link (concat file anchor) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1305 just-started (idlwave-help-assistant-start (if exists full-link))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1306 (if exists |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1307 (progn |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1308 (if (not just-started) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1309 (process-send-string idlwave-help-assistant-socket |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1310 (concat "openLink " full-link "\n"))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1311 (process-send-string idlwave-help-assistant-socket |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1312 (concat "searchIndexNoOpen " topic "\n"))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1313 (process-send-string idlwave-help-assistant-socket |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1314 (concat "searchIndexAndOpen " topic "\n")))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1315 (idlwave-help-assistant-raise)) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1316 |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1317 (defvar idlwave-help-assistant-help-with-topic-history nil |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1318 "The history of help topics selected with the minibuffer.") |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1319 |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1320 (defun idlwave-help-assistant-help-with-topic (&optional topic) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1321 "Prompt for and provide help with TOPIC." |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1322 (interactive) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1323 (let (list) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1324 (unless topic |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1325 (idlwave-routines) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1326 (setq list (append (mapcar (lambda (x) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1327 (concat (nth 2 x) (car x))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1328 idlwave-system-routines) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1329 (mapcar (lambda (x) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1330 (concat "." (car x))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1331 idlwave-executive-commands-alist) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1332 idlwave-system-class-info)) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1333 (setq topic |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1334 (idlwave-completing-read |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1335 "Help Topic: " list |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1336 nil nil nil |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1337 'idlwave-help-assistant-help-with-topic-history))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1338 (if (and topic (not (string= topic ""))) |
280766a0721d
(idlwave-html-help-location): Fail gracefully for missing help packages.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
70137
diff
changeset
|
1339 (idlwave-help-assistant-open-link (concat topic ".html"))))) |
69821
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1340 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1341 (defun idlwave-help-assistant-close () |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1342 (when (and idlwave-help-assistant-process |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1343 (eq (process-status idlwave-help-assistant-process) 'run)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1344 (when idlwave-help-assistant-socket |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1345 (process-send-string idlwave-help-assistant-socket "quit\n") |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1346 (delete-process idlwave-help-assistant-socket)) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1347 (stop-process idlwave-help-assistant-process) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1348 (delete-process idlwave-help-assistant-process) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1349 (setq idlwave-help-assistant-socket nil |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1350 idlwave-help-assistant-process nil))) |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1351 |
5baeec79c0cd
Update to IDLWAVE version 6.0; see idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
68773
diff
changeset
|
1352 |
58295
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1353 (provide 'idlw-help) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1354 (provide 'idlwave-help) |
fda404732a9a
Initial checkin of HTML help support module.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
diff
changeset
|
1355 |
58296 | 1356 ;; arch-tag: d27b5505-59de-497f-ba3f-f199fd4fb911 |
1357 ;;; idlw-help.el ends here |