1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

from __future__ import absolute_import

    27

from __future__ import print_function

    28

import os

    29

import re

    30

import datetime

    31

from types import FunctionType

    32

from xml.dom import minidom

    33

from future.builtins import round

    34

from six import string_types

    35

from past.builtins import long

    36

    37

from xmlclass.xmlclass import *

    38

    39

    40

def GenerateDictFacets(facets):

    41

    return dict([(name, (None, False)) for name in facets])

    42

    43

    44

def GenerateSimpleTypeXMLText(function):

    45

    def generateXMLTextMethod(value, name=None, indent=0):

    46

        text = ""

    47

        if name is not None:

    48

            ind1, _ind2 = getIndent(indent, name)

    49

            text += ind1 + "<%s>" % name

    50

        text += function(value)

    51

        if name is not None:

    52

            text += "</%s>\n" % name

    53

        return text

    54

    return generateXMLTextMethod

    55

    56

    57

def GenerateFloatXMLText(extra_values=None, decimal=None):

    58

    float_format = (lambda x: "{:.{width}f}".format(x, width=decimal).rstrip('0')

    59

                    if decimal is not None else str)

    60

    extra_values = [] if extra_values is None else extra_values

    61

    62

    def generateXMLTextMethod(value, name=None, indent=0):

    63

        text = ""

    64

        if name is not None:

    65

            ind1, _ind2 = getIndent(indent, name)

    66

            text += ind1 + "<%s>" % name

    67

        if isinstance(value, int):

    68

            text += str(value)

    69

        elif value in extra_values or value % 1 != 0:

    70

            text += float_format(value)

    71

        else:

    72

            text += "{:.0f}".format(value)

    73

        if name is not None:

    74

            text += "</%s>\n" % name

    75

        return text

    76

    return generateXMLTextMethod

    77

    78

    79

DEFAULT_FACETS = GenerateDictFacets(["pattern", "whiteSpace", "enumeration"])

    80

NUMBER_FACETS = GenerateDictFacets(DEFAULT_FACETS.keys() + ["maxInclusive", "maxExclusive", "minInclusive", "minExclusive"])

    81

DECIMAL_FACETS = GenerateDictFacets(NUMBER_FACETS.keys() + ["totalDigits", "fractionDigits"])

    82

STRING_FACETS = GenerateDictFacets(DEFAULT_FACETS.keys() + ["length", "minLength", "maxLength"])

    83

    84

ALL_FACETS = ["pattern", "whiteSpace", "enumeration", "maxInclusive",

    85

              "maxExclusive", "minInclusive", "minExclusive", "totalDigits",

    86

              "fractionDigits", "length", "minLength", "maxLength"]

    87

    88

    89

# -------------------------------------------------------------------------------

    90

#                           Structure reducing functions

    91

# -------------------------------------------------------------------------------

    92

    93

    94

# Documentation elements

    95

    96

def ReduceAppInfo(factory, attributes, elements):

    97

    return {"type": "appinfo", "source": attributes.get("source", None),

    98

            "content": "\n".join(elements)}

    99

   100

   101

def ReduceDocumentation(factory, attributes, elements):

   102

    return {"type": "documentation", "source": attributes.get("source", None),

   103

            "language": attributes.get("lang", "any"), "content": "\n".join(elements)}

   104

   105

   106

def ReduceAnnotation(factory, attributes, elements):

   107

    _annotations, children = factory.ReduceElements(elements)

   108

    annotation = {"type": "annotation", "appinfo": [], "documentation": {}}

   109

    for child in children:

   110

        if child["type"] == "appinfo":

   111

            annotation["appinfo"].append((child["source"], child["content"]))

   112

        elif child["type"] == "documentation":

   113

            if child["source"] is not None:

   114

                text = "(source: %(source)s):\n%(content)s\n\n" % child

   115

            else:

   116

                text = child["content"] + "\n\n"

   117

            if not child["language"] in annotation["documentation"]:

   118

                annotation["documentation"] = text

   119

            else:

   120

                annotation["documentation"] += text

   121

    return annotation

   122

   123

# Simple type elements

   124

   125

   126

def GenerateFacetReducing(facetname, canbefixed):

   127

    def ReduceFacet(factory, attributes, elements):

   128

        annotations, _children = factory.ReduceElements(elements)

   129

        if "value" in attributes:

   130

            facet = {"type": facetname, "value": attributes["value"], "doc": annotations}

   131

            if canbefixed:

   132

                facet["fixed"] = attributes.get("fixed", False)

   133

            return facet

   134

        raise ValueError("A value must be defined for the \"%s\" facet!" % facetname)

   135

    return ReduceFacet

   136

   137

   138

def ReduceList(factory, attributes, elements):

   139

    annotations, children = factory.ReduceElements(elements)

   140

    list = {"type": "list", "itemType": attributes.get("itemType", None), "doc": annotations}

   141

   142

    if len(children) > 0 and children[0]["type"] == SIMPLETYPE:

   143

        if list["itemType"] is None:

   144

            list["itemType"] = children[0]

   145

        else:

   146

            raise ValueError("Only one base type can be defined for restriction!")

   147

    if list["itemType"] is None:

   148

        raise ValueError("No base type has been defined for list!")

   149

    return list

   150

   151

   152

def ReduceUnion(factory, attributes, elements):

   153

    annotations, children = factory.ReduceElements(elements)

   154

    union = {"type": "union", "memberTypes": attributes.get("memberTypes", []), "doc": annotations}

   155

   156

    for child in children:

   157

        if child["type"] == SIMPLETYPE:

   158

            union["memberTypes"].append(child)

   159

    if len(union["memberTypes"]) == 0:

   160

        raise ValueError("No base type has been defined for union!")

   161

    return union

   162

   163

   164

def CreateSimpleType(factory, attributes, typeinfos):

   165

    # Initialize type informations

   166

    facets = {}

   167

    simpleType = {"type": SIMPLETYPE, "final": attributes.get("final", [])}

   168

    if "name" in attributes:

   169

        simpleType["name"] = attributes["name"]

   170

   171

    if typeinfos["type"] in ["restriction", "extension"]:

   172

        # Search for base type definition

   173

        if isinstance(typeinfos["base"], string_types):

   174

            basetypeinfos = factory.FindSchemaElement(typeinfos["base"], SIMPLETYPE)

   175

            if basetypeinfos is None:

   176

                raise "\"%s\" isn't defined!" % typeinfos["base"]

   177

        else:

   178

            basetypeinfos = typeinfos["base"]

   179

   180

        # Check that base type is a simple type

   181

        if basetypeinfos["type"] != SIMPLETYPE:

   182

            raise ValueError("Base type given isn't a simpleType!")

   183

   184

        simpleType["basename"] = basetypeinfos["basename"]

   185

   186

        # Check that derivation is allowed

   187

        if "final" in basetypeinfos:

   188

            if "#all" in basetypeinfos["final"]:

   189

                raise ValueError("Base type can't be derivated!")

   190

            if "restriction" in basetypeinfos["final"] and typeinfos["type"] == "restriction":

   191

                raise ValueError("Base type can't be derivated by restriction!")

   192

   193

        # Extract simple type facets

   194

        for facet in typeinfos.get("facets", []):

   195

            facettype = facet["type"]

   196

            if facettype not in basetypeinfos["facets"]:

   197

                raise ValueError("\"%s\" facet can't be defined for \"%s\" type!" % (facettype, type))

   198

            elif basetypeinfos["facets"][facettype][1]:

   199

                raise ValueError("\"%s\" facet is fixed on base type!" % facettype)

   200

            value = facet["value"]

   201

            basevalue = basetypeinfos["facets"][facettype][0]

   202

            if facettype in ["enumeration", "pattern"]:

   203

                value = basetypeinfos["extract"](value, False)

   204

                if len(facets) == 0:

   205

                    facets[facettype] = ([value], False)

   206

                    continue

   207

                elif facets.keys() == [facettype]:

   208

                    facets[facettype][0].append(value)

   209

                    continue

   210

                else:

   211

                    raise ValueError("\"%s\" facet can't be defined with another facet type!" % facettype)

   212

            elif "enumeration" in facets:

   213

                raise ValueError("\"enumeration\" facet can't be defined with another facet type!")

   214

            elif "pattern" in facets:

   215

                raise ValueError("\"pattern\" facet can't be defined with another facet type!")

   216

            elif facettype in facets:

   217

                raise ValueError("\"%s\" facet can't be defined two times!" % facettype)

   218

            elif facettype == "length":

   219

                if "minLength" in facets:

   220

                    raise ValueError("\"length\" and \"minLength\" facets can't be defined at the same time!")

   221

                if "maxLength" in facets:

   222

                    raise ValueError("\"length\" and \"maxLength\" facets can't be defined at the same time!")

   223

                try:

   224

                    value = int(value)

   225

                except Exception:

   226

                    raise ValueError("\"length\" must be an integer!")

   227

                if value < 0:

   228

                    raise ValueError("\"length\" can't be negative!")

   229

                elif basevalue is not None and basevalue != value:

   230

                    raise ValueError("\"length\" can't be different from \"length\" defined in base type!")

   231

            elif facettype == "minLength":

   232

                if "length" in facets:

   233

                    raise ValueError("\"length\" and \"minLength\" facets can't be defined at the same time!")

   234

                try:

   235

                    value = int(value)

   236

                except Exception:

   237

                    raise ValueError("\"minLength\" must be an integer!")

   238

                if value < 0:

   239

                    raise ValueError("\"minLength\" can't be negative!")

   240

                elif "maxLength" in facets and value > facets["maxLength"]:

   241

                    raise ValueError("\"minLength\" must be lesser than or equal to \"maxLength\"!")

   242

                elif basevalue is not None and basevalue < value:

   243

                    raise ValueError("\"minLength\" can't be lesser than \"minLength\" defined in base type!")

   244

            elif facettype == "maxLength":

   245

                if "length" in facets:

   246

                    raise ValueError("\"length\" and \"maxLength\" facets can't be defined at the same time!")

   247

                try:

   248

                    value = int(value)

   249

                except Exception:

   250

                    raise ValueError("\"maxLength\" must be an integer!")

   251

                if value < 0:

   252

                    raise ValueError("\"maxLength\" can't be negative!")

   253

                elif "minLength" in facets and value < facets["minLength"]:

   254

                    raise ValueError("\"minLength\" must be lesser than or equal to \"maxLength\"!")

   255

                elif basevalue is not None and basevalue > value:

   256

                    raise ValueError("\"maxLength\" can't be greater than \"maxLength\" defined in base type!")

   257

            elif facettype == "minInclusive":

   258

                if "minExclusive" in facets:

   259

                    raise ValueError("\"minExclusive\" and \"minInclusive\" facets can't be defined at the same time!")

   260

                value = basetypeinfos["extract"](facet["value"], False)

   261

                if "maxInclusive" in facets and value > facets["maxInclusive"][0]:

   262

                    raise ValueError("\"minInclusive\" must be lesser than or equal to \"maxInclusive\"!")

   263

                elif "maxExclusive" in facets and value >= facets["maxExclusive"][0]:

   264

                    raise ValueError("\"minInclusive\" must be lesser than \"maxExclusive\"!")

   265

            elif facettype == "minExclusive":

   266

                if "minInclusive" in facets:

   267

                    raise ValueError("\"minExclusive\" and \"minInclusive\" facets can't be defined at the same time!")

   268

                value = basetypeinfos["extract"](facet["value"], False)

   269

                if "maxInclusive" in facets and value >= facets["maxInclusive"][0]:

   270

                    raise ValueError("\"minExclusive\" must be lesser than \"maxInclusive\"!")

   271

                elif "maxExclusive" in facets and value >= facets["maxExclusive"][0]:

   272

                    raise ValueError("\"minExclusive\" must be lesser than \"maxExclusive\"!")

   273

            elif facettype == "maxInclusive":

   274

                if "maxExclusive" in facets:

   275

                    raise ValueError("\"maxExclusive\" and \"maxInclusive\" facets can't be defined at the same time!")

   276

                value = basetypeinfos["extract"](facet["value"], False)

   277

                if "minInclusive" in facets and value < facets["minInclusive"][0]:

   278

                    raise ValueError("\"minInclusive\" must be lesser than or equal to \"maxInclusive\"!")

   279

                elif "minExclusive" in facets and value <= facets["minExclusive"][0]:

   280

                    raise ValueError("\"minExclusive\" must be lesser than \"maxInclusive\"!")

   281

            elif facettype == "maxExclusive":

   282

                if "maxInclusive" in facets:

   283

                    raise ValueError("\"maxExclusive\" and \"maxInclusive\" facets can't be defined at the same time!")

   284

                value = basetypeinfos["extract"](facet["value"], False)

   285

                if "minInclusive" in facets and value <= facets["minInclusive"][0]:

   286

                    raise ValueError("\"minInclusive\" must be lesser than \"maxExclusive\"!")

   287

                elif "minExclusive" in facets and value <= facets["minExclusive"][0]:

   288

                    raise ValueError("\"minExclusive\" must be lesser than \"maxExclusive\"!")

   289

            elif facettype == "whiteSpace":

   290

                if basevalue == "collapse" and value in ["preserve", "replace"] or basevalue == "replace" and value == "preserve":

   291

                    raise ValueError("\"whiteSpace\" is incompatible with \"whiteSpace\" defined in base type!")

   292

            elif facettype == "totalDigits":

   293

                if "fractionDigits" in facets and value <= facets["fractionDigits"][0]:

   294

                    raise ValueError("\"fractionDigits\" must be lesser than or equal to \"totalDigits\"!")

   295

                elif basevalue is not None and value > basevalue:

   296

                    raise ValueError("\"totalDigits\" can't be greater than \"totalDigits\" defined in base type!")

   297

            elif facettype == "fractionDigits":

   298

                if "totalDigits" in facets and value <= facets["totalDigits"][0]:

   299

                    raise ValueError("\"fractionDigits\" must be lesser than or equal to \"totalDigits\"!")

   300

                elif basevalue is not None and value > basevalue:

   301

                    raise ValueError("\"totalDigits\" can't be greater than \"totalDigits\" defined in base type!")

   302

            facets[facettype] = (value, facet.get("fixed", False))

   303

   304

        # Report not redefined facet from base type to new created type

   305

        for facettype, facetvalue in basetypeinfos["facets"].items():

   306

            if facettype not in facets:

   307

                facets[facettype] = facetvalue

   308

   309

        # Generate extract value for new created type

   310

        def ExtractSimpleTypeValue(attr, extract=True):

   311

            value = basetypeinfos["extract"](attr, extract)

   312

            for facetname, (facetvalue, _facetfixed) in facets.items():

   313

                if facetvalue is not None:

   314

                    if facetname == "enumeration" and value not in facetvalue:

   315

                        raise ValueError("\"%s\" not in enumerated values" % value)

   316

                    elif facetname == "length" and len(value) != facetvalue:

   317

                        raise ValueError("value must have a length of %d" % facetvalue)

   318

                    elif facetname == "minLength" and len(value) < facetvalue:

   319

                        raise ValueError("value must have a length of %d at least" % facetvalue)

   320

                    elif facetname == "maxLength" and len(value) > facetvalue:

   321

                        raise ValueError("value must have a length of %d at most" % facetvalue)

   322

                    elif facetname == "minInclusive" and value < facetvalue:

   323

                        raise ValueError("value must be greater than or equal to %s" % str(facetvalue))

   324

                    elif facetname == "minExclusive" and value <= facetvalue:

   325

                        raise ValueError("value must be greater than %s" % str(facetvalue))

   326

                    elif facetname == "maxInclusive" and value > facetvalue:

   327

                        raise ValueError("value must be lesser than or equal to %s" % str(facetvalue))

   328

                    elif facetname == "maxExclusive" and value >= facetvalue:

   329

                        raise ValueError("value must be lesser than %s" % str(facetvalue))

   330

                    elif facetname == "pattern":

   331

                        model = re.compile("(?:%s)?$" % "|".join(map(lambda x: "(?:%s)" % x, facetvalue)))

   332

                        result = model.match(value)

   333

                        if result is None:

   334

                            if len(facetvalue) > 1:

   335

                                raise ValueError("value doesn't follow any of the patterns %s" % ",".join(facetvalue))

   336

                            else:

   337

                                raise ValueError("value doesn't follow the pattern %s" % facetvalue[0])

   338

                    elif facetname == "whiteSpace":

   339

                        if facetvalue == "replace":

   340

                            value = GetNormalizedString(value, False)

   341

                        elif facetvalue == "collapse":

   342

                            value = GetToken(value, False)

   343

            return value

   344

   345

        def CheckSimpleTypeValue(value):

   346

            for facetname, (facetvalue, _facetfixed) in facets.items():

   347

                if facetvalue is not None:

   348

                    if facetname == "enumeration" and value not in facetvalue:

   349

                        return False

   350

                    elif facetname == "length" and len(value) != facetvalue:

   351

                        return False

   352

                    elif facetname == "minLength" and len(value) < facetvalue:

   353

                        return False

   354

                    elif facetname == "maxLength" and len(value) > facetvalue:

   355

                        return False

   356

                    elif facetname == "minInclusive" and value < facetvalue:

   357

                        return False

   358

                    elif facetname == "minExclusive" and value <= facetvalue:

   359

                        return False

   360

                    elif facetname == "maxInclusive" and value > facetvalue:

   361

                        return False

   362

                    elif facetname == "maxExclusive" and value >= facetvalue:

   363

                        return False

   364

                    elif facetname == "pattern":

   365

                        model = re.compile("(?:%s)?$" % "|".join(map(lambda x: "(?:%s)" % x, facetvalue)))

   366

                        result = model.match(value)

   367

                        if result is None:

   368

                            if len(facetvalue) > 1:

   369

                                raise ValueError("value doesn't follow any of the patterns %s" % ",".join(facetvalue))

   370

                            else:

   371

                                raise ValueError("value doesn't follow the pattern %s" % facetvalue[0])

   372

            return True

   373

   374

        def SimpleTypeInitialValue():

   375

            for facetname, (facetvalue, _facetfixed) in facets.items():

   376

                if facetvalue is not None:

   377

                    if facetname == "enumeration":

   378

                        return facetvalue[0]

   379

                    elif facetname == "length":

   380

                        return " "*facetvalue

   381

                    elif facetname == "minLength":

   382

                        return " "*facetvalue

   383

                    elif facetname == "minInclusive" and facetvalue > 0:

   384

                        return facetvalue

   385

                    elif facetname == "minExclusive" and facetvalue >= 0:

   386

                        return facetvalue + 1

   387

                    elif facetname == "maxInclusive" and facetvalue < 0:

   388

                        return facetvalue

   389

                    elif facetname == "maxExclusive" and facetvalue <= 0:

   390

                        return facetvalue - 1

   391

            return basetypeinfos["initial"]()

   392

   393

        GenerateSimpleType = basetypeinfos["generate"]

   394

   395

    elif typeinfos["type"] == "list":

   396

        # Search for item type definition

   397

        if isinstance(typeinfos["itemType"], string_types):

   398

            itemtypeinfos = factory.FindSchemaElement(typeinfos["itemType"], SIMPLETYPE)

   399

            if itemtypeinfos is None:

   400

                raise "\"%s\" isn't defined!" % typeinfos["itemType"]

   401

        else:

   402

            itemtypeinfos = typeinfos["itemType"]

   403

   404

        # Check that item type is a simple type

   405

        if itemtypeinfos["type"] != SIMPLETYPE:

   406

            raise ValueError("Item type given isn't a simpleType!")

   407

   408

        simpleType["basename"] = "list"

   409

   410

        # Check that derivation is allowed

   411

        if "final" in itemtypeinfos:

   412

            if "#all" in itemtypeinfos["final"]:

   413

                raise ValueError("Item type can't be derivated!")

   414

            if "list" in itemtypeinfos["final"]:

   415

                raise ValueError("Item type can't be derivated by list!")

   416

   417

        # Generate extract value for new created type

   418

        def ExtractSimpleTypeValue(attr, extract=True):

   419

            values = []

   420

            for value in GetToken(attr, extract).split(" "):

   421

                values.append(itemtypeinfos["extract"](value, False))

   422

            return values

   423

   424

        def CheckSimpleTypeValue(value):

   425

            for item in value:

   426

                result = itemtypeinfos["check"](item)

   427

                if not result:

   428

                    return result

   429

            return True

   430

   431

        def SimpleTypeInitialValue():

   432

            return []

   433

   434

        GenerateSimpleType = GenerateSimpleTypeXMLText(lambda x: " ".join(map(itemtypeinfos["generate"], x)))

   435

   436

        facets = GenerateDictFacets(["length", "maxLength", "minLength", "enumeration", "pattern"])

   437

        facets["whiteSpace"] = ("collapse", False)

   438

   439

    elif typeinfos["type"] == "union":

   440

        # Search for member types definition

   441

        membertypesinfos = []

   442

        for membertype in typeinfos["memberTypes"]:

   443

            if isinstance(membertype, string_types):

   444

                infos = factory.FindSchemaElement(membertype, SIMPLETYPE)

   445

                if infos is None:

   446

                    raise ValueError("\"%s\" isn't defined!" % membertype)

   447

            else:

   448

                infos = membertype

   449

   450

            # Check that member type is a simple type

   451

            if infos["type"] != SIMPLETYPE:

   452

                raise ValueError("Member type given isn't a simpleType!")

   453

   454

            # Check that derivation is allowed

   455

            if "final" in infos:

   456

                if "#all" in infos["final"]:

   457

                    raise ValueError("Item type can't be derivated!")

   458

                if "union" in infos["final"]:

   459

                    raise ValueError("Member type can't be derivated by union!")

   460

   461

            membertypesinfos.append(infos)

   462

   463

        simpleType["basename"] = "union"

   464

   465

        # Generate extract value for new created type

   466

        def ExtractSimpleTypeValue(attr, extract=True):

   467

            for infos in membertypesinfos:

   468

                try:

   469

                    return infos["extract"](attr, False)

   470

                except Exception:

   471

                    pass

   472

            raise ValueError("\"%s\" isn't valid for type defined for union!")

   473

   474

        def CheckSimpleTypeValue(value):

   475

            for infos in membertypesinfos:

   476

                result = infos["check"](value)

   477

                if result:

   478

                    return result

   479

            return False

   480

   481

        SimpleTypeInitialValue = membertypesinfos[0]["initial"]

   482

   483

        def GenerateSimpleTypeFunction(value):

   484

            if isinstance(value, bool):

   485

                return {True: "true", False: "false"}[value]

   486

            else:

   487

                return str(value)

   488

        GenerateSimpleType = GenerateSimpleTypeXMLText(GenerateSimpleTypeFunction)

   489

   490

        facets = GenerateDictFacets(["pattern", "enumeration"])

   491

   492

    simpleType["facets"] = facets

   493

    simpleType["extract"] = ExtractSimpleTypeValue

   494

    simpleType["initial"] = SimpleTypeInitialValue

   495

    simpleType["check"] = CheckSimpleTypeValue

   496

    simpleType["generate"] = GenerateSimpleType

   497

    return simpleType

   498

   499

   500

def ReduceSimpleType(factory, attributes, elements):

   501

    # Reduce all the simple type children

   502

    annotations, children = factory.ReduceElements(elements)

   503