1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

__version__ = "$Revision$"

     5

     6

import os, sys, getopt, wx, tempfile

     7

from types import TupleType, StringType, UnicodeType

     8

     9

CWD = os.path.split(os.path.realpath(__file__))[0]

    10

    11

def Bpath(*args):

    12

    return os.path.join(CWD,*args)

    13

    14

if __name__ == '__main__':

    15

    def usage():

    16

        print "\nUsage of LPCBeremiz.py :"

    17

        print "\n   %s [Projectpath] [Buildpath]\n"%sys.argv[0]

    18

    19

    try:

    20

        opts, args = getopt.getopt(sys.argv[1:], "h", ["help"])

    21

    except getopt.GetoptError:

    22

        # print help information and exit:

    23

        usage()

    24

        sys.exit(2)

    25

    26

    for o, a in opts:

    27

        if o in ("-h", "--help"):

    28

            usage()

    29

            sys.exit()

    30

    31

    if len(args) > 2:

    32

        usage()

    33

        sys.exit()

    34

    elif len(args) == 1:

    35

        projectOpen = args[0]

    36

        buildpath = None

    37

    elif len(args) == 2:

    38

        projectOpen = args[0]

    39

        buildpath = args[1]

    40

    else:

    41

        projectOpen = None

    42

        buildpath = None

    43

    44

class PseudoLocale:

    45

    LocaleDirs = []

    46

    Domains = []

    47

    48

    def AddCatalogLookupPathPrefix(self, localedir):

    49

        self.LocaleDirs.append(localedir)

    50

    51

    def AddCatalog(self, domain):

    52

        self.Domains.append(domain)

    53

    54

# Import module for internationalization

    55

import gettext

    56

import __builtin__

    57

    58

# Define locale for wx

    59

__builtin__.__dict__['loc'] = PseudoLocale()

    60

    61

if __name__ == '__main__':

    62

    __builtin__.__dict__['_'] = wx.GetTranslation#unicode_translation

    63

    64

from Beremiz import *

    65

from plugger import PluginsRoot, PlugTemplate, opjimg

    66

from plcopen.structures import LOCATIONDATATYPES

    67

from PLCControler import LOCATION_PLUGIN, LOCATION_MODULE, LOCATION_GROUP,\

    68

                         LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY

    69

from PLCOpenEditor import IDEFrame

    70

    71

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

    72

#                              LPCModule Class

    73

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

    74

    75

def _GetModuleChildren(module):

    76

    children = []

    77

    for child in module["children"]:

    78

        if child["type"] == LOCATION_GROUP:

    79

            children.extend(child["children"])

    80

        else:

    81

            children.append(child)

    82

    return children

    83

    84

def _GetLastModuleGroup(module):

    85

    group = module

    86

    for child in module["children"]:

    87

        if child["type"] == LOCATION_GROUP:

    88

            group = child

    89

    return group["children"]

    90

    91

def _GetModuleBySomething(module, something, toks):

    92

    for child in _GetModuleChildren(module):

    93

        if child.get(something) == toks[0]:

    94

            if len(toks) > 1:

    95

                return _GetModuleBySomething(child, something, toks[1:])

    96

            return child

    97

    return None

    98

    99

def _GetModuleVariable(module, location):

   100

    for child in _GetModuleChildren(module):

   101

        if child["location"] == location:

   102

            return child

   103

    return None

   104

   105

def _RemoveModuleChild(module, child):

   106

    if child in module["children"]:

   107

        module["children"].remove(child)

   108

    else:

   109

        for group in module["children"]:

   110

            if group["type"] == LOCATION_GROUP and child in group["children"]:

   111

                group["children"].remove(child)

   112

   113

LOCATION_TYPES = {"I": LOCATION_VAR_INPUT,

   114

                  "Q": LOCATION_VAR_OUTPUT,

   115

                  "M": LOCATION_VAR_MEMORY}

   116

   117

LOCATION_DIRS = dict([(dir, size) for size, dir in LOCATION_TYPES.iteritems()])

   118

   119

LOCATION_SIZES = {}

   120

for size, types in LOCATIONDATATYPES.iteritems():

   121

    for type in types:

   122

        LOCATION_SIZES[type] = size

   123

   124

BUS_TEXT = """/* Code generated by LPCBus plugin */

   125

   126

/* LPCBus plugin includes */

   127

#include "app_glue.h"

   128

#ifdef _WINDOWS_H

   129

  #include "iec_types.h"

   130

#else

   131

  #include "iec_std_lib.h"

   132

#endif

   133

   134

%(declare_code)s

   135

   136

/* LPCBus plugin user variables definition */

   137

%(var_decl)s

   138

   139

/* LPCBus plugin functions */

   140

int __init_%(location_str)s(int argc,char **argv)

   141

{

   142

  return 0;

   143

}

   144

   145

void __cleanup_%(location_str)s(void)

   146

{

   147

}

   148

   149

void __retrieve_%(location_str)s(void)

   150

{

   151

  %(retrieve_code)s

   152

}

   153

   154

void __publish_%(location_str)s(void)

   155

{

   156

  %(publish_code)s

   157

}

   158

"""

   159

   160

class LPCBus(object):

   161

   162

    def __init__(self):

   163

        self.VariableLocationTree = []

   164

        self.ResetUsedLocations()

   165

        self.Icon = None

   166

   167

    def __getitem__(self, key):

   168

        if key == "children":

   169

            return self.VariableLocationTree

   170

        raise KeyError, "Only 'children' key is available"

   171

   172

    def SetIcon(self, icon):

   173

        self.Icon = icon

   174

   175

    def _GetChildBySomething(self, something, toks):

   176

        return _GetModuleBySomething({"children" : self.VariableLocationTree}, something, toks)

   177

   178

    def GetBaseTypes(self):

   179

        return self.GetPlugRoot().GetBaseTypes()

   180

   181

    def GetSizeOfType(self, type):

   182

        return LOCATION_SIZES[self.GetPlugRoot().GetBaseType(type)]

   183

   184

    def _GetVariableLocationTree(self, current_location, infos):

   185

        if infos["type"] == LOCATION_MODULE:

   186

            location = current_location + (infos["IEC_Channel"],)

   187

            return {"name": infos["name"],

   188

                    "type": infos["type"],

   189

                    "location": ".".join(map(str, location + ("x",))), 

   190

                    "icon": infos["icon"], 

   191

                    "children": [self._GetVariableLocationTree(location, child) for child in infos["children"]]}

   192

        elif infos["type"] == LOCATION_GROUP:

   193

            return {"name": infos["name"],

   194

                    "type": infos["type"],

   195

                    "location": "", 

   196

                    "icon": infos["icon"], 

   197

                    "children": [self._GetVariableLocationTree(current_location, child) for child in infos["children"]]}

   198

        else:

   199

            size = self.GetSizeOfType(infos["IEC_type"])

   200

            location = "%" + LOCATION_DIRS[infos["type"]] + size + ".".join(map(str, current_location + infos["location"]))

   201

            return {"name": infos["name"],

   202

                    "type": infos["type"],

   203

                    "size": size,

   204

                    "IEC_type": infos["IEC_type"],

   205

                    "location": location,

   206

                    "description": infos["description"],

   207

                    "children": []}

   208

   209

    def GetVariableLocationTree(self):

   210

        return {"name": self.BaseParams.getName(),

   211

                "type": LOCATION_PLUGIN,

   212

                "location": self.GetFullIEC_Channel(),

   213

                "icon": self.Icon, 

   214

                "children": [self._GetVariableLocationTree(self.GetCurrentLocation(), child) 

   215

                             for child in self.VariableLocationTree]}

   216

   217

    def PlugTestModified(self):

   218

        return False

   219

   220

    def PlugMakeDir(self):

   221

        pass

   222

   223

    def PlugRequestSave(self):

   224

        return None

   225

   226

    def ResetUsedLocations(self):

   227

        self.UsedLocations = {}

   228

   229

    def _AddUsedLocation(self, parent, location):

   230

        num = location.pop(0)

   231

        if not parent.has_key(num):

   232

            parent[num] = {"used": False, "children": {}}

   233

        if len(location) > 0:

   234

            self._AddUsedLocation(parent[num]["children"], location)

   235

        else:

   236

            parent[num]["used"] = True

   237

   238

    def AddUsedLocation(self, location):

   239

        if len(location) > 0:

   240

            self._AddUsedLocation(self.UsedLocations, list(location))

   241

   242

    def _CheckLocationConflicts(self, parent, location):

   243

        num = location.pop(0)

   244

        if not parent.has_key(num):

   245

            return False

   246

        if len(location) > 0:

   247

            if parent[num]["used"]:

   248

                return True

   249

            return self._CheckLocationConflicts(parent[num]["children"], location)

   250

        elif len(parent[num]["children"]) > 0:

   251

            return True

   252

        return False

   253

   254

    def CheckLocationConflicts(self, location):

   255

        if len(location) > 0:

   256

            return self._CheckLocationConflicts(self.UsedLocations, list(location))

   257

        return False

   258

   259

    def PlugGenerate_C(self, buildpath, locations):

   260

        """

   261

        Generate C code

   262

        @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)

   263

        @param locations: List of complete variables locations \

   264

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   265

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   266

            "DIR" : direction "Q","I" or "M"

   267

            "SIZE" : size "X", "B", "W", "D", "L"

   268

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   269

            }, ...]

   270

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   271

        """

   272

        current_location = self.GetCurrentLocation()

   273

        # define a unique name for the generated C file

   274

        location_str = "_".join(map(str, current_location))

   275

   276

        code_str = {"location_str": location_str,

   277

                    "var_decl": "",

   278

                    "declare_code": "",

   279

                    "retrieve_code": "",

   280

                    "publish_code": "",

   281

                   }

   282

   283

        # Adding variables

   284

        vars = []

   285

        self.ResetUsedLocations()

   286

        for location in locations:

   287

            loc = location["LOC"][len(current_location):]

   288

            group = next = self

   289

            i = 0

   290

            while next is not None and i < len(loc):

   291

                next = self._GetChildBySomething("IEC_Channel", loc[:i + 1])

   292

                if next is not None:

   293

                    i += 1

   294

                    group = next

   295

            var_loc = loc[i:]

   296

            for variable in group["children"]:

   297

                if variable["location"] == var_loc:

   298

                    if location["DIR"] != LOCATION_DIRS[variable["type"]]:

   299

                        raise Exception, "Direction conflict in variable definition"

   300

                    if location["IEC_TYPE"] != variable["IEC_type"]:

   301

                        raise Exception, "Type conflict in variable definition"

   302

                    if location["DIR"] == "Q":

   303

                        if self.CheckLocationConflicts(location["LOC"]):

   304

                            raise Exception, "BYTE and BIT from the same BYTE can't be used together"

   305

                        self.AddUsedLocation(location["LOC"])

   306

                    vars.append({"location": location["NAME"],

   307

                                 "Type": variable["IEC_type"],

   308

                                 "Declare": variable["declare"],

   309

                                 "Retrieve": variable["retrieve"],

   310

                                 "Publish": variable["publish"],

   311

                                })

   312

                    break

   313

        base_types = self.GetPlugRoot().GetBaseTypes()

   314

        for var in vars:

   315

            prefix = ""

   316

            if var["Type"] in base_types:

   317

                prefix = "IEC_"

   318

            code_str["var_decl"] += "%s%s beremiz%s;\n"%(prefix, var["Type"], var["location"])

   319

            code_str["var_decl"] += "%s%s *%s = &beremiz%s;\n"%(prefix, var["Type"], var["location"], var["location"])

   320

            if var["Declare"] != "":

   321

                code_str["declare_code"] += var["Declare"] + "\n"

   322

            if var["Retrieve"] != "":

   323

                code_str["retrieve_code"] += var["Retrieve"] % ("*" + var["location"]) + "\n"

   324

            if var["Publish"] != "":

   325

                code_str["publish_code"] += var["Publish"] % ("*" + var["location"]) + "\n"

   326

   327

        Gen_Module_path = os.path.join(buildpath, "Module_%s.c"%location_str)

   328

        module = open(Gen_Module_path,'w')

   329

        module.write(BUS_TEXT % code_str)

   330

        module.close()

   331

   332

        matiec_flags = '"-I%s"'%os.path.abspath(self.GetPlugRoot().GetIECLibPath())

   333

        return [(Gen_Module_path, matiec_flags)],"",True

   334

   335

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

   336

#                              LPCPluginsRoot Class

   337

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

   338

   339

def mycopytree(src, dst):

   340

    """

   341

    Copy content of a directory to an other, omit hidden files

   342

    @param src: source directory

   343

    @param dst: destination directory

   344

    """

   345

    for i in os.listdir(src):

   346

        if not i.startswith('.'):

   347

            srcpath = os.path.join(src,i)

   348

            dstpath = os.path.join(dst,i)

   349

            if os.path.isdir(srcpath):

   350

                os.makedirs(dstpath)

   351

                mycopytree(srcpath, dstpath)

   352

            elif os.path.isfile(srcpath):

   353

                shutil.copy2(srcpath, dstpath)

   354

   355

class LPCPluginsRoot(PluginsRoot):

   356

   357

    PlugChildsTypes = [("LPCBus", LPCBus, "LPC bus")]

   358

   359

    PluginMethods = [

   360

        {"bitmap" : opjimg("Build"),

   361

         "name" : _("Build"),

   362

         "tooltip" : _("Build project into build folder"),

   363

         "method" : "_build"},

   364

        {"bitmap" : opjimg("Clean"),

   365

         "name" : _("Clean"),

   366

         "enabled" : False,

   367

         "tooltip" : _("Clean project build folder"),

   368

         "method" : "_Clean"},

   369

    ]

   370

   371

    def GetProjectName(self):

   372

        return self.Project.getname()

   373

   374

    def GetDefaultTarget(self):

   375

        target = self.Classes["BeremizRoot_TargetType"]()

   376

        target_value = self.Classes["TargetType_Makefile"]()

   377

        target_value.setBuildPath(self.BuildPath)

   378

        target.setcontent({"name": "Makefile", "value": target_value})

   379

        return target

   380

   381

    def SetProjectName(self, name):

   382

        return self.Project.setname(name)

   383

   384

    # Update a PLCOpenEditor Pou variable name

   385

    def UpdateProjectVariableName(self, old_name, new_name):

   386

        self.Project.updateElementName(old_name, new_name)

   387

        self.BufferProject()

   388

   389

    def RemoveProjectVariableByAddress(self, address):

   390

        self.Project.removeVariableByAddress(address)

   391

        self.BufferProject()

   392

   393

    def RemoveProjectVariableByFilter(self, leading):

   394

        self.Project.removeVariableByFilter(leading)

   395

        self.BufferProject()

   396

   397

    def LoadProject(self, ProjectPath, BuildPath=None):

   398

        """

   399

        Load a project XML file

   400

        @param ProjectPath: path of the project xml file

   401

        """

   402

        # Load PLCOpen file

   403

        result = self.OpenXMLFile(ProjectPath)

   404

        if result:

   405

            return result

   406

        # Change XSD into class members

   407

        self._AddParamsMembers()

   408

        self.PluggedChilds = {}

   409

        # Keep track of the root plugin (i.e. project path)

   410

        self.ProjectPath = ProjectPath

   411

   412

        self.BuildPath = tempfile.mkdtemp()

   413

        if BuildPath is not None:

   414

            mycopytree(BuildPath, self.BuildPath)

   415

   416

        self.RefreshPluginsBlockLists()

   417

   418

        if os.path.exists(self._getBuildPath()):

   419

            self.EnableMethod("_Clean", True)

   420

   421

    def SaveProject(self):

   422

        self.SaveXMLFile(self.ProjectPath)

   423

   424

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

   425

#                              LPCBeremiz Class

   426

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

   427

   428

class LPCBeremiz(Beremiz):

   429

   430

    def _init_coll_FileMenu_Items(self, parent):

   431

        AppendMenu(parent, help='', id=wx.ID_SAVE,

   432

              kind=wx.ITEM_NORMAL, text=_(u'Save\tCTRL+S'))

   433

        AppendMenu(parent, help='', id=wx.ID_CLOSE,

   434

              kind=wx.ITEM_NORMAL, text=_(u'Close Tab\tCTRL+W'))

   435

        parent.AppendSeparator()

   436

        AppendMenu(parent, help='', id=wx.ID_PAGE_SETUP,

   437

              kind=wx.ITEM_NORMAL, text=_(u'Page Setup'))

   438

        AppendMenu(parent, help='', id=wx.ID_PREVIEW,

   439

              kind=wx.ITEM_NORMAL, text=_(u'Preview'))

   440

        AppendMenu(parent, help='', id=wx.ID_PRINT,

   441

              kind=wx.ITEM_NORMAL, text=_(u'Print'))

   442

        parent.AppendSeparator()

   443

        AppendMenu(parent, help='', id=wx.ID_PROPERTIES,

   444

              kind=wx.ITEM_NORMAL, text=_(u'Properties'))

   445

        parent.AppendSeparator()

   446

        AppendMenu(parent, help='', id=wx.ID_EXIT,

   447

              kind=wx.ITEM_NORMAL, text=_(u'Quit\tCTRL+Q'))

   448

   449

        self.Bind(wx.EVT_MENU, self.OnSaveProjectMenu, id=wx.ID_SAVE)

   450

        self.Bind(wx.EVT_MENU, self.OnCloseTabMenu, id=wx.ID_CLOSE)

   451

        self.Bind(wx.EVT_MENU, self.OnPageSetupMenu, id=wx.ID_PAGE_SETUP)

   452

        self.Bind(wx.EVT_MENU, self.OnPreviewMenu, id=wx.ID_PREVIEW)

   453

        self.Bind(wx.EVT_MENU, self.OnPrintMenu, id=wx.ID_PRINT)

   454

        self.Bind(wx.EVT_MENU, self.OnPropertiesMenu, id=wx.ID_PROPERTIES)

   455

        self.Bind(wx.EVT_MENU, self.OnQuitMenu, id=wx.ID_EXIT)

   456

   457

    def _init_ctrls(self, prnt):

   458

        IDEFrame._init_ctrls(self, prnt)

   459

   460

        self.Bind(wx.EVT_MENU, self.OnOpenWidgetInspector, id=ID_BEREMIZINSPECTOR)

   461

        accel = wx.AcceleratorTable([wx.AcceleratorEntry(wx.ACCEL_CTRL|wx.ACCEL_ALT, ord('I'), ID_BEREMIZINSPECTOR)])

   462

        self.SetAcceleratorTable(accel)

   463

   464

        self.PLCConfig = wx.ScrolledWindow(id=ID_BEREMIZPLCCONFIG,

   465

              name='PLCConfig', parent=self.LeftNoteBook, pos=wx.Point(0, 0),

   466

              size=wx.Size(-1, -1), style=wx.TAB_TRAVERSAL|wx.SUNKEN_BORDER|wx.HSCROLL|wx.VSCROLL)

   467

        self.PLCConfig.SetBackgroundColour(wx.WHITE)

   468

        self.PLCConfig.Bind(wx.EVT_LEFT_DOWN, self.OnPanelLeftDown)

   469

        self.PLCConfig.Bind(wx.EVT_SIZE, self.OnMoveWindow)

   470

        self.LeftNoteBook.InsertPage(0, self.PLCConfig, _("Topology"), True)

   471

   472

        self.LogConsole = wx.TextCtrl(id=ID_BEREMIZLOGCONSOLE, value='',

   473

                  name='LogConsole', parent=self.BottomNoteBook, pos=wx.Point(0, 0),

   474

                  size=wx.Size(0, 0), style=wx.TE_MULTILINE|wx.TE_RICH2)

   475

        self.LogConsole.Bind(wx.EVT_LEFT_DCLICK, self.OnLogConsoleDClick)

   476

        self.BottomNoteBook.AddPage(self.LogConsole, _("Log Console"))

   477

   478

        self._init_beremiz_sizers()

   479

   480

    def OnCloseFrame(self, event):

   481

        global frame, lpcberemiz_cmd

   482

        frame = None

   483

        self.PluginRoot.ResetAppFrame(lpcberemiz_cmd.Log)

   484

   485

        self.KillLocalRuntime()

   486

   487

        event.Skip()

   488

   489

    def RefreshFileMenu(self):

   490

        if self.PluginRoot is not None:

   491

            selected = self.TabsOpened.GetSelection()

   492

            if selected >= 0:

   493

                graphic_viewer = isinstance(self.TabsOpened.GetPage(selected), Viewer)

   494

            else:

   495

                graphic_viewer = False

   496

            if self.TabsOpened.GetPageCount() > 0:

   497

                self.FileMenu.Enable(wx.ID_CLOSE, True)

   498

                if graphic_viewer:

   499

                    self.FileMenu.Enable(wx.ID_PREVIEW, True)

   500

                    self.FileMenu.Enable(wx.ID_PRINT, True)

   501

                else:

   502

                    self.FileMenu.Enable(wx.ID_PREVIEW, False)

   503

                    self.FileMenu.Enable(wx.ID_PRINT, False)

   504

            else:

   505

                self.FileMenu.Enable(wx.ID_CLOSE, False)

   506

                self.FileMenu.Enable(wx.ID_PREVIEW, False)

   507

                self.FileMenu.Enable(wx.ID_PRINT, False)

   508

            self.FileMenu.Enable(wx.ID_PAGE_SETUP, True)

   509

            self.FileMenu.Enable(wx.ID_SAVE, True)

   510

            self.FileMenu.Enable(wx.ID_PROPERTIES, True)

   511

        else:

   512

            self.FileMenu.Enable(wx.ID_CLOSE, False)

   513

            self.FileMenu.Enable(wx.ID_PAGE_SETUP, False)

   514

            self.FileMenu.Enable(wx.ID_PREVIEW, False)

   515

            self.FileMenu.Enable(wx.ID_PRINT, False)

   516

            self.FileMenu.Enable(wx.ID_SAVE, False)

   517

            self.FileMenu.Enable(wx.ID_PROPERTIES, False)

   518

   519

    def RefreshPLCParams(self):

   520

        self.Freeze()

   521

        self.ClearSizer(self.PLCParamsSizer)

   522

   523

        if self.PluginRoot is not None:    

   524

            plcwindow = wx.Panel(self.PLCConfig, -1, size=wx.Size(-1, -1))

   525

            if self.PluginRoot.PlugTestModified():

   526

                bkgdclr = CHANGED_TITLE_COLOUR

   527

            else:

   528

                bkgdclr = TITLE_COLOUR

   529