1

// widgets_common.ysl2

     2

     3

in xsl decl labels(*ptr, name="defs_by_labels") alias call-template {

     4

    with "hmi_element", "$hmi_element";

     5

    with "labels"{text *ptr};

     6

    content;

     7

};

     8

     9

decl optional_labels(*ptr) alias - {

    10

    /* TODO add some per label xslt variable to check if exist */

    11

    labels(*ptr){

    12

        with "mandatory","'no'";

    13

        content;

    14

    }

    15

};

    16

    17

decl activable_labels(*ptr) alias - {

    18

    optional_labels(*ptr) {

    19

        with "subelements","'active inactive'";

    20

        content;

    21

    }

    22

};

    23

    24

in xsl decl widget_desc(%name, match="widget[@type='%name']", mode="widget_desc") alias template {

    25

    type > «@type»

    26

    content;

    27

};

    28

    29

in xsl decl widget_class(%name, *clsname="%nameWidget", match="widget[@type='%name']", mode="widget_class") alias template {

    30

    | class `text **clsname` extends Widget{

    31

    content;

    32

    | }

    33

};

    34

    35

in xsl decl widget_defs(%name, match="widget[@type='%name']", mode="widget_defs") alias template {

    36

    param "hmi_element";

    37

    content;

    38

};

    39

    40

in xsl decl widget_page(%name, match="widget[@type='%name']", mode="widget_page") alias template {

    41

    param "page_desc";

    42

    content;

    43

};

    44

    45

decl gen_index_xhtml alias - {

    46

    content;

    47

};

    48

    49

template "svg:*", mode="hmi_widgets" {

    50

    const "widget", "func:widget(@id)";

    51

    const "eltid","@id";

    52

    const "args" foreach "$widget/arg" > "«func:escape_quotes(@value)»"`if "position()!=last()" > ,`

    53

    const "indexes" foreach "$widget/path" {

    54

        choose {

    55

            when "not(@index)" {

    56

                choose {

    57

                    when "not(@type)" {

    58

                        warning > Widget «$widget/@type» id="«$eltid»" : No match for path "«@value»" in HMI tree

    59

                        > undefined

    60

                    }

    61

                    when "@type = 'PAGE_LOCAL'" 

    62

                        > "«@value»"

    63

                    when "@type = 'HMI_LOCAL'" 

    64

                        > hmi_local_index("«@value»")

    65

                    otherwise 

    66

                        error > Internal error while processing widget's non indexed HMI tree path : unknown type

    67

                }

    68

            }

    69

            otherwise {

    70

                > «@index»

    71

            }

    72

        }

    73

        if "position()!=last()" > ,

    74

    }

    75

    76

    const "minmaxes" foreach "$widget/path" {

    77

        choose {

    78

            when "@min and @max"

    79

                > [«@min»,«@max»]

    80

            otherwise

    81

                > undefined

    82

        }

    83

        if "position()!=last()" > ,

    84

    }

    85

    86

    const "freq" choose {

    87

        when "$widget/@freq"

    88

            > "«$widget/@freq»"

    89

        otherwise

    90

            > undefined

    91

    }

    92

    93

    |   "«@id»": new «$widget/@type»Widget ("«@id»",«$freq»,[«$args»],[«$indexes»],[«$minmaxes»],{

    94

    apply "$widget", mode="widget_defs" with "hmi_element",".";

    95

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

    96

}

    97

    98

emit "preamble:local-variable-indexes" {

    99

    ||

   100

   101

    let hmi_locals = {};

   102

    var last_remote_index = hmitree_types.length - 1;

   103

    var next_available_index = hmitree_types.length;

   104

    let cookies = new Map(document.cookie.split("; ").map(s=>s.split("=")));

   105

   106

    const local_defaults = {

   107

    ||

   108

    foreach "$parsed_widgets/widget[starts-with(@type,'VarInit')]"{

   109

        if "count(path) != 1" error > VarInit «@id» must have only one variable given.

   110

        if "path/@type != 'PAGE_LOCAL' and path/@type != 'HMI_LOCAL'" error > VarInit «@id» only applies to HMI variable.

   111

        >     "«path/@value»":

   112

        choose {

   113

            when "@type = 'VarInitPersistent'" > cookies.has("«path/@value»")?cookies.get("«path/@value»"):«arg[1]/@value»

   114

            otherwise > «arg[1]/@value»

   115

        }

   116

        > \n

   117

        if "position()!=last()" > ,

   118

    }

   119

    ||

   120

    };

   121

   122

    const persistent_locals = new Set([

   123

    ||

   124

    foreach "$parsed_widgets/widget[@type='VarInitPersistent']"{

   125

    |    "«path/@value»"`if "position()!=last()" > ,`

   126

    }

   127

    ||

   128

    ]);

   129

    var persistent_indexes = new Map();

   130

    var cache = hmitree_types.map(_ignored => undefined);

   131

    var updates = new Map();

   132

   133

    function page_local_index(varname, pagename){

   134

        let pagevars = hmi_locals[pagename];

   135

        let new_index;

   136

        if(pagevars == undefined){

   137

            new_index = next_available_index++;

   138

            hmi_locals[pagename] = {[varname]:new_index}

   139

        } else {

   140

            let result = pagevars[varname];

   141

            if(result != undefined) {

   142

                return result;

   143

            }

   144

   145

            new_index = next_available_index++;

   146

            pagevars[varname] = new_index;

   147

        }

   148

        let defaultval = local_defaults[varname];

   149

        if(defaultval != undefined) {

   150

            cache[new_index] = defaultval; 

   151

            updates.set(new_index, defaultval);

   152

            if(persistent_locals.has(varname))

   153

                persistent_indexes.set(new_index, varname);

   154

        }

   155

        return new_index;

   156

    }

   157

   158

    function hmi_local_index(varname){

   159

        return page_local_index(varname, "HMI_LOCAL");

   160

    }

   161

    ||

   162

}

   163

   164

emit "preamble:widget-base-class" {

   165

    ||

   166

    var pending_widget_animates = [];

   167

   168

    class Widget {

   169

        offset = 0;

   170

        frequency = 10; /* FIXME arbitrary default max freq. Obtain from config ? */

   171

        unsubscribable = false;

   172

        pending_animate = false;

   173

   174

        constructor(elt_id, freq, args, indexes, minmaxes, members){

   175

            this.element_id = elt_id;

   176

            this.element = id(elt_id);

   177

            this.args = args;

   178

            this.indexes = indexes;

   179

            this.minmaxes = minmaxes;

   180

            Object.keys(members).forEach(prop => this[prop]=members[prop]);

   181

            this.lastapply = indexes.map(() => undefined);

   182

            this.inhibit = indexes.map(() => undefined);

   183

            this.pending = indexes.map(() => undefined);

   191

            this.forced_frequency = freq;

   192

            this.clip = true;

   193

        }

   194

   195

        do_init(){

   196

            let forced = this.forced_frequency;

   197

            if(forced !== undefined){

   198

                /*

   199

                once every 10 seconds : 10s

   200

                once per minute : 1m

   201

                once per hour : 1h

   202

                once per day : 1d

   203

                */

   204

                let unit = forced.slice(-1);

   205

                let factor = {

   206

                    "s":1,

   207

                    "m":60,

   208

                    "h":3600,

   209

                    "d":86400}[unit];

   210

   211

                this.frequency = factor ? 1/(factor * Number(forced.slice(0,-1)))

   212

                                          : Number(forced);

   213

            }

   214

   215

            let init = this.init;

   216

            if(typeof(init) == "function"){

   217

                try {

   218

                    init.call(this);

   219

                } catch(err) {

   220

                    console.log(err);

   221

                }

   222

            }

   223

        }

   224

   225

        unsub(){

   226

            /* remove subsribers */

   227

            if(!this.unsubscribable)

   228

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

   229

                    /* flush updates pending because of inhibition */

   230

                    let inhibition = this.inhibit[i];

   231

                    if(inhibition != undefined){

   232

                        clearTimeout(inhibition);

   233

                        this.lastapply[i] = undefined;

   241

                    }

   242

                    let index = this.indexes[i];

   243

                    if(this.relativeness[i])

   244

                        index += this.offset;

   245

                    subscribers(index).delete(this);

   246

                }

   247

            this.offset = 0;

   248

            this.relativeness = undefined;

   249

        }

   250

   251

        sub(new_offset=0, relativeness, container_id){

   252

            this.offset = new_offset;

   253

            this.relativeness = relativeness;

   254

            this.container_id = container_id ;

   255

            /* add this's subsribers */

   256

            if(!this.unsubscribable)

   257

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

   258

                    let index = this.get_variable_index(i);

   259

                    if(index == undefined) continue;

   260

                    subscribers(index).add(this);

   261

                }

   262

            need_cache_apply.push(this); 

   263

        }

   264

   265

        apply_cache() {

   266

            if(!this.unsubscribable) for(let index in this.indexes){

   267

                /* dispatch current cache in newly opened page widgets */

   268

                let realindex = this.get_variable_index(index);

   269

                if(realindex == undefined) continue;

   270

                let cached_val = cache[realindex];

   271

                if(cached_val != undefined)

   272

                    this._dispatch(cached_val, cached_val, index);

   273

            }

   274

        }

   275

   276

        get_variable_index(varnum) {

   277

            let index = this.indexes[varnum];

   278

            if(typeof(index) == "string"){

   279

                index = page_local_index(index, this.container_id);

   280

            } else {

   281

                if(this.relativeness[varnum]){

   282

                    index += this.offset;

   283

                }

   284

            }

   285

            return index;

   286

        }

   287

   288

        overshot(new_val, max) {

   289

        }

   290

   291

        undershot(new_val, min) {

   292

        }

   293

   294

        clip_min_max(index, new_val) {

   295

            let minmax = this.minmaxes[index];

   296

            if(minmax !== undefined && typeof new_val == "number") {

   297

                let [min,max] = minmax;

   298

                if(new_val < min){

   299

                    this.undershot(new_val, min);

   300

                    return min;

   301

                }

   302

                if(new_val > max){

   303

                    this.overshot(new_val, max);

   304

                    return max;

   305

                }

   306

            }

   307

            return new_val;

   308

        }

   309

   310

        change_hmi_value(index, opstr) {

   311

            let realindex = this.get_variable_index(index);

   312

            if(realindex == undefined) return undefined;

   313

            let old_val = cache[realindex];

   314

            let new_val = eval_operation_string(old_val, opstr);

   315

            if(this.clip)

   316

                new_val = this.clip_min_max(index, new_val);

   317

            return apply_hmi_value(realindex, new_val);

   318

        }

   319

   320

        _apply_hmi_value(index, new_val) {

   321

            let realindex = this.get_variable_index(index);

   322

            if(realindex == undefined) return undefined;

   323

            if(this.clip)

   324

                new_val = this.clip_min_max(index, new_val);

   325

            return apply_hmi_value(realindex, new_val);

   326

        }

   327

   329

            this.inhibit[index] = undefined;

   330

            let new_val = this.pending[index];

   331

            this.pending[index] = undefined;

   332

            return this.apply_hmi_value(index, new_val);

   333

        }

   334

   335

        apply_hmi_value(index, new_val) {

   336

            if(this.inhibit[index] == undefined){

   337

                let now = Date.now();

   338

                let min_interval = 1000/this.frequency;

   339

                let lastapply = this.lastapply[index];

   340

                if(lastapply == undefined || now > lastapply + min_interval){

   341

                    this.lastapply[index] = now;

   342

                    return this._apply_hmi_value(index, new_val);

   343

                }

   344

                else {

   345

                    let elapsed = now - lastapply;

   346

                    this.pending[index] = new_val;

   348

                }

   349

            }

   350

            else {

   351

                this.pending[index] = new_val;

   352

                return new_val;

   353

            }

   354

        }

   355

   356

        new_hmi_value(index, value, oldval) {

   357

            // TODO avoid searching, store index at sub()

   358

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

   359

                let refindex = this.get_variable_index(i);

   360

                if(refindex == undefined) continue;

   361

   362

                if(index == refindex) {

   363

                    this._dispatch(value, oldval, i);

   364

                    break;

   365

                }

   366

            }

   367

        }

   368

   376

        _dispatch(value, oldval, varnum) {

   377

            let dispatch = this.dispatch;

   378

            if(dispatch != undefined){

   399

                }

   400

            }

   401

        }

   402

   403

        _animate(){

   404

            this.animate();

   405

            this.pending_animate = false;

   406

        }

   407

   408

        request_animate(){

   409

            if(!this.pending_animate){

   410

                pending_widget_animates.push(this);

   411

                this.pending_animate = true;

   412

                requestHMIAnimation();

   413

            }

   414

   415

        }

   416

   417

        activate_activable(eltsub) {

   418

            eltsub.inactive.style.display = "none";

   419

            eltsub.active.style.display = "";

   420

        }

   421

   422

        inactivate_activable(eltsub) {

   423

            eltsub.active.style.display = "none";

   424

            eltsub.inactive.style.display = "";

   425

        }

   426

    }

   427

    ||

   428

}

   429

   430

const "excluded_types", "str:split('Page VarInit VarInitPersistent')";

   431

   432

// Key to filter unique types

   433

key "TypesKey", "widget", "@type";

   434

   435

emit "declarations:hmi-classes" {

   436

    const "used_widget_types", """$parsed_widgets/widget[

   437

                                    generate-id() = generate-id(key('TypesKey', @type)) and 

   438

                                    not(@type = $excluded_types)]""";

   439

    apply "$used_widget_types", mode="widget_class";

   440

}

   441

   442

template "widget", mode="widget_class"

   443

||

   444

class «@type»Widget extends Widget{

   445

    /* empty class, as «@type» widget didn't provide any */

   446

}

   447

||

   448

   449

const "included_ids","$parsed_widgets/widget[not(@type = $excluded_types) and not(@id = $discardable_elements/@id)]/@id";

   450

const "hmi_widgets","$hmi_elements[@id = $included_ids]";

   451

const "result_widgets","$result_svg_ns//*[@id = $hmi_widgets/@id]";

   452

   453

emit "declarations:hmi-elements" {

   454

    | var hmi_widgets = {

   455

    apply "$hmi_widgets", mode="hmi_widgets";

   456

    | }

   457

}

   458

   459

function "defs_by_labels" {

   460

    param "labels","''";

   461

    param "mandatory","'yes'";

   462

    param "subelements","/..";

   463

    param "hmi_element";

   464

    const "widget_type","@type";

   465

    foreach "str:split($labels)" {

   466

        const "absolute", "starts-with(., '/')";

   467

        const "name","substring(.,number($absolute)+1)";

   468

        const "widget","$result_widgets[@id = $hmi_element/@id]";

   469

        const "elt","($widget//*[not($absolute) and @inkscape:label=$name] | $widget/*[$absolute and @inkscape:label=$name])[1]";

   470

        choose {

   471

            when "not($elt/@id)" {

   472

                if "$mandatory='yes'" {

   473

                    error > «$widget_type» widget must have a «$name» element

   474

                }

   475

                // otherwise produce nothing

   476

            }

   477

            otherwise {

   478

                |     «$name»_elt: id("«$elt/@id»"),

   479

                if "$subelements" {

   480

                |     «$name»_sub: {

   481

                    foreach "str:split($subelements)" {

   482

                        const "subname",".";

   483

                        const "subelt","$elt/*[@inkscape:label=$subname][1]";

   484

                        choose {