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

import os

    27

import re

    28

import datetime

    29

from types import FunctionType

    30

from xml.dom import minidom

    31

    32

from xmlclass.xmlclass import *

    33

    34

    35

def GenerateDictFacets(facets):

    36

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

    37

    38

    39

def GenerateSimpleTypeXMLText(function):

    40

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

    41

        text = ""

    42

        if name is not None:

    43

            ind1, _ind2 = getIndent(indent, name)

    44

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

    45

        text += function(value)

    46

        if name is not None:

    47

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

    48

        return text

    49

    return generateXMLTextMethod

    50

    51

    52

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

    53

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

    54

                    if decimal is not None else str)

    55

    extra_values = [] if extra_values is None else extra_values

    56

    57

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

    58

        text = ""

    59

        if name is not None:

    60

            ind1, _ind2 = getIndent(indent, name)

    61

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

    62

        if isinstance(value, int):

    63

            text += str(value)

    64

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

    65

            text += float_format(value)

    66

        else:

    67

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

    68

        if name is not None:

    69

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

    70

        return text

    71

    return generateXMLTextMethod

    72

    73

    74

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

    75

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

    76

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

    77

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

    78

    79

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

    80

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

    81

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

    82

    83

    84

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

    85

#                           Structure reducing functions

    86

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

    87

    88

    89

# Documentation elements

    90

    91

def ReduceAppInfo(factory, attributes, elements):

    92

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

    93

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

    94

    95

    96

def ReduceDocumentation(factory, attributes, elements):

    97

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

    98

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

    99

   100

   101

def ReduceAnnotation(factory, attributes, elements):

   102

    _annotations, children = factory.ReduceElements(elements)

   103

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

   104

    for child in children:

   105

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

   106

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

   107

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

   108

            if child["source"] is not None:

   109

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

   110

            else:

   111

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

   112

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

   113

                annotation["documentation"] = text

   114

            else:

   115

                annotation["documentation"] += text

   116

    return annotation

   117

   118

# Simple type elements

   119

   120

   121

def GenerateFacetReducing(facetname, canbefixed):

   122

    def ReduceFacet(factory, attributes, elements):

   123

        annotations, _children = factory.ReduceElements(elements)

   124

        if "value" in attributes:

   125

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

   126

            if canbefixed:

   127

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

   128

            return facet

   129

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

   130

    return ReduceFacet

   131

   132

   133

def ReduceList(factory, attributes, elements):

   134

    annotations, children = factory.ReduceElements(elements)

   135

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

   136

   137

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

   138

        if list["itemType"] is None:

   139

            list["itemType"] = children[0]

   140

        else:

   141

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

   142

    if list["itemType"] is None:

   143

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

   144

    return list

   145

   146

   147

def ReduceUnion(factory, attributes, elements):

   148

    annotations, children = factory.ReduceElements(elements)

   149

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

   150

   151

    for child in children:

   152

        if child["type"] == SIMPLETYPE:

   153

            union["memberTypes"].append(child)

   154

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

   155

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

   156

    return union

   157

   158

   159

def CreateSimpleType(factory, attributes, typeinfos):

   160

    # Initialize type informations

   161

    facets = {}

   162

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

   163

    if "name" in attributes:

   164

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

   165

   166

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

   167

        # Search for base type definition

   168

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

   169

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

   170

            if basetypeinfos is None:

   171

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

   172

        else:

   173

            basetypeinfos = typeinfos["base"]

   174

   175

        # Check that base type is a simple type

   176

        if basetypeinfos["type"] != SIMPLETYPE:

   177

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

   178

   179

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

   180

   181

        # Check that derivation is allowed

   182

        if "final" in basetypeinfos:

   183

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

   184

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

   185

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

   186

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

   187

   188

        # Extract simple type facets

   189

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

   190

            facettype = facet["type"]

   191

            if facettype not in basetypeinfos["facets"]:

   192

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

   193

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

   194

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

   195

            value = facet["value"]

   196

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

   197

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

   198

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

   199

                if len(facets) == 0:

   200

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

   201

                    continue

   202

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

   203

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

   204

                    continue

   205

                else:

   206

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

   207

            elif "enumeration" in facets:

   208

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

   209

            elif "pattern" in facets:

   210

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

   211

            elif facettype in facets:

   212

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

   213

            elif facettype == "length":

   214

                if "minLength" in facets:

   215

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

   216

                if "maxLength" in facets:

   217

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

   218

                try:

   219

                    value = int(value)

   220

                except Exception:

   221

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

   222

                if value < 0:

   223

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

   224

                elif basevalue is not None and basevalue != value:

   225

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

   226

            elif facettype == "minLength":

   227

                if "length" in facets:

   228

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

   229

                try:

   230

                    value = int(value)

   231

                except Exception:

   232

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

   233

                if value < 0:

   234

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

   235

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

   236

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

   237

                elif basevalue is not None and basevalue < value:

   238

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

   239

            elif facettype == "maxLength":

   240

                if "length" in facets:

   241

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

   242

                try:

   243

                    value = int(value)

   244

                except Exception:

   245

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

   246

                if value < 0:

   247

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

   248

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

   249

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

   250

                elif basevalue is not None and basevalue > value:

   251

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

   252

            elif facettype == "minInclusive":

   253

                if "minExclusive" in facets:

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

            elif facettype == "minExclusive":

   261

                if "minInclusive" in facets:

   262

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

   263

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

   264

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

   265

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

   266

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

   267

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

   268

            elif facettype == "maxInclusive":

   269

                if "maxExclusive" in facets:

   270

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

   271

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

   272

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

   273

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

   274

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

   275

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

   276

            elif facettype == "maxExclusive":

   277

                if "maxInclusive" in facets:

   278

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

   279

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

   280

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

   281

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

   282

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

   283

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

   284

            elif facettype == "whiteSpace":

   285

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

   286

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

   287

            elif facettype == "totalDigits":

   288

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

   289

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

   290

                elif basevalue is not None and value > basevalue:

   291

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

   292

            elif facettype == "fractionDigits":

   293

                if "totalDigits" in facets and value <= facets["totalDigits"][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

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

   298

   299

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

   300

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

   301

            if facettype not in facets:

   302

                facets[facettype] = facetvalue

   303

   304

        # Generate extract value for new created type

   305

        def ExtractSimpleTypeValue(attr, extract=True):

   306

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

   307

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

   308

                if facetvalue is not None:

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

                    elif facetname == "pattern":

   326

                        model = re.compile("(?:%s)?$" % "|".join(["(?:%s)" % x for x in facetvalue]))

   327

                        result = model.match(value)

   328

                        if result is None:

   329

                            if len(facetvalue) > 1:

   330

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

   331

                            else:

   332

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

   333

                    elif facetname == "whiteSpace":

   334

                        if facetvalue == "replace":

   335

                            value = GetNormalizedString(value, False)

   336

                        elif facetvalue == "collapse":

   337

                            value = GetToken(value, False)

   338

            return value

   339

   340

        def CheckSimpleTypeValue(value):

   341

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

   342

                if facetvalue is not None:

   343

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

   344

                        return False

   345

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

   346

                        return False

   347

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

   348

                        return False

   349

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

   350

                        return False

   351

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

   352

                        return False

   353

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

   354

                        return False

   355

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

   356

                        return False

   357

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

   358

                        return False

   359

                    elif facetname == "pattern":

   360

                        model = re.compile("(?:%s)?$" % "|".join(["(?:%s)" % x for x in facetvalue]))

   361

                        result = model.match(value)

   362

                        if result is None:

   363

                            if len(facetvalue) > 1:

   364

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

   365

                            else:

   366

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

   367

            return True

   368

   369

        def SimpleTypeInitialValue():

   370

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

   371

                if facetvalue is not None:

   372

                    if facetname == "enumeration":

   373

                        return facetvalue[0]

   374

                    elif facetname == "length":

   375

                        return " "*facetvalue

   376

                    elif facetname == "minLength":

   377

                        return " "*facetvalue

   378

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

   379

                        return facetvalue

   380

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

   381

                        return facetvalue + 1

   382

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

   383

                        return facetvalue

   384

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

   385

                        return facetvalue - 1

   386

            return basetypeinfos["initial"]()

   387

   388

        GenerateSimpleType = basetypeinfos["generate"]

   389

   390

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

   391

        # Search for item type definition

   392

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

   393

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

   394

            if itemtypeinfos is None:

   395

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

   396

        else:

   397

            itemtypeinfos = typeinfos["itemType"]

   398

   399

        # Check that item type is a simple type

   400

        if itemtypeinfos["type"] != SIMPLETYPE:

   401

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

   402

   403

        simpleType["basename"] = "list"

   404

   405

        # Check that derivation is allowed

   406

        if "final" in itemtypeinfos:

   407

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

   408

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

   409

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

   410

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

   411

   412

        # Generate extract value for new created type

   413

        def ExtractSimpleTypeValue(attr, extract=True):

   414

            values = []

   415

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

   416

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

   417

            return values

   418

   419

        def CheckSimpleTypeValue(value):

   420

            for item in value:

   421

                result = itemtypeinfos["check"](item)

   422

                if not result:

   423

                    return result

   424

            return True

   425

   426

        def SimpleTypeInitialValue():

   427

            return []

   428

   429

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

   430

   431

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

   432

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

   433

   434

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

   435

        # Search for member types definition

   436

        membertypesinfos = []

   437

        for membertype in typeinfos["memberTypes"]:

   438

            if isinstance(membertype, str):

   439

                infos = factory.FindSchemaElement(membertype, SIMPLETYPE)

   440

                if infos is None:

   441

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

   442

            else:

   443

                infos = membertype

   444

   445

            # Check that member type is a simple type

   446

            if infos["type"] != SIMPLETYPE:

   447

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

   448

   449

            # Check that derivation is allowed

   450

            if "final" in infos:

   451

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

   452

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

   453

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

   454

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

   455

   456

            membertypesinfos.append(infos)

   457

   458

        simpleType["basename"] = "union"

   459

   460

        # Generate extract value for new created type

   461

        def ExtractSimpleTypeValue(attr, extract=True):

   462

            for infos in membertypesinfos:

   463

                try:

   464

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

   465

                except Exception:

   466

                    pass

   467

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

   468

   469

        def CheckSimpleTypeValue(value):

   470

            for infos in membertypesinfos:

   471

                result = infos["check"](value)

   472

                if result:

   473

                    return result

   474

            return False

   475

   476

        SimpleTypeInitialValue = membertypesinfos[0]["initial"]

   477

   478

        def GenerateSimpleTypeFunction(value):

   479

            if isinstance(value, bool):

   480

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

   481

            else:

   482

                return str(value)

   483

        GenerateSimpleType = GenerateSimpleTypeXMLText(GenerateSimpleTypeFunction)

   484

   485

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

   486

   487

    simpleType["facets"] = facets

   488

    simpleType["extract"] = ExtractSimpleTypeValue

   489

    simpleType["initial"] = SimpleTypeInitialValue

   490

    simpleType["check"] = CheckSimpleTypeValue

   491

    simpleType["generate"] = GenerateSimpleType

   492

    return simpleType

   493

   494

   495

def ReduceSimpleType(factory, attributes, elements):

   496

    # Reduce all the simple type children

   497

    annotations, children = factory.ReduceElements(elements)

   498

   499

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

   500

    simpleType["doc"] = annotations

   501

   502

    return simpleType

   503