Class: Yast::CWMClass

Inherits:
Module
  • Object
show all
Defined in:
library/cwm/src/modules/CWM.rb

Instance Method Summary collapse

Instance Method Details

#AdjustButtons(next_, back, abort, _help) ⇒ Object

Adjust the labels of the bottom buttons of the wizard sequencer



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
# File 'library/cwm/src/modules/CWM.rb', line 898

def AdjustButtons(next_, back, abort, _help)
  next_ = "" if next_.nil?
  back = "" if back.nil?
  abort = "" if abort.nil?
  if next_ != ""
    Wizard.SetNextButton(:next, next_)
  else
    Wizard.HideNextButton
  end

  if abort != ""
    Wizard.SetAbortButton(:abort, abort)
  else
    Wizard.HideAbortButton
  end

  if back != ""
    Wizard.SetBackButton(:back, back)
  else
    Wizard.HideBackButton
  end

  nil
end

#cleanupWidgets(widgets) ⇒ Object

Cleanup after dialog was finished (independently on what event) global only because of testsuites



410
411
412
413
414
415
416
417
418
419
420
421
422
423
# File 'library/cwm/src/modules/CWM.rb', line 410

def cleanupWidgets(widgets)
  widgets = deep_copy(widgets)
  Builtins.foreach(widgets) do |w|
    @processed_widget = deep_copy(w)
    toEval = Convert.convert(
      Ops.get(w, "cleanup"),
      from: "any",
      to:   "void (string)"
    )
    toEval.call(Ops.get_string(w, "_cwm_key", "")) if !toEval.nil?
  end

  nil
end

#CreateWidgets(names, source) ⇒ Array<::CWM::WidgetHash>

Read widgets with listed names



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
# File 'library/cwm/src/modules/CWM.rb', line 716

def CreateWidgets(names, source)
  names = deep_copy(names)
  source = deep_copy(source)
  ValidateMaps(source) # FIXME: find better place
  ret = Builtins.maplist(names) do |w|
    m = Ops.get(source, w, {})
    # leave add here in order to make a copy of the structure
    # eval isn't usable because the map may contain terms, that can't
    # be evaluated here
    m = Builtins.add(m, "_cwm_key", w)
    deep_copy(m)
  end
  ret = Builtins.maplist(ret) { |w| prepareWidget(w) }
  deep_copy(ret)
end

#DisableButtons(buttons) ⇒ Object

Disable given bottom buttons of the wizard sequencer



882
883
884
885
886
887
888
889
890
891
# File 'library/cwm/src/modules/CWM.rb', line 882

def DisableButtons(buttons)
  buttons = deep_copy(buttons)
  Builtins.foreach(buttons) do |button|
    Wizard.DisableBackButton if button == "back_button"
    Wizard.DisableAbortButton if button == "abort_button"
    Wizard.DisableNextButton if button == "next_button"
  end

  nil
end

#GetLowestTimeout(widgets) ⇒ Object



294
295
296
297
298
299
300
301
302
303
304
305
# File 'library/cwm/src/modules/CWM.rb', line 294

def GetLowestTimeout(widgets)
  widgets = deep_copy(widgets)
  minimum = 0
  Builtins.foreach(widgets) do |w|
    timeout = Ops.get_integer(w, "ui_timeout", 0)
    if Ops.less_than(timeout, minimum) && Ops.greater_than(timeout, 0) ||
        minimum == 0
      minimum = timeout
    end
  end
  minimum
end

#GetProcessedWidgetHash

Return description map of currently processed widget



429
430
431
# File 'library/cwm/src/modules/CWM.rb', line 429

def GetProcessedWidget
  deep_copy(@processed_widget)
end

#handleDebugObject

A hook to handle Alt-Ctrl-Shift-D



786
787
788
789
790
# File 'library/cwm/src/modules/CWM.rb', line 786

def handleDebug
  Builtins.y2debug("Handling a debugging event")

  nil
end

#handleWidgets(widgets, event_descr) ⇒ Symbol

Handle change of widget after event generated global only because of testsuites



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'library/cwm/src/modules/CWM.rb', line 363

def handleWidgets(widgets, event_descr)
  widgets = deep_copy(widgets)
  event_descr = deep_copy(event_descr)
  ret = nil
  Builtins.foreach(widgets) do |w|
    if ret.nil?
      @processed_widget = deep_copy(w)
      events = Ops.get_list(w, "handle_events", [])
      toEval = Convert.convert(
        Ops.get(w, "handle"),
        from: "any",
        to:   "symbol (string, map)"
      )
      if !toEval.nil? &&
          (events == [] ||
            Builtins.contains(events, Ops.get(event_descr, "ID")))
        ret = toEval.call(Ops.get_string(w, "_cwm_key", ""), event_descr)
      end
    end
  end
  ret
end

#InitNull(_key) ⇒ Object

Do-nothing replacement for a widget initialization function. Used for push buttons if all the other widgets have a fallback.



1048
1049
1050
# File 'library/cwm/src/modules/CWM.rb', line 1048

def InitNull(_key)
  nil
end

#initWidgets(widgets) ⇒ Object

Set widgets according to internally stored settings global only because of testsuites



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'library/cwm/src/modules/CWM.rb', line 333

def initWidgets(widgets)
  widgets = deep_copy(widgets)
  Builtins.foreach(widgets) do |w|
    # set initial properties
    valid_chars = Ops.get_string(w, "valid_chars")
    if !valid_chars.nil?
      UI.ChangeWidget(
        Id(Ops.get_string(w, "_cwm_key", "")),
        :ValidChars,
        valid_chars
      )
    end
    # set initial values
    @processed_widget = deep_copy(w)
    toEval = Convert.convert(
      Ops.get(w, "init"),
      from: "any",
      to:   "void (string)"
    )
    toEval.call(Ops.get_string(w, "_cwm_key", "")) if !toEval.nil?
  end

  nil
end

#mainObject



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
85
86
# File 'library/cwm/src/modules/CWM.rb', line 37

def main
  Yast.import "UI"
  textdomain "base"

  Yast.import "Label"
  Yast.import "Report"
  Yast.import "Wizard"

  # local variables

  # Widget that is being currently processed
  @processed_widget = {}

  # All widgets of the current dialog, in the correct order
  @current_dialog_widgets = []

  # stack of settings of nested calls of CWM
  @settings_stack = []

  # Handler to be called after validation of a dialog fails
  @validation_failed_handler = nil

  # UI containers, layout helpers that contain other widgets.  Used by
  # functions that recurse through "contents" to decide whether to go
  # deeper.
  @ContainerWidgets = [
    :Frame,
    :RadioButtonGroup,
    :VBox,
    :HBox,
    :MarginBox,
    :MinWidth,
    :MinHeight,
    :MinSize,
    :Left,
    :Right,
    :Top,
    :Bottom,
    :HCenter,
    :VCenter,
    :HVCenter,
    :HSquash,
    :VSquash,
    :HVSquash,
    :HWeight,
    :VWeight,
    :DumbTab,
    :ReplacePoint
  ]
end

#mergeFunctions(widgets, functions) ⇒ Object

Add fallback functions to a widget global only because of testsuites



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'library/cwm/src/modules/CWM.rb', line 312

def mergeFunctions(widgets, functions)
  widgets = deep_copy(widgets)
  functions = deep_copy(functions)
  functions = Builtins.filter(functions) { |k, _v| Ops.is_string?(k) }
  fallback_functions = Convert.convert(
    functions,
    from: "map",
    to:   "map <string, any>"
  )
  Builtins.maplist(widgets) do |w|
    Convert.convert(
      Builtins.union(fallback_functions, w),
      from: "map",
      to:   "map <string, any>"
    )
  end
end

#MergeHelps(widgets) ⇒ String

Merge helps from the widgets



735
736
737
738
739
740
741
742
743
744
# File 'library/cwm/src/modules/CWM.rb', line 735

def MergeHelps(widgets)
  return "" unless widgets

  helps = widgets.map do |widget|
    help = widget["help"]
    help.respond_to?(:call) ? help.call : help
  end
  helps.compact!
  helps.join("\n")
end

#OkCancelBox::CWM::UITerm

Create a term with OK and Cancel buttons placed horizontally



435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'library/cwm/src/modules/CWM.rb', line 435

def OkCancelBox
  ButtonBox(
    PushButton(
      Id(:_tp_ok),
      Opt(:key_F10, :default, :okButton),
      Label.OKButton
    ),
    PushButton(
      Id(:_tp_cancel),
      Opt(:key_F9, :cancelButton),
      Label.CancelButton
    )
  )
end

#PopSettingsObject

Pop the settings of the currently run dialog from the stack



101
102
103
104
105
106
107
108
# File 'library/cwm/src/modules/CWM.rb', line 101

def PopSettings
  current_dialog = Ops.get(@settings_stack, 0, {})
  Ops.set(@settings_stack, 0, nil)
  @settings_stack = Builtins.filter(@settings_stack) { |e| !e.nil? }
  @current_dialog_widgets = Ops.get_list(current_dialog, "widgets", [])

  nil
end

#PrepareDialog(dialog, widgets) ⇒ ::CWM::UITerm

Prepare the dialog, replace strings in the term with appropriate widgets



751
752
753
754
755
756
757
758
759
760
761
# File 'library/cwm/src/modules/CWM.rb', line 751

def PrepareDialog(dialog, widgets)
  dialog = deep_copy(dialog)
  widgets = deep_copy(widgets)
  args = Builtins.size(dialog)
  return deep_copy(dialog) if args == 0
  m = Builtins.listmap(widgets) do |w|
    widget_key = Ops.get_string(w, "_cwm_key", "")
    { widget_key => w }
  end
  ProcessTerm(dialog, m)
end

#prepareWidget(widget_descr) ⇒ ::CWM::WidgetHash

Prepare a widget for usage



501
502
503
504
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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
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
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'library/cwm/src/modules/CWM.rb', line 501

def prepareWidget(widget_descr)
  widget_descr = deep_copy(widget_descr)
  w = deep_copy(widget_descr)
  widget = Ops.get_symbol(w, "widget", :inputfield)

  if Ops.get(w, "widget") == :empty
    Ops.set(w, "widget", VBox())
  elsif Ops.get(w, "widget") == :custom &&
      Ops.get(w, "custom_widget")
    Ops.set(w, "widget", Ops.get_term(w, "custom_widget") { VSpacing(0) })
  elsif Ops.get(w, "widget") == :func
    toEval = Convert.convert(
      Ops.get(w, "widget_func"),
      from: "any",
      to:   "term ()"
    )
    if !toEval.nil?
      Ops.set(w, "widget", toEval.call)
    else
      Ops.set(w, "widget", VBox())
    end
  else
    id_term = Id(Ops.get_string(w, "_cwm_key", ""))
    opt_term = Opt()
    Builtins.foreach(Ops.get_list(w, "opt", [])) do |o|
      opt_term = Builtins.add(opt_term, o)
    end
    label = Ops.get_string(w, "label", Ops.get_string(w, "_cwm_key", ""))

    if widget == :inputfield || widget == :textentry
      # backward compatibility
      if !Builtins.contains(Builtins.argsof(opt_term), :hstretch)
        opt_term = Builtins.add(opt_term, :hstretch)
      end
      Ops.set(w, "widget", InputField(id_term, opt_term, label))
    elsif widget == :password
      Ops.set(w, "widget", Password(id_term, opt_term, label))
    elsif widget == :checkbox
      Ops.set(w, "widget", CheckBox(id_term, opt_term, label))
    elsif widget == :combobox
      Ops.set(
        w,
        "widget",
        ComboBox(
          id_term,
          opt_term,
          label,
          Builtins.maplist(Ops.get_list(w, "items", [])) do |i|
            Item(Id(Ops.get(i, 0, "")), Ops.get(i, 1, Ops.get(i, 0, "")))
          end
        )
      )
    elsif widget == :selection_box
      Ops.set(
        w,
        "widget",
        SelectionBox(
          id_term,
          opt_term,
          label,
          Builtins.maplist(Ops.get_list(w, "items", [])) do |i|
            Item(Id(Ops.get(i, 0, "")), Ops.get(i, 1, Ops.get(i, 0, "")))
          end
        )
      )
    elsif widget == :multi_selection_box
      Ops.set(
        w,
        "widget",
        MultiSelectionBox(
          id_term,
          opt_term,
          label,
          Builtins.maplist(Ops.get_list(w, "items", [])) do |i|
            Item(Id(Ops.get(i, 0, "")), Ops.get(i, 1, Ops.get(i, 0, "")))
          end
        )
      )
    elsif widget == :intfield
      min = Ops.get_integer(w, "minimum", 0)
      max = Ops.get_integer(w, "maximum", 2**31 - 1) # libyui support only signed int
      Ops.set(
        w,
        "widget",
        IntField(id_term, opt_term, label, min, max, min)
      )
    elsif widget == :radio_buttons
      hspacing = Ops.get_integer(w, "hspacing", 0)
      vspacing = Ops.get_integer(w, "vspacing", 0)
      buttons = VBox(VSpacing(vspacing))
      Builtins.foreach(Ops.get_list(w, "items", [])) do |i|
        buttons = Builtins.add(
          buttons,
          Left(
            RadioButton(
              Id(Ops.get(i, 0, "")),
              opt_term,
              Ops.get(i, 1, Ops.get(i, 0, ""))
            )
          )
        )
        buttons = Builtins.add(buttons, VSpacing(vspacing))
      end
      Ops.set(
        w,
        "widget",
        Frame(
          label,
          HBox(
            HSpacing(hspacing),
            RadioButtonGroup(id_term, buttons),
            HSpacing(hspacing)
          )
        )
      )
    elsif widget == :radio_button
      Ops.set(w, "widget", RadioButton(id_term, opt_term, label))
    elsif widget == :push_button
      Ops.set(w, "widget", PushButton(id_term, opt_term, label))
    elsif widget == :menu_button
      Ops.set(
        w,
        "widget",
        MenuButton(
          id_term,
          opt_term,
          label,
          Builtins.maplist(Ops.get_list(w, "items", [])) do |i|
            Item(Id(Ops.get(i, 0, "")), Ops.get(i, 1, Ops.get(i, 0, "")))
          end
        )
      )
    elsif widget == :multi_line_edit
      Ops.set(w, "widget", MultiLineEdit(id_term, opt_term, label))
    elsif widget == :richtext
      Ops.set(w, "widget", RichText(id_term, opt_term, ""))
    end
  end
  Ops.set(w, "custom_widget", nil) # not needed any more
  deep_copy(w)
end

#ProcessTerm(t, widgets) ⇒ ::CWM::UITerm

Process term with the dialog, replace strings in the term with appropriate widgets



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
151
152
153
154
155
156
157
158
159
# File 'library/cwm/src/modules/CWM.rb', line 115

def ProcessTerm(t, widgets)
  t = deep_copy(t)
  widgets = deep_copy(widgets)
  args = Builtins.size(t)
  return deep_copy(t) if args == 0
  ret = Builtins.toterm(
    Builtins.substring(Builtins.sformat("%1", Builtins.symbolof(t)), 1)
  )
  id_frame = false
  index = 0
  current = Builtins.symbolof(t)
  while Ops.less_than(index, args)
    arg = Ops.get(t, index)
    # FIXME: still there is a problem for frames without label
    if current == :Frame && index == 0 # no action
      # frame can have id and also label, so mark if id is used
      id_frame = true if arg.is_a?(Yast::Term) && arg.value == :id
      Builtins.y2debug("Leaving untouched %1", arg)
    elsif current == :Frame && index == 1 && id_frame && arg.is_a?(::String) # no action
      id_frame = false
      Builtins.y2debug("Leaving untouched %1", arg)
    elsif Ops.is_term?(arg) && !arg.nil? # recurse
      s = Builtins.symbolof(Convert.to_term(arg))
      if Builtins.contains(@ContainerWidgets, s)
        arg = ProcessTerm(Convert.to_term(arg), widgets)
      end
    elsif Ops.is_string?(arg) # action
      Builtins.y2error("find string '#{arg}' without associated widget in StringTerm #{t.inspect}") unless widgets[arg]
      Builtins.y2milestone("Known widgets #{widgets.inspect}") unless widgets[arg]

      arg = Ops.get_term(
        widgets,
        [Convert.to_string(arg), "widget"],
        VBox()
      )
      s = Builtins.symbolof(arg)
      if Builtins.contains(@ContainerWidgets, s)
        arg = ProcessTerm(arg, widgets)
      end
    end
    ret = Builtins.add(ret, arg)
    index = Ops.add(index, 1)
  end
  deep_copy(ret)
end

#PushSettingsObject

Push the settings of the currently run dialog to the stack



91
92
93
94
95
96
97
98
# File 'library/cwm/src/modules/CWM.rb', line 91

def PushSettings
  @settings_stack = Builtins.prepend(
    @settings_stack,
    "widgets" => @current_dialog_widgets
  )

  nil
end

#ReplaceWidgetHelp(widget = nil, help = "") ⇒ Object

Replace help for a particular widget if nil is passed, then just regenerate help. Useful for refresh dynamic help content.

Examples:

change help content for widget w which had static help

Yast::CWM.ReplaceWidgetHelp("my_widget", "my new free-cool-in help")

refresh help for widget with dynamic content

Yast::CWM.ReplaceWidgetHelp


772
773
774
775
776
777
778
779
780
781
782
783
# File 'library/cwm/src/modules/CWM.rb', line 772

def ReplaceWidgetHelp(widget = nil, help = "")
  if widget
    @current_dialog_widgets = Builtins.maplist(@current_dialog_widgets) do |w|
      Ops.set(w, "help", help) if Ops.get_string(w, "_cwm_key", "") == widget
      deep_copy(w)
    end
  end
  help = MergeHelps(@current_dialog_widgets)
  Wizard.RestoreHelp(help)

  nil
end

#Run(widgets, functions, skip_store_for: []) ⇒ Symbol

Generic function to create dialog and handle it's events



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
# File 'library/cwm/src/modules/CWM.rb', line 800

def Run(widgets, functions, skip_store_for: [])
  widgets = deep_copy(widgets)
  functions = deep_copy(functions)
  widgets = mergeFunctions(widgets, functions)
  PushSettings()
  @current_dialog_widgets = deep_copy(widgets)
  initWidgets(widgets)

  # allow a handler to enable/disable widgets before the first real
  # UserInput takes place
  UI.FakeUserInput("ID" => "_cwm_wakeup")

  ret = nil
  save_exits = [:next, :ok]
  save = false
  event_descr = {}
  timeout = GetLowestTimeout(widgets)
  while ret != :back && ret != :abort && !save
    event_descr = if Ops.greater_than(timeout, 0)
      UI.WaitForEvent(timeout)
    else
      UI.WaitForEvent
    end
    ret = Ops.get(event_descr, "ID")
    if Ops.get_string(event_descr, "EventType", "") == "DebugEvent"
      handleDebug
    end
    handle_ret = handleWidgets(widgets, event_descr)
    if !handle_ret.nil? ||
        Ops.is_symbol?(ret) && Builtins.contains(save_exits, ret)
      save = true
      if !handle_ret.nil?
        ret = handle_ret
        Ops.set(event_descr, "ID", ret)
      end
    end

    ret = :abort if ret == :cancel
    if ret == :abort
      if Ops.get(functions, :abort)
        toEval = Convert.convert(
          Ops.get(functions, :abort),
          from: "any",
          to:   "boolean ()"
        )
        if !toEval.nil?
          eval_ret = toEval.call
          ret = eval_ret ? :abort : nil
        end
      end
    elsif ret == :back
      if Ops.get(functions, :back)
        toEval = Convert.convert(
          Ops.get(functions, :back),
          from: "any",
          to:   "boolean ()"
        )
        if !toEval.nil?
          eval_ret = toEval.call
          ret = eval_ret ? :back : nil
        end
      end
    end

    next if ret.nil?

    # ok, so what happens here? event want to save widgets, so check that there is no explicit
    # skip of  storing for this event and there is a widget containing invalid value.
    # In such case do not save and clear ret, so we are still in loop
    if save && !skip_store_for.include?(ret) && !validateWidgets(widgets, event_descr)
      ret = nil
      save = false
    end
  end
  saveWidgets(widgets, event_descr) if save && !skip_store_for.include?(ret)
  cleanupWidgets(widgets)
  PopSettings()
  Convert.to_symbol(ret)
end

#save_current_widgets(event) ⇒ Object

Saves changes of all the widgets in the current dialog



1063
1064
1065
# File 'library/cwm/src/modules/CWM.rb', line 1063

def save_current_widgets(event)
  saveWidgets(@current_dialog_widgets, event)
end

#saveWidgets(widgets, event) ⇒ Object

Save changes of widget after event generated global only because of testsuites CWMTab uses it too



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
# File 'library/cwm/src/modules/CWM.rb', line 391

def saveWidgets(widgets, event)
  widgets = deep_copy(widgets)
  event = deep_copy(event)
  Builtins.foreach(widgets) do |w|
    @processed_widget = deep_copy(w)
    toEval = Convert.convert(
      Ops.get(w, "store"),
      from: "any",
      to:   "void (string, map)"
    )
    toEval.call(Ops.get_string(w, "_cwm_key", ""), event) if !toEval.nil?
  end

  nil
end

#SetValidationFailedHandler(handler) ⇒ Object

Set handler to be called after validation of a dialog failed



925
926
927
928
929
930
# File 'library/cwm/src/modules/CWM.rb', line 925

def SetValidationFailedHandler(handler)
  handler = deep_copy(handler)
  @validation_failed_handler = deep_copy(handler)

  nil
end

#show(contents, caption: nil, back_button: nil, next_button: nil, abort_button: nil, skip_store_for: [], disable_buttons: [], abort_handler: nil) ⇒ Symbol

Display the dialog and run its event loop using new widget API



949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
# File 'library/cwm/src/modules/CWM.rb', line 949

def show(contents, caption: nil, back_button: nil, next_button: nil, abort_button: nil, skip_store_for: [],
  disable_buttons: [], abort_handler: nil)
  widgets = widgets_in_contents(contents)
  options = {
    "contents"     => widgets_contents(contents),
    "widget_names" => widgets.map(&:widget_id),
    "widget_descr" => Hash[widgets.map { |w| [w.widget_id, w.cwm_definition] }]
  }
  options["caption"] = caption if caption
  options["back_button"] = back_button if back_button
  options["next_button"] = next_button if next_button
  options["abort_button"] = abort_button if abort_button
  options["skip_store_for"] = skip_store_for
  options["disable_buttons"] = disable_buttons
  options["fallback_functions"] = { abort: Yast.fun_ref(abort_handler, "boolean ()") } if abort_handler

  ShowAndRun(options)
end

#ShowAndRun(settings) ⇒ Object

Display the dialog and run its event loop

Options Hash (settings):

  • "widgets" (Array<CWM::AbstractWidget>)

    list of widgets used in CWM, it is auto added to `“widget_names”` and `“widget_descr”`



972
973
974
975
976
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
# File 'library/cwm/src/modules/CWM.rb', line 972

def ShowAndRun(settings)
  settings = deep_copy(settings)
  if settings["widgets"]
    widgets = settings["widgets"]
    settings["widget_names"] ||= []
    settings["widget_names"] += widgets.map(&:widget_id)
    settings["widget_descr"] ||= {}
    settings["widget_descr"] = Hash[widgets.map { |w| [w.widget_id, w.cwm_definition] }]
  end
  widget_descr = Ops.get_map(settings, "widget_descr", {})
  contents = Ops.get_term(settings, "contents", VBox())
  widget_names = Convert.convert(
    Ops.get(settings, "widget_names") { StringsOfTerm(contents) },
    from: "any",
    to:   "list <string>"
  )
  caption = Ops.get_string(settings, "caption", "")
  back_button = Ops.get_string(settings, "back_button") { Label.BackButton }
  next_button = Ops.get_string(settings, "next_button") { Label.NextButton }
  abort_button = Ops.get_string(settings, "abort_button") do
    Label.AbortButton
  end
  fallback = Ops.get_map(settings, "fallback_functions", {})

  w = CreateWidgets(widget_names, widget_descr)
  help = MergeHelps(w)
  contents = PrepareDialog(contents, w)
  Wizard.SetContentsButtons(
    caption,
    contents,
    help,
    back_button,
    next_button
  )
  AdjustButtons(next_button, back_button, abort_button, nil)
  DisableButtons(Ops.get_list(settings, "disable_buttons", []))

  skip_store_for = settings["skip_store_for"] || []
  Run(w, fallback, skip_store_for: skip_store_for)
end

#ShowAndRunOrig(widget_names, widget_descr, contents, caption, back_button, next_button, fallback) ⇒ Symbol

Display the dialog and run its event loop



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
# File 'library/cwm/src/modules/CWM.rb', line 1025

def ShowAndRunOrig(widget_names, widget_descr, contents, caption, back_button, next_button, fallback)
  widget_names = deep_copy(widget_names)
  widget_descr = deep_copy(widget_descr)
  contents = deep_copy(contents)
  fallback = deep_copy(fallback)
  ShowAndRun(

    "widget_names"       => widget_names,
    "widget_descr"       => widget_descr,
    "contents"           => contents,
    "caption"            => caption,
    "back_button"        => back_button,
    "next_button"        => next_button,
    "fallback_functions" => fallback

  )
end

#StoreNull(_key, _event) ⇒ Object

Do-nothing replacement for a widget storing function. Used for push buttons if all the other widgets have a fallback.



1056
1057
1058
# File 'library/cwm/src/modules/CWM.rb', line 1056

def StoreNull(_key, _event)
  nil
end

#StringsOfTerm(t) ⇒ Array<String>

Process term with the dialog, return all strings. To be used as an argument for widget_names until they are obsoleted.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'library/cwm/src/modules/CWM.rb', line 165

def StringsOfTerm(t)
  t = deep_copy(t)
  rets = []
  args = Builtins.size(t)
  index = 0
  while Ops.less_than(index, args)
    arg = Ops.get(t, index)
    current = Builtins.symbolof(t)
    if current == :Frame && index == 0 # no action
      Builtins.y2debug("Leaving untouched %1", arg)
    elsif Ops.is_term?(arg) && !arg.nil? # recurse
      s = Builtins.symbolof(Convert.to_term(arg))
      if Builtins.contains(@ContainerWidgets, s)
        rets = Ops.add(rets, StringsOfTerm(Convert.to_term(arg)))
      end
    elsif Ops.is_string?(arg) # action
      rets = Builtins.add(rets, Convert.to_string(arg))
    end
    index = Ops.add(index, 1)
  end
  deep_copy(rets)
end

#validate_current_widgets(event) ⇒ Boolean

Validates all the widgets in the current dialog



1071
1072
1073
# File 'library/cwm/src/modules/CWM.rb', line 1071

def validate_current_widgets(event)
  validateWidgets(@current_dialog_widgets, event)
end

#ValidateBasicType(value, type) ⇒ Boolean

Validate the value against the basic type



192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'library/cwm/src/modules/CWM.rb', line 192

def ValidateBasicType(value, type)
  value = deep_copy(value)
  return Ops.is_term?(value) if type == "term"
  return Ops.is_string?(value) if type == "string"
  return Ops.is_symbol?(value) if type == "symbol"
  return Ops.is_list?(value) if type == "list"
  return Ops.is_map?(value) if type == "map"
  return Ops.is_boolean?(value) if type == "boolean"
  return Ops.is_integer?(value) if type == "integer"

  Builtins.y2error("Unknown value type %1", type)
  true
end

#ValidateMaps(widgets) ⇒ Boolean

Validate widget description map, check for maps structure Also checks option description maps if present



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
484
485
486
487
488
489
490
491
492
493
494
495
# File 'library/cwm/src/modules/CWM.rb', line 454

def ValidateMaps(widgets)
  widgets = deep_copy(widgets)
  ret = true
  Builtins.foreach(widgets) do |k, v|
    Builtins.foreach(v) do |kk, vv|
      ret = ValidateValueType(kk, vv, k) && ret
    end
    to_check = if Ops.get(v, "widget") == :custom
      ["custom_widget"]
    elsif Ops.get(v, "widget") == :empty
      []
    else
      ["label", "widget"]
    end
    Builtins.foreach(to_check) do |key|
      if key != "label" ||
          Ops.get(v, "widget") != :radio_buttons &&
              Ops.get(v, "widget") != :custom &&
              Ops.get(v, "widget") != :rich_text &&
              Ops.get(v, "widget") != :func
        ret = ValidateValueContents(key, Ops.get(v, key), k) && ret
      end
    end
    if Ops.get(v, "widget") == :custom
      ret = ValidateValueContents(
        "custom_widget",
        Ops.get(v, "custom_widget"),
        k
      ) && ret
    end
    # validate widget-specific entries
    if Builtins.haskey(v, "_cwm_do_validate")
      val_func = Convert.convert(
        Ops.get(v, "_cwm_do_validate"),
        from: "any",
        to:   "boolean (string, map <string, any>)"
      )
      ret = val_func.call(k, v) && ret if !val_func.nil?
    end
  end
  ret
end

#ValidateValueContents(key, value, widget) ⇒ Boolean

Validate value of entry of the widget/option description map Also checks option description maps if present



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'library/cwm/src/modules/CWM.rb', line 270

def ValidateValueContents(key, value, widget)
  value = deep_copy(value)
  error = ""
  if key == "label"
    s = Convert.to_string(value)
    if s.nil? || Builtins.size(s) == 0
      error = "Empty label"
    elsif Builtins.size(Builtins.filterchars(s, "&")) != 1
      error = "Label has no shortcut or more than 1 shortcuts"
    end
  elsif key == "widget"
    s = Convert.to_symbol(value)
    error = "No widget specified" if s.nil?
  elsif key == "custom_widget"
    s = Convert.to_term(value)
    error = "No custom widget specified" if s.nil?
  end

  return true if error == ""

  Builtins.y2error("Error on key %1 of widget %2: %3", key, widget, error)
  false
end

#ValidateValueType(key, value, widget) ⇒ Boolean

Validate type of entry of the widget/option description map Also checks option description maps if present



212
213
214
215
216
217
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'library/cwm/src/modules/CWM.rb', line 212

def ValidateValueType(key, value, widget)
  value = deep_copy(value)
  types = {
    # general
    "widget"        => "symbol",
    "custom_widget" => "term",
    "handle_events" => "list",
    "label"         => "string",
    "opt"           => "list",
    "ui_timeout"    => "integer",
    "validate_type" => "symbol",
    # int field
    "minimum"       => "integer",
    "maximum"       => "integer",
    "_cwm_attrib"   => "map",
    "fallback"      => "map"
  }
  type = Ops.get(types, key)
  success = true
  if type.nil?
    success = case key
    when "widget_func" then Ops.is(value, "term ()")
    when "init" then Ops.is(value, "void (string)")
    when "handle" then Ops.is(value, "symbol (string, map)")
    when "store" then Ops.is(value, "void (string, map)")
    when "cleanup" then Ops.is(value, "void (string)")
    when "validate_function" then Ops.is(value, "boolean (string, map)")
    when "items" then Ops.is(value, "list <list <string>>")
    when "_cwm_do_validate" then Ops.is(value, "boolean (string, map <string, any>)")
    when "help"
      # help can be static string or dynamic callback, that allows to recompute help for
      # widgets with dynamic contents like replace_point
      Ops.is(value, "string") || Ops.is(value, "string ()")
    else
      # unknown key, always valid
      true
    end
  else
    success = ValidateBasicType(value, type)
  end

  if !success
    Builtins.y2error(
      "Wrong type of option %1 in description map of %2",
      key,
      widget
    )
  end

  success
end

#validateWidget(widget, event, key) ⇒ Object

Validate single widget



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
# File 'library/cwm/src/modules/CWM.rb', line 648

def validateWidget(widget, event, key)
  widget = deep_copy(widget)
  event = deep_copy(event)
  @processed_widget = deep_copy(widget)
  failed = false
  val_type = Ops.get_symbol(widget, "validate_type")
  if val_type == :function || val_type == :function_no_popup
    toEval = Convert.convert(
      Ops.get(widget, "validate_function"),
      from: "any",
      to:   "boolean (string, map)"
    )
    failed = !toEval.call(key, event) if !toEval.nil?
  elsif val_type == :regexp
    regexp = Ops.get_string(widget, "validate_condition", "")
    if !Builtins.regexpmatch(
      Convert.to_string(UI.QueryWidget(Id(:_tp_value), :Value)),
      regexp
    )
      failed = true
    end
  elsif val_type == :list
    possible = Ops.get_list(widget, "validate_condition", [])
    if !Builtins.contains(possible, UI.QueryWidget(Id(:_tp_value), :Value))
      failed = true
    end
  end

  if failed && val_type != :function
    error = Ops.get_string(widget, "validate_help", "")
    if error == ""
      wname = Ops.get_string(
        widget,
        "label",
        Ops.get_string(widget, "_cwm_key", "")
      )
      wname = Builtins.deletechars(wname, "&")
      # message popup, %1 is a label of some widget
      error = Builtins.sformat(_("The value of %1 is invalid."), wname)
    end
    UI.SetFocus(Id(Ops.get_string(widget, "_cwm_key", "")))
    Report.Error(error)
  end
  !failed
end

#validateWidgets(widgets, event) ⇒ Boolean

Validate dialog contents for allow it to be saved



698
699
700
701
702
703
704
705
706
707
708
709
710
# File 'library/cwm/src/modules/CWM.rb', line 698

def validateWidgets(widgets, event)
  widgets = deep_copy(widgets)
  event = deep_copy(event)
  result = true
  Builtins.foreach(widgets) do |w|
    widget_key = Ops.get_string(w, "_cwm_key", "")
    result &&= validateWidget(w, event, widget_key)
  end
  if !result && !@validation_failed_handler.nil?
    @validation_failed_handler.call
  end
  result
end

#widgets_contents(contents) ⇒ ::CWM::StringTerm



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
# File 'library/cwm/src/modules/CWM.rb', line 1117

def widgets_contents(contents)
  res = contents.clone

  (0..(res.size - 1)).each do |index|
    case contents[index]
    when ::CWM::AbstractWidget then res[index] = res[index].widget_id
    when Yast::Term then res[index] = widgets_contents(res[index])
    end
  end

  res
end

#widgets_in_contents(contents) ⇒ Array<::CWM::AbstractWidget>



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
# File 'library/cwm/src/modules/CWM.rb', line 1103

def widgets_in_contents(contents)
  contents.each_with_object([]) do |arg, res|
    case arg
    when ::CWM::AbstractWidget
      res << arg
      # if widget have its own content, also search it
      res.concat(widgets_in_contents(arg.contents)) if arg.respond_to?(:contents)
    when Yast::Term then res.concat(widgets_in_contents(arg))
    end
  end
end