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 print_function

    27

import os

    28

import re

    29

import datetime

    30

from xml.dom import minidom

    31

from types import *

    32

    33

from xmlclass import *

    34

    35

    36

def GenerateDictFacets(facets):

    37

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

    38

    39

    40

def GenerateSimpleTypeXMLText(function):

    41

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

    42

        text = ""

    43

        if name is not None:

    44

            ind1, _ind2 = getIndent(indent, name)

    45

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

    46

        text += function(value)

    47

        if name is not None:

    48

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

    49

        return text

    50

    return generateXMLTextMethod

    51

    52

    54

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

    55

                    if decimal is not None else str)

    57

    58

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

    59

        text = ""

    60

        if name is not None:

    61

            ind1, _ind2 = getIndent(indent, name)

    62

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

    63

        if isinstance(value, IntType):

    64

            text += str(value)

    65

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

    66

            text += float_format(value)

    67

        else:

    68

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

    69

        if name is not None:

    70

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

    71

        return text

    72

    return generateXMLTextMethod

    73

    74

    75

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

    76

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

    77

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

    78

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

    79

    80

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

    81

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

    82

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

    83

    84

    85

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

    86

#                           Structure reducing functions

    87

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

    88

    89

    90

# Documentation elements

    91

    92

def ReduceAppInfo(factory, attributes, elements):

    93

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

    94

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

    95

    96

    97

def ReduceDocumentation(factory, attributes, elements):

    98

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

    99

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

   100

   101

   102

def ReduceAnnotation(factory, attributes, elements):

   103

    _annotations, children = factory.ReduceElements(elements)

   104

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

   105

    for child in children:

   106

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

   107

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

   108

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

   109

            if child["source"] is not None:

   110

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

   111

            else:

   112

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

   113

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

   114

                annotation["documentation"] = text

   115

            else:

   116

                annotation["documentation"] += text

   117

    return annotation

   118

   119

# Simple type elements

   120

   121

   122

def GenerateFacetReducing(facetname, canbefixed):

   123

    def ReduceFacet(factory, attributes, elements):

   124

        annotations, _children = factory.ReduceElements(elements)

   125

        if "value" in attributes:

   126

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

   127

            if canbefixed:

   128

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

   129

            return facet

   130

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

   131

    return ReduceFacet

   132

   133

   134

def ReduceList(factory, attributes, elements):

   135

    annotations, children = factory.ReduceElements(elements)

   136

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

   137

   138

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

   139

        if list["itemType"] is None:

   140

            list["itemType"] = children[0]

   141

        else:

   142

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

   143

    if list["itemType"] is None:

   144

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

   145

    return list

   146

   147

   148

def ReduceUnion(factory, attributes, elements):

   149

    annotations, children = factory.ReduceElements(elements)

   150

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

   151

   152

    for child in children:

   153

        if child["type"] == SIMPLETYPE:

   154

            union["memberTypes"].appendchild

   155

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

   156

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

   157

    return union

   158

   159

   160

def CreateSimpleType(factory, attributes, typeinfos):

   161

    # Initialize type informations

   162

    facets = {}

   163

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

   164

    if "name" in attributes:

   165

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

   166

   167

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

   168

        # Search for base type definition

   169

        if isinstance(typeinfos["base"], (StringType, UnicodeType)):

   170

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

   171

            if basetypeinfos is None:

   172

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

   173

        else:

   174

            basetypeinfos = typeinfos["base"]

   175

   176

        # Check that base type is a simple type

   177

        if basetypeinfos["type"] != SIMPLETYPE:

   178

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

   179

   180

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

   181

   182

        # Check that derivation is allowed

   183

        if "final" in basetypeinfos:

   184

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

   185

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

   186

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

   187

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

   188

   189

        # Extract simple type facets

   190

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

   191

            facettype = facet["type"]

   192

            if facettype not in basetypeinfos["facets"]:

   193

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

   194

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

   195

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

   196

            value = facet["value"]

   197

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

   198

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

   199

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

   200

                if len(facets) == 0:

   201

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

   202

                    continue

   203

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

   204

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

   205

                    continue

   206

                else:

   207

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

   208

            elif "enumeration" in facets:

   209

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

   210

            elif "pattern" in facets:

   211

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

   212

            elif facettype in facets:

   213

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

   214

            elif facettype == "length":

   215

                if "minLength" in facets:

   216

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

   217

                if "maxLength" in facets:

   218

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

   219

                try:

   220

                    value = int(value)

   221

                except Exception:

   222

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

   223

                if value < 0:

   224

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

   225

                elif basevalue is not None and basevalue != value:

   226

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

   227

            elif facettype == "minLength":

   228

                if "length" in facets:

   229

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

   230

                try:

   231

                    value = int(value)

   232

                except Exception:

   233

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

   234

                if value < 0:

   235

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

   236

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

   237

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

   238

                elif basevalue is not None and basevalue < value:

   239

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

   240

            elif facettype == "maxLength":

   241

                if "length" in facets:

   242

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

   243

                try:

   244

                    value = int(value)

   245

                except Exception:

   246

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

   247

                if value < 0:

   248

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

   249

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

   250

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

   251

                elif basevalue is not None and basevalue > value:

   252

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

   253

            elif facettype == "minInclusive":

   254

                if "minExclusive" in facets:

   255

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

   256

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

   257

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

   258

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

   259

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

   260

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

   261

            elif facettype == "minExclusive":

   262

                if "minInclusive" in facets:

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

            elif facettype == "maxInclusive":

   270

                if "maxExclusive" in facets:

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

            elif facettype == "maxExclusive":

   278

                if "maxInclusive" in facets:

   279

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

   280

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

   281

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

   282

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

   283

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

   284

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

   285

            elif facettype == "whiteSpace":

   286

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

   287

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

   288

            elif facettype == "totalDigits":

   289

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

   290

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

   291

                elif basevalue is not None and value > basevalue:

   292

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

   293

            elif facettype == "fractionDigits":

   294

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

   295

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

   296

                elif basevalue is not None and value > basevalue:

   297

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

   298

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

   299

   300

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

   301

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

   302

            if facettype not in facets:

   303

                facets[facettype] = facetvalue

   304

   305

        # Generate extract value for new created type

   306

        def ExtractSimpleTypeValue(attr, extract=True):

   307

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

   308

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

   309

                if facetvalue is not None:

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

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

   326

                    elif facetname == "pattern":

   327

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

   328

                        result = model.match(value)

   329

                        if result is None:

   330

                            if len(facetvalue) > 1:

   331

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

   332

                            else:

   333

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

   334

                    elif facetname == "whiteSpace":

   335

                        if facetvalue == "replace":

   336

                            value = GetNormalizedString(value, False)

   337

                        elif facetvalue == "collapse":

   338

                            value = GetToken(value, False)

   339

            return value

   340

   341

        def CheckSimpleTypeValue(value):

   342

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

   343

                if facetvalue is not None:

   344

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

   345

                        return False

   346

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

   347

                        return False

   348

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

   349

                        return False

   350

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

   351

                        return False

   352

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

   353

                        return False

   354

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

   355

                        return False

   356

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

   357

                        return False

   358

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

   359

                        return False

   360

                    elif facetname == "pattern":

   361

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

   362

                        result = model.match(value)

   363

                        if result is None:

   364

                            if len(facetvalue) > 1:

   365

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

   366

                            else:

   367

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

   368

            return True

   369

   370

        def SimpleTypeInitialValue():

   371

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

   372

                if facetvalue is not None:

   373

                    if facetname == "enumeration":

   374

                        return facetvalue[0]

   375

                    elif facetname == "length":

   376

                        return " "*facetvalue

   377

                    elif facetname == "minLength":

   378

                        return " "*minLength

   379

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

   380

                        return facetvalue

   381

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

   382

                        return facetvalue + 1

   383

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

   384

                        return facetvalue

   385

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

   386

                        return facetvalue - 1

   387

            return basetypeinfos["initial"]()

   388

   389

        GenerateSimpleType = basetypeinfos["generate"]

   390

   391

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

   392

        # Search for item type definition

   393

        if isinstance(typeinfos["itemType"], (StringType, UnicodeType)):

   394

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

   395

            if itemtypeinfos is None:

   396

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

   397

        else:

   398

            itemtypeinfos = typeinfos["itemType"]

   399

   400

        # Check that item type is a simple type

   401

        if itemtypeinfos["type"] != SIMPLETYPE:

   402

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

   403

   404

        simpleType["basename"] = "list"

   405

   406

        # Check that derivation is allowed

   407

        if "final" in itemtypeinfos:

   408

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

   409

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

   410

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

   411

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

   412

   413

        # Generate extract value for new created type

   414

        def ExtractSimpleTypeValue(attr, extract=True):

   415

            values = []

   416

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

   417

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

   418

            return values

   419

   420

        def CheckSimpleTypeValue(value):

   421

            for item in value:

   422

                result = itemtypeinfos["check"](item)

   423

                if not result:

   424

                    return result

   425

            return True

   426

   427

        def SimpleTypeInitialValue():

   428

            return []

   429

   430

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

   431

   432

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

   433

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

   434

   435

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

   436

        # Search for member types definition

   437

        membertypesinfos = []

   438

        for membertype in typeinfos["memberTypes"]:

   439

            if isinstance(membertype, (StringType, UnicodeType)):

   440

                infos = factory.FindSchemaElement(membertype, SIMPLETYPE)

   441

                if infos is None:

   442

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

   443

            else:

   444

                infos = membertype

   445

   446

            # Check that member type is a simple type

   447

            if infos["type"] != SIMPLETYPE:

   448

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

   449

   450

            # Check that derivation is allowed

   451

            if "final" in infos:

   452

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

   453

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

   454

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

   455

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

   456

   457

            membertypesinfos.append(infos)

   458

   459

        simpleType["basename"] = "union"

   460

   461

        # Generate extract value for new created type

   462

        def ExtractSimpleTypeValue(attr, extract=True):

   463

            for infos in membertypesinfos:

   464

                try:

   465

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

   466

                except Exception:

   467

                    pass

   468

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

   469

   470

        def CheckSimpleTypeValue(value):

   471

            for infos in membertypesinfos:

   472

                result = infos["check"](value)

   473

                if result:

   474

                    return result

   475

            return False

   476

   477

        SimpleTypeInitialValue = membertypesinfos[0]["initial"]

   478

   479

        def GenerateSimpleTypeFunction(value):

   480

            if isinstance(value, BooleanType):

   481

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

   482

            else:

   483

                return str(value)

   484

        GenerateSimpleType = GenerateSimpleTypeXMLText(GenerateSimpleTypeFunction)

   485

   486

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

   487

   488

    simpleType["facets"] = facets

   489

    simpleType["extract"] = ExtractSimpleTypeValue

   490

    simpleType["initial"] = SimpleTypeInitialValue

   491

    simpleType["check"] = CheckSimpleTypeValue

   492

    simpleType["generate"] = GenerateSimpleType

   493

    return simpleType

   494

   495

   496

def ReduceSimpleType(factory, attributes, elements):

   497

    # Reduce all the simple type children

   498

    annotations, children = factory.ReduceElements(elements)

   499

   500

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

   501

    simpleType["doc"] = annotations

   502

   503

    return simpleType

   504

   505

# Complex type