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

   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__['loc'] = locale

   124

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

   125

   126

    # Load extensions

   127

    for extfilename in extensions:

   128

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

   129

        sys.path.append(extension_folder)

   130

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

   131

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

   132

        execfile(extfilename, locals())

   133

   134

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

   135

import cPickle

   136

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

   137

   138

from docutil import OpenHtmlFrame

   139

from IDEFrame import IDEFrame, AppendMenu

   140

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

   141

from IDEFrame import EncodeFileSystemPath, DecodeFileSystemPath

   142

from editors.EditorPanel import EditorPanel

   143

from editors.Viewer import Viewer

   144

from editors.TextViewer import TextViewer

   145

from editors.GraphicViewer import GraphicViewer

   146

from editors.ResourceEditor import ConfigurationEditor, ResourceEditor

   147

from editors.DataTypeEditor import DataTypeEditor

   148

from util.MiniTextControler import MiniTextControler

   149

from util.ProcessLogger import ProcessLogger

   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.stack = []

   200

        self.LastRefreshTime = gettime()

   201

        self.LastRefreshTimer = None

   202

   203

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

   204

        if self.lock.acquire():

   205

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

   206

            self.lock.release()

   207

            current_time = gettime()

   208

            if self.LastRefreshTimer:

   209

                self.LastRefreshTimer.cancel()

   210

                self.LastRefreshTimer=None

   211

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

   212

                self._should_write()

   213

            else:

   214

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

   215

                self.LastRefreshTimer.start()

   216

   217

    def _should_write(self):

   218

        wx.CallAfter(self._write)

   219

        if MainThread == currentThread().ident:

   220

            app = wx.GetApp()

   221

            if app is not None:

   222

                if self.YieldLock.acquire(0):

   223

                    app.Yield()

   224

                    self.YieldLock.release()

   225

   226

    def _write(self):

   227

        if self.output :

   228

            self.output.Freeze(); 

   229

            self.lock.acquire()

   230

            for s, style in self.stack:

   231

                if style is None : style=self.black_white

   232

                if self.default_style != style: 

   233

                    self.output.SetDefaultStyle(style)

   234

                    self.default_style = style

   235

                self.output.AppendText(s)

   236

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

   237

            self.stack = []

   238

            self.lock.release()

   239

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

   240

            self.output.Thaw()

   241

            self.LastRefreshTime = gettime()

   242

            try:

   243

                self.RefreshLock.release()

   244

            except:

   245

                pass

   246

            newtime = time.time()

   247

            if newtime - self.rising_timer > 1:

   248

                self.risecall()

   249

            self.rising_timer = newtime

   250

   251

    def write_warning(self, s):

   252

        self.write(s,self.red_white)

   253

   254

    def write_error(self, s):

   255

        self.write(s,self.red_yellow)

   256

   257

    def writeyield(self, s):

   258

        self.write(s)

   259

        wx.GetApp().Yield()

   260

   261

    def flush(self):

   262

        self.output.SetValue("")

   263

   264

    def isatty(self):

   265

        return false

   266

   267

[ID_BEREMIZ, ID_BEREMIZMAINSPLITTER, 

   268

 ID_BEREMIZPLCCONFIG, ID_BEREMIZLOGCONSOLE, 

   269

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

   270

   271

[ID_FILEMENURECENTPROJECTS,

   272

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

   273

   274

CONFNODEMENU_POSITION = 3

   275

   276

class Beremiz(IDEFrame):

   277

   278

    def _init_utils(self):

   279

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

   280

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

   281

   282

        IDEFrame._init_utils(self)

   283

   284

    def _init_coll_FileMenu_Items(self, parent):

   285

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

   286

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

   287

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

   288

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

   289

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

   290

        parent.AppendSeparator()

   291

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

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

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

   299

        parent.AppendSeparator()

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

        parent.AppendSeparator()

   307

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

   308

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

   309

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

   321

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

   322

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

   323

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

   324

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

   325

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

   326

   327

    def _init_coll_AddMenu_Items(self, parent):

   328

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   329

        new_id = wx.NewId()

   330

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

   331

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

   332

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

   333

        for name, XSDClass, help in ProjectController.CTNChildrenTypes:

   334

            new_id = wx.NewId()

   335

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

   336

                       kind=wx.ITEM_NORMAL, text=help)

   337

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

   338

   339

    def _init_coll_HelpMenu_Items(self, parent):

   340

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

   341

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

   342

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

   343

   344

    def _init_ctrls(self, prnt):

   345

        IDEFrame._init_ctrls(self, prnt)

   346

   347

        self.EditMenuSize = self.EditMenu.GetMenuItemCount()

   348

   349

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

   350

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

   351

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

   352

                                ("Run",      wx.WXK_F5),

   353

                                ("Transfer", wx.WXK_F6),

   354

                                ("Connect",  wx.WXK_F7),

   355

                                ("Build",    wx.WXK_F11)]:

   356

            def OnMethodGen(obj,meth):

   357

                def OnMethod(evt):

   358

                    if obj.CTR is not None:

   359

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

   360

                    wx.CallAfter(self.RefreshStatusToolBar)

   361

                return OnMethod

   362

            newid = wx.NewId()

   363

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

   364

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

   365

   366

        self.SetAcceleratorTable(wx.AcceleratorTable(accels))

   367

   368

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

   369

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

   370

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

   371

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

   372

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

   373

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

   374

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

   375

   376

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

   377

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

   378

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

   379

        StatusToolBar.Realize()

   380

        self.Panes["StatusToolBar"] = StatusToolBar

   381

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

   382

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

   383

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

   384

                  LeftDockable(False).RightDockable(False))

   385

   386

        self.AUIManager.Update()

   387

   388

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

   389

        IDEFrame.__init__(self, parent, debug)

   390

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

   391

   392

        self.local_runtime = None

   393

        self.runtime_port = None

   394

        self.local_runtime_tmpdir = None

   395

   396

        self.LastPanelSelected = None

   397

   398

        # Define Tree item icon list

   399

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

   400

        self.LocationImageDict = {}

   401

   402

        # Icons for location items

   403

        for imgname, itemtype in [

   404

            ("CONFIGURATION", LOCATION_CONFNODE),

   405

            ("RESOURCE",      LOCATION_MODULE),

   406

            ("PROGRAM",       LOCATION_GROUP),

   407

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   408

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   409

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   410

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

   411

   412

        # Icons for other items

   413

        for imgname, itemtype in [

   414

            ("Extension", ITEM_CONFNODE)]:

   415

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

   416

   417

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

   418

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

   419

   420

        if projectOpen is not None:

   421

            projectOpen = DecodeFileSystemPath(projectOpen, False)

   422

   423

        if ctr is None and projectOpen is None and self.Config.HasEntry("currenteditedproject"):

   424

            try:

   425

                projectOpen = DecodeFileSystemPath(self.Config.Read("currenteditedproject"))

   426

                if projectOpen == "":

   427

                    projectOpen = None

   428

            except:

   429

                projectOpen = None

   430

   431

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

   432

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

   433

            self.Controler = self.CTR

   434

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

   435

            if not result:

   436

                self.LibraryPanel.SetController(self.Controler)

   437

                self.ProjectTree.Enable(True)

   438

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   439

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

   440

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   441

            else:

   442

                self.ResetView()

   443

                self.ShowErrorMessage(result)

   444

        else:

   445

            self.CTR = ctr

   446

            self.Controler = ctr

   447

            if ctr is not None:

   448

                self.LibraryPanel.SetController(self.Controler)

   449

                self.ProjectTree.Enable(True)

   450

                self.PouInstanceVariablesPanel.SetController(self.Controler)

   451

                self._Refresh(PROJECTTREE, POUINSTANCEVARIABLESPANEL, LIBRARYTREE)

   452

        if self.EnableDebug:

   453

            self.DebugVariablePanel.SetDataProducer(self.CTR)

   454

   455

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

   456

   457

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

   458

        self.RefreshAll()

   459

        self.LogConsole.SetFocus()

   460

   461

    def RiseLogConsole(self):

   462

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

   463

   464

    def RefreshTitle(self):

   465

        name = _("Beremiz")

   466

        if self.CTR is not None:

   467

            projectname = self.CTR.GetProjectName()

   468

            if self.CTR.ProjectTestModified():

   469

                projectname = "~%s~" % projectname

   470

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

   471

        else:

   472

            self.SetTitle(name)

   473

   474

    def StartLocalRuntime(self, taskbaricon = True):

   475

        if (self.local_runtime is None) or (self.local_runtime.exitcode is not None):

   476

            # create temporary directory for runtime working directory

   477

            self.local_runtime_tmpdir = tempfile.mkdtemp()

   478

            # choose an arbitrary random port for runtime

   479

            self.runtime_port = int(random.random() * 1000) + 61131

   480

            # launch local runtime

   481

            self.local_runtime = ProcessLogger(self.Log,

   482

                                               "\"%s\" \"%s\" -p %s -i localhost %s %s"%(sys.executable,

   483

                                                           Bpath("Beremiz_service.py"),

   484

                                                           self.runtime_port,

   485

                                                           {False : "-x 0", True :"-x 1"}[taskbaricon],