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

import os

    26

import re

    27

import datetime

    28

from xml.dom import minidom

    29

from types import *

    30

    31

from xmlclass import *

    32

    33

    34

def GenerateDictFacets(facets):

    35

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

    36

    37

    38

def GenerateSimpleTypeXMLText(function):

    39

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

    40

        text = ""

    41

        if name is not None:

    42

            ind1, ind2 = getIndent(indent, name)

    43

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

    44

        text += function(value)

    45

        if name is not None:

    46

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

    47

        return text

    48

    return generateXMLTextMethod

    49

    50

    51

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

    52

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

    53

                    if decimal is not None else str)

    54

    55

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

    56

        text = ""

    57

        if name is not None:

    58

            ind1, ind2 = getIndent(indent, name)

    59

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

    60

        if isinstance(value, IntType):

    61

            text += str(value)

    62

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

    63

            text += float_format(value)

    64

        else:

    65

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

    66

        if name is not None:

    67

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

    68

        return text

    69

    return generateXMLTextMethod

    70

    71

    72

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

    73

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

    74

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

    75

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

    76

    77

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

    78

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

    79

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

    80

    81

    82

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

    83

#                           Structure reducing functions

    84

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

    85

    86

    87

# Documentation elements

    88

    89

def ReduceAppInfo(factory, attributes, elements):

    90

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

    91

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

    92

    93

    94

def ReduceDocumentation(factory, attributes, elements):

    95

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

    96

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

    97

    98

    99

def ReduceAnnotation(factory, attributes, elements):

   100

    annotations, children = factory.ReduceElements(elements)

   101

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

   102

    for child in children:

   103

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

   104

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

   105

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

   106

            if child["source"] is not None:

   107

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

   108

            else:

   109

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

   110

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

   111

                annotation["documentation"] = text

   112

            else:

   113

                annotation["documentation"] += text

   114

    return annotation

   115

   116

# Simple type elements

   117

   118

   119

def GenerateFacetReducing(facetname, canbefixed):

   120

    def ReduceFacet(factory, attributes, elements):

   121

        annotations, children = factory.ReduceElements(elements)

   122

        if "value" in attributes:

   123

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

   124

            if canbefixed:

   125

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

   126

            return facet

   127

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

   128

    return ReduceFacet

   129

   130

   131

def ReduceList(factory, attributes, elements):

   132

    annotations, children = factory.ReduceElements(elements)

   133

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

   134

   135

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

   136

        if list["itemType"] is None:

   137

            list["itemType"] = children[0]

   138

        else:

   139

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

   140

    if list["itemType"] is None:

   141

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

   142

    return list

   143

   144

   145

def ReduceUnion(factory, attributes, elements):

   146

    annotations, children = factory.ReduceElements(elements)

   147

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

   148

   149

    for child in children:

   150

        if child["type"] == SIMPLETYPE:

   151

            union["memberTypes"].appendchild

   152

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

   153

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

   154

    return union

   155

   156

   157

def CreateSimpleType(factory, attributes, typeinfos):

   158

    # Initialize type informations

   159

    facets = {}

   160

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

   161

    if "name" in attributes:

   162

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

   163

   164

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

   165

        # Search for base type definition

   166

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

   167

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

   168

            if basetypeinfos is None:

   169

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

   170

        else:

   171

            basetypeinfos = typeinfos["base"]

   172

   173

        # Check that base type is a simple type

   174

        if basetypeinfos["type"] != SIMPLETYPE:

   175

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

   176

   177

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

   178

   179

        # Check that derivation is allowed

   180

        if "final" in basetypeinfos:

   181

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

   182

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

   183

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

   184

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

   185

   186

        # Extract simple type facets

   187

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

   188

            facettype = facet["type"]

   189

            if not facettype in basetypeinfos["facets"]:

   190

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

   191

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

   192

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

   193

            value = facet["value"]

   194

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

   195

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

   196

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

   197

                if len(facets) == 0:

   198

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

   199

                    continue

   200

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

   201

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

   202

                    continue

   203

                else:

   204

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

   205

            elif "enumeration" in facets:

   206

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

   207

            elif "pattern" in facets:

   208

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

   209

            elif facettype in facets:

   210

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

   211

            elif facettype == "length":

   212

                if "minLength" in facets:

   213

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

   214

                if "maxLength" in facets:

   215

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

   216

                try:

   217

                    value = int(value)

   218

                except:

   219

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

   220

                if value < 0:

   221

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

   222

                elif basevalue is not None and basevalue != value:

   223

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

   224

            elif facettype == "minLength":

   225

                if "length" in facets:

   226

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

   227

                try:

   228

                    value = int(value)

   229

                except:

   230

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

   231

                if value < 0:

   232

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

   233

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

   234

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

   235

                elif basevalue is not None and basevalue < value:

   236

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

   237

            elif facettype == "maxLength":

   238

                if "length" in facets:

   239

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

   240

                try:

   241

                    value = int(value)

   242

                except:

   243

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

   244

                if value < 0:

   245

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

   246

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

   247

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

   248

                elif basevalue is not None and basevalue > value:

   249

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

   250

            elif facettype == "minInclusive":

   251

                if "minExclusive" in facets:

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

            elif facettype == "minExclusive":

   259

                if "minInclusive" in facets:

   260

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

   261

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

   262

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

   263

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

   264

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

   265

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

   266

            elif facettype == "maxInclusive":

   267

                if "maxExclusive" in facets:

   268

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

   269

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

   270

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

   271

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

   272

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

   273

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

   274

            elif facettype == "maxExclusive":

   275

                if "maxInclusive" in facets:

   276

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

   277

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

   278

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

   279

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

   280

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

   281

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

   282

            elif facettype == "whiteSpace":

   283

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

   284

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

   285

            elif facettype == "totalDigits":

   286

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

   287

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

   288

                elif basevalue is not None and value > basevalue:

   289

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

   290

            elif facettype == "fractionDigits":

   291

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

   292

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

   293

                elif basevalue is not None and value > basevalue:

   294

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

   295

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

   296

   297

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

   298

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

   299

            if not facettype in facets:

   300

                facets[facettype] = facetvalue

   301

   302

        # Generate extract value for new created type

   303

        def ExtractSimpleTypeValue(attr, extract=True):

   304

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

   305

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

   306

                if facetvalue is not None:

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

                    elif facetname == "pattern":

   324

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

   325

                        result = model.match(value)

   326

                        if result is None:

   327

                            if len(facetvalue) > 1:

   328

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

   329

                            else:

   330

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

   331

                    elif facetname == "whiteSpace":

   332

                        if facetvalue == "replace":

   333

                            value = GetNormalizedString(value, False)

   334

                        elif facetvalue == "collapse":

   335

                            value = GetToken(value, False)

   336

            return value

   337

   338

        def CheckSimpleTypeValue(value):

   339

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

   340

                if facetvalue is not None:

   341

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

   342

                        return False

   343

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

   344

                        return False

   345

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

   346

                        return False

   347

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

   348

                        return False

   349

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

   350

                        return False

   351

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

   352

                        return False

   353

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

   354

                        return False

   355

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

   356

                        return False

   357

                    elif facetname == "pattern":

   358

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

   359

                        result = model.match(value)

   360

                        if result is None:

   361

                            if len(facetvalue) > 1:

   362

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

   363

                            else:

   364

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

   365

            return True

   366

   367

        def SimpleTypeInitialValue():

   368

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

   369

                if facetvalue is not None:

   370

                    if facetname == "enumeration":

   371

                        return facetvalue[0]

   372

                    elif facetname == "length":

   373

                        return " "*facetvalue

   374

                    elif facetname == "minLength":

   375

                        return " "*minLength

   376

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

   377

                        return facetvalue

   378

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

   379

                        return facetvalue + 1

   380

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

   381

                        return facetvalue

   382

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

   383

                        return facetvalue - 1

   384

            return basetypeinfos["initial"]()

   385

   386

        GenerateSimpleType = basetypeinfos["generate"]

   387

   388

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

   389

        # Search for item type definition

   390

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

   391

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

   392

            if itemtypeinfos is None:

   393

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

   394

        else:

   395

            itemtypeinfos = typeinfos["itemType"]

   396

   397

        # Check that item type is a simple type

   398

        if itemtypeinfos["type"] != SIMPLETYPE:

   399

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

   400

   401

        simpleType["basename"] = "list"

   402

   403

        # Check that derivation is allowed

   404

        if "final" in itemtypeinfos:

   405

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

   406

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

   407

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

   408

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

   409

   410

        # Generate extract value for new created type

   411

        def ExtractSimpleTypeValue(attr, extract=True):

   412

            values = []

   413

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

   414

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

   415

            return values

   416

   417

        def CheckSimpleTypeValue(value):

   418

            for item in value:

   419

                result = itemtypeinfos["check"](item)

   420

                if not result:

   421

                    return result

   422

            return True

   423

   424

        def SimpleTypeInitialValue():

   425

            return []

   426

   427

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

   428

   429

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

   430

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

   431

   432

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

   433

        # Search for member types definition

   434

        membertypesinfos = []

   435

        for membertype in typeinfos["memberTypes"]:

   436

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

   437

                infos = factory.FindSchemaElement(membertype, SIMPLETYPE)

   438

                if infos is None:

   439

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

   440

            else:

   441

                infos = membertype

   442

   443

            # Check that member type is a simple type

   444

            if infos["type"] != SIMPLETYPE:

   445

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

   446

   447

            # Check that derivation is allowed

   448

            if "final" in infos:

   449

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

   450

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

   451

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

   452

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

   453

   454

            membertypesinfos.append(infos)

   455

   456

        simpleType["basename"] = "union"

   457

   458

        # Generate extract value for new created type

   459

        def ExtractSimpleTypeValue(attr, extract=True):

   460

            if extract:

   461

                value = GetAttributeValue(attr)

   462

            else:

   463

                value = attr

   464

            for infos in membertypesinfos:

   465

                try:

   466

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

   467

                except:

   468

                    pass

   469

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

   470

   471

        def CheckSimpleTypeValue(value):

   472

            for infos in membertypesinfos:

   473

                result = infos["check"](value)

   474

                if result:

   475

                    return result

   476

            return False

   477

   478

        SimpleTypeInitialValue = membertypesinfos[0]["initial"]

   479

   480

        def GenerateSimpleTypeFunction(value):

   481

            if isinstance(value, BooleanType):

   482

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

   483

            else:

   484

                return str(value)

   485

        GenerateSimpleType = GenerateSimpleTypeXMLText(GenerateSimpleTypeFunction)

   486

   487

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

   488

   489

    simpleType["facets"] = facets

   490

    simpleType["extract"] = ExtractSimpleTypeValue

   491

    simpleType["initial"] = SimpleTypeInitialValue

   492

    simpleType["check"] = CheckSimpleTypeValue

   493

    simpleType["generate"] = GenerateSimpleType

   494

    return simpleType

   495

   496

   497

def ReduceSimpleType(factory, attributes, elements):

   498

    # Reduce all the simple type children

   499

    annotations, children = factory.ReduceElements(elements)

   500

   501

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

   502

    simpleType["doc"] = annotations

   503

   504

    return simpleType

   505

   506

# Complex type

   507

   508

   509

def ExtractAttributes(factory, elements, base=None):