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 six import string_types

    34

from past.builtins import long

    35

    36

from xmlclass.xmlclass import *

    37

    38

    39

def GenerateDictFacets(facets):

    40

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

    41

    42

    43

def GenerateSimpleTypeXMLText(function):

    44

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

    45

        text = ""

    46

        if name is not None:

    47

            ind1, _ind2 = getIndent(indent, name)

    48

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

    49

        text += function(value)

    50

        if name is not None:

    51

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

    52

        return text

    53

    return generateXMLTextMethod

    54

    55

    56

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

    57

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

    58

                    if decimal is not None else str)

    59

    extra_values = [] if extra_values is None else extra_values

    60

    61

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

    62

        text = ""

    63

        if name is not None:

    64

            ind1, _ind2 = getIndent(indent, name)

    65

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

    66

        if isinstance(value, int):

    67

            text += str(value)

    68

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

    69

            text += float_format(value)

    70

        else:

    71

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

    72

        if name is not None:

    73

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

    74

        return text

    75

    return generateXMLTextMethod

    76

    77

    78

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

    79

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

    80

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

    81

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

    82

    83

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

    84

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

    85

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

    86

    87

    88

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

    89

#                           Structure reducing functions

    90

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

    91

    92

    93

# Documentation elements

    94

    95

def ReduceAppInfo(factory, attributes, elements):

    96

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

    97

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

    98

    99

   100

def ReduceDocumentation(factory, attributes, elements):

   101

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

   102

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

   103

   104

   105

def ReduceAnnotation(factory, attributes, elements):

   106

    _annotations, children = factory.ReduceElements(elements)

   107

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

   108

    for child in children:

   109

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

   110

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

   111

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

   112

            if child["source"] is not None:

   113

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

   114

            else:

   115

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

   116

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

   117

                annotation["documentation"] = text

   118

            else:

   119

                annotation["documentation"] += text

   120

    return annotation

   121

   122

# Simple type elements

   123

   124

   125

def GenerateFacetReducing(facetname, canbefixed):

   126

    def ReduceFacet(factory, attributes, elements):

   127

        annotations, _children = factory.ReduceElements(elements)

   128

        if "value" in attributes:

   129

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

   130

            if canbefixed:

   131

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

   132

            return facet

   133

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

   134

    return ReduceFacet

   135

   136

   137

def ReduceList(factory, attributes, elements):

   138

    annotations, children = factory.ReduceElements(elements)

   139

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

   140

   141

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

   142

        if list["itemType"] is None:

   143

            list["itemType"] = children[0]

   144

        else:

   145

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

   146

    if list["itemType"] is None:

   147

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

   148

    return list

   149

   150

   151

def ReduceUnion(factory, attributes, elements):

   152

    annotations, children = factory.ReduceElements(elements)

   153

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

   154

   155

    for child in children:

   156

        if child["type"] == SIMPLETYPE:

   157

            union["memberTypes"].append(child)

   158

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

   159

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

   160

    return union

   161

   162

   163

def CreateSimpleType(factory, attributes, typeinfos):

   164

    # Initialize type informations

   165

    facets = {}

   166

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

   167

    if "name" in attributes:

   168

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

   169

   170

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

   171

        # Search for base type definition

   172

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

   173

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

   174

            if basetypeinfos is None:

   175

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

   176

        else:

   177

            basetypeinfos = typeinfos["base"]

   178

   179

        # Check that base type is a simple type

   180

        if basetypeinfos["type"] != SIMPLETYPE:

   181

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

   182

   183

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

   184

   185

        # Check that derivation is allowed

   186

        if "final" in basetypeinfos:

   187

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

   188

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

   189

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

   190

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

   191

   192

        # Extract simple type facets

   193

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

   194

            facettype = facet["type"]

   195

            if facettype not in basetypeinfos["facets"]:

   196

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

   197

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

   198

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

   199

            value = facet["value"]

   200

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

   201

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

   202

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

   203

                if len(facets) == 0:

   204

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

   205

                    continue

   206

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

   207

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

   208

                    continue

   209

                else:

   210

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

   211

            elif "enumeration" in facets:

   212

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

   213

            elif "pattern" in facets:

   214

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

   215

            elif facettype in facets:

   216

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

   217

            elif facettype == "length":

   218

                if "minLength" in facets:

   219

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

   220

                if "maxLength" in facets:

   221

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

   222

                try:

   223

                    value = int(value)

   224

                except Exception:

   225

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

   226

                if value < 0:

   227

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

   228

                elif basevalue is not None and basevalue != value:

   229

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

   230

            elif facettype == "minLength":

   231

                if "length" in facets:

   232

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

   233

                try:

   234

                    value = int(value)

   235

                except Exception:

   236

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

   237

                if value < 0:

   238

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

   239

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

   240

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

   241

                elif basevalue is not None and basevalue < value:

   242

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

   243

            elif facettype == "maxLength":

   244

                if "length" in facets:

   245

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

   246

                try:

   247

                    value = int(value)

   248

                except Exception:

   249

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

   250

                if value < 0:

   251

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

   252

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

   253

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

   254

                elif basevalue is not None and basevalue > value:

   255

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

   256

            elif facettype == "minInclusive":

   257

                if "minExclusive" in facets:

   258

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

   259

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

   260

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

   261

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

   262

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

   263

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

   264

            elif facettype == "minExclusive":

   265

                if "minInclusive" in facets:

   266

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

   267

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

   268

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

   269

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

   270

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

   271

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

   272

            elif facettype == "maxInclusive":

   273

                if "maxExclusive" in facets:

   274

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

   275

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

   276

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

   277

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

   278

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

   279

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

   280

            elif facettype == "maxExclusive":

   281

                if "maxInclusive" in facets:

   282

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

   283

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

   284

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

   285

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

   286

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

   287

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

   288

            elif facettype == "whiteSpace":

   289

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

   290

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

   291

            elif facettype == "totalDigits":

   292

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

   293

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

   294

                elif basevalue is not None and value > basevalue:

   295

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

   296

            elif facettype == "fractionDigits":

   297

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

   298

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

   299

                elif basevalue is not None and value > basevalue:

   300

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

   301

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

   302

   303

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

   304

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

   305

            if facettype not in facets:

   306

                facets[facettype] = facetvalue

   307

   308

        # Generate extract value for new created type

   309

        def ExtractSimpleTypeValue(attr, extract=True):

   310

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

   311

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

   312

                if facetvalue is not None:

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

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

   326

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

   327

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

   328

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

   329

                    elif facetname == "pattern":

   330

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

   331

                        result = model.match(value)

   332

                        if result is None:

   333

                            if len(facetvalue) > 1:

   334

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

   335

                            else:

   336

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

   337

                    elif facetname == "whiteSpace":

   338

                        if facetvalue == "replace":

   339

                            value = GetNormalizedString(value, False)

   340

                        elif facetvalue == "collapse":

   341

                            value = GetToken(value, False)

   342

            return value

   343

   344

        def CheckSimpleTypeValue(value):

   345

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

   346

                if facetvalue is not None:

   347

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

   348

                        return False

   349

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

   350

                        return False

   351

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

   352

                        return False

   353

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

   354

                        return False

   355

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

   356

                        return False

   357

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

   358

                        return False

   359

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

   360

                        return False

   361

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

   362

                        return False

   363

                    elif facetname == "pattern":

   364

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

   365

                        result = model.match(value)

   366

                        if result is None:

   367

                            if len(facetvalue) > 1:

   368

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

   369

                            else:

   370

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

   371

            return True

   372

   373

        def SimpleTypeInitialValue():

   374

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

   375

                if facetvalue is not None:

   376

                    if facetname == "enumeration":

   377

                        return facetvalue[0]

   378

                    elif facetname == "length":

   379

                        return " "*facetvalue

   380

                    elif facetname == "minLength":

   381

                        return " "*facetvalue

   382

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

   383

                        return facetvalue

   384

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

   385

                        return facetvalue + 1

   386

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

   387

                        return facetvalue

   388

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

   389

                        return facetvalue - 1

   390

            return basetypeinfos["initial"]()

   391

   392

        GenerateSimpleType = basetypeinfos["generate"]

   393

   394

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

   395

        # Search for item type definition

   396

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

   397

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

   398

            if itemtypeinfos is None:

   399

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

   400

        else:

   401

            itemtypeinfos = typeinfos["itemType"]

   402

   403

        # Check that item type is a simple type

   404

        if itemtypeinfos["type"] != SIMPLETYPE:

   405

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

   406

   407

        simpleType["basename"] = "list"

   408

   409

        # Check that derivation is allowed

   410

        if "final" in itemtypeinfos:

   411

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

   412

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

   413

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

   414

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

   415

   416

        # Generate extract value for new created type

   417

        def ExtractSimpleTypeValue(attr, extract=True):

   418

            values = []

   419

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

   420

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

   421

            return values

   422

   423

        def CheckSimpleTypeValue(value):

   424

            for item in value:

   425

                result = itemtypeinfos["check"](item)

   426

                if not result:

   427

                    return result

   428

            return True

   429

   430

        def SimpleTypeInitialValue():

   431

            return []

   432

   433

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

   434

   435

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

   436

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

   437

   438

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

   439

        # Search for member types definition

   440

        membertypesinfos = []

   441

        for membertype in typeinfos["memberTypes"]:

   442

            if isinstance(membertype, string_types):

   443

                infos = factory.FindSchemaElement(membertype, SIMPLETYPE)

   444

                if infos is None:

   445

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

   446

            else:

   447

                infos = membertype

   448

   449

            # Check that member type is a simple type

   450

            if infos["type"] != SIMPLETYPE:

   451

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

   452

   453

            # Check that derivation is allowed

   454

            if "final" in infos:

   455

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

   456

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

   457

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

   458

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

   459

   460

            membertypesinfos.append(infos)

   461

   462

        simpleType["basename"] = "union"

   463

   464

        # Generate extract value for new created type

   465

        def ExtractSimpleTypeValue(attr, extract=True):

   466

            for infos in membertypesinfos:

   467

                try:

   468

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

   469

                except Exception:

   470

                    pass

   471

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

   472

   473

        def CheckSimpleTypeValue(value):

   474

            for infos in membertypesinfos:

   475

                result = infos["check"](value)

   476

                if result:

   477

                    return result

   478

            return False

   479

   480

        SimpleTypeInitialValue = membertypesinfos[0]["initial"]

   481

   482

        def GenerateSimpleTypeFunction(value):

   483

            if isinstance(value, bool):

   484

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

   485

            else:

   486

                return str(value)

   487

        GenerateSimpleType = GenerateSimpleTypeXMLText(GenerateSimpleTypeFunction)

   488

   489

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

   490

   491

    simpleType["facets"] = facets

   492

    simpleType["extract"] = ExtractSimpleTypeValue

   493

    simpleType["initial"] = SimpleTypeInitialValue

   494

    simpleType["check"] = CheckSimpleTypeValue

   495

    simpleType["generate"] = GenerateSimpleType

   496

    return simpleType

   497

   498

   499

def ReduceSimpleType(factory, attributes, elements):

   500

    # Reduce all the simple type children

   501

    annotations, children = factory.ReduceElements(elements)

   502

   503

    simpleType = CreateSimpleType(factory, attributes, children[0])

   504