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, re

    26

import datetime

    27

from xml.dom import minidom

    28

from types import *

    29

    30

from xmlclass import *

    31

    32

def GenerateDictFacets(facets):

    33

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

    34

    35

def GenerateSimpleTypeXMLText(function):

    36

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

    37

        text = ""

    38

        if name is not None:

    39

            ind1, ind2 = getIndent(indent, name)

    40

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

    41

        text += function(value)

    42

        if name is not None:

    43

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

    44

        return text

    45

    return generateXMLTextMethod

    46

    47

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

    48

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

    49

                    if decimal is not None else str)

    50

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

    51

        text = ""

    52

        if name is not None:

    53

            ind1, ind2 = getIndent(indent, name)

    54

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

    55

        if isinstance(value, IntType):

    56

            text += str(value)

    57

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

    58

            text += float_format(value)

    59

        else:

    60

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

    61

        if name is not None:

    62

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

    63

        return text

    64

    return generateXMLTextMethod

    66

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

    67

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

    68

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

    69

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

    70

    73

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

    74

    75

    76

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

    77

#                           Structure reducing functions

    78

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

    79

    80

    81

# Documentation elements

    82

    83

def ReduceAppInfo(factory, attributes, elements):

    85

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

    86

    87

    88

def ReduceDocumentation(factory, attributes, elements):

    90

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

    91

    92

    93

def ReduceAnnotation(factory, attributes, elements):

    94

    annotations, children = factory.ReduceElements(elements)

    95

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

    96

    for child in children:

    97

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

    98

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

    99

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

   100

            if child["source"] is not None:

   101

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

   102

            else:

   103

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

   104

            if not annotation["documentation"].has_key(child["language"]):

   105

                annotation["documentation"] = text

   106

            else:

   107

                annotation["documentation"] += text

   108

    return annotation

   109

   110

# Simple type elements

   111

   112

def GenerateFacetReducing(facetname, canbefixed):

   113

    def ReduceFacet(factory, attributes, elements):

   114

        annotations, children = factory.ReduceElements(elements)

   115

        if attributes.has_key("value"):

   116

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

   117

            if canbefixed:

   118

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

   119

            return facet

   120

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

   121

    return ReduceFacet

   122

   123

   124

def ReduceList(factory, attributes, elements):

   125

    annotations, children = factory.ReduceElements(elements)

   126

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

   128

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

   129

        if list["itemType"] is None:

   130

            list["itemType"] = children[0]

   131

        else:

   132

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

   133

    if list["itemType"] is None:

   134

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

   135

    return list

   136

   137

   138

def ReduceUnion(factory, attributes, elements):

   139

    annotations, children = factory.ReduceElements(elements)

   140

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

   142

    for child in children:

   143

        if child["type"] == SIMPLETYPE:

   144

            union["memberTypes"].appendchild

   145

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

   146

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

   147

    return union

   148

   149

   150

def CreateSimpleType(factory, attributes, typeinfos):

   151

    # Initialize type informations

   152

    facets = {}

   153

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

   154

    if attributes.has_key("name"):

   155

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

   157

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

   158

        # Search for base type definition

   159

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

   160

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

   161

            if basetypeinfos is None:

   163

        else:

   164

            basetypeinfos = typeinfos["base"]

   166

        # Check that base type is a simple type

   167

        if basetypeinfos["type"] != SIMPLETYPE:

   168

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

   170

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

   172

        # Check that derivation is allowed

   173

        if basetypeinfos.has_key("final"):

   174

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

   175

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

   176

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

   177

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

   179

        # Extract simple type facets

   180

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

   181

            facettype = facet["type"]

   182

            if not basetypeinfos["facets"].has_key(facettype):

   183

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

   184

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

   185

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

   186

            value = facet["value"]

   187

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

   188

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

   189

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

   190

                if len(facets) == 0:

   191

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

   192

                    continue

   193

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

   194

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

   195

                    continue

   196

                else:

   197

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

   198

            elif facets.has_key("enumeration"):

   199

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

   200

            elif facets.has_key("pattern"):

   201

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

   202

            elif facets.has_key(facettype):

   203

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

   204

            elif facettype == "length":

   205

                if facets.has_key("minLength"):

   206

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

   207

                if facets.has_key("maxLength"):

   208

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

   209

                try:

   210

                    value = int(value)

   211

                except:

   212

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

   213

                if value < 0:

   214

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

   215

                elif basevalue is not None and basevalue != value:

   216

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

   217

            elif facettype == "minLength":

   218

                if facets.has_key("length"):

   219

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

   220

                try:

   221

                    value = int(value)

   222

                except:

   223

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

   224

                if value < 0:

   225

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

   226

                elif facets.has_key("maxLength") and value > facets["maxLength"]:

   227

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

   228

                elif basevalue is not None and basevalue < value:

   229

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

   230

            elif facettype == "maxLength":

   231

                if facets.has_key("length"):

   232

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

   233

                try:

   234

                    value = int(value)

   235

                except:

   236

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

   237

                if value < 0:

   238

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

   239

                elif facets.has_key("minLength") and value < facets["minLength"]:

   240

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

   241

                elif basevalue is not None and basevalue > value:

   242

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

   243

            elif facettype == "minInclusive":

   244

                if facets.has_key("minExclusive"):

   245

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

   246

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

   247

                if facets.has_key("maxInclusive") and value > facets["maxInclusive"][0]:

   248

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

   249

                elif facets.has_key("maxExclusive") and value >= facets["maxExclusive"][0]:

   250

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

   251

            elif facettype == "minExclusive":

   252

                if facets.has_key("minInclusive"):

   253

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

   254

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

   255

                if facets.has_key("maxInclusive") and value >= facets["maxInclusive"][0]:

   256

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

   257

                elif facets.has_key("maxExclusive") and value >= facets["maxExclusive"][0]:

   258

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

   259

            elif facettype == "maxInclusive":

   260

                if facets.has_key("maxExclusive"):

   261

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

   262

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

   263

                if facets.has_key("minInclusive") and value < facets["minInclusive"][0]:

   264

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

   265

                elif facets.has_key("minExclusive") and value <= facets["minExclusive"][0]:

   266

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

   267

            elif facettype == "maxExclusive":

   268

                if facets.has_key("maxInclusive"):

   269

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

   270

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

   271

                if facets.has_key("minInclusive") and value <= facets["minInclusive"][0]:

   272

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

   273

                elif facets.has_key("minExclusive") and value <= facets["minExclusive"][0]:

   274

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

   275

            elif facettype == "whiteSpace":

   276

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

   277

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

   278

            elif facettype == "totalDigits":

   279

                if facets.has_key("fractionDigits") and value <= facets["fractionDigits"][0]:

   280

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

   281

                elif basevalue is not None and value > basevalue:

   282

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

   283

            elif facettype == "fractionDigits":

   284

                if facets.has_key("totalDigits") and value <= facets["totalDigits"][0]:

   285

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

   286

                elif basevalue is not None and value > basevalue:

   287

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

   288

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

   291

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

   292

            if not facets.has_key(facettype):

   293

                facets[facettype] = facetvalue

   295

        # Generate extract value for new created type

   296

        def ExtractSimpleTypeValue(attr, extract=True):

   297

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

   298

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

   299

                if facetvalue is not None:

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

                    elif facetname == "pattern":

   317

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

   318

                        result = model.match(value)

   319

                        if result is None:

   321

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

   322

                            else:

   323

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

   324

                    elif facetname == "whiteSpace":

   325

                        if facetvalue == "replace":

   326

                            value = GetNormalizedString(value, False)

   327

                        elif facetvalue == "collapse":

   328

                            value = GetToken(value, False)

   329

            return value

   331

        def CheckSimpleTypeValue(value):

   332

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

   333

                if facetvalue is not None:

   334

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

   335

                        return False

   336

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

   337

                        return False

   338

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

   339

                        return False

   340

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

   341

                        return False

   342

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

   343

                        return False

   344

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

   345

                        return False

   346

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

   347

                        return False

   348

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

   349

                        return False

   350

                    elif facetname == "pattern":

   351

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

   352

                        result = model.match(value)

   353

                        if result is None:

   355

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

   356

                            else:

   357

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

   358

            return True

   360

        def SimpleTypeInitialValue():

   361

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

   362

                if facetvalue is not None:

   363

                    if facetname == "enumeration":

   364

                        return facetvalue[0]

   365

                    elif facetname == "length":

   366

                        return " "*facetvalue

   367

                    elif facetname == "minLength":

   368

                        return " "*minLength

   369

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

   370

                        return facetvalue

   371

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

   372

                        return facetvalue + 1

   373

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

   374

                        return facetvalue

   375

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

   376

                        return facetvalue - 1

   377

            return basetypeinfos["initial"]()

   379

        GenerateSimpleType = basetypeinfos["generate"]

   381

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

   382

        # Search for item type definition

   383

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

   384

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

   385

            if itemtypeinfos is None:

   386

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

   387

        else:

   388

            itemtypeinfos = typeinfos["itemType"]

   390

        # Check that item type is a simple type

   391

        if itemtypeinfos["type"] != SIMPLETYPE:

   392

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

   394

        simpleType["basename"] = "list"

   396

        # Check that derivation is allowed

   397

        if itemtypeinfos.has_key("final"):

   398

            if itemtypeinfos["final"].has_key("#all"):

   399

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

   400

            if itemtypeinfos["final"].has_key("list"):

   401

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

   403

        # Generate extract value for new created type

   404

        def ExtractSimpleTypeValue(attr, extract = True):

   405

            values = []

   406

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

   407

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

   408

            return values

   410

        def CheckSimpleTypeValue(value):

   411

            for item in value:

   412

                result = itemtypeinfos["check"](item)

   413

                if not result:

   414

                    return result

   415

            return True

   417

        SimpleTypeInitialValue = lambda: []

   419

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

   421

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

   422

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

   424

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

   425

        # Search for member types definition

   426

        membertypesinfos = []

   427

        for membertype in typeinfos["memberTypes"]:

   428

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

   429

                infos = factory.FindSchemaElement(membertype, SIMPLETYPE)

   430

                if infos is None:

   431

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

   432

            else:

   433

                infos = membertype

   435

            # Check that member type is a simple type

   436

            if infos["type"] != SIMPLETYPE:

   437

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

   439

            # Check that derivation is allowed

   440

            if infos.has_key("final"):

   441

                if infos["final"].has_key("#all"):

   442

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

   443

                if infos["final"].has_key("union"):

   444

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

   446

            membertypesinfos.append(infos)

   448

        simpleType["basename"] = "union"

   450

        # Generate extract value for new created type

   451

        def ExtractSimpleTypeValue(attr, extract = True):

   452

            if extract:

   453

                value = GetAttributeValue(attr)

   454

            else:

   455

                value = attr

   456

            for infos in membertypesinfos:

   457

                try:

   458

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

   459

                except:

   460

                    pass

   461

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

   463

        def CheckSimpleTypeValue(value):

   464

            for infos in membertypesinfos:

   465

                result = infos["check"](value)

   466

                if result:

   467

                    return result

   468

            return False

   470

        SimpleTypeInitialValue = membertypesinfos[0]["initial"]

   472

        def GenerateSimpleTypeFunction(value):

   473

            if isinstance(value, BooleanType):

   474

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

   475

            else:

   476

                return str(value)

   477

        GenerateSimpleType = GenerateSimpleTypeXMLText(GenerateSimpleTypeFunction)

   479

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

   481

    simpleType["facets"] = facets

   482

    simpleType["extract"] = ExtractSimpleTypeValue

   483

    simpleType["initial"] = SimpleTypeInitialValue

   484

    simpleType["check"] = CheckSimpleTypeValue

   485

    simpleType["generate"] = GenerateSimpleType

   486

    return simpleType

   487

   488

def ReduceSimpleType(factory, attributes, elements):

   489

    # Reduce all the simple type children

   490

    annotations, children = factory.ReduceElements(elements)

   492

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

   493

    simpleType["doc"] = annotations

   495

    return simpleType

   496

   497

# Complex type

   498

   499

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

   500

    attrs = []

   501

    attrnames = {}

   502

    if base is not None:

   503

        basetypeinfos = factory.FindSchemaElement(base)

   504

        if not isinstance(basetypeinfos, (UnicodeType, StringType)) and basetypeinfos["type"] == COMPLEXTYPE:

   505

            attrnames = dict(map(lambda x:(x["name"], True), basetypeinfos["attributes"]))

   507

    for element in elements:

   508

        if element["type"] == ATTRIBUTE:

   509

            if attrnames.get(element["name"], False):

   510

                raise ValueError("\"%s\" attribute has been defined two times!" % element["name"])

   511

            else:

   512

                attrnames[element["name"]] = True

   513

                attrs.append(element)

   514

        elif element["type"] == "attributeGroup":

   515

            attrgroup = factory.FindSchemaElement(element["ref"], ATTRIBUTESGROUP)

   516

            for attr in attrgroup["attributes"]:

   517

                if attrnames.get(attr["name"], False):

   518

                    raise ValueError("\"%s\" attribute has been defined two times!" % attr["name"])