]> git.cworth.org Git - sup/blob - lib/sup/buffer.rb
add buffer search with '/' and 'n', and change index search to '\'
[sup] / lib / sup / buffer.rb
1 require 'etc'
2 require 'thread'
3 require 'ncurses'
4
5 if defined? Ncurses
6 module Ncurses
7   def rows
8     lame, lamer = [], []
9     stdscr.getmaxyx lame, lamer
10     lame.first
11   end
12
13   def cols
14     lame, lamer = [], []
15     stdscr.getmaxyx lame, lamer
16     lamer.first
17   end
18
19   def curx
20     lame, lamer = [], []
21     stdscr.getyx lame, lamer
22     lamer.first
23   end
24
25   def mutex; @mutex ||= Mutex.new; end
26   def sync &b; mutex.synchronize(&b); end
27
28   ## magically, this stuff seems to work now. i could swear it didn't
29   ## before. hm.
30   def nonblocking_getch
31     if IO.select([$stdin], nil, nil, 1)
32       Ncurses.getch
33     else
34       nil
35     end
36   end
37
38   module_function :rows, :cols, :curx, :nonblocking_getch, :mutex, :sync
39
40   remove_const :KEY_ENTER
41   remove_const :KEY_CANCEL
42
43   KEY_ENTER = 10
44   KEY_CANCEL = 7 # ctrl-g
45   KEY_TAB = 9
46 end
47 end
48
49 module Redwood
50
51 class Buffer
52   attr_reader :mode, :x, :y, :width, :height, :title
53   bool_reader :dirty
54   bool_accessor :force_to_top
55
56   def initialize window, mode, width, height, opts={}
57     @w = window
58     @mode = mode
59     @dirty = true
60     @focus = false
61     @title = opts[:title] || ""
62     @force_to_top = opts[:force_to_top] || false
63     @x, @y, @width, @height = 0, 0, width, height
64   end
65
66   def content_height; @height - 1; end
67   def content_width; @width; end
68
69   def resize rows, cols 
70     return if cols == @width && rows == @height
71     @width = cols
72     @height = rows
73     @dirty = true
74     mode.resize rows, cols
75   end
76
77   def redraw
78     draw if @dirty
79     draw_status
80     commit
81   end
82
83   def mark_dirty; @dirty = true; end
84
85   def commit
86     @dirty = false
87     @w.noutrefresh
88   end
89
90   def draw
91     @mode.draw
92     draw_status
93     commit
94   end
95
96   ## s nil means a blank line!
97   def write y, x, s, opts={}
98     return if x >= @width || y >= @height
99
100     @w.attrset Colormap.color_for(opts[:color] || :none, opts[:highlight])
101     s ||= ""
102     maxl = @width - x
103     @w.mvaddstr y, x, s[0 ... maxl]
104     unless s.length >= maxl || opts[:no_fill]
105       @w.mvaddstr(y, x + s.length, " " * (maxl - s.length))
106     end
107   end
108
109   def clear
110     @w.clear
111   end
112
113   def draw_status
114     write @height - 1, 0, " [#{mode.name}] #{title}   #{mode.status}",
115       :color => :status_color
116   end
117
118   def focus
119     @focus = true
120     @dirty = true
121     @mode.focus
122   end
123
124   def blur
125     @focus = false
126     @dirty = true
127     @mode.blur
128   end
129 end
130
131 class BufferManager
132   include Singleton
133
134   attr_reader :focus_buf
135
136   ## we have to define the key used to continue in-buffer search here, because
137   ## it has special semantics that BufferManager deals with---current searches
138   ## are canceled by any keypress except this one.
139   CONTINUE_IN_BUFFER_SEARCH_KEY = "n"
140
141   def initialize
142     @name_map = {}
143     @buffers = []
144     @focus_buf = nil
145     @dirty = true
146     @minibuf_stack = []
147     @minibuf_mutex = Mutex.new
148     @textfields = {}
149     @flash = nil
150     @shelled = @asking = false
151
152     self.class.i_am_the_instance self
153   end
154
155   def buffers; @name_map.to_a; end
156
157   def focus_on buf
158     raise ArgumentError, "buffer not on stack: #{buf.inspect}" unless @buffers.member? buf
159     return if buf == @focus_buf 
160     @focus_buf.blur if @focus_buf
161     @focus_buf = buf
162     @focus_buf.focus
163   end
164
165   def raise_to_front buf
166     raise ArgumentError, "buffer not on stack: #{buf.inspect}" unless @buffers.member? buf
167
168     @buffers.delete buf
169     if @buffers.length > 0 && @buffers.last.force_to_top?
170       @buffers.insert(-2, buf)
171     else
172       @buffers.push buf
173       focus_on buf
174     end
175     @dirty = true
176   end
177
178   ## we reset force_to_top when rolling buffers. this is so that the
179   ## human can actually still move buffers around, while still
180   ## programmatically being able to pop stuff up in the middle of
181   ## drawing a window without worrying about covering it up.
182   ##
183   ## if we ever start calling roll_buffers programmatically, we will
184   ## have to change this. but it's not clear that we will ever actually
185   ## do that.
186   def roll_buffers
187     @buffers.last.force_to_top = false
188     raise_to_front @buffers.first
189   end
190
191   def roll_buffers_backwards
192     return unless @buffers.length > 1
193     @buffers.last.force_to_top = false
194     raise_to_front @buffers[@buffers.length - 2]
195   end
196
197   def handle_input c
198     if @focus_buf
199       if @focus_buf.mode.in_search? && c != CONTINUE_IN_BUFFER_SEARCH_KEY[0]
200         @focus_buf.mode.cancel_search!
201         @focus_buf.mark_dirty
202       end
203       @focus_buf.mode.handle_input c
204     end
205   end
206
207   def exists? n; @name_map.member? n; end
208   def [] n; @name_map[n]; end
209   def []= n, b
210     raise ArgumentError, "duplicate buffer name" if b && @name_map.member?(n)
211     raise ArgumentError, "title must be a string" unless n.is_a? String
212     @name_map[n] = b
213   end
214
215   def completely_redraw_screen
216     return if @shelled
217
218     Ncurses.sync do
219       @dirty = true
220       Ncurses.clear
221       draw_screen :sync => false
222     end
223   end
224
225   def draw_screen opts={}
226     return if @shelled
227
228     Ncurses.mutex.lock unless opts[:sync] == false
229
230     ## disabling this for the time being, to help with debugging
231     ## (currently we only have one buffer visible at a time).
232     ## TODO: reenable this if we allow multiple buffers
233     false && @buffers.inject(@dirty) do |dirty, buf|
234       buf.resize Ncurses.rows - minibuf_lines, Ncurses.cols
235       #dirty ? buf.draw : buf.redraw
236       buf.draw
237       dirty
238     end
239
240     ## quick hack
241     if true
242       buf = @buffers.last
243       buf.resize Ncurses.rows - minibuf_lines, Ncurses.cols
244       @dirty ? buf.draw : buf.redraw
245     end
246
247     draw_minibuf :sync => false unless opts[:skip_minibuf]
248
249     @dirty = false
250     Ncurses.doupdate
251     Ncurses.refresh if opts[:refresh]
252     Ncurses.mutex.unlock unless opts[:sync] == false
253   end
254
255   ## gets the mode from the block, which is only called if the buffer
256   ## doesn't already exist. this is useful in the case that generating
257   ## the mode is expensive, as it often is.
258   def spawn_unless_exists title, opts={}
259     if @name_map.member? title
260       raise_to_front @name_map[title] unless opts[:hidden]
261     else
262       mode = yield
263       spawn title, mode, opts
264     end
265     @name_map[title]
266   end
267
268   def spawn title, mode, opts={}
269     raise ArgumentError, "title must be a string" unless title.is_a? String
270     realtitle = title
271     num = 2
272     while @name_map.member? realtitle
273       realtitle = "#{title} <#{num}>"
274       num += 1
275     end
276
277     width = opts[:width] || Ncurses.cols
278     height = opts[:height] || Ncurses.rows - 1
279
280     ## since we are currently only doing multiple full-screen modes,
281     ## use stdscr for each window. once we become more sophisticated,
282     ## we may need to use a new Ncurses::WINDOW
283     ##
284     ## w = Ncurses::WINDOW.new(height, width, (opts[:top] || 0),
285     ## (opts[:left] || 0))
286     w = Ncurses.stdscr
287     b = Buffer.new w, mode, width, height, :title => realtitle, :force_to_top => (opts[:force_to_top] || false)
288     mode.buffer = b
289     @name_map[realtitle] = b
290
291     @buffers.unshift b
292     if opts[:hidden]
293       focus_on b unless @focus_buf
294     else
295       raise_to_front b
296     end
297     b
298   end
299
300   ## requires the mode to have #done? and #value methods
301   def spawn_modal title, mode, opts={}
302     b = spawn title, mode, opts
303     draw_screen
304
305     until mode.done?
306       c = Ncurses.nonblocking_getch
307       next unless c # getch timeout
308       break if c == Ncurses::KEY_CANCEL
309       mode.handle_input c
310       draw_screen
311       erase_flash
312     end
313
314     kill_buffer b
315     mode.value
316   end
317
318   def kill_all_buffers_safely
319     until @buffers.empty?
320       ## inbox mode always claims it's unkillable. we'll ignore it.
321       return false unless @buffers.last.mode.is_a?(InboxMode) || @buffers.last.mode.killable?
322       kill_buffer @buffers.last
323     end
324     true
325   end
326
327   def kill_buffer_safely buf
328     return false unless buf.mode.killable?
329     kill_buffer buf
330     true
331   end
332
333   def kill_all_buffers
334     kill_buffer @buffers.first until @buffers.empty?
335   end
336
337   def kill_buffer buf
338     raise ArgumentError, "buffer not on stack: #{buf.inspect}" unless @buffers.member? buf
339
340     buf.mode.cleanup
341     @buffers.delete buf
342     @name_map.delete buf.title
343     @focus_buf = nil if @focus_buf == buf
344     if @buffers.empty?
345       ## TODO: something intelligent here
346       ## for now I will simply prohibit killing the inbox buffer.
347     else
348       raise_to_front @buffers.last
349     end
350   end
351
352   def ask_with_completions domain, question, completions, default=nil
353     ask domain, question, default do |s|
354       completions.select { |x| x =~ /^#{s}/i }.map { |x| [x, x] }
355     end
356   end
357
358   def ask_many_with_completions domain, question, completions, default=nil, sep=" "
359     ask domain, question, default do |partial|
360       prefix, target = 
361         case partial#.gsub(/#{sep}+/, sep)
362         when /^\s*$/
363           ["", ""]
364         when /^(.+#{sep})$/
365           [$1, ""]
366         when /^(.*#{sep})?(.+?)$/
367           [$1 || "", $2]
368         else
369           raise "william screwed up completion: #{partial.inspect}"
370         end
371
372       completions.select { |x| x =~ /^#{target}/i }.map { |x| [prefix + x, x] }
373     end
374   end
375
376   def ask_for_filename domain, question, default=nil
377     answer = ask domain, question, default do |s|
378       if s =~ /(~([^\s\/]*))/ # twiddle directory expansion
379         full = $1
380         name = $2.empty? ? Etc.getlogin : $2
381         dir = Etc.getpwnam(name).dir rescue nil
382         if dir
383           [[s.sub(full, dir), "~#{name}"]]
384         else
385           users.select { |u| u =~ /^#{name}/ }.map do |u|
386             [s.sub("~#{name}", "~#{u}"), "~#{u}"]
387           end
388         end
389       else # regular filename completion
390         Dir["#{s}*"].sort.map do |fn|
391           suffix = File.directory?(fn) ? "/" : ""
392           [fn + suffix, File.basename(fn) + suffix]
393         end
394       end
395     end
396
397     if answer
398       answer = 
399         if answer.empty?
400           spawn_modal "file browser", FileBrowserMode.new
401         elsif File.directory?(answer)
402           spawn_modal "file browser", FileBrowserMode.new(answer)
403         else
404           answer
405         end
406     end
407
408     answer
409   end
410
411   ## returns an array of labels
412   def ask_for_labels domain, question, default_labels, forbidden_labels=[]
413     default_labels = default_labels - forbidden_labels - LabelManager::RESERVED_LABELS
414     default = default_labels.join(" ")
415     default += " " unless default.empty?
416
417     applyable_labels = (LabelManager.applyable_labels - forbidden_labels).map { |l| LabelManager.string_for l }.sort_by { |s| s.downcase }
418
419     answer = ask_many_with_completions domain, question, applyable_labels, default
420
421     return unless answer
422
423     user_labels = answer.split(/\s+/).map { |l| l.intern }
424     user_labels.each do |l|
425       if forbidden_labels.include?(l) || LabelManager::RESERVED_LABELS.include?(l)
426         BufferManager.flash "'#{l}' is a reserved label!"
427         return
428       end
429     end
430     user_labels
431   end
432
433   def ask_for_contacts domain, question, default_contacts=[]
434     default = default_contacts.map { |s| s.to_s }.join(" ")
435     default += " " unless default.empty?
436     
437     recent = Index.load_contacts(AccountManager.user_emails, :num => 10).map { |c| [c.longname, c.email] }
438     contacts = ContactManager.contacts.map { |c| [ContactManager.alias_for(c), c.longname, c.email] }
439
440     Redwood::log "recent: #{recent.inspect}"
441
442     completions = (recent + contacts).flatten.uniq.sort
443     answer = BufferManager.ask_many_with_completions domain, question, completions, default, /\s*,\s*/
444
445     if answer
446       answer.split_on_commas.map { |x| ContactManager.contact_for(x.downcase) || PersonManager.person_for(x) }
447     end
448   end
449
450
451   def ask domain, question, default=nil, &block
452     raise "impossible!" if @asking
453     @asking = true
454
455     @textfields[domain] ||= TextField.new Ncurses.stdscr, Ncurses.rows - 1, 0, Ncurses.cols
456     tf = @textfields[domain]
457     completion_buf = nil
458
459     ## this goddamn ncurses form shit is a fucking 1970's nightmare.
460     ## jesus christ. the exact sequence of ncurses events that needs
461     ## to happen in order to display a form and have the entire screen
462     ## not disappear and have the cursor in the right place is TOO
463     ## FUCKING COMPLICATED.
464     Ncurses.sync do
465       tf.activate question, default, &block
466       @dirty = true
467       draw_screen :skip_minibuf => true, :sync => false
468     end
469
470     ret = nil
471     tf.position_cursor
472     Ncurses.sync { Ncurses.refresh }
473
474     while true
475       c = Ncurses.nonblocking_getch
476       next unless c # getch timeout
477       break unless tf.handle_input c # process keystroke
478
479       if tf.new_completions?
480         kill_buffer completion_buf if completion_buf
481         
482         shorts = tf.completions.map { |full, short| short }
483         prefix_len = shorts.shared_prefix.length
484
485         mode = CompletionMode.new shorts, :header => "Possible completions for \"#{tf.value}\": ", :prefix_len => prefix_len
486         completion_buf = spawn "<completions>", mode, :height => 10
487
488         draw_screen :skip_minibuf => true
489         tf.position_cursor
490       elsif tf.roll_completions?
491         completion_buf.mode.roll
492         draw_screen :skip_minibuf => true
493         tf.position_cursor
494       end
495
496       Ncurses.sync { Ncurses.refresh }
497     end
498     
499     Ncurses.sync { tf.deactivate }
500     kill_buffer completion_buf if completion_buf
501     @dirty = true
502     @asking = false
503     draw_screen
504     tf.value
505   end
506
507   ## some pretty lame code in here!
508   def ask_getch question, accept=nil
509     accept = accept.split(//).map { |x| x[0] } if accept
510
511     flash question
512     Ncurses.sync do
513       Ncurses.curs_set 1
514       Ncurses.move Ncurses.rows - 1, question.length + 1
515       Ncurses.refresh
516     end
517
518     ret = nil
519     done = false
520     @shelled = true
521     until done
522       key = Ncurses.nonblocking_getch or next
523       if key == Ncurses::KEY_CANCEL
524         done = true
525       elsif (accept && accept.member?(key)) || !accept
526         ret = key
527         done = true
528       end
529     end
530
531     @shelled = false
532
533     Ncurses.sync do
534       Ncurses.curs_set 0
535       erase_flash
536       draw_screen :sync => false
537       Ncurses.curs_set 0
538     end
539
540     ret
541   end
542
543   ## returns true (y), false (n), or nil (ctrl-g / cancel)
544   def ask_yes_or_no question
545     case(r = ask_getch question, "ynYN")
546     when ?y, ?Y
547       true
548     when nil
549       nil
550     else
551       false
552     end
553   end
554
555   def minibuf_lines
556     @minibuf_mutex.synchronize do
557       [(@flash ? 1 : 0) + 
558        (@asking ? 1 : 0) +
559        @minibuf_stack.compact.size, 1].max
560     end
561   end
562   
563   def draw_minibuf opts={}
564     m = nil
565     @minibuf_mutex.synchronize do
566       m = @minibuf_stack.compact
567       m << @flash if @flash
568       m << "" if m.empty?
569     end
570
571     Ncurses.mutex.lock unless opts[:sync] == false
572     Ncurses.attrset Colormap.color_for(:none)
573     adj = @asking ? 2 : 1
574     m.each_with_index do |s, i|
575       Ncurses.mvaddstr Ncurses.rows - i - adj, 0, s + (" " * [Ncurses.cols - s.length, 0].max)
576     end
577     Ncurses.refresh if opts[:refresh]
578     Ncurses.mutex.unlock unless opts[:sync] == false
579   end
580
581   def say s, id=nil
582     new_id = nil
583
584     @minibuf_mutex.synchronize do
585       new_id = id.nil?
586       id ||= @minibuf_stack.length
587       @minibuf_stack[id] = s
588     end
589
590     if new_id
591       draw_screen :refresh => true
592     else
593       draw_minibuf :refresh => true
594     end
595
596     if block_given?
597       begin
598         yield id
599       ensure
600         clear id
601       end
602     end
603     id
604   end
605
606   def erase_flash; @flash = nil; end
607
608   def flash s
609     @flash = s
610     draw_screen :refresh => true
611   end
612
613   ## a little tricky because we can't just delete_at id because ids
614   ## are relative (they're positions into the array).
615   def clear id
616     @minibuf_mutex.synchronize do
617       @minibuf_stack[id] = nil
618       if id == @minibuf_stack.length - 1
619         id.downto(0) do |i|
620           break if @minibuf_stack[i]
621           @minibuf_stack.delete_at i
622         end
623       end
624     end
625
626     draw_screen :refresh => true
627   end
628
629   def shell_out command
630     @shelled = true
631     Ncurses.sync do
632       Ncurses.endwin
633       system command
634       Ncurses.refresh
635       Ncurses.curs_set 0
636     end
637     @shelled = false
638   end
639
640 private
641
642   def users
643     unless @users
644       @users = []
645       while(u = Etc.getpwent)
646         @users << u.name
647       end
648     end
649     @users
650   end
651 end
652 end