1

// widget_foreach.ysl2

     2

     3

widget_desc("ForEach") {

     4

     5

    longdesc

     6

    ||

     7

    ForEach widget is used to span a small set of widget over a larger set of

     8

    repeated HMI_NODEs. 

     9

    10

    Idea is somewhat similar to relative page, but it all happens inside the

    11

    ForEach widget, no page involved.

    12

    13

    Together with relative Jump widgets it can be used to build a menu to reach

    14

    relative pages covering many identical HMI_NODES siblings.

    15

    16

    ForEach widget takes a HMI_CLASS name as argument and a HMI_NODE path as

    17

    variable.

    18

    19

    Direct sub-elements can be either groups of widget to be spanned, labeled

    20

    "ClassName:offset", or buttons to control the spanning, labeled

    21

    "ClassName:+/-number".

    22

    23

    In case of "ClassName:offset", offset for first element is 1.

    24

    25

    ||

    26

    27

    shortdesc > span widgets over a set of repeated HMI_NODEs

    28

    29

    arg name="class_name" accepts="string" > HMI_CLASS name

    30

    31

    path name="root" accepts="HMI_NODE" >  where to find HMI_NODEs whose HMI_CLASS is class_name

    32

}

    33

    34

widget_defs("ForEach") {

    35

    36

    if "count(path) < 1" error > ForEach widget «$hmi_element/@id» must have one HMI path given.

    37

    if "count(arg) != 1" error > ForEach widget «$hmi_element/@id» must have one argument given : a class name.

    38

    39

    const "class","arg[1]/@value";

    40

    41

    const "base_path","path/@value";

    42

    const "hmi_index_base", "$indexed_hmitree/*[@hmipath = $base_path]";

    43

    const "hmi_tree_base", "$hmitree/descendant-or-self::*[@path = $hmi_index_base/@path]";

    44

    const "hmi_tree_items", "$hmi_tree_base/*[@class = $class]";

    45

    const "hmi_index_items", "$indexed_hmitree/*[@path = $hmi_tree_items/@path]"; 

    46

    const "items_paths", "$hmi_index_items/@hmipath"; 

    47

    |     index_pool: [

    48

    foreach "$hmi_index_items" {

    49

    |       «@index»`if "position()!=last()" > ,`

    50

    }

    51

    |     ],

    52

    |     init: function() {

    53

    const "prefix","concat($class,':')";

    54

    const "buttons_regex","concat('^',$prefix,'[+\-][0-9]+')";

    55

    const "buttons", "$hmi_element/*[regexp:test(@inkscape:label, $buttons_regex)]"; 

    56

    foreach "$buttons" {

    57

        const "op","substring-after(@inkscape:label, $prefix)";

    58

    |         id("«@id»").setAttribute("onclick", "hmi_widgets['«$hmi_element/@id»'].on_click('«$op»', evt)");

    59

    }

    60

    |

    61

    |         this.items = [

    62

    const "items_regex","concat('^',$prefix,'[0-9]+')";

    63

    const "unordered_items","$hmi_element//*[regexp:test(@inkscape:label, $items_regex)]";

    64

    foreach "$unordered_items" {

    65

        const "elt_label","concat($prefix, string(position()))"; 

    66

        const "elt","$unordered_items[@inkscape:label = $elt_label]";

    67

        const "pos","position()";

    68

        const "item_path", "$items_paths[$pos]";

    69

    |           [ /* item="«$elt_label»" path="«$item_path»" */

    70

        if "count($elt)=0" error > Missing item labeled «$elt_label» in ForEach widget «$hmi_element/@id»

    71

        if "count($elt)>1" error > Duplicate item labeled «$elt_label» in ForEach widget «$hmi_element/@id»

    72

        foreach "func:refered_elements($elt)[@id = $hmi_elements/@id][not(@id = $elt/@id)]" {

    73

            if "not(func:is_descendant_path(func:widget(@id)/path/@value, $item_path))"

    74

                error > Widget id="«@id»" label="«@inkscape:label»" is having wrong path. Accroding to ForEach widget ancestor id="«$hmi_element/@id»", path should be descendant of "«$item_path»".

    75

    |             hmi_widgets["«@id»"]`if "position()!=last()" > ,`

    76

        }

    77

    |           ]`if "position()!=last()" > ,`

    78

    }

    79

    |         ]

    80

    |     },

    81

    |     range: «count($hmi_index_items)»,

    82

    |     size: «count($unordered_items)»,

    83

    |     position: 0,

    84

}

    85

    86

widget_class("ForEach")

    87

||

    88

    items_subscribed = false;

    89

    90

    unsub_items(){

    91

        if(this.items_subscribed){

    92

            for(let item of this.items){

    93

                for(let widget of item) {

    94

                    widget.unsub();

    95

                }

    96

            }

    97

            this.items_subscribed = false;

    98

        }

    99

    }

   100

   101

    unsub(){

   102

        super.unsub()

   103

        this.unsub_items();

   104

    }

   105

   106

    sub_items(){

   107

        if(!this.items_subscribed){

   108

            for(let i = 0; i < this.size; i++) {

   109

                let item = this.items[i];

   110

                let orig_item_index = this.index_pool[i];

   111

                let item_index = this.index_pool[i+this.position];

   112

                let item_index_offset = item_index - orig_item_index;

   113

                if(this.relativeness[0])

   114

                    item_index_offset += this.offset;

   115

                for(let widget of item) {

   116

                    /* all variables of all widgets in a ForEach are all relative. 

   117

                       Really.

   118

   119

                       TODO: allow absolute variables in ForEach widgets

   120

                    */

   121

                    widget.sub(item_index_offset, widget.indexes.map(_=>true));

   122

                }

   123

            }

   124

        }

   125

    }

   126

   127

    sub(new_offset, relativeness, container_id){

   128

        let position_given = this.indexes.length > 2;

   129

   130

        // sub() will call apply_cache() and then dispatch()

   131

        // undefining position forces dispatch() to call apply_position()

   132

        if(position_given)

   133

            this.position = undefined;

   134

   135

        super.sub(new_offset, relativeness, container_id);

   136

   137

        // if position isn't given as a variable

   138

        // dispatch() to call apply_position() aren't called

   139

        // and items must be subscibed now.

   140

        if(!position_given)

   141

            this.sub_items();

   142

   143

        // as soon as subribed apply range and size once for all

   144

        this.apply_hmi_value(1, this.range);

   145

        this.apply_hmi_value(3, this.size);

   146

    }

   147

   148

    apply_position(new_position){

   149

        let old_position = this.position;

   150

        let limited_position = Math.round(Math.max(Math.min(new_position, this.range - this.size), 0));

   151

        if(this.position == limited_position){

   152

            return false;

   153

        }

   154

        this.unsub_items();

   155

        this.position = limited_position;

   156

        this.sub_items();

   157

        request_subscriptions_update();

   158

        jumps_need_update = true;

   159

        this.request_animate();

   160

        return true;

   161

    }

   162

   163

    on_click(opstr, evt) {

   164

        let new_position = eval(String(this.position)+opstr);

   165

        if(new_position + this.size > this.range) {

   166

            if(this.position + this.size == this.range)

   167

                new_position = 0;

   168

            else

   169

                new_position = this.range - this.size;

   170

        } else if(new_position < 0) {

   171

            if(this.position == 0)

   172

                new_position = this.range - this.size;

   173

            else

   174

                new_position = 0;

   175

        }

   176

        if(this.apply_position(new_position)){

   177

            this.apply_hmi_value(2, this.position);

   178

        }

   179

    }

   180

   181

    dispatch(value, oldval, index) {

   182

        // Only care about position, others are constants

   183

        if(index == 2){

   184

            this.apply_position(value);

   185

            if(this.position != value){

   186

                // widget refused or apply different value, force it back

   187

                this.apply_hmi_value(2, this.position);

   188

            }

   189

        }

   190

    }

   191

   192

||

   193