~cszikszoy/do-plugins/pastebin

« back to all changes in this revision

Viewing changes to ManLookUp/src/ManLookUpEntries.cs

  • Committer: Alex Launi
  • Date: 2008-10-20 01:44:13 UTC
  • mfrom: (256.1.1 do-plugins)
  • Revision ID: alex@eriktorvaldsonn-20081020014413-yugngt55h6vo4k4h
Added Man page lookup plugin

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/* ManLookUpEntries.cs is part of ManLookUp, a Gnome-Do plugin
 
2
 *
 
3
 * Copyright 2008 J. Carlos Navea
 
4
 * loconet@gmail.com
 
5
 *
 
6
 * Man Look Up is the legal property of its developers. Please refer to the
 
7
 * COPYRIGHT file distributed with this
 
8
 * source distribution.
 
9
 *
 
10
 * This program is free software: you can redistribute it and/or modify
 
11
 * it under the terms of the GNU General Public License as published by
 
12
 * the Free Software Foundation, either version 3 of the License, or
 
13
 * (at your option) any later version.
 
14
 *
 
15
 * This program is distributed in the hope that it will be useful,
 
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
18
 * GNU General Public License for more details.
 
19
 *
 
20
 * You should have received a copy of the GNU General Public License
 
21
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 
22
 *
 
23
 * Contributors:
 
24
 * J. Carlos Navea <loconet@gmail.com>
 
25
 *
 
26
 * Based on the excellent work of sample plugins included with Gnome-Do 
 
27
 * 
 
28
 */
 
29
using System;
 
30
using System.IO;
 
31
using System.Collections.Generic;
 
32
using System.Text.RegularExpressions;
 
33
using System.Diagnostics;
 
34
 
 
35
using Do.Universe;
 
36
using Mono.Unix;
 
37
 
 
38
 
 
39
namespace GnomeDoManLookUp {
 
40
 
 
41
        /// <summary>
 
42
        ///     ManLookUpItem - Our custom manual page entries
 
43
        /// </summary>
 
44
        public class ManLookUpItem : IOpenableItem {
 
45
                
 
46
                private string name;
 
47
                private string description;
 
48
 
 
49
                /// <summary>
 
50
                ///     Initializes our item. 
 
51
                /// </summary>
 
52
                /// <param name="pagename">
 
53
                /// A <see cref="System.String"/> representing the command name
 
54
                /// </param>
 
55
                /// <param name="desc">
 
56
                /// A <see cref="System.String"/> representing the description given by man
 
57
                /// </param>
 
58
                public ManLookUpItem (string pageName, string desc)
 
59
                {
 
60
                        name = pageName;
 
61
                        description = desc;
 
62
                }
 
63
 
 
64
                /// <value>
 
65
                ///     The entry's name. Usually the actual man page name. 
 
66
                /// </value>
 
67
                public string Name {
 
68
                        get { return name; }
 
69
                }
 
70
                
 
71
                /// <value>
 
72
                ///     The entry's description
 
73
                /// </value>
 
74
                public string Description { 
 
75
                        get { return description; }
 
76
                }
 
77
                
 
78
 
 
79
                /// <value>
 
80
                ///     Our pretty icon
 
81
                /// </value>
 
82
                public string Icon { 
 
83
                        get { return "help-browser"; }
 
84
                }
 
85
 
 
86
                
 
87
                /// <value>
 
88
                ///     The text associated with our custom entry. (we use the man page's name)
 
89
                /// </value>
 
90
                public string Text { 
 
91
                        get { return name; }
 
92
                }
 
93
 
 
94
 
 
95
                /// <summary>
 
96
                ///      Once our custom item entry is selected, do! 
 
97
                /// </summary>
 
98
                public void Open ()
 
99
                {
 
100
                        Process term = new Process ();
 
101
                        term.StartInfo.FileName = "yelp";
 
102
                        term.StartInfo.Arguments = " 'man:"+name+"' ";                          
 
103
                        term.Start ();
 
104
                }
 
105
        }
 
106
 
 
107
        /// <summary>
 
108
        ///     ManItemSource - Our "indexer" or data source of man items.. 
 
109
        /// </summary>
 
110
        public class ManLookUpItemSource : IItemSource { 
 
111
        
 
112
                List<IItem> items;
 
113
                
 
114
                /// <summary>
 
115
                ///     Initialize the object and update the list of items
 
116
                /// </summary>
 
117
                public ManLookUpItemSource () 
 
118
                {
 
119
                        items = new List<IItem> ();
 
120
                        UpdateItems ();
 
121
                }
 
122
 
 
123
 
 
124
                /// <value>
 
125
                ///     Name of data source
 
126
                /// </value>
 
127
                public string Name { 
 
128
                        get { return Catalog.GetString ("Documentation help entries (man)"); }
 
129
                }
 
130
 
 
131
                /// <value>
 
132
                ///     Description of data source
 
133
                /// </value>    
 
134
                public string Description { 
 
135
                        get { return Catalog.GetString ("Search and read help documentation (man)"); }
 
136
                }
 
137
                
 
138
 
 
139
                /// <value>
 
140
                ///     Our pretty icon
 
141
                /// </value>
 
142
                public string Icon { 
 
143
                        get { return "applications-office"; }
 
144
                }
 
145
 
 
146
                /// <value>
 
147
                ///     What type of items do we support
 
148
                /// </value>
 
149
                public Type[] SupportedItemTypes {
 
150
                        get {
 
151
                                return new Type[] { typeof (ManLookUpItem) };
 
152
                        }
 
153
                }
 
154
 
 
155
                /// <value>
 
156
                ///     Our collection of items
 
157
                /// </value>
 
158
                public ICollection<IItem> Items {
 
159
                        get { return items; }
 
160
                }
 
161
 
 
162
 
 
163
                /// <summary>
 
164
                /// 
 
165
                /// </summary>
 
166
                /// <param name="parent">
 
167
                /// A <see cref="IItem"/>
 
168
                /// </param>
 
169
                /// <returns>
 
170
                /// A <see cref="ICollection`1"/>
 
171
                /// </returns>
 
172
                public ICollection<IItem> ChildrenOfItem (IItem parent)
 
173
                {
 
174
                        return null;  
 
175
                }
 
176
 
 
177
 
 
178
                /// <summary>
 
179
                ///     Update the items we are keeping track of
 
180
                /// </summary>
 
181
                public void UpdateItems ()
 
182
                {
 
183
                        items.Clear ();
 
184
 
 
185
                        try {
 
186
                                
 
187
                                //
 
188
                                //We'll use man -k with a very hungry wildcard to get
 
189
                                //the whole list of manual pages. This *should* be nicer 
 
190
                                //than accessing the mandb directly so that localization is taken
 
191
                                //care of. We also don't have to worry about file location.
 
192
                                //
 
193
                                Process term = new Process ();
 
194
                                term.StartInfo.FileName = "man";
 
195
                                term.StartInfo.Arguments = " -k '.' ";
 
196
                                term.StartInfo.RedirectStandardOutput = true;
 
197
                                term.StartInfo.UseShellExecute = false;
 
198
                                
 
199
                                term.Start ();
 
200
                                
 
201
                                System.IO.StreamReader oReader2 = term.StandardOutput;
 
202
 
 
203
                                //man -k output format: command (section-int) - description
 
204
                                Regex r = new Regex ("^([^ ]+)\\s\\([1-9]+\\)\\s+-\\s(.*)$");
 
205
                                
 
206
                                //probably not the best way of reading the lines...but..
 
207
                                char[] charArray = new char [] {'\n'};
 
208
                                foreach (string line in oReader2.ReadToEnd ().Split (charArray)) {
 
209
                                        Match m = r.Match (line);
 
210
                                        if (m.Success) 
 
211
                                                items.Add (new ManLookUpItem(m.Groups [1].ToString (),m.Groups [2].ToString ()));
 
212
                                }
 
213
 
 
214
                                
 
215
                        } catch { }
 
216
                }
 
217
        }
 
218
}