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 library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

    26

updateinfo_url = None

    27

    28

import os, sys, getopt, wx

    29

import __builtin__

    30

from wx.lib.agw.advancedsplash import AdvancedSplash

    31

import tempfile

    32

import shutil

    33

import random

    34

import time

    35

from types import ListType

    36

    37

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

    38

    39

def Bpath(*args):

    40

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

    41

    42

if __name__ == '__main__':

    43

    def usage():

    44

        print "\nUsage of Beremiz.py :"

    45

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

    46

    47

    try:

    48

        opts, args = getopt.getopt(sys.argv[1:], "hu:e:", ["help", "updatecheck=", "extend="])

    49

    except getopt.GetoptError:

    50

        # print help information and exit:

    51

        usage()

    52

        sys.exit(2)

    53

    54

    extensions=[]

    55

    56

    for o, a in opts:

    57

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

    58

            usage()

    59

            sys.exit()

    60

        if o in ("-u", "--updatecheck"):

    61

            updateinfo_url = a

    62

        if o in ("-e", "--extend"):

    63

            extensions.append(a)

    64

    65

    if len(args) > 2:

    66

        usage()

    67

        sys.exit()

    68

    elif len(args) == 1:

    69

        projectOpen = args[0]

    70

        buildpath = None

    71

    elif len(args) == 2:

    72

        projectOpen = args[0]

    73

        buildpath = args[1]

    74

    else:

    75

        projectOpen = None

    76

        buildpath = None

    77

    78

    if os.path.exists("BEREMIZ_DEBUG"):

    79

        __builtin__.__dict__["BMZ_DBG"] = True

    80

    else :

    81

        __builtin__.__dict__["BMZ_DBG"] = False

    82

    83

    app = wx.PySimpleApp(redirect=BMZ_DBG)

    84

    app.SetAppName('beremiz')

    85

    wx.InitAllImageHandlers()

    86

    87

    # popup splash

    88

    bmp = wx.Image(Bpath("images", "splash.png")).ConvertToBitmap()

    89

    #splash=AdvancedSplash(None, bitmap=bmp, style=wx.SPLASH_CENTRE_ON_SCREEN, timeout=4000)

    90

    splash=AdvancedSplash(None, bitmap=bmp)

    91

    wx.Yield()

    92

    93

    if updateinfo_url is not None:

    94

        updateinfo = "Fetching %s" % updateinfo_url

    95

        # warn for possible updates

    96

        def updateinfoproc():

    97

            global updateinfo

    98

            try :

    99

                import urllib2

   100

                updateinfo = urllib2.urlopen(updateinfo_url,None).read()

   101

            except :

   102

                updateinfo = "update info unavailable." 

   103

   104

        from threading import Thread

   105

        splash.SetText(text=updateinfo)

   106

        wx.Yield()

   107

        updateinfoThread = Thread(target=updateinfoproc)

   108

        updateinfoThread.start()

   109

        updateinfoThread.join(2)

   110

        splash.SetText(text=updateinfo)

   111

        wx.Yield()

   112

   113

from util.TranslationCatalogs import AddCatalog

   114

from util.BitmapLibrary import AddBitmapFolder, GetBitmap

   115

   116

AddCatalog(os.path.join(CWD, "locale"))

   117

AddBitmapFolder(os.path.join(CWD, "images"))

   118

   119

if __name__ == '__main__':

   120

    # Import module for internationalization

   121

    import gettext

   122

   123

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

   124

   125

    # Load extensions

   126

    for extfilename in extensions:

   127

        extension_folder = os.path.split(os.path.realpath(extfilename))[0]

   128

        sys.path.append(extension_folder)

   129

        AddCatalog(os.path.join(extension_folder, "locale"))

   130

        AddBitmapFolder(os.path.join(extension_folder, "images"))

   131

        execfile(extfilename, locals())

   132

   133

import wx.lib.buttons, wx.lib.statbmp

   134

import cPickle

   135

import types, time, re, platform, time, traceback, commands

   136

   137

from docutil import OpenHtmlFrame

   138

from IDEFrame import IDEFrame, AppendMenu

   139

from IDEFrame import TITLE, EDITORTOOLBAR, FILEMENU, EDITMENU, DISPLAYMENU, PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE, SCALING, PAGETITLES 

   140

from IDEFrame import EncodeFileSystemPath, DecodeFileSystemPath

   141

from editors.EditorPanel import EditorPanel

   142

from editors.Viewer import Viewer

   143

from editors.TextViewer import TextViewer

   144

from editors.GraphicViewer import GraphicViewer

   145

from editors.ResourceEditor import ConfigurationEditor, ResourceEditor

   146

from editors.DataTypeEditor import DataTypeEditor

   147

from util.MiniTextControler import MiniTextControler

   148

from util.ProcessLogger import ProcessLogger

   149

from controls.LogViewer import LogViewer

   150

   151

from PLCControler import LOCATION_CONFNODE, LOCATION_MODULE, LOCATION_GROUP, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY, ITEM_PROJECT, ITEM_RESOURCE

   152

from ProjectController import ProjectController, MATIEC_ERROR_MODEL, ITEM_CONFNODE

   153

   154

   155

MAX_RECENT_PROJECTS = 10

   156

   157

class GenStaticBitmap(wx.lib.statbmp.GenStaticBitmap):

   158

    """ Customized GenStaticBitmap, fix transparency redraw bug on wx2.8/win32, 

   159

    and accept image name as __init__ parameter, fail silently if file do not exist"""

   160

    def __init__(self, parent, ID, bitmapname,

   161

                 pos = wx.DefaultPosition, size = wx.DefaultSize,

   162

                 style = 0,

   163

                 name = "genstatbmp"):

   164

   165

        wx.lib.statbmp.GenStaticBitmap.__init__(self, parent, ID, 

   166

                 GetBitmap(bitmapname),

   167

                 pos, size,

   168

                 style,

   169

                 name)

   170

   171

    def OnPaint(self, event):

   172

        dc = wx.PaintDC(self)

   173

        colour = self.GetParent().GetBackgroundColour()

   174

        dc.SetPen(wx.Pen(colour))

   175

        dc.SetBrush(wx.Brush(colour ))

   176

        dc.DrawRectangle(0, 0, *dc.GetSizeTuple())

   177

        if self._bitmap:

   178

            dc.DrawBitmap(self._bitmap, 0, 0, True)

   179

   180

   181

from threading import Lock,Timer,currentThread

   182

MainThread = currentThread().ident

   183

REFRESH_PERIOD = 0.1

   184

from time import time as gettime

   185

class LogPseudoFile:

   186

    """ Base class for file like objects to facilitate StdOut for the Shell."""

   187

    def __init__(self, output, risecall):

   188

        self.red_white = wx.TextAttr("RED", "WHITE")

   189

        self.red_yellow = wx.TextAttr("RED", "YELLOW")

   190

        self.black_white = wx.TextAttr("BLACK", "WHITE")

   191

        self.default_style = None

   192

        self.output = output

   193

        self.risecall = risecall

   194

        # to prevent rapid fire on rising log panel

   195

        self.rising_timer = 0

   196

        self.lock = Lock()

   197

        self.YieldLock = Lock()

   198

        self.RefreshLock = Lock()

   199

        self.TimerAccessLock = Lock()

   200

        self.stack = []

   201

        self.LastRefreshTime = gettime()

   202

        self.LastRefreshTimer = None

   203

   204

    def write(self, s, style = None):

   205

        if self.lock.acquire():

   206

            self.stack.append((s,style))

   207

            self.lock.release()

   208

            current_time = gettime()

   209

            self.TimerAccessLock.acquire()

   210

            if self.LastRefreshTimer:

   211

                self.LastRefreshTimer.cancel()

   212

                self.LastRefreshTimer=None

   213

            self.TimerAccessLock.release()

   214

            if current_time - self.LastRefreshTime > REFRESH_PERIOD and self.RefreshLock.acquire(False):

   215

                self._should_write()

   216

            else:

   217

                self.TimerAccessLock.acquire()

   218

                self.LastRefreshTimer = Timer(REFRESH_PERIOD, self._timer_expired)

   219

                self.LastRefreshTimer.start()

   220

                self.TimerAccessLock.release()

   221

   222

    def _timer_expired(self):

   223

        if self.RefreshLock.acquire(False):

   224

            self._should_write()

   225

        else:

   226

            self.TimerAccessLock.acquire()

   227

            self.LastRefreshTimer = Timer(REFRESH_PERIOD, self._timer_expired)

   228

            self.LastRefreshTimer.start()

   229

            self.TimerAccessLock.release()

   230

   231

    def _should_write(self):

   232

        wx.CallAfter(self._write)

   233

        if MainThread == currentThread().ident:

   234

            app = wx.GetApp()

   235

            if app is not None:

   236

                if self.YieldLock.acquire(0):

   237

                    app.Yield()

   238

                    self.YieldLock.release()

   239

   240

    def _write(self):

   241

        if self.output :

   242

            self.output.Freeze()

   243

            self.lock.acquire()

   244

            for s, style in self.stack:

   245

                if style is None : style=self.black_white

   246

                if self.default_style != style: 

   247

                    self.output.SetDefaultStyle(style)

   248

                    self.default_style = style

   249

                self.output.AppendText(s)

   250

                self.output.ScrollLines(s.count('\n')+1)

   251

            self.stack = []

   252

            self.lock.release()

   253

            self.output.ShowPosition(self.output.GetLastPosition())

   254

            self.output.Thaw()

   255

            self.LastRefreshTime = gettime()

   256

            try:

   257

                self.RefreshLock.release()

   258

            except:

   259

                pass

   260

            newtime = time.time()

   261

            if newtime - self.rising_timer > 1:

   262

                self.risecall()

   263

            self.rising_timer = newtime

   264

   265

    def write_warning(self, s):

   266

        self.write(s,self.red_white)

   267

   268

    def write_error(self, s):

   269

        self.write(s,self.red_yellow)

   270

   271

    def writeyield(self, s):

   272

        self.write(s)

   273

        wx.GetApp().Yield()

   274

   275

    def flush(self):

   276

        self.output.SetValue("")

   277

   278

    def isatty(self):

   279

        return false

   280

   281

[ID_BEREMIZ, ID_BEREMIZMAINSPLITTER, 

   282

 ID_BEREMIZPLCCONFIG, ID_BEREMIZLOGCONSOLE, 

   283

 ID_BEREMIZINSPECTOR] = [wx.NewId() for _init_ctrls in range(5)]

   284

   285

[ID_FILEMENURECENTPROJECTS,

   286

] = [wx.NewId() for _init_ctrls in range(1)]

   287

   288

CONFNODEMENU_POSITION = 3

   289

   290

class Beremiz(IDEFrame):

   291

   292

    def _init_utils(self):

   293

        self.ConfNodeMenu = wx.Menu(title='')

   294

        self.RecentProjectsMenu = wx.Menu(title='')

   295

   296

        IDEFrame._init_utils(self)

   297

   298

    def _init_coll_FileMenu_Items(self, parent):

   299

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

   300

              kind=wx.ITEM_NORMAL, text=_(u'New') + '\tCTRL+N')

   301

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

   302

              kind=wx.ITEM_NORMAL, text=_(u'Open') + '\tCTRL+O')

   303

        parent.AppendMenu(ID_FILEMENURECENTPROJECTS, _("&Recent Projects"), self.RecentProjectsMenu)

   304

        parent.AppendSeparator()

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

        parent.AppendSeparator()

   314

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

   315

              kind=wx.ITEM_NORMAL, text=_(u'Page Setup') + '\tCTRL+ALT+P')

   316

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

   317

              kind=wx.ITEM_NORMAL, text=_(u'Preview') + '\tCTRL+SHIFT+P')

   318

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

   319

              kind=wx.ITEM_NORMAL, text=_(u'Print') + '\tCTRL+P')

   320

        parent.AppendSeparator()

   321

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

   322

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

   323

   324

        self.Bind(wx.EVT_MENU, self.OnNewProjectMenu, id=wx.ID_NEW)

   325

        self.Bind(wx.EVT_MENU, self.OnOpenProjectMenu, id=wx.ID_OPEN)

   326

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

   327

        self.Bind(wx.EVT_MENU, self.OnSaveProjectAsMenu, id=wx.ID_SAVEAS)

   328

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

   329

        self.Bind(wx.EVT_MENU, self.OnCloseProjectMenu, id=wx.ID_CLOSE_ALL)

   330

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

   331

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

   332

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

   333

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

   334

   335

        self.AddToMenuToolBar([(wx.ID_NEW, "new", _(u'New'), None),

   336

                               (wx.ID_OPEN, "open", _(u'Open'), None),

   337

                               (wx.ID_SAVE, "save", _(u'Save'), None),

   338

                               (wx.ID_SAVEAS, "saveas", _(u'Save As...'), None),

   339

                               (wx.ID_PRINT, "print", _(u'Print'), None)])

   340

   341

    def _init_coll_AddMenu_Items(self, parent):

   342

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   343

        new_id = wx.NewId()

   344

        AppendMenu(parent, help='', id=new_id,

   345

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

   346

        self.Bind(wx.EVT_MENU, self.AddResourceMenu, id=new_id)

   347

        for name, XSDClass, help in ProjectController.CTNChildrenTypes:

   348

            new_id = wx.NewId()

   349

            AppendMenu(parent, help='', id=new_id, 

   350

                       kind=wx.ITEM_NORMAL, text=help)

   351

            self.Bind(wx.EVT_MENU, self.GetAddConfNodeFunction(name), id=new_id)

   352

   353

    def _init_coll_HelpMenu_Items(self, parent):

   354

        parent.Append(help='', id=wx.ID_ABOUT,

   355

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

   356

        self.Bind(wx.EVT_MENU, self.OnAboutMenu, id=wx.ID_ABOUT)

   357

   358

    def _init_ctrls(self, prnt):

   359

        IDEFrame._init_ctrls(self, prnt)

   360

   361

        self.EditMenuSize = self.EditMenu.GetMenuItemCount()

   362

   363

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

   364

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

   365

        for method,shortcut in [("Stop",     wx.WXK_F4),

   366

                                ("Run",      wx.WXK_F5),

   367

                                ("Transfer", wx.WXK_F6),

   368

                                ("Connect",  wx.WXK_F7),

   369

                                ("Build",    wx.WXK_F11)]:

   370

            def OnMethodGen(obj,meth):

   371

                def OnMethod(evt):

   372

                    if obj.CTR is not None:

   373

                       obj.CTR.CallMethod('_'+meth)

   374

                    wx.CallAfter(self.RefreshStatusToolBar)

   375

                return OnMethod

   376

            newid = wx.NewId()

   377

            self.Bind(wx.EVT_MENU, OnMethodGen(self,method), id=newid)

   378

            accels += [wx.AcceleratorEntry(wx.ACCEL_NORMAL, shortcut,newid)]

   379

   380

        self.SetAcceleratorTable(wx.AcceleratorTable(accels))

   381

   382

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

   383

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

   384

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

   385

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

   386

        self.MainTabs["LogConsole"] = (self.LogConsole, _("Console"))

   387

        self.BottomNoteBook.AddPage(*self.MainTabs["LogConsole"])

   388

        #self.BottomNoteBook.Split(self.BottomNoteBook.GetPageIndex(self.LogConsole), wx.RIGHT)

   389

   390

        self.LogViewer = LogViewer(self.BottomNoteBook, self)

   391

        self.MainTabs["LogViewer"] = (self.LogViewer, _("PLC Log"))

   392

        self.BottomNoteBook.AddPage(*self.MainTabs["LogViewer"])

   393

        self.BottomNoteBook.Split(self.BottomNoteBook.GetPageIndex(self.LogViewer), wx.RIGHT)

   394

   395

        StatusToolBar = wx.ToolBar(self, -1, wx.DefaultPosition, wx.DefaultSize,

   396

                wx.TB_FLAT | wx.TB_NODIVIDER | wx.NO_BORDER)

   397

        StatusToolBar.SetToolBitmapSize(wx.Size(25, 25))

   398

        StatusToolBar.Realize()

   399

        self.Panes["StatusToolBar"] = StatusToolBar

   400

        self.AUIManager.AddPane(StatusToolBar, wx.aui.AuiPaneInfo().

   401

                  Name("StatusToolBar").Caption(_("Status ToolBar")).

   402

                  ToolbarPane().Top().Position(1).

   403

                  LeftDockable(False).RightDockable(False))

   404

   405

        self.AUIManager.Update()

   406

   407

    def __init__(self, parent, projectOpen=None, buildpath=None, ctr=None, debug=True):

   408

        IDEFrame.__init__(self, parent, debug)

   409

        self.Log = LogPseudoFile(self.LogConsole,self.RiseLogConsole)

   410

   411

        self.local_runtime = None

   412

        self.runtime_port = None

   413

        self.local_runtime_tmpdir = None

   414

   415

        self.LastPanelSelected = None

   416

   417

        # Define Tree item icon list

   418

        self.LocationImageList = wx.ImageList(16, 16)

   419

        self.LocationImageDict = {}

   420

   421

        # Icons for location items

   422

        for imgname, itemtype in [

   423

            ("CONFIGURATION", LOCATION_CONFNODE),

   424

            ("RESOURCE",      LOCATION_MODULE),

   425

            ("PROGRAM",       LOCATION_GROUP),

   426

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   427

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   428

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   429

            self.LocationImageDict[itemtype] = self.LocationImageList.Add(GetBitmap(imgname))

   430

   431

        # Icons for other items

   432

        for imgname, itemtype in [

   433

            ("Extension", ITEM_CONFNODE)]:

   434

            self.TreeImageDict[itemtype] = self.TreeImageList.Add(GetBitmap(imgname))

   435

   436

        # Add beremiz's icon in top left corner of the frame

   437

        self.SetIcon(wx.Icon(Bpath("images", "brz.ico"), wx.BITMAP_TYPE_ICO))

   438

   439

        if projectOpen is not None:

   440

            projectOpen = DecodeFileSystemPath(projectOpen, False)

   441

   442

        if projectOpen is not None and os.path.isdir(projectOpen):

   443

            self.CTR = ProjectController(self, self.Log)

   444

            self.Controler = self.CTR

   445

            result = self.CTR.LoadProject(projectOpen, buildpath)

   446

            if not result:

   447

                self.LibraryPanel.SetController(self.Controler)

   448

                self.ProjectTree.Enable(True)

   449

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   450

                self.RefreshConfigRecentProjects(os.path.abspath(projectOpen))

   451

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   452

            else:

   453

                self.ResetView()

   454

                self.ShowErrorMessage(result)

   455

        else:

   456

            self.CTR = ctr

   457

            self.Controler = ctr

   458

            if ctr is not None:

   459

                self.LibraryPanel.SetController(self.Controler)

   460

                self.ProjectTree.Enable(True)

   461

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   462

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   463

        if self.EnableDebug:

   464

            self.DebugVariablePanel.SetDataProducer(self.CTR)

   465

   466

        self.Bind(wx.EVT_CLOSE, self.OnCloseFrame)

   467

   468

        self._Refresh(TITLE, EDITORTOOLBAR, FILEMENU, EDITMENU, DISPLAYMENU)

   469

        self.RefreshAll()

   470

        self.LogConsole.SetFocus()

   471

   472

    def RiseLogConsole(self):

   473

        self.BottomNoteBook.SetSelection(self.BottomNoteBook.GetPageIndex(self.LogConsole))

   474

   475

    def RefreshTitle(self):

   476

        name = _("Beremiz")

   477

        if self.CTR is not None:

   478

            projectname = self.CTR.GetProjectName()

   479

            if self.CTR.ProjectTestModified():

   480

                projectname = "~%s~" % projectname

   481

            self.SetTitle("%s - %s" % (name, projectname))

   482

        else:

   483

            self.SetTitle(name)

   484