]> git.cworth.org Git - sup/blob - lib/sup/buffer.rb
more minibuf say vs ask tweaking
[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     return unless @buffers.member? buf
159
160     return if buf == @focus_buf 
161     @focus_buf.blur if @focus_buf
162     @focus_buf = buf
163     @focus_buf.focus
164   end
165
166   def raise_to_front buf
167     return unless @buffers.member? buf
168
169     @buffers.delete buf
170     if @buffers.length > 0 && @buffers.last.force_to_top?
171       @buffers.insert(-2, buf)
172     else
173       @buffers.push buf
174       focus_on buf
175     end
176     @dirty = true
177   end
178
179   ## we reset force_to_top when rolling buffers. this is so that the
180   ## human can actually still move buffers around, while still
181   ## programmatically being able to pop stuff up in the middle of
182   ## drawing a window without worrying about covering it up.
183   ##
184   ## if we ever start calling roll_buffers programmatically, we will
185   ## have to change this. but it's not clear that we will ever actually
186   ## do that.
187   def roll_buffers
188     @buffers.last.force_to_top = false
189     raise_to_front @buffers.first
190   end
191
192   def roll_buffers_backwards
193     return unless @buffers.length > 1
194     @buffers.last.force_to_top = false
195     raise_to_front @buffers[@buffers.length - 2]
196   end
197
198   def handle_input c
199     if @focus_buf
200       if @focus_buf.mode.in_search? && c != CONTINUE_IN_BUFFER_SEARCH_KEY[0]
201         @focus_buf.mode.cancel_search!
202         @focus_buf.mark_dirty
203       end
204       @focus_buf.mode.handle_input c
205     end
206   end
207
208   def exists? n; @name_map.member? n; end
209   def [] n; @name_map[n]; end
210   def []= n, b
211     raise ArgumentError, "duplicate buffer name" if b && @name_map.member?(n)
212     raise ArgumentError, "title must be a string" unless n.is_a? String
213     @name_map[n] = b
214   end
215
216   def completely_redraw_screen
217     return if @shelled
218
219     Ncurses.sync do
220       @dirty = true
221       Ncurses.clear
222       draw_screen :sync => false
223     end
224   end
225
226   def draw_screen opts={}
227     return if @shelled
228
229     Ncurses.mutex.lock unless opts[:sync] == false
230
231     ## disabling this for the time being, to help with debugging
232     ## (currently we only have one buffer visible at a time).
233     ## TODO: reenable this if we allow multiple buffers
234     false && @buffers.inject(@dirty) do |dirty, buf|
235       buf.resize Ncurses.rows - minibuf_lines, Ncurses.cols
236       #dirty ? buf.draw : buf.redraw
237       buf.draw
238       dirty
239     end
240
241     ## quick hack
242     if true
243       buf = @buffers.last
244       buf.resize Ncurses.rows - minibuf_lines, Ncurses.cols
245       @dirty ? buf.draw : buf.redraw
246     end
247
248     draw_minibuf :sync => false unless opts[:skip_minibuf]
249
250     @dirty = false
251     Ncurses.doupdate
252     Ncurses.refresh if opts[:refresh]
253     Ncurses.mutex.unlock unless opts[:sync] == false
254   end
255
256   ## gets the mode from the block, which is only called if the buffer
257   ## doesn't already exist. this is useful in the case that generating
258   ## the mode is expensive, as it often is.
259   def spawn_unless_exists title, opts={}
260     if @name_map.member? title
261       raise_to_front @name_map[title] unless opts[:hidden]
262       nil
263     else
264       mode = yield
265       spawn title, mode, opts
266       @name_map[title]
267     end
268   end
269
270   def spawn title, mode, opts={}
271     raise ArgumentError, "title must be a string" unless title.is_a? String
272     realtitle = title
273     num = 2
274     while @name_map.member? realtitle
275       realtitle = "#{title} <#{num}>"
276       num += 1
277     end
278
279     width = opts[:width] || Ncurses.cols
280     height = opts[:height] || Ncurses.rows - 1
281
282     ## since we are currently only doing multiple full-screen modes,
283     ## use stdscr for each window. once we become more sophisticated,
284     ## we may need to use a new Ncurses::WINDOW
285     ##
286     ## w = Ncurses::WINDOW.new(height, width, (opts[:top] || 0),
287     ## (opts[:left] || 0))
288     w = Ncurses.stdscr
289     b = Buffer.new w, mode, width, height, :title => realtitle, :force_to_top => (opts[:force_to_top] || false)
290     mode.buffer = b
291     @name_map[realtitle] = b
292
293     @buffers.unshift b
294     if opts[:hidden]
295       focus_on b unless @focus_buf
296     else
297       raise_to_front b
298     end
299     b
300   end
301
302   ## requires the mode to have #done? and #value methods
303   def spawn_modal title, mode, opts={}
304     b = spawn title, mode, opts
305     draw_screen
306
307     until mode.done?
308       c = Ncurses.nonblocking_getch
309       next unless c # getch timeout
310       break if c == Ncurses::KEY_CANCEL
311       mode.handle_input c
312       draw_screen
313       erase_flash
314     end
315
316     kill_buffer b
317     mode.value
318   end
319
320   def kill_all_buffers_safely
321     until @buffers.empty?
322       ## inbox mode always claims it's unkillable. we'll ignore it.
323       return false unless @buffers.last.mode.is_a?(InboxMode) || @buffers.last.mode.killable?
324       kill_buffer @buffers.last
325     end
326     true
327   end
328
329   def kill_buffer_safely buf
330     return false unless buf.mode.killable?
331     kill_buffer buf
332     true
333   end
334
335   def kill_all_buffers
336     kill_buffer @buffers.first until @buffers.empty?
337   end
338
339   def kill_buffer buf
340     raise ArgumentError, "buffer not on stack: #{buf.inspect}" unless @buffers.member? buf
341
342     buf.mode.cleanup
343     @buffers.delete buf
344     @name_map.delete buf.title
345     @focus_buf = nil if @focus_buf == buf
346     if @buffers.empty?
347       ## TODO: something intelligent here
348       ## for now I will simply prohibit killing the inbox buffer.
349     else
350       last = @buffers.last
351       @focus_buf ||= last
352       raise_to_front last
353     end
354   end
355
356   def ask_with_completions domain, question, completions, default=nil
357     ask domain, question, default do |s|
358       completions.select { |x| x =~ /^#{s}/i }.map { |x| [x, x] }
359     end
360   end
361
362   def ask_many_with_completions domain, question, completions, default=nil
363     ask domain, question, default do |partial|
364       prefix, target = 
365         case partial
366         when /^\s*$/
367           ["", ""]
368         when /^(.*\s+)?(.*?)$/
369           [$1 || "", $2]
370         else
371           raise "william screwed up completion: #{partial.inspect}"
372         end
373
374       completions.select { |x| x =~ /^#{target}/i }.map { |x| [prefix + x, x] }
375     end
376   end
377
378   def ask_many_emails_with_completions domain, question, completions, default=nil
379     ask domain, question, default do |partial|
380       prefix, target = partial.split_on_commas_with_remainder
381       Redwood::log "before: prefix #{prefix.inspect}, target #{target.inspect}"
382       target ||= prefix.pop || ""
383       prefix = prefix.join(", ") + (prefix.empty? ? "" : ", ")
384       Redwood::log "after: prefix #{prefix.inspect}, target #{target.inspect}"
385       completions.select { |x| x =~ /^#{target}/i }.map { |x| [prefix + x, x] }
386     end
387   end
388
389   def ask_for_filename domain, question, default=nil
390     answer = ask domain, question, default do |s|
391       if s =~ /(~([^\s\/]*))/ # twiddle directory expansion
392         full = $1
393         name = $2.empty? ? Etc.getlogin : $2
394         dir = Etc.getpwnam(name).dir rescue nil
395         if dir
396           [[s.sub(full, dir), "~#{name}"]]
397         else
398           users.select { |u| u =~ /^#{name}/ }.map do |u|
399             [s.sub("~#{name}", "~#{u}"), "~#{u}"]
400           end
401         end
402       else # regular filename completion
403         Dir["#{s}*"].sort.map do |fn|
404           suffix = File.directory?(fn) ? "/" : ""
405           [fn + suffix, File.basename(fn) + suffix]
406         end
407       end
408     end
409
410     if answer
411       answer = 
412         if answer.empty?
413           spawn_modal "file browser", FileBrowserMode.new
414         elsif File.directory?(answer)
415           spawn_modal "file browser", FileBrowserMode.new(answer)
416         else
417           answer
418         end
419     end
420
421     answer
422   end
423
424   ## returns an array of labels
425   def ask_for_labels domain, question, default_labels, forbidden_labels=[]
426     default_labels = default_labels - forbidden_labels - LabelManager::RESERVED_LABELS
427     default = default_labels.join(" ")
428     default += " " unless default.empty?
429
430     applyable_labels = (LabelManager.applyable_labels - forbidden_labels).map { |l| LabelManager.string_for l }.sort_by { |s| s.downcase }
431
432     answer = ask_many_with_completions domain, question, applyable_labels, default
433
434     return unless answer
435
436     user_labels = answer.split(/\s+/).map { |l| l.intern }
437     user_labels.each do |l|
438       if forbidden_labels.include?(l) || LabelManager::RESERVED_LABELS.include?(l)
439         BufferManager.flash "'#{l}' is a reserved label!"
440         return
441       end
442     end
443     user_labels
444   end
445
446   def ask_for_contacts domain, question, default_contacts=[]
447     default = default_contacts.map { |s| s.to_s }.join(" ")
448     default += " " unless default.empty?
449     
450     recent = Index.load_contacts(AccountManager.user_emails, :num => 10).map { |c| [c.full_address, c.email] }
451     contacts = ContactManager.contacts.map { |c| [ContactManager.alias_for(c), c.full_address, c.email] }
452
453     completions = (recent + contacts).flatten.uniq.sort
454     answer = BufferManager.ask_many_emails_with_completions domain, question, completions, default
455
456     if answer
457       answer.split_on_commas.map { |x| ContactManager.contact_for(x.downcase) || PersonManager.person_for(x) }
458     end
459   end
460
461
462   def ask domain, question, default=nil, &block
463     raise "impossible!" if @asking
464     @asking = true
465
466     @textfields[domain] ||= TextField.new Ncurses.stdscr, Ncurses.rows - 1, 0, Ncurses.cols
467     tf = @textfields[domain]
468     completion_buf = nil
469
470     ## this goddamn ncurses form shit is a fucking 1970's nightmare.
471     ## jesus christ. the exact sequence of ncurses events that needs
472     ## to happen in order to display a form and have the entire screen
473     ## not disappear and have the cursor in the right place is TOO
474     ## FUCKING COMPLICATED.
475     Ncurses.sync do
476       tf.activate question, default, &block
477       @dirty = true
478       draw_screen :skip_minibuf => true, :sync => false
479       tf.position_cursor
480       Ncurses.refresh
481     end
482
483     while true
484       c = Ncurses.nonblocking_getch
485       next unless c # getch timeout
486       break unless tf.handle_input c # process keystroke
487
488       if tf.new_completions?
489         kill_buffer completion_buf if completion_buf
490         
491         shorts = tf.completions.map { |full, short| short }
492         prefix_len = shorts.shared_prefix.length
493
494         mode = CompletionMode.new shorts, :header => "Possible completions for \"#{tf.value}\": ", :prefix_len => prefix_len
495         completion_buf = spawn "<completions>", mode, :height => 10
496
497         draw_screen
498         tf.position_cursor
499       elsif tf.roll_completions?
500         completion_buf.mode.roll
501         draw_screen
502         tf.position_cursor
503       end
504
505       Ncurses.sync { Ncurses.refresh }
506     end
507     
508     Ncurses.sync { tf.deactivate }
509     kill_buffer completion_buf if completion_buf
510     @dirty = true
511     @asking = false
512     draw_screen
513     tf.value
514   end
515
516   ## some pretty lame code in here!
517   def ask_getch question, accept=nil
518     accept = accept.split(//).map { |x| x[0] } if accept
519
520     flash question
521     Ncurses.sync do
522       Ncurses.curs_set 1
523       Ncurses.move Ncurses.rows - 1, question.length + 1
524       Ncurses.refresh
525     end
526
527     ret = nil
528     done = false
529     @shelled = true
530     until done
531       key = Ncurses.nonblocking_getch or next
532       if key == Ncurses::KEY_CANCEL
533         done = true
534       elsif (accept && accept.member?(key)) || !accept
535         ret = key
536         done = true
537       end
538     end
539
540     @shelled = false
541
542     Ncurses.sync do
543       Ncurses.curs_set 0
544       erase_flash
545       draw_screen :sync => false
546       Ncurses.curs_set 0
547     end
548
549     ret
550   end
551
552   ## returns true (y), false (n), or nil (ctrl-g / cancel)
553   def ask_yes_or_no question
554     case(r = ask_getch question, "ynYN")
555     when ?y, ?Y
556       true
557     when nil
558       nil
559     else
560       false
561     end
562   end
563
564   def minibuf_lines
565     @minibuf_mutex.synchronize do
566       [(@flash ? 1 : 0) + 
567        (@asking ? 1 : 0) +
568        @minibuf_stack.compact.size, 1].max
569     end
570   end
571   
572   def draw_minibuf opts={}
573     m = nil
574     @minibuf_mutex.synchronize do
575       m = @minibuf_stack.compact
576       m << @flash if @flash
577       m << "" if m.empty?
578     end
579
580     Ncurses.mutex.lock unless opts[:sync] == false
581     Ncurses.attrset Colormap.color_for(:none)
582     adj = @asking ? 2 : 1
583     m.each_with_index do |s, i|
584       Ncurses.mvaddstr Ncurses.rows - i - adj, 0, s + (" " * [Ncurses.cols - s.length, 0].max)
585     end
586     Ncurses.refresh if opts[:refresh]
587     Ncurses.mutex.unlock unless opts[:sync] == false
588   end
589
590   def say s, id=nil
591     new_id = nil
592
593     @minibuf_mutex.synchronize do
594       new_id = id.nil?
595       id ||= @minibuf_stack.length
596       @minibuf_stack[id] = s
597     end
598
599     if new_id
600       draw_screen :refresh => true
601     else
602       draw_minibuf :refresh => true
603     end
604
605     if block_given?
606       begin
607         yield id
608       ensure
609         clear id
610       end
611     end
612     id
613   end
614
615   def erase_flash; @flash = nil; end
616
617   def flash s
618     @flash = s
619     draw_screen :refresh => true
620   end
621
622   ## a little tricky because we can't just delete_at id because ids
623   ## are relative (they're positions into the array).
624   def clear id
625     @minibuf_mutex.synchronize do
626       @minibuf_stack[id] = nil
627       if id == @minibuf_stack.length - 1
628         id.downto(0) do |i|
629           break if @minibuf_stack[i]
630           @minibuf_stack.delete_at i
631         end
632       end
633     end
634
635     draw_screen :refresh => true
636   end
637
638   def shell_out command
639     @shelled = true
640     Ncurses.sync do
641       Ncurses.endwin
642       system command
643       Ncurses.refresh
644       Ncurses.curs_set 0
645     end
646     @shelled = false
647   end
648
649 private
650
651   def users
652     unless @users
653       @users = []
654       while(u = Etc.getpwent)
655         @users << u.name
656       end
657     end
658     @users
659   end
660 end
661 end