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

    path name="position" accepts="HMI_INT" > position of HMI_NODE mapped to first item, among similar siblings

    33

    path name="range" accepts="HMI_INT" count="optional" >  count of HMI_NODE siblings

    34

    path name="size" accepts="HMI_INT" count="optional" >  count of visible items

    35

}

    36

    37

widget_defs("ForEach") {

    38

    39

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

    40

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

    41

    42

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

    43

    44

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

    45

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

    46

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

    47

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

    48

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

    49

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

    50

    |     index_pool: [

    51

    foreach "$hmi_index_items" {

    52

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

    53

    }

    54

    |     ],

    55

    |     init: function() {

    56

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

    57

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

    58

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

    59

    foreach "$buttons" {

    60

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

    61

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

    62

    }

    63

    |

    64

    |         this.items = [

    65

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

    66

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

    67

    foreach "$unordered_items" {

    68

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

    69

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

    70

        const "pos","position()";

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

                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»".

    78

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

    79

        }

    80

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

    81

    }

    82

    |         ]

    83

    |     },

    84

    |     range: «count($hmi_index_items)»,

    85

    |     size: «count($unordered_items)»,

    86

    |     position: 0,

    87

}

    88

    89

widget_class("ForEach")

    90

||

    91

    items_subscribed = false;

    92

    93

    unsub_items(){

    94

        if(this.items_subscribed){

    95

            for(let item of this.items){

    96

                for(let widget of item) {

    97

                    widget.unsub();

    98

                }

    99

            }

   100

            this.items_subscribed = false;

   101

        }

   102

    }

   103

   104

    unsub(){

   105

        super.unsub()

   106

        this.unsub_items();

   107

    }

   108

   109

    sub_items(){

   110

        if(!this.items_subscribed){

   111

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

   112

                let item = this.items[i];

   113

                let orig_item_index = this.index_pool[i];

   114

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

   115

                let item_index_offset = item_index - orig_item_index;

   116

                if(this.relativeness[0])

   117

                    item_index_offset += this.offset;

   118

                for(let widget of item) {

   119

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

   120

                       Really.

   121

   122

                       TODO: allow absolute variables in ForEach widgets

   123

                    */

   124

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

   125

                }

   126

            }

   127

        }

   128

    }

   129

   130

    sub(new_offset, relativeness, container_id){

   131

        let position_given = this.indexes.length > 1;

   132

   133

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

   134

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

   135

        if(position_given)

   136

            this.position = undefined;

   137

   138

        super.sub(new_offset, relativeness, container_id);

   139

   140

        // if position isn't given as a variable

   141

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

   142

        // and items must be subscibed now.

   143

        if(!position_given)

   144

            this.sub_items();

   145

   146

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

   147

        if(this.indexes.length > 2)

   148

            this.apply_hmi_value(2, this.range);

   149

        if(this.indexes.length > 3)

   150

            this.apply_hmi_value(3, this.size);

   151

    }

   152

   153

    apply_position(new_position){

   154

        let old_position = this.position;

   155

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

   156

        if(this.position == limited_position){

   157

            return false;

   158

        }

   159

        this.unsub_items();

   160

        this.position = limited_position;

   161

        this.sub_items();

   162

        request_subscriptions_update();

   163

        jumps_need_update = true;

   164

        this.request_animate();

   165

        return true;

   166

    }

   167

   168

    on_click(opstr, evt) {

   169

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

   170

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

   171

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

   172

                new_position = 0;

   173

            else

   174

                new_position = this.range - this.size;

   175

        } else if(new_position < 0) {

   176

            if(this.position == 0)

   177

                new_position = this.range - this.size;

   178

            else

   179

                new_position = 0;

   180

        }

   181

        if(this.apply_position(new_position)){

   182

            this.apply_hmi_value(1, this.position);

   183

        }

   184

    }

   185

   186

    dispatch(value, oldval, index) {

   187

        // Only care about position, others are constants

   188

        if(index == 1){

   189

            this.apply_position(value);

   190

            if(this.position != value){

   191

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

   192

                this.apply_hmi_value(1, this.position);

   193

            }

   194

        }

   195

    }

   196

   197

||

   198