Class: Canis::Bottomline
- Defined in:
- lib/canis/core/util/extras/bottomline.rb
Overview
some variables are polluting space of including app, we should make this a class.
Defined Under Namespace
Classes: Menu, Question, QuestionError
Instance Attribute Summary collapse
-
#message_row ⇒ Object
Returns the value of attribute message_row.
-
#name ⇒ Object
for debugging.
-
#window ⇒ Object
Returns the value of attribute window.
Instance Method Summary collapse
-
#_create_footer_window(h = 1, w = Ncurses.COLS, t = Ncurses.LINES-1, l = 0) ⇒ Object
create a window at bottom and show and hide it.
- #agree(yes_or_no_question, character = nil) ⇒ Object
-
#ask(question, answer_type = String, &details) ⇒ Object
— highline classes }}}.
-
#choose(list1, config = {}) ⇒ Object
Allows a selection in which options are shown over prompt.
-
#clear_line(len = 100, from = 0) ⇒ Object
clears line from 0, not okay in some cases.
-
#destroy ⇒ Object
destroy window, to be called by app when shutting down since we are normally hiding the window only.
-
#display_list(text, config = {}) ⇒ Object
XXX FIXME this uses only rcommand so what is it doing here.
-
#display_text_interactive(text, config = {}) ⇒ Object
XXX FIXME this uses only rcommand so what is it doing here.
-
#explain_error(error) ⇒ Object
A helper method for sending the output stream and error and repeat of the question.
- #get_response ⇒ Object
-
#hide(wait = nil) ⇒ Object
(also: #hide_bottomline)
bottomline user has to hide window if he called say().
-
#initialize(win = nil, row = nil) ⇒ Bottomline
constructor
A new instance of Bottomline.
-
#list(items, mode = :rows, option = nil) ⇒ Object
Each member of the items Array is passed through ERb and thus can contain their own expansions.
- #print_help(help_text) ⇒ Object
-
#print_str(text, config = {}) ⇒ Object
Internal method for printing a string.
-
#rb_getstr ⇒ Object
actual input routine, gets each character from user, taking care of echo, limit, completion proc, and some control characters such as C-a, C-e, C-k Taken from io.rb, has some improvements to it.
-
#say(statement, config = {}) ⇒ Object
The basic output method for HighLine objects.
-
#say_with_pause(statement, config = {}) ⇒ Object
display some text at bottom and wait for a key before hiding window.
-
#say_with_wait(statement, config = {}) ⇒ Object
since say does not leave the screen, it is not exactly recommended as it will hide what’s below.
-
#shortest_match(a) ⇒ Object
compares entries in array and returns longest common starting string as happens in bash when pressing tab abc abd abe will return ab.
-
#XXXchoose(*items, &details) ⇒ Object
This method is HighLine’s menu handler.
Constructor Details
#initialize(win = nil, row = nil) ⇒ Bottomline
Returns a new instance of Bottomline.
94 95 96 97 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 94 def initialize win=nil, row=nil @window = win @message_row = 0 # 2011-10-8 end |
Instance Attribute Details
#message_row ⇒ Object
Returns the value of attribute message_row.
92 93 94 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 92 def @message_row end |
#name ⇒ Object
for debugging
93 94 95 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 93 def name @name end |
#window ⇒ Object
Returns the value of attribute window.
91 92 93 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 91 def window @window end |
Instance Method Details
#_create_footer_window(h = 1, w = Ncurses.COLS, t = Ncurses.LINES-1, l = 0) ⇒ Object
create a window at bottom and show and hide it.
101 102 103 104 105 106 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 101 def h = 1 , w = Ncurses.COLS, t = Ncurses.LINES-1, l = 0 ewin = Canis::Window.new(h, w , t, l) #ewin.bkgd(Ncurses.COLOR_PAIR($promptcolor)); @window = ewin return ewin end |
#agree(yes_or_no_question, character = nil) ⇒ Object
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1503 def agree( yes_or_no_question, character = nil ) ask(yes_or_no_question, lambda { |yn| yn.downcase[0] == ?y}) do |q| q.validate = /\Ay(?:es)?|no?\Z/i q.responses[:not_valid] = 'Please enter "yes" or "no".' q.responses[:ask_on_error] = :question q.character = character q.limit = 1 if character yield q if block_given? end end |
#ask(question, answer_type = String, &details) ⇒ Object
— highline classes }}}
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 977 def ask(question, answer_type=String, &details) $log.debug "XXXX inside ask win #{@window} " @window ||= #@window.show #unless @window.visible? @question ||= Question.new(question, answer_type, &details) say(@question) #unless @question.echo == true @completion_proc = @question.completion_proc @change_proc = @question.change_proc @key_handler_proc = @question.key_handler_proc @default = @question.default $log.debug "XXX: ASK RBGETS got default: #{@default} " @help_text = @question.help_text @answer_type = @question.answer_type if @question.answer_type.is_a? Array @completion_proc = Proc.new{|str| @answer_type.dup.grep Regexp.new("^#{str}") } end begin # FIXME a C-c still returns default to user ! @answer = @question.answer_or_default(get_response) unless @question.valid_answer?(@answer) explain_error(:not_valid) raise QuestionError end @answer = @question.convert(@answer) if @question.in_range?(@answer) if @question.confirm # need to add a layer of scope to ask a question inside a # question, without destroying instance data context_change = self.class.new(@input, @output, @wrap_at, @page_at) if @question.confirm == true confirm_question = "Are you sure? " else # evaluate ERb under initial scope, so it will have # access to @question and @answer template = ERB.new(@question.confirm, nil, "%") confirm_question = template.result(binding) end unless context_change.agree(confirm_question) explain_error(nil) raise QuestionError end end @answer else explain_error(:not_in_range) raise QuestionError end rescue QuestionError retry rescue ArgumentError, NameError => error #raise raise if error.is_a?(NoMethodError) if error. =~ /ambiguous/ # the assumption here is that OptionParser::Completion#complete # (used for ambiguity resolution) throws exceptions containing # the word 'ambiguous' whenever resolution fails explain_error(:ambiguous_completion) else explain_error(:invalid_type) end retry rescue Question::NoAutoCompleteMatch explain_error(:no_completion) retry rescue Interrupt $log.warn "User interrupted ask() get_response does not want operation to proceed" return nil ensure @question = nil # Reset Question object. $log.debug "XXX: HIDE B AT ENSURE OF ASK" hide_bottomline # assuming this method made it visible, not sure if this is called. end end |
#choose(list1, config = {}) ⇒ Object
Allows a selection in which options are shown over prompt. As user types options are narrowed down. NOTE: For a directory we are not showing a slash, so currently you have to enter the slash manually when searching. FIXME we can put remarks in fron as in memacs such as [No matches] or [single completion] NOTE: if you use this please copy it to your app. This does not conform to highline’s choose, and I’d like to somehow get it to be identical.
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1524 def choose list1, config={} dirlist = true start = 0 case list1 when NilClass #list1 = Dir.glob("*") list1 = Dir.glob("*").collect { |f| File.directory?(f) ? f+"/" : f } when String list1 = Dir.glob(list1).collect { |f| File.directory?(f) ? f+"/" : f } when Array dirlist = false # let it be, that's how it should come else # Dir listing as default #list1 = Dir.glob("*") list1 = Dir.glob("*").collect { |f| File.directory?(f) ? f+"/" : f } end require 'canis/core/util/rcommandwindow' prompt = config[:prompt] || "Choose: " layout = { :height => 5, :width => Ncurses.COLS-1, :top => Ncurses.LINES-6, :left => 0 } rc = CommandWindow.new nil, :layout => layout, :box => true, :title => config[:title] begin w = rc.window rc. list1 # earlier wmove bombed, now move is (window.rb 121) str = ask(prompt) { |q| q.help_text = config[:help_text] ; q.change_proc = Proc.new { |str| w.wmove(1,1) ; w.wclrtobot; l = list1.select{|e| e.index(str)==0} ; # select those starting with str if (l.size == 0 || str[-1]=='/') && dirlist # used to help complete directories so we can drill up and down #l = Dir.glob(str+"*") l = Dir.glob(str +"*").collect { |f| File.directory?(f) ? f+"/" : f } end rc. l; l } q.key_handler_proc = Proc.new { |ch| # this is not very good since it does not respect above list which is filtered # # need to clear the screen before printing - FIXME case ch when ?\C-n.getbyte(0) start += 2 if start < list1.length - 2 w.wmove(1,1) ; w.wclrtobot; rc. list1, :startindex => start when ?\C-p.getbyte(0) start -= 2 if start > 2 w.wmove(1,1) ; w.wclrtobot; rc. list1, :startindex => start else alert "unhalderlind by jey " end } } # need some validation here that its in the list TODO ensure rc.destroy rc = nil $log.debug "XXX: HIDE B IN ENSURE" hide_bottomline # since we called ask() we need to close bottomline end $log.debug "XXX: HIDE B AT END OF ASK" #hide_bottomline # since we called ask() we need to close bottomline return str end |
#clear_line(len = 100, from = 0) ⇒ Object
clears line from 0, not okay in some cases
1477 1478 1479 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1477 def clear_line len=100, from=0 print_str("%-*s" % [len," "], :y => from) end |
#destroy ⇒ Object
destroy window, to be called by app when shutting down since we are normally hiding the window only.
1083 1084 1085 1086 1087 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1083 def destroy $log.debug "bottomline destroy... #{@window} " @window.destroy if @window @window = nil end |
#display_list(text, config = {}) ⇒ Object
XXX FIXME this uses only rcommand so what is it doing here. def display_list_interactive text, config={} returns a ListObject since you may not know what the list itself contained You can do ret.list to get value
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1610 def display_list text, config={} require 'canis/core/util/rcommandwindow' ht = config[:height] || 15 layout = { :height => ht, :width => Ncurses.COLS-1, :top => Ncurses.LINES-ht+1, :left => 0 } rc = CommandWindow.new nil, :layout => layout, :box => true, :title => config[:title] w = rc.window ret = rc.display_interactive text rc = nil ret end |
#display_text_interactive(text, config = {}) ⇒ Object
XXX FIXME this uses only rcommand so what is it doing here.
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1592 def display_text_interactive text, config={} require 'canis/core/util/rcommandwindow' ht = config[:height] || 15 layout = { :height => ht, :width => Ncurses.COLS-1, :top => Ncurses.LINES-ht+1, :left => 0 } rc = CommandWindow.new nil, :layout => layout, :box => true, :title => config[:title] w = rc.window #rc.text "There was a quick brown fox who ran over the lazy dog and then went over the moon over and over again and again" rc.display_interactive(text) { |l| l.focussed_attrib = 'bold' # Ncurses::A_UNDERLINE l.focussed_symbol = '>' } rc = nil end |
#explain_error(error) ⇒ Object
A helper method for sending the output stream and error and repeat of the question.
FIXME: since we write on one line in say, this often gets overidden by next say or ask
1160 1161 1162 1163 1164 1165 1166 1167 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1160 def explain_error( error ) say_with_pause(@question.responses[error]) unless error.nil? if @question.responses[:ask_on_error] == :question say(@question) elsif @question.responses[:ask_on_error] say(@question.responses[:ask_on_error]) end end |
#get_response ⇒ Object
1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1487 def get_response return @question.first_answer if @question.first_answer? # we always use character reader, so user's value does not matter #if @question.character.nil? # if @question.echo == true #and @question.limit.nil? $log.debug "XXX: before RBGETS got default: #{@default} " ret, str = rb_getstr if ret == 0 return @question.change_case(@question.remove_whitespace(str)) end if ret == -1 raise Interrupt end return "" end |
#hide(wait = nil) ⇒ Object Also known as: hide_bottomline
bottomline user has to hide window if he called say().
Call this if you find the window persists after using some method from here
usually say or ask.
NOTE: after callign this you must call window.show. Otherwise, next time
you call this, it will not hide.
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1066 def hide wait=nil if @window $log.debug "XXX: HIDE BOTTOMLINE INSIDE" sleep(wait) if wait #if @window.visible? #@window.hide # THIS HAS SUDDENLY STOPPED WORKING @window.destroy @window = nil #@window.wrefresh #Ncurses::Panel.update_panels #end end end |
#list(items, mode = :rows, option = nil) ⇒ Object
Each member of the items Array is passed through ERb and thus can contain their own expansions. Color escape expansions do not contribute to the final field width.
1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1675 def list( items, mode = :rows, option = nil ) items = items.to_ary.map do |item| ERB.new(item, nil, "%").result(binding) end case mode when :inline option = " or " if option.nil? case items.size when 0 "" when 1 items.first when 2 "#{items.first}#{option}#{items.last}" else items[0..-2].join(", ") + "#{option}#{items.last}" end when :columns_across, :columns_down max_length = actual_length( items.max { |a, b| actual_length(a) <=> actual_length(b) } ) if option.nil? limit = @wrap_at || 80 option = (limit + 2) / (max_length + 2) end items = items.map do |item| pad = max_length + (item.length - actual_length(item)) "%-#{pad}s" % item end row_count = (items.size / option.to_f).ceil if mode == :columns_across rows = Array.new(row_count) { Array.new } items.each_with_index do |item, index| rows[index / option] << item end rows.map { |row| row.join(" ") + "\n" }.join else columns = Array.new(option) { Array.new } items.each_with_index do |item, index| columns[index / row_count] << item end list = "" columns.first.size.times do |index| list << columns.map { |column| column[index] }. compact.join(" ") + "\n" end list end else items.map { |i| "#{i}\n" }.join end end |
#print_help(help_text) ⇒ Object
1481 1482 1483 1484 1485 1486 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1481 def print_help(help_text) # best to popup a window and hsow that with ENTER to dispell print_str("%-*s" % [help_text.length+2," "]) print_str("%s" % help_text) sleep(5) end |
#print_str(text, config = {}) ⇒ Object
Internal method for printing a string
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1172 def print_str(text, config={}) win = config.fetch(:window, @window) # assuming its in App x = config.fetch :x, 0 # @message_row # Ncurses.LINES-1, 0 since one line window 2011-10-8 y = config.fetch :y, 0 $log.debug "XXX: print_str #{win} with text : #{text} at #{x} #{y} " color = config[:color_pair] || $datacolor raise "no window for ask print in #{self.class} name: #{name} " unless win color=Ncurses.COLOR_PAIR(color); win.attron(color); #win.mvprintw(x, y, "%-40s" % text); win.mvprintw(x, y, "%s" % text); win.attroff(color); win.refresh # FFI NW 2011-09-9 , added back gets overwritten end |
#rb_getstr ⇒ Object
actual input routine, gets each character from user, taking care of echo, limit, completion proc, and some control characters such as C-a, C-e, C-k Taken from io.rb, has some improvements to it. However, does not print the prompt any longer Completion proc is vim style, on pressing tab it cycles through options
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1192 def rb_getstr r = @message_row c = 0 win = @window @limit = @question.limit @history = @question.history @history_list = History.new(@history) maxlen = @limit || 100 # fixme raise "rb_getstr got no window. bottomline.rb" if win.nil? ins_mode = false oldstr = nil # for tab completion, origal word entered by user default = @default || "" $log.debug "XXX: RBGETS got default: #{@default} " if @default && @history if !@history.include?(default) @history_list.push default end end len = @prompt_length # clear the area of len+maxlen color = $datacolor str = "" #str = default cpentries = nil #clear_line len+maxlen+1 #print_str(prompt+str) print_str(str, :y => @prompt_length+0) if @default len = @prompt_length + str.length begin Ncurses.noecho(); curpos = str.length prevchar = 0 entries = nil while true ch=win.getchar() $log.debug " XXXX FFI rb_getstr got ch:#{ch}, str:#{str}. " case ch when 3 # -1 # C-c # sometimes this causes an interrupt and crash return -1, nil when ?\C-g.getbyte(0) # ABORT, emacs style return -1, nil when 10, 13 # hits ENTER, complete entry and return @history_list.push str break when ?\C-h.getbyte(0), ?\C-?.getbyte(0), KEY_BSPACE, 263 # delete previous character/backspace # C-h is giving 263 i/o 8. 2011-09-19 len -= 1 if len > @prompt_length curpos -= 1 if curpos > 0 str.slice!(curpos) clear_line len+maxlen+1, @prompt_length when 330 # delete character on cursor str.slice!(curpos) #rescue next clear_line len+maxlen+1, @prompt_length when ?\M-h.getbyte(0) # HELP KEY help_text = @help_text || "No help provided..." print_help(help_text) clear_line len+maxlen+1 print_str @statement # UGH #return 7, nil #next when KEY_LEFT curpos -= 1 if curpos > 0 len -= 1 if len > @prompt_length win.move r, c+len # since getchar is not going back on del and bs wmove to move FFIWINDOW win.wrefresh next when KEY_RIGHT if curpos < str.length curpos += 1 #if curpos < str.length len += 1 win.move r, c+len # since getchar is not going back on del and bs win.wrefresh end next when ?\C-a.getbyte(0) #olen = str.length clear_line len+maxlen+1, @prompt_length len -= curpos curpos = 0 win.move r, c+len # since getchar is not going back on del and bs when ?\C-e.getbyte(0) olen = str.length len += (olen - curpos) curpos = olen clear_line len+maxlen+1, @prompt_length win.move r, c+len # since getchar is not going back on del and bs when ?\M-i.getbyte(0) ins_mode = !ins_mode next when ?\C-k.getbyte(0) # delete forward @delete_buffer = str.slice!(curpos..-1) #rescue next clear_line len+maxlen+1, @prompt_length when ?\C-u.getbyte(0) # delete to the left of cursor till start of line @delete_buffer = str.slice!(0..curpos-1) #rescue next curpos = 0 clear_line len+maxlen+1, @prompt_length len = @prompt_length when ?\C-y.getbyte(0) # paste what's in delete buffer if @delete_buffer olen = str.length str << @delete_buffer if @delete_buffer curpos = str.length len += str.length - olen end when KEY_TAB # TAB if !@completion_proc.nil? # place cursor at end of completion # after all completions, what user entered should come back so he can edit it if prevchar == 9 if !entries.nil? and !entries.empty? olen = str.length str = entries.delete_at(0) str = str.to_s.dup #str = entries[@current_index].dup #@current_index += 1 #@current_index = 0 if @current_index == entries.length curpos = str.length len += str.length - olen clear_line len+maxlen+1, @prompt_length else olen = str.length str = oldstr if oldstr curpos = str.length len += str.length - olen clear_line len+maxlen+1, @prompt_length prevchar = ch = nil # so it can start again completing end else #@current_index = 0 tabc = @completion_proc unless tabc next unless tabc oldstr = str.dup olen = str.length entries = tabc.call(str).dup $log.debug "XXX tab [#{str}] got #{entries} " str = entries.delete_at(0) unless entries.nil? or entries.empty? #str = entries[@current_index].dup unless entries.nil? or entries.empty? #@current_index += 1 #@current_index = 0 if @current_index == entries.length str = str.to_s.dup if str curpos = str.length len += str.length - olen else alert "NO MORE 2" end end else # there's another type of completion that bash does, which is irritating # compared to what vim does, it does partial completion if cpentries olen = str.length if cpentries.size == 1 str = cpentries.first.dup elsif cpentries.size > 1 str = shortest_match(cpentries).dup end curpos = str.length len += str.length - olen end end when ?\C-a.getbyte(0) .. ?\C-z.getbyte(0) # here' swhere i wish i could pass stuff back without closing # I'd like the user to be able to scroll list or do something based on # control or other keys if @key_handler_proc # added 2011-11-3 7:38 PM @key_handler_proc.call(ch) next else Ncurses.beep end when KEY_UP if @history && !@history.empty? olen = str.length str = if prevchar == KEY_UP @history_list.previous elsif prevchar == KEY_DOWN @history_list.previous else @history_list.last end str = str.dup curpos = str.length len += str.length - olen clear_line len+maxlen+1, @prompt_length else # try to pick up default, seems we don't get it 2011-10-14 if @default olen = str.length str = @default str = str.dup curpos = str.length len += str.length - olen clear_line len+maxlen+1, @prompt_length end end when KEY_DOWN if @history && !@history.empty? olen = str.length str = if prevchar == KEY_UP @history_list.next elsif prevchar == KEY_DOWN @history_list.next else @history_list.first end str = str.dup curpos = str.length len += str.length - olen clear_line len+maxlen+1, @prompt_length end else if ch < 0 || ch > 255 Ncurses.beep next end # if control char, beep if ch.chr =~ /[[:cntrl:]]/ Ncurses.beep next end # we need to trap KEY_LEFT and RIGHT and what of UP for history ? if ins_mode str[curpos] = ch.chr else str.insert(curpos, ch.chr) # FIXME index out of range due to changeproc end len += 1 curpos += 1 break if str.length >= maxlen end case @question.echo when true begin cpentries = @change_proc.call(str) if @change_proc # added 2010-11-09 23:28 rescue => exc $log.error "bottomline: change_proc EXC #{exc} " if $log.debug? $log.error( exc) if exc $log.error(exc.backtrace.join("\n")) if exc Ncurses.error end print_str(str, :y => @prompt_length+0) when false # noop, no echoing what is typed else print_str(@question.echo * str.length, :y => @prompt_length+0) end win.move r, c+len # more for arrow keys, curpos may not be end win.wrefresh # 2011-10-10 prevchar = ch end $log.debug "XXXW bottomline: after while loop" str = default if str == "" ensure Ncurses.noecho(); end return 0, str end |
#say(statement, config = {}) ⇒ Object
The basic output method for HighLine objects.
The statement parameter is processed as an ERb template, supporting embedded Ruby code. The template is evaluated with a binding inside the HighLine instance. NOTE: modified from original highline, does not care about space at end of question. Also, ansi color constants will not work. Be careful what ruby code you pass in.
NOTE: This uses a window, so it will persist in the last row. You must call hide_bottomline to remove the window. It is preferable to call say_with_pause from user programs
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1103 def say statement, config={} @window ||= #@window.show #unless @window.visible? $log.debug "XXX: inside say win #{@window} !" case statement when Question if config.has_key? :color_pair $log.debug "INSIDE QUESTION 2 " if $log.debug? else $log.debug "XXXX SAY using colorpair: #{statement.color_pair} " if $log.debug? config[:color_pair] = statement.color_pair end else $log.debug "XXX INSDIE SAY #{statement.class} " if $log.debug? end statement = statement.to_str template = ERB.new(statement, nil, "%") statement = template.result(binding) @prompt_length = statement.length # required by ask since it prints after @statement = statement # clear_line print_str statement, config end |
#say_with_pause(statement, config = {}) ⇒ Object
display some text at bottom and wait for a key before hiding window
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1131 def say_with_pause statement, config={} @window ||= #@window.show #unless @window.visible? # 2011-10-14 23:52:52 say statement, config @window.wrefresh Ncurses::Panel.update_panels ch=@window.getchar() hide_bottomline ## return char so we can use for asking for one character return ch end |
#say_with_wait(statement, config = {}) ⇒ Object
since say does not leave the screen, it is not exactly recommended
as it will hide what's below. It's better to call pause, or this, which
will quickly go off. If the message is not important enough to ask for a pause,
the will flicker on screen, but not for too long.
1146 1147 1148 1149 1150 1151 1152 1153 1154 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1146 def say_with_wait statement, config={} @window ||= #@window.show #unless @window.visible? # 2011-10-14 23:52:59 say statement, config @window.wrefresh Ncurses::Panel.update_panels sleep 0.5 hide_bottomline end |
#shortest_match(a) ⇒ Object
compares entries in array and returns longest common starting string as happens in bash when pressing tab abc abd abe will return ab
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1460 def shortest_match a #return "" if a.nil? || a.empty? # should not be called in such situations raise "shortest_match should not be called with nil or empty array" if a.nil? || a.empty? # should not be called in such situations as caller program will err. l = a.inject do |memo,word| str = "" 0.upto(memo.size) do |i| if memo[0..i] == word[0..i] str = memo[0..i] else break end end str end end |
#XXXchoose(*items, &details) ⇒ Object
This method is HighLine’s menu handler. For simple usage, you can just pass all the menu items you wish to display. At that point, choose() will build and display a menu, walk the user through selection, and return their choice amoung the provided items. You might use this in a case statement for quick and dirty menus.
However, choose() is capable of much more. If provided, a block will be passed a HighLine::Menu object to configure. Using this method, you can customize all the details of menu handling from index display, to building a complete shell-like menuing system. See HighLine::Menu for all the methods it responds to.
Raises EOFError if input is exhausted.
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 |
# File 'lib/canis/core/util/extras/bottomline.rb', line 1635 def XXXchoose( *items, &details ) @menu = @question = Menu.new(&details) @menu.choices(*items) unless items.empty? # Set _answer_type_ so we can double as the Question for ask(). @menu.answer_type = if @menu.shell lambda do |command| # shell-style selection first_word = command.to_s.split.first || "" = @menu. .extend(OptionParser::Completion) answer = .complete(first_word) if answer.nil? raise Question::NoAutoCompleteMatch end [answer.last, command.sub(/^\s*#{first_word}\s*/, "")] end else @menu. # normal menu selection, by index or name end # Provide hooks for ERb layouts. @header = @menu.header @prompt = @menu.prompt if @menu.shell selected = ask("Ignored", @menu.answer_type) @menu.select(self, *selected) else selected = ask("Ignored", @menu.answer_type) @menu.select(self, selected) end end |