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

# Import module for internationalization

   114

import gettext

   115

   116

# Get folder containing translation files

   117

localedir = os.path.join(CWD,"locale")

   118

# Get the default language

   119

langid = wx.LANGUAGE_DEFAULT

   120

# Define translation domain (name of translation files)

   121

domain = "Beremiz"

   122

   123

# Define locale for wx

   124

loc = __builtin__.__dict__.get('loc', None)

   125

if loc is None:

   126

    test_loc = wx.Locale(langid)

   127

    test_loc.AddCatalogLookupPathPrefix(localedir)

   128

    if test_loc.AddCatalog(domain):

   129

        loc = wx.Locale(langid)

   130

    else:

   131

        loc = wx.Locale(wx.LANGUAGE_ENGLISH)

   132

    __builtin__.__dict__['loc'] = loc

   133

# Define location for searching translation files

   134

loc.AddCatalogLookupPathPrefix(localedir)

   135

# Define locale domain

   136

loc.AddCatalog(domain)

   137

   138

def unicode_translation(message):

   139

    return wx.GetTranslation(message).encode("utf-8")

   140

   141

if __name__ == '__main__':

   142

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

   143

   144

base_folder = os.path.split(sys.path[0])[0]

   145

sys.path.append(base_folder)

   146

sys.path.append(os.path.join(base_folder, "plcopeneditor"))

   147

   148

if __name__ == '__main__':

   149

    # Load extensions

   150

    for extfilename in extensions:

   151

        sys.path.append(os.path.split(os.path.realpath(extfilename))[0])

   152

        execfile(extfilename, locals())

   153

   154

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

   155

from util.TextCtrlAutoComplete import TextCtrlAutoComplete

   156

import cPickle

   157

from util.BrowseValuesLibraryDialog import BrowseValuesLibraryDialog

   158

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

   159

from ProjectController import ProjectController, MATIEC_ERROR_MODEL, ITEM_CONFNODE

   160

from util.MiniTextControler import MiniTextControler

   161

from util.ProcessLogger import ProcessLogger

   162

   163

from docutil import OpenHtmlFrame

   164

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

   165

from PLCOpenEditor import EditorPanel, Viewer, TextViewer, GraphicViewer, ResourceEditor, ConfigurationEditor, DataTypeEditor

   166

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

   167

   168

MAX_RECENT_PROJECTS = 10

   169

   170

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

   171

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

   172

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

   173

    def __init__(self, parent, ID, bitmapname,

   174

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

   175

                 style = 0,

   176

                 name = "genstatbmp"):

   177

   178

        bitmappath = Bpath( "images", bitmapname)

   179

        if os.path.isfile(bitmappath):

   180

            bitmap = wx.Bitmap(bitmappath)

   181

        else:

   182

            bitmap = None

   183

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

   184

                 pos, size,

   185

                 style,

   186

                 name)

   187

   188

    def OnPaint(self, event):

   189

        dc = wx.PaintDC(self)

   190

        colour = self.GetParent().GetBackgroundColour()

   191

        dc.SetPen(wx.Pen(colour))

   192

        dc.SetBrush(wx.Brush(colour ))

   193

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

   194

        if self._bitmap:

   195

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

   196

   197

   198

from threading import Lock,Timer,currentThread

   199

MainThread = currentThread().ident

   200

REFRESH_PERIOD = 0.1

   201

from time import time as gettime

   202

class LogPseudoFile:

   203

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

   204

    def __init__(self, output, risecall):

   205

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

   206

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

   207

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

   208

        self.default_style = None

   209

        self.output = output

   210

        self.risecall = risecall

   211

        # to prevent rapid fire on rising log panel

   212

        self.rising_timer = 0

   213

        self.lock = Lock()

   214

        self.YieldLock = Lock()

   215

        self.RefreshLock = Lock()

   216

        self.stack = []

   217

        self.LastRefreshTime = gettime()

   218

        self.LastRefreshTimer = None

   219

   220

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

   221

        if self.lock.acquire():

   222

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

   223

            self.lock.release()

   224

            current_time = gettime()

   225

            if self.LastRefreshTimer:

   226

                self.LastRefreshTimer.cancel()

   227

                self.LastRefreshTimer=None

   228

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

   229

                self._should_write()

   230

            else:

   231

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

   232

                self.LastRefreshTimer.start()

   233

   234

    def _should_write(self):

   235

        wx.CallAfter(self._write)

   236

        if MainThread == currentThread().ident:

   237

            app = wx.GetApp()

   238

            if app is not None:

   239

                if self.YieldLock.acquire(0):

   240

                    app.Yield()

   241

                    self.YieldLock.release()

   242

   243

    def _write(self):

   244

        if self.output :

   245

            self.output.Freeze(); 

   246

            self.lock.acquire()

   247

            for s, style in self.stack:

   248

                if style is None : style=self.black_white

   249

                if self.default_style != style: 

   250

                    self.output.SetDefaultStyle(style)

   251

                    self.default_style = style

   252

                self.output.AppendText(s)

   253

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

   254

            self.stack = []

   255

            self.lock.release()

   256

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

   257

            self.output.Thaw()

   258

            self.LastRefreshTime = gettime()

   259

            try:

   260

                self.RefreshLock.release()

   261

            except:

   262

                pass

   263

            newtime = time.time()

   264

            if newtime - self.rising_timer > 1:

   265

                self.risecall()

   266

            self.rising_timer = newtime

   267

   268

    def write_warning(self, s):

   269

        self.write(s,self.red_white)

   270

   271

    def write_error(self, s):

   272

        self.write(s,self.red_yellow)

   273

   274

    def writeyield(self, s):

   275

        self.write(s)

   276

        wx.GetApp().Yield()

   277

   278

    def flush(self):

   279

        self.output.SetValue("")

   280

   281

    def isatty(self):

   282

        return false

   283

   284

[ID_BEREMIZ, ID_BEREMIZMAINSPLITTER, 

   285

 ID_BEREMIZPLCCONFIG, ID_BEREMIZLOGCONSOLE, 

   286

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

   287

   288

[ID_FILEMENURECENTPROJECTS,

   289

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

   290

   291

CONFNODEMENU_POSITION = 3

   292

   293

class Beremiz(IDEFrame):

   294

   295

    def _init_utils(self):

   296

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

   297

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

   298

   299

        IDEFrame._init_utils(self)

   300

   301

    def _init_coll_FileMenu_Items(self, parent):

   302

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

   303

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

   304

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

   305

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

   306

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

   307

        parent.AppendSeparator()

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

        parent.AppendSeparator()

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

        parent.AppendSeparator()

   324

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

   325

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

   326

   327

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

   328

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

   329

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

   330

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

   331

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

   332

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

   333

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

   334

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

   335

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

   336

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

   337

   338

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

   339

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

   340

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

   341

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

   342

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

   343

   344

    def _init_coll_AddMenu_Items(self, parent):

   345

        IDEFrame._init_coll_AddMenu_Items(self, parent, False)

   346

        new_id = wx.NewId()

   347

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

   348

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

   349

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

   350

        for name, XSDClass, help in ProjectController.CTNChildrenTypes:

   351

            new_id = wx.NewId()

   352

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

   353

                       kind=wx.ITEM_NORMAL, text=help)

   354

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

   355

   356

    def _init_coll_HelpMenu_Items(self, parent):

   357

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

   358

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

   359

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

   360

   361

    def _init_ctrls(self, prnt):

   362

        IDEFrame._init_ctrls(self, prnt)

   363

   366

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

   367

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

   368

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

   369

                                ("Run",      wx.WXK_F5),

   370

                                ("Transfer", wx.WXK_F6),

   371

                                ("Connect",  wx.WXK_F7),

   372

                                ("Build",    wx.WXK_F11)]:

   373

            def OnMethodGen(obj,meth):

   374

                def OnMethod(evt):

   375

                    if obj.CTR is not None:

   376

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

   377

                    wx.CallAfter(self.RefreshStatusToolBar)

   378

                return OnMethod

   379

            newid = wx.NewId()

   380

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

   381

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

   382

   383

        self.SetAcceleratorTable(wx.AcceleratorTable(accels))

   384

   385

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

   386

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

   387

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

   388

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

   389

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

   390

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

   391

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

   392

   393

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

   394

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

   395

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

   396

        StatusToolBar.Realize()

   397

        self.Panes["StatusToolBar"] = StatusToolBar

   398

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

   399

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

   400

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

   401

                  LeftDockable(False).RightDockable(False))

   402

   403

        self.AUIManager.Update()

   404

   405

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

   406

        IDEFrame.__init__(self, parent, debug)

   407

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

   408

   409

        self.local_runtime = None

   410

        self.runtime_port = None

   411

        self.local_runtime_tmpdir = None

   412

   413

        self.LastPanelSelected = None

   414

   415

        # Define Tree item icon list

   416

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

   417

        self.LocationImageDict = {}

   418

   419

        # Icons for location items

   420

        for imgname, itemtype in [

   421

            ("CONFIGURATION", LOCATION_CONFNODE),

   422

            ("RESOURCE",      LOCATION_MODULE),

   423

            ("PROGRAM",       LOCATION_GROUP),

   424

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   425

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   426

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   427

            self.LocationImageDict[itemtype]=self.LocationImageList.Add(wx.Bitmap(os.path.join(base_folder, "plcopeneditor", 'Images', '%s.png'%imgname)))

   428

   429

        # Icons for other items

   430

        for imgname, itemtype in [

   431

            ("Extension", ITEM_CONFNODE)]:

   432

            self.TreeImageDict[itemtype]=self.TreeImageList.Add(wx.Bitmap(os.path.join(CWD, 'images', '%s.png'%imgname)))

   433

   434

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

   435

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

   436

   437

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

   438

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

   439

            if projectOpen == "":

   440

                projectOpen = None

   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.SetControler(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.SetControler(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

   485

    def StartLocalRuntime(self, taskbaricon = True):

   486

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

   487