Class: Menu

Inherits:
Object show all
Defined in:
lib/xiki/menu.rb

Constant Summary collapse

ROOT_MENU = 
'Keys'
@@loaded_already = 
{}

Class Method Summary collapse

Class Method Details

.[](path) ⇒ Object 



338
339
340
341
342
 
# File 'lib/xiki/menu.rb', line 338

def self.[] path
  path, rest = path.split '/', 2

  self.call path, rest
end

.add_item(menu, name, function) ⇒ Object 



675
676
677
678
679
680
681
682
683
684
 
# File 'lib/xiki/menu.rb', line 675

def self.add_item menu, name, function

  menu_spaces = menu.join(' ').downcase
  lisp = "
    (define-key global-map
      [menu-bar #{menu_spaces} #{function}]
      '(\"#{name}\" . #{function}))
  "
  $el.el4r_lisp_eval lisp
end

.add_menu(*name) ⇒ Object

The following 3 methods are for the menu bar

- a different use of the "Menu" class

TODO move them into menu_bar.rb ?



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/xiki/menu.rb', line 659

def self.add_menu *name
  menu_spaces = name.join(' ').downcase
  menu_dashes = name.join('-').downcase
  name = name[-1]

  lisp = %Q<
    (define-key global-map
      [menu-bar #{menu_spaces}]
      (cons "#{name}" (make-sparse-keymap "#{menu_dashes}")))
  >
  $el.el4r_lisp_eval lisp

  menu = $el.elvar.menu_bar_final_items.to_a
  $el.elvar.menu_bar_final_items = menu.push(name.downcase.to_sym)
end

.append_line(name, addition) ⇒ Object

Create simple .menu file if it doesn’t exist, otherwise add line to it.

Menu.append_line “menu name”, “- text to add”



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/xiki/menu.rb', line 731

def self.append_line name, addition #, options={}

  name.gsub! /\W/, '_'

  # Default to ~/menu
  # If menu there, create, otherwise append

  # Get existing
  dir = File.expand_path "~/menu"
  Dir.mkdir dir if ! File.exists? dir

  file = File.expand_path "#{dir}/#{name}.menu"
  txt = File.read(file) rescue ""

  if txt =~ /^#{Regexp.escape addition}$/
    return ".flash - was already there!"
  end

  # Append to end (might be blank)

  txt << "#{addition}\n"

  # Save
  File.open(file, "w") { |f| f << txt }

  "- saved setting!"
end

.as_menu ⇒ Object 



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/xiki/menu.rb', line 432

def self.as_menu
  orig = View.cursor

  Tree.to_root

  root, left = Line.value, View.cursor
  root = Line.without_label :line=>root

  root = TextUtil.snake_case(root).sub(/^_+/, '')

  if Line.value(2) =~ /^ +\| Supply a few items here/   # If sample text, remove
    Line.next
    while Line.=~(/^ +\| /)
      Line.delete
    end
    Line.previous
    orig = nil
  end

  Tree.after_children
  right = View.cursor
  View.cursor = left

  # Go until end of paragraph (simple for now)
  Effects.blink :left=>left, :right=>right
  txt = View.txt left, right
  txt.sub! /.+\n/, ''
  txt.gsub! /^  /, ''
  txt.unindent

  return Tree << "| You must supply something to put under the '#{root}' menu.\n| First, add some lines here, such as these:\n- line/\n- another line/\n" if txt.empty?

  path = File.expand_path "~/menu/#{root}.menu"

  file_existed = File.exists? path

  if file_existed
    treeb = File.read path
    txt = Tree.restore txt, treeb

    DiffLog.save_diffs :patha=>path, :textb=>txt
  end

  File.open(path, "w") { |f| f << txt }

  View.cursor = orig if orig

  require_menu path

  View.flash "- #{file_existed ? 'Updated' : 'Created'} ~/menu/#{root}.menu", :times=>3
  nil
end

.call(root, rest = nil) ⇒ Object 



344
345
346
347
348
349
350
 
# File 'lib/xiki/menu.rb', line 344

def self.call root, rest=nil
  root = root.gsub /[ +]/, '_'
  menus = Launcher.menus
  block = menus[0][root] || menus[1][root]
  return if block.nil?
  Tree.output_and_search block, :line=>"#{root}/#{rest}", :just_return=>1
end

.collapser_launcher ⇒ Object 



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/xiki/menu.rb', line 505

def self.collapser_launcher

  line = Line.value
  arrows = line[/<+/].length
  arrows -= 1 if arrows > 1   # Make "<<" go back just 1, etc.

  #     line.sub! /(^ +)= /, "\\1< "   # Temporarily get "=" to work too
  line = Line.without_label :line=>line

  skip = line.empty? && arrows - 1

  Line.sub! /^(  +)<+ .+/, "\\1- "   # Delete after bullet to prepare for loop

  arrows.times do |i|

    # If no items left on current line, jump to parent and delete
    if Line =~ /^[ +-]+$/
      Tree.to_parent
      Tree.kill_under
      Move.to_end
    end

    unless i == skip   # Remove last item, or after bullet if no items
      Line.sub!(/\/[^\/]+\/$/, '/') || Line.sub!(/^([ @+-]*).*/, "\\1")
    end
  end

  if Line.indent.blank?
    line.sub! /^@ ?/, ''
    Line.sub! /^@ ?/, ''
  end

  Line << line unless skip
  Launcher.launch

end

.create(*args) ⇒ Object 



98
99
100
101
102
103
104
105
106
 
# File 'lib/xiki/menu.rb', line 98

def self.create *args
  type = args[0]

  return self.create_here if type == "here"
  return self.create_class if type == "class"
  return self.create_more(*args.drop(1)) if type == "more"

  "- unknown option #{type} passed to .create!"
end

.create_class ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/xiki/menu.rb', line 152

def self.create_class
  trunk = Xiki.trunk
  if wrapper = trunk[-2]
    # Just do in-line
    menu = TextUtil.snake_case Tree.root(wrapper)
  else
    menu = 'foo'
  end

  Xiki.dont_search

  Tree << %`
    | Update this sample class to your liking. Then do as+update (type
    | Ctrl-a, Ctrl-u) to create the '#{menu}' class file.
    - @~/menu/
      - #{menu}.rb
        | class #{TextUtil.camel_case(menu)}
        |   def self.menu *args
        |     "- Args Passed: \#{args.inspect}\\n- Customize me in) @ ~/menu/#{menu}.rb"
        |   end
        | end
    - more examples) @menu/api/classes/
    `
  nil
end

.create_here ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/xiki/menu.rb', line 108

def self.create_here

  # TODO: Handle various use cases
    # "menu/create/here/" at left margin
    # "@menu/create/here/" nested
    # "menu/create/\n  here/" at left margin
    # "@menu/create/\n  here/" nested

  trunk = Xiki.trunk
  if wrapper = trunk[-2]   # If @menu/create/here is nested
    menu = Tree.root wrapper
  else   # If put it under a fake menu

    # What?  This is if it's not nested? - is this used?

    # TODO: Go to left margin and remove menu...

    Tree.to_root

    Tree.kill_under
    menu = "foo"
    Line.sub! /([ +-]*).*/, "\\1#{menu}/"
    # Insert it wherever we are
  end
  Xiki.dont_search

  name_text = menu == "foo" ?
    "and change '#{menu}' to something" :
    "to go under the '#{menu}' menu"

  snake = TextUtil.snake_case menu

  Tree << "
    | Supply a few items here. Then do as+menu (type Ctrl-a Ctrl-m) to create
    | the '#{menu}' menu. Or, just create '~/menu/#{snake}.menu' yourself.
    - example item/
      - another/
    - and another/
    "

  nil

end

.do_as_menu ⇒ Object

Moves item to root of tree (replacing tree), then launches.



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/xiki/menu.rb', line 626

def self.do_as_menu
  line = Line.value

  do_launch = false

  txt =
    if line =~ /^ *\|/   # If on quoted line, will grab all quoted siblings and unquote
      Tree.siblings :string=>1
    elsif line =~ /^[ +-]*@/ && Tree.has_child?   # If on ^@... line and there's child on next line...
      # Will grab the whole tree and move it up
      Tree.subtree.unindent.sub(/^[ @+-]+/, '')
    elsif
      do_launch = true
      Tree.path.last
    end

  Keys.prefix_u ? Tree.to_root : Tree.to_root(:highest=>1)
  Tree.kill_under

  Line.sub! /^([ @]*).+/, "\\1#{txt}"

  return if ! do_launch

  # replace line with menu

  Launcher.launch
end

.external(menu, options = {}) ⇒ Object 



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/xiki/menu.rb', line 414

def self.external menu, options={}

  View.message ""

  View.wrap :off

  # IF nothing passed, must want to do tiny search box
  if menu.empty?
    Launcher.open ""
    View.message ""
    View.prompt "Type anything", :timed=>1, :times=>2 #, :color=>:rainbow

    Launcher.launch
  else
    Launcher.open menu, options
  end
end

.how_to_create(*args) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/xiki/menu.rb', line 295

def self.how_to_create *args
  txt = %q`
    > Summary
    | How to make your own menus in Xiki.  Note this refers to wiki-style
    | menus (such as this one), not the menu bar.
    |
    - Creating .menu files/
      | You can make menus without code, by just put "whatever.menu" files in the
      | "menu/" dir in your home dir.
      |
      | For example you could create a "foo.menu" file with the contents
      | "- sammiches/..." etc:
      |
      - TODO: get these to expand out somehow! - maybe pass another arg to Tree.children below? - probably bad idea
      - ~/menu/
        - foo.menu
          | - sammiches/
          |   - ham/
          |   - tofu/
          | - dranks/
          |   - foty/
      |
    - Delegating/
      | This makes a foo/ menu that you can expand.  Even though these menus
      | don't run code themselves, they can delegate to other menus or run code,
      | like:
      |
      - ~/menu/
        - foo.menu
          | - @mymenu/
          | - @MyClass.my_method
      |
    `

  Tree.children(txt, args.join('/'))
end

.how_to_use(*args) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/xiki/menu.rb', line 250

def self.how_to_use *args
  %`
  > Summary
  | How to use Xiki menus.  Note this refers to the wiki-style menus, not the menu bar.
  |
  | All menus can be used the same way.  Just type something and double-click
  | on it (or type Ctrl-enter while the cursor is on the line).
  |
  - example/
    | 1: type "foo" on a line (the "@" isn't necessary when the line isn't indented)
    @ foo
    |
    | 2: double-click on it to drill in. You can try it on the line above. It will look like this:
    @ foo/
    |  - sammiches/
    |  - dranks/
    |
    | 3: double-click to drill in further. It will look like this:
    @ foo/
    |  - sammiches/
    |    - ham/
    |    - tofu/
    |  - dranks/
    |
  - using the mouse/
    | You can click on the "bullets" (the - and + at the beginnings of lines)
    | to expand and collapse.  You can also double-click to expand and
    | collapse.
    |
  - search to narrow down/
    | When you double-click a line the cursor turns blue and you can type
    | letters to search and narrow down the list.
    |
  - misc keys/
    | - Return: stops searching and launches (expands file or dir)
    | - Tab: like return but hides others
    | - ;: like return but collapses path
    |
    | - C-g: stops searching
    |
    | - Arrow keys: you can use them to go up and down and expand and collapse
    |
  `
end

.init ⇒ Object 



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/xiki/menu.rb', line 688

def self.init

  return if ! $el

  Mode.define(:menu, ".menu") do
    Notes.mode
  end

  add_menu ROOT_MENU

  menus = [
    [ROOT_MENU, 'To'],
    [ROOT_MENU, 'Open'],
    [ROOT_MENU, 'Layout'],
    [ROOT_MENU, 'As'],
    [ROOT_MENU, 'Enter'],
    [ROOT_MENU, 'Do'],
    [ROOT_MENU, 'Search']
  ]
  menus.reverse.each do |tuple|
    add_menu tuple[0], tuple[1]
  end
end

.install(*args) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/xiki/menu.rb', line 86

def self.install *args
  Xiki.dont_search
  Tree.quote "
    > TODO
    - implement this.

    - Should it look for installed gems with this name?
    - Should it just show commands to do a gem install?
      - How would it know whether it the gem has a xiki menu?
    "
end

.line_exists?(name, pattern) ⇒ Boolean

Whether line exists in menu

p Menu.line_exists? “menu name”, /^- text to add$/ p Menu.line_exists? “menu name”, /^- text to (.+)$/

Returns:

  • (Boolean) 


718
719
720
721
722
723
724
 
# File 'lib/xiki/menu.rb', line 718

def self.line_exists? name, pattern #, options={}
  name.gsub! /\W/, '_'
  dir = File.expand_path "~/menu"
  file = File.expand_path "#{dir}/#{name}.menu"
  txt = File.read(file) rescue ""
  txt =~ pattern ? ($1 || $&) : nil   # Return whole string or group
end

.load_if_changed(file) ⇒ Object 



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/xiki/menu.rb', line 487

def self.load_if_changed file
  return :not_found if ! File.exists?(file)
  previous = @@loaded_already[file]
  recent = File.mtime(file)

  if previous == nil
    #       require file
    load file
    @@loaded_already[file] = recent
    return
  end

  return if recent <= previous

  load file
  @@loaded_already[file] = recent
end

.menu ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/xiki/menu.rb', line 3

def self.menu
  '
  - history/
    - @log/
    - @last/
  - @all/
  - .create/
    - here/
    - class/
  - .install/
    - gem/
  - .setup/
    - @~/menu/
    - .reload_menus/
  - .api/
    > Summary
    | How to use ruby code to define menus.
    |
    | You can create sophisticated menus backed by classes, or by using other
    | simple means:
    - .classes/
      - .simple class/
      - .menu with method/
      - .menu with two methods/
    - other/
      - With a string/
        |
        |   Menu.fish :menu=>"- salmon/\n- tuna/\n  - yellow fin/"
        |
        Try it out by typing 1 do_ruby (C-1 Ctrl-d Ctrl-r) while on it, then
        double-clicking on this menu to see what happens:
        |
        @fish/
        |
      - Delegating to an existing menu/
        |
        |   Menu.critters :menu=>"foo/animals"
        |
        @critters/
        |
      - Using a block/
        |
        |   Menu.foo do
        |     "hey/"
        |   end
        |
        The block can optionally take a |path| param to handle multiple levels
        of nesting.
        |
        |   Menu.foo do |path|
        |     "hey/#{path}"
        |   end
        |
      - Extract menu text from somewhere/
        | Tree.children just expects text that is in the form of a menu (lines with
        | 2-space indenting for nesting). So, the text can be pulled from
        | anywhere, such as a part of a larger file:
        |
        | Menu.lawn do |path|
        |   menu = Notes.read_block("/tmp/garage.notes", "> Lawn")
        |   Tree.children menu, Tree.rootless(path)
        | end
        |
    |
    | If you want to create a very simple menu you can do so without code,
    | by just putting the menu in a file such as ~/menu/foo.menu. See:
    |
    << docs/how_to_create/
  - .docs/
    - .How to use/
    - .How to create/
    - .keys/
      > Summary
      | Helpful keyboard shortcuts when using menus.
      |
      | - as+menu
      |   - Save changes to menu (or create new one)
      | - to+menu
      |   - Jump to file that implements menu
      |
  '
end

.menu_to_hash(txt) ⇒ Object 



594
595
596
597
598
599
600
601
602
603
 
# File 'lib/xiki/menu.rb', line 594

def self.menu_to_hash txt
  txt = File.read txt if txt =~ /\A\/.+\z/   # If 1 line and starts with slash, read file

  txt.gsub(/^\| /, '').split("\n").inject({}) do |o, txt|
    txt = txt.split(/ : /)
    o[txt[0]] = txt[1]
    o
  end

end

.menu_with_method(*args) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/xiki/menu.rb', line 194

def self.menu_with_method *args
  root = 'foo'
  trunk = Xiki.trunk
  root = TextUtil.snake_case(trunk[-2][/^[\w -]+/]) if trunk.length > 1   # If nested path (due to @), grab root of parent

  %`
  - @~/menu/
    - #{root}.rb
      | class #{TextUtil.camel_case(root)}
      |   def self.menu
      |     "
      |     - cake/
      |       - chocolate/
      |     - .pie/
      |     "
      |   end
      |
      |   def self.pie
      |     "- apple/"
      |   end
      | end
  `
end

.menu_with_two_methods(*args) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/xiki/menu.rb', line 218

def self.menu_with_two_methods *args
  root = 'foo'
  trunk = Xiki.trunk
  root = TextUtil.snake_case(trunk[-2][/^[\w -]+/]) if trunk.length > 1   # If nested path (due to @), grab root of parent

  %`
  - @~/menu/
    - #{root}.rb
      | class #{TextUtil.camel_case(root)}
      |   def self.menu
      |     "
      |     - sammiches/
      |       - ham/
      |         - .buy/
      |       - tofu/
      |         - .buy/
      |     - .checkout/
      |       - cash/
      |       - credit/
      |     "
      |   end
      |   def self.buy category, item
      |     "- buying \#{item} \#{category}"
      |   end
      |   def self.checkout kind
      |     "- checking out as \#{kind}..."
      |   end
      | end
      |
  `
end

.method_missing(*args, &block) ⇒ Object 



352
353
354
355
 
# File 'lib/xiki/menu.rb', line 352

def self.method_missing *args, &block
  Launcher.method_missing *args, &block
  "- defined!"
end

.reload_menus ⇒ Object 



332
333
334
335
336
 
# File 'lib/xiki/menu.rb', line 332

def self.reload_menus
  Launcher.reload_menu_dirs
  View.flash
  nil
end

.replacer_launcher ⇒ Object 



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/xiki/menu.rb', line 567

def self.replacer_launcher
  Line.sub! /^( +)<+= /, "\\1+ "

  # Run in place, grab output, then move higher and show output

  orig = View.line
  Launcher.launch :no_search=>1

  # If didn't move line, assume it had no output, and it's collapse things itself
  return if orig == View.line

  # If it inserted something

  output = Tree.siblings :everything=>1

  # return

  # Shouldn't this be looping like self.collapser_launcher ?
  Tree.to_parent
  Tree.to_parent
  Tree.kill_under :no_plus=>1
  Tree << output

  # TODO: do search now, after insterted?

end

.root_collapser_launcher ⇒ Object 



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/xiki/menu.rb', line 542

def self.root_collapser_launcher

  View.cursor


  # Grab line
  line = Line.value

  arrows = line[/<+/].length

  line.sub!(/ *<+@ /, '')

  # Go up to root, and kill under
  arrows.times { Tree.to_root }
  Tree.kill_under

  # Insert line, and launch
  old = Line.delete :leave_linebreak
  old.sub! /^( *).+/, "\\1"
  old << "@" if old =~ /^ /   # If any indent, @ is needed
  View << "#{old}#{line}"

  Launcher.launch
end

.simple_class(*args) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/xiki/menu.rb', line 178

def self.simple_class *args
  root = 'foo'
  trunk = Xiki.trunk
  root = TextUtil.snake_case(trunk[-2][/^[\w -]+/]) if trunk.length > 1   # If nested path (due to @), grab root of parent

  %`
  - @~/menu/
    - #{root}.rb
      | class #{TextUtil.camel_case(root)}
      |   def self.menu *args
      |     "- args passed: \#{args.inspect}\n- Customize me in) @ ~/menu/#{menu}.rb"
      |   end
      | end
  `
end

.split(path, options = {}) ⇒ Object 



357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/xiki/menu.rb', line 357

def self.split path, options={}
  path = path.sub /\/$/, ''
  path = Tree.rootless path if options[:rootless]

  return [] if path.empty?

  groups = path.split '/|', -1

  result = groups[0] =~ /^\|/ ?
    [groups[0]] :
    groups[0].split('/', -1)

  result += groups[1..-1].map{|o| "|#{o}"}
end

.to_menu ⇒ Object 



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/xiki/menu.rb', line 372

def self.to_menu
  # Take best guess, by looking through dirs for root
  trunk = Xiki.trunk

  return View.<<("- You weren't on a menu\n  | To jump to a menu's implementation, put your cursor on it\n  | (or type it on a blank line) and then do as+menu (ctrl-a ctrl-m)\n  | Or, look in one of these dirs:\n  - ~/menu/\n  - $xiki/menu/") if trunk[-1].blank?

  root = trunk[0][/^[\w _-]+/]

  root = trunk[-1][/^[\w _-]+/] if ! Keys.prefix_u

  root.gsub!(/[ -]/, '_') if root

  root.downcase!

  (["#{Xiki.dir}lib/"]+Launcher::MENU_DIRS).reverse.each do |dir|
    next unless File.directory? dir
    file = Dir["#{dir}/#{root}.*"]
    next unless file.any?
    return View.open file[0]
  end

  #     message = "
  #       - No menu found:
  #         | No \"#{root}\" menu or class file found in these dirs:
  #         @ ~/menu/
  #         @ $x/menu/
  #         ".unindent

  # Should be able to get it right from proc

  proc = Launcher.menus[1][root]

  return View.flash "- Menu 'root' doesn't exist!", :times=>4 if ! proc

  location = proc.source_location # ["./firefox.rb", 739]
Ol << "location: #{location.inspect}"
  # location[0].sub! /^\.\//, Xiki.dir
  View.open location[0].sub(/^\.\//, Xiki.dir)
  View.line = location[1]

end